twilio-ruby 5.6.0 → 5.33.0

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_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 TaskQueueRealTimeStatisticsList
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
-              # @param [String] task_queue_sid The task_queue_sid
+              # @param [String] workspace_sid The SID of the Workspace that contains the
+              #   TaskQueue.
+              # @param [String] task_queue_sid The SID of the TaskQueue from which these
+              #   statistics were calculated.
               # @return [TaskQueueRealTimeStatisticsList] TaskQueueRealTimeStatisticsList
               def initialize(version, workspace_sid: nil, task_queue_sid: nil)
                 super(version)
@@ -69,23 +73,27 @@ module Twilio
               ##
               # Initialize the TaskQueueRealTimeStatisticsContext
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
-              # @param [String] task_queue_sid The task_queue_sid
+              # @param [String] workspace_sid The SID of the Workspace with the TaskQueue to
+              #   fetch.
+              # @param [String] task_queue_sid The SID of the TaskQueue for which to fetch
+              #   statistics.
               # @return [TaskQueueRealTimeStatisticsContext] TaskQueueRealTimeStatisticsContext
               def initialize(version, workspace_sid, task_queue_sid)
                 super(version)
 
                 # Path Solution
-                @solution = {workspace_sid: workspace_sid, task_queue_sid: task_queue_sid}
+                @solution = {workspace_sid: workspace_sid, task_queue_sid: task_queue_sid, }
                 @uri = "/Workspaces/#{@solution[:workspace_sid]}/TaskQueues/#{@solution[:task_queue_sid]}/RealTimeStatistics"
               end
 
               ##
               # Fetch a TaskQueueRealTimeStatisticsInstance
-              # @param [String] task_channel The task_channel
+              # @param [String] task_channel The TaskChannel for which to fetch statistics. Can
+              #   be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or
+              #   `default`.
               # @return [TaskQueueRealTimeStatisticsInstance] Fetched TaskQueueRealTimeStatisticsInstance
               def fetch(task_channel: :unset)
-                params = Twilio::Values.of({'TaskChannel' => task_channel})
+                params = Twilio::Values.of({'TaskChannel' => task_channel, })
 
                 payload = @version.fetch(
                     'GET',
@@ -107,6 +115,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Taskrouter.V1.TaskQueueRealTimeStatisticsContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Taskrouter.V1.TaskQueueRealTimeStatisticsContext #{context}>"
+              end
             end
 
             class TaskQueueRealTimeStatisticsInstance < InstanceResource
@@ -114,8 +129,10 @@ module Twilio
               # Initialize the TaskQueueRealTimeStatisticsInstance
               # @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] task_queue_sid The task_queue_sid
+              # @param [String] workspace_sid The SID of the Workspace that contains the
+              #   TaskQueue.
+              # @param [String] task_queue_sid The SID of the TaskQueue from which these
+              #   statistics were calculated.
               # @return [TaskQueueRealTimeStatisticsInstance] TaskQueueRealTimeStatisticsInstance
               def initialize(version, payload, workspace_sid: nil, task_queue_sid: nil)
                 super(version)
@@ -125,6 +142,9 @@ 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'],
+                    'longest_relative_task_age_in_queue' => payload['longest_relative_task_age_in_queue'].to_i,
+                    'longest_relative_task_sid_in_queue' => payload['longest_relative_task_sid_in_queue'],
                     'task_queue_sid' => payload['task_queue_sid'],
                     'tasks_by_priority' => payload['tasks_by_priority'],
                     'tasks_by_status' => payload['tasks_by_status'],
@@ -137,7 +157,7 @@ module Twilio
 
                 # Context
                 @instance_context = nil
-                @params = {'workspace_sid' => workspace_sid, 'task_queue_sid' => task_queue_sid}
+                @params = {'workspace_sid' => workspace_sid, 'task_queue_sid' => task_queue_sid, }
               end
 
               ##
@@ -156,77 +176,97 @@ 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 [Hash] The activity_statistics
+              # @return [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 [String] The task_queue_sid
+              # @return [String] The SID of the longest waiting Task
+              def longest_task_waiting_sid
+                @properties['longest_task_waiting_sid']
+              end
+
+              ##
+              # @return [String] The relative age in the TaskQueue for the longest waiting Task.
+              def longest_relative_task_age_in_queue
+                @properties['longest_relative_task_age_in_queue']
+              end
+
+              ##
+              # @return [String] The SID of the Task waiting in the TaskQueue the longest.
+              def longest_relative_task_sid_in_queue
+                @properties['longest_relative_task_sid_in_queue']
+              end
+
+              ##
+              # @return [String] The SID of the TaskQueue from which these statistics were calculated
               def task_queue_sid
                 @properties['task_queue_sid']
               end
 
               ##
-              # @return [Hash] The tasks_by_priority
+              # @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_available_workers
+              # @return [String] The total number of Workers available for Tasks in the TaskQueue
               def total_available_workers
                 @properties['total_available_workers']
               end
 
               ##
-              # @return [String] The total_eligible_workers
+              # @return [String] The total number of Workers eligible for Tasks in the TaskQueue, independent of their Activity state
               def total_eligible_workers
                 @properties['total_eligible_workers']
               end
 
               ##
-              # @return [String] The total_tasks
+              # @return [String] The total number of Tasks
               def total_tasks
                 @properties['total_tasks']
               end
 
               ##
-              # @return [String] The workspace_sid
+              # @return [String] The SID of the Workspace that contains the TaskQueue
               def workspace_sid
                 @properties['workspace_sid']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The absolute URL of the TaskQueue statistics resource
               def url
                 @properties['url']
               end
 
               ##
               # Fetch a TaskQueueRealTimeStatisticsInstance
-              # @param [String] task_channel The task_channel
+              # @param [String] task_channel The TaskChannel for which to fetch statistics. Can
+              #   be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or
+              #   `default`.
               # @return [TaskQueueRealTimeStatisticsInstance] Fetched TaskQueueRealTimeStatisticsInstance
               def fetch(task_channel: :unset)
-                context.fetch(task_channel: task_channel)
+                context.fetch(task_channel: task_channel, )
               end
 
               ##

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_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 TaskQueueStatisticsList
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
-              # @param [String] task_queue_sid The task_queue_sid
+              # @param [String] workspace_sid The SID of the Workspace that contains the
+              #   TaskQueue.
+              # @param [String] task_queue_sid The SID of the TaskQueue from which these
+              #   statistics were calculated.
               # @return [TaskQueueStatisticsList] TaskQueueStatisticsList
               def initialize(version, workspace_sid: nil, task_queue_sid: nil)
                 super(version)
@@ -69,24 +73,35 @@ module Twilio
               ##
               # Initialize the TaskQueueStatisticsContext
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
-              # @param [String] task_queue_sid The task_queue_sid
+              # @param [String] workspace_sid The SID of the Workspace with the TaskQueue to
+              #   fetch.
+              # @param [String] task_queue_sid The SID of the TaskQueue for which to fetch
+              #   statistics.
               # @return [TaskQueueStatisticsContext] TaskQueueStatisticsContext
               def initialize(version, workspace_sid, task_queue_sid)
                 super(version)
 
                 # Path Solution
-                @solution = {workspace_sid: workspace_sid, task_queue_sid: task_queue_sid}
+                @solution = {workspace_sid: workspace_sid, task_queue_sid: task_queue_sid, }
                 @uri = "/Workspaces/#{@solution[:workspace_sid]}/TaskQueues/#{@solution[:task_queue_sid]}/Statistics"
               end
 
               ##
               # Fetch a TaskQueueStatisticsInstance
-              # @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
+              # @param [Time] end_date Only calculate statistics from this date and time and
+              #   earlier, 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 is 15 minutes.
+              # @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 real-time and cumulative statistics
+              #   for the specified 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.
               # @return [TaskQueueStatisticsInstance] Fetched TaskQueueStatisticsInstance
               def fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset)
                 params = Twilio::Values.of({
@@ -117,6 +132,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Taskrouter.V1.TaskQueueStatisticsContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Taskrouter.V1.TaskQueueStatisticsContext #{context}>"
+              end
             end
 
             class TaskQueueStatisticsInstance < InstanceResource
@@ -124,8 +146,10 @@ module Twilio
               # Initialize the TaskQueueStatisticsInstance
               # @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] task_queue_sid The task_queue_sid
+              # @param [String] workspace_sid The SID of the Workspace that contains the
+              #   TaskQueue.
+              # @param [String] task_queue_sid The SID of the TaskQueue from which these
+              #   statistics were calculated.
               # @return [TaskQueueStatisticsInstance] TaskQueueStatisticsInstance
               def initialize(version, payload, workspace_sid: nil, task_queue_sid: nil)
                 super(version)
@@ -142,7 +166,7 @@ module Twilio
 
                 # Context
                 @instance_context = nil
-                @params = {'workspace_sid' => workspace_sid, 'task_queue_sid' => task_queue_sid}
+                @params = {'workspace_sid' => workspace_sid, 'task_queue_sid' => task_queue_sid, }
               end
 
               ##
@@ -161,48 +185,57 @@ 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 [Hash] The cumulative
+              # @return [Hash] An object that contains the cumulative statistics for the TaskQueue
               def cumulative
                 @properties['cumulative']
               end
 
               ##
-              # @return [Hash] The realtime
+              # @return [Hash] An object that contains the real-time statistics for the TaskQueue
               def realtime
                 @properties['realtime']
               end
 
               ##
-              # @return [String] The task_queue_sid
+              # @return [String] The SID of the TaskQueue from which these statistics were calculated
               def task_queue_sid
                 @properties['task_queue_sid']
               end
 
               ##
-              # @return [String] The workspace_sid
+              # @return [String] The SID of the Workspace that contains the TaskQueue
               def workspace_sid
                 @properties['workspace_sid']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The absolute URL of the TaskQueue statistics resource
               def url
                 @properties['url']
               end
 
               ##
               # Fetch a TaskQueueStatisticsInstance
-              # @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
+              # @param [Time] end_date Only calculate statistics from this date and time and
+              #   earlier, 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 is 15 minutes.
+              # @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 real-time and cumulative statistics
+              #   for the specified 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.
               # @return [TaskQueueStatisticsInstance] Fetched TaskQueueStatisticsInstance
               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/task_queue/task_queues_statistics.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -14,7 +16,8 @@ module Twilio
               ##
               # Initialize the TaskQueuesStatisticsList
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
+              # @param [String] workspace_sid The SID of the Workspace that contains the
+              #   TaskQueue.
               # @return [TaskQueuesStatisticsList] TaskQueuesStatisticsList
               def initialize(version, workspace_sid: nil)
                 super(version)
@@ -28,12 +31,22 @@ module Twilio
               # Lists TaskQueuesStatisticsInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [Time] end_date The end_date
-              # @param [String] friendly_name The friendly_name
-              # @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
+              # @param [Time] end_date Only calculate statistics from this date and time and
+              #   earlier, specified in GMT as an [ISO
+              #   8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
+              # @param [String] friendly_name The `friendly_name` of the TaskQueue statistics to
+              #   read.
+              # @param [String] minutes Only calculate statistics since this many minutes in the
+              #   past. The default is 15 minutes.
+              # @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 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.
               # @param [Integer] limit Upper limit for the number of records to return. stream()
               #    guarantees to never return more than limit.  Default is no limit
               # @param [Integer] page_size Number of records to fetch per request, when
@@ -58,12 +71,22 @@ module Twilio
               # Streams TaskQueuesStatisticsInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [Time] end_date The end_date
-              # @param [String] friendly_name The friendly_name
-              # @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
+              # @param [Time] end_date Only calculate statistics from this date and time and
+              #   earlier, specified in GMT as an [ISO
+              #   8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
+              # @param [String] friendly_name The `friendly_name` of the TaskQueue statistics to
+              #   read.
+              # @param [String] minutes Only calculate statistics since this many minutes in the
+              #   past. The default is 15 minutes.
+              # @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 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.
               # @param [Integer] limit Upper limit for the number of records to return. stream()
               #    guarantees to never return more than limit. Default is no limit.
               # @param [Integer] page_size Number of records to fetch per request, when
@@ -94,7 +117,7 @@ module Twilio
               def each
                 limits = @version.read_limits
 
-                page = self.page(page_size: limits[:page_size])
+                page = self.page(page_size: limits[:page_size], )
 
                 @version.stream(page,
                                 limit: limits[:limit],
@@ -104,12 +127,22 @@ module Twilio
               ##
               # Retrieve a single page of TaskQueuesStatisticsInstance records from the API.
               # Request is executed immediately.
-              # @param [Time] end_date The end_date
-              # @param [String] friendly_name The friendly_name
-              # @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
+              # @param [Time] end_date Only calculate statistics from this date and time and
+              #   earlier, specified in GMT as an [ISO
+              #   8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
+              # @param [String] friendly_name The `friendly_name` of the TaskQueue statistics to
+              #   read.
+              # @param [String] minutes Only calculate statistics since this many minutes in the
+              #   past. The default is 15 minutes.
+              # @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 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.
               # @param [String] page_token PageToken provided by the API
               # @param [Integer] page_number Page Number, this value is simply for client state
               # @param [Integer] page_size Number of records to return, defaults to 50
@@ -173,7 +206,7 @@ module Twilio
               # @param [Hash] payload Payload response from the API
               # @return [TaskQueuesStatisticsInstance] TaskQueuesStatisticsInstance
               def get_instance(payload)
-                TaskQueuesStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid])
+                TaskQueuesStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
               end
 
               ##
@@ -188,7 +221,8 @@ module Twilio
               # Initialize the TaskQueuesStatisticsInstance
               # @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 that contains the
+              #   TaskQueue.
               # @return [TaskQueuesStatisticsInstance] TaskQueuesStatisticsInstance
               def initialize(version, payload, workspace_sid: nil)
                 super(version)
@@ -204,31 +238,31 @@ 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 [Hash] The cumulative
+              # @return [Hash] An object that contains the cumulative statistics for the TaskQueues
               def cumulative
                 @properties['cumulative']
               end
 
               ##
-              # @return [Hash] The realtime
+              # @return [Hash] An object that contains the real-time statistics for the TaskQueues
               def realtime
                 @properties['realtime']
               end
 
               ##
-              # @return [String] The task_queue_sid
+              # @return [String] The SID of the TaskQueue from which these statistics were calculated
               def task_queue_sid
                 @properties['task_queue_sid']
               end
 
               ##
-              # @return [String] The workspace_sid
+              # @return [String] The SID of the Workspace that contains the TaskQueues
               def workspace_sid
                 @properties['workspace_sid']
               end