twilio-ruby 7.9.1 → 7.10.0

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

@@ -25,6 +25,7 @@ module Twilio
                     # @return [FlowList] FlowList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Flows"
@@ -64,6 +65,46 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the FlowInstanceMetadata
+                    # @param [String] friendly_name The string that you assigned to describe the Flow.
+                    # @param [Status] status 
+                    # @param [Object] definition JSON representation of flow definition.
+                    # @param [String] commit_message Description of change made in the revision.
+                    # @return [FlowInstance] Created FlowInstance
+                    def create_with_metadata(
+                      friendly_name: nil, 
+                      status: nil, 
+                      definition: nil, 
+                      commit_message: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'Status' => status,
+                            'Definition' => Twilio.serialize_object(definition),
+                            'CommitMessage' => commit_message,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        flow_instance = FlowInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        FlowInstanceMetadata.new(
+                            @version,
+                            flow_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists FlowInstance records from the API as a list.
@@ -103,6 +144,28 @@ module Twilio
                         @version.stream(page, limit: limits[:limit], page_limit: limits[:page_limit])
                     end
 
+                    ##
+                    # Lists FlowPageMetadata 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)
+
+                        FlowPageMetadata.new(@version, response, @solution, limits[:limit])
+                    end
+
                     ##
                     # When passed a block, yields FlowInstance records from the API.
                     # This operation lazily loads records as efficiently as possible until the limit
@@ -124,7 +187,7 @@ 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 FlowInstance
-                    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,
@@ -169,6 +232,7 @@ module Twilio
                     # @return [FlowContext] FlowContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -188,9 +252,29 @@ module Twilio
                         
                         
                         
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the FlowInstanceMetadata
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          flow_instance = FlowInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          FlowInstanceMetadata.new(@version, flow_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the FlowInstance
                     # @return [FlowInstance] Fetched FlowInstance
@@ -210,6 +294,31 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the FlowInstanceMetadata
+                    # @return [FlowInstance] Fetched FlowInstance
+                    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_instance = FlowInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        FlowInstanceMetadata.new(
+                            @version,
+                            flow_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the FlowInstance
                     # @param [Status] status 
@@ -245,6 +354,47 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the FlowInstanceMetadata
+                    # @param [Status] status 
+                    # @param [String] friendly_name The string that you assigned to describe the Flow.
+                    # @param [Object] definition JSON representation of flow definition.
+                    # @param [String] commit_message Description of change made in the revision.
+                    # @return [FlowInstance] Updated FlowInstance
+                    def update_with_metadata(
+                      status: nil, 
+                      friendly_name: :unset, 
+                      definition: :unset, 
+                      commit_message: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Status' => status,
+                            'FriendlyName' => friendly_name,
+                            'Definition' => Twilio.serialize_object(definition),
+                            'CommitMessage' => commit_message,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        flow_instance = FlowInstance.new(
+                            @version,
+                            response.body,
+                            sid: @solution[:sid],
+                        )
+                        FlowInstanceMetadata.new(
+                            @version,
+                            flow_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the executions
                     # @return [ExecutionList]
@@ -309,6 +459,53 @@ module Twilio
                     end
                 end
 
+                class FlowInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new FlowInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}FlowInstance] flow_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 [FlowInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, flow_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @flow_instance = flow_instance
+                    end
+
+                    def flow
+                        @flow_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.FlowInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class FlowListResponse < InstanceListResource
+                    # @param [Array<FlowInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @flow_instance = payload.body[key].map do |data|
+                        FlowInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def flow_instance
+                          @instance
+                      end
+                  end
+
                 class FlowPage < Page
                     ##
                     # Initialize the FlowPage
@@ -318,6 +515,7 @@ module Twilio
                     # @return [FlowPage] FlowPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -337,6 +535,66 @@ module Twilio
                         '<Twilio.Studio.V2.FlowPage>'
                     end
                 end
+
+                class FlowPageMetadata < PageMetadata
+                    attr_reader :flow_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @flow_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @flow_page << FlowListResponse.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_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Studio::V2PageMetadata>';
+                    end
+                end
+                class FlowListResponse < InstanceListResource
+
+                    # @param [Array<FlowInstance>] 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 = data_list.map do |data|
+                        FlowInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def flow
+                        @flow
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class FlowInstance < InstanceResource
                     ##
                     # Initialize the FlowInstance
@@ -350,6 +608,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],

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

@@ -25,6 +25,7 @@ module Twilio
                     # @return [FlowValidateList] FlowValidateList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Flows/Validate"
@@ -64,6 +65,46 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the FlowValidateInstanceMetadata
+                    # @param [String] friendly_name The string that you assigned to describe the Flow.
+                    # @param [Status] status 
+                    # @param [Object] definition JSON representation of flow definition.
+                    # @param [String] commit_message Description of change made in the revision.
+                    # @return [FlowValidateInstance] Updated FlowValidateInstance
+                    def update_with_metadata(
+                      friendly_name: nil, 
+                      status: nil, 
+                      definition: nil, 
+                      commit_message: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'FriendlyName' => friendly_name,
+                            'Status' => status,
+                            'Definition' => Twilio.serialize_object(definition),
+                            'CommitMessage' => commit_message,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        flow_validate_instance = FlowValidateInstance.new(
+                            @version,
+                            response.body,
+                        )
+                        FlowValidateInstanceMetadata.new(
+                            @version,
+                            flow_validate_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
 
 
@@ -82,6 +123,7 @@ module Twilio
                     # @return [FlowValidatePage] FlowValidatePage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -101,6 +143,66 @@ module Twilio
                         '<Twilio.Studio.V2.FlowValidatePage>'
                     end
                 end
+
+                class FlowValidatePageMetadata < PageMetadata
+                    attr_reader :flow_validate_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @flow_validate_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @flow_validate_page << FlowValidateListResponse.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_validate_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Studio::V2PageMetadata>';
+                    end
+                end
+                class FlowValidateListResponse < InstanceListResource
+
+                    # @param [Array<FlowValidateInstance>] 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_validate = data_list.map do |data|
+                        FlowValidateInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def flow_validate
+                        @flow_validate
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class FlowValidateInstance < InstanceResource
                     ##
                     # Initialize the FlowValidateInstance
@@ -114,6 +216,7 @@ module Twilio
                     def initialize(version, payload )
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'valid' => payload['valid'],