Merge pull request #101 from livechat/Release-lc-sdk-python-v-0-3-6

Release lc-sdk-python v0.3.6

changelog.md

@@ -1,7 +1,7 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.3.6] - TBA
+## [0.3.6] - 2023-03-09
 
 ### Added
 

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

@@ -798,7 +798,7 @@ <h1 class="title">Module <code>livechat.agent.rtm.api.v33</code></h1>
               push_notifications: dict = None,
               application: dict = None,
               away: bool = None,
-              customer_push_level: str = None,
+              customer_monitoring_level: str = None,
               pushes: dict = None,
               payload: dict = None) -&gt; RtmResponse:
         &#39;&#39;&#39; Logs in agent.
@@ -813,9 +813,9 @@ <h1 class="title">Module <code>livechat.agent.rtm.api.v33</code></h1>
                         the application&#39;s name and version.
                 away (bool): When True, the connection is set to the away state.
                         Defaults to False.
-                customer_push_level (str): Possible values: my, engaged, online.
+                customer_monitoring_level (str): Possible values: my, chatting, invited, online.
                         Defaults to my if login creates the first session;
-                        otherwise it preserves the current customer_push_level.
+                        otherwise it preserves the current customer_monitoring_level.
                 pushes (dict): Use case: when you want to receive only specific pushes.
                 By default, it&#39;s set to all for the version of your currently established RTM connection.
                 payload (dict): Custom payload to be used as request&#39;s data.
@@ -1807,7 +1807,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
               push_notifications: dict = None,
               application: dict = None,
               away: bool = None,
-              customer_push_level: str = None,
+              customer_monitoring_level: str = None,
               pushes: dict = None,
               payload: dict = None) -&gt; RtmResponse:
         &#39;&#39;&#39; Logs in agent.
@@ -1822,9 +1822,9 @@ <h2 class="section-title" id="header-classes">Classes</h2>
                         the application&#39;s name and version.
                 away (bool): When True, the connection is set to the away state.
                         Defaults to False.
-                customer_push_level (str): Possible values: my, engaged, online.
+                customer_monitoring_level (str): Possible values: my, chatting, invited, online.
                         Defaults to my if login creates the first session;
-                        otherwise it preserves the current customer_push_level.
+                        otherwise it preserves the current customer_monitoring_level.
                 pushes (dict): Use case: when you want to receive only specific pushes.
                 By default, it&#39;s set to all for the version of your currently established RTM connection.
                 payload (dict): Custom payload to be used as request&#39;s data.
@@ -3026,7 +3026,7 @@ <h2 id="returns">Returns</h2>
 </details>
 </dd>
 <dt id="livechat.agent.rtm.api.v33.AgentRtmV33.login"><code class="name flex">
-<span>def <span class="ident">login</span></span>(<span>self, token: str = None, timezone: str = None, reconnect: bool = None, push_notifications: dict = None, application: dict = None, away: bool = None, customer_push_level: str = None, pushes: dict = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse</span>
+<span>def <span class="ident">login</span></span>(<span>self, token: str = None, timezone: str = None, reconnect: bool = None, push_notifications: dict = None, application: dict = None, away: bool = None, customer_monitoring_level: str = None, pushes: dict = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Logs in agent.</p>
@@ -3047,10 +3047,10 @@ <h2 id="args">Args</h2>
 <dt><strong><code>away</code></strong> :&ensp;<code>bool</code></dt>
 <dd>When True, the connection is set to the away state.
 Defaults to False.</dd>
-<dt><strong><code>customer_push_level</code></strong> :&ensp;<code>str</code></dt>
-<dd>Possible values: my, engaged, online.
+<dt><strong><code>customer_monitoring_level</code></strong> :&ensp;<code>str</code></dt>
+<dd>Possible values: my, chatting, invited, online.
 Defaults to my if login creates the first session;
-otherwise it preserves the current customer_push_level.</dd>
+otherwise it preserves the current customer_monitoring_level.</dd>
 <dt><strong><code>pushes</code></strong> :&ensp;<code>dict</code></dt>
 <dd>Use case: when you want to receive only specific pushes.</dd>
 <dt>By default, it's set to all for the version of your currently established RTM connection.</dt>
@@ -3075,7 +3075,7 @@ <h2 id="returns">Returns</h2>
           push_notifications: dict = None,
           application: dict = None,
           away: bool = None,
-          customer_push_level: str = None,
+          customer_monitoring_level: str = None,
           pushes: dict = None,
           payload: dict = None) -&gt; RtmResponse:
     &#39;&#39;&#39; Logs in agent.
@@ -3090,9 +3090,9 @@ <h2 id="returns">Returns</h2>
                     the application&#39;s name and version.
             away (bool): When True, the connection is set to the away state.
                     Defaults to False.
-            customer_push_level (str): Possible values: my, engaged, online.
+            customer_monitoring_level (str): Possible values: my, chatting, invited, online.
                     Defaults to my if login creates the first session;
-                    otherwise it preserves the current customer_push_level.
+                    otherwise it preserves the current customer_monitoring_level.
             pushes (dict): Use case: when you want to receive only specific pushes.
             By default, it&#39;s set to all for the version of your currently established RTM connection.
             payload (dict): Custom payload to be used as request&#39;s data.
@@ -4252,4 +4252,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

@@ -764,7 +764,7 @@ <h1 class="title">Module <code>livechat.agent.rtm.api.v34</code></h1>
               push_notifications: dict = None,
               application: dict = None,
               away: bool = None,
-              customer_push_level: str = None,
+              customer_monitoring_level: str = None,
               pushes: dict = None,
               payload: dict = None) -&gt; RtmResponse:
         &#39;&#39;&#39; Logs in agent.
@@ -779,9 +779,9 @@ <h1 class="title">Module <code>livechat.agent.rtm.api.v34</code></h1>
                         the application&#39;s name and version.
                 away (bool): When True, the connection is set to the away state.
                         Defaults to False.
-                customer_push_level (str): Possible values: my, engaged, online.
+                customer_monitoring_level (str): Possible values are: `my`, `chatting`, `invited`, `online` and `highest_available`.
                         Defaults to my if login creates the first session;
-                        otherwise it preserves the current customer_push_level.
+                        otherwise it preserves the current customer_monitoring_level.
                 pushes (dict): Use case: when you want to receive only specific pushes.
                 By default, it&#39;s set to all for the version of your currently established RTM connection.
                 payload (dict): Custom payload to be used as request&#39;s data.
@@ -1739,7 +1739,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
               push_notifications: dict = None,
               application: dict = None,
               away: bool = None,
-              customer_push_level: str = None,
+              customer_monitoring_level: str = None,
               pushes: dict = None,
               payload: dict = None) -&gt; RtmResponse:
         &#39;&#39;&#39; Logs in agent.
@@ -1754,9 +1754,9 @@ <h2 class="section-title" id="header-classes">Classes</h2>
                         the application&#39;s name and version.
                 away (bool): When True, the connection is set to the away state.
                         Defaults to False.
-                customer_push_level (str): Possible values: my, engaged, online.
+                customer_monitoring_level (str): Possible values are: `my`, `chatting`, `invited`, `online` and `highest_available`.
                         Defaults to my if login creates the first session;
-                        otherwise it preserves the current customer_push_level.
+                        otherwise it preserves the current customer_monitoring_level.
                 pushes (dict): Use case: when you want to receive only specific pushes.
                 By default, it&#39;s set to all for the version of your currently established RTM connection.
                 payload (dict): Custom payload to be used as request&#39;s data.
@@ -2923,7 +2923,7 @@ <h2 id="returns">Returns</h2>
 </details>
 </dd>
 <dt id="livechat.agent.rtm.api.v34.AgentRtmV34.login"><code class="name flex">
-<span>def <span class="ident">login</span></span>(<span>self, token: str = None, timezone: str = None, reconnect: bool = None, push_notifications: dict = None, application: dict = None, away: bool = None, customer_push_level: str = None, pushes: dict = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse</span>
+<span>def <span class="ident">login</span></span>(<span>self, token: str = None, timezone: str = None, reconnect: bool = None, push_notifications: dict = None, application: dict = None, away: bool = None, customer_monitoring_level: str = None, pushes: dict = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Logs in agent.</p>
@@ -2944,10 +2944,10 @@ <h2 id="args">Args</h2>
 <dt><strong><code>away</code></strong> :&ensp;<code>bool</code></dt>
 <dd>When True, the connection is set to the away state.
 Defaults to False.</dd>
-<dt><strong><code>customer_push_level</code></strong> :&ensp;<code>str</code></dt>
-<dd>Possible values: my, engaged, online.
+<dt><strong><code>customer_monitoring_level</code></strong> :&ensp;<code>str</code></dt>
+<dd>Possible values are: <code>my</code>, <code>chatting</code>, <code>invited</code>, <code>online</code> and <code>highest_available</code>.
 Defaults to my if login creates the first session;
-otherwise it preserves the current customer_push_level.</dd>
+otherwise it preserves the current customer_monitoring_level.</dd>
 <dt><strong><code>pushes</code></strong> :&ensp;<code>dict</code></dt>
 <dd>Use case: when you want to receive only specific pushes.</dd>
 <dt>By default, it's set to all for the version of your currently established RTM connection.</dt>
@@ -2972,7 +2972,7 @@ <h2 id="returns">Returns</h2>
           push_notifications: dict = None,
           application: dict = None,
           away: bool = None,
-          customer_push_level: str = None,
+          customer_monitoring_level: str = None,
           pushes: dict = None,
           payload: dict = None) -&gt; RtmResponse:
     &#39;&#39;&#39; Logs in agent.
@@ -2987,9 +2987,9 @@ <h2 id="returns">Returns</h2>
                     the application&#39;s name and version.
             away (bool): When True, the connection is set to the away state.
                     Defaults to False.
-            customer_push_level (str): Possible values: my, engaged, online.
+            customer_monitoring_level (str): Possible values are: `my`, `chatting`, `invited`, `online` and `highest_available`.
                     Defaults to my if login creates the first session;
-                    otherwise it preserves the current customer_push_level.
+                    otherwise it preserves the current customer_monitoring_level.
             pushes (dict): Use case: when you want to receive only specific pushes.
             By default, it&#39;s set to all for the version of your currently established RTM connection.
             payload (dict): Custom payload to be used as request&#39;s data.
@@ -4108,4 +4108,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>

docs/agent/rtm/api/v35.html

@@ -764,7 +764,7 @@ <h1 class="title">Module <code>livechat.agent.rtm.api.v35</code></h1>
               push_notifications: dict = None,
               application: dict = None,
               away: bool = None,
-              customer_push_level: str = None,
+              customer_monitoring_level: str = None,
               pushes: dict = None,
               payload: dict = None) -&gt; RtmResponse:
         &#39;&#39;&#39; Logs in agent.
@@ -779,9 +779,9 @@ <h1 class="title">Module <code>livechat.agent.rtm.api.v35</code></h1>
                         the application&#39;s name and version.
                 away (bool): When True, the connection is set to the away state.
                         Defaults to False.
-                customer_push_level (str): Possible values: my, engaged, online.
+                customer_monitoring_level (str): Possible values are: `my`, `chatting`, `invited`, `online` and `highest_available`.
                         Defaults to my if login creates the first session;
-                        otherwise it preserves the current customer_push_level.
+                        otherwise it preserves the current customer_monitoring_level.
                 pushes (dict): Use case: when you want to receive only specific pushes.
                 By default, it&#39;s set to all for the version of your currently established RTM connection.
                 payload (dict): Custom payload to be used as request&#39;s data.
@@ -1739,7 +1739,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
               push_notifications: dict = None,
               application: dict = None,
               away: bool = None,
-              customer_push_level: str = None,
+              customer_monitoring_level: str = None,
               pushes: dict = None,
               payload: dict = None) -&gt; RtmResponse:
         &#39;&#39;&#39; Logs in agent.
@@ -1754,9 +1754,9 @@ <h2 class="section-title" id="header-classes">Classes</h2>
                         the application&#39;s name and version.
                 away (bool): When True, the connection is set to the away state.
                         Defaults to False.
-                customer_push_level (str): Possible values: my, engaged, online.
+                customer_monitoring_level (str): Possible values are: `my`, `chatting`, `invited`, `online` and `highest_available`.
                         Defaults to my if login creates the first session;
-                        otherwise it preserves the current customer_push_level.
+                        otherwise it preserves the current customer_monitoring_level.
                 pushes (dict): Use case: when you want to receive only specific pushes.
                 By default, it&#39;s set to all for the version of your currently established RTM connection.
                 payload (dict): Custom payload to be used as request&#39;s data.
@@ -2923,7 +2923,7 @@ <h2 id="returns">Returns</h2>
 </details>
 </dd>
 <dt id="livechat.agent.rtm.api.v35.AgentRtmV35.login"><code class="name flex">
-<span>def <span class="ident">login</span></span>(<span>self, token: str = None, timezone: str = None, reconnect: bool = None, push_notifications: dict = None, application: dict = None, away: bool = None, customer_push_level: str = None, pushes: dict = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse</span>
+<span>def <span class="ident">login</span></span>(<span>self, token: str = None, timezone: str = None, reconnect: bool = None, push_notifications: dict = None, application: dict = None, away: bool = None, customer_monitoring_level: str = None, pushes: dict = None, payload: dict = None) ‑> livechat.utils.structures.RtmResponse</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Logs in agent.</p>
@@ -2944,10 +2944,10 @@ <h2 id="args">Args</h2>
 <dt><strong><code>away</code></strong> :&ensp;<code>bool</code></dt>
 <dd>When True, the connection is set to the away state.
 Defaults to False.</dd>
-<dt><strong><code>customer_push_level</code></strong> :&ensp;<code>str</code></dt>
-<dd>Possible values: my, engaged, online.
+<dt><strong><code>customer_monitoring_level</code></strong> :&ensp;<code>str</code></dt>
+<dd>Possible values are: <code>my</code>, <code>chatting</code>, <code>invited</code>, <code>online</code> and <code>highest_available</code>.
 Defaults to my if login creates the first session;
-otherwise it preserves the current customer_push_level.</dd>
+otherwise it preserves the current customer_monitoring_level.</dd>
 <dt><strong><code>pushes</code></strong> :&ensp;<code>dict</code></dt>
 <dd>Use case: when you want to receive only specific pushes.</dd>
 <dt>By default, it's set to all for the version of your currently established RTM connection.</dt>
@@ -2972,7 +2972,7 @@ <h2 id="returns">Returns</h2>
           push_notifications: dict = None,
           application: dict = None,
           away: bool = None,
-          customer_push_level: str = None,
+          customer_monitoring_level: str = None,
           pushes: dict = None,
           payload: dict = None) -&gt; RtmResponse:
     &#39;&#39;&#39; Logs in agent.
@@ -2987,9 +2987,9 @@ <h2 id="returns">Returns</h2>
                     the application&#39;s name and version.
             away (bool): When True, the connection is set to the away state.
                     Defaults to False.
-            customer_push_level (str): Possible values: my, engaged, online.
+            customer_monitoring_level (str): Possible values are: `my`, `chatting`, `invited`, `online` and `highest_available`.
                     Defaults to my if login creates the first session;
-                    otherwise it preserves the current customer_push_level.
+                    otherwise it preserves the current customer_monitoring_level.
             pushes (dict): Use case: when you want to receive only specific pushes.
             By default, it&#39;s set to all for the version of your currently established RTM connection.
             payload (dict): Custom payload to be used as request&#39;s data.
@@ -4108,4 +4108,4 @@ <h4><code><a title="livechat.agent.rtm.api.v35.AgentRtmV35" 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>