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 (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 DependentPhoneNumber resource.

  • sid (String) —

    The SID of the Call resource to fetch.



170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 170

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:



213
214
215
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 213

def 
    @properties['account_sid']
end

#address_requirements ⇒ AddressRequirement

Returns:

  • (AddressRequirement) 


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

def address_requirements
    @properties['address_requirements']
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.



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

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:

  • (Hash) —

    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`.



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

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:



261
262
263
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 261

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:



267
268
269
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 267

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:

  • (String) —

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



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

def emergency_address_sid
    @properties['emergency_address_sid']
end

#emergency_status ⇒ EmergencyStatus

Returns:

  • (EmergencyStatus) 


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

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.



219
220
221
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 219

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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:



225
226
227
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 225

def phone_number
    @properties['phone_number']
end

#sid ⇒ String

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

Returns:

  • (String) —

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



207
208
209
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 207

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:

  • (String) —

    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.



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

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:

  • (String) —

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



273
274
275
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 273

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:

  • (String) —

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



279
280
281
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 279

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:

  • (String) —

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



285
286
287
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 285

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.



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

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:

  • (String) —

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



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

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:

  • (String) —

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



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

def status_callback_method
    @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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:

  • (String) —

    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.



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

def trunk_sid
    @properties['trunk_sid']
end

#uri ⇒ String

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

Returns:

  • (String) —

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



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

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:

  • (String) —

    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.



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

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:

  • (Boolean) —

    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.



255
256
257
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 255

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:

  • (String) —

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



243
244
245
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 243

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:

  • (String) —

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



249
250
251
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 249

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:

  • (String) —

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



237
238
239
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 237

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:

  • (String) —

    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.



231
232
233
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 231

def voice_url
    @properties['voice_url']
end