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

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The workspace_sid



18
19
20
21
22
23
24
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 18

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) ⇒ TaskInstance

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

Parameters:

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

    The timeout

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

    The priority

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

    The task_channel

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

    The workflow_sid

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

    The attributes

Returns:



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 176

def create(timeout: :unset, priority: :unset, task_channel: :unset, workflow_sid: :unset, attributes: :unset)
  data = Twilio::Values.of({
      'Timeout' => timeout,
      'Priority' => priority,
      'TaskChannel' => task_channel,
      'WorkflowSid' => workflow_sid,
      'Attributes' => attributes,
  })

  payload = @version.create(
      'POST',
      @uri,
      data: data
  )

  TaskInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
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.



105
106
107
108
109
110
111
112
113
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 105

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of TaskInstance



159
160
161
162
163
164
165
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 159

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

Parameters:

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

    The priority

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

    The assignment_status

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

    The workflow_sid

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

    The workflow_name

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

    The task_queue_sid

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

    The task_queue_name

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

    The evaluate_task_attributes

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

    The ordering

  • has_addons (Boolean) (defaults to: :unset) —

    The has_addons

  • 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



46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 46

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, 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,
      ordering: ordering,
      has_addons: has_addons,
      limit: limit,
      page_size: page_size
  ).entries
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, 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.

Parameters:

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

    The priority

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

    The assignment_status

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

    The workflow_sid

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

    The workflow_name

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

    The task_queue_sid

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

    The task_queue_name

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

    The evaluate_task_attributes

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

    The ordering

  • has_addons (Boolean) (defaults to: :unset) —

    The has_addons

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



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 131

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, 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,
      'Ordering' => ordering,
      'HasAddons' => has_addons,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  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, ordering: :unset, has_addons: :unset, limit: nil, page_size: nil) ⇒ Enumerable

Streams TaskInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.

Parameters:

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

    The priority

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

    The assignment_status

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

    The workflow_sid

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

    The workflow_name

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

    The task_queue_sid

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

    The task_queue_name

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

    The evaluate_task_attributes

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

    The ordering

  • has_addons (Boolean) (defaults to: :unset) —

    The has_addons

  • 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



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task.rb', line 82

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



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

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