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, TaskQueueCumulativeStatisticsInstanceMetadata, TaskQueueCumulativeStatisticsList, TaskQueueCumulativeStatisticsListResponse, TaskQueueCumulativeStatisticsPage, TaskQueueCumulativeStatisticsPageMetadata, TaskQueueRealTimeStatisticsContext, TaskQueueRealTimeStatisticsInstance, TaskQueueRealTimeStatisticsInstanceMetadata, TaskQueueRealTimeStatisticsList, TaskQueueRealTimeStatisticsListResponse, TaskQueueRealTimeStatisticsPage, TaskQueueRealTimeStatisticsPageMetadata, TaskQueueStatisticsContext, TaskQueueStatisticsInstance, TaskQueueStatisticsInstanceMetadata, TaskQueueStatisticsList, TaskQueueStatisticsListResponse, TaskQueueStatisticsPage, TaskQueueStatisticsPageMetadata

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid, sid) ⇒ TaskQueueContext

Initialize the TaskQueueContext



298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 298

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
    @cumulative_statistics = nil
    @statistics = nil
    @real_time_statistics = nil
end

Instance Method Details

#cumulative_statistics ⇒ TaskQueueCumulativeStatisticsList, TaskQueueCumulativeStatisticsContext

Access the cumulative_statistics



483
484
485
486
487
488
489
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 483

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

#delete ⇒ Boolean

Delete the TaskQueueInstance



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

def delete

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    

    @version.delete('DELETE', @uri, headers: headers)
end

#delete_with_metadata ⇒ Boolean

Delete the TaskQueueInstanceMetadata



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 327

def delete_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
      response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
      taskQueue_instance = TaskQueueInstance.new(
          @version,
          response.body,
          account_sid: @solution[:account_sid],
          sid: @solution[:sid],
      )
      TaskQueueInstanceMetadata.new(@version, taskQueue_instance, response.headers, response.status_code)
end

#fetch ⇒ TaskQueueInstance

Fetch the TaskQueueInstance



346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 346

def fetch

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.fetch('GET', @uri, headers: headers)
    TaskQueueInstance.new(
        @version,
        payload,
        workspace_sid: @solution[:workspace_sid],
        sid: @solution[:sid],
    )
end

#fetch_with_metadata ⇒ TaskQueueInstance

Fetch the TaskQueueInstanceMetadata



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 366

def fetch_with_metadata

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.fetch_with_metadata('GET', @uri, headers: headers)
    task_queue_instance = TaskQueueInstance.new(
        @version,
        response.body,
        workspace_sid: @solution[:workspace_sid],
        sid: @solution[:sid],
    )
    TaskQueueInstanceMetadata.new(
        @version,
        task_queue_instance,
        response.headers,
        response.status_code
    )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



522
523
524
525
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 522

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



505
506
507
508
509
510
511
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 505

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

#statistics ⇒ TaskQueueStatisticsList, TaskQueueStatisticsContext

Access the statistics



494
495
496
497
498
499
500
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 494

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

#to_s ⇒ Object

Provide a user friendly representation



515
516
517
518
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 515

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



398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 398

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,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.update('POST', @uri, data: data, headers: headers)
    TaskQueueInstance.new(
        @version,
        payload,
        workspace_sid: @solution[:workspace_sid],
        sid: @solution[:sid],
    )
end

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

Update the TaskQueueInstanceMetadata



440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 440

def update_with_metadata(
  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,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
    task_queue_instance = TaskQueueInstance.new(
        @version,
        response.body,
        workspace_sid: @solution[:workspace_sid],
        sid: @solution[:sid],
    )
    TaskQueueInstanceMetadata.new(
        @version,
        task_queue_instance,
        response.headers,
        response.status_code
    )
end