feat: add support for show_deleted_message in getMessage (#161)

Author: guerinoni

stream_chat/async_chat/client.py

@@ -332,8 +332,8 @@ async def update_message_partial(
     async def delete_message(self, message_id: str, **options: Any) -> StreamResponse:
         return await self.delete(f"messages/{message_id}", options)
 
-    async def get_message(self, message_id: str) -> StreamResponse:
-        return await self.get(f"messages/{message_id}")
+    async def get_message(self, message_id: str, **options: Any) -> StreamResponse:
+        return await self.get(f"messages/{message_id}", options)
 
     async def query_users(
         self, filter_conditions: Dict, sort: List[Dict] = None, **options: Any

stream_chat/base/client.py

@@ -516,10 +516,11 @@ def delete_message(
 
     @abc.abstractmethod
     def get_message(
-        self, message_id: str
+        self, message_id: str, **options: Any
     ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
         """
         Returns a single message.
+        If the msg is deleted and you want to retrieve it, you can pass the show_deleted_message.
         """
         pass
 

stream_chat/client.py

@@ -321,8 +321,8 @@ def update_message_partial(
     def delete_message(self, message_id: str, **options: Any) -> StreamResponse:
         return self.delete(f"messages/{message_id}", options)
 
-    def get_message(self, message_id: str) -> StreamResponse:
-        return self.get(f"messages/{message_id}")
+    def get_message(self, message_id: str, **options: Any) -> StreamResponse:
+        return self.get(f"messages/{message_id}", options)
 
     def query_users(
         self, filter_conditions: Dict, sort: List[Dict] = None, **options: Any

stream_chat/tests/test_client.py

@@ -78,6 +78,8 @@ def test_get_message(self, client: StreamChat, channel, random_user: Dict):
         msg_id = str(uuid.uuid4())
         channel.send_message({"id": msg_id, "text": "helloworld"}, random_user["id"])
         client.delete_message(msg_id)
+        msg = client.get_message(msg_id, show_deleted_message=True)
+        assert msg["message"]["text"] == "helloworld"
         msg_id = str(uuid.uuid4())
         channel.send_message({"id": msg_id, "text": "helloworld"}, random_user["id"])
         message = client.get_message(msg_id)