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

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

  • account_sid (String) —

    The SID of the Account that created this Task resource.

  • sid (String) (defaults to: nil) —

    The SID of the Call resource to fetch.



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
419
420
421
422
423
424
425
426
427
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 393

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

Returns The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Task resource.

Returns:



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

def 
    @properties['account_sid']
end

#addons ⇒ String

Returns An object that contains the [Add-on](www.twilio.com/docs/add-ons) data for all installed Add-ons.

Returns:



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

def addons
    @properties['addons']
end

#age ⇒ String

Returns The number of seconds since the Task was created.

Returns:

  • (String) —

    The number of seconds since the Task was created.



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

def age
    @properties['age']
end

#assignment_status ⇒ Status

Returns:

  • (Status) 


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

def assignment_status
    @properties['assignment_status']
end

#attributes ⇒ String

Returns The JSON string with custom attributes of the work. Note If this property has been assigned a value, it will only be displayed in FETCH action that returns a single resource. Otherwise, it will be null.

Returns:

  • (String) —

    The JSON string with custom attributes of the work. Note If this property has been assigned a value, it will only be displayed in FETCH action that returns a single resource. Otherwise, it will be null.



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

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

Returns:



433
434
435
436
437
438
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 433

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

#date_created ⇒ Time

Returns The date and time in GMT when the resource was created specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_created
    @properties['date_created']
end

#date_updated ⇒ Time

Returns The date and time in GMT when the resource was last updated specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def date_updated
    @properties['date_updated']
end

#delete(if_match: :unset) ⇒ Boolean

Delete the TaskInstance

Parameters:

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete(
    if_match: :unset
)

    context.delete(
        if_match: if_match, 
    )
end

#fetch ⇒ TaskInstance

Fetch the TaskInstance

Returns:



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

def fetch

    context.fetch
end

#ignore_capacity ⇒ Boolean

Returns A boolean indicating if a new task should respect a worker’s capacity during assignment.

Returns:

  • (Boolean) —

    A boolean indicating if a new task should respect a worker’s capacity during assignment



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

def ignore_capacity
    @properties['ignore_capacity']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



652
653
654
655
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 652

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

#links ⇒ Hash

Returns The URLs of related resources.

Returns:

  • (Hash) —

    The URLs of related resources.



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

def links
    @properties['links']
end

#priority ⇒ String

Returns The current priority score of the Task as assigned to a Worker by the workflow. Tasks with higher priority values will be assigned before Tasks with lower values.

Returns:

  • (String) —

    The current priority score of the Task as assigned to a Worker by the workflow. Tasks with higher priority values will be assigned before Tasks with lower values.



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

def priority
    @properties['priority']
end

#reason ⇒ String

Returns The reason the Task was canceled or completed, if applicable.

Returns:

  • (String) —

    The reason the Task was canceled or completed, if applicable.



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

def reason
    @properties['reason']
end

#reservations ⇒ reservations

Access the reservations

Returns:



639
640
641
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 639

def reservations
    context.reservations
end

#routing_target ⇒ String

Returns A SID of a Worker, Queue, or Workflow to route a Task to.

Returns:

  • (String) —

    A SID of a Worker, Queue, or Workflow to route a Task to



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

def routing_target
    @properties['routing_target']
end

#sid ⇒ String

Returns The unique string that we created to identify the Task resource.

Returns:

  • (String) —

    The unique string that we created to identify the Task resource.



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

def sid
    @properties['sid']
end

#task_channel_sid ⇒ String

Returns The SID of the TaskChannel.

Returns:

  • (String) —

    The SID of the TaskChannel.



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

def task_channel_sid
    @properties['task_channel_sid']
end

#task_channel_unique_name ⇒ String

Returns The unique name of the TaskChannel.

Returns:

  • (String) —

    The unique name of the TaskChannel.



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

def task_channel_unique_name
    @properties['task_channel_unique_name']
end

#task_queue_entered_date ⇒ Time

Returns The date and time in GMT when the Task entered the TaskQueue, specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def task_queue_entered_date
    @properties['task_queue_entered_date']
end

#task_queue_friendly_name ⇒ String

Returns The friendly name of the TaskQueue.

Returns:

  • (String) —

    The friendly name of the TaskQueue.



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

def task_queue_friendly_name
    @properties['task_queue_friendly_name']
end

#task_queue_sid ⇒ String

Returns The SID of the TaskQueue.

Returns:

  • (String) —

    The SID of the TaskQueue.



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

def task_queue_sid
    @properties['task_queue_sid']
end

#timeout ⇒ String

Returns The amount of time in seconds that the Task can live before being assigned.

Returns:

  • (String) —

    The amount of time in seconds that the Task can live before being assigned.



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

def timeout
    @properties['timeout']
end

#to_s ⇒ Object

Provide a user friendly representation



645
646
647
648
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 645

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

Parameters:

  • attributes (String) (defaults to: :unset) —

    The JSON string that describes the custom attributes of the task.

  • assignment_status (Status) (defaults to: :unset)
  • reason (String) (defaults to: :unset) —

    The reason that the Task was canceled or completed. This parameter is required only if the Task is canceled or completed. Setting this value queues the task for deletion and logs the reason.

  • priority (String) (defaults to: :unset) —

    The Task’s new priority value. When supplied, the Task takes on the specified priority unless it matches a Workflow Target with a Priority set. Value can be 0 to 2^31^ (2,147,483,647).

  • task_channel (String) (defaults to: :unset) —

    When MultiTasking is enabled, specify the TaskChannel with the task to update. Can be the TaskChannel’s SID or its unique_name, such as voice, sms, or default.

  • virtual_start_time (Time) (defaults to: :unset) —

    The task’s new virtual start time value. When supplied, the Task takes on the specified virtual start time. Value can’t be in the future.

  • if_match (String) (defaults to: :unset) —

    If provided, applies this mutation if (and only if) the [ETag](developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag) header of the Task matches the provided value. This matches the semantics of (and is implemented with) the HTTP [If-Match header](developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match).

Returns:



615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 615

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

Returns The absolute URL of the Task resource.

Returns:

  • (String) —

    The absolute URL of the Task resource.



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

def url
    @properties['url']
end

#virtual_start_time ⇒ Time

Returns The date and time in GMT indicating the ordering for routing of the Task specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

Returns:



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

def virtual_start_time
    @properties['virtual_start_time']
end

#workflow_friendly_name ⇒ String

Returns The friendly name of the Workflow that is controlling the Task.

Returns:

  • (String) —

    The friendly name of the Workflow that is controlling the Task.



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

def workflow_friendly_name
    @properties['workflow_friendly_name']
end

#workflow_sid ⇒ String

Returns The SID of the Workflow that is controlling the Task.

Returns:

  • (String) —

    The SID of the Workflow that is controlling the Task.



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

def workflow_sid
    @properties['workflow_sid']
end

#workspace_sid ⇒ String

Returns The SID of the Workspace that contains the Task.

Returns:

  • (String) —

    The SID of the Workspace that contains the Task.



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

def workspace_sid
    @properties['workspace_sid']
end