ultracart_rest_api_v2_typescript 4.1.147 → 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.147
+## 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.147 --save
+npm install ultracart_rest_api_v2_typescript@4.1.148 --save
 ```
 
 ```typescript
@@ -85,6 +85,7 @@ 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 |

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/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.147",
+  "version": "4.1.148",
   "description": "UltraCart Rest TypeScript SDK",
   "author": "UltraCart",
   "repository": {

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/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';