twilio-ruby 5.5.1 → 5.58.3

data/lib/twilio-ruby/rest/{preview/proxy/service/short_code.rb → studio/v2/flow/flow_revision.rb}

@@ -3,47 +3,31 @@
 # \ / _    _  _|   _  _
 #  | (_)\/(_)(_|\/| |(/_  v1.0.0
 #       /       /
+#
+# frozen_string_literal: true
 
 module Twilio
   module REST
-    class Preview < Domain
-      class Proxy < Version
-        class ServiceContext < 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 ShortCodeList < ListResource
+    class Studio < Domain
+      class V2 < Version
+        class FlowContext < InstanceContext
+          class FlowRevisionList < ListResource
             ##
-            # Initialize the ShortCodeList
+            # Initialize the FlowRevisionList
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The unique SID identifier of the Service.
-            # @return [ShortCodeList] ShortCodeList
-            def initialize(version, service_sid: nil)
+            # @param [String] sid The unique string that we created to identify the Flow
+            #   resource.
+            # @return [FlowRevisionList] FlowRevisionList
+            def initialize(version, sid: nil)
               super(version)
 
               # Path Solution
-              @solution = {service_sid: service_sid}
-              @uri = "/Services/#{@solution[:service_sid]}/ShortCodes"
+              @solution = {sid: sid}
+              @uri = "/Flows/#{@solution[:sid]}/Revisions"
             end
 
             ##
-            # Retrieve a single page of ShortCodeInstance records from the API.
-            # Request is executed immediately.
-            # @param [String] sid The shortcode Sid that uniquely identifies this resource
-            # @return [ShortCodeInstance] Newly created ShortCodeInstance
-            def create(sid: nil)
-              data = Twilio::Values.of({'Sid' => sid})
-
-              payload = @version.create(
-                  'POST',
-                  @uri,
-                  data: data
-              )
-
-              ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid])
-            end
-
-            ##
-            # Lists ShortCodeInstance records from the API as a list.
+            # Lists FlowRevisionInstance records from the API as a list.
             # Unlike stream(), this operation is eager and will load `limit` records into
             # memory before returning.
             # @param [Integer] limit Upper limit for the number of records to return. stream()
@@ -58,7 +42,7 @@ module Twilio
             end
 
             ##
-            # Streams ShortCodeInstance records from the API as an Enumerable.
+            # Streams FlowRevisionInstance records from the API as an Enumerable.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
             # @param [Integer] limit Upper limit for the number of records to return. stream()
@@ -71,19 +55,19 @@ 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
 
             ##
-            # When passed a block, yields ShortCodeInstance records from the API.
+            # When passed a block, yields FlowRevisionInstance records from the API.
             # This operation lazily loads records as efficiently as possible until the limit
             # is reached.
             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],
@@ -91,55 +75,51 @@ module Twilio
             end
 
             ##
-            # Retrieve a single page of ShortCodeInstance records from the API.
+            # Retrieve a single page of FlowRevisionInstance records from the API.
             # Request is executed immediately.
             # @param [String] page_token PageToken provided by the API
             # @param [Integer] page_number Page Number, this value is simply for client state
             # @param [Integer] page_size Number of records to return, defaults to 50
-            # @return [Page] Page of ShortCodeInstance
+            # @return [Page] Page of FlowRevisionInstance
             def page(page_token: :unset, page_number: :unset, page_size: :unset)
               params = Twilio::Values.of({
                   'PageToken' => page_token,
                   'Page' => page_number,
                   'PageSize' => page_size,
               })
-              response = @version.page(
-                  'GET',
-                  @uri,
-                  params
-              )
-              ShortCodePage.new(@version, response, @solution)
+
+              response = @version.page('GET', @uri, params: params)
+
+              FlowRevisionPage.new(@version, response, @solution)
             end
 
             ##
-            # Retrieve a single page of ShortCodeInstance records from the API.
+            # Retrieve a single page of FlowRevisionInstance records from the API.
             # Request is executed immediately.
             # @param [String] target_url API-generated URL for the requested results page
-            # @return [Page] Page of ShortCodeInstance
+            # @return [Page] Page of FlowRevisionInstance
             def get_page(target_url)
               response = @version.domain.request(
                   'GET',
                   target_url
               )
-              ShortCodePage.new(@version, response, @solution)
+              FlowRevisionPage.new(@version, response, @solution)
             end
 
             ##
             # Provide a user friendly representation
             def to_s
-              '#<Twilio.Preview.Proxy.ShortCodeList>'
+              '#<Twilio.Studio.V2.FlowRevisionList>'
             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 ShortCodePage < Page
+          class FlowRevisionPage < Page
             ##
-            # Initialize the ShortCodePage
+            # Initialize the FlowRevisionPage
             # @param [Version] version Version that contains the resource
             # @param [Response] response Response from the API
             # @param [Hash] solution Path solution for the resource
-            # @return [ShortCodePage] ShortCodePage
+            # @return [FlowRevisionPage] FlowRevisionPage
             def initialize(version, response, solution)
               super(version, response)
 
@@ -148,173 +128,180 @@ module Twilio
             end
 
             ##
-            # Build an instance of ShortCodeInstance
+            # Build an instance of FlowRevisionInstance
             # @param [Hash] payload Payload response from the API
-            # @return [ShortCodeInstance] ShortCodeInstance
+            # @return [FlowRevisionInstance] FlowRevisionInstance
             def get_instance(payload)
-              ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid])
+              FlowRevisionInstance.new(@version, payload, sid: @solution[:sid], )
             end
 
             ##
             # Provide a user friendly representation
             def to_s
-              '<Twilio.Preview.Proxy.ShortCodePage>'
+              '<Twilio.Studio.V2.FlowRevisionPage>'
             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 ShortCodeContext < InstanceContext
+          class FlowRevisionContext < InstanceContext
             ##
-            # Initialize the ShortCodeContext
+            # Initialize the FlowRevisionContext
             # @param [Version] version Version that contains the resource
-            # @param [String] service_sid The service_sid
-            # @param [String] sid The shortcode Sid that uniquely identifies this resource
-            # @return [ShortCodeContext] ShortCodeContext
-            def initialize(version, service_sid, sid)
+            # @param [String] sid The SID of the Flow resource to fetch.
+            # @param [String] revision Specific Revision number or can be `LatestPublished`
+            #   and `LatestRevision`.
+            # @return [FlowRevisionContext] FlowRevisionContext
+            def initialize(version, sid, revision)
               super(version)
 
               # Path Solution
-              @solution = {service_sid: service_sid, sid: sid}
-              @uri = "/Services/#{@solution[:service_sid]}/ShortCodes/#{@solution[:sid]}"
+              @solution = {sid: sid, revision: revision, }
+              @uri = "/Flows/#{@solution[:sid]}/Revisions/#{@solution[:revision]}"
             end
 
             ##
-            # Deletes the ShortCodeInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
-            def delete
-              @version.delete('delete', @uri)
-            end
-
-            ##
-            # Fetch a ShortCodeInstance
-            # @return [ShortCodeInstance] Fetched ShortCodeInstance
+            # Fetch the FlowRevisionInstance
+            # @return [FlowRevisionInstance] Fetched FlowRevisionInstance
             def fetch
-              params = Twilio::Values.of({})
-
-              payload = @version.fetch(
-                  'GET',
-                  @uri,
-                  params,
-              )
+              payload = @version.fetch('GET', @uri)
 
-              ShortCodeInstance.new(@version, payload, service_sid: @solution[:service_sid], sid: @solution[:sid])
+              FlowRevisionInstance.new(@version, payload, sid: @solution[:sid], revision: @solution[:revision], )
             end
 
             ##
             # Provide a user friendly representation
             def to_s
               context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
-              "#<Twilio.Preview.Proxy.ShortCodeContext #{context}>"
+              "#<Twilio.Studio.V2.FlowRevisionContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Studio.V2.FlowRevisionContext #{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 ShortCodeInstance < InstanceResource
+          class FlowRevisionInstance < InstanceResource
             ##
-            # Initialize the ShortCodeInstance
+            # Initialize the FlowRevisionInstance
             # @param [Version] version Version that contains the resource
             # @param [Hash] payload payload that contains response from Twilio
-            # @param [String] service_sid The unique SID identifier of the Service.
-            # @param [String] sid The shortcode Sid that uniquely identifies this resource
-            # @return [ShortCodeInstance] ShortCodeInstance
-            def initialize(version, payload, service_sid: nil, sid: nil)
+            # @param [String] sid The unique string that we created to identify the Flow
+            #   resource.
+            # @param [String] revision Specific Revision number or can be `LatestPublished`
+            #   and `LatestRevision`.
+            # @return [FlowRevisionInstance] FlowRevisionInstance
+            def initialize(version, payload, sid: nil, revision: nil)
               super(version)
 
               # Marshaled Properties
               @properties = {
                   'sid' => payload['sid'],
                   'account_sid' => payload['account_sid'],
-                  'service_sid' => payload['service_sid'],
+                  'friendly_name' => payload['friendly_name'],
+                  'definition' => payload['definition'],
+                  'status' => payload['status'],
+                  'revision' => payload['revision'].to_i,
+                  'commit_message' => payload['commit_message'],
+                  'valid' => payload['valid'],
+                  'errors' => payload['errors'],
                   'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                   'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
-                  'short_code' => payload['short_code'],
-                  'country_code' => payload['country_code'],
-                  'capabilities' => payload['capabilities'],
                   'url' => payload['url'],
               }
 
               # Context
               @instance_context = nil
-              @params = {'service_sid' => service_sid, 'sid' => sid || @properties['sid']}
+              @params = {'sid' => sid, 'revision' => revision || @properties['revision'], }
             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 [ShortCodeContext] ShortCodeContext for this ShortCodeInstance
+            # @return [FlowRevisionContext] FlowRevisionContext for this FlowRevisionInstance
             def context
               unless @instance_context
-                @instance_context = ShortCodeContext.new(@version, @params['service_sid'], @params['sid'])
+                @instance_context = FlowRevisionContext.new(@version, @params['sid'], @params['revision'], )
               end
               @instance_context
             end
 
             ##
-            # @return [String] A string that uniquely identifies this resource
+            # @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] Service Sid.
-            def service_sid
-              @properties['service_sid']
+            # @return [String] The string that you assigned to describe the Flow
+            def friendly_name
+              @properties['friendly_name']
             end
 
             ##
-            # @return [Time] The date this resource was created
-            def date_created
-              @properties['date_created']
+            # @return [Hash] JSON representation of flow definition
+            def definition
+              @properties['definition']
             end
 
             ##
-            # @return [Time] The date this resource was last updated
-            def date_updated
-              @properties['date_updated']
+            # @return [flow_revision.Status] The status of the Flow
+            def status
+              @properties['status']
             end
 
             ##
-            # @return [String] The short code. e.g., 894546.
-            def short_code
-              @properties['short_code']
+            # @return [String] The latest revision number of the Flow's definition
+            def revision
+              @properties['revision']
             end
 
             ##
-            # @return [String] The ISO 3166-1 alpha-2 country code
-            def country_code
-              @properties['country_code']
+            # @return [String] Description of change made in the revision
+            def commit_message
+              @properties['commit_message']
             end
 
             ##
-            # @return [Hash] Indicate if a shortcode can receive messages
-            def capabilities
-              @properties['capabilities']
+            # @return [Boolean] Boolean if the flow definition is valid
+            def valid
+              @properties['valid']
             end
 
             ##
-            # @return [String] The URL of this resource.
-            def url
-              @properties['url']
+            # @return [Array[Hash]] List of error in the flow definition
+            def errors
+              @properties['errors']
+            end
+
+            ##
+            # @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 ISO 8601 date and time in GMT when the resource was last updated
+            def date_updated
+              @properties['date_updated']
             end
 
             ##
-            # Deletes the ShortCodeInstance
-            # @return [Boolean] true if delete succeeds, true otherwise
-            def delete
-              context.delete
+            # @return [String] The absolute URL of the resource
+            def url
+              @properties['url']
             end
 
             ##
-            # Fetch a ShortCodeInstance
-            # @return [ShortCodeInstance] Fetched ShortCodeInstance
+            # Fetch the FlowRevisionInstance
+            # @return [FlowRevisionInstance] Fetched FlowRevisionInstance
             def fetch
               context.fetch
             end
@@ -323,14 +310,14 @@ module Twilio
             # Provide a user friendly representation
             def to_s
               values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Preview.Proxy.ShortCodeInstance #{values}>"
+              "<Twilio.Studio.V2.FlowRevisionInstance #{values}>"
             end
 
             ##
             # Provide a detailed, user friendly representation
             def inspect
               values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
-              "<Twilio.Preview.Proxy.ShortCodeInstance #{values}>"
+              "<Twilio.Studio.V2.FlowRevisionInstance #{values}>"
             end
           end
         end

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

@@ -0,0 +1,199 @@
+##
+# 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 FlowTestUserList < ListResource
+            ##
+            # Initialize the FlowTestUserList
+            # @param [Version] version Version that contains the resource
+            # @param [String] sid Unique identifier of the flow.
+            # @return [FlowTestUserList] FlowTestUserList
+            def initialize(version, sid: nil)
+              super(version)
+
+              # Path Solution
+              @solution = {sid: sid}
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '#<Twilio.Studio.V2.FlowTestUserList>'
+            end
+          end
+
+          class FlowTestUserPage < Page
+            ##
+            # Initialize the FlowTestUserPage
+            # @param [Version] version Version that contains the resource
+            # @param [Response] response Response from the API
+            # @param [Hash] solution Path solution for the resource
+            # @return [FlowTestUserPage] FlowTestUserPage
+            def initialize(version, response, solution)
+              super(version, response)
+
+              # Path Solution
+              @solution = solution
+            end
+
+            ##
+            # Build an instance of FlowTestUserInstance
+            # @param [Hash] payload Payload response from the API
+            # @return [FlowTestUserInstance] FlowTestUserInstance
+            def get_instance(payload)
+              FlowTestUserInstance.new(@version, payload, sid: @solution[:sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              '<Twilio.Studio.V2.FlowTestUserPage>'
+            end
+          end
+
+          class FlowTestUserContext < InstanceContext
+            ##
+            # Initialize the FlowTestUserContext
+            # @param [Version] version Version that contains the resource
+            # @param [String] sid Unique identifier of the flow.
+            # @return [FlowTestUserContext] FlowTestUserContext
+            def initialize(version, sid)
+              super(version)
+
+              # Path Solution
+              @solution = {sid: sid, }
+              @uri = "/Flows/#{@solution[:sid]}/TestUsers"
+            end
+
+            ##
+            # Fetch the FlowTestUserInstance
+            # @return [FlowTestUserInstance] Fetched FlowTestUserInstance
+            def fetch
+              payload = @version.fetch('GET', @uri)
+
+              FlowTestUserInstance.new(@version, payload, sid: @solution[:sid], )
+            end
+
+            ##
+            # Update the FlowTestUserInstance
+            # @param [Array[String]] test_users List of test user identities that can test
+            #   draft versions of the flow.
+            # @return [FlowTestUserInstance] Updated FlowTestUserInstance
+            def update(test_users: nil)
+              data = Twilio::Values.of({'TestUsers' => Twilio.serialize_list(test_users) { |e| e }, })
+
+              payload = @version.update('POST', @uri, data: data)
+
+              FlowTestUserInstance.new(@version, payload, sid: @solution[:sid], )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Studio.V2.FlowTestUserContext #{context}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              context = @solution.map {|k, v| "#{k}: #{v}"}.join(',')
+              "#<Twilio.Studio.V2.FlowTestUserContext #{context}>"
+            end
+          end
+
+          class FlowTestUserInstance < InstanceResource
+            ##
+            # Initialize the FlowTestUserInstance
+            # @param [Version] version Version that contains the resource
+            # @param [Hash] payload payload that contains response from Twilio
+            # @param [String] sid Unique identifier of the flow.
+            # @return [FlowTestUserInstance] FlowTestUserInstance
+            def initialize(version, payload, sid: nil)
+              super(version)
+
+              # Marshaled Properties
+              @properties = {
+                  'sid' => payload['sid'],
+                  'test_users' => payload['test_users'],
+                  'url' => payload['url'],
+              }
+
+              # Context
+              @instance_context = nil
+              @params = {'sid' => 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 [FlowTestUserContext] FlowTestUserContext for this FlowTestUserInstance
+            def context
+              unless @instance_context
+                @instance_context = FlowTestUserContext.new(@version, @params['sid'], )
+              end
+              @instance_context
+            end
+
+            ##
+            # @return [String] Unique identifier of the flow.
+            def sid
+              @properties['sid']
+            end
+
+            ##
+            # @return [Array[String]] List of test user identities that can test draft versions of the flow.
+            def test_users
+              @properties['test_users']
+            end
+
+            ##
+            # @return [String] The URL of this resource.
+            def url
+              @properties['url']
+            end
+
+            ##
+            # Fetch the FlowTestUserInstance
+            # @return [FlowTestUserInstance] Fetched FlowTestUserInstance
+            def fetch
+              context.fetch
+            end
+
+            ##
+            # Update the FlowTestUserInstance
+            # @param [Array[String]] test_users List of test user identities that can test
+            #   draft versions of the flow.
+            # @return [FlowTestUserInstance] Updated FlowTestUserInstance
+            def update(test_users: nil)
+              context.update(test_users: test_users, )
+            end
+
+            ##
+            # Provide a user friendly representation
+            def to_s
+              values = @params.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Studio.V2.FlowTestUserInstance #{values}>"
+            end
+
+            ##
+            # Provide a detailed, user friendly representation
+            def inspect
+              values = @properties.map{|k, v| "#{k}: #{v}"}.join(" ")
+              "<Twilio.Studio.V2.FlowTestUserInstance #{values}>"
+            end
+          end
+        end
+      end
+    end
+  end
+end