ultracart_api 3.0.76 → 3.1.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (32) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +7 -13
  3. data/docs/AffiliateApi.md +8 -22
  4. data/docs/AutoOrderApi.md +32 -88
  5. data/docs/ChargebackApi.md +20 -55
  6. data/docs/CheckoutApi.md +77 -294
  7. data/docs/CouponApi.md +78 -209
  8. data/docs/CustomerApi.md +42 -110
  9. data/docs/FulfillmentApi.md +21 -55
  10. data/docs/ItemApi.md +36 -99
  11. data/docs/OauthApi.md +8 -32
  12. data/docs/OrderApi.md +81 -220
  13. data/docs/StorefrontApi.md +429 -2077
  14. data/docs/TaxApi.md +121 -308
  15. data/docs/UserApi.md +46 -121
  16. data/docs/WebhookApi.md +32 -88
  17. data/lib/ultracart_api/api/affiliate_api.rb +13 -0
  18. data/lib/ultracart_api/api/auto_order_api.rb +13 -0
  19. data/lib/ultracart_api/api/chargeback_api.rb +13 -0
  20. data/lib/ultracart_api/api/checkout_api.rb +13 -0
  21. data/lib/ultracart_api/api/coupon_api.rb +13 -0
  22. data/lib/ultracart_api/api/customer_api.rb +13 -0
  23. data/lib/ultracart_api/api/fulfillment_api.rb +13 -0
  24. data/lib/ultracart_api/api/item_api.rb +13 -0
  25. data/lib/ultracart_api/api/oauth_api.rb +13 -0
  26. data/lib/ultracart_api/api/order_api.rb +13 -0
  27. data/lib/ultracart_api/api/storefront_api.rb +13 -0
  28. data/lib/ultracart_api/api/tax_api.rb +13 -0
  29. data/lib/ultracart_api/api/user_api.rb +13 -0
  30. data/lib/ultracart_api/api/webhook_api.rb +13 -0
  31. data/lib/ultracart_api/version.rb +1 -1
  32. metadata +2 -2
data/docs/CouponApi.md CHANGED
@@ -36,18 +36,11 @@ Delete a coupon on the UltraCart account.
36
36
  ```ruby
37
37
  # load the gem
38
38
  require 'ultracart_api'
39
- # setup authorization
40
- UltracartClient.configure do |config|
41
- # Configure OAuth2 access token for authorization: ultraCartOauth
42
- config.access_token = 'YOUR ACCESS TOKEN'
43
-
44
- # Configure API key authorization: ultraCartSimpleApiKey
45
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
46
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
47
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
48
- end
49
39
 
50
- api_instance = UltracartClient::CouponApi.new
40
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
41
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
42
+ api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
43
+
51
44
 
52
45
  coupon_oid = 56 # Integer | The coupon_oid to delete.
53
46
 
@@ -92,18 +85,11 @@ Delete coupons on the UltraCart account.
92
85
  ```ruby
93
86
  # load the gem
94
87
  require 'ultracart_api'
95
- # setup authorization
96
- UltracartClient.configure do |config|
97
- # Configure OAuth2 access token for authorization: ultraCartOauth
98
- config.access_token = 'YOUR ACCESS TOKEN'
99
-
100
- # Configure API key authorization: ultraCartSimpleApiKey
101
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
102
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
103
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
104
- end
105
88
 
106
- api_instance = UltracartClient::CouponApi.new
89
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
90
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
91
+ api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
92
+
107
93
 
108
94
  coupon_delete_request = UltracartClient::CouponDeletesRequest.new # CouponDeletesRequest | Coupon oids to delete
109
95
 
@@ -148,18 +134,11 @@ Delete coupons on the UltraCart account.
148
134
  ```ruby
149
135
  # load the gem
150
136
  require 'ultracart_api'
151
- # setup authorization
152
- UltracartClient.configure do |config|
153
- # Configure OAuth2 access token for authorization: ultraCartOauth
154
- config.access_token = 'YOUR ACCESS TOKEN'
155
-
156
- # Configure API key authorization: ultraCartSimpleApiKey
157
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
158
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
159
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
160
- end
161
137
 
162
- api_instance = UltracartClient::CouponApi.new
138
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
139
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
140
+ api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
141
+
163
142
 
164
143
  coupon_delete_request = UltracartClient::CouponDeletesRequest.new # CouponDeletesRequest | Coupon oids to delete
165
144
 
@@ -204,18 +183,11 @@ Determines if a coupon merchant code already exists.
204
183
  ```ruby
205
184
  # load the gem
206
185
  require 'ultracart_api'
207
- # setup authorization
208
- UltracartClient.configure do |config|
209
- # Configure OAuth2 access token for authorization: ultraCartOauth
210
- config.access_token = 'YOUR ACCESS TOKEN'
211
-
212
- # Configure API key authorization: ultraCartSimpleApiKey
213
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
214
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
215
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
216
- end
217
186
 
218
- api_instance = UltracartClient::CouponApi.new
187
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
188
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
189
+ api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
190
+
219
191
 
220
192
  merchant_code = 'merchant_code_example' # String | The coupon merchant code to examine.
221
193
 
@@ -261,18 +233,11 @@ Generate one time codes for a coupon
261
233
  ```ruby
262
234
  # load the gem
263
235
  require 'ultracart_api'
264
- # setup authorization
265
- UltracartClient.configure do |config|
266
- # Configure OAuth2 access token for authorization: ultraCartOauth
267
- config.access_token = 'YOUR ACCESS TOKEN'
268
-
269
- # Configure API key authorization: ultraCartSimpleApiKey
270
- config.api_key['x-ultracart-simple-key'] = '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['x-ultracart-simple-key'] = 'Bearer'
273
- end
274
236
 
275
- api_instance = UltracartClient::CouponApi.new
237
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
238
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
239
+ api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
240
+
276
241
 
277
242
  coupon_oid = 56 # Integer | The coupon oid to generate codes.
278
243
 
@@ -321,18 +286,11 @@ Generate one time codes by merchant code
321
286
  ```ruby
322
287
  # load the gem
323
288
  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['x-ultracart-simple-key'] = '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['x-ultracart-simple-key'] = 'Bearer'
333
- end
334
289
 
335
- api_instance = UltracartClient::CouponApi.new
290
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
291
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
292
+ api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
293
+
336
294
 
337
295
  merchant_code = 'merchant_code_example' # String | The merchant code to generate one time codes.
338
296
 
@@ -381,18 +339,12 @@ Retrieve auto apply rules and conditions
381
339
  ```ruby
382
340
  # load the gem
383
341
  require 'ultracart_api'
384
- # setup authorization
385
- UltracartClient.configure do |config|
386
- # Configure OAuth2 access token for authorization: ultraCartOauth
387
- config.access_token = 'YOUR ACCESS TOKEN'
388
-
389
- # Configure API key authorization: ultraCartSimpleApiKey
390
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
391
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
392
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
393
- end
394
342
 
395
- api_instance = UltracartClient::CouponApi.new
343
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
344
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
345
+ api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
346
+
347
+
396
348
 
397
349
  begin
398
350
  #Retrieve auto apply rules and conditions
@@ -432,18 +384,11 @@ Retrieves a single coupon using the specified coupon profile oid.
432
384
  ```ruby
433
385
  # load the gem
434
386
  require 'ultracart_api'
435
- # setup authorization
436
- UltracartClient.configure do |config|
437
- # Configure OAuth2 access token for authorization: ultraCartOauth
438
- config.access_token = 'YOUR ACCESS TOKEN'
439
-
440
- # Configure API key authorization: ultraCartSimpleApiKey
441
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
442
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
443
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
444
- end
445
387
 
446
- api_instance = UltracartClient::CouponApi.new
388
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
389
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
390
+ api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
391
+
447
392
 
448
393
  coupon_oid = 56 # Integer | The coupon oid to retrieve.
449
394
 
@@ -493,18 +438,11 @@ Retrieves a single coupon using the specified merchant code.
493
438
  ```ruby
494
439
  # load the gem
495
440
  require 'ultracart_api'
496
- # setup authorization
497
- UltracartClient.configure do |config|
498
- # Configure OAuth2 access token for authorization: ultraCartOauth
499
- config.access_token = 'YOUR ACCESS TOKEN'
500
-
501
- # Configure API key authorization: ultraCartSimpleApiKey
502
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
503
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
504
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
505
- end
506
441
 
507
- api_instance = UltracartClient::CouponApi.new
442
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
443
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
444
+ api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
445
+
508
446
 
509
447
  merchant_code = 'merchant_code_example' # String | The coupon merchant code to retrieve.
510
448
 
@@ -554,18 +492,11 @@ Retrieves coupons for this account. If no parameters are specified, all coupons
554
492
  ```ruby
555
493
  # load the gem
556
494
  require 'ultracart_api'
557
- # setup authorization
558
- UltracartClient.configure do |config|
559
- # Configure OAuth2 access token for authorization: ultraCartOauth
560
- config.access_token = 'YOUR ACCESS TOKEN'
561
-
562
- # Configure API key authorization: ultraCartSimpleApiKey
563
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
564
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
565
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
566
- end
567
495
 
568
- api_instance = UltracartClient::CouponApi.new
496
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
497
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
498
+ api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
499
+
569
500
 
570
501
  opts = {
571
502
  merchant_code: 'merchant_code_example', # String | Merchant code
@@ -636,18 +567,11 @@ Retrieves coupons from the account. If no parameters are specified, all coupons
636
567
  ```ruby
637
568
  # load the gem
638
569
  require 'ultracart_api'
639
- # setup authorization
640
- UltracartClient.configure do |config|
641
- # Configure OAuth2 access token for authorization: ultraCartOauth
642
- config.access_token = 'YOUR ACCESS TOKEN'
643
-
644
- # Configure API key authorization: ultraCartSimpleApiKey
645
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
646
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
647
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
648
- end
649
570
 
650
- api_instance = UltracartClient::CouponApi.new
571
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
572
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
573
+ api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
574
+
651
575
 
652
576
  coupon_query = UltracartClient::CouponQuery.new # CouponQuery | Coupon query
653
577
 
@@ -703,18 +627,12 @@ Retrieve values needed for a coupon editor
703
627
  ```ruby
704
628
  # load the gem
705
629
  require 'ultracart_api'
706
- # setup authorization
707
- UltracartClient.configure do |config|
708
- # Configure OAuth2 access token for authorization: ultraCartOauth
709
- config.access_token = 'YOUR ACCESS TOKEN'
710
-
711
- # Configure API key authorization: ultraCartSimpleApiKey
712
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
713
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
714
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
715
- end
716
630
 
717
- api_instance = UltracartClient::CouponApi.new
631
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
632
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
633
+ api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
634
+
635
+
718
636
 
719
637
  begin
720
638
  #Retrieve values needed for a coupon editor
@@ -754,18 +672,11 @@ Insert a coupon on the UltraCart account.
754
672
  ```ruby
755
673
  # load the gem
756
674
  require 'ultracart_api'
757
- # setup authorization
758
- UltracartClient.configure do |config|
759
- # Configure OAuth2 access token for authorization: ultraCartOauth
760
- config.access_token = 'YOUR ACCESS TOKEN'
761
-
762
- # Configure API key authorization: ultraCartSimpleApiKey
763
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
764
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
765
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
766
- end
767
675
 
768
- api_instance = UltracartClient::CouponApi.new
676
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
677
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
678
+ api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
679
+
769
680
 
770
681
  coupon = UltracartClient::Coupon.new # Coupon | Coupon to insert
771
682
 
@@ -815,18 +726,11 @@ Insert multiple coupon on the UltraCart account.
815
726
  ```ruby
816
727
  # load the gem
817
728
  require 'ultracart_api'
818
- # setup authorization
819
- UltracartClient.configure do |config|
820
- # Configure OAuth2 access token for authorization: ultraCartOauth
821
- config.access_token = 'YOUR ACCESS TOKEN'
822
-
823
- # Configure API key authorization: ultraCartSimpleApiKey
824
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
825
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
826
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
827
- end
828
729
 
829
- api_instance = UltracartClient::CouponApi.new
730
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
731
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
732
+ api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
733
+
830
734
 
831
735
  coupons_request = UltracartClient::CouponsRequest.new # CouponsRequest | Coupons to insert (maximum 20)
832
736
 
@@ -878,18 +782,11 @@ Searches for items to display within a coupon editor and assign to coupons
878
782
  ```ruby
879
783
  # load the gem
880
784
  require 'ultracart_api'
881
- # setup authorization
882
- UltracartClient.configure do |config|
883
- # Configure OAuth2 access token for authorization: ultraCartOauth
884
- config.access_token = 'YOUR ACCESS TOKEN'
885
-
886
- # Configure API key authorization: ultraCartSimpleApiKey
887
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
888
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
889
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
890
- end
891
785
 
892
- api_instance = UltracartClient::CouponApi.new
786
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
787
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
788
+ api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
789
+
893
790
 
894
791
  opts = {
895
792
  s: 's_example', # String |
@@ -938,18 +835,11 @@ Update auto apply rules and conditions
938
835
  ```ruby
939
836
  # load the gem
940
837
  require 'ultracart_api'
941
- # setup authorization
942
- UltracartClient.configure do |config|
943
- # Configure OAuth2 access token for authorization: ultraCartOauth
944
- config.access_token = 'YOUR ACCESS TOKEN'
945
-
946
- # Configure API key authorization: ultraCartSimpleApiKey
947
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
948
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
949
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
950
- end
951
838
 
952
- api_instance = UltracartClient::CouponApi.new
839
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
840
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
841
+ api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
842
+
953
843
 
954
844
  conditions = UltracartClient::CouponAutoApplyConditions.new # CouponAutoApplyConditions | Conditions
955
845
 
@@ -994,18 +884,11 @@ Update a coupon on the UltraCart account.
994
884
  ```ruby
995
885
  # load the gem
996
886
  require 'ultracart_api'
997
- # setup authorization
998
- UltracartClient.configure do |config|
999
- # Configure OAuth2 access token for authorization: ultraCartOauth
1000
- config.access_token = 'YOUR ACCESS TOKEN'
1001
-
1002
- # Configure API key authorization: ultraCartSimpleApiKey
1003
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
1004
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1005
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
1006
- end
1007
887
 
1008
- api_instance = UltracartClient::CouponApi.new
888
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
889
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
890
+ api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
891
+
1009
892
 
1010
893
  coupon = UltracartClient::Coupon.new # Coupon | Coupon to update
1011
894
 
@@ -1058,18 +941,11 @@ Update multiple coupon on the UltraCart account.
1058
941
  ```ruby
1059
942
  # load the gem
1060
943
  require 'ultracart_api'
1061
- # setup authorization
1062
- UltracartClient.configure do |config|
1063
- # Configure OAuth2 access token for authorization: ultraCartOauth
1064
- config.access_token = 'YOUR ACCESS TOKEN'
1065
-
1066
- # Configure API key authorization: ultraCartSimpleApiKey
1067
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
1068
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1069
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
1070
- end
1071
944
 
1072
- api_instance = UltracartClient::CouponApi.new
945
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
946
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
947
+ api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
948
+
1073
949
 
1074
950
  coupons_request = UltracartClient::CouponsRequest.new # CouponsRequest | Coupons to update (synchronous maximum 20 / asynchronous maximum 100)
1075
951
 
@@ -1123,18 +999,11 @@ Upload one-time codes for a coupon
1123
999
  ```ruby
1124
1000
  # load the gem
1125
1001
  require 'ultracart_api'
1126
- # setup authorization
1127
- UltracartClient.configure do |config|
1128
- # Configure OAuth2 access token for authorization: ultraCartOauth
1129
- config.access_token = 'YOUR ACCESS TOKEN'
1130
-
1131
- # Configure API key authorization: ultraCartSimpleApiKey
1132
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
1133
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
1134
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
1135
- end
1136
1002
 
1137
- api_instance = UltracartClient::CouponApi.new
1003
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
1004
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
1005
+ api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
1006
+
1138
1007
 
1139
1008
  coupon_oid = 56 # Integer | The coupon oid to associate with the provided one-time codes.
1140
1009
 
data/docs/CustomerApi.md CHANGED
@@ -27,18 +27,11 @@ Delete a customer on the UltraCart account.
27
27
  ```ruby
28
28
  # load the gem
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['x-ultracart-simple-key'] = '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['x-ultracart-simple-key'] = 'Bearer'
39
- end
40
30
 
41
- api_instance = UltracartClient::CustomerApi.new
31
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
32
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
33
+ api_instance = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
34
+
42
35
 
43
36
  customer_profile_oid = 56 # Integer | The customer_profile_oid to delete.
44
37
 
@@ -84,18 +77,11 @@ Retrieves a single customer using the specified customer profile oid.
84
77
  ```ruby
85
78
  # load the gem
86
79
  require 'ultracart_api'
87
- # setup authorization
88
- UltracartClient.configure do |config|
89
- # Configure OAuth2 access token for authorization: ultraCartOauth
90
- config.access_token = 'YOUR ACCESS TOKEN'
91
-
92
- # Configure API key authorization: ultraCartSimpleApiKey
93
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
94
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
95
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
96
- end
97
80
 
98
- api_instance = UltracartClient::CustomerApi.new
81
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
82
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
83
+ api_instance = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
84
+
99
85
 
100
86
  customer_profile_oid = 56 # Integer | The customer oid to retrieve.
101
87
 
@@ -145,18 +131,11 @@ Retrieves customers from the account. If no parameters are specified, all custo
145
131
  ```ruby
146
132
  # load the gem
147
133
  require 'ultracart_api'
148
- # setup authorization
149
- UltracartClient.configure do |config|
150
- # Configure OAuth2 access token for authorization: ultraCartOauth
151
- config.access_token = 'YOUR ACCESS TOKEN'
152
-
153
- # Configure API key authorization: ultraCartSimpleApiKey
154
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
155
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
156
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
157
- end
158
134
 
159
- api_instance = UltracartClient::CustomerApi.new
135
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
136
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
137
+ api_instance = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
138
+
160
139
 
161
140
  opts = {
162
141
  email: 'email_example', # String | Email
@@ -265,18 +244,11 @@ Retrieves customers from the account. If no parameters are specified, all custo
265
244
  ```ruby
266
245
  # load the gem
267
246
  require 'ultracart_api'
268
- # setup authorization
269
- UltracartClient.configure do |config|
270
- # Configure OAuth2 access token for authorization: ultraCartOauth
271
- config.access_token = 'YOUR ACCESS TOKEN'
272
-
273
- # Configure API key authorization: ultraCartSimpleApiKey
274
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
275
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
276
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
277
- end
278
247
 
279
- api_instance = UltracartClient::CustomerApi.new
248
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
249
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
250
+ api_instance = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
251
+
280
252
 
281
253
  customer_query = UltracartClient::CustomerQuery.new # CustomerQuery | Customer query
282
254
 
@@ -334,18 +306,11 @@ Retrieves customers from the account. If no searches are specified, all custome
334
306
  ```ruby
335
307
  # load the gem
336
308
  require 'ultracart_api'
337
- # setup authorization
338
- UltracartClient.configure do |config|
339
- # Configure OAuth2 access token for authorization: ultraCartOauth
340
- config.access_token = 'YOUR ACCESS TOKEN'
341
-
342
- # Configure API key authorization: ultraCartSimpleApiKey
343
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
344
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
345
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
346
- end
347
309
 
348
- api_instance = UltracartClient::CustomerApi.new
310
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
311
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
312
+ api_instance = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
313
+
349
314
 
350
315
  opts = {
351
316
  _expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
@@ -392,18 +357,12 @@ Retrieve values needed for a customer profile editor.
392
357
  ```ruby
393
358
  # load the gem
394
359
  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['x-ultracart-simple-key'] = '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['x-ultracart-simple-key'] = 'Bearer'
404
- end
405
360
 
406
- api_instance = UltracartClient::CustomerApi.new
361
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
362
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
363
+ api_instance = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
364
+
365
+
407
366
 
408
367
  begin
409
368
  #Retrieve values needed for a customer profile editor
@@ -443,18 +402,12 @@ Retrieve all email lists across all storefronts
443
402
  ```ruby
444
403
  # load the gem
445
404
  require 'ultracart_api'
446
- # setup authorization
447
- UltracartClient.configure do |config|
448
- # Configure OAuth2 access token for authorization: ultraCartOauth
449
- config.access_token = 'YOUR ACCESS TOKEN'
450
-
451
- # Configure API key authorization: ultraCartSimpleApiKey
452
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
453
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
454
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
455
- end
456
405
 
457
- api_instance = UltracartClient::CustomerApi.new
406
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
407
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
408
+ api_instance = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
409
+
410
+
458
411
 
459
412
  begin
460
413
  #Retrieve all email lists across all storefronts
@@ -494,18 +447,11 @@ Insert a customer on the UltraCart account.
494
447
  ```ruby
495
448
  # load the gem
496
449
  require 'ultracart_api'
497
- # setup authorization
498
- UltracartClient.configure do |config|
499
- # Configure OAuth2 access token for authorization: ultraCartOauth
500
- config.access_token = 'YOUR ACCESS TOKEN'
501
-
502
- # Configure API key authorization: ultraCartSimpleApiKey
503
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
504
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
505
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
506
- end
507
450
 
508
- api_instance = UltracartClient::CustomerApi.new
451
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
452
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
453
+ api_instance = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
454
+
509
455
 
510
456
  customer = UltracartClient::Customer.new # Customer | Customer to insert
511
457
 
@@ -555,18 +501,11 @@ Update a customer on the UltraCart account.
555
501
  ```ruby
556
502
  # load the gem
557
503
  require 'ultracart_api'
558
- # setup authorization
559
- UltracartClient.configure do |config|
560
- # Configure OAuth2 access token for authorization: ultraCartOauth
561
- config.access_token = 'YOUR ACCESS TOKEN'
562
-
563
- # Configure API key authorization: ultraCartSimpleApiKey
564
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
565
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
566
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
567
- end
568
504
 
569
- api_instance = UltracartClient::CustomerApi.new
505
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
506
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
507
+ api_instance = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
508
+
570
509
 
571
510
  customer = UltracartClient::Customer.new # Customer | Customer to update
572
511
 
@@ -619,18 +558,11 @@ Update email list subscriptions for a customer
619
558
  ```ruby
620
559
  # load the gem
621
560
  require 'ultracart_api'
622
- # setup authorization
623
- UltracartClient.configure do |config|
624
- # Configure OAuth2 access token for authorization: ultraCartOauth
625
- config.access_token = 'YOUR ACCESS TOKEN'
626
-
627
- # Configure API key authorization: ultraCartSimpleApiKey
628
- config.api_key['x-ultracart-simple-key'] = 'YOUR API KEY'
629
- # Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
630
- #config.api_key_prefix['x-ultracart-simple-key'] = 'Bearer'
631
- end
632
561
 
633
- api_instance = UltracartClient::CustomerApi.new
562
+ # Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
563
+ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
564
+ api_instance = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
565
+
634
566
 
635
567
  customer_profile_oid = 56 # Integer | The customer profile oid
636
568