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/GiftCertificateApi.md
CHANGED
@@ -27,18 +27,15 @@ Adds a ledger entry for this gift certificate.
|
|
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::GiftCertificateApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
42
39
|
gift_certificate_oid = 56 # Integer |
|
43
40
|
gift_certificate_ledger_entry = UltracartClient::GiftCertificateLedgerEntry.new # GiftCertificateLedgerEntry | Gift certificate ledger entry
|
44
41
|
|
@@ -103,18 +100,15 @@ Creates a gift certificate for this merchant account.
|
|
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::GiftCertificateApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
118
112
|
gift_certificate_create_request = UltracartClient::GiftCertificateCreateRequest.new # GiftCertificateCreateRequest | Gift certificate create request
|
119
113
|
|
120
114
|
begin
|
@@ -177,18 +171,15 @@ Deletes a gift certificate for this merchant account.
|
|
177
171
|
```ruby
|
178
172
|
require 'time'
|
179
173
|
require 'ultracart_api'
|
180
|
-
|
181
|
-
|
182
|
-
|
183
|
-
|
184
|
-
|
185
|
-
|
186
|
-
|
187
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
188
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
189
|
-
end
|
174
|
+
require 'json'
|
175
|
+
require 'yaml'
|
176
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
177
|
+
|
178
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
179
|
+
# As such, this might not be the best way to use this object.
|
180
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
190
181
|
|
191
|
-
|
182
|
+
api = UltracartClient::GiftCertificateApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
192
183
|
gift_certificate_oid = 56 # Integer |
|
193
184
|
|
194
185
|
begin
|
@@ -250,18 +241,15 @@ Retrieves a gift certificate from the account based on the code (the value the c
|
|
250
241
|
```ruby
|
251
242
|
require 'time'
|
252
243
|
require 'ultracart_api'
|
253
|
-
|
254
|
-
|
255
|
-
|
256
|
-
|
257
|
-
|
258
|
-
|
259
|
-
|
260
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
261
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
262
|
-
end
|
244
|
+
require 'json'
|
245
|
+
require 'yaml'
|
246
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
247
|
+
|
248
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
249
|
+
# As such, this might not be the best way to use this object.
|
250
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
263
251
|
|
264
|
-
|
252
|
+
api = UltracartClient::GiftCertificateApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
265
253
|
code = 'code_example' # String |
|
266
254
|
|
267
255
|
begin
|
@@ -324,18 +312,15 @@ Retrieves a gift certificate from the account based on the internal primary key.
|
|
324
312
|
```ruby
|
325
313
|
require 'time'
|
326
314
|
require 'ultracart_api'
|
327
|
-
|
328
|
-
|
329
|
-
|
330
|
-
|
331
|
-
|
332
|
-
|
333
|
-
|
334
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
335
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
336
|
-
end
|
315
|
+
require 'json'
|
316
|
+
require 'yaml'
|
317
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
318
|
+
|
319
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
320
|
+
# As such, this might not be the best way to use this object.
|
321
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
337
322
|
|
338
|
-
|
323
|
+
api = UltracartClient::GiftCertificateApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
339
324
|
gift_certificate_oid = 56 # Integer |
|
340
325
|
|
341
326
|
begin
|
@@ -398,18 +383,15 @@ Retrieves all gift certificates from the account based on customer email.
|
|
398
383
|
```ruby
|
399
384
|
require 'time'
|
400
385
|
require 'ultracart_api'
|
401
|
-
|
402
|
-
|
403
|
-
|
404
|
-
|
405
|
-
|
406
|
-
|
407
|
-
|
408
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
409
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
410
|
-
end
|
386
|
+
require 'json'
|
387
|
+
require 'yaml'
|
388
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
389
|
+
|
390
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
391
|
+
# As such, this might not be the best way to use this object.
|
392
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
411
393
|
|
412
|
-
|
394
|
+
api = UltracartClient::GiftCertificateApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
413
395
|
email = 'email_example' # String |
|
414
396
|
|
415
397
|
begin
|
@@ -472,18 +454,15 @@ Retrieves gift certificates from the account. If no parameters are specified, a
|
|
472
454
|
```ruby
|
473
455
|
require 'time'
|
474
456
|
require 'ultracart_api'
|
475
|
-
|
476
|
-
|
477
|
-
|
478
|
-
|
479
|
-
|
480
|
-
|
481
|
-
|
482
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
483
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
484
|
-
end
|
457
|
+
require 'json'
|
458
|
+
require 'yaml'
|
459
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
460
|
+
|
461
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
462
|
+
# As such, this might not be the best way to use this object.
|
463
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
485
464
|
|
486
|
-
|
465
|
+
api = UltracartClient::GiftCertificateApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
487
466
|
gift_certificate_query = UltracartClient::GiftCertificateQuery.new # GiftCertificateQuery | Gift certificates query
|
488
467
|
opts = {
|
489
468
|
_limit: 56, # Integer | The maximum number of records to return on this one API call. (Max 200)
|
@@ -558,18 +537,15 @@ Update a gift certificate for this merchant account.
|
|
558
537
|
```ruby
|
559
538
|
require 'time'
|
560
539
|
require 'ultracart_api'
|
561
|
-
|
562
|
-
|
563
|
-
|
564
|
-
|
565
|
-
|
566
|
-
|
567
|
-
|
568
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
569
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
570
|
-
end
|
540
|
+
require 'json'
|
541
|
+
require 'yaml'
|
542
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
543
|
+
|
544
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
545
|
+
# As such, this might not be the best way to use this object.
|
546
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
571
547
|
|
572
|
-
|
548
|
+
api = UltracartClient::GiftCertificateApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
573
549
|
gift_certificate_oid = 56 # Integer |
|
574
550
|
gift_certificate = UltracartClient::GiftCertificate.new # GiftCertificate | Gift certificate
|
575
551
|
|
data/docs/IntegrationLogApi.md
CHANGED
@@ -24,18 +24,15 @@ Retrieve an integration logs from the account based identifiers
|
|
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::IntegrationLogApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
39
36
|
pk = 'pk_example' # String |
|
40
37
|
sk = 'sk_example' # String |
|
41
38
|
|
@@ -100,18 +97,15 @@ Retrieve an integration log file from the account based identifiers
|
|
100
97
|
```ruby
|
101
98
|
require 'time'
|
102
99
|
require 'ultracart_api'
|
103
|
-
|
104
|
-
|
105
|
-
|
106
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
107
|
-
|
108
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
109
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
110
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
111
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
112
|
-
end
|
100
|
+
require 'json'
|
101
|
+
require 'yaml'
|
102
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
113
103
|
|
114
|
-
|
104
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
105
|
+
# As such, this might not be the best way to use this object.
|
106
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
107
|
+
|
108
|
+
api = UltracartClient::IntegrationLogApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
115
109
|
pk = 'pk_example' # String |
|
116
110
|
sk = 'sk_example' # String |
|
117
111
|
uuid = 'uuid_example' # String |
|
@@ -178,18 +172,15 @@ Retrieve an integration log file from the account based identifiers
|
|
178
172
|
```ruby
|
179
173
|
require 'time'
|
180
174
|
require 'ultracart_api'
|
181
|
-
|
182
|
-
|
183
|
-
|
184
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
185
|
-
|
186
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
187
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
188
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
189
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
190
|
-
end
|
175
|
+
require 'json'
|
176
|
+
require 'yaml'
|
177
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
191
178
|
|
192
|
-
|
179
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
180
|
+
# As such, this might not be the best way to use this object.
|
181
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
182
|
+
|
183
|
+
api = UltracartClient::IntegrationLogApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
193
184
|
pk = 'pk_example' # String |
|
194
185
|
sk = 'sk_example' # String |
|
195
186
|
uuid = 'uuid_example' # String |
|
@@ -256,18 +247,15 @@ Retrieves a set of integration log summaries from the account based on a query o
|
|
256
247
|
```ruby
|
257
248
|
require 'time'
|
258
249
|
require 'ultracart_api'
|
259
|
-
|
260
|
-
|
261
|
-
|
262
|
-
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
267
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
268
|
-
end
|
250
|
+
require 'json'
|
251
|
+
require 'yaml'
|
252
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
253
|
+
|
254
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
255
|
+
# As such, this might not be the best way to use this object.
|
256
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
269
257
|
|
270
|
-
|
258
|
+
api = UltracartClient::IntegrationLogApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
271
259
|
integration_log_summaries_query = UltracartClient::IntegrationLogSummaryQueryRequest.new # IntegrationLogSummaryQueryRequest | Integration log summaries query
|
272
260
|
|
273
261
|
begin
|
@@ -330,18 +318,15 @@ Retrieves a set of integration logs from the account based on a query object.
|
|
330
318
|
```ruby
|
331
319
|
require 'time'
|
332
320
|
require 'ultracart_api'
|
333
|
-
|
334
|
-
|
335
|
-
|
336
|
-
|
337
|
-
|
338
|
-
|
339
|
-
|
340
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
341
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
342
|
-
end
|
321
|
+
require 'json'
|
322
|
+
require 'yaml'
|
323
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
324
|
+
|
325
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
326
|
+
# As such, this might not be the best way to use this object.
|
327
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
343
328
|
|
344
|
-
|
329
|
+
api = UltracartClient::IntegrationLogApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
345
330
|
integration_log_query = UltracartClient::IntegrationLogQueryRequest.new # IntegrationLogQueryRequest | Integration log query
|
346
331
|
opts = {
|
347
332
|
_limit: 56, # Integer | The maximum number of records to return on this one API call. (Default 100, Max 500)
|
data/docs/ItemApi.md
CHANGED
@@ -28,18 +28,15 @@ Delete an item on the UltraCart account.
|
|
28
28
|
```ruby
|
29
29
|
require 'time'
|
30
30
|
require 'ultracart_api'
|
31
|
-
|
32
|
-
|
33
|
-
|
34
|
-
|
35
|
-
|
36
|
-
|
37
|
-
|
38
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
39
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
40
|
-
end
|
31
|
+
require 'json'
|
32
|
+
require 'yaml'
|
33
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
34
|
+
|
35
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
36
|
+
# As such, this might not be the best way to use this object.
|
37
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
41
38
|
|
42
|
-
|
39
|
+
api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
43
40
|
merchant_item_oid = 56 # Integer | The item oid to delete.
|
44
41
|
|
45
42
|
begin
|
@@ -101,18 +98,15 @@ Retrieves a single item using the specified item oid.
|
|
101
98
|
```ruby
|
102
99
|
require 'time'
|
103
100
|
require 'ultracart_api'
|
104
|
-
|
105
|
-
|
106
|
-
|
107
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
108
|
-
|
109
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
110
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
111
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
112
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
113
|
-
end
|
101
|
+
require 'json'
|
102
|
+
require 'yaml'
|
103
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
114
104
|
|
115
|
-
|
105
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
106
|
+
# As such, this might not be the best way to use this object.
|
107
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
108
|
+
|
109
|
+
api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
116
110
|
merchant_item_oid = 56 # Integer | The item oid to retrieve.
|
117
111
|
opts = {
|
118
112
|
_expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
|
@@ -181,18 +175,15 @@ Retrieves a single item using the specified item id.
|
|
181
175
|
```ruby
|
182
176
|
require 'time'
|
183
177
|
require 'ultracart_api'
|
184
|
-
|
185
|
-
|
186
|
-
|
187
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
188
|
-
|
189
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
190
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
191
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
192
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
193
|
-
end
|
178
|
+
require 'json'
|
179
|
+
require 'yaml'
|
180
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
194
181
|
|
195
|
-
|
182
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
183
|
+
# As such, this might not be the best way to use this object.
|
184
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
185
|
+
|
186
|
+
api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
196
187
|
merchant_item_id = 'merchant_item_id_example' # String | The item id to retrieve.
|
197
188
|
opts = {
|
198
189
|
_expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
|
@@ -261,18 +252,15 @@ Retrieves a group of items from the account. If no parameters are specified, al
|
|
261
252
|
```ruby
|
262
253
|
require 'time'
|
263
254
|
require 'ultracart_api'
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
268
|
-
|
269
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
270
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
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
|
274
258
|
|
275
|
-
|
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.
|
262
|
+
|
263
|
+
api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
276
264
|
opts = {
|
277
265
|
parent_category_id: 56, # Integer | The parent category object id to retrieve items for. Unspecified means all items on the account. 0 = root
|
278
266
|
parent_category_path: 'parent_category_path_example', # String | The parent category path to retrieve items for. Unspecified means all items on the account. / = root
|
@@ -351,18 +339,15 @@ Retrieves the pricing tiers
|
|
351
339
|
```ruby
|
352
340
|
require 'time'
|
353
341
|
require 'ultracart_api'
|
354
|
-
|
355
|
-
|
356
|
-
|
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
|
342
|
+
require 'json'
|
343
|
+
require 'yaml'
|
344
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
364
345
|
|
365
|
-
|
346
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
347
|
+
# As such, this might not be the best way to use this object.
|
348
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
349
|
+
|
350
|
+
api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
366
351
|
opts = {
|
367
352
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
368
353
|
}
|
@@ -427,18 +412,15 @@ Create a new item on the UltraCart account.
|
|
427
412
|
```ruby
|
428
413
|
require 'time'
|
429
414
|
require 'ultracart_api'
|
430
|
-
|
431
|
-
|
432
|
-
|
433
|
-
|
434
|
-
|
435
|
-
|
436
|
-
|
437
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
438
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
439
|
-
end
|
415
|
+
require 'json'
|
416
|
+
require 'yaml'
|
417
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
418
|
+
|
419
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
420
|
+
# As such, this might not be the best way to use this object.
|
421
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
440
422
|
|
441
|
-
|
423
|
+
api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
442
424
|
item = UltracartClient::Item.new # Item | Item to create
|
443
425
|
opts = {
|
444
426
|
_expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
|
@@ -507,18 +489,15 @@ Update a new item on the UltraCart account.
|
|
507
489
|
```ruby
|
508
490
|
require 'time'
|
509
491
|
require 'ultracart_api'
|
510
|
-
|
511
|
-
|
512
|
-
|
513
|
-
|
514
|
-
|
515
|
-
|
516
|
-
|
517
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
518
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
519
|
-
end
|
492
|
+
require 'json'
|
493
|
+
require 'yaml'
|
494
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
495
|
+
|
496
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
497
|
+
# As such, this might not be the best way to use this object.
|
498
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
520
499
|
|
521
|
-
|
500
|
+
api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
522
501
|
merchant_item_oid = 56 # Integer | The item oid to update.
|
523
502
|
item = UltracartClient::Item.new # Item | Item to update
|
524
503
|
opts = {
|
@@ -589,18 +568,15 @@ Update multiple item on the UltraCart account.
|
|
589
568
|
```ruby
|
590
569
|
require 'time'
|
591
570
|
require 'ultracart_api'
|
592
|
-
|
593
|
-
|
594
|
-
|
595
|
-
|
596
|
-
|
597
|
-
|
598
|
-
|
599
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
600
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
601
|
-
end
|
571
|
+
require 'json'
|
572
|
+
require 'yaml'
|
573
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
574
|
+
|
575
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
576
|
+
# As such, this might not be the best way to use this object.
|
577
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
602
578
|
|
603
|
-
|
579
|
+
api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
604
580
|
items_request = UltracartClient::ItemsRequest.new # ItemsRequest | Items to update (synchronous maximum 20 / asynchronous maximum 100)
|
605
581
|
opts = {
|
606
582
|
_expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
|
@@ -671,18 +647,15 @@ Uploads an image and returns back meta information about the image as well as th
|
|
671
647
|
```ruby
|
672
648
|
require 'time'
|
673
649
|
require 'ultracart_api'
|
674
|
-
|
675
|
-
|
676
|
-
|
677
|
-
|
678
|
-
|
679
|
-
|
680
|
-
|
681
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
682
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
683
|
-
end
|
650
|
+
require 'json'
|
651
|
+
require 'yaml'
|
652
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
653
|
+
|
654
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
655
|
+
# As such, this might not be the best way to use this object.
|
656
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
684
657
|
|
685
|
-
|
658
|
+
api = UltracartClient::ItemApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
686
659
|
file = File.new('/path/to/some/file') # File | File to upload
|
687
660
|
|
688
661
|
begin
|