twilio-ruby 6.8.0 → 7.10.7

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

@@ -0,0 +1,258 @@
+##
+#    This code was generated by
+#    ___ _ _ _ _ _    _ ____    ____ ____ _    ____ ____ _  _ ____ ____ ____ ___ __   __
+#     |  | | | | |    | |  | __ |  | |__| | __ | __ |___ |\ | |___ |__/ |__|  | |  | |__/
+#     |  |_|_| | |___ | |__|    |__| |  | |    |__] |___ | \| |___ |  \ |  |  | |__| |  \
+#
+#    Twilio - Taskrouter
+#    This is the public Twilio REST API.
+#
+#    NOTE: This class is auto generated by OpenAPI Generator.
+#    https://openapi-generator.tech
+#    Do not edit the class manually.
+#
+
+
+module Twilio
+    module REST
+        class Taskrouter < TaskrouterBase
+            class V1 < Version
+                class WorkspaceContext < InstanceContext
+                class TaskQueueList < ListResource
+
+                     class TaskQueueBulkRealTimeStatisticsList < ListResource
+                
+                    ##
+                    # Initialize the TaskQueueBulkRealTimeStatisticsList
+                    # @param [Version] version Version that contains the resource
+                    # @return [TaskQueueBulkRealTimeStatisticsList] TaskQueueBulkRealTimeStatisticsList
+                    def initialize(version, workspace_sid: nil)
+                        super(version)
+                        
+                        # Path Solution
+                        @solution = { workspace_sid: workspace_sid }
+                        @uri = "/Workspaces/#{@solution[:workspace_sid]}/TaskQueues/RealTimeStatistics"
+                        
+                    end
+                    ##
+                    # Create the TaskQueueBulkRealTimeStatisticsInstance
+                    # @param [Object] body 
+                    # @return [TaskQueueBulkRealTimeStatisticsInstance] Created TaskQueueBulkRealTimeStatisticsInstance
+                    def create(body: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, headers: headers, data: body.to_json)
+                        TaskQueueBulkRealTimeStatisticsInstance.new(
+                            @version,
+                            payload,
+                            workspace_sid: @solution[:workspace_sid],
+                        )
+                    end
+
+                    ##
+                    # Create the TaskQueueBulkRealTimeStatisticsInstanceMetadata
+                    # @param [Object] body 
+                    # @return [TaskQueueBulkRealTimeStatisticsInstance] Created TaskQueueBulkRealTimeStatisticsInstance
+                    def create_with_metadata(body: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        headers['Content-Type'] = 'application/json'
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, headers: headers, data: body.to_json)
+                        task_queue_bulk_real_time_statistics_instance = TaskQueueBulkRealTimeStatisticsInstance.new(
+                            @version,
+                            response.body,
+                            workspace_sid: @solution[:workspace_sid],
+                        )
+                        TaskQueueBulkRealTimeStatisticsInstanceMetadata.new(
+                            @version,
+                            task_queue_bulk_real_time_statistics_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
+                
+
+
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Taskrouter.V1.TaskQueueBulkRealTimeStatisticsList>'
+                    end
+                end
+
+                class TaskQueueBulkRealTimeStatisticsPage < Page
+                    ##
+                    # Initialize the TaskQueueBulkRealTimeStatisticsPage
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [TaskQueueBulkRealTimeStatisticsPage] TaskQueueBulkRealTimeStatisticsPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of TaskQueueBulkRealTimeStatisticsInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [TaskQueueBulkRealTimeStatisticsInstance] TaskQueueBulkRealTimeStatisticsInstance
+                    def get_instance(payload)
+                        TaskQueueBulkRealTimeStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Taskrouter.V1.TaskQueueBulkRealTimeStatisticsPage>'
+                    end
+                end
+
+                class TaskQueueBulkRealTimeStatisticsPageMetadata < PageMetadata
+                    attr_reader :task_queue_bulk_real_time_statistics_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @task_queue_bulk_real_time_statistics_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @task_queue_bulk_real_time_statistics_page << TaskQueueBulkRealTimeStatisticsListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @task_queue_bulk_real_time_statistics_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Taskrouter::V1PageMetadata>';
+                    end
+                end
+                class TaskQueueBulkRealTimeStatisticsListResponse < InstanceListResource
+
+                    # @param [Array<TaskQueueBulkRealTimeStatisticsInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]  || []
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @task_queue_bulk_real_time_statistics = data_list.map do |data|
+                        TaskQueueBulkRealTimeStatisticsInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def task_queue_bulk_real_time_statistics
+                        @task_queue_bulk_real_time_statistics
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
+                class TaskQueueBulkRealTimeStatisticsInstance < InstanceResource
+                    ##
+                    # Initialize the TaskQueueBulkRealTimeStatisticsInstance
+                    # @param [Version] version Version that contains the resource
+                    # @param [Hash] payload payload that contains response from Twilio
+                    # @param [String] account_sid The SID of the
+                    #   {Account}[https://www.twilio.com/docs/iam/api/account] that created this TaskQueueBulkRealTimeStatistics
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [TaskQueueBulkRealTimeStatisticsInstance] TaskQueueBulkRealTimeStatisticsInstance
+                    def initialize(version, payload , workspace_sid: nil)
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'account_sid' => payload['account_sid'],
+                            'workspace_sid' => payload['workspace_sid'],
+                            'task_queue_data' => payload['task_queue_data'],
+                            'task_queue_response_count' => payload['task_queue_response_count'] == nil ? payload['task_queue_response_count'] : payload['task_queue_response_count'].to_i,
+                            'url' => payload['url'],
+                        }
+                    end
+
+                    
+                    ##
+                    # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the TaskQueue resource.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the Workspace that contains the TaskQueue.
+                    def workspace_sid
+                        @properties['workspace_sid']
+                    end
+                    
+                    ##
+                    # @return [Array<Hash>] The real-time statistics for each requested TaskQueue SID. `task_queue_data` returns the following attributes:  `task_queue_sid`: The SID of the TaskQueue from which these statistics were calculated.  `total_available_workers`: The total number of Workers available for Tasks in the TaskQueue.  `total_eligible_workers`: The total number of Workers eligible for Tasks in the TaskQueue, regardless of their Activity state.  `total_tasks`: The total number of Tasks.  `longest_task_waiting_age`: The age of the longest waiting Task.  `longest_task_waiting_sid`: The SID of the longest waiting Task.  `tasks_by_status`: The number of Tasks grouped by their current status.  `tasks_by_priority`: The number of Tasks grouped by priority.  `activity_statistics`: The number of current Workers grouped by Activity. 
+                    def task_queue_data
+                        @properties['task_queue_data']
+                    end
+                    
+                    ##
+                    # @return [String] The number of TaskQueue statistics received in task_queue_data.
+                    def task_queue_response_count
+                        @properties['task_queue_response_count']
+                    end
+                    
+                    ##
+                    # @return [String] The absolute URL of the TaskQueue statistics resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        "<Twilio.Taskrouter.V1.TaskQueueBulkRealTimeStatisticsInstance>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        "<Twilio.Taskrouter.V1.TaskQueueBulkRealTimeStatisticsInstance>"
+                    end
+                end
+
+             end
+             end
+            end
+        end
+    end
+end
+
+

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

@@ -21,12 +21,14 @@ module Twilio
                 class TaskQueueContext < InstanceContext
 
                      class TaskQueueCumulativeStatisticsList < ListResource
+                
                     ##
                     # Initialize the TaskQueueCumulativeStatisticsList
                     # @param [Version] version Version that contains the resource
                     # @return [TaskQueueCumulativeStatisticsList] TaskQueueCumulativeStatisticsList
                     def initialize(version, workspace_sid: nil, task_queue_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid, task_queue_sid: task_queue_sid }
                         
@@ -51,6 +53,7 @@ module Twilio
                     # @return [TaskQueueCumulativeStatisticsContext] TaskQueueCumulativeStatisticsContext
                     def initialize(version, workspace_sid, task_queue_sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid, task_queue_sid: task_queue_sid,  }
@@ -67,11 +70,11 @@ module Twilio
                     # @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. TaskRouter will calculate statistics on up to 10,000 Tasks/Reservations for any given threshold.
                     # @return [TaskQueueCumulativeStatisticsInstance] Fetched TaskQueueCumulativeStatisticsInstance
                     def fetch(
-                        end_date: :unset, 
-                        minutes: :unset, 
-                        start_date: :unset, 
-                        task_channel: :unset, 
-                        split_by_wait_time: :unset
+                      end_date: :unset, 
+                      minutes: :unset, 
+                      start_date: :unset, 
+                      task_channel: :unset, 
+                      split_by_wait_time: :unset
                     )
 
                         params = Twilio::Values.of({
@@ -81,7 +84,13 @@ module Twilio
                             'TaskChannel' => task_channel,
                             'SplitByWaitTime' => split_by_wait_time,
                         })
-                        payload = @version.fetch('GET', @uri, params: params)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, params: params, headers: headers)
                         TaskQueueCumulativeStatisticsInstance.new(
                             @version,
                             payload,
@@ -90,6 +99,50 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the TaskQueueCumulativeStatisticsInstanceMetadata
+                    # @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 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. TaskRouter will calculate statistics on up to 10,000 Tasks/Reservations for any given threshold.
+                    # @return [TaskQueueCumulativeStatisticsInstance] Fetched TaskQueueCumulativeStatisticsInstance
+                    def fetch_with_metadata(
+                      end_date: :unset, 
+                      minutes: :unset, 
+                      start_date: :unset, 
+                      task_channel: :unset, 
+                      split_by_wait_time: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'EndDate' => Twilio.serialize_iso8601_datetime(end_date),
+                            'Minutes' => minutes,
+                            'StartDate' => Twilio.serialize_iso8601_datetime(start_date),
+                            'TaskChannel' => task_channel,
+                            'SplitByWaitTime' => split_by_wait_time,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
+                        task_queue_cumulative_statistics_instance = TaskQueueCumulativeStatisticsInstance.new(
+                            @version,
+                            response.body,
+                            workspace_sid: @solution[:workspace_sid],
+                            task_queue_sid: @solution[:task_queue_sid],
+                        )
+                        TaskQueueCumulativeStatisticsInstanceMetadata.new(
+                            @version,
+                            task_queue_cumulative_statistics_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -106,6 +159,53 @@ module Twilio
                     end
                 end
 
+                class TaskQueueCumulativeStatisticsInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new TaskQueueCumulativeStatisticsInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}TaskQueueCumulativeStatisticsInstance] task_queue_cumulative_statistics_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [TaskQueueCumulativeStatisticsInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, task_queue_cumulative_statistics_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @task_queue_cumulative_statistics_instance = task_queue_cumulative_statistics_instance
+                    end
+
+                    def task_queue_cumulative_statistics
+                        @task_queue_cumulative_statistics_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.TaskQueueCumulativeStatisticsInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class TaskQueueCumulativeStatisticsListResponse < InstanceListResource
+                    # @param [Array<TaskQueueCumulativeStatisticsInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @task_queue_cumulative_statistics_instance = payload.body[key].map do |data|
+                        TaskQueueCumulativeStatisticsInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def task_queue_cumulative_statistics_instance
+                          @instance
+                      end
+                  end
+
                 class TaskQueueCumulativeStatisticsPage < Page
                     ##
                     # Initialize the TaskQueueCumulativeStatisticsPage
@@ -115,6 +215,7 @@ module Twilio
                     # @return [TaskQueueCumulativeStatisticsPage] TaskQueueCumulativeStatisticsPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -134,6 +235,66 @@ module Twilio
                         '<Twilio.Taskrouter.V1.TaskQueueCumulativeStatisticsPage>'
                     end
                 end
+
+                class TaskQueueCumulativeStatisticsPageMetadata < PageMetadata
+                    attr_reader :task_queue_cumulative_statistics_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @task_queue_cumulative_statistics_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @task_queue_cumulative_statistics_page << TaskQueueCumulativeStatisticsListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @task_queue_cumulative_statistics_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Taskrouter::V1PageMetadata>';
+                    end
+                end
+                class TaskQueueCumulativeStatisticsListResponse < InstanceListResource
+
+                    # @param [Array<TaskQueueCumulativeStatisticsInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]  || []
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @task_queue_cumulative_statistics = data_list.map do |data|
+                        TaskQueueCumulativeStatisticsInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def task_queue_cumulative_statistics
+                        @task_queue_cumulative_statistics
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class TaskQueueCumulativeStatisticsInstance < InstanceResource
                     ##
                     # Initialize the TaskQueueCumulativeStatisticsInstance
@@ -147,6 +308,7 @@ module Twilio
                     def initialize(version, payload , workspace_sid: nil, task_queue_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],
@@ -330,11 +492,11 @@ module Twilio
                     # @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. TaskRouter will calculate statistics on up to 10,000 Tasks/Reservations for any given threshold.
                     # @return [TaskQueueCumulativeStatisticsInstance] Fetched TaskQueueCumulativeStatisticsInstance
                     def fetch(
-                        end_date: :unset, 
-                        minutes: :unset, 
-                        start_date: :unset, 
-                        task_channel: :unset, 
-                        split_by_wait_time: :unset
+                      end_date: :unset, 
+                      minutes: :unset, 
+                      start_date: :unset, 
+                      task_channel: :unset, 
+                      split_by_wait_time: :unset
                     )
 
                         context.fetch(