[CHAT-2693] Add flag reports api (#91)

* [CHAT-2693] Add flag reports api

* Fix typing

* Mark methods as private

* Include user_id in _query_flag_reports

* Fix lint

* Remove user_id from query_flag_reports

Author: Eugene

stream_chat/async_chat/client.py

@@ -190,6 +190,30 @@ async def unflag_user(self, target_id: str, **options: Any) -> StreamResponse:
         data = {"target_user_id": target_id, **options}
         return await self.post("moderation/unflag", data=data)
 
+    async def _query_flag_reports(self, **options: Any) -> StreamResponse:
+        """
+        Note: Do not use this.
+        It is present for internal usage only.
+        This function can, and will, break and/or be removed at any point in time.
+        """
+        data = {"filter_conditions": options}
+        return await self.post("moderation/reports", data=data)
+
+    async def _review_flag_report(
+        self, report_id: int, review_result: str, user_id: str, **details: Any
+    ) -> StreamResponse:
+        """
+        Note: Do not use this.
+        It is present for internal usage only.
+        This function can, and will, break and/or be removed at any point in time.
+        """
+        data = {
+            "review_result": review_result,
+            "user_id": user_id,
+            "review_details": details,
+        }
+        return await self.patch(f"moderation/reports/{report_id}", data=data)
+
     async def mute_user(
         self, target_id: str, user_id: str, **options: Any
     ) -> StreamResponse:

stream_chat/client.py

@@ -175,6 +175,30 @@ def unflag_user(self, target_id: str, **options: Any) -> StreamResponse:
         data = {"target_user_id": target_id, **options}
         return self.post("moderation/unflag", data=data)
 
+    def _query_flag_reports(self, **options: Any) -> StreamResponse:
+        """
+        Note: Do not use this.
+        It is present for internal usage only.
+        This function can, and will, break and/or be removed at any point in time.
+        """
+        data = {"filter_conditions": options}
+        return self.post("moderation/reports", data=data)
+
+    def _review_flag_report(
+        self, report_id: int, review_result: str, user_id: str, **details: Any
+    ) -> StreamResponse:
+        """
+        Note: Do not use this.
+        It is present for internal usage only.
+        This function can, and will, break and/or be removed at any point in time.
+        """
+        data = {
+            "review_result": review_result,
+            "user_id": user_id,
+            "review_details": details,
+        }
+        return self.patch(f"moderation/reports/{report_id}", data=data)
+
     def mute_user(self, target_id: str, user_id: str, **options: Any) -> StreamResponse:
         data = {"target_id": target_id, "user_id": user_id, **options}
         return self.post("moderation/mute", data=data)

stream_chat/tests/async_chat/test_client.py

@@ -363,6 +363,46 @@ async def test_unflag_message(
         await client.flag_message(msg_id, user_id=server_user["id"])
         await client.unflag_message(msg_id, user_id=server_user["id"])
 
+    @pytest.mark.asyncio
+    async def test_query_flag_reports(
+        self, client: StreamChatAsync, channel, random_user, server_user: Dict
+    ):
+        msg = {"id": str(uuid.uuid4()), "text": "hello world"}
+        await channel.send_message(msg, random_user["id"])
+        await client.flag_message(msg["id"], user_id=server_user["id"])
+
+        response = await client._query_flag_reports(message_id=msg["id"])
+        report = response["flag_reports"][0]
+
+        assert report["id"] is not None
+        assert report["message"]["id"] == msg["id"]
+        assert report["message"]["text"] == msg["text"]
+
+    @pytest.mark.asyncio
+    async def test_review_flag_report(
+        self, client: StreamChatAsync, channel, random_user, server_user: Dict
+    ):
+        msg = {"id": str(uuid.uuid4()), "text": "hello world"}
+        await channel.send_message(msg, random_user["id"])
+        await client.flag_message(msg["id"], user_id=server_user["id"])
+
+        response = await client._query_flag_reports(message_id=msg["id"])
+        response = await client._review_flag_report(
+            report_id=response["flag_reports"][0]["id"],
+            review_result="reviewed",
+            user_id=random_user["id"],
+            custom="reason_a",
+        )
+
+        report = response["flag_report"]
+
+        assert report["id"] is not None
+        assert report["message"]["id"] == msg["id"]
+        assert report["message"]["text"] == msg["text"]
+
+        assert report["review_result"] == "reviewed"
+        assert report["review_details"]["custom"] == "reason_a"
+
     @pytest.mark.asyncio
     async def test_query_users_young_hobbits(
         self, client: StreamChatAsync, fellowship_of_the_ring

stream_chat/tests/test_client.py

@@ -213,6 +213,46 @@ def test_unflag_user(self, client: StreamChat, random_user, server_user: Dict):
         client.flag_user(random_user["id"], user_id=server_user["id"])
         client.unflag_user(random_user["id"], user_id=server_user["id"])
 
+    def test_query_flag_reports(
+        self, client: StreamChat, channel, random_user, server_user: Dict
+    ):
+        msg = {"id": str(uuid.uuid4()), "text": "hello world"}
+        channel.send_message(msg, random_user["id"])
+        client.flag_message(msg["id"], user_id=server_user["id"])
+
+        response = client._query_flag_reports(message_id=msg["id"])
+
+        assert len(response["flag_reports"]) == 1
+
+        report = response["flag_reports"][0]
+        assert report["id"] is not None
+        assert report["message"]["id"] == msg["id"]
+        assert report["message"]["text"] == msg["text"]
+
+    def test_review_flag_report(
+        self, client: StreamChat, channel, random_user, server_user: Dict
+    ):
+        msg = {"id": str(uuid.uuid4()), "text": "hello world"}
+        channel.send_message(msg, random_user["id"])
+        client.flag_message(msg["id"], user_id=server_user["id"])
+
+        response = client._query_flag_reports(message_id=msg["id"])
+        response = client._review_flag_report(
+            report_id=response["flag_reports"][0]["id"],
+            review_result="reviewed",
+            user_id=random_user["id"],
+            custom="reason_a",
+        )
+
+        report = response["flag_report"]
+
+        assert report["id"] is not None
+        assert report["message"]["id"] == msg["id"]
+        assert report["message"]["text"] == msg["text"]
+
+        assert report["review_result"] == "reviewed"
+        assert report["review_details"]["custom"] == "reason_a"
+
     def test_mark_all_read(self, client: StreamChat, random_user: Dict):
         client.mark_all_read(random_user["id"])