purecloud 0.28.0 → 0.29.1

data/lib/purecloud/api/alerting_api.rb

@@ -0,0 +1,609 @@
+require "uri"
+
+module PureCloud
+  class AlertingApi
+    attr_accessor :api_client
+
+    def initialize(api_client = ApiClient.default)
+      @api_client = api_client
+    end
+
+    # Get interaction stats alert list.
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [InteractionStatsAlertContainer]
+    def get_interactionstats_alerts(opts = {})
+      data, status_code, headers = get_interactionstats_alerts_with_http_info(opts)
+      return data
+    end
+
+    # Get interaction stats alert list.
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InteractionStatsAlertContainer, Fixnum, Hash)>] InteractionStatsAlertContainer data, response status code and response headers
+    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
+      path = "/api/v2/alerting/interactionstats/alerts".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, 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
+
+    # Gets user unread count of interaction stats alerts.
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [UnreadMetric]
+    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
+    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
+      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, 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 an interaction stats alert
+    # 
+    # @param alert_id Alert ID
+    # @param [Hash] opts the optional parameters
+    # @return [InteractionStatsAlert]
+    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
+    # @return [Array<(InteractionStatsAlert, Fixnum, Hash)>] InteractionStatsAlert data, response status code and response headers
+    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
+      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(:GET, 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
+
+    # Update an interaction stats alert read status
+    # 
+    # @param alert_id Alert ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [UnreadStatus] :body InteractionStatsAlert
+    # @return [UnreadStatus]
+    def put_interactionstats_alerts_alert_id(alert_id, opts = {})
+      data, status_code, headers = put_interactionstats_alerts_alert_id_with_http_info(alert_id, opts)
+      return data
+    end
+
+    # Update an interaction stats alert read status
+    # 
+    # @param alert_id Alert ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [UnreadStatus] :body InteractionStatsAlert
+    # @return [Array<(UnreadStatus, Fixnum, Hash)>] UnreadStatus data, response status code and response headers
+    def put_interactionstats_alerts_alert_id_with_http_info(alert_id, 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?
+      
+      # resource path
+      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 = @api_client.object_to_http_body(opts[:'body'])
+      
+
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:PUT, 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
+
+    # Delete an interaction stats alert
+    # 
+    # @param alert_id Alert ID
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    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
+    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
+      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, 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
+
+    # Get an interaction stats rule list.
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [InteractionStatsRuleContainer]
+    def get_interactionstats_rules(opts = {})
+      data, status_code, headers = get_interactionstats_rules_with_http_info(opts)
+      return data
+    end
+
+    # Get an interaction stats rule list.
+    # 
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(InteractionStatsRuleContainer, Fixnum, Hash)>] InteractionStatsRuleContainer data, response status code and response headers
+    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
+      path = "/api/v2/alerting/interactionstats/rules".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, 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
+
+    # Create an interaction stats rule.
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [InteractionStatsRule] :body AlertingRule
+    # @return [InteractionStatsRule]
+    def post_interactionstats_rules(opts = {})
+      data, status_code, headers = post_interactionstats_rules_with_http_info(opts)
+      return data
+    end
+
+    # Create an interaction stats rule.
+    # 
+    # @param [Hash] opts the optional parameters
+    # @option opts [InteractionStatsRule] :body AlertingRule
+    # @return [Array<(InteractionStatsRule, Fixnum, Hash)>] InteractionStatsRule data, response status code and response headers
+    def post_interactionstats_rules_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "Calling API: AlertingApi#post_interactionstats_rules ..."
+      end
+      
+      # resource path
+      path = "/api/v2/alerting/interactionstats/rules".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 = @api_client.object_to_http_body(opts[:'body'])
+      
+
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:POST, 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
+
+    # Get an interaction stats rule.
+    # 
+    # @param rule_id Rule ID
+    # @param [Hash] opts the optional parameters
+    # @return [InteractionStatsRule]
+    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
+    # @return [Array<(InteractionStatsRule, Fixnum, Hash)>] InteractionStatsRule data, response status code and response headers
+    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
+      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(:GET, 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
+
+    # Update an interaction stats rule
+    # 
+    # @param rule_id Rule ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [InteractionStatsRule] :body AlertingRule
+    # @return [InteractionStatsRule]
+    def put_interactionstats_rules_rule_id(rule_id, opts = {})
+      data, status_code, headers = put_interactionstats_rules_rule_id_with_http_info(rule_id, opts)
+      return data
+    end
+
+    # Update an interaction stats rule
+    # 
+    # @param rule_id Rule ID
+    # @param [Hash] opts the optional parameters
+    # @option opts [InteractionStatsRule] :body AlertingRule
+    # @return [Array<(InteractionStatsRule, Fixnum, Hash)>] InteractionStatsRule data, response status code and response headers
+    def put_interactionstats_rules_rule_id_with_http_info(rule_id, 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?
+      
+      # resource path
+      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 = @api_client.object_to_http_body(opts[:'body'])
+      
+
+      auth_names = ['PureCloud Auth']
+      data, status_code, headers = @api_client.call_api(:PUT, 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
+
+    # Delete an interaction stats rule.
+    # 
+    # @param rule_id Rule ID
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    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
+    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
+      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, 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
+  end
+end
+
+
+
+