ultracart_api 3.1.1 → 3.1.6
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +16 -4
- data/docs/CouponApi.md +2 -2
- data/docs/CustomerApi.md +102 -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/ScreenRecording.md +2 -1
- data/docs/ScreenRecordingPageViewDataResponse.md +12 -0
- data/docs/StorefrontApi.md +2 -2
- data/lib/ultracart_api.rb +5 -0
- data/lib/ultracart_api/api/coupon_api.rb +2 -2
- data/lib/ultracart_api/api/customer_api.rb +110 -0
- data/lib/ultracart_api/api/storefront_api.rb +3 -3
- 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/models/screen_recording_page_view_data_response.rb +221 -0
- data/lib/ultracart_api/version.rb +1 -1
- metadata +12 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: e9b67dd2df18641594c68fa7ee1cbbc179340019de0f069d5d08e706b3e4736b
|
4
|
+
data.tar.gz: 539093bfe2736cfe497f7a61d83d07bdcae6148d534d4a579e092b74a2067018
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: aefe0cd22169ffce3277c99d9245a0cd8141976d84a2737893d3b2074d5810b2b323f00af80234842e762314c2d335d4859dae4b81a1db0e0dfb4d1f189e05a0
|
7
|
+
data.tar.gz: 17bace8885d50b0a38671ba7a585a41894b766b5efb623ba40a7e1fac1a30202fda7b62e840eac1183d4d9143bfcebdfd4353c7862d8630aefd1bf02c9a25f03
|
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.6
|
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.6.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.6.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.6'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -147,9 +147,11 @@ Class | Method | HTTP request | Description
|
|
147
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
|
148
148
|
*UltracartClient::CustomerApi* | [**get_editor_values**](docs/CustomerApi.md#get_editor_values) | **GET** /customer/editor_values | Retrieve values needed for a customer profile editor
|
149
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
|
150
151
|
*UltracartClient::CustomerApi* | [**insert_customer**](docs/CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer
|
151
152
|
*UltracartClient::CustomerApi* | [**update_customer**](docs/CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer
|
152
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
|
153
155
|
*UltracartClient::FulfillmentApi* | [**acknowledge_orders**](docs/FulfillmentApi.md#acknowledge_orders) | **PUT** /fulfillment/distribution_centers/{distribution_center_code}/acknowledgements | Acknowledge receipt of orders.
|
154
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.
|
155
157
|
*UltracartClient::FulfillmentApi* | [**get_distribution_centers**](docs/FulfillmentApi.md#get_distribution_centers) | **GET** /fulfillment/distribution_centers | Retrieve distribution centers
|
@@ -666,6 +668,10 @@ Class | Method | HTTP request | Description
|
|
666
668
|
- [UltracartClient::EmailThirdPartyListImportRequest](docs/EmailThirdPartyListImportRequest.md)
|
667
669
|
- [UltracartClient::EmailThirdPartyProvider](docs/EmailThirdPartyProvider.md)
|
668
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)
|
669
675
|
- [UltracartClient::Error](docs/Error.md)
|
670
676
|
- [UltracartClient::ErrorResponse](docs/ErrorResponse.md)
|
671
677
|
- [UltracartClient::Experiment](docs/Experiment.md)
|
@@ -860,6 +866,7 @@ Class | Method | HTTP request | Description
|
|
860
866
|
- [UltracartClient::ScreenRecordingFilterValuesEventParams](docs/ScreenRecordingFilterValuesEventParams.md)
|
861
867
|
- [UltracartClient::ScreenRecordingMultifield](docs/ScreenRecordingMultifield.md)
|
862
868
|
- [UltracartClient::ScreenRecordingPageView](docs/ScreenRecordingPageView.md)
|
869
|
+
- [UltracartClient::ScreenRecordingPageViewDataResponse](docs/ScreenRecordingPageViewDataResponse.md)
|
863
870
|
- [UltracartClient::ScreenRecordingPageViewEvent](docs/ScreenRecordingPageViewEvent.md)
|
864
871
|
- [UltracartClient::ScreenRecordingPageViewEventParameter](docs/ScreenRecordingPageViewEventParameter.md)
|
865
872
|
- [UltracartClient::ScreenRecordingPageViewParameter](docs/ScreenRecordingPageViewParameter.md)
|
@@ -996,6 +1003,11 @@ Not every change is committed to every SDK.
|
|
996
1003
|
|
997
1004
|
| Version | Date | Comments |
|
998
1005
|
| --: | :-: | --- |
|
1006
|
+
| 3.1.5 | 02/12/2021 | Bug Fix: PHP retry logic missing a closing brace. Also screen recording page view data response refactor |
|
1007
|
+
| 3.1.3 | 02/11/2021 | Bug Fix: wrong return type on CustomerApi.validateEmailVerificationToken |
|
1008
|
+
| 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 |
|
1009
|
+
| 3.1.1 | 02/10/2021 | CustomerApi.getCustomerByEmail() method added |
|
1010
|
+
| 3.1.0 | 02/10/2021 | Minor revision jump. Added new convenience methods for simple_key use to all api calls. Updated docs |
|
999
1011
|
| 3.0.75 | 02/01/2021 | StoreFront Communication plan revision (internal use) |
|
1000
1012
|
| 3.0.71 | 01/28/2021 | BugFix: PHP SDK retry logic NPE |
|
1001
1013
|
| 3.0.70 | 01/26/2021 | Checkout return URL support |
|
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]
|
data/docs/CustomerApi.md
CHANGED
@@ -12,9 +12,11 @@ Method | HTTP request | Description
|
|
12
12
|
[**get_customers_for_data_tables**](CustomerApi.md#get_customers_for_data_tables) | **POST** /customer/customers/dataTables | Retrieve customers for DataTables plugin
|
13
13
|
[**get_editor_values**](CustomerApi.md#get_editor_values) | **GET** /customer/editor_values | Retrieve values needed for a customer profile editor
|
14
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
|
15
16
|
[**insert_customer**](CustomerApi.md#insert_customer) | **POST** /customer/customers | Insert a customer
|
16
17
|
[**update_customer**](CustomerApi.md#update_customer) | **PUT** /customer/customers/{customer_profile_oid} | Update a customer
|
17
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
|
18
20
|
|
19
21
|
|
20
22
|
# **delete_customer**
|
@@ -491,6 +493,56 @@ This endpoint does not need any parameter.
|
|
491
493
|
|
492
494
|
|
493
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
|
+
|
494
546
|
# **insert_customer**
|
495
547
|
> CustomerResponse insert_customer(customer, opts)
|
496
548
|
|
@@ -655,3 +707,53 @@ Name | Type | Description | Notes
|
|
655
707
|
|
656
708
|
|
657
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
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::EmailVerifyTokenResponse
|
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
|
+
**token** | **String** | token | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
@@ -0,0 +1,11 @@
|
|
1
|
+
# UltracartClient::EmailVerifyTokenValidateResponse
|
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
|
+
|
11
|
+
|
data/docs/ScreenRecording.md
CHANGED
@@ -11,7 +11,8 @@ Name | Type | Description | Notes
|
|
11
11
|
**esp_customer_uuid** | **String** | | [optional]
|
12
12
|
**events_gz_size** | **Integer** | | [optional]
|
13
13
|
**events_json_key** | **String** | | [optional]
|
14
|
-
**
|
14
|
+
**favorite** | **BOOLEAN** | True if the user calling the API has favorited this particular screen recording. | [optional]
|
15
|
+
**favorites** | **Array<Integer>** | Array of user ids that favorited this particular screen recording. | [optional]
|
15
16
|
**geolocation** | [**GeoPoint**](GeoPoint.md) | | [optional]
|
16
17
|
**geolocation_country** | **String** | | [optional]
|
17
18
|
**geolocation_state** | **String** | | [optional]
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::ScreenRecordingPageViewDataResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**error** | [**Error**](Error.md) | | [optional]
|
7
|
+
**events_json** | **String** | | [optional]
|
8
|
+
**metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional]
|
9
|
+
**success** | **BOOLEAN** | Indicates if API call was successful | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
data/docs/StorefrontApi.md
CHANGED
@@ -4366,7 +4366,7 @@ Name | Type | Description | Notes
|
|
4366
4366
|
|
4367
4367
|
|
4368
4368
|
# **get_screen_recording_page_view_data**
|
4369
|
-
>
|
4369
|
+
> ScreenRecordingPageViewDataResponse get_screen_recording_page_view_data(storefront_oid, screen_recording_uuid, screen_recording_page_view_uuid)
|
4370
4370
|
|
4371
4371
|
Get screen recording page view data
|
4372
4372
|
|
@@ -4408,7 +4408,7 @@ Name | Type | Description | Notes
|
|
4408
4408
|
|
4409
4409
|
### Return type
|
4410
4410
|
|
4411
|
-
[**
|
4411
|
+
[**ScreenRecordingPageViewDataResponse**](ScreenRecordingPageViewDataResponse.md)
|
4412
4412
|
|
4413
4413
|
### Authorization
|
4414
4414
|
|
data/lib/ultracart_api.rb
CHANGED
@@ -303,6 +303,10 @@ require 'ultracart_api/models/email_third_party_list'
|
|
303
303
|
require 'ultracart_api/models/email_third_party_list_import_request'
|
304
304
|
require 'ultracart_api/models/email_third_party_provider'
|
305
305
|
require 'ultracart_api/models/email_third_party_providers_response'
|
306
|
+
require 'ultracart_api/models/email_verify_token_request'
|
307
|
+
require 'ultracart_api/models/email_verify_token_response'
|
308
|
+
require 'ultracart_api/models/email_verify_token_validate_request'
|
309
|
+
require 'ultracart_api/models/email_verify_token_validate_response'
|
306
310
|
require 'ultracart_api/models/error'
|
307
311
|
require 'ultracart_api/models/error_response'
|
308
312
|
require 'ultracart_api/models/experiment'
|
@@ -497,6 +501,7 @@ require 'ultracart_api/models/screen_recording_filter_values_event'
|
|
497
501
|
require 'ultracart_api/models/screen_recording_filter_values_event_params'
|
498
502
|
require 'ultracart_api/models/screen_recording_multifield'
|
499
503
|
require 'ultracart_api/models/screen_recording_page_view'
|
504
|
+
require 'ultracart_api/models/screen_recording_page_view_data_response'
|
500
505
|
require 'ultracart_api/models/screen_recording_page_view_event'
|
501
506
|
require 'ultracart_api/models/screen_recording_page_view_event_parameter'
|
502
507
|
require 'ultracart_api/models/screen_recording_page_view_parameter'
|
@@ -1034,7 +1034,7 @@ module UltracartClient
|
|
1034
1034
|
end
|
1035
1035
|
# Update multiple coupons
|
1036
1036
|
# Update multiple coupon on the UltraCart account.
|
1037
|
-
# @param coupons_request Coupons to update (synchronous maximum
|
1037
|
+
# @param coupons_request Coupons to update (synchronous maximum 50 / asynchronous maximum 100)
|
1038
1038
|
# @param [Hash] opts the optional parameters
|
1039
1039
|
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
1040
1040
|
# @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
@@ -1047,7 +1047,7 @@ module UltracartClient
|
|
1047
1047
|
|
1048
1048
|
# Update multiple coupons
|
1049
1049
|
# Update multiple coupon on the UltraCart account.
|
1050
|
-
# @param coupons_request Coupons to update (synchronous maximum
|
1050
|
+
# @param coupons_request Coupons to update (synchronous maximum 50 / asynchronous maximum 100)
|
1051
1051
|
# @param [Hash] opts the optional parameters
|
1052
1052
|
# @option opts [String] :_expand The object expansion to perform on the result. See documentation for examples
|
1053
1053
|
# @option opts [BOOLEAN] :_placeholders Whether or not placeholder values should be returned in the result. Useful for UIs that consume this REST API.
|
@@ -568,6 +568,61 @@ module UltracartClient
|
|
568
568
|
end
|
569
569
|
return data, status_code, headers
|
570
570
|
end
|
571
|
+
# Create a token that can be used to verify a customer email address
|
572
|
+
# 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.
|
573
|
+
# @param token_request Token request
|
574
|
+
# @param [Hash] opts the optional parameters
|
575
|
+
# @return [EmailVerifyTokenResponse]
|
576
|
+
def get_email_verification_token(token_request, opts = {})
|
577
|
+
data, _status_code, _headers = get_email_verification_token_with_http_info(token_request, opts)
|
578
|
+
data
|
579
|
+
end
|
580
|
+
|
581
|
+
# Create a token that can be used to verify a customer email address
|
582
|
+
# 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.
|
583
|
+
# @param token_request Token request
|
584
|
+
# @param [Hash] opts the optional parameters
|
585
|
+
# @return [Array<(EmailVerifyTokenResponse, Fixnum, Hash)>] EmailVerifyTokenResponse data, response status code and response headers
|
586
|
+
def get_email_verification_token_with_http_info(token_request, opts = {})
|
587
|
+
if @api_client.config.debugging
|
588
|
+
@api_client.config.logger.debug 'Calling API: CustomerApi.get_email_verification_token ...'
|
589
|
+
end
|
590
|
+
# verify the required parameter 'token_request' is set
|
591
|
+
if @api_client.config.client_side_validation && token_request.nil?
|
592
|
+
fail ArgumentError, "Missing the required parameter 'token_request' when calling CustomerApi.get_email_verification_token"
|
593
|
+
end
|
594
|
+
# resource path
|
595
|
+
local_var_path = '/customer/customers/email_verify/get_token'
|
596
|
+
|
597
|
+
# query parameters
|
598
|
+
query_params = {}
|
599
|
+
|
600
|
+
# header parameters
|
601
|
+
header_params = {}
|
602
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
603
|
+
# HTTP header 'Accept' (if needed)
|
604
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
605
|
+
# HTTP header 'Content-Type'
|
606
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
607
|
+
|
608
|
+
# form parameters
|
609
|
+
form_params = {}
|
610
|
+
|
611
|
+
# http body (model)
|
612
|
+
post_body = @api_client.object_to_http_body(token_request)
|
613
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
614
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
615
|
+
:header_params => header_params,
|
616
|
+
:query_params => query_params,
|
617
|
+
:form_params => form_params,
|
618
|
+
:body => post_body,
|
619
|
+
:auth_names => auth_names,
|
620
|
+
:return_type => 'EmailVerifyTokenResponse')
|
621
|
+
if @api_client.config.debugging
|
622
|
+
@api_client.config.logger.debug "API called: CustomerApi#get_email_verification_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
623
|
+
end
|
624
|
+
return data, status_code, headers
|
625
|
+
end
|
571
626
|
# Insert a customer
|
572
627
|
# Insert a customer on the UltraCart account.
|
573
628
|
# @param customer Customer to insert
|
@@ -751,5 +806,60 @@ module UltracartClient
|
|
751
806
|
end
|
752
807
|
return data, status_code, headers
|
753
808
|
end
|
809
|
+
# Validate a token that can be used to verify a customer email address
|
810
|
+
# 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.
|
811
|
+
# @param validation_request Token validation request
|
812
|
+
# @param [Hash] opts the optional parameters
|
813
|
+
# @return [EmailVerifyTokenValidateResponse]
|
814
|
+
def validate_email_verification_token(validation_request, opts = {})
|
815
|
+
data, _status_code, _headers = validate_email_verification_token_with_http_info(validation_request, opts)
|
816
|
+
data
|
817
|
+
end
|
818
|
+
|
819
|
+
# Validate a token that can be used to verify a customer email address
|
820
|
+
# 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.
|
821
|
+
# @param validation_request Token validation request
|
822
|
+
# @param [Hash] opts the optional parameters
|
823
|
+
# @return [Array<(EmailVerifyTokenValidateResponse, Fixnum, Hash)>] EmailVerifyTokenValidateResponse data, response status code and response headers
|
824
|
+
def validate_email_verification_token_with_http_info(validation_request, opts = {})
|
825
|
+
if @api_client.config.debugging
|
826
|
+
@api_client.config.logger.debug 'Calling API: CustomerApi.validate_email_verification_token ...'
|
827
|
+
end
|
828
|
+
# verify the required parameter 'validation_request' is set
|
829
|
+
if @api_client.config.client_side_validation && validation_request.nil?
|
830
|
+
fail ArgumentError, "Missing the required parameter 'validation_request' when calling CustomerApi.validate_email_verification_token"
|
831
|
+
end
|
832
|
+
# resource path
|
833
|
+
local_var_path = '/customer/customers/email_verify/validate_token'
|
834
|
+
|
835
|
+
# query parameters
|
836
|
+
query_params = {}
|
837
|
+
|
838
|
+
# header parameters
|
839
|
+
header_params = {}
|
840
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
841
|
+
# HTTP header 'Accept' (if needed)
|
842
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
843
|
+
# HTTP header 'Content-Type'
|
844
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
845
|
+
|
846
|
+
# form parameters
|
847
|
+
form_params = {}
|
848
|
+
|
849
|
+
# http body (model)
|
850
|
+
post_body = @api_client.object_to_http_body(validation_request)
|
851
|
+
auth_names = ['ultraCartOauth', 'ultraCartSimpleApiKey']
|
852
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
853
|
+
:header_params => header_params,
|
854
|
+
:query_params => query_params,
|
855
|
+
:form_params => form_params,
|
856
|
+
:body => post_body,
|
857
|
+
:auth_names => auth_names,
|
858
|
+
:return_type => 'EmailVerifyTokenValidateResponse')
|
859
|
+
if @api_client.config.debugging
|
860
|
+
@api_client.config.logger.debug "API called: CustomerApi#validate_email_verification_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
861
|
+
end
|
862
|
+
return data, status_code, headers
|
863
|
+
end
|
754
864
|
end
|
755
865
|
end
|