Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::EventList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid: nil) ⇒ EventList

Initialize the EventList



20
21
22
23
24
25
26
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 20

def initialize(version, workspace_sid: nil)
  super(version)

  # Path Solution
  @solution = {workspace_sid: workspace_sid}
  @uri = "/Workspaces/#{@solution[:workspace_sid]}/Events"
end

Instance Method Details

#each ⇒ Object

When passed a block, yields EventInstance 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/event.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 EventInstance records from the API. Request is executed immediately.



200
201
202
203
204
205
206
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 200

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

#list(end_date: :unset, event_type: :unset, minutes: :unset, reservation_sid: :unset, start_date: :unset, task_queue_sid: :unset, task_sid: :unset, worker_sid: :unset, workflow_sid: :unset, task_channel: :unset, sid: :unset, limit: nil, page_size: nil) ⇒ Array

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



59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 59

def list(end_date: :unset, event_type: :unset, minutes: :unset, reservation_sid: :unset, start_date: :unset, task_queue_sid: :unset, task_sid: :unset, worker_sid: :unset, workflow_sid: :unset, task_channel: :unset, sid: :unset, limit: nil, page_size: nil)
  self.stream(
      end_date: end_date,
      event_type: event_type,
      minutes: minutes,
      reservation_sid: reservation_sid,
      start_date: start_date,
      task_queue_sid: task_queue_sid,
      task_sid: task_sid,
      worker_sid: worker_sid,
      workflow_sid: workflow_sid,
      task_channel: task_channel,
      sid: sid,
      limit: limit,
      page_size: page_size
  ).entries
end

#page(end_date: :unset, event_type: :unset, minutes: :unset, reservation_sid: :unset, start_date: :unset, task_queue_sid: :unset, task_sid: :unset, worker_sid: :unset, workflow_sid: :unset, task_channel: :unset, sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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



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

def page(end_date: :unset, event_type: :unset, minutes: :unset, reservation_sid: :unset, start_date: :unset, task_queue_sid: :unset, task_sid: :unset, worker_sid: :unset, workflow_sid: :unset, task_channel: :unset, sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
  params = Twilio::Values.of({
      'EndDate' => Twilio.serialize_iso8601_datetime(end_date),
      'EventType' => event_type,
      'Minutes' => minutes,
      'ReservationSid' => reservation_sid,
      'StartDate' => Twilio.serialize_iso8601_datetime(start_date),
      'TaskQueueSid' => task_queue_sid,
      'TaskSid' => task_sid,
      'WorkerSid' => worker_sid,
      'WorkflowSid' => workflow_sid,
      'TaskChannel' => task_channel,
      'Sid' => sid,
      'PageToken' => page_token,
      'Page' => page_number,
      'PageSize' => page_size,
  })
  response = @version.page(
      'GET',
      @uri,
      params
  )
  EventPage.new(@version, response, @solution)
end

#stream(end_date: :unset, event_type: :unset, minutes: :unset, reservation_sid: :unset, start_date: :unset, task_queue_sid: :unset, task_sid: :unset, worker_sid: :unset, workflow_sid: :unset, task_channel: :unset, sid: :unset, limit: nil, page_size: nil) ⇒ Enumerable

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



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 108

def stream(end_date: :unset, event_type: :unset, minutes: :unset, reservation_sid: :unset, start_date: :unset, task_queue_sid: :unset, task_sid: :unset, worker_sid: :unset, workflow_sid: :unset, task_channel: :unset, sid: :unset, limit: nil, page_size: nil)
  limits = @version.read_limits(limit, page_size)

  page = self.page(
      end_date: end_date,
      event_type: event_type,
      minutes: minutes,
      reservation_sid: reservation_sid,
      start_date: start_date,
      task_queue_sid: task_queue_sid,
      task_sid: task_sid,
      worker_sid: worker_sid,
      workflow_sid: workflow_sid,
      task_channel: task_channel,
      sid: sid,
      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



210
211
212
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 210

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