Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::TaskQueueList::TaskQueuesStatisticsList

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

Instance Method Summary collapse

Constructor Details

#initialize(version, workspace_sid: nil) ⇒ TaskQueuesStatisticsList

Initialize the TaskQueuesStatisticsList



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

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.



103
104
105
106
107
108
109
110
111
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb', line 103

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.



149
150
151
152
153
154
155
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb', line 149

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.



54
55
56
57
58
59
60
61
62
63
64
65
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb', line 54

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.



126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb', line 126

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 Instance records from the API as an Enumerable. This operation lazily loads records as efficiently as possible until the limit is reached.



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

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



160
161
162
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb', line 160

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