ultracart_rest_api_v2_typescript 4.1.31 → 4.1.33

package/README.md

@@ -1,12 +1,12 @@
 # UltraCart Typescript SDK
-## ultracart_rest_api_v2_typescript@4.1.31
+## ultracart_rest_api_v2_typescript@4.1.33
 
 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.31 --save
+npm install ultracart_rest_api_v2_typescript@4.1.33 --save
 ```
 
 ```typescript
@@ -85,6 +85,8 @@ Not every change is committed to every SDK.
 
 | Version | Date | Comments |
 | --: | :-: | --- |
+| 4.1.33 | 11/26/2025 | conversation - AI agent profile fields |
+| 4.1.32 | 11/20/2025 | conversion api bug fix on incorrect signature |
 | 4.1.31 | 11/20/2025 | conversation - AI agent mcp server tools function |
 | 4.1.30 | 11/19/2025 | conversation - AI agent MCP server configuration methods |
 | 4.1.29 | 11/13/2025 | conversations - AI capabilities flag for generate coupon |

package/dist/apis/ConversationApi.d.ts

@@ -211,6 +211,11 @@ export interface StartConversationRequest {
 export interface UpdateAgentProfileRequest {
     profileRequest: ConversationAgentProfile;
 }
+export interface UpdateAgentProfileMcpRequest {
+    userId: number;
+    mcpServerUuid: string;
+    mcpServer: ConversationMcpServer;
+}
 export interface UpdateConversationCannedMessageRequest {
     conversationCannedMessageOid: number;
     cannedMessage: ConversationCannedMessage;
@@ -1429,6 +1434,22 @@ export interface ConversationApiInterface {
      * Update agent profile
      */
     updateAgentProfile(requestParameters: UpdateAgentProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentProfileResponse>;
+    /**
+     * Update an agent MCP server
+     * @summary Update an agent MCP server
+     * @param {number} userId
+     * @param {string} mcpServerUuid
+     * @param {ConversationMcpServer} mcpServer MCP Server
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    updateAgentProfileMcpRaw(requestParameters: UpdateAgentProfileMcpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationMcpServerResponse>>;
+    /**
+     * Update an agent MCP server
+     * Update an agent MCP server
+     */
+    updateAgentProfileMcp(requestParameters: UpdateAgentProfileMcpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationMcpServerResponse>;
     /**
      * Update a canned message
      * @summary Update a canned message
@@ -2472,6 +2493,16 @@ export declare class ConversationApi extends runtime.BaseAPI implements Conversa
      * Update agent profile
      */
     updateAgentProfile(requestParameters: UpdateAgentProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentProfileResponse>;
+    /**
+     * Update an agent MCP server
+     * Update an agent MCP server
+     */
+    updateAgentProfileMcpRaw(requestParameters: UpdateAgentProfileMcpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationMcpServerResponse>>;
+    /**
+     * Update an agent MCP server
+     * Update an agent MCP server
+     */
+    updateAgentProfileMcp(requestParameters: UpdateAgentProfileMcpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationMcpServerResponse>;
     /**
      * Update a canned message
      * Update a canned message

package/dist/apis/ConversationApi.js

@@ -170,7 +170,7 @@ var ConversationApi = /** @class */ (function (_super) {
                         }
                         return [4 /*yield*/, this.request({
                                 path: "/conversation/agent/profiles/{user_id}/mcps/{mcp_server_uuid}".replace("{".concat("user_id", "}"), encodeURIComponent(String(requestParameters.userId))).replace("{".concat("mcp_server_uuid", "}"), encodeURIComponent(String(requestParameters.mcpServerUuid))),
-                                method: 'POST',
+                                method: 'DELETE',
                                 headers: headerParameters,
                                 query: queryParameters,
                             }, initOverrides)];
@@ -4963,6 +4963,73 @@ var ConversationApi = /** @class */ (function (_super) {
             });
         });
     };
+    /**
+     * Update an agent MCP server
+     * Update an agent MCP server
+     */
+    ConversationApi.prototype.updateAgentProfileMcpRaw = 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 updateAgentProfileMcp.');
+                        }
+                        if (requestParameters.mcpServerUuid === null || requestParameters.mcpServerUuid === undefined) {
+                            throw new runtime.RequiredError('mcpServerUuid', 'Required parameter requestParameters.mcpServerUuid was null or undefined when calling updateAgentProfileMcp.');
+                        }
+                        if (requestParameters.mcpServer === null || requestParameters.mcpServer === undefined) {
+                            throw new runtime.RequiredError('mcpServer', 'Required parameter requestParameters.mcpServer was null or undefined when calling updateAgentProfileMcp.');
+                        }
+                        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}/mcps/{mcp_server_uuid}".replace("{".concat("user_id", "}"), encodeURIComponent(String(requestParameters.userId))).replace("{".concat("mcp_server_uuid", "}"), encodeURIComponent(String(requestParameters.mcpServerUuid))),
+                                method: 'POST',
+                                headers: headerParameters,
+                                query: queryParameters,
+                                body: (0, models_1.ConversationMcpServerToJSON)(requestParameters.mcpServer),
+                            }, initOverrides)];
+                    case 3:
+                        response = _c.sent();
+                        return [2 /*return*/, new runtime.JSONApiResponse(response, function (jsonValue) { return (0, models_1.ConversationMcpServerResponseFromJSON)(jsonValue); })];
+                }
+            });
+        });
+    };
+    /**
+     * Update an agent MCP server
+     * Update an agent MCP server
+     */
+    ConversationApi.prototype.updateAgentProfileMcp = 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.updateAgentProfileMcpRaw(requestParameters, initOverrides)];
+                    case 1:
+                        response = _a.sent();
+                        return [4 /*yield*/, response.value()];
+                    case 2: return [2 /*return*/, _a.sent()];
+                }
+            });
+        });
+    };
     /**
      * Update a canned message
      * Update a canned message

package/dist/models/ConversationAgentProfile.d.ts

@@ -39,6 +39,12 @@ export interface ConversationAgentProfile {
      * @memberof ConversationAgentProfile
      */
     ai_sms_instructions?: string;
+    /**
+     * Additional instructions for this AI when handling ticket draft replies
+     * @type {string}
+     * @memberof ConversationAgentProfile
+     */
+    ai_ticket_instructions?: string;
     /**
      * The number of engagement chats that can be pushed on them at any given time.
      * @type {number}
@@ -87,6 +93,18 @@ export interface ConversationAgentProfile {
      * @memberof ConversationAgentProfile
      */
     user_id?: number;
+    /**
+     * Restrict this agent to drafting replies only to tickets with these classifications
+     * @type {Array<string>}
+     * @memberof ConversationAgentProfile
+     */
+    zohodesk_classifications?: Array<string>;
+    /**
+     * Restrict this agent to drafting replies only to these department ids
+     * @type {Array<string>}
+     * @memberof ConversationAgentProfile
+     */
+    zohodesk_departments?: Array<string>;
 }
 /**
  * @export

package/dist/models/ConversationAgentProfile.js

@@ -44,6 +44,7 @@ function ConversationAgentProfileFromJSONTyped(json, ignoreDiscriminator) {
         'ai_chat_instructions': !(0, runtime_1.exists)(json, 'ai_chat_instructions') ? undefined : json['ai_chat_instructions'],
         'ai_persona': !(0, runtime_1.exists)(json, 'ai_persona') ? undefined : json['ai_persona'],
         'ai_sms_instructions': !(0, runtime_1.exists)(json, 'ai_sms_instructions') ? undefined : json['ai_sms_instructions'],
+        'ai_ticket_instructions': !(0, runtime_1.exists)(json, 'ai_ticket_instructions') ? undefined : json['ai_ticket_instructions'],
         'chat_limit': !(0, runtime_1.exists)(json, 'chat_limit') ? undefined : json['chat_limit'],
         'default_language_iso_code': !(0, runtime_1.exists)(json, 'default_language_iso_code') ? undefined : json['default_language_iso_code'],
         'default_status': !(0, runtime_1.exists)(json, 'default_status') ? undefined : json['default_status'],
@@ -52,6 +53,8 @@ function ConversationAgentProfileFromJSONTyped(json, ignoreDiscriminator) {
         'profile_image_upload_key': !(0, runtime_1.exists)(json, 'profile_image_upload_key') ? undefined : json['profile_image_upload_key'],
         'profile_image_url': !(0, runtime_1.exists)(json, 'profile_image_url') ? undefined : json['profile_image_url'],
         'user_id': !(0, runtime_1.exists)(json, 'user_id') ? undefined : json['user_id'],
+        'zohodesk_classifications': !(0, runtime_1.exists)(json, 'zohodesk_classifications') ? undefined : json['zohodesk_classifications'],
+        'zohodesk_departments': !(0, runtime_1.exists)(json, 'zohodesk_departments') ? undefined : json['zohodesk_departments'],
     };
 }
 exports.ConversationAgentProfileFromJSONTyped = ConversationAgentProfileFromJSONTyped;
@@ -67,6 +70,7 @@ function ConversationAgentProfileToJSON(value) {
         'ai_chat_instructions': value.ai_chat_instructions,
         'ai_persona': value.ai_persona,
         'ai_sms_instructions': value.ai_sms_instructions,
+        'ai_ticket_instructions': value.ai_ticket_instructions,
         'chat_limit': value.chat_limit,
         'default_language_iso_code': value.default_language_iso_code,
         'default_status': value.default_status,
@@ -75,6 +79,8 @@ function ConversationAgentProfileToJSON(value) {
         'profile_image_upload_key': value.profile_image_upload_key,
         'profile_image_url': value.profile_image_url,
         'user_id': value.user_id,
+        'zohodesk_classifications': value.zohodesk_classifications,
+        'zohodesk_departments': value.zohodesk_departments,
     };
 }
 exports.ConversationAgentProfileToJSON = ConversationAgentProfileToJSON;

package/package.json

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

package/src/apis/ConversationApi.ts

@@ -503,6 +503,12 @@ export interface UpdateAgentProfileRequest {
     profileRequest: ConversationAgentProfile;
 }
 
+export interface UpdateAgentProfileMcpRequest {
+    userId: number;
+    mcpServerUuid: string;
+    mcpServer: ConversationMcpServer;
+}
+
 export interface UpdateConversationCannedMessageRequest {
     conversationCannedMessageOid: number;
     cannedMessage: ConversationCannedMessage;
@@ -1901,6 +1907,24 @@ export interface ConversationApiInterface {
      */
     updateAgentProfile(requestParameters: UpdateAgentProfileRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationAgentProfileResponse>;
 
+    /**
+     * Update an agent MCP server 
+     * @summary Update an agent MCP server
+     * @param {number} userId 
+     * @param {string} mcpServerUuid 
+     * @param {ConversationMcpServer} mcpServer MCP Server
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof ConversationApiInterface
+     */
+    updateAgentProfileMcpRaw(requestParameters: UpdateAgentProfileMcpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationMcpServerResponse>>;
+
+    /**
+     * Update an agent MCP server 
+     * Update an agent MCP server
+     */
+    updateAgentProfileMcp(requestParameters: UpdateAgentProfileMcpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationMcpServerResponse>;
+
     /**
      * Update a canned message 
      * @summary Update a canned message
@@ -2217,7 +2241,7 @@ export class ConversationApi extends runtime.BaseAPI implements ConversationApiI
 
         const response = await this.request({
             path: `/conversation/agent/profiles/{user_id}/mcps/{mcp_server_uuid}`.replace(`{${"user_id"}}`, encodeURIComponent(String(requestParameters.userId))).replace(`{${"mcp_server_uuid"}}`, encodeURIComponent(String(requestParameters.mcpServerUuid))),
-            method: 'POST',
+            method: 'DELETE',
             headers: headerParameters,
             query: queryParameters,
         }, initOverrides);
@@ -5563,6 +5587,58 @@ export class ConversationApi extends runtime.BaseAPI implements ConversationApiI
         return await response.value();
     }
 
+    /**
+     * Update an agent MCP server 
+     * Update an agent MCP server
+     */
+    async updateAgentProfileMcpRaw(requestParameters: UpdateAgentProfileMcpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ConversationMcpServerResponse>> {
+        if (requestParameters.userId === null || requestParameters.userId === undefined) {
+            throw new runtime.RequiredError('userId','Required parameter requestParameters.userId was null or undefined when calling updateAgentProfileMcp.');
+        }
+
+        if (requestParameters.mcpServerUuid === null || requestParameters.mcpServerUuid === undefined) {
+            throw new runtime.RequiredError('mcpServerUuid','Required parameter requestParameters.mcpServerUuid was null or undefined when calling updateAgentProfileMcp.');
+        }
+
+        if (requestParameters.mcpServer === null || requestParameters.mcpServer === undefined) {
+            throw new runtime.RequiredError('mcpServer','Required parameter requestParameters.mcpServer was null or undefined when calling updateAgentProfileMcp.');
+        }
+
+        const queryParameters: any = {};
+
+        const headerParameters: runtime.HTTPHeaders = {};
+
+        headerParameters['Content-Type'] = 'application/json';
+
+        if (this.configuration && this.configuration.accessToken) {
+            // oauth required
+            headerParameters["Authorization"] = await this.configuration.accessToken("ultraCartOauth", ["conversation_write"]);
+        }
+
+        if (this.configuration && this.configuration.apiKey) {
+            headerParameters["x-ultracart-simple-key"] = this.configuration.apiKey("x-ultracart-simple-key"); // ultraCartSimpleApiKey authentication
+        }
+
+        const response = await this.request({
+            path: `/conversation/agent/profiles/{user_id}/mcps/{mcp_server_uuid}`.replace(`{${"user_id"}}`, encodeURIComponent(String(requestParameters.userId))).replace(`{${"mcp_server_uuid"}}`, encodeURIComponent(String(requestParameters.mcpServerUuid))),
+            method: 'POST',
+            headers: headerParameters,
+            query: queryParameters,
+            body: ConversationMcpServerToJSON(requestParameters.mcpServer),
+        }, initOverrides);
+
+        return new runtime.JSONApiResponse(response, (jsonValue) => ConversationMcpServerResponseFromJSON(jsonValue));
+    }
+
+    /**
+     * Update an agent MCP server 
+     * Update an agent MCP server
+     */
+    async updateAgentProfileMcp(requestParameters: UpdateAgentProfileMcpRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ConversationMcpServerResponse> {
+        const response = await this.updateAgentProfileMcpRaw(requestParameters, initOverrides);
+        return await response.value();
+    }
+
     /**
      * Update a canned message 
      * Update a canned message

package/src/models/ConversationAgentProfile.ts

@@ -43,6 +43,12 @@ export interface ConversationAgentProfile {
      * @memberof ConversationAgentProfile
      */
     ai_sms_instructions?: string;
+    /**
+     * Additional instructions for this AI when handling ticket draft replies
+     * @type {string}
+     * @memberof ConversationAgentProfile
+     */
+    ai_ticket_instructions?: string;
     /**
      * The number of engagement chats that can be pushed on them at any given time.
      * @type {number}
@@ -91,6 +97,18 @@ export interface ConversationAgentProfile {
      * @memberof ConversationAgentProfile
      */
     user_id?: number;
+    /**
+     * Restrict this agent to drafting replies only to tickets with these classifications
+     * @type {Array<string>}
+     * @memberof ConversationAgentProfile
+     */
+    zohodesk_classifications?: Array<string>;
+    /**
+     * Restrict this agent to drafting replies only to these department ids
+     * @type {Array<string>}
+     * @memberof ConversationAgentProfile
+     */
+    zohodesk_departments?: Array<string>;
 }
 
 
@@ -129,6 +147,7 @@ export function ConversationAgentProfileFromJSONTyped(json: any, ignoreDiscrimin
         'ai_chat_instructions': !exists(json, 'ai_chat_instructions') ? undefined : json['ai_chat_instructions'],
         'ai_persona': !exists(json, 'ai_persona') ? undefined : json['ai_persona'],
         'ai_sms_instructions': !exists(json, 'ai_sms_instructions') ? undefined : json['ai_sms_instructions'],
+        'ai_ticket_instructions': !exists(json, 'ai_ticket_instructions') ? undefined : json['ai_ticket_instructions'],
         'chat_limit': !exists(json, 'chat_limit') ? undefined : json['chat_limit'],
         'default_language_iso_code': !exists(json, 'default_language_iso_code') ? undefined : json['default_language_iso_code'],
         'default_status': !exists(json, 'default_status') ? undefined : json['default_status'],
@@ -137,6 +156,8 @@ export function ConversationAgentProfileFromJSONTyped(json: any, ignoreDiscrimin
         'profile_image_upload_key': !exists(json, 'profile_image_upload_key') ? undefined : json['profile_image_upload_key'],
         'profile_image_url': !exists(json, 'profile_image_url') ? undefined : json['profile_image_url'],
         'user_id': !exists(json, 'user_id') ? undefined : json['user_id'],
+        'zohodesk_classifications': !exists(json, 'zohodesk_classifications') ? undefined : json['zohodesk_classifications'],
+        'zohodesk_departments': !exists(json, 'zohodesk_departments') ? undefined : json['zohodesk_departments'],
     };
 }
 
@@ -153,6 +174,7 @@ export function ConversationAgentProfileToJSON(value?: ConversationAgentProfile
         'ai_chat_instructions': value.ai_chat_instructions,
         'ai_persona': value.ai_persona,
         'ai_sms_instructions': value.ai_sms_instructions,
+        'ai_ticket_instructions': value.ai_ticket_instructions,
         'chat_limit': value.chat_limit,
         'default_language_iso_code': value.default_language_iso_code,
         'default_status': value.default_status,
@@ -161,6 +183,8 @@ export function ConversationAgentProfileToJSON(value?: ConversationAgentProfile
         'profile_image_upload_key': value.profile_image_upload_key,
         'profile_image_url': value.profile_image_url,
         'user_id': value.user_id,
+        'zohodesk_classifications': value.zohodesk_classifications,
+        'zohodesk_departments': value.zohodesk_departments,
     };
 }