telnyx 5.168.0 → 5.169.0

data/rbi/telnyx/resources/texml.rbi

@@ -4,6 +4,10 @@ module Telnyx
   module Resources
     # TeXML REST Commands
     class Texml
+      # TeXML REST Commands
+      sig { returns(Telnyx::Resources::Texml::Calls) }
+      attr_reader :calls
+
       # TeXML REST Commands
       sig { returns(Telnyx::Resources::Texml::Accounts) }
       attr_reader :accounts
@@ -46,8 +50,15 @@ module Telnyx
             Telnyx::TexmlInitiateAICallParams::DetectionMode::OrSymbol,
           machine_detection:
             Telnyx::TexmlInitiateAICallParams::MachineDetection::OrSymbol,
+          machine_detection_beep_max_frequency: Integer,
+          machine_detection_beep_min_frequency: Integer,
+          machine_detection_beep_min_tone_duration: Integer,
           machine_detection_beep_profile:
             Telnyx::TexmlInitiateAICallParams::MachineDetectionBeepProfile::OrSymbol,
+          machine_detection_beep_spectral_confirmation: T::Boolean,
+          machine_detection_beep_spectral_min_purity: Float,
+          machine_detection_beep_spectral_reject_fax_cng: T::Boolean,
+          machine_detection_beep_spectral_window: Integer,
           machine_detection_prompt_end_timeout: Integer,
           machine_detection_silence_timeout: Integer,
           machine_detection_speech_end_threshold: Integer,
@@ -124,11 +135,36 @@ module Telnyx
         detection_mode: nil,
         # Enables Answering Machine Detection.
         machine_detection: nil,
+        # Highest frequency, in Hz, that a tone can reach and still be treated as a beep.
+        # Only used when MachineDetection is enabled.
+        machine_detection_beep_max_frequency: nil,
+        # Lowest frequency, in Hz, that a tone must reach to be treated as a beep. Raising
+        # it above 480 excludes North American ringback (440 + 480 Hz), which can
+        # otherwise be reported as a beep when the `freq_only` profile is in use. Only
+        # used when MachineDetection is enabled.
+        machine_detection_beep_min_frequency: nil,
+        # Shortest tone, in milliseconds, that can be treated as a beep. Raising it
+        # rejects brief tones such as call-progress blips. Only used when MachineDetection
+        # is enabled.
+        machine_detection_beep_min_tone_duration: nil,
         # Selects which detectors must validate a beep. `both` requires the amplitude and
         # frequency detectors to agree. `freq_only` uses the frequency detector alone, for
         # beeps whose volume is too unsteady for the default profile. Only used when
         # MachineDetection is enabled.
         machine_detection_beep_profile: nil,
+        # When enabled, a candidate beep must pass an additional spectral check before it
+        # is reported. Only used when MachineDetection is enabled.
+        machine_detection_beep_spectral_confirmation: nil,
+        # Minimum spectral purity, from 0 to 1, for a tone to be treated as a beep.
+        # Raising it rejects mixed tones such as ringback, which combines two frequencies.
+        # Only used when MachineDetection is enabled.
+        machine_detection_beep_spectral_min_purity: nil,
+        # When enabled, the fax CNG tone is rejected rather than reported as a beep. Only
+        # used when MachineDetection is enabled.
+        machine_detection_beep_spectral_reject_fax_cng: nil,
+        # Length of the spectral confirmation window, in milliseconds. Only used when
+        # MachineDetection is enabled.
+        machine_detection_beep_spectral_window: nil,
         # Silence duration threshold after a call screening prompt before ending prompt
         # detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
         machine_detection_prompt_end_timeout: nil,

data/rbi/telnyx/resources/voice_clones.rbi

@@ -88,8 +88,10 @@ module Telnyx
       end
 
       # Creates a new voice clone by uploading an audio file directly. Supported
-      # formats: WAV, MP3, FLAC, OGG, M4A. For best results, provide 5–10 seconds of
-      # clear speech. Maximum file size: 5MB for Telnyx, 20MB for Minimax.
+      # formats: WAV, MP3, FLAC, OGG, M4A. For best results, provide 5–60 seconds of
+      # clear speech (Ultra accepts up to 60 seconds; Qwen3TTS auto-trims to 10 seconds;
+      # Minimax accepts up to 5 minutes). Maximum file size: 5MB for Telnyx, 20MB for
+      # Minimax.
       sig do
         params(
           voice_clone_upload_request:

data/sig/telnyx/client.rbs

@@ -382,6 +382,16 @@ module Telnyx
 
     attr_reader compute: Telnyx::Resources::Compute
 
+    attr_reader noise_suppression_engines: Telnyx::Resources::NoiseSuppressionEngines
+
+    attr_reader bot_challenge: Telnyx::Resources::BotChallenge
+
+    attr_reader bot_sessions: Telnyx::Resources::BotSessions
+
+    attr_reader bot_signup: Telnyx::Resources::BotSignup
+
+    attr_reader machine_payments: Telnyx::Resources::MachinePayments
+
     private def auth_headers: -> ::Hash[String, String]
 
     private def bearer_auth: -> ::Hash[String, String]

data/sig/telnyx/models/ai/assistant_tool.rbs

@@ -2,11 +2,12 @@ module Telnyx
   module Models
     module AI
       type assistant_tool =
-        Telnyx::AI::InferenceEmbeddingWebhookToolParams
+        Telnyx::AI::AssistantTool::Function
+        | Telnyx::AI::InferenceEmbeddingWebhookToolParams
         | Telnyx::AI::AssistantTool::ClientSideTool
         | Telnyx::AI::RetrievalTool
         | Telnyx::AI::AssistantTool::Handoff
-        | Telnyx::AI::HangupTool
+        | Telnyx::AI::AssistantTool::Hangup
         | Telnyx::AI::AssistantTool::Transfer
         | Telnyx::AI::AssistantTool::Invite
         | Telnyx::AI::AssistantTool::Refer
@@ -19,10 +20,40 @@ module Telnyx
       module AssistantTool
         extend Telnyx::Internal::Type::Union
 
+        type function =
+          {
+            function: Telnyx::AI::OpenAI::FunctionDefinition,
+            type: :function,
+            shared: bool
+          }
+
+        class Function < Telnyx::Internal::Type::BaseModel
+          attr_accessor function: Telnyx::AI::OpenAI::FunctionDefinition
+
+          attr_accessor type: :function
+
+          attr_reader shared: bool?
+
+          def shared=: (bool) -> bool
+
+          def initialize: (
+            function: Telnyx::AI::OpenAI::FunctionDefinition,
+            ?shared: bool,
+            ?type: :function
+          ) -> void
+
+          def to_hash: -> {
+            function: Telnyx::AI::OpenAI::FunctionDefinition,
+            type: :function,
+            shared: bool
+          }
+        end
+
         type client_side_tool =
           {
             client_side_tool: Telnyx::AI::AssistantTool::ClientSideTool::ClientSideTool,
-            type: :client_side_tool
+            type: :client_side_tool,
+            shared: bool
           }
 
         class ClientSideTool < Telnyx::Internal::Type::BaseModel
@@ -30,14 +61,20 @@ module Telnyx
 
           attr_accessor type: :client_side_tool
 
+          attr_reader shared: bool?
+
+          def shared=: (bool) -> bool
+
           def initialize: (
             client_side_tool: Telnyx::AI::AssistantTool::ClientSideTool::ClientSideTool,
+            ?shared: bool,
             ?type: :client_side_tool
           ) -> void
 
           def to_hash: -> {
             client_side_tool: Telnyx::AI::AssistantTool::ClientSideTool::ClientSideTool,
-            type: :client_side_tool
+            type: :client_side_tool,
+            shared: bool
           }
 
           type client_side_tool =
@@ -116,7 +153,8 @@ module Telnyx
         type handoff =
           {
             handoff: Telnyx::AI::AssistantTool::Handoff::Handoff,
-            type: :handoff
+            type: :handoff,
+            shared: bool
           }
 
         class Handoff < Telnyx::Internal::Type::BaseModel
@@ -124,14 +162,20 @@ module Telnyx
 
           attr_accessor type: :handoff
 
+          attr_reader shared: bool?
+
+          def shared=: (bool) -> bool
+
           def initialize: (
             handoff: Telnyx::AI::AssistantTool::Handoff::Handoff,
+            ?shared: bool,
             ?type: :handoff
           ) -> void
 
           def to_hash: -> {
             handoff: Telnyx::AI::AssistantTool::Handoff::Handoff,
-            type: :handoff
+            type: :handoff,
+            shared: bool
           }
 
           type handoff =
@@ -184,10 +228,36 @@ module Telnyx
           end
         end
 
+        type hangup =
+          { hangup: Telnyx::AI::HangupToolParams, type: :hangup, shared: bool }
+
+        class Hangup < Telnyx::Internal::Type::BaseModel
+          attr_accessor hangup: Telnyx::AI::HangupToolParams
+
+          attr_accessor type: :hangup
+
+          attr_reader shared: bool?
+
+          def shared=: (bool) -> bool
+
+          def initialize: (
+            hangup: Telnyx::AI::HangupToolParams,
+            ?shared: bool,
+            ?type: :hangup
+          ) -> void
+
+          def to_hash: -> {
+            hangup: Telnyx::AI::HangupToolParams,
+            type: :hangup,
+            shared: bool
+          }
+        end
+
         type transfer =
           {
             transfer: Telnyx::AI::AssistantTool::Transfer::Transfer,
-            type: :transfer
+            type: :transfer,
+            shared: bool
           }
 
         class Transfer < Telnyx::Internal::Type::BaseModel
@@ -195,14 +265,20 @@ module Telnyx
 
           attr_accessor type: :transfer
 
+          attr_reader shared: bool?
+
+          def shared=: (bool) -> bool
+
           def initialize: (
             transfer: Telnyx::AI::AssistantTool::Transfer::Transfer,
+            ?shared: bool,
             ?type: :transfer
           ) -> void
 
           def to_hash: -> {
             transfer: Telnyx::AI::AssistantTool::Transfer::Transfer,
-            type: :transfer
+            type: :transfer,
+            shared: bool
           }
 
           type transfer =
@@ -590,21 +666,31 @@ module Telnyx
         end
 
         type invite =
-          { invite: Telnyx::AI::AssistantTool::Invite::Invite, type: :invite }
+          {
+            invite: Telnyx::AI::AssistantTool::Invite::Invite,
+            type: :invite,
+            shared: bool
+          }
 
         class Invite < Telnyx::Internal::Type::BaseModel
           attr_accessor invite: Telnyx::AI::AssistantTool::Invite::Invite
 
           attr_accessor type: :invite
 
+          attr_reader shared: bool?
+
+          def shared=: (bool) -> bool
+
           def initialize: (
             invite: Telnyx::AI::AssistantTool::Invite::Invite,
+            ?shared: bool,
             ?type: :invite
           ) -> void
 
           def to_hash: -> {
             invite: Telnyx::AI::AssistantTool::Invite::Invite,
-            type: :invite
+            type: :invite,
+            shared: bool
           }
 
           type invite =
@@ -763,21 +849,31 @@ module Telnyx
         end
 
         type refer =
-          { refer: Telnyx::AI::AssistantTool::Refer::Refer, type: :refer }
+          {
+            refer: Telnyx::AI::AssistantTool::Refer::Refer,
+            type: :refer,
+            shared: bool
+          }
 
         class Refer < Telnyx::Internal::Type::BaseModel
           attr_accessor refer: Telnyx::AI::AssistantTool::Refer::Refer
 
           attr_accessor type: :refer
 
+          attr_reader shared: bool?
+
+          def shared=: (bool) -> bool
+
           def initialize: (
             refer: Telnyx::AI::AssistantTool::Refer::Refer,
+            ?shared: bool,
             ?type: :refer
           ) -> void
 
           def to_hash: -> {
             refer: Telnyx::AI::AssistantTool::Refer::Refer,
-            type: :refer
+            type: :refer,
+            shared: bool
           }
 
           type refer =
@@ -907,25 +1003,36 @@ module Telnyx
           end
         end
 
-        type send_dtmf = { send_dtmf: ::Hash[Symbol, top], type: :send_dtmf }
+        type send_dtmf =
+          { send_dtmf: ::Hash[Symbol, top], type: :send_dtmf, shared: bool }
 
         class SendDtmf < Telnyx::Internal::Type::BaseModel
           attr_accessor send_dtmf: ::Hash[Symbol, top]
 
           attr_accessor type: :send_dtmf
 
+          attr_reader shared: bool?
+
+          def shared=: (bool) -> bool
+
           def initialize: (
             send_dtmf: ::Hash[Symbol, top],
+            ?shared: bool,
             ?type: :send_dtmf
           ) -> void
 
-          def to_hash: -> { send_dtmf: ::Hash[Symbol, top], type: :send_dtmf }
+          def to_hash: -> {
+            send_dtmf: ::Hash[Symbol, top],
+            type: :send_dtmf,
+            shared: bool
+          }
         end
 
         type send_message =
           {
             send_message: Telnyx::AI::AssistantTool::SendMessage::SendMessage,
-            type: :send_message
+            type: :send_message,
+            shared: bool
           }
 
         class SendMessage < Telnyx::Internal::Type::BaseModel
@@ -933,14 +1040,20 @@ module Telnyx
 
           attr_accessor type: :send_message
 
+          attr_reader shared: bool?
+
+          def shared=: (bool) -> bool
+
           def initialize: (
             send_message: Telnyx::AI::AssistantTool::SendMessage::SendMessage,
+            ?shared: bool,
             ?type: :send_message
           ) -> void
 
           def to_hash: -> {
             send_message: Telnyx::AI::AssistantTool::SendMessage::SendMessage,
-            type: :send_message
+            type: :send_message,
+            shared: bool
           }
 
           type send_message = { message_template: String? }
@@ -957,7 +1070,8 @@ module Telnyx
         type skip_turn =
           {
             skip_turn: Telnyx::AI::AssistantTool::SkipTurn::SkipTurn,
-            type: :skip_turn
+            type: :skip_turn,
+            shared: bool
           }
 
         class SkipTurn < Telnyx::Internal::Type::BaseModel
@@ -965,14 +1079,20 @@ module Telnyx
 
           attr_accessor type: :skip_turn
 
+          attr_reader shared: bool?
+
+          def shared=: (bool) -> bool
+
           def initialize: (
             skip_turn: Telnyx::AI::AssistantTool::SkipTurn::SkipTurn,
+            ?shared: bool,
             ?type: :skip_turn
           ) -> void
 
           def to_hash: -> {
             skip_turn: Telnyx::AI::AssistantTool::SkipTurn::SkipTurn,
-            type: :skip_turn
+            type: :skip_turn,
+            shared: bool
           }
 
           type skip_turn = { description: String }
@@ -988,22 +1108,35 @@ module Telnyx
           end
         end
 
-        type pay = { pay: Telnyx::AI::PayToolParams, type: :pay }
+        type pay = { pay: Telnyx::AI::PayToolParams, type: :pay, shared: bool }
 
         class Pay < Telnyx::Internal::Type::BaseModel
           attr_accessor pay: Telnyx::AI::PayToolParams
 
           attr_accessor type: :pay
 
-          def initialize: (pay: Telnyx::AI::PayToolParams, ?type: :pay) -> void
+          attr_reader shared: bool?
+
+          def shared=: (bool) -> bool
 
-          def to_hash: -> { pay: Telnyx::AI::PayToolParams, type: :pay }
+          def initialize: (
+            pay: Telnyx::AI::PayToolParams,
+            ?shared: bool,
+            ?type: :pay
+          ) -> void
+
+          def to_hash: -> {
+            pay: Telnyx::AI::PayToolParams,
+            type: :pay,
+            shared: bool
+          }
         end
 
         type update_dynamic_variables =
           {
             type: :update_dynamic_variables,
-            update_dynamic_variables: Telnyx::AI::UpdateDynamicVariablesToolParams
+            update_dynamic_variables: Telnyx::AI::UpdateDynamicVariablesToolParams,
+            shared: bool
           }
 
         class UpdateDynamicVariables < Telnyx::Internal::Type::BaseModel
@@ -1011,14 +1144,20 @@ module Telnyx
 
           attr_accessor update_dynamic_variables: Telnyx::AI::UpdateDynamicVariablesToolParams
 
+          attr_reader shared: bool?
+
+          def shared=: (bool) -> bool
+
           def initialize: (
             update_dynamic_variables: Telnyx::AI::UpdateDynamicVariablesToolParams,
+            ?shared: bool,
             ?type: :update_dynamic_variables
           ) -> void
 
           def to_hash: -> {
             type: :update_dynamic_variables,
-            update_dynamic_variables: Telnyx::AI::UpdateDynamicVariablesToolParams
+            update_dynamic_variables: Telnyx::AI::UpdateDynamicVariablesToolParams,
+            shared: bool
           }
         end
 

data/sig/telnyx/models/ai/audio_transcribe_params.rbs

@@ -74,14 +74,24 @@ module Telnyx
         type model =
           :"distil-whisper/distil-large-v2"
           | :"openai/whisper-large-v3-turbo"
+          | :"deepgram/nova-2"
+          | :"deepgram/nova-2-medical"
           | :"deepgram/nova-3"
+          | :"deepgram/nova-3-medical"
+          | :"nvidia/parakeet-v3"
+          | :"omi-health/omi-med-stt-v1"
 
         module Model
           extend Telnyx::Internal::Type::Enum
 
           DISTIL_WHISPER_DISTIL_LARGE_V2: :"distil-whisper/distil-large-v2"
           OPENAI_WHISPER_LARGE_V3_TURBO: :"openai/whisper-large-v3-turbo"
+          DEEPGRAM_NOVA_2: :"deepgram/nova-2"
+          DEEPGRAM_NOVA_2_MEDICAL: :"deepgram/nova-2-medical"
           DEEPGRAM_NOVA_3: :"deepgram/nova-3"
+          DEEPGRAM_NOVA_3_MEDICAL: :"deepgram/nova-3-medical"
+          NVIDIA_PARAKEET_V3: :"nvidia/parakeet-v3"
+          OMI_HEALTH_OMI_MED_STT_V1: :"omi-health/omi-med-stt-v1"
 
           def self?.values: -> ::Array[Telnyx::Models::AI::AudioTranscribeParams::model]
         end

data/sig/telnyx/models/ai/audio_transcribe_response.rbs

@@ -6,7 +6,7 @@ module Telnyx
           text: String,
           duration: Float,
           segments: ::Array[Telnyx::Models::AI::AudioTranscribeResponse::Segment],
-          words: ::Array[Telnyx::Models::AI::AudioTranscribeResponse::Word]
+          words: ::Array[Telnyx::AI::AudioTranscriptionResponseWord]
         }
 
       class AudioTranscribeResponse < Telnyx::Internal::Type::BaseModel
@@ -22,85 +22,71 @@ module Telnyx
           ::Array[Telnyx::Models::AI::AudioTranscribeResponse::Segment]
         ) -> ::Array[Telnyx::Models::AI::AudioTranscribeResponse::Segment]
 
-        attr_reader words: ::Array[Telnyx::Models::AI::AudioTranscribeResponse::Word]?
+        attr_reader words: ::Array[Telnyx::AI::AudioTranscriptionResponseWord]?
 
         def words=: (
-          ::Array[Telnyx::Models::AI::AudioTranscribeResponse::Word]
-        ) -> ::Array[Telnyx::Models::AI::AudioTranscribeResponse::Word]
+          ::Array[Telnyx::AI::AudioTranscriptionResponseWord]
+        ) -> ::Array[Telnyx::AI::AudioTranscriptionResponseWord]
 
         def initialize: (
           text: String,
           ?duration: Float,
           ?segments: ::Array[Telnyx::Models::AI::AudioTranscribeResponse::Segment],
-          ?words: ::Array[Telnyx::Models::AI::AudioTranscribeResponse::Word]
+          ?words: ::Array[Telnyx::AI::AudioTranscriptionResponseWord]
         ) -> void
 
         def to_hash: -> {
           text: String,
           duration: Float,
           segments: ::Array[Telnyx::Models::AI::AudioTranscribeResponse::Segment],
-          words: ::Array[Telnyx::Models::AI::AudioTranscribeResponse::Word]
+          words: ::Array[Telnyx::AI::AudioTranscriptionResponseWord]
         }
 
-        type segment = { id: Float, end_: Float, start: Float, text: String }
-
-        class Segment < Telnyx::Internal::Type::BaseModel
-          attr_accessor id: Float
-
-          attr_accessor end_: Float
-
-          attr_accessor start: Float
-
-          attr_accessor text: String
-
-          def initialize: (
-            id: Float,
-            end_: Float,
-            start: Float,
-            text: String
-          ) -> void
-
-          def to_hash: -> { id: Float, end_: Float, start: Float, text: String }
-        end
-
-        type word =
+        type segment =
           {
+            id: Float,
             end_: Float,
             start: Float,
-            word: String,
-            confidence: Float,
-            speaker: Integer
+            text: String,
+            speakers: ::Array[Integer],
+            words: ::Array[Telnyx::AI::AudioTranscriptionResponseWord]
           }
 
-        class Word < Telnyx::Internal::Type::BaseModel
+        class Segment < Telnyx::Internal::Type::BaseModel
+          attr_accessor id: Float
+
           attr_accessor end_: Float
 
           attr_accessor start: Float
 
-          attr_accessor word: String
+          attr_accessor text: String
 
-          attr_reader confidence: Float?
+          attr_reader speakers: ::Array[Integer]?
 
-          def confidence=: (Float) -> Float
+          def speakers=: (::Array[Integer]) -> ::Array[Integer]
 
-          attr_reader speaker: Integer?
+          attr_reader words: ::Array[Telnyx::AI::AudioTranscriptionResponseWord]?
 
-          def speaker=: (Integer) -> Integer
+          def words=: (
+            ::Array[Telnyx::AI::AudioTranscriptionResponseWord]
+          ) -> ::Array[Telnyx::AI::AudioTranscriptionResponseWord]
 
           def initialize: (
+            id: Float,
             end_: Float,
             start: Float,
-            word: String,
-            ?confidence: Float,
-            ?speaker: Integer
+            text: String,
+            ?speakers: ::Array[Integer],
+            ?words: ::Array[Telnyx::AI::AudioTranscriptionResponseWord]
           ) -> void
 
           def to_hash: -> {
+            id: Float,
             end_: Float,
             start: Float,
-            word: String,
-            confidence: Float,
-            speaker: Integer
+            text: String,
+            speakers: ::Array[Integer],
+            words: ::Array[Telnyx::AI::AudioTranscriptionResponseWord]
           }
         end
       end

data/sig/telnyx/models/ai/audio_transcription_response_word.rbs

@@ -0,0 +1,60 @@
+module Telnyx
+  module Models
+    module AI
+      type audio_transcription_response_word =
+        {
+          end_: Float,
+          start: Float,
+          word: String,
+          confidence: Float,
+          punctuated_word: String,
+          speaker: Integer,
+          speaker_confidence: Float
+        }
+
+      class AudioTranscriptionResponseWord < Telnyx::Internal::Type::BaseModel
+        attr_accessor end_: Float
+
+        attr_accessor start: Float
+
+        attr_accessor word: String
+
+        attr_reader confidence: Float?
+
+        def confidence=: (Float) -> Float
+
+        attr_reader punctuated_word: String?
+
+        def punctuated_word=: (String) -> String
+
+        attr_reader speaker: Integer?
+
+        def speaker=: (Integer) -> Integer
+
+        attr_reader speaker_confidence: Float?
+
+        def speaker_confidence=: (Float) -> Float
+
+        def initialize: (
+          end_: Float,
+          start: Float,
+          word: String,
+          ?confidence: Float,
+          ?punctuated_word: String,
+          ?speaker: Integer,
+          ?speaker_confidence: Float
+        ) -> void
+
+        def to_hash: -> {
+          end_: Float,
+          start: Float,
+          word: String,
+          confidence: Float,
+          punctuated_word: String,
+          speaker: Integer,
+          speaker_confidence: Float
+        }
+      end
+    end
+  end
+end