twilio-ruby 5.25.4 → 5.26.0

data/lib/twilio-ruby/rest/proxy/v1/service/session.rb

@@ -229,7 +229,7 @@ module Twilio
 
             ##
             # Deletes the SessionInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -476,7 +476,7 @@ module Twilio
 
             ##
             # Deletes the SessionInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end

data/lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb

@@ -202,7 +202,7 @@ module Twilio
 
               ##
               # Deletes the InteractionInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 @version.delete('delete', @uri)
               end
@@ -410,7 +410,7 @@ module Twilio
 
               ##
               # Deletes the InteractionInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end

data/lib/twilio-ruby/rest/proxy/v1/service/session/participant.rb

@@ -239,7 +239,7 @@ module Twilio
 
               ##
               # Deletes the ParticipantInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 @version.delete('delete', @uri)
               end
@@ -434,7 +434,7 @@ module Twilio
 
               ##
               # Deletes the ParticipantInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end

data/lib/twilio-ruby/rest/proxy/v1/service/short_code.rb

@@ -189,7 +189,7 @@ module Twilio
 
             ##
             # Deletes the ShortCodeInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -350,7 +350,7 @@ module Twilio
 
             ##
             # Deletes the ShortCodeInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end

data/lib/twilio-ruby/rest/serverless/v1/service.rb

@@ -212,7 +212,7 @@ module Twilio
 
           ##
           # Deletes the ServiceInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             @version.delete('delete', @uri)
           end
@@ -431,7 +431,7 @@ module Twilio
 
           ##
           # Deletes the ServiceInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
           end

data/lib/twilio-ruby/rest/serverless/v1/service/asset.rb

@@ -204,7 +204,7 @@ module Twilio
 
             ##
             # Deletes the AssetInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -362,7 +362,7 @@ module Twilio
 
             ##
             # Deletes the AssetInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end

data/lib/twilio-ruby/rest/serverless/v1/service/build.rb

@@ -209,7 +209,7 @@ module Twilio
 
             ##
             # Deletes the BuildInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -342,7 +342,7 @@ module Twilio
 
             ##
             # Deletes the BuildInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end

data/lib/twilio-ruby/rest/serverless/v1/service/environment.rb

@@ -214,7 +214,7 @@ module Twilio
 
             ##
             # Deletes the EnvironmentInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -420,7 +420,7 @@ module Twilio
 
             ##
             # Deletes the EnvironmentInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end

data/lib/twilio-ruby/rest/serverless/v1/service/environment/variable.rb

@@ -249,7 +249,7 @@ module Twilio
 
               ##
               # Deletes the VariableInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 @version.delete('delete', @uri)
               end
@@ -397,7 +397,7 @@ module Twilio
 
               ##
               # Deletes the VariableInstance
-              # @return [Boolean] true if delete succeeds, true otherwise
+              # @return [Boolean] true if delete succeeds, false otherwise
               def delete
                 context.delete
               end

data/lib/twilio-ruby/rest/serverless/v1/service/function.rb

@@ -204,7 +204,7 @@ module Twilio
 
             ##
             # Deletes the FunctionInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               @version.delete('delete', @uri)
             end
@@ -362,7 +362,7 @@ module Twilio
 
             ##
             # Deletes the FunctionInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end

data/lib/twilio-ruby/rest/studio.rb

@@ -29,7 +29,8 @@ module Twilio
       end
 
       ##
-      # @param [String] sid A 34 character string that uniquely identifies this Flow.
+      # @param [String] sid The unique string that we created to identify the Flow
+      #   resource.
       # @return [Twilio::REST::Studio::V1::FlowInstance] if sid was passed.
       # @return [Twilio::REST::Studio::V1::FlowList]
       def flows(sid=:unset)

data/lib/twilio-ruby/rest/studio/v1.rb

@@ -19,7 +19,7 @@ module Twilio
         end
 
         ##
-        # @param [String] sid A 34 character string that uniquely identifies this Flow.
+        # @param [String] sid The SID of the Flow resource to fetch.
         # @return [Twilio::REST::Studio::V1::FlowContext] if sid was passed.
         # @return [Twilio::REST::Studio::V1::FlowList]
         def flows(sid=:unset)

data/lib/twilio-ruby/rest/studio/v1/flow.rb

@@ -145,7 +145,7 @@ module Twilio
           ##
           # Initialize the FlowContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid A 34 character string that uniquely identifies this Flow.
+          # @param [String] sid The SID of the Flow resource to fetch.
           # @return [FlowContext] FlowContext
           def initialize(version, sid)
             super(version)
@@ -176,7 +176,7 @@ module Twilio
 
           ##
           # Deletes the FlowInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             @version.delete('delete', @uri)
           end
@@ -237,7 +237,7 @@ module Twilio
           # Initialize the FlowInstance
           # @param [Version] version Version that contains the resource
           # @param [Hash] payload payload that contains response from Twilio
-          # @param [String] sid A 34 character string that uniquely identifies this Flow.
+          # @param [String] sid The SID of the Flow resource to fetch.
           # @return [FlowInstance] FlowInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -272,55 +272,55 @@ module Twilio
           end
 
           ##
-          # @return [String] A string that uniquely identifies this Flow.
+          # @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] A human readable description of this resource.
+          # @return [String] The string that you assigned to describe the Flow
           def friendly_name
             @properties['friendly_name']
           end
 
           ##
-          # @return [flow.Status] The Status of this Flow
+          # @return [flow.Status] The status of the Flow
           def status
             @properties['status']
           end
 
           ##
-          # @return [String] The latest version number of this Flow's definition.
+          # @return [String] The latest version number of the Flow's definition
           def version
             @properties['version']
           end
 
           ##
-          # @return [Time] The date this Flow was created
+          # @return [Time] The ISO 8601 date and time in GMT when the resource was created
           def date_created
             @properties['date_created']
           end
 
           ##
-          # @return [Time] The date this Flow was updated
+          # @return [Time] The ISO 8601 date and time in GMT when the resource 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] Nested resource URLs
           def links
             @properties['links']
           end
@@ -334,7 +334,7 @@ module Twilio
 
           ##
           # Deletes the FlowInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
           end

data/lib/twilio-ruby/rest/studio/v1/flow/engagement.rb

@@ -15,7 +15,7 @@ module Twilio
             ##
             # 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)
@@ -111,13 +111,14 @@ module Twilio
             # 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.
@@ -178,8 +179,8 @@ module Twilio
             ##
             # 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)
@@ -210,7 +211,7 @@ module Twilio
 
             ##
             # 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
@@ -261,8 +262,8 @@ module Twilio
             # 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)
@@ -299,67 +300,67 @@ module Twilio
             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
@@ -373,7 +374,7 @@ module Twilio
 
             ##
             # Deletes the EngagementInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end