Class: Twilio::REST::Microvisor::V1::DeviceInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the DeviceInstance

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 Device resource.

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

    The SID of the Call resource to fetch.



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 293

def initialize(version, payload , sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'unique_name' => payload['unique_name'],
        'account_sid' => payload['account_sid'],
        'app' => payload['app'],
        'logging' => payload['logging'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'url' => payload['url'],
        'links' => payload['links'],
    }

    # Context
    @instance_context = nil
    @params = { 'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique SID identifier of the Account.

Returns:

  • (String) —

    The unique SID identifier of the Account.



339
340
341
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 339

def 
    @properties['account_sid']
end

#app ⇒ Hash

Returns Information about the target App and the App reported by this Device. Contains the properties ‘target_sid`, `date_targeted`, `update_status` (one of `up-to-date`, `pending` and `error`), `update_error_code`, `reported_sid` and `date_reported`.

Returns:

  • (Hash) —

    Information about the target App and the App reported by this Device. Contains the properties ‘target_sid`, `date_targeted`, `update_status` (one of `up-to-date`, `pending` and `error`), `update_error_code`, `reported_sid` and `date_reported`.



345
346
347
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 345

def app
    @properties['app']
end

#context ⇒ DeviceContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



318
319
320
321
322
323
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 318

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

#date_created ⇒ Time

Returns The date that this Device was created, given in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



357
358
359
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 357

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date that this Device was last updated, given in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



363
364
365
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 363

def date_updated
    @properties['date_updated']
end

#device_configs ⇒ device_configs

Access the device_configs

Returns:



419
420
421
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 419

def device_configs
    context.device_configs
end

#device_secrets ⇒ device_secrets

Access the device_secrets

Returns:



412
413
414
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 412

def device_secrets
    context.device_secrets
end

#fetch ⇒ DeviceInstance

Fetch the DeviceInstance

Returns:



382
383
384
385
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 382

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



432
433
434
435
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 432

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

#links ⇒ Hash

Returns The absolute URLs of related resources.

Returns:

  • (Hash) —

    The absolute URLs of related resources.



375
376
377
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 375

def links
    @properties['links']
end

#logging ⇒ Hash

Returns Object specifying whether application logging is enabled for this Device. Contains the properties ‘enabled` and `date_expires`.

Returns:

  • (Hash) —

    Object specifying whether application logging is enabled for this Device. Contains the properties ‘enabled` and `date_expires`.



351
352
353
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 351

def logging
    @properties['logging']
end

#sid ⇒ String

Returns A 34-character string that uniquely identifies this Device.

Returns:

  • (String) —

    A 34-character string that uniquely identifies this Device.



327
328
329
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 327

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



425
426
427
428
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 425

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

#unique_name ⇒ String

Returns A developer-defined string that uniquely identifies the Device. This value must be unique for all Devices on this Account. The ‘unique_name` value may be used as an alternative to the `sid` in the URL path to address the resource.

Returns:

  • (String) —

    A developer-defined string that uniquely identifies the Device. This value must be unique for all Devices on this Account. The ‘unique_name` value may be used as an alternative to the `sid` in the URL path to address the resource.



333
334
335
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 333

def unique_name
    @properties['unique_name']
end

#update(unique_name: :unset, target_app: :unset, logging_enabled: :unset, restart_app: :unset) ⇒ DeviceInstance

Update the DeviceInstance

Parameters:

  • unique_name (String) (defaults to: :unset) —

    A unique and addressable name to be assigned to this Device by the developer. It may be used in place of the Device SID.

  • target_app (String) (defaults to: :unset) —

    The SID or unique name of the App to be targeted to the Device.

  • logging_enabled (Boolean) (defaults to: :unset) —

    A Boolean flag specifying whether to enable application logging. Logs will be enabled or extended for 24 hours.

  • restart_app (Boolean) (defaults to: :unset) —

    Set to true to restart the App running on the Device.

Returns:



394
395
396
397
398
399
400
401
402
403
404
405
406
407
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 394

def update(
    unique_name: :unset, 
    target_app: :unset, 
    logging_enabled: :unset, 
    restart_app: :unset
)

    context.update(
        unique_name: unique_name, 
        target_app: target_app, 
        logging_enabled: logging_enabled, 
        restart_app: restart_app, 
    )
end

#url ⇒ String

Returns The URL of this resource.

Returns:

  • (String) —

    The URL of this resource.



369
370
371
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 369

def url
    @properties['url']
end