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 unique SID identifier of the parent [Service](www.twilio.com/docs/proxy/api/service).

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

    A 34 character string that uniquely identifies the Phone Number to fetch (e.g. ‘PN1a2b3c4d5e6f7a8b9c0d1e2f3a4b5c6d`).



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

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

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

Instance Method Details

#account_sid ⇒ String

Returns Account Sid.

Returns:

  • (String) —

    Account Sid.



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

def 
  @properties['account_sid']
end

#capabilities ⇒ String

Returns A list of capabilities.

Returns:

  • (String) —

    A list of capabilities.



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

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:



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

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

#date_created ⇒ Time

Returns The date this Phone Number was added to the service.

Returns:

  • (Time) —

    The date this Phone Number was added to the service



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this Phone Number was updated.

Returns:

  • (Time) —

    The date this Phone Number was updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the PhoneNumberInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ PhoneNumberInstance

Fetch a PhoneNumberInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns A human-readable description of this resource.

Returns:

  • (String) —

    A human-readable description of this resource.



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#is_reserved ⇒ Boolean

Returns Reserve for manual assignment to participants only.

Returns:

  • (Boolean) —

    Reserve for manual assignment to participants only.



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

def is_reserved
  @properties['is_reserved']
end

#iso_country ⇒ String

Returns ISO Country Code,.

Returns:

  • (String) —

    ISO Country Code,



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

def iso_country
  @properties['iso_country']
end

#phone_number ⇒ String

Returns The phone number.

Returns:

  • (String) —

    The phone number.



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

def phone_number
  @properties['phone_number']
end

#service_sid ⇒ String

Returns Service Sid.

Returns:

  • (String) —

    Service Sid.



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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

Returns A string that uniquely identifies this Phone Number.

Returns:

  • (String) —

    A string that uniquely identifies this Phone Number.



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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 or not the number should be excluded from being assigned to a participant using proxy pool logic

Returns:



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

def update(is_reserved: :unset)
  context.update(is_reserved: is_reserved, )
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



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

def url
  @properties['url']
end