Class: Twilio::REST::Microvisor::V1::DeviceContext::DeviceConfigContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/microvisor/v1/device/device_config.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, device_sid, key) ⇒ DeviceConfigContext

Initialize the DeviceConfigContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • device_sid (String) —

    A 34-character string that uniquely identifies the Device.

  • key (String) —

    The config key; up to 100 characters.



172
173
174
175
176
177
178
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 172

def initialize(version, device_sid, key)
  super(version)

  # Path Solution
  @solution = {device_sid: device_sid, key: key, }
  @uri = "/Devices/#{@solution[:device_sid]}/Configs/#{@solution[:key]}"
end

Instance Method Details

#delete ⇒ Boolean

Delete the DeviceConfigInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



214
215
216
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 214

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

#fetch ⇒ DeviceConfigInstance

Fetch the DeviceConfigInstance

Returns:



183
184
185
186
187
188
189
190
191
192
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 183

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

  DeviceConfigInstance.new(
      @version,
      payload,
      device_sid: @solution[:device_sid],
      key: @solution[:key],
  )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



227
228
229
230
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 227

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

#to_s ⇒ Object

Provide a user friendly representation



220
221
222
223
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 220

def to_s
  context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
  "#<Twilio.Microvisor.V1.DeviceConfigContext #{context}>"
end

#update(value: nil) ⇒ DeviceConfigInstance

Update the DeviceConfigInstance

Parameters:

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

    The config value; up to 4096 characters.

Returns:



198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb', line 198

def update(value: nil)
  data = Twilio::Values.of({'Value' => value, })

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

  DeviceConfigInstance.new(
      @version,
      payload,
      device_sid: @solution[:device_sid],
      key: @solution[:key],
  )
end