Merge pull request #118 from livechat/LC-1065-add-logout-method-in-agent-web-api

LC-1065: Add logout method in Agent Web API v3.6

Author: skamieniarz

changelog.md

@@ -3,6 +3,10 @@ All notable changes to this project will be documented in this file.
 
 ## [0.3.8] - TBA
 
+### Added
+- Support for `logout` method in agent-api v3.6 web class.
+- Support for `agent_id` parameter in agent-api v3.6 `logout` method.
+
 ### Changed
 - Implemented truncation of request params in logging for large data.
 

livechat/agent/rtm/api/v36.py

@@ -344,7 +344,11 @@ def send_event(self,
             opts['author_id'] = author_id
         if payload is None:
             payload = prepare_payload(locals())
-        return self.ws.send({'action': 'send_event', 'payload': payload, **opts})
+        return self.ws.send({
+            'action': 'send_event',
+            'payload': payload,
+            **opts
+        })
 
     def send_rich_message_postback(self,
                                    chat_id: str = None,
@@ -810,21 +814,23 @@ def set_away_status(self,
             payload = prepare_payload(locals())
         return self.ws.send({'action': 'set_away_status', 'payload': payload})
 
-    def logout(self, payload: dict = None) -> RtmResponse:
-        ''' Logs out agent.
+    def logout(self,
+               agent_id: str = None,
+               payload: dict = None) -> RtmResponse:
+        ''' Logs the Agent out.
 
             Args:
+                agent_id (str): Login of the agent to logout.
                 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)
         '''
-        return self.ws.send({
-            'action': 'logout',
-            'payload': {} if payload is None else payload
-        })
+        if payload is None:
+            payload = prepare_payload(locals())
+        return self.ws.send({'action': 'logout', 'payload': payload})
 
     def list_routing_statuses(self,
                               filters: dict = None,

livechat/agent/web/api/v36.py

@@ -1034,3 +1034,26 @@ def list_agents_for_transfer(self,
         return self.session.post(f'{self.api_url}/list_agents_for_transfer',
                                  json=payload,
                                  headers=headers)
+
+    def logout(self,
+               agent_id: str = None,
+               payload: dict = None,
+               headers: dict = None) -> httpx.Response:
+        ''' Logs the Agent out.
+
+            Args:
+                agent_id (str): Login of the agent to logout.
+                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}/logout',
+                                 json=payload,
+                                 headers=headers)