Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::TaskQueueInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, workspace_sid: nil, sid: nil) ⇒ TaskQueueInstance

Initialize the TaskQueueInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • workspace_sid (String) (defaults to: nil) —

    The ID of the Workspace that owns this TaskQueue

  • sid (String) (defaults to: nil) —

    The sid



370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 370

def initialize(version, payload, workspace_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'assignment_activity_sid' => payload['assignment_activity_sid'],
      'assignment_activity_name' => payload['assignment_activity_name'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'friendly_name' => payload['friendly_name'],
      'max_reserved_workers' => payload['max_reserved_workers'].to_i,
      'reservation_activity_sid' => payload['reservation_activity_sid'],
      'reservation_activity_name' => payload['reservation_activity_name'],
      'sid' => payload['sid'],
      'target_workers' => payload['target_workers'],
      'task_order' => payload['task_order'],
      'url' => payload['url'],
      'workspace_sid' => payload['workspace_sid'],
      'links' => payload['links'],
  }

  # Context
  @instance_context = nil
  @params = {'workspace_sid' => workspace_sid, 'sid' => sid || @properties['sid'], }
end

Instance Method Details

#account_sid ⇒ String

Returns The ID of the Account that owns this TaskQueue.

Returns:

  • (String) —

    The ID of the Account that owns this TaskQueue



410
411
412
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 410

def 
  @properties['account_sid']
end

#assignment_activity_name ⇒ String

Returns The assignment_activity_name.

Returns:

  • (String) —

    The assignment_activity_name



422
423
424
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 422

def assignment_activity_name
  @properties['assignment_activity_name']
end

#assignment_activity_sid ⇒ String

Returns ActivitySID to assign workers once a task is assigned for them.

Returns:

  • (String) —

    ActivitySID to assign workers once a task is assigned for them



416
417
418
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 416

def assignment_activity_sid
  @properties['assignment_activity_sid']
end

#context ⇒ TaskQueueContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



401
402
403
404
405
406
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 401

def context
  unless @instance_context
    @instance_context = TaskQueueContext.new(@version, @params['workspace_sid'], @params['sid'], )
  end
  @instance_context
end

#cumulative_statistics ⇒ cumulative_statistics

Access the cumulative_statistics

Returns:



561
562
563
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 561

def cumulative_statistics
  context.cumulative_statistics
end

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



428
429
430
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 428

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



434
435
436
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 434

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the TaskQueueInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



540
541
542
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 540

def delete
  context.delete
end

#fetch ⇒ TaskQueueInstance

Fetch a TaskQueueInstance

Returns:



501
502
503
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 501

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns Filter by a human readable description of a TaskQueue.

Returns:

  • (String) —

    Filter by a human readable description of a TaskQueue



440
441
442
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 440

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



574
575
576
577
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 574

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Taskrouter.V1.TaskQueueInstance #{values}>"
end

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



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

def links
  @properties['links']
end

#max_reserved_workers ⇒ String

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

Returns:

  • (String) —

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



446
447
448
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 446

def max_reserved_workers
  @properties['max_reserved_workers']
end

#real_time_statistics ⇒ real_time_statistics

Access the real_time_statistics

Returns:



554
555
556
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 554

def real_time_statistics
  context.real_time_statistics
end

#reservation_activity_name ⇒ String

Returns The reservation_activity_name.

Returns:

  • (String) —

    The reservation_activity_name



458
459
460
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 458

def reservation_activity_name
  @properties['reservation_activity_name']
end

#reservation_activity_sid ⇒ String

Returns ActivitySID to assign workers once a task is reserved for them.

Returns:

  • (String) —

    ActivitySID to assign workers once a task is reserved for them



452
453
454
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 452

def reservation_activity_sid
  @properties['reservation_activity_sid']
end

#sid ⇒ String

Returns The unique ID of the TaskQueue.

Returns:

  • (String) —

    The unique ID of the TaskQueue



464
465
466
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 464

def sid
  @properties['sid']
end

#statistics ⇒ statistics

Access the statistics

Returns:



547
548
549
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 547

def statistics
  context.statistics
end

#target_workers ⇒ String

Returns A string describing the Worker selection criteria for any Tasks that enter this TaskQueue.

Returns:

  • (String) —

    A string describing the Worker selection criteria for any Tasks that enter this TaskQueue.



470
471
472
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 470

def target_workers
  @properties['target_workers']
end

#task_order ⇒ task_queue.TaskOrder

Returns TaskOrder will determine which order the Tasks will be assigned to Workers.

Returns:

  • (task_queue.TaskOrder) —

    TaskOrder will determine which order the Tasks will be assigned to Workers.



476
477
478
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 476

def task_order
  @properties['task_order']
end

#to_s ⇒ Object

Provide a user friendly representation



567
568
569
570
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 567

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Taskrouter.V1.TaskQueueInstance #{values}>"
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 to learn more.

Returns:



526
527
528
529
530
531
532
533
534
535
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 526

def update(friendly_name: :unset, target_workers: :unset, reservation_activity_sid: :unset, assignment_activity_sid: :unset, max_reserved_workers: :unset, task_order: :unset)
  context.update(
      friendly_name: friendly_name,
      target_workers: target_workers,
      reservation_activity_sid: reservation_activity_sid,
      assignment_activity_sid: assignment_activity_sid,
      max_reserved_workers: max_reserved_workers,
      task_order: task_order,
  )
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



482
483
484
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 482

def url
  @properties['url']
end

#workspace_sid ⇒ String

Returns The ID of the Workspace that owns this TaskQueue.

Returns:

  • (String) —

    The ID of the Workspace that owns this TaskQueue



488
489
490
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 488

def workspace_sid
  @properties['workspace_sid']
end