telnyx 5.157.0 → 5.159.0

data/rbi/telnyx/models/ai/transcription_settings.rbi

@@ -23,7 +23,13 @@ module Telnyx
         # hint), `multi` (no language hint), and language-specific hints `en`, `es`, `fr`,
         # `de`, `hi`, `ru`, `pt`, `ja`, `it`, and `nl`. For `soniox/stt-rt-v4`, `auto`
         # omits the language hint and lets Soniox auto-detect; ISO 639-1 codes (e.g. `en`,
-        # `es`) bias detection toward that language.
+        # `es`) bias detection toward that language. For `humain/realtime`, supported
+        # values are `ar`, `en`, `codeswitch` (Arabic/English code-switching), and `auto`
+        # (resolves server-side to code-switching). Unlike other models, `humain/realtime`
+        # does not fall back to `auto` when `language` is omitted — omitting it applies
+        # `en` instead. For `reson8/turns`, supported values are `auto` (or unset) for
+        # automatic language detection, and the language codes `nl`, `en`, `fr`, `fy`,
+        # `de`, `it`, `pl`, `pt`, `es`, and `sv` to fix the transcription language.
         sig { returns(T.nilable(String)) }
         attr_reader :language
 
@@ -44,6 +50,10 @@ module Telnyx
         #   detection and configurable endpointing.
         # - `nvidia/parakeet-v3` is a multilingual transcription model with automatic
         #   language detection.
+        # - `humain/realtime` is a streaming model with native Arabic and Arabic/English
+        #   code-switching support.
+        # - `reson8/turns` is a turn-based streaming model covering 10 European languages
+        #   with automatic language detection.
         sig do
           returns(T.nilable(Telnyx::AI::TranscriptionSettings::Model::OrSymbol))
         end
@@ -89,7 +99,13 @@ module Telnyx
           # hint), `multi` (no language hint), and language-specific hints `en`, `es`, `fr`,
           # `de`, `hi`, `ru`, `pt`, `ja`, `it`, and `nl`. For `soniox/stt-rt-v4`, `auto`
           # omits the language hint and lets Soniox auto-detect; ISO 639-1 codes (e.g. `en`,
-          # `es`) bias detection toward that language.
+          # `es`) bias detection toward that language. For `humain/realtime`, supported
+          # values are `ar`, `en`, `codeswitch` (Arabic/English code-switching), and `auto`
+          # (resolves server-side to code-switching). Unlike other models, `humain/realtime`
+          # does not fall back to `auto` when `language` is omitted — omitting it applies
+          # `en` instead. For `reson8/turns`, supported values are `auto` (or unset) for
+          # automatic language detection, and the language codes `nl`, `en`, `fr`, `fy`,
+          # `de`, `it`, `pl`, `pt`, `es`, and `sv` to fix the transcription language.
           language: nil,
           # The speech to text model to be used by the voice assistant. All Deepgram models
           # are run on-premise.
@@ -105,6 +121,10 @@ module Telnyx
           #   detection and configurable endpointing.
           # - `nvidia/parakeet-v3` is a multilingual transcription model with automatic
           #   language detection.
+          # - `humain/realtime` is a streaming model with native Arabic and Arabic/English
+          #   code-switching support.
+          # - `reson8/turns` is a turn-based streaming model covering 10 European languages
+          #   with automatic language detection.
           model: nil,
           # Region on third party cloud providers (currently Azure) if using one of their
           # models. Some regions require `api_key_ref`.
@@ -141,6 +161,10 @@ module Telnyx
         #   detection and configurable endpointing.
         # - `nvidia/parakeet-v3` is a multilingual transcription model with automatic
         #   language detection.
+        # - `humain/realtime` is a streaming model with native Arabic and Arabic/English
+        #   code-switching support.
+        # - `reson8/turns` is a turn-based streaming model covering 10 European languages
+        #   with automatic language detection.
         module Model
           extend Telnyx::Internal::Type::Enum
 
@@ -190,6 +214,16 @@ module Telnyx
               :"nvidia/parakeet-v3",
               Telnyx::AI::TranscriptionSettings::Model::TaggedSymbol
             )
+          HUMAIN_REALTIME =
+            T.let(
+              :"humain/realtime",
+              Telnyx::AI::TranscriptionSettings::Model::TaggedSymbol
+            )
+          RESON8_TURNS =
+            T.let(
+              :"reson8/turns",
+              Telnyx::AI::TranscriptionSettings::Model::TaggedSymbol
+            )
           DISTIL_WHISPER_DISTIL_LARGE_V2 =
             T.let(
               :"distil-whisper/distil-large-v2",

data/rbi/telnyx/models/attachment_request.rbi

@@ -0,0 +1,83 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class AttachmentRequest < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::AttachmentRequest, Telnyx::Internal::AnyHash)
+        end
+
+      # Attachment content, typically Base64-encoded. Defaults to empty string when
+      # omitted.
+      sig { returns(T.nilable(String)) }
+      attr_reader :content
+
+      sig { params(content: String).void }
+      attr_writer :content
+
+      # MIME Content-ID used to reference an inline attachment.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :content_id
+
+      # MIME content type. Defaults to "application/octet-stream" when omitted.
+      sig { returns(T.nilable(String)) }
+      attr_reader :content_type
+
+      sig { params(content_type: String).void }
+      attr_writer :content_type
+
+      # MIME disposition (`attachment` or `inline`).
+      sig { returns(T.nilable(String)) }
+      attr_reader :disposition
+
+      sig { params(disposition: String).void }
+      attr_writer :disposition
+
+      # Attachment filename. Defaults to "attachment" when omitted.
+      sig { returns(T.nilable(String)) }
+      attr_reader :filename
+
+      sig { params(filename: String).void }
+      attr_writer :filename
+
+      sig do
+        params(
+          content: String,
+          content_id: T.nilable(String),
+          content_type: String,
+          disposition: String,
+          filename: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Attachment content, typically Base64-encoded. Defaults to empty string when
+        # omitted.
+        content: nil,
+        # MIME Content-ID used to reference an inline attachment.
+        content_id: nil,
+        # MIME content type. Defaults to "application/octet-stream" when omitted.
+        content_type: nil,
+        # MIME disposition (`attachment` or `inline`).
+        disposition: nil,
+        # Attachment filename. Defaults to "attachment" when omitted.
+        filename: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            content: String,
+            content_id: T.nilable(String),
+            content_type: String,
+            disposition: String,
+            filename: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/call_answered.rbi

@@ -158,10 +158,17 @@ module Telnyx
         attr_writer :from
 
         # User-to-User and Diversion headers from sip invite.
-        sig { returns(T.nilable(T::Array[Telnyx::SipHeader])) }
+        sig do
+          returns(T.nilable(T::Array[Telnyx::CallAnswered::Payload::SipHeader]))
+        end
         attr_reader :sip_headers
 
-        sig { params(sip_headers: T::Array[Telnyx::SipHeader::OrHash]).void }
+        sig do
+          params(
+            sip_headers:
+              T::Array[Telnyx::CallAnswered::Payload::SipHeader::OrHash]
+          ).void
+        end
         attr_writer :sip_headers
 
         # ISO 8601 datetime of when the call started.
@@ -205,7 +212,8 @@ module Telnyx
             connection_id: String,
             custom_headers: T::Array[Telnyx::CustomSipHeader::OrHash],
             from: String,
-            sip_headers: T::Array[Telnyx::SipHeader::OrHash],
+            sip_headers:
+              T::Array[Telnyx::CallAnswered::Payload::SipHeader::OrHash],
             start_time: Time,
             state: Telnyx::CallAnswered::Payload::State::OrSymbol,
             tags: T::Array[String],
@@ -252,7 +260,7 @@ module Telnyx
               connection_id: String,
               custom_headers: T::Array[Telnyx::CustomSipHeader],
               from: String,
-              sip_headers: T::Array[Telnyx::SipHeader],
+              sip_headers: T::Array[Telnyx::CallAnswered::Payload::SipHeader],
               start_time: Time,
               state: Telnyx::CallAnswered::Payload::State::TaggedSymbol,
               tags: T::Array[String],
@@ -263,6 +271,86 @@ module Telnyx
         def to_hash
         end
 
+        class SipHeader < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::CallAnswered::Payload::SipHeader,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # The name of the header received from the SIP INVITE.
+          sig do
+            returns(
+              Telnyx::CallAnswered::Payload::SipHeader::Name::TaggedSymbol
+            )
+          end
+          attr_accessor :name
+
+          # The value of the header.
+          sig { returns(String) }
+          attr_accessor :value
+
+          sig do
+            params(
+              name: Telnyx::CallAnswered::Payload::SipHeader::Name::OrSymbol,
+              value: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The name of the header received from the SIP INVITE.
+            name:,
+            # The value of the header.
+            value:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                name:
+                  Telnyx::CallAnswered::Payload::SipHeader::Name::TaggedSymbol,
+                value: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The name of the header received from the SIP INVITE.
+          module Name
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(Symbol, Telnyx::CallAnswered::Payload::SipHeader::Name)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            USER_TO_USER =
+              T.let(
+                :"User-to-User",
+                Telnyx::CallAnswered::Payload::SipHeader::Name::TaggedSymbol
+              )
+            DIVERSION =
+              T.let(
+                :Diversion,
+                Telnyx::CallAnswered::Payload::SipHeader::Name::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::CallAnswered::Payload::SipHeader::Name::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
         # State received from a command.
         module State
           extend Telnyx::Internal::Type::Enum

data/rbi/telnyx/models/call_assistant_request.rbi

@@ -169,6 +169,12 @@ module Telnyx
       end
       attr_writer :tools
 
+      sig { returns(T.nilable(Telnyx::AI::VoiceSettings)) }
+      attr_reader :voice_settings
+
+      sig { params(voice_settings: Telnyx::AI::VoiceSettings::OrHash).void }
+      attr_writer :voice_settings
+
       # AI Assistant configuration. All fields except `id` are optional — the
       # assistant's stored configuration will be used as fallback for any omitted
       # fields.
@@ -200,7 +206,8 @@ module Telnyx
                 Telnyx::AI::TransferTool::OrHash,
                 Telnyx::CallControlRetrievalTool::OrHash
               )
-            ]
+            ],
+          voice_settings: Telnyx::AI::VoiceSettings::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
@@ -248,7 +255,8 @@ module Telnyx
         openai_api_key_ref: nil,
         # Inline tool definitions available to the assistant (webhook, retrieval,
         # transfer, hangup, etc.). Overrides the assistant's stored tools if provided.
-        tools: nil
+        tools: nil,
+        voice_settings: nil
       )
       end
 
@@ -281,7 +289,8 @@ module Telnyx
                   Telnyx::AI::TransferTool,
                   Telnyx::CallControlRetrievalTool
                 )
-              ]
+              ],
+            voice_settings: Telnyx::AI::VoiceSettings
           }
         )
       end

data/rbi/telnyx/models/call_dial_params.rbi

@@ -380,6 +380,18 @@ module Telnyx
       sig { params(retry_on_timeout: T::Boolean).void }
       attr_writer :retry_on_timeout
 
+      # When set to true, routes the call directly to the mobile device associated with
+      # the destination Telnyx Mobile number, bypassing Inbound Calls Interception
+      # configured in the Telnyx Portal under Mobile Numbers → select the number → Voice
+      # → Call Interception. Use this when transferring an intercepted call to the
+      # mobile device to prevent the call from being intercepted again. Defaults to
+      # false.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :route_to_mobile
+
+      sig { params(route_to_mobile: T::Boolean).void }
+      attr_writer :route_to_mobile
+
       # DTMF digits to send automatically after the called party answers. Useful for
       # reaching an extension behind an IVR (e.g. `"200"` to dial extension 200 once the
       # called party picks up). Allowed characters: `0-9`, `A-D`, `w` (0.5s pause), `W`
@@ -719,6 +731,7 @@ module Telnyx
           record_track: Telnyx::CallDialParams::RecordTrack::OrSymbol,
           record_trim: Telnyx::CallDialParams::RecordTrim::OrSymbol,
           retry_on_timeout: T::Boolean,
+          route_to_mobile: T::Boolean,
           send_digits_on_answer: String,
           send_silence_when_idle: T::Boolean,
           sip_auth_password: String,
@@ -912,6 +925,13 @@ module Telnyx
         # entire dial attempt and the `call.hangup` webhook reports a `hangup_cause` of
         # `no_answer` instead of `timeout`.
         retry_on_timeout: nil,
+        # When set to true, routes the call directly to the mobile device associated with
+        # the destination Telnyx Mobile number, bypassing Inbound Calls Interception
+        # configured in the Telnyx Portal under Mobile Numbers → select the number → Voice
+        # → Call Interception. Use this when transferring an intercepted call to the
+        # mobile device to prevent the call from being intercepted again. Defaults to
+        # false.
+        route_to_mobile: nil,
         # DTMF digits to send automatically after the called party answers. Useful for
         # reaching an extension behind an IVR (e.g. `"200"` to dial extension 200 once the
         # called party picks up). Allowed characters: `0-9`, `A-D`, `w` (0.5s pause), `W`
@@ -1041,6 +1061,7 @@ module Telnyx
             record_track: Telnyx::CallDialParams::RecordTrack::OrSymbol,
             record_trim: Telnyx::CallDialParams::RecordTrim::OrSymbol,
             retry_on_timeout: T::Boolean,
+            route_to_mobile: T::Boolean,
             send_digits_on_answer: String,
             send_silence_when_idle: T::Boolean,
             sip_auth_password: String,

data/rbi/telnyx/models/call_hangup.rbi

@@ -212,10 +212,17 @@ module Telnyx
         attr_writer :sip_hangup_cause
 
         # User-to-User and Diversion headers from sip invite.
-        sig { returns(T.nilable(T::Array[Telnyx::SipHeader])) }
+        sig do
+          returns(T.nilable(T::Array[Telnyx::CallHangup::Payload::SipHeader]))
+        end
         attr_reader :sip_headers
 
-        sig { params(sip_headers: T::Array[Telnyx::SipHeader::OrHash]).void }
+        sig do
+          params(
+            sip_headers:
+              T::Array[Telnyx::CallHangup::Payload::SipHeader::OrHash]
+          ).void
+        end
         attr_writer :sip_headers
 
         # ISO 8601 datetime of when the call started.
@@ -262,7 +269,8 @@ module Telnyx
             hangup_cause: Telnyx::CallHangup::Payload::HangupCause::OrSymbol,
             hangup_source: Telnyx::CallHangup::Payload::HangupSource::OrSymbol,
             sip_hangup_cause: String,
-            sip_headers: T::Array[Telnyx::SipHeader::OrHash],
+            sip_headers:
+              T::Array[Telnyx::CallHangup::Payload::SipHeader::OrHash],
             start_time: Time,
             state: Telnyx::CallHangup::Payload::State::OrSymbol,
             tags: T::Array[String],
@@ -329,7 +337,7 @@ module Telnyx
               hangup_source:
                 Telnyx::CallHangup::Payload::HangupSource::TaggedSymbol,
               sip_hangup_cause: String,
-              sip_headers: T::Array[Telnyx::SipHeader],
+              sip_headers: T::Array[Telnyx::CallHangup::Payload::SipHeader],
               start_time: Time,
               state: Telnyx::CallHangup::Payload::State::TaggedSymbol,
               tags: T::Array[String],
@@ -644,6 +652,84 @@ module Telnyx
           end
         end
 
+        class SipHeader < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::CallHangup::Payload::SipHeader,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # The name of the header received from the SIP INVITE.
+          sig do
+            returns(Telnyx::CallHangup::Payload::SipHeader::Name::TaggedSymbol)
+          end
+          attr_accessor :name
+
+          # The value of the header.
+          sig { returns(String) }
+          attr_accessor :value
+
+          sig do
+            params(
+              name: Telnyx::CallHangup::Payload::SipHeader::Name::OrSymbol,
+              value: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The name of the header received from the SIP INVITE.
+            name:,
+            # The value of the header.
+            value:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                name:
+                  Telnyx::CallHangup::Payload::SipHeader::Name::TaggedSymbol,
+                value: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The name of the header received from the SIP INVITE.
+          module Name
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(Symbol, Telnyx::CallHangup::Payload::SipHeader::Name)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            USER_TO_USER =
+              T.let(
+                :"User-to-User",
+                Telnyx::CallHangup::Payload::SipHeader::Name::TaggedSymbol
+              )
+            DIVERSION =
+              T.let(
+                :Diversion,
+                Telnyx::CallHangup::Payload::SipHeader::Name::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::CallHangup::Payload::SipHeader::Name::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
         # State received from a command.
         module State
           extend Telnyx::Internal::Type::Enum

data/rbi/telnyx/models/call_initiated.rbi

@@ -222,10 +222,19 @@ module Telnyx
         attr_writer :shaken_stir_validated
 
         # User-to-User and Diversion headers from sip invite.
-        sig { returns(T.nilable(T::Array[Telnyx::SipHeader])) }
+        sig do
+          returns(
+            T.nilable(T::Array[Telnyx::CallInitiated::Payload::SipHeader])
+          )
+        end
         attr_reader :sip_headers
 
-        sig { params(sip_headers: T::Array[Telnyx::SipHeader::OrHash]).void }
+        sig do
+          params(
+            sip_headers:
+              T::Array[Telnyx::CallInitiated::Payload::SipHeader::OrHash]
+          ).void
+        end
         attr_writer :sip_headers
 
         # ISO 8601 datetime of when the call started.
@@ -278,7 +287,8 @@ module Telnyx
             offered_codecs: String,
             shaken_stir_attestation: String,
             shaken_stir_validated: T::Boolean,
-            sip_headers: T::Array[Telnyx::SipHeader::OrHash],
+            sip_headers:
+              T::Array[Telnyx::CallInitiated::Payload::SipHeader::OrHash],
             start_time: Time,
             state: Telnyx::CallInitiated::Payload::State::OrSymbol,
             tags: T::Array[String],
@@ -347,7 +357,7 @@ module Telnyx
               offered_codecs: String,
               shaken_stir_attestation: String,
               shaken_stir_validated: T::Boolean,
-              sip_headers: T::Array[Telnyx::SipHeader],
+              sip_headers: T::Array[Telnyx::CallInitiated::Payload::SipHeader],
               start_time: Time,
               state: Telnyx::CallInitiated::Payload::State::TaggedSymbol,
               tags: T::Array[String],
@@ -388,6 +398,86 @@ module Telnyx
           end
         end
 
+        class SipHeader < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::CallInitiated::Payload::SipHeader,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # The name of the header received from the SIP INVITE.
+          sig do
+            returns(
+              Telnyx::CallInitiated::Payload::SipHeader::Name::TaggedSymbol
+            )
+          end
+          attr_accessor :name
+
+          # The value of the header.
+          sig { returns(String) }
+          attr_accessor :value
+
+          sig do
+            params(
+              name: Telnyx::CallInitiated::Payload::SipHeader::Name::OrSymbol,
+              value: String
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The name of the header received from the SIP INVITE.
+            name:,
+            # The value of the header.
+            value:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                name:
+                  Telnyx::CallInitiated::Payload::SipHeader::Name::TaggedSymbol,
+                value: String
+              }
+            )
+          end
+          def to_hash
+          end
+
+          # The name of the header received from the SIP INVITE.
+          module Name
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(Symbol, Telnyx::CallInitiated::Payload::SipHeader::Name)
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            USER_TO_USER =
+              T.let(
+                :"User-to-User",
+                Telnyx::CallInitiated::Payload::SipHeader::Name::TaggedSymbol
+              )
+            DIVERSION =
+              T.let(
+                :Diversion,
+                Telnyx::CallInitiated::Payload::SipHeader::Name::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::CallInitiated::Payload::SipHeader::Name::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+
         # State received from a command.
         module State
           extend Telnyx::Internal::Type::Enum