retell-sdk 5.63.0 → 5.65.0

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

@@ -2011,6 +2011,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 +2054,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
@@ -2141,7 +2147,9 @@ export namespace ConversationFlowComponentResponse {
       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;
 
@@ -6641,7 +6649,9 @@ export namespace ConversationFlowComponentResponse {
     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;
 
@@ -8669,6 +8679,9 @@ export namespace ConversationFlowComponentResponse {
     }
   }
 
+  /**
+   * @deprecated
+   */
   export interface CheckAvailabilityCalTool {
     /**
      * Cal.com Api key that have access to the cal.com event you want to check
@@ -8714,6 +8727,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
@@ -8764,9 +8780,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.
@@ -10660,6 +10676,9 @@ export namespace ConversationFlowComponentCreateParams {
       }
     }
 
+    /**
+     * @deprecated
+     */
     export interface CheckAvailabilityCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to check
@@ -10700,6 +10719,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
@@ -10790,7 +10812,9 @@ export namespace ConversationFlowComponentCreateParams {
       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;
 
@@ -15290,7 +15314,9 @@ export namespace ConversationFlowComponentCreateParams {
     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;
 
@@ -17318,6 +17344,9 @@ export namespace ConversationFlowComponentCreateParams {
     }
   }
 
+  /**
+   * @deprecated
+   */
   export interface CheckAvailabilityCalTool {
     /**
      * Cal.com Api key that have access to the cal.com event you want to check
@@ -17363,6 +17392,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
@@ -19329,6 +19361,9 @@ export namespace ConversationFlowComponentUpdateParams {
       }
     }
 
+    /**
+     * @deprecated
+     */
     export interface CheckAvailabilityCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to check
@@ -19369,6 +19404,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
@@ -19459,7 +19497,9 @@ export namespace ConversationFlowComponentUpdateParams {
       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;
 
@@ -23959,7 +23999,9 @@ export namespace ConversationFlowComponentUpdateParams {
     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;
 
@@ -25953,6 +25995,9 @@ export namespace ConversationFlowComponentUpdateParams {
     }
   }
 
+  /**
+   * @deprecated
+   */
   export interface CheckAvailabilityCalTool {
     /**
      * Cal.com Api key that have access to the cal.com event you want to check
@@ -25998,6 +26043,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

package/src/resources/conversation-flow.ts

@@ -103,8 +103,14 @@ export class ConversationFlow extends APIResource {
    * );
    * ```
    */
-  delete(conversationFlowID: string, options?: RequestOptions): APIPromise<void> {
+  delete(
+    conversationFlowID: string,
+    params: ConversationFlowDeleteParams | null | undefined = {},
+    options?: RequestOptions,
+  ): APIPromise<void> {
+    const { force_delete } = params ?? {};
     return this._client.delete(path`/delete-conversation-flow/${conversationFlowID}`, {
+      query: { force_delete },
       ...options,
       headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
     });
@@ -2141,6 +2147,9 @@ export namespace ConversationFlowResponse {
         }
       }
 
+      /**
+       * @deprecated
+       */
       export interface CheckAvailabilityCalTool {
         /**
          * Cal.com Api key that have access to the cal.com event you want to check
@@ -2181,6 +2190,9 @@ export namespace ConversationFlowResponse {
         timezone?: string;
       }
 
+      /**
+       * @deprecated
+       */
       export interface BookAppointmentCalTool {
         /**
          * Cal.com Api key that have access to the cal.com event you want to book
@@ -2271,7 +2283,9 @@ export 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;
 
@@ -6771,7 +6785,9 @@ export 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;
 
@@ -8799,6 +8815,9 @@ export namespace ConversationFlowResponse {
       }
     }
 
+    /**
+     * @deprecated
+     */
     export interface CheckAvailabilityCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to check
@@ -8844,6 +8863,9 @@ export namespace ConversationFlowResponse {
       tool_id?: string;
     }
 
+    /**
+     * @deprecated
+     */
     export interface BookAppointmentCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to book
@@ -10796,6 +10818,9 @@ export namespace ConversationFlowResponse {
       }
     }
 
+    /**
+     * @deprecated
+     */
     export interface CheckAvailabilityCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to check
@@ -10836,6 +10861,9 @@ export namespace ConversationFlowResponse {
       timezone?: string;
     }
 
+    /**
+     * @deprecated
+     */
     export interface BookAppointmentCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to book
@@ -10926,7 +10954,9 @@ export 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;
 
@@ -15426,7 +15456,9 @@ export 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;
 
@@ -17420,6 +17452,9 @@ export namespace ConversationFlowResponse {
     }
   }
 
+  /**
+   * @deprecated
+   */
   export interface CheckAvailabilityCalTool {
     /**
      * Cal.com Api key that have access to the cal.com event you want to check
@@ -17465,6 +17500,9 @@ export namespace ConversationFlowResponse {
     tool_id?: string;
   }
 
+  /**
+   * @deprecated
+   */
   export interface BookAppointmentCalTool {
     /**
      * Cal.com Api key that have access to the cal.com event you want to book
@@ -17515,9 +17553,9 @@ export interface ConversationFlowListResponse {
   /**
    * Whether more results are available.
    */
-  has_more?: boolean;
+  has_more: boolean;
 
-  items?: Array<ConversationFlowResponse>;
+  items: Array<ConversationFlowResponse>;
 
   /**
    * Pagination key for the next page.
@@ -19512,6 +19550,9 @@ export namespace ConversationFlowCreateParams {
       }
     }
 
+    /**
+     * @deprecated
+     */
     export interface CheckAvailabilityCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to check
@@ -19552,6 +19593,9 @@ export namespace ConversationFlowCreateParams {
       timezone?: string;
     }
 
+    /**
+     * @deprecated
+     */
     export interface BookAppointmentCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to book
@@ -19642,7 +19686,9 @@ export 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;
 
@@ -24142,7 +24188,9 @@ export 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;
 
@@ -27826,6 +27874,9 @@ export namespace ConversationFlowCreateParams {
         }
       }
 
+      /**
+       * @deprecated
+       */
       export interface CheckAvailabilityCalTool {
         /**
          * Cal.com Api key that have access to the cal.com event you want to check
@@ -27866,6 +27917,9 @@ export namespace ConversationFlowCreateParams {
         timezone?: string;
       }
 
+      /**
+       * @deprecated
+       */
       export interface BookAppointmentCalTool {
         /**
          * Cal.com Api key that have access to the cal.com event you want to book
@@ -27956,7 +28010,9 @@ export 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;
 
@@ -32456,7 +32512,9 @@ export 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;
 
@@ -34484,6 +34542,9 @@ export namespace ConversationFlowCreateParams {
       }
     }
 
+    /**
+     * @deprecated
+     */
     export interface CheckAvailabilityCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to check
@@ -34529,6 +34590,9 @@ export namespace ConversationFlowCreateParams {
       tool_id?: string;
     }
 
+    /**
+     * @deprecated
+     */
     export interface BookAppointmentCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to book
@@ -34818,6 +34882,9 @@ export namespace ConversationFlowCreateParams {
     }
   }
 
+  /**
+   * @deprecated
+   */
   export interface CheckAvailabilityCalTool {
     /**
      * Cal.com Api key that have access to the cal.com event you want to check
@@ -34863,6 +34930,9 @@ export namespace ConversationFlowCreateParams {
     tool_id?: string;
   }
 
+  /**
+   * @deprecated
+   */
   export interface BookAppointmentCalTool {
     /**
      * Cal.com Api key that have access to the cal.com event you want to book
@@ -36938,6 +37008,9 @@ export namespace ConversationFlowUpdateParams {
         }
       }
 
+      /**
+       * @deprecated
+       */
       export interface CheckAvailabilityCalTool {
         /**
          * Cal.com Api key that have access to the cal.com event you want to check
@@ -36978,6 +37051,9 @@ export namespace ConversationFlowUpdateParams {
         timezone?: string;
       }
 
+      /**
+       * @deprecated
+       */
       export interface BookAppointmentCalTool {
         /**
          * Cal.com Api key that have access to the cal.com event you want to book
@@ -37068,7 +37144,9 @@ export 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;
 
@@ -41568,7 +41646,9 @@ export 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;
 
@@ -43596,6 +43676,9 @@ export namespace ConversationFlowUpdateParams {
       }
     }
 
+    /**
+     * @deprecated
+     */
     export interface CheckAvailabilityCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to check
@@ -43641,6 +43724,9 @@ export namespace ConversationFlowUpdateParams {
       tool_id?: string;
     }
 
+    /**
+     * @deprecated
+     */
     export interface BookAppointmentCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to book
@@ -45593,6 +45679,9 @@ export namespace ConversationFlowUpdateParams {
       }
     }
 
+    /**
+     * @deprecated
+     */
     export interface CheckAvailabilityCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to check
@@ -45633,6 +45722,9 @@ export namespace ConversationFlowUpdateParams {
       timezone?: string;
     }
 
+    /**
+     * @deprecated
+     */
     export interface BookAppointmentCalTool {
       /**
        * Cal.com Api key that have access to the cal.com event you want to book
@@ -45723,7 +45815,9 @@ export 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;
 
@@ -50223,7 +50317,9 @@ export 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;
 
@@ -52217,6 +52313,9 @@ export namespace ConversationFlowUpdateParams {
     }
   }
 
+  /**
+   * @deprecated
+   */
   export interface CheckAvailabilityCalTool {
     /**
      * Cal.com Api key that have access to the cal.com event you want to check
@@ -52262,6 +52361,9 @@ export namespace ConversationFlowUpdateParams {
     tool_id?: string;
   }
 
+  /**
+   * @deprecated
+   */
   export interface BookAppointmentCalTool {
     /**
      * Cal.com Api key that have access to the cal.com event you want to book
@@ -52325,6 +52427,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,
@@ -52333,5 +52444,6 @@ export declare namespace ConversationFlow {
     type ConversationFlowRetrieveParams as ConversationFlowRetrieveParams,
     type ConversationFlowUpdateParams as ConversationFlowUpdateParams,
     type ConversationFlowListParams as ConversationFlowListParams,
+    type ConversationFlowDeleteParams as ConversationFlowDeleteParams,
   };
 }