ultracart_rest_api_v2_typescript 4.1.233 → 4.1.234

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.
Files changed (31) hide show
  1. package/.openapi-generator/FILES +3 -0
  2. package/README.md +3 -2
  3. package/dist/apis/SfvbApi.d.ts +75 -9
  4. package/dist/apis/SfvbApi.js +144 -4
  5. package/dist/models/SfvbApprovalParams.d.ts +1 -1
  6. package/dist/models/SfvbCommsLookupOwner.d.ts +6 -0
  7. package/dist/models/SfvbCommsLookupOwner.js +2 -0
  8. package/dist/models/SfvbCommsLookupResponse.d.ts +6 -0
  9. package/dist/models/SfvbCommsLookupResponse.js +2 -0
  10. package/dist/models/SfvbPreviewTrackingHtmlRequest.d.ts +37 -0
  11. package/dist/models/SfvbPreviewTrackingHtmlRequest.js +52 -0
  12. package/dist/models/SfvbServerLog.d.ts +1 -1
  13. package/dist/models/SfvbTrackingHtmlRenderRequest.d.ts +37 -0
  14. package/dist/models/SfvbTrackingHtmlRenderRequest.js +52 -0
  15. package/dist/models/SfvbTrackingHtmlRenderResponse.d.ts +82 -0
  16. package/dist/models/SfvbTrackingHtmlRenderResponse.js +72 -0
  17. package/dist/models/SfvbTrackingProvider.d.ts +6 -0
  18. package/dist/models/SfvbTrackingProvider.js +2 -0
  19. package/dist/models/index.d.ts +3 -0
  20. package/dist/models/index.js +3 -0
  21. package/package.json +1 -1
  22. package/src/apis/SfvbApi.ts +181 -8
  23. package/src/models/SfvbApprovalParams.ts +1 -1
  24. package/src/models/SfvbCommsLookupOwner.ts +8 -0
  25. package/src/models/SfvbCommsLookupResponse.ts +8 -0
  26. package/src/models/SfvbPreviewTrackingHtmlRequest.ts +75 -0
  27. package/src/models/SfvbServerLog.ts +1 -1
  28. package/src/models/SfvbTrackingHtmlRenderRequest.ts +75 -0
  29. package/src/models/SfvbTrackingHtmlRenderResponse.ts +140 -0
  30. package/src/models/SfvbTrackingProvider.ts +8 -0
  31. package/src/models/index.ts +3 -0
@@ -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
@@ -1319,6 +1320,8 @@ src/models/SfvbTrackingAdvanced.ts
1319
1320
  src/models/SfvbTrackingAdvancedRequest.ts
1320
1321
  src/models/SfvbTrackingChange.ts
1321
1322
  src/models/SfvbTrackingHtml.ts
1323
+ src/models/SfvbTrackingHtmlRenderRequest.ts
1324
+ src/models/SfvbTrackingHtmlRenderResponse.ts
1322
1325
  src/models/SfvbTrackingHtmlRequest.ts
1323
1326
  src/models/SfvbTrackingHtmlResponse.ts
1324
1327
  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.233
2
+ ## ultracart_rest_api_v2_typescript@4.1.234
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.233 --save
9
+ npm install ultracart_rest_api_v2_typescript@4.1.234 --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.234 | 11/09/2026 | sfvb internal testing |
87
88
  | 4.1.233 | 11/06/2026 | sfvb internal testing |
88
89
  | 4.1.232 | 11/05/2026 | sfvb internal testing |
89
90
  | 4.1.231 | 11/05/2026 | sfvb internal testing |
@@ -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, 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;
@@ -1015,6 +1017,11 @@ export interface PutSfvbPreviewSessionRequest {
1015
1017
  previewSession: SfvbPreviewSessionRequest;
1016
1018
  themeOid?: number;
1017
1019
  }
1020
+ export interface PutSfvbPreviewTrackingHtmlRequest {
1021
+ storefrontOid: number;
1022
+ previewSessionId: string;
1023
+ previewTrackingHtml: SfvbPreviewTrackingHtmlRequest;
1024
+ }
1018
1025
  export interface PutSfvbRecordingSettingsRequest {
1019
1026
  storefrontOid: number;
1020
1027
  recordingSettingsRequest: SfvbRecordingSettingsRequest;
@@ -1050,6 +1057,11 @@ export interface RenderSfvbEmailRequest {
1050
1057
  emailUuid: string;
1051
1058
  emailRenderRequest: SfvbEmailRenderRequest;
1052
1059
  }
1060
+ export interface RenderSfvbTrackingHtmlRequest {
1061
+ storefrontOid: number;
1062
+ slot: string;
1063
+ trackingHtmlRenderRequest: SfvbTrackingHtmlRenderRequest;
1064
+ }
1053
1065
  export interface RenderSfvbTransactionalEmailRequest {
1054
1066
  storefrontOid: number;
1055
1067
  fileName: string;
@@ -1978,18 +1990,20 @@ export interface SfvbApiInterface {
1978
1990
  */
1979
1991
  deleteSfvbSmartAttribution(requestParameters: DeleteSfvbSmartAttributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
1980
1992
  /**
1981
- * Clears every field and secret the API can change, the consent gate and the events, and turns off Google Tag Gateway. The provider stops being sent anything. 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. No approval.
1993
+ * 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
1994
  * @summary Clear one tracking provider
1983
1995
  * @param {number} storefrontOid
1984
1996
  * @param {string} provider
1985
1997
  * @param {string} ifMatch The provider\&#39;s hash_sha256 from the last read. 428 when absent, 412 when stale.
1998
+ * @param {boolean} [dryRun]
1999
+ * @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
2000
  * @param {*} [options] Override http request option.
1987
2001
  * @throws {RequiredError}
1988
2002
  * @memberof SfvbApiInterface
1989
2003
  */
1990
2004
  deleteSfvbTrackingProviderRaw(requestParameters: DeleteSfvbTrackingProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTrackingProvider>>;
1991
2005
  /**
1992
- * Clears every field and secret the API can change, the consent gate and the events, and turns off Google Tag Gateway. The provider stops being sent anything. 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. No approval.
2006
+ * 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
2007
  * Clear one tracking provider
1994
2008
  */
1995
2009
  deleteSfvbTrackingProvider(requestParameters: DeleteSfvbTrackingProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTrackingProvider>;
@@ -2587,7 +2601,7 @@ export interface SfvbApiInterface {
2587
2601
  */
2588
2602
  getSfvbCommsListMembers(requestParameters: GetSfvbCommsListMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsMembersResponse>;
2589
2603
  /**
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.
2604
+ * 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
2605
  * @summary Find which storefront a communications uuid lives on
2592
2606
  * @param {string} uuid The uuid to find.
2593
2607
  * @param {*} [options] Override http request option.
@@ -2596,7 +2610,7 @@ export interface SfvbApiInterface {
2596
2610
  */
2597
2611
  getSfvbCommsLookupRaw(requestParameters: GetSfvbCommsLookupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsLookupResponse>>;
2598
2612
  /**
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.
2613
+ * 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
2614
  * Find which storefront a communications uuid lives on
2601
2615
  */
2602
2616
  getSfvbCommsLookup(requestParameters: GetSfvbCommsLookupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsLookupResponse>;
@@ -4835,6 +4849,22 @@ export interface SfvbApiInterface {
4835
4849
  * Push containers into a preview session
4836
4850
  */
4837
4851
  putSfvbPreviewSession(requestParameters: PutSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
4852
+ /**
4853
+ * 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.
4854
+ * @summary Stage custom tracking HTML in a preview session
4855
+ * @param {number} storefrontOid
4856
+ * @param {string} previewSessionId
4857
+ * @param {SfvbPreviewTrackingHtmlRequest} previewTrackingHtml The HTML to stage
4858
+ * @param {*} [options] Override http request option.
4859
+ * @throws {RequiredError}
4860
+ * @memberof SfvbApiInterface
4861
+ */
4862
+ putSfvbPreviewTrackingHtmlRaw(requestParameters: PutSfvbPreviewTrackingHtmlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTrackingHtmlResponse>>;
4863
+ /**
4864
+ * 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.
4865
+ * Stage custom tracking HTML in a preview session
4866
+ */
4867
+ putSfvbPreviewTrackingHtml(requestParameters: PutSfvbPreviewTrackingHtmlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTrackingHtmlResponse>;
4838
4868
  /**
4839
4869
  * 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
4870
  * @summary Turn the storefront\'s screen recording on or off
@@ -4958,6 +4988,22 @@ export interface SfvbApiInterface {
4958
4988
  * Render a flow or campaign email without sending it
4959
4989
  */
4960
4990
  renderSfvbEmail(requestParameters: RenderSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmailRenderResponse>;
4991
+ /**
4992
+ * 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.
4993
+ * @summary Render the Conversion HTML against a test order
4994
+ * @param {number} storefrontOid
4995
+ * @param {string} slot conversion
4996
+ * @param {SfvbTrackingHtmlRenderRequest} trackingHtmlRenderRequest The test order, and optionally a draft
4997
+ * @param {*} [options] Override http request option.
4998
+ * @throws {RequiredError}
4999
+ * @memberof SfvbApiInterface
5000
+ */
5001
+ renderSfvbTrackingHtmlRaw(requestParameters: RenderSfvbTrackingHtmlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTrackingHtmlRenderResponse>>;
5002
+ /**
5003
+ * 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.
5004
+ * Render the Conversion HTML against a test order
5005
+ */
5006
+ renderSfvbTrackingHtml(requestParameters: RenderSfvbTrackingHtmlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTrackingHtmlRenderResponse>;
4961
5007
  /**
4962
5008
  * 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
5009
  * @summary Render a transactional email without sending it
@@ -6276,12 +6322,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
6276
6322
  */
6277
6323
  deleteSfvbSmartAttribution(requestParameters: DeleteSfvbSmartAttributionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
6278
6324
  /**
6279
- * Clears every field and secret the API can change, the consent gate and the events, and turns off Google Tag Gateway. The provider stops being sent anything. 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. No approval.
6325
+ * 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
6326
  * Clear one tracking provider
6281
6327
  */
6282
6328
  deleteSfvbTrackingProviderRaw(requestParameters: DeleteSfvbTrackingProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTrackingProvider>>;
6283
6329
  /**
6284
- * Clears every field and secret the API can change, the consent gate and the events, and turns off Google Tag Gateway. The provider stops being sent anything. 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. No approval.
6330
+ * 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
6331
  * Clear one tracking provider
6286
6332
  */
6287
6333
  deleteSfvbTrackingProvider(requestParameters: DeleteSfvbTrackingProviderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTrackingProvider>;
@@ -6674,12 +6720,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
6674
6720
  */
6675
6721
  getSfvbCommsListMembers(requestParameters: GetSfvbCommsListMembersRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsMembersResponse>;
6676
6722
  /**
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.
6723
+ * 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
6724
  * Find which storefront a communications uuid lives on
6679
6725
  */
6680
6726
  getSfvbCommsLookupRaw(requestParameters: GetSfvbCommsLookupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbCommsLookupResponse>>;
6681
6727
  /**
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.
6728
+ * 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
6729
  * Find which storefront a communications uuid lives on
6684
6730
  */
6685
6731
  getSfvbCommsLookup(requestParameters: GetSfvbCommsLookupRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCommsLookupResponse>;
@@ -8109,6 +8155,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
8109
8155
  * Push containers into a preview session
8110
8156
  */
8111
8157
  putSfvbPreviewSession(requestParameters: PutSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
8158
+ /**
8159
+ * 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.
8160
+ * Stage custom tracking HTML in a preview session
8161
+ */
8162
+ putSfvbPreviewTrackingHtmlRaw(requestParameters: PutSfvbPreviewTrackingHtmlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTrackingHtmlResponse>>;
8163
+ /**
8164
+ * 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.
8165
+ * Stage custom tracking HTML in a preview session
8166
+ */
8167
+ putSfvbPreviewTrackingHtml(requestParameters: PutSfvbPreviewTrackingHtmlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTrackingHtmlResponse>;
8112
8168
  /**
8113
8169
  * 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
8170
  * Turn the storefront\'s screen recording on or off
@@ -8189,6 +8245,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
8189
8245
  * Render a flow or campaign email without sending it
8190
8246
  */
8191
8247
  renderSfvbEmail(requestParameters: RenderSfvbEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbEmailRenderResponse>;
8248
+ /**
8249
+ * 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.
8250
+ * Render the Conversion HTML against a test order
8251
+ */
8252
+ renderSfvbTrackingHtmlRaw(requestParameters: RenderSfvbTrackingHtmlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTrackingHtmlRenderResponse>>;
8253
+ /**
8254
+ * 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.
8255
+ * Render the Conversion HTML against a test order
8256
+ */
8257
+ renderSfvbTrackingHtml(requestParameters: RenderSfvbTrackingHtmlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTrackingHtmlRenderResponse>;
8192
8258
  /**
8193
8259
  * 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
8260
  * Render a transactional email without sending it
@@ -2642,7 +2642,7 @@ var SfvbApi = /** @class */ (function (_super) {
2642
2642
  });
2643
2643
  };
2644
2644
  /**
2645
- * Clears every field and secret the API can change, the consent gate and the events, and turns off Google Tag Gateway. The provider stops being sent anything. 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. No approval.
2645
+ * 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).
2646
2646
  * Clear one tracking provider
2647
2647
  */
2648
2648
  SfvbApi.prototype.deleteSfvbTrackingProviderRaw = function (requestParameters, initOverrides) {
@@ -2661,10 +2661,16 @@ var SfvbApi = /** @class */ (function (_super) {
2661
2661
  throw new runtime.RequiredError('ifMatch', 'Required parameter requestParameters.ifMatch was null or undefined when calling deleteSfvbTrackingProvider.');
2662
2662
  }
2663
2663
  queryParameters = {};
2664
+ if (requestParameters.dryRun !== undefined) {
2665
+ queryParameters['dry_run'] = requestParameters.dryRun;
2666
+ }
2664
2667
  headerParameters = {};
2665
2668
  if (requestParameters.ifMatch !== undefined && requestParameters.ifMatch !== null) {
2666
2669
  headerParameters['If-Match'] = String(requestParameters.ifMatch);
2667
2670
  }
2671
+ if (requestParameters.approvalId !== undefined && requestParameters.approvalId !== null) {
2672
+ headerParameters['Approval-Id'] = String(requestParameters.approvalId);
2673
+ }
2668
2674
  if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
2669
2675
  // oauth required
2670
2676
  _a = headerParameters;
@@ -2692,7 +2698,7 @@ var SfvbApi = /** @class */ (function (_super) {
2692
2698
  });
2693
2699
  };
2694
2700
  /**
2695
- * Clears every field and secret the API can change, the consent gate and the events, and turns off Google Tag Gateway. The provider stops being sent anything. 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. No approval.
2701
+ * 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).
2696
2702
  * Clear one tracking provider
2697
2703
  */
2698
2704
  SfvbApi.prototype.deleteSfvbTrackingProvider = function (requestParameters, initOverrides) {
@@ -5170,7 +5176,7 @@ var SfvbApi = /** @class */ (function (_super) {
5170
5176
  });
5171
5177
  };
5172
5178
  /**
5173
- * 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.
5179
+ * 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.
5174
5180
  * Find which storefront a communications uuid lives on
5175
5181
  */
5176
5182
  SfvbApi.prototype.getSfvbCommsLookupRaw = function (requestParameters, initOverrides) {
@@ -5214,7 +5220,7 @@ var SfvbApi = /** @class */ (function (_super) {
5214
5220
  });
5215
5221
  };
5216
5222
  /**
5217
- * 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.
5223
+ * 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.
5218
5224
  * Find which storefront a communications uuid lives on
5219
5225
  */
5220
5226
  SfvbApi.prototype.getSfvbCommsLookup = function (requestParameters, initOverrides) {
@@ -14499,6 +14505,73 @@ var SfvbApi = /** @class */ (function (_super) {
14499
14505
  });
14500
14506
  });
14501
14507
  };
14508
+ /**
14509
+ * 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.
14510
+ * Stage custom tracking HTML in a preview session
14511
+ */
14512
+ SfvbApi.prototype.putSfvbPreviewTrackingHtmlRaw = function (requestParameters, initOverrides) {
14513
+ return __awaiter(this, void 0, void 0, function () {
14514
+ var queryParameters, headerParameters, _a, _b, response;
14515
+ return __generator(this, function (_c) {
14516
+ switch (_c.label) {
14517
+ case 0:
14518
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
14519
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling putSfvbPreviewTrackingHtml.');
14520
+ }
14521
+ if (requestParameters.previewSessionId === null || requestParameters.previewSessionId === undefined) {
14522
+ throw new runtime.RequiredError('previewSessionId', 'Required parameter requestParameters.previewSessionId was null or undefined when calling putSfvbPreviewTrackingHtml.');
14523
+ }
14524
+ if (requestParameters.previewTrackingHtml === null || requestParameters.previewTrackingHtml === undefined) {
14525
+ throw new runtime.RequiredError('previewTrackingHtml', 'Required parameter requestParameters.previewTrackingHtml was null or undefined when calling putSfvbPreviewTrackingHtml.');
14526
+ }
14527
+ queryParameters = {};
14528
+ headerParameters = {};
14529
+ headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
14530
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
14531
+ // oauth required
14532
+ _a = headerParameters;
14533
+ _b = "Authorization";
14534
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
14535
+ case 1:
14536
+ // oauth required
14537
+ _a[_b] = _c.sent();
14538
+ _c.label = 2;
14539
+ case 2:
14540
+ if (this.configuration && this.configuration.apiKey) {
14541
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
14542
+ }
14543
+ return [4 /*yield*/, this.request({
14544
+ path: "/sfvb/storefronts/{storefront_oid}/preview_sessions/{preview_session_id}/tracking_html".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("preview_session_id", "}"), encodeURIComponent(String(requestParameters.previewSessionId))),
14545
+ method: 'PUT',
14546
+ headers: headerParameters,
14547
+ query: queryParameters,
14548
+ body: (0, models_1.SfvbPreviewTrackingHtmlRequestToJSON)(requestParameters.previewTrackingHtml),
14549
+ }, initOverrides)];
14550
+ case 3:
14551
+ response = _c.sent();
14552
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbTrackingHtmlResponseFromJSON)(jsonValue); })];
14553
+ }
14554
+ });
14555
+ });
14556
+ };
14557
+ /**
14558
+ * 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.
14559
+ * Stage custom tracking HTML in a preview session
14560
+ */
14561
+ SfvbApi.prototype.putSfvbPreviewTrackingHtml = function (requestParameters, initOverrides) {
14562
+ return __awaiter(this, void 0, void 0, function () {
14563
+ var response;
14564
+ return __generator(this, function (_a) {
14565
+ switch (_a.label) {
14566
+ case 0: return [4 /*yield*/, this.putSfvbPreviewTrackingHtmlRaw(requestParameters, initOverrides)];
14567
+ case 1:
14568
+ response = _a.sent();
14569
+ return [4 /*yield*/, response.value()];
14570
+ case 2: return [2 /*return*/, _a.sent()];
14571
+ }
14572
+ });
14573
+ });
14574
+ };
14502
14575
  /**
14503
14576
  * 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.
14504
14577
  * Turn the storefront\'s screen recording on or off
@@ -15024,6 +15097,73 @@ var SfvbApi = /** @class */ (function (_super) {
15024
15097
  });
15025
15098
  });
15026
15099
  };
15100
+ /**
15101
+ * 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.
15102
+ * Render the Conversion HTML against a test order
15103
+ */
15104
+ SfvbApi.prototype.renderSfvbTrackingHtmlRaw = function (requestParameters, initOverrides) {
15105
+ return __awaiter(this, void 0, void 0, function () {
15106
+ var queryParameters, headerParameters, _a, _b, response;
15107
+ return __generator(this, function (_c) {
15108
+ switch (_c.label) {
15109
+ case 0:
15110
+ if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
15111
+ throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling renderSfvbTrackingHtml.');
15112
+ }
15113
+ if (requestParameters.slot === null || requestParameters.slot === undefined) {
15114
+ throw new runtime.RequiredError('slot', 'Required parameter requestParameters.slot was null or undefined when calling renderSfvbTrackingHtml.');
15115
+ }
15116
+ if (requestParameters.trackingHtmlRenderRequest === null || requestParameters.trackingHtmlRenderRequest === undefined) {
15117
+ throw new runtime.RequiredError('trackingHtmlRenderRequest', 'Required parameter requestParameters.trackingHtmlRenderRequest was null or undefined when calling renderSfvbTrackingHtml.');
15118
+ }
15119
+ queryParameters = {};
15120
+ headerParameters = {};
15121
+ headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
15122
+ if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
15123
+ // oauth required
15124
+ _a = headerParameters;
15125
+ _b = "Authorization";
15126
+ return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
15127
+ case 1:
15128
+ // oauth required
15129
+ _a[_b] = _c.sent();
15130
+ _c.label = 2;
15131
+ case 2:
15132
+ if (this.configuration && this.configuration.apiKey) {
15133
+ headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
15134
+ }
15135
+ return [4 /*yield*/, this.request({
15136
+ path: "/sfvb/storefronts/{storefront_oid}/tracking/html/{slot}/render".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("slot", "}"), encodeURIComponent(String(requestParameters.slot))),
15137
+ method: 'POST',
15138
+ headers: headerParameters,
15139
+ query: queryParameters,
15140
+ body: (0, models_1.SfvbTrackingHtmlRenderRequestToJSON)(requestParameters.trackingHtmlRenderRequest),
15141
+ }, initOverrides)];
15142
+ case 3:
15143
+ response = _c.sent();
15144
+ return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbTrackingHtmlRenderResponseFromJSON)(jsonValue); })];
15145
+ }
15146
+ });
15147
+ });
15148
+ };
15149
+ /**
15150
+ * 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.
15151
+ * Render the Conversion HTML against a test order
15152
+ */
15153
+ SfvbApi.prototype.renderSfvbTrackingHtml = function (requestParameters, initOverrides) {
15154
+ return __awaiter(this, void 0, void 0, function () {
15155
+ var response;
15156
+ return __generator(this, function (_a) {
15157
+ switch (_a.label) {
15158
+ case 0: return [4 /*yield*/, this.renderSfvbTrackingHtmlRaw(requestParameters, initOverrides)];
15159
+ case 1:
15160
+ response = _a.sent();
15161
+ return [4 /*yield*/, response.value()];
15162
+ case 2: return [2 /*return*/, _a.sent()];
15163
+ }
15164
+ });
15165
+ });
15166
+ };
15027
15167
  /**
15028
15168
  * 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.
15029
15169
  * Render a transactional email without sending it
@@ -136,7 +136,7 @@ export interface SfvbApprovalParams {
136
136
  */
137
137
  step_uuid?: string;
138
138
  /**
139
- * The tracking provider key, for tracking_provider.change.
139
+ * The tracking provider key, for tracking_provider.change and tracking_provider.clear.
140
140
  * @type {string}
141
141
  * @memberof SfvbApprovalParams
142
142
  */
@@ -15,6 +15,12 @@
15
15
  * @interface SfvbCommsLookupOwner
16
16
  */
17
17
  export interface SfvbCommsLookupOwner {
18
+ /**
19
+ * True when the campaign or flow is archived. It sends nothing, and 'sf comms flows list' or 'campaigns list' shows it only with --include-deleted.
20
+ * @type {boolean}
21
+ * @memberof SfvbCommsLookupOwner
22
+ */
23
+ archived?: boolean;
18
24
  /**
19
25
  * True when it is sending now, by the same rule the sequence read uses.
20
26
  * @type {boolean}
@@ -32,6 +32,7 @@ function SfvbCommsLookupOwnerFromJSONTyped(json, ignoreDiscriminator) {
32
32
  return json;
33
33
  }
34
34
  return {
35
+ 'archived': !(0, runtime_1.exists)(json, 'archived') ? undefined : json['archived'],
35
36
  'live': !(0, runtime_1.exists)(json, 'live') ? undefined : json['live'],
36
37
  'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
37
38
  'status': !(0, runtime_1.exists)(json, 'status') ? undefined : json['status'],
@@ -48,6 +49,7 @@ function SfvbCommsLookupOwnerToJSON(value) {
48
49
  return null;
49
50
  }
50
51
  return {
52
+ 'archived': value.archived,
51
53
  'live': value.live,
52
54
  'name': value.name,
53
55
  'status': value.status,
@@ -16,6 +16,12 @@ import { SfvbCommsLookupOwner } from './SfvbCommsLookupOwner';
16
16
  * @interface SfvbCommsLookupResponse
17
17
  */
18
18
  export interface SfvbCommsLookupResponse {
19
+ /**
20
+ * True when the uuid is an archived campaign or flow. It is still on its storefront and can be read; it sends nothing.
21
+ * @type {boolean}
22
+ * @memberof SfvbCommsLookupResponse
23
+ */
24
+ archived?: boolean;
19
25
  /**
20
26
  * The sequence it belongs to, when there is one.
21
27
  * @type {string}
@@ -33,6 +33,7 @@ function SfvbCommsLookupResponseFromJSONTyped(json, ignoreDiscriminator) {
33
33
  return json;
34
34
  }
35
35
  return {
36
+ 'archived': !(0, runtime_1.exists)(json, 'archived') ? undefined : json['archived'],
36
37
  'communication_sequence_uuid': !(0, runtime_1.exists)(json, 'communication_sequence_uuid') ? undefined : json['communication_sequence_uuid'],
37
38
  'kind': !(0, runtime_1.exists)(json, 'kind') ? undefined : json['kind'],
38
39
  'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
@@ -53,6 +54,7 @@ function SfvbCommsLookupResponseToJSON(value) {
53
54
  return null;
54
55
  }
55
56
  return {
57
+ 'archived': value.archived,
56
58
  'communication_sequence_uuid': value.communication_sequence_uuid,
57
59
  'kind': value.kind,
58
60
  'name': value.name,
@@ -0,0 +1,37 @@
1
+ /**
2
+ * UltraCart Rest API V2
3
+ * UltraCart REST API Version 2
4
+ *
5
+ * The version of the OpenAPI document: 2.0.0
6
+ * Contact: support@ultracart.com
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface SfvbPreviewTrackingHtmlRequest
16
+ */
17
+ export interface SfvbPreviewTrackingHtmlRequest {
18
+ /**
19
+ * Conversion HTML to run instead of the live slot on a test order's receipt opened through this session's preview access link. Never on a real order's receipt. An empty string unstages it. The same checks as a write apply.
20
+ * @type {string}
21
+ * @memberof SfvbPreviewTrackingHtmlRequest
22
+ */
23
+ conversion_html?: string;
24
+ /**
25
+ * Tracking HTML to run instead of the live slot on pages opened through this session's preview access link. An empty string unstages it. The same checks as a write apply.
26
+ * @type {string}
27
+ * @memberof SfvbPreviewTrackingHtmlRequest
28
+ */
29
+ tracking_html?: string;
30
+ }
31
+ /**
32
+ * Check if a given object implements the SfvbPreviewTrackingHtmlRequest interface.
33
+ */
34
+ export declare function instanceOfSfvbPreviewTrackingHtmlRequest(value: object): boolean;
35
+ export declare function SfvbPreviewTrackingHtmlRequestFromJSON(json: any): SfvbPreviewTrackingHtmlRequest;
36
+ export declare function SfvbPreviewTrackingHtmlRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbPreviewTrackingHtmlRequest;
37
+ export declare function SfvbPreviewTrackingHtmlRequestToJSON(value?: SfvbPreviewTrackingHtmlRequest | null): any;