Class: Twilio::REST::Messaging::V1::ServiceContext::ShortCodeInstance

Inherits:

InstanceResource

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

Defined in:

lib/twilio-ruby/rest/messaging/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 this resource.

• #capabilities ⇒ Hash

  Any array of values that indicate whether the number can receive calls or messages.

• #context ⇒ ShortCodeContext

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

• #country_code ⇒ String

  The 2-character ISO Country Code of the number.

• #date_created ⇒ Time

  The RFC 2822 date and time in GMT that this resource was created.

• #date_updated ⇒ Time

  The RFC 2822 date and time in GMT that this resource was last updated.

• #delete ⇒ Boolean

  Deletes the ShortCodeInstance.

• #fetch ⇒ ShortCodeInstance

  Fetch a ShortCodeInstance.

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

  Initialize the ShortCodeInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #service_sid ⇒ String

  The SID of the Service that this resource is associated with.

• #short_code ⇒ String

  The E.164 format of the short code.

• #sid ⇒ String

  The unique string that identifies this resource.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #url ⇒ String

  The absolute URL of this ShortCode resource.

Constructor Details

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

Initialize the ShortCodeInstance

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

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'],
      'country_code' => payload['country_code'],
      'capabilities' => payload['capabilities'],
      'url' => payload['url'],
  }

  # 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/messaging/v1/service/short_code.rb', line 280

def account_sid
  @properties['account_sid']
end

#capabilities ⇒ Hash

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

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/messaging/v1/service/short_code.rb', line 265

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

#country_code ⇒ String

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

def country_code
  @properties['country_code']
end

#date_created ⇒ Time

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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the ShortCodeInstance

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

def delete
  context.delete
end

#fetch ⇒ ShortCodeInstance

Fetch a ShortCodeInstance

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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

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

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

#service_sid ⇒ String

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

def service_sid
  @properties['service_sid']
end

#short_code ⇒ String

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

def short_code
  @properties['short_code']
end

#sid ⇒ String

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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation

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

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

#url ⇒ String

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

def url
  @properties['url']
end