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



373
374
375
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
402
403
404
405
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 373

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']),
    }

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

Instance Method Details

#account_sid ⇒ String 



420
421
422
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 420

def 
    @properties['account_sid']
end

#addons ⇒ String 



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

def addons
    @properties['addons']
end

#age ⇒ String 



426
427
428
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 426

def age
    @properties['age']
end

#assignment_status ⇒ Status 



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

def assignment_status
    @properties['assignment_status']
end

#attributes ⇒ String 



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

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



411
412
413
414
415
416
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 411

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

#date_created ⇒ Time 



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
    @properties['date_updated']
end

#delete(if_match: :unset) ⇒ Boolean

Delete the TaskInstance



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

def delete(
    if_match: :unset
)

    context.delete(
        if_match: if_match, 
    )
end

#fetch ⇒ TaskInstance

Fetch the TaskInstance



566
567
568
569
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 566

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ Hash 



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

def links
    @properties['links']
end

#priority ⇒ String 



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

def priority
    @properties['priority']
end

#reason ⇒ String 



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

def reason
    @properties['reason']
end

#reservations ⇒ reservations

Access the reservations



605
606
607
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 605

def reservations
    context.reservations
end

#sid ⇒ String 



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

def sid
    @properties['sid']
end

#task_channel_sid ⇒ String 



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

def task_channel_sid
    @properties['task_channel_sid']
end

#task_channel_unique_name ⇒ String 



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

def task_channel_unique_name
    @properties['task_channel_unique_name']
end

#task_queue_entered_date ⇒ Time 



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

def task_queue_entered_date
    @properties['task_queue_entered_date']
end

#task_queue_friendly_name ⇒ String 



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

def task_queue_friendly_name
    @properties['task_queue_friendly_name']
end

#task_queue_sid ⇒ String 



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

def task_queue_sid
    @properties['task_queue_sid']
end

#timeout ⇒ String 



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

def timeout
    @properties['timeout']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 581

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 



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

def url
    @properties['url']
end

#virtual_start_time ⇒ Time 



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

def virtual_start_time
    @properties['virtual_start_time']
end

#workflow_friendly_name ⇒ String 



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

def workflow_friendly_name
    @properties['workflow_friendly_name']
end

#workflow_sid ⇒ String 



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

def workflow_sid
    @properties['workflow_sid']
end

#workspace_sid ⇒ String 



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

def workspace_sid
    @properties['workspace_sid']
end