ultracart_api 3.0.76 → 3.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +7 -13
- data/docs/AffiliateApi.md +8 -22
- data/docs/AutoOrderApi.md +32 -88
- data/docs/ChargebackApi.md +20 -55
- data/docs/CheckoutApi.md +77 -294
- data/docs/CouponApi.md +78 -209
- data/docs/CustomerApi.md +42 -110
- data/docs/FulfillmentApi.md +21 -55
- data/docs/ItemApi.md +36 -99
- data/docs/OauthApi.md +8 -32
- data/docs/OrderApi.md +81 -220
- 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/api/affiliate_api.rb +13 -0
- data/lib/ultracart_api/api/auto_order_api.rb +13 -0
- data/lib/ultracart_api/api/chargeback_api.rb +13 -0
- data/lib/ultracart_api/api/checkout_api.rb +13 -0
- data/lib/ultracart_api/api/coupon_api.rb +13 -0
- data/lib/ultracart_api/api/customer_api.rb +13 -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 +13 -0
- 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/version.rb +1 -1
- metadata +2 -2
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 0d8ed11c26303904351ebb73fc3889cbcb03667c6a2cd4831a405e568c0e2f12
|
|
4
|
+
data.tar.gz: 3b2202a5d4b64dfffe5cb5985b36826ddc3acd92265d3d98aba743f87d9261c1
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: ed12aa7f751502328558a95bf569d8debfa888418638a1278936f3fac8c5b16933ee6ed706a024a74d20c63673cf2362323428747a9b7b99600362522e016ade
|
|
7
|
+
data.tar.gz: 149da6b85726eaa7ab9536c4cca7623add353b01c399c3927639308d6f85fb6ef6ddee5a2cfe95e94feb6fa08002ec3f9f19f9974033e0e2c38afcb06107fd6a
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
|
8
8
|
|
|
9
9
|
- API version: 2.0.0
|
|
10
|
-
- Package version: 3.0
|
|
10
|
+
- Package version: 3.1.0
|
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
|
13
13
|
|
|
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
|
|
|
24
24
|
Then either install the gem locally:
|
|
25
25
|
|
|
26
26
|
```shell
|
|
27
|
-
gem install ./ultracart_api-3.0.
|
|
27
|
+
gem install ./ultracart_api-3.1.0.gem
|
|
28
28
|
```
|
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.0.
|
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.1.0.gem` to install the development dependencies)
|
|
30
30
|
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
32
32
|
|
|
33
33
|
Finally add this to the Gemfile:
|
|
34
34
|
|
|
35
|
-
gem 'ultracart_api', '~> 3.0
|
|
35
|
+
gem 'ultracart_api', '~> 3.1.0'
|
|
36
36
|
|
|
37
37
|
### Install from Git
|
|
38
38
|
|
|
@@ -55,16 +55,10 @@ Please follow the [installation](#installation) procedure and then run the follo
|
|
|
55
55
|
# Load the gem
|
|
56
56
|
require 'ultracart_api'
|
|
57
57
|
|
|
58
|
-
# Setup authorization
|
|
59
|
-
UltracartClient.configure do |config|
|
|
60
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
61
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
62
58
|
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
67
|
-
end
|
|
59
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
60
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
61
|
+
api_instance = UltracartClient::AffiliateApi.new_using_api_key(simple_key, false, false)
|
|
68
62
|
|
|
69
63
|
api_instance = UltracartClient::AffiliateApi.new
|
|
70
64
|
|
data/docs/AffiliateApi.md
CHANGED
|
@@ -19,18 +19,11 @@ Retrieves a group of clicks from the account based on a query object. If no par
|
|
|
19
19
|
```ruby
|
|
20
20
|
# load the gem
|
|
21
21
|
require 'ultracart_api'
|
|
22
|
-
# setup authorization
|
|
23
|
-
UltracartClient.configure do |config|
|
|
24
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
25
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
26
|
-
|
|
27
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
28
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
29
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
30
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
31
|
-
end
|
|
32
22
|
|
|
33
|
-
|
|
23
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
24
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
25
|
+
api_instance = UltracartClient::AffiliateApi.new_using_api_key(simple_key, false, false)
|
|
26
|
+
|
|
34
27
|
|
|
35
28
|
click_query = UltracartClient::AffiliateClickQuery.new # AffiliateClickQuery | Click query
|
|
36
29
|
|
|
@@ -84,18 +77,11 @@ Retrieves a group of ledger entries from the account based on a query object. I
|
|
|
84
77
|
```ruby
|
|
85
78
|
# load the gem
|
|
86
79
|
require 'ultracart_api'
|
|
87
|
-
# setup authorization
|
|
88
|
-
UltracartClient.configure do |config|
|
|
89
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
90
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
91
|
-
|
|
92
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
93
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
94
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
95
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
96
|
-
end
|
|
97
80
|
|
|
98
|
-
|
|
81
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
82
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
83
|
+
api_instance = UltracartClient::AffiliateApi.new_using_api_key(simple_key, false, false)
|
|
84
|
+
|
|
99
85
|
|
|
100
86
|
ledger_query = UltracartClient::AffiliateLedgerQuery.new # AffiliateLedgerQuery | Ledger query
|
|
101
87
|
|
data/docs/AutoOrderApi.md
CHANGED
|
@@ -25,18 +25,11 @@ Retrieves a single auto order using the specified auto order oid.
|
|
|
25
25
|
```ruby
|
|
26
26
|
# load the gem
|
|
27
27
|
require 'ultracart_api'
|
|
28
|
-
# setup authorization
|
|
29
|
-
UltracartClient.configure do |config|
|
|
30
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
31
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
32
|
-
|
|
33
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
34
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
35
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
36
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
37
|
-
end
|
|
38
28
|
|
|
39
|
-
|
|
29
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
30
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
31
|
+
api_instance = UltracartClient::AutoOrderApi.new_using_api_key(simple_key, false, false)
|
|
32
|
+
|
|
40
33
|
|
|
41
34
|
auto_order_oid = 56 # Integer | The auto order oid to retrieve.
|
|
42
35
|
|
|
@@ -86,18 +79,11 @@ Retrieves a single auto order using the specified reference (original) order id.
|
|
|
86
79
|
```ruby
|
|
87
80
|
# load the gem
|
|
88
81
|
require 'ultracart_api'
|
|
89
|
-
# setup authorization
|
|
90
|
-
UltracartClient.configure do |config|
|
|
91
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
92
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
93
|
-
|
|
94
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
95
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
96
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
97
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
98
|
-
end
|
|
99
82
|
|
|
100
|
-
|
|
83
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
84
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
85
|
+
api_instance = UltracartClient::AutoOrderApi.new_using_api_key(simple_key, false, false)
|
|
86
|
+
|
|
101
87
|
|
|
102
88
|
auto_order_code = 'auto_order_code_example' # String | The auto order oid to retrieve.
|
|
103
89
|
|
|
@@ -147,18 +133,11 @@ Retrieves a single auto order using the specified reference (original) order id.
|
|
|
147
133
|
```ruby
|
|
148
134
|
# load the gem
|
|
149
135
|
require 'ultracart_api'
|
|
150
|
-
# setup authorization
|
|
151
|
-
UltracartClient.configure do |config|
|
|
152
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
153
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
154
|
-
|
|
155
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
156
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
157
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
158
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
159
|
-
end
|
|
160
136
|
|
|
161
|
-
|
|
137
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
138
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
139
|
+
api_instance = UltracartClient::AutoOrderApi.new_using_api_key(simple_key, false, false)
|
|
140
|
+
|
|
162
141
|
|
|
163
142
|
reference_order_id = 'reference_order_id_example' # String | The auto order oid to retrieve.
|
|
164
143
|
|
|
@@ -208,18 +187,11 @@ Retrieves auto orders from the account. If no parameters are specified, all aut
|
|
|
208
187
|
```ruby
|
|
209
188
|
# load the gem
|
|
210
189
|
require 'ultracart_api'
|
|
211
|
-
# setup authorization
|
|
212
|
-
UltracartClient.configure do |config|
|
|
213
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
214
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
215
|
-
|
|
216
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
217
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
218
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
219
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
220
|
-
end
|
|
221
190
|
|
|
222
|
-
|
|
191
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
192
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
193
|
+
api_instance = UltracartClient::AutoOrderApi.new_using_api_key(simple_key, false, false)
|
|
194
|
+
|
|
223
195
|
|
|
224
196
|
opts = {
|
|
225
197
|
auto_order_code: 'auto_order_code_example', # String | Auto order code
|
|
@@ -310,18 +282,11 @@ Retrieves a group of auto orders from the account based on an array of auto orde
|
|
|
310
282
|
```ruby
|
|
311
283
|
# load the gem
|
|
312
284
|
require 'ultracart_api'
|
|
313
|
-
# setup authorization
|
|
314
|
-
UltracartClient.configure do |config|
|
|
315
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
316
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
317
|
-
|
|
318
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
319
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
320
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
321
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
322
|
-
end
|
|
323
285
|
|
|
324
|
-
|
|
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::AutoOrderApi.new_using_api_key(simple_key, false, false)
|
|
289
|
+
|
|
325
290
|
|
|
326
291
|
auto_order_batch = UltracartClient::AutoOrderQueryBatch.new # AutoOrderQueryBatch | Auto order batch
|
|
327
292
|
|
|
@@ -371,18 +336,11 @@ Retrieves a group of auto orders from the account based on a query object. You
|
|
|
371
336
|
```ruby
|
|
372
337
|
# load the gem
|
|
373
338
|
require 'ultracart_api'
|
|
374
|
-
# setup authorization
|
|
375
|
-
UltracartClient.configure do |config|
|
|
376
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
377
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
378
|
-
|
|
379
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
380
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
381
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
382
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
383
|
-
end
|
|
384
339
|
|
|
385
|
-
|
|
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::AutoOrderApi.new_using_api_key(simple_key, false, false)
|
|
343
|
+
|
|
386
344
|
|
|
387
345
|
auto_order_query = UltracartClient::AutoOrderQuery.new # AutoOrderQuery | Auto order query
|
|
388
346
|
|
|
@@ -438,18 +396,11 @@ Update an auto order on the UltraCart account.
|
|
|
438
396
|
```ruby
|
|
439
397
|
# load the gem
|
|
440
398
|
require 'ultracart_api'
|
|
441
|
-
# setup authorization
|
|
442
|
-
UltracartClient.configure do |config|
|
|
443
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
444
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
445
|
-
|
|
446
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
447
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
448
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
449
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
450
|
-
end
|
|
451
399
|
|
|
452
|
-
|
|
400
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
401
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
402
|
+
api_instance = UltracartClient::AutoOrderApi.new_using_api_key(simple_key, false, false)
|
|
403
|
+
|
|
453
404
|
|
|
454
405
|
auto_order = UltracartClient::AutoOrder.new # AutoOrder | Auto order to update
|
|
455
406
|
|
|
@@ -502,18 +453,11 @@ Update multiple auto orders on the UltraCart account.
|
|
|
502
453
|
```ruby
|
|
503
454
|
# load the gem
|
|
504
455
|
require 'ultracart_api'
|
|
505
|
-
# setup authorization
|
|
506
|
-
UltracartClient.configure do |config|
|
|
507
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
508
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
509
|
-
|
|
510
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
511
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
512
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
513
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
514
|
-
end
|
|
515
456
|
|
|
516
|
-
|
|
457
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
458
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
459
|
+
api_instance = UltracartClient::AutoOrderApi.new_using_api_key(simple_key, false, false)
|
|
460
|
+
|
|
517
461
|
|
|
518
462
|
auto_orders_request = UltracartClient::AutoOrdersRequest.new # AutoOrdersRequest | Auto orders to update (synchronous maximum 20 / asynchronous maximum 100)
|
|
519
463
|
|
data/docs/ChargebackApi.md
CHANGED
|
@@ -22,18 +22,11 @@ Delete a chargeback on the UltraCart account.
|
|
|
22
22
|
```ruby
|
|
23
23
|
# load the gem
|
|
24
24
|
require 'ultracart_api'
|
|
25
|
-
# setup authorization
|
|
26
|
-
UltracartClient.configure do |config|
|
|
27
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
28
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
29
|
-
|
|
30
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
31
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
32
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
33
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
34
|
-
end
|
|
35
25
|
|
|
36
|
-
|
|
26
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
27
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
28
|
+
api_instance = UltracartClient::ChargebackApi.new_using_api_key(simple_key, false, false)
|
|
29
|
+
|
|
37
30
|
|
|
38
31
|
chargeback_dispute_oid = 56 # Integer | The chargeback_dispute_oid to delete.
|
|
39
32
|
|
|
@@ -79,18 +72,11 @@ Retrieves a single chargeback using the specified chargeback dispute oid.
|
|
|
79
72
|
```ruby
|
|
80
73
|
# load the gem
|
|
81
74
|
require 'ultracart_api'
|
|
82
|
-
# setup authorization
|
|
83
|
-
UltracartClient.configure do |config|
|
|
84
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
85
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
86
|
-
|
|
87
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
88
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
89
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
90
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
91
|
-
end
|
|
92
75
|
|
|
93
|
-
|
|
76
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
77
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
78
|
+
api_instance = UltracartClient::ChargebackApi.new_using_api_key(simple_key, false, false)
|
|
79
|
+
|
|
94
80
|
|
|
95
81
|
chargeback_dispute_oid = 56 # Integer | The chargeback dispute oid to retrieve.
|
|
96
82
|
|
|
@@ -140,18 +126,11 @@ Retrieves chargebacks from the account. If no parameters are specified, all cha
|
|
|
140
126
|
```ruby
|
|
141
127
|
# load the gem
|
|
142
128
|
require 'ultracart_api'
|
|
143
|
-
# setup authorization
|
|
144
|
-
UltracartClient.configure do |config|
|
|
145
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
146
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
147
|
-
|
|
148
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
149
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
150
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
151
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
152
|
-
end
|
|
153
129
|
|
|
154
|
-
|
|
130
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
131
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
132
|
+
api_instance = UltracartClient::ChargebackApi.new_using_api_key(simple_key, false, false)
|
|
133
|
+
|
|
155
134
|
|
|
156
135
|
opts = {
|
|
157
136
|
order_id: 'order_id_example', # String | Order Id
|
|
@@ -220,18 +199,11 @@ Insert a chargeback on the UltraCart account.
|
|
|
220
199
|
```ruby
|
|
221
200
|
# load the gem
|
|
222
201
|
require 'ultracart_api'
|
|
223
|
-
# setup authorization
|
|
224
|
-
UltracartClient.configure do |config|
|
|
225
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
226
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
227
|
-
|
|
228
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
229
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
230
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
231
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
232
|
-
end
|
|
233
202
|
|
|
234
|
-
|
|
203
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
204
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
205
|
+
api_instance = UltracartClient::ChargebackApi.new_using_api_key(simple_key, false, false)
|
|
206
|
+
|
|
235
207
|
|
|
236
208
|
chargeback = UltracartClient::ChargebackDispute.new # ChargebackDispute | Chargeback to insert
|
|
237
209
|
|
|
@@ -281,18 +253,11 @@ Update a chargeback on the UltraCart account.
|
|
|
281
253
|
```ruby
|
|
282
254
|
# load the gem
|
|
283
255
|
require 'ultracart_api'
|
|
284
|
-
# setup authorization
|
|
285
|
-
UltracartClient.configure do |config|
|
|
286
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
287
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
288
|
-
|
|
289
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
290
|
-
config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
|
|
291
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
292
|
-
#config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
|
|
293
|
-
end
|
|
294
256
|
|
|
295
|
-
|
|
257
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
|
258
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
259
|
+
api_instance = UltracartClient::ChargebackApi.new_using_api_key(simple_key, false, false)
|
|
260
|
+
|
|
296
261
|
|
|
297
262
|
chargeback = UltracartClient::ChargebackDispute.new # ChargebackDispute | Chargeback to update
|
|
298
263
|
|
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
|
|
|
@@ -1060,18 +874,11 @@ Setup a browser key authenticated application with checkout permissions. This R
|
|
|
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
|
|