telnyx 5.170.0 → 5.171.0

data/lib/telnyx/models/ai/inference_embedding_voice_settings.rb

@@ -87,6 +87,17 @@ module Telnyx
         #   @return [Float, nil]
         optional :temperature, Float
 
+        # @!attribute tool_call_audio
+        #   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.
+        #
+        #   @return [Telnyx::Models::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0, Telnyx::Models::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember1, nil]
+        optional :tool_call_audio,
+                 union: -> { Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio },
+                 nil?: true
+
         # @!attribute use_speaker_boost
         #   Amplifies similarity to the original speaker voice. Increases computational load
         #   and latency slightly. Only applicable when using ElevenLabs.
@@ -95,14 +106,15 @@ module Telnyx
         optional :use_speaker_boost, Telnyx::Internal::Type::Boolean
 
         # @!attribute voice_speed
-        #   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.
         #
         #   @return [Float, nil]
         optional :voice_speed, Float
 
-        # @!method initialize(voice:, api_key_ref: nil, background_audio: nil, expressive_mode: nil, language_boost: nil, similarity_boost: nil, speed: nil, style: nil, temperature: nil, use_speaker_boost: nil, voice_speed: nil)
+        # @!method initialize(voice:, api_key_ref: nil, background_audio: nil, expressive_mode: nil, language_boost: nil, similarity_boost: nil, speed: nil, style: nil, temperature: nil, tool_call_audio: nil, use_speaker_boost: nil, voice_speed: nil)
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::AI::InferenceEmbeddingVoiceSettings} for more details.
         #
@@ -124,9 +136,11 @@ module Telnyx
         #
         #   @param temperature [Float] Determines how stable the voice is and the randomness between each generation. L
         #
+        #   @param tool_call_audio [Telnyx::Models::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0, Telnyx::Models::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember1, nil] Optional sound played to the caller while the assistant runs a tool (for example
+        #
         #   @param use_speaker_boost [Boolean] Amplifies similarity to the original speaker voice. Increases computational load
         #
-        #   @param voice_speed [Float] The speed of the voice in the range [0.25, 2.0]. 1.0 is deafult speed. Larger nu
+        #   @param voice_speed [Float] The speed of the voice in the range [0.6, 1.5]. 1.0 is the default speed. Larger
 
         # Optional background audio to play on the call. Use a predefined media bed, or
         # supply a looped MP3 URL. If a media URL is chosen in the portal, customers can
@@ -328,6 +342,113 @@ module Telnyx
           # @!method self.values
           #   @return [Array<Symbol>]
         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.
+        #
+        # @see Telnyx::Models::AI::InferenceEmbeddingVoiceSettings#tool_call_audio
+        module ToolCallAudio
+          extend Telnyx::Internal::Type::Union
+
+          variant -> { Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0 }
+
+          variant -> { Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember1 }
+
+          class UnionMember0 < Telnyx::Internal::Type::BaseModel
+            # @!attribute type
+            #   Select from predefined media options.
+            #
+            #   @return [Symbol, Telnyx::Models::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0::Type]
+            required :type,
+                     enum: -> { Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0::Type }
+
+            # @!attribute value
+            #   The predefined media to use. `typing` plays a keyboard typing sound.
+            #
+            #   @return [Symbol, Telnyx::Models::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0::Value]
+            required :value,
+                     enum: -> { Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0::Value }
+
+            # @!attribute volume
+            #   Volume level for the predefined media. Supports values from 0.0 to 1.0 in 0.1
+            #   increments. `0.0` plays no sound.
+            #
+            #   @return [Float, nil]
+            optional :volume, Float
+
+            # @!method initialize(type:, value:, volume: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0}
+            #   for more details.
+            #
+            #   @param type [Symbol, Telnyx::Models::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0::Type] Select from predefined media options.
+            #
+            #   @param value [Symbol, Telnyx::Models::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0::Value] The predefined media to use. `typing` plays a keyboard typing sound.
+            #
+            #   @param volume [Float] Volume level for the predefined media. Supports values from 0.0 to 1.0 in 0.1 in
+
+            # Select from predefined media options.
+            #
+            # @see Telnyx::Models::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0#type
+            module Type
+              extend Telnyx::Internal::Type::Enum
+
+              PREDEFINED_MEDIA = :predefined_media
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+
+            # The predefined media to use. `typing` plays a keyboard typing sound.
+            #
+            # @see Telnyx::Models::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0#value
+            module Value
+              extend Telnyx::Internal::Type::Enum
+
+              TYPING = :typing
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          class UnionMember1 < Telnyx::Internal::Type::BaseModel
+            # @!attribute type
+            #   Provide a direct URL to an MP3 file. The audio loops while the tool runs.
+            #
+            #   @return [Symbol, Telnyx::Models::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember1::Type]
+            required :type,
+                     enum: -> { Telnyx::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember1::Type }
+
+            # @!attribute value
+            #   HTTPS URL to an MP3 file.
+            #
+            #   @return [String]
+            required :value, String
+
+            # @!method initialize(type:, value:)
+            #   @param type [Symbol, Telnyx::Models::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember1::Type] Provide a direct URL to an MP3 file. The audio loops while the tool runs.
+            #
+            #   @param value [String] HTTPS URL to an MP3 file.
+
+            # Provide a direct URL to an MP3 file. The audio loops while the tool runs.
+            #
+            # @see Telnyx::Models::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember1#type
+            module Type
+              extend Telnyx::Internal::Type::Enum
+
+              MEDIA_URL = :media_url
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # @!method self.variants
+          #   @return [Array(Telnyx::Models::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember0, Telnyx::Models::AI::InferenceEmbeddingVoiceSettings::ToolCallAudio::UnionMember1)]
+        end
       end
     end
   end

data/lib/telnyx/models/ai/memory/namespace.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        class Namespace < Telnyx::Internal::Type::BaseModel
+          # @!attribute id
+          #   The namespace's unique identifier.
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute name
+          #   The namespace's name, used in the path. `default` exists for every organization.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!method initialize(id:, name:)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::AI::Memory::Namespace} for more details.
+          #
+          #   An isolated memory store within your organization.
+          #
+          #   @param id [String] The namespace's unique identifier.
+          #
+          #   @param name [String] The namespace's name, used in the path. `default` exists for every organization.
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespace_create_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        # @see Telnyx::Resources::AI::Memory::Namespaces#create
+        class NamespaceCreateParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute name
+          #   A name for the new namespace, unique within your organization.
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!method initialize(name:, request_options: {})
+          #   @param name [String] A name for the new namespace, unique within your organization.
+          #
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespace_create_response.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        # @see Telnyx::Resources::AI::Memory::Namespaces#create
+        class NamespaceCreateResponse < Telnyx::Internal::Type::BaseModel
+          # @!attribute data
+          #   An isolated memory store within your organization.
+          #
+          #   @return [Telnyx::Models::AI::Memory::Namespace]
+          required :data, -> { Telnyx::AI::Memory::Namespace }
+
+          # @!method initialize(data:)
+          #   @param data [Telnyx::Models::AI::Memory::Namespace] An isolated memory store within your organization.
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespace_delete_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        # @see Telnyx::Resources::AI::Memory::Namespaces#delete
+        class NamespaceDeleteParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!attribute namespace
+          #   The namespace to delete. `default` cannot be deleted.
+          #
+          #   @return [String]
+          required :namespace, String
+
+          # @!method initialize(namespace:, request_options: {})
+          #   @param namespace [String] The namespace to delete. `default` cannot be deleted.
+          #
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespace_list_params.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        # @see Telnyx::Resources::AI::Memory::Namespaces#list
+        class NamespaceListParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          # @!method initialize(request_options: {})
+          #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespace_list_response.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        # @see Telnyx::Resources::AI::Memory::Namespaces#list
+        class NamespaceListResponse < Telnyx::Internal::Type::BaseModel
+          # @!attribute data
+          #
+          #   @return [Array<Telnyx::Models::AI::Memory::Namespace>]
+          required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::AI::Memory::Namespace] }
+
+          # @!method initialize(data:)
+          #   @param data [Array<Telnyx::Models::AI::Memory::Namespace>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profile_preview_params.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles#preview
+          class ProfilePreviewParams < Telnyx::Internal::Type::BaseModel
+            extend Telnyx::Internal::Type::RequestParameters::Converter
+            include Telnyx::Internal::Type::RequestParameters
+
+            # @!attribute namespace
+            #   The namespace. `default` exists for every organization.
+            #
+            #   @return [String]
+            required :namespace, String
+
+            # @!attribute profile_id
+            #
+            #   @return [String]
+            required :profile_id, String
+
+            # @!attribute instructions
+            #   The candidate note to try. `null`, empty, or whitespace-only previews the
+            #   neutral default -- the summary a profile returns to when instructions are
+            #   cleared. Capped at 2000 characters, the same cap `PATCH /settings` applies on
+            #   save; a longer note is refused with `422` before anything is generated.
+            #
+            #   @return [String, nil]
+            optional :instructions, String, nil?: true
+
+            # @!method initialize(namespace:, profile_id:, instructions: nil, request_options: {})
+            #   Some parameter documentations has been truncated, see
+            #   {Telnyx::Models::AI::Memory::Namespaces::ProfilePreviewParams} for more details.
+            #
+            #   @param namespace [String] The namespace. `default` exists for every organization.
+            #
+            #   @param profile_id [String]
+            #
+            #   @param instructions [String, nil] The candidate note to try. `null`, empty, or whitespace-only previews the neutra
+            #
+            #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/memory/namespaces/profile_preview_response.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      module Memory
+        module Namespaces
+          # @see Telnyx::Resources::AI::Memory::Namespaces::Profiles#preview
+          class ProfilePreviewResponse < Telnyx::Internal::Type::BaseModel
+            # @!attribute data
+            #
+            #   @return [Telnyx::Models::AI::Memory::Namespaces::ProfilePreviewResponse::Data]
+            required :data, -> { Telnyx::Models::AI::Memory::Namespaces::ProfilePreviewResponse::Data }
+
+            # @!method initialize(data:)
+            #   @param data [Telnyx::Models::AI::Memory::Namespaces::ProfilePreviewResponse::Data]
+
+            # @see Telnyx::Models::AI::Memory::Namespaces::ProfilePreviewResponse#data
+            class Data < Telnyx::Internal::Type::BaseModel
+              # @!attribute profile_id
+              #
+              #   @return [String]
+              required :profile_id, String
+
+              # @!attribute text
+              #   The summary this profile would carry under the candidate note. Null when nothing
+              #   was generated -- the same signal `GET /summary` uses for a profile with no card
+              #   yet.
+              #
+              #   @return [String, nil]
+              required :text, String, nil?: true
+
+              # @!method initialize(profile_id:, text:)
+              #   Some parameter documentations has been truncated, see
+              #   {Telnyx::Models::AI::Memory::Namespaces::ProfilePreviewResponse::Data} for more
+              #   details.
+              #
+              #   @param profile_id [String]
+              #
+              #   @param text [String, nil] The summary this profile would carry under the candidate note. Null when nothing
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/pay_tool_params.rb

@@ -11,6 +11,14 @@ module Telnyx
         #   @return [String]
         required :connector_name, String
 
+        # @!attribute connector_parameters
+        #   Custom key/value parameters forwarded to the pay connector as `parameters` in
+        #   the processor request. String values may use `{{dynamic_variable}}` templating,
+        #   resolved per call.
+        #
+        #   @return [Hash{Symbol=>Object}, nil]
+        optional :connector_parameters, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
         # @!attribute currency
         #   Default currency for payments processed by this tool.
         #
@@ -18,7 +26,9 @@ module Telnyx
         optional :currency, String
 
         # @!attribute description
-        #   Optional description of the pay tool that will be passed to the assistant.
+        #   Description of the pay tool shown to the assistant so it knows when to call the
+        #   tool. Not sent to the payment connector — the per-call `description` argument
+        #   the assistant passes is what reaches the processor.
         #
         #   @return [String, nil]
         optional :description, String, nil?: true
@@ -29,17 +39,47 @@ module Telnyx
         #   @return [String, nil]
         optional :payment_method, String
 
-        # @!method initialize(connector_name:, currency: nil, description: nil, payment_method: nil)
+        # @!attribute valid_card_types
+        #   Restricts accepted card numbers to the listed card types. When the caller enters
+        #   a card number that does not match one of the listed types, Pay treats the input
+        #   as invalid and re-prompts for the card number.
+        #
+        #   @return [Array<Symbol, Telnyx::Models::AI::PayToolParams::ValidCardType>, nil]
+        optional :valid_card_types,
+                 -> { Telnyx::Internal::Type::ArrayOf[enum: Telnyx::AI::PayToolParams::ValidCardType] }
+
+        # @!method initialize(connector_name:, connector_parameters: nil, currency: nil, description: nil, payment_method: nil, valid_card_types: nil)
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::AI::PayToolParams} for more details.
         #
         #   @param connector_name [String] The name of the pay connector configured in the Telnyx API. Must reference an ex
         #
+        #   @param connector_parameters [Hash{Symbol=>Object}] Custom key/value parameters forwarded to the pay connector as `parameters` in th
+        #
         #   @param currency [String] Default currency for payments processed by this tool.
         #
-        #   @param description [String, nil] Optional description of the pay tool that will be passed to the assistant.
+        #   @param description [String, nil] Description of the pay tool shown to the assistant so it knows when to call the
         #
         #   @param payment_method [String] Default payment method for payments processed by this tool.
+        #
+        #   @param valid_card_types [Array<Symbol, Telnyx::Models::AI::PayToolParams::ValidCardType>] Restricts accepted card numbers to the listed card types. When the caller enters
+
+        module ValidCardType
+          extend Telnyx::Internal::Type::Enum
+
+          VISA = :visa
+          MASTERCARD = :mastercard
+          AMEX = :amex
+          MAESTRO = :maestro
+          DISCOVER = :discover
+          OPTIMA = :optima
+          JCB = :jcb
+          DINERS_CLUB = :"diners-club"
+          ENROUTE = :enroute
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
       end
     end
   end

data/lib/telnyx/models/ai/telephony_settings.rb

@@ -4,6 +4,17 @@ module Telnyx
   module Models
     module AI
       class TelephonySettings < Telnyx::Internal::Type::BaseModel
+        # @!attribute conversation_ended_full_history
+        #   When enabled, the `messages` array of the `call.conversation.ended` webhook
+        #   contains the full conversation history in order: user and assistant turns,
+        #   assistant tool calls (`tool_calls`), tool results (`role: tool` with
+        #   `tool_call_id`), and informational `system` and `developer` entries. The
+        #   assistant's instructions are never included. When disabled, `messages` contains
+        #   only user and assistant text turns.
+        #
+        #   @return [Boolean, nil]
+        optional :conversation_ended_full_history, Telnyx::Internal::Type::Boolean
+
         # @!attribute default_texml_app_id
         #   Default Texml App used for voice calls with your assistant. This will be created
         #   automatically on assistant creation.
@@ -112,10 +123,12 @@ module Telnyx
         #   @return [Telnyx::Models::AI::TelephonySettings::VoicemailDetection, nil]
         optional :voicemail_detection, -> { Telnyx::AI::TelephonySettings::VoicemailDetection }
 
-        # @!method initialize(default_texml_app_id: nil, disable_dtmf: nil, fallback_destination: nil, noise_suppression: nil, noise_suppression_config: nil, recording_settings: nil, send_message_history_updates: nil, supports_unauthenticated_web_calls: nil, time_limit_secs: nil, user_idle_reply_secs: nil, user_idle_timeout_secs: nil, voicemail_detection: nil)
+        # @!method initialize(conversation_ended_full_history: nil, default_texml_app_id: nil, disable_dtmf: nil, fallback_destination: nil, noise_suppression: nil, noise_suppression_config: nil, recording_settings: nil, send_message_history_updates: nil, supports_unauthenticated_web_calls: nil, time_limit_secs: nil, user_idle_reply_secs: nil, user_idle_timeout_secs: nil, voicemail_detection: nil)
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::AI::TelephonySettings} for more details.
         #
+        #   @param conversation_ended_full_history [Boolean] When enabled, the `messages` array of the `call.conversation.ended` webhook cont
+        #
         #   @param default_texml_app_id [String] Default Texml App used for voice calls with your assistant. This will be created
         #
         #   @param disable_dtmf [Boolean] Disable inbound DTMF for the entire call. Must be set to true if a 'pay' tool is

data/lib/telnyx/models/ai/telnyx_avatar_settings.rb

@@ -0,0 +1,93 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module AI
+      class TelnyxAvatarSettings < Telnyx::Internal::Type::BaseModel
+        # @!attribute avatar_id
+        #   The Telnyx avatar to render.
+        #
+        #   @return [Symbol, Telnyx::Models::AI::TelnyxAvatarSettings::AvatarID]
+        required :avatar_id, enum: -> { Telnyx::AI::TelnyxAvatarSettings::AvatarID }
+
+        # @!attribute background_id
+        #   The background to render.
+        #
+        #   @return [Symbol, Telnyx::Models::AI::TelnyxAvatarSettings::BackgroundID]
+        required :background_id, enum: -> { Telnyx::AI::TelnyxAvatarSettings::BackgroundID }
+
+        # @!attribute model
+        #   Required avatar model identifier, separate from `avatar_id`. The supported value
+        #   is `foxtrot-1`. Omission, null, and unsupported model identifiers are rejected.
+        #
+        #   @return [Symbol, Telnyx::Models::AI::TelnyxAvatarSettings::Model]
+        required :model, enum: -> { Telnyx::AI::TelnyxAvatarSettings::Model }
+
+        # @!attribute provider
+        #   Selects the Telnyx open-source avatar provider.
+        #
+        #   @return [Symbol, :telnyx]
+        required :provider, const: :telnyx
+
+        # @!method initialize(avatar_id:, background_id:, model:, provider: :telnyx)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::AI::TelnyxAvatarSettings} for more details.
+        #
+        #   **Beta:** Configuration for the Telnyx open-source avatar provider. The launch
+        #   catalog supports six avatars and office, studio, or reception backgrounds.
+        #
+        #   @param avatar_id [Symbol, Telnyx::Models::AI::TelnyxAvatarSettings::AvatarID] The Telnyx avatar to render.
+        #
+        #   @param background_id [Symbol, Telnyx::Models::AI::TelnyxAvatarSettings::BackgroundID] The background to render.
+        #
+        #   @param model [Symbol, Telnyx::Models::AI::TelnyxAvatarSettings::Model] Required avatar model identifier, separate from `avatar_id`. The supported value
+        #
+        #   @param provider [Symbol, :telnyx] Selects the Telnyx open-source avatar provider.
+
+        # The Telnyx avatar to render.
+        #
+        # @see Telnyx::Models::AI::TelnyxAvatarSettings#avatar_id
+        module AvatarID
+          extend Telnyx::Internal::Type::Enum
+
+          ELENA = :elena
+          BEN = :ben
+          JORDAN = :jordan
+          LIN = :lin
+          AVERY = :avery
+          RAPHAEL = :raphael
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # The background to render.
+        #
+        # @see Telnyx::Models::AI::TelnyxAvatarSettings#background_id
+        module BackgroundID
+          extend Telnyx::Internal::Type::Enum
+
+          OFFICE = :office
+          STUDIO = :studio
+          RECEPTION = :reception
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+
+        # Required avatar model identifier, separate from `avatar_id`. The supported value
+        # is `foxtrot-1`. Omission, null, and unsupported model identifiers are rejected.
+        #
+        # @see Telnyx::Models::AI::TelnyxAvatarSettings#model
+        module Model
+          extend Telnyx::Internal::Type::Enum
+
+          FOXTROT_1 = :"foxtrot-1"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/ai/tool_node.rb

@@ -13,14 +13,26 @@ module Telnyx
         # @!attribute shared_tool_id
         #   ID of the single shared (org-level) tool this node executes. When the flow
         #   reaches this node the tool runs as a deliberate step (no LLM turn); its outgoing
-        #   `tool_result` edges then route on the outcome. Arguments are filled from the
-        #   conversation's dynamic variables by name — a dynamic variable whose name matches
-        #   one of the tool's parameters supplies that argument. Cross-validated against the
-        #   org's shared tools on write.
+        #   `llm` / `expression` edges route the flow on the tool's outcome. Arguments are
+        #   filled from the conversation's dynamic variables by name — a dynamic variable
+        #   whose name matches one of the tool's parameters supplies that argument.
+        #   Cross-validated against the org's shared tools on write.
         #
         #   @return [String]
         required :shared_tool_id, String
 
+        # @!attribute message
+        #   Optional message delivered to the user verbatim immediately before the tool
+        #   executes — an announcement such as 'One moment while I look that up.' No LLM
+        #   turn and no customer turn: the message is spoken/sent, then the tool runs, in
+        #   the same deterministic step. `{{variable}}` placeholders are interpolated from
+        #   the conversation's dynamic variables (unresolved → empty string); the tool's own
+        #   result is not yet available when the message is rendered. Omit for a silent tool
+        #   step.
+        #
+        #   @return [String, nil]
+        optional :message, String
+
         # @!attribute name
         #   Optional human-readable label, displayed in authoring UIs.
         #
@@ -49,7 +61,7 @@ module Telnyx
         #   @return [Symbol, Telnyx::Models::AI::ToolNode::Type, nil]
         optional :type, enum: -> { Telnyx::AI::ToolNode::Type }
 
-        # @!method initialize(id:, shared_tool_id:, name: nil, position: nil, tool: nil, type: nil)
+        # @!method initialize(id:, shared_tool_id:, message: nil, name: nil, position: nil, tool: nil, type: nil)
         #   Some parameter documentations has been truncated, see
         #   {Telnyx::Models::AI::ToolNode} for more details.
         #
@@ -59,6 +71,8 @@ module Telnyx
         #
         #   @param shared_tool_id [String] ID of the single shared (org-level) tool this node executes. When the flow reach
         #
+        #   @param message [String] Optional message delivered to the user verbatim immediately before the tool exec
+        #
         #   @param name [String] Optional human-readable label, displayed in authoring UIs.
         #
         #   @param position [Telnyx::Models::AI::NodePosition] Optional canvas coordinates used by authoring UIs to lay out the graph. Ignored