ultracart_api 3.0.75 → 3.1.3
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +23 -18
- data/docs/AffiliateApi.md +8 -22
- data/docs/AutoOrderApi.md +44 -100
- data/docs/ChargebackApi.md +20 -55
- data/docs/CheckoutApi.md +78 -295
- data/docs/CouponApi.md +78 -209
- data/docs/CouponTieredAmountOffItem.md +1 -1
- data/docs/CouponTieredPercentOffItems.md +1 -1
- data/docs/CustomerApi.md +199 -110
- data/docs/EmailPlanAdditional.md +1 -0
- data/docs/EmailVerifyTokenRequest.md +9 -0
- data/docs/EmailVerifyTokenResponse.md +12 -0
- data/docs/EmailVerifyTokenValidateRequest.md +8 -0
- data/docs/EmailVerifyTokenValidateResponse.md +11 -0
- data/docs/FulfillmentApi.md +21 -55
- data/docs/ItemApi.md +36 -99
- data/docs/OauthApi.md +8 -32
- data/docs/OrderApi.md +84 -223
- data/docs/ScreenRecording.md +2 -1
- data/docs/StorefrontApi.md +429 -2077
- data/docs/TaxApi.md +121 -308
- data/docs/UserApi.md +46 -121
- data/docs/WebhookApi.md +32 -88
- data/lib/ultracart_api.rb +4 -0
- data/lib/ultracart_api/api/affiliate_api.rb +13 -0
- data/lib/ultracart_api/api/auto_order_api.rb +21 -8
- data/lib/ultracart_api/api/chargeback_api.rb +13 -0
- data/lib/ultracart_api/api/checkout_api.rb +15 -2
- data/lib/ultracart_api/api/coupon_api.rb +13 -0
- data/lib/ultracart_api/api/customer_api.rb +181 -0
- data/lib/ultracart_api/api/fulfillment_api.rb +13 -0
- data/lib/ultracart_api/api/item_api.rb +13 -0
- data/lib/ultracart_api/api/oauth_api.rb +13 -0
- data/lib/ultracart_api/api/order_api.rb +15 -2
- data/lib/ultracart_api/api/storefront_api.rb +13 -0
- data/lib/ultracart_api/api/tax_api.rb +13 -0
- data/lib/ultracart_api/api/user_api.rb +13 -0
- data/lib/ultracart_api/api/webhook_api.rb +13 -0
- data/lib/ultracart_api/models/coupon_tiered_amount_off_item.rb +1 -1
- data/lib/ultracart_api/models/coupon_tiered_percent_off_items.rb +1 -1
- data/lib/ultracart_api/models/email_plan_additional.rb +10 -1
- data/lib/ultracart_api/models/email_verify_token_request.rb +195 -0
- data/lib/ultracart_api/models/email_verify_token_response.rb +222 -0
- data/lib/ultracart_api/models/email_verify_token_validate_request.rb +185 -0
- data/lib/ultracart_api/models/email_verify_token_validate_response.rb +212 -0
- data/lib/ultracart_api/models/screen_recording.rb +12 -1
- data/lib/ultracart_api/version.rb +1 -1
- metadata +10 -2
data/docs/CheckoutApi.md
CHANGED
|
@@ -36,23 +36,11 @@ Look up the city and state for the shipping zip code. Useful for building an au
|
|
|
36
36
|
```ruby
|
|
37
37
|
# load the gem
|
|
38
38
|
require 'ultracart_api'
|
|
39
|
-
# setup authorization
|
|
40
|
-
UltracartClient.configure do |config|
|
|
41
|
-
# Configure API key authorization: ultraCartBrowserApiKey
|
|
42
|
-
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
43
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
44
|
-
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
45
|
-
|
|
46
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
47
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
48
|
-
|
|
49
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
50
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
51
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
52
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
53
|
-
end
|
|
54
39
|
|
|
55
|
-
|
|
40
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
41
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
42
|
+
api_instance = UltracartClient::CheckoutApi.new_using_api_key(simple_key, false, false)
|
|
43
|
+
|
|
56
44
|
|
|
57
45
|
cart = UltracartClient::Cart.new # Cart | Cart
|
|
58
46
|
|
|
@@ -98,18 +86,11 @@ Finalize the cart into an order. This method can not be called with browser key
|
|
|
98
86
|
```ruby
|
|
99
87
|
# load the gem
|
|
100
88
|
require 'ultracart_api'
|
|
101
|
-
# setup authorization
|
|
102
|
-
UltracartClient.configure do |config|
|
|
103
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
104
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
105
|
-
|
|
106
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
107
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
108
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
109
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
110
|
-
end
|
|
111
89
|
|
|
112
|
-
|
|
90
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
91
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
92
|
+
api_instance = UltracartClient::CheckoutApi.new_using_api_key(simple_key, false, false)
|
|
93
|
+
|
|
113
94
|
|
|
114
95
|
finalize_request = UltracartClient::CartFinalizeOrderRequest.new # CartFinalizeOrderRequest | Finalize request
|
|
115
96
|
|
|
@@ -155,23 +136,11 @@ Get a Affirm checkout object for the specified cart_id parameter.
|
|
|
155
136
|
```ruby
|
|
156
137
|
# load the gem
|
|
157
138
|
require 'ultracart_api'
|
|
158
|
-
# setup authorization
|
|
159
|
-
UltracartClient.configure do |config|
|
|
160
|
-
# Configure API key authorization: ultraCartBrowserApiKey
|
|
161
|
-
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
162
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
163
|
-
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
164
|
-
|
|
165
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
166
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
167
|
-
|
|
168
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
169
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
170
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
171
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
172
|
-
end
|
|
173
139
|
|
|
174
|
-
|
|
140
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
141
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
142
|
+
api_instance = UltracartClient::CheckoutApi.new_using_api_key(simple_key, false, false)
|
|
143
|
+
|
|
175
144
|
|
|
176
145
|
cart_id = 'cart_id_example' # String | Cart ID to retrieve
|
|
177
146
|
|
|
@@ -217,23 +186,12 @@ Lookup the allowed countries for this merchant id
|
|
|
217
186
|
```ruby
|
|
218
187
|
# load the gem
|
|
219
188
|
require 'ultracart_api'
|
|
220
|
-
# setup authorization
|
|
221
|
-
UltracartClient.configure do |config|
|
|
222
|
-
# Configure API key authorization: ultraCartBrowserApiKey
|
|
223
|
-
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
224
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
225
|
-
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
226
|
-
|
|
227
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
228
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
229
|
-
|
|
230
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
231
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
232
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
233
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
234
|
-
end
|
|
235
189
|
|
|
236
|
-
|
|
190
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
191
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
192
|
+
api_instance = UltracartClient::CheckoutApi.new_using_api_key(simple_key, false, false)
|
|
193
|
+
|
|
194
|
+
|
|
237
195
|
|
|
238
196
|
begin
|
|
239
197
|
#Allowed countries
|
|
@@ -273,23 +231,11 @@ If the cookie is set on the browser making the request then it will return their
|
|
|
273
231
|
```ruby
|
|
274
232
|
# load the gem
|
|
275
233
|
require 'ultracart_api'
|
|
276
|
-
# setup authorization
|
|
277
|
-
UltracartClient.configure do |config|
|
|
278
|
-
# Configure API key authorization: ultraCartBrowserApiKey
|
|
279
|
-
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
280
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
281
|
-
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
282
|
-
|
|
283
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
284
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
285
|
-
|
|
286
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
287
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
288
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
289
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
290
|
-
end
|
|
291
234
|
|
|
292
|
-
|
|
235
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
236
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
237
|
+
api_instance = UltracartClient::CheckoutApi.new_using_api_key(simple_key, false, false)
|
|
238
|
+
|
|
293
239
|
|
|
294
240
|
opts = {
|
|
295
241
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
@@ -336,23 +282,11 @@ Get a cart specified by the cart_id parameter.
|
|
|
336
282
|
```ruby
|
|
337
283
|
# load the gem
|
|
338
284
|
require 'ultracart_api'
|
|
339
|
-
# setup authorization
|
|
340
|
-
UltracartClient.configure do |config|
|
|
341
|
-
# Configure API key authorization: ultraCartBrowserApiKey
|
|
342
|
-
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
343
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
344
|
-
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
345
|
-
|
|
346
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
347
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
348
|
-
|
|
349
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
350
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
351
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
352
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
353
|
-
end
|
|
354
285
|
|
|
355
|
-
|
|
286
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
287
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
288
|
+
api_instance = UltracartClient::CheckoutApi.new_using_api_key(simple_key, false, false)
|
|
289
|
+
|
|
356
290
|
|
|
357
291
|
cart_id = 'cart_id_example' # String | Cart ID to retrieve
|
|
358
292
|
|
|
@@ -402,23 +336,11 @@ Get a cart specified by the return code parameter.
|
|
|
402
336
|
```ruby
|
|
403
337
|
# load the gem
|
|
404
338
|
require 'ultracart_api'
|
|
405
|
-
# setup authorization
|
|
406
|
-
UltracartClient.configure do |config|
|
|
407
|
-
# Configure API key authorization: ultraCartBrowserApiKey
|
|
408
|
-
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
409
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
410
|
-
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
411
|
-
|
|
412
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
413
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
414
|
-
|
|
415
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
416
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
417
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
418
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
419
|
-
end
|
|
420
339
|
|
|
421
|
-
|
|
340
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
341
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
342
|
+
api_instance = UltracartClient::CheckoutApi.new_using_api_key(simple_key, false, false)
|
|
343
|
+
|
|
422
344
|
|
|
423
345
|
return_code = 'return_code_example' # String | Return code to lookup cart ID by
|
|
424
346
|
|
|
@@ -468,23 +390,11 @@ Get a cart specified by the encrypted return token parameter.
|
|
|
468
390
|
```ruby
|
|
469
391
|
# load the gem
|
|
470
392
|
require 'ultracart_api'
|
|
471
|
-
# setup authorization
|
|
472
|
-
UltracartClient.configure do |config|
|
|
473
|
-
# Configure API key authorization: ultraCartBrowserApiKey
|
|
474
|
-
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
475
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
476
|
-
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
477
|
-
|
|
478
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
479
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
480
|
-
|
|
481
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
482
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
483
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
484
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
485
|
-
end
|
|
486
393
|
|
|
487
|
-
|
|
394
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
395
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
396
|
+
api_instance = UltracartClient::CheckoutApi.new_using_api_key(simple_key, false, false)
|
|
397
|
+
|
|
488
398
|
|
|
489
399
|
opts = {
|
|
490
400
|
return_token: 'return_token_example', # String | Return token provided by StoreFront Communications
|
|
@@ -533,23 +443,11 @@ Lookup a state/province list for a given country code
|
|
|
533
443
|
```ruby
|
|
534
444
|
# load the gem
|
|
535
445
|
require 'ultracart_api'
|
|
536
|
-
# setup authorization
|
|
537
|
-
UltracartClient.configure do |config|
|
|
538
|
-
# Configure API key authorization: ultraCartBrowserApiKey
|
|
539
|
-
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
540
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
541
|
-
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
542
|
-
|
|
543
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
544
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
545
|
-
|
|
546
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
547
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
548
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
549
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
550
|
-
end
|
|
551
446
|
|
|
552
|
-
|
|
447
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
448
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
449
|
+
api_instance = UltracartClient::CheckoutApi.new_using_api_key(simple_key, false, false)
|
|
450
|
+
|
|
553
451
|
|
|
554
452
|
country_code = 'country_code_example' # String | Two letter ISO country code
|
|
555
453
|
|
|
@@ -595,23 +493,11 @@ Handoff the browser to UltraCart for view cart on StoreFront, transfer to PayPal
|
|
|
595
493
|
```ruby
|
|
596
494
|
# load the gem
|
|
597
495
|
require 'ultracart_api'
|
|
598
|
-
# setup authorization
|
|
599
|
-
UltracartClient.configure do |config|
|
|
600
|
-
# Configure API key authorization: ultraCartBrowserApiKey
|
|
601
|
-
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
602
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
603
|
-
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
604
|
-
|
|
605
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
606
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
607
|
-
|
|
608
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
609
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
610
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
611
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
612
|
-
end
|
|
613
496
|
|
|
614
|
-
|
|
497
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
498
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
499
|
+
api_instance = UltracartClient::CheckoutApi.new_using_api_key(simple_key, false, false)
|
|
500
|
+
|
|
615
501
|
|
|
616
502
|
handoff_request = UltracartClient::CheckoutHandoffRequest.new # CheckoutHandoffRequest | Handoff request
|
|
617
503
|
|
|
@@ -661,23 +547,11 @@ Login in to the customer profile specified by cart.billing.email and password
|
|
|
661
547
|
```ruby
|
|
662
548
|
# load the gem
|
|
663
549
|
require 'ultracart_api'
|
|
664
|
-
# setup authorization
|
|
665
|
-
UltracartClient.configure do |config|
|
|
666
|
-
# Configure API key authorization: ultraCartBrowserApiKey
|
|
667
|
-
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
668
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
669
|
-
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
670
|
-
|
|
671
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
672
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
673
|
-
|
|
674
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
675
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
676
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
677
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
678
|
-
end
|
|
679
550
|
|
|
680
|
-
|
|
551
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
552
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
553
|
+
api_instance = UltracartClient::CheckoutApi.new_using_api_key(simple_key, false, false)
|
|
554
|
+
|
|
681
555
|
|
|
682
556
|
login_request = UltracartClient::CartProfileLoginRequest.new # CartProfileLoginRequest | Login request
|
|
683
557
|
|
|
@@ -727,23 +601,11 @@ Log the cart out of the current profile. No error will occur if they are not lo
|
|
|
727
601
|
```ruby
|
|
728
602
|
# load the gem
|
|
729
603
|
require 'ultracart_api'
|
|
730
|
-
# setup authorization
|
|
731
|
-
UltracartClient.configure do |config|
|
|
732
|
-
# Configure API key authorization: ultraCartBrowserApiKey
|
|
733
|
-
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
734
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
735
|
-
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
736
|
-
|
|
737
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
738
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
739
|
-
|
|
740
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
741
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
742
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
743
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
744
|
-
end
|
|
745
604
|
|
|
746
|
-
|
|
605
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
606
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
607
|
+
api_instance = UltracartClient::CheckoutApi.new_using_api_key(simple_key, false, false)
|
|
608
|
+
|
|
747
609
|
|
|
748
610
|
cart = UltracartClient::Cart.new # Cart | Cart
|
|
749
611
|
|
|
@@ -793,23 +655,11 @@ Register a new customer profile. Requires the cart.billing object to be populat
|
|
|
793
655
|
```ruby
|
|
794
656
|
# load the gem
|
|
795
657
|
require 'ultracart_api'
|
|
796
|
-
# setup authorization
|
|
797
|
-
UltracartClient.configure do |config|
|
|
798
|
-
# Configure API key authorization: ultraCartBrowserApiKey
|
|
799
|
-
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
800
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
801
|
-
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
802
|
-
|
|
803
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
804
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
805
|
-
|
|
806
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
807
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
808
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
809
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
810
|
-
end
|
|
811
658
|
|
|
812
|
-
|
|
659
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
660
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
661
|
+
api_instance = UltracartClient::CheckoutApi.new_using_api_key(simple_key, false, false)
|
|
662
|
+
|
|
813
663
|
|
|
814
664
|
register_request = UltracartClient::CartProfileRegisterRequest.new # CartProfileRegisterRequest | Register request
|
|
815
665
|
|
|
@@ -859,23 +709,11 @@ Register an affiliate click. Used by custom checkouts that are completely API b
|
|
|
859
709
|
```ruby
|
|
860
710
|
# load the gem
|
|
861
711
|
require 'ultracart_api'
|
|
862
|
-
# setup authorization
|
|
863
|
-
UltracartClient.configure do |config|
|
|
864
|
-
# Configure API key authorization: ultraCartBrowserApiKey
|
|
865
|
-
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
866
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
867
|
-
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
868
|
-
|
|
869
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
870
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
871
|
-
|
|
872
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
873
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
874
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
875
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
876
|
-
end
|
|
877
712
|
|
|
878
|
-
|
|
713
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
714
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
715
|
+
api_instance = UltracartClient::CheckoutApi.new_using_api_key(simple_key, false, false)
|
|
716
|
+
|
|
879
717
|
|
|
880
718
|
register_affiliate_click_request = UltracartClient::RegisterAffiliateClickRequest.new # RegisterAffiliateClickRequest | Register affiliate click request
|
|
881
719
|
|
|
@@ -925,23 +763,11 @@ Retrieve all the related items for the cart contents. Expansion is limited to c
|
|
|
925
763
|
```ruby
|
|
926
764
|
# load the gem
|
|
927
765
|
require 'ultracart_api'
|
|
928
|
-
# setup authorization
|
|
929
|
-
UltracartClient.configure do |config|
|
|
930
|
-
# Configure API key authorization: ultraCartBrowserApiKey
|
|
931
|
-
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
932
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
933
|
-
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
934
|
-
|
|
935
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
936
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
937
|
-
|
|
938
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
939
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
940
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
941
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
942
|
-
end
|
|
943
766
|
|
|
944
|
-
|
|
767
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
768
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
769
|
+
api_instance = UltracartClient::CheckoutApi.new_using_api_key(simple_key, false, false)
|
|
770
|
+
|
|
945
771
|
|
|
946
772
|
cart = UltracartClient::Cart.new # Cart | Cart
|
|
947
773
|
|
|
@@ -991,23 +817,11 @@ Retrieve all the related items for the cart contents. Expansion is limited to c
|
|
|
991
817
|
```ruby
|
|
992
818
|
# load the gem
|
|
993
819
|
require 'ultracart_api'
|
|
994
|
-
# setup authorization
|
|
995
|
-
UltracartClient.configure do |config|
|
|
996
|
-
# Configure API key authorization: ultraCartBrowserApiKey
|
|
997
|
-
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
998
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
999
|
-
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
1000
|
-
|
|
1001
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1002
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1003
|
-
|
|
1004
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1005
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
1006
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1007
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
1008
|
-
end
|
|
1009
820
|
|
|
1010
|
-
|
|
821
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
822
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
823
|
+
api_instance = UltracartClient::CheckoutApi.new_using_api_key(simple_key, false, false)
|
|
824
|
+
|
|
1011
825
|
|
|
1012
826
|
item_id = 'item_id_example' # String | Item ID to retrieve related items for
|
|
1013
827
|
|
|
@@ -1054,24 +868,17 @@ Name | Type | Description | Notes
|
|
|
1054
868
|
|
|
1055
869
|
Setup Browser Application
|
|
1056
870
|
|
|
1057
|
-
Setup a browser key authenticated application with checkout permissions. This REST call must be made with an authentication scheme that is not browser key. The new application will be linked to the application that makes this call. If this application is disabled / deleted, then so will the application setup by this call. The purpose of this call is to allow an OAuth
|
|
871
|
+
Setup a browser key authenticated application with checkout permissions. This REST call must be made with an authentication scheme that is not browser key. The new application will be linked to the application that makes this call. If this application is disabled / deleted, then so will the application setup by this call. The purpose of this call is to allow an OAuth application, such as the Wordpress plugin, to setup the proper browser based authentication for the REST checkout API to use.
|
|
1058
872
|
|
|
1059
873
|
### Example
|
|
1060
874
|
```ruby
|
|
1061
875
|
# load the gem
|
|
1062
876
|
require 'ultracart_api'
|
|
1063
|
-
# setup authorization
|
|
1064
|
-
UltracartClient.configure do |config|
|
|
1065
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1066
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1067
|
-
|
|
1068
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1069
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
1070
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1071
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
1072
|
-
end
|
|
1073
877
|
|
|
1074
|
-
|
|
878
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
879
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
880
|
+
api_instance = UltracartClient::CheckoutApi.new_using_api_key(simple_key, false, false)
|
|
881
|
+
|
|
1075
882
|
|
|
1076
883
|
browser_key_request = UltracartClient::CheckoutSetupBrowserKeyRequest.new # CheckoutSetupBrowserKeyRequest | Setup browser key request
|
|
1077
884
|
|
|
@@ -1117,23 +924,11 @@ Update the cart.
|
|
|
1117
924
|
```ruby
|
|
1118
925
|
# load the gem
|
|
1119
926
|
require 'ultracart_api'
|
|
1120
|
-
# setup authorization
|
|
1121
|
-
UltracartClient.configure do |config|
|
|
1122
|
-
# Configure API key authorization: ultraCartBrowserApiKey
|
|
1123
|
-
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
1124
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1125
|
-
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
1126
|
-
|
|
1127
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1128
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1129
|
-
|
|
1130
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1131
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
1132
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1133
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
1134
|
-
end
|
|
1135
927
|
|
|
1136
|
-
|
|
928
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
929
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
930
|
+
api_instance = UltracartClient::CheckoutApi.new_using_api_key(simple_key, false, false)
|
|
931
|
+
|
|
1137
932
|
|
|
1138
933
|
cart = UltracartClient::Cart.new # Cart | Cart
|
|
1139
934
|
|
|
@@ -1183,23 +978,11 @@ Validate the cart for errors. Specific checks can be passed and multiple valida
|
|
|
1183
978
|
```ruby
|
|
1184
979
|
# load the gem
|
|
1185
980
|
require 'ultracart_api'
|
|
1186
|
-
# setup authorization
|
|
1187
|
-
UltracartClient.configure do |config|
|
|
1188
|
-
# Configure API key authorization: ultraCartBrowserApiKey
|
|
1189
|
-
config.api_key['x-ultracart-browser-key'] = 'YOUR API KEY'
|
|
1190
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1191
|
-
#config.api_key_prefix['x-ultracart-browser-key'] = 'Bearer'
|
|
1192
|
-
|
|
1193
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1194
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1195
|
-
|
|
1196
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1197
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
1198
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1199
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
1200
|
-
end
|
|
1201
981
|
|
|
1202
|
-
|
|
982
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
983
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
984
|
+
api_instance = UltracartClient::CheckoutApi.new_using_api_key(simple_key, false, false)
|
|
985
|
+
|
|
1203
986
|
|
|
1204
987
|
validation_request = UltracartClient::CartValidationRequest.new # CartValidationRequest | Validation request
|
|
1205
988
|
|