Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::TaskQueueContext::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

Parameters:

  • version (Version) —

    Version that contains the resource

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

    The workspace_sid



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

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.



96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb', line 96

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.

Parameters:

  • target_url (String) —

    API-generated URL for the requested results page

Returns:

  • (Page) —

    Page of TaskQueuesStatisticsInstance



146
147
148
149
150
151
152
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb', line 146

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.

Parameters:

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

    The end_date

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

    The friendly_name

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

    The minutes

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

    The start_date

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

    The task_channel

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

    The split_by_wait_time

  • 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
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb', line 46

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.

Parameters:

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

    The end_date

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

    The friendly_name

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

    The minutes

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

    The start_date

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

    The task_channel

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

    The split_by_wait_time

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



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

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

Parameters:

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

    The end_date

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

    The friendly_name

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

    The minutes

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

    The start_date

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

    The task_channel

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

    The split_by_wait_time

  • 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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb', line 76

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



156
157
158
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queues_statistics.rb', line 156

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