cheshirecat-typescript-client 1.8.3 → 1.8.4

package/dist/endpoints/conversation.d.ts

@@ -1,5 +1,5 @@
 import { AbstractEndpoint } from "./abstract";
-import { ConversationDeleteOutput, ConversationHistoryOutput, ConversationNameChangeOutput, ConversationsResponse } from "../models/api/conversations";
+import { ConversationDeleteOutput, ConversationHistoryOutput, ConversationAttributesChangeOutput, ConversationsResponse } from "../models/api/conversations";
 export declare class ConversationEndpoint extends AbstractEndpoint {
     protected prefix: string;
     /**
@@ -21,6 +21,16 @@ export declare class ConversationEndpoint extends AbstractEndpoint {
      * @returns An array of conversation attributes.
      */
     getConversations(agentId: string, userId: string): Promise<ConversationsResponse[]>;
+    /**
+     * This endpoint returns the attributes of a given conversation, for a given agent and user.
+     *
+     * @param agentId The agent ID.
+     * @param userId The user ID to filter the conversation attributes by.
+     * @param chatId The chat ID to filter the conversation attributes by.
+     *
+     * @returns The conversation attributes.
+     */
+    getConversation(agentId: string, userId: string, chatId: string): Promise<ConversationsResponse>;
     /**
      * This endpoint deletes the conversation.
      *
@@ -34,12 +44,13 @@ export declare class ConversationEndpoint extends AbstractEndpoint {
     /**
      * This endpoint changes the name of the conversation.
      *
-     * @param name The new name of the conversation.
      * @param agentId The agent ID.
      * @param userId The user ID to add the conversation history to.
      * @param chatId The chat ID to add the conversation history to.
+     * @param name The new name of the conversation.
+     * @param metadata The metadata to associate to the conversation.
      *
      * @returns The output of the change operation.
      */
-    postConversationName(name: string, agentId: string, userId: string, chatId: string): Promise<ConversationNameChangeOutput>;
+    putConversationAttributes(agentId: string, userId: string, chatId: string, name?: string | null, metadata?: Record<string, any>): Promise<ConversationAttributesChangeOutput>;
 }

package/dist/endpoints/conversation.js

@@ -3,7 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ConversationEndpoint = void 0;
 const abstract_1 = require("./abstract");
 class ConversationEndpoint extends abstract_1.AbstractEndpoint {
-    prefix = "/conversation";
+    prefix = "/conversations";
     /**
      * This endpoint returns the conversation history.
      *
@@ -14,7 +14,7 @@ class ConversationEndpoint extends abstract_1.AbstractEndpoint {
      * @returns The conversation history.
      */
     async getConversationHistory(agentId, userId, chatId) {
-        return this.get(this.formatUrl(chatId), agentId, userId);
+        return this.get(this.formatUrl(`/${chatId}/history`), agentId, userId);
     }
     /**
      * This endpoint returns all conversation attributes for a given agent and user.
@@ -32,6 +32,18 @@ class ConversationEndpoint extends abstract_1.AbstractEndpoint {
         const conversations = response.data;
         return conversations.map((conversation) => this.deserialize(JSON.stringify(conversation)));
     }
+    /**
+     * This endpoint returns the attributes of a given conversation, for a given agent and user.
+     *
+     * @param agentId The agent ID.
+     * @param userId The user ID to filter the conversation attributes by.
+     * @param chatId The chat ID to filter the conversation attributes by.
+     *
+     * @returns The conversation attributes.
+     */
+    async getConversation(agentId, userId, chatId) {
+        return this.get(this.formatUrl(chatId), agentId, userId);
+    }
     /**
      * This endpoint deletes the conversation.
      *
@@ -47,16 +59,23 @@ class ConversationEndpoint extends abstract_1.AbstractEndpoint {
     /**
      * This endpoint changes the name of the conversation.
      *
-     * @param name The new name of the conversation.
      * @param agentId The agent ID.
      * @param userId The user ID to add the conversation history to.
      * @param chatId The chat ID to add the conversation history to.
+     * @param name The new name of the conversation.
+     * @param metadata The metadata to associate to the conversation.
      *
      * @returns The output of the change operation.
      */
-    async postConversationName(name, agentId, userId, chatId) {
-        const payload = { name };
-        return this.post(this.formatUrl(chatId), agentId, payload, userId);
+    async putConversationAttributes(agentId, userId, chatId, name, metadata) {
+        if (!name && !metadata) {
+            throw new Error("Either name or metadata must be provided");
+        }
+        const payload = {
+            ...name && { name: name },
+            ...metadata && { metadata: metadata },
+        };
+        return this.put(this.formatUrl(chatId), agentId, payload, userId);
     }
 }
 exports.ConversationEndpoint = ConversationEndpoint;

package/dist/endpoints/conversation.js.map

@@ -1 +1 @@
-{"version":3,"file":"conversation.js","sourceRoot":"","sources":["../../src/endpoints/conversation.ts"],"names":[],"mappings":";;;AAAA,yCAA4C;AAQ5C,MAAa,oBAAqB,SAAQ,2BAAgB;IAC5C,MAAM,GAAG,eAAe,CAAC;IAEnC;;;;;;;;OAQG;IACH,KAAK,CAAC,sBAAsB,CACxB,OAAe,EACf,MAAc,EACd,MAAc;QAEd,OAAO,IAAI,CAAC,GAAG,CAA4B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IACxF,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,gBAAgB,CAAC,OAAe,EAAE,MAAc;QAClD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5E,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,6BAA6B,IAAI,CAAC,MAAM,KAAK,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;QACxF,CAAC;QAED,MAAM,aAAa,GAAG,QAAQ,CAAC,IAAI,CAAC;QACpC,OAAO,aAAa,CAAC,GAAG,CAAC,CAAC,YAAiB,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAC5D,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAC/B,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,kBAAkB,CACpB,OAAe,EACf,MAAc,EACd,MAAc;QAEd,OAAO,IAAI,CAAC,MAAM,CACd,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EACtB,OAAO,EACP,MAAM,CACT,CAAC;IACN,CAAC;IAED;;;;;;;;;OASG;IACH,KAAK,CAAC,oBAAoB,CACtB,IAAY,EACZ,OAAe,EACf,MAAc,EACd,MAAc;QAEd,MAAM,OAAO,GAAG,EAAC,IAAI,EAAC,CAAC;QAEvB,OAAO,IAAI,CAAC,IAAI,CAA+B,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IACrG,CAAC;CACJ;AAjFD,oDAiFC"}
+{"version":3,"file":"conversation.js","sourceRoot":"","sources":["../../src/endpoints/conversation.ts"],"names":[],"mappings":";;;AAAA,yCAA4C;AAQ5C,MAAa,oBAAqB,SAAQ,2BAAgB;IAC5C,MAAM,GAAG,gBAAgB,CAAC;IAEpC;;;;;;;;OAQG;IACH,KAAK,CAAC,sBAAsB,CACxB,OAAe,EACf,MAAc,EACd,MAAc;QAEd,OAAO,IAAI,CAAC,GAAG,CAA4B,IAAI,CAAC,SAAS,CAAC,IAAI,MAAM,UAAU,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IACtG,CAAC;IAED;;;;;;;OAOG;IACH,KAAK,CAAC,gBAAgB,CAAC,OAAe,EAAE,MAAc;QAClD,MAAM,QAAQ,GAAG,MAAM,IAAI,CAAC,aAAa,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;QAC5E,IAAI,QAAQ,CAAC,MAAM,KAAK,GAAG,EAAE,CAAC;YAC1B,MAAM,IAAI,KAAK,CAAC,6BAA6B,IAAI,CAAC,MAAM,KAAK,QAAQ,CAAC,UAAU,EAAE,CAAC,CAAC;QACxF,CAAC;QAED,MAAM,aAAa,GAAG,QAAQ,CAAC,IAAI,CAAC;QACpC,OAAO,aAAa,CAAC,GAAG,CAAC,CAAC,YAAiB,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,CAC5D,IAAI,CAAC,SAAS,CAAC,YAAY,CAAC,CAC/B,CAAC,CAAC;IACP,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,eAAe,CAAC,OAAe,EAAE,MAAc,EAAE,MAAc;QACjE,OAAO,IAAI,CAAC,GAAG,CAAwB,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IACpF,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,kBAAkB,CACpB,OAAe,EACf,MAAc,EACd,MAAc;QAEd,OAAO,IAAI,CAAC,MAAM,CACd,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EACtB,OAAO,EACP,MAAM,CACT,CAAC;IACN,CAAC;IAED;;;;;;;;;;OAUG;IACH,KAAK,CAAC,yBAAyB,CAC3B,OAAe,EACf,MAAc,EACd,MAAc,EACd,IAAoB,EACpB,QAA8B;QAE9B,IAAI,CAAC,IAAI,IAAI,CAAC,QAAQ,EAAE,CAAC;YACrB,MAAM,IAAI,KAAK,CAAC,0CAA0C,CAAC,CAAC;QAChE,CAAC;QAED,MAAM,OAAO,GAAQ;YACjB,GAAG,IAAI,IAAI,EAAC,IAAI,EAAE,IAAI,EAAC;YACvB,GAAG,QAAQ,IAAI,EAAC,QAAQ,EAAE,QAAQ,EAAC;SACtC,CAAC;QAEF,OAAO,IAAI,CAAC,GAAG,CAAqC,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,OAAO,EAAE,MAAM,CAAC,CAAC;IAC1G,CAAC;CACJ;AAvGD,oDAuGC"}

package/dist/models/api/conversations.d.ts

@@ -10,9 +10,10 @@ export declare class ConversationsResponse {
     chat_id: string;
     name: string;
     num_messages: number;
+    metadata: Record<string, any>;
     created_at: number | null;
     updated_at: number | null;
 }
-export declare class ConversationNameChangeOutput {
+export declare class ConversationAttributesChangeOutput {
     changed: boolean;
 }

package/dist/models/api/conversations.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ConversationNameChangeOutput = exports.ConversationsResponse = exports.ConversationHistoryOutput = void 0;
+exports.ConversationAttributesChangeOutput = exports.ConversationsResponse = exports.ConversationHistoryOutput = void 0;
 class ConversationHistoryOutput {
     history;
     toArray() {
@@ -13,12 +13,13 @@ class ConversationsResponse {
     chat_id;
     name;
     num_messages;
+    metadata;
     created_at;
     updated_at;
 }
 exports.ConversationsResponse = ConversationsResponse;
-class ConversationNameChangeOutput {
+class ConversationAttributesChangeOutput {
     changed;
 }
-exports.ConversationNameChangeOutput = ConversationNameChangeOutput;
+exports.ConversationAttributesChangeOutput = ConversationAttributesChangeOutput;
 //# sourceMappingURL=conversations.js.map

package/dist/models/api/conversations.js.map

@@ -1 +1 @@
-{"version":3,"file":"conversations.js","sourceRoot":"","sources":["../../../src/models/api/conversations.ts"],"names":[],"mappings":";;;AAMA,MAAa,yBAAyB;IAClC,OAAO,CAAwB;IAExB,OAAO;QACV,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QACnD,OAAO,EAAE,OAAO,EAAE,CAAC;IACvB,CAAC;CACJ;AAPD,8DAOC;AAED,MAAa,qBAAqB;IAC9B,OAAO,CAAS;IAChB,IAAI,CAAS;IACb,YAAY,CAAS;IACrB,UAAU,CAAgB;IAC1B,UAAU,CAAgB;CAC7B;AAND,sDAMC;AAED,MAAa,4BAA4B;IACrC,OAAO,CAAU;CACpB;AAFD,oEAEC"}
+{"version":3,"file":"conversations.js","sourceRoot":"","sources":["../../../src/models/api/conversations.ts"],"names":[],"mappings":";;;AAMA,MAAa,yBAAyB;IAClC,OAAO,CAAwB;IAExB,OAAO;QACV,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,OAAO,EAAE,CAAC,CAAC;QACnD,OAAO,EAAE,OAAO,EAAE,CAAC;IACvB,CAAC;CACJ;AAPD,8DAOC;AAED,MAAa,qBAAqB;IAC9B,OAAO,CAAS;IAChB,IAAI,CAAS;IACb,YAAY,CAAS;IACrB,QAAQ,CAAsB;IAC9B,UAAU,CAAgB;IAC1B,UAAU,CAAgB;CAC7B;AAPD,sDAOC;AAED,MAAa,kCAAkC;IAC3C,OAAO,CAAU;CACpB;AAFD,gFAEC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cheshirecat-typescript-client",
-  "version": "1.8.3",
+  "version": "1.8.4",
   "engines": {
     "node": "22.x"
   },