twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,7 +15,8 @@ module Twilio
             ##
             # Initialize the TaskQueueList
             # @param [Version] version Version that contains the resource
-            # @param [String] workspace_sid The workspace_sid
+            # @param [String] workspace_sid The SID of the Workspace that contains the
+            #   TaskQueue.
             # @return [TaskQueueList] TaskQueueList
             def initialize(version, workspace_sid: nil)
               super(version)
@@ -30,9 +33,13 @@ module Twilio
             # Lists TaskQueueInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [String] friendly_name The friendly_name
-            # @param [String] evaluate_worker_attributes The evaluate_worker_attributes
-            # @param [String] worker_sid The worker_sid
+            # @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 [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
@@ -54,9 +61,13 @@ module Twilio
             # Streams TaskQueueInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] friendly_name The friendly_name
-            # @param [String] evaluate_worker_attributes The evaluate_worker_attributes
-            # @param [String] worker_sid The worker_sid
+            # @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 [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
@@ -84,7 +95,7 @@ module Twilio
             def each
               limits = @version.read_limits
 
-              page = self.page(page_size: limits[:page_size])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page,
                               limit: limits[:limit],
@@ -94,9 +105,13 @@ module Twilio
             ##
             # Retrieve a single page of TaskQueueInstance records from the API.
             # Request is executed immediately.
-            # @param [String] friendly_name The friendly_name
-            # @param [String] evaluate_worker_attributes The evaluate_worker_attributes
-            # @param [String] worker_sid The worker_sid
+            # @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] page_token PageToken provided by the API
             # @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
@@ -110,11 +125,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               TaskQueuePage.new(@version, response, @solution)
             end
 
@@ -132,32 +145,41 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of TaskQueueInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] friendly_name The friendly_name
-            # @param [String] reservation_activity_sid The reservation_activity_sid
-            # @param [String] assignment_activity_sid The assignment_activity_sid
-            # @param [String] target_workers The target_workers
-            # @param [String] max_reserved_workers The max_reserved_workers
-            # @param [task_queue.TaskOrder] task_order The task_order
-            # @return [TaskQueueInstance] Newly created TaskQueueInstance
-            def create(friendly_name: nil, reservation_activity_sid: nil, assignment_activity_sid: nil, target_workers: :unset, max_reserved_workers: :unset, task_order: :unset)
+            # Create the TaskQueueInstance
+            # @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 [task_queue.TaskOrder] task_order How Tasks will be assigned to Workers.
+            #   Set this parameter to `LIFO` to assign most recently created Task first or FIFO
+            #   to assign the oldest Task first. Default is `FIFO`. {Click
+            #   here}[https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo]
+            #   to learn more.
+            # @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(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,
-                  'ReservationActivitySid' => reservation_activity_sid,
-                  'AssignmentActivitySid' => assignment_activity_sid,
                   'TargetWorkers' => target_workers,
                   'MaxReservedWorkers' => max_reserved_workers,
                   'TaskOrder' => task_order,
+                  'ReservationActivitySid' => reservation_activity_sid,
+                  'AssignmentActivitySid' => assignment_activity_sid,
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
-              TaskQueueInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid])
+              TaskQueueInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
             end
 
             ##
@@ -165,7 +187,7 @@ module Twilio
             # @return [TaskQueuesStatisticsList]
             # @return [TaskQueuesStatisticsContext]
             def statistics
-              @statistics ||= TaskQueuesStatisticsList.new(@version, workspace_sid: @solution[:workspace_sid])
+              @statistics ||= TaskQueuesStatisticsList.new(@version, workspace_sid: @solution[:workspace_sid], )
             end
 
             ##
@@ -194,7 +216,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [TaskQueueInstance] TaskQueueInstance
             def get_instance(payload)
-              TaskQueueInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid])
+              TaskQueueInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
             end
 
             ##
@@ -208,14 +230,15 @@ module Twilio
             ##
             # Initialize the TaskQueueContext
             # @param [Version] version Version that contains the resource
-            # @param [String] workspace_sid The workspace_sid
-            # @param [String] sid The sid
+            # @param [String] workspace_sid The SID of the Workspace with the TaskQueue to
+            #   fetch.
+            # @param [String] sid The SID of the TaskQueue resource to fetch.
             # @return [TaskQueueContext] TaskQueueContext
             def initialize(version, workspace_sid, sid)
               super(version)
 
               # Path Solution
-              @solution = {workspace_sid: workspace_sid, sid: sid}
+              @solution = {workspace_sid: workspace_sid, sid: sid, }
               @uri = "/Workspaces/#{@solution[:workspace_sid]}/TaskQueues/#{@solution[:sid]}"
 
               # Dependents
@@ -225,16 +248,10 @@ module Twilio
             end
 
             ##
-            # Fetch a TaskQueueInstance
+            # Fetch the TaskQueueInstance
             # @return [TaskQueueInstance] Fetched TaskQueueInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               TaskQueueInstance.new(
                   @version,
@@ -246,12 +263,24 @@ module Twilio
 
             ##
             # Update the TaskQueueInstance
-            # @param [String] friendly_name The friendly_name
-            # @param [String] target_workers The target_workers
-            # @param [String] reservation_activity_sid The reservation_activity_sid
-            # @param [String] assignment_activity_sid The assignment_activity_sid
-            # @param [String] max_reserved_workers The max_reserved_workers
-            # @param [task_queue.TaskOrder] task_order The task_order
+            # @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 [task_queue.TaskOrder] task_order How Tasks will be assigned to Workers.
+            #   Can be: `FIFO` or `LIFO` and the default is `FIFO`. Use `FIFO` to assign the
+            #   oldest task first and `LIFO` to assign the most recent task first. For more
+            #   information, see {Queue
+            #   Ordering}[https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo].
             # @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)
               data = Twilio::Values.of({
@@ -263,11 +292,7 @@ module Twilio
                   'TaskOrder' => task_order,
               })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               TaskQueueInstance.new(
                   @version,
@@ -278,10 +303,10 @@ module Twilio
             end
 
             ##
-            # Deletes the TaskQueueInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the TaskQueueInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -289,7 +314,7 @@ module Twilio
             # @return [TaskQueueStatisticsList]
             # @return [TaskQueueStatisticsContext]
             def statistics
-              TaskQueueStatisticsContext.new(@version, @solution[:workspace_sid], @solution[:sid])
+              TaskQueueStatisticsContext.new(@version, @solution[:workspace_sid], @solution[:sid], )
             end
 
             ##
@@ -297,7 +322,7 @@ module Twilio
             # @return [TaskQueueRealTimeStatisticsList]
             # @return [TaskQueueRealTimeStatisticsContext]
             def real_time_statistics
-              TaskQueueRealTimeStatisticsContext.new(@version, @solution[:workspace_sid], @solution[:sid])
+              TaskQueueRealTimeStatisticsContext.new(@version, @solution[:workspace_sid], @solution[:sid], )
             end
 
             ##
@@ -305,7 +330,7 @@ module Twilio
             # @return [TaskQueueCumulativeStatisticsList]
             # @return [TaskQueueCumulativeStatisticsContext]
             def cumulative_statistics
-              TaskQueueCumulativeStatisticsContext.new(@version, @solution[:workspace_sid], @solution[:sid])
+              TaskQueueCumulativeStatisticsContext.new(@version, @solution[:workspace_sid], @solution[:sid], )
             end
 
             ##
@@ -314,6 +339,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Taskrouter.V1.TaskQueueContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Taskrouter.V1.TaskQueueContext #{context}>"
+            end
           end
 
           class TaskQueueInstance < InstanceResource
@@ -321,8 +353,9 @@ module Twilio
             # Initialize the TaskQueueInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] workspace_sid The workspace_sid
-            # @param [String] sid The sid
+            # @param [String] workspace_sid The SID of the Workspace that contains the
+            #   TaskQueue.
+            # @param [String] sid The SID of the TaskQueue resource to fetch.
             # @return [TaskQueueInstance] TaskQueueInstance
             def initialize(version, payload, workspace_sid: nil, sid: nil)
               super(version)
@@ -348,7 +381,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'workspace_sid' => workspace_sid, 'sid' => sid || @properties['sid']}
+              @params = {'workspace_sid' => workspace_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -357,103 +390,103 @@ module Twilio
             # @return [TaskQueueContext] TaskQueueContext for this TaskQueueInstance
             def context
               unless @instance_context
-                @instance_context = TaskQueueContext.new(@version, @params['workspace_sid'], @params['sid'])
+                @instance_context = TaskQueueContext.new(@version, @params['workspace_sid'], @params['sid'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The assignment_activity_sid
+            # @return [String] The SID of the Activity to assign Workers when a task is assigned for them
             def assignment_activity_sid
               @properties['assignment_activity_sid']
             end
 
             ##
-            # @return [String] The assignment_activity_name
+            # @return [String] The name of the Activity to assign Workers when a task is assigned for them
             def assignment_activity_name
               @properties['assignment_activity_name']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The max_reserved_workers
+            # @return [String] The maximum number of Workers to reserve
             def max_reserved_workers
               @properties['max_reserved_workers']
             end
 
             ##
-            # @return [String] The reservation_activity_sid
+            # @return [String] The SID of the Activity to assign Workers once a task is reserved for them
             def reservation_activity_sid
               @properties['reservation_activity_sid']
             end
 
             ##
-            # @return [String] The reservation_activity_name
+            # @return [String] The name of the Activity to assign Workers once a task is reserved for them
             def reservation_activity_name
               @properties['reservation_activity_name']
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The target_workers
+            # @return [String] A string describing the Worker selection criteria for any Tasks that enter the TaskQueue
             def target_workers
               @properties['target_workers']
             end
 
             ##
-            # @return [task_queue.TaskOrder] The task_order
+            # @return [task_queue.TaskOrder] How Tasks will be assigned to Workers
             def task_order
               @properties['task_order']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the TaskQueue resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] The workspace_sid
+            # @return [String] The SID of the Workspace that contains the TaskQueue
             def workspace_sid
               @properties['workspace_sid']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] The URLs of related resources
             def links
               @properties['links']
             end
 
             ##
-            # Fetch a TaskQueueInstance
+            # Fetch the TaskQueueInstance
             # @return [TaskQueueInstance] Fetched TaskQueueInstance
             def fetch
               context.fetch
@@ -461,12 +494,24 @@ module Twilio
 
             ##
             # Update the TaskQueueInstance
-            # @param [String] friendly_name The friendly_name
-            # @param [String] target_workers The target_workers
-            # @param [String] reservation_activity_sid The reservation_activity_sid
-            # @param [String] assignment_activity_sid The assignment_activity_sid
-            # @param [String] max_reserved_workers The max_reserved_workers
-            # @param [task_queue.TaskOrder] task_order The task_order
+            # @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 [task_queue.TaskOrder] task_order How Tasks will be assigned to Workers.
+            #   Can be: `FIFO` or `LIFO` and the default is `FIFO`. Use `FIFO` to assign the
+            #   oldest task first and `LIFO` to assign the most recent task first. For more
+            #   information, see {Queue
+            #   Ordering}[https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo].
             # @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)
               context.update(
@@ -480,8 +525,8 @@ module Twilio
             end
 
             ##
-            # Deletes the TaskQueueInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the TaskQueueInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end