Class: PostFinanceCheckout::AnalyticsQueryService

Inherits:
Object
  • Object
show all
Defined in:
lib/postfinancecheckout-ruby-sdk/api/analytics_query_service_api.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AnalyticsQueryService

Returns a new instance of AnalyticsQueryService.



24
25
26
 
# File 'lib/postfinancecheckout-ruby-sdk/api/analytics_query_service_api.rb', line 24

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

Instance Attribute Details

#api_client ⇒ Object

Returns the value of attribute api_client.



22
23
24
 
# File 'lib/postfinancecheckout-ruby-sdk/api/analytics_query_service_api.rb', line 22

def api_client
  @api_client
end

Instance Method Details

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

Cancel Execution Cancels the specified query execution.

Parameters:

  • id —

    The ID of the query execution to cancel.

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

    the optional parameters

Returns:

  • (nil) 


33
34
35
36
 
# File 'lib/postfinancecheckout-ruby-sdk/api/analytics_query_service_api.rb', line 33

def cancel_execution(id, opts = {})
  cancel_execution_with_http_info(id, opts)
  return nil
end

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

Returns nil, response status code and response headers.

Parameters:

  • id —

    The ID of the query execution to cancel.

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

    the optional parameters

Returns:

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

    nil, response status code and response headers



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
 
# File 'lib/postfinancecheckout-ruby-sdk/api/analytics_query_service_api.rb', line 44

def cancel_execution_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsQueryService.cancel_execution ..."
  end
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling AnalyticsQueryService.cancel_execution" if id.nil?
  # resource path
  local_var_path = "/analytics-query/cancel-execution".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  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 = ['*/*']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}
  
  # connection timeout
  timeout = @api_client.get_connection_timeout()

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

#fetch_result(id, opts = {}) ⇒ AnalyticsQueryResultBatch

Fetch Result Fetches one batch of the result of a query execution.

Parameters:

  • id —

    The ID of the query execution for which to fetch the result.

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

    the optional parameters

Options Hash (opts):

  • :timeout (Integer) —

    The maximal time in seconds to wait for the result if it is not yet available. Use 0 (the default) to return immediately without waiting.

  • :max_rows (Integer) —

    The maximum number of rows to return per batch. (Between 1 and 999. The default is 999.)

  • :next_token (String) —

    The next-token of the preceding batch to get the next result batch or null to get the first result batch.

Returns:



98
99
100
101
 
# File 'lib/postfinancecheckout-ruby-sdk/api/analytics_query_service_api.rb', line 98

def fetch_result(id, opts = {})
  data, _status_code, _headers = fetch_result_with_http_info(id, opts)
  return data
end

#fetch_result_with_http_info(id, opts = {}) ⇒ Array<(AnalyticsQueryResultBatch, Fixnum, Hash)>

Returns AnalyticsQueryResultBatch data, response status code and response headers.

Parameters:

  • id —

    The ID of the query execution for which to fetch the result.

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

    the optional parameters

Options Hash (opts):

  • :timeout (Integer) —

    The maximal time in seconds to wait for the result if it is not yet available. Use 0 (the default) to return immediately without waiting.

  • :max_rows (Integer) —

    The maximum number of rows to return per batch. (Between 1 and 999. The default is 999.)

  • :next_token (String) —

    The next-token of the preceding batch to get the next result batch or null to get the first result batch.

Returns:

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

    AnalyticsQueryResultBatch data, response status code and response headers



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
156
157
158
159
160
 
# File 'lib/postfinancecheckout-ruby-sdk/api/analytics_query_service_api.rb', line 112

def fetch_result_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsQueryService.fetch_result ..."
  end
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling AnalyticsQueryService.fetch_result" if id.nil?
  # resource path
  local_var_path = "/analytics-query/fetch-result".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'id'] = id
  query_params[:'timeout'] = opts[:'timeout'] if !opts[:'timeout'].nil?
  query_params[:'maxRows'] = opts[:'max_rows'] if !opts[:'max_rows'].nil?
  query_params[:'nextToken'] = opts[:'next_token'] if !opts[:'next_token'].nil?

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  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 = ['*/*']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}
  
  # connection timeout
  timeout = @api_client.get_connection_timeout()

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

#generate_download_url(id, opts = {}) ⇒ String

Generate Download URL Generate a URL from which the results of a query execution can be downloaded in CSV format.

Parameters:

  • id —

    The ID of the query execution for which to generate the download URL.

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

    the optional parameters

Options Hash (opts):

  • :timeout (Integer) —

    The maximal time in seconds to wait for the result if it is not yet available. Use 0 (the default) to return immediately without waiting.

Returns:

  • (String) 


168
169
170
171
 
# File 'lib/postfinancecheckout-ruby-sdk/api/analytics_query_service_api.rb', line 168

def generate_download_url(id, opts = {})
  data, _status_code, _headers = generate_download_url_with_http_info(id, opts)
  return data
end

#generate_download_url_with_http_info(id, opts = {}) ⇒ Array<(String, Fixnum, Hash)>

Returns String data, response status code and response headers.

Parameters:

  • id —

    The ID of the query execution for which to generate the download URL.

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

    the optional parameters

Options Hash (opts):

  • :timeout (Integer) —

    The maximal time in seconds to wait for the result if it is not yet available. Use 0 (the default) to return immediately without waiting.

Returns:

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

    String data, response status code and response headers



180
181
182
183
184
185
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
222
223
224
225
226
 
# File 'lib/postfinancecheckout-ruby-sdk/api/analytics_query_service_api.rb', line 180

def generate_download_url_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsQueryService.generate_download_url ..."
  end
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling AnalyticsQueryService.generate_download_url" if id.nil?
  # resource path
  local_var_path = "/analytics-query/generate-download-url".sub('{format}','json')

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

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['text/plain']
  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 = ['*/*']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}
  
  # connection timeout
  timeout = @api_client.get_connection_timeout()

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

#schema(opts = {}) ⇒ Array<AnalyticsSchemaTable>

Get Schemas Get the schemas describing the available tables and their columns.

Parameters:

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

    the optional parameters

Returns:



232
233
234
235
 
# File 'lib/postfinancecheckout-ruby-sdk/api/analytics_query_service_api.rb', line 232

def schema(opts = {})
  data, _status_code, _headers = schema_with_http_info(opts)
  return data
end

#schema_with_http_info(opts = {}) ⇒ Array<(Array<AnalyticsSchemaTable>, Fixnum, Hash)>

Returns Array<AnalyticsSchemaTable> data, response status code and response headers.

Parameters:

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

    the optional parameters

Returns:

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

    Array<AnalyticsSchemaTable> data, response status code and response headers



242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
 
# File 'lib/postfinancecheckout-ruby-sdk/api/analytics_query_service_api.rb', line 242

def schema_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsQueryService.schema ..."
  end
  # resource path
  local_var_path = "/analytics-query/schema".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  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 = ['*/*']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}
  
  # connection timeout
  timeout = @api_client.get_connection_timeout()

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

#status(id, opts = {}) ⇒ AnalyticsQueryExecution

Execution Status Returns the current status of a query execution.

Parameters:

  • id —

    The ID of the query execution for which to get the status.

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

    the optional parameters

Returns:



291
292
293
294
 
# File 'lib/postfinancecheckout-ruby-sdk/api/analytics_query_service_api.rb', line 291

def status(id, opts = {})
  data, _status_code, _headers = status_with_http_info(id, opts)
  return data
end

#status_with_http_info(id, opts = {}) ⇒ Array<(AnalyticsQueryExecution, Fixnum, Hash)>

Returns AnalyticsQueryExecution data, response status code and response headers.

Parameters:

  • id —

    The ID of the query execution for which to get the status.

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

    the optional parameters

Returns:

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

    AnalyticsQueryExecution data, response status code and response headers



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
 
# File 'lib/postfinancecheckout-ruby-sdk/api/analytics_query_service_api.rb', line 302

def status_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsQueryService.status ..."
  end
  # verify the required parameter 'id' is set
  fail ArgumentError, "Missing the required parameter 'id' when calling AnalyticsQueryService.status" if id.nil?
  # resource path
  local_var_path = "/analytics-query/status".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'id'] = id

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  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 = ['*/*']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}
  
  # connection timeout
  timeout = @api_client.get_connection_timeout()

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

#submit_query(query, opts = {}) ⇒ AnalyticsQueryExecution

Submit Query Submits a query for execution.

Parameters:

  • query —

    The query to submit.

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

    the optional parameters

Returns:



354
355
356
357
 
# File 'lib/postfinancecheckout-ruby-sdk/api/analytics_query_service_api.rb', line 354

def submit_query(query, opts = {})
  data, _status_code, _headers = submit_query_with_http_info(query, opts)
  return data
end

#submit_query_with_http_info(query, opts = {}) ⇒ Array<(AnalyticsQueryExecution, Fixnum, Hash)>

Returns AnalyticsQueryExecution data, response status code and response headers.

Parameters:

  • query —

    The query to submit.

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

    the optional parameters

Returns:

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

    AnalyticsQueryExecution data, response status code and response headers



365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
 
# File 'lib/postfinancecheckout-ruby-sdk/api/analytics_query_service_api.rb', line 365

def submit_query_with_http_info(query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: AnalyticsQueryService.submit_query ..."
  end
  # verify the required parameter 'query' is set
  fail ArgumentError, "Missing the required parameter 'query' when calling AnalyticsQueryService.submit_query" if query.nil?
  # resource path
  local_var_path = "/analytics-query/submit-query".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json;charset=utf-8']
  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;charset=utf-8']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}
  
  # connection timeout
  timeout = @api_client.get_connection_timeout()

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