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

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, workspace_sid: nil, task_queue_sid: nil) ⇒ TaskQueueCumulativeStatisticsInstance

Initialize the TaskQueueCumulativeStatisticsInstance

Parameters:

  • version (Version) —

    Version that contains the resource

  • payload (Hash) —

    payload that contains response from Twilio

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

    The SID of the Workspace that contains the TaskQueue.

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

    The SID of the TaskQueue from which these statistics were calculated.



154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 154

def initialize(version, payload, workspace_sid: nil, task_queue_sid: nil)
  super(version)

  # Marshaled Properties
  @properties = {
      'account_sid' => payload['account_sid'],
      'avg_task_acceptance_time' => payload['avg_task_acceptance_time'].to_i,
      'start_time' => Twilio.deserialize_iso8601_datetime(payload['start_time']),
      'end_time' => Twilio.deserialize_iso8601_datetime(payload['end_time']),
      'reservations_created' => payload['reservations_created'].to_i,
      'reservations_accepted' => payload['reservations_accepted'].to_i,
      'reservations_rejected' => payload['reservations_rejected'].to_i,
      'reservations_timed_out' => payload['reservations_timed_out'].to_i,
      'reservations_canceled' => payload['reservations_canceled'].to_i,
      'reservations_rescinded' => payload['reservations_rescinded'].to_i,
      'split_by_wait_time' => payload['split_by_wait_time'],
      'task_queue_sid' => payload['task_queue_sid'],
      'wait_duration_until_accepted' => payload['wait_duration_until_accepted'],
      'wait_duration_until_canceled' => payload['wait_duration_until_canceled'],
      'wait_duration_in_queue_until_accepted' => payload['wait_duration_in_queue_until_accepted'],
      'tasks_canceled' => payload['tasks_canceled'].to_i,
      'tasks_completed' => payload['tasks_completed'].to_i,
      'tasks_deleted' => payload['tasks_deleted'].to_i,
      'tasks_entered' => payload['tasks_entered'].to_i,
      'tasks_moved' => payload['tasks_moved'].to_i,
      'workspace_sid' => payload['workspace_sid'],
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {'workspace_sid' => workspace_sid, 'task_queue_sid' => task_queue_sid, }
end

Instance Method Details

#account_sid ⇒ String

Returns The SID of the Account that created the resource.

Returns:

  • (String) —

    The SID of the Account that created the resource



205
206
207
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 205

def 
  @properties['account_sid']
end

#avg_task_acceptance_time ⇒ String

Returns The average time in seconds between Task creation and acceptance.

Returns:

  • (String) —

    The average time in seconds between Task creation and acceptance



211
212
213
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 211

def avg_task_acceptance_time
  @properties['avg_task_acceptance_time']
end

#context ⇒ TaskQueueCumulativeStatisticsContext

Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context

Returns:



192
193
194
195
196
197
198
199
200
201
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 192

def context
  unless @instance_context
    @instance_context = TaskQueueCumulativeStatisticsContext.new(
        @version,
        @params['workspace_sid'],
        @params['task_queue_sid'],
    )
  end
  @instance_context
end

#end_time ⇒ Time

Returns The end of the interval during which these statistics were calculated.

Returns:

  • (Time) —

    The end of the interval during which these statistics were calculated



223
224
225
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 223

def end_time
  @properties['end_time']
end

#fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset) ⇒ TaskQueueCumulativeStatisticsInstance

Fetch a TaskQueueCumulativeStatisticsInstance

Parameters:

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

    Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](en.wikipedia.org/wiki/ISO_8601) date-time.

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

    Only calculate statistics since this many minutes in the past. The default is 15 minutes.

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

    Only calculate statistics from this date and time and later, specified in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.

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

    Only calculate cumulative statistics on this TaskChannel. Can be the TaskChannel’s SID or its ‘unique_name`, such as `voice`, `sms`, or `default`.

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

    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.

Returns:



352
353
354
355
356
357
358
359
360
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 352

def fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset)
  context.fetch(
      end_date: end_date,
      minutes: minutes,
      start_date: start_date,
      task_channel: task_channel,
      split_by_wait_time: split_by_wait_time,
  )
end

#inspect ⇒ Object

Provide a detailed, user friendly representation



371
372
373
374
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 371

def inspect
  values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Taskrouter.V1.TaskQueueCumulativeStatisticsInstance #{values}>"
end

#reservations_accepted ⇒ String

Returns The total number of Reservations accepted for Tasks in the TaskQueue.

Returns:

  • (String) —

    The total number of Reservations accepted for Tasks in the TaskQueue



235
236
237
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 235

def reservations_accepted
  @properties['reservations_accepted']
end

#reservations_canceled ⇒ String

Returns The total number of Reservations canceled for Tasks in the TaskQueue.

Returns:

  • (String) —

    The total number of Reservations canceled for Tasks in the TaskQueue



253
254
255
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 253

def reservations_canceled
  @properties['reservations_canceled']
end

#reservations_created ⇒ String

Returns The total number of Reservations created for Tasks in the TaskQueue.

Returns:

  • (String) —

    The total number of Reservations created for Tasks in the TaskQueue



229
230
231
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 229

def reservations_created
  @properties['reservations_created']
end

#reservations_rejected ⇒ String

Returns The total number of Reservations rejected for Tasks in the TaskQueue.

Returns:

  • (String) —

    The total number of Reservations rejected for Tasks in the TaskQueue



241
242
243
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 241

def reservations_rejected
  @properties['reservations_rejected']
end

#reservations_rescinded ⇒ String

Returns The total number of Reservations rescinded.

Returns:

  • (String) —

    The total number of Reservations rescinded



259
260
261
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 259

def reservations_rescinded
  @properties['reservations_rescinded']
end

#reservations_timed_out ⇒ String

Returns The total number of Reservations that timed out for Tasks in the TaskQueue.

Returns:

  • (String) —

    The total number of Reservations that timed out for Tasks in the TaskQueue



247
248
249
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 247

def reservations_timed_out
  @properties['reservations_timed_out']
end

#split_by_wait_time ⇒ Hash

Returns A list of objects that describe the Tasks canceled and reservations accepted above and below the specified thresholds.

Returns:

  • (Hash) —

    A list of objects that describe the Tasks canceled and reservations accepted above and below the specified thresholds



265
266
267
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 265

def split_by_wait_time
  @properties['split_by_wait_time']
end

#start_time ⇒ Time

Returns The beginning of the interval during which these statistics were calculated.

Returns:

  • (Time) —

    The beginning of the interval during which these statistics were calculated



217
218
219
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 217

def start_time
  @properties['start_time']
end

#task_queue_sid ⇒ String

Returns The SID of the TaskQueue from which these statistics were calculated.

Returns:

  • (String) —

    The SID of the TaskQueue from which these statistics were calculated



271
272
273
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 271

def task_queue_sid
  @properties['task_queue_sid']
end

#tasks_canceled ⇒ String

Returns The total number of Tasks canceled in the TaskQueue.

Returns:

  • (String) —

    The total number of Tasks canceled in the TaskQueue



295
296
297
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 295

def tasks_canceled
  @properties['tasks_canceled']
end

#tasks_completed ⇒ String

Returns The total number of Tasks completed in the TaskQueue.

Returns:

  • (String) —

    The total number of Tasks completed in the TaskQueue



301
302
303
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 301

def tasks_completed
  @properties['tasks_completed']
end

#tasks_deleted ⇒ String

Returns The total number of Tasks deleted in the TaskQueue.

Returns:

  • (String) —

    The total number of Tasks deleted in the TaskQueue



307
308
309
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 307

def tasks_deleted
  @properties['tasks_deleted']
end

#tasks_entered ⇒ String

Returns The total number of Tasks entered into the TaskQueue.

Returns:

  • (String) —

    The total number of Tasks entered into the TaskQueue



313
314
315
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 313

def tasks_entered
  @properties['tasks_entered']
end

#tasks_moved ⇒ String

Returns The total number of Tasks that were moved from one queue to another.

Returns:

  • (String) —

    The total number of Tasks that were moved from one queue to another



319
320
321
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 319

def tasks_moved
  @properties['tasks_moved']
end

#to_s ⇒ Object

Provide a user friendly representation



364
365
366
367
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 364

def to_s
  values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
  "<Twilio.Taskrouter.V1.TaskQueueCumulativeStatisticsInstance #{values}>"
end

#url ⇒ String

Returns The absolute URL of the TaskQueue statistics resource.

Returns:

  • (String) —

    The absolute URL of the TaskQueue statistics resource



331
332
333
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 331

def url
  @properties['url']
end

#wait_duration_in_queue_until_accepted ⇒ Hash

Returns The relative wait duration statistics for Tasks accepted while in the TaskQueue.

Returns:

  • (Hash) —

    The relative wait duration statistics for Tasks accepted while in the TaskQueue



289
290
291
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 289

def wait_duration_in_queue_until_accepted
  @properties['wait_duration_in_queue_until_accepted']
end

#wait_duration_until_accepted ⇒ Hash

Returns The wait duration statistics for Tasks accepted while in the TaskQueue.

Returns:

  • (Hash) —

    The wait duration statistics for Tasks accepted while in the TaskQueue



277
278
279
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 277

def wait_duration_until_accepted
  @properties['wait_duration_until_accepted']
end

#wait_duration_until_canceled ⇒ Hash

Returns The wait duration statistics for Tasks canceled while in the TaskQueue.

Returns:

  • (Hash) —

    The wait duration statistics for Tasks canceled while in the TaskQueue



283
284
285
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 283

def wait_duration_until_canceled
  @properties['wait_duration_until_canceled']
end

#workspace_sid ⇒ String

Returns The SID of the Workspace that contains the TaskQueue.

Returns:

  • (String) —

    The SID of the Workspace that contains the TaskQueue



325
326
327
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 325

def workspace_sid
  @properties['workspace_sid']
end