ultracart_rest_api_v2_typescript 4.1.210 → 4.1.211

package/.openapi-generator/FILES

@@ -1196,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.210
+## 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.210 --save
+npm install ultracart_rest_api_v2_typescript@4.1.211 --save
 ```
 
 ```typescript
@@ -84,6 +84,7 @@ 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 |

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, 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, 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;
@@ -2422,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
@@ -5088,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

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

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;

package/dist/models/SfvbSequenceBranch.js

@@ -0,0 +1,53 @@
+"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.SfvbSequenceBranchToJSON = exports.SfvbSequenceBranchFromJSONTyped = exports.SfvbSequenceBranchFromJSON = exports.instanceOfSfvbSequenceBranch = void 0;
+var runtime_1 = require("../runtime");
+var SfvbSequenceStep_1 = require("./SfvbSequenceStep");
+/**
+ * Check if a given object implements the SfvbSequenceBranch interface.
+ */
+function instanceOfSfvbSequenceBranch(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbSequenceBranch = instanceOfSfvbSequenceBranch;
+function SfvbSequenceBranchFromJSON(json) {
+    return SfvbSequenceBranchFromJSONTyped(json, false);
+}
+exports.SfvbSequenceBranchFromJSON = SfvbSequenceBranchFromJSON;
+function SfvbSequenceBranchFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'label': !(0, runtime_1.exists)(json, 'label') ? undefined : json['label'],
+        'steps': !(0, runtime_1.exists)(json, 'steps') ? undefined : (json['steps'].map(SfvbSequenceStep_1.SfvbSequenceStepFromJSON)),
+    };
+}
+exports.SfvbSequenceBranchFromJSONTyped = SfvbSequenceBranchFromJSONTyped;
+function SfvbSequenceBranchToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'label': value.label,
+        'steps': value.steps === undefined ? undefined : (value.steps.map(SfvbSequenceStep_1.SfvbSequenceStepToJSON)),
+    };
+}
+exports.SfvbSequenceBranchToJSON = SfvbSequenceBranchToJSON;

package/dist/models/SfvbSequenceStep.d.ts

@@ -0,0 +1,128 @@
+/**
+ * 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 { SfvbSequenceBranch } from './SfvbSequenceBranch';
+/**
+ *
+ * @export
+ * @interface SfvbSequenceStep
+ */
+export interface SfvbSequenceStep {
+    /**
+     * Its two sides, for a condition, split or InboxGeek step.  Absent for every other type.
+     * @type {Array<SfvbSequenceBranch>}
+     * @memberof SfvbSequenceStep
+     */
+    branches?: Array<SfvbSequenceBranch>;
+    /**
+     * True when the step's settings could not be read.
+     * @type {boolean}
+     * @memberof SfvbSequenceStep
+     */
+    config_error?: boolean;
+    /**
+     * The step's settings as the admin stores them.  A webhook's header and parameter values are masked.
+     * @type {string}
+     * @memberof SfvbSequenceStep
+     */
+    config_json?: string;
+    /**
+     * A note stored inside the step's settings, when there is one.
+     * @type {string}
+     * @memberof SfvbSequenceStep
+     */
+    config_merchant_notes?: string;
+    /**
+     * True when the step is switched off in its settings.
+     * @type {boolean}
+     * @memberof SfvbSequenceStep
+     */
+    disabled?: boolean;
+    /**
+     * The emails it sends.  One for an email step, one per variant for an experiment.
+     * @type {Array<string>}
+     * @memberof SfvbSequenceStep
+     */
+    email_uuids?: Array<string>;
+    /**
+     * The step's audience filter as stored, when it has one.
+     * @type {string}
+     * @memberof SfvbSequenceStep
+     */
+    filter_profile_equation_json?: string;
+    /**
+     * The items it names, for a cart or rate limiter step.
+     * @type {Array<string>}
+     * @memberof SfvbSequenceStep
+     */
+    item_ids?: Array<string>;
+    /**
+     * The type as the admin names it, such as Time Delay.  The type itself for one it doesn't know.
+     * @type {string}
+     * @memberof SfvbSequenceStep
+     */
+    label?: string;
+    /**
+     * The lists it subscribes or unsubscribes, for a list step.
+     * @type {Array<string>}
+     * @memberof SfvbSequenceStep
+     */
+    list_uuids?: Array<string>;
+    /**
+     * The note stored on the step.
+     * @type {string}
+     * @memberof SfvbSequenceStep
+     */
+    merchant_notes?: string;
+    /**
+     * The step's own display name from its settings, when it has one.
+     * @type {string}
+     * @memberof SfvbSequenceStep
+     */
+    name?: string;
+    /**
+     * How many customers are waiting on this step now.  Only when waiting counts were asked for.
+     * @type {number}
+     * @memberof SfvbSequenceStep
+     */
+    number_waiting?: number;
+    /**
+     * The postcard it sends, for a postcard step.
+     * @type {string}
+     * @memberof SfvbSequenceStep
+     */
+    postcard_uuid?: string;
+    /**
+     * The step uuid.
+     * @type {string}
+     * @memberof SfvbSequenceStep
+     */
+    step_uuid?: string;
+    /**
+     * The step type, such as email, wait, condition or webhook.
+     * @type {string}
+     * @memberof SfvbSequenceStep
+     */
+    type?: string;
+    /**
+     * True for a step no branch leads to.  Listed at the end so nothing is hidden.
+     * @type {boolean}
+     * @memberof SfvbSequenceStep
+     */
+    unreachable?: boolean;
+}
+/**
+ * Check if a given object implements the SfvbSequenceStep interface.
+ */
+export declare function instanceOfSfvbSequenceStep(value: object): boolean;
+export declare function SfvbSequenceStepFromJSON(json: any): SfvbSequenceStep;
+export declare function SfvbSequenceStepFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSequenceStep;
+export declare function SfvbSequenceStepToJSON(value?: SfvbSequenceStep | null): any;

package/dist/models/SfvbSequenceStep.js

@@ -0,0 +1,83 @@
+"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.SfvbSequenceStepToJSON = exports.SfvbSequenceStepFromJSONTyped = exports.SfvbSequenceStepFromJSON = exports.instanceOfSfvbSequenceStep = void 0;
+var runtime_1 = require("../runtime");
+var SfvbSequenceBranch_1 = require("./SfvbSequenceBranch");
+/**
+ * Check if a given object implements the SfvbSequenceStep interface.
+ */
+function instanceOfSfvbSequenceStep(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbSequenceStep = instanceOfSfvbSequenceStep;
+function SfvbSequenceStepFromJSON(json) {
+    return SfvbSequenceStepFromJSONTyped(json, false);
+}
+exports.SfvbSequenceStepFromJSON = SfvbSequenceStepFromJSON;
+function SfvbSequenceStepFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'branches': !(0, runtime_1.exists)(json, 'branches') ? undefined : (json['branches'].map(SfvbSequenceBranch_1.SfvbSequenceBranchFromJSON)),
+        'config_error': !(0, runtime_1.exists)(json, 'config_error') ? undefined : json['config_error'],
+        'config_json': !(0, runtime_1.exists)(json, 'config_json') ? undefined : json['config_json'],
+        'config_merchant_notes': !(0, runtime_1.exists)(json, 'config_merchant_notes') ? undefined : json['config_merchant_notes'],
+        'disabled': !(0, runtime_1.exists)(json, 'disabled') ? undefined : json['disabled'],
+        'email_uuids': !(0, runtime_1.exists)(json, 'email_uuids') ? undefined : json['email_uuids'],
+        'filter_profile_equation_json': !(0, runtime_1.exists)(json, 'filter_profile_equation_json') ? undefined : json['filter_profile_equation_json'],
+        'item_ids': !(0, runtime_1.exists)(json, 'item_ids') ? undefined : json['item_ids'],
+        'label': !(0, runtime_1.exists)(json, 'label') ? undefined : json['label'],
+        'list_uuids': !(0, runtime_1.exists)(json, 'list_uuids') ? undefined : json['list_uuids'],
+        'merchant_notes': !(0, runtime_1.exists)(json, 'merchant_notes') ? undefined : json['merchant_notes'],
+        'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
+        'number_waiting': !(0, runtime_1.exists)(json, 'number_waiting') ? undefined : json['number_waiting'],
+        'postcard_uuid': !(0, runtime_1.exists)(json, 'postcard_uuid') ? undefined : json['postcard_uuid'],
+        'step_uuid': !(0, runtime_1.exists)(json, 'step_uuid') ? undefined : json['step_uuid'],
+        'type': !(0, runtime_1.exists)(json, 'type') ? undefined : json['type'],
+        'unreachable': !(0, runtime_1.exists)(json, 'unreachable') ? undefined : json['unreachable'],
+    };
+}
+exports.SfvbSequenceStepFromJSONTyped = SfvbSequenceStepFromJSONTyped;
+function SfvbSequenceStepToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'branches': value.branches === undefined ? undefined : (value.branches.map(SfvbSequenceBranch_1.SfvbSequenceBranchToJSON)),
+        'config_error': value.config_error,
+        'config_json': value.config_json,
+        'config_merchant_notes': value.config_merchant_notes,
+        'disabled': value.disabled,
+        'email_uuids': value.email_uuids,
+        'filter_profile_equation_json': value.filter_profile_equation_json,
+        'item_ids': value.item_ids,
+        'label': value.label,
+        'list_uuids': value.list_uuids,
+        'merchant_notes': value.merchant_notes,
+        'name': value.name,
+        'number_waiting': value.number_waiting,
+        'postcard_uuid': value.postcard_uuid,
+        'step_uuid': value.step_uuid,
+        'type': value.type,
+        'unreachable': value.unreachable,
+    };
+}
+exports.SfvbSequenceStepToJSON = SfvbSequenceStepToJSON;

package/dist/models/index.d.ts

@@ -1166,6 +1166,9 @@ export * from './SfvbSecretRequest';
 export * from './SfvbSecretRequestCreate';
 export * from './SfvbSecretRequestsResponse';
 export * from './SfvbSecretSink';
+export * from './SfvbSequence';
+export * from './SfvbSequenceBranch';
+export * from './SfvbSequenceStep';
 export * from './SfvbServerLog';
 export * from './SfvbServerLogDetail';
 export * from './SfvbServerLogEntry';

package/dist/models/index.js

@@ -1184,6 +1184,9 @@ __exportStar(require("./SfvbSecretRequest"), exports);
 __exportStar(require("./SfvbSecretRequestCreate"), exports);
 __exportStar(require("./SfvbSecretRequestsResponse"), exports);
 __exportStar(require("./SfvbSecretSink"), exports);
+__exportStar(require("./SfvbSequence"), exports);
+__exportStar(require("./SfvbSequenceBranch"), exports);
+__exportStar(require("./SfvbSequenceStep"), exports);
 __exportStar(require("./SfvbServerLog"), exports);
 __exportStar(require("./SfvbServerLogDetail"), exports);
 __exportStar(require("./SfvbServerLogEntry"), exports);

package/package.json

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

package/src/apis/SfvbApi.ts

@@ -429,6 +429,9 @@ import {
     SfvbSecretRequestsResponse,
     SfvbSecretRequestsResponseFromJSON,
     SfvbSecretRequestsResponseToJSON,
+    SfvbSequence,
+    SfvbSequenceFromJSON,
+    SfvbSequenceToJSON,
     SfvbServerLogDetail,
     SfvbServerLogDetailFromJSON,
     SfvbServerLogDetailToJSON,
@@ -1007,6 +1010,12 @@ export interface GetSfvbSecretRequestRequest {
     requestId: string;
 }
 
+export interface GetSfvbSequenceRequest {
+    storefrontOid: number;
+    sequenceUuid: string;
+    waiting?: boolean;
+}
+
 export interface GetSfvbServerLogRequest {
     storefrontOid: number;
     logId: string;
@@ -3308,6 +3317,24 @@ export interface SfvbApiInterface {
      */
     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
@@ -9776,6 +9803,55 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
         return await response.value();
     }
 
+    /**
+     * 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
+     */
+    async getSfvbSequenceRaw(requestParameters: GetSfvbSequenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequence>> {
+        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.');
+        }
+
+        const queryParameters: any = {};
+
+        if (requestParameters.waiting !== undefined) {
+            queryParameters['waiting'] = requestParameters.waiting;
+        }
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        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}`.replace(`{${"storefront_oid"}}`, encodeURIComponent(String(requestParameters.storefrontOid))).replace(`{${"sequence_uuid"}}`, encodeURIComponent(String(requestParameters.sequenceUuid))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => 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
+     */
+    async getSfvbSequence(requestParameters: GetSfvbSequenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequence> {
+        const response = await this.getSfvbSequenceRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * 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

package/src/models/SfvbSequence.ts

@@ -0,0 +1,138 @@
+/* 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 {
+    SfvbSequenceStep,
+    SfvbSequenceStepFromJSON,
+    SfvbSequenceStepFromJSONTyped,
+    SfvbSequenceStepToJSON,
+} 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 function instanceOfSfvbSequence(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function SfvbSequenceFromJSON(json: any): SfvbSequence {
+    return SfvbSequenceFromJSONTyped(json, false);
+}
+
+export function SfvbSequenceFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSequence {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'communication_sequence_uuid': !exists(json, 'communication_sequence_uuid') ? undefined : json['communication_sequence_uuid'],
+        'live': !exists(json, 'live') ? undefined : json['live'],
+        'notes': !exists(json, 'notes') ? undefined : json['notes'],
+        'owner_name': !exists(json, 'owner_name') ? undefined : json['owner_name'],
+        'owner_status': !exists(json, 'owner_status') ? undefined : json['owner_status'],
+        'owner_type': !exists(json, 'owner_type') ? undefined : json['owner_type'],
+        'owner_uuid': !exists(json, 'owner_uuid') ? undefined : json['owner_uuid'],
+        'steps': !exists(json, 'steps') ? undefined : ((json['steps'] as Array<any>).map(SfvbSequenceStepFromJSON)),
+        'waiting_included': !exists(json, 'waiting_included') ? undefined : json['waiting_included'],
+    };
+}
+
+export function SfvbSequenceToJSON(value?: SfvbSequence | null): any {
+    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 as Array<any>).map(SfvbSequenceStepToJSON)),
+        'waiting_included': value.waiting_included,
+    };
+}
+

package/src/models/SfvbSequenceBranch.ts

@@ -0,0 +1,82 @@
+/* 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 {
+    SfvbSequenceStep,
+    SfvbSequenceStepFromJSON,
+    SfvbSequenceStepFromJSONTyped,
+    SfvbSequenceStepToJSON,
+} 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 function instanceOfSfvbSequenceBranch(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function SfvbSequenceBranchFromJSON(json: any): SfvbSequenceBranch {
+    return SfvbSequenceBranchFromJSONTyped(json, false);
+}
+
+export function SfvbSequenceBranchFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSequenceBranch {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'label': !exists(json, 'label') ? undefined : json['label'],
+        'steps': !exists(json, 'steps') ? undefined : ((json['steps'] as Array<any>).map(SfvbSequenceStepFromJSON)),
+    };
+}
+
+export function SfvbSequenceBranchToJSON(value?: SfvbSequenceBranch | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'label': value.label,
+        'steps': value.steps === undefined ? undefined : ((value.steps as Array<any>).map(SfvbSequenceStepToJSON)),
+    };
+}
+

package/src/models/SfvbSequenceStep.ts

@@ -0,0 +1,202 @@
+/* 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 {
+    SfvbSequenceBranch,
+    SfvbSequenceBranchFromJSON,
+    SfvbSequenceBranchFromJSONTyped,
+    SfvbSequenceBranchToJSON,
+} from './SfvbSequenceBranch';
+
+/**
+ * 
+ * @export
+ * @interface SfvbSequenceStep
+ */
+export interface SfvbSequenceStep {
+    /**
+     * Its two sides, for a condition, split or InboxGeek step.  Absent for every other type.
+     * @type {Array<SfvbSequenceBranch>}
+     * @memberof SfvbSequenceStep
+     */
+    branches?: Array<SfvbSequenceBranch>;
+    /**
+     * True when the step's settings could not be read.
+     * @type {boolean}
+     * @memberof SfvbSequenceStep
+     */
+    config_error?: boolean;
+    /**
+     * The step's settings as the admin stores them.  A webhook's header and parameter values are masked.
+     * @type {string}
+     * @memberof SfvbSequenceStep
+     */
+    config_json?: string;
+    /**
+     * A note stored inside the step's settings, when there is one.
+     * @type {string}
+     * @memberof SfvbSequenceStep
+     */
+    config_merchant_notes?: string;
+    /**
+     * True when the step is switched off in its settings.
+     * @type {boolean}
+     * @memberof SfvbSequenceStep
+     */
+    disabled?: boolean;
+    /**
+     * The emails it sends.  One for an email step, one per variant for an experiment.
+     * @type {Array<string>}
+     * @memberof SfvbSequenceStep
+     */
+    email_uuids?: Array<string>;
+    /**
+     * The step's audience filter as stored, when it has one.
+     * @type {string}
+     * @memberof SfvbSequenceStep
+     */
+    filter_profile_equation_json?: string;
+    /**
+     * The items it names, for a cart or rate limiter step.
+     * @type {Array<string>}
+     * @memberof SfvbSequenceStep
+     */
+    item_ids?: Array<string>;
+    /**
+     * The type as the admin names it, such as Time Delay.  The type itself for one it doesn't know.
+     * @type {string}
+     * @memberof SfvbSequenceStep
+     */
+    label?: string;
+    /**
+     * The lists it subscribes or unsubscribes, for a list step.
+     * @type {Array<string>}
+     * @memberof SfvbSequenceStep
+     */
+    list_uuids?: Array<string>;
+    /**
+     * The note stored on the step.
+     * @type {string}
+     * @memberof SfvbSequenceStep
+     */
+    merchant_notes?: string;
+    /**
+     * The step's own display name from its settings, when it has one.
+     * @type {string}
+     * @memberof SfvbSequenceStep
+     */
+    name?: string;
+    /**
+     * How many customers are waiting on this step now.  Only when waiting counts were asked for.
+     * @type {number}
+     * @memberof SfvbSequenceStep
+     */
+    number_waiting?: number;
+    /**
+     * The postcard it sends, for a postcard step.
+     * @type {string}
+     * @memberof SfvbSequenceStep
+     */
+    postcard_uuid?: string;
+    /**
+     * The step uuid.
+     * @type {string}
+     * @memberof SfvbSequenceStep
+     */
+    step_uuid?: string;
+    /**
+     * The step type, such as email, wait, condition or webhook.
+     * @type {string}
+     * @memberof SfvbSequenceStep
+     */
+    type?: string;
+    /**
+     * True for a step no branch leads to.  Listed at the end so nothing is hidden.
+     * @type {boolean}
+     * @memberof SfvbSequenceStep
+     */
+    unreachable?: boolean;
+}
+
+
+
+/**
+ * Check if a given object implements the SfvbSequenceStep interface.
+ */
+export function instanceOfSfvbSequenceStep(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function SfvbSequenceStepFromJSON(json: any): SfvbSequenceStep {
+    return SfvbSequenceStepFromJSONTyped(json, false);
+}
+
+export function SfvbSequenceStepFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbSequenceStep {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'branches': !exists(json, 'branches') ? undefined : ((json['branches'] as Array<any>).map(SfvbSequenceBranchFromJSON)),
+        'config_error': !exists(json, 'config_error') ? undefined : json['config_error'],
+        'config_json': !exists(json, 'config_json') ? undefined : json['config_json'],
+        'config_merchant_notes': !exists(json, 'config_merchant_notes') ? undefined : json['config_merchant_notes'],
+        'disabled': !exists(json, 'disabled') ? undefined : json['disabled'],
+        'email_uuids': !exists(json, 'email_uuids') ? undefined : json['email_uuids'],
+        'filter_profile_equation_json': !exists(json, 'filter_profile_equation_json') ? undefined : json['filter_profile_equation_json'],
+        'item_ids': !exists(json, 'item_ids') ? undefined : json['item_ids'],
+        'label': !exists(json, 'label') ? undefined : json['label'],
+        'list_uuids': !exists(json, 'list_uuids') ? undefined : json['list_uuids'],
+        'merchant_notes': !exists(json, 'merchant_notes') ? undefined : json['merchant_notes'],
+        'name': !exists(json, 'name') ? undefined : json['name'],
+        'number_waiting': !exists(json, 'number_waiting') ? undefined : json['number_waiting'],
+        'postcard_uuid': !exists(json, 'postcard_uuid') ? undefined : json['postcard_uuid'],
+        'step_uuid': !exists(json, 'step_uuid') ? undefined : json['step_uuid'],
+        'type': !exists(json, 'type') ? undefined : json['type'],
+        'unreachable': !exists(json, 'unreachable') ? undefined : json['unreachable'],
+    };
+}
+
+export function SfvbSequenceStepToJSON(value?: SfvbSequenceStep | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'branches': value.branches === undefined ? undefined : ((value.branches as Array<any>).map(SfvbSequenceBranchToJSON)),
+        'config_error': value.config_error,
+        'config_json': value.config_json,
+        'config_merchant_notes': value.config_merchant_notes,
+        'disabled': value.disabled,
+        'email_uuids': value.email_uuids,
+        'filter_profile_equation_json': value.filter_profile_equation_json,
+        'item_ids': value.item_ids,
+        'label': value.label,
+        'list_uuids': value.list_uuids,
+        'merchant_notes': value.merchant_notes,
+        'name': value.name,
+        'number_waiting': value.number_waiting,
+        'postcard_uuid': value.postcard_uuid,
+        'step_uuid': value.step_uuid,
+        'type': value.type,
+        'unreachable': value.unreachable,
+    };
+}
+

package/src/models/index.ts

@@ -1168,6 +1168,9 @@ export * from './SfvbSecretRequest';
 export * from './SfvbSecretRequestCreate';
 export * from './SfvbSecretRequestsResponse';
 export * from './SfvbSecretSink';
+export * from './SfvbSequence';
+export * from './SfvbSequenceBranch';
+export * from './SfvbSequenceStep';
 export * from './SfvbServerLog';
 export * from './SfvbServerLogDetail';
 export * from './SfvbServerLogEntry';