Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::WorkerList

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

Defined Under Namespace

Classes: WorkersStatisticsContext, WorkersStatisticsInstance, WorkersStatisticsList, WorkersStatisticsPage

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid: nil) ⇒ WorkerList

Initialize the WorkerList



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

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

Instance Method Details

#create(friendly_name: nil, activity_sid: :unset, attributes: :unset) ⇒ WorkerInstance

Create the WorkerInstance



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

def create(
    friendly_name: nil, 
    activity_sid: :unset, 
    attributes: :unset
)

    data = Twilio::Values.of({
        'FriendlyName' => friendly_name,
        'ActivitySid' => activity_sid,
        'Attributes' => attributes,
    })

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

#each ⇒ Object

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



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

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 WorkerInstance records from the API. Request is executed immediately.



196
197
198
199
200
201
202
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 196

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

#list(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, ordering: :unset, limit: nil, page_size: nil) ⇒ Array

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



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

def list(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, ordering: :unset, limit: nil, page_size: nil)
    self.stream(
        activity_name: activity_name,
        activity_sid: activity_sid,
        available: available,
        friendly_name: friendly_name,
        target_workers_expression: target_workers_expression,
        task_queue_name: task_queue_name,
        task_queue_sid: task_queue_sid,
        ordering: ordering,
        limit: limit,
        page_size: page_size
    ).entries
end

#page(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, ordering: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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



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

def page(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, ordering: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
    params = Twilio::Values.of({
        'ActivityName' => activity_name,
        'ActivitySid' => activity_sid,
        'Available' => available,
        'FriendlyName' => friendly_name,
        'TargetWorkersExpression' => target_workers_expression,
        'TaskQueueName' => task_queue_name,
        'TaskQueueSid' => task_queue_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)

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

#statistics ⇒ WorkersStatisticsContext

Access the statistics



208
209
210
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 208

def statistics
   return  WorkersStatisticsContext.new(@version, @solution[:workspace_sid])
end

#stream(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_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.



122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 122

def stream(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, ordering: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        activity_name: activity_name,
        activity_sid: activity_sid,
        available: available,
        friendly_name: friendly_name,
        target_workers_expression: target_workers_expression,
        task_queue_name: task_queue_name,
        task_queue_sid: task_queue_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



213
214
215
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/worker.rb', line 213

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