twilio-ruby 5.8.1 → 5.9.0

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,7 @@ 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 ID of the Workspace that owns this TaskQueue
             # @return [TaskQueueList] TaskQueueList
             def initialize(version, workspace_sid: nil)
               super(version)
@@ -30,8 +32,11 @@ 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] friendly_name Filter by a human readable description of a
+            #   TaskQueue (for example "Customer Support" or "2014 Election Campaign")
+            # @param [String] evaluate_worker_attributes Provide a Worker attributes
+            #   expression, and this will return the list of TaskQueues that would distribute
+            #   tasks to a worker with these attributes.
             # @param [String] worker_sid The worker_sid
             # @param [Integer] limit Upper limit for the number of records to return. stream()
             #    guarantees to never return more than limit.  Default is no limit
@@ -54,8 +59,11 @@ 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] friendly_name Filter by a human readable description of a
+            #   TaskQueue (for example "Customer Support" or "2014 Election Campaign")
+            # @param [String] evaluate_worker_attributes Provide a Worker attributes
+            #   expression, and this will return the list of TaskQueues that would distribute
+            #   tasks to a worker with these attributes.
             # @param [String] worker_sid The worker_sid
             # @param [Integer] limit Upper limit for the number of records to return. stream()
             #    guarantees to never return more than limit. Default is no limit.
@@ -94,8 +102,11 @@ 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] friendly_name Filter by a human readable description of a
+            #   TaskQueue (for example "Customer Support" or "2014 Election Campaign")
+            # @param [String] evaluate_worker_attributes Provide a Worker attributes
+            #   expression, and this will return the list of TaskQueues that would distribute
+            #   tasks to a worker with these attributes.
             # @param [String] worker_sid The worker_sid
             # @param [String] page_token PageToken provided by the API
             # @param [Integer] page_number Page Number, this value is simply for client state
@@ -134,12 +145,25 @@ 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] 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
+            # @param [String] friendly_name Human readable description of this TaskQueue (for
+            #   example "Support – Tier 1", "Sales" or "Escalation")
+            # @param [String] reservation_activity_sid ActivitySID to assign workers once a
+            #   task is reserved for them
+            # @param [String] assignment_activity_sid ActivitySID to assign workers once a
+            #   task is assigned for them
+            # @param [String] target_workers A string describing the Worker selection criteria
+            #   for any Tasks that enter this TaskQueue. For example `'"language" == "spanish"'`
+            #   If no TargetWorkers parameter is provided, Tasks will wait in this TaskQueue
+            #   until they are either deleted or moved to another TaskQueue. Additional examples
+            #   on how to describing Worker selection criteria below. Defaults to 1==1.
+            # @param [String] max_reserved_workers The maximum amount of workers to create
+            #   reservations for the assignment of a task while in this queue. Defaults to 1,
+            #   with a Maximum of 50.
+            # @param [task_queue.TaskOrder] task_order TaskOrder will determine which order
+            #   the 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. Default is FIFO.
+            #   [Click here](https://www.twilio.com/docs/api/taskrouter/last-first-out-lifo) to
+            #   learn more.
             # @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)
               data = Twilio::Values.of({
@@ -246,12 +270,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 Human readable description of this 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 this TaskQueue. For example '"language" == "spanish"'
+            #   If no TargetWorkers parameter is provided, Tasks will wait in this 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 ActivitySID that will be assigned to
+            #   Workers when they are reserved for a task from this TaskQueue.
+            # @param [String] assignment_activity_sid ActivitySID that will be assigned to
+            #   Workers when they are assigned a task from this TaskQueue.
+            # @param [String] max_reserved_workers The maximum amount of workers to create
+            #   reservations for the assignment of a task while in this queue. Maximum of 50.
+            # @param [task_queue.TaskOrder] task_order TaskOrder will determine which order
+            #   the 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. Default is FIFO.
+            #   [Click here](https://www.twilio.com/docs/api/taskrouter/last-first-out-lifo) to
+            #   learn more.
             # @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({
@@ -321,7 +357,7 @@ 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] workspace_sid The ID of the Workspace that owns this TaskQueue
             # @param [String] sid The sid
             # @return [TaskQueueInstance] TaskQueueInstance
             def initialize(version, payload, workspace_sid: nil, sid: nil)
@@ -363,13 +399,13 @@ module Twilio
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The ID of the Account that owns this TaskQueue
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The assignment_activity_sid
+            # @return [String] ActivitySID to assign workers once a task is assigned for them
             def assignment_activity_sid
               @properties['assignment_activity_sid']
             end
@@ -393,19 +429,19 @@ module Twilio
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] Filter by a human readable description of a TaskQueue
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The max_reserved_workers
+            # @return [String] The maximum amount of workers to create reservations for the assignment of a task while in this queue.
             def max_reserved_workers
               @properties['max_reserved_workers']
             end
 
             ##
-            # @return [String] The reservation_activity_sid
+            # @return [String] ActivitySID to assign workers once a task is reserved for them
             def reservation_activity_sid
               @properties['reservation_activity_sid']
             end
@@ -417,19 +453,19 @@ module Twilio
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique ID of the TaskQueue
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The target_workers
+            # @return [String] A string describing the Worker selection criteria for any Tasks that enter this TaskQueue.
             def target_workers
               @properties['target_workers']
             end
 
             ##
-            # @return [task_queue.TaskOrder] The task_order
+            # @return [task_queue.TaskOrder] TaskOrder will determine which order the Tasks will be assigned to Workers.
             def task_order
               @properties['task_order']
             end
@@ -441,7 +477,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The workspace_sid
+            # @return [String] The ID of the Workspace that owns this TaskQueue
             def workspace_sid
               @properties['workspace_sid']
             end
@@ -461,12 +497,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 Human readable description of this 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 this TaskQueue. For example '"language" == "spanish"'
+            #   If no TargetWorkers parameter is provided, Tasks will wait in this 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 ActivitySID that will be assigned to
+            #   Workers when they are reserved for a task from this TaskQueue.
+            # @param [String] assignment_activity_sid ActivitySID that will be assigned to
+            #   Workers when they are assigned a task from this TaskQueue.
+            # @param [String] max_reserved_workers The maximum amount of workers to create
+            #   reservations for the assignment of a task while in this queue. Maximum of 50.
+            # @param [task_queue.TaskOrder] task_order TaskOrder will determine which order
+            #   the 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. Default is FIFO.
+            #   [Click here](https://www.twilio.com/docs/api/taskrouter/last-first-out-lifo) to
+            #   learn more.
             # @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(

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -29,7 +31,8 @@ module Twilio
               # Lists ReservationInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [reservation.Status] reservation_status The reservation_status
+              # @param [reservation.Status] reservation_status Filter by a worker’s reservation
+              #   status (pending, accepted, rejected, timeout, canceled, rescinded)
               # @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
@@ -45,7 +48,8 @@ module Twilio
               # Streams ReservationInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [reservation.Status] reservation_status The reservation_status
+              # @param [reservation.Status] reservation_status Filter by a worker’s reservation
+              #   status (pending, accepted, rejected, timeout, canceled, rescinded)
               # @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
@@ -78,7 +82,8 @@ module Twilio
               ##
               # Retrieve a single page of ReservationInstance records from the API.
               # Request is executed immediately.
-              # @param [reservation.Status] reservation_status The reservation_status
+              # @param [reservation.Status] reservation_status Filter by a worker’s reservation
+              #   status (pending, accepted, rejected, timeout, canceled, rescinded)
               # @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
@@ -191,23 +196,22 @@ module Twilio
 
               ##
               # Update the ReservationInstance
-              # @param [reservation.Status] reservation_status The reservation_status
-              # @param [String] worker_activity_sid The worker_activity_sid
-              # @param [String] instruction The instruction
-              # @param [String] dequeue_post_work_activity_sid The
-              #   dequeue_post_work_activity_sid
-              # @param [String] dequeue_from The dequeue_from
+              # @param [reservation.Status] reservation_status Yes
+              # @param [String] worker_activity_sid No
+              # @param [String] instruction Yes
+              # @param [String] dequeue_post_work_activity_sid No
+              # @param [String] dequeue_from Yes
               # @param [String] dequeue_record The dequeue_record
               # @param [String] dequeue_timeout The dequeue_timeout
               # @param [String] dequeue_to The dequeue_to
               # @param [String] dequeue_status_callback_url The dequeue_status_callback_url
-              # @param [String] call_from The call_from
+              # @param [String] call_from Yes
               # @param [String] call_record The call_record
               # @param [String] call_timeout The call_timeout
               # @param [String] call_to The call_to
-              # @param [String] call_url The call_url
-              # @param [String] call_status_callback_url The call_status_callback_url
-              # @param [Boolean] call_accept The call_accept
+              # @param [String] call_url Yes
+              # @param [String] call_status_callback_url No
+              # @param [Boolean] call_accept No
               # @param [String] redirect_call_sid The redirect_call_sid
               # @param [Boolean] redirect_accept The redirect_accept
               # @param [String] redirect_url The redirect_url
@@ -394,7 +398,7 @@ module Twilio
               end
 
               ##
-              # @return [reservation.Status] The reservation_status
+              # @return [reservation.Status] Filter by a worker’s reservation status
               def reservation_status
                 @properties['reservation_status']
               end
@@ -450,23 +454,22 @@ module Twilio
 
               ##
               # Update the ReservationInstance
-              # @param [reservation.Status] reservation_status The reservation_status
-              # @param [String] worker_activity_sid The worker_activity_sid
-              # @param [String] instruction The instruction
-              # @param [String] dequeue_post_work_activity_sid The
-              #   dequeue_post_work_activity_sid
-              # @param [String] dequeue_from The dequeue_from
+              # @param [reservation.Status] reservation_status Yes
+              # @param [String] worker_activity_sid No
+              # @param [String] instruction Yes
+              # @param [String] dequeue_post_work_activity_sid No
+              # @param [String] dequeue_from Yes
               # @param [String] dequeue_record The dequeue_record
               # @param [String] dequeue_timeout The dequeue_timeout
               # @param [String] dequeue_to The dequeue_to
               # @param [String] dequeue_status_callback_url The dequeue_status_callback_url
-              # @param [String] call_from The call_from
+              # @param [String] call_from Yes
               # @param [String] call_record The call_record
               # @param [String] call_timeout The call_timeout
               # @param [String] call_to The call_to
-              # @param [String] call_url The call_url
-              # @param [String] call_status_callback_url The call_status_callback_url
-              # @param [Boolean] call_accept The call_accept
+              # @param [String] call_url Yes
+              # @param [String] call_status_callback_url No
+              # @param [Boolean] call_accept No
               # @param [String] redirect_call_sid The redirect_call_sid
               # @param [Boolean] redirect_accept The redirect_accept
               # @param [String] redirect_url The redirect_url

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -14,8 +16,10 @@ module Twilio
               ##
               # Initialize the WorkerChannelList
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
-              # @param [String] worker_sid The worker_sid
+              # @param [String] workspace_sid The unique ID of the Workspace that this
+              #   WorkerChannel belongs to.
+              # @param [String] worker_sid The unique ID of the Worker that this WorkerChannel
+              #   belongs to.
               # @return [WorkerChannelList] WorkerChannelList
               def initialize(version, workspace_sid: nil, worker_sid: nil)
                 super(version)
@@ -187,8 +191,13 @@ module Twilio
 
               ##
               # Update the WorkerChannelInstance
-              # @param [String] capacity The capacity
-              # @param [Boolean] available The available
+              # @param [String] capacity The total number of Tasks worker should handle for this
+              #   TaskChannel type. TaskRouter will only create reservations for Tasks of this
+              #   TaskChannel type up to the capacity configured. If the capacity is 0, no new
+              #   reservations will be created
+              # @param [Boolean] available Toggle the availability of the WorkerChannel. Set
+              #   this to 'False' to make worker unavailable to receive any new Tasks of this
+              #   TaskChannel type.
               # @return [WorkerChannelInstance] Updated WorkerChannelInstance
               def update(capacity: :unset, available: :unset)
                 data = Twilio::Values.of({'Capacity' => capacity, 'Available' => available, })
@@ -221,8 +230,10 @@ module Twilio
               # Initialize the WorkerChannelInstance
               # @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] worker_sid The worker_sid
+              # @param [String] workspace_sid The unique ID of the Workspace that this
+              #   WorkerChannel belongs to.
+              # @param [String] worker_sid The unique ID of the Worker that this WorkerChannel
+              #   belongs to.
               # @param [String] sid The sid
               # @return [WorkerChannelInstance] WorkerChannelInstance
               def initialize(version, payload, workspace_sid: nil, worker_sid: nil, sid: nil)
@@ -271,73 +282,73 @@ module Twilio
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The unique ID of the Account that owns this WorkerChannel.
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The assigned_tasks
+              # @return [String] The total number of tasks assigned to Worker for this TaskChannel type.
               def assigned_tasks
                 @properties['assigned_tasks']
               end
 
               ##
-              # @return [Boolean] The available
+              # @return [Boolean] Boolean value indicating whether the worker should receive Tasks of this TaskChannel type.
               def available
                 @properties['available']
               end
 
               ##
-              # @return [String] The available_capacity_percentage
+              # @return [String] The current available capacity between 0 to 100 for this TaskChannel.
               def available_capacity_percentage
                 @properties['available_capacity_percentage']
               end
 
               ##
-              # @return [String] The configured_capacity
+              # @return [String] The current configured capacity for the WorkerChannel.
               def configured_capacity
                 @properties['configured_capacity']
               end
 
               ##
-              # @return [Time] The date_created
+              # @return [Time] The date this Activity was created.
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date_updated
+              # @return [Time] The date this Activity was updated.
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [String] The sid
+              # @return [String] The unique ID for this WorkerChannel.
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The task_channel_sid
+              # @return [String] The unique ID of the TaskChannel.
               def task_channel_sid
                 @properties['task_channel_sid']
               end
 
               ##
-              # @return [String] The task_channel_unique_name
+              # @return [String] The unique name of TaskChannel, such as 'voice', 'sms', etc.
               def task_channel_unique_name
                 @properties['task_channel_unique_name']
               end
 
               ##
-              # @return [String] The worker_sid
+              # @return [String] The unique ID of the Worker that this WorkerChannel belongs to.
               def worker_sid
                 @properties['worker_sid']
               end
 
               ##
-              # @return [String] The workspace_sid
+              # @return [String] The unique ID of the Workspace that this WorkerChannel belongs to.
               def workspace_sid
                 @properties['workspace_sid']
               end
@@ -357,8 +368,13 @@ module Twilio
 
               ##
               # Update the WorkerChannelInstance
-              # @param [String] capacity The capacity
-              # @param [Boolean] available The available
+              # @param [String] capacity The total number of Tasks worker should handle for this
+              #   TaskChannel type. TaskRouter will only create reservations for Tasks of this
+              #   TaskChannel type up to the capacity configured. If the capacity is 0, no new
+              #   reservations will be created
+              # @param [Boolean] available Toggle the availability of the WorkerChannel. Set
+              #   this to 'False' to make worker unavailable to receive any new Tasks of this
+              #   TaskChannel type.
               # @return [WorkerChannelInstance] Updated WorkerChannelInstance
               def update(capacity: :unset, available: :unset)
                 context.update(capacity: capacity, available: available, )