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

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

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


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

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


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

def 
  @properties['account_sid']
end

#capabilities ⇒ String

Returns The capabilities of the phone number.

Returns:

  • (String) —

    The capabilities of the phone number


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

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:


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

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


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

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


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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the PhoneNumberInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


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

def delete
  context.delete
end

#fetch ⇒ PhoneNumberInstance

Fetch the PhoneNumberInstance

Returns:


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

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


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

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.


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

def in_use
  @properties['in_use']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


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

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


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

def is_reserved
  @properties['is_reserved']
end

#iso_country ⇒ String

Returns The ISO Country Code.

Returns:

  • (String) —

    The ISO Country Code


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

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


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

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


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

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


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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation


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

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 for more information.

Returns:


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

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


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

def url
  @properties['url']
end