retell-sdk 5.7.0 → 5.9.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.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | null;
+    model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | 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
@@ -293,6 +293,11 @@ export declare namespace LlmResponse {
              * id when using `sip refer` cold transfer mode.
              */
             show_transferee_as_caller?: boolean;
+            /**
+             * Override the ring duration for this specific transfer, in milliseconds. If not
+             * set, falls back to the agent-level `ring_duration_ms`.
+             */
+            transfer_ring_duration_ms?: number;
         }
         interface TransferOptionWarmTransfer {
             /**
@@ -344,6 +349,11 @@ export declare namespace LlmResponse {
              * Twilio numbers support this option.
              */
             show_transferee_as_caller?: boolean;
+            /**
+             * Override the ring duration for this specific transfer, in milliseconds. If not
+             * set, falls back to the agent-level `ring_duration_ms`.
+             */
+            transfer_ring_duration_ms?: number;
         }
         namespace TransferOptionWarmTransfer {
             /**
@@ -415,6 +425,11 @@ export declare namespace LlmResponse {
              * Twilio numbers support this option.
              */
             show_transferee_as_caller?: boolean;
+            /**
+             * Override the ring duration for this specific transfer, in milliseconds. If not
+             * set, falls back to the agent-level `ring_duration_ms`.
+             */
+            transfer_ring_duration_ms?: number;
         }
         namespace TransferOptionAgenticWarmTransfer {
             /**
@@ -789,6 +804,11 @@ export declare namespace LlmResponse {
              * Examples of the variable value to teach model the style and syntax.
              */
             examples?: Array<string>;
+            /**
+             * Whether this data is required. If true and the data is not extracted, the call
+             * will be marked as unsuccessful.
+             */
+            required?: boolean;
         }
         interface EnumAnalysisData {
             /**
@@ -807,6 +827,11 @@ export declare namespace LlmResponse {
              * Type of the variable to extract.
              */
             type: 'enum';
+            /**
+             * Whether this data is required. If true and the data is not extracted, the call
+             * will be marked as unsuccessful.
+             */
+            required?: boolean;
         }
         interface BooleanAnalysisData {
             /**
@@ -821,6 +846,11 @@ export declare namespace LlmResponse {
              * Type of the variable to extract.
              */
             type: 'boolean';
+            /**
+             * Whether this data is required. If true and the data is not extracted, the call
+             * will be marked as unsuccessful.
+             */
+            required?: boolean;
         }
         interface NumberAnalysisData {
             /**
@@ -835,6 +865,11 @@ export declare namespace LlmResponse {
              * Type of the variable to extract.
              */
             type: 'number';
+            /**
+             * Whether this data is required. If true and the data is not extracted, the call
+             * will be marked as unsuccessful.
+             */
+            required?: boolean;
         }
     }
     interface BridgeTransferTool {
@@ -1167,6 +1202,11 @@ export declare namespace LlmResponse {
                  * id when using `sip refer` cold transfer mode.
                  */
                 show_transferee_as_caller?: boolean;
+                /**
+                 * Override the ring duration for this specific transfer, in milliseconds. If not
+                 * set, falls back to the agent-level `ring_duration_ms`.
+                 */
+                transfer_ring_duration_ms?: number;
             }
             interface TransferOptionWarmTransfer {
                 /**
@@ -1218,6 +1258,11 @@ export declare namespace LlmResponse {
                  * Twilio numbers support this option.
                  */
                 show_transferee_as_caller?: boolean;
+                /**
+                 * Override the ring duration for this specific transfer, in milliseconds. If not
+                 * set, falls back to the agent-level `ring_duration_ms`.
+                 */
+                transfer_ring_duration_ms?: number;
             }
             namespace TransferOptionWarmTransfer {
                 /**
@@ -1289,6 +1334,11 @@ export declare namespace LlmResponse {
                  * Twilio numbers support this option.
                  */
                 show_transferee_as_caller?: boolean;
+                /**
+                 * Override the ring duration for this specific transfer, in milliseconds. If not
+                 * set, falls back to the agent-level `ring_duration_ms`.
+                 */
+                transfer_ring_duration_ms?: number;
             }
             namespace TransferOptionAgenticWarmTransfer {
                 /**
@@ -1663,6 +1713,11 @@ export declare namespace LlmResponse {
                  * Examples of the variable value to teach model the style and syntax.
                  */
                 examples?: Array<string>;
+                /**
+                 * Whether this data is required. If true and the data is not extracted, the call
+                 * will be marked as unsuccessful.
+                 */
+                required?: boolean;
             }
             interface EnumAnalysisData {
                 /**
@@ -1681,6 +1736,11 @@ export declare namespace LlmResponse {
                  * Type of the variable to extract.
                  */
                 type: 'enum';
+                /**
+                 * Whether this data is required. If true and the data is not extracted, the call
+                 * will be marked as unsuccessful.
+                 */
+                required?: boolean;
             }
             interface BooleanAnalysisData {
                 /**
@@ -1695,6 +1755,11 @@ export declare namespace LlmResponse {
                  * Type of the variable to extract.
                  */
                 type: 'boolean';
+                /**
+                 * Whether this data is required. If true and the data is not extracted, the call
+                 * will be marked as unsuccessful.
+                 */
+                required?: boolean;
             }
             interface NumberAnalysisData {
                 /**
@@ -1709,6 +1774,11 @@ export declare namespace LlmResponse {
                  * Type of the variable to extract.
                  */
                 type: 'number';
+                /**
+                 * Whether this data is required. If true and the data is not extracted, the call
+                 * will be marked as unsuccessful.
+                 */
+                required?: boolean;
             }
         }
         interface BridgeTransferTool {
@@ -1855,7 +1925,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.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | null;
+    model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | 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
@@ -2026,6 +2096,11 @@ export declare namespace LlmCreateParams {
              * id when using `sip refer` cold transfer mode.
              */
             show_transferee_as_caller?: boolean;
+            /**
+             * Override the ring duration for this specific transfer, in milliseconds. If not
+             * set, falls back to the agent-level `ring_duration_ms`.
+             */
+            transfer_ring_duration_ms?: number;
         }
         interface TransferOptionWarmTransfer {
             /**
@@ -2077,6 +2152,11 @@ export declare namespace LlmCreateParams {
              * Twilio numbers support this option.
              */
             show_transferee_as_caller?: boolean;
+            /**
+             * Override the ring duration for this specific transfer, in milliseconds. If not
+             * set, falls back to the agent-level `ring_duration_ms`.
+             */
+            transfer_ring_duration_ms?: number;
         }
         namespace TransferOptionWarmTransfer {
             /**
@@ -2148,6 +2228,11 @@ export declare namespace LlmCreateParams {
              * Twilio numbers support this option.
              */
             show_transferee_as_caller?: boolean;
+            /**
+             * Override the ring duration for this specific transfer, in milliseconds. If not
+             * set, falls back to the agent-level `ring_duration_ms`.
+             */
+            transfer_ring_duration_ms?: number;
         }
         namespace TransferOptionAgenticWarmTransfer {
             /**
@@ -2522,6 +2607,11 @@ export declare namespace LlmCreateParams {
              * Examples of the variable value to teach model the style and syntax.
              */
             examples?: Array<string>;
+            /**
+             * Whether this data is required. If true and the data is not extracted, the call
+             * will be marked as unsuccessful.
+             */
+            required?: boolean;
         }
         interface EnumAnalysisData {
             /**
@@ -2540,6 +2630,11 @@ export declare namespace LlmCreateParams {
              * Type of the variable to extract.
              */
             type: 'enum';
+            /**
+             * Whether this data is required. If true and the data is not extracted, the call
+             * will be marked as unsuccessful.
+             */
+            required?: boolean;
         }
         interface BooleanAnalysisData {
             /**
@@ -2554,6 +2649,11 @@ export declare namespace LlmCreateParams {
              * Type of the variable to extract.
              */
             type: 'boolean';
+            /**
+             * Whether this data is required. If true and the data is not extracted, the call
+             * will be marked as unsuccessful.
+             */
+            required?: boolean;
         }
         interface NumberAnalysisData {
             /**
@@ -2568,6 +2668,11 @@ export declare namespace LlmCreateParams {
              * Type of the variable to extract.
              */
             type: 'number';
+            /**
+             * Whether this data is required. If true and the data is not extracted, the call
+             * will be marked as unsuccessful.
+             */
+            required?: boolean;
         }
     }
     interface BridgeTransferTool {
@@ -2900,6 +3005,11 @@ export declare namespace LlmCreateParams {
                  * id when using `sip refer` cold transfer mode.
                  */
                 show_transferee_as_caller?: boolean;
+                /**
+                 * Override the ring duration for this specific transfer, in milliseconds. If not
+                 * set, falls back to the agent-level `ring_duration_ms`.
+                 */
+                transfer_ring_duration_ms?: number;
             }
             interface TransferOptionWarmTransfer {
                 /**
@@ -2951,6 +3061,11 @@ export declare namespace LlmCreateParams {
                  * Twilio numbers support this option.
                  */
                 show_transferee_as_caller?: boolean;
+                /**
+                 * Override the ring duration for this specific transfer, in milliseconds. If not
+                 * set, falls back to the agent-level `ring_duration_ms`.
+                 */
+                transfer_ring_duration_ms?: number;
             }
             namespace TransferOptionWarmTransfer {
                 /**
@@ -3022,6 +3137,11 @@ export declare namespace LlmCreateParams {
                  * Twilio numbers support this option.
                  */
                 show_transferee_as_caller?: boolean;
+                /**
+                 * Override the ring duration for this specific transfer, in milliseconds. If not
+                 * set, falls back to the agent-level `ring_duration_ms`.
+                 */
+                transfer_ring_duration_ms?: number;
             }
             namespace TransferOptionAgenticWarmTransfer {
                 /**
@@ -3396,6 +3516,11 @@ export declare namespace LlmCreateParams {
                  * Examples of the variable value to teach model the style and syntax.
                  */
                 examples?: Array<string>;
+                /**
+                 * Whether this data is required. If true and the data is not extracted, the call
+                 * will be marked as unsuccessful.
+                 */
+                required?: boolean;
             }
             interface EnumAnalysisData {
                 /**
@@ -3414,6 +3539,11 @@ export declare namespace LlmCreateParams {
                  * Type of the variable to extract.
                  */
                 type: 'enum';
+                /**
+                 * Whether this data is required. If true and the data is not extracted, the call
+                 * will be marked as unsuccessful.
+                 */
+                required?: boolean;
             }
             interface BooleanAnalysisData {
                 /**
@@ -3428,6 +3558,11 @@ export declare namespace LlmCreateParams {
                  * Type of the variable to extract.
                  */
                 type: 'boolean';
+                /**
+                 * Whether this data is required. If true and the data is not extracted, the call
+                 * will be marked as unsuccessful.
+                 */
+                required?: boolean;
             }
             interface NumberAnalysisData {
                 /**
@@ -3442,6 +3577,11 @@ export declare namespace LlmCreateParams {
                  * Type of the variable to extract.
                  */
                 type: 'number';
+                /**
+                 * Whether this data is required. If true and the data is not extracted, the call
+                 * will be marked as unsuccessful.
+                 */
+                required?: boolean;
             }
         }
         interface BridgeTransferTool {
@@ -3601,7 +3741,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.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | null;
+    model?: 'gpt-4.1' | 'gpt-4.1-mini' | 'gpt-4.1-nano' | 'gpt-5' | 'gpt-5.1' | 'gpt-5.2' | 'gpt-5-mini' | 'gpt-5-nano' | 'claude-4.5-sonnet' | 'claude-4.6-sonnet' | 'claude-4.5-haiku' | 'gemini-2.5-flash' | 'gemini-2.5-flash-lite' | 'gemini-3.0-flash' | 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
@@ -3772,6 +3912,11 @@ export declare namespace LlmUpdateParams {
              * id when using `sip refer` cold transfer mode.
              */
             show_transferee_as_caller?: boolean;
+            /**
+             * Override the ring duration for this specific transfer, in milliseconds. If not
+             * set, falls back to the agent-level `ring_duration_ms`.
+             */
+            transfer_ring_duration_ms?: number;
         }
         interface TransferOptionWarmTransfer {
             /**
@@ -3823,6 +3968,11 @@ export declare namespace LlmUpdateParams {
              * Twilio numbers support this option.
              */
             show_transferee_as_caller?: boolean;
+            /**
+             * Override the ring duration for this specific transfer, in milliseconds. If not
+             * set, falls back to the agent-level `ring_duration_ms`.
+             */
+            transfer_ring_duration_ms?: number;
         }
         namespace TransferOptionWarmTransfer {
             /**
@@ -3894,6 +4044,11 @@ export declare namespace LlmUpdateParams {
              * Twilio numbers support this option.
              */
             show_transferee_as_caller?: boolean;
+            /**
+             * Override the ring duration for this specific transfer, in milliseconds. If not
+             * set, falls back to the agent-level `ring_duration_ms`.
+             */
+            transfer_ring_duration_ms?: number;
         }
         namespace TransferOptionAgenticWarmTransfer {
             /**
@@ -4268,6 +4423,11 @@ export declare namespace LlmUpdateParams {
              * Examples of the variable value to teach model the style and syntax.
              */
             examples?: Array<string>;
+            /**
+             * Whether this data is required. If true and the data is not extracted, the call
+             * will be marked as unsuccessful.
+             */
+            required?: boolean;
         }
         interface EnumAnalysisData {
             /**
@@ -4286,6 +4446,11 @@ export declare namespace LlmUpdateParams {
              * Type of the variable to extract.
              */
             type: 'enum';
+            /**
+             * Whether this data is required. If true and the data is not extracted, the call
+             * will be marked as unsuccessful.
+             */
+            required?: boolean;
         }
         interface BooleanAnalysisData {
             /**
@@ -4300,6 +4465,11 @@ export declare namespace LlmUpdateParams {
              * Type of the variable to extract.
              */
             type: 'boolean';
+            /**
+             * Whether this data is required. If true and the data is not extracted, the call
+             * will be marked as unsuccessful.
+             */
+            required?: boolean;
         }
         interface NumberAnalysisData {
             /**
@@ -4314,6 +4484,11 @@ export declare namespace LlmUpdateParams {
              * Type of the variable to extract.
              */
             type: 'number';
+            /**
+             * Whether this data is required. If true and the data is not extracted, the call
+             * will be marked as unsuccessful.
+             */
+            required?: boolean;
         }
     }
     interface BridgeTransferTool {
@@ -4646,6 +4821,11 @@ export declare namespace LlmUpdateParams {
                  * id when using `sip refer` cold transfer mode.
                  */
                 show_transferee_as_caller?: boolean;
+                /**
+                 * Override the ring duration for this specific transfer, in milliseconds. If not
+                 * set, falls back to the agent-level `ring_duration_ms`.
+                 */
+                transfer_ring_duration_ms?: number;
             }
             interface TransferOptionWarmTransfer {
                 /**
@@ -4697,6 +4877,11 @@ export declare namespace LlmUpdateParams {
                  * Twilio numbers support this option.
                  */
                 show_transferee_as_caller?: boolean;
+                /**
+                 * Override the ring duration for this specific transfer, in milliseconds. If not
+                 * set, falls back to the agent-level `ring_duration_ms`.
+                 */
+                transfer_ring_duration_ms?: number;
             }
             namespace TransferOptionWarmTransfer {
                 /**
@@ -4768,6 +4953,11 @@ export declare namespace LlmUpdateParams {
                  * Twilio numbers support this option.
                  */
                 show_transferee_as_caller?: boolean;
+                /**
+                 * Override the ring duration for this specific transfer, in milliseconds. If not
+                 * set, falls back to the agent-level `ring_duration_ms`.
+                 */
+                transfer_ring_duration_ms?: number;
             }
             namespace TransferOptionAgenticWarmTransfer {
                 /**
@@ -5142,6 +5332,11 @@ export declare namespace LlmUpdateParams {
                  * Examples of the variable value to teach model the style and syntax.
                  */
                 examples?: Array<string>;
+                /**
+                 * Whether this data is required. If true and the data is not extracted, the call
+                 * will be marked as unsuccessful.
+                 */
+                required?: boolean;
             }
             interface EnumAnalysisData {
                 /**
@@ -5160,6 +5355,11 @@ export declare namespace LlmUpdateParams {
                  * Type of the variable to extract.
                  */
                 type: 'enum';
+                /**
+                 * Whether this data is required. If true and the data is not extracted, the call
+                 * will be marked as unsuccessful.
+                 */
+                required?: boolean;
             }
             interface BooleanAnalysisData {
                 /**
@@ -5174,6 +5374,11 @@ export declare namespace LlmUpdateParams {
                  * Type of the variable to extract.
                  */
                 type: 'boolean';
+                /**
+                 * Whether this data is required. If true and the data is not extracted, the call
+                 * will be marked as unsuccessful.
+                 */
+                required?: boolean;
             }
             interface NumberAnalysisData {
                 /**
@@ -5188,6 +5393,11 @@ export declare namespace LlmUpdateParams {
                  * Type of the variable to extract.
                  */
                 type: 'number';
+                /**
+                 * Whether this data is required. If true and the data is not extracted, the call
+                 * will be marked as unsuccessful.
+                 */
+                required?: boolean;
             }
         }
         interface BridgeTransferTool {