Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::TaskQueueInstance

Inherits:
InstanceResource
  • Object
show all
Defined in:
lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, workspace_sid: nil, sid: nil) ⇒ TaskQueueInstance

Initialize the TaskQueueInstance

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



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 357

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

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'assignment_activity_sid' => payload['assignment_activity_sid'],
      'assignment_activity_name' => payload['assignment_activity_name'],
      'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
      'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
      'friendly_name' => payload['friendly_name'],
      'max_reserved_workers' => payload['max_reserved_workers'].to_i,
      'reservation_activity_sid' => payload['reservation_activity_sid'],
      'reservation_activity_name' => payload['reservation_activity_name'],
      'sid' => payload['sid'],
      'target_workers' => payload['target_workers'],
      'task_order' => payload['task_order'],
      'url' => payload['url'],
      'workspace_sid' => payload['workspace_sid'],
      '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



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

def 
  @properties['account_sid']
end

#assignment_activity_name ⇒ String

Returns The assignment_activity_name.

Returns:

  • (String) —

    The assignment_activity_name



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

def assignment_activity_name
  @properties['assignment_activity_name']
end

#assignment_activity_sid ⇒ String

Returns The assignment_activity_sid.

Returns:

  • (String) —

    The assignment_activity_sid



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

def assignment_activity_sid
  @properties['assignment_activity_sid']
end

#context ⇒ TaskQueueContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



391
392
393
394
395
396
397
398
399
400
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 391

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

#cumulative_statistics ⇒ cumulative_statistics

Access the cumulative_statistics

Returns:



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

def cumulative_statistics
  context.cumulative_statistics
end

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the TaskQueueInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ TaskQueueInstance

Fetch a TaskQueueInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The friendly_name.

Returns:

  • (String) —

    The friendly_name



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



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

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

#links ⇒ String

Returns The links.

Returns:

  • (String) —

    The links



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

def links
  @properties['links']
end

#max_reserved_workers ⇒ String

Returns The max_reserved_workers.

Returns:

  • (String) —

    The max_reserved_workers



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

def max_reserved_workers
  @properties['max_reserved_workers']
end

#real_time_statistics ⇒ real_time_statistics

Access the real_time_statistics

Returns:



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

def real_time_statistics
  context.real_time_statistics
end

#reservation_activity_name ⇒ String

Returns The reservation_activity_name.

Returns:

  • (String) —

    The reservation_activity_name



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

def reservation_activity_name
  @properties['reservation_activity_name']
end

#reservation_activity_sid ⇒ String

Returns The reservation_activity_sid.

Returns:

  • (String) —

    The reservation_activity_sid



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

def reservation_activity_sid
  @properties['reservation_activity_sid']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#statistics ⇒ statistics

Access the statistics

Returns:



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

def statistics
  context.statistics
end

#target_workers ⇒ String

Returns The target_workers.

Returns:

  • (String) —

    The target_workers



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

def target_workers
  @properties['target_workers']
end

#task_order ⇒ task_queue.TaskOrder

Returns The task_order.

Returns:

  • (task_queue.TaskOrder) —

    The task_order



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

def task_order
  @properties['task_order']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#update(friendly_name: :unset, target_workers: :unset, reservation_activity_sid: :unset, assignment_activity_sid: :unset, max_reserved_workers: :unset, task_order: :unset) ⇒ TaskQueueInstance

Update the TaskQueueInstance

Parameters:

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

    The friendly_name

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

    The target_workers

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

    The reservation_activity_sid

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

    The assignment_activity_sid

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

    The max_reserved_workers

  • task_order (task_queue.TaskOrder) (defaults to: :unset) —

    The task_order

Returns:



508
509
510
511
512
513
514
515
516
517
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 508

def update(friendly_name: :unset, target_workers: :unset, reservation_activity_sid: :unset, assignment_activity_sid: :unset, max_reserved_workers: :unset, task_order: :unset)
  context.update(
      friendly_name: friendly_name,
      target_workers: target_workers,
      reservation_activity_sid: reservation_activity_sid,
      assignment_activity_sid: assignment_activity_sid,
      max_reserved_workers: max_reserved_workers,
      task_order: task_order,
  )
end

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end

#workspace_sid ⇒ String

Returns The workspace_sid.

Returns:

  • (String) —

    The workspace_sid



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

def workspace_sid
  @properties['workspace_sid']
end