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



393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 393

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 



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

def 
    @properties['account_sid']
end

#assignment_activity_name ⇒ String 



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

def assignment_activity_name
    @properties['assignment_activity_name']
end

#assignment_activity_sid ⇒ String 



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

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



424
425
426
427
428
429
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 424

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



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 



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
    @properties['date_updated']
end

#delete ⇒ Boolean

Delete the TaskQueueInstance



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

def delete

    context.delete
end

#fetch ⇒ TaskQueueInstance

Fetch the TaskQueueInstance



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

def fetch

    context.fetch
end

#friendly_name ⇒ String 



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

def friendly_name
    @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



595
596
597
598
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 595

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

#links ⇒ Hash 



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

def links
    @properties['links']
end

#max_reserved_workers ⇒ String 



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

def max_reserved_workers
    @properties['max_reserved_workers']
end

#real_time_statistics ⇒ real_time_statistics

Access the real_time_statistics



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

def real_time_statistics
    context.real_time_statistics
end

#reservation_activity_name ⇒ String 



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

def reservation_activity_name
    @properties['reservation_activity_name']
end

#reservation_activity_sid ⇒ String 



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

def reservation_activity_sid
    @properties['reservation_activity_sid']
end

#sid ⇒ String 



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

def sid
    @properties['sid']
end

#statistics ⇒ statistics

Access the statistics



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

def statistics
    context.statistics
end

#target_workers ⇒ String 



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

def target_workers
    @properties['target_workers']
end

#task_order ⇒ TaskOrder 



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

def task_order
    @properties['task_order']
end

#to_s ⇒ Object

Provide a user friendly representation



588
589
590
591
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 588

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



546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 546

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 



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

def url
    @properties['url']
end

#workspace_sid ⇒ String 



511
512
513
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 511

def workspace_sid
    @properties['workspace_sid']
end