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

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Lookups::V1::PhoneNumberInstance

Defined in:

lib/twilio-ruby/rest/lookups/v1/phone_number.rb

Instance Method Summary

• #add_ons ⇒ Hash

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

• #caller_name ⇒ String

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

• #carrier ⇒ String

  The carrier.

• #context ⇒ PhoneNumberContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #country_code ⇒ String

  The ISO country code for the phone number.

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

  Fetch a PhoneNumberInstance.

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

  Initialize the PhoneNumberInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #national_format ⇒ String

  The phone number, in national format.

• #phone_number ⇒ String

  The phone number, in E.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #url ⇒ String

  The url.

Constructor Details

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

Initialize the PhoneNumberInstance

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

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

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

def add_ons
  @properties['add_ons']
end

#caller_name ⇒ String

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

def caller_name
  @properties['caller_name']
end

#carrier ⇒ String

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

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

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

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

#country_code ⇒ String

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

def country_code
  @properties['country_code']
end

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

Fetch a PhoneNumberInstance

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

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

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

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

#national_format ⇒ String

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

def national_format
  @properties['national_format']
end

#phone_number ⇒ String

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

def phone_number
  @properties['phone_number']
end

#to_s ⇒ Object

Provide a user friendly representation

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

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

#url ⇒ String

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

def url
  @properties['url']
end