Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::WorkflowContext::WorkflowCumulativeStatisticsInstance

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

Instance Method Summary collapse

Constructor Details

#initialize(version, payload, workspace_sid: nil, workflow_sid: nil) ⇒ WorkflowCumulativeStatisticsInstance

Initialize the WorkflowCumulativeStatisticsInstance

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

  • workflow_sid (String) (defaults to: nil)

    Returns the list of Tasks that are being controlled by the Workflow with the specified Sid value.


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
187
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 155

def initialize(version, payload, workspace_sid: nil, workflow_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_entered' => payload['tasks_entered'].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,
      'workflow_sid' => payload['workflow_sid'],
      'workspace_sid' => payload['workspace_sid'],
      'url' => payload['url'],
  }

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


206
207
208
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 206

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


212
213
214
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 212

def avg_task_acceptance_time
  @properties['avg_task_acceptance_time']
end

#contextWorkflowCumulativeStatisticsContext

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

Returns:


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

def context
  unless @instance_context
    @instance_context = WorkflowCumulativeStatisticsContext.new(
        @version,
        @params['workspace_sid'],
        @params['workflow_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


224
225
226
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 224

def end_time
  @properties['end_time']
end

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

Fetch the WorkflowCumulativeStatisticsInstance

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:


358
359
360
361
362
363
364
365
366
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 358

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


377
378
379
380
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 377

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

#reservations_acceptedString

Returns The total number of Reservations accepted by Workers.

Returns:

  • (String)

    The total number of Reservations accepted by Workers


236
237
238
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 236

def reservations_accepted
  @properties['reservations_accepted']
end

#reservations_canceledString

Returns The total number of Reservations that were canceled.

Returns:

  • (String)

    The total number of Reservations that were canceled


254
255
256
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 254

def reservations_canceled
  @properties['reservations_canceled']
end

#reservations_createdString

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

Returns:

  • (String)

    The total number of Reservations that were created for Workers


230
231
232
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 230

def reservations_created
  @properties['reservations_created']
end

#reservations_rejectedString

Returns The total number of Reservations that were rejected.

Returns:

  • (String)

    The total number of Reservations that were rejected


242
243
244
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 242

def reservations_rejected
  @properties['reservations_rejected']
end

#reservations_rescindedString

Returns The total number of Reservations that were rescinded.

Returns:

  • (String)

    The total number of Reservations that were rescinded


260
261
262
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 260

def reservations_rescinded
  @properties['reservations_rescinded']
end

#reservations_timed_outString

Returns The total number of Reservations that were timed out.

Returns:

  • (String)

    The total number of Reservations that were timed out


248
249
250
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 248

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


266
267
268
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 266

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


218
219
220
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 218

def start_time
  @properties['start_time']
end

#tasks_canceledString

Returns The total number of Tasks that were canceled.

Returns:

  • (String)

    The total number of Tasks that were canceled


284
285
286
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 284

def tasks_canceled
  @properties['tasks_canceled']
end

#tasks_completedString

Returns The total number of Tasks that were completed.

Returns:

  • (String)

    The total number of Tasks that were completed


290
291
292
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 290

def tasks_completed
  @properties['tasks_completed']
end

#tasks_deletedString

Returns The total number of Tasks that were deleted.

Returns:

  • (String)

    The total number of Tasks that were deleted


302
303
304
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 302

def tasks_deleted
  @properties['tasks_deleted']
end

#tasks_enteredString

Returns The total number of Tasks that entered the Workflow.

Returns:

  • (String)

    The total number of Tasks that entered the Workflow


296
297
298
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 296

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


308
309
310
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 308

def tasks_moved
  @properties['tasks_moved']
end

#tasks_timed_out_in_workflowString

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


314
315
316
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 314

def tasks_timed_out_in_workflow
  @properties['tasks_timed_out_in_workflow']
end

#to_sObject

Provide a user friendly representation


370
371
372
373
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 370

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

#urlString

Returns The absolute URL of the Workflow statistics resource.

Returns:

  • (String)

    The absolute URL of the Workflow statistics resource


332
333
334
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 332

def url
  @properties['url']
end

#wait_duration_until_acceptedHash

Returns The wait duration statistics for Tasks that were accepted.

Returns:

  • (Hash)

    The wait duration statistics for Tasks that were accepted


272
273
274
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 272

def wait_duration_until_accepted
  @properties['wait_duration_until_accepted']
end

#wait_duration_until_canceledHash

Returns The wait duration statistics for Tasks that were canceled.

Returns:

  • (Hash)

    The wait duration statistics for Tasks that were canceled


278
279
280
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 278

def wait_duration_until_canceled
  @properties['wait_duration_until_canceled']
end

#workflow_sidString

Returns the list of Tasks that are being controlled by the Workflow with the specified Sid value

Returns:

  • (String)

    Returns the list of Tasks that are being controlled by the Workflow with the specified Sid value


320
321
322
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 320

def workflow_sid
  @properties['workflow_sid']
end

#workspace_sidString

Returns The SID of the Workspace that contains the Workflow.

Returns:

  • (String)

    The SID of the Workspace that contains the Workflow.


326
327
328
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 326

def workspace_sid
  @properties['workspace_sid']
end