Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::TaskQueueList

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

Defined Under Namespace

Classes: TaskQueuesStatisticsInstance, TaskQueuesStatisticsList, TaskQueuesStatisticsPage

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid: nil) ⇒ TaskQueueList

Initialize the TaskQueueList

Parameters:

  • version (Version) —

    Version that contains the resource

  • workspace_sid (String) (defaults to: nil) —

    The SID of the Workspace that contains the TaskQueue.



21
22
23
24
25
26
27
28
29
30
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 21

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

  # Path Solution
  @solution = {workspace_sid: workspace_sid}
  @uri = "/Workspaces/#{@solution[:workspace_sid]}/TaskQueues"

  # Components
  @statistics = nil
end

Instance Method Details

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

Retrieve a single page of TaskQueueInstance records from the API. Request is executed immediately.

Parameters:

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

    A descriptive string that you create to describe the TaskQueue. For example ‘Support-Tier 1`, `Sales`, or `Escalation`.

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

    A string that describes the Worker selection criteria for any Tasks that enter the TaskQueue. For example, ‘’“language” == “spanish”‘`. The default value is `1==1`. If this value is empty, Tasks will wait in the TaskQueue until they are deleted or moved to another TaskQueue. For more information about Worker selection, see [Describing Worker selection criteria](www.twilio.com/docs/taskrouter/api/taskqueues#target-workers).

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

    The maximum number of Workers to reserve for the assignment of a Task in the queue. Can be an integer between 1 and 50, inclusive and defaults to 1.

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

    How Tasks will be assigned to Workers. Set this parameter to ‘LIFO` to assign most recently created Task first or FIFO to assign the oldest Task first. Default is `FIFO`. [Click here](www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo) to learn more.

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

    The SID of the Activity to assign Workers when a task is reserved for them.

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

    The SID of the Activity to assign Workers when a task is assigned to them.

Returns:



173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 173

def create(friendly_name: nil, target_workers: :unset, max_reserved_workers: :unset, task_order: :unset, reservation_activity_sid: :unset, assignment_activity_sid: :unset)
  data = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'TargetWorkers' => target_workers,
      'MaxReservedWorkers' => max_reserved_workers,
      'TaskOrder' => task_order,
      'ReservationActivitySid' => reservation_activity_sid,
      'AssignmentActivitySid' => assignment_activity_sid,
  })

  payload = @version.create(
      'POST',
      @uri,
      data: data
  )

  TaskQueueInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
end

#each ⇒ Object

When passed a block, yields TaskQueueInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.



95
96
97
98
99
100
101
102
103
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 95

def each
  limits = @version.read_limits

  page = self.page(page_size: limits[:page_size], )

  @version.stream(page,
                  limit: limits[:limit],
                  page_limit: limits[:page_limit]).each {|x| yield x}
end

#get_page(target_url) ⇒ Page

Retrieve a single page of TaskQueueInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of TaskQueueInstance



141
142
143
144
145
146
147
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 141

def get_page(target_url)
  response = @version.domain.request(
      'GET',
      target_url
  )
  TaskQueuePage.new(@version, response, @solution)
end

#list(friendly_name: :unset, evaluate_worker_attributes: :unset, worker_sid: :unset, limit: nil, page_size: nil) ⇒ Array

Lists TaskQueueInstance records from the API as a list. Unlike stream(), this operation is eager and will load ‘limit` records into memory before returning.

Parameters:

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

    The ‘friendly_name` of the TaskQueue resources to read.

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

    The attributes of the Workers to read. Returns the TaskQueues with Workers that match the attributes specified in this parameter.

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

    The SID of the Worker with the TaskQueue resources to read.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Array) —

    Array of up to limit results



50
51
52
53
54
55
56
57
58
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 50

def list(friendly_name: :unset, evaluate_worker_attributes: :unset, worker_sid: :unset, limit: nil, page_size: nil)
  self.stream(
      friendly_name: friendly_name,
      evaluate_worker_attributes: evaluate_worker_attributes,
      worker_sid: worker_sid,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(friendly_name: :unset, evaluate_worker_attributes: :unset, worker_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

Retrieve a single page of TaskQueueInstance records from the API. Request is executed immediately.

Parameters:

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

    The ‘friendly_name` of the TaskQueue resources to read.

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

    The attributes of the Workers to read. Returns the TaskQueues with Workers that match the attributes specified in this parameter.

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

    The SID of the Worker with the TaskQueue resources to read.

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

    PageToken provided by the API

  • page_number (Integer) (defaults to: :unset) —

    Page Number, this value is simply for client state

  • page_size (Integer) (defaults to: :unset) —

    Number of records to return, defaults to 50

Returns:

  • (Page) —

    Page of TaskQueueInstance



119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 119

def page(friendly_name: :unset, evaluate_worker_attributes: :unset, worker_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'FriendlyName' => friendly_name,
      'EvaluateWorkerAttributes' => evaluate_worker_attributes,
      'WorkerSid' => worker_sid,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  TaskQueuePage.new(@version, response, @solution)
end

#statistics ⇒ TaskQueuesStatisticsList, TaskQueuesStatisticsContext

Access the statistics

Returns:



196
197
198
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 196

def statistics
  @statistics ||= TaskQueuesStatisticsList.new(@version, workspace_sid: @solution[:workspace_sid], )
end

#stream(friendly_name: :unset, evaluate_worker_attributes: :unset, worker_sid: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams TaskQueueInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

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

    The ‘friendly_name` of the TaskQueue resources to read.

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

    The attributes of the Workers to read. Returns the TaskQueues with Workers that match the attributes specified in this parameter.

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

    The SID of the Worker with the TaskQueue resources to read.

  • limit (Integer) (defaults to: nil) —

    Upper limit for the number of records to return. stream() guarantees to never return more than limit. Default is no limit.

  • page_size (Integer) (defaults to: nil) —

    Number of records to fetch per request, when not set will use the default value of 50 records. If no page_size is defined but a limit is defined, stream() will attempt to read the limit with the most efficient page size, i.e. min(limit, 1000)

Returns:

  • (Enumerable) —

    Enumerable that will yield up to limit results



78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 78

def stream(friendly_name: :unset, evaluate_worker_attributes: :unset, worker_sid: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      friendly_name: friendly_name,
      evaluate_worker_attributes: evaluate_worker_attributes,
      worker_sid: worker_sid,
      page_size: limits[:page_size],
  )

  @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
end

#to_s ⇒ Object

Provide a user friendly representation



202
203
204
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 202

def to_s
  '#<Twilio.Taskrouter.V1.TaskQueueList>'
end