twilio-ruby 6.8.0 → 7.10.7

data/lib/twilio-ruby/rest/conversations/v1/service/conversation/participant.rb

@@ -21,12 +21,14 @@ module Twilio
                 class ConversationContext < InstanceContext
 
                      class ParticipantList < ListResource
+                
                     ##
                     # Initialize the ParticipantList
                     # @param [Version] version Version that contains the resource
                     # @return [ParticipantList] ParticipantList
                     def initialize(version, chat_service_sid: nil, conversation_sid: nil)
                         super(version)
+                        
                         # Path Solution
                         @solution = { chat_service_sid: chat_service_sid, conversation_sid: conversation_sid }
                         @uri = "/Services/#{@solution[:chat_service_sid]}/Conversations/#{@solution[:conversation_sid]}/Participants"
@@ -45,15 +47,15 @@ module Twilio
                     # @param [ServiceConversationParticipantEnumWebhookEnabledType] x_twilio_webhook_enabled The X-Twilio-Webhook-Enabled HTTP request header
                     # @return [ParticipantInstance] Created ParticipantInstance
                     def create(
-                        identity: :unset, 
-                        messaging_binding_address: :unset, 
-                        messaging_binding_proxy_address: :unset, 
-                        date_created: :unset, 
-                        date_updated: :unset, 
-                        attributes: :unset, 
-                        messaging_binding_projected_address: :unset, 
-                        role_sid: :unset, 
-                        x_twilio_webhook_enabled: :unset
+                      identity: :unset, 
+                      messaging_binding_address: :unset, 
+                      messaging_binding_proxy_address: :unset, 
+                      date_created: :unset, 
+                      date_updated: :unset, 
+                      attributes: :unset, 
+                      messaging_binding_projected_address: :unset, 
+                      role_sid: :unset, 
+                      x_twilio_webhook_enabled: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -67,7 +69,12 @@ module Twilio
                             'RoleSid' => role_sid,
                         })
 
-                        headers = Twilio::Values.of({ 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
+                        
+                        
+                        
+                        
+                        
                         payload = @version.create('POST', @uri, data: data, headers: headers)
                         ParticipantInstance.new(
                             @version,
@@ -77,6 +84,62 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Create the ParticipantInstanceMetadata
+                    # @param [String] identity A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters.
+                    # @param [String] messaging_binding_address The address of the participant's device, e.g. a phone or WhatsApp number. Together with the Proxy address, this determines a participant uniquely. This field (with `proxy_address`) is only null when the participant is interacting from an SDK endpoint (see the `identity` field).
+                    # @param [String] messaging_binding_proxy_address The address of the Twilio phone number (or WhatsApp number) that the participant is in contact with. This field, together with participant address, is only null when the participant is interacting from an SDK endpoint (see the `identity` field).
+                    # @param [Time] date_created The date on which this resource was created.
+                    # @param [Time] date_updated The date on which this resource was last updated.
+                    # @param [String] attributes An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.  **Note** that if the attributes are not set `{}` will be returned.
+                    # @param [String] messaging_binding_projected_address The address of the Twilio phone number that is used in Group MMS.
+                    # @param [String] role_sid The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant.
+                    # @param [ServiceConversationParticipantEnumWebhookEnabledType] x_twilio_webhook_enabled The X-Twilio-Webhook-Enabled HTTP request header
+                    # @return [ParticipantInstance] Created ParticipantInstance
+                    def create_with_metadata(
+                      identity: :unset, 
+                      messaging_binding_address: :unset, 
+                      messaging_binding_proxy_address: :unset, 
+                      date_created: :unset, 
+                      date_updated: :unset, 
+                      attributes: :unset, 
+                      messaging_binding_projected_address: :unset, 
+                      role_sid: :unset, 
+                      x_twilio_webhook_enabled: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'Identity' => identity,
+                            'MessagingBinding.Address' => messaging_binding_address,
+                            'MessagingBinding.ProxyAddress' => messaging_binding_proxy_address,
+                            'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
+                            'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
+                            'Attributes' => attributes,
+                            'MessagingBinding.ProjectedAddress' => messaging_binding_projected_address,
+                            'RoleSid' => role_sid,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.create_with_metadata('POST', @uri, data: data, headers: headers)
+                        participant_instance = ParticipantInstance.new(
+                            @version,
+                            response.body,
+                            chat_service_sid: @solution[:chat_service_sid],
+                            conversation_sid: @solution[:conversation_sid],
+                        )
+                        ParticipantInstanceMetadata.new(
+                            @version,
+                            participant_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                 
                     ##
                     # Lists ParticipantInstance records from the API as a list.
@@ -113,7 +176,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 ParticipantPageMetadata 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)
+
+                        ParticipantPageMetadata.new(@version, response, @solution, limits[:limit])
                     end
 
                     ##
@@ -125,9 +214,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
 
                     ##
@@ -137,14 +230,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 ParticipantInstance
-                    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)
 
                         ParticipantPage.new(@version, response, @solution)
                     end
@@ -181,6 +277,7 @@ module Twilio
                     # @return [ParticipantContext] ParticipantContext
                     def initialize(version, chat_service_sid, conversation_sid, sid)
                         super(version)
+                        
 
                         # Path Solution
                         @solution = { chat_service_sid: chat_service_sid, conversation_sid: conversation_sid, sid: sid,  }
@@ -193,19 +290,51 @@ module Twilio
                     # @param [ServiceConversationParticipantEnumWebhookEnabledType] x_twilio_webhook_enabled The X-Twilio-Webhook-Enabled HTTP request header
                     # @return [Boolean] True if delete succeeds, false otherwise
                     def delete(
-                        x_twilio_webhook_enabled: :unset
+                      x_twilio_webhook_enabled: :unset
                     )
 
-                        headers = Twilio::Values.of({ 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
+                        
+                        
+                        
+
                         @version.delete('DELETE', @uri, headers: headers)
                     end
 
+                    ##
+                    # Delete the ParticipantInstanceMetadata
+                    # @param [ServiceConversationParticipantEnumWebhookEnabledType] x_twilio_webhook_enabled The X-Twilio-Webhook-Enabled HTTP request header
+                    # @return [Boolean] True if delete succeeds, false otherwise
+                    def delete_with_metadata(
+                      x_twilio_webhook_enabled: :unset
+                    )
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
+                        
+                        
+                        
+                          response = @version.delete_with_metadata('DELETE', @uri, headers: headers)
+                          participant_instance = ParticipantInstance.new(
+                              @version,
+                              response.body,
+                              account_sid: @solution[:account_sid],
+                              sid: @solution[:sid],
+                          )
+                          ParticipantInstanceMetadata.new(@version, participant_instance, response.headers, response.status_code)
+                    end
+
                     ##
                     # Fetch the ParticipantInstance
                     # @return [ParticipantInstance] Fetched ParticipantInstance
                     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)
                         ParticipantInstance.new(
                             @version,
                             payload,
@@ -215,6 +344,33 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Fetch the ParticipantInstanceMetadata
+                    # @return [ParticipantInstance] Fetched ParticipantInstance
+                    def fetch_with_metadata
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.fetch_with_metadata('GET', @uri, headers: headers)
+                        participant_instance = ParticipantInstance.new(
+                            @version,
+                            response.body,
+                            chat_service_sid: @solution[:chat_service_sid],
+                            conversation_sid: @solution[:conversation_sid],
+                            sid: @solution[:sid],
+                        )
+                        ParticipantInstanceMetadata.new(
+                            @version,
+                            participant_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
                     ##
                     # Update the ParticipantInstance
                     # @param [Time] date_created The date on which this resource was created.
@@ -229,16 +385,16 @@ module Twilio
                     # @param [ServiceConversationParticipantEnumWebhookEnabledType] x_twilio_webhook_enabled The X-Twilio-Webhook-Enabled HTTP request header
                     # @return [ParticipantInstance] Updated ParticipantInstance
                     def update(
-                        date_created: :unset, 
-                        date_updated: :unset, 
-                        identity: :unset, 
-                        attributes: :unset, 
-                        role_sid: :unset, 
-                        messaging_binding_proxy_address: :unset, 
-                        messaging_binding_projected_address: :unset, 
-                        last_read_message_index: :unset, 
-                        last_read_timestamp: :unset, 
-                        x_twilio_webhook_enabled: :unset
+                      date_created: :unset, 
+                      date_updated: :unset, 
+                      identity: :unset, 
+                      attributes: :unset, 
+                      role_sid: :unset, 
+                      messaging_binding_proxy_address: :unset, 
+                      messaging_binding_projected_address: :unset, 
+                      last_read_message_index: :unset, 
+                      last_read_timestamp: :unset, 
+                      x_twilio_webhook_enabled: :unset
                     )
 
                         data = Twilio::Values.of({
@@ -253,7 +409,12 @@ module Twilio
                             'LastReadTimestamp' => last_read_timestamp,
                         })
 
-                        headers = Twilio::Values.of({ 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
+                        
+                        
+                        
+                        
+                        
                         payload = @version.update('POST', @uri, data: data, headers: headers)
                         ParticipantInstance.new(
                             @version,
@@ -264,6 +425,66 @@ module Twilio
                         )
                     end
 
+                    ##
+                    # Update the ParticipantInstanceMetadata
+                    # @param [Time] date_created The date on which this resource was created.
+                    # @param [Time] date_updated The date on which this resource was last updated.
+                    # @param [String] identity A unique string identifier for the conversation participant as [Conversation User](https://www.twilio.com/docs/conversations/api/user-resource). This parameter is non-null if (and only if) the participant is using the [Conversation SDK](https://www.twilio.com/docs/conversations/sdk-overview) to communicate. Limited to 256 characters.
+                    # @param [String] attributes An optional string metadata field you can use to store any data you wish. The string value must contain structurally valid JSON if specified.  **Note** that if the attributes are not set `{}` will be returned.
+                    # @param [String] role_sid The SID of a conversation-level [Role](https://www.twilio.com/docs/conversations/api/role-resource) to assign to the participant.
+                    # @param [String] messaging_binding_proxy_address The address of the Twilio phone number that the participant is in contact with. 'null' value will remove it.
+                    # @param [String] messaging_binding_projected_address The address of the Twilio phone number that is used in Group MMS. 'null' value will remove it.
+                    # @param [String] last_read_message_index Index of last “read” message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for the Participant.
+                    # @param [String] last_read_timestamp Timestamp of last “read” message in the [Conversation](https://www.twilio.com/docs/conversations/api/conversation-resource) for the Participant.
+                    # @param [ServiceConversationParticipantEnumWebhookEnabledType] x_twilio_webhook_enabled The X-Twilio-Webhook-Enabled HTTP request header
+                    # @return [ParticipantInstance] Updated ParticipantInstance
+                    def update_with_metadata(
+                      date_created: :unset, 
+                      date_updated: :unset, 
+                      identity: :unset, 
+                      attributes: :unset, 
+                      role_sid: :unset, 
+                      messaging_binding_proxy_address: :unset, 
+                      messaging_binding_projected_address: :unset, 
+                      last_read_message_index: :unset, 
+                      last_read_timestamp: :unset, 
+                      x_twilio_webhook_enabled: :unset
+                    )
+
+                        data = Twilio::Values.of({
+                            'DateCreated' => Twilio.serialize_iso8601_datetime(date_created),
+                            'DateUpdated' => Twilio.serialize_iso8601_datetime(date_updated),
+                            'Identity' => identity,
+                            'Attributes' => attributes,
+                            'RoleSid' => role_sid,
+                            'MessagingBinding.ProxyAddress' => messaging_binding_proxy_address,
+                            'MessagingBinding.ProjectedAddress' => messaging_binding_projected_address,
+                            'LastReadMessageIndex' => last_read_message_index,
+                            'LastReadTimestamp' => last_read_timestamp,
+                        })
+
+                        headers = Twilio::Values.of({'Content-Type' => 'application/x-www-form-urlencoded', 'X-Twilio-Webhook-Enabled' => x_twilio_webhook_enabled, })
+                        
+                        
+                        
+                        
+                        
+                        response = @version.update_with_metadata('POST', @uri, data: data, headers: headers)
+                        participant_instance = ParticipantInstance.new(
+                            @version,
+                            response.body,
+                            chat_service_sid: @solution[:chat_service_sid],
+                            conversation_sid: @solution[:conversation_sid],
+                            sid: @solution[:sid],
+                        )
+                        ParticipantInstanceMetadata.new(
+                            @version,
+                            participant_instance,
+                            response.headers,
+                            response.status_code
+                        )
+                    end
+
 
                     ##
                     # Provide a user friendly representation
@@ -280,6 +501,53 @@ module Twilio
                     end
                 end
 
+                class ParticipantInstanceMetadata <  InstanceResourceMetadata
+                    ##
+                    # Initializes a new ParticipantInstanceMetadata.
+                    # @param [Version] version Version that contains the resource
+                    # @param [}ParticipantInstance] participant_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 [ParticipantInstanceMetadata] The initialized instance with metadata.
+                    def initialize(version, participant_instance, headers, status_code)
+                        super(version, headers, status_code)
+                        @participant_instance = participant_instance
+                    end
+
+                    def participant
+                        @participant_instance
+                    end
+
+                    def headers
+                        @headers
+                    end
+
+                    def status_code
+                        @status_code
+                    end
+
+                    def to_s
+                      "<Twilio.Api.V2010.ParticipantInstanceMetadata status=#{@status_code}>"
+                    end
+                end
+
+                class ParticipantListResponse < InstanceListResource
+                    # @param [Array<ParticipantInstance>] instance
+                    # @param [Hash{String => Object}] headers
+                    # @param [Integer] status_code
+                    def initialize(version, payload, key)
+                       @participant_instance = payload.body[key].map do |data|
+                        ParticipantInstance.new(version, data)
+                       end
+                       @headers = payload.headers
+                       @status_code = payload.status_code
+                    end
+
+                      def participant_instance
+                          @instance
+                      end
+                  end
+
                 class ParticipantPage < Page
                     ##
                     # Initialize the ParticipantPage
@@ -289,6 +557,7 @@ module Twilio
                     # @return [ParticipantPage] ParticipantPage
                     def initialize(version, response, solution)
                         super(version, response)
+                        
 
                         # Path Solution
                         @solution = solution
@@ -308,6 +577,66 @@ module Twilio
                         '<Twilio.Conversations.V1.ParticipantPage>'
                     end
                 end
+
+                class ParticipantPageMetadata < PageMetadata
+                    attr_reader :participant_page
+
+                    def initialize(version, response, solution, limit)
+                        super(version, response)
+                        @participant_page = []
+                        @limit = limit
+                        key = get_key(response.body)
+                        records = 0
+                        while( limit != :unset && records < limit )
+                            @participant_page << ParticipantListResponse.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
+                        @participant_page.each do |record|
+                          yield record
+                        end
+                    end
+
+                    def to_s
+                      '<Twilio::REST::Conversations::V1PageMetadata>';
+                    end
+                end
+                class ParticipantListResponse < InstanceListResource
+
+                    # @param [Array<ParticipantInstance>] 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
+                      @participant = data_list.map do |data|
+                        ParticipantInstance.new(version, data)
+                      end
+                      @headers = payload.headers
+                      @status_code = payload.status_code
+                    end
+
+                    def participant
+                        @participant
+                    end
+
+                    def headers
+                      @headers
+                    end
+
+                    def status_code
+                      @status_code
+                    end
+                end
+
                 class ParticipantInstance < InstanceResource
                     ##
                     # Initialize the ParticipantInstance
@@ -321,6 +650,7 @@ module Twilio
                     def initialize(version, payload , chat_service_sid: nil, conversation_sid: nil, sid: nil)
                         super(version)
                         
+                        
                         # Marshaled Properties
                         @properties = { 
                             'account_sid' => payload['account_sid'],
@@ -437,7 +767,7 @@ module Twilio
                     # @param [ServiceConversationParticipantEnumWebhookEnabledType] x_twilio_webhook_enabled The X-Twilio-Webhook-Enabled HTTP request header
                     # @return [Boolean] True if delete succeeds, false otherwise
                     def delete(
-                        x_twilio_webhook_enabled: :unset
+                      x_twilio_webhook_enabled: :unset
                     )
 
                         context.delete(
@@ -467,16 +797,16 @@ module Twilio
                     # @param [ServiceConversationParticipantEnumWebhookEnabledType] x_twilio_webhook_enabled The X-Twilio-Webhook-Enabled HTTP request header
                     # @return [ParticipantInstance] Updated ParticipantInstance
                     def update(
-                        date_created: :unset, 
-                        date_updated: :unset, 
-                        identity: :unset, 
-                        attributes: :unset, 
-                        role_sid: :unset, 
-                        messaging_binding_proxy_address: :unset, 
-                        messaging_binding_projected_address: :unset, 
-                        last_read_message_index: :unset, 
-                        last_read_timestamp: :unset, 
-                        x_twilio_webhook_enabled: :unset
+                      date_created: :unset, 
+                      date_updated: :unset, 
+                      identity: :unset, 
+                      attributes: :unset, 
+                      role_sid: :unset, 
+                      messaging_binding_proxy_address: :unset, 
+                      messaging_binding_projected_address: :unset, 
+                      last_read_message_index: :unset, 
+                      last_read_timestamp: :unset, 
+                      x_twilio_webhook_enabled: :unset
                     )
 
                         context.update(