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

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.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, 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

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

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

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

    Provides a 34 character string that uniquely identifies the requested Device resource.



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 284

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, 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns The unique SID that identifies this Account.

Returns:

  • (String) —

    The unique SID that identifies this Account.



357
358
359
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 357

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:



312
313
314
315
316
317
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 312

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

#date_authenticated ⇒ Time

Returns The date this Device was authenticated.

Returns:

  • (Time) —

    The date this Device was authenticated.



387
388
389
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 387

def date_authenticated
  @properties['date_authenticated']
end

#date_created ⇒ Time

Returns The date this Device was created.

Returns:

  • (Time) —

    The date this Device was created.



375
376
377
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 375

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this Device was updated.

Returns:

  • (Time) —

    The date this Device was updated.



381
382
383
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 381

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the DeviceInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



401
402
403
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 401

def delete
  context.delete
end

#deployment_sid ⇒ String

Returns The unique SID of the Deployment group.

Returns:

  • (String) —

    The unique SID of the Deployment group.



369
370
371
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 369

def deployment_sid
  @properties['deployment_sid']
end

#enabled ⇒ Boolean

Returns Device enabled flag.

Returns:

  • (Boolean) —

    Device enabled flag.



351
352
353
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 351

def enabled
  @properties['enabled']
end

#fetch ⇒ DeviceInstance

Fetch a DeviceInstance

Returns:



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

def fetch
  context.fetch
end

#fleet_sid ⇒ String

Returns The unique identifier of the Fleet.

Returns:

  • (String) —

    The unique identifier of the Fleet.



345
346
347
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 345

def fleet_sid
  @properties['fleet_sid']
end

#friendly_name ⇒ String

Returns A human readable description for this Device.

Returns:

  • (String) —

    A human readable description for this Device



339
340
341
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 339

def friendly_name
  @properties['friendly_name']
end

#identity ⇒ String

Returns An identifier of the Device user.

Returns:

  • (String) —

    An identifier of the Device user.



363
364
365
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 363

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



433
434
435
436
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 433

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

#sid ⇒ String

Returns A string that uniquely identifies this Device.

Returns:

  • (String) —

    A string that uniquely identifies this Device.



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

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



426
427
428
429
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 426

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

#unique_name ⇒ String

Returns A unique, addressable name of this Device.

Returns:

  • (String) —

    A unique, addressable name of this Device.



333
334
335
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 333

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) —

    The enabled

Returns:



415
416
417
418
419
420
421
422
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 415

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 URL of this Device.

Returns:

  • (String) —

    URL of this Device.



327
328
329
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 327

def url
  @properties['url']
end