feat: add truncate options [CHAT-2621] (#86)

Co-authored-by: peterdeme <[email protected]>

Author: peterdeme

PULL_REQUEST_TEMPLATE.md .github/PULL_REQUEST_TEMPLATE.mdPULL_REQUEST_TEMPLATE.md renamed to .github/PULL_REQUEST_TEMPLATE.md

@@ -62,4 +62,5 @@ pip-selfcheck.json
 .vscode
 *,cover
 .eggs
+.env
 .envrc

.gitignore

@@ -139,13 +139,14 @@ async def delete(self):
         """
         return await self.client.delete(self.url)
 
-    async def truncate(self):
+    async def truncate(self, **options):
         """
         Removes all messages from the channel
 
+        :param options: the query options, check docs on https://getstream.io/chat/docs/python/channel_delete/?language=python#truncating-a-channel
         :return: The server response
         """
-        return await self.client.post(f"{self.url}/truncate")
+        return await self.client.post(f"{self.url}/truncate", data=options)
 
     async def add_members(self, members, message=None):
         """

stream_chat/async_chat/channel.py

@@ -139,10 +139,11 @@ def delete(self):
         pass
 
     @abc.abstractmethod
-    def truncate(self):
+    def truncate(self, **options):
         """
         Removes all messages from the channel
 
+        :param options: the query options, check docs on https://getstream.io/chat/docs/python/channel_delete/?language=python#truncating-a-channel
         :return: The server response
         """
         pass

stream_chat/base/channel.py

@@ -137,13 +137,14 @@ def delete(self):
         """
         return self.client.delete(self.url)
 
-    def truncate(self):
+    def truncate(self, **options):
         """
         Removes all messages from the channel
 
+        :param options: the query options, check docs on https://getstream.io/chat/docs/python/channel_delete/?language=python#truncating-a-channel
         :return: The server response
         """
-        return self.client.post(f"{self.url}/truncate")
+        return self.client.post(f"{self.url}/truncate", data=options)
 
     def add_members(self, members, message=None):
         """

stream_chat/channel.py

@@ -95,6 +95,17 @@ async def test_truncate(self, event_loop, channel):
         response = await channel.truncate()
         assert "channel" in response
 
+    @pytest.mark.asyncio
+    async def test_truncate_with_options(self, event_loop, channel, random_user):
+        response = await channel.truncate(
+            skip_push=True,
+            message={
+                "text": "Truncating channel.",
+                "user_id": random_user["id"],
+            },
+        )
+        assert "channel" in response
+
     @pytest.mark.asyncio
     async def test_add_members(self, event_loop, channel, random_user):
         response = await channel.remove_members([random_user["id"]])

stream_chat/tests/async_chat/test_channel.py

@@ -82,6 +82,16 @@ def test_truncate(self, channel):
         response = channel.truncate()
         assert "channel" in response
 
+    def test_truncate_with_options(self, channel, random_user):
+        response = channel.truncate(
+            skip_push=True,
+            message={
+                "text": "Truncating channel.",
+                "user_id": random_user["id"],
+            },
+        )
+        assert "channel" in response
+
     def test_add_members(self, channel, random_user):
         response = channel.remove_members([random_user["id"]])
         assert len(response["members"]) == 0