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 workspace_sid

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

    The task_queue_sid



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

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'],
      '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 account_sid.

Returns:

  • (String) —

    The account_sid



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

def 
  @properties['account_sid']
end

#avg_task_acceptance_time ⇒ String

Returns The average time from Task creation to reservation acceptance while in this TaskQueue.

Returns:

  • (String) —

    The average time from Task creation to reservation acceptance while in this TaskQueue



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

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:



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

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

Returns:

  • (Time) —

    The end_time



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

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

    Filter cumulative statistics by an end date. This is helpful for defining a range of statistics to capture. Input is a GMT ISO 8601 Timestamp.

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

    Filter cumulative statistics by up to ‘x’ minutes in the past. This is helpful for statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends. Defaults to 15 minutes.

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

    Filter cumulative statistics by a start date. This is helpful for defining a range of statistics to capture. Input is a GMT ISO 8601 Timestamp.

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

    Filter real-time and cumulative statistics by TaskChannel. Takes in a Unique Name (“voice”, “sms”, “default”, etc.) or a TaskChannelSid.

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

    A comma separated values for viewing splits of tasks canceled and accepted above the given threshold in seconds. Ex: “5,30” would show splits of tasks that were canceled or accepted before or after 5 seconds and respectively, 30 seconds. This is great for showing short abandoned tasks or tasks that failed to meet your SLA.

Returns:



345
346
347
348
349
350
351
352
353
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_cumulative_statistics.rb', line 345

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



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

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 that were accepted for Tasks while in this TaskQueue.

Returns:

  • (String) —

    The total number of Reservations that were accepted for Tasks while in this TaskQueue



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

def reservations_accepted
  @properties['reservations_accepted']
end

#reservations_canceled ⇒ String

Returns The total number of Reservations that were canceled for Tasks while in this TaskQueue.

Returns:

  • (String) —

    The total number of Reservations that were canceled for Tasks while in this TaskQueue



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

def reservations_canceled
  @properties['reservations_canceled']
end

#reservations_created ⇒ String

Returns The total number of Reservations that were created for Tasks while in this TaskQueue.

Returns:

  • (String) —

    The total number of Reservations that were created for Tasks while in this TaskQueue



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

def reservations_created
  @properties['reservations_created']
end

#reservations_rejected ⇒ String

Returns The total number of Reservations that were rejected for Tasks while in this TaskQueue.

Returns:

  • (String) —

    The total number of Reservations that were rejected for Tasks while in this TaskQueue



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

def reservations_rejected
  @properties['reservations_rejected']
end

#reservations_rescinded ⇒ String

Returns The total number of Reservations that were rescinded.

Returns:

  • (String) —

    The total number of Reservations that were rescinded



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

def reservations_rescinded
  @properties['reservations_rescinded']
end

#reservations_timed_out ⇒ String

Returns The total number of Reservations that were timed out for Tasks while in this TaskQueue.

Returns:

  • (String) —

    The total number of Reservations that were timed out for Tasks while in this TaskQueue



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

def reservations_timed_out
  @properties['reservations_timed_out']
end

#split_by_wait_time ⇒ Hash

Returns The splits of the tasks canceled and accepted based on the provided SplitByWaitTime parameter.

Returns:

  • (Hash) —

    The splits of the tasks canceled and accepted based on the provided SplitByWaitTime parameter



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

def split_by_wait_time
  @properties['split_by_wait_time']
end

#start_time ⇒ Time

Returns The start_time.

Returns:

  • (Time) —

    The start_time



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

def start_time
  @properties['start_time']
end

#task_queue_sid ⇒ String

Returns The task_queue_sid.

Returns:

  • (String) —

    The task_queue_sid



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

def task_queue_sid
  @properties['task_queue_sid']
end

#tasks_canceled ⇒ String

Returns The total number of Tasks canceled while in this TaskQueue.

Returns:

  • (String) —

    The total number of Tasks canceled while in this TaskQueue



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

def tasks_canceled
  @properties['tasks_canceled']
end

#tasks_completed ⇒ String

Returns The total number of Tasks completed while in this TaskQueue.

Returns:

  • (String) —

    The total number of Tasks completed while in this TaskQueue



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

def tasks_completed
  @properties['tasks_completed']
end

#tasks_deleted ⇒ String

Returns The total number of Tasks that were deleted while in this TaskQueue.

Returns:

  • (String) —

    The total number of Tasks that were deleted while in this TaskQueue



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

def tasks_deleted
  @properties['tasks_deleted']
end

#tasks_entered ⇒ String

Returns The total number of Tasks entered into this TaskQueue.

Returns:

  • (String) —

    The total number of Tasks entered into this TaskQueue



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

def tasks_entered
  @properties['tasks_entered']
end

#tasks_moved ⇒ String

Returns The total number of Tasks moved to another TaskQueue from this TaskQueue.

Returns:

  • (String) —

    The total number of Tasks moved to another TaskQueue from this TaskQueue



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

def tasks_moved
  @properties['tasks_moved']
end

#to_s ⇒ Object

Provide a user friendly representation



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

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

#url ⇒ String

Returns The url.

Returns:

  • (String) —

    The url



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

def url
  @properties['url']
end

#wait_duration_until_accepted ⇒ Hash

Returns The wait duration stats for tasks that were accepted while in this TaskQueue.

Returns:

  • (Hash) —

    The wait duration stats for tasks that were accepted while in this TaskQueue



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

def wait_duration_until_accepted
  @properties['wait_duration_until_accepted']
end

#wait_duration_until_canceled ⇒ Hash

Returns The wait duration stats for tasks that were canceled while in this TaskQueue.

Returns:

  • (Hash) —

    The wait duration stats for tasks that were canceled while in this TaskQueue



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

def wait_duration_until_canceled
  @properties['wait_duration_until_canceled']
end

#workspace_sid ⇒ String

Returns The workspace_sid.

Returns:

  • (String) —

    The workspace_sid



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

def workspace_sid
  @properties['workspace_sid']
end