ultracart_rest_api_v2_typescript 4.1.220 → 4.1.221

package/.openapi-generator/FILES

@@ -1165,6 +1165,8 @@ src/models/SfvbPageResponse.ts
 src/models/SfvbPageSelectors.ts
 src/models/SfvbPageSettingsRequest.ts
 src/models/SfvbPageSummary.ts
+src/models/SfvbPostcardProofRequest.ts
+src/models/SfvbPostcardProofResponse.ts
 src/models/SfvbPreviewAccessRequest.ts
 src/models/SfvbPreviewAccessResponse.ts
 src/models/SfvbPreviewSessionRequest.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.220
+## ultracart_rest_api_v2_typescript@4.1.221
 
 Every API method call has a sample for every language SDK.  See https://github.com/UltraCart/sdk_samples
 
 Installation
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.1.220 --save
+npm install ultracart_rest_api_v2_typescript@4.1.221 --save
 ```
 
 ```typescript
@@ -84,6 +84,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.221 | 11/02/2026 | sfvb internal testing |
 | 4.1.220 | 11/02/2026 | sfvb internal testing |
 | 4.1.219 | 10/30/2026 | item - field for hsa/fsa eligibility |
 | 4.1.218 | 10/30/2026 | svfb internal testing |

package/dist/apis/SfvbApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-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, 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';
+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';
 export interface AddSfvbPageBlogPostsRequest {
     storefrontOid: number;
     path: string;
@@ -655,6 +655,12 @@ export interface MoveSfvbUpsellPathRequest {
     upsellPathOid: number;
     moveRequest: SfvbUpsellPathMoveRequest;
 }
+export interface ProofSfvbSequencePostcardRequest {
+    storefrontOid: number;
+    sequenceUuid: string;
+    stepUuid: string;
+    postcardProofRequest: SfvbPostcardProofRequest;
+}
 export interface PublishSfvbLibraryEntryRequest {
     storefrontOid: number;
     libraryOid: number;
@@ -3282,6 +3288,23 @@ export interface SfvbApiInterface {
      * Move an upsell path
      */
     moveSfvbUpsellPath(requestParameters: MoveSfvbUpsellPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellPath>;
+    /**
+     * 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.
+     * @summary Proof a postcard step without mailing it
+     * @param {number} storefrontOid
+     * @param {string} sequenceUuid
+     * @param {string} stepUuid
+     * @param {SfvbPostcardProofRequest} postcardProofRequest Who the card is addressed to, and the order or cart it shows
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    proofSfvbSequencePostcardRaw(requestParameters: ProofSfvbSequencePostcardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPostcardProofResponse>>;
+    /**
+     * 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.
+     * Proof a postcard step without mailing it
+     */
+    proofSfvbSequencePostcard(requestParameters: ProofSfvbSequencePostcardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPostcardProofResponse>;
     /**
      * 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.
      * @summary Publish a library entry\'s draft
@@ -5799,6 +5822,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Move an upsell path
      */
     moveSfvbUpsellPath(requestParameters: MoveSfvbUpsellPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellPath>;
+    /**
+     * 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.
+     * Proof a postcard step without mailing it
+     */
+    proofSfvbSequencePostcardRaw(requestParameters: ProofSfvbSequencePostcardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPostcardProofResponse>>;
+    /**
+     * 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.
+     * Proof a postcard step without mailing it
+     */
+    proofSfvbSequencePostcard(requestParameters: ProofSfvbSequencePostcardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPostcardProofResponse>;
     /**
      * 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.
      * Publish a library entry\'s draft

package/dist/apis/SfvbApi.js

@@ -9508,6 +9508,76 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * 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.
+     * Proof a postcard step without mailing it
+     */
+    SfvbApi.prototype.proofSfvbSequencePostcardRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+                            throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling proofSfvbSequencePostcard.');
+                        }
+                        if (requestParameters.sequenceUuid === null || requestParameters.sequenceUuid === undefined) {
+                            throw new runtime.RequiredError('sequenceUuid', 'Required parameter requestParameters.sequenceUuid was null or undefined when calling proofSfvbSequencePostcard.');
+                        }
+                        if (requestParameters.stepUuid === null || requestParameters.stepUuid === undefined) {
+                            throw new runtime.RequiredError('stepUuid', 'Required parameter requestParameters.stepUuid was null or undefined when calling proofSfvbSequencePostcard.');
+                        }
+                        if (requestParameters.postcardProofRequest === null || requestParameters.postcardProofRequest === undefined) {
+                            throw new runtime.RequiredError('postcardProofRequest', 'Required parameter requestParameters.postcardProofRequest was null or undefined when calling proofSfvbSequencePostcard.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/postcard_proof".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("sequence_uuid", "}"), encodeURIComponent(String(requestParameters.sequenceUuid))).replace("{".concat("step_uuid", "}"), encodeURIComponent(String(requestParameters.stepUuid))),
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.SfvbPostcardProofRequestToJSON)(requestParameters.postcardProofRequest),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbPostcardProofResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * 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.
+     * Proof a postcard step without mailing it
+     */
+    SfvbApi.prototype.proofSfvbSequencePostcard = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.proofSfvbSequencePostcardRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * 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.
      * Publish a library entry\'s draft

package/dist/models/SfvbPostcardProofRequest.d.ts

@@ -0,0 +1,79 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface SfvbPostcardProofRequest
+ */
+export interface SfvbPostcardProofRequest {
+    /**
+     * The recipient street address.  Without address1, city, state and postal_code, a sample address is used.
+     * @type {string}
+     * @memberof SfvbPostcardProofRequest
+     */
+    address1?: string;
+    /**
+     * The recipient second address line.
+     * @type {string}
+     * @memberof SfvbPostcardProofRequest
+     */
+    address2?: string;
+    /**
+     * Item ids for the cart a cart flow card renders with.  The cart is made for the proof and deleted after it.
+     * @type {Array<string>}
+     * @memberof SfvbPostcardProofRequest
+     */
+    cart_item_ids?: Array<string>;
+    /**
+     * The recipient city.
+     * @type {string}
+     * @memberof SfvbPostcardProofRequest
+     */
+    city?: string;
+    /**
+     * The recipient name the card greets and is addressed to.  Defaults to the signed in user.
+     * @type {string}
+     * @memberof SfvbPostcardProofRequest
+     */
+    customer_name?: string;
+    /**
+     * True to return only the rendered HTML of both sides, with no print vendor render.  The default, false, also returns the images that would print and the vendor proof PDF.
+     * @type {boolean}
+     * @memberof SfvbPostcardProofRequest
+     */
+    html_only?: boolean;
+    /**
+     * A test order for an order flow card.  Real orders are refused.  Without one, an order flow card renders with a made up order.
+     * @type {string}
+     * @memberof SfvbPostcardProofRequest
+     */
+    order_id?: string;
+    /**
+     * The recipient postal code.
+     * @type {string}
+     * @memberof SfvbPostcardProofRequest
+     */
+    postal_code?: string;
+    /**
+     * The recipient state.
+     * @type {string}
+     * @memberof SfvbPostcardProofRequest
+     */
+    state?: string;
+}
+/**
+ * Check if a given object implements the SfvbPostcardProofRequest interface.
+ */
+export declare function instanceOfSfvbPostcardProofRequest(value: object): boolean;
+export declare function SfvbPostcardProofRequestFromJSON(json: any): SfvbPostcardProofRequest;
+export declare function SfvbPostcardProofRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbPostcardProofRequest;
+export declare function SfvbPostcardProofRequestToJSON(value?: SfvbPostcardProofRequest | null): any;

package/dist/models/SfvbPostcardProofRequest.js

@@ -0,0 +1,66 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SfvbPostcardProofRequestToJSON = exports.SfvbPostcardProofRequestFromJSONTyped = exports.SfvbPostcardProofRequestFromJSON = exports.instanceOfSfvbPostcardProofRequest = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the SfvbPostcardProofRequest interface.
+ */
+function instanceOfSfvbPostcardProofRequest(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbPostcardProofRequest = instanceOfSfvbPostcardProofRequest;
+function SfvbPostcardProofRequestFromJSON(json) {
+    return SfvbPostcardProofRequestFromJSONTyped(json, false);
+}
+exports.SfvbPostcardProofRequestFromJSON = SfvbPostcardProofRequestFromJSON;
+function SfvbPostcardProofRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'address1': !(0, runtime_1.exists)(json, 'address1') ? undefined : json['address1'],
+        'address2': !(0, runtime_1.exists)(json, 'address2') ? undefined : json['address2'],
+        'cart_item_ids': !(0, runtime_1.exists)(json, 'cart_item_ids') ? undefined : json['cart_item_ids'],
+        'city': !(0, runtime_1.exists)(json, 'city') ? undefined : json['city'],
+        'customer_name': !(0, runtime_1.exists)(json, 'customer_name') ? undefined : json['customer_name'],
+        'html_only': !(0, runtime_1.exists)(json, 'html_only') ? undefined : json['html_only'],
+        'order_id': !(0, runtime_1.exists)(json, 'order_id') ? undefined : json['order_id'],
+        'postal_code': !(0, runtime_1.exists)(json, 'postal_code') ? undefined : json['postal_code'],
+        'state': !(0, runtime_1.exists)(json, 'state') ? undefined : json['state'],
+    };
+}
+exports.SfvbPostcardProofRequestFromJSONTyped = SfvbPostcardProofRequestFromJSONTyped;
+function SfvbPostcardProofRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'address1': value.address1,
+        'address2': value.address2,
+        'cart_item_ids': value.cart_item_ids,
+        'city': value.city,
+        'customer_name': value.customer_name,
+        'html_only': value.html_only,
+        'order_id': value.order_id,
+        'postal_code': value.postal_code,
+        'state': value.state,
+    };
+}
+exports.SfvbPostcardProofRequestToJSON = SfvbPostcardProofRequestToJSON;

package/dist/models/SfvbPostcardProofResponse.d.ts

@@ -0,0 +1,101 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { SfvbErrorDetail } from './SfvbErrorDetail';
+/**
+ *
+ * @export
+ * @interface SfvbPostcardProofResponse
+ */
+export interface SfvbPostcardProofResponse {
+    /**
+     * The back as the send renders it, after the name tokens are filled.
+     * @type {string}
+     * @memberof SfvbPostcardProofResponse
+     */
+    back_html?: string;
+    /**
+     * The back as the PNG image the print vendor prints from.  A public url.
+     * @type {string}
+     * @memberof SfvbPostcardProofResponse
+     */
+    back_image_url?: string;
+    /**
+     * The print vendor thumbnail of the back.
+     * @type {string}
+     * @memberof SfvbPostcardProofResponse
+     */
+    back_thumbnail_url?: string;
+    /**
+     * The front as the send renders it, after the name tokens are filled.
+     * @type {string}
+     * @memberof SfvbPostcardProofResponse
+     */
+    front_html?: string;
+    /**
+     * The front as the PNG image the print vendor prints from.  A public url.
+     * @type {string}
+     * @memberof SfvbPostcardProofResponse
+     */
+    front_image_url?: string;
+    /**
+     * The print vendor thumbnail of the front.
+     * @type {string}
+     * @memberof SfvbPostcardProofResponse
+     */
+    front_thumbnail_url?: string;
+    /**
+     * Where the order came from.  test for the order_id given, dummy for a made up one, none for no order.
+     * @type {string}
+     * @memberof SfvbPostcardProofResponse
+     */
+    order_source?: SfvbPostcardProofResponseOrderSourceEnum;
+    /**
+     * The postcard the step mails.
+     * @type {string}
+     * @memberof SfvbPostcardProofResponse
+     */
+    postcard_uuid?: string;
+    /**
+     * The print vendor proof PDF of both sides.
+     * @type {string}
+     * @memberof SfvbPostcardProofResponse
+     */
+    rendered_pdf_url?: string;
+    /**
+     * True when the print vendor rendered the card, so the image and PDF urls are set.
+     * @type {boolean}
+     * @memberof SfvbPostcardProofResponse
+     */
+    vendor_rendered?: boolean;
+    /**
+     * Where the proof differs from a send, such as a placeholder coupon code or a sample address, and anything that would make a send skip the card.
+     * @type {Array<SfvbErrorDetail>}
+     * @memberof SfvbPostcardProofResponse
+     */
+    warnings?: Array<SfvbErrorDetail>;
+}
+/**
+ * @export
+ */
+export declare const SfvbPostcardProofResponseOrderSourceEnum: {
+    readonly Test: "test";
+    readonly Dummy: "dummy";
+    readonly None: "none";
+};
+export type SfvbPostcardProofResponseOrderSourceEnum = typeof SfvbPostcardProofResponseOrderSourceEnum[keyof typeof SfvbPostcardProofResponseOrderSourceEnum];
+/**
+ * Check if a given object implements the SfvbPostcardProofResponse interface.
+ */
+export declare function instanceOfSfvbPostcardProofResponse(value: object): boolean;
+export declare function SfvbPostcardProofResponseFromJSON(json: any): SfvbPostcardProofResponse;
+export declare function SfvbPostcardProofResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbPostcardProofResponse;
+export declare function SfvbPostcardProofResponseToJSON(value?: SfvbPostcardProofResponse | null): any;

package/dist/models/SfvbPostcardProofResponse.js

@@ -0,0 +1,79 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SfvbPostcardProofResponseToJSON = exports.SfvbPostcardProofResponseFromJSONTyped = exports.SfvbPostcardProofResponseFromJSON = exports.instanceOfSfvbPostcardProofResponse = exports.SfvbPostcardProofResponseOrderSourceEnum = void 0;
+var runtime_1 = require("../runtime");
+var SfvbErrorDetail_1 = require("./SfvbErrorDetail");
+/**
+ * @export
+ */
+exports.SfvbPostcardProofResponseOrderSourceEnum = {
+    Test: 'test',
+    Dummy: 'dummy',
+    None: 'none'
+};
+/**
+ * Check if a given object implements the SfvbPostcardProofResponse interface.
+ */
+function instanceOfSfvbPostcardProofResponse(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbPostcardProofResponse = instanceOfSfvbPostcardProofResponse;
+function SfvbPostcardProofResponseFromJSON(json) {
+    return SfvbPostcardProofResponseFromJSONTyped(json, false);
+}
+exports.SfvbPostcardProofResponseFromJSON = SfvbPostcardProofResponseFromJSON;
+function SfvbPostcardProofResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'back_html': !(0, runtime_1.exists)(json, 'back_html') ? undefined : json['back_html'],
+        'back_image_url': !(0, runtime_1.exists)(json, 'back_image_url') ? undefined : json['back_image_url'],
+        'back_thumbnail_url': !(0, runtime_1.exists)(json, 'back_thumbnail_url') ? undefined : json['back_thumbnail_url'],
+        'front_html': !(0, runtime_1.exists)(json, 'front_html') ? undefined : json['front_html'],
+        'front_image_url': !(0, runtime_1.exists)(json, 'front_image_url') ? undefined : json['front_image_url'],
+        'front_thumbnail_url': !(0, runtime_1.exists)(json, 'front_thumbnail_url') ? undefined : json['front_thumbnail_url'],
+        'order_source': !(0, runtime_1.exists)(json, 'order_source') ? undefined : json['order_source'],
+        'postcard_uuid': !(0, runtime_1.exists)(json, 'postcard_uuid') ? undefined : json['postcard_uuid'],
+        'rendered_pdf_url': !(0, runtime_1.exists)(json, 'rendered_pdf_url') ? undefined : json['rendered_pdf_url'],
+        'vendor_rendered': !(0, runtime_1.exists)(json, 'vendor_rendered') ? undefined : json['vendor_rendered'],
+        'warnings': !(0, runtime_1.exists)(json, 'warnings') ? undefined : (json['warnings'].map(SfvbErrorDetail_1.SfvbErrorDetailFromJSON)),
+    };
+}
+exports.SfvbPostcardProofResponseFromJSONTyped = SfvbPostcardProofResponseFromJSONTyped;
+function SfvbPostcardProofResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'back_html': value.back_html,
+        'back_image_url': value.back_image_url,
+        'back_thumbnail_url': value.back_thumbnail_url,
+        'front_html': value.front_html,
+        'front_image_url': value.front_image_url,
+        'front_thumbnail_url': value.front_thumbnail_url,
+        'order_source': value.order_source,
+        'postcard_uuid': value.postcard_uuid,
+        'rendered_pdf_url': value.rendered_pdf_url,
+        'vendor_rendered': value.vendor_rendered,
+        'warnings': value.warnings === undefined ? undefined : (value.warnings.map(SfvbErrorDetail_1.SfvbErrorDetailToJSON)),
+    };
+}
+exports.SfvbPostcardProofResponseToJSON = SfvbPostcardProofResponseToJSON;

package/dist/models/index.d.ts

@@ -1135,6 +1135,8 @@ export * from './SfvbPageResponse';
 export * from './SfvbPageSelectors';
 export * from './SfvbPageSettingsRequest';
 export * from './SfvbPageSummary';
+export * from './SfvbPostcardProofRequest';
+export * from './SfvbPostcardProofResponse';
 export * from './SfvbPreviewAccessRequest';
 export * from './SfvbPreviewAccessResponse';
 export * from './SfvbPreviewSessionRequest';

package/dist/models/index.js

@@ -1153,6 +1153,8 @@ __exportStar(require("./SfvbPageResponse"), exports);
 __exportStar(require("./SfvbPageSelectors"), exports);
 __exportStar(require("./SfvbPageSettingsRequest"), exports);
 __exportStar(require("./SfvbPageSummary"), exports);
+__exportStar(require("./SfvbPostcardProofRequest"), exports);
+__exportStar(require("./SfvbPostcardProofResponse"), exports);
 __exportStar(require("./SfvbPreviewAccessRequest"), exports);
 __exportStar(require("./SfvbPreviewAccessResponse"), exports);
 __exportStar(require("./SfvbPreviewSessionRequest"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "4.1.220",
+  "version": "4.1.221",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "repository": {

package/src/apis/SfvbApi.ts

@@ -363,6 +363,12 @@ import {
     SfvbPageSettingsRequest,
     SfvbPageSettingsRequestFromJSON,
     SfvbPageSettingsRequestToJSON,
+    SfvbPostcardProofRequest,
+    SfvbPostcardProofRequestFromJSON,
+    SfvbPostcardProofRequestToJSON,
+    SfvbPostcardProofResponse,
+    SfvbPostcardProofResponseFromJSON,
+    SfvbPostcardProofResponseToJSON,
     SfvbPreviewAccessRequest,
     SfvbPreviewAccessRequestFromJSON,
     SfvbPreviewAccessRequestToJSON,
@@ -1327,6 +1333,13 @@ export interface MoveSfvbUpsellPathRequest {
     moveRequest: SfvbUpsellPathMoveRequest;
 }
 
+export interface ProofSfvbSequencePostcardRequest {
+    storefrontOid: number;
+    sequenceUuid: string;
+    stepUuid: string;
+    postcardProofRequest: SfvbPostcardProofRequest;
+}
+
 export interface PublishSfvbLibraryEntryRequest {
     storefrontOid: number;
     libraryOid: number;
@@ -4312,6 +4325,25 @@ export interface SfvbApiInterface {
      */
     moveSfvbUpsellPath(requestParameters: MoveSfvbUpsellPathRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellPath>;
 
+    /**
+     * 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. 
+     * @summary Proof a postcard step without mailing it
+     * @param {number} storefrontOid 
+     * @param {string} sequenceUuid 
+     * @param {string} stepUuid 
+     * @param {SfvbPostcardProofRequest} postcardProofRequest Who the card is addressed to, and the order or cart it shows
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    proofSfvbSequencePostcardRaw(requestParameters: ProofSfvbSequencePostcardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPostcardProofResponse>>;
+
+    /**
+     * 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. 
+     * Proof a postcard step without mailing it
+     */
+    proofSfvbSequencePostcard(requestParameters: ProofSfvbSequencePostcardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPostcardProofResponse>;
+
     /**
      * 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. 
      * @summary Publish a library entry\'s draft
@@ -12561,6 +12593,62 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
         return await response.value();
     }
 
+    /**
+     * 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. 
+     * Proof a postcard step without mailing it
+     */
+    async proofSfvbSequencePostcardRaw(requestParameters: ProofSfvbSequencePostcardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPostcardProofResponse>> {
+        if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+            throw new runtime.RequiredError('storefrontOid','Required parameter requestParameters.storefrontOid was null or undefined when calling proofSfvbSequencePostcard.');
+        }
+
+        if (requestParameters.sequenceUuid === null || requestParameters.sequenceUuid === undefined) {
+            throw new runtime.RequiredError('sequenceUuid','Required parameter requestParameters.sequenceUuid was null or undefined when calling proofSfvbSequencePostcard.');
+        }
+
+        if (requestParameters.stepUuid === null || requestParameters.stepUuid === undefined) {
+            throw new runtime.RequiredError('stepUuid','Required parameter requestParameters.stepUuid was null or undefined when calling proofSfvbSequencePostcard.');
+        }
+
+        if (requestParameters.postcardProofRequest === null || requestParameters.postcardProofRequest === undefined) {
+            throw new runtime.RequiredError('postcardProofRequest','Required parameter requestParameters.postcardProofRequest was null or undefined when calling proofSfvbSequencePostcard.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", []);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const response = await this.request({
+            path: `/sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/postcard_proof`.replace(`{${"storefront_oid"}}`, encodeURIComponent(String(requestParameters.storefrontOid))).replace(`{${"sequence_uuid"}}`, encodeURIComponent(String(requestParameters.sequenceUuid))).replace(`{${"step_uuid"}}`, encodeURIComponent(String(requestParameters.stepUuid))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: SfvbPostcardProofRequestToJSON(requestParameters.postcardProofRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SfvbPostcardProofResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * 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. 
+     * Proof a postcard step without mailing it
+     */
+    async proofSfvbSequencePostcard(requestParameters: ProofSfvbSequencePostcardRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPostcardProofResponse> {
+        const response = await this.proofSfvbSequencePostcardRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * 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. 
      * Publish a library entry\'s draft

package/src/models/SfvbPostcardProofRequest.ts

@@ -0,0 +1,131 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface SfvbPostcardProofRequest
+ */
+export interface SfvbPostcardProofRequest {
+    /**
+     * The recipient street address.  Without address1, city, state and postal_code, a sample address is used.
+     * @type {string}
+     * @memberof SfvbPostcardProofRequest
+     */
+    address1?: string;
+    /**
+     * The recipient second address line.
+     * @type {string}
+     * @memberof SfvbPostcardProofRequest
+     */
+    address2?: string;
+    /**
+     * Item ids for the cart a cart flow card renders with.  The cart is made for the proof and deleted after it.
+     * @type {Array<string>}
+     * @memberof SfvbPostcardProofRequest
+     */
+    cart_item_ids?: Array<string>;
+    /**
+     * The recipient city.
+     * @type {string}
+     * @memberof SfvbPostcardProofRequest
+     */
+    city?: string;
+    /**
+     * The recipient name the card greets and is addressed to.  Defaults to the signed in user.
+     * @type {string}
+     * @memberof SfvbPostcardProofRequest
+     */
+    customer_name?: string;
+    /**
+     * True to return only the rendered HTML of both sides, with no print vendor render.  The default, false, also returns the images that would print and the vendor proof PDF.
+     * @type {boolean}
+     * @memberof SfvbPostcardProofRequest
+     */
+    html_only?: boolean;
+    /**
+     * A test order for an order flow card.  Real orders are refused.  Without one, an order flow card renders with a made up order.
+     * @type {string}
+     * @memberof SfvbPostcardProofRequest
+     */
+    order_id?: string;
+    /**
+     * The recipient postal code.
+     * @type {string}
+     * @memberof SfvbPostcardProofRequest
+     */
+    postal_code?: string;
+    /**
+     * The recipient state.
+     * @type {string}
+     * @memberof SfvbPostcardProofRequest
+     */
+    state?: string;
+}
+
+
+
+/**
+ * Check if a given object implements the SfvbPostcardProofRequest interface.
+ */
+export function instanceOfSfvbPostcardProofRequest(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function SfvbPostcardProofRequestFromJSON(json: any): SfvbPostcardProofRequest {
+    return SfvbPostcardProofRequestFromJSONTyped(json, false);
+}
+
+export function SfvbPostcardProofRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbPostcardProofRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'address1': !exists(json, 'address1') ? undefined : json['address1'],
+        'address2': !exists(json, 'address2') ? undefined : json['address2'],
+        'cart_item_ids': !exists(json, 'cart_item_ids') ? undefined : json['cart_item_ids'],
+        'city': !exists(json, 'city') ? undefined : json['city'],
+        'customer_name': !exists(json, 'customer_name') ? undefined : json['customer_name'],
+        'html_only': !exists(json, 'html_only') ? undefined : json['html_only'],
+        'order_id': !exists(json, 'order_id') ? undefined : json['order_id'],
+        'postal_code': !exists(json, 'postal_code') ? undefined : json['postal_code'],
+        'state': !exists(json, 'state') ? undefined : json['state'],
+    };
+}
+
+export function SfvbPostcardProofRequestToJSON(value?: SfvbPostcardProofRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'address1': value.address1,
+        'address2': value.address2,
+        'cart_item_ids': value.cart_item_ids,
+        'city': value.city,
+        'customer_name': value.customer_name,
+        'html_only': value.html_only,
+        'order_id': value.order_id,
+        'postal_code': value.postal_code,
+        'state': value.state,
+    };
+}
+

package/src/models/SfvbPostcardProofResponse.ts

@@ -0,0 +1,165 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    SfvbErrorDetail,
+    SfvbErrorDetailFromJSON,
+    SfvbErrorDetailFromJSONTyped,
+    SfvbErrorDetailToJSON,
+} from './SfvbErrorDetail';
+
+/**
+ * 
+ * @export
+ * @interface SfvbPostcardProofResponse
+ */
+export interface SfvbPostcardProofResponse {
+    /**
+     * The back as the send renders it, after the name tokens are filled.
+     * @type {string}
+     * @memberof SfvbPostcardProofResponse
+     */
+    back_html?: string;
+    /**
+     * The back as the PNG image the print vendor prints from.  A public url.
+     * @type {string}
+     * @memberof SfvbPostcardProofResponse
+     */
+    back_image_url?: string;
+    /**
+     * The print vendor thumbnail of the back.
+     * @type {string}
+     * @memberof SfvbPostcardProofResponse
+     */
+    back_thumbnail_url?: string;
+    /**
+     * The front as the send renders it, after the name tokens are filled.
+     * @type {string}
+     * @memberof SfvbPostcardProofResponse
+     */
+    front_html?: string;
+    /**
+     * The front as the PNG image the print vendor prints from.  A public url.
+     * @type {string}
+     * @memberof SfvbPostcardProofResponse
+     */
+    front_image_url?: string;
+    /**
+     * The print vendor thumbnail of the front.
+     * @type {string}
+     * @memberof SfvbPostcardProofResponse
+     */
+    front_thumbnail_url?: string;
+    /**
+     * Where the order came from.  test for the order_id given, dummy for a made up one, none for no order.
+     * @type {string}
+     * @memberof SfvbPostcardProofResponse
+     */
+    order_source?: SfvbPostcardProofResponseOrderSourceEnum;
+    /**
+     * The postcard the step mails.
+     * @type {string}
+     * @memberof SfvbPostcardProofResponse
+     */
+    postcard_uuid?: string;
+    /**
+     * The print vendor proof PDF of both sides.
+     * @type {string}
+     * @memberof SfvbPostcardProofResponse
+     */
+    rendered_pdf_url?: string;
+    /**
+     * True when the print vendor rendered the card, so the image and PDF urls are set.
+     * @type {boolean}
+     * @memberof SfvbPostcardProofResponse
+     */
+    vendor_rendered?: boolean;
+    /**
+     * Where the proof differs from a send, such as a placeholder coupon code or a sample address, and anything that would make a send skip the card.
+     * @type {Array<SfvbErrorDetail>}
+     * @memberof SfvbPostcardProofResponse
+     */
+    warnings?: Array<SfvbErrorDetail>;
+}
+
+
+
+/**
+ * @export
+ */
+export const SfvbPostcardProofResponseOrderSourceEnum = {
+    Test: 'test',
+    Dummy: 'dummy',
+    None: 'none'
+} as const;
+export type SfvbPostcardProofResponseOrderSourceEnum = typeof SfvbPostcardProofResponseOrderSourceEnum[keyof typeof SfvbPostcardProofResponseOrderSourceEnum];
+
+
+/**
+ * Check if a given object implements the SfvbPostcardProofResponse interface.
+ */
+export function instanceOfSfvbPostcardProofResponse(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function SfvbPostcardProofResponseFromJSON(json: any): SfvbPostcardProofResponse {
+    return SfvbPostcardProofResponseFromJSONTyped(json, false);
+}
+
+export function SfvbPostcardProofResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbPostcardProofResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'back_html': !exists(json, 'back_html') ? undefined : json['back_html'],
+        'back_image_url': !exists(json, 'back_image_url') ? undefined : json['back_image_url'],
+        'back_thumbnail_url': !exists(json, 'back_thumbnail_url') ? undefined : json['back_thumbnail_url'],
+        'front_html': !exists(json, 'front_html') ? undefined : json['front_html'],
+        'front_image_url': !exists(json, 'front_image_url') ? undefined : json['front_image_url'],
+        'front_thumbnail_url': !exists(json, 'front_thumbnail_url') ? undefined : json['front_thumbnail_url'],
+        'order_source': !exists(json, 'order_source') ? undefined : json['order_source'],
+        'postcard_uuid': !exists(json, 'postcard_uuid') ? undefined : json['postcard_uuid'],
+        'rendered_pdf_url': !exists(json, 'rendered_pdf_url') ? undefined : json['rendered_pdf_url'],
+        'vendor_rendered': !exists(json, 'vendor_rendered') ? undefined : json['vendor_rendered'],
+        'warnings': !exists(json, 'warnings') ? undefined : ((json['warnings'] as Array<any>).map(SfvbErrorDetailFromJSON)),
+    };
+}
+
+export function SfvbPostcardProofResponseToJSON(value?: SfvbPostcardProofResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'back_html': value.back_html,
+        'back_image_url': value.back_image_url,
+        'back_thumbnail_url': value.back_thumbnail_url,
+        'front_html': value.front_html,
+        'front_image_url': value.front_image_url,
+        'front_thumbnail_url': value.front_thumbnail_url,
+        'order_source': value.order_source,
+        'postcard_uuid': value.postcard_uuid,
+        'rendered_pdf_url': value.rendered_pdf_url,
+        'vendor_rendered': value.vendor_rendered,
+        'warnings': value.warnings === undefined ? undefined : ((value.warnings as Array<any>).map(SfvbErrorDetailToJSON)),
+    };
+}
+

package/src/models/index.ts

@@ -1137,6 +1137,8 @@ export * from './SfvbPageResponse';
 export * from './SfvbPageSelectors';
 export * from './SfvbPageSettingsRequest';
 export * from './SfvbPageSummary';
+export * from './SfvbPostcardProofRequest';
+export * from './SfvbPostcardProofResponse';
 export * from './SfvbPreviewAccessRequest';
 export * from './SfvbPreviewAccessResponse';
 export * from './SfvbPreviewSessionRequest';