Class: Twilio::REST::Proxy::V1::ServiceContext::PhoneNumberInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the PhoneNumberInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this PhoneNumber resource.

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

    The SID of the Call resource to fetch.



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 293

def initialize(version, payload , service_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'account_sid' => payload['account_sid'],
        'service_sid' => payload['service_sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'phone_number' => payload['phone_number'],
        'friendly_name' => payload['friendly_name'],
        'iso_country' => payload['iso_country'],
        'capabilities' => payload['capabilities'],
        'url' => payload['url'],
        'is_reserved' => payload['is_reserved'],
        'in_use' => payload['in_use'] == nil ? payload['in_use'] : payload['in_use'].to_i,
    }

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

Instance Method Details

#account_sid ⇒ String

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

Returns:



336
337
338
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 336

def 
    @properties['account_sid']
end

#capabilities ⇒ ProxyV1ServicePhoneNumberCapabilities

Returns:

  • (ProxyV1ServicePhoneNumberCapabilities) 


378
379
380
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 378

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:



321
322
323
324
325
326
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 321

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

#date_created ⇒ Time

Returns The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was created.

Returns:



348
349
350
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 348

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date and time in GMT when the resource was last updated.

Returns:



354
355
356
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 354

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the PhoneNumberInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



403
404
405
406
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 403

def delete

    context.delete
end

#fetch ⇒ PhoneNumberInstance

Fetch the PhoneNumberInstance

Returns:



411
412
413
414
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 411

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.



366
367
368
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 366

def friendly_name
    @properties['friendly_name']
end

#in_use ⇒ String

Returns The number of open session assigned to the number. See the [How many Phone Numbers do I need?](www.twilio.com/docs/proxy/phone-numbers-needed) guide for more information.

Returns:



396
397
398
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 396

def in_use
    @properties['in_use']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



438
439
440
441
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 438

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

#is_reserved ⇒ Boolean

Returns Whether the phone number should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](www.twilio.com/docs/proxy/reserved-phone-numbers) for more information.

Returns:



390
391
392
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 390

def is_reserved
    @properties['is_reserved']
end

#iso_country ⇒ String

Returns The ISO Country Code for the phone number.

Returns:

  • (String) —

    The ISO Country Code for the phone number.



372
373
374
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 372

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



360
361
362
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 360

def phone_number
    @properties['phone_number']
end

#service_sid ⇒ String

Returns The SID of the PhoneNumber resource’s parent [Service](www.twilio.com/docs/proxy/api/service) resource.

Returns:



342
343
344
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 342

def service_sid
    @properties['service_sid']
end

#sid ⇒ String

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

Returns:

  • (String) —

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



330
331
332
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 330

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



431
432
433
434
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 431

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

#update(is_reserved: :unset) ⇒ PhoneNumberInstance

Update the PhoneNumberInstance

Parameters:

  • is_reserved (Boolean) (defaults to: :unset) —

    Whether the phone number should be reserved and not be assigned to a participant using proxy pool logic. See [Reserved Phone Numbers](www.twilio.com/docs/proxy/reserved-phone-numbers) for more information.

Returns:



420
421
422
423
424
425
426
427
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 420

def update(
    is_reserved: :unset
)

    context.update(
        is_reserved: is_reserved, 
    )
end

#url ⇒ String

Returns The absolute URL of the PhoneNumber resource.

Returns:

  • (String) —

    The absolute URL of the PhoneNumber resource.



384
385
386
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 384

def url
    @properties['url']
end