Class: Twilio::REST::Lookups::V2::PhoneNumberInstance

Inherits:

InstanceResource

Object
InstanceResource
Twilio::REST::Lookups::V2::PhoneNumberInstance

show all

Defined in:: lib/twilio-ruby/rest/lookups/v2/phone_number.rb

Instance Method Summary collapse

#call_forwarding ⇒ Hash

An object that contains information on the unconditional call forwarding status of mobile phone number.
#caller_name ⇒ Hash

An object that contains caller name information based on [CNAM](support.twilio.com/hc/en-us/articles/360051670533-Getting-Started-with-CNAM-Caller-ID).
#calling_country_code ⇒ String

International dialing prefix of the phone number defined in the E.164 standard.
#context ⇒ PhoneNumberContext

Generate an instance context for the instance, the context is capable of performing various actions.
#country_code ⇒ String

The phone number’s [ISO country code](en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
#fetch(fields: :unset, country_code: :unset, first_name: :unset, last_name: :unset, address_line1: :unset, address_line2: :unset, city: :unset, state: :unset, postal_code: :unset, address_country_code: :unset, national_id: :unset, date_of_birth: :unset, last_verified_date: :unset, verification_sid: :unset) ⇒ PhoneNumberInstance

Fetch the PhoneNumberInstance.
#identity_match ⇒ Hash

An object that contains identity match information.
#initialize(version, payload, phone_number: nil) ⇒ PhoneNumberInstance constructor

Initialize the PhoneNumberInstance.
#inspect ⇒ Object

Provide a detailed, user friendly representation.
#line_status ⇒ Hash

An object that contains line status information for a mobile phone number.
#line_type_intelligence ⇒ Hash

An object that contains line type information including the carrier name, mobile country code, and mobile network code.
#national_format ⇒ String

The phone number in [national format](en.wikipedia.org/wiki/National_conventions_for_writing_telephone_numbers).
#phone_number ⇒ String

The phone number in [E.164](www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.
#phone_number_quality_score ⇒ Hash

An object that contains information of a mobile phone number quality score.
#pre_fill ⇒ Hash

An object that contains pre fill information.
#reassigned_number ⇒ Hash

An object that contains reassigned number information.
#sim_swap ⇒ Hash

An object that contains information on the last date the subscriber identity module (SIM) was changed for a mobile phone number.
#sms_pumping_risk ⇒ Hash

An object that contains information on if a phone number has been currently or previously blocked by Verify Fraud Guard for receiving malicious SMS pumping traffic as well as other signals associated with risky carriers and low conversion rates.
#to_s ⇒ Object

Provide a user friendly representation.
#url ⇒ String

The absolute URL of the resource.
#valid ⇒ Boolean

Boolean which indicates if the phone number is in a valid range that can be freely assigned by a carrier to a user.
#validation_errors ⇒ Array<ValidationError>

Contains reasons why a phone number is invalid.

Constructor Details

#initialize(version, payload, phone_number: nil) ⇒ `PhoneNumberInstance`

Initialize the PhoneNumberInstance

# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 172

def initialize(version, payload , phone_number: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'calling_country_code' => payload['calling_country_code'],
        'country_code' => payload['country_code'],
        'phone_number' => payload['phone_number'],
        'national_format' => payload['national_format'],
        'valid' => payload['valid'],
        'validation_errors' => payload['validation_errors'],
        'caller_name' => payload['caller_name'],
        'sim_swap' => payload['sim_swap'],
        'call_forwarding' => payload['call_forwarding'],
        'line_status' => payload['line_status'],
        'line_type_intelligence' => payload['line_type_intelligence'],
        'identity_match' => payload['identity_match'],
        'reassigned_number' => payload['reassigned_number'],
        'sms_pumping_risk' => payload['sms_pumping_risk'],
        'phone_number_quality_score' => payload['phone_number_quality_score'],
        'pre_fill' => payload['pre_fill'],
        'url' => payload['url'],
    }

    # Context
    @instance_context = nil
    @params = { 'phone_number' => phone_number  || @properties['phone_number']  , }
end

Instance Method Details

#call_forwarding ⇒ `Hash`



262
263
264

# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 262

def call_forwarding
    @properties['call_forwarding']
end

#caller_name ⇒ `Hash`



250
251
252

# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 250

def caller_name
    @properties['caller_name']
end

#calling_country_code ⇒ `String`



214
215
216

# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 214

def calling_country_code
    @properties['calling_country_code']
end

#context ⇒ `PhoneNumberContext`

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 205

def context
    unless @instance_context
        @instance_context = PhoneNumberContext.new(@version , @params['phone_number'])
    end
    @instance_context
end

#country_code ⇒ `String`



220
221
222

# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 220

def country_code
    @properties['country_code']
end

#fetch(fields: :unset, country_code: :unset, first_name: :unset, last_name: :unset, address_line1: :unset, address_line2: :unset, city: :unset, state: :unset, postal_code: :unset, address_country_code: :unset, national_id: :unset, date_of_birth: :unset, last_verified_date: :unset, verification_sid: :unset) ⇒ `PhoneNumberInstance`

Fetch the PhoneNumberInstance

# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 331

def fetch(
    fields: :unset, 
    country_code: :unset, 
    first_name: :unset, 
    last_name: :unset, 
    address_line1: :unset, 
    address_line2: :unset, 
    city: :unset, 
    state: :unset, 
    postal_code: :unset, 
    address_country_code: :unset, 
    national_id: :unset, 
    date_of_birth: :unset, 
    last_verified_date: :unset, 
    verification_sid: :unset
)

    context.fetch(
        fields: fields, 
        country_code: country_code, 
        first_name: first_name, 
        last_name: last_name, 
        address_line1: address_line1, 
        address_line2: address_line2, 
        city: city, 
        state: state, 
        postal_code: postal_code, 
        address_country_code: address_country_code, 
        national_id: national_id, 
        date_of_birth: date_of_birth, 
        last_verified_date: last_verified_date, 
        verification_sid: verification_sid, 
    )
end

#identity_match ⇒ `Hash`



280
281
282

# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 280

def identity_match
    @properties['identity_match']
end

#inspect ⇒ `Object`

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 375

def inspect
    values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Lookups.V2.PhoneNumberInstance #{values}>"
end

#line_status ⇒ `Hash`



268
269
270

# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 268

def line_status
    @properties['line_status']
end

#line_type_intelligence ⇒ `Hash`



274
275
276

# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 274

def line_type_intelligence
    @properties['line_type_intelligence']
end

#national_format ⇒ `String`



232
233
234

# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 232

def national_format
    @properties['national_format']
end

#phone_number ⇒ `String`



226
227
228

# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 226

def phone_number
    @properties['phone_number']
end

#phone_number_quality_score ⇒ `Hash`



298
299
300

# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 298

def phone_number_quality_score
    @properties['phone_number_quality_score']
end

#pre_fill ⇒ `Hash`



304
305
306

# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 304

def pre_fill
    @properties['pre_fill']
end

#reassigned_number ⇒ `Hash`



286
287
288

# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 286

def reassigned_number
    @properties['reassigned_number']
end

#sim_swap ⇒ `Hash`



256
257
258

# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 256

def sim_swap
    @properties['sim_swap']
end

#sms_pumping_risk ⇒ `Hash`



292
293
294

# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 292

def sms_pumping_risk
    @properties['sms_pumping_risk']
end

#to_s ⇒ `Object`

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 368

def to_s
    values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
    "<Twilio.Lookups.V2.PhoneNumberInstance #{values}>"
end

#url ⇒ `String`



310
311
312

# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 310

def url
    @properties['url']
end

#valid ⇒ `Boolean`



238
239
240

# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 238

def valid
    @properties['valid']
end

#validation_errors ⇒ `Array<ValidationError>`



244
245
246

# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 244

def validation_errors
    @properties['validation_errors']
end

Class: Twilio::REST::Lookups::V2::PhoneNumberInstance

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, phone_number: nil) ⇒ PhoneNumberInstance

Instance Method Details

#call_forwarding ⇒ Hash

#caller_name ⇒ Hash

#calling_country_code ⇒ String

#context ⇒ PhoneNumberContext

#country_code ⇒ String

#identity_match ⇒ Hash

#inspect ⇒ Object

#line_status ⇒ Hash

#line_type_intelligence ⇒ Hash

#national_format ⇒ String

#phone_number ⇒ String

#phone_number_quality_score ⇒ Hash

#pre_fill ⇒ Hash

#reassigned_number ⇒ Hash

#sim_swap ⇒ Hash

#sms_pumping_risk ⇒ Hash

#to_s ⇒ Object

#url ⇒ String

#valid ⇒ Boolean

#validation_errors ⇒ Array<ValidationError>