retell-sdk 5.49.0 → 5.49.2

package/src/resources/chat-agent.ts

@@ -43,6 +43,25 @@ export class ChatAgent extends APIResource {
     return this._client.get(path`/get-chat-agent/${agentID}`, { query, ...options });
   }
 
+  /**
+   * Update an existing chat agent
+   *
+   * @example
+   * ```ts
+   * const chatAgentResponse = await client.chatAgent.update(
+   *   '16b980523634a6dc504898cda492e939',
+   * );
+   * ```
+   */
+  update(
+    agentID: string,
+    params: ChatAgentUpdateParams,
+    options?: RequestOptions,
+  ): APIPromise<ChatAgentResponse> {
+    const { version, ...body } = params;
+    return this._client.patch(path`/update-chat-agent/${agentID}`, { query: { version }, body, ...options });
+  }
+
   /**
    * List unique agents with pagination.
    *
@@ -71,25 +90,6 @@ export class ChatAgent extends APIResource {
     });
   }
 
-  /**
-   * Update an existing chat agent
-   *
-   * @example
-   * ```ts
-   * const chatAgentResponse = await client.chatAgent.update(
-   *   '16b980523634a6dc504898cda492e939',
-   * );
-   * ```
-   */
-  update(
-    agentID: string,
-    params: ChatAgentUpdateParams,
-    options?: RequestOptions,
-  ): APIPromise<ChatAgentResponse> {
-    const { version, ...body } = params;
-    return this._client.patch(path`/update-chat-agent/${agentID}`, { query: { version }, body, ...options });
-  }
-
   /**
    * Delete an existing chat agent
    *
@@ -107,24 +107,6 @@ export class ChatAgent extends APIResource {
     });
   }
 
-  /**
-   * 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]),
-    });
-  }
-
   /**
    * Create a new draft agent version from a base version.
    *
@@ -181,6 +163,24 @@ 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 {
@@ -1441,57 +1441,6 @@ export interface ChatAgentRetrieveParams {
   version?: string | number;
 }
 
-export interface ChatAgentListParams {
-  /**
-   * Query param: Maximum number of items to return.
-   */
-  limit?: number;
-
-  /**
-   * Query param: Pagination key for fetching the next page.
-   */
-  pagination_key?: string;
-
-  /**
-   * Query param: Sort order for results.
-   */
-  sort_order?: 'ascending' | 'descending';
-
-  /**
-   * Body param: Filters for listing agents. All provided filters are connected with
-   * AND.
-   */
-  filter_criteria?: ChatAgentListParams.FilterCriteria;
-}
-
-export namespace ChatAgentListParams {
-  /**
-   * Filters for listing agents. All provided filters are connected with AND.
-   */
-  export interface FilterCriteria {
-    channel?: FilterCriteria.Channel;
-
-    /**
-     * Case-insensitive substring search over agent name, plus substring search over
-     * agent id.
-     */
-    query?: string;
-  }
-
-  export namespace FilterCriteria {
-    export interface Channel {
-      /**
-       * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
-       */
-      op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
-
-      type: 'string';
-
-      value: 'voice' | 'chat';
-    }
-  }
-}
-
 export interface ChatAgentUpdateParams {
   /**
    * Query param: Optional version of the API to use for this request. Default to
@@ -2083,15 +2032,55 @@ export namespace ChatAgentUpdateParams {
   }
 }
 
-export interface ChatAgentPublishParams {
-  version: number;
+export interface ChatAgentListParams {
+  /**
+   * Query param: Maximum number of items to return.
+   */
+  limit?: number;
 
-  version_description?: string;
+  /**
+   * Query param: Pagination key for fetching the next page.
+   */
+  pagination_key?: string;
 
   /**
-   * Optional title of the agent version. Used for your own reference.
+   * Query param: Sort order for results.
    */
-  version_title?: string;
+  sort_order?: 'ascending' | 'descending';
+
+  /**
+   * Body param: Filters for listing agents. All provided filters are connected with
+   * AND.
+   */
+  filter_criteria?: ChatAgentListParams.FilterCriteria;
+}
+
+export namespace ChatAgentListParams {
+  /**
+   * Filters for listing agents. All provided filters are connected with AND.
+   */
+  export interface FilterCriteria {
+    channel?: FilterCriteria.Channel;
+
+    /**
+     * Case-insensitive substring search over agent name, plus substring search over
+     * agent id.
+     */
+    query?: string;
+  }
+
+  export namespace FilterCriteria {
+    export interface Channel {
+      /**
+       * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
+       */
+      op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
+
+      type: 'string';
+
+      value: 'voice' | 'chat';
+    }
+  }
 }
 
 export interface ChatAgentCreateVersionParams {
@@ -2108,6 +2097,17 @@ export interface ChatAgentDeleteVersionParams {
   version: number;
 }
 
+export interface ChatAgentPublishParams {
+  version: number;
+
+  version_description?: string;
+
+  /**
+   * Optional title of the agent version. Used for your own reference.
+   */
+  version_title?: string;
+}
+
 export declare namespace ChatAgent {
   export {
     type ChatAgentResponse as ChatAgentResponse,
@@ -2116,10 +2116,10 @@ export declare namespace ChatAgent {
     type ChatAgentGetVersionsResponse as ChatAgentGetVersionsResponse,
     type ChatAgentCreateParams as ChatAgentCreateParams,
     type ChatAgentRetrieveParams as ChatAgentRetrieveParams,
-    type ChatAgentListParams as ChatAgentListParams,
     type ChatAgentUpdateParams as ChatAgentUpdateParams,
-    type ChatAgentPublishParams as ChatAgentPublishParams,
+    type ChatAgentListParams as ChatAgentListParams,
     type ChatAgentCreateVersionParams as ChatAgentCreateVersionParams,
     type ChatAgentDeleteVersionParams as ChatAgentDeleteVersionParams,
+    type ChatAgentPublishParams as ChatAgentPublishParams,
   };
 }

package/src/resources/chat.ts

@@ -23,49 +23,74 @@ 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.
+   * Retrieve details of a specific chat
    *
    * @example
    * ```ts
-   * const chatResponse = await client.chat.createSMSChat({
-   *   from_number: '+12137771234',
-   *   to_number: '+14155551234',
-   * });
+   * const chatResponse = await client.chat.retrieve(
+   *   '16b980523634a6dc504898cda492e939',
+   * );
    * ```
    */
-  createSMSChat(body: ChatCreateSMSChatParams, options?: RequestOptions): APIPromise<ChatResponse> {
-    return this._client.post('/create-sms-chat', { body, ...options });
+  retrieve(chatID: string, options?: RequestOptions): APIPromise<ChatResponse> {
+    return this._client.get(path`/get-chat/${chatID}`, 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 });
+  }
+
+  /**
+   * List chats with unified cursor pagination response.
+   *
+   * @example
+   * ```ts
+   * const chats = await client.chat.list();
+   * ```
+   */
+  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,
-      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
   /**
-   * Retrieve details of a specific chat
+   * Delete an existing chat
    *
    * @example
    * ```ts
-   * const chatResponse = await client.chat.retrieve(
+   * await client.chat.delete(
    *   '16b980523634a6dc504898cda492e939',
    * );
    * ```
    */
-  retrieve(chatID: string, options?: RequestOptions): APIPromise<ChatResponse> {
-    return this._client.get(path`/get-chat/${chatID}`, options);
+  delete(chatID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/delete-chat/${chatID}`, {
+      ...options,
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
+    });
   }
 
   /**
@@ -91,57 +116,32 @@ export class Chat extends APIResource {
   }
 
   /**
-   * List chats with unified cursor pagination response.
-   *
-   * @example
-   * ```ts
-   * const chats = await client.chat.list();
-   * ```
-   */
-  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,
-    });
-  }
-
-  /**
-   * 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 });
   }
 
   /**
-   * Delete an existing chat
+   * End an ongoing chat
    *
    * @example
    * ```ts
-   * await client.chat.delete(
-   *   '16b980523634a6dc504898cda492e939',
-   * );
+   * await client.chat.end('16b980523634a6dc504898cda492e939');
    * ```
    */
-  delete(chatID: string, options?: RequestOptions): APIPromise<void> {
-    return this._client.delete(path`/delete-chat/${chatID}`, {
+  end(chatID: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.patch(path`/end-chat/${chatID}`, {
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -844,56 +844,39 @@ export interface ChatCreateParams {
   retell_llm_dynamic_variables?: { [key: string]: 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, as key-value pairs. Each attribute must first be
+   * defined for your organization in the Retell dashboard (Chat History → Actions →
+   * Custom attributes) before it can be set here. The object key must match the id
+   * of an existing organization-level custom attribute; keys that do not match a
+   * defined attribute are ignored and will not be saved. Values must be a string,
+   * number, or boolean.
    */
-  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?: string | number;
-
-  /**
-   * 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;
+  override_dynamic_variables?: { [key: string]: string } | null;
 }
 
 export interface ChatListParams {
@@ -1423,39 +1406,56 @@ export namespace ChatListParams {
   }
 }
 
-export interface ChatUpdateParams {
+export interface ChatCreateChatCompletionParams {
   /**
-   * Custom attributes for the chat, as key-value pairs. Each attribute must first be
-   * defined for your organization in the Retell dashboard (Chat History → Actions →
-   * Custom attributes) before it can be set here. The object key must match the id
-   * of an existing organization-level custom attribute; keys that do not match a
-   * defined attribute are ignored and will not be saved. Values must be a string,
-   * number, or boolean.
+   * Unique id of the chat to create completion.
    */
-  custom_attributes?: { [key: string]: string | number | boolean };
+  chat_id: 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.
+   * user message to generate agent chat completion.
    */
-  data_storage_setting?: 'everything' | 'basic_attributes_only';
+  content: string;
+}
+
+export interface ChatCreateSMSChatParams {
+  /**
+   * 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.
+   */
+  from_number: string;
+
+  /**
+   * The phone number to send SMS to in E.164 format
+   */
+  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?: string | number;
+
+  /**
+   * 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 declare namespace Chat {
@@ -1464,9 +1464,9 @@ export declare namespace Chat {
     type ChatListResponse as ChatListResponse,
     type ChatCreateChatCompletionResponse as ChatCreateChatCompletionResponse,
     type ChatCreateParams as ChatCreateParams,
-    type ChatCreateSMSChatParams as ChatCreateSMSChatParams,
-    type ChatCreateChatCompletionParams as ChatCreateChatCompletionParams,
-    type ChatListParams as ChatListParams,
     type ChatUpdateParams as ChatUpdateParams,
+    type ChatListParams as ChatListParams,
+    type ChatCreateChatCompletionParams as ChatCreateChatCompletionParams,
+    type ChatCreateSMSChatParams as ChatCreateSMSChatParams,
   };
 }

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

@@ -53,22 +53,6 @@ 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
    *
@@ -91,6 +75,22 @@ 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.
@@ -17297,23 +17297,6 @@ 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
@@ -25893,12 +25876,29 @@ 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 ConversationFlowComponentListParams as ConversationFlowComponentListParams,
     type ConversationFlowComponentUpdateParams as ConversationFlowComponentUpdateParams,
+    type ConversationFlowComponentListParams as ConversationFlowComponentListParams,
   };
 }