telnyx 5.171.0 → 5.174.0

data/rbi/telnyx/models/number_lookup_retrieve_response.rbi

@@ -48,6 +48,25 @@ module Telnyx
             )
           end
 
+        # Identity information for the phone number's owner, including name and postal
+        # address. Populated when `type=caller-identity` is requested.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::Models::NumberLookupRetrieveResponse::Data::CallerIdentity
+            )
+          )
+        end
+        attr_reader :caller_identity
+
+        sig do
+          params(
+            caller_identity:
+              Telnyx::Models::NumberLookupRetrieveResponse::Data::CallerIdentity::OrHash
+          ).void
+        end
+        attr_writer :caller_identity
+
         sig do
           returns(
             T.nilable(
@@ -89,6 +108,25 @@ module Telnyx
         sig { params(country_code: String).void }
         attr_writer :country_code
 
+        # Enhanced caller name for the phone number's owner. Populated when
+        # `type=enhanced-caller-name` is requested.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::Models::NumberLookupRetrieveResponse::Data::EnhancedCallerName
+            )
+          )
+        end
+        attr_reader :enhanced_caller_name
+
+        sig do
+          params(
+            enhanced_caller_name:
+              Telnyx::Models::NumberLookupRetrieveResponse::Data::EnhancedCallerName::OrHash
+          ).void
+        end
+        attr_writer :enhanced_caller_name
+
         # Unused
         sig { returns(T.nilable(String)) }
         attr_accessor :fraud
@@ -101,6 +139,27 @@ module Telnyx
         sig { params(national_format: String).void }
         attr_writer :national_format
 
+        # Network number ID (NNID) override for the phone number, when one applies
+        # (available only to accounts enabled for NNID); otherwise null.
+        sig do
+          returns(
+            T.nilable(
+              Telnyx::Models::NumberLookupRetrieveResponse::Data::NnidOverride
+            )
+          )
+        end
+        attr_reader :nnid_override
+
+        sig do
+          params(
+            nnid_override:
+              T.nilable(
+                Telnyx::Models::NumberLookupRetrieveResponse::Data::NnidOverride::OrHash
+              )
+          ).void
+        end
+        attr_writer :nnid_override
+
         # E164-formatted phone number
         sig { returns(T.nilable(String)) }
         attr_reader :phone_number
@@ -132,59 +191,266 @@ module Telnyx
         sig { params(record_type: String).void }
         attr_writer :record_type
 
+        # Indicates whether the phone number is valid.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :valid_number
+
+        sig { params(valid_number: T::Boolean).void }
+        attr_writer :valid_number
+
         sig do
           params(
+            caller_identity:
+              Telnyx::Models::NumberLookupRetrieveResponse::Data::CallerIdentity::OrHash,
             caller_name:
               Telnyx::Models::NumberLookupRetrieveResponse::Data::CallerName::OrHash,
             carrier:
               Telnyx::Models::NumberLookupRetrieveResponse::Data::Carrier::OrHash,
             country_code: String,
+            enhanced_caller_name:
+              Telnyx::Models::NumberLookupRetrieveResponse::Data::EnhancedCallerName::OrHash,
             fraud: T.nilable(String),
             national_format: String,
+            nnid_override:
+              T.nilable(
+                Telnyx::Models::NumberLookupRetrieveResponse::Data::NnidOverride::OrHash
+              ),
             phone_number: String,
             portability:
               Telnyx::Models::NumberLookupRetrieveResponse::Data::Portability::OrHash,
-            record_type: String
+            record_type: String,
+            valid_number: T::Boolean
           ).returns(T.attached_class)
         end
         def self.new(
+          # Identity information for the phone number's owner, including name and postal
+          # address. Populated when `type=caller-identity` is requested.
+          caller_identity: nil,
           caller_name: nil,
           carrier: nil,
           # Region code that matches the specific country calling code
           country_code: nil,
+          # Enhanced caller name for the phone number's owner. Populated when
+          # `type=enhanced-caller-name` is requested.
+          enhanced_caller_name: nil,
           # Unused
           fraud: nil,
           # Hyphen-separated national number, preceded by the national destination code
           # (NDC), with a 0 prefix, if an NDC is found
           national_format: nil,
+          # Network number ID (NNID) override for the phone number, when one applies
+          # (available only to accounts enabled for NNID); otherwise null.
+          nnid_override: nil,
           # E164-formatted phone number
           phone_number: nil,
           portability: nil,
           # Identifies the type of record
-          record_type: nil
+          record_type: nil,
+          # Indicates whether the phone number is valid.
+          valid_number: nil
         )
         end
 
         sig do
           override.returns(
             {
+              caller_identity:
+                Telnyx::Models::NumberLookupRetrieveResponse::Data::CallerIdentity,
               caller_name:
                 Telnyx::Models::NumberLookupRetrieveResponse::Data::CallerName,
               carrier:
                 Telnyx::Models::NumberLookupRetrieveResponse::Data::Carrier,
               country_code: String,
+              enhanced_caller_name:
+                Telnyx::Models::NumberLookupRetrieveResponse::Data::EnhancedCallerName,
               fraud: T.nilable(String),
               national_format: String,
+              nnid_override:
+                T.nilable(
+                  Telnyx::Models::NumberLookupRetrieveResponse::Data::NnidOverride
+                ),
               phone_number: String,
               portability:
                 Telnyx::Models::NumberLookupRetrieveResponse::Data::Portability,
-              record_type: String
+              record_type: String,
+              valid_number: T::Boolean
             }
           )
         end
         def to_hash
         end
 
+        class CallerIdentity < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::NumberLookupRetrieveResponse::Data::CallerIdentity,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Postal address associated with the phone number's owner.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::Models::NumberLookupRetrieveResponse::Data::CallerIdentity::Address
+              )
+            )
+          end
+          attr_reader :address
+
+          sig do
+            params(
+              address:
+                Telnyx::Models::NumberLookupRetrieveResponse::Data::CallerIdentity::Address::OrHash
+            ).void
+          end
+          attr_writer :address
+
+          # How strongly the phone number is linked to the returned name, on a scale of 50
+          # to 90 (higher means more supporting signals). Reflects signal strength, not
+          # probability: 70 indicates stronger, more consistent evidence than 60, not a 70%
+          # chance of being correct. As a guide, 70+ is high confidence, 60 moderate, and 50
+          # limited. Below 50 no name is returned, so scores under 50 are never present.
+          sig { returns(T.nilable(Float)) }
+          attr_accessor :confidence_score
+
+          # A lookup-specific error code if the identity could not be resolved; otherwise
+          # null.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :error_code
+
+          # The name associated with the phone number.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :name
+
+          # Identity information for the phone number's owner, including name and postal
+          # address. Populated when `type=caller-identity` is requested.
+          sig do
+            params(
+              address:
+                Telnyx::Models::NumberLookupRetrieveResponse::Data::CallerIdentity::Address::OrHash,
+              confidence_score: T.nilable(Float),
+              error_code: T.nilable(String),
+              name: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Postal address associated with the phone number's owner.
+            address: nil,
+            # How strongly the phone number is linked to the returned name, on a scale of 50
+            # to 90 (higher means more supporting signals). Reflects signal strength, not
+            # probability: 70 indicates stronger, more consistent evidence than 60, not a 70%
+            # chance of being correct. As a guide, 70+ is high confidence, 60 moderate, and 50
+            # limited. Below 50 no name is returned, so scores under 50 are never present.
+            confidence_score: nil,
+            # A lookup-specific error code if the identity could not be resolved; otherwise
+            # null.
+            error_code: nil,
+            # The name associated with the phone number.
+            name: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                address:
+                  Telnyx::Models::NumberLookupRetrieveResponse::Data::CallerIdentity::Address,
+                confidence_score: T.nilable(Float),
+                error_code: T.nilable(String),
+                name: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Address < Telnyx::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Telnyx::Models::NumberLookupRetrieveResponse::Data::CallerIdentity::Address,
+                  Telnyx::Internal::AnyHash
+                )
+              end
+
+            # City.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :city
+
+            # Two-letter ISO 3166-1 country code.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :country_code
+
+            # Postal or ZIP code.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :postal_code
+
+            # Two-letter state or province code.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :state_code
+
+            # First line of the street address.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :street_line_1
+
+            # Second line of the street address, if any.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :street_line_2
+
+            # ZIP+4 extension, if available.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :zip4
+
+            # Postal address associated with the phone number's owner.
+            sig do
+              params(
+                city: T.nilable(String),
+                country_code: T.nilable(String),
+                postal_code: T.nilable(String),
+                state_code: T.nilable(String),
+                street_line_1: T.nilable(String),
+                street_line_2: T.nilable(String),
+                zip4: T.nilable(String)
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # City.
+              city: nil,
+              # Two-letter ISO 3166-1 country code.
+              country_code: nil,
+              # Postal or ZIP code.
+              postal_code: nil,
+              # Two-letter state or province code.
+              state_code: nil,
+              # First line of the street address.
+              street_line_1: nil,
+              # Second line of the street address, if any.
+              street_line_2: nil,
+              # ZIP+4 extension, if available.
+              zip4: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  city: T.nilable(String),
+                  country_code: T.nilable(String),
+                  postal_code: T.nilable(String),
+                  state_code: T.nilable(String),
+                  street_line_1: T.nilable(String),
+                  street_line_2: T.nilable(String),
+                  zip4: T.nilable(String)
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+
         class CallerName < Telnyx::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
@@ -425,6 +691,102 @@ module Telnyx
           end
         end
 
+        class EnhancedCallerName < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::NumberLookupRetrieveResponse::Data::EnhancedCallerName,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # The name associated with the phone number.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :caller_name
+
+          # A lookup-specific error code if the enhanced caller name could not be resolved;
+          # otherwise null.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :error_code
+
+          # Enhanced caller name for the phone number's owner. Populated when
+          # `type=enhanced-caller-name` is requested.
+          sig do
+            params(
+              caller_name: T.nilable(String),
+              error_code: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The name associated with the phone number.
+            caller_name: nil,
+            # A lookup-specific error code if the enhanced caller name could not be resolved;
+            # otherwise null.
+            error_code: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              { caller_name: T.nilable(String), error_code: T.nilable(String) }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class NnidOverride < Telnyx::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Telnyx::Models::NumberLookupRetrieveResponse::Data::NnidOverride,
+                Telnyx::Internal::AnyHash
+              )
+            end
+
+          # Name associated with the NNID.
+          sig { returns(T.nilable(String)) }
+          attr_reader :name
+
+          sig { params(name: String).void }
+          attr_writer :name
+
+          # The network number ID.
+          sig { returns(T.nilable(String)) }
+          attr_reader :nnid
+
+          sig { params(nnid: String).void }
+          attr_writer :nnid
+
+          # The NNID type.
+          sig { returns(T.nilable(String)) }
+          attr_reader :type
+
+          sig { params(type: String).void }
+          attr_writer :type
+
+          # Network number ID (NNID) override for the phone number, when one applies
+          # (available only to accounts enabled for NNID); otherwise null.
+          sig do
+            params(name: String, nnid: String, type: String).returns(
+              T.attached_class
+            )
+          end
+          def self.new(
+            # Name associated with the NNID.
+            name: nil,
+            # The network number ID.
+            nnid: nil,
+            # The NNID type.
+            type: nil
+          )
+          end
+
+          sig { override.returns({ name: String, nnid: String, type: String }) }
+          def to_hash
+          end
+        end
+
         class Portability < Telnyx::Internal::Type::BaseModel
           OrHash =
             T.type_alias do
@@ -464,11 +826,23 @@ module Telnyx
           sig { params(city: String).void }
           attr_writer :city
 
-          # Type of number
-          sig { returns(T.nilable(String)) }
+          # The line type of the phone number. Uses the same value set as carrier.type; see
+          # the API reference for the full list.
+          sig do
+            returns(
+              T.nilable(
+                Telnyx::Models::NumberLookupRetrieveResponse::Data::Portability::LineType::TaggedSymbol
+              )
+            )
+          end
           attr_reader :line_type
 
-          sig { params(line_type: String).void }
+          sig do
+            params(
+              line_type:
+                Telnyx::Models::NumberLookupRetrieveResponse::Data::Portability::LineType::OrSymbol
+            ).void
+          end
           attr_writer :line_type
 
           # Local Routing Number, if assigned to the requested phone number
@@ -544,7 +918,8 @@ module Telnyx
               altspid_carrier_name: String,
               altspid_carrier_type: String,
               city: String,
-              line_type: String,
+              line_type:
+                Telnyx::Models::NumberLookupRetrieveResponse::Data::Portability::LineType::OrSymbol,
               lrn: String,
               ocn: String,
               ported_date: String,
@@ -567,7 +942,8 @@ module Telnyx
             # City name extracted from the locality in the Local Exchange Routing Guide (LERG)
             # database
             city: nil,
-            # Type of number
+            # The line type of the phone number. Uses the same value set as carrier.type; see
+            # the API reference for the full list.
             line_type: nil,
             # Local Routing Number, if assigned to the requested phone number
             lrn: nil,
@@ -595,7 +971,8 @@ module Telnyx
                 altspid_carrier_name: String,
                 altspid_carrier_type: String,
                 city: String,
-                line_type: String,
+                line_type:
+                  Telnyx::Models::NumberLookupRetrieveResponse::Data::Portability::LineType::TaggedSymbol,
                 lrn: String,
                 ocn: String,
                 ported_date: String,
@@ -611,6 +988,92 @@ module Telnyx
           def to_hash
           end
 
+          # The line type of the phone number. Uses the same value set as carrier.type; see
+          # the API reference for the full list.
+          module LineType
+            extend Telnyx::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Telnyx::Models::NumberLookupRetrieveResponse::Data::Portability::LineType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            FIXED_LINE =
+              T.let(
+                :"fixed line",
+                Telnyx::Models::NumberLookupRetrieveResponse::Data::Portability::LineType::TaggedSymbol
+              )
+            MOBILE =
+              T.let(
+                :mobile,
+                Telnyx::Models::NumberLookupRetrieveResponse::Data::Portability::LineType::TaggedSymbol
+              )
+            VOIP =
+              T.let(
+                :voip,
+                Telnyx::Models::NumberLookupRetrieveResponse::Data::Portability::LineType::TaggedSymbol
+              )
+            FIXED_LINE_OR_MOBILE =
+              T.let(
+                :"fixed line or mobile",
+                Telnyx::Models::NumberLookupRetrieveResponse::Data::Portability::LineType::TaggedSymbol
+              )
+            TOLL_FREE =
+              T.let(
+                :"toll free",
+                Telnyx::Models::NumberLookupRetrieveResponse::Data::Portability::LineType::TaggedSymbol
+              )
+            PREMIUM_RATE =
+              T.let(
+                :"premium rate",
+                Telnyx::Models::NumberLookupRetrieveResponse::Data::Portability::LineType::TaggedSymbol
+              )
+            SHARED_COST =
+              T.let(
+                :"shared cost",
+                Telnyx::Models::NumberLookupRetrieveResponse::Data::Portability::LineType::TaggedSymbol
+              )
+            PERSONAL_NUMBER =
+              T.let(
+                :"personal number",
+                Telnyx::Models::NumberLookupRetrieveResponse::Data::Portability::LineType::TaggedSymbol
+              )
+            PAGER =
+              T.let(
+                :pager,
+                Telnyx::Models::NumberLookupRetrieveResponse::Data::Portability::LineType::TaggedSymbol
+              )
+            UAN =
+              T.let(
+                :uan,
+                Telnyx::Models::NumberLookupRetrieveResponse::Data::Portability::LineType::TaggedSymbol
+              )
+            VOICEMAIL =
+              T.let(
+                :voicemail,
+                Telnyx::Models::NumberLookupRetrieveResponse::Data::Portability::LineType::TaggedSymbol
+              )
+            UNKNOWN =
+              T.let(
+                :unknown,
+                Telnyx::Models::NumberLookupRetrieveResponse::Data::Portability::LineType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Telnyx::Models::NumberLookupRetrieveResponse::Data::Portability::LineType::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
           # Indicates whether or not the requested phone number has been ported
           module PortedStatus
             extend Telnyx::Internal::Type::Enum