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.



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 270

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:



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

def 
    @properties['account_sid']
end

#capabilities ⇒ ProxyV1ServicePhoneNumberCapabilities

Returns:

  • (ProxyV1ServicePhoneNumberCapabilities) 


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

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:



298
299
300
301
302
303
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 298

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:



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

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:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the PhoneNumberInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



380
381
382
383
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 380

def delete

    context.delete
end

#fetch ⇒ PhoneNumberInstance

Fetch the PhoneNumberInstance

Returns:



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

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.



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

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:



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

def in_use
    @properties['in_use']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



415
416
417
418
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 415

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:



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

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.



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

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:



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

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:



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

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.



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



408
409
410
411
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 408

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:



397
398
399
400
401
402
403
404
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 397

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.



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

def url
    @properties['url']
end