twilio-ruby 7.9.1 → 7.10.0

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

@@ -28,6 +28,7 @@ module Twilio
                     # @return [WorkersRealTimeStatisticsList] WorkersRealTimeStatisticsList
                     def initialize(version, workspace_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid }
                         
@@ -51,6 +52,7 @@ module Twilio
                     # @return [WorkersRealTimeStatisticsContext] WorkersRealTimeStatisticsContext
                     def initialize(version, workspace_sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid,  }
@@ -83,6 +85,37 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the WorkersRealTimeStatisticsInstanceMetadata
+                    # @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_with_metadata(
+                      task_channel: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'TaskChannel' => task_channel,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
+                        workers_real_time_statistics_instance = WorkersRealTimeStatisticsInstance.new(
+                            @version,
+                            response.body,
+                            workspace_sid: @solution[:workspace_sid],
+                        )
+                        WorkersRealTimeStatisticsInstanceMetadata.new(
+                            @version,
+                            workers_real_time_statistics_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -99,6 +132,53 @@ module Twilio
                     end
                 end
 
+                class WorkersRealTimeStatisticsInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new WorkersRealTimeStatisticsInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}WorkersRealTimeStatisticsInstance] workers_real_time_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 [WorkersRealTimeStatisticsInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, workers_real_time_statistics_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @workers_real_time_statistics_instance = workers_real_time_statistics_instance
+                    end
+
+                    def workers_real_time_statistics
+                        @workers_real_time_statistics_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.WorkersRealTimeStatisticsInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class WorkersRealTimeStatisticsListResponse < InstanceListResource
+                    # @param [Array<WorkersRealTimeStatisticsInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @workers_real_time_statistics_instance = payload.body[key].map do |data|
+                        WorkersRealTimeStatisticsInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def workers_real_time_statistics_instance
+                          @instance
+                      end
+                  end
+
                 class WorkersRealTimeStatisticsPage < Page
                     ##
                     # Initialize the WorkersRealTimeStatisticsPage
@@ -108,6 +188,7 @@ module Twilio
                     # @return [WorkersRealTimeStatisticsPage] WorkersRealTimeStatisticsPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -127,6 +208,66 @@ module Twilio
                         '<Twilio.Taskrouter.V1.WorkersRealTimeStatisticsPage>'
                     end
                 end
+
+                class WorkersRealTimeStatisticsPageMetadata < PageMetadata
+                    attr_reader :workers_real_time_statistics_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @workers_real_time_statistics_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @workers_real_time_statistics_page << WorkersRealTimeStatisticsListResponse.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
+                        @workers_real_time_statistics_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Taskrouter::V1PageMetadata>';
+                    end
+                end
+                class WorkersRealTimeStatisticsListResponse < InstanceListResource
+
+                    # @param [Array<WorkersRealTimeStatisticsInstance>] 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
+                      @workers_real_time_statistics = data_list.map do |data|
+                        WorkersRealTimeStatisticsInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def workers_real_time_statistics
+                        @workers_real_time_statistics
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class WorkersRealTimeStatisticsInstance < InstanceResource
                     ##
                     # Initialize the WorkersRealTimeStatisticsInstance
@@ -140,6 +281,7 @@ module Twilio
                     def initialize(version, payload , workspace_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],

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

@@ -28,6 +28,7 @@ module Twilio
                     # @return [WorkersStatisticsList] WorkersStatisticsList
                     def initialize(version, workspace_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid }
                         
@@ -51,6 +52,7 @@ module Twilio
                     # @return [WorkersStatisticsContext] WorkersStatisticsContext
                     def initialize(version, workspace_sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid,  }
@@ -101,6 +103,55 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the WorkersStatisticsInstanceMetadata
+                    # @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_with_metadata(
+                      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({
+                            'Minutes' => minutes,
+                            'StartDate' => Twilio.serialize_iso8601_datetime(start_date),
+                            'EndDate' => Twilio.serialize_iso8601_datetime(end_date),
+                            'TaskQueueSid' => task_queue_sid,
+                            'TaskQueueName' => task_queue_name,
+                            'FriendlyName' => friendly_name,
+                            'TaskChannel' => task_channel,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, params: params, headers: headers)
+                        workers_statistics_instance = WorkersStatisticsInstance.new(
+                            @version,
+                            response.body,
+                            workspace_sid: @solution[:workspace_sid],
+                        )
+                        WorkersStatisticsInstanceMetadata.new(
+                            @version,
+                            workers_statistics_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -117,6 +168,53 @@ module Twilio
                     end
                 end
 
+                class WorkersStatisticsInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new WorkersStatisticsInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}WorkersStatisticsInstance] workers_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 [WorkersStatisticsInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, workers_statistics_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @workers_statistics_instance = workers_statistics_instance
+                    end
+
+                    def workers_statistics
+                        @workers_statistics_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.WorkersStatisticsInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class WorkersStatisticsListResponse < InstanceListResource
+                    # @param [Array<WorkersStatisticsInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @workers_statistics_instance = payload.body[key].map do |data|
+                        WorkersStatisticsInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def workers_statistics_instance
+                          @instance
+                      end
+                  end
+
                 class WorkersStatisticsPage < Page
                     ##
                     # Initialize the WorkersStatisticsPage
@@ -126,6 +224,7 @@ module Twilio
                     # @return [WorkersStatisticsPage] WorkersStatisticsPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -145,6 +244,66 @@ module Twilio
                         '<Twilio.Taskrouter.V1.WorkersStatisticsPage>'
                     end
                 end
+
+                class WorkersStatisticsPageMetadata < PageMetadata
+                    attr_reader :workers_statistics_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @workers_statistics_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @workers_statistics_page << WorkersStatisticsListResponse.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
+                        @workers_statistics_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Taskrouter::V1PageMetadata>';
+                    end
+                end
+                class WorkersStatisticsListResponse < InstanceListResource
+
+                    # @param [Array<WorkersStatisticsInstance>] 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
+                      @workers_statistics = data_list.map do |data|
+                        WorkersStatisticsInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def workers_statistics
+                        @workers_statistics
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class WorkersStatisticsInstance < InstanceResource
                     ##
                     # Initialize the WorkersStatisticsInstance
@@ -158,6 +317,7 @@ module Twilio
                     def initialize(version, payload , workspace_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'realtime' => payload['realtime'],