retell-sdk 5.11.0 → 5.13.0

package/src/resources/chat.ts

@@ -187,11 +187,11 @@ export interface ChatResponse {
    * Transcript of the chat weaved with tool call invocation and results.
    */
   message_with_tool_calls?: Array<
-    | ChatResponse.Message
-    | ChatResponse.ToolCallInvocationMessage
-    | ChatResponse.ToolCallResultMessage
-    | ChatResponse.NodeTransitionMessage
-    | ChatResponse.StateTransitionMessage
+    | ChatResponse.MessageBase
+    | ChatResponse.ToolCallInvocationMessageBase
+    | ChatResponse.ToolCallResultMessageBase
+    | ChatResponse.NodeTransitionMessageBase
+    | ChatResponse.StateTransitionMessageBase
   >;
 
   /**
@@ -291,39 +291,34 @@ export namespace ChatResponse {
     }
   }
 
-  export interface Message {
+  export interface MessageBase {
     /**
      * Content of the message
      */
     content: string;
 
     /**
-     * Create timestamp of the message
+     * Documents whether this message is sent by agent or user.
      */
-    created_timestamp: number;
+    role: 'agent' | 'user';
 
     /**
-     * Unique id of the message
+     * Create timestamp of the message
      */
-    message_id: string;
+    created_timestamp?: number;
 
     /**
-     * Documents whether this message is sent by agent or user.
+     * Unique id of the message
      */
-    role: 'agent' | 'user';
+    message_id?: string;
   }
 
-  export interface ToolCallInvocationMessage {
+  export interface ToolCallInvocationMessageBase {
     /**
      * Arguments for this tool call, it's a stringified JSON object.
      */
     arguments: string;
 
-    /**
-     * Unique id of the message
-     */
-    message_id: string;
-
     /**
      * Name of the function in this tool call.
      */
@@ -344,6 +339,11 @@ export namespace ChatResponse {
      */
     created_timestamp?: number;
 
+    /**
+     * Unique id of the message
+     */
+    message_id?: string;
+
     /**
      * Optional thought signature from Google Gemini thinking models. This is used
      * internally to maintain reasoning chain in multi-turn function calling.
@@ -351,22 +351,12 @@ export namespace ChatResponse {
     thought_signature?: string;
   }
 
-  export interface ToolCallResultMessage {
+  export interface ToolCallResultMessageBase {
     /**
      * Result of the tool call, can be a string, a stringified json, etc.
      */
     content: string;
 
-    /**
-     * Create timestamp of the message
-     */
-    created_timestamp: number;
-
-    /**
-     * Unique id of the message
-     */
-    message_id: string;
-
     /**
      * This is the result of a tool call.
      */
@@ -378,27 +368,32 @@ export namespace ChatResponse {
     tool_call_id: string;
 
     /**
-     * Whether the tool call was successful.
+     * Create timestamp of the message
      */
-    successful?: boolean;
-  }
+    created_timestamp?: number;
 
-  export interface NodeTransitionMessage {
     /**
-     * Create timestamp of the message
+     * Unique id of the message
      */
-    created_timestamp: number;
+    message_id?: string;
 
     /**
-     * Unique id of the message
+     * Whether the tool call was successful.
      */
-    message_id: string;
+    successful?: boolean;
+  }
 
+  export interface NodeTransitionMessageBase {
     /**
      * This is a node transition.
      */
     role: 'node_transition';
 
+    /**
+     * Create timestamp of the message
+     */
+    created_timestamp?: number;
+
     /**
      * Former node id
      */
@@ -409,6 +404,11 @@ export namespace ChatResponse {
      */
     former_node_name?: string;
 
+    /**
+     * Unique id of the message
+     */
+    message_id?: string;
+
     /**
      * New node id
      */
@@ -418,29 +418,37 @@ export namespace ChatResponse {
      * New node name
      */
     new_node_name?: string;
-  }
 
-  export interface StateTransitionMessage {
     /**
-     * Create timestamp of the message
+     * How this node was reached. "global" means a global node transition,
+     * "global_go_back" means returning from a global node, "interrupt_go_back" means
+     * going back due to user interruption, and "normal" means a regular edge
+     * transition.
      */
-    created_timestamp: number;
+    transition_type?: 'global' | 'global_go_back' | 'interrupt_go_back' | 'normal';
+  }
 
+  export interface StateTransitionMessageBase {
     /**
-     * Unique id of the message
+     * This is a state transition.
      */
-    message_id: string;
+    role: 'state_transition';
 
     /**
-     * This is a state transition.
+     * Create timestamp of the message
      */
-    role: 'state_transition';
+    created_timestamp?: number;
 
     /**
      * Former state name
      */
     former_state_name?: string;
 
+    /**
+     * Unique id of the message
+     */
+    message_id?: string;
+
     /**
      * New state name
      */
@@ -457,48 +465,43 @@ export interface ChatCreateChatCompletionResponse {
    * messages.
    */
   messages: Array<
-    | ChatCreateChatCompletionResponse.Message
-    | ChatCreateChatCompletionResponse.ToolCallInvocationMessage
-    | ChatCreateChatCompletionResponse.ToolCallResultMessage
-    | ChatCreateChatCompletionResponse.NodeTransitionMessage
-    | ChatCreateChatCompletionResponse.StateTransitionMessage
+    | ChatCreateChatCompletionResponse.MessageBase
+    | ChatCreateChatCompletionResponse.ToolCallInvocationMessageBase
+    | ChatCreateChatCompletionResponse.ToolCallResultMessageBase
+    | ChatCreateChatCompletionResponse.NodeTransitionMessageBase
+    | ChatCreateChatCompletionResponse.StateTransitionMessageBase
   >;
 }
 
 export namespace ChatCreateChatCompletionResponse {
-  export interface Message {
+  export interface MessageBase {
     /**
      * Content of the message
      */
     content: string;
 
     /**
-     * Create timestamp of the message
+     * Documents whether this message is sent by agent or user.
      */
-    created_timestamp: number;
+    role: 'agent' | 'user';
 
     /**
-     * Unique id of the message
+     * Create timestamp of the message
      */
-    message_id: string;
+    created_timestamp?: number;
 
     /**
-     * Documents whether this message is sent by agent or user.
+     * Unique id of the message
      */
-    role: 'agent' | 'user';
+    message_id?: string;
   }
 
-  export interface ToolCallInvocationMessage {
+  export interface ToolCallInvocationMessageBase {
     /**
      * Arguments for this tool call, it's a stringified JSON object.
      */
     arguments: string;
 
-    /**
-     * Unique id of the message
-     */
-    message_id: string;
-
     /**
      * Name of the function in this tool call.
      */
@@ -519,6 +522,11 @@ export namespace ChatCreateChatCompletionResponse {
      */
     created_timestamp?: number;
 
+    /**
+     * Unique id of the message
+     */
+    message_id?: string;
+
     /**
      * Optional thought signature from Google Gemini thinking models. This is used
      * internally to maintain reasoning chain in multi-turn function calling.
@@ -526,22 +534,12 @@ export namespace ChatCreateChatCompletionResponse {
     thought_signature?: string;
   }
 
-  export interface ToolCallResultMessage {
+  export interface ToolCallResultMessageBase {
     /**
      * Result of the tool call, can be a string, a stringified json, etc.
      */
     content: string;
 
-    /**
-     * Create timestamp of the message
-     */
-    created_timestamp: number;
-
-    /**
-     * Unique id of the message
-     */
-    message_id: string;
-
     /**
      * This is the result of a tool call.
      */
@@ -553,27 +551,32 @@ export namespace ChatCreateChatCompletionResponse {
     tool_call_id: string;
 
     /**
-     * Whether the tool call was successful.
+     * Create timestamp of the message
      */
-    successful?: boolean;
-  }
+    created_timestamp?: number;
 
-  export interface NodeTransitionMessage {
     /**
-     * Create timestamp of the message
+     * Unique id of the message
      */
-    created_timestamp: number;
+    message_id?: string;
 
     /**
-     * Unique id of the message
+     * Whether the tool call was successful.
      */
-    message_id: string;
+    successful?: boolean;
+  }
 
+  export interface NodeTransitionMessageBase {
     /**
      * This is a node transition.
      */
     role: 'node_transition';
 
+    /**
+     * Create timestamp of the message
+     */
+    created_timestamp?: number;
+
     /**
      * Former node id
      */
@@ -584,6 +587,11 @@ export namespace ChatCreateChatCompletionResponse {
      */
     former_node_name?: string;
 
+    /**
+     * Unique id of the message
+     */
+    message_id?: string;
+
     /**
      * New node id
      */
@@ -593,29 +601,37 @@ export namespace ChatCreateChatCompletionResponse {
      * New node name
      */
     new_node_name?: string;
-  }
 
-  export interface StateTransitionMessage {
     /**
-     * Create timestamp of the message
+     * How this node was reached. "global" means a global node transition,
+     * "global_go_back" means returning from a global node, "interrupt_go_back" means
+     * going back due to user interruption, and "normal" means a regular edge
+     * transition.
      */
-    created_timestamp: number;
+    transition_type?: 'global' | 'global_go_back' | 'interrupt_go_back' | 'normal';
+  }
 
+  export interface StateTransitionMessageBase {
     /**
-     * Unique id of the message
+     * This is a state transition.
      */
-    message_id: string;
+    role: 'state_transition';
 
     /**
-     * This is a state transition.
+     * Create timestamp of the message
      */
-    role: 'state_transition';
+    created_timestamp?: number;
 
     /**
      * Former state name
      */
     former_state_name?: string;
 
+    /**
+     * Unique id of the message
+     */
+    message_id?: string;
+
     /**
      * New state name
      */