Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::TaskQueueContext

Inherits:
InstanceContext
  • Object
show all
Defined in:
lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_statistics.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_real_time_statistics.rb,
lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb

Defined Under Namespace

Classes: TaskQueueCumulativeStatisticsContext, TaskQueueCumulativeStatisticsInstance, TaskQueueCumulativeStatisticsList, TaskQueueCumulativeStatisticsPage, TaskQueueRealTimeStatisticsContext, TaskQueueRealTimeStatisticsInstance, TaskQueueRealTimeStatisticsList, TaskQueueRealTimeStatisticsPage, TaskQueueStatisticsContext, TaskQueueStatisticsInstance, TaskQueueStatisticsList, TaskQueueStatisticsPage

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid, sid) ⇒ TaskQueueContext

Initialize the TaskQueueContext

Parameters:

  • version (Version) —

    Version that contains the resource

  • workspace_sid (String) —

    The workspace_sid

  • sid (String) —

    The sid



238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 238

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

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

  # Dependents
  @statistics = nil
  @real_time_statistics = nil
  @cumulative_statistics = nil
end

Instance Method Details

#cumulative_statistics ⇒ TaskQueueCumulativeStatisticsList, TaskQueueCumulativeStatisticsContext

Access the cumulative_statistics

Returns:



343
344
345
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 343

def cumulative_statistics
  TaskQueueCumulativeStatisticsContext.new(@version, @solution[:workspace_sid], @solution[:sid], )
end

#delete ⇒ Boolean

Deletes the TaskQueueInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

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

#fetch ⇒ TaskQueueInstance

Fetch a TaskQueueInstance

Returns:



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

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

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

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

#inspect ⇒ Object

Provide a detailed, user friendly representation



356
357
358
359
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 356

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

#real_time_statistics ⇒ TaskQueueRealTimeStatisticsList, TaskQueueRealTimeStatisticsContext

Access the real_time_statistics

Returns:



335
336
337
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 335

def real_time_statistics
  TaskQueueRealTimeStatisticsContext.new(@version, @solution[:workspace_sid], @solution[:sid], )
end

#statistics ⇒ TaskQueueStatisticsList, TaskQueueStatisticsContext

Access the statistics

Returns:



327
328
329
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 327

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

#to_s ⇒ Object

Provide a user friendly representation



349
350
351
352
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 349

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

#update(friendly_name: :unset, target_workers: :unset, reservation_activity_sid: :unset, assignment_activity_sid: :unset, max_reserved_workers: :unset, task_order: :unset) ⇒ TaskQueueInstance

Update the TaskQueueInstance

Parameters:

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

    Human readable description of this TaskQueue (for example “Support – Tier 1”, “Sales” or “Escalation”)

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

    A string describing the Worker selection criteria for any Tasks that enter this TaskQueue. For example ‘“language” == “spanish”’ If no TargetWorkers parameter is provided, Tasks will wait in this queue until they are either deleted or moved to another queue. Additional examples on how to describing Worker selection criteria below.

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

    ActivitySID that will be assigned to Workers when they are reserved for a task from this TaskQueue.

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

    ActivitySID that will be assigned to Workers when they are assigned a task from this TaskQueue.

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

    The maximum amount of workers to create reservations for the assignment of a task while in this queue. Maximum of 50.

  • task_order (task_queue.TaskOrder) (defaults to: :unset) —

    TaskOrder will determine which order the Tasks will be assigned to Workers. Set this parameter to LIFO to assign most recently created Task first or FIFO to assign the oldest Task. Default is FIFO. [Click here](www.twilio.com/docs/api/taskrouter/last-first-out-lifo) to learn more.

Returns:



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

def update(friendly_name: :unset, target_workers: :unset, reservation_activity_sid: :unset, assignment_activity_sid: :unset, max_reserved_workers: :unset, task_order: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'TargetWorkers' => target_workers,
      'ReservationActivitySid' => reservation_activity_sid,
      'AssignmentActivitySid' => assignment_activity_sid,
      'MaxReservedWorkers' => max_reserved_workers,
      'TaskOrder' => task_order,
  })

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

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