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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil) ⇒ TollFreeInstance

Initialize the TollFreeInstance

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 IncomingPhoneNumber resource.


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
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 297

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_receive_mode' => payload['voice_receive_mode'],
      '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'],
      'emergency_status' => payload['emergency_status'],
      'emergency_address_sid' => payload['emergency_address_sid'],
      'emergency_address_status' => payload['emergency_address_status'],
      'bundle_sid' => payload['bundle_sid'],
      'status' => payload['status'],
  }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource


341
342
343
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 341

def 
  @properties['account_sid']
end

#address_requirements ⇒ toll_free.AddressRequirement

Returns Whether the phone number requires an Address registered with Twilio.

Returns:

  • (toll_free.AddressRequirement) —

    Whether the phone number requires an Address registered with Twilio.


353
354
355
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 353

def address_requirements
  @properties['address_requirements']
end

#address_sid ⇒ String

Returns The SID of the Address resource associated with the phone number.

Returns:

  • (String) —

    The SID of the Address resource associated with the phone number


347
348
349
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 347

def address_sid
  @properties['address_sid']
end

#api_version ⇒ String

Returns The API version used to start a new TwiML session.

Returns:

  • (String) —

    The API version used to start a new TwiML session


359
360
361
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 359

def api_version
  @properties['api_version']
end

#beta ⇒ Boolean

Returns Whether the phone number is new to the Twilio platform.

Returns:

  • (Boolean) —

    Whether the phone number is new to the Twilio platform


365
366
367
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 365

def beta
  @properties['beta']
end

#bundle_sid ⇒ String

Returns The SID of the Bundle resource associated with number.

Returns:

  • (String) —

    The SID of the Bundle resource associated with number


533
534
535
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 533

def bundle_sid
  @properties['bundle_sid']
end

#capabilities ⇒ String

Returns Indicate if a phone can receive calls or messages.

Returns:

  • (String) —

    Indicate if a phone can receive calls or messages


371
372
373
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 371

def capabilities
  @properties['capabilities']
end

#date_created ⇒ Time

Returns The RFC 2822 date and time in GMT that the resource was created.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT that the resource was created


377
378
379
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 377

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The RFC 2822 date and time in GMT that the resource was last updated.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT that the resource was last updated


383
384
385
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 383

def date_updated
  @properties['date_updated']
end

#emergency_address_sid ⇒ String

Returns The emergency address configuration to use for emergency calling.

Returns:

  • (String) —

    The emergency address configuration to use for emergency calling


521
522
523
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 521

def emergency_address_sid
  @properties['emergency_address_sid']
end

#emergency_address_status ⇒ toll_free.EmergencyAddressStatus

Returns State of the emergency address configuration for the phone number.

Returns:

  • (toll_free.EmergencyAddressStatus) —

    State of the emergency address configuration for the phone number


527
528
529
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 527

def emergency_address_status
  @properties['emergency_address_status']
end

#emergency_status ⇒ toll_free.EmergencyStatus

Returns Displays if emergency calling is enabled for this number.

Returns:

  • (toll_free.EmergencyStatus) —

    Displays if emergency calling is enabled for this number.


515
516
517
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 515

def emergency_status
  @properties['emergency_status']
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource


389
390
391
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 389

def friendly_name
  @properties['friendly_name']
end

#identity_sid ⇒ String

Returns The SID of the Identity resource associated with number.

Returns:

  • (String) —

    The SID of the Identity resource associated with number


395
396
397
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 395

def identity_sid
  @properties['identity_sid']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


551
552
553
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 551

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

#origin ⇒ String

Returns The phone number's origin. Can be twilio or hosted.

Returns:

  • (String) —

    The phone number's origin. Can be twilio or hosted.


407
408
409
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 407

def origin
  @properties['origin']
end

#phone_number ⇒ String

Returns The phone number in E.164 format.

Returns:

  • (String) —

    The phone number in E.164 format


401
402
403
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 401

def phone_number
  @properties['phone_number']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource


413
414
415
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 413

def sid
  @properties['sid']
end

#sms_application_sid ⇒ String

Returns The SID of the application that handles SMS messages sent to the phone number.

Returns:

  • (String) —

    The SID of the application that handles SMS messages sent to the phone number


419
420
421
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 419

def sms_application_sid
  @properties['sms_application_sid']
end

#sms_fallback_method ⇒ String

Returns The HTTP method used with sms_fallback_url.

Returns:

  • (String) —

    The HTTP method used with sms_fallback_url


425
426
427
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 425

def sms_fallback_method
  @properties['sms_fallback_method']
end

#sms_fallback_url ⇒ String

Returns The URL that we call when an error occurs while retrieving or executing the TwiML.

Returns:

  • (String) —

    The URL that we call when an error occurs while retrieving or executing the TwiML


431
432
433
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 431

def sms_fallback_url
  @properties['sms_fallback_url']
end

#sms_method ⇒ String

Returns The HTTP method to use with sms_url.

Returns:

  • (String) —

    The HTTP method to use with sms_url


437
438
439
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 437

def sms_method
  @properties['sms_method']
end

#sms_url ⇒ String

Returns The URL we call when the phone number receives an incoming SMS message.

Returns:

  • (String) —

    The URL we call when the phone number receives an incoming SMS message


443
444
445
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 443

def sms_url
  @properties['sms_url']
end

#status ⇒ String

Returns The status.

Returns:

  • (String) —

    The status


539
540
541
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 539

def status
  @properties['status']
end

#status_callback ⇒ String

Returns The URL to send status information to your application.

Returns:

  • (String) —

    The URL to send status information to your application


449
450
451
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 449

def status_callback
  @properties['status_callback']
end

#status_callback_method ⇒ String

Returns The HTTP method we use to call status_callback.

Returns:

  • (String) —

    The HTTP method we use to call status_callback


455
456
457
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 455

def status_callback_method
  @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation


545
546
547
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 545

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

#trunk_sid ⇒ String

Returns The SID of the Trunk that handles calls to the phone number.

Returns:

  • (String) —

    The SID of the Trunk that handles calls to the phone number


461
462
463
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 461

def trunk_sid
  @properties['trunk_sid']
end

#uri ⇒ String

Returns The URI of the resource, relative to `api.twilio.com`.

Returns:


467
468
469
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 467

def uri
  @properties['uri']
end

#voice_application_sid ⇒ String

Returns The SID of the application that handles calls to the phone number.

Returns:

  • (String) —

    The SID of the application that handles calls to the phone number


479
480
481
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 479

def voice_application_sid
  @properties['voice_application_sid']
end

#voice_caller_id_lookup ⇒ Boolean

Returns Whether to lookup the caller's name.

Returns:

  • (Boolean) —

    Whether to lookup the caller's name


485
486
487
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 485

def voice_caller_id_lookup
  @properties['voice_caller_id_lookup']
end

#voice_fallback_method ⇒ String

Returns The HTTP method used with voice_fallback_url.

Returns:

  • (String) —

    The HTTP method used with voice_fallback_url


491
492
493
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 491

def voice_fallback_method
  @properties['voice_fallback_method']
end

#voice_fallback_url ⇒ String

Returns The URL we call when an error occurs in TwiML.

Returns:

  • (String) —

    The URL we call when an error occurs in TwiML


497
498
499
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 497

def voice_fallback_url
  @properties['voice_fallback_url']
end

#voice_method ⇒ String

Returns The HTTP method used with the voice_url.

Returns:

  • (String) —

    The HTTP method used with the voice_url


503
504
505
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 503

def voice_method
  @properties['voice_method']
end

#voice_receive_mode ⇒ toll_free.VoiceReceiveMode

Returns The voice_receive_mode.

Returns:

  • (toll_free.VoiceReceiveMode) —

    The voice_receive_mode


473
474
475
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 473

def voice_receive_mode
  @properties['voice_receive_mode']
end

#voice_url ⇒ String

Returns The URL we call when the phone number receives a call.

Returns:

  • (String) —

    The URL we call when the phone number receives a call


509
510
511
 
# File 'lib/twilio-ruby/rest/api/v2010/account/incoming_phone_number/toll_free.rb', line 509

def voice_url
  @properties['voice_url']
end