telnyx 5.171.0 → 5.174.0

data/rbi/telnyx/models/email/ip_pool_update_params.rbi

@@ -0,0 +1,79 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Email
+      class IPPoolUpdateParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Email::IPPoolUpdateParams, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Scope the pool to one of the account's email domains, or `null` to remove the
+        # scope.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :domain_id
+
+        # Set or clear the account default flag. An account can have one default pool.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_default
+
+        sig { params(is_default: T::Boolean).void }
+        attr_writer :is_default
+
+        # Pool name: 1-64 characters of lowercase letters, digits, `.`, `_`, and `-`,
+        # starting and ending with a letter or digit. Must be unique within the account
+        # and must not start with `dip_`.
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        sig do
+          params(
+            id: String,
+            domain_id: T.nilable(String),
+            is_default: T::Boolean,
+            name: String,
+            request_options: Telnyx::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          # Scope the pool to one of the account's email domains, or `null` to remove the
+          # scope.
+          domain_id: nil,
+          # Set or clear the account default flag. An account can have one default pool.
+          is_default: nil,
+          # Pool name: 1-64 characters of lowercase letters, digits, `.`, `_`, and `-`,
+          # starting and ending with a letter or digit. Must be unique within the account
+          # and must not start with `dip_`.
+          name: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              domain_id: T.nilable(String),
+              is_default: T::Boolean,
+              name: String,
+              request_options: Telnyx::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email/ip_pools/ip_create_params.rbi

@@ -0,0 +1,71 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Email
+      module IPPools
+        class IPCreateParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Email::IPPools::IPCreateParams,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          # The dedicated IP to add. It must belong to the account, must not be released,
+          # and must not already be in a pool.
+          sig { returns(String) }
+          attr_accessor :dedicated_ip_id
+
+          # Relative routing weight for this IP in the pool. Positive integer; defaults
+          # to 100.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :weight
+
+          sig { params(weight: Integer).void }
+          attr_writer :weight
+
+          sig do
+            params(
+              id: String,
+              dedicated_ip_id: String,
+              weight: Integer,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id:,
+            # The dedicated IP to add. It must belong to the account, must not be released,
+            # and must not already be in a pool.
+            dedicated_ip_id:,
+            # Relative routing weight for this IP in the pool. Positive integer; defaults
+            # to 100.
+            weight: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                dedicated_ip_id: String,
+                weight: Integer,
+                request_options: Telnyx::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email/ip_pools/ip_create_response.rbi

@@ -0,0 +1,112 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Email
+      module IPPools
+        class IPCreateResponse < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::Email::IPPools::IPCreateResponse,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(Telnyx::Models::Email::IPPools::IPCreateResponse::Data)
+          end
+          attr_reader :data
+
+          sig do
+            params(
+              data:
+                Telnyx::Models::Email::IPPools::IPCreateResponse::Data::OrHash
+            ).void
+          end
+          attr_writer :data
+
+          sig do
+            params(
+              data:
+                Telnyx::Models::Email::IPPools::IPCreateResponse::Data::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(data:)
+          end
+
+          sig do
+            override.returns(
+              { data: Telnyx::Models::Email::IPPools::IPCreateResponse::Data }
+            )
+          end
+          def to_hash
+          end
+
+          class Data < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::Email::IPPools::IPCreateResponse::Data,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            sig { returns(T.nilable(Time)) }
+            attr_reader :created_at
+
+            sig { params(created_at: Time).void }
+            attr_writer :created_at
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :dedicated_ip_id
+
+            sig { params(dedicated_ip_id: String).void }
+            attr_writer :dedicated_ip_id
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :pool_id
+
+            sig { params(pool_id: String).void }
+            attr_writer :pool_id
+
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :weight
+
+            sig { params(weight: Integer).void }
+            attr_writer :weight
+
+            sig do
+              params(
+                created_at: Time,
+                dedicated_ip_id: String,
+                pool_id: String,
+                weight: Integer
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              created_at: nil,
+              dedicated_ip_id: nil,
+              pool_id: nil,
+              weight: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  created_at: Time,
+                  dedicated_ip_id: String,
+                  pool_id: String,
+                  weight: Integer
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email/ip_pools/ip_delete_params.rbi

@@ -0,0 +1,82 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Email
+      module IPPools
+        class IPDeleteParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Email::IPPools::IPDeleteParams,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(String) }
+          attr_accessor :ip_id
+
+          # Set together with `force=true` to remove the last IP in the pool. Acknowledges
+          # that mail routed to the emptied pool is held until the pool has a sendable IP
+          # again.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :drain
+
+          sig { params(drain: T::Boolean).void }
+          attr_writer :drain
+
+          # Set together with `drain=true` to remove the last IP in the pool. Either flag
+          # alone has no effect.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :force
+
+          sig { params(force: T::Boolean).void }
+          attr_writer :force
+
+          sig do
+            params(
+              id: String,
+              ip_id: String,
+              drain: T::Boolean,
+              force: T::Boolean,
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id:,
+            ip_id:,
+            # Set together with `force=true` to remove the last IP in the pool. Acknowledges
+            # that mail routed to the emptied pool is held until the pool has a sendable IP
+            # again.
+            drain: nil,
+            # Set together with `drain=true` to remove the last IP in the pool. Either flag
+            # alone has no effect.
+            force: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                ip_id: String,
+                drain: T::Boolean,
+                force: T::Boolean,
+                request_options: Telnyx::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/email_domain_list_params.rbi

@@ -173,6 +173,13 @@ module Telnyx
           T.let(:domain, Telnyx::EmailDomainListParams::Sort::TaggedSymbol)
         MINUS_DOMAIN =
           T.let(:"-domain", Telnyx::EmailDomainListParams::Sort::TaggedSymbol)
+        UPDATED_AT =
+          T.let(:updated_at, Telnyx::EmailDomainListParams::Sort::TaggedSymbol)
+        UPDATED_AT_DESC =
+          T.let(
+            :"-updated_at",
+            Telnyx::EmailDomainListParams::Sort::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/telnyx/models/email_template_common.rbi

@@ -43,13 +43,7 @@ module Telnyx
 
       # Structured variable requirements, or `null` when the template uses only the
       # legacy `variables` array.
-      sig do
-        returns(
-          T.nilable(
-            T::Hash[Symbol, Telnyx::EmailTemplateCommon::VariableSchema]
-          )
-        )
-      end
+      sig { returns(T.nilable(T::Hash[Symbol, Telnyx::VariableSchemaEntry])) }
       attr_accessor :variable_schema
 
       # Persisted variable names. In `explicit` mode this array preserves the exact
@@ -75,12 +69,7 @@ module Telnyx
           text_body: T.nilable(String),
           updated_at: Time,
           variable_schema:
-            T.nilable(
-              T::Hash[
-                Symbol,
-                Telnyx::EmailTemplateCommon::VariableSchema::OrHash
-              ]
-            ),
+            T.nilable(T::Hash[Symbol, Telnyx::VariableSchemaEntry::OrHash]),
           variables: T::Array[String],
           variables_mode: Telnyx::EmailTemplateCommon::VariablesMode::OrSymbol
         ).returns(T.attached_class)
@@ -127,9 +116,7 @@ module Telnyx
             text_body: T.nilable(String),
             updated_at: Time,
             variable_schema:
-              T.nilable(
-                T::Hash[Symbol, Telnyx::EmailTemplateCommon::VariableSchema]
-              ),
+              T.nilable(T::Hash[Symbol, Telnyx::VariableSchemaEntry]),
             variables: T::Array[String],
             variables_mode:
               Telnyx::EmailTemplateCommon::VariablesMode::TaggedSymbol
@@ -163,46 +150,6 @@ module Telnyx
         end
       end
 
-      class VariableSchema < Telnyx::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Telnyx::EmailTemplateCommon::VariableSchema,
-              Telnyx::Internal::AnyHash
-            )
-          end
-
-        # Whether the variable must be supplied when strict variable validation is
-        # enabled.
-        sig { returns(T::Boolean) }
-        attr_accessor :required
-
-        # Default value for an optional variable. Rejected when `required` is `true`.
-        sig { returns(T.nilable(String)) }
-        attr_reader :default
-
-        sig { params(default: String).void }
-        attr_writer :default
-
-        sig do
-          params(required: T::Boolean, default: String).returns(
-            T.attached_class
-          )
-        end
-        def self.new(
-          # Whether the variable must be supplied when strict variable validation is
-          # enabled.
-          required:,
-          # Default value for an optional variable. Rejected when `required` is `true`.
-          default: nil
-        )
-        end
-
-        sig { override.returns({ required: T::Boolean, default: String }) }
-        def to_hash
-        end
-      end
-
       # `automatic` when variable names are derived from template content; `explicit`
       # when `variables` is the exact manually managed array.
       module VariablesMode

data/rbi/telnyx/models/email_template_create_params.rbi

@@ -60,13 +60,7 @@ module Telnyx
       # and empty array `[]` all fail with 422 naming the variable, while present values
       # such as `false` and `0` pass (they are present, not empty). Optional variables
       # fall back to their `default` when absent.
-      sig do
-        returns(
-          T.nilable(
-            T::Hash[Symbol, Telnyx::EmailTemplateCreateParams::VariableSchema]
-          )
-        )
-      end
+      sig { returns(T.nilable(T::Hash[Symbol, Telnyx::VariableSchemaEntry])) }
       attr_accessor :variable_schema
 
       # Persisted variable names. In `automatic` mode a non-null array is rejected; in
@@ -111,12 +105,7 @@ module Telnyx
           subject: T.nilable(String),
           text_body: T.nilable(String),
           variable_schema:
-            T.nilable(
-              T::Hash[
-                Symbol,
-                Telnyx::EmailTemplateCreateParams::VariableSchema::OrHash
-              ]
-            ),
+            T.nilable(T::Hash[Symbol, Telnyx::VariableSchemaEntry::OrHash]),
           variables: T.nilable(T::Array[String]),
           variables_mode:
             Telnyx::EmailTemplateCreateParams::VariablesMode::OrSymbol,
@@ -183,12 +172,7 @@ module Telnyx
             subject: T.nilable(String),
             text_body: T.nilable(String),
             variable_schema:
-              T.nilable(
-                T::Hash[
-                  Symbol,
-                  Telnyx::EmailTemplateCreateParams::VariableSchema
-                ]
-              ),
+              T.nilable(T::Hash[Symbol, Telnyx::VariableSchemaEntry]),
             variables: T.nilable(T::Array[String]),
             variables_mode:
               Telnyx::EmailTemplateCreateParams::VariablesMode::OrSymbol,
@@ -200,46 +184,6 @@ module Telnyx
       def to_hash
       end
 
-      class VariableSchema < Telnyx::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Telnyx::EmailTemplateCreateParams::VariableSchema,
-              Telnyx::Internal::AnyHash
-            )
-          end
-
-        # Whether the variable must be supplied when strict variable validation is
-        # enabled.
-        sig { returns(T::Boolean) }
-        attr_accessor :required
-
-        # Default value for an optional variable. Rejected when `required` is `true`.
-        sig { returns(T.nilable(String)) }
-        attr_reader :default
-
-        sig { params(default: String).void }
-        attr_writer :default
-
-        sig do
-          params(required: T::Boolean, default: String).returns(
-            T.attached_class
-          )
-        end
-        def self.new(
-          # Whether the variable must be supplied when strict variable validation is
-          # enabled.
-          required:,
-          # Default value for an optional variable. Rejected when `required` is `true`.
-          default: nil
-        )
-        end
-
-        sig { override.returns({ required: T::Boolean, default: String }) }
-        def to_hash
-        end
-      end
-
       # Controls how `variables` is maintained. If both fields are omitted (or
       # `variables` is null), the template uses `automatic` mode and extracts variable
       # names from the effective subject, HTML body, and text body. A non-null

data/rbi/telnyx/models/encrypted_media.rbi

@@ -2,8 +2,8 @@
 
 module Telnyx
   module Models
-    # 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.
     module EncryptedMedia
       extend Telnyx::Internal::Type::Enum
 

data/rbi/telnyx/models/fax_application.rbi

@@ -186,8 +186,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
 
@@ -230,8 +230,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/fax_application_create_params.rbi

@@ -153,8 +153,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
 
@@ -197,8 +197,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/fax_application_update_params.rbi

@@ -169,8 +169,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
 
@@ -213,8 +213,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/fqdn_connection.rbi

@@ -48,6 +48,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
+
       # Indicates whether call cost calculation is enabled.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :call_cost_enabled
@@ -103,8 +116,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
 
@@ -326,6 +339,7 @@ module Telnyx
           adjust_dtmf_timestamp: T::Boolean,
           anchorsite_override: Telnyx::AnchorsiteOverride::OrSymbol,
           android_push_credential_id: T.nilable(String),
+          bridge_generate_comfort_noise_on_cn: T::Boolean,
           call_cost_enabled: T::Boolean,
           call_cost_in_webhooks: T::Boolean,
           conversation_persistence: T::Boolean,
@@ -379,6 +393,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,
         # Indicates whether call cost calculation is enabled.
         call_cost_enabled: nil,
         # Specifies if call cost webhooks should be sent for this connection.
@@ -399,8 +421,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,
         # Indicates whether DTMF duration should be ignored.
         ignore_dtmf_duration: nil,
@@ -483,6 +505,7 @@ module Telnyx
             adjust_dtmf_timestamp: T::Boolean,
             anchorsite_override: Telnyx::AnchorsiteOverride::TaggedSymbol,
             android_push_credential_id: T.nilable(String),
+            bridge_generate_comfort_noise_on_cn: T::Boolean,
             call_cost_enabled: T::Boolean,
             call_cost_in_webhooks: T::Boolean,
             conversation_persistence: T::Boolean,