ultracart_rest_api_v2_typescript 4.1.230 → 4.1.231
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 +11 -0
- package/README.md +3 -2
- package/dist/apis/SfvbApi.d.ts +170 -1
- package/dist/apis/SfvbApi.js +351 -0
- package/dist/models/ItemAutoOrder.d.ts +1 -1
- package/dist/models/SfvbApprovalCreateRequest.d.ts +8 -0
- package/dist/models/SfvbApprovalCreateRequest.js +5 -1
- package/dist/models/SfvbCampaign.d.ts +6 -0
- package/dist/models/SfvbCampaign.js +2 -0
- package/dist/models/SfvbCommsMember.d.ts +43 -0
- package/dist/models/SfvbCommsMember.js +54 -0
- package/dist/models/SfvbCommsMembersResponse.d.ts +86 -0
- package/dist/models/SfvbCommsMembersResponse.js +69 -0
- package/dist/models/SfvbFlow.d.ts +6 -0
- package/dist/models/SfvbFlow.js +2 -0
- package/dist/models/SfvbPostcardAddress.d.ts +61 -0
- package/dist/models/SfvbPostcardAddress.js +60 -0
- package/dist/models/SfvbPostcardCard.d.ts +98 -0
- package/dist/models/SfvbPostcardCard.js +73 -0
- package/dist/models/SfvbPostcardTrackingResponse.d.ts +80 -0
- package/dist/models/SfvbPostcardTrackingResponse.js +67 -0
- package/dist/models/SfvbTransactionalChange.d.ts +49 -0
- package/dist/models/SfvbTransactionalChange.js +56 -0
- package/dist/models/SfvbTransactionalDeliveryOption.d.ts +43 -0
- package/dist/models/SfvbTransactionalDeliveryOption.js +54 -0
- package/dist/models/SfvbTransactionalEmailDetail.d.ts +69 -0
- package/dist/models/SfvbTransactionalEmailDetail.js +64 -0
- package/dist/models/SfvbTransactionalEmailResponse.d.ts +51 -0
- package/dist/models/SfvbTransactionalEmailResponse.js +58 -0
- package/dist/models/SfvbTransactionalEmailUpdateRequest.d.ts +62 -0
- package/dist/models/SfvbTransactionalEmailUpdateRequest.js +61 -0
- package/dist/models/SfvbTransactionalSender.d.ts +49 -0
- package/dist/models/SfvbTransactionalSender.js +56 -0
- package/dist/models/index.d.ts +11 -0
- package/dist/models/index.js +11 -0
- package/package.json +1 -1
- package/src/apis/SfvbApi.ts +426 -0
- package/src/models/ItemAutoOrder.ts +1 -1
- package/src/models/SfvbApprovalCreateRequest.ts +16 -1
- package/src/models/SfvbCampaign.ts +8 -0
- package/src/models/SfvbCommsMember.ts +83 -0
- package/src/models/SfvbCommsMembersResponse.ts +146 -0
- package/src/models/SfvbFlow.ts +8 -0
- package/src/models/SfvbPostcardAddress.ts +107 -0
- package/src/models/SfvbPostcardCard.ts +162 -0
- package/src/models/SfvbPostcardTrackingResponse.ts +138 -0
- package/src/models/SfvbTransactionalChange.ts +91 -0
- package/src/models/SfvbTransactionalDeliveryOption.ts +83 -0
- package/src/models/SfvbTransactionalEmailDetail.ts +128 -0
- package/src/models/SfvbTransactionalEmailResponse.ts +104 -0
- package/src/models/SfvbTransactionalEmailUpdateRequest.ts +114 -0
- package/src/models/SfvbTransactionalSender.ts +91 -0
- package/src/models/index.ts +11 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -1029,6 +1029,8 @@ src/models/SfvbCommsListDetail.ts
|
|
|
1029
1029
|
src/models/SfvbCommsListResponse.ts
|
|
1030
1030
|
src/models/SfvbCommsListWriteRequest.ts
|
|
1031
1031
|
src/models/SfvbCommsListsResponse.ts
|
|
1032
|
+
src/models/SfvbCommsMember.ts
|
|
1033
|
+
src/models/SfvbCommsMembersResponse.ts
|
|
1032
1034
|
src/models/SfvbCommsPostcard.ts
|
|
1033
1035
|
src/models/SfvbCommsSegment.ts
|
|
1034
1036
|
src/models/SfvbCommsSegmentDetail.ts
|
|
@@ -1177,8 +1179,11 @@ src/models/SfvbPageResponse.ts
|
|
|
1177
1179
|
src/models/SfvbPageSelectors.ts
|
|
1178
1180
|
src/models/SfvbPageSettingsRequest.ts
|
|
1179
1181
|
src/models/SfvbPageSummary.ts
|
|
1182
|
+
src/models/SfvbPostcardAddress.ts
|
|
1183
|
+
src/models/SfvbPostcardCard.ts
|
|
1180
1184
|
src/models/SfvbPostcardProofRequest.ts
|
|
1181
1185
|
src/models/SfvbPostcardProofResponse.ts
|
|
1186
|
+
src/models/SfvbPostcardTrackingResponse.ts
|
|
1182
1187
|
src/models/SfvbPreviewAccessRequest.ts
|
|
1183
1188
|
src/models/SfvbPreviewAccessResponse.ts
|
|
1184
1189
|
src/models/SfvbPreviewSessionRequest.ts
|
|
@@ -1287,8 +1292,14 @@ src/models/SfvbTrackingProviderSecrets.ts
|
|
|
1287
1292
|
src/models/SfvbTrackingProvidersResponse.ts
|
|
1288
1293
|
src/models/SfvbTrackingSettingsResponse.ts
|
|
1289
1294
|
src/models/SfvbTrackingWholesaleTier.ts
|
|
1295
|
+
src/models/SfvbTransactionalChange.ts
|
|
1296
|
+
src/models/SfvbTransactionalDeliveryOption.ts
|
|
1290
1297
|
src/models/SfvbTransactionalEmail.ts
|
|
1298
|
+
src/models/SfvbTransactionalEmailDetail.ts
|
|
1299
|
+
src/models/SfvbTransactionalEmailResponse.ts
|
|
1300
|
+
src/models/SfvbTransactionalEmailUpdateRequest.ts
|
|
1291
1301
|
src/models/SfvbTransactionalEmailsResponse.ts
|
|
1302
|
+
src/models/SfvbTransactionalSender.ts
|
|
1292
1303
|
src/models/SfvbUpsellItemLogic.ts
|
|
1293
1304
|
src/models/SfvbUpsellItemLogicItem.ts
|
|
1294
1305
|
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.231
|
|
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.231 --save
|
|
10
10
|
```
|
|
11
11
|
|
|
12
12
|
```typescript
|
|
@@ -84,6 +84,7 @@ Not every change is committed to every SDK.
|
|
|
84
84
|
|
|
85
85
|
| Version | Date | Comments |
|
|
86
86
|
| --: | :-: | --- |
|
|
87
|
+
| 4.1.231 | 11/05/2026 | sfvb internal testing |
|
|
87
88
|
| 4.1.230 | 11/05/2026 | sfvb internal testing |
|
|
88
89
|
| 4.1.229 | 11/04/2026 | sfvb internal testing |
|
|
89
90
|
| 4.1.228 | 11/04/2026 | sfvb internal testing |
|
package/dist/apis/SfvbApi.d.ts
CHANGED
|
@@ -10,7 +10,7 @@
|
|
|
10
10
|
* Do not edit the class manually.
|
|
11
11
|
*/
|
|
12
12
|
import * as runtime from '../runtime';
|
|
13
|
-
import { SfvbAffiliateNetwork, SfvbAffiliateNetworkRequest, SfvbAffiliateNetworksResponse, SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbArchiveRequest, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCampaign, SfvbCampaignWriteRequest, SfvbCampaignsResponse, SfvbCodeLibraryEmailsResponse, SfvbCommsFolderResponse, SfvbCommsFolderWriteRequest, SfvbCommsFoldersResponse, SfvbCommsListResponse, SfvbCommsListWriteRequest, SfvbCommsListsResponse, SfvbCommsSegmentResponse, SfvbCommsSegmentWriteRequest, SfvbCommsSegmentsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbEmail, SfvbEmailRenderRequest, SfvbEmailRenderResponse, SfvbEmailReviewRequest, SfvbEmailUpdateRequest, SfvbEventsAuthRequest, SfvbEventsAuthResponse, SfvbEventsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbFlow, SfvbFlowStatusRequest, SfvbFlowWriteRequest, SfvbFlowsResponse, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeBatchRequest, SfvbItemAttributeBatchResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaDescriptionRequest, SfvbItemMultimediaRequest, SfvbItemPricing, SfvbItemPricingRequest, SfvbItemRelated, SfvbItemRelatedRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbNotFoundEntry, SfvbNotFoundEntryResponse, SfvbNotFoundPage, SfvbNotFoundResponse, SfvbNotFoundSummary, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPostcardProofRequest, SfvbPostcardProofResponse, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveBatchRequest, SfvbRedirectResolveBatchResponse, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbSequence, SfvbSequenceStepCreateRequest, SfvbSequenceStepCreateResponse, SfvbSequenceStepDeleteResponse, SfvbSequenceStepMoveRequest, SfvbSequenceStepMoveResponse, SfvbSequenceStepUpdateRequest, SfvbSequenceStepUpdateResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbSiteSeo, SfvbSiteSeoRequest, SfvbSitemapsResponse, SfvbSmartAttribution, SfvbSmartAttributionRequest, SfvbStepDispatchLogsResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTrackingAdvancedRequest, SfvbTrackingHtml, SfvbTrackingHtmlRequest, SfvbTrackingHtmlResponse, SfvbTrackingPrivacyRequest, SfvbTrackingProvider, SfvbTrackingProviderRequest, SfvbTrackingProvidersResponse, SfvbTrackingSettingsResponse, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbUtmShortcode, SfvbUtmShortcodeRequest, SfvbUtmShortcodesResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
|
|
13
|
+
import { SfvbAffiliateNetwork, SfvbAffiliateNetworkRequest, SfvbAffiliateNetworksResponse, SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbArchiveRequest, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCampaign, SfvbCampaignWriteRequest, SfvbCampaignsResponse, SfvbCodeLibraryEmailsResponse, SfvbCommsFolderResponse, SfvbCommsFolderWriteRequest, SfvbCommsFoldersResponse, SfvbCommsListResponse, SfvbCommsListWriteRequest, SfvbCommsListsResponse, SfvbCommsMembersResponse, SfvbCommsSegmentResponse, SfvbCommsSegmentWriteRequest, SfvbCommsSegmentsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbEmail, SfvbEmailRenderRequest, SfvbEmailRenderResponse, SfvbEmailReviewRequest, SfvbEmailUpdateRequest, SfvbEventsAuthRequest, SfvbEventsAuthResponse, SfvbEventsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbFlow, SfvbFlowStatusRequest, SfvbFlowWriteRequest, SfvbFlowsResponse, SfvbI18nGlossary, SfvbI18nGlossaryRequest, SfvbI18nLanguageEnableRequest, SfvbI18nLanguagesResponse, SfvbI18nMachineTranslationsResponse, SfvbI18nMessage, SfvbI18nMessageWriteRequest, SfvbI18nMessagesResponse, SfvbI18nResetResponse, SfvbItemAttributeBatchRequest, SfvbItemAttributeBatchResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaDescriptionRequest, SfvbItemMultimediaRequest, SfvbItemPricing, SfvbItemPricingRequest, SfvbItemRelated, SfvbItemRelatedRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryDeleteResult, SfvbLibraryEntry, SfvbLibraryEntryRequest, SfvbLibraryHistoryResponse, SfvbLibraryInstallReceipt, SfvbLibraryInstallRequest, SfvbLibraryInstallsResponse, SfvbLibraryPublishRequest, SfvbLibraryResponse, SfvbLibraryScreenshotRequest, SfvbLibraryShareRequest, SfvbLibraryShareTargetsResponse, SfvbLibraryTaxonomyCatalog, SfvbLibraryUnshareResult, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbNotFoundEntry, SfvbNotFoundEntryResponse, SfvbNotFoundPage, SfvbNotFoundResponse, SfvbNotFoundSummary, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPostcardProofRequest, SfvbPostcardProofResponse, SfvbPostcardTrackingResponse, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, SfvbRedirect, SfvbRedirectCheckResponse, SfvbRedirectDeleteRequest, SfvbRedirectDeleteResponse, SfvbRedirectImportRequest, SfvbRedirectImportResponse, SfvbRedirectRequest, SfvbRedirectResolveBatchRequest, SfvbRedirectResolveBatchResponse, SfvbRedirectResolveResponse, SfvbRedirectResponse, SfvbRedirectsResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbSecretKindsResponse, SfvbSecretRequest, SfvbSecretRequestCreate, SfvbSecretRequestsResponse, SfvbSequence, SfvbSequenceStepCreateRequest, SfvbSequenceStepCreateResponse, SfvbSequenceStepDeleteResponse, SfvbSequenceStepMoveRequest, SfvbSequenceStepMoveResponse, SfvbSequenceStepUpdateRequest, SfvbSequenceStepUpdateResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbSiteSeo, SfvbSiteSeoRequest, SfvbSitemapsResponse, SfvbSmartAttribution, SfvbSmartAttributionRequest, SfvbStepDispatchLogsResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTestOrdersResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbTrackingAdvancedRequest, SfvbTrackingHtml, SfvbTrackingHtmlRequest, SfvbTrackingHtmlResponse, SfvbTrackingPrivacyRequest, SfvbTrackingProvider, SfvbTrackingProviderRequest, SfvbTrackingProvidersResponse, SfvbTrackingSettingsResponse, SfvbTransactionalEmailResponse, SfvbTransactionalEmailUpdateRequest, SfvbTransactionalEmailsResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbUtmShortcode, SfvbUtmShortcodeRequest, SfvbUtmShortcodesResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
|
|
14
14
|
export interface AddSfvbPageBlogPostsRequest {
|
|
15
15
|
storefrontOid: number;
|
|
16
16
|
path: string;
|
|
@@ -317,10 +317,24 @@ export interface GetSfvbCommsListRequest {
|
|
|
317
317
|
storefrontOid: number;
|
|
318
318
|
listUuid: string;
|
|
319
319
|
}
|
|
320
|
+
export interface GetSfvbCommsListMembersRequest {
|
|
321
|
+
storefrontOid: number;
|
|
322
|
+
listUuid: string;
|
|
323
|
+
page?: number;
|
|
324
|
+
pageSize?: number;
|
|
325
|
+
showCustomerData?: boolean;
|
|
326
|
+
}
|
|
320
327
|
export interface GetSfvbCommsSegmentRequest {
|
|
321
328
|
storefrontOid: number;
|
|
322
329
|
segmentUuid: string;
|
|
323
330
|
}
|
|
331
|
+
export interface GetSfvbCommsSegmentMembersRequest {
|
|
332
|
+
storefrontOid: number;
|
|
333
|
+
segmentUuid: string;
|
|
334
|
+
page?: number;
|
|
335
|
+
pageSize?: number;
|
|
336
|
+
showCustomerData?: boolean;
|
|
337
|
+
}
|
|
324
338
|
export interface GetSfvbCommsSendingDomainRequest {
|
|
325
339
|
domain: string;
|
|
326
340
|
}
|
|
@@ -469,6 +483,13 @@ export interface GetSfvbPageSelectorsRequest {
|
|
|
469
483
|
storefrontOid: number;
|
|
470
484
|
path: string;
|
|
471
485
|
}
|
|
486
|
+
export interface GetSfvbPostcardTrackingRequest {
|
|
487
|
+
storefrontOid: number;
|
|
488
|
+
postcardUuid: string;
|
|
489
|
+
page?: number;
|
|
490
|
+
pageSize?: number;
|
|
491
|
+
showCustomerData?: boolean;
|
|
492
|
+
}
|
|
472
493
|
export interface GetSfvbPreviewUrlRequest {
|
|
473
494
|
storefrontOid: number;
|
|
474
495
|
previewSessionId: string;
|
|
@@ -565,6 +586,10 @@ export interface GetSfvbTrackingProvidersRequest {
|
|
|
565
586
|
export interface GetSfvbTrackingSettingsRequest {
|
|
566
587
|
storefrontOid: number;
|
|
567
588
|
}
|
|
589
|
+
export interface GetSfvbTransactionalEmailRequest {
|
|
590
|
+
storefrontOid: number;
|
|
591
|
+
fileName: string;
|
|
592
|
+
}
|
|
568
593
|
export interface GetSfvbTransactionalEmailsRequest {
|
|
569
594
|
storefrontOid: number;
|
|
570
595
|
}
|
|
@@ -1172,6 +1197,13 @@ export interface UpdateSfvbTrackingProviderRequest {
|
|
|
1172
1197
|
trackingProviderRequest: SfvbTrackingProviderRequest;
|
|
1173
1198
|
approvalId?: string;
|
|
1174
1199
|
}
|
|
1200
|
+
export interface UpdateSfvbTransactionalEmailRequest {
|
|
1201
|
+
storefrontOid: number;
|
|
1202
|
+
fileName: string;
|
|
1203
|
+
ifMatch: string;
|
|
1204
|
+
transactionalEmailUpdateRequest: SfvbTransactionalEmailUpdateRequest;
|
|
1205
|
+
approvalId?: string;
|
|
1206
|
+
}
|
|
1175
1207
|
export interface UpdateSfvbUpsellOfferRequest {
|
|
1176
1208
|
storefrontOid: number;
|
|
1177
1209
|
upsellOfferOid: number;
|
|
@@ -2276,6 +2308,24 @@ export interface SfvbApiInterface {
|
|
|
2276
2308
|
* Read one email list
|
|
2277
2309
|
*/
|
|
2278
2310
|
getSfvbCommsList(requestParameters: GetSfvbCommsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsListResponse>;
|
|
2311
|
+
/**
|
|
2312
|
+
* Each member\'s customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person\'s address. Read only.
|
|
2313
|
+
* @summary Read one page of a list\'s members
|
|
2314
|
+
* @param {number} storefrontOid
|
|
2315
|
+
* @param {string} listUuid
|
|
2316
|
+
* @param {number} [page] The page, from 1
|
|
2317
|
+
* @param {number} [pageSize] Members per page, 1 to 100 (default 50)
|
|
2318
|
+
* @param {boolean} [showCustomerData] True to return the real email addresses instead of masked ones
|
|
2319
|
+
* @param {*} [options] Override http request option.
|
|
2320
|
+
* @throws {RequiredError}
|
|
2321
|
+
* @memberof SfvbApiInterface
|
|
2322
|
+
*/
|
|
2323
|
+
getSfvbCommsListMembersRaw(requestParameters: GetSfvbCommsListMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsMembersResponse>>;
|
|
2324
|
+
/**
|
|
2325
|
+
* Each member\'s customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person\'s address. Read only.
|
|
2326
|
+
* Read one page of a list\'s members
|
|
2327
|
+
*/
|
|
2328
|
+
getSfvbCommsListMembers(requestParameters: GetSfvbCommsListMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsMembersResponse>;
|
|
2279
2329
|
/**
|
|
2280
2330
|
* The segment\'s name, folder, rule, member count at its last rebuild, whether a rebuild is still due, and the campaigns and flows that use it, each with whether it is live. hash_sha256 is the If-Match for an update. Never its members, its Facebook audience, its ranking or its third party sync settings.
|
|
2281
2331
|
* @summary Read one segment, with its rule
|
|
@@ -2291,6 +2341,24 @@ export interface SfvbApiInterface {
|
|
|
2291
2341
|
* Read one segment, with its rule
|
|
2292
2342
|
*/
|
|
2293
2343
|
getSfvbCommsSegment(requestParameters: GetSfvbCommsSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSegmentResponse>;
|
|
2344
|
+
/**
|
|
2345
|
+
* Each member\'s customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person\'s address. Read only.
|
|
2346
|
+
* @summary Read one page of a segment\'s members
|
|
2347
|
+
* @param {number} storefrontOid
|
|
2348
|
+
* @param {string} segmentUuid
|
|
2349
|
+
* @param {number} [page] The page, from 1
|
|
2350
|
+
* @param {number} [pageSize] Members per page, 1 to 100 (default 50)
|
|
2351
|
+
* @param {boolean} [showCustomerData] True to return the real email addresses instead of masked ones
|
|
2352
|
+
* @param {*} [options] Override http request option.
|
|
2353
|
+
* @throws {RequiredError}
|
|
2354
|
+
* @memberof SfvbApiInterface
|
|
2355
|
+
*/
|
|
2356
|
+
getSfvbCommsSegmentMembersRaw(requestParameters: GetSfvbCommsSegmentMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsMembersResponse>>;
|
|
2357
|
+
/**
|
|
2358
|
+
* Each member\'s customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person\'s address. Read only.
|
|
2359
|
+
* Read one page of a segment\'s members
|
|
2360
|
+
*/
|
|
2361
|
+
getSfvbCommsSegmentMembers(requestParameters: GetSfvbCommsSegmentMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsMembersResponse>;
|
|
2294
2362
|
/**
|
|
2295
2363
|
* One sending domain as stored. To check an amazon domain\'s DNS again, use the status call.
|
|
2296
2364
|
* @summary Read a sending domain
|
|
@@ -2839,6 +2907,24 @@ export interface SfvbApiInterface {
|
|
|
2839
2907
|
* Read a page\'s selectors
|
|
2840
2908
|
*/
|
|
2841
2909
|
getSfvbPageSelectors(requestParameters: GetSfvbPageSelectorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageSelectors>;
|
|
2910
|
+
/**
|
|
2911
|
+
* Every printed card mailed for the postcard, newest first, with its status, cost, dates and the order it converted to. Recipients are masked (the name an initial, the street lines hidden, city, state and postal code kept) and the vendor\'s status text is left out, unless show_customer_data is true, which needs the sfvb_publish scope and is logged. The return address is the merchant\'s own. Read only.
|
|
2912
|
+
* @summary Read one page of the cards mailed for a postcard
|
|
2913
|
+
* @param {number} storefrontOid
|
|
2914
|
+
* @param {string} postcardUuid
|
|
2915
|
+
* @param {number} [page] The page, from 1
|
|
2916
|
+
* @param {number} [pageSize] Cards per page, 1 to 100 (default 50)
|
|
2917
|
+
* @param {boolean} [showCustomerData] True to return the recipients\' real names and street addresses
|
|
2918
|
+
* @param {*} [options] Override http request option.
|
|
2919
|
+
* @throws {RequiredError}
|
|
2920
|
+
* @memberof SfvbApiInterface
|
|
2921
|
+
*/
|
|
2922
|
+
getSfvbPostcardTrackingRaw(requestParameters: GetSfvbPostcardTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPostcardTrackingResponse>>;
|
|
2923
|
+
/**
|
|
2924
|
+
* Every printed card mailed for the postcard, newest first, with its status, cost, dates and the order it converted to. Recipients are masked (the name an initial, the street lines hidden, city, state and postal code kept) and the vendor\'s status text is left out, unless show_customer_data is true, which needs the sfvb_publish scope and is logged. The return address is the merchant\'s own. Read only.
|
|
2925
|
+
* Read one page of the cards mailed for a postcard
|
|
2926
|
+
*/
|
|
2927
|
+
getSfvbPostcardTracking(requestParameters: GetSfvbPostcardTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPostcardTrackingResponse>;
|
|
2842
2928
|
/**
|
|
2843
2929
|
* Refuses a session that does not exist, so a URL you receive is for a session that was really there. expires_in_seconds is the time actually remaining, not the configured lifetime. Needs a token that resolves to a user, because a preview session belongs to the person who created it.
|
|
2844
2930
|
* @summary URL that renders a preview session
|
|
@@ -3213,6 +3299,21 @@ export interface SfvbApiInterface {
|
|
|
3213
3299
|
* Read a storefront\'s privacy rules and advanced conversion settings
|
|
3214
3300
|
*/
|
|
3215
3301
|
getSfvbTrackingSettings(requestParameters: GetSfvbTrackingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTrackingSettingsResponse>;
|
|
3302
|
+
/**
|
|
3303
|
+
* file_name is the template file from the transactional email list, such as receipt_html.vm, or its display name. The sender is shared by every storefront on the same screen branding theme (sender_shared_with); a sender that sends through the merchant\'s own mail server shows smtp true and never its credentials. hash_sha256 is the If-Match for an update. The template itself is a theme file.
|
|
3304
|
+
* @summary Read a transactional email\'s subject, delivery options and sender
|
|
3305
|
+
* @param {number} storefrontOid
|
|
3306
|
+
* @param {string} fileName
|
|
3307
|
+
* @param {*} [options] Override http request option.
|
|
3308
|
+
* @throws {RequiredError}
|
|
3309
|
+
* @memberof SfvbApiInterface
|
|
3310
|
+
*/
|
|
3311
|
+
getSfvbTransactionalEmailRaw(requestParameters: GetSfvbTransactionalEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTransactionalEmailResponse>>;
|
|
3312
|
+
/**
|
|
3313
|
+
* file_name is the template file from the transactional email list, such as receipt_html.vm, or its display name. The sender is shared by every storefront on the same screen branding theme (sender_shared_with); a sender that sends through the merchant\'s own mail server shows smtp true and never its credentials. hash_sha256 is the If-Match for an update. The template itself is a theme file.
|
|
3314
|
+
* Read a transactional email\'s subject, delivery options and sender
|
|
3315
|
+
*/
|
|
3316
|
+
getSfvbTransactionalEmail(requestParameters: GetSfvbTransactionalEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTransactionalEmailResponse>;
|
|
3216
3317
|
/**
|
|
3217
3318
|
* 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.
|
|
3218
3319
|
* @summary List the transactional emails a storefront sends
|
|
@@ -5125,6 +5226,24 @@ export interface SfvbApiInterface {
|
|
|
5125
5226
|
* Change one tracking provider
|
|
5126
5227
|
*/
|
|
5127
5228
|
updateSfvbTrackingProvider(requestParameters: UpdateSfvbTrackingProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTrackingProvider>;
|
|
5229
|
+
/**
|
|
5230
|
+
* A field left out stays as it is. It goes to every matching order from the moment it is saved, so every change needs sfvb_publish, the email\'s hash_sha256 as If-Match, and an approved transactional_email.update request for exactly this change (params.path the template file). dry_run checks and shows the change without writing or using an approval. Delivery options are named by name. A sender change reaches every storefront on the same screen branding theme, and is refused for one that sends through the merchant\'s own mail server.
|
|
5231
|
+
* @summary Change a transactional email\'s subject, delivery options or sender
|
|
5232
|
+
* @param {number} storefrontOid
|
|
5233
|
+
* @param {string} fileName
|
|
5234
|
+
* @param {string} ifMatch The email\'s hash_sha256 from the last read. Required; 428 when absent, 412 when stale.
|
|
5235
|
+
* @param {SfvbTransactionalEmailUpdateRequest} transactionalEmailUpdateRequest The fields to change
|
|
5236
|
+
* @param {string} [approvalId] The approval_id of an approved transactional_email.update request for exactly this change. See POST /sfvb/approvals.
|
|
5237
|
+
* @param {*} [options] Override http request option.
|
|
5238
|
+
* @throws {RequiredError}
|
|
5239
|
+
* @memberof SfvbApiInterface
|
|
5240
|
+
*/
|
|
5241
|
+
updateSfvbTransactionalEmailRaw(requestParameters: UpdateSfvbTransactionalEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTransactionalEmailResponse>>;
|
|
5242
|
+
/**
|
|
5243
|
+
* A field left out stays as it is. It goes to every matching order from the moment it is saved, so every change needs sfvb_publish, the email\'s hash_sha256 as If-Match, and an approved transactional_email.update request for exactly this change (params.path the template file). dry_run checks and shows the change without writing or using an approval. Delivery options are named by name. A sender change reaches every storefront on the same screen branding theme, and is refused for one that sends through the merchant\'s own mail server.
|
|
5244
|
+
* Change a transactional email\'s subject, delivery options or sender
|
|
5245
|
+
*/
|
|
5246
|
+
updateSfvbTransactionalEmail(requestParameters: UpdateSfvbTransactionalEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTransactionalEmailResponse>;
|
|
5128
5247
|
/**
|
|
5129
5248
|
* A full replace. Send back the whole offer you read, changed, with its hash_sha256 in If-Match. Read only fields are ignored and a writable field left out is cleared. Changing an offer that is switched on, or changing upsell_item_id_javascript or offsite_content_url, needs sfvb_publish. An update cannot switch an offer on; that is the enable call, which needs approval. Settings the API does not show, such as the offer\'s screenshots, are kept.
|
|
5130
5249
|
* @summary Update an upsell offer
|
|
@@ -5915,6 +6034,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
5915
6034
|
* Read one email list
|
|
5916
6035
|
*/
|
|
5917
6036
|
getSfvbCommsList(requestParameters: GetSfvbCommsListRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsListResponse>;
|
|
6037
|
+
/**
|
|
6038
|
+
* Each member\'s customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person\'s address. Read only.
|
|
6039
|
+
* Read one page of a list\'s members
|
|
6040
|
+
*/
|
|
6041
|
+
getSfvbCommsListMembersRaw(requestParameters: GetSfvbCommsListMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsMembersResponse>>;
|
|
6042
|
+
/**
|
|
6043
|
+
* Each member\'s customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person\'s address. Read only.
|
|
6044
|
+
* Read one page of a list\'s members
|
|
6045
|
+
*/
|
|
6046
|
+
getSfvbCommsListMembers(requestParameters: GetSfvbCommsListMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsMembersResponse>;
|
|
5918
6047
|
/**
|
|
5919
6048
|
* The segment\'s name, folder, rule, member count at its last rebuild, whether a rebuild is still due, and the campaigns and flows that use it, each with whether it is live. hash_sha256 is the If-Match for an update. Never its members, its Facebook audience, its ranking or its third party sync settings.
|
|
5920
6049
|
* Read one segment, with its rule
|
|
@@ -5925,6 +6054,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
5925
6054
|
* Read one segment, with its rule
|
|
5926
6055
|
*/
|
|
5927
6056
|
getSfvbCommsSegment(requestParameters: GetSfvbCommsSegmentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsSegmentResponse>;
|
|
6057
|
+
/**
|
|
6058
|
+
* Each member\'s customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person\'s address. Read only.
|
|
6059
|
+
* Read one page of a segment\'s members
|
|
6060
|
+
*/
|
|
6061
|
+
getSfvbCommsSegmentMembersRaw(requestParameters: GetSfvbCommsSegmentMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsMembersResponse>>;
|
|
6062
|
+
/**
|
|
6063
|
+
* Each member\'s customer uuid, email and the date they joined. Email addresses are masked (w***a@example.com) and customer_data is masked, unless show_customer_data is true, which returns the real addresses and needs the sfvb_publish scope. Every such read is logged. Ask for them only when the merchant needs a person\'s address. Read only.
|
|
6064
|
+
* Read one page of a segment\'s members
|
|
6065
|
+
*/
|
|
6066
|
+
getSfvbCommsSegmentMembers(requestParameters: GetSfvbCommsSegmentMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsMembersResponse>;
|
|
5928
6067
|
/**
|
|
5929
6068
|
* One sending domain as stored. To check an amazon domain\'s DNS again, use the status call.
|
|
5930
6069
|
* Read a sending domain
|
|
@@ -6285,6 +6424,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
6285
6424
|
* Read a page\'s selectors
|
|
6286
6425
|
*/
|
|
6287
6426
|
getSfvbPageSelectors(requestParameters: GetSfvbPageSelectorsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPageSelectors>;
|
|
6427
|
+
/**
|
|
6428
|
+
* Every printed card mailed for the postcard, newest first, with its status, cost, dates and the order it converted to. Recipients are masked (the name an initial, the street lines hidden, city, state and postal code kept) and the vendor\'s status text is left out, unless show_customer_data is true, which needs the sfvb_publish scope and is logged. The return address is the merchant\'s own. Read only.
|
|
6429
|
+
* Read one page of the cards mailed for a postcard
|
|
6430
|
+
*/
|
|
6431
|
+
getSfvbPostcardTrackingRaw(requestParameters: GetSfvbPostcardTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPostcardTrackingResponse>>;
|
|
6432
|
+
/**
|
|
6433
|
+
* Every printed card mailed for the postcard, newest first, with its status, cost, dates and the order it converted to. Recipients are masked (the name an initial, the street lines hidden, city, state and postal code kept) and the vendor\'s status text is left out, unless show_customer_data is true, which needs the sfvb_publish scope and is logged. The return address is the merchant\'s own. Read only.
|
|
6434
|
+
* Read one page of the cards mailed for a postcard
|
|
6435
|
+
*/
|
|
6436
|
+
getSfvbPostcardTracking(requestParameters: GetSfvbPostcardTrackingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPostcardTrackingResponse>;
|
|
6288
6437
|
/**
|
|
6289
6438
|
* Refuses a session that does not exist, so a URL you receive is for a session that was really there. expires_in_seconds is the time actually remaining, not the configured lifetime. Needs a token that resolves to a user, because a preview session belongs to the person who created it.
|
|
6290
6439
|
* URL that renders a preview session
|
|
@@ -6533,6 +6682,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
6533
6682
|
* Read a storefront\'s privacy rules and advanced conversion settings
|
|
6534
6683
|
*/
|
|
6535
6684
|
getSfvbTrackingSettings(requestParameters: GetSfvbTrackingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTrackingSettingsResponse>;
|
|
6685
|
+
/**
|
|
6686
|
+
* file_name is the template file from the transactional email list, such as receipt_html.vm, or its display name. The sender is shared by every storefront on the same screen branding theme (sender_shared_with); a sender that sends through the merchant\'s own mail server shows smtp true and never its credentials. hash_sha256 is the If-Match for an update. The template itself is a theme file.
|
|
6687
|
+
* Read a transactional email\'s subject, delivery options and sender
|
|
6688
|
+
*/
|
|
6689
|
+
getSfvbTransactionalEmailRaw(requestParameters: GetSfvbTransactionalEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTransactionalEmailResponse>>;
|
|
6690
|
+
/**
|
|
6691
|
+
* file_name is the template file from the transactional email list, such as receipt_html.vm, or its display name. The sender is shared by every storefront on the same screen branding theme (sender_shared_with); a sender that sends through the merchant\'s own mail server shows smtp true and never its credentials. hash_sha256 is the If-Match for an update. The template itself is a theme file.
|
|
6692
|
+
* Read a transactional email\'s subject, delivery options and sender
|
|
6693
|
+
*/
|
|
6694
|
+
getSfvbTransactionalEmail(requestParameters: GetSfvbTransactionalEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTransactionalEmailResponse>;
|
|
6536
6695
|
/**
|
|
6537
6696
|
* 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.
|
|
6538
6697
|
* List the transactional emails a storefront sends
|
|
@@ -7711,6 +7870,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
7711
7870
|
* Change one tracking provider
|
|
7712
7871
|
*/
|
|
7713
7872
|
updateSfvbTrackingProvider(requestParameters: UpdateSfvbTrackingProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTrackingProvider>;
|
|
7873
|
+
/**
|
|
7874
|
+
* A field left out stays as it is. It goes to every matching order from the moment it is saved, so every change needs sfvb_publish, the email\'s hash_sha256 as If-Match, and an approved transactional_email.update request for exactly this change (params.path the template file). dry_run checks and shows the change without writing or using an approval. Delivery options are named by name. A sender change reaches every storefront on the same screen branding theme, and is refused for one that sends through the merchant\'s own mail server.
|
|
7875
|
+
* Change a transactional email\'s subject, delivery options or sender
|
|
7876
|
+
*/
|
|
7877
|
+
updateSfvbTransactionalEmailRaw(requestParameters: UpdateSfvbTransactionalEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTransactionalEmailResponse>>;
|
|
7878
|
+
/**
|
|
7879
|
+
* A field left out stays as it is. It goes to every matching order from the moment it is saved, so every change needs sfvb_publish, the email\'s hash_sha256 as If-Match, and an approved transactional_email.update request for exactly this change (params.path the template file). dry_run checks and shows the change without writing or using an approval. Delivery options are named by name. A sender change reaches every storefront on the same screen branding theme, and is refused for one that sends through the merchant\'s own mail server.
|
|
7880
|
+
* Change a transactional email\'s subject, delivery options or sender
|
|
7881
|
+
*/
|
|
7882
|
+
updateSfvbTransactionalEmail(requestParameters: UpdateSfvbTransactionalEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTransactionalEmailResponse>;
|
|
7714
7883
|
/**
|
|
7715
7884
|
* A full replace. Send back the whole offer you read, changed, with its hash_sha256 in If-Match. Read only fields are ignored and a writable field left out is cleared. Changing an offer that is switched on, or changing upsell_item_id_javascript or offsite_content_url, needs sfvb_publish. An update cannot switch an offer on; that is the enable call, which needs approval. Settings the API does not show, such as the offer\'s screenshots, are kept.
|
|
7716
7885
|
* Update an upsell offer
|