ultracart_rest_api_v2_typescript 4.1.218 → 4.1.220

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.
Files changed (36) hide show
  1. package/.openapi-generator/FILES +4 -0
  2. package/README.md +4 -2
  3. package/dist/apis/SfvbApi.d.ts +82 -14
  4. package/dist/apis/SfvbApi.js +150 -6
  5. package/dist/apis/StorefrontApi.d.ts +4 -1
  6. package/dist/apis/StorefrontApi.js +2 -0
  7. package/dist/models/ItemPaymentProcessing.d.ts +6 -0
  8. package/dist/models/ItemPaymentProcessing.js +2 -0
  9. package/dist/models/SfvbApprovalParams.d.ts +20 -2
  10. package/dist/models/SfvbApprovalParams.js +6 -0
  11. package/dist/models/SfvbCodeLibraryEmail.d.ts +61 -0
  12. package/dist/models/SfvbCodeLibraryEmail.js +60 -0
  13. package/dist/models/SfvbCodeLibraryEmailsResponse.d.ts +38 -0
  14. package/dist/models/SfvbCodeLibraryEmailsResponse.js +53 -0
  15. package/dist/models/SfvbSequenceStepCreateRequest.d.ts +27 -3
  16. package/dist/models/SfvbSequenceStepCreateRequest.js +8 -0
  17. package/dist/models/SfvbSequenceStepCreateResponse.d.ts +42 -0
  18. package/dist/models/SfvbSequenceStepCreateResponse.js +14 -0
  19. package/dist/models/SfvbSequenceStepMoveRequest.d.ts +49 -0
  20. package/dist/models/SfvbSequenceStepMoveRequest.js +56 -0
  21. package/dist/models/SfvbSequenceStepMoveResponse.d.ts +38 -0
  22. package/dist/models/SfvbSequenceStepMoveResponse.js +53 -0
  23. package/dist/models/index.d.ts +4 -0
  24. package/dist/models/index.js +4 -0
  25. package/package.json +1 -1
  26. package/src/apis/SfvbApi.ts +193 -13
  27. package/src/apis/StorefrontApi.ts +4 -1
  28. package/src/models/ItemPaymentProcessing.ts +8 -0
  29. package/src/models/SfvbApprovalParams.ts +26 -2
  30. package/src/models/SfvbCodeLibraryEmail.ts +107 -0
  31. package/src/models/SfvbCodeLibraryEmailsResponse.ts +82 -0
  32. package/src/models/SfvbSequenceStepCreateRequest.ts +35 -3
  33. package/src/models/SfvbSequenceStepCreateResponse.ts +56 -0
  34. package/src/models/SfvbSequenceStepMoveRequest.ts +91 -0
  35. package/src/models/SfvbSequenceStepMoveResponse.ts +82 -0
  36. package/src/models/index.ts +4 -0
@@ -1012,6 +1012,8 @@ src/models/SfvbCampaign.ts
1012
1012
  src/models/SfvbCampaignMembership.ts
1013
1013
  src/models/SfvbCampaignWriteRequest.ts
1014
1014
  src/models/SfvbCampaignsResponse.ts
1015
+ src/models/SfvbCodeLibraryEmail.ts
1016
+ src/models/SfvbCodeLibraryEmailsResponse.ts
1015
1017
  src/models/SfvbCommsDnsRecord.ts
1016
1018
  src/models/SfvbCommsEmail.ts
1017
1019
  src/models/SfvbCommsList.ts
@@ -1207,6 +1209,8 @@ src/models/SfvbSequenceStep.ts
1207
1209
  src/models/SfvbSequenceStepCreateRequest.ts
1208
1210
  src/models/SfvbSequenceStepCreateResponse.ts
1209
1211
  src/models/SfvbSequenceStepDeleteResponse.ts
1212
+ src/models/SfvbSequenceStepMoveRequest.ts
1213
+ src/models/SfvbSequenceStepMoveResponse.ts
1210
1214
  src/models/SfvbSequenceStepUpdateRequest.ts
1211
1215
  src/models/SfvbSequenceStepUpdateResponse.ts
1212
1216
  src/models/SfvbServerLog.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.218
2
+ ## ultracart_rest_api_v2_typescript@4.1.220
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.218 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.220 --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.220 | 11/02/2026 | sfvb internal testing |
88
+ | 4.1.219 | 10/30/2026 | item - field for hsa/fsa eligibility |
87
89
  | 4.1.218 | 10/30/2026 | svfb internal testing |
88
90
  | 4.1.217 | 10/29/2026 | sfvb internal testing |
89
91
  | 4.1.216 | 10/29/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, SfvbArchiveRequest, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCampaign, SfvbCampaignWriteRequest, SfvbCampaignsResponse, SfvbCommsListsResponse, SfvbCommsSegmentResponse, SfvbCommsSegmentWriteRequest, SfvbCommsSegmentsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbEmail, SfvbEmailRenderRequest, SfvbEmailRenderResponse, SfvbEmailReviewRequest, SfvbEmailUpdateRequest, SfvbEventsAuthRequest, SfvbEventsAuthResponse, SfvbEventsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbFlow, SfvbFlowStatusRequest, SfvbFlowWriteRequest, SfvbFlowsResponse, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeBatchRequest, SfvbItemAttributeBatchResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaDescriptionRequest, SfvbItemMultimediaRequest, SfvbItemPricing, SfvbItemPricingRequest, SfvbItemRelated, SfvbItemRelatedRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbNotFoundEntry, SfvbNotFoundEntryResponse, SfvbNotFoundPage, SfvbNotFoundResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbSequence, SfvbSequenceStepCreateRequest, SfvbSequenceStepCreateResponse, SfvbSequenceStepDeleteResponse, SfvbSequenceStepUpdateRequest, SfvbSequenceStepUpdateResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
13
+ import { SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbArchiveRequest, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCampaign, SfvbCampaignWriteRequest, SfvbCampaignsResponse, SfvbCodeLibraryEmailsResponse, SfvbCommsListsResponse, SfvbCommsSegmentResponse, SfvbCommsSegmentWriteRequest, SfvbCommsSegmentsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbEmail, SfvbEmailRenderRequest, SfvbEmailRenderResponse, SfvbEmailReviewRequest, SfvbEmailUpdateRequest, SfvbEventsAuthRequest, SfvbEventsAuthResponse, SfvbEventsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbFlow, SfvbFlowStatusRequest, SfvbFlowWriteRequest, SfvbFlowsResponse, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeBatchRequest, SfvbItemAttributeBatchResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaDescriptionRequest, SfvbItemMultimediaRequest, SfvbItemPricing, SfvbItemPricingRequest, SfvbItemRelated, SfvbItemRelatedRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbNotFoundEntry, SfvbNotFoundEntryResponse, SfvbNotFoundPage, SfvbNotFoundResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbSequence, SfvbSequenceStepCreateRequest, SfvbSequenceStepCreateResponse, SfvbSequenceStepDeleteResponse, SfvbSequenceStepMoveRequest, SfvbSequenceStepMoveResponse, SfvbSequenceStepUpdateRequest, SfvbSequenceStepUpdateResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
14
14
  export interface AddSfvbPageBlogPostsRequest {
15
15
  storefrontOid: number;
16
16
  path: string;
@@ -545,6 +545,10 @@ export interface ListSfvbCampaignsRequest {
545
545
  pageSize?: number;
546
546
  includeDeleted?: boolean;
547
547
  }
548
+ export interface ListSfvbCodeLibraryEmailsRequest {
549
+ storefrontOid: number;
550
+ search?: string;
551
+ }
548
552
  export interface ListSfvbCommsListsRequest {
549
553
  storefrontOid: number;
550
554
  }
@@ -638,6 +642,14 @@ export interface ListSfvbUpsellPathsRequest {
638
642
  maxResults?: number;
639
643
  offset?: number;
640
644
  }
645
+ export interface MoveSfvbSequenceStepRequest {
646
+ storefrontOid: number;
647
+ sequenceUuid: string;
648
+ stepUuid: string;
649
+ ifMatch: string;
650
+ sequenceStepMoveRequest: SfvbSequenceStepMoveRequest;
651
+ approvalId?: string;
652
+ }
641
653
  export interface MoveSfvbUpsellPathRequest {
642
654
  storefrontOid: number;
643
655
  upsellPathOid: number;
@@ -960,6 +972,7 @@ export interface UpdateSfvbSequenceStepRequest {
960
972
  stepUuid: string;
961
973
  ifMatch: string;
962
974
  sequenceStepUpdateRequest: SfvbSequenceStepUpdateRequest;
975
+ approvalId?: string;
963
976
  }
964
977
  export interface UpdateSfvbUpsellOfferRequest {
965
978
  storefrontOid: number;
@@ -2828,20 +2841,20 @@ export interface SfvbApiInterface {
2828
2841
  */
2829
2842
  insertSfvbSecretRequest(requestParameters: InsertSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequest>;
2830
2843
  /**
2831
- * Creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. It goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the email, as the admin\'s editor adds them. The email has no body yet, and gets the content review flags the admin gives a new email here. A sequence whose campaign or flow is live needs sfvb_publish.
2832
- * @summary Add an email step, with its new email
2844
+ * type email (the default) creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. The email has no body yet, and gets the content review flags the admin gives a new email here. With library_item_oid the email starts from a code library email item instead (listSfvbCodeLibraryEmails): its body with new element ids, and its subject and preview text where the request gives none. The item must be this account\'s own, shared with it, or published, approved by UltraCart and free; it must pass the library content scanner and the email container rules, and executable elements need acknowledge_executable true. Its PNG, JPEG and GIF image files are copied into the storefront first, never over an existing file; any other file is skipped and listed. type wait adds a wait step with config_json as its settings: delay_duration and delay_duration_unit (minutes, hours, days, weeks or months), or a delay_until option; a wait that would pass customers on at once is refused. type post_card creates a new postcard with the admin\'s default front and back and adds the postcard step that mails it, together; the step starts disabled, so nothing is printed or mailed until it is turned on with set-config, and the response names the front and back containers. Any goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the new step, as the admin\'s editor adds them. A sequence whose campaign or flow is live needs sfvb_publish.
2845
+ * @summary Add an email step, with its new email, a wait step, or a postcard step, with its new postcard
2833
2846
  * @param {number} storefrontOid
2834
2847
  * @param {string} sequenceUuid
2835
2848
  * @param {string} ifMatch The hash_sha256 of the step it goes after, or of the branching step, or * for the first step of a sequence with no steps. Required; 428 when absent, 412 when stale.
2836
- * @param {SfvbSequenceStepCreateRequest} sequenceStepCreateRequest Where the step goes, and the new email\&#39;s subject and preview text
2849
+ * @param {SfvbSequenceStepCreateRequest} sequenceStepCreateRequest Where the step goes, and the new email\&#39;s subject and preview text or code library item, the wait\&#39;s config_json, or the postcard step\&#39;s name
2837
2850
  * @param {*} [options] Override http request option.
2838
2851
  * @throws {RequiredError}
2839
2852
  * @memberof SfvbApiInterface
2840
2853
  */
2841
2854
  insertSfvbSequenceStepRaw(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepCreateResponse>>;
2842
2855
  /**
2843
- * Creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. It goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the email, as the admin\'s editor adds them. The email has no body yet, and gets the content review flags the admin gives a new email here. A sequence whose campaign or flow is live needs sfvb_publish.
2844
- * Add an email step, with its new email
2856
+ * type email (the default) creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. The email has no body yet, and gets the content review flags the admin gives a new email here. With library_item_oid the email starts from a code library email item instead (listSfvbCodeLibraryEmails): its body with new element ids, and its subject and preview text where the request gives none. The item must be this account\'s own, shared with it, or published, approved by UltraCart and free; it must pass the library content scanner and the email container rules, and executable elements need acknowledge_executable true. Its PNG, JPEG and GIF image files are copied into the storefront first, never over an existing file; any other file is skipped and listed. type wait adds a wait step with config_json as its settings: delay_duration and delay_duration_unit (minutes, hours, days, weeks or months), or a delay_until option; a wait that would pass customers on at once is refused. type post_card creates a new postcard with the admin\'s default front and back and adds the postcard step that mails it, together; the step starts disabled, so nothing is printed or mailed until it is turned on with set-config, and the response names the front and back containers. Any goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the new step, as the admin\'s editor adds them. A sequence whose campaign or flow is live needs sfvb_publish.
2857
+ * Add an email step, with its new email, a wait step, or a postcard step, with its new postcard
2845
2858
  */
2846
2859
  insertSfvbSequenceStep(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepCreateResponse>;
2847
2860
  /**
@@ -2925,6 +2938,21 @@ export interface SfvbApiInterface {
2925
2938
  * List the storefront\'s campaigns
2926
2939
  */
2927
2940
  listSfvbCampaigns(requestParameters: ListSfvbCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaignsResponse>;
2941
+ /**
2942
+ * The code library is the one the admin\'s \"start from library\" uses; it isn\'t the Visual Builder element library. Lists the email items this account may use, by title: its own (source owned), those shared with it (shared), and those published for everyone, approved by UltraCart and free (public). search matches part of the title, with case. Each kind is capped at 100 items, and truncated says when there were more. Send an item\'s library_item_oid on the step insert to start a new email from it.
2943
+ * @summary Email items from the code library that can start a new email step
2944
+ * @param {number} storefrontOid
2945
+ * @param {string} [search] Part of the title to match, with case. Up to 100 characters.
2946
+ * @param {*} [options] Override http request option.
2947
+ * @throws {RequiredError}
2948
+ * @memberof SfvbApiInterface
2949
+ */
2950
+ listSfvbCodeLibraryEmailsRaw(requestParameters: ListSfvbCodeLibraryEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCodeLibraryEmailsResponse>>;
2951
+ /**
2952
+ * The code library is the one the admin\'s \"start from library\" uses; it isn\'t the Visual Builder element library. Lists the email items this account may use, by title: its own (source owned), those shared with it (shared), and those published for everyone, approved by UltraCart and free (public). search matches part of the title, with case. Each kind is capped at 100 items, and truncated says when there were more. Send an item\'s library_item_oid on the step insert to start a new email from it.
2953
+ * Email items from the code library that can start a new email step
2954
+ */
2955
+ listSfvbCodeLibraryEmails(requestParameters: ListSfvbCodeLibraryEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCodeLibraryEmailsResponse>;
2928
2956
  /**
2929
2957
  * 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.
2930
2958
  * @summary List the storefront\'s email lists
@@ -3219,6 +3247,25 @@ export interface SfvbApiInterface {
3219
3247
  * List upsell paths
3220
3248
  */
3221
3249
  listSfvbUpsellPaths(requestParameters: ListSfvbUpsellPathsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellPathsResponse>;
3250
+ /**
3251
+ * Moves the step, in one transaction, to right after after_step_uuid (the begin step puts it first in the sequence) or to the start of one side of a condition, split or inboxgeek step (branch_step_uuid with side). The step keeps its uuid, settings and the email or postcard it sends: nothing is archived or created. Refused for the begin, end, continue and merge markers, for a condition, split or inboxgeek step, while any customer is waiting on the step, and when the new place is the one it is in. Send the step\'s hash_sha256 as If-Match, and the hash_sha256 of after_step_uuid or branch_step_uuid as anchor_hash_sha256. A sequence whose campaign or flow is live needs sfvb_publish and an approved sequence_step.move approval (Approval-Id); a draft or inactive one needs neither.
3252
+ * @summary Move one step
3253
+ * @param {number} storefrontOid
3254
+ * @param {string} sequenceUuid
3255
+ * @param {string} stepUuid
3256
+ * @param {string} ifMatch The moved step\&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
3257
+ * @param {SfvbSequenceStepMoveRequest} sequenceStepMoveRequest Where the step moves, and the hash of the step it goes next to
3258
+ * @param {string} [approvalId] When the sequence is live, the approval_id of an approved sequence_step.move request for exactly this move. See POST /sfvb/approvals.
3259
+ * @param {*} [options] Override http request option.
3260
+ * @throws {RequiredError}
3261
+ * @memberof SfvbApiInterface
3262
+ */
3263
+ moveSfvbSequenceStepRaw(requestParameters: MoveSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepMoveResponse>>;
3264
+ /**
3265
+ * Moves the step, in one transaction, to right after after_step_uuid (the begin step puts it first in the sequence) or to the start of one side of a condition, split or inboxgeek step (branch_step_uuid with side). The step keeps its uuid, settings and the email or postcard it sends: nothing is archived or created. Refused for the begin, end, continue and merge markers, for a condition, split or inboxgeek step, while any customer is waiting on the step, and when the new place is the one it is in. Send the step\'s hash_sha256 as If-Match, and the hash_sha256 of after_step_uuid or branch_step_uuid as anchor_hash_sha256. A sequence whose campaign or flow is live needs sfvb_publish and an approved sequence_step.move approval (Approval-Id); a draft or inactive one needs neither.
3266
+ * Move one step
3267
+ */
3268
+ moveSfvbSequenceStep(requestParameters: MoveSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepMoveResponse>;
3222
3269
  /**
3223
3270
  * Up, down, to the top or to the bottom of the storefront\'s paths. Order decides which running path a shopper meets first, so moving a running path needs sfvb_publish.
3224
3271
  * @summary Move an upsell path
@@ -4185,20 +4232,21 @@ export interface SfvbApiInterface {
4185
4232
  */
4186
4233
  updateSfvbRedirect(requestParameters: UpdateSfvbRedirectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRedirectResponse>;
4187
4234
  /**
4188
- * Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, postcard, experiment, resend, webhook, begin, end, continue and merge steps are refused. A sequence whose campaign or flow is live needs sfvb_publish.
4235
+ * Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, experiment, resend, webhook, begin, end, continue and merge steps are refused. On a post_card step only disabled, name and info change, and not its filter. A sequence whose campaign or flow is live needs sfvb_publish. Turning a post_card step on, live or not, needs an approved sequence_step.enable_postcard approval (Approval-Id): once on, it mails printed cards whenever the campaign or flow runs.
4189
4236
  * @summary Change one step\'s settings or audience filter
4190
4237
  * @param {number} storefrontOid
4191
4238
  * @param {string} sequenceUuid
4192
4239
  * @param {string} stepUuid
4193
4240
  * @param {string} ifMatch The step\&#39;s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
4194
4241
  * @param {SfvbSequenceStepUpdateRequest} sequenceStepUpdateRequest The settings, the filter, or both
4242
+ * @param {string} [approvalId] When the change turns a post_card step on, the approval_id of an approved sequence_step.enable_postcard request for this step. See POST /sfvb/approvals.
4195
4243
  * @param {*} [options] Override http request option.
4196
4244
  * @throws {RequiredError}
4197
4245
  * @memberof SfvbApiInterface
4198
4246
  */
4199
4247
  updateSfvbSequenceStepRaw(requestParameters: UpdateSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepUpdateResponse>>;
4200
4248
  /**
4201
- * Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, postcard, experiment, resend, webhook, begin, end, continue and merge steps are refused. A sequence whose campaign or flow is live needs sfvb_publish.
4249
+ * Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, experiment, resend, webhook, begin, end, continue and merge steps are refused. On a post_card step only disabled, name and info change, and not its filter. A sequence whose campaign or flow is live needs sfvb_publish. Turning a post_card step on, live or not, needs an approved sequence_step.enable_postcard approval (Approval-Id): once on, it mails printed cards whenever the campaign or flow runs.
4202
4250
  * Change one step\'s settings or audience filter
4203
4251
  */
4204
4252
  updateSfvbSequenceStep(requestParameters: UpdateSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepUpdateResponse>;
@@ -5484,13 +5532,13 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
5484
5532
  */
5485
5533
  insertSfvbSecretRequest(requestParameters: InsertSfvbSecretRequestRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSecretRequest>;
5486
5534
  /**
5487
- * Creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. It goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the email, as the admin\'s editor adds them. The email has no body yet, and gets the content review flags the admin gives a new email here. A sequence whose campaign or flow is live needs sfvb_publish.
5488
- * Add an email step, with its new email
5535
+ * type email (the default) creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. The email has no body yet, and gets the content review flags the admin gives a new email here. With library_item_oid the email starts from a code library email item instead (listSfvbCodeLibraryEmails): its body with new element ids, and its subject and preview text where the request gives none. The item must be this account\'s own, shared with it, or published, approved by UltraCart and free; it must pass the library content scanner and the email container rules, and executable elements need acknowledge_executable true. Its PNG, JPEG and GIF image files are copied into the storefront first, never over an existing file; any other file is skipped and listed. type wait adds a wait step with config_json as its settings: delay_duration and delay_duration_unit (minutes, hours, days, weeks or months), or a delay_until option; a wait that would pass customers on at once is refused. type post_card creates a new postcard with the admin\'s default front and back and adds the postcard step that mails it, together; the step starts disabled, so nothing is printed or mailed until it is turned on with set-config, and the response names the front and back containers. Any goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the new step, as the admin\'s editor adds them. A sequence whose campaign or flow is live needs sfvb_publish.
5536
+ * Add an email step, with its new email, a wait step, or a postcard step, with its new postcard
5489
5537
  */
5490
5538
  insertSfvbSequenceStepRaw(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepCreateResponse>>;
5491
5539
  /**
5492
- * Creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. It goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the email, as the admin\'s editor adds them. The email has no body yet, and gets the content review flags the admin gives a new email here. A sequence whose campaign or flow is live needs sfvb_publish.
5493
- * Add an email step, with its new email
5540
+ * type email (the default) creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. The email has no body yet, and gets the content review flags the admin gives a new email here. With library_item_oid the email starts from a code library email item instead (listSfvbCodeLibraryEmails): its body with new element ids, and its subject and preview text where the request gives none. The item must be this account\'s own, shared with it, or published, approved by UltraCart and free; it must pass the library content scanner and the email container rules, and executable elements need acknowledge_executable true. Its PNG, JPEG and GIF image files are copied into the storefront first, never over an existing file; any other file is skipped and listed. type wait adds a wait step with config_json as its settings: delay_duration and delay_duration_unit (minutes, hours, days, weeks or months), or a delay_until option; a wait that would pass customers on at once is refused. type post_card creates a new postcard with the admin\'s default front and back and adds the postcard step that mails it, together; the step starts disabled, so nothing is printed or mailed until it is turned on with set-config, and the response names the front and back containers. Any goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the new step, as the admin\'s editor adds them. A sequence whose campaign or flow is live needs sfvb_publish.
5541
+ * Add an email step, with its new email, a wait step, or a postcard step, with its new postcard
5494
5542
  */
5495
5543
  insertSfvbSequenceStep(requestParameters: InsertSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepCreateResponse>;
5496
5544
  /**
@@ -5543,6 +5591,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
5543
5591
  * List the storefront\'s campaigns
5544
5592
  */
5545
5593
  listSfvbCampaigns(requestParameters: ListSfvbCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaignsResponse>;
5594
+ /**
5595
+ * The code library is the one the admin\'s \"start from library\" uses; it isn\'t the Visual Builder element library. Lists the email items this account may use, by title: its own (source owned), those shared with it (shared), and those published for everyone, approved by UltraCart and free (public). search matches part of the title, with case. Each kind is capped at 100 items, and truncated says when there were more. Send an item\'s library_item_oid on the step insert to start a new email from it.
5596
+ * Email items from the code library that can start a new email step
5597
+ */
5598
+ listSfvbCodeLibraryEmailsRaw(requestParameters: ListSfvbCodeLibraryEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCodeLibraryEmailsResponse>>;
5599
+ /**
5600
+ * The code library is the one the admin\'s \"start from library\" uses; it isn\'t the Visual Builder element library. Lists the email items this account may use, by title: its own (source owned), those shared with it (shared), and those published for everyone, approved by UltraCart and free (public). search matches part of the title, with case. Each kind is capped at 100 items, and truncated says when there were more. Send an item\'s library_item_oid on the step insert to start a new email from it.
5601
+ * Email items from the code library that can start a new email step
5602
+ */
5603
+ listSfvbCodeLibraryEmails(requestParameters: ListSfvbCodeLibraryEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCodeLibraryEmailsResponse>;
5546
5604
  /**
5547
5605
  * 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.
5548
5606
  * List the storefront\'s email lists
@@ -5721,6 +5779,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
5721
5779
  * List upsell paths
5722
5780
  */
5723
5781
  listSfvbUpsellPaths(requestParameters: ListSfvbUpsellPathsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbUpsellPathsResponse>;
5782
+ /**
5783
+ * Moves the step, in one transaction, to right after after_step_uuid (the begin step puts it first in the sequence) or to the start of one side of a condition, split or inboxgeek step (branch_step_uuid with side). The step keeps its uuid, settings and the email or postcard it sends: nothing is archived or created. Refused for the begin, end, continue and merge markers, for a condition, split or inboxgeek step, while any customer is waiting on the step, and when the new place is the one it is in. Send the step\'s hash_sha256 as If-Match, and the hash_sha256 of after_step_uuid or branch_step_uuid as anchor_hash_sha256. A sequence whose campaign or flow is live needs sfvb_publish and an approved sequence_step.move approval (Approval-Id); a draft or inactive one needs neither.
5784
+ * Move one step
5785
+ */
5786
+ moveSfvbSequenceStepRaw(requestParameters: MoveSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepMoveResponse>>;
5787
+ /**
5788
+ * Moves the step, in one transaction, to right after after_step_uuid (the begin step puts it first in the sequence) or to the start of one side of a condition, split or inboxgeek step (branch_step_uuid with side). The step keeps its uuid, settings and the email or postcard it sends: nothing is archived or created. Refused for the begin, end, continue and merge markers, for a condition, split or inboxgeek step, while any customer is waiting on the step, and when the new place is the one it is in. Send the step\'s hash_sha256 as If-Match, and the hash_sha256 of after_step_uuid or branch_step_uuid as anchor_hash_sha256. A sequence whose campaign or flow is live needs sfvb_publish and an approved sequence_step.move approval (Approval-Id); a draft or inactive one needs neither.
5789
+ * Move one step
5790
+ */
5791
+ moveSfvbSequenceStep(requestParameters: MoveSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepMoveResponse>;
5724
5792
  /**
5725
5793
  * Up, down, to the top or to the bottom of the storefront\'s paths. Order decides which running path a shopper meets first, so moving a running path needs sfvb_publish.
5726
5794
  * Move an upsell path
@@ -6312,12 +6380,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
6312
6380
  */
6313
6381
  updateSfvbRedirect(requestParameters: UpdateSfvbRedirectRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRedirectResponse>;
6314
6382
  /**
6315
- * Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, postcard, experiment, resend, webhook, begin, end, continue and merge steps are refused. A sequence whose campaign or flow is live needs sfvb_publish.
6383
+ * Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, experiment, resend, webhook, begin, end, continue and merge steps are refused. On a post_card step only disabled, name and info change, and not its filter. A sequence whose campaign or flow is live needs sfvb_publish. Turning a post_card step on, live or not, needs an approved sequence_step.enable_postcard approval (Approval-Id): once on, it mails printed cards whenever the campaign or flow runs.
6316
6384
  * Change one step\'s settings or audience filter
6317
6385
  */
6318
6386
  updateSfvbSequenceStepRaw(requestParameters: UpdateSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbSequenceStepUpdateResponse>>;
6319
6387
  /**
6320
- * Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, postcard, experiment, resend, webhook, begin, end, continue and merge steps are refused. A sequence whose campaign or flow is live needs sfvb_publish.
6388
+ * Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, experiment, resend, webhook, begin, end, continue and merge steps are refused. On a post_card step only disabled, name and info change, and not its filter. A sequence whose campaign or flow is live needs sfvb_publish. Turning a post_card step on, live or not, needs an approved sequence_step.enable_postcard approval (Approval-Id): once on, it mails printed cards whenever the campaign or flow runs.
6321
6389
  * Change one step\'s settings or audience filter
6322
6390
  */
6323
6391
  updateSfvbSequenceStep(requestParameters: UpdateSfvbSequenceStepRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbSequenceStepUpdateResponse>;
@@ -7708,8 +7708,8 @@ var SfvbApi = /** @class */ (function (_super) {
7708
7708
  });
7709
7709
  };
7710
7710
  /**
7711
- * Creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. It goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the email, as the admin\'s editor adds them. The email has no body yet, and gets the content review flags the admin gives a new email here. A sequence whose campaign or flow is live needs sfvb_publish.
7712
- * Add an email step, with its new email
7711
+ * type email (the default) creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. The email has no body yet, and gets the content review flags the admin gives a new email here. With library_item_oid the email starts from a code library email item instead (listSfvbCodeLibraryEmails): its body with new element ids, and its subject and preview text where the request gives none. The item must be this account\'s own, shared with it, or published, approved by UltraCart and free; it must pass the library content scanner and the email container rules, and executable elements need acknowledge_executable true. Its PNG, JPEG and GIF image files are copied into the storefront first, never over an existing file; any other file is skipped and listed. type wait adds a wait step with config_json as its settings: delay_duration and delay_duration_unit (minutes, hours, days, weeks or months), or a delay_until option; a wait that would pass customers on at once is refused. type post_card creates a new postcard with the admin\'s default front and back and adds the postcard step that mails it, together; the step starts disabled, so nothing is printed or mailed until it is turned on with set-config, and the response names the front and back containers. Any goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the new step, as the admin\'s editor adds them. A sequence whose campaign or flow is live needs sfvb_publish.
7712
+ * Add an email step, with its new email, a wait step, or a postcard step, with its new postcard
7713
7713
  */
7714
7714
  SfvbApi.prototype.insertSfvbSequenceStepRaw = function (requestParameters, initOverrides) {
7715
7715
  return __awaiter(this, void 0, void 0, function () {
@@ -7763,8 +7763,8 @@ var SfvbApi = /** @class */ (function (_super) {
7763
7763
  });
7764
7764
  };
7765
7765
  /**
7766
- * Creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. It goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the email, as the admin\'s editor adds them. The email has no body yet, and gets the content review flags the admin gives a new email here. A sequence whose campaign or flow is live needs sfvb_publish.
7767
- * Add an email step, with its new email
7766
+ * type email (the default) creates a new email with the subject and preview text and adds the email step that sends it, together, so a failure leaves neither. The email has no body yet, and gets the content review flags the admin gives a new email here. With library_item_oid the email starts from a code library email item instead (listSfvbCodeLibraryEmails): its body with new element ids, and its subject and preview text where the request gives none. The item must be this account\'s own, shared with it, or published, approved by UltraCart and free; it must pass the library content scanner and the email container rules, and executable elements need acknowledge_executable true. Its PNG, JPEG and GIF image files are copied into the storefront first, never over an existing file; any other file is skipped and listed. type wait adds a wait step with config_json as its settings: delay_duration and delay_duration_unit (minutes, hours, days, weeks or months), or a delay_until option; a wait that would pass customers on at once is refused. type post_card creates a new postcard with the admin\'s default front and back and adds the postcard step that mails it, together; the step starts disabled, so nothing is printed or mailed until it is turned on with set-config, and the response names the front and back containers. Any goes right after after_step_uuid, or first on one side of a condition, split or inboxgeek step (branch_step_uuid with side). Send that step\'s hash_sha256 as If-Match. A sequence with no steps yet takes neither place and If-Match *, and gets begin and end steps around the new step, as the admin\'s editor adds them. A sequence whose campaign or flow is live needs sfvb_publish.
7767
+ * Add an email step, with its new email, a wait step, or a postcard step, with its new postcard
7768
7768
  */
7769
7769
  SfvbApi.prototype.insertSfvbSequenceStep = function (requestParameters, initOverrides) {
7770
7770
  return __awaiter(this, void 0, void 0, function () {
@@ -8111,6 +8111,68 @@ var SfvbApi = /** @class */ (function (_super) {
8111
8111
  });
8112
8112
  });
8113
8113
  };
8114
+ /**
8115
+ * The code library is the one the admin\'s \"start from library\" uses; it isn\'t the Visual Builder element library. Lists the email items this account may use, by title: its own (source owned), those shared with it (shared), and those published for everyone, approved by UltraCart and free (public). search matches part of the title, with case. Each kind is capped at 100 items, and truncated says when there were more. Send an item\'s library_item_oid on the step insert to start a new email from it.
8116
+ * Email items from the code library that can start a new email step
8117
+ */
8118
+ SfvbApi.prototype.listSfvbCodeLibraryEmailsRaw = function (requestParameters, initOverrides) {
8119
+ return __awaiter(this, void 0, void 0, function () {
8120
+ var queryParameters, headerParameters, _a, _b, response;
8121
+ return __generator(this, function (_c) {
8122
+ switch (_c.label) {
8123
+ case 0:
8124
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
8125
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling listSfvbCodeLibraryEmails.');
8126
+ }
8127
+ queryParameters = {};
8128
+ if (requestParameters.search !== undefined) {
8129
+ queryParameters['search'] = requestParameters.search;
8130
+ }
8131
+ headerParameters = {};
8132
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
8133
+ // oauth required
8134
+ _a = headerParameters;
8135
+ _b = "Authorization";
8136
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
8137
+ case 1:
8138
+ // oauth required
8139
+ _a[_b] = _c.sent();
8140
+ _c.label = 2;
8141
+ case 2:
8142
+ if (this.configuration && this.configuration.apiKey) {
8143
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
8144
+ }
8145
+ return [4 /*yield*/, this.request({
8146
+ path: "/sfvb/storefronts/{storefront_oid}/code_library/emails".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
8147
+ method: 'GET',
8148
+ headers: headerParameters,
8149
+ query: queryParameters,
8150
+ }, initOverrides)];
8151
+ case 3:
8152
+ response = _c.sent();
8153
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbCodeLibraryEmailsResponseFromJSON)(jsonValue); })];
8154
+ }
8155
+ });
8156
+ });
8157
+ };
8158
+ /**
8159
+ * The code library is the one the admin\'s \"start from library\" uses; it isn\'t the Visual Builder element library. Lists the email items this account may use, by title: its own (source owned), those shared with it (shared), and those published for everyone, approved by UltraCart and free (public). search matches part of the title, with case. Each kind is capped at 100 items, and truncated says when there were more. Send an item\'s library_item_oid on the step insert to start a new email from it.
8160
+ * Email items from the code library that can start a new email step
8161
+ */
8162
+ SfvbApi.prototype.listSfvbCodeLibraryEmails = function (requestParameters, initOverrides) {
8163
+ return __awaiter(this, void 0, void 0, function () {
8164
+ var response;
8165
+ return __generator(this, function (_a) {
8166
+ switch (_a.label) {
8167
+ case 0: return [4 /*yield*/, this.listSfvbCodeLibraryEmailsRaw(requestParameters, initOverrides)];
8168
+ case 1:
8169
+ response = _a.sent();
8170
+ return [4 /*yield*/, response.value()];
8171
+ case 2: return [2 /*return*/, _a.sent()];
8172
+ }
8173
+ });
8174
+ });
8175
+ };
8114
8176
  /**
8115
8177
  * 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.
8116
8178
  * List the storefront\'s email lists
@@ -9300,6 +9362,85 @@ var SfvbApi = /** @class */ (function (_super) {
9300
9362
  });
9301
9363
  });
9302
9364
  };
9365
+ /**
9366
+ * Moves the step, in one transaction, to right after after_step_uuid (the begin step puts it first in the sequence) or to the start of one side of a condition, split or inboxgeek step (branch_step_uuid with side). The step keeps its uuid, settings and the email or postcard it sends: nothing is archived or created. Refused for the begin, end, continue and merge markers, for a condition, split or inboxgeek step, while any customer is waiting on the step, and when the new place is the one it is in. Send the step\'s hash_sha256 as If-Match, and the hash_sha256 of after_step_uuid or branch_step_uuid as anchor_hash_sha256. A sequence whose campaign or flow is live needs sfvb_publish and an approved sequence_step.move approval (Approval-Id); a draft or inactive one needs neither.
9367
+ * Move one step
9368
+ */
9369
+ SfvbApi.prototype.moveSfvbSequenceStepRaw = function (requestParameters, initOverrides) {
9370
+ return __awaiter(this, void 0, void 0, function () {
9371
+ var queryParameters, headerParameters, _a, _b, response;
9372
+ return __generator(this, function (_c) {
9373
+ switch (_c.label) {
9374
+ case 0:
9375
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
9376
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling moveSfvbSequenceStep.');
9377
+ }
9378
+ if (requestParameters.sequenceUuid === null || requestParameters.sequenceUuid === undefined) {
9379
+ throw new runtime.RequiredError('sequenceUuid', 'Required parameter requestParameters.sequenceUuid was null or undefined when calling moveSfvbSequenceStep.');
9380
+ }
9381
+ if (requestParameters.stepUuid === null || requestParameters.stepUuid === undefined) {
9382
+ throw new runtime.RequiredError('stepUuid', 'Required parameter requestParameters.stepUuid was null or undefined when calling moveSfvbSequenceStep.');
9383
+ }
9384
+ if (requestParameters.ifMatch === null || requestParameters.ifMatch === undefined) {
9385
+ throw new runtime.RequiredError('ifMatch', 'Required parameter requestParameters.ifMatch was null or undefined when calling moveSfvbSequenceStep.');
9386
+ }
9387
+ if (requestParameters.sequenceStepMoveRequest === null || requestParameters.sequenceStepMoveRequest === undefined) {
9388
+ throw new runtime.RequiredError('sequenceStepMoveRequest', 'Required parameter requestParameters.sequenceStepMoveRequest was null or undefined when calling moveSfvbSequenceStep.');
9389
+ }
9390
+ queryParameters = {};
9391
+ headerParameters = {};
9392
+ headerParameters['Content-Type'] = 'application/json';
9393
+ if (requestParameters.ifMatch !== undefined && requestParameters.ifMatch !== null) {
9394
+ headerParameters['If-Match'] = String(requestParameters.ifMatch);
9395
+ }
9396
+ if (requestParameters.approvalId !== undefined && requestParameters.approvalId !== null) {
9397
+ headerParameters['Approval-Id'] = String(requestParameters.approvalId);
9398
+ }
9399
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
9400
+ // oauth required
9401
+ _a = headerParameters;
9402
+ _b = "Authorization";
9403
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
9404
+ case 1:
9405
+ // oauth required
9406
+ _a[_b] = _c.sent();
9407
+ _c.label = 2;
9408
+ case 2:
9409
+ if (this.configuration && this.configuration.apiKey) {
9410
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
9411
+ }
9412
+ return [4 /*yield*/, this.request({
9413
+ path: "/sfvb/storefronts/{storefront_oid}/sequences/{sequence_uuid}/steps/{step_uuid}/move".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("sequence_uuid", "}"), encodeURIComponent(String(requestParameters.sequenceUuid))).replace("{".concat("step_uuid", "}"), encodeURIComponent(String(requestParameters.stepUuid))),
9414
+ method: 'POST',
9415
+ headers: headerParameters,
9416
+ query: queryParameters,
9417
+ body: (0, models_1.SfvbSequenceStepMoveRequestToJSON)(requestParameters.sequenceStepMoveRequest),
9418
+ }, initOverrides)];
9419
+ case 3:
9420
+ response = _c.sent();
9421
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbSequenceStepMoveResponseFromJSON)(jsonValue); })];
9422
+ }
9423
+ });
9424
+ });
9425
+ };
9426
+ /**
9427
+ * Moves the step, in one transaction, to right after after_step_uuid (the begin step puts it first in the sequence) or to the start of one side of a condition, split or inboxgeek step (branch_step_uuid with side). The step keeps its uuid, settings and the email or postcard it sends: nothing is archived or created. Refused for the begin, end, continue and merge markers, for a condition, split or inboxgeek step, while any customer is waiting on the step, and when the new place is the one it is in. Send the step\'s hash_sha256 as If-Match, and the hash_sha256 of after_step_uuid or branch_step_uuid as anchor_hash_sha256. A sequence whose campaign or flow is live needs sfvb_publish and an approved sequence_step.move approval (Approval-Id); a draft or inactive one needs neither.
9428
+ * Move one step
9429
+ */
9430
+ SfvbApi.prototype.moveSfvbSequenceStep = function (requestParameters, initOverrides) {
9431
+ return __awaiter(this, void 0, void 0, function () {
9432
+ var response;
9433
+ return __generator(this, function (_a) {
9434
+ switch (_a.label) {
9435
+ case 0: return [4 /*yield*/, this.moveSfvbSequenceStepRaw(requestParameters, initOverrides)];
9436
+ case 1:
9437
+ response = _a.sent();
9438
+ return [4 /*yield*/, response.value()];
9439
+ case 2: return [2 /*return*/, _a.sent()];
9440
+ }
9441
+ });
9442
+ });
9443
+ };
9303
9444
  /**
9304
9445
  * Up, down, to the top or to the bottom of the storefront\'s paths. Order decides which running path a shopper meets first, so moving a running path needs sfvb_publish.
9305
9446
  * Move an upsell path
@@ -13365,7 +13506,7 @@ var SfvbApi = /** @class */ (function (_super) {
13365
13506
  });
13366
13507
  };
13367
13508
  /**
13368
- * Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, postcard, experiment, resend, webhook, begin, end, continue and merge steps are refused. A sequence whose campaign or flow is live needs sfvb_publish.
13509
+ * Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, experiment, resend, webhook, begin, end, continue and merge steps are refused. On a post_card step only disabled, name and info change, and not its filter. A sequence whose campaign or flow is live needs sfvb_publish. Turning a post_card step on, live or not, needs an approved sequence_step.enable_postcard approval (Approval-Id): once on, it mails printed cards whenever the campaign or flow runs.
13369
13510
  * Change one step\'s settings or audience filter
13370
13511
  */
13371
13512
  SfvbApi.prototype.updateSfvbSequenceStepRaw = function (requestParameters, initOverrides) {
@@ -13395,6 +13536,9 @@ var SfvbApi = /** @class */ (function (_super) {
13395
13536
  if (requestParameters.ifMatch !== undefined && requestParameters.ifMatch !== null) {
13396
13537
  headerParameters['If-Match'] = String(requestParameters.ifMatch);
13397
13538
  }
13539
+ if (requestParameters.approvalId !== undefined && requestParameters.approvalId !== null) {
13540
+ headerParameters['Approval-Id'] = String(requestParameters.approvalId);
13541
+ }
13398
13542
  if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
13399
13543
  // oauth required
13400
13544
  _a = headerParameters;
@@ -13423,7 +13567,7 @@ var SfvbApi = /** @class */ (function (_super) {
13423
13567
  });
13424
13568
  };
13425
13569
  /**
13426
- * Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, postcard, experiment, resend, webhook, begin, end, continue and merge steps are refused. A sequence whose campaign or flow is live needs sfvb_publish.
13570
+ * Replaces the step\'s settings (config_json), its audience filter (filter_profile_equation_json), or both. Nothing else about the step or the sequence changes. Send the step\'s hash_sha256 as If-Match; the write only lands if the step is still what you read. Email, experiment, resend, webhook, begin, end, continue and merge steps are refused. On a post_card step only disabled, name and info change, and not its filter. A sequence whose campaign or flow is live needs sfvb_publish. Turning a post_card step on, live or not, needs an approved sequence_step.enable_postcard approval (Approval-Id): once on, it mails printed cards whenever the campaign or flow runs.
13427
13571
  * Change one step\'s settings or audience filter
13428
13572
  */
13429
13573
  SfvbApi.prototype.updateSfvbSequenceStep = function (requestParameters, initOverrides) {
@@ -1342,7 +1342,7 @@ export interface StorefrontApiInterface {
1342
1342
  */
1343
1343
  getEmailCampaigns(requestParameters: GetEmailCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailCampaignsResponse>;
1344
1344
  /**
1345
- *
1345
+ * Lists only the campaigns with stats recorded in the last stat_days days, with those stats summed. A campaign with no stats in that window isn\'t listed; getEmailCampaigns lists every campaign.
1346
1346
  * @summary Get email campaigns with stats
1347
1347
  * @param {number} storefrontOid
1348
1348
  * @param {string} statDays
@@ -1352,6 +1352,7 @@ export interface StorefrontApiInterface {
1352
1352
  */
1353
1353
  getEmailCampaignsWithStatsRaw(requestParameters: GetEmailCampaignsWithStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailCampaignsResponse>>;
1354
1354
  /**
1355
+ * Lists only the campaigns with stats recorded in the last stat_days days, with those stats summed. A campaign with no stats in that window isn\'t listed; getEmailCampaigns lists every campaign.
1355
1356
  * Get email campaigns with stats
1356
1357
  */
1357
1358
  getEmailCampaignsWithStats(requestParameters: GetEmailCampaignsWithStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailCampaignsResponse>;
@@ -3805,10 +3806,12 @@ export declare class StorefrontApi extends runtime.BaseAPI implements Storefront
3805
3806
  */
3806
3807
  getEmailCampaigns(requestParameters: GetEmailCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailCampaignsResponse>;
3807
3808
  /**
3809
+ * Lists only the campaigns with stats recorded in the last stat_days days, with those stats summed. A campaign with no stats in that window isn\'t listed; getEmailCampaigns lists every campaign.
3808
3810
  * Get email campaigns with stats
3809
3811
  */
3810
3812
  getEmailCampaignsWithStatsRaw(requestParameters: GetEmailCampaignsWithStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<EmailCampaignsResponse>>;
3811
3813
  /**
3814
+ * Lists only the campaigns with stats recorded in the last stat_days days, with those stats summed. A campaign with no stats in that window isn\'t listed; getEmailCampaigns lists every campaign.
3812
3815
  * Get email campaigns with stats
3813
3816
  */
3814
3817
  getEmailCampaignsWithStats(requestParameters: GetEmailCampaignsWithStatsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<EmailCampaignsResponse>;
@@ -2518,6 +2518,7 @@ var StorefrontApi = /** @class */ (function (_super) {
2518
2518
  });
2519
2519
  };
2520
2520
  /**
2521
+ * Lists only the campaigns with stats recorded in the last stat_days days, with those stats summed. A campaign with no stats in that window isn\'t listed; getEmailCampaigns lists every campaign.
2521
2522
  * Get email campaigns with stats
2522
2523
  */
2523
2524
  StorefrontApi.prototype.getEmailCampaignsWithStatsRaw = function (requestParameters, initOverrides) {
@@ -2564,6 +2565,7 @@ var StorefrontApi = /** @class */ (function (_super) {
2564
2565
  });
2565
2566
  };
2566
2567
  /**
2568
+ * Lists only the campaigns with stats recorded in the last stat_days days, with those stats summed. A campaign with no stats in that window isn\'t listed; getEmailCampaigns lists every campaign.
2567
2569
  * Get email campaigns with stats
2568
2570
  */
2569
2571
  StorefrontApi.prototype.getEmailCampaignsWithStats = function (requestParameters, initOverrides) {
@@ -33,6 +33,12 @@ export interface ItemPaymentProcessing {
33
33
  * @memberof ItemPaymentProcessing
34
34
  */
35
35
  credit_card_transaction_type?: string;
36
+ /**
37
+ * HSA/FSA eligibility. eligible_with_lmn means the customer needs a Letter of Medical Necessity. Kept in sync automatically when Truemed is configured. Empty string clears it, null value will not update the field
38
+ * @type {string}
39
+ * @memberof ItemPaymentProcessing
40
+ */
41
+ hsa_fsa_eligibility?: string;
36
42
  /**
37
43
  * True if no real-time charge should be performed on this item.
38
44
  * @type {boolean}
@@ -35,6 +35,7 @@ function ItemPaymentProcessingFromJSONTyped(json, ignoreDiscriminator) {
35
35
  'block_prepaid': !(0, runtime_1.exists)(json, 'block_prepaid') ? undefined : json['block_prepaid'],
36
36
  'block_refunds': !(0, runtime_1.exists)(json, 'block_refunds') ? undefined : json['block_refunds'],
37
37
  'credit_card_transaction_type': !(0, runtime_1.exists)(json, 'credit_card_transaction_type') ? undefined : json['credit_card_transaction_type'],
38
+ 'hsa_fsa_eligibility': !(0, runtime_1.exists)(json, 'hsa_fsa_eligibility') ? undefined : json['hsa_fsa_eligibility'],
38
39
  'no_realtime_charge': !(0, runtime_1.exists)(json, 'no_realtime_charge') ? undefined : json['no_realtime_charge'],
39
40
  'payment_method_validity': !(0, runtime_1.exists)(json, 'payment_method_validity') ? undefined : json['payment_method_validity'],
40
41
  'rotating_transaction_gateway_codes': !(0, runtime_1.exists)(json, 'rotating_transaction_gateway_codes') ? undefined : json['rotating_transaction_gateway_codes'],
@@ -52,6 +53,7 @@ function ItemPaymentProcessingToJSON(value) {
52
53
  'block_prepaid': value.block_prepaid,
53
54
  'block_refunds': value.block_refunds,
54
55
  'credit_card_transaction_type': value.credit_card_transaction_type,
56
+ 'hsa_fsa_eligibility': value.hsa_fsa_eligibility,
55
57
  'no_realtime_charge': value.no_realtime_charge,
56
58
  'payment_method_validity': value.payment_method_validity,
57
59
  'rotating_transaction_gateway_codes': value.rotating_transaction_gateway_codes,