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

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

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

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

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

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

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

    The Twilio-provided string that uniquely identifies the PhoneNumber resource to fetch.



258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 258

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'].to_i,
  }

  # Context
  @instance_context = nil
  @params = {'service_sid' => service_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



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

def 
  @properties['account_sid']
end

#capabilities ⇒ String

Returns The capabilities of the phone number.

Returns:

  • (String) —

    The capabilities of the phone number



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

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:



286
287
288
289
290
291
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 286

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 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The ISO 8601 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The ISO 8601 date and time in GMT when the resource was last updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the PhoneNumberInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete
  context.delete
end

#fetch ⇒ PhoneNumberInstance

Fetch the PhoneNumberInstance

Returns:



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

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



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

def friendly_name
  @properties['friendly_name']
end

#in_use ⇒ String

Returns The number of open session assigned to the number.

Returns:

  • (String) —

    The number of open session assigned to the number.



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

def in_use
  @properties['in_use']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#is_reserved ⇒ Boolean

Returns Reserve the phone number for manual assignment to participants only.

Returns:

  • (Boolean) —

    Reserve the phone number for manual assignment to participants only



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

def is_reserved
  @properties['is_reserved']
end

#iso_country ⇒ String

Returns The ISO Country Code.

Returns:

  • (String) —

    The ISO Country Code



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

def iso_country
  @properties['iso_country']
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/proxy/v1/service/phone_number.rb', line 325

def phone_number
  @properties['phone_number']
end

#service_sid ⇒ String

Returns The SID of the PhoneNumber resource’s parent Service resource.

Returns:

  • (String) —

    The SID of the PhoneNumber resource’s parent Service resource



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



392
393
394
395
 
# File 'lib/twilio-ruby/rest/proxy/v1/service/phone_number.rb', line 392

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:



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

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



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

def url
  @properties['url']
end