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](www.twilio.com/docs/iam/api/account) that created the Command resource.

• #command ⇒ String

  The message being sent to or from the SIM.

• #command_mode ⇒ CommandMode
• #context ⇒ CommandContext

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

• #date_created ⇒ Time

  The date and time in GMT when the resource was created specified in [ISO 8601](www.iso.org/iso-8601-date-and-time-format.html) format.

• #date_updated ⇒ Time

  The date and time in GMT when the resource was last updated specified in [ISO 8601](www.iso.org/iso-8601-date-and-time-format.html) format.

• #delete ⇒ Boolean

  Delete the CommandInstance.

• #delivery_receipt_requested ⇒ Boolean

  Whether to request a delivery receipt.

• #direction ⇒ Direction
• #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 we created to identify the Command resource.

• #sim_sid ⇒ String

  The SID of the [Sim resource](www.twilio.com/docs/iot/wireless/api/sim-resource) that the Command was sent to or from.

• #status ⇒ Status
• #to_s ⇒ Object

  Provide a user friendly representation.

• #transport ⇒ Transport
• #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 281

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 324

def account_sid
    @properties['account_sid']
end

#command ⇒ String

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

def command
    @properties['command']
end

#command_mode ⇒ CommandMode

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

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 309

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 372

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the CommandInstance

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

def delete

    context.delete
end

#delivery_receipt_requested ⇒ Boolean

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

def delivery_receipt_requested
    @properties['delivery_receipt_requested']
end

#direction ⇒ Direction

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

def direction
    @properties['direction']
end

#fetch ⇒ CommandInstance

Fetch the CommandInstance

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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation

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

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 318

def sid
    @properties['sid']
end

#sim_sid ⇒ String

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

def sim_sid
    @properties['sim_sid']
end

#status ⇒ Status

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

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation

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

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

#transport ⇒ Transport

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

def transport
    @properties['transport']
end

#url ⇒ String

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

def url
    @properties['url']
end