twilio-ruby 5.8.1 → 5.9.0

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -82,10 +84,17 @@ module Twilio
 
               ##
               # Fetch a WorkerStatisticsInstance
-              # @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] 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 string of the
+              #   format: yyyy-MM-dd’T’HH:mm:ss’Z’.
+              # @param [Time] end_date Filter cumulative statistics by a end date. This is
+              #   helpful for defining a range of statistics to capture. Input is a string of the
+              #   format: yyyy-MM-dd’T’HH:mm:ss’Z’.
+              # @param [String] task_channel Filter cumulative statistics by TaskChannel. Takes
+              #   in a Unique Name ("voice", "sms", "default", etc.) or a TaskChannelSid.
               # @return [WorkerStatisticsInstance] Fetched WorkerStatisticsInstance
               def fetch(minutes: :unset, start_date: :unset, end_date: :unset, task_channel: :unset)
                 params = Twilio::Values.of({
@@ -189,10 +198,17 @@ module Twilio
 
               ##
               # Fetch a WorkerStatisticsInstance
-              # @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] 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 string of the
+              #   format: yyyy-MM-dd’T’HH:mm:ss’Z’.
+              # @param [Time] end_date Filter cumulative statistics by a end date. This is
+              #   helpful for defining a range of statistics to capture. Input is a string of the
+              #   format: yyyy-MM-dd’T’HH:mm:ss’Z’.
+              # @param [String] task_channel Filter cumulative statistics by TaskChannel. Takes
+              #   in a Unique Name ("voice", "sms", "default", etc.) or a TaskChannelSid.
               # @return [WorkerStatisticsInstance] Fetched WorkerStatisticsInstance
               def fetch(minutes: :unset, start_date: :unset, end_date: :unset, task_channel: :unset)
                 context.fetch(

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -75,10 +77,17 @@ module Twilio
 
               ##
               # Fetch a WorkersCumulativeStatisticsInstance
-              # @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 [Time] end_date Filter cumulative statistics by a end date. This is
+              #   helpful for defining a range of statistics to capture. Input is a string of the
+              #   format: yyyy-MM-dd’T’HH:mm:ss’Z’.
+              # @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 string of the
+              #   format: yyyy-MM-dd’T’HH:mm:ss’Z’.
+              # @param [String] task_channel Filter cumulative statistics by TaskChannel. Takes
+              #   in a Unique Name ("voice", "sms", "default", etc.) or a TaskChannelSid.
               # @return [WorkersCumulativeStatisticsInstance] Fetched WorkersCumulativeStatisticsInstance
               def fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset)
                 params = Twilio::Values.of({
@@ -166,43 +175,43 @@ module Twilio
               end
 
               ##
-              # @return [Hash] The activity_durations
+              # @return [Hash] The minimum, average, maximum and total time Workers spent in each Activity
               def activity_durations
                 @properties['activity_durations']
               end
 
               ##
-              # @return [String] The reservations_created
+              # @return [String] The total number of Reservations that were created
               def reservations_created
                 @properties['reservations_created']
               end
 
               ##
-              # @return [String] The reservations_accepted
+              # @return [String] The total number of Reservations that were accepted
               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
@@ -221,10 +230,17 @@ module Twilio
 
               ##
               # Fetch a WorkersCumulativeStatisticsInstance
-              # @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 [Time] end_date Filter cumulative statistics by a end date. This is
+              #   helpful for defining a range of statistics to capture. Input is a string of the
+              #   format: yyyy-MM-dd’T’HH:mm:ss’Z’.
+              # @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 string of the
+              #   format: yyyy-MM-dd’T’HH:mm:ss’Z’.
+              # @param [String] task_channel Filter cumulative statistics by TaskChannel. Takes
+              #   in a Unique Name ("voice", "sms", "default", etc.) or a TaskChannelSid.
               # @return [WorkersCumulativeStatisticsInstance] Fetched WorkersCumulativeStatisticsInstance
               def fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset)
                 context.fetch(

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -75,7 +77,8 @@ module Twilio
 
               ##
               # Fetch a WorkersRealTimeStatisticsInstance
-              # @param [String] task_channel The task_channel
+              # @param [String] task_channel Filter cumulative statistics by TaskChannel. Takes
+              #   in a Unique Name ("voice", "sms", "default", etc.) or a TaskChannelSid.
               # @return [WorkersRealTimeStatisticsInstance] Fetched WorkersRealTimeStatisticsInstance
               def fetch(task_channel: :unset)
                 params = Twilio::Values.of({'TaskChannel' => task_channel, })
@@ -139,13 +142,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 total_workers
+              # @return [String] The total number of Workers
               def total_workers
                 @properties['total_workers']
               end
@@ -164,7 +167,8 @@ module Twilio
 
               ##
               # Fetch a WorkersRealTimeStatisticsInstance
-              # @param [String] task_channel The task_channel
+              # @param [String] task_channel Filter cumulative statistics by TaskChannel. Takes
+              #   in a Unique Name ("voice", "sms", "default", etc.) or a TaskChannelSid.
               # @return [WorkersRealTimeStatisticsInstance] Fetched WorkersRealTimeStatisticsInstance
               def fetch(task_channel: :unset)
                 context.fetch(task_channel: task_channel, )

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -14,7 +16,8 @@ module Twilio
               ##
               # Initialize the WorkersStatisticsList
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
+              # @param [String] workspace_sid The ID of the Workflow this worker is associated
+              #   with
               # @return [WorkersStatisticsList] WorkersStatisticsList
               def initialize(version, workspace_sid: nil)
                 super(version)
@@ -75,13 +78,22 @@ module Twilio
 
               ##
               # Fetch a WorkersStatisticsInstance
-              # @param [String] minutes The minutes
-              # @param [Time] start_date The start_date
-              # @param [Time] end_date The end_date
-              # @param [String] task_queue_sid The task_queue_sid
-              # @param [String] task_queue_name The task_queue_name
+              # @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 string of the
+              #   format: yyyy-MM-dd’T’HH:mm:ss’Z’.
+              # @param [Time] end_date Filter cumulative statistics by a end date. This is
+              #   helpful for defining a range of statistics to capture. Input is a string of the
+              #   format: yyyy-MM-dd’T’HH:mm:ss’Z’.
+              # @param [String] task_queue_sid Filter the real-time and cumulative statistics
+              #   based on Workers tied to a particular queue
+              # @param [String] task_queue_name Filter the real-time and cumulative statistics
+              #   based on Workers tied to a particular queue
               # @param [String] friendly_name The friendly_name
-              # @param [String] task_channel The task_channel
+              # @param [String] task_channel Filter cumulative statistics by TaskChannel. Takes
+              #   in a Unique Name ("voice", "sms", "default", etc.) or a TaskChannelSid.
               # @return [WorkersStatisticsInstance] Fetched WorkersStatisticsInstance
               def fetch(minutes: :unset, start_date: :unset, end_date: :unset, task_queue_sid: :unset, task_queue_name: :unset, friendly_name: :unset, task_channel: :unset)
                 params = Twilio::Values.of({
@@ -116,7 +128,8 @@ module Twilio
               # Initialize the WorkersStatisticsInstance
               # @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 Workflow this worker is associated
+              #   with
               # @return [WorkersStatisticsInstance] WorkersStatisticsInstance
               def initialize(version, payload, workspace_sid: nil)
                 super(version)
@@ -178,13 +191,22 @@ module Twilio
 
               ##
               # Fetch a WorkersStatisticsInstance
-              # @param [String] minutes The minutes
-              # @param [Time] start_date The start_date
-              # @param [Time] end_date The end_date
-              # @param [String] task_queue_sid The task_queue_sid
-              # @param [String] task_queue_name The task_queue_name
+              # @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 string of the
+              #   format: yyyy-MM-dd’T’HH:mm:ss’Z’.
+              # @param [Time] end_date Filter cumulative statistics by a end date. This is
+              #   helpful for defining a range of statistics to capture. Input is a string of the
+              #   format: yyyy-MM-dd’T’HH:mm:ss’Z’.
+              # @param [String] task_queue_sid Filter the real-time and cumulative statistics
+              #   based on Workers tied to a particular queue
+              # @param [String] task_queue_name Filter the real-time and cumulative statistics
+              #   based on Workers tied to a particular queue
               # @param [String] friendly_name The friendly_name
-              # @param [String] task_channel The task_channel
+              # @param [String] task_channel Filter cumulative statistics by TaskChannel. Takes
+              #   in a Unique Name ("voice", "sms", "default", etc.) or a TaskChannelSid.
               # @return [WorkersStatisticsInstance] Fetched WorkersStatisticsInstance
               def fetch(minutes: :unset, start_date: :unset, end_date: :unset, task_queue_sid: :unset, task_queue_name: :unset, friendly_name: :unset, task_channel: :unset)
                 context.fetch(

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+# 
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,7 +15,8 @@ module Twilio
             ##
             # Initialize the WorkerList
             # @param [Version] version Version that contains the resource
-            # @param [String] workspace_sid The workspace_sid
+            # @param [String] workspace_sid The ID of the Workflow this worker is associated
+            #   with
             # @return [WorkerList] WorkerList
             def initialize(version, workspace_sid: nil)
               super(version)
@@ -30,13 +33,21 @@ module Twilio
             # Lists WorkerInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
-            # @param [String] activity_name The activity_name
-            # @param [String] activity_sid The activity_sid
-            # @param [String] available The available
-            # @param [String] friendly_name The friendly_name
-            # @param [String] target_workers_expression The target_workers_expression
-            # @param [String] task_queue_name The task_queue_name
-            # @param [String] task_queue_sid The task_queue_sid
+            # @param [String] activity_name Filter by workers that are in a particular
+            #   Activity by Friendly Name
+            # @param [String] activity_sid Filter by workers that are in a particular Activity
+            #   by SID
+            # @param [String] available Filter by workers that are available or unavailable.
+            #   (Note: This can be ‘true’, ‘1’’ or ‘yes’ to indicate a true value. All other
+            #   values will represent false)
+            # @param [String] friendly_name Filter by a worker’s friendly name
+            # @param [String] target_workers_expression Filter by workers that would match an
+            #   expression on a TaskQueue. This is helpful for debugging which workers would
+            #   match a potential queue.
+            # @param [String] task_queue_name Filter by workers that are eligible for a
+            #   TaskQueue by Friendly Name
+            # @param [String] task_queue_sid Filter by workers that are eligible for a
+            #   TaskQueue by SID
             # @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
@@ -62,13 +73,21 @@ module Twilio
             # Streams WorkerInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
-            # @param [String] activity_name The activity_name
-            # @param [String] activity_sid The activity_sid
-            # @param [String] available The available
-            # @param [String] friendly_name The friendly_name
-            # @param [String] target_workers_expression The target_workers_expression
-            # @param [String] task_queue_name The task_queue_name
-            # @param [String] task_queue_sid The task_queue_sid
+            # @param [String] activity_name Filter by workers that are in a particular
+            #   Activity by Friendly Name
+            # @param [String] activity_sid Filter by workers that are in a particular Activity
+            #   by SID
+            # @param [String] available Filter by workers that are available or unavailable.
+            #   (Note: This can be ‘true’, ‘1’’ or ‘yes’ to indicate a true value. All other
+            #   values will represent false)
+            # @param [String] friendly_name Filter by a worker’s friendly name
+            # @param [String] target_workers_expression Filter by workers that would match an
+            #   expression on a TaskQueue. This is helpful for debugging which workers would
+            #   match a potential queue.
+            # @param [String] task_queue_name Filter by workers that are eligible for a
+            #   TaskQueue by Friendly Name
+            # @param [String] task_queue_sid Filter by workers that are eligible for a
+            #   TaskQueue by SID
             # @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
@@ -110,13 +129,21 @@ module Twilio
             ##
             # Retrieve a single page of WorkerInstance records from the API.
             # Request is executed immediately.
-            # @param [String] activity_name The activity_name
-            # @param [String] activity_sid The activity_sid
-            # @param [String] available The available
-            # @param [String] friendly_name The friendly_name
-            # @param [String] target_workers_expression The target_workers_expression
-            # @param [String] task_queue_name The task_queue_name
-            # @param [String] task_queue_sid The task_queue_sid
+            # @param [String] activity_name Filter by workers that are in a particular
+            #   Activity by Friendly Name
+            # @param [String] activity_sid Filter by workers that are in a particular Activity
+            #   by SID
+            # @param [String] available Filter by workers that are available or unavailable.
+            #   (Note: This can be ‘true’, ‘1’’ or ‘yes’ to indicate a true value. All other
+            #   values will represent false)
+            # @param [String] friendly_name Filter by a worker’s friendly name
+            # @param [String] target_workers_expression Filter by workers that would match an
+            #   expression on a TaskQueue. This is helpful for debugging which workers would
+            #   match a potential queue.
+            # @param [String] task_queue_name Filter by workers that are eligible for a
+            #   TaskQueue by Friendly Name
+            # @param [String] task_queue_sid Filter by workers that are eligible for a
+            #   TaskQueue by SID
             # @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
@@ -158,9 +185,15 @@ module Twilio
             ##
             # Retrieve a single page of WorkerInstance records from the API.
             # Request is executed immediately.
-            # @param [String] friendly_name The friendly_name
-            # @param [String] activity_sid The activity_sid
-            # @param [String] attributes The attributes
+            # @param [String] friendly_name String representing user-friendly name for the
+            #   Worker.
+            # @param [String] activity_sid A valid Activity describing the worker's initial
+            #   state. See Activities for more information. If not provided, new Workers will be
+            #   use the DefaultActivitySid configured on the Workspace.
+            # @param [String] attributes JSON object describing this worker. For example: `{
+            #   'email: 'Bob@foo.com', 'phone': '8675309' }`. This data will be passed to the
+            #   Assignment Callback URL whenever TaskRouter assigns a Task to this worker.
+            #   Defaults to {}.
             # @return [WorkerInstance] Newly created WorkerInstance
             def create(friendly_name: nil, activity_sid: :unset, attributes: :unset)
               data = Twilio::Values.of({
@@ -381,7 +414,8 @@ module Twilio
             # Initialize the WorkerInstance
             # @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 Workflow this worker is associated
+            #   with
             # @param [String] sid The sid
             # @return [WorkerInstance] WorkerInstance
             def initialize(version, payload, workspace_sid: nil, sid: nil)
@@ -421,67 +455,67 @@ module Twilio
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The ID of the account that owns this worker
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The activity_name
+            # @return [String] Filter by workers that are in a particular Activity by Friendly Name
             def activity_name
               @properties['activity_name']
             end
 
             ##
-            # @return [String] The activity_sid
+            # @return [String] Filter by workers that are in a particular Activity by SID
             def activity_sid
               @properties['activity_sid']
             end
 
             ##
-            # @return [String] The attributes
+            # @return [String] JSON object describing this worker.
             def attributes
               @properties['attributes']
             end
 
             ##
-            # @return [Boolean] The available
+            # @return [Boolean] Filter by workers that are available or unavailable.
             def available
               @properties['available']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] DateTime this worker was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_status_changed
+            # @return [Time] DateTime of the last change to the Worker's activity.
             def date_status_changed
               @properties['date_status_changed']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] DateTime of the last update
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] Filter by a worker’s friendly name
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique ID of the worker
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The workspace_sid
+            # @return [String] The ID of the Workflow this worker is associated with
             def workspace_sid
               @properties['workspace_sid']
             end