twilio-ruby 5.6.0 → 5.33.0

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,7 +15,7 @@ module Twilio
             ##
             # Initialize the TaskList
             # @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 Task.
             # @return [TaskList] TaskList
             def initialize(version, workspace_sid: nil)
               super(version)
@@ -27,15 +29,33 @@ module Twilio
             # Lists TaskInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [String] priority The priority
-            # @param [String] assignment_status The assignment_status
-            # @param [String] workflow_sid The workflow_sid
-            # @param [String] workflow_name The workflow_name
-            # @param [String] task_queue_sid The task_queue_sid
-            # @param [String] task_queue_name The task_queue_name
-            # @param [String] evaluate_task_attributes The evaluate_task_attributes
-            # @param [String] ordering The ordering
-            # @param [Boolean] has_addons The has_addons
+            # @param [String] priority The priority value of the Tasks to read. Returns the
+            #   list of all Tasks in the Workspace with the specified priority.
+            # @param [String] assignment_status The `assignment_status` of the Tasks to read.
+            #   Can be: `pending`, `reserved`, `assigned`, `canceled`, and `completed`. Returns
+            #   all Tasks in the Workspace with the specified `assignment_status`.
+            # @param [String] workflow_sid The SID of the Workflow with the Tasks to read.
+            #   Returns the Tasks controlled by the Workflow identified by this SID.
+            # @param [String] workflow_name The friendly name of the Workflow with the Tasks
+            #   to read. Returns the Tasks controlled by the Workflow identified by this
+            #   friendly name.
+            # @param [String] task_queue_sid The SID of the TaskQueue with the Tasks to read.
+            #   Returns the Tasks waiting in the TaskQueue identified by this SID.
+            # @param [String] task_queue_name The `friendly_name` of the TaskQueue with the
+            #   Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this
+            #   friendly name.
+            # @param [String] evaluate_task_attributes The attributes of the Tasks to read.
+            #   Returns the Tasks that match the attributes specified in this parameter.
+            # @param [String] ordering How to order the returned Task resources. y default,
+            #   Tasks are sorted by ascending DateCreated. This value is specified as:
+            #   `Attribute:Order`, where `Attribute` can be either `Priority` or `DateCreated`
+            #   and `Order` can be either `asc` or `desc`. For example, `Priority:desc` returns
+            #   Tasks ordered in descending order of their Priority. Multiple sort orders can be
+            #   specified in a comma-separated list such as `Priority:desc,DateCreated:asc`,
+            #   which returns the Tasks in descending Priority order and ascending DateCreated
+            #   Order.
+            # @param [Boolean] has_addons Whether to read Tasks with addons. If `true`,
+            #   returns only Tasks with addons. If `false`, returns only Tasks without addons.
             # @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
@@ -63,15 +83,33 @@ module Twilio
             # Streams TaskInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] priority The priority
-            # @param [String] assignment_status The assignment_status
-            # @param [String] workflow_sid The workflow_sid
-            # @param [String] workflow_name The workflow_name
-            # @param [String] task_queue_sid The task_queue_sid
-            # @param [String] task_queue_name The task_queue_name
-            # @param [String] evaluate_task_attributes The evaluate_task_attributes
-            # @param [String] ordering The ordering
-            # @param [Boolean] has_addons The has_addons
+            # @param [String] priority The priority value of the Tasks to read. Returns the
+            #   list of all Tasks in the Workspace with the specified priority.
+            # @param [String] assignment_status The `assignment_status` of the Tasks to read.
+            #   Can be: `pending`, `reserved`, `assigned`, `canceled`, and `completed`. Returns
+            #   all Tasks in the Workspace with the specified `assignment_status`.
+            # @param [String] workflow_sid The SID of the Workflow with the Tasks to read.
+            #   Returns the Tasks controlled by the Workflow identified by this SID.
+            # @param [String] workflow_name The friendly name of the Workflow with the Tasks
+            #   to read. Returns the Tasks controlled by the Workflow identified by this
+            #   friendly name.
+            # @param [String] task_queue_sid The SID of the TaskQueue with the Tasks to read.
+            #   Returns the Tasks waiting in the TaskQueue identified by this SID.
+            # @param [String] task_queue_name The `friendly_name` of the TaskQueue with the
+            #   Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this
+            #   friendly name.
+            # @param [String] evaluate_task_attributes The attributes of the Tasks to read.
+            #   Returns the Tasks that match the attributes specified in this parameter.
+            # @param [String] ordering How to order the returned Task resources. y default,
+            #   Tasks are sorted by ascending DateCreated. This value is specified as:
+            #   `Attribute:Order`, where `Attribute` can be either `Priority` or `DateCreated`
+            #   and `Order` can be either `asc` or `desc`. For example, `Priority:desc` returns
+            #   Tasks ordered in descending order of their Priority. Multiple sort orders can be
+            #   specified in a comma-separated list such as `Priority:desc,DateCreated:asc`,
+            #   which returns the Tasks in descending Priority order and ascending DateCreated
+            #   Order.
+            # @param [Boolean] has_addons Whether to read Tasks with addons. If `true`,
+            #   returns only Tasks with addons. If `false`, returns only Tasks without addons.
             # @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
@@ -105,7 +143,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],
@@ -115,15 +153,33 @@ module Twilio
             ##
             # Retrieve a single page of TaskInstance records from the API.
             # Request is executed immediately.
-            # @param [String] priority The priority
-            # @param [String] assignment_status The assignment_status
-            # @param [String] workflow_sid The workflow_sid
-            # @param [String] workflow_name The workflow_name
-            # @param [String] task_queue_sid The task_queue_sid
-            # @param [String] task_queue_name The task_queue_name
-            # @param [String] evaluate_task_attributes The evaluate_task_attributes
-            # @param [String] ordering The ordering
-            # @param [Boolean] has_addons The has_addons
+            # @param [String] priority The priority value of the Tasks to read. Returns the
+            #   list of all Tasks in the Workspace with the specified priority.
+            # @param [String] assignment_status The `assignment_status` of the Tasks to read.
+            #   Can be: `pending`, `reserved`, `assigned`, `canceled`, and `completed`. Returns
+            #   all Tasks in the Workspace with the specified `assignment_status`.
+            # @param [String] workflow_sid The SID of the Workflow with the Tasks to read.
+            #   Returns the Tasks controlled by the Workflow identified by this SID.
+            # @param [String] workflow_name The friendly name of the Workflow with the Tasks
+            #   to read. Returns the Tasks controlled by the Workflow identified by this
+            #   friendly name.
+            # @param [String] task_queue_sid The SID of the TaskQueue with the Tasks to read.
+            #   Returns the Tasks waiting in the TaskQueue identified by this SID.
+            # @param [String] task_queue_name The `friendly_name` of the TaskQueue with the
+            #   Tasks to read. Returns the Tasks waiting in the TaskQueue identified by this
+            #   friendly name.
+            # @param [String] evaluate_task_attributes The attributes of the Tasks to read.
+            #   Returns the Tasks that match the attributes specified in this parameter.
+            # @param [String] ordering How to order the returned Task resources. y default,
+            #   Tasks are sorted by ascending DateCreated. This value is specified as:
+            #   `Attribute:Order`, where `Attribute` can be either `Priority` or `DateCreated`
+            #   and `Order` can be either `asc` or `desc`. For example, `Priority:desc` returns
+            #   Tasks ordered in descending order of their Priority. Multiple sort orders can be
+            #   specified in a comma-separated list such as `Priority:desc,DateCreated:asc`,
+            #   which returns the Tasks in descending Priority order and ascending DateCreated
+            #   Order.
+            # @param [Boolean] has_addons Whether to read Tasks with addons. If `true`,
+            #   returns only Tasks with addons. If `false`, returns only Tasks without addons.
             # @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
@@ -167,11 +223,25 @@ module Twilio
             ##
             # Retrieve a single page of TaskInstance records from the API.
             # Request is executed immediately.
-            # @param [String] timeout The timeout
-            # @param [String] priority The priority
-            # @param [String] task_channel The task_channel
-            # @param [String] workflow_sid The workflow_sid
-            # @param [String] attributes The attributes
+            # @param [String] timeout The amount of time in seconds the new task is allowed to
+            #   live. Can be up to a maximum of 2 weeks (1,209,600 seconds). The default value
+            #   is 24 hours (86,400 seconds). On timeout, the `task.canceled` event will fire
+            #   with description `Task TTL Exceeded`.
+            # @param [String] priority The priority to assign the new task and override the
+            #   default. When supplied, the new Task will have this priority unless it matches a
+            #   Workflow Target with a Priority set. When not supplied, the new Task will have
+            #   the priority of the matching Workflow Target. Value can be 0 to 2^31^
+            #   (2,147,483,647).
+            # @param [String] task_channel When MultiTasking is enabled, specify the
+            #   TaskChannel by passing either its `unique_name` or `sid`. Default value is
+            #   `default`.
+            # @param [String] workflow_sid The SID of the Workflow that you would like to
+            #   handle routing for the new Task. If there is only one Workflow defined for the
+            #   Workspace that you are posting the new task to, this parameter is optional.
+            # @param [String] attributes A URL-encoded JSON string with the attributes of the
+            #   new task. This value is passed to the Workflow's `assignment_callback_url` when
+            #   the Task is assigned to a Worker. For example: `{ "task_type": "call",
+            #   "twilio_call_sid": "CAxxx", "customer_ticket_number": "12345" }`.
             # @return [TaskInstance] Newly created TaskInstance
             def create(timeout: :unset, priority: :unset, task_channel: :unset, workflow_sid: :unset, attributes: :unset)
               data = Twilio::Values.of({
@@ -188,7 +258,7 @@ module Twilio
                   data: data
               )
 
-              TaskInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid])
+              TaskInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
             end
 
             ##
@@ -217,7 +287,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [TaskInstance] TaskInstance
             def get_instance(payload)
-              TaskInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid])
+              TaskInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
             end
 
             ##
@@ -231,14 +301,14 @@ module Twilio
             ##
             # Initialize the TaskContext
             # @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 Task to fetch.
+            # @param [String] sid The SID of the Task resource to fetch.
             # @return [TaskContext] TaskContext
             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]}/Tasks/#{@solution[:sid]}"
 
               # Dependents
@@ -257,16 +327,26 @@ module Twilio
                   params,
               )
 
-              TaskInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], sid: @solution[:sid])
+              TaskInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], sid: @solution[:sid], )
             end
 
             ##
             # Update the TaskInstance
-            # @param [String] attributes The attributes
-            # @param [task.Status] assignment_status The assignment_status
-            # @param [String] reason The reason
-            # @param [String] priority The priority
-            # @param [String] task_channel The task_channel
+            # @param [String] attributes The JSON string that describes the custom attributes
+            #   of the task.
+            # @param [task.Status] assignment_status The new status of the task. Can be:
+            #   `canceled`, to cancel a Task that is currently `pending` or `reserved`;
+            #   `wrapping`, to move the Task to wrapup state; or `completed`, to move a Task to
+            #   the completed state.
+            # @param [String] reason The reason that the Task was canceled or completed. This
+            #   parameter is required only if the Task is canceled or completed. Setting this
+            #   value queues the task for deletion and logs the reason.
+            # @param [String] priority The Task's new priority value. When supplied, the Task
+            #   takes on the specified priority unless it matches a Workflow Target with a
+            #   Priority set. Value can be 0 to 2^31^ (2,147,483,647).
+            # @param [String] task_channel When MultiTasking is enabled, specify the
+            #   TaskChannel with the task to update. Can be the TaskChannel's SID or its
+            #   `unique_name`, such as `voice`, `sms`, or `default`.
             # @return [TaskInstance] Updated TaskInstance
             def update(attributes: :unset, assignment_status: :unset, reason: :unset, priority: :unset, task_channel: :unset)
               data = Twilio::Values.of({
@@ -283,12 +363,12 @@ module Twilio
                   data: data,
               )
 
-              TaskInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], sid: @solution[:sid])
+              TaskInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], sid: @solution[:sid], )
             end
 
             ##
             # Deletes the TaskInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -301,7 +381,7 @@ module Twilio
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return ReservationContext.new(@version, @solution[:workspace_sid], @solution[:sid], sid)
+                return ReservationContext.new(@version, @solution[:workspace_sid], @solution[:sid], sid, )
               end
 
               unless @reservations
@@ -321,6 +401,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Taskrouter.V1.TaskContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Taskrouter.V1.TaskContext #{context}>"
+            end
           end
 
           class TaskInstance < InstanceResource
@@ -328,8 +415,8 @@ module Twilio
             # Initialize the TaskInstance
             # @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 Task.
+            # @param [String] sid The SID of the Task resource to fetch.
             # @return [TaskInstance] TaskInstance
             def initialize(version, payload, workspace_sid: nil, sid: nil)
               super(version)
@@ -343,6 +430,7 @@ module Twilio
                   'addons' => payload['addons'],
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
+                  'task_queue_entered_date' => Twilio.deserialize_iso8601_datetime(payload['task_queue_entered_date']),
                   'priority' => payload['priority'].to_i,
                   'reason' => payload['reason'],
                   'sid' => payload['sid'],
@@ -360,7 +448,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
 
             ##
@@ -369,127 +457,133 @@ module Twilio
             # @return [TaskContext] TaskContext for this TaskInstance
             def context
               unless @instance_context
-                @instance_context = TaskContext.new(@version, @params['workspace_sid'], @params['sid'])
+                @instance_context = TaskContext.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 age
+            # @return [String] The number of seconds since the Task was created
             def age
               @properties['age']
             end
 
             ##
-            # @return [reservation.Status] The assignment_status
+            # @return [task.Status] The current status of the Task's assignment
             def assignment_status
               @properties['assignment_status']
             end
 
             ##
-            # @return [String] The attributes
+            # @return [String] The JSON string with custom attributes of the work
             def attributes
               @properties['attributes']
             end
 
             ##
-            # @return [String] The addons
+            # @return [String] An object that contains the addon data for all installed addons
             def addons
               @properties['addons']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The ISO 8601 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 ISO 8601 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The priority
+            # @return [Time] The ISO 8601 date and time in GMT when the Task entered the TaskQueue.
+            def task_queue_entered_date
+              @properties['task_queue_entered_date']
+            end
+
+            ##
+            # @return [String] Retrieve the list of all Tasks in the Workspace with the specified priority
             def priority
               @properties['priority']
             end
 
             ##
-            # @return [String] The reason
+            # @return [String] The reason the Task was canceled or completed
             def reason
               @properties['reason']
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The task_queue_sid
+            # @return [String] The SID of the TaskQueue
             def task_queue_sid
               @properties['task_queue_sid']
             end
 
             ##
-            # @return [String] The task_queue_friendly_name
+            # @return [String] The friendly name of the TaskQueue
             def task_queue_friendly_name
               @properties['task_queue_friendly_name']
             end
 
             ##
-            # @return [String] The task_channel_sid
+            # @return [String] The SID 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 the TaskChannel
             def task_channel_unique_name
               @properties['task_channel_unique_name']
             end
 
             ##
-            # @return [String] The timeout
+            # @return [String] The amount of time in seconds that the Task is allowed to live
             def timeout
               @properties['timeout']
             end
 
             ##
-            # @return [String] The workflow_sid
+            # @return [String] The SID of the Workflow that is controlling the Task
             def workflow_sid
               @properties['workflow_sid']
             end
 
             ##
-            # @return [String] The workflow_friendly_name
+            # @return [String] The friendly name of the Workflow that is controlling the Task
             def workflow_friendly_name
               @properties['workflow_friendly_name']
             end
 
             ##
-            # @return [String] The workspace_sid
+            # @return [String] The SID of the Workspace that contains the Task
             def workspace_sid
               @properties['workspace_sid']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the Task resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] The URLs of related resources
             def links
               @properties['links']
             end
@@ -503,11 +597,21 @@ module Twilio
 
             ##
             # Update the TaskInstance
-            # @param [String] attributes The attributes
-            # @param [reservation.Status] assignment_status The assignment_status
-            # @param [String] reason The reason
-            # @param [String] priority The priority
-            # @param [String] task_channel The task_channel
+            # @param [String] attributes The JSON string that describes the custom attributes
+            #   of the task.
+            # @param [task.Status] assignment_status The new status of the task. Can be:
+            #   `canceled`, to cancel a Task that is currently `pending` or `reserved`;
+            #   `wrapping`, to move the Task to wrapup state; or `completed`, to move a Task to
+            #   the completed state.
+            # @param [String] reason The reason that the Task was canceled or completed. This
+            #   parameter is required only if the Task is canceled or completed. Setting this
+            #   value queues the task for deletion and logs the reason.
+            # @param [String] priority The Task's new priority value. When supplied, the Task
+            #   takes on the specified priority unless it matches a Workflow Target with a
+            #   Priority set. Value can be 0 to 2^31^ (2,147,483,647).
+            # @param [String] task_channel When MultiTasking is enabled, specify the
+            #   TaskChannel with the task to update. Can be the TaskChannel's SID or its
+            #   `unique_name`, such as `voice`, `sms`, or `default`.
             # @return [TaskInstance] Updated TaskInstance
             def update(attributes: :unset, assignment_status: :unset, reason: :unset, priority: :unset, task_channel: :unset)
               context.update(
@@ -521,7 +625,7 @@ module Twilio
 
             ##
             # Deletes the TaskInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end