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



376
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
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 376

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 



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

def 
    @properties['account_sid']
end

#assignment_activity_name ⇒ String 



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

def assignment_activity_name
    @properties['assignment_activity_name']
end

#assignment_activity_sid ⇒ String 



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

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



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

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



551
552
553
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 551

def cumulative_statistics
    context.cumulative_statistics
end

#date_created ⇒ Time 



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the TaskQueueInstance



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

def delete

    context.delete
end

#fetch ⇒ TaskQueueInstance

Fetch the TaskQueueInstance



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

def fetch

    context.fetch
end

#friendly_name ⇒ String 



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



578
579
580
581
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 578

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

#links ⇒ Hash 



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

def links
    @properties['links']
end

#max_reserved_workers ⇒ String 



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

def max_reserved_workers
    @properties['max_reserved_workers']
end

#real_time_statistics ⇒ real_time_statistics

Access the real_time_statistics



565
566
567
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 565

def real_time_statistics
    context.real_time_statistics
end

#reservation_activity_name ⇒ String 



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

def reservation_activity_name
    @properties['reservation_activity_name']
end

#reservation_activity_sid ⇒ String 



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

def reservation_activity_sid
    @properties['reservation_activity_sid']
end

#sid ⇒ String 



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

def sid
    @properties['sid']
end

#statistics ⇒ statistics

Access the statistics



558
559
560
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 558

def statistics
    context.statistics
end

#target_workers ⇒ String 



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

def target_workers
    @properties['target_workers']
end

#task_order ⇒ TaskOrder 



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

def task_order
    @properties['task_order']
end

#to_s ⇒ Object

Provide a user friendly representation



571
572
573
574
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 571

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



529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 529

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 



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

def url
    @properties['url']
end

#workspace_sid ⇒ String 



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

def workspace_sid
    @properties['workspace_sid']
end