twilio-ruby 7.9.1 → 7.10.0

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

@@ -28,6 +28,7 @@ module Twilio
                     # @return [TaskQueueRealTimeStatisticsList] TaskQueueRealTimeStatisticsList
                     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 }
                         
@@ -52,6 +53,7 @@ module Twilio
                     # @return [TaskQueueRealTimeStatisticsContext] TaskQueueRealTimeStatisticsContext
                     def initialize(version, workspace_sid, task_queue_sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid, task_queue_sid: task_queue_sid,  }
@@ -85,6 +87,38 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the TaskQueueRealTimeStatisticsInstanceMetadata
+                    # @param [String] task_channel The TaskChannel for which to fetch statistics. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
+                    # @return [TaskQueueRealTimeStatisticsInstance] Fetched TaskQueueRealTimeStatisticsInstance
+                    def fetch_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)
+                        task_queue_real_time_statistics_instance = TaskQueueRealTimeStatisticsInstance.new(
+                            @version,
+                            response.body,
+                            workspace_sid: @solution[:workspace_sid],
+                            task_queue_sid: @solution[:task_queue_sid],
+                        )
+                        TaskQueueRealTimeStatisticsInstanceMetadata.new(
+                            @version,
+                            task_queue_real_time_statistics_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -101,6 +135,53 @@ module Twilio
                     end
                 end
 
+                class TaskQueueRealTimeStatisticsInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new TaskQueueRealTimeStatisticsInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}TaskQueueRealTimeStatisticsInstance] task_queue_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 [TaskQueueRealTimeStatisticsInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, task_queue_real_time_statistics_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @task_queue_real_time_statistics_instance = task_queue_real_time_statistics_instance
+                    end
+
+                    def task_queue_real_time_statistics
+                        @task_queue_real_time_statistics_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.TaskQueueRealTimeStatisticsInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class TaskQueueRealTimeStatisticsListResponse < InstanceListResource
+                    # @param [Array<TaskQueueRealTimeStatisticsInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @task_queue_real_time_statistics_instance = payload.body[key].map do |data|
+                        TaskQueueRealTimeStatisticsInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def task_queue_real_time_statistics_instance
+                          @instance
+                      end
+                  end
+
                 class TaskQueueRealTimeStatisticsPage < Page
                     ##
                     # Initialize the TaskQueueRealTimeStatisticsPage
@@ -110,6 +191,7 @@ module Twilio
                     # @return [TaskQueueRealTimeStatisticsPage] TaskQueueRealTimeStatisticsPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -129,6 +211,66 @@ module Twilio
                         '<Twilio.Taskrouter.V1.TaskQueueRealTimeStatisticsPage>'
                     end
                 end
+
+                class TaskQueueRealTimeStatisticsPageMetadata < PageMetadata
+                    attr_reader :task_queue_real_time_statistics_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @task_queue_real_time_statistics_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @task_queue_real_time_statistics_page << TaskQueueRealTimeStatisticsListResponse.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_real_time_statistics_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Taskrouter::V1PageMetadata>';
+                    end
+                end
+                class TaskQueueRealTimeStatisticsListResponse < InstanceListResource
+
+                    # @param [Array<TaskQueueRealTimeStatisticsInstance>] 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_real_time_statistics = data_list.map do |data|
+                        TaskQueueRealTimeStatisticsInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def task_queue_real_time_statistics
+                        @task_queue_real_time_statistics
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class TaskQueueRealTimeStatisticsInstance < InstanceResource
                     ##
                     # Initialize the TaskQueueRealTimeStatisticsInstance
@@ -142,6 +284,7 @@ module Twilio
                     def initialize(version, payload , workspace_sid: nil, task_queue_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],

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

@@ -28,6 +28,7 @@ module Twilio
                     # @return [TaskQueueStatisticsList] TaskQueueStatisticsList
                     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 }
                         
@@ -52,6 +53,7 @@ module Twilio
                     # @return [TaskQueueStatisticsContext] TaskQueueStatisticsContext
                     def initialize(version, workspace_sid, task_queue_sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid, task_queue_sid: task_queue_sid,  }
@@ -97,6 +99,50 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the TaskQueueStatisticsInstanceMetadata
+                    # @param [Time] end_date Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
+                    # @param [String] minutes Only calculate statistics since this many minutes in the past. The default is 15 minutes.
+                    # @param [Time] start_date Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                    # @param [String] task_channel Only calculate real-time and cumulative statistics for the specified TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
+                    # @param [String] split_by_wait_time A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on. For each threshold specified, the number of Tasks canceled and reservations accepted above and below the specified thresholds in seconds are computed.
+                    # @return [TaskQueueStatisticsInstance] Fetched TaskQueueStatisticsInstance
+                    def fetch_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_statistics_instance = TaskQueueStatisticsInstance.new(
+                            @version,
+                            response.body,
+                            workspace_sid: @solution[:workspace_sid],
+                            task_queue_sid: @solution[:task_queue_sid],
+                        )
+                        TaskQueueStatisticsInstanceMetadata.new(
+                            @version,
+                            task_queue_statistics_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -113,6 +159,53 @@ module Twilio
                     end
                 end
 
+                class TaskQueueStatisticsInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new TaskQueueStatisticsInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}TaskQueueStatisticsInstance] task_queue_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 [TaskQueueStatisticsInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, task_queue_statistics_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @task_queue_statistics_instance = task_queue_statistics_instance
+                    end
+
+                    def task_queue_statistics
+                        @task_queue_statistics_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.TaskQueueStatisticsInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class TaskQueueStatisticsListResponse < InstanceListResource
+                    # @param [Array<TaskQueueStatisticsInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @task_queue_statistics_instance = payload.body[key].map do |data|
+                        TaskQueueStatisticsInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def task_queue_statistics_instance
+                          @instance
+                      end
+                  end
+
                 class TaskQueueStatisticsPage < Page
                     ##
                     # Initialize the TaskQueueStatisticsPage
@@ -122,6 +215,7 @@ module Twilio
                     # @return [TaskQueueStatisticsPage] TaskQueueStatisticsPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -141,6 +235,66 @@ module Twilio
                         '<Twilio.Taskrouter.V1.TaskQueueStatisticsPage>'
                     end
                 end
+
+                class TaskQueueStatisticsPageMetadata < PageMetadata
+                    attr_reader :task_queue_statistics_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @task_queue_statistics_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @task_queue_statistics_page << TaskQueueStatisticsListResponse.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_statistics_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Taskrouter::V1PageMetadata>';
+                    end
+                end
+                class TaskQueueStatisticsListResponse < InstanceListResource
+
+                    # @param [Array<TaskQueueStatisticsInstance>] 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_statistics = data_list.map do |data|
+                        TaskQueueStatisticsInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def task_queue_statistics
+                        @task_queue_statistics
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class TaskQueueStatisticsInstance < InstanceResource
                     ##
                     # Initialize the TaskQueueStatisticsInstance
@@ -154,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'],

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

@@ -28,6 +28,7 @@ module Twilio
                     # @return [TaskQueuesStatisticsList] TaskQueuesStatisticsList
                     def initialize(version, workspace_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid }
                         @uri = "/Workspaces/#{@solution[:workspace_sid]}/TaskQueues/Statistics"
@@ -96,6 +97,40 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists TaskQueuesStatisticsPageMetadata records from the API as a list.
+                      # @param [Time] end_date Only calculate statistics from this date and time and earlier, specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
+                      # @param [String] friendly_name The `friendly_name` of the TaskQueue statistics to read.
+                      # @param [String] minutes Only calculate statistics since this many minutes in the past. The default is 15 minutes.
+                      # @param [Time] start_date Only calculate statistics from this date and time and later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+                      # @param [String] task_channel Only calculate statistics on this TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or `default`.
+                      # @param [String] split_by_wait_time A comma separated list of values that describes the thresholds, in seconds, to calculate statistics on. For each threshold specified, the number of Tasks canceled and reservations accepted above and below the specified thresholds in seconds are computed.
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Array] Array of up to limit results
+                    def list_with_metadata(end_date: :unset, friendly_name: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'EndDate' =>  Twilio.serialize_iso8601_datetime(end_date),
+                            'FriendlyName' => friendly_name,
+                            'Minutes' => minutes,
+                            'StartDate' =>  Twilio.serialize_iso8601_datetime(start_date),
+                            'TaskChannel' => task_channel,
+                            'SplitByWaitTime' => split_by_wait_time,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        TaskQueuesStatisticsPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields TaskQueuesStatisticsInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -123,7 +158,7 @@ module Twilio
                     # @param [Integer] page_number Page Number, this value is simply for client state
                     # @param [Integer] page_size Number of records to return, defaults to 50
                     # @return [Page] Page of TaskQueuesStatisticsInstance
-                    def page(end_date: :unset, friendly_name: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(end_date: :unset, friendly_name: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'EndDate' =>  Twilio.serialize_iso8601_datetime(end_date),
                             'FriendlyName' => friendly_name,
@@ -174,6 +209,7 @@ module Twilio
                     # @return [TaskQueuesStatisticsPage] TaskQueuesStatisticsPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -193,6 +229,66 @@ module Twilio
                         '<Twilio.Taskrouter.V1.TaskQueuesStatisticsPage>'
                     end
                 end
+
+                class TaskQueuesStatisticsPageMetadata < PageMetadata
+                    attr_reader :task_queues_statistics_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @task_queues_statistics_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @task_queues_statistics_page << TaskQueuesStatisticsListResponse.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_queues_statistics_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Taskrouter::V1PageMetadata>';
+                    end
+                end
+                class TaskQueuesStatisticsListResponse < InstanceListResource
+
+                    # @param [Array<TaskQueuesStatisticsInstance>] 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_queues_statistics = data_list.map do |data|
+                        TaskQueuesStatisticsInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def task_queues_statistics
+                        @task_queues_statistics
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class TaskQueuesStatisticsInstance < InstanceResource
                     ##
                     # Initialize the TaskQueuesStatisticsInstance
@@ -206,6 +302,7 @@ module Twilio
                     def initialize(version, payload , workspace_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],