ultracart_api 4.0.32.rc → 4.0.35.rc

Sign up to get free protection for your applications and to get access to all the features.
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
data/docs/UserApi.md CHANGED
@@ -30,18 +30,15 @@ Delete a group on the UltraCart account.
30
30
  ```ruby
31
31
  require 'time'
32
32
  require 'ultracart_api'
33
- # setup authorization
34
- UltracartClient.configure do |config|
35
- # Configure OAuth2 access token for authorization: ultraCartOauth
36
- config.access_token = 'YOUR ACCESS TOKEN'
37
-
38
- # Configure API key authorization: ultraCartSimpleApiKey
39
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
40
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
41
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
42
- end
33
+ require 'json'
34
+ require 'yaml'
35
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
36
+
37
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
38
+ # As such, this might not be the best way to use this object.
39
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
43
40
 
44
- api_instance = UltracartClient::UserApi.new
41
+ api = UltracartClient::UserApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
45
42
  group_oid = 56 # Integer | The group_oid to delete.
46
43
 
47
44
  begin
@@ -103,18 +100,15 @@ Delete a user on the UltraCart 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
116
106
 
117
- api_instance = UltracartClient::UserApi.new
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.
110
+
111
+ api = UltracartClient::UserApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
118
112
  user_id = 56 # Integer | The user_id to delete.
119
113
 
120
114
  begin
@@ -176,18 +170,15 @@ Retrieves a single group using the specified group id.
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::UserApi.new
181
+ api = UltracartClient::UserApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
191
182
  group_oid = 56 # Integer | The group id to retrieve.
192
183
 
193
184
  begin
@@ -247,18 +238,15 @@ Get groups
247
238
  ```ruby
248
239
  require 'time'
249
240
  require 'ultracart_api'
250
- # setup authorization
251
- UltracartClient.configure do |config|
252
- # Configure OAuth2 access token for authorization: ultraCartOauth
253
- config.access_token = 'YOUR ACCESS TOKEN'
254
-
255
- # Configure API key authorization: ultraCartSimpleApiKey
256
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
257
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
258
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
259
- end
241
+ require 'json'
242
+ require 'yaml'
243
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
244
+
245
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
246
+ # As such, this might not be the best way to use this object.
247
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
260
248
 
261
- api_instance = UltracartClient::UserApi.new
249
+ api = UltracartClient::UserApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
262
250
 
263
251
  begin
264
252
  # Get groups
@@ -318,18 +306,15 @@ Retrieves a single user using the specified user id.
318
306
  ```ruby
319
307
  require 'time'
320
308
  require 'ultracart_api'
321
- # setup authorization
322
- UltracartClient.configure do |config|
323
- # Configure OAuth2 access token for authorization: ultraCartOauth
324
- config.access_token = 'YOUR ACCESS TOKEN'
325
-
326
- # Configure API key authorization: ultraCartSimpleApiKey
327
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
328
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
329
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
330
- end
309
+ require 'json'
310
+ require 'yaml'
311
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
331
312
 
332
- api_instance = UltracartClient::UserApi.new
313
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
314
+ # As such, this might not be the best way to use this object.
315
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
316
+
317
+ api = UltracartClient::UserApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
333
318
  user_id = 56 # Integer | The user id to retrieve.
334
319
 
335
320
  begin
@@ -392,18 +377,15 @@ Retrieves logins for a single user using the specified user id.
392
377
  ```ruby
393
378
  require 'time'
394
379
  require 'ultracart_api'
395
- # setup authorization
396
- UltracartClient.configure do |config|
397
- # Configure OAuth2 access token for authorization: ultraCartOauth
398
- config.access_token = 'YOUR ACCESS TOKEN'
399
-
400
- # Configure API key authorization: ultraCartSimpleApiKey
401
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
402
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
403
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
404
- end
380
+ require 'json'
381
+ require 'yaml'
382
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
405
383
 
406
- api_instance = UltracartClient::UserApi.new
384
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
385
+ # As such, this might not be the best way to use this object.
386
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
387
+
388
+ api = UltracartClient::UserApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
407
389
  user_id = 56 # Integer | The user id to retrieve.
408
390
 
409
391
  begin
@@ -464,18 +446,15 @@ Get users
464
446
  ```ruby
465
447
  require 'time'
466
448
  require 'ultracart_api'
467
- # setup authorization
468
- UltracartClient.configure do |config|
469
- # Configure OAuth2 access token for authorization: ultraCartOauth
470
- config.access_token = 'YOUR ACCESS TOKEN'
471
-
472
- # Configure API key authorization: ultraCartSimpleApiKey
473
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
474
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
475
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
476
- end
449
+ require 'json'
450
+ require 'yaml'
451
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
452
+
453
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
454
+ # As such, this might not be the best way to use this object.
455
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
477
456
 
478
- api_instance = UltracartClient::UserApi.new
457
+ api = UltracartClient::UserApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
479
458
 
480
459
  begin
481
460
  # Get users
@@ -535,18 +514,15 @@ Insert a group on the UltraCart account.
535
514
  ```ruby
536
515
  require 'time'
537
516
  require 'ultracart_api'
538
- # setup authorization
539
- UltracartClient.configure do |config|
540
- # Configure OAuth2 access token for authorization: ultraCartOauth
541
- config.access_token = 'YOUR ACCESS TOKEN'
542
-
543
- # Configure API key authorization: ultraCartSimpleApiKey
544
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
545
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
546
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
547
- end
517
+ require 'json'
518
+ require 'yaml'
519
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
520
+
521
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
522
+ # As such, this might not be the best way to use this object.
523
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
548
524
 
549
- api_instance = UltracartClient::UserApi.new
525
+ api = UltracartClient::UserApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
550
526
  group = UltracartClient::Group.new # Group | Group to insert
551
527
 
552
528
  begin
@@ -609,18 +585,15 @@ Insert a user on the UltraCart account.
609
585
  ```ruby
610
586
  require 'time'
611
587
  require 'ultracart_api'
612
- # setup authorization
613
- UltracartClient.configure do |config|
614
- # Configure OAuth2 access token for authorization: ultraCartOauth
615
- config.access_token = 'YOUR ACCESS TOKEN'
616
-
617
- # Configure API key authorization: ultraCartSimpleApiKey
618
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
619
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
620
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
621
- end
588
+ require 'json'
589
+ require 'yaml'
590
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
622
591
 
623
- api_instance = UltracartClient::UserApi.new
592
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
593
+ # As such, this might not be the best way to use this object.
594
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
595
+
596
+ api = UltracartClient::UserApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
624
597
  user = UltracartClient::User.new # User | User to insert
625
598
 
626
599
  begin
@@ -683,18 +656,15 @@ Update a group on the UltraCart account.
683
656
  ```ruby
684
657
  require 'time'
685
658
  require 'ultracart_api'
686
- # setup authorization
687
- UltracartClient.configure do |config|
688
- # Configure OAuth2 access token for authorization: ultraCartOauth
689
- config.access_token = 'YOUR ACCESS TOKEN'
690
-
691
- # Configure API key authorization: ultraCartSimpleApiKey
692
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
693
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
694
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
695
- end
659
+ require 'json'
660
+ require 'yaml'
661
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
662
+
663
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
664
+ # As such, this might not be the best way to use this object.
665
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
696
666
 
697
- api_instance = UltracartClient::UserApi.new
667
+ api = UltracartClient::UserApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
698
668
  group_oid = 56 # Integer | The group_oid to update.
699
669
  group = UltracartClient::Group.new # Group | Group to update
700
670
 
@@ -759,18 +729,15 @@ Update a user on the UltraCart account.
759
729
  ```ruby
760
730
  require 'time'
761
731
  require 'ultracart_api'
762
- # setup authorization
763
- UltracartClient.configure do |config|
764
- # Configure OAuth2 access token for authorization: ultraCartOauth
765
- config.access_token = 'YOUR ACCESS TOKEN'
766
-
767
- # Configure API key authorization: ultraCartSimpleApiKey
768
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
769
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
770
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
771
- end
732
+ require 'json'
733
+ require 'yaml'
734
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
735
+
736
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
737
+ # As such, this might not be the best way to use this object.
738
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
772
739
 
773
- api_instance = UltracartClient::UserApi.new
740
+ api = UltracartClient::UserApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
774
741
  user_id = 56 # Integer | The user_id to update.
775
742
  user = UltracartClient::User.new # User | User to update
776
743
 
data/docs/WebhookApi.md CHANGED
@@ -27,18 +27,15 @@ Delete a webhook on the UltraCart account.
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::WebhookApi.new
38
+ api = UltracartClient::WebhookApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
42
39
  webhook_oid = 56 # Integer | The webhook oid to delete.
43
40
 
44
41
  begin
@@ -100,18 +97,15 @@ Delete a webhook based upon the URL on the webhook_url matching an existing webh
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
103
+
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.
113
107
 
114
- api_instance = UltracartClient::WebhookApi.new
108
+ api = UltracartClient::WebhookApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
115
109
  webhook = UltracartClient::Webhook.new # Webhook | Webhook to delete
116
110
 
117
111
  begin
@@ -174,18 +168,15 @@ Retrieves an individual log for a webhook given the webhook oid the request id.
174
168
  ```ruby
175
169
  require 'time'
176
170
  require 'ultracart_api'
177
- # setup authorization
178
- UltracartClient.configure do |config|
179
- # Configure OAuth2 access token for authorization: ultraCartOauth
180
- config.access_token = 'YOUR ACCESS TOKEN'
181
-
182
- # Configure API key authorization: ultraCartSimpleApiKey
183
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
184
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
185
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
186
- end
171
+ require 'json'
172
+ require 'yaml'
173
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
174
+
175
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
176
+ # As such, this might not be the best way to use this object.
177
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
187
178
 
188
- api_instance = UltracartClient::WebhookApi.new
179
+ api = UltracartClient::WebhookApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
189
180
  webhook_oid = 56 # Integer | The webhook oid that owns the log.
190
181
  request_id = 'request_id_example' # String | The request id associated with the log to view.
191
182
 
@@ -250,18 +241,15 @@ Retrieves the log summary information for a given webhook. This is useful for d
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::WebhookApi.new
252
+ api = UltracartClient::WebhookApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
265
253
  webhook_oid = 56 # Integer | The webhook oid to retrieve log summaries for.
266
254
  opts = {
267
255
  _limit: 56, # Integer | The maximum number of records to return on this one API call.
@@ -332,18 +320,15 @@ Retrieves the webhooks associated with this application.
332
320
  ```ruby
333
321
  require 'time'
334
322
  require 'ultracart_api'
335
- # setup authorization
336
- UltracartClient.configure do |config|
337
- # Configure OAuth2 access token for authorization: ultraCartOauth
338
- config.access_token = 'YOUR ACCESS TOKEN'
339
-
340
- # Configure API key authorization: ultraCartSimpleApiKey
341
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
342
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
343
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
344
- end
323
+ require 'json'
324
+ require 'yaml'
325
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
326
+
327
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
328
+ # As such, this might not be the best way to use this object.
329
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
345
330
 
346
- api_instance = UltracartClient::WebhookApi.new
331
+ api = UltracartClient::WebhookApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
347
332
  opts = {
348
333
  _limit: 56, # Integer | The maximum number of records to return on this one API call.
349
334
  _offset: 56, # Integer | Pagination of the record set. Offset is a zero based index.
@@ -414,18 +399,15 @@ Adds a new webhook on the account. If you add a new webhook with the authentica
414
399
  ```ruby
415
400
  require 'time'
416
401
  require 'ultracart_api'
417
- # setup authorization
418
- UltracartClient.configure do |config|
419
- # Configure OAuth2 access token for authorization: ultraCartOauth
420
- config.access_token = 'YOUR ACCESS TOKEN'
421
-
422
- # Configure API key authorization: ultraCartSimpleApiKey
423
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
424
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
425
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
426
- end
402
+ require 'json'
403
+ require 'yaml'
404
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
405
+
406
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
407
+ # As such, this might not be the best way to use this object.
408
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
427
409
 
428
- api_instance = UltracartClient::WebhookApi.new
410
+ api = UltracartClient::WebhookApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
429
411
  webhook = UltracartClient::Webhook.new # Webhook | Webhook to create
430
412
  opts = {
431
413
  _placeholders: true # Boolean | Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
@@ -492,18 +474,15 @@ This method will resend events to the webhook endpoint. This method can be used
492
474
  ```ruby
493
475
  require 'time'
494
476
  require 'ultracart_api'
495
- # setup authorization
496
- UltracartClient.configure do |config|
497
- # Configure OAuth2 access token for authorization: ultraCartOauth
498
- config.access_token = 'YOUR ACCESS TOKEN'
499
-
500
- # Configure API key authorization: ultraCartSimpleApiKey
501
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
502
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
503
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
504
- end
477
+ require 'json'
478
+ require 'yaml'
479
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
480
+
481
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
482
+ # As such, this might not be the best way to use this object.
483
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
505
484
 
506
- api_instance = UltracartClient::WebhookApi.new
485
+ api = UltracartClient::WebhookApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
507
486
  webhook_oid = 56 # Integer | The webhook oid that is receiving the reflowed events.
508
487
  event_name = 'event_name_example' # String | The event to reflow.
509
488
 
@@ -568,18 +547,15 @@ Update a webhook on the account
568
547
  ```ruby
569
548
  require 'time'
570
549
  require 'ultracart_api'
571
- # setup authorization
572
- UltracartClient.configure do |config|
573
- # Configure OAuth2 access token for authorization: ultraCartOauth
574
- config.access_token = 'YOUR ACCESS TOKEN'
575
-
576
- # Configure API key authorization: ultraCartSimpleApiKey
577
- config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
578
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
579
- # config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
580
- end
550
+ require 'json'
551
+ require 'yaml'
552
+ require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
553
+
554
+ # This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
555
+ # As such, this might not be the best way to use this object.
556
+ # Please see https://github.com/UltraCart/sdk_samples for working examples.
581
557
 
582
- api_instance = UltracartClient::WebhookApi.new
558
+ api = UltracartClient::WebhookApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
583
559
  webhook_oid = 56 # Integer | The webhook oid to update.
584
560
  webhook = UltracartClient::Webhook.new # Webhook | Webhook to update
585
561
  opts = {