analytics_api.rb in purecloud-0.29.1

- old
+ new
@@ -6,627 +6,9 @@
 
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
 
-    # Get a list of alerts.
-    # 
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page_number Page number
-    # @option opts [Integer] :page_size Page size
-    # @option opts [String] :sort_by title, startTime, endTime, description or unread
-    # @option opts [String] :sort_order ascending or descending
-    # @return [AlertEntityListing]
-    def get_alerting_alerts(opts = {})
-      data, status_code, headers = get_alerting_alerts_with_http_info(opts)
-      return data
-    end
-
-    # Get a list of alerts.
-    # 
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page_number Page number
-    # @option opts [Integer] :page_size Page size
-    # @option opts [String] :sort_by title, startTime, endTime, description or unread
-    # @option opts [String] :sort_order ascending or descending
-    # @return [Array<(AlertEntityListing, Fixnum, Hash)>] AlertEntityListing data, response status code and response headers
-    def get_alerting_alerts_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: AnalyticsApi#get_alerting_alerts ..."
-      end
-      
-      # resource path
-      path = "/api/v2/analytics/alerting/alerts".sub('{format}','json')
-
-      # query parameters
-      query_params = {}
-      query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
-      query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
-      query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
-      query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
-
-      # 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 => 'AlertEntityListing')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AnalyticsApi#get_alerting_alerts\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # A count of unread alerts.
-    # 
-    # @param [Hash] opts the optional parameters
-    # @return [UnreadMetric]
-    def get_alerting_alerts_unread(opts = {})
-      data, status_code, headers = get_alerting_alerts_unread_with_http_info(opts)
-      return data
-    end
-
-    # A count of unread alerts.
-    # 
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(UnreadMetric, Fixnum, Hash)>] UnreadMetric data, response status code and response headers
-    def get_alerting_alerts_unread_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: AnalyticsApi#get_alerting_alerts_unread ..."
-      end
-      
-      # resource path
-      path = "/api/v2/analytics/alerting/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: AnalyticsApi#get_alerting_alerts_unread\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Get an alert.
-    # 
-    # @param alert_id Alert ID
-    # @param [Hash] opts the optional parameters
-    # @return [Alert]
-    def get_alerting_alerts_alert_id(alert_id, opts = {})
-      data, status_code, headers = get_alerting_alerts_alert_id_with_http_info(alert_id, opts)
-      return data
-    end
-
-    # Get an alert.
-    # 
-    # @param alert_id Alert ID
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(Alert, Fixnum, Hash)>] Alert data, response status code and response headers
-    def get_alerting_alerts_alert_id_with_http_info(alert_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: AnalyticsApi#get_alerting_alerts_alert_id ..."
-      end
-      
-      # verify the required parameter 'alert_id' is set
-      fail "Missing the required parameter 'alert_id' when calling get_alerting_alerts_alert_id" if alert_id.nil?
-      
-      # resource path
-      path = "/api/v2/analytics/alerting/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 => 'Alert')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AnalyticsApi#get_alerting_alerts_alert_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Update an alerts unread status.
-    # 
-    # @param alert_id Alert ID
-    # @param [Hash] opts the optional parameters
-    # @option opts [Alert] :body Alert
-    # @return [Alert]
-    def put_alerting_alerts_alert_id(alert_id, opts = {})
-      data, status_code, headers = put_alerting_alerts_alert_id_with_http_info(alert_id, opts)
-      return data
-    end
-
-    # Update an alerts unread status.
-    # 
-    # @param alert_id Alert ID
-    # @param [Hash] opts the optional parameters
-    # @option opts [Alert] :body Alert
-    # @return [Array<(Alert, Fixnum, Hash)>] Alert data, response status code and response headers
-    def put_alerting_alerts_alert_id_with_http_info(alert_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: AnalyticsApi#put_alerting_alerts_alert_id ..."
-      end
-      
-      # verify the required parameter 'alert_id' is set
-      fail "Missing the required parameter 'alert_id' when calling put_alerting_alerts_alert_id" if alert_id.nil?
-      
-      # resource path
-      path = "/api/v2/analytics/alerting/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 => 'Alert')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AnalyticsApi#put_alerting_alerts_alert_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Delete an alert.
-    # 
-    # @param alert_id Alert ID
-    # @param [Hash] opts the optional parameters
-    # @return [nil]
-    def delete_alerting_alerts_alert_id(alert_id, opts = {})
-      delete_alerting_alerts_alert_id_with_http_info(alert_id, opts)
-      return nil
-    end
-
-    # Delete an 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_alerting_alerts_alert_id_with_http_info(alert_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: AnalyticsApi#delete_alerting_alerts_alert_id ..."
-      end
-      
-      # verify the required parameter 'alert_id' is set
-      fail "Missing the required parameter 'alert_id' when calling delete_alerting_alerts_alert_id" if alert_id.nil?
-      
-      # resource path
-      path = "/api/v2/analytics/alerting/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: AnalyticsApi#delete_alerting_alerts_alert_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Get a list of rules.
-    # 
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page_number Page number
-    # @option opts [Integer] :page_size Page size
-    # @option opts [String] :sort_by title, description, inAlarm or enabled
-    # @option opts [String] :sort_order ascending or descending
-    # @return [RuleEntityListing]
-    def get_alerting_rules(opts = {})
-      data, status_code, headers = get_alerting_rules_with_http_info(opts)
-      return data
-    end
-
-    # Get a list of rules.
-    # 
-    # @param [Hash] opts the optional parameters
-    # @option opts [Integer] :page_number Page number
-    # @option opts [Integer] :page_size Page size
-    # @option opts [String] :sort_by title, description, inAlarm or enabled
-    # @option opts [String] :sort_order ascending or descending
-    # @return [Array<(RuleEntityListing, Fixnum, Hash)>] RuleEntityListing data, response status code and response headers
-    def get_alerting_rules_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: AnalyticsApi#get_alerting_rules ..."
-      end
-      
-      # resource path
-      path = "/api/v2/analytics/alerting/rules".sub('{format}','json')
-
-      # query parameters
-      query_params = {}
-      query_params[:'pageNumber'] = opts[:'page_number'] if opts[:'page_number']
-      query_params[:'pageSize'] = opts[:'page_size'] if opts[:'page_size']
-      query_params[:'sortBy'] = opts[:'sort_by'] if opts[:'sort_by']
-      query_params[:'sortOrder'] = opts[:'sort_order'] if opts[:'sort_order']
-
-      # 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 => 'RuleEntityListing')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AnalyticsApi#get_alerting_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Create an alerting rule.
-    # 
-    # @param [Hash] opts the optional parameters
-    # @option opts [Rule] :body Rule
-    # @return [Rule]
-    def post_alerting_rules(opts = {})
-      data, status_code, headers = post_alerting_rules_with_http_info(opts)
-      return data
-    end
-
-    # Create an alerting rule.
-    # 
-    # @param [Hash] opts the optional parameters
-    # @option opts [Rule] :body Rule
-    # @return [Array<(Rule, Fixnum, Hash)>] Rule data, response status code and response headers
-    def post_alerting_rules_with_http_info(opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: AnalyticsApi#post_alerting_rules ..."
-      end
-      
-      # resource path
-      path = "/api/v2/analytics/alerting/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 => 'Rule')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AnalyticsApi#post_alerting_rules\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Get an alerting rule.
-    # 
-    # @param rule_id Rule ID
-    # @param [Hash] opts the optional parameters
-    # @return [Rule]
-    def get_alerting_rules_rule_id(rule_id, opts = {})
-      data, status_code, headers = get_alerting_rules_rule_id_with_http_info(rule_id, opts)
-      return data
-    end
-
-    # Get an alerting rule.
-    # 
-    # @param rule_id Rule ID
-    # @param [Hash] opts the optional parameters
-    # @return [Array<(Rule, Fixnum, Hash)>] Rule data, response status code and response headers
-    def get_alerting_rules_rule_id_with_http_info(rule_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: AnalyticsApi#get_alerting_rules_rule_id ..."
-      end
-      
-      # verify the required parameter 'rule_id' is set
-      fail "Missing the required parameter 'rule_id' when calling get_alerting_rules_rule_id" if rule_id.nil?
-      
-      # resource path
-      path = "/api/v2/analytics/alerting/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 => 'Rule')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AnalyticsApi#get_alerting_rules_rule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Update an alerting rule.
-    # 
-    # @param rule_id Rule ID
-    # @param [Hash] opts the optional parameters
-    # @option opts [Rule] :body Rule
-    # @return [Rule]
-    def put_alerting_rules_rule_id(rule_id, opts = {})
-      data, status_code, headers = put_alerting_rules_rule_id_with_http_info(rule_id, opts)
-      return data
-    end
-
-    # Update an alerting rule.
-    # 
-    # @param rule_id Rule ID
-    # @param [Hash] opts the optional parameters
-    # @option opts [Rule] :body Rule
-    # @return [Array<(Rule, Fixnum, Hash)>] Rule data, response status code and response headers
-    def put_alerting_rules_rule_id_with_http_info(rule_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: AnalyticsApi#put_alerting_rules_rule_id ..."
-      end
-      
-      # verify the required parameter 'rule_id' is set
-      fail "Missing the required parameter 'rule_id' when calling put_alerting_rules_rule_id" if rule_id.nil?
-      
-      # resource path
-      path = "/api/v2/analytics/alerting/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 => 'Rule')
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "API called: AnalyticsApi#put_alerting_rules_rule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
-    # Delete an alerting rule.
-    # 
-    # @param rule_id Rule ID
-    # @param [Hash] opts the optional parameters
-    # @return [nil]
-    def delete_alerting_rules_rule_id(rule_id, opts = {})
-      delete_alerting_rules_rule_id_with_http_info(rule_id, opts)
-      return nil
-    end
-
-    # Delete an alerting 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_alerting_rules_rule_id_with_http_info(rule_id, opts = {})
-      if @api_client.config.debugging
-        @api_client.config.logger.debug "Calling API: AnalyticsApi#delete_alerting_rules_rule_id ..."
-      end
-      
-      # verify the required parameter 'rule_id' is set
-      fail "Missing the required parameter 'rule_id' when calling delete_alerting_rules_rule_id" if rule_id.nil?
-      
-      # resource path
-      path = "/api/v2/analytics/alerting/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: AnalyticsApi#delete_alerting_rules_rule_id\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
-      end
-      return data, status_code, headers
-    end
-
     # Query for conversation aggregates
     # 
     # @param [Hash] opts the optional parameters
     # @option opts [AggregationQuery] :body query
     # @return [AggregateQueryResponse]