ultracart_rest_api_v2_typescript 4.1.208 → 4.1.210

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 (51) hide show
  1. package/.openapi-generator/FILES +10 -0
  2. package/README.md +4 -2
  3. package/dist/apis/SfvbApi.d.ts +367 -1
  4. package/dist/apis/SfvbApi.js +825 -23
  5. package/dist/models/SfvbArchiveRequest.d.ts +31 -0
  6. package/dist/models/SfvbArchiveRequest.js +50 -0
  7. package/dist/models/SfvbCampaign.d.ts +49 -0
  8. package/dist/models/SfvbCampaign.js +17 -0
  9. package/dist/models/SfvbCampaignMembership.d.ts +49 -0
  10. package/dist/models/SfvbCampaignMembership.js +56 -0
  11. package/dist/models/SfvbCampaignWriteRequest.d.ts +74 -0
  12. package/dist/models/SfvbCampaignWriteRequest.js +65 -0
  13. package/dist/models/SfvbCommsEmail.d.ts +18 -0
  14. package/dist/models/SfvbCommsEmail.js +6 -0
  15. package/dist/models/SfvbCommsList.d.ts +49 -0
  16. package/dist/models/SfvbCommsList.js +56 -0
  17. package/dist/models/SfvbCommsListsResponse.d.ts +32 -0
  18. package/dist/models/SfvbCommsListsResponse.js +51 -0
  19. package/dist/models/SfvbCommsSegment.d.ts +55 -0
  20. package/dist/models/SfvbCommsSegment.js +58 -0
  21. package/dist/models/SfvbCommsSegmentsResponse.d.ts +32 -0
  22. package/dist/models/SfvbCommsSegmentsResponse.js +51 -0
  23. package/dist/models/SfvbEmail.d.ts +6 -0
  24. package/dist/models/SfvbEmail.js +2 -0
  25. package/dist/models/SfvbEmailReviewRequest.d.ts +31 -0
  26. package/dist/models/SfvbEmailReviewRequest.js +50 -0
  27. package/dist/models/SfvbFlow.d.ts +66 -0
  28. package/dist/models/SfvbFlow.js +22 -0
  29. package/dist/models/SfvbFlowStatusRequest.d.ts +39 -0
  30. package/dist/models/SfvbFlowStatusRequest.js +57 -0
  31. package/dist/models/SfvbFlowWriteRequest.d.ts +100 -0
  32. package/dist/models/SfvbFlowWriteRequest.js +78 -0
  33. package/dist/models/index.d.ts +10 -0
  34. package/dist/models/index.js +10 -0
  35. package/package.json +1 -1
  36. package/src/apis/SfvbApi.ts +933 -10
  37. package/src/models/SfvbArchiveRequest.ts +67 -0
  38. package/src/models/SfvbCampaign.ts +70 -0
  39. package/src/models/SfvbCampaignMembership.ts +91 -0
  40. package/src/models/SfvbCampaignWriteRequest.ts +130 -0
  41. package/src/models/SfvbCommsEmail.ts +24 -0
  42. package/src/models/SfvbCommsList.ts +91 -0
  43. package/src/models/SfvbCommsListsResponse.ts +74 -0
  44. package/src/models/SfvbCommsSegment.ts +99 -0
  45. package/src/models/SfvbCommsSegmentsResponse.ts +74 -0
  46. package/src/models/SfvbEmail.ts +8 -0
  47. package/src/models/SfvbEmailReviewRequest.ts +67 -0
  48. package/src/models/SfvbFlow.ts +88 -0
  49. package/src/models/SfvbFlowStatusRequest.ts +77 -0
  50. package/src/models/SfvbFlowWriteRequest.ts +158 -0
  51. package/src/models/index.ts +10 -0
@@ -1001,6 +1001,7 @@ src/models/SfvbApprovalParams.ts
1001
1001
  src/models/SfvbApprovalReview.ts
1002
1002
  src/models/SfvbApprovalReviewFinding.ts
1003
1003
  src/models/SfvbApprovalsResponse.ts
1004
+ src/models/SfvbArchiveRequest.ts
1004
1005
  src/models/SfvbBlogPost.ts
1005
1006
  src/models/SfvbBlogPostDetail.ts
1006
1007
  src/models/SfvbBlogPostImage.ts
@@ -1008,10 +1009,16 @@ src/models/SfvbBlogPostImageRequest.ts
1008
1009
  src/models/SfvbBlogPostRequest.ts
1009
1010
  src/models/SfvbBlogPostsResponse.ts
1010
1011
  src/models/SfvbCampaign.ts
1012
+ src/models/SfvbCampaignMembership.ts
1013
+ src/models/SfvbCampaignWriteRequest.ts
1011
1014
  src/models/SfvbCampaignsResponse.ts
1012
1015
  src/models/SfvbCommsDnsRecord.ts
1013
1016
  src/models/SfvbCommsEmail.ts
1017
+ src/models/SfvbCommsList.ts
1018
+ src/models/SfvbCommsListsResponse.ts
1014
1019
  src/models/SfvbCommsPostcard.ts
1020
+ src/models/SfvbCommsSegment.ts
1021
+ src/models/SfvbCommsSegmentsResponse.ts
1015
1022
  src/models/SfvbCommsSendingDomain.ts
1016
1023
  src/models/SfvbCommsSendingDomainsResponse.ts
1017
1024
  src/models/SfvbCommsTwilioAccount.ts
@@ -1029,6 +1036,7 @@ src/models/SfvbElementsResponse.ts
1029
1036
  src/models/SfvbEmail.ts
1030
1037
  src/models/SfvbEmailRenderRequest.ts
1031
1038
  src/models/SfvbEmailRenderResponse.ts
1039
+ src/models/SfvbEmailReviewRequest.ts
1032
1040
  src/models/SfvbEmailUpdateRequest.ts
1033
1041
  src/models/SfvbErrorDetail.ts
1034
1042
  src/models/SfvbEvent.ts
@@ -1056,6 +1064,8 @@ src/models/SfvbFileWriteRequest.ts
1056
1064
  src/models/SfvbFileWriteResponse.ts
1057
1065
  src/models/SfvbFilesResponse.ts
1058
1066
  src/models/SfvbFlow.ts
1067
+ src/models/SfvbFlowStatusRequest.ts
1068
+ src/models/SfvbFlowWriteRequest.ts
1059
1069
  src/models/SfvbFlowsResponse.ts
1060
1070
  src/models/SfvbI18nGlossary.ts
1061
1071
  src/models/SfvbI18nGlossaryRequest.ts
package/README.md CHANGED
@@ -1,12 +1,12 @@
1
1
  # UltraCart Typescript SDK
2
- ## ultracart_rest_api_v2_typescript@4.1.208
2
+ ## ultracart_rest_api_v2_typescript@4.1.210
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.208 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.210 --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.210 | 10/27/2026 | sfvb internal testing |
88
+ | 4.1.209 | 10/27/2026 | sfvb internal testing |
87
89
  | 4.1.208 | 10/26/2026 | sfvb internal testing |
88
90
  | 4.1.207 | 10/16/2026 | sfvb internal testing |
89
91
  | 4.1.206 | 10/16/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, SfvbCampaign, SfvbCampaignsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbEmail, SfvbEmailRenderRequest, SfvbEmailRenderResponse, SfvbEmailUpdateRequest, SfvbEventsAuthRequest, SfvbEventsAuthResponse, SfvbEventsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbFlow, SfvbFlowsResponse, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeBatchRequest, SfvbItemAttributeBatchResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaDescriptionRequest, SfvbItemMultimediaRequest, SfvbItemPricing, SfvbItemPricingRequest, SfvbItemRelated, SfvbItemRelatedRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbNotFoundEntry, SfvbNotFoundEntryResponse, SfvbNotFoundPage, SfvbNotFoundResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
13
+ import { SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbArchiveRequest, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCampaign, SfvbCampaignWriteRequest, SfvbCampaignsResponse, SfvbCommsListsResponse, SfvbCommsSegmentsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbEmail, SfvbEmailRenderRequest, SfvbEmailRenderResponse, SfvbEmailReviewRequest, SfvbEmailUpdateRequest, SfvbEventsAuthRequest, SfvbEventsAuthResponse, SfvbEventsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbFlow, SfvbFlowStatusRequest, SfvbFlowWriteRequest, SfvbFlowsResponse, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeBatchRequest, SfvbItemAttributeBatchResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaDescriptionRequest, SfvbItemMultimediaRequest, SfvbItemPricing, SfvbItemPricingRequest, SfvbItemRelated, SfvbItemRelatedRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbNotFoundEntry, SfvbNotFoundEntryResponse, SfvbNotFoundPage, SfvbNotFoundResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
14
14
  export interface AddSfvbPageBlogPostsRequest {
15
15
  storefrontOid: number;
16
16
  path: string;
@@ -21,6 +21,18 @@ export interface AddSfvbPageItemsRequest {
21
21
  path: string;
22
22
  pageItemsAddRequest: SfvbPageItemsAddRequest;
23
23
  }
24
+ export interface ArchiveSfvbCampaignRequest {
25
+ storefrontOid: number;
26
+ campaignUuid: string;
27
+ ifMatch: string;
28
+ archiveRequest: SfvbArchiveRequest;
29
+ }
30
+ export interface ArchiveSfvbFlowRequest {
31
+ storefrontOid: number;
32
+ flowUuid: string;
33
+ ifMatch: string;
34
+ archiveRequest: SfvbArchiveRequest;
35
+ }
24
36
  export interface ArchiveSfvbUpsellPathRequest {
25
37
  storefrontOid: number;
26
38
  upsellPathOid: number;
@@ -39,9 +51,25 @@ export interface ClearSfvbLibraryScreenshotRequest {
39
51
  libraryOid: number;
40
52
  ifMatch: string;
41
53
  }
54
+ export interface CloneSfvbCampaignRequest {
55
+ storefrontOid: number;
56
+ campaignUuid: string;
57
+ }
58
+ export interface CloneSfvbFlowRequest {
59
+ storefrontOid: number;
60
+ flowUuid: string;
61
+ }
42
62
  export interface CompileSfvbCjsonRequest {
43
63
  compileRequest: SfvbCompileRequest;
44
64
  }
65
+ export interface CreateSfvbCampaignRequest {
66
+ storefrontOid: number;
67
+ campaignWriteRequest: SfvbCampaignWriteRequest;
68
+ }
69
+ export interface CreateSfvbFlowRequest {
70
+ storefrontOid: number;
71
+ flowWriteRequest: SfvbFlowWriteRequest;
72
+ }
45
73
  export interface CreateSfvbLibraryEntryRequest {
46
74
  storefrontOid: number;
47
75
  libraryEntry: SfvbLibraryEntryRequest;
@@ -491,6 +519,12 @@ export interface ListSfvbCampaignsRequest {
491
519
  pageSize?: number;
492
520
  includeDeleted?: boolean;
493
521
  }
522
+ export interface ListSfvbCommsListsRequest {
523
+ storefrontOid: number;
524
+ }
525
+ export interface ListSfvbCommsSegmentsRequest {
526
+ storefrontOid: number;
527
+ }
494
528
  export interface ListSfvbContainerVersionsRequest {
495
529
  storefrontOid: number;
496
530
  ownerType?: string;
@@ -777,6 +811,11 @@ export interface RevertSfvbFileRequest {
777
811
  fileRevertRequest: SfvbFileRevertRequest;
778
812
  approvalId?: string;
779
813
  }
814
+ export interface ReviewSfvbEmailRequest {
815
+ storefrontOid: number;
816
+ emailUuid: string;
817
+ emailReviewRequest: SfvbEmailReviewRequest;
818
+ }
780
819
  export interface RevokeSfvbSecretRequestRequest {
781
820
  requestId: string;
782
821
  }
@@ -834,6 +873,12 @@ export interface UpdateSfvbBlogPostRequest {
834
873
  blogPostOid: number;
835
874
  blogPostRequest: SfvbBlogPostRequest;
836
875
  }
876
+ export interface UpdateSfvbCampaignRequest {
877
+ storefrontOid: number;
878
+ campaignUuid: string;
879
+ ifMatch: string;
880
+ campaignWriteRequest: SfvbCampaignWriteRequest;
881
+ }
837
882
  export interface UpdateSfvbCommsSendingDomainRequest {
838
883
  domain: string;
839
884
  sendingDomain: SfvbCommsSendingDomain;
@@ -847,6 +892,18 @@ export interface UpdateSfvbEmailRequest {
847
892
  ifMatch: string;
848
893
  emailUpdateRequest: SfvbEmailUpdateRequest;
849
894
  }
895
+ export interface UpdateSfvbFlowRequest {
896
+ storefrontOid: number;
897
+ flowUuid: string;
898
+ ifMatch: string;
899
+ flowWriteRequest: SfvbFlowWriteRequest;
900
+ }
901
+ export interface UpdateSfvbFlowStatusRequest {
902
+ storefrontOid: number;
903
+ flowUuid: string;
904
+ ifMatch: string;
905
+ flowStatusRequest: SfvbFlowStatusRequest;
906
+ }
850
907
  export interface UpdateSfvbItemAttributeBatchRequest {
851
908
  storefrontOid: number;
852
909
  itemAttributeBatchRequest: SfvbItemAttributeBatchRequest;
@@ -928,6 +985,40 @@ export interface SfvbApiInterface {
928
985
  * Assign items to a page
929
986
  */
930
987
  addSfvbPageItems(requestParameters: AddSfvbPageItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageItemsResponse>;
988
+ /**
989
+ * Archiving alone never stops a send, so archiving a scheduled campaign also sets it back to draft, and notes says so. A campaign whose send is under way is refused with sfvb.campaign_sending. Send the hash_sha256 you read as If-Match. A scheduled, sending or sent campaign needs sfvb_publish.
990
+ * @summary Archive or unarchive a campaign
991
+ * @param {number} storefrontOid
992
+ * @param {string} campaignUuid
993
+ * @param {string} ifMatch hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
994
+ * @param {SfvbArchiveRequest} archiveRequest Whether to archive
995
+ * @param {*} [options] Override http request option.
996
+ * @throws {RequiredError}
997
+ * @memberof SfvbApiInterface
998
+ */
999
+ archiveSfvbCampaignRaw(requestParameters: ArchiveSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
1000
+ /**
1001
+ * Archiving alone never stops a send, so archiving a scheduled campaign also sets it back to draft, and notes says so. A campaign whose send is under way is refused with sfvb.campaign_sending. Send the hash_sha256 you read as If-Match. A scheduled, sending or sent campaign needs sfvb_publish.
1002
+ * Archive or unarchive a campaign
1003
+ */
1004
+ archiveSfvbCampaign(requestParameters: ArchiveSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
1005
+ /**
1006
+ * A flow that is still enrolling customers is refused, because archiving would only hide it. Set its status to inactive first. Send the hash_sha256 you read as If-Match.
1007
+ * @summary Archive or unarchive a flow
1008
+ * @param {number} storefrontOid
1009
+ * @param {string} flowUuid
1010
+ * @param {string} ifMatch hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
1011
+ * @param {SfvbArchiveRequest} archiveRequest Whether to archive
1012
+ * @param {*} [options] Override http request option.
1013
+ * @throws {RequiredError}
1014
+ * @memberof SfvbApiInterface
1015
+ */
1016
+ archiveSfvbFlowRaw(requestParameters: ArchiveSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
1017
+ /**
1018
+ * A flow that is still enrolling customers is refused, because archiving would only hide it. Set its status to inactive first. Send the hash_sha256 you read as If-Match.
1019
+ * Archive or unarchive a flow
1020
+ */
1021
+ archiveSfvbFlow(requestParameters: ArchiveSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
931
1022
  /**
932
1023
  * Files the path out of the default list. An archived path does not run. Archiving one that is switched on is a live change and needs sfvb_publish.
933
1024
  * @summary Archive an upsell path
@@ -990,6 +1081,36 @@ export interface SfvbApiInterface {
990
1081
  * Remove a library entry\'s screenshot
991
1082
  */
992
1083
  clearSfvbLibraryScreenshot(requestParameters: ClearSfvbLibraryScreenshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
1084
+ /**
1085
+ * A draft copy with copies of its emails and postcards, named Copy of and the original name, never archived and never scheduled. Steps keep their settings, including a paused rate limiter or an experiment winner, and notes names each one.
1086
+ * @summary Copy a campaign on the same storefront
1087
+ * @param {number} storefrontOid
1088
+ * @param {string} campaignUuid
1089
+ * @param {*} [options] Override http request option.
1090
+ * @throws {RequiredError}
1091
+ * @memberof SfvbApiInterface
1092
+ */
1093
+ cloneSfvbCampaignRaw(requestParameters: CloneSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
1094
+ /**
1095
+ * A draft copy with copies of its emails and postcards, named Copy of and the original name, never archived and never scheduled. Steps keep their settings, including a paused rate limiter or an experiment winner, and notes names each one.
1096
+ * Copy a campaign on the same storefront
1097
+ */
1098
+ cloneSfvbCampaign(requestParameters: CloneSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
1099
+ /**
1100
+ * A draft copy with copies of its emails and postcards, named Copy of and the original name, never archived. It enrolls nobody until it is turned on. Steps keep their settings, including a paused rate limiter or an experiment winner, and notes names each one.
1101
+ * @summary Copy a flow on the same storefront
1102
+ * @param {number} storefrontOid
1103
+ * @param {string} flowUuid
1104
+ * @param {*} [options] Override http request option.
1105
+ * @throws {RequiredError}
1106
+ * @memberof SfvbApiInterface
1107
+ */
1108
+ cloneSfvbFlowRaw(requestParameters: CloneSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
1109
+ /**
1110
+ * A draft copy with copies of its emails and postcards, named Copy of and the original name, never archived. It enrolls nobody until it is turned on. Steps keep their settings, including a paused rate limiter or an experiment winner, and notes names each one.
1111
+ * Copy a flow on the same storefront
1112
+ */
1113
+ cloneSfvbFlow(requestParameters: CloneSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
993
1114
  /**
994
1115
  * Compiles a container document to Velocity without storing anything. Supply theme_oid to compile with the theme\'s inherit groups applied; omit it to compile standalone.
995
1116
  * @summary Compile CJSON to Velocity
@@ -1004,6 +1125,36 @@ export interface SfvbApiInterface {
1004
1125
  * Compile CJSON to Velocity
1005
1126
  */
1006
1127
  compileSfvbCjson(requestParameters: CompileSfvbCjsonRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCompileResponse>;
1128
+ /**
1129
+ * A new draft campaign with an empty communication sequence. name is required. The sender defaults to the storefront\'s marketing sending settings. Nothing here starts a campaign.
1130
+ * @summary Create a draft campaign
1131
+ * @param {number} storefrontOid
1132
+ * @param {SfvbCampaignWriteRequest} campaignWriteRequest The campaign to create
1133
+ * @param {*} [options] Override http request option.
1134
+ * @throws {RequiredError}
1135
+ * @memberof SfvbApiInterface
1136
+ */
1137
+ createSfvbCampaignRaw(requestParameters: CreateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
1138
+ /**
1139
+ * A new draft campaign with an empty communication sequence. name is required. The sender defaults to the storefront\'s marketing sending settings. Nothing here starts a campaign.
1140
+ * Create a draft campaign
1141
+ */
1142
+ createSfvbCampaign(requestParameters: CreateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
1143
+ /**
1144
+ * A new draft flow with an empty communication sequence. name and trigger_type are required. A list or segment trigger needs trigger_parameter, the uuid of a list or segment on this storefront. The sender defaults to the storefront\'s marketing sending settings. A draft flow enrolls nobody until it is turned on.
1145
+ * @summary Create a draft flow
1146
+ * @param {number} storefrontOid
1147
+ * @param {SfvbFlowWriteRequest} flowWriteRequest The flow to create
1148
+ * @param {*} [options] Override http request option.
1149
+ * @throws {RequiredError}
1150
+ * @memberof SfvbApiInterface
1151
+ */
1152
+ createSfvbFlowRaw(requestParameters: CreateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
1153
+ /**
1154
+ * A new draft flow with an empty communication sequence. name and trigger_type are required. A list or segment trigger needs trigger_parameter, the uuid of a list or segment on this storefront. The sender defaults to the storefront\'s marketing sending settings. A draft flow enrolls nobody until it is turned on.
1155
+ * Create a draft flow
1156
+ */
1157
+ createSfvbFlow(requestParameters: CreateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
1007
1158
  /**
1008
1159
  * Creates a private draft owned by the calling user. The fragment is one widget and its children, and it must validate. Images it references on this storefront are copied into the entry before this returns, so it installs anywhere with its images. The fragment is scanned; card skimming or obfuscation signals are refused outright. Nothing other merchants or shoppers see changes, so sfvb_write is enough. Publish it to share it. An optional screenshot takes a staged PNG key, exactly as the library screenshot endpoint does; a refused screenshot refuses the whole create.
1009
1160
  * @summary Save a fragment to the library
@@ -2653,6 +2804,34 @@ export interface SfvbApiInterface {
2653
2804
  * List the storefront\'s campaigns
2654
2805
  */
2655
2806
  listSfvbCampaigns(requestParameters: ListSfvbCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaignsResponse>;
2807
+ /**
2808
+ * 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.
2809
+ * @summary List the storefront\'s email lists
2810
+ * @param {number} storefrontOid
2811
+ * @param {*} [options] Override http request option.
2812
+ * @throws {RequiredError}
2813
+ * @memberof SfvbApiInterface
2814
+ */
2815
+ listSfvbCommsListsRaw(requestParameters: ListSfvbCommsListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsListsResponse>>;
2816
+ /**
2817
+ * 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.
2818
+ * List the storefront\'s email lists
2819
+ */
2820
+ listSfvbCommsLists(requestParameters: ListSfvbCommsListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsListsResponse>;
2821
+ /**
2822
+ * Each segment\'s uuid, name and member count at its last rebuild, by name, for a campaign\'s memberships or a segment trigger. Never its members or its rule. Archived segments are left out.
2823
+ * @summary List the storefront\'s segments
2824
+ * @param {number} storefrontOid
2825
+ * @param {*} [options] Override http request option.
2826
+ * @throws {RequiredError}
2827
+ * @memberof SfvbApiInterface
2828
+ */
2829
+ listSfvbCommsSegmentsRaw(requestParameters: ListSfvbCommsSegmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSegmentsResponse>>;
2830
+ /**
2831
+ * Each segment\'s uuid, name and member count at its last rebuild, by name, for a campaign\'s memberships or a segment trigger. Never its members or its rule. Archived segments are left out.
2832
+ * List the storefront\'s segments
2833
+ */
2834
+ listSfvbCommsSegments(requestParameters: ListSfvbCommsSegmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSegmentsResponse>;
2656
2835
  /**
2657
2836
  * 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.
2658
2837
  * @summary Version history for a container stored outside the file system
@@ -3514,6 +3693,22 @@ export interface SfvbApiInterface {
3514
3693
  * Revert a storefront file to an earlier version
3515
3694
  */
3516
3695
  revertSfvbFile(requestParameters: RevertSfvbFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileWriteResponse>;
3696
+ /**
3697
+ * Starts a review the way the admin\'s Request Review does. One test copy of the email goes to the signed-in user, and to no one else, and the review runs in the background, so read the email again for pending_review and then the ruling. Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since. An email in a flow triggered by an order or an auto order needs order_id, a test order. Needs a signed-in user, not an API key alone.
3698
+ * @summary Request a content review of a flow or campaign email
3699
+ * @param {number} storefrontOid
3700
+ * @param {string} emailUuid
3701
+ * @param {SfvbEmailReviewRequest} emailReviewRequest The test order, for an email in an order-triggered flow
3702
+ * @param {*} [options] Override http request option.
3703
+ * @throws {RequiredError}
3704
+ * @memberof SfvbApiInterface
3705
+ */
3706
+ reviewSfvbEmailRaw(requestParameters: ReviewSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEmail>>;
3707
+ /**
3708
+ * Starts a review the way the admin\'s Request Review does. One test copy of the email goes to the signed-in user, and to no one else, and the review runs in the background, so read the email again for pending_review and then the ruling. Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since. An email in a flow triggered by an order or an auto order needs order_id, a test order. Needs a signed-in user, not an API key alone.
3709
+ * Request a content review of a flow or campaign email
3710
+ */
3711
+ reviewSfvbEmail(requestParameters: ReviewSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail>;
3517
3712
  /**
3518
3713
  * Every handle of the request that no write has used up stops working at once, and its value is deleted. A handle a write is using right now is left to that write. Use it when the plan changed, or a handle may have leaked.
3519
3714
  * @summary Revoke a fulfilled request\'s unused handles
@@ -3703,6 +3898,23 @@ export interface SfvbApiInterface {
3703
3898
  * Change a blog post
3704
3899
  */
3705
3900
  updateSfvbBlogPost(requestParameters: UpdateSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
3901
+ /**
3902
+ * A field left out keeps its value; memberships replaces the whole set. The status is never changed here. Send the hash_sha256 you read as If-Match. A scheduled, sending or sent campaign needs sfvb_publish, and a change to a scheduled one applies to the send that is coming. notes lists any emails a sending domain change put back to needing review.
3903
+ * @summary Change a campaign
3904
+ * @param {number} storefrontOid
3905
+ * @param {string} campaignUuid
3906
+ * @param {string} ifMatch hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
3907
+ * @param {SfvbCampaignWriteRequest} campaignWriteRequest The fields to change
3908
+ * @param {*} [options] Override http request option.
3909
+ * @throws {RequiredError}
3910
+ * @memberof SfvbApiInterface
3911
+ */
3912
+ updateSfvbCampaignRaw(requestParameters: UpdateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
3913
+ /**
3914
+ * A field left out keeps its value; memberships replaces the whole set. The status is never changed here. Send the hash_sha256 you read as If-Match. A scheduled, sending or sent campaign needs sfvb_publish, and a change to a scheduled one applies to the send that is coming. notes lists any emails a sending domain change put back to needing review.
3915
+ * Change a campaign
3916
+ */
3917
+ updateSfvbCampaign(requestParameters: UpdateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
3706
3918
  /**
3707
3919
  * Only a mailgun domain\'s mailgun_api_key can change. Send it as a secret handle made for the domain to replace it, or as the mask it was read with to keep it. A new key sets up UltraCart\'s webhooks again with it; if Mailgun refuses, nothing is saved and the handle is given back unused.
3708
3920
  * @summary Update a sending domain
@@ -3749,6 +3961,40 @@ export interface SfvbApiInterface {
3749
3961
  * Change a flow or campaign email\'s subject or preview text
3750
3962
  */
3751
3963
  updateSfvbEmail(requestParameters: UpdateSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail>;
3964
+ /**
3965
+ * A field left out keeps its value. The trigger and the status are never changed here. Send the hash_sha256 you read as If-Match. A flow that is enrolling customers needs sfvb_publish.
3966
+ * @summary Change a flow
3967
+ * @param {number} storefrontOid
3968
+ * @param {string} flowUuid
3969
+ * @param {string} ifMatch hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
3970
+ * @param {SfvbFlowWriteRequest} flowWriteRequest The fields to change
3971
+ * @param {*} [options] Override http request option.
3972
+ * @throws {RequiredError}
3973
+ * @memberof SfvbApiInterface
3974
+ */
3975
+ updateSfvbFlowRaw(requestParameters: UpdateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
3976
+ /**
3977
+ * A field left out keeps its value. The trigger and the status are never changed here. Send the hash_sha256 you read as If-Match. A flow that is enrolling customers needs sfvb_publish.
3978
+ * Change a flow
3979
+ */
3980
+ updateSfvbFlow(requestParameters: UpdateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
3981
+ /**
3982
+ * active enrolls customers as they trigger the flow from now on, and they receive its emails. inactive stops new enrollments. Always needs sfvb_publish. Send the hash_sha256 you read as If-Match.
3983
+ * @summary Turn a flow on or off
3984
+ * @param {number} storefrontOid
3985
+ * @param {string} flowUuid
3986
+ * @param {string} ifMatch hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
3987
+ * @param {SfvbFlowStatusRequest} flowStatusRequest The status to set
3988
+ * @param {*} [options] Override http request option.
3989
+ * @throws {RequiredError}
3990
+ * @memberof SfvbApiInterface
3991
+ */
3992
+ updateSfvbFlowStatusRaw(requestParameters: UpdateSfvbFlowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
3993
+ /**
3994
+ * active enrolls customers as they trigger the flow from now on, and they receive its emails. inactive stops new enrollments. Always needs sfvb_publish. Send the hash_sha256 you read as If-Match.
3995
+ * Turn a flow on or off
3996
+ */
3997
+ updateSfvbFlowStatus(requestParameters: UpdateSfvbFlowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
3752
3998
  /**
3753
3999
  * Applies exactly the change rows of a dry run, given its plan_hash, each with its merchant_item_oid and current_sha256. Each item is saved once with all of its rows; a row whose value changed since the dry run is skipped as stale and never overwritten, and an item that cannot be saved does not stop the others. Only the named attributes change. Needs sfvb_publish and the approval of the person who signed in the CLI, an approved item.attribute_batch request for exactly these rows in the Approval-Id header.
3754
4000
  * @summary Change attributes across many items in one call
@@ -3904,6 +4150,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
3904
4150
  * Assign items to a page
3905
4151
  */
3906
4152
  addSfvbPageItems(requestParameters: AddSfvbPageItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageItemsResponse>;
4153
+ /**
4154
+ * Archiving alone never stops a send, so archiving a scheduled campaign also sets it back to draft, and notes says so. A campaign whose send is under way is refused with sfvb.campaign_sending. Send the hash_sha256 you read as If-Match. A scheduled, sending or sent campaign needs sfvb_publish.
4155
+ * Archive or unarchive a campaign
4156
+ */
4157
+ archiveSfvbCampaignRaw(requestParameters: ArchiveSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
4158
+ /**
4159
+ * Archiving alone never stops a send, so archiving a scheduled campaign also sets it back to draft, and notes says so. A campaign whose send is under way is refused with sfvb.campaign_sending. Send the hash_sha256 you read as If-Match. A scheduled, sending or sent campaign needs sfvb_publish.
4160
+ * Archive or unarchive a campaign
4161
+ */
4162
+ archiveSfvbCampaign(requestParameters: ArchiveSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
4163
+ /**
4164
+ * A flow that is still enrolling customers is refused, because archiving would only hide it. Set its status to inactive first. Send the hash_sha256 you read as If-Match.
4165
+ * Archive or unarchive a flow
4166
+ */
4167
+ archiveSfvbFlowRaw(requestParameters: ArchiveSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
4168
+ /**
4169
+ * A flow that is still enrolling customers is refused, because archiving would only hide it. Set its status to inactive first. Send the hash_sha256 you read as If-Match.
4170
+ * Archive or unarchive a flow
4171
+ */
4172
+ archiveSfvbFlow(requestParameters: ArchiveSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
3907
4173
  /**
3908
4174
  * Files the path out of the default list. An archived path does not run. Archiving one that is switched on is a live change and needs sfvb_publish.
3909
4175
  * Archive an upsell path
@@ -3944,6 +4210,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
3944
4210
  * Remove a library entry\'s screenshot
3945
4211
  */
3946
4212
  clearSfvbLibraryScreenshot(requestParameters: ClearSfvbLibraryScreenshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
4213
+ /**
4214
+ * A draft copy with copies of its emails and postcards, named Copy of and the original name, never archived and never scheduled. Steps keep their settings, including a paused rate limiter or an experiment winner, and notes names each one.
4215
+ * Copy a campaign on the same storefront
4216
+ */
4217
+ cloneSfvbCampaignRaw(requestParameters: CloneSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
4218
+ /**
4219
+ * A draft copy with copies of its emails and postcards, named Copy of and the original name, never archived and never scheduled. Steps keep their settings, including a paused rate limiter or an experiment winner, and notes names each one.
4220
+ * Copy a campaign on the same storefront
4221
+ */
4222
+ cloneSfvbCampaign(requestParameters: CloneSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
4223
+ /**
4224
+ * A draft copy with copies of its emails and postcards, named Copy of and the original name, never archived. It enrolls nobody until it is turned on. Steps keep their settings, including a paused rate limiter or an experiment winner, and notes names each one.
4225
+ * Copy a flow on the same storefront
4226
+ */
4227
+ cloneSfvbFlowRaw(requestParameters: CloneSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
4228
+ /**
4229
+ * A draft copy with copies of its emails and postcards, named Copy of and the original name, never archived. It enrolls nobody until it is turned on. Steps keep their settings, including a paused rate limiter or an experiment winner, and notes names each one.
4230
+ * Copy a flow on the same storefront
4231
+ */
4232
+ cloneSfvbFlow(requestParameters: CloneSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
3947
4233
  /**
3948
4234
  * Compiles a container document to Velocity without storing anything. Supply theme_oid to compile with the theme\'s inherit groups applied; omit it to compile standalone.
3949
4235
  * Compile CJSON to Velocity
@@ -3954,6 +4240,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
3954
4240
  * Compile CJSON to Velocity
3955
4241
  */
3956
4242
  compileSfvbCjson(requestParameters: CompileSfvbCjsonRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCompileResponse>;
4243
+ /**
4244
+ * A new draft campaign with an empty communication sequence. name is required. The sender defaults to the storefront\'s marketing sending settings. Nothing here starts a campaign.
4245
+ * Create a draft campaign
4246
+ */
4247
+ createSfvbCampaignRaw(requestParameters: CreateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
4248
+ /**
4249
+ * A new draft campaign with an empty communication sequence. name is required. The sender defaults to the storefront\'s marketing sending settings. Nothing here starts a campaign.
4250
+ * Create a draft campaign
4251
+ */
4252
+ createSfvbCampaign(requestParameters: CreateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
4253
+ /**
4254
+ * A new draft flow with an empty communication sequence. name and trigger_type are required. A list or segment trigger needs trigger_parameter, the uuid of a list or segment on this storefront. The sender defaults to the storefront\'s marketing sending settings. A draft flow enrolls nobody until it is turned on.
4255
+ * Create a draft flow
4256
+ */
4257
+ createSfvbFlowRaw(requestParameters: CreateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
4258
+ /**
4259
+ * A new draft flow with an empty communication sequence. name and trigger_type are required. A list or segment trigger needs trigger_parameter, the uuid of a list or segment on this storefront. The sender defaults to the storefront\'s marketing sending settings. A draft flow enrolls nobody until it is turned on.
4260
+ * Create a draft flow
4261
+ */
4262
+ createSfvbFlow(requestParameters: CreateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
3957
4263
  /**
3958
4264
  * Creates a private draft owned by the calling user. The fragment is one widget and its children, and it must validate. Images it references on this storefront are copied into the entry before this returns, so it installs anywhere with its images. The fragment is scanned; card skimming or obfuscation signals are refused outright. Nothing other merchants or shoppers see changes, so sfvb_write is enough. Publish it to share it. An optional screenshot takes a staged PNG key, exactly as the library screenshot endpoint does; a refused screenshot refuses the whole create.
3959
4265
  * Save a fragment to the library
@@ -5030,6 +5336,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
5030
5336
  * List the storefront\'s campaigns
5031
5337
  */
5032
5338
  listSfvbCampaigns(requestParameters: ListSfvbCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaignsResponse>;
5339
+ /**
5340
+ * 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.
5341
+ * List the storefront\'s email lists
5342
+ */
5343
+ listSfvbCommsListsRaw(requestParameters: ListSfvbCommsListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsListsResponse>>;
5344
+ /**
5345
+ * 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.
5346
+ * List the storefront\'s email lists
5347
+ */
5348
+ listSfvbCommsLists(requestParameters: ListSfvbCommsListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsListsResponse>;
5349
+ /**
5350
+ * Each segment\'s uuid, name and member count at its last rebuild, by name, for a campaign\'s memberships or a segment trigger. Never its members or its rule. Archived segments are left out.
5351
+ * List the storefront\'s segments
5352
+ */
5353
+ listSfvbCommsSegmentsRaw(requestParameters: ListSfvbCommsSegmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSegmentsResponse>>;
5354
+ /**
5355
+ * Each segment\'s uuid, name and member count at its last rebuild, by name, for a campaign\'s memberships or a segment trigger. Never its members or its rule. Archived segments are left out.
5356
+ * List the storefront\'s segments
5357
+ */
5358
+ listSfvbCommsSegments(requestParameters: ListSfvbCommsSegmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSegmentsResponse>;
5033
5359
  /**
5034
5360
  * 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.
5035
5361
  * Version history for a container stored outside the file system
@@ -5548,6 +5874,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
5548
5874
  * Revert a storefront file to an earlier version
5549
5875
  */
5550
5876
  revertSfvbFile(requestParameters: RevertSfvbFileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileWriteResponse>;
5877
+ /**
5878
+ * Starts a review the way the admin\'s Request Review does. One test copy of the email goes to the signed-in user, and to no one else, and the review runs in the background, so read the email again for pending_review and then the ruling. Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since. An email in a flow triggered by an order or an auto order needs order_id, a test order. Needs a signed-in user, not an API key alone.
5879
+ * Request a content review of a flow or campaign email
5880
+ */
5881
+ reviewSfvbEmailRaw(requestParameters: ReviewSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEmail>>;
5882
+ /**
5883
+ * Starts a review the way the admin\'s Request Review does. One test copy of the email goes to the signed-in user, and to no one else, and the review runs in the background, so read the email again for pending_review and then the ruling. Refused with sfvb.review_not_needed when it doesn\'t need review, is already waiting for one, or was rejected and not changed since. An email in a flow triggered by an order or an auto order needs order_id, a test order. Needs a signed-in user, not an API key alone.
5884
+ * Request a content review of a flow or campaign email
5885
+ */
5886
+ reviewSfvbEmail(requestParameters: ReviewSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail>;
5551
5887
  /**
5552
5888
  * Every handle of the request that no write has used up stops working at once, and its value is deleted. A handle a write is using right now is left to that write. Use it when the plan changed, or a handle may have leaked.
5553
5889
  * Revoke a fulfilled request\'s unused handles
@@ -5668,6 +6004,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
5668
6004
  * Change a blog post
5669
6005
  */
5670
6006
  updateSfvbBlogPost(requestParameters: UpdateSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
6007
+ /**
6008
+ * A field left out keeps its value; memberships replaces the whole set. The status is never changed here. Send the hash_sha256 you read as If-Match. A scheduled, sending or sent campaign needs sfvb_publish, and a change to a scheduled one applies to the send that is coming. notes lists any emails a sending domain change put back to needing review.
6009
+ * Change a campaign
6010
+ */
6011
+ updateSfvbCampaignRaw(requestParameters: UpdateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
6012
+ /**
6013
+ * A field left out keeps its value; memberships replaces the whole set. The status is never changed here. Send the hash_sha256 you read as If-Match. A scheduled, sending or sent campaign needs sfvb_publish, and a change to a scheduled one applies to the send that is coming. notes lists any emails a sending domain change put back to needing review.
6014
+ * Change a campaign
6015
+ */
6016
+ updateSfvbCampaign(requestParameters: UpdateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
5671
6017
  /**
5672
6018
  * Only a mailgun domain\'s mailgun_api_key can change. Send it as a secret handle made for the domain to replace it, or as the mask it was read with to keep it. A new key sets up UltraCart\'s webhooks again with it; if Mailgun refuses, nothing is saved and the handle is given back unused.
5673
6019
  * Update a sending domain
@@ -5698,6 +6044,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
5698
6044
  * Change a flow or campaign email\'s subject or preview text
5699
6045
  */
5700
6046
  updateSfvbEmail(requestParameters: UpdateSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail>;
6047
+ /**
6048
+ * A field left out keeps its value. The trigger and the status are never changed here. Send the hash_sha256 you read as If-Match. A flow that is enrolling customers needs sfvb_publish.
6049
+ * Change a flow
6050
+ */
6051
+ updateSfvbFlowRaw(requestParameters: UpdateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
6052
+ /**
6053
+ * A field left out keeps its value. The trigger and the status are never changed here. Send the hash_sha256 you read as If-Match. A flow that is enrolling customers needs sfvb_publish.
6054
+ * Change a flow
6055
+ */
6056
+ updateSfvbFlow(requestParameters: UpdateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
6057
+ /**
6058
+ * active enrolls customers as they trigger the flow from now on, and they receive its emails. inactive stops new enrollments. Always needs sfvb_publish. Send the hash_sha256 you read as If-Match.
6059
+ * Turn a flow on or off
6060
+ */
6061
+ updateSfvbFlowStatusRaw(requestParameters: UpdateSfvbFlowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
6062
+ /**
6063
+ * active enrolls customers as they trigger the flow from now on, and they receive its emails. inactive stops new enrollments. Always needs sfvb_publish. Send the hash_sha256 you read as If-Match.
6064
+ * Turn a flow on or off
6065
+ */
6066
+ updateSfvbFlowStatus(requestParameters: UpdateSfvbFlowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
5701
6067
  /**
5702
6068
  * Applies exactly the change rows of a dry run, given its plan_hash, each with its merchant_item_oid and current_sha256. Each item is saved once with all of its rows; a row whose value changed since the dry run is skipped as stale and never overwritten, and an item that cannot be saved does not stop the others. Only the named attributes change. Needs sfvb_publish and the approval of the person who signed in the CLI, an approved item.attribute_batch request for exactly these rows in the Approval-Id header.
5703
6069
  * Change attributes across many items in one call