Class: Twilio::REST::Preview::DeployedDevices::FleetContext::KeyInstance

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

Initialize the KeyInstance

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 Key credential belongs to.

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

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



255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 255

def initialize(version, payload, fleet_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'sid' => payload['sid'],
      'url' => payload['url'],
      'friendly_name' => payload['friendly_name'],
      'fleet_sid' => payload['fleet_sid'],
      'account_sid' => payload['account_sid'],
      'device_sid' => payload['device_sid'],
      'secret' => payload['secret'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
  }

  # 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.



313
314
315
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 313

def 
  @properties['account_sid']
end

#context ⇒ KeyContext

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

Returns:

  • (KeyContext) —

    KeyContext for this KeyInstance



280
281
282
283
284
285
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 280

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

#date_created ⇒ Time

Returns The date this Key credential was created.

Returns:

  • (Time) —

    The date this Key credential was created.



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this Key credential was updated.

Returns:

  • (Time) —

    The date this Key credential was updated.



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the KeyInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#device_sid ⇒ String

Returns The unique identifier of a mapped Device.

Returns:

  • (String) —

    The unique identifier of a mapped Device.



319
320
321
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 319

def device_sid
  @properties['device_sid']
end

#fetch ⇒ KeyInstance

Fetch a KeyInstance

Returns:



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

def fetch
  context.fetch
end

#fleet_sid ⇒ String

Returns The unique identifier of the Fleet.

Returns:

  • (String) —

    The unique identifier of the Fleet.



307
308
309
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 307

def fleet_sid
  @properties['fleet_sid']
end

#friendly_name ⇒ String

Returns A human readable description for this Key.

Returns:

  • (String) —

    A human readable description for this Key.



301
302
303
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 301

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#secret ⇒ String

Returns The key secret.

Returns:

  • (String) —

    The key secret.



325
326
327
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 325

def secret
  @properties['secret']
end

#sid ⇒ String

Returns A string that uniquely identifies this Key.

Returns:

  • (String) —

    A string that uniquely identifies this Key.



289
290
291
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 289

def sid
  @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#update(friendly_name: :unset, device_sid: :unset) ⇒ KeyInstance

Update the KeyInstance

Parameters:

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

    Provides a human readable descriptive text for this Key credential, up to 256 characters long.

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

    Provides the unique string identifier of an existing Device to become authenticated with this Key credential.

Returns:



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

def update(friendly_name: :unset, device_sid: :unset)
  context.update(friendly_name: friendly_name, device_sid: device_sid)
end

#url ⇒ String

Returns URL of this Key.

Returns:

  • (String) —

    URL of this Key.



295
296
297
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 295

def url
  @properties['url']
end