telnyx 5.168.0 → 5.170.0

data/rbi/telnyx/models/texml/accounts/conferences/participant_participants_params.rbi

@@ -317,6 +317,35 @@ module Telnyx
             end
             attr_writer :machine_detection
 
+            # Highest frequency, in Hz, that a tone can reach and still be treated as a beep.
+            # Only used when MachineDetection is enabled.
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :machine_detection_beep_max_frequency
+
+            sig { params(machine_detection_beep_max_frequency: Integer).void }
+            attr_writer :machine_detection_beep_max_frequency
+
+            # 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.
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :machine_detection_beep_min_frequency
+
+            sig { params(machine_detection_beep_min_frequency: Integer).void }
+            attr_writer :machine_detection_beep_min_frequency
+
+            # 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.
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :machine_detection_beep_min_tone_duration
+
+            sig do
+              params(machine_detection_beep_min_tone_duration: Integer).void
+            end
+            attr_writer :machine_detection_beep_min_tone_duration
+
             # 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
@@ -338,6 +367,49 @@ module Telnyx
             end
             attr_writer :machine_detection_beep_profile
 
+            # When enabled, a candidate beep must pass an additional spectral check before it
+            # is reported. Only used when MachineDetection is enabled.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :machine_detection_beep_spectral_confirmation
+
+            sig do
+              params(
+                machine_detection_beep_spectral_confirmation: T::Boolean
+              ).void
+            end
+            attr_writer :machine_detection_beep_spectral_confirmation
+
+            # 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.
+            sig { returns(T.nilable(Float)) }
+            attr_reader :machine_detection_beep_spectral_min_purity
+
+            sig do
+              params(machine_detection_beep_spectral_min_purity: Float).void
+            end
+            attr_writer :machine_detection_beep_spectral_min_purity
+
+            # When enabled, the fax CNG tone is rejected rather than reported as a beep. Only
+            # used when MachineDetection is enabled.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :machine_detection_beep_spectral_reject_fax_cng
+
+            sig do
+              params(
+                machine_detection_beep_spectral_reject_fax_cng: T::Boolean
+              ).void
+            end
+            attr_writer :machine_detection_beep_spectral_reject_fax_cng
+
+            # Length of the spectral confirmation window, in milliseconds. Only used when
+            # MachineDetection is enabled.
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :machine_detection_beep_spectral_window
+
+            sig { params(machine_detection_beep_spectral_window: Integer).void }
+            attr_writer :machine_detection_beep_spectral_window
+
             # If initial silence duration is greater than this value, consider it a machine.
             # Ignored when `premium` detection is used.
             sig { returns(T.nilable(Integer)) }
@@ -613,8 +685,15 @@ module Telnyx
                 label: String,
                 machine_detection:
                   Telnyx::Texml::Accounts::Conferences::ParticipantParticipantsParams::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::Texml::Accounts::Conferences::ParticipantParticipantsParams::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_silence_timeout: Integer,
                 machine_detection_speech_end_threshold: Integer,
                 machine_detection_speech_threshold: Integer,
@@ -726,11 +805,36 @@ module Telnyx
               # identified. Use `DetectMessageEnd`, if you would like to leave a message on an
               # answering machine.
               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,
               # If initial silence duration is greater than this value, consider it a machine.
               # Ignored when `premium` detection is used.
               machine_detection_silence_timeout: nil,
@@ -836,8 +940,15 @@ module Telnyx
                   label: String,
                   machine_detection:
                     Telnyx::Texml::Accounts::Conferences::ParticipantParticipantsParams::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::Texml::Accounts::Conferences::ParticipantParticipantsParams::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_silence_timeout: Integer,
                   machine_detection_speech_end_threshold: Integer,
                   machine_detection_speech_threshold: Integer,

data/rbi/telnyx/models/texml/call_create_params.rbi

@@ -0,0 +1,124 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Texml
+      class CallCreateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Texml::CallCreateParams, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :connection_id
+
+        # The E.164-formatted phone number or SIP URI to present as the caller.
+        sig { returns(String) }
+        attr_accessor :from
+
+        # The E.164-formatted phone number or SIP URI to call.
+        sig { returns(String) }
+        attr_accessor :to
+
+        # HTTP method used to retrieve TeXML instructions from Url.
+        sig do
+          returns(T.nilable(Telnyx::Texml::CallCreateParams::Method::OrSymbol))
+        end
+        attr_reader :method_
+
+        sig do
+          params(
+            method_: Telnyx::Texml::CallCreateParams::Method::OrSymbol
+          ).void
+        end
+        attr_writer :method_
+
+        # Inline TeXML instructions to execute when the call is answered.
+        sig { returns(T.nilable(String)) }
+        attr_reader :texml
+
+        sig { params(texml: String).void }
+        attr_writer :texml
+
+        # The URL from which to retrieve TeXML instructions. Overrides the TeXML
+        # application XML request URL.
+        sig { returns(T.nilable(String)) }
+        attr_reader :url
+
+        sig { params(url: String).void }
+        attr_writer :url
+
+        sig do
+          params(
+            connection_id: String,
+            from: String,
+            to: String,
+            method_: Telnyx::Texml::CallCreateParams::Method::OrSymbol,
+            texml: String,
+            url: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          connection_id:,
+          # The E.164-formatted phone number or SIP URI to present as the caller.
+          from:,
+          # The E.164-formatted phone number or SIP URI to call.
+          to:,
+          # HTTP method used to retrieve TeXML instructions from Url.
+          method_: nil,
+          # Inline TeXML instructions to execute when the call is answered.
+          texml: nil,
+          # The URL from which to retrieve TeXML instructions. Overrides the TeXML
+          # application XML request URL.
+          url: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              connection_id: String,
+              from: String,
+              to: String,
+              method_: Telnyx::Texml::CallCreateParams::Method::OrSymbol,
+              texml: String,
+              url: String,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # HTTP method used to retrieve TeXML instructions from Url.
+        module Method
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::Texml::CallCreateParams::Method)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          GET =
+            T.let(:GET, Telnyx::Texml::CallCreateParams::Method::TaggedSymbol)
+          POST =
+            T.let(:POST, Telnyx::Texml::CallCreateParams::Method::TaggedSymbol)
+
+          sig do
+            override.returns(
+              T::Array[Telnyx::Texml::CallCreateParams::Method::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/texml/call_create_response.rbi

@@ -0,0 +1,98 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Texml
+      class CallCreateResponse < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::Texml::CallCreateResponse,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # The call control ID of the created call.
+        sig { returns(String) }
+        attr_accessor :call_sid
+
+        # The caller address.
+        sig { returns(String) }
+        attr_accessor :from
+
+        # The initial status of the outbound call.
+        sig do
+          returns(
+            Telnyx::Models::Texml::CallCreateResponse::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        # The called address.
+        sig { returns(String) }
+        attr_accessor :to
+
+        sig do
+          params(
+            call_sid: String,
+            from: String,
+            status: Telnyx::Models::Texml::CallCreateResponse::Status::OrSymbol,
+            to: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The call control ID of the created call.
+          call_sid:,
+          # The caller address.
+          from:,
+          # The initial status of the outbound call.
+          status:,
+          # The called address.
+          to:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              call_sid: String,
+              from: String,
+              status:
+                Telnyx::Models::Texml::CallCreateResponse::Status::TaggedSymbol,
+              to: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The initial status of the outbound call.
+        module Status
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Telnyx::Models::Texml::CallCreateResponse::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          QUEUED =
+            T.let(
+              :queued,
+              Telnyx::Models::Texml::CallCreateResponse::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Models::Texml::CallCreateResponse::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/texml_initiate_ai_call_params.rbi

@@ -174,6 +174,33 @@ module Telnyx
       end
       attr_writer :machine_detection
 
+      # Highest frequency, in Hz, that a tone can reach and still be treated as a beep.
+      # Only used when MachineDetection is enabled.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :machine_detection_beep_max_frequency
+
+      sig { params(machine_detection_beep_max_frequency: Integer).void }
+      attr_writer :machine_detection_beep_max_frequency
+
+      # 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.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :machine_detection_beep_min_frequency
+
+      sig { params(machine_detection_beep_min_frequency: Integer).void }
+      attr_writer :machine_detection_beep_min_frequency
+
+      # 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.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :machine_detection_beep_min_tone_duration
+
+      sig { params(machine_detection_beep_min_tone_duration: Integer).void }
+      attr_writer :machine_detection_beep_min_tone_duration
+
       # 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
@@ -195,6 +222,43 @@ module Telnyx
       end
       attr_writer :machine_detection_beep_profile
 
+      # When enabled, a candidate beep must pass an additional spectral check before it
+      # is reported. Only used when MachineDetection is enabled.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :machine_detection_beep_spectral_confirmation
+
+      sig do
+        params(machine_detection_beep_spectral_confirmation: T::Boolean).void
+      end
+      attr_writer :machine_detection_beep_spectral_confirmation
+
+      # 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.
+      sig { returns(T.nilable(Float)) }
+      attr_reader :machine_detection_beep_spectral_min_purity
+
+      sig { params(machine_detection_beep_spectral_min_purity: Float).void }
+      attr_writer :machine_detection_beep_spectral_min_purity
+
+      # When enabled, the fax CNG tone is rejected rather than reported as a beep. Only
+      # used when MachineDetection is enabled.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :machine_detection_beep_spectral_reject_fax_cng
+
+      sig do
+        params(machine_detection_beep_spectral_reject_fax_cng: T::Boolean).void
+      end
+      attr_writer :machine_detection_beep_spectral_reject_fax_cng
+
+      # Length of the spectral confirmation window, in milliseconds. Only used when
+      # MachineDetection is enabled.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :machine_detection_beep_spectral_window
+
+      sig { params(machine_detection_beep_spectral_window: Integer).void }
+      attr_writer :machine_detection_beep_spectral_window
+
       # Silence duration threshold after a call screening prompt before ending prompt
       # detection, in milliseconds. Used when `DetectionMode` is `PremiumCallScreening`.
       sig { returns(T.nilable(Integer)) }
@@ -469,8 +533,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,
@@ -546,11 +617,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,
@@ -651,8 +747,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,