twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,7 +15,7 @@ module Twilio
             ##
             # Initialize the WorkspaceCumulativeStatisticsList
             # @param [Version] version Version that contains the resource
-            # @param [String] workspace_sid The workspace_sid
+            # @param [String] workspace_sid The SID of the Workspace.
             # @return [WorkspaceCumulativeStatisticsList] WorkspaceCumulativeStatisticsList
             def initialize(version, workspace_sid: nil)
               super(version)
@@ -48,7 +50,11 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [WorkspaceCumulativeStatisticsInstance] WorkspaceCumulativeStatisticsInstance
             def get_instance(payload)
-              WorkspaceCumulativeStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid])
+              WorkspaceCumulativeStatisticsInstance.new(
+                  @version,
+                  payload,
+                  workspace_sid: @solution[:workspace_sid],
+              )
             end
 
             ##
@@ -62,23 +68,36 @@ module Twilio
             ##
             # Initialize the WorkspaceCumulativeStatisticsContext
             # @param [Version] version Version that contains the resource
-            # @param [String] workspace_sid The workspace_sid
+            # @param [String] workspace_sid The SID of the Workspace to fetch.
             # @return [WorkspaceCumulativeStatisticsContext] WorkspaceCumulativeStatisticsContext
             def initialize(version, workspace_sid)
               super(version)
 
               # Path Solution
-              @solution = {workspace_sid: workspace_sid}
+              @solution = {workspace_sid: workspace_sid, }
               @uri = "/Workspaces/#{@solution[:workspace_sid]}/CumulativeStatistics"
             end
 
             ##
-            # Fetch a WorkspaceCumulativeStatisticsInstance
-            # @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 WorkspaceCumulativeStatisticsInstance
+            # @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 [WorkspaceCumulativeStatisticsInstance] Fetched WorkspaceCumulativeStatisticsInstance
             def fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset)
               params = Twilio::Values.of({
@@ -89,13 +108,13 @@ module Twilio
                   'SplitByWaitTime' => split_by_wait_time,
               })
 
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri, params: params)
 
-              WorkspaceCumulativeStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid])
+              WorkspaceCumulativeStatisticsInstance.new(
+                  @version,
+                  payload,
+                  workspace_sid: @solution[:workspace_sid],
+              )
             end
 
             ##
@@ -104,6 +123,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Taskrouter.V1.WorkspaceCumulativeStatisticsContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Taskrouter.V1.WorkspaceCumulativeStatisticsContext #{context}>"
+            end
           end
 
           class WorkspaceCumulativeStatisticsInstance < InstanceResource
@@ -111,7 +137,7 @@ module Twilio
             # Initialize the WorkspaceCumulativeStatisticsInstance
             # @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] workspace_sid The SID of the Workspace.
             # @return [WorkspaceCumulativeStatisticsInstance] WorkspaceCumulativeStatisticsInstance
             def initialize(version, payload, workspace_sid: nil)
               super(version)
@@ -143,7 +169,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'workspace_sid' => workspace_sid}
+              @params = {'workspace_sid' => workspace_sid, }
             end
 
             ##
@@ -152,144 +178,157 @@ module Twilio
             # @return [WorkspaceCumulativeStatisticsContext] WorkspaceCumulativeStatisticsContext for this WorkspaceCumulativeStatisticsInstance
             def context
               unless @instance_context
-                @instance_context = WorkspaceCumulativeStatisticsContext.new(@version, @params['workspace_sid'])
+                @instance_context = WorkspaceCumulativeStatisticsContext.new(@version, @params['workspace_sid'], )
               end
               @instance_context
             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_created
+            # @return [String] The total number of Tasks created
             def tasks_created
               @properties['tasks_created']
             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 workspace_sid
+            # @return [String] The SID of the Workspace
             def workspace_sid
               @properties['workspace_sid']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the Workspace statistics resource
             def url
               @properties['url']
             end
 
             ##
-            # Fetch a WorkspaceCumulativeStatisticsInstance
-            # @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 WorkspaceCumulativeStatisticsInstance
+            # @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 [WorkspaceCumulativeStatisticsInstance] Fetched WorkspaceCumulativeStatisticsInstance
             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/workspace_real_time_statistics.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,7 +15,7 @@ module Twilio
             ##
             # Initialize the WorkspaceRealTimeStatisticsList
             # @param [Version] version Version that contains the resource
-            # @param [String] workspace_sid The workspace_sid
+            # @param [String] workspace_sid The SID of the Workspace.
             # @return [WorkspaceRealTimeStatisticsList] WorkspaceRealTimeStatisticsList
             def initialize(version, workspace_sid: nil)
               super(version)
@@ -48,7 +50,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [WorkspaceRealTimeStatisticsInstance] WorkspaceRealTimeStatisticsInstance
             def get_instance(payload)
-              WorkspaceRealTimeStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid])
+              WorkspaceRealTimeStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
             end
 
             ##
@@ -62,30 +64,28 @@ module Twilio
             ##
             # Initialize the WorkspaceRealTimeStatisticsContext
             # @param [Version] version Version that contains the resource
-            # @param [String] workspace_sid The workspace_sid
+            # @param [String] workspace_sid The SID of the Workspace to fetch.
             # @return [WorkspaceRealTimeStatisticsContext] WorkspaceRealTimeStatisticsContext
             def initialize(version, workspace_sid)
               super(version)
 
               # Path Solution
-              @solution = {workspace_sid: workspace_sid}
+              @solution = {workspace_sid: workspace_sid, }
               @uri = "/Workspaces/#{@solution[:workspace_sid]}/RealTimeStatistics"
             end
 
             ##
-            # Fetch a WorkspaceRealTimeStatisticsInstance
-            # @param [String] task_channel The task_channel
+            # Fetch the WorkspaceRealTimeStatisticsInstance
+            # @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 [WorkspaceRealTimeStatisticsInstance] Fetched WorkspaceRealTimeStatisticsInstance
             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)
 
-              WorkspaceRealTimeStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid])
+              WorkspaceRealTimeStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
             end
 
             ##
@@ -94,6 +94,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Taskrouter.V1.WorkspaceRealTimeStatisticsContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Taskrouter.V1.WorkspaceRealTimeStatisticsContext #{context}>"
+            end
           end
 
           class WorkspaceRealTimeStatisticsInstance < InstanceResource
@@ -101,7 +108,7 @@ module Twilio
             # Initialize the WorkspaceRealTimeStatisticsInstance
             # @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] workspace_sid The SID of the Workspace.
             # @return [WorkspaceRealTimeStatisticsInstance] WorkspaceRealTimeStatisticsInstance
             def initialize(version, payload, workspace_sid: nil)
               super(version)
@@ -111,6 +118,7 @@ module Twilio
                   'account_sid' => payload['account_sid'],
                   'activity_statistics' => payload['activity_statistics'],
                   '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,
@@ -121,7 +129,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'workspace_sid' => workspace_sid}
+              @params = {'workspace_sid' => workspace_sid, }
             end
 
             ##
@@ -130,71 +138,79 @@ module Twilio
             # @return [WorkspaceRealTimeStatisticsContext] WorkspaceRealTimeStatisticsContext for this WorkspaceRealTimeStatisticsInstance
             def context
               unless @instance_context
-                @instance_context = WorkspaceRealTimeStatisticsContext.new(@version, @params['workspace_sid'])
+                @instance_context = WorkspaceRealTimeStatisticsContext.new(@version, @params['workspace_sid'], )
               end
               @instance_context
             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 [Hash] The activity_statistics
+            # @return [Array[Hash]] The number of current Workers by Activity
             def activity_statistics
               @properties['activity_statistics']
             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 total_workers
+            # @return [String] The total number of Workers in the Workspace
             def total_workers
               @properties['total_workers']
             end
 
             ##
-            # @return [String] The workspace_sid
+            # @return [String] The SID of the Workspace
             def workspace_sid
               @properties['workspace_sid']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the Workspace statistics resource
             def url
               @properties['url']
             end
 
             ##
-            # Fetch a WorkspaceRealTimeStatisticsInstance
-            # @param [String] task_channel The task_channel
+            # Fetch the WorkspaceRealTimeStatisticsInstance
+            # @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 [WorkspaceRealTimeStatisticsInstance] Fetched WorkspaceRealTimeStatisticsInstance
             def fetch(task_channel: :unset)
-              context.fetch(task_channel: task_channel)
+              context.fetch(task_channel: task_channel, )
             end
 
             ##