ultracart_rest_api_v2_typescript 4.1.153 → 4.1.155

package/.openapi-generator/FILES

@@ -1021,6 +1021,8 @@ src/models/SfvbPageAttributeUpdateRequest.ts
 src/models/SfvbPageMultimedia.ts
 src/models/SfvbPageMultimediaRequest.ts
 src/models/SfvbPageResponse.ts
+src/models/SfvbPreviewAccessRequest.ts
+src/models/SfvbPreviewAccessResponse.ts
 src/models/SfvbPreviewSessionRequest.ts
 src/models/SfvbPreviewSessionResponse.ts
 src/models/SfvbPreviewUrlResponse.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.153
+## ultracart_rest_api_v2_typescript@4.1.155
 
 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.153 --save
+npm install ultracart_rest_api_v2_typescript@4.1.155 --save
 ```
 
 ```typescript
@@ -85,6 +85,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.155 | 09/15/2026 | sfvb internal testing |
+| 4.1.154 | 09/14/2026 | sfvb internal testing |
 | 4.1.153 | 09/14/2026 | sfvb internal testing |
 | 4.1.152 | 09/09/2026 | sfvb - internal testing |
 | 4.1.151 | 09/04/2026 | conversations - added ai agent capabilities |

package/dist/apis/SfvbApi.d.ts

@@ -10,10 +10,14 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbLibraryEntry, SfvbLibraryResponse, SfvbPageAttributeUpdateRequest, SfvbPageMultimediaRequest, SfvbPageResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbStorefrontsResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffersResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
+import { SfvbCompileRequest, SfvbCompileResponse, SfvbContainerResponse, SfvbContainerRevertRequest, SfvbContainerVersion, SfvbContainerVersionsResponse, SfvbContainerWriteRequest, SfvbElementSchemaResponse, SfvbElementsResponse, SfvbFileContentResponse, SfvbFileRevertRequest, SfvbFileSearchRequest, SfvbFileSearchResponse, SfvbFileUploadRequest, SfvbFileUploadUrlResponse, SfvbFileVersionsResponse, SfvbFileWriteRequest, SfvbFileWriteResponse, SfvbFilesResponse, SfvbLibraryEntry, SfvbLibraryResponse, SfvbPageAttributeUpdateRequest, SfvbPageMultimediaRequest, SfvbPageResponse, SfvbPreviewAccessRequest, SfvbPreviewAccessResponse, SfvbPreviewSessionRequest, SfvbPreviewSessionResponse, SfvbPreviewUrlResponse, SfvbRenderRequest, SfvbRenderResponse, SfvbStorefrontsResponse, SfvbTheme, SfvbThemeAttributeUpdateRequest, SfvbThemeAttributesResponse, SfvbThemeDuplicateRequest, SfvbThemeJobResponse, SfvbThemesResponse, SfvbUpsellOffersResponse, SfvbValidateRequest, SfvbValidationResponse, SfvbVelocityValidateRequest, SfvbVersionResponse, SfvbWhoamiResponse, SfvbWidgetIdsResponse } from '../models';
 export interface CompileSfvbCjsonRequest {
     compileRequest: SfvbCompileRequest;
 }
+export interface CreateSfvbPreviewAccessRequest {
+    storefrontOid: number;
+    previewAccess?: SfvbPreviewAccessRequest;
+}
 export interface CreateSfvbPreviewSessionRequest {
     storefrontOid: number;
 }
@@ -223,6 +227,21 @@ export interface SfvbApiInterface {
      * Compile CJSON to Velocity
      */
     compileSfvbCjson(requestParameters: CompileSfvbCjsonRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCompileResponse>;
+    /**
+     * The preview URL only works in a browser already signed in to UltraCart on the storefront\'s own host, and an agent\'s built in browser never is.  This returns a single use access_url on the storefront host instead.  Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path.  It expires two minutes after issue or on first use.  Pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied.  Requires a token that resolves to a user, so use the device authorization flow.
+     * @summary One time link that opens a preview in a browser with no UltraCart login
+     * @param {number} storefrontOid
+     * @param {SfvbPreviewAccessRequest} [previewAccess] What the browser should see
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    createSfvbPreviewAccessRaw(requestParameters: CreateSfvbPreviewAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPreviewAccessResponse>>;
+    /**
+     * The preview URL only works in a browser already signed in to UltraCart on the storefront\'s own host, and an agent\'s built in browser never is.  This returns a single use access_url on the storefront host instead.  Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path.  It expires two minutes after issue or on first use.  Pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied.  Requires a token that resolves to a user, so use the device authorization flow.
+     * One time link that opens a preview in a browser with no UltraCart login
+     */
+    createSfvbPreviewAccess(requestParameters: CreateSfvbPreviewAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewAccessResponse>;
     /**
      * Returns a server generated session id to push containers into, and opens the session so that id exists rather than merely being random.  The id is not caller supplied, because concurrent agents choosing their own would be free to collide, and the browser editor\'s habit of minting one with Math.random is not a property worth carrying into an API.  Expires after eight hours and can be deleted sooner.  Requires a token that resolves to a user, so use the device authorization flow.
      * @summary Create a preview session
@@ -365,8 +384,8 @@ export interface SfvbApiInterface {
      */
     getSfvbContainerVersion(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersion>;
     /**
-     *
-     * @summary Configuration schema for one element type
+     * schema is the draft-07 JSON schema for the element config object and doc is the markdown field card, both as strings.  Either is omitted when none has been published for the element, which is still a 200.  The catalog is published by the visual builder release process, and a republish can take up to an hour to appear here.
+     * @summary Configuration schema and field card for one element type
      * @param {string} elementType
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -374,7 +393,8 @@ export interface SfvbApiInterface {
      */
     getSfvbElementRaw(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbElementSchemaResponse>>;
     /**
-     * Configuration schema for one element type
+     * schema is the draft-07 JSON schema for the element config object and doc is the markdown field card, both as strings.  Either is omitted when none has been published for the element, which is still a 200.  The catalog is published by the visual builder release process, and a republish can take up to an hour to appear here.
+     * Configuration schema and field card for one element type
      */
     getSfvbElement(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementSchemaResponse>;
     /**
@@ -902,6 +922,16 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      * Compile CJSON to Velocity
      */
     compileSfvbCjson(requestParameters: CompileSfvbCjsonRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCompileResponse>;
+    /**
+     * The preview URL only works in a browser already signed in to UltraCart on the storefront\'s own host, and an agent\'s built in browser never is.  This returns a single use access_url on the storefront host instead.  Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path.  It expires two minutes after issue or on first use.  Pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied.  Requires a token that resolves to a user, so use the device authorization flow.
+     * One time link that opens a preview in a browser with no UltraCart login
+     */
+    createSfvbPreviewAccessRaw(requestParameters: CreateSfvbPreviewAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPreviewAccessResponse>>;
+    /**
+     * The preview URL only works in a browser already signed in to UltraCart on the storefront\'s own host, and an agent\'s built in browser never is.  This returns a single use access_url on the storefront host instead.  Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path.  It expires two minutes after issue or on first use.  Pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied.  Requires a token that resolves to a user, so use the device authorization flow.
+     * One time link that opens a preview in a browser with no UltraCart login
+     */
+    createSfvbPreviewAccess(requestParameters: CreateSfvbPreviewAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewAccessResponse>;
     /**
      * Returns a server generated session id to push containers into, and opens the session so that id exists rather than merely being random.  The id is not caller supplied, because concurrent agents choosing their own would be free to collide, and the browser editor\'s habit of minting one with Math.random is not a property worth carrying into an API.  Expires after eight hours and can be deleted sooner.  Requires a token that resolves to a user, so use the device authorization flow.
      * Create a preview session
@@ -991,11 +1021,13 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      */
     getSfvbContainerVersion(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersion>;
     /**
-     * Configuration schema for one element type
+     * schema is the draft-07 JSON schema for the element config object and doc is the markdown field card, both as strings.  Either is omitted when none has been published for the element, which is still a 200.  The catalog is published by the visual builder release process, and a republish can take up to an hour to appear here.
+     * Configuration schema and field card for one element type
      */
     getSfvbElementRaw(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbElementSchemaResponse>>;
     /**
-     * Configuration schema for one element type
+     * schema is the draft-07 JSON schema for the element config object and doc is the markdown field card, both as strings.  Either is omitted when none has been published for the element, which is still a 200.  The catalog is published by the visual builder release process, and a republish can take up to an hour to appear here.
+     * Configuration schema and field card for one element type
      */
     getSfvbElement(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementSchemaResponse>;
     /**

package/dist/apis/SfvbApi.js

@@ -136,6 +136,67 @@ var SfvbApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * The preview URL only works in a browser already signed in to UltraCart on the storefront\'s own host, and an agent\'s built in browser never is.  This returns a single use access_url on the storefront host instead.  Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path.  It expires two minutes after issue or on first use.  Pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied.  Requires a token that resolves to a user, so use the device authorization flow.
+     * One time link that opens a preview in a browser with no UltraCart login
+     */
+    SfvbApi.prototype.createSfvbPreviewAccessRaw = 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 createSfvbPreviewAccess.');
+                        }
+                        queryParameters = {};
+                        headerParameters = {};
+                        headerParameters['Content-Type'] = 'application/json';
+                        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}/preview_access".replace("{".concat("storefront_oid", "}"), encodeURIComponent(String(requestParameters.storefrontOid))),
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.SfvbPreviewAccessRequestToJSON)(requestParameters.previewAccess),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.SfvbPreviewAccessResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * The preview URL only works in a browser already signed in to UltraCart on the storefront\'s own host, and an agent\'s built in browser never is.  This returns a single use access_url on the storefront host instead.  Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path.  It expires two minutes after issue or on first use.  Pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied.  Requires a token that resolves to a user, so use the device authorization flow.
+     * One time link that opens a preview in a browser with no UltraCart login
+     */
+    SfvbApi.prototype.createSfvbPreviewAccess = 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.createSfvbPreviewAccessRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Returns a server generated session id to push containers into, and opens the session so that id exists rather than merely being random.  The id is not caller supplied, because concurrent agents choosing their own would be free to collide, and the browser editor\'s habit of minting one with Math.random is not a property worth carrying into an API.  Expires after eight hours and can be deleted sooner.  Requires a token that resolves to a user, so use the device authorization flow.
      * Create a preview session
@@ -718,7 +779,8 @@ var SfvbApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Configuration schema for one element type
+     * schema is the draft-07 JSON schema for the element config object and doc is the markdown field card, both as strings.  Either is omitted when none has been published for the element, which is still a 200.  The catalog is published by the visual builder release process, and a republish can take up to an hour to appear here.
+     * Configuration schema and field card for one element type
      */
     SfvbApi.prototype.getSfvbElementRaw = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {
@@ -758,7 +820,8 @@ var SfvbApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Configuration schema for one element type
+     * schema is the draft-07 JSON schema for the element config object and doc is the markdown field card, both as strings.  Either is omitted when none has been published for the element, which is still a 200.  The catalog is published by the visual builder release process, and a republish can take up to an hour to appear here.
+     * Configuration schema and field card for one element type
      */
     SfvbApi.prototype.getSfvbElement = function (requestParameters, initOverrides) {
         return __awaiter(this, void 0, void 0, function () {

package/dist/models/SfvbElement.d.ts

@@ -15,6 +15,12 @@
  * @interface SfvbElement
  */
 export interface SfvbElement {
+    /**
+     * True when a markdown field card for this element is available from elements/{element_type}.
+     * @type {boolean}
+     * @memberof SfvbElement
+     */
+    doc_available?: boolean;
     /**
      * True when a per element configuration schema is available from elements/{element_type}.
      * @type {boolean}

package/dist/models/SfvbElement.js

@@ -32,6 +32,7 @@ function SfvbElementFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
+        'doc_available': !(0, runtime_1.exists)(json, 'doc_available') ? undefined : json['doc_available'],
         'schema_available': !(0, runtime_1.exists)(json, 'schema_available') ? undefined : json['schema_available'],
         'type': !(0, runtime_1.exists)(json, 'type') ? undefined : json['type'],
     };
@@ -45,6 +46,7 @@ function SfvbElementToJSON(value) {
         return null;
     }
     return {
+        'doc_available': value.doc_available,
         'schema_available': value.schema_available,
         'type': value.type,
     };

package/dist/models/SfvbElementSchemaResponse.d.ts

@@ -16,7 +16,13 @@
  */
 export interface SfvbElementSchemaResponse {
     /**
-     * JSON schema for this element's config object, as a JSON string.  Null when no schema has been published for this element yet.
+     * Markdown field card for this element, as a string.  Omitted when no field card has been published for this element.
+     * @type {string}
+     * @memberof SfvbElementSchemaResponse
+     */
+    doc?: string;
+    /**
+     * Draft-07 JSON schema for this element's config object, as a JSON string.  Omitted when no schema has been published for this element.
      * @type {string}
      * @memberof SfvbElementSchemaResponse
      */

package/dist/models/SfvbElementSchemaResponse.js

@@ -32,6 +32,7 @@ function SfvbElementSchemaResponseFromJSONTyped(json, ignoreDiscriminator) {
         return json;
     }
     return {
+        'doc': !(0, runtime_1.exists)(json, 'doc') ? undefined : json['doc'],
         'schema': !(0, runtime_1.exists)(json, 'schema') ? undefined : json['schema'],
         'type': !(0, runtime_1.exists)(json, 'type') ? undefined : json['type'],
     };
@@ -45,6 +46,7 @@ function SfvbElementSchemaResponseToJSON(value) {
         return null;
     }
     return {
+        'doc': value.doc,
         'schema': value.schema,
         'type': value.type,
     };

package/dist/models/SfvbPreviewAccessRequest.d.ts

@@ -0,0 +1,43 @@
+/**
+ * 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 SfvbPreviewAccessRequest
+ */
+export interface SfvbPreviewAccessRequest {
+    /**
+     * Storefront path to land on, beginning with a slash.  Defaults to /
+     * @type {string}
+     * @memberof SfvbPreviewAccessRequest
+     */
+    path?: string;
+    /**
+     * Staged preview session to show.  It must be one this user created and it must not have expired.  Leave it out to show the saved containers with nothing staged.
+     * @type {string}
+     * @memberof SfvbPreviewAccessRequest
+     */
+    preview_session_id?: string;
+    /**
+     * Theme to show, which may be inactive.  Must belong to this storefront.  Defaults to the active theme.
+     * @type {number}
+     * @memberof SfvbPreviewAccessRequest
+     */
+    theme_oid?: number;
+}
+/**
+ * Check if a given object implements the SfvbPreviewAccessRequest interface.
+ */
+export declare function instanceOfSfvbPreviewAccessRequest(value: object): boolean;
+export declare function SfvbPreviewAccessRequestFromJSON(json: any): SfvbPreviewAccessRequest;
+export declare function SfvbPreviewAccessRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbPreviewAccessRequest;
+export declare function SfvbPreviewAccessRequestToJSON(value?: SfvbPreviewAccessRequest | null): any;

package/dist/models/SfvbPreviewAccessRequest.js

@@ -0,0 +1,54 @@
+"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.SfvbPreviewAccessRequestToJSON = exports.SfvbPreviewAccessRequestFromJSONTyped = exports.SfvbPreviewAccessRequestFromJSON = exports.instanceOfSfvbPreviewAccessRequest = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the SfvbPreviewAccessRequest interface.
+ */
+function instanceOfSfvbPreviewAccessRequest(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbPreviewAccessRequest = instanceOfSfvbPreviewAccessRequest;
+function SfvbPreviewAccessRequestFromJSON(json) {
+    return SfvbPreviewAccessRequestFromJSONTyped(json, false);
+}
+exports.SfvbPreviewAccessRequestFromJSON = SfvbPreviewAccessRequestFromJSON;
+function SfvbPreviewAccessRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'path': !(0, runtime_1.exists)(json, 'path') ? undefined : json['path'],
+        'preview_session_id': !(0, runtime_1.exists)(json, 'preview_session_id') ? undefined : json['preview_session_id'],
+        'theme_oid': !(0, runtime_1.exists)(json, 'theme_oid') ? undefined : json['theme_oid'],
+    };
+}
+exports.SfvbPreviewAccessRequestFromJSONTyped = SfvbPreviewAccessRequestFromJSONTyped;
+function SfvbPreviewAccessRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'path': value.path,
+        'preview_session_id': value.preview_session_id,
+        'theme_oid': value.theme_oid,
+    };
+}
+exports.SfvbPreviewAccessRequestToJSON = SfvbPreviewAccessRequestToJSON;

package/dist/models/SfvbPreviewAccessResponse.d.ts

@@ -0,0 +1,73 @@
+/**
+ * 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 SfvbPreviewAccessResponse
+ */
+export interface SfvbPreviewAccessResponse {
+    /**
+     * One time link on the storefront's own host.  Opening it in any browser, including an agent's built in browser with no UltraCart login, gets past the storefront lock and applies the preview session and theme for the rest of that browser's session, then redirects to path.  It is a credential until used, so do not paste it anywhere other than the browser that should open it.
+     * @type {string}
+     * @memberof SfvbPreviewAccessResponse
+     */
+    access_url?: string;
+    /**
+     * Seconds left to open access_url.  It stops working after that, and after its first use.
+     * @type {number}
+     * @memberof SfvbPreviewAccessResponse
+     */
+    expires_in_seconds?: number;
+    /**
+     * Storefront path the browser lands on, after reserved preview parameters are removed.
+     * @type {string}
+     * @memberof SfvbPreviewAccessResponse
+     */
+    path?: string;
+    /**
+     * The preview session applied, when one was requested.
+     * @type {string}
+     * @memberof SfvbPreviewAccessResponse
+     */
+    preview_session_id?: string;
+    /**
+     * How long the browser stays in preview once access_url is opened.  The remaining life of the preview session, or eight hours when none was given.  The user and their storefront permission are checked again on every page, so removing either ends it sooner.
+     * @type {number}
+     * @memberof SfvbPreviewAccessResponse
+     */
+    session_lifetime_seconds?: number;
+    /**
+     * Always true.  A second open of access_url returns 410.
+     * @type {boolean}
+     * @memberof SfvbPreviewAccessResponse
+     */
+    single_use?: boolean;
+    /**
+     * The theme shown, when one was requested.
+     * @type {number}
+     * @memberof SfvbPreviewAccessResponse
+     */
+    theme_oid?: number;
+    /**
+     * Plain language instructions, safe to show a user.
+     * @type {string}
+     * @memberof SfvbPreviewAccessResponse
+     */
+    usage_note?: string;
+}
+/**
+ * Check if a given object implements the SfvbPreviewAccessResponse interface.
+ */
+export declare function instanceOfSfvbPreviewAccessResponse(value: object): boolean;
+export declare function SfvbPreviewAccessResponseFromJSON(json: any): SfvbPreviewAccessResponse;
+export declare function SfvbPreviewAccessResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbPreviewAccessResponse;
+export declare function SfvbPreviewAccessResponseToJSON(value?: SfvbPreviewAccessResponse | null): any;

package/dist/models/SfvbPreviewAccessResponse.js

@@ -0,0 +1,64 @@
+"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.SfvbPreviewAccessResponseToJSON = exports.SfvbPreviewAccessResponseFromJSONTyped = exports.SfvbPreviewAccessResponseFromJSON = exports.instanceOfSfvbPreviewAccessResponse = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the SfvbPreviewAccessResponse interface.
+ */
+function instanceOfSfvbPreviewAccessResponse(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfSfvbPreviewAccessResponse = instanceOfSfvbPreviewAccessResponse;
+function SfvbPreviewAccessResponseFromJSON(json) {
+    return SfvbPreviewAccessResponseFromJSONTyped(json, false);
+}
+exports.SfvbPreviewAccessResponseFromJSON = SfvbPreviewAccessResponseFromJSON;
+function SfvbPreviewAccessResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'access_url': !(0, runtime_1.exists)(json, 'access_url') ? undefined : json['access_url'],
+        'expires_in_seconds': !(0, runtime_1.exists)(json, 'expires_in_seconds') ? undefined : json['expires_in_seconds'],
+        'path': !(0, runtime_1.exists)(json, 'path') ? undefined : json['path'],
+        'preview_session_id': !(0, runtime_1.exists)(json, 'preview_session_id') ? undefined : json['preview_session_id'],
+        'session_lifetime_seconds': !(0, runtime_1.exists)(json, 'session_lifetime_seconds') ? undefined : json['session_lifetime_seconds'],
+        'single_use': !(0, runtime_1.exists)(json, 'single_use') ? undefined : json['single_use'],
+        'theme_oid': !(0, runtime_1.exists)(json, 'theme_oid') ? undefined : json['theme_oid'],
+        'usage_note': !(0, runtime_1.exists)(json, 'usage_note') ? undefined : json['usage_note'],
+    };
+}
+exports.SfvbPreviewAccessResponseFromJSONTyped = SfvbPreviewAccessResponseFromJSONTyped;
+function SfvbPreviewAccessResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'access_url': value.access_url,
+        'expires_in_seconds': value.expires_in_seconds,
+        'path': value.path,
+        'preview_session_id': value.preview_session_id,
+        'session_lifetime_seconds': value.session_lifetime_seconds,
+        'single_use': value.single_use,
+        'theme_oid': value.theme_oid,
+        'usage_note': value.usage_note,
+    };
+}
+exports.SfvbPreviewAccessResponseToJSON = SfvbPreviewAccessResponseToJSON;

package/dist/models/SfvbThemeJobResponse.d.ts

@@ -28,7 +28,7 @@ export interface SfvbThemeJobResponse {
      */
     description?: string;
     /**
-     * Failure detail.  Populated only when status is error.
+     * What to do next when the job did not produce a theme.  The internal cause is not returned; it is recorded against the job id in the server log.
      * @type {string}
      * @memberof SfvbThemeJobResponse
      */

package/dist/models/index.d.ts

@@ -991,6 +991,8 @@ export * from './SfvbPageAttributeUpdateRequest';
 export * from './SfvbPageMultimedia';
 export * from './SfvbPageMultimediaRequest';
 export * from './SfvbPageResponse';
+export * from './SfvbPreviewAccessRequest';
+export * from './SfvbPreviewAccessResponse';
 export * from './SfvbPreviewSessionRequest';
 export * from './SfvbPreviewSessionResponse';
 export * from './SfvbPreviewUrlResponse';

package/dist/models/index.js

@@ -1009,6 +1009,8 @@ __exportStar(require("./SfvbPageAttributeUpdateRequest"), exports);
 __exportStar(require("./SfvbPageMultimedia"), exports);
 __exportStar(require("./SfvbPageMultimediaRequest"), exports);
 __exportStar(require("./SfvbPageResponse"), exports);
+__exportStar(require("./SfvbPreviewAccessRequest"), exports);
+__exportStar(require("./SfvbPreviewAccessResponse"), exports);
 __exportStar(require("./SfvbPreviewSessionRequest"), exports);
 __exportStar(require("./SfvbPreviewSessionResponse"), exports);
 __exportStar(require("./SfvbPreviewUrlResponse"), exports);

package/package.json

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

package/src/apis/SfvbApi.ts

@@ -90,6 +90,12 @@ import {
     SfvbPageResponse,
     SfvbPageResponseFromJSON,
     SfvbPageResponseToJSON,
+    SfvbPreviewAccessRequest,
+    SfvbPreviewAccessRequestFromJSON,
+    SfvbPreviewAccessRequestToJSON,
+    SfvbPreviewAccessResponse,
+    SfvbPreviewAccessResponseFromJSON,
+    SfvbPreviewAccessResponseToJSON,
     SfvbPreviewSessionRequest,
     SfvbPreviewSessionRequestFromJSON,
     SfvbPreviewSessionRequestToJSON,
@@ -153,6 +159,11 @@ export interface CompileSfvbCjsonRequest {
     compileRequest: SfvbCompileRequest;
 }
 
+export interface CreateSfvbPreviewAccessRequest {
+    storefrontOid: number;
+    previewAccess?: SfvbPreviewAccessRequest;
+}
+
 export interface CreateSfvbPreviewSessionRequest {
     storefrontOid: number;
 }
@@ -403,6 +414,23 @@ export interface SfvbApiInterface {
      */
     compileSfvbCjson(requestParameters: CompileSfvbCjsonRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCompileResponse>;
 
+    /**
+     * The preview URL only works in a browser already signed in to UltraCart on the storefront\'s own host, and an agent\'s built in browser never is.  This returns a single use access_url on the storefront host instead.  Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path.  It expires two minutes after issue or on first use.  Pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied.  Requires a token that resolves to a user, so use the device authorization flow. 
+     * @summary One time link that opens a preview in a browser with no UltraCart login
+     * @param {number} storefrontOid 
+     * @param {SfvbPreviewAccessRequest} [previewAccess] What the browser should see
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof SfvbApiInterface
+     */
+    createSfvbPreviewAccessRaw(requestParameters: CreateSfvbPreviewAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPreviewAccessResponse>>;
+
+    /**
+     * The preview URL only works in a browser already signed in to UltraCart on the storefront\'s own host, and an agent\'s built in browser never is.  This returns a single use access_url on the storefront host instead.  Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path.  It expires two minutes after issue or on first use.  Pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied.  Requires a token that resolves to a user, so use the device authorization flow. 
+     * One time link that opens a preview in a browser with no UltraCart login
+     */
+    createSfvbPreviewAccess(requestParameters: CreateSfvbPreviewAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewAccessResponse>;
+
     /**
      * Returns a server generated session id to push containers into, and opens the session so that id exists rather than merely being random.  The id is not caller supplied, because concurrent agents choosing their own would be free to collide, and the browser editor\'s habit of minting one with Math.random is not a property worth carrying into an API.  Expires after eight hours and can be deleted sooner.  Requires a token that resolves to a user, so use the device authorization flow. 
      * @summary Create a preview session
@@ -563,8 +591,8 @@ export interface SfvbApiInterface {
     getSfvbContainerVersion(requestParameters: GetSfvbContainerVersionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbContainerVersion>;
 
     /**
-     * 
-     * @summary Configuration schema for one element type
+     * schema is the draft-07 JSON schema for the element config object and doc is the markdown field card, both as strings.  Either is omitted when none has been published for the element, which is still a 200.  The catalog is published by the visual builder release process, and a republish can take up to an hour to appear here. 
+     * @summary Configuration schema and field card for one element type
      * @param {string} elementType 
      * @param {*} [options] Override http request option.
      * @throws {RequiredError}
@@ -573,7 +601,8 @@ export interface SfvbApiInterface {
     getSfvbElementRaw(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbElementSchemaResponse>>;
 
     /**
-     * Configuration schema for one element type
+     * schema is the draft-07 JSON schema for the element config object and doc is the markdown field card, both as strings.  Either is omitted when none has been published for the element, which is still a 200.  The catalog is published by the visual builder release process, and a republish can take up to an hour to appear here. 
+     * Configuration schema and field card for one element type
      */
     getSfvbElement(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementSchemaResponse>;
 
@@ -1204,6 +1233,50 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
         return await response.value();
     }
 
+    /**
+     * The preview URL only works in a browser already signed in to UltraCart on the storefront\'s own host, and an agent\'s built in browser never is.  This returns a single use access_url on the storefront host instead.  Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path.  It expires two minutes after issue or on first use.  Pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied.  Requires a token that resolves to a user, so use the device authorization flow. 
+     * One time link that opens a preview in a browser with no UltraCart login
+     */
+    async createSfvbPreviewAccessRaw(requestParameters: CreateSfvbPreviewAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPreviewAccessResponse>> {
+        if (requestParameters.storefrontOid === null || requestParameters.storefrontOid === undefined) {
+            throw new runtime.RequiredError('storefrontOid','Required parameter requestParameters.storefrontOid was null or undefined when calling createSfvbPreviewAccess.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        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}/preview_access`.replace(`{${"storefront_oid"}}`, encodeURIComponent(String(requestParameters.storefrontOid))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: SfvbPreviewAccessRequestToJSON(requestParameters.previewAccess),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => SfvbPreviewAccessResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * The preview URL only works in a browser already signed in to UltraCart on the storefront\'s own host, and an agent\'s built in browser never is.  This returns a single use access_url on the storefront host instead.  Opening it gets past the storefront lock, shows the requested theme and applies the requested preview session for the rest of that browser session, then redirects to path.  It expires two minutes after issue or on first use.  Pages opened afterwards carry an X-UltraCart-Preview header of applied or not-applied.  Requires a token that resolves to a user, so use the device authorization flow. 
+     * One time link that opens a preview in a browser with no UltraCart login
+     */
+    async createSfvbPreviewAccess(requestParameters: CreateSfvbPreviewAccessRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewAccessResponse> {
+        const response = await this.createSfvbPreviewAccessRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Returns a server generated session id to push containers into, and opens the session so that id exists rather than merely being random.  The id is not caller supplied, because concurrent agents choosing their own would be free to collide, and the browser editor\'s habit of minting one with Math.random is not a property worth carrying into an API.  Expires after eight hours and can be deleted sooner.  Requires a token that resolves to a user, so use the device authorization flow. 
      * Create a preview session
@@ -1647,7 +1720,8 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
     }
 
     /**
-     * Configuration schema for one element type
+     * schema is the draft-07 JSON schema for the element config object and doc is the markdown field card, both as strings.  Either is omitted when none has been published for the element, which is still a 200.  The catalog is published by the visual builder release process, and a republish can take up to an hour to appear here. 
+     * Configuration schema and field card for one element type
      */
     async getSfvbElementRaw(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbElementSchemaResponse>> {
         if (requestParameters.elementType === null || requestParameters.elementType === undefined) {
@@ -1678,7 +1752,8 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
     }
 
     /**
-     * Configuration schema for one element type
+     * schema is the draft-07 JSON schema for the element config object and doc is the markdown field card, both as strings.  Either is omitted when none has been published for the element, which is still a 200.  The catalog is published by the visual builder release process, and a republish can take up to an hour to appear here. 
+     * Configuration schema and field card for one element type
      */
     async getSfvbElement(requestParameters: GetSfvbElementRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbElementSchemaResponse> {
         const response = await this.getSfvbElementRaw(requestParameters, initOverrides);

package/src/models/SfvbElement.ts

@@ -19,6 +19,12 @@ import { exists, mapValues } from '../runtime';
  * @interface SfvbElement
  */
 export interface SfvbElement {
+    /**
+     * True when a markdown field card for this element is available from elements/{element_type}.
+     * @type {boolean}
+     * @memberof SfvbElement
+     */
+    doc_available?: boolean;
     /**
      * True when a per element configuration schema is available from elements/{element_type}.
      * @type {boolean}
@@ -54,6 +60,7 @@ export function SfvbElementFromJSONTyped(json: any, ignoreDiscriminator: boolean
     }
     return {
         
+        'doc_available': !exists(json, 'doc_available') ? undefined : json['doc_available'],
         'schema_available': !exists(json, 'schema_available') ? undefined : json['schema_available'],
         'type': !exists(json, 'type') ? undefined : json['type'],
     };
@@ -68,6 +75,7 @@ export function SfvbElementToJSON(value?: SfvbElement | null): any {
     }
     return {
         
+        'doc_available': value.doc_available,
         'schema_available': value.schema_available,
         'type': value.type,
     };

package/src/models/SfvbElementSchemaResponse.ts

@@ -20,7 +20,13 @@ import { exists, mapValues } from '../runtime';
  */
 export interface SfvbElementSchemaResponse {
     /**
-     * JSON schema for this element's config object, as a JSON string.  Null when no schema has been published for this element yet.
+     * Markdown field card for this element, as a string.  Omitted when no field card has been published for this element.
+     * @type {string}
+     * @memberof SfvbElementSchemaResponse
+     */
+    doc?: string;
+    /**
+     * Draft-07 JSON schema for this element's config object, as a JSON string.  Omitted when no schema has been published for this element.
      * @type {string}
      * @memberof SfvbElementSchemaResponse
      */
@@ -54,6 +60,7 @@ export function SfvbElementSchemaResponseFromJSONTyped(json: any, ignoreDiscrimi
     }
     return {
         
+        'doc': !exists(json, 'doc') ? undefined : json['doc'],
         'schema': !exists(json, 'schema') ? undefined : json['schema'],
         'type': !exists(json, 'type') ? undefined : json['type'],
     };
@@ -68,6 +75,7 @@ export function SfvbElementSchemaResponseToJSON(value?: SfvbElementSchemaRespons
     }
     return {
         
+        'doc': value.doc,
         'schema': value.schema,
         'type': value.type,
     };

package/src/models/SfvbPreviewAccessRequest.ts

@@ -0,0 +1,83 @@
+/* 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 SfvbPreviewAccessRequest
+ */
+export interface SfvbPreviewAccessRequest {
+    /**
+     * Storefront path to land on, beginning with a slash.  Defaults to /
+     * @type {string}
+     * @memberof SfvbPreviewAccessRequest
+     */
+    path?: string;
+    /**
+     * Staged preview session to show.  It must be one this user created and it must not have expired.  Leave it out to show the saved containers with nothing staged.
+     * @type {string}
+     * @memberof SfvbPreviewAccessRequest
+     */
+    preview_session_id?: string;
+    /**
+     * Theme to show, which may be inactive.  Must belong to this storefront.  Defaults to the active theme.
+     * @type {number}
+     * @memberof SfvbPreviewAccessRequest
+     */
+    theme_oid?: number;
+}
+
+
+
+/**
+ * Check if a given object implements the SfvbPreviewAccessRequest interface.
+ */
+export function instanceOfSfvbPreviewAccessRequest(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function SfvbPreviewAccessRequestFromJSON(json: any): SfvbPreviewAccessRequest {
+    return SfvbPreviewAccessRequestFromJSONTyped(json, false);
+}
+
+export function SfvbPreviewAccessRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbPreviewAccessRequest {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'path': !exists(json, 'path') ? undefined : json['path'],
+        'preview_session_id': !exists(json, 'preview_session_id') ? undefined : json['preview_session_id'],
+        'theme_oid': !exists(json, 'theme_oid') ? undefined : json['theme_oid'],
+    };
+}
+
+export function SfvbPreviewAccessRequestToJSON(value?: SfvbPreviewAccessRequest | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'path': value.path,
+        'preview_session_id': value.preview_session_id,
+        'theme_oid': value.theme_oid,
+    };
+}
+

package/src/models/SfvbPreviewAccessResponse.ts

@@ -0,0 +1,123 @@
+/* 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 SfvbPreviewAccessResponse
+ */
+export interface SfvbPreviewAccessResponse {
+    /**
+     * One time link on the storefront's own host.  Opening it in any browser, including an agent's built in browser with no UltraCart login, gets past the storefront lock and applies the preview session and theme for the rest of that browser's session, then redirects to path.  It is a credential until used, so do not paste it anywhere other than the browser that should open it.
+     * @type {string}
+     * @memberof SfvbPreviewAccessResponse
+     */
+    access_url?: string;
+    /**
+     * Seconds left to open access_url.  It stops working after that, and after its first use.
+     * @type {number}
+     * @memberof SfvbPreviewAccessResponse
+     */
+    expires_in_seconds?: number;
+    /**
+     * Storefront path the browser lands on, after reserved preview parameters are removed.
+     * @type {string}
+     * @memberof SfvbPreviewAccessResponse
+     */
+    path?: string;
+    /**
+     * The preview session applied, when one was requested.
+     * @type {string}
+     * @memberof SfvbPreviewAccessResponse
+     */
+    preview_session_id?: string;
+    /**
+     * How long the browser stays in preview once access_url is opened.  The remaining life of the preview session, or eight hours when none was given.  The user and their storefront permission are checked again on every page, so removing either ends it sooner.
+     * @type {number}
+     * @memberof SfvbPreviewAccessResponse
+     */
+    session_lifetime_seconds?: number;
+    /**
+     * Always true.  A second open of access_url returns 410.
+     * @type {boolean}
+     * @memberof SfvbPreviewAccessResponse
+     */
+    single_use?: boolean;
+    /**
+     * The theme shown, when one was requested.
+     * @type {number}
+     * @memberof SfvbPreviewAccessResponse
+     */
+    theme_oid?: number;
+    /**
+     * Plain language instructions, safe to show a user.
+     * @type {string}
+     * @memberof SfvbPreviewAccessResponse
+     */
+    usage_note?: string;
+}
+
+
+
+/**
+ * Check if a given object implements the SfvbPreviewAccessResponse interface.
+ */
+export function instanceOfSfvbPreviewAccessResponse(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function SfvbPreviewAccessResponseFromJSON(json: any): SfvbPreviewAccessResponse {
+    return SfvbPreviewAccessResponseFromJSONTyped(json, false);
+}
+
+export function SfvbPreviewAccessResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): SfvbPreviewAccessResponse {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'access_url': !exists(json, 'access_url') ? undefined : json['access_url'],
+        'expires_in_seconds': !exists(json, 'expires_in_seconds') ? undefined : json['expires_in_seconds'],
+        'path': !exists(json, 'path') ? undefined : json['path'],
+        'preview_session_id': !exists(json, 'preview_session_id') ? undefined : json['preview_session_id'],
+        'session_lifetime_seconds': !exists(json, 'session_lifetime_seconds') ? undefined : json['session_lifetime_seconds'],
+        'single_use': !exists(json, 'single_use') ? undefined : json['single_use'],
+        'theme_oid': !exists(json, 'theme_oid') ? undefined : json['theme_oid'],
+        'usage_note': !exists(json, 'usage_note') ? undefined : json['usage_note'],
+    };
+}
+
+export function SfvbPreviewAccessResponseToJSON(value?: SfvbPreviewAccessResponse | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'access_url': value.access_url,
+        'expires_in_seconds': value.expires_in_seconds,
+        'path': value.path,
+        'preview_session_id': value.preview_session_id,
+        'session_lifetime_seconds': value.session_lifetime_seconds,
+        'single_use': value.single_use,
+        'theme_oid': value.theme_oid,
+        'usage_note': value.usage_note,
+    };
+}
+

package/src/models/SfvbThemeJobResponse.ts

@@ -32,7 +32,7 @@ export interface SfvbThemeJobResponse {
      */
     description?: string;
     /**
-     * Failure detail.  Populated only when status is error.
+     * What to do next when the job did not produce a theme.  The internal cause is not returned; it is recorded against the job id in the server log.
      * @type {string}
      * @memberof SfvbThemeJobResponse
      */

package/src/models/index.ts

@@ -993,6 +993,8 @@ export * from './SfvbPageAttributeUpdateRequest';
 export * from './SfvbPageMultimedia';
 export * from './SfvbPageMultimediaRequest';
 export * from './SfvbPageResponse';
+export * from './SfvbPreviewAccessRequest';
+export * from './SfvbPreviewAccessResponse';
 export * from './SfvbPreviewSessionRequest';
 export * from './SfvbPreviewSessionResponse';
 export * from './SfvbPreviewUrlResponse';