Class: UltracartClient::IntegrationLogApi

Inherits:
Object
  • Object
show all
Defined in:
lib/ultracart_api/api/integration_log_api.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ IntegrationLogApi

Returns a new instance of IntegrationLogApi.



19
20
21
 
# File 'lib/ultracart_api/api/integration_log_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/ultracart_api/api/integration_log_api.rb', line 17

def api_client
  @api_client
end

Class Method Details

.new_using_api_key(simple_key, verify_ssl = true, debugging = false) ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
 
# File 'lib/ultracart_api/api/integration_log_api.rb', line 23

def self.new_using_api_key(simple_key, verify_ssl = true, debugging = false)
  api_config = Configuration.new
  api_config.api_key_prefix['x-ultracart-simple-key'] = simple_key
  api_config.api_version = '2017-03-01'
  api_config.verify_ssl = verify_ssl

  api_client = ApiClient.new(api_config)
  api_client.config.debugging = debugging

  UltracartClient::IntegrationLogApi.new(api_client)
end

Instance Method Details

#get_integration_log(pk, sk, opts = {}) ⇒ IntegrationLogResponse

Retrieve an integration log Retrieve an integration logs from the account based identifiers

Parameters:

  • pk (String)
  • sk (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:



41
42
43
44
 
# File 'lib/ultracart_api/api/integration_log_api.rb', line 41

def get_integration_log(pk, sk, opts = {})
  data, _status_code, _headers = get_integration_log_with_http_info(pk, sk, opts)
  data
end

#get_integration_log_file(pk, sk, uuid, opts = {}) ⇒ File

Retrieve an integration log file Retrieve an integration log file from the account based identifiers

Parameters:

  • pk (String)
  • sk (String)
  • uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


112
113
114
115
 
# File 'lib/ultracart_api/api/integration_log_api.rb', line 112

def get_integration_log_file(pk, sk, uuid, opts = {})
  data, _status_code, _headers = get_integration_log_file_with_http_info(pk, sk, uuid, opts)
  data
end

#get_integration_log_file_pdf(pk, sk, uuid, opts = {}) ⇒ File

Retrieve an integration log file converted to PDF Retrieve an integration log file from the account based identifiers

Parameters:

  • pk (String)
  • sk (String)
  • uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (File) 


188
189
190
191
 
# File 'lib/ultracart_api/api/integration_log_api.rb', line 188

def get_integration_log_file_pdf(pk, sk, uuid, opts = {})
  data, _status_code, _headers = get_integration_log_file_pdf_with_http_info(pk, sk, uuid, opts)
  data
end

#get_integration_log_file_pdf_with_http_info(pk, sk, uuid, opts = {}) ⇒ Array<(File, Integer, Hash)>

Retrieve an integration log file converted to PDF Retrieve an integration log file from the account based identifiers

Parameters:

  • pk (String)
  • sk (String)
  • uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



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
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/ultracart_api/api/integration_log_api.rb', line 200

def get_integration_log_file_pdf_with_http_info(pk, sk, uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationLogApi.get_integration_log_file_pdf ...'
  end
  # verify the required parameter 'pk' is set
  if @api_client.config.client_side_validation && pk.nil?
    fail ArgumentError, "Missing the required parameter 'pk' when calling IntegrationLogApi.get_integration_log_file_pdf"
  end
  # verify the required parameter 'sk' is set
  if @api_client.config.client_side_validation && sk.nil?
    fail ArgumentError, "Missing the required parameter 'sk' when calling IntegrationLogApi.get_integration_log_file_pdf"
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling IntegrationLogApi.get_integration_log_file_pdf"
  end
  # resource path
  local_var_path = '/integration_log/query/{pk}/{sk}/{uuid}/pdf'.sub('{' + 'pk' + '}', CGI.escape(pk.to_s)).sub('{' + 'sk' + '}', CGI.escape(sk.to_s)).sub('{' + 'uuid' + '}', CGI.escape(uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"IntegrationLogApi.get_integration_log_file_pdf",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationLogApi#get_integration_log_file_pdf\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integration_log_file_with_http_info(pk, sk, uuid, opts = {}) ⇒ Array<(File, Integer, Hash)>

Retrieve an integration log file Retrieve an integration log file from the account based identifiers

Parameters:

  • pk (String)
  • sk (String)
  • uuid (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(File, Integer, Hash)>) —

    File data, response status code and response headers



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
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/ultracart_api/api/integration_log_api.rb', line 124

def get_integration_log_file_with_http_info(pk, sk, uuid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationLogApi.get_integration_log_file ...'
  end
  # verify the required parameter 'pk' is set
  if @api_client.config.client_side_validation && pk.nil?
    fail ArgumentError, "Missing the required parameter 'pk' when calling IntegrationLogApi.get_integration_log_file"
  end
  # verify the required parameter 'sk' is set
  if @api_client.config.client_side_validation && sk.nil?
    fail ArgumentError, "Missing the required parameter 'sk' when calling IntegrationLogApi.get_integration_log_file"
  end
  # verify the required parameter 'uuid' is set
  if @api_client.config.client_side_validation && uuid.nil?
    fail ArgumentError, "Missing the required parameter 'uuid' when calling IntegrationLogApi.get_integration_log_file"
  end
  # resource path
  local_var_path = '/integration_log/query/{pk}/{sk}/{uuid}'.sub('{' + 'pk' + '}', CGI.escape(pk.to_s)).sub('{' + 'sk' + '}', CGI.escape(sk.to_s)).sub('{' + 'uuid' + '}', CGI.escape(uuid.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/octet-stream'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'File'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"IntegrationLogApi.get_integration_log_file",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationLogApi#get_integration_log_file\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integration_log_summaries_query(integration_log_summaries_query, opts = {}) ⇒ IntegrationLogSummaryQueryResponse

Retrieve integration log summaries Retrieves a set of integration log summaries from the account based on a query object.

Parameters:

Returns:



262
263
264
265
 
# File 'lib/ultracart_api/api/integration_log_api.rb', line 262

def get_integration_log_summaries_query(integration_log_summaries_query, opts = {})
  data, _status_code, _headers = get_integration_log_summaries_query_with_http_info(integration_log_summaries_query, opts)
  data
end

#get_integration_log_summaries_query_with_http_info(integration_log_summaries_query, opts = {}) ⇒ Array<(IntegrationLogSummaryQueryResponse, Integer, Hash)>

Retrieve integration log summaries Retrieves a set of integration log summaries from the account based on a query object.

Parameters:

Returns:



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/ultracart_api/api/integration_log_api.rb', line 272

def get_integration_log_summaries_query_with_http_info(integration_log_summaries_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationLogApi.get_integration_log_summaries_query ...'
  end
  # verify the required parameter 'integration_log_summaries_query' is set
  if @api_client.config.client_side_validation && integration_log_summaries_query.nil?
    fail ArgumentError, "Missing the required parameter 'integration_log_summaries_query' when calling IntegrationLogApi.get_integration_log_summaries_query"
  end
  # resource path
  local_var_path = '/integration_log/summary/query'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(integration_log_summaries_query)

  # return_type
  return_type = opts[:debug_return_type] || 'IntegrationLogSummaryQueryResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"IntegrationLogApi.get_integration_log_summaries_query",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationLogApi#get_integration_log_summaries_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integration_log_with_http_info(pk, sk, opts = {}) ⇒ Array<(IntegrationLogResponse, Integer, Hash)>

Retrieve an integration log Retrieve an integration logs from the account based identifiers

Parameters:

  • pk (String)
  • sk (String)
  • opts (Hash) (defaults to: {}) —

    the optional parameters

Returns:

  • (Array<(IntegrationLogResponse, Integer, Hash)>) —

    IntegrationLogResponse data, response status code and response headers



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
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/ultracart_api/api/integration_log_api.rb', line 52

def get_integration_log_with_http_info(pk, sk, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationLogApi.get_integration_log ...'
  end
  # verify the required parameter 'pk' is set
  if @api_client.config.client_side_validation && pk.nil?
    fail ArgumentError, "Missing the required parameter 'pk' when calling IntegrationLogApi.get_integration_log"
  end
  # verify the required parameter 'sk' is set
  if @api_client.config.client_side_validation && sk.nil?
    fail ArgumentError, "Missing the required parameter 'sk' when calling IntegrationLogApi.get_integration_log"
  end
  # resource path
  local_var_path = '/integration_log/query/{pk}/{sk}'.sub('{' + 'pk' + '}', CGI.escape(pk.to_s)).sub('{' + 'sk' + '}', CGI.escape(sk.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'IntegrationLogResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"IntegrationLogApi.get_integration_log",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationLogApi#get_integration_log\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_integration_logs_query(integration_log_query, opts = {}) ⇒ IntegrationLogQueryResponse

Retrieve integration logs Retrieves a set of integration logs from the account based on a query object.

Parameters:

  • integration_log_query (IntegrationLogQueryRequest) —

    Integration log query

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

    the optional parameters

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Default 100, Max 500) (default to 100)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index. (default to 0)

  • :_sort (String) —

    The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

Returns:



334
335
336
337
 
# File 'lib/ultracart_api/api/integration_log_api.rb', line 334

def get_integration_logs_query(integration_log_query, opts = {})
  data, _status_code, _headers = get_integration_logs_query_with_http_info(integration_log_query, opts)
  data
end

#get_integration_logs_query_with_http_info(integration_log_query, opts = {}) ⇒ Array<(IntegrationLogQueryResponse, Integer, Hash)>

Retrieve integration logs Retrieves a set of integration logs from the account based on a query object.

Parameters:

  • integration_log_query (IntegrationLogQueryRequest) —

    Integration log query

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

    the optional parameters

Options Hash (opts):

  • :_limit (Integer) —

    The maximum number of records to return on this one API call. (Default 100, Max 500) (default to 100)

  • :_offset (Integer) —

    Pagination of the record set. Offset is a zero based index. (default to 0)

  • :_sort (String) —

    The sort order of the items. See Sorting documentation for examples of using multiple values and sorting by ascending and descending.

Returns:

  • (Array<(IntegrationLogQueryResponse, Integer, Hash)>) —

    IntegrationLogQueryResponse data, response status code and response headers



347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
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
 
# File 'lib/ultracart_api/api/integration_log_api.rb', line 347

def get_integration_logs_query_with_http_info(integration_log_query, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: IntegrationLogApi.get_integration_logs_query ...'
  end
  # verify the required parameter 'integration_log_query' is set
  if @api_client.config.client_side_validation && integration_log_query.nil?
    fail ArgumentError, "Missing the required parameter 'integration_log_query' when calling IntegrationLogApi.get_integration_logs_query"
  end
  # resource path
  local_var_path = '/integration_log/query'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'_limit'] = opts[:'_limit'] if !opts[:'_limit'].nil?
  query_params[:'_offset'] = opts[:'_offset'] if !opts[:'_offset'].nil?
  query_params[:'_sort'] = opts[:'_sort'] if !opts[:'_sort'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(integration_log_query)

  # return_type
  return_type = opts[:debug_return_type] || 'IntegrationLogQueryResponse'

  # auth_names
  auth_names = opts[:debug_auth_names] || ['ultraCartOauth', 'ultraCartSimpleApiKey']

  new_options = opts.merge(
    :operation => :"IntegrationLogApi.get_integration_logs_query",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: IntegrationLogApi#get_integration_logs_query\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end