ultracart_rest_api_v2_typescript 4.1.207 → 4.1.209

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 (54) hide show
  1. package/.openapi-generator/FILES +11 -0
  2. package/README.md +4 -2
  3. package/dist/apis/SfvbApi.d.ts +398 -1
  4. package/dist/apis/SfvbApi.js +889 -19
  5. package/dist/models/ItemThirdPartyEmailMarketing.d.ts +0 -2
  6. package/dist/models/ItemThirdPartyEmailMarketing.js +0 -2
  7. package/dist/models/SfvbArchiveRequest.d.ts +31 -0
  8. package/dist/models/SfvbArchiveRequest.js +50 -0
  9. package/dist/models/SfvbCampaign.d.ts +49 -0
  10. package/dist/models/SfvbCampaign.js +17 -0
  11. package/dist/models/SfvbCampaignMembership.d.ts +49 -0
  12. package/dist/models/SfvbCampaignMembership.js +56 -0
  13. package/dist/models/SfvbCampaignWriteRequest.d.ts +74 -0
  14. package/dist/models/SfvbCampaignWriteRequest.js +65 -0
  15. package/dist/models/SfvbCommsEmail.d.ts +18 -0
  16. package/dist/models/SfvbCommsEmail.js +6 -0
  17. package/dist/models/SfvbCommsList.d.ts +49 -0
  18. package/dist/models/SfvbCommsList.js +56 -0
  19. package/dist/models/SfvbCommsListsResponse.d.ts +32 -0
  20. package/dist/models/SfvbCommsListsResponse.js +51 -0
  21. package/dist/models/SfvbCommsSegment.d.ts +55 -0
  22. package/dist/models/SfvbCommsSegment.js +58 -0
  23. package/dist/models/SfvbCommsSegmentsResponse.d.ts +32 -0
  24. package/dist/models/SfvbCommsSegmentsResponse.js +51 -0
  25. package/dist/models/SfvbEmail.d.ts +97 -0
  26. package/dist/models/SfvbEmail.js +72 -0
  27. package/dist/models/SfvbEmailUpdateRequest.d.ts +37 -0
  28. package/dist/models/SfvbEmailUpdateRequest.js +52 -0
  29. package/dist/models/SfvbFlow.d.ts +66 -0
  30. package/dist/models/SfvbFlow.js +22 -0
  31. package/dist/models/SfvbFlowStatusRequest.d.ts +39 -0
  32. package/dist/models/SfvbFlowStatusRequest.js +57 -0
  33. package/dist/models/SfvbFlowWriteRequest.d.ts +100 -0
  34. package/dist/models/SfvbFlowWriteRequest.js +78 -0
  35. package/dist/models/index.d.ts +11 -0
  36. package/dist/models/index.js +11 -0
  37. package/package.json +1 -1
  38. package/src/apis/SfvbApi.ts +1009 -6
  39. package/src/models/ItemThirdPartyEmailMarketing.ts +0 -2
  40. package/src/models/SfvbArchiveRequest.ts +67 -0
  41. package/src/models/SfvbCampaign.ts +70 -0
  42. package/src/models/SfvbCampaignMembership.ts +91 -0
  43. package/src/models/SfvbCampaignWriteRequest.ts +130 -0
  44. package/src/models/SfvbCommsEmail.ts +24 -0
  45. package/src/models/SfvbCommsList.ts +91 -0
  46. package/src/models/SfvbCommsListsResponse.ts +74 -0
  47. package/src/models/SfvbCommsSegment.ts +99 -0
  48. package/src/models/SfvbCommsSegmentsResponse.ts +74 -0
  49. package/src/models/SfvbEmail.ts +155 -0
  50. package/src/models/SfvbEmailUpdateRequest.ts +75 -0
  51. package/src/models/SfvbFlow.ts +88 -0
  52. package/src/models/SfvbFlowStatusRequest.ts +77 -0
  53. package/src/models/SfvbFlowWriteRequest.ts +158 -0
  54. package/src/models/index.ts +11 -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
@@ -1026,8 +1033,10 @@ src/models/SfvbContainerWriteRequest.ts
1026
1033
  src/models/SfvbElement.ts
1027
1034
  src/models/SfvbElementSchemaResponse.ts
1028
1035
  src/models/SfvbElementsResponse.ts
1036
+ src/models/SfvbEmail.ts
1029
1037
  src/models/SfvbEmailRenderRequest.ts
1030
1038
  src/models/SfvbEmailRenderResponse.ts
1039
+ src/models/SfvbEmailUpdateRequest.ts
1031
1040
  src/models/SfvbErrorDetail.ts
1032
1041
  src/models/SfvbEvent.ts
1033
1042
  src/models/SfvbEventsAuthRequest.ts
@@ -1054,6 +1063,8 @@ src/models/SfvbFileWriteRequest.ts
1054
1063
  src/models/SfvbFileWriteResponse.ts
1055
1064
  src/models/SfvbFilesResponse.ts
1056
1065
  src/models/SfvbFlow.ts
1066
+ src/models/SfvbFlowStatusRequest.ts
1067
+ src/models/SfvbFlowWriteRequest.ts
1057
1068
  src/models/SfvbFlowsResponse.ts
1058
1069
  src/models/SfvbI18nGlossary.ts
1059
1070
  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.207
2
+ ## ultracart_rest_api_v2_typescript@4.1.209
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.207 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.209 --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.209 | 10/27/2026 | sfvb internal testing |
88
+ | 4.1.208 | 10/26/2026 | sfvb internal testing |
87
89
  | 4.1.207 | 10/16/2026 | sfvb internal testing |
88
90
  | 4.1.206 | 10/16/2026 | sfvb internal testing |
89
91
  | 4.1.205 | 10/15/2026 | sfvb internal testing |
@@ -10,7 +10,7 @@
10
10
  * Do not edit the class manually.
11
11
  */
12
12
  import * as runtime from '../runtime';
13
- import { SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCampaign, SfvbCampaignsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbEmailRenderRequest, SfvbEmailRenderResponse, SfvbEventsAuthRequest, SfvbEventsAuthResponse, SfvbEventsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbFlow, SfvbFlowsResponse, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeBatchRequest, SfvbItemAttributeBatchResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaDescriptionRequest, SfvbItemMultimediaRequest, SfvbItemPricing, SfvbItemPricingRequest, SfvbItemRelated, SfvbItemRelatedRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbNotFoundEntry, SfvbNotFoundEntryResponse, SfvbNotFoundPage, SfvbNotFoundResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
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, 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;
@@ -231,6 +259,10 @@ export interface GetSfvbContainerVersionRequest {
231
259
  export interface GetSfvbElementRequest {
232
260
  elementType: string;
233
261
  }
262
+ export interface GetSfvbEmailRequest {
263
+ storefrontOid: number;
264
+ emailUuid: string;
265
+ }
234
266
  export interface GetSfvbEventsRequest {
235
267
  after?: string;
236
268
  storefrontOid?: number;
@@ -487,6 +519,12 @@ export interface ListSfvbCampaignsRequest {
487
519
  pageSize?: number;
488
520
  includeDeleted?: boolean;
489
521
  }
522
+ export interface ListSfvbCommsListsRequest {
523
+ storefrontOid: number;
524
+ }
525
+ export interface ListSfvbCommsSegmentsRequest {
526
+ storefrontOid: number;
527
+ }
490
528
  export interface ListSfvbContainerVersionsRequest {
491
529
  storefrontOid: number;
492
530
  ownerType?: string;
@@ -830,6 +868,12 @@ export interface UpdateSfvbBlogPostRequest {
830
868
  blogPostOid: number;
831
869
  blogPostRequest: SfvbBlogPostRequest;
832
870
  }
871
+ export interface UpdateSfvbCampaignRequest {
872
+ storefrontOid: number;
873
+ campaignUuid: string;
874
+ ifMatch: string;
875
+ campaignWriteRequest: SfvbCampaignWriteRequest;
876
+ }
833
877
  export interface UpdateSfvbCommsSendingDomainRequest {
834
878
  domain: string;
835
879
  sendingDomain: SfvbCommsSendingDomain;
@@ -837,6 +881,24 @@ export interface UpdateSfvbCommsSendingDomainRequest {
837
881
  export interface UpdateSfvbCommsTwilioAccountRequest {
838
882
  twilioAccount: SfvbCommsTwilioAccount;
839
883
  }
884
+ export interface UpdateSfvbEmailRequest {
885
+ storefrontOid: number;
886
+ emailUuid: string;
887
+ ifMatch: string;
888
+ emailUpdateRequest: SfvbEmailUpdateRequest;
889
+ }
890
+ export interface UpdateSfvbFlowRequest {
891
+ storefrontOid: number;
892
+ flowUuid: string;
893
+ ifMatch: string;
894
+ flowWriteRequest: SfvbFlowWriteRequest;
895
+ }
896
+ export interface UpdateSfvbFlowStatusRequest {
897
+ storefrontOid: number;
898
+ flowUuid: string;
899
+ ifMatch: string;
900
+ flowStatusRequest: SfvbFlowStatusRequest;
901
+ }
840
902
  export interface UpdateSfvbItemAttributeBatchRequest {
841
903
  storefrontOid: number;
842
904
  itemAttributeBatchRequest: SfvbItemAttributeBatchRequest;
@@ -918,6 +980,40 @@ export interface SfvbApiInterface {
918
980
  * Assign items to a page
919
981
  */
920
982
  addSfvbPageItems(requestParameters: AddSfvbPageItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageItemsResponse>;
983
+ /**
984
+ * 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.
985
+ * @summary Archive or unarchive a campaign
986
+ * @param {number} storefrontOid
987
+ * @param {string} campaignUuid
988
+ * @param {string} ifMatch hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
989
+ * @param {SfvbArchiveRequest} archiveRequest Whether to archive
990
+ * @param {*} [options] Override http request option.
991
+ * @throws {RequiredError}
992
+ * @memberof SfvbApiInterface
993
+ */
994
+ archiveSfvbCampaignRaw(requestParameters: ArchiveSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
995
+ /**
996
+ * 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.
997
+ * Archive or unarchive a campaign
998
+ */
999
+ archiveSfvbCampaign(requestParameters: ArchiveSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
1000
+ /**
1001
+ * 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.
1002
+ * @summary Archive or unarchive a flow
1003
+ * @param {number} storefrontOid
1004
+ * @param {string} flowUuid
1005
+ * @param {string} ifMatch hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
1006
+ * @param {SfvbArchiveRequest} archiveRequest Whether to archive
1007
+ * @param {*} [options] Override http request option.
1008
+ * @throws {RequiredError}
1009
+ * @memberof SfvbApiInterface
1010
+ */
1011
+ archiveSfvbFlowRaw(requestParameters: ArchiveSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
1012
+ /**
1013
+ * 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.
1014
+ * Archive or unarchive a flow
1015
+ */
1016
+ archiveSfvbFlow(requestParameters: ArchiveSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
921
1017
  /**
922
1018
  * 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.
923
1019
  * @summary Archive an upsell path
@@ -980,6 +1076,36 @@ export interface SfvbApiInterface {
980
1076
  * Remove a library entry\'s screenshot
981
1077
  */
982
1078
  clearSfvbLibraryScreenshot(requestParameters: ClearSfvbLibraryScreenshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
1079
+ /**
1080
+ * 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.
1081
+ * @summary Copy a campaign on the same storefront
1082
+ * @param {number} storefrontOid
1083
+ * @param {string} campaignUuid
1084
+ * @param {*} [options] Override http request option.
1085
+ * @throws {RequiredError}
1086
+ * @memberof SfvbApiInterface
1087
+ */
1088
+ cloneSfvbCampaignRaw(requestParameters: CloneSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
1089
+ /**
1090
+ * 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.
1091
+ * Copy a campaign on the same storefront
1092
+ */
1093
+ cloneSfvbCampaign(requestParameters: CloneSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
1094
+ /**
1095
+ * 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.
1096
+ * @summary Copy a flow on the same storefront
1097
+ * @param {number} storefrontOid
1098
+ * @param {string} flowUuid
1099
+ * @param {*} [options] Override http request option.
1100
+ * @throws {RequiredError}
1101
+ * @memberof SfvbApiInterface
1102
+ */
1103
+ cloneSfvbFlowRaw(requestParameters: CloneSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
1104
+ /**
1105
+ * 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.
1106
+ * Copy a flow on the same storefront
1107
+ */
1108
+ cloneSfvbFlow(requestParameters: CloneSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
983
1109
  /**
984
1110
  * 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.
985
1111
  * @summary Compile CJSON to Velocity
@@ -994,6 +1120,36 @@ export interface SfvbApiInterface {
994
1120
  * Compile CJSON to Velocity
995
1121
  */
996
1122
  compileSfvbCjson(requestParameters: CompileSfvbCjsonRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCompileResponse>;
1123
+ /**
1124
+ * 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.
1125
+ * @summary Create a draft campaign
1126
+ * @param {number} storefrontOid
1127
+ * @param {SfvbCampaignWriteRequest} campaignWriteRequest The campaign to create
1128
+ * @param {*} [options] Override http request option.
1129
+ * @throws {RequiredError}
1130
+ * @memberof SfvbApiInterface
1131
+ */
1132
+ createSfvbCampaignRaw(requestParameters: CreateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
1133
+ /**
1134
+ * 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.
1135
+ * Create a draft campaign
1136
+ */
1137
+ createSfvbCampaign(requestParameters: CreateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
1138
+ /**
1139
+ * 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.
1140
+ * @summary Create a draft flow
1141
+ * @param {number} storefrontOid
1142
+ * @param {SfvbFlowWriteRequest} flowWriteRequest The flow to create
1143
+ * @param {*} [options] Override http request option.
1144
+ * @throws {RequiredError}
1145
+ * @memberof SfvbApiInterface
1146
+ */
1147
+ createSfvbFlowRaw(requestParameters: CreateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
1148
+ /**
1149
+ * 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.
1150
+ * Create a draft flow
1151
+ */
1152
+ createSfvbFlow(requestParameters: CreateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
997
1153
  /**
998
1154
  * 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.
999
1155
  * @summary Save a fragment to the library
@@ -1683,6 +1839,21 @@ export interface SfvbApiInterface {
1683
1839
  * Configuration schema and field card for one element type
1684
1840
  */
1685
1841
  getSfvbElement(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementSchemaResponse>;
1842
+ /**
1843
+ * The subject, preview text and hash_sha256 to send as If-Match when updating them, with whether the email is live and its review state. The body is the email container (owner type email). Find the uuid in the storefront\'s campaigns and flows.
1844
+ * @summary Get a flow or campaign email\'s subject and preview text
1845
+ * @param {number} storefrontOid
1846
+ * @param {string} emailUuid
1847
+ * @param {*} [options] Override http request option.
1848
+ * @throws {RequiredError}
1849
+ * @memberof SfvbApiInterface
1850
+ */
1851
+ getSfvbEmailRaw(requestParameters: GetSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEmail>>;
1852
+ /**
1853
+ * The subject, preview text and hash_sha256 to send as If-Match when updating them, with whether the email is live and its review state. The body is the email container (owner type email). Find the uuid in the storefront\'s campaigns and flows.
1854
+ * Get a flow or campaign email\'s subject and preview text
1855
+ */
1856
+ getSfvbEmail(requestParameters: GetSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail>;
1686
1857
  /**
1687
1858
  * The signed-in person\'s events after the cursor, oldest first. Events are kept 72 hours; an older cursor returns resync_required, and then the caller re-lists what it was waiting on. Events about one sign-in\'s requests, such as approvals, are only returned to that sign-in. limit is 1 to 500, default 100.
1688
1859
  * @summary Replay events
@@ -2628,6 +2799,34 @@ export interface SfvbApiInterface {
2628
2799
  * List the storefront\'s campaigns
2629
2800
  */
2630
2801
  listSfvbCampaigns(requestParameters: ListSfvbCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaignsResponse>;
2802
+ /**
2803
+ * 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.
2804
+ * @summary List the storefront\'s email lists
2805
+ * @param {number} storefrontOid
2806
+ * @param {*} [options] Override http request option.
2807
+ * @throws {RequiredError}
2808
+ * @memberof SfvbApiInterface
2809
+ */
2810
+ listSfvbCommsListsRaw(requestParameters: ListSfvbCommsListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsListsResponse>>;
2811
+ /**
2812
+ * 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.
2813
+ * List the storefront\'s email lists
2814
+ */
2815
+ listSfvbCommsLists(requestParameters: ListSfvbCommsListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsListsResponse>;
2816
+ /**
2817
+ * 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.
2818
+ * @summary List the storefront\'s segments
2819
+ * @param {number} storefrontOid
2820
+ * @param {*} [options] Override http request option.
2821
+ * @throws {RequiredError}
2822
+ * @memberof SfvbApiInterface
2823
+ */
2824
+ listSfvbCommsSegmentsRaw(requestParameters: ListSfvbCommsSegmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSegmentsResponse>>;
2825
+ /**
2826
+ * 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.
2827
+ * List the storefront\'s segments
2828
+ */
2829
+ listSfvbCommsSegments(requestParameters: ListSfvbCommsSegmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSegmentsResponse>;
2631
2830
  /**
2632
2831
  * 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.
2633
2832
  * @summary Version history for a container stored outside the file system
@@ -3678,6 +3877,23 @@ export interface SfvbApiInterface {
3678
3877
  * Change a blog post
3679
3878
  */
3680
3879
  updateSfvbBlogPost(requestParameters: UpdateSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
3880
+ /**
3881
+ * 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.
3882
+ * @summary Change a campaign
3883
+ * @param {number} storefrontOid
3884
+ * @param {string} campaignUuid
3885
+ * @param {string} ifMatch hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
3886
+ * @param {SfvbCampaignWriteRequest} campaignWriteRequest The fields to change
3887
+ * @param {*} [options] Override http request option.
3888
+ * @throws {RequiredError}
3889
+ * @memberof SfvbApiInterface
3890
+ */
3891
+ updateSfvbCampaignRaw(requestParameters: UpdateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
3892
+ /**
3893
+ * 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.
3894
+ * Change a campaign
3895
+ */
3896
+ updateSfvbCampaign(requestParameters: UpdateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
3681
3897
  /**
3682
3898
  * 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.
3683
3899
  * @summary Update a sending domain
@@ -3707,6 +3923,57 @@ export interface SfvbApiInterface {
3707
3923
  * Update the Twilio account
3708
3924
  */
3709
3925
  updateSfvbCommsTwilioAccount(requestParameters: UpdateSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTwilioAccountResponse>;
3926
+ /**
3927
+ * A field left out keeps its value. Each is 5 to 150 characters on one line. Send the hash_sha256 you read as If-Match. An email in a sending flow or campaign needs sfvb_publish, as a body push does. The merchant\'s content review rule applies, so an email waiting for review or rejected goes back to needing review. An email suspended for spam is refused with sfvb.email_suspended.
3928
+ * @summary Change a flow or campaign email\'s subject or preview text
3929
+ * @param {number} storefrontOid
3930
+ * @param {string} emailUuid
3931
+ * @param {string} ifMatch hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
3932
+ * @param {SfvbEmailUpdateRequest} emailUpdateRequest The subject or preview text to change
3933
+ * @param {*} [options] Override http request option.
3934
+ * @throws {RequiredError}
3935
+ * @memberof SfvbApiInterface
3936
+ */
3937
+ updateSfvbEmailRaw(requestParameters: UpdateSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEmail>>;
3938
+ /**
3939
+ * A field left out keeps its value. Each is 5 to 150 characters on one line. Send the hash_sha256 you read as If-Match. An email in a sending flow or campaign needs sfvb_publish, as a body push does. The merchant\'s content review rule applies, so an email waiting for review or rejected goes back to needing review. An email suspended for spam is refused with sfvb.email_suspended.
3940
+ * Change a flow or campaign email\'s subject or preview text
3941
+ */
3942
+ updateSfvbEmail(requestParameters: UpdateSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail>;
3943
+ /**
3944
+ * 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.
3945
+ * @summary Change a flow
3946
+ * @param {number} storefrontOid
3947
+ * @param {string} flowUuid
3948
+ * @param {string} ifMatch hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
3949
+ * @param {SfvbFlowWriteRequest} flowWriteRequest The fields to change
3950
+ * @param {*} [options] Override http request option.
3951
+ * @throws {RequiredError}
3952
+ * @memberof SfvbApiInterface
3953
+ */
3954
+ updateSfvbFlowRaw(requestParameters: UpdateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
3955
+ /**
3956
+ * 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.
3957
+ * Change a flow
3958
+ */
3959
+ updateSfvbFlow(requestParameters: UpdateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
3960
+ /**
3961
+ * 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.
3962
+ * @summary Turn a flow on or off
3963
+ * @param {number} storefrontOid
3964
+ * @param {string} flowUuid
3965
+ * @param {string} ifMatch hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
3966
+ * @param {SfvbFlowStatusRequest} flowStatusRequest The status to set
3967
+ * @param {*} [options] Override http request option.
3968
+ * @throws {RequiredError}
3969
+ * @memberof SfvbApiInterface
3970
+ */
3971
+ updateSfvbFlowStatusRaw(requestParameters: UpdateSfvbFlowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
3972
+ /**
3973
+ * 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.
3974
+ * Turn a flow on or off
3975
+ */
3976
+ updateSfvbFlowStatus(requestParameters: UpdateSfvbFlowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
3710
3977
  /**
3711
3978
  * 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.
3712
3979
  * @summary Change attributes across many items in one call
@@ -3862,6 +4129,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
3862
4129
  * Assign items to a page
3863
4130
  */
3864
4131
  addSfvbPageItems(requestParameters: AddSfvbPageItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageItemsResponse>;
4132
+ /**
4133
+ * 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.
4134
+ * Archive or unarchive a campaign
4135
+ */
4136
+ archiveSfvbCampaignRaw(requestParameters: ArchiveSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
4137
+ /**
4138
+ * 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.
4139
+ * Archive or unarchive a campaign
4140
+ */
4141
+ archiveSfvbCampaign(requestParameters: ArchiveSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
4142
+ /**
4143
+ * 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.
4144
+ * Archive or unarchive a flow
4145
+ */
4146
+ archiveSfvbFlowRaw(requestParameters: ArchiveSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
4147
+ /**
4148
+ * 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.
4149
+ * Archive or unarchive a flow
4150
+ */
4151
+ archiveSfvbFlow(requestParameters: ArchiveSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
3865
4152
  /**
3866
4153
  * 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.
3867
4154
  * Archive an upsell path
@@ -3902,6 +4189,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
3902
4189
  * Remove a library entry\'s screenshot
3903
4190
  */
3904
4191
  clearSfvbLibraryScreenshot(requestParameters: ClearSfvbLibraryScreenshotRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbLibraryEntry>;
4192
+ /**
4193
+ * 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.
4194
+ * Copy a campaign on the same storefront
4195
+ */
4196
+ cloneSfvbCampaignRaw(requestParameters: CloneSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
4197
+ /**
4198
+ * 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.
4199
+ * Copy a campaign on the same storefront
4200
+ */
4201
+ cloneSfvbCampaign(requestParameters: CloneSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
4202
+ /**
4203
+ * 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.
4204
+ * Copy a flow on the same storefront
4205
+ */
4206
+ cloneSfvbFlowRaw(requestParameters: CloneSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
4207
+ /**
4208
+ * 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.
4209
+ * Copy a flow on the same storefront
4210
+ */
4211
+ cloneSfvbFlow(requestParameters: CloneSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
3905
4212
  /**
3906
4213
  * 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.
3907
4214
  * Compile CJSON to Velocity
@@ -3912,6 +4219,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
3912
4219
  * Compile CJSON to Velocity
3913
4220
  */
3914
4221
  compileSfvbCjson(requestParameters: CompileSfvbCjsonRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCompileResponse>;
4222
+ /**
4223
+ * 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.
4224
+ * Create a draft campaign
4225
+ */
4226
+ createSfvbCampaignRaw(requestParameters: CreateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
4227
+ /**
4228
+ * 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.
4229
+ * Create a draft campaign
4230
+ */
4231
+ createSfvbCampaign(requestParameters: CreateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
4232
+ /**
4233
+ * 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.
4234
+ * Create a draft flow
4235
+ */
4236
+ createSfvbFlowRaw(requestParameters: CreateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
4237
+ /**
4238
+ * 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.
4239
+ * Create a draft flow
4240
+ */
4241
+ createSfvbFlow(requestParameters: CreateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
3915
4242
  /**
3916
4243
  * 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.
3917
4244
  * Save a fragment to the library
@@ -4360,6 +4687,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
4360
4687
  * Configuration schema and field card for one element type
4361
4688
  */
4362
4689
  getSfvbElement(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementSchemaResponse>;
4690
+ /**
4691
+ * The subject, preview text and hash_sha256 to send as If-Match when updating them, with whether the email is live and its review state. The body is the email container (owner type email). Find the uuid in the storefront\'s campaigns and flows.
4692
+ * Get a flow or campaign email\'s subject and preview text
4693
+ */
4694
+ getSfvbEmailRaw(requestParameters: GetSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEmail>>;
4695
+ /**
4696
+ * The subject, preview text and hash_sha256 to send as If-Match when updating them, with whether the email is live and its review state. The body is the email container (owner type email). Find the uuid in the storefront\'s campaigns and flows.
4697
+ * Get a flow or campaign email\'s subject and preview text
4698
+ */
4699
+ getSfvbEmail(requestParameters: GetSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail>;
4363
4700
  /**
4364
4701
  * The signed-in person\'s events after the cursor, oldest first. Events are kept 72 hours; an older cursor returns resync_required, and then the caller re-lists what it was waiting on. Events about one sign-in\'s requests, such as approvals, are only returned to that sign-in. limit is 1 to 500, default 100.
4365
4702
  * Replay events
@@ -4978,6 +5315,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
4978
5315
  * List the storefront\'s campaigns
4979
5316
  */
4980
5317
  listSfvbCampaigns(requestParameters: ListSfvbCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaignsResponse>;
5318
+ /**
5319
+ * 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.
5320
+ * List the storefront\'s email lists
5321
+ */
5322
+ listSfvbCommsListsRaw(requestParameters: ListSfvbCommsListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsListsResponse>>;
5323
+ /**
5324
+ * 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.
5325
+ * List the storefront\'s email lists
5326
+ */
5327
+ listSfvbCommsLists(requestParameters: ListSfvbCommsListsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsListsResponse>;
5328
+ /**
5329
+ * 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.
5330
+ * List the storefront\'s segments
5331
+ */
5332
+ listSfvbCommsSegmentsRaw(requestParameters: ListSfvbCommsSegmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSegmentsResponse>>;
5333
+ /**
5334
+ * 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.
5335
+ * List the storefront\'s segments
5336
+ */
5337
+ listSfvbCommsSegments(requestParameters: ListSfvbCommsSegmentsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSegmentsResponse>;
4981
5338
  /**
4982
5339
  * 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.
4983
5340
  * Version history for a container stored outside the file system
@@ -5616,6 +5973,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
5616
5973
  * Change a blog post
5617
5974
  */
5618
5975
  updateSfvbBlogPost(requestParameters: UpdateSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
5976
+ /**
5977
+ * 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.
5978
+ * Change a campaign
5979
+ */
5980
+ updateSfvbCampaignRaw(requestParameters: UpdateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
5981
+ /**
5982
+ * 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.
5983
+ * Change a campaign
5984
+ */
5985
+ updateSfvbCampaign(requestParameters: UpdateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
5619
5986
  /**
5620
5987
  * 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.
5621
5988
  * Update a sending domain
@@ -5636,6 +6003,36 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
5636
6003
  * Update the Twilio account
5637
6004
  */
5638
6005
  updateSfvbCommsTwilioAccount(requestParameters: UpdateSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTwilioAccountResponse>;
6006
+ /**
6007
+ * A field left out keeps its value. Each is 5 to 150 characters on one line. Send the hash_sha256 you read as If-Match. An email in a sending flow or campaign needs sfvb_publish, as a body push does. The merchant\'s content review rule applies, so an email waiting for review or rejected goes back to needing review. An email suspended for spam is refused with sfvb.email_suspended.
6008
+ * Change a flow or campaign email\'s subject or preview text
6009
+ */
6010
+ updateSfvbEmailRaw(requestParameters: UpdateSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEmail>>;
6011
+ /**
6012
+ * A field left out keeps its value. Each is 5 to 150 characters on one line. Send the hash_sha256 you read as If-Match. An email in a sending flow or campaign needs sfvb_publish, as a body push does. The merchant\'s content review rule applies, so an email waiting for review or rejected goes back to needing review. An email suspended for spam is refused with sfvb.email_suspended.
6013
+ * Change a flow or campaign email\'s subject or preview text
6014
+ */
6015
+ updateSfvbEmail(requestParameters: UpdateSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail>;
6016
+ /**
6017
+ * 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.
6018
+ * Change a flow
6019
+ */
6020
+ updateSfvbFlowRaw(requestParameters: UpdateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
6021
+ /**
6022
+ * 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.
6023
+ * Change a flow
6024
+ */
6025
+ updateSfvbFlow(requestParameters: UpdateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
6026
+ /**
6027
+ * 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.
6028
+ * Turn a flow on or off
6029
+ */
6030
+ updateSfvbFlowStatusRaw(requestParameters: UpdateSfvbFlowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
6031
+ /**
6032
+ * 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.
6033
+ * Turn a flow on or off
6034
+ */
6035
+ updateSfvbFlowStatus(requestParameters: UpdateSfvbFlowStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
5639
6036
  /**
5640
6037
  * 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.
5641
6038
  * Change attributes across many items in one call