Class: Twilio::REST::Lookups::V1::PhoneNumberInstance

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/lookups/v1/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

  • phone_number (String) (defaults to: nil) —

    The phone_number



125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/twilio-ruby/rest/lookups/v1/phone_number.rb', line 125

def initialize(version, payload, phone_number: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'caller_name' => payload['caller_name'],
      'country_code' => payload['country_code'],
      'phone_number' => payload['phone_number'],
      'national_format' => payload['national_format'],
      'carrier' => payload['carrier'],
      'add_ons' => payload['add_ons'],
      'url' => payload['url'],
  }

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

Instance Method Details

#add_ons ⇒ Hash

Returns Results of any Add-ons you have specified using the AddOn parameter in the request, as a JSON dictionary.

Returns:

  • (Hash) —

    Results of any Add-ons you have specified using the AddOn parameter in the request, as a JSON dictionary.



187
188
189
 
# File 'lib/twilio-ruby/rest/lookups/v1/phone_number.rb', line 187

def add_ons
  @properties['add_ons']
end

#caller_name ⇒ String

Returns String indicating the name of the owner of the phone number.

Returns:

  • (String) —

    String indicating the name of the owner of the phone number.



157
158
159
 
# File 'lib/twilio-ruby/rest/lookups/v1/phone_number.rb', line 157

def caller_name
  @properties['caller_name']
end

#carrier ⇒ String

Returns The carrier.

Returns:

  • (String) —

    The carrier



181
182
183
 
# File 'lib/twilio-ruby/rest/lookups/v1/phone_number.rb', line 181

def carrier
  @properties['carrier']
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:



148
149
150
151
152
153
 
# File 'lib/twilio-ruby/rest/lookups/v1/phone_number.rb', line 148

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

#country_code ⇒ String

Returns The ISO country code for the phone number.

Returns:

  • (String) —

    The ISO country code for the phone number.



163
164
165
 
# File 'lib/twilio-ruby/rest/lookups/v1/phone_number.rb', line 163

def country_code
  @properties['country_code']
end

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

Fetch a PhoneNumberInstance

Parameters:

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

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

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

    Indicates the type of information you would like returned with your request. Possible values are ‘carrier` or `caller-name`. If not specified, the default is null. Carrier information costs $0.005 per phone number looked up. Caller Name information costs $0.01 per phone number looked up, and is currently ONLY available in the US. You can retrieve both types of information by including two `Type` arguments or making two separate requests.

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

    Indicates the particular Add-on you would like to use to get more information. Possible values are the *Add-on Unique Names* of Add-ons installed on your account. You can specify multiple instances of this parameter to invoke different Add-ons. See [Add-ons documentation](www.twilio.com/docs/api/addons) for information on installing Add-ons. Add-on pricing is available in your list of Installed Add-ons in the Console.

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

    The add_ons_data

Returns:



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

def fetch(country_code: :unset, type: :unset, add_ons: :unset, add_ons_data: :unset)
  context.fetch(country_code: country_code, type: type, add_ons: add_ons, add_ons_data: add_ons_data, )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



230
231
232
233
 
# File 'lib/twilio-ruby/rest/lookups/v1/phone_number.rb', line 230

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

#national_format ⇒ String

Returns The phone number, in national format.

Returns:

  • (String) —

    The phone number, in national format.



175
176
177
 
# File 'lib/twilio-ruby/rest/lookups/v1/phone_number.rb', line 175

def national_format
  @properties['national_format']
end

#phone_number ⇒ String

Returns The phone number, in E.

Returns:

  • (String) —

    The phone number, in E.



169
170
171
 
# File 'lib/twilio-ruby/rest/lookups/v1/phone_number.rb', line 169

def phone_number
  @properties['phone_number']
end

#to_s ⇒ Object

Provide a user friendly representation



223
224
225
226
 
# File 'lib/twilio-ruby/rest/lookups/v1/phone_number.rb', line 223

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

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



193
194
195
 
# File 'lib/twilio-ruby/rest/lookups/v1/phone_number.rb', line 193

def url
  @properties['url']
end