twilio-ruby 5.19.0 → 5.77.0

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -18,9 +18,11 @@ module Twilio
               ##
               # Initialize the FieldValueList
               # @param [Version] version Version that contains the resource
-              # @param [String] assistant_sid The unique ID of the Assistant.
-              # @param [String] field_type_sid The unique ID of the Field Type associated with
-              #   this Field Value.
+              # @param [String] assistant_sid The SID of the
+              #   {Assistant}[https://www.twilio.com/docs/autopilot/api/assistant] that is the
+              #   parent of the FieldType associated with the resource.
+              # @param [String] field_type_sid The SID of the Field Type associated with the
+              #   Field Value.
               # @return [FieldValueList] FieldValueList
               def initialize(version, assistant_sid: nil, field_type_sid: nil)
                 super(version)
@@ -34,8 +36,9 @@ module Twilio
               # Lists FieldValueInstance records from the API as a list.
               # Unlike stream(), this operation is eager and will load `limit` records into
               # memory before returning.
-              # @param [String] language An ISO language-country string that specifies the
-              #   language used for this field value. For example: en-US
+              # @param [String] language The {ISO
+              #   language-country}[https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html]
+              #   tag that specifies the language of the value. Currently supported tags: `en-US`
               # @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
@@ -51,8 +54,9 @@ module Twilio
               # Streams FieldValueInstance records from the API as an Enumerable.
               # This operation lazily loads records as efficiently as possible until the limit
               # is reached.
-              # @param [String] language An ISO language-country string that specifies the
-              #   language used for this field value. For example: en-US
+              # @param [String] language The {ISO
+              #   language-country}[https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html]
+              #   tag that specifies the language of the value. Currently supported tags: `en-US`
               # @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
@@ -85,8 +89,9 @@ module Twilio
               ##
               # Retrieve a single page of FieldValueInstance records from the API.
               # Request is executed immediately.
-              # @param [String] language An ISO language-country string that specifies the
-              #   language used for this field value. For example: en-US
+              # @param [String] language The {ISO
+              #   language-country}[https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html]
+              #   tag that specifies the language of the value. Currently supported tags: `en-US`
               # @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
@@ -98,11 +103,9 @@ module Twilio
                     'Page' => page_number,
                     'PageSize' => page_size,
                 })
-                response = @version.page(
-                    'GET',
-                    @uri,
-                    params
-                )
+
+                response = @version.page('GET', @uri, params: params)
+
                 FieldValuePage.new(@version, response, @solution)
               end
 
@@ -120,23 +123,18 @@ module Twilio
               end
 
               ##
-              # Retrieve a single page of FieldValueInstance records from the API.
-              # Request is executed immediately.
-              # @param [String] language An ISO language-country string that specifies the
-              #   language used for this field value. For example: en-US
-              # @param [String] value A user-provided string that uniquely identifies this
-              #   resource as an alternative to the sid. Unique up to 64 characters long.
-              # @param [String] synonym_of A string value that indicates which word this field
+              # Create the FieldValueInstance
+              # @param [String] language The {ISO
+              #   language-country}[https://docs.oracle.com/cd/E13214_01/wli/docs92/xref/xqisocodes.html]
+              #   tag that specifies the language of the value. Currently supported tags: `en-US`
+              # @param [String] value The Field Value data.
+              # @param [String] synonym_of The string value that indicates which word the field
               #   value is a synonym of.
-              # @return [FieldValueInstance] Newly created FieldValueInstance
+              # @return [FieldValueInstance] Created FieldValueInstance
               def create(language: nil, value: nil, synonym_of: :unset)
                 data = Twilio::Values.of({'Language' => language, 'Value' => value, 'SynonymOf' => synonym_of, })
 
-                payload = @version.create(
-                    'POST',
-                    @uri,
-                    data: data
-                )
+                payload = @version.create('POST', @uri, data: data)
 
                 FieldValueInstance.new(
                     @version,
@@ -195,10 +193,13 @@ module Twilio
               ##
               # Initialize the FieldValueContext
               # @param [Version] version Version that contains the resource
-              # @param [String] assistant_sid The unique ID of the Assistant
-              # @param [String] field_type_sid The unique ID of the Field Type associated with
-              #   this Field Value
-              # @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 FieldType associated with the resource to fetch.
+              # @param [String] field_type_sid The SID of the Field Type associated with the
+              #   Field Value to fetch.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   FieldValue resource to fetch.
               # @return [FieldValueContext] FieldValueContext
               def initialize(version, assistant_sid, field_type_sid, sid)
                 super(version)
@@ -209,16 +210,10 @@ module Twilio
               end
 
               ##
-              # Fetch a FieldValueInstance
+              # Fetch the FieldValueInstance
               # @return [FieldValueInstance] Fetched FieldValueInstance
               def fetch
-                params = Twilio::Values.of({})
-
-                payload = @version.fetch(
-                    'GET',
-                    @uri,
-                    params,
-                )
+                payload = @version.fetch('GET', @uri)
 
                 FieldValueInstance.new(
                     @version,
@@ -230,10 +225,10 @@ module Twilio
               end
 
               ##
-              # Deletes the FieldValueInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the FieldValueInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
-                @version.delete('delete', @uri)
+                 @version.delete('DELETE', @uri)
               end
 
               ##
@@ -242,6 +237,13 @@ module Twilio
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
                 "#<Twilio.Autopilot.V1.FieldValueContext #{context}>"
               end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Autopilot.V1.FieldValueContext #{context}>"
+              end
             end
 
             ##
@@ -251,10 +253,13 @@ module Twilio
               # Initialize the FieldValueInstance
               # @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] field_type_sid The unique ID of the Field Type associated with
-              #   this Field Value.
-              # @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 FieldType associated with the resource.
+              # @param [String] field_type_sid The SID of the Field Type associated with the
+              #   Field Value.
+              # @param [String] sid The Twilio-provided string that uniquely identifies the
+              #   FieldValue resource to fetch.
               # @return [FieldValueInstance] FieldValueInstance
               def initialize(version, payload, assistant_sid: nil, field_type_sid: nil, sid: nil)
                 super(version)
@@ -299,75 +304,75 @@ module Twilio
               end
 
               ##
-              # @return [String] The unique ID of the Account that created this Field Value.
+              # @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 unique ID of the Field Type associated with this Field Value.
+              # @return [String] The SID of the Field Type associated with the Field Value
               def field_type_sid
                 @properties['field_type_sid']
               end
 
               ##
-              # @return [String] An ISO language-country string of the value (currently supported: `en-US`, `nl-NL`)
+              # @return [String] The ISO language-country tag that identifies the language of the value
               def language
                 @properties['language']
               end
 
               ##
-              # @return [String] The unique ID of the Assistant.
+              # @return [String] The SID of the Assistant that is the parent of the FieldType 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] The Field Value itself.
+              # @return [String] The Field Value data
               def value
                 @properties['value']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The absolute URL of the FieldValue resource
               def url
                 @properties['url']
               end
 
               ##
-              # @return [String] A string value that indicates which word this field value is a synonym of.
+              # @return [String] The word for which the field value is a synonym of
               def synonym_of
                 @properties['synonym_of']
               end
 
               ##
-              # Fetch a FieldValueInstance
+              # Fetch the FieldValueInstance
               # @return [FieldValueInstance] Fetched FieldValueInstance
               def fetch
                 context.fetch
               end
 
               ##
-              # Deletes the FieldValueInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # Delete the FieldValueInstance
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end

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