twilio-ruby 5.27.0 → 5.27.1

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

@@ -15,8 +15,8 @@ module Twilio
             ##
             # Initialize the WorkflowList
             # @param [Version] version Version that contains the resource
-            # @param [String] workspace_sid The ID of the Workspace that contains this
-            #   Workflow
+            # @param [String] workspace_sid The SID of the Workspace that contains the
+            #   Workflow.
             # @return [WorkflowList] WorkflowList
             def initialize(version, workspace_sid: nil)
               super(version)
@@ -30,8 +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 Human readable description of this Workflow (for
-            #   example "Customer Support" or "2014 Election Campaign")
+            # @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
@@ -47,8 +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 Human readable description of this Workflow (for
-            #   example "Customer Support" or "2014 Election Campaign")
+            # @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
@@ -81,8 +81,8 @@ module Twilio
             ##
             # Retrieve a single page of WorkflowInstance records from the API.
             # Request is executed immediately.
-            # @param [String] friendly_name Human readable description of this Workflow (for
-            #   example "Customer Support" or "2014 Election Campaign")
+            # @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
@@ -118,22 +118,22 @@ module Twilio
             ##
             # Retrieve a single page of WorkflowInstance records from the API.
             # Request is executed immediately.
-            # @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)
+            # @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({
@@ -193,8 +193,9 @@ 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)
@@ -231,21 +232,22 @@ module Twilio
 
             ##
             # Update the WorkflowInstance
-            # @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)
+            # @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`.
             # @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({
@@ -321,9 +323,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 ID of the Workspace that contains this
-            #   Workflow
-            # @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)
@@ -362,79 +364,79 @@ module Twilio
             end
 
             ##
-            # @return [String] The ID of the account that owns this Workflow
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The URL that will be called whenever a task managed by this Workflow is assigned to a Worker.
+            # @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] JSON document configuring the rules for this Workflow.
+            # @return [String] A JSON string that contains the Workflow's configuration
             def configuration
               @properties['configuration']
             end
 
             ##
-            # @return [Time] The date this workflow was 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 this workflow was last 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] If the request to the AssignmentCallbackUrl fails, the assignment callback will be made to this 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] Human readable description of this Workflow
+            # @return [String] The string that you assigned to describe the Workflow resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The unique ID of the Workflow
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] Determines how long TaskRouter will wait for a confirmation response from your application after assigning a Task to a worker.
+            # @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 ID of the Workspace that contains this Workflow
+            # @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
@@ -448,21 +450,22 @@ module Twilio
 
             ##
             # Update the WorkflowInstance
-            # @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)
+            # @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`.
             # @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(

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

@@ -16,8 +16,10 @@ module Twilio
               ##
               # Initialize the WorkflowCumulativeStatisticsList
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
-              # @param [String] workflow_sid The workflow_sid
+              # @param [String] workspace_sid The SID of the Workspace that contains the
+              #   Workflow.
+              # @param [String] workflow_sid Returns the list of Tasks that are being controlled
+              #   by the Workflow with the specified Sid value.
               # @return [WorkflowCumulativeStatisticsList] WorkflowCumulativeStatisticsList
               def initialize(version, workspace_sid: nil, workflow_sid: nil)
                 super(version)
@@ -71,8 +73,10 @@ module Twilio
               ##
               # Initialize the WorkflowCumulativeStatisticsContext
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
-              # @param [String] workflow_sid The workflow_sid
+              # @param [String] workspace_sid The SID of the Workspace with the resource to
+              #   fetch.
+              # @param [String] workflow_sid Returns the list of Tasks that are being controlled
+              #   by the Workflow with the specified Sid value.
               # @return [WorkflowCumulativeStatisticsContext] WorkflowCumulativeStatisticsContext
               def initialize(version, workspace_sid, workflow_sid)
                 super(version)
@@ -84,23 +88,24 @@ module Twilio
 
               ##
               # Fetch a WorkflowCumulativeStatisticsInstance
-              # @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.
+              # @param [Time] end_date Only include usage that occurred on or before this date,
+              #   specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+              #   date-time.
+              # @param [String] minutes Only calculate statistics since this many minutes in the
+              #   past. The default 15 minutes. This is helpful for displaying statistics for the
+              #   last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.
+              # @param [Time] start_date Only calculate statistics from this date and time and
+              #   later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+              # @param [String] task_channel Only calculate cumulative statistics on this
+              #   TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`,
+              #   `sms`, or `default`.
+              # @param [String] split_by_wait_time A comma separated list of values that
+              #   describes the thresholds, in seconds, to calculate statistics on. For each
+              #   threshold specified, the number of Tasks canceled and reservations accepted
+              #   above and below the specified thresholds in seconds are computed. For example,
+              #   `5,30` would show splits of Tasks that were canceled or accepted before and
+              #   after 5 seconds and before and after 30 seconds. This can be used to show short
+              #   abandoned Tasks or Tasks that failed to meet an 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({
@@ -145,8 +150,10 @@ module Twilio
               # Initialize the WorkflowCumulativeStatisticsInstance
               # @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] workflow_sid The workflow_sid
+              # @param [String] workspace_sid The SID of the Workspace that contains the
+              #   Workflow.
+              # @param [String] workflow_sid Returns the list of Tasks that are being controlled
+              #   by the Workflow with the specified Sid value.
               # @return [WorkflowCumulativeStatisticsInstance] WorkflowCumulativeStatisticsInstance
               def initialize(version, payload, workspace_sid: nil, workflow_sid: nil)
                 super(version)
@@ -198,25 +205,25 @@ module Twilio
               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 average time from Task creation to acceptance
+              # @return [String] The average time in seconds between Task creation and acceptance
               def avg_task_acceptance_time
                 @properties['avg_task_acceptance_time']
               end
 
               ##
-              # @return [Time] The start_time
+              # @return [Time] The beginning of the interval during which these statistics were calculated
               def start_time
                 @properties['start_time']
               end
 
               ##
-              # @return [Time] The end_time
+              # @return [Time] The end of the interval during which these statistics were calculated
               def end_time
                 @properties['end_time']
               end
@@ -258,19 +265,19 @@ module Twilio
               end
 
               ##
-              # @return [Hash] The splits of the tasks canceled and accepted based on the provided SplitByWaitTime parameter.
+              # @return [Hash] A list of objects that describe the Tasks canceled and reservations accepted above and below the specified thresholds
               def split_by_wait_time
                 @properties['split_by_wait_time']
               end
 
               ##
-              # @return [Hash] The wait duration stats for tasks that were accepted.
+              # @return [Hash] The wait duration statistics for Tasks that were accepted
               def wait_duration_until_accepted
                 @properties['wait_duration_until_accepted']
               end
 
               ##
-              # @return [Hash] The wait duration stats for tasks that were canceled.
+              # @return [Hash] The wait duration statistics for Tasks that were canceled
               def wait_duration_until_canceled
                 @properties['wait_duration_until_canceled']
               end
@@ -288,7 +295,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The total number of Tasks that entered this Workflow
+              # @return [String] The total number of Tasks that entered the Workflow
               def tasks_entered
                 @properties['tasks_entered']
               end
@@ -312,42 +319,43 @@ module Twilio
               end
 
               ##
-              # @return [String] The workflow_sid
+              # @return [String] Returns the list of Tasks that are being controlled by the Workflow with the specified Sid value
               def workflow_sid
                 @properties['workflow_sid']
               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 statistics resource
               def url
                 @properties['url']
               end
 
               ##
               # Fetch a WorkflowCumulativeStatisticsInstance
-              # @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.
+              # @param [Time] end_date Only include usage that occurred on or before this date,
+              #   specified in GMT as an [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601)
+              #   date-time.
+              # @param [String] minutes Only calculate statistics since this many minutes in the
+              #   past. The default 15 minutes. This is helpful for displaying statistics for the
+              #   last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.
+              # @param [Time] start_date Only calculate statistics from this date and time and
+              #   later, specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
+              # @param [String] task_channel Only calculate cumulative statistics on this
+              #   TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`,
+              #   `sms`, or `default`.
+              # @param [String] split_by_wait_time A comma separated list of values that
+              #   describes the thresholds, in seconds, to calculate statistics on. For each
+              #   threshold specified, the number of Tasks canceled and reservations accepted
+              #   above and below the specified thresholds in seconds are computed. For example,
+              #   `5,30` would show splits of Tasks that were canceled or accepted before and
+              #   after 5 seconds and before and after 30 seconds. This can be used to show short
+              #   abandoned Tasks or Tasks that failed to meet an 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(