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,
lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_bulk_real_time_statistics.rb

Defined Under Namespace

Classes: TaskQueueBulkRealTimeStatisticsInstance, TaskQueueBulkRealTimeStatisticsList, TaskQueueBulkRealTimeStatisticsListResponse, TaskQueueBulkRealTimeStatisticsPage, TaskQueueBulkRealTimeStatisticsPageMetadata, TaskQueuesStatisticsInstance, TaskQueuesStatisticsList, TaskQueuesStatisticsListResponse, TaskQueuesStatisticsPage, TaskQueuesStatisticsPageMetadata

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid: nil) ⇒ TaskQueueList

Initialize the TaskQueueList

Parameters:

  • Version that contains the resource



28
29
30
31
32
33
34
35
36
37
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 28

def initialize(version, workspace_sid: nil)
    super(version)
    
    # Path Solution
    @solution = { workspace_sid: workspace_sid }
    @uri = "/Workspaces/#{@solution[:workspace_sid]}/TaskQueues"
    # Components
    @bulk_real_time_statistics = nil
    @statistics = nil
end

Instance Method Details

#bulk_real_time_statistics ⇒ TaskQueueBulkRealTimeStatisticsList, TaskQueueBulkRealTimeStatisticsContext

Access the bulk_real_time_statistics

Returns:



273
274
275
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 273

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

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

Create the TaskQueueInstance

Parameters:

  • (defaults to: nil)

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

  • (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).

  • (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.

  • (defaults to: :unset)
  • (defaults to: :unset)

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

  • (defaults to: :unset)

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

Returns:

  • Created TaskQueueInstance



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 47

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,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    payload = @version.create('POST', @uri, data: data, headers: headers)
    TaskQueueInstance.new(
        @version,
        payload,
        workspace_sid: @solution[:workspace_sid],
    )
end

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

Create the TaskQueueInstanceMetadata

Parameters:

  • (defaults to: nil)

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

  • (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).

  • (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.

  • (defaults to: :unset)
  • (defaults to: :unset)

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

  • (defaults to: :unset)

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

Returns:

  • Created TaskQueueInstance



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 88

def create_with_metadata(
  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,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    task_queue_instance = TaskQueueInstance.new(
        @version,
        response.body,
        workspace_sid: @solution[:workspace_sid],
    )
    TaskQueueInstanceMetadata.new(
        @version,
        task_queue_instance,
        response.headers,
        response.status_code
    )
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.



215
216
217
218
219
220
221
222
223
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 215

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:

  • API-generated URL for the requested results page

Returns:

  • Page of TaskQueueInstance



260
261
262
263
264
265
266
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 260

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, ordering: :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:

  • (defaults to: :unset)

    The friendly_name of the TaskQueue resources to read.

  • (defaults to: :unset)

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

  • (defaults to: :unset)

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

  • (defaults to: :unset)

    Sorting parameter for TaskQueues

  • (defaults to: nil)

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

  • (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 of up to limit results



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

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

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

Returns Array of up to limit results.

Parameters:

  • (defaults to: nil)

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

  • (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 of up to limit results



194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 194

def list_with_metadata(friendly_name: :unset, evaluate_worker_attributes: :unset, worker_sid: :unset, ordering: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'FriendlyName' => friendly_name,
        'EvaluateWorkerAttributes' => evaluate_worker_attributes,
        'WorkerSid' => worker_sid,
        'Ordering' => ordering,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

    response = @version.page('GET', @uri, params: params, headers: headers)

    TaskQueuePageMetadata.new(@version, response, @solution, limits[:limit])
end

#page(friendly_name: :unset, evaluate_worker_attributes: :unset, worker_sid: :unset, ordering: :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:

  • (defaults to: :unset)

    The friendly_name of the TaskQueue resources to read.

  • (defaults to: :unset)

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

  • (defaults to: :unset)

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

  • (defaults to: :unset)

    Sorting parameter for TaskQueues

  • (defaults to: :unset)

    PageToken provided by the API

  • (defaults to: :unset)

    Page Number, this value is simply for client state

  • (defaults to: :unset)

    Number of records to return, defaults to 50

Returns:

  • Page of TaskQueueInstance



236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 236

def page(friendly_name: :unset, evaluate_worker_attributes: :unset, worker_sid: :unset, ordering: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        'FriendlyName' => friendly_name,
        'EvaluateWorkerAttributes' => evaluate_worker_attributes,
        'WorkerSid' => worker_sid,
        'Ordering' => ordering,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

    response = @version.page('GET', @uri, params: params, headers: headers)

    TaskQueuePage.new(@version, response, @solution)
end

#statistics ⇒ TaskQueuesStatisticsList, TaskQueuesStatisticsContext

Access the statistics

Returns:



280
281
282
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 280

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

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

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

Parameters:

  • (defaults to: :unset)

    The friendly_name of the TaskQueue resources to read.

  • (defaults to: :unset)

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

  • (defaults to: :unset)

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

  • (defaults to: :unset)

    Sorting parameter for TaskQueues

  • (defaults to: nil)

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

  • (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 that will yield up to limit results



168
169
170
171
172
173
174
175
176
177
178
179
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 168

def stream(friendly_name: :unset, evaluate_worker_attributes: :unset, worker_sid: :unset, ordering: :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,
        ordering: ordering,
        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



285
286
287
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 285

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