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

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/lookups/v2/phone_number.rb

Instance Method Summary collapse

Constructor Details

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

Initialize the PhoneNumberInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this PhoneNumber resource.

  • sid (String) —

    The SID of the Call resource to fetch.



165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 165

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'],
        'live_activity' => payload['live_activity'],
        'line_type_intelligence' => payload['line_type_intelligence'],
        'identity_match' => payload['identity_match'],
        'sms_pumping_risk' => payload['sms_pumping_risk'],
        'url' => payload['url'],
    }

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

Instance Method Details

#call_forwarding ⇒ Hash

Returns An object that contains information on the unconditional call forwarding status of mobile phone number.

Returns:

  • (Hash) —

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



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

def call_forwarding
    @properties['call_forwarding']
end

#caller_name ⇒ Hash

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

Returns:



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

def caller_name
    @properties['caller_name']
end

#calling_country_code ⇒ String

Returns International dialing prefix of the phone number defined in the E.164 standard.

Returns:

  • (String) —

    International dialing prefix of the phone number defined in the E.164 standard.



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

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

Returns:



195
196
197
198
199
200
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 195

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

#country_code ⇒ String

Returns The phone number’s [ISO country code](en.wikipedia.org/wiki/ISO_3166-1_alpha-2).

Returns:



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

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) ⇒ PhoneNumberInstance

Fetch the PhoneNumberInstance

Parameters:

  • fields (String) (defaults to: :unset) —

    A comma-separated list of fields to return. Possible values are caller_name, sim_swap, call_forwarding, live_activity, line_type_intelligence, identity_match.

  • country_code (String) (defaults to: :unset) —

    The [country code](en.wikipedia.org/wiki/ISO_3166-1_alpha-2) used if the phone number provided is in national format.

  • first_name (String) (defaults to: :unset) —

    User’s first name. This query parameter is only used (optionally) for identity_match package requests.

  • last_name (String) (defaults to: :unset) —

    User’s last name. This query parameter is only used (optionally) for identity_match package requests.

  • address_line1 (String) (defaults to: :unset) —

    User’s first address line. This query parameter is only used (optionally) for identity_match package requests.

  • address_line2 (String) (defaults to: :unset) —

    User’s second address line. This query parameter is only used (optionally) for identity_match package requests.

  • city (String) (defaults to: :unset) —

    User’s city. This query parameter is only used (optionally) for identity_match package requests.

  • state (String) (defaults to: :unset) —

    User’s country subdivision, such as state, province, or locality. This query parameter is only used (optionally) for identity_match package requests.

  • postal_code (String) (defaults to: :unset) —

    User’s postal zip code. This query parameter is only used (optionally) for identity_match package requests.

  • address_country_code (String) (defaults to: :unset) —

    User’s country, up to two characters. This query parameter is only used (optionally) for identity_match package requests.

  • national_id (String) (defaults to: :unset) —

    User’s national ID, such as SSN or Passport ID. This query parameter is only used (optionally) for identity_match package requests.

  • date_of_birth (String) (defaults to: :unset) —

    User’s date of birth, in YYYYMMDD format. This query parameter is only used (optionally) for identity_match package requests.

Returns:



301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 301

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
)

    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, 
    )
end

#identity_match ⇒ Hash

Returns An object that contains identity match information. The result of comparing user-provided information including name, address, date of birth, national ID, against authoritative phone-based data sources.

Returns:

  • (Hash) —

    An object that contains identity match information. The result of comparing user-provided information including name, address, date of birth, national ID, against authoritative phone-based data sources



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

def identity_match
    @properties['identity_match']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



341
342
343
344
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 341

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

#line_type_intelligence ⇒ Hash

Returns An object that contains line type information including the carrier name, mobile country code, and mobile network code.

Returns:

  • (Hash) —

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



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

def line_type_intelligence
    @properties['line_type_intelligence']
end

#live_activity ⇒ Hash

Returns An object that contains live activity information for a mobile phone number.

Returns:

  • (Hash) —

    An object that contains live activity information for a mobile phone number.



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

def live_activity
    @properties['live_activity']
end

#national_format ⇒ String

Returns The phone number in [national format](en.wikipedia.org/wiki/National_conventions_for_writing_telephone_numbers).

Returns:



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

def national_format
    @properties['national_format']
end

#phone_number ⇒ String

Returns 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.

Returns:



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

def phone_number
    @properties['phone_number']
end

#sim_swap ⇒ Hash

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

Returns:

  • (Hash) —

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



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

def sim_swap
    @properties['sim_swap']
end

#sms_pumping_risk ⇒ Hash

Returns 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.

Returns:

  • (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.



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

def sms_pumping_risk
    @properties['sms_pumping_risk']
end

#to_s ⇒ Object

Provide a user friendly representation



334
335
336
337
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 334

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

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



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

def url
    @properties['url']
end

#valid ⇒ Boolean

Returns Boolean which indicates if the phone number is in a valid range that can be freely assigned by a carrier to a user.

Returns:

  • (Boolean) —

    Boolean which indicates if the phone number is in a valid range that can be freely assigned by a carrier to a user.



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

def valid
    @properties['valid']
end

#validation_errors ⇒ Array<ValidationError>

Returns Contains reasons why a phone number is invalid. Possible values: TOO_SHORT, TOO_LONG, INVALID_BUT_POSSIBLE, INVALID_COUNTRY_CODE, INVALID_LENGTH, NOT_A_NUMBER.

Returns:

  • (Array<ValidationError>) —

    Contains reasons why a phone number is invalid. Possible values: TOO_SHORT, TOO_LONG, INVALID_BUT_POSSIBLE, INVALID_COUNTRY_CODE, INVALID_LENGTH, NOT_A_NUMBER.



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

def validation_errors
    @properties['validation_errors']
end