twilio-ruby 5.6.0 → 5.33.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
@@ -13,7 +15,8 @@ module Twilio
             ##
             # Initialize the TaskChannelList
             # @param [Version] version Version that contains the resource
-            # @param [String] workspace_sid The workspace_sid
+            # @param [String] workspace_sid The SID of the Workspace that contains the
+            #   TaskChannel.
             # @return [TaskChannelList] TaskChannelList
             def initialize(version, workspace_sid: nil)
               super(version)
@@ -52,7 +55,7 @@ module Twilio
             def stream(limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(page_size: limits[:page_size])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -64,7 +67,7 @@ module Twilio
             def each
               limits = @version.read_limits
 
-              page = self.page(page_size: limits[:page_size])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page,
                               limit: limits[:limit],
@@ -105,6 +108,33 @@ module Twilio
               TaskChannelPage.new(@version, response, @solution)
             end
 
+            ##
+            # Retrieve a single page of TaskChannelInstance records from the API.
+            # Request is executed immediately.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the TaskChannel. 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
+            #   prioritize Workers that have been idle. If `true`, Workers that have been idle
+            #   the longest are prioritized.
+            # @return [TaskChannelInstance] Newly created TaskChannelInstance
+            def create(friendly_name: nil, unique_name: nil, channel_optimized_routing: :unset)
+              data = Twilio::Values.of({
+                  'FriendlyName' => friendly_name,
+                  'UniqueName' => unique_name,
+                  'ChannelOptimizedRouting' => channel_optimized_routing,
+              })
+
+              payload = @version.create(
+                  'POST',
+                  @uri,
+                  data: data
+              )
+
+              TaskChannelInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
@@ -131,7 +161,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [TaskChannelInstance] TaskChannelInstance
             def get_instance(payload)
-              TaskChannelInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid])
+              TaskChannelInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
             end
 
             ##
@@ -145,14 +175,15 @@ module Twilio
             ##
             # Initialize the TaskChannelContext
             # @param [Version] version Version that contains the resource
-            # @param [String] workspace_sid The workspace_sid
-            # @param [String] sid The sid
+            # @param [String] workspace_sid The SID of the Workspace with the TaskChannel to
+            #   fetch.
+            # @param [String] sid The SID of the TaskChannel resource to fetch.
             # @return [TaskChannelContext] TaskChannelContext
             def initialize(version, workspace_sid, sid)
               super(version)
 
               # Path Solution
-              @solution = {workspace_sid: workspace_sid, sid: sid}
+              @solution = {workspace_sid: workspace_sid, sid: sid, }
               @uri = "/Workspaces/#{@solution[:workspace_sid]}/TaskChannels/#{@solution[:sid]}"
             end
 
@@ -176,12 +207,54 @@ module Twilio
               )
             end
 
+            ##
+            # 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.
+            # @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.
+            # @return [TaskChannelInstance] Updated TaskChannelInstance
+            def update(friendly_name: :unset, channel_optimized_routing: :unset)
+              data = Twilio::Values.of({
+                  'FriendlyName' => friendly_name,
+                  'ChannelOptimizedRouting' => channel_optimized_routing,
+              })
+
+              payload = @version.update(
+                  'POST',
+                  @uri,
+                  data: data,
+              )
+
+              TaskChannelInstance.new(
+                  @version,
+                  payload,
+                  workspace_sid: @solution[:workspace_sid],
+                  sid: @solution[:sid],
+              )
+            end
+
+            ##
+            # Deletes the TaskChannelInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+              @version.delete('delete', @uri)
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Taskrouter.V1.TaskChannelContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Taskrouter.V1.TaskChannelContext #{context}>"
+            end
           end
 
           class TaskChannelInstance < InstanceResource
@@ -189,8 +262,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 workspace_sid
-            # @param [String] sid The sid
+            # @param [String] workspace_sid The SID of the Workspace that contains the
+            #   TaskChannel.
+            # @param [String] sid The SID of the TaskChannel resource to fetch.
             # @return [TaskChannelInstance] TaskChannelInstance
             def initialize(version, payload, workspace_sid: nil, sid: nil)
               super(version)
@@ -204,12 +278,14 @@ module Twilio
                   'sid' => payload['sid'],
                   'unique_name' => payload['unique_name'],
                   'workspace_sid' => payload['workspace_sid'],
+                  'channel_optimized_routing' => payload['channel_optimized_routing'],
                   'url' => payload['url'],
+                  'links' => payload['links'],
               }
 
               # Context
               @instance_context = nil
-              @params = {'workspace_sid' => workspace_sid, 'sid' => sid || @properties['sid']}
+              @params = {'workspace_sid' => workspace_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -218,59 +294,71 @@ module Twilio
             # @return [TaskChannelContext] TaskChannelContext for this TaskChannelInstance
             def context
               unless @instance_context
-                @instance_context = TaskChannelContext.new(@version, @params['workspace_sid'], @params['sid'])
+                @instance_context = TaskChannelContext.new(@version, @params['workspace_sid'], @params['sid'], )
               end
               @instance_context
             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 [Time] The date_created
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The ISO 8601 date and time in GMT when the resource was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The friendly_name
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The unique_name
+            # @return [String] An application-defined string that uniquely identifies the TaskChannel
             def unique_name
               @properties['unique_name']
             end
 
             ##
-            # @return [String] The workspace_sid
+            # @return [String] The SID of the Workspace that contains the TaskChannel
             def workspace_sid
               @properties['workspace_sid']
             end
 
             ##
-            # @return [String] The url
+            # @return [Boolean] Whether the TaskChannel 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
             def url
               @properties['url']
             end
 
+            ##
+            # @return [String] The URLs of related resources
+            def links
+              @properties['links']
+            end
+
             ##
             # Fetch a TaskChannelInstance
             # @return [TaskChannelInstance] Fetched TaskChannelInstance
@@ -278,6 +366,25 @@ module Twilio
               context.fetch
             end
 
+            ##
+            # 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.
+            # @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.
+            # @return [TaskChannelInstance] Updated TaskChannelInstance
+            def update(friendly_name: :unset, channel_optimized_routing: :unset)
+              context.update(friendly_name: friendly_name, channel_optimized_routing: channel_optimized_routing, )
+            end
+
+            ##
+            # Deletes the TaskChannelInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
+            def delete
+              context.delete
+            end
+
             ##
             # Provide a user friendly representation
             def to_s

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
@@ -14,8 +16,10 @@ module Twilio
               ##
               # Initialize the TaskQueueCumulativeStatisticsList
               # @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 [TaskQueueCumulativeStatisticsList] TaskQueueCumulativeStatisticsList
               def initialize(version, workspace_sid: nil, task_queue_sid: nil)
                 super(version)
@@ -69,24 +73,35 @@ module Twilio
               ##
               # Initialize the TaskQueueCumulativeStatisticsContext
               # @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 [TaskQueueCumulativeStatisticsContext] TaskQueueCumulativeStatisticsContext
               def initialize(version, workspace_sid, task_queue_sid)
                 super(version)
 
                 # Path Solution
-                @solution = {workspace_sid: workspace_sid, task_queue_sid: task_queue_sid}
+                @solution = {workspace_sid: workspace_sid, task_queue_sid: task_queue_sid, }
                 @uri = "/Workspaces/#{@solution[:workspace_sid]}/TaskQueues/#{@solution[:task_queue_sid]}/CumulativeStatistics"
               end
 
               ##
               # 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 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 cumulative statistics on this
+              #   TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`,
+              #   `sms`, or `default`.
+              # @param [String] split_by_wait_time A comma separated list of values that
+              #   describes the thresholds, in seconds, to calculate statistics on. For each
+              #   threshold specified, the number of Tasks canceled and reservations accepted
+              #   above and below the specified thresholds in seconds are computed.
               # @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({
@@ -117,6 +132,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Taskrouter.V1.TaskQueueCumulativeStatisticsContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Taskrouter.V1.TaskQueueCumulativeStatisticsContext #{context}>"
+              end
             end
 
             class TaskQueueCumulativeStatisticsInstance < InstanceResource
@@ -124,8 +146,10 @@ module Twilio
               # Initialize the TaskQueueCumulativeStatisticsInstance
               # @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 [TaskQueueCumulativeStatisticsInstance] TaskQueueCumulativeStatisticsInstance
               def initialize(version, payload, workspace_sid: nil, task_queue_sid: nil)
                 super(version)
@@ -146,6 +170,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,
@@ -157,7 +182,7 @@ module Twilio
 
                 # Context
                 @instance_context = nil
-                @params = {'workspace_sid' => workspace_sid, 'task_queue_sid' => task_queue_sid}
+                @params = {'workspace_sid' => workspace_sid, 'task_queue_sid' => task_queue_sid, }
               end
 
               ##
@@ -176,138 +201,153 @@ module Twilio
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The avg_task_acceptance_time
+              # @return [String] The average time in seconds between Task creation and acceptance
               def avg_task_acceptance_time
                 @properties['avg_task_acceptance_time']
               end
 
               ##
-              # @return [Time] The start_time
+              # @return [Time] The beginning of the interval during which these statistics were calculated
               def start_time
                 @properties['start_time']
               end
 
               ##
-              # @return [Time] The end_time
+              # @return [Time] The end of the interval during which these statistics were calculated
               def end_time
                 @properties['end_time']
               end
 
               ##
-              # @return [String] The reservations_created
+              # @return [String] The total number of Reservations created for Tasks in the TaskQueue
               def reservations_created
                 @properties['reservations_created']
               end
 
               ##
-              # @return [String] The reservations_accepted
+              # @return [String] The total number of Reservations accepted for Tasks in the TaskQueue
               def reservations_accepted
                 @properties['reservations_accepted']
               end
 
               ##
-              # @return [String] The reservations_rejected
+              # @return [String] The total number of Reservations rejected for Tasks in the TaskQueue
               def reservations_rejected
                 @properties['reservations_rejected']
               end
 
               ##
-              # @return [String] The reservations_timed_out
+              # @return [String] The total number of Reservations that timed out for Tasks in the TaskQueue
               def reservations_timed_out
                 @properties['reservations_timed_out']
               end
 
               ##
-              # @return [String] The reservations_canceled
+              # @return [String] The total number of Reservations canceled for Tasks in the TaskQueue
               def reservations_canceled
                 @properties['reservations_canceled']
               end
 
               ##
-              # @return [String] The reservations_rescinded
+              # @return [String] The total number of Reservations rescinded
               def reservations_rescinded
                 @properties['reservations_rescinded']
               end
 
               ##
-              # @return [Hash] The split_by_wait_time
+              # @return [Hash] A list of objects that describe the Tasks canceled and reservations accepted above and below the specified thresholds
               def split_by_wait_time
                 @properties['split_by_wait_time']
               end
 
               ##
-              # @return [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 wait_duration_until_accepted
+              # @return [Hash] The wait duration statistics for Tasks accepted while in the TaskQueue
               def wait_duration_until_accepted
                 @properties['wait_duration_until_accepted']
               end
 
               ##
-              # @return [Hash] The wait_duration_until_canceled
+              # @return [Hash] The wait duration statistics for Tasks canceled while in the TaskQueue
               def wait_duration_until_canceled
                 @properties['wait_duration_until_canceled']
               end
 
               ##
-              # @return [String] The tasks_canceled
+              # @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
                 @properties['tasks_canceled']
               end
 
               ##
-              # @return [String] The tasks_completed
+              # @return [String] The total number of Tasks completed in the TaskQueue
               def tasks_completed
                 @properties['tasks_completed']
               end
 
               ##
-              # @return [String] The tasks_deleted
+              # @return [String] The total number of Tasks deleted in the TaskQueue
               def tasks_deleted
                 @properties['tasks_deleted']
               end
 
               ##
-              # @return [String] The tasks_entered
+              # @return [String] The total number of Tasks entered into the TaskQueue
               def tasks_entered
                 @properties['tasks_entered']
               end
 
               ##
-              # @return [String] The tasks_moved
+              # @return [String] The total number of Tasks that were moved from one queue to another
               def tasks_moved
                 @properties['tasks_moved']
               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 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 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 cumulative statistics on this
+              #   TaskChannel. Can be the TaskChannel's SID or its `unique_name`, such as `voice`,
+              #   `sms`, or `default`.
+              # @param [String] split_by_wait_time A comma separated list of values that
+              #   describes the thresholds, in seconds, to calculate statistics on. For each
+              #   threshold specified, the number of Tasks canceled and reservations accepted
+              #   above and below the specified thresholds in seconds are computed.
               # @return [TaskQueueCumulativeStatisticsInstance] Fetched TaskQueueCumulativeStatisticsInstance
               def fetch(end_date: :unset, minutes: :unset, start_date: :unset, task_channel: :unset, split_by_wait_time: :unset)
                 context.fetch(