twilio-ruby 5.6.0 → 5.33.0

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,7 +15,8 @@ module Twilio
             ##
             # Initialize the WorkflowList
             # @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
+            #   Workflow.
             # @return [WorkflowList] WorkflowList
             def initialize(version, workspace_sid: nil)
               super(version)
@@ -27,7 +30,8 @@ module Twilio
             # Lists WorkflowInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [String] friendly_name The friendly_name
+            # @param [String] friendly_name The `friendly_name` of the Workflow resources to
+            #   read.
             # @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
@@ -43,7 +47,8 @@ module Twilio
             # Streams WorkflowInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] friendly_name The friendly_name
+            # @param [String] friendly_name The `friendly_name` of the Workflow resources to
+            #   read.
             # @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
@@ -54,7 +59,7 @@ module Twilio
             def stream(friendly_name: :unset, limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(friendly_name: friendly_name, page_size: limits[:page_size])
+              page = self.page(friendly_name: friendly_name, page_size: limits[:page_size], )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -66,7 +71,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],
@@ -76,7 +81,8 @@ module Twilio
             ##
             # Retrieve a single page of WorkflowInstance records from the API.
             # Request is executed immediately.
-            # @param [String] friendly_name The friendly_name
+            # @param [String] friendly_name The `friendly_name` of the Workflow resources to
+            #   read.
             # @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
@@ -112,12 +118,22 @@ module Twilio
             ##
             # Retrieve a single page of WorkflowInstance records from the API.
             # Request is executed immediately.
-            # @param [String] friendly_name The friendly_name
-            # @param [String] configuration The configuration
-            # @param [String] assignment_callback_url The assignment_callback_url
-            # @param [String] fallback_assignment_callback_url The
-            #   fallback_assignment_callback_url
-            # @param [String] task_reservation_timeout The task_reservation_timeout
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the Workflow resource. For example, `Inbound Call Workflow` or `2014 Outbound
+            #   Campaign`.
+            # @param [String] configuration A JSON string that contains the rules to apply to
+            #   the Workflow. See [Configuring
+            #   Workflows](https://www.twilio.com/docs/taskrouter/workflow-configuration) for
+            #   more information.
+            # @param [String] assignment_callback_url The URL from your application that will
+            #   process task assignment events. See [Handling Task Assignment
+            #   Callback](https://www.twilio.com/docs/taskrouter/handle-assignment-callbacks)
+            #   for more details.
+            # @param [String] fallback_assignment_callback_url The URL that we should call
+            #   when a call to the `assignment_callback_url` fails.
+            # @param [String] task_reservation_timeout How long TaskRouter will wait for a
+            #   confirmation response from your application after it assigns a Task to a Worker.
+            #   Can be up to `86,400` (24 hours) and the default is `120`.
             # @return [WorkflowInstance] Newly created WorkflowInstance
             def create(friendly_name: nil, configuration: nil, assignment_callback_url: :unset, fallback_assignment_callback_url: :unset, task_reservation_timeout: :unset)
               data = Twilio::Values.of({
@@ -134,7 +150,7 @@ module Twilio
                   data: data
               )
 
-              WorkflowInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid])
+              WorkflowInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
             end
 
             ##
@@ -163,7 +179,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [WorkflowInstance] WorkflowInstance
             def get_instance(payload)
-              WorkflowInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid])
+              WorkflowInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
             end
 
             ##
@@ -177,14 +193,15 @@ module Twilio
             ##
             # Initialize the WorkflowContext
             # @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 Workflow to
+            #   fetch.
+            # @param [String] sid The SID of the Workflow resource to fetch.
             # @return [WorkflowContext] WorkflowContext
             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]}/Workflows/#{@solution[:sid]}"
 
               # Dependents
@@ -205,25 +222,44 @@ module Twilio
                   params,
               )
 
-              WorkflowInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], sid: @solution[:sid])
+              WorkflowInstance.new(
+                  @version,
+                  payload,
+                  workspace_sid: @solution[:workspace_sid],
+                  sid: @solution[:sid],
+              )
             end
 
             ##
             # Update the WorkflowInstance
-            # @param [String] friendly_name The friendly_name
-            # @param [String] assignment_callback_url The assignment_callback_url
-            # @param [String] fallback_assignment_callback_url The
-            #   fallback_assignment_callback_url
-            # @param [String] configuration The configuration
-            # @param [String] task_reservation_timeout The task_reservation_timeout
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the Workflow resource. For example, `Inbound Call Workflow` or `2014 Outbound
+            #   Campaign`.
+            # @param [String] assignment_callback_url The URL from your application that will
+            #   process task assignment events. See [Handling Task Assignment
+            #   Callback](https://www.twilio.com/docs/taskrouter/handle-assignment-callbacks)
+            #   for more details.
+            # @param [String] fallback_assignment_callback_url The URL that we should call
+            #   when a call to the `assignment_callback_url` fails.
+            # @param [String] configuration A JSON string that contains the rules to apply to
+            #   the Workflow. See [Configuring
+            #   Workflows](https://www.twilio.com/docs/taskrouter/workflow-configuration) for
+            #   more information.
+            # @param [String] task_reservation_timeout How long TaskRouter will wait for a
+            #   confirmation response from your application after it assigns a Task to a Worker.
+            #   Can be up to `86,400` (24 hours) and the default is `120`.
+            # @param [String] re_evaluate_tasks Whether or not to re-evaluate Tasks. The
+            #   default is `false`, which means Tasks in the Workflow will not be processed
+            #   through the assignment loop again.
             # @return [WorkflowInstance] Updated WorkflowInstance
-            def update(friendly_name: :unset, assignment_callback_url: :unset, fallback_assignment_callback_url: :unset, configuration: :unset, task_reservation_timeout: :unset)
+            def update(friendly_name: :unset, assignment_callback_url: :unset, fallback_assignment_callback_url: :unset, configuration: :unset, task_reservation_timeout: :unset, re_evaluate_tasks: :unset)
               data = Twilio::Values.of({
                   'FriendlyName' => friendly_name,
                   'AssignmentCallbackUrl' => assignment_callback_url,
                   'FallbackAssignmentCallbackUrl' => fallback_assignment_callback_url,
                   'Configuration' => configuration,
                   'TaskReservationTimeout' => task_reservation_timeout,
+                  'ReEvaluateTasks' => re_evaluate_tasks,
               })
 
               payload = @version.update(
@@ -232,12 +268,17 @@ module Twilio
                   data: data,
               )
 
-              WorkflowInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], sid: @solution[:sid])
+              WorkflowInstance.new(
+                  @version,
+                  payload,
+                  workspace_sid: @solution[:workspace_sid],
+                  sid: @solution[:sid],
+              )
             end
 
             ##
             # Deletes the WorkflowInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -247,7 +288,7 @@ module Twilio
             # @return [WorkflowStatisticsList]
             # @return [WorkflowStatisticsContext]
             def statistics
-              WorkflowStatisticsContext.new(@version, @solution[:workspace_sid], @solution[:sid])
+              WorkflowStatisticsContext.new(@version, @solution[:workspace_sid], @solution[:sid], )
             end
 
             ##
@@ -255,7 +296,7 @@ module Twilio
             # @return [WorkflowRealTimeStatisticsList]
             # @return [WorkflowRealTimeStatisticsContext]
             def real_time_statistics
-              WorkflowRealTimeStatisticsContext.new(@version, @solution[:workspace_sid], @solution[:sid])
+              WorkflowRealTimeStatisticsContext.new(@version, @solution[:workspace_sid], @solution[:sid], )
             end
 
             ##
@@ -263,7 +304,7 @@ module Twilio
             # @return [WorkflowCumulativeStatisticsList]
             # @return [WorkflowCumulativeStatisticsContext]
             def cumulative_statistics
-              WorkflowCumulativeStatisticsContext.new(@version, @solution[:workspace_sid], @solution[:sid])
+              WorkflowCumulativeStatisticsContext.new(@version, @solution[:workspace_sid], @solution[:sid], )
             end
 
             ##
@@ -272,6 +313,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Taskrouter.V1.WorkflowContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Taskrouter.V1.WorkflowContext #{context}>"
+            end
           end
 
           class WorkflowInstance < InstanceResource
@@ -279,8 +327,9 @@ module Twilio
             # Initialize the WorkflowInstance
             # @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
+            #   Workflow.
+            # @param [String] sid The SID of the Workflow resource to fetch.
             # @return [WorkflowInstance] WorkflowInstance
             def initialize(version, payload, workspace_sid: nil, sid: nil)
               super(version)
@@ -304,7 +353,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
 
             ##
@@ -313,85 +362,85 @@ module Twilio
             # @return [WorkflowContext] WorkflowContext for this WorkflowInstance
             def context
               unless @instance_context
-                @instance_context = WorkflowContext.new(@version, @params['workspace_sid'], @params['sid'])
+                @instance_context = WorkflowContext.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 assignment_callback_url
+            # @return [String] The URL that we call when a task managed by the Workflow is assigned to a Worker
             def assignment_callback_url
               @properties['assignment_callback_url']
             end
 
             ##
-            # @return [String] The configuration
+            # @return [String] A JSON string that contains the Workflow's configuration
             def configuration
               @properties['configuration']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The RFC 2822 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The document_content_type
+            # @return [String] The MIME type of the document
             def document_content_type
               @properties['document_content_type']
             end
 
             ##
-            # @return [String] The fallback_assignment_callback_url
+            # @return [String] The URL that we call when a call to the `assignment_callback_url` fails
             def fallback_assignment_callback_url
               @properties['fallback_assignment_callback_url']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] The string that you assigned to describe the Workflow 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 task_reservation_timeout
+            # @return [String] How long TaskRouter will wait for a confirmation response from your application after it assigns a Task to a Worker
             def task_reservation_timeout
               @properties['task_reservation_timeout']
             end
 
             ##
-            # @return [String] The workspace_sid
+            # @return [String] The SID of the Workspace that contains the Workflow
             def workspace_sid
               @properties['workspace_sid']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the Workflow resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] The URLs of related resources
             def links
               @properties['links']
             end
@@ -405,26 +454,40 @@ module Twilio
 
             ##
             # Update the WorkflowInstance
-            # @param [String] friendly_name The friendly_name
-            # @param [String] assignment_callback_url The assignment_callback_url
-            # @param [String] fallback_assignment_callback_url The
-            #   fallback_assignment_callback_url
-            # @param [String] configuration The configuration
-            # @param [String] task_reservation_timeout The task_reservation_timeout
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the Workflow resource. For example, `Inbound Call Workflow` or `2014 Outbound
+            #   Campaign`.
+            # @param [String] assignment_callback_url The URL from your application that will
+            #   process task assignment events. See [Handling Task Assignment
+            #   Callback](https://www.twilio.com/docs/taskrouter/handle-assignment-callbacks)
+            #   for more details.
+            # @param [String] fallback_assignment_callback_url The URL that we should call
+            #   when a call to the `assignment_callback_url` fails.
+            # @param [String] configuration A JSON string that contains the rules to apply to
+            #   the Workflow. See [Configuring
+            #   Workflows](https://www.twilio.com/docs/taskrouter/workflow-configuration) for
+            #   more information.
+            # @param [String] task_reservation_timeout How long TaskRouter will wait for a
+            #   confirmation response from your application after it assigns a Task to a Worker.
+            #   Can be up to `86,400` (24 hours) and the default is `120`.
+            # @param [String] re_evaluate_tasks Whether or not to re-evaluate Tasks. The
+            #   default is `false`, which means Tasks in the Workflow will not be processed
+            #   through the assignment loop again.
             # @return [WorkflowInstance] Updated WorkflowInstance
-            def update(friendly_name: :unset, assignment_callback_url: :unset, fallback_assignment_callback_url: :unset, configuration: :unset, task_reservation_timeout: :unset)
+            def update(friendly_name: :unset, assignment_callback_url: :unset, fallback_assignment_callback_url: :unset, configuration: :unset, task_reservation_timeout: :unset, re_evaluate_tasks: :unset)
               context.update(
                   friendly_name: friendly_name,
                   assignment_callback_url: assignment_callback_url,
                   fallback_assignment_callback_url: fallback_assignment_callback_url,
                   configuration: configuration,
                   task_reservation_timeout: task_reservation_timeout,
+                  re_evaluate_tasks: re_evaluate_tasks,
               )
             end
 
             ##
             # Deletes the WorkflowInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end