lib/twilio-ruby/rest/autopilot/v1/assistant/task/field.rb in twilio-ruby-5.15.1 vs lib/twilio-ruby/rest/autopilot/v1/assistant/task/field.rb in twilio-ruby-5.15.2
- old
+ new
@@ -16,11 +16,11 @@
# PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
class FieldList < ListResource
##
# Initialize the FieldList
# @param [Version] version Version that contains the resource
- # @param [String] assistant_sid The unique ID of the parent Assistant.
+ # @param [String] assistant_sid The unique ID of the Assistant.
# @param [String] task_sid The unique ID of the Task associated with this Field.
# @return [FieldList] FieldList
def initialize(version, assistant_sid: nil, task_sid: nil)
super(version)
@@ -112,14 +112,14 @@
end
##
# Retrieve a single page of FieldInstance records from the API.
# Request is executed immediately.
- # @param [String] field_type The unique name or sid of the FieldType. It can be
- # any [Built-in Field
+ # @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 the Field Type sid of a custom Field Type.
+ # 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
def create(field_type: nil, unique_name: nil)
data = Twilio::Values.of({'FieldType' => field_type, 'UniqueName' => unique_name, })
@@ -185,13 +185,14 @@
# PLEASE NOTE that this class contains preview products that are subject to change. Use them with caution. If you currently do not have developer preview access, please contact help@twilio.com.
class FieldContext < InstanceContext
##
# Initialize the FieldContext
# @param [Version] version Version that contains the resource
- # @param [String] assistant_sid The assistant_sid
- # @param [String] task_sid The task_sid
- # @param [String] sid The sid
+ # @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.
# @return [FieldContext] FieldContext
def initialize(version, assistant_sid, task_sid, sid)
super(version)
# Path Solution
@@ -240,13 +241,14 @@
class FieldInstance < InstanceResource
##
# 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 parent Assistant.
+ # @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 The sid
+ # @param [String] sid A 34-character string that uniquely identifies this
+ # resource.
# @return [FieldInstance] FieldInstance
def initialize(version, payload, assistant_sid: nil, task_sid: nil, sid: nil)
super(version)
# Marshaled Properties
@@ -304,11 +306,11 @@
def date_updated
@properties['date_updated']
end
##
- # @return [String] The Field Type of this field. It can be any Built-in Field Type or unique_name or the Field Type sid of a custom Field Type.
+ # @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.
def field_type
@properties['field_type']
end
##
@@ -316,16 +318,16 @@
def task_sid
@properties['task_sid']
end
##
- # @return [String] The unique ID of the parent Assistant.
+ # @return [String] The unique ID of the Assistant.
def assistant_sid
@properties['assistant_sid']
end
##
- # @return [String] A 34 character string that uniquely identifies this resource.
+ # @return [String] A 34-character string that uniquely identifies this resource.
def sid
@properties['sid']
end
##
\ No newline at end of file