Class: PureCloud::UsageApi

Inherits:
Object
  • Object
show all
Defined in:
lib/purecloudplatformclientv2/api/usage_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ UsageApi

Returns a new instance of UsageApi.



23
24
25
 
# File 'lib/purecloudplatformclientv2/api/usage_api.rb', line 23

def initialize(api_client = ApiClient.default)
  @api_client = api_client
end

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



21
22
23
 
# File 'lib/purecloudplatformclientv2/api/usage_api.rb', line 21

def api_client
  @api_client
end

Instance Method Details

#get_usage_query_execution_id_results(execution_id, opts = {}) ⇒ ApiUsageQueryResult

Get the results of a usage query

Parameters:

  • execution_id —

    ID of the query execution

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



32
33
34
35
 
# File 'lib/purecloudplatformclientv2/api/usage_api.rb', line 32

def get_usage_query_execution_id_results(execution_id, opts = {})
  data, _status_code, _headers = get_usage_query_execution_id_results_with_http_info(execution_id, opts)
  return data
end

#get_usage_query_execution_id_results_with_http_info(execution_id, opts = {}) ⇒ Array<(ApiUsageQueryResult, Fixnum, Hash)>

Get the results of a usage query

Parameters:

  • execution_id —

    ID of the query execution

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(ApiUsageQueryResult, Fixnum, Hash)>) —

    ApiUsageQueryResult data, response status code and response headers



42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/purecloudplatformclientv2/api/usage_api.rb', line 42

def get_usage_query_execution_id_results_with_http_info(execution_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsageApi.get_usage_query_execution_id_results ..."
  end
  
  
  # verify the required parameter 'execution_id' is set
  fail ArgumentError, "Missing the required parameter 'execution_id' when calling UsageApi.get_usage_query_execution_id_results" if execution_id.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/usage/query/{executionId}/results".sub('{format}','json').sub('{' + 'executionId' + '}', execution_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  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 => 'ApiUsageQueryResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsageApi#get_usage_query_execution_id_results\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_usage_query(body, opts = {}) ⇒ UsageExecutionResult

Query organization API Usage - After calling this method, you will then need to poll for the query results based on the returned execution Id

Parameters:

  • body —

    Query

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



97
98
99
100
 
# File 'lib/purecloudplatformclientv2/api/usage_api.rb', line 97

def post_usage_query(body, opts = {})
  data, _status_code, _headers = post_usage_query_with_http_info(body, opts)
  return data
end

#post_usage_query_with_http_info(body, opts = {}) ⇒ Array<(UsageExecutionResult, Fixnum, Hash)>

Query organization API Usage - After calling this method, you will then need to poll for the query results based on the returned execution Id

Parameters:

  • body —

    Query

  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(UsageExecutionResult, Fixnum, Hash)>) —

    UsageExecutionResult data, response status code and response headers



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
 
# File 'lib/purecloudplatformclientv2/api/usage_api.rb', line 107

def post_usage_query_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: UsageApi.post_usage_query ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling UsageApi.post_usage_query" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/usage/query".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  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 => 'UsageExecutionResult')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: UsageApi#post_usage_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end