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



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
386
387
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 359

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



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

def 
  @properties['account_sid']
end

#assignment_activity_name ⇒ String

Returns The assignment_activity_name.

Returns:

  • (String) —

    The assignment_activity_name



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

def assignment_activity_name
  @properties['assignment_activity_name']
end

#assignment_activity_sid ⇒ String

Returns The assignment_activity_sid.

Returns:

  • (String) —

    The assignment_activity_sid



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

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:



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

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

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the TaskQueueInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ TaskQueueInstance

Fetch a TaskQueueInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The friendly_name.

Returns:

  • (String) —

    The friendly_name



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



565
566
567
568
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 565

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



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

def links
  @properties['links']
end

#max_reserved_workers ⇒ String

Returns The max_reserved_workers.

Returns:

  • (String) —

    The max_reserved_workers



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

def max_reserved_workers
  @properties['max_reserved_workers']
end

#reservation_activity_name ⇒ String

Returns The reservation_activity_name.

Returns:

  • (String) —

    The reservation_activity_name



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

def reservation_activity_name
  @properties['reservation_activity_name']
end

#reservation_activity_sid ⇒ String

Returns The reservation_activity_sid.

Returns:

  • (String) —

    The reservation_activity_sid



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

def reservation_activity_sid
  @properties['reservation_activity_sid']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#target_workers ⇒ String

Returns The target_workers.

Returns:

  • (String) —

    The target_workers



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

def target_workers
  @properties['target_workers']
end

#task_order ⇒ task_queue.TaskOrder

Returns The task_order.

Returns:

  • (task_queue.TaskOrder) —

    The task_order



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

def task_order
  @properties['task_order']
end

#task_queue_cumulative_statistics ⇒ task_queue_cumulative_statistics

Access the task_queue_cumulative_statistics

Returns:



552
553
554
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 552

def task_queue_cumulative_statistics
  context.task_queue_cumulative_statistics
end

#task_queue_real_time_statistics ⇒ task_queue_real_time_statistics

Access the task_queue_real_time_statistics

Returns:



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

def task_queue_real_time_statistics
  context.task_queue_real_time_statistics
end

#task_queue_statistics ⇒ task_queue_statistics

Access the task_queue_statistics

Returns:



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

def task_queue_statistics
  context.task_queue_statistics
end

#task_queues_statistics ⇒ task_queues_statistics

Access the task_queues_statistics

Returns:



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

def task_queues_statistics
  context.task_queues_statistics
end

#to_s ⇒ Object

Provide a user friendly representation



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

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:



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

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



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

def url
  @properties['url']
end

#workspace_sid ⇒ String

Returns The workspace_sid.

Returns:

  • (String) —

    The workspace_sid



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

def workspace_sid
  @properties['workspace_sid']
end