ultracart_rest_api_v2_typescript 4.1.219 → 4.1.221
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 +6 -0
- package/README.md +4 -2
- package/dist/apis/SfvbApi.d.ts +115 -14
- package/dist/apis/SfvbApi.js +220 -6
- package/dist/apis/StorefrontApi.d.ts +4 -1
- package/dist/apis/StorefrontApi.js +2 -0
- package/dist/models/SfvbApprovalParams.d.ts +20 -2
- package/dist/models/SfvbApprovalParams.js +6 -0
- package/dist/models/SfvbCodeLibraryEmail.d.ts +61 -0
- package/dist/models/SfvbCodeLibraryEmail.js +60 -0
- package/dist/models/SfvbCodeLibraryEmailsResponse.d.ts +38 -0
- package/dist/models/SfvbCodeLibraryEmailsResponse.js +53 -0
- package/dist/models/SfvbPostcardProofRequest.d.ts +79 -0
- package/dist/models/SfvbPostcardProofRequest.js +66 -0
- package/dist/models/SfvbPostcardProofResponse.d.ts +101 -0
- package/dist/models/SfvbPostcardProofResponse.js +79 -0
- package/dist/models/SfvbSequenceStepCreateRequest.d.ts +27 -3
- package/dist/models/SfvbSequenceStepCreateRequest.js +8 -0
- package/dist/models/SfvbSequenceStepCreateResponse.d.ts +42 -0
- package/dist/models/SfvbSequenceStepCreateResponse.js +14 -0
- package/dist/models/SfvbSequenceStepMoveRequest.d.ts +49 -0
- package/dist/models/SfvbSequenceStepMoveRequest.js +56 -0
- package/dist/models/SfvbSequenceStepMoveResponse.d.ts +38 -0
- package/dist/models/SfvbSequenceStepMoveResponse.js +53 -0
- package/dist/models/index.d.ts +6 -0
- package/dist/models/index.js +6 -0
- package/package.json +1 -1
- package/src/apis/SfvbApi.ts +281 -13
- package/src/apis/StorefrontApi.ts +4 -1
- package/src/models/SfvbApprovalParams.ts +26 -2
- package/src/models/SfvbCodeLibraryEmail.ts +107 -0
- package/src/models/SfvbCodeLibraryEmailsResponse.ts +82 -0
- package/src/models/SfvbPostcardProofRequest.ts +131 -0
- package/src/models/SfvbPostcardProofResponse.ts +165 -0
- package/src/models/SfvbSequenceStepCreateRequest.ts +35 -3
- package/src/models/SfvbSequenceStepCreateResponse.ts +56 -0
- package/src/models/SfvbSequenceStepMoveRequest.ts +91 -0
- package/src/models/SfvbSequenceStepMoveResponse.ts +82 -0
- package/src/models/index.ts +6 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -1012,6 +1012,8 @@ src/models/SfvbCampaign.ts
|
|
|
1012
1012
|
src/models/SfvbCampaignMembership.ts
|
|
1013
1013
|
src/models/SfvbCampaignWriteRequest.ts
|
|
1014
1014
|
src/models/SfvbCampaignsResponse.ts
|
|
1015
|
+
src/models/SfvbCodeLibraryEmail.ts
|
|
1016
|
+
src/models/SfvbCodeLibraryEmailsResponse.ts
|
|
1015
1017
|
src/models/SfvbCommsDnsRecord.ts
|
|
1016
1018
|
src/models/SfvbCommsEmail.ts
|
|
1017
1019
|
src/models/SfvbCommsList.ts
|
|
@@ -1163,6 +1165,8 @@ src/models/SfvbPageResponse.ts
|
|
|
1163
1165
|
src/models/SfvbPageSelectors.ts
|
|
1164
1166
|
src/models/SfvbPageSettingsRequest.ts
|
|
1165
1167
|
src/models/SfvbPageSummary.ts
|
|
1168
|
+
src/models/SfvbPostcardProofRequest.ts
|
|
1169
|
+
src/models/SfvbPostcardProofResponse.ts
|
|
1166
1170
|
src/models/SfvbPreviewAccessRequest.ts
|
|
1167
1171
|
src/models/SfvbPreviewAccessResponse.ts
|
|
1168
1172
|
src/models/SfvbPreviewSessionRequest.ts
|
|
@@ -1207,6 +1211,8 @@ src/models/SfvbSequenceStep.ts
|
|
|
1207
1211
|
src/models/SfvbSequenceStepCreateRequest.ts
|
|
1208
1212
|
src/models/SfvbSequenceStepCreateResponse.ts
|
|
1209
1213
|
src/models/SfvbSequenceStepDeleteResponse.ts
|
|
1214
|
+
src/models/SfvbSequenceStepMoveRequest.ts
|
|
1215
|
+
src/models/SfvbSequenceStepMoveResponse.ts
|
|
1210
1216
|
src/models/SfvbSequenceStepUpdateRequest.ts
|
|
1211
1217
|
src/models/SfvbSequenceStepUpdateResponse.ts
|
|
1212
1218
|
src/models/SfvbServerLog.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.221
|
|
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.221 --save
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
@@ -84,6 +84,8 @@ Not every change is committed to every SDK.
|
|
|
84
84
|
|
|
85
85
|
| Version | Date | Comments |
|
|
86
86
|
| --: | :-: | --- |
|
|
87
|
+
| 4.1.221 | 11/02/2026 | sfvb internal testing |
|
|
88
|
+
| 4.1.220 | 11/02/2026 | sfvb internal testing |
|
|
87
89
|
| 4.1.219 | 10/30/2026 | item - field for hsa/fsa eligibility |
|
|
88
90
|
| 4.1.218 | 10/30/2026 | svfb internal testing |
|
|
89
91
|
| 4.1.217 | 10/29/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 { SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbArchiveRequest, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCampaign, SfvbCampaignWriteRequest, SfvbCampaignsResponse, 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, 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, SfvbSequenceStepUpdateRequest, SfvbSequenceStepUpdateResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
|
|
13
|
+
import { 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, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
|
|
14
14
|
export interface AddSfvbPageBlogPostsRequest {
|
|
15
15
|
storefrontOid: number;
|
|
16
16
|
path: string;
|
|
@@ -545,6 +545,10 @@ export interface ListSfvbCampaignsRequest {
|
|
|
545
545
|
pageSize?: number;
|
|
546
546
|
includeDeleted?: boolean;
|
|
547
547
|
}
|
|
548
|
+
export interface ListSfvbCodeLibraryEmailsRequest {
|
|
549
|
+
storefrontOid: number;
|
|
550
|
+
search?: string;
|
|
551
|
+
}
|
|
548
552
|
export interface ListSfvbCommsListsRequest {
|
|
549
553
|
storefrontOid: number;
|
|
550
554
|
}
|
|
@@ -638,11 +642,25 @@ export interface ListSfvbUpsellPathsRequest {
|
|
|
638
642
|
maxResults?: number;
|
|
639
643
|
offset?: number;
|
|
640
644
|
}
|
|
645
|
+
export interface MoveSfvbSequenceStepRequest {
|
|
646
|
+
storefrontOid: number;
|
|
647
|
+
sequenceUuid: string;
|
|
648
|
+
stepUuid: string;
|
|
649
|
+
ifMatch: string;
|
|
650
|
+
sequenceStepMoveRequest: SfvbSequenceStepMoveRequest;
|
|
651
|
+
approvalId?: string;
|
|
652
|
+
}
|
|
641
653
|
export interface MoveSfvbUpsellPathRequest {
|
|
642
654
|
storefrontOid: number;
|
|
643
655
|
upsellPathOid: number;
|
|
644
656
|
moveRequest: SfvbUpsellPathMoveRequest;
|
|
645
657
|
}
|
|
658
|
+
export interface ProofSfvbSequencePostcardRequest {
|
|
659
|
+
storefrontOid: number;
|
|
660
|
+
sequenceUuid: string;
|
|
661
|
+
stepUuid: string;
|
|
662
|
+
postcardProofRequest: SfvbPostcardProofRequest;
|
|
663
|
+
}
|
|
646
664
|
export interface PublishSfvbLibraryEntryRequest {
|
|
647
665
|
storefrontOid: number;
|
|
648
666
|
libraryOid: number;
|
|
@@ -960,6 +978,7 @@ export interface UpdateSfvbSequenceStepRequest {
|
|
|
960
978
|
stepUuid: string;
|
|
961
979
|
ifMatch: string;
|
|
962
980
|
sequenceStepUpdateRequest: SfvbSequenceStepUpdateRequest;
|
|
981
|
+
approvalId?: string;
|
|
963
982
|
}
|
|
964
983
|
export interface UpdateSfvbUpsellOfferRequest {
|
|
965
984
|
storefrontOid: number;
|
|
@@ -2828,20 +2847,20 @@ export interface SfvbApiInterface {
|
|
|
2828
2847
|
*/
|
|
2829
2848
|
insertSfvbSecretRequest(requestParameters: InsertSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequest>;
|
|
2830
2849
|
/**
|
|
2831
|
-
*
|
|
2832
|
-
* @summary Add an email step, with its new email
|
|
2850
|
+
* type email (the default) creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. The email has no body yet, and gets the content review flags the admin gives a new email here. With library_item_oid the email starts from a code library email item instead (listSfvbCodeLibraryEmails): its body with new element ids, and its subject and preview text where the request gives none. The item must be this account\'s own, shared with it, or published, approved by UltraCart and free; it must pass the library content scanner and the email container rules, and executable elements need acknowledge_executable true. Its PNG, JPEG and GIF image files are copied into the storefront first, never over an existing file; any other file is skipped and listed. type wait adds a wait step with config_json as its settings: delay_duration and delay_duration_unit (minutes, hours, days, weeks or months), or a delay_until option; a wait that would pass customers on at once is refused. type post_card creates a new postcard with the admin\'s default front and back and adds the postcard step that mails it, together; the step starts disabled, so nothing is printed or mailed until it is turned on with set-config, and the response names the front and back containers. Any goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the new step, as the admin\'s editor adds them. A sequence whose campaign or flow is live needs sfvb_publish.
|
|
2851
|
+
* @summary Add an email step, with its new email, a wait step, or a postcard step, with its new postcard
|
|
2833
2852
|
* @param {number} storefrontOid
|
|
2834
2853
|
* @param {string} sequenceUuid
|
|
2835
2854
|
* @param {string} ifMatch The hash_sha256 of the step it goes after, or of the branching step, or * for the first step of a sequence with no steps. Required; 428 when absent, 412 when stale.
|
|
2836
|
-
* @param {SfvbSequenceStepCreateRequest} sequenceStepCreateRequest Where the step goes, and the new email\'s subject and preview text
|
|
2855
|
+
* @param {SfvbSequenceStepCreateRequest} sequenceStepCreateRequest Where the step goes, and the new email\'s subject and preview text or code library item, the wait\'s config_json, or the postcard step\'s name
|
|
2837
2856
|
* @param {*} [options] Override http request option.
|
|
2838
2857
|
* @throws {RequiredError}
|
|
2839
2858
|
* @memberof SfvbApiInterface
|
|
2840
2859
|
*/
|
|
2841
2860
|
insertSfvbSequenceStepRaw(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepCreateResponse>>;
|
|
2842
2861
|
/**
|
|
2843
|
-
*
|
|
2844
|
-
* Add an email step, with its new email
|
|
2862
|
+
* type email (the default) creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. The email has no body yet, and gets the content review flags the admin gives a new email here. With library_item_oid the email starts from a code library email item instead (listSfvbCodeLibraryEmails): its body with new element ids, and its subject and preview text where the request gives none. The item must be this account\'s own, shared with it, or published, approved by UltraCart and free; it must pass the library content scanner and the email container rules, and executable elements need acknowledge_executable true. Its PNG, JPEG and GIF image files are copied into the storefront first, never over an existing file; any other file is skipped and listed. type wait adds a wait step with config_json as its settings: delay_duration and delay_duration_unit (minutes, hours, days, weeks or months), or a delay_until option; a wait that would pass customers on at once is refused. type post_card creates a new postcard with the admin\'s default front and back and adds the postcard step that mails it, together; the step starts disabled, so nothing is printed or mailed until it is turned on with set-config, and the response names the front and back containers. Any goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the new step, as the admin\'s editor adds them. A sequence whose campaign or flow is live needs sfvb_publish.
|
|
2863
|
+
* Add an email step, with its new email, a wait step, or a postcard step, with its new postcard
|
|
2845
2864
|
*/
|
|
2846
2865
|
insertSfvbSequenceStep(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepCreateResponse>;
|
|
2847
2866
|
/**
|
|
@@ -2925,6 +2944,21 @@ export interface SfvbApiInterface {
|
|
|
2925
2944
|
* List the storefront\'s campaigns
|
|
2926
2945
|
*/
|
|
2927
2946
|
listSfvbCampaigns(requestParameters: ListSfvbCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaignsResponse>;
|
|
2947
|
+
/**
|
|
2948
|
+
* The code library is the one the admin\'s \"start from library\" uses; it isn\'t the Visual Builder element library. Lists the email items this account may use, by title: its own (source owned), those shared with it (shared), and those published for everyone, approved by UltraCart and free (public). search matches part of the title, with case. Each kind is capped at 100 items, and truncated says when there were more. Send an item\'s library_item_oid on the step insert to start a new email from it.
|
|
2949
|
+
* @summary Email items from the code library that can start a new email step
|
|
2950
|
+
* @param {number} storefrontOid
|
|
2951
|
+
* @param {string} [search] Part of the title to match, with case. Up to 100 characters.
|
|
2952
|
+
* @param {*} [options] Override http request option.
|
|
2953
|
+
* @throws {RequiredError}
|
|
2954
|
+
* @memberof SfvbApiInterface
|
|
2955
|
+
*/
|
|
2956
|
+
listSfvbCodeLibraryEmailsRaw(requestParameters: ListSfvbCodeLibraryEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCodeLibraryEmailsResponse>>;
|
|
2957
|
+
/**
|
|
2958
|
+
* The code library is the one the admin\'s \"start from library\" uses; it isn\'t the Visual Builder element library. Lists the email items this account may use, by title: its own (source owned), those shared with it (shared), and those published for everyone, approved by UltraCart and free (public). search matches part of the title, with case. Each kind is capped at 100 items, and truncated says when there were more. Send an item\'s library_item_oid on the step insert to start a new email from it.
|
|
2959
|
+
* Email items from the code library that can start a new email step
|
|
2960
|
+
*/
|
|
2961
|
+
listSfvbCodeLibraryEmails(requestParameters: ListSfvbCodeLibraryEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCodeLibraryEmailsResponse>;
|
|
2928
2962
|
/**
|
|
2929
2963
|
* Each list\'s uuid, name and member count, by name, for a campaign\'s memberships or a list trigger. Never its members. Archived lists are left out.
|
|
2930
2964
|
* @summary List the storefront\'s email lists
|
|
@@ -3219,6 +3253,25 @@ export interface SfvbApiInterface {
|
|
|
3219
3253
|
* List upsell paths
|
|
3220
3254
|
*/
|
|
3221
3255
|
listSfvbUpsellPaths(requestParameters: ListSfvbUpsellPathsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellPathsResponse>;
|
|
3256
|
+
/**
|
|
3257
|
+
* Moves the step, in one transaction, to right after after_step_uuid (the begin step puts it first in the sequence) or to the start of one side of a condition, split or inboxgeek step (branch_step_uuid with side). The step keeps its uuid, settings and the email or postcard it sends: nothing is archived or created. Refused for the begin, end, continue and merge markers, for a condition, split or inboxgeek step, while any customer is waiting on the step, and when the new place is the one it is in. Send the step\'s hash_sha256 as If-Match, and the hash_sha256 of after_step_uuid or branch_step_uuid as anchor_hash_sha256. A sequence whose campaign or flow is live needs sfvb_publish and an approved sequence_step.move approval (Approval-Id); a draft or inactive one needs neither.
|
|
3258
|
+
* @summary Move one step
|
|
3259
|
+
* @param {number} storefrontOid
|
|
3260
|
+
* @param {string} sequenceUuid
|
|
3261
|
+
* @param {string} stepUuid
|
|
3262
|
+
* @param {string} ifMatch The moved step\'s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
3263
|
+
* @param {SfvbSequenceStepMoveRequest} sequenceStepMoveRequest Where the step moves, and the hash of the step it goes next to
|
|
3264
|
+
* @param {string} [approvalId] When the sequence is live, the approval_id of an approved sequence_step.move request for exactly this move. See POST /sfvb/approvals.
|
|
3265
|
+
* @param {*} [options] Override http request option.
|
|
3266
|
+
* @throws {RequiredError}
|
|
3267
|
+
* @memberof SfvbApiInterface
|
|
3268
|
+
*/
|
|
3269
|
+
moveSfvbSequenceStepRaw(requestParameters: MoveSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepMoveResponse>>;
|
|
3270
|
+
/**
|
|
3271
|
+
* Moves the step, in one transaction, to right after after_step_uuid (the begin step puts it first in the sequence) or to the start of one side of a condition, split or inboxgeek step (branch_step_uuid with side). The step keeps its uuid, settings and the email or postcard it sends: nothing is archived or created. Refused for the begin, end, continue and merge markers, for a condition, split or inboxgeek step, while any customer is waiting on the step, and when the new place is the one it is in. Send the step\'s hash_sha256 as If-Match, and the hash_sha256 of after_step_uuid or branch_step_uuid as anchor_hash_sha256. A sequence whose campaign or flow is live needs sfvb_publish and an approved sequence_step.move approval (Approval-Id); a draft or inactive one needs neither.
|
|
3272
|
+
* Move one step
|
|
3273
|
+
*/
|
|
3274
|
+
moveSfvbSequenceStep(requestParameters: MoveSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepMoveResponse>;
|
|
3222
3275
|
/**
|
|
3223
3276
|
* Up, down, to the top or to the bottom of the storefront\'s paths. Order decides which running path a shopper meets first, so moving a running path needs sfvb_publish.
|
|
3224
3277
|
* @summary Move an upsell path
|
|
@@ -3235,6 +3288,23 @@ export interface SfvbApiInterface {
|
|
|
3235
3288
|
* Move an upsell path
|
|
3236
3289
|
*/
|
|
3237
3290
|
moveSfvbUpsellPath(requestParameters: MoveSfvbUpsellPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellPath>;
|
|
3291
|
+
/**
|
|
3292
|
+
* Renders both sides of the step\'s postcard as a send renders them, then has the print vendor render the card as a dry run. Returns the HTML of each side, the PNG image of each side that the vendor prints from, the vendor\'s thumbnails and its proof PDF. The QR code is the short link a send prints. No card is printed or mailed, nothing is billed, the step is not changed, and no coupon is created. A unique coupon code shows as PREVIEW-UNIQUE. The image urls are public. html_only returns the HTML alone, with no vendor render. An order must be a test order. cart_item_ids fills the cart a cart flow card shows. Works whether the step is on or off.
|
|
3293
|
+
* @summary Proof a postcard step without mailing it
|
|
3294
|
+
* @param {number} storefrontOid
|
|
3295
|
+
* @param {string} sequenceUuid
|
|
3296
|
+
* @param {string} stepUuid
|
|
3297
|
+
* @param {SfvbPostcardProofRequest} postcardProofRequest Who the card is addressed to, and the order or cart it shows
|
|
3298
|
+
* @param {*} [options] Override http request option.
|
|
3299
|
+
* @throws {RequiredError}
|
|
3300
|
+
* @memberof SfvbApiInterface
|
|
3301
|
+
*/
|
|
3302
|
+
proofSfvbSequencePostcardRaw(requestParameters: ProofSfvbSequencePostcardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPostcardProofResponse>>;
|
|
3303
|
+
/**
|
|
3304
|
+
* Renders both sides of the step\'s postcard as a send renders them, then has the print vendor render the card as a dry run. Returns the HTML of each side, the PNG image of each side that the vendor prints from, the vendor\'s thumbnails and its proof PDF. The QR code is the short link a send prints. No card is printed or mailed, nothing is billed, the step is not changed, and no coupon is created. A unique coupon code shows as PREVIEW-UNIQUE. The image urls are public. html_only returns the HTML alone, with no vendor render. An order must be a test order. cart_item_ids fills the cart a cart flow card shows. Works whether the step is on or off.
|
|
3305
|
+
* Proof a postcard step without mailing it
|
|
3306
|
+
*/
|
|
3307
|
+
proofSfvbSequencePostcard(requestParameters: ProofSfvbSequencePostcardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPostcardProofResponse>;
|
|
3238
3308
|
/**
|
|
3239
3309
|
* Freezes the draft as a published revision at its revision_number and sets who can see it. Owner only, with the draft\'s hash_sha256 as If-Match. Always needs sfvb_publish, because it changes what other merchants can install. Images, fonts, stylesheets and media must be relative paths, and credential shaped strings are refused. Public also needs the library publisher property on the account and no executable content at all - no script, html, embed, css or velocity elements. After those checks an automated AI review reads the fragment, which can take up to about a minute. A clear violation both of its models agree on refuses any publish with sfvb.library_ai_review_blocked. A public publish also needs its approval, otherwise sfvb.library_ai_review_inconclusive. The result is in content_manifest.ai_review.
|
|
3240
3310
|
* @summary Publish a library entry\'s draft
|
|
@@ -4185,20 +4255,21 @@ export interface SfvbApiInterface {
|
|
|
4185
4255
|
*/
|
|
4186
4256
|
updateSfvbRedirect(requestParameters: UpdateSfvbRedirectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRedirectResponse>;
|
|
4187
4257
|
/**
|
|
4188
|
-
* Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email,
|
|
4258
|
+
* Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, experiment, resend, webhook, begin, end, continue and merge steps are refused. On a post_card step only disabled, name and info change, and not its filter. A sequence whose campaign or flow is live needs sfvb_publish. Turning a post_card step on, live or not, needs an approved sequence_step.enable_postcard approval (Approval-Id): once on, it mails printed cards whenever the campaign or flow runs.
|
|
4189
4259
|
* @summary Change one step\'s settings or audience filter
|
|
4190
4260
|
* @param {number} storefrontOid
|
|
4191
4261
|
* @param {string} sequenceUuid
|
|
4192
4262
|
* @param {string} stepUuid
|
|
4193
4263
|
* @param {string} ifMatch The step\'s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
4194
4264
|
* @param {SfvbSequenceStepUpdateRequest} sequenceStepUpdateRequest The settings, the filter, or both
|
|
4265
|
+
* @param {string} [approvalId] When the change turns a post_card step on, the approval_id of an approved sequence_step.enable_postcard request for this step. See POST /sfvb/approvals.
|
|
4195
4266
|
* @param {*} [options] Override http request option.
|
|
4196
4267
|
* @throws {RequiredError}
|
|
4197
4268
|
* @memberof SfvbApiInterface
|
|
4198
4269
|
*/
|
|
4199
4270
|
updateSfvbSequenceStepRaw(requestParameters: UpdateSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepUpdateResponse>>;
|
|
4200
4271
|
/**
|
|
4201
|
-
* Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email,
|
|
4272
|
+
* Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, experiment, resend, webhook, begin, end, continue and merge steps are refused. On a post_card step only disabled, name and info change, and not its filter. A sequence whose campaign or flow is live needs sfvb_publish. Turning a post_card step on, live or not, needs an approved sequence_step.enable_postcard approval (Approval-Id): once on, it mails printed cards whenever the campaign or flow runs.
|
|
4202
4273
|
* Change one step\'s settings or audience filter
|
|
4203
4274
|
*/
|
|
4204
4275
|
updateSfvbSequenceStep(requestParameters: UpdateSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepUpdateResponse>;
|
|
@@ -5484,13 +5555,13 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
5484
5555
|
*/
|
|
5485
5556
|
insertSfvbSecretRequest(requestParameters: InsertSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequest>;
|
|
5486
5557
|
/**
|
|
5487
|
-
*
|
|
5488
|
-
* Add an email step, with its new email
|
|
5558
|
+
* type email (the default) creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. The email has no body yet, and gets the content review flags the admin gives a new email here. With library_item_oid the email starts from a code library email item instead (listSfvbCodeLibraryEmails): its body with new element ids, and its subject and preview text where the request gives none. The item must be this account\'s own, shared with it, or published, approved by UltraCart and free; it must pass the library content scanner and the email container rules, and executable elements need acknowledge_executable true. Its PNG, JPEG and GIF image files are copied into the storefront first, never over an existing file; any other file is skipped and listed. type wait adds a wait step with config_json as its settings: delay_duration and delay_duration_unit (minutes, hours, days, weeks or months), or a delay_until option; a wait that would pass customers on at once is refused. type post_card creates a new postcard with the admin\'s default front and back and adds the postcard step that mails it, together; the step starts disabled, so nothing is printed or mailed until it is turned on with set-config, and the response names the front and back containers. Any goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the new step, as the admin\'s editor adds them. A sequence whose campaign or flow is live needs sfvb_publish.
|
|
5559
|
+
* Add an email step, with its new email, a wait step, or a postcard step, with its new postcard
|
|
5489
5560
|
*/
|
|
5490
5561
|
insertSfvbSequenceStepRaw(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepCreateResponse>>;
|
|
5491
5562
|
/**
|
|
5492
|
-
*
|
|
5493
|
-
* Add an email step, with its new email
|
|
5563
|
+
* type email (the default) creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. The email has no body yet, and gets the content review flags the admin gives a new email here. With library_item_oid the email starts from a code library email item instead (listSfvbCodeLibraryEmails): its body with new element ids, and its subject and preview text where the request gives none. The item must be this account\'s own, shared with it, or published, approved by UltraCart and free; it must pass the library content scanner and the email container rules, and executable elements need acknowledge_executable true. Its PNG, JPEG and GIF image files are copied into the storefront first, never over an existing file; any other file is skipped and listed. type wait adds a wait step with config_json as its settings: delay_duration and delay_duration_unit (minutes, hours, days, weeks or months), or a delay_until option; a wait that would pass customers on at once is refused. type post_card creates a new postcard with the admin\'s default front and back and adds the postcard step that mails it, together; the step starts disabled, so nothing is printed or mailed until it is turned on with set-config, and the response names the front and back containers. Any goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the new step, as the admin\'s editor adds them. A sequence whose campaign or flow is live needs sfvb_publish.
|
|
5564
|
+
* Add an email step, with its new email, a wait step, or a postcard step, with its new postcard
|
|
5494
5565
|
*/
|
|
5495
5566
|
insertSfvbSequenceStep(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepCreateResponse>;
|
|
5496
5567
|
/**
|
|
@@ -5543,6 +5614,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
5543
5614
|
* List the storefront\'s campaigns
|
|
5544
5615
|
*/
|
|
5545
5616
|
listSfvbCampaigns(requestParameters: ListSfvbCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaignsResponse>;
|
|
5617
|
+
/**
|
|
5618
|
+
* The code library is the one the admin\'s \"start from library\" uses; it isn\'t the Visual Builder element library. Lists the email items this account may use, by title: its own (source owned), those shared with it (shared), and those published for everyone, approved by UltraCart and free (public). search matches part of the title, with case. Each kind is capped at 100 items, and truncated says when there were more. Send an item\'s library_item_oid on the step insert to start a new email from it.
|
|
5619
|
+
* Email items from the code library that can start a new email step
|
|
5620
|
+
*/
|
|
5621
|
+
listSfvbCodeLibraryEmailsRaw(requestParameters: ListSfvbCodeLibraryEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCodeLibraryEmailsResponse>>;
|
|
5622
|
+
/**
|
|
5623
|
+
* The code library is the one the admin\'s \"start from library\" uses; it isn\'t the Visual Builder element library. Lists the email items this account may use, by title: its own (source owned), those shared with it (shared), and those published for everyone, approved by UltraCart and free (public). search matches part of the title, with case. Each kind is capped at 100 items, and truncated says when there were more. Send an item\'s library_item_oid on the step insert to start a new email from it.
|
|
5624
|
+
* Email items from the code library that can start a new email step
|
|
5625
|
+
*/
|
|
5626
|
+
listSfvbCodeLibraryEmails(requestParameters: ListSfvbCodeLibraryEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCodeLibraryEmailsResponse>;
|
|
5546
5627
|
/**
|
|
5547
5628
|
* Each list\'s uuid, name and member count, by name, for a campaign\'s memberships or a list trigger. Never its members. Archived lists are left out.
|
|
5548
5629
|
* List the storefront\'s email lists
|
|
@@ -5721,6 +5802,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
5721
5802
|
* List upsell paths
|
|
5722
5803
|
*/
|
|
5723
5804
|
listSfvbUpsellPaths(requestParameters: ListSfvbUpsellPathsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellPathsResponse>;
|
|
5805
|
+
/**
|
|
5806
|
+
* Moves the step, in one transaction, to right after after_step_uuid (the begin step puts it first in the sequence) or to the start of one side of a condition, split or inboxgeek step (branch_step_uuid with side). The step keeps its uuid, settings and the email or postcard it sends: nothing is archived or created. Refused for the begin, end, continue and merge markers, for a condition, split or inboxgeek step, while any customer is waiting on the step, and when the new place is the one it is in. Send the step\'s hash_sha256 as If-Match, and the hash_sha256 of after_step_uuid or branch_step_uuid as anchor_hash_sha256. A sequence whose campaign or flow is live needs sfvb_publish and an approved sequence_step.move approval (Approval-Id); a draft or inactive one needs neither.
|
|
5807
|
+
* Move one step
|
|
5808
|
+
*/
|
|
5809
|
+
moveSfvbSequenceStepRaw(requestParameters: MoveSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepMoveResponse>>;
|
|
5810
|
+
/**
|
|
5811
|
+
* Moves the step, in one transaction, to right after after_step_uuid (the begin step puts it first in the sequence) or to the start of one side of a condition, split or inboxgeek step (branch_step_uuid with side). The step keeps its uuid, settings and the email or postcard it sends: nothing is archived or created. Refused for the begin, end, continue and merge markers, for a condition, split or inboxgeek step, while any customer is waiting on the step, and when the new place is the one it is in. Send the step\'s hash_sha256 as If-Match, and the hash_sha256 of after_step_uuid or branch_step_uuid as anchor_hash_sha256. A sequence whose campaign or flow is live needs sfvb_publish and an approved sequence_step.move approval (Approval-Id); a draft or inactive one needs neither.
|
|
5812
|
+
* Move one step
|
|
5813
|
+
*/
|
|
5814
|
+
moveSfvbSequenceStep(requestParameters: MoveSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepMoveResponse>;
|
|
5724
5815
|
/**
|
|
5725
5816
|
* Up, down, to the top or to the bottom of the storefront\'s paths. Order decides which running path a shopper meets first, so moving a running path needs sfvb_publish.
|
|
5726
5817
|
* Move an upsell path
|
|
@@ -5731,6 +5822,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
5731
5822
|
* Move an upsell path
|
|
5732
5823
|
*/
|
|
5733
5824
|
moveSfvbUpsellPath(requestParameters: MoveSfvbUpsellPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellPath>;
|
|
5825
|
+
/**
|
|
5826
|
+
* Renders both sides of the step\'s postcard as a send renders them, then has the print vendor render the card as a dry run. Returns the HTML of each side, the PNG image of each side that the vendor prints from, the vendor\'s thumbnails and its proof PDF. The QR code is the short link a send prints. No card is printed or mailed, nothing is billed, the step is not changed, and no coupon is created. A unique coupon code shows as PREVIEW-UNIQUE. The image urls are public. html_only returns the HTML alone, with no vendor render. An order must be a test order. cart_item_ids fills the cart a cart flow card shows. Works whether the step is on or off.
|
|
5827
|
+
* Proof a postcard step without mailing it
|
|
5828
|
+
*/
|
|
5829
|
+
proofSfvbSequencePostcardRaw(requestParameters: ProofSfvbSequencePostcardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPostcardProofResponse>>;
|
|
5830
|
+
/**
|
|
5831
|
+
* Renders both sides of the step\'s postcard as a send renders them, then has the print vendor render the card as a dry run. Returns the HTML of each side, the PNG image of each side that the vendor prints from, the vendor\'s thumbnails and its proof PDF. The QR code is the short link a send prints. No card is printed or mailed, nothing is billed, the step is not changed, and no coupon is created. A unique coupon code shows as PREVIEW-UNIQUE. The image urls are public. html_only returns the HTML alone, with no vendor render. An order must be a test order. cart_item_ids fills the cart a cart flow card shows. Works whether the step is on or off.
|
|
5832
|
+
* Proof a postcard step without mailing it
|
|
5833
|
+
*/
|
|
5834
|
+
proofSfvbSequencePostcard(requestParameters: ProofSfvbSequencePostcardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPostcardProofResponse>;
|
|
5734
5835
|
/**
|
|
5735
5836
|
* Freezes the draft as a published revision at its revision_number and sets who can see it. Owner only, with the draft\'s hash_sha256 as If-Match. Always needs sfvb_publish, because it changes what other merchants can install. Images, fonts, stylesheets and media must be relative paths, and credential shaped strings are refused. Public also needs the library publisher property on the account and no executable content at all - no script, html, embed, css or velocity elements. After those checks an automated AI review reads the fragment, which can take up to about a minute. A clear violation both of its models agree on refuses any publish with sfvb.library_ai_review_blocked. A public publish also needs its approval, otherwise sfvb.library_ai_review_inconclusive. The result is in content_manifest.ai_review.
|
|
5736
5837
|
* Publish a library entry\'s draft
|
|
@@ -6312,12 +6413,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
6312
6413
|
*/
|
|
6313
6414
|
updateSfvbRedirect(requestParameters: UpdateSfvbRedirectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRedirectResponse>;
|
|
6314
6415
|
/**
|
|
6315
|
-
* Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email,
|
|
6416
|
+
* Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, experiment, resend, webhook, begin, end, continue and merge steps are refused. On a post_card step only disabled, name and info change, and not its filter. A sequence whose campaign or flow is live needs sfvb_publish. Turning a post_card step on, live or not, needs an approved sequence_step.enable_postcard approval (Approval-Id): once on, it mails printed cards whenever the campaign or flow runs.
|
|
6316
6417
|
* Change one step\'s settings or audience filter
|
|
6317
6418
|
*/
|
|
6318
6419
|
updateSfvbSequenceStepRaw(requestParameters: UpdateSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepUpdateResponse>>;
|
|
6319
6420
|
/**
|
|
6320
|
-
* Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email,
|
|
6421
|
+
* Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, experiment, resend, webhook, begin, end, continue and merge steps are refused. On a post_card step only disabled, name and info change, and not its filter. A sequence whose campaign or flow is live needs sfvb_publish. Turning a post_card step on, live or not, needs an approved sequence_step.enable_postcard approval (Approval-Id): once on, it mails printed cards whenever the campaign or flow runs.
|
|
6321
6422
|
* Change one step\'s settings or audience filter
|
|
6322
6423
|
*/
|
|
6323
6424
|
updateSfvbSequenceStep(requestParameters: UpdateSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepUpdateResponse>;
|