Merge branch 'master' into API-10483-refactor-customer-rtm-api

examples/agent_rtm_example.py

@@ -1,6 +1,6 @@
 ''' Agent RTM client example usage. '''
 
-from livechat.agent.rtm.client import AgentRTM
+from livechat.agent.rtm.base import AgentRTM
 
 agent_rtm = AgentRTM.get_client()
 agent_rtm.open_connection()

examples/customer_web_example.py

@@ -1,6 +1,6 @@
 ''' Customer WEB client example usage. '''
 
-from livechat.customer.web.client import CustomerWeb
+from livechat.customer.web.base import CustomerWeb
 
 customer_web = CustomerWeb.get_client(license_id=12345,
                                       access_token='<your access token>')

livechat/agent/__init__.py

@@ -1,3 +1,3 @@
 # pylint: disable=C0114
-from livechat.agent.rtm.client import AgentRTM
+from livechat.agent.rtm.base import AgentRTM
 from livechat.agent.web.base import AgentWeb

livechat/agent/rtm/base.py

@@ -0,0 +1,43 @@
+''' Agent RTM client implementation. '''
+
+# pylint: disable=W0613,W0622,C0103,R0913,R0903,W0107,W0221
+from __future__ import annotations
+
+from typing import Union
+
+from livechat.agent.rtm.api.v33 import AgentRtmV33
+from livechat.agent.rtm.api.v34 import AgentRtmV34
+from livechat.agent.rtm.api.v35 import AgentRtmV35
+from livechat.config import CONFIG
+
+stable_version = CONFIG.get('stable')
+api_url = CONFIG.get('url')
+
+
+class AgentRTM:
+    ''' Main class that gets specific client. '''
+    @staticmethod
+    def get_client(
+        version: str = stable_version,
+        base_url: str = api_url
+    ) -> Union[AgentRtmV33, AgentRtmV34, AgentRtmV35]:
+        ''' Returns client for specific Agent RTM version.
+
+            Args:
+                version (str): API's version. Defaults to the stable version of API.
+                base_url (str): API's base url. Defaults to API's production URL.
+
+            Returns:
+                API client object for specified version.
+
+            Raises:
+                ValueError: If the specified version does not exist.
+        '''
+        client = {
+            '3.3': AgentRtmV33,
+            '3.4': AgentRtmV34,
+            '3.5': AgentRtmV35,
+        }.get(version)
+        if not client:
+            raise ValueError('Provided version does not exist.')
+        return client(base_url)

livechat/customer/__init__.py

@@ -1,3 +1,3 @@
 #pylint: disable=C0114
 from livechat.customer.rtm.base import CustomerRTM
-from livechat.customer.web.client import CustomerWeb
+from livechat.customer.web.base import CustomerWeb