twilio-ruby 5.22.1 → 5.22.2

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

@@ -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)
@@ -112,10 +114,11 @@ module Twilio
             ##
             # 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.
+            # @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] Newly created FieldTypeInstance
             def create(unique_name: nil, friendly_name: :unset)
               data = Twilio::Values.of({'UniqueName' => unique_name, 'FriendlyName' => friendly_name, })
@@ -173,9 +176,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)
@@ -210,10 +215,11 @@ 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, })
@@ -283,9 +289,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)
@@ -320,55 +328,55 @@ 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
@@ -382,10 +390,11 @@ 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, )

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

@@ -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,8 @@ 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`, `nl-NL`
               # @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 +53,8 @@ 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`, `nl-NL`
               # @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 +87,8 @@ 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`, `nl-NL`
               # @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
@@ -122,11 +124,10 @@ 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] 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
+              # @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`, `nl-NL`
+              # @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
               def create(language: nil, value: nil, synonym_of: :unset)
@@ -195,10 +196,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)
@@ -258,10 +262,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)
@@ -306,61 +313,61 @@ 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

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

@@ -17,7 +17,9 @@ module Twilio
             ##
             # Initialize the ModelBuildList
             # @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 [ModelBuildList] ModelBuildList
             def initialize(version, assistant_sid: nil)
               super(version)
@@ -112,10 +114,12 @@ module Twilio
             ##
             # Retrieve a single page of ModelBuildInstance records from the API.
             # Request is executed immediately.
-            # @param [String] status_callback The status_callback
-            # @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. For
-            #   example: v0.1
+            # @param [String] status_callback The URL we should call using a POST method to
+            #   send status information to your application.
+            # @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 [ModelBuildInstance] Newly created ModelBuildInstance
             def create(status_callback: :unset, unique_name: :unset)
               data = Twilio::Values.of({'StatusCallback' => status_callback, 'UniqueName' => unique_name, })
@@ -173,9 +177,11 @@ module Twilio
             ##
             # Initialize the ModelBuildContext
             # @param [Version] version Version that contains the resource
-            # @param [String] assistant_sid The unique ID of the parent 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
+            #   ModelBuild resource to fetch.
             # @return [ModelBuildContext] ModelBuildContext
             def initialize(version, assistant_sid, sid)
               super(version)
@@ -207,9 +213,10 @@ module Twilio
 
             ##
             # Update the ModelBuildInstance
-            # @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. For
-            #   example: v0.1
+            # @param [String] unique_name An application-defined string that uniquely
+            #   identifies the 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 [ModelBuildInstance] Updated ModelBuildInstance
             def update(unique_name: :unset)
               data = Twilio::Values.of({'UniqueName' => unique_name, })
@@ -257,9 +264,11 @@ module Twilio
             # Initialize the ModelBuildInstance
             # @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 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
+            #   ModelBuild resource to fetch.
             # @return [ModelBuildInstance] ModelBuildInstance
             def initialize(version, payload, assistant_sid: nil, sid: nil)
               super(version)
@@ -295,61 +304,61 @@ module Twilio
             end
 
             ##
-            # @return [String] The unique ID of the Account that created this Model Build.
+            # @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 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] A 34-character string that uniquely identifies this resource.
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [model_build.Status] A string that described the model build status. The values can be: `enqueued`, `building`, `completed`, `failed`
+            # @return [model_build.Status] The status of the model build process
             def status
               @properties['status']
             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 ModelBuild resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] The time in seconds it took to build the model.
+            # @return [String] The time in seconds it took to build the model
             def build_duration
               @properties['build_duration']
             end
 
             ##
-            # @return [String] The error_code
+            # @return [String] More information about why the model build failed, if `status` is `failed`
             def error_code
               @properties['error_code']
             end
@@ -363,9 +372,10 @@ module Twilio
 
             ##
             # Update the ModelBuildInstance
-            # @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. For
-            #   example: v0.1
+            # @param [String] unique_name An application-defined string that uniquely
+            #   identifies the 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 [ModelBuildInstance] Updated ModelBuildInstance
             def update(unique_name: :unset)
               context.update(unique_name: unique_name, )