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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: 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 unique id of the [Account](www.twilio.com/docs/iam/api/account) responsible for this phone number.



288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 288

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

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'address_sid' => payload['address_sid'],
      'address_requirements' => payload['address_requirements'],
      'api_version' => payload['api_version'],
      'beta' => payload['beta'],
      'capabilities' => payload['capabilities'],
      'date_created' => Twilio.deserialize_rfc2822(payload['date_created']),
      'date_updated' => Twilio.deserialize_rfc2822(payload['date_updated']),
      'friendly_name' => payload['friendly_name'],
      'identity_sid' => payload['identity_sid'],
      'phone_number' => payload['phone_number'],
      'origin' => payload['origin'],
      'sid' => payload['sid'],
      'sms_application_sid' => payload['sms_application_sid'],
      'sms_fallback_method' => payload['sms_fallback_method'],
      'sms_fallback_url' => payload['sms_fallback_url'],
      'sms_method' => payload['sms_method'],
      'sms_url' => payload['sms_url'],
      'status_callback' => payload['status_callback'],
      'status_callback_method' => payload['status_callback_method'],
      'trunk_sid' => payload['trunk_sid'],
      'uri' => payload['uri'],
      'voice_application_sid' => payload['voice_application_sid'],
      'voice_caller_id_lookup' => payload['voice_caller_id_lookup'],
      'voice_fallback_method' => payload['voice_fallback_method'],
      'voice_fallback_url' => payload['voice_fallback_url'],
      'voice_method' => payload['voice_method'],
      'voice_url' => payload['voice_url'],
  }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique id of the Account responsible for this phone number.

Returns:

  • (String) —

    The unique id of the Account responsible for this phone number.



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

def 
  @properties['account_sid']
end

#address_requirements ⇒ local.AddressRequirement

Returns This indicates whether the phone number requires you or your customer to have an Address registered with Twilio.

Returns:

  • (local.AddressRequirement) —

    This indicates whether the phone number requires you or your customer to have an Address registered with Twilio.



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

def address_requirements
  @properties['address_requirements']
end

#address_sid ⇒ String

Returns The 34 character sid of the address associated with this number.

Returns:

  • (String) —

    The 34 character sid of the address associated with this number.



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

def address_sid
  @properties['address_sid']
end

#api_version ⇒ String

Returns Calls to this phone number will start a new TwiML session with this API version.

Returns:

  • (String) —

    Calls to this phone number will start a new TwiML session with this API version.



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

def api_version
  @properties['api_version']
end

#beta ⇒ Boolean

Returns Phone numbers new to the Twilio platform are marked as beta.

Returns:

  • (Boolean) —

    Phone numbers new to the Twilio platform are marked as beta.



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

def beta
  @properties['beta']
end

#capabilities ⇒ String

Returns This is a set of boolean properties that indicate whether a phone number can receive calls or messages.

Returns:

  • (String) —

    This is a set of boolean properties that indicate whether a phone number can receive calls or messages.



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

def capabilities
  @properties['capabilities']
end

#date_created ⇒ Time

Returns The date that this resource was created, given as GMT RFC 2822 format.

Returns:

  • (Time) —

    The date that this resource was created, given as GMT RFC 2822 format.



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this resource was last updated, given as GMT RFC 2822 format.

Returns:

  • (Time) —

    The date that this resource was last updated, given as GMT RFC 2822 format.



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

def date_updated
  @properties['date_updated']
end

#friendly_name ⇒ String

Returns A human readable descriptive text for this resource, up to 64 characters long.

Returns:

  • (String) —

    A human readable descriptive text for this resource, up to 64 characters long.



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

def friendly_name
  @properties['friendly_name']
end

#identity_sid ⇒ String

Returns The identity_sid.

Returns:

  • (String) —

    The identity_sid



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

def identity_sid
  @properties['identity_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



500
501
502
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 500

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

#origin ⇒ String

Returns Twilio owned phone numbers are marked as twilio while hosted phone numbers are marked as hosted.

Returns:

  • (String) —

    Twilio owned phone numbers are marked as twilio while hosted phone numbers are marked as hosted.



392
393
394
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 392

def origin
  @properties['origin']
end

#phone_number ⇒ String

Returns The incoming phone number.

Returns:

  • (String) —

    The incoming phone number.



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

def phone_number
  @properties['phone_number']
end

#sid ⇒ String

Returns A 34 character string that uniquely identifies this resource.

Returns:

  • (String) —

    A 34 character string that uniquely identifies this resource.



398
399
400
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 398

def sid
  @properties['sid']
end

#sms_application_sid ⇒ String

Returns The 34 character sid of the application Twilio should use to handle SMSs sent to this number.

Returns:

  • (String) —

    The 34 character sid of the application Twilio should use to handle SMSs sent to this number.



404
405
406
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 404

def sms_application_sid
  @properties['sms_application_sid']
end

#sms_fallback_method ⇒ String

Returns The HTTP method Twilio will use when requesting the above URL.

Returns:

  • (String) —

    The HTTP method Twilio will use when requesting the above URL.



410
411
412
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 410

def sms_fallback_method
  @properties['sms_fallback_method']
end

#sms_fallback_url ⇒ String

Returns The URL that Twilio will request if an error occurs retrieving or executing the TwiML from SmsUrl.

Returns:

  • (String) —

    The URL that Twilio will request if an error occurs retrieving or executing the TwiML from SmsUrl.



416
417
418
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 416

def sms_fallback_url
  @properties['sms_fallback_url']
end

#sms_method ⇒ String

Returns The HTTP method Twilio will use when making requests to the SmsUrl.

Returns:

  • (String) —

    The HTTP method Twilio will use when making requests to the SmsUrl.



422
423
424
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 422

def sms_method
  @properties['sms_method']
end

#sms_url ⇒ String

Returns The URL Twilio will request when receiving an incoming SMS message to this number.

Returns:

  • (String) —

    The URL Twilio will request when receiving an incoming SMS message to this number.



428
429
430
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 428

def sms_url
  @properties['sms_url']
end

#status_callback ⇒ String

Returns The URL that Twilio will request to pass status parameters to your application.

Returns:

  • (String) —

    The URL that Twilio will request to pass status parameters to your application.



434
435
436
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 434

def status_callback
  @properties['status_callback']
end

#status_callback_method ⇒ String

Returns The HTTP method Twilio will use to make requests to the StatusCallback URL.

Returns:

  • (String) —

    The HTTP method Twilio will use to make requests to the StatusCallback URL.



440
441
442
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 440

def status_callback_method
  @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



494
495
496
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 494

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

#trunk_sid ⇒ String

Returns The 34 character sid of the Trunk Twilio should use to handle phone calls to this number.

Returns:

  • (String) —

    The 34 character sid of the Trunk Twilio should use to handle phone calls to this number.



446
447
448
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 446

def trunk_sid
  @properties['trunk_sid']
end

#uri ⇒ String

Returns The URI for this resource, relative to api.

Returns:

  • (String) —

    The URI for this resource, relative to api.



452
453
454
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 452

def uri
  @properties['uri']
end

#voice_application_sid ⇒ String

Returns The 34 character sid of the application Twilio should use to handle phone calls to this number.

Returns:

  • (String) —

    The 34 character sid of the application Twilio should use to handle phone calls to this number.



458
459
460
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 458

def voice_application_sid
  @properties['voice_application_sid']
end

#voice_caller_id_lookup ⇒ Boolean

Returns Look up the caller’s caller-ID name from the CNAM database.

Returns:

  • (Boolean) —

    Look up the caller’s caller-ID name from the CNAM database.



464
465
466
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 464

def voice_caller_id_lookup
  @properties['voice_caller_id_lookup']
end

#voice_fallback_method ⇒ String

Returns The HTTP method Twilio will use when requesting the VoiceFallbackUrl.

Returns:

  • (String) —

    The HTTP method Twilio will use when requesting the VoiceFallbackUrl.



470
471
472
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 470

def voice_fallback_method
  @properties['voice_fallback_method']
end

#voice_fallback_url ⇒ String

Returns The URL that Twilio will request if an error occurs retrieving or executing the TwiML requested by Url.

Returns:

  • (String) —

    The URL that Twilio will request if an error occurs retrieving or executing the TwiML requested by Url.



476
477
478
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 476

def voice_fallback_url
  @properties['voice_fallback_url']
end

#voice_method ⇒ String

Returns The HTTP method Twilio will use when requesting the above Url.

Returns:

  • (String) —

    The HTTP method Twilio will use when requesting the above Url.



482
483
484
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 482

def voice_method
  @properties['voice_method']
end

#voice_url ⇒ String

Returns The URL Twilio will request when this phone number receives a call.

Returns:

  • (String) —

    The URL Twilio will request when this phone number receives a call.



488
489
490
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/local.rb', line 488

def voice_url
  @properties['voice_url']
end