engagement.rb in twilio-ruby-5.26.0

- old
+ new

@@ -13,11 +13,11 @@
         class FlowContext < InstanceContext
           class EngagementList < ListResource
             ##
             # Initialize the EngagementList
             # @param [Version] version Version that contains the resource
-            # @param [String] flow_sid The unique SID identifier of the Flow.
+            # @param [String] flow_sid The SID of the Flow.
             # @return [EngagementList] EngagementList
             def initialize(version, flow_sid: nil)
               super(version)
 
               # Path Solution
@@ -109,17 +109,18 @@
 
             ##
             # Retrieve a single page of EngagementInstance records from the API.
             # Request is executed immediately.
             # @param [String] to The Contact phone number to start a Studio Flow Engagement,
-            #   available as variable {{contact.channel.address}}.
+            #   available as variable `{{contact.channel.address}}`.
             # @param [String] from The Twilio phone number to send messages or initiate calls
-            #   from during the Flow Engagement, available as variable {{flow.channel.address}}
-            # @param [Hash] parameters JSON data that will be added to your flow's context and
-            #   can accessed as variables inside your flow. For example, if you pass in
-            #   Parameters={'name':'Zeke'} then inside a widget you can reference the variable
-            #   {{flow.data.name}} which will return the string 'Zeke'. Note: the JSON value
+            #   from during the Flow Engagement. Available as variable
+            #   `{{flow.channel.address}}`
+            # @param [Hash] parameters A JSON string we will add to your flow's context and
+            #   that you can access as variables inside your flow. For example, if you pass in
+            #   `Parameters={'name':'Zeke'}` then inside a widget you can reference the variable
+            #   `{{flow.data.name}}` which will return the string 'Zeke'. Note: the JSON value
             #   must explicitly be passed as a string, not as a hash object. Depending on your
             #   particular HTTP library, you may need to add quotes or URL encode your JSON
             #   string.
             # @return [EngagementInstance] Newly created EngagementInstance
             def create(to: nil, from: nil, parameters: :unset)
@@ -176,12 +177,12 @@
 
           class EngagementContext < InstanceContext
             ##
             # Initialize the EngagementContext
             # @param [Version] version Version that contains the resource
-            # @param [String] flow_sid The unique SID identifier of the Flow.
-            # @param [String] sid The unique SID identifier of the Engagement.
+            # @param [String] flow_sid The SID of the Flow.
+            # @param [String] sid The SID of the Engagement resource to fetch.
             # @return [EngagementContext] EngagementContext
             def initialize(version, flow_sid, sid)
               super(version)
 
               # Path Solution
@@ -208,11 +209,11 @@
               EngagementInstance.new(@version, payload, flow_sid: @solution[:flow_sid], sid: @solution[:sid], )
             end
 
             ##
             # Deletes the EngagementInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
 
             ##
@@ -259,12 +260,12 @@
           class EngagementInstance < InstanceResource
             ##
             # Initialize the EngagementInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] flow_sid The unique SID identifier of the Flow.
-            # @param [String] sid The unique SID identifier of the Engagement.
+            # @param [String] flow_sid The SID of the Flow.
+            # @param [String] sid The SID of the Engagement resource to fetch.
             # @return [EngagementInstance] EngagementInstance
             def initialize(version, payload, flow_sid: nil, sid: nil)
               super(version)
 
               # Marshaled Properties
@@ -297,71 +298,71 @@
               end
               @instance_context
             end
 
             ##
-            # @return [String] A string that uniquely identifies this Engagement.
+            # @return [String] The unique string that identifies the resource
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] Account Sid.
+            # @return [String] The SID of the Account that created the resource
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] Flow Sid.
+            # @return [String] The SID of the Flow
             def flow_sid
               @properties['flow_sid']
             end
 
             ##
-            # @return [String] Contact Sid.
+            # @return [String] The SID of the Contact
             def contact_sid
               @properties['contact_sid']
             end
 
             ##
-            # @return [String] The phone number, SIP address or Client identifier that triggered this Engagement.
+            # @return [String] The phone number, SIP address or Client identifier that triggered this Engagement
             def contact_channel_address
               @properties['contact_channel_address']
             end
 
             ##
-            # @return [Hash] Flow state.
+            # @return [Hash] The current state of the execution flow
             def context
               @properties['context']
             end
 
             ##
-            # @return [engagement.Status] The Status of this Engagement
+            # @return [engagement.Status] The status of the Engagement
             def status
               @properties['status']
             end
 
             ##
-            # @return [Time] The date this Engagement was created
+            # @return [Time] The ISO 8601 date and time in GMT when the Engagement was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date this Engagement was updated
+            # @return [Time] The ISO 8601 date and time in GMT when the Engagement was last updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The URL of this resource.
+            # @return [String] The absolute URL of the resource
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] Nested resource URLs.
+            # @return [String] The URLs of the Engagement's nested resources
             def links
               @properties['links']
             end
 
             ##
@@ -371,10 +372,10 @@
               context.fetch
             end
 
             ##
             # Deletes the EngagementInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end
 
             ##
\ No newline at end of file