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](www.twilio.com/docs/api/rest/account) that created the DependentPhoneNumber resource.

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

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



167
168
169
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
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 167

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 that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

def 
  @properties['account_sid']
end

#address_requirements ⇒ dependent_phone_number.AddressRequirement

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

Returns:

  • (dependent_phone_number.AddressRequirement) —

    Whether the phone number requires an Address registered with Twilio



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

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



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

def api_version
  @properties['api_version']
end

#capabilities ⇒ Hash

Returns Indicate if a phone can receive calls or messages.

Returns:

  • (Hash) —

    Indicate if a phone can receive calls or messages



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

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



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

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



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

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



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

def emergency_address_sid
  @properties['emergency_address_sid']
end

#emergency_status ⇒ dependent_phone_number.EmergencyStatus

Returns Whether the phone number is enabled for emergency calling.

Returns:

  • (dependent_phone_number.EmergencyStatus) —

    Whether the phone number is enabled for emergency calling



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

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



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#phone_number ⇒ String

Returns The phone number in E.164 format.

Returns:

  • (String) —

    The phone number in E.164 format



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

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



203
204
205
 
# File 'lib/twilio-ruby/rest/api/v2010/account/address/dependent_phone_number.rb', line 203

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



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

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



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

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



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

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



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

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



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

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



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

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



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

def status_callback_method
  @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

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`



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

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



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

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



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

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



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

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



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

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



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

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



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

def voice_url
  @properties['voice_url']
end