twilio-ruby 5.31.1 → 5.54.0

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

@@ -112,11 +112,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               ActivityPage.new(@version, response, @solution)
             end
 
@@ -134,8 +132,7 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of ActivityInstance records from the API.
-            # Request is executed immediately.
+            # Create the ActivityInstance
             # @param [String] friendly_name A descriptive string that you create to describe
             #   the Activity resource. It can be up to 64 characters long. These names are used
             #   to calculate and expose statistics about Workers, and provide visibility into
@@ -143,16 +140,13 @@ module Twilio
             #   `break`, and `email`.
             # @param [Boolean] available Whether the Worker should be eligible to receive a
             #   Task when it occupies the Activity. A value of `true`, `1`, or `yes` specifies
-            #   the Activity is available. All other values specify that it is not.
-            # @return [ActivityInstance] Newly created ActivityInstance
+            #   the Activity is available. All other values specify that it is not. The value
+            #   cannot be changed after the Activity is created.
+            # @return [ActivityInstance] Created ActivityInstance
             def create(friendly_name: nil, available: :unset)
               data = Twilio::Values.of({'FriendlyName' => friendly_name, 'Available' => available, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               ActivityInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
             end
@@ -210,16 +204,10 @@ module Twilio
             end
 
             ##
-            # Fetch a ActivityInstance
+            # Fetch the ActivityInstance
             # @return [ActivityInstance] Fetched ActivityInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               ActivityInstance.new(
                   @version,
@@ -240,11 +228,7 @@ module Twilio
             def update(friendly_name: :unset)
               data = Twilio::Values.of({'FriendlyName' => friendly_name, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               ActivityInstance.new(
                   @version,
@@ -255,10 +239,10 @@ module Twilio
             end
 
             ##
-            # Deletes the ActivityInstance
+            # Delete the ActivityInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -365,7 +349,7 @@ module Twilio
             end
 
             ##
-            # Fetch a ActivityInstance
+            # Fetch the ActivityInstance
             # @return [ActivityInstance] Fetched ActivityInstance
             def fetch
               context.fetch
@@ -384,7 +368,7 @@ module Twilio
             end
 
             ##
-            # Deletes the ActivityInstance
+            # Delete the ActivityInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete

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

@@ -30,17 +30,19 @@ module Twilio
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
             # @param [Time] end_date Only include Events that occurred on or before this date,
-            #   specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+            #   specified in GMT as an {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601]
             #   date-time.
             # @param [String] event_type The type of Events to read. Returns only Events of
             #   the type specified.
             # @param [String] minutes The period of events to read in minutes. Returns only
             #   Events that occurred since this many minutes in the past. The default is `15`
-            #   minutes.
+            #   minutes. Task Attributes for Events occuring more 43,200 minutes ago will be
+            #   redacted.
             # @param [String] reservation_sid The SID of the Reservation with the Events to
             #   read. Returns only Events that pertain to the specified Reservation.
             # @param [Time] start_date Only include Events from on or after this date and
-            #   time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+            #   time, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format.
+            #   Task Attributes for Events older than 30 days will be redacted.
             # @param [String] task_queue_sid The SID of the TaskQueue with the Events to read.
             #   Returns only the Events that pertain to the specified TaskQueue.
             # @param [String] task_sid The SID of the Task with the Events to read. Returns
@@ -82,17 +84,19 @@ module Twilio
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
             # @param [Time] end_date Only include Events that occurred on or before this date,
-            #   specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+            #   specified in GMT as an {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601]
             #   date-time.
             # @param [String] event_type The type of Events to read. Returns only Events of
             #   the type specified.
             # @param [String] minutes The period of events to read in minutes. Returns only
             #   Events that occurred since this many minutes in the past. The default is `15`
-            #   minutes.
+            #   minutes. Task Attributes for Events occuring more 43,200 minutes ago will be
+            #   redacted.
             # @param [String] reservation_sid The SID of the Reservation with the Events to
             #   read. Returns only Events that pertain to the specified Reservation.
             # @param [Time] start_date Only include Events from on or after this date and
-            #   time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+            #   time, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format.
+            #   Task Attributes for Events older than 30 days will be redacted.
             # @param [String] task_queue_sid The SID of the TaskQueue with the Events to read.
             #   Returns only the Events that pertain to the specified TaskQueue.
             # @param [String] task_sid The SID of the Task with the Events to read. Returns
@@ -150,17 +154,19 @@ module Twilio
             # Retrieve a single page of EventInstance records from the API.
             # Request is executed immediately.
             # @param [Time] end_date Only include Events that occurred on or before this date,
-            #   specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+            #   specified in GMT as an {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601]
             #   date-time.
             # @param [String] event_type The type of Events to read. Returns only Events of
             #   the type specified.
             # @param [String] minutes The period of events to read in minutes. Returns only
             #   Events that occurred since this many minutes in the past. The default is `15`
-            #   minutes.
+            #   minutes. Task Attributes for Events occuring more 43,200 minutes ago will be
+            #   redacted.
             # @param [String] reservation_sid The SID of the Reservation with the Events to
             #   read. Returns only Events that pertain to the specified Reservation.
             # @param [Time] start_date Only include Events from on or after this date and
-            #   time, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+            #   time, specified in {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601] format.
+            #   Task Attributes for Events older than 30 days will be redacted.
             # @param [String] task_queue_sid The SID of the TaskQueue with the Events to read.
             #   Returns only the Events that pertain to the specified TaskQueue.
             # @param [String] task_sid The SID of the Task with the Events to read. Returns
@@ -193,11 +199,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               EventPage.new(@version, response, @solution)
             end
 
@@ -266,16 +270,10 @@ module Twilio
             end
 
             ##
-            # Fetch a EventInstance
+            # Fetch the EventInstance
             # @return [EventInstance] Fetched EventInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               EventInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], sid: @solution[:sid], )
             end
@@ -446,7 +444,7 @@ module Twilio
             end
 
             ##
-            # Fetch a EventInstance
+            # Fetch the EventInstance
             # @return [EventInstance] Fetched EventInstance
             def fetch
               context.fetch

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

@@ -31,9 +31,10 @@ module Twilio
             # memory before returning.
             # @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 [Array[String]] assignment_status The `assignment_status` of the Tasks
+            #   you want to read. Can be: `pending`, `reserved`, `assigned`, `canceled`,
+            #   `wrapping`, or `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
@@ -85,9 +86,10 @@ module Twilio
             # is reached.
             # @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 [Array[String]] assignment_status The `assignment_status` of the Tasks
+            #   you want to read. Can be: `pending`, `reserved`, `assigned`, `canceled`,
+            #   `wrapping`, or `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
@@ -155,9 +157,10 @@ module Twilio
             # Request is executed immediately.
             # @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 [Array[String]] assignment_status The `assignment_status` of the Tasks
+            #   you want to read. Can be: `pending`, `reserved`, `assigned`, `canceled`,
+            #   `wrapping`, or `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
@@ -199,11 +202,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               TaskPage.new(@version, response, @solution)
             end
 
@@ -221,16 +222,16 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of TaskInstance records from the API.
-            # Request is executed immediately.
-            # @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`.
+            # Create the TaskInstance
+            # @param [String] timeout The amount of time in seconds the new task can live
+            #   before being assigned. 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.
+            #   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`.
@@ -241,7 +242,7 @@ module Twilio
             #   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
+            # @return [TaskInstance] Created TaskInstance
             def create(timeout: :unset, priority: :unset, task_channel: :unset, workflow_sid: :unset, attributes: :unset)
               data = Twilio::Values.of({
                   'Timeout' => timeout,
@@ -251,11 +252,7 @@ module Twilio
                   'Attributes' => attributes,
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               TaskInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
             end
@@ -315,16 +312,10 @@ module Twilio
             end
 
             ##
-            # Fetch a TaskInstance
+            # Fetch the TaskInstance
             # @return [TaskInstance] Fetched TaskInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               TaskInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], sid: @solution[:sid], )
             end
@@ -342,12 +333,17 @@ module Twilio
             #   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.
+            #   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`.
+            # @param [String] if_match If provided, applies this mutation if (and only if) the
+            #   {ETag}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag] header of
+            #   the Task matches the provided value. This matches the semantics of (and is
+            #   implemented with) the HTTP {If-Match
+            #   header}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match].
             # @return [TaskInstance] Updated TaskInstance
-            def update(attributes: :unset, assignment_status: :unset, reason: :unset, priority: :unset, task_channel: :unset)
+            def update(attributes: :unset, assignment_status: :unset, reason: :unset, priority: :unset, task_channel: :unset, if_match: :unset)
               data = Twilio::Values.of({
                   'Attributes' => attributes,
                   'AssignmentStatus' => assignment_status,
@@ -355,21 +351,25 @@ module Twilio
                   'Priority' => priority,
                   'TaskChannel' => task_channel,
               })
+              headers = Twilio::Values.of({'If-Match' => if_match, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data, headers: headers)
 
               TaskInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the TaskInstance
+            # Delete the TaskInstance
+            # @param [String] if_match If provided, deletes this Task if (and only if) the
+            #   {ETag}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag] header of
+            #   the Task matches the provided value. This matches the semantics of (and is
+            #   implemented with) the HTTP {If-Match
+            #   header}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match].
             # @return [Boolean] true if delete succeeds, false otherwise
-            def delete
-              @version.delete('delete', @uri)
+            def delete(if_match: :unset)
+              headers = Twilio::Values.of({'If-Match' => if_match, })
+
+               @version.delete('DELETE', @uri, headers: headers)
             end
 
             ##
@@ -429,6 +429,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'],
@@ -467,7 +468,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The number of seconds since the task was created
+            # @return [String] The number of seconds since the Task was created
             def age
               @properties['age']
             end
@@ -502,6 +503,12 @@ module Twilio
               @properties['date_updated']
             end
 
+            ##
+            # @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
@@ -509,7 +516,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The reason the task was canceled or completed
+            # @return [String] The reason the Task was canceled or completed
             def reason
               @properties['reason']
             end
@@ -545,7 +552,7 @@ module Twilio
             end
 
             ##
-            # @return [String] The amount of time in seconds that the task is allowed to live
+            # @return [String] The amount of time in seconds that the Task can live before being assigned
             def timeout
               @properties['timeout']
             end
@@ -581,7 +588,7 @@ module Twilio
             end
 
             ##
-            # Fetch a TaskInstance
+            # Fetch the TaskInstance
             # @return [TaskInstance] Fetched TaskInstance
             def fetch
               context.fetch
@@ -600,26 +607,37 @@ module Twilio
             #   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.
+            #   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`.
+            # @param [String] if_match If provided, applies this mutation if (and only if) the
+            #   {ETag}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag] header of
+            #   the Task matches the provided value. This matches the semantics of (and is
+            #   implemented with) the HTTP {If-Match
+            #   header}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match].
             # @return [TaskInstance] Updated TaskInstance
-            def update(attributes: :unset, assignment_status: :unset, reason: :unset, priority: :unset, task_channel: :unset)
+            def update(attributes: :unset, assignment_status: :unset, reason: :unset, priority: :unset, task_channel: :unset, if_match: :unset)
               context.update(
                   attributes: attributes,
                   assignment_status: assignment_status,
                   reason: reason,
                   priority: priority,
                   task_channel: task_channel,
+                  if_match: if_match,
               )
             end
 
             ##
-            # Deletes the TaskInstance
+            # Delete the TaskInstance
+            # @param [String] if_match If provided, deletes this Task if (and only if) the
+            #   {ETag}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/ETag] header of
+            #   the Task matches the provided value. This matches the semantics of (and is
+            #   implemented with) the HTTP {If-Match
+            #   header}[https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-Match].
             # @return [Boolean] true if delete succeeds, false otherwise
-            def delete
-              context.delete
+            def delete(if_match: :unset)
+              context.delete(if_match: if_match, )
             end
 
             ##