ultracart_api 4.0.32.rc → 4.0.33.rc
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +5 -4
- data/docs/AffiliateApi.md +16 -22
- data/docs/AutoOrderApi.md +64 -88
- data/docs/ChannelPartnerApi.md +40 -55
- data/docs/ChargebackApi.md +40 -55
- data/docs/CheckoutApi.md +152 -294
- data/docs/CouponApi.md +152 -209
- data/docs/CustomerApi.md +136 -192
- data/docs/FulfillmentApi.md +48 -66
- data/docs/GiftCertificateApi.md +64 -88
- data/docs/IntegrationLogApi.md +40 -55
- data/docs/ItemApi.md +72 -99
- data/docs/OauthApi.md +16 -32
- data/docs/OrderApi.md +184 -253
- data/docs/SsoApi.md +32 -44
- data/docs/StorefrontApi.md +1134 -2345
- data/docs/TaxApi.md +224 -308
- data/docs/UserApi.md +88 -121
- data/docs/WebhookApi.md +64 -88
- data/lib/ultracart_api/version.rb +1 -1
- metadata +2 -2
data/docs/CheckoutApi.md
CHANGED
|
@@ -38,23 +38,15 @@ Look up the city and state for the shipping zip code. Useful for building an au
|
|
|
38
38
|
```ruby
|
|
39
39
|
require 'time'
|
|
40
40
|
require 'ultracart_api'
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
49
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
50
|
-
|
|
51
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
52
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
53
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
54
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
55
|
-
end
|
|
41
|
+
require 'json'
|
|
42
|
+
require 'yaml'
|
|
43
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
44
|
+
|
|
45
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
46
|
+
# As such, this might not be the best way to use this object.
|
|
47
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
56
48
|
|
|
57
|
-
|
|
49
|
+
api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
58
50
|
cart = UltracartClient::Cart.new # Cart | Cart
|
|
59
51
|
|
|
60
52
|
begin
|
|
@@ -117,18 +109,15 @@ Finalize the cart into an order. This method can not be called with browser key
|
|
|
117
109
|
```ruby
|
|
118
110
|
require 'time'
|
|
119
111
|
require 'ultracart_api'
|
|
120
|
-
|
|
121
|
-
|
|
122
|
-
|
|
123
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
124
|
-
|
|
125
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
126
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
127
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
128
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
129
|
-
end
|
|
112
|
+
require 'json'
|
|
113
|
+
require 'yaml'
|
|
114
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
130
115
|
|
|
131
|
-
|
|
116
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
117
|
+
# As such, this might not be the best way to use this object.
|
|
118
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
119
|
+
|
|
120
|
+
api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
132
121
|
finalize_request = UltracartClient::CartFinalizeOrderRequest.new # CartFinalizeOrderRequest | Finalize request
|
|
133
122
|
|
|
134
123
|
begin
|
|
@@ -191,23 +180,15 @@ Get a Affirm checkout object for the specified cart_id parameter.
|
|
|
191
180
|
```ruby
|
|
192
181
|
require 'time'
|
|
193
182
|
require 'ultracart_api'
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
config.api_key['ultraCartBrowserApiKey'] = 'YOUR API KEY'
|
|
198
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
199
|
-
# config.api_key_prefix['ultraCartBrowserApiKey'] = 'Bearer'
|
|
200
|
-
|
|
201
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
202
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
203
|
-
|
|
204
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
205
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
206
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
207
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
208
|
-
end
|
|
183
|
+
require 'json'
|
|
184
|
+
require 'yaml'
|
|
185
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
209
186
|
|
|
210
|
-
|
|
187
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
188
|
+
# As such, this might not be the best way to use this object.
|
|
189
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
190
|
+
|
|
191
|
+
api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
211
192
|
cart_id = 'cart_id_example' # String | Cart ID to retrieve
|
|
212
193
|
|
|
213
194
|
begin
|
|
@@ -270,23 +251,15 @@ Lookup the allowed countries for this merchant id
|
|
|
270
251
|
```ruby
|
|
271
252
|
require 'time'
|
|
272
253
|
require 'ultracart_api'
|
|
273
|
-
|
|
274
|
-
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
281
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
282
|
-
|
|
283
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
284
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
285
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
286
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
287
|
-
end
|
|
254
|
+
require 'json'
|
|
255
|
+
require 'yaml'
|
|
256
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
257
|
+
|
|
258
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
259
|
+
# As such, this might not be the best way to use this object.
|
|
260
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
288
261
|
|
|
289
|
-
|
|
262
|
+
api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
290
263
|
|
|
291
264
|
begin
|
|
292
265
|
# Allowed countries
|
|
@@ -346,23 +319,15 @@ If the cookie is set on the browser making the request then it will return their
|
|
|
346
319
|
```ruby
|
|
347
320
|
require 'time'
|
|
348
321
|
require 'ultracart_api'
|
|
349
|
-
|
|
350
|
-
|
|
351
|
-
|
|
352
|
-
|
|
353
|
-
|
|
354
|
-
|
|
355
|
-
|
|
356
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
357
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
358
|
-
|
|
359
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
360
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
361
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
362
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
363
|
-
end
|
|
322
|
+
require 'json'
|
|
323
|
+
require 'yaml'
|
|
324
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
325
|
+
|
|
326
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
327
|
+
# As such, this might not be the best way to use this object.
|
|
328
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
364
329
|
|
|
365
|
-
|
|
330
|
+
api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
366
331
|
opts = {
|
|
367
332
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
368
333
|
}
|
|
@@ -427,23 +392,15 @@ Get a cart specified by the cart_id parameter.
|
|
|
427
392
|
```ruby
|
|
428
393
|
require 'time'
|
|
429
394
|
require 'ultracart_api'
|
|
430
|
-
|
|
431
|
-
|
|
432
|
-
|
|
433
|
-
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
438
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
439
|
-
|
|
440
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
441
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
442
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
443
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
444
|
-
end
|
|
395
|
+
require 'json'
|
|
396
|
+
require 'yaml'
|
|
397
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
398
|
+
|
|
399
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
400
|
+
# As such, this might not be the best way to use this object.
|
|
401
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
445
402
|
|
|
446
|
-
|
|
403
|
+
api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
447
404
|
cart_id = 'cart_id_example' # String | Cart ID to retrieve
|
|
448
405
|
opts = {
|
|
449
406
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
@@ -510,23 +467,15 @@ Get a cart specified by the return code parameter.
|
|
|
510
467
|
```ruby
|
|
511
468
|
require 'time'
|
|
512
469
|
require 'ultracart_api'
|
|
513
|
-
|
|
514
|
-
|
|
515
|
-
|
|
516
|
-
config.api_key['ultraCartBrowserApiKey'] = 'YOUR API KEY'
|
|
517
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
518
|
-
# config.api_key_prefix['ultraCartBrowserApiKey'] = 'Bearer'
|
|
519
|
-
|
|
520
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
521
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
522
|
-
|
|
523
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
524
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
525
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
526
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
527
|
-
end
|
|
470
|
+
require 'json'
|
|
471
|
+
require 'yaml'
|
|
472
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
528
473
|
|
|
529
|
-
|
|
474
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
475
|
+
# As such, this might not be the best way to use this object.
|
|
476
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
477
|
+
|
|
478
|
+
api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
530
479
|
return_code = 'return_code_example' # String | Return code to lookup cart ID by
|
|
531
480
|
opts = {
|
|
532
481
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
@@ -593,23 +542,15 @@ Get a cart specified by the encrypted return token parameter.
|
|
|
593
542
|
```ruby
|
|
594
543
|
require 'time'
|
|
595
544
|
require 'ultracart_api'
|
|
596
|
-
|
|
597
|
-
|
|
598
|
-
|
|
599
|
-
config.api_key['ultraCartBrowserApiKey'] = 'YOUR API KEY'
|
|
600
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
601
|
-
# config.api_key_prefix['ultraCartBrowserApiKey'] = 'Bearer'
|
|
602
|
-
|
|
603
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
604
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
605
|
-
|
|
606
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
607
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
608
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
609
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
610
|
-
end
|
|
545
|
+
require 'json'
|
|
546
|
+
require 'yaml'
|
|
547
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
611
548
|
|
|
612
|
-
|
|
549
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
550
|
+
# As such, this might not be the best way to use this object.
|
|
551
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
552
|
+
|
|
553
|
+
api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
613
554
|
opts = {
|
|
614
555
|
return_token: 'return_token_example', # String | Return token provided by StoreFront Communications
|
|
615
556
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
@@ -676,23 +617,15 @@ Lookup a state/province list for a given country code
|
|
|
676
617
|
```ruby
|
|
677
618
|
require 'time'
|
|
678
619
|
require 'ultracart_api'
|
|
679
|
-
|
|
680
|
-
|
|
681
|
-
|
|
682
|
-
config.api_key['ultraCartBrowserApiKey'] = 'YOUR API KEY'
|
|
683
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
684
|
-
# config.api_key_prefix['ultraCartBrowserApiKey'] = 'Bearer'
|
|
685
|
-
|
|
686
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
687
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
688
|
-
|
|
689
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
690
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
691
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
692
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
693
|
-
end
|
|
620
|
+
require 'json'
|
|
621
|
+
require 'yaml'
|
|
622
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
694
623
|
|
|
695
|
-
|
|
624
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
625
|
+
# As such, this might not be the best way to use this object.
|
|
626
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
627
|
+
|
|
628
|
+
api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
696
629
|
country_code = 'country_code_example' # String | Two letter ISO country code
|
|
697
630
|
|
|
698
631
|
begin
|
|
@@ -755,23 +688,15 @@ Handoff the browser to UltraCart for view cart on StoreFront, transfer to PayPal
|
|
|
755
688
|
```ruby
|
|
756
689
|
require 'time'
|
|
757
690
|
require 'ultracart_api'
|
|
758
|
-
|
|
759
|
-
|
|
760
|
-
|
|
761
|
-
config.api_key['ultraCartBrowserApiKey'] = 'YOUR API KEY'
|
|
762
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
763
|
-
# config.api_key_prefix['ultraCartBrowserApiKey'] = 'Bearer'
|
|
764
|
-
|
|
765
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
766
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
767
|
-
|
|
768
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
769
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
770
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
771
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
772
|
-
end
|
|
691
|
+
require 'json'
|
|
692
|
+
require 'yaml'
|
|
693
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
773
694
|
|
|
774
|
-
|
|
695
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
696
|
+
# As such, this might not be the best way to use this object.
|
|
697
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
698
|
+
|
|
699
|
+
api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
775
700
|
handoff_request = UltracartClient::CheckoutHandoffRequest.new # CheckoutHandoffRequest | Handoff request
|
|
776
701
|
opts = {
|
|
777
702
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
@@ -838,23 +763,15 @@ Login in to the customer profile specified by cart.billing.email and password
|
|
|
838
763
|
```ruby
|
|
839
764
|
require 'time'
|
|
840
765
|
require 'ultracart_api'
|
|
841
|
-
|
|
842
|
-
|
|
843
|
-
|
|
844
|
-
|
|
845
|
-
|
|
846
|
-
|
|
847
|
-
|
|
848
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
849
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
850
|
-
|
|
851
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
852
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
853
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
854
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
855
|
-
end
|
|
766
|
+
require 'json'
|
|
767
|
+
require 'yaml'
|
|
768
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
769
|
+
|
|
770
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
771
|
+
# As such, this might not be the best way to use this object.
|
|
772
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
856
773
|
|
|
857
|
-
|
|
774
|
+
api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
858
775
|
login_request = UltracartClient::CartProfileLoginRequest.new # CartProfileLoginRequest | Login request
|
|
859
776
|
opts = {
|
|
860
777
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
@@ -921,23 +838,15 @@ Log the cart out of the current profile. No error will occur if they are not lo
|
|
|
921
838
|
```ruby
|
|
922
839
|
require 'time'
|
|
923
840
|
require 'ultracart_api'
|
|
924
|
-
|
|
925
|
-
|
|
926
|
-
|
|
927
|
-
|
|
928
|
-
|
|
929
|
-
|
|
930
|
-
|
|
931
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
932
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
933
|
-
|
|
934
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
935
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
936
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
937
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
938
|
-
end
|
|
841
|
+
require 'json'
|
|
842
|
+
require 'yaml'
|
|
843
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
844
|
+
|
|
845
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
846
|
+
# As such, this might not be the best way to use this object.
|
|
847
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
939
848
|
|
|
940
|
-
|
|
849
|
+
api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
941
850
|
cart = UltracartClient::Cart.new # Cart | Cart
|
|
942
851
|
opts = {
|
|
943
852
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
@@ -1004,23 +913,15 @@ Register a new customer profile. Requires the cart.billing object to be populat
|
|
|
1004
913
|
```ruby
|
|
1005
914
|
require 'time'
|
|
1006
915
|
require 'ultracart_api'
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1015
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1016
|
-
|
|
1017
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1018
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
1019
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1020
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
1021
|
-
end
|
|
916
|
+
require 'json'
|
|
917
|
+
require 'yaml'
|
|
918
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
919
|
+
|
|
920
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
921
|
+
# As such, this might not be the best way to use this object.
|
|
922
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
1022
923
|
|
|
1023
|
-
|
|
924
|
+
api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
1024
925
|
register_request = UltracartClient::CartProfileRegisterRequest.new # CartProfileRegisterRequest | Register request
|
|
1025
926
|
opts = {
|
|
1026
927
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
@@ -1087,23 +988,15 @@ Register an affiliate click. Used by custom checkouts that are completely API b
|
|
|
1087
988
|
```ruby
|
|
1088
989
|
require 'time'
|
|
1089
990
|
require 'ultracart_api'
|
|
1090
|
-
|
|
1091
|
-
|
|
1092
|
-
|
|
1093
|
-
config.api_key['ultraCartBrowserApiKey'] = 'YOUR API KEY'
|
|
1094
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1095
|
-
# config.api_key_prefix['ultraCartBrowserApiKey'] = 'Bearer'
|
|
1096
|
-
|
|
1097
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1098
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1099
|
-
|
|
1100
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1101
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
1102
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1103
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
1104
|
-
end
|
|
991
|
+
require 'json'
|
|
992
|
+
require 'yaml'
|
|
993
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
1105
994
|
|
|
1106
|
-
|
|
995
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
996
|
+
# As such, this might not be the best way to use this object.
|
|
997
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
998
|
+
|
|
999
|
+
api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
1107
1000
|
register_affiliate_click_request = UltracartClient::RegisterAffiliateClickRequest.new # RegisterAffiliateClickRequest | Register affiliate click request
|
|
1108
1001
|
opts = {
|
|
1109
1002
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
@@ -1170,23 +1063,15 @@ Retrieve all the related items for the cart contents. Expansion is limited to c
|
|
|
1170
1063
|
```ruby
|
|
1171
1064
|
require 'time'
|
|
1172
1065
|
require 'ultracart_api'
|
|
1173
|
-
|
|
1174
|
-
|
|
1175
|
-
|
|
1176
|
-
config.api_key['ultraCartBrowserApiKey'] = 'YOUR API KEY'
|
|
1177
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1178
|
-
# config.api_key_prefix['ultraCartBrowserApiKey'] = 'Bearer'
|
|
1179
|
-
|
|
1180
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1181
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1182
|
-
|
|
1183
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1184
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
1185
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1186
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
1187
|
-
end
|
|
1066
|
+
require 'json'
|
|
1067
|
+
require 'yaml'
|
|
1068
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
1188
1069
|
|
|
1189
|
-
|
|
1070
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
1071
|
+
# As such, this might not be the best way to use this object.
|
|
1072
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
1073
|
+
|
|
1074
|
+
api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
1190
1075
|
cart = UltracartClient::Cart.new # Cart | Cart
|
|
1191
1076
|
opts = {
|
|
1192
1077
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See item resource documentation for examples
|
|
@@ -1253,23 +1138,15 @@ Retrieve all the related items for the cart contents. Expansion is limited to c
|
|
|
1253
1138
|
```ruby
|
|
1254
1139
|
require 'time'
|
|
1255
1140
|
require 'ultracart_api'
|
|
1256
|
-
|
|
1257
|
-
|
|
1258
|
-
|
|
1259
|
-
|
|
1260
|
-
|
|
1261
|
-
|
|
1262
|
-
|
|
1263
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1264
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1265
|
-
|
|
1266
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1267
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
1268
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1269
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
1270
|
-
end
|
|
1141
|
+
require 'json'
|
|
1142
|
+
require 'yaml'
|
|
1143
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
1144
|
+
|
|
1145
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
1146
|
+
# As such, this might not be the best way to use this object.
|
|
1147
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
1271
1148
|
|
|
1272
|
-
|
|
1149
|
+
api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
1273
1150
|
item_id = 'item_id_example' # String | Item ID to retrieve related items for
|
|
1274
1151
|
cart = UltracartClient::Cart.new # Cart | Cart
|
|
1275
1152
|
opts = {
|
|
@@ -1338,18 +1215,15 @@ Setup a browser key authenticated application with checkout permissions. This R
|
|
|
1338
1215
|
```ruby
|
|
1339
1216
|
require 'time'
|
|
1340
1217
|
require 'ultracart_api'
|
|
1341
|
-
|
|
1342
|
-
|
|
1343
|
-
|
|
1344
|
-
|
|
1345
|
-
|
|
1346
|
-
|
|
1347
|
-
|
|
1348
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1349
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
1350
|
-
end
|
|
1218
|
+
require 'json'
|
|
1219
|
+
require 'yaml'
|
|
1220
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
1221
|
+
|
|
1222
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
1223
|
+
# As such, this might not be the best way to use this object.
|
|
1224
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
1351
1225
|
|
|
1352
|
-
|
|
1226
|
+
api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
1353
1227
|
browser_key_request = UltracartClient::CheckoutSetupBrowserKeyRequest.new # CheckoutSetupBrowserKeyRequest | Setup browser key request
|
|
1354
1228
|
|
|
1355
1229
|
begin
|
|
@@ -1412,23 +1286,15 @@ Update the cart.
|
|
|
1412
1286
|
```ruby
|
|
1413
1287
|
require 'time'
|
|
1414
1288
|
require 'ultracart_api'
|
|
1415
|
-
|
|
1416
|
-
|
|
1417
|
-
|
|
1418
|
-
|
|
1419
|
-
|
|
1420
|
-
|
|
1421
|
-
|
|
1422
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1423
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1424
|
-
|
|
1425
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1426
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
1427
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1428
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
1429
|
-
end
|
|
1289
|
+
require 'json'
|
|
1290
|
+
require 'yaml'
|
|
1291
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
1292
|
+
|
|
1293
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
1294
|
+
# As such, this might not be the best way to use this object.
|
|
1295
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
1430
1296
|
|
|
1431
|
-
|
|
1297
|
+
api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
1432
1298
|
cart = UltracartClient::Cart.new # Cart | Cart
|
|
1433
1299
|
opts = {
|
|
1434
1300
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
@@ -1495,23 +1361,15 @@ Validate the cart for errors. Specific checks can be passed and multiple valida
|
|
|
1495
1361
|
```ruby
|
|
1496
1362
|
require 'time'
|
|
1497
1363
|
require 'ultracart_api'
|
|
1498
|
-
|
|
1499
|
-
|
|
1500
|
-
|
|
1501
|
-
|
|
1502
|
-
|
|
1503
|
-
|
|
1504
|
-
|
|
1505
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1506
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1507
|
-
|
|
1508
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1509
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
1510
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1511
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
1512
|
-
end
|
|
1364
|
+
require 'json'
|
|
1365
|
+
require 'yaml'
|
|
1366
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
1367
|
+
|
|
1368
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
1369
|
+
# As such, this might not be the best way to use this object.
|
|
1370
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
1513
1371
|
|
|
1514
|
-
|
|
1372
|
+
api = UltracartClient::CheckoutApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
1515
1373
|
validation_request = UltracartClient::CartValidationRequest.new # CartValidationRequest | Validation request
|
|
1516
1374
|
opts = {
|
|
1517
1375
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|