ultracart_rest_api_v2_typescript 4.1.209 → 4.1.211

package/.openapi-generator/FILES

@@ -1036,6 +1036,7 @@ src/models/SfvbElementsResponse.ts
 src/models/SfvbEmail.ts
 src/models/SfvbEmailRenderRequest.ts
 src/models/SfvbEmailRenderResponse.ts
+src/models/SfvbEmailReviewRequest.ts
 src/models/SfvbEmailUpdateRequest.ts
 src/models/SfvbErrorDetail.ts
 src/models/SfvbEvent.ts
@@ -1195,6 +1196,9 @@ src/models/SfvbSecretRequest.ts
 src/models/SfvbSecretRequestCreate.ts
 src/models/SfvbSecretRequestsResponse.ts
 src/models/SfvbSecretSink.ts
+src/models/SfvbSequence.ts
+src/models/SfvbSequenceBranch.ts
+src/models/SfvbSequenceStep.ts
 src/models/SfvbServerLog.ts
 src/models/SfvbServerLogDetail.ts
 src/models/SfvbServerLogEntry.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.209
+## ultracart_rest_api_v2_typescript@4.1.211
 
 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.209 --save
+npm install ultracart_rest_api_v2_typescript@4.1.211 --save
 ```
 
 ```typescript
@@ -84,6 +84,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.211 | 10/27/2026 | sfvb internal testing |
+| 4.1.210 | 10/27/2026 | sfvb internal testing |
 | 4.1.209 | 10/27/2026 | sfvb internal testing |
 | 4.1.208 | 10/26/2026 | sfvb internal testing |
 | 4.1.207 | 10/16/2026 | sfvb 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, SfvbCommsListsResponse, SfvbCommsSegmentsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbEmail, SfvbEmailRenderRequest, SfvbEmailRenderResponse, 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, 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, SfvbCommsListsResponse, 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, 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;
@@ -415,6 +415,11 @@ export interface GetSfvbRedirectsRequest {
 export interface GetSfvbSecretRequestRequest {
     requestId: string;
 }
+export interface GetSfvbSequenceRequest {
+    storefrontOid: number;
+    sequenceUuid: string;
+    waiting?: boolean;
+}
 export interface GetSfvbServerLogRequest {
     storefrontOid: number;
     logId: string;
@@ -811,6 +816,11 @@ export interface RevertSfvbFileRequest {
     fileRevertRequest: SfvbFileRevertRequest;
     approvalId?: string;
 }
+export interface ReviewSfvbEmailRequest {
+    storefrontOid: number;
+    emailUuid: string;
+    emailReviewRequest: SfvbEmailReviewRequest;
+}
 export interface RevokeSfvbSecretRequestRequest {
     requestId: string;
 }
@@ -2417,6 +2427,22 @@ export interface SfvbApiInterface {
      * List this sign-in\'s secret requests
      */
     getSfvbSecretRequests(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequestsResponse>;
+    /**
+     * The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order.  Only condition, split and InboxGeek steps branch, and each holds its two sides in branches.  Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter, and the emails, postcard, lists or items it names.  waiting adds how many customers are waiting on each step now.  Read only.
+     * @summary Get a campaign\'s or flow\'s steps as a tree
+     * @param {number} storefrontOid
+     * @param {string} sequenceUuid
+     * @param {boolean} [waiting] Include how many customers are waiting on each step
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    getSfvbSequenceRaw(requestParameters: GetSfvbSequenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequence>>;
+    /**
+     * The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order.  Only condition, split and InboxGeek steps branch, and each holds its two sides in branches.  Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter, and the emails, postcard, lists or items it names.  waiting adds how many customers are waiting on each step now.  Read only.
+     * Get a campaign\'s or flow\'s steps as a tree
+     */
+    getSfvbSequence(requestParameters: GetSfvbSequenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequence>;
     /**
      * One render\'s server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message.  log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session.  min_level is debug, info, warn or error, default debug.
      * @summary Get one storefront render log
@@ -3688,6 +3714,22 @@ export interface SfvbApiInterface {
      * Revert a storefront file to an earlier version
      */
     revertSfvbFile(requestParameters: RevertSfvbFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileWriteResponse>;
+    /**
+     * Starts a review the way the admin\'s Request Review does.  One test copy of the email goes to the signed-in user, and to no one else, and the review runs in the background, so read the email again for pending_review and then the ruling.  Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since.  An email in a flow triggered by an order or an auto order needs order_id, a test order.  Needs a signed-in user, not an API key alone.
+     * @summary Request a content review of a flow or campaign email
+     * @param {number} storefrontOid
+     * @param {string} emailUuid
+     * @param {SfvbEmailReviewRequest} emailReviewRequest The test order, for an email in an order-triggered flow
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    reviewSfvbEmailRaw(requestParameters: ReviewSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEmail>>;
+    /**
+     * Starts a review the way the admin\'s Request Review does.  One test copy of the email goes to the signed-in user, and to no one else, and the review runs in the background, so read the email again for pending_review and then the ruling.  Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since.  An email in a flow triggered by an order or an auto order needs order_id, a test order.  Needs a signed-in user, not an API key alone.
+     * Request a content review of a flow or campaign email
+     */
+    reviewSfvbEmail(requestParameters: ReviewSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail>;
     /**
      * Every handle of the request that no write has used up stops working at once, and its value is deleted.  A handle a write is using right now is left to that write.  Use it when the plan changed, or a handle may have leaked.
      * @summary Revoke a fulfilled request\'s unused handles
@@ -5067,6 +5109,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * List this sign-in\'s secret requests
      */
     getSfvbSecretRequests(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequestsResponse>;
+    /**
+     * The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order.  Only condition, split and InboxGeek steps branch, and each holds its two sides in branches.  Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter, and the emails, postcard, lists or items it names.  waiting adds how many customers are waiting on each step now.  Read only.
+     * Get a campaign\'s or flow\'s steps as a tree
+     */
+    getSfvbSequenceRaw(requestParameters: GetSfvbSequenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequence>>;
+    /**
+     * The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order.  Only condition, split and InboxGeek steps branch, and each holds its two sides in branches.  Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter, and the emails, postcard, lists or items it names.  waiting adds how many customers are waiting on each step now.  Read only.
+     * Get a campaign\'s or flow\'s steps as a tree
+     */
+    getSfvbSequence(requestParameters: GetSfvbSequenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequence>;
     /**
      * One render\'s server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message.  log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session.  min_level is debug, info, warn or error, default debug.
      * Get one storefront render log
@@ -5853,6 +5905,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Revert a storefront file to an earlier version
      */
     revertSfvbFile(requestParameters: RevertSfvbFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileWriteResponse>;
+    /**
+     * Starts a review the way the admin\'s Request Review does.  One test copy of the email goes to the signed-in user, and to no one else, and the review runs in the background, so read the email again for pending_review and then the ruling.  Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since.  An email in a flow triggered by an order or an auto order needs order_id, a test order.  Needs a signed-in user, not an API key alone.
+     * Request a content review of a flow or campaign email
+     */
+    reviewSfvbEmailRaw(requestParameters: ReviewSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEmail>>;
+    /**
+     * Starts a review the way the admin\'s Request Review does.  One test copy of the email goes to the signed-in user, and to no one else, and the review runs in the background, so read the email again for pending_review and then the ruling.  Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since.  An email in a flow triggered by an order or an auto order needs order_id, a test order.  Needs a signed-in user, not an API key alone.
+     * Request a content review of a flow or campaign email
+     */
+    reviewSfvbEmail(requestParameters: ReviewSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail>;
     /**
      * Every handle of the request that no write has used up stops working at once, and its value is deleted.  A handle a write is using right now is left to that write.  Use it when the plan changed, or a handle may have leaked.
      * Revoke a fulfilled request\'s unused handles

package/dist/apis/SfvbApi.js

@@ -6182,6 +6182,71 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order.  Only condition, split and InboxGeek steps branch, and each holds its two sides in branches.  Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter, and the emails, postcard, lists or items it names.  waiting adds how many customers are waiting on each step now.  Read only.
+     * Get a campaign\'s or flow\'s steps as a tree
+     */
+    SfvbApi.prototype.getSfvbSequenceRaw = 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 getSfvbSequence.');
+                        }
+                        if (requestParameters.sequenceUuid === null || requestParameters.sequenceUuid === undefined) {
+                            throw new runtime.RequiredError('sequenceUuid', 'Required parameter requestParameters.sequenceUuid was null or undefined when calling getSfvbSequence.');
+                        }
+                        queryParameters = {};
+                        if (requestParameters.waiting !== undefined) {
+                            queryParameters['waiting'] = requestParameters.waiting;
+                        }
+                        headerParameters = {};
+                        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}".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("sequence_uuid", "}"), encodeURIComponent(String(requestParameters.sequenceUuid))),
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbSequenceFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * The communication sequence named by a campaign\'s or flow\'s communication_sequence_uuid, with its steps from the start in order.  Only condition, split and InboxGeek steps branch, and each holds its two sides in branches.  Each step has its type, the admin\'s label, its settings (a webhook\'s header and parameter values masked), its audience filter, and the emails, postcard, lists or items it names.  waiting adds how many customers are waiting on each step now.  Read only.
+     * Get a campaign\'s or flow\'s steps as a tree
+     */
+    SfvbApi.prototype.getSfvbSequence = 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.getSfvbSequenceRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * One render\'s server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message.  log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session.  min_level is debug, info, warn or error, default debug.
      * Get one storefront render log
@@ -11469,6 +11534,73 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Starts a review the way the admin\'s Request Review does.  One test copy of the email goes to the signed-in user, and to no one else, and the review runs in the background, so read the email again for pending_review and then the ruling.  Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since.  An email in a flow triggered by an order or an auto order needs order_id, a test order.  Needs a signed-in user, not an API key alone.
+     * Request a content review of a flow or campaign email
+     */
+    SfvbApi.prototype.reviewSfvbEmailRaw = 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 reviewSfvbEmail.');
+                        }
+                        if (requestParameters.emailUuid === null || requestParameters.emailUuid === undefined) {
+                            throw new runtime.RequiredError('emailUuid', 'Required parameter requestParameters.emailUuid was null or undefined when calling reviewSfvbEmail.');
+                        }
+                        if (requestParameters.emailReviewRequest === null || requestParameters.emailReviewRequest === undefined) {
+                            throw new runtime.RequiredError('emailReviewRequest', 'Required parameter requestParameters.emailReviewRequest was null or undefined when calling reviewSfvbEmail.');
+                        }
+                        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}/emails/{email_uuid}/review".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("email_uuid", "}"), encodeURIComponent(String(requestParameters.emailUuid))),
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.SfvbEmailReviewRequestToJSON)(requestParameters.emailReviewRequest),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbEmailFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Starts a review the way the admin\'s Request Review does.  One test copy of the email goes to the signed-in user, and to no one else, and the review runs in the background, so read the email again for pending_review and then the ruling.  Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since.  An email in a flow triggered by an order or an auto order needs order_id, a test order.  Needs a signed-in user, not an API key alone.
+     * Request a content review of a flow or campaign email
+     */
+    SfvbApi.prototype.reviewSfvbEmail = 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.reviewSfvbEmailRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Every handle of the request that no write has used up stops working at once, and its value is deleted.  A handle a write is using right now is left to that write.  Use it when the plan changed, or a handle may have leaked.
      * Revoke a fulfilled request\'s unused handles

package/dist/models/SfvbEmail.d.ts

@@ -39,6 +39,12 @@ export interface SfvbEmail {
      * @memberof SfvbEmail
      */
     live?: boolean;
+    /**
+     * What a write did beyond the fields asked for, such as a step label it could not refresh.  Only on a write.
+     * @type {Array<string>}
+     * @memberof SfvbEmail
+     */
+    notes?: Array<string>;
     /**
      * True while a change waits for review.  An edit puts it back to needing review.
      * @type {boolean}

package/dist/models/SfvbEmail.js

@@ -36,6 +36,7 @@ function SfvbEmailFromJSONTyped(json, ignoreDiscriminator) {
         'email_uuid': !(0, runtime_1.exists)(json, 'email_uuid') ? undefined : json['email_uuid'],
         'hash_sha256': !(0, runtime_1.exists)(json, 'hash_sha256') ? undefined : json['hash_sha256'],
         'live': !(0, runtime_1.exists)(json, 'live') ? undefined : json['live'],
+        'notes': !(0, runtime_1.exists)(json, 'notes') ? undefined : json['notes'],
         'pending_review': !(0, runtime_1.exists)(json, 'pending_review') ? undefined : json['pending_review'],
         'preview_text': !(0, runtime_1.exists)(json, 'preview_text') ? undefined : json['preview_text'],
         'rejected': !(0, runtime_1.exists)(json, 'rejected') ? undefined : json['rejected'],
@@ -59,6 +60,7 @@ function SfvbEmailToJSON(value) {
         'email_uuid': value.email_uuid,
         'hash_sha256': value.hash_sha256,
         'live': value.live,
+        'notes': value.notes,
         'pending_review': value.pending_review,
         'preview_text': value.preview_text,
         'rejected': value.rejected,

package/dist/models/SfvbEmailReviewRequest.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 SfvbEmailReviewRequest
+ */
+export interface SfvbEmailReviewRequest {
+    /**
+     * A test order id.  Required for an email in a flow triggered by an order or an auto order, and refused otherwise.
+     * @type {string}
+     * @memberof SfvbEmailReviewRequest
+     */
+    order_id?: string;
+}
+/**
+ * Check if a given object implements the SfvbEmailReviewRequest interface.
+ */
+export declare function instanceOfSfvbEmailReviewRequest(value: object): boolean;
+export declare function SfvbEmailReviewRequestFromJSON(json: any): SfvbEmailReviewRequest;
+export declare function SfvbEmailReviewRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbEmailReviewRequest;
+export declare function SfvbEmailReviewRequestToJSON(value?: SfvbEmailReviewRequest | null): any;

package/dist/models/SfvbEmailReviewRequest.js

@@ -0,0 +1,50 @@
+"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.SfvbEmailReviewRequestToJSON = exports.SfvbEmailReviewRequestFromJSONTyped = exports.SfvbEmailReviewRequestFromJSON = exports.instanceOfSfvbEmailReviewRequest = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the SfvbEmailReviewRequest interface.
+ */
+function instanceOfSfvbEmailReviewRequest(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbEmailReviewRequest = instanceOfSfvbEmailReviewRequest;
+function SfvbEmailReviewRequestFromJSON(json) {
+    return SfvbEmailReviewRequestFromJSONTyped(json, false);
+}
+exports.SfvbEmailReviewRequestFromJSON = SfvbEmailReviewRequestFromJSON;
+function SfvbEmailReviewRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'order_id': !(0, runtime_1.exists)(json, 'order_id') ? undefined : json['order_id'],
+    };
+}
+exports.SfvbEmailReviewRequestFromJSONTyped = SfvbEmailReviewRequestFromJSONTyped;
+function SfvbEmailReviewRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'order_id': value.order_id,
+    };
+}
+exports.SfvbEmailReviewRequestToJSON = SfvbEmailReviewRequestToJSON;

package/dist/models/SfvbSequence.d.ts

@@ -0,0 +1,80 @@
+/**
+ * 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 { SfvbSequenceStep } from './SfvbSequenceStep';
+/**
+ *
+ * @export
+ * @interface SfvbSequence
+ */
+export interface SfvbSequence {
+    /**
+     * The sequence uuid.
+     * @type {string}
+     * @memberof SfvbSequence
+     */
+    communication_sequence_uuid?: string;
+    /**
+     * True when its emails and postcards reach customers now.
+     * @type {boolean}
+     * @memberof SfvbSequence
+     */
+    live?: boolean;
+    /**
+     * Anything the read could not do, such as waiting counts that were unavailable.
+     * @type {Array<string>}
+     * @memberof SfvbSequence
+     */
+    notes?: Array<string>;
+    /**
+     * The campaign or flow name.
+     * @type {string}
+     * @memberof SfvbSequence
+     */
+    owner_name?: string;
+    /**
+     * The campaign or flow status.
+     * @type {string}
+     * @memberof SfvbSequence
+     */
+    owner_status?: string;
+    /**
+     * campaign or flow.
+     * @type {string}
+     * @memberof SfvbSequence
+     */
+    owner_type?: string;
+    /**
+     * The campaign or flow uuid.
+     * @type {string}
+     * @memberof SfvbSequence
+     */
+    owner_uuid?: string;
+    /**
+     * The steps from the start, in order.  A branching step holds its sides in branches.
+     * @type {Array<SfvbSequenceStep>}
+     * @memberof SfvbSequence
+     */
+    steps?: Array<SfvbSequenceStep>;
+    /**
+     * True when number_waiting was filled in.
+     * @type {boolean}
+     * @memberof SfvbSequence
+     */
+    waiting_included?: boolean;
+}
+/**
+ * Check if a given object implements the SfvbSequence interface.
+ */
+export declare function instanceOfSfvbSequence(value: object): boolean;
+export declare function SfvbSequenceFromJSON(json: any): SfvbSequence;
+export declare function SfvbSequenceFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSequence;
+export declare function SfvbSequenceToJSON(value?: SfvbSequence | null): any;

package/dist/models/SfvbSequence.js

@@ -0,0 +1,67 @@
+"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.SfvbSequenceToJSON = exports.SfvbSequenceFromJSONTyped = exports.SfvbSequenceFromJSON = exports.instanceOfSfvbSequence = void 0;
+var runtime_1 = require("../runtime");
+var SfvbSequenceStep_1 = require("./SfvbSequenceStep");
+/**
+ * Check if a given object implements the SfvbSequence interface.
+ */
+function instanceOfSfvbSequence(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbSequence = instanceOfSfvbSequence;
+function SfvbSequenceFromJSON(json) {
+    return SfvbSequenceFromJSONTyped(json, false);
+}
+exports.SfvbSequenceFromJSON = SfvbSequenceFromJSON;
+function SfvbSequenceFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'communication_sequence_uuid': !(0, runtime_1.exists)(json, 'communication_sequence_uuid') ? undefined : json['communication_sequence_uuid'],
+        'live': !(0, runtime_1.exists)(json, 'live') ? undefined : json['live'],
+        'notes': !(0, runtime_1.exists)(json, 'notes') ? undefined : json['notes'],
+        'owner_name': !(0, runtime_1.exists)(json, 'owner_name') ? undefined : json['owner_name'],
+        'owner_status': !(0, runtime_1.exists)(json, 'owner_status') ? undefined : json['owner_status'],
+        'owner_type': !(0, runtime_1.exists)(json, 'owner_type') ? undefined : json['owner_type'],
+        'owner_uuid': !(0, runtime_1.exists)(json, 'owner_uuid') ? undefined : json['owner_uuid'],
+        'steps': !(0, runtime_1.exists)(json, 'steps') ? undefined : (json['steps'].map(SfvbSequenceStep_1.SfvbSequenceStepFromJSON)),
+        'waiting_included': !(0, runtime_1.exists)(json, 'waiting_included') ? undefined : json['waiting_included'],
+    };
+}
+exports.SfvbSequenceFromJSONTyped = SfvbSequenceFromJSONTyped;
+function SfvbSequenceToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'communication_sequence_uuid': value.communication_sequence_uuid,
+        'live': value.live,
+        'notes': value.notes,
+        'owner_name': value.owner_name,
+        'owner_status': value.owner_status,
+        'owner_type': value.owner_type,
+        'owner_uuid': value.owner_uuid,
+        'steps': value.steps === undefined ? undefined : (value.steps.map(SfvbSequenceStep_1.SfvbSequenceStepToJSON)),
+        'waiting_included': value.waiting_included,
+    };
+}
+exports.SfvbSequenceToJSON = SfvbSequenceToJSON;

package/dist/models/SfvbSequenceBranch.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 { SfvbSequenceStep } from './SfvbSequenceStep';
+/**
+ *
+ * @export
+ * @interface SfvbSequenceBranch
+ */
+export interface SfvbSequenceBranch {
+    /**
+     * yes or no for a condition, left or right for a split or an InboxGeek step.
+     * @type {string}
+     * @memberof SfvbSequenceBranch
+     */
+    label?: string;
+    /**
+     * The steps on this side, in order.
+     * @type {Array<SfvbSequenceStep>}
+     * @memberof SfvbSequenceBranch
+     */
+    steps?: Array<SfvbSequenceStep>;
+}
+/**
+ * Check if a given object implements the SfvbSequenceBranch interface.
+ */
+export declare function instanceOfSfvbSequenceBranch(value: object): boolean;
+export declare function SfvbSequenceBranchFromJSON(json: any): SfvbSequenceBranch;
+export declare function SfvbSequenceBranchFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSequenceBranch;
+export declare function SfvbSequenceBranchToJSON(value?: SfvbSequenceBranch | null): any;