feat: add custom event endpoint (#103)

Author: peterdeme

stream_chat/async_chat/client.py

@@ -591,6 +591,9 @@ async def get_export_channel_status(self, task_id: str) -> StreamResponse:
     async def get_task(self, task_id: str) -> StreamResponse:
         return await self.get(f"tasks/{task_id}")
 
+    async def send_user_custom_event(self, user_id: str, event: Dict) -> StreamResponse:
+        return await self.post(f"users/{user_id}/event", data={"event": event})
+
     async def close(self) -> None:
         await self.session.close()
 

stream_chat/base/client.py

@@ -857,6 +857,15 @@ def get_task(
         """
         pass
 
+    @abc.abstractmethod
+    def send_user_custom_event(
+        self, user_id: str, event: Dict
+    ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
+        """
+        Allows you to send custom events to a connected user.
+        """
+        pass
+
     #####################
     #  Private methods  #
     #####################

stream_chat/client.py

@@ -560,3 +560,6 @@ def get_export_channel_status(self, task_id: str) -> StreamResponse:
 
     def get_task(self, task_id: str) -> StreamResponse:
         return self.get(f"tasks/{task_id}")
+
+    def send_user_custom_event(self, user_id: str, event: Dict) -> StreamResponse:
+        return self.post(f"users/{user_id}/event", data={"event": event})

stream_chat/tests/async_chat/test_client.py

@@ -701,6 +701,13 @@ async def test_delete_channels(self, client: StreamChatAsync, channel: Channel):
 
         pytest.fail("task did not succeed")
 
+    async def test_send_user_custom_event(
+        self, client: StreamChatAsync, random_user: Dict
+    ):
+        await client.send_user_custom_event(
+            random_user["id"], {"type": "friendship_request", "text": "testtext"}
+        )
+
     @pytest.mark.asyncio
     async def test_stream_response(self, client: StreamChatAsync):
         resp = await client.get_app_settings()

stream_chat/tests/test_client.py

@@ -657,6 +657,11 @@ def test_delete_channels(self, client: StreamChat, channel: Channel):
 
         pytest.fail("task did not succeed")
 
+    def test_send_user_custom_event(self, client: StreamChat, random_user: Dict):
+        client.send_user_custom_event(
+            random_user["id"], {"type": "friendship_request", "text": "testtext"}
+        )
+
     def test_stream_response_contains_metadata(self, client: StreamChat):
         resp = client.get_app_settings()