telnyx 5.169.0 → 5.171.0

data/rbi/telnyx/models/ai/assistants/deleted_assistant.rbi

@@ -0,0 +1,52 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      DeletedAssistant = Assistants::DeletedAssistant
+
+      module Assistants
+        class DeletedAssistant < Telnyx::Models::AI::InferenceEmbedding
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::AI::Assistants::DeletedAssistant,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Timestamp of the soft delete.
+          sig { returns(Time) }
+          attr_accessor :deleted_at
+
+          # Point after which the assistant is permanently deleted automatically and can no
+          # longer be restored.
+          sig { returns(Time) }
+          attr_accessor :permanently_deleted_at
+
+          # A soft-deleted assistant in the Recently Deleted list: the full assistant
+          # configuration plus deletion metadata.
+          sig do
+            params(deleted_at: Time, permanently_deleted_at: Time).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            # Timestamp of the soft delete.
+            deleted_at:,
+            # Point after which the assistant is permanently deleted automatically and can no
+            # longer be restored.
+            permanently_deleted_at:
+          )
+          end
+
+          sig do
+            override.returns({ deleted_at: Time, permanently_deleted_at: Time })
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/assistants/deleted_get_params.rbi

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

data/rbi/telnyx/models/ai/assistants/deleted_list_params.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Assistants
+        class DeletedListParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::AI::Assistants::DeletedListParams,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Page number to retrieve (1-based).
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :page_number
+
+          sig { params(page_number: Integer).void }
+          attr_writer :page_number
+
+          # Number of items to return per page.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :page_size
+
+          sig { params(page_size: Integer).void }
+          attr_writer :page_size
+
+          sig do
+            params(
+              page_number: Integer,
+              page_size: Integer,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Page number to retrieve (1-based).
+            page_number: nil,
+            # Number of items to return per page.
+            page_size: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                page_number: Integer,
+                page_size: Integer,
+                request_options: Telnyx::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/assistants/update_assistant.rbi

@@ -34,6 +34,19 @@ 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::AvatarSettingsRequest)) }
+          attr_reader :avatar_settings
+
+          sig do
+            params(
+              avatar_settings:
+                T.nilable(Telnyx::AI::AvatarSettingsRequest::OrHash)
+            ).void
+          end
+          attr_writer :avatar_settings
+
           # Conversation flow as supplied by API clients (create / update).
           #
           # A directed graph of `FlowNodeReq` connected by `FlowEdge`s. Validation enforces
@@ -49,6 +62,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
 
@@ -369,12 +399,34 @@ module Telnyx
           sig { params(version_name: String).void }
           attr_writer :version_name
 
-          sig { returns(T.nilable(Telnyx::AI::VoiceSettings)) }
+          sig do
+            returns(T.nilable(Telnyx::AI::InferenceEmbeddingVoiceSettings))
+          end
           attr_reader :voice_settings
 
-          sig { params(voice_settings: Telnyx::AI::VoiceSettings::OrHash).void }
+          sig do
+            params(
+              voice_settings:
+                Telnyx::AI::InferenceEmbeddingVoiceSettings::OrHash
+            ).void
+          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
@@ -387,7 +439,10 @@ module Telnyx
           sig do
             params(
               a2a_agents: T::Array[Telnyx::AI::AssistantA2AAgent::OrHash],
+              avatar_settings:
+                T.nilable(Telnyx::AI::AvatarSettingsRequest::OrHash),
               conversation_flow: Telnyx::AI::ConversationFlowReq::OrHash,
+              delegation_settings: Telnyx::AI::DelegationSettings::OrHash,
               description: String,
               dynamic_variables: T::Hash[Symbol, T.anything],
               dynamic_variables_webhook_timeout_ms: Integer,
@@ -434,7 +489,9 @@ module Telnyx
                 ],
               transcription: Telnyx::AI::TranscriptionSettings::OrHash,
               version_name: String,
-              voice_settings: Telnyx::AI::VoiceSettings::OrHash,
+              voice_settings:
+                Telnyx::AI::InferenceEmbeddingVoiceSettings::OrHash,
+              websocket_settings: Telnyx::AI::WebsocketSettings::OrHash,
               widget_settings: Telnyx::AI::WidgetSettings::OrHash
             ).returns(T.attached_class)
           end
@@ -449,12 +506,23 @@ module Telnyx
             # capability for the conversation; it does not fail the call. Omit this field to
             # leave the assistant's agents unchanged; send an empty array to remove them all.
             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 supplied by API clients (create / update).
             #
             # A directed graph of `FlowNodeReq` connected by `FlowEdge`s. Validation enforces
             # unique node/edge IDs, that `start_node_id` references a real node, and that
             # every edge's endpoints reference real nodes.
             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 default values
             dynamic_variables: nil,
@@ -551,6 +619,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
           )
@@ -560,7 +634,9 @@ module Telnyx
             override.returns(
               {
                 a2a_agents: T::Array[Telnyx::AI::AssistantA2AAgent],
+                avatar_settings: T.nilable(Telnyx::AI::AvatarSettingsRequest),
                 conversation_flow: Telnyx::AI::ConversationFlowReq,
+                delegation_settings: Telnyx::AI::DelegationSettings,
                 description: String,
                 dynamic_variables: T::Hash[Symbol, T.anything],
                 dynamic_variables_webhook_timeout_ms: Integer,
@@ -608,7 +684,8 @@ module Telnyx
                   ],
                 transcription: Telnyx::AI::TranscriptionSettings,
                 version_name: String,
-                voice_settings: Telnyx::AI::VoiceSettings,
+                voice_settings: Telnyx::AI::InferenceEmbeddingVoiceSettings,
+                websocket_settings: Telnyx::AI::WebsocketSettings,
                 widget_settings: Telnyx::AI::WidgetSettings
               }
             )

data/rbi/telnyx/models/ai/avatar_settings_request.rbi

@@ -0,0 +1,186 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      class AvatarSettingsRequest < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::AI::AvatarSettingsRequest, Telnyx::Internal::AnyHash)
+          end
+
+        # The Telnyx avatar to render.
+        sig { returns(Telnyx::AI::AvatarSettingsRequest::AvatarID::OrSymbol) }
+        attr_accessor :avatar_id
+
+        # The background to render.
+        sig do
+          returns(Telnyx::AI::AvatarSettingsRequest::BackgroundID::OrSymbol)
+        end
+        attr_accessor :background_id
+
+        # Required avatar model identifier, separate from `avatar_id`. The supported value
+        # is `foxtrot-1`. Omission, null, and unsupported model identifiers are rejected.
+        sig { returns(Telnyx::AI::AvatarSettingsRequest::Model::OrSymbol) }
+        attr_accessor :model
+
+        # Selects the Telnyx open-source avatar provider.
+        sig { returns(Symbol) }
+        attr_accessor :provider
+
+        # **Beta:** Configuration for the Telnyx open-source avatar provider. The launch
+        # catalog supports six avatars and office, studio, or reception backgrounds.
+        sig do
+          params(
+            avatar_id: Telnyx::AI::AvatarSettingsRequest::AvatarID::OrSymbol,
+            background_id:
+              Telnyx::AI::AvatarSettingsRequest::BackgroundID::OrSymbol,
+            model: Telnyx::AI::AvatarSettingsRequest::Model::OrSymbol,
+            provider: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The Telnyx avatar to render.
+          avatar_id:,
+          # The background to render.
+          background_id:,
+          # Required avatar model identifier, separate from `avatar_id`. The supported value
+          # is `foxtrot-1`. Omission, null, and unsupported model identifiers are rejected.
+          model:,
+          # Selects the Telnyx open-source avatar provider.
+          provider: :telnyx
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              avatar_id: Telnyx::AI::AvatarSettingsRequest::AvatarID::OrSymbol,
+              background_id:
+                Telnyx::AI::AvatarSettingsRequest::BackgroundID::OrSymbol,
+              model: Telnyx::AI::AvatarSettingsRequest::Model::OrSymbol,
+              provider: Symbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The Telnyx avatar to render.
+        module AvatarID
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::AI::AvatarSettingsRequest::AvatarID)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ELENA =
+            T.let(
+              :elena,
+              Telnyx::AI::AvatarSettingsRequest::AvatarID::TaggedSymbol
+            )
+          BEN =
+            T.let(
+              :ben,
+              Telnyx::AI::AvatarSettingsRequest::AvatarID::TaggedSymbol
+            )
+          JORDAN =
+            T.let(
+              :jordan,
+              Telnyx::AI::AvatarSettingsRequest::AvatarID::TaggedSymbol
+            )
+          LIN =
+            T.let(
+              :lin,
+              Telnyx::AI::AvatarSettingsRequest::AvatarID::TaggedSymbol
+            )
+          AVERY =
+            T.let(
+              :avery,
+              Telnyx::AI::AvatarSettingsRequest::AvatarID::TaggedSymbol
+            )
+          RAPHAEL =
+            T.let(
+              :raphael,
+              Telnyx::AI::AvatarSettingsRequest::AvatarID::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::AI::AvatarSettingsRequest::AvatarID::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # The background to render.
+        module BackgroundID
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::AI::AvatarSettingsRequest::BackgroundID)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          OFFICE =
+            T.let(
+              :office,
+              Telnyx::AI::AvatarSettingsRequest::BackgroundID::TaggedSymbol
+            )
+          STUDIO =
+            T.let(
+              :studio,
+              Telnyx::AI::AvatarSettingsRequest::BackgroundID::TaggedSymbol
+            )
+          RECEPTION =
+            T.let(
+              :reception,
+              Telnyx::AI::AvatarSettingsRequest::BackgroundID::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::AI::AvatarSettingsRequest::BackgroundID::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        # Required avatar model identifier, separate from `avatar_id`. The supported value
+        # is `foxtrot-1`. Omission, null, and unsupported model identifiers are rejected.
+        module Model
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::AI::AvatarSettingsRequest::Model)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FOXTROT_1 =
+            T.let(
+              :"foxtrot-1",
+              Telnyx::AI::AvatarSettingsRequest::Model::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::AI::AvatarSettingsRequest::Model::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/chat_completion_request.rbi

@@ -72,12 +72,28 @@ module Telnyx
         sig { params(logprobs: T::Boolean).void }
         attr_writer :logprobs
 
-        # Maximum number of completion tokens the model should generate.
+        # Maximum number of completion (output) tokens, including reasoning and answer
+        # tokens combined. An omitted or null limit defaults to 8192 unless the model is
+        # excluded from that default; excluded models leave the limit to the serving
+        # engine. Explicit values and applied defaults are clamped to the model's
+        # max_completion_tokens metadata when that ceiling is set (see GET
+        # /v2/ai/openai/models). An omitted limit on an excluded model remains unset even
+        # when metadata declares a ceiling. Input and output together must fit the model's
+        # context window. Set an explicit limit when a bounded generation budget is
+        # required. For current Telnyx-hosted models, omitted or null limits default to
+        # 8192 for `zai-org/GLM-5.3`, `zai-org/GLM-5.3-Flash` and
+        # `deepseek-ai/DeepSeek-V4.1-Flash`. The hosted exclusions are
+        # `moonshotai/Kimi-K3`, `moonshotai/Kimi-K2.6`, `moonshotai/Kimi-K2.5`,
+        # `zai-org/GLM-5.2`, `zai-org/GLM-5.1-FP8`, `MiniMaxAI/MiniMax-M3-MXFP8`,
+        # `MiniMaxAI/MiniMax-M2.7`, `Qwen/Qwen3.8-27B`, `Qwen/Qwen3-235B-A22B`,
+        # `deepseek-ai/DeepSeek-V4-Flash-0731`, `meta-llama/Llama-3.3-70B-Instruct`,
+        # `meta-llama/Meta-Llama-3.1-70B-Instruct`,
+        # `meta-llama/Meta-Llama-3.1-8B-Instruct` and `google/gemma-2b-it`. Legacy
+        # external and fine-tuned model IDs can also bypass the default; model discovery
+        # reports completion ceilings, not whether this default applies. Set an explicit
+        # limit for predictable behavior across models.
         sig { returns(T.nilable(Integer)) }
-        attr_reader :max_tokens
-
-        sig { params(max_tokens: Integer).void }
-        attr_writer :max_tokens
+        attr_accessor :max_tokens
 
         # This is an alternative to `top_p` that
         # [many prefer](https://github.com/huggingface/transformers/issues/27670). Must be
@@ -323,7 +339,7 @@ module Telnyx
             frequency_penalty: Float,
             length_penalty: Float,
             logprobs: T::Boolean,
-            max_tokens: Integer,
+            max_tokens: T.nilable(Integer),
             min_p: Float,
             mode: Telnyx::AI::ChatCompletionRequest::Mode::OrSymbol,
             model: String,
@@ -384,7 +400,26 @@ module Telnyx
           # returns the log probabilities of each output token returned in the `content` of
           # `message`.
           logprobs: nil,
-          # Maximum number of completion tokens the model should generate.
+          # Maximum number of completion (output) tokens, including reasoning and answer
+          # tokens combined. An omitted or null limit defaults to 8192 unless the model is
+          # excluded from that default; excluded models leave the limit to the serving
+          # engine. Explicit values and applied defaults are clamped to the model's
+          # max_completion_tokens metadata when that ceiling is set (see GET
+          # /v2/ai/openai/models). An omitted limit on an excluded model remains unset even
+          # when metadata declares a ceiling. Input and output together must fit the model's
+          # context window. Set an explicit limit when a bounded generation budget is
+          # required. For current Telnyx-hosted models, omitted or null limits default to
+          # 8192 for `zai-org/GLM-5.3`, `zai-org/GLM-5.3-Flash` and
+          # `deepseek-ai/DeepSeek-V4.1-Flash`. The hosted exclusions are
+          # `moonshotai/Kimi-K3`, `moonshotai/Kimi-K2.6`, `moonshotai/Kimi-K2.5`,
+          # `zai-org/GLM-5.2`, `zai-org/GLM-5.1-FP8`, `MiniMaxAI/MiniMax-M3-MXFP8`,
+          # `MiniMaxAI/MiniMax-M2.7`, `Qwen/Qwen3.8-27B`, `Qwen/Qwen3-235B-A22B`,
+          # `deepseek-ai/DeepSeek-V4-Flash-0731`, `meta-llama/Llama-3.3-70B-Instruct`,
+          # `meta-llama/Meta-Llama-3.1-70B-Instruct`,
+          # `meta-llama/Meta-Llama-3.1-8B-Instruct` and `google/gemma-2b-it`. Legacy
+          # external and fine-tuned model IDs can also bypass the default; model discovery
+          # reports completion ceilings, not whether this default applies. Set an explicit
+          # limit for predictable behavior across models.
           max_tokens: nil,
           # This is an alternative to `top_p` that
           # [many prefer](https://github.com/huggingface/transformers/issues/27670). Must be
@@ -468,7 +503,7 @@ module Telnyx
               frequency_penalty: Float,
               length_penalty: Float,
               logprobs: T::Boolean,
-              max_tokens: Integer,
+              max_tokens: T.nilable(Integer),
               min_p: Float,
               mode: Telnyx::AI::ChatCompletionRequest::Mode::OrSymbol,
               model: String,

data/rbi/telnyx/models/ai/collection.rbi

@@ -52,12 +52,17 @@ module Telnyx
         sig { params(slug: String).void }
         attr_writer :slug
 
-        sig { returns(T.nilable(T::Array[Telnyx::AI::Collections::Source])) }
+        sig do
+          returns(
+            T.nilable(T::Array[Telnyx::AI::Collections::CollectionsSource])
+          )
+        end
         attr_reader :sources
 
         sig do
           params(
-            sources: T::Array[Telnyx::AI::Collections::Source::OrHash]
+            sources:
+              T::Array[Telnyx::AI::Collections::CollectionsSource::OrHash]
           ).void
         end
         attr_writer :sources
@@ -88,7 +93,8 @@ module Telnyx
             record_type: String,
             settings: Telnyx::AI::Collections::RetrievalSettingsWrapper::OrHash,
             slug: String,
-            sources: T::Array[Telnyx::AI::Collections::Source::OrHash],
+            sources:
+              T::Array[Telnyx::AI::Collections::CollectionsSource::OrHash],
             status: String,
             updated_at: Time,
             uuid: String
@@ -118,7 +124,7 @@ module Telnyx
               record_type: String,
               settings: Telnyx::AI::Collections::RetrievalSettingsWrapper,
               slug: String,
-              sources: T::Array[Telnyx::AI::Collections::Source],
+              sources: T::Array[Telnyx::AI::Collections::CollectionsSource],
               status: String,
               updated_at: Time,
               uuid: String