twilio-ruby 5.20.0 → 5.47.0

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -20,6 +20,7 @@ module Twilio
 
         # Versions
         @v1 = nil
+        @v2 = nil
       end
 
       ##
@@ -29,11 +30,24 @@ module Twilio
       end
 
       ##
-      # @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]
+      # Version v2 of studio
+      def v2
+        @v2 ||= V2.new self
+      end
+
+      ##
+      # @param [String] sid The unique string that we created to identify the Flow
+      #   resource.
+      # @return [Twilio::REST::Studio::V2::FlowInstance] if sid was passed.
+      # @return [Twilio::REST::Studio::V2::FlowList]
       def flows(sid=:unset)
-        self.v1.flows(sid)
+        self.v2.flows(sid)
+      end
+
+      ##
+      # @return [Twilio::REST::Studio::V2::FlowValidateInstance]
+      def flow_validate
+        self.v2.flow_validate()
       end
 
       ##

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -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
 
@@ -145,7 +143,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)
@@ -160,25 +158,19 @@ module Twilio
           end
 
           ##
-          # Fetch a FlowInstance
+          # Fetch the FlowInstance
           # @return [FlowInstance] Fetched FlowInstance
           def fetch
-            params = Twilio::Values.of({})
-
-            payload = @version.fetch(
-                'GET',
-                @uri,
-                params,
-            )
+            payload = @version.fetch('GET', @uri)
 
             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
 
           ##
@@ -223,6 +215,13 @@ module Twilio
             context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
             "#<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
 
         class FlowInstance < InstanceResource
@@ -230,7 +229,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)
@@ -265,69 +264,69 @@ 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
 
           ##
-          # 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

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

@@ -3,7 +3,7 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
-# 
+#
 # frozen_string_literal: true
 
 module Twilio
@@ -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)
@@ -86,11 +86,9 @@ module Twilio
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
+
+              response = @version.page('GET', @uri, params: params)
+
               EngagementPage.new(@version, response, @solution)
             end
 
@@ -108,20 +106,20 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of EngagementInstance records from the API.
-            # Request is executed immediately.
+            # Create the EngagementInstance
             # @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
+            # @return [EngagementInstance] Created EngagementInstance
             def create(to: nil, from: nil, parameters: :unset)
               data = Twilio::Values.of({
                   'To' => to,
@@ -129,11 +127,7 @@ module Twilio
                   'Parameters' => Twilio.serialize_object(parameters),
               })
 
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
+              payload = @version.create('POST', @uri, data: data)
 
               EngagementInstance.new(@version, payload, flow_sid: @solution[:flow_sid], )
             end
@@ -178,8 +172,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)
@@ -194,25 +188,19 @@ module Twilio
             end
 
             ##
-            # Fetch a EngagementInstance
+            # Fetch the EngagementInstance
             # @return [EngagementInstance] Fetched EngagementInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
               EngagementInstance.new(@version, payload, flow_sid: @solution[:flow_sid], sid: @solution[:sid], )
             end
 
             ##
-            # Deletes the EngagementInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the EngagementInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
-              @version.delete('delete', @uri)
+               @version.delete('DELETE', @uri)
             end
 
             ##
@@ -247,6 +235,13 @@ module Twilio
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
               "#<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
 
           class EngagementInstance < InstanceResource
@@ -254,8 +249,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)
@@ -292,81 +287,81 @@ 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
 
             ##
-            # Fetch a EngagementInstance
+            # Fetch the EngagementInstance
             # @return [EngagementInstance] Fetched EngagementInstance
             def fetch
               context.fetch
             end
 
             ##
-            # Deletes the EngagementInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
+            # Delete the EngagementInstance
+            # @return [Boolean] true if delete succeeds, false otherwise
             def delete
               context.delete
             end