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

Inherits:
InstanceResource show all
Defined in:
lib/twilio-ruby/rest/wireless/v1/command.rb

Overview

PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.

Instance Method Summary collapse

Constructor Details

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

Initialize the CommandInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • sid (String) (defaults to: nil) —

    The sid



260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 260

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'],
      '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

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



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

def 
  @properties['account_sid']
end

#command ⇒ String

Returns The command.

Returns:

  • (String) —

    The command



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

def command
  @properties['command']
end

#command_mode ⇒ command.CommandMode

Returns The command_mode.

Returns:

  • (command.CommandMode) —

    The command_mode



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

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

Returns:



288
289
290
291
292
293
294
295
296
 
# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 288

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

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#direction ⇒ command.Direction

Returns The direction.

Returns:

  • (command.Direction) —

    The direction



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

def direction
  @properties['direction']
end

#fetch ⇒ CommandInstance

Fetch a CommandInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#sim_sid ⇒ String

Returns The sim_sid.

Returns:

  • (String) —

    The sim_sid



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

def sim_sid
  @properties['sim_sid']
end

#status ⇒ command.Status

Returns The status.

Returns:



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end