twilio-ruby 5.6.0 → 5.33.0

data/lib/twilio-ruby/rest/{preview/studio → studio/v1}/flow/engagement/step.rb

@@ -3,21 +3,21 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
-    class Preview < Domain
-      class Studio < Version
+    class Studio < Domain
+      class V1 < Version
         class FlowContext < InstanceContext
           class EngagementContext < InstanceContext
-            ##
-            # 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 StepList < ListResource
               ##
               # Initialize the StepList
               # @param [Version] version Version that contains the resource
-              # @param [String] flow_sid The unique SID identifier of the Flow.
-              # @param [String] engagement_sid The unique SID identifier of the Engagement.
+              # @param [String] flow_sid The SID of the Flow.
+              # @param [String] engagement_sid The SID of the Engagement.
               # @return [StepList] StepList
               def initialize(version, flow_sid: nil, engagement_sid: nil)
                 super(version)
@@ -56,7 +56,7 @@ module Twilio
               def stream(limit: nil, page_size: nil)
                 limits = @version.read_limits(limit, page_size)
 
-                page = self.page(page_size: limits[:page_size])
+                page = self.page(page_size: limits[:page_size], )
 
                 @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
               end
@@ -68,7 +68,7 @@ module Twilio
               def each
                 limits = @version.read_limits
 
-                page = self.page(page_size: limits[:page_size])
+                page = self.page(page_size: limits[:page_size], )
 
                 @version.stream(page,
                                 limit: limits[:limit],
@@ -112,12 +112,10 @@ module Twilio
               ##
               # Provide a user friendly representation
               def to_s
-                '#<Twilio.Preview.Studio.StepList>'
+                '#<Twilio.Studio.V1.StepList>'
               end
             end
 
-            ##
-            # 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 StepPage < Page
               ##
               # Initialize the StepPage
@@ -148,26 +146,27 @@ module Twilio
               ##
               # Provide a user friendly representation
               def to_s
-                '<Twilio.Preview.Studio.StepPage>'
+                '<Twilio.Studio.V1.StepPage>'
               end
             end
 
-            ##
-            # 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 StepContext < InstanceContext
               ##
               # 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 SID of the Flow with the Step to fetch.
+              # @param [String] engagement_sid The SID of the Engagement with the Step to fetch.
+              # @param [String] sid The SID of the Step resource to fetch.
               # @return [StepContext] StepContext
               def initialize(version, flow_sid, engagement_sid, sid)
                 super(version)
 
                 # Path Solution
-                @solution = {flow_sid: flow_sid, engagement_sid: engagement_sid, sid: sid}
+                @solution = {flow_sid: flow_sid, engagement_sid: engagement_sid, sid: sid, }
                 @uri = "/Flows/#{@solution[:flow_sid]}/Engagements/#{@solution[:engagement_sid]}/Steps/#{@solution[:sid]}"
+
+                # Dependents
+                @step_context = nil
               end
 
               ##
@@ -191,24 +190,37 @@ module Twilio
                 )
               end
 
+              ##
+              # Access the step_context
+              # @return [StepContextList]
+              # @return [StepContextContext]
+              def step_context
+                StepContextContext.new(@version, @solution[:flow_sid], @solution[:engagement_sid], @solution[:sid], )
+              end
+
               ##
               # Provide a user friendly representation
               def to_s
                 context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-                "#<Twilio.Preview.Studio.StepContext #{context}>"
+                "#<Twilio.Studio.V1.StepContext #{context}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Studio.V1.StepContext #{context}>"
               end
             end
 
-            ##
-            # 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 StepInstance < InstanceResource
               ##
               # 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 unique SID identifier of the Flow.
-              # @param [String] engagement_sid The unique SID identifier of the Engagement.
-              # @param [String] sid The sid
+              # @param [String] flow_sid The SID of the Flow.
+              # @param [String] engagement_sid The SID of the Engagement.
+              # @param [String] sid The SID of the Step resource to fetch.
               # @return [StepInstance] StepInstance
               def initialize(version, payload, flow_sid: nil, engagement_sid: nil, sid: nil)
                 super(version)
@@ -226,6 +238,7 @@ module Twilio
                     'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                     'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                     'url' => payload['url'],
+                    'links' => payload['links'],
                 }
 
                 # Context
@@ -254,71 +267,77 @@ module Twilio
               end
 
               ##
-              # @return [String] A string that uniquely identifies this Step.
+              # @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] Engagement Sid.
+              # @return [String] The SID of the Engagement
               def engagement_sid
                 @properties['engagement_sid']
               end
 
               ##
-              # @return [String] The Widget that implemented this Step.
+              # @return [String] The event that caused the Flow to transition to the Step
               def name
                 @properties['name']
               end
 
               ##
-              # @return [Hash] Nested resource URLs.
+              # @return [Hash] The current state of the flow
               def context
                 @properties['context']
               end
 
               ##
-              # @return [String] The Widget that preceded the Widget for this Step.
+              # @return [String] The Widget that preceded the Widget for the Step
               def transitioned_from
                 @properties['transitioned_from']
               end
 
               ##
-              # @return [String] The Widget that will follow the Widget for this Step.
+              # @return [String] The Widget that will follow the Widget for the Step
               def transitioned_to
                 @properties['transitioned_to']
               end
 
               ##
-              # @return [Time] The date this Step 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 Step 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] The URLs of related resources
+              def links
+                @properties['links']
+              end
+
               ##
               # Fetch a StepInstance
               # @return [StepInstance] Fetched StepInstance
@@ -326,18 +345,25 @@ module Twilio
                 context.fetch
               end
 
+              ##
+              # Access the step_context
+              # @return [step_context] step_context
+              def step_context
+                context.step_context
+              end
+
               ##
               # Provide a user friendly representation
               def to_s
                 values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-                "<Twilio.Preview.Studio.StepInstance #{values}>"
+                "<Twilio.Studio.V1.StepInstance #{values}>"
               end
 
               ##
               # Provide a detailed, user friendly representation
               def inspect
                 values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-                "<Twilio.Preview.Studio.StepInstance #{values}>"
+                "<Twilio.Studio.V1.StepInstance #{values}>"
               end
             end
           end

data/lib/twilio-ruby/rest/{preview/studio → studio/v1}/flow/engagement.rb

@@ -3,19 +3,19 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
-    class Preview < Domain
-      class Studio < Version
+    class Studio < Domain
+      class V1 < Version
         class FlowContext < InstanceContext
-          ##
-          # 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 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)
@@ -54,7 +54,7 @@ module Twilio
             def stream(limit: nil, page_size: nil)
               limits = @version.read_limits(limit, page_size)
 
-              page = self.page(page_size: limits[:page_size])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
             end
@@ -66,7 +66,7 @@ module Twilio
             def each
               limits = @version.read_limits
 
-              page = self.page(page_size: limits[:page_size])
+              page = self.page(page_size: limits[:page_size], )
 
               @version.stream(page,
                               limit: limits[:limit],
@@ -110,12 +110,25 @@ 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 [String] 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 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)
-              data = Twilio::Values.of({'To' => to, 'From' => from, 'Parameters' => parameters})
+              data = Twilio::Values.of({
+                  'To' => to,
+                  'From' => from,
+                  'Parameters' => Twilio.serialize_object(parameters),
+              })
 
               payload = @version.create(
                   'POST',
@@ -123,18 +136,16 @@ module Twilio
                   data: data
               )
 
-              EngagementInstance.new(@version, payload, flow_sid: @solution[:flow_sid])
+              EngagementInstance.new(@version, payload, flow_sid: @solution[:flow_sid], )
             end
 
             ##
             # Provide a user friendly representation
             def to_s
-              '#<Twilio.Preview.Studio.EngagementList>'
+              '#<Twilio.Studio.V1.EngagementList>'
             end
           end
 
-          ##
-          # 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 EngagementPage < Page
             ##
             # Initialize the EngagementPage
@@ -154,34 +165,33 @@ module Twilio
             # @param [Hash] payload Payload response from the API
             # @return [EngagementInstance] EngagementInstance
             def get_instance(payload)
-              EngagementInstance.new(@version, payload, flow_sid: @solution[:flow_sid])
+              EngagementInstance.new(@version, payload, flow_sid: @solution[:flow_sid], )
             end
 
             ##
             # Provide a user friendly representation
             def to_s
-              '<Twilio.Preview.Studio.EngagementPage>'
+              '<Twilio.Studio.V1.EngagementPage>'
             end
           end
 
-          ##
-          # 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 EngagementContext < InstanceContext
             ##
             # 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 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
-              @solution = {flow_sid: flow_sid, sid: sid}
+              @solution = {flow_sid: flow_sid, sid: sid, }
               @uri = "/Flows/#{@solution[:flow_sid]}/Engagements/#{@solution[:sid]}"
 
               # Dependents
               @steps = nil
+              @engagement_context = nil
             end
 
             ##
@@ -196,12 +206,12 @@ module Twilio
                   params,
               )
 
-              EngagementInstance.new(@version, payload, flow_sid: @solution[:flow_sid], sid: @solution[:sid])
+              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
@@ -214,33 +224,46 @@ module Twilio
               raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
               if sid != :unset
-                return StepContext.new(@version, @solution[:flow_sid], @solution[:sid], sid)
+                return StepContext.new(@version, @solution[:flow_sid], @solution[:sid], sid, )
               end
 
               unless @steps
-                @steps = StepList.new(@version, flow_sid: @solution[:flow_sid], engagement_sid: @solution[:sid])
+                @steps = StepList.new(@version, flow_sid: @solution[:flow_sid], engagement_sid: @solution[:sid], )
               end
 
               @steps
             end
 
+            ##
+            # Access the engagement_context
+            # @return [EngagementContextList]
+            # @return [EngagementContextContext]
+            def engagement_context
+              EngagementContextContext.new(@version, @solution[:flow_sid], @solution[:sid], )
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-              "#<Twilio.Preview.Studio.EngagementContext #{context}>"
+              "#<Twilio.Studio.V1.EngagementContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Studio.V1.EngagementContext #{context}>"
             end
           end
 
-          ##
-          # 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 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 sid
+            # @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)
@@ -252,8 +275,8 @@ module Twilio
                   'flow_sid' => payload['flow_sid'],
                   'contact_sid' => payload['contact_sid'],
                   'contact_channel_address' => payload['contact_channel_address'],
-                  'status' => payload['status'],
                   'context' => payload['context'],
+                  'status' => payload['status'],
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                   'url' => payload['url'],
@@ -262,7 +285,7 @@ module Twilio
 
               # Context
               @instance_context = nil
-              @params = {'flow_sid' => flow_sid, 'sid' => sid || @properties['sid']}
+              @params = {'flow_sid' => flow_sid, 'sid' => sid || @properties['sid'], }
             end
 
             ##
@@ -271,73 +294,73 @@ module Twilio
             # @return [EngagementContext] EngagementContext for this EngagementInstance
             def context
               unless @instance_context
-                @instance_context = EngagementContext.new(@version, @params['flow_sid'], @params['sid'])
+                @instance_context = EngagementContext.new(@version, @params['flow_sid'], @params['sid'], )
               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 [engagement.Status] The Status of this Engagement
-            def status
-              @properties['status']
+            # @return [Hash] The current state of the execution flow
+            def context
+              @properties['context']
             end
 
             ##
-            # @return [Hash] Nested resource URLs.
-            def context
-              @properties['context']
+            # @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
@@ -351,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
@@ -363,18 +386,25 @@ module Twilio
               context.steps
             end
 
+            ##
+            # Access the engagement_context
+            # @return [engagement_context] engagement_context
+            def engagement_context
+              context.engagement_context
+            end
+
             ##
             # Provide a user friendly representation
             def to_s
               values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Preview.Studio.EngagementInstance #{values}>"
+              "<Twilio.Studio.V1.EngagementInstance #{values}>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
               values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Preview.Studio.EngagementInstance #{values}>"
+              "<Twilio.Studio.V1.EngagementInstance #{values}>"
             end
           end
         end