ultracart_rest_api_v2_typescript 4.1.229 → 4.1.230
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.
- package/.openapi-generator/FILES +8 -0
- package/README.md +3 -2
- package/dist/apis/SfvbApi.d.ts +307 -5
- package/dist/apis/SfvbApi.js +698 -37
- package/dist/models/ItemAutoOrder.d.ts +18 -0
- package/dist/models/ItemAutoOrder.js +6 -0
- package/dist/models/SfvbCommsFolder.d.ts +61 -0
- package/dist/models/SfvbCommsFolder.js +60 -0
- package/dist/models/SfvbCommsFolderItem.d.ts +43 -0
- package/dist/models/SfvbCommsFolderItem.js +54 -0
- package/dist/models/SfvbCommsFolderResponse.d.ts +45 -0
- package/dist/models/SfvbCommsFolderResponse.js +56 -0
- package/dist/models/SfvbCommsFolderWriteRequest.d.ts +31 -0
- package/dist/models/SfvbCommsFolderWriteRequest.js +50 -0
- package/dist/models/SfvbCommsFoldersResponse.d.ts +32 -0
- package/dist/models/SfvbCommsFoldersResponse.js +51 -0
- package/dist/models/SfvbCommsListDetail.d.ts +80 -0
- package/dist/models/SfvbCommsListDetail.js +67 -0
- package/dist/models/SfvbCommsListResponse.d.ts +38 -0
- package/dist/models/SfvbCommsListResponse.js +53 -0
- package/dist/models/SfvbCommsListWriteRequest.d.ts +49 -0
- package/dist/models/SfvbCommsListWriteRequest.js +56 -0
- package/dist/models/SfvbFlowWriteRequest.d.ts +2 -2
- package/dist/models/SfvbSequenceStep.d.ts +1 -1
- package/dist/models/SfvbStepCounts.d.ts +1 -1
- package/dist/models/index.d.ts +8 -0
- package/dist/models/index.js +8 -0
- package/package.json +1 -1
- package/src/apis/SfvbApi.ts +757 -4
- package/src/models/ItemAutoOrder.ts +24 -0
- package/src/models/SfvbCommsFolder.ts +107 -0
- package/src/models/SfvbCommsFolderItem.ts +83 -0
- package/src/models/SfvbCommsFolderResponse.ts +96 -0
- package/src/models/SfvbCommsFolderWriteRequest.ts +67 -0
- package/src/models/SfvbCommsFoldersResponse.ts +74 -0
- package/src/models/SfvbCommsListDetail.ts +138 -0
- package/src/models/SfvbCommsListResponse.ts +82 -0
- package/src/models/SfvbCommsListWriteRequest.ts +91 -0
- package/src/models/SfvbFlowWriteRequest.ts +2 -2
- package/src/models/SfvbSequenceStep.ts +1 -1
- package/src/models/SfvbStepCounts.ts +1 -1
- package/src/models/index.ts +8 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -1019,7 +1019,15 @@ src/models/SfvbCodeLibraryEmail.ts
|
|
|
1019
1019
|
src/models/SfvbCodeLibraryEmailsResponse.ts
|
|
1020
1020
|
src/models/SfvbCommsDnsRecord.ts
|
|
1021
1021
|
src/models/SfvbCommsEmail.ts
|
|
1022
|
+
src/models/SfvbCommsFolder.ts
|
|
1023
|
+
src/models/SfvbCommsFolderItem.ts
|
|
1024
|
+
src/models/SfvbCommsFolderResponse.ts
|
|
1025
|
+
src/models/SfvbCommsFolderWriteRequest.ts
|
|
1026
|
+
src/models/SfvbCommsFoldersResponse.ts
|
|
1022
1027
|
src/models/SfvbCommsList.ts
|
|
1028
|
+
src/models/SfvbCommsListDetail.ts
|
|
1029
|
+
src/models/SfvbCommsListResponse.ts
|
|
1030
|
+
src/models/SfvbCommsListWriteRequest.ts
|
|
1023
1031
|
src/models/SfvbCommsListsResponse.ts
|
|
1024
1032
|
src/models/SfvbCommsPostcard.ts
|
|
1025
1033
|
src/models/SfvbCommsSegment.ts
|
package/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# UltraCart Typescript SDK
|
|
2
|
-
## ultracart_rest_api_v2_typescript@4.1.
|
|
2
|
+
## ultracart_rest_api_v2_typescript@4.1.230
|
|
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.
|
|
9
|
+
npm install ultracart_rest_api_v2_typescript@4.1.230 --save
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
@@ -84,6 +84,7 @@ Not every change is committed to every SDK.
|
|
|
84
84
|
|
|
85
85
|
| Version | Date | Comments |
|
|
86
86
|
| --: | :-: | --- |
|
|
87
|
+
| 4.1.230 | 11/05/2026 | sfvb internal testing |
|
|
87
88
|
| 4.1.229 | 11/04/2026 | sfvb internal testing |
|
|
88
89
|
| 4.1.228 | 11/04/2026 | sfvb internal testing |
|
|
89
90
|
| 4.1.227 | 11/04/2026 | sfvb internal testing |
|
package/dist/apis/SfvbApi.d.ts
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { SfvbAffiliateNetwork, SfvbAffiliateNetworkRequest, SfvbAffiliateNetworksResponse, SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbArchiveRequest, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCampaign, SfvbCampaignWriteRequest, SfvbCampaignsResponse, SfvbCodeLibraryEmailsResponse, SfvbCommsListsResponse, SfvbCommsSegmentResponse, SfvbCommsSegmentWriteRequest, SfvbCommsSegmentsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbEmail, SfvbEmailRenderRequest, SfvbEmailRenderResponse, SfvbEmailReviewRequest, SfvbEmailUpdateRequest, SfvbEventsAuthRequest, SfvbEventsAuthResponse, SfvbEventsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbFlow, SfvbFlowStatusRequest, SfvbFlowWriteRequest, SfvbFlowsResponse, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeBatchRequest, SfvbItemAttributeBatchResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaDescriptionRequest, SfvbItemMultimediaRequest, SfvbItemPricing, SfvbItemPricingRequest, SfvbItemRelated, SfvbItemRelatedRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbNotFoundEntry, SfvbNotFoundEntryResponse, SfvbNotFoundPage, SfvbNotFoundResponse, SfvbNotFoundSummary, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPostcardProofRequest, SfvbPostcardProofResponse, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveBatchRequest, SfvbRedirectResolveBatchResponse, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbSequence, SfvbSequenceStepCreateRequest, SfvbSequenceStepCreateResponse, SfvbSequenceStepDeleteResponse, SfvbSequenceStepMoveRequest, SfvbSequenceStepMoveResponse, SfvbSequenceStepUpdateRequest, SfvbSequenceStepUpdateResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbSiteSeo, SfvbSiteSeoRequest, SfvbSitemapsResponse, SfvbSmartAttribution, SfvbSmartAttributionRequest, SfvbStepDispatchLogsResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTrackingAdvancedRequest, SfvbTrackingHtml, SfvbTrackingHtmlRequest, SfvbTrackingHtmlResponse, SfvbTrackingPrivacyRequest, SfvbTrackingProvider, SfvbTrackingProviderRequest, SfvbTrackingProvidersResponse, SfvbTrackingSettingsResponse, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbUtmShortcode, SfvbUtmShortcodeRequest, SfvbUtmShortcodesResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
|
|
13
|
+
import { SfvbAffiliateNetwork, SfvbAffiliateNetworkRequest, SfvbAffiliateNetworksResponse, SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbArchiveRequest, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCampaign, SfvbCampaignWriteRequest, SfvbCampaignsResponse, SfvbCodeLibraryEmailsResponse, SfvbCommsFolderResponse, SfvbCommsFolderWriteRequest, SfvbCommsFoldersResponse, SfvbCommsListResponse, SfvbCommsListWriteRequest, SfvbCommsListsResponse, SfvbCommsSegmentResponse, SfvbCommsSegmentWriteRequest, SfvbCommsSegmentsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbEmail, SfvbEmailRenderRequest, SfvbEmailRenderResponse, SfvbEmailReviewRequest, SfvbEmailUpdateRequest, SfvbEventsAuthRequest, SfvbEventsAuthResponse, SfvbEventsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbFlow, SfvbFlowStatusRequest, SfvbFlowWriteRequest, SfvbFlowsResponse, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeBatchRequest, SfvbItemAttributeBatchResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaDescriptionRequest, SfvbItemMultimediaRequest, SfvbItemPricing, SfvbItemPricingRequest, SfvbItemRelated, SfvbItemRelatedRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbNotFoundEntry, SfvbNotFoundEntryResponse, SfvbNotFoundPage, SfvbNotFoundResponse, SfvbNotFoundSummary, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPostcardProofRequest, SfvbPostcardProofResponse, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveBatchRequest, SfvbRedirectResolveBatchResponse, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbSequence, SfvbSequenceStepCreateRequest, SfvbSequenceStepCreateResponse, SfvbSequenceStepDeleteResponse, SfvbSequenceStepMoveRequest, SfvbSequenceStepMoveResponse, SfvbSequenceStepUpdateRequest, SfvbSequenceStepUpdateResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbSiteSeo, SfvbSiteSeoRequest, SfvbSitemapsResponse, SfvbSmartAttribution, SfvbSmartAttributionRequest, SfvbStepDispatchLogsResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTrackingAdvancedRequest, SfvbTrackingHtml, SfvbTrackingHtmlRequest, SfvbTrackingHtmlResponse, SfvbTrackingPrivacyRequest, SfvbTrackingProvider, SfvbTrackingProviderRequest, SfvbTrackingProvidersResponse, SfvbTrackingSettingsResponse, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbUtmShortcode, SfvbUtmShortcodeRequest, SfvbUtmShortcodesResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
|
|
14
14
|
export interface AddSfvbPageBlogPostsRequest {
|
|
15
15
|
storefrontOid: number;
|
|
16
16
|
path: string;
|
|
@@ -27,6 +27,16 @@ export interface ArchiveSfvbCampaignRequest {
|
|
|
27
27
|
ifMatch: string;
|
|
28
28
|
archiveRequest: SfvbArchiveRequest;
|
|
29
29
|
}
|
|
30
|
+
export interface ArchiveSfvbCommsListRequest {
|
|
31
|
+
storefrontOid: number;
|
|
32
|
+
listUuid: string;
|
|
33
|
+
ifMatch: string;
|
|
34
|
+
}
|
|
35
|
+
export interface ArchiveSfvbCommsSegmentRequest {
|
|
36
|
+
storefrontOid: number;
|
|
37
|
+
segmentUuid: string;
|
|
38
|
+
ifMatch: string;
|
|
39
|
+
}
|
|
30
40
|
export interface ArchiveSfvbFlowRequest {
|
|
31
41
|
storefrontOid: number;
|
|
32
42
|
flowUuid: string;
|
|
@@ -95,6 +105,11 @@ export interface DeleteSfvbBlogPostRequest {
|
|
|
95
105
|
blogPostOid: number;
|
|
96
106
|
approvalId?: string;
|
|
97
107
|
}
|
|
108
|
+
export interface DeleteSfvbCommsFolderRequest {
|
|
109
|
+
storefrontOid: number;
|
|
110
|
+
folderUuid: string;
|
|
111
|
+
ifMatch: string;
|
|
112
|
+
}
|
|
98
113
|
export interface DeleteSfvbCommsSendingDomainRequest {
|
|
99
114
|
domain: string;
|
|
100
115
|
approvalId?: string;
|
|
@@ -291,6 +306,17 @@ export interface GetSfvbCampaignRequest {
|
|
|
291
306
|
export interface GetSfvbCjsonUsedElementsRequest {
|
|
292
307
|
compileRequest: SfvbCompileRequest;
|
|
293
308
|
}
|
|
309
|
+
export interface GetSfvbCommsFolderRequest {
|
|
310
|
+
storefrontOid: number;
|
|
311
|
+
folderUuid: string;
|
|
312
|
+
}
|
|
313
|
+
export interface GetSfvbCommsFoldersRequest {
|
|
314
|
+
storefrontOid: number;
|
|
315
|
+
}
|
|
316
|
+
export interface GetSfvbCommsListRequest {
|
|
317
|
+
storefrontOid: number;
|
|
318
|
+
listUuid: string;
|
|
319
|
+
}
|
|
294
320
|
export interface GetSfvbCommsSegmentRequest {
|
|
295
321
|
storefrontOid: number;
|
|
296
322
|
segmentUuid: string;
|
|
@@ -587,6 +613,14 @@ export interface InsertSfvbBlogPostRequest {
|
|
|
587
613
|
storefrontOid: number;
|
|
588
614
|
blogPostRequest: SfvbBlogPostRequest;
|
|
589
615
|
}
|
|
616
|
+
export interface InsertSfvbCommsFolderRequest {
|
|
617
|
+
storefrontOid: number;
|
|
618
|
+
folderWriteRequest: SfvbCommsFolderWriteRequest;
|
|
619
|
+
}
|
|
620
|
+
export interface InsertSfvbCommsListRequest {
|
|
621
|
+
storefrontOid: number;
|
|
622
|
+
listWriteRequest: SfvbCommsListWriteRequest;
|
|
623
|
+
}
|
|
590
624
|
export interface InsertSfvbCommsSegmentRequest {
|
|
591
625
|
storefrontOid: number;
|
|
592
626
|
segmentWriteRequest: SfvbCommsSegmentWriteRequest;
|
|
@@ -1033,6 +1067,18 @@ export interface UpdateSfvbCampaignRequest {
|
|
|
1033
1067
|
ifMatch: string;
|
|
1034
1068
|
campaignWriteRequest: SfvbCampaignWriteRequest;
|
|
1035
1069
|
}
|
|
1070
|
+
export interface UpdateSfvbCommsFolderRequest {
|
|
1071
|
+
storefrontOid: number;
|
|
1072
|
+
folderUuid: string;
|
|
1073
|
+
ifMatch: string;
|
|
1074
|
+
folderWriteRequest: SfvbCommsFolderWriteRequest;
|
|
1075
|
+
}
|
|
1076
|
+
export interface UpdateSfvbCommsListRequest {
|
|
1077
|
+
storefrontOid: number;
|
|
1078
|
+
listUuid: string;
|
|
1079
|
+
ifMatch: string;
|
|
1080
|
+
listWriteRequest: SfvbCommsListWriteRequest;
|
|
1081
|
+
}
|
|
1036
1082
|
export interface UpdateSfvbCommsSegmentRequest {
|
|
1037
1083
|
storefrontOid: number;
|
|
1038
1084
|
segmentUuid: string;
|
|
@@ -1213,6 +1259,38 @@ export interface SfvbApiInterface {
|
|
|
1213
1259
|
* Archive or unarchive a campaign
|
|
1214
1260
|
*/
|
|
1215
1261
|
archiveSfvbCampaign(requestParameters: ArchiveSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
|
|
1262
|
+
/**
|
|
1263
|
+
* Hides the list from the lists list and the admin, and keeps its members. Refused with sfvb.in_use_live, naming each one, while a live campaign or flow uses it; notes names any that use it but aren\'t live, which can no longer use it. Send the list\'s hash_sha256 as If-Match.
|
|
1264
|
+
* @summary Archive an email list
|
|
1265
|
+
* @param {number} storefrontOid
|
|
1266
|
+
* @param {string} listUuid
|
|
1267
|
+
* @param {string} ifMatch The list\'s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
1268
|
+
* @param {*} [options] Override http request option.
|
|
1269
|
+
* @throws {RequiredError}
|
|
1270
|
+
* @memberof SfvbApiInterface
|
|
1271
|
+
*/
|
|
1272
|
+
archiveSfvbCommsListRaw(requestParameters: ArchiveSfvbCommsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsListResponse>>;
|
|
1273
|
+
/**
|
|
1274
|
+
* Hides the list from the lists list and the admin, and keeps its members. Refused with sfvb.in_use_live, naming each one, while a live campaign or flow uses it; notes names any that use it but aren\'t live, which can no longer use it. Send the list\'s hash_sha256 as If-Match.
|
|
1275
|
+
* Archive an email list
|
|
1276
|
+
*/
|
|
1277
|
+
archiveSfvbCommsList(requestParameters: ArchiveSfvbCommsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsListResponse>;
|
|
1278
|
+
/**
|
|
1279
|
+
* Hides the segment from the segments list and the admin. Refused with sfvb.in_use_live, naming each one, while a live campaign or flow uses it; notes names any that use it but aren\'t live, which can no longer use it. Send the segment\'s hash_sha256 as If-Match.
|
|
1280
|
+
* @summary Archive a segment
|
|
1281
|
+
* @param {number} storefrontOid
|
|
1282
|
+
* @param {string} segmentUuid
|
|
1283
|
+
* @param {string} ifMatch The segment\'s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
1284
|
+
* @param {*} [options] Override http request option.
|
|
1285
|
+
* @throws {RequiredError}
|
|
1286
|
+
* @memberof SfvbApiInterface
|
|
1287
|
+
*/
|
|
1288
|
+
archiveSfvbCommsSegmentRaw(requestParameters: ArchiveSfvbCommsSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSegmentResponse>>;
|
|
1289
|
+
/**
|
|
1290
|
+
* Hides the segment from the segments list and the admin. Refused with sfvb.in_use_live, naming each one, while a live campaign or flow uses it; notes names any that use it but aren\'t live, which can no longer use it. Send the segment\'s hash_sha256 as If-Match.
|
|
1291
|
+
* Archive a segment
|
|
1292
|
+
*/
|
|
1293
|
+
archiveSfvbCommsSegment(requestParameters: ArchiveSfvbCommsSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSegmentResponse>;
|
|
1216
1294
|
/**
|
|
1217
1295
|
* 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.
|
|
1218
1296
|
* @summary Archive or unarchive a flow
|
|
@@ -1457,6 +1535,22 @@ export interface SfvbApiInterface {
|
|
|
1457
1535
|
* Delete a blog post
|
|
1458
1536
|
*/
|
|
1459
1537
|
deleteSfvbBlogPost(requestParameters: DeleteSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
1538
|
+
/**
|
|
1539
|
+
* Its lists and segments are kept and filed under no folder, as the admin does; items names each one. Send the folder\'s hash_sha256 as If-Match. A folder the admin made itself (system_generated) can\'t be deleted here.
|
|
1540
|
+
* @summary Delete a list and segment folder
|
|
1541
|
+
* @param {number} storefrontOid
|
|
1542
|
+
* @param {string} folderUuid
|
|
1543
|
+
* @param {string} ifMatch The folder\'s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
1544
|
+
* @param {*} [options] Override http request option.
|
|
1545
|
+
* @throws {RequiredError}
|
|
1546
|
+
* @memberof SfvbApiInterface
|
|
1547
|
+
*/
|
|
1548
|
+
deleteSfvbCommsFolderRaw(requestParameters: DeleteSfvbCommsFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsFolderResponse>>;
|
|
1549
|
+
/**
|
|
1550
|
+
* Its lists and segments are kept and filed under no folder, as the admin does; items names each one. Send the folder\'s hash_sha256 as If-Match. A folder the admin made itself (system_generated) can\'t be deleted here.
|
|
1551
|
+
* Delete a list and segment folder
|
|
1552
|
+
*/
|
|
1553
|
+
deleteSfvbCommsFolder(requestParameters: DeleteSfvbCommsFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsFolderResponse>;
|
|
1460
1554
|
/**
|
|
1461
1555
|
* Removes the domain from UltraCart and from Amazon SES. Needs an approved sending_domain.delete request for it (POST approvals, params.domain).
|
|
1462
1556
|
* @summary Remove a sending domain
|
|
@@ -2138,6 +2232,50 @@ export interface SfvbApiInterface {
|
|
|
2138
2232
|
* Element types used by a container
|
|
2139
2233
|
*/
|
|
2140
2234
|
getSfvbCjsonUsedElements(requestParameters: GetSfvbCjsonUsedElementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementsResponse>;
|
|
2235
|
+
/**
|
|
2236
|
+
* The folder, with the name and uuid of each list and segment filed in it.
|
|
2237
|
+
* @summary Read one list and segment folder
|
|
2238
|
+
* @param {number} storefrontOid
|
|
2239
|
+
* @param {string} folderUuid
|
|
2240
|
+
* @param {*} [options] Override http request option.
|
|
2241
|
+
* @throws {RequiredError}
|
|
2242
|
+
* @memberof SfvbApiInterface
|
|
2243
|
+
*/
|
|
2244
|
+
getSfvbCommsFolderRaw(requestParameters: GetSfvbCommsFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsFolderResponse>>;
|
|
2245
|
+
/**
|
|
2246
|
+
* The folder, with the name and uuid of each list and segment filed in it.
|
|
2247
|
+
* Read one list and segment folder
|
|
2248
|
+
*/
|
|
2249
|
+
getSfvbCommsFolder(requestParameters: GetSfvbCommsFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsFolderResponse>;
|
|
2250
|
+
/**
|
|
2251
|
+
* Each folder with how many lists and segments are filed in it, whether the admin made it, and its hash_sha256.
|
|
2252
|
+
* @summary List the list and segment folders
|
|
2253
|
+
* @param {number} storefrontOid
|
|
2254
|
+
* @param {*} [options] Override http request option.
|
|
2255
|
+
* @throws {RequiredError}
|
|
2256
|
+
* @memberof SfvbApiInterface
|
|
2257
|
+
*/
|
|
2258
|
+
getSfvbCommsFoldersRaw(requestParameters: GetSfvbCommsFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsFoldersResponse>>;
|
|
2259
|
+
/**
|
|
2260
|
+
* Each folder with how many lists and segments are filed in it, whether the admin made it, and its hash_sha256.
|
|
2261
|
+
* List the list and segment folders
|
|
2262
|
+
*/
|
|
2263
|
+
getSfvbCommsFolders(requestParameters: GetSfvbCommsFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsFoldersResponse>;
|
|
2264
|
+
/**
|
|
2265
|
+
* The list\'s name, folder, member count, public settings, and the campaigns and flows that use it, each with whether it is live. hash_sha256 is the If-Match for a change or an archive. Never its members.
|
|
2266
|
+
* @summary Read one email list
|
|
2267
|
+
* @param {number} storefrontOid
|
|
2268
|
+
* @param {string} listUuid
|
|
2269
|
+
* @param {*} [options] Override http request option.
|
|
2270
|
+
* @throws {RequiredError}
|
|
2271
|
+
* @memberof SfvbApiInterface
|
|
2272
|
+
*/
|
|
2273
|
+
getSfvbCommsListRaw(requestParameters: GetSfvbCommsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsListResponse>>;
|
|
2274
|
+
/**
|
|
2275
|
+
* The list\'s name, folder, member count, public settings, and the campaigns and flows that use it, each with whether it is live. hash_sha256 is the If-Match for a change or an archive. Never its members.
|
|
2276
|
+
* Read one email list
|
|
2277
|
+
*/
|
|
2278
|
+
getSfvbCommsList(requestParameters: GetSfvbCommsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsListResponse>;
|
|
2141
2279
|
/**
|
|
2142
2280
|
* The segment\'s name, folder, rule, member count at its last rebuild, whether a rebuild is still due, and the campaigns and flows that use it, each with whether it is live. hash_sha256 is the If-Match for an update. Never its members, its Facebook audience, its ranking or its third party sync settings.
|
|
2143
2281
|
* @summary Read one segment, with its rule
|
|
@@ -3259,6 +3397,36 @@ export interface SfvbApiInterface {
|
|
|
3259
3397
|
* Create a blog post
|
|
3260
3398
|
*/
|
|
3261
3399
|
insertSfvbBlogPost(requestParameters: InsertSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
|
|
3400
|
+
/**
|
|
3401
|
+
* A new, empty folder. File a list or segment in it by setting its folder_uuid.
|
|
3402
|
+
* @summary Create a list and segment folder
|
|
3403
|
+
* @param {number} storefrontOid
|
|
3404
|
+
* @param {SfvbCommsFolderWriteRequest} folderWriteRequest The new folder\'s name
|
|
3405
|
+
* @param {*} [options] Override http request option.
|
|
3406
|
+
* @throws {RequiredError}
|
|
3407
|
+
* @memberof SfvbApiInterface
|
|
3408
|
+
*/
|
|
3409
|
+
insertSfvbCommsFolderRaw(requestParameters: InsertSfvbCommsFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsFolderResponse>>;
|
|
3410
|
+
/**
|
|
3411
|
+
* A new, empty folder. File a list or segment in it by setting its folder_uuid.
|
|
3412
|
+
* Create a list and segment folder
|
|
3413
|
+
*/
|
|
3414
|
+
insertSfvbCommsFolder(requestParameters: InsertSfvbCommsFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsFolderResponse>;
|
|
3415
|
+
/**
|
|
3416
|
+
* A new, empty list with the name, folder and public settings given. public_description is plain text, since subscribers see it on the email preferences page.
|
|
3417
|
+
* @summary Create an email list
|
|
3418
|
+
* @param {number} storefrontOid
|
|
3419
|
+
* @param {SfvbCommsListWriteRequest} listWriteRequest The new list\'s name, folder and public settings
|
|
3420
|
+
* @param {*} [options] Override http request option.
|
|
3421
|
+
* @throws {RequiredError}
|
|
3422
|
+
* @memberof SfvbApiInterface
|
|
3423
|
+
*/
|
|
3424
|
+
insertSfvbCommsListRaw(requestParameters: InsertSfvbCommsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsListResponse>>;
|
|
3425
|
+
/**
|
|
3426
|
+
* A new, empty list with the name, folder and public settings given. public_description is plain text, since subscribers see it on the email preferences page.
|
|
3427
|
+
* Create an email list
|
|
3428
|
+
*/
|
|
3429
|
+
insertSfvbCommsList(requestParameters: InsertSfvbCommsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsListResponse>;
|
|
3262
3430
|
/**
|
|
3263
3431
|
* A new segment with the name, rule and folder given. The rule needs at least one group, each with at least one function of a rule type the segment rebuild knows, and any list or segment it names must be on this storefront. The segment starts empty and rebuilds in the background; member_count is out of date until rebuild_required is false.
|
|
3264
3432
|
* @summary Create a segment
|
|
@@ -4654,6 +4822,40 @@ export interface SfvbApiInterface {
|
|
|
4654
4822
|
* Change a campaign
|
|
4655
4823
|
*/
|
|
4656
4824
|
updateSfvbCampaign(requestParameters: UpdateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
|
|
4825
|
+
/**
|
|
4826
|
+
* Send the folder\'s hash_sha256 as If-Match. A folder the admin made itself (system_generated) can\'t be renamed here.
|
|
4827
|
+
* @summary Rename a list and segment folder
|
|
4828
|
+
* @param {number} storefrontOid
|
|
4829
|
+
* @param {string} folderUuid
|
|
4830
|
+
* @param {string} ifMatch The folder\'s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
4831
|
+
* @param {SfvbCommsFolderWriteRequest} folderWriteRequest The new name
|
|
4832
|
+
* @param {*} [options] Override http request option.
|
|
4833
|
+
* @throws {RequiredError}
|
|
4834
|
+
* @memberof SfvbApiInterface
|
|
4835
|
+
*/
|
|
4836
|
+
updateSfvbCommsFolderRaw(requestParameters: UpdateSfvbCommsFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsFolderResponse>>;
|
|
4837
|
+
/**
|
|
4838
|
+
* Send the folder\'s hash_sha256 as If-Match. A folder the admin made itself (system_generated) can\'t be renamed here.
|
|
4839
|
+
* Rename a list and segment folder
|
|
4840
|
+
*/
|
|
4841
|
+
updateSfvbCommsFolder(requestParameters: UpdateSfvbCommsFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsFolderResponse>;
|
|
4842
|
+
/**
|
|
4843
|
+
* A field left out stays as it is; an empty folder_uuid or public_description clears it. Send the list\'s hash_sha256 as If-Match; the change applies only while the name, folder and public settings are still what was read. The members and member count are never changed here.
|
|
4844
|
+
* @summary Change an email list\'s name, folder or public settings
|
|
4845
|
+
* @param {number} storefrontOid
|
|
4846
|
+
* @param {string} listUuid
|
|
4847
|
+
* @param {string} ifMatch The list\'s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
4848
|
+
* @param {SfvbCommsListWriteRequest} listWriteRequest The fields to change
|
|
4849
|
+
* @param {*} [options] Override http request option.
|
|
4850
|
+
* @throws {RequiredError}
|
|
4851
|
+
* @memberof SfvbApiInterface
|
|
4852
|
+
*/
|
|
4853
|
+
updateSfvbCommsListRaw(requestParameters: UpdateSfvbCommsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsListResponse>>;
|
|
4854
|
+
/**
|
|
4855
|
+
* A field left out stays as it is; an empty folder_uuid or public_description clears it. Send the list\'s hash_sha256 as If-Match; the change applies only while the name, folder and public settings are still what was read. The members and member count are never changed here.
|
|
4856
|
+
* Change an email list\'s name, folder or public settings
|
|
4857
|
+
*/
|
|
4858
|
+
updateSfvbCommsList(requestParameters: UpdateSfvbCommsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsListResponse>;
|
|
4657
4859
|
/**
|
|
4658
4860
|
* A field left out stays as it is. Send the segment\'s hash_sha256 as If-Match; the change applies only while the name, rule and folder are still what was read. A changed rule is checked as on a create and starts a rebuild. Changing the rule of a segment a live campaign or flow uses needs sfvb_publish and an approved segment.update approval (Approval-Id); a name or folder change, or a segment nothing live uses, needs neither.
|
|
4659
4861
|
* @summary Change a segment\'s name, rule or folder
|
|
@@ -4719,7 +4921,7 @@ export interface SfvbApiInterface {
|
|
|
4719
4921
|
*/
|
|
4720
4922
|
updateSfvbEmail(requestParameters: UpdateSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail>;
|
|
4721
4923
|
/**
|
|
4722
|
-
* A field left out keeps its value. The trigger and the status
|
|
4924
|
+
* A field left out keeps its value. The trigger changes only while the flow is off (sfvb.flow_trigger_live otherwise), and customers already in the flow continue. The status is never changed here. Send the hash_sha256 you read as If-Match. A flow that is enrolling customers needs sfvb_publish.
|
|
4723
4925
|
* @summary Change a flow
|
|
4724
4926
|
* @param {number} storefrontOid
|
|
4725
4927
|
* @param {string} flowUuid
|
|
@@ -4731,7 +4933,7 @@ export interface SfvbApiInterface {
|
|
|
4731
4933
|
*/
|
|
4732
4934
|
updateSfvbFlowRaw(requestParameters: UpdateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
|
|
4733
4935
|
/**
|
|
4734
|
-
* A field left out keeps its value. The trigger and the status
|
|
4936
|
+
* A field left out keeps its value. The trigger changes only while the flow is off (sfvb.flow_trigger_live otherwise), and customers already in the flow continue. The status is never changed here. Send the hash_sha256 you read as If-Match. A flow that is enrolling customers needs sfvb_publish.
|
|
4735
4937
|
* Change a flow
|
|
4736
4938
|
*/
|
|
4737
4939
|
updateSfvbFlow(requestParameters: UpdateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
|
|
@@ -5055,6 +5257,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
5055
5257
|
* Archive or unarchive a campaign
|
|
5056
5258
|
*/
|
|
5057
5259
|
archiveSfvbCampaign(requestParameters: ArchiveSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
|
|
5260
|
+
/**
|
|
5261
|
+
* Hides the list from the lists list and the admin, and keeps its members. Refused with sfvb.in_use_live, naming each one, while a live campaign or flow uses it; notes names any that use it but aren\'t live, which can no longer use it. Send the list\'s hash_sha256 as If-Match.
|
|
5262
|
+
* Archive an email list
|
|
5263
|
+
*/
|
|
5264
|
+
archiveSfvbCommsListRaw(requestParameters: ArchiveSfvbCommsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsListResponse>>;
|
|
5265
|
+
/**
|
|
5266
|
+
* Hides the list from the lists list and the admin, and keeps its members. Refused with sfvb.in_use_live, naming each one, while a live campaign or flow uses it; notes names any that use it but aren\'t live, which can no longer use it. Send the list\'s hash_sha256 as If-Match.
|
|
5267
|
+
* Archive an email list
|
|
5268
|
+
*/
|
|
5269
|
+
archiveSfvbCommsList(requestParameters: ArchiveSfvbCommsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsListResponse>;
|
|
5270
|
+
/**
|
|
5271
|
+
* Hides the segment from the segments list and the admin. Refused with sfvb.in_use_live, naming each one, while a live campaign or flow uses it; notes names any that use it but aren\'t live, which can no longer use it. Send the segment\'s hash_sha256 as If-Match.
|
|
5272
|
+
* Archive a segment
|
|
5273
|
+
*/
|
|
5274
|
+
archiveSfvbCommsSegmentRaw(requestParameters: ArchiveSfvbCommsSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSegmentResponse>>;
|
|
5275
|
+
/**
|
|
5276
|
+
* Hides the segment from the segments list and the admin. Refused with sfvb.in_use_live, naming each one, while a live campaign or flow uses it; notes names any that use it but aren\'t live, which can no longer use it. Send the segment\'s hash_sha256 as If-Match.
|
|
5277
|
+
* Archive a segment
|
|
5278
|
+
*/
|
|
5279
|
+
archiveSfvbCommsSegment(requestParameters: ArchiveSfvbCommsSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSegmentResponse>;
|
|
5058
5280
|
/**
|
|
5059
5281
|
* 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.
|
|
5060
5282
|
* Archive or unarchive a flow
|
|
@@ -5215,6 +5437,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
5215
5437
|
* Delete a blog post
|
|
5216
5438
|
*/
|
|
5217
5439
|
deleteSfvbBlogPost(requestParameters: DeleteSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
5440
|
+
/**
|
|
5441
|
+
* Its lists and segments are kept and filed under no folder, as the admin does; items names each one. Send the folder\'s hash_sha256 as If-Match. A folder the admin made itself (system_generated) can\'t be deleted here.
|
|
5442
|
+
* Delete a list and segment folder
|
|
5443
|
+
*/
|
|
5444
|
+
deleteSfvbCommsFolderRaw(requestParameters: DeleteSfvbCommsFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsFolderResponse>>;
|
|
5445
|
+
/**
|
|
5446
|
+
* Its lists and segments are kept and filed under no folder, as the admin does; items names each one. Send the folder\'s hash_sha256 as If-Match. A folder the admin made itself (system_generated) can\'t be deleted here.
|
|
5447
|
+
* Delete a list and segment folder
|
|
5448
|
+
*/
|
|
5449
|
+
deleteSfvbCommsFolder(requestParameters: DeleteSfvbCommsFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsFolderResponse>;
|
|
5218
5450
|
/**
|
|
5219
5451
|
* Removes the domain from UltraCart and from Amazon SES. Needs an approved sending_domain.delete request for it (POST approvals, params.domain).
|
|
5220
5452
|
* Remove a sending domain
|
|
@@ -5653,6 +5885,36 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
5653
5885
|
* Element types used by a container
|
|
5654
5886
|
*/
|
|
5655
5887
|
getSfvbCjsonUsedElements(requestParameters: GetSfvbCjsonUsedElementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementsResponse>;
|
|
5888
|
+
/**
|
|
5889
|
+
* The folder, with the name and uuid of each list and segment filed in it.
|
|
5890
|
+
* Read one list and segment folder
|
|
5891
|
+
*/
|
|
5892
|
+
getSfvbCommsFolderRaw(requestParameters: GetSfvbCommsFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsFolderResponse>>;
|
|
5893
|
+
/**
|
|
5894
|
+
* The folder, with the name and uuid of each list and segment filed in it.
|
|
5895
|
+
* Read one list and segment folder
|
|
5896
|
+
*/
|
|
5897
|
+
getSfvbCommsFolder(requestParameters: GetSfvbCommsFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsFolderResponse>;
|
|
5898
|
+
/**
|
|
5899
|
+
* Each folder with how many lists and segments are filed in it, whether the admin made it, and its hash_sha256.
|
|
5900
|
+
* List the list and segment folders
|
|
5901
|
+
*/
|
|
5902
|
+
getSfvbCommsFoldersRaw(requestParameters: GetSfvbCommsFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsFoldersResponse>>;
|
|
5903
|
+
/**
|
|
5904
|
+
* Each folder with how many lists and segments are filed in it, whether the admin made it, and its hash_sha256.
|
|
5905
|
+
* List the list and segment folders
|
|
5906
|
+
*/
|
|
5907
|
+
getSfvbCommsFolders(requestParameters: GetSfvbCommsFoldersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsFoldersResponse>;
|
|
5908
|
+
/**
|
|
5909
|
+
* The list\'s name, folder, member count, public settings, and the campaigns and flows that use it, each with whether it is live. hash_sha256 is the If-Match for a change or an archive. Never its members.
|
|
5910
|
+
* Read one email list
|
|
5911
|
+
*/
|
|
5912
|
+
getSfvbCommsListRaw(requestParameters: GetSfvbCommsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsListResponse>>;
|
|
5913
|
+
/**
|
|
5914
|
+
* The list\'s name, folder, member count, public settings, and the campaigns and flows that use it, each with whether it is live. hash_sha256 is the If-Match for a change or an archive. Never its members.
|
|
5915
|
+
* Read one email list
|
|
5916
|
+
*/
|
|
5917
|
+
getSfvbCommsList(requestParameters: GetSfvbCommsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsListResponse>;
|
|
5656
5918
|
/**
|
|
5657
5919
|
* The segment\'s name, folder, rule, member count at its last rebuild, whether a rebuild is still due, and the campaigns and flows that use it, each with whether it is live. hash_sha256 is the If-Match for an update. Never its members, its Facebook audience, its ranking or its third party sync settings.
|
|
5658
5920
|
* Read one segment, with its rule
|
|
@@ -6391,6 +6653,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
6391
6653
|
* Create a blog post
|
|
6392
6654
|
*/
|
|
6393
6655
|
insertSfvbBlogPost(requestParameters: InsertSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
|
|
6656
|
+
/**
|
|
6657
|
+
* A new, empty folder. File a list or segment in it by setting its folder_uuid.
|
|
6658
|
+
* Create a list and segment folder
|
|
6659
|
+
*/
|
|
6660
|
+
insertSfvbCommsFolderRaw(requestParameters: InsertSfvbCommsFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsFolderResponse>>;
|
|
6661
|
+
/**
|
|
6662
|
+
* A new, empty folder. File a list or segment in it by setting its folder_uuid.
|
|
6663
|
+
* Create a list and segment folder
|
|
6664
|
+
*/
|
|
6665
|
+
insertSfvbCommsFolder(requestParameters: InsertSfvbCommsFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsFolderResponse>;
|
|
6666
|
+
/**
|
|
6667
|
+
* A new, empty list with the name, folder and public settings given. public_description is plain text, since subscribers see it on the email preferences page.
|
|
6668
|
+
* Create an email list
|
|
6669
|
+
*/
|
|
6670
|
+
insertSfvbCommsListRaw(requestParameters: InsertSfvbCommsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsListResponse>>;
|
|
6671
|
+
/**
|
|
6672
|
+
* A new, empty list with the name, folder and public settings given. public_description is plain text, since subscribers see it on the email preferences page.
|
|
6673
|
+
* Create an email list
|
|
6674
|
+
*/
|
|
6675
|
+
insertSfvbCommsList(requestParameters: InsertSfvbCommsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsListResponse>;
|
|
6394
6676
|
/**
|
|
6395
6677
|
* A new segment with the name, rule and folder given. The rule needs at least one group, each with at least one function of a rule type the segment rebuild knows, and any list or segment it names must be on this storefront. The segment starts empty and rebuilds in the background; member_count is out of date until rebuild_required is false.
|
|
6396
6678
|
* Create a segment
|
|
@@ -7249,6 +7531,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
7249
7531
|
* Change a campaign
|
|
7250
7532
|
*/
|
|
7251
7533
|
updateSfvbCampaign(requestParameters: UpdateSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
|
|
7534
|
+
/**
|
|
7535
|
+
* Send the folder\'s hash_sha256 as If-Match. A folder the admin made itself (system_generated) can\'t be renamed here.
|
|
7536
|
+
* Rename a list and segment folder
|
|
7537
|
+
*/
|
|
7538
|
+
updateSfvbCommsFolderRaw(requestParameters: UpdateSfvbCommsFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsFolderResponse>>;
|
|
7539
|
+
/**
|
|
7540
|
+
* Send the folder\'s hash_sha256 as If-Match. A folder the admin made itself (system_generated) can\'t be renamed here.
|
|
7541
|
+
* Rename a list and segment folder
|
|
7542
|
+
*/
|
|
7543
|
+
updateSfvbCommsFolder(requestParameters: UpdateSfvbCommsFolderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsFolderResponse>;
|
|
7544
|
+
/**
|
|
7545
|
+
* A field left out stays as it is; an empty folder_uuid or public_description clears it. Send the list\'s hash_sha256 as If-Match; the change applies only while the name, folder and public settings are still what was read. The members and member count are never changed here.
|
|
7546
|
+
* Change an email list\'s name, folder or public settings
|
|
7547
|
+
*/
|
|
7548
|
+
updateSfvbCommsListRaw(requestParameters: UpdateSfvbCommsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsListResponse>>;
|
|
7549
|
+
/**
|
|
7550
|
+
* A field left out stays as it is; an empty folder_uuid or public_description clears it. Send the list\'s hash_sha256 as If-Match; the change applies only while the name, folder and public settings are still what was read. The members and member count are never changed here.
|
|
7551
|
+
* Change an email list\'s name, folder or public settings
|
|
7552
|
+
*/
|
|
7553
|
+
updateSfvbCommsList(requestParameters: UpdateSfvbCommsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsListResponse>;
|
|
7252
7554
|
/**
|
|
7253
7555
|
* A field left out stays as it is. Send the segment\'s hash_sha256 as If-Match; the change applies only while the name, rule and folder are still what was read. A changed rule is checked as on a create and starts a rebuild. Changing the rule of a segment a live campaign or flow uses needs sfvb_publish and an approved segment.update approval (Approval-Id); a name or folder change, or a segment nothing live uses, needs neither.
|
|
7254
7556
|
* Change a segment\'s name, rule or folder
|
|
@@ -7290,12 +7592,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
7290
7592
|
*/
|
|
7291
7593
|
updateSfvbEmail(requestParameters: UpdateSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail>;
|
|
7292
7594
|
/**
|
|
7293
|
-
* A field left out keeps its value. The trigger and the status
|
|
7595
|
+
* A field left out keeps its value. The trigger changes only while the flow is off (sfvb.flow_trigger_live otherwise), and customers already in the flow continue. The status is never changed here. Send the hash_sha256 you read as If-Match. A flow that is enrolling customers needs sfvb_publish.
|
|
7294
7596
|
* Change a flow
|
|
7295
7597
|
*/
|
|
7296
7598
|
updateSfvbFlowRaw(requestParameters: UpdateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
|
|
7297
7599
|
/**
|
|
7298
|
-
* A field left out keeps its value. The trigger and the status
|
|
7600
|
+
* A field left out keeps its value. The trigger changes only while the flow is off (sfvb.flow_trigger_live otherwise), and customers already in the flow continue. The status is never changed here. Send the hash_sha256 you read as If-Match. A flow that is enrolling customers needs sfvb_publish.
|
|
7299
7601
|
* Change a flow
|
|
7300
7602
|
*/
|
|
7301
7603
|
updateSfvbFlow(requestParameters: UpdateSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
|