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

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The sid



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

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.



105
106
107
108
109
110
111
112
113
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.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 EventInstance records from the API. Request is executed immediately.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of EventInstance



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

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

Parameters:

  • end_date (Time) (defaults to: :unset) —

    The end_date

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

    The event_type

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

    The minutes

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

    The reservation_sid

  • start_date (Time) (defaults to: :unset) —

    The start_date

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

    The task_queue_sid

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

    The task_sid

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

    The worker_sid

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

    The workflow_sid

  • 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/event.rb', line 46

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, 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,
      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, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page

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

Parameters:

  • end_date (Time) (defaults to: :unset) —

    The end_date

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

    The event_type

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

    The minutes

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

    The reservation_sid

  • start_date (Time) (defaults to: :unset) —

    The start_date

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

    The task_queue_sid

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

    The task_sid

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

    The worker_sid

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

    The workflow_sid

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



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/event.rb', line 131

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

Parameters:

  • end_date (Time) (defaults to: :unset) —

    The end_date

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

    The event_type

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

    The minutes

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

    The reservation_sid

  • start_date (Time) (defaults to: :unset) —

    The start_date

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

    The task_queue_sid

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

    The task_sid

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

    The worker_sid

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

    The workflow_sid

  • 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/event.rb', line 82

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



169
170
171
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/event.rb', line 169

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