ultracart_api 4.0.60.rc → 4.0.63.rc
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 +66 -0
- data/docs/EmailPostcardTrackingResponse.md +26 -0
- data/docs/EmailSettings.md +2 -0
- data/docs/RulerValidationRequest.md +18 -0
- data/docs/RulerValidationResponse.md +20 -0
- data/docs/StorefrontApi.md +142 -0
- data/lib/ultracart_api/api/storefront_api.rb +135 -0
- data/lib/ultracart_api/models/email_postcard_tracking.rb +439 -0
- data/lib/ultracart_api/models/email_postcard_tracking_response.rb +256 -0
- data/lib/ultracart_api/models/email_settings.rb +11 -1
- data/lib/ultracart_api/models/ruler_validation_request.rb +219 -0
- data/lib/ultracart_api/models/ruler_validation_response.rb +228 -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: 15484cd481220bf96f131fc0acecfeee27a83afa20836d4804198613d206d67b
|
4
|
+
data.tar.gz: 8654390b05267c0e34e5dc43e9c9d49facfa49b5e298a88069a21a62e22cf462
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: 9d7cf627cbbca6e6a3b35f08fbaf70701185d9883dff012f3a62d95fa2520b2d5a0e9bfaff8bf1d2800fbf0f6f192399e800694b1225e9a0234cca6ba0ed6a44
|
7
|
+
data.tar.gz: d27642bc84c9af9c1461615825fa390860755f513e69cf9640e43351780bc1d8671cbe94c269f51648c5deff54090ef5cb87efe156417c13edf0616f7250d92a
|
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.63.rc
|
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.63.rc.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.63.rc.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.63.rc'
|
37
37
|
|
38
38
|
### Install from Git
|
39
39
|
|
@@ -275,6 +275,7 @@ Class | Method | HTTP request | Description
|
|
275
275
|
*UltracartClient::StorefrontApi* | [**get_email_commseq**](docs/StorefrontApi.md#get_email_commseq) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid} | Get email commseq
|
276
276
|
*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
|
277
277
|
*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
|
278
|
+
*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
|
278
279
|
*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
|
279
280
|
*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
|
280
281
|
*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
|
@@ -399,6 +400,7 @@ Class | Method | HTTP request | Description
|
|
399
400
|
*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
|
400
401
|
*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
|
401
402
|
*UltracartClient::StorefrontApi* | [**update_twilio_account**](docs/StorefrontApi.md#update_twilio_account) | **PUT** /storefront/twilio/accounts/{esp_twilio_uuid} | Update Twilio account
|
403
|
+
*UltracartClient::StorefrontApi* | [**validate_ruler**](docs/StorefrontApi.md#validate_ruler) | **POST** /storefront/ruler/validate | Validate AWS Event Ruler
|
402
404
|
*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
|
403
405
|
*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
|
404
406
|
*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
|
@@ -769,6 +771,8 @@ Class | Method | HTTP request | Description
|
|
769
771
|
- [UltracartClient::EmailPlanAdditional](docs/EmailPlanAdditional.md)
|
770
772
|
- [UltracartClient::EmailPlanResponse](docs/EmailPlanResponse.md)
|
771
773
|
- [UltracartClient::EmailPostcardStat](docs/EmailPostcardStat.md)
|
774
|
+
- [UltracartClient::EmailPostcardTracking](docs/EmailPostcardTracking.md)
|
775
|
+
- [UltracartClient::EmailPostcardTrackingResponse](docs/EmailPostcardTrackingResponse.md)
|
772
776
|
- [UltracartClient::EmailSegment](docs/EmailSegment.md)
|
773
777
|
- [UltracartClient::EmailSegmentArchiveResponse](docs/EmailSegmentArchiveResponse.md)
|
774
778
|
- [UltracartClient::EmailSegmentCustomer](docs/EmailSegmentCustomer.md)
|
@@ -1000,6 +1004,8 @@ Class | Method | HTTP request | Description
|
|
1000
1004
|
- [UltracartClient::RegisterAffiliateClickResponse](docs/RegisterAffiliateClickResponse.md)
|
1001
1005
|
- [UltracartClient::ResponseMetadata](docs/ResponseMetadata.md)
|
1002
1006
|
- [UltracartClient::ResultSet](docs/ResultSet.md)
|
1007
|
+
- [UltracartClient::RulerValidationRequest](docs/RulerValidationRequest.md)
|
1008
|
+
- [UltracartClient::RulerValidationResponse](docs/RulerValidationResponse.md)
|
1003
1009
|
- [UltracartClient::ScreenRecording](docs/ScreenRecording.md)
|
1004
1010
|
- [UltracartClient::ScreenRecordingAdPlatform](docs/ScreenRecordingAdPlatform.md)
|
1005
1011
|
- [UltracartClient::ScreenRecordingFilter](docs/ScreenRecordingFilter.md)
|
@@ -1188,6 +1194,9 @@ Not every change is committed to every SDK.
|
|
1188
1194
|
|
1189
1195
|
| Version | Date | Comments |
|
1190
1196
|
| --: | :-: | --- |
|
1197
|
+
| 4.0.63-RC | 09/13/2022 | storefront comms - postcard tracking |
|
1198
|
+
| 4.0.62-RC | 09/12/2022 | storefront comm - send back reviews.io configured flag on getEmailSettings |
|
1199
|
+
| 4.0.61-RC | 09/07/2022 | sf comms - using aws event ruler for bigquery segmentation validation |
|
1191
1200
|
| 4.0.60-RC | 09/02/2022 | customer editor added loyal ledger descriptions |
|
1192
1201
|
| 4.0.59-RC | 08/30/2022 | storefront comm fields for sms configuration |
|
1193
1202
|
| 4.0.58-RC | 08/26/2022 | postcard address fields for comm sequence testing |
|
@@ -0,0 +1,66 @@
|
|
1
|
+
# UltracartClient::EmailPostcardTracking
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **commseq_postcard_uuid** | **String** | | [optional] |
|
8
|
+
| **commseq_step_uuid** | **String** | | [optional] |
|
9
|
+
| **commseq_uuid** | **String** | | [optional] |
|
10
|
+
| **conversion_dts** | **String** | Conversion date time. | [optional] |
|
11
|
+
| **cost** | **Float** | | [optional] |
|
12
|
+
| **customer_uuid** | **String** | | [optional] |
|
13
|
+
| **delivered_dts** | **String** | Delivered date time. | [optional] |
|
14
|
+
| **from_address_line1** | **String** | | [optional] |
|
15
|
+
| **from_address_line2** | **String** | | [optional] |
|
16
|
+
| **from_city** | **String** | | [optional] |
|
17
|
+
| **from_name** | **String** | | [optional] |
|
18
|
+
| **from_state** | **String** | | [optional] |
|
19
|
+
| **from_zip** | **String** | | [optional] |
|
20
|
+
| **mailed_dts** | **String** | Mailed date time. | [optional] |
|
21
|
+
| **order_id** | **String** | | [optional] |
|
22
|
+
| **postcard_tracking_uuid** | **String** | | [optional] |
|
23
|
+
| **status** | **String** | | [optional] |
|
24
|
+
| **submit_dts** | **String** | Submit date time. | [optional] |
|
25
|
+
| **to_address_line1** | **String** | | [optional] |
|
26
|
+
| **to_address_line2** | **String** | | [optional] |
|
27
|
+
| **to_city** | **String** | | [optional] |
|
28
|
+
| **to_name** | **String** | | [optional] |
|
29
|
+
| **to_state** | **String** | | [optional] |
|
30
|
+
| **to_zip** | **String** | | [optional] |
|
31
|
+
| **tracking_description** | **String** | | [optional] |
|
32
|
+
|
33
|
+
## Example
|
34
|
+
|
35
|
+
```ruby
|
36
|
+
require 'ultracart_api'
|
37
|
+
|
38
|
+
instance = UltracartClient::EmailPostcardTracking.new(
|
39
|
+
commseq_postcard_uuid: null,
|
40
|
+
commseq_step_uuid: null,
|
41
|
+
commseq_uuid: null,
|
42
|
+
conversion_dts: null,
|
43
|
+
cost: null,
|
44
|
+
customer_uuid: null,
|
45
|
+
delivered_dts: null,
|
46
|
+
from_address_line1: null,
|
47
|
+
from_address_line2: null,
|
48
|
+
from_city: null,
|
49
|
+
from_name: null,
|
50
|
+
from_state: null,
|
51
|
+
from_zip: null,
|
52
|
+
mailed_dts: null,
|
53
|
+
order_id: null,
|
54
|
+
postcard_tracking_uuid: null,
|
55
|
+
status: null,
|
56
|
+
submit_dts: null,
|
57
|
+
to_address_line1: null,
|
58
|
+
to_address_line2: null,
|
59
|
+
to_city: null,
|
60
|
+
to_name: null,
|
61
|
+
to_state: null,
|
62
|
+
to_zip: null,
|
63
|
+
tracking_description: null
|
64
|
+
)
|
65
|
+
```
|
66
|
+
|
@@ -0,0 +1,26 @@
|
|
1
|
+
# UltracartClient::EmailPostcardTrackingResponse
|
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
|
+
| **tracking** | [**EmailPostcardTracking**](EmailPostcardTracking.md) | | [optional] |
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
12
|
+
|
13
|
+
## Example
|
14
|
+
|
15
|
+
```ruby
|
16
|
+
require 'ultracart_api'
|
17
|
+
|
18
|
+
instance = UltracartClient::EmailPostcardTrackingResponse.new(
|
19
|
+
error: null,
|
20
|
+
metadata: null,
|
21
|
+
success: null,
|
22
|
+
tracking: null,
|
23
|
+
warning: null
|
24
|
+
)
|
25
|
+
```
|
26
|
+
|
data/docs/EmailSettings.md
CHANGED
@@ -13,6 +13,7 @@
|
|
13
13
|
| **postcard_from_name** | **String** | | [optional] |
|
14
14
|
| **postcard_from_postal_code** | **String** | | [optional] |
|
15
15
|
| **postcard_from_state** | **String** | | [optional] |
|
16
|
+
| **reviews_io_configured** | **Boolean** | True if the Reviews.io integration is configured | [optional] |
|
16
17
|
| **sms_esp_twilio_uuid** | **String** | | [optional] |
|
17
18
|
| **sms_phone_number** | **String** | | [optional] |
|
18
19
|
| **transactional_esp_domain_user** | **String** | | [optional] |
|
@@ -34,6 +35,7 @@ instance = UltracartClient::EmailSettings.new(
|
|
34
35
|
postcard_from_name: null,
|
35
36
|
postcard_from_postal_code: null,
|
36
37
|
postcard_from_state: null,
|
38
|
+
reviews_io_configured: null,
|
37
39
|
sms_esp_twilio_uuid: null,
|
38
40
|
sms_phone_number: null,
|
39
41
|
transactional_esp_domain_user: null,
|
@@ -0,0 +1,18 @@
|
|
1
|
+
# UltracartClient::RulerValidationRequest
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **ruler** | **String** | | [optional] |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'ultracart_api'
|
13
|
+
|
14
|
+
instance = UltracartClient::RulerValidationRequest.new(
|
15
|
+
ruler: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,20 @@
|
|
1
|
+
# UltracartClient::RulerValidationResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **error_message** | **String** | | [optional] |
|
8
|
+
| **valid** | **Boolean** | | [optional] |
|
9
|
+
|
10
|
+
## Example
|
11
|
+
|
12
|
+
```ruby
|
13
|
+
require 'ultracart_api'
|
14
|
+
|
15
|
+
instance = UltracartClient::RulerValidationResponse.new(
|
16
|
+
error_message: null,
|
17
|
+
valid: null
|
18
|
+
)
|
19
|
+
```
|
20
|
+
|
data/docs/StorefrontApi.md
CHANGED
@@ -44,6 +44,7 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
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 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
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
|
@@ -2999,6 +3001,77 @@ end
|
|
2999
3001
|
- **Accept**: application/json
|
3000
3002
|
|
3001
3003
|
|
3004
|
+
## get_email_commseq_postcard_tracking
|
3005
|
+
|
3006
|
+
> <EmailPostcardTrackingResponse> get_email_commseq_postcard_tracking(storefront_oid, commseq_postcard_uuid)
|
3007
|
+
|
3008
|
+
Get email communication postcard tracking
|
3009
|
+
|
3010
|
+
### Examples
|
3011
|
+
|
3012
|
+
```ruby
|
3013
|
+
require 'time'
|
3014
|
+
require 'ultracart_api'
|
3015
|
+
require 'json'
|
3016
|
+
require 'yaml'
|
3017
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
3018
|
+
|
3019
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
3020
|
+
# As such, this might not be the best way to use this object.
|
3021
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
3022
|
+
|
3023
|
+
api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
3024
|
+
storefront_oid = 56 # Integer |
|
3025
|
+
commseq_postcard_uuid = 'commseq_postcard_uuid_example' # String |
|
3026
|
+
|
3027
|
+
begin
|
3028
|
+
# Get email communication postcard tracking
|
3029
|
+
result = api_instance.get_email_commseq_postcard_tracking(storefront_oid, commseq_postcard_uuid)
|
3030
|
+
p result
|
3031
|
+
rescue UltracartClient::ApiError => e
|
3032
|
+
puts "Error when calling StorefrontApi->get_email_commseq_postcard_tracking: #{e}"
|
3033
|
+
end
|
3034
|
+
```
|
3035
|
+
|
3036
|
+
#### Using the get_email_commseq_postcard_tracking_with_http_info variant
|
3037
|
+
|
3038
|
+
This returns an Array which contains the response data, status code and headers.
|
3039
|
+
|
3040
|
+
> <Array(<EmailPostcardTrackingResponse>, Integer, Hash)> get_email_commseq_postcard_tracking_with_http_info(storefront_oid, commseq_postcard_uuid)
|
3041
|
+
|
3042
|
+
```ruby
|
3043
|
+
begin
|
3044
|
+
# Get email communication postcard tracking
|
3045
|
+
data, status_code, headers = api_instance.get_email_commseq_postcard_tracking_with_http_info(storefront_oid, commseq_postcard_uuid)
|
3046
|
+
p status_code # => 2xx
|
3047
|
+
p headers # => { ... }
|
3048
|
+
p data # => <EmailPostcardTrackingResponse>
|
3049
|
+
rescue UltracartClient::ApiError => e
|
3050
|
+
puts "Error when calling StorefrontApi->get_email_commseq_postcard_tracking_with_http_info: #{e}"
|
3051
|
+
end
|
3052
|
+
```
|
3053
|
+
|
3054
|
+
### Parameters
|
3055
|
+
|
3056
|
+
| Name | Type | Description | Notes |
|
3057
|
+
| ---- | ---- | ----------- | ----- |
|
3058
|
+
| **storefront_oid** | **Integer** | | |
|
3059
|
+
| **commseq_postcard_uuid** | **String** | | |
|
3060
|
+
|
3061
|
+
### Return type
|
3062
|
+
|
3063
|
+
[**EmailPostcardTrackingResponse**](EmailPostcardTrackingResponse.md)
|
3064
|
+
|
3065
|
+
### Authorization
|
3066
|
+
|
3067
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
3068
|
+
|
3069
|
+
### HTTP request headers
|
3070
|
+
|
3071
|
+
- **Content-Type**: Not defined
|
3072
|
+
- **Accept**: application/json
|
3073
|
+
|
3074
|
+
|
3002
3075
|
## get_email_commseq_stat_overall
|
3003
3076
|
|
3004
3077
|
> <EmailCommseqStatResponse> get_email_commseq_stat_overall(storefront_oid, commseq_uuid)
|
@@ -11933,3 +12006,72 @@ end
|
|
11933
12006
|
- **Content-Type**: application/json
|
11934
12007
|
- **Accept**: application/json
|
11935
12008
|
|
12009
|
+
|
12010
|
+
## validate_ruler
|
12011
|
+
|
12012
|
+
> <RulerValidationResponse> validate_ruler(ruler_validate_request)
|
12013
|
+
|
12014
|
+
Validate AWS Event Ruler
|
12015
|
+
|
12016
|
+
### Examples
|
12017
|
+
|
12018
|
+
```ruby
|
12019
|
+
require 'time'
|
12020
|
+
require 'ultracart_api'
|
12021
|
+
require 'json'
|
12022
|
+
require 'yaml'
|
12023
|
+
require_relative '../constants' # https://github.com/UltraCart/sdk_samples/blob/master/ruby/constants.rb
|
12024
|
+
|
12025
|
+
# This example is based on our samples_sdk project, but still contains auto-generated content from our sdk generators.
|
12026
|
+
# As such, this might not be the best way to use this object.
|
12027
|
+
# Please see https://github.com/UltraCart/sdk_samples for working examples.
|
12028
|
+
|
12029
|
+
api = UltracartClient::StorefrontApi.new_using_api_key(Constants::API_KEY, Constants::VERIFY_SSL, Constants::DEBUG_MODE)
|
12030
|
+
ruler_validate_request = UltracartClient::RulerValidationRequest.new # RulerValidationRequest | Ruler Validate Request
|
12031
|
+
|
12032
|
+
begin
|
12033
|
+
# Validate AWS Event Ruler
|
12034
|
+
result = api_instance.validate_ruler(ruler_validate_request)
|
12035
|
+
p result
|
12036
|
+
rescue UltracartClient::ApiError => e
|
12037
|
+
puts "Error when calling StorefrontApi->validate_ruler: #{e}"
|
12038
|
+
end
|
12039
|
+
```
|
12040
|
+
|
12041
|
+
#### Using the validate_ruler_with_http_info variant
|
12042
|
+
|
12043
|
+
This returns an Array which contains the response data, status code and headers.
|
12044
|
+
|
12045
|
+
> <Array(<RulerValidationResponse>, Integer, Hash)> validate_ruler_with_http_info(ruler_validate_request)
|
12046
|
+
|
12047
|
+
```ruby
|
12048
|
+
begin
|
12049
|
+
# Validate AWS Event Ruler
|
12050
|
+
data, status_code, headers = api_instance.validate_ruler_with_http_info(ruler_validate_request)
|
12051
|
+
p status_code # => 2xx
|
12052
|
+
p headers # => { ... }
|
12053
|
+
p data # => <RulerValidationResponse>
|
12054
|
+
rescue UltracartClient::ApiError => e
|
12055
|
+
puts "Error when calling StorefrontApi->validate_ruler_with_http_info: #{e}"
|
12056
|
+
end
|
12057
|
+
```
|
12058
|
+
|
12059
|
+
### Parameters
|
12060
|
+
|
12061
|
+
| Name | Type | Description | Notes |
|
12062
|
+
| ---- | ---- | ----------- | ----- |
|
12063
|
+
| **ruler_validate_request** | [**RulerValidationRequest**](RulerValidationRequest.md) | Ruler Validate Request | |
|
12064
|
+
|
12065
|
+
### Return type
|
12066
|
+
|
12067
|
+
[**RulerValidationResponse**](RulerValidationResponse.md)
|
12068
|
+
|
12069
|
+
### Authorization
|
12070
|
+
|
12071
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
12072
|
+
|
12073
|
+
### HTTP request headers
|
12074
|
+
|
12075
|
+
- **Content-Type**: application/json
|
12076
|
+
- **Accept**: application/json
|
12077
|
+
|
@@ -2751,6 +2751,74 @@ module UltracartClient
|
|
2751
2751
|
return data, status_code, headers
|
2752
2752
|
end
|
2753
2753
|
|
2754
|
+
# Get email communication postcard tracking
|
2755
|
+
# @param storefront_oid [Integer]
|
2756
|
+
# @param commseq_postcard_uuid [String]
|
2757
|
+
# @param [Hash] opts the optional parameters
|
2758
|
+
# @return [EmailPostcardTrackingResponse]
|
2759
|
+
def get_email_commseq_postcard_tracking(storefront_oid, commseq_postcard_uuid, opts = {})
|
2760
|
+
data, _status_code, _headers = get_email_commseq_postcard_tracking_with_http_info(storefront_oid, commseq_postcard_uuid, opts)
|
2761
|
+
data
|
2762
|
+
end
|
2763
|
+
|
2764
|
+
# Get email communication postcard tracking
|
2765
|
+
# @param storefront_oid [Integer]
|
2766
|
+
# @param commseq_postcard_uuid [String]
|
2767
|
+
# @param [Hash] opts the optional parameters
|
2768
|
+
# @return [Array<(EmailPostcardTrackingResponse, Integer, Hash)>] EmailPostcardTrackingResponse data, response status code and response headers
|
2769
|
+
def get_email_commseq_postcard_tracking_with_http_info(storefront_oid, commseq_postcard_uuid, opts = {})
|
2770
|
+
if @api_client.config.debugging
|
2771
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.get_email_commseq_postcard_tracking ...'
|
2772
|
+
end
|
2773
|
+
# verify the required parameter 'storefront_oid' is set
|
2774
|
+
if @api_client.config.client_side_validation && storefront_oid.nil?
|
2775
|
+
fail ArgumentError, "Missing the required parameter 'storefront_oid' when calling StorefrontApi.get_email_commseq_postcard_tracking"
|
2776
|
+
end
|
2777
|
+
# verify the required parameter 'commseq_postcard_uuid' is set
|
2778
|
+
if @api_client.config.client_side_validation && commseq_postcard_uuid.nil?
|
2779
|
+
fail ArgumentError, "Missing the required parameter 'commseq_postcard_uuid' when calling StorefrontApi.get_email_commseq_postcard_tracking"
|
2780
|
+
end
|
2781
|
+
# resource path
|
2782
|
+
local_var_path = '/storefront/{storefront_oid}/email/postcards/{commseq_postcard_uuid}/tracking'.sub('{' + 'storefront_oid' + '}', CGI.escape(storefront_oid.to_s)).sub('{' + 'commseq_postcard_uuid' + '}', CGI.escape(commseq_postcard_uuid.to_s))
|
2783
|
+
|
2784
|
+
# query parameters
|
2785
|
+
query_params = opts[:query_params] || {}
|
2786
|
+
|
2787
|
+
# header parameters
|
2788
|
+
header_params = opts[:header_params] || {}
|
2789
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
2790
|
+
# HTTP header 'Accept' (if needed)
|
2791
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
2792
|
+
|
2793
|
+
# form parameters
|
2794
|
+
form_params = opts[:form_params] || {}
|
2795
|
+
|
2796
|
+
# http body (model)
|
2797
|
+
post_body = opts[:debug_body]
|
2798
|
+
|
2799
|
+
# return_type
|
2800
|
+
return_type = opts[:debug_return_type] || 'EmailPostcardTrackingResponse'
|
2801
|
+
|
2802
|
+
# auth_names
|
2803
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
2804
|
+
|
2805
|
+
new_options = opts.merge(
|
2806
|
+
:operation => :"StorefrontApi.get_email_commseq_postcard_tracking",
|
2807
|
+
:header_params => header_params,
|
2808
|
+
:query_params => query_params,
|
2809
|
+
:form_params => form_params,
|
2810
|
+
:body => post_body,
|
2811
|
+
:auth_names => auth_names,
|
2812
|
+
:return_type => return_type
|
2813
|
+
)
|
2814
|
+
|
2815
|
+
data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
|
2816
|
+
if @api_client.config.debugging
|
2817
|
+
@api_client.config.logger.debug "API called: StorefrontApi#get_email_commseq_postcard_tracking\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
2818
|
+
end
|
2819
|
+
return data, status_code, headers
|
2820
|
+
end
|
2821
|
+
|
2754
2822
|
# Get communication sequence stats overall
|
2755
2823
|
# @param storefront_oid [Integer]
|
2756
2824
|
# @param commseq_uuid [String]
|
@@ -11538,5 +11606,72 @@ module UltracartClient
|
|
11538
11606
|
end
|
11539
11607
|
return data, status_code, headers
|
11540
11608
|
end
|
11609
|
+
|
11610
|
+
# Validate AWS Event Ruler
|
11611
|
+
# @param ruler_validate_request [RulerValidationRequest] Ruler Validate Request
|
11612
|
+
# @param [Hash] opts the optional parameters
|
11613
|
+
# @return [RulerValidationResponse]
|
11614
|
+
def validate_ruler(ruler_validate_request, opts = {})
|
11615
|
+
data, _status_code, _headers = validate_ruler_with_http_info(ruler_validate_request, opts)
|
11616
|
+
data
|
11617
|
+
end
|
11618
|
+
|
11619
|
+
# Validate AWS Event Ruler
|
11620
|
+
# @param ruler_validate_request [RulerValidationRequest] Ruler Validate Request
|
11621
|
+
# @param [Hash] opts the optional parameters
|
11622
|
+
# @return [Array<(RulerValidationResponse, Integer, Hash)>] RulerValidationResponse data, response status code and response headers
|
11623
|
+
def validate_ruler_with_http_info(ruler_validate_request, opts = {})
|
11624
|
+
if @api_client.config.debugging
|
11625
|
+
@api_client.config.logger.debug 'Calling API: StorefrontApi.validate_ruler ...'
|
11626
|
+
end
|
11627
|
+
# verify the required parameter 'ruler_validate_request' is set
|
11628
|
+
if @api_client.config.client_side_validation && ruler_validate_request.nil?
|
11629
|
+
fail ArgumentError, "Missing the required parameter 'ruler_validate_request' when calling StorefrontApi.validate_ruler"
|
11630
|
+
end
|
11631
|
+
# resource path
|
11632
|
+
local_var_path = '/storefront/ruler/validate'
|
11633
|
+
|
11634
|
+
# query parameters
|
11635
|
+
query_params = opts[:query_params] || {}
|
11636
|
+
|
11637
|
+
# header parameters
|
11638
|
+
header_params = opts[:header_params] || {}
|
11639
|
+
header_params['X-UltraCart-Api-Version'] = @api_client.select_header_api_version()
|
11640
|
+
# HTTP header 'Accept' (if needed)
|
11641
|
+
header_params['Accept'] = @api_client.select_header_accept(['application/json'])
|
11642
|
+
# HTTP header 'Content-Type'
|
11643
|
+
content_type = @api_client.select_header_content_type(['application/json'])
|
11644
|
+
if !content_type.nil?
|
11645
|
+
header_params['Content-Type'] = content_type
|
11646
|
+
end
|
11647
|
+
|
11648
|
+
# form parameters
|
11649
|
+
form_params = opts[:form_params] || {}
|
11650
|
+
|
11651
|
+
# http body (model)
|
11652
|
+
post_body = opts[:debug_body] || @api_client.object_to_http_body(ruler_validate_request)
|
11653
|
+
|
11654
|
+
# return_type
|
11655
|
+
return_type = opts[:debug_return_type] || 'RulerValidationResponse'
|
11656
|
+
|
11657
|
+
# auth_names
|
11658
|
+
auth_names = opts[:debug_auth_names] || ['ultraCartBrowserApiKey', 'ultraCartOauth', 'ultraCartSimpleApiKey']
|
11659
|
+
|
11660
|
+
new_options = opts.merge(
|
11661
|
+
:operation => :"StorefrontApi.validate_ruler",
|
11662
|
+
:header_params => header_params,
|
11663
|
+
:query_params => query_params,
|
11664
|
+
:form_params => form_params,
|
11665
|
+
:body => post_body,
|
11666
|
+
:auth_names => auth_names,
|
11667
|
+
:return_type => return_type
|
11668
|
+
)
|
11669
|
+
|
11670
|
+
data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
|
11671
|
+
if @api_client.config.debugging
|
11672
|
+
@api_client.config.logger.debug "API called: StorefrontApi#validate_ruler\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
|
11673
|
+
end
|
11674
|
+
return data, status_code, headers
|
11675
|
+
end
|
11541
11676
|
end
|
11542
11677
|
end
|