ultracart_api 4.0.32.rc → 4.0.33.rc
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- 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
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 634502a1bc116f800777a69bf16554f121df67574859bcbfd053569ea95679fe
|
|
4
|
+
data.tar.gz: 30ebb479b0fadca610c0eaad053d88272d8da051a4b441767285c415c089dfb8
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: cd3a30aa86c17daca037cf07c2577316c339f291f428af7261b88e3bc63431a72ba1dad54521416a662c00d07d991779085c3b1edf7ff1d549ffd9ac3dea0079
|
|
7
|
+
data.tar.gz: a5c7f287e6c276fbebc5b75edd9071df28f9580f033920a75c4f040c7feee84370e11407b45bbbc0542c1ea02eb993d3a9fc8979a36e02f436d38cd7cefb13da
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
|
8
8
|
|
|
9
9
|
- API version: 2.0.0
|
|
10
|
-
- Package version: 4.0.
|
|
10
|
+
- Package version: 4.0.33.rc
|
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
|
13
13
|
|
|
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
|
|
|
24
24
|
Then either install the gem locally:
|
|
25
25
|
|
|
26
26
|
```shell
|
|
27
|
-
gem install ./ultracart_api-4.0.
|
|
27
|
+
gem install ./ultracart_api-4.0.33.rc.gem
|
|
28
28
|
```
|
|
29
29
|
|
|
30
|
-
(for development, run `gem install --dev ./ultracart_api-4.0.
|
|
30
|
+
(for development, run `gem install --dev ./ultracart_api-4.0.33.rc.gem` to install the development dependencies)
|
|
31
31
|
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
|
33
33
|
|
|
34
34
|
Finally add this to the Gemfile:
|
|
35
35
|
|
|
36
|
-
gem 'ultracart_api', '~> 4.0.
|
|
36
|
+
gem 'ultracart_api', '~> 4.0.33.rc'
|
|
37
37
|
|
|
38
38
|
### Install from Git
|
|
39
39
|
|
|
@@ -1140,6 +1140,7 @@ Not every change is committed to every SDK.
|
|
|
1140
1140
|
|
|
1141
1141
|
| Version | Date | Comments |
|
|
1142
1142
|
| --: | :-: | --- |
|
|
1143
|
+
| 4.0.33-RC | 07/05/2022 | docs update |
|
|
1143
1144
|
| 4.0.32-RC | 06/24/2022 | removed unneeded consumes declarations on several api calls (yaml fix) |
|
|
1144
1145
|
| 4.0.31-RC | 06/24/2022 | removed unneeded consumes declarations on several api calls (yaml fix) |
|
|
1145
1146
|
| 4.0.30-RC | 06/24/2022 | removed unneeded consumes declarations on several api calls (yaml fix) |
|
data/docs/AffiliateApi.md
CHANGED
|
@@ -21,18 +21,15 @@ Retrieves a group of clicks from the account based on a query object. If no par
|
|
|
21
21
|
```ruby
|
|
22
22
|
require 'time'
|
|
23
23
|
require 'ultracart_api'
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
32
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
33
|
-
end
|
|
24
|
+
require 'json'
|
|
25
|
+
require 'yaml'
|
|
26
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
27
|
+
|
|
28
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
29
|
+
# As such, this might not be the best way to use this object.
|
|
30
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
34
31
|
|
|
35
|
-
|
|
32
|
+
api = UltracartClient::AffiliateApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
36
33
|
click_query = UltracartClient::AffiliateClickQuery.new # AffiliateClickQuery | Click query
|
|
37
34
|
opts = {
|
|
38
35
|
_limit: 56, # Integer | The maximum number of records to return on this one API call. (Maximum 10000)
|
|
@@ -103,18 +100,15 @@ Retrieves a group of ledger entries from the account based on a query object. I
|
|
|
103
100
|
```ruby
|
|
104
101
|
require 'time'
|
|
105
102
|
require 'ultracart_api'
|
|
106
|
-
|
|
107
|
-
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
114
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
115
|
-
end
|
|
103
|
+
require 'json'
|
|
104
|
+
require 'yaml'
|
|
105
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
106
|
+
|
|
107
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
108
|
+
# As such, this might not be the best way to use this object.
|
|
109
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
116
110
|
|
|
117
|
-
|
|
111
|
+
api = UltracartClient::AffiliateApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
118
112
|
ledger_query = UltracartClient::AffiliateLedgerQuery.new # AffiliateLedgerQuery | Ledger query
|
|
119
113
|
opts = {
|
|
120
114
|
_limit: 56, # Integer | The maximum number of records to return on this one API call. (Maximum 200)
|
data/docs/AutoOrderApi.md
CHANGED
|
@@ -27,18 +27,15 @@ Retrieves a single auto order using the specified auto order oid.
|
|
|
27
27
|
```ruby
|
|
28
28
|
require 'time'
|
|
29
29
|
require 'ultracart_api'
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
38
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
39
|
-
end
|
|
30
|
+
require 'json'
|
|
31
|
+
require 'yaml'
|
|
32
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
33
|
+
|
|
34
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
35
|
+
# As such, this might not be the best way to use this object.
|
|
36
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
40
37
|
|
|
41
|
-
|
|
38
|
+
api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
42
39
|
auto_order_oid = 56 # Integer | The auto order oid to retrieve.
|
|
43
40
|
opts = {
|
|
44
41
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
@@ -105,18 +102,15 @@ Retrieves a single auto order using the specified reference (original) order id.
|
|
|
105
102
|
```ruby
|
|
106
103
|
require 'time'
|
|
107
104
|
require 'ultracart_api'
|
|
108
|
-
|
|
109
|
-
|
|
110
|
-
|
|
111
|
-
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
116
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
117
|
-
end
|
|
105
|
+
require 'json'
|
|
106
|
+
require 'yaml'
|
|
107
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
108
|
+
|
|
109
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
110
|
+
# As such, this might not be the best way to use this object.
|
|
111
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
118
112
|
|
|
119
|
-
|
|
113
|
+
api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
120
114
|
auto_order_code = 'auto_order_code_example' # String | The auto order oid to retrieve.
|
|
121
115
|
opts = {
|
|
122
116
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
@@ -183,18 +177,15 @@ Retrieves a single auto order using the specified reference (original) order id.
|
|
|
183
177
|
```ruby
|
|
184
178
|
require 'time'
|
|
185
179
|
require 'ultracart_api'
|
|
186
|
-
|
|
187
|
-
|
|
188
|
-
|
|
189
|
-
|
|
190
|
-
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
194
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
195
|
-
end
|
|
180
|
+
require 'json'
|
|
181
|
+
require 'yaml'
|
|
182
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
183
|
+
|
|
184
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
185
|
+
# As such, this might not be the best way to use this object.
|
|
186
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
196
187
|
|
|
197
|
-
|
|
188
|
+
api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
198
189
|
reference_order_id = 'reference_order_id_example' # String | The auto order oid to retrieve.
|
|
199
190
|
opts = {
|
|
200
191
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
@@ -261,18 +252,15 @@ Retrieves auto orders from the account. If no parameters are specified, all aut
|
|
|
261
252
|
```ruby
|
|
262
253
|
require 'time'
|
|
263
254
|
require 'ultracart_api'
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
272
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
273
|
-
end
|
|
255
|
+
require 'json'
|
|
256
|
+
require 'yaml'
|
|
257
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
258
|
+
|
|
259
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
260
|
+
# As such, this might not be the best way to use this object.
|
|
261
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
274
262
|
|
|
275
|
-
|
|
263
|
+
api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
276
264
|
opts = {
|
|
277
265
|
auto_order_code: 'auto_order_code_example', # String | Auto order code
|
|
278
266
|
original_order_id: 'original_order_id_example', # String | Original order id
|
|
@@ -381,18 +369,15 @@ Retrieves a group of auto orders from the account based on an array of auto orde
|
|
|
381
369
|
```ruby
|
|
382
370
|
require 'time'
|
|
383
371
|
require 'ultracart_api'
|
|
384
|
-
|
|
385
|
-
|
|
386
|
-
|
|
387
|
-
|
|
388
|
-
|
|
389
|
-
|
|
390
|
-
|
|
391
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
392
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
393
|
-
end
|
|
372
|
+
require 'json'
|
|
373
|
+
require 'yaml'
|
|
374
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
375
|
+
|
|
376
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
377
|
+
# As such, this might not be the best way to use this object.
|
|
378
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
394
379
|
|
|
395
|
-
|
|
380
|
+
api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
396
381
|
auto_order_batch = UltracartClient::AutoOrderQueryBatch.new # AutoOrderQueryBatch | Auto order batch
|
|
397
382
|
opts = {
|
|
398
383
|
_expand: '_expand_example' # String | The object expansion to perform on the result.
|
|
@@ -459,18 +444,15 @@ Retrieves a group of auto orders from the account based on a query object. You
|
|
|
459
444
|
```ruby
|
|
460
445
|
require 'time'
|
|
461
446
|
require 'ultracart_api'
|
|
462
|
-
|
|
463
|
-
|
|
464
|
-
|
|
465
|
-
|
|
466
|
-
|
|
467
|
-
|
|
468
|
-
|
|
469
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
470
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
471
|
-
end
|
|
447
|
+
require 'json'
|
|
448
|
+
require 'yaml'
|
|
449
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
450
|
+
|
|
451
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
452
|
+
# As such, this might not be the best way to use this object.
|
|
453
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
472
454
|
|
|
473
|
-
|
|
455
|
+
api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
474
456
|
auto_order_query = UltracartClient::AutoOrderQuery.new # AutoOrderQuery | Auto order query
|
|
475
457
|
opts = {
|
|
476
458
|
_limit: 56, # Integer | The maximum number of records to return on this one API call. (Maximum 200)
|
|
@@ -543,18 +525,15 @@ Update an auto order on the UltraCart account.
|
|
|
543
525
|
```ruby
|
|
544
526
|
require 'time'
|
|
545
527
|
require 'ultracart_api'
|
|
546
|
-
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
552
|
-
|
|
553
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
554
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
555
|
-
end
|
|
528
|
+
require 'json'
|
|
529
|
+
require 'yaml'
|
|
530
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
531
|
+
|
|
532
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
533
|
+
# As such, this might not be the best way to use this object.
|
|
534
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
556
535
|
|
|
557
|
-
|
|
536
|
+
api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
558
537
|
auto_order_oid = 56 # Integer | The auto order oid to update.
|
|
559
538
|
auto_order = UltracartClient::AutoOrder.new # AutoOrder | Auto order to update
|
|
560
539
|
opts = {
|
|
@@ -623,18 +602,15 @@ Update multiple auto orders on the UltraCart account.
|
|
|
623
602
|
```ruby
|
|
624
603
|
require 'time'
|
|
625
604
|
require 'ultracart_api'
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
634
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
635
|
-
end
|
|
605
|
+
require 'json'
|
|
606
|
+
require 'yaml'
|
|
607
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
608
|
+
|
|
609
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
610
|
+
# As such, this might not be the best way to use this object.
|
|
611
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
636
612
|
|
|
637
|
-
|
|
613
|
+
api = UltracartClient::AutoOrderApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
638
614
|
auto_orders_request = UltracartClient::AutoOrdersRequest.new # AutoOrdersRequest | Auto orders to update (synchronous maximum 20 / asynchronous maximum 100)
|
|
639
615
|
opts = {
|
|
640
616
|
_expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
|
data/docs/ChannelPartnerApi.md
CHANGED
|
@@ -24,18 +24,15 @@ Cancel channel partner order by channel partner order id
|
|
|
24
24
|
```ruby
|
|
25
25
|
require 'time'
|
|
26
26
|
require 'ultracart_api'
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
35
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
36
|
-
end
|
|
27
|
+
require 'json'
|
|
28
|
+
require 'yaml'
|
|
29
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
30
|
+
|
|
31
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
32
|
+
# As such, this might not be the best way to use this object.
|
|
33
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
37
34
|
|
|
38
|
-
|
|
35
|
+
api = UltracartClient::ChannelPartnerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
39
36
|
order_id = 'order_id_example' # String | The channel partner order id to delete.
|
|
40
37
|
|
|
41
38
|
begin
|
|
@@ -98,18 +95,15 @@ Cancel channel partner order by UltraCart order id
|
|
|
98
95
|
```ruby
|
|
99
96
|
require 'time'
|
|
100
97
|
require 'ultracart_api'
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
105
|
-
|
|
106
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
107
|
-
config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
|
|
110
|
-
end
|
|
98
|
+
require 'json'
|
|
99
|
+
require 'yaml'
|
|
100
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
111
101
|
|
|
112
|
-
|
|
102
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
103
|
+
# As such, this might not be the best way to use this object.
|
|
104
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
105
|
+
|
|
106
|
+
api = UltracartClient::ChannelPartnerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
113
107
|
order_id = 'order_id_example' # String | The UltraCart order id to delete.
|
|
114
108
|
|
|
115
109
|
begin
|
|
@@ -172,18 +166,15 @@ Estimate shipping for order from a channel partner.
|
|
|
172
166
|
```ruby
|
|
173
167
|
require 'time'
|
|
174
168
|
require 'ultracart_api'
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
179
|
-
|
|
180
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
181
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
182
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
183
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
184
|
-
end
|
|
169
|
+
require 'json'
|
|
170
|
+
require 'yaml'
|
|
171
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
185
172
|
|
|
186
|
-
|
|
173
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
174
|
+
# As such, this might not be the best way to use this object.
|
|
175
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
176
|
+
|
|
177
|
+
api = UltracartClient::ChannelPartnerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
187
178
|
channel_partner_order = UltracartClient::ChannelPartnerOrder.new # ChannelPartnerOrder | Order needing shipping estimate
|
|
188
179
|
|
|
189
180
|
begin
|
|
@@ -246,18 +237,15 @@ Estimate tax for order from a channel partner.
|
|
|
246
237
|
```ruby
|
|
247
238
|
require 'time'
|
|
248
239
|
require 'ultracart_api'
|
|
249
|
-
|
|
250
|
-
|
|
251
|
-
|
|
252
|
-
|
|
253
|
-
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
257
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
258
|
-
end
|
|
240
|
+
require 'json'
|
|
241
|
+
require 'yaml'
|
|
242
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
243
|
+
|
|
244
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
245
|
+
# As such, this might not be the best way to use this object.
|
|
246
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
259
247
|
|
|
260
|
-
|
|
248
|
+
api = UltracartClient::ChannelPartnerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
261
249
|
channel_partner_order = UltracartClient::ChannelPartnerOrder.new # ChannelPartnerOrder | Order needing tax estimate
|
|
262
250
|
|
|
263
251
|
begin
|
|
@@ -320,18 +308,15 @@ Insert order from a channel partner.
|
|
|
320
308
|
```ruby
|
|
321
309
|
require 'time'
|
|
322
310
|
require 'ultracart_api'
|
|
323
|
-
|
|
324
|
-
|
|
325
|
-
|
|
326
|
-
|
|
327
|
-
|
|
328
|
-
|
|
329
|
-
|
|
330
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
331
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
332
|
-
end
|
|
311
|
+
require 'json'
|
|
312
|
+
require 'yaml'
|
|
313
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
314
|
+
|
|
315
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
316
|
+
# As such, this might not be the best way to use this object.
|
|
317
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
333
318
|
|
|
334
|
-
|
|
319
|
+
api = UltracartClient::ChannelPartnerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
335
320
|
channel_partner_order = UltracartClient::ChannelPartnerOrder.new # ChannelPartnerOrder | Order to insert
|
|
336
321
|
|
|
337
322
|
begin
|
data/docs/ChargebackApi.md
CHANGED
|
@@ -24,18 +24,15 @@ Delete a chargeback on the UltraCart account.
|
|
|
24
24
|
```ruby
|
|
25
25
|
require 'time'
|
|
26
26
|
require 'ultracart_api'
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
35
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
36
|
-
end
|
|
27
|
+
require 'json'
|
|
28
|
+
require 'yaml'
|
|
29
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
30
|
+
|
|
31
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
32
|
+
# As such, this might not be the best way to use this object.
|
|
33
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
37
34
|
|
|
38
|
-
|
|
35
|
+
api = UltracartClient::ChargebackApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
39
36
|
chargeback_dispute_oid = 56 # Integer | The chargeback_dispute_oid to delete.
|
|
40
37
|
|
|
41
38
|
begin
|
|
@@ -98,18 +95,15 @@ Retrieves a single chargeback using the specified chargeback dispute oid.
|
|
|
98
95
|
```ruby
|
|
99
96
|
require 'time'
|
|
100
97
|
require 'ultracart_api'
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
105
|
-
|
|
106
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
107
|
-
config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
|
|
110
|
-
end
|
|
98
|
+
require 'json'
|
|
99
|
+
require 'yaml'
|
|
100
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
111
101
|
|
|
112
|
-
|
|
102
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
103
|
+
# As such, this might not be the best way to use this object.
|
|
104
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
105
|
+
|
|
106
|
+
api = UltracartClient::ChargebackApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
113
107
|
chargeback_dispute_oid = 56 # Integer | The chargeback dispute oid to retrieve.
|
|
114
108
|
opts = {
|
|
115
109
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
@@ -176,18 +170,15 @@ Retrieves chargebacks from the account. If no parameters are specified, all cha
|
|
|
176
170
|
```ruby
|
|
177
171
|
require 'time'
|
|
178
172
|
require 'ultracart_api'
|
|
179
|
-
|
|
180
|
-
|
|
181
|
-
|
|
182
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
183
|
-
|
|
184
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
185
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
186
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
187
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
188
|
-
end
|
|
173
|
+
require 'json'
|
|
174
|
+
require 'yaml'
|
|
175
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
189
176
|
|
|
190
|
-
|
|
177
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
178
|
+
# As such, this might not be the best way to use this object.
|
|
179
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
180
|
+
|
|
181
|
+
api = UltracartClient::ChargebackApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
191
182
|
opts = {
|
|
192
183
|
order_id: 'order_id_example', # String | Order Id
|
|
193
184
|
case_number: 'case_number_example', # String | Case number
|
|
@@ -274,18 +265,15 @@ Insert a chargeback on the UltraCart account.
|
|
|
274
265
|
```ruby
|
|
275
266
|
require 'time'
|
|
276
267
|
require 'ultracart_api'
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
|
|
281
|
-
|
|
282
|
-
|
|
283
|
-
|
|
284
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
285
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
286
|
-
end
|
|
268
|
+
require 'json'
|
|
269
|
+
require 'yaml'
|
|
270
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
271
|
+
|
|
272
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
273
|
+
# As such, this might not be the best way to use this object.
|
|
274
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
287
275
|
|
|
288
|
-
|
|
276
|
+
api = UltracartClient::ChargebackApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
289
277
|
chargeback = UltracartClient::ChargebackDispute.new # ChargebackDispute | Chargeback to insert
|
|
290
278
|
opts = {
|
|
291
279
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
@@ -352,18 +340,15 @@ Update a chargeback on the UltraCart account.
|
|
|
352
340
|
```ruby
|
|
353
341
|
require 'time'
|
|
354
342
|
require 'ultracart_api'
|
|
355
|
-
|
|
356
|
-
|
|
357
|
-
|
|
358
|
-
|
|
359
|
-
|
|
360
|
-
|
|
361
|
-
|
|
362
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
363
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
364
|
-
end
|
|
343
|
+
require 'json'
|
|
344
|
+
require 'yaml'
|
|
345
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
346
|
+
|
|
347
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
348
|
+
# As such, this might not be the best way to use this object.
|
|
349
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
365
350
|
|
|
366
|
-
|
|
351
|
+
api = UltracartClient::ChargebackApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
367
352
|
chargeback_dispute_oid = 56 # Integer | The chargeback_dispute_oid to update.
|
|
368
353
|
chargeback = UltracartClient::ChargebackDispute.new # ChargebackDispute | Chargeback to update
|
|
369
354
|
opts = {
|