twilio-ruby 5.10.7 → 5.11.0

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

@@ -29,7 +29,7 @@ module Twilio
       end
 
       ##
-      # @param [String] sid The sid
+      # @param [String] sid A 34 character string that uniquely identifies this Flow.
       # @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 The sid
+        # @param [String] sid A 34 character string that uniquely identifies this Flow.
         # @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

@@ -151,7 +151,7 @@ module Twilio
           ##
           # Initialize the FlowContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The sid
+          # @param [String] sid A 34 character string that uniquely identifies this Flow.
           # @return [FlowContext] FlowContext
           def initialize(version, sid)
             super(version)
@@ -238,7 +238,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 The sid
+          # @param [String] sid A 34 character string that uniquely identifies this Flow.
           # @return [FlowInstance] FlowInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -273,55 +273,55 @@ module Twilio
           end
 
           ##
-          # @return [String] The sid
+          # @return [String] A string that uniquely identifies this Flow.
           def sid
             @properties['sid']
           end
 
           ##
-          # @return [String] The account_sid
+          # @return [String] Account Sid.
           def account_sid
             @properties['account_sid']
           end
 
           ##
-          # @return [String] The friendly_name
+          # @return [String] A human readable description of this resource.
           def friendly_name
             @properties['friendly_name']
           end
 
           ##
-          # @return [flow.Status] The status
+          # @return [flow.Status] The Status of this Flow
           def status
             @properties['status']
           end
 
           ##
-          # @return [String] The version
+          # @return [String] The latest version number of this Flow's definition.
           def version
             @properties['version']
           end
 
           ##
-          # @return [Time] The date_created
+          # @return [Time] The date this Flow was created
           def date_created
             @properties['date_created']
           end
 
           ##
-          # @return [Time] The date_updated
+          # @return [Time] The date this Flow was updated
           def date_updated
             @properties['date_updated']
           end
 
           ##
-          # @return [String] The url
+          # @return [String] The URL of this resource.
           def url
             @properties['url']
           end
 
           ##
-          # @return [String] The links
+          # @return [String] Nested resource URLs.
           def links
             @properties['links']
           end

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

@@ -17,7 +17,7 @@ module Twilio
             ##
             # Initialize the EngagementList
             # @param [Version] version Version that contains the resource
-            # @param [String] flow_sid The flow_sid
+            # @param [String] flow_sid The unique SID identifier of the Flow.
             # @return [EngagementList] EngagementList
             def initialize(version, flow_sid: nil)
               super(version)
@@ -112,9 +112,17 @@ module Twilio
             ##
             # Retrieve a single page of EngagementInstance records from the API.
             # Request is executed immediately.
-            # @param [String] to The to
-            # @param [String] from The from
-            # @param [Hash] parameters The parameters
+            # @param [String] to The Contact phone number to start a Studio Flow Engagement,
+            #   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
+            #   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)
               data = Twilio::Values.of({
@@ -176,8 +184,8 @@ module Twilio
             ##
             # Initialize the EngagementContext
             # @param [Version] version Version that contains the resource
-            # @param [String] flow_sid The flow_sid
-            # @param [String] sid The sid
+            # @param [String] flow_sid The unique SID identifier of the Flow.
+            # @param [String] sid The unique SID identifier of the Engagement.
             # @return [EngagementContext] EngagementContext
             def initialize(version, flow_sid, sid)
               super(version)
@@ -254,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 flow_sid
-            # @param [String] sid The sid
+            # @param [String] flow_sid The unique SID identifier of the Flow.
+            # @param [String] sid The unique SID identifier of the Engagement.
             # @return [EngagementInstance] EngagementInstance
             def initialize(version, payload, flow_sid: nil, sid: nil)
               super(version)
@@ -292,67 +300,67 @@ module Twilio
             end
 
             ##
-            # @return [String] The sid
+            # @return [String] A string that uniquely identifies this Engagement.
             def sid
               @properties['sid']
             end
 
             ##
-            # @return [String] The account_sid
+            # @return [String] Account Sid.
             def account_sid
               @properties['account_sid']
             end
 
             ##
-            # @return [String] The flow_sid
+            # @return [String] Flow Sid.
             def flow_sid
               @properties['flow_sid']
             end
 
             ##
-            # @return [String] The contact_sid
+            # @return [String] Contact Sid.
             def contact_sid
               @properties['contact_sid']
             end
 
             ##
-            # @return [String] The contact_channel_address
+            # @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] The context
+            # @return [Hash] Flow state.
             def context
               @properties['context']
             end
 
             ##
-            # @return [engagement.Status] The status
+            # @return [engagement.Status] The Status of this Engagement
             def status
               @properties['status']
             end
 
             ##
-            # @return [Time] The date_created
+            # @return [Time] The date this Engagement was created
             def date_created
               @properties['date_created']
             end
 
             ##
-            # @return [Time] The date_updated
+            # @return [Time] The date this Engagement was updated
             def date_updated
               @properties['date_updated']
             end
 
             ##
-            # @return [String] The url
+            # @return [String] The URL of this resource.
             def url
               @properties['url']
             end
 
             ##
-            # @return [String] The links
+            # @return [String] Nested resource URLs.
             def links
               @properties['links']
             end

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

@@ -18,8 +18,8 @@ module Twilio
               ##
               # Initialize the EngagementContextList
               # @param [Version] version Version that contains the resource
-              # @param [String] flow_sid The flow_sid
-              # @param [String] engagement_sid The engagement_sid
+              # @param [String] flow_sid The unique SID identifier of the Flow.
+              # @param [String] engagement_sid The unique SID identifier of the Engagement.
               # @return [EngagementContextList] EngagementContextList
               def initialize(version, flow_sid: nil, engagement_sid: nil)
                 super(version)
@@ -77,8 +77,8 @@ module Twilio
               ##
               # Initialize the EngagementContextContext
               # @param [Version] version Version that contains the resource
-              # @param [String] flow_sid The flow_sid
-              # @param [String] engagement_sid The engagement_sid
+              # @param [String] flow_sid The unique SID identifier of the Flow.
+              # @param [String] engagement_sid The unique SID identifier of the Engagement.
               # @return [EngagementContextContext] EngagementContextContext
               def initialize(version, flow_sid, engagement_sid)
                 super(version)
@@ -123,8 +123,8 @@ module Twilio
               # Initialize the EngagementContextInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] flow_sid The flow_sid
-              # @param [String] engagement_sid The engagement_sid
+              # @param [String] flow_sid The unique SID identifier of the Flow.
+              # @param [String] engagement_sid The unique SID identifier of the Engagement.
               # @return [EngagementContextInstance] EngagementContextInstance
               def initialize(version, payload, flow_sid: nil, engagement_sid: nil)
                 super(version)
@@ -159,31 +159,31 @@ module Twilio
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] Account Sid.
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [Hash] The context
+              # @return [Hash] Flow state.
               def context
                 @properties['context']
               end
 
               ##
-              # @return [String] The engagement_sid
+              # @return [String] Engagement Sid.
               def engagement_sid
                 @properties['engagement_sid']
               end
 
               ##
-              # @return [String] The flow_sid
+              # @return [String] Flow Sid.
               def flow_sid
                 @properties['flow_sid']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The URL of this resource.
               def url
                 @properties['url']
               end

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

@@ -18,8 +18,8 @@ module Twilio
               ##
               # Initialize the StepList
               # @param [Version] version Version that contains the resource
-              # @param [String] flow_sid The flow_sid
-              # @param [String] engagement_sid The engagement_sid
+              # @param [String] flow_sid The unique SID identifier of the Flow.
+              # @param [String] engagement_sid The unique SID identifier of the Engagement.
               # @return [StepList] StepList
               def initialize(version, flow_sid: nil, engagement_sid: nil)
                 super(version)
@@ -160,9 +160,9 @@ module Twilio
               ##
               # Initialize the StepContext
               # @param [Version] version Version that contains the resource
-              # @param [String] flow_sid The flow_sid
-              # @param [String] engagement_sid The engagement_sid
-              # @param [String] sid The sid
+              # @param [String] flow_sid The unique SID identifier of the Flow.
+              # @param [String] engagement_sid The unique SID identifier of the Engagement.
+              # @param [String] sid The unique SID identifier of the Step.
               # @return [StepContext] StepContext
               def initialize(version, flow_sid, engagement_sid, sid)
                 super(version)
@@ -219,9 +219,9 @@ module Twilio
               # Initialize the StepInstance
               # @param [Version] version Version that contains the resource
               # @param [Hash] payload payload that contains response from Twilio
-              # @param [String] flow_sid The flow_sid
-              # @param [String] engagement_sid The engagement_sid
-              # @param [String] sid The sid
+              # @param [String] flow_sid The unique SID identifier of the Flow.
+              # @param [String] engagement_sid The unique SID identifier of the Engagement.
+              # @param [String] sid The unique SID identifier of the Step.
               # @return [StepInstance] StepInstance
               def initialize(version, payload, flow_sid: nil, engagement_sid: nil, sid: nil)
                 super(version)
@@ -268,31 +268,31 @@ module Twilio
               end
 
               ##
-              # @return [String] The sid
+              # @return [String] A string that uniquely identifies this Step.
               def sid
                 @properties['sid']
               end
 
               ##
-              # @return [String] The account_sid
+              # @return [String] Account Sid.
               def account_sid
                 @properties['account_sid']
               end
 
               ##
-              # @return [String] The flow_sid
+              # @return [String] Flow Sid.
               def flow_sid
                 @properties['flow_sid']
               end
 
               ##
-              # @return [String] The engagement_sid
+              # @return [String] Engagement Sid.
               def engagement_sid
                 @properties['engagement_sid']
               end
 
               ##
-              # @return [String] The name
+              # @return [String] The event that caused the flow to transition to this Step.
               def name
                 @properties['name']
               end
@@ -304,31 +304,31 @@ module Twilio
               end
 
               ##
-              # @return [String] The transitioned_from
+              # @return [String] The Widget that preceded the Widget for this Step.
               def transitioned_from
                 @properties['transitioned_from']
               end
 
               ##
-              # @return [String] The transitioned_to
+              # @return [String] The Widget that will follow the Widget for this Step.
               def transitioned_to
                 @properties['transitioned_to']
               end
 
               ##
-              # @return [Time] The date_created
+              # @return [Time] The date this Step was created
               def date_created
                 @properties['date_created']
               end
 
               ##
-              # @return [Time] The date_updated
+              # @return [Time] The date this Step was updated
               def date_updated
                 @properties['date_updated']
               end
 
               ##
-              # @return [String] The url
+              # @return [String] The URL of this resource.
               def url
                 @properties['url']
               end

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

@@ -19,9 +19,10 @@ module Twilio
                 ##
                 # Initialize the StepContextList
                 # @param [Version] version Version that contains the resource
-                # @param [String] flow_sid The flow_sid
-                # @param [String] engagement_sid The engagement_sid
-                # @param [String] step_sid The step_sid
+                # @param [String] flow_sid The unique SID identifier of the Flow.
+                # @param [String] engagement_sid The unique SID identifier of the Engagement.
+                # @param [String] step_sid The unique SID identifier of the Step this context is
+                #   associated with.
                 # @return [StepContextList] StepContextList
                 def initialize(version, flow_sid: nil, engagement_sid: nil, step_sid: nil)
                   super(version)
@@ -80,9 +81,9 @@ module Twilio
                 ##
                 # Initialize the StepContextContext
                 # @param [Version] version Version that contains the resource
-                # @param [String] flow_sid The flow_sid
-                # @param [String] engagement_sid The engagement_sid
-                # @param [String] step_sid The step_sid
+                # @param [String] flow_sid The unique SID identifier of the Flow.
+                # @param [String] engagement_sid The unique SID identifier of the Engagement.
+                # @param [String] step_sid The unique SID identifier of the Step.
                 # @return [StepContextContext] StepContextContext
                 def initialize(version, flow_sid, engagement_sid, step_sid)
                   super(version)
@@ -128,9 +129,10 @@ module Twilio
                 # Initialize the StepContextInstance
                 # @param [Version] version Version that contains the resource
                 # @param [Hash] payload payload that contains response from Twilio
-                # @param [String] flow_sid The flow_sid
-                # @param [String] engagement_sid The engagement_sid
-                # @param [String] step_sid The step_sid
+                # @param [String] flow_sid The unique SID identifier of the Flow.
+                # @param [String] engagement_sid The unique SID identifier of the Engagement.
+                # @param [String] step_sid The unique SID identifier of the Step this context is
+                #   associated with.
                 # @return [StepContextInstance] StepContextInstance
                 def initialize(version, payload, flow_sid: nil, engagement_sid: nil, step_sid: nil)
                   super(version)
@@ -167,37 +169,37 @@ module Twilio
                 end
 
                 ##
-                # @return [String] The account_sid
+                # @return [String] Account Sid.
                 def account_sid
                   @properties['account_sid']
                 end
 
                 ##
-                # @return [Hash] The context
+                # @return [Hash] Flow state.
                 def context
                   @properties['context']
                 end
 
                 ##
-                # @return [String] The engagement_sid
+                # @return [String] Engagement Sid.
                 def engagement_sid
                   @properties['engagement_sid']
                 end
 
                 ##
-                # @return [String] The flow_sid
+                # @return [String] Flow Sid.
                 def flow_sid
                   @properties['flow_sid']
                 end
 
                 ##
-                # @return [String] The step_sid
+                # @return [String] Step Sid.
                 def step_sid
                   @properties['step_sid']
                 end
 
                 ##
-                # @return [String] The url
+                # @return [String] The URL of this resource.
                 def url
                   @properties['url']
                 end