Class: Twilio::REST::Api::V2010::AccountContext::AddressContext::DependentPhoneNumberInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, account_sid: nil, address_sid: nil) ⇒ DependentPhoneNumberInstance

Initialize the DependentPhoneNumberInstance

Parameters:

  • Version that contains the resource

  • payload that contains response from Twilio

  • (defaults to: nil)

    The SID of the Account that created this DependentPhoneNumber resource.

  • The SID of the Call resource to fetch.



254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 254

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

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the DependentPhoneNumber resource.

Returns:



298
299
300
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 298

def 
    @properties['account_sid']
end

#address_requirements ⇒ AddressRequirement

Returns:



382
383
384
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 382

def address_requirements
    @properties['address_requirements']
end

#api_version ⇒ String

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

Returns:

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



406
407
408
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 406

def api_version
    @properties['api_version']
end

#capabilities ⇒ Hash

Returns The set of Boolean properties that indicates whether a phone number can receive calls or messages. Capabilities are Voice, SMS, and MMS and each capability can be: true or false.

Returns:

  • The set of Boolean properties that indicates whether a phone number can receive calls or messages. Capabilities are Voice, SMS, and MMS and each capability can be: true or false.



388
389
390
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 388

def capabilities
    @properties['capabilities']
end

#date_created ⇒ Time

Returns The date and time in GMT that the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



346
347
348
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 346

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT that the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



352
353
354
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 352

def date_updated
    @properties['date_updated']
end

#emergency_address_sid ⇒ String

Returns The SID of the emergency address configuration that we use for emergency calling from the phone number.

Returns:

  • The SID of the emergency address configuration that we use for emergency calling from the phone number.



436
437
438
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 436

def emergency_address_sid
    @properties['emergency_address_sid']
end

#emergency_status ⇒ EmergencyStatus

Returns:



430
431
432
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 430

def emergency_status
    @properties['emergency_status']
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • The string that you assigned to describe the resource.



304
305
306
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 304

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



454
455
456
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 454

def inspect
    "<Twilio.Api.V2010.DependentPhoneNumberInstance>"
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:



310
311
312
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 310

def phone_number
    @properties['phone_number']
end

#sid ⇒ String

Returns The unique string that that we created to identify the DependentPhoneNumber resource.

Returns:

  • The unique string that that we created to identify the DependentPhoneNumber resource.



292
293
294
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 292

def sid
    @properties['sid']
end

#sms_application_sid ⇒ String

Returns The SID of the application that handles SMS messages sent to the phone number. If an sms_application_sid is present, we ignore all ‘sms_*_url` values and use those of the application.

Returns:

  • The SID of the application that handles SMS messages sent to the phone number. If an sms_application_sid is present, we ignore all ‘sms_*_url` values and use those of the application.



412
413
414
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 412

def sms_application_sid
    @properties['sms_application_sid']
end

#sms_fallback_method ⇒ String

Returns The HTTP method we use to call sms_fallback_url. Can be: GET or POST.

Returns:

  • The HTTP method we use to call sms_fallback_url. Can be: GET or POST.



358
359
360
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 358

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 from sms_url.

Returns:

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



364
365
366
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 364

def sms_fallback_url
    @properties['sms_fallback_url']
end

#sms_method ⇒ String

Returns The HTTP method we use to call sms_url. Can be: GET or POST.

Returns:

  • The HTTP method we use to call sms_url. Can be: GET or POST.



370
371
372
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 370

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:

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



376
377
378
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 376

def sms_url
    @properties['sms_url']
end

#status_callback ⇒ String

Returns The URL we call using the status_callback_method to send status information to your application.

Returns:

  • The URL we call using the status_callback_method to send status information to your application.



394
395
396
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 394

def status_callback
    @properties['status_callback']
end

#status_callback_method ⇒ String

Returns The HTTP method we use to call status_callback. Can be: GET or POST.

Returns:

  • The HTTP method we use to call status_callback. Can be: GET or POST.



400
401
402
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 400

def status_callback_method
    @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



448
449
450
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 448

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

#trunk_sid ⇒ String

Returns The SID of the Trunk that handles calls to the phone number. If a trunk_sid is present, we ignore all of the voice urls and voice applications and use those set on the Trunk. Setting a trunk_sid will automatically delete your voice_application_sid and vice versa.

Returns:

  • The SID of the Trunk that handles calls to the phone number. If a trunk_sid is present, we ignore all of the voice urls and voice applications and use those set on the Trunk. Setting a trunk_sid will automatically delete your voice_application_sid and vice versa.



424
425
426
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 424

def trunk_sid
    @properties['trunk_sid']
end

#uri ⇒ String

Returns The URI of the resource, relative to https://api.twilio.com.

Returns:

  • The URI of the resource, relative to https://api.twilio.com.



442
443
444
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 442

def uri
    @properties['uri']
end

#voice_application_sid ⇒ String

Returns The SID of the application that handles calls to the phone number. If a voice_application_sid is present, we ignore all of the voice urls and use those set on the application. Setting a voice_application_sid will automatically delete your trunk_sid and vice versa.

Returns:

  • The SID of the application that handles calls to the phone number. If a voice_application_sid is present, we ignore all of the voice urls and use those set on the application. Setting a voice_application_sid will automatically delete your trunk_sid and vice versa.



418
419
420
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 418

def voice_application_sid
    @properties['voice_application_sid']
end

#voice_caller_id_lookup ⇒ Boolean

Returns Whether we look up the caller’s caller-ID name from the CNAM database. Can be: true or false. Caller ID lookups can cost $0.01 each.

Returns:

  • Whether we look up the caller’s caller-ID name from the CNAM database. Can be: true or false. Caller ID lookups can cost $0.01 each.



340
341
342
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 340

def voice_caller_id_lookup
    @properties['voice_caller_id_lookup']
end

#voice_fallback_method ⇒ String

Returns The HTTP method we use to call voice_fallback_url. Can be: GET or POST.

Returns:

  • The HTTP method we use to call voice_fallback_url. Can be: GET or POST.



328
329
330
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 328

def voice_fallback_method
    @properties['voice_fallback_method']
end

#voice_fallback_url ⇒ String

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

Returns:

  • The URL that we call when an error occurs retrieving or executing the TwiML requested by url.



334
335
336
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 334

def voice_fallback_url
    @properties['voice_fallback_url']
end

#voice_method ⇒ String

Returns The HTTP method we use to call voice_url. Can be: GET or POST.

Returns:

  • The HTTP method we use to call voice_url. Can be: GET or POST.



322
323
324
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 322

def voice_method
    @properties['voice_method']
end

#voice_url ⇒ String

Returns The URL we call when the phone number receives a call. The voice_url will not be used if a voice_application_sid or a trunk_sid is set.

Returns:

  • The URL we call when the phone number receives a call. The voice_url will not be used if a voice_application_sid or a trunk_sid is set.



316
317
318
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 316

def voice_url
    @properties['voice_url']
end