telnyx 5.171.0 → 5.174.0

data/rbi/telnyx/models/fqdn_connection_create_params.rbi

@@ -37,6 +37,19 @@ module Telnyx
       sig { returns(T.nilable(String)) }
       attr_accessor :android_push_credential_id
 
+      # Stores the connection preference for generating silent RTP toward the opposite
+      # call leg when comfort-noise packets (CN, payload type 13) are received during
+      # hold. Optional; defaults to false when omitted on creation. Only JSON true and
+      # false are accepted; null and non-boolean values are rejected. This preference is
+      # independent of default_on_hold_comfort_noise_enabled and does not modify that
+      # setting. This API provisions the preference; call-processing behavior is
+      # implemented separately.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :bridge_generate_comfort_noise_on_cn
+
+      sig { params(bridge_generate_comfort_noise_on_cn: T::Boolean).void }
+      attr_writer :bridge_generate_comfort_noise_on_cn
+
       # Specifies if call cost webhooks should be sent for this connection.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :call_cost_in_webhooks
@@ -69,8 +82,8 @@ module Telnyx
       sig { params(encode_contact_header_enabled: T::Boolean).void }
       attr_writer :encode_contact_header_enabled
 
-      # Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
-      # TLS.
+      # Enable use of SRTP for encryption. Can only be set when the SIP signaling
+      # transport protocol is TLS.
       sig { returns(T.nilable(Telnyx::EncryptedMedia::OrSymbol)) }
       attr_accessor :encrypted_media
 
@@ -202,6 +215,7 @@ module Telnyx
           active: T::Boolean,
           anchorsite_override: Telnyx::AnchorsiteOverride::OrSymbol,
           android_push_credential_id: T.nilable(String),
+          bridge_generate_comfort_noise_on_cn: T::Boolean,
           call_cost_in_webhooks: T::Boolean,
           default_on_hold_comfort_noise_enabled: T::Boolean,
           dtmf_type: Telnyx::DtmfType::OrSymbol,
@@ -237,6 +251,14 @@ module Telnyx
         anchorsite_override: nil,
         # The uuid of the push credential for Android
         android_push_credential_id: nil,
+        # Stores the connection preference for generating silent RTP toward the opposite
+        # call leg when comfort-noise packets (CN, payload type 13) are received during
+        # hold. Optional; defaults to false when omitted on creation. Only JSON true and
+        # false are accepted; null and non-boolean values are rejected. This preference is
+        # independent of default_on_hold_comfort_noise_enabled and does not modify that
+        # setting. This API provisions the preference; call-processing behavior is
+        # implemented separately.
+        bridge_generate_comfort_noise_on_cn: nil,
         # Specifies if call cost webhooks should be sent for this connection.
         call_cost_in_webhooks: nil,
         # When enabled, Telnyx will generate comfort noise when you place the call on
@@ -249,8 +271,8 @@ module Telnyx
         # Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG
         # scenarios.
         encode_contact_header_enabled: nil,
-        # Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
-        # TLS.
+        # Enable use of SRTP for encryption. Can only be set when the SIP signaling
+        # transport protocol is TLS.
         encrypted_media: nil,
         inbound: nil,
         # The uuid of the push credential for Ios
@@ -306,6 +328,7 @@ module Telnyx
             active: T::Boolean,
             anchorsite_override: Telnyx::AnchorsiteOverride::OrSymbol,
             android_push_credential_id: T.nilable(String),
+            bridge_generate_comfort_noise_on_cn: T::Boolean,
             call_cost_in_webhooks: T::Boolean,
             default_on_hold_comfort_noise_enabled: T::Boolean,
             dtmf_type: Telnyx::DtmfType::OrSymbol,

data/rbi/telnyx/models/fqdn_connection_update_params.rbi

@@ -36,6 +36,19 @@ module Telnyx
       sig { returns(T.nilable(String)) }
       attr_accessor :android_push_credential_id
 
+      # Stores the connection preference for generating silent RTP toward the opposite
+      # call leg when comfort-noise packets (CN, payload type 13) are received during
+      # hold. Optional; omitting this field preserves the saved value. Only JSON true
+      # and false are accepted; null and non-boolean values are rejected. This
+      # preference is independent of default_on_hold_comfort_noise_enabled and does not
+      # modify that setting. This API provisions the preference; call-processing
+      # behavior is implemented separately.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :bridge_generate_comfort_noise_on_cn
+
+      sig { params(bridge_generate_comfort_noise_on_cn: T::Boolean).void }
+      attr_writer :bridge_generate_comfort_noise_on_cn
+
       # Specifies if call cost webhooks should be sent for this connection.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :call_cost_in_webhooks
@@ -84,8 +97,8 @@ module Telnyx
       sig { params(encode_contact_header_enabled: T::Boolean).void }
       attr_writer :encode_contact_header_enabled
 
-      # Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
-      # TLS.
+      # Enable use of SRTP for encryption. Can only be set when the SIP signaling
+      # transport protocol is TLS.
       sig { returns(T.nilable(Telnyx::EncryptedMedia::OrSymbol)) }
       attr_accessor :encrypted_media
 
@@ -209,6 +222,7 @@ module Telnyx
           active: T::Boolean,
           anchorsite_override: Telnyx::AnchorsiteOverride::OrSymbol,
           android_push_credential_id: T.nilable(String),
+          bridge_generate_comfort_noise_on_cn: T::Boolean,
           call_cost_in_webhooks: T::Boolean,
           connection_name: String,
           conversation_persistence: T::Boolean,
@@ -244,6 +258,14 @@ module Telnyx
         anchorsite_override: nil,
         # The uuid of the push credential for Android
         android_push_credential_id: nil,
+        # Stores the connection preference for generating silent RTP toward the opposite
+        # call leg when comfort-noise packets (CN, payload type 13) are received during
+        # hold. Optional; omitting this field preserves the saved value. Only JSON true
+        # and false are accepted; null and non-boolean values are rejected. This
+        # preference is independent of default_on_hold_comfort_noise_enabled and does not
+        # modify that setting. This API provisions the preference; call-processing
+        # behavior is implemented separately.
+        bridge_generate_comfort_noise_on_cn: nil,
         # Specifies if call cost webhooks should be sent for this connection.
         call_cost_in_webhooks: nil,
         # A user-assigned name to help manage the connection.
@@ -262,8 +284,8 @@ module Telnyx
         # Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG
         # scenarios.
         encode_contact_header_enabled: nil,
-        # Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
-        # TLS.
+        # Enable use of SRTP for encryption. Can only be set when the SIP signaling
+        # transport protocol is TLS.
         encrypted_media: nil,
         inbound: nil,
         # The uuid of the push credential for Ios
@@ -316,6 +338,7 @@ module Telnyx
             active: T::Boolean,
             anchorsite_override: Telnyx::AnchorsiteOverride::OrSymbol,
             android_push_credential_id: T.nilable(String),
+            bridge_generate_comfort_noise_on_cn: T::Boolean,
             call_cost_in_webhooks: T::Boolean,
             connection_name: String,
             conversation_persistence: T::Boolean,

data/rbi/telnyx/models/generic_pay_connector_config.rbi

@@ -0,0 +1,342 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    # Configuration for a generic connector. A config update replaces the complete
+    # object, not individual keys. Unknown config keys are discarded. Authentication
+    # credentials must be nonblank strings when required by the selected auth_type.
+    module GenericPayConnectorConfig
+      extend Telnyx::Internal::Type::Union
+
+      Variants =
+        T.type_alias do
+          T.any(
+            Telnyx::GenericPayConnectorConfig::BasicAuthenticationAlsoTheValidationDefault,
+            Telnyx::GenericPayConnectorConfig::BearerAuthentication,
+            Telnyx::GenericPayConnectorConfig::NoProcessorAuthentication
+          )
+        end
+
+      class BasicAuthenticationAlsoTheValidationDefault < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::GenericPayConnectorConfig::BasicAuthenticationAlsoTheValidationDefault,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Basic password.
+        sig { returns(String) }
+        attr_accessor :password
+
+        # Basic username.
+        sig { returns(String) }
+        attr_accessor :username
+
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::GenericPayConnectorConfig::BasicAuthenticationAlsoTheValidationDefault::AuthType::OrSymbol
+            )
+          )
+        end
+        attr_reader :auth_type
+
+        sig do
+          params(
+            auth_type:
+              Telnyx::GenericPayConnectorConfig::BasicAuthenticationAlsoTheValidationDefault::AuthType::OrSymbol
+          ).void
+        end
+        attr_writer :auth_type
+
+        # HTTP or HTTPS processor URL with a host. Use HTTPS to protect payment data in
+        # transit.
+        sig { returns(T.nilable(String)) }
+        attr_reader :endpoint_url
+
+        sig { params(endpoint_url: String).void }
+        attr_writer :endpoint_url
+
+        # Processor HTTP timeout in milliseconds. Omitted or null uses 10000; null is
+        # removed before storage. Not the IVR digit-gather timeout.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :timeout
+
+        # Nonblank string required for bearer authentication. Write-only; omitted from
+        # responses. Re-send when replacing a bearer-auth config.
+        sig { returns(T.nilable(T.anything)) }
+        attr_reader :token
+
+        sig { params(token: T.anything).void }
+        attr_writer :token
+
+        sig do
+          params(
+            password: String,
+            username: String,
+            token: T.anything,
+            auth_type:
+              Telnyx::GenericPayConnectorConfig::BasicAuthenticationAlsoTheValidationDefault::AuthType::OrSymbol,
+            endpoint_url: String,
+            timeout: T.nilable(Integer)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Basic password.
+          password:,
+          # Basic username.
+          username:,
+          # Nonblank string required for bearer authentication. Write-only; omitted from
+          # responses. Re-send when replacing a bearer-auth config.
+          token: nil,
+          auth_type: nil,
+          # HTTP or HTTPS processor URL with a host. Use HTTPS to protect payment data in
+          # transit.
+          endpoint_url: nil,
+          # Processor HTTP timeout in milliseconds. Omitted or null uses 10000; null is
+          # removed before storage. Not the IVR digit-gather timeout.
+          timeout: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              password: String,
+              username: String,
+              token: T.anything,
+              auth_type:
+                Telnyx::GenericPayConnectorConfig::BasicAuthenticationAlsoTheValidationDefault::AuthType::OrSymbol,
+              endpoint_url: String,
+              timeout: T.nilable(Integer)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module AuthType
+          extend Telnyx::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Telnyx::GenericPayConnectorConfig::BasicAuthenticationAlsoTheValidationDefault::AuthType
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          BASIC =
+            T.let(
+              :basic,
+              Telnyx::GenericPayConnectorConfig::BasicAuthenticationAlsoTheValidationDefault::AuthType::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::GenericPayConnectorConfig::BasicAuthenticationAlsoTheValidationDefault::AuthType::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      class BearerAuthentication < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::GenericPayConnectorConfig::BearerAuthentication,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Processor bearer token.
+        sig { returns(String) }
+        attr_accessor :token
+
+        sig { returns(Symbol) }
+        attr_accessor :auth_type
+
+        # HTTP or HTTPS processor URL with a host. Use HTTPS to protect payment data in
+        # transit.
+        sig { returns(T.nilable(String)) }
+        attr_reader :endpoint_url
+
+        sig { params(endpoint_url: String).void }
+        attr_writer :endpoint_url
+
+        # Processor HTTP timeout in milliseconds. Omitted or null uses 10000; null is
+        # removed before storage. Not the IVR digit-gather timeout.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :timeout
+
+        # Nonblank string required for basic authentication. Returned in connector
+        # responses.
+        sig { returns(T.nilable(T.anything)) }
+        attr_reader :username
+
+        sig { params(username: T.anything).void }
+        attr_writer :username
+
+        # Nonblank string required for basic authentication. Write-only; omitted from
+        # responses. Re-send when replacing a basic-auth config.
+        sig { returns(T.nilable(T.anything)) }
+        attr_reader :password
+
+        sig { params(password: T.anything).void }
+        attr_writer :password
+
+        sig do
+          params(
+            token: String,
+            endpoint_url: String,
+            password: T.anything,
+            timeout: T.nilable(Integer),
+            username: T.anything,
+            auth_type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Processor bearer token.
+          token:,
+          # HTTP or HTTPS processor URL with a host. Use HTTPS to protect payment data in
+          # transit.
+          endpoint_url: nil,
+          # Nonblank string required for basic authentication. Write-only; omitted from
+          # responses. Re-send when replacing a basic-auth config.
+          password: nil,
+          # Processor HTTP timeout in milliseconds. Omitted or null uses 10000; null is
+          # removed before storage. Not the IVR digit-gather timeout.
+          timeout: nil,
+          # Nonblank string required for basic authentication. Returned in connector
+          # responses.
+          username: nil,
+          auth_type: :bearer
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              token: String,
+              auth_type: Symbol,
+              endpoint_url: String,
+              password: T.anything,
+              timeout: T.nilable(Integer),
+              username: T.anything
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class NoProcessorAuthentication < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::GenericPayConnectorConfig::NoProcessorAuthentication,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Symbol) }
+        attr_accessor :auth_type
+
+        # HTTP or HTTPS processor URL with a host. Use HTTPS to protect payment data in
+        # transit.
+        sig { returns(T.nilable(String)) }
+        attr_reader :endpoint_url
+
+        sig { params(endpoint_url: String).void }
+        attr_writer :endpoint_url
+
+        # Processor HTTP timeout in milliseconds. Omitted or null uses 10000; null is
+        # removed before storage. Not the IVR digit-gather timeout.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :timeout
+
+        # Nonblank string required for basic authentication. Returned in connector
+        # responses.
+        sig { returns(T.nilable(T.anything)) }
+        attr_reader :username
+
+        sig { params(username: T.anything).void }
+        attr_writer :username
+
+        # Nonblank string required for bearer authentication. Write-only; omitted from
+        # responses. Re-send when replacing a bearer-auth config.
+        sig { returns(T.nilable(T.anything)) }
+        attr_reader :token
+
+        sig { params(token: T.anything).void }
+        attr_writer :token
+
+        # Nonblank string required for basic authentication. Write-only; omitted from
+        # responses. Re-send when replacing a basic-auth config.
+        sig { returns(T.nilable(T.anything)) }
+        attr_reader :password
+
+        sig { params(password: T.anything).void }
+        attr_writer :password
+
+        sig do
+          params(
+            token: T.anything,
+            endpoint_url: String,
+            password: T.anything,
+            timeout: T.nilable(Integer),
+            username: T.anything,
+            auth_type: Symbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Nonblank string required for bearer authentication. Write-only; omitted from
+          # responses. Re-send when replacing a bearer-auth config.
+          token: nil,
+          # HTTP or HTTPS processor URL with a host. Use HTTPS to protect payment data in
+          # transit.
+          endpoint_url: nil,
+          # Nonblank string required for basic authentication. Write-only; omitted from
+          # responses. Re-send when replacing a basic-auth config.
+          password: nil,
+          # Processor HTTP timeout in milliseconds. Omitted or null uses 10000; null is
+          # removed before storage. Not the IVR digit-gather timeout.
+          timeout: nil,
+          # Nonblank string required for basic authentication. Returned in connector
+          # responses.
+          username: nil,
+          auth_type: :none
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              auth_type: Symbol,
+              token: T.anything,
+              endpoint_url: String,
+              password: T.anything,
+              timeout: T.nilable(Integer),
+              username: T.anything
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      sig do
+        override.returns(T::Array[Telnyx::GenericPayConnectorConfig::Variants])
+      end
+      def self.variants
+      end
+    end
+  end
+end

data/rbi/telnyx/models/inbound_fqdn.rbi

@@ -119,8 +119,8 @@ module Telnyx
       # in the same way a phone number is used, from a SIP endpoint. Example: the
       # subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
       # the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
-      # alphanumeric value. Please note TLS encrypted calls are not allowed for
-      # subdomain calls.
+      # alphanumeric value. TLS signaling is supported. SRTP media encryption requires
+      # TLS transport.
       sig { returns(T.nilable(String)) }
       attr_accessor :sip_subdomain
 
@@ -227,8 +227,8 @@ module Telnyx
         # in the same way a phone number is used, from a SIP endpoint. Example: the
         # subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
         # the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
-        # alphanumeric value. Please note TLS encrypted calls are not allowed for
-        # subdomain calls.
+        # alphanumeric value. TLS signaling is supported. SRTP media encryption requires
+        # TLS transport.
         sip_subdomain: nil,
         # This option can be enabled to receive calls from: "Anyone" (any SIP endpoint in
         # the public Internet) or "Only my connections" (any connection assigned to the

data/rbi/telnyx/models/inbound_ip.rbi

@@ -139,8 +139,8 @@ module Telnyx
       # in the same way a phone number is used, from a SIP endpoint. Example: the
       # subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
       # the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
-      # alphanumeric value. Please note TLS encrypted calls are not allowed for
-      # subdomain calls.
+      # alphanumeric value. TLS signaling is supported. SRTP media encryption requires
+      # TLS transport.
       sig { returns(T.nilable(String)) }
       attr_reader :sip_subdomain
 
@@ -252,8 +252,8 @@ module Telnyx
         # in the same way a phone number is used, from a SIP endpoint. Example: the
         # subdomain "example.sip.telnyx.com" can be called from any SIP endpoint by using
         # the SIP URI "sip:@example.sip.telnyx.com" where the user part can be any
-        # alphanumeric value. Please note TLS encrypted calls are not allowed for
-        # subdomain calls.
+        # alphanumeric value. TLS signaling is supported. SRTP media encryption requires
+        # TLS transport.
         sip_subdomain: nil,
         # This option can be enabled to receive calls from: "Anyone" (any SIP endpoint in
         # the public Internet) or "Only my connections" (any connection assigned to the

data/rbi/telnyx/models/ip_connection.rbi

@@ -35,6 +35,19 @@ module Telnyx
       sig { returns(T.nilable(String)) }
       attr_accessor :android_push_credential_id
 
+      # Stores the connection preference for generating silent RTP toward the opposite
+      # call leg when comfort-noise packets (CN, payload type 13) are received during
+      # hold. Defaults to false and returns the saved value. Only JSON true and false
+      # are accepted; null and non-boolean values are rejected. This preference is
+      # independent of default_on_hold_comfort_noise_enabled and does not modify that
+      # setting. This API provisions the preference; call-processing behavior is
+      # implemented separately.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :bridge_generate_comfort_noise_on_cn
+
+      sig { params(bridge_generate_comfort_noise_on_cn: T::Boolean).void }
+      attr_writer :bridge_generate_comfort_noise_on_cn
+
       # Specifies if call cost webhooks should be sent for this connection.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :call_cost_in_webhooks
@@ -89,8 +102,8 @@ module Telnyx
       sig { params(encode_contact_header_enabled: T::Boolean).void }
       attr_writer :encode_contact_header_enabled
 
-      # Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
-      # TLS.
+      # Enable use of SRTP for encryption. Can only be set when the SIP signaling
+      # transport protocol is TLS.
       sig { returns(T.nilable(Telnyx::EncryptedMedia::TaggedSymbol)) }
       attr_accessor :encrypted_media
 
@@ -242,6 +255,7 @@ module Telnyx
           active: T::Boolean,
           anchorsite_override: Telnyx::AnchorsiteOverride::OrSymbol,
           android_push_credential_id: T.nilable(String),
+          bridge_generate_comfort_noise_on_cn: T::Boolean,
           call_cost_in_webhooks: T::Boolean,
           connection_name: String,
           conversation_persistence: T::Boolean,
@@ -281,6 +295,14 @@ module Telnyx
         anchorsite_override: nil,
         # The uuid of the push credential for Android
         android_push_credential_id: nil,
+        # Stores the connection preference for generating silent RTP toward the opposite
+        # call leg when comfort-noise packets (CN, payload type 13) are received during
+        # hold. Defaults to false and returns the saved value. Only JSON true and false
+        # are accepted; null and non-boolean values are rejected. This preference is
+        # independent of default_on_hold_comfort_noise_enabled and does not modify that
+        # setting. This API provisions the preference; call-processing behavior is
+        # implemented separately.
+        bridge_generate_comfort_noise_on_cn: nil,
         # Specifies if call cost webhooks should be sent for this connection.
         call_cost_in_webhooks: nil,
         connection_name: nil,
@@ -300,8 +322,8 @@ module Telnyx
         # Encode the SIP contact header sent by Telnyx to avoid issues for NAT or ALG
         # scenarios.
         encode_contact_header_enabled: nil,
-        # Enable use of SRTP for encryption. Cannot be set if the transport_portocol is
-        # TLS.
+        # Enable use of SRTP for encryption. Can only be set when the SIP signaling
+        # transport protocol is TLS.
         encrypted_media: nil,
         inbound: nil,
         # The uuid of the push credential for Ios
@@ -357,6 +379,7 @@ module Telnyx
             active: T::Boolean,
             anchorsite_override: Telnyx::AnchorsiteOverride::TaggedSymbol,
             android_push_credential_id: T.nilable(String),
+            bridge_generate_comfort_noise_on_cn: T::Boolean,
             call_cost_in_webhooks: T::Boolean,
             connection_name: String,
             conversation_persistence: T::Boolean,