ultracart_api 3.10.43 → 3.10.46
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/EmailPostcardTracking.md +32 -0
- data/docs/EmailPostcardTrackingResponse.md +12 -0
- data/docs/EmailSettings.md +1 -0
- data/docs/RulerValidationRequest.md +8 -0
- data/docs/RulerValidationResponse.md +9 -0
- data/docs/StorefrontApi.md +101 -0
- data/lib/ultracart_api/api/storefront_api.rb +112 -0
- data/lib/ultracart_api/models/email_postcard_tracking.rb +404 -0
- data/lib/ultracart_api/models/email_postcard_tracking_response.rb +221 -0
- data/lib/ultracart_api/models/email_settings.rb +11 -1
- data/lib/ultracart_api/models/ruler_validation_request.rb +184 -0
- data/lib/ultracart_api/models/ruler_validation_response.rb +193 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +4 -0
- 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: 377b9d095f723be07c9afffb03549128473ca5d53d2db8166589f5b1927f3c7a
|
4
|
+
data.tar.gz: c9798b40411f46e8a96ddfc213582bee2f6b5147c24c66a42ad842b4171149e8
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 87e752a22dc48d8d6f2803e37717c0ec756044c467beb0fa8de4edade1573074718fc3acede9530c5a866ece6af81628bc925626720f491163087e877c0192f2
|
7
|
+
data.tar.gz: dfeb897c6054f77b3f11b35e09dcec872b72955056a4f823f14cb60e964da372c099b0bdb2d0edf37543aa737866bee268e824195873e462cb3914272f597d21
|
data/README.md
CHANGED
@@ -7,7 +7,7 @@ UltraCart REST API Version 2
|
|
7
7
|
This SDK is automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:
|
8
8
|
|
9
9
|
- API version: 2.0.0
|
10
|
-
- Package version: 3.10.
|
10
|
+
- Package version: 3.10.46
|
11
11
|
- Build package: io.swagger.codegen.languages.RubyClientCodegen
|
12
12
|
For more information, please visit [http://www.ultracart.com](http://www.ultracart.com)
|
13
13
|
|
@@ -24,15 +24,15 @@ gem build ultracart_api.gemspec
|
|
24
24
|
Then either install the gem locally:
|
25
25
|
|
26
26
|
```shell
|
27
|
-
gem install ./ultracart_api-3.10.
|
27
|
+
gem install ./ultracart_api-3.10.46.gem
|
28
28
|
```
|
29
|
-
(for development, run `gem install --dev ./ultracart_api-3.10.
|
29
|
+
(for development, run `gem install --dev ./ultracart_api-3.10.46.gem` to install the development dependencies)
|
30
30
|
|
31
31
|
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
32
32
|
|
33
33
|
Finally add this to the Gemfile:
|
34
34
|
|
35
|
-
gem 'ultracart_api', '~> 3.10.
|
35
|
+
gem 'ultracart_api', '~> 3.10.46'
|
36
36
|
|
37
37
|
### Install from Git
|
38
38
|
|
@@ -269,6 +269,7 @@ Class | Method | HTTP request | Description
|
|
269
269
|
*UltracartClient::StorefrontApi* | [**get_email_commseq**](docs/StorefrontApi.md#get_email_commseq) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid} | Get email commseq
|
270
270
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_email_stats**](docs/StorefrontApi.md#get_email_commseq_email_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/emailStats | Get email communication sequence emails stats
|
271
271
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_postcard_stats**](docs/StorefrontApi.md#get_email_commseq_postcard_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/postcardStats | Get email communication sequence postcard stats
|
272
|
+
*UltracartClient::StorefrontApi* | [**get_email_commseq_postcard_tracking**](docs/StorefrontApi.md#get_email_commseq_postcard_tracking) | **GET** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking | Get email communication postcard tracking
|
272
273
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_stat_overall**](docs/StorefrontApi.md#get_email_commseq_stat_overall) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Get communication sequence stats overall
|
273
274
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_step_stats**](docs/StorefrontApi.md#get_email_commseq_step_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stepStats | Get email communication sequence step stats
|
274
275
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_step_waiting**](docs/StorefrontApi.md#get_email_commseq_step_waiting) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting | Get email communication sequence customers waiting at each requested step
|
@@ -393,6 +394,7 @@ Class | Method | HTTP request | Description
|
|
393
394
|
*UltracartClient::StorefrontApi* | [**update_screen_recording_tags**](docs/StorefrontApi.md#update_screen_recording_tags) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/tags | Update tags on a screen recording
|
394
395
|
*UltracartClient::StorefrontApi* | [**update_transaction_email**](docs/StorefrontApi.md#update_transaction_email) | **PUT** /storefront/{storefront_oid}/transaction_email/list/{email_id} | Updates a transaction email object
|
395
396
|
*UltracartClient::StorefrontApi* | [**update_twilio_account**](docs/StorefrontApi.md#update_twilio_account) | **PUT** /storefront/twilio/accounts/{esp_twilio_uuid} | Update Twilio account
|
397
|
+
*UltracartClient::StorefrontApi* | [**validate_ruler**](docs/StorefrontApi.md#validate_ruler) | **POST** /storefront/ruler/validate | Validate AWS Event Ruler
|
396
398
|
*UltracartClient::TaxApi* | [**delete_tax_provider_self_city**](docs/TaxApi.md#delete_tax_provider_self_city) | **DELETE** /tax/providers/self/city/{city} | Deletes a Self tax provider city
|
397
399
|
*UltracartClient::TaxApi* | [**delete_tax_provider_self_country**](docs/TaxApi.md#delete_tax_provider_self_country) | **DELETE** /tax/providers/self/country/{countryCode} | Deletes a Self tax provider country
|
398
400
|
*UltracartClient::TaxApi* | [**delete_tax_provider_self_county**](docs/TaxApi.md#delete_tax_provider_self_county) | **DELETE** /tax/providers/self/county/{county} | Deletes a Self tax provider county
|
@@ -763,6 +765,8 @@ Class | Method | HTTP request | Description
|
|
763
765
|
- [UltracartClient::EmailPlanAdditional](docs/EmailPlanAdditional.md)
|
764
766
|
- [UltracartClient::EmailPlanResponse](docs/EmailPlanResponse.md)
|
765
767
|
- [UltracartClient::EmailPostcardStat](docs/EmailPostcardStat.md)
|
768
|
+
- [UltracartClient::EmailPostcardTracking](docs/EmailPostcardTracking.md)
|
769
|
+
- [UltracartClient::EmailPostcardTrackingResponse](docs/EmailPostcardTrackingResponse.md)
|
766
770
|
- [UltracartClient::EmailSegment](docs/EmailSegment.md)
|
767
771
|
- [UltracartClient::EmailSegmentArchiveResponse](docs/EmailSegmentArchiveResponse.md)
|
768
772
|
- [UltracartClient::EmailSegmentCustomer](docs/EmailSegmentCustomer.md)
|
@@ -994,6 +998,8 @@ Class | Method | HTTP request | Description
|
|
994
998
|
- [UltracartClient::RegisterAffiliateClickResponse](docs/RegisterAffiliateClickResponse.md)
|
995
999
|
- [UltracartClient::ResponseMetadata](docs/ResponseMetadata.md)
|
996
1000
|
- [UltracartClient::ResultSet](docs/ResultSet.md)
|
1001
|
+
- [UltracartClient::RulerValidationRequest](docs/RulerValidationRequest.md)
|
1002
|
+
- [UltracartClient::RulerValidationResponse](docs/RulerValidationResponse.md)
|
997
1003
|
- [UltracartClient::ScreenRecording](docs/ScreenRecording.md)
|
998
1004
|
- [UltracartClient::ScreenRecordingAdPlatform](docs/ScreenRecordingAdPlatform.md)
|
999
1005
|
- [UltracartClient::ScreenRecordingFilter](docs/ScreenRecordingFilter.md)
|
@@ -1179,6 +1185,9 @@ Not every change is committed to every SDK.
|
|
1179
1185
|
|
1180
1186
|
| Version | Date | Comments |
|
1181
1187
|
| --: | :-: | --- |
|
1188
|
+
| 3.10.46 | 09/13/2022 | storefront comms - postcard tracking |
|
1189
|
+
| 3.10.45 | 09/12/2022 | storefront comm - send back reviews.io configured flag on getEmailSettings |
|
1190
|
+
| 3.10.44 | 09/07/2022 | sf comms - using aws event ruler for bigquery segmentation validation |
|
1182
1191
|
| 3.10.43 | 09/02/2022 | customer editor added loyal ledger descriptions |
|
1183
1192
|
| 3.10.42 | 08/30/2022 | storefront comm fields for sms configuration |
|
1184
1193
|
| 3.10.41 | 08/26/2022 | postcard address fields for comm sequence testing |
|
@@ -0,0 +1,32 @@
|
|
1
|
+
# UltracartClient::EmailPostcardTracking
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
Name | Type | Description | Notes
|
5
|
+
------------ | ------------- | ------------- | -------------
|
6
|
+
**commseq_postcard_uuid** | **String** | | [optional]
|
7
|
+
**commseq_step_uuid** | **String** | | [optional]
|
8
|
+
**commseq_uuid** | **String** | | [optional]
|
9
|
+
**conversion_dts** | **String** | Conversion date time. | [optional]
|
10
|
+
**cost** | **Float** | | [optional]
|
11
|
+
**customer_uuid** | **String** | | [optional]
|
12
|
+
**delivered_dts** | **String** | Delivered date time. | [optional]
|
13
|
+
**from_address_line1** | **String** | | [optional]
|
14
|
+
**from_address_line2** | **String** | | [optional]
|
15
|
+
**from_city** | **String** | | [optional]
|
16
|
+
**from_name** | **String** | | [optional]
|
17
|
+
**from_state** | **String** | | [optional]
|
18
|
+
**from_zip** | **String** | | [optional]
|
19
|
+
**mailed_dts** | **String** | Mailed date time. | [optional]
|
20
|
+
**order_id** | **String** | | [optional]
|
21
|
+
**postcard_tracking_uuid** | **String** | | [optional]
|
22
|
+
**status** | **String** | | [optional]
|
23
|
+
**submit_dts** | **String** | Submit date time. | [optional]
|
24
|
+
**to_address_line1** | **String** | | [optional]
|
25
|
+
**to_address_line2** | **String** | | [optional]
|
26
|
+
**to_city** | **String** | | [optional]
|
27
|
+
**to_name** | **String** | | [optional]
|
28
|
+
**to_state** | **String** | | [optional]
|
29
|
+
**to_zip** | **String** | | [optional]
|
30
|
+
**tracking_description** | **String** | | [optional]
|
31
|
+
|
32
|
+
|
@@ -0,0 +1,12 @@
|
|
1
|
+
# UltracartClient::EmailPostcardTrackingResponse
|
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
|
+
**tracking** | [**EmailPostcardTracking**](EmailPostcardTracking.md) | | [optional]
|
10
|
+
**warning** | [**Warning**](Warning.md) | | [optional]
|
11
|
+
|
12
|
+
|
data/docs/EmailSettings.md
CHANGED
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
|
|
12
12
|
**postcard_from_name** | **String** | | [optional]
|
13
13
|
**postcard_from_postal_code** | **String** | | [optional]
|
14
14
|
**postcard_from_state** | **String** | | [optional]
|
15
|
+
**reviews_io_configured** | **BOOLEAN** | True if the Reviews.io integration is configured | [optional]
|
15
16
|
**sms_esp_twilio_uuid** | **String** | | [optional]
|
16
17
|
**sms_phone_number** | **String** | | [optional]
|
17
18
|
**transactional_esp_domain_user** | **String** | | [optional]
|
data/docs/StorefrontApi.md
CHANGED
@@ -44,6 +44,7 @@ Method | HTTP request | Description
|
|
44
44
|
[**get_email_commseq**](StorefrontApi.md#get_email_commseq) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid} | Get email commseq
|
45
45
|
[**get_email_commseq_email_stats**](StorefrontApi.md#get_email_commseq_email_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/emailStats | Get email communication sequence emails stats
|
46
46
|
[**get_email_commseq_postcard_stats**](StorefrontApi.md#get_email_commseq_postcard_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/postcardStats | Get email communication sequence postcard stats
|
47
|
+
[**get_email_commseq_postcard_tracking**](StorefrontApi.md#get_email_commseq_postcard_tracking) | **GET** /storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking | Get email communication postcard tracking
|
47
48
|
[**get_email_commseq_stat_overall**](StorefrontApi.md#get_email_commseq_stat_overall) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stat | Get communication sequence stats overall
|
48
49
|
[**get_email_commseq_step_stats**](StorefrontApi.md#get_email_commseq_step_stats) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/stepStats | Get email communication sequence step stats
|
49
50
|
[**get_email_commseq_step_waiting**](StorefrontApi.md#get_email_commseq_step_waiting) | **POST** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/waiting | Get email communication sequence customers waiting at each requested step
|
@@ -168,6 +169,7 @@ Method | HTTP request | Description
|
|
168
169
|
[**update_screen_recording_tags**](StorefrontApi.md#update_screen_recording_tags) | **POST** /storefront/{storefront_oid}/screen_recordings/{screen_recording_uuid}/tags | Update tags on a screen recording
|
169
170
|
[**update_transaction_email**](StorefrontApi.md#update_transaction_email) | **PUT** /storefront/{storefront_oid}/transaction_email/list/{email_id} | Updates a transaction email object
|
170
171
|
[**update_twilio_account**](StorefrontApi.md#update_twilio_account) | **PUT** /storefront/twilio/accounts/{esp_twilio_uuid} | Update Twilio account
|
172
|
+
[**validate_ruler**](StorefrontApi.md#validate_ruler) | **POST** /storefront/ruler/validate | Validate AWS Event Ruler
|
171
173
|
|
172
174
|
|
173
175
|
# **add_to_library**
|
@@ -2189,6 +2191,57 @@ Name | Type | Description | Notes
|
|
2189
2191
|
|
2190
2192
|
|
2191
2193
|
|
2194
|
+
# **get_email_commseq_postcard_tracking**
|
2195
|
+
> EmailPostcardTrackingResponse get_email_commseq_postcard_tracking(storefront_oid, commseq_postcard_uuid)
|
2196
|
+
|
2197
|
+
Get email communication postcard tracking
|
2198
|
+
|
2199
|
+
### Example
|
2200
|
+
```ruby
|
2201
|
+
# load the gem
|
2202
|
+
require 'ultracart_api'
|
2203
|
+
|
2204
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
2205
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
2206
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
2207
|
+
|
2208
|
+
|
2209
|
+
storefront_oid = 56 # Integer |
|
2210
|
+
|
2211
|
+
commseq_postcard_uuid = 'commseq_postcard_uuid_example' # String |
|
2212
|
+
|
2213
|
+
|
2214
|
+
begin
|
2215
|
+
#Get email communication postcard tracking
|
2216
|
+
result = api_instance.get_email_commseq_postcard_tracking(storefront_oid, commseq_postcard_uuid)
|
2217
|
+
p result
|
2218
|
+
rescue UltracartClient::ApiError => e
|
2219
|
+
puts "Exception when calling StorefrontApi->get_email_commseq_postcard_tracking: #{e}"
|
2220
|
+
end
|
2221
|
+
```
|
2222
|
+
|
2223
|
+
### Parameters
|
2224
|
+
|
2225
|
+
Name | Type | Description | Notes
|
2226
|
+
------------- | ------------- | ------------- | -------------
|
2227
|
+
**storefront_oid** | **Integer**| |
|
2228
|
+
**commseq_postcard_uuid** | **String**| |
|
2229
|
+
|
2230
|
+
### Return type
|
2231
|
+
|
2232
|
+
[**EmailPostcardTrackingResponse**](EmailPostcardTrackingResponse.md)
|
2233
|
+
|
2234
|
+
### Authorization
|
2235
|
+
|
2236
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
2237
|
+
|
2238
|
+
### HTTP request headers
|
2239
|
+
|
2240
|
+
- **Content-Type**: application/json
|
2241
|
+
- **Accept**: application/json
|
2242
|
+
|
2243
|
+
|
2244
|
+
|
2192
2245
|
# **get_email_commseq_stat_overall**
|
2193
2246
|
> EmailCommseqStatResponse get_email_commseq_stat_overall(storefront_oid, commseq_uuid)
|
2194
2247
|
|
@@ -8622,3 +8675,51 @@ Name | Type | Description | Notes
|
|
8622
8675
|
|
8623
8676
|
|
8624
8677
|
|
8678
|
+
# **validate_ruler**
|
8679
|
+
> RulerValidationResponse validate_ruler(ruler_validate_request)
|
8680
|
+
|
8681
|
+
Validate AWS Event Ruler
|
8682
|
+
|
8683
|
+
### Example
|
8684
|
+
```ruby
|
8685
|
+
# load the gem
|
8686
|
+
require 'ultracart_api'
|
8687
|
+
|
8688
|
+
# Create a Simple Key: https://ultracart.atlassian.net/wiki/spaces/ucdoc/pages/38688545/API+Simple+Key
|
8689
|
+
simple_key = '109ee846ee69f50177018ab12f008a00748a25aa28dbdc0177018ab12f008a00'
|
8690
|
+
api_instance = UltracartClient::StorefrontApi.new_using_api_key(simple_key, false, false)
|
8691
|
+
|
8692
|
+
|
8693
|
+
ruler_validate_request = UltracartClient::RulerValidationRequest.new # RulerValidationRequest | Ruler Validate Request
|
8694
|
+
|
8695
|
+
|
8696
|
+
begin
|
8697
|
+
#Validate AWS Event Ruler
|
8698
|
+
result = api_instance.validate_ruler(ruler_validate_request)
|
8699
|
+
p result
|
8700
|
+
rescue UltracartClient::ApiError => e
|
8701
|
+
puts "Exception when calling StorefrontApi->validate_ruler: #{e}"
|
8702
|
+
end
|
8703
|
+
```
|
8704
|
+
|
8705
|
+
### Parameters
|
8706
|
+
|
8707
|
+
Name | Type | Description | Notes
|
8708
|
+
------------- | ------------- | ------------- | -------------
|
8709
|
+
**ruler_validate_request** | [**RulerValidationRequest**](RulerValidationRequest.md)| Ruler Validate Request |
|
8710
|
+
|
8711
|
+
### Return type
|
8712
|
+
|
8713
|
+
[**RulerValidationResponse**](RulerValidationResponse.md)
|
8714
|
+
|
8715
|
+
### Authorization
|
8716
|
+
|
8717
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
8718
|
+
|
8719
|
+
### HTTP request headers
|
8720
|
+
|
8721
|
+
- **Content-Type**: application/json
|
8722
|
+
- **Accept**: application/json
|
8723
|
+
|
8724
|
+
|
8725
|
+
|
@@ -2339,6 +2339,65 @@ module UltracartClient
|
|
2339
2339
|
end
|
2340
2340
|
return data, status_code, headers
|
2341
2341
|
end
|
2342
|
+
# Get email communication postcard tracking
|
2343
|
+
# @param storefront_oid
|
2344
|
+
# @param commseq_postcard_uuid
|
2345
|
+
# @param [Hash] opts the optional parameters
|
2346
|
+
# @return [EmailPostcardTrackingResponse]
|
2347
|
+
def get_email_commseq_postcard_tracking(storefront_oid, commseq_postcard_uuid, opts = {})
|
2348
|
+
data, _status_code, _headers = get_email_commseq_postcard_tracking_with_http_info(storefront_oid, commseq_postcard_uuid, opts)
|
2349
|
+
data
|
2350
|
+
end
|
2351
|
+
|
2352
|
+
# Get email communication postcard tracking
|
2353
|
+
# @param storefront_oid
|
2354
|
+
# @param commseq_postcard_uuid
|
2355
|
+
# @param [Hash] opts the optional parameters
|
2356
|
+
# @return [Array<(EmailPostcardTrackingResponse, Fixnum, Hash)>] EmailPostcardTrackingResponse data, response status code and response headers
|
2357
|
+
def get_email_commseq_postcard_tracking_with_http_info(storefront_oid, commseq_postcard_uuid, opts = {})
|
2358
|
+
if @api_client.config.debugging
|
2359
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq_postcard_tracking ...'
|
2360
|
+
end
|
2361
|
+
# verify the required parameter 'storefront_oid' is set
|
2362
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
2363
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_commseq_postcard_tracking"
|
2364
|
+
end
|
2365
|
+
# verify the required parameter 'commseq_postcard_uuid' is set
|
2366
|
+
if @api_client.config.client_side_validation && commseq_postcard_uuid.nil?
|
2367
|
+
fail ArgumentError, "Missing the required parameter 'commseq_postcard_uuid' when calling StorefrontApi.get_email_commseq_postcard_tracking"
|
2368
|
+
end
|
2369
|
+
# resource path
|
2370
|
+
local_var_path = '/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking'.sub('{' + 'storefront_oid' + '}', storefront_oid.to_s).sub('{' + 'commseq_postcard_uuid' + '}', commseq_postcard_uuid.to_s)
|
2371
|
+
|
2372
|
+
# query parameters
|
2373
|
+
query_params = {}
|
2374
|
+
|
2375
|
+
# header parameters
|
2376
|
+
header_params = {}
|
2377
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
2378
|
+
# HTTP header 'Accept' (if needed)
|
2379
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2380
|
+
# HTTP header 'Content-Type'
|
2381
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
2382
|
+
|
2383
|
+
# form parameters
|
2384
|
+
form_params = {}
|
2385
|
+
|
2386
|
+
# http body (model)
|
2387
|
+
post_body = nil
|
2388
|
+
auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
2389
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path,
|
2390
|
+
:header_params => header_params,
|
2391
|
+
:query_params => query_params,
|
2392
|
+
:form_params => form_params,
|
2393
|
+
:body => post_body,
|
2394
|
+
:auth_names => auth_names,
|
2395
|
+
:return_type => 'EmailPostcardTrackingResponse')
|
2396
|
+
if @api_client.config.debugging
|
2397
|
+
@api_client.config.logger.debug "API called: StorefrontApi#get_email_commseq_postcard_tracking\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2398
|
+
end
|
2399
|
+
return data, status_code, headers
|
2400
|
+
end
|
2342
2401
|
# Get communication sequence stats overall
|
2343
2402
|
# @param storefront_oid
|
2344
2403
|
# @param commseq_uuid
|
@@ -9725,5 +9784,58 @@ module UltracartClient
|
|
9725
9784
|
end
|
9726
9785
|
return data, status_code, headers
|
9727
9786
|
end
|
9787
|
+
# Validate AWS Event Ruler
|
9788
|
+
# @param ruler_validate_request Ruler Validate Request
|
9789
|
+
# @param [Hash] opts the optional parameters
|
9790
|
+
# @return [RulerValidationResponse]
|
9791
|
+
def validate_ruler(ruler_validate_request, opts = {})
|
9792
|
+
data, _status_code, _headers = validate_ruler_with_http_info(ruler_validate_request, opts)
|
9793
|
+
data
|
9794
|
+
end
|
9795
|
+
|
9796
|
+
# Validate AWS Event Ruler
|
9797
|
+
# @param ruler_validate_request Ruler Validate Request
|
9798
|
+
# @param [Hash] opts the optional parameters
|
9799
|
+
# @return [Array<(RulerValidationResponse, Fixnum, Hash)>] RulerValidationResponse data, response status code and response headers
|
9800
|
+
def validate_ruler_with_http_info(ruler_validate_request, opts = {})
|
9801
|
+
if @api_client.config.debugging
|
9802
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.validate_ruler ...'
|
9803
|
+
end
|
9804
|
+
# verify the required parameter 'ruler_validate_request' is set
|
9805
|
+
if @api_client.config.client_side_validation && ruler_validate_request.nil?
|
9806
|
+
fail ArgumentError, "Missing the required parameter 'ruler_validate_request' when calling StorefrontApi.validate_ruler"
|
9807
|
+
end
|
9808
|
+
# resource path
|
9809
|
+
local_var_path = '/storefront/ruler/validate'
|
9810
|
+
|
9811
|
+
# query parameters
|
9812
|
+
query_params = {}
|
9813
|
+
|
9814
|
+
# header parameters
|
9815
|
+
header_params = {}
|
9816
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
9817
|
+
# HTTP header 'Accept' (if needed)
|
9818
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
9819
|
+
# HTTP header 'Content-Type'
|
9820
|
+
header_params['Content-Type'] = @api_client.select_header_content_type(['application/json'])
|
9821
|
+
|
9822
|
+
# form parameters
|
9823
|
+
form_params = {}
|
9824
|
+
|
9825
|
+
# http body (model)
|
9826
|
+
post_body = @api_client.object_to_http_body(ruler_validate_request)
|
9827
|
+
auth_names = ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
9828
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path,
|
9829
|
+
:header_params => header_params,
|
9830
|
+
:query_params => query_params,
|
9831
|
+
:form_params => form_params,
|
9832
|
+
:body => post_body,
|
9833
|
+
:auth_names => auth_names,
|
9834
|
+
:return_type => 'RulerValidationResponse')
|
9835
|
+
if @api_client.config.debugging
|
9836
|
+
@api_client.config.logger.debug "API called: StorefrontApi#validate_ruler\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
9837
|
+
end
|
9838
|
+
return data, status_code, headers
|
9839
|
+
end
|
9728
9840
|
end
|
9729
9841
|
end
|