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.


181
182
183
184
185
186
187
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 181

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

#deleteBoolean

Delete the KeyInstance

Returns:

  • (Boolean)

    true if delete succeeds, false otherwise


201
202
203
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 201

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

#fetchKeyInstance

Fetch the KeyInstance

Returns:


192
193
194
195
196
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 192

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

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

#inspectObject

Provide a detailed, user friendly representation


229
230
231
232
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 229

def inspect
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Preview.DeployedDevices.KeyContext #{context}>"
end

#to_sObject

Provide a user friendly representation


222
223
224
225
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb', line 222

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:


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

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