ultracart_api 3.10.167 → 3.10.169
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +14 -4
- data/docs/Customer.md +1 -0
- data/docs/CustomerApi.md +270 -0
- data/docs/CustomerWishListItem.md +14 -0
- data/docs/CustomerWishListItemResponse.md +12 -0
- data/docs/CustomerWishListItemsResponse.md +12 -0
- data/lib/ultracart_api/api/customer_api.rb +305 -0
- data/lib/ultracart_api/models/customer.rb +11 -1
- data/lib/ultracart_api/models/customer_wish_list_item.rb +260 -0
- data/lib/ultracart_api/models/customer_wish_list_item_response.rb +221 -0
- data/lib/ultracart_api/models/customer_wish_list_items_response.rb +223 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +3 -0
- metadata +8 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 78b1ce84e204f6e1b831dfa5d7f5eea1c77fed092f12d1db642303de1aec21c0
|
4
|
+
data.tar.gz: ce0e7e09416139b1de7edefef85d2334ca285bdecc8defdeaf611093f762defd
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: ff32a071c7001a590524c6015ae48cad5d0222f765a6ab98eeed53e4d491a55c1760f2dd01fc9dcb81521bbd40b9c035aa36a7bee2b3cf9093f94110f38e7564
|
7
|
+
data.tar.gz: 65b708b7955c5fb01d9a5dd4710cb636ea5fb45027034d0e78749bac4dab7040d1a8a01e97cc011ecb67718337c2c86aacbe3e96b75490a8a54b49f9ab2be67d
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 3.10.
|
10
|
+
- Package version: 3.10.169
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-3.10.
|
27
|
+
gem install ./ultracart_api-3.10.169.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.10.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.10.169.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'ultracart_api', '~> 3.10.
|
35
|
+
gem 'ultracart_api', '~> 3.10.169'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -189,21 +189,26 @@ Class | Method | HTTP request | Description
|
|
189
189
|
*UltracartClient::CustomerApi* | [**add_customer_store_credit**](docs/CustomerApi.md#add_customer_store_credit) | **POST** /customer/customers/{customer_profile_oid}/store_credit | Adds store credit to a customer
|
190
190
|
*UltracartClient::CustomerApi* | [**adjust_internal_certificate**](docs/CustomerApi.md#adjust_internal_certificate) | **POST** /customer/customers/{customer_profile_oid}/adjust_cashback_balance | Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
|
191
191
|
*UltracartClient::CustomerApi* | [**delete_customer**](docs/CustomerApi.md#delete_customer) | **DELETE** /customer/customers/{customer_profile_oid} | Delete a customer
|
192
|
+
*UltracartClient::CustomerApi* | [**delete_wish_list_item**](docs/CustomerApi.md#delete_wish_list_item) | **DELETE** /customer/customers/{customer_profile_oid}/wishlist/{customer_wishlist_item_oid} | Delete a customer wishlist item
|
192
193
|
*UltracartClient::CustomerApi* | [**get_customer**](docs/CustomerApi.md#get_customer) | **GET** /customer/customers/{customer_profile_oid} | Retrieve a customer
|
193
194
|
*UltracartClient::CustomerApi* | [**get_customer_by_email**](docs/CustomerApi.md#get_customer_by_email) | **GET** /customer/customers/by_email/{email} | Retrieve a customer by Email
|
194
195
|
*UltracartClient::CustomerApi* | [**get_customer_editor_values**](docs/CustomerApi.md#get_customer_editor_values) | **GET** /customer/editor_values | Retrieve values needed for a customer profile editor
|
195
196
|
*UltracartClient::CustomerApi* | [**get_customer_email_lists**](docs/CustomerApi.md#get_customer_email_lists) | **GET** /customer/email_lists | Retrieve all email lists across all storefronts
|
196
197
|
*UltracartClient::CustomerApi* | [**get_customer_store_credit**](docs/CustomerApi.md#get_customer_store_credit) | **GET** /customer/customers/{customer_profile_oid}/store_credit | Retrieve the customer store credit accumulated through loyalty programs
|
198
|
+
*UltracartClient::CustomerApi* | [**get_customer_wish_list**](docs/CustomerApi.md#get_customer_wish_list) | **GET** /customer/customers/{customer_profile_oid}/wishlist | Retrieve wishlist items for customer
|
199
|
+
*UltracartClient::CustomerApi* | [**get_customer_wish_list_item**](docs/CustomerApi.md#get_customer_wish_list_item) | **GET** /customer/customers/{customer_profile_oid}/wishlist/{customer_wishlist_item_oid} | Retrieve wishlist item for customer
|
197
200
|
*UltracartClient::CustomerApi* | [**get_customers**](docs/CustomerApi.md#get_customers) | **GET** /customer/customers | Retrieve customers
|
198
201
|
*UltracartClient::CustomerApi* | [**get_customers_by_query**](docs/CustomerApi.md#get_customers_by_query) | **POST** /customer/customers/query | Retrieve customers by query
|
199
202
|
*UltracartClient::CustomerApi* | [**get_customers_for_data_tables**](docs/CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin
|
200
203
|
*UltracartClient::CustomerApi* | [**get_email_verification_token**](docs/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
|
201
204
|
*UltracartClient::CustomerApi* | [**get_magic_link**](docs/CustomerApi.md#get_magic_link) | **PUT** /customer/customers/{customer_profile_oid}/magic_link/{storefront_host_name} | getMagicLink
|
202
205
|
*UltracartClient::CustomerApi* | [**insert_customer**](docs/CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer
|
206
|
+
*UltracartClient::CustomerApi* | [**insert_wish_list_item**](docs/CustomerApi.md#insert_wish_list_item) | **POST** /customer/customers/{customer_profile_oid}/wishlist | Insert a customer wishlist item
|
203
207
|
*UltracartClient::CustomerApi* | [**merge_customer**](docs/CustomerApi.md#merge_customer) | **PUT** /customer/customers/{customer_profile_oid}/merge | Merge customer into this customer
|
204
208
|
*UltracartClient::CustomerApi* | [**search_customer_profile_values**](docs/CustomerApi.md#search_customer_profile_values) | **POST** /customer/search | Searches for all matching values (using POST)
|
205
209
|
*UltracartClient::CustomerApi* | [**update_customer**](docs/CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer
|
206
210
|
*UltracartClient::CustomerApi* | [**update_customer_email_lists**](docs/CustomerApi.md#update_customer_email_lists) | **POST** /customer/customers/{customer_profile_oid}/email_lists | Update email list subscriptions for a customer
|
211
|
+
*UltracartClient::CustomerApi* | [**update_wish_list_item**](docs/CustomerApi.md#update_wish_list_item) | **PUT** /customer/customers/{customer_profile_oid}/wishlist/{customer_wishlist_item_oid} | Update a customer wishlist item
|
207
212
|
*UltracartClient::CustomerApi* | [**validate_email_verification_token**](docs/CustomerApi.md#validate_email_verification_token) | **POST** /customer/customers/email_verify/validate_token | Validate a token that can be used to verify a customer email address
|
208
213
|
*UltracartClient::DatawarehouseApi* | [**delete_report**](docs/DatawarehouseApi.md#delete_report) | **DELETE** /datawarehouse/reports/{report_oid} | Delete a report
|
209
214
|
*UltracartClient::DatawarehouseApi* | [**dry_run_report_queries**](docs/DatawarehouseApi.md#dry_run_report_queries) | **PUT** /datawarehouse/reports/dryrun | Dry run the report queries
|
@@ -809,6 +814,9 @@ Class | Method | HTTP request | Description
|
|
809
814
|
- [UltracartClient::CustomerStoreCreditResponse](docs/CustomerStoreCreditResponse.md)
|
810
815
|
- [UltracartClient::CustomerTag](docs/CustomerTag.md)
|
811
816
|
- [UltracartClient::CustomerTaxCodes](docs/CustomerTaxCodes.md)
|
817
|
+
- [UltracartClient::CustomerWishListItem](docs/CustomerWishListItem.md)
|
818
|
+
- [UltracartClient::CustomerWishListItemResponse](docs/CustomerWishListItemResponse.md)
|
819
|
+
- [UltracartClient::CustomerWishListItemsResponse](docs/CustomerWishListItemsResponse.md)
|
812
820
|
- [UltracartClient::CustomersResponse](docs/CustomersResponse.md)
|
813
821
|
- [UltracartClient::DataTablesServerSideResponse](docs/DataTablesServerSideResponse.md)
|
814
822
|
- [UltracartClient::Distance](docs/Distance.md)
|
@@ -1388,6 +1396,8 @@ Not every change is committed to every SDK.
|
|
1388
1396
|
|
1389
1397
|
| Version | Date | Comments |
|
1390
1398
|
| --: | :-: | --- |
|
1399
|
+
| 3.10.169 | 11/06/2023 | customer api - added wishlist methods |
|
1400
|
+
| 3.10.168 | 11/01/2023 | customer - do_no_send_mail flag added |
|
1391
1401
|
| 3.10.167 | 10/30/2023 | cart/order fields for health benefit card values in summary expansion objects |
|
1392
1402
|
| 3.10.166 | 10/27/2023 | workflow task object model refinement |
|
1393
1403
|
| 3.10.165 | 10/23/2023 | workflow tasks api |
|
data/docs/Customer.md
CHANGED
@@ -22,6 +22,7 @@ Name | Type | Description | Notes
|
|
22
22
|
**customer_profile_oid** | **Integer** | Customer profile object identifier | [optional]
|
23
23
|
**dhl_account_number** | **String** | DHL account number | [optional]
|
24
24
|
**dhl_duty_account_number** | **String** | DHL duty account number | [optional]
|
25
|
+
**do_not_send_mail** | **BOOLEAN** | Do not send mail (null will not update) | [optional]
|
25
26
|
**edi** | [**CustomerEDI**](CustomerEDI.md) | | [optional]
|
26
27
|
**email** | **String** | Email address of this customer profile | [optional]
|
27
28
|
**exempt_shipping_handling_charge** | **BOOLEAN** | Exempt shipping handling charge | [optional]
|
data/docs/CustomerApi.md
CHANGED
@@ -7,21 +7,26 @@ Method | HTTP request | Description
|
|
7
7
|
[**add_customer_store_credit**](CustomerApi.md#add_customer_store_credit) | **POST** /customer/customers/{customer_profile_oid}/store_credit | Adds store credit to a customer
|
8
8
|
[**adjust_internal_certificate**](CustomerApi.md#adjust_internal_certificate) | **POST** /customer/customers/{customer_profile_oid}/adjust_cashback_balance | Updates the cashback balance for a customer by updating the internal gift certificate used, creating the gift certificate if needed.
|
9
9
|
[**delete_customer**](CustomerApi.md#delete_customer) | **DELETE** /customer/customers/{customer_profile_oid} | Delete a customer
|
10
|
+
[**delete_wish_list_item**](CustomerApi.md#delete_wish_list_item) | **DELETE** /customer/customers/{customer_profile_oid}/wishlist/{customer_wishlist_item_oid} | Delete a customer wishlist item
|
10
11
|
[**get_customer**](CustomerApi.md#get_customer) | **GET** /customer/customers/{customer_profile_oid} | Retrieve a customer
|
11
12
|
[**get_customer_by_email**](CustomerApi.md#get_customer_by_email) | **GET** /customer/customers/by_email/{email} | Retrieve a customer by Email
|
12
13
|
[**get_customer_editor_values**](CustomerApi.md#get_customer_editor_values) | **GET** /customer/editor_values | Retrieve values needed for a customer profile editor
|
13
14
|
[**get_customer_email_lists**](CustomerApi.md#get_customer_email_lists) | **GET** /customer/email_lists | Retrieve all email lists across all storefronts
|
14
15
|
[**get_customer_store_credit**](CustomerApi.md#get_customer_store_credit) | **GET** /customer/customers/{customer_profile_oid}/store_credit | Retrieve the customer store credit accumulated through loyalty programs
|
16
|
+
[**get_customer_wish_list**](CustomerApi.md#get_customer_wish_list) | **GET** /customer/customers/{customer_profile_oid}/wishlist | Retrieve wishlist items for customer
|
17
|
+
[**get_customer_wish_list_item**](CustomerApi.md#get_customer_wish_list_item) | **GET** /customer/customers/{customer_profile_oid}/wishlist/{customer_wishlist_item_oid} | Retrieve wishlist item for customer
|
15
18
|
[**get_customers**](CustomerApi.md#get_customers) | **GET** /customer/customers | Retrieve customers
|
16
19
|
[**get_customers_by_query**](CustomerApi.md#get_customers_by_query) | **POST** /customer/customers/query | Retrieve customers by query
|
17
20
|
[**get_customers_for_data_tables**](CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin
|
18
21
|
[**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
22
|
[**get_magic_link**](CustomerApi.md#get_magic_link) | **PUT** /customer/customers/{customer_profile_oid}/magic_link/{storefront_host_name} | getMagicLink
|
20
23
|
[**insert_customer**](CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer
|
24
|
+
[**insert_wish_list_item**](CustomerApi.md#insert_wish_list_item) | **POST** /customer/customers/{customer_profile_oid}/wishlist | Insert a customer wishlist item
|
21
25
|
[**merge_customer**](CustomerApi.md#merge_customer) | **PUT** /customer/customers/{customer_profile_oid}/merge | Merge customer into this customer
|
22
26
|
[**search_customer_profile_values**](CustomerApi.md#search_customer_profile_values) | **POST** /customer/search | Searches for all matching values (using POST)
|
23
27
|
[**update_customer**](CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer
|
24
28
|
[**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
|
29
|
+
[**update_wish_list_item**](CustomerApi.md#update_wish_list_item) | **PUT** /customer/customers/{customer_profile_oid}/wishlist/{customer_wishlist_item_oid} | Update a customer wishlist item
|
25
30
|
[**validate_email_verification_token**](CustomerApi.md#validate_email_verification_token) | **POST** /customer/customers/email_verify/validate_token | Validate a token that can be used to verify a customer email address
|
26
31
|
|
27
32
|
|
@@ -180,6 +185,59 @@ nil (empty response body)
|
|
180
185
|
|
181
186
|
|
182
187
|
|
188
|
+
# **delete_wish_list_item**
|
189
|
+
> CustomerWishListItem delete_wish_list_item(customer_profile_oid, customer_wishlist_item_oid)
|
190
|
+
|
191
|
+
Delete a customer wishlist item
|
192
|
+
|
193
|
+
Delete a customer wishlist item
|
194
|
+
|
195
|
+
### Example
|
196
|
+
```ruby
|
197
|
+
# load the gem
|
198
|
+
require 'ultracart_api'
|
199
|
+
|
200
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
201
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
202
|
+
api_instance = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
|
203
|
+
|
204
|
+
|
205
|
+
customer_profile_oid = 56 # Integer | The customer oid for this wishlist.
|
206
|
+
|
207
|
+
customer_wishlist_item_oid = 56 # Integer | The wishlist oid for this wishlist item to delete.
|
208
|
+
|
209
|
+
|
210
|
+
begin
|
211
|
+
#Delete a customer wishlist item
|
212
|
+
result = api_instance.delete_wish_list_item(customer_profile_oid, customer_wishlist_item_oid)
|
213
|
+
p result
|
214
|
+
rescue UltracartClient::ApiError => e
|
215
|
+
puts "Exception when calling CustomerApi->delete_wish_list_item: #{e}"
|
216
|
+
end
|
217
|
+
```
|
218
|
+
|
219
|
+
### Parameters
|
220
|
+
|
221
|
+
Name | Type | Description | Notes
|
222
|
+
------------- | ------------- | ------------- | -------------
|
223
|
+
**customer_profile_oid** | **Integer**| The customer oid for this wishlist. |
|
224
|
+
**customer_wishlist_item_oid** | **Integer**| The wishlist oid for this wishlist item to delete. |
|
225
|
+
|
226
|
+
### Return type
|
227
|
+
|
228
|
+
[**CustomerWishListItem**](CustomerWishListItem.md)
|
229
|
+
|
230
|
+
### Authorization
|
231
|
+
|
232
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
233
|
+
|
234
|
+
### HTTP request headers
|
235
|
+
|
236
|
+
- **Content-Type**: application/json; charset=UTF-8
|
237
|
+
- **Accept**: application/json
|
238
|
+
|
239
|
+
|
240
|
+
|
183
241
|
# **get_customer**
|
184
242
|
> CustomerResponse get_customer(customer_profile_oid, opts)
|
185
243
|
|
@@ -428,6 +486,109 @@ Name | Type | Description | Notes
|
|
428
486
|
|
429
487
|
|
430
488
|
|
489
|
+
# **get_customer_wish_list**
|
490
|
+
> CustomerWishListItemsResponse get_customer_wish_list(customer_profile_oid)
|
491
|
+
|
492
|
+
Retrieve wishlist items for customer
|
493
|
+
|
494
|
+
Retrieve wishlist items for customer.
|
495
|
+
|
496
|
+
### Example
|
497
|
+
```ruby
|
498
|
+
# load the gem
|
499
|
+
require 'ultracart_api'
|
500
|
+
|
501
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
502
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
503
|
+
api_instance = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
|
504
|
+
|
505
|
+
|
506
|
+
customer_profile_oid = 56 # Integer | The customer oid for this wishlist.
|
507
|
+
|
508
|
+
|
509
|
+
begin
|
510
|
+
#Retrieve wishlist items for customer
|
511
|
+
result = api_instance.get_customer_wish_list(customer_profile_oid)
|
512
|
+
p result
|
513
|
+
rescue UltracartClient::ApiError => e
|
514
|
+
puts "Exception when calling CustomerApi->get_customer_wish_list: #{e}"
|
515
|
+
end
|
516
|
+
```
|
517
|
+
|
518
|
+
### Parameters
|
519
|
+
|
520
|
+
Name | Type | Description | Notes
|
521
|
+
------------- | ------------- | ------------- | -------------
|
522
|
+
**customer_profile_oid** | **Integer**| The customer oid for this wishlist. |
|
523
|
+
|
524
|
+
### Return type
|
525
|
+
|
526
|
+
[**CustomerWishListItemsResponse**](CustomerWishListItemsResponse.md)
|
527
|
+
|
528
|
+
### Authorization
|
529
|
+
|
530
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
531
|
+
|
532
|
+
### HTTP request headers
|
533
|
+
|
534
|
+
- **Content-Type**: application/json
|
535
|
+
- **Accept**: application/json
|
536
|
+
|
537
|
+
|
538
|
+
|
539
|
+
# **get_customer_wish_list_item**
|
540
|
+
> CustomerWishListItemResponse get_customer_wish_list_item(customer_profile_oid, customer_wishlist_item_oid)
|
541
|
+
|
542
|
+
Retrieve wishlist item for customer
|
543
|
+
|
544
|
+
Retrieve wishlist item for customer.
|
545
|
+
|
546
|
+
### Example
|
547
|
+
```ruby
|
548
|
+
# load the gem
|
549
|
+
require 'ultracart_api'
|
550
|
+
|
551
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
552
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
553
|
+
api_instance = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
|
554
|
+
|
555
|
+
|
556
|
+
customer_profile_oid = 56 # Integer | The customer oid for this wishlist.
|
557
|
+
|
558
|
+
customer_wishlist_item_oid = 56 # Integer | The wishlist oid for this wishlist item.
|
559
|
+
|
560
|
+
|
561
|
+
begin
|
562
|
+
#Retrieve wishlist item for customer
|
563
|
+
result = api_instance.get_customer_wish_list_item(customer_profile_oid, customer_wishlist_item_oid)
|
564
|
+
p result
|
565
|
+
rescue UltracartClient::ApiError => e
|
566
|
+
puts "Exception when calling CustomerApi->get_customer_wish_list_item: #{e}"
|
567
|
+
end
|
568
|
+
```
|
569
|
+
|
570
|
+
### Parameters
|
571
|
+
|
572
|
+
Name | Type | Description | Notes
|
573
|
+
------------- | ------------- | ------------- | -------------
|
574
|
+
**customer_profile_oid** | **Integer**| The customer oid for this wishlist. |
|
575
|
+
**customer_wishlist_item_oid** | **Integer**| The wishlist oid for this wishlist item. |
|
576
|
+
|
577
|
+
### Return type
|
578
|
+
|
579
|
+
[**CustomerWishListItemResponse**](CustomerWishListItemResponse.md)
|
580
|
+
|
581
|
+
### Authorization
|
582
|
+
|
583
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
584
|
+
|
585
|
+
### HTTP request headers
|
586
|
+
|
587
|
+
- **Content-Type**: application/json
|
588
|
+
- **Accept**: application/json
|
589
|
+
|
590
|
+
|
591
|
+
|
431
592
|
# **get_customers**
|
432
593
|
> CustomersResponse get_customers(opts)
|
433
594
|
|
@@ -811,6 +972,59 @@ Name | Type | Description | Notes
|
|
811
972
|
|
812
973
|
|
813
974
|
|
975
|
+
# **insert_wish_list_item**
|
976
|
+
> CustomerWishListItem insert_wish_list_item(wishlist_item, customer_profile_oid)
|
977
|
+
|
978
|
+
Insert a customer wishlist item
|
979
|
+
|
980
|
+
Insert a customer wishlist item
|
981
|
+
|
982
|
+
### Example
|
983
|
+
```ruby
|
984
|
+
# load the gem
|
985
|
+
require 'ultracart_api'
|
986
|
+
|
987
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
988
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
989
|
+
api_instance = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
|
990
|
+
|
991
|
+
|
992
|
+
wishlist_item = UltracartClient::CustomerWishListItem.new # CustomerWishListItem | Wishlist item to insert
|
993
|
+
|
994
|
+
customer_profile_oid = 56 # Integer | The customer oid for this wishlist.
|
995
|
+
|
996
|
+
|
997
|
+
begin
|
998
|
+
#Insert a customer wishlist item
|
999
|
+
result = api_instance.insert_wish_list_item(wishlist_item, customer_profile_oid)
|
1000
|
+
p result
|
1001
|
+
rescue UltracartClient::ApiError => e
|
1002
|
+
puts "Exception when calling CustomerApi->insert_wish_list_item: #{e}"
|
1003
|
+
end
|
1004
|
+
```
|
1005
|
+
|
1006
|
+
### Parameters
|
1007
|
+
|
1008
|
+
Name | Type | Description | Notes
|
1009
|
+
------------- | ------------- | ------------- | -------------
|
1010
|
+
**wishlist_item** | [**CustomerWishListItem**](CustomerWishListItem.md)| Wishlist item to insert |
|
1011
|
+
**customer_profile_oid** | **Integer**| The customer oid for this wishlist. |
|
1012
|
+
|
1013
|
+
### Return type
|
1014
|
+
|
1015
|
+
[**CustomerWishListItem**](CustomerWishListItem.md)
|
1016
|
+
|
1017
|
+
### Authorization
|
1018
|
+
|
1019
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1020
|
+
|
1021
|
+
### HTTP request headers
|
1022
|
+
|
1023
|
+
- **Content-Type**: application/json; charset=UTF-8
|
1024
|
+
- **Accept**: application/json
|
1025
|
+
|
1026
|
+
|
1027
|
+
|
814
1028
|
# **merge_customer**
|
815
1029
|
> merge_customer(customer, customer_profile_oid, opts)
|
816
1030
|
|
@@ -1025,6 +1239,62 @@ Name | Type | Description | Notes
|
|
1025
1239
|
|
1026
1240
|
|
1027
1241
|
|
1242
|
+
# **update_wish_list_item**
|
1243
|
+
> CustomerWishListItem update_wish_list_item(wishlist_item, customer_profile_oid, customer_wishlist_item_oid)
|
1244
|
+
|
1245
|
+
Update a customer wishlist item
|
1246
|
+
|
1247
|
+
Update a customer wishlist item
|
1248
|
+
|
1249
|
+
### Example
|
1250
|
+
```ruby
|
1251
|
+
# load the gem
|
1252
|
+
require 'ultracart_api'
|
1253
|
+
|
1254
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
1255
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
1256
|
+
api_instance = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
|
1257
|
+
|
1258
|
+
|
1259
|
+
wishlist_item = UltracartClient::CustomerWishListItem.new # CustomerWishListItem | Wishlist item to update
|
1260
|
+
|
1261
|
+
customer_profile_oid = 56 # Integer | The customer oid for this wishlist.
|
1262
|
+
|
1263
|
+
customer_wishlist_item_oid = 56 # Integer | The wishlist oid for this wishlist item.
|
1264
|
+
|
1265
|
+
|
1266
|
+
begin
|
1267
|
+
#Update a customer wishlist item
|
1268
|
+
result = api_instance.update_wish_list_item(wishlist_item, customer_profile_oid, customer_wishlist_item_oid)
|
1269
|
+
p result
|
1270
|
+
rescue UltracartClient::ApiError => e
|
1271
|
+
puts "Exception when calling CustomerApi->update_wish_list_item: #{e}"
|
1272
|
+
end
|
1273
|
+
```
|
1274
|
+
|
1275
|
+
### Parameters
|
1276
|
+
|
1277
|
+
Name | Type | Description | Notes
|
1278
|
+
------------- | ------------- | ------------- | -------------
|
1279
|
+
**wishlist_item** | [**CustomerWishListItem**](CustomerWishListItem.md)| Wishlist item to update |
|
1280
|
+
**customer_profile_oid** | **Integer**| The customer oid for this wishlist. |
|
1281
|
+
**customer_wishlist_item_oid** | **Integer**| The wishlist oid for this wishlist item. |
|
1282
|
+
|
1283
|
+
### Return type
|
1284
|
+
|
1285
|
+
[**CustomerWishListItem**](CustomerWishListItem.md)
|
1286
|
+
|
1287
|
+
### Authorization
|
1288
|
+
|
1289
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1290
|
+
|
1291
|
+
### HTTP request headers
|
1292
|
+
|
1293
|
+
- **Content-Type**: application/json; charset=UTF-8
|
1294
|
+
- **Accept**: application/json
|
1295
|
+
|
1296
|
+
|
1297
|
+
|
1028
1298
|
# **validate_email_verification_token**
|
1029
1299
|
> EmailVerifyTokenValidateResponse validate_email_verification_token(validation_request)
|
1030
1300
|
|
@@ -0,0 +1,14 @@
|
|
1
|
+
# UltracartClient::CustomerWishListItem
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**add_dts** | **String** | Add date | [optional]
|
7
|
+
**comments** | **String** | Comments | [optional]
|
8
|
+
**customer_profile_oid** | **Integer** | Customer profile object identifier | [optional]
|
9
|
+
**customer_wishlist_item_oid** | **Integer** | Customer wishlist item object identifier | [optional]
|
10
|
+
**merchant_item_oid** | **Integer** | Merchant item object identifier | [optional]
|
11
|
+
**position** | **Integer** | Position in wishlist | [optional]
|
12
|
+
**priority** | **Integer** | Priority of wishlist item, 3 being low priority and 5 is high priority. | [optional]
|
13
|
+
|
14
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::CustomerWishListItemResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
8
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
9
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
10
|
+
**wishlist_item** | [**CustomerWishListItem**](CustomerWishListItem.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::CustomerWishListItemsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
8
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
9
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
10
|
+
**wishlist_items** | [**Array<CustomerWishListItem>**](CustomerWishListItem.md) | | [optional]
|
11
|
+
|
12
|
+
|