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_queues_statistics.rb

Defined Under Namespace

Classes: TaskQueueStatisticsContext, TaskQueueStatisticsInstance, TaskQueueStatisticsList, TaskQueueStatisticsPage, TaskQueuesStatisticsInstance, TaskQueuesStatisticsList, TaskQueuesStatisticsPage

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



215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 215

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
  @task_queues_statistics = nil
  @task_queue_statistics = nil
end

Instance Method Details

#delete ⇒ Boolean

Deletes the TaskQueueInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



286
287
288
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 286

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

#fetch ⇒ TaskQueueInstance

Fetch a TaskQueueInstance

Returns:



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

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

#task_queue_statistics ⇒ TaskQueueStatisticsList, TaskQueueStatisticsContext

Access the task_queue_statistics

Returns:



309
310
311
312
313
314
315
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 309

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

#task_queues_statistics ⇒ TaskQueuesStatisticsList, TaskQueuesStatisticsContext

Access the task_queues_statistics

Returns:



294
295
296
297
298
299
300
301
302
303
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 294

def task_queues_statistics
  unless @task_queues_statistics
    @task_queues_statistics = TaskQueuesStatisticsList.new(
        @version,
        workspace_sid: @solution[:workspace_sid],
    )
  end

  @task_queues_statistics
end

#to_s ⇒ Object

Provide a user friendly representation



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

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) —

    The friendly_name

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

    The target_workers

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

    The reservation_activity_sid

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

    The assignment_activity_sid

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

    The max_reserved_workers

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

    The task_order

Returns:



259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 259

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