ultracart_rest_api_v2_typescript 4.1.146 → 4.1.148

package/.openapi-generator/FILES

@@ -349,6 +349,7 @@ src/models/ConversationVirtualAgentBudget.ts
 src/models/ConversationVirtualAgentBudgetResponse.ts
 src/models/ConversationVirtualAgentCapabilities.ts
 src/models/ConversationVirtualAgentCapabilitiesResponse.ts
+src/models/ConversationVirtualAgentCapabilityCustomCollection.ts
 src/models/ConversationVirtualAgentCapabilityZohoDeskDepartment.ts
 src/models/ConversationWebchatContext.ts
 src/models/ConversationWebchatQueueStatus.ts

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.146
+## ultracart_rest_api_v2_typescript@4.1.148
 
 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.146 --save
+npm install ultracart_rest_api_v2_typescript@4.1.148 --save
 ```
 
 ```typescript
@@ -85,6 +85,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.148 | 09/04/2026 | conversations - added ai agent capabilities |
+| 4.1.147 | 09/04/2026 | sfvb - internal testing |
 | 4.1.146 | 09/03/2026 | sfvb - internal testing |
 | 4.1.145 | 09/02/2026 | sfvb - internal testing |
 | 4.1.144 | 09/02/2026 | sfvb - internal testing |

package/dist/apis/SfvbApi.d.ts

@@ -195,7 +195,7 @@ export interface SfvbApiInterface {
      */
     compileSfvbCjson(requestParameters: CompileSfvbCjsonRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCompileResponse>;
     /**
-     * Returns a server generated session id to push containers into.  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.
+     * 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
      * @param {number} storefrontOid
      * @param {*} [options] Override http request option.
@@ -204,7 +204,7 @@ export interface SfvbApiInterface {
      */
     createSfvbPreviewSessionRaw(requestParameters: CreateSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPreviewSessionResponse>>;
     /**
-     * Returns a server generated session id to push containers into.  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.
+     * 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
      */
     createSfvbPreviewSession(requestParameters: CreateSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
@@ -602,7 +602,7 @@ export interface SfvbApiInterface {
      */
     putSfvbFileContent(requestParameters: PutSfvbFileContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileWriteResponse>;
     /**
-     * Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow.
+     * Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  The session must exist - this does not create one, so a deleted, expired or never issued id is a 404 rather than a new session.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow.
      * @summary Push containers into a preview session
      * @param {number} storefrontOid
      * @param {string} previewSessionId
@@ -614,7 +614,7 @@ export interface SfvbApiInterface {
      */
     putSfvbPreviewSessionRaw(requestParameters: PutSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPreviewSessionResponse>>;
     /**
-     * Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow.
+     * Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  The session must exist - this does not create one, so a deleted, expired or never issued id is a 404 rather than a new session.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow.
      * Push containers into a preview session
      */
     putSfvbPreviewSession(requestParameters: PutSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
@@ -779,12 +779,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      */
     compileSfvbCjson(requestParameters: CompileSfvbCjsonRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCompileResponse>;
     /**
-     * Returns a server generated session id to push containers into.  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.
+     * 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
      */
     createSfvbPreviewSessionRaw(requestParameters: CreateSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPreviewSessionResponse>>;
     /**
-     * Returns a server generated session id to push containers into.  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.
+     * 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
      */
     createSfvbPreviewSession(requestParameters: CreateSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
@@ -1039,12 +1039,12 @@ export declare class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface
      */
     putSfvbFileContent(requestParameters: PutSfvbFileContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileWriteResponse>;
     /**
-     * Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow.
+     * Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  The session must exist - this does not create one, so a deleted, expired or never issued id is a 404 rather than a new session.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow.
      * Push containers into a preview session
      */
     putSfvbPreviewSessionRaw(requestParameters: PutSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPreviewSessionResponse>>;
     /**
-     * Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow.
+     * Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  The session must exist - this does not create one, so a deleted, expired or never issued id is a 404 rather than a new session.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow.
      * Push containers into a preview session
      */
     putSfvbPreviewSession(requestParameters: PutSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;

package/dist/apis/SfvbApi.js

@@ -137,7 +137,7 @@ var SfvbApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Returns a server generated session id to push containers into.  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.
+     * 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
      */
     SfvbApi.prototype.createSfvbPreviewSessionRaw = function (requestParameters, initOverrides) {
@@ -178,7 +178,7 @@ var SfvbApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Returns a server generated session id to push containers into.  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.
+     * 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
      */
     SfvbApi.prototype.createSfvbPreviewSession = function (requestParameters, initOverrides) {
@@ -1833,7 +1833,7 @@ var SfvbApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow.
+     * Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  The session must exist - this does not create one, so a deleted, expired or never issued id is a 404 rather than a new session.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow.
      * Push containers into a preview session
      */
     SfvbApi.prototype.putSfvbPreviewSessionRaw = function (requestParameters, initOverrides) {
@@ -1885,7 +1885,7 @@ var SfvbApi = /** @class */ (function (_super) {
         });
     };
     /**
-     * Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow.
+     * Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  The session must exist - this does not create one, so a deleted, expired or never issued id is a 404 rather than a new session.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow.
      * Push containers into a preview session
      */
     SfvbApi.prototype.putSfvbPreviewSession = function (requestParameters, initOverrides) {

package/dist/models/ConversationVirtualAgentCapabilities.d.ts

@@ -9,6 +9,7 @@
  * https://openapi-generator.tech
  * Do not edit the class manually.
  */
+import { ConversationVirtualAgentCapabilityCustomCollection } from './ConversationVirtualAgentCapabilityCustomCollection';
 import { ConversationVirtualAgentCapabilityZohoDeskDepartment } from './ConversationVirtualAgentCapabilityZohoDeskDepartment';
 /**
  *
@@ -16,6 +17,12 @@ import { ConversationVirtualAgentCapabilityZohoDeskDepartment } from './Conversa
  * @interface ConversationVirtualAgentCapabilities
  */
 export interface ConversationVirtualAgentCapabilities {
+    /**
+     * Permission flag to allow this Agent to search the merchant's custom Typesense collections.
+     * @type {boolean}
+     * @memberof ConversationVirtualAgentCapabilities
+     */
+    access_custom_collections?: boolean;
     /**
      * Permission flag to allow this Agent access to the storefront and item information.
      * @type {boolean}
@@ -28,6 +35,18 @@ export interface ConversationVirtualAgentCapabilities {
      * @memberof ConversationVirtualAgentCapabilities
      */
     cancel_subscription?: boolean;
+    /**
+     * The custom collections this Agent is allowed to search.  Empty means none, even when access_custom_collections is true.
+     * @type {object}
+     * @memberof ConversationVirtualAgentCapabilities
+     */
+    custom_collection_oids?: object;
+    /**
+     * Read only.  All of the merchant's custom collections, to populate the selection list for custom_collection_oids.  Changes here are ignored.
+     * @type {Array<ConversationVirtualAgentCapabilityCustomCollection>}
+     * @memberof ConversationVirtualAgentCapabilities
+     */
+    custom_collections?: Array<ConversationVirtualAgentCapabilityCustomCollection>;
     /**
      *
      * @type {boolean}

package/dist/models/ConversationVirtualAgentCapabilities.js

@@ -15,6 +15,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConversationVirtualAgentCapabilitiesToJSON = exports.ConversationVirtualAgentCapabilitiesFromJSONTyped = exports.ConversationVirtualAgentCapabilitiesFromJSON = exports.instanceOfConversationVirtualAgentCapabilities = exports.ConversationVirtualAgentCapabilitiesOpenSupportTicketChannelEnum = void 0;
 var runtime_1 = require("../runtime");
+var ConversationVirtualAgentCapabilityCustomCollection_1 = require("./ConversationVirtualAgentCapabilityCustomCollection");
 var ConversationVirtualAgentCapabilityZohoDeskDepartment_1 = require("./ConversationVirtualAgentCapabilityZohoDeskDepartment");
 /**
  * @export
@@ -42,8 +43,11 @@ function ConversationVirtualAgentCapabilitiesFromJSONTyped(json, ignoreDiscrimin
         return json;
     }
     return {
+        'access_custom_collections': !(0, runtime_1.exists)(json, 'access_custom_collections') ? undefined : json['access_custom_collections'],
         'access_storefront_and_item': !(0, runtime_1.exists)(json, 'access_storefront_and_item') ? undefined : json['access_storefront_and_item'],
         'cancel_subscription': !(0, runtime_1.exists)(json, 'cancel_subscription') ? undefined : json['cancel_subscription'],
+        'custom_collection_oids': !(0, runtime_1.exists)(json, 'custom_collection_oids') ? undefined : json['custom_collection_oids'],
+        'custom_collections': !(0, runtime_1.exists)(json, 'custom_collections') ? undefined : (json['custom_collections'].map(ConversationVirtualAgentCapabilityCustomCollection_1.ConversationVirtualAgentCapabilityCustomCollectionFromJSON)),
         'delay_subscription': !(0, runtime_1.exists)(json, 'delay_subscription') ? undefined : json['delay_subscription'],
         'generate_coupon': !(0, runtime_1.exists)(json, 'generate_coupon') ? undefined : json['generate_coupon'],
         'lookup_order_information': !(0, runtime_1.exists)(json, 'lookup_order_information') ? undefined : json['lookup_order_information'],
@@ -69,8 +73,11 @@ function ConversationVirtualAgentCapabilitiesToJSON(value) {
         return null;
     }
     return {
+        'access_custom_collections': value.access_custom_collections,
         'access_storefront_and_item': value.access_storefront_and_item,
         'cancel_subscription': value.cancel_subscription,
+        'custom_collection_oids': value.custom_collection_oids,
+        'custom_collections': value.custom_collections === undefined ? undefined : (value.custom_collections.map(ConversationVirtualAgentCapabilityCustomCollection_1.ConversationVirtualAgentCapabilityCustomCollectionToJSON)),
         'delay_subscription': value.delay_subscription,
         'generate_coupon': value.generate_coupon,
         'lookup_order_information': value.lookup_order_information,

package/dist/models/ConversationVirtualAgentCapabilityCustomCollection.d.ts

@@ -0,0 +1,67 @@
+/**
+ * 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 ConversationVirtualAgentCapabilityCustomCollection
+ */
+export interface ConversationVirtualAgentCapabilityCustomCollection {
+    /**
+     * Merchant authored description of what is in this collection, which is what the agent sees when deciding whether to search it
+     * @type {string}
+     * @memberof ConversationVirtualAgentCapabilityCustomCollection
+     */
+    ai_description?: string;
+    /**
+     * True if this collection has been enabled for AI access in its own configuration.  A collection that is not enabled cannot be searched even if it is selected here.
+     * @type {boolean}
+     * @memberof ConversationVirtualAgentCapabilityCustomCollection
+     */
+    ai_enabled?: boolean;
+    /**
+     * Merchant assigned name of the collection
+     * @type {string}
+     * @memberof ConversationVirtualAgentCapabilityCustomCollection
+     */
+    collection_name?: string;
+    /**
+     * Error from the last build, if it failed.  A collection with an error will return nothing to the agent, so this is worth surfacing next to the selection.
+     * @type {string}
+     * @memberof ConversationVirtualAgentCapabilityCustomCollection
+     */
+    error_message?: string;
+    /**
+     * Date/time the collection was last rebuilt from the merchant's BigQuery query
+     * @type {string}
+     * @memberof ConversationVirtualAgentCapabilityCustomCollection
+     */
+    last_update_dts?: string;
+    /**
+     * Number of records loaded on the last build
+     * @type {number}
+     * @memberof ConversationVirtualAgentCapabilityCustomCollection
+     */
+    record_count?: number;
+    /**
+     * The identifier to place in custom_collection_oids to grant the agent access to this collection
+     * @type {number}
+     * @memberof ConversationVirtualAgentCapabilityCustomCollection
+     */
+    typesense_custom_collection_oid?: number;
+}
+/**
+ * Check if a given object implements the ConversationVirtualAgentCapabilityCustomCollection interface.
+ */
+export declare function instanceOfConversationVirtualAgentCapabilityCustomCollection(value: object): boolean;
+export declare function ConversationVirtualAgentCapabilityCustomCollectionFromJSON(json: any): ConversationVirtualAgentCapabilityCustomCollection;
+export declare function ConversationVirtualAgentCapabilityCustomCollectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationVirtualAgentCapabilityCustomCollection;
+export declare function ConversationVirtualAgentCapabilityCustomCollectionToJSON(value?: ConversationVirtualAgentCapabilityCustomCollection | null): any;

package/dist/models/ConversationVirtualAgentCapabilityCustomCollection.js

@@ -0,0 +1,62 @@
+"use strict";
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ConversationVirtualAgentCapabilityCustomCollectionToJSON = exports.ConversationVirtualAgentCapabilityCustomCollectionFromJSONTyped = exports.ConversationVirtualAgentCapabilityCustomCollectionFromJSON = exports.instanceOfConversationVirtualAgentCapabilityCustomCollection = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the ConversationVirtualAgentCapabilityCustomCollection interface.
+ */
+function instanceOfConversationVirtualAgentCapabilityCustomCollection(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfConversationVirtualAgentCapabilityCustomCollection = instanceOfConversationVirtualAgentCapabilityCustomCollection;
+function ConversationVirtualAgentCapabilityCustomCollectionFromJSON(json) {
+    return ConversationVirtualAgentCapabilityCustomCollectionFromJSONTyped(json, false);
+}
+exports.ConversationVirtualAgentCapabilityCustomCollectionFromJSON = ConversationVirtualAgentCapabilityCustomCollectionFromJSON;
+function ConversationVirtualAgentCapabilityCustomCollectionFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'ai_description': !(0, runtime_1.exists)(json, 'ai_description') ? undefined : json['ai_description'],
+        'ai_enabled': !(0, runtime_1.exists)(json, 'ai_enabled') ? undefined : json['ai_enabled'],
+        'collection_name': !(0, runtime_1.exists)(json, 'collection_name') ? undefined : json['collection_name'],
+        'error_message': !(0, runtime_1.exists)(json, 'error_message') ? undefined : json['error_message'],
+        'last_update_dts': !(0, runtime_1.exists)(json, 'last_update_dts') ? undefined : json['last_update_dts'],
+        'record_count': !(0, runtime_1.exists)(json, 'record_count') ? undefined : json['record_count'],
+        'typesense_custom_collection_oid': !(0, runtime_1.exists)(json, 'typesense_custom_collection_oid') ? undefined : json['typesense_custom_collection_oid'],
+    };
+}
+exports.ConversationVirtualAgentCapabilityCustomCollectionFromJSONTyped = ConversationVirtualAgentCapabilityCustomCollectionFromJSONTyped;
+function ConversationVirtualAgentCapabilityCustomCollectionToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'ai_description': value.ai_description,
+        'ai_enabled': value.ai_enabled,
+        'collection_name': value.collection_name,
+        'error_message': value.error_message,
+        'last_update_dts': value.last_update_dts,
+        'record_count': value.record_count,
+        'typesense_custom_collection_oid': value.typesense_custom_collection_oid,
+    };
+}
+exports.ConversationVirtualAgentCapabilityCustomCollectionToJSON = ConversationVirtualAgentCapabilityCustomCollectionToJSON;

package/dist/models/SfvbContainerResponse.d.ts

@@ -34,7 +34,7 @@ export interface SfvbContainerResponse {
      */
     hash_sha256?: string;
     /**
-     * When the container was last modified, in the store's own record of it.  Present for email, postcardfront and postcardback.  Absent for upsell and item, because those tables carry no modification timestamp at all - for those two, read created_dts on the current entry of container_versions, which records when this API last wrote the container.  Note that a postcard keeps one timestamp for both of its sides, so writing the front moves the value the back reports.
+     * When the container was last modified, in the store's own record of it.  Every owner type reports this.  It is absent only when the container has never been written since the store began recording it, so treat an absent value as unknown rather than as never modified.  Two behaviours worth knowing.  A postcard keeps one timestamp for both of its sides, so writing the front moves the value the back reports.  An upsell container that is rewritten with byte identical content keeps its original date rather than moving to now, because the timestamp tracks changes to the container and not writes to the offer.
      * @type {string}
      * @memberof SfvbContainerResponse
      */

package/dist/models/SfvbThemeDuplicateRequest.d.ts

@@ -16,7 +16,7 @@
  */
 export interface SfvbThemeDuplicateRequest {
     /**
-     * Directory name for the new theme under /themes/.  Letters and numbers; it is cleansed before use.  Must not already exist - a collision is refused rather than resolved, because silently creating a differently named theme leaves you unsure what you made.
+     * Directory name for the new theme under /themes/.  Letters and numbers, one path segment.  Used verbatim - anything that is not already a valid directory name is refused rather than adjusted, because this call does not return the new theme's oid and you find your copy by matching the target_path you asked for.  Must not already exist - a collision is refused rather than resolved, because silently creating a differently named theme leaves you unsure what you made.
      * @type {string}
      * @memberof SfvbThemeDuplicateRequest
      */

package/dist/models/SfvbThemeJobResponse.d.ts

@@ -82,7 +82,7 @@ export interface SfvbThemeJobResponse {
      */
     success?: boolean;
     /**
-     * Path the new theme was created at.  Returned when the job is started; the theme oid itself is NOT returned, because the job's product is a plain text report rather than a structured result.  Once the job completes, list themes and match on this path.
+     * Path the new theme is being created at.  Returned when the job is started and on every poll, so you do not have to keep the response that started it.  The theme oid itself is NOT returned, so once the job completes you list themes and match on this path.  It is also what success is checked against - a finished job whose theme is not here reports success false rather than pretending.
      * @type {string}
      * @memberof SfvbThemeJobResponse
      */

package/dist/models/SfvbVersionResponse.d.ts

@@ -33,18 +33,42 @@ export interface SfvbVersionResponse {
      * @memberof SfvbVersionResponse
      */
     element_count?: number;
+    /**
+     * Largest binary asset that can be uploaded, in bytes, for every accepted type except video.
+     * @type {number}
+     * @memberof SfvbVersionResponse
+     */
+    max_asset_bytes?: number;
     /**
      * Largest CJSON document that will be parsed, in bytes.
      * @type {number}
      * @memberof SfvbVersionResponse
      */
     max_cjson_bytes?: number;
+    /**
+     * Most entries one directory listing returns.  Asking for more is silently reduced to this rather than refused, so compare against it instead of trusting that you got what you asked for.  The listing does set a truncated flag when it drops entries.
+     * @type {number}
+     * @memberof SfvbVersionResponse
+     */
+    max_directory_entries?: number;
+    /**
+     * Most element library results one page returns.  Asking for more is silently reduced to this, and unlike the directory listing there is no truncation flag on the response, so this number is the only way to know a larger request was cut.
+     * @type {number}
+     * @memberof SfvbVersionResponse
+     */
+    max_library_results_per_page?: number;
     /**
      * Largest payload one preview session may hold, in bytes.
      * @type {number}
      * @memberof SfvbVersionResponse
      */
     max_preview_session_bytes?: number;
+    /**
+     * Largest historical version files/revert will restore, in bytes.  Higher than max_text_read_bytes deliberately - putting back a version that is already stored is cheaper than serving it as JSON, so a version too large to read can still be reverted to.
+     * @type {number}
+     * @memberof SfvbVersionResponse
+     */
+    max_revertable_bytes?: number;
     /**
      * Hard ceiling on file search results per page.
      * @type {number}
@@ -52,11 +76,23 @@ export interface SfvbVersionResponse {
      */
     max_search_results?: number;
     /**
-     * Largest template file that can be written, in bytes.
+     * Largest .vm template that can be written, in bytes.  Narrow on purpose - it gates writes, only for files ending in .vm, and it is not the ceiling on reading a file back.  Use max_text_read_bytes for that.
      * @type {number}
      * @memberof SfvbVersionResponse
      */
     max_template_bytes?: number;
+    /**
+     * Largest file files/content will return as text, in bytes.  A file above this is refused with sfvb.too_large however small its history versions are.  Bigger than max_template_bytes, so a file can be readable here and still be too large to write back as a template.  Anything above this is still readable in full through files/download, which returns raw bytes and applies no ceiling.
+     * @type {number}
+     * @memberof SfvbVersionResponse
+     */
+    max_text_read_bytes?: number;
+    /**
+     * Largest video that can be uploaded, in bytes.  Video is the one type allowed past max_asset_bytes.
+     * @type {number}
+     * @memberof SfvbVersionResponse
+     */
+    max_video_bytes?: number;
     /**
      * Most widget ids that can be reserved in one call.
      * @type {number}

package/dist/models/SfvbVersionResponse.js

@@ -43,10 +43,16 @@ function SfvbVersionResponseFromJSONTyped(json, ignoreDiscriminator) {
         'container_manager_version': !(0, runtime_1.exists)(json, 'container_manager_version') ? undefined : json['container_manager_version'],
         'container_versions_retained': !(0, runtime_1.exists)(json, 'container_versions_retained') ? undefined : json['container_versions_retained'],
         'element_count': !(0, runtime_1.exists)(json, 'element_count') ? undefined : json['element_count'],
+        'max_asset_bytes': !(0, runtime_1.exists)(json, 'max_asset_bytes') ? undefined : json['max_asset_bytes'],
         'max_cjson_bytes': !(0, runtime_1.exists)(json, 'max_cjson_bytes') ? undefined : json['max_cjson_bytes'],
+        'max_directory_entries': !(0, runtime_1.exists)(json, 'max_directory_entries') ? undefined : json['max_directory_entries'],
+        'max_library_results_per_page': !(0, runtime_1.exists)(json, 'max_library_results_per_page') ? undefined : json['max_library_results_per_page'],
         'max_preview_session_bytes': !(0, runtime_1.exists)(json, 'max_preview_session_bytes') ? undefined : json['max_preview_session_bytes'],
+        'max_revertable_bytes': !(0, runtime_1.exists)(json, 'max_revertable_bytes') ? undefined : json['max_revertable_bytes'],
         'max_search_results': !(0, runtime_1.exists)(json, 'max_search_results') ? undefined : json['max_search_results'],
         'max_template_bytes': !(0, runtime_1.exists)(json, 'max_template_bytes') ? undefined : json['max_template_bytes'],
+        'max_text_read_bytes': !(0, runtime_1.exists)(json, 'max_text_read_bytes') ? undefined : json['max_text_read_bytes'],
+        'max_video_bytes': !(0, runtime_1.exists)(json, 'max_video_bytes') ? undefined : json['max_video_bytes'],
         'max_widget_ids_per_request': !(0, runtime_1.exists)(json, 'max_widget_ids_per_request') ? undefined : json['max_widget_ids_per_request'],
         'preview_session_ttl_seconds': !(0, runtime_1.exists)(json, 'preview_session_ttl_seconds') ? undefined : json['preview_session_ttl_seconds'],
         'release': !(0, runtime_1.exists)(json, 'release') ? undefined : json['release'],
@@ -64,10 +70,16 @@ function SfvbVersionResponseToJSON(value) {
         'container_manager_version': value.container_manager_version,
         'container_versions_retained': value.container_versions_retained,
         'element_count': value.element_count,
+        'max_asset_bytes': value.max_asset_bytes,
         'max_cjson_bytes': value.max_cjson_bytes,
+        'max_directory_entries': value.max_directory_entries,
+        'max_library_results_per_page': value.max_library_results_per_page,
         'max_preview_session_bytes': value.max_preview_session_bytes,
+        'max_revertable_bytes': value.max_revertable_bytes,
         'max_search_results': value.max_search_results,
         'max_template_bytes': value.max_template_bytes,
+        'max_text_read_bytes': value.max_text_read_bytes,
+        'max_video_bytes': value.max_video_bytes,
         'max_widget_ids_per_request': value.max_widget_ids_per_request,
         'preview_session_ttl_seconds': value.preview_session_ttl_seconds,
         'release': value.release,

package/dist/models/index.d.ts

@@ -319,6 +319,7 @@ export * from './ConversationVirtualAgentBudget';
 export * from './ConversationVirtualAgentBudgetResponse';
 export * from './ConversationVirtualAgentCapabilities';
 export * from './ConversationVirtualAgentCapabilitiesResponse';
+export * from './ConversationVirtualAgentCapabilityCustomCollection';
 export * from './ConversationVirtualAgentCapabilityZohoDeskDepartment';
 export * from './ConversationWebchatContext';
 export * from './ConversationWebchatQueueStatus';

package/dist/models/index.js

@@ -337,6 +337,7 @@ __exportStar(require("./ConversationVirtualAgentBudget"), exports);
 __exportStar(require("./ConversationVirtualAgentBudgetResponse"), exports);
 __exportStar(require("./ConversationVirtualAgentCapabilities"), exports);
 __exportStar(require("./ConversationVirtualAgentCapabilitiesResponse"), exports);
+__exportStar(require("./ConversationVirtualAgentCapabilityCustomCollection"), exports);
 __exportStar(require("./ConversationVirtualAgentCapabilityZohoDeskDepartment"), exports);
 __exportStar(require("./ConversationWebchatContext"), exports);
 __exportStar(require("./ConversationWebchatQueueStatus"), exports);

package/package.json

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

package/src/apis/SfvbApi.ts

@@ -354,7 +354,7 @@ export interface SfvbApiInterface {
     compileSfvbCjson(requestParameters: CompileSfvbCjsonRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbCompileResponse>;
 
     /**
-     * Returns a server generated session id to push containers into.  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. 
+     * 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
      * @param {number} storefrontOid 
      * @param {*} [options] Override http request option.
@@ -364,7 +364,7 @@ export interface SfvbApiInterface {
     createSfvbPreviewSessionRaw(requestParameters: CreateSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPreviewSessionResponse>>;
 
     /**
-     * Returns a server generated session id to push containers into.  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. 
+     * 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
      */
     createSfvbPreviewSession(requestParameters: CreateSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
@@ -815,7 +815,7 @@ export interface SfvbApiInterface {
     putSfvbFileContent(requestParameters: PutSfvbFileContentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbFileWriteResponse>;
 
     /**
-     * Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow. 
+     * Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  The session must exist - this does not create one, so a deleted, expired or never issued id is a 404 rather than a new session.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow. 
      * @summary Push containers into a preview session
      * @param {number} storefrontOid 
      * @param {string} previewSessionId 
@@ -828,7 +828,7 @@ export interface SfvbApiInterface {
     putSfvbPreviewSessionRaw(requestParameters: PutSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPreviewSessionResponse>>;
 
     /**
-     * Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow. 
+     * Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  The session must exist - this does not create one, so a deleted, expired or never issued id is a 404 rather than a new session.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow. 
      * Push containers into a preview session
      */
     putSfvbPreviewSession(requestParameters: PutSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse>;
@@ -1048,7 +1048,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
     }
 
     /**
-     * Returns a server generated session id to push containers into.  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. 
+     * 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
      */
     async createSfvbPreviewSessionRaw(requestParameters: CreateSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPreviewSessionResponse>> {
@@ -1080,7 +1080,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
     }
 
     /**
-     * Returns a server generated session id to push containers into.  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. 
+     * 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
      */
     async createSfvbPreviewSession(requestParameters: CreateSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse> {
@@ -2302,7 +2302,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
     }
 
     /**
-     * Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow. 
+     * Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  The session must exist - this does not create one, so a deleted, expired or never issued id is a 404 rather than a new session.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow. 
      * Push containers into a preview session
      */
     async putSfvbPreviewSessionRaw(requestParameters: PutSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<SfvbPreviewSessionResponse>> {
@@ -2349,7 +2349,7 @@ export class SfvbApi extends runtime.BaseAPI implements SfvbApiInterface {
     }
 
     /**
-     * Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow. 
+     * Stores compiled containers against a session created by createSfvbPreviewSession.  Replaces whatever the session held.  The session must exist - this does not create one, so a deleted, expired or never issued id is a 404 rather than a new session.  Nothing durable is written.  Requires a token that resolves to a user, so use the device authorization flow. 
      * Push containers into a preview session
      */
     async putSfvbPreviewSession(requestParameters: PutSfvbPreviewSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<SfvbPreviewSessionResponse> {

package/src/models/ConversationVirtualAgentCapabilities.ts

@@ -13,6 +13,12 @@
  */
 
 import { exists, mapValues } from '../runtime';
+import {
+    ConversationVirtualAgentCapabilityCustomCollection,
+    ConversationVirtualAgentCapabilityCustomCollectionFromJSON,
+    ConversationVirtualAgentCapabilityCustomCollectionFromJSONTyped,
+    ConversationVirtualAgentCapabilityCustomCollectionToJSON,
+} from './ConversationVirtualAgentCapabilityCustomCollection';
 import {
     ConversationVirtualAgentCapabilityZohoDeskDepartment,
     ConversationVirtualAgentCapabilityZohoDeskDepartmentFromJSON,
@@ -26,6 +32,12 @@ import {
  * @interface ConversationVirtualAgentCapabilities
  */
 export interface ConversationVirtualAgentCapabilities {
+    /**
+     * Permission flag to allow this Agent to search the merchant's custom Typesense collections.
+     * @type {boolean}
+     * @memberof ConversationVirtualAgentCapabilities
+     */
+    access_custom_collections?: boolean;
     /**
      * Permission flag to allow this Agent access to the storefront and item information.
      * @type {boolean}
@@ -38,6 +50,18 @@ export interface ConversationVirtualAgentCapabilities {
      * @memberof ConversationVirtualAgentCapabilities
      */
     cancel_subscription?: boolean;
+    /**
+     * The custom collections this Agent is allowed to search.  Empty means none, even when access_custom_collections is true.
+     * @type {object}
+     * @memberof ConversationVirtualAgentCapabilities
+     */
+    custom_collection_oids?: object;
+    /**
+     * Read only.  All of the merchant's custom collections, to populate the selection list for custom_collection_oids.  Changes here are ignored.
+     * @type {Array<ConversationVirtualAgentCapabilityCustomCollection>}
+     * @memberof ConversationVirtualAgentCapabilities
+     */
+    custom_collections?: Array<ConversationVirtualAgentCapabilityCustomCollection>;
     /**
      * 
      * @type {boolean}
@@ -157,8 +181,11 @@ export function ConversationVirtualAgentCapabilitiesFromJSONTyped(json: any, ign
     }
     return {
         
+        'access_custom_collections': !exists(json, 'access_custom_collections') ? undefined : json['access_custom_collections'],
         'access_storefront_and_item': !exists(json, 'access_storefront_and_item') ? undefined : json['access_storefront_and_item'],
         'cancel_subscription': !exists(json, 'cancel_subscription') ? undefined : json['cancel_subscription'],
+        'custom_collection_oids': !exists(json, 'custom_collection_oids') ? undefined : json['custom_collection_oids'],
+        'custom_collections': !exists(json, 'custom_collections') ? undefined : ((json['custom_collections'] as Array<any>).map(ConversationVirtualAgentCapabilityCustomCollectionFromJSON)),
         'delay_subscription': !exists(json, 'delay_subscription') ? undefined : json['delay_subscription'],
         'generate_coupon': !exists(json, 'generate_coupon') ? undefined : json['generate_coupon'],
         'lookup_order_information': !exists(json, 'lookup_order_information') ? undefined : json['lookup_order_information'],
@@ -185,8 +212,11 @@ export function ConversationVirtualAgentCapabilitiesToJSON(value?: ConversationV
     }
     return {
         
+        'access_custom_collections': value.access_custom_collections,
         'access_storefront_and_item': value.access_storefront_and_item,
         'cancel_subscription': value.cancel_subscription,
+        'custom_collection_oids': value.custom_collection_oids,
+        'custom_collections': value.custom_collections === undefined ? undefined : ((value.custom_collections as Array<any>).map(ConversationVirtualAgentCapabilityCustomCollectionToJSON)),
         'delay_subscription': value.delay_subscription,
         'generate_coupon': value.generate_coupon,
         'lookup_order_information': value.lookup_order_information,

package/src/models/ConversationVirtualAgentCapabilityCustomCollection.ts

@@ -0,0 +1,115 @@
+/* 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 ConversationVirtualAgentCapabilityCustomCollection
+ */
+export interface ConversationVirtualAgentCapabilityCustomCollection {
+    /**
+     * Merchant authored description of what is in this collection, which is what the agent sees when deciding whether to search it
+     * @type {string}
+     * @memberof ConversationVirtualAgentCapabilityCustomCollection
+     */
+    ai_description?: string;
+    /**
+     * True if this collection has been enabled for AI access in its own configuration.  A collection that is not enabled cannot be searched even if it is selected here.
+     * @type {boolean}
+     * @memberof ConversationVirtualAgentCapabilityCustomCollection
+     */
+    ai_enabled?: boolean;
+    /**
+     * Merchant assigned name of the collection
+     * @type {string}
+     * @memberof ConversationVirtualAgentCapabilityCustomCollection
+     */
+    collection_name?: string;
+    /**
+     * Error from the last build, if it failed.  A collection with an error will return nothing to the agent, so this is worth surfacing next to the selection.
+     * @type {string}
+     * @memberof ConversationVirtualAgentCapabilityCustomCollection
+     */
+    error_message?: string;
+    /**
+     * Date/time the collection was last rebuilt from the merchant's BigQuery query
+     * @type {string}
+     * @memberof ConversationVirtualAgentCapabilityCustomCollection
+     */
+    last_update_dts?: string;
+    /**
+     * Number of records loaded on the last build
+     * @type {number}
+     * @memberof ConversationVirtualAgentCapabilityCustomCollection
+     */
+    record_count?: number;
+    /**
+     * The identifier to place in custom_collection_oids to grant the agent access to this collection
+     * @type {number}
+     * @memberof ConversationVirtualAgentCapabilityCustomCollection
+     */
+    typesense_custom_collection_oid?: number;
+}
+
+
+
+/**
+ * Check if a given object implements the ConversationVirtualAgentCapabilityCustomCollection interface.
+ */
+export function instanceOfConversationVirtualAgentCapabilityCustomCollection(value: object): boolean {
+    let isInstance = true;
+
+    return isInstance;
+}
+
+export function ConversationVirtualAgentCapabilityCustomCollectionFromJSON(json: any): ConversationVirtualAgentCapabilityCustomCollection {
+    return ConversationVirtualAgentCapabilityCustomCollectionFromJSONTyped(json, false);
+}
+
+export function ConversationVirtualAgentCapabilityCustomCollectionFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationVirtualAgentCapabilityCustomCollection {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        
+        'ai_description': !exists(json, 'ai_description') ? undefined : json['ai_description'],
+        'ai_enabled': !exists(json, 'ai_enabled') ? undefined : json['ai_enabled'],
+        'collection_name': !exists(json, 'collection_name') ? undefined : json['collection_name'],
+        'error_message': !exists(json, 'error_message') ? undefined : json['error_message'],
+        'last_update_dts': !exists(json, 'last_update_dts') ? undefined : json['last_update_dts'],
+        'record_count': !exists(json, 'record_count') ? undefined : json['record_count'],
+        'typesense_custom_collection_oid': !exists(json, 'typesense_custom_collection_oid') ? undefined : json['typesense_custom_collection_oid'],
+    };
+}
+
+export function ConversationVirtualAgentCapabilityCustomCollectionToJSON(value?: ConversationVirtualAgentCapabilityCustomCollection | null): any {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        
+        'ai_description': value.ai_description,
+        'ai_enabled': value.ai_enabled,
+        'collection_name': value.collection_name,
+        'error_message': value.error_message,
+        'last_update_dts': value.last_update_dts,
+        'record_count': value.record_count,
+        'typesense_custom_collection_oid': value.typesense_custom_collection_oid,
+    };
+}
+

package/src/models/SfvbContainerResponse.ts

@@ -38,7 +38,7 @@ export interface SfvbContainerResponse {
      */
     hash_sha256?: string;
     /**
-     * When the container was last modified, in the store's own record of it.  Present for email, postcardfront and postcardback.  Absent for upsell and item, because those tables carry no modification timestamp at all - for those two, read created_dts on the current entry of container_versions, which records when this API last wrote the container.  Note that a postcard keeps one timestamp for both of its sides, so writing the front moves the value the back reports.
+     * When the container was last modified, in the store's own record of it.  Every owner type reports this.  It is absent only when the container has never been written since the store began recording it, so treat an absent value as unknown rather than as never modified.  Two behaviours worth knowing.  A postcard keeps one timestamp for both of its sides, so writing the front moves the value the back reports.  An upsell container that is rewritten with byte identical content keeps its original date rather than moving to now, because the timestamp tracks changes to the container and not writes to the offer.
      * @type {string}
      * @memberof SfvbContainerResponse
      */

package/src/models/SfvbThemeDuplicateRequest.ts

@@ -20,7 +20,7 @@ import { exists, mapValues } from '../runtime';
  */
 export interface SfvbThemeDuplicateRequest {
     /**
-     * Directory name for the new theme under /themes/.  Letters and numbers; it is cleansed before use.  Must not already exist - a collision is refused rather than resolved, because silently creating a differently named theme leaves you unsure what you made.
+     * Directory name for the new theme under /themes/.  Letters and numbers, one path segment.  Used verbatim - anything that is not already a valid directory name is refused rather than adjusted, because this call does not return the new theme's oid and you find your copy by matching the target_path you asked for.  Must not already exist - a collision is refused rather than resolved, because silently creating a differently named theme leaves you unsure what you made.
      * @type {string}
      * @memberof SfvbThemeDuplicateRequest
      */

package/src/models/SfvbThemeJobResponse.ts

@@ -86,7 +86,7 @@ export interface SfvbThemeJobResponse {
      */
     success?: boolean;
     /**
-     * Path the new theme was created at.  Returned when the job is started; the theme oid itself is NOT returned, because the job's product is a plain text report rather than a structured result.  Once the job completes, list themes and match on this path.
+     * Path the new theme is being created at.  Returned when the job is started and on every poll, so you do not have to keep the response that started it.  The theme oid itself is NOT returned, so once the job completes you list themes and match on this path.  It is also what success is checked against - a finished job whose theme is not here reports success false rather than pretending.
      * @type {string}
      * @memberof SfvbThemeJobResponse
      */

package/src/models/SfvbVersionResponse.ts

@@ -37,18 +37,42 @@ export interface SfvbVersionResponse {
      * @memberof SfvbVersionResponse
      */
     element_count?: number;
+    /**
+     * Largest binary asset that can be uploaded, in bytes, for every accepted type except video.
+     * @type {number}
+     * @memberof SfvbVersionResponse
+     */
+    max_asset_bytes?: number;
     /**
      * Largest CJSON document that will be parsed, in bytes.
      * @type {number}
      * @memberof SfvbVersionResponse
      */
     max_cjson_bytes?: number;
+    /**
+     * Most entries one directory listing returns.  Asking for more is silently reduced to this rather than refused, so compare against it instead of trusting that you got what you asked for.  The listing does set a truncated flag when it drops entries.
+     * @type {number}
+     * @memberof SfvbVersionResponse
+     */
+    max_directory_entries?: number;
+    /**
+     * Most element library results one page returns.  Asking for more is silently reduced to this, and unlike the directory listing there is no truncation flag on the response, so this number is the only way to know a larger request was cut.
+     * @type {number}
+     * @memberof SfvbVersionResponse
+     */
+    max_library_results_per_page?: number;
     /**
      * Largest payload one preview session may hold, in bytes.
      * @type {number}
      * @memberof SfvbVersionResponse
      */
     max_preview_session_bytes?: number;
+    /**
+     * Largest historical version files/revert will restore, in bytes.  Higher than max_text_read_bytes deliberately - putting back a version that is already stored is cheaper than serving it as JSON, so a version too large to read can still be reverted to.
+     * @type {number}
+     * @memberof SfvbVersionResponse
+     */
+    max_revertable_bytes?: number;
     /**
      * Hard ceiling on file search results per page.
      * @type {number}
@@ -56,11 +80,23 @@ export interface SfvbVersionResponse {
      */
     max_search_results?: number;
     /**
-     * Largest template file that can be written, in bytes.
+     * Largest .vm template that can be written, in bytes.  Narrow on purpose - it gates writes, only for files ending in .vm, and it is not the ceiling on reading a file back.  Use max_text_read_bytes for that.
      * @type {number}
      * @memberof SfvbVersionResponse
      */
     max_template_bytes?: number;
+    /**
+     * Largest file files/content will return as text, in bytes.  A file above this is refused with sfvb.too_large however small its history versions are.  Bigger than max_template_bytes, so a file can be readable here and still be too large to write back as a template.  Anything above this is still readable in full through files/download, which returns raw bytes and applies no ceiling.
+     * @type {number}
+     * @memberof SfvbVersionResponse
+     */
+    max_text_read_bytes?: number;
+    /**
+     * Largest video that can be uploaded, in bytes.  Video is the one type allowed past max_asset_bytes.
+     * @type {number}
+     * @memberof SfvbVersionResponse
+     */
+    max_video_bytes?: number;
     /**
      * Most widget ids that can be reserved in one call.
      * @type {number}
@@ -116,10 +152,16 @@ export function SfvbVersionResponseFromJSONTyped(json: any, ignoreDiscriminator:
         'container_manager_version': !exists(json, 'container_manager_version') ? undefined : json['container_manager_version'],
         'container_versions_retained': !exists(json, 'container_versions_retained') ? undefined : json['container_versions_retained'],
         'element_count': !exists(json, 'element_count') ? undefined : json['element_count'],
+        'max_asset_bytes': !exists(json, 'max_asset_bytes') ? undefined : json['max_asset_bytes'],
         'max_cjson_bytes': !exists(json, 'max_cjson_bytes') ? undefined : json['max_cjson_bytes'],
+        'max_directory_entries': !exists(json, 'max_directory_entries') ? undefined : json['max_directory_entries'],
+        'max_library_results_per_page': !exists(json, 'max_library_results_per_page') ? undefined : json['max_library_results_per_page'],
         'max_preview_session_bytes': !exists(json, 'max_preview_session_bytes') ? undefined : json['max_preview_session_bytes'],
+        'max_revertable_bytes': !exists(json, 'max_revertable_bytes') ? undefined : json['max_revertable_bytes'],
         'max_search_results': !exists(json, 'max_search_results') ? undefined : json['max_search_results'],
         'max_template_bytes': !exists(json, 'max_template_bytes') ? undefined : json['max_template_bytes'],
+        'max_text_read_bytes': !exists(json, 'max_text_read_bytes') ? undefined : json['max_text_read_bytes'],
+        'max_video_bytes': !exists(json, 'max_video_bytes') ? undefined : json['max_video_bytes'],
         'max_widget_ids_per_request': !exists(json, 'max_widget_ids_per_request') ? undefined : json['max_widget_ids_per_request'],
         'preview_session_ttl_seconds': !exists(json, 'preview_session_ttl_seconds') ? undefined : json['preview_session_ttl_seconds'],
         'release': !exists(json, 'release') ? undefined : json['release'],
@@ -138,10 +180,16 @@ export function SfvbVersionResponseToJSON(value?: SfvbVersionResponse | null): a
         'container_manager_version': value.container_manager_version,
         'container_versions_retained': value.container_versions_retained,
         'element_count': value.element_count,
+        'max_asset_bytes': value.max_asset_bytes,
         'max_cjson_bytes': value.max_cjson_bytes,
+        'max_directory_entries': value.max_directory_entries,
+        'max_library_results_per_page': value.max_library_results_per_page,
         'max_preview_session_bytes': value.max_preview_session_bytes,
+        'max_revertable_bytes': value.max_revertable_bytes,
         'max_search_results': value.max_search_results,
         'max_template_bytes': value.max_template_bytes,
+        'max_text_read_bytes': value.max_text_read_bytes,
+        'max_video_bytes': value.max_video_bytes,
         'max_widget_ids_per_request': value.max_widget_ids_per_request,
         'preview_session_ttl_seconds': value.preview_session_ttl_seconds,
         'release': value.release,

package/src/models/index.ts

@@ -321,6 +321,7 @@ export * from './ConversationVirtualAgentBudget';
 export * from './ConversationVirtualAgentBudgetResponse';
 export * from './ConversationVirtualAgentCapabilities';
 export * from './ConversationVirtualAgentCapabilitiesResponse';
+export * from './ConversationVirtualAgentCapabilityCustomCollection';
 export * from './ConversationVirtualAgentCapabilityZohoDeskDepartment';
 export * from './ConversationWebchatContext';
 export * from './ConversationWebchatQueueStatus';