telnyx 5.167.0 → 5.169.0

data/rbi/telnyx/models/compute/functions_observability_pagination_meta.rbi

@@ -0,0 +1,70 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Compute
+      class FunctionsObservabilityPaginationMeta < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Compute::FunctionsObservabilityPaginationMeta,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_number
+
+        sig { params(page_number: Integer).void }
+        attr_writer :page_number
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :page_size
+
+        sig { params(page_size: Integer).void }
+        attr_writer :page_size
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :total_pages
+
+        sig { params(total_pages: Integer).void }
+        attr_writer :total_pages
+
+        sig { returns(T.nilable(Integer)) }
+        attr_reader :total_results
+
+        sig { params(total_results: Integer).void }
+        attr_writer :total_results
+
+        sig do
+          params(
+            page_number: Integer,
+            page_size: Integer,
+            total_pages: Integer,
+            total_results: Integer
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          page_number: nil,
+          page_size: nil,
+          total_pages: nil,
+          total_results: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              page_number: Integer,
+              page_size: Integer,
+              total_pages: Integer,
+              total_results: Integer
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/compute/logs_meta.rbi

@@ -0,0 +1,38 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Compute
+      class LogsMeta < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Telnyx::Compute::LogsMeta, Telnyx::Internal::AnyHash)
+          end
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :has_more
+
+        sig { params(has_more: T::Boolean).void }
+        attr_writer :has_more
+
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :partial
+
+        sig { params(partial: T::Boolean).void }
+        attr_writer :partial
+
+        sig do
+          params(has_more: T::Boolean, partial: T::Boolean).returns(
+            T.attached_class
+          )
+        end
+        def self.new(has_more: nil, partial: nil)
+        end
+
+        sig { override.returns({ has_more: T::Boolean, partial: T::Boolean }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/connection_retrieve_count_params.rbi

@@ -0,0 +1,30 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class ConnectionRetrieveCountParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::ConnectionRetrieveCountParams,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig do
+        params(request_options: Telnyx::RequestOptions::OrHash).returns(
+          T.attached_class
+        )
+      end
+      def self.new(request_options: {})
+      end
+
+      sig { override.returns({ request_options: Telnyx::RequestOptions }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/telnyx/models/connection_retrieve_count_response.rbi

@@ -0,0 +1,353 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    class ConnectionRetrieveCountResponse < Telnyx::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Telnyx::Models::ConnectionRetrieveCountResponse,
+            Telnyx::Internal::AnyHash
+          )
+        end
+
+      sig { returns(Telnyx::Models::ConnectionRetrieveCountResponse::Data) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: Telnyx::Models::ConnectionRetrieveCountResponse::Data::OrHash
+        ).void
+      end
+      attr_writer :data
+
+      sig do
+        params(
+          data: Telnyx::Models::ConnectionRetrieveCountResponse::Data::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(data:)
+      end
+
+      sig do
+        override.returns(
+          { data: Telnyx::Models::ConnectionRetrieveCountResponse::Data }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Telnyx::Models::ConnectionRetrieveCountResponse::Data,
+              Telnyx::Internal::AnyHash
+            )
+          end
+
+        # Counts of the authenticated user's connections, grouped by connection type.
+        # Forward-only connections are excluded.
+        sig do
+          returns(Telnyx::Models::ConnectionRetrieveCountResponse::Data::Counts)
+        end
+        attr_reader :counts
+
+        sig do
+          params(
+            counts:
+              Telnyx::Models::ConnectionRetrieveCountResponse::Data::Counts::OrHash
+          ).void
+        end
+        attr_writer :counts
+
+        # Connection limits that apply to the user. Contains a single global_limit when a
+        # global connection limit applies, or per-type limits (standard_limit, texml_limit
+        # and uac_limit) when the user has per-type connection count capabilities.
+        sig do
+          returns(
+            Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::Variants
+          )
+        end
+        attr_accessor :limits
+
+        # Identifies the type of the resource.
+        sig { returns(String) }
+        attr_accessor :record_type
+
+        sig do
+          params(
+            counts:
+              Telnyx::Models::ConnectionRetrieveCountResponse::Data::Counts::OrHash,
+            limits:
+              T.any(
+                Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::GlobalConnectionLimit::OrHash,
+                Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::PerTypeConnectionLimits::OrHash
+              ),
+            record_type: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Counts of the authenticated user's connections, grouped by connection type.
+          # Forward-only connections are excluded.
+          counts:,
+          # Connection limits that apply to the user. Contains a single global_limit when a
+          # global connection limit applies, or per-type limits (standard_limit, texml_limit
+          # and uac_limit) when the user has per-type connection count capabilities.
+          limits:,
+          # Identifies the type of the resource.
+          record_type:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              counts:
+                Telnyx::Models::ConnectionRetrieveCountResponse::Data::Counts,
+              limits:
+                Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::Variants,
+              record_type: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Counts < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::ConnectionRetrieveCountResponse::Data::Counts,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Number of Call Control applications.
+          sig { returns(Integer) }
+          attr_accessor :call_control_applications
+
+          # Number of credential connections.
+          sig { returns(Integer) }
+          attr_accessor :credential_connections
+
+          # Number of external connections.
+          sig { returns(Integer) }
+          attr_accessor :external_connections
+
+          # Number of Fax applications.
+          sig { returns(Integer) }
+          attr_accessor :fax_connections
+
+          # Number of FQDN connections.
+          sig { returns(Integer) }
+          attr_accessor :fqdn_connections
+
+          # Number of IP connections.
+          sig { returns(Integer) }
+          attr_accessor :ip_connections
+
+          # Number of Microsoft Teams SBC (direct routing) connections.
+          sig { returns(Integer) }
+          attr_accessor :microsoft_teams_sbc_connections
+
+          # Number of mobile voice (IMS) connections.
+          sig { returns(Integer) }
+          attr_accessor :mobile_voice_connections
+
+          # Number of Microsoft Operator Connect connections.
+          sig { returns(Integer) }
+          attr_accessor :operator_connect_connections
+
+          # Number of TeXML applications.
+          sig { returns(Integer) }
+          attr_accessor :texml_applications
+
+          # Number of third-party provider connections.
+          sig { returns(Integer) }
+          attr_accessor :third_party_provider_connections
+
+          # Number of UAC connections.
+          sig { returns(Integer) }
+          attr_accessor :uac_connections
+
+          # Number of Zoom SBC connections.
+          sig { returns(Integer) }
+          attr_accessor :zoom_sbc_connections
+
+          # Counts of the authenticated user's connections, grouped by connection type.
+          # Forward-only connections are excluded.
+          sig do
+            params(
+              call_control_applications: Integer,
+              credential_connections: Integer,
+              external_connections: Integer,
+              fax_connections: Integer,
+              fqdn_connections: Integer,
+              ip_connections: Integer,
+              microsoft_teams_sbc_connections: Integer,
+              mobile_voice_connections: Integer,
+              operator_connect_connections: Integer,
+              texml_applications: Integer,
+              third_party_provider_connections: Integer,
+              uac_connections: Integer,
+              zoom_sbc_connections: Integer
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Number of Call Control applications.
+            call_control_applications:,
+            # Number of credential connections.
+            credential_connections:,
+            # Number of external connections.
+            external_connections:,
+            # Number of Fax applications.
+            fax_connections:,
+            # Number of FQDN connections.
+            fqdn_connections:,
+            # Number of IP connections.
+            ip_connections:,
+            # Number of Microsoft Teams SBC (direct routing) connections.
+            microsoft_teams_sbc_connections:,
+            # Number of mobile voice (IMS) connections.
+            mobile_voice_connections:,
+            # Number of Microsoft Operator Connect connections.
+            operator_connect_connections:,
+            # Number of TeXML applications.
+            texml_applications:,
+            # Number of third-party provider connections.
+            third_party_provider_connections:,
+            # Number of UAC connections.
+            uac_connections:,
+            # Number of Zoom SBC connections.
+            zoom_sbc_connections:
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                call_control_applications: Integer,
+                credential_connections: Integer,
+                external_connections: Integer,
+                fax_connections: Integer,
+                fqdn_connections: Integer,
+                ip_connections: Integer,
+                microsoft_teams_sbc_connections: Integer,
+                mobile_voice_connections: Integer,
+                operator_connect_connections: Integer,
+                texml_applications: Integer,
+                third_party_provider_connections: Integer,
+                uac_connections: Integer,
+                zoom_sbc_connections: Integer
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        # Connection limits that apply to the user. Contains a single global_limit when a
+        # global connection limit applies, or per-type limits (standard_limit, texml_limit
+        # and uac_limit) when the user has per-type connection count capabilities.
+        module Limits
+          extend Telnyx::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::GlobalConnectionLimit,
+                Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::PerTypeConnectionLimits
+              )
+            end
+
+          class GlobalConnectionLimit < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::GlobalConnectionLimit,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # Maximum total number of connections allowed, when a global limit applies.
+            sig { returns(Integer) }
+            attr_accessor :global_limit
+
+            sig { params(global_limit: Integer).returns(T.attached_class) }
+            def self.new(
+              # Maximum total number of connections allowed, when a global limit applies.
+              global_limit:
+            )
+            end
+
+            sig { override.returns({ global_limit: Integer }) }
+            def to_hash
+            end
+          end
+
+          class PerTypeConnectionLimits < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::PerTypeConnectionLimits,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # Maximum number of standard connections allowed, when per-type limits apply.
+            sig { returns(Integer) }
+            attr_accessor :standard_limit
+
+            # Maximum number of TeXML applications allowed, when per-type limits apply.
+            sig { returns(Integer) }
+            attr_accessor :texml_limit
+
+            # Maximum number of UAC connections allowed, when per-type limits apply.
+            sig { returns(Integer) }
+            attr_accessor :uac_limit
+
+            sig do
+              params(
+                standard_limit: Integer,
+                texml_limit: Integer,
+                uac_limit: Integer
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Maximum number of standard connections allowed, when per-type limits apply.
+              standard_limit:,
+              # Maximum number of TeXML applications allowed, when per-type limits apply.
+              texml_limit:,
+              # Maximum number of UAC connections allowed, when per-type limits apply.
+              uac_limit:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  standard_limit: Integer,
+                  texml_limit: Integer,
+                  uac_limit: Integer
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[
+                Telnyx::Models::ConnectionRetrieveCountResponse::Data::Limits::Variants
+              ]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/credential_connection.rbi

@@ -164,7 +164,10 @@ module Telnyx
       attr_writer :outbound
 
       # The password to be used as part of the credentials. Must be 8 to 128 characters
-      # long.
+      # long. For primary accounts created on or after September 8, 2026, this password
+      # is returned as `********`. The password is returned in full on create, and on
+      # update only when that update changed the password. Accounts created before
+      # September 8, 2026 are unaffected.
       sig { returns(T.nilable(String)) }
       attr_reader :password
 
@@ -359,7 +362,10 @@ module Telnyx
         onnet_t38_passthrough_enabled: nil,
         outbound: nil,
         # The password to be used as part of the credentials. Must be 8 to 128 characters
-        # long.
+        # long. For primary accounts created on or after September 8, 2026, this password
+        # is returned as `********`. The password is returned in full on create, and on
+        # update only when that update changed the password. Accounts created before
+        # September 8, 2026 are unaffected.
         password: nil,
         # Identifies the type of the resource.
         record_type: nil,

data/rbi/telnyx/models/detail_record_list_params.rbi

@@ -13,6 +13,12 @@ module Telnyx
 
       # Filter records on a given record attribute and value. <br/>Example:
       # filter[status]=delivered. <br/>Required: filter[record_type] must be specified.
+      # <br/>The valid filter fields depend on the record_type: filtering by a field
+      # that does not exist for the selected record_type is rejected with a 400 error.
+      # Call-control and sip-trunking records use started_at, finished_at and
+      # answered_at (they have no created_at); messaging records use created_at. To list
+      # the fields available for a record_type, use the /v2/detail_records/options
+      # endpoint.
       sig { returns(T.nilable(Telnyx::DetailRecordListParams::Filter)) }
       attr_reader :filter
 
@@ -33,7 +39,12 @@ module Telnyx
       sig { params(page_size: Integer).void }
       attr_writer :page_size
 
-      # Specifies the sort order for results. <br/>Example: sort=-created_at
+      # Specifies the sort order for results. <br/>Example: sort=-created_at <br/>The
+      # valid sort fields depend on the record_type: sort by a field that does not exist
+      # for the selected record_type is rejected with a 400 error. Call-control and
+      # sip-trunking records use started_at, finished_at and answered_at (they have no
+      # created_at); messaging records use created_at. To list the fields available for
+      # a record_type, use the /v2/detail_records/options endpoint.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :sort
 
@@ -52,10 +63,21 @@ module Telnyx
       def self.new(
         # Filter records on a given record attribute and value. <br/>Example:
         # filter[status]=delivered. <br/>Required: filter[record_type] must be specified.
+        # <br/>The valid filter fields depend on the record_type: filtering by a field
+        # that does not exist for the selected record_type is rejected with a 400 error.
+        # Call-control and sip-trunking records use started_at, finished_at and
+        # answered_at (they have no created_at); messaging records use created_at. To list
+        # the fields available for a record_type, use the /v2/detail_records/options
+        # endpoint.
         filter: nil,
         page_number: nil,
         page_size: nil,
-        # Specifies the sort order for results. <br/>Example: sort=-created_at
+        # Specifies the sort order for results. <br/>Example: sort=-created_at <br/>The
+        # valid sort fields depend on the record_type: sort by a field that does not exist
+        # for the selected record_type is rejected with a 400 error. Call-control and
+        # sip-trunking records use started_at, finished_at and answered_at (they have no
+        # created_at); messaging records use created_at. To list the fields available for
+        # a record_type, use the /v2/detail_records/options endpoint.
         sort: nil,
         request_options: {}
       )
@@ -111,6 +133,12 @@ module Telnyx
 
         # Filter records on a given record attribute and value. <br/>Example:
         # filter[status]=delivered. <br/>Required: filter[record_type] must be specified.
+        # <br/>The valid filter fields depend on the record_type: filtering by a field
+        # that does not exist for the selected record_type is rejected with a 400 error.
+        # Call-control and sip-trunking records use started_at, finished_at and
+        # answered_at (they have no created_at); messaging records use created_at. To list
+        # the fields available for a record_type, use the /v2/detail_records/options
+        # endpoint.
         sig do
           params(
             record_type:

data/rbi/telnyx/models/email_inboxes/email_message.rbi

@@ -95,6 +95,18 @@ module Telnyx
         sig { params(scheduled_at: Time).void }
         attr_writer :scheduled_at
 
+        # Recipients excluded from delivery by suppression checks, with reasons. On batch
+        # items, present when that item had suppressed recipients; all other recipients of
+        # the item still receive the message. For single sends this information appears at
+        # the top level of the response instead (see EmailMessageResponse.suppressed).
+        sig { returns(T.nilable(T::Array[Telnyx::SuppressedRecipient])) }
+        attr_reader :suppressed
+
+        sig do
+          params(suppressed: T::Array[Telnyx::SuppressedRecipient::OrHash]).void
+        end
+        attr_writer :suppressed
+
         sig do
           params(
             id: String,
@@ -116,7 +128,8 @@ module Telnyx
             inline_css: T::Boolean,
             recipient_statuses: T::Hash[Symbol, Integer],
             sandbox: T::Boolean,
-            scheduled_at: Time
+            scheduled_at: Time,
+            suppressed: T::Array[Telnyx::SuppressedRecipient::OrHash]
           ).returns(T.attached_class)
         end
         def self.new(
@@ -148,7 +161,12 @@ module Telnyx
           sandbox: nil,
           # Present when a scheduled_at value was stored. Persists even after the scheduled
           # send has been processed or cancelled.
-          scheduled_at: nil
+          scheduled_at: nil,
+          # Recipients excluded from delivery by suppression checks, with reasons. On batch
+          # items, present when that item had suppressed recipients; all other recipients of
+          # the item still receive the message. For single sends this information appears at
+          # the top level of the response instead (see EmailMessageResponse.suppressed).
+          suppressed: nil
         )
         end
 
@@ -174,7 +192,8 @@ module Telnyx
               inline_css: T::Boolean,
               recipient_statuses: T::Hash[Symbol, Integer],
               sandbox: T::Boolean,
-              scheduled_at: Time
+              scheduled_at: Time,
+              suppressed: T::Array[Telnyx::SuppressedRecipient]
             }
           )
         end

data/rbi/telnyx/models/email_message_batch_params.rbi

@@ -11,6 +11,9 @@ module Telnyx
           T.any(Telnyx::EmailMessageBatchParams, Telnyx::Internal::AnyHash)
         end
 
+      # Array of email messages to send. Up to 1,000 messages per batch request. Each
+      # message is validated and sent independently; per-message failures do not affect
+      # other messages in the batch.
       sig { returns(T::Array[Telnyx::EmailMessageBatchParams::Message]) }
       attr_accessor :messages
 
@@ -37,6 +40,9 @@ module Telnyx
         ).returns(T.attached_class)
       end
       def self.new(
+        # Array of email messages to send. Up to 1,000 messages per batch request. Each
+        # message is validated and sent independently; per-message failures do not affect
+        # other messages in the batch.
         messages:,
         # Applies sandbox mode to all messages in the batch. Overrides any per-message
         # sandbox_mode in the messages array.

data/rbi/telnyx/models/email_message_batch_response.rbi

@@ -139,6 +139,11 @@ module Telnyx
               :service_unavailable,
               Telnyx::Models::EmailMessageBatchResponse::Error::Code::TaggedSymbol
             )
+          UNPROCESSABLE_ENTITY =
+            T.let(
+              :unprocessable_entity,
+              Telnyx::Models::EmailMessageBatchResponse::Error::Code::TaggedSymbol
+            )
           VALIDATION_ERROR =
             T.let(
               :validation_error,

data/rbi/telnyx/models/fqdn_connection.rbi

@@ -196,7 +196,10 @@ module Telnyx
       sig { params(outbound: Telnyx::OutboundFqdn::OrHash).void }
       attr_writer :outbound
 
-      # The password for the FQDN connection.
+      # The password for the FQDN connection. For primary accounts created on or after
+      # September 8, 2026, this password is returned as `********`. The password is
+      # returned in full on create, and on update only when that update changed the
+      # password. Accounts created before September 8, 2026 are unaffected.
       sig { returns(T.nilable(String)) }
       attr_reader :password
 
@@ -429,7 +432,10 @@ module Telnyx
         # be able to use T38 on just one leg of the call according to each leg's settings.
         onnet_t38_passthrough_enabled: nil,
         outbound: nil,
-        # The password for the FQDN connection.
+        # The password for the FQDN connection. For primary accounts created on or after
+        # September 8, 2026, this password is returned as `********`. The password is
+        # returned in full on create, and on update only when that update changed the
+        # password. Accounts created before September 8, 2026 are unaffected.
         password: nil,
         # Identifies the type of the resource.
         record_type: nil,