stream-chat 4.19.0__tar.gz → 4.21.0__tar.gz

{stream-chat-4.19.0/stream_chat.egg-info → stream-chat-4.21.0}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: stream-chat
-Version: 4.19.0
+Version: 4.21.0
 Summary: Client for Stream Chat.
 Home-page: https://github.com/GetStream/stream-chat-python
 Author: Tommaso Barbugli
 Author-email: support@getstream.io
 Project-URL: Bug Tracker, https://github.com/GetStream/stream-chat-python/issues
 Project-URL: Documentation, https://getstream.io/activity-feeds/docs/python/?language=python
-Project-URL: Release Notes, https://github.com/GetStream/stream-chat-python/releases/tag/v4.19.0
+Project-URL: Release Notes, https://github.com/GetStream/stream-chat-python/releases/tag/v4.21.0
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
 Classifier: Operating System :: OS Independent

{stream-chat-4.19.0 → stream-chat-4.21.0}/stream_chat/__pkg__.py

@@ -1,6 +1,6 @@
 __author__ = "Tommaso Barbugli"
 __copyright__ = "Copyright 2019-2022, Stream.io, Inc"
-__version__ = "4.19.0"
+__version__ = "4.21.0"
 __maintainer__ = "Tommaso Barbugli"
 __email__ = "support@getstream.io"
 __status__ = "Production"

{stream-chat-4.19.0 → stream-chat-4.21.0}/stream_chat/async_chat/channel.py

@@ -2,6 +2,7 @@ import json
 from typing import Any, Dict, Iterable, List, Union
 
 from stream_chat.base.channel import ChannelInterface, add_user_id
+from stream_chat.base.exceptions import StreamChannelException
 from stream_chat.types.stream_response import StreamResponse
 
 
@@ -209,3 +210,40 @@ class Channel(ChannelInterface):
             "channel_cid": self.cid,
         }
         return await self.client.post("moderation/unmute/channel", data=params)
+
+    async def pin(self, user_id: str) -> StreamResponse:
+        if not user_id:
+            raise StreamChannelException("user_id must not be empty")
+
+        payload = {"set": {"pinned": True}}
+        return await self.client.patch(f"{self.url}/member/{user_id}", data=payload)
+
+    async def unpin(self, user_id: str) -> StreamResponse:
+        if not user_id:
+            raise StreamChannelException("user_id must not be empty")
+
+        payload = {"set": {"pinned": False}}
+        return await self.client.patch(f"{self.url}/member/{user_id}", data=payload)
+
+    async def archive(self, user_id: str) -> StreamResponse:
+        if not user_id:
+            raise StreamChannelException("user_id must not be empty")
+
+        payload = {"set": {"archived": True}}
+        return await self.client.patch(f"{self.url}/member/{user_id}", data=payload)
+
+    async def unarchive(self, user_id: str) -> StreamResponse:
+        if not user_id:
+            raise StreamChannelException("user_id must not be empty")
+
+        payload = {"set": {"archived": False}}
+        return await self.client.patch(f"{self.url}/member/{user_id}", data=payload)
+
+    async def update_member_partial(
+        self, user_id: str, to_set: Dict = None, to_unset: Iterable[str] = None
+    ) -> StreamResponse:
+        if not user_id:
+            raise StreamChannelException("user_id must not be empty")
+
+        payload = {"set": to_set or {}, "unset": to_unset or []}
+        return await self.client.patch(f"{self.url}/member/{user_id}", data=payload)

{stream-chat-4.19.0 → stream-chat-4.21.0}/stream_chat/base/channel.py

@@ -440,6 +440,52 @@ class ChannelInterface(abc.ABC):
         """
         pass
 
+    @abc.abstractmethod
+    def pin(self, user_id: str) -> Union[StreamResponse, Awaitable[StreamResponse]]:
+        """
+        Pins a channel
+        Allows a user to pin the channel (only for themselves)
+        """
+        pass
+
+    @abc.abstractmethod
+    def unpin(self, user_id: str) -> Union[StreamResponse, Awaitable[StreamResponse]]:
+        """
+        Unpins a channel
+        Allows a user to unpin the channel (only for themselves)
+        """
+        pass
+
+    @abc.abstractmethod
+    def archive(self, user_id: str) -> Union[StreamResponse, Awaitable[StreamResponse]]:
+        """
+        Pins a channel
+        Allows a user to archive the channel (only for themselves)
+        """
+        pass
+
+    @abc.abstractmethod
+    def unarchive(
+        self, user_id: str
+    ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
+        """
+        Unpins a channel
+        Allows a user to unpin the channel (only for themselves)
+        """
+        pass
+
+    @abc.abstractmethod
+    def update_member_partial(
+        self, user_id: str, to_set: Dict = None, to_unset: Iterable[str] = None
+    ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
+        """
+        Update channel member partially
+
+        :param to_set: a dictionary of key/value pairs to set or to override
+        :param to_unset: a list of keys to clear
+        """
+        pass
+
 
 def add_user_id(payload: Dict, user_id: str) -> Dict:
     return {**payload, "user": {"id": user_id}}

{stream-chat-4.19.0 → stream-chat-4.21.0}/stream_chat/channel.py

@@ -2,6 +2,7 @@ import json
 from typing import Any, Dict, Iterable, List, Union
 
 from stream_chat.base.channel import ChannelInterface, add_user_id
+from stream_chat.base.exceptions import StreamChannelException
 from stream_chat.types.stream_response import StreamResponse
 
 
@@ -210,3 +211,40 @@ class Channel(ChannelInterface):
             "channel_cid": self.cid,
         }
         return self.client.post("moderation/unmute/channel", data=params)
+
+    def pin(self, user_id: str) -> StreamResponse:
+        if not user_id:
+            raise StreamChannelException("user_id must not be empty")
+
+        payload = {"set": {"pinned": True}}
+        return self.client.patch(f"{self.url}/member/{user_id}", data=payload)
+
+    def unpin(self, user_id: str) -> StreamResponse:
+        if not user_id:
+            raise StreamChannelException("user_id must not be empty")
+
+        payload = {"set": {"pinned": False}}
+        return self.client.patch(f"{self.url}/member/{user_id}", data=payload)
+
+    def archive(self, user_id: str) -> StreamResponse:
+        if not user_id:
+            raise StreamChannelException("user_id must not be empty")
+
+        payload = {"set": {"archived": True}}
+        return self.client.patch(f"{self.url}/member/{user_id}", data=payload)
+
+    def unarchive(self, user_id: str) -> StreamResponse:
+        if not user_id:
+            raise StreamChannelException("user_id must not be empty")
+
+        payload = {"set": {"archived": False}}
+        return self.client.patch(f"{self.url}/member/{user_id}", data=payload)
+
+    def update_member_partial(
+        self, user_id: str, to_set: Dict = None, to_unset: Iterable[str] = None
+    ) -> StreamResponse:
+        if not user_id:
+            raise StreamChannelException("user_id must not be empty")
+
+        payload = {"set": to_set or {}, "unset": to_unset or []}
+        return self.client.patch(f"{self.url}/member/{user_id}", data=payload)

{stream-chat-4.19.0 → stream-chat-4.21.0/stream_chat.egg-info}/PKG-INFO

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: stream-chat
-Version: 4.19.0
+Version: 4.21.0
 Summary: Client for Stream Chat.
 Home-page: https://github.com/GetStream/stream-chat-python
 Author: Tommaso Barbugli
 Author-email: support@getstream.io
 Project-URL: Bug Tracker, https://github.com/GetStream/stream-chat-python/issues
 Project-URL: Documentation, https://getstream.io/activity-feeds/docs/python/?language=python
-Project-URL: Release Notes, https://github.com/GetStream/stream-chat-python/releases/tag/v4.19.0
+Project-URL: Release Notes, https://github.com/GetStream/stream-chat-python/releases/tag/v4.21.0
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
 Classifier: Operating System :: OS Independent