retell-sdk 4.10.0 → 4.12.0

package/src/resources/agent.ts

@@ -134,6 +134,14 @@ export interface AgentResponse {
    */
   backchannel_words?: Array<string> | null;
 
+  /**
+   * If set, will delay the first message by the specified amount of milliseconds, so
+   * that it gives user more time to prepare to take the call. Valid range is [0,
+   * 5000]. If not set or set to 0, agent will speak immediately. Only applicable
+   * when agent speaks first.
+   */
+  begin_message_delay_ms?: number;
+
   /**
    * Provide a customized list of keywords to bias the transcriber model, so that
    * these words are more likely to get transcribed. Commonly used for names, brands,
@@ -234,8 +242,8 @@ export interface AgentResponse {
 
   /**
    * Whether this agent opts out of sensitive data storage like transcript,
-   * recording, logging. These data can still be accessed securely via webhooks. If
-   * not set, default value of false will apply.
+   * recording, logging, inbound/outbound phone numbers, etc. These data can still be
+   * accessed securely via webhooks. If not set, default value of false will apply.
    */
   opt_out_sensitive_data_storage?: boolean;
 
@@ -283,16 +291,18 @@ export interface AgentResponse {
   /**
    * Optionally set the voice model used for the selected voice. Currently only
    * elevenlab voices have voice model selections. Set to null to remove voice model
-   * selection, and default ones will apply. Supported voice models are:
-   *
-   * - `eleven_turbo_v2`: Fast english only model, supports pronunciation tags.
-   *
-   * - `eleven_turbo_v2_5`: Multilingual model with lowest latency.
-   *
-   * - `eleven_multilingual_v2`: Multilingual model with rich emotion and nice
-   *   accent.
-   */
-  voice_model?: 'eleven_turbo_v2' | 'eleven_turbo_v2_5' | 'eleven_multilingual_v2' | null;
+   * selection, and default ones will apply. Check out the dashboard for details on
+   * each voice model.
+   */
+  voice_model?:
+    | 'eleven_turbo_v2'
+    | 'eleven_flash_v2'
+    | 'eleven_turbo_v2_5'
+    | 'eleven_flash_v2_5'
+    | 'eleven_multilingual_v2'
+    | 'Play3.0-mini'
+    | 'PlayDialog'
+    | null;
 
   /**
    * Controls speed of voice. Value ranging from [0.5,2]. Lower value means slower
@@ -539,6 +549,14 @@ export interface AgentCreateParams {
    */
   backchannel_words?: Array<string> | null;
 
+  /**
+   * If set, will delay the first message by the specified amount of milliseconds, so
+   * that it gives user more time to prepare to take the call. Valid range is [0,
+   * 5000]. If not set or set to 0, agent will speak immediately. Only applicable
+   * when agent speaks first.
+   */
+  begin_message_delay_ms?: number;
+
   /**
    * Provide a customized list of keywords to bias the transcriber model, so that
    * these words are more likely to get transcribed. Commonly used for names, brands,
@@ -639,8 +657,8 @@ export interface AgentCreateParams {
 
   /**
    * Whether this agent opts out of sensitive data storage like transcript,
-   * recording, logging. These data can still be accessed securely via webhooks. If
-   * not set, default value of false will apply.
+   * recording, logging, inbound/outbound phone numbers, etc. These data can still be
+   * accessed securely via webhooks. If not set, default value of false will apply.
    */
   opt_out_sensitive_data_storage?: boolean;
 
@@ -688,16 +706,18 @@ export interface AgentCreateParams {
   /**
    * Optionally set the voice model used for the selected voice. Currently only
    * elevenlab voices have voice model selections. Set to null to remove voice model
-   * selection, and default ones will apply. Supported voice models are:
-   *
-   * - `eleven_turbo_v2`: Fast english only model, supports pronunciation tags.
-   *
-   * - `eleven_turbo_v2_5`: Multilingual model with lowest latency.
-   *
-   * - `eleven_multilingual_v2`: Multilingual model with rich emotion and nice
-   *   accent.
-   */
-  voice_model?: 'eleven_turbo_v2' | 'eleven_turbo_v2_5' | 'eleven_multilingual_v2' | null;
+   * selection, and default ones will apply. Check out the dashboard for details on
+   * each voice model.
+   */
+  voice_model?:
+    | 'eleven_turbo_v2'
+    | 'eleven_flash_v2'
+    | 'eleven_turbo_v2_5'
+    | 'eleven_flash_v2_5'
+    | 'eleven_multilingual_v2'
+    | 'Play3.0-mini'
+    | 'PlayDialog'
+    | null;
 
   /**
    * Controls speed of voice. Value ranging from [0.5,2]. Lower value means slower
@@ -931,6 +951,14 @@ export interface AgentUpdateParams {
    */
   backchannel_words?: Array<string> | null;
 
+  /**
+   * If set, will delay the first message by the specified amount of milliseconds, so
+   * that it gives user more time to prepare to take the call. Valid range is [0,
+   * 5000]. If not set or set to 0, agent will speak immediately. Only applicable
+   * when agent speaks first.
+   */
+  begin_message_delay_ms?: number;
+
   /**
    * Provide a customized list of keywords to bias the transcriber model, so that
    * these words are more likely to get transcribed. Commonly used for names, brands,
@@ -1031,8 +1059,8 @@ export interface AgentUpdateParams {
 
   /**
    * Whether this agent opts out of sensitive data storage like transcript,
-   * recording, logging. These data can still be accessed securely via webhooks. If
-   * not set, default value of false will apply.
+   * recording, logging, inbound/outbound phone numbers, etc. These data can still be
+   * accessed securely via webhooks. If not set, default value of false will apply.
    */
   opt_out_sensitive_data_storage?: boolean;
 
@@ -1091,16 +1119,18 @@ export interface AgentUpdateParams {
   /**
    * Optionally set the voice model used for the selected voice. Currently only
    * elevenlab voices have voice model selections. Set to null to remove voice model
-   * selection, and default ones will apply. Supported voice models are:
-   *
-   * - `eleven_turbo_v2`: Fast english only model, supports pronunciation tags.
-   *
-   * - `eleven_turbo_v2_5`: Multilingual model with lowest latency.
-   *
-   * - `eleven_multilingual_v2`: Multilingual model with rich emotion and nice
-   *   accent.
-   */
-  voice_model?: 'eleven_turbo_v2' | 'eleven_turbo_v2_5' | 'eleven_multilingual_v2' | null;
+   * selection, and default ones will apply. Check out the dashboard for details on
+   * each voice model.
+   */
+  voice_model?:
+    | 'eleven_turbo_v2'
+    | 'eleven_flash_v2'
+    | 'eleven_turbo_v2_5'
+    | 'eleven_flash_v2_5'
+    | 'eleven_multilingual_v2'
+    | 'Play3.0-mini'
+    | 'PlayDialog'
+    | null;
 
   /**
    * Controls speed of voice. Value ranging from [0.5,2]. Lower value means slower

package/src/resources/call.ts

@@ -104,6 +104,11 @@ export interface PhoneCallResponse {
    */
   call_analysis?: PhoneCallResponse.CallAnalysis;
 
+  /**
+   * Cost of the call, including all the products and their costs and discount.
+   */
+  call_cost?: PhoneCallResponse.CallCost;
+
   /**
    * The reason for the disconnection of the call. Read details desciption about
    * reasons listed here at
@@ -243,6 +248,55 @@ export namespace PhoneCallResponse {
     user_sentiment?: 'Negative' | 'Positive' | 'Neutral' | 'Unknown';
   }
 
+  /**
+   * Cost of the call, including all the products and their costs and discount.
+   */
+  export interface CallCost {
+    /**
+     * Combined cost of all individual costs in cents
+     */
+    combined_cost: number;
+
+    /**
+     * List of products with their unit prices and costs in cents
+     */
+    product_costs: Array<CallCost.ProductCost>;
+
+    /**
+     * Total duration of the call in seconds
+     */
+    total_duration_seconds: number;
+
+    /**
+     * Total unit duration price of all products in cents per second
+     */
+    total_duration_unit_price: number;
+
+    /**
+     * Total one time price of all products in cents per call
+     */
+    total_one_time_price: number;
+  }
+
+  export namespace CallCost {
+    export interface ProductCost {
+      /**
+       * Cost for the product in cents for the duration of the call.
+       */
+      cost: number;
+
+      /**
+       * Product name that has a cost associated with it.
+       */
+      product: string;
+
+      /**
+       * Unit price of the product in cents per second.
+       */
+      unitPrice: number;
+    }
+  }
+
   /**
    * Latency tracking of the call, available after call ends. Not all fields here
    * will be available, as it depends on the type of call and feature used.
@@ -737,6 +791,11 @@ export interface WebCallResponse {
    */
   call_analysis?: WebCallResponse.CallAnalysis;
 
+  /**
+   * Cost of the call, including all the products and their costs and discount.
+   */
+  call_cost?: WebCallResponse.CallCost;
+
   /**
    * The reason for the disconnection of the call. Read details desciption about
    * reasons listed here at
@@ -876,6 +935,55 @@ export namespace WebCallResponse {
     user_sentiment?: 'Negative' | 'Positive' | 'Neutral' | 'Unknown';
   }
 
+  /**
+   * Cost of the call, including all the products and their costs and discount.
+   */
+  export interface CallCost {
+    /**
+     * Combined cost of all individual costs in cents
+     */
+    combined_cost: number;
+
+    /**
+     * List of products with their unit prices and costs in cents
+     */
+    product_costs: Array<CallCost.ProductCost>;
+
+    /**
+     * Total duration of the call in seconds
+     */
+    total_duration_seconds: number;
+
+    /**
+     * Total unit duration price of all products in cents per second
+     */
+    total_duration_unit_price: number;
+
+    /**
+     * Total one time price of all products in cents per call
+     */
+    total_one_time_price: number;
+  }
+
+  export namespace CallCost {
+    export interface ProductCost {
+      /**
+       * Cost for the product in cents for the duration of the call.
+       */
+      cost: number;
+
+      /**
+       * Product name that has a cost associated with it.
+       */
+      product: string;
+
+      /**
+       * Unit price of the product in cents per second.
+       */
+      unitPrice: number;
+    }
+  }
+
   /**
    * Latency tracking of the call, available after call ends. Not all fields here
    * will be available, as it depends on the type of call and feature used.
@@ -1354,29 +1462,111 @@ export interface CallListParams {
 export namespace CallListParams {
   export interface FilterCriteria {
     /**
-     * Inclusive. Filter calls that end on or after this timestamp.
+     * Only retrieve calls that are made with specific agent(s).
      */
-    after_end_timestamp?: number;
+    agent_id?: Array<string>;
 
     /**
-     * Inclusive. Filter calls that start on or after this timestamp.
+     * Only retrieve calls with specific call status(es).
      */
-    after_start_timestamp?: number;
+    call_status?: Array<'registered' | 'ongoing' | 'ended' | 'error'>;
 
     /**
-     * Only retrieve calls that are made with specific agent(s).
+     * Only retrieve calls with specific call successful(s).
      */
-    agent_id?: Array<string>;
+    call_successful?: Array<boolean>;
+
+    /**
+     * Only retrieve calls with specific call type(s).
+     */
+    call_type?: Array<'web_call' | 'phone_call'>;
+
+    /**
+     * Only retrieve calls with specific direction(s).
+     */
+    direction?: Array<'inbound' | 'outbound'>;
+
+    /**
+     * Only retrieve calls with specific disconnection reason(s).
+     */
+    disconnection_reason?: Array<
+      | 'user_hangup'
+      | 'agent_hangup'
+      | 'call_transfer'
+      | 'voicemail_reached'
+      | 'inactivity'
+      | 'machine_detected'
+      | 'max_duration_reached'
+      | 'concurrency_limit_reached'
+      | 'no_valid_payment'
+      | 'scam_detected'
+      | 'error_inbound_webhook'
+      | 'dial_busy'
+      | 'dial_failed'
+      | 'dial_no_answer'
+      | 'error_llm_websocket_open'
+      | 'error_llm_websocket_lost_connection'
+      | 'error_llm_websocket_runtime'
+      | 'error_llm_websocket_corrupt_payload'
+      | 'error_frontend_corrupted_payload'
+      | 'error_twilio'
+      | 'error_no_audio_received'
+      | 'error_asr'
+      | 'error_retell'
+      | 'error_unknown'
+      | 'error_user_not_joined'
+      | 'registered_call_timeout'
+    >;
 
     /**
-     * Exclusive. Filter calls that end before this timestamp.
+     * Only retrieve calls with specific range of duration(s).
      */
-    before_end_timestamp?: number;
+    duration_ms?: FilterCriteria.DurationMs;
 
     /**
-     * Exclusive. Filter calls that start before this timestamp.
+     * Only retrieve calls with specific from number(s).
      */
-    before_start_timestamp?: number;
+    from_number?: Array<string>;
+
+    /**
+     * Only retrieve calls that are in voicemail or not in voicemail.
+     */
+    in_voicemail?: Array<boolean>;
+
+    /**
+     * Only retrieve calls with specific range of start timestamp(s).
+     */
+    start_timestamp?: FilterCriteria.StartTimestamp;
+
+    /**
+     * Only retrieve calls with specific to number(s).
+     */
+    to_number?: Array<string>;
+
+    /**
+     * Only retrieve calls with specific user sentiment(s).
+     */
+    user_sentiment?: Array<'Negative' | 'Positive' | 'Neutral' | 'Unknown'>;
+  }
+
+  export namespace FilterCriteria {
+    /**
+     * Only retrieve calls with specific range of duration(s).
+     */
+    export interface DurationMs {
+      lower_threshold?: number;
+
+      upper_threshold?: number;
+    }
+
+    /**
+     * Only retrieve calls with specific range of start timestamp(s).
+     */
+    export interface StartTimestamp {
+      lower_threshold?: number;
+
+      upper_threshold?: number;
+    }
   }
 }
 

package/src/resources/llm.ts

@@ -104,7 +104,7 @@ export interface LlmResponse {
   /**
    * Select the underlying text LLM. If not set, would default to gpt-4o.
    */
-  model?: 'gpt-4o' | 'gpt-4o-mini' | 'claude-3.5-sonnet' | 'claude-3-haiku' | null;
+  model?: 'gpt-4o' | 'gpt-4o-mini' | 'claude-3.5-sonnet' | 'claude-3-haiku' | 'claude-3.5-haiku' | null;
 
   /**
    * If set, will control the randomness of the response. Value ranging from [0,1].
@@ -118,7 +118,7 @@ export interface LlmResponse {
    * Select the underlying speech to speech model. Can only set this or model, not
    * both.
    */
-  s2s_model?: 'gpt-4o-realtime' | null;
+  s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | null;
 
   /**
    * Name of the starting state. Required if states is not empty.
@@ -829,7 +829,7 @@ export interface LlmCreateParams {
   /**
    * Select the underlying text LLM. If not set, would default to gpt-4o.
    */
-  model?: 'gpt-4o' | 'gpt-4o-mini' | 'claude-3.5-sonnet' | 'claude-3-haiku' | null;
+  model?: 'gpt-4o' | 'gpt-4o-mini' | 'claude-3.5-sonnet' | 'claude-3-haiku' | 'claude-3.5-haiku' | null;
 
   /**
    * If set, will control the randomness of the response. Value ranging from [0,1].
@@ -843,7 +843,7 @@ export interface LlmCreateParams {
    * Select the underlying speech to speech model. Can only set this or model, not
    * both.
    */
-  s2s_model?: 'gpt-4o-realtime' | null;
+  s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | null;
 
   /**
    * Name of the starting state. Required if states is not empty.
@@ -1552,7 +1552,7 @@ export interface LlmUpdateParams {
   /**
    * Select the underlying text LLM. If not set, would default to gpt-4o.
    */
-  model?: 'gpt-4o' | 'gpt-4o-mini' | 'claude-3.5-sonnet' | 'claude-3-haiku' | null;
+  model?: 'gpt-4o' | 'gpt-4o-mini' | 'claude-3.5-sonnet' | 'claude-3-haiku' | 'claude-3.5-haiku' | null;
 
   /**
    * If set, will control the randomness of the response. Value ranging from [0,1].
@@ -1566,7 +1566,7 @@ export interface LlmUpdateParams {
    * Select the underlying speech to speech model. Can only set this or model, not
    * both.
    */
-  s2s_model?: 'gpt-4o-realtime' | null;
+  s2s_model?: 'gpt-4o-realtime' | 'gpt-4o-mini-realtime' | null;
 
   /**
    * Name of the starting state. Required if states is not empty.

package/src/version.ts

@@ -1 +1 @@
-export const VERSION = '4.10.0'; // x-release-please-version
+export const VERSION = '4.12.0'; // x-release-please-version

package/version.d.ts

@@ -1,2 +1,2 @@
-export declare const VERSION = "4.10.0";
+export declare const VERSION = "4.12.0";
 //# sourceMappingURL=version.d.ts.map

package/version.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
-exports.VERSION = '4.10.0'; // x-release-please-version
+exports.VERSION = '4.12.0'; // x-release-please-version
 //# sourceMappingURL=version.js.map

package/version.mjs

@@ -1,2 +1,2 @@
-export const VERSION = '4.10.0'; // x-release-please-version
+export const VERSION = '4.12.0'; // x-release-please-version
 //# sourceMappingURL=version.mjs.map