ultracart_api 3.1.0 → 3.1.5
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +21 -9
- data/docs/AutoOrderApi.md +12 -12
- data/docs/CheckoutApi.md +1 -1
- data/docs/CouponApi.md +2 -2
- data/docs/CouponTieredAmountOffItem.md +1 -1
- data/docs/CouponTieredPercentOffItems.md +1 -1
- data/docs/CustomerApi.md +157 -0
- data/docs/EmailPlanAdditional.md +1 -0
- data/docs/EmailVerifyTokenRequest.md +9 -0
- data/docs/EmailVerifyTokenResponse.md +12 -0
- data/docs/EmailVerifyTokenValidateRequest.md +8 -0
- data/docs/EmailVerifyTokenValidateResponse.md +11 -0
- data/docs/OrderApi.md +3 -3
- data/docs/ScreenRecording.md +2 -1
- data/lib/ultracart_api.rb +4 -0
- data/lib/ultracart_api/api/auto_order_api.rb +8 -8
- data/lib/ultracart_api/api/checkout_api.rb +2 -2
- data/lib/ultracart_api/api/coupon_api.rb +2 -2
- data/lib/ultracart_api/api/customer_api.rb +168 -0
- data/lib/ultracart_api/api/order_api.rb +2 -2
- data/lib/ultracart_api/models/coupon_tiered_amount_off_item.rb +1 -1
- data/lib/ultracart_api/models/coupon_tiered_percent_off_items.rb +1 -1
- data/lib/ultracart_api/models/email_plan_additional.rb +10 -1
- data/lib/ultracart_api/models/email_verify_token_request.rb +195 -0
- data/lib/ultracart_api/models/email_verify_token_response.rb +222 -0
- data/lib/ultracart_api/models/email_verify_token_validate_request.rb +185 -0
- data/lib/ultracart_api/models/email_verify_token_validate_response.rb +212 -0
- data/lib/ultracart_api/models/screen_recording.rb +12 -1
- data/lib/ultracart_api/version.rb +1 -1
- metadata +10 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: cbe3a716091ec080ca1b98dceb24d11f943750ab15eee75d82d49b2afe6d84d4
|
4
|
+
data.tar.gz: ee95d4a3a5875ad45c599ced6810c124a08ab0f6ffbd3d93ec2c0d0b771239a6
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 15db56e7ce000ff22e4171cd8fc6c3ebe087c7757b59c19ceb06b3552b304eded1c84730c730ab6d83897ea1eaa8ce14f0f2fc760bd12d7639a98a07654b8533
|
7
|
+
data.tar.gz: ca1511eeac09bb4768935144c5ed6bbb9dd13d108d0a5e2140c6120414ca9ebefaa50f1b666abeb1bfbddc45cc9718a71bf3a3e6ea4cd60361b1f169e13fb919
|
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.1.
|
10
|
+
- Package version: 3.1.5
|
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.1.
|
27
|
+
gem install ./ultracart_api-3.1.5.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.1.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.1.5.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.1.
|
35
|
+
gem 'ultracart_api', '~> 3.1.5'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -88,12 +88,12 @@ Class | Method | HTTP request | Description
|
|
88
88
|
------------ | ------------- | ------------- | -------------
|
89
89
|
*UltracartClient::AffiliateApi* | [**get_clicks_by_query**](docs/AffiliateApi.md#get_clicks_by_query) | **POST** /affiliate/clicks/query | Retrieve clicks
|
90
90
|
*UltracartClient::AffiliateApi* | [**get_ledgers_by_query**](docs/AffiliateApi.md#get_ledgers_by_query) | **POST** /affiliate/ledgers/query | Retrieve ledger entries
|
91
|
-
*UltracartClient::AutoOrderApi* | [**get_auto_order**](docs/AutoOrderApi.md#get_auto_order) | **GET** /auto_order/auto_orders/{auto_order_oid} | Retrieve an auto order
|
92
|
-
*UltracartClient::AutoOrderApi* | [**get_auto_order_by_code**](docs/AutoOrderApi.md#get_auto_order_by_code) | **GET** /auto_order/auto_orders/code/{auto_order_code} | Retrieve an auto order
|
93
|
-
*UltracartClient::AutoOrderApi* | [**get_auto_order_by_reference_order_id**](docs/AutoOrderApi.md#get_auto_order_by_reference_order_id) | **GET** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Retrieve an auto order
|
91
|
+
*UltracartClient::AutoOrderApi* | [**get_auto_order**](docs/AutoOrderApi.md#get_auto_order) | **GET** /auto_order/auto_orders/{auto_order_oid} | Retrieve an auto order by oid
|
92
|
+
*UltracartClient::AutoOrderApi* | [**get_auto_order_by_code**](docs/AutoOrderApi.md#get_auto_order_by_code) | **GET** /auto_order/auto_orders/code/{auto_order_code} | Retrieve an auto order by code
|
93
|
+
*UltracartClient::AutoOrderApi* | [**get_auto_order_by_reference_order_id**](docs/AutoOrderApi.md#get_auto_order_by_reference_order_id) | **GET** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Retrieve an auto order by order id
|
94
94
|
*UltracartClient::AutoOrderApi* | [**get_auto_orders**](docs/AutoOrderApi.md#get_auto_orders) | **GET** /auto_order/auto_orders | Retrieve auto orders
|
95
95
|
*UltracartClient::AutoOrderApi* | [**get_auto_orders_batch**](docs/AutoOrderApi.md#get_auto_orders_batch) | **POST** /auto_order/auto_orders/batch | Retrieve auto order batch
|
96
|
-
*UltracartClient::AutoOrderApi* | [**get_auto_orders_by_query**](docs/AutoOrderApi.md#get_auto_orders_by_query) | **POST** /auto_order/auto_orders/query | Retrieve auto orders
|
96
|
+
*UltracartClient::AutoOrderApi* | [**get_auto_orders_by_query**](docs/AutoOrderApi.md#get_auto_orders_by_query) | **POST** /auto_order/auto_orders/query | Retrieve auto orders by query
|
97
97
|
*UltracartClient::AutoOrderApi* | [**update_auto_order**](docs/AutoOrderApi.md#update_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid} | Update an auto order
|
98
98
|
*UltracartClient::AutoOrderApi* | [**update_auto_orders_batch**](docs/AutoOrderApi.md#update_auto_orders_batch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders
|
99
99
|
*UltracartClient::ChargebackApi* | [**delete_chargeback**](docs/ChargebackApi.md#delete_chargeback) | **DELETE** /chargeback/chargebacks/{chargeback_dispute_oid} | Delete a chargeback
|
@@ -141,14 +141,17 @@ Class | Method | HTTP request | Description
|
|
141
141
|
*UltracartClient::CouponApi* | [**upload_coupon_codes**](docs/CouponApi.md#upload_coupon_codes) | **POST** /coupon/coupons/{coupon_oid}/upload_codes | Upload one-time codes for a coupon
|
142
142
|
*UltracartClient::CustomerApi* | [**delete_customer**](docs/CustomerApi.md#delete_customer) | **DELETE** /customer/customers/{customer_profile_oid} | Delete a customer
|
143
143
|
*UltracartClient::CustomerApi* | [**get_customer**](docs/CustomerApi.md#get_customer) | **GET** /customer/customers/{customer_profile_oid} | Retrieve a customer
|
144
|
+
*UltracartClient::CustomerApi* | [**get_customer_by_email**](docs/CustomerApi.md#get_customer_by_email) | **GET** /customer/customers/by_email/{email} | Retrieve a customer by Email
|
144
145
|
*UltracartClient::CustomerApi* | [**get_customers**](docs/CustomerApi.md#get_customers) | **GET** /customer/customers | Retrieve customers
|
145
146
|
*UltracartClient::CustomerApi* | [**get_customers_by_query**](docs/CustomerApi.md#get_customers_by_query) | **POST** /customer/customers/query | Retrieve customers by query
|
146
147
|
*UltracartClient::CustomerApi* | [**get_customers_for_data_tables**](docs/CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin
|
147
148
|
*UltracartClient::CustomerApi* | [**get_editor_values**](docs/CustomerApi.md#get_editor_values) | **GET** /customer/editor_values | Retrieve values needed for a customer profile editor
|
148
149
|
*UltracartClient::CustomerApi* | [**get_email_lists**](docs/CustomerApi.md#get_email_lists) | **GET** /customer/email_lists | Retrieve all email lists across all storefronts
|
150
|
+
*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
|
149
151
|
*UltracartClient::CustomerApi* | [**insert_customer**](docs/CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer
|
150
152
|
*UltracartClient::CustomerApi* | [**update_customer**](docs/CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer
|
151
153
|
*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
|
154
|
+
*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
|
152
155
|
*UltracartClient::FulfillmentApi* | [**acknowledge_orders**](docs/FulfillmentApi.md#acknowledge_orders) | **PUT** /fulfillment/distribution_centers/{distribution_center_code}/acknowledgements | Acknowledge receipt of orders.
|
153
156
|
*UltracartClient::FulfillmentApi* | [**get_distribution_center_orders**](docs/FulfillmentApi.md#get_distribution_center_orders) | **GET** /fulfillment/distribution_centers/{distribution_center_code}/orders | Retrieve orders queued up for this distribution center.
|
154
157
|
*UltracartClient::FulfillmentApi* | [**get_distribution_centers**](docs/FulfillmentApi.md#get_distribution_centers) | **GET** /fulfillment/distribution_centers | Retrieve distribution centers
|
@@ -176,7 +179,7 @@ Class | Method | HTTP request | Description
|
|
176
179
|
*UltracartClient::OrderApi* | [**get_order_by_token**](docs/OrderApi.md#get_order_by_token) | **POST** /order/orders/token | Retrieve an order using a token
|
177
180
|
*UltracartClient::OrderApi* | [**get_orders**](docs/OrderApi.md#get_orders) | **GET** /order/orders | Retrieve orders
|
178
181
|
*UltracartClient::OrderApi* | [**get_orders_batch**](docs/OrderApi.md#get_orders_batch) | **POST** /order/orders/batch | Retrieve order batch
|
179
|
-
*UltracartClient::OrderApi* | [**get_orders_by_query**](docs/OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders
|
182
|
+
*UltracartClient::OrderApi* | [**get_orders_by_query**](docs/OrderApi.md#get_orders_by_query) | **POST** /order/orders/query | Retrieve orders by query
|
180
183
|
*UltracartClient::OrderApi* | [**insert_order**](docs/OrderApi.md#insert_order) | **POST** /order/orders | Insert an order
|
181
184
|
*UltracartClient::OrderApi* | [**process_payment**](docs/OrderApi.md#process_payment) | **POST** /order/orders/{order_id}/process_payment | Process payment
|
182
185
|
*UltracartClient::OrderApi* | [**refund_order**](docs/OrderApi.md#refund_order) | **PUT** /order/orders/{order_id}/refund | Refund an order
|
@@ -665,6 +668,10 @@ Class | Method | HTTP request | Description
|
|
665
668
|
- [UltracartClient::EmailThirdPartyListImportRequest](docs/EmailThirdPartyListImportRequest.md)
|
666
669
|
- [UltracartClient::EmailThirdPartyProvider](docs/EmailThirdPartyProvider.md)
|
667
670
|
- [UltracartClient::EmailThirdPartyProvidersResponse](docs/EmailThirdPartyProvidersResponse.md)
|
671
|
+
- [UltracartClient::EmailVerifyTokenRequest](docs/EmailVerifyTokenRequest.md)
|
672
|
+
- [UltracartClient::EmailVerifyTokenResponse](docs/EmailVerifyTokenResponse.md)
|
673
|
+
- [UltracartClient::EmailVerifyTokenValidateRequest](docs/EmailVerifyTokenValidateRequest.md)
|
674
|
+
- [UltracartClient::EmailVerifyTokenValidateResponse](docs/EmailVerifyTokenValidateResponse.md)
|
668
675
|
- [UltracartClient::Error](docs/Error.md)
|
669
676
|
- [UltracartClient::ErrorResponse](docs/ErrorResponse.md)
|
670
677
|
- [UltracartClient::Experiment](docs/Experiment.md)
|
@@ -995,6 +1002,11 @@ Not every change is committed to every SDK.
|
|
995
1002
|
|
996
1003
|
| Version | Date | Comments |
|
997
1004
|
| --: | :-: | --- |
|
1005
|
+
| 3.1.5 | 02/12/2021 | Bug Fix: PHP retry logic missing a closing brace. Also screen recording page view data response refactor |
|
1006
|
+
| 3.1.3 | 02/11/2021 | Bug Fix: wrong return type on CustomerApi.validateEmailVerificationToken |
|
1007
|
+
| 3.1.2 | 02/11/2021 | CustomerApi.getEmailVerificationToken, CustomerApi.validateEmailVerificationToken added to allow for custom email verification. Also added favorite flag to screen recording object |
|
1008
|
+
| 3.1.1 | 02/10/2021 | CustomerApi.getCustomerByEmail() method added |
|
1009
|
+
| 3.1.0 | 02/10/2021 | Minor revision jump. Added new convenience methods for simple_key use to all api calls. Updated docs |
|
998
1010
|
| 3.0.75 | 02/01/2021 | StoreFront Communication plan revision (internal use) |
|
999
1011
|
| 3.0.71 | 01/28/2021 | BugFix: PHP SDK retry logic NPE |
|
1000
1012
|
| 3.0.70 | 01/26/2021 | Checkout return URL support |
|
data/docs/AutoOrderApi.md
CHANGED
@@ -4,12 +4,12 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
4
4
|
|
5
5
|
Method | HTTP request | Description
|
6
6
|
------------- | ------------- | -------------
|
7
|
-
[**get_auto_order**](AutoOrderApi.md#get_auto_order) | **GET** /auto_order/auto_orders/{auto_order_oid} | Retrieve an auto order
|
8
|
-
[**get_auto_order_by_code**](AutoOrderApi.md#get_auto_order_by_code) | **GET** /auto_order/auto_orders/code/{auto_order_code} | Retrieve an auto order
|
9
|
-
[**get_auto_order_by_reference_order_id**](AutoOrderApi.md#get_auto_order_by_reference_order_id) | **GET** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Retrieve an auto order
|
7
|
+
[**get_auto_order**](AutoOrderApi.md#get_auto_order) | **GET** /auto_order/auto_orders/{auto_order_oid} | Retrieve an auto order by oid
|
8
|
+
[**get_auto_order_by_code**](AutoOrderApi.md#get_auto_order_by_code) | **GET** /auto_order/auto_orders/code/{auto_order_code} | Retrieve an auto order by code
|
9
|
+
[**get_auto_order_by_reference_order_id**](AutoOrderApi.md#get_auto_order_by_reference_order_id) | **GET** /auto_order/auto_orders/reference_order_id/{reference_order_id} | Retrieve an auto order by order id
|
10
10
|
[**get_auto_orders**](AutoOrderApi.md#get_auto_orders) | **GET** /auto_order/auto_orders | Retrieve auto orders
|
11
11
|
[**get_auto_orders_batch**](AutoOrderApi.md#get_auto_orders_batch) | **POST** /auto_order/auto_orders/batch | Retrieve auto order batch
|
12
|
-
[**get_auto_orders_by_query**](AutoOrderApi.md#get_auto_orders_by_query) | **POST** /auto_order/auto_orders/query | Retrieve auto orders
|
12
|
+
[**get_auto_orders_by_query**](AutoOrderApi.md#get_auto_orders_by_query) | **POST** /auto_order/auto_orders/query | Retrieve auto orders by query
|
13
13
|
[**update_auto_order**](AutoOrderApi.md#update_auto_order) | **PUT** /auto_order/auto_orders/{auto_order_oid} | Update an auto order
|
14
14
|
[**update_auto_orders_batch**](AutoOrderApi.md#update_auto_orders_batch) | **PUT** /auto_order/auto_orders/batch | Update multiple auto orders
|
15
15
|
|
@@ -17,7 +17,7 @@ Method | HTTP request | Description
|
|
17
17
|
# **get_auto_order**
|
18
18
|
> AutoOrderResponse get_auto_order(auto_order_oid, opts)
|
19
19
|
|
20
|
-
Retrieve an auto order
|
20
|
+
Retrieve an auto order by oid
|
21
21
|
|
22
22
|
Retrieves a single auto order using the specified auto order oid.
|
23
23
|
|
@@ -38,7 +38,7 @@ opts = {
|
|
38
38
|
}
|
39
39
|
|
40
40
|
begin
|
41
|
-
#Retrieve an auto order
|
41
|
+
#Retrieve an auto order by oid
|
42
42
|
result = api_instance.get_auto_order(auto_order_oid, opts)
|
43
43
|
p result
|
44
44
|
rescue UltracartClient::ApiError => e
|
@@ -71,7 +71,7 @@ Name | Type | Description | Notes
|
|
71
71
|
# **get_auto_order_by_code**
|
72
72
|
> AutoOrderResponse get_auto_order_by_code(auto_order_code, opts)
|
73
73
|
|
74
|
-
Retrieve an auto order
|
74
|
+
Retrieve an auto order by code
|
75
75
|
|
76
76
|
Retrieves a single auto order using the specified reference (original) order id.
|
77
77
|
|
@@ -92,7 +92,7 @@ opts = {
|
|
92
92
|
}
|
93
93
|
|
94
94
|
begin
|
95
|
-
#Retrieve an auto order
|
95
|
+
#Retrieve an auto order by code
|
96
96
|
result = api_instance.get_auto_order_by_code(auto_order_code, opts)
|
97
97
|
p result
|
98
98
|
rescue UltracartClient::ApiError => e
|
@@ -125,7 +125,7 @@ Name | Type | Description | Notes
|
|
125
125
|
# **get_auto_order_by_reference_order_id**
|
126
126
|
> AutoOrderResponse get_auto_order_by_reference_order_id(reference_order_id, opts)
|
127
127
|
|
128
|
-
Retrieve an auto order
|
128
|
+
Retrieve an auto order by order id
|
129
129
|
|
130
130
|
Retrieves a single auto order using the specified reference (original) order id.
|
131
131
|
|
@@ -146,7 +146,7 @@ opts = {
|
|
146
146
|
}
|
147
147
|
|
148
148
|
begin
|
149
|
-
#Retrieve an auto order
|
149
|
+
#Retrieve an auto order by order id
|
150
150
|
result = api_instance.get_auto_order_by_reference_order_id(reference_order_id, opts)
|
151
151
|
p result
|
152
152
|
rescue UltracartClient::ApiError => e
|
@@ -328,7 +328,7 @@ Name | Type | Description | Notes
|
|
328
328
|
# **get_auto_orders_by_query**
|
329
329
|
> AutoOrdersResponse get_auto_orders_by_query(auto_order_query, opts)
|
330
330
|
|
331
|
-
Retrieve auto orders
|
331
|
+
Retrieve auto orders by query
|
332
332
|
|
333
333
|
Retrieves a group of auto orders from the account based on a query object. You will need to make multiple API calls in order to retrieve the entire result set since this API performs result set pagination.
|
334
334
|
|
@@ -352,7 +352,7 @@ opts = {
|
|
352
352
|
}
|
353
353
|
|
354
354
|
begin
|
355
|
-
#Retrieve auto orders
|
355
|
+
#Retrieve auto orders by query
|
356
356
|
result = api_instance.get_auto_orders_by_query(auto_order_query, opts)
|
357
357
|
p result
|
358
358
|
rescue UltracartClient::ApiError => e
|
data/docs/CheckoutApi.md
CHANGED
@@ -868,7 +868,7 @@ Name | Type | Description | Notes
|
|
868
868
|
|
869
869
|
Setup Browser Application
|
870
870
|
|
871
|
-
Setup a browser key authenticated application with checkout permissions. This REST call must be made with an authentication scheme that is not browser key. The new application will be linked to the application that makes this call. If this application is disabled / deleted, then so will the application setup by this call. The purpose of this call is to allow an OAuth
|
871
|
+
Setup a browser key authenticated application with checkout permissions. This REST call must be made with an authentication scheme that is not browser key. The new application will be linked to the application that makes this call. If this application is disabled / deleted, then so will the application setup by this call. The purpose of this call is to allow an OAuth application, such as the Wordpress plugin, to setup the proper browser based authentication for the REST checkout API to use.
|
872
872
|
|
873
873
|
### Example
|
874
874
|
```ruby
|
data/docs/CouponApi.md
CHANGED
@@ -947,7 +947,7 @@ simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
|
947
947
|
api_instance = UltracartClient::CouponApi.new_using_api_key(simple_key, false, false)
|
948
948
|
|
949
949
|
|
950
|
-
coupons_request = UltracartClient::CouponsRequest.new # CouponsRequest | Coupons to update (synchronous maximum
|
950
|
+
coupons_request = UltracartClient::CouponsRequest.new # CouponsRequest | Coupons to update (synchronous maximum 50 / asynchronous maximum 100)
|
951
951
|
|
952
952
|
opts = {
|
953
953
|
_expand: '_expand_example', # String | The object expansion to perform on the result. See documentation for examples
|
@@ -968,7 +968,7 @@ end
|
|
968
968
|
|
969
969
|
Name | Type | Description | Notes
|
970
970
|
------------- | ------------- | ------------- | -------------
|
971
|
-
**coupons_request** | [**CouponsRequest**](CouponsRequest.md)| Coupons to update (synchronous maximum
|
971
|
+
**coupons_request** | [**CouponsRequest**](CouponsRequest.md)| Coupons to update (synchronous maximum 50 / asynchronous maximum 100) |
|
972
972
|
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
973
973
|
**_placeholders** | **BOOLEAN**| Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API. | [optional]
|
974
974
|
**_async** | **BOOLEAN**| True if the operation should be run async. No result returned | [optional]
|
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**item** | **String** | The item being discounted by this coupon. | [optional]
|
7
|
-
**limit** | **Float** | The maximum
|
7
|
+
**limit** | **Float** | The maximum number of discounted items. | [optional]
|
8
8
|
**tiers** | [**Array<CouponTierQuantityAmount>**](CouponTierQuantityAmount.md) | A list of discount tiers. | [optional]
|
9
9
|
|
10
10
|
|
@@ -4,7 +4,7 @@
|
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
6
|
**items** | **Array<String>** | A list of items of which at least one must be purchased for coupon to be valid. | [optional]
|
7
|
-
**limit** | **Float** | The maximum
|
7
|
+
**limit** | **Float** | The (optional) maximum quantity of discounted items. | [optional]
|
8
8
|
**tiers** | [**Array<CouponTierQuantityPercent>**](CouponTierQuantityPercent.md) | A list of discount tiers. | [optional]
|
9
9
|
|
10
10
|
|
data/docs/CustomerApi.md
CHANGED
@@ -6,14 +6,17 @@ Method | HTTP request | Description
|
|
6
6
|
------------- | ------------- | -------------
|
7
7
|
[**delete_customer**](CustomerApi.md#delete_customer) | **DELETE** /customer/customers/{customer_profile_oid} | Delete a customer
|
8
8
|
[**get_customer**](CustomerApi.md#get_customer) | **GET** /customer/customers/{customer_profile_oid} | Retrieve a customer
|
9
|
+
[**get_customer_by_email**](CustomerApi.md#get_customer_by_email) | **GET** /customer/customers/by_email/{email} | Retrieve a customer by Email
|
9
10
|
[**get_customers**](CustomerApi.md#get_customers) | **GET** /customer/customers | Retrieve customers
|
10
11
|
[**get_customers_by_query**](CustomerApi.md#get_customers_by_query) | **POST** /customer/customers/query | Retrieve customers by query
|
11
12
|
[**get_customers_for_data_tables**](CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin
|
12
13
|
[**get_editor_values**](CustomerApi.md#get_editor_values) | **GET** /customer/editor_values | Retrieve values needed for a customer profile editor
|
13
14
|
[**get_email_lists**](CustomerApi.md#get_email_lists) | **GET** /customer/email_lists | Retrieve all email lists across all storefronts
|
15
|
+
[**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
|
14
16
|
[**insert_customer**](CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer
|
15
17
|
[**update_customer**](CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer
|
16
18
|
[**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
|
19
|
+
[**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
|
17
20
|
|
18
21
|
|
19
22
|
# **delete_customer**
|
@@ -120,6 +123,60 @@ Name | Type | Description | Notes
|
|
120
123
|
|
121
124
|
|
122
125
|
|
126
|
+
# **get_customer_by_email**
|
127
|
+
> CustomerResponse get_customer_by_email(email, opts)
|
128
|
+
|
129
|
+
Retrieve a customer by Email
|
130
|
+
|
131
|
+
Retrieves a single customer using the specified customer email address.
|
132
|
+
|
133
|
+
### Example
|
134
|
+
```ruby
|
135
|
+
# load the gem
|
136
|
+
require 'ultracart_api'
|
137
|
+
|
138
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
139
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
140
|
+
api_instance = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
|
141
|
+
|
142
|
+
|
143
|
+
email = 'email_example' # String | The email address of the customer to retrieve.
|
144
|
+
|
145
|
+
opts = {
|
146
|
+
_expand: '_expand_example' # String | The object expansion to perform on the result. See documentation for examples
|
147
|
+
}
|
148
|
+
|
149
|
+
begin
|
150
|
+
#Retrieve a customer by Email
|
151
|
+
result = api_instance.get_customer_by_email(email, opts)
|
152
|
+
p result
|
153
|
+
rescue UltracartClient::ApiError => e
|
154
|
+
puts "Exception when calling CustomerApi->get_customer_by_email: #{e}"
|
155
|
+
end
|
156
|
+
```
|
157
|
+
|
158
|
+
### Parameters
|
159
|
+
|
160
|
+
Name | Type | Description | Notes
|
161
|
+
------------- | ------------- | ------------- | -------------
|
162
|
+
**email** | **String**| The email address of the customer to retrieve. |
|
163
|
+
**_expand** | **String**| The object expansion to perform on the result. See documentation for examples | [optional]
|
164
|
+
|
165
|
+
### Return type
|
166
|
+
|
167
|
+
[**CustomerResponse**](CustomerResponse.md)
|
168
|
+
|
169
|
+
### Authorization
|
170
|
+
|
171
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
172
|
+
|
173
|
+
### HTTP request headers
|
174
|
+
|
175
|
+
- **Content-Type**: application/json
|
176
|
+
- **Accept**: application/json
|
177
|
+
|
178
|
+
|
179
|
+
|
123
180
|
# **get_customers**
|
124
181
|
> CustomersResponse get_customers(opts)
|
125
182
|
|
@@ -436,6 +493,56 @@ This endpoint does not need any parameter.
|
|
436
493
|
|
437
494
|
|
438
495
|
|
496
|
+
# **get_email_verification_token**
|
497
|
+
> EmailVerifyTokenResponse get_email_verification_token(token_request)
|
498
|
+
|
499
|
+
Create a token that can be used to verify a customer email address
|
500
|
+
|
501
|
+
Create a token that can be used to verify a customer email address. The implementation of how a customer interacts with this token is left to the merchant.
|
502
|
+
|
503
|
+
### Example
|
504
|
+
```ruby
|
505
|
+
# load the gem
|
506
|
+
require 'ultracart_api'
|
507
|
+
|
508
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
509
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
510
|
+
api_instance = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
|
511
|
+
|
512
|
+
|
513
|
+
token_request = UltracartClient::EmailVerifyTokenRequest.new # EmailVerifyTokenRequest | Token request
|
514
|
+
|
515
|
+
|
516
|
+
begin
|
517
|
+
#Create a token that can be used to verify a customer email address
|
518
|
+
result = api_instance.get_email_verification_token(token_request)
|
519
|
+
p result
|
520
|
+
rescue UltracartClient::ApiError => e
|
521
|
+
puts "Exception when calling CustomerApi->get_email_verification_token: #{e}"
|
522
|
+
end
|
523
|
+
```
|
524
|
+
|
525
|
+
### Parameters
|
526
|
+
|
527
|
+
Name | Type | Description | Notes
|
528
|
+
------------- | ------------- | ------------- | -------------
|
529
|
+
**token_request** | [**EmailVerifyTokenRequest**](EmailVerifyTokenRequest.md)| Token request |
|
530
|
+
|
531
|
+
### Return type
|
532
|
+
|
533
|
+
[**EmailVerifyTokenResponse**](EmailVerifyTokenResponse.md)
|
534
|
+
|
535
|
+
### Authorization
|
536
|
+
|
537
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
538
|
+
|
539
|
+
### HTTP request headers
|
540
|
+
|
541
|
+
- **Content-Type**: application/json
|
542
|
+
- **Accept**: application/json
|
543
|
+
|
544
|
+
|
545
|
+
|
439
546
|
# **insert_customer**
|
440
547
|
> CustomerResponse insert_customer(customer, opts)
|
441
548
|
|
@@ -600,3 +707,53 @@ Name | Type | Description | Notes
|
|
600
707
|
|
601
708
|
|
602
709
|
|
710
|
+
# **validate_email_verification_token**
|
711
|
+
> EmailVerifyTokenValidateResponse validate_email_verification_token(validation_request)
|
712
|
+
|
713
|
+
Validate a token that can be used to verify a customer email address
|
714
|
+
|
715
|
+
Validate a token that can be used to verify a customer email address. The implementation of how a customer interacts with this token is left to the merchant.
|
716
|
+
|
717
|
+
### Example
|
718
|
+
```ruby
|
719
|
+
# load the gem
|
720
|
+
require 'ultracart_api'
|
721
|
+
|
722
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
723
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
724
|
+
api_instance = UltracartClient::CustomerApi.new_using_api_key(simple_key, false, false)
|
725
|
+
|
726
|
+
|
727
|
+
validation_request = UltracartClient::EmailVerifyTokenValidateRequest.new # EmailVerifyTokenValidateRequest | Token validation request
|
728
|
+
|
729
|
+
|
730
|
+
begin
|
731
|
+
#Validate a token that can be used to verify a customer email address
|
732
|
+
result = api_instance.validate_email_verification_token(validation_request)
|
733
|
+
p result
|
734
|
+
rescue UltracartClient::ApiError => e
|
735
|
+
puts "Exception when calling CustomerApi->validate_email_verification_token: #{e}"
|
736
|
+
end
|
737
|
+
```
|
738
|
+
|
739
|
+
### Parameters
|
740
|
+
|
741
|
+
Name | Type | Description | Notes
|
742
|
+
------------- | ------------- | ------------- | -------------
|
743
|
+
**validation_request** | [**EmailVerifyTokenValidateRequest**](EmailVerifyTokenValidateRequest.md)| Token validation request |
|
744
|
+
|
745
|
+
### Return type
|
746
|
+
|
747
|
+
[**EmailVerifyTokenValidateResponse**](EmailVerifyTokenValidateResponse.md)
|
748
|
+
|
749
|
+
### Authorization
|
750
|
+
|
751
|
+
[ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
752
|
+
|
753
|
+
### HTTP request headers
|
754
|
+
|
755
|
+
- **Content-Type**: application/json
|
756
|
+
- **Accept**: application/json
|
757
|
+
|
758
|
+
|
759
|
+
|
data/docs/EmailPlanAdditional.md
CHANGED
@@ -3,6 +3,7 @@
|
|
3
3
|
## Properties
|
4
4
|
Name | Type | Description | Notes
|
5
5
|
------------ | ------------- | ------------- | -------------
|
6
|
+
**active** | **BOOLEAN** | | [optional]
|
6
7
|
**can_downgrade** | **BOOLEAN** | | [optional]
|
7
8
|
**can_upgrade** | **BOOLEAN** | | [optional]
|
8
9
|
**cost** | **Float** | | [optional]
|