stream-chat 4.14.0__py3-none-any.whl → 4.16.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.14.0"
+__version__ = "4.16.0"
 __maintainer__ = "Tommaso Barbugli"
 __email__ = "support@getstream.io"
 __status__ = "Production"

stream_chat/async_chat/client.py

@@ -26,6 +26,7 @@ from stream_chat.types.segment import (
     QuerySegmentTargetsOptions,
     SegmentData,
     SegmentType,
+    SegmentUpdatableFields,
 )
 
 if sys.version_info >= (3, 8):
@@ -335,6 +336,18 @@ class StreamChatAsync(StreamChatInterface, AsyncContextManager):
     async def get_message(self, message_id: str, **options: Any) -> StreamResponse:
         return await self.get(f"messages/{message_id}", options)
 
+    async def query_message_history(
+        self, filter: Dict = None, sort: List[Dict] = None, **options: Any
+    ) -> StreamResponse:
+        params = options.copy()
+        params.update(
+            {
+                "filter": filter,
+                "sort": self.normalize_sort(sort),
+            }
+        )
+        return await self.post("messages/history", data=params)
+
     async def query_users(
         self, filter_conditions: Dict, sort: List[Dict] = None, **options: Any
     ) -> StreamResponse:
@@ -591,7 +604,7 @@ class StreamChatAsync(StreamChatInterface, AsyncContextManager):
         return await self.post("segments/query", data=payload)
 
     async def update_segment(
-        self, segment_id: str, data: SegmentData
+        self, segment_id: str, data: SegmentUpdatableFields
     ) -> StreamResponse:
         return await self.put(f"segments/{segment_id}", data=data)
 

stream_chat/async_chat/segment.py

@@ -2,7 +2,11 @@ from typing import Dict, List, Optional
 
 from stream_chat.base.segment import SegmentInterface
 from stream_chat.types.base import SortParam
-from stream_chat.types.segment import QuerySegmentTargetsOptions, SegmentData
+from stream_chat.types.segment import (
+    QuerySegmentTargetsOptions,
+    SegmentData,
+    SegmentUpdatableFields,
+)
 from stream_chat.types.stream_response import StreamResponse
 
 
@@ -24,24 +28,29 @@ class Segment(SegmentInterface):
         return state
 
     async def get(self) -> StreamResponse:
+        super().verify_segment_id()
         return await self.client.get_segment(segment_id=self.segment_id)  # type: ignore
 
-    async def update(self, data: SegmentData) -> StreamResponse:
+    async def update(self, data: SegmentUpdatableFields) -> StreamResponse:
+        super().verify_segment_id()
         return await self.client.update_segment(  # type: ignore
             segment_id=self.segment_id, data=data
         )
 
     async def delete(self) -> StreamResponse:
+        super().verify_segment_id()
         return await self.client.delete_segment(  # type: ignore
             segment_id=self.segment_id
         )
 
     async def target_exists(self, target_id: str) -> StreamResponse:
+        super().verify_segment_id()
         return await self.client.segment_target_exists(  # type: ignore
             segment_id=self.segment_id, target_id=target_id
         )
 
     async def add_targets(self, target_ids: list) -> StreamResponse:
+        super().verify_segment_id()
         return await self.client.add_segment_targets(  # type: ignore
             segment_id=self.segment_id, target_ids=target_ids
         )
@@ -52,6 +61,7 @@ class Segment(SegmentInterface):
         sort: Optional[List[SortParam]] = None,
         options: Optional[QuerySegmentTargetsOptions] = None,
     ) -> StreamResponse:
+        super().verify_segment_id()
         return await self.client.query_segment_targets(  # type: ignore
             segment_id=self.segment_id,
             filter_conditions=filter_conditions,
@@ -60,6 +70,7 @@ class Segment(SegmentInterface):
         )
 
     async def remove_targets(self, target_ids: list) -> StreamResponse:
+        super().verify_segment_id()
         return await self.client.remove_segment_targets(  # type: ignore
             segment_id=self.segment_id, target_ids=target_ids
         )

stream_chat/base/client.py

@@ -14,6 +14,7 @@ from stream_chat.types.segment import (
     QuerySegmentTargetsOptions,
     SegmentData,
     SegmentType,
+    SegmentUpdatableFields,
 )
 
 if sys.version_info >= (3, 8):
@@ -524,6 +525,15 @@ class StreamChatInterface(abc.ABC):
         """
         pass
 
+    @abc.abstractmethod
+    def query_message_history(
+        self, filter: Dict = None, sort: List[Dict] = None, **options: Any
+    ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
+        """
+        Queries message history.
+        """
+        pass
+
     @abc.abstractmethod
     def query_users(
         self, filter_conditions: Dict, sort: List[Dict] = None, **options: Any
@@ -982,7 +992,7 @@ class StreamChatInterface(abc.ABC):
 
     @abc.abstractmethod
     def update_segment(
-        self, segment_id: str, data: SegmentData
+        self, segment_id: str, data: SegmentUpdatableFields
     ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
         """
         Update a segment by id

stream_chat/base/segment.py

@@ -7,6 +7,7 @@ from stream_chat.types.segment import (
     QuerySegmentTargetsOptions,
     SegmentData,
     SegmentType,
+    SegmentUpdatableFields,
 )
 from stream_chat.types.stream_response import StreamResponse
 
@@ -36,7 +37,7 @@ class SegmentInterface(abc.ABC):
 
     @abc.abstractmethod
     def update(
-        self, data: SegmentData
+        self, data: SegmentUpdatableFields
     ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
         pass
 
@@ -70,3 +71,10 @@ class SegmentInterface(abc.ABC):
         self, target_ids: List[str]
     ) -> Union[StreamResponse, Awaitable[StreamResponse]]:
         pass
+
+    def verify_segment_id(self) -> None:
+        if not self.segment_id:
+            raise ValueError(
+                "Segment id is missing. Either create the segment using segment.create() "
+                "or set the id during instantiation - segment = Segment(segment_id=segment_id)"
+            )

stream_chat/client.py

@@ -15,6 +15,7 @@ from stream_chat.types.segment import (
     QuerySegmentTargetsOptions,
     SegmentData,
     SegmentType,
+    SegmentUpdatableFields,
 )
 
 if sys.version_info >= (3, 8):
@@ -324,6 +325,13 @@ class StreamChat(StreamChatInterface):
     def get_message(self, message_id: str, **options: Any) -> StreamResponse:
         return self.get(f"messages/{message_id}", options)
 
+    def query_message_history(
+        self, filter: Dict = None, sort: List[Dict] = None, **options: Any
+    ) -> StreamResponse:
+        params = options.copy()
+        params.update({"filter": filter, "sort": self.normalize_sort(sort)})
+        return self.post("messages/history", data=params)
+
     def query_users(
         self, filter_conditions: Dict, sort: List[Dict] = None, **options: Any
     ) -> StreamResponse:
@@ -569,7 +577,9 @@ class StreamChat(StreamChatInterface):
             payload.update(cast(dict, options))
         return self.post("segments/query", data=payload)
 
-    def update_segment(self, segment_id: str, data: SegmentData) -> StreamResponse:
+    def update_segment(
+        self, segment_id: str, data: SegmentUpdatableFields
+    ) -> StreamResponse:
         return self.put(f"segments/{segment_id}", data=data)
 
     def delete_segment(self, segment_id: str) -> StreamResponse:

stream_chat/segment.py

@@ -2,7 +2,11 @@ from typing import Dict, List, Optional
 
 from stream_chat.base.segment import SegmentInterface
 from stream_chat.types.base import SortParam
-from stream_chat.types.segment import QuerySegmentTargetsOptions, SegmentData
+from stream_chat.types.segment import (
+    QuerySegmentTargetsOptions,
+    SegmentData,
+    SegmentUpdatableFields,
+)
 from stream_chat.types.stream_response import StreamResponse
 
 
@@ -24,22 +28,27 @@ class Segment(SegmentInterface):
         return state  # type: ignore
 
     def get(self) -> StreamResponse:
+        super().verify_segment_id()
         return self.client.get_segment(segment_id=self.segment_id)  # type: ignore
 
-    def update(self, data: SegmentData) -> StreamResponse:
+    def update(self, data: SegmentUpdatableFields) -> StreamResponse:
+        super().verify_segment_id()
         return self.client.update_segment(  # type: ignore
             segment_id=self.segment_id, data=data
         )
 
     def delete(self) -> StreamResponse:
+        super().verify_segment_id()
         return self.client.delete_segment(segment_id=self.segment_id)  # type: ignore
 
     def target_exists(self, target_id: str) -> StreamResponse:
+        super().verify_segment_id()
         return self.client.segment_target_exists(  # type: ignore
             segment_id=self.segment_id, target_id=target_id
         )
 
     def add_targets(self, target_ids: list) -> StreamResponse:
+        super().verify_segment_id()
         return self.client.add_segment_targets(  # type: ignore
             segment_id=self.segment_id, target_ids=target_ids
         )
@@ -50,6 +59,7 @@ class Segment(SegmentInterface):
         sort: Optional[List[SortParam]] = None,
         options: Optional[QuerySegmentTargetsOptions] = None,
     ) -> StreamResponse:
+        super().verify_segment_id()
         return self.client.query_segment_targets(  # type: ignore
             segment_id=self.segment_id,
             sort=sort,
@@ -58,6 +68,7 @@ class Segment(SegmentInterface):
         )
 
     def remove_targets(self, target_ids: list) -> StreamResponse:
+        super().verify_segment_id()
         return self.client.remove_segment_targets(  # type: ignore
             segment_id=self.segment_id, target_ids=target_ids
         )

stream_chat/types/segment.py

@@ -23,9 +23,9 @@ class SegmentType(Enum):
     USER = "user"
 
 
-class SegmentData(TypedDict, total=False):
+class SegmentUpdatableFields(TypedDict, total=False):
     """
-    Represents the data structure for a segment.
+    Represents the updatable data structure for a segment.
 
     Parameters:
         name: The name of the segment.
@@ -38,6 +38,19 @@ class SegmentData(TypedDict, total=False):
     filter: Optional[Dict]
 
 
+class SegmentData(SegmentUpdatableFields, total=False):
+    """
+    Represents the data structure for a segment.
+
+    Parameters:
+        all_users: Whether to target all users.
+        all_sender_channels: Whether to target all sender channels.
+    """
+
+    all_users: Optional[bool]
+    all_sender_channels: Optional[bool]
+
+
 class QuerySegmentsOptions(Pager, total=False):
     pass
 

{stream_chat-4.14.0.dist-info → stream_chat-4.16.0.dist-info}/METADATA

@@ -1,13 +1,13 @@
 Metadata-Version: 2.1
 Name: stream-chat
-Version: 4.14.0
+Version: 4.16.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.14.0
+Project-URL: Release Notes, https://github.com/GetStream/stream-chat-python/releases/tag/v4.16.0
 Classifier: Intended Audience :: Developers
 Classifier: Intended Audience :: System Administrators
 Classifier: Operating System :: OS Independent
@@ -39,7 +39,7 @@ Requires-Dist: pytest-cov ; extra == 'ci'
 Requires-Dist: mypy ; extra == 'ci'
 Requires-Dist: types-requests ; extra == 'ci'
 Provides-Extra: test
-Requires-Dist: pytest ; extra == 'test'
+Requires-Dist: pytest (==8.1.1) ; extra == 'test'
 Requires-Dist: pytest-asyncio (<=0.21.1) ; extra == 'test'
 
 # Official Python SDK for [Stream Chat](https://getstream.io/chat/)

{stream_chat-4.14.0.dist-info → stream_chat-4.16.0.dist-info}/RECORD

@@ -1,29 +1,29 @@
 stream_chat/__init__.py,sha256=xYQuC8xcPLJxJnFWzaNaO-sVUc7IJZYe13OIPRaDBEA,116
-stream_chat/__pkg__.py,sha256=-YPJmzfj3VZRmIMKjYn4lhLy3K6i6W4d4rsHnhURvAk,206
+stream_chat/__pkg__.py,sha256=-SVKUWD2I2HdMWMOyVsa9eNsgpWCHMZDPnE7qENOTv0,206
 stream_chat/campaign.py,sha256=Z7bBo2rGMs02JkA1k9_206J0spcSLecjdhQuRnrc2Eo,2156
 stream_chat/channel.py,sha256=SxlnRM8U1yo_k3wDBC4azz3_LDRPclDV5GBmGCfqB8U,7766
-stream_chat/client.py,sha256=yASGeuFs7simQToM1p4Hy0W2vyze2QMt3PfY2eBbFng,28455
+stream_chat/client.py,sha256=hQ_O_9iRfGQotU79ZB94RhRoKEsHe6ETq69WAgq6SRo,28807
 stream_chat/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-stream_chat/segment.py,sha256=NqfjNZ9i7RYlLkBohxu3-Xc4l3zo3fnKoh2IMLAUrmo,2387
+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=yn9P7u1lJdwoCVw9gKotadq6s1rdYSM_wnxhdaZpnTI,8124
-stream_chat/async_chat/client.py,sha256=J3ySKtNWVK1SjzdkbT9G40dfeovQuAMSKQvcbKmQKF0,30633
-stream_chat/async_chat/segment.py,sha256=qo8waiGTkRRDRFYKW0GtrcSgnBkDF-PVSaCSBEnYwAg,2473
+stream_chat/async_chat/client.py,sha256=_Dz-FA8KLNpCpczuW5bxWBkn35JeaRRFCqm6QiTdwGk,31052
+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=G6thUgND74z0gvI-N3b3vEsrDJ-D4MrAfW2um_E4x9w,13788
-stream_chat/base/client.py,sha256=m5PY7o0ZxG11mUDVXcj-ZmKcN1LA0Gl3NpYyakGp7Hg,40815
+stream_chat/base/client.py,sha256=0INKl5FkF9o7xZyxy2BDn2fTOSrN3eOkEPG66GiRAH0,41114
 stream_chat/base/exceptions.py,sha256=eh1qW5d6zjUrlgsHNEBebAr0jVH2UupZ06w8sp2cseI,819
-stream_chat/base/segment.py,sha256=_UONbdF4OjaGIpsTzyY5UN_U3VAfuZyAkJnS3RfsM5k,2020
+stream_chat/base/segment.py,sha256=X82DX8Y-cERJ1OvF2tz9iIM4CBNW6tx8HGaTEXBva9I,2364
 stream_chat/types/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 stream_chat/types/base.py,sha256=JKlOxQVPvMClTo0ev63Ya-K-dX-98j95qSE-KKzziEE,858
 stream_chat/types/campaign.py,sha256=JyAn08oMaEsxPSqmVTdsfJK4xpfErPQV7Xr7zLQm99M,2293
 stream_chat/types/rate_limit.py,sha256=v3Z4Ur0yoEdFLiHa1CNABEej2nxPlHQ6Bpy2XxW-TYQ,165
-stream_chat/types/segment.py,sha256=28pLB3ADJcF8Y5PZHa4VACVg-ySxM94nCiP4uNvQxfs,925
+stream_chat/types/segment.py,sha256=KzOi5N-VzLfj0m4zeZ9U_29ey9dxDtewtcNv9g4Aums,1273
 stream_chat/types/stream_response.py,sha256=jWKPrOU7u6dZ2SyOK53uQCXTstrL1HshO9fA7R6Bt_A,2391
-stream_chat-4.14.0.dist-info/LICENSE,sha256=H66SBDuPWSRHzKPEdyjAk3C0THQRcGPfqqve4naQuu0,14424
-stream_chat-4.14.0.dist-info/METADATA,sha256=xdu2AiW3Qk29xwtYGX3ax8xuZ8s15j8DhJ2KsxrQxXI,7395
-stream_chat-4.14.0.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
-stream_chat-4.14.0.dist-info/top_level.txt,sha256=26uTfg4bWcEaFrVKlzGGgfONH1p5DDe21G07EKfYSvo,12
-stream_chat-4.14.0.dist-info/RECORD,,
+stream_chat-4.16.0.dist-info/LICENSE,sha256=H66SBDuPWSRHzKPEdyjAk3C0THQRcGPfqqve4naQuu0,14424
+stream_chat-4.16.0.dist-info/METADATA,sha256=r_oAMWV8d6qT7Ihrst3DFCS01nad7-piG5JMcSBqbh4,7405
+stream_chat-4.16.0.dist-info/WHEEL,sha256=G16H4A3IeoQmnOrYV4ueZGKSjhipXx8zc8nu9FGlvMA,92
+stream_chat-4.16.0.dist-info/top_level.txt,sha256=26uTfg4bWcEaFrVKlzGGgfONH1p5DDe21G07EKfYSvo,12
+stream_chat-4.16.0.dist-info/RECORD,,