@whop/sdk 0.0.27 → 0.0.29

package/resources/account-links.js.map

@@ -1 +1 @@
-{"version":3,"file":"account-links.js","sourceRoot":"","sources":["../src/resources/account-links.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAA6B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF;AAnBD,oCAmBC"}
+{"version":3,"file":"account-links.js","sourceRoot":"","sources":["../src/resources/account-links.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAI/C,MAAa,YAAa,SAAQ,sBAAW;IAC3C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAA6B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF;AAlBD,oCAkBC"}

package/resources/account-links.mjs

@@ -2,9 +2,8 @@
 import { APIResource } from "../core/resource.mjs";
 export class AccountLinks extends APIResource {
     /**
-     * Generates a url that a user can be directed to in order to access their
-     * sub-merchant account. For example, they can visit the hosted payouts portal or
-     * the hosted KYC onboarding flow.
+     * Generate a URL that directs a sub-merchant to their account portal, such as the
+     * hosted payouts dashboard or the KYC onboarding flow.
      *
      * @example
      * ```ts

package/resources/account-links.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"account-links.mjs","sourceRoot":"","sources":["../src/resources/account-links.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,IAA6B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF"}
+{"version":3,"file":"account-links.mjs","sourceRoot":"","sources":["../src/resources/account-links.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;AAItB,MAAM,OAAO,YAAa,SAAQ,WAAW;IAC3C;;;;;;;;;;;;;OAaG;IACH,MAAM,CAAC,IAA6B,EAAE,OAAwB;QAC5D,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACnE,CAAC;CACF"}

package/resources/ai-chats.d.mts

@@ -4,7 +4,7 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
 import { RequestOptions } from "../internal/request-options.mjs";
 export declare class AIChats extends APIResource {
     /**
-     * Creates a new AI chat
+     * Create a new AI chat thread and send the first message to the AI agent.
      *
      * Required permissions:
      *
@@ -12,11 +12,11 @@ export declare class AIChats extends APIResource {
      */
     create(body: AIChatCreateParams, options?: RequestOptions): APIPromise<AIChat>;
     /**
-     * Fetches a single AI chat by ID
+     * Retrieves the details of an existing AI chat.
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<AIChat>;
     /**
-     * Updates an AI chat
+     * Update an AI chat's title or associated company context.
      *
      * Required permissions:
      *
@@ -24,11 +24,11 @@ export declare class AIChats extends APIResource {
      */
     update(id: string, body?: AIChatUpdateParams | null | undefined, options?: RequestOptions): APIPromise<AIChat>;
     /**
-     * Fetches all AI chats for the current user
+     * Returns a paginated list of AI chat threads for the current authenticated user.
      */
     list(query?: AIChatListParams | null | undefined, options?: RequestOptions): PagePromise<AIChatListResponsesCursorPage, AIChatListResponse>;
     /**
-     * Deletes an AI chat
+     * Delete an AI chat thread so it no longer appears in the user's chat list.
      *
      * Required permissions:
      *
@@ -38,7 +38,8 @@ export declare class AIChats extends APIResource {
 }
 export type AIChatListResponsesCursorPage = CursorPage<AIChatListResponse>;
 /**
- * An AI chat conversation belonging to a user
+ * An AI-powered chat conversation belonging to a user, with optional scheduled
+ * automation.
  */
 export interface AIChat {
     /**
@@ -46,7 +47,7 @@ export interface AIChat {
      */
     id: string;
     /**
-     * The total number of tokens used in the chat
+     * The total number of tokens consumed across all messages in this conversation.
      */
     blended_token_usage: string;
     /**
@@ -54,15 +55,17 @@ export interface AIChat {
      */
     created_at: string;
     /**
-     * When the last message was sent
+     * The timestamp of the most recent message in this conversation. Null if no
+     * messages have been sent yet.
      */
     last_message_at: string | null;
     /**
-     * The number of messages in the chat
+     * The total number of messages exchanged in this conversation.
      */
     message_count: number;
     /**
-     * The title of the AI chat
+     * A short descriptive title for this AI chat conversation. Null if no title has
+     * been set.
      */
     title: string | null;
     /**
@@ -70,13 +73,13 @@ export interface AIChat {
      */
     updated_at: string;
     /**
-     * The user who owns the AI chat
+     * The user who owns this AI chat conversation.
      */
     user: AIChat.User;
 }
 export declare namespace AIChat {
     /**
-     * The user who owns the AI chat
+     * The user who owns this AI chat conversation.
      */
     interface User {
         /**
@@ -86,7 +89,8 @@ export declare namespace AIChat {
     }
 }
 /**
- * An AI chat conversation belonging to a user
+ * An AI-powered chat conversation belonging to a user, with optional scheduled
+ * automation.
  */
 export interface AIChatListResponse {
     /**
@@ -94,7 +98,7 @@ export interface AIChatListResponse {
      */
     id: string;
     /**
-     * The total number of tokens used in the chat
+     * The total number of tokens consumed across all messages in this conversation.
      */
     blended_token_usage: string;
     /**
@@ -102,15 +106,17 @@ export interface AIChatListResponse {
      */
     created_at: string;
     /**
-     * When the last message was sent
+     * The timestamp of the most recent message in this conversation. Null if no
+     * messages have been sent yet.
      */
     last_message_at: string | null;
     /**
-     * The number of messages in the chat
+     * The total number of messages exchanged in this conversation.
      */
     message_count: number;
     /**
-     * The title of the AI chat
+     * A short descriptive title for this AI chat conversation. Null if no title has
+     * been set.
      */
     title: string | null;
     /**
@@ -118,13 +124,13 @@ export interface AIChatListResponse {
      */
     updated_at: string;
     /**
-     * The user who owns the AI chat
+     * The user who owns this AI chat conversation.
      */
     user: AIChatListResponse.User;
 }
 export declare namespace AIChatListResponse {
     /**
-     * The user who owns the AI chat
+     * The user who owns this AI chat conversation.
      */
     interface User {
         /**
@@ -139,20 +145,25 @@ export declare namespace AIChatListResponse {
 export type AIChatDeleteResponse = boolean;
 export interface AIChatCreateParams {
     /**
-     * The text content of the first message sent in the chat
+     * The text content of the first message to send to the AI agent.
      */
     message_text: string;
     /**
-     * The ID of the company to set as the current company in context for the AI chat
+     * The unique identifier of the company to set as context for the AI chat (e.g.,
+     * "biz_XXXXX").
      */
     current_company_id?: string | null;
     /**
-     * The IDs of existing uploaded attachments to include in the first message to the
-     * agent
+     * A list of previously uploaded file attachments to include with the first
+     * message.
      */
     message_attachments?: Array<AIChatCreateParams.MessageAttachment> | null;
     /**
-     * The title of the AI chat
+     * The source of an AI chat message
+     */
+    message_source?: 'manual' | 'suggestion' | 'link' | null;
+    /**
+     * An optional display title for the AI chat thread (e.g., "Help with billing").
      */
     title?: string | null;
 }
@@ -169,11 +180,12 @@ export declare namespace AIChatCreateParams {
 }
 export interface AIChatUpdateParams {
     /**
-     * The ID of the company to set as the current company in context for the AI chat
+     * The unique identifier of the company to set as context for the AI chat (e.g.,
+     * "biz_XXXXX").
      */
     current_company_id?: string | null;
     /**
-     * The new title for the AI chat
+     * The new display title for the AI chat thread (e.g., "Help with billing").
      */
     title?: string | null;
 }

package/resources/ai-chats.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"ai-chats.d.mts","sourceRoot":"","sources":["../src/resources/ai-chats.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI9E;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIlE;;;;;;OAMG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC;IAIrB;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6BAA6B,EAAE,kBAAkB,CAAC;IAIjE;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAG/E;AAED,MAAM,MAAM,6BAA6B,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;AAE3E;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;CACnB;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;CAC/B;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC;AAE3C,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;IAEzE;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
+{"version":3,"file":"ai-chats.d.mts","sourceRoot":"","sources":["../src/resources/ai-chats.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI9E;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIlE;;;;;;OAMG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC;IAIrB;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6BAA6B,EAAE,kBAAkB,CAAC;IAIjE;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAG/E;AAED,MAAM,MAAM,6BAA6B,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;AAE3E;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;CACnB;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;CAC/B;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC;AAE3C,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;IAEzE;;OAEG;IACH,cAAc,CAAC,EAAE,QAAQ,GAAG,YAAY,GAAG,MAAM,GAAG,IAAI,CAAC;IAEzD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}

package/resources/ai-chats.d.ts

@@ -4,7 +4,7 @@ import { CursorPage, type CursorPageParams, PagePromise } from "../core/paginati
 import { RequestOptions } from "../internal/request-options.js";
 export declare class AIChats extends APIResource {
     /**
-     * Creates a new AI chat
+     * Create a new AI chat thread and send the first message to the AI agent.
      *
      * Required permissions:
      *
@@ -12,11 +12,11 @@ export declare class AIChats extends APIResource {
      */
     create(body: AIChatCreateParams, options?: RequestOptions): APIPromise<AIChat>;
     /**
-     * Fetches a single AI chat by ID
+     * Retrieves the details of an existing AI chat.
      */
     retrieve(id: string, options?: RequestOptions): APIPromise<AIChat>;
     /**
-     * Updates an AI chat
+     * Update an AI chat's title or associated company context.
      *
      * Required permissions:
      *
@@ -24,11 +24,11 @@ export declare class AIChats extends APIResource {
      */
     update(id: string, body?: AIChatUpdateParams | null | undefined, options?: RequestOptions): APIPromise<AIChat>;
     /**
-     * Fetches all AI chats for the current user
+     * Returns a paginated list of AI chat threads for the current authenticated user.
      */
     list(query?: AIChatListParams | null | undefined, options?: RequestOptions): PagePromise<AIChatListResponsesCursorPage, AIChatListResponse>;
     /**
-     * Deletes an AI chat
+     * Delete an AI chat thread so it no longer appears in the user's chat list.
      *
      * Required permissions:
      *
@@ -38,7 +38,8 @@ export declare class AIChats extends APIResource {
 }
 export type AIChatListResponsesCursorPage = CursorPage<AIChatListResponse>;
 /**
- * An AI chat conversation belonging to a user
+ * An AI-powered chat conversation belonging to a user, with optional scheduled
+ * automation.
  */
 export interface AIChat {
     /**
@@ -46,7 +47,7 @@ export interface AIChat {
      */
     id: string;
     /**
-     * The total number of tokens used in the chat
+     * The total number of tokens consumed across all messages in this conversation.
      */
     blended_token_usage: string;
     /**
@@ -54,15 +55,17 @@ export interface AIChat {
      */
     created_at: string;
     /**
-     * When the last message was sent
+     * The timestamp of the most recent message in this conversation. Null if no
+     * messages have been sent yet.
      */
     last_message_at: string | null;
     /**
-     * The number of messages in the chat
+     * The total number of messages exchanged in this conversation.
      */
     message_count: number;
     /**
-     * The title of the AI chat
+     * A short descriptive title for this AI chat conversation. Null if no title has
+     * been set.
      */
     title: string | null;
     /**
@@ -70,13 +73,13 @@ export interface AIChat {
      */
     updated_at: string;
     /**
-     * The user who owns the AI chat
+     * The user who owns this AI chat conversation.
      */
     user: AIChat.User;
 }
 export declare namespace AIChat {
     /**
-     * The user who owns the AI chat
+     * The user who owns this AI chat conversation.
      */
     interface User {
         /**
@@ -86,7 +89,8 @@ export declare namespace AIChat {
     }
 }
 /**
- * An AI chat conversation belonging to a user
+ * An AI-powered chat conversation belonging to a user, with optional scheduled
+ * automation.
  */
 export interface AIChatListResponse {
     /**
@@ -94,7 +98,7 @@ export interface AIChatListResponse {
      */
     id: string;
     /**
-     * The total number of tokens used in the chat
+     * The total number of tokens consumed across all messages in this conversation.
      */
     blended_token_usage: string;
     /**
@@ -102,15 +106,17 @@ export interface AIChatListResponse {
      */
     created_at: string;
     /**
-     * When the last message was sent
+     * The timestamp of the most recent message in this conversation. Null if no
+     * messages have been sent yet.
      */
     last_message_at: string | null;
     /**
-     * The number of messages in the chat
+     * The total number of messages exchanged in this conversation.
      */
     message_count: number;
     /**
-     * The title of the AI chat
+     * A short descriptive title for this AI chat conversation. Null if no title has
+     * been set.
      */
     title: string | null;
     /**
@@ -118,13 +124,13 @@ export interface AIChatListResponse {
      */
     updated_at: string;
     /**
-     * The user who owns the AI chat
+     * The user who owns this AI chat conversation.
      */
     user: AIChatListResponse.User;
 }
 export declare namespace AIChatListResponse {
     /**
-     * The user who owns the AI chat
+     * The user who owns this AI chat conversation.
      */
     interface User {
         /**
@@ -139,20 +145,25 @@ export declare namespace AIChatListResponse {
 export type AIChatDeleteResponse = boolean;
 export interface AIChatCreateParams {
     /**
-     * The text content of the first message sent in the chat
+     * The text content of the first message to send to the AI agent.
      */
     message_text: string;
     /**
-     * The ID of the company to set as the current company in context for the AI chat
+     * The unique identifier of the company to set as context for the AI chat (e.g.,
+     * "biz_XXXXX").
      */
     current_company_id?: string | null;
     /**
-     * The IDs of existing uploaded attachments to include in the first message to the
-     * agent
+     * A list of previously uploaded file attachments to include with the first
+     * message.
      */
     message_attachments?: Array<AIChatCreateParams.MessageAttachment> | null;
     /**
-     * The title of the AI chat
+     * The source of an AI chat message
+     */
+    message_source?: 'manual' | 'suggestion' | 'link' | null;
+    /**
+     * An optional display title for the AI chat thread (e.g., "Help with billing").
      */
     title?: string | null;
 }
@@ -169,11 +180,12 @@ export declare namespace AIChatCreateParams {
 }
 export interface AIChatUpdateParams {
     /**
-     * The ID of the company to set as the current company in context for the AI chat
+     * The unique identifier of the company to set as context for the AI chat (e.g.,
+     * "biz_XXXXX").
      */
     current_company_id?: string | null;
     /**
-     * The new title for the AI chat
+     * The new display title for the AI chat thread (e.g., "Help with billing").
      */
     title?: string | null;
 }

package/resources/ai-chats.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"ai-chats.d.ts","sourceRoot":"","sources":["../src/resources/ai-chats.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI9E;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIlE;;;;;;OAMG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC;IAIrB;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6BAA6B,EAAE,kBAAkB,CAAC;IAIjE;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAG/E;AAED,MAAM,MAAM,6BAA6B,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;AAE3E;;GAEG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;CACnB;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;CAC/B;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC;AAE3C,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;IAEzE;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
+{"version":3,"file":"ai-chats.d.ts","sourceRoot":"","sources":["../src/resources/ai-chats.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OACd,EAAE,UAAU,EAAE,KAAK,gBAAgB,EAAE,WAAW,EAAE;OAClD,EAAE,cAAc,EAAE;AAGzB,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;;;;;OAMG;IACH,MAAM,CAAC,IAAI,EAAE,kBAAkB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAI9E;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,MAAM,CAAC;IAIlE;;;;;;OAMG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,kBAAkB,GAAG,IAAI,GAAG,SAAc,EAChD,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC;IAIrB;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC/C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,6BAA6B,EAAE,kBAAkB,CAAC;IAIjE;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,oBAAoB,CAAC;CAG/E;AAED,MAAM,MAAM,6BAA6B,GAAG,UAAU,CAAC,kBAAkB,CAAC,CAAC;AAE3E;;;GAGG;AACH,MAAM,WAAW,MAAM;IACrB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,MAAM,CAAC,IAAI,CAAC;CACnB;AAED,yBAAiB,MAAM,CAAC;IACtB;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,mBAAmB,EAAE,MAAM,CAAC;IAE5B;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,eAAe,EAAE,MAAM,GAAG,IAAI,CAAC;IAE/B;;OAEG;IACH,aAAa,EAAE,MAAM,CAAC;IAEtB;;;OAGG;IACH,KAAK,EAAE,MAAM,GAAG,IAAI,CAAC;IAErB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,IAAI,EAAE,kBAAkB,CAAC,IAAI,CAAC;CAC/B;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,IAAI;QACnB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED;;GAEG;AACH,MAAM,MAAM,oBAAoB,GAAG,OAAO,CAAC;AAE3C,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,YAAY,EAAE,MAAM,CAAC;IAErB;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;;OAGG;IACH,mBAAmB,CAAC,EAAE,KAAK,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,GAAG,IAAI,CAAC;IAEzE;;OAEG;IACH,cAAc,CAAC,EAAE,QAAQ,GAAG,YAAY,GAAG,MAAM,GAAG,IAAI,CAAC;IAEzD;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;KACZ;CACF;AAED,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,kBAAkB,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEnC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACvB;AAED,MAAM,WAAW,gBAAiB,SAAQ,gBAAgB;IACxD;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEvB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;CACtB;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,MAAM,IAAI,MAAM,EACrB,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,6BAA6B,IAAI,6BAA6B,EACnE,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}

package/resources/ai-chats.js

@@ -7,7 +7,7 @@ const pagination_1 = require("../core/pagination.js");
 const path_1 = require("../internal/utils/path.js");
 class AIChats extends resource_1.APIResource {
     /**
-     * Creates a new AI chat
+     * Create a new AI chat thread and send the first message to the AI agent.
      *
      * Required permissions:
      *
@@ -17,13 +17,13 @@ class AIChats extends resource_1.APIResource {
         return this._client.post('/ai_chats', { body, ...options });
     }
     /**
-     * Fetches a single AI chat by ID
+     * Retrieves the details of an existing AI chat.
      */
     retrieve(id, options) {
         return this._client.get((0, path_1.path) `/ai_chats/${id}`, options);
     }
     /**
-     * Updates an AI chat
+     * Update an AI chat's title or associated company context.
      *
      * Required permissions:
      *
@@ -33,13 +33,13 @@ class AIChats extends resource_1.APIResource {
         return this._client.patch((0, path_1.path) `/ai_chats/${id}`, { body, ...options });
     }
     /**
-     * Fetches all AI chats for the current user
+     * Returns a paginated list of AI chat threads for the current authenticated user.
      */
     list(query = {}, options) {
         return this._client.getAPIList('/ai_chats', (pagination_1.CursorPage), { query, ...options });
     }
     /**
-     * Deletes an AI chat
+     * Delete an AI chat thread so it no longer appears in the user's chat list.
      *
      * Required permissions:
      *

package/resources/ai-chats.mjs

@@ -4,7 +4,7 @@ import { CursorPage } from "../core/pagination.mjs";
 import { path } from "../internal/utils/path.mjs";
 export class AIChats extends APIResource {
     /**
-     * Creates a new AI chat
+     * Create a new AI chat thread and send the first message to the AI agent.
      *
      * Required permissions:
      *
@@ -14,13 +14,13 @@ export class AIChats extends APIResource {
         return this._client.post('/ai_chats', { body, ...options });
     }
     /**
-     * Fetches a single AI chat by ID
+     * Retrieves the details of an existing AI chat.
      */
     retrieve(id, options) {
         return this._client.get(path `/ai_chats/${id}`, options);
     }
     /**
-     * Updates an AI chat
+     * Update an AI chat's title or associated company context.
      *
      * Required permissions:
      *
@@ -30,13 +30,13 @@ export class AIChats extends APIResource {
         return this._client.patch(path `/ai_chats/${id}`, { body, ...options });
     }
     /**
-     * Fetches all AI chats for the current user
+     * Returns a paginated list of AI chat threads for the current authenticated user.
      */
     list(query = {}, options) {
         return this._client.getAPIList('/ai_chats', (CursorPage), { query, ...options });
     }
     /**
-     * Deletes an AI chat
+     * Delete an AI chat thread so it no longer appears in the user's chat list.
      *
      * Required permissions:
      *