retell-sdk 5.63.0 → 5.65.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 {
     /**
@@ -1471,6 +1471,9 @@ export declare namespace ConversationFlowResponse {
                     }
                 }
             }
+            /**
+             * @deprecated
+             */
             interface CheckAvailabilityCalTool {
                 /**
                  * Cal.com Api key that have access to the cal.com event you want to check
@@ -1505,6 +1508,9 @@ export declare namespace ConversationFlowResponse {
                  */
                 timezone?: string;
             }
+            /**
+             * @deprecated
+             */
             interface BookAppointmentCalTool {
                 /**
                  * Cal.com Api key that have access to the cal.com event you want to book
@@ -1580,7 +1586,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 +4741,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;
@@ -6143,6 +6153,9 @@ export declare namespace ConversationFlowResponse {
                 required?: Array<string>;
             }
         }
+        /**
+         * @deprecated
+         */
         interface CheckAvailabilityCalTool {
             /**
              * Cal.com Api key that have access to the cal.com event you want to check
@@ -6181,6 +6194,9 @@ export declare namespace ConversationFlowResponse {
              */
             tool_id?: string;
         }
+        /**
+         * @deprecated
+         */
         interface BookAppointmentCalTool {
             /**
              * Cal.com Api key that have access to the cal.com event you want to book
@@ -7533,6 +7549,9 @@ export declare namespace ConversationFlowResponse {
                 }
             }
         }
+        /**
+         * @deprecated
+         */
         interface CheckAvailabilityCalTool {
             /**
              * Cal.com Api key that have access to the cal.com event you want to check
@@ -7567,6 +7586,9 @@ export declare namespace ConversationFlowResponse {
              */
             timezone?: string;
         }
+        /**
+         * @deprecated
+         */
         interface BookAppointmentCalTool {
             /**
              * Cal.com Api key that have access to the cal.com event you want to book
@@ -7642,7 +7664,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 +10819,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;
@@ -12174,6 +12200,9 @@ export declare namespace ConversationFlowResponse {
             required?: Array<string>;
         }
     }
+    /**
+     * @deprecated
+     */
     interface CheckAvailabilityCalTool {
         /**
          * Cal.com Api key that have access to the cal.com event you want to check
@@ -12212,6 +12241,9 @@ export declare namespace ConversationFlowResponse {
          */
         tool_id?: string;
     }
+    /**
+     * @deprecated
+     */
     interface BookAppointmentCalTool {
         /**
          * Cal.com Api key that have access to the cal.com event you want to book
@@ -12255,8 +12287,8 @@ export interface ConversationFlowListResponse {
     /**
      * Whether more results are available.
      */
-    has_more?: boolean;
-    items?: Array<ConversationFlowResponse>;
+    has_more: boolean;
+    items: Array<ConversationFlowResponse>;
     /**
      * Pagination key for the next page.
      */
@@ -13623,6 +13655,9 @@ export declare namespace ConversationFlowCreateParams {
                 }
             }
         }
+        /**
+         * @deprecated
+         */
         interface CheckAvailabilityCalTool {
             /**
              * Cal.com Api key that have access to the cal.com event you want to check
@@ -13657,6 +13692,9 @@ export declare namespace ConversationFlowCreateParams {
              */
             timezone?: string;
         }
+        /**
+         * @deprecated
+         */
         interface BookAppointmentCalTool {
             /**
              * Cal.com Api key that have access to the cal.com event you want to book
@@ -13732,7 +13770,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 +16925,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;
@@ -19386,6 +19428,9 @@ export declare namespace ConversationFlowCreateParams {
                     }
                 }
             }
+            /**
+             * @deprecated
+             */
             interface CheckAvailabilityCalTool {
                 /**
                  * Cal.com Api key that have access to the cal.com event you want to check
@@ -19420,6 +19465,9 @@ export declare namespace ConversationFlowCreateParams {
                  */
                 timezone?: string;
             }
+            /**
+             * @deprecated
+             */
             interface BookAppointmentCalTool {
                 /**
                  * Cal.com Api key that have access to the cal.com event you want to book
@@ -19495,7 +19543,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 +22698,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;
@@ -24058,6 +24110,9 @@ export declare namespace ConversationFlowCreateParams {
                 required?: Array<string>;
             }
         }
+        /**
+         * @deprecated
+         */
         interface CheckAvailabilityCalTool {
             /**
              * Cal.com Api key that have access to the cal.com event you want to check
@@ -24096,6 +24151,9 @@ export declare namespace ConversationFlowCreateParams {
              */
             tool_id?: string;
         }
+        /**
+         * @deprecated
+         */
         interface BookAppointmentCalTool {
             /**
              * Cal.com Api key that have access to the cal.com event you want to book
@@ -24351,6 +24409,9 @@ export declare namespace ConversationFlowCreateParams {
             required?: Array<string>;
         }
     }
+    /**
+     * @deprecated
+     */
     interface CheckAvailabilityCalTool {
         /**
          * Cal.com Api key that have access to the cal.com event you want to check
@@ -24389,6 +24450,9 @@ export declare namespace ConversationFlowCreateParams {
          */
         tool_id?: string;
     }
+    /**
+     * @deprecated
+     */
     interface BookAppointmentCalTool {
         /**
          * Cal.com Api key that have access to the cal.com event you want to book
@@ -25827,6 +25891,9 @@ export declare namespace ConversationFlowUpdateParams {
                     }
                 }
             }
+            /**
+             * @deprecated
+             */
             interface CheckAvailabilityCalTool {
                 /**
                  * Cal.com Api key that have access to the cal.com event you want to check
@@ -25861,6 +25928,9 @@ export declare namespace ConversationFlowUpdateParams {
                  */
                 timezone?: string;
             }
+            /**
+             * @deprecated
+             */
             interface BookAppointmentCalTool {
                 /**
                  * Cal.com Api key that have access to the cal.com event you want to book
@@ -25936,7 +26006,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 +29161,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;
@@ -30499,6 +30573,9 @@ export declare namespace ConversationFlowUpdateParams {
                 required?: Array<string>;
             }
         }
+        /**
+         * @deprecated
+         */
         interface CheckAvailabilityCalTool {
             /**
              * Cal.com Api key that have access to the cal.com event you want to check
@@ -30537,6 +30614,9 @@ export declare namespace ConversationFlowUpdateParams {
              */
             tool_id?: string;
         }
+        /**
+         * @deprecated
+         */
         interface BookAppointmentCalTool {
             /**
              * Cal.com Api key that have access to the cal.com event you want to book
@@ -31889,6 +31969,9 @@ export declare namespace ConversationFlowUpdateParams {
                 }
             }
         }
+        /**
+         * @deprecated
+         */
         interface CheckAvailabilityCalTool {
             /**
              * Cal.com Api key that have access to the cal.com event you want to check
@@ -31923,6 +32006,9 @@ export declare namespace ConversationFlowUpdateParams {
              */
             timezone?: string;
         }
+        /**
+         * @deprecated
+         */
         interface BookAppointmentCalTool {
             /**
              * Cal.com Api key that have access to the cal.com event you want to book
@@ -31998,7 +32084,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 +35239,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;
@@ -36530,6 +36620,9 @@ export declare namespace ConversationFlowUpdateParams {
             required?: Array<string>;
         }
     }
+    /**
+     * @deprecated
+     */
     interface CheckAvailabilityCalTool {
         /**
          * Cal.com Api key that have access to the cal.com event you want to check
@@ -36568,6 +36661,9 @@ export declare namespace ConversationFlowUpdateParams {
          */
         tool_id?: string;
     }
+    /**
+     * @deprecated
+     */
     interface BookAppointmentCalTool {
         /**
          * Cal.com Api key that have access to the cal.com event you want to book
@@ -36621,7 +36717,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