ultracart_rest_api_v2_typescript 4.1.234 → 4.1.235

package/.openapi-generator/FILES

@@ -1319,6 +1319,13 @@ src/models/SfvbThemesResponse.ts
 src/models/SfvbTrackingAdvanced.ts
 src/models/SfvbTrackingAdvancedRequest.ts
 src/models/SfvbTrackingChange.ts
+src/models/SfvbTrackingCheckPlan.ts
+src/models/SfvbTrackingCheckPlanEvent.ts
+src/models/SfvbTrackingCheckPlanGate.ts
+src/models/SfvbTrackingCheckPlanProvider.ts
+src/models/SfvbTrackingCheckPlanRequest.ts
+src/models/SfvbTrackingCheckPlanServerSide.ts
+src/models/SfvbTrackingCheckPlanUnchecked.ts
 src/models/SfvbTrackingHtml.ts
 src/models/SfvbTrackingHtmlRenderRequest.ts
 src/models/SfvbTrackingHtmlRenderResponse.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.234
+## ultracart_rest_api_v2_typescript@4.1.235
 
 Every API method call has a sample for every language SDK.  See https://github.com/UltraCart/sdk_samples
 
 Installation
 
 ```
-npm install ultracart_rest_api_v2_typescript@4.1.234 --save
+npm install ultracart_rest_api_v2_typescript@4.1.235 --save
 ```
 
 ```typescript
@@ -84,6 +84,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.235 | 11/09/2026 | sfvb internal testing |
 | 4.1.234 | 11/09/2026 | sfvb internal testing |
 | 4.1.233 | 11/06/2026 | sfvb internal testing |
 | 4.1.232 | 11/05/2026 | sfvb internal testing |

package/dist/apis/SfvbApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-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';
+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';
 export interface AddSfvbPageBlogPostsRequest {
     storefrontOid: number;
     path: string;
@@ -637,6 +637,14 @@ export interface GetSfvbThemeJobRequest {
     storefrontOid: number;
     jobId: number;
 }
+export interface GetSfvbTrackingCheckPlanRequest {
+    storefrontOid: number;
+    path: string;
+    event?: string;
+    orderId?: string;
+    consent?: string;
+    region?: string;
+}
 export interface GetSfvbTrackingHtmlRequest {
     storefrontOid: number;
     slot: string;
@@ -3615,6 +3623,25 @@ export interface SfvbApiInterface {
      * Status of an asynchronous theme job
      */
     getSfvbThemeJob(requestParameters: GetSfvbThemeJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbThemeJobResponse>;
+    /**
+     * 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.
+     * @summary Plan a browser check of a storefront\'s tracking
+     * @param {number} storefrontOid
+     * @param {string} path A storefront page path, such as / or /checkout/receipt.html, with an optional query
+     * @param {string} [event] page_view (the default) or purchase
+     * @param {string} [orderId] For purchase, a test order on this account
+     * @param {string} [consent] none, all, or a comma list of statistics, preferences and marketing
+     * @param {string} [region] Where the browser is.  eea, non-us or other
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    getSfvbTrackingCheckPlanRaw(requestParameters: GetSfvbTrackingCheckPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTrackingCheckPlan>>;
+    /**
+     * 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.
+     * Plan a browser check of a storefront\'s tracking
+     */
+    getSfvbTrackingCheckPlan(requestParameters: GetSfvbTrackingCheckPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTrackingCheckPlan>;
     /**
      * The HTML with its Velocity tokens as stored, and the hash_sha256 a write sends back as If-Match.
      * @summary Read one custom tracking HTML slot
@@ -7387,6 +7414,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Status of an asynchronous theme job
      */
     getSfvbThemeJob(requestParameters: GetSfvbThemeJobRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbThemeJobResponse>;
+    /**
+     * 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.
+     * Plan a browser check of a storefront\'s tracking
+     */
+    getSfvbTrackingCheckPlanRaw(requestParameters: GetSfvbTrackingCheckPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbTrackingCheckPlan>>;
+    /**
+     * 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.
+     * Plan a browser check of a storefront\'s tracking
+     */
+    getSfvbTrackingCheckPlan(requestParameters: GetSfvbTrackingCheckPlanRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbTrackingCheckPlan>;
     /**
      * The HTML with its Velocity tokens as stored, and the hash_sha256 a write sends back as If-Match.
      * Read one custom tracking HTML slot

package/dist/apis/SfvbApi.js

@@ -9376,6 +9376,83 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * 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.
+     * Plan a browser check of a storefront\'s tracking
+     */
+    SfvbApi.prototype.getSfvbTrackingCheckPlanRaw = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var queryParameters, headerParameters, _a, _b, response;
+            return __generator(this, function (_c) {
+                switch (_c.label) {
+                    case 0:
+                        if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+                            throw new runtime.RequiredError('storefrontOid', 'Required parameter requestParameters.storefrontOid was null or undefined when calling getSfvbTrackingCheckPlan.');
+                        }
+                        if (requestParameters.path === null || requestParameters.path === undefined) {
+                            throw new runtime.RequiredError('path', 'Required parameter requestParameters.path was null or undefined when calling getSfvbTrackingCheckPlan.');
+                        }
+                        queryParameters = {};
+                        if (requestParameters.path !== undefined) {
+                            queryParameters['path'] = requestParameters.path;
+                        }
+                        if (requestParameters.event !== undefined) {
+                            queryParameters['event'] = requestParameters.event;
+                        }
+                        if (requestParameters.orderId !== undefined) {
+                            queryParameters['order_id'] = requestParameters.orderId;
+                        }
+                        if (requestParameters.consent !== undefined) {
+                            queryParameters['consent'] = requestParameters.consent;
+                        }
+                        if (requestParameters.region !== undefined) {
+                            queryParameters['region'] = requestParameters.region;
+                        }
+                        headerParameters = {};
+                        if (!(this.configuration && this.configuration.accessToken)) return [3 /*break*/, 2];
+                        // oauth required
+                        _a = headerParameters;
+                        _b = "Authorization";
+                        return [4 /*yield*/, this.configuration.accessToken("ultraCartOauth", [])];
+                    case 1:
+                        // oauth required
+                        _a[_b] = _c.sent();
+                        _c.label = 2;
+                    case 2:
+                        if (this.configuration && this.configuration.apiKey) {
+                            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+                        }
+                        return [4 /*yield*/, this.request({
+                                path: "/sfvb/storefronts/{storefront_oid}/tracking/check_plan".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
+                                method: 'GET',
+                                headers: headerParameters,
+                                query: queryParameters,
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbTrackingCheckPlanFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * 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.
+     * Plan a browser check of a storefront\'s tracking
+     */
+    SfvbApi.prototype.getSfvbTrackingCheckPlan = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            var response;
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.getSfvbTrackingCheckPlanRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * The HTML with its Velocity tokens as stored, and the hash_sha256 a write sends back as If-Match.
      * Read one custom tracking HTML slot

package/dist/models/SfvbTrackingCheckPlan.d.ts

@@ -0,0 +1,123 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import { SfvbTrackingCheckPlanProvider } from './SfvbTrackingCheckPlanProvider';
+import { SfvbTrackingCheckPlanServerSide } from './SfvbTrackingCheckPlanServerSide';
+import { SfvbTrackingCheckPlanUnchecked } from './SfvbTrackingCheckPlanUnchecked';
+/**
+ *
+ * @export
+ * @interface SfvbTrackingCheckPlan
+ */
+export interface SfvbTrackingCheckPlan {
+    /**
+     * The tracking provider catalog version the plan was built from.
+     * @type {number}
+     * @memberof SfvbTrackingCheckPlan
+     */
+    catalog_version?: number;
+    /**
+     * The consent state the plan assumes.  none, all, or the granted categories in the order statistics, preferences, marketing.  Left out when the plan lists every gate instead.
+     * @type {string}
+     * @memberof SfvbTrackingCheckPlan
+     */
+    consent?: string;
+    /**
+     * page_view, or purchase for a test order receipt.
+     * @type {string}
+     * @memberof SfvbTrackingCheckPlan
+     */
+    event?: SfvbTrackingCheckPlanEventEnum;
+    /**
+     * What the plan assumes about the browser and the page.
+     * @type {Array<string>}
+     * @memberof SfvbTrackingCheckPlan
+     */
+    notes?: Array<string>;
+    /**
+     * The test order a purchase plan is for.  Left out for a page view.
+     * @type {string}
+     * @memberof SfvbTrackingCheckPlan
+     */
+    order_id?: string;
+    /**
+     * The page path the plan is for, as given.
+     * @type {string}
+     * @memberof SfvbTrackingCheckPlan
+     */
+    path?: string;
+    /**
+     * The lowercase SHA-256 hex of the UTF-8 bytes of this response written as JSON without plan_id and snippet, with object keys sorted, no white space, and keys whose value is null left out, as JavaScript JSON.stringify writes values.  A results file carries it, so the CLI can tell which plan the results belong to.
+     * @type {string}
+     * @memberof SfvbTrackingCheckPlan
+     */
+    plan_id?: string;
+    /**
+     * One entry per provider the storefront turns on for this event, then one per host found in custom or affiliate network HTML.
+     * @type {Array<SfvbTrackingCheckPlanProvider>}
+     * @memberof SfvbTrackingCheckPlan
+     */
+    providers?: Array<SfvbTrackingCheckPlanProvider>;
+    /**
+     * Where the browser is, which decides which gates apply.  eea, non-us or other.  Left out when the plan lists every gate instead.
+     * @type {string}
+     * @memberof SfvbTrackingCheckPlan
+     */
+    region?: SfvbTrackingCheckPlanRegionEnum;
+    /**
+     * What providers send from UltraCart servers for this event.  The browser never sees these, so they are reported as not checked.
+     * @type {Array<SfvbTrackingCheckPlanServerSide>}
+     * @memberof SfvbTrackingCheckPlan
+     */
+    server_side?: Array<SfvbTrackingCheckPlanServerSide>;
+    /**
+     * The collector, the source of one JavaScript async arrow function.  Run it with addInitScript before the action so it starts before the page scripts, then run it again with evaluate after the action.  The second run waits for 3 seconds of quiet, or 15 seconds at most, and returns plan_id, page, collected_at, requests (url, initiator) and events (via, name, params).  URLs keep only the query params the plan names for that host, and events only the params the plan names.  It never reads cookies, storage or form fields and sends nothing anywhere.
+     * @type {string}
+     * @memberof SfvbTrackingCheckPlan
+     */
+    snippet?: string;
+    /**
+     * The storefront.
+     * @type {number}
+     * @memberof SfvbTrackingCheckPlan
+     */
+    storefront_oid?: number;
+    /**
+     * What the plan could not predict, and why.
+     * @type {Array<SfvbTrackingCheckPlanUnchecked>}
+     * @memberof SfvbTrackingCheckPlan
+     */
+    unchecked?: Array<SfvbTrackingCheckPlanUnchecked>;
+}
+/**
+ * @export
+ */
+export declare const SfvbTrackingCheckPlanEventEnum: {
+    readonly PageView: "page_view";
+    readonly Purchase: "purchase";
+};
+export type SfvbTrackingCheckPlanEventEnum = typeof SfvbTrackingCheckPlanEventEnum[keyof typeof SfvbTrackingCheckPlanEventEnum];
+/**
+ * @export
+ */
+export declare const SfvbTrackingCheckPlanRegionEnum: {
+    readonly Eea: "eea";
+    readonly NonUs: "non-us";
+    readonly Other: "other";
+};
+export type SfvbTrackingCheckPlanRegionEnum = typeof SfvbTrackingCheckPlanRegionEnum[keyof typeof SfvbTrackingCheckPlanRegionEnum];
+/**
+ * Check if a given object implements the SfvbTrackingCheckPlan interface.
+ */
+export declare function instanceOfSfvbTrackingCheckPlan(value: object): boolean;
+export declare function SfvbTrackingCheckPlanFromJSON(json: any): SfvbTrackingCheckPlan;
+export declare function SfvbTrackingCheckPlanFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbTrackingCheckPlan;
+export declare function SfvbTrackingCheckPlanToJSON(value?: SfvbTrackingCheckPlan | null): any;

package/dist/models/SfvbTrackingCheckPlan.js

@@ -0,0 +1,92 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SfvbTrackingCheckPlanToJSON = exports.SfvbTrackingCheckPlanFromJSONTyped = exports.SfvbTrackingCheckPlanFromJSON = exports.instanceOfSfvbTrackingCheckPlan = exports.SfvbTrackingCheckPlanRegionEnum = exports.SfvbTrackingCheckPlanEventEnum = void 0;
+var runtime_1 = require("../runtime");
+var SfvbTrackingCheckPlanProvider_1 = require("./SfvbTrackingCheckPlanProvider");
+var SfvbTrackingCheckPlanServerSide_1 = require("./SfvbTrackingCheckPlanServerSide");
+var SfvbTrackingCheckPlanUnchecked_1 = require("./SfvbTrackingCheckPlanUnchecked");
+/**
+ * @export
+ */
+exports.SfvbTrackingCheckPlanEventEnum = {
+    PageView: 'page_view',
+    Purchase: 'purchase'
+};
+/**
+ * @export
+ */
+exports.SfvbTrackingCheckPlanRegionEnum = {
+    Eea: 'eea',
+    NonUs: 'non-us',
+    Other: 'other'
+};
+/**
+ * Check if a given object implements the SfvbTrackingCheckPlan interface.
+ */
+function instanceOfSfvbTrackingCheckPlan(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbTrackingCheckPlan = instanceOfSfvbTrackingCheckPlan;
+function SfvbTrackingCheckPlanFromJSON(json) {
+    return SfvbTrackingCheckPlanFromJSONTyped(json, false);
+}
+exports.SfvbTrackingCheckPlanFromJSON = SfvbTrackingCheckPlanFromJSON;
+function SfvbTrackingCheckPlanFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'catalog_version': !(0, runtime_1.exists)(json, 'catalog_version') ? undefined : json['catalog_version'],
+        'consent': !(0, runtime_1.exists)(json, 'consent') ? undefined : json['consent'],
+        'event': !(0, runtime_1.exists)(json, 'event') ? undefined : json['event'],
+        'notes': !(0, runtime_1.exists)(json, 'notes') ? undefined : json['notes'],
+        'order_id': !(0, runtime_1.exists)(json, 'order_id') ? undefined : json['order_id'],
+        'path': !(0, runtime_1.exists)(json, 'path') ? undefined : json['path'],
+        'plan_id': !(0, runtime_1.exists)(json, 'plan_id') ? undefined : json['plan_id'],
+        'providers': !(0, runtime_1.exists)(json, 'providers') ? undefined : (json['providers'].map(SfvbTrackingCheckPlanProvider_1.SfvbTrackingCheckPlanProviderFromJSON)),
+        'region': !(0, runtime_1.exists)(json, 'region') ? undefined : json['region'],
+        'server_side': !(0, runtime_1.exists)(json, 'server_side') ? undefined : (json['server_side'].map(SfvbTrackingCheckPlanServerSide_1.SfvbTrackingCheckPlanServerSideFromJSON)),
+        'snippet': !(0, runtime_1.exists)(json, 'snippet') ? undefined : json['snippet'],
+        'storefront_oid': !(0, runtime_1.exists)(json, 'storefront_oid') ? undefined : json['storefront_oid'],
+        'unchecked': !(0, runtime_1.exists)(json, 'unchecked') ? undefined : (json['unchecked'].map(SfvbTrackingCheckPlanUnchecked_1.SfvbTrackingCheckPlanUncheckedFromJSON)),
+    };
+}
+exports.SfvbTrackingCheckPlanFromJSONTyped = SfvbTrackingCheckPlanFromJSONTyped;
+function SfvbTrackingCheckPlanToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'catalog_version': value.catalog_version,
+        'consent': value.consent,
+        'event': value.event,
+        'notes': value.notes,
+        'order_id': value.order_id,
+        'path': value.path,
+        'plan_id': value.plan_id,
+        'providers': value.providers === undefined ? undefined : (value.providers.map(SfvbTrackingCheckPlanProvider_1.SfvbTrackingCheckPlanProviderToJSON)),
+        'region': value.region,
+        'server_side': value.server_side === undefined ? undefined : (value.server_side.map(SfvbTrackingCheckPlanServerSide_1.SfvbTrackingCheckPlanServerSideToJSON)),
+        'snippet': value.snippet,
+        'storefront_oid': value.storefront_oid,
+        'unchecked': value.unchecked === undefined ? undefined : (value.unchecked.map(SfvbTrackingCheckPlanUnchecked_1.SfvbTrackingCheckPlanUncheckedToJSON)),
+    };
+}
+exports.SfvbTrackingCheckPlanToJSON = SfvbTrackingCheckPlanToJSON;

package/dist/models/SfvbTrackingCheckPlanEvent.d.ts

@@ -0,0 +1,52 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface SfvbTrackingCheckPlanEvent
+ */
+export interface SfvbTrackingCheckPlanEvent {
+    /**
+     * The event name or command.
+     * @type {string}
+     * @memberof SfvbTrackingCheckPlanEvent
+     */
+    name?: string;
+    /**
+     * Params the call must carry, as text.  A star means present with any value.
+     * @type {object}
+     * @memberof SfvbTrackingCheckPlanEvent
+     */
+    params?: object;
+    /**
+     * dataLayer, gtag or fbq.
+     * @type {string}
+     * @memberof SfvbTrackingCheckPlanEvent
+     */
+    via?: SfvbTrackingCheckPlanEventViaEnum;
+}
+/**
+ * @export
+ */
+export declare const SfvbTrackingCheckPlanEventViaEnum: {
+    readonly DataLayer: "dataLayer";
+    readonly Gtag: "gtag";
+    readonly Fbq: "fbq";
+};
+export type SfvbTrackingCheckPlanEventViaEnum = typeof SfvbTrackingCheckPlanEventViaEnum[keyof typeof SfvbTrackingCheckPlanEventViaEnum];
+/**
+ * Check if a given object implements the SfvbTrackingCheckPlanEvent interface.
+ */
+export declare function instanceOfSfvbTrackingCheckPlanEvent(value: object): boolean;
+export declare function SfvbTrackingCheckPlanEventFromJSON(json: any): SfvbTrackingCheckPlanEvent;
+export declare function SfvbTrackingCheckPlanEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbTrackingCheckPlanEvent;
+export declare function SfvbTrackingCheckPlanEventToJSON(value?: SfvbTrackingCheckPlanEvent | null): any;

package/dist/models/SfvbTrackingCheckPlanEvent.js

@@ -0,0 +1,62 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.SfvbTrackingCheckPlanEventToJSON = exports.SfvbTrackingCheckPlanEventFromJSONTyped = exports.SfvbTrackingCheckPlanEventFromJSON = exports.instanceOfSfvbTrackingCheckPlanEvent = exports.SfvbTrackingCheckPlanEventViaEnum = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * @export
+ */
+exports.SfvbTrackingCheckPlanEventViaEnum = {
+    DataLayer: 'dataLayer',
+    Gtag: 'gtag',
+    Fbq: 'fbq'
+};
+/**
+ * Check if a given object implements the SfvbTrackingCheckPlanEvent interface.
+ */
+function instanceOfSfvbTrackingCheckPlanEvent(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbTrackingCheckPlanEvent = instanceOfSfvbTrackingCheckPlanEvent;
+function SfvbTrackingCheckPlanEventFromJSON(json) {
+    return SfvbTrackingCheckPlanEventFromJSONTyped(json, false);
+}
+exports.SfvbTrackingCheckPlanEventFromJSON = SfvbTrackingCheckPlanEventFromJSON;
+function SfvbTrackingCheckPlanEventFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'name': !(0, runtime_1.exists)(json, 'name') ? undefined : json['name'],
+        'params': !(0, runtime_1.exists)(json, 'params') ? undefined : json['params'],
+        'via': !(0, runtime_1.exists)(json, 'via') ? undefined : json['via'],
+    };
+}
+exports.SfvbTrackingCheckPlanEventFromJSONTyped = SfvbTrackingCheckPlanEventFromJSONTyped;
+function SfvbTrackingCheckPlanEventToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'params': value.params,
+        'via': value.via,
+    };
+}
+exports.SfvbTrackingCheckPlanEventToJSON = SfvbTrackingCheckPlanEventToJSON;

package/dist/models/SfvbTrackingCheckPlanGate.d.ts

@@ -0,0 +1,55 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface SfvbTrackingCheckPlanGate
+ */
+export interface SfvbTrackingCheckPlanGate {
+    /**
+     * Where the gate applies.  all, eea or non_us.
+     * @type {string}
+     * @memberof SfvbTrackingCheckPlanGate
+     */
+    region?: SfvbTrackingCheckPlanGateRegionEnum;
+    /**
+     * The consent category that must be granted.  Statistics, Preferences or Marketing.
+     * @type {string}
+     * @memberof SfvbTrackingCheckPlanGate
+     */
+    type?: SfvbTrackingCheckPlanGateTypeEnum;
+}
+/**
+ * @export
+ */
+export declare const SfvbTrackingCheckPlanGateRegionEnum: {
+    readonly All: "all";
+    readonly Eea: "eea";
+    readonly NonUs: "non_us";
+};
+export type SfvbTrackingCheckPlanGateRegionEnum = typeof SfvbTrackingCheckPlanGateRegionEnum[keyof typeof SfvbTrackingCheckPlanGateRegionEnum];
+/**
+ * @export
+ */
+export declare const SfvbTrackingCheckPlanGateTypeEnum: {
+    readonly Statistics: "Statistics";
+    readonly Preferences: "Preferences";
+    readonly Marketing: "Marketing";
+};
+export type SfvbTrackingCheckPlanGateTypeEnum = typeof SfvbTrackingCheckPlanGateTypeEnum[keyof typeof SfvbTrackingCheckPlanGateTypeEnum];
+/**
+ * Check if a given object implements the SfvbTrackingCheckPlanGate interface.
+ */
+export declare function instanceOfSfvbTrackingCheckPlanGate(value: object): boolean;
+export declare function SfvbTrackingCheckPlanGateFromJSON(json: any): SfvbTrackingCheckPlanGate;
+export declare function SfvbTrackingCheckPlanGateFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbTrackingCheckPlanGate;
+export declare function SfvbTrackingCheckPlanGateToJSON(value?: SfvbTrackingCheckPlanGate | null): any;