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

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

    The unique string that we created to identify the PhoneNumber resource to fetch.



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
251
252
253
254
255
256
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 220

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_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

def 
  @properties['account_sid']
end

#address_requirements ⇒ phone_number.AddressRequirement

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

Returns:

  • (phone_number.AddressRequirement) —

    Whether the phone number requires an Address registered with Twilio



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

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



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

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



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

def beta
  @properties['beta']
end

#capabilities ⇒ Hash

Returns Indicate if a phone can receive calls or messages.

Returns:

  • (Hash) —

    Indicate if a phone can receive calls or messages



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

def capabilities
  @properties['capabilities']
end

#context ⇒ PhoneNumberContext

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

Returns:



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

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

#date_created ⇒ Time

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

Returns:

  • (Time) —

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



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

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

Returns:

  • (Time) —

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



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the PhoneNumberInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete
  context.delete
end

#fetch ⇒ PhoneNumberInstance

Fetch the PhoneNumberInstance

Returns:



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

def fetch
  context.fetch
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



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



448
449
450
451
 
# File 'lib/twilio-ruby/rest/trunking/v1/trunk/phone_number.rb', line 448

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

#links ⇒ String

Returns The URLs of related resources.

Returns:

  • (String) —

    The URLs of related resources



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

def links
  @properties['links']
end

#phone_number ⇒ String

Returns The phone number in E.164 format.

Returns:

  • (String) —

    The phone number in E.164 format



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

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



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

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



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

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



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

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



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

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



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

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



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

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



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

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



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

def status_callback_method
  @properties['status_callback_method']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



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

def trunk_sid
  @properties['trunk_sid']
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource



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

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



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

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



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

def voice_caller_id_lookup
  @properties['voice_caller_id_lookup']
end

#voice_fallback_method ⇒ String

Returns The HTTP method that we use to call voice_fallback_url.

Returns:

  • (String) —

    The HTTP method that we use to call voice_fallback_url



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

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



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

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



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

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



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

def voice_url
  @properties['voice_url']
end