retell-sdk 4.66.0 → 5.0.0

package/src/resources/mcp-tool.ts

@@ -1,18 +1,20 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../resource';
-import * as Core from '../core';
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
 
 export class McpTool extends APIResource {
   /**
    * Get MCP tools for a specific agent
    */
   getMcpTools(
-    agentId: string,
+    agentID: string,
     query: McpToolGetMcpToolsParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<McpToolGetMcpToolsResponse> {
-    return this._client.get(`/get-mcp-tools/${agentId}`, { query, ...options });
+    options?: RequestOptions,
+  ): APIPromise<McpToolGetMcpToolsResponse> {
+    return this._client.get(path`/get-mcp-tools/${agentID}`, { query, ...options });
   }
 }
 
@@ -41,6 +43,11 @@ export interface McpToolGetMcpToolsParams {
    */
   mcp_id: string;
 
+  /**
+   * The ID of the component if the MCP server is configured under a component.
+   */
+  component_id?: string;
+
   /**
    * Optional version of the agent to use for this request. Default to latest
    * version.

package/src/resources/phone-number.ts

@@ -1,7 +1,10 @@
 // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
 
-import { APIResource } from '../resource';
-import * as Core from '../core';
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { buildHeaders } from '../internal/headers';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
 
 export class PhoneNumber extends APIResource {
   /**
@@ -13,7 +16,7 @@ export class PhoneNumber extends APIResource {
    *   await client.phoneNumber.create();
    * ```
    */
-  create(body: PhoneNumberCreateParams, options?: Core.RequestOptions): Core.APIPromise<PhoneNumberResponse> {
+  create(body: PhoneNumberCreateParams, options?: RequestOptions): APIPromise<PhoneNumberResponse> {
     return this._client.post('/create-phone-number', { body, ...options });
   }
 
@@ -26,8 +29,8 @@ export class PhoneNumber extends APIResource {
    *   await client.phoneNumber.retrieve('+14157774444');
    * ```
    */
-  retrieve(phoneNumber: string, options?: Core.RequestOptions): Core.APIPromise<PhoneNumberResponse> {
-    return this._client.get(`/get-phone-number/${phoneNumber}`, options);
+  retrieve(phoneNumber: string, options?: RequestOptions): APIPromise<PhoneNumberResponse> {
+    return this._client.get(path`/get-phone-number/${phoneNumber}`, options);
   }
 
   /**
@@ -48,9 +51,9 @@ export class PhoneNumber extends APIResource {
   update(
     phoneNumber: string,
     body: PhoneNumberUpdateParams,
-    options?: Core.RequestOptions,
-  ): Core.APIPromise<PhoneNumberResponse> {
-    return this._client.patch(`/update-phone-number/${phoneNumber}`, { body, ...options });
+    options?: RequestOptions,
+  ): APIPromise<PhoneNumberResponse> {
+    return this._client.patch(path`/update-phone-number/${phoneNumber}`, { body, ...options });
   }
 
   /**
@@ -62,7 +65,7 @@ export class PhoneNumber extends APIResource {
    *   await client.phoneNumber.list();
    * ```
    */
-  list(options?: Core.RequestOptions): Core.APIPromise<PhoneNumberListResponse> {
+  list(options?: RequestOptions): APIPromise<PhoneNumberListResponse> {
     return this._client.get('/list-phone-numbers', options);
   }
 
@@ -74,10 +77,10 @@ export class PhoneNumber extends APIResource {
    * await client.phoneNumber.delete('+14157774444');
    * ```
    */
-  delete(phoneNumber: string, options?: Core.RequestOptions): Core.APIPromise<void> {
-    return this._client.delete(`/delete-phone-number/${phoneNumber}`, {
+  delete(phoneNumber: string, options?: RequestOptions): APIPromise<void> {
+    return this._client.delete(path`/delete-phone-number/${phoneNumber}`, {
       ...options,
-      headers: { Accept: '*/*', ...options?.headers },
+      headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
 
@@ -94,7 +97,7 @@ export class PhoneNumber extends APIResource {
    * );
    * ```
    */
-  import(body: PhoneNumberImportParams, options?: Core.RequestOptions): Core.APIPromise<PhoneNumberResponse> {
+  import(body: PhoneNumberImportParams, options?: RequestOptions): APIPromise<PhoneNumberResponse> {
     return this._client.post('/import-phone-number', { body, ...options });
   }
 }
@@ -112,12 +115,37 @@ export interface PhoneNumberResponse {
    */
   phone_number: string;
 
+  /**
+   * Type of the phone number.
+   */
+  phone_number_type: 'retell-twilio' | 'retell-telnyx' | 'custom';
+
+  /**
+   * List of ISO 3166-1 alpha-2 country codes from which inbound calls are allowed.
+   * If not set or empty, calls from all countries are allowed.
+   */
+  allowed_inbound_country_list?: Array<string> | null;
+
+  /**
+   * List of ISO 3166-1 alpha-2 country codes to which outbound calls are allowed. If
+   * not set or empty, calls to all countries are allowed.
+   */
+  allowed_outbound_country_list?: Array<string> | null;
+
   /**
    * Area code of the number to obtain. Format is a 3 digit integer. Currently only
    * supports US area code.
    */
   area_code?: number;
 
+  /**
+   * Enterprise only. Phone number to transfer inbound calls to when organization is
+   * in outage mode. Can be either a Retell phone number or an external number.
+   * Cannot be the same as this phone number, and cannot be a number that already has
+   * its own fallback configured (prevents nested forwarding).
+   */
+  fallback_number?: string | null;
+
   /**
    * Unique id of agent to bind to the number. The number will automatically use the
    * agent when receiving inbound calls. If null, this number would not accept
@@ -131,6 +159,28 @@ export interface PhoneNumberResponse {
    */
   inbound_agent_version?: number | null;
 
+  /**
+   * Inbound agents to bind to the number with weights. If set and non-empty, one
+   * agent will be picked randomly for each inbound call, with probability
+   * proportional to the weight. Total weights must add up to 1. If not set or empty,
+   * fallback to inbound_agent_id.
+   */
+  inbound_agents?: Array<PhoneNumberResponse.InboundAgent> | null;
+
+  /**
+   * Inbound SMS agents to bind to the number with weights. If set and non-empty, one
+   * agent will be picked randomly for each inbound SMS, with probability
+   * proportional to the weight. Total weights must add up to 1. If not set or empty,
+   * fallback to inbound_sms_agent_id.
+   */
+  inbound_sms_agents?: Array<PhoneNumberResponse.InboundSMSAgent> | null;
+
+  /**
+   * If set, will send a webhook for inbound SMS, where you can override agent id,
+   * set dynamic variables and other fields specific to that chat.
+   */
+  inbound_sms_webhook_url?: string | null;
+
   /**
    * If set, will send a webhook for inbound calls, where you can to override agent
    * id, set dynamic variables and other fields specific to that call.
@@ -156,19 +206,112 @@ export interface PhoneNumberResponse {
   outbound_agent_version?: number | null;
 
   /**
-   * Pretty printed phone number, provided for your reference.
+   * Outbound agents to bind to the number with weights. If set and non-empty, one
+   * agent will be picked randomly for each outbound call, with probability
+   * proportional to the weight. Total weights must add up to 1. If not set or empty,
+   * fallback to outbound_agent_id.
    */
-  phone_number_pretty?: string;
+  outbound_agents?: Array<PhoneNumberResponse.OutboundAgent> | null;
 
   /**
-   * Type of the phone number.
+   * Outbound SMS agents to bind to the number with weights. If set and non-empty,
+   * one agent will be picked randomly for each outbound SMS, with probability
+   * proportional to the weight. Total weights must add up to 1. If not set or empty,
+   * fallback to outbound_sms_agent_id.
    */
-  phone_number_type?: 'retell-twilio' | 'retell-telnyx' | 'custom';
+  outbound_sms_agents?: Array<PhoneNumberResponse.OutboundSMSAgent> | null;
+
+  /**
+   * Pretty printed phone number, provided for your reference.
+   */
+  phone_number_pretty?: string;
+
+  sip_outbound_trunk_config?: PhoneNumberResponse.SipOutboundTrunkConfig | null;
+}
+
+export namespace PhoneNumberResponse {
+  export interface InboundAgent {
+    agent_id: string;
+
+    /**
+     * The weight of the agent. When used in a list of agents, the total weights must
+     * add up to 1.
+     */
+    weight: number;
+
+    agent_version?: number;
+  }
+
+  export interface InboundSMSAgent {
+    agent_id: string;
+
+    /**
+     * The weight of the agent. When used in a list of agents, the total weights must
+     * add up to 1.
+     */
+    weight: number;
+
+    agent_version?: number;
+  }
+
+  export interface OutboundAgent {
+    agent_id: string;
+
+    /**
+     * The weight of the agent. When used in a list of agents, the total weights must
+     * add up to 1.
+     */
+    weight: number;
+
+    agent_version?: number;
+  }
+
+  export interface OutboundSMSAgent {
+    agent_id: string;
+
+    /**
+     * The weight of the agent. When used in a list of agents, the total weights must
+     * add up to 1.
+     */
+    weight: number;
+
+    agent_version?: number;
+  }
+
+  export interface SipOutboundTrunkConfig {
+    /**
+     * The username used for authenticating the SIP trunk for the phone number.
+     */
+    auth_username?: string | null;
+
+    /**
+     * The termination URI for the SIP trunk for the phone number.
+     */
+    termination_uri?: string | null;
+
+    /**
+     * Outbound transport protocol for the SIP trunk for the phone number. Valid values
+     * are "TLS", "TCP" and "UDP". Default is "TCP".
+     */
+    transport?: string | null;
+  }
 }
 
 export type PhoneNumberListResponse = Array<PhoneNumberResponse>;
 
 export interface PhoneNumberCreateParams {
+  /**
+   * List of ISO 3166-1 alpha-2 country codes from which inbound calls are allowed.
+   * If not set or empty, calls from all countries are allowed.
+   */
+  allowed_inbound_country_list?: Array<string> | null;
+
+  /**
+   * List of ISO 3166-1 alpha-2 country codes to which outbound calls are allowed. If
+   * not set or empty, calls to all countries are allowed.
+   */
+  allowed_outbound_country_list?: Array<string> | null;
+
   /**
    * Area code of the number to obtain. Format is a 3 digit integer. Currently only
    * supports US area code.
@@ -181,6 +324,14 @@ export interface PhoneNumberCreateParams {
    */
   country_code?: 'US' | 'CA';
 
+  /**
+   * Enterprise only. Phone number to transfer inbound calls to when organization is
+   * in outage mode. Can be either a Retell phone number or an external number.
+   * Cannot be the same as this phone number, and cannot be a number that already has
+   * its own fallback configured (prevents nested forwarding).
+   */
+  fallback_number?: string | null;
+
   /**
    * Unique id of agent to bind to the number. The number will automatically use the
    * agent when receiving inbound calls. If null, this number would not accept
@@ -194,6 +345,14 @@ export interface PhoneNumberCreateParams {
    */
   inbound_agent_version?: number | null;
 
+  /**
+   * Inbound agents to bind to the number with weights. If set and non-empty, one
+   * agent will be picked randomly for each inbound call, with probability
+   * proportional to the weight. Total weights must add up to 1. If not set or empty,
+   * fallback to inbound_agent_id.
+   */
+  inbound_agents?: Array<PhoneNumberCreateParams.InboundAgent> | null;
+
   /**
    * If set, will send a webhook for inbound calls, where you can to override agent
    * id, set dynamic variables and other fields specific to that call.
@@ -223,6 +382,14 @@ export interface PhoneNumberCreateParams {
    */
   outbound_agent_version?: number | null;
 
+  /**
+   * Outbound agents to bind to the number with weights. If set and non-empty, one
+   * agent will be picked randomly for each outbound call, with probability
+   * proportional to the weight. Total weights must add up to 1. If not set or empty,
+   * fallback to outbound_agent_id.
+   */
+  outbound_agents?: Array<PhoneNumberCreateParams.OutboundAgent> | null;
+
   /**
    * The number you are trying to purchase in E.164 format of the number (+country
    * code then number with no space and no special characters).
@@ -233,9 +400,74 @@ export interface PhoneNumberCreateParams {
    * Whether to purchase a toll-free number. Toll-free numbers incur higher costs.
    */
   toll_free?: boolean;
+
+  /**
+   * Outbound transport protocol to use for the phone number. Valid values are "TLS",
+   * "TCP" and "UDP". Default is "TCP".
+   */
+  transport?: string | null;
+}
+
+export namespace PhoneNumberCreateParams {
+  export interface InboundAgent {
+    agent_id: string;
+
+    /**
+     * The weight of the agent. When used in a list of agents, the total weights must
+     * add up to 1.
+     */
+    weight: number;
+
+    agent_version?: number;
+  }
+
+  export interface OutboundAgent {
+    agent_id: string;
+
+    /**
+     * The weight of the agent. When used in a list of agents, the total weights must
+     * add up to 1.
+     */
+    weight: number;
+
+    agent_version?: number;
+  }
 }
 
 export interface PhoneNumberUpdateParams {
+  /**
+   * List of ISO 3166-1 alpha-2 country codes from which inbound calls are allowed.
+   * If not set or empty, calls from all countries are allowed.
+   */
+  allowed_inbound_country_list?: Array<string> | null;
+
+  /**
+   * List of ISO 3166-1 alpha-2 country codes to which outbound calls are allowed. If
+   * not set or empty, calls to all countries are allowed.
+   */
+  allowed_outbound_country_list?: Array<string> | null;
+
+  /**
+   * The password used for authentication for the SIP trunk to update for the phone
+   * number.
+   */
+  auth_password?: string;
+
+  /**
+   * The username used for authentication for the SIP trunk to update for the phone
+   * number.
+   */
+  auth_username?: string;
+
+  /**
+   * Enterprise only. Phone number to transfer inbound calls to when organization is
+   * in outage mode. Can be either a Retell phone number or an external number. Set
+   * to null to remove. Cannot be the same as this phone number, and cannot be a
+   * number that already has its own fallback configured (prevents nested
+   * forwarding).
+   */
+  fallback_number?: string | null;
+
   /**
    * Unique id of agent to bind to the number. The number will automatically use the
    * agent when receiving inbound calls. If set to null, this number would not accept
@@ -249,6 +481,28 @@ export interface PhoneNumberUpdateParams {
    */
   inbound_agent_version?: number | null;
 
+  /**
+   * Inbound agents to bind to the number with weights. If set and non-empty, one
+   * agent will be picked randomly for each inbound call, with probability
+   * proportional to the weight. Total weights must add up to 1. If not set or empty,
+   * fallback to inbound_agent_id.
+   */
+  inbound_agents?: Array<PhoneNumberUpdateParams.InboundAgent> | null;
+
+  /**
+   * Inbound SMS agents to bind to the number with weights. If set and non-empty, one
+   * agent will be picked randomly for each inbound SMS, with probability
+   * proportional to the weight. Total weights must add up to 1. If not set or empty,
+   * fallback to inbound_sms_agent_id.
+   */
+  inbound_sms_agents?: Array<PhoneNumberUpdateParams.InboundSMSAgent> | null;
+
+  /**
+   * If set, will send a webhook for inbound SMS, where you can override agent id,
+   * set dynamic variables and other fields specific to that chat.
+   */
+  inbound_sms_webhook_url?: string | null;
+
   /**
    * If set, will send a webhook for inbound calls, where you can to override agent
    * id, set dynamic variables and other fields specific to that call.
@@ -272,6 +526,84 @@ export interface PhoneNumberUpdateParams {
    * default to latest version.
    */
   outbound_agent_version?: number | null;
+
+  /**
+   * Outbound agents to bind to the number with weights. If set and non-empty, one
+   * agent will be picked randomly for each outbound call, with probability
+   * proportional to the weight. Total weights must add up to 1. If not set or empty,
+   * fallback to outbound_agent_id.
+   */
+  outbound_agents?: Array<PhoneNumberUpdateParams.OutboundAgent> | null;
+
+  /**
+   * Outbound SMS agents to bind to the number with weights. If set and non-empty,
+   * one agent will be picked randomly for each outbound SMS, with probability
+   * proportional to the weight. Total weights must add up to 1. If not set or empty,
+   * fallback to outbound_sms_agent_id.
+   */
+  outbound_sms_agents?: Array<PhoneNumberUpdateParams.OutboundSMSAgent> | null;
+
+  /**
+   * The termination uri to update for the phone number. This is used for outbound
+   * calls.
+   */
+  termination_uri?: string;
+
+  /**
+   * Outbound transport protocol to update for the phone number. Valid values are
+   * "TLS", "TCP" and "UDP". Default is "TCP".
+   */
+  transport?: string | null;
+}
+
+export namespace PhoneNumberUpdateParams {
+  export interface InboundAgent {
+    agent_id: string;
+
+    /**
+     * The weight of the agent. When used in a list of agents, the total weights must
+     * add up to 1.
+     */
+    weight: number;
+
+    agent_version?: number;
+  }
+
+  export interface InboundSMSAgent {
+    agent_id: string;
+
+    /**
+     * The weight of the agent. When used in a list of agents, the total weights must
+     * add up to 1.
+     */
+    weight: number;
+
+    agent_version?: number;
+  }
+
+  export interface OutboundAgent {
+    agent_id: string;
+
+    /**
+     * The weight of the agent. When used in a list of agents, the total weights must
+     * add up to 1.
+     */
+    weight: number;
+
+    agent_version?: number;
+  }
+
+  export interface OutboundSMSAgent {
+    agent_id: string;
+
+    /**
+     * The weight of the agent. When used in a list of agents, the total weights must
+     * add up to 1.
+     */
+    weight: number;
+
+    agent_version?: number;
+  }
 }
 
 export interface PhoneNumberImportParams {
@@ -289,6 +621,18 @@ export interface PhoneNumberImportParams {
    */
   termination_uri: string;
 
+  /**
+   * List of ISO 3166-1 alpha-2 country codes from which inbound calls are allowed.
+   * If not set or empty, calls from all countries are allowed.
+   */
+  allowed_inbound_country_list?: Array<string> | null;
+
+  /**
+   * List of ISO 3166-1 alpha-2 country codes to which outbound calls are allowed. If
+   * not set or empty, calls to all countries are allowed.
+   */
+  allowed_outbound_country_list?: Array<string> | null;
+
   /**
    * Unique id of agent to bind to the number. The number will automatically use the
    * agent when receiving inbound calls. If null, this number would not accept
@@ -302,6 +646,14 @@ export interface PhoneNumberImportParams {
    */
   inbound_agent_version?: number | null;
 
+  /**
+   * Inbound agents to bind to the number with weights. If set and non-empty, one
+   * agent will be picked randomly for each inbound call, with probability
+   * proportional to the weight. Total weights must add up to 1. If not set or empty,
+   * fallback to inbound_agent_id.
+   */
+  inbound_agents?: Array<PhoneNumberImportParams.InboundAgent> | null;
+
   /**
    * If set, will send a webhook for inbound calls, where you can to override agent
    * id, set dynamic variables and other fields specific to that call.
@@ -318,7 +670,7 @@ export interface PhoneNumberImportParams {
    * agent when conducting outbound calls. If null, this number would not be able to
    * initiate outbound call without agent id override.
    */
-  outbound_agent_id?: string;
+  outbound_agent_id?: string | null;
 
   /**
    * Version of the outbound agent to bind to the number. If not provided, will
@@ -326,6 +678,14 @@ export interface PhoneNumberImportParams {
    */
   outbound_agent_version?: number | null;
 
+  /**
+   * Outbound agents to bind to the number with weights. If set and non-empty, one
+   * agent will be picked randomly for each outbound call, with probability
+   * proportional to the weight. Total weights must add up to 1. If not set or empty,
+   * fallback to outbound_agent_id.
+   */
+  outbound_agents?: Array<PhoneNumberImportParams.OutboundAgent> | null;
+
   /**
    * The password used for authentication for the SIP trunk.
    */
@@ -335,6 +695,38 @@ export interface PhoneNumberImportParams {
    * The username used for authentication for the SIP trunk.
    */
   sip_trunk_auth_username?: string;
+
+  /**
+   * Outbound transport protocol to update for the phone number. Valid values are
+   * "TLS", "TCP" and "UDP". Default is "TCP".
+   */
+  transport?: string | null;
+}
+
+export namespace PhoneNumberImportParams {
+  export interface InboundAgent {
+    agent_id: string;
+
+    /**
+     * The weight of the agent. When used in a list of agents, the total weights must
+     * add up to 1.
+     */
+    weight: number;
+
+    agent_version?: number;
+  }
+
+  export interface OutboundAgent {
+    agent_id: string;
+
+    /**
+     * The weight of the agent. When used in a list of agents, the total weights must
+     * add up to 1.
+     */
+    weight: number;
+
+    agent_version?: number;
+  }
 }
 
 export declare namespace PhoneNumber {