twilio-ruby 6.8.0 → 7.10.7

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

@@ -20,12 +20,14 @@ module Twilio
                 class FlowContext < InstanceContext
 
                      class FlowRevisionList < ListResource
+                
                     ##
                     # Initialize the FlowRevisionList
                     # @param [Version] version Version that contains the resource
                     # @return [FlowRevisionList] FlowRevisionList
                     def initialize(version, sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { sid: sid }
                         @uri = "/Flows/#{@solution[:sid]}/Revisions"
@@ -67,7 +69,33 @@ module Twilio
                         page = self.page(
                             page_size: limits[:page_size], )
 
-                        @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if page.nil?
+
+                        result = @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result
+                    end
+
+                    ##
+                    # Lists FlowRevisionPageMetadata records from the API as a list.
+                    # @param [Integer] limit Upper limit for the number of records to return. stream()
+                    #    guarantees to never return more than limit.  Default is no limit
+                    # @param [Integer] page_size Number of records to fetch per request, when
+                    #    not set will use the default value of 50 records.  If no page_size is defined
+                    #    but a limit is defined, stream() will attempt to read the limit with the most
+                    #    efficient page size, i.e. min(limit, 1000)
+                    # @return [Array] Array of up to limit results
+                    def list_with_metadata(limit: nil, page_size: nil)
+                        limits = @version.read_limits(limit, page_size)
+                        params = Twilio::Values.of({
+                            
+                            'PageSize' => limits[:page_size],
+                        });
+                        headers = Twilio::Values.of({})
+
+                        response = @version.page('GET', @uri, params: params, headers: headers)
+
+                        FlowRevisionPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -79,9 +107,13 @@ module Twilio
 
                         page = self.page(page_size: limits[:page_size], )
 
-                        @version.stream(page,
+                        return [].each if page.nil?
+
+                        result = @version.stream(page,
                             limit: limits[:limit],
-                            page_limit: limits[:page_limit]).each {|x| yield x}
+                            page_limit: limits[:page_limit])
+                        return [].each if result.nil?
+                        result.each {|x| yield x}
                     end
 
                     ##
@@ -91,14 +123,17 @@ module Twilio
                     # @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 FlowRevisionInstance
-                    def page(page_token: :unset, page_number: :unset, page_size: :unset)
+                    def page(page_token: :unset, page_number: :unset,page_size: :unset)
                         params = Twilio::Values.of({
                             'PageToken' => page_token,
                             'Page' => page_number,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         FlowRevisionPage.new(@version, response, @solution)
                     end
@@ -134,6 +169,7 @@ module Twilio
                     # @return [FlowRevisionContext] FlowRevisionContext
                     def initialize(version, sid, revision)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid, revision: revision,  }
@@ -146,7 +182,13 @@ module Twilio
                     # @return [FlowRevisionInstance] Fetched FlowRevisionInstance
                     def fetch
 
-                        payload = @version.fetch('GET', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
                         FlowRevisionInstance.new(
                             @version,
                             payload,
@@ -155,6 +197,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the FlowRevisionInstanceMetadata
+                    # @return [FlowRevisionInstance] Fetched FlowRevisionInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        flow_revision_instance = FlowRevisionInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                            revision: @solution[:revision],
+                        )
+                        FlowRevisionInstanceMetadata.new(
+                            @version,
+                            flow_revision_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -171,6 +239,53 @@ module Twilio
                     end
                 end
 
+                class FlowRevisionInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new FlowRevisionInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}FlowRevisionInstance] flow_revision_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [FlowRevisionInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, flow_revision_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @flow_revision_instance = flow_revision_instance
+                    end
+
+                    def flow_revision
+                        @flow_revision_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.FlowRevisionInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class FlowRevisionListResponse < InstanceListResource
+                    # @param [Array<FlowRevisionInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @flow_revision_instance = payload.body[key].map do |data|
+                        FlowRevisionInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def flow_revision_instance
+                          @instance
+                      end
+                  end
+
                 class FlowRevisionPage < Page
                     ##
                     # Initialize the FlowRevisionPage
@@ -180,6 +295,7 @@ module Twilio
                     # @return [FlowRevisionPage] FlowRevisionPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -199,6 +315,66 @@ module Twilio
                         '<Twilio.Studio.V2.FlowRevisionPage>'
                     end
                 end
+
+                class FlowRevisionPageMetadata < PageMetadata
+                    attr_reader :flow_revision_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @flow_revision_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @flow_revision_page << FlowRevisionListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @flow_revision_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Studio::V2PageMetadata>';
+                    end
+                end
+                class FlowRevisionListResponse < InstanceListResource
+
+                    # @param [Array<FlowRevisionInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]  || []
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @flow_revision = data_list.map do |data|
+                        FlowRevisionInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def flow_revision
+                        @flow_revision
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class FlowRevisionInstance < InstanceResource
                     ##
                     # Initialize the FlowRevisionInstance
@@ -212,10 +388,12 @@ module Twilio
                     def initialize(version, payload , sid: nil, revision: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
                             'account_sid' => payload['account_sid'],
+                            'author_sid' => payload['author_sid'],
                             'friendly_name' => payload['friendly_name'],
                             'definition' => payload['definition'],
                             'status' => payload['status'],
@@ -256,6 +434,12 @@ module Twilio
                         @properties['account_sid']
                     end
                     
+                    ##
+                    # @return [String] The SID of the User that created or last updated the Flow.
+                    def author_sid
+                        @properties['author_sid']
+                    end
+                    
                     ##
                     # @return [String] The string that you assigned to describe the Flow.
                     def friendly_name

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

@@ -20,12 +20,14 @@ module Twilio
                 class FlowContext < InstanceContext
 
                      class FlowTestUserList < ListResource
+                
                     ##
                     # Initialize the FlowTestUserList
                     # @param [Version] version Version that contains the resource
                     # @return [FlowTestUserList] FlowTestUserList
                     def initialize(version, sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { sid: sid }
                         
@@ -49,6 +51,7 @@ module Twilio
                     # @return [FlowTestUserContext] FlowTestUserContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -61,7 +64,13 @@ module Twilio
                     # @return [FlowTestUserInstance] Fetched FlowTestUserInstance
                     def fetch
 
-                        payload = @version.fetch('GET', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.fetch('GET', @uri, headers: headers)
                         FlowTestUserInstance.new(
                             @version,
                             payload,
@@ -69,19 +78,50 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the FlowTestUserInstanceMetadata
+                    # @return [FlowTestUserInstance] Fetched FlowTestUserInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        flow_test_user_instance = FlowTestUserInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        FlowTestUserInstanceMetadata.new(
+                            @version,
+                            flow_test_user_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    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
+                      test_users: nil
                     )
 
                         data = Twilio::Values.of({
                             'TestUsers' => Twilio.serialize_list(test_users) { |e| e },
                         })
 
-                        payload = @version.update('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.update('POST', @uri, data: data, headers: headers)
                         FlowTestUserInstance.new(
                             @version,
                             payload,
@@ -89,6 +129,38 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the FlowTestUserInstanceMetadata
+                    # @param [Array[String]] test_users List of test user identities that can test draft versions of the flow.
+                    # @return [FlowTestUserInstance] Updated FlowTestUserInstance
+                    def update_with_metadata(
+                      test_users: nil
+                    )
+
+                        data = Twilio::Values.of({
+                            'TestUsers' => Twilio.serialize_list(test_users) { |e| e },
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        flow_test_user_instance = FlowTestUserInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        FlowTestUserInstanceMetadata.new(
+                            @version,
+                            flow_test_user_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -105,6 +177,53 @@ module Twilio
                     end
                 end
 
+                class FlowTestUserInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new FlowTestUserInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}FlowTestUserInstance] flow_test_user_instance The instance associated with the metadata.
+                    # @param [Hash] headers Header object with response headers.
+                    # @param [Integer] status_code The HTTP status code of the response.
+                    # @return [FlowTestUserInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, flow_test_user_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @flow_test_user_instance = flow_test_user_instance
+                    end
+
+                    def flow_test_user
+                        @flow_test_user_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.FlowTestUserInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class FlowTestUserListResponse < InstanceListResource
+                    # @param [Array<FlowTestUserInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @flow_test_user_instance = payload.body[key].map do |data|
+                        FlowTestUserInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def flow_test_user_instance
+                          @instance
+                      end
+                  end
+
                 class FlowTestUserPage < Page
                     ##
                     # Initialize the FlowTestUserPage
@@ -114,6 +233,7 @@ module Twilio
                     # @return [FlowTestUserPage] FlowTestUserPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -133,6 +253,66 @@ module Twilio
                         '<Twilio.Studio.V2.FlowTestUserPage>'
                     end
                 end
+
+                class FlowTestUserPageMetadata < PageMetadata
+                    attr_reader :flow_test_user_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @flow_test_user_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @flow_test_user_page << FlowTestUserListResponse.new(version, @payload, key, limit - records)
+                            @payload = self.next_page
+                            break unless @payload
+                            records += (@payload.body[key] || []).size
+                        end
+                        # Path Solution
+                        @solution = solution
+                    end
+
+                    def each
+                        @flow_test_user_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Studio::V2PageMetadata>';
+                    end
+                end
+                class FlowTestUserListResponse < InstanceListResource
+
+                    # @param [Array<FlowTestUserInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key, limit = :unset)
+                      data_list = payload.body[key]  || []
+                      if limit != :unset
+                        data_list = data_list[0, limit]
+                      end
+                      @flow_test_user = data_list.map do |data|
+                        FlowTestUserInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def flow_test_user
+                        @flow_test_user
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class FlowTestUserInstance < InstanceResource
                     ##
                     # Initialize the FlowTestUserInstance
@@ -146,6 +326,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
@@ -200,7 +381,7 @@ module Twilio
                     # @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
+                      test_users: nil
                     )
 
                         context.update(