twilio-ruby 6.8.0 → 7.10.7

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

@@ -18,12 +18,14 @@ module Twilio
         class Studio < StudioBase
             class V1 < Version
                 class FlowList < ListResource
+                
                     ##
                     # Initialize the FlowList
                     # @param [Version] version Version that contains the resource
                     # @return [FlowList] FlowList
                     def initialize(version)
                         super(version)
+                        
                         # Path Solution
                         @solution = {  }
                         @uri = "/Flows"
@@ -65,7 +67,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 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
 
                     ##
@@ -77,9 +105,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
 
                     ##
@@ -89,14 +121,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 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,
                             'PageSize' => page_size,
                         })
+                        headers = Twilio::Values.of({})
+                        
+                        
 
-                        response = @version.page('GET', @uri, params: params)
+                        response = @version.page('GET', @uri, params: params, headers: headers)
 
                         FlowPage.new(@version, response, @solution)
                     end
@@ -131,6 +166,7 @@ module Twilio
                     # @return [FlowContext] FlowContext
                     def initialize(version, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { sid: sid,  }
@@ -145,7 +181,31 @@ module Twilio
                     # @return [Boolean] True if delete succeeds, false otherwise
                     def delete
 
-                        @version.delete('DELETE', @uri)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+
+                        @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
 
                     ##
@@ -153,7 +213,13 @@ module Twilio
                     # @return [FlowInstance] Fetched FlowInstance
                     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)
                         FlowInstance.new(
                             @version,
                             payload,
@@ -161,6 +227,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
+
                     ##
                     # Access the executions
                     # @return [ExecutionList]
@@ -215,6 +306,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
@@ -224,6 +362,7 @@ module Twilio
                     # @return [FlowPage] FlowPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -243,6 +382,66 @@ module Twilio
                         '<Twilio.Studio.V1.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::V1PageMetadata>';
+                    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
@@ -256,6 +455,7 @@ module Twilio
                     def initialize(version, payload , sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],

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

@@ -32,6 +32,7 @@ module Twilio
                     if sid.nil?
                         raise ArgumentError, 'sid cannot be nil'
                     end
+
                     if sid == :unset
                         @flows ||= FlowList.new self
                     else

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

@@ -21,12 +21,14 @@ module Twilio
                 class ExecutionContext < InstanceContext
 
                      class ExecutionContextList < ListResource
+                
                     ##
                     # Initialize the ExecutionContextList
                     # @param [Version] version Version that contains the 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 }
                         
@@ -51,6 +53,7 @@ module Twilio
                     # @return [ExecutionContextContext] ExecutionContextContext
                     def initialize(version, flow_sid, execution_sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { flow_sid: flow_sid, execution_sid: execution_sid,  }
@@ -63,7 +66,13 @@ module Twilio
                     # @return [ExecutionContextInstance] Fetched ExecutionContextInstance
                     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)
                         ExecutionContextInstance.new(
                             @version,
                             payload,
@@ -72,6 +81,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the ExecutionContextInstanceMetadata
+                    # @return [ExecutionContextInstance] Fetched ExecutionContextInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        execution_context_instance = ExecutionContextInstance.new(
+                            @version,
+                            response.body,
+                            flow_sid: @solution[:flow_sid],
+                            execution_sid: @solution[:execution_sid],
+                        )
+                        ExecutionContextInstanceMetadata.new(
+                            @version,
+                            execution_context_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -88,6 +123,53 @@ module Twilio
                     end
                 end
 
+                class ExecutionContextInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new ExecutionContextInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}ExecutionContextInstance] execution_context_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 [ExecutionContextInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, execution_context_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @execution_context_instance = execution_context_instance
+                    end
+
+                    def execution_context
+                        @execution_context_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.ExecutionContextInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class ExecutionContextListResponse < InstanceListResource
+                    # @param [Array<ExecutionContextInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @execution_context_instance = payload.body[key].map do |data|
+                        ExecutionContextInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def execution_context_instance
+                          @instance
+                      end
+                  end
+
                 class ExecutionContextPage < Page
                     ##
                     # Initialize the ExecutionContextPage
@@ -97,6 +179,7 @@ module Twilio
                     # @return [ExecutionContextPage] ExecutionContextPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -116,6 +199,66 @@ module Twilio
                         '<Twilio.Studio.V2.ExecutionContextPage>'
                     end
                 end
+
+                class ExecutionContextPageMetadata < PageMetadata
+                    attr_reader :execution_context_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @execution_context_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @execution_context_page << ExecutionContextListResponse.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
+                        @execution_context_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Studio::V2PageMetadata>';
+                    end
+                end
+                class ExecutionContextListResponse < InstanceListResource
+
+                    # @param [Array<ExecutionContextInstance>] 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
+                      @execution_context = data_list.map do |data|
+                        ExecutionContextInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def execution_context
+                        @execution_context
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class ExecutionContextInstance < InstanceResource
                     ##
                     # Initialize the ExecutionContextInstance
@@ -129,6 +272,7 @@ module Twilio
                     def initialize(version, payload , flow_sid: nil, execution_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],