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, TaskQueueBulkRealTimeStatisticsPage, TaskQueuesStatisticsInstance, TaskQueuesStatisticsList, TaskQueuesStatisticsPage

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid: nil) ⇒ TaskQueueList

Initialize the TaskQueueList



28
29
30
31
32
33
34
35
36
 
# 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



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

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



46
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
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 46

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

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



133
134
135
136
137
138
139
140
141
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 133

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.



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

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.



90
91
92
93
94
95
96
97
98
99
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 90

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.



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

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



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

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.



116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue.rb', line 116

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



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

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