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

symphony/bdk/core/service/message/multi_attachments_messages_api.py

@@ -2,9 +2,7 @@ from symphony.bdk.gen.agent_api.messages_api import MessagesApi
 from symphony.bdk.gen.agent_model.v4_message import V4Message
 from symphony.bdk.gen.agent_model.v4_message_blast_response import V4MessageBlastResponse
 from symphony.bdk.gen.api_client import Endpoint
-from symphony.bdk.gen.model_utils import (
-    file_type
-)
+from symphony.bdk.gen.model_utils import file_type
 
 
 class MultiAttachmentsMessagesApi(MessagesApi):
@@ -17,186 +15,140 @@ class MultiAttachmentsMessagesApi(MessagesApi):
 
         self.v4_multi_attachment_message_blast_post_endpoint = Endpoint(
             settings={
-                'response_type': (V4MessageBlastResponse,),
-                'auth': [],
-                'endpoint_path': '/v4/message/blast',
-                'operation_id': 'v4_message_blast_post',
-                'http_method': 'POST',
-                'servers': None,
+                "response_type": (V4MessageBlastResponse,),
+                "auth": [],
+                "endpoint_path": "/v4/message/blast",
+                "operation_id": "v4_message_blast_post",
+                "http_method": "POST",
+                "servers": None,
             },
             params_map={
-                'all': [
-                    'session_token',
-                    'sids',
-                    'key_manager_token',
-                    'message',
-                    'data',
-                    'version',
-                    'attachment',
-                    'preview',
+                "all": [
+                    "session_token",
+                    "sids",
+                    "key_manager_token",
+                    "message",
+                    "data",
+                    "version",
+                    "attachment",
+                    "preview",
                 ],
-                'required': [
-                    'session_token',
-                    'sids',
+                "required": [
+                    "session_token",
+                    "sids",
                 ],
-                'nullable': [
-                ],
-                'enum': [
-                ],
-                'validation': [
-                ]
+                "nullable": [],
+                "enum": [],
+                "validation": [],
             },
             root_map={
-                'validations': {
-                },
-                'allowed_values': {
+                "validations": {},
+                "allowed_values": {},
+                "openapi_types": {
+                    "session_token": (str,),
+                    "sids": ([str],),
+                    "key_manager_token": (str,),
+                    "message": (str,),
+                    "data": (str,),
+                    "version": (str,),
+                    "attachment": ([file_type],),
+                    "preview": ([file_type],),
                 },
-                'openapi_types': {
-                    'session_token':
-                        (str,),
-                    'sids':
-                        ([str],),
-                    'key_manager_token':
-                        (str,),
-                    'message':
-                        (str,),
-                    'data':
-                        (str,),
-                    'version':
-                        (str,),
-                    'attachment':
-                        ([file_type],),
-                    'preview':
-                        ([file_type],),
+                "attribute_map": {
+                    "session_token": "sessionToken",
+                    "sids": "sids",
+                    "key_manager_token": "keyManagerToken",
+                    "message": "message",
+                    "data": "data",
+                    "version": "version",
+                    "attachment": "attachment",
+                    "preview": "preview",
                 },
-                'attribute_map': {
-                    'session_token': 'sessionToken',
-                    'sids': 'sids',
-                    'key_manager_token': 'keyManagerToken',
-                    'message': 'message',
-                    'data': 'data',
-                    'version': 'version',
-                    'attachment': 'attachment',
-                    'preview': 'preview',
+                "location_map": {
+                    "session_token": "header",
+                    "sids": "form",
+                    "key_manager_token": "header",
+                    "message": "form",
+                    "data": "form",
+                    "version": "form",
+                    "attachment": "form",
+                    "preview": "form",
                 },
-                'location_map': {
-                    'session_token': 'header',
-                    'sids': 'form',
-                    'key_manager_token': 'header',
-                    'message': 'form',
-                    'data': 'form',
-                    'version': 'form',
-                    'attachment': 'form',
-                    'preview': 'form',
+                "collection_format_map": {
+                    "sids": "csv",
                 },
-                'collection_format_map': {
-                    'sids': 'csv',
-                }
             },
-            headers_map={
-                'accept': [
-                    'application/json'
-                ],
-                'content_type': [
-                    'multipart/form-data'
-                ]
-            },
-            api_client=api_client
+            headers_map={"accept": ["application/json"], "content_type": ["multipart/form-data"]},
+            api_client=api_client,
         )
         self.v4_stream_sid_multi_attachment_message_create_post_endpoint = Endpoint(
             settings={
-                'response_type': (V4Message,),
-                'auth': [],
-                'endpoint_path': '/v4/stream/{sid}/message/create',
-                'operation_id': 'v4_stream_sid_message_create_post',
-                'http_method': 'POST',
-                'servers': None,
+                "response_type": (V4Message,),
+                "auth": [],
+                "endpoint_path": "/v4/stream/{sid}/message/create",
+                "operation_id": "v4_stream_sid_message_create_post",
+                "http_method": "POST",
+                "servers": None,
             },
             params_map={
-                'all': [
-                    'sid',
-                    'session_token',
-                    'key_manager_token',
-                    'message',
-                    'data',
-                    'version',
-                    'attachment',
-                    'preview',
-                ],
-                'required': [
-                    'sid',
-                    'session_token',
+                "all": [
+                    "sid",
+                    "session_token",
+                    "key_manager_token",
+                    "message",
+                    "data",
+                    "version",
+                    "attachment",
+                    "preview",
                 ],
-                'nullable': [
+                "required": [
+                    "sid",
+                    "session_token",
                 ],
-                'enum': [
-                ],
-                'validation': [
-                ]
+                "nullable": [],
+                "enum": [],
+                "validation": [],
             },
             root_map={
-                'validations': {
-                },
-                'allowed_values': {
-                },
-                'openapi_types': {
-                    'sid':
-                        (str,),
-                    'session_token':
-                        (str,),
-                    'key_manager_token':
-                        (str,),
-                    'message':
-                        (str,),
-                    'data':
-                        (str,),
-                    'version':
-                        (str,),
-                    'attachment':
-                        ([file_type],),
-                    'preview':
-                        ([file_type],),
+                "validations": {},
+                "allowed_values": {},
+                "openapi_types": {
+                    "sid": (str,),
+                    "session_token": (str,),
+                    "key_manager_token": (str,),
+                    "message": (str,),
+                    "data": (str,),
+                    "version": (str,),
+                    "attachment": ([file_type],),
+                    "preview": ([file_type],),
                 },
-                'attribute_map': {
-                    'sid': 'sid',
-                    'session_token': 'sessionToken',
-                    'key_manager_token': 'keyManagerToken',
-                    'message': 'message',
-                    'data': 'data',
-                    'version': 'version',
-                    'attachment': 'attachment',
-                    'preview': 'preview',
+                "attribute_map": {
+                    "sid": "sid",
+                    "session_token": "sessionToken",
+                    "key_manager_token": "keyManagerToken",
+                    "message": "message",
+                    "data": "data",
+                    "version": "version",
+                    "attachment": "attachment",
+                    "preview": "preview",
                 },
-                'location_map': {
-                    'sid': 'path',
-                    'session_token': 'header',
-                    'key_manager_token': 'header',
-                    'message': 'form',
-                    'data': 'form',
-                    'version': 'form',
-                    'attachment': 'form',
-                    'preview': 'form',
+                "location_map": {
+                    "sid": "path",
+                    "session_token": "header",
+                    "key_manager_token": "header",
+                    "message": "form",
+                    "data": "form",
+                    "version": "form",
+                    "attachment": "form",
+                    "preview": "form",
                 },
-                'collection_format_map': {
-                }
+                "collection_format_map": {},
             },
-            headers_map={
-                'accept': [
-                    'application/json'
-                ],
-                'content_type': [
-                    'multipart/form-data'
-                ]
-            },
-            api_client=api_client
+            headers_map={"accept": ["application/json"], "content_type": ["multipart/form-data"]},
+            api_client=api_client,
         )
 
-    def v4_stream_sid_multi_attachment_message_create_post(
-        self,
-        sid,
-        session_token,
-        **kwargs
-    ):
+    def v4_stream_sid_multi_attachment_message_create_post(self, sid, session_token, **kwargs):
         """Post a message to one existing stream.  # noqa: E501
 
         Post a new message to the given stream. The stream can be a chatroom, an IM or a multiparty IM.  You may include an attachment on the message.  The message can be provided as MessageMLV2 or PresentationML. Both formats support Freemarker templates.  The optional parameter \"data\" can be used to provide a JSON payload containing entity data. If the message contains explicit references to entity data (in \"data-entity-id\" element attributes), this parameter is required.  If the message is in MessageML and fails schema validation a client error results  If the message is sent then 200 is returned.  Regarding authentication, you must either use the sessionToken which was created for delegated app access or both the sessionToken and keyManagerToken together.   # noqa: E501
@@ -249,42 +201,22 @@ class MultiAttachmentsMessagesApi(MessagesApi):
                 If the method is called asynchronously, returns the request
                 thread.
         """
-        kwargs['async_req'] = kwargs.get(
-            'async_req', False
-        )
-        kwargs['_return_http_data_only'] = kwargs.get(
-            '_return_http_data_only', True
+        kwargs["async_req"] = kwargs.get("async_req", False)
+        kwargs["_return_http_data_only"] = kwargs.get("_return_http_data_only", True)
+        kwargs["_preload_content"] = kwargs.get("_preload_content", True)
+        kwargs["_request_timeout"] = kwargs.get("_request_timeout", None)
+        kwargs["_check_input_type"] = kwargs.get("_check_input_type", True)
+        kwargs["_check_return_type"] = kwargs.get("_check_return_type", True)
+        kwargs["_spec_property_naming"] = kwargs.get("_spec_property_naming", False)
+        kwargs["_content_type"] = kwargs.get("_content_type")
+        kwargs["_host_index"] = kwargs.get("_host_index")
+        kwargs["sid"] = sid
+        kwargs["session_token"] = session_token
+        return self.v4_stream_sid_multi_attachment_message_create_post_endpoint.call_with_http_info(
+            **kwargs
         )
-        kwargs['_preload_content'] = kwargs.get(
-            '_preload_content', True
-        )
-        kwargs['_request_timeout'] = kwargs.get(
-            '_request_timeout', None
-        )
-        kwargs['_check_input_type'] = kwargs.get(
-            '_check_input_type', True
-        )
-        kwargs['_check_return_type'] = kwargs.get(
-            '_check_return_type', True
-        )
-        kwargs['_spec_property_naming'] = kwargs.get(
-            '_spec_property_naming', False
-        )
-        kwargs['_content_type'] = kwargs.get(
-            '_content_type')
-        kwargs['_host_index'] = kwargs.get('_host_index')
-        kwargs['sid'] = \
-            sid
-        kwargs['session_token'] = \
-            session_token
-        return self.v4_stream_sid_multi_attachment_message_create_post_endpoint.call_with_http_info(**kwargs)
 
-    def v4_multi_attachment_message_blast_post(
-        self,
-        session_token,
-        sids,
-        **kwargs
-    ):
+    def v4_multi_attachment_message_blast_post(self, session_token, sids, **kwargs):
         """Post a message to multiple existing streams.  # noqa: E501
 
         Post a new message to the given list of streams. The stream can be a chatroom, an IM or a multiparty IM.  You may include an attachment on the message.  The message can be provided as MessageMLV2 or PresentationML. Both formats support Freemarker templates.  The optional parameter \"data\" can be used to provide a JSON payload containing entity data. If the message contains explicit references to entity data (in \"data-entity-id\" element attributes), this parameter is required.  If the message is in MessageML and fails schema validation a client error results  This endpoint is idempotent, it means that a 200 response will be returned even if the message has not been delivered to some streams. Check the `errors` map from the response in order to see on which stream(s) the message has not been delivered.  The maximum number of streams where the message can be sent is limitted to 100.  Regarding authentication, you must either use the sessionToken which was created for delegated app access or both the sessionToken and keyManagerToken together.   # noqa: E501
@@ -337,32 +269,15 @@ class MultiAttachmentsMessagesApi(MessagesApi):
                 If the method is called asynchronously, returns the request
                 thread.
         """
-        kwargs['async_req'] = kwargs.get(
-            'async_req', False
-        )
-        kwargs['_return_http_data_only'] = kwargs.get(
-            '_return_http_data_only', True
-        )
-        kwargs['_preload_content'] = kwargs.get(
-            '_preload_content', True
-        )
-        kwargs['_request_timeout'] = kwargs.get(
-            '_request_timeout', None
-        )
-        kwargs['_check_input_type'] = kwargs.get(
-            '_check_input_type', True
-        )
-        kwargs['_check_return_type'] = kwargs.get(
-            '_check_return_type', True
-        )
-        kwargs['_spec_property_naming'] = kwargs.get(
-            '_spec_property_naming', False
-        )
-        kwargs['_content_type'] = kwargs.get(
-            '_content_type')
-        kwargs['_host_index'] = kwargs.get('_host_index')
-        kwargs['session_token'] = \
-            session_token
-        kwargs['sids'] = \
-            sids
+        kwargs["async_req"] = kwargs.get("async_req", False)
+        kwargs["_return_http_data_only"] = kwargs.get("_return_http_data_only", True)
+        kwargs["_preload_content"] = kwargs.get("_preload_content", True)
+        kwargs["_request_timeout"] = kwargs.get("_request_timeout", None)
+        kwargs["_check_input_type"] = kwargs.get("_check_input_type", True)
+        kwargs["_check_return_type"] = kwargs.get("_check_return_type", True)
+        kwargs["_spec_property_naming"] = kwargs.get("_spec_property_naming", False)
+        kwargs["_content_type"] = kwargs.get("_content_type")
+        kwargs["_host_index"] = kwargs.get("_host_index")
+        kwargs["session_token"] = session_token
+        kwargs["sids"] = sids
         return self.v4_multi_attachment_message_blast_post_endpoint.call_with_http_info(**kwargs)

symphony/bdk/core/service/obo_services.py

@@ -11,7 +11,7 @@ from symphony.bdk.core.service_factory import OboServiceFactory
 
 class OboServices:
     """Entry point for OBO-enabled services, see
-        `the list of OBO-enabled endpoints <https://developers.symphony.com/restapi/reference/obo-enabled-endpoints#api-endpoints-enabled-for-obo>`_
+    `the list of OBO-enabled endpoints <https://developers.symphony.com/restapi/reference/obo-enabled-endpoints#api-endpoints-enabled-for-obo>`_
     """
 
     async def __aenter__(self):
@@ -30,7 +30,9 @@ class OboServices:
         self._obo_session = obo_session
 
         self._api_client_factory = ApiClientFactory(config)
-        self._service_factory = OboServiceFactory(self._api_client_factory, self._obo_session, self._config)
+        self._service_factory = OboServiceFactory(
+            self._api_client_factory, self._obo_session, self._config
+        )
         self._connection_service = self._service_factory.get_connection_service()
         self._message_service = self._service_factory.get_message_service()
         self._stream_service = self._service_factory.get_stream_service()
@@ -73,6 +75,5 @@ class OboServices:
         return self._signal_service
 
     async def close_clients(self):
-        """Close all the existing api clients created by the api client factory.
-        """
+        """Close all the existing api clients created by the api client factory."""
         await self._api_client_factory.close_clients()

symphony/bdk/core/service/pagination.py

@@ -1,13 +1,15 @@
 """This module takes care of creating generators from paginated endpoints, so that user do not have to care about
 making several calls to the same endpoint with the correct pagination values.
 """
-from typing import AsyncGenerator, TypeVar, Callable, Awaitable, Tuple
 
-T = TypeVar('T')
+from typing import AsyncGenerator, Awaitable, Callable, Tuple, TypeVar
 
+T = TypeVar("T")
 
-async def offset_based_pagination(func: Callable[[int, int], Awaitable[T]],
-                                  chunk_size=50, max_number=None) -> AsyncGenerator[T, None]:
+
+async def offset_based_pagination(
+    func: Callable[[int, int], Awaitable[T]], chunk_size=50, max_number=None
+) -> AsyncGenerator[T, None]:
     """Creates an asynchronous generator from a paginated endpoint. The generator makes the call to the underlying
     endpoint `func` until the `max_number` of items is reached or results are exhausted (i.e. `func` is None or empty).
 
@@ -42,8 +44,9 @@ async def offset_based_pagination(func: Callable[[int, int], Awaitable[T]],
         chunk = await func(skip, chunk_size)
 
 
-async def cursor_based_pagination(func: Callable[[int, str], Awaitable[Tuple[T, str]]],
-                                  chunk_size=100, max_number=None) -> AsyncGenerator[T, None]:
+async def cursor_based_pagination(
+    func: Callable[[int, str], Awaitable[Tuple[T, str]]], chunk_size=100, max_number=None
+) -> AsyncGenerator[T, None]:
     """Creates an asynchronous generator from a cursor based endpoint. The generator makes the call to the underlying
     endpoint `func` until the `max_number` of items is reached or results are exhausted (i.e. cursor returned by `func`
     is None).

symphony/bdk/core/service/presence/presence_service.py

@@ -38,22 +38,26 @@ class OboPresenceService:
     * Delete a created presence feed
     """
 
-    def __init__(self, presence_api: PresenceApi, auth_session: AuthSession, retry_config: BdkRetryConfig):
+    def __init__(
+        self, presence_api: PresenceApi, auth_session: AuthSession, retry_config: BdkRetryConfig
+    ):
         self._presence_api = presence_api
         self._auth_session = auth_session
         self._retry_config = retry_config
 
     @retry
     async def get_presence(self) -> V2Presence:
-        """ Get the online status (presence info) of the calling user.
+        """Get the online status (presence info) of the calling user.
         See: `Get Presence <https://developers.symphony.com/restapi/reference/get-presence>`_.
 
         :return: Presence info of the calling user.
         """
-        return await self._presence_api.v2_user_presence_get(session_token=await self._auth_session.session_token)
+        return await self._presence_api.v2_user_presence_get(
+            session_token=await self._auth_session.session_token
+        )
 
     async def get_all_presence(self, last_user_id: int, limit: int) -> List[V2Presence]:
-        """ Get the presence info of all users in a pod.
+        """Get the presence info of all users in a pod.
         See: `Get All Presence <https://developers.symphony.com/restapi/reference/get-all-presence>`_.
 
         :param last_user_id: Last user ID retrieved, used for paging. If provided, results skip users with IDs less
@@ -64,12 +68,13 @@ class OboPresenceService:
         presence_list = await self._presence_api.v2_users_presence_get(
             session_token=await self._auth_session.session_token,
             last_user_id=last_user_id,
-            limit=limit)
+            limit=limit,
+        )
         return presence_list.value
 
     @retry
     async def get_user_presence(self, user_id: int, local: bool) -> V2Presence:
-        """ Get the presence info of a specified user.
+        """Get the presence info of a specified user.
         See: `Get User Presence <https://developers.symphony.com/restapi/reference/user-presence-v3>`_.
 
         :param user_id: User Id
@@ -78,24 +83,25 @@ class OboPresenceService:
           connected to the calling user.
         :return: Presence info of the looked up user.
         """
-        return await self._presence_api.v3_user_uid_presence_get(uid=user_id,
-                                                                 session_token=await self._auth_session.session_token,
-                                                                 local=local)
+        return await self._presence_api.v3_user_uid_presence_get(
+            uid=user_id, session_token=await self._auth_session.session_token, local=local
+        )
 
     @retry
     async def external_presence_interest(self, user_ids: List[int]):
-        """ Register interest in a list of external users to get their presence info.
+        """Register interest in a list of external users to get their presence info.
         See: `External Presence Interest
         <https://developers.symphony.com/restapi/reference/register-user-presence-interest>`_.
 
         :param user_ids: List of user ids to be registered.
         """
-        await self._presence_api.v1_user_presence_register_post(session_token=await self._auth_session.session_token,
-                                                                uid_list=user_ids)
+        await self._presence_api.v1_user_presence_register_post(
+            session_token=await self._auth_session.session_token, uid_list=user_ids
+        )
 
     @retry
     async def set_presence(self, status: PresenceStatus, soft: bool) -> V2Presence:
-        """ Set the presence info of the calling user.
+        """Set the presence info of the calling user.
         See: `Set Presence <https://developers.symphony.com/restapi/reference/set-presence>`_.
 
         :param status: The new presence state for the user.
@@ -108,13 +114,15 @@ class OboPresenceService:
         :return: Presence info of the calling user.
         """
         presence_status: V2PresenceStatus = V2PresenceStatus(category=status.name)
-        return await self._presence_api.v2_user_presence_post(session_token=await self._auth_session.session_token,
-                                                              presence=presence_status,
-                                                              soft=soft)
+        return await self._presence_api.v2_user_presence_post(
+            session_token=await self._auth_session.session_token,
+            presence=presence_status,
+            soft=soft,
+        )
 
     @retry
     async def create_presence_feed(self) -> str:
-        """ Creates a new stream capturing online status changes ("presence feed") for the company (pod) and returns
+        """Creates a new stream capturing online status changes ("presence feed") for the company (pod) and returns
         the ID of the new feed. The feed will return the presence of users whose presence status has changed since it
         was last read.
         See: `Create Presence Feed <https://developers.symphony.com/restapi/reference/create-presence-feed>`_.
@@ -122,12 +130,13 @@ class OboPresenceService:
         :return: Presence feed Id
         """
         string_id = await self._presence_api.v1_presence_feed_create_post(
-            session_token=await self._auth_session.session_token)
+            session_token=await self._auth_session.session_token
+        )
         return string_id.id
 
     @retry
     async def read_presence_feed(self, feed_id: str) -> List[V2Presence]:
-        """ Reads the specified presence feed that was created.
+        """Reads the specified presence feed that was created.
         The feed returned includes the user presence statuses that have changed since they were last read.
         See: `Read Presence Feed <https://developers.symphony.com/restapi/reference/read-presence-feed>`_.
 
@@ -135,25 +144,28 @@ class OboPresenceService:
         :return: The list of user presences has changed since the last presence read.
         """
         presence_list = await self._presence_api.v1_presence_feed_feed_id_read_get(
-            session_token=await self._auth_session.session_token,
-            feed_id=feed_id)
+            session_token=await self._auth_session.session_token, feed_id=feed_id
+        )
         return presence_list.value
 
     @retry
     async def delete_presence_feed(self, feed_id: str) -> str:
-        """ Delete the specified presence feed that was created.
+        """Delete the specified presence feed that was created.
         See: `Delete Presence Feed <https://developers.symphony.com/restapi/reference/delete-presence-feed>`_.
 
         :param feed_id: The presence feed id to be deleted.
         :return: The id of the deleted presence feed.
         """
         string_id = await self._presence_api.v1_presence_feed_feed_id_delete_post(
-            session_token=await self._auth_session.session_token, feed_id=feed_id)
+            session_token=await self._auth_session.session_token, feed_id=feed_id
+        )
         return string_id.id
 
     @retry
-    async def set_user_presence(self, user_id: int, status: PresenceStatus, soft: bool) -> V2Presence:
-        """ Set the presence state of a another user.
+    async def set_user_presence(
+        self, user_id: int, status: PresenceStatus, soft: bool
+    ) -> V2Presence:
+        """Set the presence state of a another user.
         See: `Set Other User's Presence - Admin V3
         <https://developers.symphony.com/restapi/reference/set-user-presence>`_.
 
@@ -168,9 +180,9 @@ class OboPresenceService:
         :return: The presence info of the specified user.
         """
         user_presence: V2UserPresence = V2UserPresence(category=status.name, user_id=user_id)
-        return await self._presence_api.v3_user_presence_post(session_token=await self._auth_session.session_token,
-                                                              presence=user_presence,
-                                                              soft=soft)
+        return await self._presence_api.v3_user_presence_post(
+            session_token=await self._auth_session.session_token, presence=user_presence, soft=soft
+        )
 
 
 class PresenceService(OboPresenceService):