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 SID of the Workspace that contains the TaskQueue.

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

    The SID of the TaskQueue resource to fetch.



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 377

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 SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



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

def 
  @properties['account_sid']
end

#assignment_activity_name ⇒ String

Returns The name of the Activity to assign Workers when a task is assigned for them.

Returns:

  • (String) —

    The name of the Activity to assign Workers when a task is assigned for them



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

def assignment_activity_name
  @properties['assignment_activity_name']
end

#assignment_activity_sid ⇒ String

Returns The SID of the Activity to assign Workers when a task is assigned for them.

Returns:

  • (String) —

    The SID of the Activity to assign Workers when a task is assigned for them



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

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:



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

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:



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

def cumulative_statistics
  context.cumulative_statistics
end

#date_created ⇒ Time

Returns The RFC 2822 date and time in GMT when the resource was created.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The RFC 2822 date and time in GMT when the resource was last updated.

Returns:

  • (Time) —

    The RFC 2822 date and time in GMT when the resource was last updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the TaskQueueInstance

Returns:

  • (Boolean) —

    true if delete succeeds, false otherwise



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

def delete
  context.delete
end

#fetch ⇒ TaskQueueInstance

Fetch a TaskQueueInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The string that you assigned to describe the resource.

Returns:

  • (String) —

    The string that you assigned to describe the resource



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



581
582
583
584
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 581

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

#links ⇒ String

Returns The URLs of related resources.

Returns:

  • (String) —

    The URLs of related resources



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

def links
  @properties['links']
end

#max_reserved_workers ⇒ String

Returns The maximum number of Workers to reserve.

Returns:

  • (String) —

    The maximum number of Workers to reserve



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

def max_reserved_workers
  @properties['max_reserved_workers']
end

#real_time_statistics ⇒ real_time_statistics

Access the real_time_statistics

Returns:



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

def real_time_statistics
  context.real_time_statistics
end

#reservation_activity_name ⇒ String

Returns The name of the Activity to assign Workers once a task is reserved for them.

Returns:

  • (String) —

    The name of the Activity to assign Workers once a task is reserved for them



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

def reservation_activity_name
  @properties['reservation_activity_name']
end

#reservation_activity_sid ⇒ String

Returns The SID of the Activity to assign Workers once a task is reserved for them.

Returns:

  • (String) —

    The SID of the Activity to assign Workers once a task is reserved for them



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

def reservation_activity_sid
  @properties['reservation_activity_sid']
end

#sid ⇒ String

Returns The unique string that identifies the resource.

Returns:

  • (String) —

    The unique string that identifies the resource



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

def sid
  @properties['sid']
end

#statistics ⇒ statistics

Access the statistics

Returns:



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

def statistics
  context.statistics
end

#target_workers ⇒ String

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

Returns:

  • (String) —

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



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

def target_workers
  @properties['target_workers']
end

#task_order ⇒ task_queue.TaskOrder

Returns How Tasks will be assigned to Workers.

Returns:

  • (task_queue.TaskOrder) —

    How Tasks will be assigned to Workers



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

def task_order
  @properties['task_order']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

    A descriptive string that you create to describe the 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 the TaskQueue. For example ‘“language” == “spanish”’ If no TargetWorkers parameter is provided, Tasks will wait in the 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) —

    The SID of the Activity to assign Workers when a task is reserved for them.

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

    The SID of the Activity to assign Workers when a task is assigned for them.

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

    The maximum number of Workers to create reservations for the assignment of a task while in the queue. Maximum of 50.

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

    How Tasks will be assigned to Workers. Can be: ‘FIFO` or `LIFO` and the default is `FIFO`. Use `FIFO` to assign the oldest task first and `LIFO` to assign the most recent task first. For more information, see [Queue Ordering](www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo).

Returns:



533
534
535
536
537
538
539
540
541
542
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 533

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 absolute URL of the TaskQueue resource.

Returns:

  • (String) —

    The absolute URL of the TaskQueue resource



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

def url
  @properties['url']
end

#workspace_sid ⇒ String

Returns The SID of the Workspace that contains the TaskQueue.

Returns:

  • (String) —

    The SID of the Workspace that contains the TaskQueue



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

def workspace_sid
  @properties['workspace_sid']
end