Class: Twilio::REST::Taskrouter::V1::WorkspaceContext::WorkflowContext::WorkflowCumulativeStatisticsInstance
- Inherits:
-
InstanceResource
- Object
- InstanceResource
- Twilio::REST::Taskrouter::V1::WorkspaceContext::WorkflowContext::WorkflowCumulativeStatisticsInstance
- Defined in:
- lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb
Instance Method Summary collapse
-
#account_sid ⇒ String
The SID of the [Account](www.twilio.com/docs/iam/api/account) that created the Workflow resource.
-
#avg_task_acceptance_time ⇒ String
The average time in seconds between Task creation and acceptance.
-
#context ⇒ WorkflowCumulativeStatisticsContext
Generate an instance context for the instance, the context is capable of performing various actions.
-
#end_time ⇒ Time
The end of the interval during which these statistics were calculated, in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset) ⇒ WorkflowCumulativeStatisticsInstance
Fetch the WorkflowCumulativeStatisticsInstance.
-
#initialize(version, payload, workspace_sid: nil, workflow_sid: nil) ⇒ WorkflowCumulativeStatisticsInstance
constructor
Initialize the WorkflowCumulativeStatisticsInstance.
-
#inspect ⇒ Object
Provide a detailed, user friendly representation.
-
#reservations_accepted ⇒ String
The total number of Reservations accepted by Workers.
-
#reservations_canceled ⇒ String
The total number of Reservations that were canceled.
-
#reservations_created ⇒ String
The total number of Reservations that were created for Workers.
-
#reservations_rejected ⇒ String
The total number of Reservations that were rejected.
-
#reservations_rescinded ⇒ String
The total number of Reservations that were rescinded.
-
#reservations_timed_out ⇒ String
The total number of Reservations that were timed out.
-
#split_by_wait_time ⇒ Hash
A list of objects that describe the number of Tasks canceled and reservations accepted above and below the thresholds specified in seconds.
-
#start_time ⇒ Time
The beginning of the interval during which these statistics were calculated, in [ISO 8601](en.wikipedia.org/wiki/ISO_8601) format.
-
#tasks_canceled ⇒ String
The total number of Tasks that were canceled.
-
#tasks_completed ⇒ String
The total number of Tasks that were completed.
-
#tasks_deleted ⇒ String
The total number of Tasks that were deleted.
-
#tasks_entered ⇒ String
The total number of Tasks that entered the Workflow.
-
#tasks_moved ⇒ String
The total number of Tasks that were moved from one queue to another.
-
#tasks_timed_out_in_workflow ⇒ String
The total number of Tasks that were timed out of their Workflows (and deleted).
-
#to_s ⇒ Object
Provide a user friendly representation.
-
#url ⇒ String
The absolute URL of the Workflow statistics resource.
-
#wait_duration_until_accepted ⇒ Hash
The wait duration statistics (
avg,min,max,total) for Tasks that were accepted. -
#wait_duration_until_canceled ⇒ Hash
The wait duration statistics (
avg,min,max,total) for Tasks that were canceled. -
#workflow_sid ⇒ String
Returns the list of Tasks that are being controlled by the Workflow with the specified Sid value.
-
#workspace_sid ⇒ String
The SID of the Workspace that contains the Workflow.
Constructor Details
#initialize(version, payload, workspace_sid: nil, workflow_sid: nil) ⇒ WorkflowCumulativeStatisticsInstance
Initialize the WorkflowCumulativeStatisticsInstance
308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 308 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'] == nil ? payload['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'] == nil ? payload['reservations_created'] : payload['reservations_created'].to_i, 'reservations_accepted' => payload['reservations_accepted'] == nil ? payload['reservations_accepted'] : payload['reservations_accepted'].to_i, 'reservations_rejected' => payload['reservations_rejected'] == nil ? payload['reservations_rejected'] : payload['reservations_rejected'].to_i, 'reservations_timed_out' => payload['reservations_timed_out'] == nil ? payload['reservations_timed_out'] : payload['reservations_timed_out'].to_i, 'reservations_canceled' => payload['reservations_canceled'] == nil ? payload['reservations_canceled'] : payload['reservations_canceled'].to_i, 'reservations_rescinded' => payload['reservations_rescinded'] == nil ? payload['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'] == nil ? payload['tasks_canceled'] : payload['tasks_canceled'].to_i, 'tasks_completed' => payload['tasks_completed'] == nil ? payload['tasks_completed'] : payload['tasks_completed'].to_i, 'tasks_entered' => payload['tasks_entered'] == nil ? payload['tasks_entered'] : payload['tasks_entered'].to_i, 'tasks_deleted' => payload['tasks_deleted'] == nil ? payload['tasks_deleted'] : payload['tasks_deleted'].to_i, 'tasks_moved' => payload['tasks_moved'] == nil ? payload['tasks_moved'] : payload['tasks_moved'].to_i, 'tasks_timed_out_in_workflow' => payload['tasks_timed_out_in_workflow'] == nil ? payload['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 || @properties['workspace_sid'] ,'workflow_sid' => workflow_sid || @properties['workflow_sid'] , } end |
Instance Method Details
#account_sid ⇒ String
356 357 358 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 356 def account_sid @properties['account_sid'] end |
#avg_task_acceptance_time ⇒ String
362 363 364 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 362 def avg_task_acceptance_time @properties['avg_task_acceptance_time'] end |
#context ⇒ WorkflowCumulativeStatisticsContext
Generate an instance context for the instance, the context is capable of performing various actions. All instance actions are proxied to the context
347 348 349 350 351 352 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 347 def context unless @instance_context @instance_context = WorkflowCumulativeStatisticsContext.new(@version , @params['workspace_sid'], @params['workflow_sid']) end @instance_context end |
#end_time ⇒ Time
374 375 376 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 374 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
494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 494 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
520 521 522 523 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 520 def inspect values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Taskrouter.V1.WorkflowCumulativeStatisticsInstance #{values}>" end |
#reservations_accepted ⇒ String
386 387 388 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 386 def reservations_accepted @properties['reservations_accepted'] end |
#reservations_canceled ⇒ String
404 405 406 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 404 def reservations_canceled @properties['reservations_canceled'] end |
#reservations_created ⇒ String
380 381 382 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 380 def reservations_created @properties['reservations_created'] end |
#reservations_rejected ⇒ String
392 393 394 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 392 def reservations_rejected @properties['reservations_rejected'] end |
#reservations_rescinded ⇒ String
410 411 412 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 410 def reservations_rescinded @properties['reservations_rescinded'] end |
#reservations_timed_out ⇒ String
398 399 400 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 398 def reservations_timed_out @properties['reservations_timed_out'] end |
#split_by_wait_time ⇒ Hash
416 417 418 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 416 def split_by_wait_time @properties['split_by_wait_time'] end |
#start_time ⇒ Time
368 369 370 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 368 def start_time @properties['start_time'] end |
#tasks_canceled ⇒ String
434 435 436 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 434 def tasks_canceled @properties['tasks_canceled'] end |
#tasks_completed ⇒ String
440 441 442 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 440 def tasks_completed @properties['tasks_completed'] end |
#tasks_deleted ⇒ String
452 453 454 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 452 def tasks_deleted @properties['tasks_deleted'] end |
#tasks_entered ⇒ String
446 447 448 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 446 def tasks_entered @properties['tasks_entered'] end |
#tasks_moved ⇒ String
458 459 460 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 458 def tasks_moved @properties['tasks_moved'] end |
#tasks_timed_out_in_workflow ⇒ String
464 465 466 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 464 def tasks_timed_out_in_workflow @properties['tasks_timed_out_in_workflow'] end |
#to_s ⇒ Object
Provide a user friendly representation
513 514 515 516 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 513 def to_s values = @params.map{|k, v| "#{k}: #{v}"}.join(" ") "<Twilio.Taskrouter.V1.WorkflowCumulativeStatisticsInstance #{values}>" end |
#url ⇒ String
482 483 484 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 482 def url @properties['url'] end |
#wait_duration_until_accepted ⇒ Hash
422 423 424 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 422 def wait_duration_until_accepted @properties['wait_duration_until_accepted'] end |
#wait_duration_until_canceled ⇒ Hash
428 429 430 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 428 def wait_duration_until_canceled @properties['wait_duration_until_canceled'] end |
#workflow_sid ⇒ String
470 471 472 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 470 def workflow_sid @properties['workflow_sid'] end |
#workspace_sid ⇒ String
476 477 478 |
# File 'lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb', line 476 def workspace_sid @properties['workspace_sid'] end |