ultracart_rest_api_v2_typescript 4.1.208 → 4.1.209

package/.openapi-generator/FILES

@@ -1001,6 +1001,7 @@ src/models/SfvbApprovalParams.ts
 src/models/SfvbApprovalReview.ts
 src/models/SfvbApprovalReviewFinding.ts
 src/models/SfvbApprovalsResponse.ts
+src/models/SfvbArchiveRequest.ts
 src/models/SfvbBlogPost.ts
 src/models/SfvbBlogPostDetail.ts
 src/models/SfvbBlogPostImage.ts
@@ -1008,10 +1009,16 @@ src/models/SfvbBlogPostImageRequest.ts
 src/models/SfvbBlogPostRequest.ts
 src/models/SfvbBlogPostsResponse.ts
 src/models/SfvbCampaign.ts
+src/models/SfvbCampaignMembership.ts
+src/models/SfvbCampaignWriteRequest.ts
 src/models/SfvbCampaignsResponse.ts
 src/models/SfvbCommsDnsRecord.ts
 src/models/SfvbCommsEmail.ts
+src/models/SfvbCommsList.ts
+src/models/SfvbCommsListsResponse.ts
 src/models/SfvbCommsPostcard.ts
+src/models/SfvbCommsSegment.ts
+src/models/SfvbCommsSegmentsResponse.ts
 src/models/SfvbCommsSendingDomain.ts
 src/models/SfvbCommsSendingDomainsResponse.ts
 src/models/SfvbCommsTwilioAccount.ts
@@ -1056,6 +1063,8 @@ src/models/SfvbFileWriteRequest.ts
 src/models/SfvbFileWriteResponse.ts
 src/models/SfvbFilesResponse.ts
 src/models/SfvbFlow.ts
+src/models/SfvbFlowStatusRequest.ts
+src/models/SfvbFlowWriteRequest.ts
 src/models/SfvbFlowsResponse.ts
 src/models/SfvbI18nGlossary.ts
 src/models/SfvbI18nGlossaryRequest.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.208
+## ultracart_rest_api_v2_typescript@4.1.209
 
 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.208 --save
+npm install ultracart_rest_api_v2_typescript@4.1.209 --save
 ```
 
 ```typescript
@@ -84,6 +84,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 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 |
 | 4.1.206 | 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, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCampaign, SfvbCampaignsResponse, 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, 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, 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';
 export interface AddSfvbPageBlogPostsRequest {
     storefrontOid: number;
     path: string;
@@ -21,6 +21,18 @@ export interface AddSfvbPageItemsRequest {
     path: string;
     pageItemsAddRequest: SfvbPageItemsAddRequest;
 }
+export interface ArchiveSfvbCampaignRequest {
+    storefrontOid: number;
+    campaignUuid: string;
+    ifMatch: string;
+    archiveRequest: SfvbArchiveRequest;
+}
+export interface ArchiveSfvbFlowRequest {
+    storefrontOid: number;
+    flowUuid: string;
+    ifMatch: string;
+    archiveRequest: SfvbArchiveRequest;
+}
 export interface ArchiveSfvbUpsellPathRequest {
     storefrontOid: number;
     upsellPathOid: number;
@@ -39,9 +51,25 @@ export interface ClearSfvbLibraryScreenshotRequest {
     libraryOid: number;
     ifMatch: string;
 }
+export interface CloneSfvbCampaignRequest {
+    storefrontOid: number;
+    campaignUuid: string;
+}
+export interface CloneSfvbFlowRequest {
+    storefrontOid: number;
+    flowUuid: string;
+}
 export interface CompileSfvbCjsonRequest {
     compileRequest: SfvbCompileRequest;
 }
+export interface CreateSfvbCampaignRequest {
+    storefrontOid: number;
+    campaignWriteRequest: SfvbCampaignWriteRequest;
+}
+export interface CreateSfvbFlowRequest {
+    storefrontOid: number;
+    flowWriteRequest: SfvbFlowWriteRequest;
+}
 export interface CreateSfvbLibraryEntryRequest {
     storefrontOid: number;
     libraryEntry: SfvbLibraryEntryRequest;
@@ -491,6 +519,12 @@ export interface ListSfvbCampaignsRequest {
     pageSize?: number;
     includeDeleted?: boolean;
 }
+export interface ListSfvbCommsListsRequest {
+    storefrontOid: number;
+}
+export interface ListSfvbCommsSegmentsRequest {
+    storefrontOid: number;
+}
 export interface ListSfvbContainerVersionsRequest {
     storefrontOid: number;
     ownerType?: string;
@@ -834,6 +868,12 @@ export interface UpdateSfvbBlogPostRequest {
     blogPostOid: number;
     blogPostRequest: SfvbBlogPostRequest;
 }
+export interface UpdateSfvbCampaignRequest {
+    storefrontOid: number;
+    campaignUuid: string;
+    ifMatch: string;
+    campaignWriteRequest: SfvbCampaignWriteRequest;
+}
 export interface UpdateSfvbCommsSendingDomainRequest {
     domain: string;
     sendingDomain: SfvbCommsSendingDomain;
@@ -847,6 +887,18 @@ export interface UpdateSfvbEmailRequest {
     ifMatch: string;
     emailUpdateRequest: SfvbEmailUpdateRequest;
 }
+export interface UpdateSfvbFlowRequest {
+    storefrontOid: number;
+    flowUuid: string;
+    ifMatch: string;
+    flowWriteRequest: SfvbFlowWriteRequest;
+}
+export interface UpdateSfvbFlowStatusRequest {
+    storefrontOid: number;
+    flowUuid: string;
+    ifMatch: string;
+    flowStatusRequest: SfvbFlowStatusRequest;
+}
 export interface UpdateSfvbItemAttributeBatchRequest {
     storefrontOid: number;
     itemAttributeBatchRequest: SfvbItemAttributeBatchRequest;
@@ -928,6 +980,40 @@ export interface SfvbApiInterface {
      * Assign items to a page
      */
     addSfvbPageItems(requestParameters: AddSfvbPageItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageItemsResponse>;
+    /**
+     * Archiving alone never stops a send, so archiving a scheduled campaign also sets it back to draft, and notes says so.  A campaign whose send is under way is refused with sfvb.campaign_sending.  Send the hash_sha256 you read as If-Match.  A scheduled, sending or sent campaign needs sfvb_publish.
+     * @summary Archive or unarchive a campaign
+     * @param {number} storefrontOid
+     * @param {string} campaignUuid
+     * @param {string} ifMatch hash_sha256 from the last read.  Required; 428 when absent, 412 when stale.
+     * @param {SfvbArchiveRequest} archiveRequest Whether to archive
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    archiveSfvbCampaignRaw(requestParameters: ArchiveSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
+    /**
+     * Archiving alone never stops a send, so archiving a scheduled campaign also sets it back to draft, and notes says so.  A campaign whose send is under way is refused with sfvb.campaign_sending.  Send the hash_sha256 you read as If-Match.  A scheduled, sending or sent campaign needs sfvb_publish.
+     * Archive or unarchive a campaign
+     */
+    archiveSfvbCampaign(requestParameters: ArchiveSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
+    /**
+     * A flow that is still enrolling customers is refused, because archiving would only hide it.  Set its status to inactive first.  Send the hash_sha256 you read as If-Match.
+     * @summary Archive or unarchive a flow
+     * @param {number} storefrontOid
+     * @param {string} flowUuid
+     * @param {string} ifMatch hash_sha256 from the last read.  Required; 428 when absent, 412 when stale.
+     * @param {SfvbArchiveRequest} archiveRequest Whether to archive
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    archiveSfvbFlowRaw(requestParameters: ArchiveSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
+    /**
+     * A flow that is still enrolling customers is refused, because archiving would only hide it.  Set its status to inactive first.  Send the hash_sha256 you read as If-Match.
+     * Archive or unarchive a flow
+     */
+    archiveSfvbFlow(requestParameters: ArchiveSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
     /**
      * Files the path out of the default list.  An archived path does not run.  Archiving one that is switched on is a live change and needs sfvb_publish.
      * @summary Archive an upsell path
@@ -990,6 +1076,36 @@ export interface SfvbApiInterface {
      * Remove a library entry\'s screenshot
      */
     clearSfvbLibraryScreenshot(requestParameters: ClearSfvbLibraryScreenshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
+    /**
+     * A draft copy with copies of its emails and postcards, named Copy of and the original name, never archived and never scheduled.  Steps keep their settings, including a paused rate limiter or an experiment winner, and notes names each one.
+     * @summary Copy a campaign on the same storefront
+     * @param {number} storefrontOid
+     * @param {string} campaignUuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    cloneSfvbCampaignRaw(requestParameters: CloneSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
+    /**
+     * A draft copy with copies of its emails and postcards, named Copy of and the original name, never archived and never scheduled.  Steps keep their settings, including a paused rate limiter or an experiment winner, and notes names each one.
+     * Copy a campaign on the same storefront
+     */
+    cloneSfvbCampaign(requestParameters: CloneSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
+    /**
+     * A draft copy with copies of its emails and postcards, named Copy of and the original name, never archived.  It enrolls nobody until it is turned on.  Steps keep their settings, including a paused rate limiter or an experiment winner, and notes names each one.
+     * @summary Copy a flow on the same storefront
+     * @param {number} storefrontOid
+     * @param {string} flowUuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    cloneSfvbFlowRaw(requestParameters: CloneSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
+    /**
+     * A draft copy with copies of its emails and postcards, named Copy of and the original name, never archived.  It enrolls nobody until it is turned on.  Steps keep their settings, including a paused rate limiter or an experiment winner, and notes names each one.
+     * Copy a flow on the same storefront
+     */
+    cloneSfvbFlow(requestParameters: CloneSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
     /**
      * Compiles a container document to Velocity without storing anything.  Supply theme_oid to compile with the theme\'s inherit groups applied; omit it to compile standalone.
      * @summary Compile CJSON to Velocity
@@ -1004,6 +1120,36 @@ export interface SfvbApiInterface {
      * Compile CJSON to Velocity
      */
     compileSfvbCjson(requestParameters: CompileSfvbCjsonRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCompileResponse>;
+    /**
+     * A new draft campaign with an empty communication sequence.  name is required.  The sender defaults to the storefront\'s marketing sending settings.  Nothing here starts a campaign.
+     * @summary Create a draft campaign
+     * @param {number} storefrontOid
+     * @param {SfvbCampaignWriteRequest} campaignWriteRequest The campaign to create
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    createSfvbCampaignRaw(requestParameters: CreateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
+    /**
+     * A new draft campaign with an empty communication sequence.  name is required.  The sender defaults to the storefront\'s marketing sending settings.  Nothing here starts a campaign.
+     * Create a draft campaign
+     */
+    createSfvbCampaign(requestParameters: CreateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
+    /**
+     * A new draft flow with an empty communication sequence.  name and trigger_type are required.  A list or segment trigger needs trigger_parameter, the uuid of a list or segment on this storefront.  The sender defaults to the storefront\'s marketing sending settings.  A draft flow enrolls nobody until it is turned on.
+     * @summary Create a draft flow
+     * @param {number} storefrontOid
+     * @param {SfvbFlowWriteRequest} flowWriteRequest The flow to create
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    createSfvbFlowRaw(requestParameters: CreateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
+    /**
+     * A new draft flow with an empty communication sequence.  name and trigger_type are required.  A list or segment trigger needs trigger_parameter, the uuid of a list or segment on this storefront.  The sender defaults to the storefront\'s marketing sending settings.  A draft flow enrolls nobody until it is turned on.
+     * Create a draft flow
+     */
+    createSfvbFlow(requestParameters: CreateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
     /**
      * Creates a private draft owned by the calling user.  The fragment is one widget and its children, and it must validate.  Images it references on this storefront are copied into the entry before this returns, so it installs anywhere with its images.  The fragment is scanned; card skimming or obfuscation signals are refused outright.  Nothing other merchants or shoppers see changes, so sfvb_write is enough.  Publish it to share it.  An optional screenshot takes a staged PNG key, exactly as the library screenshot endpoint does; a refused screenshot refuses the whole create.
      * @summary Save a fragment to the library
@@ -2653,6 +2799,34 @@ export interface SfvbApiInterface {
      * List the storefront\'s campaigns
      */
     listSfvbCampaigns(requestParameters: ListSfvbCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaignsResponse>;
+    /**
+     * Each list\'s uuid, name and member count, by name, for a campaign\'s memberships or a list trigger.  Never its members.  Archived lists are left out.
+     * @summary List the storefront\'s email lists
+     * @param {number} storefrontOid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    listSfvbCommsListsRaw(requestParameters: ListSfvbCommsListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsListsResponse>>;
+    /**
+     * Each list\'s uuid, name and member count, by name, for a campaign\'s memberships or a list trigger.  Never its members.  Archived lists are left out.
+     * List the storefront\'s email lists
+     */
+    listSfvbCommsLists(requestParameters: ListSfvbCommsListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsListsResponse>;
+    /**
+     * Each segment\'s uuid, name and member count at its last rebuild, by name, for a campaign\'s memberships or a segment trigger.  Never its members or its rule.  Archived segments are left out.
+     * @summary List the storefront\'s segments
+     * @param {number} storefrontOid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    listSfvbCommsSegmentsRaw(requestParameters: ListSfvbCommsSegmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSegmentsResponse>>;
+    /**
+     * Each segment\'s uuid, name and member count at its last rebuild, by name, for a campaign\'s memberships or a segment trigger.  Never its members or its rule.  Archived segments are left out.
+     * List the storefront\'s segments
+     */
+    listSfvbCommsSegments(requestParameters: ListSfvbCommsSegmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSegmentsResponse>;
     /**
      * Addressed the same way as the container itself, so owner_type also says how owner_object_id is read and itemid lists the history of the item container that merchant item id names.
      * @summary Version history for a container stored outside the file system
@@ -3703,6 +3877,23 @@ export interface SfvbApiInterface {
      * Change a blog post
      */
     updateSfvbBlogPost(requestParameters: UpdateSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
+    /**
+     * A field left out keeps its value; memberships replaces the whole set.  The status is never changed here.  Send the hash_sha256 you read as If-Match.  A scheduled, sending or sent campaign needs sfvb_publish, and a change to a scheduled one applies to the send that is coming.  notes lists any emails a sending domain change put back to needing review.
+     * @summary Change a campaign
+     * @param {number} storefrontOid
+     * @param {string} campaignUuid
+     * @param {string} ifMatch hash_sha256 from the last read.  Required; 428 when absent, 412 when stale.
+     * @param {SfvbCampaignWriteRequest} campaignWriteRequest The fields to change
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    updateSfvbCampaignRaw(requestParameters: UpdateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
+    /**
+     * A field left out keeps its value; memberships replaces the whole set.  The status is never changed here.  Send the hash_sha256 you read as If-Match.  A scheduled, sending or sent campaign needs sfvb_publish, and a change to a scheduled one applies to the send that is coming.  notes lists any emails a sending domain change put back to needing review.
+     * Change a campaign
+     */
+    updateSfvbCampaign(requestParameters: UpdateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
     /**
      * Only a mailgun domain\'s mailgun_api_key can change.  Send it as a secret handle made for the domain to replace it, or as the mask it was read with to keep it.  A new key sets up UltraCart\'s webhooks again with it; if Mailgun refuses, nothing is saved and the handle is given back unused.
      * @summary Update a sending domain
@@ -3749,6 +3940,40 @@ export interface SfvbApiInterface {
      * Change a flow or campaign email\'s subject or preview text
      */
     updateSfvbEmail(requestParameters: UpdateSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail>;
+    /**
+     * A field left out keeps its value.  The trigger and the status are never changed here.  Send the hash_sha256 you read as If-Match.  A flow that is enrolling customers needs sfvb_publish.
+     * @summary Change a flow
+     * @param {number} storefrontOid
+     * @param {string} flowUuid
+     * @param {string} ifMatch hash_sha256 from the last read.  Required; 428 when absent, 412 when stale.
+     * @param {SfvbFlowWriteRequest} flowWriteRequest The fields to change
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    updateSfvbFlowRaw(requestParameters: UpdateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
+    /**
+     * A field left out keeps its value.  The trigger and the status are never changed here.  Send the hash_sha256 you read as If-Match.  A flow that is enrolling customers needs sfvb_publish.
+     * Change a flow
+     */
+    updateSfvbFlow(requestParameters: UpdateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
+    /**
+     * active enrolls customers as they trigger the flow from now on, and they receive its emails.  inactive stops new enrollments.  Always needs sfvb_publish.  Send the hash_sha256 you read as If-Match.
+     * @summary Turn a flow on or off
+     * @param {number} storefrontOid
+     * @param {string} flowUuid
+     * @param {string} ifMatch hash_sha256 from the last read.  Required; 428 when absent, 412 when stale.
+     * @param {SfvbFlowStatusRequest} flowStatusRequest The status to set
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    updateSfvbFlowStatusRaw(requestParameters: UpdateSfvbFlowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
+    /**
+     * active enrolls customers as they trigger the flow from now on, and they receive its emails.  inactive stops new enrollments.  Always needs sfvb_publish.  Send the hash_sha256 you read as If-Match.
+     * Turn a flow on or off
+     */
+    updateSfvbFlowStatus(requestParameters: UpdateSfvbFlowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
     /**
      * Applies exactly the change rows of a dry run, given its plan_hash, each with its merchant_item_oid and current_sha256.  Each item is saved once with all of its rows; a row whose value changed since the dry run is skipped as stale and never overwritten, and an item that cannot be saved does not stop the others.  Only the named attributes change.  Needs sfvb_publish and the approval of the person who signed in the CLI, an approved item.attribute_batch request for exactly these rows in the Approval-Id header.
      * @summary Change attributes across many items in one call
@@ -3904,6 +4129,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Assign items to a page
      */
     addSfvbPageItems(requestParameters: AddSfvbPageItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageItemsResponse>;
+    /**
+     * Archiving alone never stops a send, so archiving a scheduled campaign also sets it back to draft, and notes says so.  A campaign whose send is under way is refused with sfvb.campaign_sending.  Send the hash_sha256 you read as If-Match.  A scheduled, sending or sent campaign needs sfvb_publish.
+     * Archive or unarchive a campaign
+     */
+    archiveSfvbCampaignRaw(requestParameters: ArchiveSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
+    /**
+     * Archiving alone never stops a send, so archiving a scheduled campaign also sets it back to draft, and notes says so.  A campaign whose send is under way is refused with sfvb.campaign_sending.  Send the hash_sha256 you read as If-Match.  A scheduled, sending or sent campaign needs sfvb_publish.
+     * Archive or unarchive a campaign
+     */
+    archiveSfvbCampaign(requestParameters: ArchiveSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
+    /**
+     * A flow that is still enrolling customers is refused, because archiving would only hide it.  Set its status to inactive first.  Send the hash_sha256 you read as If-Match.
+     * Archive or unarchive a flow
+     */
+    archiveSfvbFlowRaw(requestParameters: ArchiveSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
+    /**
+     * A flow that is still enrolling customers is refused, because archiving would only hide it.  Set its status to inactive first.  Send the hash_sha256 you read as If-Match.
+     * Archive or unarchive a flow
+     */
+    archiveSfvbFlow(requestParameters: ArchiveSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
     /**
      * Files the path out of the default list.  An archived path does not run.  Archiving one that is switched on is a live change and needs sfvb_publish.
      * Archive an upsell path
@@ -3944,6 +4189,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Remove a library entry\'s screenshot
      */
     clearSfvbLibraryScreenshot(requestParameters: ClearSfvbLibraryScreenshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
+    /**
+     * A draft copy with copies of its emails and postcards, named Copy of and the original name, never archived and never scheduled.  Steps keep their settings, including a paused rate limiter or an experiment winner, and notes names each one.
+     * Copy a campaign on the same storefront
+     */
+    cloneSfvbCampaignRaw(requestParameters: CloneSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
+    /**
+     * A draft copy with copies of its emails and postcards, named Copy of and the original name, never archived and never scheduled.  Steps keep their settings, including a paused rate limiter or an experiment winner, and notes names each one.
+     * Copy a campaign on the same storefront
+     */
+    cloneSfvbCampaign(requestParameters: CloneSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
+    /**
+     * A draft copy with copies of its emails and postcards, named Copy of and the original name, never archived.  It enrolls nobody until it is turned on.  Steps keep their settings, including a paused rate limiter or an experiment winner, and notes names each one.
+     * Copy a flow on the same storefront
+     */
+    cloneSfvbFlowRaw(requestParameters: CloneSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
+    /**
+     * A draft copy with copies of its emails and postcards, named Copy of and the original name, never archived.  It enrolls nobody until it is turned on.  Steps keep their settings, including a paused rate limiter or an experiment winner, and notes names each one.
+     * Copy a flow on the same storefront
+     */
+    cloneSfvbFlow(requestParameters: CloneSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
     /**
      * Compiles a container document to Velocity without storing anything.  Supply theme_oid to compile with the theme\'s inherit groups applied; omit it to compile standalone.
      * Compile CJSON to Velocity
@@ -3954,6 +4219,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Compile CJSON to Velocity
      */
     compileSfvbCjson(requestParameters: CompileSfvbCjsonRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCompileResponse>;
+    /**
+     * A new draft campaign with an empty communication sequence.  name is required.  The sender defaults to the storefront\'s marketing sending settings.  Nothing here starts a campaign.
+     * Create a draft campaign
+     */
+    createSfvbCampaignRaw(requestParameters: CreateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
+    /**
+     * A new draft campaign with an empty communication sequence.  name is required.  The sender defaults to the storefront\'s marketing sending settings.  Nothing here starts a campaign.
+     * Create a draft campaign
+     */
+    createSfvbCampaign(requestParameters: CreateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
+    /**
+     * A new draft flow with an empty communication sequence.  name and trigger_type are required.  A list or segment trigger needs trigger_parameter, the uuid of a list or segment on this storefront.  The sender defaults to the storefront\'s marketing sending settings.  A draft flow enrolls nobody until it is turned on.
+     * Create a draft flow
+     */
+    createSfvbFlowRaw(requestParameters: CreateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
+    /**
+     * A new draft flow with an empty communication sequence.  name and trigger_type are required.  A list or segment trigger needs trigger_parameter, the uuid of a list or segment on this storefront.  The sender defaults to the storefront\'s marketing sending settings.  A draft flow enrolls nobody until it is turned on.
+     * Create a draft flow
+     */
+    createSfvbFlow(requestParameters: CreateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
     /**
      * Creates a private draft owned by the calling user.  The fragment is one widget and its children, and it must validate.  Images it references on this storefront are copied into the entry before this returns, so it installs anywhere with its images.  The fragment is scanned; card skimming or obfuscation signals are refused outright.  Nothing other merchants or shoppers see changes, so sfvb_write is enough.  Publish it to share it.  An optional screenshot takes a staged PNG key, exactly as the library screenshot endpoint does; a refused screenshot refuses the whole create.
      * Save a fragment to the library
@@ -5030,6 +5315,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * List the storefront\'s campaigns
      */
     listSfvbCampaigns(requestParameters: ListSfvbCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaignsResponse>;
+    /**
+     * Each list\'s uuid, name and member count, by name, for a campaign\'s memberships or a list trigger.  Never its members.  Archived lists are left out.
+     * List the storefront\'s email lists
+     */
+    listSfvbCommsListsRaw(requestParameters: ListSfvbCommsListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsListsResponse>>;
+    /**
+     * Each list\'s uuid, name and member count, by name, for a campaign\'s memberships or a list trigger.  Never its members.  Archived lists are left out.
+     * List the storefront\'s email lists
+     */
+    listSfvbCommsLists(requestParameters: ListSfvbCommsListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsListsResponse>;
+    /**
+     * Each segment\'s uuid, name and member count at its last rebuild, by name, for a campaign\'s memberships or a segment trigger.  Never its members or its rule.  Archived segments are left out.
+     * List the storefront\'s segments
+     */
+    listSfvbCommsSegmentsRaw(requestParameters: ListSfvbCommsSegmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSegmentsResponse>>;
+    /**
+     * Each segment\'s uuid, name and member count at its last rebuild, by name, for a campaign\'s memberships or a segment trigger.  Never its members or its rule.  Archived segments are left out.
+     * List the storefront\'s segments
+     */
+    listSfvbCommsSegments(requestParameters: ListSfvbCommsSegmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSegmentsResponse>;
     /**
      * Addressed the same way as the container itself, so owner_type also says how owner_object_id is read and itemid lists the history of the item container that merchant item id names.
      * Version history for a container stored outside the file system
@@ -5668,6 +5973,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Change a blog post
      */
     updateSfvbBlogPost(requestParameters: UpdateSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
+    /**
+     * A field left out keeps its value; memberships replaces the whole set.  The status is never changed here.  Send the hash_sha256 you read as If-Match.  A scheduled, sending or sent campaign needs sfvb_publish, and a change to a scheduled one applies to the send that is coming.  notes lists any emails a sending domain change put back to needing review.
+     * Change a campaign
+     */
+    updateSfvbCampaignRaw(requestParameters: UpdateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
+    /**
+     * A field left out keeps its value; memberships replaces the whole set.  The status is never changed here.  Send the hash_sha256 you read as If-Match.  A scheduled, sending or sent campaign needs sfvb_publish, and a change to a scheduled one applies to the send that is coming.  notes lists any emails a sending domain change put back to needing review.
+     * Change a campaign
+     */
+    updateSfvbCampaign(requestParameters: UpdateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
     /**
      * Only a mailgun domain\'s mailgun_api_key can change.  Send it as a secret handle made for the domain to replace it, or as the mask it was read with to keep it.  A new key sets up UltraCart\'s webhooks again with it; if Mailgun refuses, nothing is saved and the handle is given back unused.
      * Update a sending domain
@@ -5698,6 +6013,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Change a flow or campaign email\'s subject or preview text
      */
     updateSfvbEmail(requestParameters: UpdateSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail>;
+    /**
+     * A field left out keeps its value.  The trigger and the status are never changed here.  Send the hash_sha256 you read as If-Match.  A flow that is enrolling customers needs sfvb_publish.
+     * Change a flow
+     */
+    updateSfvbFlowRaw(requestParameters: UpdateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
+    /**
+     * A field left out keeps its value.  The trigger and the status are never changed here.  Send the hash_sha256 you read as If-Match.  A flow that is enrolling customers needs sfvb_publish.
+     * Change a flow
+     */
+    updateSfvbFlow(requestParameters: UpdateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
+    /**
+     * active enrolls customers as they trigger the flow from now on, and they receive its emails.  inactive stops new enrollments.  Always needs sfvb_publish.  Send the hash_sha256 you read as If-Match.
+     * Turn a flow on or off
+     */
+    updateSfvbFlowStatusRaw(requestParameters: UpdateSfvbFlowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
+    /**
+     * active enrolls customers as they trigger the flow from now on, and they receive its emails.  inactive stops new enrollments.  Always needs sfvb_publish.  Send the hash_sha256 you read as If-Match.
+     * Turn a flow on or off
+     */
+    updateSfvbFlowStatus(requestParameters: UpdateSfvbFlowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
     /**
      * Applies exactly the change rows of a dry run, given its plan_hash, each with its merchant_item_oid and current_sha256.  Each item is saved once with all of its rows; a row whose value changed since the dry run is skipped as stale and never overwritten, and an item that cannot be saved does not stop the others.  Only the named attributes change.  Needs sfvb_publish and the approval of the person who signed in the CLI, an approved item.attribute_batch request for exactly these rows in the Approval-Id header.
      * Change attributes across many items in one call