ultracart_api 4.1.110 → 4.1.111
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/README.md +12 -2
- data/docs/EmailCustomerLookupResponse.md +28 -0
- data/docs/EmailDispatchLog.md +26 -0
- data/docs/EmailDispatchLogDetail.md +32 -0
- data/docs/EmailDispatchLogDetailResponse.md +26 -0
- data/docs/EmailDispatchLogsResponse.md +32 -0
- data/docs/StorefrontApi.md +233 -0
- data/lib/ultracart_api/api/storefront_api.rb +322 -0
- data/lib/ultracart_api/models/email_customer_lookup_response.rb +267 -0
- data/lib/ultracart_api/models/email_dispatch_log.rb +260 -0
- data/lib/ultracart_api/models/email_dispatch_log_detail.rb +290 -0
- data/lib/ultracart_api/models/email_dispatch_log_detail_response.rb +256 -0
- data/lib/ultracart_api/models/email_dispatch_logs_response.rb +289 -0
- data/lib/ultracart_api/version.rb +1 -1
- data/lib/ultracart_api.rb +5 -0
- 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: da2c7488120167d9ea42c5f308f90c4e8c32c88c71c4e0a645f4cad2a9cd26bf
|
|
4
|
+
data.tar.gz: ee86cda36fbe1d0a139005849cc44f1b72f2644666fb5c2e10bd1265ecd1dfbd
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 4d4cd119cd05d04ef2ae7bb1e971e8386f77c8463480cc53ea7b41ad01ce35cf51738ae1ca592bc34225eca9d74f5439dbbc3114e017c35229a973124f5822e2
|
|
7
|
+
data.tar.gz: b37ea2d1ee017e4db1dd0a50b927b37bcc884e917802c740f42b894954ec0348db4eee45a0619935a15a7a4891cf8c24baf8d5f1dc0e411d4c779be06d87cf1e
|
data/README.md
CHANGED
|
@@ -7,7 +7,7 @@ Note: Every method has a sample for every language. See https://github.com/Ultr
|
|
|
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.1.
|
|
10
|
+
- Package version: 4.1.111
|
|
11
11
|
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
|
12
12
|
- For more information, please visit [http://www.ultracart.com/api/](http://www.ultracart.com/api/)
|
|
13
13
|
|
|
@@ -16,7 +16,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g
|
|
|
16
16
|
gemfile:
|
|
17
17
|
|
|
18
18
|
```shell
|
|
19
|
-
gem 'ultracart_api', '4.1.
|
|
19
|
+
gem 'ultracart_api', '4.1.111'
|
|
20
20
|
```
|
|
21
21
|
|
|
22
22
|
install:
|
|
@@ -516,10 +516,12 @@ Class | Method | HTTP request | Description
|
|
|
516
516
|
*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
|
|
517
517
|
*UltracartClient::StorefrontApi* | [**get_email_commseq_webhook_editor_values**](docs/StorefrontApi.md#get_email_commseq_webhook_editor_values) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/webhookEditorValues | Get email webhook editor values
|
|
518
518
|
*UltracartClient::StorefrontApi* | [**get_email_commseqs**](docs/StorefrontApi.md#get_email_commseqs) | **GET** /storefront/{storefront_oid}/email/commseqs | Get email commseqs
|
|
519
|
+
*UltracartClient::StorefrontApi* | [**get_email_customer_dispatch_logs**](docs/StorefrontApi.md#get_email_customer_dispatch_logs) | **GET** /storefront/{storefront_oid}/email/customers/{email_customer_uuid}/dispatch_logs | Get a customer's dispatch-log journey across all flows/campaigns
|
|
519
520
|
*UltracartClient::StorefrontApi* | [**get_email_customer_editor_url**](docs/StorefrontApi.md#get_email_customer_editor_url) | **GET** /storefront/{storefront_oid}/email/customers/{email_customer_uuid}/editor_url | Get customers editor URL
|
|
520
521
|
*UltracartClient::StorefrontApi* | [**get_email_customers**](docs/StorefrontApi.md#get_email_customers) | **GET** /storefront/{storefront_oid}/email/customers | Get email customers
|
|
521
522
|
*UltracartClient::StorefrontApi* | [**get_email_dashboard_activity**](docs/StorefrontApi.md#get_email_dashboard_activity) | **GET** /storefront/{storefront_oid}/email/dashboard_activity | Get email dashboard activity
|
|
522
523
|
*UltracartClient::StorefrontApi* | [**get_email_dashboard_stats**](docs/StorefrontApi.md#get_email_dashboard_stats) | **GET** /storefront/{storefront_oid}/email/dashboard_stats | Get dashboard stats
|
|
524
|
+
*UltracartClient::StorefrontApi* | [**get_email_dispatch_log_customer_lookup**](docs/StorefrontApi.md#get_email_dispatch_log_customer_lookup) | **GET** /storefront/{storefront_oid}/email/dispatch_logs/customer_lookup | Resolve a customer email to its ESP customer UUID
|
|
523
525
|
*UltracartClient::StorefrontApi* | [**get_email_dispatch_logs**](docs/StorefrontApi.md#get_email_dispatch_logs) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/logs | Get email dispatch logs
|
|
524
526
|
*UltracartClient::StorefrontApi* | [**get_email_email**](docs/StorefrontApi.md#get_email_email) | **GET** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} | Get email email
|
|
525
527
|
*UltracartClient::StorefrontApi* | [**get_email_email_clicks**](docs/StorefrontApi.md#get_email_email_clicks) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/emails/{commseq_email_uuid}/clicks | Get email email clicks
|
|
@@ -553,6 +555,8 @@ Class | Method | HTTP request | Description
|
|
|
553
555
|
*UltracartClient::StorefrontApi* | [**get_email_sending_domains**](docs/StorefrontApi.md#get_email_sending_domains) | **GET** /storefront/email/sending_domains | Get email sending domains
|
|
554
556
|
*UltracartClient::StorefrontApi* | [**get_email_settings**](docs/StorefrontApi.md#get_email_settings) | **GET** /storefront/{storefront_oid}/email/settings | Get email settings
|
|
555
557
|
*UltracartClient::StorefrontApi* | [**get_email_sms_orders**](docs/StorefrontApi.md#get_email_sms_orders) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/sms/orders | Get email sms orders
|
|
558
|
+
*UltracartClient::StorefrontApi* | [**get_email_step_dispatch_log_detail**](docs/StorefrontApi.md#get_email_step_dispatch_log_detail) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/dispatch_logs/detail | Get the full detail of a single dispatch-log record
|
|
559
|
+
*UltracartClient::StorefrontApi* | [**get_email_step_dispatch_logs**](docs/StorefrontApi.md#get_email_step_dispatch_logs) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/dispatch_logs | Get a paginated, date-boundable dispatch-log feed for a step
|
|
556
560
|
*UltracartClient::StorefrontApi* | [**get_email_template**](docs/StorefrontApi.md#get_email_template) | **GET** /storefront/{storefront_oid}/email/templates/{email_template_oid} | Get email template
|
|
557
561
|
*UltracartClient::StorefrontApi* | [**get_email_templates**](docs/StorefrontApi.md#get_email_templates) | **GET** /storefront/{storefront_oid}/email/templates | Get email templates
|
|
558
562
|
*UltracartClient::StorefrontApi* | [**get_email_third_party_providers**](docs/StorefrontApi.md#get_email_third_party_providers) | **GET** /storefront/{storefront_oid}/email/third_party_providers | Get a list of third party email providers
|
|
@@ -1211,10 +1215,15 @@ Class | Method | HTTP request | Description
|
|
|
1211
1215
|
- [UltracartClient::EmailCommseqsResponse](docs/EmailCommseqsResponse.md)
|
|
1212
1216
|
- [UltracartClient::EmailCustomer](docs/EmailCustomer.md)
|
|
1213
1217
|
- [UltracartClient::EmailCustomerEditorUrlResponse](docs/EmailCustomerEditorUrlResponse.md)
|
|
1218
|
+
- [UltracartClient::EmailCustomerLookupResponse](docs/EmailCustomerLookupResponse.md)
|
|
1214
1219
|
- [UltracartClient::EmailCustomersResponse](docs/EmailCustomersResponse.md)
|
|
1215
1220
|
- [UltracartClient::EmailDashboardActivity](docs/EmailDashboardActivity.md)
|
|
1216
1221
|
- [UltracartClient::EmailDashboardActivityResponse](docs/EmailDashboardActivityResponse.md)
|
|
1217
1222
|
- [UltracartClient::EmailDashboardStatsResponse](docs/EmailDashboardStatsResponse.md)
|
|
1223
|
+
- [UltracartClient::EmailDispatchLog](docs/EmailDispatchLog.md)
|
|
1224
|
+
- [UltracartClient::EmailDispatchLogDetail](docs/EmailDispatchLogDetail.md)
|
|
1225
|
+
- [UltracartClient::EmailDispatchLogDetailResponse](docs/EmailDispatchLogDetailResponse.md)
|
|
1226
|
+
- [UltracartClient::EmailDispatchLogsResponse](docs/EmailDispatchLogsResponse.md)
|
|
1218
1227
|
- [UltracartClient::EmailDomain](docs/EmailDomain.md)
|
|
1219
1228
|
- [UltracartClient::EmailEditorTokenResponse](docs/EmailEditorTokenResponse.md)
|
|
1220
1229
|
- [UltracartClient::EmailEditorValuesResponse](docs/EmailEditorValuesResponse.md)
|
|
@@ -1806,6 +1815,7 @@ Not every change is committed to every SDK.
|
|
|
1806
1815
|
|
|
1807
1816
|
| Version | Date | Comments |
|
|
1808
1817
|
| --: | :-: | --- |
|
|
1818
|
+
| 4.1.111 | 07/08/2026 | storefront - additional email dispatch log methods |
|
|
1809
1819
|
| 4.1.110 | 07/06/2026 | Conversation - CRM message type constant for tool call |
|
|
1810
1820
|
| 4.1.109 | 07/03/2026 | bulk import endpoints (alpha) |
|
|
1811
1821
|
| 4.1.108 | 07/03/2026 | bulk import endpoints (alpha) |
|
|
@@ -0,0 +1,28 @@
|
|
|
1
|
+
# UltracartClient::EmailCustomerLookupResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **email** | **String** | The email that was looked up | [optional] |
|
|
8
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
|
9
|
+
| **esp_customer_uuid** | **String** | ESP customer UUID, or null when the email is not on file | [optional] |
|
|
10
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
|
11
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
|
12
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```ruby
|
|
17
|
+
require 'ultracart_api'
|
|
18
|
+
|
|
19
|
+
instance = UltracartClient::EmailCustomerLookupResponse.new(
|
|
20
|
+
email: null,
|
|
21
|
+
error: null,
|
|
22
|
+
esp_customer_uuid: null,
|
|
23
|
+
metadata: null,
|
|
24
|
+
success: null,
|
|
25
|
+
warning: null
|
|
26
|
+
)
|
|
27
|
+
```
|
|
28
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::EmailDispatchLog
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **email** | **String** | Customer email, resolved from the customer UUID for the page | [optional] |
|
|
8
|
+
| **esp_commseq_step_uuid** | **String** | Communication sequence step UUID | [optional] |
|
|
9
|
+
| **esp_commseq_uuid** | **String** | Communication sequence (flow/campaign) UUID | [optional] |
|
|
10
|
+
| **esp_customer_uuid** | **String** | ESP customer UUID | [optional] |
|
|
11
|
+
| **log_dts** | **String** | Log date/time (ISO-8601) | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'ultracart_api'
|
|
17
|
+
|
|
18
|
+
instance = UltracartClient::EmailDispatchLog.new(
|
|
19
|
+
email: null,
|
|
20
|
+
esp_commseq_step_uuid: null,
|
|
21
|
+
esp_commseq_uuid: null,
|
|
22
|
+
esp_customer_uuid: null,
|
|
23
|
+
log_dts: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# UltracartClient::EmailDispatchLogDetail
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **detail** | **String** | Dispatch detail text (free-form log of how the customer moved through the step) | [optional] |
|
|
8
|
+
| **email** | **String** | Customer email, resolved from the customer UUID | [optional] |
|
|
9
|
+
| **esp_commseq_step_uuid** | **String** | Communication sequence step UUID | [optional] |
|
|
10
|
+
| **esp_commseq_uuid** | **String** | Communication sequence (flow/campaign) UUID | [optional] |
|
|
11
|
+
| **esp_customer_uuid** | **String** | ESP customer UUID | [optional] |
|
|
12
|
+
| **log_dts** | **String** | Log date/time (ISO-8601) | [optional] |
|
|
13
|
+
| **merchant_id** | **String** | Merchant id | [optional] |
|
|
14
|
+
| **storefront_oid** | **Integer** | Storefront oid | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'ultracart_api'
|
|
20
|
+
|
|
21
|
+
instance = UltracartClient::EmailDispatchLogDetail.new(
|
|
22
|
+
detail: null,
|
|
23
|
+
email: null,
|
|
24
|
+
esp_commseq_step_uuid: null,
|
|
25
|
+
esp_commseq_uuid: null,
|
|
26
|
+
esp_customer_uuid: null,
|
|
27
|
+
log_dts: null,
|
|
28
|
+
merchant_id: null,
|
|
29
|
+
storefront_oid: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# UltracartClient::EmailDispatchLogDetailResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **dispatch_log** | [**EmailDispatchLogDetail**](EmailDispatchLogDetail.md) | | [optional] |
|
|
8
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
|
9
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
|
10
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
|
11
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```ruby
|
|
16
|
+
require 'ultracart_api'
|
|
17
|
+
|
|
18
|
+
instance = UltracartClient::EmailDispatchLogDetailResponse.new(
|
|
19
|
+
dispatch_log: null,
|
|
20
|
+
error: null,
|
|
21
|
+
metadata: null,
|
|
22
|
+
success: null,
|
|
23
|
+
warning: null
|
|
24
|
+
)
|
|
25
|
+
```
|
|
26
|
+
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# UltracartClient::EmailDispatchLogsResponse
|
|
2
|
+
|
|
3
|
+
## Properties
|
|
4
|
+
|
|
5
|
+
| Name | Type | Description | Notes |
|
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
|
7
|
+
| **dispatch_logs** | [**Array<EmailDispatchLog>**](EmailDispatchLog.md) | Dispatch log rows on this page | [optional] |
|
|
8
|
+
| **error** | [**Error**](Error.md) | | [optional] |
|
|
9
|
+
| **metadata** | [**ResponseMetadata**](ResponseMetadata.md) | | [optional] |
|
|
10
|
+
| **more** | **Boolean** | True when another page exists after this one | [optional] |
|
|
11
|
+
| **page_number** | **Integer** | Page number (one based) | [optional] |
|
|
12
|
+
| **page_size** | **Integer** | Number of records per page | [optional] |
|
|
13
|
+
| **success** | **Boolean** | Indicates if API call was successful | [optional] |
|
|
14
|
+
| **warning** | [**Warning**](Warning.md) | | [optional] |
|
|
15
|
+
|
|
16
|
+
## Example
|
|
17
|
+
|
|
18
|
+
```ruby
|
|
19
|
+
require 'ultracart_api'
|
|
20
|
+
|
|
21
|
+
instance = UltracartClient::EmailDispatchLogsResponse.new(
|
|
22
|
+
dispatch_logs: null,
|
|
23
|
+
error: null,
|
|
24
|
+
metadata: null,
|
|
25
|
+
more: null,
|
|
26
|
+
page_number: null,
|
|
27
|
+
page_size: null,
|
|
28
|
+
success: null,
|
|
29
|
+
warning: null
|
|
30
|
+
)
|
|
31
|
+
```
|
|
32
|
+
|
data/docs/StorefrontApi.md
CHANGED
|
@@ -56,10 +56,12 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
56
56
|
| [**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 |
|
|
57
57
|
| [**get_email_commseq_webhook_editor_values**](StorefrontApi.md#get_email_commseq_webhook_editor_values) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/webhookEditorValues | Get email webhook editor values |
|
|
58
58
|
| [**get_email_commseqs**](StorefrontApi.md#get_email_commseqs) | **GET** /storefront/{storefront_oid}/email/commseqs | Get email commseqs |
|
|
59
|
+
| [**get_email_customer_dispatch_logs**](StorefrontApi.md#get_email_customer_dispatch_logs) | **GET** /storefront/{storefront_oid}/email/customers/{email_customer_uuid}/dispatch_logs | Get a customer's dispatch-log journey across all flows/campaigns |
|
|
59
60
|
| [**get_email_customer_editor_url**](StorefrontApi.md#get_email_customer_editor_url) | **GET** /storefront/{storefront_oid}/email/customers/{email_customer_uuid}/editor_url | Get customers editor URL |
|
|
60
61
|
| [**get_email_customers**](StorefrontApi.md#get_email_customers) | **GET** /storefront/{storefront_oid}/email/customers | Get email customers |
|
|
61
62
|
| [**get_email_dashboard_activity**](StorefrontApi.md#get_email_dashboard_activity) | **GET** /storefront/{storefront_oid}/email/dashboard_activity | Get email dashboard activity |
|
|
62
63
|
| [**get_email_dashboard_stats**](StorefrontApi.md#get_email_dashboard_stats) | **GET** /storefront/{storefront_oid}/email/dashboard_stats | Get dashboard stats |
|
|
64
|
+
| [**get_email_dispatch_log_customer_lookup**](StorefrontApi.md#get_email_dispatch_log_customer_lookup) | **GET** /storefront/{storefront_oid}/email/dispatch_logs/customer_lookup | Resolve a customer email to its ESP customer UUID |
|
|
63
65
|
| [**get_email_dispatch_logs**](StorefrontApi.md#get_email_dispatch_logs) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/logs | Get email dispatch logs |
|
|
64
66
|
| [**get_email_email**](StorefrontApi.md#get_email_email) | **GET** /storefront/{storefront_oid}/email/emails/{commseq_email_uuid} | Get email email |
|
|
65
67
|
| [**get_email_email_clicks**](StorefrontApi.md#get_email_email_clicks) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/emails/{commseq_email_uuid}/clicks | Get email email clicks |
|
|
@@ -93,6 +95,8 @@ All URIs are relative to *https://secure.ultracart.com/rest/v2*
|
|
|
93
95
|
| [**get_email_sending_domains**](StorefrontApi.md#get_email_sending_domains) | **GET** /storefront/email/sending_domains | Get email sending domains |
|
|
94
96
|
| [**get_email_settings**](StorefrontApi.md#get_email_settings) | **GET** /storefront/{storefront_oid}/email/settings | Get email settings |
|
|
95
97
|
| [**get_email_sms_orders**](StorefrontApi.md#get_email_sms_orders) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/sms/orders | Get email sms orders |
|
|
98
|
+
| [**get_email_step_dispatch_log_detail**](StorefrontApi.md#get_email_step_dispatch_log_detail) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/dispatch_logs/detail | Get the full detail of a single dispatch-log record |
|
|
99
|
+
| [**get_email_step_dispatch_logs**](StorefrontApi.md#get_email_step_dispatch_logs) | **GET** /storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/dispatch_logs | Get a paginated, date-boundable dispatch-log feed for a step |
|
|
96
100
|
| [**get_email_template**](StorefrontApi.md#get_email_template) | **GET** /storefront/{storefront_oid}/email/templates/{email_template_oid} | Get email template |
|
|
97
101
|
| [**get_email_templates**](StorefrontApi.md#get_email_templates) | **GET** /storefront/{storefront_oid}/email/templates | Get email templates |
|
|
98
102
|
| [**get_email_third_party_providers**](StorefrontApi.md#get_email_third_party_providers) | **GET** /storefront/{storefront_oid}/email/third_party_providers | Get a list of third party email providers |
|
|
@@ -2945,6 +2949,65 @@ end
|
|
|
2945
2949
|
- **Accept**: application/json
|
|
2946
2950
|
|
|
2947
2951
|
|
|
2952
|
+
## get_email_customer_dispatch_logs
|
|
2953
|
+
|
|
2954
|
+
> <EmailDispatchLogsResponse> get_email_customer_dispatch_logs(storefront_oid, email_customer_uuid, opts)
|
|
2955
|
+
|
|
2956
|
+
Get a customer's dispatch-log journey across all flows/campaigns
|
|
2957
|
+
|
|
2958
|
+
Paginated, date-boundable journey of every flow/campaign step a customer moved through (AP1/AP2), time-sorted. Rows are lean; fetch a row's detail via getEmailStepDispatchLogDetail. scanForward=false (default) returns recent-first; true returns chronological progression. Page forward until 'more' is false.
|
|
2959
|
+
|
|
2960
|
+
|
|
2961
|
+
### Examples
|
|
2962
|
+
|
|
2963
|
+
|
|
2964
|
+
(No example for this operation).
|
|
2965
|
+
|
|
2966
|
+
|
|
2967
|
+
#### Using the get_email_customer_dispatch_logs_with_http_info variant
|
|
2968
|
+
|
|
2969
|
+
This returns an Array which contains the response data, status code and headers.
|
|
2970
|
+
|
|
2971
|
+
> <Array(<EmailDispatchLogsResponse>, Integer, Hash)> get_email_customer_dispatch_logs_with_http_info(storefront_oid, email_customer_uuid, opts)
|
|
2972
|
+
|
|
2973
|
+
```ruby
|
|
2974
|
+
begin
|
|
2975
|
+
# Get a customer's dispatch-log journey across all flows/campaigns
|
|
2976
|
+
data, status_code, headers = api_instance.get_email_customer_dispatch_logs_with_http_info(storefront_oid, email_customer_uuid, opts)
|
|
2977
|
+
p status_code # => 2xx
|
|
2978
|
+
p headers # => { ... }
|
|
2979
|
+
p data # => <EmailDispatchLogsResponse>
|
|
2980
|
+
rescue UltracartClient::ApiError => e
|
|
2981
|
+
puts "Error when calling StorefrontApi->get_email_customer_dispatch_logs_with_http_info: #{e}"
|
|
2982
|
+
end
|
|
2983
|
+
```
|
|
2984
|
+
|
|
2985
|
+
### Parameters
|
|
2986
|
+
|
|
2987
|
+
| Name | Type | Description | Notes |
|
|
2988
|
+
| ---- | ---- | ----------- | ----- |
|
|
2989
|
+
| **storefront_oid** | **Integer** | | |
|
|
2990
|
+
| **email_customer_uuid** | **String** | | |
|
|
2991
|
+
| **since** | **String** | | [optional] |
|
|
2992
|
+
| **_until** | **String** | | [optional] |
|
|
2993
|
+
| **page_number** | **Integer** | | [optional] |
|
|
2994
|
+
| **page_size** | **Integer** | | [optional] |
|
|
2995
|
+
| **scan_forward** | **Boolean** | | [optional] |
|
|
2996
|
+
|
|
2997
|
+
### Return type
|
|
2998
|
+
|
|
2999
|
+
[**EmailDispatchLogsResponse**](EmailDispatchLogsResponse.md)
|
|
3000
|
+
|
|
3001
|
+
### Authorization
|
|
3002
|
+
|
|
3003
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
3004
|
+
|
|
3005
|
+
### HTTP request headers
|
|
3006
|
+
|
|
3007
|
+
- **Content-Type**: Not defined
|
|
3008
|
+
- **Accept**: application/json
|
|
3009
|
+
|
|
3010
|
+
|
|
2948
3011
|
## get_email_customer_editor_url
|
|
2949
3012
|
|
|
2950
3013
|
> <EmailCustomerEditorUrlResponse> get_email_customer_editor_url(storefront_oid, email_customer_uuid)
|
|
@@ -3159,6 +3222,60 @@ end
|
|
|
3159
3222
|
- **Accept**: application/json
|
|
3160
3223
|
|
|
3161
3224
|
|
|
3225
|
+
## get_email_dispatch_log_customer_lookup
|
|
3226
|
+
|
|
3227
|
+
> <EmailCustomerLookupResponse> get_email_dispatch_log_customer_lookup(storefront_oid, opts)
|
|
3228
|
+
|
|
3229
|
+
Resolve a customer email to its ESP customer UUID
|
|
3230
|
+
|
|
3231
|
+
Entry-hop resolver for the customer-journey screen (AP0). Returns the esp_customer_uuid for a merchant's customer email, or a null uuid when the email is not on file.
|
|
3232
|
+
|
|
3233
|
+
|
|
3234
|
+
### Examples
|
|
3235
|
+
|
|
3236
|
+
|
|
3237
|
+
(No example for this operation).
|
|
3238
|
+
|
|
3239
|
+
|
|
3240
|
+
#### Using the get_email_dispatch_log_customer_lookup_with_http_info variant
|
|
3241
|
+
|
|
3242
|
+
This returns an Array which contains the response data, status code and headers.
|
|
3243
|
+
|
|
3244
|
+
> <Array(<EmailCustomerLookupResponse>, Integer, Hash)> get_email_dispatch_log_customer_lookup_with_http_info(storefront_oid, opts)
|
|
3245
|
+
|
|
3246
|
+
```ruby
|
|
3247
|
+
begin
|
|
3248
|
+
# Resolve a customer email to its ESP customer UUID
|
|
3249
|
+
data, status_code, headers = api_instance.get_email_dispatch_log_customer_lookup_with_http_info(storefront_oid, opts)
|
|
3250
|
+
p status_code # => 2xx
|
|
3251
|
+
p headers # => { ... }
|
|
3252
|
+
p data # => <EmailCustomerLookupResponse>
|
|
3253
|
+
rescue UltracartClient::ApiError => e
|
|
3254
|
+
puts "Error when calling StorefrontApi->get_email_dispatch_log_customer_lookup_with_http_info: #{e}"
|
|
3255
|
+
end
|
|
3256
|
+
```
|
|
3257
|
+
|
|
3258
|
+
### Parameters
|
|
3259
|
+
|
|
3260
|
+
| Name | Type | Description | Notes |
|
|
3261
|
+
| ---- | ---- | ----------- | ----- |
|
|
3262
|
+
| **storefront_oid** | **Integer** | | |
|
|
3263
|
+
| **email** | **String** | | [optional] |
|
|
3264
|
+
|
|
3265
|
+
### Return type
|
|
3266
|
+
|
|
3267
|
+
[**EmailCustomerLookupResponse**](EmailCustomerLookupResponse.md)
|
|
3268
|
+
|
|
3269
|
+
### Authorization
|
|
3270
|
+
|
|
3271
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
3272
|
+
|
|
3273
|
+
### HTTP request headers
|
|
3274
|
+
|
|
3275
|
+
- **Content-Type**: Not defined
|
|
3276
|
+
- **Accept**: application/json
|
|
3277
|
+
|
|
3278
|
+
|
|
3162
3279
|
## get_email_dispatch_logs
|
|
3163
3280
|
|
|
3164
3281
|
> <EmailCommseqStepLogsResponse> get_email_dispatch_logs(storefront_oid, commseq_uuid, commseq_step_uuid)
|
|
@@ -4906,6 +5023,122 @@ end
|
|
|
4906
5023
|
- **Accept**: application/json
|
|
4907
5024
|
|
|
4908
5025
|
|
|
5026
|
+
## get_email_step_dispatch_log_detail
|
|
5027
|
+
|
|
5028
|
+
> <EmailDispatchLogDetailResponse> get_email_step_dispatch_log_detail(storefront_oid, commseq_uuid, commseq_step_uuid, opts)
|
|
5029
|
+
|
|
5030
|
+
Get the full detail of a single dispatch-log record
|
|
5031
|
+
|
|
5032
|
+
Fetches and gunzips the full detail payload of one dispatch-log record (AP5 drill-down), identified by its step plus the log_dts and esp_customer_uuid shown on the list row.
|
|
5033
|
+
|
|
5034
|
+
|
|
5035
|
+
### Examples
|
|
5036
|
+
|
|
5037
|
+
|
|
5038
|
+
(No example for this operation).
|
|
5039
|
+
|
|
5040
|
+
|
|
5041
|
+
#### Using the get_email_step_dispatch_log_detail_with_http_info variant
|
|
5042
|
+
|
|
5043
|
+
This returns an Array which contains the response data, status code and headers.
|
|
5044
|
+
|
|
5045
|
+
> <Array(<EmailDispatchLogDetailResponse>, Integer, Hash)> get_email_step_dispatch_log_detail_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts)
|
|
5046
|
+
|
|
5047
|
+
```ruby
|
|
5048
|
+
begin
|
|
5049
|
+
# Get the full detail of a single dispatch-log record
|
|
5050
|
+
data, status_code, headers = api_instance.get_email_step_dispatch_log_detail_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts)
|
|
5051
|
+
p status_code # => 2xx
|
|
5052
|
+
p headers # => { ... }
|
|
5053
|
+
p data # => <EmailDispatchLogDetailResponse>
|
|
5054
|
+
rescue UltracartClient::ApiError => e
|
|
5055
|
+
puts "Error when calling StorefrontApi->get_email_step_dispatch_log_detail_with_http_info: #{e}"
|
|
5056
|
+
end
|
|
5057
|
+
```
|
|
5058
|
+
|
|
5059
|
+
### Parameters
|
|
5060
|
+
|
|
5061
|
+
| Name | Type | Description | Notes |
|
|
5062
|
+
| ---- | ---- | ----------- | ----- |
|
|
5063
|
+
| **storefront_oid** | **Integer** | | |
|
|
5064
|
+
| **commseq_uuid** | **String** | | |
|
|
5065
|
+
| **commseq_step_uuid** | **String** | | |
|
|
5066
|
+
| **log_dts** | **String** | | [optional] |
|
|
5067
|
+
| **esp_customer_uuid** | **String** | | [optional] |
|
|
5068
|
+
|
|
5069
|
+
### Return type
|
|
5070
|
+
|
|
5071
|
+
[**EmailDispatchLogDetailResponse**](EmailDispatchLogDetailResponse.md)
|
|
5072
|
+
|
|
5073
|
+
### Authorization
|
|
5074
|
+
|
|
5075
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
5076
|
+
|
|
5077
|
+
### HTTP request headers
|
|
5078
|
+
|
|
5079
|
+
- **Content-Type**: Not defined
|
|
5080
|
+
- **Accept**: application/json
|
|
5081
|
+
|
|
5082
|
+
|
|
5083
|
+
## get_email_step_dispatch_logs
|
|
5084
|
+
|
|
5085
|
+
> <EmailDispatchLogsResponse> get_email_step_dispatch_logs(storefront_oid, commseq_uuid, commseq_step_uuid, opts)
|
|
5086
|
+
|
|
5087
|
+
Get a paginated, date-boundable dispatch-log feed for a step
|
|
5088
|
+
|
|
5089
|
+
Paginated per-step dispatch activity with 90-day depth (AP3/AP4). Rows are lean, rendered from the DynamoDB keys; fetch a row's full detail via getEmailStepDispatchLogDetail. Page forward by incrementing pageNumber until the response 'more' flag is false. since/until are inclusive ISO-8601 bounds on log_dts.
|
|
5090
|
+
|
|
5091
|
+
|
|
5092
|
+
### Examples
|
|
5093
|
+
|
|
5094
|
+
|
|
5095
|
+
(No example for this operation).
|
|
5096
|
+
|
|
5097
|
+
|
|
5098
|
+
#### Using the get_email_step_dispatch_logs_with_http_info variant
|
|
5099
|
+
|
|
5100
|
+
This returns an Array which contains the response data, status code and headers.
|
|
5101
|
+
|
|
5102
|
+
> <Array(<EmailDispatchLogsResponse>, Integer, Hash)> get_email_step_dispatch_logs_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts)
|
|
5103
|
+
|
|
5104
|
+
```ruby
|
|
5105
|
+
begin
|
|
5106
|
+
# Get a paginated, date-boundable dispatch-log feed for a step
|
|
5107
|
+
data, status_code, headers = api_instance.get_email_step_dispatch_logs_with_http_info(storefront_oid, commseq_uuid, commseq_step_uuid, opts)
|
|
5108
|
+
p status_code # => 2xx
|
|
5109
|
+
p headers # => { ... }
|
|
5110
|
+
p data # => <EmailDispatchLogsResponse>
|
|
5111
|
+
rescue UltracartClient::ApiError => e
|
|
5112
|
+
puts "Error when calling StorefrontApi->get_email_step_dispatch_logs_with_http_info: #{e}"
|
|
5113
|
+
end
|
|
5114
|
+
```
|
|
5115
|
+
|
|
5116
|
+
### Parameters
|
|
5117
|
+
|
|
5118
|
+
| Name | Type | Description | Notes |
|
|
5119
|
+
| ---- | ---- | ----------- | ----- |
|
|
5120
|
+
| **storefront_oid** | **Integer** | | |
|
|
5121
|
+
| **commseq_uuid** | **String** | | |
|
|
5122
|
+
| **commseq_step_uuid** | **String** | | |
|
|
5123
|
+
| **since** | **String** | | [optional] |
|
|
5124
|
+
| **_until** | **String** | | [optional] |
|
|
5125
|
+
| **page_number** | **Integer** | | [optional] |
|
|
5126
|
+
| **page_size** | **Integer** | | [optional] |
|
|
5127
|
+
|
|
5128
|
+
### Return type
|
|
5129
|
+
|
|
5130
|
+
[**EmailDispatchLogsResponse**](EmailDispatchLogsResponse.md)
|
|
5131
|
+
|
|
5132
|
+
### Authorization
|
|
5133
|
+
|
|
5134
|
+
[ultraCartBrowserApiKey](../README.md#ultraCartBrowserApiKey), [ultraCartOauth](../README.md#ultraCartOauth), [ultraCartSimpleApiKey](../README.md#ultraCartSimpleApiKey)
|
|
5135
|
+
|
|
5136
|
+
### HTTP request headers
|
|
5137
|
+
|
|
5138
|
+
- **Content-Type**: Not defined
|
|
5139
|
+
- **Accept**: application/json
|
|
5140
|
+
|
|
5141
|
+
|
|
4909
5142
|
## get_email_template
|
|
4910
5143
|
|
|
4911
5144
|
> <EmailTemplate> get_email_template(storefront_oid, email_template_oid)
|