twilio-ruby 5.19.0 → 5.77.0

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -15,8 +15,7 @@ module Twilio
             ##
             # Initialize the WorkerList
             # @param [Version] version Version that contains the resource
-            # @param [String] workspace_sid The ID of the Workflow this worker is associated
-            #   with
+            # @param [String] workspace_sid The SID of the Workspace that contains the Worker.
             # @return [WorkerList] WorkerList
             def initialize(version, workspace_sid: nil)
               super(version)
@@ -33,21 +32,23 @@ module Twilio
             # Lists WorkerInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [String] activity_name Filter by workers that are in a particular
-            #   Activity by Friendly Name
-            # @param [String] activity_sid Filter by workers that are in a particular Activity
-            #   by SID
-            # @param [String] available Filter by workers that are available or unavailable.
-            #   (Note: This can be 'true', '1' or 'yes' to indicate a true value. All other
-            #   values will represent false)
-            # @param [String] friendly_name Filter by a worker's friendly name
-            # @param [String] target_workers_expression Filter by workers that would match an
-            #   expression on a TaskQueue. This is helpful for debugging which workers would
+            # @param [String] activity_name The `activity_name` of the Worker resources to
+            #   read.
+            # @param [String] activity_sid The `activity_sid` of the Worker resources to read.
+            # @param [String] available Whether to return only Worker resources that are
+            #   available or unavailable. Can be `true`, `1`, or `yes` to return Worker
+            #   resources that are available, and `false`, or any value returns the Worker
+            #   resources that are not available.
+            # @param [String] friendly_name The `friendly_name` of the Worker resources to
+            #   read.
+            # @param [String] target_workers_expression Filter by Workers that would match an
+            #   expression on a TaskQueue. This is helpful for debugging which Workers would
             #   match a potential queue.
-            # @param [String] task_queue_name Filter by workers that are eligible for a
-            #   TaskQueue by Friendly Name
-            # @param [String] task_queue_sid Filter by workers that are eligible for a
-            #   TaskQueue by SID
+            # @param [String] task_queue_name The `friendly_name` of the TaskQueue that the
+            #   Workers to read are eligible for.
+            # @param [String] task_queue_sid The SID of the TaskQueue that the Workers to read
+            #   are eligible for.
+            # @param [String] ordering Sorting parameter for Workers
             # @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
@@ -55,7 +56,7 @@ module Twilio
             #    but a limit is defined, stream() will attempt to read the limit with the most
             #    efficient page size, i.e. min(limit, 1000)
             # @return [Array] Array of up to limit results
-            def list(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, limit: nil, page_size: nil)
+            def list(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, ordering: :unset, limit: nil, page_size: nil)
               self.stream(
                   activity_name: activity_name,
                   activity_sid: activity_sid,
@@ -64,6 +65,7 @@ module Twilio
                   target_workers_expression: target_workers_expression,
                   task_queue_name: task_queue_name,
                   task_queue_sid: task_queue_sid,
+                  ordering: ordering,
                   limit: limit,
                   page_size: page_size
               ).entries
@@ -73,21 +75,23 @@ module Twilio
             # Streams WorkerInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] activity_name Filter by workers that are in a particular
-            #   Activity by Friendly Name
-            # @param [String] activity_sid Filter by workers that are in a particular Activity
-            #   by SID
-            # @param [String] available Filter by workers that are available or unavailable.
-            #   (Note: This can be 'true', '1' or 'yes' to indicate a true value. All other
-            #   values will represent false)
-            # @param [String] friendly_name Filter by a worker's friendly name
-            # @param [String] target_workers_expression Filter by workers that would match an
-            #   expression on a TaskQueue. This is helpful for debugging which workers would
+            # @param [String] activity_name The `activity_name` of the Worker resources to
+            #   read.
+            # @param [String] activity_sid The `activity_sid` of the Worker resources to read.
+            # @param [String] available Whether to return only Worker resources that are
+            #   available or unavailable. Can be `true`, `1`, or `yes` to return Worker
+            #   resources that are available, and `false`, or any value returns the Worker
+            #   resources that are not available.
+            # @param [String] friendly_name The `friendly_name` of the Worker resources to
+            #   read.
+            # @param [String] target_workers_expression Filter by Workers that would match an
+            #   expression on a TaskQueue. This is helpful for debugging which Workers would
             #   match a potential queue.
-            # @param [String] task_queue_name Filter by workers that are eligible for a
-            #   TaskQueue by Friendly Name
-            # @param [String] task_queue_sid Filter by workers that are eligible for a
-            #   TaskQueue by SID
+            # @param [String] task_queue_name The `friendly_name` of the TaskQueue that the
+            #   Workers to read are eligible for.
+            # @param [String] task_queue_sid The SID of the TaskQueue that the Workers to read
+            #   are eligible for.
+            # @param [String] ordering Sorting parameter for Workers
             # @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
@@ -95,7 +99,7 @@ module Twilio
             #    but a limit is defined, stream() will attempt to read the limit with the most
             #    efficient page size, i.e. min(limit, 1000)
             # @return [Enumerable] Enumerable that will yield up to limit results
-            def stream(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, limit: nil, page_size: nil)
+            def stream(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, ordering: :unset, limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
               page = self.page(
@@ -106,6 +110,7 @@ module Twilio
                   target_workers_expression: target_workers_expression,
                   task_queue_name: task_queue_name,
                   task_queue_sid: task_queue_sid,
+                  ordering: ordering,
                   page_size: limits[:page_size],
               )
 
@@ -129,26 +134,28 @@ module Twilio
             ##
             # Retrieve a single page of WorkerInstance records from the API.
             # Request is executed immediately.
-            # @param [String] activity_name Filter by workers that are in a particular
-            #   Activity by Friendly Name
-            # @param [String] activity_sid Filter by workers that are in a particular Activity
-            #   by SID
-            # @param [String] available Filter by workers that are available or unavailable.
-            #   (Note: This can be 'true', '1' or 'yes' to indicate a true value. All other
-            #   values will represent false)
-            # @param [String] friendly_name Filter by a worker's friendly name
-            # @param [String] target_workers_expression Filter by workers that would match an
-            #   expression on a TaskQueue. This is helpful for debugging which workers would
+            # @param [String] activity_name The `activity_name` of the Worker resources to
+            #   read.
+            # @param [String] activity_sid The `activity_sid` of the Worker resources to read.
+            # @param [String] available Whether to return only Worker resources that are
+            #   available or unavailable. Can be `true`, `1`, or `yes` to return Worker
+            #   resources that are available, and `false`, or any value returns the Worker
+            #   resources that are not available.
+            # @param [String] friendly_name The `friendly_name` of the Worker resources to
+            #   read.
+            # @param [String] target_workers_expression Filter by Workers that would match an
+            #   expression on a TaskQueue. This is helpful for debugging which Workers would
             #   match a potential queue.
-            # @param [String] task_queue_name Filter by workers that are eligible for a
-            #   TaskQueue by Friendly Name
-            # @param [String] task_queue_sid Filter by workers that are eligible for a
-            #   TaskQueue by SID
+            # @param [String] task_queue_name The `friendly_name` of the TaskQueue that the
+            #   Workers to read are eligible for.
+            # @param [String] task_queue_sid The SID of the TaskQueue that the Workers to read
+            #   are eligible for.
+            # @param [String] ordering Sorting parameter for Workers
             # @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
             # @return [Page] Page of WorkerInstance
-            def page(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
+            def page(activity_name: :unset, activity_sid: :unset, available: :unset, friendly_name: :unset, target_workers_expression: :unset, task_queue_name: :unset, task_queue_sid: :unset, ordering: :unset, page_token: :unset, page_number: :unset, page_size: :unset)
               params = Twilio::Values.of({
                   'ActivityName' => activity_name,
                   'ActivitySid' => activity_sid,
@@ -157,15 +164,14 @@ module Twilio
                   'TargetWorkersExpression' => target_workers_expression,
                   'TaskQueueName' => task_queue_name,
                   'TaskQueueSid' => task_queue_sid,
+                  'Ordering' => ordering,
                   'PageToken' => page_token,
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               WorkerPage.new(@version, response, @solution)
             end
 
@@ -183,18 +189,19 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of WorkerInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] friendly_name String representing user-friendly name for the
-            #   Worker.
-            # @param [String] activity_sid A valid Activity describing the worker's initial
-            #   state. See Activities for more information. If not provided, new Workers will be
-            #   use the DefaultActivitySid configured on the Workspace.
-            # @param [String] attributes JSON object describing this worker. For example: `{
-            #   'email: 'Bob@foo.com', 'phone': '8675309' }`. This data will be passed to the
-            #   Assignment Callback URL whenever TaskRouter assigns a Task to this worker.
-            #   Defaults to {}.
-            # @return [WorkerInstance] Newly created WorkerInstance
+            # Create the WorkerInstance
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the new Worker. It can be up to 64 characters long.
+            # @param [String] activity_sid The SID of a valid Activity that will describe the
+            #   new Worker's initial state. See
+            #   {Activities}[https://www.twilio.com/docs/taskrouter/api/activity] for more
+            #   information. If not provided, the new Worker's initial state is the
+            #   `default_activity_sid` configured on the Workspace.
+            # @param [String] attributes A valid JSON string that describes the new Worker.
+            #   For example: `{ "email": "Bob@example.com", "phone": "+5095551234" }`. This data
+            #   is passed to the `assignment_callback_url` when TaskRouter assigns a Task to the
+            #   Worker. Defaults to {}.
+            # @return [WorkerInstance] Created WorkerInstance
             def create(friendly_name: nil, activity_sid: :unset, attributes: :unset)
               data = Twilio::Values.of({
                   'FriendlyName' => friendly_name,
@@ -202,23 +209,16 @@ module Twilio
                   'Attributes' => attributes,
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               WorkerInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
             end
 
             ##
             # Access the statistics
-            # @return [WorkersStatisticsList]
-            # @return [WorkersStatisticsContext]
+            # @return [WorkersStatisticsContext] WorkersStatisticsContext
             def statistics
               return WorkersStatisticsContext.new(@version, @solution[:workspace_sid], )
-
-              @statistics ||= WorkersStatisticsList.new(@version, workspace_sid: @solution[:workspace_sid], )
             end
 
             ##
@@ -261,8 +261,8 @@ module Twilio
             ##
             # Initialize the WorkerContext
             # @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 Worker to fetch.
+            # @param [String] sid The SID of the Worker resource to fetch.
             # @return [WorkerContext] WorkerContext
             def initialize(version, workspace_sid, sid)
               super(version)
@@ -280,16 +280,10 @@ module Twilio
             end
 
             ##
-            # Fetch a WorkerInstance
+            # Fetch the WorkerInstance
             # @return [WorkerInstance] Fetched WorkerInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               WorkerInstance.new(
                   @version,
@@ -301,22 +295,32 @@ module Twilio
 
             ##
             # Update the WorkerInstance
-            # @param [String] activity_sid The activity_sid
-            # @param [String] attributes The attributes
-            # @param [String] friendly_name The friendly_name
+            # @param [String] activity_sid The SID of a valid Activity that will describe the
+            #   Worker's initial state. See
+            #   {Activities}[https://www.twilio.com/docs/taskrouter/api/activity] for more
+            #   information.
+            # @param [String] attributes The JSON string that describes the Worker. For
+            #   example: `{ "email": "Bob@example.com", "phone": "+5095551234" }`. This data is
+            #   passed to the `assignment_callback_url` when TaskRouter assigns a Task to the
+            #   Worker. Defaults to {}.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the Worker. It can be up to 64 characters long.
+            # @param [Boolean] reject_pending_reservations Whether to reject the Worker's
+            #   pending reservations. This option is only valid if the Worker's new
+            #   {Activity}[https://www.twilio.com/docs/taskrouter/api/activity] resource has its
+            #   `availability` property set to `False`.
+            # @param [String] if_match The If-Match HTTP request header
             # @return [WorkerInstance] Updated WorkerInstance
-            def update(activity_sid: :unset, attributes: :unset, friendly_name: :unset)
+            def update(activity_sid: :unset, attributes: :unset, friendly_name: :unset, reject_pending_reservations: :unset, if_match: :unset)
               data = Twilio::Values.of({
                   'ActivitySid' => activity_sid,
                   'Attributes' => attributes,
                   'FriendlyName' => friendly_name,
+                  'RejectPendingReservations' => reject_pending_reservations,
               })
+              headers = Twilio::Values.of({'If-Match' => if_match, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data, headers: headers)
 
               WorkerInstance.new(
                   @version,
@@ -327,10 +331,13 @@ module Twilio
             end
 
             ##
-            # Deletes the WorkerInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
-            def delete
-              @version.delete('delete', @uri)
+            # Delete the WorkerInstance
+            # @param [String] if_match The If-Match HTTP request header
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete(if_match: :unset)
+              headers = Twilio::Values.of({'If-Match' => if_match, })
+
+               @version.delete('DELETE', @uri, headers: headers)
             end
 
             ##
@@ -407,6 +414,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Taskrouter.V1.WorkerContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Taskrouter.V1.WorkerContext #{context}>"
+            end
           end
 
           class WorkerInstance < InstanceResource
@@ -414,9 +428,8 @@ module Twilio
             # Initialize the WorkerInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] workspace_sid The ID of the Workflow this worker is associated
-            #   with
-            # @param [String] sid The sid
+            # @param [String] workspace_sid The SID of the Workspace that contains the Worker.
+            # @param [String] sid The SID of the Worker resource to fetch.
             # @return [WorkerInstance] WorkerInstance
             def initialize(version, payload, workspace_sid: nil, sid: nil)
               super(version)
@@ -455,85 +468,85 @@ module Twilio
             end
 
             ##
-            # @return [String] The ID of the account that owns this worker
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] Filter by workers that are in a particular Activity by Friendly Name
+            # @return [String] The friendly_name of the Worker's current Activity
             def activity_name
               @properties['activity_name']
             end
 
             ##
-            # @return [String] Filter by workers that are in a particular Activity by SID
+            # @return [String] The SID of the Worker's current Activity
             def activity_sid
               @properties['activity_sid']
             end
 
             ##
-            # @return [String] JSON object describing this worker.
+            # @return [String] The JSON string that describes the Worker
             def attributes
               @properties['attributes']
             end
 
             ##
-            # @return [Boolean] Filter by workers that are available or unavailable.
+            # @return [Boolean] Whether the Worker is available to perform tasks
             def available
               @properties['available']
             end
 
             ##
-            # @return [Time] DateTime this worker was 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] DateTime of the last change to the Worker's activity.
+            # @return [Time] The date and time in GMT of the last change to the Worker's activity
             def date_status_changed
               @properties['date_status_changed']
             end
 
             ##
-            # @return [Time] DateTime of the last update
+            # @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] Filter by a worker's friendly name
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The unique ID of the worker
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The ID of the Workflow this worker is associated with
+            # @return [String] The SID of the Workspace that contains the Worker
             def workspace_sid
               @properties['workspace_sid']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the Worker resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] The URLs of related resources
             def links
               @properties['links']
             end
 
             ##
-            # Fetch a WorkerInstance
+            # Fetch the WorkerInstance
             # @return [WorkerInstance] Fetched WorkerInstance
             def fetch
               context.fetch
@@ -541,19 +554,38 @@ module Twilio
 
             ##
             # Update the WorkerInstance
-            # @param [String] activity_sid The activity_sid
-            # @param [String] attributes The attributes
-            # @param [String] friendly_name The friendly_name
+            # @param [String] activity_sid The SID of a valid Activity that will describe the
+            #   Worker's initial state. See
+            #   {Activities}[https://www.twilio.com/docs/taskrouter/api/activity] for more
+            #   information.
+            # @param [String] attributes The JSON string that describes the Worker. For
+            #   example: `{ "email": "Bob@example.com", "phone": "+5095551234" }`. This data is
+            #   passed to the `assignment_callback_url` when TaskRouter assigns a Task to the
+            #   Worker. Defaults to {}.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the Worker. It can be up to 64 characters long.
+            # @param [Boolean] reject_pending_reservations Whether to reject the Worker's
+            #   pending reservations. This option is only valid if the Worker's new
+            #   {Activity}[https://www.twilio.com/docs/taskrouter/api/activity] resource has its
+            #   `availability` property set to `False`.
+            # @param [String] if_match The If-Match HTTP request header
             # @return [WorkerInstance] Updated WorkerInstance
-            def update(activity_sid: :unset, attributes: :unset, friendly_name: :unset)
-              context.update(activity_sid: activity_sid, attributes: attributes, friendly_name: friendly_name, )
+            def update(activity_sid: :unset, attributes: :unset, friendly_name: :unset, reject_pending_reservations: :unset, if_match: :unset)
+              context.update(
+                  activity_sid: activity_sid,
+                  attributes: attributes,
+                  friendly_name: friendly_name,
+                  reject_pending_reservations: reject_pending_reservations,
+                  if_match: if_match,
+              )
             end
 
             ##
-            # Deletes the WorkerInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
-            def delete
-              context.delete
+            # Delete the WorkerInstance
+            # @param [String] if_match The If-Match HTTP request header
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete(if_match: :unset)
+              context.delete(if_match: if_match, )
             end
 
             ##