twilio-ruby 5.74.0 → 7.10.1

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

@@ -1,252 +1,406 @@
 ##
-# This code was generated by
-# \ / _    _  _|   _  _
-#  | (_)\/(_)(_|\/| |(/_  v1.0.0
-#       /       /
+#    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.
 #
-# frozen_string_literal: true
+
 
 module Twilio
-  module REST
-    class Taskrouter < Domain
-      class V1 < Version
-        class WorkspaceContext < InstanceContext
-          class WorkflowContext < InstanceContext
-            class WorkflowRealTimeStatisticsList < ListResource
-              ##
-              # Initialize the WorkflowRealTimeStatisticsList
-              # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The SID of the Workspace that contains the
-              #   Workflow.
-              # @param [String] workflow_sid Returns the list of Tasks that are being controlled
-              #   by the Workflow with the specified SID value.
-              # @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}
-              end
-
-              ##
-              # Provide a user friendly representation
-              def to_s
-                '#<Twilio.Taskrouter.V1.WorkflowRealTimeStatisticsList>'
-              end
-            end
+    module REST
+        class Taskrouter < TaskrouterBase
+            class V1 < Version
+                class WorkspaceContext < InstanceContext
+                class WorkflowContext < InstanceContext
 
-            class WorkflowRealTimeStatisticsPage < Page
-              ##
-              # Initialize the WorkflowRealTimeStatisticsPage
-              # @param [Version] version Version that contains the resource
-              # @param [Response] response Response from the API
-              # @param [Hash] solution Path solution for the resource
-              # @return [WorkflowRealTimeStatisticsPage] WorkflowRealTimeStatisticsPage
-              def initialize(version, response, solution)
-                super(version, response)
-
-                # Path Solution
-                @solution = solution
-              end
-
-              ##
-              # Build an instance of WorkflowRealTimeStatisticsInstance
-              # @param [Hash] payload Payload response from the API
-              # @return [WorkflowRealTimeStatisticsInstance] WorkflowRealTimeStatisticsInstance
-              def get_instance(payload)
-                WorkflowRealTimeStatisticsInstance.new(
-                    @version,
-                    payload,
-                    workspace_sid: @solution[:workspace_sid],
-                    workflow_sid: @solution[:workflow_sid],
-                )
-              end
-
-              ##
-              # Provide a user friendly representation
-              def to_s
-                '<Twilio.Taskrouter.V1.WorkflowRealTimeStatisticsPage>'
-              end
-            end
+                     class WorkflowRealTimeStatisticsList < ListResource
+                
+                    ##
+                    # Initialize the WorkflowRealTimeStatisticsList
+                    # @param [Version] version Version that contains the resource
+                    # @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 }
+                        
+                        
+                    end
+                
 
-            class WorkflowRealTimeStatisticsContext < InstanceContext
-              ##
-              # Initialize the WorkflowRealTimeStatisticsContext
-              # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The SID of the Workspace with the Workflow to
-              #   fetch.
-              # @param [String] workflow_sid Returns the list of Tasks that are being controlled
-              #   by the Workflow with the specified SID value.
-              # @return [WorkflowRealTimeStatisticsContext] WorkflowRealTimeStatisticsContext
-              def initialize(version, workspace_sid, workflow_sid)
-                super(version)
-
-                # Path Solution
-                @solution = {workspace_sid: workspace_sid, workflow_sid: workflow_sid, }
-                @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workflows/#{@solution[:workflow_sid]}/RealTimeStatistics"
-              end
-
-              ##
-              # Fetch the WorkflowRealTimeStatisticsInstance
-              # @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(task_channel: :unset)
-                params = Twilio::Values.of({'TaskChannel' => task_channel, })
-
-                payload = @version.fetch('GET', @uri, params: params)
-
-                WorkflowRealTimeStatisticsInstance.new(
-                    @version,
-                    payload,
-                    workspace_sid: @solution[:workspace_sid],
-                    workflow_sid: @solution[:workflow_sid],
-                )
-              end
-
-              ##
-              # Provide a user friendly representation
-              def to_s
-                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-                "#<Twilio.Taskrouter.V1.WorkflowRealTimeStatisticsContext #{context}>"
-              end
-
-              ##
-              # Provide a detailed, user friendly representation
-              def inspect
-                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-                "#<Twilio.Taskrouter.V1.WorkflowRealTimeStatisticsContext #{context}>"
-              end
-            end
 
-            class WorkflowRealTimeStatisticsInstance < InstanceResource
-              ##
-              # Initialize the WorkflowRealTimeStatisticsInstance
-              # @param [Version] version Version that contains the resource
-              # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] workspace_sid The SID of the Workspace that contains the
-              #   Workflow.
-              # @param [String] workflow_sid Returns the list of Tasks that are being controlled
-              #   by the Workflow with the specified SID value.
-              # @return [WorkflowRealTimeStatisticsInstance] WorkflowRealTimeStatisticsInstance
-              def initialize(version, payload, workspace_sid: nil, workflow_sid: nil)
-                super(version)
-
-                # Marshaled Properties
-                @properties = {
-                    'account_sid' => payload['account_sid'],
-                    'longest_task_waiting_age' => payload['longest_task_waiting_age'] == nil ? payload['longest_task_waiting_age'] : payload['longest_task_waiting_age'].to_i,
-                    'longest_task_waiting_sid' => payload['longest_task_waiting_sid'],
-                    'tasks_by_priority' => payload['tasks_by_priority'],
-                    'tasks_by_status' => payload['tasks_by_status'],
-                    'total_tasks' => payload['total_tasks'] == nil ? payload['total_tasks'] : payload['total_tasks'].to_i,
-                    'workflow_sid' => payload['workflow_sid'],
-                    'workspace_sid' => payload['workspace_sid'],
-                    'url' => payload['url'],
-                }
-
-                # Context
-                @instance_context = nil
-                @params = {'workspace_sid' => workspace_sid, 'workflow_sid' => workflow_sid, }
-              end
-
-              ##
-              # Generate an instance context for the instance, the context is capable of
-              # performing various actions.  All instance actions are proxied to the context
-              # @return [WorkflowRealTimeStatisticsContext] WorkflowRealTimeStatisticsContext for this WorkflowRealTimeStatisticsInstance
-              def context
-                unless @instance_context
-                  @instance_context = WorkflowRealTimeStatisticsContext.new(
-                      @version,
-                      @params['workspace_sid'],
-                      @params['workflow_sid'],
-                  )
+                    # Provide a user friendly representation
+                    def to_s
+                        '#<Twilio.Taskrouter.V1.WorkflowRealTimeStatisticsList>'
+                    end
+                end
+
+
+                class WorkflowRealTimeStatisticsContext < InstanceContext
+                    ##
+                    # Initialize the WorkflowRealTimeStatisticsContext
+                    # @param [Version] version Version that contains the resource
+                    # @param [String] workspace_sid The SID of the Workspace with the Workflow to fetch.
+                    # @param [String] workflow_sid Returns the list of Tasks that are being controlled by the Workflow with the specified SID value.
+                    # @return [WorkflowRealTimeStatisticsContext] WorkflowRealTimeStatisticsContext
+                    def initialize(version, workspace_sid, workflow_sid)
+                        super(version)
+                        
+
+                        # Path Solution
+                        @solution = { workspace_sid: workspace_sid, workflow_sid: workflow_sid,  }
+                        @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workflows/#{@solution[:workflow_sid]}/RealTimeStatistics"
+
+                        
+                    end
+                    ##
+                    # Fetch the WorkflowRealTimeStatisticsInstance
+                    # @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(
+                        task_channel: :unset
+                    )
+
+                        params = Twilio::Values.of({
+                            'TaskChannel' => task_channel,
+                        })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, params: params, headers: headers)
+                        WorkflowRealTimeStatisticsInstance.new(
+                            @version,
+                            payload,
+                            workspace_sid: @solution[:workspace_sid],
+                            workflow_sid: @solution[:workflow_sid],
+                        )
+                    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
+                    def to_s
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Taskrouter.V1.WorkflowRealTimeStatisticsContext #{context}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        context = @solution.map{|k, v| "#{k}: #{v}"}.join(',')
+                        "#<Twilio.Taskrouter.V1.WorkflowRealTimeStatisticsContext #{context}>"
+                    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
+                    # @param [Version] version Version that contains the resource
+                    # @param [Response] response Response from the API
+                    # @param [Hash] solution Path solution for the resource
+                    # @return [WorkflowRealTimeStatisticsPage] WorkflowRealTimeStatisticsPage
+                    def initialize(version, response, solution)
+                        super(version, response)
+                        
+
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    ##
+                    # Build an instance of WorkflowRealTimeStatisticsInstance
+                    # @param [Hash] payload Payload response from the API
+                    # @return [WorkflowRealTimeStatisticsInstance] WorkflowRealTimeStatisticsInstance
+                    def get_instance(payload)
+                        WorkflowRealTimeStatisticsInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], workflow_sid: @solution[:workflow_sid])
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        '<Twilio.Taskrouter.V1.WorkflowRealTimeStatisticsPage>'
+                    end
                 end
-                @instance_context
-              end
-
-              ##
-              # @return [String] The SID of the Account that created the resource
-              def account_sid
-                @properties['account_sid']
-              end
-
-              ##
-              # @return [String] The age of the longest waiting Task
-              def longest_task_waiting_age
-                @properties['longest_task_waiting_age']
-              end
-
-              ##
-              # @return [String] The SID of the longest waiting Task
-              def longest_task_waiting_sid
-                @properties['longest_task_waiting_sid']
-              end
-
-              ##
-              # @return [Hash] The number of Tasks by priority
-              def tasks_by_priority
-                @properties['tasks_by_priority']
-              end
-
-              ##
-              # @return [Hash] The number of Tasks by their current status
-              def tasks_by_status
-                @properties['tasks_by_status']
-              end
-
-              ##
-              # @return [String] The total number of Tasks
-              def total_tasks
-                @properties['total_tasks']
-              end
-
-              ##
-              # @return [String] Returns the list of Tasks that are being controlled by the Workflow with the specified SID value
-              def workflow_sid
-                @properties['workflow_sid']
-              end
-
-              ##
-              # @return [String] The SID of the Workspace that contains the Workflow.
-              def workspace_sid
-                @properties['workspace_sid']
-              end
-
-              ##
-              # @return [String] The absolute URL of the Workflow statistics resource
-              def url
-                @properties['url']
-              end
-
-              ##
-              # Fetch the WorkflowRealTimeStatisticsInstance
-              # @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(task_channel: :unset)
-                context.fetch(task_channel: task_channel, )
-              end
-
-              ##
-              # Provide a user friendly representation
-              def to_s
-                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-                "<Twilio.Taskrouter.V1.WorkflowRealTimeStatisticsInstance #{values}>"
-              end
-
-              ##
-              # Provide a detailed, user friendly representation
-              def inspect
-                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-                "<Twilio.Taskrouter.V1.WorkflowRealTimeStatisticsInstance #{values}>"
-              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
+                    # @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 WorkflowRealTimeStatistics
+                    #   resource.
+                    # @param [String] sid The SID of the Call resource to fetch.
+                    # @return [WorkflowRealTimeStatisticsInstance] WorkflowRealTimeStatisticsInstance
+                    def initialize(version, payload , workspace_sid: nil, workflow_sid: nil)
+                        super(version)
+                        
+                        
+                        # Marshaled Properties
+                        @properties = { 
+                            'account_sid' => payload['account_sid'],
+                            'longest_task_waiting_age' => payload['longest_task_waiting_age'] == nil ? payload['longest_task_waiting_age'] : payload['longest_task_waiting_age'].to_i,
+                            'longest_task_waiting_sid' => payload['longest_task_waiting_sid'],
+                            'tasks_by_priority' => payload['tasks_by_priority'],
+                            'tasks_by_status' => payload['tasks_by_status'],
+                            'total_tasks' => payload['total_tasks'] == nil ? payload['total_tasks'] : payload['total_tasks'].to_i,
+                            'workflow_sid' => payload['workflow_sid'],
+                            'workspace_sid' => payload['workspace_sid'],
+                            'url' => payload['url'],
+                        }
+
+                        # Context
+                        @instance_context = nil
+                        @params = { 'workspace_sid' => workspace_sid  || @properties['workspace_sid']  ,'workflow_sid' => workflow_sid  || @properties['workflow_sid']  , }
+                    end
+
+                    ##
+                    # Generate an instance context for the instance, the context is capable of
+                    # performing various actions.  All instance actions are proxied to the context
+                    # @return [WorkflowRealTimeStatisticsContext] CallContext for this CallInstance
+                    def context
+                        unless @instance_context
+                            @instance_context = WorkflowRealTimeStatisticsContext.new(@version , @params['workspace_sid'], @params['workflow_sid'])
+                        end
+                        @instance_context
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the [Account](https://www.twilio.com/docs/iam/api/account) that created the Workflow resource.
+                    def account_sid
+                        @properties['account_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The age of the longest waiting Task.
+                    def longest_task_waiting_age
+                        @properties['longest_task_waiting_age']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the longest waiting Task.
+                    def longest_task_waiting_sid
+                        @properties['longest_task_waiting_sid']
+                    end
+                    
+                    ##
+                    # @return [Hash] The number of Tasks by priority. For example: `{\"0\": \"10\", \"99\": \"5\"}` shows 10 Tasks at priority 0 and 5 at priority 99.
+                    def tasks_by_priority
+                        @properties['tasks_by_priority']
+                    end
+                    
+                    ##
+                    # @return [Hash] The number of Tasks by their current status. For example: `{\"pending\": \"1\", \"reserved\": \"3\", \"assigned\": \"2\", \"completed\": \"5\"}`.
+                    def tasks_by_status
+                        @properties['tasks_by_status']
+                    end
+                    
+                    ##
+                    # @return [String] The total number of Tasks.
+                    def total_tasks
+                        @properties['total_tasks']
+                    end
+                    
+                    ##
+                    # @return [String] Returns the list of Tasks that are being controlled by the Workflow with the specified SID value.
+                    def workflow_sid
+                        @properties['workflow_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The SID of the Workspace that contains the Workflow.
+                    def workspace_sid
+                        @properties['workspace_sid']
+                    end
+                    
+                    ##
+                    # @return [String] The absolute URL of the Workflow statistics resource.
+                    def url
+                        @properties['url']
+                    end
+                    
+                    ##
+                    # Fetch the WorkflowRealTimeStatisticsInstance
+                    # @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(
+                        task_channel: :unset
+                    )
+
+                        context.fetch(
+                            task_channel: task_channel, 
+                        )
+                    end
+
+                    ##
+                    # Provide a user friendly representation
+                    def to_s
+                        values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Taskrouter.V1.WorkflowRealTimeStatisticsInstance #{values}>"
+                    end
+
+                    ##
+                    # Provide a detailed, user friendly representation
+                    def inspect
+                        values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                        "<Twilio.Taskrouter.V1.WorkflowRealTimeStatisticsInstance #{values}>"
+                    end
+                end
+
+             end
+             end
             end
-          end
         end
-      end
     end
-  end
-end
+end
+
+