Class: SubskribeSandboxClient::MetricsReportingApi

Inherits:
Object
  • Object
show all
Defined in:
lib/subskribe_sandbox/api/metrics_reporting_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ MetricsReportingApi

Returns a new instance of MetricsReportingApi.



19
20
21
 
# File 'lib/subskribe_sandbox/api/metrics_reporting_api.rb', line 19

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



17
18
19
 
# File 'lib/subskribe_sandbox/api/metrics_reporting_api.rb', line 17

def api_client
  @api_client
end

Instance Method Details

#add_external_arr_metrics(opts = {}) ⇒ nil

submit request to generate external arr metrics returns the request with its captured id. Arr metrics will be generated as a backend job

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

  • (nil) 


27
28
29
30
 
# File 'lib/subskribe_sandbox/api/metrics_reporting_api.rb', line 27

def add_external_arr_metrics(opts = {})
  add_external_arr_metrics_with_http_info(opts)
  nil
end

#add_external_arr_metrics_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

submit request to generate external arr metrics returns the request with its captured id. Arr metrics will be generated as a backend job

Parameters:

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

    the optional parameters

Options Hash (opts):

Returns:

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

    nil, response status code and response headers



37
38
39
40
41
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
 
# File 'lib/subskribe_sandbox/api/metrics_reporting_api.rb', line 37

def add_external_arr_metrics_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetricsReportingApi.add_external_arr_metrics ...'
  end
  # resource path
  local_var_path = '/metricsReporting/externalArrMetrics'

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

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

#get_external_arr_metrics(id, opts = {}) ⇒ nil

gets external arr metrics request for the provided id returns the external arr metrics request for the provided id

Parameters:

  • id —

    id of the externalArrMetrics request

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

    the optional parameters

Returns:

  • (nil) 


74
75
76
77
 
# File 'lib/subskribe_sandbox/api/metrics_reporting_api.rb', line 74

def get_external_arr_metrics(id, opts = {})
  get_external_arr_metrics_with_http_info(id, opts)
  nil
end

#get_external_arr_metrics1(opts = {}) ⇒ nil

gets external arr metrics requests submitted returns the paginated list of external arr metrics requests

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String)
  • :limit (Integer)

Returns:

  • (nil) 


126
127
128
129
 
# File 'lib/subskribe_sandbox/api/metrics_reporting_api.rb', line 126

def get_external_arr_metrics1(opts = {})
  get_external_arr_metrics1_with_http_info(opts)
  nil
end

#get_external_arr_metrics1_with_http_info(opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

gets external arr metrics requests submitted returns the paginated list of external arr metrics requests

Parameters:

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

    the optional parameters

Options Hash (opts):

  • :cursor (String)
  • :limit (Integer)

Returns:

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

    nil, response status code and response headers



137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
 
# File 'lib/subskribe_sandbox/api/metrics_reporting_api.rb', line 137

def get_external_arr_metrics1_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetricsReportingApi.get_external_arr_metrics1 ...'
  end
  # resource path
  local_var_path = '/metricsReporting/externalArrMetrics'

  # query parameters
  query_params = {}
  query_params[:'cursor'] = opts[:'cursor'] if !opts[:'cursor'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

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

#get_external_arr_metrics_with_http_info(id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

gets external arr metrics request for the provided id returns the external arr metrics request for the provided id

Parameters:

  • id —

    id of the externalArrMetrics request

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/subskribe_sandbox/api/metrics_reporting_api.rb', line 84

def get_external_arr_metrics_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetricsReportingApi.get_external_arr_metrics ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling MetricsReportingApi.get_external_arr_metrics"
  end
  # resource path
  local_var_path = '/metricsReporting/externalArrMetrics/{id}'.sub('{' + 'id' + '}', id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

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

#populate_arr_metrics_for_subscription(subscription_id, opts = {}) ⇒ nil

submit request to generate/regenerate arr metrics for a subscription returns 200 if the result is successfully submitted to a background task

Parameters:

  • subscription_id —

    id of the subscription

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

    the optional parameters

Returns:

  • (nil) 


176
177
178
179
 
# File 'lib/subskribe_sandbox/api/metrics_reporting_api.rb', line 176

def populate_arr_metrics_for_subscription(subscription_id, opts = {})
  populate_arr_metrics_for_subscription_with_http_info(subscription_id, opts)
  nil
end

#populate_arr_metrics_for_subscription_with_http_info(subscription_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

submit request to generate/regenerate arr metrics for a subscription returns 200 if the result is successfully submitted to a background task

Parameters:

  • subscription_id —

    id of the subscription

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
 
# File 'lib/subskribe_sandbox/api/metrics_reporting_api.rb', line 186

def populate_arr_metrics_for_subscription_with_http_info(subscription_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: MetricsReportingApi.populate_arr_metrics_for_subscription ...'
  end
  # verify the required parameter 'subscription_id' is set
  if @api_client.config.client_side_validation && subscription_id.nil?
    fail ArgumentError, "Missing the required parameter 'subscription_id' when calling MetricsReportingApi.populate_arr_metrics_for_subscription"
  end
  # resource path
  local_var_path = '/metricsReporting/populateArrMetrics/subscriptions/{subscriptionId}'.sub('{' + 'subscriptionId' + '}', subscription_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = {}

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