ultracart_rest_api_v2_typescript 4.1.233 → 4.1.235
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 +10 -0
- package/README.md +4 -2
- package/dist/apis/SfvbApi.d.ts +112 -9
- package/dist/apis/SfvbApi.js +221 -4
- package/dist/models/SfvbApprovalParams.d.ts +1 -1
- package/dist/models/SfvbCommsLookupOwner.d.ts +6 -0
- package/dist/models/SfvbCommsLookupOwner.js +2 -0
- package/dist/models/SfvbCommsLookupResponse.d.ts +6 -0
- package/dist/models/SfvbCommsLookupResponse.js +2 -0
- package/dist/models/SfvbPreviewTrackingHtmlRequest.d.ts +37 -0
- package/dist/models/SfvbPreviewTrackingHtmlRequest.js +52 -0
- package/dist/models/SfvbServerLog.d.ts +1 -1
- package/dist/models/SfvbTrackingCheckPlan.d.ts +123 -0
- package/dist/models/SfvbTrackingCheckPlan.js +92 -0
- package/dist/models/SfvbTrackingCheckPlanEvent.d.ts +52 -0
- package/dist/models/SfvbTrackingCheckPlanEvent.js +62 -0
- package/dist/models/SfvbTrackingCheckPlanGate.d.ts +55 -0
- package/dist/models/SfvbTrackingCheckPlanGate.js +68 -0
- package/dist/models/SfvbTrackingCheckPlanProvider.d.ts +100 -0
- package/dist/models/SfvbTrackingCheckPlanProvider.js +85 -0
- package/dist/models/SfvbTrackingCheckPlanRequest.d.ts +58 -0
- package/dist/models/SfvbTrackingCheckPlanRequest.js +64 -0
- package/dist/models/SfvbTrackingCheckPlanServerSide.d.ts +37 -0
- package/dist/models/SfvbTrackingCheckPlanServerSide.js +52 -0
- package/dist/models/SfvbTrackingCheckPlanUnchecked.d.ts +37 -0
- package/dist/models/SfvbTrackingCheckPlanUnchecked.js +52 -0
- package/dist/models/SfvbTrackingHtmlRenderRequest.d.ts +37 -0
- package/dist/models/SfvbTrackingHtmlRenderRequest.js +52 -0
- package/dist/models/SfvbTrackingHtmlRenderResponse.d.ts +82 -0
- package/dist/models/SfvbTrackingHtmlRenderResponse.js +72 -0
- package/dist/models/SfvbTrackingProvider.d.ts +6 -0
- package/dist/models/SfvbTrackingProvider.js +2 -0
- package/dist/models/index.d.ts +10 -0
- package/dist/models/index.js +10 -0
- package/package.json +1 -1
- package/src/apis/SfvbApi.ts +279 -8
- package/src/models/SfvbApprovalParams.ts +1 -1
- package/src/models/SfvbCommsLookupOwner.ts +8 -0
- package/src/models/SfvbCommsLookupResponse.ts +8 -0
- package/src/models/SfvbPreviewTrackingHtmlRequest.ts +75 -0
- package/src/models/SfvbServerLog.ts +1 -1
- package/src/models/SfvbTrackingCheckPlan.ts +202 -0
- package/src/models/SfvbTrackingCheckPlanEvent.ts +94 -0
- package/src/models/SfvbTrackingCheckPlanGate.ts +96 -0
- package/src/models/SfvbTrackingCheckPlanProvider.ts +171 -0
- package/src/models/SfvbTrackingCheckPlanRequest.ts +102 -0
- package/src/models/SfvbTrackingCheckPlanServerSide.ts +75 -0
- package/src/models/SfvbTrackingCheckPlanUnchecked.ts +75 -0
- package/src/models/SfvbTrackingHtmlRenderRequest.ts +75 -0
- package/src/models/SfvbTrackingHtmlRenderResponse.ts +140 -0
- package/src/models/SfvbTrackingProvider.ts +8 -0
- package/src/models/index.ts +10 -0
package/.openapi-generator/FILES
CHANGED
|
@@ -1229,6 +1229,7 @@ src/models/SfvbPreviewAccessRequest.ts
|
|
|
1229
1229
|
src/models/SfvbPreviewAccessResponse.ts
|
|
1230
1230
|
src/models/SfvbPreviewSessionRequest.ts
|
|
1231
1231
|
src/models/SfvbPreviewSessionResponse.ts
|
|
1232
|
+
src/models/SfvbPreviewTrackingHtmlRequest.ts
|
|
1232
1233
|
src/models/SfvbPreviewUrlResponse.ts
|
|
1233
1234
|
src/models/SfvbRecording.ts
|
|
1234
1235
|
src/models/SfvbRecordingEvent.ts
|
|
@@ -1318,7 +1319,16 @@ src/models/SfvbThemesResponse.ts
|
|
|
1318
1319
|
src/models/SfvbTrackingAdvanced.ts
|
|
1319
1320
|
src/models/SfvbTrackingAdvancedRequest.ts
|
|
1320
1321
|
src/models/SfvbTrackingChange.ts
|
|
1322
|
+
src/models/SfvbTrackingCheckPlan.ts
|
|
1323
|
+
src/models/SfvbTrackingCheckPlanEvent.ts
|
|
1324
|
+
src/models/SfvbTrackingCheckPlanGate.ts
|
|
1325
|
+
src/models/SfvbTrackingCheckPlanProvider.ts
|
|
1326
|
+
src/models/SfvbTrackingCheckPlanRequest.ts
|
|
1327
|
+
src/models/SfvbTrackingCheckPlanServerSide.ts
|
|
1328
|
+
src/models/SfvbTrackingCheckPlanUnchecked.ts
|
|
1321
1329
|
src/models/SfvbTrackingHtml.ts
|
|
1330
|
+
src/models/SfvbTrackingHtmlRenderRequest.ts
|
|
1331
|
+
src/models/SfvbTrackingHtmlRenderResponse.ts
|
|
1322
1332
|
src/models/SfvbTrackingHtmlRequest.ts
|
|
1323
1333
|
src/models/SfvbTrackingHtmlResponse.ts
|
|
1324
1334
|
src/models/SfvbTrackingPrivacy.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.235
|
|
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.235 --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.235 | 11/09/2026 | sfvb internal testing |
|
|
88
|
+
| 4.1.234 | 11/09/2026 | sfvb internal testing |
|
|
87
89
|
| 4.1.233 | 11/06/2026 | sfvb internal testing |
|
|
88
90
|
| 4.1.232 | 11/05/2026 | sfvb internal testing |
|
|
89
91
|
| 4.1.231 | 11/05/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, SfvbCommsClicksResponse, SfvbCommsDashboardResponse, SfvbCommsFolderResponse, SfvbCommsFolderWriteRequest, SfvbCommsFoldersResponse, SfvbCommsListResponse, SfvbCommsListWriteRequest, SfvbCommsListsResponse, SfvbCommsLookupResponse, SfvbCommsMembersResponse, SfvbCommsPlanResponse, SfvbCommsProviderImportRequest, SfvbCommsProviderImportResponse, SfvbCommsProvidersResponse, SfvbCommsRulerValidateRequest, SfvbCommsRulerValidateResponse, SfvbCommsSegmentResponse, SfvbCommsSegmentWriteRequest, SfvbCommsSegmentsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsSequenceFolderResponse, SfvbCommsSequenceFoldersResponse, SfvbCommsSequenceStatsResponse, SfvbCommsSettingsResponse, SfvbCommsSettingsUpdateRequest, SfvbCommsTemplateResponse, SfvbCommsTemplatesResponse, SfvbCommsTestEmailRequest, SfvbCommsTestPostcardRequest, SfvbCommsTestSendResponse, SfvbCommsTestSmsRequest, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCommsUnreferencedResponse, 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, SfvbFlowBackfillRequest, SfvbFlowBackfillResponse, 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';
|
|
13
|
+
import { SfvbAffiliateNetwork, SfvbAffiliateNetworkRequest, SfvbAffiliateNetworksResponse, SfvbApproval, SfvbApprovalCreateRequest, SfvbApprovalsResponse, SfvbArchiveRequest, SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCampaign, SfvbCampaignWriteRequest, SfvbCampaignsResponse, SfvbCodeLibraryEmailsResponse, SfvbCommsClicksResponse, SfvbCommsDashboardResponse, SfvbCommsFolderResponse, SfvbCommsFolderWriteRequest, SfvbCommsFoldersResponse, SfvbCommsListResponse, SfvbCommsListWriteRequest, SfvbCommsListsResponse, SfvbCommsLookupResponse, SfvbCommsMembersResponse, SfvbCommsPlanResponse, SfvbCommsProviderImportRequest, SfvbCommsProviderImportResponse, SfvbCommsProvidersResponse, SfvbCommsRulerValidateRequest, SfvbCommsRulerValidateResponse, SfvbCommsSegmentResponse, SfvbCommsSegmentWriteRequest, SfvbCommsSegmentsResponse, SfvbCommsSendingDomain, SfvbCommsSendingDomainsResponse, SfvbCommsSequenceFolderResponse, SfvbCommsSequenceFoldersResponse, SfvbCommsSequenceStatsResponse, SfvbCommsSettingsResponse, SfvbCommsSettingsUpdateRequest, SfvbCommsTemplateResponse, SfvbCommsTemplatesResponse, SfvbCommsTestEmailRequest, SfvbCommsTestPostcardRequest, SfvbCommsTestSendResponse, SfvbCommsTestSmsRequest, SfvbCommsTwilioAccount, SfvbCommsTwilioAccountResponse, SfvbCommsUnreferencedResponse, 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, SfvbFlowBackfillRequest, SfvbFlowBackfillResponse, 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, SfvbPreviewTrackingHtmlRequest, 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, SfvbTrackingCheckPlan, SfvbTrackingHtml, SfvbTrackingHtmlRenderRequest, SfvbTrackingHtmlRenderResponse, 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;
|
|
@@ -200,6 +200,8 @@ export interface DeleteSfvbTrackingProviderRequest {
|
|
|
200
200
|
storefrontOid: number;
|
|
201
201
|
provider: string;
|
|
202
202
|
ifMatch: string;
|
|
203
|
+
dryRun?: boolean;
|
|
204
|
+
approvalId?: string;
|
|
203
205
|
}
|
|
204
206
|
export interface DeleteSfvbUtmShortcodeRequest {
|
|
205
207
|
storefrontOid: number;
|
|
@@ -635,6 +637,14 @@ export interface GetSfvbThemeJobRequest {
|
|
|
635
637
|
storefrontOid: number;
|
|
636
638
|
jobId: number;
|
|
637
639
|
}
|
|
640
|
+
export interface GetSfvbTrackingCheckPlanRequest {
|
|
641
|
+
storefrontOid: number;
|
|
642
|
+
path: string;
|
|
643
|
+
event?: string;
|
|
644
|
+
orderId?: string;
|
|
645
|
+
consent?: string;
|
|
646
|
+
region?: string;
|
|
647
|
+
}
|
|
638
648
|
export interface GetSfvbTrackingHtmlRequest {
|
|
639
649
|
storefrontOid: number;
|
|
640
650
|
slot: string;
|
|
@@ -1015,6 +1025,11 @@ export interface PutSfvbPreviewSessionRequest {
|
|
|
1015
1025
|
previewSession: SfvbPreviewSessionRequest;
|
|
1016
1026
|
themeOid?: number;
|
|
1017
1027
|
}
|
|
1028
|
+
export interface PutSfvbPreviewTrackingHtmlRequest {
|
|
1029
|
+
storefrontOid: number;
|
|
1030
|
+
previewSessionId: string;
|
|
1031
|
+
previewTrackingHtml: SfvbPreviewTrackingHtmlRequest;
|
|
1032
|
+
}
|
|
1018
1033
|
export interface PutSfvbRecordingSettingsRequest {
|
|
1019
1034
|
storefrontOid: number;
|
|
1020
1035
|
recordingSettingsRequest: SfvbRecordingSettingsRequest;
|
|
@@ -1050,6 +1065,11 @@ export interface RenderSfvbEmailRequest {
|
|
|
1050
1065
|
emailUuid: string;
|
|
1051
1066
|
emailRenderRequest: SfvbEmailRenderRequest;
|
|
1052
1067
|
}
|
|
1068
|
+
export interface RenderSfvbTrackingHtmlRequest {
|
|
1069
|
+
storefrontOid: number;
|
|
1070
|
+
slot: string;
|
|
1071
|
+
trackingHtmlRenderRequest: SfvbTrackingHtmlRenderRequest;
|
|
1072
|
+
}
|
|
1053
1073
|
export interface RenderSfvbTransactionalEmailRequest {
|
|
1054
1074
|
storefrontOid: number;
|
|
1055
1075
|
fileName: string;
|
|
@@ -1978,18 +1998,20 @@ export interface SfvbApiInterface {
|
|
|
1978
1998
|
*/
|
|
1979
1999
|
deleteSfvbSmartAttribution(requestParameters: DeleteSfvbSmartAttributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
1980
2000
|
/**
|
|
1981
|
-
* Clears every field and secret the API can change, the consent gate and the events, and turns off Google Tag Gateway.
|
|
2001
|
+
* Clears every field and secret the API can change, the consent gate and the events, and turns off Google Tag Gateway. An OAuth connection is left alone, and notes say to disconnect it in the admin. Send the provider\'s hash_sha256 as If-Match. Needs sfvb_publish. dry_run=true reports the changes, and approval_needed, without clearing. No approval, except when the clear removes a consent gate while something outside the provider\'s fields still fires it (Google Ads for an affiliate\'s own Google conversion id, Commission Junction for an affiliate network of its type): that needs an approved tracking_provider.clear request for the provider (Approval-Id).
|
|
1982
2002
|
* @summary Clear one tracking provider
|
|
1983
2003
|
* @param {number} storefrontOid
|
|
1984
2004
|
* @param {string} provider
|
|
1985
2005
|
* @param {string} ifMatch The provider\'s hash_sha256 from the last read. 428 when absent, 412 when stale.
|
|
2006
|
+
* @param {boolean} [dryRun]
|
|
2007
|
+
* @param {string} [approvalId] When the clear removes a consent gate while something else still fires the provider, the approval_id of an approved tracking_provider.clear request for it. See POST /sfvb/approvals.
|
|
1986
2008
|
* @param {*} [options] Override http request option.
|
|
1987
2009
|
* @throws {RequiredError}
|
|
1988
2010
|
* @memberof SfvbApiInterface
|
|
1989
2011
|
*/
|
|
1990
2012
|
deleteSfvbTrackingProviderRaw(requestParameters: DeleteSfvbTrackingProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTrackingProvider>>;
|
|
1991
2013
|
/**
|
|
1992
|
-
* Clears every field and secret the API can change, the consent gate and the events, and turns off Google Tag Gateway.
|
|
2014
|
+
* Clears every field and secret the API can change, the consent gate and the events, and turns off Google Tag Gateway. An OAuth connection is left alone, and notes say to disconnect it in the admin. Send the provider\'s hash_sha256 as If-Match. Needs sfvb_publish. dry_run=true reports the changes, and approval_needed, without clearing. No approval, except when the clear removes a consent gate while something outside the provider\'s fields still fires it (Google Ads for an affiliate\'s own Google conversion id, Commission Junction for an affiliate network of its type): that needs an approved tracking_provider.clear request for the provider (Approval-Id).
|
|
1993
2015
|
* Clear one tracking provider
|
|
1994
2016
|
*/
|
|
1995
2017
|
deleteSfvbTrackingProvider(requestParameters: DeleteSfvbTrackingProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTrackingProvider>;
|
|
@@ -2587,7 +2609,7 @@ export interface SfvbApiInterface {
|
|
|
2587
2609
|
*/
|
|
2588
2610
|
getSfvbCommsListMembers(requestParameters: GetSfvbCommsListMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsMembersResponse>;
|
|
2589
2611
|
/**
|
|
2590
|
-
* Takes a campaign, flow, sequence, step, email, postcard, list or segment uuid and says which of this account\'s storefronts it is on, what it is, the campaign or flow it belongs to, and the command that reads it. A uuid nothing on this account has, another account\'s included, is 404. Read only.
|
|
2612
|
+
* Takes a campaign, flow, sequence, step, email, postcard, list or segment uuid and says which of this account\'s storefronts it is on, what it is, the campaign or flow it belongs to, and the command that reads it. An archived campaign or flow is found too, with archived true, and owner.archived is true when what was found belongs to one. A uuid nothing on this account has, another account\'s included, and a deleted step, email, postcard, list or segment, is 404. Read only.
|
|
2591
2613
|
* @summary Find which storefront a communications uuid lives on
|
|
2592
2614
|
* @param {string} uuid The uuid to find.
|
|
2593
2615
|
* @param {*} [options] Override http request option.
|
|
@@ -2596,7 +2618,7 @@ export interface SfvbApiInterface {
|
|
|
2596
2618
|
*/
|
|
2597
2619
|
getSfvbCommsLookupRaw(requestParameters: GetSfvbCommsLookupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsLookupResponse>>;
|
|
2598
2620
|
/**
|
|
2599
|
-
* Takes a campaign, flow, sequence, step, email, postcard, list or segment uuid and says which of this account\'s storefronts it is on, what it is, the campaign or flow it belongs to, and the command that reads it. A uuid nothing on this account has, another account\'s included, is 404. Read only.
|
|
2621
|
+
* Takes a campaign, flow, sequence, step, email, postcard, list or segment uuid and says which of this account\'s storefronts it is on, what it is, the campaign or flow it belongs to, and the command that reads it. An archived campaign or flow is found too, with archived true, and owner.archived is true when what was found belongs to one. A uuid nothing on this account has, another account\'s included, and a deleted step, email, postcard, list or segment, is 404. Read only.
|
|
2600
2622
|
* Find which storefront a communications uuid lives on
|
|
2601
2623
|
*/
|
|
2602
2624
|
getSfvbCommsLookup(requestParameters: GetSfvbCommsLookupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsLookupResponse>;
|
|
@@ -3601,6 +3623,25 @@ export interface SfvbApiInterface {
|
|
|
3601
3623
|
* Status of an asynchronous theme job
|
|
3602
3624
|
*/
|
|
3603
3625
|
getSfvbThemeJob(requestParameters: GetSfvbThemeJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbThemeJobResponse>;
|
|
3626
|
+
/**
|
|
3627
|
+
* What each tracking provider should load on one page, for page_view or a test order\'s purchase, under a consent state and region, with the requests and calls to look for and the ones that must not appear. Built from the same rules the storefront\'s tracking templates follow, never by running them, so nothing is sent to any provider. Includes the hosts the storefront\'s custom and affiliate network HTML loads, the sends made from UltraCart servers, and a snippet that collects what the browser saw. Grade the results locally; they are never sent here. With neither consent nor region, every provider is listed with the gate that holds it back. A purchase needs a test order on this account.
|
|
3628
|
+
* @summary Plan a browser check of a storefront\'s tracking
|
|
3629
|
+
* @param {number} storefrontOid
|
|
3630
|
+
* @param {string} path A storefront page path, such as / or /checkout/receipt.html, with an optional query
|
|
3631
|
+
* @param {string} [event] page_view (the default) or purchase
|
|
3632
|
+
* @param {string} [orderId] For purchase, a test order on this account
|
|
3633
|
+
* @param {string} [consent] none, all, or a comma list of statistics, preferences and marketing
|
|
3634
|
+
* @param {string} [region] Where the browser is. eea, non-us or other
|
|
3635
|
+
* @param {*} [options] Override http request option.
|
|
3636
|
+
* @throws {RequiredError}
|
|
3637
|
+
* @memberof SfvbApiInterface
|
|
3638
|
+
*/
|
|
3639
|
+
getSfvbTrackingCheckPlanRaw(requestParameters: GetSfvbTrackingCheckPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTrackingCheckPlan>>;
|
|
3640
|
+
/**
|
|
3641
|
+
* What each tracking provider should load on one page, for page_view or a test order\'s purchase, under a consent state and region, with the requests and calls to look for and the ones that must not appear. Built from the same rules the storefront\'s tracking templates follow, never by running them, so nothing is sent to any provider. Includes the hosts the storefront\'s custom and affiliate network HTML loads, the sends made from UltraCart servers, and a snippet that collects what the browser saw. Grade the results locally; they are never sent here. With neither consent nor region, every provider is listed with the gate that holds it back. A purchase needs a test order on this account.
|
|
3642
|
+
* Plan a browser check of a storefront\'s tracking
|
|
3643
|
+
*/
|
|
3644
|
+
getSfvbTrackingCheckPlan(requestParameters: GetSfvbTrackingCheckPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTrackingCheckPlan>;
|
|
3604
3645
|
/**
|
|
3605
3646
|
* The HTML with its Velocity tokens as stored, and the hash_sha256 a write sends back as If-Match.
|
|
3606
3647
|
* @summary Read one custom tracking HTML slot
|
|
@@ -4835,6 +4876,22 @@ export interface SfvbApiInterface {
|
|
|
4835
4876
|
* Push containers into a preview session
|
|
4836
4877
|
*/
|
|
4837
4878
|
putSfvbPreviewSession(requestParameters: PutSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
|
|
4879
|
+
/**
|
|
4880
|
+
* Runs Tracking HTML, Conversion HTML or both instead of the storefront\'s live slots, only in a browser that opened this session\'s preview access link, so a page can be checked before the write is approved. Staged Conversion HTML runs only on a test order\'s receipt. Each slot gets the same checks as a write. An empty string unstages a slot; a slot left out is left as it is. Containers pushed to the session later keep what is staged. Needs sfvb_write and a token that resolves to a user; no approval, since nothing durable is written and only that user\'s own session runs it.
|
|
4881
|
+
* @summary Stage custom tracking HTML in a preview session
|
|
4882
|
+
* @param {number} storefrontOid
|
|
4883
|
+
* @param {string} previewSessionId
|
|
4884
|
+
* @param {SfvbPreviewTrackingHtmlRequest} previewTrackingHtml The HTML to stage
|
|
4885
|
+
* @param {*} [options] Override http request option.
|
|
4886
|
+
* @throws {RequiredError}
|
|
4887
|
+
* @memberof SfvbApiInterface
|
|
4888
|
+
*/
|
|
4889
|
+
putSfvbPreviewTrackingHtmlRaw(requestParameters: PutSfvbPreviewTrackingHtmlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTrackingHtmlResponse>>;
|
|
4890
|
+
/**
|
|
4891
|
+
* Runs Tracking HTML, Conversion HTML or both instead of the storefront\'s live slots, only in a browser that opened this session\'s preview access link, so a page can be checked before the write is approved. Staged Conversion HTML runs only on a test order\'s receipt. Each slot gets the same checks as a write. An empty string unstages a slot; a slot left out is left as it is. Containers pushed to the session later keep what is staged. Needs sfvb_write and a token that resolves to a user; no approval, since nothing durable is written and only that user\'s own session runs it.
|
|
4892
|
+
* Stage custom tracking HTML in a preview session
|
|
4893
|
+
*/
|
|
4894
|
+
putSfvbPreviewTrackingHtml(requestParameters: PutSfvbPreviewTrackingHtmlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTrackingHtmlResponse>;
|
|
4838
4895
|
/**
|
|
4839
4896
|
* Turning it on records real shoppers\' sessions from that moment, with no history before it. The first time starts a 14 day free trial, after which recorded sessions are billed per 1,000. Only change it when the merchant has asked for it. Asking for the state it is already in changes nothing, and changed comes back false. Always needs sfvb_publish, in both directions, because it decides whether live shoppers are recorded. Limited per storefront to 5 changes a minute, 20 an hour and 50 a day.
|
|
4840
4897
|
* @summary Turn the storefront\'s screen recording on or off
|
|
@@ -4958,6 +5015,22 @@ export interface SfvbApiInterface {
|
|
|
4958
5015
|
* Render a flow or campaign email without sending it
|
|
4959
5016
|
*/
|
|
4960
5017
|
renderSfvbEmail(requestParameters: RenderSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmailRenderResponse>;
|
|
5018
|
+
/**
|
|
5019
|
+
* The Conversion HTML as the receipt of that order would inject it: order tokens filled, then Velocity run with $order, $conversion and $formatHelper. Renders the stored slot, or content when it is sent (a draft, checked as a write is). Only a test order on this account may be used; a real or unknown order is refused the same way. Nothing is saved, injected or sent: the receipt\'s provider pixels, analytics and postbacks do not run, and a token that would write something ([CouponForNewAffiliate=...]) is left as written. Only the conversion slot renders; tracking HTML is checked by staging it in a preview session.
|
|
5020
|
+
* @summary Render the Conversion HTML against a test order
|
|
5021
|
+
* @param {number} storefrontOid
|
|
5022
|
+
* @param {string} slot conversion
|
|
5023
|
+
* @param {SfvbTrackingHtmlRenderRequest} trackingHtmlRenderRequest The test order, and optionally a draft
|
|
5024
|
+
* @param {*} [options] Override http request option.
|
|
5025
|
+
* @throws {RequiredError}
|
|
5026
|
+
* @memberof SfvbApiInterface
|
|
5027
|
+
*/
|
|
5028
|
+
renderSfvbTrackingHtmlRaw(requestParameters: RenderSfvbTrackingHtmlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTrackingHtmlRenderResponse>>;
|
|
5029
|
+
/**
|
|
5030
|
+
* The Conversion HTML as the receipt of that order would inject it: order tokens filled, then Velocity run with $order, $conversion and $formatHelper. Renders the stored slot, or content when it is sent (a draft, checked as a write is). Only a test order on this account may be used; a real or unknown order is refused the same way. Nothing is saved, injected or sent: the receipt\'s provider pixels, analytics and postbacks do not run, and a token that would write something ([CouponForNewAffiliate=...]) is left as written. Only the conversion slot renders; tracking HTML is checked by staging it in a preview session.
|
|
5031
|
+
* Render the Conversion HTML against a test order
|
|
5032
|
+
*/
|
|
5033
|
+
renderSfvbTrackingHtml(requestParameters: RenderSfvbTrackingHtmlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTrackingHtmlRenderResponse>;
|
|
4961
5034
|
/**
|
|
4962
5035
|
* 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.
|
|
4963
5036
|
* @summary Render a transactional email without sending it
|
|
@@ -6276,12 +6349,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
6276
6349
|
*/
|
|
6277
6350
|
deleteSfvbSmartAttribution(requestParameters: DeleteSfvbSmartAttributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
|
|
6278
6351
|
/**
|
|
6279
|
-
* Clears every field and secret the API can change, the consent gate and the events, and turns off Google Tag Gateway.
|
|
6352
|
+
* Clears every field and secret the API can change, the consent gate and the events, and turns off Google Tag Gateway. An OAuth connection is left alone, and notes say to disconnect it in the admin. Send the provider\'s hash_sha256 as If-Match. Needs sfvb_publish. dry_run=true reports the changes, and approval_needed, without clearing. No approval, except when the clear removes a consent gate while something outside the provider\'s fields still fires it (Google Ads for an affiliate\'s own Google conversion id, Commission Junction for an affiliate network of its type): that needs an approved tracking_provider.clear request for the provider (Approval-Id).
|
|
6280
6353
|
* Clear one tracking provider
|
|
6281
6354
|
*/
|
|
6282
6355
|
deleteSfvbTrackingProviderRaw(requestParameters: DeleteSfvbTrackingProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTrackingProvider>>;
|
|
6283
6356
|
/**
|
|
6284
|
-
* Clears every field and secret the API can change, the consent gate and the events, and turns off Google Tag Gateway.
|
|
6357
|
+
* Clears every field and secret the API can change, the consent gate and the events, and turns off Google Tag Gateway. An OAuth connection is left alone, and notes say to disconnect it in the admin. Send the provider\'s hash_sha256 as If-Match. Needs sfvb_publish. dry_run=true reports the changes, and approval_needed, without clearing. No approval, except when the clear removes a consent gate while something outside the provider\'s fields still fires it (Google Ads for an affiliate\'s own Google conversion id, Commission Junction for an affiliate network of its type): that needs an approved tracking_provider.clear request for the provider (Approval-Id).
|
|
6285
6358
|
* Clear one tracking provider
|
|
6286
6359
|
*/
|
|
6287
6360
|
deleteSfvbTrackingProvider(requestParameters: DeleteSfvbTrackingProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTrackingProvider>;
|
|
@@ -6674,12 +6747,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
6674
6747
|
*/
|
|
6675
6748
|
getSfvbCommsListMembers(requestParameters: GetSfvbCommsListMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsMembersResponse>;
|
|
6676
6749
|
/**
|
|
6677
|
-
* Takes a campaign, flow, sequence, step, email, postcard, list or segment uuid and says which of this account\'s storefronts it is on, what it is, the campaign or flow it belongs to, and the command that reads it. A uuid nothing on this account has, another account\'s included, is 404. Read only.
|
|
6750
|
+
* Takes a campaign, flow, sequence, step, email, postcard, list or segment uuid and says which of this account\'s storefronts it is on, what it is, the campaign or flow it belongs to, and the command that reads it. An archived campaign or flow is found too, with archived true, and owner.archived is true when what was found belongs to one. A uuid nothing on this account has, another account\'s included, and a deleted step, email, postcard, list or segment, is 404. Read only.
|
|
6678
6751
|
* Find which storefront a communications uuid lives on
|
|
6679
6752
|
*/
|
|
6680
6753
|
getSfvbCommsLookupRaw(requestParameters: GetSfvbCommsLookupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsLookupResponse>>;
|
|
6681
6754
|
/**
|
|
6682
|
-
* Takes a campaign, flow, sequence, step, email, postcard, list or segment uuid and says which of this account\'s storefronts it is on, what it is, the campaign or flow it belongs to, and the command that reads it. A uuid nothing on this account has, another account\'s included, is 404. Read only.
|
|
6755
|
+
* Takes a campaign, flow, sequence, step, email, postcard, list or segment uuid and says which of this account\'s storefronts it is on, what it is, the campaign or flow it belongs to, and the command that reads it. An archived campaign or flow is found too, with archived true, and owner.archived is true when what was found belongs to one. A uuid nothing on this account has, another account\'s included, and a deleted step, email, postcard, list or segment, is 404. Read only.
|
|
6683
6756
|
* Find which storefront a communications uuid lives on
|
|
6684
6757
|
*/
|
|
6685
6758
|
getSfvbCommsLookup(requestParameters: GetSfvbCommsLookupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsLookupResponse>;
|
|
@@ -7341,6 +7414,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
7341
7414
|
* Status of an asynchronous theme job
|
|
7342
7415
|
*/
|
|
7343
7416
|
getSfvbThemeJob(requestParameters: GetSfvbThemeJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbThemeJobResponse>;
|
|
7417
|
+
/**
|
|
7418
|
+
* What each tracking provider should load on one page, for page_view or a test order\'s purchase, under a consent state and region, with the requests and calls to look for and the ones that must not appear. Built from the same rules the storefront\'s tracking templates follow, never by running them, so nothing is sent to any provider. Includes the hosts the storefront\'s custom and affiliate network HTML loads, the sends made from UltraCart servers, and a snippet that collects what the browser saw. Grade the results locally; they are never sent here. With neither consent nor region, every provider is listed with the gate that holds it back. A purchase needs a test order on this account.
|
|
7419
|
+
* Plan a browser check of a storefront\'s tracking
|
|
7420
|
+
*/
|
|
7421
|
+
getSfvbTrackingCheckPlanRaw(requestParameters: GetSfvbTrackingCheckPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTrackingCheckPlan>>;
|
|
7422
|
+
/**
|
|
7423
|
+
* What each tracking provider should load on one page, for page_view or a test order\'s purchase, under a consent state and region, with the requests and calls to look for and the ones that must not appear. Built from the same rules the storefront\'s tracking templates follow, never by running them, so nothing is sent to any provider. Includes the hosts the storefront\'s custom and affiliate network HTML loads, the sends made from UltraCart servers, and a snippet that collects what the browser saw. Grade the results locally; they are never sent here. With neither consent nor region, every provider is listed with the gate that holds it back. A purchase needs a test order on this account.
|
|
7424
|
+
* Plan a browser check of a storefront\'s tracking
|
|
7425
|
+
*/
|
|
7426
|
+
getSfvbTrackingCheckPlan(requestParameters: GetSfvbTrackingCheckPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTrackingCheckPlan>;
|
|
7344
7427
|
/**
|
|
7345
7428
|
* The HTML with its Velocity tokens as stored, and the hash_sha256 a write sends back as If-Match.
|
|
7346
7429
|
* Read one custom tracking HTML slot
|
|
@@ -8109,6 +8192,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
8109
8192
|
* Push containers into a preview session
|
|
8110
8193
|
*/
|
|
8111
8194
|
putSfvbPreviewSession(requestParameters: PutSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
|
|
8195
|
+
/**
|
|
8196
|
+
* Runs Tracking HTML, Conversion HTML or both instead of the storefront\'s live slots, only in a browser that opened this session\'s preview access link, so a page can be checked before the write is approved. Staged Conversion HTML runs only on a test order\'s receipt. Each slot gets the same checks as a write. An empty string unstages a slot; a slot left out is left as it is. Containers pushed to the session later keep what is staged. Needs sfvb_write and a token that resolves to a user; no approval, since nothing durable is written and only that user\'s own session runs it.
|
|
8197
|
+
* Stage custom tracking HTML in a preview session
|
|
8198
|
+
*/
|
|
8199
|
+
putSfvbPreviewTrackingHtmlRaw(requestParameters: PutSfvbPreviewTrackingHtmlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTrackingHtmlResponse>>;
|
|
8200
|
+
/**
|
|
8201
|
+
* Runs Tracking HTML, Conversion HTML or both instead of the storefront\'s live slots, only in a browser that opened this session\'s preview access link, so a page can be checked before the write is approved. Staged Conversion HTML runs only on a test order\'s receipt. Each slot gets the same checks as a write. An empty string unstages a slot; a slot left out is left as it is. Containers pushed to the session later keep what is staged. Needs sfvb_write and a token that resolves to a user; no approval, since nothing durable is written and only that user\'s own session runs it.
|
|
8202
|
+
* Stage custom tracking HTML in a preview session
|
|
8203
|
+
*/
|
|
8204
|
+
putSfvbPreviewTrackingHtml(requestParameters: PutSfvbPreviewTrackingHtmlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTrackingHtmlResponse>;
|
|
8112
8205
|
/**
|
|
8113
8206
|
* Turning it on records real shoppers\' sessions from that moment, with no history before it. The first time starts a 14 day free trial, after which recorded sessions are billed per 1,000. Only change it when the merchant has asked for it. Asking for the state it is already in changes nothing, and changed comes back false. Always needs sfvb_publish, in both directions, because it decides whether live shoppers are recorded. Limited per storefront to 5 changes a minute, 20 an hour and 50 a day.
|
|
8114
8207
|
* Turn the storefront\'s screen recording on or off
|
|
@@ -8189,6 +8282,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
|
|
|
8189
8282
|
* Render a flow or campaign email without sending it
|
|
8190
8283
|
*/
|
|
8191
8284
|
renderSfvbEmail(requestParameters: RenderSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmailRenderResponse>;
|
|
8285
|
+
/**
|
|
8286
|
+
* The Conversion HTML as the receipt of that order would inject it: order tokens filled, then Velocity run with $order, $conversion and $formatHelper. Renders the stored slot, or content when it is sent (a draft, checked as a write is). Only a test order on this account may be used; a real or unknown order is refused the same way. Nothing is saved, injected or sent: the receipt\'s provider pixels, analytics and postbacks do not run, and a token that would write something ([CouponForNewAffiliate=...]) is left as written. Only the conversion slot renders; tracking HTML is checked by staging it in a preview session.
|
|
8287
|
+
* Render the Conversion HTML against a test order
|
|
8288
|
+
*/
|
|
8289
|
+
renderSfvbTrackingHtmlRaw(requestParameters: RenderSfvbTrackingHtmlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTrackingHtmlRenderResponse>>;
|
|
8290
|
+
/**
|
|
8291
|
+
* The Conversion HTML as the receipt of that order would inject it: order tokens filled, then Velocity run with $order, $conversion and $formatHelper. Renders the stored slot, or content when it is sent (a draft, checked as a write is). Only a test order on this account may be used; a real or unknown order is refused the same way. Nothing is saved, injected or sent: the receipt\'s provider pixels, analytics and postbacks do not run, and a token that would write something ([CouponForNewAffiliate=...]) is left as written. Only the conversion slot renders; tracking HTML is checked by staging it in a preview session.
|
|
8292
|
+
* Render the Conversion HTML against a test order
|
|
8293
|
+
*/
|
|
8294
|
+
renderSfvbTrackingHtml(requestParameters: RenderSfvbTrackingHtmlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTrackingHtmlRenderResponse>;
|
|
8192
8295
|
/**
|
|
8193
8296
|
* 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.
|
|
8194
8297
|
* Render a transactional email without sending it
|