ultracart_rest_api_v2_typescript 4.1.149 → 4.1.151

package/.openapi-generator/FILES

@@ -206,6 +206,9 @@ src/models/ConversationAgentStatusRollupSearchRequest.ts
 src/models/ConversationAgentStatusRollupSearchResponse.ts
 src/models/ConversationAgentStatusSummaryResponse.ts
 src/models/ConversationAgentStatusTimelineResponse.ts
+src/models/ConversationAgentTestSessionJoinRequest.ts
+src/models/ConversationAgentTestSessionRequest.ts
+src/models/ConversationAgentTestSessionResponse.ts
 src/models/ConversationAutocompleteRequest.ts
 src/models/ConversationAutocompleteResponse.ts
 src/models/ConversationAutocompleteValue.ts
@@ -213,6 +216,7 @@ src/models/ConversationCannedMessage.ts
 src/models/ConversationCannedMessageResponse.ts
 src/models/ConversationCannedMessagesResponse.ts
 src/models/ConversationCannedMessagesSearch.ts
+src/models/ConversationCustomerAuth.ts
 src/models/ConversationDeleteKnowledgeBaseDocumentResponse.ts
 src/models/ConversationDepartment.ts
 src/models/ConversationDepartmentMember.ts

package/README.md

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

package/dist/apis/ConversationApi.d.ts

@@ -10,7 +10,7 @@
  * Do not edit the class manually.
  */
 import * as runtime from '../runtime';
-import { BaseResponse, ConversationAgentAuthResponse, ConversationAgentProfile, ConversationAgentProfileResponse, ConversationAgentProfilesResponse, ConversationAgentStatusConfig, ConversationAgentStatusConfigResponse, ConversationAgentStatusConfigsResponse, ConversationAgentStatusHeatmapRequest, ConversationAgentStatusHeatmapResponse, ConversationAgentStatusHistorySearchRequest, ConversationAgentStatusHistorySearchResponse, ConversationAgentStatusRollupSearchRequest, ConversationAgentStatusRollupSearchResponse, ConversationAgentStatusSummaryResponse, ConversationAgentStatusTimelineResponse, ConversationAutocompleteRequest, ConversationAutocompleteResponse, ConversationCannedMessage, ConversationCannedMessageResponse, ConversationCannedMessagesResponse, ConversationCannedMessagesSearch, ConversationDeleteKnowledgeBaseDocumentResponse, ConversationDepartment, ConversationDepartmentMembersResponse, ConversationDepartmentResponse, ConversationDepartmentsResponse, ConversationEngagement, ConversationEngagementResponse, ConversationEngagementsResponse, ConversationInsertKnowledgeBaseDocumentRequest, ConversationInsertKnowledgeBaseDocumentResponse, ConversationJoinRequest, ConversationKnowledgeBaseDocumentUploadUrlResponse, ConversationKnowledgeBaseDocumentsResponse, ConversationLocationsResponse, ConversationMcpServer, ConversationMcpServerResponse, ConversationMcpServerToolsResponse, ConversationMcpServersResponse, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationPbxAddress, ConversationPbxAddressResponse, ConversationPbxAddressesResponse, ConversationPbxAgent, ConversationPbxAgentResponse, ConversationPbxAgentsResponse, ConversationPbxAudio, ConversationPbxAudioResponse, ConversationPbxAudioUploadUrlResponse, ConversationPbxAudioUsageResponse, ConversationPbxAudiosResponse, ConversationPbxAvailablePhoneNumbersResponse, ConversationPbxCallResponse, ConversationPbxCallSearchRequest, ConversationPbxCallSearchResponse, ConversationPbxCallUpdateRequest, ConversationPbxClassOfService, ConversationPbxClassOfServiceResponse, ConversationPbxClassOfServicesResponse, ConversationPbxCosAuditLogsResponse, ConversationPbxCustomerSnapshotRequest, ConversationPbxCustomerSnapshotResponse, ConversationPbxDefaultTimezoneResponse, ConversationPbxDefaultTimezoneUpdateRequest, ConversationPbxHardwarePhone, ConversationPbxHardwarePhoneResponse, ConversationPbxHardwarePhonesResponse, ConversationPbxMenu, ConversationPbxMenuResponse, ConversationPbxMenusResponse, ConversationPbxPayConnectorsResponse, ConversationPbxPhoneManufacturersResponse, ConversationPbxPhoneNumber, ConversationPbxPhoneNumberPurchaseRequest, ConversationPbxPhoneNumberResponse, ConversationPbxPhoneNumbersResponse, ConversationPbxQueue, ConversationPbxQueueResponse, ConversationPbxQueuesResponse, ConversationPbxTimeBased, ConversationPbxTimeBasedResponse, ConversationPbxTimeBasedsResponse, ConversationPbxTimeRange, ConversationPbxTimeRangeResponse, ConversationPbxTimeRangesResponse, ConversationPbxVoicemailCapabilitiesResponse, ConversationPbxVoicemailMailbox, ConversationPbxVoicemailMailboxResponse, ConversationPbxVoicemailMailboxesResponse, ConversationPbxVoicemailMessageResponse, ConversationPbxVoicemailMessageSummariesResponse, ConversationPermissionsResponse, ConversationResponse, ConversationSearchRequest, ConversationSearchResponse, ConversationStartRequest, ConversationStartResponse, ConversationVirtualAgentBudget, ConversationVirtualAgentBudgetResponse, ConversationVirtualAgentCapabilities, ConversationVirtualAgentCapabilitiesResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse, ItemResponse } from '../models';
+import { BaseResponse, ConversationAgentAuthResponse, ConversationAgentProfile, ConversationAgentProfileResponse, ConversationAgentProfilesResponse, ConversationAgentStatusConfig, ConversationAgentStatusConfigResponse, ConversationAgentStatusConfigsResponse, ConversationAgentStatusHeatmapRequest, ConversationAgentStatusHeatmapResponse, ConversationAgentStatusHistorySearchRequest, ConversationAgentStatusHistorySearchResponse, ConversationAgentStatusRollupSearchRequest, ConversationAgentStatusRollupSearchResponse, ConversationAgentStatusSummaryResponse, ConversationAgentStatusTimelineResponse, ConversationAgentTestSessionJoinRequest, ConversationAgentTestSessionRequest, ConversationAgentTestSessionResponse, ConversationAutocompleteRequest, ConversationAutocompleteResponse, ConversationCannedMessage, ConversationCannedMessageResponse, ConversationCannedMessagesResponse, ConversationCannedMessagesSearch, ConversationDeleteKnowledgeBaseDocumentResponse, ConversationDepartment, ConversationDepartmentMembersResponse, ConversationDepartmentResponse, ConversationDepartmentsResponse, ConversationEngagement, ConversationEngagementResponse, ConversationEngagementsResponse, ConversationInsertKnowledgeBaseDocumentRequest, ConversationInsertKnowledgeBaseDocumentResponse, ConversationJoinRequest, ConversationKnowledgeBaseDocumentUploadUrlResponse, ConversationKnowledgeBaseDocumentsResponse, ConversationLocationsResponse, ConversationMcpServer, ConversationMcpServerResponse, ConversationMcpServerToolsResponse, ConversationMcpServersResponse, ConversationMessagesResponse, ConversationMultimediaUploadUrlResponse, ConversationPbxAddress, ConversationPbxAddressResponse, ConversationPbxAddressesResponse, ConversationPbxAgent, ConversationPbxAgentResponse, ConversationPbxAgentsResponse, ConversationPbxAudio, ConversationPbxAudioResponse, ConversationPbxAudioUploadUrlResponse, ConversationPbxAudioUsageResponse, ConversationPbxAudiosResponse, ConversationPbxAvailablePhoneNumbersResponse, ConversationPbxCallResponse, ConversationPbxCallSearchRequest, ConversationPbxCallSearchResponse, ConversationPbxCallUpdateRequest, ConversationPbxClassOfService, ConversationPbxClassOfServiceResponse, ConversationPbxClassOfServicesResponse, ConversationPbxCosAuditLogsResponse, ConversationPbxCustomerSnapshotRequest, ConversationPbxCustomerSnapshotResponse, ConversationPbxDefaultTimezoneResponse, ConversationPbxDefaultTimezoneUpdateRequest, ConversationPbxHardwarePhone, ConversationPbxHardwarePhoneResponse, ConversationPbxHardwarePhonesResponse, ConversationPbxMenu, ConversationPbxMenuResponse, ConversationPbxMenusResponse, ConversationPbxPayConnectorsResponse, ConversationPbxPhoneManufacturersResponse, ConversationPbxPhoneNumber, ConversationPbxPhoneNumberPurchaseRequest, ConversationPbxPhoneNumberResponse, ConversationPbxPhoneNumbersResponse, ConversationPbxQueue, ConversationPbxQueueResponse, ConversationPbxQueuesResponse, ConversationPbxTimeBased, ConversationPbxTimeBasedResponse, ConversationPbxTimeBasedsResponse, ConversationPbxTimeRange, ConversationPbxTimeRangeResponse, ConversationPbxTimeRangesResponse, ConversationPbxVoicemailCapabilitiesResponse, ConversationPbxVoicemailMailbox, ConversationPbxVoicemailMailboxResponse, ConversationPbxVoicemailMailboxesResponse, ConversationPbxVoicemailMessageResponse, ConversationPbxVoicemailMessageSummariesResponse, ConversationPermissionsResponse, ConversationResponse, ConversationSearchRequest, ConversationSearchResponse, ConversationStartRequest, ConversationStartResponse, ConversationVirtualAgentBudget, ConversationVirtualAgentBudgetResponse, ConversationVirtualAgentCapabilities, ConversationVirtualAgentCapabilitiesResponse, ConversationWebchatContext, ConversationWebchatQueueStatusUpdateRequest, ConversationWebchatQueueStatusesResponse, ConversationsResponse, ItemResponse } from '../models';
 export interface DeleteAgentProfileKnowledgeBaseDocumentRequest {
     userId: number;
     documentUuid: string;
@@ -252,6 +252,11 @@ export interface InsertPbxVoicemailMailboxRequest {
 export interface InsertUserPbxAudioRequest {
     pbxAudio: ConversationPbxAudio;
 }
+export interface JoinAgentTestSessionRequest {
+    userId: number;
+    conversationUuid: string;
+    joinRequest: ConversationAgentTestSessionJoinRequest;
+}
 export interface JoinConversationRequest {
     conversationUuid: string;
     joinRequest?: ConversationJoinRequest;
@@ -311,6 +316,10 @@ export interface SearchPbxCallsRequest {
 export interface SmsUnsubscribeConversationRequest {
     conversationUuid: string;
 }
+export interface StartAgentTestSessionRequest {
+    userId: number;
+    testSessionRequest: ConversationAgentTestSessionRequest;
+}
 export interface StartConversationRequest {
     startRequest: ConversationStartRequest;
 }
@@ -1846,6 +1855,22 @@ export interface ConversationApiInterface {
      * Insert user pbx audio
      */
     insertUserPbxAudio(requestParameters: InsertUserPbxAudioRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAudioResponse>;
+    /**
+     * Joins the simulated customer to the conversation the agent opened for a test session.  This mirrors what the storefront webchat widget does after an agent picks up its queue entry, and it is what gives the conversation a customer participant.  Requires a logged in user with conversations admin; an API key or OAuth application cannot call this.
+     * @summary Join a test conversation as the simulated customer
+     * @param {number} userId
+     * @param {string} conversationUuid
+     * @param {ConversationAgentTestSessionJoinRequest} joinRequest Test session join request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    joinAgentTestSessionRaw(requestParameters: JoinAgentTestSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Joins the simulated customer to the conversation the agent opened for a test session.  This mirrors what the storefront webchat widget does after an agent picks up its queue entry, and it is what gives the conversation a customer participant.  Requires a logged in user with conversations admin; an API key or OAuth application cannot call this.
+     * Join a test conversation as the simulated customer
+     */
+    joinAgentTestSession(requestParameters: JoinAgentTestSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Join a conversation
      * @summary Join a conversation
@@ -2070,6 +2095,21 @@ export interface ConversationApiInterface {
      * Unsubscribe any SMS participants in this conversation
      */
     smsUnsubscribeConversation(requestParameters: SmsUnsubscribeConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Opens a webchat conversation against this specific AI agent as if the given customer had started it from the storefront, so the agent can be tried out before it is put in front of anyone.  The session runs against live data: the cart is real, the customer is real, and anything the agent does during the conversation actually happens.  Requires a logged in user with conversations admin; an API key or OAuth application cannot call this.
+     * @summary Start a test conversation with this AI agent
+     * @param {number} userId
+     * @param {ConversationAgentTestSessionRequest} testSessionRequest Test session request
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    startAgentTestSessionRaw(requestParameters: StartAgentTestSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentTestSessionResponse>>;
+    /**
+     * Opens a webchat conversation against this specific AI agent as if the given customer had started it from the storefront, so the agent can be tried out before it is put in front of anyone.  The session runs against live data: the cart is real, the customer is real, and anything the agent does during the conversation actually happens.  Requires a logged in user with conversations admin; an API key or OAuth application cannot call this.
+     * Start a test conversation with this AI agent
+     */
+    startAgentTestSession(requestParameters: StartAgentTestSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentTestSessionResponse>;
     /**
      * Start a new conversation
      * @summary Start a conversation
@@ -3461,6 +3501,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Insert user pbx audio
      */
     insertUserPbxAudio(requestParameters: InsertUserPbxAudioRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationPbxAudioResponse>;
+    /**
+     * Joins the simulated customer to the conversation the agent opened for a test session.  This mirrors what the storefront webchat widget does after an agent picks up its queue entry, and it is what gives the conversation a customer participant.  Requires a logged in user with conversations admin; an API key or OAuth application cannot call this.
+     * Join a test conversation as the simulated customer
+     */
+    joinAgentTestSessionRaw(requestParameters: JoinAgentTestSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Joins the simulated customer to the conversation the agent opened for a test session.  This mirrors what the storefront webchat widget does after an agent picks up its queue entry, and it is what gives the conversation a customer participant.  Requires a logged in user with conversations admin; an API key or OAuth application cannot call this.
+     * Join a test conversation as the simulated customer
+     */
+    joinAgentTestSession(requestParameters: JoinAgentTestSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
     /**
      * Join a conversation
      * Join a conversation
@@ -3611,6 +3661,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Unsubscribe any SMS participants in this conversation
      */
     smsUnsubscribeConversation(requestParameters: SmsUnsubscribeConversationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Opens a webchat conversation against this specific AI agent as if the given customer had started it from the storefront, so the agent can be tried out before it is put in front of anyone.  The session runs against live data: the cart is real, the customer is real, and anything the agent does during the conversation actually happens.  Requires a logged in user with conversations admin; an API key or OAuth application cannot call this.
+     * Start a test conversation with this AI agent
+     */
+    startAgentTestSessionRaw(requestParameters: StartAgentTestSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationAgentTestSessionResponse>>;
+    /**
+     * Opens a webchat conversation against this specific AI agent as if the given customer had started it from the storefront, so the agent can be tried out before it is put in front of anyone.  The session runs against live data: the cart is real, the customer is real, and anything the agent does during the conversation actually happens.  Requires a logged in user with conversations admin; an API key or OAuth application cannot call this.
+     * Start a test conversation with this AI agent
+     */
+    startAgentTestSession(requestParameters: StartAgentTestSessionRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentTestSessionResponse>;
     /**
      * Start a new conversation
      * Start a conversation

package/dist/apis/ConversationApi.js

@@ -6167,6 +6167,71 @@ var ConversationApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Joins the simulated customer to the conversation the agent opened for a test session.  This mirrors what the storefront webchat widget does after an agent picks up its queue entry, and it is what gives the conversation a customer participant.  Requires a logged in user with conversations admin; an API key or OAuth application cannot call this.
+     * Join a test conversation as the simulated customer
+     */
+    ConversationApi.prototype.joinAgentTestSessionRaw = 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.userId === null || requestParameters.userId === undefined) {
+                            throw new runtime.RequiredError('userId', 'Required parameter requestParameters.userId was null or undefined when calling joinAgentTestSession.');
+                        }
+                        if (requestParameters.conversationUuid === null || requestParameters.conversationUuid === undefined) {
+                            throw new runtime.RequiredError('conversationUuid', 'Required parameter requestParameters.conversationUuid was null or undefined when calling joinAgentTestSession.');
+                        }
+                        if (requestParameters.joinRequest === null || requestParameters.joinRequest === undefined) {
+                            throw new runtime.RequiredError('joinRequest', 'Required parameter requestParameters.joinRequest was null or undefined when calling joinAgentTestSession.');
+                        }
+                        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", ["conversation_write"])];
+                    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: "/conversation/agent/profiles/{user_id}/test_session/{conversation_uuid}/join".replace("{".concat("user_id", "}"), encodeURIComponent(String(requestParameters.userId))).replace("{".concat("conversation_uuid", "}"), encodeURIComponent(String(requestParameters.conversationUuid))),
+                                method: 'PUT',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.ConversationAgentTestSessionJoinRequestToJSON)(requestParameters.joinRequest),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.VoidApiResponse(response)];
+                }
+            });
+        });
+    };
+    /**
+     * Joins the simulated customer to the conversation the agent opened for a test session.  This mirrors what the storefront webchat widget does after an agent picks up its queue entry, and it is what gives the conversation a customer participant.  Requires a logged in user with conversations admin; an API key or OAuth application cannot call this.
+     * Join a test conversation as the simulated customer
+     */
+    ConversationApi.prototype.joinAgentTestSession = function (requestParameters, initOverrides) {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, this.joinAgentTestSessionRaw(requestParameters, initOverrides)];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
     /**
      * Join a conversation
      * Join a conversation
@@ -7094,6 +7159,70 @@ var ConversationApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Opens a webchat conversation against this specific AI agent as if the given customer had started it from the storefront, so the agent can be tried out before it is put in front of anyone.  The session runs against live data: the cart is real, the customer is real, and anything the agent does during the conversation actually happens.  Requires a logged in user with conversations admin; an API key or OAuth application cannot call this.
+     * Start a test conversation with this AI agent
+     */
+    ConversationApi.prototype.startAgentTestSessionRaw = 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.userId === null || requestParameters.userId === undefined) {
+                            throw new runtime.RequiredError('userId', 'Required parameter requestParameters.userId was null or undefined when calling startAgentTestSession.');
+                        }
+                        if (requestParameters.testSessionRequest === null || requestParameters.testSessionRequest === undefined) {
+                            throw new runtime.RequiredError('testSessionRequest', 'Required parameter requestParameters.testSessionRequest was null or undefined when calling startAgentTestSession.');
+                        }
+                        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", ["conversation_write"])];
+                    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: "/conversation/agent/profiles/{user_id}/test_session".replace("{".concat("user_id", "}"), encodeURIComponent(String(requestParameters.userId))),
+                                method: 'PUT',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.ConversationAgentTestSessionRequestToJSON)(requestParameters.testSessionRequest),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ConversationAgentTestSessionResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Opens a webchat conversation against this specific AI agent as if the given customer had started it from the storefront, so the agent can be tried out before it is put in front of anyone.  The session runs against live data: the cart is real, the customer is real, and anything the agent does during the conversation actually happens.  Requires a logged in user with conversations admin; an API key or OAuth application cannot call this.
+     * Start a test conversation with this AI agent
+     */
+    ConversationApi.prototype.startAgentTestSession = 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.startAgentTestSessionRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Start a new conversation
      * Start a conversation

package/dist/models/ConversationAgentTestSessionJoinRequest.d.ts

@@ -0,0 +1,31 @@
+/**
+ * UltraCart Rest API V2
+ * UltraCart REST API Version 2
+ *
+ * The version of the OpenAPI document: 2.0.0
+ * Contact: support@ultracart.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+/**
+ *
+ * @export
+ * @interface ConversationAgentTestSessionJoinRequest
+ */
+export interface ConversationAgentTestSessionJoinRequest {
+    /**
+     * Queue entry uuid returned when the test session was started
+     * @type {string}
+     * @memberof ConversationAgentTestSessionJoinRequest
+     */
+    conversation_webchat_queue_uuid?: string;
+}
+/**
+ * Check if a given object implements the ConversationAgentTestSessionJoinRequest interface.
+ */
+export declare function instanceOfConversationAgentTestSessionJoinRequest(value: object): boolean;
+export declare function ConversationAgentTestSessionJoinRequestFromJSON(json: any): ConversationAgentTestSessionJoinRequest;
+export declare function ConversationAgentTestSessionJoinRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationAgentTestSessionJoinRequest;
+export declare function ConversationAgentTestSessionJoinRequestToJSON(value?: ConversationAgentTestSessionJoinRequest | null): any;

package/dist/models/ConversationAgentTestSessionJoinRequest.js

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

package/dist/models/ConversationAgentTestSessionRequest.d.ts

@@ -0,0 +1,49 @@
+/**
+ * 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 ConversationAgentTestSessionRequest
+ */
+export interface ConversationAgentTestSessionRequest {
+    /**
+     * Customer profile to converse as.  The cart is established as a soft login for this customer, so the agent sees their real order history.
+     * @type {number}
+     * @memberof ConversationAgentTestSessionRequest
+     */
+    customer_profile_oid?: number;
+    /**
+     * Optional opening question, the same way a customer types one before joining the queue.
+     * @type {string}
+     * @memberof ConversationAgentTestSessionRequest
+     */
+    question?: string;
+    /**
+     * Webchat queue to join.  The agent is selected explicitly, so this does not have to be a queue the agent is assigned to.
+     * @type {string}
+     * @memberof ConversationAgentTestSessionRequest
+     */
+    queue_name?: string;
+    /**
+     * Host name of the storefront to test against, with no protocol prefix.  Determines which catalog the agent searches.
+     * @type {string}
+     * @memberof ConversationAgentTestSessionRequest
+     */
+    storefront_host_name?: string;
+}
+/**
+ * Check if a given object implements the ConversationAgentTestSessionRequest interface.
+ */
+export declare function instanceOfConversationAgentTestSessionRequest(value: object): boolean;
+export declare function ConversationAgentTestSessionRequestFromJSON(json: any): ConversationAgentTestSessionRequest;
+export declare function ConversationAgentTestSessionRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationAgentTestSessionRequest;
+export declare function ConversationAgentTestSessionRequestToJSON(value?: ConversationAgentTestSessionRequest | null): any;

package/dist/models/ConversationAgentTestSessionRequest.js

@@ -0,0 +1,56 @@
+"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.ConversationAgentTestSessionRequestToJSON = exports.ConversationAgentTestSessionRequestFromJSONTyped = exports.ConversationAgentTestSessionRequestFromJSON = exports.instanceOfConversationAgentTestSessionRequest = void 0;
+var runtime_1 = require("../runtime");
+/**
+ * Check if a given object implements the ConversationAgentTestSessionRequest interface.
+ */
+function instanceOfConversationAgentTestSessionRequest(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfConversationAgentTestSessionRequest = instanceOfConversationAgentTestSessionRequest;
+function ConversationAgentTestSessionRequestFromJSON(json) {
+    return ConversationAgentTestSessionRequestFromJSONTyped(json, false);
+}
+exports.ConversationAgentTestSessionRequestFromJSON = ConversationAgentTestSessionRequestFromJSON;
+function ConversationAgentTestSessionRequestFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'customer_profile_oid': !(0, runtime_1.exists)(json, 'customer_profile_oid') ? undefined : json['customer_profile_oid'],
+        'question': !(0, runtime_1.exists)(json, 'question') ? undefined : json['question'],
+        'queue_name': !(0, runtime_1.exists)(json, 'queue_name') ? undefined : json['queue_name'],
+        'storefront_host_name': !(0, runtime_1.exists)(json, 'storefront_host_name') ? undefined : json['storefront_host_name'],
+    };
+}
+exports.ConversationAgentTestSessionRequestFromJSONTyped = ConversationAgentTestSessionRequestFromJSONTyped;
+function ConversationAgentTestSessionRequestToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'customer_profile_oid': value.customer_profile_oid,
+        'question': value.question,
+        'queue_name': value.queue_name,
+        'storefront_host_name': value.storefront_host_name,
+    };
+}
+exports.ConversationAgentTestSessionRequestToJSON = ConversationAgentTestSessionRequestToJSON;

package/dist/models/ConversationAgentTestSessionResponse.d.ts

@@ -0,0 +1,77 @@
+/**
+ * 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 { ConversationCustomerAuth } from './ConversationCustomerAuth';
+import { ModelError } from './ModelError';
+import { ResponseMetadata } from './ResponseMetadata';
+import { Warning } from './Warning';
+/**
+ *
+ * @export
+ * @interface ConversationAgentTestSessionResponse
+ */
+export interface ConversationAgentTestSessionResponse {
+    /**
+     * Cart established for this session, soft logged in as the chosen customer profile.  Real, and anything the agent adds to it persists.
+     * @type {string}
+     * @memberof ConversationAgentTestSessionResponse
+     */
+    cart_id?: string;
+    /**
+     * Queue entry created for this session
+     * @type {string}
+     * @memberof ConversationAgentTestSessionResponse
+     */
+    conversation_webchat_queue_uuid?: string;
+    /**
+     *
+     * @type {ConversationCustomerAuth}
+     * @memberof ConversationAgentTestSessionResponse
+     */
+    customer_auth?: ConversationCustomerAuth;
+    /**
+     *
+     * @type {ModelError}
+     * @memberof ConversationAgentTestSessionResponse
+     */
+    error?: ModelError;
+    /**
+     *
+     * @type {ResponseMetadata}
+     * @memberof ConversationAgentTestSessionResponse
+     */
+    metadata?: ResponseMetadata;
+    /**
+     * Storefront the session is running against
+     * @type {string}
+     * @memberof ConversationAgentTestSessionResponse
+     */
+    storefront_host_name?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof ConversationAgentTestSessionResponse
+     */
+    success?: boolean;
+    /**
+     *
+     * @type {Warning}
+     * @memberof ConversationAgentTestSessionResponse
+     */
+    warning?: Warning;
+}
+/**
+ * Check if a given object implements the ConversationAgentTestSessionResponse interface.
+ */
+export declare function instanceOfConversationAgentTestSessionResponse(value: object): boolean;
+export declare function ConversationAgentTestSessionResponseFromJSON(json: any): ConversationAgentTestSessionResponse;
+export declare function ConversationAgentTestSessionResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): ConversationAgentTestSessionResponse;
+export declare function ConversationAgentTestSessionResponseToJSON(value?: ConversationAgentTestSessionResponse | null): any;

package/dist/models/ConversationAgentTestSessionResponse.js

@@ -0,0 +1,68 @@
+"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.ConversationAgentTestSessionResponseToJSON = exports.ConversationAgentTestSessionResponseFromJSONTyped = exports.ConversationAgentTestSessionResponseFromJSON = exports.instanceOfConversationAgentTestSessionResponse = void 0;
+var runtime_1 = require("../runtime");
+var ConversationCustomerAuth_1 = require("./ConversationCustomerAuth");
+var ModelError_1 = require("./ModelError");
+var ResponseMetadata_1 = require("./ResponseMetadata");
+var Warning_1 = require("./Warning");
+/**
+ * Check if a given object implements the ConversationAgentTestSessionResponse interface.
+ */
+function instanceOfConversationAgentTestSessionResponse(value) {
+    var isInstance = true;
+    return isInstance;
+}
+exports.instanceOfConversationAgentTestSessionResponse = instanceOfConversationAgentTestSessionResponse;
+function ConversationAgentTestSessionResponseFromJSON(json) {
+    return ConversationAgentTestSessionResponseFromJSONTyped(json, false);
+}
+exports.ConversationAgentTestSessionResponseFromJSON = ConversationAgentTestSessionResponseFromJSON;
+function ConversationAgentTestSessionResponseFromJSONTyped(json, ignoreDiscriminator) {
+    if ((json === undefined) || (json === null)) {
+        return json;
+    }
+    return {
+        'cart_id': !(0, runtime_1.exists)(json, 'cart_id') ? undefined : json['cart_id'],
+        'conversation_webchat_queue_uuid': !(0, runtime_1.exists)(json, 'conversation_webchat_queue_uuid') ? undefined : json['conversation_webchat_queue_uuid'],
+        'customer_auth': !(0, runtime_1.exists)(json, 'customer_auth') ? undefined : (0, ConversationCustomerAuth_1.ConversationCustomerAuthFromJSON)(json['customer_auth']),
+        'error': !(0, runtime_1.exists)(json, 'error') ? undefined : (0, ModelError_1.ModelErrorFromJSON)(json['error']),
+        'metadata': !(0, runtime_1.exists)(json, 'metadata') ? undefined : (0, ResponseMetadata_1.ResponseMetadataFromJSON)(json['metadata']),
+        'storefront_host_name': !(0, runtime_1.exists)(json, 'storefront_host_name') ? undefined : json['storefront_host_name'],
+        'success': !(0, runtime_1.exists)(json, 'success') ? undefined : json['success'],
+        'warning': !(0, runtime_1.exists)(json, 'warning') ? undefined : (0, Warning_1.WarningFromJSON)(json['warning']),
+    };
+}
+exports.ConversationAgentTestSessionResponseFromJSONTyped = ConversationAgentTestSessionResponseFromJSONTyped;
+function ConversationAgentTestSessionResponseToJSON(value) {
+    if (value === undefined) {
+        return undefined;
+    }
+    if (value === null) {
+        return null;
+    }
+    return {
+        'cart_id': value.cart_id,
+        'conversation_webchat_queue_uuid': value.conversation_webchat_queue_uuid,
+        'customer_auth': (0, ConversationCustomerAuth_1.ConversationCustomerAuthToJSON)(value.customer_auth),
+        'error': (0, ModelError_1.ModelErrorToJSON)(value.error),
+        'metadata': (0, ResponseMetadata_1.ResponseMetadataToJSON)(value.metadata),
+        'storefront_host_name': value.storefront_host_name,
+        'success': value.success,
+        'warning': (0, Warning_1.WarningToJSON)(value.warning),
+    };
+}
+exports.ConversationAgentTestSessionResponseToJSON = ConversationAgentTestSessionResponseToJSON;