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.
- 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/CustomerApi.md
CHANGED
|
@@ -17,6 +17,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
17
17
|
| [**get_customers_for_data_tables**](CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin |
|
|
18
18
|
| [**get_email_verification_token**](CustomerApi.md#get_email_verification_token) | **POST** /customer/customers/email_verify/get_token | Create a token that can be used to verify a customer email address |
|
|
19
19
|
| [**insert_customer**](CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer |
|
|
20
|
+
| [**merge_customer**](CustomerApi.md#merge_customer) | **PUT** /customer/customers/{customer_profile_oid}/merge | Merge customer into this customer |
|
|
20
21
|
| [**search_customer_profile_values**](CustomerApi.md#search_customer_profile_values) | **POST** /customer/search | Searches for all matching values (using POST) |
|
|
21
22
|
| [**update_customer**](CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer |
|
|
22
23
|
| [**update_customer_email_lists**](CustomerApi.md#update_customer_email_lists) | **POST** /customer/customers/{customer_profile_oid}/email_lists | Update email list subscriptions for a customer |
|
|
@@ -36,18 +37,15 @@ Adds store credit to a customer
|
|
|
36
37
|
```ruby
|
|
37
38
|
require 'time'
|
|
38
39
|
require 'ultracart_api'
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
47
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
48
|
-
end
|
|
40
|
+
require 'json'
|
|
41
|
+
require 'yaml'
|
|
42
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
43
|
+
|
|
44
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
45
|
+
# As such, this might not be the best way to use this object.
|
|
46
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
49
47
|
|
|
50
|
-
|
|
48
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
51
49
|
customer_profile_oid = 56 # Integer | The customer oid to credit.
|
|
52
50
|
store_credit_request = UltracartClient::CustomerStoreCreditAddRequest.new # CustomerStoreCreditAddRequest | Store credit to add
|
|
53
51
|
|
|
@@ -112,18 +110,15 @@ Updates the cashback balance for a customer by updating the internal gift certif
|
|
|
112
110
|
```ruby
|
|
113
111
|
require 'time'
|
|
114
112
|
require 'ultracart_api'
|
|
115
|
-
|
|
116
|
-
|
|
117
|
-
|
|
118
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
119
|
-
|
|
120
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
121
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
122
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
123
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
124
|
-
end
|
|
113
|
+
require 'json'
|
|
114
|
+
require 'yaml'
|
|
115
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
125
116
|
|
|
126
|
-
|
|
117
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
118
|
+
# As such, this might not be the best way to use this object.
|
|
119
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
120
|
+
|
|
121
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
127
122
|
customer_profile_oid = 56 # Integer | The customer profile oid
|
|
128
123
|
adjust_internal_certificate_request = UltracartClient::AdjustInternalCertificateRequest.new # AdjustInternalCertificateRequest | adjustInternalCertificateRequest
|
|
129
124
|
|
|
@@ -188,18 +183,15 @@ Delete a customer on the UltraCart account.
|
|
|
188
183
|
```ruby
|
|
189
184
|
require 'time'
|
|
190
185
|
require 'ultracart_api'
|
|
191
|
-
|
|
192
|
-
|
|
193
|
-
|
|
194
|
-
|
|
195
|
-
|
|
196
|
-
|
|
197
|
-
|
|
198
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
199
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
200
|
-
end
|
|
186
|
+
require 'json'
|
|
187
|
+
require 'yaml'
|
|
188
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
189
|
+
|
|
190
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
191
|
+
# As such, this might not be the best way to use this object.
|
|
192
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
201
193
|
|
|
202
|
-
|
|
194
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
203
195
|
customer_profile_oid = 56 # Integer | The customer_profile_oid to delete.
|
|
204
196
|
|
|
205
197
|
begin
|
|
@@ -261,18 +253,15 @@ Retrieves a single customer using the specified customer profile oid.
|
|
|
261
253
|
```ruby
|
|
262
254
|
require 'time'
|
|
263
255
|
require 'ultracart_api'
|
|
264
|
-
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
|
|
268
|
-
|
|
269
|
-
|
|
270
|
-
|
|
271
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
272
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
273
|
-
end
|
|
256
|
+
require 'json'
|
|
257
|
+
require 'yaml'
|
|
258
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
259
|
+
|
|
260
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
261
|
+
# As such, this might not be the best way to use this object.
|
|
262
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
274
263
|
|
|
275
|
-
|
|
264
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
276
265
|
customer_profile_oid = 56 # Integer | The customer oid to retrieve.
|
|
277
266
|
opts = {
|
|
278
267
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
@@ -339,18 +328,15 @@ Retrieves a single customer using the specified customer email address.
|
|
|
339
328
|
```ruby
|
|
340
329
|
require 'time'
|
|
341
330
|
require 'ultracart_api'
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
346
|
-
|
|
347
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
348
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
349
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
350
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
351
|
-
end
|
|
331
|
+
require 'json'
|
|
332
|
+
require 'yaml'
|
|
333
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
352
334
|
|
|
353
|
-
|
|
335
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
336
|
+
# As such, this might not be the best way to use this object.
|
|
337
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
338
|
+
|
|
339
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
354
340
|
email = 'email_example' # String | The email address of the customer to retrieve.
|
|
355
341
|
opts = {
|
|
356
342
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
@@ -417,18 +403,15 @@ Retrieve values needed for a customer profile editor.
|
|
|
417
403
|
```ruby
|
|
418
404
|
require 'time'
|
|
419
405
|
require 'ultracart_api'
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
|
|
424
|
-
|
|
425
|
-
|
|
426
|
-
|
|
427
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
428
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
429
|
-
end
|
|
406
|
+
require 'json'
|
|
407
|
+
require 'yaml'
|
|
408
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
409
|
+
|
|
410
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
411
|
+
# As such, this might not be the best way to use this object.
|
|
412
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
430
413
|
|
|
431
|
-
|
|
414
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
432
415
|
|
|
433
416
|
begin
|
|
434
417
|
# Retrieve values needed for a customer profile editor
|
|
@@ -488,18 +471,15 @@ Retrieve all email lists across all storefronts
|
|
|
488
471
|
```ruby
|
|
489
472
|
require 'time'
|
|
490
473
|
require 'ultracart_api'
|
|
491
|
-
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
499
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
500
|
-
end
|
|
474
|
+
require 'json'
|
|
475
|
+
require 'yaml'
|
|
476
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
477
|
+
|
|
478
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
479
|
+
# As such, this might not be the best way to use this object.
|
|
480
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
501
481
|
|
|
502
|
-
|
|
482
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
503
483
|
|
|
504
484
|
begin
|
|
505
485
|
# Retrieve all email lists across all storefronts
|
|
@@ -559,18 +539,15 @@ Retrieve the customer store credit accumulated through loyalty programs
|
|
|
559
539
|
```ruby
|
|
560
540
|
require 'time'
|
|
561
541
|
require 'ultracart_api'
|
|
562
|
-
|
|
563
|
-
|
|
564
|
-
|
|
565
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
566
|
-
|
|
567
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
568
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
569
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
570
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
571
|
-
end
|
|
542
|
+
require 'json'
|
|
543
|
+
require 'yaml'
|
|
544
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
572
545
|
|
|
573
|
-
|
|
546
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
547
|
+
# As such, this might not be the best way to use this object.
|
|
548
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
549
|
+
|
|
550
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
574
551
|
customer_profile_oid = 56 # Integer | The customer oid to retrieve.
|
|
575
552
|
|
|
576
553
|
begin
|
|
@@ -633,18 +610,15 @@ Retrieves customers from the account. If no parameters are specified, all custo
|
|
|
633
610
|
```ruby
|
|
634
611
|
require 'time'
|
|
635
612
|
require 'ultracart_api'
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
643
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
644
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
645
|
-
end
|
|
613
|
+
require 'json'
|
|
614
|
+
require 'yaml'
|
|
615
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
616
|
+
|
|
617
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
618
|
+
# As such, this might not be the best way to use this object.
|
|
619
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
646
620
|
|
|
647
|
-
|
|
621
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
648
622
|
opts = {
|
|
649
623
|
email: 'email_example', # String | Email
|
|
650
624
|
qb_class: 'qb_class_example', # String | Quickbooks class
|
|
@@ -771,18 +745,15 @@ Retrieves customers from the account. If no parameters are specified, all custo
|
|
|
771
745
|
```ruby
|
|
772
746
|
require 'time'
|
|
773
747
|
require 'ultracart_api'
|
|
774
|
-
|
|
775
|
-
|
|
776
|
-
|
|
777
|
-
|
|
778
|
-
|
|
779
|
-
|
|
780
|
-
|
|
781
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
782
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
783
|
-
end
|
|
748
|
+
require 'json'
|
|
749
|
+
require 'yaml'
|
|
750
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
751
|
+
|
|
752
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
753
|
+
# As such, this might not be the best way to use this object.
|
|
754
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
784
755
|
|
|
785
|
-
|
|
756
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
786
757
|
customer_query = UltracartClient::CustomerQuery.new # CustomerQuery | Customer query
|
|
787
758
|
opts = {
|
|
788
759
|
_limit: 56, # Integer | The maximum number of records to return on this one API call. (Max 200)
|
|
@@ -857,18 +828,15 @@ Retrieves customers from the account. If no searches are specified, all custome
|
|
|
857
828
|
```ruby
|
|
858
829
|
require 'time'
|
|
859
830
|
require 'ultracart_api'
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
864
|
-
|
|
865
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
866
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
867
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
868
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
869
|
-
end
|
|
831
|
+
require 'json'
|
|
832
|
+
require 'yaml'
|
|
833
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
870
834
|
|
|
871
|
-
|
|
835
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
836
|
+
# As such, this might not be the best way to use this object.
|
|
837
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
838
|
+
|
|
839
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
872
840
|
opts = {
|
|
873
841
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
874
842
|
}
|
|
@@ -933,18 +901,15 @@ Create a token that can be used to verify a customer email address. The impleme
|
|
|
933
901
|
```ruby
|
|
934
902
|
require 'time'
|
|
935
903
|
require 'ultracart_api'
|
|
936
|
-
|
|
937
|
-
|
|
938
|
-
|
|
939
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
940
|
-
|
|
941
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
942
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
943
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
944
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
945
|
-
end
|
|
904
|
+
require 'json'
|
|
905
|
+
require 'yaml'
|
|
906
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
946
907
|
|
|
947
|
-
|
|
908
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
909
|
+
# As such, this might not be the best way to use this object.
|
|
910
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
911
|
+
|
|
912
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
948
913
|
token_request = UltracartClient::EmailVerifyTokenRequest.new # EmailVerifyTokenRequest | Token request
|
|
949
914
|
|
|
950
915
|
begin
|
|
@@ -1007,18 +972,15 @@ Insert a customer on the UltraCart account.
|
|
|
1007
972
|
```ruby
|
|
1008
973
|
require 'time'
|
|
1009
974
|
require 'ultracart_api'
|
|
1010
|
-
|
|
1011
|
-
|
|
1012
|
-
|
|
1013
|
-
|
|
1014
|
-
|
|
1015
|
-
|
|
1016
|
-
|
|
1017
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1018
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
1019
|
-
end
|
|
975
|
+
require 'json'
|
|
976
|
+
require 'yaml'
|
|
977
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
978
|
+
|
|
979
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
980
|
+
# As such, this might not be the best way to use this object.
|
|
981
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
1020
982
|
|
|
1021
|
-
|
|
983
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
1022
984
|
customer = UltracartClient::Customer.new # Customer | Customer to insert
|
|
1023
985
|
opts = {
|
|
1024
986
|
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
@@ -1072,6 +1034,82 @@ end
|
|
|
1072
1034
|
- **Accept**: application/json
|
|
1073
1035
|
|
|
1074
1036
|
|
|
1037
|
+
## merge_customer
|
|
1038
|
+
|
|
1039
|
+
> merge_customer(customer_profile_oid, customer, opts)
|
|
1040
|
+
|
|
1041
|
+
Merge customer into this customer
|
|
1042
|
+
|
|
1043
|
+
Merge customer into this customer.
|
|
1044
|
+
|
|
1045
|
+
### Examples
|
|
1046
|
+
|
|
1047
|
+
```ruby
|
|
1048
|
+
require 'time'
|
|
1049
|
+
require 'ultracart_api'
|
|
1050
|
+
require 'json'
|
|
1051
|
+
require 'yaml'
|
|
1052
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
1053
|
+
|
|
1054
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
1055
|
+
# As such, this might not be the best way to use this object.
|
|
1056
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
1057
|
+
|
|
1058
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
1059
|
+
customer_profile_oid = 56 # Integer | The customer_profile_oid to update.
|
|
1060
|
+
customer = UltracartClient::CustomerMergeRequest.new # CustomerMergeRequest | Customer to merge into this profile.
|
|
1061
|
+
opts = {
|
|
1062
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
|
1063
|
+
}
|
|
1064
|
+
|
|
1065
|
+
begin
|
|
1066
|
+
# Merge customer into this customer
|
|
1067
|
+
api_instance.merge_customer(customer_profile_oid, customer, opts)
|
|
1068
|
+
rescue UltracartClient::ApiError => e
|
|
1069
|
+
puts "Error when calling CustomerApi->merge_customer: #{e}"
|
|
1070
|
+
end
|
|
1071
|
+
```
|
|
1072
|
+
|
|
1073
|
+
#### Using the merge_customer_with_http_info variant
|
|
1074
|
+
|
|
1075
|
+
This returns an Array which contains the response data (`nil` in this case), status code and headers.
|
|
1076
|
+
|
|
1077
|
+
> <Array(nil, Integer, Hash)> merge_customer_with_http_info(customer_profile_oid, customer, opts)
|
|
1078
|
+
|
|
1079
|
+
```ruby
|
|
1080
|
+
begin
|
|
1081
|
+
# Merge customer into this customer
|
|
1082
|
+
data, status_code, headers = api_instance.merge_customer_with_http_info(customer_profile_oid, customer, opts)
|
|
1083
|
+
p status_code # => 2xx
|
|
1084
|
+
p headers # => { ... }
|
|
1085
|
+
p data # => nil
|
|
1086
|
+
rescue UltracartClient::ApiError => e
|
|
1087
|
+
puts "Error when calling CustomerApi->merge_customer_with_http_info: #{e}"
|
|
1088
|
+
end
|
|
1089
|
+
```
|
|
1090
|
+
|
|
1091
|
+
### Parameters
|
|
1092
|
+
|
|
1093
|
+
| Name | Type | Description | Notes |
|
|
1094
|
+
| ---- | ---- | ----------- | ----- |
|
|
1095
|
+
| **customer_profile_oid** | **Integer** | The customer_profile_oid to update. | |
|
|
1096
|
+
| **customer** | [**CustomerMergeRequest**](CustomerMergeRequest.md) | Customer to merge into this profile. | |
|
|
1097
|
+
| **_expand** | **String** | The object expansion to perform on the result. See documentation for examples | [optional] |
|
|
1098
|
+
|
|
1099
|
+
### Return type
|
|
1100
|
+
|
|
1101
|
+
nil (empty response body)
|
|
1102
|
+
|
|
1103
|
+
### Authorization
|
|
1104
|
+
|
|
1105
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
1106
|
+
|
|
1107
|
+
### HTTP request headers
|
|
1108
|
+
|
|
1109
|
+
- **Content-Type**: application/json; charset=UTF-8
|
|
1110
|
+
- **Accept**: application/json
|
|
1111
|
+
|
|
1112
|
+
|
|
1075
1113
|
## search_customer_profile_values
|
|
1076
1114
|
|
|
1077
1115
|
> <LookupResponse> search_customer_profile_values(lookup_request)
|
|
@@ -1083,23 +1121,15 @@ Searches for all matching values (using POST)
|
|
|
1083
1121
|
```ruby
|
|
1084
1122
|
require 'time'
|
|
1085
1123
|
require 'ultracart_api'
|
|
1086
|
-
|
|
1087
|
-
|
|
1088
|
-
|
|
1089
|
-
|
|
1090
|
-
|
|
1091
|
-
|
|
1092
|
-
|
|
1093
|
-
# Configure OAuth2 access token for authorization: ultraCartOauth
|
|
1094
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1095
|
-
|
|
1096
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1097
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
1098
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1099
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
1100
|
-
end
|
|
1124
|
+
require 'json'
|
|
1125
|
+
require 'yaml'
|
|
1126
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
1127
|
+
|
|
1128
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
1129
|
+
# As such, this might not be the best way to use this object.
|
|
1130
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
1101
1131
|
|
|
1102
|
-
|
|
1132
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
1103
1133
|
lookup_request = UltracartClient::LookupRequest.new # LookupRequest | LookupRequest
|
|
1104
1134
|
|
|
1105
1135
|
begin
|
|
@@ -1162,18 +1192,15 @@ Update a customer on the UltraCart account.
|
|
|
1162
1192
|
```ruby
|
|
1163
1193
|
require 'time'
|
|
1164
1194
|
require 'ultracart_api'
|
|
1165
|
-
|
|
1166
|
-
|
|
1167
|
-
|
|
1168
|
-
config.access_token = 'YOUR ACCESS TOKEN'
|
|
1169
|
-
|
|
1170
|
-
# Configure API key authorization: ultraCartSimpleApiKey
|
|
1171
|
-
config.api_key['ultraCartSimpleApiKey'] = 'YOUR API KEY'
|
|
1172
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1173
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
1174
|
-
end
|
|
1195
|
+
require 'json'
|
|
1196
|
+
require 'yaml'
|
|
1197
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
1175
1198
|
|
|
1176
|
-
|
|
1199
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
1200
|
+
# As such, this might not be the best way to use this object.
|
|
1201
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
1202
|
+
|
|
1203
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
1177
1204
|
customer_profile_oid = 56 # Integer | The customer_profile_oid to update.
|
|
1178
1205
|
customer = UltracartClient::Customer.new # Customer | Customer to update
|
|
1179
1206
|
opts = {
|
|
@@ -1242,18 +1269,15 @@ Update email list subscriptions for a customer
|
|
|
1242
1269
|
```ruby
|
|
1243
1270
|
require 'time'
|
|
1244
1271
|
require 'ultracart_api'
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1253
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
1254
|
-
end
|
|
1272
|
+
require 'json'
|
|
1273
|
+
require 'yaml'
|
|
1274
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
1275
|
+
|
|
1276
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
1277
|
+
# As such, this might not be the best way to use this object.
|
|
1278
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
1255
1279
|
|
|
1256
|
-
|
|
1280
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
1257
1281
|
customer_profile_oid = 56 # Integer | The customer profile oid
|
|
1258
1282
|
list_changes = UltracartClient::CustomerEmailListChanges.new # CustomerEmailListChanges | List changes
|
|
1259
1283
|
|
|
@@ -1318,18 +1342,15 @@ Validate a token that can be used to verify a customer email address. The imple
|
|
|
1318
1342
|
```ruby
|
|
1319
1343
|
require 'time'
|
|
1320
1344
|
require 'ultracart_api'
|
|
1321
|
-
|
|
1322
|
-
|
|
1323
|
-
|
|
1324
|
-
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
|
|
1328
|
-
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
|
|
1329
|
-
# config.api_key_prefix['ultraCartSimpleApiKey'] = 'Bearer'
|
|
1330
|
-
end
|
|
1345
|
+
require 'json'
|
|
1346
|
+
require 'yaml'
|
|
1347
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
|
1348
|
+
|
|
1349
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
|
1350
|
+
# As such, this might not be the best way to use this object.
|
|
1351
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
|
1331
1352
|
|
|
1332
|
-
|
|
1353
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
|
1333
1354
|
validation_request = UltracartClient::EmailVerifyTokenValidateRequest.new # EmailVerifyTokenValidateRequest | Token validation request
|
|
1334
1355
|
|
|
1335
1356
|
begin
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# UltracartClient::CustomerMergeRequest
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **customer_profile_oid** | **Integer** | Customer profile oid to merge | [optional] |
|
|
8
|
+
| **email** | **String** | Email of the customer profile to merge | [optional] |
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```ruby
|
|
13
|
+
require 'ultracart_api'
|
|
14
|
+
|
|
15
|
+
instance = UltracartClient::CustomerMergeRequest.new(
|
|
16
|
+
customer_profile_oid: null,
|
|
17
|
+
email: null
|
|
18
|
+
)
|
|
19
|
+
```
|
|
20
|
+
|