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

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb,
lib/twilio-ruby/rest/preview/deployed_devices/fleet/key.rb,
lib/twilio-ruby/rest/preview/deployed_devices/fleet/device.rb,
lib/twilio-ruby/rest/preview/deployed_devices/fleet/deployment.rb,
lib/twilio-ruby/rest/preview/deployed_devices/fleet/certificate.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: CertificateContext, CertificateInstance, CertificateList, CertificatePage, DeploymentContext, DeploymentInstance, DeploymentList, DeploymentPage, DeviceContext, DeviceInstance, DeviceList, DevicePage, KeyContext, KeyInstance, KeyList, KeyPage

Instance Method Summary collapse

Constructor Details

#initialize(version, sid) ⇒ FleetContext

Initialize the FleetContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • sid (String) —

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



188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 188

def initialize(version, sid)
  super(version)

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

  # Dependents
  @devices = nil
  @deployments = nil
  @certificates = nil
  @keys = nil
end

Instance Method Details

#certificates(sid = :unset) ⇒ CertificateList, CertificateContext

Access the certificates

Returns:

Raises:

  • (ArgumentError) 


310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 310

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

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

  unless @certificates
    @certificates = CertificateList.new(
        @version,
        fleet_sid: @solution[:sid],
    )
  end

  @certificates
end

#delete ⇒ Boolean

Deletes the FleetInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



226
227
228
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 226

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

#deployments(sid = :unset) ⇒ DeploymentList, DeploymentContext

Access the deployments

Returns:

Raises:

  • (ArgumentError) 


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 285

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

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

  unless @deployments
    @deployments = DeploymentList.new(
        @version,
        fleet_sid: @solution[:sid],
    )
  end

  @deployments
end

#devices(sid = :unset) ⇒ DeviceList, DeviceContext

Access the devices

Returns:

Raises:

  • (ArgumentError) 


260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 260

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

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

  unless @devices
    @devices = DeviceList.new(
        @version,
        fleet_sid: @solution[:sid],
    )
  end

  @devices
end

#fetch ⇒ FleetInstance

Fetch a FleetInstance

Returns:



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

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

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

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

#keys(sid = :unset) ⇒ KeyList, KeyContext

Access the keys

Returns:

Raises:

  • (ArgumentError) 


335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 335

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

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

  unless @keys
    @keys = KeyList.new(
        @version,
        fleet_sid: @solution[:sid],
    )
  end

  @keys
end

#to_s ⇒ Object

Provide a user friendly representation



358
359
360
361
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 358

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

#update(friendly_name: :unset, default_deployment_sid: :unset) ⇒ FleetInstance

Update the FleetInstance

Parameters:

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

    Provides a human readable descriptive text for this Fleet, up to 256 characters long.

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

    Provides a string identifier of a Deployment that is going to be used as a default one for this Fleet.

Returns:



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/twilio-ruby/rest/preview/deployed_devices/fleet.rb', line 237

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

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

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