twilio-ruby 5.20.0 → 5.47.0

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -17,7 +17,9 @@ module Twilio
             ##
             # Initialize the DefaultsList
             # @param [Version] version Version that contains the resource
-            # @param [String] assistant_sid The assistant_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.
             # @return [DefaultsList] DefaultsList
             def initialize(version, assistant_sid: nil)
               super(version)
@@ -70,7 +72,9 @@ module Twilio
             ##
             # Initialize the DefaultsContext
             # @param [Version] version Version that contains the resource
-            # @param [String] assistant_sid The assistant_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.
             # @return [DefaultsContext] DefaultsContext
             def initialize(version, assistant_sid)
               super(version)
@@ -81,32 +85,23 @@ module Twilio
             end
 
             ##
-            # Fetch a DefaultsInstance
+            # Fetch the DefaultsInstance
             # @return [DefaultsInstance] Fetched DefaultsInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               DefaultsInstance.new(@version, payload, assistant_sid: @solution[:assistant_sid], )
             end
 
             ##
             # Update the DefaultsInstance
-            # @param [Hash] defaults The defaults
+            # @param [Hash] defaults A JSON string that describes the default task links for
+            #   the `assistant_initiation`, `collect`, and `fallback` situations.
             # @return [DefaultsInstance] Updated DefaultsInstance
             def update(defaults: :unset)
               data = Twilio::Values.of({'Defaults' => Twilio.serialize_object(defaults), })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               DefaultsInstance.new(@version, payload, assistant_sid: @solution[:assistant_sid], )
             end
@@ -117,6 +112,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Autopilot.V1.DefaultsContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Autopilot.V1.DefaultsContext #{context}>"
+            end
           end
 
           ##
@@ -126,7 +128,9 @@ module Twilio
             # Initialize the DefaultsInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] assistant_sid The assistant_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.
             # @return [DefaultsInstance] DefaultsInstance
             def initialize(version, payload, assistant_sid: nil)
               super(version)
@@ -156,31 +160,31 @@ module Twilio
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The assistant_sid
+            # @return [String] The SID of the Assistant that is the parent of the resource
             def assistant_sid
               @properties['assistant_sid']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the Defaults resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [Hash] The data
+            # @return [Hash] The JSON string that describes the default task links
             def data
               @properties['data']
             end
 
             ##
-            # Fetch a DefaultsInstance
+            # Fetch the DefaultsInstance
             # @return [DefaultsInstance] Fetched DefaultsInstance
             def fetch
               context.fetch
@@ -188,7 +192,8 @@ module Twilio
 
             ##
             # Update the DefaultsInstance
-            # @param [Hash] defaults The defaults
+            # @param [Hash] defaults A JSON string that describes the default task links for
+            #   the `assistant_initiation`, `collect`, and `fallback` situations.
             # @return [DefaultsInstance] Updated DefaultsInstance
             def update(defaults: :unset)
               context.update(defaults: defaults, )

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -17,7 +17,9 @@ module Twilio
             ##
             # Initialize the DialogueList
             # @param [Version] version Version that contains the resource
-            # @param [String] assistant_sid The unique ID of the parent 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 [DialogueList] DialogueList
             def initialize(version, assistant_sid: nil)
               super(version)
@@ -70,8 +72,11 @@ module Twilio
             ##
             # Initialize the DialogueContext
             # @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
+            #   Dialogue resource to fetch.
             # @return [DialogueContext] DialogueContext
             def initialize(version, assistant_sid, sid)
               super(version)
@@ -82,16 +87,10 @@ module Twilio
             end
 
             ##
-            # Fetch a DialogueInstance
+            # Fetch the DialogueInstance
             # @return [DialogueInstance] Fetched DialogueInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               DialogueInstance.new(
                   @version,
@@ -107,6 +106,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Autopilot.V1.DialogueContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Autopilot.V1.DialogueContext #{context}>"
+            end
           end
 
           ##
@@ -116,8 +122,11 @@ module Twilio
             # Initialize the DialogueInstance
             # @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] 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
+            #   Dialogue resource to fetch.
             # @return [DialogueInstance] DialogueInstance
             def initialize(version, payload, assistant_sid: nil, sid: nil)
               super(version)
@@ -148,37 +157,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 resource
             def assistant_sid
               @properties['assistant_sid']
             end
 
             ##
-            # @return [String] The unique ID of the Dialogue
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [Hash] The dialogue session object as json
+            # @return [Hash] The JSON string that describes the dialogue session object
             def data
               @properties['data']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The absolute URL of the Dialogue resource
             def url
               @properties['url']
             end
 
             ##
-            # Fetch a DialogueInstance
+            # Fetch the DialogueInstance
             # @return [DialogueInstance] Fetched DialogueInstance
             def fetch
               context.fetch

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -17,7 +17,9 @@ module Twilio
             ##
             # Initialize the FieldTypeList
             # @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 [FieldTypeList] FieldTypeList
             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)
+
               FieldTypePage.new(@version, response, @solution)
             end
 
@@ -110,21 +110,17 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of FieldTypeInstance 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.
-            # @return [FieldTypeInstance] Newly created FieldTypeInstance
+            # Create the FieldTypeInstance
+            # @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. The first 64 characters must be unique.
+            # @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.
+            # @return [FieldTypeInstance] Created FieldTypeInstance
             def create(unique_name: nil, friendly_name: :unset)
               data = Twilio::Values.of({'UniqueName' => unique_name, 'FriendlyName' => friendly_name, })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               FieldTypeInstance.new(@version, payload, assistant_sid: @solution[:assistant_sid], )
             end
@@ -173,9 +169,11 @@ module Twilio
             ##
             # Initialize the FieldTypeContext
             # @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
+            #   FieldType resource to fetch.
             # @return [FieldTypeContext] FieldTypeContext
             def initialize(version, assistant_sid, sid)
               super(version)
@@ -189,16 +187,10 @@ module Twilio
             end
 
             ##
-            # Fetch a FieldTypeInstance
+            # Fetch the FieldTypeInstance
             # @return [FieldTypeInstance] Fetched FieldTypeInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               FieldTypeInstance.new(
                   @version,
@@ -210,19 +202,16 @@ module Twilio
 
             ##
             # Update the FieldTypeInstance
-            # @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 [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. It can be used as an alternative to the `sid` in the
+            #   URL path to address the resource. The first 64 characters must be unique.
             # @return [FieldTypeInstance] Updated FieldTypeInstance
             def update(friendly_name: :unset, unique_name: :unset)
               data = Twilio::Values.of({'FriendlyName' => friendly_name, 'UniqueName' => unique_name, })
 
-              payload = @version.update(
-                  'POST',
-                  @uri,
-                  data: data,
-              )
+              payload = @version.update('POST', @uri, data: data)
 
               FieldTypeInstance.new(
                   @version,
@@ -233,10 +222,10 @@ module Twilio
             end
 
             ##
-            # Deletes the FieldTypeInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the FieldTypeInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -267,6 +256,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<Twilio.Autopilot.V1.FieldTypeContext #{context}>"
             end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Autopilot.V1.FieldTypeContext #{context}>"
+            end
           end
 
           ##
@@ -276,9 +272,11 @@ module Twilio
             # Initialize the FieldTypeInstance
             # @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
+            #   FieldType resource to fetch.
             # @return [FieldTypeInstance] FieldTypeInstance
             def initialize(version, payload, assistant_sid: nil, sid: nil)
               super(version)
@@ -313,61 +311,61 @@ module Twilio
             end
 
             ##
-            # @return [String] The unique ID of the Account that created this Field Type.
+            # @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] The url
+            # @return [String] The absolute URL of the FieldType resource
             def url
               @properties['url']
             end
 
             ##
-            # Fetch a FieldTypeInstance
+            # Fetch the FieldTypeInstance
             # @return [FieldTypeInstance] Fetched FieldTypeInstance
             def fetch
               context.fetch
@@ -375,18 +373,19 @@ module Twilio
 
             ##
             # Update the FieldTypeInstance
-            # @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 [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. It can be used as an alternative to the `sid` in the
+            #   URL path to address the resource. The first 64 characters must be unique.
             # @return [FieldTypeInstance] Updated FieldTypeInstance
             def update(friendly_name: :unset, unique_name: :unset)
               context.update(friendly_name: friendly_name, unique_name: unique_name, )
             end
 
             ##
-            # Deletes the FieldTypeInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the FieldTypeInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end