retell-sdk 5.31.0 → 5.32.0

package/src/resources/chat-agent.ts

@@ -43,6 +43,21 @@ export class ChatAgent extends APIResource {
     return this._client.get(path`/get-chat-agent/${agentID}`, { query, ...options });
   }
 
+  /**
+   * List all chat agents
+   *
+   * @example
+   * ```ts
+   * const chatAgentResponses = await client.chatAgent.list();
+   * ```
+   */
+  list(
+    query: ChatAgentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ChatAgentListResponse> {
+    return this._client.get('/list-chat-agents', { query, ...options });
+  }
+
   /**
    * Update an existing chat agent
    *
@@ -63,32 +78,35 @@ export class ChatAgent extends APIResource {
   }
 
   /**
-   * List all chat agents
+   * Delete an existing chat agent
    *
    * @example
    * ```ts
-   * const chatAgentResponses = await client.chatAgent.list();
+   * await client.chatAgent.delete(
+   *   'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
+   * );
    * ```
    */
-  list(
-    query: ChatAgentListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<ChatAgentListResponse> {
-    return this._client.get('/list-chat-agents', { query, ...options });
+  delete(agentID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/delete-chat-agent/${agentID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
   }
 
   /**
-   * Delete an existing chat agent
+   * Publish an existing draft version in place.
    *
    * @example
    * ```ts
-   * await client.chatAgent.delete(
-   *   'oBeDLoLOeuAbiuaMFXRtDOLriTJ5tSxD',
-   * );
+   * await client.chatAgent.publish('agent_xxx', {
+   *   version: 15,
+   * });
    * ```
    */
-  delete(agentID: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/delete-chat-agent/${agentID}`, {
+  publish(agentID: string, body: ChatAgentPublishParams, options?: RequestOptions): APIPromise<void> {
+    return this._client.post(path`/publish-agent-version/${agentID}`, {
+      body,
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -150,24 +168,6 @@ export class ChatAgent extends APIResource {
   getVersions(agentID: string, options?: RequestOptions): APIPromise<ChatAgentGetVersionsResponse> {
     return this._client.get(path`/get-chat-agent-versions/${agentID}`, options);
   }
-
-  /**
-   * Publish an existing draft version in place.
-   *
-   * @example
-   * ```ts
-   * await client.chatAgent.publish('agent_xxx', {
-   *   version: 15,
-   * });
-   * ```
-   */
-  publish(agentID: string, body: ChatAgentPublishParams, options?: RequestOptions): APIPromise<void> {
-    return this._client.post(path`/publish-agent-version/${agentID}`, {
-      body,
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
-  }
 }
 
 export interface ChatAgentResponse {
@@ -1401,6 +1401,33 @@ export interface ChatAgentRetrieveParams {
   version?: number | string;
 }
 
+export interface ChatAgentListParams {
+  /**
+   * If true, only return the latest version of each chat agent.
+   */
+  is_latest?: boolean;
+
+  /**
+   * A limit on the number of objects to be returned. Limit can range between 1 and
+   * 1000, and the default is 1000.
+   */
+  limit?: number;
+
+  /**
+   * The pagination key to continue fetching the next page of agents. Pagination key
+   * is represented by a agent id, pagination key and version pair is exclusive (not
+   * included in the fetched page). If not set, will start from the beginning.
+   */
+  pagination_key?: string;
+
+  /**
+   * Specifies the version of the agent associated with the pagination_key. When
+   * paginating, both the pagination_key and its version must be provided to ensure
+   * consistent ordering and to fetch the next page correctly.
+   */
+  pagination_key_version?: number;
+}
+
 export interface ChatAgentUpdateParams {
   /**
    * Query param: Optional version of the API to use for this request. Default to
@@ -2002,31 +2029,10 @@ export namespace ChatAgentUpdateParams {
   }
 }
 
-export interface ChatAgentListParams {
-  /**
-   * If true, only return the latest version of each chat agent.
-   */
-  is_latest?: boolean;
-
-  /**
-   * A limit on the number of objects to be returned. Limit can range between 1 and
-   * 1000, and the default is 1000.
-   */
-  limit?: number;
-
-  /**
-   * The pagination key to continue fetching the next page of agents. Pagination key
-   * is represented by a agent id, pagination key and version pair is exclusive (not
-   * included in the fetched page). If not set, will start from the beginning.
-   */
-  pagination_key?: string;
+export interface ChatAgentPublishParams {
+  version: number;
 
-  /**
-   * Specifies the version of the agent associated with the pagination_key. When
-   * paginating, both the pagination_key and its version must be provided to ensure
-   * consistent ordering and to fetch the next page correctly.
-   */
-  pagination_key_version?: number;
+  version_description?: string;
 }
 
 export interface ChatAgentCreateVersionParams {
@@ -2043,12 +2049,6 @@ export interface ChatAgentDeleteVersionParams {
   version: number;
 }
 
-export interface ChatAgentPublishParams {
-  version: number;
-
-  version_description?: string;
-}
-
 export declare namespace ChatAgent {
   export {
     type ChatAgentResponse as ChatAgentResponse,
@@ -2057,10 +2057,10 @@ export declare namespace ChatAgent {
     type ChatAgentGetVersionsResponse as ChatAgentGetVersionsResponse,
     type ChatAgentCreateParams as ChatAgentCreateParams,
     type ChatAgentRetrieveParams as ChatAgentRetrieveParams,
-    type ChatAgentUpdateParams as ChatAgentUpdateParams,
     type ChatAgentListParams as ChatAgentListParams,
+    type ChatAgentUpdateParams as ChatAgentUpdateParams,
+    type ChatAgentPublishParams as ChatAgentPublishParams,
     type ChatAgentCreateVersionParams as ChatAgentCreateVersionParams,
     type ChatAgentDeleteVersionParams as ChatAgentDeleteVersionParams,
-    type ChatAgentPublishParams as ChatAgentPublishParams,
   };
 }

package/src/resources/chat.ts

@@ -23,74 +23,49 @@ export class Chat extends APIResource {
   }
 
   /**
-   * Retrieve details of a specific chat
-   *
-   * @example
-   * ```ts
-   * const chatResponse = await client.chat.retrieve(
-   *   '16b980523634a6dc504898cda492e939',
-   * );
-   * ```
-   */
-  retrieve(chatID: string, options?: RequestOptions): APIPromise<ChatResponse> {
-    return this._client.get(path`/get-chat/${chatID}`, options);
-  }
-
-  /**
-   * Update metadata and sensitive data storage settings for an existing chat.
+   * Start an outbound SMS chat conversation with a phone number using the specified
+   * agent. The agent must be configured for chat mode. The initial SMS message will
+   * be automatically generated and sent based on the agent's configuration.
    *
    * @example
    * ```ts
-   * const chatResponse = await client.chat.update(
-   *   'chat_98c1a2157aa0559144d67bb0729',
-   *   {
-   *     data_storage_setting: 'everything',
-   *     metadata: {
-   *       customer_id: 'cust_123',
-   *       notes: 'Follow-up required',
-   *     },
-   *     override_dynamic_variables: {
-   *       additional_discount: '15%',
-   *     },
-   *   },
-   * );
+   * const chatResponse = await client.chat.createSMSChat({
+   *   from_number: '+12137771234',
+   *   to_number: '+14155551234',
+   * });
    * ```
    */
-  update(chatID: string, body: ChatUpdateParams, options?: RequestOptions): APIPromise<ChatResponse> {
-    return this._client.patch(path`/update-chat/${chatID}`, { body, ...options });
+  createSMSChat(body: ChatCreateSMSChatParams, options?: RequestOptions): APIPromise<ChatResponse> {
+    return this._client.post('/create-sms-chat', { body, ...options });
   }
 
   /**
-   * List chats with unified cursor pagination response.
+   * End an ongoing chat
    *
    * @example
    * ```ts
-   * const chats = await client.chat.list();
+   * await client.chat.end('16b980523634a6dc504898cda492e939');
    * ```
    */
-  list(body: ChatListParams | null | undefined = {}, options?: RequestOptions): APIPromise<ChatListResponse> {
-    return this._client.post('/v3/list-chats', {
-      body,
-      timeout: (this._client as any)._options.timeout ?? 300000,
+  end(chatID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.patch(path`/end-chat/${chatID}`, {
       ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
   /**
-   * Delete an existing chat
+   * Retrieve details of a specific chat
    *
    * @example
    * ```ts
-   * await client.chat.delete(
+   * const chatResponse = await client.chat.retrieve(
    *   '16b980523634a6dc504898cda492e939',
    * );
    * ```
    */
-  delete(chatID: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/delete-chat/${chatID}`, {
-      ...options,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
-    });
+  retrieve(chatID: string, options?: RequestOptions): APIPromise<ChatResponse> {
+    return this._client.get(path`/get-chat/${chatID}`, options);
   }
 
   /**
@@ -116,32 +91,57 @@ export class Chat extends APIResource {
   }
 
   /**
-   * Start an outbound SMS chat conversation with a phone number using the specified
-   * agent. The agent must be configured for chat mode. The initial SMS message will
-   * be automatically generated and sent based on the agent's configuration.
+   * List chats with unified cursor pagination response.
    *
    * @example
    * ```ts
-   * const chatResponse = await client.chat.createSMSChat({
-   *   from_number: '+12137771234',
-   *   to_number: '+14155551234',
-   * });
+   * const chats = await client.chat.list();
    * ```
    */
-  createSMSChat(body: ChatCreateSMSChatParams, options?: RequestOptions): APIPromise<ChatResponse> {
-    return this._client.post('/create-sms-chat', { body, ...options });
+  list(body: ChatListParams | null | undefined = {}, options?: RequestOptions): APIPromise<ChatListResponse> {
+    return this._client.post('/v3/list-chats', {
+      body,
+      timeout: (this._client as any)._options.timeout ?? 300000,
+      ...options,
+    });
   }
 
   /**
-   * End an ongoing chat
+   * Update metadata and sensitive data storage settings for an existing chat.
    *
    * @example
    * ```ts
-   * await client.chat.end('16b980523634a6dc504898cda492e939');
+   * const chatResponse = await client.chat.update(
+   *   'chat_98c1a2157aa0559144d67bb0729',
+   *   {
+   *     data_storage_setting: 'everything',
+   *     metadata: {
+   *       customer_id: 'cust_123',
+   *       notes: 'Follow-up required',
+   *     },
+   *     override_dynamic_variables: {
+   *       additional_discount: '15%',
+   *     },
+   *   },
+   * );
    * ```
    */
-  end(chatID: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.patch(path`/end-chat/${chatID}`, {
+  update(chatID: string, body: ChatUpdateParams, options?: RequestOptions): APIPromise<ChatResponse> {
+    return this._client.patch(path`/update-chat/${chatID}`, { body, ...options });
+  }
+
+  /**
+   * Delete an existing chat
+   *
+   * @example
+   * ```ts
+   * await client.chat.delete(
+   *   '16b980523634a6dc504898cda492e939',
+   * );
+   * ```
+   */
+  delete(chatID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/delete-chat/${chatID}`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -706,34 +706,56 @@ export interface ChatCreateParams {
   retell_llm_dynamic_variables?: { [key: string]: string };
 }
 
-export interface ChatUpdateParams {
+export interface ChatCreateSMSChatParams {
   /**
-   * Custom attributes for the chat
+   * The phone number to send SMS from in E.164 format. Must be a number purchased
+   * from Retell or imported to Retell with SMS capability.
    */
-  custom_attributes?: { [key: string]: string | number | boolean };
+  from_number: string;
 
   /**
-   * Data storage setting for this chat. Overrides the agent's default setting.
-   * "everything" stores all data, "basic_attributes_only" stores only metadata.
-   * Cannot be downgraded from more restrictive to less restrictive settings.
+   * The phone number to send SMS to in E.164 format
    */
-  data_storage_setting?: 'everything' | 'basic_attributes_only';
+  to_number: string;
 
   /**
    * An arbitrary object for storage purpose only. You can put anything here like
    * your internal customer id associated with the chat. Not used for processing. You
-   * can later get this field from the chat object. Size limited to 50kB max.
+   * can later get this field from the chat object.
    */
   metadata?: unknown;
 
   /**
-   * Override dynamic variables represented as key-value pairs of strings. Setting
-   * this will override or add the dynamic variables set in the agent during the
-   * call. Only need to set the delta where you want to override, no need to set the
-   * entire dynamic variables object. Setting this to null will remove any existing
+   * For this particular chat, override the agent used with this agent id. This does
+   * not bind the agent to this number, this is for one time override.
+   */
+  override_agent_id?: string;
+
+  /**
+   * For this particular chat, override the agent version used with this version.
+   * This does not bind the agent version to this number, this is for one time
    * override.
    */
-  override_dynamic_variables?: { [key: string]: string } | null;
+  override_agent_version?: number | string;
+
+  /**
+   * Add optional dynamic variables in key value pairs of string that injects into
+   * your Response Engine prompt and tool description. Only applicable for Response
+   * Engine.
+   */
+  retell_llm_dynamic_variables?: { [key: string]: string };
+}
+
+export interface ChatCreateChatCompletionParams {
+  /**
+   * Unique id of the chat to create completion.
+   */
+  chat_id: string;
+
+  /**
+   * user message to generate agent chat completion.
+   */
+  content: string;
 }
 
 export interface ChatListParams {
@@ -1243,56 +1265,34 @@ export namespace ChatListParams {
   }
 }
 
-export interface ChatCreateChatCompletionParams {
-  /**
-   * Unique id of the chat to create completion.
-   */
-  chat_id: string;
-
-  /**
-   * user message to generate agent chat completion.
-   */
-  content: string;
-}
-
-export interface ChatCreateSMSChatParams {
+export interface ChatUpdateParams {
   /**
-   * The phone number to send SMS from in E.164 format. Must be a number purchased
-   * from Retell or imported to Retell with SMS capability.
+   * Custom attributes for the chat
    */
-  from_number: string;
+  custom_attributes?: { [key: string]: string | number | boolean };
 
   /**
-   * The phone number to send SMS to in E.164 format
+   * Data storage setting for this chat. Overrides the agent's default setting.
+   * "everything" stores all data, "basic_attributes_only" stores only metadata.
+   * Cannot be downgraded from more restrictive to less restrictive settings.
    */
-  to_number: string;
+  data_storage_setting?: 'everything' | 'basic_attributes_only';
 
   /**
    * An arbitrary object for storage purpose only. You can put anything here like
    * your internal customer id associated with the chat. Not used for processing. You
-   * can later get this field from the chat object.
+   * can later get this field from the chat object. Size limited to 50kB max.
    */
   metadata?: unknown;
 
   /**
-   * For this particular chat, override the agent used with this agent id. This does
-   * not bind the agent to this number, this is for one time override.
-   */
-  override_agent_id?: string;
-
-  /**
-   * For this particular chat, override the agent version used with this version.
-   * This does not bind the agent version to this number, this is for one time
+   * Override dynamic variables represented as key-value pairs of strings. Setting
+   * this will override or add the dynamic variables set in the agent during the
+   * call. Only need to set the delta where you want to override, no need to set the
+   * entire dynamic variables object. Setting this to null will remove any existing
    * override.
    */
-  override_agent_version?: number | string;
-
-  /**
-   * Add optional dynamic variables in key value pairs of string that injects into
-   * your Response Engine prompt and tool description. Only applicable for Response
-   * Engine.
-   */
-  retell_llm_dynamic_variables?: { [key: string]: string };
+  override_dynamic_variables?: { [key: string]: string } | null;
 }
 
 export declare namespace Chat {
@@ -1301,9 +1301,9 @@ export declare namespace Chat {
     type ChatListResponse as ChatListResponse,
     type ChatCreateChatCompletionResponse as ChatCreateChatCompletionResponse,
     type ChatCreateParams as ChatCreateParams,
-    type ChatUpdateParams as ChatUpdateParams,
-    type ChatListParams as ChatListParams,
-    type ChatCreateChatCompletionParams as ChatCreateChatCompletionParams,
     type ChatCreateSMSChatParams as ChatCreateSMSChatParams,
+    type ChatCreateChatCompletionParams as ChatCreateChatCompletionParams,
+    type ChatListParams as ChatListParams,
+    type ChatUpdateParams as ChatUpdateParams,
   };
 }

package/src/resources/conversation-flow-component.ts

@@ -53,6 +53,22 @@ export class ConversationFlowComponent extends APIResource {
     return this._client.get(path`/get-conversation-flow-component/${conversationFlowComponentID}`, options);
   }
 
+  /**
+   * List shared conversation flow components with pagination
+   *
+   * @example
+   * ```ts
+   * const conversationFlowComponents =
+   *   await client.conversationFlowComponent.list();
+   * ```
+   */
+  list(
+    query: ConversationFlowComponentListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<ConversationFlowComponentListResponse> {
+    return this._client.get('/v2/list-conversation-flow-components', { query, ...options });
+  }
+
   /**
    * Update an existing shared conversation flow component
    *
@@ -75,22 +91,6 @@ export class ConversationFlowComponent extends APIResource {
     });
   }
 
-  /**
-   * List shared conversation flow components with pagination
-   *
-   * @example
-   * ```ts
-   * const conversationFlowComponents =
-   *   await client.conversationFlowComponent.list();
-   * ```
-   */
-  list(
-    query: ConversationFlowComponentListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<ConversationFlowComponentListResponse> {
-    return this._client.get('/v2/list-conversation-flow-components', { query, ...options });
-  }
-
   /**
    * Delete a shared conversation flow component. When deleting a shared component,
    * creates local copies for all linked conversation flows.
@@ -16613,6 +16613,23 @@ export namespace ConversationFlowComponentCreateParams {
   }
 }
 
+export interface ConversationFlowComponentListParams {
+  /**
+   * Maximum number of items to return.
+   */
+  limit?: number;
+
+  /**
+   * Pagination key for fetching the next page.
+   */
+  pagination_key?: string;
+
+  /**
+   * Sort order for results.
+   */
+  sort_order?: 'ascending' | 'descending';
+}
+
 export interface ConversationFlowComponentUpdateParams {
   /**
    * Display position for the begin tag in the frontend
@@ -24850,29 +24867,12 @@ export namespace ConversationFlowComponentUpdateParams {
   }
 }
 
-export interface ConversationFlowComponentListParams {
-  /**
-   * Maximum number of items to return.
-   */
-  limit?: number;
-
-  /**
-   * Pagination key for fetching the next page.
-   */
-  pagination_key?: string;
-
-  /**
-   * Sort order for results.
-   */
-  sort_order?: 'ascending' | 'descending';
-}
-
 export declare namespace ConversationFlowComponent {
   export {
     type ConversationFlowComponentResponse as ConversationFlowComponentResponse,
     type ConversationFlowComponentListResponse as ConversationFlowComponentListResponse,
     type ConversationFlowComponentCreateParams as ConversationFlowComponentCreateParams,
-    type ConversationFlowComponentUpdateParams as ConversationFlowComponentUpdateParams,
     type ConversationFlowComponentListParams as ConversationFlowComponentListParams,
+    type ConversationFlowComponentUpdateParams as ConversationFlowComponentUpdateParams,
   };
 }