telnyx 5.156.0 → 5.158.0

data/rbi/telnyx/models/call_dial_params.rbi

@@ -369,6 +369,17 @@ module Telnyx
       end
       attr_writer :record_trim
 
+      # Whether to keep trying the remaining routing paths (e.g. alternate
+      # providers/gateways) for the same destination after `timeout_secs` is reached for
+      # the current attempt. When set to `false`, reaching `timeout_secs` aborts the
+      # entire dial attempt and the `call.hangup` webhook reports a `hangup_cause` of
+      # `no_answer` instead of `timeout`.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :retry_on_timeout
+
+      sig { params(retry_on_timeout: T::Boolean).void }
+      attr_writer :retry_on_timeout
+
       # 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`
@@ -707,6 +718,7 @@ module Telnyx
           record_timeout_secs: Integer,
           record_track: Telnyx::CallDialParams::RecordTrack::OrSymbol,
           record_trim: Telnyx::CallDialParams::RecordTrim::OrSymbol,
+          retry_on_timeout: T::Boolean,
           send_digits_on_answer: String,
           send_silence_when_idle: T::Boolean,
           sip_auth_password: String,
@@ -894,6 +906,12 @@ module Telnyx
         # When set to `trim-silence`, silence will be removed from the beginning and end
         # of the recording.
         record_trim: nil,
+        # Whether to keep trying the remaining routing paths (e.g. alternate
+        # providers/gateways) for the same destination after `timeout_secs` is reached for
+        # the current attempt. When set to `false`, reaching `timeout_secs` aborts the
+        # entire dial attempt and the `call.hangup` webhook reports a `hangup_cause` of
+        # `no_answer` instead of `timeout`.
+        retry_on_timeout: 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`
@@ -1022,6 +1040,7 @@ module Telnyx
             record_timeout_secs: Integer,
             record_track: Telnyx::CallDialParams::RecordTrack::OrSymbol,
             record_trim: Telnyx::CallDialParams::RecordTrim::OrSymbol,
+            retry_on_timeout: 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

data/rbi/telnyx/models/calls/transcription_config.rbi

@@ -16,7 +16,11 @@ module Telnyx
         # controls the language 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.
+        # ISO 639-1 codes (e.g. `en`, `es`) bias detection toward that language. For
+        # `assemblyai/universal-streaming`, `auto` (or unset) enables native multilingual
+        # code-switching; ISO 639-1 codes (`en`, `es`, `de`, `fr`, `pt`, `it`, `tr`, `nl`,
+        # `sv`, `no`, `da`, `fi`, `hi`, `vi`, `ar`, `he`, `ja`, `zh`) bias the session to
+        # that language.
         sig { returns(T.nilable(String)) }
         attr_reader :language
 
@@ -34,7 +38,7 @@ module Telnyx
         # - `xai/grok-stt` for live streaming transcription.
         # - `soniox/stt-rt-v4` for live streaming multilingual transcription with
         #   automatic language detection.
-        # - `parakeet/tdt-0.6b-v3` for multilingual transcription with automatic language
+        # - `nvidia/parakeet-v3` for multilingual transcription with automatic language
         #   detection.
         # - `azure/fast` and `azure/realtime`; Azure models require `region`, and
         #   unsupported regions require `api_key_ref`.
@@ -75,7 +79,11 @@ module Telnyx
           # controls the language 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.
+          # ISO 639-1 codes (e.g. `en`, `es`) bias detection toward that language. For
+          # `assemblyai/universal-streaming`, `auto` (or unset) enables native multilingual
+          # code-switching; ISO 639-1 codes (`en`, `es`, `de`, `fr`, `pt`, `it`, `tr`, `nl`,
+          # `sv`, `no`, `da`, `fi`, `hi`, `vi`, `ar`, `he`, `ja`, `zh`) bias the session to
+          # that language.
           language: nil,
           # The speech to text model to be used by the voice assistant. Supported models
           # include:
@@ -88,7 +96,7 @@ module Telnyx
           # - `xai/grok-stt` for live streaming transcription.
           # - `soniox/stt-rt-v4` for live streaming multilingual transcription with
           #   automatic language detection.
-          # - `parakeet/tdt-0.6b-v3` for multilingual transcription with automatic language
+          # - `nvidia/parakeet-v3` for multilingual transcription with automatic language
           #   detection.
           # - `azure/fast` and `azure/realtime`; Azure models require `region`, and
           #   unsupported regions require `api_key_ref`.
@@ -123,7 +131,7 @@ module Telnyx
         # - `xai/grok-stt` for live streaming transcription.
         # - `soniox/stt-rt-v4` for live streaming multilingual transcription with
         #   automatic language detection.
-        # - `parakeet/tdt-0.6b-v3` for multilingual transcription with automatic language
+        # - `nvidia/parakeet-v3` for multilingual transcription with automatic language
         #   detection.
         # - `azure/fast` and `azure/realtime`; Azure models require `region`, and
         #   unsupported regions require `api_key_ref`.
@@ -186,9 +194,9 @@ module Telnyx
               :"soniox/stt-rt-v4",
               Telnyx::Calls::TranscriptionConfig::Model::TaggedSymbol
             )
-          PARAKEET_TDT_0_6B_V3 =
+          NVIDIA_PARAKEET_V3 =
             T.let(
-              :"parakeet/tdt-0.6b-v3",
+              :"nvidia/parakeet-v3",
               Telnyx::Calls::TranscriptionConfig::Model::TaggedSymbol
             )
           AZURE_FAST =

data/rbi/telnyx/models/calls/transcription_engine_parakeet_config.rbi

@@ -133,9 +133,9 @@ module Telnyx
             end
           OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-          PARAKEET_TDT_0_6B_V3 =
+          NVIDIA_PARAKEET_V3 =
             T.let(
-              :"parakeet/tdt-0.6b-v3",
+              :"nvidia/parakeet-v3",
               Telnyx::Calls::TranscriptionEngineParakeetConfig::TranscriptionModel::TaggedSymbol
             )
 

data/rbi/telnyx/models/doc_reqs_requirement.rbi

@@ -63,6 +63,15 @@ module Telnyx
       sig { params(created_at: String).void }
       attr_writer :created_at
 
+      # When this version was superseded. NULL means this is the active or pending
+      # version.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :effective_end_at
+
+      # When this version became (or will become) active.
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :effective_start_at
+
       # Identifies the type of the resource.
       sig { returns(T.nilable(String)) }
       attr_reader :record_type
@@ -72,14 +81,14 @@ module Telnyx
 
       # Lists the requirement types necessary to fulfill this requirement
       sig { returns(T.nilable(T::Array[Telnyx::DocReqsRequirementType])) }
-      attr_reader :requirements_types
+      attr_reader :requirement_types
 
       sig do
         params(
-          requirements_types: T::Array[Telnyx::DocReqsRequirementType::OrHash]
+          requirement_types: T::Array[Telnyx::DocReqsRequirementType::OrHash]
         ).void
       end
-      attr_writer :requirements_types
+      attr_writer :requirement_types
 
       # ISO 8601 formatted date-time indicating when the resource was last updated.
       sig { returns(T.nilable(String)) }
@@ -88,18 +97,28 @@ module Telnyx
       sig { params(updated_at: String).void }
       attr_writer :updated_at
 
+      # Version number. Increments with each new version. Defaults to 1.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :version
+
+      sig { params(version: Integer).void }
+      attr_writer :version
+
       sig do
         params(
           id: String,
           action: Telnyx::DocReqsRequirement::Action::OrSymbol,
           country_code: String,
           created_at: String,
+          effective_end_at: T.nilable(Time),
+          effective_start_at: T.nilable(Time),
           locality: String,
           phone_number_type:
             Telnyx::DocReqsRequirement::PhoneNumberType::OrSymbol,
           record_type: String,
-          requirements_types: T::Array[Telnyx::DocReqsRequirementType::OrHash],
-          updated_at: String
+          requirement_types: T::Array[Telnyx::DocReqsRequirementType::OrHash],
+          updated_at: String,
+          version: Integer
         ).returns(T.attached_class)
       end
       def self.new(
@@ -112,6 +131,11 @@ module Telnyx
         country_code: nil,
         # ISO 8601 formatted date-time indicating when the resource was created.
         created_at: nil,
+        # When this version was superseded. NULL means this is the active or pending
+        # version.
+        effective_end_at: nil,
+        # When this version became (or will become) active.
+        effective_start_at: nil,
         # The locality where this requirement applies
         locality: nil,
         # Indicates the phone_number_type this requirement applies to. Leave blank if this
@@ -120,9 +144,11 @@ module Telnyx
         # Identifies the type of the resource.
         record_type: nil,
         # Lists the requirement types necessary to fulfill this requirement
-        requirements_types: nil,
+        requirement_types: nil,
         # ISO 8601 formatted date-time indicating when the resource was last updated.
-        updated_at: nil
+        updated_at: nil,
+        # Version number. Increments with each new version. Defaults to 1.
+        version: nil
       )
       end
 
@@ -133,12 +159,15 @@ module Telnyx
             action: Telnyx::DocReqsRequirement::Action::TaggedSymbol,
             country_code: String,
             created_at: String,
+            effective_end_at: T.nilable(Time),
+            effective_start_at: T.nilable(Time),
             locality: String,
             phone_number_type:
               Telnyx::DocReqsRequirement::PhoneNumberType::TaggedSymbol,
             record_type: String,
-            requirements_types: T::Array[Telnyx::DocReqsRequirementType],
-            updated_at: String
+            requirement_types: T::Array[Telnyx::DocReqsRequirementType],
+            updated_at: String,
+            version: Integer
           }
         )
       end