Class: Twilio::REST::Lookups::V2::PhoneNumberContext

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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

#initialize(version, phone_number) ⇒ PhoneNumberContext

Initialize the PhoneNumberContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • phone_number (String) —

    The phone number to lookup in E.164 or national format. Default country code is +1 (North America).



74
75
76
77
78
79
80
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 74

def initialize(version, phone_number)
  super(version)

  # Path Solution
  @solution = {phone_number: phone_number, }
  @uri = "/PhoneNumbers/#{@solution[:phone_number]}"
end

Instance Method Details

#fetch(fields: :unset, country_code: :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.

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

    The country code used if the phone number provided is in national format.

Returns:



91
92
93
94
95
96
97
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 91

def fetch(fields: :unset, country_code: :unset)
  params = Twilio::Values.of({'Fields' => fields, 'CountryCode' => country_code, })

  payload = @version.fetch('GET', @uri, params: params)

  PhoneNumberInstance.new(@version, payload, phone_number: @solution[:phone_number], )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



108
109
110
111
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 108

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Lookups.V2.PhoneNumberContext #{context}>"
end

#to_s ⇒ Object

Provide a user friendly representation



101
102
103
104
 
# File 'lib/twilio-ruby/rest/lookups/v2/phone_number.rb', line 101

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Lookups.V2.PhoneNumberContext #{context}>"
end