telnyx 5.155.0 → 5.157.0

data/rbi/telnyx/models/ai/anthropic/v1_messages_params.rbi

@@ -0,0 +1,314 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Anthropic
+        class V1MessagesParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::AI::Anthropic::V1MessagesParams,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # The maximum number of tokens to generate in the response.
+          sig { returns(Integer) }
+          attr_accessor :max_tokens
+
+          # The messages to send to the model, following the
+          # [Anthropic Messages API](https://docs.anthropic.com/en/api/messages) format.
+          sig { returns(T::Array[T::Hash[Symbol, T.anything]]) }
+          attr_accessor :messages
+
+          # The model to use for generating the response, for example `zai-org/GLM-5.2` or
+          # another model available from the Telnyx models endpoint.
+          sig { returns(String) }
+          attr_accessor :model
+
+          # If you are using an external inference provider, this field allows you to pass
+          # along a reference to your API key. After creating an
+          # [integration secret](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
+          # for your API key, pass the secret's `identifier` in this field.
+          sig { returns(T.nilable(String)) }
+          attr_reader :api_key_ref
+
+          sig { params(api_key_ref: String).void }
+          attr_writer :api_key_ref
+
+          # The billing group ID to associate with this request.
+          sig { returns(T.nilable(String)) }
+          attr_reader :billing_group_id
+
+          sig { params(billing_group_id: String).void }
+          attr_writer :billing_group_id
+
+          # Configuration for model fallback behavior when the primary model is unavailable.
+          sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+          attr_reader :fallback_config
+
+          sig { params(fallback_config: T::Hash[Symbol, T.anything]).void }
+          attr_writer :fallback_config
+
+          # Maximum number of retries for the request.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :max_retries
+
+          sig { params(max_retries: Integer).void }
+          attr_writer :max_retries
+
+          # List of MCP (Model Context Protocol) servers to make available to the model.
+          sig { returns(T.nilable(T::Array[T::Hash[Symbol, T.anything]])) }
+          attr_reader :mcp_servers
+
+          sig do
+            params(mcp_servers: T::Array[T::Hash[Symbol, T.anything]]).void
+          end
+          attr_writer :mcp_servers
+
+          # An object describing metadata about the request.
+          sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+          attr_reader :metadata
+
+          sig { params(metadata: T::Hash[Symbol, T.anything]).void }
+          attr_writer :metadata
+
+          # Service tier for the request.
+          sig { returns(T.nilable(String)) }
+          attr_reader :service_tier
+
+          sig { params(service_tier: String).void }
+          attr_writer :service_tier
+
+          # Custom sequences that will cause the model to stop generating.
+          sig { returns(T.nilable(T::Array[String])) }
+          attr_reader :stop_sequences
+
+          sig { params(stop_sequences: T::Array[String]).void }
+          attr_writer :stop_sequences
+
+          # Whether to stream the response as Anthropic-format Server-Sent Events.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :stream
+
+          sig { params(stream: T::Boolean).void }
+          attr_writer :stream
+
+          # System prompt. Can be a string or an array of content blocks following the
+          # Anthropic API format.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::AI::Anthropic::V1MessagesParams::System::Variants
+              )
+            )
+          end
+          attr_reader :system_
+
+          sig do
+            params(
+              system_: Telnyx::AI::Anthropic::V1MessagesParams::System::Variants
+            ).void
+          end
+          attr_writer :system_
+
+          # Amount of randomness injected into the response. Ranges from 0 to 1.
+          sig { returns(T.nilable(Float)) }
+          attr_reader :temperature
+
+          sig { params(temperature: Float).void }
+          attr_writer :temperature
+
+          # Extended thinking configuration for models that support it. Set `type` to
+          # `enabled` to turn on extended thinking.
+          sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+          attr_reader :thinking
+
+          sig { params(thinking: T::Hash[Symbol, T.anything]).void }
+          attr_writer :thinking
+
+          # Request timeout in seconds.
+          sig { returns(T.nilable(Float)) }
+          attr_reader :timeout
+
+          sig { params(timeout: Float).void }
+          attr_writer :timeout
+
+          # Controls how the model uses tools, following the Anthropic API format.
+          sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+          attr_reader :tool_choice
+
+          sig { params(tool_choice: T::Hash[Symbol, T.anything]).void }
+          attr_writer :tool_choice
+
+          # Definitions of tools that the model may use, following the Anthropic API format.
+          sig { returns(T.nilable(T::Array[T::Hash[Symbol, T.anything]])) }
+          attr_reader :tools
+
+          sig { params(tools: T::Array[T::Hash[Symbol, T.anything]]).void }
+          attr_writer :tools
+
+          # Top-k sampling parameter. Only sample from the top K options for each subsequent
+          # token.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :top_k
+
+          sig { params(top_k: Integer).void }
+          attr_writer :top_k
+
+          # Nucleus sampling parameter. Use temperature or top_p, but not both.
+          sig { returns(T.nilable(Float)) }
+          attr_reader :top_p
+
+          sig { params(top_p: Float).void }
+          attr_writer :top_p
+
+          sig do
+            params(
+              max_tokens: Integer,
+              messages: T::Array[T::Hash[Symbol, T.anything]],
+              model: String,
+              api_key_ref: String,
+              billing_group_id: String,
+              fallback_config: T::Hash[Symbol, T.anything],
+              max_retries: Integer,
+              mcp_servers: T::Array[T::Hash[Symbol, T.anything]],
+              metadata: T::Hash[Symbol, T.anything],
+              service_tier: String,
+              stop_sequences: T::Array[String],
+              stream: T::Boolean,
+              system_:
+                Telnyx::AI::Anthropic::V1MessagesParams::System::Variants,
+              temperature: Float,
+              thinking: T::Hash[Symbol, T.anything],
+              timeout: Float,
+              tool_choice: T::Hash[Symbol, T.anything],
+              tools: T::Array[T::Hash[Symbol, T.anything]],
+              top_k: Integer,
+              top_p: Float,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The maximum number of tokens to generate in the response.
+            max_tokens:,
+            # The messages to send to the model, following the
+            # [Anthropic Messages API](https://docs.anthropic.com/en/api/messages) format.
+            messages:,
+            # The model to use for generating the response, for example `zai-org/GLM-5.2` or
+            # another model available from the Telnyx models endpoint.
+            model:,
+            # If you are using an external inference provider, this field allows you to pass
+            # along a reference to your API key. After creating an
+            # [integration secret](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
+            # for your API key, pass the secret's `identifier` in this field.
+            api_key_ref: nil,
+            # The billing group ID to associate with this request.
+            billing_group_id: nil,
+            # Configuration for model fallback behavior when the primary model is unavailable.
+            fallback_config: nil,
+            # Maximum number of retries for the request.
+            max_retries: nil,
+            # List of MCP (Model Context Protocol) servers to make available to the model.
+            mcp_servers: nil,
+            # An object describing metadata about the request.
+            metadata: nil,
+            # Service tier for the request.
+            service_tier: nil,
+            # Custom sequences that will cause the model to stop generating.
+            stop_sequences: nil,
+            # Whether to stream the response as Anthropic-format Server-Sent Events.
+            stream: nil,
+            # System prompt. Can be a string or an array of content blocks following the
+            # Anthropic API format.
+            system_: nil,
+            # Amount of randomness injected into the response. Ranges from 0 to 1.
+            temperature: nil,
+            # Extended thinking configuration for models that support it. Set `type` to
+            # `enabled` to turn on extended thinking.
+            thinking: nil,
+            # Request timeout in seconds.
+            timeout: nil,
+            # Controls how the model uses tools, following the Anthropic API format.
+            tool_choice: nil,
+            # Definitions of tools that the model may use, following the Anthropic API format.
+            tools: nil,
+            # Top-k sampling parameter. Only sample from the top K options for each subsequent
+            # token.
+            top_k: nil,
+            # Nucleus sampling parameter. Use temperature or top_p, but not both.
+            top_p: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                max_tokens: Integer,
+                messages: T::Array[T::Hash[Symbol, T.anything]],
+                model: String,
+                api_key_ref: String,
+                billing_group_id: String,
+                fallback_config: T::Hash[Symbol, T.anything],
+                max_retries: Integer,
+                mcp_servers: T::Array[T::Hash[Symbol, T.anything]],
+                metadata: T::Hash[Symbol, T.anything],
+                service_tier: String,
+                stop_sequences: T::Array[String],
+                stream: T::Boolean,
+                system_:
+                  Telnyx::AI::Anthropic::V1MessagesParams::System::Variants,
+                temperature: Float,
+                thinking: T::Hash[Symbol, T.anything],
+                timeout: Float,
+                tool_choice: T::Hash[Symbol, T.anything],
+                tools: T::Array[T::Hash[Symbol, T.anything]],
+                top_k: Integer,
+                top_p: Float,
+                request_options: Telnyx::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # System prompt. Can be a string or an array of content blocks following the
+          # Anthropic API format.
+          module System
+            extend Telnyx::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(String, T::Array[T::Hash[Symbol, T.anything]])
+              end
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::AI::Anthropic::V1MessagesParams::System::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+
+            UnionMember1Array =
+              T.let(
+                Telnyx::Internal::Type::ArrayOf[
+                  Telnyx::Internal::Type::HashOf[
+                    Telnyx::Internal::Type::Unknown
+                  ]
+                ],
+                Telnyx::Internal::Type::Converter
+              )
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/anthropic/v1_messages_response.rbi

@@ -0,0 +1,15 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module AI
+      module Anthropic
+        V1MessagesResponse =
+          T.let(
+            Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown],
+            Telnyx::Internal::Type::Converter
+          )
+      end
+    end
+  end
+end

data/rbi/telnyx/models/ai/assistant_create_params.rbi

@@ -262,6 +262,7 @@ module Telnyx
               T::Array[
                 T.any(
                   Telnyx::AI::InferenceEmbeddingWebhookToolParams,
+                  Telnyx::AI::AssistantTool::ClientSideTool,
                   Telnyx::AI::RetrievalTool,
                   Telnyx::AI::AssistantTool::Handoff,
                   Telnyx::AI::HangupTool,
@@ -270,7 +271,8 @@ module Telnyx
                   Telnyx::AI::AssistantTool::Refer,
                   Telnyx::AI::AssistantTool::SendDtmf,
                   Telnyx::AI::AssistantTool::SendMessage,
-                  Telnyx::AI::AssistantTool::SkipTurn
+                  Telnyx::AI::AssistantTool::SkipTurn,
+                  Telnyx::AI::AssistantTool::Pay
                 )
               ]
             )
@@ -284,6 +286,7 @@ module Telnyx
               T::Array[
                 T.any(
                   Telnyx::AI::InferenceEmbeddingWebhookToolParams::OrHash,
+                  Telnyx::AI::AssistantTool::ClientSideTool::OrHash,
                   Telnyx::AI::RetrievalTool::OrHash,
                   Telnyx::AI::AssistantTool::Handoff::OrHash,
                   Telnyx::AI::HangupTool::OrHash,
@@ -292,7 +295,8 @@ module Telnyx
                   Telnyx::AI::AssistantTool::Refer::OrHash,
                   Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                   Telnyx::AI::AssistantTool::SendMessage::OrHash,
-                  Telnyx::AI::AssistantTool::SkipTurn::OrHash
+                  Telnyx::AI::AssistantTool::SkipTurn::OrHash,
+                  Telnyx::AI::AssistantTool::Pay::OrHash
                 )
               ]
           ).void
@@ -352,6 +356,7 @@ module Telnyx
               T::Array[
                 T.any(
                   Telnyx::AI::InferenceEmbeddingWebhookToolParams::OrHash,
+                  Telnyx::AI::AssistantTool::ClientSideTool::OrHash,
                   Telnyx::AI::RetrievalTool::OrHash,
                   Telnyx::AI::AssistantTool::Handoff::OrHash,
                   Telnyx::AI::HangupTool::OrHash,
@@ -360,7 +365,8 @@ module Telnyx
                   Telnyx::AI::AssistantTool::Refer::OrHash,
                   Telnyx::AI::AssistantTool::SendDtmf::OrHash,
                   Telnyx::AI::AssistantTool::SendMessage::OrHash,
-                  Telnyx::AI::AssistantTool::SkipTurn::OrHash
+                  Telnyx::AI::AssistantTool::SkipTurn::OrHash,
+                  Telnyx::AI::AssistantTool::Pay::OrHash
                 )
               ],
             transcription: Telnyx::AI::TranscriptionSettings::OrHash,
@@ -498,6 +504,7 @@ module Telnyx
                 T::Array[
                   T.any(
                     Telnyx::AI::InferenceEmbeddingWebhookToolParams,
+                    Telnyx::AI::AssistantTool::ClientSideTool,
                     Telnyx::AI::RetrievalTool,
                     Telnyx::AI::AssistantTool::Handoff,
                     Telnyx::AI::HangupTool,
@@ -506,7 +513,8 @@ module Telnyx
                     Telnyx::AI::AssistantTool::Refer,
                     Telnyx::AI::AssistantTool::SendDtmf,
                     Telnyx::AI::AssistantTool::SendMessage,
-                    Telnyx::AI::AssistantTool::SkipTurn
+                    Telnyx::AI::AssistantTool::SkipTurn,
+                    Telnyx::AI::AssistantTool::Pay
                   )
                 ],
               transcription: Telnyx::AI::TranscriptionSettings,

data/rbi/telnyx/models/ai/assistant_tool.rbi

@@ -13,6 +13,7 @@ module Telnyx
           T.type_alias do
             T.any(
               Telnyx::AI::InferenceEmbeddingWebhookToolParams,
+              Telnyx::AI::AssistantTool::ClientSideTool,
               Telnyx::AI::RetrievalTool,
               Telnyx::AI::AssistantTool::Handoff,
               Telnyx::AI::HangupTool,
@@ -21,10 +22,231 @@ module Telnyx
               Telnyx::AI::AssistantTool::Refer,
               Telnyx::AI::AssistantTool::SendDtmf,
               Telnyx::AI::AssistantTool::SendMessage,
-              Telnyx::AI::AssistantTool::SkipTurn
+              Telnyx::AI::AssistantTool::SkipTurn,
+              Telnyx::AI::AssistantTool::Pay
             )
           end
 
+        class ClientSideTool < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::AI::AssistantTool::ClientSideTool,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(Telnyx::AI::AssistantTool::ClientSideTool::ClientSideTool)
+          end
+          attr_reader :client_side_tool
+
+          sig do
+            params(
+              client_side_tool:
+                Telnyx::AI::AssistantTool::ClientSideTool::ClientSideTool::OrHash
+            ).void
+          end
+          attr_writer :client_side_tool
+
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          sig do
+            params(
+              client_side_tool:
+                Telnyx::AI::AssistantTool::ClientSideTool::ClientSideTool::OrHash,
+              type: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(client_side_tool:, type: :client_side_tool)
+          end
+
+          sig do
+            override.returns(
+              {
+                client_side_tool:
+                  Telnyx::AI::AssistantTool::ClientSideTool::ClientSideTool,
+                type: Symbol
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class ClientSideTool < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::AI::AssistantTool::ClientSideTool::ClientSideTool,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # The description of the tool.
+            sig { returns(String) }
+            attr_accessor :description
+
+            # The name of the tool.
+            sig { returns(String) }
+            attr_accessor :name
+
+            # The parameters the tool accepts, described as a JSON Schema object. See the
+            # [JSON Schema reference](https://json-schema.org/understanding-json-schema) for
+            # documentation about the format
+            sig do
+              returns(
+                Telnyx::AI::AssistantTool::ClientSideTool::ClientSideTool::Parameters
+              )
+            end
+            attr_reader :parameters
+
+            sig do
+              params(
+                parameters:
+                  Telnyx::AI::AssistantTool::ClientSideTool::ClientSideTool::Parameters::OrHash
+              ).void
+            end
+            attr_writer :parameters
+
+            sig do
+              params(
+                description: String,
+                name: String,
+                parameters:
+                  Telnyx::AI::AssistantTool::ClientSideTool::ClientSideTool::Parameters::OrHash
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # The description of the tool.
+              description:,
+              # The name of the tool.
+              name:,
+              # The parameters the tool accepts, described as a JSON Schema object. See the
+              # [JSON Schema reference](https://json-schema.org/understanding-json-schema) for
+              # documentation about the format
+              parameters:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  description: String,
+                  name: String,
+                  parameters:
+                    Telnyx::AI::AssistantTool::ClientSideTool::ClientSideTool::Parameters
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class Parameters < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::AI::AssistantTool::ClientSideTool::ClientSideTool::Parameters,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              # The properties of the parameters.
+              sig { returns(T.nilable(T::Hash[Symbol, T.anything])) }
+              attr_reader :properties
+
+              sig { params(properties: T::Hash[Symbol, T.anything]).void }
+              attr_writer :properties
+
+              # The required properties of the parameters.
+              sig { returns(T.nilable(T::Array[String])) }
+              attr_reader :required
+
+              sig { params(required: T::Array[String]).void }
+              attr_writer :required
+
+              sig do
+                returns(
+                  T.nilable(
+                    Telnyx::AI::AssistantTool::ClientSideTool::ClientSideTool::Parameters::Type::OrSymbol
+                  )
+                )
+              end
+              attr_reader :type
+
+              sig do
+                params(
+                  type:
+                    Telnyx::AI::AssistantTool::ClientSideTool::ClientSideTool::Parameters::Type::OrSymbol
+                ).void
+              end
+              attr_writer :type
+
+              # The parameters the tool accepts, described as a JSON Schema object. See the
+              # [JSON Schema reference](https://json-schema.org/understanding-json-schema) for
+              # documentation about the format
+              sig do
+                params(
+                  properties: T::Hash[Symbol, T.anything],
+                  required: T::Array[String],
+                  type:
+                    Telnyx::AI::AssistantTool::ClientSideTool::ClientSideTool::Parameters::Type::OrSymbol
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                # The properties of the parameters.
+                properties: nil,
+                # The required properties of the parameters.
+                required: nil,
+                type: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    properties: T::Hash[Symbol, T.anything],
+                    required: T::Array[String],
+                    type:
+                      Telnyx::AI::AssistantTool::ClientSideTool::ClientSideTool::Parameters::Type::OrSymbol
+                  }
+                )
+              end
+              def to_hash
+              end
+
+              module Type
+                extend Telnyx::Internal::Type::Enum
+
+                TaggedSymbol =
+                  T.type_alias do
+                    T.all(
+                      Symbol,
+                      Telnyx::AI::AssistantTool::ClientSideTool::ClientSideTool::Parameters::Type
+                    )
+                  end
+                OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+                OBJECT =
+                  T.let(
+                    :object,
+                    Telnyx::AI::AssistantTool::ClientSideTool::ClientSideTool::Parameters::Type::TaggedSymbol
+                  )
+
+                sig do
+                  override.returns(
+                    T::Array[
+                      Telnyx::AI::AssistantTool::ClientSideTool::ClientSideTool::Parameters::Type::TaggedSymbol
+                    ]
+                  )
+                end
+                def self.values
+                end
+              end
+            end
+          end
+        end
+
         class Handoff < Telnyx::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
@@ -2071,6 +2293,41 @@ module Telnyx
           end
         end
 
+        class Pay < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(Telnyx::AI::AssistantTool::Pay, Telnyx::Internal::AnyHash)
+            end
+
+          sig { returns(Telnyx::AI::PayToolParams) }
+          attr_reader :pay
+
+          sig { params(pay: Telnyx::AI::PayToolParams::OrHash).void }
+          attr_writer :pay
+
+          sig { returns(Symbol) }
+          attr_accessor :type
+
+          # (BETA) The pay tool allows the assistant to collect card payments from the
+          # caller via DTMF during the conversation. Recording is automatically paused while
+          # the pay tool is active and resumes when the payment flow completes. The
+          # connector_name must reference a pay connector configured in the Telnyx API.
+          sig do
+            params(
+              pay: Telnyx::AI::PayToolParams::OrHash,
+              type: Symbol
+            ).returns(T.attached_class)
+          end
+          def self.new(pay:, type: :pay)
+          end
+
+          sig do
+            override.returns({ pay: Telnyx::AI::PayToolParams, type: Symbol })
+          end
+          def to_hash
+          end
+        end
+
         sig { override.returns(T::Array[Telnyx::AI::AssistantTool::Variants]) }
         def self.variants
         end