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.


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

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_sidString

Returns The SID of the Account that created the resource.

Returns:

  • (String)

    The SID of the Account that created the resource


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

def 
  @properties['account_sid']
end

#avg_task_acceptance_timeString

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

Returns:

  • (String)

    The average time in seconds between Task creation and acceptance


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

def avg_task_acceptance_time
  @properties['avg_task_acceptance_time']
end

#contextTaskQueueCumulativeStatisticsContext

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

Returns:


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

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

#end_timeTime

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


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

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 the 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 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 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. TaskRouter will calculate statistics on up to 10,000 Tasks/Reservations for any given threshold.

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

#inspectObject

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_acceptedString

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


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

def reservations_accepted
  @properties['reservations_accepted']
end

#reservations_canceledString

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


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

def reservations_canceled
  @properties['reservations_canceled']
end

#reservations_createdString

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


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

def reservations_created
  @properties['reservations_created']
end

#reservations_rejectedString

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


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

def reservations_rejected
  @properties['reservations_rejected']
end

#reservations_rescindedString

Returns The total number of Reservations rescinded.

Returns:

  • (String)

    The total number of Reservations rescinded


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

def reservations_rescinded
  @properties['reservations_rescinded']
end

#reservations_timed_outString

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


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

def reservations_timed_out
  @properties['reservations_timed_out']
end

#split_by_wait_timeHash

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


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

def split_by_wait_time
  @properties['split_by_wait_time']
end

#start_timeTime

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


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

def start_time
  @properties['start_time']
end

#task_queue_sidString

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


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

def task_queue_sid
  @properties['task_queue_sid']
end

#tasks_canceledString

Returns The total number of Tasks canceled in the TaskQueue.

Returns:

  • (String)

    The total number of Tasks canceled in the TaskQueue


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

def tasks_canceled
  @properties['tasks_canceled']
end

#tasks_completedString

Returns The total number of Tasks completed in the TaskQueue.

Returns:

  • (String)

    The total number of Tasks completed in the TaskQueue


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

def tasks_completed
  @properties['tasks_completed']
end

#tasks_deletedString

Returns The total number of Tasks deleted in the TaskQueue.

Returns:

  • (String)

    The total number of Tasks deleted in the TaskQueue


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

def tasks_deleted
  @properties['tasks_deleted']
end

#tasks_enteredString

Returns The total number of Tasks entered into the TaskQueue.

Returns:

  • (String)

    The total number of Tasks entered into the TaskQueue


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

def tasks_entered
  @properties['tasks_entered']
end

#tasks_movedString

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


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

def tasks_moved
  @properties['tasks_moved']
end

#to_sObject

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

#urlString

Returns The absolute URL of the TaskQueue statistics resource.

Returns:

  • (String)

    The absolute URL of the TaskQueue statistics resource


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

def url
  @properties['url']
end

#wait_duration_in_queue_until_acceptedHash

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


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

def wait_duration_in_queue_until_accepted
  @properties['wait_duration_in_queue_until_accepted']
end

#wait_duration_until_acceptedHash

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


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

def wait_duration_until_accepted
  @properties['wait_duration_until_accepted']
end

#wait_duration_until_canceledHash

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


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

def wait_duration_until_canceled
  @properties['wait_duration_until_canceled']
end

#workspace_sidString

Returns The SID of the Workspace that contains the TaskQueue.

Returns:

  • (String)

    The SID of the Workspace that contains the TaskQueue


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

def workspace_sid
  @properties['workspace_sid']
end