twilio-ruby 5.6.0 → 5.33.0

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,7 +15,7 @@ module Twilio
             ##
             # Initialize the WorkerList
             # @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 Worker.
             # @return [WorkerList] WorkerList
             def initialize(version, workspace_sid: nil)
               super(version)
@@ -30,13 +32,22 @@ 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 The activity_name
-            # @param [String] activity_sid The activity_sid
-            # @param [String] available The available
-            # @param [String] friendly_name The friendly_name
-            # @param [String] target_workers_expression The target_workers_expression
-            # @param [String] task_queue_name The task_queue_name
-            # @param [String] task_queue_sid The task_queue_sid
+            # @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 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 [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
@@ -62,13 +73,22 @@ 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 The activity_name
-            # @param [String] activity_sid The activity_sid
-            # @param [String] available The available
-            # @param [String] friendly_name The friendly_name
-            # @param [String] target_workers_expression The target_workers_expression
-            # @param [String] task_queue_name The task_queue_name
-            # @param [String] task_queue_sid The task_queue_sid
+            # @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 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 [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
@@ -100,7 +120,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],
@@ -110,13 +130,22 @@ module Twilio
             ##
             # Retrieve a single page of WorkerInstance records from the API.
             # Request is executed immediately.
-            # @param [String] activity_name The activity_name
-            # @param [String] activity_sid The activity_sid
-            # @param [String] available The available
-            # @param [String] friendly_name The friendly_name
-            # @param [String] target_workers_expression The target_workers_expression
-            # @param [String] task_queue_name The task_queue_name
-            # @param [String] task_queue_sid The task_queue_sid
+            # @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 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] 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
@@ -158,9 +187,17 @@ module Twilio
             ##
             # Retrieve a single page of WorkerInstance records from the API.
             # Request is executed immediately.
-            # @param [String] friendly_name The friendly_name
-            # @param [String] activity_sid The activity_sid
-            # @param [String] attributes The attributes
+            # @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] Newly created WorkerInstance
             def create(friendly_name: nil, activity_sid: :unset, attributes: :unset)
               data = Twilio::Values.of({
@@ -175,7 +212,7 @@ module Twilio
                   data: data
               )
 
-              WorkerInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid])
+              WorkerInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
             end
 
             ##
@@ -183,9 +220,9 @@ module Twilio
             # @return [WorkersStatisticsList]
             # @return [WorkersStatisticsContext]
             def statistics
-              return WorkersStatisticsContext.new(@version, @solution[:workspace_sid])
+              return WorkersStatisticsContext.new(@version, @solution[:workspace_sid], )
 
-              @statistics ||= WorkersStatisticsList.new(@version, workspace_sid: @solution[:workspace_sid])
+              @statistics ||= WorkersStatisticsList.new(@version, workspace_sid: @solution[:workspace_sid], )
             end
 
             ##
@@ -214,7 +251,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [WorkerInstance] WorkerInstance
             def get_instance(payload)
-              WorkerInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid])
+              WorkerInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
             end
 
             ##
@@ -228,14 +265,14 @@ 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)
 
               # Path Solution
-              @solution = {workspace_sid: workspace_sid, sid: sid}
+              @solution = {workspace_sid: workspace_sid, sid: sid, }
               @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workers/#{@solution[:sid]}"
 
               # Dependents
@@ -258,20 +295,35 @@ module Twilio
                   params,
               )
 
-              WorkerInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], sid: @solution[:sid])
+              WorkerInstance.new(
+                  @version,
+                  payload,
+                  workspace_sid: @solution[:workspace_sid],
+                  sid: @solution[:sid],
+              )
             end
 
             ##
             # 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 pending
+            #   reservations.
             # @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)
               data = Twilio::Values.of({
                   'ActivitySid' => activity_sid,
                   'Attributes' => attributes,
                   'FriendlyName' => friendly_name,
+                  'RejectPendingReservations' => reject_pending_reservations,
               })
 
               payload = @version.update(
@@ -280,12 +332,17 @@ module Twilio
                   data: data,
               )
 
-              WorkerInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], sid: @solution[:sid])
+              WorkerInstance.new(
+                  @version,
+                  payload,
+                  workspace_sid: @solution[:workspace_sid],
+                  sid: @solution[:sid],
+              )
             end
 
             ##
             # Deletes the WorkerInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -295,7 +352,7 @@ module Twilio
             # @return [WorkersRealTimeStatisticsList]
             # @return [WorkersRealTimeStatisticsContext]
             def real_time_statistics
-              WorkersRealTimeStatisticsContext.new(@version, @solution[:workspace_sid])
+              WorkersRealTimeStatisticsContext.new(@version, @solution[:workspace_sid], )
             end
 
             ##
@@ -303,7 +360,7 @@ module Twilio
             # @return [WorkersCumulativeStatisticsList]
             # @return [WorkersCumulativeStatisticsContext]
             def cumulative_statistics
-              WorkersCumulativeStatisticsContext.new(@version, @solution[:workspace_sid])
+              WorkersCumulativeStatisticsContext.new(@version, @solution[:workspace_sid], )
             end
 
             ##
@@ -311,7 +368,7 @@ module Twilio
             # @return [WorkerStatisticsList]
             # @return [WorkerStatisticsContext]
             def statistics
-              WorkerStatisticsContext.new(@version, @solution[:workspace_sid], @solution[:sid])
+              WorkerStatisticsContext.new(@version, @solution[:workspace_sid], @solution[:sid], )
             end
 
             ##
@@ -322,7 +379,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
@@ -344,7 +401,7 @@ module Twilio
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return WorkerChannelContext.new(@version, @solution[:workspace_sid], @solution[:sid], sid)
+                return WorkerChannelContext.new(@version, @solution[:workspace_sid], @solution[:sid], sid, )
               end
 
               unless @worker_channels
@@ -364,6 +421,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
@@ -371,8 +435,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 workspace_sid
-            # @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)
@@ -396,7 +460,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
 
             ##
@@ -405,85 +469,85 @@ module Twilio
             # @return [WorkerContext] WorkerContext for this WorkerInstance
             def context
               unless @instance_context
-                @instance_context = WorkerContext.new(@version, @params['workspace_sid'], @params['sid'])
+                @instance_context = WorkerContext.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 activity_name
+            # @return [String] The friendly_name of the Worker's current Activity
             def activity_name
               @properties['activity_name']
             end
 
             ##
-            # @return [String] The activity_sid
+            # @return [String] The SID of the Worker's current Activity
             def activity_sid
               @properties['activity_sid']
             end
 
             ##
-            # @return [String] The attributes
+            # @return [String] The JSON string that describes the Worker
             def attributes
               @properties['attributes']
             end
 
             ##
-            # @return [Boolean] The available
+            # @return [Boolean] Whether the Worker is available to perform tasks
             def available
               @properties['available']
             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_status_changed
+            # @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] 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 friendly_name
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The workspace_sid
+            # @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
@@ -497,17 +561,31 @@ 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 pending
+            #   reservations.
             # @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)
+              context.update(
+                  activity_sid: activity_sid,
+                  attributes: attributes,
+                  friendly_name: friendly_name,
+                  reject_pending_reservations: reject_pending_reservations,
+              )
             end
 
             ##
             # Deletes the WorkerInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end