twilio-ruby 5.8.1 → 5.9.0

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -14,8 +16,9 @@ module Twilio
               ##
               # Initialize the ReservationList
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
-              # @param [String] task_sid The task_sid
+              # @param [String] workspace_sid The ID of the Workspace that this task is
+              #   contained within.
+              # @param [String] task_sid The ID of the reserved Task
               # @return [ReservationList] ReservationList
               def initialize(version, workspace_sid: nil, task_sid: nil)
                 super(version)
@@ -29,7 +32,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 Returns the list of reservations
+              #   for a task with a specified ReservationStatus
               # @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 +49,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 Returns the list of reservations
+              #   for a task with a specified ReservationStatus
               # @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 +83,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 Returns the list of reservations
+              #   for a task with a specified ReservationStatus
               # @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,32 +197,31 @@ 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 [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_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] redirect_call_sid The redirect_call_sid
-              # @param [Boolean] redirect_accept The redirect_accept
-              # @param [String] redirect_url The redirect_url
-              # @param [String] to The to
-              # @param [String] from The 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 No
+              # @param [String] dequeue_timeout No
+              # @param [String] dequeue_to No
+              # @param [String] dequeue_status_callback_url No
+              # @param [String] call_from Yes
+              # @param [String] call_record No
+              # @param [String] call_timeout No
+              # @param [String] call_to No
+              # @param [String] call_url Yes
+              # @param [String] call_status_callback_url No
+              # @param [Boolean] call_accept No
+              # @param [String] redirect_call_sid Yes
+              # @param [Boolean] redirect_accept No
+              # @param [String] redirect_url Yes
+              # @param [String] to No
+              # @param [String] from No
               # @param [String] status_callback The status_callback
               # @param [String] status_callback_method The status_callback_method
               # @param [reservation.CallStatus] status_callback_event The status_callback_event
-              # @param [String] timeout The timeout
+              # @param [String] timeout No
               # @param [Boolean] record The record
               # @param [Boolean] muted The muted
               # @param [String] beep The beep
@@ -244,8 +249,8 @@ module Twilio
               # @param [String] region The region
               # @param [String] sip_auth_username The sip_auth_username
               # @param [String] sip_auth_password The sip_auth_password
-              # @param [String] dequeue_status_callback_event The dequeue_status_callback_event
-              # @param [String] post_work_activity_sid The post_work_activity_sid
+              # @param [String] dequeue_status_callback_event No
+              # @param [String] post_work_activity_sid No
               # @return [ReservationInstance] Updated ReservationInstance
               def update(reservation_status: :unset, worker_activity_sid: :unset, instruction: :unset, dequeue_post_work_activity_sid: :unset, dequeue_from: :unset, dequeue_record: :unset, dequeue_timeout: :unset, dequeue_to: :unset, dequeue_status_callback_url: :unset, call_from: :unset, call_record: :unset, call_timeout: :unset, call_to: :unset, call_url: :unset, call_status_callback_url: :unset, call_accept: :unset, redirect_call_sid: :unset, redirect_accept: :unset, redirect_url: :unset, to: :unset, from: :unset, status_callback: :unset, status_callback_method: :unset, status_callback_event: :unset, timeout: :unset, record: :unset, muted: :unset, beep: :unset, start_conference_on_enter: :unset, end_conference_on_exit: :unset, wait_url: :unset, wait_method: :unset, early_media: :unset, max_participants: :unset, conference_status_callback: :unset, conference_status_callback_method: :unset, conference_status_callback_event: :unset, conference_record: :unset, conference_trim: :unset, recording_channels: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, conference_recording_status_callback: :unset, conference_recording_status_callback_method: :unset, region: :unset, sip_auth_username: :unset, sip_auth_password: :unset, dequeue_status_callback_event: :unset, post_work_activity_sid: :unset)
                 data = Twilio::Values.of({
@@ -328,8 +333,9 @@ module Twilio
               # Initialize the ReservationInstance
               # @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] task_sid The task_sid
+              # @param [String] workspace_sid The ID of the Workspace that this task is
+              #   contained within.
+              # @param [String] task_sid The ID of the reserved Task
               # @param [String] sid The sid
               # @return [ReservationInstance] ReservationInstance
               def initialize(version, payload, workspace_sid: nil, task_sid: nil, sid: nil)
@@ -376,7 +382,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The ID of the Account that owns this Task
               def account_sid
                 @properties['account_sid']
               end
@@ -394,37 +400,37 @@ module Twilio
               end
 
               ##
-              # @return [reservation.Status] The reservation_status
+              # @return [reservation.Status] The current status of the reservation.
               def reservation_status
                 @properties['reservation_status']
               end
 
               ##
-              # @return [String] The sid
+              # @return [String] The unique ID of this Reservation.
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The task_sid
+              # @return [String] The ID of the reserved Task
               def task_sid
                 @properties['task_sid']
               end
 
               ##
-              # @return [String] The worker_name
+              # @return [String] Human readable description of the Worker that is reserved
               def worker_name
                 @properties['worker_name']
               end
 
               ##
-              # @return [String] The worker_sid
+              # @return [String] The ID of the reserved Worker
               def worker_sid
                 @properties['worker_sid']
               end
 
               ##
-              # @return [String] The workspace_sid
+              # @return [String] The ID of the Workspace that this task is contained within.
               def workspace_sid
                 @properties['workspace_sid']
               end
@@ -450,32 +456,31 @@ 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 [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_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] redirect_call_sid The redirect_call_sid
-              # @param [Boolean] redirect_accept The redirect_accept
-              # @param [String] redirect_url The redirect_url
-              # @param [String] to The to
-              # @param [String] from The 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 No
+              # @param [String] dequeue_timeout No
+              # @param [String] dequeue_to No
+              # @param [String] dequeue_status_callback_url No
+              # @param [String] call_from Yes
+              # @param [String] call_record No
+              # @param [String] call_timeout No
+              # @param [String] call_to No
+              # @param [String] call_url Yes
+              # @param [String] call_status_callback_url No
+              # @param [Boolean] call_accept No
+              # @param [String] redirect_call_sid Yes
+              # @param [Boolean] redirect_accept No
+              # @param [String] redirect_url Yes
+              # @param [String] to No
+              # @param [String] from No
               # @param [String] status_callback The status_callback
               # @param [String] status_callback_method The status_callback_method
               # @param [reservation.CallStatus] status_callback_event The status_callback_event
-              # @param [String] timeout The timeout
+              # @param [String] timeout No
               # @param [Boolean] record The record
               # @param [Boolean] muted The muted
               # @param [String] beep The beep
@@ -503,8 +508,8 @@ module Twilio
               # @param [String] region The region
               # @param [String] sip_auth_username The sip_auth_username
               # @param [String] sip_auth_password The sip_auth_password
-              # @param [String] dequeue_status_callback_event The dequeue_status_callback_event
-              # @param [String] post_work_activity_sid The post_work_activity_sid
+              # @param [String] dequeue_status_callback_event No
+              # @param [String] post_work_activity_sid No
               # @return [ReservationInstance] Updated ReservationInstance
               def update(reservation_status: :unset, worker_activity_sid: :unset, instruction: :unset, dequeue_post_work_activity_sid: :unset, dequeue_from: :unset, dequeue_record: :unset, dequeue_timeout: :unset, dequeue_to: :unset, dequeue_status_callback_url: :unset, call_from: :unset, call_record: :unset, call_timeout: :unset, call_to: :unset, call_url: :unset, call_status_callback_url: :unset, call_accept: :unset, redirect_call_sid: :unset, redirect_accept: :unset, redirect_url: :unset, to: :unset, from: :unset, status_callback: :unset, status_callback_method: :unset, status_callback_event: :unset, timeout: :unset, record: :unset, muted: :unset, beep: :unset, start_conference_on_enter: :unset, end_conference_on_exit: :unset, wait_url: :unset, wait_method: :unset, early_media: :unset, max_participants: :unset, conference_status_callback: :unset, conference_status_callback_method: :unset, conference_status_callback_event: :unset, conference_record: :unset, conference_trim: :unset, recording_channels: :unset, recording_status_callback: :unset, recording_status_callback_method: :unset, conference_recording_status_callback: :unset, conference_recording_status_callback_method: :unset, region: :unset, sip_auth_username: :unset, sip_auth_password: :unset, dequeue_status_callback_event: :unset, post_work_activity_sid: :unset)
                 context.update(

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 ID of the Workspace that holds this Task
             # @return [TaskList] TaskList
             def initialize(version, workspace_sid: nil)
               super(version)
@@ -27,14 +29,28 @@ 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 [String] priority Retrieve the list of all Tasks in the workspace with
+            #   the specified priority.
+            # @param [String] assignment_status Returns the list of all Tasks in the workspace
+            #   with the specified AssignmentStatus. Allowed AssignmentStatus values are
+            #   pending, reserved, assigned, canceled, and completed.
+            # @param [String] workflow_sid Returns the list of Tasks that are being controlled
+            #   by the Workflow with the specified Sid value.
+            # @param [String] workflow_name Returns the list of Tasks that are being
+            #   controlled by the Workflow with the specified FriendlyName value.
+            # @param [String] task_queue_sid Returns the list of Tasks that are currently
+            #   waiting in the TaskQueue identified by the Sid specified.
+            # @param [String] task_queue_name Returns the list of Tasks that are currently
+            #   waiting in the TaskQueue identified by the FriendlyName specified.
+            # @param [String] evaluate_task_attributes Provide a task attributes expression,
+            #   and this will return tasks which match the attributes.
+            # @param [String] ordering Use this parameter to control the order of the Tasks
+            #   returned. The value should be passed in `Attribute:Order` format, where
+            #   Attribute can be either `Priority` or `DateCreated` and Order can be either
+            #   `asc` or `desc`. For example, `Priority:desc` returns Tasks ordered by Priority
+            #   in descending order. To sort the Tasks by Priority and DateCreated pass
+            #   `Priority:desc,DateCreated:asc`. By Default Tasks are returned sorted by
+            #   DateCreated in ascending order.
             # @param [Boolean] has_addons The has_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
@@ -63,14 +79,28 @@ 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 [String] priority Retrieve the list of all Tasks in the workspace with
+            #   the specified priority.
+            # @param [String] assignment_status Returns the list of all Tasks in the workspace
+            #   with the specified AssignmentStatus. Allowed AssignmentStatus values are
+            #   pending, reserved, assigned, canceled, and completed.
+            # @param [String] workflow_sid Returns the list of Tasks that are being controlled
+            #   by the Workflow with the specified Sid value.
+            # @param [String] workflow_name Returns the list of Tasks that are being
+            #   controlled by the Workflow with the specified FriendlyName value.
+            # @param [String] task_queue_sid Returns the list of Tasks that are currently
+            #   waiting in the TaskQueue identified by the Sid specified.
+            # @param [String] task_queue_name Returns the list of Tasks that are currently
+            #   waiting in the TaskQueue identified by the FriendlyName specified.
+            # @param [String] evaluate_task_attributes Provide a task attributes expression,
+            #   and this will return tasks which match the attributes.
+            # @param [String] ordering Use this parameter to control the order of the Tasks
+            #   returned. The value should be passed in `Attribute:Order` format, where
+            #   Attribute can be either `Priority` or `DateCreated` and Order can be either
+            #   `asc` or `desc`. For example, `Priority:desc` returns Tasks ordered by Priority
+            #   in descending order. To sort the Tasks by Priority and DateCreated pass
+            #   `Priority:desc,DateCreated:asc`. By Default Tasks are returned sorted by
+            #   DateCreated in ascending order.
             # @param [Boolean] has_addons The has_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.
@@ -115,14 +145,28 @@ 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 [String] priority Retrieve the list of all Tasks in the workspace with
+            #   the specified priority.
+            # @param [String] assignment_status Returns the list of all Tasks in the workspace
+            #   with the specified AssignmentStatus. Allowed AssignmentStatus values are
+            #   pending, reserved, assigned, canceled, and completed.
+            # @param [String] workflow_sid Returns the list of Tasks that are being controlled
+            #   by the Workflow with the specified Sid value.
+            # @param [String] workflow_name Returns the list of Tasks that are being
+            #   controlled by the Workflow with the specified FriendlyName value.
+            # @param [String] task_queue_sid Returns the list of Tasks that are currently
+            #   waiting in the TaskQueue identified by the Sid specified.
+            # @param [String] task_queue_name Returns the list of Tasks that are currently
+            #   waiting in the TaskQueue identified by the FriendlyName specified.
+            # @param [String] evaluate_task_attributes Provide a task attributes expression,
+            #   and this will return tasks which match the attributes.
+            # @param [String] ordering Use this parameter to control the order of the Tasks
+            #   returned. The value should be passed in `Attribute:Order` format, where
+            #   Attribute can be either `Priority` or `DateCreated` and Order can be either
+            #   `asc` or `desc`. For example, `Priority:desc` returns Tasks ordered by Priority
+            #   in descending order. To sort the Tasks by Priority and DateCreated pass
+            #   `Priority:desc,DateCreated:asc`. By Default Tasks are returned sorted by
+            #   DateCreated in ascending order.
             # @param [Boolean] has_addons The has_addons
             # @param [String] page_token PageToken provided by the API
             # @param [Integer] page_number Page Number, this value is simply for client state
@@ -167,11 +211,24 @@ 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 task is allowed to
+            #   live up to a maximum of 2 weeks. Defaults to 24 hours. On timeout,
+            #   `task.canceled` event will fire with description "Task TTL Exceeded".
+            # @param [String] priority Override priority for the Task. When supplied, the Task
+            #   will take on the given priority unless it matches a Workflow Target with a
+            #   Priority set. When not supplied, the Task will take on the priority of the
+            #   matching Workflow Target.
+            # @param [String] task_channel When MultiTasking is enabled specify the type of
+            #   the task by passing either TaskChannel Unique Name or Task Channel Sid. Default
+            #   value is "default"
+            # @param [String] workflow_sid The WorkflowSid for the Workflow that you would
+            #   like to handle routing for this Task. If there is only one Workflow defined for
+            #   the Workspace that you are posting a task to, then this is an optional
+            #   parameter, and that single workflow will be used.
+            # @param [String] attributes Url-encoded JSON string describing the attributes of
+            #   this task. This data will be passed back to the Workflow's AssignmentCallbackURL
+            #   when the Task is assigned to a Worker. An example task: `{ "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({
@@ -262,10 +319,18 @@ module Twilio
 
             ##
             # 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] attributes The user-defined JSON data describing the custom
+            #   attributes of this task.
+            # @param [task.Status] assignment_status A 'pending' or 'reserved' Task may be
+            #   canceled by posting AssignmentStatus='canceled'. Post
+            #   AssignmentStatus='wrapping' to move Task to 'wrapup' state and
+            #   AssignmentStatus='completed' to move a Task to 'completed' state.
+            # @param [String] reason This is only required if the Task is canceled or
+            #   completed. This logs the reason the task was either canceled or completed and
+            #   queues the task for deletion after 5 minutes.
+            # @param [String] priority Override priority for the Task. When supplied, the Task
+            #   will take on the given priority unless it matches a Workflow Target with a
+            #   Priority set.
             # @param [String] task_channel The task_channel
             # @return [TaskInstance] Updated TaskInstance
             def update(attributes: :unset, assignment_status: :unset, reason: :unset, priority: :unset, task_channel: :unset)
@@ -328,7 +393,7 @@ 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] workspace_sid The ID of the Workspace that holds this Task
             # @param [String] sid The sid
             # @return [TaskInstance] TaskInstance
             def initialize(version, payload, workspace_sid: nil, sid: nil)
@@ -375,67 +440,67 @@ module Twilio
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The ID of the account that owns this Task
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The age
+            # @return [String] The number of seconds since this task was created.
             def age
               @properties['age']
             end
 
             ##
-            # @return [task.Status] The assignment_status
+            # @return [task.Status] Returns the list of all Tasks in the workspace with the specified AssignmentStatus.
             def assignment_status
               @properties['assignment_status']
             end
 
             ##
-            # @return [String] The attributes
+            # @return [String] The user-defined JSON string describing the custom attributes of this work.
             def attributes
               @properties['attributes']
             end
 
             ##
-            # @return [String] The addons
+            # @return [String] The addon data for all installed addons is returned with this attribute
             def addons
               @properties['addons']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] Date this task was created, given as ISO 8601 format.
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] Date this task was updated, given as ISO 8601 format.
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The priority
+            # @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 ID of the Task
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The task_queue_sid
+            # @return [String] Returns the list of Tasks that are currently waiting in the TaskQueue identified by the Sid specified.
             def task_queue_sid
               @properties['task_queue_sid']
             end
@@ -447,25 +512,25 @@ module Twilio
             end
 
             ##
-            # @return [String] The task_channel_sid
+            # @return [String] The ID of the Task Channel
             def task_channel_sid
               @properties['task_channel_sid']
             end
 
             ##
-            # @return [String] The task_channel_unique_name
+            # @return [String] The unique name of the Task Channel
             def task_channel_unique_name
               @properties['task_channel_unique_name']
             end
 
             ##
-            # @return [String] The timeout
+            # @return [String] The amount of time in seconds the task is allowed to live
             def timeout
               @properties['timeout']
             end
 
             ##
-            # @return [String] The workflow_sid
+            # @return [String] Returns the list of Tasks that are being controlled by the Workflow with the specified Sid value.
             def workflow_sid
               @properties['workflow_sid']
             end
@@ -477,7 +542,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The workspace_sid
+            # @return [String] The ID of the Workspace that holds this Task
             def workspace_sid
               @properties['workspace_sid']
             end
@@ -503,10 +568,18 @@ module Twilio
 
             ##
             # 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] attributes The user-defined JSON data describing the custom
+            #   attributes of this task.
+            # @param [task.Status] assignment_status A 'pending' or 'reserved' Task may be
+            #   canceled by posting AssignmentStatus='canceled'. Post
+            #   AssignmentStatus='wrapping' to move Task to 'wrapup' state and
+            #   AssignmentStatus='completed' to move a Task to 'completed' state.
+            # @param [String] reason This is only required if the Task is canceled or
+            #   completed. This logs the reason the task was either canceled or completed and
+            #   queues the task for deletion after 5 minutes.
+            # @param [String] priority Override priority for the Task. When supplied, the Task
+            #   will take on the given priority unless it matches a Workflow Target with a
+            #   Priority set.
             # @param [String] task_channel The task_channel
             # @return [TaskInstance] Updated TaskInstance
             def update(attributes: :unset, assignment_status: :unset, reason: :unset, priority: :unset, task_channel: :unset)