Merge pull request #96 from livechat/API-11765-remove-list-customers-from-v36

API-11765: Remove support for list_customers method in agent-api v3.6 classes

Author: skamieniarz

changelog.md

@@ -6,6 +6,10 @@ All notable changes to this project will be documented in this file.
 ### Bugfixes
 - Fix `customer_monitoring_level` parameter in `login` method in agent-api v3.3/v3.4/v3.5 classes.
 
+### Removed
+
+- Support for `list_customers` method in agent-api v3.6 classes.
+
 ## [0.3.5] - 2022-11-25
 
 ### Added

livechat/agent/rtm/api/v36.py

@@ -586,34 +586,6 @@ def get_customer(self,
             payload = prepare_payload(locals())
         return self.ws.send({'action': 'get_customer', 'payload': payload})
 
-    def list_customers(self,
-                       page_id: str = None,
-                       limit: int = None,
-                       sort_order: str = None,
-                       sort_by: str = None,
-                       filters: dict = None,
-                       payload: dict = None) -> RtmResponse:
-        ''' Returns the list of Customers.
-
-            Args:
-                page_id (str): Page ID.
-                limit (int): Customers limit. Default: 10, maximum: 100.
-                sort_order (str): Possible values: asc, desc (default). Customers are sorted
-                        by the creation date.
-                sort_by (str): Possible values: created_at (default), threads_count, visits_count,
-                        agent_last_event or customer_last_event.
-                filters (dict): Filters object.
-                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': 'list_customers', 'payload': payload})
-
     def create_customer(self,
                         name: str = None,
                         email: str = None,

livechat/agent/web/api/v36.py

@@ -728,41 +728,6 @@ def get_customer(self,
                                  json=payload,
                                  headers=headers)
 
-    def list_customers(self,
-                       page_id: str = None,
-                       limit: str = None,
-                       sort_order: str = None,
-                       sort_by: str = None,
-                       filters: dict = None,
-                       payload: dict = None,
-                       headers: dict = None) -> httpx.Response:
-        ''' Returns the list of Customers.
-
-            Args:
-                page_id (str): ID of the page with paginated results.
-                limit (str): Limit of results per page. Default: 10, maximum: 100.
-                sort_order (str): Possible values: asc, desc (default).
-                sort_by (str): When sorting by fields other than created_at, the entries
-                               with identical values will be additionally sorted by their
-                               creation time. Possible values: created_at (default),
-                               threads_count, visits_count, agent_last_event, customer_last_event.
-                filters (dict): Possible request filters.
-                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}/list_customers',
-                                 json=payload,
-                                 headers=headers)
-
     def create_customer(self,
                         name: str = None,
                         email: str = None,