Class: Twilio::REST::Api::V2010::AccountContext::AvailablePhoneNumberCountryContext::LocalInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/local.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, country_code: nil) ⇒ LocalInstance

Initialize the LocalInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The SID of the Account that created this Local resource.

  • sid (String) —

    The SID of the Call resource to fetch.



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/local.rb', line 278

def initialize(version, payload , account_sid: nil, country_code: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'friendly_name' => payload['friendly_name'],
        'phone_number' => payload['phone_number'],
        'lata' => payload['lata'],
        'locality' => payload['locality'],
        'rate_center' => payload['rate_center'],
        'latitude' => payload['latitude'],
        'longitude' => payload['longitude'],
        'region' => payload['region'],
        'postal_code' => payload['postal_code'],
        'iso_country' => payload['iso_country'],
        'address_requirements' => payload['address_requirements'],
        'beta' => payload['beta'],
        'capabilities' => payload['capabilities'],
    }
end

Instance Method Details

#address_requirements ⇒ String

Returns The type of [Address](www.twilio.com/docs/usage/api/address) resource the phone number requires. Can be: none, any, local, or foreign. none means no address is required. any means an address is required, but it can be anywhere in the world. local means an address in the phone number’s country is required. foreign means an address outside of the phone number’s country is required.

Returns:

  • (String) —

    The type of [Address](www.twilio.com/docs/usage/api/address) resource the phone number requires. Can be: none, any, local, or foreign. none means no address is required. any means an address is required, but it can be anywhere in the world. local means an address in the phone number’s country is required. foreign means an address outside of the phone number’s country is required.



362
363
364
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/local.rb', line 362

def address_requirements
    @properties['address_requirements']
end

#beta ⇒ Boolean

Returns Whether the phone number is new to the Twilio platform. Can be: true or false.

Returns:

  • (Boolean) —

    Whether the phone number is new to the Twilio platform. Can be: true or false.



368
369
370
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/local.rb', line 368

def beta
    @properties['beta']
end

#capabilities ⇒ ApiV2010AccountAvailablePhoneNumberCountryAvailablePhoneNumberLocalCapabilities

Returns:

  • (ApiV2010AccountAvailablePhoneNumberCountryAvailablePhoneNumberLocalCapabilities) 


374
375
376
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/local.rb', line 374

def capabilities
    @properties['capabilities']
end

#friendly_name ⇒ String

Returns A formatted version of the phone number.

Returns:

  • (String) —

    A formatted version of the phone number.



302
303
304
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/local.rb', line 302

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



386
387
388
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/local.rb', line 386

def inspect
    "<Twilio.Api.V2010.LocalInstance>"
end

#iso_country ⇒ String

Returns The [ISO country code](en.wikipedia.org/wiki/ISO_3166-1_alpha-2) of this phone number.

Returns:



356
357
358
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/local.rb', line 356

def iso_country
    @properties['iso_country']
end

#lata ⇒ String

Returns The [LATA](en.wikipedia.org/wiki/Local_access_and_transport_area) of this phone number. Available for only phone numbers from the US and Canada.

Returns:



314
315
316
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/local.rb', line 314

def lata
    @properties['lata']
end

#latitude ⇒ Float

Returns The latitude of this phone number’s location. Available for only phone numbers from the US and Canada.

Returns:

  • (Float) —

    The latitude of this phone number’s location. Available for only phone numbers from the US and Canada.



332
333
334
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/local.rb', line 332

def latitude
    @properties['latitude']
end

#locality ⇒ String

Returns The locality or city of this phone number’s location.

Returns:

  • (String) —

    The locality or city of this phone number’s location.



320
321
322
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/local.rb', line 320

def locality
    @properties['locality']
end

#longitude ⇒ Float

Returns The longitude of this phone number’s location. Available for only phone numbers from the US and Canada.

Returns:

  • (Float) —

    The longitude of this phone number’s location. Available for only phone numbers from the US and Canada.



338
339
340
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/local.rb', line 338

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



308
309
310
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/local.rb', line 308

def phone_number
    @properties['phone_number']
end

#postal_code ⇒ String

Returns The postal or ZIP code of this phone number’s location. Available for only phone numbers from the US and Canada.

Returns:

  • (String) —

    The postal or ZIP code of this phone number’s location. Available for only phone numbers from the US and Canada.



350
351
352
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/local.rb', line 350

def postal_code
    @properties['postal_code']
end

#rate_center ⇒ String

Returns The [rate center](en.wikipedia.org/wiki/Telephone_exchange) of this phone number. Available for only phone numbers from the US and Canada.

Returns:



326
327
328
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/local.rb', line 326

def rate_center
    @properties['rate_center']
end

#region ⇒ String

Returns The two-letter state or province abbreviation of this phone number’s location. Available for only phone numbers from the US and Canada.

Returns:

  • (String) —

    The two-letter state or province abbreviation of this phone number’s location. Available for only phone numbers from the US and Canada.



344
345
346
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/local.rb', line 344

def region
    @properties['region']
end

#to_s ⇒ Object

Provide a user friendly representation



380
381
382
 
# File 'lib/twilio-ruby/rest/api/v2010/account/available_phone_number_country/local.rb', line 380

def to_s
    "<Twilio.Api.V2010.LocalInstance>"
end