Class: Twilio::REST::Microvisor::V1::DeviceContext::DeviceSecretContext

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

Initialize the DeviceSecretContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • device_sid (String) —

    A 34-character string that uniquely identifies the Device.

  • key (String) —

    The secret key; up to 100 characters.



160
161
162
163
164
165
166
167
168
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_secret.rb', line 160

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

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

    
end

Instance Method Details

#delete ⇒ Boolean

Delete the DeviceSecretInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

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

#fetch ⇒ DeviceSecretInstance

Fetch the DeviceSecretInstance

Returns:



180
181
182
183
184
185
186
187
188
189
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_secret.rb', line 180

def fetch

    payload = @version.fetch('GET', @uri)
    DeviceSecretInstance.new(
        @version,
        payload,
        device_sid: @solution[:device_sid],
        key: @solution[:key],
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



222
223
224
225
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_secret.rb', line 222

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

#to_s ⇒ Object

Provide a user friendly representation



215
216
217
218
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device/device_secret.rb', line 215

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

#update(value: nil) ⇒ DeviceSecretInstance

Update the DeviceSecretInstance

Parameters:

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

    The secret value; up to 4096 characters.

Returns:



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

def update(
    value: nil
)

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

    payload = @version.update('POST', @uri, data: data)
    DeviceSecretInstance.new(
        @version,
        payload,
        device_sid: @solution[:device_sid],
        key: @solution[:key],
    )
end