class PureCloud::AlertingApi
Attributes
Public Class Methods
# File lib/purecloud/api/alerting_api.rb, line 23 def initialize(api_client = ApiClient.default) @api_client = api_client end
Public Instance Methods
Delete a heart beat alert
@param alert_id Alert ID @param [Hash] opts the optional parameters @return [nil]
# File lib/purecloud/api/alerting_api.rb, line 32 def delete_heartbeat_alerts_alert_id(alert_id, opts = {}) delete_heartbeat_alerts_alert_id_with_http_info(alert_id, opts) return nil end
Delete a heart beat alert
@param alert_id Alert ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 42 def delete_heartbeat_alerts_alert_id_with_http_info(alert_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#delete_heartbeat_alerts_alert_id ..." end # verify the required parameter 'alert_id' is set fail "Missing the required parameter 'alert_id' when calling delete_heartbeat_alerts_alert_id" if alert_id.nil? # resource path local_var_path = "/api/v2/alerting/heartbeat/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#delete_heartbeat_alerts_alert_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a heart beat rule.
@param rule_id Rule ID @param [Hash] opts the optional parameters @return [nil]
# File lib/purecloud/api/alerting_api.rb, line 91 def delete_heartbeat_rules_rule_id(rule_id, opts = {}) delete_heartbeat_rules_rule_id_with_http_info(rule_id, opts) return nil end
Delete a heart beat rule.
@param rule_id Rule ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 101 def delete_heartbeat_rules_rule_id_with_http_info(rule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#delete_heartbeat_rules_rule_id ..." end # verify the required parameter 'rule_id' is set fail "Missing the required parameter 'rule_id' when calling delete_heartbeat_rules_rule_id" if rule_id.nil? # resource path local_var_path = "/api/v2/alerting/heartbeat/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#delete_heartbeat_rules_rule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete an interaction stats alert
@param alert_id Alert ID @param [Hash] opts the optional parameters @return [nil]
# File lib/purecloud/api/alerting_api.rb, line 150 def delete_interactionstats_alerts_alert_id(alert_id, opts = {}) delete_interactionstats_alerts_alert_id_with_http_info(alert_id, opts) return nil end
Delete an interaction stats alert
@param alert_id Alert ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 160 def delete_interactionstats_alerts_alert_id_with_http_info(alert_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#delete_interactionstats_alerts_alert_id ..." end # verify the required parameter 'alert_id' is set fail "Missing the required parameter 'alert_id' when calling delete_interactionstats_alerts_alert_id" if alert_id.nil? # resource path local_var_path = "/api/v2/alerting/interactionstats/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#delete_interactionstats_alerts_alert_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete an interaction stats rule.
@param rule_id Rule ID @param [Hash] opts the optional parameters @return [nil]
# File lib/purecloud/api/alerting_api.rb, line 209 def delete_interactionstats_rules_rule_id(rule_id, opts = {}) delete_interactionstats_rules_rule_id_with_http_info(rule_id, opts) return nil end
Delete an interaction stats rule.
@param rule_id Rule ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 219 def delete_interactionstats_rules_rule_id_with_http_info(rule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#delete_interactionstats_rules_rule_id ..." end # verify the required parameter 'rule_id' is set fail "Missing the required parameter 'rule_id' when calling delete_interactionstats_rules_rule_id" if rule_id.nil? # resource path local_var_path = "/api/v2/alerting/interactionstats/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#delete_interactionstats_rules_rule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a routing status alert
@param alert_id Alert ID @param [Hash] opts the optional parameters @return [nil]
# File lib/purecloud/api/alerting_api.rb, line 268 def delete_routingstatus_alerts_alert_id(alert_id, opts = {}) delete_routingstatus_alerts_alert_id_with_http_info(alert_id, opts) return nil end
Delete a routing status alert
@param alert_id Alert ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 278 def delete_routingstatus_alerts_alert_id_with_http_info(alert_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#delete_routingstatus_alerts_alert_id ..." end # verify the required parameter 'alert_id' is set fail "Missing the required parameter 'alert_id' when calling delete_routingstatus_alerts_alert_id" if alert_id.nil? # resource path local_var_path = "/api/v2/alerting/routingstatus/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#delete_routingstatus_alerts_alert_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a routing status rule.
@param rule_id Rule ID @param [Hash] opts the optional parameters @return [nil]
# File lib/purecloud/api/alerting_api.rb, line 327 def delete_routingstatus_rules_rule_id(rule_id, opts = {}) delete_routingstatus_rules_rule_id_with_http_info(rule_id, opts) return nil end
Delete a routing status rule.
@param rule_id Rule ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 337 def delete_routingstatus_rules_rule_id_with_http_info(rule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#delete_routingstatus_rules_rule_id ..." end # verify the required parameter 'rule_id' is set fail "Missing the required parameter 'rule_id' when calling delete_routingstatus_rules_rule_id" if rule_id.nil? # resource path local_var_path = "/api/v2/alerting/routingstatus/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#delete_routingstatus_rules_rule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a user presence alert
@param alert_id Alert ID @param [Hash] opts the optional parameters @return [nil]
# File lib/purecloud/api/alerting_api.rb, line 386 def delete_userpresence_alerts_alert_id(alert_id, opts = {}) delete_userpresence_alerts_alert_id_with_http_info(alert_id, opts) return nil end
Delete a user presence alert
@param alert_id Alert ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 396 def delete_userpresence_alerts_alert_id_with_http_info(alert_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#delete_userpresence_alerts_alert_id ..." end # verify the required parameter 'alert_id' is set fail "Missing the required parameter 'alert_id' when calling delete_userpresence_alerts_alert_id" if alert_id.nil? # resource path local_var_path = "/api/v2/alerting/userpresence/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#delete_userpresence_alerts_alert_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Delete a user presence rule.
@param rule_id Rule ID @param [Hash] opts the optional parameters @return [nil]
# File lib/purecloud/api/alerting_api.rb, line 445 def delete_userpresence_rules_rule_id(rule_id, opts = {}) delete_userpresence_rules_rule_id_with_http_info(rule_id, opts) return nil end
Delete a user presence rule.
@param rule_id Rule ID @param [Hash] opts the optional parameters @return [Array<(nil, Fixnum, Hash)>] nil, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 455 def delete_userpresence_rules_rule_id_with_http_info(rule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#delete_userpresence_rules_rule_id ..." end # verify the required parameter 'rule_id' is set fail "Missing the required parameter 'rule_id' when calling delete_userpresence_rules_rule_id" if rule_id.nil? # resource path local_var_path = "/api/v2/alerting/userpresence/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s) # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names) if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#delete_userpresence_rules_rule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get heart beat alert list.
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [HeartBeatAlertContainer]
# File lib/purecloud/api/alerting_api.rb, line 504 def get_heartbeat_alerts(opts = {}) data, status_code, headers = get_heartbeat_alerts_with_http_info(opts) return data end
Get a heart beat alert
@param alert_id Alert ID @param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [HeartBeatAlert]
# File lib/purecloud/api/alerting_api.rb, line 563 def get_heartbeat_alerts_alert_id(alert_id, opts = {}) data, status_code, headers = get_heartbeat_alerts_alert_id_with_http_info(alert_id, opts) return data end
Get a heart beat alert
@param alert_id Alert ID @param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [Array<(HeartBeatAlert
, Fixnum, Hash)>] HeartBeatAlert
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 574 def get_heartbeat_alerts_alert_id_with_http_info(alert_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#get_heartbeat_alerts_alert_id ..." end # verify the required parameter 'alert_id' is set fail "Missing the required parameter 'alert_id' when calling get_heartbeat_alerts_alert_id" if alert_id.nil? # resource path local_var_path = "/api/v2/alerting/heartbeat/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s) # query parameters query_params = {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'HeartBeatAlert') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#get_heartbeat_alerts_alert_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get heart beat alert list.
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [Array<(HeartBeatAlertContainer
, Fixnum, Hash)>] HeartBeatAlertContainer
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 514 def get_heartbeat_alerts_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#get_heartbeat_alerts ..." end # resource path local_var_path = "/api/v2/alerting/heartbeat/alerts".sub('{format}','json') # query parameters query_params = {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'HeartBeatAlertContainer') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#get_heartbeat_alerts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a heart beat rule list.
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [HeartBeatRuleContainer]
# File lib/purecloud/api/alerting_api.rb, line 625 def get_heartbeat_rules(opts = {}) data, status_code, headers = get_heartbeat_rules_with_http_info(opts) return data end
Get a heart beat rule.
@param rule_id Rule ID @param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [HeartBeatRule]
# File lib/purecloud/api/alerting_api.rb, line 684 def get_heartbeat_rules_rule_id(rule_id, opts = {}) data, status_code, headers = get_heartbeat_rules_rule_id_with_http_info(rule_id, opts) return data end
Get a heart beat rule.
@param rule_id Rule ID @param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [Array<(HeartBeatRule
, Fixnum, Hash)>] HeartBeatRule
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 695 def get_heartbeat_rules_rule_id_with_http_info(rule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#get_heartbeat_rules_rule_id ..." end # verify the required parameter 'rule_id' is set fail "Missing the required parameter 'rule_id' when calling get_heartbeat_rules_rule_id" if rule_id.nil? # resource path local_var_path = "/api/v2/alerting/heartbeat/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s) # query parameters query_params = {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'HeartBeatRule') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#get_heartbeat_rules_rule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a heart beat rule list.
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [Array<(HeartBeatRuleContainer
, Fixnum, Hash)>] HeartBeatRuleContainer
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 635 def get_heartbeat_rules_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#get_heartbeat_rules ..." end # resource path local_var_path = "/api/v2/alerting/heartbeat/rules".sub('{format}','json') # query parameters query_params = {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'HeartBeatRuleContainer') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#get_heartbeat_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get interaction stats alert list.
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [InteractionStatsAlertContainer]
# File lib/purecloud/api/alerting_api.rb, line 746 def get_interactionstats_alerts(opts = {}) data, status_code, headers = get_interactionstats_alerts_with_http_info(opts) return data end
Get an interaction stats alert
@param alert_id Alert ID @param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [InteractionStatsAlert]
# File lib/purecloud/api/alerting_api.rb, line 805 def get_interactionstats_alerts_alert_id(alert_id, opts = {}) data, status_code, headers = get_interactionstats_alerts_alert_id_with_http_info(alert_id, opts) return data end
Get an interaction stats alert
@param alert_id Alert ID @param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [Array<(InteractionStatsAlert
, Fixnum, Hash)>] InteractionStatsAlert
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 816 def get_interactionstats_alerts_alert_id_with_http_info(alert_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#get_interactionstats_alerts_alert_id ..." end # verify the required parameter 'alert_id' is set fail "Missing the required parameter 'alert_id' when calling get_interactionstats_alerts_alert_id" if alert_id.nil? # resource path local_var_path = "/api/v2/alerting/interactionstats/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s) # query parameters query_params = {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InteractionStatsAlert') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#get_interactionstats_alerts_alert_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Gets user unread count of interaction stats alerts.
@param [Hash] opts the optional parameters @return [UnreadMetric]
# File lib/purecloud/api/alerting_api.rb, line 866 def get_interactionstats_alerts_unread(opts = {}) data, status_code, headers = get_interactionstats_alerts_unread_with_http_info(opts) return data end
Gets user unread count of interaction stats alerts.
@param [Hash] opts the optional parameters @return [Array<(UnreadMetric
, Fixnum, Hash)>] UnreadMetric
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 875 def get_interactionstats_alerts_unread_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#get_interactionstats_alerts_unread ..." end # resource path local_var_path = "/api/v2/alerting/interactionstats/alerts/unread".sub('{format}','json') # query parameters query_params = {} # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'UnreadMetric') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#get_interactionstats_alerts_unread\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get interaction stats alert list.
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [Array<(InteractionStatsAlertContainer
, Fixnum, Hash)>] InteractionStatsAlertContainer
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 756 def get_interactionstats_alerts_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#get_interactionstats_alerts ..." end # resource path local_var_path = "/api/v2/alerting/interactionstats/alerts".sub('{format}','json') # query parameters query_params = {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InteractionStatsAlertContainer') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#get_interactionstats_alerts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get an interaction stats rule list.
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [InteractionStatsRuleContainer]
# File lib/purecloud/api/alerting_api.rb, line 922 def get_interactionstats_rules(opts = {}) data, status_code, headers = get_interactionstats_rules_with_http_info(opts) return data end
Get an interaction stats rule.
@param rule_id Rule ID @param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [InteractionStatsRule]
# File lib/purecloud/api/alerting_api.rb, line 981 def get_interactionstats_rules_rule_id(rule_id, opts = {}) data, status_code, headers = get_interactionstats_rules_rule_id_with_http_info(rule_id, opts) return data end
Get an interaction stats rule.
@param rule_id Rule ID @param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [Array<(InteractionStatsRule
, Fixnum, Hash)>] InteractionStatsRule
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 992 def get_interactionstats_rules_rule_id_with_http_info(rule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#get_interactionstats_rules_rule_id ..." end # verify the required parameter 'rule_id' is set fail "Missing the required parameter 'rule_id' when calling get_interactionstats_rules_rule_id" if rule_id.nil? # resource path local_var_path = "/api/v2/alerting/interactionstats/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s) # query parameters query_params = {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InteractionStatsRule') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#get_interactionstats_rules_rule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get an interaction stats rule list.
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [Array<(InteractionStatsRuleContainer
, Fixnum, Hash)>] InteractionStatsRuleContainer
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 932 def get_interactionstats_rules_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#get_interactionstats_rules ..." end # resource path local_var_path = "/api/v2/alerting/interactionstats/rules".sub('{format}','json') # query parameters query_params = {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InteractionStatsRuleContainer') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#get_interactionstats_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get routing status alert list.
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [RoutingStatusAlertContainer]
# File lib/purecloud/api/alerting_api.rb, line 1043 def get_routingstatus_alerts(opts = {}) data, status_code, headers = get_routingstatus_alerts_with_http_info(opts) return data end
Get a routing status alert
@param alert_id Alert ID @param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [RoutingStatusAlert]
# File lib/purecloud/api/alerting_api.rb, line 1102 def get_routingstatus_alerts_alert_id(alert_id, opts = {}) data, status_code, headers = get_routingstatus_alerts_alert_id_with_http_info(alert_id, opts) return data end
Get a routing status alert
@param alert_id Alert ID @param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [Array<(RoutingStatusAlert
, Fixnum, Hash)>] RoutingStatusAlert
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 1113 def get_routingstatus_alerts_alert_id_with_http_info(alert_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#get_routingstatus_alerts_alert_id ..." end # verify the required parameter 'alert_id' is set fail "Missing the required parameter 'alert_id' when calling get_routingstatus_alerts_alert_id" if alert_id.nil? # resource path local_var_path = "/api/v2/alerting/routingstatus/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s) # query parameters query_params = {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'RoutingStatusAlert') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#get_routingstatus_alerts_alert_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get routing status alert list.
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [Array<(RoutingStatusAlertContainer
, Fixnum, Hash)>] RoutingStatusAlertContainer
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 1053 def get_routingstatus_alerts_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#get_routingstatus_alerts ..." end # resource path local_var_path = "/api/v2/alerting/routingstatus/alerts".sub('{format}','json') # query parameters query_params = {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'RoutingStatusAlertContainer') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#get_routingstatus_alerts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a routing status rule list.
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [RoutingStatusRuleContainer]
# File lib/purecloud/api/alerting_api.rb, line 1164 def get_routingstatus_rules(opts = {}) data, status_code, headers = get_routingstatus_rules_with_http_info(opts) return data end
Get a routing status rule.
@param rule_id Rule ID @param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [RoutingStatusRule]
# File lib/purecloud/api/alerting_api.rb, line 1223 def get_routingstatus_rules_rule_id(rule_id, opts = {}) data, status_code, headers = get_routingstatus_rules_rule_id_with_http_info(rule_id, opts) return data end
Get a routing status rule.
@param rule_id Rule ID @param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [Array<(RoutingStatusRule
, Fixnum, Hash)>] RoutingStatusRule
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 1234 def get_routingstatus_rules_rule_id_with_http_info(rule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#get_routingstatus_rules_rule_id ..." end # verify the required parameter 'rule_id' is set fail "Missing the required parameter 'rule_id' when calling get_routingstatus_rules_rule_id" if rule_id.nil? # resource path local_var_path = "/api/v2/alerting/routingstatus/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s) # query parameters query_params = {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'RoutingStatusRule') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#get_routingstatus_rules_rule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a routing status rule list.
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [Array<(RoutingStatusRuleContainer
, Fixnum, Hash)>] RoutingStatusRuleContainer
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 1174 def get_routingstatus_rules_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#get_routingstatus_rules ..." end # resource path local_var_path = "/api/v2/alerting/routingstatus/rules".sub('{format}','json') # query parameters query_params = {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'RoutingStatusRuleContainer') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#get_routingstatus_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get user presence alert list.
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [UserPresenceAlertContainer]
# File lib/purecloud/api/alerting_api.rb, line 1285 def get_userpresence_alerts(opts = {}) data, status_code, headers = get_userpresence_alerts_with_http_info(opts) return data end
Get a user presence alert
@param alert_id Alert ID @param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [UserPresenceAlert]
# File lib/purecloud/api/alerting_api.rb, line 1344 def get_userpresence_alerts_alert_id(alert_id, opts = {}) data, status_code, headers = get_userpresence_alerts_alert_id_with_http_info(alert_id, opts) return data end
Get a user presence alert
@param alert_id Alert ID @param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [Array<(UserPresenceAlert
, Fixnum, Hash)>] UserPresenceAlert
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 1355 def get_userpresence_alerts_alert_id_with_http_info(alert_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#get_userpresence_alerts_alert_id ..." end # verify the required parameter 'alert_id' is set fail "Missing the required parameter 'alert_id' when calling get_userpresence_alerts_alert_id" if alert_id.nil? # resource path local_var_path = "/api/v2/alerting/userpresence/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s) # query parameters query_params = {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'UserPresenceAlert') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#get_userpresence_alerts_alert_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get user presence alert list.
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [Array<(UserPresenceAlertContainer
, Fixnum, Hash)>] UserPresenceAlertContainer
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 1295 def get_userpresence_alerts_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#get_userpresence_alerts ..." end # resource path local_var_path = "/api/v2/alerting/userpresence/alerts".sub('{format}','json') # query parameters query_params = {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'UserPresenceAlertContainer') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#get_userpresence_alerts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a user presence rule list.
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [UserPresenceRuleContainer]
# File lib/purecloud/api/alerting_api.rb, line 1406 def get_userpresence_rules(opts = {}) data, status_code, headers = get_userpresence_rules_with_http_info(opts) return data end
Get a user presence rule.
@param rule_id Rule ID @param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [UserPresenceRule]
# File lib/purecloud/api/alerting_api.rb, line 1465 def get_userpresence_rules_rule_id(rule_id, opts = {}) data, status_code, headers = get_userpresence_rules_rule_id_with_http_info(rule_id, opts) return data end
Get a user presence rule.
@param rule_id Rule ID @param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [Array<(UserPresenceRule
, Fixnum, Hash)>] UserPresenceRule
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 1476 def get_userpresence_rules_rule_id_with_http_info(rule_id, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#get_userpresence_rules_rule_id ..." end # verify the required parameter 'rule_id' is set fail "Missing the required parameter 'rule_id' when calling get_userpresence_rules_rule_id" if rule_id.nil? # resource path local_var_path = "/api/v2/alerting/userpresence/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s) # query parameters query_params = {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'UserPresenceRule') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#get_userpresence_rules_rule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Get a user presence rule list.
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [Array<(UserPresenceRuleContainer
, Fixnum, Hash)>] UserPresenceRuleContainer
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 1416 def get_userpresence_rules_with_http_info(opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#get_userpresence_rules ..." end # resource path local_var_path = "/api/v2/alerting/userpresence/rules".sub('{format}','json') # query parameters query_params = {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = nil auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:GET, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'UserPresenceRuleContainer') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#get_userpresence_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create a heart beat rule.
@param body HeartBeatRule
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [HeartBeatRule]
# File lib/purecloud/api/alerting_api.rb, line 1528 def post_heartbeat_rules(body, opts = {}) data, status_code, headers = post_heartbeat_rules_with_http_info(body, opts) return data end
Create a heart beat rule.
@param body HeartBeatRule
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [Array<(HeartBeatRule
, Fixnum, Hash)>] HeartBeatRule
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 1539 def post_heartbeat_rules_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#post_heartbeat_rules ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_heartbeat_rules" if body.nil? # resource path local_var_path = "/api/v2/alerting/heartbeat/rules".sub('{format}','json') # query parameters query_params = {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'HeartBeatRule') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#post_heartbeat_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create an interaction stats rule.
@param body AlertingRule @param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [InteractionStatsRule]
# File lib/purecloud/api/alerting_api.rb, line 1591 def post_interactionstats_rules(body, opts = {}) data, status_code, headers = post_interactionstats_rules_with_http_info(body, opts) return data end
Create an interaction stats rule.
@param body AlertingRule @param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [Array<(InteractionStatsRule
, Fixnum, Hash)>] InteractionStatsRule
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 1602 def post_interactionstats_rules_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#post_interactionstats_rules ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_interactionstats_rules" if body.nil? # resource path local_var_path = "/api/v2/alerting/interactionstats/rules".sub('{format}','json') # query parameters query_params = {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InteractionStatsRule') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#post_interactionstats_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create a routing status rule.
@param body RoutingStatusRule
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [RoutingStatusRule]
# File lib/purecloud/api/alerting_api.rb, line 1654 def post_routingstatus_rules(body, opts = {}) data, status_code, headers = post_routingstatus_rules_with_http_info(body, opts) return data end
Create a routing status rule.
@param body RoutingStatusRule
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [Array<(RoutingStatusRule
, Fixnum, Hash)>] RoutingStatusRule
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 1665 def post_routingstatus_rules_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#post_routingstatus_rules ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_routingstatus_rules" if body.nil? # resource path local_var_path = "/api/v2/alerting/routingstatus/rules".sub('{format}','json') # query parameters query_params = {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'RoutingStatusRule') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#post_routingstatus_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Create a user presence rule.
@param body UserPresenceRule
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [UserPresenceRule]
# File lib/purecloud/api/alerting_api.rb, line 1717 def post_userpresence_rules(body, opts = {}) data, status_code, headers = post_userpresence_rules_with_http_info(body, opts) return data end
Create a user presence rule.
@param body UserPresenceRule
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [Array<(UserPresenceRule
, Fixnum, Hash)>] UserPresenceRule
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 1728 def post_userpresence_rules_with_http_info(body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#post_userpresence_rules ..." end # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling post_userpresence_rules" if body.nil? # resource path local_var_path = "/api/v2/alerting/userpresence/rules".sub('{format}','json') # query parameters query_params = {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:POST, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'UserPresenceRule') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#post_userpresence_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update a heart beat rule
@param rule_id Rule ID @param body HeartBeatRule
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [HeartBeatRule]
# File lib/purecloud/api/alerting_api.rb, line 1781 def put_heartbeat_rules_rule_id(rule_id, body, opts = {}) data, status_code, headers = put_heartbeat_rules_rule_id_with_http_info(rule_id, body, opts) return data end
Update a heart beat rule
@param rule_id Rule ID @param body HeartBeatRule
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [Array<(HeartBeatRule
, Fixnum, Hash)>] HeartBeatRule
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 1793 def put_heartbeat_rules_rule_id_with_http_info(rule_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#put_heartbeat_rules_rule_id ..." end # verify the required parameter 'rule_id' is set fail "Missing the required parameter 'rule_id' when calling put_heartbeat_rules_rule_id" if rule_id.nil? # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling put_heartbeat_rules_rule_id" if body.nil? # resource path local_var_path = "/api/v2/alerting/heartbeat/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s) # query parameters query_params = {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'HeartBeatRule') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#put_heartbeat_rules_rule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update an interaction stats alert read status
@param alert_id Alert ID @param body InteractionStatsAlert
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [UnreadStatus]
# File lib/purecloud/api/alerting_api.rb, line 1849 def put_interactionstats_alerts_alert_id(alert_id, body, opts = {}) data, status_code, headers = put_interactionstats_alerts_alert_id_with_http_info(alert_id, body, opts) return data end
Update an interaction stats alert read status
@param alert_id Alert ID @param body InteractionStatsAlert
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [Array<(UnreadStatus
, Fixnum, Hash)>] UnreadStatus
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 1861 def put_interactionstats_alerts_alert_id_with_http_info(alert_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#put_interactionstats_alerts_alert_id ..." end # verify the required parameter 'alert_id' is set fail "Missing the required parameter 'alert_id' when calling put_interactionstats_alerts_alert_id" if alert_id.nil? # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling put_interactionstats_alerts_alert_id" if body.nil? # resource path local_var_path = "/api/v2/alerting/interactionstats/alerts/{alertId}".sub('{format}','json').sub('{' + 'alertId' + '}', alert_id.to_s) # query parameters query_params = {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'UnreadStatus') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#put_interactionstats_alerts_alert_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update an interaction stats rule
@param rule_id Rule ID @param body AlertingRule @param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [InteractionStatsRule]
# File lib/purecloud/api/alerting_api.rb, line 1917 def put_interactionstats_rules_rule_id(rule_id, body, opts = {}) data, status_code, headers = put_interactionstats_rules_rule_id_with_http_info(rule_id, body, opts) return data end
Update an interaction stats rule
@param rule_id Rule ID @param body AlertingRule @param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [Array<(InteractionStatsRule
, Fixnum, Hash)>] InteractionStatsRule
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 1929 def put_interactionstats_rules_rule_id_with_http_info(rule_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#put_interactionstats_rules_rule_id ..." end # verify the required parameter 'rule_id' is set fail "Missing the required parameter 'rule_id' when calling put_interactionstats_rules_rule_id" if rule_id.nil? # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling put_interactionstats_rules_rule_id" if body.nil? # resource path local_var_path = "/api/v2/alerting/interactionstats/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s) # query parameters query_params = {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'InteractionStatsRule') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#put_interactionstats_rules_rule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update a routing status rule
@param rule_id Rule ID @param body RoutingStatusRule
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [RoutingStatusRule]
# File lib/purecloud/api/alerting_api.rb, line 1985 def put_routingstatus_rules_rule_id(rule_id, body, opts = {}) data, status_code, headers = put_routingstatus_rules_rule_id_with_http_info(rule_id, body, opts) return data end
Update a routing status rule
@param rule_id Rule ID @param body RoutingStatusRule
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [Array<(RoutingStatusRule
, Fixnum, Hash)>] RoutingStatusRule
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 1997 def put_routingstatus_rules_rule_id_with_http_info(rule_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#put_routingstatus_rules_rule_id ..." end # verify the required parameter 'rule_id' is set fail "Missing the required parameter 'rule_id' when calling put_routingstatus_rules_rule_id" if rule_id.nil? # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling put_routingstatus_rules_rule_id" if body.nil? # resource path local_var_path = "/api/v2/alerting/routingstatus/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s) # query parameters query_params = {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'RoutingStatusRule') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#put_routingstatus_rules_rule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end
Update a user presence rule
@param rule_id Rule ID @param body UserPresenceRule
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [UserPresenceRule]
# File lib/purecloud/api/alerting_api.rb, line 2053 def put_userpresence_rules_rule_id(rule_id, body, opts = {}) data, status_code, headers = put_userpresence_rules_rule_id_with_http_info(rule_id, body, opts) return data end
Update a user presence rule
@param rule_id Rule ID @param body UserPresenceRule
@param [Hash] opts the optional parameters @option opts [Array<String>] :expand Which fields, if any, to expand @return [Array<(UserPresenceRule
, Fixnum, Hash)>] UserPresenceRule
data, response status code and response headers
# File lib/purecloud/api/alerting_api.rb, line 2065 def put_userpresence_rules_rule_id_with_http_info(rule_id, body, opts = {}) if @api_client.config.debugging @api_client.config.logger.debug "Calling API: AlertingApi#put_userpresence_rules_rule_id ..." end # verify the required parameter 'rule_id' is set fail "Missing the required parameter 'rule_id' when calling put_userpresence_rules_rule_id" if rule_id.nil? # verify the required parameter 'body' is set fail "Missing the required parameter 'body' when calling put_userpresence_rules_rule_id" if body.nil? # resource path local_var_path = "/api/v2/alerting/userpresence/rules/{ruleId}".sub('{format}','json').sub('{' + 'ruleId' + '}', rule_id.to_s) # query parameters query_params = {} query_params[:'expand'] = @api_client.build_collection_param(opts[:'expand'], :multi) if opts[:'expand'] # header parameters header_params = {} # HTTP header 'Accept' (if needed) _header_accept = ['application/json'] _header_accept_result = @api_client.select_header_accept(_header_accept) and header_params['Accept'] = _header_accept_result # HTTP header 'Content-Type' _header_content_type = ['application/json'] header_params['Content-Type'] = @api_client.select_header_content_type(_header_content_type) # form parameters form_params = {} # http body (model) post_body = @api_client.object_to_http_body(body) auth_names = ['PureCloud Auth'] data, status_code, headers = @api_client.call_api(:PUT, local_var_path, :header_params => header_params, :query_params => query_params, :form_params => form_params, :body => post_body, :auth_names => auth_names, :return_type => 'UserPresenceRule') if @api_client.config.debugging @api_client.config.logger.debug "API called: AlertingApi#put_userpresence_rules_rule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}" end return data, status_code, headers end