twilio-ruby 5.8.1 → 5.9.0

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST

data/lib/twilio-ruby/rest/taskrouter/v1/workspace/task_queue/task_queue_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 TaskQueueCumulativeStatisticsInstance
-              # @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 [TaskQueueCumulativeStatisticsInstance] Fetched TaskQueueCumulativeStatisticsInstance
               def fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset)
                 params = Twilio::Values.of({
@@ -182,7 +196,7 @@ module Twilio
               end
 
               ##
-              # @return [String] The avg_task_acceptance_time
+              # @return [String] The average time from Task creation to reservation acceptance while in this TaskQueue
               def avg_task_acceptance_time
                 @properties['avg_task_acceptance_time']
               end
@@ -200,43 +214,43 @@ module Twilio
               end
 
               ##
-              # @return [String] The reservations_created
+              # @return [String] The total number of Reservations that were created for Tasks while in this TaskQueue
               def reservations_created
                 @properties['reservations_created']
               end
 
               ##
-              # @return [String] The reservations_accepted
+              # @return [String] The total number of Reservations that were accepted for Tasks while in this TaskQueue
               def reservations_accepted
                 @properties['reservations_accepted']
               end
 
               ##
-              # @return [String] The reservations_rejected
+              # @return [String] The total number of Reservations that were rejected for Tasks while in this TaskQueue
               def reservations_rejected
                 @properties['reservations_rejected']
               end
 
               ##
-              # @return [String] The reservations_timed_out
+              # @return [String] The total number of Reservations that were timed out for Tasks while in this TaskQueue
               def reservations_timed_out
                 @properties['reservations_timed_out']
               end
 
               ##
-              # @return [String] The reservations_canceled
+              # @return [String] The total number of Reservations that were canceled for Tasks while in this TaskQueue
               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
@@ -248,43 +262,43 @@ module Twilio
               end
 
               ##
-              # @return [Hash] The wait_duration_until_accepted
+              # @return [Hash] The wait duration stats for tasks that were accepted while in this TaskQueue
               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 while in this TaskQueue
               def wait_duration_until_canceled
                 @properties['wait_duration_until_canceled']
               end
 
               ##
-              # @return [String] The tasks_canceled
+              # @return [String] The total number of Tasks canceled while in this TaskQueue
               def tasks_canceled
                 @properties['tasks_canceled']
               end
 
               ##
-              # @return [String] The tasks_completed
+              # @return [String] The total number of Tasks completed while in this TaskQueue
               def tasks_completed
                 @properties['tasks_completed']
               end
 
               ##
-              # @return [String] The tasks_deleted
+              # @return [String] The total number of Tasks that were deleted while in this TaskQueue
               def tasks_deleted
                 @properties['tasks_deleted']
               end
 
               ##
-              # @return [String] The tasks_entered
+              # @return [String] The total number of Tasks entered into this TaskQueue
               def tasks_entered
                 @properties['tasks_entered']
               end
 
               ##
-              # @return [String] The tasks_moved
+              # @return [String] The total number of Tasks moved to another TaskQueue from this TaskQueue
               def tasks_moved
                 @properties['tasks_moved']
               end
@@ -303,11 +317,23 @@ module Twilio
 
               ##
               # Fetch a TaskQueueCumulativeStatisticsInstance
-              # @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 [TaskQueueCumulativeStatisticsInstance] Fetched TaskQueueCumulativeStatisticsInstance
               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_queue_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 TaskQueueRealTimeStatisticsInstance
-              # @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 [TaskQueueRealTimeStatisticsInstance] Fetched TaskQueueRealTimeStatisticsInstance
               def fetch(task_channel: :unset)
                 params = Twilio::Values.of({'TaskChannel' => task_channel, })
@@ -162,13 +166,13 @@ module Twilio
               end
 
               ##
-              # @return [Hash] The activity_statistics
+              # @return [Hash] The current Worker status count breakdown by Activity
               def activity_statistics
                 @properties['activity_statistics']
               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
@@ -180,31 +184,31 @@ module Twilio
               end
 
               ##
-              # @return [Hash] The tasks_by_priority
+              # @return [Hash] The Tasks broken down by priority
               def tasks_by_priority
                 @properties['tasks_by_priority']
               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_available_workers
+              # @return [String] The total number of Workers available for Tasks in this TaskQueue
               def total_available_workers
                 @properties['total_available_workers']
               end
 
               ##
-              # @return [String] The total_eligible_workers
+              # @return [String] The total number of Workers eligible for Tasks in this TaskQueue, irrespective of Activity state.
               def total_eligible_workers
                 @properties['total_eligible_workers']
               end
 
               ##
-              # @return [String] The total_tasks
+              # @return [String] The total number of Tasks
               def total_tasks
                 @properties['total_tasks']
               end
@@ -223,7 +227,9 @@ module Twilio
 
               ##
               # Fetch a TaskQueueRealTimeStatisticsInstance
-              # @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 [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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -82,11 +84,23 @@ module Twilio
 
               ##
               # Fetch a TaskQueueStatisticsInstance
-              # @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 [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({
@@ -198,11 +212,23 @@ module Twilio
 
               ##
               # Fetch a TaskQueueStatisticsInstance
-              # @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 [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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -14,7 +16,7 @@ module Twilio
               ##
               # Initialize the TaskQueuesStatisticsList
               # @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 owns this TaskQueue
               # @return [TaskQueuesStatisticsList] TaskQueuesStatisticsList
               def initialize(version, workspace_sid: nil)
                 super(version)
@@ -28,12 +30,25 @@ 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 The end_date
-              # @param [String] friendly_name The friendly_name
-              # @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] 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 [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
@@ -58,12 +73,25 @@ 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 The end_date
-              # @param [String] friendly_name The friendly_name
-              # @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] 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 [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
@@ -104,12 +132,25 @@ module Twilio
               ##
               # Retrieve a single page of TaskQueuesStatisticsInstance records from the API.
               # Request is executed immediately.
-              # @param [Time] end_date The end_date
-              # @param [String] friendly_name The friendly_name
-              # @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] 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 [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
@@ -188,7 +229,7 @@ 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 workspace_sid
+              # @param [String] workspace_sid The ID of the Workspace that owns this TaskQueue
               # @return [TaskQueuesStatisticsInstance] TaskQueuesStatisticsInstance
               def initialize(version, payload, workspace_sid: nil)
                 super(version)