Class: Twilio::REST::Trunking::V1::TrunkContext::PhoneNumberInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, trunk_sid: nil, sid: nil) ⇒ PhoneNumberInstance

Initialize the PhoneNumberInstance

Parameters:

  • version (Version)

    Version that contains the resource

  • payload (Hash)

    payload that contains response from Twilio

  • trunk_sid (String) (defaults to: nil)

    The trunk_sid

  • sid (String) (defaults to: nil)

    The sid



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 214

def initialize(version, payload, trunk_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'address_requirements' => payload['address_requirements'],
      'api_version' => payload['api_version'],
      'beta' => payload['beta'],
      'capabilities' => payload['capabilities'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'friendly_name' => payload['friendly_name'],
      'links' => payload['links'],
      'phone_number' => payload['phone_number'],
      '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'],
      'url' => payload['url'],
      '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'],
  }

  # Context
  @instance_context = nil
  @params = {'trunk_sid' => trunk_sid, 'sid' => sid || @properties['sid']}
end

Instance Method Details

#account_sidString

Returns The account_sid.

Returns:

  • (String)

    The account_sid



265
266
267
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 265

def 
  @properties['account_sid']
end

#address_requirementsphone_number.AddressRequirement

Returns The address_requirements.

Returns:

  • (phone_number.AddressRequirement)

    The address_requirements



271
272
273
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 271

def address_requirements
  @properties['address_requirements']
end

#api_versionString

Returns The api_version.

Returns:

  • (String)

    The api_version



277
278
279
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 277

def api_version
  @properties['api_version']
end

#betaBoolean

Returns The beta.

Returns:

  • (Boolean)

    The beta



283
284
285
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 283

def beta
  @properties['beta']
end

#capabilitiesString

Returns The capabilities.

Returns:

  • (String)

    The capabilities



289
290
291
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 289

def capabilities
  @properties['capabilities']
end

#contextPhoneNumberContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



256
257
258
259
260
261
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 256

def context
  unless @instance_context
    @instance_context = PhoneNumberContext.new(@version, @params['trunk_sid'], @params['sid'])
  end
  @instance_context
end

#date_createdTime

Returns The date_created.

Returns:

  • (Time)

    The date_created



295
296
297
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 295

def date_created
  @properties['date_created']
end

#date_updatedTime

Returns The date_updated.

Returns:

  • (Time)

    The date_updated



301
302
303
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 301

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Deletes the PhoneNumberInstance

Returns:

  • (Boolean)

    true if delete succeeds, true otherwise



429
430
431
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 429

def delete
  context.delete
end

#fetchPhoneNumberInstance

Fetch a PhoneNumberInstance

Returns:



422
423
424
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 422

def fetch
  context.fetch
end

#friendly_nameString

Returns The friendly_name.

Returns:

  • (String)

    The friendly_name



307
308
309
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 307

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation



442
443
444
445
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 442

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Trunking.V1.PhoneNumberInstance #{values}>"
end

Returns The links.

Returns:

  • (String)

    The links



313
314
315
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 313

def links
  @properties['links']
end

#phone_numberString

Returns The phone_number.

Returns:

  • (String)

    The phone_number



319
320
321
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 319

def phone_number
  @properties['phone_number']
end

#sidString

Returns The sid.

Returns:

  • (String)

    The sid



325
326
327
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 325

def sid
  @properties['sid']
end

#sms_application_sidString

Returns The sms_application_sid.

Returns:

  • (String)

    The sms_application_sid



331
332
333
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 331

def sms_application_sid
  @properties['sms_application_sid']
end

#sms_fallback_methodString

Returns The sms_fallback_method.

Returns:

  • (String)

    The sms_fallback_method



337
338
339
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 337

def sms_fallback_method
  @properties['sms_fallback_method']
end

#sms_fallback_urlString

Returns The sms_fallback_url.

Returns:

  • (String)

    The sms_fallback_url



343
344
345
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 343

def sms_fallback_url
  @properties['sms_fallback_url']
end

#sms_methodString

Returns The sms_method.

Returns:

  • (String)

    The sms_method



349
350
351
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 349

def sms_method
  @properties['sms_method']
end

#sms_urlString

Returns The sms_url.

Returns:

  • (String)

    The sms_url



355
356
357
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 355

def sms_url
  @properties['sms_url']
end

#status_callbackString

Returns The status_callback.

Returns:

  • (String)

    The status_callback



361
362
363
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 361

def status_callback
  @properties['status_callback']
end

#status_callback_methodString

Returns The status_callback_method.

Returns:

  • (String)

    The status_callback_method



367
368
369
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 367

def status_callback_method
  @properties['status_callback_method']
end

#to_sObject

Provide a user friendly representation



435
436
437
438
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 435

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Trunking.V1.PhoneNumberInstance #{values}>"
end

#trunk_sidString

Returns The trunk_sid.

Returns:

  • (String)

    The trunk_sid



373
374
375
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 373

def trunk_sid
  @properties['trunk_sid']
end

#urlString

Returns The url.

Returns:

  • (String)

    The url



379
380
381
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 379

def url
  @properties['url']
end

#voice_application_sidString

Returns The voice_application_sid.

Returns:

  • (String)

    The voice_application_sid



385
386
387
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 385

def voice_application_sid
  @properties['voice_application_sid']
end

#voice_caller_id_lookupBoolean

Returns The voice_caller_id_lookup.

Returns:

  • (Boolean)

    The voice_caller_id_lookup



391
392
393
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 391

def voice_caller_id_lookup
  @properties['voice_caller_id_lookup']
end

#voice_fallback_methodString

Returns The voice_fallback_method.

Returns:

  • (String)

    The voice_fallback_method



397
398
399
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 397

def voice_fallback_method
  @properties['voice_fallback_method']
end

#voice_fallback_urlString

Returns The voice_fallback_url.

Returns:

  • (String)

    The voice_fallback_url



403
404
405
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 403

def voice_fallback_url
  @properties['voice_fallback_url']
end

#voice_methodString

Returns The voice_method.

Returns:

  • (String)

    The voice_method



409
410
411
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 409

def voice_method
  @properties['voice_method']
end

#voice_urlString

Returns The voice_url.

Returns:

  • (String)

    The voice_url



415
416
417
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 415

def voice_url
  @properties['voice_url']
end