Class: Twilio::REST::Microvisor::V1::DeviceContext::DeviceSecretInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/microvisor/v1/device/device_secret.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, device_sid: nil, key: nil) ⇒ DeviceSecretInstance

Initialize the DeviceSecretInstance

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 DeviceSecret resource.

  • sid (String) —

    The SID of the Call resource to fetch.



266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_secret.rb', line 266

def initialize(version, payload , device_sid: nil, key: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'device_sid' => payload['device_sid'],
        'key' => payload['key'],
        'date_rotated' => Twilio.deserialize_iso8601_datetime(payload['date_rotated']),
        'url' => payload['url'],
    }

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

Instance Method Details

#context ⇒ DeviceSecretContext

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

Returns:



286
287
288
289
290
291
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_secret.rb', line 286

def context
    unless @instance_context
        @instance_context = DeviceSecretContext.new(@version , @params['device_sid'], @params['key'])
    end
    @instance_context
end

#date_rotated ⇒ Time

Returns:

  • (Time) 


307
308
309
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_secret.rb', line 307

def date_rotated
    @properties['date_rotated']
end

#delete ⇒ Boolean

Delete the DeviceSecretInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



320
321
322
323
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_secret.rb', line 320

def delete

    context.delete
end

#device_sid ⇒ String

Returns A 34-character string that uniquely identifies the parent Device.

Returns:

  • (String) —

    A 34-character string that uniquely identifies the parent Device.



295
296
297
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_secret.rb', line 295

def device_sid
    @properties['device_sid']
end

#fetch ⇒ DeviceSecretInstance

Fetch the DeviceSecretInstance

Returns:



328
329
330
331
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_secret.rb', line 328

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



355
356
357
358
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_secret.rb', line 355

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

#key ⇒ String

Returns The secret key; up to 100 characters.

Returns:

  • (String) —

    The secret key; up to 100 characters.



301
302
303
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_secret.rb', line 301

def key
    @properties['key']
end

#to_s ⇒ Object

Provide a user friendly representation



348
349
350
351
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_secret.rb', line 348

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

#update(value: nil) ⇒ DeviceSecretInstance

Update the DeviceSecretInstance

Parameters:

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

    The secret value; up to 4096 characters.

Returns:



337
338
339
340
341
342
343
344
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_secret.rb', line 337

def update(
    value: nil
)

    context.update(
        value: value, 
    )
end

#url ⇒ String

Returns The absolute URL of the Secret.

Returns:

  • (String) —

    The absolute URL of the Secret.



313
314
315
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_secret.rb', line 313

def url
    @properties['url']
end