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

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

    The workspace_sid

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

    The sid



364
365
366
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
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 364

def initialize(version, payload, workspace_sid: nil, sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      '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']),
      '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'].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,
      'sid' => sid || @properties['sid'],
  }
end

Instance Method Details

#account_sid ⇒ String

Returns The account_sid.

Returns:

  • (String) —

    The account_sid



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

def 
  @properties['account_sid']
end

#addons ⇒ String

Returns The addons.

Returns:

  • (String) —

    The addons



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

def addons
  @properties['addons']
end

#age ⇒ String

Returns The age.

Returns:

  • (String) —

    The age



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

def age
  @properties['age']
end

#assignment_status ⇒ reservation.Status

Returns The assignment_status.

Returns:

  • (reservation.Status) —

    The assignment_status



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

def assignment_status
  @properties['assignment_status']
end

#attributes ⇒ String

Returns The attributes.

Returns:

  • (String) —

    The attributes



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

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:



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

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_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the TaskInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ TaskInstance

Fetch a TaskInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



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

def links
  @properties['links']
end

#priority ⇒ String

Returns The priority.

Returns:

  • (String) —

    The priority



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

def priority
  @properties['priority']
end

#reason ⇒ String

Returns The reason.

Returns:

  • (String) —

    The reason



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

def reason
  @properties['reason']
end

#reservations ⇒ reservations

Access the reservations

Returns:



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

def reservations
  context.reservations
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#task_channel_sid ⇒ String

Returns The task_channel_sid.

Returns:

  • (String) —

    The task_channel_sid



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

def task_channel_sid
  @properties['task_channel_sid']
end

#task_channel_unique_name ⇒ String

Returns The task_channel_unique_name.

Returns:

  • (String) —

    The task_channel_unique_name



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

def task_channel_unique_name
  @properties['task_channel_unique_name']
end

#task_queue_friendly_name ⇒ String

Returns The task_queue_friendly_name.

Returns:

  • (String) —

    The task_queue_friendly_name



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

def task_queue_friendly_name
  @properties['task_queue_friendly_name']
end

#task_queue_sid ⇒ String

Returns The task_queue_sid.

Returns:

  • (String) —

    The task_queue_sid



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

def task_queue_sid
  @properties['task_queue_sid']
end

#timeout ⇒ String

Returns The timeout.

Returns:

  • (String) —

    The timeout



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

def timeout
  @properties['timeout']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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) ⇒ TaskInstance

Update the TaskInstance

Parameters:

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

    The attributes

  • assignment_status (reservation.Status) (defaults to: :unset) —

    The assignment_status

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

    The reason

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

    The priority

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

    The task_channel

Returns:



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

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

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end

#workflow_friendly_name ⇒ String

Returns The workflow_friendly_name.

Returns:

  • (String) —

    The workflow_friendly_name



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

def workflow_friendly_name
  @properties['workflow_friendly_name']
end

#workflow_sid ⇒ String

Returns The workflow_sid.

Returns:

  • (String) —

    The workflow_sid



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

def workflow_sid
  @properties['workflow_sid']
end

#workspace_sid ⇒ String

Returns The workspace_sid.

Returns:

  • (String) —

    The workspace_sid



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

def workspace_sid
  @properties['workspace_sid']
end