ultracart_rest_api_v2_typescript 4.1.178 → 4.1.179

package/.openapi-generator/FILES

@@ -1075,6 +1075,12 @@ src/models/SfvbPreviewAccessResponse.ts
 src/models/SfvbPreviewSessionRequest.ts
 src/models/SfvbPreviewSessionResponse.ts
 src/models/SfvbPreviewUrlResponse.ts
+src/models/SfvbRecording.ts
+src/models/SfvbRecordingEvent.ts
+src/models/SfvbRecordingEventsResponse.ts
+src/models/SfvbRecordingPageView.ts
+src/models/SfvbRecordingParameter.ts
+src/models/SfvbRecordingResponse.ts
 src/models/SfvbRenderRequest.ts
 src/models/SfvbRenderResponse.ts
 src/models/SfvbServerLog.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.178
+## ultracart_rest_api_v2_typescript@4.1.179
 
 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.178 --save
+npm install ultracart_rest_api_v2_typescript@4.1.179 --save
 ```
 
 ```typescript
@@ -84,6 +84,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.179 | 10/01/2026 | sfvb internal testing |
 | 4.1.178 | 09/30/2026 | sfvb internal testing |
 | 4.1.177 | 09/30/2026 | sfvb internal testing |
 | 4.1.176 | 09/29/2026 | taxcloud tax provider testing |

package/dist/apis/SfvbApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryEntry, SfvbLibraryResponse, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
+import { SfvbBlogPostDetail, SfvbBlogPostImageRequest, SfvbBlogPostRequest, SfvbBlogPostsResponse, SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbExperiment, SfvbExperimentEndRequest, SfvbExperimentObjectivesResponse, SfvbExperimentStartRequest, SfvbExperimentVariationUpdateRequest, SfvbExperimentsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbItemAttributeUpdateRequest, SfvbItemContainersResponse, SfvbItemContentRequest, SfvbItemMultimediaRequest, SfvbItemResponse, SfvbItemSeoRequest, SfvbLibraryEntry, SfvbLibraryResponse, SfvbMenu, SfvbMenuWriteRequest, SfvbMenusResponse, SfvbPageAttributeUpdateRequest, SfvbPageBlogPostsRequest, SfvbPageBlogPostsResponse, SfvbPageCreateRequest, SfvbPageDuplicateRequest, SfvbPageItemsAddRequest, SfvbPageItemsRemoveRequest, SfvbPageItemsResponse, SfvbPageListResponse, SfvbPageMultimediaRequest, SfvbPageRefreshRequest, SfvbPageRefreshResponse, SfvbPageResponse, SfvbPageSelectors, SfvbPageSettingsRequest, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRecordingEventsResponse, SfvbRecordingResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbServerLogDetail, SfvbServerLogsResponse, SfvbSiteAttributeUpdateRequest, SfvbSiteAttributesResponse, SfvbStorefrontsResponse, SfvbTemplateResolveResponse, SfvbTemplatesResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffer, SfvbUpsellOffersResponse, SfvbUpsellPath, SfvbUpsellPathDuplicateRequest, SfvbUpsellPathMoveRequest, SfvbUpsellPathsResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
 export interface AddSfvbPageBlogPostsRequest {
     storefrontOid: number;
     path: string;
@@ -189,6 +189,15 @@ export interface GetSfvbPreviewUrlRequest {
     previewSessionId: string;
     path?: string;
 }
+export interface GetSfvbRecordingRequest {
+    storefrontOid: number;
+    screenRecordingUuid: string;
+}
+export interface GetSfvbRecordingPageViewEventsRequest {
+    storefrontOid: number;
+    screenRecordingUuid: string;
+    screenRecordingPageViewUuid: string;
+}
 export interface GetSfvbServerLogRequest {
     storefrontOid: number;
     logId: string;
@@ -1123,6 +1132,37 @@ export interface SfvbApiInterface {
      * URL that renders a preview session
      */
     getSfvbPreviewUrl(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewUrlResponse>;
+    /**
+     * One recorded visitor session and its page views, with each page view\'s named events such as rage clicks, script errors and checkout errors, but without the replay data.  Fetch a page view\'s replay events separately.  Find recordings to look at from the heatmaps or the analytics warehouse.  The visitor\'s email, IP address and visitor id are not returned, nor what they typed into form fields.  Reading a recording does not mark it watched.
+     * @summary Get a screen recording
+     * @param {number} storefrontOid
+     * @param {string} screenRecordingUuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    getSfvbRecordingRaw(requestParameters: GetSfvbRecordingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRecordingResponse>>;
+    /**
+     * One recorded visitor session and its page views, with each page view\'s named events such as rage clicks, script errors and checkout errors, but without the replay data.  Fetch a page view\'s replay events separately.  Find recordings to look at from the heatmaps or the analytics warehouse.  The visitor\'s email, IP address and visitor id are not returned, nor what they typed into form fields.  Reading a recording does not mark it watched.
+     * Get a screen recording
+     */
+    getSfvbRecording(requestParameters: GetSfvbRecordingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingResponse>;
+    /**
+     * The rrweb events for one page view, as a JSON array in a string, for replaying on the caller\'s own machine.  Card fields are masked by the recorder, but other text the visitor typed can appear.  Limited per account to 30 page views a minute, 300 an hour and 1000 a day.  Reading the events does not mark the recording watched.
+     * @summary Get one recorded page view\'s replay events
+     * @param {number} storefrontOid
+     * @param {string} screenRecordingUuid
+     * @param {string} screenRecordingPageViewUuid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    getSfvbRecordingPageViewEventsRaw(requestParameters: GetSfvbRecordingPageViewEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRecordingEventsResponse>>;
+    /**
+     * The rrweb events for one page view, as a JSON array in a string, for replaying on the caller\'s own machine.  Card fields are masked by the recorder, but other text the visitor typed can appear.  Limited per account to 30 page views a minute, 300 an hour and 1000 a day.  Reading the events does not mark the recording watched.
+     * Get one recorded page view\'s replay events
+     */
+    getSfvbRecordingPageViewEvents(requestParameters: GetSfvbRecordingPageViewEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingEventsResponse>;
     /**
      * One render\'s server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message.  log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session.  min_level is debug, info, warn or error, default debug.
      * @summary Get one storefront render log
@@ -2524,6 +2564,26 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * URL that renders a preview session
      */
     getSfvbPreviewUrl(requestParameters: GetSfvbPreviewUrlRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewUrlResponse>;
+    /**
+     * One recorded visitor session and its page views, with each page view\'s named events such as rage clicks, script errors and checkout errors, but without the replay data.  Fetch a page view\'s replay events separately.  Find recordings to look at from the heatmaps or the analytics warehouse.  The visitor\'s email, IP address and visitor id are not returned, nor what they typed into form fields.  Reading a recording does not mark it watched.
+     * Get a screen recording
+     */
+    getSfvbRecordingRaw(requestParameters: GetSfvbRecordingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRecordingResponse>>;
+    /**
+     * One recorded visitor session and its page views, with each page view\'s named events such as rage clicks, script errors and checkout errors, but without the replay data.  Fetch a page view\'s replay events separately.  Find recordings to look at from the heatmaps or the analytics warehouse.  The visitor\'s email, IP address and visitor id are not returned, nor what they typed into form fields.  Reading a recording does not mark it watched.
+     * Get a screen recording
+     */
+    getSfvbRecording(requestParameters: GetSfvbRecordingRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingResponse>;
+    /**
+     * The rrweb events for one page view, as a JSON array in a string, for replaying on the caller\'s own machine.  Card fields are masked by the recorder, but other text the visitor typed can appear.  Limited per account to 30 page views a minute, 300 an hour and 1000 a day.  Reading the events does not mark the recording watched.
+     * Get one recorded page view\'s replay events
+     */
+    getSfvbRecordingPageViewEventsRaw(requestParameters: GetSfvbRecordingPageViewEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRecordingEventsResponse>>;
+    /**
+     * The rrweb events for one page view, as a JSON array in a string, for replaying on the caller\'s own machine.  Card fields are masked by the recorder, but other text the visitor typed can appear.  Limited per account to 30 page views a minute, 300 an hour and 1000 a day.  Reading the events does not mark the recording watched.
+     * Get one recorded page view\'s replay events
+     */
+    getSfvbRecordingPageViewEvents(requestParameters: GetSfvbRecordingPageViewEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingEventsResponse>;
     /**
      * One render\'s server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message.  log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session.  min_level is debug, info, warn or error, default debug.
      * Get one storefront render log

package/dist/apis/SfvbApi.js

@@ -2639,6 +2639,133 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * One recorded visitor session and its page views, with each page view\'s named events such as rage clicks, script errors and checkout errors, but without the replay data.  Fetch a page view\'s replay events separately.  Find recordings to look at from the heatmaps or the analytics warehouse.  The visitor\'s email, IP address and visitor id are not returned, nor what they typed into form fields.  Reading a recording does not mark it watched.
+     * Get a screen recording
+     */
+    SfvbApi.prototype.getSfvbRecordingRaw = 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 getSfvbRecording.');
+                        }
+                        if (requestParameters.screenRecordingUuid === null || requestParameters.screenRecordingUuid === undefined) {
+                            throw new runtime.RequiredError('screenRecordingUuid', 'Required parameter requestParameters.screenRecordingUuid was null or undefined when calling getSfvbRecording.');
+                        }
+                        queryParameters = {};
+                        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}/recordings/{screen_recording_uuid}".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("screen_recording_uuid", "}"), encodeURIComponent(String(requestParameters.screenRecordingUuid))),
+                                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.SfvbRecordingResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * One recorded visitor session and its page views, with each page view\'s named events such as rage clicks, script errors and checkout errors, but without the replay data.  Fetch a page view\'s replay events separately.  Find recordings to look at from the heatmaps or the analytics warehouse.  The visitor\'s email, IP address and visitor id are not returned, nor what they typed into form fields.  Reading a recording does not mark it watched.
+     * Get a screen recording
+     */
+    SfvbApi.prototype.getSfvbRecording = 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.getSfvbRecordingRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
+    /**
+     * The rrweb events for one page view, as a JSON array in a string, for replaying on the caller\'s own machine.  Card fields are masked by the recorder, but other text the visitor typed can appear.  Limited per account to 30 page views a minute, 300 an hour and 1000 a day.  Reading the events does not mark the recording watched.
+     * Get one recorded page view\'s replay events
+     */
+    SfvbApi.prototype.getSfvbRecordingPageViewEventsRaw = 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 getSfvbRecordingPageViewEvents.');
+                        }
+                        if (requestParameters.screenRecordingUuid === null || requestParameters.screenRecordingUuid === undefined) {
+                            throw new runtime.RequiredError('screenRecordingUuid', 'Required parameter requestParameters.screenRecordingUuid was null or undefined when calling getSfvbRecordingPageViewEvents.');
+                        }
+                        if (requestParameters.screenRecordingPageViewUuid === null || requestParameters.screenRecordingPageViewUuid === undefined) {
+                            throw new runtime.RequiredError('screenRecordingPageViewUuid', 'Required parameter requestParameters.screenRecordingPageViewUuid was null or undefined when calling getSfvbRecordingPageViewEvents.');
+                        }
+                        queryParameters = {};
+                        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}/recordings/{screen_recording_uuid}/page_views/{screen_recording_page_view_uuid}/events".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))).replace("{".concat("screen_recording_uuid", "}"), encodeURIComponent(String(requestParameters.screenRecordingUuid))).replace("{".concat("screen_recording_page_view_uuid", "}"), encodeURIComponent(String(requestParameters.screenRecordingPageViewUuid))),
+                                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.SfvbRecordingEventsResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * The rrweb events for one page view, as a JSON array in a string, for replaying on the caller\'s own machine.  Card fields are masked by the recorder, but other text the visitor typed can appear.  Limited per account to 30 page views a minute, 300 an hour and 1000 a day.  Reading the events does not mark the recording watched.
+     * Get one recorded page view\'s replay events
+     */
+    SfvbApi.prototype.getSfvbRecordingPageViewEvents = 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.getSfvbRecordingPageViewEventsRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * One render\'s server log with its lines, each with a level, a category such as VELOCITY or FLOW, and the message.  log_id comes from the list, or from the X-UltraCart-Storefront-Log-Id header a page sends inside an SFVB preview session.  min_level is debug, info, warn or error, default debug.
      * Get one storefront render log

package/dist/models/SfvbRecording.d.ts

@@ -0,0 +1,159 @@
+/**
+ * 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 { ScreenRecordingAdPlatform } from './ScreenRecordingAdPlatform';
+import { SfvbRecordingPageView } from './SfvbRecordingPageView';
+/**
+ *
+ * @export
+ * @interface SfvbRecording
+ */
+export interface SfvbRecording {
+    /**
+     *
+     * @type {ScreenRecordingAdPlatform}
+     * @memberof SfvbRecording
+     */
+    ad_platform?: ScreenRecordingAdPlatform;
+    /**
+     * Browser name from the user agent.
+     * @type {string}
+     * @memberof SfvbRecording
+     */
+    browser?: string;
+    /**
+     * Browser version from the user agent.
+     * @type {string}
+     * @memberof SfvbRecording
+     */
+    browser_version?: string;
+    /**
+     * True when the session ended in an order.
+     * @type {boolean}
+     * @memberof SfvbRecording
+     */
+    converted?: boolean;
+    /**
+     * Device name from the user agent.
+     * @type {string}
+     * @memberof SfvbRecording
+     */
+    device?: string;
+    /**
+     * When the session ended, ISO-8601 in UTC.
+     * @type {string}
+     * @memberof SfvbRecording
+     */
+    end_timestamp?: string;
+    /**
+     * Country the visitor was in.
+     * @type {string}
+     * @memberof SfvbRecording
+     */
+    geolocation_country?: string;
+    /**
+     * State or region the visitor was in.
+     * @type {string}
+     * @memberof SfvbRecording
+     */
+    geolocation_state?: string;
+    /**
+     * The browser language.
+     * @type {string}
+     * @memberof SfvbRecording
+     */
+    language_iso_code?: string;
+    /**
+     * The order placed during the session, when there was one.
+     * @type {string}
+     * @memberof SfvbRecording
+     */
+    order_id?: string;
+    /**
+     * Operating system from the user agent.
+     * @type {string}
+     * @memberof SfvbRecording
+     */
+    os?: string;
+    /**
+     * How many pages the visitor viewed.
+     * @type {number}
+     * @memberof SfvbRecording
+     */
+    page_view_count?: number;
+    /**
+     * The pages viewed, in order.
+     * @type {Array<SfvbRecordingPageView>}
+     * @memberof SfvbRecording
+     */
+    page_views?: Array<SfvbRecordingPageView>;
+    /**
+     * The domain that referred the visitor.
+     * @type {string}
+     * @memberof SfvbRecording
+     */
+    referrer_domain?: string;
+    /**
+     * The rrweb version that recorded the session.  Replay with the same version.
+     * @type {string}
+     * @memberof SfvbRecording
+     */
+    rrweb_version?: string;
+    /**
+     * Identifies the recording.
+     * @type {string}
+     * @memberof SfvbRecording
+     */
+    screen_recording_uuid?: string;
+    /**
+     * When the session started, ISO-8601 in UTC.
+     * @type {string}
+     * @memberof SfvbRecording
+     */
+    start_timestamp?: string;
+    /**
+     * Seconds the visitor spent on the site.
+     * @type {number}
+     * @memberof SfvbRecording
+     */
+    time_on_site?: number;
+    /**
+     * utm_campaign on arrival.
+     * @type {string}
+     * @memberof SfvbRecording
+     */
+    utm_campaign?: string;
+    /**
+     * utm_source on arrival.
+     * @type {string}
+     * @memberof SfvbRecording
+     */
+    utm_source?: string;
+    /**
+     * Browser window height in pixels.
+     * @type {number}
+     * @memberof SfvbRecording
+     */
+    window_height?: number;
+    /**
+     * Browser window width in pixels.
+     * @type {number}
+     * @memberof SfvbRecording
+     */
+    window_width?: number;
+}
+/**
+ * Check if a given object implements the SfvbRecording interface.
+ */
+export declare function instanceOfSfvbRecording(value: object): boolean;
+export declare function SfvbRecordingFromJSON(json: any): SfvbRecording;
+export declare function SfvbRecordingFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbRecording;
+export declare function SfvbRecordingToJSON(value?: SfvbRecording | null): any;

package/dist/models/SfvbRecording.js

@@ -0,0 +1,94 @@
+"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.SfvbRecordingToJSON = exports.SfvbRecordingFromJSONTyped = exports.SfvbRecordingFromJSON = exports.instanceOfSfvbRecording = void 0;
+var runtime_1 = require("../runtime");
+var ScreenRecordingAdPlatform_1 = require("./ScreenRecordingAdPlatform");
+var SfvbRecordingPageView_1 = require("./SfvbRecordingPageView");
+/**
+ * Check if a given object implements the SfvbRecording interface.
+ */
+function instanceOfSfvbRecording(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbRecording = instanceOfSfvbRecording;
+function SfvbRecordingFromJSON(json) {
+    return SfvbRecordingFromJSONTyped(json, false);
+}
+exports.SfvbRecordingFromJSON = SfvbRecordingFromJSON;
+function SfvbRecordingFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'ad_platform': !(0, runtime_1.exists)(json, 'ad_platform') ? undefined : (0, ScreenRecordingAdPlatform_1.ScreenRecordingAdPlatformFromJSON)(json['ad_platform']),
+        'browser': !(0, runtime_1.exists)(json, 'browser') ? undefined : json['browser'],
+        'browser_version': !(0, runtime_1.exists)(json, 'browser_version') ? undefined : json['browser_version'],
+        'converted': !(0, runtime_1.exists)(json, 'converted') ? undefined : json['converted'],
+        'device': !(0, runtime_1.exists)(json, 'device') ? undefined : json['device'],
+        'end_timestamp': !(0, runtime_1.exists)(json, 'end_timestamp') ? undefined : json['end_timestamp'],
+        'geolocation_country': !(0, runtime_1.exists)(json, 'geolocation_country') ? undefined : json['geolocation_country'],
+        'geolocation_state': !(0, runtime_1.exists)(json, 'geolocation_state') ? undefined : json['geolocation_state'],
+        'language_iso_code': !(0, runtime_1.exists)(json, 'language_iso_code') ? undefined : json['language_iso_code'],
+        'order_id': !(0, runtime_1.exists)(json, 'order_id') ? undefined : json['order_id'],
+        'os': !(0, runtime_1.exists)(json, 'os') ? undefined : json['os'],
+        'page_view_count': !(0, runtime_1.exists)(json, 'page_view_count') ? undefined : json['page_view_count'],
+        'page_views': !(0, runtime_1.exists)(json, 'page_views') ? undefined : (json['page_views'].map(SfvbRecordingPageView_1.SfvbRecordingPageViewFromJSON)),
+        'referrer_domain': !(0, runtime_1.exists)(json, 'referrer_domain') ? undefined : json['referrer_domain'],
+        'rrweb_version': !(0, runtime_1.exists)(json, 'rrweb_version') ? undefined : json['rrweb_version'],
+        'screen_recording_uuid': !(0, runtime_1.exists)(json, 'screen_recording_uuid') ? undefined : json['screen_recording_uuid'],
+        'start_timestamp': !(0, runtime_1.exists)(json, 'start_timestamp') ? undefined : json['start_timestamp'],
+        'time_on_site': !(0, runtime_1.exists)(json, 'time_on_site') ? undefined : json['time_on_site'],
+        'utm_campaign': !(0, runtime_1.exists)(json, 'utm_campaign') ? undefined : json['utm_campaign'],
+        'utm_source': !(0, runtime_1.exists)(json, 'utm_source') ? undefined : json['utm_source'],
+        'window_height': !(0, runtime_1.exists)(json, 'window_height') ? undefined : json['window_height'],
+        'window_width': !(0, runtime_1.exists)(json, 'window_width') ? undefined : json['window_width'],
+    };
+}
+exports.SfvbRecordingFromJSONTyped = SfvbRecordingFromJSONTyped;
+function SfvbRecordingToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'ad_platform': (0, ScreenRecordingAdPlatform_1.ScreenRecordingAdPlatformToJSON)(value.ad_platform),
+        'browser': value.browser,
+        'browser_version': value.browser_version,
+        'converted': value.converted,
+        'device': value.device,
+        'end_timestamp': value.end_timestamp,
+        'geolocation_country': value.geolocation_country,
+        'geolocation_state': value.geolocation_state,
+        'language_iso_code': value.language_iso_code,
+        'order_id': value.order_id,
+        'os': value.os,
+        'page_view_count': value.page_view_count,
+        'page_views': value.page_views === undefined ? undefined : (value.page_views.map(SfvbRecordingPageView_1.SfvbRecordingPageViewToJSON)),
+        'referrer_domain': value.referrer_domain,
+        'rrweb_version': value.rrweb_version,
+        'screen_recording_uuid': value.screen_recording_uuid,
+        'start_timestamp': value.start_timestamp,
+        'time_on_site': value.time_on_site,
+        'utm_campaign': value.utm_campaign,
+        'utm_source': value.utm_source,
+        'window_height': value.window_height,
+        'window_width': value.window_width,
+    };
+}
+exports.SfvbRecordingToJSON = SfvbRecordingToJSON;

package/dist/models/SfvbRecordingEvent.d.ts

@@ -0,0 +1,50 @@
+/**
+ * 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 { SfvbRecordingParameter } from './SfvbRecordingParameter';
+/**
+ *
+ * @export
+ * @interface SfvbRecordingEvent
+ */
+export interface SfvbRecordingEvent {
+    /**
+     * The event name, such as rage click, script error, checkout error or add to cart.
+     * @type {string}
+     * @memberof SfvbRecordingEvent
+     */
+    name?: string;
+    /**
+     * The event's parameters as name and value pairs.  Omitted for input change events, whose values are what the visitor typed.
+     * @type {Array<SfvbRecordingParameter>}
+     * @memberof SfvbRecordingEvent
+     */
+    params?: Array<SfvbRecordingParameter>;
+    /**
+     * A short human readable summary of the event, when the recorder produced one.
+     * @type {string}
+     * @memberof SfvbRecordingEvent
+     */
+    sub_text?: string;
+    /**
+     * When it happened, ISO-8601 in UTC.  Subtract the page view's first_event_timestamp for the offset into the replay.
+     * @type {string}
+     * @memberof SfvbRecordingEvent
+     */
+    timestamp?: string;
+}
+/**
+ * Check if a given object implements the SfvbRecordingEvent interface.
+ */
+export declare function instanceOfSfvbRecordingEvent(value: object): boolean;
+export declare function SfvbRecordingEventFromJSON(json: any): SfvbRecordingEvent;
+export declare function SfvbRecordingEventFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbRecordingEvent;
+export declare function SfvbRecordingEventToJSON(value?: SfvbRecordingEvent | null): any;

package/dist/models/SfvbRecordingEvent.js

@@ -0,0 +1,57 @@
+"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.SfvbRecordingEventToJSON = exports.SfvbRecordingEventFromJSONTyped = exports.SfvbRecordingEventFromJSON = exports.instanceOfSfvbRecordingEvent = void 0;
+var runtime_1 = require("../runtime");
+var SfvbRecordingParameter_1 = require("./SfvbRecordingParameter");
+/**
+ * Check if a given object implements the SfvbRecordingEvent interface.
+ */
+function instanceOfSfvbRecordingEvent(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbRecordingEvent = instanceOfSfvbRecordingEvent;
+function SfvbRecordingEventFromJSON(json) {
+    return SfvbRecordingEventFromJSONTyped(json, false);
+}
+exports.SfvbRecordingEventFromJSON = SfvbRecordingEventFromJSON;
+function SfvbRecordingEventFromJSONTyped(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'].map(SfvbRecordingParameter_1.SfvbRecordingParameterFromJSON)),
+        'sub_text': !(0, runtime_1.exists)(json, 'sub_text') ? undefined : json['sub_text'],
+        'timestamp': !(0, runtime_1.exists)(json, 'timestamp') ? undefined : json['timestamp'],
+    };
+}
+exports.SfvbRecordingEventFromJSONTyped = SfvbRecordingEventFromJSONTyped;
+function SfvbRecordingEventToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'name': value.name,
+        'params': value.params === undefined ? undefined : (value.params.map(SfvbRecordingParameter_1.SfvbRecordingParameterToJSON)),
+        'sub_text': value.sub_text,
+        'timestamp': value.timestamp,
+    };
+}
+exports.SfvbRecordingEventToJSON = SfvbRecordingEventToJSON;