twilio-ruby 5.5.1 → 5.58.3

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_cumulative_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 WorkersCumulativeStatisticsList
               # @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
+              #   Workers.
               # @return [WorkersCumulativeStatisticsList] WorkersCumulativeStatisticsList
               def initialize(version, workspace_sid: nil)
                 super(version)
@@ -49,7 +52,7 @@ module Twilio
               # @param [Hash] payload Payload response from the API
               # @return [WorkersCumulativeStatisticsInstance] WorkersCumulativeStatisticsInstance
               def get_instance(payload)
-                WorkersCumulativeStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid])
+                WorkersCumulativeStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
               end
 
               ##
@@ -63,22 +66,29 @@ module Twilio
               ##
               # Initialize the WorkersCumulativeStatisticsContext
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
+              # @param [String] workspace_sid The SID of the Workspace with the resource to
+              #   fetch.
               # @return [WorkersCumulativeStatisticsContext] WorkersCumulativeStatisticsContext
               def initialize(version, workspace_sid)
                 super(version)
 
                 # Path Solution
-                @solution = {workspace_sid: workspace_sid}
+                @solution = {workspace_sid: workspace_sid, }
                 @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workers/CumulativeStatistics"
               end
 
               ##
-              # Fetch a WorkersCumulativeStatisticsInstance
-              # @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
+              # Fetch the WorkersCumulativeStatisticsInstance
+              # @param [Time] end_date Only calculate statistics from this date and time and
+              #   earlier, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format.
+              # @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`.
               # @return [WorkersCumulativeStatisticsInstance] Fetched WorkersCumulativeStatisticsInstance
               def fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset)
                 params = Twilio::Values.of({
@@ -88,13 +98,9 @@ module Twilio
                     'TaskChannel' => task_channel,
                 })
 
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri, params: params)
 
-                WorkersCumulativeStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid])
+                WorkersCumulativeStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
               end
 
               ##
@@ -103,6 +109,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Taskrouter.V1.WorkersCumulativeStatisticsContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Taskrouter.V1.WorkersCumulativeStatisticsContext #{context}>"
+              end
             end
 
             class WorkersCumulativeStatisticsInstance < InstanceResource
@@ -110,7 +123,8 @@ module Twilio
               # Initialize the WorkersCumulativeStatisticsInstance
               # @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
+              #   Workers.
               # @return [WorkersCumulativeStatisticsInstance] WorkersCumulativeStatisticsInstance
               def initialize(version, payload, workspace_sid: nil)
                 super(version)
@@ -133,7 +147,7 @@ module Twilio
 
                 # Context
                 @instance_context = nil
-                @params = {'workspace_sid' => workspace_sid}
+                @params = {'workspace_sid' => workspace_sid, }
               end
 
               ##
@@ -142,92 +156,103 @@ module Twilio
               # @return [WorkersCumulativeStatisticsContext] WorkersCumulativeStatisticsContext for this WorkersCumulativeStatisticsInstance
               def context
                 unless @instance_context
-                  @instance_context = WorkersCumulativeStatisticsContext.new(@version, @params['workspace_sid'])
+                  @instance_context = WorkersCumulativeStatisticsContext.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 [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 [Hash] The activity_durations
+              # @return [Array[Hash]] The minimum, average, maximum, and total time that Workers spent in each Activity
               def activity_durations
                 @properties['activity_durations']
               end
 
               ##
-              # @return [String] The reservations_created
+              # @return [String] The total number of Reservations that were created
               def reservations_created
                 @properties['reservations_created']
               end
 
               ##
-              # @return [String] The reservations_accepted
+              # @return [String] The total number of Reservations that were accepted
               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 [String] The workspace_sid
+              # @return [String] The SID of the Workspace that contains the Workers
               def workspace_sid
                 @properties['workspace_sid']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The absolute URL of the Workers statistics resource
               def url
                 @properties['url']
               end
 
               ##
-              # Fetch a WorkersCumulativeStatisticsInstance
-              # @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
+              # Fetch the WorkersCumulativeStatisticsInstance
+              # @param [Time] end_date Only calculate statistics from this date and time and
+              #   earlier, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format.
+              # @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`.
               # @return [WorkersCumulativeStatisticsInstance] Fetched WorkersCumulativeStatisticsInstance
               def fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset)
-                context.fetch(end_date: end_date, minutes: minutes, start_date: start_date, task_channel: task_channel)
+                context.fetch(
+                    end_date: end_date,
+                    minutes: minutes,
+                    start_date: start_date,
+                    task_channel: task_channel,
+                )
               end
 
               ##

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/worker/workers_real_time_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 WorkersRealTimeStatisticsList
               # @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
+              #   Workers.
               # @return [WorkersRealTimeStatisticsList] WorkersRealTimeStatisticsList
               def initialize(version, workspace_sid: nil)
                 super(version)
@@ -49,7 +52,7 @@ module Twilio
               # @param [Hash] payload Payload response from the API
               # @return [WorkersRealTimeStatisticsInstance] WorkersRealTimeStatisticsInstance
               def get_instance(payload)
-                WorkersRealTimeStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid])
+                WorkersRealTimeStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
               end
 
               ##
@@ -63,30 +66,29 @@ module Twilio
               ##
               # Initialize the WorkersRealTimeStatisticsContext
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
+              # @param [String] workspace_sid The SID of the Workspace with the resource to
+              #   fetch.
               # @return [WorkersRealTimeStatisticsContext] WorkersRealTimeStatisticsContext
               def initialize(version, workspace_sid)
                 super(version)
 
                 # Path Solution
-                @solution = {workspace_sid: workspace_sid}
+                @solution = {workspace_sid: workspace_sid, }
                 @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workers/RealTimeStatistics"
               end
 
               ##
-              # Fetch a WorkersRealTimeStatisticsInstance
-              # @param [String] task_channel The task_channel
+              # Fetch the WorkersRealTimeStatisticsInstance
+              # @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 [WorkersRealTimeStatisticsInstance] Fetched WorkersRealTimeStatisticsInstance
               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)
 
-                WorkersRealTimeStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid])
+                WorkersRealTimeStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
               end
 
               ##
@@ -95,6 +97,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Taskrouter.V1.WorkersRealTimeStatisticsContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Taskrouter.V1.WorkersRealTimeStatisticsContext #{context}>"
+              end
             end
 
             class WorkersRealTimeStatisticsInstance < InstanceResource
@@ -102,7 +111,8 @@ module Twilio
               # Initialize the WorkersRealTimeStatisticsInstance
               # @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
+              #   Workers.
               # @return [WorkersRealTimeStatisticsInstance] WorkersRealTimeStatisticsInstance
               def initialize(version, payload, workspace_sid: nil)
                 super(version)
@@ -118,7 +128,7 @@ module Twilio
 
                 # Context
                 @instance_context = nil
-                @params = {'workspace_sid' => workspace_sid}
+                @params = {'workspace_sid' => workspace_sid, }
               end
 
               ##
@@ -127,47 +137,49 @@ module Twilio
               # @return [WorkersRealTimeStatisticsContext] WorkersRealTimeStatisticsContext for this WorkersRealTimeStatisticsInstance
               def context
                 unless @instance_context
-                  @instance_context = WorkersRealTimeStatisticsContext.new(@version, @params['workspace_sid'])
+                  @instance_context = WorkersRealTimeStatisticsContext.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 total_workers
+              # @return [String] The total number of Workers
               def total_workers
                 @properties['total_workers']
               end
 
               ##
-              # @return [String] The workspace_sid
+              # @return [String] The SID of the Workspace that contains the Workers
               def workspace_sid
                 @properties['workspace_sid']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The absolute URL of the Workers statistics resource
               def url
                 @properties['url']
               end
 
               ##
-              # Fetch a WorkersRealTimeStatisticsInstance
-              # @param [String] task_channel The task_channel
+              # Fetch the WorkersRealTimeStatisticsInstance
+              # @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 [WorkersRealTimeStatisticsInstance] Fetched WorkersRealTimeStatisticsInstance
               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/worker/workers_statistics.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -14,7 +16,7 @@ module Twilio
               ##
               # Initialize the WorkersStatisticsList
               # @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 Worker.
               # @return [WorkersStatisticsList] WorkersStatisticsList
               def initialize(version, workspace_sid: nil)
                 super(version)
@@ -49,7 +51,7 @@ module Twilio
               # @param [Hash] payload Payload response from the API
               # @return [WorkersStatisticsInstance] WorkersStatisticsInstance
               def get_instance(payload)
-                WorkersStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid])
+                WorkersStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
               end
 
               ##
@@ -63,25 +65,35 @@ module Twilio
               ##
               # Initialize the WorkersStatisticsContext
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
+              # @param [String] workspace_sid The SID of the Workspace with the Worker to fetch.
               # @return [WorkersStatisticsContext] WorkersStatisticsContext
               def initialize(version, workspace_sid)
                 super(version)
 
                 # Path Solution
-                @solution = {workspace_sid: workspace_sid}
+                @solution = {workspace_sid: workspace_sid, }
                 @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workers/Statistics"
               end
 
               ##
-              # Fetch a WorkersStatisticsInstance
-              # @param [String] minutes The minutes
-              # @param [Time] start_date The start_date
-              # @param [Time] end_date The end_date
-              # @param [String] task_queue_sid The task_queue_sid
-              # @param [String] task_queue_name The task_queue_name
-              # @param [String] friendly_name The friendly_name
-              # @param [String] task_channel The task_channel
+              # Fetch the WorkersStatisticsInstance
+              # @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 [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] task_queue_sid The SID of the TaskQueue for which to fetch
+              #   Worker statistics.
+              # @param [String] task_queue_name The `friendly_name` of the TaskQueue for which
+              #   to fetch Worker statistics.
+              # @param [String] friendly_name Only include Workers with `friendly_name` values
+              #   that match this parameter.
+              # @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`.
               # @return [WorkersStatisticsInstance] Fetched WorkersStatisticsInstance
               def fetch(minutes: :unset, start_date: :unset, end_date: :unset, task_queue_sid: :unset, task_queue_name: :unset, friendly_name: :unset, task_channel: :unset)
                 params = Twilio::Values.of({
@@ -94,13 +106,9 @@ module Twilio
                     'TaskChannel' => task_channel,
                 })
 
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri, params: params)
 
-                WorkersStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid])
+                WorkersStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
               end
 
               ##
@@ -109,6 +117,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Taskrouter.V1.WorkersStatisticsContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Taskrouter.V1.WorkersStatisticsContext #{context}>"
+              end
             end
 
             class WorkersStatisticsInstance < InstanceResource
@@ -116,7 +131,7 @@ module Twilio
               # Initialize the WorkersStatisticsInstance
               # @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 Worker.
               # @return [WorkersStatisticsInstance] WorkersStatisticsInstance
               def initialize(version, payload, workspace_sid: nil)
                 super(version)
@@ -132,7 +147,7 @@ module Twilio
 
                 # Context
                 @instance_context = nil
-                @params = {'workspace_sid' => workspace_sid}
+                @params = {'workspace_sid' => workspace_sid, }
               end
 
               ##
@@ -141,50 +156,60 @@ module Twilio
               # @return [WorkersStatisticsContext] WorkersStatisticsContext for this WorkersStatisticsInstance
               def context
                 unless @instance_context
-                  @instance_context = WorkersStatisticsContext.new(@version, @params['workspace_sid'])
+                  @instance_context = WorkersStatisticsContext.new(@version, @params['workspace_sid'], )
                 end
                 @instance_context
               end
 
               ##
-              # @return [Hash] The realtime
+              # @return [Hash] An object that contains the real-time statistics for the Worker
               def realtime
                 @properties['realtime']
               end
 
               ##
-              # @return [Hash] The cumulative
+              # @return [Hash] An object that contains the cumulative statistics for the Worker
               def cumulative
                 @properties['cumulative']
               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 workspace_sid
+              # @return [String] The SID of the Workspace that contains the Worker
               def workspace_sid
                 @properties['workspace_sid']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The absolute URL of the Worker statistics resource
               def url
                 @properties['url']
               end
 
               ##
-              # Fetch a WorkersStatisticsInstance
-              # @param [String] minutes The minutes
-              # @param [Time] start_date The start_date
-              # @param [Time] end_date The end_date
-              # @param [String] task_queue_sid The task_queue_sid
-              # @param [String] task_queue_name The task_queue_name
-              # @param [String] friendly_name The friendly_name
-              # @param [String] task_channel The task_channel
+              # Fetch the WorkersStatisticsInstance
+              # @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 [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] task_queue_sid The SID of the TaskQueue for which to fetch
+              #   Worker statistics.
+              # @param [String] task_queue_name The `friendly_name` of the TaskQueue for which
+              #   to fetch Worker statistics.
+              # @param [String] friendly_name Only include Workers with `friendly_name` values
+              #   that match this parameter.
+              # @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`.
               # @return [WorkersStatisticsInstance] Fetched WorkersStatisticsInstance
               def fetch(minutes: :unset, start_date: :unset, end_date: :unset, task_queue_sid: :unset, task_queue_name: :unset, friendly_name: :unset, task_channel: :unset)
                 context.fetch(