retell-sdk 5.21.0 → 5.23.0

package/resources/call.d.mts

@@ -1,4 +1,5 @@
 import { APIResource } from "../core/resource.mjs";
+import * as CallAPI from "./call.mjs";
 import { APIPromise } from "../core/api-promise.mjs";
 import { RequestOptions } from "../internal/request-options.mjs";
 export declare class Call extends APIResource {
@@ -32,11 +33,14 @@ export declare class Call extends APIResource {
      */
     update(callID: string, body: CallUpdateParams, options?: RequestOptions): APIPromise<CallResponse>;
     /**
-     * Retrieve call details
+     * List calls with unified cursor pagination response.
      *
-     * @deprecated
+     * @example
+     * ```ts
+     * const calls = await client.call.list();
+     * ```
      */
-    list(body: CallListParams, options?: RequestOptions): APIPromise<CallListResponse>;
+    list(body?: CallListParams | null | undefined, options?: RequestOptions): APIPromise<CallListResponse>;
     /**
      * Delete a specific call and its associated data
      *
@@ -1826,7 +1830,29 @@ export declare namespace WebCallResponse {
         role: 'dtmf';
     }
 }
-export type CallListResponse = Array<CallResponse>;
+export interface CallListResponse {
+    /**
+     * Whether more results are available.
+     */
+    has_more?: boolean;
+    items?: Array<CallListResponse.CallWebCallResponse | CallListResponse.CallPhoneCallResponse>;
+    /**
+     * Pagination key for the next page.
+     */
+    pagination_key?: string;
+}
+export declare namespace CallListResponse {
+    /**
+     * V3 list calls response. Transcript fields are intentionally omitted.
+     */
+    interface CallWebCallResponse extends CallAPI.WebCallResponse {
+    }
+    /**
+     * V3 list calls response. Transcript fields are intentionally omitted.
+     */
+    interface CallPhoneCallResponse extends CallAPI.PhoneCallResponse {
+    }
+}
 export interface CallUpdateParams {
     /**
      * Custom attributes for the call
@@ -1860,137 +1886,596 @@ export interface CallUpdateParams {
 }
 export interface CallListParams {
     /**
-     * Filter criteria for the calls to retrieve.
+     * Filter criteria for calls. All conditions are implicitly connected with AND.
      */
     filter_criteria?: CallListParams.FilterCriteria;
     /**
-     * Limit the number of calls returned. Default 50, Max 1000. To retrieve more than
-     * 1000, use pagination_key to continue fetching the next page.
+     * Maximum number of calls to return.
      */
     limit?: number;
     /**
-     * The pagination key to continue fetching the next page of calls. Pagination key
-     * is represented by a call id here, and it's exclusive (not included in the
-     * fetched calls). The last call id from the list calls is usually used as
-     * pagination key here. If not set, will start from the beginning.
+     * Opaque pagination cursor from a previous response.
      */
     pagination_key?: string;
     /**
-     * The calls will be sorted by `start_timestamp`, whether to return the calls in
-     * ascending or descending order.
+     * Number of records to skip for pagination.
+     */
+    skip?: number;
+    /**
+     * Sort calls by `start_timestamp` in ascending or descending order.
      */
     sort_order?: 'ascending' | 'descending';
 }
 export declare namespace CallListParams {
     /**
-     * Filter criteria for the calls to retrieve.
+     * Filter criteria for calls. All conditions are implicitly connected with AND.
      */
     interface FilterCriteria {
         /**
-         * Only retrieve calls that are made with specific agent(s).
+         * Filter by agent(s). Agent filters are connected by OR.
          */
-        agent_id?: Array<string>;
+        agent?: Array<FilterCriteria.Agent>;
         /**
-         * Only retrieve calls with specific batch call id(s).
+         * Filter by batch call ID.
          */
-        batch_call_id?: Array<string>;
+        batch_call_id?: FilterCriteria.BatchCallID;
         /**
-         * Only retrieve calls with specific call id(s).
+         * Filter by call ID.
          */
-        call_id?: Array<string>;
+        call_id?: FilterCriteria.CallID;
+        call_status?: FilterCriteria.CallStatus;
         /**
-         * Only retrieve calls with specific call status(es).
+         * Filter by whether the call was successful.
          */
-        call_status?: Array<'not_connected' | 'ongoing' | 'ended' | 'error'>;
+        call_successful?: FilterCriteria.CallSuccessful;
+        call_type?: FilterCriteria.CallType;
         /**
-         * Only retrieve calls with specific call successful(s).
+         * Filter by combined cost of the call.
          */
-        call_successful?: Array<boolean>;
+        combined_cost?: FilterCriteria.NumberFilter | FilterCriteria.RangeFilter;
         /**
-         * Only retrieve calls with specific call type(s).
+         * Filter by custom analysis data fields.
          */
-        call_type?: Array<'web_call' | 'phone_call'>;
+        custom_analysis_data?: Array<FilterCriteria.StringFilter | FilterCriteria.NumberFilter | FilterCriteria.BooleanFilter | FilterCriteria.RangeFilter | FilterCriteria.EnumFilter | FilterCriteria.PresentFilter>;
         /**
-         * Only retrieve calls with specific direction(s).
+         * Filter by custom attributes fields.
          */
-        direction?: Array<'inbound' | 'outbound'>;
+        custom_attributes?: Array<FilterCriteria.StringFilter | FilterCriteria.NumberFilter | FilterCriteria.BooleanFilter | FilterCriteria.RangeFilter | FilterCriteria.EnumFilter | FilterCriteria.PresentFilter>;
+        data_storage_setting?: FilterCriteria.DataStorageSetting;
+        direction?: FilterCriteria.Direction;
+        disconnection_reason?: FilterCriteria.DisconnectionReason;
         /**
-         * Only retrieve calls with specific disconnection reason(s).
+         * Filter by call duration in milliseconds.
          */
-        disconnection_reason?: Array<'user_hangup' | 'agent_hangup' | 'call_transfer' | 'voicemail_reached' | 'ivr_reached' | 'inactivity' | 'max_duration_reached' | 'concurrency_limit_reached' | 'no_valid_payment' | 'scam_detected' | 'dial_busy' | 'dial_failed' | 'dial_no_answer' | 'invalid_destination' | 'telephony_provider_permission_denied' | 'telephony_provider_unavailable' | 'sip_routing_error' | 'marked_as_spam' | 'user_declined' | 'error_llm_websocket_open' | 'error_llm_websocket_lost_connection' | 'error_llm_websocket_runtime' | 'error_llm_websocket_corrupt_payload' | 'error_no_audio_received' | 'error_asr' | 'error_retell' | 'error_unknown' | 'error_user_not_joined' | 'registered_call_timeout' | 'transfer_bridged' | 'transfer_cancelled' | 'manual_stopped'>;
+        duration_ms?: FilterCriteria.NumberFilter | FilterCriteria.RangeFilter;
         /**
-         * Only retrieve calls with specific range of duration(s).
+         * Filter by dynamic variables.
          */
-        duration_ms?: FilterCriteria.DurationMs;
+        dynamic_variables?: Array<FilterCriteria.DynamicVariable>;
         /**
-         * Filter by dynamic variables using dot notation (e.g., `dynamic_variables.name`).
-         * Values are matched exactly as strings.
+         * Filter by end-to-end latency p50.
          */
-        dynamic_variables?: {
-            [key: string]: Array<string>;
-        };
-        e2e_latency_p50?: FilterCriteria.E2ELatencyP50;
+        e2e_latency_p50?: FilterCriteria.NumberFilter | FilterCriteria.RangeFilter;
         /**
-         * Only retrieve calls with specific range of end timestamp(s).
+         * Filter by call end timestamp (epoch ms).
          */
-        end_timestamp?: FilterCriteria.EndTimestamp;
+        end_timestamp?: FilterCriteria.NumberFilter | FilterCriteria.RangeFilter;
         /**
-         * Only retrieve calls with specific from number(s).
+         * Filter by from number.
          */
-        from_number?: Array<string>;
+        from_number?: FilterCriteria.FromNumber;
         /**
-         * Only retrieve calls that are in voicemail or not in voicemail.
+         * Filter by whether the call is in voicemail.
          */
-        in_voicemail?: Array<boolean>;
+        in_voicemail?: FilterCriteria.InVoicemail;
         /**
-         * Filter by metadata fields using dot notation (e.g., `metadata.customer_id`).
-         * Values are matched exactly as strings.
+         * Filter by metadata fields.
          */
-        metadata?: {
-            [key: string]: Array<string>;
-        };
+        metadata?: Array<FilterCriteria.StringFilter | FilterCriteria.NumberFilter | FilterCriteria.BooleanFilter | FilterCriteria.RangeFilter | FilterCriteria.EnumFilter | FilterCriteria.PresentFilter>;
         /**
-         * Only retrieve calls with specific range of start timestamp(s).
+         * Filter by call start timestamp (epoch ms).
          */
-        start_timestamp?: FilterCriteria.StartTimestamp;
+        start_timestamp?: FilterCriteria.NumberFilter | FilterCriteria.RangeFilter;
         /**
-         * Only retrieve calls with specific to number(s).
+         * Filter by to number.
          */
-        to_number?: Array<string>;
+        to_number?: FilterCriteria.ToNumber;
         /**
-         * Only retrieve calls with specific user sentiment(s).
+         * Filter by tool call criteria. Tool call filters are connected by AND.
          */
-        user_sentiment?: Array<'Negative' | 'Positive' | 'Neutral' | 'Unknown'>;
-        /**
-         * The version of the agent to use for the call.
-         */
-        version?: Array<number>;
+        tool_calls?: Array<FilterCriteria.ToolCall>;
+        user_sentiment?: FilterCriteria.UserSentiment;
     }
     namespace FilterCriteria {
+        interface Agent {
+            /**
+             * The agent ID to filter on.
+             */
+            agent_id: string;
+            /**
+             * Specific versions to filter on. If not provided, all versions are included.
+             */
+            version?: Array<number>;
+        }
+        /**
+         * Filter by batch call ID.
+         */
+        interface BatchCallID {
+            /**
+             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
+             */
+            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
+            type: 'string';
+            value: string;
+        }
+        /**
+         * Filter by call ID.
+         */
+        interface CallID {
+            /**
+             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
+             */
+            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
+            type: 'string';
+            value: string;
+        }
+        interface CallStatus {
+            /**
+             * in: value is one of the listed values
+             */
+            op: 'in';
+            type: 'enum';
+            value: Array<'not_connected' | 'ongoing' | 'ended' | 'error'>;
+        }
         /**
-         * Only retrieve calls with specific range of duration(s).
+         * Filter by whether the call was successful.
          */
-        interface DurationMs {
-            lower_threshold?: number;
-            upper_threshold?: number;
+        interface CallSuccessful {
+            op: 'eq';
+            type: 'boolean';
+            value: boolean;
+        }
+        interface CallType {
+            /**
+             * in: value is one of the listed values
+             */
+            op: 'in';
+            type: 'enum';
+            value: Array<'web_call' | 'phone_call'>;
+        }
+        interface NumberFilter {
+            /**
+             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+             * than, le: less than or equal
+             */
+            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+            type: 'number';
+            value: number;
+        }
+        interface RangeFilter {
+            /**
+             * bt: between
+             */
+            op: 'bt';
+            type: 'range';
+            /**
+             * [lower_bound, upper_bound]
+             */
+            value: Array<number>;
+        }
+        interface StringFilter {
+            /**
+             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
+             */
+            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
+            type: 'string';
+            value: string;
+            /**
+             * The field name to filter on.
+             */
+            key?: string;
+        }
+        interface NumberFilter {
+            /**
+             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+             * than, le: less than or equal
+             */
+            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+            type: 'number';
+            value: number;
+            /**
+             * The field name to filter on.
+             */
+            key?: string;
+        }
+        interface BooleanFilter {
+            op: 'eq';
+            type: 'boolean';
+            value: boolean;
+            /**
+             * The field name to filter on.
+             */
+            key?: string;
+        }
+        interface RangeFilter {
+            /**
+             * bt: between
+             */
+            op: 'bt';
+            type: 'range';
+            /**
+             * [lower_bound, upper_bound]
+             */
+            value: Array<number>;
+            /**
+             * The field name to filter on.
+             */
+            key?: string;
+        }
+        interface EnumFilter {
+            /**
+             * in: value is one of the listed values
+             */
+            op: 'in';
+            type: 'enum';
+            value: Array<string>;
+            /**
+             * The field name to filter on.
+             */
+            key?: string;
+        }
+        interface PresentFilter {
+            /**
+             * pr: present (has value), np: not present
+             */
+            op: 'pr' | 'np';
+            type: 'present';
+            /**
+             * The field name to filter on.
+             */
+            key?: string;
+        }
+        interface StringFilter {
+            /**
+             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
+             */
+            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
+            type: 'string';
+            value: string;
+            /**
+             * The field name to filter on.
+             */
+            key?: string;
+        }
+        interface NumberFilter {
+            /**
+             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+             * than, le: less than or equal
+             */
+            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+            type: 'number';
+            value: number;
+            /**
+             * The field name to filter on.
+             */
+            key?: string;
+        }
+        interface BooleanFilter {
+            op: 'eq';
+            type: 'boolean';
+            value: boolean;
+            /**
+             * The field name to filter on.
+             */
+            key?: string;
+        }
+        interface RangeFilter {
+            /**
+             * bt: between
+             */
+            op: 'bt';
+            type: 'range';
+            /**
+             * [lower_bound, upper_bound]
+             */
+            value: Array<number>;
+            /**
+             * The field name to filter on.
+             */
+            key?: string;
+        }
+        interface EnumFilter {
+            /**
+             * in: value is one of the listed values
+             */
+            op: 'in';
+            type: 'enum';
+            value: Array<string>;
+            /**
+             * The field name to filter on.
+             */
+            key?: string;
+        }
+        interface PresentFilter {
+            /**
+             * pr: present (has value), np: not present
+             */
+            op: 'pr' | 'np';
+            type: 'present';
+            /**
+             * The field name to filter on.
+             */
+            key?: string;
+        }
+        interface DataStorageSetting {
+            /**
+             * in: value is one of the listed values
+             */
+            op: 'in';
+            type: 'enum';
+            value: Array<'everything' | 'everything_except_pii' | 'basic_attributes_only'>;
+        }
+        interface Direction {
+            /**
+             * in: value is one of the listed values
+             */
+            op: 'in';
+            type: 'enum';
+            value: Array<'inbound' | 'outbound'>;
+        }
+        interface DisconnectionReason {
+            /**
+             * in: value is one of the listed values
+             */
+            op: 'in';
+            type: 'enum';
+            value: Array<'user_hangup' | 'agent_hangup' | 'call_transfer' | 'voicemail_reached' | 'ivr_reached' | 'inactivity' | 'max_duration_reached' | 'concurrency_limit_reached' | 'no_valid_payment' | 'scam_detected' | 'dial_busy' | 'dial_failed' | 'dial_no_answer' | 'invalid_destination' | 'telephony_provider_permission_denied' | 'telephony_provider_unavailable' | 'sip_routing_error' | 'marked_as_spam' | 'user_declined' | 'error_llm_websocket_open' | 'error_llm_websocket_lost_connection' | 'error_llm_websocket_runtime' | 'error_llm_websocket_corrupt_payload' | 'error_no_audio_received' | 'error_asr' | 'error_retell' | 'error_unknown' | 'error_user_not_joined' | 'registered_call_timeout' | 'transfer_bridged' | 'transfer_cancelled' | 'manual_stopped'>;
+        }
+        interface NumberFilter {
+            /**
+             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+             * than, le: less than or equal
+             */
+            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+            type: 'number';
+            value: number;
+        }
+        interface RangeFilter {
+            /**
+             * bt: between
+             */
+            op: 'bt';
+            type: 'range';
+            /**
+             * [lower_bound, upper_bound]
+             */
+            value: Array<number>;
+        }
+        interface DynamicVariable {
+            /**
+             * The dynamic variable name to filter on.
+             */
+            key: string;
+            /**
+             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
+             */
+            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
+            type: 'string';
+            value: string;
+        }
+        interface NumberFilter {
+            /**
+             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+             * than, le: less than or equal
+             */
+            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+            type: 'number';
+            value: number;
         }
-        interface E2ELatencyP50 {
-            lower_threshold?: number;
-            upper_threshold?: number;
+        interface RangeFilter {
+            /**
+             * bt: between
+             */
+            op: 'bt';
+            type: 'range';
+            /**
+             * [lower_bound, upper_bound]
+             */
+            value: Array<number>;
+        }
+        interface NumberFilter {
+            /**
+             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+             * than, le: less than or equal
+             */
+            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+            type: 'number';
+            value: number;
+        }
+        interface RangeFilter {
+            /**
+             * bt: between
+             */
+            op: 'bt';
+            type: 'range';
+            /**
+             * [lower_bound, upper_bound]
+             */
+            value: Array<number>;
         }
         /**
-         * Only retrieve calls with specific range of end timestamp(s).
+         * Filter by from number.
          */
-        interface EndTimestamp {
-            lower_threshold?: number;
-            upper_threshold?: number;
+        interface FromNumber {
+            /**
+             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
+             */
+            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
+            type: 'string';
+            value: string;
+        }
+        /**
+         * Filter by whether the call is in voicemail.
+         */
+        interface InVoicemail {
+            op: 'eq';
+            type: 'boolean';
+            value: boolean;
+        }
+        interface StringFilter {
+            /**
+             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
+             */
+            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
+            type: 'string';
+            value: string;
+            /**
+             * The field name to filter on.
+             */
+            key?: string;
+        }
+        interface NumberFilter {
+            /**
+             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+             * than, le: less than or equal
+             */
+            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+            type: 'number';
+            value: number;
+            /**
+             * The field name to filter on.
+             */
+            key?: string;
+        }
+        interface BooleanFilter {
+            op: 'eq';
+            type: 'boolean';
+            value: boolean;
+            /**
+             * The field name to filter on.
+             */
+            key?: string;
+        }
+        interface RangeFilter {
+            /**
+             * bt: between
+             */
+            op: 'bt';
+            type: 'range';
+            /**
+             * [lower_bound, upper_bound]
+             */
+            value: Array<number>;
+            /**
+             * The field name to filter on.
+             */
+            key?: string;
+        }
+        interface EnumFilter {
+            /**
+             * in: value is one of the listed values
+             */
+            op: 'in';
+            type: 'enum';
+            value: Array<string>;
+            /**
+             * The field name to filter on.
+             */
+            key?: string;
+        }
+        interface PresentFilter {
+            /**
+             * pr: present (has value), np: not present
+             */
+            op: 'pr' | 'np';
+            type: 'present';
+            /**
+             * The field name to filter on.
+             */
+            key?: string;
+        }
+        interface NumberFilter {
+            /**
+             * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+             * than, le: less than or equal
+             */
+            op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+            type: 'number';
+            value: number;
+        }
+        interface RangeFilter {
+            /**
+             * bt: between
+             */
+            op: 'bt';
+            type: 'range';
+            /**
+             * [lower_bound, upper_bound]
+             */
+            value: Array<number>;
         }
         /**
-         * Only retrieve calls with specific range of start timestamp(s).
+         * Filter by to number.
          */
-        interface StartTimestamp {
-            lower_threshold?: number;
-            upper_threshold?: number;
+        interface ToNumber {
+            /**
+             * eq: equal, ne: not equal, sw: starts with, ew: ends with, co: contains
+             */
+            op: 'eq' | 'ne' | 'sw' | 'ew' | 'co';
+            type: 'string';
+            value: string;
+        }
+        interface ToolCall {
+            /**
+             * The tool call name to filter on.
+             */
+            name: string;
+            /**
+             * Filter by tool call latency in milliseconds.
+             */
+            latency_ms?: ToolCall.NumberFilter | ToolCall.RangeFilter;
+            /**
+             * Filter by tool call success status.
+             */
+            success?: ToolCall.Success;
+        }
+        namespace ToolCall {
+            interface NumberFilter {
+                /**
+                 * eq: equal, ne: not equal, gt: greater than, ge: greater than or equal, lt: less
+                 * than, le: less than or equal
+                 */
+                op: 'eq' | 'ne' | 'gt' | 'ge' | 'lt' | 'le';
+                type: 'number';
+                value: number;
+            }
+            interface RangeFilter {
+                /**
+                 * bt: between
+                 */
+                op: 'bt';
+                type: 'range';
+                /**
+                 * [lower_bound, upper_bound]
+                 */
+                value: Array<number>;
+            }
+            /**
+             * Filter by tool call success status.
+             */
+            interface Success {
+                op: 'eq';
+                type: 'boolean';
+                value: boolean;
+            }
+        }
+        interface UserSentiment {
+            /**
+             * in: value is one of the listed values
+             */
+            op: 'in';
+            type: 'enum';
+            value: Array<'Negative' | 'Positive' | 'Neutral' | 'Unknown'>;
         }
     }
 }