ultracart_api 3.10.14 → 3.10.17

Sign up to get free protection for your applications and to get access to all the features.
Files changed (85) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +49 -97
  3. data/docs/ChannelPartnerApi.md +51 -0
  4. data/docs/{DelayAutoOrdersResponse.md → ChannelPartnerEstimateTaxResponse.md} +2 -2
  5. data/lib/ultracart_api/api/channel_partner_api.rb +55 -0
  6. data/lib/ultracart_api/models/{stripe_connect_response.rb → channel_partner_estimate_tax_response.rb} +8 -8
  7. data/lib/ultracart_api/version.rb +1 -1
  8. data/lib/ultracart_api.rb +1 -39
  9. metadata +4 -80
  10. data/docs/ConfigurationApi.md +0 -756
  11. data/docs/PaymentsConfiguration.md +0 -24
  12. data/docs/PaymentsConfigurationAffirm.md +0 -15
  13. data/docs/PaymentsConfigurationAmazon.md +0 -15
  14. data/docs/PaymentsConfigurationCOD.md +0 -13
  15. data/docs/PaymentsConfigurationCash.md +0 -9
  16. data/docs/PaymentsConfigurationCheck.md +0 -19
  17. data/docs/PaymentsConfigurationCreditCard.md +0 -17
  18. data/docs/PaymentsConfigurationCreditCardType.md +0 -18
  19. data/docs/PaymentsConfigurationEcheck.md +0 -12
  20. data/docs/PaymentsConfigurationInsurance.md +0 -9
  21. data/docs/PaymentsConfigurationLoanHero.md +0 -12
  22. data/docs/PaymentsConfigurationMoneyOrder.md +0 -11
  23. data/docs/PaymentsConfigurationPayPal.md +0 -36
  24. data/docs/PaymentsConfigurationPurchaseOrder.md +0 -11
  25. data/docs/PaymentsConfigurationQuoteRequest.md +0 -10
  26. data/docs/PaymentsConfigurationResponse.md +0 -12
  27. data/docs/PaymentsConfigurationRestrictions.md +0 -21
  28. data/docs/PaymentsConfigurationRestrictionsTheme.md +0 -10
  29. data/docs/PaymentsConfigurationSezzle.md +0 -15
  30. data/docs/PaymentsConfigurationTestMethod.md +0 -18
  31. data/docs/PaymentsConfigurationWePay.md +0 -35
  32. data/docs/PaymentsConfigurationWireTransfer.md +0 -18
  33. data/docs/PaymentsThemeTransactionType.md +0 -10
  34. data/docs/PaymentsWepayEnroll.md +0 -22
  35. data/docs/RotatingTransactionGateway.md +0 -51
  36. data/docs/RotatingTransactionGatewayResponse.md +0 -12
  37. data/docs/RotatingTransactionGatewaysResponse.md +0 -12
  38. data/docs/RtgCurrency.md +0 -10
  39. data/docs/RtgDayOfMonthRestriction.md +0 -9
  40. data/docs/RtgDayOfWeekRestriction.md +0 -10
  41. data/docs/RtgSummaryGateway.md +0 -24
  42. data/docs/RtgSummaryResponse.md +0 -14
  43. data/docs/RtgThemeRestriction.md +0 -10
  44. data/docs/StripeConnectResponse.md +0 -12
  45. data/docs/TransactionGateway.md +0 -71
  46. data/docs/TransactionGatewaysRequest.md +0 -10
  47. data/docs/TransactionGatewaysResponse.md +0 -12
  48. data/lib/ultracart_api/api/configuration_api.rb +0 -843
  49. data/lib/ultracart_api/models/delay_auto_orders_response.rb +0 -221
  50. data/lib/ultracart_api/models/payments_configuration.rb +0 -329
  51. data/lib/ultracart_api/models/payments_configuration_affirm.rb +0 -288
  52. data/lib/ultracart_api/models/payments_configuration_amazon.rb +0 -288
  53. data/lib/ultracart_api/models/payments_configuration_cash.rb +0 -194
  54. data/lib/ultracart_api/models/payments_configuration_check.rb +0 -294
  55. data/lib/ultracart_api/models/payments_configuration_cod.rb +0 -234
  56. data/lib/ultracart_api/models/payments_configuration_credit_card.rb +0 -279
  57. data/lib/ultracart_api/models/payments_configuration_credit_card_type.rb +0 -318
  58. data/lib/ultracart_api/models/payments_configuration_echeck.rb +0 -226
  59. data/lib/ultracart_api/models/payments_configuration_insurance.rb +0 -194
  60. data/lib/ultracart_api/models/payments_configuration_loan_hero.rb +0 -224
  61. data/lib/ultracart_api/models/payments_configuration_money_order.rb +0 -214
  62. data/lib/ultracart_api/models/payments_configuration_pay_pal.rb +0 -534
  63. data/lib/ultracart_api/models/payments_configuration_purchase_order.rb +0 -214
  64. data/lib/ultracart_api/models/payments_configuration_quote_request.rb +0 -204
  65. data/lib/ultracart_api/models/payments_configuration_response.rb +0 -221
  66. data/lib/ultracart_api/models/payments_configuration_restrictions.rb +0 -447
  67. data/lib/ultracart_api/models/payments_configuration_restrictions_theme.rb +0 -202
  68. data/lib/ultracart_api/models/payments_configuration_sezzle.rb +0 -288
  69. data/lib/ultracart_api/models/payments_configuration_test_method.rb +0 -319
  70. data/lib/ultracart_api/models/payments_configuration_we_pay.rb +0 -454
  71. data/lib/ultracart_api/models/payments_configuration_wire_transfer.rb +0 -284
  72. data/lib/ultracart_api/models/payments_theme_transaction_type.rb +0 -239
  73. data/lib/ultracart_api/models/payments_wepay_enroll.rb +0 -310
  74. data/lib/ultracart_api/models/rotating_transaction_gateway.rb +0 -675
  75. data/lib/ultracart_api/models/rotating_transaction_gateway_response.rb +0 -221
  76. data/lib/ultracart_api/models/rotating_transaction_gateways_response.rb +0 -223
  77. data/lib/ultracart_api/models/rtg_currency.rb +0 -205
  78. data/lib/ultracart_api/models/rtg_day_of_month_restriction.rb +0 -195
  79. data/lib/ultracart_api/models/rtg_day_of_week_restriction.rb +0 -205
  80. data/lib/ultracart_api/models/rtg_summary_gateway.rb +0 -329
  81. data/lib/ultracart_api/models/rtg_summary_response.rb +0 -240
  82. data/lib/ultracart_api/models/rtg_theme_restriction.rb +0 -239
  83. data/lib/ultracart_api/models/transaction_gateway.rb +0 -823
  84. data/lib/ultracart_api/models/transaction_gateways_request.rb +0 -242
  85. data/lib/ultracart_api/models/transaction_gateways_response.rb +0 -223
data/docs/ConfigurationApi.md DELETED
@@ -1,756 +0,0 @@
1
- # UltracartClient::ConfigurationApi
2
-
3
- All URIs are relative to *https://secure.ultracart.com/rest/v2*
4
-
5
- Method | HTTP request | Description
6
- ------------- | ------------- | -------------
7
- [**delay_auto_orders**](ConfigurationApi.md#delay_auto_orders) | **POST** /configuration/checkout/payments/rtg/{rtg_oid}/delayAutoOrders | Delay auto order processing for a day for this rotating transaction gateway
8
- [**delete_rotating_transaction_gateway**](ConfigurationApi.md#delete_rotating_transaction_gateway) | **DELETE** /configuration/checkout/payments/rtg/{rtg_oid} | Delete a rotating transaction gateway
9
- [**get_payments_configuration**](ConfigurationApi.md#get_payments_configuration) | **GET** /configuration/checkout/payments | Retrieve payments configuration
10
- [**get_payments_rotating_gateway**](ConfigurationApi.md#get_payments_rotating_gateway) | **GET** /configuration/checkout/payments/rtg/{rtg_oid} | Retrieve a rotating transaction gateway
11
- [**get_payments_rotating_gateway_by_code**](ConfigurationApi.md#get_payments_rotating_gateway_by_code) | **GET** /configuration/checkout/payments/rtg/byCode/{code} | Retrieve a rotating transaction gateway by code
12
- [**get_payments_rotating_transaction_gateways**](ConfigurationApi.md#get_payments_rotating_transaction_gateways) | **GET** /configuration/checkout/payments/rtg | Retrieve a list of rotating transaction gateways
13
- [**get_payments_rtg_summaries**](ConfigurationApi.md#get_payments_rtg_summaries) | **GET** /configuration/checkout/payments/rtg/summaries | Retrieve a summary of rotating transaction gateways
14
- [**get_payments_transaction_gateways**](ConfigurationApi.md#get_payments_transaction_gateways) | **GET** /configuration/checkout/payments/tg | Retrieve a list of transaction gateways
15
- [**insert_rotating_transaction_gateway**](ConfigurationApi.md#insert_rotating_transaction_gateway) | **POST** /configuration/checkout/payments/rtg/ | Insert a rotating transaction gateway
16
- [**migrate_to_rotating_transaction_gateway**](ConfigurationApi.md#migrate_to_rotating_transaction_gateway) | **POST** /configuration/checkout/payments/tg/migrateToRtgWithCodeOf/{code} | Migrate a normal transaction gateway to a rotating transaction gateway
17
- [**stripe_connect**](ConfigurationApi.md#stripe_connect) | **POST** /configuration/checkout/payments/rtg/{rtg_oid}/stripeConnect | Begin the processing of connecting with Stripe
18
- [**update_payments_configuration**](ConfigurationApi.md#update_payments_configuration) | **PUT** /configuration/checkout/payments | Updates payments configuration
19
- [**update_payments_transaction_gateway**](ConfigurationApi.md#update_payments_transaction_gateway) | **PUT** /configuration/checkout/payments/tg | Updates payments transaction gateway
20
- [**update_rotating_transaction_gateway**](ConfigurationApi.md#update_rotating_transaction_gateway) | **PUT** /configuration/checkout/payments/rtg/{rtg_oid} | Update a rotating transaction gateway
21
- [**wepay_enroll**](ConfigurationApi.md#wepay_enroll) | **PUT** /configuration/checkout/wepayEnroll | Enroll with WePay
22
-
23
-
24
- # **delay_auto_orders**
25
- > DelayAutoOrdersResponse delay_auto_orders(rtg_oid)
26
-
27
- Delay auto order processing for a day for this rotating transaction gateway
28
-
29
- Delay auto order processing for a day for this rotating transaction gateway
30
-
31
- ### Example
32
- ```ruby
33
- # load the gem
34
- require 'ultracart_api'
35
-
36
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
37
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
38
- api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
39
-
40
-
41
- rtg_oid = 56 # Integer | The rtg_oid to delay.
42
-
43
-
44
- begin
45
- #Delay auto order processing for a day for this rotating transaction gateway
46
- result = api_instance.delay_auto_orders(rtg_oid)
47
- p result
48
- rescue UltracartClient::ApiError => e
49
- puts "Exception when calling ConfigurationApi->delay_auto_orders: #{e}"
50
- end
51
- ```
52
-
53
- ### Parameters
54
-
55
- Name | Type | Description | Notes
56
- ------------- | ------------- | ------------- | -------------
57
- **rtg_oid** | **Integer**| The rtg_oid to delay. |
58
-
59
- ### Return type
60
-
61
- [**DelayAutoOrdersResponse**](DelayAutoOrdersResponse.md)
62
-
63
- ### Authorization
64
-
65
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
66
-
67
- ### HTTP request headers
68
-
69
- - **Content-Type**: application/json; charset=UTF-8
70
- - **Accept**: application/json
71
-
72
-
73
-
74
- # **delete_rotating_transaction_gateway**
75
- > BaseResponse delete_rotating_transaction_gateway(rtg_oid)
76
-
77
- Delete a rotating transaction gateway
78
-
79
- Delete a rotating transaction gateway
80
-
81
- ### Example
82
- ```ruby
83
- # load the gem
84
- require 'ultracart_api'
85
-
86
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
87
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
88
- api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
89
-
90
-
91
- rtg_oid = 56 # Integer | The rtg_oid to delete.
92
-
93
-
94
- begin
95
- #Delete a rotating transaction gateway
96
- result = api_instance.delete_rotating_transaction_gateway(rtg_oid)
97
- p result
98
- rescue UltracartClient::ApiError => e
99
- puts "Exception when calling ConfigurationApi->delete_rotating_transaction_gateway: #{e}"
100
- end
101
- ```
102
-
103
- ### Parameters
104
-
105
- Name | Type | Description | Notes
106
- ------------- | ------------- | ------------- | -------------
107
- **rtg_oid** | **Integer**| The rtg_oid to delete. |
108
-
109
- ### Return type
110
-
111
- [**BaseResponse**](BaseResponse.md)
112
-
113
- ### Authorization
114
-
115
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
116
-
117
- ### HTTP request headers
118
-
119
- - **Content-Type**: application/json; charset=UTF-8
120
- - **Accept**: application/json
121
-
122
-
123
-
124
- # **get_payments_configuration**
125
- > PaymentsConfigurationResponse get_payments_configuration
126
-
127
- Retrieve payments configuration
128
-
129
- Retrieves payments configuration for this account.
130
-
131
- ### Example
132
- ```ruby
133
- # load the gem
134
- require 'ultracart_api'
135
-
136
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
137
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
138
- api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
139
-
140
-
141
-
142
- begin
143
- #Retrieve payments configuration
144
- result = api_instance.get_payments_configuration
145
- p result
146
- rescue UltracartClient::ApiError => e
147
- puts "Exception when calling ConfigurationApi->get_payments_configuration: #{e}"
148
- end
149
- ```
150
-
151
- ### Parameters
152
- This endpoint does not need any parameter.
153
-
154
- ### Return type
155
-
156
- [**PaymentsConfigurationResponse**](PaymentsConfigurationResponse.md)
157
-
158
- ### Authorization
159
-
160
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
161
-
162
- ### HTTP request headers
163
-
164
- - **Content-Type**: application/json
165
- - **Accept**: application/json
166
-
167
-
168
-
169
- # **get_payments_rotating_gateway**
170
- > RotatingTransactionGatewayResponse get_payments_rotating_gateway(rtg_oid)
171
-
172
- Retrieve a rotating transaction gateway
173
-
174
- Retrieve a rotating transaction gateway
175
-
176
- ### Example
177
- ```ruby
178
- # load the gem
179
- require 'ultracart_api'
180
-
181
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
182
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
183
- api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
184
-
185
-
186
- rtg_oid = 56 # Integer | The rtg_oid for the desired record.
187
-
188
-
189
- begin
190
- #Retrieve a rotating transaction gateway
191
- result = api_instance.get_payments_rotating_gateway(rtg_oid)
192
- p result
193
- rescue UltracartClient::ApiError => e
194
- puts "Exception when calling ConfigurationApi->get_payments_rotating_gateway: #{e}"
195
- end
196
- ```
197
-
198
- ### Parameters
199
-
200
- Name | Type | Description | Notes
201
- ------------- | ------------- | ------------- | -------------
202
- **rtg_oid** | **Integer**| The rtg_oid for the desired record. |
203
-
204
- ### Return type
205
-
206
- [**RotatingTransactionGatewayResponse**](RotatingTransactionGatewayResponse.md)
207
-
208
- ### Authorization
209
-
210
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
211
-
212
- ### HTTP request headers
213
-
214
- - **Content-Type**: application/json
215
- - **Accept**: application/json
216
-
217
-
218
-
219
- # **get_payments_rotating_gateway_by_code**
220
- > RotatingTransactionGatewayResponse get_payments_rotating_gateway_by_code(code)
221
-
222
- Retrieve a rotating transaction gateway by code
223
-
224
- Retrieve a rotating transaction gateway by code
225
-
226
- ### Example
227
- ```ruby
228
- # load the gem
229
- require 'ultracart_api'
230
-
231
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
232
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
233
- api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
234
-
235
-
236
- code = 'code_example' # String | The code for the desired rotating transaction gateway.
237
-
238
-
239
- begin
240
- #Retrieve a rotating transaction gateway by code
241
- result = api_instance.get_payments_rotating_gateway_by_code(code)
242
- p result
243
- rescue UltracartClient::ApiError => e
244
- puts "Exception when calling ConfigurationApi->get_payments_rotating_gateway_by_code: #{e}"
245
- end
246
- ```
247
-
248
- ### Parameters
249
-
250
- Name | Type | Description | Notes
251
- ------------- | ------------- | ------------- | -------------
252
- **code** | **String**| The code for the desired rotating transaction gateway. |
253
-
254
- ### Return type
255
-
256
- [**RotatingTransactionGatewayResponse**](RotatingTransactionGatewayResponse.md)
257
-
258
- ### Authorization
259
-
260
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
261
-
262
- ### HTTP request headers
263
-
264
- - **Content-Type**: application/json
265
- - **Accept**: application/json
266
-
267
-
268
-
269
- # **get_payments_rotating_transaction_gateways**
270
- > RotatingTransactionGatewaysResponse get_payments_rotating_transaction_gateways
271
-
272
- Retrieve a list of rotating transaction gateways
273
-
274
- Retrieve a list of rotating transaction gateways
275
-
276
- ### Example
277
- ```ruby
278
- # load the gem
279
- require 'ultracart_api'
280
-
281
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
282
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
283
- api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
284
-
285
-
286
-
287
- begin
288
- #Retrieve a list of rotating transaction gateways
289
- result = api_instance.get_payments_rotating_transaction_gateways
290
- p result
291
- rescue UltracartClient::ApiError => e
292
- puts "Exception when calling ConfigurationApi->get_payments_rotating_transaction_gateways: #{e}"
293
- end
294
- ```
295
-
296
- ### Parameters
297
- This endpoint does not need any parameter.
298
-
299
- ### Return type
300
-
301
- [**RotatingTransactionGatewaysResponse**](RotatingTransactionGatewaysResponse.md)
302
-
303
- ### Authorization
304
-
305
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
306
-
307
- ### HTTP request headers
308
-
309
- - **Content-Type**: application/json
310
- - **Accept**: application/json
311
-
312
-
313
-
314
- # **get_payments_rtg_summaries**
315
- > RtgSummaryResponse get_payments_rtg_summaries
316
-
317
- Retrieve a summary of rotating transaction gateways
318
-
319
- Retrieve a summary of rotating transaction gateways
320
-
321
- ### Example
322
- ```ruby
323
- # load the gem
324
- require 'ultracart_api'
325
-
326
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
327
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
328
- api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
329
-
330
-
331
-
332
- begin
333
- #Retrieve a summary of rotating transaction gateways
334
- result = api_instance.get_payments_rtg_summaries
335
- p result
336
- rescue UltracartClient::ApiError => e
337
- puts "Exception when calling ConfigurationApi->get_payments_rtg_summaries: #{e}"
338
- end
339
- ```
340
-
341
- ### Parameters
342
- This endpoint does not need any parameter.
343
-
344
- ### Return type
345
-
346
- [**RtgSummaryResponse**](RtgSummaryResponse.md)
347
-
348
- ### Authorization
349
-
350
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
351
-
352
- ### HTTP request headers
353
-
354
- - **Content-Type**: application/json
355
- - **Accept**: application/json
356
-
357
-
358
-
359
- # **get_payments_transaction_gateways**
360
- > TransactionGatewaysResponse get_payments_transaction_gateways
361
-
362
- Retrieve a list of transaction gateways
363
-
364
- Retrieve a list of transaction gateways
365
-
366
- ### Example
367
- ```ruby
368
- # load the gem
369
- require 'ultracart_api'
370
-
371
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
372
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
373
- api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
374
-
375
-
376
-
377
- begin
378
- #Retrieve a list of transaction gateways
379
- result = api_instance.get_payments_transaction_gateways
380
- p result
381
- rescue UltracartClient::ApiError => e
382
- puts "Exception when calling ConfigurationApi->get_payments_transaction_gateways: #{e}"
383
- end
384
- ```
385
-
386
- ### Parameters
387
- This endpoint does not need any parameter.
388
-
389
- ### Return type
390
-
391
- [**TransactionGatewaysResponse**](TransactionGatewaysResponse.md)
392
-
393
- ### Authorization
394
-
395
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
396
-
397
- ### HTTP request headers
398
-
399
- - **Content-Type**: application/json
400
- - **Accept**: application/json
401
-
402
-
403
-
404
- # **insert_rotating_transaction_gateway**
405
- > RotatingTransactionGatewayResponse insert_rotating_transaction_gateway(rotating_transaction_gateway)
406
-
407
- Insert a rotating transaction gateway
408
-
409
- Insert a rotating transaction gateway
410
-
411
- ### Example
412
- ```ruby
413
- # load the gem
414
- require 'ultracart_api'
415
-
416
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
417
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
418
- api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
419
-
420
-
421
- rotating_transaction_gateway = UltracartClient::RotatingTransactionGateway.new # RotatingTransactionGateway | Rotating transaction gateway
422
-
423
-
424
- begin
425
- #Insert a rotating transaction gateway
426
- result = api_instance.insert_rotating_transaction_gateway(rotating_transaction_gateway)
427
- p result
428
- rescue UltracartClient::ApiError => e
429
- puts "Exception when calling ConfigurationApi->insert_rotating_transaction_gateway: #{e}"
430
- end
431
- ```
432
-
433
- ### Parameters
434
-
435
- Name | Type | Description | Notes
436
- ------------- | ------------- | ------------- | -------------
437
- **rotating_transaction_gateway** | [**RotatingTransactionGateway**](RotatingTransactionGateway.md)| Rotating transaction gateway |
438
-
439
- ### Return type
440
-
441
- [**RotatingTransactionGatewayResponse**](RotatingTransactionGatewayResponse.md)
442
-
443
- ### Authorization
444
-
445
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
446
-
447
- ### HTTP request headers
448
-
449
- - **Content-Type**: application/json; charset=UTF-8
450
- - **Accept**: application/json
451
-
452
-
453
-
454
- # **migrate_to_rotating_transaction_gateway**
455
- > RotatingTransactionGatewayResponse migrate_to_rotating_transaction_gateway(code)
456
-
457
- Migrate a normal transaction gateway to a rotating transaction gateway
458
-
459
- Migrate a normal transaction gateway to a rotating transaction gateway
460
-
461
- ### Example
462
- ```ruby
463
- # load the gem
464
- require 'ultracart_api'
465
-
466
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
467
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
468
- api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
469
-
470
-
471
- code = 'code_example' # String | The short code for the new rotating transaction gateway
472
-
473
-
474
- begin
475
- #Migrate a normal transaction gateway to a rotating transaction gateway
476
- result = api_instance.migrate_to_rotating_transaction_gateway(code)
477
- p result
478
- rescue UltracartClient::ApiError => e
479
- puts "Exception when calling ConfigurationApi->migrate_to_rotating_transaction_gateway: #{e}"
480
- end
481
- ```
482
-
483
- ### Parameters
484
-
485
- Name | Type | Description | Notes
486
- ------------- | ------------- | ------------- | -------------
487
- **code** | **String**| The short code for the new rotating transaction gateway |
488
-
489
- ### Return type
490
-
491
- [**RotatingTransactionGatewayResponse**](RotatingTransactionGatewayResponse.md)
492
-
493
- ### Authorization
494
-
495
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
496
-
497
- ### HTTP request headers
498
-
499
- - **Content-Type**: application/json; charset=UTF-8
500
- - **Accept**: application/json
501
-
502
-
503
-
504
- # **stripe_connect**
505
- > StripeConnectResponse stripe_connect(rtg_oid)
506
-
507
- Begin the processing of connecting with Stripe
508
-
509
- Begin the processing of connecting with Stripe.
510
-
511
- ### Example
512
- ```ruby
513
- # load the gem
514
- require 'ultracart_api'
515
-
516
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
517
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
518
- api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
519
-
520
-
521
- rtg_oid = 56 # Integer | The rtg_oid to be connected to stripe.
522
-
523
-
524
- begin
525
- #Begin the processing of connecting with Stripe
526
- result = api_instance.stripe_connect(rtg_oid)
527
- p result
528
- rescue UltracartClient::ApiError => e
529
- puts "Exception when calling ConfigurationApi->stripe_connect: #{e}"
530
- end
531
- ```
532
-
533
- ### Parameters
534
-
535
- Name | Type | Description | Notes
536
- ------------- | ------------- | ------------- | -------------
537
- **rtg_oid** | **Integer**| The rtg_oid to be connected to stripe. |
538
-
539
- ### Return type
540
-
541
- [**StripeConnectResponse**](StripeConnectResponse.md)
542
-
543
- ### Authorization
544
-
545
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
546
-
547
- ### HTTP request headers
548
-
549
- - **Content-Type**: application/json; charset=UTF-8
550
- - **Accept**: application/json
551
-
552
-
553
-
554
- # **update_payments_configuration**
555
- > PaymentsConfigurationResponse update_payments_configuration(payments_configuration)
556
-
557
- Updates payments configuration
558
-
559
- Updates payments configuration on the UltraCart account.
560
-
561
- ### Example
562
- ```ruby
563
- # load the gem
564
- require 'ultracart_api'
565
-
566
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
567
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
568
- api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
569
-
570
-
571
- payments_configuration = UltracartClient::PaymentsConfiguration.new # PaymentsConfiguration | Payments configuration
572
-
573
-
574
- begin
575
- #Updates payments configuration
576
- result = api_instance.update_payments_configuration(payments_configuration)
577
- p result
578
- rescue UltracartClient::ApiError => e
579
- puts "Exception when calling ConfigurationApi->update_payments_configuration: #{e}"
580
- end
581
- ```
582
-
583
- ### Parameters
584
-
585
- Name | Type | Description | Notes
586
- ------------- | ------------- | ------------- | -------------
587
- **payments_configuration** | [**PaymentsConfiguration**](PaymentsConfiguration.md)| Payments configuration |
588
-
589
- ### Return type
590
-
591
- [**PaymentsConfigurationResponse**](PaymentsConfigurationResponse.md)
592
-
593
- ### Authorization
594
-
595
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
596
-
597
- ### HTTP request headers
598
-
599
- - **Content-Type**: application/json; charset=UTF-8
600
- - **Accept**: application/json
601
-
602
-
603
-
604
- # **update_payments_transaction_gateway**
605
- > TransactionGatewaysResponse update_payments_transaction_gateway(update_gateway_request)
606
-
607
- Updates payments transaction gateway
608
-
609
- Updates payments transaction gateway on the UltraCart account.
610
-
611
- ### Example
612
- ```ruby
613
- # load the gem
614
- require 'ultracart_api'
615
-
616
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
617
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
618
- api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
619
-
620
-
621
- update_gateway_request = UltracartClient::TransactionGatewaysRequest.new # TransactionGatewaysRequest | Transaction gateways
622
-
623
-
624
- begin
625
- #Updates payments transaction gateway
626
- result = api_instance.update_payments_transaction_gateway(update_gateway_request)
627
- p result
628
- rescue UltracartClient::ApiError => e
629
- puts "Exception when calling ConfigurationApi->update_payments_transaction_gateway: #{e}"
630
- end
631
- ```
632
-
633
- ### Parameters
634
-
635
- Name | Type | Description | Notes
636
- ------------- | ------------- | ------------- | -------------
637
- **update_gateway_request** | [**TransactionGatewaysRequest**](TransactionGatewaysRequest.md)| Transaction gateways |
638
-
639
- ### Return type
640
-
641
- [**TransactionGatewaysResponse**](TransactionGatewaysResponse.md)
642
-
643
- ### Authorization
644
-
645
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
646
-
647
- ### HTTP request headers
648
-
649
- - **Content-Type**: application/json; charset=UTF-8
650
- - **Accept**: application/json
651
-
652
-
653
-
654
- # **update_rotating_transaction_gateway**
655
- > RotatingTransactionGatewayResponse update_rotating_transaction_gateway(rtg_oid, rotating_transaction_gateway)
656
-
657
- Update a rotating transaction gateway
658
-
659
- Update a rotating transaction gateway
660
-
661
- ### Example
662
- ```ruby
663
- # load the gem
664
- require 'ultracart_api'
665
-
666
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
667
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
668
- api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
669
-
670
-
671
- rtg_oid = 56 # Integer | The rtg_oid to update.
672
-
673
- rotating_transaction_gateway = UltracartClient::RotatingTransactionGateway.new # RotatingTransactionGateway | Rotating transaction gateway
674
-
675
-
676
- begin
677
- #Update a rotating transaction gateway
678
- result = api_instance.update_rotating_transaction_gateway(rtg_oid, rotating_transaction_gateway)
679
- p result
680
- rescue UltracartClient::ApiError => e
681
- puts "Exception when calling ConfigurationApi->update_rotating_transaction_gateway: #{e}"
682
- end
683
- ```
684
-
685
- ### Parameters
686
-
687
- Name | Type | Description | Notes
688
- ------------- | ------------- | ------------- | -------------
689
- **rtg_oid** | **Integer**| The rtg_oid to update. |
690
- **rotating_transaction_gateway** | [**RotatingTransactionGateway**](RotatingTransactionGateway.md)| Rotating transaction gateway |
691
-
692
- ### Return type
693
-
694
- [**RotatingTransactionGatewayResponse**](RotatingTransactionGatewayResponse.md)
695
-
696
- ### Authorization
697
-
698
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
699
-
700
- ### HTTP request headers
701
-
702
- - **Content-Type**: application/json; charset=UTF-8
703
- - **Accept**: application/json
704
-
705
-
706
-
707
- # **wepay_enroll**
708
- > PaymentsConfigurationResponse wepay_enroll(wepay_enroll)
709
-
710
- Enroll with WePay
711
-
712
- Enroll with WePay on the UltraCart account.
713
-
714
- ### Example
715
- ```ruby
716
- # load the gem
717
- require 'ultracart_api'
718
-
719
- # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
720
- simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
721
- api_instance = UltracartClient::ConfigurationApi.new_using_api_key(simple_key, false, false)
722
-
723
-
724
- wepay_enroll = UltracartClient::PaymentsWepayEnroll.new # PaymentsWepayEnroll | Wepay enrollment information
725
-
726
-
727
- begin
728
- #Enroll with WePay
729
- result = api_instance.wepay_enroll(wepay_enroll)
730
- p result
731
- rescue UltracartClient::ApiError => e
732
- puts "Exception when calling ConfigurationApi->wepay_enroll: #{e}"
733
- end
734
- ```
735
-
736
- ### Parameters
737
-
738
- Name | Type | Description | Notes
739
- ------------- | ------------- | ------------- | -------------
740
- **wepay_enroll** | [**PaymentsWepayEnroll**](PaymentsWepayEnroll.md)| Wepay enrollment information |
741
-
742
- ### Return type
743
-
744
- [**PaymentsConfigurationResponse**](PaymentsConfigurationResponse.md)
745
-
746
- ### Authorization
747
-
748
- [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
749
-
750
- ### HTTP request headers
751
-
752
- - **Content-Type**: application/json; charset=UTF-8
753
- - **Accept**: application/json
754
-
755
-
756
-