twilio-ruby 7.9.1 → 7.10.0

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_real_time_statistics.rb

@@ -28,6 +28,7 @@ module Twilio
                     # @return [WorkflowRealTimeStatisticsList] WorkflowRealTimeStatisticsList
                     def initialize(version, workspace_sid: nil, workflow_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid, workflow_sid: workflow_sid }
                         
@@ -52,6 +53,7 @@ module Twilio
                     # @return [WorkflowRealTimeStatisticsContext] WorkflowRealTimeStatisticsContext
                     def initialize(version, workspace_sid, workflow_sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid, workflow_sid: workflow_sid,  }
@@ -85,6 +87,38 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the WorkflowRealTimeStatisticsInstanceMetadata
+                    # @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 [WorkflowRealTimeStatisticsInstance] Fetched WorkflowRealTimeStatisticsInstance
+                    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)
+                        workflow_real_time_statistics_instance = WorkflowRealTimeStatisticsInstance.new(
+                            @version,
+                            response.body,
+                            workspace_sid: @solution[:workspace_sid],
+                            workflow_sid: @solution[:workflow_sid],
+                        )
+                        WorkflowRealTimeStatisticsInstanceMetadata.new(
+                            @version,
+                            workflow_real_time_statistics_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -101,6 +135,53 @@ module Twilio
                     end
                 end
 
+                class WorkflowRealTimeStatisticsInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new WorkflowRealTimeStatisticsInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}WorkflowRealTimeStatisticsInstance] workflow_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 [WorkflowRealTimeStatisticsInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, workflow_real_time_statistics_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @workflow_real_time_statistics_instance = workflow_real_time_statistics_instance
+                    end
+
+                    def workflow_real_time_statistics
+                        @workflow_real_time_statistics_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.WorkflowRealTimeStatisticsInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class WorkflowRealTimeStatisticsListResponse < InstanceListResource
+                    # @param [Array<WorkflowRealTimeStatisticsInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @workflow_real_time_statistics_instance = payload.body[key].map do |data|
+                        WorkflowRealTimeStatisticsInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def workflow_real_time_statistics_instance
+                          @instance
+                      end
+                  end
+
                 class WorkflowRealTimeStatisticsPage < Page
                     ##
                     # Initialize the WorkflowRealTimeStatisticsPage
@@ -110,6 +191,7 @@ module Twilio
                     # @return [WorkflowRealTimeStatisticsPage] WorkflowRealTimeStatisticsPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -129,6 +211,66 @@ module Twilio
                         '<Twilio.Taskrouter.V1.WorkflowRealTimeStatisticsPage>'
                     end
                 end
+
+                class WorkflowRealTimeStatisticsPageMetadata < PageMetadata
+                    attr_reader :workflow_real_time_statistics_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @workflow_real_time_statistics_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @workflow_real_time_statistics_page << WorkflowRealTimeStatisticsListResponse.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
+                        @workflow_real_time_statistics_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Taskrouter::V1PageMetadata>';
+                    end
+                end
+                class WorkflowRealTimeStatisticsListResponse < InstanceListResource
+
+                    # @param [Array<WorkflowRealTimeStatisticsInstance>] 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
+                      @workflow_real_time_statistics = data_list.map do |data|
+                        WorkflowRealTimeStatisticsInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def workflow_real_time_statistics
+                        @workflow_real_time_statistics
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class WorkflowRealTimeStatisticsInstance < InstanceResource
                     ##
                     # Initialize the WorkflowRealTimeStatisticsInstance
@@ -142,6 +284,7 @@ module Twilio
                     def initialize(version, payload , workspace_sid: nil, workflow_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/workflow/workflow_statistics.rb

@@ -28,6 +28,7 @@ module Twilio
                     # @return [WorkflowStatisticsList] WorkflowStatisticsList
                     def initialize(version, workspace_sid: nil, workflow_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid, workflow_sid: workflow_sid }
                         
@@ -52,6 +53,7 @@ module Twilio
                     # @return [WorkflowStatisticsContext] WorkflowStatisticsContext
                     def initialize(version, workspace_sid, workflow_sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid, workflow_sid: workflow_sid,  }
@@ -97,6 +99,50 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the WorkflowStatisticsInstanceMetadata
+                    # @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_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`.
+                    # @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. For example, `5,30` would show splits of Tasks that were canceled or accepted before and after 5 seconds and before and after 30 seconds. This can be used to show short abandoned Tasks or Tasks that failed to meet an SLA.
+                    # @return [WorkflowStatisticsInstance] Fetched WorkflowStatisticsInstance
+                    def fetch_with_metadata(
+                      minutes: :unset, 
+                      start_date: :unset, 
+                      end_date: :unset, 
+                      task_channel: :unset, 
+                      split_by_wait_time: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'Minutes' => minutes,
+                            'StartDate' => Twilio.serialize_iso8601_datetime(start_date),
+                            'EndDate' => Twilio.serialize_iso8601_datetime(end_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)
+                        workflow_statistics_instance = WorkflowStatisticsInstance.new(
+                            @version,
+                            response.body,
+                            workspace_sid: @solution[:workspace_sid],
+                            workflow_sid: @solution[:workflow_sid],
+                        )
+                        WorkflowStatisticsInstanceMetadata.new(
+                            @version,
+                            workflow_statistics_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -113,6 +159,53 @@ module Twilio
                     end
                 end
 
+                class WorkflowStatisticsInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new WorkflowStatisticsInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}WorkflowStatisticsInstance] workflow_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 [WorkflowStatisticsInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, workflow_statistics_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @workflow_statistics_instance = workflow_statistics_instance
+                    end
+
+                    def workflow_statistics
+                        @workflow_statistics_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.WorkflowStatisticsInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class WorkflowStatisticsListResponse < InstanceListResource
+                    # @param [Array<WorkflowStatisticsInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @workflow_statistics_instance = payload.body[key].map do |data|
+                        WorkflowStatisticsInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def workflow_statistics_instance
+                          @instance
+                      end
+                  end
+
                 class WorkflowStatisticsPage < Page
                     ##
                     # Initialize the WorkflowStatisticsPage
@@ -122,6 +215,7 @@ module Twilio
                     # @return [WorkflowStatisticsPage] WorkflowStatisticsPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -141,6 +235,66 @@ module Twilio
                         '<Twilio.Taskrouter.V1.WorkflowStatisticsPage>'
                     end
                 end
+
+                class WorkflowStatisticsPageMetadata < PageMetadata
+                    attr_reader :workflow_statistics_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @workflow_statistics_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @workflow_statistics_page << WorkflowStatisticsListResponse.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
+                        @workflow_statistics_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Taskrouter::V1PageMetadata>';
+                    end
+                end
+                class WorkflowStatisticsListResponse < InstanceListResource
+
+                    # @param [Array<WorkflowStatisticsInstance>] 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
+                      @workflow_statistics = data_list.map do |data|
+                        WorkflowStatisticsInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def workflow_statistics
+                        @workflow_statistics
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class WorkflowStatisticsInstance < InstanceResource
                     ##
                     # Initialize the WorkflowStatisticsInstance
@@ -154,6 +308,7 @@ module Twilio
                     def initialize(version, payload , workspace_sid: nil, workflow_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],