@lorikeetai/node-sdk 1.8.1 → 2.1.0

package/resources/conversation/chat.d.mts

@@ -0,0 +1,312 @@
+import { APIResource } from "../../core/resource.mjs";
+import * as ConversationAPI from "./conversation.mjs";
+import { APIPromise } from "../../core/api-promise.mjs";
+import { RequestOptions } from "../../internal/request-options.mjs";
+export declare class Chat extends APIResource {
+    /**
+     * @example
+     * ```ts
+     * const response = await client.conversation.chat.generate({
+     *   attachments: [
+     *     {
+     *       name: 'example.jpg',
+     *       type: 'image/jpeg',
+     *       url: 'https://example.com/example.jpg',
+     *     },
+     *   ],
+     *   conversationId: 'conversationId',
+     *   message: 'message',
+     * });
+     * ```
+     */
+    generate(body: ChatGenerateParams, options?: RequestOptions): APIPromise<ChatGenerateResponse>;
+    /**
+     * @example
+     * ```ts
+     * const chat = await client.conversation.chat.get({
+     *   conversationId: 'conversationId',
+     * });
+     * ```
+     */
+    get(query: ChatGetParams, options?: RequestOptions): APIPromise<ChatGetResponse>;
+    /**
+     * @example
+     * ```ts
+     * const response = await client.conversation.chat.start({
+     *   customerId: 'customerId',
+     *   publicKey: 'publicKey',
+     * });
+     * ```
+     */
+    start(body: ChatStartParams, options?: RequestOptions): APIPromise<ChatStartResponse>;
+    /**
+     * Send a message and poll until a response is ready.
+     *
+     * This is a convenience wrapper that calls {@link Chat.generate} then {@link Chat.poll}.
+     */
+    message(body: ChatGenerateParams, options?: RequestOptions): APIPromise<ChatGetResponse>;
+    /**
+     * Poll until the conversation has a bot response ready.
+     *
+     * Stops when `latestMessageType` is `BOT_RESPONSE` or `PENDING_RESPONSE`,
+     * or when `status` is `Escalated` or `Error`.
+     */
+    poll(query: ChatGetParams, options?: RequestOptions): APIPromise<ChatGetResponse>;
+    /**
+     * Create a persistent stream of updates for a conversation.
+     *
+     * Responses from the bot will arrive as events. Consuming clients must aggregate
+     * multiple chunks into a single message based on the `messageId` field.
+     *
+     * This stream is open indefinitely and does not automatically close — avoid
+     * blocking other operations while listening to events from this generator.
+     *
+     * @example
+     * ```ts
+     * for await (const evt of client.conversation.chat.streamUpdates({ conversationId: 'abc123' })) {
+     *   console.log(evt);
+     * }
+     * ```
+     */
+    streamUpdates(params: ChatStreamParams): AsyncIterable<ChatStreamEvent>;
+}
+export interface ChatGenerateResponse {
+    /**
+     * The ID of the conversation
+     */
+    conversationId: string;
+    /**
+     * The timestamp of the when the conversation was created in our system.
+     */
+    createdAt: string;
+    /**
+     * The events that have occurred in the conversation. Can be used for deriving more
+     * information about the conversation.
+     */
+    events: Array<ConversationAPI.TicketEvent>;
+    /**
+     * The latest message type - useful for polling
+     */
+    latestMessageType: 'CUSTOMER' | 'BOT_RESPONSE' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' | null;
+    /**
+     * The url of the conversation in the Lorikeet dashboard
+     */
+    link: string;
+    /**
+     * The full list of messages. This endpoint supports markdown.
+     */
+    messages: Array<ConversationAPI.TicketMessageDto>;
+    /**
+     * The status of the conversation
+     */
+    status: 'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed';
+    /**
+     * The tags of the conversation
+     */
+    tags: Array<string>;
+    /**
+     * The timestamp of when the ticket was last updated in our system.
+     */
+    updatedAt: string;
+}
+export interface ChatGetResponse {
+    /**
+     * The ID of the conversation
+     */
+    conversationId: string;
+    /**
+     * The timestamp of the when the conversation was created in our system.
+     */
+    createdAt: string;
+    /**
+     * The events that have occurred in the conversation. Can be used for deriving more
+     * information about the conversation.
+     */
+    events: Array<ConversationAPI.TicketEvent>;
+    /**
+     * The latest message type - useful for polling
+     */
+    latestMessageType: 'CUSTOMER' | 'BOT_RESPONSE' | 'PENDING_RESPONSE' | 'DRAFT_RESPONSE' | null;
+    /**
+     * The url of the conversation in the Lorikeet dashboard
+     */
+    link: string;
+    /**
+     * The full list of messages. This endpoint supports markdown.
+     */
+    messages: Array<ConversationAPI.TicketMessageDto>;
+    /**
+     * The status of the conversation
+     */
+    status: 'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed';
+    /**
+     * The tags of the conversation
+     */
+    tags: Array<string>;
+    /**
+     * The timestamp of when the ticket was last updated in our system.
+     */
+    updatedAt: string;
+}
+export interface ChatStartResponse {
+    /**
+     * The ID of the conversation
+     */
+    conversationId: string;
+    /**
+     * The timestamp of the when the conversation was created in our system.
+     */
+    createdAt: string;
+    /**
+     * The events that have occurred in the conversation. Can be used for deriving more
+     * information about the conversation.
+     */
+    events: Array<ConversationAPI.TicketEvent>;
+    /**
+     * The url of the conversation in the Lorikeet dashboard
+     */
+    link: string;
+    /**
+     * The status of the conversation
+     */
+    status: 'Unprocessed' | 'Processing' | 'Unhandled' | 'Responded' | 'Error' | 'Escalated' | 'Processed';
+    /**
+     * The tags of the conversation
+     */
+    tags: Array<string>;
+}
+export interface ChatGenerateParams {
+    /**
+     * Attachments to be sent with the message
+     */
+    attachments: Array<ConversationAPI.AttachmentDto>;
+    /**
+     * The ID of the conversation
+     */
+    conversationId: string;
+    /**
+     * The message to be sent to the user (customer or agent). This endpoint supports
+     * markdown.
+     */
+    message: string;
+    /**
+     * Any additional customer information, that has changed in the course of the
+     * conversation. Required if the message is sent by the customer to the agent. Must
+     * be omitted if the message is sent by the agent to the customer.
+     */
+    customer?: ChatGenerateParams.Customer;
+    /**
+     * The variables to be passed to the conversation - this can be used by workflows
+     */
+    variables?: {
+        [key: string]: unknown;
+    };
+}
+export declare namespace ChatGenerateParams {
+    /**
+     * Any additional customer information, that has changed in the course of the
+     * conversation. Required if the message is sent by the customer to the agent. Must
+     * be omitted if the message is sent by the agent to the customer.
+     */
+    interface Customer {
+        /**
+         * The URL of the customer avatar
+         */
+        avatarUrl?: string;
+        /**
+         * The display name of the customer
+         */
+        displayName?: string;
+        /**
+         * The email of the customer
+         */
+        email?: string;
+        /**
+         * The first name of the customer
+         */
+        firstName?: string;
+        /**
+         * The last name of the customer
+         */
+        lastName?: string;
+        /**
+         * The phone number of the customer (in international / E.164 format)
+         */
+        phoneNumber?: string;
+        /**
+         * The id of the customer in the ticketing system. For the SDK this needs to be
+         * stable and unique
+         */
+        remoteId?: string;
+        /**
+         * The id of the customer in your own primary database or a unique identifier, for
+         * example a cookie
+         */
+        subscriberCustomerId?: string;
+        /**
+         * A token that can be used to authenticate the customer in the your system, like a
+         * JWT
+         */
+        subscriberToken?: string;
+    }
+}
+export interface ChatGetParams {
+    /**
+     * The ID of the conversation you need to poll.
+     */
+    conversationId: string;
+}
+export interface ChatStartParams {
+    /**
+     * The ID of the customer. If omitted, a new customer will be created.
+     */
+    customerId: string;
+    /**
+     * The public key associated with this agent
+     */
+    publicKey: string;
+    /**
+     * The subject of the conversation.
+     */
+    subject?: string;
+    /**
+     * The UUID of the workflow to trigger.
+     */
+    workflowId?: string;
+}
+export interface ChatStreamParams {
+    /**
+     * The ID of the conversation you need to stream.
+     */
+    conversationId: string;
+}
+/**
+ * Signal that a new response message has been created and new chunks
+ * for this response for the messageId will follow.
+ */
+export interface ChatStreamNewMessageEvent {
+    type: 'new-message';
+    createdAt: string;
+    messageId: string;
+    content: string;
+}
+/**
+ * A chunk of text response for the message with the given messageId.
+ */
+export interface ChatStreamMessageChunkEvent {
+    type: 'message-chunk';
+    contentDelta: string;
+    messageId: string;
+}
+/**
+ * All chunks for a message have been received and no more chunks will follow for this message.
+ */
+export interface ChatStreamMessageCompleteEvent {
+    type: 'message-complete';
+    messageId: string;
+}
+export type ChatStreamEvent = ChatStreamNewMessageEvent | ChatStreamMessageChunkEvent | ChatStreamMessageCompleteEvent;
+export declare namespace Chat {
+    export { type ChatGenerateResponse as ChatGenerateResponse, type ChatGetResponse as ChatGetResponse, type ChatStartResponse as ChatStartResponse, type ChatGenerateParams as ChatGenerateParams, type ChatGetParams as ChatGetParams, type ChatStartParams as ChatStartParams, type ChatStreamParams as ChatStreamParams, type ChatStreamEvent as ChatStreamEvent, type ChatStreamNewMessageEvent as ChatStreamNewMessageEvent, type ChatStreamMessageChunkEvent as ChatStreamMessageChunkEvent, type ChatStreamMessageCompleteEvent as ChatStreamMessageCompleteEvent, };
+}
+//# sourceMappingURL=chat.d.mts.map

package/resources/conversation/chat.d.mts.map

@@ -0,0 +1 @@
+{"version":3,"file":"chat.d.mts","sourceRoot":"","sources":["../../src/resources/conversation/chat.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,eAAe;OACpB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAKzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAI9F;;;;;;;OAOG;IACH,GAAG,CAAC,KAAK,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAIhF;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAIrF;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAMxF;;;;;OAKG;IACH,IAAI,CAAC,KAAK,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAwBjF;;;;;;;;;;;;;;;OAeG;IACH,aAAa,CAAC,MAAM,EAAE,gBAAgB,GAAG,aAAa,CAAC,eAAe,CAAC;CA2CxE;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,MAAM,EAAE,KAAK,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;IAE3C;;OAEG;IACH,iBAAiB,EAAE,UAAU,GAAG,cAAc,GAAG,kBAAkB,GAAG,gBAAgB,GAAG,IAAI,CAAC;IAE9F;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;IAElD;;OAEG;IACH,MAAM,EAAE,aAAa,GAAG,YAAY,GAAG,WAAW,GAAG,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,WAAW,CAAC;IAEvG;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,MAAM,EAAE,KAAK,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;IAE3C;;OAEG;IACH,iBAAiB,EAAE,UAAU,GAAG,cAAc,GAAG,kBAAkB,GAAG,gBAAgB,GAAG,IAAI,CAAC;IAE9F;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;IAElD;;OAEG;IACH,MAAM,EAAE,aAAa,GAAG,YAAY,GAAG,WAAW,GAAG,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,WAAW,CAAC;IAEvG;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,MAAM,EAAE,KAAK,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;IAE3C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,aAAa,GAAG,YAAY,GAAG,WAAW,GAAG,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,WAAW,CAAC;IAEvG;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;IAElD;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,kBAAkB,CAAC,QAAQ,CAAC;IAEvC;;OAEG;IACH,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACxC;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;;;OAIG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;WAGG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,aAAa,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,eAAe,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,IAAI,EAAE,kBAAkB,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,eAAe,GACvB,yBAAyB,GACzB,2BAA2B,GAC3B,8BAA8B,CAAC;AAEnC,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}

package/resources/conversation/chat.d.ts

@@ -1,21 +1,8 @@
-import { APIResource } from "../../resource.js";
-import * as Core from "../../core.js";
+import { APIResource } from "../../core/resource.js";
 import * as ConversationAPI from "./conversation.js";
+import { APIPromise } from "../../core/api-promise.js";
+import { RequestOptions } from "../../internal/request-options.js";
 export declare class Chat extends APIResource {
-    /**
-     * __chat.generate__
-     *
-     * Generate a chat message for a conversation. This endpoint will return immediately, polling will be required to get the response.
-     *
-     * The `latestMessageType` field in the response can be used to determine if the response is ready.
-     *
-     * If the `latestMessageType` is `BOT_RESPONSE`, the response is ready.
-     * For a more ergonomic way to poll, use the `message` method.
-     *
-     * ** WARNING ** This endpoint is not idempotent. If you call it multiple times, you will generate multiple messages.
-     *
-     * @see {@link Chat.message}
-     */
     /**
      * @example
      * ```ts
@@ -32,12 +19,7 @@ export declare class Chat extends APIResource {
      * });
      * ```
      */
-    generate(body: ChatGenerateParams, options?: Core.RequestOptions): Core.APIPromise<ChatGenerateResponse>;
-    /**
-     * __chat.get__
-     *
-     * Returns a chat message for a conversation. This endpoint will return the latest state of the conversation.
-     */
+    generate(body: ChatGenerateParams, options?: RequestOptions): APIPromise<ChatGenerateResponse>;
     /**
      * @example
      * ```ts
@@ -46,16 +28,7 @@ export declare class Chat extends APIResource {
      * });
      * ```
      */
-    get(query: ChatGetParams, options?: Core.RequestOptions): Core.APIPromise<ChatGetResponse>;
-    /**
-     * __chat.start__
-     *
-     * Start a chat conversation. This endpoint will return immediately.
-     *
-     * The `conversationId` field in the response can be used to generate messages.
-     *
-     * ** WARNING ** This endpoint is not idempotent. If you call it multiple times, you will generate multiple conversations.
-     */
+    get(query: ChatGetParams, options?: RequestOptions): APIPromise<ChatGetResponse>;
     /**
      * @example
      * ```ts
@@ -65,34 +38,29 @@ export declare class Chat extends APIResource {
      * });
      * ```
      */
-    start(body: ChatStartParams, options?: Core.RequestOptions): Core.APIPromise<ChatStartResponse>;
+    start(body: ChatStartParams, options?: RequestOptions): APIPromise<ChatStartResponse>;
     /**
-     * Returns a chat message for a conversation. This endpoint will poll until a response is ready.
+     * Send a message and poll until a response is ready.
      *
-     * When it return the response is the latest message type that is of type `BOT_RESPONSE`.
-     *
-     * @see {@link Chat.poll}
+     * This is a convenience wrapper that calls {@link Chat.generate} then {@link Chat.poll}.
      */
-    message(body: ChatGenerateParams, options?: Core.RequestOptions): Core.APIPromise<ChatGetResponse>;
+    message(body: ChatGenerateParams, options?: RequestOptions): APIPromise<ChatGetResponse>;
     /**
-     * __chat.poll__
+     * Poll until the conversation has a bot response ready.
      *
-     * Polls until it returns a BOT chat message for a conversation.
+     * Stops when `latestMessageType` is `BOT_RESPONSE` or `PENDING_RESPONSE`,
+     * or when `status` is `Escalated` or `Error`.
      */
-    poll(query: ChatGetParams, options?: Core.RequestOptions): Core.APIPromise<ChatGetResponse>;
+    poll(query: ChatGetParams, options?: RequestOptions): APIPromise<ChatGetResponse>;
     /**
-     * __chat.streamUpdates__
-     *
      * Create a persistent stream of updates for a conversation.
-     * Responses from the bot will arrive as events. Consuming clients must aggregate multiple chunks
-     * into a single message based on the messageId field. Note that new messages may arrive without
-     * new user messages, this update stream is open indefinitely and does not automatically close - avoid
+     *
+     * Responses from the bot will arrive as events. Consuming clients must aggregate
+     * multiple chunks into a single message based on the `messageId` field.
+     *
+     * This stream is open indefinitely and does not automatically close — avoid
      * blocking other operations while listening to events from this generator.
      *
-     * @param params.conversationId - Conversation/ticket ID to subscribe to.
-     * @returns AsyncGenerator<ChatStreamEvent> a generator that emits response events as they arrive.
-     */
-    /**
      * @example
      * ```ts
      * for await (const evt of client.conversation.chat.streamUpdates({ conversationId: 'abc123' })) {
@@ -102,32 +70,6 @@ export declare class Chat extends APIResource {
      */
     streamUpdates(params: ChatStreamParams): AsyncIterable<ChatStreamEvent>;
 }
-/**
- * Signal that a new response message has been created and new chunks
- * for this response for the messageId will follow.
- */
-export interface ChatStreamNewMessageEvent {
-    type: 'new-message';
-    createdAt: string;
-    messageId: string;
-    content: string;
-}
-/**
- * A chunk of text response for the message with the given messageId.
- */
-export interface ChatStreamMessageChunkEvent {
-    type: 'message-chunk';
-    contentDelta: string;
-    messageId: string;
-}
-/**
- * All chunks for a message have been received and no more chunks will follow for this message.
- */
-export interface ChatStreamMessageCompleteEvent {
-    type: 'message-complete';
-    messageId: string;
-}
-export type ChatStreamEvent = ChatStreamNewMessageEvent | ChatStreamMessageChunkEvent | ChatStreamMessageCompleteEvent;
 export interface ChatGenerateResponse {
     /**
      * The ID of the conversation
@@ -338,7 +280,33 @@ export interface ChatStreamParams {
      */
     conversationId: string;
 }
+/**
+ * Signal that a new response message has been created and new chunks
+ * for this response for the messageId will follow.
+ */
+export interface ChatStreamNewMessageEvent {
+    type: 'new-message';
+    createdAt: string;
+    messageId: string;
+    content: string;
+}
+/**
+ * A chunk of text response for the message with the given messageId.
+ */
+export interface ChatStreamMessageChunkEvent {
+    type: 'message-chunk';
+    contentDelta: string;
+    messageId: string;
+}
+/**
+ * All chunks for a message have been received and no more chunks will follow for this message.
+ */
+export interface ChatStreamMessageCompleteEvent {
+    type: 'message-complete';
+    messageId: string;
+}
+export type ChatStreamEvent = ChatStreamNewMessageEvent | ChatStreamMessageChunkEvent | ChatStreamMessageCompleteEvent;
 export declare namespace Chat {
-    export { type ChatGenerateResponse as ChatGenerateResponse, type ChatGetResponse as ChatGetResponse, type ChatStartResponse as ChatStartResponse, type ChatGenerateParams as ChatGenerateParams, type ChatGetParams as ChatGetParams, type ChatStartParams as ChatStartParams, type ChatStreamParams as ChatStreamParams, };
+    export { type ChatGenerateResponse as ChatGenerateResponse, type ChatGetResponse as ChatGetResponse, type ChatStartResponse as ChatStartResponse, type ChatGenerateParams as ChatGenerateParams, type ChatGetParams as ChatGetParams, type ChatStartParams as ChatStartParams, type ChatStreamParams as ChatStreamParams, type ChatStreamEvent as ChatStreamEvent, type ChatStreamNewMessageEvent as ChatStreamNewMessageEvent, type ChatStreamMessageChunkEvent as ChatStreamMessageChunkEvent, type ChatStreamMessageCompleteEvent as ChatStreamMessageCompleteEvent, };
 }
 //# sourceMappingURL=chat.d.ts.map

package/resources/conversation/chat.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"chat.d.ts","sourceRoot":"","sources":["../../src/resources/conversation/chat.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AAEnC,OAAO,KAAK,eAAe,MAAM,gBAAgB,CAAC;AAIlD,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;;OAaG;IAEH;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,oBAAoB,CAAC;IAIxG;;;;OAIG;IAEH;;;;;;;OAOG;IACH,GAAG,CAAC,KAAK,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;IAI1F;;;;;;;;OAQG;IAEH;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,iBAAiB,CAAC;IAI/F;;;;;;OAMG;IACH,OAAO,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;IAMlG;;;;OAIG;IACH,IAAI,CAAC,KAAK,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,IAAI,CAAC,cAAc,GAAG,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;IAyB3F;;;;;;;;;;;OAWG;IAEH;;;;;;;OAOG;IACH,aAAa,CAAC,MAAM,EAAE,gBAAgB,GAAG,aAAa,CAAC,eAAe,CAAC;CA2CxE;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,aAAa,CAAC;IAEpB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAElB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,eAAe,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,IAAI,EAAE,kBAAkB,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,eAAe,GACvB,yBAAyB,GACzB,2BAA2B,GAC3B,8BAA8B,CAAC;AAEnC,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,MAAM,EAAE,KAAK,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;IAE3C;;OAEG;IACH,iBAAiB,EAAE,UAAU,GAAG,cAAc,GAAG,kBAAkB,GAAG,gBAAgB,GAAG,IAAI,CAAC;IAE9F;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;IAElD;;OAEG;IACH,MAAM,EAAE,aAAa,GAAG,YAAY,GAAG,WAAW,GAAG,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,WAAW,CAAC;IAEvG;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,MAAM,EAAE,KAAK,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;IAE3C;;OAEG;IACH,iBAAiB,EAAE,UAAU,GAAG,cAAc,GAAG,kBAAkB,GAAG,gBAAgB,GAAG,IAAI,CAAC;IAE9F;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;IAElD;;OAEG;IACH,MAAM,EAAE,aAAa,GAAG,YAAY,GAAG,WAAW,GAAG,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,WAAW,CAAC;IAEvG;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,MAAM,EAAE,KAAK,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;IAE3C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,aAAa,GAAG,YAAY,GAAG,WAAW,GAAG,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,WAAW,CAAC;IAEvG;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;IAElD;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,kBAAkB,CAAC,QAAQ,CAAC;IAEvC;;OAEG;IACH,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACxC;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;;;OAIG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;WAGG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
+{"version":3,"file":"chat.d.ts","sourceRoot":"","sources":["../../src/resources/conversation/chat.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,KAAK,eAAe;OACpB,EAAE,UAAU,EAAE;OACd,EAAE,cAAc,EAAE;AAKzB,qBAAa,IAAK,SAAQ,WAAW;IACnC;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;IAI9F;;;;;;;OAOG;IACH,GAAG,CAAC,KAAK,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAIhF;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAI,EAAE,eAAe,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAIrF;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAMxF;;;;;OAKG;IACH,IAAI,CAAC,KAAK,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,eAAe,CAAC;IAwBjF;;;;;;;;;;;;;;;OAeG;IACH,aAAa,CAAC,MAAM,EAAE,gBAAgB,GAAG,aAAa,CAAC,eAAe,CAAC;CA2CxE;AAED,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,MAAM,EAAE,KAAK,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;IAE3C;;OAEG;IACH,iBAAiB,EAAE,UAAU,GAAG,cAAc,GAAG,kBAAkB,GAAG,gBAAgB,GAAG,IAAI,CAAC;IAE9F;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;IAElD;;OAEG;IACH,MAAM,EAAE,aAAa,GAAG,YAAY,GAAG,WAAW,GAAG,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,WAAW,CAAC;IAEvG;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,MAAM,EAAE,KAAK,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;IAE3C;;OAEG;IACH,iBAAiB,EAAE,UAAU,GAAG,cAAc,GAAG,kBAAkB,GAAG,gBAAgB,GAAG,IAAI,CAAC;IAE9F;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,QAAQ,EAAE,KAAK,CAAC,eAAe,CAAC,gBAAgB,CAAC,CAAC;IAElD;;OAEG;IACH,MAAM,EAAE,aAAa,GAAG,YAAY,GAAG,WAAW,GAAG,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,WAAW,CAAC;IAEvG;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAEpB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,WAAW,iBAAiB;IAChC;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;;OAGG;IACH,MAAM,EAAE,KAAK,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC;IAE3C;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC;IAEb;;OAEG;IACH,MAAM,EAAE,aAAa,GAAG,YAAY,GAAG,WAAW,GAAG,WAAW,GAAG,OAAO,GAAG,WAAW,GAAG,WAAW,CAAC;IAEvG;;OAEG;IACH,IAAI,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;CACrB;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,WAAW,EAAE,KAAK,CAAC,eAAe,CAAC,aAAa,CAAC,CAAC;IAElD;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,kBAAkB,CAAC,QAAQ,CAAC;IAEvC;;OAEG;IACH,SAAS,CAAC,EAAE;QAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;KAAE,CAAC;CACxC;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;;;OAIG;IACH,UAAiB,QAAQ;QACvB;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,WAAW,CAAC,EAAE,MAAM,CAAC;QAErB;;;WAGG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,oBAAoB,CAAC,EAAE,MAAM,CAAC;QAE9B;;;WAGG;QACH,eAAe,CAAC,EAAE,MAAM,CAAC;KAC1B;CACF;AAED,MAAM,WAAW,aAAa;IAC5B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC/B;;OAEG;IACH,cAAc,EAAE,MAAM,CAAC;CACxB;AAED;;;GAGG;AACH,MAAM,WAAW,yBAAyB;IACxC,IAAI,EAAE,aAAa,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,2BAA2B;IAC1C,IAAI,EAAE,eAAe,CAAC;IACtB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC7C,IAAI,EAAE,kBAAkB,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,MAAM,MAAM,eAAe,GACvB,yBAAyB,GACzB,2BAA2B,GAC3B,8BAA8B,CAAC;AAEnC,MAAM,CAAC,OAAO,WAAW,IAAI,CAAC;IAC5B,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,aAAa,IAAI,aAAa,EACnC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gBAAgB,IAAI,gBAAgB,EACzC,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,yBAAyB,IAAI,yBAAyB,EAC3D,KAAK,2BAA2B,IAAI,2BAA2B,EAC/D,KAAK,8BAA8B,IAAI,8BAA8B,GACtE,CAAC;CACH"}

package/resources/conversation/chat.js

@@ -2,25 +2,11 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.Chat = void 0;
-const resource_1 = require("../../resource.js");
-const poll_until_1 = require("@lorikeetai/node-sdk/lib/poll-until");
+const resource_1 = require("../../core/resource.js");
+const poll_until_1 = require("../../lib/poll-until.js");
+const promise_1 = require("../../lib/promise.js");
 const eventsource_1 = require("eventsource");
-const promise_1 = require("@lorikeetai/node-sdk/lib/promise");
 class Chat extends resource_1.APIResource {
-    /**
-     * __chat.generate__
-     *
-     * Generate a chat message for a conversation. This endpoint will return immediately, polling will be required to get the response.
-     *
-     * The `latestMessageType` field in the response can be used to determine if the response is ready.
-     *
-     * If the `latestMessageType` is `BOT_RESPONSE`, the response is ready.
-     * For a more ergonomic way to poll, use the `message` method.
-     *
-     * ** WARNING ** This endpoint is not idempotent. If you call it multiple times, you will generate multiple messages.
-     *
-     * @see {@link Chat.message}
-     */
     /**
      * @example
      * ```ts
@@ -40,11 +26,6 @@ class Chat extends resource_1.APIResource {
     generate(body, options) {
         return this._client.post('/v1/conversation/chat/message', { body, ...options });
     }
-    /**
-     * __chat.get__
-     *
-     * Returns a chat message for a conversation. This endpoint will return the latest state of the conversation.
-     */
     /**
      * @example
      * ```ts
@@ -56,15 +37,6 @@ class Chat extends resource_1.APIResource {
     get(query, options) {
         return this._client.get('/v1/conversation/chat/message', { query, ...options });
     }
-    /**
-     * __chat.start__
-     *
-     * Start a chat conversation. This endpoint will return immediately.
-     *
-     * The `conversationId` field in the response can be used to generate messages.
-     *
-     * ** WARNING ** This endpoint is not idempotent. If you call it multiple times, you will generate multiple conversations.
-     */
     /**
      * @example
      * ```ts
@@ -78,26 +50,24 @@ class Chat extends resource_1.APIResource {
         return this._client.post('/v1/conversation/chat/create', { body, ...options });
     }
     /**
-     * Returns a chat message for a conversation. This endpoint will poll until a response is ready.
-     *
-     * When it return the response is the latest message type that is of type `BOT_RESPONSE`.
+     * Send a message and poll until a response is ready.
      *
-     * @see {@link Chat.poll}
+     * This is a convenience wrapper that calls {@link Chat.generate} then {@link Chat.poll}.
      */
     message(body, options) {
         return this.generate(body, options).then((response) => this.poll({ conversationId: response.conversationId }, options));
     }
     /**
-     * __chat.poll__
+     * Poll until the conversation has a bot response ready.
      *
-     * Polls until it returns a BOT chat message for a conversation.
+     * Stops when `latestMessageType` is `BOT_RESPONSE` or `PENDING_RESPONSE`,
+     * or when `status` is `Escalated` or `Error`.
      */
     poll(query, options) {
         return (0, poll_until_1.pollUntil)(() => this._client.get('/v1/conversation/chat/message', { query, ...options }), {
             timeout: options?.timeout || 180000,
             interval: 2000,
             condition: (conversation) => {
-                // Don't poll if the conversation is escalated or in error
                 if (conversation.status === 'Escalated' || conversation.status === 'Error') {
                     return true;
                 }
@@ -110,18 +80,14 @@ class Chat extends resource_1.APIResource {
         });
     }
     /**
-     * __chat.streamUpdates__
-     *
      * Create a persistent stream of updates for a conversation.
-     * Responses from the bot will arrive as events. Consuming clients must aggregate multiple chunks
-     * into a single message based on the messageId field. Note that new messages may arrive without
-     * new user messages, this update stream is open indefinitely and does not automatically close - avoid
+     *
+     * Responses from the bot will arrive as events. Consuming clients must aggregate
+     * multiple chunks into a single message based on the `messageId` field.
+     *
+     * This stream is open indefinitely and does not automatically close — avoid
      * blocking other operations while listening to events from this generator.
      *
-     * @param params.conversationId - Conversation/ticket ID to subscribe to.
-     * @returns AsyncGenerator<ChatStreamEvent> a generator that emits response events as they arrive.
-     */
-    /**
      * @example
      * ```ts
      * for await (const evt of client.conversation.chat.streamUpdates({ conversationId: 'abc123' })) {
@@ -133,7 +99,7 @@ class Chat extends resource_1.APIResource {
         const queries = new URLSearchParams();
         queries.set('sseMessageTypes', 'new-message,message-chunk,message-complete');
         queries.set('ticketMessageTypes', 'BOT_RESPONSE');
-        const url = `/v1/ticket/sse/${params.conversationId}?${queries.toString()}`;
+        const url = `${this._client.baseURL}/v1/ticket/sse/${params.conversationId}?${queries.toString()}`;
         const eventSource = new eventsource_1.EventSource(url);
         const output = new promise_1.DeferredAsyncIterable();
         eventSource.addEventListener('error', (evt) => {

package/resources/conversation/chat.js.map

@@ -1 +1 @@
-{"version":3,"file":"chat.js","sourceRoot":"","sources":["../../src/resources/conversation/chat.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,gDAA6C;AAE7C,oEAAgE;AAEhE,6CAA0C;AAC1C,8DAAyE;AAEzE,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;;;;;;;;;OAaG;IAEH;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,IAAwB,EAAE,OAA6B;QAC9D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;OAIG;IAEH;;;;;;;OAOG;IACH,GAAG,CAAC,KAAoB,EAAE,OAA6B;QACrD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;OAQG;IAEH;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAqB,EAAE,OAA6B;QACxD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,8BAA8B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;;;OAMG;IACH,OAAO,CAAC,IAAwB,EAAE,OAA6B;QAC7D,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CACpD,IAAI,CAAC,IAAI,CAAC,EAAE,cAAc,EAAE,QAAQ,CAAC,cAAc,EAAE,EAAE,OAAO,CAAC,CAC5B,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACH,IAAI,CAAC,KAAoB,EAAE,OAA6B;QACtD,OAAO,IAAA,sBAAS,EACd,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,EAC9E;YACE,OAAO,EAAE,OAAO,EAAE,OAAO,IAAI,MAAO;YACpC,QAAQ,EAAE,IAAK;YACf,SAAS,EAAE,CAAC,YAAY,EAAE,EAAE;gBAC1B,0DAA0D;gBAC1D,IAAI,YAAY,CAAC,MAAM,KAAK,WAAW,IAAI,YAAY,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;oBAC3E,OAAO,IAAI,CAAC;gBACd,CAAC;gBAED,IACE,YAAY,CAAC,iBAAiB,KAAK,cAAc;oBACjD,YAAY,CAAC,iBAAiB,KAAK,kBAAkB,EACrD,CAAC;oBACD,OAAO,IAAI,CAAC;gBACd,CAAC;gBAED,OAAO,KAAK,CAAC;YACf,CAAC;SACF,CACkC,CAAC;IACxC,CAAC;IAED;;;;;;;;;;;OAWG;IAEH;;;;;;;OAOG;IACH,aAAa,CAAC,MAAwB;QACpC,MAAM,OAAO,GAAG,IAAI,eAAe,EAAE,CAAC;QACtC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,4CAA4C,CAAC,CAAC;QAC7E,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,cAAc,CAAC,CAAC;QAClD,MAAM,GAAG,GAAG,kBAAkB,MAAM,CAAC,cAAc,IAAI,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;QAC5E,MAAM,WAAW,GAAG,IAAI,yBAAW,CAAC,GAAG,CAAC,CAAC;QACzC,MAAM,MAAM,GAAG,IAAI,+BAAqB,EAAmB,CAAC;QAE5D,WAAW,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YAC5C,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE;YAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAClC,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;gBAClB,KAAK,aAAa;oBAChB,MAAM,CAAC,IAAI,CAAC;wBACV,IAAI,EAAE,aAAa;wBACnB,SAAS,EAAE,IAAI,CAAC,SAAS;wBACzB,SAAS,EAAE,IAAI,CAAC,SAAS;wBACzB,OAAO,EAAE,IAAI,CAAC,OAAO;qBACtB,CAAC,CAAC;oBACH,MAAM;gBACR,KAAK,eAAe;oBAClB,MAAM,CAAC,IAAI,CAAC;wBACV,IAAI,EAAE,eAAe;wBACrB,YAAY,EAAE,IAAI,CAAC,YAAY;wBAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;qBAC1B,CAAC,CAAC;oBACH,MAAM;gBACR,KAAK,kBAAkB;oBACrB,MAAM,CAAC,IAAI,CAAC;wBACV,IAAI,EAAE,kBAAkB;wBACxB,SAAS,EAAE,IAAI,CAAC,SAAS;qBAC1B,CAAC,CAAC;oBACH,MAAM;gBACR;oBACE,MAAM;YACV,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAxLD,oBAwLC"}
+{"version":3,"file":"chat.js","sourceRoot":"","sources":["../../src/resources/conversation/chat.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,qDAAkD;AAIlD,wDAAiD;AACjD,kDAA0D;AAC1D,6CAA0C;AAE1C,MAAa,IAAK,SAAQ,sBAAW;IACnC;;;;;;;;;;;;;;;OAeG;IACH,QAAQ,CAAC,IAAwB,EAAE,OAAwB;QACzD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,+BAA+B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;OAOG;IACH,GAAG,CAAC,KAAoB,EAAE,OAAwB;QAChD,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAClF,CAAC;IAED;;;;;;;;OAQG;IACH,KAAK,CAAC,IAAqB,EAAE,OAAwB;QACnD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,8BAA8B,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACjF,CAAC;IAED;;;;OAIG;IACH,OAAO,CAAC,IAAwB,EAAE,OAAwB;QACxD,OAAO,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,QAAQ,EAAE,EAAE,CACpD,IAAI,CAAC,IAAI,CAAC,EAAE,cAAc,EAAE,QAAQ,CAAC,cAAc,EAAE,EAAE,OAAO,CAAC,CACjC,CAAC;IACnC,CAAC;IAED;;;;;OAKG;IACH,IAAI,CAAC,KAAoB,EAAE,OAAwB;QACjD,OAAO,IAAA,sBAAS,EACd,GAAG,EAAE,CAAC,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,+BAA+B,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,EAC9E;YACE,OAAO,EAAE,OAAO,EAAE,OAAO,IAAI,MAAO;YACpC,QAAQ,EAAE,IAAK;YACf,SAAS,EAAE,CAAC,YAAY,EAAE,EAAE;gBAC1B,IAAI,YAAY,CAAC,MAAM,KAAK,WAAW,IAAI,YAAY,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;oBAC3E,OAAO,IAAI,CAAC;gBACd,CAAC;gBAED,IACE,YAAY,CAAC,iBAAiB,KAAK,cAAc;oBACjD,YAAY,CAAC,iBAAiB,KAAK,kBAAkB,EACrD,CAAC;oBACD,OAAO,IAAI,CAAC;gBACd,CAAC;gBAED,OAAO,KAAK,CAAC;YACf,CAAC;SACF,CAC6B,CAAC;IACnC,CAAC;IAED;;;;;;;;;;;;;;;OAeG;IACH,aAAa,CAAC,MAAwB;QACpC,MAAM,OAAO,GAAG,IAAI,eAAe,EAAE,CAAC;QACtC,OAAO,CAAC,GAAG,CAAC,iBAAiB,EAAE,4CAA4C,CAAC,CAAC;QAC7E,OAAO,CAAC,GAAG,CAAC,oBAAoB,EAAE,cAAc,CAAC,CAAC;QAClD,MAAM,GAAG,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,kBAAkB,MAAM,CAAC,cAAc,IAAI,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC;QACnG,MAAM,WAAW,GAAG,IAAI,yBAAW,CAAC,GAAG,CAAC,CAAC;QACzC,MAAM,MAAM,GAAG,IAAI,+BAAqB,EAAmB,CAAC;QAE5D,WAAW,CAAC,gBAAgB,CAAC,OAAO,EAAE,CAAC,GAAG,EAAE,EAAE;YAC5C,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;QACrB,CAAC,CAAC,CAAC;QAEH,WAAW,CAAC,gBAAgB,CAAC,SAAS,EAAE,CAAC,GAAG,EAAE,EAAE;YAC9C,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;YAClC,QAAQ,IAAI,CAAC,IAAI,EAAE,CAAC;gBAClB,KAAK,aAAa;oBAChB,MAAM,CAAC,IAAI,CAAC;wBACV,IAAI,EAAE,aAAa;wBACnB,SAAS,EAAE,IAAI,CAAC,SAAS;wBACzB,SAAS,EAAE,IAAI,CAAC,SAAS;wBACzB,OAAO,EAAE,IAAI,CAAC,OAAO;qBACtB,CAAC,CAAC;oBACH,MAAM;gBACR,KAAK,eAAe;oBAClB,MAAM,CAAC,IAAI,CAAC;wBACV,IAAI,EAAE,eAAe;wBACrB,YAAY,EAAE,IAAI,CAAC,YAAY;wBAC/B,SAAS,EAAE,IAAI,CAAC,SAAS;qBAC1B,CAAC,CAAC;oBACH,MAAM;gBACR,KAAK,kBAAkB;oBACrB,MAAM,CAAC,IAAI,CAAC;wBACV,IAAI,EAAE,kBAAkB;wBACxB,SAAS,EAAE,IAAI,CAAC,SAAS;qBAC1B,CAAC,CAAC;oBACH,MAAM;gBACR;oBACE,MAAM;YACV,CAAC;QACH,CAAC,CAAC,CAAC;QAEH,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAlJD,oBAkJC"}