retell-sdk 5.64.0 → 5.66.0

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

@@ -208,6 +208,11 @@ export namespace ConversationFlowComponentResponse {
 
     always_edge?: ConversationNode.AlwaysEdge;
 
+    /**
+     * Custom transcription settings. Required when stt_mode is custom.
+     */
+    custom_stt_config?: ConversationNode.CustomSttConfig | null;
+
     /**
      * Position for frontend display
      */
@@ -259,6 +264,13 @@ export namespace ConversationFlowComponentResponse {
 
     skip_response_edge?: ConversationNode.SkipResponseEdge;
 
+    /**
+     * Balance between speed and accuracy. Fast optimizes for speed using the provider
+     * configuration, accurate optimizes for accuracy using the provider configuration,
+     * and custom uses custom_stt_config.
+     */
+    stt_mode?: 'fast' | 'accurate' | 'custom' | null;
+
     voice_speed?: number | null;
   }
 
@@ -364,6 +376,22 @@ export namespace ConversationFlowComponentResponse {
       }
     }
 
+    /**
+     * Custom transcription settings. Required when stt_mode is custom.
+     */
+    export interface CustomSttConfig {
+      /**
+       * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
+       * 500 for Soniox, and 100 for AssemblyAI.
+       */
+      endpointing_ms: number;
+
+      /**
+       * ASR provider name.
+       */
+      provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
+    }
+
     /**
      * Position for frontend display
      */
@@ -915,6 +943,11 @@ export namespace ConversationFlowComponentResponse {
 
     always_edge?: SubagentNode.AlwaysEdge;
 
+    /**
+     * Custom transcription settings. Required when stt_mode is custom.
+     */
+    custom_stt_config?: SubagentNode.CustomSttConfig | null;
+
     /**
      * Position for frontend display
      */
@@ -966,6 +999,13 @@ export namespace ConversationFlowComponentResponse {
 
     skip_response_edge?: SubagentNode.SkipResponseEdge;
 
+    /**
+     * Balance between speed and accuracy. Fast optimizes for speed using the provider
+     * configuration, accurate optimizes for accuracy using the provider configuration,
+     * and custom uses custom_stt_config.
+     */
+    stt_mode?: 'fast' | 'accurate' | 'custom' | null;
+
     /**
      * The tool ids of the tools defined in main conversation flow or component that
      * can be used in this subagent node.
@@ -1085,6 +1125,22 @@ export namespace ConversationFlowComponentResponse {
       }
     }
 
+    /**
+     * Custom transcription settings. Required when stt_mode is custom.
+     */
+    export interface CustomSttConfig {
+      /**
+       * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
+       * 500 for Soniox, and 100 for AssemblyAI.
+       */
+      endpointing_ms: number;
+
+      /**
+       * ASR provider name.
+       */
+      provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
+    }
+
     /**
      * Position for frontend display
      */
@@ -2011,6 +2067,9 @@ export namespace ConversationFlowComponentResponse {
       }
     }
 
+    /**
+     * @deprecated
+     */
     export interface CheckAvailabilityCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to check
@@ -2051,6 +2110,9 @@ export namespace ConversationFlowComponentResponse {
       timezone?: string;
     }
 
+    /**
+     * @deprecated
+     */
     export interface BookAppointmentCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to book
@@ -8673,6 +8735,9 @@ export namespace ConversationFlowComponentResponse {
     }
   }
 
+  /**
+   * @deprecated
+   */
   export interface CheckAvailabilityCalTool {
     /**
      * Cal.com Api key that have access to the cal.com event you want to check
@@ -8718,6 +8783,9 @@ export namespace ConversationFlowComponentResponse {
     tool_id?: string;
   }
 
+  /**
+   * @deprecated
+   */
   export interface BookAppointmentCalTool {
     /**
      * Cal.com Api key that have access to the cal.com event you want to book
@@ -8768,9 +8836,9 @@ export interface ConversationFlowComponentListResponse {
   /**
    * Whether more results are available.
    */
-  has_more?: boolean;
+  has_more: boolean;
 
-  items?: Array<ConversationFlowComponentResponse>;
+  items: Array<ConversationFlowComponentResponse>;
 
   /**
    * Pagination key for the next page.
@@ -8861,6 +8929,11 @@ export namespace ConversationFlowComponentCreateParams {
 
     always_edge?: ConversationNode.AlwaysEdge;
 
+    /**
+     * Custom transcription settings. Required when stt_mode is custom.
+     */
+    custom_stt_config?: ConversationNode.CustomSttConfig | null;
+
     /**
      * Position for frontend display
      */
@@ -8912,6 +8985,13 @@ export namespace ConversationFlowComponentCreateParams {
 
     skip_response_edge?: ConversationNode.SkipResponseEdge;
 
+    /**
+     * Balance between speed and accuracy. Fast optimizes for speed using the provider
+     * configuration, accurate optimizes for accuracy using the provider configuration,
+     * and custom uses custom_stt_config.
+     */
+    stt_mode?: 'fast' | 'accurate' | 'custom' | null;
+
     voice_speed?: number | null;
   }
 
@@ -9017,6 +9097,22 @@ export namespace ConversationFlowComponentCreateParams {
       }
     }
 
+    /**
+     * Custom transcription settings. Required when stt_mode is custom.
+     */
+    export interface CustomSttConfig {
+      /**
+       * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
+       * 500 for Soniox, and 100 for AssemblyAI.
+       */
+      endpointing_ms: number;
+
+      /**
+       * ASR provider name.
+       */
+      provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
+    }
+
     /**
      * Position for frontend display
      */
@@ -9568,6 +9664,11 @@ export namespace ConversationFlowComponentCreateParams {
 
     always_edge?: SubagentNode.AlwaysEdge;
 
+    /**
+     * Custom transcription settings. Required when stt_mode is custom.
+     */
+    custom_stt_config?: SubagentNode.CustomSttConfig | null;
+
     /**
      * Position for frontend display
      */
@@ -9619,6 +9720,13 @@ export namespace ConversationFlowComponentCreateParams {
 
     skip_response_edge?: SubagentNode.SkipResponseEdge;
 
+    /**
+     * Balance between speed and accuracy. Fast optimizes for speed using the provider
+     * configuration, accurate optimizes for accuracy using the provider configuration,
+     * and custom uses custom_stt_config.
+     */
+    stt_mode?: 'fast' | 'accurate' | 'custom' | null;
+
     /**
      * The tool ids of the tools defined in main conversation flow or component that
      * can be used in this subagent node.
@@ -9738,6 +9846,22 @@ export namespace ConversationFlowComponentCreateParams {
       }
     }
 
+    /**
+     * Custom transcription settings. Required when stt_mode is custom.
+     */
+    export interface CustomSttConfig {
+      /**
+       * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
+       * 500 for Soniox, and 100 for AssemblyAI.
+       */
+      endpointing_ms: number;
+
+      /**
+       * ASR provider name.
+       */
+      provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
+    }
+
     /**
      * Position for frontend display
      */
@@ -10664,6 +10788,9 @@ export namespace ConversationFlowComponentCreateParams {
       }
     }
 
+    /**
+     * @deprecated
+     */
     export interface CheckAvailabilityCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to check
@@ -10704,6 +10831,9 @@ export namespace ConversationFlowComponentCreateParams {
       timezone?: string;
     }
 
+    /**
+     * @deprecated
+     */
     export interface BookAppointmentCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to book
@@ -17326,6 +17456,9 @@ export namespace ConversationFlowComponentCreateParams {
     }
   }
 
+  /**
+   * @deprecated
+   */
   export interface CheckAvailabilityCalTool {
     /**
      * Cal.com Api key that have access to the cal.com event you want to check
@@ -17371,6 +17504,9 @@ export namespace ConversationFlowComponentCreateParams {
     tool_id?: string;
   }
 
+  /**
+   * @deprecated
+   */
   export interface BookAppointmentCalTool {
     /**
      * Cal.com Api key that have access to the cal.com event you want to book
@@ -17534,6 +17670,11 @@ export namespace ConversationFlowComponentUpdateParams {
 
     always_edge?: ConversationNode.AlwaysEdge;
 
+    /**
+     * Custom transcription settings. Required when stt_mode is custom.
+     */
+    custom_stt_config?: ConversationNode.CustomSttConfig | null;
+
     /**
      * Position for frontend display
      */
@@ -17585,6 +17726,13 @@ export namespace ConversationFlowComponentUpdateParams {
 
     skip_response_edge?: ConversationNode.SkipResponseEdge;
 
+    /**
+     * Balance between speed and accuracy. Fast optimizes for speed using the provider
+     * configuration, accurate optimizes for accuracy using the provider configuration,
+     * and custom uses custom_stt_config.
+     */
+    stt_mode?: 'fast' | 'accurate' | 'custom' | null;
+
     voice_speed?: number | null;
   }
 
@@ -17690,6 +17838,22 @@ export namespace ConversationFlowComponentUpdateParams {
       }
     }
 
+    /**
+     * Custom transcription settings. Required when stt_mode is custom.
+     */
+    export interface CustomSttConfig {
+      /**
+       * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
+       * 500 for Soniox, and 100 for AssemblyAI.
+       */
+      endpointing_ms: number;
+
+      /**
+       * ASR provider name.
+       */
+      provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
+    }
+
     /**
      * Position for frontend display
      */
@@ -18241,6 +18405,11 @@ export namespace ConversationFlowComponentUpdateParams {
 
     always_edge?: SubagentNode.AlwaysEdge;
 
+    /**
+     * Custom transcription settings. Required when stt_mode is custom.
+     */
+    custom_stt_config?: SubagentNode.CustomSttConfig | null;
+
     /**
      * Position for frontend display
      */
@@ -18292,6 +18461,13 @@ export namespace ConversationFlowComponentUpdateParams {
 
     skip_response_edge?: SubagentNode.SkipResponseEdge;
 
+    /**
+     * Balance between speed and accuracy. Fast optimizes for speed using the provider
+     * configuration, accurate optimizes for accuracy using the provider configuration,
+     * and custom uses custom_stt_config.
+     */
+    stt_mode?: 'fast' | 'accurate' | 'custom' | null;
+
     /**
      * The tool ids of the tools defined in main conversation flow or component that
      * can be used in this subagent node.
@@ -18411,6 +18587,22 @@ export namespace ConversationFlowComponentUpdateParams {
       }
     }
 
+    /**
+     * Custom transcription settings. Required when stt_mode is custom.
+     */
+    export interface CustomSttConfig {
+      /**
+       * Endpointing timeout in milliseconds. Minimum is 100 for Azure, 10 for Deepgram,
+       * 500 for Soniox, and 100 for AssemblyAI.
+       */
+      endpointing_ms: number;
+
+      /**
+       * ASR provider name.
+       */
+      provider: 'azure' | 'deepgram' | 'soniox' | 'assemblyai';
+    }
+
     /**
      * Position for frontend display
      */
@@ -19337,6 +19529,9 @@ export namespace ConversationFlowComponentUpdateParams {
       }
     }
 
+    /**
+     * @deprecated
+     */
     export interface CheckAvailabilityCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to check
@@ -19377,6 +19572,9 @@ export namespace ConversationFlowComponentUpdateParams {
       timezone?: string;
     }
 
+    /**
+     * @deprecated
+     */
     export interface BookAppointmentCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to book
@@ -25965,6 +26163,9 @@ export namespace ConversationFlowComponentUpdateParams {
     }
   }
 
+  /**
+   * @deprecated
+   */
   export interface CheckAvailabilityCalTool {
     /**
      * Cal.com Api key that have access to the cal.com event you want to check
@@ -26010,6 +26211,9 @@ export namespace ConversationFlowComponentUpdateParams {
     tool_id?: string;
   }
 
+  /**
+   * @deprecated
+   */
   export interface BookAppointmentCalTool {
     /**
      * Cal.com Api key that have access to the cal.com event you want to book