ultracart_rest_api_v2_typescript 4.1.109 → 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.
- package/.openapi-generator/FILES +5 -0
- package/README.md +4 -2
- package/dist/apis/StorefrontApi.d.ts +143 -1
- package/dist/apis/StorefrontApi.js +299 -0
- package/dist/models/ConversationMessage.d.ts +1 -0
- package/dist/models/ConversationMessage.js +2 -1
- package/dist/models/EmailCustomerLookupResponse.d.ts +64 -0
- package/dist/models/EmailCustomerLookupResponse.js +63 -0
- package/dist/models/EmailDispatchLog.d.ts +55 -0
- package/dist/models/EmailDispatchLog.js +58 -0
- package/dist/models/EmailDispatchLogDetail.d.ts +73 -0
- package/dist/models/EmailDispatchLogDetail.js +64 -0
- package/dist/models/EmailDispatchLogDetailResponse.d.ts +59 -0
- package/dist/models/EmailDispatchLogDetailResponse.js +62 -0
- package/dist/models/EmailDispatchLogsResponse.d.ts +77 -0
- package/dist/models/EmailDispatchLogsResponse.js +68 -0
- package/dist/models/index.d.ts +5 -0
- package/dist/models/index.js +5 -0
- package/package.json +1 -1
- package/src/apis/StorefrontApi.ts +371 -0
- package/src/models/ConversationMessage.ts +2 -1
- package/src/models/EmailCustomerLookupResponse.ts +126 -0
- package/src/models/EmailDispatchLog.ts +99 -0
- package/src/models/EmailDispatchLogDetail.ts +123 -0
- package/src/models/EmailDispatchLogDetailResponse.ts +124 -0
- package/src/models/EmailDispatchLogsResponse.ts +148 -0
- package/src/models/index.ts +5 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -530,10 +530,15 @@ src/models/EmailCommseqWebhookSendTestResponse.ts
|
|
|
530
530
|
src/models/EmailCommseqsResponse.ts
|
|
531
531
|
src/models/EmailCustomer.ts
|
|
532
532
|
src/models/EmailCustomerEditorUrlResponse.ts
|
|
533
|
+
src/models/EmailCustomerLookupResponse.ts
|
|
533
534
|
src/models/EmailCustomersResponse.ts
|
|
534
535
|
src/models/EmailDashboardActivity.ts
|
|
535
536
|
src/models/EmailDashboardActivityResponse.ts
|
|
536
537
|
src/models/EmailDashboardStatsResponse.ts
|
|
538
|
+
src/models/EmailDispatchLog.ts
|
|
539
|
+
src/models/EmailDispatchLogDetail.ts
|
|
540
|
+
src/models/EmailDispatchLogDetailResponse.ts
|
|
541
|
+
src/models/EmailDispatchLogsResponse.ts
|
|
537
542
|
src/models/EmailDomain.ts
|
|
538
543
|
src/models/EmailEditorTokenResponse.ts
|
|
539
544
|
src/models/EmailEditorValuesResponse.ts
|
package/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# UltraCart Typescript SDK
|
|
2
|
-
## ultracart_rest_api_v2_typescript@4.1.
|
|
2
|
+
## ultracart_rest_api_v2_typescript@4.1.111
|
|
3
3
|
|
|
4
4
|
Every API method call has a sample for every language SDK. See https://github.com/UltraCart/sdk_samples
|
|
5
5
|
|
|
6
6
|
Installation
|
|
7
7
|
|
|
8
8
|
```
|
|
9
|
-
npm install ultracart_rest_api_v2_typescript@4.1.
|
|
9
|
+
npm install ultracart_rest_api_v2_typescript@4.1.111 --save
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
@@ -85,6 +85,8 @@ Not every change is committed to every SDK.
|
|
|
85
85
|
|
|
86
86
|
| Version | Date | Comments |
|
|
87
87
|
| --: | :-: | --- |
|
|
88
|
+
| 4.1.111 | 07/08/2026 | storefront - additional email dispatch log methods |
|
|
89
|
+
| 4.1.110 | 07/06/2026 | Conversation - CRM message type constant for tool call |
|
|
88
90
|
| 4.1.109 | 07/03/2026 | bulk import endpoints (alpha) |
|
|
89
91
|
| 4.1.108 | 07/03/2026 | bulk import endpoints (alpha) |
|
|
90
92
|
| 4.1.107 | 07/03/2026 | bulk import endpoints (alpha) |
|
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { AddLibraryItemRequest, ApplyLibraryItemRequest, ApplyLibraryItemResponse, BaseResponse, CountriesResponse, EmailBaseTemplateListResponse, EmailCampaign, EmailCampaignFolder, EmailCampaignFolderResponse, EmailCampaignFoldersResponse, EmailCampaignResponse, EmailCampaignsResponse, EmailClicksResponse, EmailCommseq, EmailCommseqEmail, EmailCommseqEmailResponse, EmailCommseqEmailSendTestRequest, EmailCommseqEmailSendTestResponse, EmailCommseqEmailsRequest, EmailCommseqEmailsResponse, EmailCommseqEnrollmentRequest, EmailCommseqEnrollmentResponse, EmailCommseqPostcard, EmailCommseqPostcardResponse, EmailCommseqPostcardSendTestRequest, EmailCommseqPostcardSendTestResponse, EmailCommseqPostcardsRequest, EmailCommseqPostcardsResponse, EmailCommseqResponse, EmailCommseqSequenceTestRequest, EmailCommseqSequenceTestResponse, EmailCommseqSmsSendTestRequest, EmailCommseqSmsSendTestResponse, EmailCommseqStatResponse, EmailCommseqStepLogsResponse, EmailCommseqWebhookSendTestRequest, EmailCommseqWebhookSendTestResponse, EmailCommseqsResponse, EmailCustomer, EmailCustomerEditorUrlResponse, EmailCustomersResponse, EmailDashboardActivityResponse, EmailDashboardStatsResponse, EmailDomain, EmailEditorTokenResponse, EmailEditorValuesResponse, EmailFlow, EmailFlowBackPopulateRequest, EmailFlowBackPopulateResponse, EmailFlowFolder, EmailFlowFolderResponse, EmailFlowFoldersResponse, EmailFlowResponse, EmailFlowsResponse, EmailGlobalSettings, EmailGlobalSettingsResponse, EmailGlobalUnsubscribeRequest, EmailGlobalUnsubscribeResponse, EmailHistogramPropertyNamesResponse, EmailHistogramPropertyValuesResponse, EmailList, EmailListArchiveResponse, EmailListCustomersResponse, EmailListResponse, EmailListSegmentFolder, EmailListSegmentFolderResponse, EmailListSegmentFoldersResponse, EmailListSubscribeResponse, EmailListsResponse, EmailOrdersResponse, EmailPerformanceResponse, EmailPlan, EmailPlanResponse, EmailPostcardTrackingResponse, EmailRateLimitersResponse, EmailSegment, EmailSegmentArchiveResponse, EmailSegmentCustomersResponse, EmailSegmentDownloadPrepareResponse, EmailSegmentResponse, EmailSegmentsResponse, EmailSendingDomainResponse, EmailSendingDomainsResponse, EmailSettings, EmailSettingsResponse, EmailSmsOrdersResponse, EmailStatPostcardSummaryRequest, EmailStatPostcardSummaryResponse, EmailStatSmsSummaryRequest, EmailStatSmsSummaryResponse, EmailStatSummaryRequest, EmailStatSummaryResponse, EmailStepStatRequest, EmailStepStatResponse, EmailStepWaitingRequest, EmailStepWaitingResponse, EmailTemplate, EmailTemplatesResponse, EmailThirdPartyListImportRequest, EmailThirdPartyProvidersResponse, EmailWebhookEditorValuesResponse, Experiment, ExperimentResponse, ExperimentsResponse, FileManagerPageResponse, FileManagerUploadRequest, FileManagerUploadUrlResponse, GeocodeRequest, GeocodeResponse, LibraryFilterValuesResponse, LibraryItem, LibraryItemQuery, LibraryItemResponse, LibraryItemsResponse, LookupRequest, LookupResponse, PricingTiersResponse, PublishLibraryItemRequest, RulerValidationRequest, RulerValidationResponse, ScreenRecordingHeatmapIndexRequest, ScreenRecordingHeatmapIndexResponse, ScreenRecordingHeatmapRequest, ScreenRecordingHeatmapReset, ScreenRecordingHeatmapResponse, ScreenRecordingMerchantNotesRequest, ScreenRecordingPageViewDataResponse, ScreenRecordingQueryRequest, ScreenRecordingQueryResponse, ScreenRecordingResponse, ScreenRecordingSegment, ScreenRecordingSegmentResponse, ScreenRecordingSegmentsResponse, ScreenRecordingSettings, ScreenRecordingSettingsResponse, ScreenRecordingTagsRequest, ScreenRecordingTagsResponse, ScreenshotsResponse, StoreFrontPageContentAttribute, StoreFrontsResponse, ThumbnailParametersRequest, ThumbnailParametersResponse, TransactionEmail, TransactionEmailListResponse, TransactionEmailResponse, Twilio, TwilioResponse, TwiliosResponse } from '../models';
|
|
13
|
+
import { AddLibraryItemRequest, ApplyLibraryItemRequest, ApplyLibraryItemResponse, BaseResponse, CountriesResponse, EmailBaseTemplateListResponse, EmailCampaign, EmailCampaignFolder, EmailCampaignFolderResponse, EmailCampaignFoldersResponse, EmailCampaignResponse, EmailCampaignsResponse, EmailClicksResponse, EmailCommseq, EmailCommseqEmail, EmailCommseqEmailResponse, EmailCommseqEmailSendTestRequest, EmailCommseqEmailSendTestResponse, EmailCommseqEmailsRequest, EmailCommseqEmailsResponse, EmailCommseqEnrollmentRequest, EmailCommseqEnrollmentResponse, EmailCommseqPostcard, EmailCommseqPostcardResponse, EmailCommseqPostcardSendTestRequest, EmailCommseqPostcardSendTestResponse, EmailCommseqPostcardsRequest, EmailCommseqPostcardsResponse, EmailCommseqResponse, EmailCommseqSequenceTestRequest, EmailCommseqSequenceTestResponse, EmailCommseqSmsSendTestRequest, EmailCommseqSmsSendTestResponse, EmailCommseqStatResponse, EmailCommseqStepLogsResponse, EmailCommseqWebhookSendTestRequest, EmailCommseqWebhookSendTestResponse, EmailCommseqsResponse, EmailCustomer, EmailCustomerEditorUrlResponse, EmailCustomerLookupResponse, EmailCustomersResponse, EmailDashboardActivityResponse, EmailDashboardStatsResponse, EmailDispatchLogDetailResponse, EmailDispatchLogsResponse, EmailDomain, EmailEditorTokenResponse, EmailEditorValuesResponse, EmailFlow, EmailFlowBackPopulateRequest, EmailFlowBackPopulateResponse, EmailFlowFolder, EmailFlowFolderResponse, EmailFlowFoldersResponse, EmailFlowResponse, EmailFlowsResponse, EmailGlobalSettings, EmailGlobalSettingsResponse, EmailGlobalUnsubscribeRequest, EmailGlobalUnsubscribeResponse, EmailHistogramPropertyNamesResponse, EmailHistogramPropertyValuesResponse, EmailList, EmailListArchiveResponse, EmailListCustomersResponse, EmailListResponse, EmailListSegmentFolder, EmailListSegmentFolderResponse, EmailListSegmentFoldersResponse, EmailListSubscribeResponse, EmailListsResponse, EmailOrdersResponse, EmailPerformanceResponse, EmailPlan, EmailPlanResponse, EmailPostcardTrackingResponse, EmailRateLimitersResponse, EmailSegment, EmailSegmentArchiveResponse, EmailSegmentCustomersResponse, EmailSegmentDownloadPrepareResponse, EmailSegmentResponse, EmailSegmentsResponse, EmailSendingDomainResponse, EmailSendingDomainsResponse, EmailSettings, EmailSettingsResponse, EmailSmsOrdersResponse, EmailStatPostcardSummaryRequest, EmailStatPostcardSummaryResponse, EmailStatSmsSummaryRequest, EmailStatSmsSummaryResponse, EmailStatSummaryRequest, EmailStatSummaryResponse, EmailStepStatRequest, EmailStepStatResponse, EmailStepWaitingRequest, EmailStepWaitingResponse, EmailTemplate, EmailTemplatesResponse, EmailThirdPartyListImportRequest, EmailThirdPartyProvidersResponse, EmailWebhookEditorValuesResponse, Experiment, ExperimentResponse, ExperimentsResponse, FileManagerPageResponse, FileManagerUploadRequest, FileManagerUploadUrlResponse, GeocodeRequest, GeocodeResponse, LibraryFilterValuesResponse, LibraryItem, LibraryItemQuery, LibraryItemResponse, LibraryItemsResponse, LookupRequest, LookupResponse, PricingTiersResponse, PublishLibraryItemRequest, RulerValidationRequest, RulerValidationResponse, ScreenRecordingHeatmapIndexRequest, ScreenRecordingHeatmapIndexResponse, ScreenRecordingHeatmapRequest, ScreenRecordingHeatmapReset, ScreenRecordingHeatmapResponse, ScreenRecordingMerchantNotesRequest, ScreenRecordingPageViewDataResponse, ScreenRecordingQueryRequest, ScreenRecordingQueryResponse, ScreenRecordingResponse, ScreenRecordingSegment, ScreenRecordingSegmentResponse, ScreenRecordingSegmentsResponse, ScreenRecordingSettings, ScreenRecordingSettingsResponse, ScreenRecordingTagsRequest, ScreenRecordingTagsResponse, ScreenshotsResponse, StoreFrontPageContentAttribute, StoreFrontsResponse, ThumbnailParametersRequest, ThumbnailParametersResponse, TransactionEmail, TransactionEmailListResponse, TransactionEmailResponse, Twilio, TwilioResponse, TwiliosResponse } from '../models';
|
|
14
14
|
export interface AddToLibraryRequest {
|
|
15
15
|
addLibraryRequest: AddLibraryItemRequest;
|
|
16
16
|
}
|
|
@@ -215,6 +215,15 @@ export interface GetEmailCommseqWebhookEditorValuesRequest {
|
|
|
215
215
|
export interface GetEmailCommseqsRequest {
|
|
216
216
|
storefrontOid: number;
|
|
217
217
|
}
|
|
218
|
+
export interface GetEmailCustomerDispatchLogsRequest {
|
|
219
|
+
storefrontOid: number;
|
|
220
|
+
emailCustomerUuid: string;
|
|
221
|
+
since?: string;
|
|
222
|
+
until?: string;
|
|
223
|
+
pageNumber?: number;
|
|
224
|
+
pageSize?: number;
|
|
225
|
+
scanForward?: boolean;
|
|
226
|
+
}
|
|
218
227
|
export interface GetEmailCustomerEditorUrlRequest {
|
|
219
228
|
storefrontOid: number;
|
|
220
229
|
emailCustomerUuid: string;
|
|
@@ -233,6 +242,10 @@ export interface GetEmailDashboardStatsRequest {
|
|
|
233
242
|
storefrontOid: number;
|
|
234
243
|
days?: number;
|
|
235
244
|
}
|
|
245
|
+
export interface GetEmailDispatchLogCustomerLookupRequest {
|
|
246
|
+
storefrontOid: number;
|
|
247
|
+
email?: string;
|
|
248
|
+
}
|
|
236
249
|
export interface GetEmailDispatchLogsRequest {
|
|
237
250
|
storefrontOid: number;
|
|
238
251
|
commseqUuid: string;
|
|
@@ -361,6 +374,22 @@ export interface GetEmailSmsOrdersRequest {
|
|
|
361
374
|
commseqStepUuid: string;
|
|
362
375
|
days?: number;
|
|
363
376
|
}
|
|
377
|
+
export interface GetEmailStepDispatchLogDetailRequest {
|
|
378
|
+
storefrontOid: number;
|
|
379
|
+
commseqUuid: string;
|
|
380
|
+
commseqStepUuid: string;
|
|
381
|
+
logDts?: string;
|
|
382
|
+
espCustomerUuid?: string;
|
|
383
|
+
}
|
|
384
|
+
export interface GetEmailStepDispatchLogsRequest {
|
|
385
|
+
storefrontOid: number;
|
|
386
|
+
commseqUuid: string;
|
|
387
|
+
commseqStepUuid: string;
|
|
388
|
+
since?: string;
|
|
389
|
+
until?: string;
|
|
390
|
+
pageNumber?: number;
|
|
391
|
+
pageSize?: number;
|
|
392
|
+
}
|
|
364
393
|
export interface GetEmailTemplateRequest {
|
|
365
394
|
storefrontOid: number;
|
|
366
395
|
emailTemplateOid: number;
|
|
@@ -1487,6 +1516,26 @@ export interface StorefrontApiInterface {
|
|
|
1487
1516
|
* Get email commseqs
|
|
1488
1517
|
*/
|
|
1489
1518
|
getEmailCommseqs(requestParameters: GetEmailCommseqsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailCommseqsResponse>;
|
|
1519
|
+
/**
|
|
1520
|
+
* 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.
|
|
1521
|
+
* @summary Get a customer\'s dispatch-log journey across all flows/campaigns
|
|
1522
|
+
* @param {number} storefrontOid
|
|
1523
|
+
* @param {string} emailCustomerUuid
|
|
1524
|
+
* @param {string} [since]
|
|
1525
|
+
* @param {string} [until]
|
|
1526
|
+
* @param {number} [pageNumber]
|
|
1527
|
+
* @param {number} [pageSize]
|
|
1528
|
+
* @param {boolean} [scanForward]
|
|
1529
|
+
* @param {*} [options] Override http request option.
|
|
1530
|
+
* @throws {RequiredError}
|
|
1531
|
+
* @memberof StorefrontApiInterface
|
|
1532
|
+
*/
|
|
1533
|
+
getEmailCustomerDispatchLogsRaw(requestParameters: GetEmailCustomerDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailDispatchLogsResponse>>;
|
|
1534
|
+
/**
|
|
1535
|
+
* 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.
|
|
1536
|
+
* Get a customer\'s dispatch-log journey across all flows/campaigns
|
|
1537
|
+
*/
|
|
1538
|
+
getEmailCustomerDispatchLogs(requestParameters: GetEmailCustomerDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailDispatchLogsResponse>;
|
|
1490
1539
|
/**
|
|
1491
1540
|
*
|
|
1492
1541
|
* @summary Get customers editor URL
|
|
@@ -1545,6 +1594,21 @@ export interface StorefrontApiInterface {
|
|
|
1545
1594
|
* Get dashboard stats
|
|
1546
1595
|
*/
|
|
1547
1596
|
getEmailDashboardStats(requestParameters: GetEmailDashboardStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailDashboardStatsResponse>;
|
|
1597
|
+
/**
|
|
1598
|
+
* 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.
|
|
1599
|
+
* @summary Resolve a customer email to its ESP customer UUID
|
|
1600
|
+
* @param {number} storefrontOid
|
|
1601
|
+
* @param {string} [email]
|
|
1602
|
+
* @param {*} [options] Override http request option.
|
|
1603
|
+
* @throws {RequiredError}
|
|
1604
|
+
* @memberof StorefrontApiInterface
|
|
1605
|
+
*/
|
|
1606
|
+
getEmailDispatchLogCustomerLookupRaw(requestParameters: GetEmailDispatchLogCustomerLookupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailCustomerLookupResponse>>;
|
|
1607
|
+
/**
|
|
1608
|
+
* 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.
|
|
1609
|
+
* Resolve a customer email to its ESP customer UUID
|
|
1610
|
+
*/
|
|
1611
|
+
getEmailDispatchLogCustomerLookup(requestParameters: GetEmailDispatchLogCustomerLookupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailCustomerLookupResponse>;
|
|
1548
1612
|
/**
|
|
1549
1613
|
*
|
|
1550
1614
|
* @summary Get email dispatch logs
|
|
@@ -2007,6 +2071,44 @@ export interface StorefrontApiInterface {
|
|
|
2007
2071
|
* Get email sms orders
|
|
2008
2072
|
*/
|
|
2009
2073
|
getEmailSmsOrders(requestParameters: GetEmailSmsOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailSmsOrdersResponse>;
|
|
2074
|
+
/**
|
|
2075
|
+
* 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.
|
|
2076
|
+
* @summary Get the full detail of a single dispatch-log record
|
|
2077
|
+
* @param {number} storefrontOid
|
|
2078
|
+
* @param {string} commseqUuid
|
|
2079
|
+
* @param {string} commseqStepUuid
|
|
2080
|
+
* @param {string} [logDts]
|
|
2081
|
+
* @param {string} [espCustomerUuid]
|
|
2082
|
+
* @param {*} [options] Override http request option.
|
|
2083
|
+
* @throws {RequiredError}
|
|
2084
|
+
* @memberof StorefrontApiInterface
|
|
2085
|
+
*/
|
|
2086
|
+
getEmailStepDispatchLogDetailRaw(requestParameters: GetEmailStepDispatchLogDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailDispatchLogDetailResponse>>;
|
|
2087
|
+
/**
|
|
2088
|
+
* 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.
|
|
2089
|
+
* Get the full detail of a single dispatch-log record
|
|
2090
|
+
*/
|
|
2091
|
+
getEmailStepDispatchLogDetail(requestParameters: GetEmailStepDispatchLogDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailDispatchLogDetailResponse>;
|
|
2092
|
+
/**
|
|
2093
|
+
* 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.
|
|
2094
|
+
* @summary Get a paginated, date-boundable dispatch-log feed for a step
|
|
2095
|
+
* @param {number} storefrontOid
|
|
2096
|
+
* @param {string} commseqUuid
|
|
2097
|
+
* @param {string} commseqStepUuid
|
|
2098
|
+
* @param {string} [since]
|
|
2099
|
+
* @param {string} [until]
|
|
2100
|
+
* @param {number} [pageNumber]
|
|
2101
|
+
* @param {number} [pageSize]
|
|
2102
|
+
* @param {*} [options] Override http request option.
|
|
2103
|
+
* @throws {RequiredError}
|
|
2104
|
+
* @memberof StorefrontApiInterface
|
|
2105
|
+
*/
|
|
2106
|
+
getEmailStepDispatchLogsRaw(requestParameters: GetEmailStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailDispatchLogsResponse>>;
|
|
2107
|
+
/**
|
|
2108
|
+
* 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.
|
|
2109
|
+
* Get a paginated, date-boundable dispatch-log feed for a step
|
|
2110
|
+
*/
|
|
2111
|
+
getEmailStepDispatchLogs(requestParameters: GetEmailStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailDispatchLogsResponse>;
|
|
2010
2112
|
/**
|
|
2011
2113
|
*
|
|
2012
2114
|
* @summary Get email template
|
|
@@ -3765,6 +3867,16 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
|
|
|
3765
3867
|
* Get email commseqs
|
|
3766
3868
|
*/
|
|
3767
3869
|
getEmailCommseqs(requestParameters: GetEmailCommseqsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailCommseqsResponse>;
|
|
3870
|
+
/**
|
|
3871
|
+
* 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.
|
|
3872
|
+
* Get a customer\'s dispatch-log journey across all flows/campaigns
|
|
3873
|
+
*/
|
|
3874
|
+
getEmailCustomerDispatchLogsRaw(requestParameters: GetEmailCustomerDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailDispatchLogsResponse>>;
|
|
3875
|
+
/**
|
|
3876
|
+
* 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.
|
|
3877
|
+
* Get a customer\'s dispatch-log journey across all flows/campaigns
|
|
3878
|
+
*/
|
|
3879
|
+
getEmailCustomerDispatchLogs(requestParameters: GetEmailCustomerDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailDispatchLogsResponse>;
|
|
3768
3880
|
/**
|
|
3769
3881
|
* Get customers editor URL
|
|
3770
3882
|
*/
|
|
@@ -3797,6 +3909,16 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
|
|
|
3797
3909
|
* Get dashboard stats
|
|
3798
3910
|
*/
|
|
3799
3911
|
getEmailDashboardStats(requestParameters: GetEmailDashboardStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailDashboardStatsResponse>;
|
|
3912
|
+
/**
|
|
3913
|
+
* 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.
|
|
3914
|
+
* Resolve a customer email to its ESP customer UUID
|
|
3915
|
+
*/
|
|
3916
|
+
getEmailDispatchLogCustomerLookupRaw(requestParameters: GetEmailDispatchLogCustomerLookupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailCustomerLookupResponse>>;
|
|
3917
|
+
/**
|
|
3918
|
+
* 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.
|
|
3919
|
+
* Resolve a customer email to its ESP customer UUID
|
|
3920
|
+
*/
|
|
3921
|
+
getEmailDispatchLogCustomerLookup(requestParameters: GetEmailDispatchLogCustomerLookupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailCustomerLookupResponse>;
|
|
3800
3922
|
/**
|
|
3801
3923
|
* Get email dispatch logs
|
|
3802
3924
|
*/
|
|
@@ -4061,6 +4183,26 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
|
|
|
4061
4183
|
* Get email sms orders
|
|
4062
4184
|
*/
|
|
4063
4185
|
getEmailSmsOrders(requestParameters: GetEmailSmsOrdersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailSmsOrdersResponse>;
|
|
4186
|
+
/**
|
|
4187
|
+
* 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.
|
|
4188
|
+
* Get the full detail of a single dispatch-log record
|
|
4189
|
+
*/
|
|
4190
|
+
getEmailStepDispatchLogDetailRaw(requestParameters: GetEmailStepDispatchLogDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailDispatchLogDetailResponse>>;
|
|
4191
|
+
/**
|
|
4192
|
+
* 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.
|
|
4193
|
+
* Get the full detail of a single dispatch-log record
|
|
4194
|
+
*/
|
|
4195
|
+
getEmailStepDispatchLogDetail(requestParameters: GetEmailStepDispatchLogDetailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailDispatchLogDetailResponse>;
|
|
4196
|
+
/**
|
|
4197
|
+
* 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.
|
|
4198
|
+
* Get a paginated, date-boundable dispatch-log feed for a step
|
|
4199
|
+
*/
|
|
4200
|
+
getEmailStepDispatchLogsRaw(requestParameters: GetEmailStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailDispatchLogsResponse>>;
|
|
4201
|
+
/**
|
|
4202
|
+
* 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.
|
|
4203
|
+
* Get a paginated, date-boundable dispatch-log feed for a step
|
|
4204
|
+
*/
|
|
4205
|
+
getEmailStepDispatchLogs(requestParameters: GetEmailStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailDispatchLogsResponse>;
|
|
4064
4206
|
/**
|
|
4065
4207
|
* Get email template
|
|
4066
4208
|
*/
|
|
@@ -3355,6 +3355,86 @@ var StorefrontApi = /** @class */ (function (_super) {
|
|
|
3355
3355
|
});
|
|
3356
3356
|
});
|
|
3357
3357
|
};
|
|
3358
|
+
/**
|
|
3359
|
+
* 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.
|
|
3360
|
+
* Get a customer\'s dispatch-log journey across all flows/campaigns
|
|
3361
|
+
*/
|
|
3362
|
+
StorefrontApi.prototype.getEmailCustomerDispatchLogsRaw = function (requestParameters, initOverrides) {
|
|
3363
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
3364
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
3365
|
+
return __generator(this, function (_c) {
|
|
3366
|
+
switch (_c.label) {
|
|
3367
|
+
case 0:
|
|
3368
|
+
if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
|
|
3369
|
+
throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getEmailCustomerDispatchLogs.');
|
|
3370
|
+
}
|
|
3371
|
+
if (requestParameters.emailCustomerUuid === null || requestParameters.emailCustomerUuid === undefined) {
|
|
3372
|
+
throw new runtime.RequiredError('emailCustomerUuid', 'Required parameter requestParameters.emailCustomerUuid was null or undefined when calling getEmailCustomerDispatchLogs.');
|
|
3373
|
+
}
|
|
3374
|
+
queryParameters = {};
|
|
3375
|
+
if (requestParameters.since !== undefined) {
|
|
3376
|
+
queryParameters['since'] = requestParameters.since;
|
|
3377
|
+
}
|
|
3378
|
+
if (requestParameters.until !== undefined) {
|
|
3379
|
+
queryParameters['until'] = requestParameters.until;
|
|
3380
|
+
}
|
|
3381
|
+
if (requestParameters.pageNumber !== undefined) {
|
|
3382
|
+
queryParameters['pageNumber'] = requestParameters.pageNumber;
|
|
3383
|
+
}
|
|
3384
|
+
if (requestParameters.pageSize !== undefined) {
|
|
3385
|
+
queryParameters['pageSize'] = requestParameters.pageSize;
|
|
3386
|
+
}
|
|
3387
|
+
if (requestParameters.scanForward !== undefined) {
|
|
3388
|
+
queryParameters['scanForward'] = requestParameters.scanForward;
|
|
3389
|
+
}
|
|
3390
|
+
headerParameters = {};
|
|
3391
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
3392
|
+
headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
|
|
3393
|
+
}
|
|
3394
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
3395
|
+
// oauth required
|
|
3396
|
+
_a = headerParameters;
|
|
3397
|
+
_b = "Authorization";
|
|
3398
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["storefront_read"])];
|
|
3399
|
+
case 1:
|
|
3400
|
+
// oauth required
|
|
3401
|
+
_a[_b] = _c.sent();
|
|
3402
|
+
_c.label = 2;
|
|
3403
|
+
case 2:
|
|
3404
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
3405
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
3406
|
+
}
|
|
3407
|
+
return [4 /*yield*/, this.request({
|
|
3408
|
+
path: "/storefront/{storefront_oid}/email/customers/{email_customer_uuid}/dispatch_logs".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("email_customer_uuid", "}"), encodeURIComponent(String(requestParameters.emailCustomerUuid))),
|
|
3409
|
+
method: 'GET',
|
|
3410
|
+
headers: headerParameters,
|
|
3411
|
+
query: queryParameters,
|
|
3412
|
+
}, initOverrides)];
|
|
3413
|
+
case 3:
|
|
3414
|
+
response = _c.sent();
|
|
3415
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.EmailDispatchLogsResponseFromJSON)(jsonValue); })];
|
|
3416
|
+
}
|
|
3417
|
+
});
|
|
3418
|
+
});
|
|
3419
|
+
};
|
|
3420
|
+
/**
|
|
3421
|
+
* 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.
|
|
3422
|
+
* Get a customer\'s dispatch-log journey across all flows/campaigns
|
|
3423
|
+
*/
|
|
3424
|
+
StorefrontApi.prototype.getEmailCustomerDispatchLogs = function (requestParameters, initOverrides) {
|
|
3425
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
3426
|
+
var response;
|
|
3427
|
+
return __generator(this, function (_a) {
|
|
3428
|
+
switch (_a.label) {
|
|
3429
|
+
case 0: return [4 /*yield*/, this.getEmailCustomerDispatchLogsRaw(requestParameters, initOverrides)];
|
|
3430
|
+
case 1:
|
|
3431
|
+
response = _a.sent();
|
|
3432
|
+
return [4 /*yield*/, response.value()];
|
|
3433
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
3434
|
+
}
|
|
3435
|
+
});
|
|
3436
|
+
});
|
|
3437
|
+
};
|
|
3358
3438
|
/**
|
|
3359
3439
|
* Get customers editor URL
|
|
3360
3440
|
*/
|
|
@@ -3613,6 +3693,71 @@ var StorefrontApi = /** @class */ (function (_super) {
|
|
|
3613
3693
|
});
|
|
3614
3694
|
});
|
|
3615
3695
|
};
|
|
3696
|
+
/**
|
|
3697
|
+
* 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.
|
|
3698
|
+
* Resolve a customer email to its ESP customer UUID
|
|
3699
|
+
*/
|
|
3700
|
+
StorefrontApi.prototype.getEmailDispatchLogCustomerLookupRaw = function (requestParameters, initOverrides) {
|
|
3701
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
3702
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
3703
|
+
return __generator(this, function (_c) {
|
|
3704
|
+
switch (_c.label) {
|
|
3705
|
+
case 0:
|
|
3706
|
+
if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
|
|
3707
|
+
throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getEmailDispatchLogCustomerLookup.');
|
|
3708
|
+
}
|
|
3709
|
+
queryParameters = {};
|
|
3710
|
+
if (requestParameters.email !== undefined) {
|
|
3711
|
+
queryParameters['email'] = requestParameters.email;
|
|
3712
|
+
}
|
|
3713
|
+
headerParameters = {};
|
|
3714
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
3715
|
+
headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
|
|
3716
|
+
}
|
|
3717
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
3718
|
+
// oauth required
|
|
3719
|
+
_a = headerParameters;
|
|
3720
|
+
_b = "Authorization";
|
|
3721
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["storefront_read"])];
|
|
3722
|
+
case 1:
|
|
3723
|
+
// oauth required
|
|
3724
|
+
_a[_b] = _c.sent();
|
|
3725
|
+
_c.label = 2;
|
|
3726
|
+
case 2:
|
|
3727
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
3728
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
3729
|
+
}
|
|
3730
|
+
return [4 /*yield*/, this.request({
|
|
3731
|
+
path: "/storefront/{storefront_oid}/email/dispatch_logs/customer_lookup".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
|
|
3732
|
+
method: 'GET',
|
|
3733
|
+
headers: headerParameters,
|
|
3734
|
+
query: queryParameters,
|
|
3735
|
+
}, initOverrides)];
|
|
3736
|
+
case 3:
|
|
3737
|
+
response = _c.sent();
|
|
3738
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.EmailCustomerLookupResponseFromJSON)(jsonValue); })];
|
|
3739
|
+
}
|
|
3740
|
+
});
|
|
3741
|
+
});
|
|
3742
|
+
};
|
|
3743
|
+
/**
|
|
3744
|
+
* 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.
|
|
3745
|
+
* Resolve a customer email to its ESP customer UUID
|
|
3746
|
+
*/
|
|
3747
|
+
StorefrontApi.prototype.getEmailDispatchLogCustomerLookup = function (requestParameters, initOverrides) {
|
|
3748
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
3749
|
+
var response;
|
|
3750
|
+
return __generator(this, function (_a) {
|
|
3751
|
+
switch (_a.label) {
|
|
3752
|
+
case 0: return [4 /*yield*/, this.getEmailDispatchLogCustomerLookupRaw(requestParameters, initOverrides)];
|
|
3753
|
+
case 1:
|
|
3754
|
+
response = _a.sent();
|
|
3755
|
+
return [4 /*yield*/, response.value()];
|
|
3756
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
3757
|
+
}
|
|
3758
|
+
});
|
|
3759
|
+
});
|
|
3760
|
+
};
|
|
3616
3761
|
/**
|
|
3617
3762
|
* Get email dispatch logs
|
|
3618
3763
|
*/
|
|
@@ -5696,6 +5841,160 @@ var StorefrontApi = /** @class */ (function (_super) {
|
|
|
5696
5841
|
});
|
|
5697
5842
|
});
|
|
5698
5843
|
};
|
|
5844
|
+
/**
|
|
5845
|
+
* 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.
|
|
5846
|
+
* Get the full detail of a single dispatch-log record
|
|
5847
|
+
*/
|
|
5848
|
+
StorefrontApi.prototype.getEmailStepDispatchLogDetailRaw = function (requestParameters, initOverrides) {
|
|
5849
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
5850
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
5851
|
+
return __generator(this, function (_c) {
|
|
5852
|
+
switch (_c.label) {
|
|
5853
|
+
case 0:
|
|
5854
|
+
if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
|
|
5855
|
+
throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getEmailStepDispatchLogDetail.');
|
|
5856
|
+
}
|
|
5857
|
+
if (requestParameters.commseqUuid === null || requestParameters.commseqUuid === undefined) {
|
|
5858
|
+
throw new runtime.RequiredError('commseqUuid', 'Required parameter requestParameters.commseqUuid was null or undefined when calling getEmailStepDispatchLogDetail.');
|
|
5859
|
+
}
|
|
5860
|
+
if (requestParameters.commseqStepUuid === null || requestParameters.commseqStepUuid === undefined) {
|
|
5861
|
+
throw new runtime.RequiredError('commseqStepUuid', 'Required parameter requestParameters.commseqStepUuid was null or undefined when calling getEmailStepDispatchLogDetail.');
|
|
5862
|
+
}
|
|
5863
|
+
queryParameters = {};
|
|
5864
|
+
if (requestParameters.logDts !== undefined) {
|
|
5865
|
+
queryParameters['log_dts'] = requestParameters.logDts;
|
|
5866
|
+
}
|
|
5867
|
+
if (requestParameters.espCustomerUuid !== undefined) {
|
|
5868
|
+
queryParameters['esp_customer_uuid'] = requestParameters.espCustomerUuid;
|
|
5869
|
+
}
|
|
5870
|
+
headerParameters = {};
|
|
5871
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
5872
|
+
headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
|
|
5873
|
+
}
|
|
5874
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
5875
|
+
// oauth required
|
|
5876
|
+
_a = headerParameters;
|
|
5877
|
+
_b = "Authorization";
|
|
5878
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["storefront_read"])];
|
|
5879
|
+
case 1:
|
|
5880
|
+
// oauth required
|
|
5881
|
+
_a[_b] = _c.sent();
|
|
5882
|
+
_c.label = 2;
|
|
5883
|
+
case 2:
|
|
5884
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
5885
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
5886
|
+
}
|
|
5887
|
+
return [4 /*yield*/, this.request({
|
|
5888
|
+
path: "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/dispatch_logs/detail".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("commseq_uuid", "}"), encodeURIComponent(String(requestParameters.commseqUuid))).replace("{".concat("commseq_step_uuid", "}"), encodeURIComponent(String(requestParameters.commseqStepUuid))),
|
|
5889
|
+
method: 'GET',
|
|
5890
|
+
headers: headerParameters,
|
|
5891
|
+
query: queryParameters,
|
|
5892
|
+
}, initOverrides)];
|
|
5893
|
+
case 3:
|
|
5894
|
+
response = _c.sent();
|
|
5895
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.EmailDispatchLogDetailResponseFromJSON)(jsonValue); })];
|
|
5896
|
+
}
|
|
5897
|
+
});
|
|
5898
|
+
});
|
|
5899
|
+
};
|
|
5900
|
+
/**
|
|
5901
|
+
* 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.
|
|
5902
|
+
* Get the full detail of a single dispatch-log record
|
|
5903
|
+
*/
|
|
5904
|
+
StorefrontApi.prototype.getEmailStepDispatchLogDetail = function (requestParameters, initOverrides) {
|
|
5905
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
5906
|
+
var response;
|
|
5907
|
+
return __generator(this, function (_a) {
|
|
5908
|
+
switch (_a.label) {
|
|
5909
|
+
case 0: return [4 /*yield*/, this.getEmailStepDispatchLogDetailRaw(requestParameters, initOverrides)];
|
|
5910
|
+
case 1:
|
|
5911
|
+
response = _a.sent();
|
|
5912
|
+
return [4 /*yield*/, response.value()];
|
|
5913
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
5914
|
+
}
|
|
5915
|
+
});
|
|
5916
|
+
});
|
|
5917
|
+
};
|
|
5918
|
+
/**
|
|
5919
|
+
* 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.
|
|
5920
|
+
* Get a paginated, date-boundable dispatch-log feed for a step
|
|
5921
|
+
*/
|
|
5922
|
+
StorefrontApi.prototype.getEmailStepDispatchLogsRaw = function (requestParameters, initOverrides) {
|
|
5923
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
5924
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
5925
|
+
return __generator(this, function (_c) {
|
|
5926
|
+
switch (_c.label) {
|
|
5927
|
+
case 0:
|
|
5928
|
+
if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
|
|
5929
|
+
throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getEmailStepDispatchLogs.');
|
|
5930
|
+
}
|
|
5931
|
+
if (requestParameters.commseqUuid === null || requestParameters.commseqUuid === undefined) {
|
|
5932
|
+
throw new runtime.RequiredError('commseqUuid', 'Required parameter requestParameters.commseqUuid was null or undefined when calling getEmailStepDispatchLogs.');
|
|
5933
|
+
}
|
|
5934
|
+
if (requestParameters.commseqStepUuid === null || requestParameters.commseqStepUuid === undefined) {
|
|
5935
|
+
throw new runtime.RequiredError('commseqStepUuid', 'Required parameter requestParameters.commseqStepUuid was null or undefined when calling getEmailStepDispatchLogs.');
|
|
5936
|
+
}
|
|
5937
|
+
queryParameters = {};
|
|
5938
|
+
if (requestParameters.since !== undefined) {
|
|
5939
|
+
queryParameters['since'] = requestParameters.since;
|
|
5940
|
+
}
|
|
5941
|
+
if (requestParameters.until !== undefined) {
|
|
5942
|
+
queryParameters['until'] = requestParameters.until;
|
|
5943
|
+
}
|
|
5944
|
+
if (requestParameters.pageNumber !== undefined) {
|
|
5945
|
+
queryParameters['pageNumber'] = requestParameters.pageNumber;
|
|
5946
|
+
}
|
|
5947
|
+
if (requestParameters.pageSize !== undefined) {
|
|
5948
|
+
queryParameters['pageSize'] = requestParameters.pageSize;
|
|
5949
|
+
}
|
|
5950
|
+
headerParameters = {};
|
|
5951
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
5952
|
+
headerParameters["x-ultracart-browser-key"] = this.configuration.apiKey("x-ultracart-browser-key"); // ultraCartBrowserApiKey authentication
|
|
5953
|
+
}
|
|
5954
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
5955
|
+
// oauth required
|
|
5956
|
+
_a = headerParameters;
|
|
5957
|
+
_b = "Authorization";
|
|
5958
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", ["storefront_read"])];
|
|
5959
|
+
case 1:
|
|
5960
|
+
// oauth required
|
|
5961
|
+
_a[_b] = _c.sent();
|
|
5962
|
+
_c.label = 2;
|
|
5963
|
+
case 2:
|
|
5964
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
5965
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
5966
|
+
}
|
|
5967
|
+
return [4 /*yield*/, this.request({
|
|
5968
|
+
path: "/storefront/{storefront_oid}/email/commseqs/{commseq_uuid}/steps/{commseq_step_uuid}/dispatch_logs".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("commseq_uuid", "}"), encodeURIComponent(String(requestParameters.commseqUuid))).replace("{".concat("commseq_step_uuid", "}"), encodeURIComponent(String(requestParameters.commseqStepUuid))),
|
|
5969
|
+
method: 'GET',
|
|
5970
|
+
headers: headerParameters,
|
|
5971
|
+
query: queryParameters,
|
|
5972
|
+
}, initOverrides)];
|
|
5973
|
+
case 3:
|
|
5974
|
+
response = _c.sent();
|
|
5975
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.EmailDispatchLogsResponseFromJSON)(jsonValue); })];
|
|
5976
|
+
}
|
|
5977
|
+
});
|
|
5978
|
+
});
|
|
5979
|
+
};
|
|
5980
|
+
/**
|
|
5981
|
+
* 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.
|
|
5982
|
+
* Get a paginated, date-boundable dispatch-log feed for a step
|
|
5983
|
+
*/
|
|
5984
|
+
StorefrontApi.prototype.getEmailStepDispatchLogs = function (requestParameters, initOverrides) {
|
|
5985
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
5986
|
+
var response;
|
|
5987
|
+
return __generator(this, function (_a) {
|
|
5988
|
+
switch (_a.label) {
|
|
5989
|
+
case 0: return [4 /*yield*/, this.getEmailStepDispatchLogsRaw(requestParameters, initOverrides)];
|
|
5990
|
+
case 1:
|
|
5991
|
+
response = _a.sent();
|
|
5992
|
+
return [4 /*yield*/, response.value()];
|
|
5993
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
5994
|
+
}
|
|
5995
|
+
});
|
|
5996
|
+
});
|
|
5997
|
+
};
|
|
5699
5998
|
/**
|
|
5700
5999
|
* Get email template
|
|
5701
6000
|
*/
|
|
@@ -121,6 +121,7 @@ export declare const ConversationMessageTypeEnum: {
|
|
|
121
121
|
readonly Message: "message";
|
|
122
122
|
readonly Notice: "notice";
|
|
123
123
|
readonly EngagementPrompt: "engagement prompt";
|
|
124
|
+
readonly ToolCall: "tool call";
|
|
124
125
|
};
|
|
125
126
|
export type ConversationMessageTypeEnum = typeof ConversationMessageTypeEnum[keyof typeof ConversationMessageTypeEnum];
|
|
126
127
|
/**
|
|
@@ -23,7 +23,8 @@ var ConversationMessageTransportStatus_1 = require("./ConversationMessageTranspo
|
|
|
23
23
|
exports.ConversationMessageTypeEnum = {
|
|
24
24
|
Message: 'message',
|
|
25
25
|
Notice: 'notice',
|
|
26
|
-
EngagementPrompt: 'engagement prompt'
|
|
26
|
+
EngagementPrompt: 'engagement prompt',
|
|
27
|
+
ToolCall: 'tool call'
|
|
27
28
|
};
|
|
28
29
|
/**
|
|
29
30
|
* Check if a given object implements the ConversationMessage interface.
|