twilio-ruby 5.31.1 → 5.46.1

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

@@ -15,8 +15,8 @@ module Twilio
             ##
             # Initialize the TaskChannelList
             # @param [Version] version Version that contains the resource
-            # @param [String] workspace_sid The SID of the Workspace that contains the
-            #   TaskChannel.
+            # @param [String] workspace_sid The SID of the Workspace that contains the Task
+            #   Channel.
             # @return [TaskChannelList] TaskChannelList
             def initialize(version, workspace_sid: nil)
               super(version)
@@ -87,11 +87,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               TaskChannelPage.new(@version, response, @solution)
             end
 
@@ -109,16 +107,15 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of TaskChannelInstance records from the API.
-            # Request is executed immediately.
+            # Create the TaskChannelInstance
             # @param [String] friendly_name A descriptive string that you create to describe
-            #   the TaskChannel. It can be up to 64 characters long.
+            #   the Task Channel. It can be up to 64 characters long.
             # @param [String] unique_name An application-defined string that uniquely
-            #   identifies the TaskChannel, such as `voice` or `sms`.
-            # @param [Boolean] channel_optimized_routing Whether the TaskChannel should
+            #   identifies the Task Channel, such as `voice` or `sms`.
+            # @param [Boolean] channel_optimized_routing Whether the Task Channel should
             #   prioritize Workers that have been idle. If `true`, Workers that have been idle
             #   the longest are prioritized.
-            # @return [TaskChannelInstance] Newly created TaskChannelInstance
+            # @return [TaskChannelInstance] Created TaskChannelInstance
             def create(friendly_name: nil, unique_name: nil, channel_optimized_routing: :unset)
               data = Twilio::Values.of({
                   'FriendlyName' => friendly_name,
@@ -126,11 +123,7 @@ module Twilio
                   'ChannelOptimizedRouting' => channel_optimized_routing,
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               TaskChannelInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
             end
@@ -175,9 +168,9 @@ module Twilio
             ##
             # Initialize the TaskChannelContext
             # @param [Version] version Version that contains the resource
-            # @param [String] workspace_sid The SID of the Workspace with the TaskChannel to
+            # @param [String] workspace_sid The SID of the Workspace with the Task Channel to
             #   fetch.
-            # @param [String] sid The SID of the TaskChannel resource to fetch.
+            # @param [String] sid The SID of the Task Channel resource to fetch.
             # @return [TaskChannelContext] TaskChannelContext
             def initialize(version, workspace_sid, sid)
               super(version)
@@ -188,16 +181,10 @@ module Twilio
             end
 
             ##
-            # Fetch a TaskChannelInstance
+            # Fetch the TaskChannelInstance
             # @return [TaskChannelInstance] Fetched TaskChannelInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               TaskChannelInstance.new(
                   @version,
@@ -210,7 +197,7 @@ module Twilio
             ##
             # Update the TaskChannelInstance
             # @param [String] friendly_name A descriptive string that you create to describe
-            #   the TaskChannel. It can be up to 64 characters long.
+            #   the Task Channel. It can be up to 64 characters long.
             # @param [Boolean] channel_optimized_routing Whether the TaskChannel should
             #   prioritize Workers that have been idle. If `true`, Workers that have been idle
             #   the longest are prioritized.
@@ -221,11 +208,7 @@ module Twilio
                   'ChannelOptimizedRouting' => channel_optimized_routing,
               })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               TaskChannelInstance.new(
                   @version,
@@ -236,10 +219,10 @@ module Twilio
             end
 
             ##
-            # Deletes the TaskChannelInstance
+            # Delete the TaskChannelInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -262,9 +245,9 @@ module Twilio
             # Initialize the TaskChannelInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] workspace_sid The SID of the Workspace that contains the
-            #   TaskChannel.
-            # @param [String] sid The SID of the TaskChannel resource to fetch.
+            # @param [String] workspace_sid The SID of the Workspace that contains the Task
+            #   Channel.
+            # @param [String] sid The SID of the Task Channel resource to fetch.
             # @return [TaskChannelInstance] TaskChannelInstance
             def initialize(version, payload, workspace_sid: nil, sid: nil)
               super(version)
@@ -330,25 +313,25 @@ module Twilio
             end
 
             ##
-            # @return [String] An application-defined string that uniquely identifies the TaskChannel
+            # @return [String] An application-defined string that uniquely identifies the Task Channel
             def unique_name
               @properties['unique_name']
             end
 
             ##
-            # @return [String] The SID of the Workspace that contains the TaskChannel
+            # @return [String] The SID of the Workspace that contains the Task Channel
             def workspace_sid
               @properties['workspace_sid']
             end
 
             ##
-            # @return [Boolean] Whether the TaskChannel will prioritize Workers that have been idle
+            # @return [Boolean] Whether the Task Channel will prioritize Workers that have been idle
             def channel_optimized_routing
               @properties['channel_optimized_routing']
             end
 
             ##
-            # @return [String] The absolute URL of the TaskChannel resource
+            # @return [String] The absolute URL of the Task Channel resource
             def url
               @properties['url']
             end
@@ -360,7 +343,7 @@ module Twilio
             end
 
             ##
-            # Fetch a TaskChannelInstance
+            # Fetch the TaskChannelInstance
             # @return [TaskChannelInstance] Fetched TaskChannelInstance
             def fetch
               context.fetch
@@ -369,7 +352,7 @@ module Twilio
             ##
             # Update the TaskChannelInstance
             # @param [String] friendly_name A descriptive string that you create to describe
-            #   the TaskChannel. It can be up to 64 characters long.
+            #   the Task Channel. It can be up to 64 characters long.
             # @param [Boolean] channel_optimized_routing Whether the TaskChannel should
             #   prioritize Workers that have been idle. If `true`, Workers that have been idle
             #   the longest are prioritized.
@@ -379,7 +362,7 @@ module Twilio
             end
 
             ##
-            # Deletes the TaskChannelInstance
+            # Delete the TaskChannelInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete

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

@@ -125,11 +125,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               TaskQueuePage.new(@version, response, @solution)
             end
 
@@ -147,29 +145,28 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of TaskQueueInstance records from the API.
-            # Request is executed immediately.
+            # Create the TaskQueueInstance
             # @param [String] friendly_name A descriptive string that you create to describe
             #   the TaskQueue. For example `Support-Tier 1`, `Sales`, or `Escalation`.
             # @param [String] target_workers A string that describes the Worker selection
             #   criteria for any Tasks that enter the TaskQueue. For example, `'"language" ==
             #   "spanish"'`. The default value is `1==1`. If this value is empty, Tasks will
             #   wait in the TaskQueue until they are deleted or moved to another TaskQueue. For
-            #   more information about Worker selection, see [Describing Worker selection
-            #   criteria](https://www.twilio.com/docs/taskrouter/api/taskqueues#target-workers).
+            #   more information about Worker selection, see {Describing Worker selection
+            #   criteria}[https://www.twilio.com/docs/taskrouter/api/taskqueues#target-workers].
             # @param [String] max_reserved_workers The maximum number of Workers to reserve
             #   for the assignment of a Task in the queue. Can be an integer between 1 and 50,
             #   inclusive and defaults to 1.
             # @param [task_queue.TaskOrder] task_order How Tasks will be assigned to Workers.
             #   Set this parameter to `LIFO` to assign most recently created Task first or FIFO
-            #   to assign the oldest Task first. Default is `FIFO`. [Click
-            #   here](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo)
+            #   to assign the oldest Task first. Default is `FIFO`. {Click
+            #   here}[https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo]
             #   to learn more.
             # @param [String] reservation_activity_sid The SID of the Activity to assign
             #   Workers when a task is reserved for them.
             # @param [String] assignment_activity_sid The SID of the Activity to assign
             #   Workers when a task is assigned to them.
-            # @return [TaskQueueInstance] Newly created TaskQueueInstance
+            # @return [TaskQueueInstance] Created TaskQueueInstance
             def create(friendly_name: nil, target_workers: :unset, max_reserved_workers: :unset, task_order: :unset, reservation_activity_sid: :unset, assignment_activity_sid: :unset)
               data = Twilio::Values.of({
                   'FriendlyName' => friendly_name,
@@ -180,11 +177,7 @@ module Twilio
                   'AssignmentActivitySid' => assignment_activity_sid,
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               TaskQueueInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
             end
@@ -255,16 +248,10 @@ module Twilio
             end
 
             ##
-            # Fetch a TaskQueueInstance
+            # Fetch the TaskQueueInstance
             # @return [TaskQueueInstance] Fetched TaskQueueInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               TaskQueueInstance.new(
                   @version,
@@ -292,8 +279,8 @@ module Twilio
             # @param [task_queue.TaskOrder] task_order How Tasks will be assigned to Workers.
             #   Can be: `FIFO` or `LIFO` and the default is `FIFO`. Use `FIFO` to assign the
             #   oldest task first and `LIFO` to assign the most recent task first. For more
-            #   information, see [Queue
-            #   Ordering](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo).
+            #   information, see {Queue
+            #   Ordering}[https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo].
             # @return [TaskQueueInstance] Updated TaskQueueInstance
             def update(friendly_name: :unset, target_workers: :unset, reservation_activity_sid: :unset, assignment_activity_sid: :unset, max_reserved_workers: :unset, task_order: :unset)
               data = Twilio::Values.of({
@@ -305,11 +292,7 @@ module Twilio
                   'TaskOrder' => task_order,
               })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               TaskQueueInstance.new(
                   @version,
@@ -320,10 +303,10 @@ module Twilio
             end
 
             ##
-            # Deletes the TaskQueueInstance
+            # Delete the TaskQueueInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -503,7 +486,7 @@ module Twilio
             end
 
             ##
-            # Fetch a TaskQueueInstance
+            # Fetch the TaskQueueInstance
             # @return [TaskQueueInstance] Fetched TaskQueueInstance
             def fetch
               context.fetch
@@ -527,8 +510,8 @@ module Twilio
             # @param [task_queue.TaskOrder] task_order How Tasks will be assigned to Workers.
             #   Can be: `FIFO` or `LIFO` and the default is `FIFO`. Use `FIFO` to assign the
             #   oldest task first and `LIFO` to assign the most recent task first. For more
-            #   information, see [Queue
-            #   Ordering](https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo).
+            #   information, see {Queue
+            #   Ordering}[https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo].
             # @return [TaskQueueInstance] Updated TaskQueueInstance
             def update(friendly_name: :unset, target_workers: :unset, reservation_activity_sid: :unset, assignment_activity_sid: :unset, max_reserved_workers: :unset, task_order: :unset)
               context.update(
@@ -542,7 +525,7 @@ module Twilio
             end
 
             ##
-            # Deletes the TaskQueueInstance
+            # Delete the TaskQueueInstance
             # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete

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

@@ -87,14 +87,14 @@ module Twilio
               end
 
               ##
-              # Fetch a TaskQueueCumulativeStatisticsInstance
+              # Fetch the TaskQueueCumulativeStatisticsInstance
               # @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.
+              #   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.
+              #   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`.
@@ -112,11 +112,7 @@ module Twilio
                     'SplitByWaitTime' => split_by_wait_time,
                 })
 
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri, params: params)
 
                 TaskQueueCumulativeStatisticsInstance.new(
                     @version,
@@ -170,6 +166,7 @@ module Twilio
                     'task_queue_sid' => payload['task_queue_sid'],
                     'wait_duration_until_accepted' => payload['wait_duration_until_accepted'],
                     'wait_duration_until_canceled' => payload['wait_duration_until_canceled'],
+                    'wait_duration_in_queue_until_accepted' => payload['wait_duration_in_queue_until_accepted'],
                     'tasks_canceled' => payload['tasks_canceled'].to_i,
                     'tasks_completed' => payload['tasks_completed'].to_i,
                     'tasks_deleted' => payload['tasks_deleted'].to_i,
@@ -283,6 +280,12 @@ module Twilio
                 @properties['wait_duration_until_canceled']
               end
 
+              ##
+              # @return [Hash] The relative wait duration statistics for Tasks accepted while in the TaskQueue
+              def wait_duration_in_queue_until_accepted
+                @properties['wait_duration_in_queue_until_accepted']
+              end
+
               ##
               # @return [String] The total number of Tasks canceled in the TaskQueue
               def tasks_canceled
@@ -326,14 +329,14 @@ module Twilio
               end
 
               ##
-              # Fetch a TaskQueueCumulativeStatisticsInstance
+              # Fetch the TaskQueueCumulativeStatisticsInstance
               # @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.
+              #   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.
+              #   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`.

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

@@ -87,7 +87,7 @@ module Twilio
               end
 
               ##
-              # Fetch a TaskQueueRealTimeStatisticsInstance
+              # Fetch the TaskQueueRealTimeStatisticsInstance
               # @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`.
@@ -95,11 +95,7 @@ module Twilio
               def fetch(task_channel: :unset)
                 params = Twilio::Values.of({'TaskChannel' => task_channel, })
 
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri, params: params)
 
                 TaskQueueRealTimeStatisticsInstance.new(
                     @version,
@@ -143,6 +139,8 @@ module Twilio
                     'activity_statistics' => payload['activity_statistics'],
                     'longest_task_waiting_age' => payload['longest_task_waiting_age'].to_i,
                     'longest_task_waiting_sid' => payload['longest_task_waiting_sid'],
+                    'longest_relative_task_age_in_queue' => payload['longest_relative_task_age_in_queue'].to_i,
+                    'longest_relative_task_sid_in_queue' => payload['longest_relative_task_sid_in_queue'],
                     'task_queue_sid' => payload['task_queue_sid'],
                     'tasks_by_priority' => payload['tasks_by_priority'],
                     'tasks_by_status' => payload['tasks_by_status'],
@@ -180,7 +178,7 @@ module Twilio
               end
 
               ##
-              # @return [Hash] The number of current Workers by Activity
+              # @return [Array[Hash]] The number of current Workers by Activity
               def activity_statistics
                 @properties['activity_statistics']
               end
@@ -197,6 +195,18 @@ module Twilio
                 @properties['longest_task_waiting_sid']
               end
 
+              ##
+              # @return [String] The relative age in the TaskQueue for the longest waiting Task.
+              def longest_relative_task_age_in_queue
+                @properties['longest_relative_task_age_in_queue']
+              end
+
+              ##
+              # @return [String] The SID of the Task waiting in the TaskQueue the longest.
+              def longest_relative_task_sid_in_queue
+                @properties['longest_relative_task_sid_in_queue']
+              end
+
               ##
               # @return [String] The SID of the TaskQueue from which these statistics were calculated
               def task_queue_sid
@@ -246,7 +256,7 @@ module Twilio
               end
 
               ##
-              # Fetch a TaskQueueRealTimeStatisticsInstance
+              # Fetch the TaskQueueRealTimeStatisticsInstance
               # @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`.