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.



179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 179

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

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.



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

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:



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

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.



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

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:



212
213
214
215
216
217
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 212

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:



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

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, partner_sub_id: :unset) ⇒ PhoneNumberInstance

Fetch the PhoneNumberInstance

Parameters:

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

    A comma-separated list of fields to return. Possible values are validation, caller_name, sim_swap, call_forwarding, line_status, line_type_intelligence, identity_match, reassigned_number, sms_pumping_risk, phone_number_quality_score, pre_fill.

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

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

    The date you obtained consent to call or text the end-user of the phone number or a date on which you are reasonably certain that the end-user could still be reached at that number. This query parameter is only used (optionally) for reassigned_number package requests.

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

    The unique identifier associated with a verification process through verify API. This query parameter is only used (optionally) for pre_fill package requests.

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

    The optional partnerSubId parameter to provide context for your sub-accounts, tenantIDs, sender IDs or other segmentation, enhancing the accuracy of the risk analysis.

Returns:



339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 339

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, 
    partner_sub_id: :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, 
        partner_sub_id: partner_sub_id, 
    )
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



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

def identity_match
    @properties['identity_match']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



385
386
387
388
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 385

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

#line_status ⇒ Hash

Returns An object that contains line status information for a mobile phone number.

Returns:

  • (Hash) —

    An object that contains line status information for a mobile phone number.



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

def line_status
    @properties['line_status']
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.



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

def line_type_intelligence
    @properties['line_type_intelligence']
end

#national_format ⇒ String

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

Returns:



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

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:



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

def phone_number
    @properties['phone_number']
end

#phone_number_quality_score ⇒ Hash

Returns An object that contains information of a mobile phone number quality score. Quality score will return a risk score about the phone number.

Returns:

  • (Hash) —

    An object that contains information of a mobile phone number quality score. Quality score will return a risk score about the phone number.



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

def phone_number_quality_score
    @properties['phone_number_quality_score']
end

#pre_fill ⇒ Hash

Returns An object that contains pre fill information. pre_fill will return PII information associated with the phone number like first name, last name, address line, country code, state and postal code.

Returns:

  • (Hash) —

    An object that contains pre fill information. pre_fill will return PII information associated with the phone number like first name, last name, address line, country code, state and postal code.



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

def pre_fill
    @properties['pre_fill']
end

#reassigned_number ⇒ Hash

Returns An object that contains reassigned number information. Reassigned Numbers will return a phone number’s reassignment status given a phone number and date.

Returns:

  • (Hash) —

    An object that contains reassigned number information. Reassigned Numbers will return a phone number’s reassignment status given a phone number and date



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

def reassigned_number
    @properties['reassigned_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.



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

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.



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

def sms_pumping_risk
    @properties['sms_pumping_risk']
end

#to_s ⇒ Object

Provide a user friendly representation



378
379
380
381
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 378

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.



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

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.



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

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.



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

def validation_errors
    @properties['validation_errors']
end