telnyx 5.168.0 → 5.170.0

data/rbi/telnyx/models/connection_retrieve_count_response.rbi

@@ -0,0 +1,353 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class ConnectionRetrieveCountResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::ConnectionRetrieveCountResponse,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Telnyx::Models::ConnectionRetrieveCountResponse::Data) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: Telnyx::Models::ConnectionRetrieveCountResponse::Data::OrHash
+        ).void
+      end
+      attr_writer :data
+
+      sig do
+        params(
+          data: Telnyx::Models::ConnectionRetrieveCountResponse::Data::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(data:)
+      end
+
+      sig do
+        override.returns(
+          { data: Telnyx::Models::ConnectionRetrieveCountResponse::Data }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::ConnectionRetrieveCountResponse::Data,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Counts of the authenticated user's connections, grouped by connection type.
+        # Forward-only connections are excluded.
+        sig do
+          returns(Telnyx::Models::ConnectionRetrieveCountResponse::Data::Counts)
+        end
+        attr_reader :counts
+
+        sig do
+          params(
+            counts:
+              Telnyx::Models::ConnectionRetrieveCountResponse::Data::Counts::OrHash
+          ).void
+        end
+        attr_writer :counts
+
+        # Connection limits that apply to the user. Contains a single global_limit when a
+        # global connection limit applies, or per-type limits (standard_limit, texml_limit
+        # and uac_limit) when the user has per-type connection count capabilities.
+        sig do
+          returns(
+            Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::Variants
+          )
+        end
+        attr_accessor :limits
+
+        # Identifies the type of the resource.
+        sig { returns(String) }
+        attr_accessor :record_type
+
+        sig do
+          params(
+            counts:
+              Telnyx::Models::ConnectionRetrieveCountResponse::Data::Counts::OrHash,
+            limits:
+              T.any(
+                Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::GlobalConnectionLimit::OrHash,
+                Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::PerTypeConnectionLimits::OrHash
+              ),
+            record_type: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Counts of the authenticated user's connections, grouped by connection type.
+          # Forward-only connections are excluded.
+          counts:,
+          # Connection limits that apply to the user. Contains a single global_limit when a
+          # global connection limit applies, or per-type limits (standard_limit, texml_limit
+          # and uac_limit) when the user has per-type connection count capabilities.
+          limits:,
+          # Identifies the type of the resource.
+          record_type:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              counts:
+                Telnyx::Models::ConnectionRetrieveCountResponse::Data::Counts,
+              limits:
+                Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::Variants,
+              record_type: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Counts < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::ConnectionRetrieveCountResponse::Data::Counts,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Number of Call Control applications.
+          sig { returns(Integer) }
+          attr_accessor :call_control_applications
+
+          # Number of credential connections.
+          sig { returns(Integer) }
+          attr_accessor :credential_connections
+
+          # Number of external connections.
+          sig { returns(Integer) }
+          attr_accessor :external_connections
+
+          # Number of Fax applications.
+          sig { returns(Integer) }
+          attr_accessor :fax_connections
+
+          # Number of FQDN connections.
+          sig { returns(Integer) }
+          attr_accessor :fqdn_connections
+
+          # Number of IP connections.
+          sig { returns(Integer) }
+          attr_accessor :ip_connections
+
+          # Number of Microsoft Teams SBC (direct routing) connections.
+          sig { returns(Integer) }
+          attr_accessor :microsoft_teams_sbc_connections
+
+          # Number of mobile voice (IMS) connections.
+          sig { returns(Integer) }
+          attr_accessor :mobile_voice_connections
+
+          # Number of Microsoft Operator Connect connections.
+          sig { returns(Integer) }
+          attr_accessor :operator_connect_connections
+
+          # Number of TeXML applications.
+          sig { returns(Integer) }
+          attr_accessor :texml_applications
+
+          # Number of third-party provider connections.
+          sig { returns(Integer) }
+          attr_accessor :third_party_provider_connections
+
+          # Number of UAC connections.
+          sig { returns(Integer) }
+          attr_accessor :uac_connections
+
+          # Number of Zoom SBC connections.
+          sig { returns(Integer) }
+          attr_accessor :zoom_sbc_connections
+
+          # Counts of the authenticated user's connections, grouped by connection type.
+          # Forward-only connections are excluded.
+          sig do
+            params(
+              call_control_applications: Integer,
+              credential_connections: Integer,
+              external_connections: Integer,
+              fax_connections: Integer,
+              fqdn_connections: Integer,
+              ip_connections: Integer,
+              microsoft_teams_sbc_connections: Integer,
+              mobile_voice_connections: Integer,
+              operator_connect_connections: Integer,
+              texml_applications: Integer,
+              third_party_provider_connections: Integer,
+              uac_connections: Integer,
+              zoom_sbc_connections: Integer
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Number of Call Control applications.
+            call_control_applications:,
+            # Number of credential connections.
+            credential_connections:,
+            # Number of external connections.
+            external_connections:,
+            # Number of Fax applications.
+            fax_connections:,
+            # Number of FQDN connections.
+            fqdn_connections:,
+            # Number of IP connections.
+            ip_connections:,
+            # Number of Microsoft Teams SBC (direct routing) connections.
+            microsoft_teams_sbc_connections:,
+            # Number of mobile voice (IMS) connections.
+            mobile_voice_connections:,
+            # Number of Microsoft Operator Connect connections.
+            operator_connect_connections:,
+            # Number of TeXML applications.
+            texml_applications:,
+            # Number of third-party provider connections.
+            third_party_provider_connections:,
+            # Number of UAC connections.
+            uac_connections:,
+            # Number of Zoom SBC connections.
+            zoom_sbc_connections:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                call_control_applications: Integer,
+                credential_connections: Integer,
+                external_connections: Integer,
+                fax_connections: Integer,
+                fqdn_connections: Integer,
+                ip_connections: Integer,
+                microsoft_teams_sbc_connections: Integer,
+                mobile_voice_connections: Integer,
+                operator_connect_connections: Integer,
+                texml_applications: Integer,
+                third_party_provider_connections: Integer,
+                uac_connections: Integer,
+                zoom_sbc_connections: Integer
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        # Connection limits that apply to the user. Contains a single global_limit when a
+        # global connection limit applies, or per-type limits (standard_limit, texml_limit
+        # and uac_limit) when the user has per-type connection count capabilities.
+        module Limits
+          extend Telnyx::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::GlobalConnectionLimit,
+                Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::PerTypeConnectionLimits
+              )
+            end
+
+          class GlobalConnectionLimit < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::GlobalConnectionLimit,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # Maximum total number of connections allowed, when a global limit applies.
+            sig { returns(Integer) }
+            attr_accessor :global_limit
+
+            sig { params(global_limit: Integer).returns(T.attached_class) }
+            def self.new(
+              # Maximum total number of connections allowed, when a global limit applies.
+              global_limit:
+            )
+            end
+
+            sig { override.returns({ global_limit: Integer }) }
+            def to_hash
+            end
+          end
+
+          class PerTypeConnectionLimits < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::PerTypeConnectionLimits,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # Maximum number of standard connections allowed, when per-type limits apply.
+            sig { returns(Integer) }
+            attr_accessor :standard_limit
+
+            # Maximum number of TeXML applications allowed, when per-type limits apply.
+            sig { returns(Integer) }
+            attr_accessor :texml_limit
+
+            # Maximum number of UAC connections allowed, when per-type limits apply.
+            sig { returns(Integer) }
+            attr_accessor :uac_limit
+
+            sig do
+              params(
+                standard_limit: Integer,
+                texml_limit: Integer,
+                uac_limit: Integer
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Maximum number of standard connections allowed, when per-type limits apply.
+              standard_limit:,
+              # Maximum number of TeXML applications allowed, when per-type limits apply.
+              texml_limit:,
+              # Maximum number of UAC connections allowed, when per-type limits apply.
+              uac_limit:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  standard_limit: Integer,
+                  texml_limit: Integer,
+                  uac_limit: Integer
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/conversation_relay_embedded_config.rbi

@@ -188,6 +188,12 @@ module Telnyx
       # - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
       #   `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
       #   `s1`. `VoiceId` is a Fish Voice-Library reference ID.
+      # - **Soniox:** Use `Soniox.<ModelId>.<VoiceId>` (e.g., `Soniox.tts-rt-v2.Emma`).
+      #   Supported model: `tts-rt-v2`. Browse the catalog via the
+      #   [Voices API](https://developers.telnyx.com/api-reference/text-to-speech-commands/list-available-voices).
+      #   Every voice speaks all supported languages; set `language` to the two-letter
+      #   ISO 639-1 code of the text, for example `it`. SSML is not supported. Use
+      #   `voice_settings` to configure `speed` (0.7 to 1.3) and `reduce_silence`.
       # - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
       #   `ara`, `rex`, `sal`, `leo`.
       # - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
@@ -212,7 +218,8 @@ module Telnyx
               Telnyx::AzureVoiceSettings,
               Telnyx::ResembleVoiceSettings,
               Telnyx::InworldVoiceSettings,
-              Telnyx::XaiVoiceSettings
+              Telnyx::XaiVoiceSettings,
+              Telnyx::Calls::SonioxVoiceSettings
             )
           )
         )
@@ -230,7 +237,8 @@ module Telnyx
               Telnyx::AzureVoiceSettings::OrHash,
               Telnyx::ResembleVoiceSettings::OrHash,
               Telnyx::InworldVoiceSettings::OrHash,
-              Telnyx::XaiVoiceSettings::OrHash
+              Telnyx::XaiVoiceSettings::OrHash,
+              Telnyx::Calls::SonioxVoiceSettings::OrHash
             )
         ).void
       end
@@ -272,7 +280,8 @@ module Telnyx
               Telnyx::AzureVoiceSettings::OrHash,
               Telnyx::ResembleVoiceSettings::OrHash,
               Telnyx::InworldVoiceSettings::OrHash,
-              Telnyx::XaiVoiceSettings::OrHash
+              Telnyx::XaiVoiceSettings::OrHash,
+              Telnyx::Calls::SonioxVoiceSettings::OrHash
             )
         ).returns(T.attached_class)
       end
@@ -348,6 +357,12 @@ module Telnyx
         # - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
         #   `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
         #   `s1`. `VoiceId` is a Fish Voice-Library reference ID.
+        # - **Soniox:** Use `Soniox.<ModelId>.<VoiceId>` (e.g., `Soniox.tts-rt-v2.Emma`).
+        #   Supported model: `tts-rt-v2`. Browse the catalog via the
+        #   [Voices API](https://developers.telnyx.com/api-reference/text-to-speech-commands/list-available-voices).
+        #   Every voice speaks all supported languages; set `language` to the two-letter
+        #   ISO 639-1 code of the text, for example `it`. SSML is not supported. Use
+        #   `voice_settings` to configure `speed` (0.7 to 1.3) and `reduce_silence`.
         # - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
         #   `ara`, `rex`, `sal`, `leo`.
         # - **Humain:** Use `Humain.<VoiceId>` (e.g., `Humain.sara-ar`). Available voices:
@@ -391,7 +406,8 @@ module Telnyx
                 Telnyx::AzureVoiceSettings,
                 Telnyx::ResembleVoiceSettings,
                 Telnyx::InworldVoiceSettings,
-                Telnyx::XaiVoiceSettings
+                Telnyx::XaiVoiceSettings,
+                Telnyx::Calls::SonioxVoiceSettings
               )
           }
         )
@@ -491,7 +507,8 @@ module Telnyx
               Telnyx::AzureVoiceSettings,
               Telnyx::ResembleVoiceSettings,
               Telnyx::InworldVoiceSettings,
-              Telnyx::XaiVoiceSettings
+              Telnyx::XaiVoiceSettings,
+              Telnyx::Calls::SonioxVoiceSettings
             )
           end
 

data/rbi/telnyx/models/conversation_relay_language.rbi

@@ -89,7 +89,8 @@ module Telnyx
               Telnyx::AzureVoiceSettings,
               Telnyx::ResembleVoiceSettings,
               Telnyx::InworldVoiceSettings,
-              Telnyx::XaiVoiceSettings
+              Telnyx::XaiVoiceSettings,
+              Telnyx::Calls::SonioxVoiceSettings
             )
           )
         )
@@ -107,7 +108,8 @@ module Telnyx
               Telnyx::AzureVoiceSettings::OrHash,
               Telnyx::ResembleVoiceSettings::OrHash,
               Telnyx::InworldVoiceSettings::OrHash,
-              Telnyx::XaiVoiceSettings::OrHash
+              Telnyx::XaiVoiceSettings::OrHash,
+              Telnyx::Calls::SonioxVoiceSettings::OrHash
             )
         ).void
       end
@@ -133,7 +135,8 @@ module Telnyx
               Telnyx::AzureVoiceSettings::OrHash,
               Telnyx::ResembleVoiceSettings::OrHash,
               Telnyx::InworldVoiceSettings::OrHash,
-              Telnyx::XaiVoiceSettings::OrHash
+              Telnyx::XaiVoiceSettings::OrHash,
+              Telnyx::Calls::SonioxVoiceSettings::OrHash
             )
         ).returns(T.attached_class)
       end
@@ -187,7 +190,8 @@ module Telnyx
                 Telnyx::AzureVoiceSettings,
                 Telnyx::ResembleVoiceSettings,
                 Telnyx::InworldVoiceSettings,
-                Telnyx::XaiVoiceSettings
+                Telnyx::XaiVoiceSettings,
+                Telnyx::Calls::SonioxVoiceSettings
               )
           }
         )
@@ -287,7 +291,8 @@ module Telnyx
               Telnyx::AzureVoiceSettings,
               Telnyx::ResembleVoiceSettings,
               Telnyx::InworldVoiceSettings,
-              Telnyx::XaiVoiceSettings
+              Telnyx::XaiVoiceSettings,
+              Telnyx::Calls::SonioxVoiceSettings
             )
           end
 

data/rbi/telnyx/models/detail_record_list_params.rbi

@@ -13,6 +13,12 @@ module Telnyx
 
       # Filter records on a given record attribute and value. <br/>Example:
       # filter[status]=delivered. <br/>Required: filter[record_type] must be specified.
+      # <br/>The valid filter fields depend on the record_type: filtering by a field
+      # that does not exist for the selected record_type is rejected with a 400 error.
+      # Call-control and sip-trunking records use started_at, finished_at and
+      # answered_at (they have no created_at); messaging records use created_at. To list
+      # the fields available for a record_type, use the /v2/detail_records/options
+      # endpoint.
       sig { returns(T.nilable(Telnyx::DetailRecordListParams::Filter)) }
       attr_reader :filter
 
@@ -33,7 +39,12 @@ module Telnyx
       sig { params(page_size: Integer).void }
       attr_writer :page_size
 
-      # Specifies the sort order for results. <br/>Example: sort=-created_at
+      # Specifies the sort order for results. <br/>Example: sort=-created_at <br/>The
+      # valid sort fields depend on the record_type: sort by a field that does not exist
+      # for the selected record_type is rejected with a 400 error. Call-control and
+      # sip-trunking records use started_at, finished_at and answered_at (they have no
+      # created_at); messaging records use created_at. To list the fields available for
+      # a record_type, use the /v2/detail_records/options endpoint.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :sort
 
@@ -52,10 +63,21 @@ module Telnyx
       def self.new(
         # Filter records on a given record attribute and value. <br/>Example:
         # filter[status]=delivered. <br/>Required: filter[record_type] must be specified.
+        # <br/>The valid filter fields depend on the record_type: filtering by a field
+        # that does not exist for the selected record_type is rejected with a 400 error.
+        # Call-control and sip-trunking records use started_at, finished_at and
+        # answered_at (they have no created_at); messaging records use created_at. To list
+        # the fields available for a record_type, use the /v2/detail_records/options
+        # endpoint.
         filter: nil,
         page_number: nil,
         page_size: nil,
-        # Specifies the sort order for results. <br/>Example: sort=-created_at
+        # Specifies the sort order for results. <br/>Example: sort=-created_at <br/>The
+        # valid sort fields depend on the record_type: sort by a field that does not exist
+        # for the selected record_type is rejected with a 400 error. Call-control and
+        # sip-trunking records use started_at, finished_at and answered_at (they have no
+        # created_at); messaging records use created_at. To list the fields available for
+        # a record_type, use the /v2/detail_records/options endpoint.
         sort: nil,
         request_options: {}
       )
@@ -111,6 +133,12 @@ module Telnyx
 
         # Filter records on a given record attribute and value. <br/>Example:
         # filter[status]=delivered. <br/>Required: filter[record_type] must be specified.
+        # <br/>The valid filter fields depend on the record_type: filtering by a field
+        # that does not exist for the selected record_type is rejected with a 400 error.
+        # Call-control and sip-trunking records use started_at, finished_at and
+        # answered_at (they have no created_at); messaging records use created_at. To list
+        # the fields available for a record_type, use the /v2/detail_records/options
+        # endpoint.
         sig do
           params(
             record_type:

data/rbi/telnyx/models/email_block.rbi

@@ -40,6 +40,10 @@ module Telnyx
       sig { returns(T.nilable(String)) }
       attr_accessor :domain_id
 
+      # Optional expiration time. An active row stops matching send-time suppression
+      # checks as soon as `expires_at <= now()`. A maintenance worker later transitions
+      # the row to `status: expired` and appends an `expired` audit event (normally
+      # within 15 minutes).
       sig { returns(T.nilable(Time)) }
       attr_accessor :expires_at
 
@@ -85,6 +89,10 @@ module Telnyx
         updated_at:,
         # `null` ⇒ account scope. Stored on the row; exposed here.
         domain_id: nil,
+        # Optional expiration time. An active row stops matching send-time suppression
+        # checks as soon as `expires_at <= now()`. A maintenance worker later transitions
+        # the row to `status: expired` and appends an `expired` audit event (normally
+        # within 15 minutes).
         expires_at: nil,
         # `null` ⇒ not address-scope. (schema: from_address)
         from: nil,

data/rbi/telnyx/models/email_blocks/email_block_import.rbi

@@ -54,7 +54,9 @@ module Telnyx
         sig { params(created_count: Integer).void }
         attr_writer :created_count
 
-        # Only when `status == completed`.
+        # Rows that passed CSV parsing but failed suppression creation. This is the
+        # creation-failure subset of `skipped_count`; parser-rejected rows equal
+        # `skipped_count - error_count`. Only when `status == completed`.
         sig { returns(T.nilable(Integer)) }
         attr_reader :error_count
 
@@ -148,7 +150,9 @@ module Telnyx
           completed_at: nil,
           # Only when `status == completed`.
           created_count: nil,
-          # Only when `status == completed`.
+          # Rows that passed CSV parsing but failed suppression creation. This is the
+          # creation-failure subset of `skipped_count`; parser-rejected rows equal
+          # `skipped_count - error_count`. Only when `status == completed`.
           error_count: nil,
           # `{row_number: reason}`; only rendered when non-empty.
           errors: nil,

data/rbi/telnyx/models/email_domain_rotate_dkim_params.rbi

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