CR fixup: Added response_timeout parameter in open_connection methods.

changelog.md

@@ -5,11 +5,10 @@ All notable changes to this project will be documented in this file.
 
 ### Added
 - New `get_company_details` method in configuration-api v3.6.
+- Added `response_timeout` parameter in `open_connection` methods.
 
 ### Changed
 - Updated outdated packages.
-- Exposed `response_timeout` parameter in `open_connection` methods.
-- Changed default value of `ping_timeout` to 30 seconds.
 
 ## [0.3.9] - 2024-04-22
 

livechat/agent/rtm/api/v33.py

@@ -16,17 +16,17 @@ def __init__(self, url: str):
 
     def open_connection(self,
                         origin: dict = None,
-                        ping_timeout: float = 30,
-                        ping_interval: float = 5,
-                        ws_conn_timeout: float = 10,
+                        ping_timeout: Union[float, int] = 3,
+                        ping_interval: Union[float, int] = 5,
+                        ws_conn_timeout: Union[float, int] = 10,
                         keep_alive: bool = True,
-                        response_timeout: float = 3) -> None:
+                        response_timeout: Union[float, int] = 3) -> None:
         ''' Opens WebSocket connection.
 
             Args:
                 origin (dict): Specifies origin while creating websocket connection.
                 ping_timeout (int or float): timeout (in seconds) if the pong message is not received,
-                    by default sets to 30 seconds.
+                    by default sets to 3 seconds.
                 ping_interval (int or float): automatically sends "ping" command every specified period (in seconds).
                     If set to 0, no ping is sent periodically, by default sets to 5 seconds.
                 ws_conn_timeout (int or float): timeout (in seconds) to wait for WebSocket connection,

livechat/agent/rtm/api/v34.py

@@ -16,17 +16,17 @@ def __init__(self, url: str):
 
     def open_connection(self,
                         origin: dict = None,
-                        ping_timeout: float = 30,
-                        ping_interval: float = 5,
-                        ws_conn_timeout: float = 10,
+                        ping_timeout: Union[float, int] = 3,
+                        ping_interval: Union[float, int] = 5,
+                        ws_conn_timeout: Union[float, int] = 10,
                         keep_alive: bool = True,
-                        response_timeout: float = 3) -> None:
+                        response_timeout: Union[float, int] = 3) -> None:
         ''' Opens WebSocket connection.
 
             Args:
                 origin (dict): Specifies origin while creating websocket connection.
                 ping_timeout (int or float): timeout (in seconds) if the pong message is not received,
-                    by default sets to 30 seconds.
+                    by default sets to 3 seconds.
                 ping_interval (int or float): automatically sends "ping" command every specified period (in seconds).
                     If set to 0, no ping is sent periodically, by default sets to 5 seconds.
                 ws_conn_timeout (int or float): timeout (in seconds) to wait for WebSocket connection,

livechat/agent/rtm/api/v35.py

@@ -16,17 +16,17 @@ def __init__(self, url: str):
 
     def open_connection(self,
                         origin: dict = None,
-                        ping_timeout: float = 30,
-                        ping_interval: float = 5,
-                        ws_conn_timeout: float = 10,
+                        ping_timeout: Union[float, int] = 3,
+                        ping_interval: Union[float, int] = 5,
+                        ws_conn_timeout: Union[float, int] = 10,
                         keep_alive: bool = True,
-                        response_timeout: float = 3) -> None:
+                        response_timeout: Union[float, int] = 3) -> None:
         ''' Opens WebSocket connection.
 
             Args:
                 origin (dict): Specifies origin while creating websocket connection.
                 ping_timeout (int or float): timeout (in seconds) if the pong message is not received,
-                    by default sets to 30 seconds.
+                    by default sets to 3 seconds.
                 ping_interval (int or float): automatically sends "ping" command every specified period (in seconds).
                     If set to 0, no ping is sent periodically, by default sets to 5 seconds.
                 ws_conn_timeout (int or float): timeout (in seconds) to wait for WebSocket connection,

livechat/agent/rtm/api/v36.py

@@ -16,17 +16,17 @@ def __init__(self, url: str):
 
     def open_connection(self,
                         origin: dict = None,
-                        ping_timeout: float = 30,
-                        ping_interval: float = 5,
-                        ws_conn_timeout: float = 10,
+                        ping_timeout: Union[float, int] = 3,
+                        ping_interval: Union[float, int] = 5,
+                        ws_conn_timeout: Union[float, int] = 10,
                         keep_alive: bool = True,
-                        response_timeout: float = 3) -> None:
+                        response_timeout: Union[float, int] = 3) -> None:
         ''' Opens WebSocket connection.
 
             Args:
                 origin (dict): Specifies origin while creating websocket connection.
                 ping_timeout (int or float): timeout (in seconds) if the pong message is not received,
-                    by default sets to 30 seconds.
+                    by default sets to 3 seconds.
                 ping_interval (int or float): automatically sends "ping" command every specified period (in seconds).
                     If set to 0, no ping is sent periodically, by default sets to 5 seconds.
                 ws_conn_timeout (int or float): timeout (in seconds) to wait for WebSocket connection,

livechat/customer/rtm/api/v33.py

@@ -24,17 +24,17 @@ def __init__(self, license_id: str, base_url: str):
 
     def open_connection(self,
                         origin: dict = None,
-                        ping_timeout: float = 30,
-                        ping_interval: float = 5,
-                        ws_conn_timeout: float = 10,
+                        ping_timeout: Union[float, int] = 3,
+                        ping_interval: Union[float, int] = 5,
+                        ws_conn_timeout: Union[float, int] = 10,
                         keep_alive: bool = True,
-                        response_timeout: float = 3) -> None:
+                        response_timeout: Union[float, int] = 3) -> None:
         ''' Opens WebSocket connection.
 
             Args:
                 origin (dict): Specifies origin while creating websocket connection.
                 ping_timeout (int or float): timeout (in seconds) if the pong message is not received,
-                    by default sets to 30 seconds.
+                    by default sets to 3 seconds.
                 ping_interval (int or float): automatically sends "ping" command every specified period (in seconds).
                     If set to 0, no ping is sent periodically, by default sets to 5 seconds.
                 ws_conn_timeout (int or float): timeout (in seconds) to wait for WebSocket connection,

livechat/customer/rtm/api/v34.py

@@ -24,17 +24,17 @@ def __init__(self, organization_id: str, base_url: str):
 
     def open_connection(self,
                         origin: dict = None,
-                        ping_timeout: float = 30,
-                        ping_interval: float = 5,
-                        ws_conn_timeout: float = 10,
+                        ping_timeout: Union[float, int] = 3,
+                        ping_interval: Union[float, int] = 5,
+                        ws_conn_timeout: Union[float, int] = 10,
                         keep_alive: bool = True,
-                        response_timeout: float = 3) -> None:
+                        response_timeout: Union[float, int] = 3) -> None:
         ''' Opens WebSocket connection.
 
             Args:
                 origin (dict): Specifies origin while creating websocket connection.
                 ping_timeout (int or float): timeout (in seconds) if the pong message is not received,
-                    by default sets to 30 seconds.
+                    by default sets to 3 seconds.
                 ping_interval (int or float): automatically sends "ping" command every specified period (in seconds).
                     If set to 0, no ping is sent periodically, by default sets to 5 seconds.
                 ws_conn_timeout (int or float): timeout (in seconds) to wait for WebSocket connection,

livechat/customer/rtm/api/v35.py

@@ -24,17 +24,17 @@ def __init__(self, organization_id: str, base_url: str):
 
     def open_connection(self,
                         origin: dict = None,
-                        ping_timeout: float = 30,
-                        ping_interval: float = 5,
-                        ws_conn_timeout: float = 10,
+                        ping_timeout: Union[float, int] = 3,
+                        ping_interval: Union[float, int] = 5,
+                        ws_conn_timeout: Union[float, int] = 10,
                         keep_alive: bool = True,
-                        response_timeout: float = 3) -> None:
+                        response_timeout: Union[float, int] = 3) -> None:
         ''' Opens WebSocket connection.
 
             Args:
                 origin (dict): Specifies origin while creating websocket connection.
                 ping_timeout (int or float): timeout (in seconds) if the pong message is not received,
-                    by default sets to 30 seconds.
+                    by default sets to 3 seconds.
                 ping_interval (int or float): automatically sends "ping" command every specified period (in seconds).
                     If set to 0, no ping is sent periodically, by default sets to 5 seconds.
                 ws_conn_timeout (int or float): timeout (in seconds) to wait for WebSocket connection,

livechat/customer/rtm/api/v36.py

@@ -24,17 +24,17 @@ def __init__(self, organization_id: str, base_url: str):
 
     def open_connection(self,
                         origin: dict = None,
-                        ping_timeout: float = 30,
-                        ping_interval: float = 5,
-                        ws_conn_timeout: float = 10,
+                        ping_timeout: Union[float, int] = 3,
+                        ping_interval: Union[float, int] = 5,
+                        ws_conn_timeout: Union[float, int] = 10,
                         keep_alive: bool = True,
-                        response_timeout: float = 3) -> None:
+                        response_timeout: Union[float, int] = 3) -> None:
         ''' Opens WebSocket connection.
 
             Args:
                 origin (dict): Specifies origin while creating websocket connection.
                 ping_timeout (int or float): timeout (in seconds) if the pong message is not received,
-                    by default sets to 30 seconds.
+                    by default sets to 3 seconds.
                 ping_interval (int or float): automatically sends "ping" command every specified period (in seconds).
                     If set to 0, no ping is sent periodically, by default sets to 5 seconds.
                 ws_conn_timeout (int or float): timeout (in seconds) to wait for WebSocket connection,

livechat/utils/ws_client.py

@@ -7,7 +7,7 @@
 import ssl
 import threading
 from time import sleep
-from typing import List, NoReturn
+from typing import List, NoReturn, Union
 
 from loguru import logger
 from websocket import WebSocketApp, WebSocketConnectionClosedException
@@ -31,16 +31,16 @@ def __init__(self, *args, **kwargs):
 
     def open(self,
              origin: dict = None,
-             ping_timeout: float = 30,
-             ping_interval: float = 5,
-             ws_conn_timeout: float = 10,
+             ping_timeout: Union[float, int] = 3,
+             ping_interval: Union[float, int] = 5,
+             ws_conn_timeout: Union[float, int] = 10,
              keep_alive: bool = True,
-             response_timeout: float = 3) -> NoReturn:
+             response_timeout: Union[float, int] = 3) -> NoReturn:
         ''' Opens websocket connection and keep running forever.
             Args:
                 origin (dict): Specifies origin while creating websocket connection.
                 ping_timeout (int or float): timeout (in seconds) if the pong message is not received,
-                    by default sets to 30 seconds.
+                    by default sets to 3 seconds.
                 ping_interval (int or float): automatically sends "ping" command every specified period (in seconds).
                     If set to 0, no ping is sent periodically, by default sets to 5 seconds.
                 ws_conn_timeout (int or float): timeout (in seconds) to wait for WebSocket connection,