Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::TaskQueueList::TaskQueuesStatisticsList
- Inherits:
-
ListResource
- Object
- ListResource
- Twilio::REST::Taskrouter::V1::WorkspaceContext::TaskQueueList::TaskQueuesStatisticsList
- Defined in:
- lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb
Instance Method Summary collapse
-
#each ⇒ Object
When passed a block, yields TaskQueuesStatisticsInstance records from the API.
-
#get_page(target_url) ⇒ Page
Retrieve a single page of TaskQueuesStatisticsInstance records from the API.
-
#initialize(version, workspace_sid: nil) ⇒ TaskQueuesStatisticsList
constructor
Initialize the TaskQueuesStatisticsList.
-
#list(end_date: :unset, friendly_name: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset, limit: nil, page_size: nil) ⇒ Array
Lists TaskQueuesStatisticsInstance records from the API as a list.
-
#page(end_date: :unset, friendly_name: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of TaskQueuesStatisticsInstance records from the API.
-
#stream(end_date: :unset, friendly_name: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams TaskQueuesStatisticsInstance records from the API as an Enumerable.
-
#to_s ⇒ Object
Provide a user friendly representation.
Constructor Details
#initialize(version, workspace_sid: nil) ⇒ TaskQueuesStatisticsList
Initialize the TaskQueuesStatisticsList
22 23 24 25 26 27 28 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb', line 22 def initialize(version, workspace_sid: nil) super(version) # Path Solution @solution = {workspace_sid: workspace_sid} @uri = "/Workspaces/#{@solution[:workspace_sid]}/TaskQueues/Statistics" end |
Instance Method Details
#each ⇒ Object
When passed a block, yields TaskQueuesStatisticsInstance records from the API. This operation lazily loads records as efficiently as possible until the limit is reached.
117 118 119 120 121 122 123 124 125 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb', line 117 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 TaskQueuesStatisticsInstance records from the API. Request is executed immediately.
173 174 175 176 177 178 179 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb', line 173 def get_page(target_url) response = @version.domain.request( 'GET', target_url ) TaskQueuesStatisticsPage.new(@version, response, @solution) end |
#list(end_date: :unset, friendly_name: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset, limit: nil, page_size: nil) ⇒ Array
Lists TaskQueuesStatisticsInstance records from the API as a list. Unlike stream(), this operation is eager and will load `limit` records into memory before returning.
57 58 59 60 61 62 63 64 65 66 67 68 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb', line 57 def list(end_date: :unset, friendly_name: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset, limit: nil, page_size: nil) self.stream( end_date: end_date, friendly_name: friendly_name, minutes: minutes, start_date: start_date, task_channel: task_channel, split_by_wait_time: split_by_wait_time, limit: limit, page_size: page_size ).entries end |
#page(end_date: :unset, friendly_name: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset, page_token: :unset, page_number: :unset, page_size: :unset) ⇒ Page
Retrieve a single page of TaskQueuesStatisticsInstance records from the API. Request is executed immediately.
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb', line 150 def page(end_date: :unset, friendly_name: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset, page_token: :unset, page_number: :unset, page_size: :unset) params = Twilio::Values.of({ 'EndDate' => Twilio.serialize_iso8601_datetime(end_date), 'FriendlyName' => friendly_name, 'Minutes' => minutes, 'StartDate' => Twilio.serialize_iso8601_datetime(start_date), 'TaskChannel' => task_channel, 'SplitByWaitTime' => split_by_wait_time, 'PageToken' => page_token, 'Page' => page_number, 'PageSize' => page_size, }) response = @version.page('GET', @uri, params: params) TaskQueuesStatisticsPage.new(@version, response, @solution) end |
#stream(end_date: :unset, friendly_name: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset, limit: nil, page_size: nil) ⇒ Enumerable
Streams TaskQueuesStatisticsInstance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.
97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb', line 97 def stream(end_date: :unset, friendly_name: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset, limit: nil, page_size: nil) limits = @version.read_limits(limit, page_size) page = self.page( end_date: end_date, friendly_name: friendly_name, minutes: minutes, start_date: start_date, task_channel: task_channel, split_by_wait_time: split_by_wait_time, 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
183 184 185 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb', line 183 def to_s '#<Twilio.Taskrouter.V1.TaskQueuesStatisticsList>' end |