class Twilio::REST::Taskrouter::V1::WorkspaceContext::TaskQueueContext::TaskQueueCumulativeStatisticsInstance

Public Class Methods

new(version, payload, workspace_sid: nil, task_queue_sid: nil) click to toggle source

Initialize the TaskQueueCumulativeStatisticsInstance @param [Version] version Version that contains the resource @param [Hash] payload payload that contains response from Twilio @param [String] workspace_sid The SID of the Workspace that contains the

TaskQueue.

@param [String] task_queue_sid The SID of the TaskQueue from which these

statistics were calculated.

@return [TaskQueueCumulativeStatisticsInstance] TaskQueueCumulativeStatisticsInstance

Calls superclass method Twilio::REST::InstanceResource::new
    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
150 def initialize(version, payload, workspace_sid: nil, task_queue_sid: nil)
151   super(version)
152 
153   # Marshaled Properties
154   @properties = {
155       'account_sid' => payload['account_sid'],
156       'avg_task_acceptance_time' => payload['avg_task_acceptance_time'].to_i,
157       'start_time' => Twilio.deserialize_iso8601_datetime(payload['start_time']),
158       'end_time' => Twilio.deserialize_iso8601_datetime(payload['end_time']),
159       'reservations_created' => payload['reservations_created'].to_i,
160       'reservations_accepted' => payload['reservations_accepted'].to_i,
161       'reservations_rejected' => payload['reservations_rejected'].to_i,
162       'reservations_timed_out' => payload['reservations_timed_out'].to_i,
163       'reservations_canceled' => payload['reservations_canceled'].to_i,
164       'reservations_rescinded' => payload['reservations_rescinded'].to_i,
165       'split_by_wait_time' => payload['split_by_wait_time'],
166       'task_queue_sid' => payload['task_queue_sid'],
167       'wait_duration_until_accepted' => payload['wait_duration_until_accepted'],
168       'wait_duration_until_canceled' => payload['wait_duration_until_canceled'],
169       'wait_duration_in_queue_until_accepted' => payload['wait_duration_in_queue_until_accepted'],
170       'tasks_canceled' => payload['tasks_canceled'].to_i,
171       'tasks_completed' => payload['tasks_completed'].to_i,
172       'tasks_deleted' => payload['tasks_deleted'].to_i,
173       'tasks_entered' => payload['tasks_entered'].to_i,
174       'tasks_moved' => payload['tasks_moved'].to_i,
175       'workspace_sid' => payload['workspace_sid'],
176       'url' => payload['url'],
177   }
178 
179   # Context
180   @instance_context = nil
181   @params = {'workspace_sid' => workspace_sid, 'task_queue_sid' => task_queue_sid, }
182 end

Public Instance Methods

account_sid() click to toggle source

@return [String] The SID of the Account that created the resource

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
201 def account_sid
202   @properties['account_sid']
203 end
avg_task_acceptance_time() click to toggle source

@return [String] The average time in seconds between Task creation and acceptance

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
207 def avg_task_acceptance_time
208   @properties['avg_task_acceptance_time']
209 end
context() click to toggle source

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context @return [TaskQueueCumulativeStatisticsContext] TaskQueueCumulativeStatisticsContext for this TaskQueueCumulativeStatisticsInstance

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
188 def context
189   unless @instance_context
190     @instance_context = TaskQueueCumulativeStatisticsContext.new(
191         @version,
192         @params['workspace_sid'],
193         @params['task_queue_sid'],
194     )
195   end
196   @instance_context
197 end
end_time() click to toggle source

@return [Time] The end of the interval during which these statistics were calculated

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
219 def end_time
220   @properties['end_time']
221 end
fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset) click to toggle source

Fetch the TaskQueueCumulativeStatisticsInstance @param [Time] end_date Only calculate statistics from this date and time and

earlier, specified in GMT as an {ISO
8601}[https://en.wikipedia.org/wiki/ISO_8601] date-time.

@param [String] minutes Only calculate statistics since this many minutes in the

past. The default is 15 minutes.

@param [Time] start_date Only calculate statistics from this date and time and

later, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format.

@param [String] task_channel Only calculate cumulative statistics on this

TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`,
`sms`, or `default`.

@param [String] split_by_wait_time A comma separated list of values that

describes the thresholds, in seconds, to calculate statistics on. For each
threshold specified, the number of Tasks canceled and reservations accepted
above and below the specified thresholds in seconds are computed.

@return [TaskQueueCumulativeStatisticsInstance] Fetched TaskQueueCumulativeStatisticsInstance

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
348 def fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset)
349   context.fetch(
350       end_date: end_date,
351       minutes: minutes,
352       start_date: start_date,
353       task_channel: task_channel,
354       split_by_wait_time: split_by_wait_time,
355   )
356 end
inspect() click to toggle source

Provide a detailed, user friendly representation

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
367 def inspect
368   values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
369   "<Twilio.Taskrouter.V1.TaskQueueCumulativeStatisticsInstance #{values}>"
370 end
reservations_accepted() click to toggle source

@return [String] The total number of Reservations accepted for Tasks in the TaskQueue

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
231 def reservations_accepted
232   @properties['reservations_accepted']
233 end
reservations_canceled() click to toggle source

@return [String] The total number of Reservations canceled for Tasks in the TaskQueue

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
249 def reservations_canceled
250   @properties['reservations_canceled']
251 end
reservations_created() click to toggle source

@return [String] The total number of Reservations created for Tasks in the TaskQueue

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
225 def reservations_created
226   @properties['reservations_created']
227 end
reservations_rejected() click to toggle source

@return [String] The total number of Reservations rejected for Tasks in the TaskQueue

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
237 def reservations_rejected
238   @properties['reservations_rejected']
239 end
reservations_rescinded() click to toggle source

@return [String] The total number of Reservations rescinded

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
255 def reservations_rescinded
256   @properties['reservations_rescinded']
257 end
reservations_timed_out() click to toggle source

@return [String] The total number of Reservations that timed out for Tasks in the TaskQueue

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
243 def reservations_timed_out
244   @properties['reservations_timed_out']
245 end
split_by_wait_time() click to toggle source

@return [Hash] A list of objects that describe the Tasks canceled and reservations accepted above and below the specified thresholds

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
261 def split_by_wait_time
262   @properties['split_by_wait_time']
263 end
start_time() click to toggle source

@return [Time] The beginning of the interval during which these statistics were calculated

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
213 def start_time
214   @properties['start_time']
215 end
task_queue_sid() click to toggle source

@return [String] The SID of the TaskQueue from which these statistics were calculated

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
267 def task_queue_sid
268   @properties['task_queue_sid']
269 end
tasks_canceled() click to toggle source

@return [String] The total number of Tasks canceled in the TaskQueue

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
291 def tasks_canceled
292   @properties['tasks_canceled']
293 end
tasks_completed() click to toggle source

@return [String] The total number of Tasks completed in the TaskQueue

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
297 def tasks_completed
298   @properties['tasks_completed']
299 end
tasks_deleted() click to toggle source

@return [String] The total number of Tasks deleted in the TaskQueue

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
303 def tasks_deleted
304   @properties['tasks_deleted']
305 end
tasks_entered() click to toggle source

@return [String] The total number of Tasks entered into the TaskQueue

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
309 def tasks_entered
310   @properties['tasks_entered']
311 end
tasks_moved() click to toggle source

@return [String] The total number of Tasks that were moved from one queue to another

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
315 def tasks_moved
316   @properties['tasks_moved']
317 end
to_s() click to toggle source

Provide a user friendly representation

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
360 def to_s
361   values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
362   "<Twilio.Taskrouter.V1.TaskQueueCumulativeStatisticsInstance #{values}>"
363 end
url() click to toggle source

@return [String] The absolute URL of the TaskQueue statistics resource

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
327 def url
328   @properties['url']
329 end
wait_duration_in_queue_until_accepted() click to toggle source

@return [Hash] The relative wait duration statistics for Tasks accepted while in the TaskQueue

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
285 def wait_duration_in_queue_until_accepted
286   @properties['wait_duration_in_queue_until_accepted']
287 end
wait_duration_until_accepted() click to toggle source

@return [Hash] The wait duration statistics for Tasks accepted while in the TaskQueue

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
273 def wait_duration_until_accepted
274   @properties['wait_duration_until_accepted']
275 end
wait_duration_until_canceled() click to toggle source

@return [Hash] The wait duration statistics for Tasks canceled while in the TaskQueue

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
279 def wait_duration_until_canceled
280   @properties['wait_duration_until_canceled']
281 end
workspace_sid() click to toggle source

@return [String] The SID of the Workspace that contains the TaskQueue

    # File lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb
321 def workspace_sid
322   @properties['workspace_sid']
323 end