ultracart_rest_api_v2_typescript 4.1.180 → 4.1.181

package/.openapi-generator/FILES

@@ -1083,6 +1083,9 @@ src/models/SfvbRecordingEventsResponse.ts
 src/models/SfvbRecordingPageView.ts
 src/models/SfvbRecordingParameter.ts
 src/models/SfvbRecordingResponse.ts
+src/models/SfvbRecordingSettings.ts
+src/models/SfvbRecordingSettingsRequest.ts
+src/models/SfvbRecordingSettingsResponse.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.180
+## ultracart_rest_api_v2_typescript@4.1.181
 
 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.180 --save
+npm install ultracart_rest_api_v2_typescript@4.1.181 --save
 ```
 
 ```typescript
@@ -84,6 +84,7 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.181 | 10/02/2026 | sfvb internal testing |
 | 4.1.180 | 10/02/2026 | sfvb internal builder |
 | 4.1.179 | 10/01/2026 | sfvb internal testing |
 | 4.1.178 | 09/30/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 { 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';
+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, SfvbRecordingSettingsRequest, SfvbRecordingSettingsResponse, 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;
@@ -198,6 +198,9 @@ export interface GetSfvbRecordingPageViewEventsRequest {
     screenRecordingUuid: string;
     screenRecordingPageViewUuid: string;
 }
+export interface GetSfvbRecordingSettingsRequest {
+    storefrontOid: number;
+}
 export interface GetSfvbServerLogRequest {
     storefrontOid: number;
     logId: string;
@@ -409,6 +412,10 @@ export interface PutSfvbPreviewSessionRequest {
     previewSession: SfvbPreviewSessionRequest;
     themeOid?: number;
 }
+export interface PutSfvbRecordingSettingsRequest {
+    storefrontOid: number;
+    recordingSettingsRequest: SfvbRecordingSettingsRequest;
+}
 export interface PutSfvbSiteAttributesRequest {
     storefrontOid: number;
     siteAttributeUpdateRequest: SfvbSiteAttributeUpdateRequest;
@@ -1163,6 +1170,20 @@ export interface SfvbApiInterface {
      * Get one recorded page view\'s replay events
      */
     getSfvbRecordingPageViewEvents(requestParameters: GetSfvbRecordingPageViewEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingEventsResponse>;
+    /**
+     * Whether real shoppers\' sessions on this storefront are being recorded, what recording costs per 1,000 sessions after the 14 day free trial, how long recordings are kept, and how many sessions were recorded in the current and last billing periods.  Recording only collects from the moment it is turned on, so when it is on but was turned on recently, check the analytics warehouse for rows before reporting that there is no data.
+     * @summary Get the storefront\'s screen recording settings
+     * @param {number} storefrontOid
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    getSfvbRecordingSettingsRaw(requestParameters: GetSfvbRecordingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRecordingSettingsResponse>>;
+    /**
+     * Whether real shoppers\' sessions on this storefront are being recorded, what recording costs per 1,000 sessions after the 14 day free trial, how long recordings are kept, and how many sessions were recorded in the current and last billing periods.  Recording only collects from the moment it is turned on, so when it is on but was turned on recently, check the analytics warehouse for rows before reporting that there is no data.
+     * Get the storefront\'s screen recording settings
+     */
+    getSfvbRecordingSettings(requestParameters: GetSfvbRecordingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingSettingsResponse>;
     /**
      * 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
@@ -1842,6 +1863,21 @@ export interface SfvbApiInterface {
      * Push containers into a preview session
      */
     putSfvbPreviewSession(requestParameters: PutSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
+    /**
+     * 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.
+     * @summary Turn the storefront\'s screen recording on or off
+     * @param {number} storefrontOid
+     * @param {SfvbRecordingSettingsRequest} recordingSettingsRequest Whether to record
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    putSfvbRecordingSettingsRaw(requestParameters: PutSfvbRecordingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRecordingSettingsResponse>>;
+    /**
+     * 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.
+     * Turn the storefront\'s screen recording on or off
+     */
+    putSfvbRecordingSettings(requestParameters: PutSfvbRecordingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingSettingsResponse>;
     /**
      * A partial update.  Only the attributes you name are changed.  Every entry is checked before any is written.  List, video list, mailing list and item set attributes are refused, and so are the General screen settings other than the title, the SEO description and keywords and the social account names.  Credentials are refused.  Always needs sfvb_publish, because every theme reads the same attributes and there is no dormant copy to change instead.  The admin General screen saves the whole storefront, so a merchant with it open can still overwrite a change made here.
      * @summary Change a storefront\'s site attributes
@@ -2584,6 +2620,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Get one recorded page view\'s replay events
      */
     getSfvbRecordingPageViewEvents(requestParameters: GetSfvbRecordingPageViewEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingEventsResponse>;
+    /**
+     * Whether real shoppers\' sessions on this storefront are being recorded, what recording costs per 1,000 sessions after the 14 day free trial, how long recordings are kept, and how many sessions were recorded in the current and last billing periods.  Recording only collects from the moment it is turned on, so when it is on but was turned on recently, check the analytics warehouse for rows before reporting that there is no data.
+     * Get the storefront\'s screen recording settings
+     */
+    getSfvbRecordingSettingsRaw(requestParameters: GetSfvbRecordingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRecordingSettingsResponse>>;
+    /**
+     * Whether real shoppers\' sessions on this storefront are being recorded, what recording costs per 1,000 sessions after the 14 day free trial, how long recordings are kept, and how many sessions were recorded in the current and last billing periods.  Recording only collects from the moment it is turned on, so when it is on but was turned on recently, check the analytics warehouse for rows before reporting that there is no data.
+     * Get the storefront\'s screen recording settings
+     */
+    getSfvbRecordingSettings(requestParameters: GetSfvbRecordingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingSettingsResponse>;
     /**
      * 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
@@ -3000,6 +3046,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Push containers into a preview session
      */
     putSfvbPreviewSession(requestParameters: PutSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
+    /**
+     * 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.
+     * Turn the storefront\'s screen recording on or off
+     */
+    putSfvbRecordingSettingsRaw(requestParameters: PutSfvbRecordingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRecordingSettingsResponse>>;
+    /**
+     * 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.
+     * Turn the storefront\'s screen recording on or off
+     */
+    putSfvbRecordingSettings(requestParameters: PutSfvbRecordingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingSettingsResponse>;
     /**
      * A partial update.  Only the attributes you name are changed.  Every entry is checked before any is written.  List, video list, mailing list and item set attributes are refused, and so are the General screen settings other than the title, the SEO description and keywords and the social account names.  Credentials are refused.  Always needs sfvb_publish, because every theme reads the same attributes and there is no dormant copy to change instead.  The admin General screen saves the whole storefront, so a merchant with it open can still overwrite a change made here.
      * Change a storefront\'s site attributes

package/dist/apis/SfvbApi.js

@@ -2766,6 +2766,65 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Whether real shoppers\' sessions on this storefront are being recorded, what recording costs per 1,000 sessions after the 14 day free trial, how long recordings are kept, and how many sessions were recorded in the current and last billing periods.  Recording only collects from the moment it is turned on, so when it is on but was turned on recently, check the analytics warehouse for rows before reporting that there is no data.
+     * Get the storefront\'s screen recording settings
+     */
+    SfvbApi.prototype.getSfvbRecordingSettingsRaw = 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 getSfvbRecordingSettings.');
+                        }
+                        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}/recording_settings".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.SfvbRecordingSettingsResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Whether real shoppers\' sessions on this storefront are being recorded, what recording costs per 1,000 sessions after the 14 day free trial, how long recordings are kept, and how many sessions were recorded in the current and last billing periods.  Recording only collects from the moment it is turned on, so when it is on but was turned on recently, check the analytics warehouse for rows before reporting that there is no data.
+     * Get the storefront\'s screen recording settings
+     */
+    SfvbApi.prototype.getSfvbRecordingSettings = 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.getSfvbRecordingSettingsRaw(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
@@ -5573,6 +5632,70 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * 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.
+     * Turn the storefront\'s screen recording on or off
+     */
+    SfvbApi.prototype.putSfvbRecordingSettingsRaw = 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 putSfvbRecordingSettings.');
+                        }
+                        if (requestParameters.recordingSettingsRequest === null || requestParameters.recordingSettingsRequest === undefined) {
+                            throw new runtime.RequiredError('recordingSettingsRequest', 'Required parameter requestParameters.recordingSettingsRequest was null or undefined when calling putSfvbRecordingSettings.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
+                        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}/recording_settings".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
+                                method: 'PUT',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.SfvbRecordingSettingsRequestToJSON)(requestParameters.recordingSettingsRequest),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbRecordingSettingsResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * 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.
+     * Turn the storefront\'s screen recording on or off
+     */
+    SfvbApi.prototype.putSfvbRecordingSettings = 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.putSfvbRecordingSettingsRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * A partial update.  Only the attributes you name are changed.  Every entry is checked before any is written.  List, video list, mailing list and item set attributes are refused, and so are the General screen settings other than the title, the SEO description and keywords and the social account names.  Credentials are refused.  Always needs sfvb_publish, because every theme reads the same attributes and there is no dormant copy to change instead.  The admin General screen saves the whole storefront, so a merchant with it open can still overwrite a change made here.
      * Change a storefront\'s site attributes

package/dist/models/SfvbRecordingSettings.d.ts

@@ -0,0 +1,79 @@
+/**
+ * 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 SfvbRecordingSettings
+ */
+export interface SfvbRecordingSettings {
+    /**
+     * What 1,000 recorded sessions cost after the trial, in US dollars.
+     * @type {number}
+     * @memberof SfvbRecordingSettings
+     */
+    cost_per_thousand?: number;
+    /**
+     * True when real shoppers' sessions on this storefront are being recorded.
+     * @type {boolean}
+     * @memberof SfvbRecordingSettings
+     */
+    enabled?: boolean;
+    /**
+     * How long recordings are kept, such as 1 year.
+     * @type {string}
+     * @memberof SfvbRecordingSettings
+     */
+    retention_interval?: string;
+    /**
+     * Sessions recorded so far in the current billing period.
+     * @type {number}
+     * @memberof SfvbRecordingSettings
+     */
+    sessions_current_billing_period?: number;
+    /**
+     * Sessions recorded in the previous billing period.
+     * @type {number}
+     * @memberof SfvbRecordingSettings
+     */
+    sessions_last_billing_period?: number;
+    /**
+     * Sessions recorded during the free trial.
+     * @type {number}
+     * @memberof SfvbRecordingSettings
+     */
+    sessions_trial_billing_period?: number;
+    /**
+     * When the free trial ends, as an ISO-8601 time.  Absent until the trial has started.
+     * @type {string}
+     * @memberof SfvbRecordingSettings
+     */
+    trial_expiration?: string;
+    /**
+     * True when the free trial is over and recorded sessions are billed.
+     * @type {boolean}
+     * @memberof SfvbRecordingSettings
+     */
+    trial_expired?: boolean;
+    /**
+     * True once recording has been turned on at least once, which starts a 14 day free trial.
+     * @type {boolean}
+     * @memberof SfvbRecordingSettings
+     */
+    trial_started?: boolean;
+}
+/**
+ * Check if a given object implements the SfvbRecordingSettings interface.
+ */
+export declare function instanceOfSfvbRecordingSettings(value: object): boolean;
+export declare function SfvbRecordingSettingsFromJSON(json: any): SfvbRecordingSettings;
+export declare function SfvbRecordingSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbRecordingSettings;
+export declare function SfvbRecordingSettingsToJSON(value?: SfvbRecordingSettings | null): any;

package/dist/models/SfvbRecordingSettings.js

@@ -0,0 +1,66 @@
+"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.SfvbRecordingSettingsToJSON = exports.SfvbRecordingSettingsFromJSONTyped = exports.SfvbRecordingSettingsFromJSON = exports.instanceOfSfvbRecordingSettings = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the SfvbRecordingSettings interface.
+ */
+function instanceOfSfvbRecordingSettings(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbRecordingSettings = instanceOfSfvbRecordingSettings;
+function SfvbRecordingSettingsFromJSON(json) {
+    return SfvbRecordingSettingsFromJSONTyped(json, false);
+}
+exports.SfvbRecordingSettingsFromJSON = SfvbRecordingSettingsFromJSON;
+function SfvbRecordingSettingsFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'cost_per_thousand': !(0, runtime_1.exists)(json, 'cost_per_thousand') ? undefined : json['cost_per_thousand'],
+        'enabled': !(0, runtime_1.exists)(json, 'enabled') ? undefined : json['enabled'],
+        'retention_interval': !(0, runtime_1.exists)(json, 'retention_interval') ? undefined : json['retention_interval'],
+        'sessions_current_billing_period': !(0, runtime_1.exists)(json, 'sessions_current_billing_period') ? undefined : json['sessions_current_billing_period'],
+        'sessions_last_billing_period': !(0, runtime_1.exists)(json, 'sessions_last_billing_period') ? undefined : json['sessions_last_billing_period'],
+        'sessions_trial_billing_period': !(0, runtime_1.exists)(json, 'sessions_trial_billing_period') ? undefined : json['sessions_trial_billing_period'],
+        'trial_expiration': !(0, runtime_1.exists)(json, 'trial_expiration') ? undefined : json['trial_expiration'],
+        'trial_expired': !(0, runtime_1.exists)(json, 'trial_expired') ? undefined : json['trial_expired'],
+        'trial_started': !(0, runtime_1.exists)(json, 'trial_started') ? undefined : json['trial_started'],
+    };
+}
+exports.SfvbRecordingSettingsFromJSONTyped = SfvbRecordingSettingsFromJSONTyped;
+function SfvbRecordingSettingsToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'cost_per_thousand': value.cost_per_thousand,
+        'enabled': value.enabled,
+        'retention_interval': value.retention_interval,
+        'sessions_current_billing_period': value.sessions_current_billing_period,
+        'sessions_last_billing_period': value.sessions_last_billing_period,
+        'sessions_trial_billing_period': value.sessions_trial_billing_period,
+        'trial_expiration': value.trial_expiration,
+        'trial_expired': value.trial_expired,
+        'trial_started': value.trial_started,
+    };
+}
+exports.SfvbRecordingSettingsToJSON = SfvbRecordingSettingsToJSON;

package/dist/models/SfvbRecordingSettingsRequest.d.ts

@@ -0,0 +1,31 @@
+/**
+ * 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 SfvbRecordingSettingsRequest
+ */
+export interface SfvbRecordingSettingsRequest {
+    /**
+     * True to record real shoppers' sessions, false to stop.
+     * @type {boolean}
+     * @memberof SfvbRecordingSettingsRequest
+     */
+    enabled?: boolean;
+}
+/**
+ * Check if a given object implements the SfvbRecordingSettingsRequest interface.
+ */
+export declare function instanceOfSfvbRecordingSettingsRequest(value: object): boolean;
+export declare function SfvbRecordingSettingsRequestFromJSON(json: any): SfvbRecordingSettingsRequest;
+export declare function SfvbRecordingSettingsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbRecordingSettingsRequest;
+export declare function SfvbRecordingSettingsRequestToJSON(value?: SfvbRecordingSettingsRequest | null): any;

package/dist/models/SfvbRecordingSettingsRequest.js

@@ -0,0 +1,50 @@
+"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.SfvbRecordingSettingsRequestToJSON = exports.SfvbRecordingSettingsRequestFromJSONTyped = exports.SfvbRecordingSettingsRequestFromJSON = exports.instanceOfSfvbRecordingSettingsRequest = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the SfvbRecordingSettingsRequest interface.
+ */
+function instanceOfSfvbRecordingSettingsRequest(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbRecordingSettingsRequest = instanceOfSfvbRecordingSettingsRequest;
+function SfvbRecordingSettingsRequestFromJSON(json) {
+    return SfvbRecordingSettingsRequestFromJSONTyped(json, false);
+}
+exports.SfvbRecordingSettingsRequestFromJSON = SfvbRecordingSettingsRequestFromJSON;
+function SfvbRecordingSettingsRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'enabled': !(0, runtime_1.exists)(json, 'enabled') ? undefined : json['enabled'],
+    };
+}
+exports.SfvbRecordingSettingsRequestFromJSONTyped = SfvbRecordingSettingsRequestFromJSONTyped;
+function SfvbRecordingSettingsRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'enabled': value.enabled,
+    };
+}
+exports.SfvbRecordingSettingsRequestToJSON = SfvbRecordingSettingsRequestToJSON;

package/dist/models/SfvbRecordingSettingsResponse.d.ts

@@ -0,0 +1,38 @@
+/**
+ * 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 { SfvbRecordingSettings } from './SfvbRecordingSettings';
+/**
+ *
+ * @export
+ * @interface SfvbRecordingSettingsResponse
+ */
+export interface SfvbRecordingSettingsResponse {
+    /**
+     * On a change only.  False when recording was already in the requested state, so nothing was saved.
+     * @type {boolean}
+     * @memberof SfvbRecordingSettingsResponse
+     */
+    changed?: boolean;
+    /**
+     *
+     * @type {SfvbRecordingSettings}
+     * @memberof SfvbRecordingSettingsResponse
+     */
+    settings?: SfvbRecordingSettings;
+}
+/**
+ * Check if a given object implements the SfvbRecordingSettingsResponse interface.
+ */
+export declare function instanceOfSfvbRecordingSettingsResponse(value: object): boolean;
+export declare function SfvbRecordingSettingsResponseFromJSON(json: any): SfvbRecordingSettingsResponse;
+export declare function SfvbRecordingSettingsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbRecordingSettingsResponse;
+export declare function SfvbRecordingSettingsResponseToJSON(value?: SfvbRecordingSettingsResponse | null): any;

package/dist/models/SfvbRecordingSettingsResponse.js

@@ -0,0 +1,53 @@
+"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.SfvbRecordingSettingsResponseToJSON = exports.SfvbRecordingSettingsResponseFromJSONTyped = exports.SfvbRecordingSettingsResponseFromJSON = exports.instanceOfSfvbRecordingSettingsResponse = void 0;
+var runtime_1 = require("../runtime");
+var SfvbRecordingSettings_1 = require("./SfvbRecordingSettings");
+/**
+ * Check if a given object implements the SfvbRecordingSettingsResponse interface.
+ */
+function instanceOfSfvbRecordingSettingsResponse(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbRecordingSettingsResponse = instanceOfSfvbRecordingSettingsResponse;
+function SfvbRecordingSettingsResponseFromJSON(json) {
+    return SfvbRecordingSettingsResponseFromJSONTyped(json, false);
+}
+exports.SfvbRecordingSettingsResponseFromJSON = SfvbRecordingSettingsResponseFromJSON;
+function SfvbRecordingSettingsResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'changed': !(0, runtime_1.exists)(json, 'changed') ? undefined : json['changed'],
+        'settings': !(0, runtime_1.exists)(json, 'settings') ? undefined : (0, SfvbRecordingSettings_1.SfvbRecordingSettingsFromJSON)(json['settings']),
+    };
+}
+exports.SfvbRecordingSettingsResponseFromJSONTyped = SfvbRecordingSettingsResponseFromJSONTyped;
+function SfvbRecordingSettingsResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'changed': value.changed,
+        'settings': (0, SfvbRecordingSettings_1.SfvbRecordingSettingsToJSON)(value.settings),
+    };
+}
+exports.SfvbRecordingSettingsResponseToJSON = SfvbRecordingSettingsResponseToJSON;

package/dist/models/index.d.ts

@@ -1053,6 +1053,9 @@ export * from './SfvbRecordingEventsResponse';
 export * from './SfvbRecordingPageView';
 export * from './SfvbRecordingParameter';
 export * from './SfvbRecordingResponse';
+export * from './SfvbRecordingSettings';
+export * from './SfvbRecordingSettingsRequest';
+export * from './SfvbRecordingSettingsResponse';
 export * from './SfvbRenderRequest';
 export * from './SfvbRenderResponse';
 export * from './SfvbServerLog';

package/dist/models/index.js

@@ -1071,6 +1071,9 @@ __exportStar(require("./SfvbRecordingEventsResponse"), exports);
 __exportStar(require("./SfvbRecordingPageView"), exports);
 __exportStar(require("./SfvbRecordingParameter"), exports);
 __exportStar(require("./SfvbRecordingResponse"), exports);
+__exportStar(require("./SfvbRecordingSettings"), exports);
+__exportStar(require("./SfvbRecordingSettingsRequest"), exports);
+__exportStar(require("./SfvbRecordingSettingsResponse"), exports);
 __exportStar(require("./SfvbRenderRequest"), exports);
 __exportStar(require("./SfvbRenderResponse"), exports);
 __exportStar(require("./SfvbServerLog"), exports);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "ultracart_rest_api_v2_typescript",
-  "version": "4.1.180",
+  "version": "4.1.181",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "repository": {

package/src/apis/SfvbApi.ts

@@ -204,6 +204,12 @@ import {
     SfvbRecordingResponse,
     SfvbRecordingResponseFromJSON,
     SfvbRecordingResponseToJSON,
+    SfvbRecordingSettingsRequest,
+    SfvbRecordingSettingsRequestFromJSON,
+    SfvbRecordingSettingsRequestToJSON,
+    SfvbRecordingSettingsResponse,
+    SfvbRecordingSettingsResponseFromJSON,
+    SfvbRecordingSettingsResponseToJSON,
     SfvbRenderRequest,
     SfvbRenderRequestFromJSON,
     SfvbRenderRequestToJSON,
@@ -516,6 +522,10 @@ export interface GetSfvbRecordingPageViewEventsRequest {
     screenRecordingPageViewUuid: string;
 }
 
+export interface GetSfvbRecordingSettingsRequest {
+    storefrontOid: number;
+}
+
 export interface GetSfvbServerLogRequest {
     storefrontOid: number;
     logId: string;
@@ -765,6 +775,11 @@ export interface PutSfvbPreviewSessionRequest {
     themeOid?: number;
 }
 
+export interface PutSfvbRecordingSettingsRequest {
+    storefrontOid: number;
+    recordingSettingsRequest: SfvbRecordingSettingsRequest;
+}
+
 export interface PutSfvbSiteAttributesRequest {
     storefrontOid: number;
     siteAttributeUpdateRequest: SfvbSiteAttributeUpdateRequest;
@@ -1623,6 +1638,22 @@ export interface SfvbApiInterface {
      */
     getSfvbRecordingPageViewEvents(requestParameters: GetSfvbRecordingPageViewEventsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingEventsResponse>;
 
+    /**
+     * Whether real shoppers\' sessions on this storefront are being recorded, what recording costs per 1,000 sessions after the 14 day free trial, how long recordings are kept, and how many sessions were recorded in the current and last billing periods.  Recording only collects from the moment it is turned on, so when it is on but was turned on recently, check the analytics warehouse for rows before reporting that there is no data. 
+     * @summary Get the storefront\'s screen recording settings
+     * @param {number} storefrontOid 
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    getSfvbRecordingSettingsRaw(requestParameters: GetSfvbRecordingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRecordingSettingsResponse>>;
+
+    /**
+     * Whether real shoppers\' sessions on this storefront are being recorded, what recording costs per 1,000 sessions after the 14 day free trial, how long recordings are kept, and how many sessions were recorded in the current and last billing periods.  Recording only collects from the moment it is turned on, so when it is on but was turned on recently, check the analytics warehouse for rows before reporting that there is no data. 
+     * Get the storefront\'s screen recording settings
+     */
+    getSfvbRecordingSettings(requestParameters: GetSfvbRecordingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingSettingsResponse>;
+
     /**
      * 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
@@ -2386,6 +2417,23 @@ export interface SfvbApiInterface {
      */
     putSfvbPreviewSession(requestParameters: PutSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
 
+    /**
+     * 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. 
+     * @summary Turn the storefront\'s screen recording on or off
+     * @param {number} storefrontOid 
+     * @param {SfvbRecordingSettingsRequest} recordingSettingsRequest Whether to record
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    putSfvbRecordingSettingsRaw(requestParameters: PutSfvbRecordingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRecordingSettingsResponse>>;
+
+    /**
+     * 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. 
+     * Turn the storefront\'s screen recording on or off
+     */
+    putSfvbRecordingSettings(requestParameters: PutSfvbRecordingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingSettingsResponse>;
+
     /**
      * A partial update.  Only the attributes you name are changed.  Every entry is checked before any is written.  List, video list, mailing list and item set attributes are refused, and so are the General screen settings other than the title, the SEO description and keywords and the social account names.  Credentials are refused.  Always needs sfvb_publish, because every theme reads the same attributes and there is no dormant copy to change instead.  The admin General screen saves the whole storefront, so a merchant with it open can still overwrite a change made here. 
      * @summary Change a storefront\'s site attributes
@@ -4769,6 +4817,47 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
         return await response.value();
     }
 
+    /**
+     * Whether real shoppers\' sessions on this storefront are being recorded, what recording costs per 1,000 sessions after the 14 day free trial, how long recordings are kept, and how many sessions were recorded in the current and last billing periods.  Recording only collects from the moment it is turned on, so when it is on but was turned on recently, check the analytics warehouse for rows before reporting that there is no data. 
+     * Get the storefront\'s screen recording settings
+     */
+    async getSfvbRecordingSettingsRaw(requestParameters: GetSfvbRecordingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRecordingSettingsResponse>> {
+        if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+            throw new runtime.RequiredError('storefrontOid','Required parameter requestParameters.storefrontOid was null or undefined when calling getSfvbRecordingSettings.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", []);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const response = await this.request({
+            path: `/sfvb/storefronts/{storefront_oid}/recording_settings`.replace(`{${"storefront_oid"}}`, encodeURIComponent(String(requestParameters.storefrontOid))),
+            method: 'GET',
+            headers: headerParameters,
+            query: queryParameters,
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SfvbRecordingSettingsResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Whether real shoppers\' sessions on this storefront are being recorded, what recording costs per 1,000 sessions after the 14 day free trial, how long recordings are kept, and how many sessions were recorded in the current and last billing periods.  Recording only collects from the moment it is turned on, so when it is on but was turned on recently, check the analytics warehouse for rows before reporting that there is no data. 
+     * Get the storefront\'s screen recording settings
+     */
+    async getSfvbRecordingSettings(requestParameters: GetSfvbRecordingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingSettingsResponse> {
+        const response = await this.getSfvbRecordingSettingsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * 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
@@ -6937,6 +7026,54 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
         return await response.value();
     }
 
+    /**
+     * 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. 
+     * Turn the storefront\'s screen recording on or off
+     */
+    async putSfvbRecordingSettingsRaw(requestParameters: PutSfvbRecordingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbRecordingSettingsResponse>> {
+        if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+            throw new runtime.RequiredError('storefrontOid','Required parameter requestParameters.storefrontOid was null or undefined when calling putSfvbRecordingSettings.');
+        }
+
+        if (requestParameters.recordingSettingsRequest === null || requestParameters.recordingSettingsRequest === undefined) {
+            throw new runtime.RequiredError('recordingSettingsRequest','Required parameter requestParameters.recordingSettingsRequest was null or undefined when calling putSfvbRecordingSettings.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json; charset=UTF-8';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", []);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const response = await this.request({
+            path: `/sfvb/storefronts/{storefront_oid}/recording_settings`.replace(`{${"storefront_oid"}}`, encodeURIComponent(String(requestParameters.storefrontOid))),
+            method: 'PUT',
+            headers: headerParameters,
+            query: queryParameters,
+            body: SfvbRecordingSettingsRequestToJSON(requestParameters.recordingSettingsRequest),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SfvbRecordingSettingsResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * 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. 
+     * Turn the storefront\'s screen recording on or off
+     */
+    async putSfvbRecordingSettings(requestParameters: PutSfvbRecordingSettingsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbRecordingSettingsResponse> {
+        const response = await this.putSfvbRecordingSettingsRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * A partial update.  Only the attributes you name are changed.  Every entry is checked before any is written.  List, video list, mailing list and item set attributes are refused, and so are the General screen settings other than the title, the SEO description and keywords and the social account names.  Credentials are refused.  Always needs sfvb_publish, because every theme reads the same attributes and there is no dormant copy to change instead.  The admin General screen saves the whole storefront, so a merchant with it open can still overwrite a change made here. 
      * Change a storefront\'s site attributes

package/src/models/SfvbRecordingSettings.ts

@@ -0,0 +1,131 @@
+/* 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.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface SfvbRecordingSettings
+ */
+export interface SfvbRecordingSettings {
+    /**
+     * What 1,000 recorded sessions cost after the trial, in US dollars.
+     * @type {number}
+     * @memberof SfvbRecordingSettings
+     */
+    cost_per_thousand?: number;
+    /**
+     * True when real shoppers' sessions on this storefront are being recorded.
+     * @type {boolean}
+     * @memberof SfvbRecordingSettings
+     */
+    enabled?: boolean;
+    /**
+     * How long recordings are kept, such as 1 year.
+     * @type {string}
+     * @memberof SfvbRecordingSettings
+     */
+    retention_interval?: string;
+    /**
+     * Sessions recorded so far in the current billing period.
+     * @type {number}
+     * @memberof SfvbRecordingSettings
+     */
+    sessions_current_billing_period?: number;
+    /**
+     * Sessions recorded in the previous billing period.
+     * @type {number}
+     * @memberof SfvbRecordingSettings
+     */
+    sessions_last_billing_period?: number;
+    /**
+     * Sessions recorded during the free trial.
+     * @type {number}
+     * @memberof SfvbRecordingSettings
+     */
+    sessions_trial_billing_period?: number;
+    /**
+     * When the free trial ends, as an ISO-8601 time.  Absent until the trial has started.
+     * @type {string}
+     * @memberof SfvbRecordingSettings
+     */
+    trial_expiration?: string;
+    /**
+     * True when the free trial is over and recorded sessions are billed.
+     * @type {boolean}
+     * @memberof SfvbRecordingSettings
+     */
+    trial_expired?: boolean;
+    /**
+     * True once recording has been turned on at least once, which starts a 14 day free trial.
+     * @type {boolean}
+     * @memberof SfvbRecordingSettings
+     */
+    trial_started?: boolean;
+}
+
+
+
+/**
+ * Check if a given object implements the SfvbRecordingSettings interface.
+ */
+export function instanceOfSfvbRecordingSettings(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function SfvbRecordingSettingsFromJSON(json: any): SfvbRecordingSettings {
+    return SfvbRecordingSettingsFromJSONTyped(json, false);
+}
+
+export function SfvbRecordingSettingsFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbRecordingSettings {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'cost_per_thousand': !exists(json, 'cost_per_thousand') ? undefined : json['cost_per_thousand'],
+        'enabled': !exists(json, 'enabled') ? undefined : json['enabled'],
+        'retention_interval': !exists(json, 'retention_interval') ? undefined : json['retention_interval'],
+        'sessions_current_billing_period': !exists(json, 'sessions_current_billing_period') ? undefined : json['sessions_current_billing_period'],
+        'sessions_last_billing_period': !exists(json, 'sessions_last_billing_period') ? undefined : json['sessions_last_billing_period'],
+        'sessions_trial_billing_period': !exists(json, 'sessions_trial_billing_period') ? undefined : json['sessions_trial_billing_period'],
+        'trial_expiration': !exists(json, 'trial_expiration') ? undefined : json['trial_expiration'],
+        'trial_expired': !exists(json, 'trial_expired') ? undefined : json['trial_expired'],
+        'trial_started': !exists(json, 'trial_started') ? undefined : json['trial_started'],
+    };
+}
+
+export function SfvbRecordingSettingsToJSON(value?: SfvbRecordingSettings | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'cost_per_thousand': value.cost_per_thousand,
+        'enabled': value.enabled,
+        'retention_interval': value.retention_interval,
+        'sessions_current_billing_period': value.sessions_current_billing_period,
+        'sessions_last_billing_period': value.sessions_last_billing_period,
+        'sessions_trial_billing_period': value.sessions_trial_billing_period,
+        'trial_expiration': value.trial_expiration,
+        'trial_expired': value.trial_expired,
+        'trial_started': value.trial_started,
+    };
+}
+

package/src/models/SfvbRecordingSettingsRequest.ts

@@ -0,0 +1,67 @@
+/* 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.
+ */
+
+import { exists, mapValues } from '../runtime';
+/**
+ * 
+ * @export
+ * @interface SfvbRecordingSettingsRequest
+ */
+export interface SfvbRecordingSettingsRequest {
+    /**
+     * True to record real shoppers' sessions, false to stop.
+     * @type {boolean}
+     * @memberof SfvbRecordingSettingsRequest
+     */
+    enabled?: boolean;
+}
+
+
+
+/**
+ * Check if a given object implements the SfvbRecordingSettingsRequest interface.
+ */
+export function instanceOfSfvbRecordingSettingsRequest(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function SfvbRecordingSettingsRequestFromJSON(json: any): SfvbRecordingSettingsRequest {
+    return SfvbRecordingSettingsRequestFromJSONTyped(json, false);
+}
+
+export function SfvbRecordingSettingsRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbRecordingSettingsRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'enabled': !exists(json, 'enabled') ? undefined : json['enabled'],
+    };
+}
+
+export function SfvbRecordingSettingsRequestToJSON(value?: SfvbRecordingSettingsRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'enabled': value.enabled,
+    };
+}
+

package/src/models/SfvbRecordingSettingsResponse.ts

@@ -0,0 +1,82 @@
+/* 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.
+ */
+
+import { exists, mapValues } from '../runtime';
+import {
+    SfvbRecordingSettings,
+    SfvbRecordingSettingsFromJSON,
+    SfvbRecordingSettingsFromJSONTyped,
+    SfvbRecordingSettingsToJSON,
+} from './SfvbRecordingSettings';
+
+/**
+ * 
+ * @export
+ * @interface SfvbRecordingSettingsResponse
+ */
+export interface SfvbRecordingSettingsResponse {
+    /**
+     * On a change only.  False when recording was already in the requested state, so nothing was saved.
+     * @type {boolean}
+     * @memberof SfvbRecordingSettingsResponse
+     */
+    changed?: boolean;
+    /**
+     * 
+     * @type {SfvbRecordingSettings}
+     * @memberof SfvbRecordingSettingsResponse
+     */
+    settings?: SfvbRecordingSettings;
+}
+
+
+
+/**
+ * Check if a given object implements the SfvbRecordingSettingsResponse interface.
+ */
+export function instanceOfSfvbRecordingSettingsResponse(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function SfvbRecordingSettingsResponseFromJSON(json: any): SfvbRecordingSettingsResponse {
+    return SfvbRecordingSettingsResponseFromJSONTyped(json, false);
+}
+
+export function SfvbRecordingSettingsResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbRecordingSettingsResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'changed': !exists(json, 'changed') ? undefined : json['changed'],
+        'settings': !exists(json, 'settings') ? undefined : SfvbRecordingSettingsFromJSON(json['settings']),
+    };
+}
+
+export function SfvbRecordingSettingsResponseToJSON(value?: SfvbRecordingSettingsResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'changed': value.changed,
+        'settings': SfvbRecordingSettingsToJSON(value.settings),
+    };
+}
+

package/src/models/index.ts

@@ -1055,6 +1055,9 @@ export * from './SfvbRecordingEventsResponse';
 export * from './SfvbRecordingPageView';
 export * from './SfvbRecordingParameter';
 export * from './SfvbRecordingResponse';
+export * from './SfvbRecordingSettings';
+export * from './SfvbRecordingSettingsRequest';
+export * from './SfvbRecordingSettingsResponse';
 export * from './SfvbRenderRequest';
 export * from './SfvbRenderResponse';
 export * from './SfvbServerLog';