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



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 229

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:



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

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



301
302
303
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 301

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

#fetch ⇒ TaskQueueInstance

Fetch a TaskQueueInstance

Returns:



248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 248

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

#real_time_statistics ⇒ TaskQueueRealTimeStatisticsList, TaskQueueRealTimeStatisticsContext

Access the real_time_statistics

Returns:



321
322
323
324
325
326
327
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 321

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

#statistics ⇒ TaskQueueStatisticsList, TaskQueueStatisticsContext

Access the statistics

Returns:



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

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

#to_s ⇒ Object

Provide a user friendly representation



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

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:



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 274

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