twilio-ruby 5.19.0 → 5.77.0

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -16,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)
@@ -71,8 +73,10 @@ 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)
@@ -83,24 +87,26 @@ module Twilio
               end
 
               ##
-              # Fetch a WorkflowCumulativeStatisticsInstance
-              # @param [Time] end_date 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
-              # @param [String] minutes 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.
-              # @param [Time] start_date 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
-              # @param [String] task_channel Filter real-time and cumulative statistics by
-              #   TaskChannel. Takes in a Unique Name ("voice", "sms", "default", etc.) or a
-              #   TaskChannelSid.
-              # @param [String] split_by_wait_time 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.
+              # 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. TaskRouter will calculate
+              #   statistics on up to 10,000 Tasks for any given threshold.
               # @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({
@@ -111,11 +117,7 @@ module Twilio
                     'SplitByWaitTime' => split_by_wait_time,
                 })
 
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri, params: params)
 
                 WorkflowCumulativeStatisticsInstance.new(
                     @version,
@@ -131,6 +133,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
@@ -138,8 +147,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)
@@ -147,24 +158,24 @@ module Twilio
                 # Marshaled Properties
                 @properties = {
                     'account_sid' => payload['account_sid'],
-                    'avg_task_acceptance_time' => payload['avg_task_acceptance_time'].to_i,
+                    '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'].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,
+                    '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'].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,
+                    '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'],
@@ -191,25 +202,25 @@ 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 average time from Task creation to acceptance
+              # @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
@@ -251,19 +262,19 @@ module Twilio
               end
 
               ##
-              # @return [Hash] The splits of the tasks canceled and accepted based on the provided SplitByWaitTime parameter.
+              # @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 stats for tasks that were 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 stats for tasks that were canceled.
+              # @return [Hash] The wait duration statistics for Tasks that were canceled
               def wait_duration_until_canceled
                 @properties['wait_duration_until_canceled']
               end
@@ -281,7 +292,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The total number of Tasks that entered this Workflow
+              # @return [String] The total number of Tasks that entered the Workflow
               def tasks_entered
                 @properties['tasks_entered']
               end
@@ -305,42 +316,44 @@ module Twilio
               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 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
-              # @param [String] minutes 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.
-              # @param [Time] start_date 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
-              # @param [String] task_channel Filter real-time and cumulative statistics by
-              #   TaskChannel. Takes in a Unique Name ("voice", "sms", "default", etc.) or a
-              #   TaskChannelSid.
-              # @param [String] split_by_wait_time 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.
+              # 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. TaskRouter will calculate
+              #   statistics on up to 10,000 Tasks for any given threshold.
               # @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,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -16,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)
@@ -71,8 +73,10 @@ 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)
@@ -83,19 +87,15 @@ module Twilio
               end
 
               ##
-              # Fetch a WorkflowRealTimeStatisticsInstance
-              # @param [String] task_channel Filter real-time and cumulative statistics by
-              #   TaskChannel. Takes in a Unique Name ("voice", "sms", "default", etc.) or a
-              #   TaskChannelSid.
+              # 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, })
 
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri, params: params)
 
                 WorkflowRealTimeStatisticsInstance.new(
                     @version,
@@ -111,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
@@ -118,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)
@@ -127,10 +136,11 @@ module Twilio
                 # Marshaled Properties
                 @properties = {
                     'account_sid' => payload['account_sid'],
-                    'longest_task_waiting_age' => payload['longest_task_waiting_age'].to_i,
+                    'longest_task_waiting_age' => payload['longest_task_waiting_age'] == nil ? payload['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,
+                    'total_tasks' => payload['total_tasks'] == nil ? payload['total_tasks'] : payload['total_tasks'].to_i,
                     'workflow_sid' => payload['workflow_sid'],
                     'workspace_sid' => payload['workspace_sid'],
                     'url' => payload['url'],
@@ -157,7 +167,7 @@ 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
@@ -169,13 +179,19 @@ module Twilio
               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 broken down by status
+              # @return [Hash] The number of Tasks by their current status
               def tasks_by_status
                 @properties['tasks_by_status']
               end
@@ -187,28 +203,28 @@ module Twilio
               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 Filter real-time and cumulative statistics by
-              #   TaskChannel. Takes in a Unique Name ("voice", "sms", "default", etc.) or a
-              #   TaskChannelSid.
+              # 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, )