symphony_bdk_python 2.10.dev0__py3-none-any.whl → 2.11.0__py3-none-any.whl

symphony/bdk/core/service/session/session_service.py

@@ -6,31 +6,25 @@ from symphony.bdk.gen.pod_model.user_v2 import UserV2
 
 
 class OboSessionService:
-    """Service interface exposing OBO-enabled endpoints to get user session information.
-    """
+    """Service interface exposing OBO-enabled endpoints to get user session information."""
 
-    def __init__(self, session_api: SessionApi,
-                 auth_session: AuthSession,
-                 retry_config: BdkRetryConfig):
+    def __init__(
+        self, session_api: SessionApi, auth_session: AuthSession, retry_config: BdkRetryConfig
+    ):
         self._session_api = session_api
         self._auth_session = auth_session
         self._retry_config = retry_config
 
     @retry
-    async def get_session(
-            self
-    ) -> UserV2:
+    async def get_session(self) -> UserV2:
         """
         Retrieves the {@link UserV2} session from the pod using an {@link AuthSession} holder.
 
         Returns: User session info
         """
-        params = {
-            'session_token': await self._auth_session.session_token
-        }
+        params = {"session_token": await self._auth_session.session_token}
         return await self._session_api.v2_sessioninfo_get(**params)
 
 
 class SessionService(OboSessionService):
-    """Service class for exposing endpoints to get user session information.
-    """
+    """Service class for exposing endpoints to get user session information."""

symphony/bdk/core/service/signal/signal_service.py

@@ -27,7 +27,9 @@ class OboSignalService:
     * Subscribe or unsubscribe a signal
     """
 
-    def __init__(self, signals_api: SignalsApi, auth_session: AuthSession, retry_config: BdkRetryConfig):
+    def __init__(
+        self, signals_api: SignalsApi, auth_session: AuthSession, retry_config: BdkRetryConfig
+    ):
         self._signals_api = signals_api
         self._auth_session = auth_session
         self._retry_config = retry_config
@@ -45,10 +47,15 @@ class OboSignalService:
         """
 
         return await self._signals_api.v1_signals_list_get(
-            skip=skip, limit=limit, session_token=await self._auth_session.session_token,
-            key_manager_token=await self._auth_session.key_manager_token)
-
-    async def list_all_signals(self, chunk_size: int = 50, max_number: int = None) -> AsyncGenerator[Signal, None]:
+            skip=skip,
+            limit=limit,
+            session_token=await self._auth_session.session_token,
+            key_manager_token=await self._auth_session.key_manager_token,
+        )
+
+    async def list_all_signals(
+        self, chunk_size: int = 50, max_number: int = None
+    ) -> AsyncGenerator[Signal, None]:
         """Lists all signals on behalf of the user. The response includes signals that the user has created and
         public signals to which they have subscribed.
 
@@ -67,7 +74,7 @@ class OboSignalService:
 
     @retry
     async def get_signal(self, signal_id: str) -> Signal:
-        """ Gets details about the specified signal.
+        """Gets details about the specified signal.
 
         See: 'Get signal <https://developers.symphony.com/restapi/reference/get-signal>'_
 
@@ -76,12 +83,14 @@ class OboSignalService:
         """
 
         return await self._signals_api.v1_signals_id_get_get(
-            id=signal_id, session_token=await self._auth_session.session_token,
-            key_manager_token=await self._auth_session.key_manager_token)
+            id=signal_id,
+            session_token=await self._auth_session.session_token,
+            key_manager_token=await self._auth_session.key_manager_token,
+        )
 
     @retry
     async def create_signal(self, signal: BaseSignal) -> Signal:
-        """ Creates a new Signal.
+        """Creates a new Signal.
 
         See: 'Create signal <https://developers.symphony.com/restapi/reference/create-signal>'_
 
@@ -90,12 +99,14 @@ class OboSignalService:
         """
 
         return await self._signals_api.v1_signals_create_post(
-            signal=signal, session_token=await self._auth_session.session_token,
-            key_manager_token=await self._auth_session.key_manager_token)
+            signal=signal,
+            session_token=await self._auth_session.session_token,
+            key_manager_token=await self._auth_session.key_manager_token,
+        )
 
     @retry
     async def update_signal(self, signal_id: str, signal: BaseSignal) -> Signal:
-        """ Updates an existing Signal.
+        """Updates an existing Signal.
 
         See: 'Update signal <https://developers.symphony.com/restapi/reference/update-signal>'_
 
@@ -105,26 +116,32 @@ class OboSignalService:
         """
 
         return await self._signals_api.v1_signals_id_update_post(
-            id=signal_id, signal=signal, session_token=await self._auth_session.session_token,
-            key_manager_token=await self._auth_session.key_manager_token)
+            id=signal_id,
+            signal=signal,
+            session_token=await self._auth_session.session_token,
+            key_manager_token=await self._auth_session.key_manager_token,
+        )
 
     @retry
     async def delete_signal(self, signal_id: str) -> None:
-        """ Deletes an existing Signal.
+        """Deletes an existing Signal.
 
         See: 'Delete signal <https://developers.symphony.com/restapi/reference/delete-signal>'_
 
         :param signal_id: The Id of the existing signal to be deleted.
         """
 
-        await self._signals_api.v1_signals_id_delete_post(id=signal_id,
-                                                          session_token=await self._auth_session.session_token,
-                                                          key_manager_token=await self._auth_session.key_manager_token)
+        await self._signals_api.v1_signals_id_delete_post(
+            id=signal_id,
+            session_token=await self._auth_session.session_token,
+            key_manager_token=await self._auth_session.key_manager_token,
+        )
 
     @retry
-    async def subscribe_users_to_signal(self, signal_id: str, pushed: bool,
-                                        user_ids: [int]) -> ChannelSubscriptionResponse:
-        """ Subscribe an array of users to a Signal.
+    async def subscribe_users_to_signal(
+        self, signal_id: str, pushed: bool, user_ids: [int]
+    ) -> ChannelSubscriptionResponse:
+        """Subscribe an array of users to a Signal.
 
         See: 'Subscribe signal <https://developers.symphony.com/restapi/reference/subscribe-signal>'_
 
@@ -135,12 +152,18 @@ class OboSignalService:
         """
 
         return await self._signals_api.v1_signals_id_subscribe_post(
-            id=signal_id, pushed=pushed, users=user_ids, session_token=await self._auth_session.session_token,
-            key_manager_token=await self._auth_session.key_manager_token)
+            id=signal_id,
+            pushed=pushed,
+            users=user_ids,
+            session_token=await self._auth_session.session_token,
+            key_manager_token=await self._auth_session.key_manager_token,
+        )
 
     @retry
-    async def unsubscribe_users_to_signal(self, signal_id: str, user_ids: [int]) -> ChannelSubscriptionResponse:
-        """ Unsubscribes an array of users from the specified Signal.
+    async def unsubscribe_users_to_signal(
+        self, signal_id: str, user_ids: [int]
+    ) -> ChannelSubscriptionResponse:
+        """Unsubscribes an array of users from the specified Signal.
 
         See: 'Unsubscribe signal <https://developers.symphony.com/restapi/reference/unsubscribe-signal>'_
 
@@ -150,11 +173,16 @@ class OboSignalService:
         """
 
         return await self._signals_api.v1_signals_id_unsubscribe_post(
-            id=signal_id, users=user_ids, session_token=await self._auth_session.session_token,
-            key_manager_token=await self._auth_session.key_manager_token)
+            id=signal_id,
+            users=user_ids,
+            session_token=await self._auth_session.session_token,
+            key_manager_token=await self._auth_session.key_manager_token,
+        )
 
     @retry
-    async def list_subscribers(self, signal_id: str, skip: int = 0, limit: int = 50) -> ChannelSubscriberResponse:
+    async def list_subscribers(
+        self, signal_id: str, skip: int = 0, limit: int = 50
+    ) -> ChannelSubscriberResponse:
         """Gets the subscribers for the specified signal.
 
         See: 'Subscribers <https://developers.symphony.com/restapi/reference/subscribers>'_
@@ -167,11 +195,16 @@ class OboSignalService:
         """
 
         return await self._signals_api.v1_signals_id_subscribers_get(
-            id=signal_id, skip=skip, limit=limit, session_token=await self._auth_session.session_token,
-            key_manager_token=await self._auth_session.key_manager_token)
-
-    async def list_all_subscribers(self, signal_id: str, chunk_size: int = 50, max_number: int = None) \
-            -> AsyncGenerator[ChannelSubscriber, None]:
+            id=signal_id,
+            skip=skip,
+            limit=limit,
+            session_token=await self._auth_session.session_token,
+            key_manager_token=await self._auth_session.key_manager_token,
+        )
+
+    async def list_all_subscribers(
+        self, signal_id: str, chunk_size: int = 50, max_number: int = None
+    ) -> AsyncGenerator[ChannelSubscriber, None]:
         """Gets all the subscribers for the specified signal.
 
         See: 'Subscribers <https://developers.symphony.com/restapi/reference/subscribers>'_

symphony/bdk/core/service/stream/stream_service.py

@@ -34,8 +34,14 @@ from symphony.bdk.gen.pod_model.v3_room_search_results import V3RoomSearchResult
 class OboStreamService:
     """Class exposing OBO-enabled endpoints for stream management."""
 
-    def __init__(self, streams_api: StreamsApi, room_membership_api: RoomMembershipApi, share_api: ShareApi,
-                 auth_session: AuthSession, retry_config: BdkRetryConfig):
+    def __init__(
+        self,
+        streams_api: StreamsApi,
+        room_membership_api: RoomMembershipApi,
+        share_api: ShareApi,
+        auth_session: AuthSession,
+        retry_config: BdkRetryConfig,
+    ):
         """
 
         :param streams_api: a generated StreamsApi instance.
@@ -50,21 +56,19 @@ class OboStreamService:
         self._retry_config = retry_config
 
     @retry
-    async def create_im_or_mim(self, user_ids: [int]) -> Stream:
-        """Create a new single or multi party instant message conversation between the caller and specified users.
+    async def create_im(self, user_id: int) -> Stream:
+        """Create a new single party instant message conversation between the caller and specified user.
         The caller is implicitly included in the members of the created chat.
-        Duplicate users will be included in the membership of the chat but the duplication will be silently ignored.
-        If there is an existing IM conversation with the same set of participants then the id of that existing stream
-        will be returned.
-        If the given list of user ids contains only one id, an IM will be created, otherwise, a MIM will be created.
 
-        Wraps the `Create IM or MIM <https://developers.symphony.com/restapi/reference/create-im-or-mim>`_ endpoint.
+        Wraps the `Create IM  <https://rest-api.symphony.com/main/streams-conversations/im-mim-endpoints/create-im-or-mim>`_ endpoint.
 
-        :param user_ids: the list of user ids ti be put as room participants.
+        :param user_id: the user id to be put as room participant.
         :return: the created stream.
         """
-        return await self._streams_api.v1_im_create_post(uid_list=UserIdList(value=user_ids),
-                                                         session_token=await self._auth_session.session_token)
+        return await self._streams_api.v1_im_create_post(
+            uid_list=UserIdList(value=[user_id]),
+            session_token=await self._auth_session.session_token,
+        )
 
     @retry
     async def create_room(self, room_attributes: V3RoomAttributes) -> V3RoomDetail:
@@ -75,8 +79,10 @@ class OboStreamService:
         :param room_attributes: attributes of the room to be created.
         :return: details of created room.
         """
-        return await self._streams_api.v3_room_create_post(payload=room_attributes,
-                                                           session_token=await self._auth_session.session_token)
+        return await self._streams_api.v3_room_create_post(
+            payload=room_attributes,
+            session_token=await self._auth_session.session_token,
+        )
 
     @retry
     async def get_stream(self, stream_id: str) -> V2StreamAttributes:
@@ -86,8 +92,9 @@ class OboStreamService:
         :param stream_id: the ID of the stream to be retrieved.
         :return: the information about the given stream.
         """
-        return await self._streams_api.v2_streams_sid_info_get(sid=stream_id,
-                                                               session_token=await self._auth_session.session_token)
+        return await self._streams_api.v2_streams_sid_info_get(
+            sid=stream_id, session_token=await self._auth_session.session_token
+        )
 
     @retry
     async def get_room_info(self, room_id: str) -> V3RoomDetail:
@@ -97,12 +104,14 @@ class OboStreamService:
         :param room_id: the id of the room.
         :return: the room details.
         """
-        return await self._streams_api.v3_room_id_info_get(id=room_id,
-                                                           session_token=await self._auth_session.session_token)
+        return await self._streams_api.v3_room_id_info_get(
+            id=room_id, session_token=await self._auth_session.session_token
+        )
 
     @retry
-    async def list_streams(self, stream_filter: StreamFilter, skip: int = 0,
-                           limit: int = 50) -> StreamList:
+    async def list_streams(
+        self, stream_filter: StreamFilter, skip: int = 0, limit: int = 50
+    ) -> StreamList:
         """Returns a list of all the streams of which the requesting user is a member,
         sorted by creation date (ascending - oldest to newest).
         Wraps the `List User Streams <https://developers.symphony.com/restapi/reference/list-user-streams>`_ endpoint.
@@ -112,12 +121,17 @@ class OboStreamService:
         :param limit: maximum number of streams to return.
         :return: the list of stream retrieved matching the search filter.
         """
-        return await self._streams_api.v1_streams_list_post(filter=stream_filter, skip=skip, limit=limit,
-                                                            session_token=await self._auth_session.session_token)
+        return await self._streams_api.v1_streams_list_post(
+            filter=stream_filter,
+            skip=skip,
+            limit=limit,
+            session_token=await self._auth_session.session_token,
+        )
 
     @retry
-    async def list_all_streams(self, stream_filter: StreamFilter, chunk_size: int = 50, max_number: int = None) \
-            -> AsyncGenerator[StreamAttributes, None]:
+    async def list_all_streams(
+        self, stream_filter: StreamFilter, chunk_size: int = 50, max_number: int = None
+    ) -> AsyncGenerator[StreamAttributes, None]:
         """Returns an asynchronous of all the streams of which the requesting user is a member,
         sorted by creation date (ascending - oldest to newest).
         Wraps the `List User Streams <https://developers.symphony.com/restapi/reference/list-user-streams>`_ endpoint.
@@ -135,32 +149,49 @@ class OboStreamService:
         return offset_based_pagination(list_streams_one_page, chunk_size, max_number)
 
     @retry
-    async def search_rooms(self, query: V2RoomSearchCriteria, skip: int = 0,
-                           limit: int = 50) -> V3RoomSearchResults:
+    async def search_rooms(
+        self,
+        query: V2RoomSearchCriteria,
+        skip: int = 0,
+        limit: int = 50,
+        include_non_discoverable=False,
+    ) -> V3RoomSearchResults:
         """Search for rooms according to the specified criteria.
         Wraps the `Search Rooms V3 <https://developers.symphony.com/restapi/reference/search-rooms-v3>`_ endpoint.
 
         :param query: the search criteria.
         :param skip: number of rooms to skip, defaults to 0.
         :param limit: number of maximum rooms to return. Must be a positive integer that does not exceed 100.
+        :param include_non_discoverable: set to `True` to include rooms not publicly searchable, false by default.
         :return: the rooms matching search criteria.
         """
-        return await self._streams_api.v3_room_search_post(query=query, skip=skip, limit=limit,
-                                                           session_token=await self._auth_session.session_token)
-
-    async def search_all_rooms(self, query: V2RoomSearchCriteria, chunk_size: int = 50,
-                               max_number: int = None) -> AsyncGenerator[V3RoomDetail, None]:
+        return await self._streams_api.v3_room_search_post(
+            query=query,
+            skip=skip,
+            limit=limit,
+            include_non_discoverable=include_non_discoverable,
+            session_token=await self._auth_session.session_token,
+        )
+
+    async def search_all_rooms(
+        self,
+        query: V2RoomSearchCriteria,
+        chunk_size: int = 50,
+        max_number: int = None,
+        include_non_discoverable: bool = False,
+    ) -> AsyncGenerator[V3RoomDetail, None]:
         """Search for rooms according to the specified criteria.
         Wraps the `Search Rooms V3 <https://developers.symphony.com/restapi/reference/search-rooms-v3>`_ endpoint.
 
         :param query: the search criteria.
         :param chunk_size: the maximum number of elements to retrieve in one underlying HTTP call.
         :param max_number: the total maximum number of elements to retrieve.
+        :param include_non_discoverable: set to `True` to include rooms not publicly searchable, false by default.
         :return: an asynchronous generator of the rooms matching the search criteria.
         """
 
         async def search_rooms_one_page(skip, limit):
-            result = await self.search_rooms(query, skip, limit)
+            result = await self.search_rooms(query, skip, limit, include_non_discoverable)
             return result.rooms if result.rooms else None
 
         return offset_based_pagination(search_rooms_one_page, chunk_size, max_number)
@@ -174,8 +205,11 @@ class OboStreamService:
         :param room_attributes: the attributes of the room to be updated.
         :return: the details of the updated room.
         """
-        return await self._streams_api.v3_room_id_update_post(id=room_id, payload=room_attributes,
-                                                              session_token=await self._auth_session.session_token)
+        return await self._streams_api.v3_room_id_update_post(
+            id=room_id,
+            payload=room_attributes,
+            session_token=await self._auth_session.session_token,
+        )
 
     @retry
     async def add_member_to_room(self, user_id: int, room_id: str):
@@ -187,8 +221,10 @@ class OboStreamService:
         :return: None
         """
         await self._room_membership_api.v1_room_id_membership_add_post(
-            payload=UserId(id=user_id), id=room_id,
-            session_token=await self._auth_session.session_token)
+            payload=UserId(id=user_id),
+            id=room_id,
+            session_token=await self._auth_session.session_token,
+        )
 
     @retry
     async def remove_member_from_room(self, user_id: int, room_id: str):
@@ -200,8 +236,10 @@ class OboStreamService:
         :return: None
         """
         await self._room_membership_api.v1_room_id_membership_remove_post(
-            payload=UserId(id=user_id), id=room_id,
-            session_token=await self._auth_session.session_token)
+            payload=UserId(id=user_id),
+            id=room_id,
+            session_token=await self._auth_session.session_token,
+        )
 
     @retry
     async def share(self, stream_id: str, content: ShareContent) -> V2Message:
@@ -214,8 +252,11 @@ class OboStreamService:
         :return: the created message.
         """
         return await self._share_api.v3_stream_sid_share_post(
-            sid=stream_id, share_content=content, session_token=await self._auth_session.session_token,
-            key_manager_token=await self._auth_session.key_manager_token)
+            sid=stream_id,
+            share_content=content,
+            session_token=await self._auth_session.session_token,
+            key_manager_token=await self._auth_session.key_manager_token,
+        )
 
     @retry
     async def promote_user_to_room_owner(self, user_id: int, room_id: str):
@@ -227,7 +268,10 @@ class OboStreamService:
         :return: None
         """
         await self._room_membership_api.v1_room_id_membership_promote_owner_post(
-            id=room_id, payload=UserId(id=user_id), session_token=await self._auth_session.session_token)
+            id=room_id,
+            payload=UserId(id=user_id),
+            session_token=await self._auth_session.session_token,
+        )
 
     @retry
     async def demote_owner_to_room_participant(self, user_id: int, room_id: str):
@@ -239,12 +283,14 @@ class OboStreamService:
         :return: None
         """
         await self._room_membership_api.v1_room_id_membership_demote_owner_post(
-            id=room_id, payload=UserId(id=user_id), session_token=await self._auth_session.session_token)
+            id=room_id,
+            payload=UserId(id=user_id),
+            session_token=await self._auth_session.session_token,
+        )
 
 
 class StreamService(OboStreamService):
-    """Service class to manage streams.
-    """
+    """Service class to manage streams."""
 
     @retry
     async def get_im_info(self, im_id: str) -> V1IMDetail:
@@ -254,8 +300,9 @@ class StreamService(OboStreamService):
         :param im_id: the id of the IM.
         :return: the im details.
         """
-        return await self._streams_api.v1_im_id_info_get(id=im_id,
-                                                         session_token=await self._auth_session.session_token)
+        return await self._streams_api.v1_im_id_info_get(
+            id=im_id, session_token=await self._auth_session.session_token
+        )
 
     @retry
     async def set_room_active(self, room_id: str, active: bool) -> RoomDetail:
@@ -267,8 +314,11 @@ class StreamService(OboStreamService):
         :param active: the new active status (True to reactivate, false to deactivate).
         :return: the details of the updated room.
         """
-        return await self._streams_api.v1_room_id_set_active_post(id=room_id, active=active,
-                                                                  session_token=await self._auth_session.session_token)
+        return await self._streams_api.v1_room_id_set_active_post(
+            id=room_id,
+            active=active,
+            session_token=await self._auth_session.session_token,
+        )
 
     @retry
     async def update_im(self, im_id: str, im_attributes: V1IMAttributes) -> V1IMDetail:
@@ -279,8 +329,11 @@ class StreamService(OboStreamService):
         :param im_attributes: the attributes of the im to be updated.
         :return: the details of the updated im.
         """
-        return await self._streams_api.v1_im_id_update_post(id=im_id, payload=im_attributes,
-                                                            session_token=await self._auth_session.session_token)
+        return await self._streams_api.v1_im_id_update_post(
+            id=im_id,
+            payload=im_attributes,
+            session_token=await self._auth_session.session_token,
+        )
 
     @retry
     async def create_im_admin(self, user_ids: [int]) -> Stream:
@@ -298,8 +351,10 @@ class StreamService(OboStreamService):
         :param user_ids: the list of user IDs to be put as participants. At least two user IDs must be provided.
         :return: the created IM or MIM.
         """
-        return await self._streams_api.v1_admin_im_create_post(uid_list=UserIdList(value=user_ids),
-                                                               session_token=await self._auth_session.session_token)
+        return await self._streams_api.v1_admin_im_create_post(
+            uid_list=UserIdList(value=user_ids),
+            session_token=await self._auth_session.session_token,
+        )
 
     @retry
     async def set_room_active_admin(self, room_id: str, active: bool) -> RoomDetail:
@@ -310,12 +365,15 @@ class StreamService(OboStreamService):
         :return: the details of the updated room.
         """
         return await self._streams_api.v1_admin_room_id_set_active_post(
-            id=room_id, active=active,
-            session_token=await self._auth_session.session_token)
+            id=room_id,
+            active=active,
+            session_token=await self._auth_session.session_token,
+        )
 
     @retry
-    async def list_streams_admin(self, stream_filter: V2AdminStreamFilter, skip: int = 0,
-                                 limit: int = 50) -> V2AdminStreamList:
+    async def list_streams_admin(
+        self, stream_filter: V2AdminStreamFilter, skip: int = 0, limit: int = 50
+    ) -> V2AdminStreamList:
         """Retrieves all the streams across the enterprise.
         Wraps the `List Streams for Enterprise V2
         <https://developers.symphony.com/restapi/reference/list-streams-for-enterprise-v2>`_ endpoint.
@@ -325,11 +383,16 @@ class StreamService(OboStreamService):
         :param limit: the maximum number of streams to retrieve. Must be a positive integer less or equal than 100.
         :return: the list of streams matching the search criteria.
         """
-        return await self._streams_api.v2_admin_streams_list_post(filter=stream_filter, skip=skip, limit=limit,
-                                                                  session_token=await self._auth_session.session_token)
-
-    async def list_all_streams_admin(self, stream_filter: V2AdminStreamFilter, chunk_size=50, max_number=None) \
-            -> AsyncGenerator[V2AdminStreamInfo, None]:
+        return await self._streams_api.v2_admin_streams_list_post(
+            filter=stream_filter,
+            skip=skip,
+            limit=limit,
+            session_token=await self._auth_session.session_token,
+        )
+
+    async def list_all_streams_admin(
+        self, stream_filter: V2AdminStreamFilter, chunk_size=50, max_number=None
+    ) -> AsyncGenerator[V2AdminStreamInfo, None]:
         """Retrieves all the streams across the enterprise.
         Wraps the `List Streams for Enterprise V2
         <https://developers.symphony.com/restapi/reference/list-streams-for-enterprise-v2>`_ endpoint.
@@ -347,7 +410,57 @@ class StreamService(OboStreamService):
         return offset_based_pagination(list_streams_admin_one_page, chunk_size, max_number)
 
     @retry
-    async def list_stream_members(self, stream_id: str, skip: int = 0, limit: int = 100) -> V2MembershipList:
+    async def list_user_streams_admin(
+        self,
+        uid: int,
+        stream_filter: StreamFilter = None,
+        skip: int = 0,
+        limit: int = 50,
+    ) -> StreamList:
+        """Retrieve a list of all streams of which a user is a member.
+        Wraps the `User Streams <https://developers.symphony.com/restapi/v20.16/reference#user-streams>`_ endpoint.
+
+        :param uid: the ID of the user.
+        :param stream_filter: the filtering criteria for the streams.
+        :param skip: the number of streams to skip.
+        :param limit: the maximum number of streams to retrieve. Must be less or equal than 1000.
+        :return: the list of streams for the specified user.
+        """
+        return await self._streams_api.v1_admin_user_uid_streams_list_post(
+            uid=uid,
+            filter=stream_filter,
+            skip=skip,
+            limit=limit,
+            session_token=await self._auth_session.session_token,
+        )
+
+    async def list_all_user_streams_admin(
+        self,
+        uid: int,
+        stream_filter: StreamFilter = None,
+        chunk_size: int = 50,
+        max_number: int = None,
+    ) -> AsyncGenerator[StreamAttributes, None]:
+        """Retrieves all streams of which a user is a member, handling pagination automatically.
+        Wraps the `User Streams <https://developers.symphony.com/restapi/v20.16/reference#user-streams>`_ endpoint.
+
+        :param uid: the ID of the user.
+        :param stream_filter: the filtering criteria for the streams.
+        :param chunk_size: the maximum number of streams to retrieve in one underlying HTTP call.
+        :param max_number: the total maximum number of streams to retrieve.
+        :return: an asynchronous generator of the streams.
+        """
+
+        async def list_streams_one_page(skip, limit):
+            result = await self.list_user_streams_admin(uid, stream_filter, skip, limit)
+            return result.value if result else None
+
+        return offset_based_pagination(list_streams_one_page, chunk_size, max_number)
+
+    @retry
+    async def list_stream_members(
+        self, stream_id: str, skip: int = 0, limit: int = 100
+    ) -> V2MembershipList:
         """List the current members of an existing stream. The stream can be of type IM, MIM, or ROOM.
         Wraps the `Stream Members <https://developers.symphony.com/restapi/reference#stream-members>`_ endpoint.
 
@@ -357,11 +470,15 @@ class StreamService(OboStreamService):
         :return: the list of stream members.
         """
         return await self._streams_api.v1_admin_stream_id_membership_list_get(
-            id=stream_id, skip=skip, limit=limit,
-            session_token=await self._auth_session.session_token)
-
-    async def list_all_stream_members(self, stream_id: str, chunk_size: int = 50, max_number=None) \
-            -> AsyncGenerator[V2MemberInfo, None]:
+            id=stream_id,
+            skip=skip,
+            limit=limit,
+            session_token=await self._auth_session.session_token,
+        )
+
+    async def list_all_stream_members(
+        self, stream_id: str, chunk_size: int = 50, max_number=None
+    ) -> AsyncGenerator[V2MemberInfo, None]:
         """List the current members of an existing stream. The stream can be of type IM, MIM, or ROOM.
         Wraps the `Stream Members <https://developers.symphony.com/restapi/reference#stream-members>`_ endpoint.
 
@@ -386,5 +503,5 @@ class StreamService(OboStreamService):
         :return: the list of room members.
         """
         return await self._room_membership_api.v2_room_id_membership_list_get(
-            id=room_id,
-            session_token=await self._auth_session.session_token)
+            id=room_id, session_token=await self._auth_session.session_token
+        )

symphony/bdk/core/service/stream/stream_util.py

@@ -1,6 +1,7 @@
 """This module contains a set of util functions providing stream id conversion.
 It is possible to make conversion from the original stream id to the URLSafe encoded stream id and viceversa.
 """
+
 import base64