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.



277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/twilio-ruby/rest/wireless/v1/command.rb', line 277

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:



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

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.



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

def command
    @properties['command']
end

#command_mode ⇒ CommandMode

Returns:

  • (CommandMode) 


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

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:



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

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:



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

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:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the CommandInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#delivery_receipt_requested ⇒ Boolean

Returns Whether to request a delivery receipt.

Returns:

  • (Boolean) —

    Whether to request a delivery receipt.



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

def delivery_receipt_requested
    @properties['delivery_receipt_requested']
end

#direction ⇒ Direction

Returns:

  • (Direction) 


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

def direction
    @properties['direction']
end

#fetch ⇒ CommandInstance

Fetch the CommandInstance

Returns:



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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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.



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

def sid
    @properties['sid']
end

#sim_sid ⇒ String

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

Returns:



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

def sim_sid
    @properties['sim_sid']
end

#status ⇒ Status

Returns:

  • (Status) 


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

def status
    @properties['status']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#transport ⇒ Transport

Returns:

  • (Transport) 


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

def transport
    @properties['transport']
end

#url ⇒ String

Returns The absolute URL of the resource.

Returns:

  • (String) —

    The absolute URL of the resource.



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

def url
    @properties['url']
end