twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -14,8 +16,10 @@ module Twilio
               ##
               # Initialize the WorkerChannelList
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
-              # @param [String] worker_sid The worker_sid
+              # @param [String] workspace_sid The SID of the Workspace that contains the
+              #   WorkerChannel.
+              # @param [String] worker_sid The SID of the Worker that contains the
+              #   WorkerChannel.
               # @return [WorkerChannelList] WorkerChannelList
               def initialize(version, workspace_sid: nil, worker_sid: nil)
                 super(version)
@@ -54,7 +58,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
@@ -66,7 +70,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],
@@ -86,11 +90,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 WorkerChannelPage.new(@version, response, @solution)
               end
 
@@ -152,29 +154,25 @@ module Twilio
               ##
               # Initialize the WorkerChannelContext
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
-              # @param [String] worker_sid The worker_sid
-              # @param [String] sid The sid
+              # @param [String] workspace_sid The SID of the Workspace with the WorkerChannel to
+              #   fetch.
+              # @param [String] worker_sid The SID of the Worker with the WorkerChannel to
+              #   fetch.
+              # @param [String] sid The SID of the WorkerChannel to fetch.
               # @return [WorkerChannelContext] WorkerChannelContext
               def initialize(version, workspace_sid, worker_sid, sid)
                 super(version)
 
                 # Path Solution
-                @solution = {workspace_sid: workspace_sid, worker_sid: worker_sid, sid: sid}
+                @solution = {workspace_sid: workspace_sid, worker_sid: worker_sid, sid: sid, }
                 @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workers/#{@solution[:worker_sid]}/Channels/#{@solution[:sid]}"
               end
 
               ##
-              # Fetch a WorkerChannelInstance
+              # Fetch the WorkerChannelInstance
               # @return [WorkerChannelInstance] Fetched WorkerChannelInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 WorkerChannelInstance.new(
                     @version,
@@ -187,17 +185,18 @@ module Twilio
 
               ##
               # Update the WorkerChannelInstance
-              # @param [String] capacity The capacity
-              # @param [Boolean] available The available
+              # @param [String] capacity The total number of Tasks that the Worker should handle
+              #   for the TaskChannel type. TaskRouter creates reservations for Tasks of this
+              #   TaskChannel type up to the specified capacity. If the capacity is 0, no new
+              #   reservations will be created.
+              # @param [Boolean] available Whether the WorkerChannel is available. Set to
+              #   `false` to prevent the Worker from receiving any new Tasks of this TaskChannel
+              #   type.
               # @return [WorkerChannelInstance] Updated WorkerChannelInstance
               def update(capacity: :unset, available: :unset)
-                data = Twilio::Values.of({'Capacity' => capacity, 'Available' => available})
+                data = Twilio::Values.of({'Capacity' => capacity, 'Available' => available, })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data)
 
                 WorkerChannelInstance.new(
                     @version,
@@ -214,6 +213,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Taskrouter.V1.WorkerChannelContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Taskrouter.V1.WorkerChannelContext #{context}>"
+              end
             end
 
             class WorkerChannelInstance < InstanceResource
@@ -221,9 +227,11 @@ module Twilio
               # Initialize the WorkerChannelInstance
               # @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] worker_sid The worker_sid
-              # @param [String] sid The sid
+              # @param [String] workspace_sid The SID of the Workspace that contains the
+              #   WorkerChannel.
+              # @param [String] worker_sid The SID of the Worker that contains the
+              #   WorkerChannel.
+              # @param [String] sid The SID of the WorkerChannel to fetch.
               # @return [WorkerChannelInstance] WorkerChannelInstance
               def initialize(version, payload, workspace_sid: nil, worker_sid: nil, sid: nil)
                 super(version)
@@ -242,7 +250,6 @@ module Twilio
                     'task_channel_unique_name' => payload['task_channel_unique_name'],
                     'worker_sid' => payload['worker_sid'],
                     'workspace_sid' => payload['workspace_sid'],
-                    'links' => payload['links'],
                     'url' => payload['url'],
                 }
 
@@ -272,91 +279,85 @@ 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 assigned_tasks
+              # @return [String] The total number of Tasks assigned to Worker for the TaskChannel type
               def assigned_tasks
                 @properties['assigned_tasks']
               end
 
               ##
-              # @return [Boolean] The available
+              # @return [Boolean] Whether the Worker should receive Tasks of the TaskChannel type
               def available
                 @properties['available']
               end
 
               ##
-              # @return [String] The available_capacity_percentage
+              # @return [String] The current available capacity between 0 to 100 for the TaskChannel
               def available_capacity_percentage
                 @properties['available_capacity_percentage']
               end
 
               ##
-              # @return [String] The configured_capacity
+              # @return [String] The current configured capacity for the WorkerChannel
               def configured_capacity
                 @properties['configured_capacity']
               end
 
               ##
-              # @return [Time] The date_created
+              # @return [Time] The RFC 2822 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 RFC 2822 date and time in GMT when the resource was last updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [String] The sid
+              # @return [String] The unique string that identifies the resource
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The task_channel_sid
+              # @return [String] The SID of the TaskChannel
               def task_channel_sid
                 @properties['task_channel_sid']
               end
 
               ##
-              # @return [String] The task_channel_unique_name
+              # @return [String] The unique name of the TaskChannel, such as 'voice' or 'sms'
               def task_channel_unique_name
                 @properties['task_channel_unique_name']
               end
 
               ##
-              # @return [String] The worker_sid
+              # @return [String] The SID of the Worker that contains the WorkerChannel
               def worker_sid
                 @properties['worker_sid']
               end
 
               ##
-              # @return [String] The workspace_sid
+              # @return [String] The SID of the Workspace that contains the WorkerChannel
               def workspace_sid
                 @properties['workspace_sid']
               end
 
               ##
-              # @return [String] The links
-              def links
-                @properties['links']
-              end
-
-              ##
-              # @return [String] The url
+              # @return [String] The absolute URL of the WorkerChannel resource
               def url
                 @properties['url']
               end
 
               ##
-              # Fetch a WorkerChannelInstance
+              # Fetch the WorkerChannelInstance
               # @return [WorkerChannelInstance] Fetched WorkerChannelInstance
               def fetch
                 context.fetch
@@ -364,11 +365,16 @@ module Twilio
 
               ##
               # Update the WorkerChannelInstance
-              # @param [String] capacity The capacity
-              # @param [Boolean] available The available
+              # @param [String] capacity The total number of Tasks that the Worker should handle
+              #   for the TaskChannel type. TaskRouter creates reservations for Tasks of this
+              #   TaskChannel type up to the specified capacity. If the capacity is 0, no new
+              #   reservations will be created.
+              # @param [Boolean] available Whether the WorkerChannel is available. Set to
+              #   `false` to prevent the Worker from receiving any new Tasks of this TaskChannel
+              #   type.
               # @return [WorkerChannelInstance] Updated WorkerChannelInstance
               def update(capacity: :unset, available: :unset)
-                context.update(capacity: capacity, available: available)
+                context.update(capacity: capacity, available: available, )
               end
 
               ##

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
@@ -14,8 +16,10 @@ module Twilio
               ##
               # Initialize the WorkerStatisticsList
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
-              # @param [String] worker_sid The worker_sid
+              # @param [String] workspace_sid The SID of the Workspace that contains the
+              #   WorkerChannel.
+              # @param [String] worker_sid The SID of the Worker that contains the
+              #   WorkerChannel.
               # @return [WorkerStatisticsList] WorkerStatisticsList
               def initialize(version, workspace_sid: nil, worker_sid: nil)
                 super(version)
@@ -69,23 +73,32 @@ module Twilio
               ##
               # Initialize the WorkerStatisticsContext
               # @param [Version] version Version that contains the resource
-              # @param [String] workspace_sid The workspace_sid
-              # @param [String] worker_sid The worker_sid
+              # @param [String] workspace_sid The SID of the Workspace with the WorkerChannel to
+              #   fetch.
+              # @param [String] worker_sid The SID of the Worker with the WorkerChannel to
+              #   fetch.
               # @return [WorkerStatisticsContext] WorkerStatisticsContext
               def initialize(version, workspace_sid, worker_sid)
                 super(version)
 
                 # Path Solution
-                @solution = {workspace_sid: workspace_sid, worker_sid: worker_sid}
+                @solution = {workspace_sid: workspace_sid, worker_sid: worker_sid, }
                 @uri = "/Workspaces/#{@solution[:workspace_sid]}/Workers/#{@solution[:worker_sid]}/Statistics"
               end
 
               ##
-              # 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
+              # Fetch the WorkerStatisticsInstance
+              # @param [String] minutes Only calculate statistics since this many minutes in the
+              #   past. The default 15 minutes. This is helpful for displaying statistics for the
+              #   last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.
+              # @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 [Time] end_date Only include usage that occurred on or before this date,
+              #   specified in GMT as an {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601]
+              #   date-time.
+              # @param [String] task_channel Only calculate statistics on this TaskChannel. Can
+              #   be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or
+              #   `default`.
               # @return [WorkerStatisticsInstance] Fetched WorkerStatisticsInstance
               def fetch(minutes: :unset, start_date: :unset, end_date: :unset, task_channel: :unset)
                 params = Twilio::Values.of({
@@ -95,11 +108,7 @@ module Twilio
                     'TaskChannel' => task_channel,
                 })
 
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri, params: params)
 
                 WorkerStatisticsInstance.new(
                     @version,
@@ -115,6 +124,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Taskrouter.V1.WorkerStatisticsContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Taskrouter.V1.WorkerStatisticsContext #{context}>"
+              end
             end
 
             class WorkerStatisticsInstance < InstanceResource
@@ -122,8 +138,10 @@ module Twilio
               # Initialize the WorkerStatisticsInstance
               # @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] worker_sid The worker_sid
+              # @param [String] workspace_sid The SID of the Workspace that contains the
+              #   WorkerChannel.
+              # @param [String] worker_sid The SID of the Worker that contains the
+              #   WorkerChannel.
               # @return [WorkerStatisticsInstance] WorkerStatisticsInstance
               def initialize(version, payload, workspace_sid: nil, worker_sid: nil)
                 super(version)
@@ -139,7 +157,7 @@ module Twilio
 
                 # Context
                 @instance_context = nil
-                @params = {'workspace_sid' => workspace_sid, 'worker_sid' => worker_sid}
+                @params = {'workspace_sid' => workspace_sid, 'worker_sid' => worker_sid, }
               end
 
               ##
@@ -158,44 +176,56 @@ module Twilio
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [Hash] The cumulative
+              # @return [Hash] An object that contains the cumulative statistics for the Worker
               def cumulative
                 @properties['cumulative']
               end
 
               ##
-              # @return [String] The worker_sid
+              # @return [String] The SID of the Worker that contains the WorkerChannel
               def worker_sid
                 @properties['worker_sid']
               end
 
               ##
-              # @return [String] The workspace_sid
+              # @return [String] The SID of the Workspace that contains the WorkerChannel
               def workspace_sid
                 @properties['workspace_sid']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The absolute URL of the WorkerChannel statistics resource
               def url
                 @properties['url']
               end
 
               ##
-              # 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
+              # Fetch the WorkerStatisticsInstance
+              # @param [String] minutes Only calculate statistics since this many minutes in the
+              #   past. The default 15 minutes. This is helpful for displaying statistics for the
+              #   last 15 minutes, 240 minutes (4 hours), and 480 minutes (8 hours) to see trends.
+              # @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 [Time] end_date Only include usage that occurred on or before this date,
+              #   specified in GMT as an {ISO 8601}[https://en.wikipedia.org/wiki/ISO_8601]
+              #   date-time.
+              # @param [String] task_channel Only calculate statistics on this TaskChannel. Can
+              #   be the TaskChannel's SID or its `unique_name`, such as `voice`, `sms`, or
+              #   `default`.
               # @return [WorkerStatisticsInstance] Fetched WorkerStatisticsInstance
               def fetch(minutes: :unset, start_date: :unset, end_date: :unset, task_channel: :unset)
-                context.fetch(minutes: minutes, start_date: start_date, end_date: end_date, task_channel: task_channel)
+                context.fetch(
+                    minutes: minutes,
+                    start_date: start_date,
+                    end_date: end_date,
+                    task_channel: task_channel,
+                )
               end
 
               ##