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



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 377

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_sidString



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

def 
  @properties['account_sid']
end

#assignment_activity_nameString



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

def assignment_activity_name
  @properties['assignment_activity_name']
end

#assignment_activity_sidString



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

def assignment_activity_sid
  @properties['assignment_activity_sid']
end

#contextTaskQueueContext

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



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

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

#cumulative_statisticscumulative_statistics

Access the cumulative_statistics



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

def cumulative_statistics
  context.cumulative_statistics
end

#date_createdTime



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

def date_created
  @properties['date_created']
end

#date_updatedTime



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

def date_updated
  @properties['date_updated']
end

#deleteBoolean

Deletes the TaskQueueInstance



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

def delete
  context.delete
end

#fetchTaskQueueInstance

Fetch a TaskQueueInstance



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

def fetch
  context.fetch
end

#friendly_nameString



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

def friendly_name
  @properties['friendly_name']
end

#inspectObject

Provide a detailed, user friendly representation



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

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


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

def links
  @properties['links']
end

#max_reserved_workersString



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

def max_reserved_workers
  @properties['max_reserved_workers']
end

#real_time_statisticsreal_time_statistics

Access the real_time_statistics



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

def real_time_statistics
  context.real_time_statistics
end

#reservation_activity_nameString



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

def reservation_activity_name
  @properties['reservation_activity_name']
end

#reservation_activity_sidString



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

def reservation_activity_sid
  @properties['reservation_activity_sid']
end

#sidString



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

def sid
  @properties['sid']
end

#statisticsstatistics

Access the statistics



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

def statistics
  context.statistics
end

#target_workersString



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

def target_workers
  @properties['target_workers']
end

#task_ordertask_queue.TaskOrder



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

def task_order
  @properties['task_order']
end

#to_sObject

Provide a user friendly representation



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

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



533
534
535
536
537
538
539
540
541
542
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 533

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

#urlString



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

def url
  @properties['url']
end

#workspace_sidString



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

def workspace_sid
  @properties['workspace_sid']
end