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



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 327

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



367
368
369
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 367

def 
  @properties['account_sid']
end

#assignment_activity_name ⇒ String

Returns The assignment_activity_name.

Returns:

  • (String) —

    The assignment_activity_name



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

def assignment_activity_name
  @properties['assignment_activity_name']
end

#assignment_activity_sid ⇒ String

Returns The assignment_activity_sid.

Returns:

  • (String) —

    The assignment_activity_sid



373
374
375
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 373

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:



358
359
360
361
362
363
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 358

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:



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

def cumulative_statistics
  context.cumulative_statistics
end

#date_created ⇒ Time

Returns The date_created.

Returns:

  • (Time) —

    The date_created



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

def date_created
  @properties['date_created']
end

#date_updated ⇒ Time

Returns The date_updated.

Returns:

  • (Time) —

    The date_updated



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

def date_updated
  @properties['date_updated']
end

#delete ⇒ Boolean

Deletes the TaskQueueInstance

Returns:

  • (Boolean) —

    true if delete succeeds, true otherwise



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

def delete
  context.delete
end

#fetch ⇒ TaskQueueInstance

Fetch a TaskQueueInstance

Returns:



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

def fetch
  context.fetch
end

#friendly_name ⇒ String

Returns The friendly_name.

Returns:

  • (String) —

    The friendly_name



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

def friendly_name
  @properties['friendly_name']
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



519
520
521
522
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 519

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



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

def links
  @properties['links']
end

#max_reserved_workers ⇒ String

Returns The max_reserved_workers.

Returns:

  • (String) —

    The max_reserved_workers



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

def max_reserved_workers
  @properties['max_reserved_workers']
end

#real_time_statistics ⇒ real_time_statistics

Access the real_time_statistics

Returns:



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

def real_time_statistics
  context.real_time_statistics
end

#reservation_activity_name ⇒ String

Returns The reservation_activity_name.

Returns:

  • (String) —

    The reservation_activity_name



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

def reservation_activity_name
  @properties['reservation_activity_name']
end

#reservation_activity_sid ⇒ String

Returns The reservation_activity_sid.

Returns:

  • (String) —

    The reservation_activity_sid



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

def reservation_activity_sid
  @properties['reservation_activity_sid']
end

#sid ⇒ String

Returns The sid.

Returns:

  • (String) —

    The sid



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

def sid
  @properties['sid']
end

#statistics ⇒ statistics

Access the statistics

Returns:



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

def statistics
  context.statistics
end

#target_workers ⇒ String

Returns The target_workers.

Returns:

  • (String) —

    The target_workers



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

def target_workers
  @properties['target_workers']
end

#task_order ⇒ task_queue.TaskOrder

Returns The task_order.

Returns:

  • (task_queue.TaskOrder) —

    The task_order



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

def task_order
  @properties['task_order']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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:



471
472
473
474
475
476
477
478
479
480
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 471

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



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

def url
  @properties['url']
end

#workspace_sid ⇒ String

Returns The workspace_sid.

Returns:

  • (String) —

    The workspace_sid



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

def workspace_sid
  @properties['workspace_sid']
end