retell-sdk 5.49.1 → 5.50.0

package/src/resources/phone-number.ts

@@ -20,23 +20,6 @@ export class PhoneNumber extends APIResource {
     return this._client.post('/create-phone-number', { body, ...options });
   }
 
-  /**
-   * Import a phone number from custom telephony & Bind agents
-   *
-   * @example
-   * ```ts
-   * const phoneNumberResponse = await client.phoneNumber.import(
-   *   {
-   *     phone_number: '+14157774444',
-   *     termination_uri: 'someuri.pstn.twilio.com',
-   *   },
-   * );
-   * ```
-   */
-  import(body: PhoneNumberImportParams, options?: RequestOptions): APIPromise<PhoneNumberResponse> {
-    return this._client.post('/import-phone-number', { body, ...options });
-  }
-
   /**
    * Retrieve details of a specific phone number
    *
@@ -50,21 +33,6 @@ export class PhoneNumber extends APIResource {
     return this._client.get(path`/get-phone-number/${phoneNumber}`, options);
   }
 
-  /**
-   * List phone numbers with pagination
-   *
-   * @example
-   * ```ts
-   * const phoneNumbers = await client.phoneNumber.list();
-   * ```
-   */
-  list(
-    query: PhoneNumberListParams | null | undefined = {},
-    options?: RequestOptions,
-  ): APIPromise<PhoneNumberListResponse> {
-    return this._client.get('/v2/list-phone-numbers', { query, ...options });
-  }
-
   /**
    * Update agent bound to a purchased phone number
    *
@@ -100,6 +68,21 @@ export class PhoneNumber extends APIResource {
     return this._client.patch(path`/update-phone-number/${phoneNumber}`, { body, ...options });
   }
 
+  /**
+   * List phone numbers with pagination
+   *
+   * @example
+   * ```ts
+   * const phoneNumbers = await client.phoneNumber.list();
+   * ```
+   */
+  list(
+    query: PhoneNumberListParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<PhoneNumberListResponse> {
+    return this._client.get('/v2/list-phone-numbers', { query, ...options });
+  }
+
   /**
    * Delete an existing phone number
    *
@@ -114,6 +97,23 @@ export class PhoneNumber extends APIResource {
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
   }
+
+  /**
+   * Import a phone number from custom telephony & Bind agents
+   *
+   * @example
+   * ```ts
+   * const phoneNumberResponse = await client.phoneNumber.import(
+   *   {
+   *     phone_number: '+14157774444',
+   *     termination_uri: 'someuri.pstn.twilio.com',
+   *   },
+   * );
+   * ```
+   */
+  import(body: PhoneNumberImportParams, options?: RequestOptions): APIPromise<PhoneNumberResponse> {
+    return this._client.post('/import-phone-number', { body, ...options });
+  }
 }
 
 export interface PhoneNumberResponse {
@@ -473,21 +473,7 @@ export namespace PhoneNumberCreateParams {
   }
 }
 
-export interface PhoneNumberImportParams {
-  /**
-   * The number you are trying to import in E.164 format of the number (+country
-   * code, then number with no space, no special characters), used as the unique
-   * identifier for phone number APIs.
-   */
-  phone_number: string;
-
-  /**
-   * The termination uri to uniquely identify your elastic SIP trunk. This is used
-   * for outbound calls. For Twilio elastic SIP trunks it always end with
-   * ".pstn.twilio.com".
-   */
-  termination_uri: string;
-
+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.
@@ -501,19 +487,46 @@ export interface PhoneNumberImportParams {
   allowed_outbound_country_list?: Array<string> | null;
 
   /**
-   * If true, E.164 validation for phone_number is skipped. This is useful for
-   * internal pseudo numbers when using custom telephony. If omitted, default is
-   * true. Must be a boolean literal; string values like "true" or "false" are
-   * invalid.
+   * The password used for authentication for the SIP trunk to update for the phone
+   * number.
    */
-  ignore_e164_validation?: boolean;
+  auth_password?: string;
+
+  /**
+   * The username used for authentication for the SIP trunk to update for the phone
+   * number.
+   */
+  auth_username?: string;
+
+  /**
+   * When inbound call concurrency is reached and a slot does not free up after
+   * extended ringing, the call will fall back to this number. 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;
 
   /**
    * 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.
    */
-  inbound_agents?: Array<PhoneNumberImportParams.InboundAgent> | null;
+  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.
+   */
+  inbound_sms_agents?: Array<PhoneNumberUpdateParams.InboundSMSAgent> | null;
+
+  /**
+   * If set, Retell will send a webhook for inbound SMS, where you can override the
+   * agent ID, set dynamic variables, reject the SMS, and configure other fields
+   * specific to that chat.
+   */
+  inbound_sms_webhook_url?: string | null;
 
   /**
    * If set, Retell will send a webhook for inbound calls, where you can override the
@@ -525,24 +538,27 @@ export interface PhoneNumberImportParams {
   /**
    * Nickname of the number. This is for your reference only.
    */
-  nickname?: string;
+  nickname?: string | 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.
    */
-  outbound_agents?: Array<PhoneNumberImportParams.OutboundAgent> | null;
+  outbound_agents?: Array<PhoneNumberUpdateParams.OutboundAgent> | null;
 
   /**
-   * The password used for authentication for the SIP trunk.
+   * 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.
    */
-  sip_trunk_auth_password?: string;
+  outbound_sms_agents?: Array<PhoneNumberUpdateParams.OutboundSMSAgent> | null;
 
   /**
-   * The username used for authentication for the SIP trunk.
+   * The termination uri to update for the phone number. This is used for outbound
+   * calls.
    */
-  sip_trunk_auth_username?: string;
+  termination_uri?: string;
 
   /**
    * Outbound transport protocol to update for the phone number. Valid values are
@@ -551,7 +567,7 @@ export interface PhoneNumberImportParams {
   transport?: string | null;
 }
 
-export namespace PhoneNumberImportParams {
+export namespace PhoneNumberUpdateParams {
   export interface InboundAgent {
     agent_id: string;
 
@@ -575,6 +591,29 @@ export namespace PhoneNumberImportParams {
     agent_version?: string | 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 reference. Supports a numeric version (for example 3) or a
+     * tag/environment name (for example "prod"). The string "latest" resolves to the
+     * most recently created version (the largest version number), and
+     * "latest_published" resolves to the most recently published version. When a tag
+     * is provided, resolution uses that exact tag assignment (including its dynamic
+     * variables). If the tag exists but is currently unassigned, it resolves to
+     * latest. When a numeric version, latest, or latest_published is provided,
+     * resolution applies dynamic variables from the preferred tag for that resolved
+     * version (most recently assigned), if any.
+     */
+    agent_version?: string | number;
+  }
+
   export interface OutboundAgent {
     agent_id: string;
 
@@ -597,6 +636,29 @@ export namespace PhoneNumberImportParams {
      */
     agent_version?: string | 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 reference. Supports a numeric version (for example 3) or a
+     * tag/environment name (for example "prod"). The string "latest" resolves to the
+     * most recently created version (the largest version number), and
+     * "latest_published" resolves to the most recently published version. When a tag
+     * is provided, resolution uses that exact tag assignment (including its dynamic
+     * variables). If the tag exists but is currently unassigned, it resolves to
+     * latest. When a numeric version, latest, or latest_published is provided,
+     * resolution applies dynamic variables from the preferred tag for that resolved
+     * version (most recently assigned), if any.
+     */
+    agent_version?: string | number;
+  }
 }
 
 export interface PhoneNumberListParams {
@@ -616,60 +678,47 @@ export interface PhoneNumberListParams {
   sort_order?: 'ascending' | 'descending';
 }
 
-export interface PhoneNumberUpdateParams {
+export interface PhoneNumberImportParams {
   /**
-   * 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.
+   * The number you are trying to import in E.164 format of the number (+country
+   * code, then number with no space, no special characters), used as the unique
+   * identifier for phone number APIs.
    */
-  allowed_inbound_country_list?: Array<string> | null;
+  phone_number: string;
 
   /**
-   * 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.
+   * The termination uri to uniquely identify your elastic SIP trunk. This is used
+   * for outbound calls. For Twilio elastic SIP trunks it always end with
+   * ".pstn.twilio.com".
    */
-  allowed_outbound_country_list?: Array<string> | null;
+  termination_uri: string;
 
   /**
-   * The password used for authentication for the SIP trunk to update for the phone
-   * number.
+   * 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.
    */
-  auth_password?: string;
+  allowed_inbound_country_list?: Array<string> | null;
 
   /**
-   * The username used for authentication for the SIP trunk to update for the phone
-   * number.
+   * 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.
    */
-  auth_username?: string;
+  allowed_outbound_country_list?: Array<string> | null;
 
   /**
-   * When inbound call concurrency is reached and a slot does not free up after
-   * extended ringing, the call will fall back to this number. 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).
+   * If true, E.164 validation for phone_number is skipped. This is useful for
+   * internal pseudo numbers when using custom telephony. If omitted, default is
+   * true. Must be a boolean literal; string values like "true" or "false" are
+   * invalid.
    */
-  fallback_number?: string | null;
+  ignore_e164_validation?: boolean;
 
   /**
    * 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.
    */
-  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.
-   */
-  inbound_sms_agents?: Array<PhoneNumberUpdateParams.InboundSMSAgent> | null;
-
-  /**
-   * If set, Retell will send a webhook for inbound SMS, where you can override the
-   * agent ID, set dynamic variables, reject the SMS, and configure other fields
-   * specific to that chat.
-   */
-  inbound_sms_webhook_url?: string | null;
+  inbound_agents?: Array<PhoneNumberImportParams.InboundAgent> | null;
 
   /**
    * If set, Retell will send a webhook for inbound calls, where you can override the
@@ -681,27 +730,24 @@ export interface PhoneNumberUpdateParams {
   /**
    * Nickname of the number. This is for your reference only.
    */
-  nickname?: string | null;
+  nickname?: string;
 
   /**
    * 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.
    */
-  outbound_agents?: Array<PhoneNumberUpdateParams.OutboundAgent> | null;
+  outbound_agents?: Array<PhoneNumberImportParams.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.
+   * The password used for authentication for the SIP trunk.
    */
-  outbound_sms_agents?: Array<PhoneNumberUpdateParams.OutboundSMSAgent> | null;
+  sip_trunk_auth_password?: string;
 
   /**
-   * The termination uri to update for the phone number. This is used for outbound
-   * calls.
+   * The username used for authentication for the SIP trunk.
    */
-  termination_uri?: string;
+  sip_trunk_auth_username?: string;
 
   /**
    * Outbound transport protocol to update for the phone number. Valid values are
@@ -710,7 +756,7 @@ export interface PhoneNumberUpdateParams {
   transport?: string | null;
 }
 
-export namespace PhoneNumberUpdateParams {
+export namespace PhoneNumberImportParams {
   export interface InboundAgent {
     agent_id: string;
 
@@ -734,29 +780,6 @@ export namespace PhoneNumberUpdateParams {
     agent_version?: string | 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 reference. Supports a numeric version (for example 3) or a
-     * tag/environment name (for example "prod"). The string "latest" resolves to the
-     * most recently created version (the largest version number), and
-     * "latest_published" resolves to the most recently published version. When a tag
-     * is provided, resolution uses that exact tag assignment (including its dynamic
-     * variables). If the tag exists but is currently unassigned, it resolves to
-     * latest. When a numeric version, latest, or latest_published is provided,
-     * resolution applies dynamic variables from the preferred tag for that resolved
-     * version (most recently assigned), if any.
-     */
-    agent_version?: string | number;
-  }
-
   export interface OutboundAgent {
     agent_id: string;
 
@@ -779,29 +802,6 @@ export namespace PhoneNumberUpdateParams {
      */
     agent_version?: string | 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 reference. Supports a numeric version (for example 3) or a
-     * tag/environment name (for example "prod"). The string "latest" resolves to the
-     * most recently created version (the largest version number), and
-     * "latest_published" resolves to the most recently published version. When a tag
-     * is provided, resolution uses that exact tag assignment (including its dynamic
-     * variables). If the tag exists but is currently unassigned, it resolves to
-     * latest. When a numeric version, latest, or latest_published is provided,
-     * resolution applies dynamic variables from the preferred tag for that resolved
-     * version (most recently assigned), if any.
-     */
-    agent_version?: string | number;
-  }
 }
 
 export declare namespace PhoneNumber {
@@ -809,8 +809,8 @@ export declare namespace PhoneNumber {
     type PhoneNumberResponse as PhoneNumberResponse,
     type PhoneNumberListResponse as PhoneNumberListResponse,
     type PhoneNumberCreateParams as PhoneNumberCreateParams,
-    type PhoneNumberImportParams as PhoneNumberImportParams,
-    type PhoneNumberListParams as PhoneNumberListParams,
     type PhoneNumberUpdateParams as PhoneNumberUpdateParams,
+    type PhoneNumberListParams as PhoneNumberListParams,
+    type PhoneNumberImportParams as PhoneNumberImportParams,
   };
 }