stream-chat 4.19.0__py3-none-any.whl → 4.20.0__py3-none-any.whl

stream_chat/__pkg__.py

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

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/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/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.dist-info → stream_chat-4.20.0.dist-info}/METADATA

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: stream-chat
-Version: 4.19.0
+Version: 4.20.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.20.0
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
 Classifier: Operating System :: OS Independent

{stream_chat-4.19.0.dist-info → stream_chat-4.20.0.dist-info}/RECORD

@@ -1,18 +1,18 @@
 stream_chat/__init__.py,sha256=xYQuC8xcPLJxJnFWzaNaO-sVUc7IJZYe13OIPRaDBEA,116
-stream_chat/__pkg__.py,sha256=wO-i7ei-UR40ccvRBP_bEnEmY_H5yrmrmKqJ3hny_N8,206
+stream_chat/__pkg__.py,sha256=nbHjOBD-I3lllsWmxhsUEY33qm1NUrxGwdeYQsEJczw,206
 stream_chat/campaign.py,sha256=Z7bBo2rGMs02JkA1k9_206J0spcSLecjdhQuRnrc2Eo,2156
-stream_chat/channel.py,sha256=FMX7dWHvljwE4P7d0fofL3dN63ihuWLvYHbFLSoIL4M,7952
+stream_chat/channel.py,sha256=LnlHx1CDDnoxq4fCQ2sqlgjzIgPt0MmtKqph4240Uyg,9489
 stream_chat/client.py,sha256=sQH_Jkg06saa6BLtjXEwcu51GKdxtlqPDMGBL8jQAvY,29003
 stream_chat/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 stream_chat/segment.py,sha256=MD1de83rVsaqxcyPy8wTXDudFjxz5Mvr70z4pTkW3P0,2691
 stream_chat/async_chat/__init__.py,sha256=V6x7yDCdXbP3vMuSan6Xm7RE_njZUvflImqOxfKRt4Y,67
 stream_chat/async_chat/campaign.py,sha256=Bc3iHZigxserUycZK4wDuXU0wXVH2G6fIDiYNVYPkeE,1885
-stream_chat/async_chat/channel.py,sha256=vJRyMV0p19a911sOdRQtkzoJxlwQxRpA7_aWkCfcRlk,8322
+stream_chat/async_chat/channel.py,sha256=-n-Fq3MrIhGy6DzyHwOOHijSrDAudUxV0Akp-OVn7V0,9919
 stream_chat/async_chat/client.py,sha256=X7GagduhTgwac8jugISwZxdBAijq14rTzaKWiTS9Q8k,31260
 stream_chat/async_chat/segment.py,sha256=G_YEwW2SXIE7huTW3Zu_rim2XkYcuFNYekLZZGDjFkA,2777
 stream_chat/base/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 stream_chat/base/campaign.py,sha256=dAVkTYyirEpgyOPn8JyDebNMKeJu02vTuqgmPvdQoWU,1449
-stream_chat/base/channel.py,sha256=Jwsfuac2aU6Yipc8ven8U77iTGXIyA1b2WqZfIjB0SA,14315
+stream_chat/base/channel.py,sha256=bK-bbDFQquPskktXSu3UspWgOsH0EOBaHVpyg4vt2VM,15684
 stream_chat/base/client.py,sha256=LRV136gyHAt4LkVct8wvpWYwQJ6hvcB4swz3b6AKihA,41387
 stream_chat/base/exceptions.py,sha256=eh1qW5d6zjUrlgsHNEBebAr0jVH2UupZ06w8sp2cseI,819
 stream_chat/base/segment.py,sha256=X82DX8Y-cERJ1OvF2tz9iIM4CBNW6tx8HGaTEXBva9I,2364
@@ -22,8 +22,8 @@ stream_chat/types/campaign.py,sha256=JyAn08oMaEsxPSqmVTdsfJK4xpfErPQV7Xr7zLQm99M
 stream_chat/types/rate_limit.py,sha256=v3Z4Ur0yoEdFLiHa1CNABEej2nxPlHQ6Bpy2XxW-TYQ,165
 stream_chat/types/segment.py,sha256=KzOi5N-VzLfj0m4zeZ9U_29ey9dxDtewtcNv9g4Aums,1273
 stream_chat/types/stream_response.py,sha256=jWKPrOU7u6dZ2SyOK53uQCXTstrL1HshO9fA7R6Bt_A,2391
-stream_chat-4.19.0.dist-info/LICENSE,sha256=H66SBDuPWSRHzKPEdyjAk3C0THQRcGPfqqve4naQuu0,14424
-stream_chat-4.19.0.dist-info/METADATA,sha256=LBWGUmMdeUP5TV7VqmaPH9RKQUSAYQ0EW0aO5raCiUI,7405
-stream_chat-4.19.0.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-stream_chat-4.19.0.dist-info/top_level.txt,sha256=26uTfg4bWcEaFrVKlzGGgfONH1p5DDe21G07EKfYSvo,12
-stream_chat-4.19.0.dist-info/RECORD,,
+stream_chat-4.20.0.dist-info/LICENSE,sha256=H66SBDuPWSRHzKPEdyjAk3C0THQRcGPfqqve4naQuu0,14424
+stream_chat-4.20.0.dist-info/METADATA,sha256=XDxL4bY8cfSqKSslYRxkpV4eaMeR3ifTVvmZE2ORum4,7405
+stream_chat-4.20.0.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
+stream_chat-4.20.0.dist-info/top_level.txt,sha256=26uTfg4bWcEaFrVKlzGGgfONH1p5DDe21G07EKfYSvo,12
+stream_chat-4.20.0.dist-info/RECORD,,