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

  • account_sid (String) —

    The SID of the Account that created this TaskQueue resource.

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

    The SID of the Call resource to fetch.



359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 359

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'] == nil ? payload['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  || @properties['workspace_sid']  ,'sid' => sid  || @properties['sid']  , }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the TaskQueue resource.

Returns:



399
400
401
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 399

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.



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

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.



405
406
407
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 405

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:



390
391
392
393
394
395
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 390

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:



534
535
536
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 534

def cumulative_statistics
    context.cumulative_statistics
end

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [RFC 2822](www.ietf.org/rfc/rfc2822.txt) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the TaskQueueInstance

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete

    context.delete
end

#fetch ⇒ TaskQueueInstance

Fetch the TaskQueueInstance

Returns:



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

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.



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ Hash

Returns The URLs of related resources.

Returns:

  • (Hash) —

    The URLs of related resources.



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

def links
    @properties['links']
end

#max_reserved_workers ⇒ String

Returns The maximum number of Workers to reserve for the assignment of a task in the queue. Can be an integer between 1 and 50, inclusive and defaults to 1.

Returns:

  • (String) —

    The maximum number of Workers to reserve for the assignment of a task in the queue. Can be an integer between 1 and 50, inclusive and defaults to 1.



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

def max_reserved_workers
    @properties['max_reserved_workers']
end

#real_time_statistics ⇒ real_time_statistics

Access the real_time_statistics

Returns:



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

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.



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

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.



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

def reservation_activity_sid
    @properties['reservation_activity_sid']
end

#sid ⇒ String

Returns The unique string that we created to identify the TaskQueue resource.

Returns:

  • (String) —

    The unique string that we created to identify the TaskQueue resource.



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

def sid
    @properties['sid']
end

#statistics ⇒ statistics

Access the statistics

Returns:



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

def statistics
    context.statistics
end

#target_workers ⇒ String

Returns 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 TaskQueue until they are either deleted or moved to another TaskQueue. Additional examples on how to describing Worker selection criteria below. Defaults to 1==1.

Returns:

  • (String) —

    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 TaskQueue until they are either deleted or moved to another TaskQueue. Additional examples on how to describing Worker selection criteria below. Defaults to 1==1.



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

def target_workers
    @properties['target_workers']
end

#task_order ⇒ TaskOrder

Returns:

  • (TaskOrder) 


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

def task_order
    @properties['task_order']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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 (TaskOrder) (defaults to: :unset)

Returns:



512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 512

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.



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

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.



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

def workspace_sid
    @properties['workspace_sid']
end