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



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
406
407
408
409
410
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 378

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 



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

def 
    @properties['account_sid']
end

#addons ⇒ String 



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

def addons
    @properties['addons']
end

#age ⇒ String 



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

def age
    @properties['age']
end

#assignment_status ⇒ Status 



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

def assignment_status
    @properties['assignment_status']
end

#attributes ⇒ String 



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

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



416
417
418
419
420
421
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 416

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

#date_created ⇒ Time 



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time 



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

def date_updated
    @properties['date_updated']
end

#delete(if_match: :unset) ⇒ Boolean

Delete the TaskInstance



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

def delete(
    if_match: :unset
)

    context.delete(
        if_match: if_match, 
    )
end

#fetch ⇒ TaskInstance

Fetch the TaskInstance



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

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



623
624
625
626
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 623

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

#links ⇒ Hash 



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

def links
    @properties['links']
end

#priority ⇒ String 



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

def priority
    @properties['priority']
end

#reason ⇒ String 



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

def reason
    @properties['reason']
end

#reservations ⇒ reservations

Access the reservations



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

def reservations
    context.reservations
end

#sid ⇒ String 



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

def sid
    @properties['sid']
end

#task_channel_sid ⇒ String 



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

def task_channel_sid
    @properties['task_channel_sid']
end

#task_channel_unique_name ⇒ String 



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

def task_channel_unique_name
    @properties['task_channel_unique_name']
end

#task_queue_entered_date ⇒ Time 



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

def task_queue_entered_date
    @properties['task_queue_entered_date']
end

#task_queue_friendly_name ⇒ String 



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

def task_queue_friendly_name
    @properties['task_queue_friendly_name']
end

#task_queue_sid ⇒ String 



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

def task_queue_sid
    @properties['task_queue_sid']
end

#timeout ⇒ String 



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

def timeout
    @properties['timeout']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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



586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 586

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 



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

def url
    @properties['url']
end

#virtual_start_time ⇒ Time 



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

def virtual_start_time
    @properties['virtual_start_time']
end

#workflow_friendly_name ⇒ String 



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

def workflow_friendly_name
    @properties['workflow_friendly_name']
end

#workflow_sid ⇒ String 



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

def workflow_sid
    @properties['workflow_sid']
end

#workspace_sid ⇒ String 



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

def workspace_sid
    @properties['workspace_sid']
end