lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb in twilio-ruby-5.15.1 vs lib/twilio-ruby/rest/autopilot/v1/assistant/task.rb in twilio-ruby-5.15.2

- old
+ new

@@ -114,12 +114,14 @@ # 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 The actions - # @param [String] actions_url The actions_url + # @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 def create(unique_name: nil, friendly_name: :unset, actions: :unset, actions_url: :unset) data = Twilio::Values.of({ 'UniqueName' => unique_name, 'FriendlyName' => friendly_name, @@ -178,12 +180,13 @@ # 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 TaskContext < InstanceContext ## # Initialize the TaskContext # @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 unique ID of the Assistant. + # @param [String] sid A 34-character string that uniquely identifies this + # resource. # @return [TaskContext] TaskContext def initialize(version, assistant_sid, sid) super(version) # Path Solution @@ -215,13 +218,16 @@ ## # 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. Unique up to 64 characters long. - # @param [Hash] actions The actions - # @param [String] actions_url The actions_url + # 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. # @return [TaskInstance] Updated TaskInstance def update(friendly_name: :unset, unique_name: :unset, actions: :unset, actions_url: :unset) data = Twilio::Values.of({ 'FriendlyName' => friendly_name, 'UniqueName' => unique_name, @@ -319,11 +325,12 @@ ## # 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 The sid + # @param [String] sid A 34-character string that uniquely identifies this + # resource. # @return [TaskInstance] TaskInstance def initialize(version, payload, assistant_sid: nil, sid: nil) super(version) # Marshaled Properties @@ -391,11 +398,11 @@ 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 ## @@ -403,11 +410,11 @@ def unique_name @properties['unique_name'] end ## - # @return [String] User-provided HTTP endpoint where the assistant can fetch actions. + # @return [String] A user-provided HTTP endpoint where the assistant can fetch actions. def actions_url @properties['actions_url'] end ## @@ -426,12 +433,15 @@ ## # 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. Unique up to 64 characters long. - # @param [Hash] actions The actions - # @param [String] actions_url The actions_url + # 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. # @return [TaskInstance] Updated TaskInstance def update(friendly_name: :unset, unique_name: :unset, actions: :unset, actions_url: :unset) context.update( friendly_name: friendly_name, unique_name: unique_name, \ No newline at end of file