twilio-ruby 5.15.1 → 5.58.1

data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_actions.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -18,8 +18,12 @@ module Twilio
               ##
               # Initialize the TaskActionsList
               # @param [Version] version Version that contains the resource
-              # @param [String] assistant_sid The unique ID of the parent Assistant.
-              # @param [String] task_sid The unique ID of the Task.
+              # @param [String] assistant_sid The SID of the
+              #   {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the
+              #   parent of the Task associated with the resource.
+              # @param [String] task_sid The SID of the
+              #   {Task}[https://www.twilio.com/docs/autopilot/api/task] associated with the
+              #   resource.
               # @return [TaskActionsList] TaskActionsList
               def initialize(version, assistant_sid: nil, task_sid: nil)
                 super(version)
@@ -77,8 +81,12 @@ module Twilio
               ##
               # Initialize the TaskActionsContext
               # @param [Version] version Version that contains the resource
-              # @param [String] assistant_sid The unique ID of the parent Assistant.
-              # @param [String] task_sid The unique ID of the Task.
+              # @param [String] assistant_sid The SID of the
+              #   {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the
+              #   parent of the Task for which the task actions to fetch were defined.
+              # @param [String] task_sid The SID of the
+              #   {Task}[https://www.twilio.com/docs/autopilot/api/task] for which the task
+              #   actions to fetch were defined.
               # @return [TaskActionsContext] TaskActionsContext
               def initialize(version, assistant_sid, task_sid)
                 super(version)
@@ -89,16 +97,10 @@ module Twilio
               end
 
               ##
-              # Fetch a TaskActionsInstance
+              # Fetch the TaskActionsInstance
               # @return [TaskActionsInstance] Fetched TaskActionsInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 TaskActionsInstance.new(
                     @version,
@@ -110,17 +112,14 @@ module Twilio
 
               ##
               # Update the TaskActionsInstance
-              # @param [Hash] actions The JSON actions that instruct the Assistant how to
-              #   perform this task.
+              # @param [Hash] actions The JSON string that specifies the
+              #   {actions}[https://www.twilio.com/docs/autopilot/actions] that instruct the
+              #   Assistant on how to perform the task.
               # @return [TaskActionsInstance] Updated TaskActionsInstance
               def update(actions: :unset)
                 data = Twilio::Values.of({'Actions' => Twilio.serialize_object(actions), })
 
-                payload = @version.update(
-                    'POST',
-                    @uri,
-                    data: data,
-                )
+                payload = @version.update('POST', @uri, data: data)
 
                 TaskActionsInstance.new(
                     @version,
@@ -136,6 +135,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Autopilot.V1.TaskActionsContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Autopilot.V1.TaskActionsContext #{context}>"
+              end
             end
 
             ##
@@ -145,8 +151,12 @@ module Twilio
               # Initialize the TaskActionsInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] assistant_sid The unique ID of the parent Assistant.
-              # @param [String] task_sid The unique ID of the Task.
+              # @param [String] assistant_sid The SID of the
+              #   {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the
+              #   parent of the Task associated with the resource.
+              # @param [String] task_sid The SID of the
+              #   {Task}[https://www.twilio.com/docs/autopilot/api/task] associated with the
+              #   resource.
               # @return [TaskActionsInstance] TaskActionsInstance
               def initialize(version, payload, assistant_sid: nil, task_sid: nil)
                 super(version)
@@ -177,37 +187,37 @@ module Twilio
               end
 
               ##
-              # @return [String] The unique ID of the Account that created this Field.
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The unique ID of the parent Assistant.
+              # @return [String] The SID of the Assistant that is the parent of the Task associated with the resource
               def assistant_sid
                 @properties['assistant_sid']
               end
 
               ##
-              # @return [String] The unique ID of the Task.
+              # @return [String] The SID of the Task associated with the resource
               def task_sid
                 @properties['task_sid']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The absolute URL of the TaskActions resource
               def url
                 @properties['url']
               end
 
               ##
-              # @return [Hash] The data
+              # @return [Hash] The JSON string that specifies the actions that instruct the Assistant on how to perform the task
               def data
                 @properties['data']
               end
 
               ##
-              # Fetch a TaskActionsInstance
+              # Fetch the TaskActionsInstance
               # @return [TaskActionsInstance] Fetched TaskActionsInstance
               def fetch
                 context.fetch
@@ -215,8 +225,9 @@ module Twilio
 
               ##
               # Update the TaskActionsInstance
-              # @param [Hash] actions The JSON actions that instruct the Assistant how to
-              #   perform this task.
+              # @param [Hash] actions The JSON string that specifies the
+              #   {actions}[https://www.twilio.com/docs/autopilot/actions] that instruct the
+              #   Assistant on how to perform the task.
               # @return [TaskActionsInstance] Updated TaskActionsInstance
               def update(actions: :unset)
                 context.update(actions: actions, )

data/lib/twilio-ruby/rest/autopilot/v1/assistant/task/task_statistics.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -18,8 +18,12 @@ module Twilio
               ##
               # Initialize the TaskStatisticsList
               # @param [Version] version Version that contains the resource
-              # @param [String] assistant_sid The unique ID of the parent Assistant.
-              # @param [String] task_sid The unique ID of the Task associated with this Field.
+              # @param [String] assistant_sid The SID of the
+              #   {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the
+              #   parent of the Task associated with the resource.
+              # @param [String] task_sid The SID of the
+              #   {Task}[https://www.twilio.com/docs/autopilot/api/task] for which the statistics
+              #   were collected.
               # @return [TaskStatisticsList] TaskStatisticsList
               def initialize(version, assistant_sid: nil, task_sid: nil)
                 super(version)
@@ -77,8 +81,12 @@ module Twilio
               ##
               # Initialize the TaskStatisticsContext
               # @param [Version] version Version that contains the resource
-              # @param [String] assistant_sid The assistant_sid
-              # @param [String] task_sid The task_sid
+              # @param [String] assistant_sid The SID of the
+              #   {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the
+              #   parent of the resource to fetch.
+              # @param [String] task_sid The SID of the
+              #   {Task}[https://www.twilio.com/docs/autopilot/api/task] that is associated with
+              #   the resource to fetch.
               # @return [TaskStatisticsContext] TaskStatisticsContext
               def initialize(version, assistant_sid, task_sid)
                 super(version)
@@ -89,16 +97,10 @@ module Twilio
               end
 
               ##
-              # Fetch a TaskStatisticsInstance
+              # Fetch the TaskStatisticsInstance
               # @return [TaskStatisticsInstance] Fetched TaskStatisticsInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 TaskStatisticsInstance.new(
                     @version,
@@ -114,6 +116,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Autopilot.V1.TaskStatisticsContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Autopilot.V1.TaskStatisticsContext #{context}>"
+              end
             end
 
             ##
@@ -123,8 +132,12 @@ module Twilio
               # Initialize the TaskStatisticsInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] assistant_sid The unique ID of the parent Assistant.
-              # @param [String] task_sid The unique ID of the Task associated with this Field.
+              # @param [String] assistant_sid The SID of the
+              #   {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the
+              #   parent of the Task associated with the resource.
+              # @param [String] task_sid The SID of the
+              #   {Task}[https://www.twilio.com/docs/autopilot/api/task] for which the statistics
+              #   were collected.
               # @return [TaskStatisticsInstance] TaskStatisticsInstance
               def initialize(version, payload, assistant_sid: nil, task_sid: nil)
                 super(version)
@@ -160,43 +173,43 @@ module Twilio
               end
 
               ##
-              # @return [String] The unique ID of the Account that created this Field.
+              # @return [String] The SID of the Account that created the resource
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The unique ID of the parent Assistant.
+              # @return [String] The SID of the Assistant that is the parent of the Task associated with the resource
               def assistant_sid
                 @properties['assistant_sid']
               end
 
               ##
-              # @return [String] The unique ID of the Task associated with this Field.
+              # @return [String] The SID of the Task for which the statistics were collected
               def task_sid
                 @properties['task_sid']
               end
 
               ##
-              # @return [String] The total number of Samples associated with this Task.
+              # @return [String] The total number of Samples associated with the Task
               def samples_count
                 @properties['samples_count']
               end
 
               ##
-              # @return [String] The total number of Fields associated with this Task.
+              # @return [String] The total number of Fields associated with the Task
               def fields_count
                 @properties['fields_count']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The absolute URL of the TaskStatistics resource
               def url
                 @properties['url']
               end
 
               ##
-              # Fetch a TaskStatisticsInstance
+              # Fetch the TaskStatisticsInstance
               # @return [TaskStatisticsInstance] Fetched TaskStatisticsInstance
               def fetch
                 context.fetch

data/lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -17,7 +17,9 @@ module Twilio
             ##
             # Initialize the TaskList
             # @param [Version] version Version that contains the resource
-            # @param [String] assistant_sid The unique ID of the Assistant.
+            # @param [String] assistant_sid The SID of the
+            #   {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the
+            #   parent of the resource.
             # @return [TaskList] TaskList
             def initialize(version, assistant_sid: nil)
               super(version)
@@ -88,11 +90,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               TaskPage.new(@version, response, @solution)
             end
 
@@ -110,15 +110,18 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of TaskInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] unique_name A user-provided string that uniquely identifies this
-            #   resource as an alternative to the sid. Unique up to 64 characters long.
-            # @param [String] friendly_name A user-provided string that identifies this
-            #   resource. It is non-unique and can be up to 255 characters long.
-            # @param [Hash] actions The actions
-            # @param [String] actions_url The actions_url
-            # @return [TaskInstance] Newly created TaskInstance
+            # Create the TaskInstance
+            # @param [String] unique_name An application-defined string that uniquely
+            #   identifies the new resource. It can be used as an alternative to the `sid` in
+            #   the URL path to address the resource. This value must be unique and 64
+            #   characters or less in length.
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the new resource. It is not unique and can be up to 255 characters long.
+            # @param [Hash] actions The JSON string that specifies the
+            #   {actions}[https://www.twilio.com/docs/autopilot/actions] that instruct the
+            #   Assistant on how to perform the task. It is optional and not unique.
+            # @param [String] actions_url The URL from which the Assistant can fetch actions.
+            # @return [TaskInstance] Created TaskInstance
             def create(unique_name: nil, friendly_name: :unset, actions: :unset, actions_url: :unset)
               data = Twilio::Values.of({
                   'UniqueName' => unique_name,
@@ -127,11 +130,7 @@ module Twilio
                   'ActionsUrl' => actions_url,
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               TaskInstance.new(@version, payload, assistant_sid: @solution[:assistant_sid], )
             end
@@ -180,8 +179,11 @@ module Twilio
             ##
             # Initialize the TaskContext
             # @param [Version] version Version that contains the resource
-            # @param [String] assistant_sid The assistant_sid
-            # @param [String] sid The sid
+            # @param [String] assistant_sid The SID of the
+            #   {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the
+            #   parent of the resource to fetch.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the Task
+            #   resource to fetch.
             # @return [TaskContext] TaskContext
             def initialize(version, assistant_sid, sid)
               super(version)
@@ -198,28 +200,26 @@ module Twilio
             end
 
             ##
-            # Fetch a TaskInstance
+            # Fetch the TaskInstance
             # @return [TaskInstance] Fetched TaskInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               TaskInstance.new(@version, payload, assistant_sid: @solution[:assistant_sid], sid: @solution[:sid], )
             end
 
             ##
             # Update the TaskInstance
-            # @param [String] friendly_name A user-provided string that identifies this
-            #   resource. It is non-unique and can be up to 255 characters long.
-            # @param [String] unique_name A user-provided string that uniquely identifies this
-            #   resource as an alternative to the sid. Unique up to 64 characters long.
-            # @param [Hash] actions The actions
-            # @param [String] actions_url The actions_url
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It is not unique and can be up to 255 characters long.
+            # @param [String] unique_name An application-defined string that uniquely
+            #   identifies the resource. This value must be 64 characters or less in length and
+            #   be unique. It can be used as an alternative to the `sid` in the URL path to
+            #   address the resource.
+            # @param [Hash] actions The JSON string that specifies the
+            #   {actions}[https://www.twilio.com/docs/autopilot/actions] that instruct the
+            #   Assistant on how to perform the task.
+            # @param [String] actions_url The URL from which the Assistant can fetch actions.
             # @return [TaskInstance] Updated TaskInstance
             def update(friendly_name: :unset, unique_name: :unset, actions: :unset, actions_url: :unset)
               data = Twilio::Values.of({
@@ -229,20 +229,16 @@ module Twilio
                   'ActionsUrl' => actions_url,
               })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               TaskInstance.new(@version, payload, assistant_sid: @solution[:assistant_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the TaskInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the TaskInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -311,6 +307,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Autopilot.V1.TaskContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Autopilot.V1.TaskContext #{context}>"
+            end
           end
 
           ##
@@ -320,8 +323,11 @@ module Twilio
             # Initialize the TaskInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] assistant_sid The unique ID of the Assistant.
-            # @param [String] sid The sid
+            # @param [String] assistant_sid The SID of the
+            #   {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the
+            #   parent of the resource.
+            # @param [String] sid The Twilio-provided string that uniquely identifies the Task
+            #   resource to fetch.
             # @return [TaskInstance] TaskInstance
             def initialize(version, payload, assistant_sid: nil, sid: nil)
               super(version)
@@ -357,67 +363,67 @@ module Twilio
             end
 
             ##
-            # @return [String] The unique ID of the Account that created this Task.
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [Time] The date that this resource was 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 that this resource was last 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] A user-provided string that identifies this resource. It is non-unique and can be up to 255 characters long.
+            # @return [String] The string that you assigned to describe the resource
             def friendly_name
               @properties['friendly_name']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] A list of the URLs of related resources
             def links
               @properties['links']
             end
 
             ##
-            # @return [String] The unique ID of the Assistant.
+            # @return [String] The SID of the Assistant that is the parent of the resource
             def assistant_sid
               @properties['assistant_sid']
             end
 
             ##
-            # @return [String] A 34 character string that uniquely identifies this resource.
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] A user-provided string that uniquely identifies this resource as an alternative to the sid. Unique up to 64 characters long.
+            # @return [String] An application-defined string that uniquely identifies the resource
             def unique_name
               @properties['unique_name']
             end
 
             ##
-            # @return [String] User-provided HTTP endpoint where the assistant can fetch actions.
+            # @return [String] The URL from which the Assistant can fetch actions
             def actions_url
               @properties['actions_url']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the Task resource
             def url
               @properties['url']
             end
 
             ##
-            # Fetch a TaskInstance
+            # Fetch the TaskInstance
             # @return [TaskInstance] Fetched TaskInstance
             def fetch
               context.fetch
@@ -425,12 +431,16 @@ module Twilio
 
             ##
             # Update the TaskInstance
-            # @param [String] friendly_name A user-provided string that identifies this
-            #   resource. It is non-unique and can be up to 255 characters long.
-            # @param [String] unique_name A user-provided string that uniquely identifies this
-            #   resource as an alternative to the sid. Unique up to 64 characters long.
-            # @param [Hash] actions The actions
-            # @param [String] actions_url The actions_url
+            # @param [String] friendly_name A descriptive string that you create to describe
+            #   the resource. It is not unique and can be up to 255 characters long.
+            # @param [String] unique_name An application-defined string that uniquely
+            #   identifies the resource. This value must be 64 characters or less in length and
+            #   be unique. It can be used as an alternative to the `sid` in the URL path to
+            #   address the resource.
+            # @param [Hash] actions The JSON string that specifies the
+            #   {actions}[https://www.twilio.com/docs/autopilot/actions] that instruct the
+            #   Assistant on how to perform the task.
+            # @param [String] actions_url The URL from which the Assistant can fetch actions.
             # @return [TaskInstance] Updated TaskInstance
             def update(friendly_name: :unset, unique_name: :unset, actions: :unset, actions_url: :unset)
               context.update(
@@ -442,8 +452,8 @@ module Twilio
             end
 
             ##
-            # Deletes the TaskInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the TaskInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end