telnyx 5.112.0 → 5.113.0

data/rbi/telnyx/models/fax_create_params.rbi

@@ -51,16 +51,18 @@ module Telnyx
       attr_writer :from_display_name
 
       # The media_name used for the fax's media. Must point to a file previously
-      # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
-      # and media_url/contents can't be submitted together.
+      # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
+      # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
+      # media_url/contents can't be submitted together.
       sig { returns(T.nilable(String)) }
       attr_reader :media_name
 
       sig { params(media_name: String).void }
       attr_writer :media_name
 
-      # The URL (or list of URLs) to the PDF used for the fax's media. media_url and
-      # media_name/contents can't be submitted together.
+      # The URL (or list of URLs) to the fax document. Supported formats: PDF, TIFF,
+      # JPEG, PNG, DOC, DOCX, RTF, and TXT. media_url and media_name/contents can't be
+      # submitted together.
       sig { returns(T.nilable(String)) }
       attr_reader :media_url
 
@@ -166,11 +168,13 @@ module Telnyx
         # number in the `from` field.
         from_display_name: nil,
         # The media_name used for the fax's media. Must point to a file previously
-        # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
-        # and media_url/contents can't be submitted together.
+        # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
+        # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
+        # media_url/contents can't be submitted together.
         media_name: nil,
-        # The URL (or list of URLs) to the PDF used for the fax's media. media_url and
-        # media_name/contents can't be submitted together.
+        # The URL (or list of URLs) to the fax document. Supported formats: PDF, TIFF,
+        # JPEG, PNG, DOC, DOCX, RTF, and TXT. media_url and media_name/contents can't be
+        # submitted together.
         media_url: nil,
         # The flag to enable monochrome, true black and white fax results.
         monochrome: nil,

data/rbi/telnyx/models/fax_delivered.rbi

@@ -222,8 +222,9 @@ module Telnyx
           attr_writer :from
 
           # The media_name used for the fax's media. Must point to a file previously
-          # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
-          # and media_url/contents can't be submitted together.
+          # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
+          # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
+          # media_url/contents can't be submitted together.
           sig { returns(T.nilable(String)) }
           attr_reader :media_name
 
@@ -307,8 +308,9 @@ module Telnyx
             # The phone number, in E.164 format, the fax will be sent from.
             from: nil,
             # The media_name used for the fax's media. Must point to a file previously
-            # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
-            # and media_url/contents can't be submitted together.
+            # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
+            # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
+            # media_url/contents can't be submitted together.
             media_name: nil,
             # The original URL to the PDF used for the fax's media. If media_name was
             # supplied, this is omitted

data/rbi/telnyx/models/fax_failed.rbi

@@ -219,8 +219,9 @@ module Telnyx
           attr_writer :from
 
           # The media_name used for the fax's media. Must point to a file previously
-          # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
-          # and media_url/contents can't be submitted together.
+          # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
+          # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
+          # media_url/contents can't be submitted together.
           sig { returns(T.nilable(String)) }
           attr_reader :media_name
 
@@ -294,8 +295,9 @@ module Telnyx
             # The phone number, in E.164 format, the fax will be sent from.
             from: nil,
             # The media_name used for the fax's media. Must point to a file previously
-            # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
-            # and media_url/contents can't be submitted together.
+            # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
+            # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
+            # media_url/contents can't be submitted together.
             media_name: nil,
             # The original URL to the PDF used for the fax's media. If media_name was
             # supplied, this is omitted

data/rbi/telnyx/models/fax_media_processed.rbi

@@ -222,8 +222,9 @@ module Telnyx
           attr_writer :from
 
           # The media_name used for the fax's media. Must point to a file previously
-          # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
-          # and media_url/contents can't be submitted together.
+          # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
+          # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
+          # media_url/contents can't be submitted together.
           sig { returns(T.nilable(String)) }
           attr_reader :media_name
 
@@ -297,8 +298,9 @@ module Telnyx
             # The phone number, in E.164 format, the fax will be sent from.
             from: nil,
             # The media_name used for the fax's media. Must point to a file previously
-            # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
-            # and media_url/contents can't be submitted together.
+            # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
+            # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
+            # media_url/contents can't be submitted together.
             media_name: nil,
             # The original URL to the PDF used for the fax's media. If media_name was
             # supplied, this is omitted

data/rbi/telnyx/models/fax_queued.rbi

@@ -201,8 +201,9 @@ module Telnyx
           attr_writer :from
 
           # The media_name used for the fax's media. Must point to a file previously
-          # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
-          # and media_url/contents can't be submitted together.
+          # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
+          # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
+          # media_url/contents can't be submitted together.
           sig { returns(T.nilable(String)) }
           attr_reader :media_name
 
@@ -272,8 +273,9 @@ module Telnyx
             # The phone number, in E.164 format, the fax will be sent from.
             from: nil,
             # The media_name used for the fax's media. Must point to a file previously
-            # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
-            # and media_url/contents can't be submitted together.
+            # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
+            # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
+            # media_url/contents can't be submitted together.
             media_name: nil,
             # The original URL to the PDF used for the fax's media. If media_name was
             # supplied, this is omitted

data/rbi/telnyx/models/fax_sending_started.rbi

@@ -222,8 +222,9 @@ module Telnyx
           attr_writer :from
 
           # The media_name used for the fax's media. Must point to a file previously
-          # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
-          # and media_url/contents can't be submitted together.
+          # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
+          # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
+          # media_url/contents can't be submitted together.
           sig { returns(T.nilable(String)) }
           attr_reader :media_name
 
@@ -297,8 +298,9 @@ module Telnyx
             # The phone number, in E.164 format, the fax will be sent from.
             from: nil,
             # The media_name used for the fax's media. Must point to a file previously
-            # uploaded to api.telnyx.com/v2/media by the same user/organization. media_name
-            # and media_url/contents can't be submitted together.
+            # uploaded to api.telnyx.com/v2/media by the same user/organization. Supported
+            # formats: PDF, TIFF, JPEG, PNG, DOC, DOCX, RTF, and TXT. media_name and
+            # media_url/contents can't be submitted together.
             media_name: nil,
             # The original URL to the PDF used for the fax's media. If media_name was
             # supplied, this is omitted

data/rbi/telnyx/models/model_metadata.rbi

@@ -0,0 +1,272 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class ModelMetadata < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Telnyx::ModelMetadata, Telnyx::Internal::AnyHash) }
+
+      # 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 { returns(Telnyx::ModelMetadata::Tier::TaggedSymbol) }
+      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::ModelMetadata::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::ModelMetadata::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 { T.all(Symbol, Telnyx::ModelMetadata::Tier) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SMALL = T.let(:small, Telnyx::ModelMetadata::Tier::TaggedSymbol)
+        MEDIUM = T.let(:medium, Telnyx::ModelMetadata::Tier::TaggedSymbol)
+        LARGE = T.let(:large, Telnyx::ModelMetadata::Tier::TaggedSymbol)
+        UNLISTED = T.let(:unlisted, Telnyx::ModelMetadata::Tier::TaggedSymbol)
+
+        sig do
+          override.returns(T::Array[Telnyx::ModelMetadata::Tier::TaggedSymbol])
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/network_list_interfaces_response.rbi

@@ -2,7 +2,7 @@
 
 module Telnyx
   module Models
-    class NetworkListInterfacesResponse < Telnyx::Models::Record
+    class NetworkListInterfacesResponse < Telnyx::Internal::Type::BaseModel
       OrHash =
         T.type_alias do
           T.any(
@@ -11,13 +11,190 @@ module Telnyx
           )
         end
 
-      sig { returns(T.attached_class) }
-      def self.new
+      # A user specified name for the interface.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # The id of the network associated with the interface.
+      sig { returns(T.nilable(String)) }
+      attr_reader :network_id
+
+      sig { params(network_id: String).void }
+      attr_writer :network_id
+
+      sig do
+        returns(
+          T.nilable(Telnyx::Models::NetworkListInterfacesResponse::Region)
+        )
+      end
+      attr_reader :region
+
+      sig do
+        params(
+          region: Telnyx::Models::NetworkListInterfacesResponse::Region::OrHash
+        ).void
       end
+      attr_writer :region
+
+      # The region interface is deployed to.
+      sig { returns(T.nilable(String)) }
+      attr_reader :region_code
+
+      sig { params(region_code: String).void }
+      attr_writer :region_code
+
+      # Identifies the resource.
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # ISO 8601 formatted date-time indicating when the resource was created.
+      sig { returns(T.nilable(String)) }
+      attr_reader :created_at
+
+      sig { params(created_at: String).void }
+      attr_writer :created_at
+
+      # Identifies the type of the resource.
+      sig { returns(T.nilable(String)) }
+      attr_reader :record_type
+
+      sig { params(record_type: String).void }
+      attr_writer :record_type
+
+      # The current status of the interface deployment.
+      sig { returns(T.nilable(Telnyx::InterfaceStatus::TaggedSymbol)) }
+      attr_reader :status
+
+      sig { params(status: Telnyx::InterfaceStatus::OrSymbol).void }
+      attr_writer :status
+
+      # Identifies the type of the interface.
+      sig { returns(T.nilable(String)) }
+      attr_reader :type
+
+      sig { params(type: String).void }
+      attr_writer :type
+
+      # ISO 8601 formatted date-time indicating when the resource was updated.
+      sig { returns(T.nilable(String)) }
+      attr_reader :updated_at
+
+      sig { params(updated_at: String).void }
+      attr_writer :updated_at
 
-      sig { override.returns({}) }
+      sig do
+        params(
+          id: String,
+          created_at: String,
+          name: String,
+          network_id: String,
+          record_type: String,
+          region: Telnyx::Models::NetworkListInterfacesResponse::Region::OrHash,
+          region_code: String,
+          status: Telnyx::InterfaceStatus::OrSymbol,
+          type: String,
+          updated_at: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Identifies the resource.
+        id: nil,
+        # ISO 8601 formatted date-time indicating when the resource was created.
+        created_at: nil,
+        # A user specified name for the interface.
+        name: nil,
+        # The id of the network associated with the interface.
+        network_id: nil,
+        # Identifies the type of the resource.
+        record_type: nil,
+        region: nil,
+        # The region interface is deployed to.
+        region_code: nil,
+        # The current status of the interface deployment.
+        status: nil,
+        # Identifies the type of the interface.
+        type: nil,
+        # ISO 8601 formatted date-time indicating when the resource was updated.
+        updated_at: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: String,
+            name: String,
+            network_id: String,
+            record_type: String,
+            region: Telnyx::Models::NetworkListInterfacesResponse::Region,
+            region_code: String,
+            status: Telnyx::InterfaceStatus::TaggedSymbol,
+            type: String,
+            updated_at: String
+          }
+        )
+      end
       def to_hash
       end
+
+      class Region < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::NetworkListInterfacesResponse::Region,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Region code of the interface.
+        sig { returns(T.nilable(String)) }
+        attr_reader :code
+
+        sig { params(code: String).void }
+        attr_writer :code
+
+        # Region name of the interface.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # Identifies the type of the resource.
+        sig { returns(T.nilable(String)) }
+        attr_reader :record_type
+
+        sig { params(record_type: String).void }
+        attr_writer :record_type
+
+        sig do
+          params(code: String, name: String, record_type: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Region code of the interface.
+          code: nil,
+          # Region name of the interface.
+          name: nil,
+          # Identifies the type of the resource.
+          record_type: nil
+        )
+        end
+
+        sig do
+          override.returns({ code: String, name: String, record_type: String })
+        end
+        def to_hash
+        end
+      end
     end
   end
 end