telnyx 5.126.0 → 5.128.0

data/rbi/telnyx/models/enterprises/reputation/number_associate_response.rbi

@@ -15,29 +15,30 @@ module Telnyx
 
           sig do
             returns(
-              T.nilable(
-                T::Array[
-                  Telnyx::Models::Enterprises::Reputation::NumberAssociateResponse::Data
-                ]
-              )
+              T::Array[
+                Telnyx::Models::Enterprises::Reputation::NumberAssociateResponse::Data
+              ]
             )
           end
-          attr_reader :data
+          attr_accessor :data
 
+          # JSON:API pagination metadata returned with every paginated list response. Page
+          # numbering is 1-based. `page_size` reports the number of items actually returned
+          # in `data` for this page; the requested size is taken from the `page[size]` query
+          # parameter.
           sig do
-            params(
-              data:
-                T::Array[
-                  Telnyx::Models::Enterprises::Reputation::NumberAssociateResponse::Data::OrHash
-                ]
-            ).void
+            returns(
+              Telnyx::Models::Enterprises::Reputation::NumberAssociateResponse::Meta
+            )
           end
-          attr_writer :data
-
-          sig { returns(T.nilable(Telnyx::MetaInfo)) }
           attr_reader :meta
 
-          sig { params(meta: Telnyx::MetaInfo::OrHash).void }
+          sig do
+            params(
+              meta:
+                Telnyx::Models::Enterprises::Reputation::NumberAssociateResponse::Meta::OrHash
+            ).void
+          end
           attr_writer :meta
 
           sig do
@@ -46,10 +47,18 @@ module Telnyx
                 T::Array[
                   Telnyx::Models::Enterprises::Reputation::NumberAssociateResponse::Data::OrHash
                 ],
-              meta: Telnyx::MetaInfo::OrHash
+              meta:
+                Telnyx::Models::Enterprises::Reputation::NumberAssociateResponse::Meta::OrHash
             ).returns(T.attached_class)
           end
-          def self.new(data: nil, meta: nil)
+          def self.new(
+            data:,
+            # JSON:API pagination metadata returned with every paginated list response. Page
+            # numbering is 1-based. `page_size` reports the number of items actually returned
+            # in `data` for this page; the requested size is taken from the `page[size]` query
+            # parameter.
+            meta:
+          )
           end
 
           sig do
@@ -59,7 +68,8 @@ module Telnyx
                   T::Array[
                     Telnyx::Models::Enterprises::Reputation::NumberAssociateResponse::Data
                   ],
-                meta: Telnyx::MetaInfo
+                meta:
+                  Telnyx::Models::Enterprises::Reputation::NumberAssociateResponse::Meta
               }
             )
           end
@@ -75,35 +85,42 @@ module Telnyx
                 )
               end
 
-            # Unique identifier
-            sig { returns(T.nilable(String)) }
-            attr_reader :id
-
-            sig { params(id: String).void }
-            attr_writer :id
-
-            # When the number was associated
-            sig { returns(T.nilable(Time)) }
-            attr_reader :created_at
-
-            sig { params(created_at: Time).void }
-            attr_writer :created_at
-
-            # ID of the associated enterprise
             sig { returns(T.nilable(String)) }
             attr_reader :enterprise_id
 
             sig { params(enterprise_id: String).void }
             attr_writer :enterprise_id
 
-            # Phone number in E.164 format
+            # E.164 with leading `+`.
             sig { returns(T.nilable(String)) }
             attr_reader :phone_number
 
             sig { params(phone_number: String).void }
             attr_writer :phone_number
 
-            # When the record was last updated
+            # `null` until the first refresh has been collected for this number.
+            sig { returns(T.nilable(Telnyx::ReputationData)) }
+            attr_reader :reputation_data
+
+            sig do
+              params(
+                reputation_data: T.nilable(Telnyx::ReputationData::OrHash)
+              ).void
+            end
+            attr_writer :reputation_data
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :id
+
+            sig { params(id: String).void }
+            attr_writer :id
+
+            sig { returns(T.nilable(Time)) }
+            attr_reader :created_at
+
+            sig { params(created_at: Time).void }
+            attr_writer :created_at
+
             sig { returns(T.nilable(Time)) }
             attr_reader :updated_at
 
@@ -116,19 +133,18 @@ module Telnyx
                 created_at: Time,
                 enterprise_id: String,
                 phone_number: String,
+                reputation_data: T.nilable(Telnyx::ReputationData::OrHash),
                 updated_at: Time
               ).returns(T.attached_class)
             end
             def self.new(
-              # Unique identifier
               id: nil,
-              # When the number was associated
               created_at: nil,
-              # ID of the associated enterprise
               enterprise_id: nil,
-              # Phone number in E.164 format
+              # E.164 with leading `+`.
               phone_number: nil,
-              # When the record was last updated
+              # `null` until the first refresh has been collected for this number.
+              reputation_data: nil,
               updated_at: nil
             )
             end
@@ -140,6 +156,7 @@ module Telnyx
                   created_at: Time,
                   enterprise_id: String,
                   phone_number: String,
+                  reputation_data: T.nilable(Telnyx::ReputationData),
                   updated_at: Time
                 }
               )
@@ -147,6 +164,71 @@ module Telnyx
             def to_hash
             end
           end
+
+          class Meta < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::Enterprises::Reputation::NumberAssociateResponse::Meta,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # 1-based index of this page. Echoes the `page[number]` query parameter (default
+            # `1`).
+            sig { returns(Integer) }
+            attr_accessor :page_number
+
+            # Number of items returned in this page's `data` array. Capped at 250.
+            sig { returns(Integer) }
+            attr_accessor :page_size
+
+            # Total number of pages available given the current `page_size`.
+            sig { returns(Integer) }
+            attr_accessor :total_pages
+
+            # Total number of items across all pages (excludes soft-deleted rows).
+            sig { returns(Integer) }
+            attr_accessor :total_results
+
+            # JSON:API pagination metadata returned with every paginated list response. Page
+            # numbering is 1-based. `page_size` reports the number of items actually returned
+            # in `data` for this page; the requested size is taken from the `page[size]` query
+            # parameter.
+            sig do
+              params(
+                page_number: Integer,
+                page_size: Integer,
+                total_pages: Integer,
+                total_results: Integer
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # 1-based index of this page. Echoes the `page[number]` query parameter (default
+              # `1`).
+              page_number:,
+              # Number of items returned in this page's `data` array. Capped at 250.
+              page_size:,
+              # Total number of pages available given the current `page_size`.
+              total_pages:,
+              # Total number of items across all pages (excludes soft-deleted rows).
+              total_results:
+            )
+            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/enterprises/reputation/number_list_params.rbi

@@ -19,44 +19,54 @@ module Telnyx
           sig { returns(String) }
           attr_accessor :enterprise_id
 
-          # Page number (1-indexed)
+          # Partial match on phone number. Must contain at least 5 digits.
+          sig { returns(T.nilable(String)) }
+          attr_reader :filter_phone_number_contains
+
+          sig { params(filter_phone_number_contains: String).void }
+          attr_writer :filter_phone_number_contains
+
+          # Exact phone-number match (E.164).
+          sig { returns(T.nilable(String)) }
+          attr_reader :filter_phone_number_eq
+
+          sig { params(filter_phone_number_eq: String).void }
+          attr_writer :filter_phone_number_eq
+
+          # 1-based page number. Out-of-range values return an empty page with correct meta.
           sig { returns(T.nilable(Integer)) }
           attr_reader :page_number
 
           sig { params(page_number: Integer).void }
           attr_writer :page_number
 
-          # Number of items per page
+          # Items per page. Default 10. Maximum 250; values above are clamped to 250.
           sig { returns(T.nilable(Integer)) }
           attr_reader :page_size
 
           sig { params(page_size: Integer).void }
           attr_writer :page_size
 
-          # Filter by specific phone number (E.164 format)
-          sig { returns(T.nilable(String)) }
-          attr_reader :phone_number
-
-          sig { params(phone_number: String).void }
-          attr_writer :phone_number
-
           sig do
             params(
               enterprise_id: String,
+              filter_phone_number_contains: String,
+              filter_phone_number_eq: String,
               page_number: Integer,
               page_size: Integer,
-              phone_number: String,
               request_options: Telnyx::RequestOptions::OrHash
             ).returns(T.attached_class)
           end
           def self.new(
             enterprise_id:,
-            # Page number (1-indexed)
+            # Partial match on phone number. Must contain at least 5 digits.
+            filter_phone_number_contains: nil,
+            # Exact phone-number match (E.164).
+            filter_phone_number_eq: nil,
+            # 1-based page number. Out-of-range values return an empty page with correct meta.
             page_number: nil,
-            # Number of items per page
+            # Items per page. Default 10. Maximum 250; values above are clamped to 250.
             page_size: nil,
-            # Filter by specific phone number (E.164 format)
-            phone_number: nil,
             request_options: {}
           )
           end
@@ -65,9 +75,10 @@ module Telnyx
             override.returns(
               {
                 enterprise_id: String,
+                filter_phone_number_contains: String,
+                filter_phone_number_eq: String,
                 page_number: Integer,
                 page_size: Integer,
-                phone_number: String,
                 request_options: Telnyx::RequestOptions
               }
             )

data/rbi/telnyx/models/enterprises/reputation/number_list_response.rbi

@@ -0,0 +1,98 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Enterprises
+      module Reputation
+        class NumberListResponse < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::Enterprises::Reputation::NumberListResponse,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :enterprise_id
+
+          sig { params(enterprise_id: String).void }
+          attr_writer :enterprise_id
+
+          # E.164 with leading `+`.
+          sig { returns(T.nilable(String)) }
+          attr_reader :phone_number
+
+          sig { params(phone_number: String).void }
+          attr_writer :phone_number
+
+          # `null` until the first refresh has been collected for this number.
+          sig { returns(T.nilable(Telnyx::ReputationData)) }
+          attr_reader :reputation_data
+
+          sig do
+            params(
+              reputation_data: T.nilable(Telnyx::ReputationData::OrHash)
+            ).void
+          end
+          attr_writer :reputation_data
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :id
+
+          sig { params(id: String).void }
+          attr_writer :id
+
+          sig { returns(T.nilable(Time)) }
+          attr_reader :created_at
+
+          sig { params(created_at: Time).void }
+          attr_writer :created_at
+
+          sig { returns(T.nilable(Time)) }
+          attr_reader :updated_at
+
+          sig { params(updated_at: Time).void }
+          attr_writer :updated_at
+
+          sig do
+            params(
+              id: String,
+              created_at: Time,
+              enterprise_id: String,
+              phone_number: String,
+              reputation_data: T.nilable(Telnyx::ReputationData::OrHash),
+              updated_at: Time
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id: nil,
+            created_at: nil,
+            enterprise_id: nil,
+            # E.164 with leading `+`.
+            phone_number: nil,
+            # `null` until the first refresh has been collected for this number.
+            reputation_data: nil,
+            updated_at: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                created_at: Time,
+                enterprise_id: String,
+                phone_number: String,
+                reputation_data: T.nilable(Telnyx::ReputationData),
+                updated_at: Time
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/enterprises/reputation/number_refresh_params.rbi

@@ -0,0 +1,58 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Enterprises
+      module Reputation
+        class NumberRefreshParams < Telnyx::Internal::Type::BaseModel
+          extend Telnyx::Internal::Type::RequestParameters::Converter
+          include Telnyx::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Enterprises::Reputation::NumberRefreshParams,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :enterprise_id
+
+          # Phone numbers to refresh reputation data for. 1–100 numbers per request, each in
+          # E.164 format. Reputation refreshes are subject to per-enterprise rate limits.
+          sig { returns(T::Array[String]) }
+          attr_accessor :phone_numbers
+
+          sig do
+            params(
+              enterprise_id: String,
+              phone_numbers: T::Array[String],
+              request_options: Telnyx::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            enterprise_id:,
+            # Phone numbers to refresh reputation data for. 1–100 numbers per request, each in
+            # E.164 format. Reputation refreshes are subject to per-enterprise rate limits.
+            phone_numbers:,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                enterprise_id: String,
+                phone_numbers: T::Array[String],
+                request_options: Telnyx::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/enterprises/reputation/number_refresh_response.rbi

@@ -0,0 +1,166 @@
+# typed: strong
+
+module Telnyx
+  module Models
+    module Enterprises
+      module Reputation
+        class NumberRefreshResponse < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::Enterprises::Reputation::NumberRefreshResponse,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              Telnyx::Models::Enterprises::Reputation::NumberRefreshResponse::Data
+            )
+          end
+          attr_reader :data
+
+          sig do
+            params(
+              data:
+                Telnyx::Models::Enterprises::Reputation::NumberRefreshResponse::Data::OrHash
+            ).void
+          end
+          attr_writer :data
+
+          sig do
+            params(
+              data:
+                Telnyx::Models::Enterprises::Reputation::NumberRefreshResponse::Data::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(data:)
+          end
+
+          sig do
+            override.returns(
+              {
+                data:
+                  Telnyx::Models::Enterprises::Reputation::NumberRefreshResponse::Data
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Data < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::Enterprises::Reputation::NumberRefreshResponse::Data,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # Per-number outcome of the refresh.
+            sig do
+              returns(
+                T::Array[
+                  Telnyx::Models::Enterprises::Reputation::NumberRefreshResponse::Data::Result
+                ]
+              )
+            end
+            attr_accessor :results
+
+            sig { returns(Integer) }
+            attr_accessor :total_failed
+
+            sig { returns(Integer) }
+            attr_accessor :total_requested
+
+            sig { returns(Integer) }
+            attr_accessor :total_successful
+
+            sig do
+              params(
+                results:
+                  T::Array[
+                    Telnyx::Models::Enterprises::Reputation::NumberRefreshResponse::Data::Result::OrHash
+                  ],
+                total_failed: Integer,
+                total_requested: Integer,
+                total_successful: Integer
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Per-number outcome of the refresh.
+              results:,
+              total_failed:,
+              total_requested:,
+              total_successful:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  results:
+                    T::Array[
+                      Telnyx::Models::Enterprises::Reputation::NumberRefreshResponse::Data::Result
+                    ],
+                  total_failed: Integer,
+                  total_requested: Integer,
+                  total_successful: Integer
+                }
+              )
+            end
+            def to_hash
+            end
+
+            class Result < Telnyx::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Telnyx::Models::Enterprises::Reputation::NumberRefreshResponse::Data::Result,
+                    Telnyx::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(String) }
+              attr_accessor :phone_number
+
+              sig { returns(T::Boolean) }
+              attr_accessor :success
+
+              # `null` when `success` is `true`; carries an error message otherwise.
+              sig { returns(T.nilable(String)) }
+              attr_accessor :error
+
+              sig do
+                params(
+                  phone_number: String,
+                  success: T::Boolean,
+                  error: T.nilable(String)
+                ).returns(T.attached_class)
+              end
+              def self.new(
+                phone_number:,
+                success:,
+                # `null` when `success` is `true`; carries an error message otherwise.
+                error: nil
+              )
+              end
+
+              sig do
+                override.returns(
+                  {
+                    phone_number: String,
+                    success: T::Boolean,
+                    error: T.nilable(String)
+                  }
+                )
+              end
+              def to_hash
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/telnyx/models/enterprises/reputation/number_retrieve_params.rbi

@@ -22,8 +22,8 @@ module Telnyx
           sig { returns(String) }
           attr_accessor :phone_number
 
-          # When true, fetches fresh reputation data (incurs API cost). When false, returns
-          # cached data.
+          # When true, fetches fresh reputation data (incurs API cost). When false
+          # (default), returns cached data.
           sig { returns(T.nilable(T::Boolean)) }
           attr_reader :fresh
 
@@ -41,8 +41,8 @@ module Telnyx
           def self.new(
             enterprise_id:,
             phone_number:,
-            # When true, fetches fresh reputation data (incurs API cost). When false, returns
-            # cached data.
+            # When true, fetches fresh reputation data (incurs API cost). When false
+            # (default), returns cached data.
             fresh: nil,
             request_options: {}
           )