Class: UltracartClient::ConfigurationApi

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ ConfigurationApi

Returns a new instance of ConfigurationApi.



19
20
21
 
# File 'lib/ultracart_api/api/configuration_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/configuration_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/configuration_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::ConfigurationApi.new(api_client)
end

Instance Method Details

#delay_auto_orders(rtg_oid, opts = {}) ⇒ DelayAutoOrdersResponse

Delay auto order processing for a day for this rotating transaction gateway Delay auto order processing for a day for this rotating transaction gateway

Parameters:

  • rtg_oid —

    The rtg_oid to delay.

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

    the optional parameters

Returns:



40
41
42
43
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 40

def delay_auto_orders(rtg_oid, opts = {})
  data, _status_code, _headers = delay_auto_orders_with_http_info(rtg_oid, opts)
  data
end

#delay_auto_orders_with_http_info(rtg_oid, opts = {}) ⇒ Array<(DelayAutoOrdersResponse, Fixnum, Hash)>

Delay auto order processing for a day for this rotating transaction gateway Delay auto order processing for a day for this rotating transaction gateway

Parameters:

  • rtg_oid —

    The rtg_oid to delay.

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

    the optional parameters

Returns:

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

    DelayAutoOrdersResponse data, response status code and response headers



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
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 50

def delay_auto_orders_with_http_info(rtg_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.delay_auto_orders ...'
  end
  # verify the required parameter 'rtg_oid' is set
  if @api_client.config.client_side_validation && rtg_oid.nil?
    fail ArgumentError, "Missing the required parameter 'rtg_oid' when calling ConfigurationApi.delay_auto_orders"
  end
  # resource path
  local_var_path = '/configuration/checkout/payments/rtg/{rtg_oid}/delayAutoOrders'.sub('{' + 'rtg_oid' + '}', rtg_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])

  # form parameters
  form_params = {}

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

#delete_rotating_transaction_gateway(rtg_oid, opts = {}) ⇒ BaseResponse

Delete a rotating transaction gateway Delete a rotating transaction gateway

Parameters:

  • rtg_oid —

    The rtg_oid to delete.

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

    the optional parameters

Returns:



95
96
97
98
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 95

def delete_rotating_transaction_gateway(rtg_oid, opts = {})
  data, _status_code, _headers = delete_rotating_transaction_gateway_with_http_info(rtg_oid, opts)
  data
end

#delete_rotating_transaction_gateway_with_http_info(rtg_oid, opts = {}) ⇒ Array<(BaseResponse, Fixnum, Hash)>

Delete a rotating transaction gateway Delete a rotating transaction gateway

Parameters:

  • rtg_oid —

    The rtg_oid to delete.

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

    the optional parameters

Returns:

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

    BaseResponse data, response status code and response headers



105
106
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
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 105

def delete_rotating_transaction_gateway_with_http_info(rtg_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.delete_rotating_transaction_gateway ...'
  end
  # verify the required parameter 'rtg_oid' is set
  if @api_client.config.client_side_validation && rtg_oid.nil?
    fail ArgumentError, "Missing the required parameter 'rtg_oid' when calling ConfigurationApi.delete_rotating_transaction_gateway"
  end
  # resource path
  local_var_path = '/configuration/checkout/payments/rtg/{rtg_oid}'.sub('{' + 'rtg_oid' + '}', rtg_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'BaseResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: ConfigurationApi#delete_rotating_transaction_gateway\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_payments_configuration(opts = {}) ⇒ PaymentsConfigurationResponse

Retrieve payments configuration Retrieves payments configuration for this account.

Parameters:

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

    the optional parameters

Returns:



149
150
151
152
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 149

def get_payments_configuration(opts = {})
  data, _status_code, _headers = get_payments_configuration_with_http_info(opts)
  data
end

#get_payments_configuration_with_http_info(opts = {}) ⇒ Array<(PaymentsConfigurationResponse, Fixnum, Hash)>

Retrieve payments configuration Retrieves payments configuration for this account.

Parameters:

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

    the optional parameters

Returns:



158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 158

def get_payments_configuration_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.get_payments_configuration ...'
  end
  # resource path
  local_var_path = '/configuration/checkout/payments'

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

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

#get_payments_rotating_gateway(rtg_oid, opts = {}) ⇒ RotatingTransactionGatewayResponse

Retrieve a rotating transaction gateway Retrieve a rotating transaction gateway

Parameters:

  • rtg_oid —

    The rtg_oid for the desired record.

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

    the optional parameters

Returns:



199
200
201
202
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 199

def get_payments_rotating_gateway(rtg_oid, opts = {})
  data, _status_code, _headers = get_payments_rotating_gateway_with_http_info(rtg_oid, opts)
  data
end

#get_payments_rotating_gateway_by_code(code, opts = {}) ⇒ RotatingTransactionGatewayResponse

Retrieve a rotating transaction gateway by code Retrieve a rotating transaction gateway by code

Parameters:

  • code —

    The code for the desired rotating transaction gateway.

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

    the optional parameters

Returns:



254
255
256
257
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 254

def get_payments_rotating_gateway_by_code(code, opts = {})
  data, _status_code, _headers = get_payments_rotating_gateway_by_code_with_http_info(code, opts)
  data
end

#get_payments_rotating_gateway_by_code_with_http_info(code, opts = {}) ⇒ Array<(RotatingTransactionGatewayResponse, Fixnum, Hash)>

Retrieve a rotating transaction gateway by code Retrieve a rotating transaction gateway by code

Parameters:

  • code —

    The code for the desired rotating transaction gateway.

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

    the optional parameters

Returns:



264
265
266
267
268
269
270
271
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
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 264

def get_payments_rotating_gateway_by_code_with_http_info(code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.get_payments_rotating_gateway_by_code ...'
  end
  # verify the required parameter 'code' is set
  if @api_client.config.client_side_validation && code.nil?
    fail ArgumentError, "Missing the required parameter 'code' when calling ConfigurationApi.get_payments_rotating_gateway_by_code"
  end
  # resource path
  local_var_path = '/configuration/checkout/payments/rtg/byCode/{code}'.sub('{' + 'code' + '}', code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

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

#get_payments_rotating_gateway_with_http_info(rtg_oid, opts = {}) ⇒ Array<(RotatingTransactionGatewayResponse, Fixnum, Hash)>

Retrieve a rotating transaction gateway Retrieve a rotating transaction gateway

Parameters:

  • rtg_oid —

    The rtg_oid for the desired record.

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

    the optional parameters

Returns:



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
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 209

def get_payments_rotating_gateway_with_http_info(rtg_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.get_payments_rotating_gateway ...'
  end
  # verify the required parameter 'rtg_oid' is set
  if @api_client.config.client_side_validation && rtg_oid.nil?
    fail ArgumentError, "Missing the required parameter 'rtg_oid' when calling ConfigurationApi.get_payments_rotating_gateway"
  end
  # resource path
  local_var_path = '/configuration/checkout/payments/rtg/{rtg_oid}'.sub('{' + 'rtg_oid' + '}', rtg_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

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

#get_payments_rotating_transaction_gateways(opts = {}) ⇒ RotatingTransactionGatewaysResponse

Retrieve a list of rotating transaction gateways Retrieve a list of rotating transaction gateways

Parameters:

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

    the optional parameters

Returns:



308
309
310
311
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 308

def get_payments_rotating_transaction_gateways(opts = {})
  data, _status_code, _headers = get_payments_rotating_transaction_gateways_with_http_info(opts)
  data
end

#get_payments_rotating_transaction_gateways_with_http_info(opts = {}) ⇒ Array<(RotatingTransactionGatewaysResponse, Fixnum, Hash)>

Retrieve a list of rotating transaction gateways Retrieve a list of rotating transaction gateways

Parameters:

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

    the optional parameters

Returns:



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
348
349
350
351
352
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 317

def get_payments_rotating_transaction_gateways_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.get_payments_rotating_transaction_gateways ...'
  end
  # resource path
  local_var_path = '/configuration/checkout/payments/rtg'

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

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

#get_payments_rtg_summaries(opts = {}) ⇒ RtgSummaryResponse

Retrieve a summary of rotating transaction gateways Retrieve a summary of rotating transaction gateways

Parameters:

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

    the optional parameters

Returns:



357
358
359
360
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 357

def get_payments_rtg_summaries(opts = {})
  data, _status_code, _headers = get_payments_rtg_summaries_with_http_info(opts)
  data
end

#get_payments_rtg_summaries_with_http_info(opts = {}) ⇒ Array<(RtgSummaryResponse, Fixnum, Hash)>

Retrieve a summary of rotating transaction gateways Retrieve a summary of rotating transaction gateways

Parameters:

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

    the optional parameters

Returns:

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

    RtgSummaryResponse data, response status code and response headers



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
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 366

def get_payments_rtg_summaries_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.get_payments_rtg_summaries ...'
  end
  # resource path
  local_var_path = '/configuration/checkout/payments/rtg/summaries'

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

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

#get_payments_transaction_gateways(opts = {}) ⇒ TransactionGatewaysResponse

Retrieve a list of transaction gateways Retrieve a list of transaction gateways

Parameters:

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

    the optional parameters

Returns:



406
407
408
409
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 406

def get_payments_transaction_gateways(opts = {})
  data, _status_code, _headers = get_payments_transaction_gateways_with_http_info(opts)
  data
end

#get_payments_transaction_gateways_with_http_info(opts = {}) ⇒ Array<(TransactionGatewaysResponse, Fixnum, Hash)>

Retrieve a list of transaction gateways Retrieve a list of transaction gateways

Parameters:

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

    the optional parameters

Returns:



415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 415

def get_payments_transaction_gateways_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.get_payments_transaction_gateways ...'
  end
  # resource path
  local_var_path = '/configuration/checkout/payments/tg'

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])

  # form parameters
  form_params = {}

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

#insert_rotating_transaction_gateway(rotating_transaction_gateway, opts = {}) ⇒ RotatingTransactionGatewayResponse

Insert a rotating transaction gateway Insert a rotating transaction gateway

Parameters:

  • rotating_transaction_gateway —

    Rotating transaction gateway

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

    the optional parameters

Returns:



456
457
458
459
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 456

def insert_rotating_transaction_gateway(rotating_transaction_gateway, opts = {})
  data, _status_code, _headers = insert_rotating_transaction_gateway_with_http_info(rotating_transaction_gateway, opts)
  data
end

#insert_rotating_transaction_gateway_with_http_info(rotating_transaction_gateway, opts = {}) ⇒ Array<(RotatingTransactionGatewayResponse, Fixnum, Hash)>

Insert a rotating transaction gateway Insert a rotating transaction gateway

Parameters:

  • rotating_transaction_gateway —

    Rotating transaction gateway

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

    the optional parameters

Returns:



466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 466

def insert_rotating_transaction_gateway_with_http_info(rotating_transaction_gateway, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.insert_rotating_transaction_gateway ...'
  end
  # verify the required parameter 'rotating_transaction_gateway' is set
  if @api_client.config.client_side_validation && rotating_transaction_gateway.nil?
    fail ArgumentError, "Missing the required parameter 'rotating_transaction_gateway' when calling ConfigurationApi.insert_rotating_transaction_gateway"
  end
  # resource path
  local_var_path = '/configuration/checkout/payments/rtg/'

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])

  # form parameters
  form_params = {}

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

#migrate_to_rotating_transaction_gateway(code, opts = {}) ⇒ RotatingTransactionGatewayResponse

Migrate a normal transaction gateway to a rotating transaction gateway Migrate a normal transaction gateway to a rotating transaction gateway

Parameters:

  • code —

    The short code for the new rotating transaction gateway

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

    the optional parameters

Returns:



511
512
513
514
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 511

def migrate_to_rotating_transaction_gateway(code, opts = {})
  data, _status_code, _headers = migrate_to_rotating_transaction_gateway_with_http_info(code, opts)
  data
end

#migrate_to_rotating_transaction_gateway_with_http_info(code, opts = {}) ⇒ Array<(RotatingTransactionGatewayResponse, Fixnum, Hash)>

Migrate a normal transaction gateway to a rotating transaction gateway Migrate a normal transaction gateway to a rotating transaction gateway

Parameters:

  • code —

    The short code for the new rotating transaction gateway

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

    the optional parameters

Returns:



521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 521

def migrate_to_rotating_transaction_gateway_with_http_info(code, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.migrate_to_rotating_transaction_gateway ...'
  end
  # verify the required parameter 'code' is set
  if @api_client.config.client_side_validation && code.nil?
    fail ArgumentError, "Missing the required parameter 'code' when calling ConfigurationApi.migrate_to_rotating_transaction_gateway"
  end
  # resource path
  local_var_path = '/configuration/checkout/payments/tg/migrateToRtgWithCodeOf/{code}'.sub('{' + 'code' + '}', code.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])

  # form parameters
  form_params = {}

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

#stripe_connect(rtg_oid, opts = {}) ⇒ StripeConnectResponse

Begin the processing of connecting with Stripe Begin the processing of connecting with Stripe.

Parameters:

  • rtg_oid —

    The rtg_oid to be connected to stripe.

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

    the optional parameters

Returns:



566
567
568
569
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 566

def stripe_connect(rtg_oid, opts = {})
  data, _status_code, _headers = stripe_connect_with_http_info(rtg_oid, opts)
  data
end

#stripe_connect_with_http_info(rtg_oid, opts = {}) ⇒ Array<(StripeConnectResponse, Fixnum, Hash)>

Begin the processing of connecting with Stripe Begin the processing of connecting with Stripe.

Parameters:

  • rtg_oid —

    The rtg_oid to be connected to stripe.

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

    the optional parameters

Returns:

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

    StripeConnectResponse data, response status code and response headers



576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 576

def stripe_connect_with_http_info(rtg_oid, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.stripe_connect ...'
  end
  # verify the required parameter 'rtg_oid' is set
  if @api_client.config.client_side_validation && rtg_oid.nil?
    fail ArgumentError, "Missing the required parameter 'rtg_oid' when calling ConfigurationApi.stripe_connect"
  end
  # resource path
  local_var_path = '/configuration/checkout/payments/rtg/{rtg_oid}/stripeConnect'.sub('{' + 'rtg_oid' + '}', rtg_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])

  # form parameters
  form_params = {}

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

#update_payments_configuration(payments_configuration, opts = {}) ⇒ PaymentsConfigurationResponse

Updates payments configuration Updates payments configuration on the UltraCart account.

Parameters:

  • payments_configuration —

    Payments configuration

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

    the optional parameters

Returns:



621
622
623
624
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 621

def update_payments_configuration(payments_configuration, opts = {})
  data, _status_code, _headers = update_payments_configuration_with_http_info(payments_configuration, opts)
  data
end

#update_payments_configuration_with_http_info(payments_configuration, opts = {}) ⇒ Array<(PaymentsConfigurationResponse, Fixnum, Hash)>

Updates payments configuration Updates payments configuration on the UltraCart account.

Parameters:

  • payments_configuration —

    Payments configuration

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

    the optional parameters

Returns:



631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 631

def update_payments_configuration_with_http_info(payments_configuration, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.update_payments_configuration ...'
  end
  # verify the required parameter 'payments_configuration' is set
  if @api_client.config.client_side_validation && payments_configuration.nil?
    fail ArgumentError, "Missing the required parameter 'payments_configuration' when calling ConfigurationApi.update_payments_configuration"
  end
  # resource path
  local_var_path = '/configuration/checkout/payments'

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])

  # form parameters
  form_params = {}

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

#update_payments_transaction_gateway(update_gateway_request, opts = {}) ⇒ TransactionGatewaysResponse

Updates payments transaction gateway Updates payments transaction gateway on the UltraCart account.

Parameters:

  • update_gateway_request —

    Transaction gateways

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

    the optional parameters

Returns:



676
677
678
679
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 676

def update_payments_transaction_gateway(update_gateway_request, opts = {})
  data, _status_code, _headers = update_payments_transaction_gateway_with_http_info(update_gateway_request, opts)
  data
end

#update_payments_transaction_gateway_with_http_info(update_gateway_request, opts = {}) ⇒ Array<(TransactionGatewaysResponse, Fixnum, Hash)>

Updates payments transaction gateway Updates payments transaction gateway on the UltraCart account.

Parameters:

  • update_gateway_request —

    Transaction gateways

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

    the optional parameters

Returns:



686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 686

def update_payments_transaction_gateway_with_http_info(update_gateway_request, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.update_payments_transaction_gateway ...'
  end
  # verify the required parameter 'update_gateway_request' is set
  if @api_client.config.client_side_validation && update_gateway_request.nil?
    fail ArgumentError, "Missing the required parameter 'update_gateway_request' when calling ConfigurationApi.update_payments_transaction_gateway"
  end
  # resource path
  local_var_path = '/configuration/checkout/payments/tg'

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])

  # form parameters
  form_params = {}

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

#update_rotating_transaction_gateway(rtg_oid, rotating_transaction_gateway, opts = {}) ⇒ RotatingTransactionGatewayResponse

Update a rotating transaction gateway Update a rotating transaction gateway

Parameters:

  • rtg_oid —

    The rtg_oid to update.

  • rotating_transaction_gateway —

    Rotating transaction gateway

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

    the optional parameters

Returns:



732
733
734
735
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 732

def update_rotating_transaction_gateway(rtg_oid, rotating_transaction_gateway, opts = {})
  data, _status_code, _headers = update_rotating_transaction_gateway_with_http_info(rtg_oid, rotating_transaction_gateway, opts)
  data
end

#update_rotating_transaction_gateway_with_http_info(rtg_oid, rotating_transaction_gateway, opts = {}) ⇒ Array<(RotatingTransactionGatewayResponse, Fixnum, Hash)>

Update a rotating transaction gateway Update a rotating transaction gateway

Parameters:

  • rtg_oid —

    The rtg_oid to update.

  • rotating_transaction_gateway —

    Rotating transaction gateway

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

    the optional parameters

Returns:



743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 743

def update_rotating_transaction_gateway_with_http_info(rtg_oid, rotating_transaction_gateway, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.update_rotating_transaction_gateway ...'
  end
  # verify the required parameter 'rtg_oid' is set
  if @api_client.config.client_side_validation && rtg_oid.nil?
    fail ArgumentError, "Missing the required parameter 'rtg_oid' when calling ConfigurationApi.update_rotating_transaction_gateway"
  end
  # verify the required parameter 'rotating_transaction_gateway' is set
  if @api_client.config.client_side_validation && rotating_transaction_gateway.nil?
    fail ArgumentError, "Missing the required parameter 'rotating_transaction_gateway' when calling ConfigurationApi.update_rotating_transaction_gateway"
  end
  # resource path
  local_var_path = '/configuration/checkout/payments/rtg/{rtg_oid}'.sub('{' + 'rtg_oid' + '}', rtg_oid.to_s)

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])

  # form parameters
  form_params = {}

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

#wepay_enroll(wepay_enroll, opts = {}) ⇒ PaymentsConfigurationResponse

Enroll with WePay Enroll with WePay on the UltraCart account.

Parameters:

  • wepay_enroll —

    Wepay enrollment information

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

    the optional parameters

Returns:



792
793
794
795
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 792

def wepay_enroll(wepay_enroll, opts = {})
  data, _status_code, _headers = wepay_enroll_with_http_info(wepay_enroll, opts)
  data
end

#wepay_enroll_with_http_info(wepay_enroll, opts = {}) ⇒ Array<(PaymentsConfigurationResponse, Fixnum, Hash)>

Enroll with WePay Enroll with WePay on the UltraCart account.

Parameters:

  • wepay_enroll —

    Wepay enrollment information

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

    the optional parameters

Returns:



802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
 
# File 'lib/ultracart_api/api/configuration_api.rb', line 802

def wepay_enroll_with_http_info(wepay_enroll, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: ConfigurationApi.wepay_enroll ...'
  end
  # verify the required parameter 'wepay_enroll' is set
  if @api_client.config.client_side_validation && wepay_enroll.nil?
    fail ArgumentError, "Missing the required parameter 'wepay_enroll' when calling ConfigurationApi.wepay_enroll"
  end
  # resource path
  local_var_path = '/configuration/checkout/wepayEnroll'

  # query parameters
  query_params = {}

  # header parameters
  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'
  header_params['Content-Type'] = @api_client.select_header_content_type(['application/json; charset=UTF-8'])

  # form parameters
  form_params = {}

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