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



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 334

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



379
380
381
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 379

def 
  @properties['account_sid']
end

#addons ⇒ String

Returns The addons.

Returns:

  • (String) —

    The addons



403
404
405
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 403

def addons
  @properties['addons']
end

#age ⇒ String

Returns The age.

Returns:

  • (String) —

    The age



385
386
387
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 385

def age
  @properties['age']
end

#assignment_status ⇒ task.Status

Returns The assignment_status.

Returns:

  • (task.Status) —

    The assignment_status



391
392
393
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 391

def assignment_status
  @properties['assignment_status']
end

#attributes ⇒ String

Returns The attributes.

Returns:

  • (String) —

    The attributes



397
398
399
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 397

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:



370
371
372
373
374
375
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 370

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



409
410
411
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 409

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the TaskInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ TaskInstance

Fetch a TaskInstance

Returns:



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

def fetch
  context.fetch
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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



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

def links
  @properties['links']
end

#priority ⇒ String

Returns The priority.

Returns:

  • (String) —

    The priority



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

def priority
  @properties['priority']
end

#reason ⇒ String

Returns The reason.

Returns:

  • (String) —

    The reason



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

def reason
  @properties['reason']
end

#reservations ⇒ reservations

Access the reservations

Returns:



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

def reservations
  context.reservations
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#task_channel_sid ⇒ String

Returns The task_channel_sid.

Returns:

  • (String) —

    The task_channel_sid



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

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



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

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



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

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



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

def task_queue_sid
  @properties['task_queue_sid']
end

#timeout ⇒ String

Returns The timeout.

Returns:

  • (String) —

    The timeout



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

def timeout
  @properties['timeout']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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 (task.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:



512
513
514
515
516
517
518
519
520
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 512

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



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

def url
  @properties['url']
end

#workflow_friendly_name ⇒ String

Returns The workflow_friendly_name.

Returns:

  • (String) —

    The workflow_friendly_name



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

def workflow_friendly_name
  @properties['workflow_friendly_name']
end

#workflow_sid ⇒ String

Returns The workflow_sid.

Returns:

  • (String) —

    The workflow_sid



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

def workflow_sid
  @properties['workflow_sid']
end

#workspace_sid ⇒ String

Returns The workspace_sid.

Returns:

  • (String) —

    The workspace_sid



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

def workspace_sid
  @properties['workspace_sid']
end