Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::WorkspaceCumulativeStatisticsInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, workspace_sid: nil) ⇒ WorkspaceCumulativeStatisticsInstance

Initialize the WorkspaceCumulativeStatisticsInstance

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.


143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 143

def initialize(version, payload, workspace_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'],
      '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_created' => payload['tasks_created'].to_i,
      'tasks_deleted' => payload['tasks_deleted'].to_i,
      'tasks_moved' => payload['tasks_moved'].to_i,
      'tasks_timed_out_in_workflow' => payload['tasks_timed_out_in_workflow'].to_i,
      'workspace_sid' => payload['workspace_sid'],
      'url' => payload['url'],
  }

  # Context
  @instance_context = nil
  @params = {'workspace_sid' => workspace_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


189
190
191
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 189

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


195
196
197
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 195

def avg_task_acceptance_time
  @properties['avg_task_acceptance_time']
end

#context ⇒ WorkspaceCumulativeStatisticsContext

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

Returns:


180
181
182
183
184
185
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 180

def context
  unless @instance_context
    @instance_context = WorkspaceCumulativeStatisticsContext.new(@version, @params['workspace_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


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

def end_time
  @properties['end_time']
end

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

Fetch the WorkspaceCumulativeStatisticsInstance

Parameters:

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

    Only include usage that occurred on or before this date, 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 15 minutes. This is helpful for displaying statistics for the last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.

  • 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. For example, `5,30` would show splits of Tasks that were canceled or accepted before and after 5 seconds and before and after 30 seconds. This can be used to show short abandoned Tasks or Tasks that failed to meet an SLA. TaskRouter will calculate statistics on up to 10,000 Tasks for any given threshold.

Returns:


335
336
337
338
339
340
341
342
343
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 335

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


354
355
356
357
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 354

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

#reservations_accepted ⇒ String

Returns The total number of Reservations accepted by Workers.

Returns:

  • (String) —

    The total number of Reservations accepted by Workers


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

def reservations_accepted
  @properties['reservations_accepted']
end

#reservations_canceled ⇒ String

Returns The total number of Reservations that were canceled.

Returns:

  • (String) —

    The total number of Reservations that were canceled


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

def reservations_canceled
  @properties['reservations_canceled']
end

#reservations_created ⇒ String

Returns The total number of Reservations that were created for Workers.

Returns:

  • (String) —

    The total number of Reservations that were created for Workers


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

def reservations_created
  @properties['reservations_created']
end

#reservations_rejected ⇒ String

Returns The total number of Reservations that were rejected.

Returns:

  • (String) —

    The total number of Reservations that were rejected


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

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


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

def reservations_rescinded
  @properties['reservations_rescinded']
end

#reservations_timed_out ⇒ String

Returns The total number of Reservations that were timed out.

Returns:

  • (String) —

    The total number of Reservations that were timed out


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

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


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

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


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

def start_time
  @properties['start_time']
end

#tasks_canceled ⇒ String

Returns The total number of Tasks that were canceled.

Returns:

  • (String) —

    The total number of Tasks that were canceled


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

def tasks_canceled
  @properties['tasks_canceled']
end

#tasks_completed ⇒ String

Returns The total number of Tasks that were completed.

Returns:

  • (String) —

    The total number of Tasks that were completed


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

def tasks_completed
  @properties['tasks_completed']
end

#tasks_created ⇒ String

Returns The total number of Tasks created.

Returns:

  • (String) —

    The total number of Tasks created


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

def tasks_created
  @properties['tasks_created']
end

#tasks_deleted ⇒ String

Returns The total number of Tasks that were deleted.

Returns:

  • (String) —

    The total number of Tasks that were deleted


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

def tasks_deleted
  @properties['tasks_deleted']
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


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

def tasks_moved
  @properties['tasks_moved']
end

#tasks_timed_out_in_workflow ⇒ String

Returns The total number of Tasks that were timed out of their Workflows.

Returns:

  • (String) —

    The total number of Tasks that were timed out of their Workflows


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

def tasks_timed_out_in_workflow
  @properties['tasks_timed_out_in_workflow']
end

#to_s ⇒ Object

Provide a user friendly representation


347
348
349
350
 
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workspace_cumulative_statistics.rb', line 347

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

#url ⇒ String

Returns The absolute URL of the Workspace statistics resource.

Returns:

  • (String) —

    The absolute URL of the Workspace statistics resource


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

def url
  @properties['url']
end

#wait_duration_until_accepted ⇒ Hash

Returns The wait duration statistics for Tasks that were accepted.

Returns:

  • (Hash) —

    The wait duration statistics for Tasks that were accepted


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

def wait_duration_until_accepted
  @properties['wait_duration_until_accepted']
end

#wait_duration_until_canceled ⇒ Hash

Returns The wait duration statistics for Tasks that were canceled.

Returns:

  • (Hash) —

    The wait duration statistics for Tasks that were canceled


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

def wait_duration_until_canceled
  @properties['wait_duration_until_canceled']
end

#workspace_sid ⇒ String

Returns The SID of the Workspace.

Returns:

  • (String) —

    The SID of the Workspace


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

def workspace_sid
  @properties['workspace_sid']
end