Class: Twilio::REST::Preview::DeployedDevices::FleetContext::CertificateInstance

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

Initialize the CertificateInstance

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

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

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


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

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'],
      'thumbprint' => payload['thumbprint'],
      '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.


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

def 
  @properties['account_sid']
end

#context ⇒ CertificateContext

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

Returns:


278
279
280
281
282
283
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb', line 278

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

#date_created ⇒ Time

Returns The date this Certificate was created.

Returns:

  • (Time) —

    The date this Certificate was created.


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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date this Certificate was updated.

Returns:

  • (Time) —

    The date this Certificate was updated.


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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Delete the CertificateInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise


349
350
351
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb', line 349

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.


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

def device_sid
  @properties['device_sid']
end

#fetch ⇒ CertificateInstance

Fetch the CertificateInstance

Returns:


342
343
344
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb', line 342

def fetch
  context.fetch
end

#fleet_sid ⇒ String

Returns The unique identifier of the Fleet.

Returns:

  • (String) —

    The unique identifier of the Fleet.


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

def fleet_sid
  @properties['fleet_sid']
end

#friendly_name ⇒ String

Returns A human readable description for this Certificate.

Returns:

  • (String) —

    A human readable description for this Certificate.


299
300
301
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb', line 299

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation


373
374
375
376
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb', line 373

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

#sid ⇒ String

Returns A string that uniquely identifies this Certificate.

Returns:

  • (String) —

    A string that uniquely identifies this Certificate.


287
288
289
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb', line 287

def sid
  @properties['sid']
end

#thumbprint ⇒ String

Returns A Certificate unique payload hash.

Returns:

  • (String) —

    A Certificate unique payload hash.


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

def thumbprint
  @properties['thumbprint']
end

#to_s ⇒ Object

Provide a user friendly representation


366
367
368
369
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb', line 366

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

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

Update the CertificateInstance

Parameters:

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

    Provides a human readable descriptive text for this Certificate 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 Certificate credential.

Returns:


360
361
362
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb', line 360

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

Returns:

  • (String) —

    URL of this Certificate.


293
294
295
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.rb', line 293

def url
  @properties['url']
end