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.



367
368
369
370
371
372
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
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 367

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

    # 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:



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

def 
    @properties['account_sid']
end

#addons ⇒ String

Returns An object that contains the [addon](www.twilio.com/docs/taskrouter/marketplace) data for all installed addons.

Returns:



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

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.



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

def age
    @properties['age']
end

#assignment_status ⇒ Status

Returns:

  • (Status) 


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

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.



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

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:



404
405
406
407
408
409
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 404

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:



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

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:



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

def date_updated
    @properties['date_updated']
end

#delete(if_match: :unset) ⇒ Boolean

Delete the TaskInstance

Parameters:

Returns:

  • (Boolean) —

    True if delete succeeds, false otherwise



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

def delete(
    if_match: :unset
)

    context.delete(
        if_match: if_match, 
    )
end

#fetch ⇒ TaskInstance

Fetch the TaskInstance

Returns:



553
554
555
556
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 553

def fetch

    context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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.



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

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.



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

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.



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

def reason
    @properties['reason']
end

#reservations ⇒ reservations

Access the reservations

Returns:



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

def reservations
    context.reservations
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.



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

def sid
    @properties['sid']
end

#task_channel_sid ⇒ String

Returns The SID of the TaskChannel.

Returns:

  • (String) —

    The SID of the TaskChannel.



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

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.



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

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:



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

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.



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

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.



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

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.



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

def timeout
    @properties['timeout']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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, 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`.

  • 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:



567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 567

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

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

#url ⇒ String

Returns The absolute URL of the Task resource.

Returns:

  • (String) —

    The absolute URL of the Task resource.



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

def url
    @properties['url']
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.



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

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.



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

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.



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

def workspace_sid
    @properties['workspace_sid']
end