telnyx 5.158.0 → 5.159.0

data/rbi/telnyx/models/s3_configuration_data.rbi

@@ -8,67 +8,55 @@ module Telnyx
           T.any(Telnyx::S3ConfigurationData, Telnyx::Internal::AnyHash)
         end
 
-      # Storage backend type
-      sig { returns(Telnyx::S3ConfigurationData::Backend::OrSymbol) }
-      attr_accessor :backend
-
       # AWS credentials access key id.
-      sig { returns(T.nilable(String)) }
-      attr_reader :aws_access_key_id
-
-      sig { params(aws_access_key_id: String).void }
-      attr_writer :aws_access_key_id
+      sig { returns(String) }
+      attr_accessor :aws_access_key_id
 
       # AWS secret access key.
-      sig { returns(T.nilable(String)) }
-      attr_reader :aws_secret_access_key
+      sig { returns(String) }
+      attr_accessor :aws_secret_access_key
 
-      sig { params(aws_secret_access_key: String).void }
-      attr_writer :aws_secret_access_key
+      # Storage backend type
+      sig { returns(Telnyx::S3ConfigurationData::Backend::OrSymbol) }
+      attr_accessor :backend
 
       # Name of the bucket to be used to store recording files.
-      sig { returns(T.nilable(String)) }
-      attr_reader :bucket
-
-      sig { params(bucket: String).void }
-      attr_writer :bucket
+      sig { returns(String) }
+      attr_accessor :bucket
 
       # Region where the bucket is located.
-      sig { returns(T.nilable(String)) }
-      attr_reader :region
-
-      sig { params(region: String).void }
-      attr_writer :region
+      sig { returns(String) }
+      attr_accessor :region
 
       sig do
         params(
-          backend: Telnyx::S3ConfigurationData::Backend::OrSymbol,
           aws_access_key_id: String,
           aws_secret_access_key: String,
+          backend: Telnyx::S3ConfigurationData::Backend::OrSymbol,
           bucket: String,
           region: String
         ).returns(T.attached_class)
       end
       def self.new(
-        # Storage backend type
-        backend:,
         # AWS credentials access key id.
-        aws_access_key_id: nil,
+        aws_access_key_id:,
         # AWS secret access key.
-        aws_secret_access_key: nil,
+        aws_secret_access_key:,
+        # Storage backend type
+        backend:,
         # Name of the bucket to be used to store recording files.
-        bucket: nil,
+        bucket:,
         # Region where the bucket is located.
-        region: nil
+        region:
       )
       end
 
       sig do
         override.returns(
           {
-            backend: Telnyx::S3ConfigurationData::Backend::OrSymbol,
             aws_access_key_id: String,
             aws_secret_access_key: String,
+            backend: Telnyx::S3ConfigurationData::Backend::OrSymbol,
             bucket: String,
             region: String
           }

data/rbi/telnyx/models/short_code.rbi

@@ -10,6 +10,7 @@ module Telnyx
       sig { returns(T.nilable(String)) }
       attr_accessor :messaging_profile_id
 
+      # Tags associated with the resource.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :tags
 
@@ -83,6 +84,7 @@ module Telnyx
         record_type: nil,
         # Short digit sequence used to address messages.
         short_code: nil,
+        # Tags associated with the resource.
         tags: nil,
         # ISO 8601 formatted date indicating when the resource was updated.
         updated_at: nil

data/rbi/telnyx/models/short_code_update_params.rbi

@@ -18,6 +18,7 @@ module Telnyx
       sig { returns(String) }
       attr_accessor :messaging_profile_id
 
+      # Tags associated with the resource.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :tags
 
@@ -36,6 +37,7 @@ module Telnyx
         id:,
         # Unique identifier for a messaging profile.
         messaging_profile_id:,
+        # Tags associated with the resource.
         tags: nil,
         request_options: {}
       )

data/rbi/telnyx/models/speech_to_text_list_providers_params.rbi

@@ -127,6 +127,16 @@ module Telnyx
             :parakeet,
             Telnyx::SpeechToTextListProvidersParams::Provider::TaggedSymbol
           )
+        HUMAIN =
+          T.let(
+            :humain,
+            Telnyx::SpeechToTextListProvidersParams::Provider::TaggedSymbol
+          )
+        RESON8 =
+          T.let(
+            :reson8,
+            Telnyx::SpeechToTextListProvidersParams::Provider::TaggedSymbol
+          )
         AZURE =
           T.let(
             :azure,

data/rbi/telnyx/models/speech_to_text_retrieve_transcription_params.rbi

@@ -254,6 +254,16 @@ module Telnyx
             :Parakeet,
             Telnyx::SpeechToTextRetrieveTranscriptionParams::TranscriptionEngine::TaggedSymbol
           )
+        HUMAIN =
+          T.let(
+            :Humain,
+            Telnyx::SpeechToTextRetrieveTranscriptionParams::TranscriptionEngine::TaggedSymbol
+          )
+        RESON8 =
+          T.let(
+            :Reson8,
+            Telnyx::SpeechToTextRetrieveTranscriptionParams::TranscriptionEngine::TaggedSymbol
+          )
 
         sig do
           override.returns(
@@ -364,6 +374,16 @@ module Telnyx
             :"nvidia/parakeet-v3",
             Telnyx::SpeechToTextRetrieveTranscriptionParams::Model::TaggedSymbol
           )
+        HUMAIN_REALTIME =
+          T.let(
+            :"humain/realtime",
+            Telnyx::SpeechToTextRetrieveTranscriptionParams::Model::TaggedSymbol
+          )
+        RESON8_TURNS =
+          T.let(
+            :"reson8/turns",
+            Telnyx::SpeechToTextRetrieveTranscriptionParams::Model::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/telnyx/models/text_to_speech_generate_speech_params.rbi

@@ -63,6 +63,21 @@ module Telnyx
       end
       attr_writer :elevenlabs
 
+      # Humain provider-specific parameters. Unlike other providers, Humain has no
+      # format/sample-rate negotiation (output is always PCM16 24kHz mono) and no
+      # language parameter — language is fixed per voice.
+      sig do
+        returns(T.nilable(::Telnyx::TextToSpeechGenerateSpeechParams::Humain))
+      end
+      attr_reader :humain
+
+      sig do
+        params(
+          humain: ::Telnyx::TextToSpeechGenerateSpeechParams::Humain::OrHash
+        ).void
+      end
+      attr_writer :humain
+
       # Language code (e.g. `en-US`). Usage varies by provider.
       sig { returns(T.nilable(String)) }
       attr_reader :language
@@ -228,6 +243,7 @@ module Telnyx
           disable_cache: T::Boolean,
           elevenlabs:
             ::Telnyx::TextToSpeechGenerateSpeechParams::Elevenlabs::OrHash,
+          humain: ::Telnyx::TextToSpeechGenerateSpeechParams::Humain::OrHash,
           language: String,
           minimax: ::Telnyx::TextToSpeechGenerateSpeechParams::Minimax::OrHash,
           output_type:
@@ -256,6 +272,10 @@ module Telnyx
         disable_cache: nil,
         # ElevenLabs provider-specific parameters.
         elevenlabs: nil,
+        # Humain provider-specific parameters. Unlike other providers, Humain has no
+        # format/sample-rate negotiation (output is always PCM16 24kHz mono) and no
+        # language parameter — language is fixed per voice.
+        humain: nil,
         # Language code (e.g. `en-US`). Usage varies by provider.
         language: nil,
         # Minimax provider-specific parameters.
@@ -302,6 +322,7 @@ module Telnyx
             azure: ::Telnyx::TextToSpeechGenerateSpeechParams::Azure,
             disable_cache: T::Boolean,
             elevenlabs: ::Telnyx::TextToSpeechGenerateSpeechParams::Elevenlabs,
+            humain: ::Telnyx::TextToSpeechGenerateSpeechParams::Humain,
             language: String,
             minimax: ::Telnyx::TextToSpeechGenerateSpeechParams::Minimax,
             output_type:
@@ -680,6 +701,116 @@ module Telnyx
         end
       end
 
+      class Humain < ::Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ::Telnyx::TextToSpeechGenerateSpeechParams::Humain,
+              ::Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Humain voice identifier.
+        sig do
+          returns(
+            ::Telnyx::TextToSpeechGenerateSpeechParams::Humain::VoiceID::OrSymbol
+          )
+        end
+        attr_accessor :voice_id
+
+        # Time-to-first-byte eagerness, trading synthesis latency for quality.
+        sig { returns(T.nilable(Float)) }
+        attr_reader :ttfb_eagerness
+
+        sig { params(ttfb_eagerness: Float).void }
+        attr_writer :ttfb_eagerness
+
+        # Humain provider-specific parameters. Unlike other providers, Humain has no
+        # format/sample-rate negotiation (output is always PCM16 24kHz mono) and no
+        # language parameter — language is fixed per voice.
+        sig do
+          params(
+            voice_id:
+              ::Telnyx::TextToSpeechGenerateSpeechParams::Humain::VoiceID::OrSymbol,
+            ttfb_eagerness: Float
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Humain voice identifier.
+          voice_id:,
+          # Time-to-first-byte eagerness, trading synthesis latency for quality.
+          ttfb_eagerness: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              voice_id:
+                ::Telnyx::TextToSpeechGenerateSpeechParams::Humain::VoiceID::OrSymbol,
+              ttfb_eagerness: Float
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Humain voice identifier.
+        module VoiceID
+          extend ::Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ::Telnyx::TextToSpeechGenerateSpeechParams::Humain::VoiceID
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SARA_EN =
+            T.let(
+              :"sara-en",
+              ::Telnyx::TextToSpeechGenerateSpeechParams::Humain::VoiceID::TaggedSymbol
+            )
+          ABDULAZIZ_EN =
+            T.let(
+              :"abdulaziz-en",
+              ::Telnyx::TextToSpeechGenerateSpeechParams::Humain::VoiceID::TaggedSymbol
+            )
+          SARA_AR =
+            T.let(
+              :"sara-ar",
+              ::Telnyx::TextToSpeechGenerateSpeechParams::Humain::VoiceID::TaggedSymbol
+            )
+          ABDULAZIZ_AR =
+            T.let(
+              :"abdulaziz-ar",
+              ::Telnyx::TextToSpeechGenerateSpeechParams::Humain::VoiceID::TaggedSymbol
+            )
+          NOURAH_AR =
+            T.let(
+              :"nourah-ar",
+              ::Telnyx::TextToSpeechGenerateSpeechParams::Humain::VoiceID::TaggedSymbol
+            )
+          ABDULLAH_AR =
+            T.let(
+              :"abdullah-ar",
+              ::Telnyx::TextToSpeechGenerateSpeechParams::Humain::VoiceID::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ::Telnyx::TextToSpeechGenerateSpeechParams::Humain::VoiceID::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
       class Minimax < ::Telnyx::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -849,6 +980,11 @@ module Telnyx
             :xai,
             ::Telnyx::TextToSpeechGenerateSpeechParams::Provider::TaggedSymbol
           )
+        HUMAIN =
+          T.let(
+            :humain,
+            ::Telnyx::TextToSpeechGenerateSpeechParams::Provider::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/telnyx/models/text_to_speech_list_voices_params.rbi

@@ -111,6 +111,11 @@ module Telnyx
             :xai,
             Telnyx::TextToSpeechListVoicesParams::Provider::TaggedSymbol
           )
+        HUMAIN =
+          T.let(
+            :humain,
+            Telnyx::TextToSpeechListVoicesParams::Provider::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/telnyx/models/text_to_speech_retrieve_speech_params.rbi

@@ -251,6 +251,11 @@ module Telnyx
             :xai,
             Telnyx::TextToSpeechRetrieveSpeechParams::Provider::TaggedSymbol
           )
+        HUMAIN =
+          T.let(
+            :humain,
+            Telnyx::TextToSpeechRetrieveSpeechParams::Provider::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/telnyx/models/time_range.rbi

@@ -0,0 +1,28 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class TimeRange < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Telnyx::TimeRange, Telnyx::Internal::AnyHash) }
+
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :from
+
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :to
+
+      sig do
+        params(from: T.nilable(Time), to: T.nilable(Time)).returns(
+          T.attached_class
+        )
+      end
+      def self.new(from:, to:)
+      end
+
+      sig { override.returns({ from: T.nilable(Time), to: T.nilable(Time) }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/tracking_settings.rbi

@@ -0,0 +1,49 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class TrackingSettings < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::TrackingSettings, Telnyx::Internal::AnyHash)
+        end
+
+      # Whether to rewrite links for click tracking in this message.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :click_tracking
+
+      sig { params(click_tracking: T::Boolean).void }
+      attr_writer :click_tracking
+
+      # Whether to inject an open-tracking pixel for this message.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :open_tracking
+
+      sig { params(open_tracking: T::Boolean).void }
+      attr_writer :open_tracking
+
+      # Per-send open and click tracking overrides. Omitted properties inherit the
+      # sender domain's tracking settings.
+      sig do
+        params(click_tracking: T::Boolean, open_tracking: T::Boolean).returns(
+          T.attached_class
+        )
+      end
+      def self.new(
+        # Whether to rewrite links for click tracking in this message.
+        click_tracking: nil,
+        # Whether to inject an open-tracking pixel for this message.
+        open_tracking: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          { click_tracking: T::Boolean, open_tracking: T::Boolean }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/uac_external_settings.rbi

@@ -50,6 +50,11 @@ module Telnyx
       end
       attr_accessor :transport
 
+      # Custom SIP User-Agent header value that Telnyx uses on outbound REGISTER and
+      # INVITE messages. Set to null to use Telnyx's default User-Agent.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :user_agent
+
       # The SIP username used to authenticate with the external SIP peer for
       # registrations and outbound calls. Must start with a letter or number and contain
       # only letters, numbers, hyphens, and underscores.
@@ -71,6 +76,7 @@ module Telnyx
           proxy: String,
           transport:
             T.nilable(Telnyx::UacExternalSettings::Transport::OrSymbol),
+          user_agent: T.nilable(String),
           username: String
         ).returns(T.attached_class)
       end
@@ -95,6 +101,9 @@ module Telnyx
         # The transport protocol used for SIP signaling when communicating with the
         # external SIP peer. One of UDP, TLS, or TCP.
         transport: nil,
+        # Custom SIP User-Agent header value that Telnyx uses on outbound REGISTER and
+        # INVITE messages. Set to null to use Telnyx's default User-Agent.
+        user_agent: nil,
         # The SIP username used to authenticate with the external SIP peer for
         # registrations and outbound calls. Must start with a letter or number and contain
         # only letters, numbers, hyphens, and underscores.
@@ -113,6 +122,7 @@ module Telnyx
             proxy: String,
             transport:
               T.nilable(Telnyx::UacExternalSettings::Transport::OrSymbol),
+            user_agent: T.nilable(String),
             username: String
           }
         )

data/rbi/telnyx/models/unsafe_unwrap_webhook_event.rbi

@@ -31,6 +31,8 @@ module Telnyx
             Telnyx::CallMachineGreetingEndedWebhookEvent,
             Telnyx::CallMachinePremiumDetectionEndedWebhookEvent,
             Telnyx::CallMachinePremiumGreetingEndedWebhookEvent,
+            Telnyx::CallPaymentCompletedWebhookEvent,
+            Telnyx::CallPaymentProgressWebhookEvent,
             Telnyx::CallPlaybackEndedWebhookEvent,
             Telnyx::CallPlaybackStartedWebhookEvent,
             Telnyx::CallRecordingErrorWebhookEvent,

data/rbi/telnyx/models/unsubscribe_group.rbi

@@ -0,0 +1,92 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class UnsubscribeGroup < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Telnyx::UnsubscribeGroup, Telnyx::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # Always present (not omit-nullable); `null` when unset.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      sig { returns(String) }
+      attr_accessor :name
+
+      # View-only.
+      sig { returns(Telnyx::UnsubscribeGroup::RecordType::TaggedSymbol) }
+      attr_accessor :record_type
+
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          description: T.nilable(String),
+          name: String,
+          record_type: Telnyx::UnsubscribeGroup::RecordType::OrSymbol,
+          updated_at: Time
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        created_at:,
+        # Always present (not omit-nullable); `null` when unset.
+        description:,
+        name:,
+        # View-only.
+        record_type:,
+        updated_at:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            description: T.nilable(String),
+            name: String,
+            record_type: Telnyx::UnsubscribeGroup::RecordType::TaggedSymbol,
+            updated_at: Time
+          }
+        )
+      end
+      def to_hash
+      end
+
+      # View-only.
+      module RecordType
+        extend Telnyx::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, Telnyx::UnsubscribeGroup::RecordType) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        EMAIL_UNSUBSCRIBE_GROUP =
+          T.let(
+            :email_unsubscribe_group,
+            Telnyx::UnsubscribeGroup::RecordType::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[Telnyx::UnsubscribeGroup::RecordType::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/unsubscribe_group_response.rbi

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

data/rbi/telnyx/models/unwrap_webhook_event.rbi

@@ -31,6 +31,8 @@ module Telnyx
             Telnyx::CallMachineGreetingEndedWebhookEvent,
             Telnyx::CallMachinePremiumDetectionEndedWebhookEvent,
             Telnyx::CallMachinePremiumGreetingEndedWebhookEvent,
+            Telnyx::CallPaymentCompletedWebhookEvent,
+            Telnyx::CallPaymentProgressWebhookEvent,
             Telnyx::CallPlaybackEndedWebhookEvent,
             Telnyx::CallPlaybackStartedWebhookEvent,
             Telnyx::CallRecordingErrorWebhookEvent,