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

Inherits:
InstanceContext show all
Defined in:
lib/twilio-ruby/rest/microvisor/v1/device.rb,
lib/twilio-ruby/rest/microvisor/v1/device/device_config.rb,
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].

Defined Under Namespace

Classes: DeviceConfigContext, DeviceConfigInstance, DeviceConfigList, DeviceConfigPage, DeviceSecretContext, DeviceSecretInstance, DeviceSecretList, DeviceSecretPage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ DeviceContext

Initialize the DeviceContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

    A 34-character string that uniquely identifies this Device.



154
155
156
157
158
159
160
161
162
163
164
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 154

def initialize(version, sid)
  super(version)

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

  # Dependents
  @device_configs = nil
  @device_secrets = nil
end

Instance Method Details

#device_configs(key = :unset) ⇒ DeviceConfigList, DeviceConfigContext

Access the device_configs

Returns:

Raises:

  • (ArgumentError) 


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

def device_configs(key=:unset)
  raise ArgumentError, 'key cannot be nil' if key.nil?

  if key != :unset
    return DeviceConfigContext.new(@version, @solution[:sid], key, )
  end

  unless @device_configs
    @device_configs = DeviceConfigList.new(@version, device_sid: @solution[:sid], )
  end

  @device_configs
end

#device_secrets(key = :unset) ⇒ DeviceSecretList, DeviceSecretContext

Access the device_secrets

Returns:

Raises:

  • (ArgumentError) 


218
219
220
221
222
223
224
225
226
227
228
229
230
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 218

def device_secrets(key=:unset)
  raise ArgumentError, 'key cannot be nil' if key.nil?

  if key != :unset
    return DeviceSecretContext.new(@version, @solution[:sid], key, )
  end

  unless @device_secrets
    @device_secrets = DeviceSecretList.new(@version, device_sid: @solution[:sid], )
  end

  @device_secrets
end

#fetch ⇒ DeviceInstance

Fetch the DeviceInstance

Returns:



169
170
171
172
173
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 169

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



241
242
243
244
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 241

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

#to_s ⇒ Object

Provide a user friendly representation



234
235
236
237
 
# File 'lib/twilio-ruby/rest/microvisor/v1/device.rb', line 234

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

#update(unique_name: :unset, target_app: :unset, logging_enabled: :unset) ⇒ DeviceInstance

Update the DeviceInstance

Parameters:

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

    A unique and addressable name to be assigned to this Device by the developer. It may be used in place of the Device SID.

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

    The SID or unique name of the App to be targeted to the Device.

  • logging_enabled (Boolean) (defaults to: :unset) —

    A Boolean flag specifying whether to enable application logging. Logs will be enabled or extended for 24 hours.

Returns:



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

def update(unique_name: :unset, target_app: :unset, logging_enabled: :unset)
  data = Twilio::Values.of({
      'UniqueName' => unique_name,
      'TargetApp' => target_app,
      'LoggingEnabled' => logging_enabled,
  })

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

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