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 workspace_sid



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

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, reservation_activity_sid: nil, assignment_activity_sid: nil, target_workers: :unset, max_reserved_workers: :unset, task_order: :unset) ⇒ TaskQueueInstance

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

Parameters:

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

    The friendly_name

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

    The reservation_activity_sid

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

    The assignment_activity_sid

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

    The target_workers

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

    The max_reserved_workers

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

    The task_order

Returns:



148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 148

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

  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.



86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 86

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



130
131
132
133
134
135
136
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 130

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

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

    The evaluate_worker_attributes

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

    The worker_sid

  • 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



45
46
47
48
49
50
51
52
53
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 45

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

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

    The evaluate_worker_attributes

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

    The worker_sid

  • 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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 108

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:



175
176
177
178
179
180
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 175

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

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

    The evaluate_worker_attributes

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

    The worker_sid

  • 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



69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 69

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



184
185
186
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 184

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