twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/proxy/v1/service/session/interaction.rb

@@ -21,12 +21,14 @@ module Twilio
                 class SessionContext < InstanceContext
 
                      class InteractionList < ListResource
+                
                     ##
                     # Initialize the InteractionList
                     # @param [Version] version Version that contains the resource
                     # @return [InteractionList] InteractionList
                     def initialize(version, service_sid: nil, session_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { service_sid: service_sid, session_sid: session_sid }
                         @uri = "/Services/#{@solution[:service_sid]}/Sessions/#{@solution[:session_sid]}/Interactions"
@@ -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 InteractionPageMetadata 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)
+
+                        InteractionPageMetadata.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 InteractionInstance
-                    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)
 
                         InteractionPage.new(@version, response, @solution)
                     end
@@ -126,8 +161,6 @@ module Twilio
                 end
 
 
-                ##
-                #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
                 class InteractionContext < InstanceContext
                     ##
                     # Initialize the InteractionContext
@@ -138,6 +171,7 @@ module Twilio
                     # @return [InteractionContext] InteractionContext
                     def initialize(version, service_sid, session_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { service_sid: service_sid, session_sid: session_sid, sid: sid,  }
@@ -150,7 +184,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 InteractionInstanceMetadata
+                    # @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)
+                          interaction_instance = InteractionInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          InteractionInstanceMetadata.new(@version, interaction_instance, response.headers, response.status_code)
                     end
 
                     ##
@@ -158,7 +216,13 @@ module Twilio
                     # @return [InteractionInstance] Fetched InteractionInstance
                     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)
                         InteractionInstance.new(
                             @version,
                             payload,
@@ -168,6 +232,33 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the InteractionInstanceMetadata
+                    # @return [InteractionInstance] Fetched InteractionInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        interaction_instance = InteractionInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            session_sid: @solution[:session_sid],
+                            sid: @solution[:sid],
+                        )
+                        InteractionInstanceMetadata.new(
+                            @version,
+                            interaction_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -184,6 +275,53 @@ module Twilio
                     end
                 end
 
+                class InteractionInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new InteractionInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}InteractionInstance] interaction_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 [InteractionInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, interaction_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @interaction_instance = interaction_instance
+                    end
+
+                    def interaction
+                        @interaction_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.InteractionInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class InteractionListResponse < InstanceListResource
+                    # @param [Array<InteractionInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @interaction_instance = payload.body[key].map do |data|
+                        InteractionInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def interaction_instance
+                          @instance
+                      end
+                  end
+
                 class InteractionPage < Page
                     ##
                     # Initialize the InteractionPage
@@ -193,6 +331,7 @@ module Twilio
                     # @return [InteractionPage] InteractionPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -212,6 +351,66 @@ module Twilio
                         '<Twilio.Proxy.V1.InteractionPage>'
                     end
                 end
+
+                class InteractionPageMetadata < PageMetadata
+                    attr_reader :interaction_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @interaction_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @interaction_page << InteractionListResponse.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
+                        @interaction_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Proxy::V1PageMetadata>';
+                    end
+                end
+                class InteractionListResponse < InstanceListResource
+
+                    # @param [Array<InteractionInstance>] 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
+                      @interaction = data_list.map do |data|
+                        InteractionInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def interaction
+                        @interaction
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class InteractionInstance < InstanceResource
                     ##
                     # Initialize the InteractionInstance
@@ -225,6 +424,7 @@ module Twilio
                     def initialize(version, payload , service_sid: nil, session_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],
@@ -307,7 +507,7 @@ module Twilio
                     end
                     
                     ##
-                    # @return [String] The SID of the inbound resource; either the [Call](https://www.twilio.com/docs/voice/api/call-resource) or [Message](https://www.twilio.com/docs/sms/api/message.
+                    # @return [String] The SID of the inbound resource; either the [Call](https://www.twilio.com/docs/voice/api/call-resource) or [Message](https://www.twilio.com/docs/sms/api/message-resource).
                     def inbound_resource_sid
                         @properties['inbound_resource_sid']
                     end

data/lib/twilio-ruby/rest/proxy/v1/service/session/participant/message_interaction.rb

@@ -22,12 +22,14 @@ module Twilio
                 class ParticipantContext < InstanceContext
 
                      class MessageInteractionList < ListResource
+                
                     ##
                     # Initialize the MessageInteractionList
                     # @param [Version] version Version that contains the resource
                     # @return [MessageInteractionList] MessageInteractionList
                     def initialize(version, service_sid: nil, session_sid: nil, participant_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { service_sid: service_sid, session_sid: session_sid, participant_sid: participant_sid }
                         @uri = "/Services/#{@solution[:service_sid]}/Sessions/#{@solution[:session_sid]}/Participants/#{@solution[:participant_sid]}/MessageInteractions"
@@ -39,8 +41,8 @@ module Twilio
                     # @param [Array[String]] media_url Reserved. Not currently supported.
                     # @return [MessageInteractionInstance] Created MessageInteractionInstance
                     def create(
-                        body: :unset, 
-                        media_url: :unset
+                      body: :unset, 
+                      media_url: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -48,7 +50,13 @@ module Twilio
                             'MediaUrl' => Twilio.serialize_list(media_url) { |e| e },
                         })
 
-                        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)
                         MessageInteractionInstance.new(
                             @version,
                             payload,
@@ -58,6 +66,43 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the MessageInteractionInstanceMetadata
+                    # @param [String] body The message to send to the participant
+                    # @param [Array[String]] media_url Reserved. Not currently supported.
+                    # @return [MessageInteractionInstance] Created MessageInteractionInstance
+                    def create_with_metadata(
+                      body: :unset, 
+                      media_url: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Body' => body,
+                            'MediaUrl' => Twilio.serialize_list(media_url) { |e| e },
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        message_interaction_instance = MessageInteractionInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            session_sid: @solution[:session_sid],
+                            participant_sid: @solution[:participant_sid],
+                        )
+                        MessageInteractionInstanceMetadata.new(
+                            @version,
+                            message_interaction_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists MessageInteractionInstance records from the API as a list.
@@ -94,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 MessageInteractionPageMetadata 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)
+
+                        MessageInteractionPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -106,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
 
                     ##
@@ -118,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 MessageInteractionInstance
-                    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)
 
                         MessageInteractionPage.new(@version, response, @solution)
                     end
@@ -152,8 +230,6 @@ module Twilio
                 end
 
 
-                ##
-                #PLEASE NOTE that this class contains beta products that are subject to change. Use them with caution.
                 class MessageInteractionContext < InstanceContext
                     ##
                     # Initialize the MessageInteractionContext
@@ -165,6 +241,7 @@ module Twilio
                     # @return [MessageInteractionContext] MessageInteractionContext
                     def initialize(version, service_sid, session_sid, participant_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { service_sid: service_sid, session_sid: session_sid, participant_sid: participant_sid, sid: sid,  }
@@ -177,7 +254,13 @@ module Twilio
                     # @return [MessageInteractionInstance] Fetched MessageInteractionInstance
                     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)
                         MessageInteractionInstance.new(
                             @version,
                             payload,
@@ -188,6 +271,34 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the MessageInteractionInstanceMetadata
+                    # @return [MessageInteractionInstance] Fetched MessageInteractionInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        message_interaction_instance = MessageInteractionInstance.new(
+                            @version,
+                            response.body,
+                            service_sid: @solution[:service_sid],
+                            session_sid: @solution[:session_sid],
+                            participant_sid: @solution[:participant_sid],
+                            sid: @solution[:sid],
+                        )
+                        MessageInteractionInstanceMetadata.new(
+                            @version,
+                            message_interaction_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -204,6 +315,53 @@ module Twilio
                     end
                 end
 
+                class MessageInteractionInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new MessageInteractionInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}MessageInteractionInstance] message_interaction_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 [MessageInteractionInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, message_interaction_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @message_interaction_instance = message_interaction_instance
+                    end
+
+                    def message_interaction
+                        @message_interaction_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.MessageInteractionInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class MessageInteractionListResponse < InstanceListResource
+                    # @param [Array<MessageInteractionInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @message_interaction_instance = payload.body[key].map do |data|
+                        MessageInteractionInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def message_interaction_instance
+                          @instance
+                      end
+                  end
+
                 class MessageInteractionPage < Page
                     ##
                     # Initialize the MessageInteractionPage
@@ -213,6 +371,7 @@ module Twilio
                     # @return [MessageInteractionPage] MessageInteractionPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -232,6 +391,66 @@ module Twilio
                         '<Twilio.Proxy.V1.MessageInteractionPage>'
                     end
                 end
+
+                class MessageInteractionPageMetadata < PageMetadata
+                    attr_reader :message_interaction_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @message_interaction_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @message_interaction_page << MessageInteractionListResponse.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
+                        @message_interaction_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Proxy::V1PageMetadata>';
+                    end
+                end
+                class MessageInteractionListResponse < InstanceListResource
+
+                    # @param [Array<MessageInteractionInstance>] 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
+                      @message_interaction = data_list.map do |data|
+                        MessageInteractionInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def message_interaction
+                        @message_interaction
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class MessageInteractionInstance < InstanceResource
                     ##
                     # Initialize the MessageInteractionInstance
@@ -245,6 +464,7 @@ module Twilio
                     def initialize(version, payload , service_sid: nil, session_sid: nil, participant_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'sid' => payload['sid'],