Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::TaskInstance

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

Instance Method Summary collapse

Constructor Details

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

Initialize the TaskInstance



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 412

def initialize(version, payload , workspace_sid: nil, sid: nil)
    super(version)
    
    # Marshaled Properties
    @properties = { 
        'account_sid' => payload['account_sid'],
        'age' => payload['age'] == nil ? payload['age'] : payload['age'].to_i,
        'assignment_status' => payload['assignment_status'],
        'attributes' => payload['attributes'],
        'addons' => payload['addons'],
        'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
        'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
        'task_queue_entered_date' => Twilio.deserialize_iso8601_datetime(payload['task_queue_entered_date']),
        'priority' => payload['priority'] == nil ? payload['priority'] : payload['priority'].to_i,
        'reason' => payload['reason'],
        'sid' => payload['sid'],
        'task_queue_sid' => payload['task_queue_sid'],
        'task_queue_friendly_name' => payload['task_queue_friendly_name'],
        'task_channel_sid' => payload['task_channel_sid'],
        'task_channel_unique_name' => payload['task_channel_unique_name'],
        'timeout' => payload['timeout'] == nil ? payload['timeout'] : payload['timeout'].to_i,
        'workflow_sid' => payload['workflow_sid'],
        'workflow_friendly_name' => payload['workflow_friendly_name'],
        'workspace_sid' => payload['workspace_sid'],
        'url' => payload['url'],
        'links' => payload['links'],
        'virtual_start_time' => Twilio.deserialize_iso8601_datetime(payload['virtual_start_time']),
        'ignore_capacity' => payload['ignore_capacity'],
        'routing_target' => payload['routing_target'],
    }

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

Instance Method Details

#account_sid ⇒ String 



461
462
463
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 461

def 
    @properties['account_sid']
end

#addons ⇒ String 



485
486
487
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 485

def addons
    @properties['addons']
end

#age ⇒ String 



467
468
469
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 467

def age
    @properties['age']
end

#assignment_status ⇒ Status 



473
474
475
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 473

def assignment_status
    @properties['assignment_status']
end

#attributes ⇒ String 



479
480
481
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 479

def attributes
    @properties['attributes']
end

#context ⇒ TaskContext

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



452
453
454
455
456
457
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 452

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

#date_created ⇒ Time 



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



497
498
499
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 497

def date_updated
    @properties['date_updated']
end

#delete(if_match: :unset) ⇒ Boolean

Delete the TaskInstance



607
608
609
610
611
612
613
614
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 607

def delete(
    if_match: :unset
)

    context.delete(
        if_match: if_match, 
    )
end

#fetch ⇒ TaskInstance

Fetch the TaskInstance



619
620
621
622
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 619

def fetch

    context.fetch
end

#ignore_capacity ⇒ Boolean 



593
594
595
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 593

def ignore_capacity
    @properties['ignore_capacity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



671
672
673
674
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 671

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

#links ⇒ Hash 



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

def links
    @properties['links']
end

#priority ⇒ String 



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

def priority
    @properties['priority']
end

#reason ⇒ String 



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

def reason
    @properties['reason']
end

#reservations ⇒ reservations

Access the reservations



658
659
660
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 658

def reservations
    context.reservations
end

#routing_target ⇒ String 



599
600
601
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 599

def routing_target
    @properties['routing_target']
end

#sid ⇒ String 



521
522
523
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 521

def sid
    @properties['sid']
end

#task_channel_sid ⇒ String 



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

def task_channel_sid
    @properties['task_channel_sid']
end

#task_channel_unique_name ⇒ String 



545
546
547
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 545

def task_channel_unique_name
    @properties['task_channel_unique_name']
end

#task_queue_entered_date ⇒ Time 



503
504
505
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 503

def task_queue_entered_date
    @properties['task_queue_entered_date']
end

#task_queue_friendly_name ⇒ String 



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

def task_queue_friendly_name
    @properties['task_queue_friendly_name']
end

#task_queue_sid ⇒ String 



527
528
529
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 527

def task_queue_sid
    @properties['task_queue_sid']
end

#timeout ⇒ String 



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

def timeout
    @properties['timeout']
end

#to_s ⇒ Object

Provide a user friendly representation



664
665
666
667
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 664

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

#update(attributes: :unset, assignment_status: :unset, reason: :unset, priority: :unset, task_channel: :unset, virtual_start_time: :unset, if_match: :unset) ⇒ TaskInstance

Update the TaskInstance



634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 634

def update(
    attributes: :unset, 
    assignment_status: :unset, 
    reason: :unset, 
    priority: :unset, 
    task_channel: :unset, 
    virtual_start_time: :unset, 
    if_match: :unset
)

    context.update(
        attributes: attributes, 
        assignment_status: assignment_status, 
        reason: reason, 
        priority: priority, 
        task_channel: task_channel, 
        virtual_start_time: virtual_start_time, 
        if_match: if_match, 
    )
end

#url ⇒ String 



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

def url
    @properties['url']
end

#virtual_start_time ⇒ Time 



587
588
589
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 587

def virtual_start_time
    @properties['virtual_start_time']
end

#workflow_friendly_name ⇒ String 



563
564
565
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 563

def workflow_friendly_name
    @properties['workflow_friendly_name']
end

#workflow_sid ⇒ String 



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

def workflow_sid
    @properties['workflow_sid']
end

#workspace_sid ⇒ String 



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

def workspace_sid
    @properties['workspace_sid']
end