twilio-ruby 6.8.0 → 7.10.7

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

@@ -20,12 +20,14 @@ module Twilio
                 class FlowContext < InstanceContext
 
                      class EngagementList < ListResource
+                
                     ##
                     # Initialize the EngagementList
                     # @param [Version] version Version that contains the resource
                     # @return [EngagementList] EngagementList
                     def initialize(version, flow_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { flow_sid: flow_sid }
                         @uri = "/Flows/#{@solution[:flow_sid]}/Engagements"
@@ -38,9 +40,9 @@ module Twilio
                     # @param [Object] parameters A JSON string we will add to your flow's context and that you can access as variables inside your flow. For example, if you pass in `Parameters={'name':'Zeke'}` then inside a widget you can reference the variable `{{flow.data.name}}` which will return the string 'Zeke'. Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode your JSON string.
                     # @return [EngagementInstance] Created EngagementInstance
                     def create(
-                        to: nil, 
-                        from: nil, 
-                        parameters: :unset
+                      to: nil, 
+                      from: nil, 
+                      parameters: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -49,7 +51,13 @@ module Twilio
                             'Parameters' => Twilio.serialize_object(parameters),
                         })
 
-                        payload = @version.create('POST', @uri, data: data)
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        payload = @version.create('POST', @uri, data: data, headers: headers)
                         EngagementInstance.new(
                             @version,
                             payload,
@@ -57,6 +65,44 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the EngagementInstanceMetadata
+                    # @param [String] to The Contact phone number to start a Studio Flow Engagement, available as variable `{{contact.channel.address}}`.
+                    # @param [String] from The Twilio phone number to send messages or initiate calls from during the Flow Engagement. Available as variable `{{flow.channel.address}}`
+                    # @param [Object] parameters A JSON string we will add to your flow's context and that you can access as variables inside your flow. For example, if you pass in `Parameters={'name':'Zeke'}` then inside a widget you can reference the variable `{{flow.data.name}}` which will return the string 'Zeke'. Note: the JSON value must explicitly be passed as a string, not as a hash object. Depending on your particular HTTP library, you may need to add quotes or URL encode your JSON string.
+                    # @return [EngagementInstance] Created EngagementInstance
+                    def create_with_metadata(
+                      to: nil, 
+                      from: nil, 
+                      parameters: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'To' => to,
+                            'From' => from,
+                            'Parameters' => Twilio.serialize_object(parameters),
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        engagement_instance = EngagementInstance.new(
+                            @version,
+                            response.body,
+                            flow_sid: @solution[:flow_sid],
+                        )
+                        EngagementInstanceMetadata.new(
+                            @version,
+                            engagement_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists EngagementInstance records from the API as a list.
@@ -93,7 +139,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 EngagementPageMetadata 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)
+
+                        EngagementPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -105,9 +177,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
 
                     ##
@@ -117,14 +193,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 EngagementInstance
-                    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)
 
                         EngagementPage.new(@version, response, @solution)
                     end
@@ -160,6 +239,7 @@ module Twilio
                     # @return [EngagementContext] EngagementContext
                     def initialize(version, flow_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { flow_sid: flow_sid, sid: sid,  }
@@ -174,7 +254,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 EngagementInstanceMetadata
+                    # @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)
+                          engagement_instance = EngagementInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          EngagementInstanceMetadata.new(@version, engagement_instance, response.headers, response.status_code)
                     end
 
                     ##
@@ -182,7 +286,13 @@ module Twilio
                     # @return [EngagementInstance] Fetched EngagementInstance
                     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)
                         EngagementInstance.new(
                             @version,
                             payload,
@@ -191,6 +301,32 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the EngagementInstanceMetadata
+                    # @return [EngagementInstance] Fetched EngagementInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        engagement_instance = EngagementInstance.new(
+                            @version,
+                            response.body,
+                            flow_sid: @solution[:flow_sid],
+                            sid: @solution[:sid],
+                        )
+                        EngagementInstanceMetadata.new(
+                            @version,
+                            engagement_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Access the steps
                     # @return [StepList]
@@ -237,6 +373,53 @@ module Twilio
                     end
                 end
 
+                class EngagementInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new EngagementInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}EngagementInstance] engagement_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 [EngagementInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, engagement_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @engagement_instance = engagement_instance
+                    end
+
+                    def engagement
+                        @engagement_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.EngagementInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class EngagementListResponse < InstanceListResource
+                    # @param [Array<EngagementInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @engagement_instance = payload.body[key].map do |data|
+                        EngagementInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def engagement_instance
+                          @instance
+                      end
+                  end
+
                 class EngagementPage < Page
                     ##
                     # Initialize the EngagementPage
@@ -246,6 +429,7 @@ module Twilio
                     # @return [EngagementPage] EngagementPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -265,6 +449,66 @@ module Twilio
                         '<Twilio.Studio.V1.EngagementPage>'
                     end
                 end
+
+                class EngagementPageMetadata < PageMetadata
+                    attr_reader :engagement_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @engagement_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @engagement_page << EngagementListResponse.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
+                        @engagement_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Studio::V1PageMetadata>';
+                    end
+                end
+                class EngagementListResponse < InstanceListResource
+
+                    # @param [Array<EngagementInstance>] 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
+                      @engagement = data_list.map do |data|
+                        EngagementInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def engagement
+                        @engagement
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class EngagementInstance < InstanceResource
                     ##
                     # Initialize the EngagementInstance
@@ -278,6 +522,7 @@ module Twilio
                     def initialize(version, payload , flow_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],

data/lib/twilio-ruby/rest/studio/v1/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.V1.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::V1PageMetadata>';
+                    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'],