Merge branch 'master' into API-9951-set-v34-as-stable-and-create-v35

Author: skamieniarz

changelog.md

@@ -1,11 +1,13 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [TBD] - 2022-01-TBD
+
+## [TBD] - Unreleased
 
 ### Added
 - API stable version 3.4 as a default.
 - API dev preview version 3.5 support.
+- Proxy support to web interfaces.
 
 ## [0.1.10] - 2021-12-02
 

livechat/agent/web/client.py

@@ -56,16 +56,23 @@ def get_client(access_token: str,
 
 class AgentWebInterface(metaclass=ABCMeta):
     ''' Main class containing API methods. '''
-    def __init__(self, access_token: str, version: str, base_url: str,
-                 http2: bool) -> AgentWebInterface:
+    def __init__(self,
+                 access_token: str,
+                 version: str,
+                 base_url: str,
+                 http2: bool,
+                 proxies=None,
+                 verify: bool = True) -> AgentWebInterface:
         logger = HttpxLogger()
         self.api_url = f'https://{base_url}/v{version}/agent/action'
         self.session = httpx.Client(http2=http2,
                                     headers={'Authorization': access_token},
                                     event_hooks={
                                         'request': [logger.log_request],
                                         'response': [logger.log_response]
-                                    })
+                                    },
+                                    proxies=proxies,
+                                    verify=verify)
 
     def modify_header(self, header: dict) -> None:
         ''' Modifies provided header in session object.

livechat/configuration/client.py

@@ -53,16 +53,23 @@ def get_client(token: str,
 
 class ConfigurationApiInterface(metaclass=ABCMeta):
     ''' Interface class. '''
-    def __init__(self, token: str, version: str, base_url: str,
-                 http2: bool) -> ConfigurationApiInterface:
+    def __init__(self,
+                 token: str,
+                 version: str,
+                 base_url: str,
+                 http2: bool,
+                 proxies=None,
+                 verify: bool = True) -> ConfigurationApiInterface:
         logger = HttpxLogger()
         self.api_url = f'https://{base_url}/v{version}/configuration/action'
         self.session = httpx.Client(http2=http2,
                                     headers={'Authorization': token},
                                     event_hooks={
                                         'request': [logger.log_request],
                                         'response': [logger.log_response]
-                                    })
+                                    },
+                                    proxies=proxies,
+                                    verify=verify)
 
     def modify_header(self, header: dict) -> None:
         ''' Modifies provided header in session object.

livechat/customer/web/client.py

@@ -32,9 +32,9 @@ def get_client(license_id: int = None,
         ''' Returns client for specific API version.
 
             Args:
-                license_id (int): License ID.Required to use for API version <= 3.3.
+                license_id (int): License ID. Required to use for API version <= 3.3.
                 token (str): Full token with type (Bearer/Basic) that will be
-                                used as `Authorization` header in requests to API.
+                             used as `Authorization` header in requests to API.
                 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.
                 http2 (bool): A boolean indicating if HTTP/2 support should be
@@ -83,8 +83,13 @@ def get_client(license_id: int = None,
 
 class CustomerWebInterface(metaclass=ABCMeta):
     ''' Main class containing API methods. '''
-    def __init__(self, access_token: str, version: str, base_url: str,
-                 http2: bool) -> CustomerWebInterface:
+    def __init__(self,
+                 access_token: str,
+                 version: str,
+                 base_url: str,
+                 http2: bool,
+                 proxies=None,
+                 verify: bool = True) -> CustomerWebInterface:
         logger = HttpxLogger()
         self.api_url = f'https://{base_url}/v{version}/customer/action'
         if all([access_token, isinstance(access_token, str)]):
@@ -94,7 +99,9 @@ def __init__(self, access_token: str, version: str, base_url: str,
                 event_hooks={
                     'request': [logger.log_request],
                     'response': [logger.log_response]
-                })
+                },
+                proxies=proxies,
+                verify=verify)
         else:
             raise ValueError(
                 'Incorrect or missing `access_token` argument (should be of type str.)'

livechat/reports/client.py

@@ -54,16 +54,23 @@ def get_client(token: str,
 
 class ReportsApiInterface(metaclass=ABCMeta):
     ''' Interface class. '''
-    def __init__(self, token: str, version: str, base_url: str,
-                 http2: bool) -> ReportsApiInterface:
+    def __init__(self,
+                 token: str,
+                 version: str,
+                 base_url: str,
+                 http2: bool,
+                 proxies=None,
+                 verify: bool = True) -> ReportsApiInterface:
         logger = HttpxLogger()
         self.api_url = f'https://{base_url}/v{version}/reports'
         self.session = httpx.Client(http2=http2,
                                     headers={'Authorization': token},
                                     event_hooks={
                                         'request': [logger.log_request],
                                         'response': [logger.log_response]
-                                    })
+                                    },
+                                    proxies=proxies,
+                                    verify=verify)
 
     def modify_header(self, header: dict) -> None:
         ''' Modifies provided header in session object.