Class: Twilio::REST::Proxy::V1::ServiceContext::ShortCodeInstance

Inherits:

InstanceResource

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

Defined in:

lib/twilio-ruby/rest/proxy/v1/service/short_code.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

  The SID of the Account that created the resource.

• #capabilities ⇒ String

  The capabilities of the short code.

• #context ⇒ ShortCodeContext

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

• #date_created ⇒ Time

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

• #date_updated ⇒ Time

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

• #delete ⇒ Boolean

  Delete the ShortCodeInstance.

• #fetch ⇒ ShortCodeInstance

  Fetch the ShortCodeInstance.

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

  Initialize the ShortCodeInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #is_reserved ⇒ Boolean

  Whether the short code should be reserved for manual assignment to participants only.

• #iso_country ⇒ String

  The ISO Country Code.

• #service_sid ⇒ String

  The SID of the resource’s parent Service.

• #short_code ⇒ String

  The short code’s number.

• #sid ⇒ String

  The unique string that identifies the resource.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #update(is_reserved: :unset) ⇒ ShortCodeInstance

  Update the ShortCodeInstance.

• #url ⇒ String

  The absolute URL of the ShortCode resource.

Constructor Details

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

Initialize the ShortCodeInstance

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

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']),
      'short_code' => payload['short_code'],
      '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/short_code.rb', line 282

def account_sid
  @properties['account_sid']
end

#capabilities ⇒ String

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

def capabilities
  @properties['capabilities']
end

#context ⇒ ShortCodeContext

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/short_code.rb', line 267

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

#date_created ⇒ Time

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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the ShortCodeInstance

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

def delete
  context.delete
end

#fetch ⇒ ShortCodeInstance

Fetch the ShortCodeInstance

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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

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

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

#is_reserved ⇒ Boolean

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

def is_reserved
  @properties['is_reserved']
end

#iso_country ⇒ String

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

def iso_country
  @properties['iso_country']
end

#service_sid ⇒ String

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

def service_sid
  @properties['service_sid']
end

#short_code ⇒ String

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

def short_code
  @properties['short_code']
end

#sid ⇒ String

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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation

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

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

#update(is_reserved: :unset) ⇒ ShortCodeInstance

Update the ShortCodeInstance

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

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

#url ⇒ String

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

def url
  @properties['url']
end