Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::TaskList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid: nil) ⇒ TaskList

Initialize the TaskList



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

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

Instance Method Details

#create(timeout: :unset, priority: :unset, task_channel: :unset, workflow_sid: :unset, attributes: :unset, virtual_start_time: :unset, routing_target: :unset, ignore_capacity: :unset, task_queue_sid: :unset) ⇒ TaskInstance

Create the TaskInstance



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
78
79
80
81
82
83
84
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 48

def create(
    timeout: :unset, 
    priority: :unset, 
    task_channel: :unset, 
    workflow_sid: :unset, 
    attributes: :unset, 
    virtual_start_time: :unset, 
    routing_target: :unset, 
    ignore_capacity: :unset, 
    task_queue_sid: :unset
)

    data = Twilio::Values.of({
        'Timeout' => timeout,
        'Priority' => priority,
        'TaskChannel' => task_channel,
        'WorkflowSid' => workflow_sid,
        'Attributes' => attributes,
        'VirtualStartTime' => Twilio.serialize_iso8601_datetime(virtual_start_time),
        'RoutingTarget' => routing_target,
        'IgnoreCapacity' => ignore_capacity,
        'TaskQueueSid' => task_queue_sid,
    })

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

#create_with_metadata(timeout: :unset, priority: :unset, task_channel: :unset, workflow_sid: :unset, attributes: :unset, virtual_start_time: :unset, routing_target: :unset, ignore_capacity: :unset, task_queue_sid: :unset) ⇒ TaskInstance

Create the TaskInstanceMetadata



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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 98

def create_with_metadata(
  timeout: :unset, 
  priority: :unset, 
  task_channel: :unset, 
  workflow_sid: :unset, 
  attributes: :unset, 
  virtual_start_time: :unset, 
  routing_target: :unset, 
  ignore_capacity: :unset, 
  task_queue_sid: :unset
)

    data = Twilio::Values.of({
        'Timeout' => timeout,
        'Priority' => priority,
        'TaskChannel' => task_channel,
        'WorkflowSid' => workflow_sid,
        'Attributes' => attributes,
        'VirtualStartTime' => Twilio.serialize_iso8601_datetime(virtual_start_time),
        'RoutingTarget' => routing_target,
        'IgnoreCapacity' => ignore_capacity,
        'TaskQueueSid' => task_queue_sid,
    })

    headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
    
    
    
    
    
    response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
    task_instance = TaskInstance.new(
        @version,
        response.body,
        workspace_sid: @solution[:workspace_sid],
    )
    TaskInstanceMetadata.new(
        @version,
        task_instance,
        response.headers,
        response.status_code
    )
end

#each ⇒ Object

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



268
269
270
271
272
273
274
275
276
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 268

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



326
327
328
329
330
331
332
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 326

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

#list(priority: :unset, assignment_status: :unset, workflow_sid: :unset, workflow_name: :unset, task_queue_sid: :unset, task_queue_name: :unset, evaluate_task_attributes: :unset, routing_target: :unset, ordering: :unset, has_addons: :unset, limit: nil, page_size: nil) ⇒ Array

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



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

def list(priority: :unset, assignment_status: :unset, workflow_sid: :unset, workflow_name: :unset, task_queue_sid: :unset, task_queue_name: :unset, evaluate_task_attributes: :unset, routing_target: :unset, ordering: :unset, has_addons: :unset, limit: nil, page_size: nil)
    self.stream(
        priority: priority,
        assignment_status: assignment_status,
        workflow_sid: workflow_sid,
        workflow_name: workflow_name,
        task_queue_sid: task_queue_sid,
        task_queue_name: task_queue_name,
        evaluate_task_attributes: evaluate_task_attributes,
        routing_target: routing_target,
        ordering: ordering,
        has_addons: has_addons,
        limit: limit,
        page_size: page_size
    ).entries
end

#list_with_metadata(priority: :unset, assignment_status: :unset, workflow_sid: :unset, workflow_name: :unset, task_queue_sid: :unset, task_queue_name: :unset, evaluate_task_attributes: :unset, routing_target: :unset, ordering: :unset, has_addons: :unset, limit: nil, page_size: nil) ⇒ Array 



240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 240

def list_with_metadata(priority: :unset, assignment_status: :unset, workflow_sid: :unset, workflow_name: :unset, task_queue_sid: :unset, task_queue_name: :unset, evaluate_task_attributes: :unset, routing_target: :unset, ordering: :unset, has_addons: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)
    params = Twilio::Values.of({
        'Priority' => priority,
        
        'AssignmentStatus' =>  Twilio.serialize_list(assignment_status) { |e| e },
        'WorkflowSid' => workflow_sid,
        'WorkflowName' => workflow_name,
        'TaskQueueSid' => task_queue_sid,
        'TaskQueueName' => task_queue_name,
        'EvaluateTaskAttributes' => evaluate_task_attributes,
        'RoutingTarget' => routing_target,
        'Ordering' => ordering,
        'HasAddons' => has_addons,
        
        'PageSize' => limits[:page_size],
    });
    headers = Twilio::Values.of({})

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

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

#page(priority: :unset, assignment_status: :unset, workflow_sid: :unset, workflow_name: :unset, task_queue_sid: :unset, task_queue_name: :unset, evaluate_task_attributes: :unset, routing_target: :unset, ordering: :unset, has_addons: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 295

def page(priority: :unset, assignment_status: :unset, workflow_sid: :unset, workflow_name: :unset, task_queue_sid: :unset, task_queue_name: :unset, evaluate_task_attributes: :unset, routing_target: :unset, ordering: :unset, has_addons: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
    params = Twilio::Values.of({
        'Priority' => priority,
        
        'AssignmentStatus' =>  Twilio.serialize_list(assignment_status) { |e| e },
        'WorkflowSid' => workflow_sid,
        'WorkflowName' => workflow_name,
        'TaskQueueSid' => task_queue_sid,
        'TaskQueueName' => task_queue_name,
        'EvaluateTaskAttributes' => evaluate_task_attributes,
        'RoutingTarget' => routing_target,
        'Ordering' => ordering,
        'HasAddons' => has_addons,
        'PageToken' => page_token,
        'Page' => page_number,
        'PageSize' => page_size,
    })
    headers = Twilio::Values.of({})
    
    

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

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

#stream(priority: :unset, assignment_status: :unset, workflow_sid: :unset, workflow_name: :unset, task_queue_sid: :unset, task_queue_name: :unset, evaluate_task_attributes: :unset, routing_target: :unset, ordering: :unset, has_addons: :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.



202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 202

def stream(priority: :unset, assignment_status: :unset, workflow_sid: :unset, workflow_name: :unset, task_queue_sid: :unset, task_queue_name: :unset, evaluate_task_attributes: :unset, routing_target: :unset, ordering: :unset, has_addons: :unset, limit: nil, page_size: nil)
    limits = @version.read_limits(limit, page_size)

    page = self.page(
        priority: priority,
        assignment_status: assignment_status,
        workflow_sid: workflow_sid,
        workflow_name: workflow_name,
        task_queue_sid: task_queue_sid,
        task_queue_name: task_queue_name,
        evaluate_task_attributes: evaluate_task_attributes,
        routing_target: routing_target,
        ordering: ordering,
        has_addons: has_addons,
        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



337
338
339
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 337

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