retell-sdk 5.62.0 → 5.64.0

package/resources/conversation-flow.d.ts

@@ -70,7 +70,7 @@ export declare class ConversationFlow extends APIResource {
      * );
      * ```
      */
-    delete(conversationFlowID: string, options?: RequestOptions): APIPromise<void>;
+    delete(conversationFlowID: string, params?: ConversationFlowDeleteParams | null | undefined, options?: RequestOptions): APIPromise<void>;
 }
 export interface ConversationFlowResponse {
     /**
@@ -1580,7 +1580,9 @@ export declare namespace ConversationFlowResponse {
                  */
                 keep_current_language?: boolean;
                 /**
-                 * If true, keep the current voice when swapping agents. Defaults to false.
+                 * If true, keep the current voice and ambient sound settings when swapping agents.
+                 * Otherwise, use the destination agent's voice and ambient sound settings.
+                 * Defaults to false.
                  */
                 keep_current_voice?: boolean;
                 speak_during_execution?: boolean;
@@ -4733,7 +4735,9 @@ export declare namespace ConversationFlowResponse {
              */
             keep_current_language?: boolean;
             /**
-             * If true, keep the current voice when swapping agents. Defaults to false.
+             * If true, keep the current voice and ambient sound settings when swapping agents.
+             * Otherwise, use the destination agent's voice and ambient sound settings.
+             * Defaults to false.
              */
             keep_current_voice?: boolean;
             model_choice?: AgentSwapNode.ModelChoice;
@@ -7642,7 +7646,9 @@ export declare namespace ConversationFlowResponse {
              */
             keep_current_language?: boolean;
             /**
-             * If true, keep the current voice when swapping agents. Defaults to false.
+             * If true, keep the current voice and ambient sound settings when swapping agents.
+             * Otherwise, use the destination agent's voice and ambient sound settings.
+             * Defaults to false.
              */
             keep_current_voice?: boolean;
             speak_during_execution?: boolean;
@@ -10795,7 +10801,9 @@ export declare namespace ConversationFlowResponse {
          */
         keep_current_language?: boolean;
         /**
-         * If true, keep the current voice when swapping agents. Defaults to false.
+         * If true, keep the current voice and ambient sound settings when swapping agents.
+         * Otherwise, use the destination agent's voice and ambient sound settings.
+         * Defaults to false.
          */
         keep_current_voice?: boolean;
         model_choice?: AgentSwapNode.ModelChoice;
@@ -13732,7 +13740,9 @@ export declare namespace ConversationFlowCreateParams {
              */
             keep_current_language?: boolean;
             /**
-             * If true, keep the current voice when swapping agents. Defaults to false.
+             * If true, keep the current voice and ambient sound settings when swapping agents.
+             * Otherwise, use the destination agent's voice and ambient sound settings.
+             * Defaults to false.
              */
             keep_current_voice?: boolean;
             speak_during_execution?: boolean;
@@ -16885,7 +16895,9 @@ export declare namespace ConversationFlowCreateParams {
          */
         keep_current_language?: boolean;
         /**
-         * If true, keep the current voice when swapping agents. Defaults to false.
+         * If true, keep the current voice and ambient sound settings when swapping agents.
+         * Otherwise, use the destination agent's voice and ambient sound settings.
+         * Defaults to false.
          */
         keep_current_voice?: boolean;
         model_choice?: AgentSwapNode.ModelChoice;
@@ -19495,7 +19507,9 @@ export declare namespace ConversationFlowCreateParams {
                  */
                 keep_current_language?: boolean;
                 /**
-                 * If true, keep the current voice when swapping agents. Defaults to false.
+                 * If true, keep the current voice and ambient sound settings when swapping agents.
+                 * Otherwise, use the destination agent's voice and ambient sound settings.
+                 * Defaults to false.
                  */
                 keep_current_voice?: boolean;
                 speak_during_execution?: boolean;
@@ -22648,7 +22662,9 @@ export declare namespace ConversationFlowCreateParams {
              */
             keep_current_language?: boolean;
             /**
-             * If true, keep the current voice when swapping agents. Defaults to false.
+             * If true, keep the current voice and ambient sound settings when swapping agents.
+             * Otherwise, use the destination agent's voice and ambient sound settings.
+             * Defaults to false.
              */
             keep_current_voice?: boolean;
             model_choice?: AgentSwapNode.ModelChoice;
@@ -25936,7 +25952,9 @@ export declare namespace ConversationFlowUpdateParams {
                  */
                 keep_current_language?: boolean;
                 /**
-                 * If true, keep the current voice when swapping agents. Defaults to false.
+                 * If true, keep the current voice and ambient sound settings when swapping agents.
+                 * Otherwise, use the destination agent's voice and ambient sound settings.
+                 * Defaults to false.
                  */
                 keep_current_voice?: boolean;
                 speak_during_execution?: boolean;
@@ -29089,7 +29107,9 @@ export declare namespace ConversationFlowUpdateParams {
              */
             keep_current_language?: boolean;
             /**
-             * If true, keep the current voice when swapping agents. Defaults to false.
+             * If true, keep the current voice and ambient sound settings when swapping agents.
+             * Otherwise, use the destination agent's voice and ambient sound settings.
+             * Defaults to false.
              */
             keep_current_voice?: boolean;
             model_choice?: AgentSwapNode.ModelChoice;
@@ -31998,7 +32018,9 @@ export declare namespace ConversationFlowUpdateParams {
              */
             keep_current_language?: boolean;
             /**
-             * If true, keep the current voice when swapping agents. Defaults to false.
+             * If true, keep the current voice and ambient sound settings when swapping agents.
+             * Otherwise, use the destination agent's voice and ambient sound settings.
+             * Defaults to false.
              */
             keep_current_voice?: boolean;
             speak_during_execution?: boolean;
@@ -35151,7 +35173,9 @@ export declare namespace ConversationFlowUpdateParams {
          */
         keep_current_language?: boolean;
         /**
-         * If true, keep the current voice when swapping agents. Defaults to false.
+         * If true, keep the current voice and ambient sound settings when swapping agents.
+         * Otherwise, use the destination agent's voice and ambient sound settings.
+         * Defaults to false.
          */
         keep_current_voice?: boolean;
         model_choice?: AgentSwapNode.ModelChoice;
@@ -36621,7 +36645,15 @@ export interface ConversationFlowListParams {
      */
     sort_order?: 'ascending' | 'descending';
 }
+export interface ConversationFlowDeleteParams {
+    /**
+     * By default the deletion is rejected with a 400 if any agent still uses this
+     * conversation flow as its response engine. Set to true to delete it anyway, which
+     * leaves those agents pointing at a conversation flow that no longer exists.
+     */
+    force_delete?: boolean;
+}
 export declare namespace ConversationFlow {
-    export { type ConversationFlowResponse as ConversationFlowResponse, type ConversationFlowListResponse as ConversationFlowListResponse, type ConversationFlowCreateParams as ConversationFlowCreateParams, type ConversationFlowRetrieveParams as ConversationFlowRetrieveParams, type ConversationFlowUpdateParams as ConversationFlowUpdateParams, type ConversationFlowListParams as ConversationFlowListParams, };
+    export { type ConversationFlowResponse as ConversationFlowResponse, type ConversationFlowListResponse as ConversationFlowListResponse, type ConversationFlowCreateParams as ConversationFlowCreateParams, type ConversationFlowRetrieveParams as ConversationFlowRetrieveParams, type ConversationFlowUpdateParams as ConversationFlowUpdateParams, type ConversationFlowListParams as ConversationFlowListParams, type ConversationFlowDeleteParams as ConversationFlowDeleteParams, };
 }
 //# sourceMappingURL=conversation-flow.d.ts.map