Release 0.3.8 (#119)

* Release 0.3.8

* add emptyline@EOF in all doc files

* fix date of release

Author: kacperf531

changelog.md

@@ -1,7 +1,7 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.3.8] - TBA
+## [0.3.8] - 2023-11-30
 
 ### Added
 - Support for `logout` method in agent-api v3.6 web class.

docs/agent/index.html

@@ -75,4 +75,4 @@ <h1>Index</h1>
 <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
-</html>
+</html>

docs/agent/rtm/api/index.html

@@ -77,4 +77,4 @@ <h1>Index</h1>
 <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
-</html>
+</html>

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
+from typing import Any, Optional
 
 from livechat.utils.helpers import prepare_payload
 from livechat.utils.structures import RtmResponse
@@ -385,6 +385,7 @@ <h1 class="title">Module <code>livechat.agent.rtm.api.v33</code></h1>
                    chat_id: str = None,
                    event: dict = None,
                    attach_to_last_thread: bool = None,
+                   author_id: Optional[str] = None,
                    payload: dict = None) -&gt; RtmResponse:
         &#39;&#39;&#39; Sends an Event object.
 
@@ -393,16 +394,20 @@ <h1 class="title">Module <code>livechat.agent.rtm.api.v33</code></h1>
                 event (dict): Event object.
                 attach_to_last_thread (bool): Flag which states if event object should be added to last thread.
                         The flag is ignored for active chats.
+                author_id (optional str): Provide if the event should be sent on behalf of a bot.
                 payload (dict): Custom payload to be used as request&#39;s data.
                         It overrides all other parameters provided for the method.
 
             Returns:
                 RtmResponse: RTM response structure (`request_id`, `action`,
                              `type`, `success` and `payload` properties)
         &#39;&#39;&#39;
+        opts = {}
+        if author_id:
+            opts[&#39;author_id&#39;] = author_id
         if payload is None:
             payload = prepare_payload(locals())
-        return self.ws.send({&#39;action&#39;: &#39;send_event&#39;, &#39;payload&#39;: payload})
+        return self.ws.send({&#39;action&#39;: &#39;send_event&#39;, &#39;payload&#39;: payload, **opts})
 
     def send_rich_message_postback(self,
                                    chat_id: str = None,
@@ -1394,6 +1399,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
                    chat_id: str = None,
                    event: dict = None,
                    attach_to_last_thread: bool = None,
+                   author_id: Optional[str] = None,
                    payload: dict = None) -&gt; RtmResponse:
         &#39;&#39;&#39; Sends an Event object.
 
@@ -1402,16 +1408,20 @@ <h2 class="section-title" id="header-classes">Classes</h2>
                 event (dict): Event object.
                 attach_to_last_thread (bool): Flag which states if event object should be added to last thread.
                         The flag is ignored for active chats.
+                author_id (optional str): Provide if the event should be sent on behalf of a bot.
                 payload (dict): Custom payload to be used as request&#39;s data.
                         It overrides all other parameters provided for the method.
 
             Returns:
                 RtmResponse: RTM response structure (`request_id`, `action`,
                              `type`, `success` and `payload` properties)
         &#39;&#39;&#39;
+        opts = {}
+        if author_id:
+            opts[&#39;author_id&#39;] = author_id
         if payload is None:
             payload = prepare_payload(locals())
-        return self.ws.send({&#39;action&#39;: &#39;send_event&#39;, &#39;payload&#39;: payload})
+        return self.ws.send({&#39;action&#39;: &#39;send_event&#39;, &#39;payload&#39;: payload, **opts})
 
     def send_rich_message_postback(self,
                                    chat_id: str = None,
@@ -3411,7 +3421,7 @@ <h2 id="returns">Returns</h2>
 </details>
 </dd>
 <dt id="livechat.agent.rtm.api.v33.AgentRtmV33.send_event"><code class="name flex">
-<span>def <span class="ident">send_event</span></span>(<span>self, chat_id: str = None, event: dict = None, attach_to_last_thread: bool = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse</span>
+<span>def <span class="ident">send_event</span></span>(<span>self, chat_id: str = None, event: dict = None, attach_to_last_thread: bool = None, author_id: Optional[str] = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Sends an Event object.</p>
@@ -3424,6 +3434,8 @@ <h2 id="args">Args</h2>
 <dt><strong><code>attach_to_last_thread</code></strong> :&ensp;<code>bool</code></dt>
 <dd>Flag which states if event object should be added to last thread.
 The flag is ignored for active chats.</dd>
+<dt><strong><code>author_id</code></strong> :&ensp;<code>optional str</code></dt>
+<dd>Provide if the event should be sent on behalf of a bot.</dd>
 <dt><strong><code>payload</code></strong> :&ensp;<code>dict</code></dt>
 <dd>Custom payload to be used as request's data.
 It overrides all other parameters provided for the method.</dd>
@@ -3442,6 +3454,7 @@ <h2 id="returns">Returns</h2>
                chat_id: str = None,
                event: dict = None,
                attach_to_last_thread: bool = None,
+               author_id: Optional[str] = None,
                payload: dict = None) -&gt; RtmResponse:
     &#39;&#39;&#39; Sends an Event object.
 
@@ -3450,16 +3463,20 @@ <h2 id="returns">Returns</h2>
             event (dict): Event object.
             attach_to_last_thread (bool): Flag which states if event object should be added to last thread.
                     The flag is ignored for active chats.
+            author_id (optional str): Provide if the event should be sent on behalf of a bot.
             payload (dict): Custom payload to be used as request&#39;s data.
                     It overrides all other parameters provided for the method.
 
         Returns:
             RtmResponse: RTM response structure (`request_id`, `action`,
                          `type`, `success` and `payload` properties)
     &#39;&#39;&#39;
+    opts = {}
+    if author_id:
+        opts[&#39;author_id&#39;] = author_id
     if payload is None:
         payload = prepare_payload(locals())
-    return self.ws.send({&#39;action&#39;: &#39;send_event&#39;, &#39;payload&#39;: payload})</code></pre>
+    return self.ws.send({&#39;action&#39;: &#39;send_event&#39;, &#39;payload&#39;: payload, **opts})</code></pre>
 </details>
 </dd>
 <dt id="livechat.agent.rtm.api.v33.AgentRtmV33.send_rich_message_postback"><code class="name flex">
@@ -4252,4 +4269,4 @@ <h4><code><a title="livechat.agent.rtm.api.v33.AgentRtmV33" href="#livechat.agen
 <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
-</html>
+</html>

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
+from typing import Any, Optional
 
 from livechat.utils.helpers import prepare_payload
 from livechat.utils.structures import RtmResponse
@@ -351,6 +351,7 @@ <h1 class="title">Module <code>livechat.agent.rtm.api.v34</code></h1>
                    chat_id: str = None,
                    event: dict = None,
                    attach_to_last_thread: bool = None,
+                   author_id: Optional[str] = None,
                    payload: dict = None) -&gt; RtmResponse:
         &#39;&#39;&#39; Sends an Event object.
 
@@ -359,16 +360,20 @@ <h1 class="title">Module <code>livechat.agent.rtm.api.v34</code></h1>
                 event (dict): Event object.
                 attach_to_last_thread (bool): Flag which states if event object should be added to last thread.
                         The flag is ignored for active chats.
+                author_id (optional str): Provide if the event should be sent on behalf of a bot.
                 payload (dict): Custom payload to be used as request&#39;s data.
                         It overrides all other parameters provided for the method.
 
             Returns:
                 RtmResponse: RTM response structure (`request_id`, `action`,
                              `type`, `success` and `payload` properties)
         &#39;&#39;&#39;
+        opts = {}
+        if author_id:
+            opts[&#39;author_id&#39;] = author_id
         if payload is None:
             payload = prepare_payload(locals())
-        return self.ws.send({&#39;action&#39;: &#39;send_event&#39;, &#39;payload&#39;: payload})
+        return self.ws.send({&#39;action&#39;: &#39;send_event&#39;, &#39;payload&#39;: payload, **opts})
 
     def send_rich_message_postback(self,
                                    chat_id: str = None,
@@ -1326,6 +1331,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
                    chat_id: str = None,
                    event: dict = None,
                    attach_to_last_thread: bool = None,
+                   author_id: Optional[str] = None,
                    payload: dict = None) -&gt; RtmResponse:
         &#39;&#39;&#39; Sends an Event object.
 
@@ -1334,16 +1340,20 @@ <h2 class="section-title" id="header-classes">Classes</h2>
                 event (dict): Event object.
                 attach_to_last_thread (bool): Flag which states if event object should be added to last thread.
                         The flag is ignored for active chats.
+                author_id (optional str): Provide if the event should be sent on behalf of a bot.
                 payload (dict): Custom payload to be used as request&#39;s data.
                         It overrides all other parameters provided for the method.
 
             Returns:
                 RtmResponse: RTM response structure (`request_id`, `action`,
                              `type`, `success` and `payload` properties)
         &#39;&#39;&#39;
+        opts = {}
+        if author_id:
+            opts[&#39;author_id&#39;] = author_id
         if payload is None:
             payload = prepare_payload(locals())
-        return self.ws.send({&#39;action&#39;: &#39;send_event&#39;, &#39;payload&#39;: payload})
+        return self.ws.send({&#39;action&#39;: &#39;send_event&#39;, &#39;payload&#39;: payload, **opts})
 
     def send_rich_message_postback(self,
                                    chat_id: str = None,
@@ -3265,7 +3275,7 @@ <h2 id="returns">Returns</h2>
 </details>
 </dd>
 <dt id="livechat.agent.rtm.api.v34.AgentRtmV34.send_event"><code class="name flex">
-<span>def <span class="ident">send_event</span></span>(<span>self, chat_id: str = None, event: dict = None, attach_to_last_thread: bool = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse</span>
+<span>def <span class="ident">send_event</span></span>(<span>self, chat_id: str = None, event: dict = None, attach_to_last_thread: bool = None, author_id: Optional[str] = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Sends an Event object.</p>
@@ -3278,6 +3288,8 @@ <h2 id="args">Args</h2>
 <dt><strong><code>attach_to_last_thread</code></strong> :&ensp;<code>bool</code></dt>
 <dd>Flag which states if event object should be added to last thread.
 The flag is ignored for active chats.</dd>
+<dt><strong><code>author_id</code></strong> :&ensp;<code>optional str</code></dt>
+<dd>Provide if the event should be sent on behalf of a bot.</dd>
 <dt><strong><code>payload</code></strong> :&ensp;<code>dict</code></dt>
 <dd>Custom payload to be used as request's data.
 It overrides all other parameters provided for the method.</dd>
@@ -3296,6 +3308,7 @@ <h2 id="returns">Returns</h2>
                chat_id: str = None,
                event: dict = None,
                attach_to_last_thread: bool = None,
+               author_id: Optional[str] = None,
                payload: dict = None) -&gt; RtmResponse:
     &#39;&#39;&#39; Sends an Event object.
 
@@ -3304,16 +3317,20 @@ <h2 id="returns">Returns</h2>
             event (dict): Event object.
             attach_to_last_thread (bool): Flag which states if event object should be added to last thread.
                     The flag is ignored for active chats.
+            author_id (optional str): Provide if the event should be sent on behalf of a bot.
             payload (dict): Custom payload to be used as request&#39;s data.
                     It overrides all other parameters provided for the method.
 
         Returns:
             RtmResponse: RTM response structure (`request_id`, `action`,
                          `type`, `success` and `payload` properties)
     &#39;&#39;&#39;
+    opts = {}
+    if author_id:
+        opts[&#39;author_id&#39;] = author_id
     if payload is None:
         payload = prepare_payload(locals())
-    return self.ws.send({&#39;action&#39;: &#39;send_event&#39;, &#39;payload&#39;: payload})</code></pre>
+    return self.ws.send({&#39;action&#39;: &#39;send_event&#39;, &#39;payload&#39;: payload, **opts})</code></pre>
 </details>
 </dd>
 <dt id="livechat.agent.rtm.api.v34.AgentRtmV34.send_rich_message_postback"><code class="name flex">
@@ -4108,4 +4125,4 @@ <h4><code><a title="livechat.agent.rtm.api.v34.AgentRtmV34" href="#livechat.agen
 <p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.10.0</a>.</p>
 </footer>
 </body>
-</html>
+</html>