twilio-ruby 5.5.1 → 5.58.3

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_cumulative_statistics.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -14,8 +16,10 @@ module Twilio
               ##
               # Initialize the WorkflowCumulativeStatisticsList
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
-              # @param [String] workflow_sid The workflow_sid
+              # @param [String] workspace_sid The SID of the Workspace that contains the
+              #   Workflow.
+              # @param [String] workflow_sid Returns the list of Tasks that are being controlled
+              #   by the Workflow with the specified Sid value.
               # @return [WorkflowCumulativeStatisticsList] WorkflowCumulativeStatisticsList
               def initialize(version, workspace_sid: nil, workflow_sid: nil)
                 super(version)
@@ -69,24 +73,39 @@ module Twilio
               ##
               # Initialize the WorkflowCumulativeStatisticsContext
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
-              # @param [String] workflow_sid The workflow_sid
+              # @param [String] workspace_sid The SID of the Workspace with the resource to
+              #   fetch.
+              # @param [String] workflow_sid Returns the list of Tasks that are being controlled
+              #   by the Workflow with the specified Sid value.
               # @return [WorkflowCumulativeStatisticsContext] WorkflowCumulativeStatisticsContext
               def initialize(version, workspace_sid, workflow_sid)
                 super(version)
 
                 # Path Solution
-                @solution = {workspace_sid: workspace_sid, workflow_sid: workflow_sid}
+                @solution = {workspace_sid: workspace_sid, workflow_sid: workflow_sid, }
                 @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workflows/#{@solution[:workflow_sid]}/CumulativeStatistics"
               end
 
               ##
-              # Fetch a WorkflowCumulativeStatisticsInstance
-              # @param [Time] end_date The end_date
-              # @param [String] minutes The minutes
-              # @param [Time] start_date The start_date
-              # @param [String] task_channel The task_channel
-              # @param [String] split_by_wait_time The split_by_wait_time
+              # Fetch the WorkflowCumulativeStatisticsInstance
+              # @param [Time] end_date Only include usage that occurred on or before this date,
+              #   specified in GMT as an {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601]
+              #   date-time.
+              # @param [String] minutes 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.
+              # @param [Time] start_date Only calculate statistics from this date and time and
+              #   later, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format.
+              # @param [String] task_channel Only calculate cumulative statistics on this
+              #   TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`,
+              #   `sms`, or `default`.
+              # @param [String] split_by_wait_time 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.
               # @return [WorkflowCumulativeStatisticsInstance] Fetched WorkflowCumulativeStatisticsInstance
               def fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset)
                 params = Twilio::Values.of({
@@ -97,11 +116,7 @@ module Twilio
                     'SplitByWaitTime' => split_by_wait_time,
                 })
 
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri, params: params)
 
                 WorkflowCumulativeStatisticsInstance.new(
                     @version,
@@ -117,6 +132,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Taskrouter.V1.WorkflowCumulativeStatisticsContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Taskrouter.V1.WorkflowCumulativeStatisticsContext #{context}>"
+              end
             end
 
             class WorkflowCumulativeStatisticsInstance < InstanceResource
@@ -124,8 +146,10 @@ module Twilio
               # Initialize the WorkflowCumulativeStatisticsInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] workspace_sid The workspace_sid
-              # @param [String] workflow_sid The workflow_sid
+              # @param [String] workspace_sid The SID of the Workspace that contains the
+              #   Workflow.
+              # @param [String] workflow_sid Returns the list of Tasks that are being controlled
+              #   by the Workflow with the specified Sid value.
               # @return [WorkflowCumulativeStatisticsInstance] WorkflowCumulativeStatisticsInstance
               def initialize(version, payload, workspace_sid: nil, workflow_sid: nil)
                 super(version)
@@ -158,7 +182,7 @@ module Twilio
 
                 # Context
                 @instance_context = nil
-                @params = {'workspace_sid' => workspace_sid, 'workflow_sid' => workflow_sid}
+                @params = {'workspace_sid' => workspace_sid, 'workflow_sid' => workflow_sid, }
               end
 
               ##
@@ -177,144 +201,157 @@ module Twilio
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The avg_task_acceptance_time
+              # @return [String] The average time in seconds between Task creation and acceptance
               def avg_task_acceptance_time
                 @properties['avg_task_acceptance_time']
               end
 
               ##
-              # @return [Time] The start_time
+              # @return [Time] The beginning of the interval during which these statistics were calculated
               def start_time
                 @properties['start_time']
               end
 
               ##
-              # @return [Time] The end_time
+              # @return [Time] The end of the interval during which these statistics were calculated
               def end_time
                 @properties['end_time']
               end
 
               ##
-              # @return [String] The reservations_created
+              # @return [String] The total number of Reservations that were created for Workers
               def reservations_created
                 @properties['reservations_created']
               end
 
               ##
-              # @return [String] The reservations_accepted
+              # @return [String] The total number of Reservations accepted by Workers
               def reservations_accepted
                 @properties['reservations_accepted']
               end
 
               ##
-              # @return [String] The reservations_rejected
+              # @return [String] The total number of Reservations that were rejected
               def reservations_rejected
                 @properties['reservations_rejected']
               end
 
               ##
-              # @return [String] The reservations_timed_out
+              # @return [String] The total number of Reservations that were timed out
               def reservations_timed_out
                 @properties['reservations_timed_out']
               end
 
               ##
-              # @return [String] The reservations_canceled
+              # @return [String] The total number of Reservations that were canceled
               def reservations_canceled
                 @properties['reservations_canceled']
               end
 
               ##
-              # @return [String] The reservations_rescinded
+              # @return [String] The total number of Reservations that were rescinded
               def reservations_rescinded
                 @properties['reservations_rescinded']
               end
 
               ##
-              # @return [Hash] The split_by_wait_time
+              # @return [Hash] A list of objects that describe the Tasks canceled and reservations accepted above and below the specified thresholds
               def split_by_wait_time
                 @properties['split_by_wait_time']
               end
 
               ##
-              # @return [Hash] The wait_duration_until_accepted
+              # @return [Hash] The wait duration statistics for Tasks that were accepted
               def wait_duration_until_accepted
                 @properties['wait_duration_until_accepted']
               end
 
               ##
-              # @return [Hash] The wait_duration_until_canceled
+              # @return [Hash] The wait duration statistics for Tasks that were canceled
               def wait_duration_until_canceled
                 @properties['wait_duration_until_canceled']
               end
 
               ##
-              # @return [String] The tasks_canceled
+              # @return [String] The total number of Tasks that were canceled
               def tasks_canceled
                 @properties['tasks_canceled']
               end
 
               ##
-              # @return [String] The tasks_completed
+              # @return [String] The total number of Tasks that were completed
               def tasks_completed
                 @properties['tasks_completed']
               end
 
               ##
-              # @return [String] The tasks_entered
+              # @return [String] The total number of Tasks that entered the Workflow
               def tasks_entered
                 @properties['tasks_entered']
               end
 
               ##
-              # @return [String] The tasks_deleted
+              # @return [String] The total number of Tasks that were deleted
               def tasks_deleted
                 @properties['tasks_deleted']
               end
 
               ##
-              # @return [String] The tasks_moved
+              # @return [String] The total number of Tasks that were moved from one queue to another
               def tasks_moved
                 @properties['tasks_moved']
               end
 
               ##
-              # @return [String] The tasks_timed_out_in_workflow
+              # @return [String] The total number of Tasks that were timed out of their Workflows
               def tasks_timed_out_in_workflow
                 @properties['tasks_timed_out_in_workflow']
               end
 
               ##
-              # @return [String] The workflow_sid
+              # @return [String] Returns the list of Tasks that are being controlled by the Workflow with the specified Sid value
               def workflow_sid
                 @properties['workflow_sid']
               end
 
               ##
-              # @return [String] The workspace_sid
+              # @return [String] The SID of the Workspace that contains the Workflow.
               def workspace_sid
                 @properties['workspace_sid']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The absolute URL of the Workflow statistics resource
               def url
                 @properties['url']
               end
 
               ##
-              # Fetch a WorkflowCumulativeStatisticsInstance
-              # @param [Time] end_date The end_date
-              # @param [String] minutes The minutes
-              # @param [Time] start_date The start_date
-              # @param [String] task_channel The task_channel
-              # @param [String] split_by_wait_time The split_by_wait_time
+              # Fetch the WorkflowCumulativeStatisticsInstance
+              # @param [Time] end_date Only include usage that occurred on or before this date,
+              #   specified in GMT as an {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601]
+              #   date-time.
+              # @param [String] minutes 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.
+              # @param [Time] start_date Only calculate statistics from this date and time and
+              #   later, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format.
+              # @param [String] task_channel Only calculate cumulative statistics on this
+              #   TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`,
+              #   `sms`, or `default`.
+              # @param [String] split_by_wait_time 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.
               # @return [WorkflowCumulativeStatisticsInstance] Fetched WorkflowCumulativeStatisticsInstance
               def fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset)
                 context.fetch(

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -14,8 +16,10 @@ module Twilio
               ##
               # Initialize the WorkflowRealTimeStatisticsList
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
-              # @param [String] workflow_sid The workflow_sid
+              # @param [String] workspace_sid The SID of the Workspace that contains the
+              #   Workflow.
+              # @param [String] workflow_sid Returns the list of Tasks that are being controlled
+              #   by the Workflow with the specified SID value.
               # @return [WorkflowRealTimeStatisticsList] WorkflowRealTimeStatisticsList
               def initialize(version, workspace_sid: nil, workflow_sid: nil)
                 super(version)
@@ -69,29 +73,29 @@ module Twilio
               ##
               # Initialize the WorkflowRealTimeStatisticsContext
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
-              # @param [String] workflow_sid The workflow_sid
+              # @param [String] workspace_sid The SID of the Workspace with the Workflow to
+              #   fetch.
+              # @param [String] workflow_sid Returns the list of Tasks that are being controlled
+              #   by the Workflow with the specified SID value.
               # @return [WorkflowRealTimeStatisticsContext] WorkflowRealTimeStatisticsContext
               def initialize(version, workspace_sid, workflow_sid)
                 super(version)
 
                 # Path Solution
-                @solution = {workspace_sid: workspace_sid, workflow_sid: workflow_sid}
+                @solution = {workspace_sid: workspace_sid, workflow_sid: workflow_sid, }
                 @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workflows/#{@solution[:workflow_sid]}/RealTimeStatistics"
               end
 
               ##
-              # Fetch a WorkflowRealTimeStatisticsInstance
-              # @param [String] task_channel The task_channel
+              # Fetch the WorkflowRealTimeStatisticsInstance
+              # @param [String] task_channel Only calculate real-time statistics on this
+              #   TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`,
+              #   `sms`, or `default`.
               # @return [WorkflowRealTimeStatisticsInstance] Fetched WorkflowRealTimeStatisticsInstance
               def fetch(task_channel: :unset)
-                params = Twilio::Values.of({'TaskChannel' => task_channel})
+                params = Twilio::Values.of({'TaskChannel' => task_channel, })
 
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri, params: params)
 
                 WorkflowRealTimeStatisticsInstance.new(
                     @version,
@@ -107,6 +111,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Taskrouter.V1.WorkflowRealTimeStatisticsContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Taskrouter.V1.WorkflowRealTimeStatisticsContext #{context}>"
+              end
             end
 
             class WorkflowRealTimeStatisticsInstance < InstanceResource
@@ -114,8 +125,10 @@ module Twilio
               # Initialize the WorkflowRealTimeStatisticsInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] workspace_sid The workspace_sid
-              # @param [String] workflow_sid The workflow_sid
+              # @param [String] workspace_sid The SID of the Workspace that contains the
+              #   Workflow.
+              # @param [String] workflow_sid Returns the list of Tasks that are being controlled
+              #   by the Workflow with the specified SID value.
               # @return [WorkflowRealTimeStatisticsInstance] WorkflowRealTimeStatisticsInstance
               def initialize(version, payload, workspace_sid: nil, workflow_sid: nil)
                 super(version)
@@ -124,6 +137,7 @@ module Twilio
                 @properties = {
                     'account_sid' => payload['account_sid'],
                     'longest_task_waiting_age' => payload['longest_task_waiting_age'].to_i,
+                    'longest_task_waiting_sid' => payload['longest_task_waiting_sid'],
                     'tasks_by_priority' => payload['tasks_by_priority'],
                     'tasks_by_status' => payload['tasks_by_status'],
                     'total_tasks' => payload['total_tasks'].to_i,
@@ -134,7 +148,7 @@ module Twilio
 
                 # Context
                 @instance_context = nil
-                @params = {'workspace_sid' => workspace_sid, 'workflow_sid' => workflow_sid}
+                @params = {'workspace_sid' => workspace_sid, 'workflow_sid' => workflow_sid, }
               end
 
               ##
@@ -153,59 +167,67 @@ module Twilio
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The longest_task_waiting_age
+              # @return [String] The age of the longest waiting Task
               def longest_task_waiting_age
                 @properties['longest_task_waiting_age']
               end
 
               ##
-              # @return [Hash] The tasks_by_priority
+              # @return [String] The SID of the longest waiting Task
+              def longest_task_waiting_sid
+                @properties['longest_task_waiting_sid']
+              end
+
+              ##
+              # @return [Hash] The number of Tasks by priority
               def tasks_by_priority
                 @properties['tasks_by_priority']
               end
 
               ##
-              # @return [Hash] The tasks_by_status
+              # @return [Hash] The number of Tasks by their current status
               def tasks_by_status
                 @properties['tasks_by_status']
               end
 
               ##
-              # @return [String] The total_tasks
+              # @return [String] The total number of Tasks
               def total_tasks
                 @properties['total_tasks']
               end
 
               ##
-              # @return [String] The workflow_sid
+              # @return [String] Returns the list of Tasks that are being controlled by the Workflow with the specified SID value
               def workflow_sid
                 @properties['workflow_sid']
               end
 
               ##
-              # @return [String] The workspace_sid
+              # @return [String] The SID of the Workspace that contains the Workflow.
               def workspace_sid
                 @properties['workspace_sid']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The absolute URL of the Workflow statistics resource
               def url
                 @properties['url']
               end
 
               ##
-              # Fetch a WorkflowRealTimeStatisticsInstance
-              # @param [String] task_channel The task_channel
+              # Fetch the WorkflowRealTimeStatisticsInstance
+              # @param [String] task_channel Only calculate real-time statistics on this
+              #   TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`,
+              #   `sms`, or `default`.
               # @return [WorkflowRealTimeStatisticsInstance] Fetched WorkflowRealTimeStatisticsInstance
               def fetch(task_channel: :unset)
-                context.fetch(task_channel: task_channel)
+                context.fetch(task_channel: task_channel, )
               end
 
               ##