release 0.4.0 (#145)

Author: zuczkows

changelog.md

@@ -1,7 +1,7 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.4.0] - TBA
+## [0.4.0] - 2025-02-14
 
 ### Added
 - New `get_company_details`, `list_customer_bans` and `unban_customer` methods in configuration-api v3.6.

docs/agent/rtm/api/v33.html

@@ -29,7 +29,7 @@ <h1 class="title">Module <code>livechat.agent.rtm.api.v33</code></h1>
 </summary>
 <pre><code class="python">&#39;&#39;&#39; Module containing Agent RTM API client implementation for v3.3. &#39;&#39;&#39;
 
-from typing import Any, Optional, Union
+from typing import Any, Callable, Optional, Union
 
 from livechat.utils.helpers import prepare_payload
 from livechat.utils.structures import AccessToken, RtmResponse
@@ -40,15 +40,21 @@ <h1 class="title">Module <code>livechat.agent.rtm.api.v33</code></h1>
 
 class AgentRtmV33:
     &#39;&#39;&#39; Agent RTM API Class containing methods in version 3.3. &#39;&#39;&#39;
-    def __init__(self, url: str):
-        self.ws = WebsocketClient(url=f&#39;wss://{url}/v3.3/agent/rtm/ws&#39;)
+    def __init__(
+        self,
+        url: str,
+        header: Union[list, dict, Callable, None],
+    ):
+        self.ws = WebsocketClient(url=f&#39;wss://{url}/v3.3/agent/rtm/ws&#39;,
+                                  header=header)
 
     def open_connection(self,
                         origin: dict = None,
-                        ping_timeout: float = 3,
-                        ping_interval: float = 5,
-                        ws_conn_timeout: float = 10,
-                        keep_alive: bool = True) -&gt; None:
+                        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: Union[float, int] = 3) -&gt; None:
         &#39;&#39;&#39; Opens WebSocket connection.
 
             Args:
@@ -60,9 +66,11 @@ <h1 class="title">Module <code>livechat.agent.rtm.api.v33</code></h1>
                 ws_conn_timeout (int or float): timeout (in seconds) to wait for WebSocket connection,
                     by default sets to 10 seconds.
                 keep_alive(bool): Bool which states if connection should be kept, by default sets to `True`.
+                response_timeout (int or float): timeout (in seconds) to wait for the response,
+                    by default sets to 3 seconds.
         &#39;&#39;&#39;
         self.ws.open(origin, ping_timeout, ping_interval, ws_conn_timeout,
-                     keep_alive)
+                     keep_alive, response_timeout)
 
     def close_connection(self) -&gt; None:
         &#39;&#39;&#39; Closes WebSocket connection. &#39;&#39;&#39;
@@ -1067,7 +1075,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <dl>
 <dt id="livechat.agent.rtm.api.v33.AgentRtmV33"><code class="flex name class">
 <span>class <span class="ident">AgentRtmV33</span></span>
-<span>(</span><span>url: str)</span>
+<span>(</span><span>url: str, header: Union[list, dict, Callable, None])</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Agent RTM API Class containing methods in version 3.3.</p></div>
@@ -1077,15 +1085,21 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 </summary>
 <pre><code class="python">class AgentRtmV33:
     &#39;&#39;&#39; Agent RTM API Class containing methods in version 3.3. &#39;&#39;&#39;
-    def __init__(self, url: str):
-        self.ws = WebsocketClient(url=f&#39;wss://{url}/v3.3/agent/rtm/ws&#39;)
+    def __init__(
+        self,
+        url: str,
+        header: Union[list, dict, Callable, None],
+    ):
+        self.ws = WebsocketClient(url=f&#39;wss://{url}/v3.3/agent/rtm/ws&#39;,
+                                  header=header)
 
     def open_connection(self,
                         origin: dict = None,
-                        ping_timeout: float = 3,
-                        ping_interval: float = 5,
-                        ws_conn_timeout: float = 10,
-                        keep_alive: bool = True) -&gt; None:
+                        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: Union[float, int] = 3) -&gt; None:
         &#39;&#39;&#39; Opens WebSocket connection.
 
             Args:
@@ -1097,9 +1111,11 @@ <h2 class="section-title" id="header-classes">Classes</h2>
                 ws_conn_timeout (int or float): timeout (in seconds) to wait for WebSocket connection,
                     by default sets to 10 seconds.
                 keep_alive(bool): Bool which states if connection should be kept, by default sets to `True`.
+                response_timeout (int or float): timeout (in seconds) to wait for the response,
+                    by default sets to 3 seconds.
         &#39;&#39;&#39;
         self.ws.open(origin, ping_timeout, ping_interval, ws_conn_timeout,
-                     keep_alive)
+                     keep_alive, response_timeout)
 
     def close_connection(self) -&gt; None:
         &#39;&#39;&#39; Closes WebSocket connection. &#39;&#39;&#39;
@@ -3303,7 +3319,7 @@ <h2 id="returns">Returns</h2>
 </details>
 </dd>
 <dt id="livechat.agent.rtm.api.v33.AgentRtmV33.open_connection"><code class="name flex">
-<span>def <span class="ident">open_connection</span></span>(<span>self, origin: dict = None, ping_timeout: float = 3, ping_interval: float = 5, ws_conn_timeout: float = 10, keep_alive: bool = True) ‑> None</span>
+<span>def <span class="ident">open_connection</span></span>(<span>self, origin: dict = None, 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: Union[float, int] = 3) ‑> None</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Opens WebSocket connection.</p>
@@ -3320,18 +3336,22 @@ <h2 id="args">Args</h2>
 <dt><strong><code>ws_conn_timeout</code></strong> :&ensp;<code>int</code> or <code>float</code></dt>
 <dd>timeout (in seconds) to wait for WebSocket connection,
 by default sets to 10 seconds.</dd>
-</dl>
-<p>keep_alive(bool): Bool which states if connection should be kept, by default sets to <code>True</code>.</p></div>
+<dt>keep_alive(bool): Bool which states if connection should be kept, by default sets to <code>True</code>.</dt>
+<dt><strong><code>response_timeout</code></strong> :&ensp;<code>int</code> or <code>float</code></dt>
+<dd>timeout (in seconds) to wait for the response,
+by default sets to 3 seconds.</dd>
+</dl></div>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">def open_connection(self,
                     origin: dict = None,
-                    ping_timeout: float = 3,
-                    ping_interval: float = 5,
-                    ws_conn_timeout: float = 10,
-                    keep_alive: bool = True) -&gt; None:
+                    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: Union[float, int] = 3) -&gt; None:
     &#39;&#39;&#39; Opens WebSocket connection.
 
         Args:
@@ -3343,9 +3363,11 @@ <h2 id="args">Args</h2>
             ws_conn_timeout (int or float): timeout (in seconds) to wait for WebSocket connection,
                 by default sets to 10 seconds.
             keep_alive(bool): Bool which states if connection should be kept, by default sets to `True`.
+            response_timeout (int or float): timeout (in seconds) to wait for the response,
+                by default sets to 3 seconds.
     &#39;&#39;&#39;
     self.ws.open(origin, ping_timeout, ping_interval, ws_conn_timeout,
-                 keep_alive)</code></pre>
+                 keep_alive, response_timeout)</code></pre>
 </details>
 </dd>
 <dt id="livechat.agent.rtm.api.v33.AgentRtmV33.remove_user_from_chat"><code class="name flex">

docs/agent/rtm/api/v34.html

@@ -29,7 +29,7 @@ <h1 class="title">Module <code>livechat.agent.rtm.api.v34</code></h1>
 </summary>
 <pre><code class="python">&#39;&#39;&#39; Module containing Agent RTM API client implementation for v3.4. &#39;&#39;&#39;
 
-from typing import Any, Optional, Union
+from typing import Any, Callable, Optional, Union
 
 from livechat.utils.helpers import prepare_payload
 from livechat.utils.structures import AccessToken, RtmResponse
@@ -40,15 +40,21 @@ <h1 class="title">Module <code>livechat.agent.rtm.api.v34</code></h1>
 
 class AgentRtmV34:
     &#39;&#39;&#39; Agent RTM API Class containing methods in version 3.4. &#39;&#39;&#39;
-    def __init__(self, url: str):
-        self.ws = WebsocketClient(url=f&#39;wss://{url}/v3.4/agent/rtm/ws&#39;)
+    def __init__(
+        self,
+        url: str,
+        header: Union[list, dict, Callable, None],
+    ):
+        self.ws = WebsocketClient(url=f&#39;wss://{url}/v3.4/agent/rtm/ws&#39;,
+                                  header=header)
 
     def open_connection(self,
                         origin: dict = None,
-                        ping_timeout: float = 3,
-                        ping_interval: float = 5,
-                        ws_conn_timeout: float = 10,
-                        keep_alive: bool = True) -&gt; None:
+                        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: Union[float, int] = 3) -&gt; None:
         &#39;&#39;&#39; Opens WebSocket connection.
 
             Args:
@@ -60,9 +66,11 @@ <h1 class="title">Module <code>livechat.agent.rtm.api.v34</code></h1>
                 ws_conn_timeout (int or float): timeout (in seconds) to wait for WebSocket connection,
                     by default sets to 10 seconds.
                 keep_alive(bool): Bool which states if connection should be kept, by default sets to `True`.
+                response_timeout (int or float): timeout (in seconds) to wait for the response,
+                    by default sets to 3 seconds.
         &#39;&#39;&#39;
         self.ws.open(origin, ping_timeout, ping_interval, ws_conn_timeout,
-                     keep_alive)
+                     keep_alive, response_timeout)
 
     def close_connection(self) -&gt; None:
         &#39;&#39;&#39; Closes WebSocket connection. &#39;&#39;&#39;
@@ -1033,7 +1041,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <dl>
 <dt id="livechat.agent.rtm.api.v34.AgentRtmV34"><code class="flex name class">
 <span>class <span class="ident">AgentRtmV34</span></span>
-<span>(</span><span>url: str)</span>
+<span>(</span><span>url: str, header: Union[list, dict, Callable, None])</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Agent RTM API Class containing methods in version 3.4.</p></div>
@@ -1043,15 +1051,21 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 </summary>
 <pre><code class="python">class AgentRtmV34:
     &#39;&#39;&#39; Agent RTM API Class containing methods in version 3.4. &#39;&#39;&#39;
-    def __init__(self, url: str):
-        self.ws = WebsocketClient(url=f&#39;wss://{url}/v3.4/agent/rtm/ws&#39;)
+    def __init__(
+        self,
+        url: str,
+        header: Union[list, dict, Callable, None],
+    ):
+        self.ws = WebsocketClient(url=f&#39;wss://{url}/v3.4/agent/rtm/ws&#39;,
+                                  header=header)
 
     def open_connection(self,
                         origin: dict = None,
-                        ping_timeout: float = 3,
-                        ping_interval: float = 5,
-                        ws_conn_timeout: float = 10,
-                        keep_alive: bool = True) -&gt; None:
+                        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: Union[float, int] = 3) -&gt; None:
         &#39;&#39;&#39; Opens WebSocket connection.
 
             Args:
@@ -1063,9 +1077,11 @@ <h2 class="section-title" id="header-classes">Classes</h2>
                 ws_conn_timeout (int or float): timeout (in seconds) to wait for WebSocket connection,
                     by default sets to 10 seconds.
                 keep_alive(bool): Bool which states if connection should be kept, by default sets to `True`.
+                response_timeout (int or float): timeout (in seconds) to wait for the response,
+                    by default sets to 3 seconds.
         &#39;&#39;&#39;
         self.ws.open(origin, ping_timeout, ping_interval, ws_conn_timeout,
-                     keep_alive)
+                     keep_alive, response_timeout)
 
     def close_connection(self) -&gt; None:
         &#39;&#39;&#39; Closes WebSocket connection. &#39;&#39;&#39;
@@ -3200,7 +3216,7 @@ <h2 id="returns">Returns</h2>
 </details>
 </dd>
 <dt id="livechat.agent.rtm.api.v34.AgentRtmV34.open_connection"><code class="name flex">
-<span>def <span class="ident">open_connection</span></span>(<span>self, origin: dict = None, ping_timeout: float = 3, ping_interval: float = 5, ws_conn_timeout: float = 10, keep_alive: bool = True) ‑> None</span>
+<span>def <span class="ident">open_connection</span></span>(<span>self, origin: dict = None, 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: Union[float, int] = 3) ‑> None</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Opens WebSocket connection.</p>
@@ -3217,18 +3233,22 @@ <h2 id="args">Args</h2>
 <dt><strong><code>ws_conn_timeout</code></strong> :&ensp;<code>int</code> or <code>float</code></dt>
 <dd>timeout (in seconds) to wait for WebSocket connection,
 by default sets to 10 seconds.</dd>
-</dl>
-<p>keep_alive(bool): Bool which states if connection should be kept, by default sets to <code>True</code>.</p></div>
+<dt>keep_alive(bool): Bool which states if connection should be kept, by default sets to <code>True</code>.</dt>
+<dt><strong><code>response_timeout</code></strong> :&ensp;<code>int</code> or <code>float</code></dt>
+<dd>timeout (in seconds) to wait for the response,
+by default sets to 3 seconds.</dd>
+</dl></div>
 <details class="source">
 <summary>
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">def open_connection(self,
                     origin: dict = None,
-                    ping_timeout: float = 3,
-                    ping_interval: float = 5,
-                    ws_conn_timeout: float = 10,
-                    keep_alive: bool = True) -&gt; None:
+                    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: Union[float, int] = 3) -&gt; None:
     &#39;&#39;&#39; Opens WebSocket connection.
 
         Args:
@@ -3240,9 +3260,11 @@ <h2 id="args">Args</h2>
             ws_conn_timeout (int or float): timeout (in seconds) to wait for WebSocket connection,
                 by default sets to 10 seconds.
             keep_alive(bool): Bool which states if connection should be kept, by default sets to `True`.
+            response_timeout (int or float): timeout (in seconds) to wait for the response,
+                by default sets to 3 seconds.
     &#39;&#39;&#39;
     self.ws.open(origin, ping_timeout, ping_interval, ws_conn_timeout,
-                 keep_alive)</code></pre>
+                 keep_alive, response_timeout)</code></pre>
 </details>
 </dd>
 <dt id="livechat.agent.rtm.api.v34.AgentRtmV34.remove_user_from_chat"><code class="name flex">