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

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Proxy::V1::ServiceContext::PhoneNumberInstance

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

• #account_sid ⇒ String

  Account Sid.

• #capabilities ⇒ String

  A list of capabilities.

• #context ⇒ PhoneNumberContext

  Generate an instance context for the instance, the context is capable of performing various actions.

• #date_created ⇒ Time

  The date this Phone Number was added to the service.

• #date_updated ⇒ Time

  The date this Phone Number was updated.

• #delete ⇒ Boolean

  Deletes the PhoneNumberInstance.

• #fetch ⇒ PhoneNumberInstance

  Fetch a PhoneNumberInstance.

• #friendly_name ⇒ String

  A human-readable description of this resource.

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

  Initialize the PhoneNumberInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #is_reserved ⇒ Boolean

  Reserve for manual assignment to participants only.

• #iso_country ⇒ String

  ISO Country Code,.

• #phone_number ⇒ String

  The phone number.

• #service_sid ⇒ String

  Service Sid.

• #sid ⇒ String

  A string that uniquely identifies this Phone Number.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #update(is_reserved: :unset) ⇒ PhoneNumberInstance

  Update the PhoneNumberInstance.

• #url ⇒ String

  The URL of this resource.

Constructor Details

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

Initialize the PhoneNumberInstance

# 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

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

def account_sid
  @properties['account_sid']
end

#capabilities ⇒ String

# 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

# 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

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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

# 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

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

def delete
  context.delete
end

#fetch ⇒ PhoneNumberInstance

Fetch a PhoneNumberInstance

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

def fetch
  context.fetch
end

#friendly_name ⇒ String

# 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

# 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

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

def is_reserved
  @properties['is_reserved']
end

#iso_country ⇒ String

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

def iso_country
  @properties['iso_country']
end

#phone_number ⇒ String

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

def phone_number
  @properties['phone_number']
end

#service_sid ⇒ String

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

def service_sid
  @properties['service_sid']
end

#sid ⇒ String

# 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

# 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

# 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

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

def url
  @properties['url']
end