telnyx 5.0.0 → 5.2.0

data/rbi/telnyx/models/credential_connection_create_params.rbi

@@ -122,19 +122,13 @@ module Telnyx
       # regardless of the noise_suppression value, but only take effect when
       # noise_suppression is not 'disabled'. If you disable noise suppression and later
       # re-enable it, the previously configured settings will be used.
-      sig do
-        returns(
-          T.nilable(
-            Telnyx::CredentialConnectionCreateParams::NoiseSuppressionDetails
-          )
-        )
-      end
+      sig { returns(T.nilable(Telnyx::ConnectionNoiseSuppressionDetails)) }
       attr_reader :noise_suppression_details
 
       sig do
         params(
           noise_suppression_details:
-            Telnyx::CredentialConnectionCreateParams::NoiseSuppressionDetails::OrHash
+            Telnyx::ConnectionNoiseSuppressionDetails::OrHash
         ).void
       end
       attr_writer :noise_suppression_details
@@ -244,7 +238,7 @@ module Telnyx
           noise_suppression:
             Telnyx::CredentialConnectionCreateParams::NoiseSuppression::OrSymbol,
           noise_suppression_details:
-            Telnyx::CredentialConnectionCreateParams::NoiseSuppressionDetails::OrHash,
+            Telnyx::ConnectionNoiseSuppressionDetails::OrHash,
           onnet_t38_passthrough_enabled: T::Boolean,
           outbound: Telnyx::CredentialOutbound::OrHash,
           rtcp_settings: Telnyx::ConnectionRtcpSettings::OrHash,
@@ -353,7 +347,7 @@ module Telnyx
             noise_suppression:
               Telnyx::CredentialConnectionCreateParams::NoiseSuppression::OrSymbol,
             noise_suppression_details:
-              Telnyx::CredentialConnectionCreateParams::NoiseSuppressionDetails,
+              Telnyx::ConnectionNoiseSuppressionDetails,
             onnet_t38_passthrough_enabled: T::Boolean,
             outbound: Telnyx::CredentialOutbound,
             rtcp_settings: Telnyx::ConnectionRtcpSettings,
@@ -420,150 +414,6 @@ module Telnyx
         end
       end
 
-      class NoiseSuppressionDetails < Telnyx::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Telnyx::CredentialConnectionCreateParams::NoiseSuppressionDetails,
-              Telnyx::Internal::AnyHash
-            )
-          end
-
-        # The attenuation limit value for the selected engine. Default values vary by
-        # engine: 0 for 'denoiser', 80 for 'deep_filter_net', 'deep_filter_net_large', and
-        # all Krisp engines ('krisp_viva_tel', 'krisp_viva_tel_lite',
-        # 'krisp_viva_promodel', 'krisp_viva_ss').
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :attenuation_limit
-
-        sig { params(attenuation_limit: Integer).void }
-        attr_writer :attenuation_limit
-
-        # The noise suppression engine to use. 'denoiser' is the default engine.
-        # 'deep_filter_net' and 'deep_filter_net_large' are alternative engines with
-        # different performance characteristics. Krisp engines ('krisp_viva_tel',
-        # 'krisp_viva_tel_lite', 'krisp_viva_promodel', 'krisp_viva_ss') provide advanced
-        # noise suppression capabilities.
-        sig do
-          returns(
-            T.nilable(
-              Telnyx::CredentialConnectionCreateParams::NoiseSuppressionDetails::Engine::OrSymbol
-            )
-          )
-        end
-        attr_reader :engine
-
-        sig do
-          params(
-            engine:
-              Telnyx::CredentialConnectionCreateParams::NoiseSuppressionDetails::Engine::OrSymbol
-          ).void
-        end
-        attr_writer :engine
-
-        # Configuration options for noise suppression. These settings are stored
-        # regardless of the noise_suppression value, but only take effect when
-        # noise_suppression is not 'disabled'. If you disable noise suppression and later
-        # re-enable it, the previously configured settings will be used.
-        sig do
-          params(
-            attenuation_limit: Integer,
-            engine:
-              Telnyx::CredentialConnectionCreateParams::NoiseSuppressionDetails::Engine::OrSymbol
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The attenuation limit value for the selected engine. Default values vary by
-          # engine: 0 for 'denoiser', 80 for 'deep_filter_net', 'deep_filter_net_large', and
-          # all Krisp engines ('krisp_viva_tel', 'krisp_viva_tel_lite',
-          # 'krisp_viva_promodel', 'krisp_viva_ss').
-          attenuation_limit: nil,
-          # The noise suppression engine to use. 'denoiser' is the default engine.
-          # 'deep_filter_net' and 'deep_filter_net_large' are alternative engines with
-          # different performance characteristics. Krisp engines ('krisp_viva_tel',
-          # 'krisp_viva_tel_lite', 'krisp_viva_promodel', 'krisp_viva_ss') provide advanced
-          # noise suppression capabilities.
-          engine: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              attenuation_limit: Integer,
-              engine:
-                Telnyx::CredentialConnectionCreateParams::NoiseSuppressionDetails::Engine::OrSymbol
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # The noise suppression engine to use. 'denoiser' is the default engine.
-        # 'deep_filter_net' and 'deep_filter_net_large' are alternative engines with
-        # different performance characteristics. Krisp engines ('krisp_viva_tel',
-        # 'krisp_viva_tel_lite', 'krisp_viva_promodel', 'krisp_viva_ss') provide advanced
-        # noise suppression capabilities.
-        module Engine
-          extend Telnyx::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                Telnyx::CredentialConnectionCreateParams::NoiseSuppressionDetails::Engine
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          DENOISER =
-            T.let(
-              :denoiser,
-              Telnyx::CredentialConnectionCreateParams::NoiseSuppressionDetails::Engine::TaggedSymbol
-            )
-          DEEP_FILTER_NET =
-            T.let(
-              :deep_filter_net,
-              Telnyx::CredentialConnectionCreateParams::NoiseSuppressionDetails::Engine::TaggedSymbol
-            )
-          DEEP_FILTER_NET_LARGE =
-            T.let(
-              :deep_filter_net_large,
-              Telnyx::CredentialConnectionCreateParams::NoiseSuppressionDetails::Engine::TaggedSymbol
-            )
-          KRISP_VIVA_TEL =
-            T.let(
-              :krisp_viva_tel,
-              Telnyx::CredentialConnectionCreateParams::NoiseSuppressionDetails::Engine::TaggedSymbol
-            )
-          KRISP_VIVA_TEL_LITE =
-            T.let(
-              :krisp_viva_tel_lite,
-              Telnyx::CredentialConnectionCreateParams::NoiseSuppressionDetails::Engine::TaggedSymbol
-            )
-          KRISP_VIVA_PROMODEL =
-            T.let(
-              :krisp_viva_promodel,
-              Telnyx::CredentialConnectionCreateParams::NoiseSuppressionDetails::Engine::TaggedSymbol
-            )
-          KRISP_VIVA_SS =
-            T.let(
-              :krisp_viva_ss,
-              Telnyx::CredentialConnectionCreateParams::NoiseSuppressionDetails::Engine::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                Telnyx::CredentialConnectionCreateParams::NoiseSuppressionDetails::Engine::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-
       # This feature enables inbound SIP URI calls to your Credential Auth Connection.
       # If enabled for all (unrestricted) then anyone who calls the SIP URI
       # <your-username>@telnyx.com will be connected to your Connection. You can also

data/rbi/telnyx/models/credential_connection_update_params.rbi

@@ -115,19 +115,13 @@ module Telnyx
       # regardless of the noise_suppression value, but only take effect when
       # noise_suppression is not 'disabled'. If you disable noise suppression and later
       # re-enable it, the previously configured settings will be used.
-      sig do
-        returns(
-          T.nilable(
-            Telnyx::CredentialConnectionUpdateParams::NoiseSuppressionDetails
-          )
-        )
-      end
+      sig { returns(T.nilable(Telnyx::ConnectionNoiseSuppressionDetails)) }
       attr_reader :noise_suppression_details
 
       sig do
         params(
           noise_suppression_details:
-            Telnyx::CredentialConnectionUpdateParams::NoiseSuppressionDetails::OrHash
+            Telnyx::ConnectionNoiseSuppressionDetails::OrHash
         ).void
       end
       attr_writer :noise_suppression_details
@@ -249,7 +243,7 @@ module Telnyx
           noise_suppression:
             Telnyx::CredentialConnectionUpdateParams::NoiseSuppression::OrSymbol,
           noise_suppression_details:
-            Telnyx::CredentialConnectionUpdateParams::NoiseSuppressionDetails::OrHash,
+            Telnyx::ConnectionNoiseSuppressionDetails::OrHash,
           onnet_t38_passthrough_enabled: T::Boolean,
           outbound: Telnyx::CredentialOutbound::OrHash,
           password: String,
@@ -356,7 +350,7 @@ module Telnyx
             noise_suppression:
               Telnyx::CredentialConnectionUpdateParams::NoiseSuppression::OrSymbol,
             noise_suppression_details:
-              Telnyx::CredentialConnectionUpdateParams::NoiseSuppressionDetails,
+              Telnyx::ConnectionNoiseSuppressionDetails,
             onnet_t38_passthrough_enabled: T::Boolean,
             outbound: Telnyx::CredentialOutbound,
             password: String,
@@ -425,150 +419,6 @@ module Telnyx
         end
       end
 
-      class NoiseSuppressionDetails < Telnyx::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Telnyx::CredentialConnectionUpdateParams::NoiseSuppressionDetails,
-              Telnyx::Internal::AnyHash
-            )
-          end
-
-        # The attenuation limit value for the selected engine. Default values vary by
-        # engine: 0 for 'denoiser', 80 for 'deep_filter_net', 'deep_filter_net_large', and
-        # all Krisp engines ('krisp_viva_tel', 'krisp_viva_tel_lite',
-        # 'krisp_viva_promodel', 'krisp_viva_ss').
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :attenuation_limit
-
-        sig { params(attenuation_limit: Integer).void }
-        attr_writer :attenuation_limit
-
-        # The noise suppression engine to use. 'denoiser' is the default engine.
-        # 'deep_filter_net' and 'deep_filter_net_large' are alternative engines with
-        # different performance characteristics. Krisp engines ('krisp_viva_tel',
-        # 'krisp_viva_tel_lite', 'krisp_viva_promodel', 'krisp_viva_ss') provide advanced
-        # noise suppression capabilities.
-        sig do
-          returns(
-            T.nilable(
-              Telnyx::CredentialConnectionUpdateParams::NoiseSuppressionDetails::Engine::OrSymbol
-            )
-          )
-        end
-        attr_reader :engine
-
-        sig do
-          params(
-            engine:
-              Telnyx::CredentialConnectionUpdateParams::NoiseSuppressionDetails::Engine::OrSymbol
-          ).void
-        end
-        attr_writer :engine
-
-        # Configuration options for noise suppression. These settings are stored
-        # regardless of the noise_suppression value, but only take effect when
-        # noise_suppression is not 'disabled'. If you disable noise suppression and later
-        # re-enable it, the previously configured settings will be used.
-        sig do
-          params(
-            attenuation_limit: Integer,
-            engine:
-              Telnyx::CredentialConnectionUpdateParams::NoiseSuppressionDetails::Engine::OrSymbol
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The attenuation limit value for the selected engine. Default values vary by
-          # engine: 0 for 'denoiser', 80 for 'deep_filter_net', 'deep_filter_net_large', and
-          # all Krisp engines ('krisp_viva_tel', 'krisp_viva_tel_lite',
-          # 'krisp_viva_promodel', 'krisp_viva_ss').
-          attenuation_limit: nil,
-          # The noise suppression engine to use. 'denoiser' is the default engine.
-          # 'deep_filter_net' and 'deep_filter_net_large' are alternative engines with
-          # different performance characteristics. Krisp engines ('krisp_viva_tel',
-          # 'krisp_viva_tel_lite', 'krisp_viva_promodel', 'krisp_viva_ss') provide advanced
-          # noise suppression capabilities.
-          engine: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              attenuation_limit: Integer,
-              engine:
-                Telnyx::CredentialConnectionUpdateParams::NoiseSuppressionDetails::Engine::OrSymbol
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # The noise suppression engine to use. 'denoiser' is the default engine.
-        # 'deep_filter_net' and 'deep_filter_net_large' are alternative engines with
-        # different performance characteristics. Krisp engines ('krisp_viva_tel',
-        # 'krisp_viva_tel_lite', 'krisp_viva_promodel', 'krisp_viva_ss') provide advanced
-        # noise suppression capabilities.
-        module Engine
-          extend Telnyx::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                Telnyx::CredentialConnectionUpdateParams::NoiseSuppressionDetails::Engine
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          DENOISER =
-            T.let(
-              :denoiser,
-              Telnyx::CredentialConnectionUpdateParams::NoiseSuppressionDetails::Engine::TaggedSymbol
-            )
-          DEEP_FILTER_NET =
-            T.let(
-              :deep_filter_net,
-              Telnyx::CredentialConnectionUpdateParams::NoiseSuppressionDetails::Engine::TaggedSymbol
-            )
-          DEEP_FILTER_NET_LARGE =
-            T.let(
-              :deep_filter_net_large,
-              Telnyx::CredentialConnectionUpdateParams::NoiseSuppressionDetails::Engine::TaggedSymbol
-            )
-          KRISP_VIVA_TEL =
-            T.let(
-              :krisp_viva_tel,
-              Telnyx::CredentialConnectionUpdateParams::NoiseSuppressionDetails::Engine::TaggedSymbol
-            )
-          KRISP_VIVA_TEL_LITE =
-            T.let(
-              :krisp_viva_tel_lite,
-              Telnyx::CredentialConnectionUpdateParams::NoiseSuppressionDetails::Engine::TaggedSymbol
-            )
-          KRISP_VIVA_PROMODEL =
-            T.let(
-              :krisp_viva_promodel,
-              Telnyx::CredentialConnectionUpdateParams::NoiseSuppressionDetails::Engine::TaggedSymbol
-            )
-          KRISP_VIVA_SS =
-            T.let(
-              :krisp_viva_ss,
-              Telnyx::CredentialConnectionUpdateParams::NoiseSuppressionDetails::Engine::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                Telnyx::CredentialConnectionUpdateParams::NoiseSuppressionDetails::Engine::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-
       # This feature enables inbound SIP URI calls to your Credential Auth Connection.
       # If enabled for all (unrestricted) then anyone who calls the SIP URI
       # <your-username>@telnyx.com will be connected to your Connection. You can also

data/rbi/telnyx/models/fax_create_params.rbi

@@ -23,6 +23,14 @@ module Telnyx
       sig { returns(String) }
       attr_accessor :to
 
+      # The black threshold percentage for monochrome faxes. Only applicable if
+      # `monochrome` is set to `true`.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :black_threshold
+
+      sig { params(black_threshold: Integer).void }
+      attr_writer :black_threshold
+
       # Use this field to add state to every subsequent webhook. It must be a valid
       # Base-64 encoded string.
       sig { returns(T.nilable(String)) }
@@ -123,6 +131,7 @@ module Telnyx
           connection_id: String,
           from: String,
           to: String,
+          black_threshold: Integer,
           client_state: String,
           from_display_name: String,
           media_name: String,
@@ -144,6 +153,9 @@ module Telnyx
         from:,
         # The phone number, in E.164 format, the fax will be sent to or SIP URI
         to:,
+        # The black threshold percentage for monochrome faxes. Only applicable if
+        # `monochrome` is set to `true`.
+        black_threshold: nil,
         # Use this field to add state to every subsequent webhook. It must be a valid
         # Base-64 encoded string.
         client_state: nil,
@@ -188,6 +200,7 @@ module Telnyx
             connection_id: String,
             from: String,
             to: String,
+            black_threshold: Integer,
             client_state: String,
             from_display_name: String,
             media_name: String,

data/rbi/telnyx/models/fqdn_connection.rbi

@@ -144,15 +144,13 @@ module Telnyx
       # regardless of the noise_suppression value, but only take effect when
       # noise_suppression is not 'disabled'. If you disable noise suppression and later
       # re-enable it, the previously configured settings will be used.
-      sig do
-        returns(T.nilable(Telnyx::FqdnConnection::NoiseSuppressionDetails))
-      end
+      sig { returns(T.nilable(Telnyx::ConnectionNoiseSuppressionDetails)) }
       attr_reader :noise_suppression_details
 
       sig do
         params(
           noise_suppression_details:
-            Telnyx::FqdnConnection::NoiseSuppressionDetails::OrHash
+            Telnyx::ConnectionNoiseSuppressionDetails::OrHash
         ).void
       end
       attr_writer :noise_suppression_details
@@ -311,7 +309,7 @@ module Telnyx
           microsoft_teams_sbc: T::Boolean,
           noise_suppression: Telnyx::FqdnConnection::NoiseSuppression::OrSymbol,
           noise_suppression_details:
-            Telnyx::FqdnConnection::NoiseSuppressionDetails::OrHash,
+            Telnyx::ConnectionNoiseSuppressionDetails::OrHash,
           onnet_t38_passthrough_enabled: T::Boolean,
           outbound: Telnyx::OutboundFqdn::OrHash,
           password: String,
@@ -448,7 +446,7 @@ module Telnyx
             noise_suppression:
               Telnyx::FqdnConnection::NoiseSuppression::TaggedSymbol,
             noise_suppression_details:
-              Telnyx::FqdnConnection::NoiseSuppressionDetails,
+              Telnyx::ConnectionNoiseSuppressionDetails,
             onnet_t38_passthrough_enabled: T::Boolean,
             outbound: Telnyx::OutboundFqdn,
             password: String,
@@ -513,150 +511,6 @@ module Telnyx
         def self.values
         end
       end
-
-      class NoiseSuppressionDetails < Telnyx::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Telnyx::FqdnConnection::NoiseSuppressionDetails,
-              Telnyx::Internal::AnyHash
-            )
-          end
-
-        # The attenuation limit value for the selected engine. Default values vary by
-        # engine: 0 for 'denoiser', 80 for 'deep_filter_net', 'deep_filter_net_large', and
-        # all Krisp engines ('krisp_viva_tel', 'krisp_viva_tel_lite',
-        # 'krisp_viva_promodel', 'krisp_viva_ss').
-        sig { returns(T.nilable(Integer)) }
-        attr_reader :attenuation_limit
-
-        sig { params(attenuation_limit: Integer).void }
-        attr_writer :attenuation_limit
-
-        # The noise suppression engine to use. 'denoiser' is the default engine.
-        # 'deep_filter_net' and 'deep_filter_net_large' are alternative engines with
-        # different performance characteristics. Krisp engines ('krisp_viva_tel',
-        # 'krisp_viva_tel_lite', 'krisp_viva_promodel', 'krisp_viva_ss') provide advanced
-        # noise suppression capabilities.
-        sig do
-          returns(
-            T.nilable(
-              Telnyx::FqdnConnection::NoiseSuppressionDetails::Engine::TaggedSymbol
-            )
-          )
-        end
-        attr_reader :engine
-
-        sig do
-          params(
-            engine:
-              Telnyx::FqdnConnection::NoiseSuppressionDetails::Engine::OrSymbol
-          ).void
-        end
-        attr_writer :engine
-
-        # Configuration options for noise suppression. These settings are stored
-        # regardless of the noise_suppression value, but only take effect when
-        # noise_suppression is not 'disabled'. If you disable noise suppression and later
-        # re-enable it, the previously configured settings will be used.
-        sig do
-          params(
-            attenuation_limit: Integer,
-            engine:
-              Telnyx::FqdnConnection::NoiseSuppressionDetails::Engine::OrSymbol
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The attenuation limit value for the selected engine. Default values vary by
-          # engine: 0 for 'denoiser', 80 for 'deep_filter_net', 'deep_filter_net_large', and
-          # all Krisp engines ('krisp_viva_tel', 'krisp_viva_tel_lite',
-          # 'krisp_viva_promodel', 'krisp_viva_ss').
-          attenuation_limit: nil,
-          # The noise suppression engine to use. 'denoiser' is the default engine.
-          # 'deep_filter_net' and 'deep_filter_net_large' are alternative engines with
-          # different performance characteristics. Krisp engines ('krisp_viva_tel',
-          # 'krisp_viva_tel_lite', 'krisp_viva_promodel', 'krisp_viva_ss') provide advanced
-          # noise suppression capabilities.
-          engine: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              attenuation_limit: Integer,
-              engine:
-                Telnyx::FqdnConnection::NoiseSuppressionDetails::Engine::TaggedSymbol
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # The noise suppression engine to use. 'denoiser' is the default engine.
-        # 'deep_filter_net' and 'deep_filter_net_large' are alternative engines with
-        # different performance characteristics. Krisp engines ('krisp_viva_tel',
-        # 'krisp_viva_tel_lite', 'krisp_viva_promodel', 'krisp_viva_ss') provide advanced
-        # noise suppression capabilities.
-        module Engine
-          extend Telnyx::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                Telnyx::FqdnConnection::NoiseSuppressionDetails::Engine
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          DENOISER =
-            T.let(
-              :denoiser,
-              Telnyx::FqdnConnection::NoiseSuppressionDetails::Engine::TaggedSymbol
-            )
-          DEEP_FILTER_NET =
-            T.let(
-              :deep_filter_net,
-              Telnyx::FqdnConnection::NoiseSuppressionDetails::Engine::TaggedSymbol
-            )
-          DEEP_FILTER_NET_LARGE =
-            T.let(
-              :deep_filter_net_large,
-              Telnyx::FqdnConnection::NoiseSuppressionDetails::Engine::TaggedSymbol
-            )
-          KRISP_VIVA_TEL =
-            T.let(
-              :krisp_viva_tel,
-              Telnyx::FqdnConnection::NoiseSuppressionDetails::Engine::TaggedSymbol
-            )
-          KRISP_VIVA_TEL_LITE =
-            T.let(
-              :krisp_viva_tel_lite,
-              Telnyx::FqdnConnection::NoiseSuppressionDetails::Engine::TaggedSymbol
-            )
-          KRISP_VIVA_PROMODEL =
-            T.let(
-              :krisp_viva_promodel,
-              Telnyx::FqdnConnection::NoiseSuppressionDetails::Engine::TaggedSymbol
-            )
-          KRISP_VIVA_SS =
-            T.let(
-              :krisp_viva_ss,
-              Telnyx::FqdnConnection::NoiseSuppressionDetails::Engine::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                Telnyx::FqdnConnection::NoiseSuppressionDetails::Engine::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
     end
   end
 end