retell-sdk 5.38.0 → 5.40.0

package/resources/llm.d.ts

@@ -122,7 +122,7 @@ export interface LlmResponse {
     /**
      * Select the underlying text LLM. If not set, would default to gpt-4.1.
      */
-    model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | null;
+    model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | null;
     /**
      * If set to true, will use high priority pool with more dedicated resource to
      * ensure lower and more consistent latency, default to false. This feature usually
@@ -308,6 +308,12 @@ export declare namespace LlmResponse {
              * The time to wait before considering transfer fails.
              */
             agent_detection_timeout_ms?: number;
+            /**
+             * Asset ID of the uploaded hold music to play. Required when `on_hold_music` is
+             * `custom`. Must reference an audio asset owned by the organization (see
+             * create-asset).
+             */
+            custom_on_hold_music_asset_id?: string;
             /**
              * Whether to play an audio cue when bridging the call. Defaults to true.
              */
@@ -318,9 +324,10 @@ export declare namespace LlmResponse {
              */
             ivr_option?: TransferOptionWarmTransfer.IvrOption;
             /**
-             * The music to play while the caller is being transferred.
+             * The music to play while the caller is being transferred. Use `custom` together
+             * with `custom_on_hold_music_asset_id` to play an uploaded audio asset.
              */
-            on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
+            on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone' | 'custom';
             /**
              * If set to true, will not perform human detection for the transfer. Default to
              * false.
@@ -400,14 +407,21 @@ export declare namespace LlmResponse {
              * The type of the transfer.
              */
             type: 'agentic_warm_transfer';
+            /**
+             * Asset ID of the uploaded hold music to play. Required when `on_hold_music` is
+             * `custom`. Must reference an audio asset owned by the organization (see
+             * create-asset).
+             */
+            custom_on_hold_music_asset_id?: string;
             /**
              * Whether to play an audio cue when bridging the call. Defaults to true.
              */
             enable_bridge_audio_cue?: boolean;
             /**
-             * The music to play while the caller is being transferred.
+             * The music to play while the caller is being transferred. Use `custom` together
+             * with `custom_on_hold_music_asset_id` to play an uploaded audio asset.
              */
-            on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
+            on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone' | 'custom';
             /**
              * If set, when transfer is successful, will say the handoff message to both the
              * transferee and the agent receiving the transfer. Can leave either a static
@@ -728,6 +742,13 @@ export declare namespace LlmResponse {
          * Method to use for the request, default to POST.
          */
         method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+        /**
+         * How the tool's `parameters` are authored and shown in the dashboard editor —
+         * "form" for the visual parameter builder, "json" for a raw JSON Schema. Both
+         * produce the same `parameters` schema; this does not change how the request body
+         * is encoded (see `args_at_root`).
+         */
+        parameter_type?: 'json' | 'form';
         /**
          * The parameters the functions accepts, described as a JSON Schema object. See
          * [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
@@ -1366,6 +1387,12 @@ export declare namespace LlmResponse {
                  * The time to wait before considering transfer fails.
                  */
                 agent_detection_timeout_ms?: number;
+                /**
+                 * Asset ID of the uploaded hold music to play. Required when `on_hold_music` is
+                 * `custom`. Must reference an audio asset owned by the organization (see
+                 * create-asset).
+                 */
+                custom_on_hold_music_asset_id?: string;
                 /**
                  * Whether to play an audio cue when bridging the call. Defaults to true.
                  */
@@ -1376,9 +1403,10 @@ export declare namespace LlmResponse {
                  */
                 ivr_option?: TransferOptionWarmTransfer.IvrOption;
                 /**
-                 * The music to play while the caller is being transferred.
+                 * The music to play while the caller is being transferred. Use `custom` together
+                 * with `custom_on_hold_music_asset_id` to play an uploaded audio asset.
                  */
-                on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
+                on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone' | 'custom';
                 /**
                  * If set to true, will not perform human detection for the transfer. Default to
                  * false.
@@ -1458,14 +1486,21 @@ export declare namespace LlmResponse {
                  * The type of the transfer.
                  */
                 type: 'agentic_warm_transfer';
+                /**
+                 * Asset ID of the uploaded hold music to play. Required when `on_hold_music` is
+                 * `custom`. Must reference an audio asset owned by the organization (see
+                 * create-asset).
+                 */
+                custom_on_hold_music_asset_id?: string;
                 /**
                  * Whether to play an audio cue when bridging the call. Defaults to true.
                  */
                 enable_bridge_audio_cue?: boolean;
                 /**
-                 * The music to play while the caller is being transferred.
+                 * The music to play while the caller is being transferred. Use `custom` together
+                 * with `custom_on_hold_music_asset_id` to play an uploaded audio asset.
                  */
-                on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
+                on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone' | 'custom';
                 /**
                  * If set, when transfer is successful, will say the handoff message to both the
                  * transferee and the agent receiving the transfer. Can leave either a static
@@ -1786,6 +1821,13 @@ export declare namespace LlmResponse {
              * Method to use for the request, default to POST.
              */
             method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+            /**
+             * How the tool's `parameters` are authored and shown in the dashboard editor —
+             * "form" for the visual parameter builder, "json" for a raw JSON Schema. Both
+             * produce the same `parameters` schema; this does not change how the request body
+             * is encoded (see `args_at_root`).
+             */
+            parameter_type?: 'json' | 'form';
             /**
              * The parameters the functions accepts, described as a JSON Schema object. See
              * [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
@@ -2235,7 +2277,7 @@ export interface LlmCreateParams {
     /**
      * Select the underlying text LLM. If not set, would default to gpt-4.1.
      */
-    model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | null;
+    model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | null;
     /**
      * If set to true, will use high priority pool with more dedicated resource to
      * ensure lower and more consistent latency, default to false. This feature usually
@@ -2417,6 +2459,12 @@ export declare namespace LlmCreateParams {
              * The time to wait before considering transfer fails.
              */
             agent_detection_timeout_ms?: number;
+            /**
+             * Asset ID of the uploaded hold music to play. Required when `on_hold_music` is
+             * `custom`. Must reference an audio asset owned by the organization (see
+             * create-asset).
+             */
+            custom_on_hold_music_asset_id?: string;
             /**
              * Whether to play an audio cue when bridging the call. Defaults to true.
              */
@@ -2427,9 +2475,10 @@ export declare namespace LlmCreateParams {
              */
             ivr_option?: TransferOptionWarmTransfer.IvrOption;
             /**
-             * The music to play while the caller is being transferred.
+             * The music to play while the caller is being transferred. Use `custom` together
+             * with `custom_on_hold_music_asset_id` to play an uploaded audio asset.
              */
-            on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
+            on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone' | 'custom';
             /**
              * If set to true, will not perform human detection for the transfer. Default to
              * false.
@@ -2509,14 +2558,21 @@ export declare namespace LlmCreateParams {
              * The type of the transfer.
              */
             type: 'agentic_warm_transfer';
+            /**
+             * Asset ID of the uploaded hold music to play. Required when `on_hold_music` is
+             * `custom`. Must reference an audio asset owned by the organization (see
+             * create-asset).
+             */
+            custom_on_hold_music_asset_id?: string;
             /**
              * Whether to play an audio cue when bridging the call. Defaults to true.
              */
             enable_bridge_audio_cue?: boolean;
             /**
-             * The music to play while the caller is being transferred.
+             * The music to play while the caller is being transferred. Use `custom` together
+             * with `custom_on_hold_music_asset_id` to play an uploaded audio asset.
              */
-            on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
+            on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone' | 'custom';
             /**
              * If set, when transfer is successful, will say the handoff message to both the
              * transferee and the agent receiving the transfer. Can leave either a static
@@ -2837,6 +2893,13 @@ export declare namespace LlmCreateParams {
          * Method to use for the request, default to POST.
          */
         method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+        /**
+         * How the tool's `parameters` are authored and shown in the dashboard editor —
+         * "form" for the visual parameter builder, "json" for a raw JSON Schema. Both
+         * produce the same `parameters` schema; this does not change how the request body
+         * is encoded (see `args_at_root`).
+         */
+        parameter_type?: 'json' | 'form';
         /**
          * The parameters the functions accepts, described as a JSON Schema object. See
          * [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
@@ -3475,6 +3538,12 @@ export declare namespace LlmCreateParams {
                  * The time to wait before considering transfer fails.
                  */
                 agent_detection_timeout_ms?: number;
+                /**
+                 * Asset ID of the uploaded hold music to play. Required when `on_hold_music` is
+                 * `custom`. Must reference an audio asset owned by the organization (see
+                 * create-asset).
+                 */
+                custom_on_hold_music_asset_id?: string;
                 /**
                  * Whether to play an audio cue when bridging the call. Defaults to true.
                  */
@@ -3485,9 +3554,10 @@ export declare namespace LlmCreateParams {
                  */
                 ivr_option?: TransferOptionWarmTransfer.IvrOption;
                 /**
-                 * The music to play while the caller is being transferred.
+                 * The music to play while the caller is being transferred. Use `custom` together
+                 * with `custom_on_hold_music_asset_id` to play an uploaded audio asset.
                  */
-                on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
+                on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone' | 'custom';
                 /**
                  * If set to true, will not perform human detection for the transfer. Default to
                  * false.
@@ -3567,14 +3637,21 @@ export declare namespace LlmCreateParams {
                  * The type of the transfer.
                  */
                 type: 'agentic_warm_transfer';
+                /**
+                 * Asset ID of the uploaded hold music to play. Required when `on_hold_music` is
+                 * `custom`. Must reference an audio asset owned by the organization (see
+                 * create-asset).
+                 */
+                custom_on_hold_music_asset_id?: string;
                 /**
                  * Whether to play an audio cue when bridging the call. Defaults to true.
                  */
                 enable_bridge_audio_cue?: boolean;
                 /**
-                 * The music to play while the caller is being transferred.
+                 * The music to play while the caller is being transferred. Use `custom` together
+                 * with `custom_on_hold_music_asset_id` to play an uploaded audio asset.
                  */
-                on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
+                on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone' | 'custom';
                 /**
                  * If set, when transfer is successful, will say the handoff message to both the
                  * transferee and the agent receiving the transfer. Can leave either a static
@@ -3895,6 +3972,13 @@ export declare namespace LlmCreateParams {
              * Method to use for the request, default to POST.
              */
             method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+            /**
+             * How the tool's `parameters` are authored and shown in the dashboard editor —
+             * "form" for the visual parameter builder, "json" for a raw JSON Schema. Both
+             * produce the same `parameters` schema; this does not change how the request body
+             * is encoded (see `args_at_root`).
+             */
+            parameter_type?: 'json' | 'form';
             /**
              * The parameters the functions accepts, described as a JSON Schema object. See
              * [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
@@ -4361,7 +4445,7 @@ export interface LlmUpdateParams {
      * Body param: Select the underlying text LLM. If not set, would default to
      * gpt-4.1.
      */
-    model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | null;
+    model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5-mini' | 'gpt-5-nano' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5.4' | 'gpt-5.4-mini' | 'gpt-5.4-nano' | 'gpt-5.5' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-3.0-flash' | 'gemini-3.1-flash-lite' | null;
     /**
      * Body param: If set to true, will use high priority pool with more dedicated
      * resource to ensure lower and more consistent latency, default to false. This
@@ -4543,6 +4627,12 @@ export declare namespace LlmUpdateParams {
              * The time to wait before considering transfer fails.
              */
             agent_detection_timeout_ms?: number;
+            /**
+             * Asset ID of the uploaded hold music to play. Required when `on_hold_music` is
+             * `custom`. Must reference an audio asset owned by the organization (see
+             * create-asset).
+             */
+            custom_on_hold_music_asset_id?: string;
             /**
              * Whether to play an audio cue when bridging the call. Defaults to true.
              */
@@ -4553,9 +4643,10 @@ export declare namespace LlmUpdateParams {
              */
             ivr_option?: TransferOptionWarmTransfer.IvrOption;
             /**
-             * The music to play while the caller is being transferred.
+             * The music to play while the caller is being transferred. Use `custom` together
+             * with `custom_on_hold_music_asset_id` to play an uploaded audio asset.
              */
-            on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
+            on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone' | 'custom';
             /**
              * If set to true, will not perform human detection for the transfer. Default to
              * false.
@@ -4635,14 +4726,21 @@ export declare namespace LlmUpdateParams {
              * The type of the transfer.
              */
             type: 'agentic_warm_transfer';
+            /**
+             * Asset ID of the uploaded hold music to play. Required when `on_hold_music` is
+             * `custom`. Must reference an audio asset owned by the organization (see
+             * create-asset).
+             */
+            custom_on_hold_music_asset_id?: string;
             /**
              * Whether to play an audio cue when bridging the call. Defaults to true.
              */
             enable_bridge_audio_cue?: boolean;
             /**
-             * The music to play while the caller is being transferred.
+             * The music to play while the caller is being transferred. Use `custom` together
+             * with `custom_on_hold_music_asset_id` to play an uploaded audio asset.
              */
-            on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
+            on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone' | 'custom';
             /**
              * If set, when transfer is successful, will say the handoff message to both the
              * transferee and the agent receiving the transfer. Can leave either a static
@@ -4963,6 +5061,13 @@ export declare namespace LlmUpdateParams {
          * Method to use for the request, default to POST.
          */
         method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+        /**
+         * How the tool's `parameters` are authored and shown in the dashboard editor —
+         * "form" for the visual parameter builder, "json" for a raw JSON Schema. Both
+         * produce the same `parameters` schema; this does not change how the request body
+         * is encoded (see `args_at_root`).
+         */
+        parameter_type?: 'json' | 'form';
         /**
          * The parameters the functions accepts, described as a JSON Schema object. See
          * [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for
@@ -5601,6 +5706,12 @@ export declare namespace LlmUpdateParams {
                  * The time to wait before considering transfer fails.
                  */
                 agent_detection_timeout_ms?: number;
+                /**
+                 * Asset ID of the uploaded hold music to play. Required when `on_hold_music` is
+                 * `custom`. Must reference an audio asset owned by the organization (see
+                 * create-asset).
+                 */
+                custom_on_hold_music_asset_id?: string;
                 /**
                  * Whether to play an audio cue when bridging the call. Defaults to true.
                  */
@@ -5611,9 +5722,10 @@ export declare namespace LlmUpdateParams {
                  */
                 ivr_option?: TransferOptionWarmTransfer.IvrOption;
                 /**
-                 * The music to play while the caller is being transferred.
+                 * The music to play while the caller is being transferred. Use `custom` together
+                 * with `custom_on_hold_music_asset_id` to play an uploaded audio asset.
                  */
-                on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
+                on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone' | 'custom';
                 /**
                  * If set to true, will not perform human detection for the transfer. Default to
                  * false.
@@ -5693,14 +5805,21 @@ export declare namespace LlmUpdateParams {
                  * The type of the transfer.
                  */
                 type: 'agentic_warm_transfer';
+                /**
+                 * Asset ID of the uploaded hold music to play. Required when `on_hold_music` is
+                 * `custom`. Must reference an audio asset owned by the organization (see
+                 * create-asset).
+                 */
+                custom_on_hold_music_asset_id?: string;
                 /**
                  * Whether to play an audio cue when bridging the call. Defaults to true.
                  */
                 enable_bridge_audio_cue?: boolean;
                 /**
-                 * The music to play while the caller is being transferred.
+                 * The music to play while the caller is being transferred. Use `custom` together
+                 * with `custom_on_hold_music_asset_id` to play an uploaded audio asset.
                  */
-                on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone';
+                on_hold_music?: 'none' | 'relaxing_sound' | 'uplifting_beats' | 'ringtone' | 'custom';
                 /**
                  * If set, when transfer is successful, will say the handoff message to both the
                  * transferee and the agent receiving the transfer. Can leave either a static
@@ -6021,6 +6140,13 @@ export declare namespace LlmUpdateParams {
              * Method to use for the request, default to POST.
              */
             method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
+            /**
+             * How the tool's `parameters` are authored and shown in the dashboard editor —
+             * "form" for the visual parameter builder, "json" for a raw JSON Schema. Both
+             * produce the same `parameters` schema; this does not change how the request body
+             * is encoded (see `args_at_root`).
+             */
+            parameter_type?: 'json' | 'form';
             /**
              * The parameters the functions accepts, described as a JSON Schema object. See
              * [JSON Schema reference](https://json-schema.org/understanding-json-schema/) for