twilio-ruby 5.20.0 → 5.47.0

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,17 +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 A user-provided JSON object encoded as a string to specify
-            #   the actions for this task. It is optional and non-unique.
-            # @param [String] actions_url User-provided HTTP endpoint where the assistant can
-            #   fetch actions.
-            # @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,
@@ -129,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
@@ -182,9 +179,11 @@ module Twilio
             ##
             # Initialize the TaskContext
             # @param [Version] version Version that contains the resource
-            # @param [String] assistant_sid The unique ID of the Assistant.
-            # @param [String] sid A 34-character string that uniquely identifies this
-            #   resource.
+            # @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)
@@ -201,31 +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. You can use the unique name in the URL
-            #   path when addressing this resource. Unique up to 64 characters long.
-            # @param [Hash] actions A user-provided JSON object encoded as a string to specify
-            #   the actions for this task. It is optional and non-unique.
-            # @param [String] actions_url User-provided HTTP endpoint where the assistant can
-            #   fetch actions.
+            # @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({
@@ -235,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
 
             ##
@@ -317,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
 
           ##
@@ -326,9 +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 A 34-character string that uniquely identifies this
-            #   resource.
+            # @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)
@@ -364,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] A 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
@@ -432,15 +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. You can use the unique name in the URL
-            #   path when addressing this resource. Unique up to 64 characters long.
-            # @param [Hash] actions A user-provided JSON object encoded as a string to specify
-            #   the actions for this task. It is optional and non-unique.
-            # @param [String] actions_url User-provided HTTP endpoint where the assistant can
-            #   fetch actions.
+            # @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(
@@ -452,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

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -18,8 +18,12 @@ module Twilio
               ##
               # Initialize the FieldList
               # @param [Version] version Version that contains the resource
-              # @param [String] assistant_sid The unique ID of the 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] resource associated with
+              #   this Field.
               # @return [FieldList] FieldList
               def initialize(version, assistant_sid: nil, task_sid: nil)
                 super(version)
@@ -90,11 +94,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 FieldPage.new(@version, response, @solution)
               end
 
@@ -112,23 +114,19 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of FieldInstance records from the API.
-              # Request is executed immediately.
-              # @param [String] field_type The Field Type of this field. It can be either a
-              #   [Built-in Field
-              #   Type](https://www.twilio.com/docs/assistant/api/built-in-field-types) or the
-              #   unique_name or sid of a custom Field Type.
-              # @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.
-              # @return [FieldInstance] Newly created FieldInstance
+              # Create the FieldInstance
+              # @param [String] field_type The Field Type of the new field. Can be: a {Built-in
+              #   Field Type}[https://www.twilio.com/docs/autopilot/built-in-field-types], the
+              #   `unique_name`, or the `sid` of a custom Field Type.
+              # @param [String] unique_name An application-defined string that uniquely
+              #   identifies the new resource. This value must be a unique string of no more than
+              #   64 characters. It can be used as an alternative to the `sid` in the URL path to
+              #   address the resource.
+              # @return [FieldInstance] Created FieldInstance
               def create(field_type: nil, unique_name: nil)
                 data = Twilio::Values.of({'FieldType' => field_type, 'UniqueName' => unique_name, })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 FieldInstance.new(
                     @version,
@@ -187,10 +185,14 @@ module Twilio
               ##
               # Initialize the FieldContext
               # @param [Version] version Version that contains the resource
-              # @param [String] assistant_sid The unique ID of the Assistant.
-              # @param [String] task_sid The unique ID of the Task associated with this Field.
-              # @param [String] sid A 34-character string that uniquely identifies this
-              #   resource.
+              # @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 to fetch.
+              # @param [String] task_sid The SID of the
+              #   {Task}[https://www.twilio.com/docs/autopilot/api/task] resource associated with
+              #   the Field resource to fetch.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Field resource to fetch.
               # @return [FieldContext] FieldContext
               def initialize(version, assistant_sid, task_sid, sid)
                 super(version)
@@ -201,16 +203,10 @@ module Twilio
               end
 
               ##
-              # Fetch a FieldInstance
+              # Fetch the FieldInstance
               # @return [FieldInstance] Fetched FieldInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 FieldInstance.new(
                     @version,
@@ -222,10 +218,10 @@ module Twilio
               end
 
               ##
-              # Deletes the FieldInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the FieldInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -234,6 +230,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Autopilot.V1.FieldContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Autopilot.V1.FieldContext #{context}>"
+              end
             end
 
             ##
@@ -243,10 +246,14 @@ module Twilio
               # Initialize the FieldInstance
               # @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] task_sid The unique ID of the Task associated with this Field.
-              # @param [String] sid A 34-character string that uniquely identifies this
-              #   resource.
+              # @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] resource associated with
+              #   this Field.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   Field resource to fetch.
               # @return [FieldInstance] FieldInstance
               def initialize(version, payload, assistant_sid: nil, task_sid: nil, sid: nil)
                 super(version)
@@ -290,69 +297,69 @@ 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 [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] The Field Type of this field. It can be either a Built-in Field Type or the unique_name or sid of a custom Field Type.
+              # @return [String] The Field Type of the field
               def field_type
                 @properties['field_type']
               end
 
               ##
-              # @return [String] The unique ID of the Task associated with this Field.
+              # @return [String] The SID of the {Task}[https://www.twilio.com/docs/autopilot/api/task] resource associated with this Field
               def task_sid
                 @properties['task_sid']
               end
 
               ##
-              # @return [String] The unique ID of the 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] 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] The url
+              # @return [String] The absolute URL of the Field resource
               def url
                 @properties['url']
               end
 
               ##
-              # Fetch a FieldInstance
+              # Fetch the FieldInstance
               # @return [FieldInstance] Fetched FieldInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the FieldInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the FieldInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end