ultracart_api 4.0.185 → 4.0.186
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +13 -4
- data/docs/CustomerApi.md +370 -0
- data/docs/CustomerWishListItem.md +30 -0
- data/docs/CustomerWishListItemResponse.md +26 -0
- data/docs/CustomerWishListItemsResponse.md +26 -0
- data/lib/ultracart_api/api/customer_api.rb +360 -0
- data/lib/ultracart_api/models/customer_wish_list_item.rb +295 -0
- data/lib/ultracart_api/models/customer_wish_list_item_response.rb +256 -0
- data/lib/ultracart_api/models/customer_wish_list_items_response.rb +258 -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: ed36da23b208a7311ac8cd543e60742211526401a60a1c1462a612ceed2652ac
|
4
|
+
data.tar.gz: a2b700910c6c7ab9eab94e5e1c7b8d3290c70cd49fcbf534e424ba1bc9973258
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 3eab3e9f31c01ae8a75a48f22fa09323b14d0e0dc03711ad30f46c511a53ad9ca43672d50e70aed28e67de40ac6b840ef38987b6bbe86e3f1b4ee354d48308b0
|
7
|
+
data.tar.gz: 3dde8312e935c4292fd6be5ad10d535fe73e70ef581617714449df2da9708af255b0cc35333743fdfd8829650e40326690a454ab8cd4f10bff191cf88fd77cd0
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 4.0.
|
10
|
+
- Package version: 4.0.186
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,16 +24,16 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-4.0.
|
27
|
+
gem install ./ultracart_api-4.0.186.gem
|
28
28
|
```
|
29
29
|
|
30
|
-
(for development, run `gem install --dev ./ultracart_api-4.0.
|
30
|
+
(for development, run `gem install --dev ./ultracart_api-4.0.186.gem` to install the development dependencies)
|
31
31
|
|
32
32
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
33
33
|
|
34
34
|
Finally add this to the Gemfile:
|
35
35
|
|
36
|
-
gem 'ultracart_api', '~> 4.0.
|
36
|
+
gem 'ultracart_api', '~> 4.0.186'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -195,21 +195,26 @@ Class | Method | HTTP request | Description
|
|
195
195
|
*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
|
196
196
|
*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.
|
197
197
|
*UltracartClient::CustomerApi* | [**delete_customer**](docs/CustomerApi.md#delete_customer) | **DELETE** /customer/customers/{customer_profile_oid} | Delete a customer
|
198
|
+
*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
|
198
199
|
*UltracartClient::CustomerApi* | [**get_customer**](docs/CustomerApi.md#get_customer) | **GET** /customer/customers/{customer_profile_oid} | Retrieve a customer
|
199
200
|
*UltracartClient::CustomerApi* | [**get_customer_by_email**](docs/CustomerApi.md#get_customer_by_email) | **GET** /customer/customers/by_email/{email} | Retrieve a customer by Email
|
200
201
|
*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
|
201
202
|
*UltracartClient::CustomerApi* | [**get_customer_email_lists**](docs/CustomerApi.md#get_customer_email_lists) | **GET** /customer/email_lists | Retrieve all email lists across all storefronts
|
202
203
|
*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
|
204
|
+
*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
|
205
|
+
*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
|
203
206
|
*UltracartClient::CustomerApi* | [**get_customers**](docs/CustomerApi.md#get_customers) | **GET** /customer/customers | Retrieve customers
|
204
207
|
*UltracartClient::CustomerApi* | [**get_customers_by_query**](docs/CustomerApi.md#get_customers_by_query) | **POST** /customer/customers/query | Retrieve customers by query
|
205
208
|
*UltracartClient::CustomerApi* | [**get_customers_for_data_tables**](docs/CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin
|
206
209
|
*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
|
207
210
|
*UltracartClient::CustomerApi* | [**get_magic_link**](docs/CustomerApi.md#get_magic_link) | **PUT** /customer/customers/{customer_profile_oid}/magic_link/{storefront_host_name} | getMagicLink
|
208
211
|
*UltracartClient::CustomerApi* | [**insert_customer**](docs/CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer
|
212
|
+
*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
|
209
213
|
*UltracartClient::CustomerApi* | [**merge_customer**](docs/CustomerApi.md#merge_customer) | **PUT** /customer/customers/{customer_profile_oid}/merge | Merge customer into this customer
|
210
214
|
*UltracartClient::CustomerApi* | [**search_customer_profile_values**](docs/CustomerApi.md#search_customer_profile_values) | **POST** /customer/search | Searches for all matching values (using POST)
|
211
215
|
*UltracartClient::CustomerApi* | [**update_customer**](docs/CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer
|
212
216
|
*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
|
217
|
+
*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
|
213
218
|
*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
|
214
219
|
*UltracartClient::DatawarehouseApi* | [**delete_report**](docs/DatawarehouseApi.md#delete_report) | **DELETE** /datawarehouse/reports/{report_oid} | Delete a report
|
215
220
|
*UltracartClient::DatawarehouseApi* | [**dry_run_report_queries**](docs/DatawarehouseApi.md#dry_run_report_queries) | **PUT** /datawarehouse/reports/dryrun | Dry run the report queries
|
@@ -814,6 +819,9 @@ Class | Method | HTTP request | Description
|
|
814
819
|
- [UltracartClient::CustomerStoreCreditResponse](docs/CustomerStoreCreditResponse.md)
|
815
820
|
- [UltracartClient::CustomerTag](docs/CustomerTag.md)
|
816
821
|
- [UltracartClient::CustomerTaxCodes](docs/CustomerTaxCodes.md)
|
822
|
+
- [UltracartClient::CustomerWishListItem](docs/CustomerWishListItem.md)
|
823
|
+
- [UltracartClient::CustomerWishListItemResponse](docs/CustomerWishListItemResponse.md)
|
824
|
+
- [UltracartClient::CustomerWishListItemsResponse](docs/CustomerWishListItemsResponse.md)
|
817
825
|
- [UltracartClient::CustomersResponse](docs/CustomersResponse.md)
|
818
826
|
- [UltracartClient::DataTablesServerSideResponse](docs/DataTablesServerSideResponse.md)
|
819
827
|
- [UltracartClient::Distance](docs/Distance.md)
|
@@ -1396,6 +1404,7 @@ Not every change is committed to every SDK.
|
|
1396
1404
|
|
1397
1405
|
| Version | Date | Comments |
|
1398
1406
|
| --: | :-: | --- |
|
1407
|
+
| 4.0.186 | 11/06/2023 | customer api - added wishlist methods |
|
1399
1408
|
| 4.0.185 | 11/01/2023 | customer - do_no_send_mail flag added |
|
1400
1409
|
| 4.0.184 | 10/30/2023 | cart/order fields for health benefit card values in summary expansion objects |
|
1401
1410
|
| 4.0.183 | 10/27/2023 | workflow task object model refinement |
|
data/docs/CustomerApi.md
CHANGED
@@ -7,21 +7,26 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
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
|
|
@@ -241,6 +246,79 @@ nil (empty response body)
|
|
241
246
|
- **Accept**: application/json
|
242
247
|
|
243
248
|
|
249
|
+
## delete_wish_list_item
|
250
|
+
|
251
|
+
> <CustomerWishListItem> delete_wish_list_item(customer_profile_oid, customer_wishlist_item_oid)
|
252
|
+
|
253
|
+
Delete a customer wishlist item
|
254
|
+
|
255
|
+
Delete a customer wishlist item
|
256
|
+
|
257
|
+
### Examples
|
258
|
+
|
259
|
+
```ruby
|
260
|
+
require 'time'
|
261
|
+
require 'ultracart_api'
|
262
|
+
require 'json'
|
263
|
+
require 'yaml'
|
264
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
265
|
+
|
266
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
267
|
+
# As such, this might not be the best way to use this object.
|
268
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
269
|
+
|
270
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
271
|
+
customer_profile_oid = 56 # Integer | The customer oid for this wishlist.
|
272
|
+
customer_wishlist_item_oid = 56 # Integer | The wishlist oid for this wishlist item to delete.
|
273
|
+
|
274
|
+
begin
|
275
|
+
# Delete a customer wishlist item
|
276
|
+
result = api_instance.delete_wish_list_item(customer_profile_oid, customer_wishlist_item_oid)
|
277
|
+
p result
|
278
|
+
rescue UltracartClient::ApiError => e
|
279
|
+
puts "Error when calling CustomerApi->delete_wish_list_item: #{e}"
|
280
|
+
end
|
281
|
+
```
|
282
|
+
|
283
|
+
#### Using the delete_wish_list_item_with_http_info variant
|
284
|
+
|
285
|
+
This returns an Array which contains the response data, status code and headers.
|
286
|
+
|
287
|
+
> <Array(<CustomerWishListItem>, Integer, Hash)> delete_wish_list_item_with_http_info(customer_profile_oid, customer_wishlist_item_oid)
|
288
|
+
|
289
|
+
```ruby
|
290
|
+
begin
|
291
|
+
# Delete a customer wishlist item
|
292
|
+
data, status_code, headers = api_instance.delete_wish_list_item_with_http_info(customer_profile_oid, customer_wishlist_item_oid)
|
293
|
+
p status_code # => 2xx
|
294
|
+
p headers # => { ... }
|
295
|
+
p data # => <CustomerWishListItem>
|
296
|
+
rescue UltracartClient::ApiError => e
|
297
|
+
puts "Error when calling CustomerApi->delete_wish_list_item_with_http_info: #{e}"
|
298
|
+
end
|
299
|
+
```
|
300
|
+
|
301
|
+
### Parameters
|
302
|
+
|
303
|
+
| Name | Type | Description | Notes |
|
304
|
+
| ---- | ---- | ----------- | ----- |
|
305
|
+
| **customer_profile_oid** | **Integer** | The customer oid for this wishlist. | |
|
306
|
+
| **customer_wishlist_item_oid** | **Integer** | The wishlist oid for this wishlist item to delete. | |
|
307
|
+
|
308
|
+
### Return type
|
309
|
+
|
310
|
+
[**CustomerWishListItem**](CustomerWishListItem.md)
|
311
|
+
|
312
|
+
### Authorization
|
313
|
+
|
314
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
315
|
+
|
316
|
+
### HTTP request headers
|
317
|
+
|
318
|
+
- **Content-Type**: Not defined
|
319
|
+
- **Accept**: application/json
|
320
|
+
|
321
|
+
|
244
322
|
## get_customer
|
245
323
|
|
246
324
|
> <CustomerResponse> get_customer(customer_profile_oid, opts)
|
@@ -598,6 +676,150 @@ end
|
|
598
676
|
- **Accept**: application/json
|
599
677
|
|
600
678
|
|
679
|
+
## get_customer_wish_list
|
680
|
+
|
681
|
+
> <CustomerWishListItemsResponse> get_customer_wish_list(customer_profile_oid)
|
682
|
+
|
683
|
+
Retrieve wishlist items for customer
|
684
|
+
|
685
|
+
Retrieve wishlist items for customer.
|
686
|
+
|
687
|
+
### Examples
|
688
|
+
|
689
|
+
```ruby
|
690
|
+
require 'time'
|
691
|
+
require 'ultracart_api'
|
692
|
+
require 'json'
|
693
|
+
require 'yaml'
|
694
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
695
|
+
|
696
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
697
|
+
# As such, this might not be the best way to use this object.
|
698
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
699
|
+
|
700
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
701
|
+
customer_profile_oid = 56 # Integer | The customer oid for this wishlist.
|
702
|
+
|
703
|
+
begin
|
704
|
+
# Retrieve wishlist items for customer
|
705
|
+
result = api_instance.get_customer_wish_list(customer_profile_oid)
|
706
|
+
p result
|
707
|
+
rescue UltracartClient::ApiError => e
|
708
|
+
puts "Error when calling CustomerApi->get_customer_wish_list: #{e}"
|
709
|
+
end
|
710
|
+
```
|
711
|
+
|
712
|
+
#### Using the get_customer_wish_list_with_http_info variant
|
713
|
+
|
714
|
+
This returns an Array which contains the response data, status code and headers.
|
715
|
+
|
716
|
+
> <Array(<CustomerWishListItemsResponse>, Integer, Hash)> get_customer_wish_list_with_http_info(customer_profile_oid)
|
717
|
+
|
718
|
+
```ruby
|
719
|
+
begin
|
720
|
+
# Retrieve wishlist items for customer
|
721
|
+
data, status_code, headers = api_instance.get_customer_wish_list_with_http_info(customer_profile_oid)
|
722
|
+
p status_code # => 2xx
|
723
|
+
p headers # => { ... }
|
724
|
+
p data # => <CustomerWishListItemsResponse>
|
725
|
+
rescue UltracartClient::ApiError => e
|
726
|
+
puts "Error when calling CustomerApi->get_customer_wish_list_with_http_info: #{e}"
|
727
|
+
end
|
728
|
+
```
|
729
|
+
|
730
|
+
### Parameters
|
731
|
+
|
732
|
+
| Name | Type | Description | Notes |
|
733
|
+
| ---- | ---- | ----------- | ----- |
|
734
|
+
| **customer_profile_oid** | **Integer** | The customer oid for this wishlist. | |
|
735
|
+
|
736
|
+
### Return type
|
737
|
+
|
738
|
+
[**CustomerWishListItemsResponse**](CustomerWishListItemsResponse.md)
|
739
|
+
|
740
|
+
### Authorization
|
741
|
+
|
742
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
743
|
+
|
744
|
+
### HTTP request headers
|
745
|
+
|
746
|
+
- **Content-Type**: Not defined
|
747
|
+
- **Accept**: application/json
|
748
|
+
|
749
|
+
|
750
|
+
## get_customer_wish_list_item
|
751
|
+
|
752
|
+
> <CustomerWishListItemResponse> get_customer_wish_list_item(customer_profile_oid, customer_wishlist_item_oid)
|
753
|
+
|
754
|
+
Retrieve wishlist item for customer
|
755
|
+
|
756
|
+
Retrieve wishlist item for customer.
|
757
|
+
|
758
|
+
### Examples
|
759
|
+
|
760
|
+
```ruby
|
761
|
+
require 'time'
|
762
|
+
require 'ultracart_api'
|
763
|
+
require 'json'
|
764
|
+
require 'yaml'
|
765
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
766
|
+
|
767
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
768
|
+
# As such, this might not be the best way to use this object.
|
769
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
770
|
+
|
771
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
772
|
+
customer_profile_oid = 56 # Integer | The customer oid for this wishlist.
|
773
|
+
customer_wishlist_item_oid = 56 # Integer | The wishlist oid for this wishlist item.
|
774
|
+
|
775
|
+
begin
|
776
|
+
# Retrieve wishlist item for customer
|
777
|
+
result = api_instance.get_customer_wish_list_item(customer_profile_oid, customer_wishlist_item_oid)
|
778
|
+
p result
|
779
|
+
rescue UltracartClient::ApiError => e
|
780
|
+
puts "Error when calling CustomerApi->get_customer_wish_list_item: #{e}"
|
781
|
+
end
|
782
|
+
```
|
783
|
+
|
784
|
+
#### Using the get_customer_wish_list_item_with_http_info variant
|
785
|
+
|
786
|
+
This returns an Array which contains the response data, status code and headers.
|
787
|
+
|
788
|
+
> <Array(<CustomerWishListItemResponse>, Integer, Hash)> get_customer_wish_list_item_with_http_info(customer_profile_oid, customer_wishlist_item_oid)
|
789
|
+
|
790
|
+
```ruby
|
791
|
+
begin
|
792
|
+
# Retrieve wishlist item for customer
|
793
|
+
data, status_code, headers = api_instance.get_customer_wish_list_item_with_http_info(customer_profile_oid, customer_wishlist_item_oid)
|
794
|
+
p status_code # => 2xx
|
795
|
+
p headers # => { ... }
|
796
|
+
p data # => <CustomerWishListItemResponse>
|
797
|
+
rescue UltracartClient::ApiError => e
|
798
|
+
puts "Error when calling CustomerApi->get_customer_wish_list_item_with_http_info: #{e}"
|
799
|
+
end
|
800
|
+
```
|
801
|
+
|
802
|
+
### Parameters
|
803
|
+
|
804
|
+
| Name | Type | Description | Notes |
|
805
|
+
| ---- | ---- | ----------- | ----- |
|
806
|
+
| **customer_profile_oid** | **Integer** | The customer oid for this wishlist. | |
|
807
|
+
| **customer_wishlist_item_oid** | **Integer** | The wishlist oid for this wishlist item. | |
|
808
|
+
|
809
|
+
### Return type
|
810
|
+
|
811
|
+
[**CustomerWishListItemResponse**](CustomerWishListItemResponse.md)
|
812
|
+
|
813
|
+
### Authorization
|
814
|
+
|
815
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
816
|
+
|
817
|
+
### HTTP request headers
|
818
|
+
|
819
|
+
- **Content-Type**: Not defined
|
820
|
+
- **Accept**: application/json
|
821
|
+
|
822
|
+
|
601
823
|
## get_customers
|
602
824
|
|
603
825
|
> <CustomersResponse> get_customers(opts)
|
@@ -1108,6 +1330,79 @@ end
|
|
1108
1330
|
- **Accept**: application/json
|
1109
1331
|
|
1110
1332
|
|
1333
|
+
## insert_wish_list_item
|
1334
|
+
|
1335
|
+
> <CustomerWishListItem> insert_wish_list_item(customer_profile_oid, wishlist_item)
|
1336
|
+
|
1337
|
+
Insert a customer wishlist item
|
1338
|
+
|
1339
|
+
Insert a customer wishlist item
|
1340
|
+
|
1341
|
+
### Examples
|
1342
|
+
|
1343
|
+
```ruby
|
1344
|
+
require 'time'
|
1345
|
+
require 'ultracart_api'
|
1346
|
+
require 'json'
|
1347
|
+
require 'yaml'
|
1348
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
1349
|
+
|
1350
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
1351
|
+
# As such, this might not be the best way to use this object.
|
1352
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
1353
|
+
|
1354
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
1355
|
+
customer_profile_oid = 56 # Integer | The customer oid for this wishlist.
|
1356
|
+
wishlist_item = UltracartClient::CustomerWishListItem.new # CustomerWishListItem | Wishlist item to insert
|
1357
|
+
|
1358
|
+
begin
|
1359
|
+
# Insert a customer wishlist item
|
1360
|
+
result = api_instance.insert_wish_list_item(customer_profile_oid, wishlist_item)
|
1361
|
+
p result
|
1362
|
+
rescue UltracartClient::ApiError => e
|
1363
|
+
puts "Error when calling CustomerApi->insert_wish_list_item: #{e}"
|
1364
|
+
end
|
1365
|
+
```
|
1366
|
+
|
1367
|
+
#### Using the insert_wish_list_item_with_http_info variant
|
1368
|
+
|
1369
|
+
This returns an Array which contains the response data, status code and headers.
|
1370
|
+
|
1371
|
+
> <Array(<CustomerWishListItem>, Integer, Hash)> insert_wish_list_item_with_http_info(customer_profile_oid, wishlist_item)
|
1372
|
+
|
1373
|
+
```ruby
|
1374
|
+
begin
|
1375
|
+
# Insert a customer wishlist item
|
1376
|
+
data, status_code, headers = api_instance.insert_wish_list_item_with_http_info(customer_profile_oid, wishlist_item)
|
1377
|
+
p status_code # => 2xx
|
1378
|
+
p headers # => { ... }
|
1379
|
+
p data # => <CustomerWishListItem>
|
1380
|
+
rescue UltracartClient::ApiError => e
|
1381
|
+
puts "Error when calling CustomerApi->insert_wish_list_item_with_http_info: #{e}"
|
1382
|
+
end
|
1383
|
+
```
|
1384
|
+
|
1385
|
+
### Parameters
|
1386
|
+
|
1387
|
+
| Name | Type | Description | Notes |
|
1388
|
+
| ---- | ---- | ----------- | ----- |
|
1389
|
+
| **customer_profile_oid** | **Integer** | The customer oid for this wishlist. | |
|
1390
|
+
| **wishlist_item** | [**CustomerWishListItem**](CustomerWishListItem.md) | Wishlist item to insert | |
|
1391
|
+
|
1392
|
+
### Return type
|
1393
|
+
|
1394
|
+
[**CustomerWishListItem**](CustomerWishListItem.md)
|
1395
|
+
|
1396
|
+
### Authorization
|
1397
|
+
|
1398
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1399
|
+
|
1400
|
+
### HTTP request headers
|
1401
|
+
|
1402
|
+
- **Content-Type**: application/json; charset=UTF-8
|
1403
|
+
- **Accept**: application/json
|
1404
|
+
|
1405
|
+
|
1111
1406
|
## merge_customer
|
1112
1407
|
|
1113
1408
|
> merge_customer(customer_profile_oid, customer, opts)
|
@@ -1403,6 +1698,81 @@ end
|
|
1403
1698
|
- **Accept**: application/json
|
1404
1699
|
|
1405
1700
|
|
1701
|
+
## update_wish_list_item
|
1702
|
+
|
1703
|
+
> <CustomerWishListItem> update_wish_list_item(customer_profile_oid, customer_wishlist_item_oid, wishlist_item)
|
1704
|
+
|
1705
|
+
Update a customer wishlist item
|
1706
|
+
|
1707
|
+
Update a customer wishlist item
|
1708
|
+
|
1709
|
+
### Examples
|
1710
|
+
|
1711
|
+
```ruby
|
1712
|
+
require 'time'
|
1713
|
+
require 'ultracart_api'
|
1714
|
+
require 'json'
|
1715
|
+
require 'yaml'
|
1716
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
1717
|
+
|
1718
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
1719
|
+
# As such, this might not be the best way to use this object.
|
1720
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
1721
|
+
|
1722
|
+
api = UltracartClient::CustomerApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
1723
|
+
customer_profile_oid = 56 # Integer | The customer oid for this wishlist.
|
1724
|
+
customer_wishlist_item_oid = 56 # Integer | The wishlist oid for this wishlist item.
|
1725
|
+
wishlist_item = UltracartClient::CustomerWishListItem.new # CustomerWishListItem | Wishlist item to update
|
1726
|
+
|
1727
|
+
begin
|
1728
|
+
# Update a customer wishlist item
|
1729
|
+
result = api_instance.update_wish_list_item(customer_profile_oid, customer_wishlist_item_oid, wishlist_item)
|
1730
|
+
p result
|
1731
|
+
rescue UltracartClient::ApiError => e
|
1732
|
+
puts "Error when calling CustomerApi->update_wish_list_item: #{e}"
|
1733
|
+
end
|
1734
|
+
```
|
1735
|
+
|
1736
|
+
#### Using the update_wish_list_item_with_http_info variant
|
1737
|
+
|
1738
|
+
This returns an Array which contains the response data, status code and headers.
|
1739
|
+
|
1740
|
+
> <Array(<CustomerWishListItem>, Integer, Hash)> update_wish_list_item_with_http_info(customer_profile_oid, customer_wishlist_item_oid, wishlist_item)
|
1741
|
+
|
1742
|
+
```ruby
|
1743
|
+
begin
|
1744
|
+
# Update a customer wishlist item
|
1745
|
+
data, status_code, headers = api_instance.update_wish_list_item_with_http_info(customer_profile_oid, customer_wishlist_item_oid, wishlist_item)
|
1746
|
+
p status_code # => 2xx
|
1747
|
+
p headers # => { ... }
|
1748
|
+
p data # => <CustomerWishListItem>
|
1749
|
+
rescue UltracartClient::ApiError => e
|
1750
|
+
puts "Error when calling CustomerApi->update_wish_list_item_with_http_info: #{e}"
|
1751
|
+
end
|
1752
|
+
```
|
1753
|
+
|
1754
|
+
### Parameters
|
1755
|
+
|
1756
|
+
| Name | Type | Description | Notes |
|
1757
|
+
| ---- | ---- | ----------- | ----- |
|
1758
|
+
| **customer_profile_oid** | **Integer** | The customer oid for this wishlist. | |
|
1759
|
+
| **customer_wishlist_item_oid** | **Integer** | The wishlist oid for this wishlist item. | |
|
1760
|
+
| **wishlist_item** | [**CustomerWishListItem**](CustomerWishListItem.md) | Wishlist item to update | |
|
1761
|
+
|
1762
|
+
### Return type
|
1763
|
+
|
1764
|
+
[**CustomerWishListItem**](CustomerWishListItem.md)
|
1765
|
+
|
1766
|
+
### Authorization
|
1767
|
+
|
1768
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
1769
|
+
|
1770
|
+
### HTTP request headers
|
1771
|
+
|
1772
|
+
- **Content-Type**: application/json; charset=UTF-8
|
1773
|
+
- **Accept**: application/json
|
1774
|
+
|
1775
|
+
|
1406
1776
|
## validate_email_verification_token
|
1407
1777
|
|
1408
1778
|
> <EmailVerifyTokenValidateResponse> validate_email_verification_token(validation_request)
|
@@ -0,0 +1,30 @@
|
|
1
|
+
# UltracartClient::CustomerWishListItem
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **add_dts** | **String** | Add date | [optional] |
|
8
|
+
| **comments** | **String** | Comments | [optional] |
|
9
|
+
| **customer_profile_oid** | **Integer** | Customer profile object identifier | [optional] |
|
10
|
+
| **customer_wishlist_item_oid** | **Integer** | Customer wishlist item object identifier | [optional] |
|
11
|
+
| **merchant_item_oid** | **Integer** | Merchant item object identifier | [optional] |
|
12
|
+
| **position** | **Integer** | Position in wishlist | [optional] |
|
13
|
+
| **priority** | **Integer** | Priority of wishlist item, 3 being low priority and 5 is high priority. | [optional] |
|
14
|
+
|
15
|
+
## Example
|
16
|
+
|
17
|
+
```ruby
|
18
|
+
require 'ultracart_api'
|
19
|
+
|
20
|
+
instance = UltracartClient::CustomerWishListItem.new(
|
21
|
+
add_dts: null,
|
22
|
+
comments: null,
|
23
|
+
customer_profile_oid: null,
|
24
|
+
customer_wishlist_item_oid: null,
|
25
|
+
merchant_item_oid: null,
|
26
|
+
position: null,
|
27
|
+
priority: null
|
28
|
+
)
|
29
|
+
```
|
30
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::CustomerWishListItemResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
8
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
9
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
10
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
11
|
+
| **wishlist_item** | [**CustomerWishListItem**](CustomerWishListItem.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::CustomerWishListItemResponse.new(
|
19
|
+
error: null,
|
20
|
+
metadata: null,
|
21
|
+
success: null,
|
22
|
+
warning: null,
|
23
|
+
wishlist_item: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::CustomerWishListItemsResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
8
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
9
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
10
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
11
|
+
| **wishlist_items** | [**Array<CustomerWishListItem>**](CustomerWishListItem.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::CustomerWishListItemsResponse.new(
|
19
|
+
error: null,
|
20
|
+
metadata: null,
|
21
|
+
success: null,
|
22
|
+
warning: null,
|
23
|
+
wishlist_items: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|