ultracart_rest_api_v2_typescript 4.1.203 → 4.1.205
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 +9 -0
- package/README.md +4 -2
- package/dist/apis/SfvbApi.d.ts +356 -1
- package/dist/apis/SfvbApi.js +802 -14
- package/dist/models/SfvbApprovalParams.d.ts +12 -0
- package/dist/models/SfvbApprovalParams.js +4 -0
- package/dist/models/SfvbCommsDnsRecord.d.ts +66 -0
- package/dist/models/SfvbCommsDnsRecord.js +71 -0
- package/dist/models/SfvbCommsSendingDomain.d.ts +100 -0
- package/dist/models/SfvbCommsSendingDomain.js +78 -0
- package/dist/models/SfvbCommsSendingDomainsResponse.d.ts +32 -0
- package/dist/models/SfvbCommsSendingDomainsResponse.js +51 -0
- package/dist/models/SfvbCommsTwilioAccount.d.ts +91 -0
- package/dist/models/SfvbCommsTwilioAccount.js +70 -0
- package/dist/models/SfvbCommsTwilioAccountResponse.d.ts +39 -0
- package/dist/models/SfvbCommsTwilioAccountResponse.js +54 -0
- package/dist/models/SfvbEmailRenderRequest.d.ts +49 -0
- package/dist/models/SfvbEmailRenderRequest.js +56 -0
- package/dist/models/SfvbEmailRenderResponse.d.ts +81 -0
- package/dist/models/SfvbEmailRenderResponse.js +68 -0
- package/dist/models/SfvbSecretRequestCreate.d.ts +1 -1
- package/dist/models/SfvbTransactionalEmail.d.ts +49 -0
- package/dist/models/SfvbTransactionalEmail.js +56 -0
- package/dist/models/SfvbTransactionalEmailsResponse.d.ts +32 -0
- package/dist/models/SfvbTransactionalEmailsResponse.js +51 -0
- package/dist/models/index.d.ts +9 -0
- package/dist/models/index.js +9 -0
- package/package.json +1 -1
- package/src/apis/SfvbApi.ts +887 -39
- package/src/models/SfvbApprovalParams.ts +16 -0
- package/src/models/SfvbCommsDnsRecord.ts +111 -0
- package/src/models/SfvbCommsSendingDomain.ts +164 -0
- package/src/models/SfvbCommsSendingDomainsResponse.ts +74 -0
- package/src/models/SfvbCommsTwilioAccount.ts +147 -0
- package/src/models/SfvbCommsTwilioAccountResponse.ts +88 -0
- package/src/models/SfvbEmailRenderRequest.ts +91 -0
- package/src/models/SfvbEmailRenderResponse.ts +144 -0
- package/src/models/SfvbSecretRequestCreate.ts +1 -1
- package/src/models/SfvbTransactionalEmail.ts +91 -0
- package/src/models/SfvbTransactionalEmailsResponse.ts +74 -0
- package/src/models/index.ts +9 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -1007,6 +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/SfvbCommsDnsRecord.ts
|
|
1011
|
+
src/models/SfvbCommsSendingDomain.ts
|
|
1012
|
+
src/models/SfvbCommsSendingDomainsResponse.ts
|
|
1013
|
+
src/models/SfvbCommsTwilioAccount.ts
|
|
1014
|
+
src/models/SfvbCommsTwilioAccountResponse.ts
|
|
1010
1015
|
src/models/SfvbCompileRequest.ts
|
|
1011
1016
|
src/models/SfvbCompileResponse.ts
|
|
1012
1017
|
src/models/SfvbContainerResponse.ts
|
|
@@ -1017,6 +1022,8 @@ src/models/SfvbContainerWriteRequest.ts
|
|
|
1017
1022
|
src/models/SfvbElement.ts
|
|
1018
1023
|
src/models/SfvbElementSchemaResponse.ts
|
|
1019
1024
|
src/models/SfvbElementsResponse.ts
|
|
1025
|
+
src/models/SfvbEmailRenderRequest.ts
|
|
1026
|
+
src/models/SfvbEmailRenderResponse.ts
|
|
1020
1027
|
src/models/SfvbErrorDetail.ts
|
|
1021
1028
|
src/models/SfvbEvent.ts
|
|
1022
1029
|
src/models/SfvbEventsAuthRequest.ts
|
|
@@ -1198,6 +1205,8 @@ src/models/SfvbThemeFont.ts
|
|
|
1198
1205
|
src/models/SfvbThemeFontFamily.ts
|
|
1199
1206
|
src/models/SfvbThemeJobResponse.ts
|
|
1200
1207
|
src/models/SfvbThemesResponse.ts
|
|
1208
|
+
src/models/SfvbTransactionalEmail.ts
|
|
1209
|
+
src/models/SfvbTransactionalEmailsResponse.ts
|
|
1201
1210
|
src/models/SfvbUpsellItemLogic.ts
|
|
1202
1211
|
src/models/SfvbUpsellItemLogicItem.ts
|
|
1203
1212
|
src/models/SfvbUpsellOffer.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.205
|
|
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.205 --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.205 | 10/15/2026 | sfvb internal testing |
|
|
88
|
+
| 4.1.204 | 10/15/2026 | sfvb internal testing |
|
|
87
89
|
| 4.1.203 | 10/15/2026 | sfvb internal testing |
|
|
88
90
|
| 4.1.202 | 10/13/2026 | sfvb internal testing |
|
|
89
91
|
| 4.1.201 | 10/12/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, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, 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, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
|
|
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';
|
|
14
14
|
export interface AddSfvbPageBlogPostsRequest {
|
|
15
15
|
storefrontOid: number;
|
|
16
16
|
path: string;
|
|
@@ -61,6 +61,13 @@ export interface DeleteSfvbBlogPostRequest {
|
|
|
61
61
|
blogPostOid: number;
|
|
62
62
|
approvalId?: string;
|
|
63
63
|
}
|
|
64
|
+
export interface DeleteSfvbCommsSendingDomainRequest {
|
|
65
|
+
domain: string;
|
|
66
|
+
approvalId?: string;
|
|
67
|
+
}
|
|
68
|
+
export interface DeleteSfvbCommsTwilioAccountRequest {
|
|
69
|
+
approvalId?: string;
|
|
70
|
+
}
|
|
64
71
|
export interface DeleteSfvbFileRequest {
|
|
65
72
|
storefrontOid: number;
|
|
66
73
|
ifMatch: string;
|
|
@@ -201,6 +208,9 @@ export interface GetSfvbBlogPostRequest {
|
|
|
201
208
|
export interface GetSfvbCjsonUsedElementsRequest {
|
|
202
209
|
compileRequest: SfvbCompileRequest;
|
|
203
210
|
}
|
|
211
|
+
export interface GetSfvbCommsSendingDomainRequest {
|
|
212
|
+
domain: string;
|
|
213
|
+
}
|
|
204
214
|
export interface GetSfvbContainerRequest {
|
|
205
215
|
storefrontOid: number;
|
|
206
216
|
ownerType: string;
|
|
@@ -391,6 +401,9 @@ export interface GetSfvbThemeJobRequest {
|
|
|
391
401
|
storefrontOid: number;
|
|
392
402
|
jobId: number;
|
|
393
403
|
}
|
|
404
|
+
export interface GetSfvbTransactionalEmailsRequest {
|
|
405
|
+
storefrontOid: number;
|
|
406
|
+
}
|
|
394
407
|
export interface GetSfvbUpsellOfferRequest {
|
|
395
408
|
storefrontOid: number;
|
|
396
409
|
upsellOfferOid: number;
|
|
@@ -423,6 +436,12 @@ export interface InsertSfvbBlogPostRequest {
|
|
|
423
436
|
storefrontOid: number;
|
|
424
437
|
blogPostRequest: SfvbBlogPostRequest;
|
|
425
438
|
}
|
|
439
|
+
export interface InsertSfvbCommsSendingDomainRequest {
|
|
440
|
+
sendingDomain: SfvbCommsSendingDomain;
|
|
441
|
+
}
|
|
442
|
+
export interface InsertSfvbCommsTwilioAccountRequest {
|
|
443
|
+
twilioAccount: SfvbCommsTwilioAccount;
|
|
444
|
+
}
|
|
426
445
|
export interface InsertSfvbPageRequest {
|
|
427
446
|
storefrontOid: number;
|
|
428
447
|
pageCreateRequest: SfvbPageCreateRequest;
|
|
@@ -667,6 +686,9 @@ export interface PutSfvbThemeAttributesRequest {
|
|
|
667
686
|
themeOid: number;
|
|
668
687
|
attributeUpdateRequest: SfvbThemeAttributeUpdateRequest;
|
|
669
688
|
}
|
|
689
|
+
export interface RefreshSfvbCommsSendingDomainStatusRequest {
|
|
690
|
+
domain: string;
|
|
691
|
+
}
|
|
670
692
|
export interface RefreshSfvbPageRequest {
|
|
671
693
|
storefrontOid: number;
|
|
672
694
|
pageRefreshRequest: SfvbPageRefreshRequest;
|
|
@@ -681,6 +703,16 @@ export interface RemoveSfvbPageItemsRequest {
|
|
|
681
703
|
path: string;
|
|
682
704
|
pageItemsRemoveRequest: SfvbPageItemsRemoveRequest;
|
|
683
705
|
}
|
|
706
|
+
export interface RenderSfvbEmailRequest {
|
|
707
|
+
storefrontOid: number;
|
|
708
|
+
emailUuid: string;
|
|
709
|
+
emailRenderRequest: SfvbEmailRenderRequest;
|
|
710
|
+
}
|
|
711
|
+
export interface RenderSfvbTransactionalEmailRequest {
|
|
712
|
+
storefrontOid: number;
|
|
713
|
+
fileName: string;
|
|
714
|
+
emailRenderRequest: SfvbEmailRenderRequest;
|
|
715
|
+
}
|
|
684
716
|
export interface RenderSfvbWidgetsRequest {
|
|
685
717
|
storefrontOid: number;
|
|
686
718
|
themeOid: number;
|
|
@@ -776,6 +808,13 @@ export interface UpdateSfvbBlogPostRequest {
|
|
|
776
808
|
blogPostOid: number;
|
|
777
809
|
blogPostRequest: SfvbBlogPostRequest;
|
|
778
810
|
}
|
|
811
|
+
export interface UpdateSfvbCommsSendingDomainRequest {
|
|
812
|
+
domain: string;
|
|
813
|
+
sendingDomain: SfvbCommsSendingDomain;
|
|
814
|
+
}
|
|
815
|
+
export interface UpdateSfvbCommsTwilioAccountRequest {
|
|
816
|
+
twilioAccount: SfvbCommsTwilioAccount;
|
|
817
|
+
}
|
|
779
818
|
export interface UpdateSfvbItemAttributeBatchRequest {
|
|
780
819
|
storefrontOid: number;
|
|
781
820
|
itemAttributeBatchRequest: SfvbItemAttributeBatchRequest;
|
|
@@ -1007,6 +1046,35 @@ export interface SfvbApiInterface {
|
|
|
1007
1046
|
* Delete a blog post
|
|
1008
1047
|
*/
|
|
1009
1048
|
deleteSfvbBlogPost(requestParameters: DeleteSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
1049
|
+
/**
|
|
1050
|
+
* Removes the domain from UltraCart and from Amazon SES. Needs an approved sending_domain.delete request for it (POST approvals, params.domain).
|
|
1051
|
+
* @summary Remove a sending domain
|
|
1052
|
+
* @param {string} domain
|
|
1053
|
+
* @param {string} [approvalId] The approval_id of an approved sending_domain.delete request for this domain. See POST /sfvb/approvals.
|
|
1054
|
+
* @param {*} [options] Override http request option.
|
|
1055
|
+
* @throws {RequiredError}
|
|
1056
|
+
* @memberof SfvbApiInterface
|
|
1057
|
+
*/
|
|
1058
|
+
deleteSfvbCommsSendingDomainRaw(requestParameters: DeleteSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
1059
|
+
/**
|
|
1060
|
+
* Removes the domain from UltraCart and from Amazon SES. Needs an approved sending_domain.delete request for it (POST approvals, params.domain).
|
|
1061
|
+
* Remove a sending domain
|
|
1062
|
+
*/
|
|
1063
|
+
deleteSfvbCommsSendingDomain(requestParameters: DeleteSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
1064
|
+
/**
|
|
1065
|
+
* Removes the account\'s Twilio account and its credentials from UltraCart. The account stays at Twilio. Needs an approved twilio_account.delete request for it (POST approvals, params.esp_twilio_uuid).
|
|
1066
|
+
* @summary Remove the Twilio account
|
|
1067
|
+
* @param {string} [approvalId] The approval_id of an approved twilio_account.delete request for this account. See POST /sfvb/approvals.
|
|
1068
|
+
* @param {*} [options] Override http request option.
|
|
1069
|
+
* @throws {RequiredError}
|
|
1070
|
+
* @memberof SfvbApiInterface
|
|
1071
|
+
*/
|
|
1072
|
+
deleteSfvbCommsTwilioAccountRaw(requestParameters: DeleteSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
1073
|
+
/**
|
|
1074
|
+
* Removes the account\'s Twilio account and its credentials from UltraCart. The account stays at Twilio. Needs an approved twilio_account.delete request for it (POST approvals, params.esp_twilio_uuid).
|
|
1075
|
+
* Remove the Twilio account
|
|
1076
|
+
*/
|
|
1077
|
+
deleteSfvbCommsTwilioAccount(requestParameters: DeleteSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
1010
1078
|
/**
|
|
1011
1079
|
* Recoverable from the recycle bin.
|
|
1012
1080
|
* @summary Delete a storefront file
|
|
@@ -1489,6 +1557,46 @@ export interface SfvbApiInterface {
|
|
|
1489
1557
|
* Element types used by a container
|
|
1490
1558
|
*/
|
|
1491
1559
|
getSfvbCjsonUsedElements(requestParameters: GetSfvbCjsonUsedElementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementsResponse>;
|
|
1560
|
+
/**
|
|
1561
|
+
* One sending domain as stored. To check an amazon domain\'s DNS again, use the status call.
|
|
1562
|
+
* @summary Read a sending domain
|
|
1563
|
+
* @param {string} domain
|
|
1564
|
+
* @param {*} [options] Override http request option.
|
|
1565
|
+
* @throws {RequiredError}
|
|
1566
|
+
* @memberof SfvbApiInterface
|
|
1567
|
+
*/
|
|
1568
|
+
getSfvbCommsSendingDomainRaw(requestParameters: GetSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSendingDomain>>;
|
|
1569
|
+
/**
|
|
1570
|
+
* One sending domain as stored. To check an amazon domain\'s DNS again, use the status call.
|
|
1571
|
+
* Read a sending domain
|
|
1572
|
+
*/
|
|
1573
|
+
getSfvbCommsSendingDomain(requestParameters: GetSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSendingDomain>;
|
|
1574
|
+
/**
|
|
1575
|
+
* Every domain the account sends email from, with its provider, verification status and the DNS records an amazon domain needs. mailgun_api_key is always a mask.
|
|
1576
|
+
* @summary List the sending domains
|
|
1577
|
+
* @param {*} [options] Override http request option.
|
|
1578
|
+
* @throws {RequiredError}
|
|
1579
|
+
* @memberof SfvbApiInterface
|
|
1580
|
+
*/
|
|
1581
|
+
getSfvbCommsSendingDomainsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSendingDomainsResponse>>;
|
|
1582
|
+
/**
|
|
1583
|
+
* Every domain the account sends email from, with its provider, verification status and the DNS records an amazon domain needs. mailgun_api_key is always a mask.
|
|
1584
|
+
* List the sending domains
|
|
1585
|
+
*/
|
|
1586
|
+
getSfvbCommsSendingDomains(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSendingDomainsResponse>;
|
|
1587
|
+
/**
|
|
1588
|
+
* The account\'s Twilio account, used for SMS and the phone system, or none. An account has at most one. auth_token is always a mask.
|
|
1589
|
+
* @summary Read the Twilio account
|
|
1590
|
+
* @param {*} [options] Override http request option.
|
|
1591
|
+
* @throws {RequiredError}
|
|
1592
|
+
* @memberof SfvbApiInterface
|
|
1593
|
+
*/
|
|
1594
|
+
getSfvbCommsTwilioAccountRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsTwilioAccountResponse>>;
|
|
1595
|
+
/**
|
|
1596
|
+
* The account\'s Twilio account, used for SMS and the phone system, or none. An account has at most one. auth_token is always a mask.
|
|
1597
|
+
* Read the Twilio account
|
|
1598
|
+
*/
|
|
1599
|
+
getSfvbCommsTwilioAccount(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTwilioAccountResponse>;
|
|
1492
1600
|
/**
|
|
1493
1601
|
* owner_type is one of upsell, email, postcardfront, postcardback, item or itemid. It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid. itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere. Item containers also require container_name. Theme and page containers are files; read those through files/content.
|
|
1494
1602
|
* @summary Read a container stored outside the file system
|
|
@@ -2177,6 +2285,20 @@ export interface SfvbApiInterface {
|
|
|
2177
2285
|
* Status of an asynchronous theme job
|
|
2178
2286
|
*/
|
|
2179
2287
|
getSfvbThemeJob(requestParameters: GetSfvbThemeJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbThemeJobResponse>;
|
|
2288
|
+
/**
|
|
2289
|
+
* The order, shipment, auto order and other transactional emails this storefront sends, with their template files and the body container a draft replaces. Forgot password and chat verification are not listed, because they have no preview.
|
|
2290
|
+
* @summary List the transactional emails a storefront sends
|
|
2291
|
+
* @param {number} storefrontOid
|
|
2292
|
+
* @param {*} [options] Override http request option.
|
|
2293
|
+
* @throws {RequiredError}
|
|
2294
|
+
* @memberof SfvbApiInterface
|
|
2295
|
+
*/
|
|
2296
|
+
getSfvbTransactionalEmailsRaw(requestParameters: GetSfvbTransactionalEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTransactionalEmailsResponse>>;
|
|
2297
|
+
/**
|
|
2298
|
+
* The order, shipment, auto order and other transactional emails this storefront sends, with their template files and the body container a draft replaces. Forgot password and chat verification are not listed, because they have no preview.
|
|
2299
|
+
* List the transactional emails a storefront sends
|
|
2300
|
+
*/
|
|
2301
|
+
getSfvbTransactionalEmails(requestParameters: GetSfvbTransactionalEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTransactionalEmailsResponse>;
|
|
2180
2302
|
/**
|
|
2181
2303
|
* The whole offer, with the hash an update sends back in If-Match, which upsell items are out of stock now, and whether loyalty, TowerData and Everflow are set up. Stats as on the path list.
|
|
2182
2304
|
* @summary Get an upsell offer
|
|
@@ -2301,6 +2423,34 @@ export interface SfvbApiInterface {
|
|
|
2301
2423
|
* Create a blog post
|
|
2302
2424
|
*/
|
|
2303
2425
|
insertSfvbBlogPost(requestParameters: InsertSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
|
|
2426
|
+
/**
|
|
2427
|
+
* Adds a domain to send email from. An amazon domain starts verification with Amazon SES and returns the DNS records to publish; the person signed in also gets them by email. A mailgun domain needs mailgun_api_key as a secret handle made for the domain (POST secrets, sink mailgun.domain.api_key), never the key itself. UltraCart sets up its webhooks on the Mailgun domain with the key; if Mailgun refuses, nothing is saved and the handle is given back unused.
|
|
2428
|
+
* @summary Add a sending domain
|
|
2429
|
+
* @param {SfvbCommsSendingDomain} sendingDomain The sending domain
|
|
2430
|
+
* @param {*} [options] Override http request option.
|
|
2431
|
+
* @throws {RequiredError}
|
|
2432
|
+
* @memberof SfvbApiInterface
|
|
2433
|
+
*/
|
|
2434
|
+
insertSfvbCommsSendingDomainRaw(requestParameters: InsertSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSendingDomain>>;
|
|
2435
|
+
/**
|
|
2436
|
+
* Adds a domain to send email from. An amazon domain starts verification with Amazon SES and returns the DNS records to publish; the person signed in also gets them by email. A mailgun domain needs mailgun_api_key as a secret handle made for the domain (POST secrets, sink mailgun.domain.api_key), never the key itself. UltraCart sets up its webhooks on the Mailgun domain with the key; if Mailgun refuses, nothing is saved and the handle is given back unused.
|
|
2437
|
+
* Add a sending domain
|
|
2438
|
+
*/
|
|
2439
|
+
insertSfvbCommsSendingDomain(requestParameters: InsertSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSendingDomain>;
|
|
2440
|
+
/**
|
|
2441
|
+
* Connects the account\'s Twilio account with account_sid and auth_token. Send auth_token as a secret handle made for that account SID (POST secrets, sink twilio.account.auth_token), never the token itself. UltraCart checks the token with Twilio, then makes its API key, TwiML apps and voice encryption key on the account, as the admin does. If Twilio refuses, nothing is saved and the handle is given back unused. An account has at most one Twilio account, so this is refused when one exists; update it instead.
|
|
2442
|
+
* @summary Connect the Twilio account
|
|
2443
|
+
* @param {SfvbCommsTwilioAccount} twilioAccount The Twilio account
|
|
2444
|
+
* @param {*} [options] Override http request option.
|
|
2445
|
+
* @throws {RequiredError}
|
|
2446
|
+
* @memberof SfvbApiInterface
|
|
2447
|
+
*/
|
|
2448
|
+
insertSfvbCommsTwilioAccountRaw(requestParameters: InsertSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsTwilioAccountResponse>>;
|
|
2449
|
+
/**
|
|
2450
|
+
* Connects the account\'s Twilio account with account_sid and auth_token. Send auth_token as a secret handle made for that account SID (POST secrets, sink twilio.account.auth_token), never the token itself. UltraCart checks the token with Twilio, then makes its API key, TwiML apps and voice encryption key on the account, as the admin does. If Twilio refuses, nothing is saved and the handle is given back unused. An account has at most one Twilio account, so this is refused when one exists; update it instead.
|
|
2451
|
+
* Connect the Twilio account
|
|
2452
|
+
*/
|
|
2453
|
+
insertSfvbCommsTwilioAccount(requestParameters: InsertSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTwilioAccountResponse>;
|
|
2304
2454
|
/**
|
|
2305
2455
|
* Creates the page and its folder, the way the store admin\'s add page does. The parent page must already exist, and the last part of the path may only contain letters, digits, hyphens and underscores - it is refused, not cleaned. A path that already has a page is refused with a 409 and the code sfvb.page_exists. Without a group_template the page inherits its parent\'s templates, or catalog_group.vm directly under the root. Set attributes and images afterwards with the page attribute and image endpoints, and push the body to the page folder. Always needs sfvb_publish, because the page is live as soon as it exists. Deleting, moving and renaming pages stay in the store admin.
|
|
2306
2456
|
* @summary Create a page
|
|
@@ -3043,6 +3193,20 @@ export interface SfvbApiInterface {
|
|
|
3043
3193
|
* Change a theme\'s colors, fonts and settings
|
|
3044
3194
|
*/
|
|
3045
3195
|
putSfvbThemeAttributes(requestParameters: PutSfvbThemeAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbThemeAttributesResponse>;
|
|
3196
|
+
/**
|
|
3197
|
+
* Asks Amazon SES again whether an amazon domain\'s DNS records are in place, and restarts a verification that failed (its records then change). A mailgun domain comes back as it is; Mailgun checks its own records.
|
|
3198
|
+
* @summary Check a sending domain\'s verification
|
|
3199
|
+
* @param {string} domain
|
|
3200
|
+
* @param {*} [options] Override http request option.
|
|
3201
|
+
* @throws {RequiredError}
|
|
3202
|
+
* @memberof SfvbApiInterface
|
|
3203
|
+
*/
|
|
3204
|
+
refreshSfvbCommsSendingDomainStatusRaw(requestParameters: RefreshSfvbCommsSendingDomainStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSendingDomain>>;
|
|
3205
|
+
/**
|
|
3206
|
+
* Asks Amazon SES again whether an amazon domain\'s DNS records are in place, and restarts a verification that failed (its records then change). A mailgun domain comes back as it is; Mailgun checks its own records.
|
|
3207
|
+
* Check a sending domain\'s verification
|
|
3208
|
+
*/
|
|
3209
|
+
refreshSfvbCommsSendingDomainStatus(requestParameters: RefreshSfvbCommsSendingDomainStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSendingDomain>;
|
|
3046
3210
|
/**
|
|
3047
3211
|
* The next request renders the page fresh. Use it when a write succeeded, a read shows the new value, and the public page still shows the old one. Writes normally refresh the pages they affect, so a stale page after a write is a bug worth reporting with its URL. One page per request. The response says whether the page had a cached copy and whether anything was dropped.
|
|
3048
3212
|
* @summary Drop one page\'s cached copy
|
|
@@ -3090,6 +3254,38 @@ export interface SfvbApiInterface {
|
|
|
3090
3254
|
* Take items off a page
|
|
3091
3255
|
*/
|
|
3092
3256
|
removeSfvbPageItems(requestParameters: RemoveSfvbPageItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageItemsResponse>;
|
|
3257
|
+
/**
|
|
3258
|
+
* Renders a flow or campaign email exactly as its send would, and returns the subject, preview text, HTML and text. Nothing is sent, saved or created. A unique coupon code, click id and magic link token are placeholders. A missing footer token, which a send skips the email for, is a warning. Give cjson to render an unsaved draft of the email container in place of the saved one. An order must be a test order. cart_item_ids fills the cart a cart flow email shows.
|
|
3259
|
+
* @summary Render a flow or campaign email without sending it
|
|
3260
|
+
* @param {number} storefrontOid
|
|
3261
|
+
* @param {string} emailUuid
|
|
3262
|
+
* @param {SfvbEmailRenderRequest} emailRenderRequest What to render the email with
|
|
3263
|
+
* @param {*} [options] Override http request option.
|
|
3264
|
+
* @throws {RequiredError}
|
|
3265
|
+
* @memberof SfvbApiInterface
|
|
3266
|
+
*/
|
|
3267
|
+
renderSfvbEmailRaw(requestParameters: RenderSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEmailRenderResponse>>;
|
|
3268
|
+
/**
|
|
3269
|
+
* Renders a flow or campaign email exactly as its send would, and returns the subject, preview text, HTML and text. Nothing is sent, saved or created. A unique coupon code, click id and magic link token are placeholders. A missing footer token, which a send skips the email for, is a warning. Give cjson to render an unsaved draft of the email container in place of the saved one. An order must be a test order. cart_item_ids fills the cart a cart flow email shows.
|
|
3270
|
+
* Render a flow or campaign email without sending it
|
|
3271
|
+
*/
|
|
3272
|
+
renderSfvbEmail(requestParameters: RenderSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmailRenderResponse>;
|
|
3273
|
+
/**
|
|
3274
|
+
* Renders a transactional email, such as the order receipt, exactly as it is sent, and returns the subject, HTML and text. Nothing is sent or saved. file_name is the template file, such as receipt_html.vm, or the display name. Give cjson to render an unsaved draft of the email\'s body container in place of the saved one. The order must be a test order. Without one the email renders with a made up order.
|
|
3275
|
+
* @summary Render a transactional email without sending it
|
|
3276
|
+
* @param {number} storefrontOid
|
|
3277
|
+
* @param {string} fileName
|
|
3278
|
+
* @param {SfvbEmailRenderRequest} emailRenderRequest What to render the email with
|
|
3279
|
+
* @param {*} [options] Override http request option.
|
|
3280
|
+
* @throws {RequiredError}
|
|
3281
|
+
* @memberof SfvbApiInterface
|
|
3282
|
+
*/
|
|
3283
|
+
renderSfvbTransactionalEmailRaw(requestParameters: RenderSfvbTransactionalEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEmailRenderResponse>>;
|
|
3284
|
+
/**
|
|
3285
|
+
* Renders a transactional email, such as the order receipt, exactly as it is sent, and returns the subject, HTML and text. Nothing is sent or saved. file_name is the template file, such as receipt_html.vm, or the display name. Give cjson to render an unsaved draft of the email\'s body container in place of the saved one. The order must be a test order. Without one the email renders with a made up order.
|
|
3286
|
+
* Render a transactional email without sending it
|
|
3287
|
+
*/
|
|
3288
|
+
renderSfvbTransactionalEmail(requestParameters: RenderSfvbTransactionalEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmailRenderResponse>;
|
|
3093
3289
|
/**
|
|
3094
3290
|
* Renders one node in the context of a theme and a page. Unlike compile this is stateful. Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id. One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why. By default the node renders as a shopper sees it, with conditions, prices and sale state evaluated against the context item. Set edit_mode to render every branch the way the builder shows it, for styling content a shopper only sometimes sees.
|
|
3095
3291
|
* @summary Render a CJSON node to HTML
|
|
@@ -3394,6 +3590,35 @@ export interface SfvbApiInterface {
|
|
|
3394
3590
|
* Change a blog post
|
|
3395
3591
|
*/
|
|
3396
3592
|
updateSfvbBlogPost(requestParameters: UpdateSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
|
|
3593
|
+
/**
|
|
3594
|
+
* 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.
|
|
3595
|
+
* @summary Update a sending domain
|
|
3596
|
+
* @param {string} domain
|
|
3597
|
+
* @param {SfvbCommsSendingDomain} sendingDomain The changes
|
|
3598
|
+
* @param {*} [options] Override http request option.
|
|
3599
|
+
* @throws {RequiredError}
|
|
3600
|
+
* @memberof SfvbApiInterface
|
|
3601
|
+
*/
|
|
3602
|
+
updateSfvbCommsSendingDomainRaw(requestParameters: UpdateSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSendingDomain>>;
|
|
3603
|
+
/**
|
|
3604
|
+
* 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.
|
|
3605
|
+
* Update a sending domain
|
|
3606
|
+
*/
|
|
3607
|
+
updateSfvbCommsSendingDomain(requestParameters: UpdateSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSendingDomain>;
|
|
3608
|
+
/**
|
|
3609
|
+
* Changes the account\'s Twilio account. Leave a field out to keep it. Send auth_token as the mask it was read with to keep it, or as a secret handle made for the account SID to replace it. A new account_sid needs a new auth_token with it. A new token is checked with Twilio and UltraCart\'s API key, TwiML apps and voice encryption key are made again; if Twilio refuses, nothing is saved and the handle is given back unused. phone_numbers, when sent, replaces the list.
|
|
3610
|
+
* @summary Update the Twilio account
|
|
3611
|
+
* @param {SfvbCommsTwilioAccount} twilioAccount The changes
|
|
3612
|
+
* @param {*} [options] Override http request option.
|
|
3613
|
+
* @throws {RequiredError}
|
|
3614
|
+
* @memberof SfvbApiInterface
|
|
3615
|
+
*/
|
|
3616
|
+
updateSfvbCommsTwilioAccountRaw(requestParameters: UpdateSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsTwilioAccountResponse>>;
|
|
3617
|
+
/**
|
|
3618
|
+
* Changes the account\'s Twilio account. Leave a field out to keep it. Send auth_token as the mask it was read with to keep it, or as a secret handle made for the account SID to replace it. A new account_sid needs a new auth_token with it. A new token is checked with Twilio and UltraCart\'s API key, TwiML apps and voice encryption key are made again; if Twilio refuses, nothing is saved and the handle is given back unused. phone_numbers, when sent, replaces the list.
|
|
3619
|
+
* Update the Twilio account
|
|
3620
|
+
*/
|
|
3621
|
+
updateSfvbCommsTwilioAccount(requestParameters: UpdateSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTwilioAccountResponse>;
|
|
3397
3622
|
/**
|
|
3398
3623
|
* 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.
|
|
3399
3624
|
* @summary Change attributes across many items in one call
|
|
@@ -3649,6 +3874,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
3649
3874
|
* Delete a blog post
|
|
3650
3875
|
*/
|
|
3651
3876
|
deleteSfvbBlogPost(requestParameters: DeleteSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
3877
|
+
/**
|
|
3878
|
+
* Removes the domain from UltraCart and from Amazon SES. Needs an approved sending_domain.delete request for it (POST approvals, params.domain).
|
|
3879
|
+
* Remove a sending domain
|
|
3880
|
+
*/
|
|
3881
|
+
deleteSfvbCommsSendingDomainRaw(requestParameters: DeleteSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
3882
|
+
/**
|
|
3883
|
+
* Removes the domain from UltraCart and from Amazon SES. Needs an approved sending_domain.delete request for it (POST approvals, params.domain).
|
|
3884
|
+
* Remove a sending domain
|
|
3885
|
+
*/
|
|
3886
|
+
deleteSfvbCommsSendingDomain(requestParameters: DeleteSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
3887
|
+
/**
|
|
3888
|
+
* Removes the account\'s Twilio account and its credentials from UltraCart. The account stays at Twilio. Needs an approved twilio_account.delete request for it (POST approvals, params.esp_twilio_uuid).
|
|
3889
|
+
* Remove the Twilio account
|
|
3890
|
+
*/
|
|
3891
|
+
deleteSfvbCommsTwilioAccountRaw(requestParameters: DeleteSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
|
|
3892
|
+
/**
|
|
3893
|
+
* Removes the account\'s Twilio account and its credentials from UltraCart. The account stays at Twilio. Needs an approved twilio_account.delete request for it (POST approvals, params.esp_twilio_uuid).
|
|
3894
|
+
* Remove the Twilio account
|
|
3895
|
+
*/
|
|
3896
|
+
deleteSfvbCommsTwilioAccount(requestParameters?: DeleteSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
3652
3897
|
/**
|
|
3653
3898
|
* Recoverable from the recycle bin.
|
|
3654
3899
|
* Delete a storefront file
|
|
@@ -3957,6 +4202,36 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
3957
4202
|
* Element types used by a container
|
|
3958
4203
|
*/
|
|
3959
4204
|
getSfvbCjsonUsedElements(requestParameters: GetSfvbCjsonUsedElementsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementsResponse>;
|
|
4205
|
+
/**
|
|
4206
|
+
* One sending domain as stored. To check an amazon domain\'s DNS again, use the status call.
|
|
4207
|
+
* Read a sending domain
|
|
4208
|
+
*/
|
|
4209
|
+
getSfvbCommsSendingDomainRaw(requestParameters: GetSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSendingDomain>>;
|
|
4210
|
+
/**
|
|
4211
|
+
* One sending domain as stored. To check an amazon domain\'s DNS again, use the status call.
|
|
4212
|
+
* Read a sending domain
|
|
4213
|
+
*/
|
|
4214
|
+
getSfvbCommsSendingDomain(requestParameters: GetSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSendingDomain>;
|
|
4215
|
+
/**
|
|
4216
|
+
* Every domain the account sends email from, with its provider, verification status and the DNS records an amazon domain needs. mailgun_api_key is always a mask.
|
|
4217
|
+
* List the sending domains
|
|
4218
|
+
*/
|
|
4219
|
+
getSfvbCommsSendingDomainsRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSendingDomainsResponse>>;
|
|
4220
|
+
/**
|
|
4221
|
+
* Every domain the account sends email from, with its provider, verification status and the DNS records an amazon domain needs. mailgun_api_key is always a mask.
|
|
4222
|
+
* List the sending domains
|
|
4223
|
+
*/
|
|
4224
|
+
getSfvbCommsSendingDomains(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSendingDomainsResponse>;
|
|
4225
|
+
/**
|
|
4226
|
+
* The account\'s Twilio account, used for SMS and the phone system, or none. An account has at most one. auth_token is always a mask.
|
|
4227
|
+
* Read the Twilio account
|
|
4228
|
+
*/
|
|
4229
|
+
getSfvbCommsTwilioAccountRaw(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsTwilioAccountResponse>>;
|
|
4230
|
+
/**
|
|
4231
|
+
* The account\'s Twilio account, used for SMS and the phone system, or none. An account has at most one. auth_token is always a mask.
|
|
4232
|
+
* Read the Twilio account
|
|
4233
|
+
*/
|
|
4234
|
+
getSfvbCommsTwilioAccount(initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTwilioAccountResponse>;
|
|
3960
4235
|
/**
|
|
3961
4236
|
* owner_type is one of upsell, email, postcardfront, postcardback, item or itemid. It also says how owner_object_id is read - item and upsell take an oid, itemid takes a merchant item id, and the rest take an esp uuid. itemid reaches the same containers as item and is the way to address one from a storefront, where data-context-item-id carries the merchant item id and the oid appears nowhere. Item containers also require container_name. Theme and page containers are files; read those through files/content.
|
|
3962
4237
|
* Read a container stored outside the file system
|
|
@@ -4405,6 +4680,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
4405
4680
|
* Status of an asynchronous theme job
|
|
4406
4681
|
*/
|
|
4407
4682
|
getSfvbThemeJob(requestParameters: GetSfvbThemeJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbThemeJobResponse>;
|
|
4683
|
+
/**
|
|
4684
|
+
* The order, shipment, auto order and other transactional emails this storefront sends, with their template files and the body container a draft replaces. Forgot password and chat verification are not listed, because they have no preview.
|
|
4685
|
+
* List the transactional emails a storefront sends
|
|
4686
|
+
*/
|
|
4687
|
+
getSfvbTransactionalEmailsRaw(requestParameters: GetSfvbTransactionalEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTransactionalEmailsResponse>>;
|
|
4688
|
+
/**
|
|
4689
|
+
* The order, shipment, auto order and other transactional emails this storefront sends, with their template files and the body container a draft replaces. Forgot password and chat verification are not listed, because they have no preview.
|
|
4690
|
+
* List the transactional emails a storefront sends
|
|
4691
|
+
*/
|
|
4692
|
+
getSfvbTransactionalEmails(requestParameters: GetSfvbTransactionalEmailsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTransactionalEmailsResponse>;
|
|
4408
4693
|
/**
|
|
4409
4694
|
* The whole offer, with the hash an update sends back in If-Match, which upsell items are out of stock now, and whether loyalty, TowerData and Everflow are set up. Stats as on the path list.
|
|
4410
4695
|
* Get an upsell offer
|
|
@@ -4485,6 +4770,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
4485
4770
|
* Create a blog post
|
|
4486
4771
|
*/
|
|
4487
4772
|
insertSfvbBlogPost(requestParameters: InsertSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
|
|
4773
|
+
/**
|
|
4774
|
+
* Adds a domain to send email from. An amazon domain starts verification with Amazon SES and returns the DNS records to publish; the person signed in also gets them by email. A mailgun domain needs mailgun_api_key as a secret handle made for the domain (POST secrets, sink mailgun.domain.api_key), never the key itself. UltraCart sets up its webhooks on the Mailgun domain with the key; if Mailgun refuses, nothing is saved and the handle is given back unused.
|
|
4775
|
+
* Add a sending domain
|
|
4776
|
+
*/
|
|
4777
|
+
insertSfvbCommsSendingDomainRaw(requestParameters: InsertSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSendingDomain>>;
|
|
4778
|
+
/**
|
|
4779
|
+
* Adds a domain to send email from. An amazon domain starts verification with Amazon SES and returns the DNS records to publish; the person signed in also gets them by email. A mailgun domain needs mailgun_api_key as a secret handle made for the domain (POST secrets, sink mailgun.domain.api_key), never the key itself. UltraCart sets up its webhooks on the Mailgun domain with the key; if Mailgun refuses, nothing is saved and the handle is given back unused.
|
|
4780
|
+
* Add a sending domain
|
|
4781
|
+
*/
|
|
4782
|
+
insertSfvbCommsSendingDomain(requestParameters: InsertSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSendingDomain>;
|
|
4783
|
+
/**
|
|
4784
|
+
* Connects the account\'s Twilio account with account_sid and auth_token. Send auth_token as a secret handle made for that account SID (POST secrets, sink twilio.account.auth_token), never the token itself. UltraCart checks the token with Twilio, then makes its API key, TwiML apps and voice encryption key on the account, as the admin does. If Twilio refuses, nothing is saved and the handle is given back unused. An account has at most one Twilio account, so this is refused when one exists; update it instead.
|
|
4785
|
+
* Connect the Twilio account
|
|
4786
|
+
*/
|
|
4787
|
+
insertSfvbCommsTwilioAccountRaw(requestParameters: InsertSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsTwilioAccountResponse>>;
|
|
4788
|
+
/**
|
|
4789
|
+
* Connects the account\'s Twilio account with account_sid and auth_token. Send auth_token as a secret handle made for that account SID (POST secrets, sink twilio.account.auth_token), never the token itself. UltraCart checks the token with Twilio, then makes its API key, TwiML apps and voice encryption key on the account, as the admin does. If Twilio refuses, nothing is saved and the handle is given back unused. An account has at most one Twilio account, so this is refused when one exists; update it instead.
|
|
4790
|
+
* Connect the Twilio account
|
|
4791
|
+
*/
|
|
4792
|
+
insertSfvbCommsTwilioAccount(requestParameters: InsertSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTwilioAccountResponse>;
|
|
4488
4793
|
/**
|
|
4489
4794
|
* Creates the page and its folder, the way the store admin\'s add page does. The parent page must already exist, and the last part of the path may only contain letters, digits, hyphens and underscores - it is refused, not cleaned. A path that already has a page is refused with a 409 and the code sfvb.page_exists. Without a group_template the page inherits its parent\'s templates, or catalog_group.vm directly under the root. Set attributes and images afterwards with the page attribute and image endpoints, and push the body to the page folder. Always needs sfvb_publish, because the page is live as soon as it exists. Deleting, moving and renaming pages stay in the store admin.
|
|
4490
4795
|
* Create a page
|
|
@@ -4933,6 +5238,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
4933
5238
|
* Change a theme\'s colors, fonts and settings
|
|
4934
5239
|
*/
|
|
4935
5240
|
putSfvbThemeAttributes(requestParameters: PutSfvbThemeAttributesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbThemeAttributesResponse>;
|
|
5241
|
+
/**
|
|
5242
|
+
* Asks Amazon SES again whether an amazon domain\'s DNS records are in place, and restarts a verification that failed (its records then change). A mailgun domain comes back as it is; Mailgun checks its own records.
|
|
5243
|
+
* Check a sending domain\'s verification
|
|
5244
|
+
*/
|
|
5245
|
+
refreshSfvbCommsSendingDomainStatusRaw(requestParameters: RefreshSfvbCommsSendingDomainStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSendingDomain>>;
|
|
5246
|
+
/**
|
|
5247
|
+
* Asks Amazon SES again whether an amazon domain\'s DNS records are in place, and restarts a verification that failed (its records then change). A mailgun domain comes back as it is; Mailgun checks its own records.
|
|
5248
|
+
* Check a sending domain\'s verification
|
|
5249
|
+
*/
|
|
5250
|
+
refreshSfvbCommsSendingDomainStatus(requestParameters: RefreshSfvbCommsSendingDomainStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSendingDomain>;
|
|
4936
5251
|
/**
|
|
4937
5252
|
* The next request renders the page fresh. Use it when a write succeeded, a read shows the new value, and the public page still shows the old one. Writes normally refresh the pages they affect, so a stale page after a write is a bug worth reporting with its URL. One page per request. The response says whether the page had a cached copy and whether anything was dropped.
|
|
4938
5253
|
* Drop one page\'s cached copy
|
|
@@ -4963,6 +5278,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
4963
5278
|
* Take items off a page
|
|
4964
5279
|
*/
|
|
4965
5280
|
removeSfvbPageItems(requestParameters: RemoveSfvbPageItemsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageItemsResponse>;
|
|
5281
|
+
/**
|
|
5282
|
+
* Renders a flow or campaign email exactly as its send would, and returns the subject, preview text, HTML and text. Nothing is sent, saved or created. A unique coupon code, click id and magic link token are placeholders. A missing footer token, which a send skips the email for, is a warning. Give cjson to render an unsaved draft of the email container in place of the saved one. An order must be a test order. cart_item_ids fills the cart a cart flow email shows.
|
|
5283
|
+
* Render a flow or campaign email without sending it
|
|
5284
|
+
*/
|
|
5285
|
+
renderSfvbEmailRaw(requestParameters: RenderSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEmailRenderResponse>>;
|
|
5286
|
+
/**
|
|
5287
|
+
* Renders a flow or campaign email exactly as its send would, and returns the subject, preview text, HTML and text. Nothing is sent, saved or created. A unique coupon code, click id and magic link token are placeholders. A missing footer token, which a send skips the email for, is a warning. Give cjson to render an unsaved draft of the email container in place of the saved one. An order must be a test order. cart_item_ids fills the cart a cart flow email shows.
|
|
5288
|
+
* Render a flow or campaign email without sending it
|
|
5289
|
+
*/
|
|
5290
|
+
renderSfvbEmail(requestParameters: RenderSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmailRenderResponse>;
|
|
5291
|
+
/**
|
|
5292
|
+
* Renders a transactional email, such as the order receipt, exactly as it is sent, and returns the subject, HTML and text. Nothing is sent or saved. file_name is the template file, such as receipt_html.vm, or the display name. Give cjson to render an unsaved draft of the email\'s body container in place of the saved one. The order must be a test order. Without one the email renders with a made up order.
|
|
5293
|
+
* Render a transactional email without sending it
|
|
5294
|
+
*/
|
|
5295
|
+
renderSfvbTransactionalEmailRaw(requestParameters: RenderSfvbTransactionalEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbEmailRenderResponse>>;
|
|
5296
|
+
/**
|
|
5297
|
+
* Renders a transactional email, such as the order receipt, exactly as it is sent, and returns the subject, HTML and text. Nothing is sent or saved. file_name is the template file, such as receipt_html.vm, or the display name. Give cjson to render an unsaved draft of the email\'s body container in place of the saved one. The order must be a test order. Without one the email renders with a made up order.
|
|
5298
|
+
* Render a transactional email without sending it
|
|
5299
|
+
*/
|
|
5300
|
+
renderSfvbTransactionalEmail(requestParameters: RenderSfvbTransactionalEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmailRenderResponse>;
|
|
4966
5301
|
/**
|
|
4967
5302
|
* Renders one node in the context of a theme and a page. Unlike compile this is stateful. Rendering resolves merchant data, so an element bound to an item renders wrongly, and silently, without a context item id. One node per call, so a node that fails to render fails on its own rather than taking a batch with it, and a failure says why. By default the node renders as a shopper sees it, with conditions, prices and sale state evaluated against the context item. Set edit_mode to render every branch the way the builder shows it, for styling content a shopper only sometimes sees.
|
|
4968
5303
|
* Render a CJSON node to HTML
|
|
@@ -5153,6 +5488,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
5153
5488
|
* Change a blog post
|
|
5154
5489
|
*/
|
|
5155
5490
|
updateSfvbBlogPost(requestParameters: UpdateSfvbBlogPostRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbBlogPostDetail>;
|
|
5491
|
+
/**
|
|
5492
|
+
* 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.
|
|
5493
|
+
* Update a sending domain
|
|
5494
|
+
*/
|
|
5495
|
+
updateSfvbCommsSendingDomainRaw(requestParameters: UpdateSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsSendingDomain>>;
|
|
5496
|
+
/**
|
|
5497
|
+
* 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.
|
|
5498
|
+
* Update a sending domain
|
|
5499
|
+
*/
|
|
5500
|
+
updateSfvbCommsSendingDomain(requestParameters: UpdateSfvbCommsSendingDomainRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSendingDomain>;
|
|
5501
|
+
/**
|
|
5502
|
+
* Changes the account\'s Twilio account. Leave a field out to keep it. Send auth_token as the mask it was read with to keep it, or as a secret handle made for the account SID to replace it. A new account_sid needs a new auth_token with it. A new token is checked with Twilio and UltraCart\'s API key, TwiML apps and voice encryption key are made again; if Twilio refuses, nothing is saved and the handle is given back unused. phone_numbers, when sent, replaces the list.
|
|
5503
|
+
* Update the Twilio account
|
|
5504
|
+
*/
|
|
5505
|
+
updateSfvbCommsTwilioAccountRaw(requestParameters: UpdateSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsTwilioAccountResponse>>;
|
|
5506
|
+
/**
|
|
5507
|
+
* Changes the account\'s Twilio account. Leave a field out to keep it. Send auth_token as the mask it was read with to keep it, or as a secret handle made for the account SID to replace it. A new account_sid needs a new auth_token with it. A new token is checked with Twilio and UltraCart\'s API key, TwiML apps and voice encryption key are made again; if Twilio refuses, nothing is saved and the handle is given back unused. phone_numbers, when sent, replaces the list.
|
|
5508
|
+
* Update the Twilio account
|
|
5509
|
+
*/
|
|
5510
|
+
updateSfvbCommsTwilioAccount(requestParameters: UpdateSfvbCommsTwilioAccountRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsTwilioAccountResponse>;
|
|
5156
5511
|
/**
|
|
5157
5512
|
* 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.
|
|
5158
5513
|
* Change attributes across many items in one call
|