telnyx 5.126.0 → 5.128.0

data/rbi/telnyx/models/ai_retrieve_models_response.rbi

@@ -11,7 +11,7 @@ module Telnyx
           )
         end
 
-      sig { returns(T::Array[Telnyx::ModelMetadata]) }
+      sig { returns(T::Array[Telnyx::Models::AIRetrieveModelsResponse::Data]) }
       attr_accessor :data
 
       sig { returns(T.nilable(String)) }
@@ -22,7 +22,8 @@ module Telnyx
 
       sig do
         params(
-          data: T::Array[Telnyx::ModelMetadata::OrHash],
+          data:
+            T::Array[Telnyx::Models::AIRetrieveModelsResponse::Data::OrHash],
           object: String
         ).returns(T.attached_class)
       end
@@ -31,11 +32,317 @@ module Telnyx
 
       sig do
         override.returns(
-          { data: T::Array[Telnyx::ModelMetadata], object: String }
+          {
+            data: T::Array[Telnyx::Models::AIRetrieveModelsResponse::Data],
+            object: String
+          }
         )
       end
       def to_hash
       end
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::AIRetrieveModelsResponse::Data,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Model identifier. For open-source models, follows the
+        # `{organization}/{model_name}` convention from Hugging Face (e.g.
+        # `moonshotai/Kimi-K2.6`).
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Maximum total tokens (prompt + completion) supported by the model in a single
+        # request.
+        sig { returns(Integer) }
+        attr_accessor :context_length
+
+        # Timestamp at which the model was registered on Telnyx Inference (ISO 8601).
+        sig { returns(Time) }
+        attr_accessor :created
+
+        # ISO language codes the model supports (e.g. `en`, `es`).
+        sig { returns(T::Array[String]) }
+        attr_accessor :languages
+
+        # License the model is distributed under, e.g. `Apache 2.0`, `MIT`,
+        # `Llama 3 Community License`.
+        sig { returns(String) }
+        attr_accessor :license
+
+        # Organization that originally published the model, matching the prefix of `id`
+        # for open-source models.
+        sig { returns(String) }
+        attr_accessor :organization
+
+        # Owner of the model. `Telnyx` for Telnyx-hosted open-source models, the upstream
+        # provider name for proxied models, or the Telnyx organization id for fine-tuned
+        # models.
+        sig { returns(String) }
+        attr_accessor :owned_by
+
+        # Total parameter count of the model.
+        sig { returns(Integer) }
+        attr_accessor :parameters
+
+        # Billing tier the model belongs to. Used together with `pricing` to determine
+        # cost per 1M tokens.
+        sig do
+          returns(
+            Telnyx::Models::AIRetrieveModelsResponse::Data::Tier::TaggedSymbol
+          )
+        end
+        attr_accessor :tier
+
+        # Base model the fine-tuned model was trained from. Only set for fine-tuned
+        # models.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :base_model
+
+        # Short, human-readable summary of what the model is best suited for.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        # Whether the model can be used as a base for a fine-tuning job via
+        # `POST /v2/ai/fine_tuning/jobs`.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_fine_tunable
+
+        sig { params(is_fine_tunable: T::Boolean).void }
+        attr_writer :is_fine_tunable
+
+        # Whether the model accepts image inputs in chat completions (multimodal vision
+        # support).
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_vision_supported
+
+        sig { params(is_vision_supported: T::Boolean).void }
+        attr_writer :is_vision_supported
+
+        # Maximum number of completion (output) tokens the model will generate per
+        # request. `null` if unconstrained beyond `context_length`.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :max_completion_tokens
+
+        # Object type. Always `model`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :object
+
+        sig { params(object: String).void }
+        attr_writer :object
+
+        # Human-readable parameter count, e.g. `1.0T`, `753.9B`, `8B`.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :parameters_str
+
+        # Mapping of token kind to price, as strings to preserve precision. Typical keys
+        # are `prompt`, `cached_prompt`, and `completion`. When pricing is available the
+        # block also includes `currency` (ISO 4217 code matching the account's configured
+        # billing currency) and `unit` (the denomination the prices are quoted in,
+        # currently always `1M_tokens` for token-priced models).
+        sig { returns(T.nilable(T::Hash[Symbol, String])) }
+        attr_reader :pricing
+
+        sig { params(pricing: T::Hash[Symbol, String]).void }
+        attr_writer :pricing
+
+        # Whether Telnyx currently recommends this model as the LLM powering a Telnyx AI
+        # Assistant.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :recommended_for_assistants
+
+        sig { params(recommended_for_assistants: T::Boolean).void }
+        attr_writer :recommended_for_assistants
+
+        # Public region names where the model is currently deployed (e.g. `us-central-1`,
+        # `eu-central-1`).
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :regions
+
+        sig { params(regions: T::Array[String]).void }
+        attr_writer :regions
+
+        # Primary task the model is intended for, e.g. `text-generation`,
+        # `audio-text-to-text`, `feature-extraction` (embeddings).
+        sig { returns(T.nilable(String)) }
+        attr_reader :task
+
+        sig { params(task: String).void }
+        attr_writer :task
+
+        # Metadata for a model available on Telnyx Inference. Returned by
+        # `GET /v2/ai/openai/models` (and the deprecated `GET /v2/ai/models`). Open-source
+        # models live under their Hugging Face organization (e.g. `moonshotai/Kimi-K2.6`,
+        # `zai-org/GLM-5.1-FP8`, `MiniMaxAI/MiniMax-M2.7`); fine-tuned models are owned by
+        # the Telnyx organization that trained them.
+        sig do
+          params(
+            id: String,
+            context_length: Integer,
+            created: Time,
+            languages: T::Array[String],
+            license: String,
+            organization: String,
+            owned_by: String,
+            parameters: Integer,
+            tier:
+              Telnyx::Models::AIRetrieveModelsResponse::Data::Tier::OrSymbol,
+            base_model: T.nilable(String),
+            description: T.nilable(String),
+            is_fine_tunable: T::Boolean,
+            is_vision_supported: T::Boolean,
+            max_completion_tokens: T.nilable(Integer),
+            object: String,
+            parameters_str: T.nilable(String),
+            pricing: T::Hash[Symbol, String],
+            recommended_for_assistants: T::Boolean,
+            regions: T::Array[String],
+            task: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Model identifier. For open-source models, follows the
+          # `{organization}/{model_name}` convention from Hugging Face (e.g.
+          # `moonshotai/Kimi-K2.6`).
+          id:,
+          # Maximum total tokens (prompt + completion) supported by the model in a single
+          # request.
+          context_length:,
+          # Timestamp at which the model was registered on Telnyx Inference (ISO 8601).
+          created:,
+          # ISO language codes the model supports (e.g. `en`, `es`).
+          languages:,
+          # License the model is distributed under, e.g. `Apache 2.0`, `MIT`,
+          # `Llama 3 Community License`.
+          license:,
+          # Organization that originally published the model, matching the prefix of `id`
+          # for open-source models.
+          organization:,
+          # Owner of the model. `Telnyx` for Telnyx-hosted open-source models, the upstream
+          # provider name for proxied models, or the Telnyx organization id for fine-tuned
+          # models.
+          owned_by:,
+          # Total parameter count of the model.
+          parameters:,
+          # Billing tier the model belongs to. Used together with `pricing` to determine
+          # cost per 1M tokens.
+          tier:,
+          # Base model the fine-tuned model was trained from. Only set for fine-tuned
+          # models.
+          base_model: nil,
+          # Short, human-readable summary of what the model is best suited for.
+          description: nil,
+          # Whether the model can be used as a base for a fine-tuning job via
+          # `POST /v2/ai/fine_tuning/jobs`.
+          is_fine_tunable: nil,
+          # Whether the model accepts image inputs in chat completions (multimodal vision
+          # support).
+          is_vision_supported: nil,
+          # Maximum number of completion (output) tokens the model will generate per
+          # request. `null` if unconstrained beyond `context_length`.
+          max_completion_tokens: nil,
+          # Object type. Always `model`.
+          object: nil,
+          # Human-readable parameter count, e.g. `1.0T`, `753.9B`, `8B`.
+          parameters_str: nil,
+          # Mapping of token kind to price, as strings to preserve precision. Typical keys
+          # are `prompt`, `cached_prompt`, and `completion`. When pricing is available the
+          # block also includes `currency` (ISO 4217 code matching the account's configured
+          # billing currency) and `unit` (the denomination the prices are quoted in,
+          # currently always `1M_tokens` for token-priced models).
+          pricing: nil,
+          # Whether Telnyx currently recommends this model as the LLM powering a Telnyx AI
+          # Assistant.
+          recommended_for_assistants: nil,
+          # Public region names where the model is currently deployed (e.g. `us-central-1`,
+          # `eu-central-1`).
+          regions: nil,
+          # Primary task the model is intended for, e.g. `text-generation`,
+          # `audio-text-to-text`, `feature-extraction` (embeddings).
+          task: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              context_length: Integer,
+              created: Time,
+              languages: T::Array[String],
+              license: String,
+              organization: String,
+              owned_by: String,
+              parameters: Integer,
+              tier:
+                Telnyx::Models::AIRetrieveModelsResponse::Data::Tier::TaggedSymbol,
+              base_model: T.nilable(String),
+              description: T.nilable(String),
+              is_fine_tunable: T::Boolean,
+              is_vision_supported: T::Boolean,
+              max_completion_tokens: T.nilable(Integer),
+              object: String,
+              parameters_str: T.nilable(String),
+              pricing: T::Hash[Symbol, String],
+              recommended_for_assistants: T::Boolean,
+              regions: T::Array[String],
+              task: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Billing tier the model belongs to. Used together with `pricing` to determine
+        # cost per 1M tokens.
+        module Tier
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::Models::AIRetrieveModelsResponse::Data::Tier
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SMALL =
+            T.let(
+              :small,
+              Telnyx::Models::AIRetrieveModelsResponse::Data::Tier::TaggedSymbol
+            )
+          MEDIUM =
+            T.let(
+              :medium,
+              Telnyx::Models::AIRetrieveModelsResponse::Data::Tier::TaggedSymbol
+            )
+          LARGE =
+            T.let(
+              :large,
+              Telnyx::Models::AIRetrieveModelsResponse::Data::Tier::TaggedSymbol
+            )
+          UNLISTED =
+            T.let(
+              :unlisted,
+              Telnyx::Models::AIRetrieveModelsResponse::Data::Tier::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Models::AIRetrieveModelsResponse::Data::Tier::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
     end
   end
 end

data/rbi/telnyx/models/billing_address.rbi

@@ -8,27 +8,23 @@ module Telnyx
           T.any(Telnyx::BillingAddress, Telnyx::Internal::AnyHash)
         end
 
-      # State or province
+      # State or province code (e.g. `IL`, `ON`).
       sig { returns(String) }
       attr_accessor :administrative_area
 
-      # City name
       sig { returns(String) }
       attr_accessor :city
 
-      # Country name (e.g., United States)
+      # ISO 3166-1 alpha-2 code (currently `US` or `CA`).
       sig { returns(String) }
       attr_accessor :country
 
-      # ZIP or postal code
       sig { returns(String) }
       attr_accessor :postal_code
 
-      # Street address
       sig { returns(String) }
       attr_accessor :street_address
 
-      # Additional address line (suite, apt, etc.)
       sig { returns(T.nilable(String)) }
       attr_accessor :extended_address
 
@@ -43,17 +39,13 @@ module Telnyx
         ).returns(T.attached_class)
       end
       def self.new(
-        # State or province
+        # State or province code (e.g. `IL`, `ON`).
         administrative_area:,
-        # City name
         city:,
-        # Country name (e.g., United States)
+        # ISO 3166-1 alpha-2 code (currently `US` or `CA`).
         country:,
-        # ZIP or postal code
         postal_code:,
-        # Street address
         street_address:,
-        # Additional address line (suite, apt, etc.)
         extended_address: nil
       )
       end

data/rbi/telnyx/models/billing_contact.rbi

@@ -8,19 +8,16 @@ module Telnyx
           T.any(Telnyx::BillingContact, Telnyx::Internal::AnyHash)
         end
 
-      # Contact's email address
       sig { returns(String) }
       attr_accessor :email
 
-      # Contact's first name
       sig { returns(String) }
       attr_accessor :first_name
 
-      # Contact's last name
       sig { returns(String) }
       attr_accessor :last_name
 
-      # Contact's phone number (10-15 digits)
+      # E.164 format with leading `+`.
       sig { returns(String) }
       attr_accessor :phone_number
 
@@ -33,13 +30,10 @@ module Telnyx
         ).returns(T.attached_class)
       end
       def self.new(
-        # Contact's email address
         email:,
-        # Contact's first name
         first_name:,
-        # Contact's last name
         last_name:,
-        # Contact's phone number (10-15 digits)
+        # E.164 format with leading `+`.
         phone_number:
       )
       end

data/rbi/telnyx/models/call_dial_params.rbi

@@ -1891,7 +1891,7 @@ module Telnyx
                 Telnyx::RimeVoiceSettings,
                 Telnyx::ResembleVoiceSettings,
                 Telnyx::CallDialParams::ConversationRelayConfig::VoiceSettings::Inworld,
-                Telnyx::XaiVoiceSettings
+                Telnyx::CallDialParams::ConversationRelayConfig::VoiceSettings::Xai
               )
             )
           )
@@ -1910,7 +1910,7 @@ module Telnyx
                 Telnyx::RimeVoiceSettings::OrHash,
                 Telnyx::ResembleVoiceSettings::OrHash,
                 Telnyx::CallDialParams::ConversationRelayConfig::VoiceSettings::Inworld::OrHash,
-                Telnyx::XaiVoiceSettings::OrHash
+                Telnyx::CallDialParams::ConversationRelayConfig::VoiceSettings::Xai::OrHash
               )
           ).void
         end
@@ -1956,7 +1956,7 @@ module Telnyx
                 Telnyx::RimeVoiceSettings::OrHash,
                 Telnyx::ResembleVoiceSettings::OrHash,
                 Telnyx::CallDialParams::ConversationRelayConfig::VoiceSettings::Inworld::OrHash,
-                Telnyx::XaiVoiceSettings::OrHash
+                Telnyx::CallDialParams::ConversationRelayConfig::VoiceSettings::Xai::OrHash
               )
           ).returns(T.attached_class)
         end
@@ -2071,7 +2071,7 @@ module Telnyx
                   Telnyx::RimeVoiceSettings,
                   Telnyx::ResembleVoiceSettings,
                   Telnyx::CallDialParams::ConversationRelayConfig::VoiceSettings::Inworld,
-                  Telnyx::XaiVoiceSettings
+                  Telnyx::CallDialParams::ConversationRelayConfig::VoiceSettings::Xai
                 )
             }
           )
@@ -2532,7 +2532,7 @@ module Telnyx
                   Telnyx::RimeVoiceSettings,
                   Telnyx::ResembleVoiceSettings,
                   Telnyx::CallDialParams::ConversationRelayConfig::Language::VoiceSettings::Inworld,
-                  Telnyx::XaiVoiceSettings
+                  Telnyx::CallDialParams::ConversationRelayConfig::Language::VoiceSettings::Xai
                 )
               )
             )
@@ -2551,7 +2551,7 @@ module Telnyx
                   Telnyx::RimeVoiceSettings::OrHash,
                   Telnyx::ResembleVoiceSettings::OrHash,
                   Telnyx::CallDialParams::ConversationRelayConfig::Language::VoiceSettings::Inworld::OrHash,
-                  Telnyx::XaiVoiceSettings::OrHash
+                  Telnyx::CallDialParams::ConversationRelayConfig::Language::VoiceSettings::Xai::OrHash
                 )
             ).void
           end
@@ -2578,7 +2578,7 @@ module Telnyx
                   Telnyx::RimeVoiceSettings::OrHash,
                   Telnyx::ResembleVoiceSettings::OrHash,
                   Telnyx::CallDialParams::ConversationRelayConfig::Language::VoiceSettings::Inworld::OrHash,
-                  Telnyx::XaiVoiceSettings::OrHash
+                  Telnyx::CallDialParams::ConversationRelayConfig::Language::VoiceSettings::Xai::OrHash
                 )
             ).returns(T.attached_class)
           end
@@ -2633,7 +2633,7 @@ module Telnyx
                     Telnyx::RimeVoiceSettings,
                     Telnyx::ResembleVoiceSettings,
                     Telnyx::CallDialParams::ConversationRelayConfig::Language::VoiceSettings::Inworld,
-                    Telnyx::XaiVoiceSettings
+                    Telnyx::CallDialParams::ConversationRelayConfig::Language::VoiceSettings::Xai
                   )
               }
             )
@@ -2734,7 +2734,7 @@ module Telnyx
                   Telnyx::RimeVoiceSettings,
                   Telnyx::ResembleVoiceSettings,
                   Telnyx::CallDialParams::ConversationRelayConfig::Language::VoiceSettings::Inworld,
-                  Telnyx::XaiVoiceSettings
+                  Telnyx::CallDialParams::ConversationRelayConfig::Language::VoiceSettings::Xai
                 )
               end
 
@@ -2763,6 +2763,42 @@ module Telnyx
               end
             end
 
+            class Xai < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::CallDialParams::ConversationRelayConfig::Language::VoiceSettings::Xai,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              # Voice settings provider type
+              sig { returns(Symbol) }
+              attr_accessor :type
+
+              # Language code, or `auto` to detect automatically.
+              sig { returns(T.nilable(String)) }
+              attr_reader :language
+
+              sig { params(language: String).void }
+              attr_writer :language
+
+              sig do
+                params(language: String, type: Symbol).returns(T.attached_class)
+              end
+              def self.new(
+                # Language code, or `auto` to detect automatically.
+                language: nil,
+                # Voice settings provider type
+                type: :xai
+              )
+              end
+
+              sig { override.returns({ type: Symbol, language: String }) }
+              def to_hash
+              end
+            end
+
             sig do
               override.returns(
                 T::Array[
@@ -2868,7 +2904,7 @@ module Telnyx
                 Telnyx::RimeVoiceSettings,
                 Telnyx::ResembleVoiceSettings,
                 Telnyx::CallDialParams::ConversationRelayConfig::VoiceSettings::Inworld,
-                Telnyx::XaiVoiceSettings
+                Telnyx::CallDialParams::ConversationRelayConfig::VoiceSettings::Xai
               )
             end
 
@@ -2897,6 +2933,42 @@ module Telnyx
             end
           end
 
+          class Xai < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::CallDialParams::ConversationRelayConfig::VoiceSettings::Xai,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # Voice settings provider type
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # Language code, or `auto` to detect automatically.
+            sig { returns(T.nilable(String)) }
+            attr_reader :language
+
+            sig { params(language: String).void }
+            attr_writer :language
+
+            sig do
+              params(language: String, type: Symbol).returns(T.attached_class)
+            end
+            def self.new(
+              # Language code, or `auto` to detect automatically.
+              language: nil,
+              # Voice settings provider type
+              type: :xai
+            )
+            end
+
+            sig { override.returns({ type: Symbol, language: String }) }
+            def to_hash
+            end
+          end
+
           sig do
             override.returns(
               T::Array[

data/rbi/telnyx/models/call_reason_list_params.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class CallReasonListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::CallReasonListParams, Telnyx::Internal::AnyHash)
+        end
+
+      # 1-based page number. Out-of-range values return an empty page with correct meta.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_number
+
+      sig { params(page_number: Integer).void }
+      attr_writer :page_number
+
+      # Items per page. Default `100` for this endpoint (the call-reason library is
+      # small and most callers want the whole list in one call). Maximum 250; values
+      # above are clamped to 250.
+      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(
+        # 1-based page number. Out-of-range values return an empty page with correct meta.
+        page_number: nil,
+        # Items per page. Default `100` for this endpoint (the call-reason library is
+        # small and most callers want the whole list in one call). Maximum 250; values
+        # above are clamped to 250.
+        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