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.


267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 267

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.


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

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:


295
296
297
298
299
300
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 295

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.


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

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.


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

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.


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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the DeviceInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


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

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.


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

def deployment_sid
  @properties['deployment_sid']
end

#enabled ⇒ Boolean

Returns Device enabled flag.

Returns:

  • (Boolean) —

    Device enabled flag.


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

def enabled
  @properties['enabled']
end

#fetch ⇒ DeviceInstance

Fetch the DeviceInstance

Returns:


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

def fetch
  context.fetch
end

#fleet_sid ⇒ String

Returns The unique identifier of the Fleet.

Returns:

  • (String) —

    The unique identifier of the Fleet.


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

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


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

def friendly_name
  @properties['friendly_name']
end

#identity ⇒ String

Returns An identifier of the Device user.

Returns:

  • (String) —

    An identifier of the Device user.


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

def identity
  @properties['identity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


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

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.


304
305
306
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 304

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation


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

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.


316
317
318
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 316

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:


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

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.


310
311
312
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb', line 310

def url
  @properties['url']
end