twilio-ruby 5.8.1 → 5.9.0

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -82,11 +84,23 @@ module Twilio
 
               ##
               # Fetch a WorkflowCumulativeStatisticsInstance
-              # @param [Time] end_date The end_date
-              # @param [String] minutes The minutes
-              # @param [Time] start_date The start_date
-              # @param [String] task_channel The task_channel
-              # @param [String] split_by_wait_time The split_by_wait_time
+              # @param [Time] end_date Filter cumulative statistics by an end date. This is
+              #   helpful for defining a range of statistics to capture. Input is a GMT ISO 8601
+              #   Timestamp
+              # @param [String] minutes Filter cumulative statistics by up to ‘x’ minutes in the
+              #   past. This is helpful for statistics for the last 15 minutes, 240 minutes (4
+              #   hours), and 480 minutes (8 hours) to see trends. Defaults to 15 minutes.
+              # @param [Time] start_date Filter cumulative statistics by a start date. This is
+              #   helpful for defining a range of statistics to capture. Input is a GMT ISO 8601
+              #   Timestamp
+              # @param [String] task_channel Filter real-time and cumulative statistics by
+              #   TaskChannel. Takes in a Unique Name ("voice", "sms", "default", etc.) or a
+              #   TaskChannelSid.
+              # @param [String] split_by_wait_time A comma separated values for viewing splits
+              #   of tasks canceled and accepted above the given threshold in seconds. Ex: "5,30"
+              #   would show splits of tasks that were canceled or accepted before or after 5
+              #   seconds and respectively, 30 seconds. This is great for showing short abandoned
+              #   tasks or tasks that failed to meet your SLA.
               # @return [WorkflowCumulativeStatisticsInstance] Fetched WorkflowCumulativeStatisticsInstance
               def fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset)
                 params = Twilio::Values.of({
@@ -183,7 +197,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The avg_task_acceptance_time
+              # @return [String] The average time from Task creation to acceptance
               def avg_task_acceptance_time
                 @properties['avg_task_acceptance_time']
               end
@@ -201,91 +215,91 @@ module Twilio
               end
 
               ##
-              # @return [String] The reservations_created
+              # @return [String] The total number of Reservations that were created for Workers
               def reservations_created
                 @properties['reservations_created']
               end
 
               ##
-              # @return [String] The reservations_accepted
+              # @return [String] The total number of Reservations accepted by Workers
               def reservations_accepted
                 @properties['reservations_accepted']
               end
 
               ##
-              # @return [String] The reservations_rejected
+              # @return [String] The total number of Reservations that were rejected
               def reservations_rejected
                 @properties['reservations_rejected']
               end
 
               ##
-              # @return [String] The reservations_timed_out
+              # @return [String] The total number of Reservations that were timed out
               def reservations_timed_out
                 @properties['reservations_timed_out']
               end
 
               ##
-              # @return [String] The reservations_canceled
+              # @return [String] The total number of Reservations that were canceled
               def reservations_canceled
                 @properties['reservations_canceled']
               end
 
               ##
-              # @return [String] The reservations_rescinded
+              # @return [String] The total number of Reservations that were rescinded
               def reservations_rescinded
                 @properties['reservations_rescinded']
               end
 
               ##
-              # @return [Hash] The split_by_wait_time
+              # @return [Hash] The splits of the tasks canceled and accepted based on the provided SplitByWaitTime parameter.
               def split_by_wait_time
                 @properties['split_by_wait_time']
               end
 
               ##
-              # @return [Hash] The wait_duration_until_accepted
+              # @return [Hash] The wait duration stats for tasks that were accepted.
               def wait_duration_until_accepted
                 @properties['wait_duration_until_accepted']
               end
 
               ##
-              # @return [Hash] The wait_duration_until_canceled
+              # @return [Hash] The wait duration stats for tasks that were canceled.
               def wait_duration_until_canceled
                 @properties['wait_duration_until_canceled']
               end
 
               ##
-              # @return [String] The tasks_canceled
+              # @return [String] The total number of Tasks that were canceled
               def tasks_canceled
                 @properties['tasks_canceled']
               end
 
               ##
-              # @return [String] The tasks_completed
+              # @return [String] The total number of Tasks that were completed
               def tasks_completed
                 @properties['tasks_completed']
               end
 
               ##
-              # @return [String] The tasks_entered
+              # @return [String] The total number of Tasks that entered this Workflow
               def tasks_entered
                 @properties['tasks_entered']
               end
 
               ##
-              # @return [String] The tasks_deleted
+              # @return [String] The total number of Tasks that were deleted
               def tasks_deleted
                 @properties['tasks_deleted']
               end
 
               ##
-              # @return [String] The tasks_moved
+              # @return [String] The total number of Tasks that were moved from one queue to another
               def tasks_moved
                 @properties['tasks_moved']
               end
 
               ##
-              # @return [String] The tasks_timed_out_in_workflow
+              # @return [String] The total number of Tasks that were timed out of their Workflows
               def tasks_timed_out_in_workflow
                 @properties['tasks_timed_out_in_workflow']
               end
@@ -310,11 +324,23 @@ module Twilio
 
               ##
               # Fetch a WorkflowCumulativeStatisticsInstance
-              # @param [Time] end_date The end_date
-              # @param [String] minutes The minutes
-              # @param [Time] start_date The start_date
-              # @param [String] task_channel The task_channel
-              # @param [String] split_by_wait_time The split_by_wait_time
+              # @param [Time] end_date Filter cumulative statistics by an end date. This is
+              #   helpful for defining a range of statistics to capture. Input is a GMT ISO 8601
+              #   Timestamp
+              # @param [String] minutes Filter cumulative statistics by up to ‘x’ minutes in the
+              #   past. This is helpful for statistics for the last 15 minutes, 240 minutes (4
+              #   hours), and 480 minutes (8 hours) to see trends. Defaults to 15 minutes.
+              # @param [Time] start_date Filter cumulative statistics by a start date. This is
+              #   helpful for defining a range of statistics to capture. Input is a GMT ISO 8601
+              #   Timestamp
+              # @param [String] task_channel Filter real-time and cumulative statistics by
+              #   TaskChannel. Takes in a Unique Name ("voice", "sms", "default", etc.) or a
+              #   TaskChannelSid.
+              # @param [String] split_by_wait_time A comma separated values for viewing splits
+              #   of tasks canceled and accepted above the given threshold in seconds. Ex: "5,30"
+              #   would show splits of tasks that were canceled or accepted before or after 5
+              #   seconds and respectively, 30 seconds. This is great for showing short abandoned
+              #   tasks or tasks that failed to meet your SLA.
               # @return [WorkflowCumulativeStatisticsInstance] Fetched WorkflowCumulativeStatisticsInstance
               def fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset)
                 context.fetch(

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -82,7 +84,9 @@ module Twilio
 
               ##
               # Fetch a WorkflowRealTimeStatisticsInstance
-              # @param [String] task_channel The task_channel
+              # @param [String] task_channel Filter real-time and cumulative statistics by
+              #   TaskChannel. Takes in a Unique Name ("voice", "sms", "default", etc.) or a
+              #   TaskChannelSid.
               # @return [WorkflowRealTimeStatisticsInstance] Fetched WorkflowRealTimeStatisticsInstance
               def fetch(task_channel: :unset)
                 params = Twilio::Values.of({'TaskChannel' => task_channel, })
@@ -159,7 +163,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The longest_task_waiting_age
+              # @return [String] The age of the longest waiting Task
               def longest_task_waiting_age
                 @properties['longest_task_waiting_age']
               end
@@ -171,13 +175,13 @@ module Twilio
               end
 
               ##
-              # @return [Hash] The tasks_by_status
+              # @return [Hash] The Tasks broken down by status
               def tasks_by_status
                 @properties['tasks_by_status']
               end
 
               ##
-              # @return [String] The total_tasks
+              # @return [String] The total number of Tasks
               def total_tasks
                 @properties['total_tasks']
               end
@@ -202,7 +206,9 @@ module Twilio
 
               ##
               # Fetch a WorkflowRealTimeStatisticsInstance
-              # @param [String] task_channel The task_channel
+              # @param [String] task_channel Filter real-time and cumulative statistics by
+              #   TaskChannel. Takes in a Unique Name ("voice", "sms", "default", etc.) or a
+              #   TaskChannelSid.
               # @return [WorkflowRealTimeStatisticsInstance] Fetched WorkflowRealTimeStatisticsInstance
               def fetch(task_channel: :unset)
                 context.fetch(task_channel: task_channel, )

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -82,11 +84,23 @@ module Twilio
 
               ##
               # Fetch a WorkflowStatisticsInstance
-              # @param [String] minutes The minutes
-              # @param [Time] start_date The start_date
-              # @param [Time] end_date The end_date
-              # @param [String] task_channel The task_channel
-              # @param [String] split_by_wait_time The split_by_wait_time
+              # @param [String] minutes Filter cumulative statistics by up to ‘x’ minutes in the
+              #   past. This is helpful for statistics for the last 15 minutes, 240 minutes (4
+              #   hours), and 480 minutes (8 hours) to see trends. Defaults to 15 minutes.
+              # @param [Time] start_date Filter cumulative statistics by a start date. This is
+              #   helpful for defining a range of statistics to capture. Input is a GMT ISO 8601
+              #   Timestamp
+              # @param [Time] end_date Filter cumulative statistics by an end date. This is
+              #   helpful for defining a range of statistics to capture. Input is a GMT ISO 8601
+              #   Timestamp
+              # @param [String] task_channel Filter real-time and cumulative statistics by
+              #   TaskChannel. Takes in a Unique Name ("voice", "sms", "default", etc.) or a
+              #   TaskChannelSid.
+              # @param [String] split_by_wait_time A comma separated values for viewing splits
+              #   of tasks canceled and accepted above the given threshold in seconds. Ex: "5,30"
+              #   would show splits of tasks that were canceled or accepted before or after 5
+              #   seconds and respectively, 30 seconds. This is great for showing short abandoned
+              #   tasks or tasks that failed to meet your SLA.
               # @return [WorkflowStatisticsInstance] Fetched WorkflowStatisticsInstance
               def fetch(minutes: :unset, start_date: :unset, end_date: :unset, task_channel: :unset, split_by_wait_time: :unset)
                 params = Twilio::Values.of({
@@ -198,11 +212,23 @@ module Twilio
 
               ##
               # Fetch a WorkflowStatisticsInstance
-              # @param [String] minutes The minutes
-              # @param [Time] start_date The start_date
-              # @param [Time] end_date The end_date
-              # @param [String] task_channel The task_channel
-              # @param [String] split_by_wait_time The split_by_wait_time
+              # @param [String] minutes Filter cumulative statistics by up to ‘x’ minutes in the
+              #   past. This is helpful for statistics for the last 15 minutes, 240 minutes (4
+              #   hours), and 480 minutes (8 hours) to see trends. Defaults to 15 minutes.
+              # @param [Time] start_date Filter cumulative statistics by a start date. This is
+              #   helpful for defining a range of statistics to capture. Input is a GMT ISO 8601
+              #   Timestamp
+              # @param [Time] end_date Filter cumulative statistics by an end date. This is
+              #   helpful for defining a range of statistics to capture. Input is a GMT ISO 8601
+              #   Timestamp
+              # @param [String] task_channel Filter real-time and cumulative statistics by
+              #   TaskChannel. Takes in a Unique Name ("voice", "sms", "default", etc.) or a
+              #   TaskChannelSid.
+              # @param [String] split_by_wait_time A comma separated values for viewing splits
+              #   of tasks canceled and accepted above the given threshold in seconds. Ex: "5,30"
+              #   would show splits of tasks that were canceled or accepted before or after 5
+              #   seconds and respectively, 30 seconds. This is great for showing short abandoned
+              #   tasks or tasks that failed to meet your SLA.
               # @return [WorkflowStatisticsInstance] Fetched WorkflowStatisticsInstance
               def fetch(minutes: :unset, start_date: :unset, end_date: :unset, task_channel: :unset, split_by_wait_time: :unset)
                 context.fetch(

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 ID of the Workspace that contains this
+            #   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 Human readable description of this Workflow (for
+            #   example "Customer Support" or "2014 Election Campaign")
             # @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 Human readable description of this Workflow (for
+            #   example "Customer Support" or "2014 Election Campaign")
             # @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
@@ -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 Human readable description of this Workflow (for
+            #   example "Customer Support" or "2014 Election Campaign")
             # @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 string representing a human readable name for
+            #   this Workflow. Examples include 'Inbound Call Workflow' or '2014 Outbound
+            #   Campaign'.
+            # @param [String] configuration JSON document configuring the rules for this
+            #   Workflow. See [Configuring
+            #   Workflows](https://www.twilio.com/docs/api/taskrouter/workflow-configuration)
+            #   for more information.
+            # @param [String] assignment_callback_url A valid URL for the application that
+            #   will process task assignment events. See [Handling Task Assignment
+            #   Callback](https://www.twilio.com/docs/api/taskrouter/handling-assignment-callbacks) for more details.
+            # @param [String] fallback_assignment_callback_url If the request to the
+            #   AssignmentCallbackUrl fails, the assignment callback will be made to this URL.
+            # @param [String] task_reservation_timeout An integer value controlling how long
+            #   in seconds TaskRouter will wait for a confirmation response from your
+            #   application after assigning a Task to a worker. See Task Assignment Callback for
+            #   more information. Defaults to 120 seconds. Maximum value is 86400 (24 hours)
             # @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({
@@ -215,12 +231,21 @@ 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 string representing a human readable name for
+            #   this Workflow. Examples include 'Customer Support' or 'Sales Team'.
+            # @param [String] assignment_callback_url A valid URL for the application that
+            #   will process task assignment events. See [Handling Task Assignment
+            #   Callback](https://www.twilio.com/docs/api/taskrouter/handling-assignment-callbacks) for more details.
+            # @param [String] fallback_assignment_callback_url If the request to the
+            #   AssignmentCallbackUrl fails, the assignment callback will be made to this URL.
+            # @param [String] configuration JSON document configuring the rules for this
+            #   Workflow. See [Configuring
+            #   Workflows](https://www.twilio.com/docs/api/taskrouter/workflow-configuration)
+            #   for more information.
+            # @param [String] task_reservation_timeout An integer value controlling how long
+            #   in seconds TaskRouter will wait for a confirmation response from your
+            #   application after assigning a Task to a worker. Defaults to 120 seconds. Maximum
+            #   value is 86400 (24 hours)
             # @return [WorkflowInstance] Updated WorkflowInstance
             def update(friendly_name: :unset, assignment_callback_url: :unset, fallback_assignment_callback_url: :unset, configuration: :unset, task_reservation_timeout: :unset)
               data = Twilio::Values.of({
@@ -289,7 +314,8 @@ 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] workspace_sid The ID of the Workspace that contains this
+            #   Workflow
             # @param [String] sid The sid
             # @return [WorkflowInstance] WorkflowInstance
             def initialize(version, payload, workspace_sid: nil, sid: nil)
@@ -329,31 +355,31 @@ module Twilio
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The ID of the account that owns this Workflow
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The assignment_callback_url
+            # @return [String] The URL that will be called whenever a task managed by this Workflow is assigned to a Worker.
             def assignment_callback_url
               @properties['assignment_callback_url']
             end
 
             ##
-            # @return [String] The configuration
+            # @return [String] JSON document configuring the rules for this Workflow.
             def configuration
               @properties['configuration']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The date this workflow was created.
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The date this workflow was last updated.
             def date_updated
               @properties['date_updated']
             end
@@ -365,31 +391,31 @@ module Twilio
             end
 
             ##
-            # @return [String] The fallback_assignment_callback_url
+            # @return [String] If the request to the AssignmentCallbackUrl fails, the assignment callback will be made to this URL.
             def fallback_assignment_callback_url
               @properties['fallback_assignment_callback_url']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] Human readable description of this Workflow
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique ID of the Workflow
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The task_reservation_timeout
+            # @return [String] Determines how long TaskRouter will wait for a confirmation response from your application after assigning a Task to a worker.
             def task_reservation_timeout
               @properties['task_reservation_timeout']
             end
 
             ##
-            # @return [String] The workspace_sid
+            # @return [String] The ID of the Workspace that contains this Workflow
             def workspace_sid
               @properties['workspace_sid']
             end
@@ -415,12 +441,21 @@ 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 string representing a human readable name for
+            #   this Workflow. Examples include 'Customer Support' or 'Sales Team'.
+            # @param [String] assignment_callback_url A valid URL for the application that
+            #   will process task assignment events. See [Handling Task Assignment
+            #   Callback](https://www.twilio.com/docs/api/taskrouter/handling-assignment-callbacks) for more details.
+            # @param [String] fallback_assignment_callback_url If the request to the
+            #   AssignmentCallbackUrl fails, the assignment callback will be made to this URL.
+            # @param [String] configuration JSON document configuring the rules for this
+            #   Workflow. See [Configuring
+            #   Workflows](https://www.twilio.com/docs/api/taskrouter/workflow-configuration)
+            #   for more information.
+            # @param [String] task_reservation_timeout An integer value controlling how long
+            #   in seconds TaskRouter will wait for a confirmation response from your
+            #   application after assigning a Task to a worker. Defaults to 120 seconds. Maximum
+            #   value is 86400 (24 hours)
             # @return [WorkflowInstance] Updated WorkflowInstance
             def update(friendly_name: :unset, assignment_callback_url: :unset, fallback_assignment_callback_url: :unset, configuration: :unset, task_reservation_timeout: :unset)
               context.update(