Class: Twilio::REST::Preview::DeployedDevices::FleetContext::KeyContext

Inherits:
InstanceContext
  • 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, fleet_sid, sid) ⇒ KeyContext

Initialize the KeyContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • fleet_sid (String) —

    The fleet_sid

  • sid (String) —

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



208
209
210
211
212
213
214
215
216
217
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 208

def initialize(version, fleet_sid, sid)
  super(version)

  # Path Solution
  @solution = {
      fleet_sid: fleet_sid,
      sid: sid,
  }
  @uri = "/Fleets/#{@solution[:fleet_sid]}/Keys/#{@solution[:sid]}"
end

Instance Method Details

#delete ⇒ Boolean

Deletes the KeyInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



242
243
244
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 242

def delete
  @version.delete('delete', @uri)
end

#fetch ⇒ KeyInstance

Fetch a KeyInstance

Returns:



222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 222

def fetch
  params = Twilio::Values.of({})

  payload = @version.fetch(
      'GET',
      @uri,
      params,
  )

  KeyInstance.new(
      @version,
      payload,
      fleet_sid: @solution[:fleet_sid],
      sid: @solution[:sid],
  )
end

#to_s ⇒ Object

Provide a user friendly representation



275
276
277
278
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 275

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Preview.DeployedDevices.KeyContext #{context}>"
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:



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

def update(friendly_name: :unset, device_sid: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'DeviceSid' => device_sid,
  })

  payload = @version.update(
      'POST',
      @uri,
      data: data,
  )

  KeyInstance.new(
      @version,
      payload,
      fleet_sid: @solution[:fleet_sid],
      sid: @solution[:sid],
  )
end