twilio-ruby 5.6.0 → 5.33.1

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -25,7 +27,8 @@ module Twilio
           # Lists WorkspaceInstance records from the API as a list.
           # Unlike stream(), this operation is eager and will load `limit` records into
           # memory before returning.
-          # @param [String] friendly_name The friendly_name
+          # @param [String] friendly_name The `friendly_name` of the Workspace resources to
+          #   read. For example `Customer Support` or `2014 Election Campaign`.
           # @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
@@ -41,7 +44,8 @@ module Twilio
           # Streams WorkspaceInstance records from the API as an Enumerable.
           # This operation lazily loads records as efficiently as possible until the limit
           # is reached.
-          # @param [String] friendly_name The friendly_name
+          # @param [String] friendly_name The `friendly_name` of the Workspace resources to
+          #   read. For example `Customer Support` or `2014 Election Campaign`.
           # @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
@@ -52,7 +56,7 @@ module Twilio
           def stream(friendly_name: :unset, limit: nil, page_size: nil)
             limits = @version.read_limits(limit, page_size)
 
-            page = self.page(friendly_name: friendly_name, page_size: limits[:page_size])
+            page = self.page(friendly_name: friendly_name, page_size: limits[:page_size], )
 
             @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
           end
@@ -64,7 +68,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],
@@ -74,7 +78,8 @@ module Twilio
           ##
           # Retrieve a single page of WorkspaceInstance records from the API.
           # Request is executed immediately.
-          # @param [String] friendly_name The friendly_name
+          # @param [String] friendly_name The `friendly_name` of the Workspace resources to
+          #   read. For example `Customer Support` or `2014 Election Campaign`.
           # @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
@@ -110,12 +115,35 @@ module Twilio
           ##
           # Retrieve a single page of WorkspaceInstance records from the API.
           # Request is executed immediately.
-          # @param [String] friendly_name The friendly_name
-          # @param [String] event_callback_url The event_callback_url
-          # @param [String] events_filter The events_filter
-          # @param [Boolean] multi_task_enabled The multi_task_enabled
-          # @param [String] template The template
-          # @param [workspace.QueueOrder] prioritize_queue_order The prioritize_queue_order
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the Workspace resource. It can be up to 64 characters long. For example:
+          #   `Customer Support` or `2014 Election Campaign`.
+          # @param [String] event_callback_url The URL we should call when an event occurs.
+          #   If provided, the Workspace will publish events to this URL, for example, to
+          #   collect data for reporting. See [Workspace
+          #   Events](https://www.twilio.com/docs/taskrouter/api/event) for more information.
+          # @param [String] events_filter The list of Workspace events for which to call
+          #   event_callback_url. For example if
+          #   `EventsFilter=task.created,task.canceled,worker.activity.update`, then
+          #   TaskRouter will call event_callback_url only when a task is created, canceled,
+          #   or a Worker activity is updated.
+          # @param [Boolean] multi_task_enabled Whether to enable multi-tasking. Can be:
+          #   `true` to enable multi-tasking, or `false` to disable it. The default is
+          #   `false`. Multi-tasking allows Workers to handle multiple Tasks simultaneously.
+          #   When enabled (`true`), each Worker can receive parallel reservations up to the
+          #   per-channel maximums defined in the Workers section. Otherwise, each Worker will
+          #   only receive a new reservation when the previous task is completed. Learn more
+          #   at [Multitasking][https://www.twilio.com/docs/taskrouter/multitasking].
+          # @param [String] template An available template name. Can be: `NONE` or `FIFO`
+          #   and the default is `NONE`. Pre-configures the Workspace with the Workflow and
+          #   Activities specified in the template. `NONE` will create a Workspace with only a
+          #   set of default activities. `FIFO` will configure TaskRouter with a set of
+          #   default activities and a single TaskQueue for first-in, first-out distribution,
+          #   which can be useful when you are getting started with TaskRouter.
+          # @param [workspace.QueueOrder] prioritize_queue_order The type of TaskQueue to
+          #   prioritize when Workers are receiving Tasks from both types of TaskQueues. Can
+          #   be: `LIFO` or `FIFO` and the default is `FIFO`. For more information, see [Queue
+          #   Ordering][https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo].
           # @return [WorkspaceInstance] Newly created WorkspaceInstance
           def create(friendly_name: nil, event_callback_url: :unset, events_filter: :unset, multi_task_enabled: :unset, template: :unset, prioritize_queue_order: :unset)
             data = Twilio::Values.of({
@@ -133,7 +161,7 @@ module Twilio
                 data: data
             )
 
-            WorkspaceInstance.new(@version, payload)
+            WorkspaceInstance.new(@version, payload, )
           end
 
           ##
@@ -162,7 +190,7 @@ module Twilio
           # @param [Hash] payload Payload response from the API
           # @return [WorkspaceInstance] WorkspaceInstance
           def get_instance(payload)
-            WorkspaceInstance.new(@version, payload)
+            WorkspaceInstance.new(@version, payload, )
           end
 
           ##
@@ -176,13 +204,13 @@ module Twilio
           ##
           # Initialize the WorkspaceContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The sid
+          # @param [String] sid The SID of the Workspace resource to fetch.
           # @return [WorkspaceContext] WorkspaceContext
           def initialize(version, sid)
             super(version)
 
             # Path Solution
-            @solution = {sid: sid}
+            @solution = {sid: sid, }
             @uri = "/Workspaces/#{@solution[:sid]}"
 
             # Dependents
@@ -210,18 +238,37 @@ module Twilio
                 params,
             )
 
-            WorkspaceInstance.new(@version, payload, sid: @solution[:sid])
+            WorkspaceInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
           # Update the WorkspaceInstance
-          # @param [String] default_activity_sid The default_activity_sid
-          # @param [String] event_callback_url The event_callback_url
-          # @param [String] events_filter The events_filter
-          # @param [String] friendly_name The friendly_name
-          # @param [Boolean] multi_task_enabled The multi_task_enabled
-          # @param [String] timeout_activity_sid The timeout_activity_sid
-          # @param [workspace.QueueOrder] prioritize_queue_order The prioritize_queue_order
+          # @param [String] default_activity_sid The SID of the Activity that will be used
+          #   when new Workers are created in the Workspace.
+          # @param [String] event_callback_url The URL we should call when an event occurs.
+          #   See [Workspace Events](https://www.twilio.com/docs/taskrouter/api/event) for
+          #   more information.
+          # @param [String] events_filter The list of Workspace events for which to call
+          #   event_callback_url. For example if
+          #   `EventsFilter=task.created,task.canceled,worker.activity.update`, then
+          #   TaskRouter will call event_callback_url only when a task is created, canceled,
+          #   or a Worker activity is updated.
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the Workspace resource. For example: `Sales Call Center` or `Customer Support
+          #   Team`.
+          # @param [Boolean] multi_task_enabled Whether to enable multi-tasking. Can be:
+          #   `true` to enable multi-tasking, or `false` to disable it. The default is
+          #   `false`. Multi-tasking allows Workers to handle multiple Tasks simultaneously.
+          #   When enabled (`true`), each Worker can receive parallel reservations up to the
+          #   per-channel maximums defined in the Workers section. Otherwise, each Worker will
+          #   only receive a new reservation when the previous task is completed. Learn more
+          #   at [Multitasking][https://www.twilio.com/docs/taskrouter/multitasking].
+          # @param [String] timeout_activity_sid The SID of the Activity that will be
+          #   assigned to a Worker when a Task reservation times out without a response.
+          # @param [workspace.QueueOrder] prioritize_queue_order The type of TaskQueue to
+          #   prioritize when Workers are receiving Tasks from both types of TaskQueues. Can
+          #   be: `LIFO` or `FIFO` and the default is `FIFO`. For more information, see [Queue
+          #   Ordering][https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo].
           # @return [WorkspaceInstance] Updated WorkspaceInstance
           def update(default_activity_sid: :unset, event_callback_url: :unset, events_filter: :unset, friendly_name: :unset, multi_task_enabled: :unset, timeout_activity_sid: :unset, prioritize_queue_order: :unset)
             data = Twilio::Values.of({
@@ -240,12 +287,12 @@ module Twilio
                 data: data,
             )
 
-            WorkspaceInstance.new(@version, payload, sid: @solution[:sid])
+            WorkspaceInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
           # Deletes the WorkspaceInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             @version.delete('delete', @uri)
           end
@@ -258,11 +305,11 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return ActivityContext.new(@version, @solution[:sid], sid)
+              return ActivityContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @activities
-              @activities = ActivityList.new(@version, workspace_sid: @solution[:sid])
+              @activities = ActivityList.new(@version, workspace_sid: @solution[:sid], )
             end
 
             @activities
@@ -276,11 +323,11 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return EventContext.new(@version, @solution[:sid], sid)
+              return EventContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @events
-              @events = EventList.new(@version, workspace_sid: @solution[:sid])
+              @events = EventList.new(@version, workspace_sid: @solution[:sid], )
             end
 
             @events
@@ -294,11 +341,11 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return TaskContext.new(@version, @solution[:sid], sid)
+              return TaskContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @tasks
-              @tasks = TaskList.new(@version, workspace_sid: @solution[:sid])
+              @tasks = TaskList.new(@version, workspace_sid: @solution[:sid], )
             end
 
             @tasks
@@ -312,11 +359,11 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return TaskQueueContext.new(@version, @solution[:sid], sid)
+              return TaskQueueContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @task_queues
-              @task_queues = TaskQueueList.new(@version, workspace_sid: @solution[:sid])
+              @task_queues = TaskQueueList.new(@version, workspace_sid: @solution[:sid], )
             end
 
             @task_queues
@@ -330,11 +377,11 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return WorkerContext.new(@version, @solution[:sid], sid)
+              return WorkerContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @workers
-              @workers = WorkerList.new(@version, workspace_sid: @solution[:sid])
+              @workers = WorkerList.new(@version, workspace_sid: @solution[:sid], )
             end
 
             @workers
@@ -348,11 +395,11 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return WorkflowContext.new(@version, @solution[:sid], sid)
+              return WorkflowContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @workflows
-              @workflows = WorkflowList.new(@version, workspace_sid: @solution[:sid])
+              @workflows = WorkflowList.new(@version, workspace_sid: @solution[:sid], )
             end
 
             @workflows
@@ -363,7 +410,7 @@ module Twilio
           # @return [WorkspaceStatisticsList]
           # @return [WorkspaceStatisticsContext]
           def statistics
-            WorkspaceStatisticsContext.new(@version, @solution[:sid])
+            WorkspaceStatisticsContext.new(@version, @solution[:sid], )
           end
 
           ##
@@ -371,7 +418,7 @@ module Twilio
           # @return [WorkspaceRealTimeStatisticsList]
           # @return [WorkspaceRealTimeStatisticsContext]
           def real_time_statistics
-            WorkspaceRealTimeStatisticsContext.new(@version, @solution[:sid])
+            WorkspaceRealTimeStatisticsContext.new(@version, @solution[:sid], )
           end
 
           ##
@@ -379,7 +426,7 @@ module Twilio
           # @return [WorkspaceCumulativeStatisticsList]
           # @return [WorkspaceCumulativeStatisticsContext]
           def cumulative_statistics
-            WorkspaceCumulativeStatisticsContext.new(@version, @solution[:sid])
+            WorkspaceCumulativeStatisticsContext.new(@version, @solution[:sid], )
           end
 
           ##
@@ -390,11 +437,11 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return TaskChannelContext.new(@version, @solution[:sid], sid)
+              return TaskChannelContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @task_channels
-              @task_channels = TaskChannelList.new(@version, workspace_sid: @solution[:sid])
+              @task_channels = TaskChannelList.new(@version, workspace_sid: @solution[:sid], )
             end
 
             @task_channels
@@ -406,6 +453,13 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<Twilio.Taskrouter.V1.WorkspaceContext #{context}>"
           end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Taskrouter.V1.WorkspaceContext #{context}>"
+          end
         end
 
         class WorkspaceInstance < InstanceResource
@@ -413,7 +467,7 @@ module Twilio
           # Initialize the WorkspaceInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid The sid
+          # @param [String] sid The SID of the Workspace resource to fetch.
           # @return [WorkspaceInstance] WorkspaceInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -439,7 +493,7 @@ module Twilio
 
             # Context
             @instance_context = nil
-            @params = {'sid' => sid || @properties['sid']}
+            @params = {'sid' => sid || @properties['sid'], }
           end
 
           ##
@@ -448,97 +502,97 @@ module Twilio
           # @return [WorkspaceContext] WorkspaceContext for this WorkspaceInstance
           def context
             unless @instance_context
-              @instance_context = WorkspaceContext.new(@version, @params['sid'])
+              @instance_context = WorkspaceContext.new(@version, @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 default_activity_name
+          # @return [String] The name of the default activity
           def default_activity_name
             @properties['default_activity_name']
           end
 
           ##
-          # @return [String] The default_activity_sid
+          # @return [String] The SID of the Activity that will be used when new Workers are created in the Workspace
           def default_activity_sid
             @properties['default_activity_sid']
           end
 
           ##
-          # @return [String] The event_callback_url
+          # @return [String] The URL we call when an event occurs
           def event_callback_url
             @properties['event_callback_url']
           end
 
           ##
-          # @return [String] The events_filter
+          # @return [String] The list of Workspace events for which to call event_callback_url
           def events_filter
             @properties['events_filter']
           end
 
           ##
-          # @return [String] The friendly_name
+          # @return [String] The string that you assigned to describe the Workspace resource
           def friendly_name
             @properties['friendly_name']
           end
 
           ##
-          # @return [Boolean] The multi_task_enabled
+          # @return [Boolean] Whether multi-tasking is enabled
           def multi_task_enabled
             @properties['multi_task_enabled']
           end
 
           ##
-          # @return [String] The sid
+          # @return [String] The unique string that identifies the resource
           def sid
             @properties['sid']
           end
 
           ##
-          # @return [String] The timeout_activity_name
+          # @return [String] The name of the timeout activity
           def timeout_activity_name
             @properties['timeout_activity_name']
           end
 
           ##
-          # @return [String] The timeout_activity_sid
+          # @return [String] The SID of the Activity that will be assigned to a Worker when a Task reservation times out without a response
           def timeout_activity_sid
             @properties['timeout_activity_sid']
           end
 
           ##
-          # @return [workspace.QueueOrder] The prioritize_queue_order
+          # @return [workspace.QueueOrder] The type of TaskQueue to prioritize when Workers are receiving Tasks from both types of TaskQueues
           def prioritize_queue_order
             @properties['prioritize_queue_order']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The absolute URL of the Workspace resource
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] The links
+          # @return [String] The URLs of related resources
           def links
             @properties['links']
           end
@@ -552,13 +606,32 @@ module Twilio
 
           ##
           # Update the WorkspaceInstance
-          # @param [String] default_activity_sid The default_activity_sid
-          # @param [String] event_callback_url The event_callback_url
-          # @param [String] events_filter The events_filter
-          # @param [String] friendly_name The friendly_name
-          # @param [Boolean] multi_task_enabled The multi_task_enabled
-          # @param [String] timeout_activity_sid The timeout_activity_sid
-          # @param [workspace.QueueOrder] prioritize_queue_order The prioritize_queue_order
+          # @param [String] default_activity_sid The SID of the Activity that will be used
+          #   when new Workers are created in the Workspace.
+          # @param [String] event_callback_url The URL we should call when an event occurs.
+          #   See [Workspace Events](https://www.twilio.com/docs/taskrouter/api/event) for
+          #   more information.
+          # @param [String] events_filter The list of Workspace events for which to call
+          #   event_callback_url. For example if
+          #   `EventsFilter=task.created,task.canceled,worker.activity.update`, then
+          #   TaskRouter will call event_callback_url only when a task is created, canceled,
+          #   or a Worker activity is updated.
+          # @param [String] friendly_name A descriptive string that you create to describe
+          #   the Workspace resource. For example: `Sales Call Center` or `Customer Support
+          #   Team`.
+          # @param [Boolean] multi_task_enabled Whether to enable multi-tasking. Can be:
+          #   `true` to enable multi-tasking, or `false` to disable it. The default is
+          #   `false`. Multi-tasking allows Workers to handle multiple Tasks simultaneously.
+          #   When enabled (`true`), each Worker can receive parallel reservations up to the
+          #   per-channel maximums defined in the Workers section. Otherwise, each Worker will
+          #   only receive a new reservation when the previous task is completed. Learn more
+          #   at [Multitasking][https://www.twilio.com/docs/taskrouter/multitasking].
+          # @param [String] timeout_activity_sid The SID of the Activity that will be
+          #   assigned to a Worker when a Task reservation times out without a response.
+          # @param [workspace.QueueOrder] prioritize_queue_order The type of TaskQueue to
+          #   prioritize when Workers are receiving Tasks from both types of TaskQueues. Can
+          #   be: `LIFO` or `FIFO` and the default is `FIFO`. For more information, see [Queue
+          #   Ordering][https://www.twilio.com/docs/taskrouter/queue-ordering-last-first-out-lifo].
           # @return [WorkspaceInstance] Updated WorkspaceInstance
           def update(default_activity_sid: :unset, event_callback_url: :unset, events_filter: :unset, friendly_name: :unset, multi_task_enabled: :unset, timeout_activity_sid: :unset, prioritize_queue_order: :unset)
             context.update(
@@ -574,7 +647,7 @@ module Twilio
 
           ##
           # Deletes the WorkspaceInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
           end

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -17,7 +19,7 @@ module Twilio
         end
 
         ##
-        # @param [String] sid The sid
+        # @param [String] sid The SID of the Workspace resource to fetch.
         # @return [Twilio::REST::Taskrouter::V1::WorkspaceContext] if sid was passed.
         # @return [Twilio::REST::Taskrouter::V1::WorkspaceList]
         def workspaces(sid=:unset)

data/lib/twilio-ruby/rest/taskrouter.rb

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -27,7 +29,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid The sid
+      # @param [String] sid The unique string that we created to identify the Workspace
+      #   resource.
       # @return [Twilio::REST::Taskrouter::V1::WorkspaceInstance] if sid was passed.
       # @return [Twilio::REST::Taskrouter::V1::WorkspaceList]
       def workspaces(sid=:unset)