ultracart_api 4.0.32.rc → 4.0.35.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.
Files changed (48) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +25 -4
  3. data/docs/Activity.md +4 -0
  4. data/docs/AffiliateApi.md +16 -22
  5. data/docs/AutoOrderApi.md +64 -88
  6. data/docs/ChannelPartnerApi.md +40 -55
  7. data/docs/ChargebackApi.md +40 -55
  8. data/docs/CheckoutApi.md +152 -294
  9. data/docs/Conversation.md +26 -0
  10. data/docs/ConversationAgentAuthResponse.md +22 -0
  11. data/docs/ConversationApi.md +438 -0
  12. data/docs/ConversationMessage.md +26 -0
  13. data/docs/ConversationParticipant.md +30 -0
  14. data/docs/ConversationStartRequest.md +20 -0
  15. data/docs/ConversationStartResponse.md +20 -0
  16. data/docs/ConversationSummary.md +34 -0
  17. data/docs/ConversationsResponse.md +26 -0
  18. data/docs/CouponApi.md +152 -209
  19. data/docs/CustomerActivity.md +9 -1
  20. data/docs/CustomerApi.md +213 -192
  21. data/docs/CustomerMergeRequest.md +20 -0
  22. data/docs/FulfillmentApi.md +48 -66
  23. data/docs/GiftCertificateApi.md +64 -88
  24. data/docs/IntegrationLogApi.md +40 -55
  25. data/docs/ItemApi.md +72 -99
  26. data/docs/OauthApi.md +16 -32
  27. data/docs/OrderApi.md +184 -253
  28. data/docs/SsoApi.md +32 -44
  29. data/docs/StorefrontApi.md +1134 -2345
  30. data/docs/TaxApi.md +224 -308
  31. data/docs/UserApi.md +88 -121
  32. data/docs/WebhookApi.md +64 -88
  33. data/lib/ultracart_api/api/conversation_api.rb +418 -0
  34. data/lib/ultracart_api/api/customer_api.rb +78 -0
  35. data/lib/ultracart_api/models/activity.rb +19 -1
  36. data/lib/ultracart_api/models/conversation.rb +259 -0
  37. data/lib/ultracart_api/models/conversation_agent_auth_response.rb +237 -0
  38. data/lib/ultracart_api/models/conversation_message.rb +258 -0
  39. data/lib/ultracart_api/models/conversation_participant.rb +276 -0
  40. data/lib/ultracart_api/models/conversation_start_request.rb +230 -0
  41. data/lib/ultracart_api/models/conversation_start_response.rb +228 -0
  42. data/lib/ultracart_api/models/conversation_summary.rb +292 -0
  43. data/lib/ultracart_api/models/conversations_response.rb +258 -0
  44. data/lib/ultracart_api/models/customer_activity.rb +40 -4
  45. data/lib/ultracart_api/models/customer_merge_request.rb +230 -0
  46. data/lib/ultracart_api/version.rb +1 -1
  47. data/lib/ultracart_api.rb +10 -0
  48. metadata +22 -2
@@ -25,18 +25,15 @@ Acknowledge receipt of orders so that they are removed from the fulfillment queu
25
25
  ```ruby
26
26
  require 'time'
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['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
37
- end
28
+ require 'json'
29
+ require 'yaml'
30
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
31
+
32
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
33
+ # As such, this might not be the best way to use this object.
34
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
38
35
 
39
- api_instance = UltracartClient::FulfillmentApi.new
36
+ api = UltracartClient::FulfillmentApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
40
37
  distribution_center_code = 'distribution_center_code_example' # String | Distribution center code
41
38
  order_ids = ['property_example'] # Array<String> | Orders to acknowledge receipt of (limit 100)
42
39
 
@@ -100,18 +97,15 @@ The packing slip PDF that is returned is base 64 encoded
100
97
  ```ruby
101
98
  require 'time'
102
99
  require 'ultracart_api'
103
- # setup authorization
104
- UltracartClient.configure do |config|
105
- # Configure OAuth2 access token for authorization: ultraCartOauth
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
- api_instance = UltracartClient::FulfillmentApi.new
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::FulfillmentApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
115
109
  distribution_center_code = 'distribution_center_code_example' # String | Distribution center code
116
110
  order_id = 'order_id_example' # String | Order ID
117
111
 
@@ -176,18 +170,15 @@ Retrieves up to 100 orders that are queued up in this distribution center. You
176
170
  ```ruby
177
171
  require 'time'
178
172
  require 'ultracart_api'
179
- # setup authorization
180
- UltracartClient.configure do |config|
181
- # Configure OAuth2 access token for authorization: ultraCartOauth
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
176
+
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.
189
180
 
190
- api_instance = UltracartClient::FulfillmentApi.new
181
+ api = UltracartClient::FulfillmentApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
191
182
  distribution_center_code = 'distribution_center_code_example' # String | Distribution center code
192
183
 
193
184
  begin
@@ -250,18 +241,15 @@ Retrieves the distribution centers that this user has access to.
250
241
  ```ruby
251
242
  require 'time'
252
243
  require 'ultracart_api'
253
- # setup authorization
254
- UltracartClient.configure do |config|
255
- # Configure OAuth2 access token for authorization: ultraCartOauth
256
- config.access_token = 'YOUR ACCESS TOKEN'
257
-
258
- # Configure API key authorization: ultraCartSimpleApiKey
259
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
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
- api_instance = UltracartClient::FulfillmentApi.new
252
+ api = UltracartClient::FulfillmentApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
265
253
 
266
254
  begin
267
255
  # Retrieve distribution centers
@@ -321,18 +309,15 @@ Store the tracking information and mark the order shipped for this distribution
321
309
  ```ruby
322
310
  require 'time'
323
311
  require 'ultracart_api'
324
- # setup authorization
325
- UltracartClient.configure do |config|
326
- # Configure OAuth2 access token for authorization: ultraCartOauth
327
- config.access_token = 'YOUR ACCESS TOKEN'
328
-
329
- # Configure API key authorization: ultraCartSimpleApiKey
330
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
331
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
332
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
333
- end
312
+ require 'json'
313
+ require 'yaml'
314
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
334
315
 
335
- api_instance = UltracartClient::FulfillmentApi.new
316
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
317
+ # As such, this might not be the best way to use this object.
318
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
319
+
320
+ api = UltracartClient::FulfillmentApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
336
321
  distribution_center_code = 'distribution_center_code_example' # String | Distribution center code
337
322
  shipments = [UltracartClient::FulfillmentShipment.new] # Array<FulfillmentShipment> | Orders to mark shipped
338
323
 
@@ -396,18 +381,15 @@ Update the inventory for items associated with this distribution center
396
381
  ```ruby
397
382
  require 'time'
398
383
  require 'ultracart_api'
399
- # setup authorization
400
- UltracartClient.configure do |config|
401
- # Configure OAuth2 access token for authorization: ultraCartOauth
402
- config.access_token = 'YOUR ACCESS TOKEN'
403
-
404
- # Configure API key authorization: ultraCartSimpleApiKey
405
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
406
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
407
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
408
- end
384
+ require 'json'
385
+ require 'yaml'
386
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
387
+
388
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
389
+ # As such, this might not be the best way to use this object.
390
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
409
391
 
410
- api_instance = UltracartClient::FulfillmentApi.new
392
+ api = UltracartClient::FulfillmentApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
411
393
  distribution_center_code = 'distribution_center_code_example' # String | Distribution center code
412
394
  inventories = [UltracartClient::FulfillmentInventory.new] # Array<FulfillmentInventory> | Inventory updates (limit 500)
413
395
 
@@ -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
- # setup authorization
31
- UltracartClient.configure do |config|
32
- # Configure OAuth2 access token for authorization: ultraCartOauth
33
- config.access_token = 'YOUR ACCESS TOKEN'
34
-
35
- # Configure API key authorization: ultraCartSimpleApiKey
36
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
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
- api_instance = UltracartClient::GiftCertificateApi.new
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
- # setup authorization
107
- UltracartClient.configure do |config|
108
- # Configure OAuth2 access token for authorization: ultraCartOauth
109
- config.access_token = 'YOUR ACCESS TOKEN'
110
-
111
- # Configure API key authorization: ultraCartSimpleApiKey
112
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
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
- api_instance = UltracartClient::GiftCertificateApi.new
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
- # setup authorization
181
- UltracartClient.configure do |config|
182
- # Configure OAuth2 access token for authorization: ultraCartOauth
183
- config.access_token = 'YOUR ACCESS TOKEN'
184
-
185
- # Configure API key authorization: ultraCartSimpleApiKey
186
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
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
- api_instance = UltracartClient::GiftCertificateApi.new
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
- # setup authorization
254
- UltracartClient.configure do |config|
255
- # Configure OAuth2 access token for authorization: ultraCartOauth
256
- config.access_token = 'YOUR ACCESS TOKEN'
257
-
258
- # Configure API key authorization: ultraCartSimpleApiKey
259
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
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
- api_instance = UltracartClient::GiftCertificateApi.new
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
- # setup authorization
328
- UltracartClient.configure do |config|
329
- # Configure OAuth2 access token for authorization: ultraCartOauth
330
- config.access_token = 'YOUR ACCESS TOKEN'
331
-
332
- # Configure API key authorization: ultraCartSimpleApiKey
333
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
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
- api_instance = UltracartClient::GiftCertificateApi.new
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
- # setup authorization
402
- UltracartClient.configure do |config|
403
- # Configure OAuth2 access token for authorization: ultraCartOauth
404
- config.access_token = 'YOUR ACCESS TOKEN'
405
-
406
- # Configure API key authorization: ultraCartSimpleApiKey
407
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
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
- api_instance = UltracartClient::GiftCertificateApi.new
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
- # setup authorization
476
- UltracartClient.configure do |config|
477
- # Configure OAuth2 access token for authorization: ultraCartOauth
478
- config.access_token = 'YOUR ACCESS TOKEN'
479
-
480
- # Configure API key authorization: ultraCartSimpleApiKey
481
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
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
- api_instance = UltracartClient::GiftCertificateApi.new
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
- # setup authorization
562
- UltracartClient.configure do |config|
563
- # Configure OAuth2 access token for authorization: ultraCartOauth
564
- config.access_token = 'YOUR ACCESS TOKEN'
565
-
566
- # Configure API key authorization: ultraCartSimpleApiKey
567
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
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
- api_instance = UltracartClient::GiftCertificateApi.new
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
 
@@ -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
- # setup authorization
28
- UltracartClient.configure do |config|
29
- # Configure OAuth2 access token for authorization: ultraCartOauth
30
- config.access_token = 'YOUR ACCESS TOKEN'
31
-
32
- # Configure API key authorization: ultraCartSimpleApiKey
33
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
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
- api_instance = UltracartClient::IntegrationLogApi.new
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
- # setup authorization
104
- UltracartClient.configure do |config|
105
- # Configure OAuth2 access token for authorization: ultraCartOauth
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
- api_instance = UltracartClient::IntegrationLogApi.new
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
- # setup authorization
182
- UltracartClient.configure do |config|
183
- # Configure OAuth2 access token for authorization: ultraCartOauth
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
- api_instance = UltracartClient::IntegrationLogApi.new
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
- # setup authorization
260
- UltracartClient.configure do |config|
261
- # Configure OAuth2 access token for authorization: ultraCartOauth
262
- config.access_token = 'YOUR ACCESS TOKEN'
263
-
264
- # Configure API key authorization: ultraCartSimpleApiKey
265
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
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
- api_instance = UltracartClient::IntegrationLogApi.new
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
- # setup authorization
334
- UltracartClient.configure do |config|
335
- # Configure OAuth2 access token for authorization: ultraCartOauth
336
- config.access_token = 'YOUR ACCESS TOKEN'
337
-
338
- # Configure API key authorization: ultraCartSimpleApiKey
339
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
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
- api_instance = UltracartClient::IntegrationLogApi.new
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)