twilio-ruby 3.11.5 → 5.71.0

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

@@ -0,0 +1,277 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Taskrouter < Domain
+      class V1 < Version
+        class WorkspaceContext < InstanceContext
+          class WorkerContext < InstanceContext
+            class WorkersCumulativeStatisticsList < ListResource
+              ##
+              # Initialize the WorkersCumulativeStatisticsList
+              # @param [Version] version Version that contains the resource
+              # @param [String] workspace_sid The SID of the Workspace that contains the
+              #   Workers.
+              # @return [WorkersCumulativeStatisticsList] WorkersCumulativeStatisticsList
+              def initialize(version, workspace_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {workspace_sid: workspace_sid}
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Taskrouter.V1.WorkersCumulativeStatisticsList>'
+              end
+            end
+
+            class WorkersCumulativeStatisticsPage < Page
+              ##
+              # Initialize the WorkersCumulativeStatisticsPage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [WorkersCumulativeStatisticsPage] WorkersCumulativeStatisticsPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of WorkersCumulativeStatisticsInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [WorkersCumulativeStatisticsInstance] WorkersCumulativeStatisticsInstance
+              def get_instance(payload)
+                WorkersCumulativeStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Taskrouter.V1.WorkersCumulativeStatisticsPage>'
+              end
+            end
+
+            class WorkersCumulativeStatisticsContext < InstanceContext
+              ##
+              # Initialize the WorkersCumulativeStatisticsContext
+              # @param [Version] version Version that contains the resource
+              # @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, }
+                @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workers/CumulativeStatistics"
+              end
+
+              ##
+              # 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({
+                    'EndDate' => Twilio.serialize_iso8601_datetime(end_date),
+                    'Minutes' => minutes,
+                    'StartDate' => Twilio.serialize_iso8601_datetime(start_date),
+                    'TaskChannel' => task_channel,
+                })
+
+                payload = @version.fetch('GET', @uri, params: params)
+
+                WorkersCumulativeStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                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
+              ##
+              # 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 SID of the Workspace that contains the
+              #   Workers.
+              # @return [WorkersCumulativeStatisticsInstance] WorkersCumulativeStatisticsInstance
+              def initialize(version, payload, workspace_sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'account_sid' => payload['account_sid'],
+                    'start_time' => Twilio.deserialize_iso8601_datetime(payload['start_time']),
+                    'end_time' => Twilio.deserialize_iso8601_datetime(payload['end_time']),
+                    'activity_durations' => payload['activity_durations'],
+                    '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,
+                    'workspace_sid' => payload['workspace_sid'],
+                    'url' => payload['url'],
+                }
+
+                # Context
+                @instance_context = nil
+                @params = {'workspace_sid' => workspace_sid, }
+              end
+
+              ##
+              # Generate an instance context for the instance, the context is capable of
+              # performing various actions.  All instance actions are proxied to the context
+              # @return [WorkersCumulativeStatisticsContext] WorkersCumulativeStatisticsContext for this WorkersCumulativeStatisticsInstance
+              def context
+                unless @instance_context
+                  @instance_context = WorkersCumulativeStatisticsContext.new(@version, @params['workspace_sid'], )
+                end
+                @instance_context
+              end
+
+              ##
+              # @return [String] The SID of the Account that created the resource
+              def account_sid
+                @properties['account_sid']
+              end
+
+              ##
+              # @return [Time] The beginning of the interval during which these statistics were calculated
+              def start_time
+                @properties['start_time']
+              end
+
+              ##
+              # @return [Time] The end of the interval during which these statistics were calculated
+              def end_time
+                @properties['end_time']
+              end
+
+              ##
+              # @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 total number of Reservations that were created
+              def reservations_created
+                @properties['reservations_created']
+              end
+
+              ##
+              # @return [String] The total number of Reservations that were accepted
+              def reservations_accepted
+                @properties['reservations_accepted']
+              end
+
+              ##
+              # @return [String] The total number of Reservations that were rejected
+              def reservations_rejected
+                @properties['reservations_rejected']
+              end
+
+              ##
+              # @return [String] The total number of Reservations that were timed out
+              def reservations_timed_out
+                @properties['reservations_timed_out']
+              end
+
+              ##
+              # @return [String] The total number of Reservations that were canceled
+              def reservations_canceled
+                @properties['reservations_canceled']
+              end
+
+              ##
+              # @return [String] The total number of Reservations that were rescinded
+              def reservations_rescinded
+                @properties['reservations_rescinded']
+              end
+
+              ##
+              # @return [String] The SID of the Workspace that contains the Workers
+              def workspace_sid
+                @properties['workspace_sid']
+              end
+
+              ##
+              # @return [String] The absolute URL of the Workers statistics resource
+              def url
+                @properties['url']
+              end
+
+              ##
+              # 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,
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Taskrouter.V1.WorkersCumulativeStatisticsInstance #{values}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Taskrouter.V1.WorkersCumulativeStatisticsInstance #{values}>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,204 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Taskrouter < Domain
+      class V1 < Version
+        class WorkspaceContext < InstanceContext
+          class WorkerContext < InstanceContext
+            class WorkersRealTimeStatisticsList < ListResource
+              ##
+              # Initialize the WorkersRealTimeStatisticsList
+              # @param [Version] version Version that contains the resource
+              # @param [String] workspace_sid The SID of the Workspace that contains the
+              #   Workers.
+              # @return [WorkersRealTimeStatisticsList] WorkersRealTimeStatisticsList
+              def initialize(version, workspace_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {workspace_sid: workspace_sid}
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Taskrouter.V1.WorkersRealTimeStatisticsList>'
+              end
+            end
+
+            class WorkersRealTimeStatisticsPage < Page
+              ##
+              # Initialize the WorkersRealTimeStatisticsPage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [WorkersRealTimeStatisticsPage] WorkersRealTimeStatisticsPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of WorkersRealTimeStatisticsInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [WorkersRealTimeStatisticsInstance] WorkersRealTimeStatisticsInstance
+              def get_instance(payload)
+                WorkersRealTimeStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Taskrouter.V1.WorkersRealTimeStatisticsPage>'
+              end
+            end
+
+            class WorkersRealTimeStatisticsContext < InstanceContext
+              ##
+              # Initialize the WorkersRealTimeStatisticsContext
+              # @param [Version] version Version that contains the resource
+              # @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, }
+                @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workers/RealTimeStatistics"
+              end
+
+              ##
+              # 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, })
+
+                payload = @version.fetch('GET', @uri, params: params)
+
+                WorkersRealTimeStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                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
+              ##
+              # 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 SID of the Workspace that contains the
+              #   Workers.
+              # @return [WorkersRealTimeStatisticsInstance] WorkersRealTimeStatisticsInstance
+              def initialize(version, payload, workspace_sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'account_sid' => payload['account_sid'],
+                    'activity_statistics' => payload['activity_statistics'],
+                    'total_workers' => payload['total_workers'].to_i,
+                    'workspace_sid' => payload['workspace_sid'],
+                    'url' => payload['url'],
+                }
+
+                # Context
+                @instance_context = nil
+                @params = {'workspace_sid' => workspace_sid, }
+              end
+
+              ##
+              # Generate an instance context for the instance, the context is capable of
+              # performing various actions.  All instance actions are proxied to the context
+              # @return [WorkersRealTimeStatisticsContext] WorkersRealTimeStatisticsContext for this WorkersRealTimeStatisticsInstance
+              def context
+                unless @instance_context
+                  @instance_context = WorkersRealTimeStatisticsContext.new(@version, @params['workspace_sid'], )
+                end
+                @instance_context
+              end
+
+              ##
+              # @return [String] The SID of the Account that created the resource
+              def account_sid
+                @properties['account_sid']
+              end
+
+              ##
+              # @return [Array[Hash]] The number of current Workers by Activity
+              def activity_statistics
+                @properties['activity_statistics']
+              end
+
+              ##
+              # @return [String] The total number of Workers
+              def total_workers
+                @properties['total_workers']
+              end
+
+              ##
+              # @return [String] The SID of the Workspace that contains the Workers
+              def workspace_sid
+                @properties['workspace_sid']
+              end
+
+              ##
+              # @return [String] The absolute URL of the Workers statistics resource
+              def url
+                @properties['url']
+              end
+
+              ##
+              # 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, )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Taskrouter.V1.WorkersRealTimeStatisticsInstance #{values}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Taskrouter.V1.WorkersRealTimeStatisticsInstance #{values}>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end