Class: Twilio::REST::Wireless::V1::CommandInstance

Inherits:

InstanceResource

• Object
• InstanceResource
• Twilio::REST::Wireless::V1::CommandInstance

Defined in:

lib/twilio-ruby/rest/wireless/v1/command.rb

Instance Method Summary

• #account_sid ⇒ String

  The SID of the Account that created the resource.

• #command ⇒ String

  The message being sent to or from the SIM.

• #command_mode ⇒ command.CommandMode

  The mode used to send the SMS message.

• #context ⇒ CommandContext

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

• #delete ⇒ Boolean

  Delete the CommandInstance.

• #delivery_receipt_requested ⇒ Boolean

  Whether to request a delivery receipt.

• #direction ⇒ command.Direction

  The direction of the Command.

• #fetch ⇒ CommandInstance

  Fetch the CommandInstance.

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

  Initialize the CommandInstance.

• #inspect ⇒ Object

  Provide a detailed, user friendly representation.

• #sid ⇒ String

  The unique string that identifies the resource.

• #sim_sid ⇒ String

  The SID of the Sim resource that the Command was sent to or from.

• #status ⇒ command.Status

  The status of the Command.

• #to_s ⇒ Object

  Provide a user friendly representation.

• #transport ⇒ command.Transport

  The type of transport used.

• #url ⇒ String

  The absolute URL of the resource.

Constructor Details

#initialize(version, payload, sid: nil) ⇒ CommandInstance

Initialize the CommandInstance

# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 278

def initialize(version, payload, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'sim_sid' => payload['sim_sid'],
      'command' => payload['command'],
      'command_mode' => payload['command_mode'],
      'transport' => payload['transport'],
      'delivery_receipt_requested' => payload['delivery_receipt_requested'],
      'status' => payload['status'],
      'direction' => payload['direction'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'url' => payload['url'],
  }

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

Instance Method Details

#account_sid ⇒ String

# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 321

def account_sid
  @properties['account_sid']
end

#command ⇒ String

# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 333

def command
  @properties['command']
end

#command_mode ⇒ command.CommandMode

# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 339

def command_mode
  @properties['command_mode']
end

#context ⇒ CommandContext

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/wireless/v1/command.rb', line 306

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

#date_created ⇒ Time

# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 369

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 375

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the CommandInstance

# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 395

def delete
  context.delete
end

#delivery_receipt_requested ⇒ Boolean

# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 351

def delivery_receipt_requested
  @properties['delivery_receipt_requested']
end

#direction ⇒ command.Direction

# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 363

def direction
  @properties['direction']
end

#fetch ⇒ CommandInstance

Fetch the CommandInstance

# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 388

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 408

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

#sid ⇒ String

# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 315

def sid
  @properties['sid']
end

#sim_sid ⇒ String

# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 327

def sim_sid
  @properties['sim_sid']
end

#status ⇒ command.Status

# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 357

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation

# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 401

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

#transport ⇒ command.Transport

# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 345

def transport
  @properties['transport']
end

#url ⇒ String

# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 381

def url
  @properties['url']
end