ultracart_rest_api_v2_typescript 4.1.206 → 4.1.208
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 +4 -2
- package/dist/apis/SfvbApi.d.ts +191 -1
- package/dist/apis/SfvbApi.js +401 -0
- package/dist/models/ItemThirdPartyEmailMarketing.d.ts +0 -2
- package/dist/models/ItemThirdPartyEmailMarketing.js +0 -2
- package/dist/models/SfvbCampaign.d.ts +93 -0
- package/dist/models/SfvbCampaign.js +72 -0
- package/dist/models/SfvbCampaignsResponse.d.ts +50 -0
- package/dist/models/SfvbCampaignsResponse.js +57 -0
- package/dist/models/SfvbCommsEmail.d.ts +91 -0
- package/dist/models/SfvbCommsEmail.js +70 -0
- package/dist/models/SfvbCommsPostcard.d.ts +61 -0
- package/dist/models/SfvbCommsPostcard.js +60 -0
- package/dist/models/SfvbEmail.d.ts +97 -0
- package/dist/models/SfvbEmail.js +72 -0
- package/dist/models/SfvbEmailUpdateRequest.d.ts +37 -0
- package/dist/models/SfvbEmailUpdateRequest.js +52 -0
- package/dist/models/SfvbFlow.d.ts +99 -0
- package/dist/models/SfvbFlow.js +74 -0
- package/dist/models/SfvbFlowsResponse.d.ts +50 -0
- package/dist/models/SfvbFlowsResponse.js +57 -0
- 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 +475 -0
- package/src/models/ItemThirdPartyEmailMarketing.ts +0 -2
- package/src/models/SfvbCampaign.ts +160 -0
- package/src/models/SfvbCampaignsResponse.ts +98 -0
- package/src/models/SfvbCommsEmail.ts +147 -0
- package/src/models/SfvbCommsPostcard.ts +107 -0
- package/src/models/SfvbEmail.ts +155 -0
- package/src/models/SfvbEmailUpdateRequest.ts +75 -0
- package/src/models/SfvbFlow.ts +168 -0
- package/src/models/SfvbFlowsResponse.ts +98 -0
- package/src/models/index.ts +8 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -1007,7 +1007,11 @@ src/models/SfvbBlogPostImage.ts
|
|
|
1007
1007
|
src/models/SfvbBlogPostImageRequest.ts
|
|
1008
1008
|
src/models/SfvbBlogPostRequest.ts
|
|
1009
1009
|
src/models/SfvbBlogPostsResponse.ts
|
|
1010
|
+
src/models/SfvbCampaign.ts
|
|
1011
|
+
src/models/SfvbCampaignsResponse.ts
|
|
1010
1012
|
src/models/SfvbCommsDnsRecord.ts
|
|
1013
|
+
src/models/SfvbCommsEmail.ts
|
|
1014
|
+
src/models/SfvbCommsPostcard.ts
|
|
1011
1015
|
src/models/SfvbCommsSendingDomain.ts
|
|
1012
1016
|
src/models/SfvbCommsSendingDomainsResponse.ts
|
|
1013
1017
|
src/models/SfvbCommsTwilioAccount.ts
|
|
@@ -1022,8 +1026,10 @@ src/models/SfvbContainerWriteRequest.ts
|
|
|
1022
1026
|
src/models/SfvbElement.ts
|
|
1023
1027
|
src/models/SfvbElementSchemaResponse.ts
|
|
1024
1028
|
src/models/SfvbElementsResponse.ts
|
|
1029
|
+
src/models/SfvbEmail.ts
|
|
1025
1030
|
src/models/SfvbEmailRenderRequest.ts
|
|
1026
1031
|
src/models/SfvbEmailRenderResponse.ts
|
|
1032
|
+
src/models/SfvbEmailUpdateRequest.ts
|
|
1027
1033
|
src/models/SfvbErrorDetail.ts
|
|
1028
1034
|
src/models/SfvbEvent.ts
|
|
1029
1035
|
src/models/SfvbEventsAuthRequest.ts
|
|
@@ -1049,6 +1055,8 @@ src/models/SfvbFileVersionsResponse.ts
|
|
|
1049
1055
|
src/models/SfvbFileWriteRequest.ts
|
|
1050
1056
|
src/models/SfvbFileWriteResponse.ts
|
|
1051
1057
|
src/models/SfvbFilesResponse.ts
|
|
1058
|
+
src/models/SfvbFlow.ts
|
|
1059
|
+
src/models/SfvbFlowsResponse.ts
|
|
1052
1060
|
src/models/SfvbI18nGlossary.ts
|
|
1053
1061
|
src/models/SfvbI18nGlossaryRequest.ts
|
|
1054
1062
|
src/models/SfvbI18nLanguage.ts
|
package/README.md
CHANGED
|
@@ -1,12 +1,12 @@
|
|
|
1
1
|
# UltraCart Typescript SDK
|
|
2
|
-
## ultracart_rest_api_v2_typescript@4.1.
|
|
2
|
+
## ultracart_rest_api_v2_typescript@4.1.208
|
|
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.208 --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.208 | 10/26/2026 | sfvb internal testing |
|
|
88
|
+
| 4.1.207 | 10/16/2026 | sfvb internal testing |
|
|
87
89
|
| 4.1.206 | 10/16/2026 | sfvb internal testing |
|
|
88
90
|
| 4.1.205 | 10/15/2026 | sfvb internal testing |
|
|
89
91
|
| 4.1.204 | 10/15/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 { SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbEmailRenderRequest, SfvbEmailRenderResponse, SfvbEventsAuthRequest, SfvbEventsAuthResponse, SfvbEventsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeBatchRequest, SfvbItemAttributeBatchResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaDescriptionRequest, SfvbItemMultimediaRequest, SfvbItemPricing, SfvbItemPricingRequest, SfvbItemRelated, SfvbItemRelatedRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbNotFoundEntry, SfvbNotFoundEntryResponse, SfvbNotFoundPage, SfvbNotFoundResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
|
|
13
|
+
import { SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCampaign, SfvbCampaignsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbEmail, SfvbEmailRenderRequest, SfvbEmailRenderResponse, SfvbEmailUpdateRequest, SfvbEventsAuthRequest, SfvbEventsAuthResponse, SfvbEventsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbFlow, SfvbFlowsResponse, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeBatchRequest, SfvbItemAttributeBatchResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaDescriptionRequest, SfvbItemMultimediaRequest, SfvbItemPricing, SfvbItemPricingRequest, SfvbItemRelated, SfvbItemRelatedRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbNotFoundEntry, SfvbNotFoundEntryResponse, SfvbNotFoundPage, SfvbNotFoundResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
|
|
14
14
|
export interface AddSfvbPageBlogPostsRequest {
|
|
15
15
|
storefrontOid: number;
|
|
16
16
|
path: string;
|
|
@@ -205,6 +205,10 @@ export interface GetSfvbBlogPostRequest {
|
|
|
205
205
|
storefrontOid: number;
|
|
206
206
|
blogPostOid: number;
|
|
207
207
|
}
|
|
208
|
+
export interface GetSfvbCampaignRequest {
|
|
209
|
+
storefrontOid: number;
|
|
210
|
+
campaignUuid: string;
|
|
211
|
+
}
|
|
208
212
|
export interface GetSfvbCjsonUsedElementsRequest {
|
|
209
213
|
compileRequest: SfvbCompileRequest;
|
|
210
214
|
}
|
|
@@ -227,6 +231,10 @@ export interface GetSfvbContainerVersionRequest {
|
|
|
227
231
|
export interface GetSfvbElementRequest {
|
|
228
232
|
elementType: string;
|
|
229
233
|
}
|
|
234
|
+
export interface GetSfvbEmailRequest {
|
|
235
|
+
storefrontOid: number;
|
|
236
|
+
emailUuid: string;
|
|
237
|
+
}
|
|
230
238
|
export interface GetSfvbEventsRequest {
|
|
231
239
|
after?: string;
|
|
232
240
|
storefrontOid?: number;
|
|
@@ -252,6 +260,10 @@ export interface GetSfvbFileUploadUrlRequest {
|
|
|
252
260
|
storefrontOid: number;
|
|
253
261
|
extension: string;
|
|
254
262
|
}
|
|
263
|
+
export interface GetSfvbFlowRequest {
|
|
264
|
+
storefrontOid: number;
|
|
265
|
+
flowUuid: string;
|
|
266
|
+
}
|
|
255
267
|
export interface GetSfvbI18nGlossaryRequest {
|
|
256
268
|
storefrontOid: number;
|
|
257
269
|
}
|
|
@@ -472,6 +484,13 @@ export interface ListSfvbBlogPostsRequest {
|
|
|
472
484
|
page?: number;
|
|
473
485
|
pageSize?: number;
|
|
474
486
|
}
|
|
487
|
+
export interface ListSfvbCampaignsRequest {
|
|
488
|
+
storefrontOid: number;
|
|
489
|
+
search?: string;
|
|
490
|
+
page?: number;
|
|
491
|
+
pageSize?: number;
|
|
492
|
+
includeDeleted?: boolean;
|
|
493
|
+
}
|
|
475
494
|
export interface ListSfvbContainerVersionsRequest {
|
|
476
495
|
storefrontOid: number;
|
|
477
496
|
ownerType?: string;
|
|
@@ -495,6 +514,13 @@ export interface ListSfvbFilesRequest {
|
|
|
495
514
|
themeOid?: number;
|
|
496
515
|
maxEntries?: number;
|
|
497
516
|
}
|
|
517
|
+
export interface ListSfvbFlowsRequest {
|
|
518
|
+
storefrontOid: number;
|
|
519
|
+
search?: string;
|
|
520
|
+
page?: number;
|
|
521
|
+
pageSize?: number;
|
|
522
|
+
includeDeleted?: boolean;
|
|
523
|
+
}
|
|
498
524
|
export interface ListSfvbI18nMessagesRequest {
|
|
499
525
|
storefrontOid: number;
|
|
500
526
|
themeOid?: number;
|
|
@@ -815,6 +841,12 @@ export interface UpdateSfvbCommsSendingDomainRequest {
|
|
|
815
841
|
export interface UpdateSfvbCommsTwilioAccountRequest {
|
|
816
842
|
twilioAccount: SfvbCommsTwilioAccount;
|
|
817
843
|
}
|
|
844
|
+
export interface UpdateSfvbEmailRequest {
|
|
845
|
+
storefrontOid: number;
|
|
846
|
+
emailUuid: string;
|
|
847
|
+
ifMatch: string;
|
|
848
|
+
emailUpdateRequest: SfvbEmailUpdateRequest;
|
|
849
|
+
}
|
|
818
850
|
export interface UpdateSfvbItemAttributeBatchRequest {
|
|
819
851
|
storefrontOid: number;
|
|
820
852
|
itemAttributeBatchRequest: SfvbItemAttributeBatchRequest;
|
|
@@ -1544,6 +1576,21 @@ export interface SfvbApiInterface {
|
|
|
1544
1576
|
* Read a blog post
|
|
1545
1577
|
*/
|
|
1546
1578
|
getSfvbBlogPost(requestParameters: GetSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
|
|
1579
|
+
/**
|
|
1580
|
+
* One campaign, the same object as its list entry, with its emails and postcards in step order. A deleted campaign is returned with deleted true.
|
|
1581
|
+
* @summary Get a campaign
|
|
1582
|
+
* @param {number} storefrontOid
|
|
1583
|
+
* @param {string} campaignUuid
|
|
1584
|
+
* @param {*} [options] Override http request option.
|
|
1585
|
+
* @throws {RequiredError}
|
|
1586
|
+
* @memberof SfvbApiInterface
|
|
1587
|
+
*/
|
|
1588
|
+
getSfvbCampaignRaw(requestParameters: GetSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
|
|
1589
|
+
/**
|
|
1590
|
+
* One campaign, the same object as its list entry, with its emails and postcards in step order. A deleted campaign is returned with deleted true.
|
|
1591
|
+
* Get a campaign
|
|
1592
|
+
*/
|
|
1593
|
+
getSfvbCampaign(requestParameters: GetSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
|
|
1547
1594
|
/**
|
|
1548
1595
|
*
|
|
1549
1596
|
* @summary Element types used by a container
|
|
@@ -1646,6 +1693,21 @@ export interface SfvbApiInterface {
|
|
|
1646
1693
|
* Configuration schema and field card for one element type
|
|
1647
1694
|
*/
|
|
1648
1695
|
getSfvbElement(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementSchemaResponse>;
|
|
1696
|
+
/**
|
|
1697
|
+
* 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.
|
|
1698
|
+
* @summary Get a flow or campaign email\'s subject and preview text
|
|
1699
|
+
* @param {number} storefrontOid
|
|
1700
|
+
* @param {string} emailUuid
|
|
1701
|
+
* @param {*} [options] Override http request option.
|
|
1702
|
+
* @throws {RequiredError}
|
|
1703
|
+
* @memberof SfvbApiInterface
|
|
1704
|
+
*/
|
|
1705
|
+
getSfvbEmailRaw(requestParameters: GetSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEmail>>;
|
|
1706
|
+
/**
|
|
1707
|
+
* 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.
|
|
1708
|
+
* Get a flow or campaign email\'s subject and preview text
|
|
1709
|
+
*/
|
|
1710
|
+
getSfvbEmail(requestParameters: GetSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail>;
|
|
1649
1711
|
/**
|
|
1650
1712
|
* 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.
|
|
1651
1713
|
* @summary Replay events
|
|
@@ -1737,6 +1799,21 @@ export interface SfvbApiInterface {
|
|
|
1737
1799
|
* Get a URL to upload a binary asset to
|
|
1738
1800
|
*/
|
|
1739
1801
|
getSfvbFileUploadUrl(requestParameters: GetSfvbFileUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileUploadUrlResponse>;
|
|
1802
|
+
/**
|
|
1803
|
+
* One flow, the same object as its list entry, with its emails and postcards in step order. A deleted flow is returned with deleted true.
|
|
1804
|
+
* @summary Get a flow
|
|
1805
|
+
* @param {number} storefrontOid
|
|
1806
|
+
* @param {string} flowUuid
|
|
1807
|
+
* @param {*} [options] Override http request option.
|
|
1808
|
+
* @throws {RequiredError}
|
|
1809
|
+
* @memberof SfvbApiInterface
|
|
1810
|
+
*/
|
|
1811
|
+
getSfvbFlowRaw(requestParameters: GetSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
|
|
1812
|
+
/**
|
|
1813
|
+
* One flow, the same object as its list entry, with its emails and postcards in step order. A deleted flow is returned with deleted true.
|
|
1814
|
+
* Get a flow
|
|
1815
|
+
*/
|
|
1816
|
+
getSfvbFlow(requestParameters: GetSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
|
|
1740
1817
|
/**
|
|
1741
1818
|
* The storefront\'s glossary, plain markdown with terms not to translate, required translations, tone and words to avoid. Read it before translating anything. Empty when none has been saved. Each storefront has its own, because a storefront is often its own brand.
|
|
1742
1819
|
* @summary Read the storefront\'s translation glossary
|
|
@@ -2558,6 +2635,24 @@ export interface SfvbApiInterface {
|
|
|
2558
2635
|
* List the storefront\'s blog posts
|
|
2559
2636
|
*/
|
|
2560
2637
|
listSfvbBlogPosts(requestParameters: ListSfvbBlogPostsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostsResponse>;
|
|
2638
|
+
/**
|
|
2639
|
+
* One page of campaigns, newest first, each with its emails and postcards in step order, without their container JSON. search matches the campaign name. Deleted campaigns are left out unless include_deleted is true. live is true unless the status sends nothing (draft or archived), so a change to one of its emails reaches customers at once.
|
|
2640
|
+
* @summary List the storefront\'s campaigns
|
|
2641
|
+
* @param {number} storefrontOid
|
|
2642
|
+
* @param {string} [search] Text to search for in the name
|
|
2643
|
+
* @param {number} [page] Page number, starting at 1
|
|
2644
|
+
* @param {number} [pageSize] Campaigns per page, 1 to 100, default 50
|
|
2645
|
+
* @param {boolean} [includeDeleted] Include deleted campaigns
|
|
2646
|
+
* @param {*} [options] Override http request option.
|
|
2647
|
+
* @throws {RequiredError}
|
|
2648
|
+
* @memberof SfvbApiInterface
|
|
2649
|
+
*/
|
|
2650
|
+
listSfvbCampaignsRaw(requestParameters: ListSfvbCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaignsResponse>>;
|
|
2651
|
+
/**
|
|
2652
|
+
* One page of campaigns, newest first, each with its emails and postcards in step order, without their container JSON. search matches the campaign name. Deleted campaigns are left out unless include_deleted is true. live is true unless the status sends nothing (draft or archived), so a change to one of its emails reaches customers at once.
|
|
2653
|
+
* List the storefront\'s campaigns
|
|
2654
|
+
*/
|
|
2655
|
+
listSfvbCampaigns(requestParameters: ListSfvbCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaignsResponse>;
|
|
2561
2656
|
/**
|
|
2562
2657
|
* Addressed the same way as the container itself, so owner_type also says how owner_object_id is read and itemid lists the history of the item container that merchant item id names.
|
|
2563
2658
|
* @summary Version history for a container stored outside the file system
|
|
@@ -2638,6 +2733,24 @@ export interface SfvbApiInterface {
|
|
|
2638
2733
|
* List a storefront directory
|
|
2639
2734
|
*/
|
|
2640
2735
|
listSfvbFiles(requestParameters: ListSfvbFilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFilesResponse>;
|
|
2736
|
+
/**
|
|
2737
|
+
* One page of flows, newest first, each with its trigger and its emails and postcards in step order, without their container JSON. search matches the flow name. Deleted flows are left out unless include_deleted is true. live is true unless the status sends nothing (draft or inactive); a paused flow still holds enrolled customers, so it counts as live.
|
|
2738
|
+
* @summary List the storefront\'s flows
|
|
2739
|
+
* @param {number} storefrontOid
|
|
2740
|
+
* @param {string} [search] Text to search for in the name
|
|
2741
|
+
* @param {number} [page] Page number, starting at 1
|
|
2742
|
+
* @param {number} [pageSize] Flows per page, 1 to 100, default 50
|
|
2743
|
+
* @param {boolean} [includeDeleted] Include deleted flows
|
|
2744
|
+
* @param {*} [options] Override http request option.
|
|
2745
|
+
* @throws {RequiredError}
|
|
2746
|
+
* @memberof SfvbApiInterface
|
|
2747
|
+
*/
|
|
2748
|
+
listSfvbFlowsRaw(requestParameters: ListSfvbFlowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlowsResponse>>;
|
|
2749
|
+
/**
|
|
2750
|
+
* One page of flows, newest first, each with its trigger and its emails and postcards in step order, without their container JSON. search matches the flow name. Deleted flows are left out unless include_deleted is true. live is true unless the status sends nothing (draft or inactive); a paused flow still holds enrolled customers, so it counts as live.
|
|
2751
|
+
* List the storefront\'s flows
|
|
2752
|
+
*/
|
|
2753
|
+
listSfvbFlows(requestParameters: ListSfvbFlowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlowsResponse>;
|
|
2641
2754
|
/**
|
|
2642
2755
|
* The system text templates render by key, such as checkout labels, for one theme (the active theme unless theme_oid is given). Each message has its English, whether it was edited, and each enabled language\'s text with its source (hand, machine, pending or none). A message appears the first time a page renders it. q matches the key or the English. overridden keeps messages with an edited English or a hand translation. Paged by offset and limit (default 200, at most 500).
|
|
2643
2756
|
* @summary List built-in messages
|
|
@@ -3619,6 +3732,23 @@ export interface SfvbApiInterface {
|
|
|
3619
3732
|
* Update the Twilio account
|
|
3620
3733
|
*/
|
|
3621
3734
|
updateSfvbCommsTwilioAccount(requestParameters: UpdateSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTwilioAccountResponse>;
|
|
3735
|
+
/**
|
|
3736
|
+
* 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.
|
|
3737
|
+
* @summary Change a flow or campaign email\'s subject or preview text
|
|
3738
|
+
* @param {number} storefrontOid
|
|
3739
|
+
* @param {string} emailUuid
|
|
3740
|
+
* @param {string} ifMatch hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
3741
|
+
* @param {SfvbEmailUpdateRequest} emailUpdateRequest The subject or preview text to change
|
|
3742
|
+
* @param {*} [options] Override http request option.
|
|
3743
|
+
* @throws {RequiredError}
|
|
3744
|
+
* @memberof SfvbApiInterface
|
|
3745
|
+
*/
|
|
3746
|
+
updateSfvbEmailRaw(requestParameters: UpdateSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEmail>>;
|
|
3747
|
+
/**
|
|
3748
|
+
* 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.
|
|
3749
|
+
* Change a flow or campaign email\'s subject or preview text
|
|
3750
|
+
*/
|
|
3751
|
+
updateSfvbEmail(requestParameters: UpdateSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail>;
|
|
3622
3752
|
/**
|
|
3623
3753
|
* 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.
|
|
3624
3754
|
* @summary Change attributes across many items in one call
|
|
@@ -4194,6 +4324,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
4194
4324
|
* Read a blog post
|
|
4195
4325
|
*/
|
|
4196
4326
|
getSfvbBlogPost(requestParameters: GetSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
|
|
4327
|
+
/**
|
|
4328
|
+
* One campaign, the same object as its list entry, with its emails and postcards in step order. A deleted campaign is returned with deleted true.
|
|
4329
|
+
* Get a campaign
|
|
4330
|
+
*/
|
|
4331
|
+
getSfvbCampaignRaw(requestParameters: GetSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaign>>;
|
|
4332
|
+
/**
|
|
4333
|
+
* One campaign, the same object as its list entry, with its emails and postcards in step order. A deleted campaign is returned with deleted true.
|
|
4334
|
+
* Get a campaign
|
|
4335
|
+
*/
|
|
4336
|
+
getSfvbCampaign(requestParameters: GetSfvbCampaignRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaign>;
|
|
4197
4337
|
/**
|
|
4198
4338
|
* Element types used by a container
|
|
4199
4339
|
*/
|
|
@@ -4262,6 +4402,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
4262
4402
|
* Configuration schema and field card for one element type
|
|
4263
4403
|
*/
|
|
4264
4404
|
getSfvbElement(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementSchemaResponse>;
|
|
4405
|
+
/**
|
|
4406
|
+
* 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.
|
|
4407
|
+
* Get a flow or campaign email\'s subject and preview text
|
|
4408
|
+
*/
|
|
4409
|
+
getSfvbEmailRaw(requestParameters: GetSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEmail>>;
|
|
4410
|
+
/**
|
|
4411
|
+
* 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.
|
|
4412
|
+
* Get a flow or campaign email\'s subject and preview text
|
|
4413
|
+
*/
|
|
4414
|
+
getSfvbEmail(requestParameters: GetSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail>;
|
|
4265
4415
|
/**
|
|
4266
4416
|
* 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.
|
|
4267
4417
|
* Replay events
|
|
@@ -4322,6 +4472,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
4322
4472
|
* Get a URL to upload a binary asset to
|
|
4323
4473
|
*/
|
|
4324
4474
|
getSfvbFileUploadUrl(requestParameters: GetSfvbFileUploadUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileUploadUrlResponse>;
|
|
4475
|
+
/**
|
|
4476
|
+
* One flow, the same object as its list entry, with its emails and postcards in step order. A deleted flow is returned with deleted true.
|
|
4477
|
+
* Get a flow
|
|
4478
|
+
*/
|
|
4479
|
+
getSfvbFlowRaw(requestParameters: GetSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlow>>;
|
|
4480
|
+
/**
|
|
4481
|
+
* One flow, the same object as its list entry, with its emails and postcards in step order. A deleted flow is returned with deleted true.
|
|
4482
|
+
* Get a flow
|
|
4483
|
+
*/
|
|
4484
|
+
getSfvbFlow(requestParameters: GetSfvbFlowRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlow>;
|
|
4325
4485
|
/**
|
|
4326
4486
|
* The storefront\'s glossary, plain markdown with terms not to translate, required translations, tone and words to avoid. Read it before translating anything. Empty when none has been saved. Each storefront has its own, because a storefront is often its own brand.
|
|
4327
4487
|
* Read the storefront\'s translation glossary
|
|
@@ -4860,6 +5020,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
4860
5020
|
* List the storefront\'s blog posts
|
|
4861
5021
|
*/
|
|
4862
5022
|
listSfvbBlogPosts(requestParameters: ListSfvbBlogPostsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostsResponse>;
|
|
5023
|
+
/**
|
|
5024
|
+
* One page of campaigns, newest first, each with its emails and postcards in step order, without their container JSON. search matches the campaign name. Deleted campaigns are left out unless include_deleted is true. live is true unless the status sends nothing (draft or archived), so a change to one of its emails reaches customers at once.
|
|
5025
|
+
* List the storefront\'s campaigns
|
|
5026
|
+
*/
|
|
5027
|
+
listSfvbCampaignsRaw(requestParameters: ListSfvbCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCampaignsResponse>>;
|
|
5028
|
+
/**
|
|
5029
|
+
* One page of campaigns, newest first, each with its emails and postcards in step order, without their container JSON. search matches the campaign name. Deleted campaigns are left out unless include_deleted is true. live is true unless the status sends nothing (draft or archived), so a change to one of its emails reaches customers at once.
|
|
5030
|
+
* List the storefront\'s campaigns
|
|
5031
|
+
*/
|
|
5032
|
+
listSfvbCampaigns(requestParameters: ListSfvbCampaignsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCampaignsResponse>;
|
|
4863
5033
|
/**
|
|
4864
5034
|
* Addressed the same way as the container itself, so owner_type also says how owner_object_id is read and itemid lists the history of the item container that merchant item id names.
|
|
4865
5035
|
* Version history for a container stored outside the file system
|
|
@@ -4910,6 +5080,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
4910
5080
|
* List a storefront directory
|
|
4911
5081
|
*/
|
|
4912
5082
|
listSfvbFiles(requestParameters: ListSfvbFilesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFilesResponse>;
|
|
5083
|
+
/**
|
|
5084
|
+
* One page of flows, newest first, each with its trigger and its emails and postcards in step order, without their container JSON. search matches the flow name. Deleted flows are left out unless include_deleted is true. live is true unless the status sends nothing (draft or inactive); a paused flow still holds enrolled customers, so it counts as live.
|
|
5085
|
+
* List the storefront\'s flows
|
|
5086
|
+
*/
|
|
5087
|
+
listSfvbFlowsRaw(requestParameters: ListSfvbFlowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbFlowsResponse>>;
|
|
5088
|
+
/**
|
|
5089
|
+
* One page of flows, newest first, each with its trigger and its emails and postcards in step order, without their container JSON. search matches the flow name. Deleted flows are left out unless include_deleted is true. live is true unless the status sends nothing (draft or inactive); a paused flow still holds enrolled customers, so it counts as live.
|
|
5090
|
+
* List the storefront\'s flows
|
|
5091
|
+
*/
|
|
5092
|
+
listSfvbFlows(requestParameters: ListSfvbFlowsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFlowsResponse>;
|
|
4913
5093
|
/**
|
|
4914
5094
|
* The system text templates render by key, such as checkout labels, for one theme (the active theme unless theme_oid is given). Each message has its English, whether it was edited, and each enabled language\'s text with its source (hand, machine, pending or none). A message appears the first time a page renders it. q matches the key or the English. overridden keeps messages with an edited English or a hand translation. Paged by offset and limit (default 200, at most 500).
|
|
4915
5095
|
* List built-in messages
|
|
@@ -5508,6 +5688,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
5508
5688
|
* Update the Twilio account
|
|
5509
5689
|
*/
|
|
5510
5690
|
updateSfvbCommsTwilioAccount(requestParameters: UpdateSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTwilioAccountResponse>;
|
|
5691
|
+
/**
|
|
5692
|
+
* 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.
|
|
5693
|
+
* Change a flow or campaign email\'s subject or preview text
|
|
5694
|
+
*/
|
|
5695
|
+
updateSfvbEmailRaw(requestParameters: UpdateSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEmail>>;
|
|
5696
|
+
/**
|
|
5697
|
+
* 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.
|
|
5698
|
+
* Change a flow or campaign email\'s subject or preview text
|
|
5699
|
+
*/
|
|
5700
|
+
updateSfvbEmail(requestParameters: UpdateSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmail>;
|
|
5511
5701
|
/**
|
|
5512
5702
|
* 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.
|
|
5513
5703
|
* Change attributes across many items in one call
|