[CHA-1230] support delivery receipts

Author: Rafael Marinho

stream_chat/async_chat/channel.py

@@ -138,6 +138,9 @@ async def mark_read(self, user_id: str, **data: Any) -> StreamResponse:
     async def mark_unread(self, user_id: str, **data: Any) -> StreamResponse:
         payload = add_user_id(data, user_id)
         return await self.client.post(f"{self.url}/unread", data=payload)
+    
+    async def mark_delivered(self, data: Dict[str, Any]) -> Optional[StreamResponse]:
+        return await self.client.post("channels/delivered", data=data)
 
     async def get_replies(self, parent_id: str, **options: Any) -> StreamResponse:
         return await self.client.get(f"messages/{parent_id}/replies", params=options)

stream_chat/base/channel.py

@@ -292,6 +292,18 @@ def mark_unread(
         :return: The server response
         """
         pass
+    
+    @abc.abstractmethod
+    def mark_delivered(
+        self, data: Dict[str, Any]
+    ) -> Union[StreamResponse, Awaitable[StreamResponse], None]:
+        """
+        Send the mark delivered event for this user, only works if the `delivery_receipts` setting is enabled
+
+        :param data: MarkDeliveredOptions containing channel_delivered_message and other optional fields
+        :return: The server response or None if delivery receipts are disabled
+        """
+        pass
 
     @abc.abstractmethod
     def get_replies(

stream_chat/channel.py

@@ -139,6 +139,9 @@ def mark_read(self, user_id: str, **data: Any) -> StreamResponse:
     def mark_unread(self, user_id: str, **data: Any) -> StreamResponse:
         payload = add_user_id(data, user_id)
         return self.client.post(f"{self.url}/unread", data=payload)
+    
+    def mark_delivered(self, data: Dict[str, Any]) -> Optional[StreamResponse]:
+       return self.client.post("channels/delivered", data=data)
 
     def get_replies(self, parent_id: str, **options: Any) -> StreamResponse:
         return self.client.get(f"messages/{parent_id}/replies", params=options)

stream_chat/tests/test_channel.py

@@ -202,6 +202,25 @@ def test_mark_unread(self, channel: Channel, random_user: Dict):
         channel.send_message({"id": msg_id, "text": "helloworld"}, random_user["id"])
         response = channel.mark_unread(random_user["id"], message_id=msg_id)
         assert "duration" in response
+    
+    def test_mark_delivered(self, channel: Channel, random_user: Dict):
+        delivery_data = {
+            "channel_delivered_message": {channel.id: "test-message-id"},
+            "user_id": random_user["id"]
+        }
+        
+        response = channel.mark_delivered(delivery_data)
+        assert response is not None
+        
+        delivery_data_with_options = {
+            "channel_delivered_message": {channel.id: "test-message-id-2"},
+            "user_id": random_user["id"],
+            "client_id": "test-client",
+            "connection_id": "test-connection"
+        }
+        
+        response = channel.mark_delivered(delivery_data_with_options)
+        assert response is not None
 
     def test_get_messages(self, channel: Channel, random_user: Dict):
         msg_id = str(uuid.uuid4())