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

Parameters:

  • version (Version) —

    Version that contains the resource



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

Parameters:

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

    A descriptive string that you create to describe the new Worker. It can be up to 64 characters long.

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

    The SID of a valid Activity that will describe the new Worker’s initial state. See [Activities](www.twilio.com/docs/taskrouter/api/activity) for more information. If not provided, the new Worker’s initial state is the ‘default_activity_sid` configured on the Workspace.

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

    A valid JSON string that describes the new Worker. For example: ‘{ \"email\": \"[email protected]\", \"phone\": \"+5095551234\" }`. This data is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the Worker. Defaults to {}.

Returns:



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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of WorkerInstance



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.

Parameters:

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

    The ‘activity_name` of the Worker resources to read.

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

    The ‘activity_sid` of the Worker resources to read.

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

    Whether to return only Worker resources that are available or unavailable. Can be ‘true`, `1`, or `yes` to return Worker resources that are available, and `false`, or any value returns the Worker resources that are not available.

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

    The ‘friendly_name` of the Worker resources to read.

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

    Filter by Workers that would match an expression. In addition to fields in the workers’ attributes, the expression can include the following worker fields: ‘sid`, `friendly_name`, `activity_sid`, or `activity_name`

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

    The ‘friendly_name` of the TaskQueue that the Workers to read are eligible for.

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

    The SID of the TaskQueue that the Workers to read are eligible for.

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

    Sorting parameter for Workers

  • 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



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.

Parameters:

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

    The ‘activity_name` of the Worker resources to read.

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

    The ‘activity_sid` of the Worker resources to read.

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

    Whether to return only Worker resources that are available or unavailable. Can be ‘true`, `1`, or `yes` to return Worker resources that are available, and `false`, or any value returns the Worker resources that are not available.

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

    The ‘friendly_name` of the Worker resources to read.

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

    Filter by Workers that would match an expression. In addition to fields in the workers’ attributes, the expression can include the following worker fields: ‘sid`, `friendly_name`, `activity_sid`, or `activity_name`

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

    The ‘friendly_name` of the TaskQueue that the Workers to read are eligible for.

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

    The SID of the TaskQueue that the Workers to read are eligible for.

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

    Sorting parameter for Workers

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



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

Returns:



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.

Parameters:

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

    The ‘activity_name` of the Worker resources to read.

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

    The ‘activity_sid` of the Worker resources to read.

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

    Whether to return only Worker resources that are available or unavailable. Can be ‘true`, `1`, or `yes` to return Worker resources that are available, and `false`, or any value returns the Worker resources that are not available.

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

    The ‘friendly_name` of the Worker resources to read.

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

    Filter by Workers that would match an expression. In addition to fields in the workers’ attributes, the expression can include the following worker fields: ‘sid`, `friendly_name`, `activity_sid`, or `activity_name`

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

    The ‘friendly_name` of the TaskQueue that the Workers to read are eligible for.

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

    The SID of the TaskQueue that the Workers to read are eligible for.

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

    Sorting parameter for Workers

  • 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



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