twilio-ruby 5.27.0 → 5.27.1

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

@@ -16,8 +16,10 @@ module Twilio
               ##
               # Initialize the TaskQueueRealTimeStatisticsList
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
-              # @param [String] task_queue_sid The task_queue_sid
+              # @param [String] workspace_sid The SID of the Workspace that contains the
+              #   TaskQueue.
+              # @param [String] task_queue_sid The SID of the TaskQueue from which these
+              #   statistics were calculated.
               # @return [TaskQueueRealTimeStatisticsList] TaskQueueRealTimeStatisticsList
               def initialize(version, workspace_sid: nil, task_queue_sid: nil)
                 super(version)
@@ -71,8 +73,10 @@ module Twilio
               ##
               # Initialize the TaskQueueRealTimeStatisticsContext
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
-              # @param [String] task_queue_sid The task_queue_sid
+              # @param [String] workspace_sid The SID of the Workspace with the TaskQueue to
+              #   fetch.
+              # @param [String] task_queue_sid The SID of the TaskQueue for which to fetch
+              #   statistics.
               # @return [TaskQueueRealTimeStatisticsContext] TaskQueueRealTimeStatisticsContext
               def initialize(version, workspace_sid, task_queue_sid)
                 super(version)
@@ -84,9 +88,9 @@ module Twilio
 
               ##
               # Fetch a TaskQueueRealTimeStatisticsInstance
-              # @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] task_channel The TaskChannel for which to fetch statistics. Can
+              #   be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or
+              #   `default`.
               # @return [TaskQueueRealTimeStatisticsInstance] Fetched TaskQueueRealTimeStatisticsInstance
               def fetch(task_channel: :unset)
                 params = Twilio::Values.of({'TaskChannel' => task_channel, })
@@ -125,8 +129,10 @@ module Twilio
               # Initialize the TaskQueueRealTimeStatisticsInstance
               # @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] task_queue_sid The task_queue_sid
+              # @param [String] workspace_sid The SID of the Workspace that contains the
+              #   TaskQueue.
+              # @param [String] task_queue_sid The SID of the TaskQueue from which these
+              #   statistics were calculated.
               # @return [TaskQueueRealTimeStatisticsInstance] TaskQueueRealTimeStatisticsInstance
               def initialize(version, payload, workspace_sid: nil, task_queue_sid: nil)
                 super(version)
@@ -168,13 +174,13 @@ 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 [Hash] The current Worker status count breakdown by Activity
+              # @return [Hash] The number of current Workers by Activity
               def activity_statistics
                 @properties['activity_statistics']
               end
@@ -192,31 +198,31 @@ module Twilio
               end
 
               ##
-              # @return [String] The task_queue_sid
+              # @return [String] The SID of the TaskQueue from which these statistics were calculated
               def task_queue_sid
                 @properties['task_queue_sid']
               end
 
               ##
-              # @return [Hash] The Tasks broken down by priority
+              # @return [Hash] The number of Tasks by priority
               def tasks_by_priority
                 @properties['tasks_by_priority']
               end
 
               ##
-              # @return [Hash] The Tasks broken down by status
+              # @return [Hash] The number of Tasks by their current status
               def tasks_by_status
                 @properties['tasks_by_status']
               end
 
               ##
-              # @return [String] The total number of Workers available for Tasks in this TaskQueue
+              # @return [String] The total number of Workers available for Tasks in the TaskQueue
               def total_available_workers
                 @properties['total_available_workers']
               end
 
               ##
-              # @return [String] The total number of Workers eligible for Tasks in this TaskQueue, irrespective of Activity state.
+              # @return [String] The total number of Workers eligible for Tasks in the TaskQueue, independent of their Activity state
               def total_eligible_workers
                 @properties['total_eligible_workers']
               end
@@ -228,22 +234,22 @@ module Twilio
               end
 
               ##
-              # @return [String] The workspace_sid
+              # @return [String] The SID of the Workspace that contains the TaskQueue
               def workspace_sid
                 @properties['workspace_sid']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The absolute URL of the TaskQueue statistics resource
               def url
                 @properties['url']
               end
 
               ##
               # Fetch a TaskQueueRealTimeStatisticsInstance
-              # @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] task_channel The TaskChannel for which to fetch statistics. Can
+              #   be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or
+              #   `default`.
               # @return [TaskQueueRealTimeStatisticsInstance] Fetched TaskQueueRealTimeStatisticsInstance
               def fetch(task_channel: :unset)
                 context.fetch(task_channel: task_channel, )

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

@@ -16,8 +16,10 @@ module Twilio
               ##
               # Initialize the TaskQueueStatisticsList
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
-              # @param [String] task_queue_sid The task_queue_sid
+              # @param [String] workspace_sid The SID of the Workspace that contains the
+              #   TaskQueue.
+              # @param [String] task_queue_sid The SID of the TaskQueue from which these
+              #   statistics were calculated.
               # @return [TaskQueueStatisticsList] TaskQueueStatisticsList
               def initialize(version, workspace_sid: nil, task_queue_sid: nil)
                 super(version)
@@ -71,8 +73,10 @@ module Twilio
               ##
               # Initialize the TaskQueueStatisticsContext
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
-              # @param [String] task_queue_sid The task_queue_sid
+              # @param [String] workspace_sid The SID of the Workspace with the TaskQueue to
+              #   fetch.
+              # @param [String] task_queue_sid The SID of the TaskQueue for which to fetch
+              #   statistics.
               # @return [TaskQueueStatisticsContext] TaskQueueStatisticsContext
               def initialize(version, workspace_sid, task_queue_sid)
                 super(version)
@@ -84,23 +88,20 @@ module Twilio
 
               ##
               # Fetch a TaskQueueStatisticsInstance
-              # @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 calculate statistics from this date and time and
+              #   earlier, 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 is 15 minutes.
+              # @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 real-time and cumulative statistics
+              #   for the specified 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.
               # @return [TaskQueueStatisticsInstance] Fetched TaskQueueStatisticsInstance
               def fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset)
                 params = Twilio::Values.of({
@@ -145,8 +146,10 @@ module Twilio
               # Initialize the TaskQueueStatisticsInstance
               # @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] task_queue_sid The task_queue_sid
+              # @param [String] workspace_sid The SID of the Workspace that contains the
+              #   TaskQueue.
+              # @param [String] task_queue_sid The SID of the TaskQueue from which these
+              #   statistics were calculated.
               # @return [TaskQueueStatisticsInstance] TaskQueueStatisticsInstance
               def initialize(version, payload, workspace_sid: nil, task_queue_sid: nil)
                 super(version)
@@ -182,60 +185,57 @@ 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 [Hash] The cumulative
+              # @return [Hash] An object that contains the cumulative statistics for the TaskQueue
               def cumulative
                 @properties['cumulative']
               end
 
               ##
-              # @return [Hash] The realtime
+              # @return [Hash] An object that contains the real-time statistics for the TaskQueue
               def realtime
                 @properties['realtime']
               end
 
               ##
-              # @return [String] The task_queue_sid
+              # @return [String] The SID of the TaskQueue from which these statistics were calculated
               def task_queue_sid
                 @properties['task_queue_sid']
               end
 
               ##
-              # @return [String] The workspace_sid
+              # @return [String] The SID of the Workspace that contains the TaskQueue
               def workspace_sid
                 @properties['workspace_sid']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The absolute URL of the TaskQueue statistics resource
               def url
                 @properties['url']
               end
 
               ##
               # Fetch a TaskQueueStatisticsInstance
-              # @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 calculate statistics from this date and time and
+              #   earlier, 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 is 15 minutes.
+              # @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 real-time and cumulative statistics
+              #   for the specified 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.
               # @return [TaskQueueStatisticsInstance] Fetched TaskQueueStatisticsInstance
               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/task_queue/task_queues_statistics.rb

@@ -16,7 +16,8 @@ module Twilio
               ##
               # Initialize the TaskQueuesStatisticsList
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The ID of the Workspace that owns this TaskQueue
+              # @param [String] workspace_sid The SID of the Workspace that contains the
+              #   TaskQueue.
               # @return [TaskQueuesStatisticsList] TaskQueuesStatisticsList
               def initialize(version, workspace_sid: nil)
                 super(version)
@@ -30,25 +31,22 @@ module Twilio
               # Lists TaskQueuesStatisticsInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @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] friendly_name Filter the TaskQueue stats based on a TaskQueue's
-              #   name (only for list resource)
-              # @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 calculate statistics from this date and time and
+              #   earlier, specified in GMT as an [ISO
+              #   8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
+              # @param [String] friendly_name The `friendly_name` of the TaskQueue statistics to
+              #   read.
+              # @param [String] minutes Only calculate statistics since this many minutes in the
+              #   past. The default is 15 minutes.
+              # @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 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.
               # @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
@@ -73,25 +71,22 @@ module Twilio
               # Streams TaskQueuesStatisticsInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @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] friendly_name Filter the TaskQueue stats based on a TaskQueue's
-              #   name (only for list resource)
-              # @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 calculate statistics from this date and time and
+              #   earlier, specified in GMT as an [ISO
+              #   8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
+              # @param [String] friendly_name The `friendly_name` of the TaskQueue statistics to
+              #   read.
+              # @param [String] minutes Only calculate statistics since this many minutes in the
+              #   past. The default is 15 minutes.
+              # @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 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.
               # @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
@@ -132,25 +127,22 @@ module Twilio
               ##
               # Retrieve a single page of TaskQueuesStatisticsInstance records from the API.
               # Request is executed immediately.
-              # @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] friendly_name Filter the TaskQueue stats based on a TaskQueue's
-              #   name (only for list resource)
-              # @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 calculate statistics from this date and time and
+              #   earlier, specified in GMT as an [ISO
+              #   8601](https://en.wikipedia.org/wiki/ISO_8601) date-time.
+              # @param [String] friendly_name The `friendly_name` of the TaskQueue statistics to
+              #   read.
+              # @param [String] minutes Only calculate statistics since this many minutes in the
+              #   past. The default is 15 minutes.
+              # @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 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.
               # @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
@@ -229,7 +221,8 @@ module Twilio
               # Initialize the TaskQueuesStatisticsInstance
               # @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 owns this TaskQueue
+              # @param [String] workspace_sid The SID of the Workspace that contains the
+              #   TaskQueue.
               # @return [TaskQueuesStatisticsInstance] TaskQueuesStatisticsInstance
               def initialize(version, payload, workspace_sid: nil)
                 super(version)
@@ -245,31 +238,31 @@ 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 [Hash] The cumulative
+              # @return [Hash] An object that contains the cumulative statistics for the TaskQueues
               def cumulative
                 @properties['cumulative']
               end
 
               ##
-              # @return [Hash] The realtime
+              # @return [Hash] An object that contains the real-time statistics for the TaskQueues
               def realtime
                 @properties['realtime']
               end
 
               ##
-              # @return [String] The task_queue_sid
+              # @return [String] The SID of the TaskQueue from which these statistics were calculated
               def task_queue_sid
                 @properties['task_queue_sid']
               end
 
               ##
-              # @return [String] The workspace_sid
+              # @return [String] The SID of the Workspace that contains the TaskQueues
               def workspace_sid
                 @properties['workspace_sid']
               end