Class: Twilio::REST::Preview::Wireless::CommandInstance

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

Overview

PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact [email protected].

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



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/twilio-ruby/rest/preview/wireless/command.rb', line 268

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

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'account_sid' => payload['account_sid'],
      'device_sid' => payload['device_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



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

def 
  @properties['account_sid']
end

#command ⇒ String

Returns The command.

Returns:

  • (String) —

    The command



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

def command
  @properties['command']
end

#command_mode ⇒ String

Returns The command_mode.

Returns:

  • (String) —

    The command_mode



339
340
341
 
# File 'lib/twilio-ruby/rest/preview/wireless/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

Returns:



297
298
299
300
301
302
303
304
305
 
# File 'lib/twilio-ruby/rest/preview/wireless/command.rb', line 297

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



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#device_sid ⇒ String

Returns The device_sid.

Returns:

  • (String) —

    The device_sid



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

def device_sid
  @properties['device_sid']
end

#direction ⇒ String

Returns The direction.

Returns:

  • (String) —

    The direction



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

def direction
  @properties['direction']
end

#fetch ⇒ CommandInstance

Fetch a CommandInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



389
390
391
392
 
# File 'lib/twilio-ruby/rest/preview/wireless/command.rb', line 389

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

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



309
310
311
 
# File 'lib/twilio-ruby/rest/preview/wireless/command.rb', line 309

def sid
  @properties['sid']
end

#sim_sid ⇒ String

Returns The sim_sid.

Returns:

  • (String) —

    The sim_sid



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

def sim_sid
  @properties['sim_sid']
end

#status ⇒ String

Returns The status.

Returns:

  • (String) —

    The status



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

def status
  @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



382
383
384
385
 
# File 'lib/twilio-ruby/rest/preview/wireless/command.rb', line 382

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

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end