Merge pull request #157 from livechat/ME-87/deleting_messages

ME-87: Add new method delete_event in customer api v3.6. Fix api vers…

Author: zuczkows

changelog.md

@@ -3,6 +3,9 @@ All notable changes to this project will be documented in this file.
 
 ## [0.4.2] - TBA
 
+### Added
+- New method `delete_event` in customer-api v3.6.
+
 ### Changed
 - Improved websocket response collection + extended logging in the websocket client.
 

livechat/customer/rtm/api/v34.py

@@ -20,7 +20,7 @@ def __init__(
         if isinstance(organization_id, str):
             self.ws = WebsocketClient(
                 url=
-                f'wss://{base_url}/v3.5/customer/rtm/ws?organization_id={organization_id}',
+                f'wss://{base_url}/v3.4/customer/rtm/ws?organization_id={organization_id}',
                 header=header)
         else:
             raise ValueError(

livechat/customer/rtm/api/v36.py

@@ -20,7 +20,7 @@ def __init__(
         if isinstance(organization_id, str):
             self.ws = WebsocketClient(
                 url=
-                f'wss://{base_url}/v3.5/customer/rtm/ws?organization_id={organization_id}',
+                f'wss://{base_url}/v3.6/customer/rtm/ws?organization_id={organization_id}',
                 header=header)
         else:
             raise ValueError(
@@ -214,6 +214,28 @@ def send_event(self,
             payload = prepare_payload(locals())
         return self.ws.send({'action': 'send_event', 'payload': payload})
 
+    def delete_event(self,
+                     chat_id: str = None,
+                     thread_id: str = None,
+                     event_id: str = None,
+                     payload: dict = None) -> RtmResponse:
+        ''' Deletes an event.
+
+            Args:
+                chat_id (str): ID of the chat from which to delete the event.
+                thread_id (str): ID of the thread from which to delete the event.
+                event_id (str): ID of the event to be deleted.
+                payload (dict): Custom payload to be used as request's data.
+                        It overrides all other parameters provided for the method.
+
+            Returns:
+                RtmResponse: RTM response structure (`request_id`, `action`,
+                             `type`, `success` and `payload` properties)
+        '''
+        if payload is None:
+            payload = prepare_payload(locals())
+        return self.ws.send({'action': 'delete_event', 'payload': payload})
+
     def send_rich_message_postback(self,
                                    chat_id: str = None,
                                    thread_id: str = None,

livechat/customer/web/api/v36.py

@@ -312,6 +312,35 @@ def send_event(self,
             json=payload,
             headers=headers)
 
+    def delete_event(self,
+                     chat_id: str = None,
+                     thread_id: str = None,
+                     event_id: str = None,
+                     payload: dict = None,
+                     headers: dict = None) -> httpx.Response:
+        ''' Deletes an event.
+
+            Args:
+                chat_id (str): ID of the chat from which to delete the event.
+                thread_id (str): ID of the thread from which to delete the event.
+                event_id (str): ID of the event to be deleted.
+
+                payload (dict): Custom payload to be used as request's data.
+                                It overrides all other parameters provided for the method.
+                headers (dict): Custom headers to be used with session headers.
+                                They will be merged with session-level values that are set,
+                                however, these method-level parameters will not be persisted across requests.
+
+            Returns:
+                httpx.Response: The Response object from `httpx` library,
+                                which contains a server’s response to an HTTP request. '''
+        if payload is None:
+            payload = prepare_payload(locals())
+        return self.session.post(
+            f'{self.api_url}/delete_event{self.query_string}',
+            json=payload,
+            headers=headers)
+
     def upload_file(self,
                     file: typing.BinaryIO = None,
                     headers: dict = None) -> httpx.Response: