Class: Twilio::REST::Lookups::V1::PhoneNumberContext

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

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](www.twilio.com/docs/glossary/what-e164) format, which consists of a + followed by the country code and subscriber number.



69
70
71
72
73
74
75
 
# File 'lib/twilio-ruby/rest/lookups/v1/phone_number.rb', line 69

def initialize(version, phone_number)
  super(version)

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

Instance Method Details

#fetch(country_code: :unset, type: :unset, add_ons: :unset, add_ons_data: :unset) ⇒ PhoneNumberInstance

Fetch a PhoneNumberInstance

Parameters:

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

    The [ISO country code](en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of the phone number to fetch. This is used to specify the country when the phone number is provided in a national format.

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

    The type of information to return. Can be: ‘carrier` or `caller-name`. The default is null. Carrier information costs $0.005 per phone number looked up. Caller Name information is currently available only in the US and costs $0.01 per phone number looked up. To retrieve both types on information, specify this parameter twice; once with `carrier` and once with `caller-name` as the value.

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

    The ‘unique_name` of an Add-on you would like to invoke. Can be the `unique_name` of an Add-on that is installed on your account. You can specify multiple instances of this parameter to invoke multiple Add-ons. For more information about Add-ons, see the [Add-ons documentation](www.twilio.com/docs/api/addons).

  • add_ons_data (Hash) (defaults to: :unset) —

    Data specific to the add-on you would like to invoke. The content and format of this value depends on the add-on.

Returns:



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
 
# File 'lib/twilio-ruby/rest/lookups/v1/phone_number.rb', line 97

def fetch(country_code: :unset, type: :unset, add_ons: :unset, add_ons_data: :unset)
  params = Twilio::Values.of({
      'CountryCode' => country_code,
      'Type' => Twilio.serialize_list(type) { |e| e },
      'AddOns' => Twilio.serialize_list(add_ons) { |e| e },
  })

  params.merge!(Twilio.prefixed_collapsible_map(add_ons_data, 'AddOns'))
  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



123
124
125
126
 
# File 'lib/twilio-ruby/rest/lookups/v1/phone_number.rb', line 123

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

#to_s ⇒ Object

Provide a user friendly representation



116
117
118
119
 
# File 'lib/twilio-ruby/rest/lookups/v1/phone_number.rb', line 116

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