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

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

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

  • account_sid (String) —

    The SID of the Account that created this Key resource.

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

    The SID of the Call resource to fetch.



282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 282

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  || @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 Key credential.

Returns:

  • (String) —

    Specifies the unique string identifier of the Account responsible for this Key credential.



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

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

    CallContext for this CallInstance



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

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

#date_created ⇒ Time

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

Returns:

  • (Time) —

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



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

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

Returns:

  • (Time) —

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



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the KeyInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#device_sid ⇒ String

Returns Specifies the unique string identifier of a Device authenticated with this Key credential.

Returns:

  • (String) —

    Specifies the unique string identifier of a Device authenticated with this Key credential.



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

def device_sid
    @properties['device_sid']
end

#fetch ⇒ KeyInstance

Fetch the KeyInstance

Returns:



379
380
381
382
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 379

def fetch

    context.fetch
end

#fleet_sid ⇒ String

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

Returns:

  • (String) —

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



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

def fleet_sid
    @properties['fleet_sid']
end

#friendly_name ⇒ String

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

Returns:

  • (String) —

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



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#secret ⇒ String

Returns Contains the automatically generated secret belonging to this Key credential, used to authenticate the Device.

Returns:

  • (String) —

    Contains the automatically generated secret belonging to this Key credential, used to authenticate the Device.



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

def secret
    @properties['secret']
end

#sid ⇒ String

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

Returns:

  • (String) —

    Contains a 34 character string that uniquely identifies this Key credential resource.



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

def sid
    @properties['sid']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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:



389
390
391
392
393
394
395
396
397
398
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 389

def update(
    friendly_name: :unset, 
    device_sid: :unset
)

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

#url ⇒ String

Returns Contains an absolute URL for this Key credential resource.

Returns:

  • (String) —

    Contains an absolute URL for this Key credential resource.



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

def url
    @properties['url']
end