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

symphony/bdk/gen/agent_api/datahose_api.py

@@ -0,0 +1,184 @@
+"""
+    Agent API
+
+    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: 24.12.1
+    Generated by: https://openapi-generator.tech
+"""
+
+
+import re  # noqa: F401
+import sys  # noqa: F401
+
+from symphony.bdk.gen.api_client import ApiClient, Endpoint as _Endpoint
+from symphony.bdk.gen.model_utils import (  # noqa: F401
+    check_allowed_values,
+    check_validations,
+    date,
+    datetime,
+    file_type,
+    none_type,
+    validate_and_convert_types
+)
+from symphony.bdk.gen.agent_model.v2_error import V2Error
+from symphony.bdk.gen.agent_model.v5_event_list import V5EventList
+from symphony.bdk.gen.agent_model.v5_events_read_body import V5EventsReadBody
+
+
+class DatahoseApi(object):
+    """NOTE: This class is auto generated by OpenAPI Generator
+    Ref: https://openapi-generator.tech
+
+    Do not edit the class manually.
+    """
+
+    def __init__(self, api_client=None):
+        if api_client is None:
+            api_client = ApiClient()
+        self.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',
+                    'body',
+                    'key_manager_token',
+                ],
+                'required': [
+                    'session_token',
+                    'body',
+                ],
+                'nullable': [
+                ],
+                'enum': [
+                ],
+                'validation': [
+                ]
+            },
+            root_map={
+                'validations': {
+                },
+                'allowed_values': {
+                },
+                'openapi_types': {
+                    'session_token':
+                        (str,),
+                    'body':
+                        (V5EventsReadBody,),
+                    'key_manager_token':
+                        (str,),
+                },
+                'attribute_map': {
+                    'session_token': 'sessionToken',
+                    'key_manager_token': 'keyManagerToken',
+                },
+                'location_map': {
+                    'session_token': 'header',
+                    'body': 'body',
+                    'key_manager_token': 'header',
+                },
+                'collection_format_map': {
+                }
+            },
+            headers_map={
+                'accept': [
+                    'application/json'
+                ],
+                'content_type': [
+                    'application/json'
+                ]
+            },
+            api_client=api_client
+        )
+
+    def read_events(
+        self,
+        session_token,
+        body,
+        **kwargs
+    ):
+        """Creates and Reads a real time feed of messages and events of your pod (Datahose)  # noqa: E501
+
+        _Available on Agent 22.5.1 and above._  This API provides a real time feed of all the messages and events in the pod,  even from conversations where the calling service user is not a member. The types of events surfaced  can be found in the Real Time Events list. In case you retrieving SOCIALMESSAGE events, the credentials of the 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.  The Datahose API is an add-on to the Symphony Services, and is subject to additional charges.  Prior to using Datahose in your Symphony environment(s), you will need to enter into a specific contract.   # 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, body, async_req=True)
+        >>> result = thread.get()
+
+        Args:
+            session_token (str): Session authentication token.
+            body (V5EventsReadBody):
+
+        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
+                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['body'] = \
+            body
+        return self.read_events_endpoint.call_with_http_info(**kwargs)
+