twilio-ruby 6.8.0 → 7.10.7

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

@@ -22,12 +22,14 @@ module Twilio
                 class StepContext < InstanceContext
 
                      class StepContextList < ListResource
+                
                     ##
                     # Initialize the StepContextList
                     # @param [Version] version Version that contains the resource
                     # @return [StepContextList] StepContextList
                     def initialize(version, flow_sid: nil, engagement_sid: nil, step_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { flow_sid: flow_sid, engagement_sid: engagement_sid, step_sid: step_sid }
                         
@@ -53,6 +55,7 @@ module Twilio
                     # @return [StepContextContext] StepContextContext
                     def initialize(version, flow_sid, engagement_sid, step_sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { flow_sid: flow_sid, engagement_sid: engagement_sid, step_sid: step_sid,  }
@@ -65,7 +68,13 @@ module Twilio
                     # @return [StepContextInstance] Fetched StepContextInstance
                     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)
                         StepContextInstance.new(
                             @version,
                             payload,
@@ -75,6 +84,33 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the StepContextInstanceMetadata
+                    # @return [StepContextInstance] Fetched StepContextInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        step_context_instance = StepContextInstance.new(
+                            @version,
+                            response.body,
+                            flow_sid: @solution[:flow_sid],
+                            engagement_sid: @solution[:engagement_sid],
+                            step_sid: @solution[:step_sid],
+                        )
+                        StepContextInstanceMetadata.new(
+                            @version,
+                            step_context_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -91,6 +127,53 @@ module Twilio
                     end
                 end
 
+                class StepContextInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new StepContextInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}StepContextInstance] step_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 [StepContextInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, step_context_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @step_context_instance = step_context_instance
+                    end
+
+                    def step_context
+                        @step_context_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.StepContextInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class StepContextListResponse < InstanceListResource
+                    # @param [Array<StepContextInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @step_context_instance = payload.body[key].map do |data|
+                        StepContextInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def step_context_instance
+                          @instance
+                      end
+                  end
+
                 class StepContextPage < Page
                     ##
                     # Initialize the StepContextPage
@@ -100,6 +183,7 @@ module Twilio
                     # @return [StepContextPage] StepContextPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -119,6 +203,66 @@ module Twilio
                         '<Twilio.Studio.V1.StepContextPage>'
                     end
                 end
+
+                class StepContextPageMetadata < PageMetadata
+                    attr_reader :step_context_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @step_context_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @step_context_page << StepContextListResponse.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
+                        @step_context_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Studio::V1PageMetadata>';
+                    end
+                end
+                class StepContextListResponse < InstanceListResource
+
+                    # @param [Array<StepContextInstance>] 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
+                      @step_context = data_list.map do |data|
+                        StepContextInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def step_context
+                        @step_context
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class StepContextInstance < InstanceResource
                     ##
                     # Initialize the StepContextInstance
@@ -132,6 +276,7 @@ module Twilio
                     def initialize(version, payload , flow_sid: nil, engagement_sid: nil, step_sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],

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

@@ -21,12 +21,14 @@ module Twilio
                 class EngagementContext < InstanceContext
 
                      class StepList < ListResource
+                
                     ##
                     # Initialize the StepList
                     # @param [Version] version Version that contains the resource
                     # @return [StepList] StepList
                     def initialize(version, flow_sid: nil, engagement_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { flow_sid: flow_sid, engagement_sid: engagement_sid }
                         @uri = "/Flows/#{@solution[:flow_sid]}/Engagements/#{@solution[:engagement_sid]}/Steps"
@@ -68,7 +70,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 StepPageMetadata 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)
+
+                        StepPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -80,9 +108,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
 
                     ##
@@ -92,14 +124,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 StepInstance
-                    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)
 
                         StepPage.new(@version, response, @solution)
                     end
@@ -136,6 +171,7 @@ module Twilio
                     # @return [StepContext] StepContext
                     def initialize(version, flow_sid, engagement_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { flow_sid: flow_sid, engagement_sid: engagement_sid, sid: sid,  }
@@ -149,7 +185,13 @@ module Twilio
                     # @return [StepInstance] Fetched StepInstance
                     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)
                         StepInstance.new(
                             @version,
                             payload,
@@ -159,6 +201,33 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the StepInstanceMetadata
+                    # @return [StepInstance] Fetched StepInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        step_instance = StepInstance.new(
+                            @version,
+                            response.body,
+                            flow_sid: @solution[:flow_sid],
+                            engagement_sid: @solution[:engagement_sid],
+                            sid: @solution[:sid],
+                        )
+                        StepInstanceMetadata.new(
+                            @version,
+                            step_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the step_context
                     # @return [StepContextList]
@@ -187,6 +256,53 @@ module Twilio
                     end
                 end
 
+                class StepInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new StepInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}StepInstance] step_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 [StepInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, step_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @step_instance = step_instance
+                    end
+
+                    def step
+                        @step_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.StepInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class StepListResponse < InstanceListResource
+                    # @param [Array<StepInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @step_instance = payload.body[key].map do |data|
+                        StepInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def step_instance
+                          @instance
+                      end
+                  end
+
                 class StepPage < Page
                     ##
                     # Initialize the StepPage
@@ -196,6 +312,7 @@ module Twilio
                     # @return [StepPage] StepPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -215,6 +332,66 @@ module Twilio
                         '<Twilio.Studio.V1.StepPage>'
                     end
                 end
+
+                class StepPageMetadata < PageMetadata
+                    attr_reader :step_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @step_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @step_page << StepListResponse.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
+                        @step_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Studio::V1PageMetadata>';
+                    end
+                end
+                class StepListResponse < InstanceListResource
+
+                    # @param [Array<StepInstance>] 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
+                      @step = data_list.map do |data|
+                        StepInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def step
+                        @step
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class StepInstance < InstanceResource
                     ##
                     # Initialize the StepInstance
@@ -228,6 +405,7 @@ module Twilio
                     def initialize(version, payload , flow_sid: nil, engagement_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
@@ -236,8 +414,10 @@ module Twilio
                             'engagement_sid' => payload['engagement_sid'],
                             'name' => payload['name'],
                             'context' => payload['context'],
+                            'parent_step_sid' => payload['parent_step_sid'],
                             'transitioned_from' => payload['transitioned_from'],
                             'transitioned_to' => payload['transitioned_to'],
+                            'type' => payload['type'],
                             'date_created' => Twilio.deserialize_iso8601_datetime(payload['date_created']),
                             'date_updated' => Twilio.deserialize_iso8601_datetime(payload['date_updated']),
                             'url' => payload['url'],
@@ -296,6 +476,12 @@ module Twilio
                         @properties['context']
                     end
                     
+                    ##
+                    # @return [String] The SID of the parent Step.
+                    def parent_step_sid
+                        @properties['parent_step_sid']
+                    end
+                    
                     ##
                     # @return [String] The Widget that preceded the Widget for the Step.
                     def transitioned_from
@@ -308,6 +494,12 @@ module Twilio
                         @properties['transitioned_to']
                     end
                     
+                    ##
+                    # @return [String] The type of the widget that was executed.
+                    def type
+                        @properties['type']
+                    end
+                    
                     ##
                     # @return [Time] The date and time in GMT when the resource was created specified in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.
                     def date_created