telnyx 5.170.0 → 5.171.0

data/rbi/telnyx/models/ai/inference_embedding.rbi

@@ -49,6 +49,18 @@ module Telnyx
         end
         attr_writer :a2a_agents
 
+        # **Beta:** Configuration for the Telnyx open-source avatar provider. The launch
+        # catalog supports six avatars and office, studio, or reception backgrounds.
+        sig { returns(T.nilable(Telnyx::AI::TelnyxAvatarSettings)) }
+        attr_reader :avatar_settings
+
+        sig do
+          params(
+            avatar_settings: T.nilable(Telnyx::AI::TelnyxAvatarSettings::OrHash)
+          ).void
+        end
+        attr_writer :avatar_settings
+
         # Conversation flow as returned by the API.
         sig { returns(T.nilable(Telnyx::AI::ConversationFlow)) }
         attr_reader :conversation_flow
@@ -58,6 +70,23 @@ module Telnyx
         end
         attr_writer :conversation_flow
 
+        # Splits the conversation between a frontend model that talks to the caller and a
+        # backend model that does the work. On the GPT-Live route the frontend model
+        # cannot call tools at all — when it needs something done it raises a delegation
+        # and waits. On the chat completion route the frontend keeps a single `delegate`
+        # tool that returns immediately, so the conversation carries on while the backend
+        # works. Either way the backend's answer is spoken as commentary or kept as silent
+        # context, depending on `speak_results`. Beta feature.
+        sig { returns(T.nilable(Telnyx::AI::DelegationSettings)) }
+        attr_reader :delegation_settings
+
+        sig do
+          params(
+            delegation_settings: Telnyx::AI::DelegationSettings::OrHash
+          ).void
+        end
+        attr_writer :delegation_settings
+
         sig { returns(T.nilable(String)) }
         attr_reader :description
 
@@ -344,6 +373,19 @@ module Telnyx
         end
         attr_writer :voice_settings
 
+        # Streams conversation and telephony events to a WebSocket server you host, and
+        # accepts messages injected back into the conversation. Telnyx opens the
+        # connection as a client, once per conversation. Delivery is best effort
+        # throughout: while the connection is down events are dropped rather than queued,
+        # and no socket failure is ever allowed to affect the call. Beta feature.
+        sig { returns(T.nilable(Telnyx::AI::WebsocketSettings)) }
+        attr_reader :websocket_settings
+
+        sig do
+          params(websocket_settings: Telnyx::AI::WebsocketSettings::OrHash).void
+        end
+        attr_writer :websocket_settings
+
         # Configuration settings for the assistant's web widget.
         sig { returns(T.nilable(Telnyx::AI::WidgetSettings)) }
         attr_reader :widget_settings
@@ -359,7 +401,10 @@ module Telnyx
             model: String,
             name: String,
             a2a_agents: T::Array[Telnyx::AI::AssistantA2AAgent::OrHash],
+            avatar_settings:
+              T.nilable(Telnyx::AI::TelnyxAvatarSettings::OrHash),
             conversation_flow: Telnyx::AI::ConversationFlow::OrHash,
+            delegation_settings: Telnyx::AI::DelegationSettings::OrHash,
             description: String,
             dynamic_variables: T::Hash[Symbol, T.anything],
             dynamic_variables_webhook_timeout_ms: Integer,
@@ -407,6 +452,7 @@ module Telnyx
             version_id: String,
             version_name: String,
             voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings::OrHash,
+            websocket_settings: Telnyx::AI::WebsocketSettings::OrHash,
             widget_settings: Telnyx::AI::WidgetSettings::OrHash
           ).returns(T.attached_class)
         end
@@ -432,8 +478,19 @@ module Telnyx
           # fetches combined. An agent whose card cannot be fetched costs the assistant that
           # capability for the conversation; it does not fail the call.
           a2a_agents: nil,
+          # **Beta:** Configuration for the Telnyx open-source avatar provider. The launch
+          # catalog supports six avatars and office, studio, or reception backgrounds.
+          avatar_settings: nil,
           # Conversation flow as returned by the API.
           conversation_flow: nil,
+          # Splits the conversation between a frontend model that talks to the caller and a
+          # backend model that does the work. On the GPT-Live route the frontend model
+          # cannot call tools at all — when it needs something done it raises a delegation
+          # and waits. On the chat completion route the frontend keeps a single `delegate`
+          # tool that returns immediately, so the conversation carries on while the backend
+          # works. Either way the backend's answer is spoken as commentary or kept as silent
+          # context, depending on `speak_results`. Beta feature.
+          delegation_settings: nil,
           description: nil,
           # Map of dynamic variables and their values
           dynamic_variables: nil,
@@ -517,6 +574,12 @@ module Telnyx
           # Human-readable name for the assistant version.
           version_name: nil,
           voice_settings: nil,
+          # Streams conversation and telephony events to a WebSocket server you host, and
+          # accepts messages injected back into the conversation. Telnyx opens the
+          # connection as a client, once per conversation. Delivery is best effort
+          # throughout: while the connection is down events are dropped rather than queued,
+          # and no socket failure is ever allowed to affect the call. Beta feature.
+          websocket_settings: nil,
           # Configuration settings for the assistant's web widget.
           widget_settings: nil
         )
@@ -531,7 +594,9 @@ module Telnyx
               model: String,
               name: String,
               a2a_agents: T::Array[Telnyx::AI::AssistantA2AAgent],
+              avatar_settings: T.nilable(Telnyx::AI::TelnyxAvatarSettings),
               conversation_flow: Telnyx::AI::ConversationFlow,
+              delegation_settings: Telnyx::AI::DelegationSettings,
               description: String,
               dynamic_variables: T::Hash[Symbol, T.anything],
               dynamic_variables_webhook_timeout_ms: Integer,
@@ -561,6 +626,7 @@ module Telnyx
               version_id: String,
               version_name: String,
               voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings,
+              websocket_settings: Telnyx::AI::WebsocketSettings,
               widget_settings: Telnyx::AI::WidgetSettings
             }
           )

data/rbi/telnyx/models/ai/inference_embedding_voice_settings.rbi

@@ -121,6 +121,22 @@ module Telnyx
         sig { params(temperature: Float).void }
         attr_writer :temperature
 
+        # Optional sound played to the caller while the assistant runs a tool (for example
+        # a webhook or MCP tool). It replaces the background audio until the tool
+        # responds, then the background audio resumes. Defaults to null, which plays no
+        # sound; send `null` on update to clear it. Not played in conference calls.
+        sig do
+          returns(
+            T.nilable(
+              T.any(
+                Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0,
+                Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember1
+              )
+            )
+          )
+        end
+        attr_accessor :tool_call_audio
+
         # Amplifies similarity to the original speaker voice. Increases computational load
         # and latency slightly. Only applicable when using ElevenLabs.
         sig { returns(T.nilable(T::Boolean)) }
@@ -129,9 +145,10 @@ module Telnyx
         sig { params(use_speaker_boost: T::Boolean).void }
         attr_writer :use_speaker_boost
 
-        # The speed of the voice in the range [0.25, 2.0]. 1.0 is deafult speed. Larger
-        # numbers make the voice faster, smaller numbers make it slower. This is only
-        # applicable for Telnyx Natural voices and Soniox voices (0.7 to 1.3 for Soniox).
+        # The speed of the voice in the range [0.6, 1.5]. 1.0 is the default speed. Larger
+        # numbers make the voice faster, smaller numbers make it slower. Applies to Telnyx
+        # `Ultra` voices; values outside this range are rejected by the synthesis engine.
+        # Soniox voices support a speed range of 0.7 to 1.3.
         sig { returns(T.nilable(Float)) }
         attr_reader :voice_speed
 
@@ -157,6 +174,13 @@ module Telnyx
             speed: Float,
             style: Float,
             temperature: Float,
+            tool_call_audio:
+              T.nilable(
+                T.any(
+                  Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0::OrHash,
+                  Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember1::OrHash
+                )
+              ),
             use_speaker_boost: T::Boolean,
             voice_speed: Float
           ).returns(T.attached_class)
@@ -207,12 +231,18 @@ module Telnyx
           # Lower values create a broader emotional range; higher values produce more
           # consistent, monotonous output. Only applicable when using ElevenLabs.
           temperature: nil,
+          # Optional sound played to the caller while the assistant runs a tool (for example
+          # a webhook or MCP tool). It replaces the background audio until the tool
+          # responds, then the background audio resumes. Defaults to null, which plays no
+          # sound; send `null` on update to clear it. Not played in conference calls.
+          tool_call_audio: nil,
           # Amplifies similarity to the original speaker voice. Increases computational load
           # and latency slightly. Only applicable when using ElevenLabs.
           use_speaker_boost: nil,
-          # The speed of the voice in the range [0.25, 2.0]. 1.0 is deafult speed. Larger
-          # numbers make the voice faster, smaller numbers make it slower. This is only
-          # applicable for Telnyx Natural voices and Soniox voices (0.7 to 1.3 for Soniox).
+          # The speed of the voice in the range [0.6, 1.5]. 1.0 is the default speed. Larger
+          # numbers make the voice faster, smaller numbers make it slower. Applies to Telnyx
+          # `Ultra` voices; values outside this range are rejected by the synthesis engine.
+          # Soniox voices support a speed range of 0.7 to 1.3.
           voice_speed: nil
         )
         end
@@ -237,6 +267,13 @@ module Telnyx
               speed: Float,
               style: Float,
               temperature: Float,
+              tool_call_audio:
+                T.nilable(
+                  T.any(
+                    Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0,
+                    Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember1
+                  )
+                ),
               use_speaker_boost: T::Boolean,
               voice_speed: Float
             }
@@ -797,6 +834,239 @@ module Telnyx
           def self.values
           end
         end
+
+        # Optional sound played to the caller while the assistant runs a tool (for example
+        # a webhook or MCP tool). It replaces the background audio until the tool
+        # responds, then the background audio resumes. Defaults to null, which plays no
+        # sound; send `null` on update to clear it. Not played in conference calls.
+        module ToolCallAudio
+          extend Telnyx::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0,
+                Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember1
+              )
+            end
+
+          class UnionMember0 < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # Select from predefined media options.
+            sig do
+              returns(
+                Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0::Type::OrSymbol
+              )
+            end
+            attr_accessor :type
+
+            # The predefined media to use. `typing` plays a keyboard typing sound.
+            sig do
+              returns(
+                Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0::Value::OrSymbol
+              )
+            end
+            attr_accessor :value
+
+            # Volume level for the predefined media. Supports values from 0.0 to 1.0 in 0.1
+            # increments. `0.0` plays no sound.
+            sig { returns(T.nilable(Float)) }
+            attr_reader :volume
+
+            sig { params(volume: Float).void }
+            attr_writer :volume
+
+            sig do
+              params(
+                type:
+                  Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0::Type::OrSymbol,
+                value:
+                  Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0::Value::OrSymbol,
+                volume: Float
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Select from predefined media options.
+              type:,
+              # The predefined media to use. `typing` plays a keyboard typing sound.
+              value:,
+              # Volume level for the predefined media. Supports values from 0.0 to 1.0 in 0.1
+              # increments. `0.0` plays no sound.
+              volume: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  type:
+                    Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0::Type::OrSymbol,
+                  value:
+                    Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0::Value::OrSymbol,
+                  volume: Float
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # Select from predefined media options.
+            module Type
+              extend Telnyx::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0::Type
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              PREDEFINED_MEDIA =
+                T.let(
+                  :predefined_media,
+                  Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0::Type::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0::Type::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+
+            # The predefined media to use. `typing` plays a keyboard typing sound.
+            module Value
+              extend Telnyx::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0::Value
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              TYPING =
+                T.let(
+                  :typing,
+                  Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0::Value::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0::Value::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+
+          class UnionMember1 < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember1,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # Provide a direct URL to an MP3 file. The audio loops while the tool runs.
+            sig do
+              returns(
+                Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember1::Type::OrSymbol
+              )
+            end
+            attr_accessor :type
+
+            # HTTPS URL to an MP3 file.
+            sig { returns(String) }
+            attr_accessor :value
+
+            sig do
+              params(
+                type:
+                  Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember1::Type::OrSymbol,
+                value: String
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Provide a direct URL to an MP3 file. The audio loops while the tool runs.
+              type:,
+              # HTTPS URL to an MP3 file.
+              value:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  type:
+                    Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember1::Type::OrSymbol,
+                  value: String
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # Provide a direct URL to an MP3 file. The audio loops while the tool runs.
+            module Type
+              extend Telnyx::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember1::Type
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              MEDIA_URL =
+                T.let(
+                  :media_url,
+                  Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember1::Type::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember1::Type::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
       end
     end
   end

data/rbi/telnyx/models/ai/memory/namespace.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        class Namespace < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(Telnyx::AI::Memory::Namespace, Telnyx::Internal::AnyHash)
+            end
+
+          # The namespace's unique identifier.
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The namespace's name, used in the path. `default` exists for every organization.
+          sig { returns(String) }
+          attr_accessor :name
+
+          # An isolated memory store within your organization.
+          sig { params(id: String, name: String).returns(T.attached_class) }
+          def self.new(
+            # The namespace's unique identifier.
+            id:,
+            # The namespace's name, used in the path. `default` exists for every organization.
+            name:
+          )
+          end
+
+          sig { override.returns({ id: String, name: String }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/memory/namespace_create_params.rbi

@@ -0,0 +1,47 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        class NamespaceCreateParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::AI::Memory::NamespaceCreateParams,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # A name for the new namespace, unique within your organization.
+          sig { returns(String) }
+          attr_accessor :name
+
+          sig do
+            params(
+              name: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # A name for the new namespace, unique within your organization.
+            name:,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              { name: String, request_options: Telnyx::RequestOptions }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/memory/namespace_create_response.rbi

@@ -0,0 +1,41 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        class NamespaceCreateResponse < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::AI::Memory::NamespaceCreateResponse,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # An isolated memory store within your organization.
+          sig { returns(Telnyx::AI::Memory::Namespace) }
+          attr_reader :data
+
+          sig { params(data: Telnyx::AI::Memory::Namespace::OrHash).void }
+          attr_writer :data
+
+          sig do
+            params(data: Telnyx::AI::Memory::Namespace::OrHash).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            # An isolated memory store within your organization.
+            data:
+          )
+          end
+
+          sig { override.returns({ data: Telnyx::AI::Memory::Namespace }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/memory/namespace_delete_params.rbi

@@ -0,0 +1,47 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        class NamespaceDeleteParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::AI::Memory::NamespaceDeleteParams,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # The namespace to delete. `default` cannot be deleted.
+          sig { returns(String) }
+          attr_accessor :namespace
+
+          sig do
+            params(
+              namespace: String,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The namespace to delete. `default` cannot be deleted.
+            namespace:,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              { namespace: String, request_options: Telnyx::RequestOptions }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/memory/namespace_list_params.rbi

@@ -0,0 +1,34 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        class NamespaceListParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::AI::Memory::NamespaceListParams,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig do
+            params(request_options: Telnyx::RequestOptions::OrHash).returns(
+              T.attached_class
+            )
+          end
+          def self.new(request_options: {})
+          end
+
+          sig { override.returns({ request_options: Telnyx::RequestOptions }) }
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end