ultracart_rest_api_v2_typescript 4.1.205 → 4.1.207

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1007,7 +1007,11 @@ src/models/SfvbBlogPostImage.ts
1007
1007
  src/models/SfvbBlogPostImageRequest.ts
1008
1008
  src/models/SfvbBlogPostRequest.ts
1009
1009
  src/models/SfvbBlogPostsResponse.ts
1010
+ src/models/SfvbCampaign.ts
1011
+ src/models/SfvbCampaignsResponse.ts
1010
1012
  src/models/SfvbCommsDnsRecord.ts
1013
+ src/models/SfvbCommsEmail.ts
1014
+ src/models/SfvbCommsPostcard.ts
1011
1015
  src/models/SfvbCommsSendingDomain.ts
1012
1016
  src/models/SfvbCommsSendingDomainsResponse.ts
1013
1017
  src/models/SfvbCommsTwilioAccount.ts
@@ -1049,6 +1053,8 @@ src/models/SfvbFileVersionsResponse.ts
1049
1053
  src/models/SfvbFileWriteRequest.ts
1050
1054
  src/models/SfvbFileWriteResponse.ts
1051
1055
  src/models/SfvbFilesResponse.ts
1056
+ src/models/SfvbFlow.ts
1057
+ src/models/SfvbFlowsResponse.ts
1052
1058
  src/models/SfvbI18nGlossary.ts
1053
1059
  src/models/SfvbI18nGlossaryRequest.ts
1054
1060
  src/models/SfvbI18nLanguage.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.205
2
+ ## ultracart_rest_api_v2_typescript@4.1.207
3
3
 
4
4
  Every API method call has a sample for every language SDK. See https://github.com/UltraCart/sdk_samples
5
5
 
6
6
  Installation
7
7
 
8
8
  ```
9
- npm install ultracart_rest_api_v2_typescript@4.1.205 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.207 --save
10
10
  ```
11
11
 
12
12
  ```typescript
@@ -84,6 +84,8 @@ Not every change is committed to every SDK.
84
84
 
85
85
  | Version | Date | Comments |
86
86
  | --: | :-: | --- |
87
+ | 4.1.207 | 10/16/2026 | sfvb internal testing |
88
+ | 4.1.206 | 10/16/2026 | sfvb internal testing |
87
89
  | 4.1.205 | 10/15/2026 | sfvb internal testing |
88
90
  | 4.1.204 | 10/15/2026 | sfvb internal testing |
89
91
  | 4.1.203 | 10/15/2026 | sfvb internal testing |
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbEmailRenderRequest, SfvbEmailRenderResponse, SfvbEventsAuthRequest, SfvbEventsAuthResponse, SfvbEventsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, 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';
13
+ import { SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCampaign, SfvbCampaignsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbEmailRenderRequest, SfvbEmailRenderResponse, 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';
14
14
  export interface AddSfvbPageBlogPostsRequest {
15
15
  storefrontOid: number;
16
16
  path: string;
@@ -205,6 +205,10 @@ export interface GetSfvbBlogPostRequest {
205
205
  storefrontOid: number;
206
206
  blogPostOid: number;
207
207
  }
208
+ export interface GetSfvbCampaignRequest {
209
+ storefrontOid: number;
210
+ campaignUuid: string;
211
+ }
208
212
  export interface GetSfvbCjsonUsedElementsRequest {
209
213
  compileRequest: SfvbCompileRequest;
210
214
  }
@@ -252,6 +256,10 @@ export interface GetSfvbFileUploadUrlRequest {
252
256
  storefrontOid: number;
253
257
  extension: string;
254
258
  }
259
+ export interface GetSfvbFlowRequest {
260
+ storefrontOid: number;
261
+ flowUuid: string;
262
+ }
255
263
  export interface GetSfvbI18nGlossaryRequest {
256
264
  storefrontOid: number;
257
265
  }
@@ -472,6 +480,13 @@ export interface ListSfvbBlogPostsRequest {
472
480
  page?: number;
473
481
  pageSize?: number;
474
482
  }
483
+ export interface ListSfvbCampaignsRequest {
484
+ storefrontOid: number;
485
+ search?: string;
486
+ page?: number;
487
+ pageSize?: number;
488
+ includeDeleted?: boolean;
489
+ }
475
490
  export interface ListSfvbContainerVersionsRequest {
476
491
  storefrontOid: number;
477
492
  ownerType?: string;
@@ -495,6 +510,13 @@ export interface ListSfvbFilesRequest {
495
510
  themeOid?: number;
496
511
  maxEntries?: number;
497
512
  }
513
+ export interface ListSfvbFlowsRequest {
514
+ storefrontOid: number;
515
+ search?: string;
516
+ page?: number;
517
+ pageSize?: number;
518
+ includeDeleted?: boolean;
519
+ }
498
520
  export interface ListSfvbI18nMessagesRequest {
499
521
  storefrontOid: number;
500
522
  themeOid?: number;
@@ -1544,6 +1566,21 @@ export interface SfvbApiInterface {
1544
1566
  * Read a blog post
1545
1567
  */
1546
1568
  getSfvbBlogPost(requestParameters: GetSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
1569
+ /**
1570
+ * One campaign, the same object as its list entry, with its emails and postcards in step order. A deleted campaign is returned with deleted true.
1571
+ * @summary Get a campaign
1572
+ * @param {number} storefrontOid
1573
+ * @param {string} campaignUuid
1574
+ * @param {*} [options] Override http request option.
1575
+ * @throws {RequiredError}
1576
+ * @memberof SfvbApiInterface
1577
+ */
1578
+ getSfvbCampaignRaw(requestParameters: GetSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
1579
+ /**
1580
+ * One campaign, the same object as its list entry, with its emails and postcards in step order. A deleted campaign is returned with deleted true.
1581
+ * Get a campaign
1582
+ */
1583
+ getSfvbCampaign(requestParameters: GetSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
1547
1584
  /**
1548
1585
  *
1549
1586
  * @summary Element types used by a container
@@ -1737,6 +1774,21 @@ export interface SfvbApiInterface {
1737
1774
  * Get a URL to upload a binary asset to
1738
1775
  */
1739
1776
  getSfvbFileUploadUrl(requestParameters: GetSfvbFileUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileUploadUrlResponse>;
1777
+ /**
1778
+ * One flow, the same object as its list entry, with its emails and postcards in step order. A deleted flow is returned with deleted true.
1779
+ * @summary Get a flow
1780
+ * @param {number} storefrontOid
1781
+ * @param {string} flowUuid
1782
+ * @param {*} [options] Override http request option.
1783
+ * @throws {RequiredError}
1784
+ * @memberof SfvbApiInterface
1785
+ */
1786
+ getSfvbFlowRaw(requestParameters: GetSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
1787
+ /**
1788
+ * One flow, the same object as its list entry, with its emails and postcards in step order. A deleted flow is returned with deleted true.
1789
+ * Get a flow
1790
+ */
1791
+ getSfvbFlow(requestParameters: GetSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
1740
1792
  /**
1741
1793
  * The storefront\'s glossary, plain markdown with terms not to translate, required translations, tone and words to avoid. Read it before translating anything. Empty when none has been saved. Each storefront has its own, because a storefront is often its own brand.
1742
1794
  * @summary Read the storefront\'s translation glossary
@@ -2558,6 +2610,24 @@ export interface SfvbApiInterface {
2558
2610
  * List the storefront\'s blog posts
2559
2611
  */
2560
2612
  listSfvbBlogPosts(requestParameters: ListSfvbBlogPostsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostsResponse>;
2613
+ /**
2614
+ * One page of campaigns, newest first, each with its emails and postcards in step order, without their container JSON. search matches the campaign name. Deleted campaigns are left out unless include_deleted is true. live is true unless the status sends nothing (draft or archived), so a change to one of its emails reaches customers at once.
2615
+ * @summary List the storefront\'s campaigns
2616
+ * @param {number} storefrontOid
2617
+ * @param {string} [search] Text to search for in the name
2618
+ * @param {number} [page] Page number, starting at 1
2619
+ * @param {number} [pageSize] Campaigns per page, 1 to 100, default 50
2620
+ * @param {boolean} [includeDeleted] Include deleted campaigns
2621
+ * @param {*} [options] Override http request option.
2622
+ * @throws {RequiredError}
2623
+ * @memberof SfvbApiInterface
2624
+ */
2625
+ listSfvbCampaignsRaw(requestParameters: ListSfvbCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaignsResponse>>;
2626
+ /**
2627
+ * One page of campaigns, newest first, each with its emails and postcards in step order, without their container JSON. search matches the campaign name. Deleted campaigns are left out unless include_deleted is true. live is true unless the status sends nothing (draft or archived), so a change to one of its emails reaches customers at once.
2628
+ * List the storefront\'s campaigns
2629
+ */
2630
+ listSfvbCampaigns(requestParameters: ListSfvbCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaignsResponse>;
2561
2631
  /**
2562
2632
  * 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.
2563
2633
  * @summary Version history for a container stored outside the file system
@@ -2638,6 +2708,24 @@ export interface SfvbApiInterface {
2638
2708
  * List a storefront directory
2639
2709
  */
2640
2710
  listSfvbFiles(requestParameters: ListSfvbFilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFilesResponse>;
2711
+ /**
2712
+ * One page of flows, newest first, each with its trigger and its emails and postcards in step order, without their container JSON. search matches the flow name. Deleted flows are left out unless include_deleted is true. live is true unless the status sends nothing (draft or inactive); a paused flow still holds enrolled customers, so it counts as live.
2713
+ * @summary List the storefront\'s flows
2714
+ * @param {number} storefrontOid
2715
+ * @param {string} [search] Text to search for in the name
2716
+ * @param {number} [page] Page number, starting at 1
2717
+ * @param {number} [pageSize] Flows per page, 1 to 100, default 50
2718
+ * @param {boolean} [includeDeleted] Include deleted flows
2719
+ * @param {*} [options] Override http request option.
2720
+ * @throws {RequiredError}
2721
+ * @memberof SfvbApiInterface
2722
+ */
2723
+ listSfvbFlowsRaw(requestParameters: ListSfvbFlowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlowsResponse>>;
2724
+ /**
2725
+ * One page of flows, newest first, each with its trigger and its emails and postcards in step order, without their container JSON. search matches the flow name. Deleted flows are left out unless include_deleted is true. live is true unless the status sends nothing (draft or inactive); a paused flow still holds enrolled customers, so it counts as live.
2726
+ * List the storefront\'s flows
2727
+ */
2728
+ listSfvbFlows(requestParameters: ListSfvbFlowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlowsResponse>;
2641
2729
  /**
2642
2730
  * The system text templates render by key, such as checkout labels, for one theme (the active theme unless theme_oid is given). Each message has its English, whether it was edited, and each enabled language\'s text with its source (hand, machine, pending or none). A message appears the first time a page renders it. q matches the key or the English. overridden keeps messages with an edited English or a hand translation. Paged by offset and limit (default 200, at most 500).
2643
2731
  * @summary List built-in messages
@@ -4194,6 +4282,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
4194
4282
  * Read a blog post
4195
4283
  */
4196
4284
  getSfvbBlogPost(requestParameters: GetSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
4285
+ /**
4286
+ * One campaign, the same object as its list entry, with its emails and postcards in step order. A deleted campaign is returned with deleted true.
4287
+ * Get a campaign
4288
+ */
4289
+ getSfvbCampaignRaw(requestParameters: GetSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
4290
+ /**
4291
+ * One campaign, the same object as its list entry, with its emails and postcards in step order. A deleted campaign is returned with deleted true.
4292
+ * Get a campaign
4293
+ */
4294
+ getSfvbCampaign(requestParameters: GetSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
4197
4295
  /**
4198
4296
  * Element types used by a container
4199
4297
  */
@@ -4322,6 +4420,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
4322
4420
  * Get a URL to upload a binary asset to
4323
4421
  */
4324
4422
  getSfvbFileUploadUrl(requestParameters: GetSfvbFileUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileUploadUrlResponse>;
4423
+ /**
4424
+ * One flow, the same object as its list entry, with its emails and postcards in step order. A deleted flow is returned with deleted true.
4425
+ * Get a flow
4426
+ */
4427
+ getSfvbFlowRaw(requestParameters: GetSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
4428
+ /**
4429
+ * One flow, the same object as its list entry, with its emails and postcards in step order. A deleted flow is returned with deleted true.
4430
+ * Get a flow
4431
+ */
4432
+ getSfvbFlow(requestParameters: GetSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
4325
4433
  /**
4326
4434
  * The storefront\'s glossary, plain markdown with terms not to translate, required translations, tone and words to avoid. Read it before translating anything. Empty when none has been saved. Each storefront has its own, because a storefront is often its own brand.
4327
4435
  * Read the storefront\'s translation glossary
@@ -4860,6 +4968,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
4860
4968
  * List the storefront\'s blog posts
4861
4969
  */
4862
4970
  listSfvbBlogPosts(requestParameters: ListSfvbBlogPostsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostsResponse>;
4971
+ /**
4972
+ * One page of campaigns, newest first, each with its emails and postcards in step order, without their container JSON. search matches the campaign name. Deleted campaigns are left out unless include_deleted is true. live is true unless the status sends nothing (draft or archived), so a change to one of its emails reaches customers at once.
4973
+ * List the storefront\'s campaigns
4974
+ */
4975
+ listSfvbCampaignsRaw(requestParameters: ListSfvbCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaignsResponse>>;
4976
+ /**
4977
+ * One page of campaigns, newest first, each with its emails and postcards in step order, without their container JSON. search matches the campaign name. Deleted campaigns are left out unless include_deleted is true. live is true unless the status sends nothing (draft or archived), so a change to one of its emails reaches customers at once.
4978
+ * List the storefront\'s campaigns
4979
+ */
4980
+ listSfvbCampaigns(requestParameters: ListSfvbCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaignsResponse>;
4863
4981
  /**
4864
4982
  * 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.
4865
4983
  * Version history for a container stored outside the file system
@@ -4910,6 +5028,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
4910
5028
  * List a storefront directory
4911
5029
  */
4912
5030
  listSfvbFiles(requestParameters: ListSfvbFilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFilesResponse>;
5031
+ /**
5032
+ * One page of flows, newest first, each with its trigger and its emails and postcards in step order, without their container JSON. search matches the flow name. Deleted flows are left out unless include_deleted is true. live is true unless the status sends nothing (draft or inactive); a paused flow still holds enrolled customers, so it counts as live.
5033
+ * List the storefront\'s flows
5034
+ */
5035
+ listSfvbFlowsRaw(requestParameters: ListSfvbFlowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlowsResponse>>;
5036
+ /**
5037
+ * One page of flows, newest first, each with its trigger and its emails and postcards in step order, without their container JSON. search matches the flow name. Deleted flows are left out unless include_deleted is true. live is true unless the status sends nothing (draft or inactive); a paused flow still holds enrolled customers, so it counts as live.
5038
+ * List the storefront\'s flows
5039
+ */
5040
+ listSfvbFlows(requestParameters: ListSfvbFlowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlowsResponse>;
4913
5041
  /**
4914
5042
  * The system text templates render by key, such as checkout labels, for one theme (the active theme unless theme_oid is given). Each message has its English, whether it was edited, and each enabled language\'s text with its source (hand, machine, pending or none). A message appears the first time a page renders it. q matches the key or the English. overridden keeps messages with an edited English or a hand translation. Paged by offset and limit (default 200, at most 500).
4915
5043
  * List built-in messages
@@ -2901,6 +2901,68 @@ var SfvbApi = /** @class */ (function (_super) {
2901
2901
  });
2902
2902
  });
2903
2903
  };
2904
+ /**
2905
+ * One campaign, the same object as its list entry, with its emails and postcards in step order. A deleted campaign is returned with deleted true.
2906
+ * Get a campaign
2907
+ */
2908
+ SfvbApi.prototype.getSfvbCampaignRaw = function (requestParameters, initOverrides) {
2909
+ return __awaiter(this, void 0, void 0, function () {
2910
+ var queryParameters, headerParameters, _a, _b, response;
2911
+ return __generator(this, function (_c) {
2912
+ switch (_c.label) {
2913
+ case 0:
2914
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
2915
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getSfvbCampaign.');
2916
+ }
2917
+ if (requestParameters.campaignUuid === null || requestParameters.campaignUuid === undefined) {
2918
+ throw new runtime.RequiredError('campaignUuid', 'Required parameter requestParameters.campaignUuid was null or undefined when calling getSfvbCampaign.');
2919
+ }
2920
+ queryParameters = {};
2921
+ headerParameters = {};
2922
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
2923
+ // oauth required
2924
+ _a = headerParameters;
2925
+ _b = "Authorization";
2926
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
2927
+ case 1:
2928
+ // oauth required
2929
+ _a[_b] = _c.sent();
2930
+ _c.label = 2;
2931
+ case 2:
2932
+ if (this.configuration && this.configuration.apiKey) {
2933
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
2934
+ }
2935
+ return [4 /*yield*/, this.request({
2936
+ path: "/sfvb/storefronts/{storefront_oid}/campaigns/{campaign_uuid}".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("campaign_uuid", "}"), encodeURIComponent(String(requestParameters.campaignUuid))),
2937
+ method: 'GET',
2938
+ headers: headerParameters,
2939
+ query: queryParameters,
2940
+ }, initOverrides)];
2941
+ case 3:
2942
+ response = _c.sent();
2943
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbCampaignFromJSON)(jsonValue); })];
2944
+ }
2945
+ });
2946
+ });
2947
+ };
2948
+ /**
2949
+ * One campaign, the same object as its list entry, with its emails and postcards in step order. A deleted campaign is returned with deleted true.
2950
+ * Get a campaign
2951
+ */
2952
+ SfvbApi.prototype.getSfvbCampaign = function (requestParameters, initOverrides) {
2953
+ return __awaiter(this, void 0, void 0, function () {
2954
+ var response;
2955
+ return __generator(this, function (_a) {
2956
+ switch (_a.label) {
2957
+ case 0: return [4 /*yield*/, this.getSfvbCampaignRaw(requestParameters, initOverrides)];
2958
+ case 1:
2959
+ response = _a.sent();
2960
+ return [4 /*yield*/, response.value()];
2961
+ case 2: return [2 /*return*/, _a.sent()];
2962
+ }
2963
+ });
2964
+ });
2965
+ };
2904
2966
  /**
2905
2967
  * Element types used by a container
2906
2968
  */
@@ -3705,6 +3767,68 @@ var SfvbApi = /** @class */ (function (_super) {
3705
3767
  });
3706
3768
  });
3707
3769
  };
3770
+ /**
3771
+ * One flow, the same object as its list entry, with its emails and postcards in step order. A deleted flow is returned with deleted true.
3772
+ * Get a flow
3773
+ */
3774
+ SfvbApi.prototype.getSfvbFlowRaw = function (requestParameters, initOverrides) {
3775
+ return __awaiter(this, void 0, void 0, function () {
3776
+ var queryParameters, headerParameters, _a, _b, response;
3777
+ return __generator(this, function (_c) {
3778
+ switch (_c.label) {
3779
+ case 0:
3780
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
3781
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getSfvbFlow.');
3782
+ }
3783
+ if (requestParameters.flowUuid === null || requestParameters.flowUuid === undefined) {
3784
+ throw new runtime.RequiredError('flowUuid', 'Required parameter requestParameters.flowUuid was null or undefined when calling getSfvbFlow.');
3785
+ }
3786
+ queryParameters = {};
3787
+ headerParameters = {};
3788
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
3789
+ // oauth required
3790
+ _a = headerParameters;
3791
+ _b = "Authorization";
3792
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
3793
+ case 1:
3794
+ // oauth required
3795
+ _a[_b] = _c.sent();
3796
+ _c.label = 2;
3797
+ case 2:
3798
+ if (this.configuration && this.configuration.apiKey) {
3799
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
3800
+ }
3801
+ return [4 /*yield*/, this.request({
3802
+ path: "/sfvb/storefronts/{storefront_oid}/flows/{flow_uuid}".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("flow_uuid", "}"), encodeURIComponent(String(requestParameters.flowUuid))),
3803
+ method: 'GET',
3804
+ headers: headerParameters,
3805
+ query: queryParameters,
3806
+ }, initOverrides)];
3807
+ case 3:
3808
+ response = _c.sent();
3809
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbFlowFromJSON)(jsonValue); })];
3810
+ }
3811
+ });
3812
+ });
3813
+ };
3814
+ /**
3815
+ * One flow, the same object as its list entry, with its emails and postcards in step order. A deleted flow is returned with deleted true.
3816
+ * Get a flow
3817
+ */
3818
+ SfvbApi.prototype.getSfvbFlow = function (requestParameters, initOverrides) {
3819
+ return __awaiter(this, void 0, void 0, function () {
3820
+ var response;
3821
+ return __generator(this, function (_a) {
3822
+ switch (_a.label) {
3823
+ case 0: return [4 /*yield*/, this.getSfvbFlowRaw(requestParameters, initOverrides)];
3824
+ case 1:
3825
+ response = _a.sent();
3826
+ return [4 /*yield*/, response.value()];
3827
+ case 2: return [2 /*return*/, _a.sent()];
3828
+ }
3829
+ });
3830
+ });
3831
+ };
3708
3832
  /**
3709
3833
  * The storefront\'s glossary, plain markdown with terms not to translate, required translations, tone and words to avoid. Read it before translating anything. Empty when none has been saved. Each storefront has its own, because a storefront is often its own brand.
3710
3834
  * Read the storefront\'s translation glossary
@@ -7118,6 +7242,77 @@ var SfvbApi = /** @class */ (function (_super) {
7118
7242
  });
7119
7243
  });
7120
7244
  };
7245
+ /**
7246
+ * One page of campaigns, newest first, each with its emails and postcards in step order, without their container JSON. search matches the campaign name. Deleted campaigns are left out unless include_deleted is true. live is true unless the status sends nothing (draft or archived), so a change to one of its emails reaches customers at once.
7247
+ * List the storefront\'s campaigns
7248
+ */
7249
+ SfvbApi.prototype.listSfvbCampaignsRaw = function (requestParameters, initOverrides) {
7250
+ return __awaiter(this, void 0, void 0, function () {
7251
+ var queryParameters, headerParameters, _a, _b, response;
7252
+ return __generator(this, function (_c) {
7253
+ switch (_c.label) {
7254
+ case 0:
7255
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
7256
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling listSfvbCampaigns.');
7257
+ }
7258
+ queryParameters = {};
7259
+ if (requestParameters.search !== undefined) {
7260
+ queryParameters['search'] = requestParameters.search;
7261
+ }
7262
+ if (requestParameters.page !== undefined) {
7263
+ queryParameters['page'] = requestParameters.page;
7264
+ }
7265
+ if (requestParameters.pageSize !== undefined) {
7266
+ queryParameters['page_size'] = requestParameters.pageSize;
7267
+ }
7268
+ if (requestParameters.includeDeleted !== undefined) {
7269
+ queryParameters['include_deleted'] = requestParameters.includeDeleted;
7270
+ }
7271
+ headerParameters = {};
7272
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
7273
+ // oauth required
7274
+ _a = headerParameters;
7275
+ _b = "Authorization";
7276
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
7277
+ case 1:
7278
+ // oauth required
7279
+ _a[_b] = _c.sent();
7280
+ _c.label = 2;
7281
+ case 2:
7282
+ if (this.configuration && this.configuration.apiKey) {
7283
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
7284
+ }
7285
+ return [4 /*yield*/, this.request({
7286
+ path: "/sfvb/storefronts/{storefront_oid}/campaigns".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
7287
+ method: 'GET',
7288
+ headers: headerParameters,
7289
+ query: queryParameters,
7290
+ }, initOverrides)];
7291
+ case 3:
7292
+ response = _c.sent();
7293
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbCampaignsResponseFromJSON)(jsonValue); })];
7294
+ }
7295
+ });
7296
+ });
7297
+ };
7298
+ /**
7299
+ * One page of campaigns, newest first, each with its emails and postcards in step order, without their container JSON. search matches the campaign name. Deleted campaigns are left out unless include_deleted is true. live is true unless the status sends nothing (draft or archived), so a change to one of its emails reaches customers at once.
7300
+ * List the storefront\'s campaigns
7301
+ */
7302
+ SfvbApi.prototype.listSfvbCampaigns = function (requestParameters, initOverrides) {
7303
+ return __awaiter(this, void 0, void 0, function () {
7304
+ var response;
7305
+ return __generator(this, function (_a) {
7306
+ switch (_a.label) {
7307
+ case 0: return [4 /*yield*/, this.listSfvbCampaignsRaw(requestParameters, initOverrides)];
7308
+ case 1:
7309
+ response = _a.sent();
7310
+ return [4 /*yield*/, response.value()];
7311
+ case 2: return [2 /*return*/, _a.sent()];
7312
+ }
7313
+ });
7314
+ });
7315
+ };
7121
7316
  /**
7122
7317
  * 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.
7123
7318
  * Version history for a container stored outside the file system
@@ -7443,6 +7638,77 @@ var SfvbApi = /** @class */ (function (_super) {
7443
7638
  });
7444
7639
  });
7445
7640
  };
7641
+ /**
7642
+ * One page of flows, newest first, each with its trigger and its emails and postcards in step order, without their container JSON. search matches the flow name. Deleted flows are left out unless include_deleted is true. live is true unless the status sends nothing (draft or inactive); a paused flow still holds enrolled customers, so it counts as live.
7643
+ * List the storefront\'s flows
7644
+ */
7645
+ SfvbApi.prototype.listSfvbFlowsRaw = function (requestParameters, initOverrides) {
7646
+ return __awaiter(this, void 0, void 0, function () {
7647
+ var queryParameters, headerParameters, _a, _b, response;
7648
+ return __generator(this, function (_c) {
7649
+ switch (_c.label) {
7650
+ case 0:
7651
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
7652
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling listSfvbFlows.');
7653
+ }
7654
+ queryParameters = {};
7655
+ if (requestParameters.search !== undefined) {
7656
+ queryParameters['search'] = requestParameters.search;
7657
+ }
7658
+ if (requestParameters.page !== undefined) {
7659
+ queryParameters['page'] = requestParameters.page;
7660
+ }
7661
+ if (requestParameters.pageSize !== undefined) {
7662
+ queryParameters['page_size'] = requestParameters.pageSize;
7663
+ }
7664
+ if (requestParameters.includeDeleted !== undefined) {
7665
+ queryParameters['include_deleted'] = requestParameters.includeDeleted;
7666
+ }
7667
+ headerParameters = {};
7668
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
7669
+ // oauth required
7670
+ _a = headerParameters;
7671
+ _b = "Authorization";
7672
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
7673
+ case 1:
7674
+ // oauth required
7675
+ _a[_b] = _c.sent();
7676
+ _c.label = 2;
7677
+ case 2:
7678
+ if (this.configuration && this.configuration.apiKey) {
7679
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
7680
+ }
7681
+ return [4 /*yield*/, this.request({
7682
+ path: "/sfvb/storefronts/{storefront_oid}/flows".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
7683
+ method: 'GET',
7684
+ headers: headerParameters,
7685
+ query: queryParameters,
7686
+ }, initOverrides)];
7687
+ case 3:
7688
+ response = _c.sent();
7689
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbFlowsResponseFromJSON)(jsonValue); })];
7690
+ }
7691
+ });
7692
+ });
7693
+ };
7694
+ /**
7695
+ * One page of flows, newest first, each with its trigger and its emails and postcards in step order, without their container JSON. search matches the flow name. Deleted flows are left out unless include_deleted is true. live is true unless the status sends nothing (draft or inactive); a paused flow still holds enrolled customers, so it counts as live.
7696
+ * List the storefront\'s flows
7697
+ */
7698
+ SfvbApi.prototype.listSfvbFlows = function (requestParameters, initOverrides) {
7699
+ return __awaiter(this, void 0, void 0, function () {
7700
+ var response;
7701
+ return __generator(this, function (_a) {
7702
+ switch (_a.label) {
7703
+ case 0: return [4 /*yield*/, this.listSfvbFlowsRaw(requestParameters, initOverrides)];
7704
+ case 1:
7705
+ response = _a.sent();
7706
+ return [4 /*yield*/, response.value()];
7707
+ case 2: return [2 /*return*/, _a.sent()];
7708
+ }
7709
+ });
7710
+ });
7711
+ };
7446
7712
  /**
7447
7713
  * The system text templates render by key, such as checkout labels, for one theme (the active theme unless theme_oid is given). Each message has its English, whether it was edited, and each enabled language\'s text with its source (hand, machine, pending or none). A message appears the first time a page renders it. q matches the key or the English. overridden keeps messages with an edited English or a hand translation. Paged by offset and limit (default 200, at most 500).
7448
7714
  * List built-in messages