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.
- checksums.yaml +4 -4
- data/README.md +25 -4
- data/docs/Activity.md +4 -0
- data/docs/AffiliateApi.md +16 -22
- data/docs/AutoOrderApi.md +64 -88
- data/docs/ChannelPartnerApi.md +40 -55
- data/docs/ChargebackApi.md +40 -55
- data/docs/CheckoutApi.md +152 -294
- data/docs/Conversation.md +26 -0
- data/docs/ConversationAgentAuthResponse.md +22 -0
- data/docs/ConversationApi.md +438 -0
- data/docs/ConversationMessage.md +26 -0
- data/docs/ConversationParticipant.md +30 -0
- data/docs/ConversationStartRequest.md +20 -0
- data/docs/ConversationStartResponse.md +20 -0
- data/docs/ConversationSummary.md +34 -0
- data/docs/ConversationsResponse.md +26 -0
- data/docs/CouponApi.md +152 -209
- data/docs/CustomerActivity.md +9 -1
- data/docs/CustomerApi.md +213 -192
- data/docs/CustomerMergeRequest.md +20 -0
- data/docs/FulfillmentApi.md +48 -66
- data/docs/GiftCertificateApi.md +64 -88
- data/docs/IntegrationLogApi.md +40 -55
- data/docs/ItemApi.md +72 -99
- data/docs/OauthApi.md +16 -32
- data/docs/OrderApi.md +184 -253
- data/docs/SsoApi.md +32 -44
- data/docs/StorefrontApi.md +1134 -2345
- data/docs/TaxApi.md +224 -308
- data/docs/UserApi.md +88 -121
- data/docs/WebhookApi.md +64 -88
- data/lib/ultracart_api/api/conversation_api.rb +418 -0
- data/lib/ultracart_api/api/customer_api.rb +78 -0
- data/lib/ultracart_api/models/activity.rb +19 -1
- data/lib/ultracart_api/models/conversation.rb +259 -0
- data/lib/ultracart_api/models/conversation_agent_auth_response.rb +237 -0
- data/lib/ultracart_api/models/conversation_message.rb +258 -0
- data/lib/ultracart_api/models/conversation_participant.rb +276 -0
- data/lib/ultracart_api/models/conversation_start_request.rb +230 -0
- data/lib/ultracart_api/models/conversation_start_response.rb +228 -0
- data/lib/ultracart_api/models/conversation_summary.rb +292 -0
- data/lib/ultracart_api/models/conversations_response.rb +258 -0
- data/lib/ultracart_api/models/customer_activity.rb +40 -4
- data/lib/ultracart_api/models/customer_merge_request.rb +230 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +10 -0
- metadata +22 -2
data/docs/CouponApi.md
CHANGED
@@ -38,18 +38,15 @@ Delete a coupon on the UltraCart account.
|
|
38
38
|
```ruby
|
39
39
|
require 'time'
|
40
40
|
require 'ultracart_api'
|
41
|
-
|
42
|
-
|
43
|
-
|
44
|
-
|
45
|
-
|
46
|
-
|
47
|
-
|
48
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
49
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
50
|
-
end
|
41
|
+
require 'json'
|
42
|
+
require 'yaml'
|
43
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
44
|
+
|
45
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
46
|
+
# As such, this might not be the best way to use this object.
|
47
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
51
48
|
|
52
|
-
|
49
|
+
api = UltracartClient::CouponApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
53
50
|
coupon_oid = 56 # Integer | The coupon_oid to delete.
|
54
51
|
|
55
52
|
begin
|
@@ -111,18 +108,15 @@ Delete coupons on the UltraCart account.
|
|
111
108
|
```ruby
|
112
109
|
require 'time'
|
113
110
|
require 'ultracart_api'
|
114
|
-
|
115
|
-
|
116
|
-
|
117
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
118
|
-
|
119
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
120
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
121
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
122
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
123
|
-
end
|
111
|
+
require 'json'
|
112
|
+
require 'yaml'
|
113
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
124
114
|
|
125
|
-
|
115
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
116
|
+
# As such, this might not be the best way to use this object.
|
117
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
118
|
+
|
119
|
+
api = UltracartClient::CouponApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
126
120
|
coupon_delete_request = UltracartClient::CouponDeletesRequest.new # CouponDeletesRequest | Coupon oids to delete
|
127
121
|
|
128
122
|
begin
|
@@ -184,18 +178,15 @@ Delete coupons on the UltraCart account.
|
|
184
178
|
```ruby
|
185
179
|
require 'time'
|
186
180
|
require 'ultracart_api'
|
187
|
-
|
188
|
-
|
189
|
-
|
190
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
191
|
-
|
192
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
193
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
194
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
195
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
196
|
-
end
|
181
|
+
require 'json'
|
182
|
+
require 'yaml'
|
183
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
197
184
|
|
198
|
-
|
185
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
186
|
+
# As such, this might not be the best way to use this object.
|
187
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
188
|
+
|
189
|
+
api = UltracartClient::CouponApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
199
190
|
coupon_delete_request = UltracartClient::CouponDeletesRequest.new # CouponDeletesRequest | Coupon oids to delete
|
200
191
|
|
201
192
|
begin
|
@@ -257,18 +248,15 @@ Determines if a coupon merchant code already exists.
|
|
257
248
|
```ruby
|
258
249
|
require 'time'
|
259
250
|
require 'ultracart_api'
|
260
|
-
|
261
|
-
|
262
|
-
|
263
|
-
|
264
|
-
|
265
|
-
|
266
|
-
|
267
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
268
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
269
|
-
end
|
251
|
+
require 'json'
|
252
|
+
require 'yaml'
|
253
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
254
|
+
|
255
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
256
|
+
# As such, this might not be the best way to use this object.
|
257
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
270
258
|
|
271
|
-
|
259
|
+
api = UltracartClient::CouponApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
272
260
|
merchant_code = 'merchant_code_example' # String | The coupon merchant code to examine.
|
273
261
|
|
274
262
|
begin
|
@@ -331,18 +319,15 @@ Generate one time codes for a coupon
|
|
331
319
|
```ruby
|
332
320
|
require 'time'
|
333
321
|
require 'ultracart_api'
|
334
|
-
|
335
|
-
|
336
|
-
|
337
|
-
|
338
|
-
|
339
|
-
|
340
|
-
|
341
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
342
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
343
|
-
end
|
322
|
+
require 'json'
|
323
|
+
require 'yaml'
|
324
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
325
|
+
|
326
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
327
|
+
# As such, this might not be the best way to use this object.
|
328
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
344
329
|
|
345
|
-
|
330
|
+
api = UltracartClient::CouponApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
346
331
|
coupon_oid = 56 # Integer | The coupon oid to generate codes.
|
347
332
|
coupon_codes_request = UltracartClient::CouponCodesRequest.new # CouponCodesRequest | Coupon code generation parameters
|
348
333
|
|
@@ -407,18 +392,15 @@ Generate one time codes by merchant code
|
|
407
392
|
```ruby
|
408
393
|
require 'time'
|
409
394
|
require 'ultracart_api'
|
410
|
-
|
411
|
-
|
412
|
-
|
413
|
-
|
414
|
-
|
415
|
-
|
416
|
-
|
417
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
418
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
419
|
-
end
|
395
|
+
require 'json'
|
396
|
+
require 'yaml'
|
397
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
398
|
+
|
399
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
400
|
+
# As such, this might not be the best way to use this object.
|
401
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
420
402
|
|
421
|
-
|
403
|
+
api = UltracartClient::CouponApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
422
404
|
merchant_code = 'merchant_code_example' # String | The merchant code to generate one time codes.
|
423
405
|
coupon_codes_request = UltracartClient::CouponCodesRequest.new # CouponCodesRequest | Coupon code generation parameters
|
424
406
|
|
@@ -483,18 +465,15 @@ Retrieve auto apply rules and conditions
|
|
483
465
|
```ruby
|
484
466
|
require 'time'
|
485
467
|
require 'ultracart_api'
|
486
|
-
|
487
|
-
|
488
|
-
|
489
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
490
|
-
|
491
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
492
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
493
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
494
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
495
|
-
end
|
468
|
+
require 'json'
|
469
|
+
require 'yaml'
|
470
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
496
471
|
|
497
|
-
|
472
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
473
|
+
# As such, this might not be the best way to use this object.
|
474
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
475
|
+
|
476
|
+
api = UltracartClient::CouponApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
498
477
|
|
499
478
|
begin
|
500
479
|
# Retrieve auto apply rules and conditions
|
@@ -554,18 +533,15 @@ Retrieves a single coupon using the specified coupon profile oid.
|
|
554
533
|
```ruby
|
555
534
|
require 'time'
|
556
535
|
require 'ultracart_api'
|
557
|
-
|
558
|
-
|
559
|
-
|
560
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
561
|
-
|
562
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
563
|
-
config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
|
566
|
-
end
|
536
|
+
require 'json'
|
537
|
+
require 'yaml'
|
538
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
567
539
|
|
568
|
-
|
540
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
541
|
+
# As such, this might not be the best way to use this object.
|
542
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
543
|
+
|
544
|
+
api = UltracartClient::CouponApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
569
545
|
coupon_oid = 56 # Integer | The coupon oid to retrieve.
|
570
546
|
opts = {
|
571
547
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
@@ -632,18 +608,15 @@ Retrieves a single coupon using the specified merchant code.
|
|
632
608
|
```ruby
|
633
609
|
require 'time'
|
634
610
|
require 'ultracart_api'
|
635
|
-
|
636
|
-
|
637
|
-
|
638
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
639
|
-
|
640
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
641
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
642
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
643
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
644
|
-
end
|
611
|
+
require 'json'
|
612
|
+
require 'yaml'
|
613
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
645
614
|
|
646
|
-
|
615
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
616
|
+
# As such, this might not be the best way to use this object.
|
617
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
618
|
+
|
619
|
+
api = UltracartClient::CouponApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
647
620
|
merchant_code = 'merchant_code_example' # String | The coupon merchant code to retrieve.
|
648
621
|
opts = {
|
649
622
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
@@ -710,18 +683,15 @@ Retrieves coupons for this account. If no parameters are specified, all coupons
|
|
710
683
|
```ruby
|
711
684
|
require 'time'
|
712
685
|
require 'ultracart_api'
|
713
|
-
|
714
|
-
|
715
|
-
|
716
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
717
|
-
|
718
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
719
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
720
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
721
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
722
|
-
end
|
686
|
+
require 'json'
|
687
|
+
require 'yaml'
|
688
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
723
689
|
|
724
|
-
|
690
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
691
|
+
# As such, this might not be the best way to use this object.
|
692
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
693
|
+
|
694
|
+
api = UltracartClient::CouponApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
725
695
|
opts = {
|
726
696
|
merchant_code: 'merchant_code_example', # String | Merchant code
|
727
697
|
description: 'description_example', # String | Description
|
@@ -810,18 +780,15 @@ Retrieves coupons from the account. If no parameters are specified, all coupons
|
|
810
780
|
```ruby
|
811
781
|
require 'time'
|
812
782
|
require 'ultracart_api'
|
813
|
-
|
814
|
-
|
815
|
-
|
816
|
-
|
817
|
-
|
818
|
-
|
819
|
-
|
820
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
821
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
822
|
-
end
|
783
|
+
require 'json'
|
784
|
+
require 'yaml'
|
785
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
786
|
+
|
787
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
788
|
+
# As such, this might not be the best way to use this object.
|
789
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
823
790
|
|
824
|
-
|
791
|
+
api = UltracartClient::CouponApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
825
792
|
coupon_query = UltracartClient::CouponQuery.new # CouponQuery | Coupon query
|
826
793
|
opts = {
|
827
794
|
_limit: 56, # Integer | The maximum number of records to return on this one API call. (Max 200)
|
@@ -894,18 +861,15 @@ Retrieve values needed for a coupon editor
|
|
894
861
|
```ruby
|
895
862
|
require 'time'
|
896
863
|
require 'ultracart_api'
|
897
|
-
|
898
|
-
|
899
|
-
|
900
|
-
|
901
|
-
|
902
|
-
|
903
|
-
|
904
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
905
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
906
|
-
end
|
864
|
+
require 'json'
|
865
|
+
require 'yaml'
|
866
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
867
|
+
|
868
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
869
|
+
# As such, this might not be the best way to use this object.
|
870
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
907
871
|
|
908
|
-
|
872
|
+
api = UltracartClient::CouponApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
909
873
|
|
910
874
|
begin
|
911
875
|
# Retrieve values needed for a coupon editor
|
@@ -965,18 +929,15 @@ Insert a coupon on the UltraCart account.
|
|
965
929
|
```ruby
|
966
930
|
require 'time'
|
967
931
|
require 'ultracart_api'
|
968
|
-
|
969
|
-
|
970
|
-
|
971
|
-
|
972
|
-
|
973
|
-
|
974
|
-
|
975
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
976
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
977
|
-
end
|
932
|
+
require 'json'
|
933
|
+
require 'yaml'
|
934
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
935
|
+
|
936
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
937
|
+
# As such, this might not be the best way to use this object.
|
938
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
978
939
|
|
979
|
-
|
940
|
+
api = UltracartClient::CouponApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
980
941
|
coupon = UltracartClient::Coupon.new # Coupon | Coupon to insert
|
981
942
|
opts = {
|
982
943
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
@@ -1043,18 +1004,15 @@ Insert multiple coupon on the UltraCart account.
|
|
1043
1004
|
```ruby
|
1044
1005
|
require 'time'
|
1045
1006
|
require 'ultracart_api'
|
1046
|
-
|
1047
|
-
|
1048
|
-
|
1049
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
1050
|
-
|
1051
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
1052
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
1053
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1054
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
1055
|
-
end
|
1007
|
+
require 'json'
|
1008
|
+
require 'yaml'
|
1009
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
1056
1010
|
|
1057
|
-
|
1011
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
1012
|
+
# As such, this might not be the best way to use this object.
|
1013
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
1014
|
+
|
1015
|
+
api = UltracartClient::CouponApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
1058
1016
|
coupons_request = UltracartClient::CouponsRequest.new # CouponsRequest | Coupons to insert (maximum 50)
|
1059
1017
|
opts = {
|
1060
1018
|
_expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
|
@@ -1123,18 +1081,15 @@ Searches for items to display within a coupon editor and assign to coupons
|
|
1123
1081
|
```ruby
|
1124
1082
|
require 'time'
|
1125
1083
|
require 'ultracart_api'
|
1126
|
-
|
1127
|
-
|
1128
|
-
|
1129
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
1130
|
-
|
1131
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
1132
|
-
config.api_key['ultraCartSimpleApiKey'] = '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['ultraCartSimpleApiKey'] = 'Bearer'
|
1135
|
-
end
|
1084
|
+
require 'json'
|
1085
|
+
require 'yaml'
|
1086
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
1136
1087
|
|
1137
|
-
|
1088
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
1089
|
+
# As such, this might not be the best way to use this object.
|
1090
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
1091
|
+
|
1092
|
+
api = UltracartClient::CouponApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
1138
1093
|
opts = {
|
1139
1094
|
s: 's_example', # String |
|
1140
1095
|
m: 56 # Integer |
|
@@ -1201,18 +1156,15 @@ Update auto apply rules and conditions
|
|
1201
1156
|
```ruby
|
1202
1157
|
require 'time'
|
1203
1158
|
require 'ultracart_api'
|
1204
|
-
|
1205
|
-
|
1206
|
-
|
1207
|
-
|
1208
|
-
|
1209
|
-
|
1210
|
-
|
1211
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1212
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
1213
|
-
end
|
1159
|
+
require 'json'
|
1160
|
+
require 'yaml'
|
1161
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
1162
|
+
|
1163
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
1164
|
+
# As such, this might not be the best way to use this object.
|
1165
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
1214
1166
|
|
1215
|
-
|
1167
|
+
api = UltracartClient::CouponApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
1216
1168
|
conditions = UltracartClient::CouponAutoApplyConditions.new # CouponAutoApplyConditions | Conditions
|
1217
1169
|
|
1218
1170
|
begin
|
@@ -1274,18 +1226,15 @@ Update a coupon on the UltraCart account.
|
|
1274
1226
|
```ruby
|
1275
1227
|
require 'time'
|
1276
1228
|
require 'ultracart_api'
|
1277
|
-
|
1278
|
-
|
1279
|
-
|
1280
|
-
|
1281
|
-
|
1282
|
-
|
1283
|
-
|
1284
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1285
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
1286
|
-
end
|
1229
|
+
require 'json'
|
1230
|
+
require 'yaml'
|
1231
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
1232
|
+
|
1233
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
1234
|
+
# As such, this might not be the best way to use this object.
|
1235
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
1287
1236
|
|
1288
|
-
|
1237
|
+
api = UltracartClient::CouponApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
1289
1238
|
coupon_oid = 56 # Integer | The coupon_oid to update.
|
1290
1239
|
coupon = UltracartClient::Coupon.new # Coupon | Coupon to update
|
1291
1240
|
opts = {
|
@@ -1354,18 +1303,15 @@ Update multiple coupon on the UltraCart account.
|
|
1354
1303
|
```ruby
|
1355
1304
|
require 'time'
|
1356
1305
|
require 'ultracart_api'
|
1357
|
-
|
1358
|
-
|
1359
|
-
|
1360
|
-
|
1361
|
-
|
1362
|
-
|
1363
|
-
|
1364
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1365
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
1366
|
-
end
|
1306
|
+
require 'json'
|
1307
|
+
require 'yaml'
|
1308
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
1309
|
+
|
1310
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
1311
|
+
# As such, this might not be the best way to use this object.
|
1312
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
1367
1313
|
|
1368
|
-
|
1314
|
+
api = UltracartClient::CouponApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
1369
1315
|
coupons_request = UltracartClient::CouponsRequest.new # CouponsRequest | Coupons to update (synchronous maximum 50 / asynchronous maximum 100)
|
1370
1316
|
opts = {
|
1371
1317
|
_expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
|
@@ -1436,18 +1382,15 @@ Upload one-time codes for a coupon
|
|
1436
1382
|
```ruby
|
1437
1383
|
require 'time'
|
1438
1384
|
require 'ultracart_api'
|
1439
|
-
|
1440
|
-
|
1441
|
-
|
1442
|
-
|
1443
|
-
|
1444
|
-
|
1445
|
-
|
1446
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
1447
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
1448
|
-
end
|
1385
|
+
require 'json'
|
1386
|
+
require 'yaml'
|
1387
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
1388
|
+
|
1389
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
1390
|
+
# As such, this might not be the best way to use this object.
|
1391
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
1449
1392
|
|
1450
|
-
|
1393
|
+
api = UltracartClient::CouponApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
1451
1394
|
coupon_oid = 56 # Integer | The coupon oid to associate with the provided one-time codes.
|
1452
1395
|
upload_coupon_codes_request = UltracartClient::UploadCouponCodesRequest.new # UploadCouponCodesRequest | One-time coupon codes
|
1453
1396
|
|
data/docs/CustomerActivity.md
CHANGED
@@ -5,9 +5,13 @@
|
|
5
5
|
| Name | Type | Description | Notes |
|
6
6
|
| ---- | ---- | ----------- | ----- |
|
7
7
|
| **activities** | [**Array<Activity>**](Activity.md) | | [optional] |
|
8
|
+
| **global_unsubscribed** | **Boolean** | | [optional] |
|
9
|
+
| **global_unsubscribed_dts** | **String** | | [optional] |
|
8
10
|
| **memberships** | [**Array<ListSegmentMembership>**](ListSegmentMembership.md) | | [optional] |
|
9
11
|
| **metrics** | [**Array<Metric>**](Metric.md) | | [optional] |
|
10
12
|
| **properties_list** | [**Array<Property>**](Property.md) | | [optional] |
|
13
|
+
| **spam_complaint** | **Boolean** | | [optional] |
|
14
|
+
| **spam_complaint_dts** | **String** | | [optional] |
|
11
15
|
|
12
16
|
## Example
|
13
17
|
|
@@ -16,9 +20,13 @@ require 'ultracart_api'
|
|
16
20
|
|
17
21
|
instance = UltracartClient::CustomerActivity.new(
|
18
22
|
activities: null,
|
23
|
+
global_unsubscribed: null,
|
24
|
+
global_unsubscribed_dts: null,
|
19
25
|
memberships: null,
|
20
26
|
metrics: null,
|
21
|
-
properties_list: null
|
27
|
+
properties_list: null,
|
28
|
+
spam_complaint: null,
|
29
|
+
spam_complaint_dts: null
|
22
30
|
)
|
23
31
|
```
|
24
32
|
|