Merge pull request #169 from livechat/ME-884/add-chat-summary-method

ME-884: Add new method in agent-api v36 and v36 - request_thread_summary

Author: zuczkows

changelog.md

@@ -9,6 +9,7 @@ All notable changes to this project will be documented in this file.
 - New methods in configuration-api v3.6 for greetings: `create_greeting`, `delete_greeting`, `get_greeting`, `update_greeting`, `list_greetings`.
 - New methods in agent-api v3.6: `send_thinking_indicator`, `send_message_preview`.
 - New methods in configuration-api v3.7 for canned responses: `create_canned_response`, `update_canned_response`, `list_canned_responses`, `delete_canned_response`.
+- New method `request_thread_summary` in agent-api v3.6 and v3.7.
 
 ### Changed
 - Config now points to v3.6 as a stable and 3.7 as a dev-preview version.

livechat/agent/rtm/api/v36.py

@@ -404,6 +404,29 @@ def send_rich_message_postback(self,
             'payload': payload
         })
 
+    def request_thread_summary(self,
+                               chat_id: str = None,
+                               thread_id: str = None,
+                               payload: dict = None) -> RtmResponse:
+        ''' Requests a thread summary.
+
+            Args:
+                chat_id (str): ID of the chat to request thread summary for.
+                thread_id (str): ID of the thread to request summary for.
+                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': 'request_thread_summary',
+            'payload': payload
+        })
+
 # Properties
 
     def update_chat_properties(self,

livechat/agent/rtm/api/v37.py

@@ -404,6 +404,29 @@ def send_rich_message_postback(self,
             'payload': payload
         })
 
+    def request_thread_summary(self,
+                               chat_id: str = None,
+                               thread_id: str = None,
+                               payload: dict = None) -> RtmResponse:
+        ''' Requests a thread summary.
+
+            Args:
+                chat_id (str): ID of the chat to request thread summary for.
+                thread_id (str): ID of the thread to request summary for.
+                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': 'request_thread_summary',
+            'payload': payload
+        })
+
 # Properties
 
     def update_chat_properties(self,

livechat/agent/web/api/v36.py

@@ -483,6 +483,31 @@ def send_rich_message_postback(self,
                                  json=payload,
                                  headers=headers)
 
+    def request_thread_summary(self,
+                               chat_id: str = None,
+                               thread_id: str = None,
+                               payload: dict = None,
+                               headers: dict = None) -> httpx.Response:
+        ''' Requests a thread summary.
+
+            Args:
+                chat_id (str): ID of the chat to request thread summary for.
+                thread_id (str): ID of the thread to request summary for.
+                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}/request_thread_summary',
+                                 json=payload,
+                                 headers=headers)
+
 # Properties
 
     def update_chat_properties(self,

livechat/agent/web/api/v37.py

@@ -483,6 +483,31 @@ def send_rich_message_postback(self,
                                  json=payload,
                                  headers=headers)
 
+    def request_thread_summary(self,
+                               chat_id: str = None,
+                               thread_id: str = None,
+                               payload: dict = None,
+                               headers: dict = None) -> httpx.Response:
+        ''' Requests a thread summary.
+
+            Args:
+                chat_id (str): ID of the chat to request thread summary for.
+                thread_id (str): ID of the thread to request summary for.
+                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}/request_thread_summary',
+                                 json=payload,
+                                 headers=headers)
+
 # Properties
 
     def update_chat_properties(self,