twilio-ruby 5.5.1 → 5.58.3

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

@@ -3,13 +3,13 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
-    class Preview < Domain
-      class Studio < Version
-        ##
-        # 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 Studio < Domain
+      class V1 < Version
         class FlowList < ListResource
           ##
           # Initialize the FlowList
@@ -52,7 +52,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
@@ -64,7 +64,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],
@@ -84,11 +84,9 @@ module Twilio
                 'Page' => page_number,
                 'PageSize' => page_size,
             })
-            response = @version.page(
-                'GET',
-                @uri,
-                params
-            )
+
+            response = @version.page('GET', @uri, params: params)
+
             FlowPage.new(@version, response, @solution)
           end
 
@@ -108,12 +106,10 @@ module Twilio
           ##
           # Provide a user friendly representation
           def to_s
-            '#<Twilio.Preview.Studio.FlowList>'
+            '#<Twilio.Studio.V1.FlowList>'
           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 FlowPage < Page
           ##
           # Initialize the FlowPage
@@ -133,55 +129,48 @@ module Twilio
           # @param [Hash] payload Payload response from the API
           # @return [FlowInstance] FlowInstance
           def get_instance(payload)
-            FlowInstance.new(@version, payload)
+            FlowInstance.new(@version, payload, )
           end
 
           ##
           # Provide a user friendly representation
           def to_s
-            '<Twilio.Preview.Studio.FlowPage>'
+            '<Twilio.Studio.V1.FlowPage>'
           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 FlowContext < InstanceContext
           ##
           # Initialize the FlowContext
           # @param [Version] version Version that contains the resource
-          # @param [String] sid The sid
+          # @param [String] sid The SID of the Flow resource to fetch.
           # @return [FlowContext] FlowContext
           def initialize(version, sid)
             super(version)
 
             # Path Solution
-            @solution = {sid: sid}
+            @solution = {sid: sid, }
             @uri = "/Flows/#{@solution[:sid]}"
 
             # Dependents
             @engagements = nil
+            @executions = nil
           end
 
           ##
-          # Fetch a FlowInstance
+          # Fetch the FlowInstance
           # @return [FlowInstance] Fetched FlowInstance
           def fetch
-            params = Twilio::Values.of({})
+            payload = @version.fetch('GET', @uri)
 
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
-
-            FlowInstance.new(@version, payload, sid: @solution[:sid])
+            FlowInstance.new(@version, payload, sid: @solution[:sid], )
           end
 
           ##
-          # Deletes the FlowInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # Delete the FlowInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
-            @version.delete('delete', @uri)
+             @version.delete('DELETE', @uri)
           end
 
           ##
@@ -192,32 +181,55 @@ module Twilio
             raise ArgumentError, 'sid cannot be nil' if sid.nil?
 
             if sid != :unset
-              return EngagementContext.new(@version, @solution[:sid], sid)
+              return EngagementContext.new(@version, @solution[:sid], sid, )
             end
 
             unless @engagements
-              @engagements = EngagementList.new(@version, flow_sid: @solution[:sid])
+              @engagements = EngagementList.new(@version, flow_sid: @solution[:sid], )
             end
 
             @engagements
           end
 
+          ##
+          # Access the executions
+          # @return [ExecutionList]
+          # @return [ExecutionContext] if sid was passed.
+          def executions(sid=:unset)
+            raise ArgumentError, 'sid cannot be nil' if sid.nil?
+
+            if sid != :unset
+              return ExecutionContext.new(@version, @solution[:sid], sid, )
+            end
+
+            unless @executions
+              @executions = ExecutionList.new(@version, flow_sid: @solution[:sid], )
+            end
+
+            @executions
+          end
+
           ##
           # Provide a user friendly representation
           def to_s
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-            "#<Twilio.Preview.Studio.FlowContext #{context}>"
+            "#<Twilio.Studio.V1.FlowContext #{context}>"
+          end
+
+          ##
+          # Provide a detailed, user friendly representation
+          def inspect
+            context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+            "#<Twilio.Studio.V1.FlowContext #{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 FlowInstance < InstanceResource
           ##
           # 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 The SID of the Flow resource to fetch.
           # @return [FlowInstance] FlowInstance
           def initialize(version, payload, sid: nil)
             super(version)
@@ -228,7 +240,6 @@ module Twilio
                 'account_sid' => payload['account_sid'],
                 'friendly_name' => payload['friendly_name'],
                 'status' => payload['status'],
-                'debug' => payload['debug'],
                 'version' => payload['version'].to_i,
                 'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                 'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
@@ -238,7 +249,7 @@ module Twilio
 
             # Context
             @instance_context = nil
-            @params = {'sid' => sid || @properties['sid']}
+            @params = {'sid' => sid || @properties['sid'], }
           end
 
           ##
@@ -247,81 +258,75 @@ module Twilio
           # @return [FlowContext] FlowContext for this FlowInstance
           def context
             unless @instance_context
-              @instance_context = FlowContext.new(@version, @params['sid'])
+              @instance_context = FlowContext.new(@version, @params['sid'], )
             end
             @instance_context
           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 [Boolean] Toggle extra logging.
-          def debug
-            @properties['debug']
-          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
 
           ##
-          # Fetch a FlowInstance
+          # Fetch the FlowInstance
           # @return [FlowInstance] Fetched FlowInstance
           def fetch
             context.fetch
           end
 
           ##
-          # Deletes the FlowInstance
-          # @return [Boolean] true if delete succeeds, true otherwise
+          # Delete the FlowInstance
+          # @return [Boolean] true if delete succeeds, false otherwise
           def delete
             context.delete
           end
@@ -333,18 +338,25 @@ module Twilio
             context.engagements
           end
 
+          ##
+          # Access the executions
+          # @return [executions] executions
+          def executions
+            context.executions
+          end
+
           ##
           # Provide a user friendly representation
           def to_s
             values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Preview.Studio.FlowInstance #{values}>"
+            "<Twilio.Studio.V1.FlowInstance #{values}>"
           end
 
           ##
           # Provide a detailed, user friendly representation
           def inspect
             values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-            "<Twilio.Preview.Studio.FlowInstance #{values}>"
+            "<Twilio.Studio.V1.FlowInstance #{values}>"
           end
         end
       end

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

@@ -0,0 +1,44 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Studio
+      class V1 < Version
+        ##
+        # Initialize the V1 version of Studio
+        def initialize(domain)
+          super
+          @version = 'v1'
+          @flows = nil
+        end
+
+        ##
+        # @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)
+          if sid.nil?
+              raise ArgumentError, 'sid cannot be nil'
+          end
+          if sid == :unset
+              @flows ||= FlowList.new self
+          else
+              FlowContext.new(self, sid)
+          end
+        end
+
+        ##
+        # Provide a user friendly representation
+        def to_s
+          '<Twilio::REST::Studio::V1>'
+        end
+      end
+    end
+  end
+end

data/lib/twilio-ruby/rest/studio/v2/flow/execution/execution_context.rb

@@ -0,0 +1,211 @@
+##
+# This code was generated by
+# \ / _    _  _|   _  _
+#  | (_)\/(_)(_|\/| |(/_  v1.0.0
+#       /       /
+#
+# frozen_string_literal: true
+
+module Twilio
+  module REST
+    class Studio < Domain
+      class V2 < Version
+        class FlowContext < InstanceContext
+          class ExecutionContext < InstanceContext
+            class ExecutionContextList < ListResource
+              ##
+              # Initialize the ExecutionContextList
+              # @param [Version] version Version that contains the resource
+              # @param [String] flow_sid The SID of the Flow.
+              # @param [String] execution_sid The SID of the context's Execution resource.
+              # @return [ExecutionContextList] ExecutionContextList
+              def initialize(version, flow_sid: nil, execution_sid: nil)
+                super(version)
+
+                # Path Solution
+                @solution = {flow_sid: flow_sid, execution_sid: execution_sid}
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '#<Twilio.Studio.V2.ExecutionContextList>'
+              end
+            end
+
+            class ExecutionContextPage < Page
+              ##
+              # Initialize the ExecutionContextPage
+              # @param [Version] version Version that contains the resource
+              # @param [Response] response Response from the API
+              # @param [Hash] solution Path solution for the resource
+              # @return [ExecutionContextPage] ExecutionContextPage
+              def initialize(version, response, solution)
+                super(version, response)
+
+                # Path Solution
+                @solution = solution
+              end
+
+              ##
+              # Build an instance of ExecutionContextInstance
+              # @param [Hash] payload Payload response from the API
+              # @return [ExecutionContextInstance] ExecutionContextInstance
+              def get_instance(payload)
+                ExecutionContextInstance.new(
+                    @version,
+                    payload,
+                    flow_sid: @solution[:flow_sid],
+                    execution_sid: @solution[:execution_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                '<Twilio.Studio.V2.ExecutionContextPage>'
+              end
+            end
+
+            class ExecutionContextContext < InstanceContext
+              ##
+              # Initialize the ExecutionContextContext
+              # @param [Version] version Version that contains the resource
+              # @param [String] flow_sid The SID of the Flow with the Execution context to
+              #   fetch.
+              # @param [String] execution_sid The SID of the Execution context to fetch.
+              # @return [ExecutionContextContext] ExecutionContextContext
+              def initialize(version, flow_sid, execution_sid)
+                super(version)
+
+                # Path Solution
+                @solution = {flow_sid: flow_sid, execution_sid: execution_sid, }
+                @uri = "/Flows/#{@solution[:flow_sid]}/Executions/#{@solution[:execution_sid]}/Context"
+              end
+
+              ##
+              # Fetch the ExecutionContextInstance
+              # @return [ExecutionContextInstance] Fetched ExecutionContextInstance
+              def fetch
+                payload = @version.fetch('GET', @uri)
+
+                ExecutionContextInstance.new(
+                    @version,
+                    payload,
+                    flow_sid: @solution[:flow_sid],
+                    execution_sid: @solution[:execution_sid],
+                )
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Studio.V2.ExecutionContextContext #{context}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+                "#<Twilio.Studio.V2.ExecutionContextContext #{context}>"
+              end
+            end
+
+            class ExecutionContextInstance < InstanceResource
+              ##
+              # Initialize the ExecutionContextInstance
+              # @param [Version] version Version that contains the resource
+              # @param [Hash] payload payload that contains response from Twilio
+              # @param [String] flow_sid The SID of the Flow.
+              # @param [String] execution_sid The SID of the context's Execution resource.
+              # @return [ExecutionContextInstance] ExecutionContextInstance
+              def initialize(version, payload, flow_sid: nil, execution_sid: nil)
+                super(version)
+
+                # Marshaled Properties
+                @properties = {
+                    'account_sid' => payload['account_sid'],
+                    'context' => payload['context'],
+                    'flow_sid' => payload['flow_sid'],
+                    'execution_sid' => payload['execution_sid'],
+                    'url' => payload['url'],
+                }
+
+                # Context
+                @instance_context = nil
+                @params = {'flow_sid' => flow_sid, 'execution_sid' => execution_sid, }
+              end
+
+              ##
+              # Generate an instance context for the instance, the context is capable of
+              # performing various actions.  All instance actions are proxied to the context
+              # @return [ExecutionContextContext] ExecutionContextContext for this ExecutionContextInstance
+              def context
+                unless @instance_context
+                  @instance_context = ExecutionContextContext.new(
+                      @version,
+                      @params['flow_sid'],
+                      @params['execution_sid'],
+                  )
+                end
+                @instance_context
+              end
+
+              ##
+              # @return [String] The SID of the Account that created the resource
+              def account_sid
+                @properties['account_sid']
+              end
+
+              ##
+              # @return [Hash] The current state of the flow
+              def context
+                @properties['context']
+              end
+
+              ##
+              # @return [String] The SID of the Flow
+              def flow_sid
+                @properties['flow_sid']
+              end
+
+              ##
+              # @return [String] The SID of the Execution
+              def execution_sid
+                @properties['execution_sid']
+              end
+
+              ##
+              # @return [String] The absolute URL of the resource
+              def url
+                @properties['url']
+              end
+
+              ##
+              # Fetch the ExecutionContextInstance
+              # @return [ExecutionContextInstance] Fetched ExecutionContextInstance
+              def fetch
+                context.fetch
+              end
+
+              ##
+              # Provide a user friendly representation
+              def to_s
+                values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Studio.V2.ExecutionContextInstance #{values}>"
+              end
+
+              ##
+              # Provide a detailed, user friendly representation
+              def inspect
+                values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+                "<Twilio.Studio.V2.ExecutionContextInstance #{values}>"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end