telnyx 5.171.0 → 5.174.0

data/rbi/telnyx/models/telephony_credential_create_token_params.rbi

@@ -17,18 +17,29 @@ module Telnyx
       sig { returns(String) }
       attr_accessor :id
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
       sig do
         params(
           id: String,
+          idempotency_key: String,
           request_options: Telnyx::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(id:, request_options: {})
+      def self.new(id:, idempotency_key: nil, request_options: {})
       end
 
       sig do
         override.returns(
-          { id: String, request_options: Telnyx::RequestOptions }
+          {
+            id: String,
+            idempotency_key: String,
+            request_options: Telnyx::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi

@@ -87,7 +87,12 @@ module Telnyx
               sig { returns(String) }
               attr_accessor :url
 
-              # The ID of the TeXML Application.
+              # The ID of the TeXML Application that will handle the call, for example
+              # `1293384261075731499`. The `ApplicationSid` name is kept for Twilio API
+              # compatibility, but the value is the numeric ID of one of your TeXML Applications
+              # (see the TeXML Applications API or the Mission Control Portal), not a Twilio
+              # `AP...` SID. If `Url` and `Texml` are omitted, Telnyx fetches instructions from
+              # the XML Request URL configured on this application.
               sig { returns(T.nilable(String)) }
               attr_reader :application_sid
 
@@ -776,7 +781,12 @@ module Telnyx
               def self.new(
                 # The URL from which Telnyx will retrieve the TeXML call instructions.
                 url:,
-                # The ID of the TeXML Application.
+                # The ID of the TeXML Application that will handle the call, for example
+                # `1293384261075731499`. The `ApplicationSid` name is kept for Twilio API
+                # compatibility, but the value is the numeric ID of one of your TeXML Applications
+                # (see the TeXML Applications API or the Mission Control Portal), not a Twilio
+                # `AP...` SID. If `Url` and `Texml` are omitted, Telnyx fetches instructions from
+                # the XML Request URL configured on this application.
                 application_sid: nil,
                 # Select whether to perform answering machine detection in the background. By
                 # default execution is blocked until Answering Machine Detection is completed.
@@ -1636,7 +1646,12 @@ module Telnyx
               sig { returns(String) }
               attr_accessor :texml
 
-              # The ID of the TeXML Application.
+              # The ID of the TeXML Application that will handle the call, for example
+              # `1293384261075731499`. The `ApplicationSid` name is kept for Twilio API
+              # compatibility, but the value is the numeric ID of one of your TeXML Applications
+              # (see the TeXML Applications API or the Mission Control Portal), not a Twilio
+              # `AP...` SID. If `Url` and `Texml` are omitted, Telnyx fetches instructions from
+              # the XML Request URL configured on this application.
               sig { returns(T.nilable(String)) }
               attr_reader :application_sid
 
@@ -2326,7 +2341,12 @@ module Telnyx
                 # TeXML to be used as instructions for the call. If provided, the call will
                 # execute these instructions instead of fetching from the Url.
                 texml:,
-                # The ID of the TeXML Application.
+                # The ID of the TeXML Application that will handle the call, for example
+                # `1293384261075731499`. The `ApplicationSid` name is kept for Twilio API
+                # compatibility, but the value is the numeric ID of one of your TeXML Applications
+                # (see the TeXML Applications API or the Mission Control Portal), not a Twilio
+                # `AP...` SID. If `Url` and `Texml` are omitted, Telnyx fetches instructions from
+                # the XML Request URL configured on this application.
                 application_sid: nil,
                 # Select whether to perform answering machine detection in the background. By
                 # default execution is blocked until Answering Machine Detection is completed.
@@ -3181,7 +3201,12 @@ module Telnyx
                   )
                 end
 
-              # The ID of the TeXML Application.
+              # The ID of the TeXML Application that will handle the call, for example
+              # `1293384261075731499`. The `ApplicationSid` name is kept for Twilio API
+              # compatibility, but the value is the numeric ID of one of your TeXML Applications
+              # (see the TeXML Applications API or the Mission Control Portal), not a Twilio
+              # `AP...` SID. If `Url` and `Texml` are omitted, Telnyx fetches instructions from
+              # the XML Request URL configured on this application.
               sig { returns(T.nilable(String)) }
               attr_reader :application_sid
 
@@ -3871,7 +3896,12 @@ module Telnyx
                 ).returns(T.attached_class)
               end
               def self.new(
-                # The ID of the TeXML Application.
+                # The ID of the TeXML Application that will handle the call, for example
+                # `1293384261075731499`. The `ApplicationSid` name is kept for Twilio API
+                # compatibility, but the value is the numeric ID of one of your TeXML Applications
+                # (see the TeXML Applications API or the Mission Control Portal), not a Twilio
+                # `AP...` SID. If `Url` and `Texml` are omitted, Telnyx fetches instructions from
+                # the XML Request URL configured on this application.
                 application_sid: nil,
                 # Select whether to perform answering machine detection in the background. By
                 # default execution is blocked until Answering Machine Detection is completed.

data/rbi/telnyx/models/texml_application.rbi

@@ -291,8 +291,8 @@ module Telnyx
         # in the same way a phone number is used, from a SIP endpoint. Example: the
         # subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
         # the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
-        # alphanumeric value. Please note TLS encrypted calls are not allowed for
-        # subdomain calls.
+        # alphanumeric value. TLS signaling is supported. SRTP media encryption requires
+        # TLS transport.
         sig { returns(T.nilable(String)) }
         attr_reader :sip_subdomain
 
@@ -339,8 +339,8 @@ module Telnyx
           # in the same way a phone number is used, from a SIP endpoint. Example: the
           # subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
           # the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
-          # alphanumeric value. Please note TLS encrypted calls are not allowed for
-          # subdomain calls.
+          # alphanumeric value. TLS signaling is supported. SRTP media encryption requires
+          # TLS transport.
           sip_subdomain: nil,
           # This option can be enabled to receive calls from: "Anyone" (any SIP endpoint in
           # the public Internet) or "Only my connections" (any connection assigned to the

data/rbi/telnyx/models/texml_application_create_params.rbi

@@ -263,8 +263,8 @@ module Telnyx
         # in the same way a phone number is used, from a SIP endpoint. Example: the
         # subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
         # the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
-        # alphanumeric value. Please note TLS encrypted calls are not allowed for
-        # subdomain calls.
+        # alphanumeric value. TLS signaling is supported. SRTP media encryption requires
+        # TLS transport.
         sig { returns(T.nilable(String)) }
         attr_reader :sip_subdomain
 
@@ -311,8 +311,8 @@ module Telnyx
           # in the same way a phone number is used, from a SIP endpoint. Example: the
           # subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
           # the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
-          # alphanumeric value. Please note TLS encrypted calls are not allowed for
-          # subdomain calls.
+          # alphanumeric value. TLS signaling is supported. SRTP media encryption requires
+          # TLS transport.
           sip_subdomain: nil,
           # This option can be enabled to receive calls from: "Anyone" (any SIP endpoint in
           # the public Internet) or "Only my connections" (any connection assigned to the

data/rbi/telnyx/models/texml_application_update_params.rbi

@@ -269,8 +269,8 @@ module Telnyx
         # in the same way a phone number is used, from a SIP endpoint. Example: the
         # subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
         # the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
-        # alphanumeric value. Please note TLS encrypted calls are not allowed for
-        # subdomain calls.
+        # alphanumeric value. TLS signaling is supported. SRTP media encryption requires
+        # TLS transport.
         sig { returns(T.nilable(String)) }
         attr_reader :sip_subdomain
 
@@ -317,8 +317,8 @@ module Telnyx
           # in the same way a phone number is used, from a SIP endpoint. Example: the
           # subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
           # the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
-          # alphanumeric value. Please note TLS encrypted calls are not allowed for
-          # subdomain calls.
+          # alphanumeric value. TLS signaling is supported. SRTP media encryption requires
+          # TLS transport.
           sip_subdomain: nil,
           # This option can be enabled to receive calls from: "Anyone" (any SIP endpoint in
           # the public Internet) or "Only my connections" (any connection assigned to the

data/rbi/telnyx/models/text_to_speech_generate_speech_params.rbi

@@ -164,7 +164,10 @@ module Telnyx
 
       # Telnyx provider-specific parameters. For the `Ultra` model, use `voice_speed`,
       # `volume`, and `emotion`. `Bayan` and `Sukhan` don't use `temperature`, `volume`,
-      # or `emotion`, and don't support `voice_speed`. `Sukhan`'s `response_format` is
+      # or `emotion`. `Bayan` accepts `voice_speed` from 0.5 to 2.0; `Sukhan` doesn't
+      # support it. `Bayan` synthesizes at a native 16 kHz: `sampling_rate` `8000`,
+      # `22050`, or `24000` is resampled, needs `response_format: pcm`, and isn't
+      # available with `output_type: audio_id`. `Sukhan`'s `response_format` is
       # restricted to `mp3` or `pcm` (no `wav`).
       sig do
         returns(T.nilable(::Telnyx::TextToSpeechGenerateSpeechParams::Telnyx))
@@ -292,7 +295,10 @@ module Telnyx
         soniox: nil,
         # Telnyx provider-specific parameters. For the `Ultra` model, use `voice_speed`,
         # `volume`, and `emotion`. `Bayan` and `Sukhan` don't use `temperature`, `volume`,
-        # or `emotion`, and don't support `voice_speed`. `Sukhan`'s `response_format` is
+        # or `emotion`. `Bayan` accepts `voice_speed` from 0.5 to 2.0; `Sukhan` doesn't
+        # support it. `Bayan` synthesizes at a native 16 kHz: `sampling_rate` `8000`,
+        # `22050`, or `24000` is resampled, needs `response_format: pcm`, and isn't
+        # available with `output_type: audio_id`. `Sukhan`'s `response_format` is
         # restricted to `mp3` or `pcm` (no `wav`).
         telnyx: nil,
         # The text to convert to speech.
@@ -1006,13 +1012,6 @@ module Telnyx
             )
           end
 
-        # Custom Resemble API key.
-        sig { returns(T.nilable(String)) }
-        attr_reader :api_key
-
-        sig { params(api_key: String).void }
-        attr_writer :api_key
-
         # Audio output format.
         sig { returns(T.nilable(String)) }
         attr_reader :file_format
@@ -1037,15 +1036,12 @@ module Telnyx
         # Resemble AI provider-specific parameters.
         sig do
           params(
-            api_key: String,
             file_format: String,
             precision: String,
             sample_rate: String
           ).returns(T.attached_class)
         end
         def self.new(
-          # Custom Resemble API key.
-          api_key: nil,
           # Audio output format.
           file_format: nil,
           # Synthesis precision.
@@ -1057,12 +1053,7 @@ module Telnyx
 
         sig do
           override.returns(
-            {
-              api_key: String,
-              file_format: String,
-              precision: String,
-              sample_rate: String
-            }
+            { file_format: String, precision: String, sample_rate: String }
           )
         end
         def to_hash
@@ -1383,7 +1374,10 @@ module Telnyx
         sig { params(response_format: String).void }
         attr_writer :response_format
 
-        # Audio sampling rate in Hz.
+        # Audio sampling rate in Hz. `Bayan` ignores the default and synthesizes at its
+        # native 16 kHz unless `8000`, `22050`, or `24000` is set explicitly with
+        # `response_format: pcm`. Resampled rates aren't available with
+        # `output_type: audio_id`.
         sig { returns(T.nilable(Integer)) }
         attr_reader :sampling_rate
 
@@ -1391,9 +1385,9 @@ module Telnyx
         attr_writer :sampling_rate
 
         # Voice speed multiplier. Telnyx `Ultra` voices accept values from 0.6 to 1.5 —
-        # requests outside that range are rejected by the synthesis engine. `KokoroTTS`
-        # and `Qwen3TTS` accept the field but do not apply it. `Bayan` and `Sukhan` don't
-        # support it.
+        # requests outside that range are rejected by the synthesis engine. `Bayan`
+        # accepts values from 0.5 to 2.0. `KokoroTTS` and `Qwen3TTS` accept the field but
+        # do not apply it. `Sukhan` doesn't support it.
         sig { returns(T.nilable(Float)) }
         attr_reader :voice_speed
 
@@ -1412,7 +1406,10 @@ module Telnyx
 
         # Telnyx provider-specific parameters. For the `Ultra` model, use `voice_speed`,
         # `volume`, and `emotion`. `Bayan` and `Sukhan` don't use `temperature`, `volume`,
-        # or `emotion`, and don't support `voice_speed`. `Sukhan`'s `response_format` is
+        # or `emotion`. `Bayan` accepts `voice_speed` from 0.5 to 2.0; `Sukhan` doesn't
+        # support it. `Bayan` synthesizes at a native 16 kHz: `sampling_rate` `8000`,
+        # `22050`, or `24000` is resampled, needs `response_format: pcm`, and isn't
+        # available with `output_type: audio_id`. `Sukhan`'s `response_format` is
         # restricted to `mp3` or `pcm` (no `wav`).
         sig do
           params(
@@ -1430,12 +1427,15 @@ module Telnyx
           emotion: nil,
           # Audio response format.
           response_format: nil,
-          # Audio sampling rate in Hz.
+          # Audio sampling rate in Hz. `Bayan` ignores the default and synthesizes at its
+          # native 16 kHz unless `8000`, `22050`, or `24000` is set explicitly with
+          # `response_format: pcm`. Resampled rates aren't available with
+          # `output_type: audio_id`.
           sampling_rate: nil,
           # Voice speed multiplier. Telnyx `Ultra` voices accept values from 0.6 to 1.5 —
-          # requests outside that range are rejected by the synthesis engine. `KokoroTTS`
-          # and `Qwen3TTS` accept the field but do not apply it. `Bayan` and `Sukhan` don't
-          # support it.
+          # requests outside that range are rejected by the synthesis engine. `Bayan`
+          # accepts values from 0.5 to 2.0. `KokoroTTS` and `Qwen3TTS` accept the field but
+          # do not apply it. `Sukhan` doesn't support it.
           voice_speed: nil,
           # Volume level for the Ultra model. Telnyx `Ultra` voices accept values from 0.5
           # to 2.0 — requests outside that range are rejected by the synthesis engine.

data/rbi/telnyx/models/tunnel.rbi

@@ -0,0 +1,200 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class Tunnel < Telnyx::Internal::Type::BaseModel
+      OrHash = T.type_alias { T.any(Telnyx::Tunnel, Telnyx::Internal::AnyHash) }
+
+      # A user specified name for the tunnel.
+      sig { returns(T.nilable(String)) }
+      attr_reader :name
+
+      sig { params(name: String).void }
+      attr_writer :name
+
+      # Identifies the resource.
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      # The number of tunnel processes connected with the tunnel's token.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :connection_count
+
+      sig { params(connection_count: Integer).void }
+      attr_writer :connection_count
+
+      # The tunnel processes connected with the tunnel's token.
+      sig { returns(T.nilable(T::Array[Telnyx::Tunnel::Connection])) }
+      attr_reader :connections
+
+      sig do
+        params(connections: T::Array[Telnyx::Tunnel::Connection::OrHash]).void
+      end
+      attr_writer :connections
+
+      # ISO 8601 formatted date-time indicating when the resource was created.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_at
+
+      sig { params(created_at: Time).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
+
+      # `inactive` when no tunnel process is connected, and `healthy` when one or more
+      # are. `degraded` (Preview, not reported yet) when a process is connected but
+      # fails to reach its destinations.
+      sig { returns(T.nilable(Telnyx::Tunnel::Status::TaggedSymbol)) }
+      attr_reader :status
+
+      sig { params(status: Telnyx::Tunnel::Status::OrSymbol).void }
+      attr_writer :status
+
+      sig do
+        params(
+          id: String,
+          connection_count: Integer,
+          connections: T::Array[Telnyx::Tunnel::Connection::OrHash],
+          created_at: Time,
+          name: String,
+          record_type: String,
+          status: Telnyx::Tunnel::Status::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Identifies the resource.
+        id: nil,
+        # The number of tunnel processes connected with the tunnel's token.
+        connection_count: nil,
+        # The tunnel processes connected with the tunnel's token.
+        connections: nil,
+        # ISO 8601 formatted date-time indicating when the resource was created.
+        created_at: nil,
+        # A user specified name for the tunnel.
+        name: nil,
+        # Identifies the type of the resource.
+        record_type: nil,
+        # `inactive` when no tunnel process is connected, and `healthy` when one or more
+        # are. `degraded` (Preview, not reported yet) when a process is connected but
+        # fails to reach its destinations.
+        status: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            connection_count: Integer,
+            connections: T::Array[Telnyx::Tunnel::Connection],
+            created_at: Time,
+            name: String,
+            record_type: String,
+            status: Telnyx::Tunnel::Status::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Connection < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Tunnel::Connection, Telnyx::Internal::AnyHash)
+          end
+
+        # When the process connected.
+        sig { returns(T.nilable(Time)) }
+        attr_reader :connected_at
+
+        sig { params(connected_at: Time).void }
+        attr_writer :connected_at
+
+        # The name the host reports for itself. Preview: empty until the CLI reports it.
+        sig { returns(T.nilable(String)) }
+        attr_reader :hostname
+
+        sig { params(hostname: String).void }
+        attr_writer :hostname
+
+        # The Telnyx region the process is connected to. Preview: empty until the CLI
+        # reports it.
+        sig { returns(T.nilable(String)) }
+        attr_reader :region_code
+
+        sig { params(region_code: String).void }
+        attr_writer :region_code
+
+        # The `telnyx-edge` CLI version of the process. Preview: empty until the CLI
+        # reports it.
+        sig { returns(T.nilable(String)) }
+        attr_reader :version
+
+        sig { params(version: String).void }
+        attr_writer :version
+
+        # A tunnel process connected to the tunnel.
+        sig do
+          params(
+            connected_at: Time,
+            hostname: String,
+            region_code: String,
+            version: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # When the process connected.
+          connected_at: nil,
+          # The name the host reports for itself. Preview: empty until the CLI reports it.
+          hostname: nil,
+          # The Telnyx region the process is connected to. Preview: empty until the CLI
+          # reports it.
+          region_code: nil,
+          # The `telnyx-edge` CLI version of the process. Preview: empty until the CLI
+          # reports it.
+          version: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              connected_at: Time,
+              hostname: String,
+              region_code: String,
+              version: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      # `inactive` when no tunnel process is connected, and `healthy` when one or more
+      # are. `degraded` (Preview, not reported yet) when a process is connected but
+      # fails to reach its destinations.
+      module Status
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol = T.type_alias { T.all(Symbol, Telnyx::Tunnel::Status) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        INACTIVE = T.let(:inactive, Telnyx::Tunnel::Status::TaggedSymbol)
+        HEALTHY = T.let(:healthy, Telnyx::Tunnel::Status::TaggedSymbol)
+        DEGRADED = T.let(:degraded, Telnyx::Tunnel::Status::TaggedSymbol)
+
+        sig { override.returns(T::Array[Telnyx::Tunnel::Status::TaggedSymbol]) }
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/tunnel_create_params.rbi

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

data/rbi/telnyx/models/tunnel_create_response.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class TunnelCreateResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::Models::TunnelCreateResponse, Telnyx::Internal::AnyHash)
+        end
+
+      sig { returns(T.nilable(Telnyx::TunnelWithToken)) }
+      attr_reader :data
+
+      sig { params(data: Telnyx::TunnelWithToken::OrHash).void }
+      attr_writer :data
+
+      sig do
+        params(data: Telnyx::TunnelWithToken::OrHash).returns(T.attached_class)
+      end
+      def self.new(data: nil)
+      end
+
+      sig { override.returns({ data: Telnyx::TunnelWithToken }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/tunnel_delete_params.rbi

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