Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::WorkerContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/reservation.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_channel.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/worker_statistics.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_statistics.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_cumulative_statistics.rb

Defined Under Namespace

Classes: ReservationContext, ReservationInstance, ReservationList, ReservationPage, WorkerChannelContext, WorkerChannelInstance, WorkerChannelList, WorkerChannelPage, WorkerStatisticsContext, WorkerStatisticsInstance, WorkerStatisticsList, WorkerStatisticsPage, WorkersCumulativeStatisticsContext, WorkersCumulativeStatisticsInstance, WorkersCumulativeStatisticsList, WorkersCumulativeStatisticsPage, WorkersRealTimeStatisticsContext, WorkersRealTimeStatisticsInstance, WorkersRealTimeStatisticsList, WorkersRealTimeStatisticsPage

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid, sid) ⇒ WorkerContext

Initialize the WorkerContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • workspace_sid (String) —

    The workspace_sid

  • sid (String) —

    The sid



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 252

def initialize(version, workspace_sid, sid)
  super(version)

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

  # Dependents
  @workers_real_time_statistics = nil
  @workers_cumulative_statistics = nil
  @statistics = nil
  @reservations = nil
  @worker_channels = nil
end

Instance Method Details

#delete ⇒ Boolean

Deletes the WorkerInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



320
321
322
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 320

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

#fetch ⇒ WorkerInstance

Fetch a WorkerInstance

Returns:



273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 273

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

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

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

#reservations(sid = :unset) ⇒ ReservationList, ReservationContext

Access the reservations

Returns:

Raises:

  • (ArgumentError) 


362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 362

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

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

  unless @reservations
    @reservations = ReservationList.new(
        @version,
        workspace_sid: @solution[:workspace_sid],
        worker_sid: @solution[:sid],
    )
  end

  @reservations
end

#statistics ⇒ WorkerStatisticsList, WorkerStatisticsContext

Access the statistics

Returns:



350
351
352
353
354
355
356
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 350

def statistics
  WorkerStatisticsContext.new(
      @version,
      @solution[:workspace_sid],
      @solution[:sid],
  )
end

#to_s ⇒ Object

Provide a user friendly representation



414
415
416
417
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 414

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

#update(activity_sid: :unset, attributes: :unset, friendly_name: :unset) ⇒ WorkerInstance

Update the WorkerInstance

Parameters:

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

    The activity_sid

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

    The attributes

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

    The friendly_name

Returns:



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 296

def update(activity_sid: :unset, attributes: :unset, friendly_name: :unset)
  data = Twilio::Values.of({
      'ActivitySid' => activity_sid,
      'Attributes' => attributes,
      'FriendlyName' => friendly_name,
  })

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

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

#worker_channels(sid = :unset) ⇒ WorkerChannelList, WorkerChannelContext

Access the worker_channels

Returns:

Raises:

  • (ArgumentError) 


389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 389

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

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

  unless @worker_channels
    @worker_channels = WorkerChannelList.new(
        @version,
        workspace_sid: @solution[:workspace_sid],
        worker_sid: @solution[:sid],
    )
  end

  @worker_channels
end

#workers_cumulative_statistics ⇒ WorkersCumulativeStatisticsList, WorkersCumulativeStatisticsContext

Access the workers_cumulative_statistics

Returns:



339
340
341
342
343
344
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 339

def workers_cumulative_statistics
  WorkersCumulativeStatisticsContext.new(
      @version,
      @solution[:workspace_sid],
  )
end

#workers_real_time_statistics ⇒ WorkersRealTimeStatisticsList, WorkersRealTimeStatisticsContext

Access the workers_real_time_statistics

Returns:



328
329
330
331
332
333
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 328

def workers_real_time_statistics
  WorkersRealTimeStatisticsContext.new(
      @version,
      @solution[:workspace_sid],
  )
end