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

symphony/bdk/gen/agent_api/datafeed_api.py

@@ -3,7 +3,7 @@
 
     This document refers to Symphony API calls to send and receive messages and content. They need the on-premise Agent installed to perform decryption/encryption of content.  - sessionToken and keyManagerToken can be obtained by calling the authenticationAPI on the symphony back end and the key manager respectively. Refer to the methods described in authenticatorAPI.yaml. - Actions are defined to be atomic, ie will succeed in their entirety or fail and have changed nothing. - If it returns a 40X status then it will have sent no message to any stream even if a request to some subset of the requested streams would have succeeded. - If this contract cannot be met for any reason then this is an error and the response code will be 50X. - MessageML is a markup language for messages. See reference here: https://rest-api.symphony.com/docs/messagemlv2 - **Real Time Events**: The following events are returned when reading from a real time messages and events stream (\"datafeed\"). These events will be returned for datafeeds created with the v5 endpoints. To know more about the endpoints, refer to Create Messages/Events Stream and Read Messages/Events Stream. Unless otherwise specified, all events were added in 1.46.   # noqa: E501
 
-    The version of the OpenAPI document: 22.9.1
+    The version of the OpenAPI document: 24.12.1
     Generated by: https://openapi-generator.tech
 """
 
@@ -31,7 +31,6 @@ from symphony.bdk.gen.agent_model.v4_event_list import V4EventList
 from symphony.bdk.gen.agent_model.v5_datafeed import V5Datafeed
 from symphony.bdk.gen.agent_model.v5_datafeed_create_body import V5DatafeedCreateBody
 from symphony.bdk.gen.agent_model.v5_event_list import V5EventList
-from symphony.bdk.gen.agent_model.v5_events_read_body import V5EventsReadBody
 
 
 class DatafeedApi(object):
@@ -62,7 +61,6 @@ class DatafeedApi(object):
                 ],
                 'required': [
                     'session_token',
-                    'key_manager_token',
                 ],
                 'nullable': [
                 ],
@@ -124,7 +122,6 @@ class DatafeedApi(object):
                 'required': [
                     'datafeed_id',
                     'session_token',
-                    'key_manager_token',
                 ],
                 'nullable': [
                 ],
@@ -184,7 +181,6 @@ class DatafeedApi(object):
                 ],
                 'required': [
                     'session_token',
-                    'key_manager_token',
                 ],
                 'nullable': [
                 ],
@@ -250,7 +246,6 @@ class DatafeedApi(object):
                 'required': [
                     'datafeed_id',
                     'session_token',
-                    'key_manager_token',
                 ],
                 'nullable': [
                 ],
@@ -298,68 +293,6 @@ class DatafeedApi(object):
             },
             api_client=api_client
         )
-        self.read_events_endpoint = _Endpoint(
-            settings={
-                'response_type': (V5EventList,),
-                'auth': [],
-                'endpoint_path': '/v5/events/read',
-                'operation_id': 'read_events',
-                'http_method': 'POST',
-                'servers': None,
-            },
-            params_map={
-                'all': [
-                    'session_token',
-                    'key_manager_token',
-                    'body',
-                ],
-                'required': [
-                    'session_token',
-                    'key_manager_token',
-                    'body',
-                ],
-                'nullable': [
-                ],
-                'enum': [
-                ],
-                'validation': [
-                ]
-            },
-            root_map={
-                'validations': {
-                },
-                'allowed_values': {
-                },
-                'openapi_types': {
-                    'session_token':
-                        (str,),
-                    'key_manager_token':
-                        (str,),
-                    'body':
-                        (V5EventsReadBody,),
-                },
-                'attribute_map': {
-                    'session_token': 'sessionToken',
-                    'key_manager_token': 'keyManagerToken',
-                },
-                'location_map': {
-                    'session_token': 'header',
-                    'key_manager_token': 'header',
-                    'body': 'body',
-                },
-                'collection_format_map': {
-                }
-            },
-            headers_map={
-                'accept': [
-                    'application/json'
-                ],
-                'content_type': [
-                    'application/json'
-                ]
-            },
-            api_client=api_client
-        )
         self.v1_datafeed_create_post_endpoint = _Endpoint(
             settings={
                 'response_type': (Datafeed,),
@@ -376,7 +309,6 @@ class DatafeedApi(object):
                 ],
                 'required': [
                     'session_token',
-                    'key_manager_token',
                 ],
                 'nullable': [
                 ],
@@ -428,13 +360,12 @@ class DatafeedApi(object):
                 'all': [
                     'id',
                     'session_token',
-                    'key_manager_token',
                     'max_messages',
+                    'key_manager_token',
                 ],
                 'required': [
                     'id',
                     'session_token',
-                    'key_manager_token',
                 ],
                 'nullable': [
                 ],
@@ -453,22 +384,22 @@ class DatafeedApi(object):
                         (str,),
                     'session_token':
                         (str,),
-                    'key_manager_token':
-                        (str,),
                     'max_messages':
                         (int,),
+                    'key_manager_token':
+                        (str,),
                 },
                 'attribute_map': {
                     'id': 'id',
                     'session_token': 'sessionToken',
-                    'key_manager_token': 'keyManagerToken',
                     'max_messages': 'maxMessages',
+                    'key_manager_token': 'keyManagerToken',
                 },
                 'location_map': {
                     'id': 'path',
                     'session_token': 'header',
-                    'key_manager_token': 'header',
                     'max_messages': 'query',
+                    'key_manager_token': 'header',
                 },
                 'collection_format_map': {
                 }
@@ -494,13 +425,12 @@ class DatafeedApi(object):
                 'all': [
                     'id',
                     'session_token',
-                    'key_manager_token',
                     'max_messages',
+                    'key_manager_token',
                 ],
                 'required': [
                     'id',
                     'session_token',
-                    'key_manager_token',
                 ],
                 'nullable': [
                 ],
@@ -519,22 +449,22 @@ class DatafeedApi(object):
                         (str,),
                     'session_token':
                         (str,),
-                    'key_manager_token':
-                        (str,),
                     'max_messages':
                         (int,),
+                    'key_manager_token':
+                        (str,),
                 },
                 'attribute_map': {
                     'id': 'id',
                     'session_token': 'sessionToken',
-                    'key_manager_token': 'keyManagerToken',
                     'max_messages': 'maxMessages',
+                    'key_manager_token': 'keyManagerToken',
                 },
                 'location_map': {
                     'id': 'path',
                     'session_token': 'header',
-                    'key_manager_token': 'header',
                     'max_messages': 'query',
+                    'key_manager_token': 'header',
                 },
                 'collection_format_map': {
                 }
@@ -563,7 +493,6 @@ class DatafeedApi(object):
                 ],
                 'required': [
                     'session_token',
-                    'key_manager_token',
                 ],
                 'nullable': [
                 ],
@@ -615,13 +544,12 @@ class DatafeedApi(object):
                 'all': [
                     'id',
                     'session_token',
-                    'key_manager_token',
                     'limit',
+                    'key_manager_token',
                 ],
                 'required': [
                     'id',
                     'session_token',
-                    'key_manager_token',
                 ],
                 'nullable': [
                 ],
@@ -640,22 +568,22 @@ class DatafeedApi(object):
                         (str,),
                     'session_token':
                         (str,),
-                    'key_manager_token':
-                        (str,),
                     'limit':
                         (int,),
+                    'key_manager_token':
+                        (str,),
                 },
                 'attribute_map': {
                     'id': 'id',
                     'session_token': 'sessionToken',
-                    'key_manager_token': 'keyManagerToken',
                     'limit': 'limit',
+                    'key_manager_token': 'keyManagerToken',
                 },
                 'location_map': {
                     'id': 'path',
                     'session_token': 'header',
-                    'key_manager_token': 'header',
                     'limit': 'query',
+                    'key_manager_token': 'header',
                 },
                 'collection_format_map': {
                 }
@@ -672,7 +600,6 @@ class DatafeedApi(object):
     def create_datafeed(
         self,
         session_token,
-        key_manager_token,
         **kwargs
     ):
         """Create a new real time messages / events stream (\"datafeed\").  # noqa: E501
@@ -681,14 +608,14 @@ class DatafeedApi(object):
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = agent_api.create_datafeed(session_token, key_manager_token, async_req=True)
+        >>> thread = agent_api.create_datafeed(session_token, async_req=True)
         >>> result = thread.get()
 
         Args:
             session_token (str): Session authentication token.
-            key_manager_token (str): Key Manager authentication token.
 
         Keyword Args:
+            key_manager_token (str): Key Manager authentication token.. [optional]
             body (V5DatafeedCreateBody): [optional]
             _return_http_data_only (bool): response data without head status
                 code and headers. Default is True.
@@ -748,15 +675,12 @@ class DatafeedApi(object):
         kwargs['_host_index'] = kwargs.get('_host_index')
         kwargs['session_token'] = \
             session_token
-        kwargs['key_manager_token'] = \
-            key_manager_token
         return self.create_datafeed_endpoint.call_with_http_info(**kwargs)
 
     def delete_datafeed(
         self,
         datafeed_id,
         session_token,
-        key_manager_token,
         **kwargs
     ):
         """Delete the specified real time message / event stream (\"datafeed\").  # noqa: E501
@@ -765,15 +689,15 @@ class DatafeedApi(object):
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = agent_api.delete_datafeed(datafeed_id, session_token, key_manager_token, async_req=True)
+        >>> thread = agent_api.delete_datafeed(datafeed_id, session_token, async_req=True)
         >>> result = thread.get()
 
         Args:
             datafeed_id (str): ID of the datafeed
             session_token (str): Session authentication token.
-            key_manager_token (str): Key Manager authentication token.
 
         Keyword Args:
+            key_manager_token (str): Key Manager authentication token.. [optional]
             _return_http_data_only (bool): response data without head status
                 code and headers. Default is True.
             _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -834,14 +758,11 @@ class DatafeedApi(object):
             datafeed_id
         kwargs['session_token'] = \
             session_token
-        kwargs['key_manager_token'] = \
-            key_manager_token
         return self.delete_datafeed_endpoint.call_with_http_info(**kwargs)
 
     def list_datafeed(
         self,
         session_token,
-        key_manager_token,
         **kwargs
     ):
         """Read list of real time messages / events stream (\"datafeed\").  # noqa: E501
@@ -850,14 +771,14 @@ class DatafeedApi(object):
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = agent_api.list_datafeed(session_token, key_manager_token, async_req=True)
+        >>> thread = agent_api.list_datafeed(session_token, async_req=True)
         >>> result = thread.get()
 
         Args:
             session_token (str): Session authentication token.
-            key_manager_token (str): Key Manager authentication token.
 
         Keyword Args:
+            key_manager_token (str): Key Manager authentication token.. [optional]
             tag (str): A unique identifier to ensure uniqueness of the datafeed. Used to restrict search.. [optional]
             _return_http_data_only (bool): response data without head status
                 code and headers. Default is True.
@@ -917,15 +838,12 @@ class DatafeedApi(object):
         kwargs['_host_index'] = kwargs.get('_host_index')
         kwargs['session_token'] = \
             session_token
-        kwargs['key_manager_token'] = \
-            key_manager_token
         return self.list_datafeed_endpoint.call_with_http_info(**kwargs)
 
     def read_datafeed(
         self,
         datafeed_id,
         session_token,
-        key_manager_token,
         **kwargs
     ):
         """Read the specified real time message / event stream (\"datafeed\").  # noqa: E501
@@ -934,15 +852,15 @@ class DatafeedApi(object):
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = agent_api.read_datafeed(datafeed_id, session_token, key_manager_token, async_req=True)
+        >>> thread = agent_api.read_datafeed(datafeed_id, session_token, async_req=True)
         >>> result = thread.get()
 
         Args:
             datafeed_id (str): ID of the datafeed
             session_token (str): Session authentication token.
-            key_manager_token (str): Key Manager authentication token.
 
         Keyword Args:
+            key_manager_token (str): Key Manager authentication token.. [optional]
             ack_id (AckId): ackId received from last POST Base64 encoded.. [optional]
             _return_http_data_only (bool): response data without head status
                 code and headers. Default is True.
@@ -1004,100 +922,11 @@ class DatafeedApi(object):
             datafeed_id
         kwargs['session_token'] = \
             session_token
-        kwargs['key_manager_token'] = \
-            key_manager_token
         return self.read_datafeed_endpoint.call_with_http_info(**kwargs)
 
-    def read_events(
-        self,
-        session_token,
-        key_manager_token,
-        body,
-        **kwargs
-    ):
-        """Read Real Time Events from an event stream (aka datafeed)  # noqa: E501
-
-        _Available on Agent 22.5.1 and above.This endpoint provides messages and events from all conversations that the user is in or events from the whole pod depending on the \"type\" field value. When \"type\":\"fanout\" is provided in the body, then only events from streams  the accountbelongs to are returned. Otherwise, if \"type\": \"datahose\" is provided in the body, then events returned are not limited to the streams user belongs to. In this case, at least one event type must be provided in the \"filters\" field. In case you are using a datahose feed and retrieving SOCIALMESSAGE events, ceservice account must be properly configured in the Agent.The types of events returned can be found in the Real Time Events list (see definition on top of the file). The ackId sent as parameter can be empty for the first call. In the response an ackId will be sent back and it can be used for the next call: in this way you acknowledge that you have received the events that came with that ackId. If you have several instances of the same bot, they must share the same feed so  that events are spread across all bot instances. To do so, you must: share the same  service account provide the same \"tag\" and same \"filters\" values   # noqa: E501
-        This method makes a synchronous HTTP request by default. To make an
-        asynchronous HTTP request, please pass async_req=True
-
-        >>> thread = agent_api.read_events(session_token, key_manager_token, body, async_req=True)
-        >>> result = thread.get()
-
-        Args:
-            session_token (str): Session authentication token.
-            key_manager_token (str): Key Manager authentication token.
-            body (V5EventsReadBody): body containing all information of events to be fetched
-
-        Keyword Args:
-            _return_http_data_only (bool): response data without head status
-                code and headers. Default is True.
-            _preload_content (bool): if False, the urllib3.HTTPResponse object
-                will be returned without reading/decoding response data.
-                Default is True.
-            _request_timeout (int/float/tuple): timeout setting for this request. If
-                one number provided, it will be total request timeout. It can also
-                be a pair (tuple) of (connection, read) timeouts.
-                Default is None.
-            _check_input_type (bool): specifies if type checking
-                should be done one the data sent to the server.
-                Default is True.
-            _check_return_type (bool): specifies if type checking
-                should be done one the data received from the server.
-                Default is True.
-            _spec_property_naming (bool): True if the variable names in the input data
-                are serialized names, as specified in the OpenAPI document.
-                False if the variable names in the input data
-                are pythonic names, e.g. snake case (default)
-            _content_type (str/None): force body content-type.
-                Default is None and content-type will be predicted by allowed
-                content-types and body.
-            _host_index (int/None): specifies the index of the server
-                that we want to use.
-                Default is read from the configuration.
-            async_req (bool): execute request asynchronously
-
-        Returns:
-            V5EventList
-                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['key_manager_token'] = \
-            key_manager_token
-        kwargs['body'] = \
-            body
-        return self.read_events_endpoint.call_with_http_info(**kwargs)
-
     def v1_datafeed_create_post(
         self,
         session_token,
-        key_manager_token,
         **kwargs
     ):
         """Create a new real time message event stream.  # noqa: E501
@@ -1106,14 +935,14 @@ class DatafeedApi(object):
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = agent_api.v1_datafeed_create_post(session_token, key_manager_token, async_req=True)
+        >>> thread = agent_api.v1_datafeed_create_post(session_token, async_req=True)
         >>> result = thread.get()
 
         Args:
             session_token (str): Session authentication token.
-            key_manager_token (str): Key Manager authentication token.
 
         Keyword Args:
+            key_manager_token (str): Key Manager authentication token.. [optional]
             _return_http_data_only (bool): response data without head status
                 code and headers. Default is True.
             _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -1172,15 +1001,12 @@ class DatafeedApi(object):
         kwargs['_host_index'] = kwargs.get('_host_index')
         kwargs['session_token'] = \
             session_token
-        kwargs['key_manager_token'] = \
-            key_manager_token
         return self.v1_datafeed_create_post_endpoint.call_with_http_info(**kwargs)
 
     def v1_datafeed_id_read_get(
         self,
         id,
         session_token,
-        key_manager_token,
         **kwargs
     ):
         """Read a given datafeed.  # noqa: E501
@@ -1189,16 +1015,16 @@ class DatafeedApi(object):
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = agent_api.v1_datafeed_id_read_get(id, session_token, key_manager_token, async_req=True)
+        >>> thread = agent_api.v1_datafeed_id_read_get(id, session_token, async_req=True)
         >>> result = thread.get()
 
         Args:
             id (str): Datafeed ID
             session_token (str): Session authentication token.
-            key_manager_token (str): Key Manager authentication token.
 
         Keyword Args:
             max_messages (int): Max No. of messages to return.. [optional]
+            key_manager_token (str): Key Manager authentication token.. [optional]
             _return_http_data_only (bool): response data without head status
                 code and headers. Default is True.
             _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -1259,15 +1085,12 @@ class DatafeedApi(object):
             id
         kwargs['session_token'] = \
             session_token
-        kwargs['key_manager_token'] = \
-            key_manager_token
         return self.v1_datafeed_id_read_get_endpoint.call_with_http_info(**kwargs)
 
     def v2_datafeed_id_read_get(
         self,
         id,
         session_token,
-        key_manager_token,
         **kwargs
     ):
         """Read a given datafeed.  # noqa: E501
@@ -1276,16 +1099,16 @@ class DatafeedApi(object):
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = agent_api.v2_datafeed_id_read_get(id, session_token, key_manager_token, async_req=True)
+        >>> thread = agent_api.v2_datafeed_id_read_get(id, session_token, async_req=True)
         >>> result = thread.get()
 
         Args:
             id (str): Datafeed ID
             session_token (str): Session authentication token.
-            key_manager_token (str): Key Manager authentication token.
 
         Keyword Args:
             max_messages (int): Max No. of messages to return.. [optional]
+            key_manager_token (str): Key Manager authentication token.. [optional]
             _return_http_data_only (bool): response data without head status
                 code and headers. Default is True.
             _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -1346,14 +1169,11 @@ class DatafeedApi(object):
             id
         kwargs['session_token'] = \
             session_token
-        kwargs['key_manager_token'] = \
-            key_manager_token
         return self.v2_datafeed_id_read_get_endpoint.call_with_http_info(**kwargs)
 
     def v4_datafeed_create_post(
         self,
         session_token,
-        key_manager_token,
         **kwargs
     ):
         """(Deprecated - Datafeed v1 will be fully replaced by the datafeed 2 service in the future. Please consider migrating over to datafeed 2 APIs /agent/v5/datafeeds. For more information on the timeline as well as on the benefits of datafeed 2, please reach out to your Technical Account Manager or to our developer documentation https://docs.developers.symphony.com/building-bots-on-symphony/datafeed) Create a new real time message event stream.   # noqa: E501
@@ -1362,14 +1182,14 @@ class DatafeedApi(object):
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = agent_api.v4_datafeed_create_post(session_token, key_manager_token, async_req=True)
+        >>> thread = agent_api.v4_datafeed_create_post(session_token, async_req=True)
         >>> result = thread.get()
 
         Args:
             session_token (str): Session authentication token.
-            key_manager_token (str): Key Manager authentication token.
 
         Keyword Args:
+            key_manager_token (str): Key Manager authentication token.. [optional]
             _return_http_data_only (bool): response data without head status
                 code and headers. Default is True.
             _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -1428,15 +1248,12 @@ class DatafeedApi(object):
         kwargs['_host_index'] = kwargs.get('_host_index')
         kwargs['session_token'] = \
             session_token
-        kwargs['key_manager_token'] = \
-            key_manager_token
         return self.v4_datafeed_create_post_endpoint.call_with_http_info(**kwargs)
 
     def v4_datafeed_id_read_get(
         self,
         id,
         session_token,
-        key_manager_token,
         **kwargs
     ):
         """(Deprecated - Datafeed v1 will be fully replaced by the datafeed 2 service in the future.  Please consider migrating over to datafeed 2 APIs /agent/v5/datafeeds/{id}/read. For more information on the timeline as well as on the benefits of datafeed 2, please reach out to your Technical Account Manager or to our developer documentation https://docs.developers.symphony.com/building-bots-on-symphony/datafeed) Read a given datafeed.   # noqa: E501
@@ -1445,16 +1262,16 @@ class DatafeedApi(object):
         This method makes a synchronous HTTP request by default. To make an
         asynchronous HTTP request, please pass async_req=True
 
-        >>> thread = agent_api.v4_datafeed_id_read_get(id, session_token, key_manager_token, async_req=True)
+        >>> thread = agent_api.v4_datafeed_id_read_get(id, session_token, async_req=True)
         >>> result = thread.get()
 
         Args:
             id (str): Datafeed ID
             session_token (str): Session authentication token.
-            key_manager_token (str): Key Manager authentication token.
 
         Keyword Args:
             limit (int): Max No. of messages to return.. [optional]
+            key_manager_token (str): Key Manager authentication token.. [optional]
             _return_http_data_only (bool): response data without head status
                 code and headers. Default is True.
             _preload_content (bool): if False, the urllib3.HTTPResponse object
@@ -1515,7 +1332,5 @@ class DatafeedApi(object):
             id
         kwargs['session_token'] = \
             session_token
-        kwargs['key_manager_token'] = \
-            key_manager_token
         return self.v4_datafeed_id_read_get_endpoint.call_with_http_info(**kwargs)