lib/twilio-ruby/rest/autopilot/v1/assistant/defaults.rb in twilio-ruby-5.22.1 vs lib/twilio-ruby/rest/autopilot/v1/assistant/defaults.rb in twilio-ruby-5.22.2

- old
+ new

@@ -15,11 +15,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 DefaultsList < ListResource ## # 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) # Path Solution @@ -68,11 +70,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 DefaultsContext < InstanceContext ## # 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) # Path Solution @@ -95,11 +99,12 @@ 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( @@ -131,11 +136,13 @@ class DefaultsInstance < InstanceResource ## # 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) # Marshaled Properties @@ -161,29 +168,29 @@ end @instance_context 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 ## @@ -193,10 +200,11 @@ context.fetch 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) context.update(defaults: defaults, ) end \ No newline at end of file