ultracart_rest_api_v2_typescript 4.1.227 → 4.1.228
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 +3 -0
- package/README.md +3 -2
- package/dist/apis/SfvbApi.d.ts +38 -1
- package/dist/apis/SfvbApi.js +74 -0
- package/dist/models/SfvbBlogPostDetail.d.ts +6 -0
- package/dist/models/SfvbBlogPostDetail.js +2 -0
- package/dist/models/SfvbBlogPostRequest.d.ts +6 -0
- package/dist/models/SfvbBlogPostRequest.js +2 -0
- package/dist/models/SfvbStepCounts.d.ts +79 -0
- package/dist/models/SfvbStepCounts.js +66 -0
- package/dist/models/SfvbStepDispatchLog.d.ts +43 -0
- package/dist/models/SfvbStepDispatchLog.js +54 -0
- package/dist/models/SfvbStepDispatchLogsResponse.d.ts +75 -0
- package/dist/models/SfvbStepDispatchLogsResponse.js +66 -0
- package/dist/models/index.d.ts +3 -0
- package/dist/models/index.js +3 -0
- package/package.json +1 -1
- package/src/apis/SfvbApi.ts +94 -0
- package/src/models/SfvbBlogPostDetail.ts +8 -0
- package/src/models/SfvbBlogPostRequest.ts +8 -0
- package/src/models/SfvbStepCounts.ts +131 -0
- package/src/models/SfvbStepDispatchLog.ts +83 -0
- package/src/models/SfvbStepDispatchLogsResponse.ts +136 -0
- package/src/models/index.ts +3 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -1233,6 +1233,9 @@ src/models/SfvbSitemapsResponse.ts
|
|
|
1233
1233
|
src/models/SfvbSmartAttribution.ts
|
|
1234
1234
|
src/models/SfvbSmartAttributionPlatform.ts
|
|
1235
1235
|
src/models/SfvbSmartAttributionRequest.ts
|
|
1236
|
+
src/models/SfvbStepCounts.ts
|
|
1237
|
+
src/models/SfvbStepDispatchLog.ts
|
|
1238
|
+
src/models/SfvbStepDispatchLogsResponse.ts
|
|
1236
1239
|
src/models/SfvbStorefront.ts
|
|
1237
1240
|
src/models/SfvbStorefrontsResponse.ts
|
|
1238
1241
|
src/models/SfvbTemplate.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.228
|
|
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.228 --save
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
@@ -84,6 +84,7 @@ Not every change is committed to every SDK.
|
|
|
84
84
|
|
|
85
85
|
| Version | Date | Comments |
|
|
86
86
|
| --: | :-: | --- |
|
|
87
|
+
| 4.1.228 | 11/04/2026 | sfvb internal testing |
|
|
87
88
|
| 4.1.227 | 11/04/2026 | sfvb internal testing |
|
|
88
89
|
| 4.1.226 | 11/04/2026 | sfvb internal testing |
|
|
89
90
|
| 4.1.225 | 11/03/2026 | sfvb internal testing |
|
package/dist/apis/SfvbApi.d.ts
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { SfvbAffiliateNetwork, SfvbAffiliateNetworkRequest, SfvbAffiliateNetworksResponse, SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbArchiveRequest, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCampaign, SfvbCampaignWriteRequest, SfvbCampaignsResponse, SfvbCodeLibraryEmailsResponse, SfvbCommsListsResponse, SfvbCommsSegmentResponse, SfvbCommsSegmentWriteRequest, SfvbCommsSegmentsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbEmail, SfvbEmailRenderRequest, SfvbEmailRenderResponse, SfvbEmailReviewRequest, SfvbEmailUpdateRequest, SfvbEventsAuthRequest, SfvbEventsAuthResponse, SfvbEventsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbFlow, SfvbFlowStatusRequest, SfvbFlowWriteRequest, SfvbFlowsResponse, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeBatchRequest, SfvbItemAttributeBatchResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaDescriptionRequest, SfvbItemMultimediaRequest, SfvbItemPricing, SfvbItemPricingRequest, SfvbItemRelated, SfvbItemRelatedRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbNotFoundEntry, SfvbNotFoundEntryResponse, SfvbNotFoundPage, SfvbNotFoundResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPostcardProofRequest, SfvbPostcardProofResponse, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbSequence, SfvbSequenceStepCreateRequest, SfvbSequenceStepCreateResponse, SfvbSequenceStepDeleteResponse, SfvbSequenceStepMoveRequest, SfvbSequenceStepMoveResponse, SfvbSequenceStepUpdateRequest, SfvbSequenceStepUpdateResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbSitemapsResponse, SfvbSmartAttribution, SfvbSmartAttributionRequest, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTrackingAdvancedRequest, SfvbTrackingHtml, SfvbTrackingHtmlRequest, SfvbTrackingHtmlResponse, SfvbTrackingPrivacyRequest, SfvbTrackingProvider, SfvbTrackingProviderRequest, SfvbTrackingProvidersResponse, SfvbTrackingSettingsResponse, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbUtmShortcode, SfvbUtmShortcodeRequest, SfvbUtmShortcodesResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
|
|
13
|
+
import { SfvbAffiliateNetwork, SfvbAffiliateNetworkRequest, SfvbAffiliateNetworksResponse, SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbArchiveRequest, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCampaign, SfvbCampaignWriteRequest, SfvbCampaignsResponse, SfvbCodeLibraryEmailsResponse, SfvbCommsListsResponse, SfvbCommsSegmentResponse, SfvbCommsSegmentWriteRequest, SfvbCommsSegmentsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbEmail, SfvbEmailRenderRequest, SfvbEmailRenderResponse, SfvbEmailReviewRequest, SfvbEmailUpdateRequest, SfvbEventsAuthRequest, SfvbEventsAuthResponse, SfvbEventsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbFlow, SfvbFlowStatusRequest, SfvbFlowWriteRequest, SfvbFlowsResponse, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeBatchRequest, SfvbItemAttributeBatchResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaDescriptionRequest, SfvbItemMultimediaRequest, SfvbItemPricing, SfvbItemPricingRequest, SfvbItemRelated, SfvbItemRelatedRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbNotFoundEntry, SfvbNotFoundEntryResponse, SfvbNotFoundPage, SfvbNotFoundResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPostcardProofRequest, SfvbPostcardProofResponse, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbSequence, SfvbSequenceStepCreateRequest, SfvbSequenceStepCreateResponse, SfvbSequenceStepDeleteResponse, SfvbSequenceStepMoveRequest, SfvbSequenceStepMoveResponse, SfvbSequenceStepUpdateRequest, SfvbSequenceStepUpdateResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbSitemapsResponse, SfvbSmartAttribution, SfvbSmartAttributionRequest, SfvbStepDispatchLogsResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTrackingAdvancedRequest, SfvbTrackingHtml, SfvbTrackingHtmlRequest, SfvbTrackingHtmlResponse, SfvbTrackingPrivacyRequest, SfvbTrackingProvider, SfvbTrackingProviderRequest, SfvbTrackingProvidersResponse, SfvbTrackingSettingsResponse, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbUtmShortcode, SfvbUtmShortcodeRequest, SfvbUtmShortcodesResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
|
|
14
14
|
export interface AddSfvbPageBlogPostsRequest {
|
|
15
15
|
storefrontOid: number;
|
|
16
16
|
path: string;
|
|
@@ -462,6 +462,14 @@ export interface GetSfvbSequenceRequest {
|
|
|
462
462
|
sequenceUuid: string;
|
|
463
463
|
waiting?: boolean;
|
|
464
464
|
}
|
|
465
|
+
export interface GetSfvbSequenceStepDispatchLogsRequest {
|
|
466
|
+
storefrontOid: number;
|
|
467
|
+
sequenceUuid: string;
|
|
468
|
+
stepUuid: string;
|
|
469
|
+
since?: string;
|
|
470
|
+
limit?: number;
|
|
471
|
+
offset?: number;
|
|
472
|
+
}
|
|
465
473
|
export interface GetSfvbServerLogRequest {
|
|
466
474
|
storefrontOid: number;
|
|
467
475
|
logId: string;
|
|
@@ -2753,6 +2761,25 @@ export interface SfvbApiInterface {
|
|
|
2753
2761
|
* Get a campaign\'s or flow\'s steps as a tree
|
|
2754
2762
|
*/
|
|
2755
2763
|
getSfvbSequence(requestParameters: GetSfvbSequenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequence>;
|
|
2764
|
+
/**
|
|
2765
|
+
* Why customers were sent, skipped or ended at this step, newest first, as the admin\'s Dispatch Logs screen shows it, with the step\'s counts. An email step\'s counts are its email\'s; any other step\'s are its own over 90 days. Email addresses and phone numbers in the text are masked. since is 15m, 2h or 7d, or an ISO-8601 time, default 7d; entries are kept 90 days. limit is 1 to 200, default 50; send next_offset as offset for the next page. Read only.
|
|
2766
|
+
* @summary Read a flow or campaign step\'s dispatch log and counts
|
|
2767
|
+
* @param {number} storefrontOid
|
|
2768
|
+
* @param {string} sequenceUuid
|
|
2769
|
+
* @param {string} stepUuid
|
|
2770
|
+
* @param {string} [since]
|
|
2771
|
+
* @param {number} [limit]
|
|
2772
|
+
* @param {number} [offset]
|
|
2773
|
+
* @param {*} [options] Override http request option.
|
|
2774
|
+
* @throws {RequiredError}
|
|
2775
|
+
* @memberof SfvbApiInterface
|
|
2776
|
+
*/
|
|
2777
|
+
getSfvbSequenceStepDispatchLogsRaw(requestParameters: GetSfvbSequenceStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbStepDispatchLogsResponse>>;
|
|
2778
|
+
/**
|
|
2779
|
+
* Why customers were sent, skipped or ended at this step, newest first, as the admin\'s Dispatch Logs screen shows it, with the step\'s counts. An email step\'s counts are its email\'s; any other step\'s are its own over 90 days. Email addresses and phone numbers in the text are masked. since is 15m, 2h or 7d, or an ISO-8601 time, default 7d; entries are kept 90 days. limit is 1 to 200, default 50; send next_offset as offset for the next page. Read only.
|
|
2780
|
+
* Read a flow or campaign step\'s dispatch log and counts
|
|
2781
|
+
*/
|
|
2782
|
+
getSfvbSequenceStepDispatchLogs(requestParameters: GetSfvbSequenceStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbStepDispatchLogsResponse>;
|
|
2756
2783
|
/**
|
|
2757
2784
|
* One render\'s server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message. log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session. min_level is debug, info, warn or error, default debug.
|
|
2758
2785
|
* @summary Get one storefront render log
|
|
@@ -5921,6 +5948,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
5921
5948
|
* Get a campaign\'s or flow\'s steps as a tree
|
|
5922
5949
|
*/
|
|
5923
5950
|
getSfvbSequence(requestParameters: GetSfvbSequenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequence>;
|
|
5951
|
+
/**
|
|
5952
|
+
* Why customers were sent, skipped or ended at this step, newest first, as the admin\'s Dispatch Logs screen shows it, with the step\'s counts. An email step\'s counts are its email\'s; any other step\'s are its own over 90 days. Email addresses and phone numbers in the text are masked. since is 15m, 2h or 7d, or an ISO-8601 time, default 7d; entries are kept 90 days. limit is 1 to 200, default 50; send next_offset as offset for the next page. Read only.
|
|
5953
|
+
* Read a flow or campaign step\'s dispatch log and counts
|
|
5954
|
+
*/
|
|
5955
|
+
getSfvbSequenceStepDispatchLogsRaw(requestParameters: GetSfvbSequenceStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbStepDispatchLogsResponse>>;
|
|
5956
|
+
/**
|
|
5957
|
+
* Why customers were sent, skipped or ended at this step, newest first, as the admin\'s Dispatch Logs screen shows it, with the step\'s counts. An email step\'s counts are its email\'s; any other step\'s are its own over 90 days. Email addresses and phone numbers in the text are masked. since is 15m, 2h or 7d, or an ISO-8601 time, default 7d; entries are kept 90 days. limit is 1 to 200, default 50; send next_offset as offset for the next page. Read only.
|
|
5958
|
+
* Read a flow or campaign step\'s dispatch log and counts
|
|
5959
|
+
*/
|
|
5960
|
+
getSfvbSequenceStepDispatchLogs(requestParameters: GetSfvbSequenceStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbStepDispatchLogsResponse>;
|
|
5924
5961
|
/**
|
|
5925
5962
|
* One render\'s server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message. log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session. min_level is debug, info, warn or error, default debug.
|
|
5926
5963
|
* Get one storefront render log
|
package/dist/apis/SfvbApi.js
CHANGED
|
@@ -6835,6 +6835,80 @@ var SfvbApi = /** @class */ (function (_super) {
|
|
|
6835
6835
|
});
|
|
6836
6836
|
});
|
|
6837
6837
|
};
|
|
6838
|
+
/**
|
|
6839
|
+
* Why customers were sent, skipped or ended at this step, newest first, as the admin\'s Dispatch Logs screen shows it, with the step\'s counts. An email step\'s counts are its email\'s; any other step\'s are its own over 90 days. Email addresses and phone numbers in the text are masked. since is 15m, 2h or 7d, or an ISO-8601 time, default 7d; entries are kept 90 days. limit is 1 to 200, default 50; send next_offset as offset for the next page. Read only.
|
|
6840
|
+
* Read a flow or campaign step\'s dispatch log and counts
|
|
6841
|
+
*/
|
|
6842
|
+
SfvbApi.prototype.getSfvbSequenceStepDispatchLogsRaw = function (requestParameters, initOverrides) {
|
|
6843
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
6844
|
+
var queryParameters, headerParameters, _a, _b, response;
|
|
6845
|
+
return __generator(this, function (_c) {
|
|
6846
|
+
switch (_c.label) {
|
|
6847
|
+
case 0:
|
|
6848
|
+
if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
|
|
6849
|
+
throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getSfvbSequenceStepDispatchLogs.');
|
|
6850
|
+
}
|
|
6851
|
+
if (requestParameters.sequenceUuid === null || requestParameters.sequenceUuid === undefined) {
|
|
6852
|
+
throw new runtime.RequiredError('sequenceUuid', 'Required parameter requestParameters.sequenceUuid was null or undefined when calling getSfvbSequenceStepDispatchLogs.');
|
|
6853
|
+
}
|
|
6854
|
+
if (requestParameters.stepUuid === null || requestParameters.stepUuid === undefined) {
|
|
6855
|
+
throw new runtime.RequiredError('stepUuid', 'Required parameter requestParameters.stepUuid was null or undefined when calling getSfvbSequenceStepDispatchLogs.');
|
|
6856
|
+
}
|
|
6857
|
+
queryParameters = {};
|
|
6858
|
+
if (requestParameters.since !== undefined) {
|
|
6859
|
+
queryParameters['since'] = requestParameters.since;
|
|
6860
|
+
}
|
|
6861
|
+
if (requestParameters.limit !== undefined) {
|
|
6862
|
+
queryParameters['limit'] = requestParameters.limit;
|
|
6863
|
+
}
|
|
6864
|
+
if (requestParameters.offset !== undefined) {
|
|
6865
|
+
queryParameters['offset'] = requestParameters.offset;
|
|
6866
|
+
}
|
|
6867
|
+
headerParameters = {};
|
|
6868
|
+
if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
|
|
6869
|
+
// oauth required
|
|
6870
|
+
_a = headerParameters;
|
|
6871
|
+
_b = "Authorization";
|
|
6872
|
+
return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
|
|
6873
|
+
case 1:
|
|
6874
|
+
// oauth required
|
|
6875
|
+
_a[_b] = _c.sent();
|
|
6876
|
+
_c.label = 2;
|
|
6877
|
+
case 2:
|
|
6878
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
6879
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
6880
|
+
}
|
|
6881
|
+
return [4 /*yield*/, this.request({
|
|
6882
|
+
path: "/sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/dispatch_logs".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("sequence_uuid", "}"), encodeURIComponent(String(requestParameters.sequenceUuid))).replace("{".concat("step_uuid", "}"), encodeURIComponent(String(requestParameters.stepUuid))),
|
|
6883
|
+
method: 'GET',
|
|
6884
|
+
headers: headerParameters,
|
|
6885
|
+
query: queryParameters,
|
|
6886
|
+
}, initOverrides)];
|
|
6887
|
+
case 3:
|
|
6888
|
+
response = _c.sent();
|
|
6889
|
+
return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbStepDispatchLogsResponseFromJSON)(jsonValue); })];
|
|
6890
|
+
}
|
|
6891
|
+
});
|
|
6892
|
+
});
|
|
6893
|
+
};
|
|
6894
|
+
/**
|
|
6895
|
+
* Why customers were sent, skipped or ended at this step, newest first, as the admin\'s Dispatch Logs screen shows it, with the step\'s counts. An email step\'s counts are its email\'s; any other step\'s are its own over 90 days. Email addresses and phone numbers in the text are masked. since is 15m, 2h or 7d, or an ISO-8601 time, default 7d; entries are kept 90 days. limit is 1 to 200, default 50; send next_offset as offset for the next page. Read only.
|
|
6896
|
+
* Read a flow or campaign step\'s dispatch log and counts
|
|
6897
|
+
*/
|
|
6898
|
+
SfvbApi.prototype.getSfvbSequenceStepDispatchLogs = function (requestParameters, initOverrides) {
|
|
6899
|
+
return __awaiter(this, void 0, void 0, function () {
|
|
6900
|
+
var response;
|
|
6901
|
+
return __generator(this, function (_a) {
|
|
6902
|
+
switch (_a.label) {
|
|
6903
|
+
case 0: return [4 /*yield*/, this.getSfvbSequenceStepDispatchLogsRaw(requestParameters, initOverrides)];
|
|
6904
|
+
case 1:
|
|
6905
|
+
response = _a.sent();
|
|
6906
|
+
return [4 /*yield*/, response.value()];
|
|
6907
|
+
case 2: return [2 /*return*/, _a.sent()];
|
|
6908
|
+
}
|
|
6909
|
+
});
|
|
6910
|
+
});
|
|
6911
|
+
};
|
|
6838
6912
|
/**
|
|
6839
6913
|
* One render\'s server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message. log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session. min_level is debug, info, warn or error, default debug.
|
|
6840
6914
|
* Get one storefront render log
|
|
@@ -46,6 +46,12 @@ export interface SfvbBlogPostDetail {
|
|
|
46
46
|
* @memberof SfvbBlogPostDetail
|
|
47
47
|
*/
|
|
48
48
|
created_dts?: string;
|
|
49
|
+
/**
|
|
50
|
+
* True when this is the result of a dry run and nothing was saved. The post is shown as it is stored.
|
|
51
|
+
* @type {boolean}
|
|
52
|
+
* @memberof SfvbBlogPostDetail
|
|
53
|
+
*/
|
|
54
|
+
dry_run?: boolean;
|
|
49
55
|
/**
|
|
50
56
|
* The post excerpt as HTML, exactly as stored.
|
|
51
57
|
* @type {string}
|
|
@@ -38,6 +38,7 @@ function SfvbBlogPostDetailFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
38
38
|
'blog_post_oid': !(0, runtime_1.exists)(json, 'blog_post_oid') ? undefined : json['blog_post_oid'],
|
|
39
39
|
'body': !(0, runtime_1.exists)(json, 'body') ? undefined : json['body'],
|
|
40
40
|
'created_dts': !(0, runtime_1.exists)(json, 'created_dts') ? undefined : json['created_dts'],
|
|
41
|
+
'dry_run': !(0, runtime_1.exists)(json, 'dry_run') ? undefined : json['dry_run'],
|
|
41
42
|
'excerpt': !(0, runtime_1.exists)(json, 'excerpt') ? undefined : json['excerpt'],
|
|
42
43
|
'images': !(0, runtime_1.exists)(json, 'images') ? undefined : (json['images'].map(SfvbBlogPostImage_1.SfvbBlogPostImageFromJSON)),
|
|
43
44
|
'last_modified_dts': !(0, runtime_1.exists)(json, 'last_modified_dts') ? undefined : json['last_modified_dts'],
|
|
@@ -67,6 +68,7 @@ function SfvbBlogPostDetailToJSON(value) {
|
|
|
67
68
|
'blog_post_oid': value.blog_post_oid,
|
|
68
69
|
'body': value.body,
|
|
69
70
|
'created_dts': value.created_dts,
|
|
71
|
+
'dry_run': value.dry_run,
|
|
70
72
|
'excerpt': value.excerpt,
|
|
71
73
|
'images': value.images === undefined ? undefined : (value.images.map(SfvbBlogPostImage_1.SfvbBlogPostImageToJSON)),
|
|
72
74
|
'last_modified_dts': value.last_modified_dts,
|
|
@@ -33,6 +33,12 @@ export interface SfvbBlogPostRequest {
|
|
|
33
33
|
* @memberof SfvbBlogPostRequest
|
|
34
34
|
*/
|
|
35
35
|
body?: string;
|
|
36
|
+
/**
|
|
37
|
+
* On an update, true to run every check the write would run and save nothing. A refusal comes back exactly as it would on the real write.
|
|
38
|
+
* @type {boolean}
|
|
39
|
+
* @memberof SfvbBlogPostRequest
|
|
40
|
+
*/
|
|
41
|
+
dry_run?: boolean;
|
|
36
42
|
/**
|
|
37
43
|
* The post excerpt as HTML, up to 256 KB. Held to the same rule as body.
|
|
38
44
|
* @type {string}
|
|
@@ -43,6 +43,7 @@ function SfvbBlogPostRequestFromJSONTyped(json, ignoreDiscriminator) {
|
|
|
43
43
|
'allow_comments': !(0, runtime_1.exists)(json, 'allow_comments') ? undefined : json['allow_comments'],
|
|
44
44
|
'author': !(0, runtime_1.exists)(json, 'author') ? undefined : json['author'],
|
|
45
45
|
'body': !(0, runtime_1.exists)(json, 'body') ? undefined : json['body'],
|
|
46
|
+
'dry_run': !(0, runtime_1.exists)(json, 'dry_run') ? undefined : json['dry_run'],
|
|
46
47
|
'excerpt': !(0, runtime_1.exists)(json, 'excerpt') ? undefined : json['excerpt'],
|
|
47
48
|
'publication_dts': !(0, runtime_1.exists)(json, 'publication_dts') ? undefined : json['publication_dts'],
|
|
48
49
|
'seo_description': !(0, runtime_1.exists)(json, 'seo_description') ? undefined : json['seo_description'],
|
|
@@ -66,6 +67,7 @@ function SfvbBlogPostRequestToJSON(value) {
|
|
|
66
67
|
'allow_comments': value.allow_comments,
|
|
67
68
|
'author': value.author,
|
|
68
69
|
'body': value.body,
|
|
70
|
+
'dry_run': value.dry_run,
|
|
69
71
|
'excerpt': value.excerpt,
|
|
70
72
|
'publication_dts': value.publication_dts,
|
|
71
73
|
'seo_description': value.seo_description,
|
|
@@ -0,0 +1,79 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* UltraCart Rest API V2
|
|
3
|
+
* UltraCart REST API Version 2
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
|
6
|
+
* Contact: support@ultracart.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface SfvbStepCounts
|
|
16
|
+
*/
|
|
17
|
+
export interface SfvbStepCounts {
|
|
18
|
+
/**
|
|
19
|
+
* Messages with a click.
|
|
20
|
+
* @type {number}
|
|
21
|
+
* @memberof SfvbStepCounts
|
|
22
|
+
*/
|
|
23
|
+
clicked?: number;
|
|
24
|
+
/**
|
|
25
|
+
* For a step that isn't an email, the customers that passed through it.
|
|
26
|
+
* @type {number}
|
|
27
|
+
* @memberof SfvbStepCounts
|
|
28
|
+
*/
|
|
29
|
+
customers?: number;
|
|
30
|
+
/**
|
|
31
|
+
* Messages delivered.
|
|
32
|
+
* @type {number}
|
|
33
|
+
* @memberof SfvbStepCounts
|
|
34
|
+
*/
|
|
35
|
+
delivered?: number;
|
|
36
|
+
/**
|
|
37
|
+
* Emails opened.
|
|
38
|
+
* @type {number}
|
|
39
|
+
* @memberof SfvbStepCounts
|
|
40
|
+
*/
|
|
41
|
+
opened?: number;
|
|
42
|
+
/**
|
|
43
|
+
* Messages sent.
|
|
44
|
+
* @type {number}
|
|
45
|
+
* @memberof SfvbStepCounts
|
|
46
|
+
*/
|
|
47
|
+
sent?: number;
|
|
48
|
+
/**
|
|
49
|
+
* Customers who reached the step and were not sent anything. The dispatch log says why.
|
|
50
|
+
* @type {number}
|
|
51
|
+
* @memberof SfvbStepCounts
|
|
52
|
+
*/
|
|
53
|
+
skipped?: number;
|
|
54
|
+
/**
|
|
55
|
+
* email (the step's email, all time) or step (this step, the last 90 days).
|
|
56
|
+
* @type {string}
|
|
57
|
+
* @memberof SfvbStepCounts
|
|
58
|
+
*/
|
|
59
|
+
source?: string;
|
|
60
|
+
/**
|
|
61
|
+
* Spam complaints.
|
|
62
|
+
* @type {number}
|
|
63
|
+
* @memberof SfvbStepCounts
|
|
64
|
+
*/
|
|
65
|
+
spam?: number;
|
|
66
|
+
/**
|
|
67
|
+
* Unsubscribes from these messages.
|
|
68
|
+
* @type {number}
|
|
69
|
+
* @memberof SfvbStepCounts
|
|
70
|
+
*/
|
|
71
|
+
unsubscribed?: number;
|
|
72
|
+
}
|
|
73
|
+
/**
|
|
74
|
+
* Check if a given object implements the SfvbStepCounts interface.
|
|
75
|
+
*/
|
|
76
|
+
export declare function instanceOfSfvbStepCounts(value: object): boolean;
|
|
77
|
+
export declare function SfvbStepCountsFromJSON(json: any): SfvbStepCounts;
|
|
78
|
+
export declare function SfvbStepCountsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbStepCounts;
|
|
79
|
+
export declare function SfvbStepCountsToJSON(value?: SfvbStepCounts | null): any;
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* UltraCart Rest API V2
|
|
6
|
+
* UltraCart REST API Version 2
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2.0.0
|
|
9
|
+
* Contact: support@ultracart.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.SfvbStepCountsToJSON = exports.SfvbStepCountsFromJSONTyped = exports.SfvbStepCountsFromJSON = exports.instanceOfSfvbStepCounts = void 0;
|
|
17
|
+
var runtime_1 = require("../runtime");
|
|
18
|
+
/**
|
|
19
|
+
* Check if a given object implements the SfvbStepCounts interface.
|
|
20
|
+
*/
|
|
21
|
+
function instanceOfSfvbStepCounts(value) {
|
|
22
|
+
var isInstance = true;
|
|
23
|
+
return isInstance;
|
|
24
|
+
}
|
|
25
|
+
exports.instanceOfSfvbStepCounts = instanceOfSfvbStepCounts;
|
|
26
|
+
function SfvbStepCountsFromJSON(json) {
|
|
27
|
+
return SfvbStepCountsFromJSONTyped(json, false);
|
|
28
|
+
}
|
|
29
|
+
exports.SfvbStepCountsFromJSON = SfvbStepCountsFromJSON;
|
|
30
|
+
function SfvbStepCountsFromJSONTyped(json, ignoreDiscriminator) {
|
|
31
|
+
if ((json === undefined) || (json === null)) {
|
|
32
|
+
return json;
|
|
33
|
+
}
|
|
34
|
+
return {
|
|
35
|
+
'clicked': !(0, runtime_1.exists)(json, 'clicked') ? undefined : json['clicked'],
|
|
36
|
+
'customers': !(0, runtime_1.exists)(json, 'customers') ? undefined : json['customers'],
|
|
37
|
+
'delivered': !(0, runtime_1.exists)(json, 'delivered') ? undefined : json['delivered'],
|
|
38
|
+
'opened': !(0, runtime_1.exists)(json, 'opened') ? undefined : json['opened'],
|
|
39
|
+
'sent': !(0, runtime_1.exists)(json, 'sent') ? undefined : json['sent'],
|
|
40
|
+
'skipped': !(0, runtime_1.exists)(json, 'skipped') ? undefined : json['skipped'],
|
|
41
|
+
'source': !(0, runtime_1.exists)(json, 'source') ? undefined : json['source'],
|
|
42
|
+
'spam': !(0, runtime_1.exists)(json, 'spam') ? undefined : json['spam'],
|
|
43
|
+
'unsubscribed': !(0, runtime_1.exists)(json, 'unsubscribed') ? undefined : json['unsubscribed'],
|
|
44
|
+
};
|
|
45
|
+
}
|
|
46
|
+
exports.SfvbStepCountsFromJSONTyped = SfvbStepCountsFromJSONTyped;
|
|
47
|
+
function SfvbStepCountsToJSON(value) {
|
|
48
|
+
if (value === undefined) {
|
|
49
|
+
return undefined;
|
|
50
|
+
}
|
|
51
|
+
if (value === null) {
|
|
52
|
+
return null;
|
|
53
|
+
}
|
|
54
|
+
return {
|
|
55
|
+
'clicked': value.clicked,
|
|
56
|
+
'customers': value.customers,
|
|
57
|
+
'delivered': value.delivered,
|
|
58
|
+
'opened': value.opened,
|
|
59
|
+
'sent': value.sent,
|
|
60
|
+
'skipped': value.skipped,
|
|
61
|
+
'source': value.source,
|
|
62
|
+
'spam': value.spam,
|
|
63
|
+
'unsubscribed': value.unsubscribed,
|
|
64
|
+
};
|
|
65
|
+
}
|
|
66
|
+
exports.SfvbStepCountsToJSON = SfvbStepCountsToJSON;
|
|
@@ -0,0 +1,43 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* UltraCart Rest API V2
|
|
3
|
+
* UltraCart REST API Version 2
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
|
6
|
+
* Contact: support@ultracart.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
/**
|
|
13
|
+
*
|
|
14
|
+
* @export
|
|
15
|
+
* @interface SfvbStepDispatchLog
|
|
16
|
+
*/
|
|
17
|
+
export interface SfvbStepDispatchLog {
|
|
18
|
+
/**
|
|
19
|
+
* The customer the entry is about.
|
|
20
|
+
* @type {string}
|
|
21
|
+
* @memberof SfvbStepDispatchLog
|
|
22
|
+
*/
|
|
23
|
+
customer_uuid?: string;
|
|
24
|
+
/**
|
|
25
|
+
* What happened, as the admin's Dispatch Logs screen shows it, with email addresses and phone numbers masked.
|
|
26
|
+
* @type {string}
|
|
27
|
+
* @memberof SfvbStepDispatchLog
|
|
28
|
+
*/
|
|
29
|
+
detail?: string;
|
|
30
|
+
/**
|
|
31
|
+
* When the entry was written, as ISO 8601 with the server's offset.
|
|
32
|
+
* @type {string}
|
|
33
|
+
* @memberof SfvbStepDispatchLog
|
|
34
|
+
*/
|
|
35
|
+
logged_at?: string;
|
|
36
|
+
}
|
|
37
|
+
/**
|
|
38
|
+
* Check if a given object implements the SfvbStepDispatchLog interface.
|
|
39
|
+
*/
|
|
40
|
+
export declare function instanceOfSfvbStepDispatchLog(value: object): boolean;
|
|
41
|
+
export declare function SfvbStepDispatchLogFromJSON(json: any): SfvbStepDispatchLog;
|
|
42
|
+
export declare function SfvbStepDispatchLogFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbStepDispatchLog;
|
|
43
|
+
export declare function SfvbStepDispatchLogToJSON(value?: SfvbStepDispatchLog | null): any;
|
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* UltraCart Rest API V2
|
|
6
|
+
* UltraCart REST API Version 2
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2.0.0
|
|
9
|
+
* Contact: support@ultracart.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.SfvbStepDispatchLogToJSON = exports.SfvbStepDispatchLogFromJSONTyped = exports.SfvbStepDispatchLogFromJSON = exports.instanceOfSfvbStepDispatchLog = void 0;
|
|
17
|
+
var runtime_1 = require("../runtime");
|
|
18
|
+
/**
|
|
19
|
+
* Check if a given object implements the SfvbStepDispatchLog interface.
|
|
20
|
+
*/
|
|
21
|
+
function instanceOfSfvbStepDispatchLog(value) {
|
|
22
|
+
var isInstance = true;
|
|
23
|
+
return isInstance;
|
|
24
|
+
}
|
|
25
|
+
exports.instanceOfSfvbStepDispatchLog = instanceOfSfvbStepDispatchLog;
|
|
26
|
+
function SfvbStepDispatchLogFromJSON(json) {
|
|
27
|
+
return SfvbStepDispatchLogFromJSONTyped(json, false);
|
|
28
|
+
}
|
|
29
|
+
exports.SfvbStepDispatchLogFromJSON = SfvbStepDispatchLogFromJSON;
|
|
30
|
+
function SfvbStepDispatchLogFromJSONTyped(json, ignoreDiscriminator) {
|
|
31
|
+
if ((json === undefined) || (json === null)) {
|
|
32
|
+
return json;
|
|
33
|
+
}
|
|
34
|
+
return {
|
|
35
|
+
'customer_uuid': !(0, runtime_1.exists)(json, 'customer_uuid') ? undefined : json['customer_uuid'],
|
|
36
|
+
'detail': !(0, runtime_1.exists)(json, 'detail') ? undefined : json['detail'],
|
|
37
|
+
'logged_at': !(0, runtime_1.exists)(json, 'logged_at') ? undefined : json['logged_at'],
|
|
38
|
+
};
|
|
39
|
+
}
|
|
40
|
+
exports.SfvbStepDispatchLogFromJSONTyped = SfvbStepDispatchLogFromJSONTyped;
|
|
41
|
+
function SfvbStepDispatchLogToJSON(value) {
|
|
42
|
+
if (value === undefined) {
|
|
43
|
+
return undefined;
|
|
44
|
+
}
|
|
45
|
+
if (value === null) {
|
|
46
|
+
return null;
|
|
47
|
+
}
|
|
48
|
+
return {
|
|
49
|
+
'customer_uuid': value.customer_uuid,
|
|
50
|
+
'detail': value.detail,
|
|
51
|
+
'logged_at': value.logged_at,
|
|
52
|
+
};
|
|
53
|
+
}
|
|
54
|
+
exports.SfvbStepDispatchLogToJSON = SfvbStepDispatchLogToJSON;
|
|
@@ -0,0 +1,75 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* UltraCart Rest API V2
|
|
3
|
+
* UltraCart REST API Version 2
|
|
4
|
+
*
|
|
5
|
+
* The version of the OpenAPI document: 2.0.0
|
|
6
|
+
* Contact: support@ultracart.com
|
|
7
|
+
*
|
|
8
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
9
|
+
* https://openapi-generator.tech
|
|
10
|
+
* Do not edit the class manually.
|
|
11
|
+
*/
|
|
12
|
+
import { SfvbStepCounts } from './SfvbStepCounts';
|
|
13
|
+
import { SfvbStepDispatchLog } from './SfvbStepDispatchLog';
|
|
14
|
+
/**
|
|
15
|
+
*
|
|
16
|
+
* @export
|
|
17
|
+
* @interface SfvbStepDispatchLogsResponse
|
|
18
|
+
*/
|
|
19
|
+
export interface SfvbStepDispatchLogsResponse {
|
|
20
|
+
/**
|
|
21
|
+
*
|
|
22
|
+
* @type {SfvbStepCounts}
|
|
23
|
+
* @memberof SfvbStepDispatchLogsResponse
|
|
24
|
+
*/
|
|
25
|
+
counts?: SfvbStepCounts;
|
|
26
|
+
/**
|
|
27
|
+
* The entries in the window, newest first.
|
|
28
|
+
* @type {Array<SfvbStepDispatchLog>}
|
|
29
|
+
* @memberof SfvbStepDispatchLogsResponse
|
|
30
|
+
*/
|
|
31
|
+
entries?: Array<SfvbStepDispatchLog>;
|
|
32
|
+
/**
|
|
33
|
+
* Send this as offset for the next page. Absent on the last page.
|
|
34
|
+
* @type {number}
|
|
35
|
+
* @memberof SfvbStepDispatchLogsResponse
|
|
36
|
+
*/
|
|
37
|
+
next_offset?: number;
|
|
38
|
+
/**
|
|
39
|
+
* What a person should know about reading these entries.
|
|
40
|
+
* @type {Array<string>}
|
|
41
|
+
* @memberof SfvbStepDispatchLogsResponse
|
|
42
|
+
*/
|
|
43
|
+
notes?: Array<string>;
|
|
44
|
+
/**
|
|
45
|
+
* The communication sequence the step is in.
|
|
46
|
+
* @type {string}
|
|
47
|
+
* @memberof SfvbStepDispatchLogsResponse
|
|
48
|
+
*/
|
|
49
|
+
sequence_uuid?: string;
|
|
50
|
+
/**
|
|
51
|
+
* The start of the window read, as ISO 8601.
|
|
52
|
+
* @type {string}
|
|
53
|
+
* @memberof SfvbStepDispatchLogsResponse
|
|
54
|
+
*/
|
|
55
|
+
since?: string;
|
|
56
|
+
/**
|
|
57
|
+
* The step's type, such as email, sms or wait.
|
|
58
|
+
* @type {string}
|
|
59
|
+
* @memberof SfvbStepDispatchLogsResponse
|
|
60
|
+
*/
|
|
61
|
+
step_type?: string;
|
|
62
|
+
/**
|
|
63
|
+
* The step.
|
|
64
|
+
* @type {string}
|
|
65
|
+
* @memberof SfvbStepDispatchLogsResponse
|
|
66
|
+
*/
|
|
67
|
+
step_uuid?: string;
|
|
68
|
+
}
|
|
69
|
+
/**
|
|
70
|
+
* Check if a given object implements the SfvbStepDispatchLogsResponse interface.
|
|
71
|
+
*/
|
|
72
|
+
export declare function instanceOfSfvbStepDispatchLogsResponse(value: object): boolean;
|
|
73
|
+
export declare function SfvbStepDispatchLogsResponseFromJSON(json: any): SfvbStepDispatchLogsResponse;
|
|
74
|
+
export declare function SfvbStepDispatchLogsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbStepDispatchLogsResponse;
|
|
75
|
+
export declare function SfvbStepDispatchLogsResponseToJSON(value?: SfvbStepDispatchLogsResponse | null): any;
|
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
/* tslint:disable */
|
|
3
|
+
/* eslint-disable */
|
|
4
|
+
/**
|
|
5
|
+
* UltraCart Rest API V2
|
|
6
|
+
* UltraCart REST API Version 2
|
|
7
|
+
*
|
|
8
|
+
* The version of the OpenAPI document: 2.0.0
|
|
9
|
+
* Contact: support@ultracart.com
|
|
10
|
+
*
|
|
11
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
12
|
+
* https://openapi-generator.tech
|
|
13
|
+
* Do not edit the class manually.
|
|
14
|
+
*/
|
|
15
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
16
|
+
exports.SfvbStepDispatchLogsResponseToJSON = exports.SfvbStepDispatchLogsResponseFromJSONTyped = exports.SfvbStepDispatchLogsResponseFromJSON = exports.instanceOfSfvbStepDispatchLogsResponse = void 0;
|
|
17
|
+
var runtime_1 = require("../runtime");
|
|
18
|
+
var SfvbStepCounts_1 = require("./SfvbStepCounts");
|
|
19
|
+
var SfvbStepDispatchLog_1 = require("./SfvbStepDispatchLog");
|
|
20
|
+
/**
|
|
21
|
+
* Check if a given object implements the SfvbStepDispatchLogsResponse interface.
|
|
22
|
+
*/
|
|
23
|
+
function instanceOfSfvbStepDispatchLogsResponse(value) {
|
|
24
|
+
var isInstance = true;
|
|
25
|
+
return isInstance;
|
|
26
|
+
}
|
|
27
|
+
exports.instanceOfSfvbStepDispatchLogsResponse = instanceOfSfvbStepDispatchLogsResponse;
|
|
28
|
+
function SfvbStepDispatchLogsResponseFromJSON(json) {
|
|
29
|
+
return SfvbStepDispatchLogsResponseFromJSONTyped(json, false);
|
|
30
|
+
}
|
|
31
|
+
exports.SfvbStepDispatchLogsResponseFromJSON = SfvbStepDispatchLogsResponseFromJSON;
|
|
32
|
+
function SfvbStepDispatchLogsResponseFromJSONTyped(json, ignoreDiscriminator) {
|
|
33
|
+
if ((json === undefined) || (json === null)) {
|
|
34
|
+
return json;
|
|
35
|
+
}
|
|
36
|
+
return {
|
|
37
|
+
'counts': !(0, runtime_1.exists)(json, 'counts') ? undefined : (0, SfvbStepCounts_1.SfvbStepCountsFromJSON)(json['counts']),
|
|
38
|
+
'entries': !(0, runtime_1.exists)(json, 'entries') ? undefined : (json['entries'].map(SfvbStepDispatchLog_1.SfvbStepDispatchLogFromJSON)),
|
|
39
|
+
'next_offset': !(0, runtime_1.exists)(json, 'next_offset') ? undefined : json['next_offset'],
|
|
40
|
+
'notes': !(0, runtime_1.exists)(json, 'notes') ? undefined : json['notes'],
|
|
41
|
+
'sequence_uuid': !(0, runtime_1.exists)(json, 'sequence_uuid') ? undefined : json['sequence_uuid'],
|
|
42
|
+
'since': !(0, runtime_1.exists)(json, 'since') ? undefined : json['since'],
|
|
43
|
+
'step_type': !(0, runtime_1.exists)(json, 'step_type') ? undefined : json['step_type'],
|
|
44
|
+
'step_uuid': !(0, runtime_1.exists)(json, 'step_uuid') ? undefined : json['step_uuid'],
|
|
45
|
+
};
|
|
46
|
+
}
|
|
47
|
+
exports.SfvbStepDispatchLogsResponseFromJSONTyped = SfvbStepDispatchLogsResponseFromJSONTyped;
|
|
48
|
+
function SfvbStepDispatchLogsResponseToJSON(value) {
|
|
49
|
+
if (value === undefined) {
|
|
50
|
+
return undefined;
|
|
51
|
+
}
|
|
52
|
+
if (value === null) {
|
|
53
|
+
return null;
|
|
54
|
+
}
|
|
55
|
+
return {
|
|
56
|
+
'counts': (0, SfvbStepCounts_1.SfvbStepCountsToJSON)(value.counts),
|
|
57
|
+
'entries': value.entries === undefined ? undefined : (value.entries.map(SfvbStepDispatchLog_1.SfvbStepDispatchLogToJSON)),
|
|
58
|
+
'next_offset': value.next_offset,
|
|
59
|
+
'notes': value.notes,
|
|
60
|
+
'sequence_uuid': value.sequence_uuid,
|
|
61
|
+
'since': value.since,
|
|
62
|
+
'step_type': value.step_type,
|
|
63
|
+
'step_uuid': value.step_uuid,
|
|
64
|
+
};
|
|
65
|
+
}
|
|
66
|
+
exports.SfvbStepDispatchLogsResponseToJSON = SfvbStepDispatchLogsResponseToJSON;
|
package/dist/models/index.d.ts
CHANGED
|
@@ -1203,6 +1203,9 @@ export * from './SfvbSitemapsResponse';
|
|
|
1203
1203
|
export * from './SfvbSmartAttribution';
|
|
1204
1204
|
export * from './SfvbSmartAttributionPlatform';
|
|
1205
1205
|
export * from './SfvbSmartAttributionRequest';
|
|
1206
|
+
export * from './SfvbStepCounts';
|
|
1207
|
+
export * from './SfvbStepDispatchLog';
|
|
1208
|
+
export * from './SfvbStepDispatchLogsResponse';
|
|
1206
1209
|
export * from './SfvbStorefront';
|
|
1207
1210
|
export * from './SfvbStorefrontsResponse';
|
|
1208
1211
|
export * from './SfvbTemplate';
|
package/dist/models/index.js
CHANGED
|
@@ -1221,6 +1221,9 @@ __exportStar(require("./SfvbSitemapsResponse"), exports);
|
|
|
1221
1221
|
__exportStar(require("./SfvbSmartAttribution"), exports);
|
|
1222
1222
|
__exportStar(require("./SfvbSmartAttributionPlatform"), exports);
|
|
1223
1223
|
__exportStar(require("./SfvbSmartAttributionRequest"), exports);
|
|
1224
|
+
__exportStar(require("./SfvbStepCounts"), exports);
|
|
1225
|
+
__exportStar(require("./SfvbStepDispatchLog"), exports);
|
|
1226
|
+
__exportStar(require("./SfvbStepDispatchLogsResponse"), exports);
|
|
1224
1227
|
__exportStar(require("./SfvbStorefront"), exports);
|
|
1225
1228
|
__exportStar(require("./SfvbStorefrontsResponse"), exports);
|
|
1226
1229
|
__exportStar(require("./SfvbTemplate"), exports);
|
package/package.json
CHANGED
package/src/apis/SfvbApi.ts
CHANGED
|
@@ -498,6 +498,9 @@ import {
|
|
|
498
498
|
SfvbSmartAttributionRequest,
|
|
499
499
|
SfvbSmartAttributionRequestFromJSON,
|
|
500
500
|
SfvbSmartAttributionRequestToJSON,
|
|
501
|
+
SfvbStepDispatchLogsResponse,
|
|
502
|
+
SfvbStepDispatchLogsResponseFromJSON,
|
|
503
|
+
SfvbStepDispatchLogsResponseToJSON,
|
|
501
504
|
SfvbStorefrontsResponse,
|
|
502
505
|
SfvbStorefrontsResponseFromJSON,
|
|
503
506
|
SfvbStorefrontsResponseToJSON,
|
|
@@ -1157,6 +1160,15 @@ export interface GetSfvbSequenceRequest {
|
|
|
1157
1160
|
waiting?: boolean;
|
|
1158
1161
|
}
|
|
1159
1162
|
|
|
1163
|
+
export interface GetSfvbSequenceStepDispatchLogsRequest {
|
|
1164
|
+
storefrontOid: number;
|
|
1165
|
+
sequenceUuid: string;
|
|
1166
|
+
stepUuid: string;
|
|
1167
|
+
since?: string;
|
|
1168
|
+
limit?: number;
|
|
1169
|
+
offset?: number;
|
|
1170
|
+
}
|
|
1171
|
+
|
|
1160
1172
|
export interface GetSfvbServerLogRequest {
|
|
1161
1173
|
storefrontOid: number;
|
|
1162
1174
|
logId: string;
|
|
@@ -3787,6 +3799,27 @@ export interface SfvbApiInterface {
|
|
|
3787
3799
|
*/
|
|
3788
3800
|
getSfvbSequence(requestParameters: GetSfvbSequenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequence>;
|
|
3789
3801
|
|
|
3802
|
+
/**
|
|
3803
|
+
* Why customers were sent, skipped or ended at this step, newest first, as the admin\'s Dispatch Logs screen shows it, with the step\'s counts. An email step\'s counts are its email\'s; any other step\'s are its own over 90 days. Email addresses and phone numbers in the text are masked. since is 15m, 2h or 7d, or an ISO-8601 time, default 7d; entries are kept 90 days. limit is 1 to 200, default 50; send next_offset as offset for the next page. Read only.
|
|
3804
|
+
* @summary Read a flow or campaign step\'s dispatch log and counts
|
|
3805
|
+
* @param {number} storefrontOid
|
|
3806
|
+
* @param {string} sequenceUuid
|
|
3807
|
+
* @param {string} stepUuid
|
|
3808
|
+
* @param {string} [since]
|
|
3809
|
+
* @param {number} [limit]
|
|
3810
|
+
* @param {number} [offset]
|
|
3811
|
+
* @param {*} [options] Override http request option.
|
|
3812
|
+
* @throws {RequiredError}
|
|
3813
|
+
* @memberof SfvbApiInterface
|
|
3814
|
+
*/
|
|
3815
|
+
getSfvbSequenceStepDispatchLogsRaw(requestParameters: GetSfvbSequenceStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbStepDispatchLogsResponse>>;
|
|
3816
|
+
|
|
3817
|
+
/**
|
|
3818
|
+
* Why customers were sent, skipped or ended at this step, newest first, as the admin\'s Dispatch Logs screen shows it, with the step\'s counts. An email step\'s counts are its email\'s; any other step\'s are its own over 90 days. Email addresses and phone numbers in the text are masked. since is 15m, 2h or 7d, or an ISO-8601 time, default 7d; entries are kept 90 days. limit is 1 to 200, default 50; send next_offset as offset for the next page. Read only.
|
|
3819
|
+
* Read a flow or campaign step\'s dispatch log and counts
|
|
3820
|
+
*/
|
|
3821
|
+
getSfvbSequenceStepDispatchLogs(requestParameters: GetSfvbSequenceStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbStepDispatchLogsResponse>;
|
|
3822
|
+
|
|
3790
3823
|
/**
|
|
3791
3824
|
* One render\'s server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message. log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session. min_level is debug, info, warn or error, default debug.
|
|
3792
3825
|
* @summary Get one storefront render log
|
|
@@ -11206,6 +11239,67 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
|
|
|
11206
11239
|
return await response.value();
|
|
11207
11240
|
}
|
|
11208
11241
|
|
|
11242
|
+
/**
|
|
11243
|
+
* Why customers were sent, skipped or ended at this step, newest first, as the admin\'s Dispatch Logs screen shows it, with the step\'s counts. An email step\'s counts are its email\'s; any other step\'s are its own over 90 days. Email addresses and phone numbers in the text are masked. since is 15m, 2h or 7d, or an ISO-8601 time, default 7d; entries are kept 90 days. limit is 1 to 200, default 50; send next_offset as offset for the next page. Read only.
|
|
11244
|
+
* Read a flow or campaign step\'s dispatch log and counts
|
|
11245
|
+
*/
|
|
11246
|
+
async getSfvbSequenceStepDispatchLogsRaw(requestParameters: GetSfvbSequenceStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbStepDispatchLogsResponse>> {
|
|
11247
|
+
if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
|
|
11248
|
+
throw new runtime.RequiredError('storefrontOid','Required parameter requestParameters.storefrontOid was null or undefined when calling getSfvbSequenceStepDispatchLogs.');
|
|
11249
|
+
}
|
|
11250
|
+
|
|
11251
|
+
if (requestParameters.sequenceUuid === null || requestParameters.sequenceUuid === undefined) {
|
|
11252
|
+
throw new runtime.RequiredError('sequenceUuid','Required parameter requestParameters.sequenceUuid was null or undefined when calling getSfvbSequenceStepDispatchLogs.');
|
|
11253
|
+
}
|
|
11254
|
+
|
|
11255
|
+
if (requestParameters.stepUuid === null || requestParameters.stepUuid === undefined) {
|
|
11256
|
+
throw new runtime.RequiredError('stepUuid','Required parameter requestParameters.stepUuid was null or undefined when calling getSfvbSequenceStepDispatchLogs.');
|
|
11257
|
+
}
|
|
11258
|
+
|
|
11259
|
+
const queryParameters: any = {};
|
|
11260
|
+
|
|
11261
|
+
if (requestParameters.since !== undefined) {
|
|
11262
|
+
queryParameters['since'] = requestParameters.since;
|
|
11263
|
+
}
|
|
11264
|
+
|
|
11265
|
+
if (requestParameters.limit !== undefined) {
|
|
11266
|
+
queryParameters['limit'] = requestParameters.limit;
|
|
11267
|
+
}
|
|
11268
|
+
|
|
11269
|
+
if (requestParameters.offset !== undefined) {
|
|
11270
|
+
queryParameters['offset'] = requestParameters.offset;
|
|
11271
|
+
}
|
|
11272
|
+
|
|
11273
|
+
const headerParameters: runtime.HTTPHeaders = {};
|
|
11274
|
+
|
|
11275
|
+
if (this.configuration && this.configuration.accessToken) {
|
|
11276
|
+
// oauth required
|
|
11277
|
+
headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", []);
|
|
11278
|
+
}
|
|
11279
|
+
|
|
11280
|
+
if (this.configuration && this.configuration.apiKey) {
|
|
11281
|
+
headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
|
|
11282
|
+
}
|
|
11283
|
+
|
|
11284
|
+
const response = await this.request({
|
|
11285
|
+
path: `/sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/dispatch_logs`.replace(`{${"storefront_oid"}}`, encodeURIComponent(String(requestParameters.storefrontOid))).replace(`{${"sequence_uuid"}}`, encodeURIComponent(String(requestParameters.sequenceUuid))).replace(`{${"step_uuid"}}`, encodeURIComponent(String(requestParameters.stepUuid))),
|
|
11286
|
+
method: 'GET',
|
|
11287
|
+
headers: headerParameters,
|
|
11288
|
+
query: queryParameters,
|
|
11289
|
+
}, initOverrides);
|
|
11290
|
+
|
|
11291
|
+
return new runtime.JSONApiResponse(response, (jsonValue) => SfvbStepDispatchLogsResponseFromJSON(jsonValue));
|
|
11292
|
+
}
|
|
11293
|
+
|
|
11294
|
+
/**
|
|
11295
|
+
* Why customers were sent, skipped or ended at this step, newest first, as the admin\'s Dispatch Logs screen shows it, with the step\'s counts. An email step\'s counts are its email\'s; any other step\'s are its own over 90 days. Email addresses and phone numbers in the text are masked. since is 15m, 2h or 7d, or an ISO-8601 time, default 7d; entries are kept 90 days. limit is 1 to 200, default 50; send next_offset as offset for the next page. Read only.
|
|
11296
|
+
* Read a flow or campaign step\'s dispatch log and counts
|
|
11297
|
+
*/
|
|
11298
|
+
async getSfvbSequenceStepDispatchLogs(requestParameters: GetSfvbSequenceStepDispatchLogsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbStepDispatchLogsResponse> {
|
|
11299
|
+
const response = await this.getSfvbSequenceStepDispatchLogsRaw(requestParameters, initOverrides);
|
|
11300
|
+
return await response.value();
|
|
11301
|
+
}
|
|
11302
|
+
|
|
11209
11303
|
/**
|
|
11210
11304
|
* One render\'s server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message. log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session. min_level is debug, info, warn or error, default debug.
|
|
11211
11305
|
* Get one storefront render log
|
|
@@ -56,6 +56,12 @@ export interface SfvbBlogPostDetail {
|
|
|
56
56
|
* @memberof SfvbBlogPostDetail
|
|
57
57
|
*/
|
|
58
58
|
created_dts?: string;
|
|
59
|
+
/**
|
|
60
|
+
* True when this is the result of a dry run and nothing was saved. The post is shown as it is stored.
|
|
61
|
+
* @type {boolean}
|
|
62
|
+
* @memberof SfvbBlogPostDetail
|
|
63
|
+
*/
|
|
64
|
+
dry_run?: boolean;
|
|
59
65
|
/**
|
|
60
66
|
* The post excerpt as HTML, exactly as stored.
|
|
61
67
|
* @type {string}
|
|
@@ -162,6 +168,7 @@ export function SfvbBlogPostDetailFromJSONTyped(json: any, ignoreDiscriminator:
|
|
|
162
168
|
'blog_post_oid': !exists(json, 'blog_post_oid') ? undefined : json['blog_post_oid'],
|
|
163
169
|
'body': !exists(json, 'body') ? undefined : json['body'],
|
|
164
170
|
'created_dts': !exists(json, 'created_dts') ? undefined : json['created_dts'],
|
|
171
|
+
'dry_run': !exists(json, 'dry_run') ? undefined : json['dry_run'],
|
|
165
172
|
'excerpt': !exists(json, 'excerpt') ? undefined : json['excerpt'],
|
|
166
173
|
'images': !exists(json, 'images') ? undefined : ((json['images'] as Array<any>).map(SfvbBlogPostImageFromJSON)),
|
|
167
174
|
'last_modified_dts': !exists(json, 'last_modified_dts') ? undefined : json['last_modified_dts'],
|
|
@@ -192,6 +199,7 @@ export function SfvbBlogPostDetailToJSON(value?: SfvbBlogPostDetail | null): any
|
|
|
192
199
|
'blog_post_oid': value.blog_post_oid,
|
|
193
200
|
'body': value.body,
|
|
194
201
|
'created_dts': value.created_dts,
|
|
202
|
+
'dry_run': value.dry_run,
|
|
195
203
|
'excerpt': value.excerpt,
|
|
196
204
|
'images': value.images === undefined ? undefined : ((value.images as Array<any>).map(SfvbBlogPostImageToJSON)),
|
|
197
205
|
'last_modified_dts': value.last_modified_dts,
|
|
@@ -37,6 +37,12 @@ export interface SfvbBlogPostRequest {
|
|
|
37
37
|
* @memberof SfvbBlogPostRequest
|
|
38
38
|
*/
|
|
39
39
|
body?: string;
|
|
40
|
+
/**
|
|
41
|
+
* On an update, true to run every check the write would run and save nothing. A refusal comes back exactly as it would on the real write.
|
|
42
|
+
* @type {boolean}
|
|
43
|
+
* @memberof SfvbBlogPostRequest
|
|
44
|
+
*/
|
|
45
|
+
dry_run?: boolean;
|
|
40
46
|
/**
|
|
41
47
|
* The post excerpt as HTML, up to 256 KB. Held to the same rule as body.
|
|
42
48
|
* @type {string}
|
|
@@ -128,6 +134,7 @@ export function SfvbBlogPostRequestFromJSONTyped(json: any, ignoreDiscriminator:
|
|
|
128
134
|
'allow_comments': !exists(json, 'allow_comments') ? undefined : json['allow_comments'],
|
|
129
135
|
'author': !exists(json, 'author') ? undefined : json['author'],
|
|
130
136
|
'body': !exists(json, 'body') ? undefined : json['body'],
|
|
137
|
+
'dry_run': !exists(json, 'dry_run') ? undefined : json['dry_run'],
|
|
131
138
|
'excerpt': !exists(json, 'excerpt') ? undefined : json['excerpt'],
|
|
132
139
|
'publication_dts': !exists(json, 'publication_dts') ? undefined : json['publication_dts'],
|
|
133
140
|
'seo_description': !exists(json, 'seo_description') ? undefined : json['seo_description'],
|
|
@@ -152,6 +159,7 @@ export function SfvbBlogPostRequestToJSON(value?: SfvbBlogPostRequest | null): a
|
|
|
152
159
|
'allow_comments': value.allow_comments,
|
|
153
160
|
'author': value.author,
|
|
154
161
|
'body': value.body,
|
|
162
|
+
'dry_run': value.dry_run,
|
|
155
163
|
'excerpt': value.excerpt,
|
|
156
164
|
'publication_dts': value.publication_dts,
|
|
157
165
|
'seo_description': value.seo_description,
|
|
@@ -0,0 +1,131 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* UltraCart Rest API V2
|
|
5
|
+
* UltraCart REST API Version 2
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.0.0
|
|
8
|
+
* Contact: support@ultracart.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { exists, mapValues } from '../runtime';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface SfvbStepCounts
|
|
20
|
+
*/
|
|
21
|
+
export interface SfvbStepCounts {
|
|
22
|
+
/**
|
|
23
|
+
* Messages with a click.
|
|
24
|
+
* @type {number}
|
|
25
|
+
* @memberof SfvbStepCounts
|
|
26
|
+
*/
|
|
27
|
+
clicked?: number;
|
|
28
|
+
/**
|
|
29
|
+
* For a step that isn't an email, the customers that passed through it.
|
|
30
|
+
* @type {number}
|
|
31
|
+
* @memberof SfvbStepCounts
|
|
32
|
+
*/
|
|
33
|
+
customers?: number;
|
|
34
|
+
/**
|
|
35
|
+
* Messages delivered.
|
|
36
|
+
* @type {number}
|
|
37
|
+
* @memberof SfvbStepCounts
|
|
38
|
+
*/
|
|
39
|
+
delivered?: number;
|
|
40
|
+
/**
|
|
41
|
+
* Emails opened.
|
|
42
|
+
* @type {number}
|
|
43
|
+
* @memberof SfvbStepCounts
|
|
44
|
+
*/
|
|
45
|
+
opened?: number;
|
|
46
|
+
/**
|
|
47
|
+
* Messages sent.
|
|
48
|
+
* @type {number}
|
|
49
|
+
* @memberof SfvbStepCounts
|
|
50
|
+
*/
|
|
51
|
+
sent?: number;
|
|
52
|
+
/**
|
|
53
|
+
* Customers who reached the step and were not sent anything. The dispatch log says why.
|
|
54
|
+
* @type {number}
|
|
55
|
+
* @memberof SfvbStepCounts
|
|
56
|
+
*/
|
|
57
|
+
skipped?: number;
|
|
58
|
+
/**
|
|
59
|
+
* email (the step's email, all time) or step (this step, the last 90 days).
|
|
60
|
+
* @type {string}
|
|
61
|
+
* @memberof SfvbStepCounts
|
|
62
|
+
*/
|
|
63
|
+
source?: string;
|
|
64
|
+
/**
|
|
65
|
+
* Spam complaints.
|
|
66
|
+
* @type {number}
|
|
67
|
+
* @memberof SfvbStepCounts
|
|
68
|
+
*/
|
|
69
|
+
spam?: number;
|
|
70
|
+
/**
|
|
71
|
+
* Unsubscribes from these messages.
|
|
72
|
+
* @type {number}
|
|
73
|
+
* @memberof SfvbStepCounts
|
|
74
|
+
*/
|
|
75
|
+
unsubscribed?: number;
|
|
76
|
+
}
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
|
|
80
|
+
/**
|
|
81
|
+
* Check if a given object implements the SfvbStepCounts interface.
|
|
82
|
+
*/
|
|
83
|
+
export function instanceOfSfvbStepCounts(value: object): boolean {
|
|
84
|
+
let isInstance = true;
|
|
85
|
+
|
|
86
|
+
return isInstance;
|
|
87
|
+
}
|
|
88
|
+
|
|
89
|
+
export function SfvbStepCountsFromJSON(json: any): SfvbStepCounts {
|
|
90
|
+
return SfvbStepCountsFromJSONTyped(json, false);
|
|
91
|
+
}
|
|
92
|
+
|
|
93
|
+
export function SfvbStepCountsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbStepCounts {
|
|
94
|
+
if ((json === undefined) || (json === null)) {
|
|
95
|
+
return json;
|
|
96
|
+
}
|
|
97
|
+
return {
|
|
98
|
+
|
|
99
|
+
'clicked': !exists(json, 'clicked') ? undefined : json['clicked'],
|
|
100
|
+
'customers': !exists(json, 'customers') ? undefined : json['customers'],
|
|
101
|
+
'delivered': !exists(json, 'delivered') ? undefined : json['delivered'],
|
|
102
|
+
'opened': !exists(json, 'opened') ? undefined : json['opened'],
|
|
103
|
+
'sent': !exists(json, 'sent') ? undefined : json['sent'],
|
|
104
|
+
'skipped': !exists(json, 'skipped') ? undefined : json['skipped'],
|
|
105
|
+
'source': !exists(json, 'source') ? undefined : json['source'],
|
|
106
|
+
'spam': !exists(json, 'spam') ? undefined : json['spam'],
|
|
107
|
+
'unsubscribed': !exists(json, 'unsubscribed') ? undefined : json['unsubscribed'],
|
|
108
|
+
};
|
|
109
|
+
}
|
|
110
|
+
|
|
111
|
+
export function SfvbStepCountsToJSON(value?: SfvbStepCounts | null): any {
|
|
112
|
+
if (value === undefined) {
|
|
113
|
+
return undefined;
|
|
114
|
+
}
|
|
115
|
+
if (value === null) {
|
|
116
|
+
return null;
|
|
117
|
+
}
|
|
118
|
+
return {
|
|
119
|
+
|
|
120
|
+
'clicked': value.clicked,
|
|
121
|
+
'customers': value.customers,
|
|
122
|
+
'delivered': value.delivered,
|
|
123
|
+
'opened': value.opened,
|
|
124
|
+
'sent': value.sent,
|
|
125
|
+
'skipped': value.skipped,
|
|
126
|
+
'source': value.source,
|
|
127
|
+
'spam': value.spam,
|
|
128
|
+
'unsubscribed': value.unsubscribed,
|
|
129
|
+
};
|
|
130
|
+
}
|
|
131
|
+
|
|
@@ -0,0 +1,83 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* UltraCart Rest API V2
|
|
5
|
+
* UltraCart REST API Version 2
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.0.0
|
|
8
|
+
* Contact: support@ultracart.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { exists, mapValues } from '../runtime';
|
|
16
|
+
/**
|
|
17
|
+
*
|
|
18
|
+
* @export
|
|
19
|
+
* @interface SfvbStepDispatchLog
|
|
20
|
+
*/
|
|
21
|
+
export interface SfvbStepDispatchLog {
|
|
22
|
+
/**
|
|
23
|
+
* The customer the entry is about.
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof SfvbStepDispatchLog
|
|
26
|
+
*/
|
|
27
|
+
customer_uuid?: string;
|
|
28
|
+
/**
|
|
29
|
+
* What happened, as the admin's Dispatch Logs screen shows it, with email addresses and phone numbers masked.
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof SfvbStepDispatchLog
|
|
32
|
+
*/
|
|
33
|
+
detail?: string;
|
|
34
|
+
/**
|
|
35
|
+
* When the entry was written, as ISO 8601 with the server's offset.
|
|
36
|
+
* @type {string}
|
|
37
|
+
* @memberof SfvbStepDispatchLog
|
|
38
|
+
*/
|
|
39
|
+
logged_at?: string;
|
|
40
|
+
}
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
/**
|
|
45
|
+
* Check if a given object implements the SfvbStepDispatchLog interface.
|
|
46
|
+
*/
|
|
47
|
+
export function instanceOfSfvbStepDispatchLog(value: object): boolean {
|
|
48
|
+
let isInstance = true;
|
|
49
|
+
|
|
50
|
+
return isInstance;
|
|
51
|
+
}
|
|
52
|
+
|
|
53
|
+
export function SfvbStepDispatchLogFromJSON(json: any): SfvbStepDispatchLog {
|
|
54
|
+
return SfvbStepDispatchLogFromJSONTyped(json, false);
|
|
55
|
+
}
|
|
56
|
+
|
|
57
|
+
export function SfvbStepDispatchLogFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbStepDispatchLog {
|
|
58
|
+
if ((json === undefined) || (json === null)) {
|
|
59
|
+
return json;
|
|
60
|
+
}
|
|
61
|
+
return {
|
|
62
|
+
|
|
63
|
+
'customer_uuid': !exists(json, 'customer_uuid') ? undefined : json['customer_uuid'],
|
|
64
|
+
'detail': !exists(json, 'detail') ? undefined : json['detail'],
|
|
65
|
+
'logged_at': !exists(json, 'logged_at') ? undefined : json['logged_at'],
|
|
66
|
+
};
|
|
67
|
+
}
|
|
68
|
+
|
|
69
|
+
export function SfvbStepDispatchLogToJSON(value?: SfvbStepDispatchLog | null): any {
|
|
70
|
+
if (value === undefined) {
|
|
71
|
+
return undefined;
|
|
72
|
+
}
|
|
73
|
+
if (value === null) {
|
|
74
|
+
return null;
|
|
75
|
+
}
|
|
76
|
+
return {
|
|
77
|
+
|
|
78
|
+
'customer_uuid': value.customer_uuid,
|
|
79
|
+
'detail': value.detail,
|
|
80
|
+
'logged_at': value.logged_at,
|
|
81
|
+
};
|
|
82
|
+
}
|
|
83
|
+
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
/* tslint:disable */
|
|
2
|
+
/* eslint-disable */
|
|
3
|
+
/**
|
|
4
|
+
* UltraCart Rest API V2
|
|
5
|
+
* UltraCart REST API Version 2
|
|
6
|
+
*
|
|
7
|
+
* The version of the OpenAPI document: 2.0.0
|
|
8
|
+
* Contact: support@ultracart.com
|
|
9
|
+
*
|
|
10
|
+
* NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
|
|
11
|
+
* https://openapi-generator.tech
|
|
12
|
+
* Do not edit the class manually.
|
|
13
|
+
*/
|
|
14
|
+
|
|
15
|
+
import { exists, mapValues } from '../runtime';
|
|
16
|
+
import {
|
|
17
|
+
SfvbStepCounts,
|
|
18
|
+
SfvbStepCountsFromJSON,
|
|
19
|
+
SfvbStepCountsFromJSONTyped,
|
|
20
|
+
SfvbStepCountsToJSON,
|
|
21
|
+
} from './SfvbStepCounts';
|
|
22
|
+
import {
|
|
23
|
+
SfvbStepDispatchLog,
|
|
24
|
+
SfvbStepDispatchLogFromJSON,
|
|
25
|
+
SfvbStepDispatchLogFromJSONTyped,
|
|
26
|
+
SfvbStepDispatchLogToJSON,
|
|
27
|
+
} from './SfvbStepDispatchLog';
|
|
28
|
+
|
|
29
|
+
/**
|
|
30
|
+
*
|
|
31
|
+
* @export
|
|
32
|
+
* @interface SfvbStepDispatchLogsResponse
|
|
33
|
+
*/
|
|
34
|
+
export interface SfvbStepDispatchLogsResponse {
|
|
35
|
+
/**
|
|
36
|
+
*
|
|
37
|
+
* @type {SfvbStepCounts}
|
|
38
|
+
* @memberof SfvbStepDispatchLogsResponse
|
|
39
|
+
*/
|
|
40
|
+
counts?: SfvbStepCounts;
|
|
41
|
+
/**
|
|
42
|
+
* The entries in the window, newest first.
|
|
43
|
+
* @type {Array<SfvbStepDispatchLog>}
|
|
44
|
+
* @memberof SfvbStepDispatchLogsResponse
|
|
45
|
+
*/
|
|
46
|
+
entries?: Array<SfvbStepDispatchLog>;
|
|
47
|
+
/**
|
|
48
|
+
* Send this as offset for the next page. Absent on the last page.
|
|
49
|
+
* @type {number}
|
|
50
|
+
* @memberof SfvbStepDispatchLogsResponse
|
|
51
|
+
*/
|
|
52
|
+
next_offset?: number;
|
|
53
|
+
/**
|
|
54
|
+
* What a person should know about reading these entries.
|
|
55
|
+
* @type {Array<string>}
|
|
56
|
+
* @memberof SfvbStepDispatchLogsResponse
|
|
57
|
+
*/
|
|
58
|
+
notes?: Array<string>;
|
|
59
|
+
/**
|
|
60
|
+
* The communication sequence the step is in.
|
|
61
|
+
* @type {string}
|
|
62
|
+
* @memberof SfvbStepDispatchLogsResponse
|
|
63
|
+
*/
|
|
64
|
+
sequence_uuid?: string;
|
|
65
|
+
/**
|
|
66
|
+
* The start of the window read, as ISO 8601.
|
|
67
|
+
* @type {string}
|
|
68
|
+
* @memberof SfvbStepDispatchLogsResponse
|
|
69
|
+
*/
|
|
70
|
+
since?: string;
|
|
71
|
+
/**
|
|
72
|
+
* The step's type, such as email, sms or wait.
|
|
73
|
+
* @type {string}
|
|
74
|
+
* @memberof SfvbStepDispatchLogsResponse
|
|
75
|
+
*/
|
|
76
|
+
step_type?: string;
|
|
77
|
+
/**
|
|
78
|
+
* The step.
|
|
79
|
+
* @type {string}
|
|
80
|
+
* @memberof SfvbStepDispatchLogsResponse
|
|
81
|
+
*/
|
|
82
|
+
step_uuid?: string;
|
|
83
|
+
}
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
/**
|
|
88
|
+
* Check if a given object implements the SfvbStepDispatchLogsResponse interface.
|
|
89
|
+
*/
|
|
90
|
+
export function instanceOfSfvbStepDispatchLogsResponse(value: object): boolean {
|
|
91
|
+
let isInstance = true;
|
|
92
|
+
|
|
93
|
+
return isInstance;
|
|
94
|
+
}
|
|
95
|
+
|
|
96
|
+
export function SfvbStepDispatchLogsResponseFromJSON(json: any): SfvbStepDispatchLogsResponse {
|
|
97
|
+
return SfvbStepDispatchLogsResponseFromJSONTyped(json, false);
|
|
98
|
+
}
|
|
99
|
+
|
|
100
|
+
export function SfvbStepDispatchLogsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbStepDispatchLogsResponse {
|
|
101
|
+
if ((json === undefined) || (json === null)) {
|
|
102
|
+
return json;
|
|
103
|
+
}
|
|
104
|
+
return {
|
|
105
|
+
|
|
106
|
+
'counts': !exists(json, 'counts') ? undefined : SfvbStepCountsFromJSON(json['counts']),
|
|
107
|
+
'entries': !exists(json, 'entries') ? undefined : ((json['entries'] as Array<any>).map(SfvbStepDispatchLogFromJSON)),
|
|
108
|
+
'next_offset': !exists(json, 'next_offset') ? undefined : json['next_offset'],
|
|
109
|
+
'notes': !exists(json, 'notes') ? undefined : json['notes'],
|
|
110
|
+
'sequence_uuid': !exists(json, 'sequence_uuid') ? undefined : json['sequence_uuid'],
|
|
111
|
+
'since': !exists(json, 'since') ? undefined : json['since'],
|
|
112
|
+
'step_type': !exists(json, 'step_type') ? undefined : json['step_type'],
|
|
113
|
+
'step_uuid': !exists(json, 'step_uuid') ? undefined : json['step_uuid'],
|
|
114
|
+
};
|
|
115
|
+
}
|
|
116
|
+
|
|
117
|
+
export function SfvbStepDispatchLogsResponseToJSON(value?: SfvbStepDispatchLogsResponse | null): any {
|
|
118
|
+
if (value === undefined) {
|
|
119
|
+
return undefined;
|
|
120
|
+
}
|
|
121
|
+
if (value === null) {
|
|
122
|
+
return null;
|
|
123
|
+
}
|
|
124
|
+
return {
|
|
125
|
+
|
|
126
|
+
'counts': SfvbStepCountsToJSON(value.counts),
|
|
127
|
+
'entries': value.entries === undefined ? undefined : ((value.entries as Array<any>).map(SfvbStepDispatchLogToJSON)),
|
|
128
|
+
'next_offset': value.next_offset,
|
|
129
|
+
'notes': value.notes,
|
|
130
|
+
'sequence_uuid': value.sequence_uuid,
|
|
131
|
+
'since': value.since,
|
|
132
|
+
'step_type': value.step_type,
|
|
133
|
+
'step_uuid': value.step_uuid,
|
|
134
|
+
};
|
|
135
|
+
}
|
|
136
|
+
|
package/src/models/index.ts
CHANGED
|
@@ -1205,6 +1205,9 @@ export * from './SfvbSitemapsResponse';
|
|
|
1205
1205
|
export * from './SfvbSmartAttribution';
|
|
1206
1206
|
export * from './SfvbSmartAttributionPlatform';
|
|
1207
1207
|
export * from './SfvbSmartAttributionRequest';
|
|
1208
|
+
export * from './SfvbStepCounts';
|
|
1209
|
+
export * from './SfvbStepDispatchLog';
|
|
1210
|
+
export * from './SfvbStepDispatchLogsResponse';
|
|
1208
1211
|
export * from './SfvbStorefront';
|
|
1209
1212
|
export * from './SfvbStorefrontsResponse';
|
|
1210
1213
|
export * from './SfvbTemplate';
|