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

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

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

  • account_sid (String) —

    The SID of the Account that created this Command resource.

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

    The SID of the Call resource to fetch.



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 282

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

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Command resource.

Returns:



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

def 
    @properties['account_sid']
end

#command ⇒ String

Returns The message being sent to or from the SIM. For text mode messages, this can be up to 160 characters. For binary mode messages, this is a series of up to 140 bytes of data encoded using base64.

Returns:

  • (String) —

    The message being sent to or from the SIM. For text mode messages, this can be up to 160 characters. For binary mode messages, this is a series of up to 140 bytes of data encoded using base64.



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

def command
    @properties['command']
end

#command_mode ⇒ CommandMode

Returns:

  • (CommandMode) 


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

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:



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

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

#date_created ⇒ Time

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

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

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

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the CommandInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#delivery_receipt_requested ⇒ Boolean

Returns Whether to request a delivery receipt.

Returns:

  • (Boolean) —

    Whether to request a delivery receipt.



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

def delivery_receipt_requested
    @properties['delivery_receipt_requested']
end

#direction ⇒ Direction

Returns:

  • (Direction) 


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

def direction
    @properties['direction']
end

#fetch ⇒ CommandInstance

Fetch the CommandInstance

Returns:



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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



414
415
416
417
 
# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 414

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

#sid ⇒ String

Returns The unique string that we created to identify the Command resource.

Returns:

  • (String) —

    The unique string that we created to identify the Command resource.



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

def sid
    @properties['sid']
end

#sim_sid ⇒ String

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

Returns:



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

def sim_sid
    @properties['sim_sid']
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#transport ⇒ Transport

Returns:

  • (Transport) 


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

def transport
    @properties['transport']
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



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

def url
    @properties['url']
end