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



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

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

Create the TaskQueueInstance

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 (TaskOrder) (defaults to: :unset)
  • 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:



44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 44

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.



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

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



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

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:

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

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

    Sorting parameter for TaskQueues

  • 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



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

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

#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:

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

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

    Sorting parameter for TaskQueues

  • 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



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

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

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

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

#statistics ⇒ TaskQueuesStatisticsList, TaskQueuesStatisticsContext

Access the statistics

Returns:



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

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:

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

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

    Sorting parameter for TaskQueues

  • 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



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

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



189
190
191
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 189

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