twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,6 +3,8 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
@@ -13,7 +15,8 @@ module Twilio
             ##
             # Initialize the ActivityList
             # @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
+            #   Activity.
             # @return [ActivityList] ActivityList
             def initialize(version, workspace_sid: nil)
               super(version)
@@ -27,8 +30,12 @@ module Twilio
             # Lists ActivityInstance 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] available The available
+            # @param [String] friendly_name The `friendly_name` of the Activity resources to
+            #   read.
+            # @param [String] available Whether return only Activity resources that are
+            #   available or unavailable. A value of `true` returns only available activities.
+            #   Values of '1' or `yes` also indicate `true`. All other values represent `false`
+            #   and return activities that are unavailable.
             # @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
@@ -49,8 +56,12 @@ module Twilio
             # Streams ActivityInstance 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] available The available
+            # @param [String] friendly_name The `friendly_name` of the Activity resources to
+            #   read.
+            # @param [String] available Whether return only Activity resources that are
+            #   available or unavailable. A value of `true` returns only available activities.
+            #   Values of '1' or `yes` also indicate `true`. All other values represent `false`
+            #   and return activities that are unavailable.
             # @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
@@ -61,7 +72,7 @@ module Twilio
             def stream(friendly_name: :unset, available: :unset, limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(friendly_name: friendly_name, available: available, page_size: limits[:page_size])
+              page = self.page(friendly_name: friendly_name, available: available, page_size: limits[:page_size], )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -73,7 +84,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],
@@ -83,8 +94,12 @@ module Twilio
             ##
             # Retrieve a single page of ActivityInstance records from the API.
             # Request is executed immediately.
-            # @param [String] friendly_name The friendly_name
-            # @param [String] available The available
+            # @param [String] friendly_name The `friendly_name` of the Activity resources to
+            #   read.
+            # @param [String] available Whether return only Activity resources that are
+            #   available or unavailable. A value of `true` returns only available activities.
+            #   Values of '1' or `yes` also indicate `true`. All other values represent `false`
+            #   and return activities that are unavailable.
             # @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
@@ -97,11 +112,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               ActivityPage.new(@version, response, @solution)
             end
 
@@ -119,21 +132,23 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of ActivityInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] friendly_name The friendly_name
-            # @param [Boolean] available The available
-            # @return [ActivityInstance] Newly created ActivityInstance
+            # Create the ActivityInstance
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the Activity resource. It can be up to 64 characters long. These names are used
+            #   to calculate and expose statistics about Workers, and provide visibility into
+            #   the state of each Worker. Examples of friendly names include: `on-call`,
+            #   `break`, and `email`.
+            # @param [Boolean] available Whether the Worker should be eligible to receive a
+            #   Task when it occupies the Activity. A value of `true`, `1`, or `yes` specifies
+            #   the Activity is available. All other values specify that it is not. The value
+            #   cannot be changed after the Activity is created.
+            # @return [ActivityInstance] Created ActivityInstance
             def create(friendly_name: nil, available: :unset)
-              data = Twilio::Values.of({'FriendlyName' => friendly_name, 'Available' => available})
+              data = Twilio::Values.of({'FriendlyName' => friendly_name, 'Available' => available, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
-              ActivityInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid])
+              ActivityInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
             end
 
             ##
@@ -162,7 +177,7 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [ActivityInstance] ActivityInstance
             def get_instance(payload)
-              ActivityInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid])
+              ActivityInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], )
             end
 
             ##
@@ -176,53 +191,58 @@ module Twilio
             ##
             # Initialize the ActivityContext
             # @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 Activity
+            #   resources to fetch.
+            # @param [String] sid The SID of the Activity resource to fetch.
             # @return [ActivityContext] ActivityContext
             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]}/Activities/#{@solution[:sid]}"
             end
 
             ##
-            # Fetch a ActivityInstance
+            # Fetch the ActivityInstance
             # @return [ActivityInstance] Fetched ActivityInstance
             def fetch
-              params = Twilio::Values.of({})
+              payload = @version.fetch('GET', @uri)
 
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
+              ActivityInstance.new(
+                  @version,
+                  payload,
+                  workspace_sid: @solution[:workspace_sid],
+                  sid: @solution[:sid],
               )
-
-              ActivityInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], sid: @solution[:sid])
             end
 
             ##
             # Update the ActivityInstance
-            # @param [String] friendly_name The friendly_name
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the Activity resource. It can be up to 64 characters long. These names are used
+            #   to calculate and expose statistics about Workers, and provide visibility into
+            #   the state of each Worker. Examples of friendly names include: `on-call`,
+            #   `break`, and `email`.
             # @return [ActivityInstance] Updated ActivityInstance
             def update(friendly_name: :unset)
-              data = Twilio::Values.of({'FriendlyName' => friendly_name})
+              data = Twilio::Values.of({'FriendlyName' => friendly_name, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
-              ActivityInstance.new(@version, payload, workspace_sid: @solution[:workspace_sid], sid: @solution[:sid])
+              ActivityInstance.new(
+                  @version,
+                  payload,
+                  workspace_sid: @solution[:workspace_sid],
+                  sid: @solution[:sid],
+              )
             end
 
             ##
-            # Deletes the ActivityInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the ActivityInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -231,6 +251,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Taskrouter.V1.ActivityContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Taskrouter.V1.ActivityContext #{context}>"
+            end
           end
 
           class ActivityInstance < InstanceResource
@@ -238,8 +265,9 @@ module Twilio
             # Initialize the ActivityInstance
             # @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
+            #   Activity.
+            # @param [String] sid The SID of the Activity resource to fetch.
             # @return [ActivityInstance] ActivityInstance
             def initialize(version, payload, workspace_sid: nil, sid: nil)
               super(version)
@@ -254,11 +282,12 @@ module Twilio
                   'sid' => payload['sid'],
                   'workspace_sid' => payload['workspace_sid'],
                   '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
 
             ##
@@ -267,61 +296,67 @@ module Twilio
             # @return [ActivityContext] ActivityContext for this ActivityInstance
             def context
               unless @instance_context
-                @instance_context = ActivityContext.new(@version, @params['workspace_sid'], @params['sid'])
+                @instance_context = ActivityContext.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 [Boolean] The available
+            # @return [Boolean] Whether the Worker should be eligible to receive a Task when it occupies the Activity
             def available
               @properties['available']
             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 Activity 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 workspace_sid
+            # @return [String] The SID of the Workspace that contains the Activity
             def workspace_sid
               @properties['workspace_sid']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the Activity resource
             def url
               @properties['url']
             end
 
             ##
-            # Fetch a ActivityInstance
+            # @return [String] The links
+            def links
+              @properties['links']
+            end
+
+            ##
+            # Fetch the ActivityInstance
             # @return [ActivityInstance] Fetched ActivityInstance
             def fetch
               context.fetch
@@ -329,15 +364,19 @@ module Twilio
 
             ##
             # Update the ActivityInstance
-            # @param [String] friendly_name The friendly_name
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the Activity resource. It can be up to 64 characters long. These names are used
+            #   to calculate and expose statistics about Workers, and provide visibility into
+            #   the state of each Worker. Examples of friendly names include: `on-call`,
+            #   `break`, and `email`.
             # @return [ActivityInstance] Updated ActivityInstance
             def update(friendly_name: :unset)
-              context.update(friendly_name: friendly_name)
+              context.update(friendly_name: friendly_name, )
             end
 
             ##
-            # Deletes the ActivityInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the ActivityInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end