Class: Twilio::REST::Preview::DeployedDevices::FleetContext::DeviceInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, fleet_sid: nil, 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
313
314
315
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 293

def initialize(version, payload , fleet_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'sid' => payload['sid'],
        'url' => payload['url'],
        'unique_name' => payload['unique_name'],
        'friendly_name' => payload['friendly_name'],
        'fleet_sid' => payload['fleet_sid'],
        'enabled' => payload['enabled'],
        'account_sid' => payload['account_sid'],
        'identity' => payload['identity'],
        'deployment_sid' => payload['deployment_sid'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'date_authenticated' => Twilio.deserialize_iso8601_datetime(payload['date_authenticated']),
    }

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

Instance Method Details

#account_sid ⇒ String

Returns Specifies the unique string identifier of the Account responsible for this Device.

Returns:

  • (String) —

    Specifies the unique string identifier of the Account responsible for this Device.



366
367
368
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 366

def 
    @properties['account_sid']
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:



321
322
323
324
325
326
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 321

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

#date_authenticated ⇒ Time

Returns Specifies the date this Device was last authenticated, given in UTC ISO 8601 format.

Returns:

  • (Time) —

    Specifies the date this Device was last authenticated, given in UTC ISO 8601 format.



396
397
398
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 396

def date_authenticated
    @properties['date_authenticated']
end

#date_created ⇒ Time

Returns Specifies the date this Device was created, given in UTC ISO 8601 format.

Returns:

  • (Time) —

    Specifies the date this Device was created, given in UTC ISO 8601 format.



384
385
386
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 384

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns Specifies the date this Device was last updated, given in UTC ISO 8601 format.

Returns:

  • (Time) —

    Specifies the date this Device was last updated, given in UTC ISO 8601 format.



390
391
392
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 390

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the DeviceInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



403
404
405
406
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 403

def delete

    context.delete
end

#deployment_sid ⇒ String

Returns Specifies the unique string identifier of the Deployment group that this Device is associated with.

Returns:

  • (String) —

    Specifies the unique string identifier of the Deployment group that this Device is associated with.



378
379
380
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 378

def deployment_sid
    @properties['deployment_sid']
end

#enabled ⇒ Boolean

Returns Contains a boolean flag indicating whether the device is enabled or not, blocks device connectivity if set to false.

Returns:

  • (Boolean) —

    Contains a boolean flag indicating whether the device is enabled or not, blocks device connectivity if set to false.



360
361
362
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 360

def enabled
    @properties['enabled']
end

#fetch ⇒ DeviceInstance

Fetch the DeviceInstance

Returns:



411
412
413
414
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 411

def fetch

    context.fetch
end

#fleet_sid ⇒ String

Returns Specifies the unique string identifier of the Fleet that the given Device belongs to.

Returns:

  • (String) —

    Specifies the unique string identifier of the Fleet that the given Device belongs to.



354
355
356
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 354

def fleet_sid
    @properties['fleet_sid']
end

#friendly_name ⇒ String

Returns Contains a human readable descriptive text for this Device, up to 256 characters long.

Returns:

  • (String) —

    Contains a human readable descriptive text for this Device, up to 256 characters long



348
349
350
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 348

def friendly_name
    @properties['friendly_name']
end

#identity ⇒ String

Returns Contains an arbitrary string identifier representing a human user associated with this Device, assigned by the developer, up to 256 characters long.

Returns:

  • (String) —

    Contains an arbitrary string identifier representing a human user associated with this Device, assigned by the developer, up to 256 characters long.



372
373
374
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 372

def identity
    @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



447
448
449
450
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 447

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

#sid ⇒ String

Returns Contains a 34 character string that uniquely identifies this Device resource.

Returns:

  • (String) —

    Contains a 34 character string that uniquely identifies this Device resource.



330
331
332
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 330

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



440
441
442
443
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 440

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

#unique_name ⇒ String

Returns Contains a unique and addressable name of this Device, assigned by the developer, up to 128 characters long.

Returns:

  • (String) —

    Contains a unique and addressable name of this Device, assigned by the developer, up to 128 characters long.



342
343
344
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 342

def unique_name
    @properties['unique_name']
end

#update(friendly_name: :unset, identity: :unset, deployment_sid: :unset, enabled: :unset) ⇒ DeviceInstance

Update the DeviceInstance

Parameters:

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

    Provides a human readable descriptive text to be assigned to this Device, up to 256 characters long.

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

    Provides an arbitrary string identifier representing a human user to be associated with this Device, up to 256 characters long.

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

    Specifies the unique string identifier of the Deployment group that this Device is going to be associated with.

  • enabled (Boolean) (defaults to: :unset)

Returns:



423
424
425
426
427
428
429
430
431
432
433
434
435
436
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 423

def update(
    friendly_name: :unset, 
    identity: :unset, 
    deployment_sid: :unset, 
    enabled: :unset
)

    context.update(
        friendly_name: friendly_name, 
        identity: identity, 
        deployment_sid: deployment_sid, 
        enabled: enabled, 
    )
end

#url ⇒ String

Returns Contains an absolute URL for this Device resource.

Returns:

  • (String) —

    Contains an absolute URL for this Device resource.



336
337
338
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 336

def url
    @properties['url']
end