twilio-ruby 6.8.0 → 7.10.7

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

@@ -20,16 +20,19 @@ module Twilio
                 class WorkspaceContext < InstanceContext
 
                      class TaskQueueList < ListResource
+                
                     ##
                     # Initialize the TaskQueueList
                     # @param [Version] version Version that contains the resource
                     # @return [TaskQueueList] TaskQueueList
                     def initialize(version, workspace_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid }
                         @uri = "/Workspaces/#{@solution[:workspace_sid]}/TaskQueues"
                         # Components
+                        @bulk_real_time_statistics = nil
                         @statistics = nil
                     end
                     ##
@@ -42,12 +45,12 @@ module Twilio
                     # @param [String] assignment_activity_sid The SID of the Activity to assign Workers when a task is assigned to them.
                     # @return [TaskQueueInstance] Created TaskQueueInstance
                     def create(
-                        friendly_name: nil, 
-                        target_workers: :unset, 
-                        max_reserved_workers: :unset, 
-                        task_order: :unset, 
-                        reservation_activity_sid: :unset, 
-                        assignment_activity_sid: :unset
+                      friendly_name: nil, 
+                      target_workers: :unset, 
+                      max_reserved_workers: :unset, 
+                      task_order: :unset, 
+                      reservation_activity_sid: :unset, 
+                      assignment_activity_sid: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -59,7 +62,13 @@ module Twilio
                             'AssignmentActivitySid' => assignment_activity_sid,
                         })
 
-                        payload = @version.create('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
                         TaskQueueInstance.new(
                             @version,
                             payload,
@@ -67,6 +76,53 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the TaskQueueInstanceMetadata
+                    # @param [String] friendly_name A descriptive string that you create to describe the TaskQueue. For example `Support-Tier 1`, `Sales`, or `Escalation`.
+                    # @param [String] target_workers A string that describes the Worker selection criteria for any Tasks that enter the TaskQueue. For example, `'\\\"language\\\" == \\\"spanish\\\"'`. The default value is `1==1`. If this value is empty, Tasks will wait in the TaskQueue until they are deleted or moved to another TaskQueue. For more information about Worker selection, see [Describing Worker selection criteria](https://www.twilio.com/docs/taskrouter/api/taskqueues#target-workers).
+                    # @param [String] max_reserved_workers The maximum number of Workers to reserve for the assignment of a Task in the queue. Can be an integer between 1 and 50, inclusive and defaults to 1.
+                    # @param [TaskOrder] task_order 
+                    # @param [String] reservation_activity_sid The SID of the Activity to assign Workers when a task is reserved for them.
+                    # @param [String] assignment_activity_sid The SID of the Activity to assign Workers when a task is assigned to them.
+                    # @return [TaskQueueInstance] Created TaskQueueInstance
+                    def create_with_metadata(
+                      friendly_name: nil, 
+                      target_workers: :unset, 
+                      max_reserved_workers: :unset, 
+                      task_order: :unset, 
+                      reservation_activity_sid: :unset, 
+                      assignment_activity_sid: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'TargetWorkers' => target_workers,
+                            'MaxReservedWorkers' => max_reserved_workers,
+                            'TaskOrder' => task_order,
+                            'ReservationActivitySid' => reservation_activity_sid,
+                            'AssignmentActivitySid' => assignment_activity_sid,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        task_queue_instance = TaskQueueInstance.new(
+                            @version,
+                            response.body,
+                            workspace_sid: @solution[:workspace_sid],
+                        )
+                        TaskQueueInstanceMetadata.new(
+                            @version,
+                            task_queue_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists TaskQueueInstance records from the API as a list.
@@ -119,7 +175,41 @@ module Twilio
                             ordering: ordering,
                             page_size: limits[:page_size], )
 
-                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    end
+
+                    ##
+                    # Lists TaskQueuePageMetadata records from the API as a list.
+                      # @param [String] friendly_name The `friendly_name` of the TaskQueue resources to read.
+                      # @param [String] evaluate_worker_attributes The attributes of the Workers to read. Returns the TaskQueues with Workers that match the attributes specified in this parameter.
+                      # @param [String] worker_sid The SID of the Worker with the TaskQueue resources to read.
+                      # @param [String] ordering Sorting parameter for TaskQueues
+                    # @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(friendly_name: :unset, evaluate_worker_attributes: :unset, worker_sid: :unset, ordering: :unset, limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'EvaluateWorkerAttributes' => evaluate_worker_attributes,
+                            'WorkerSid' => worker_sid,
+                            'Ordering' => ordering,
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        TaskQueuePageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -131,9 +221,13 @@ module Twilio
 
                         page = self.page(page_size: limits[:page_size], )
 
-                        @version.stream(page,
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
                             limit: limits[:limit],
-                            page_limit: limits[:page_limit]).each {|x| yield x}
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
                     end
 
                     ##
@@ -147,7 +241,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 TaskQueueInstance
-                    def page(friendly_name: :unset, evaluate_worker_attributes: :unset, worker_sid: :unset, ordering: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(friendly_name: :unset, evaluate_worker_attributes: :unset, worker_sid: :unset, ordering: :unset, page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'FriendlyName' => friendly_name,
                             'EvaluateWorkerAttributes' => evaluate_worker_attributes,
@@ -157,8 +251,11 @@ module Twilio
                             'Page' => page_number,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         TaskQueuePage.new(@version, response, @solution)
                     end
@@ -177,6 +274,13 @@ module Twilio
                     end
                     
 
+                ##
+                # Access the bulk_real_time_statistics
+                # @return [TaskQueueBulkRealTimeStatisticsList]
+                # @return [TaskQueueBulkRealTimeStatisticsContext]
+                def bulk_real_time_statistics
+                    @bulk_real_time_statistics ||= TaskQueueBulkRealTimeStatisticsList.new(@version, workspace_sid: @solution[:workspace_sid] )
+                end
                 ##
                 # Access the statistics
                 # @return [TaskQueuesStatisticsList]
@@ -201,6 +305,7 @@ module Twilio
                     # @return [TaskQueueContext] TaskQueueContext
                     def initialize(version, workspace_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { workspace_sid: workspace_sid, sid: sid,  }
@@ -216,7 +321,31 @@ module Twilio
                     # @return [Boolean] True if delete succeeds, false otherwise
                     def delete
 
-                        @version.delete('DELETE', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+
+                        @version.delete('DELETE', @uri, headers: headers)
+                    end
+
+                    ##
+                    # Delete the TaskQueueInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          taskQueue_instance = TaskQueueInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          TaskQueueInstanceMetadata.new(@version, taskQueue_instance, response.headers, response.status_code)
                     end
 
                     ##
@@ -224,7 +353,13 @@ module Twilio
                     # @return [TaskQueueInstance] Fetched TaskQueueInstance
                     def fetch
 
-                        payload = @version.fetch('GET', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
                         TaskQueueInstance.new(
                             @version,
                             payload,
@@ -233,6 +368,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the TaskQueueInstanceMetadata
+                    # @return [TaskQueueInstance] Fetched TaskQueueInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        task_queue_instance = TaskQueueInstance.new(
+                            @version,
+                            response.body,
+                            workspace_sid: @solution[:workspace_sid],
+                            sid: @solution[:sid],
+                        )
+                        TaskQueueInstanceMetadata.new(
+                            @version,
+                            task_queue_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the TaskQueueInstance
                     # @param [String] friendly_name A descriptive string that you create to describe the TaskQueue. For example `Support-Tier 1`, `Sales`, or `Escalation`.
@@ -243,12 +404,12 @@ module Twilio
                     # @param [TaskOrder] task_order 
                     # @return [TaskQueueInstance] Updated TaskQueueInstance
                     def update(
-                        friendly_name: :unset, 
-                        target_workers: :unset, 
-                        reservation_activity_sid: :unset, 
-                        assignment_activity_sid: :unset, 
-                        max_reserved_workers: :unset, 
-                        task_order: :unset
+                      friendly_name: :unset, 
+                      target_workers: :unset, 
+                      reservation_activity_sid: :unset, 
+                      assignment_activity_sid: :unset, 
+                      max_reserved_workers: :unset, 
+                      task_order: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -260,7 +421,13 @@ module Twilio
                             'TaskOrder' => task_order,
                         })
 
-                        payload = @version.update('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.update('POST', @uri, data: data, headers: headers)
                         TaskQueueInstance.new(
                             @version,
                             payload,
@@ -269,6 +436,54 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the TaskQueueInstanceMetadata
+                    # @param [String] friendly_name A descriptive string that you create to describe the TaskQueue. For example `Support-Tier 1`, `Sales`, or `Escalation`.
+                    # @param [String] target_workers A string describing the Worker selection criteria for any Tasks that enter the TaskQueue. For example '\\\"language\\\" == \\\"spanish\\\"' If no TargetWorkers parameter is provided, Tasks will wait in the queue until they are either deleted or moved to another queue. Additional examples on how to describing Worker selection criteria below.
+                    # @param [String] reservation_activity_sid The SID of the Activity to assign Workers when a task is reserved for them.
+                    # @param [String] assignment_activity_sid The SID of the Activity to assign Workers when a task is assigned for them.
+                    # @param [String] max_reserved_workers The maximum number of Workers to create reservations for the assignment of a task while in the queue. Maximum of 50.
+                    # @param [TaskOrder] task_order 
+                    # @return [TaskQueueInstance] Updated TaskQueueInstance
+                    def update_with_metadata(
+                      friendly_name: :unset, 
+                      target_workers: :unset, 
+                      reservation_activity_sid: :unset, 
+                      assignment_activity_sid: :unset, 
+                      max_reserved_workers: :unset, 
+                      task_order: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'TargetWorkers' => target_workers,
+                            'ReservationActivitySid' => reservation_activity_sid,
+                            'AssignmentActivitySid' => assignment_activity_sid,
+                            'MaxReservedWorkers' => max_reserved_workers,
+                            'TaskOrder' => task_order,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        task_queue_instance = TaskQueueInstance.new(
+                            @version,
+                            response.body,
+                            workspace_sid: @solution[:workspace_sid],
+                            sid: @solution[:sid],
+                        )
+                        TaskQueueInstanceMetadata.new(
+                            @version,
+                            task_queue_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the cumulative_statistics
                     # @return [TaskQueueCumulativeStatisticsList]
@@ -318,6 +533,53 @@ module Twilio
                     end
                 end
 
+                class TaskQueueInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new TaskQueueInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}TaskQueueInstance] task_queue_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 [TaskQueueInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, task_queue_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @task_queue_instance = task_queue_instance
+                    end
+
+                    def task_queue
+                        @task_queue_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.TaskQueueInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class TaskQueueListResponse < InstanceListResource
+                    # @param [Array<TaskQueueInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @task_queue_instance = payload.body[key].map do |data|
+                        TaskQueueInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def task_queue_instance
+                          @instance
+                      end
+                  end
+
                 class TaskQueuePage < Page
                     ##
                     # Initialize the TaskQueuePage
@@ -327,6 +589,7 @@ module Twilio
                     # @return [TaskQueuePage] TaskQueuePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -346,6 +609,66 @@ module Twilio
                         '<Twilio.Taskrouter.V1.TaskQueuePage>'
                     end
                 end
+
+                class TaskQueuePageMetadata < PageMetadata
+                    attr_reader :task_queue_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @task_queue_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @task_queue_page << TaskQueueListResponse.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_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Taskrouter::V1PageMetadata>';
+                    end
+                end
+                class TaskQueueListResponse < InstanceListResource
+
+                    # @param [Array<TaskQueueInstance>] 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 = data_list.map do |data|
+                        TaskQueueInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def task_queue
+                        @task_queue
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class TaskQueueInstance < InstanceResource
                     ##
                     # Initialize the TaskQueueInstance
@@ -359,6 +682,7 @@ module Twilio
                     def initialize(version, payload , workspace_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],
@@ -510,12 +834,12 @@ module Twilio
                     # @param [TaskOrder] task_order 
                     # @return [TaskQueueInstance] Updated TaskQueueInstance
                     def update(
-                        friendly_name: :unset, 
-                        target_workers: :unset, 
-                        reservation_activity_sid: :unset, 
-                        assignment_activity_sid: :unset, 
-                        max_reserved_workers: :unset, 
-                        task_order: :unset
+                      friendly_name: :unset, 
+                      target_workers: :unset, 
+                      reservation_activity_sid: :unset, 
+                      assignment_activity_sid: :unset, 
+                      max_reserved_workers: :unset, 
+                      task_order: :unset
                     )
 
                         context.update(