Merge pull request #109 from livechat/0-3-7-release

0.3.7 version release
livechat · Sep 26, 2023 · 0cb6fb8 · 0cb6fb8
2 parents 087b4c2 + f35b00e
commit 0cb6fb8
Show file tree

Hide file tree

Showing 24 changed files with 811 additions and 303 deletions.
diff --git a/changelog.md b/changelog.md
@@ -1,7 +1,7 @@
 # Change Log
 All notable changes to this project will be documented in this file.
 
-## [0.3.7] - TBA
+## [0.3.7] - 2023-09-26
 
 ### Added
 

diff --git a/docs/agent/web/api/v33.html b/docs/agent/web/api/v33.html
@@ -47,8 +47,10 @@ <h1 class="title">Module <code>livechat.agent.web.api.v33</code></h1>
                  base_url: str,
                  http2: bool,
                  proxies=None,
-                 verify: bool = True):
-        super().__init__(access_token, base_url, http2, proxies, verify)
+                 verify: bool = True,
+                 disable_logging: bool = False):
+        super().__init__(access_token, base_url, http2, proxies, verify,
+                         disable_logging)
         self.api_url = f&#39;https://{base_url}/v3.3/agent/action&#39;
 
     # Chats
@@ -1147,7 +1149,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <dl>
 <dt id="livechat.agent.web.api.v33.AgentWebV33"><code class="flex name class">
 <span>class <span class="ident">AgentWebV33</span></span>
-<span>(</span><span>access_token: str, base_url: str, http2: bool, proxies=None, verify: bool = True)</span>
+<span>(</span><span>access_token: str, base_url: str, http2: bool, proxies=None, verify: bool = True, disable_logging: bool = False)</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Agent Web API Class containing methods in version 3.3.</p></div>
@@ -1162,8 +1164,10 @@ <h2 class="section-title" id="header-classes">Classes</h2>
                  base_url: str,
                  http2: bool,
                  proxies=None,
-                 verify: bool = True):
-        super().__init__(access_token, base_url, http2, proxies, verify)
+                 verify: bool = True,
+                 disable_logging: bool = False):
+        super().__init__(access_token, base_url, http2, proxies, verify,
+                         disable_logging)
         self.api_url = f&#39;https://{base_url}/v3.3/agent/action&#39;
 
     # Chats
@@ -4624,4 +4628,4 @@ <h4><code><a title="livechat.agent.web.api.v33.AgentWebV33" 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>
diff --git a/docs/agent/web/api/v34.html b/docs/agent/web/api/v34.html
@@ -49,8 +49,10 @@ <h1 class="title">Module <code>livechat.agent.web.api.v34</code></h1>
                  base_url: str,
                  http2: bool,
                  proxies=None,
-                 verify: bool = True):
-        super().__init__(access_token, base_url, http2, proxies, verify)
+                 verify: bool = True,
+                 disable_logging: bool = False):
+        super().__init__(access_token, base_url, http2, proxies, verify,
+                         disable_logging)
         self.api_url = f&#39;https://{base_url}/v3.4/agent/action&#39;
 
     # Chats
@@ -1109,7 +1111,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <dl>
 <dt id="livechat.agent.web.api.v34.AgentWebV34"><code class="flex name class">
 <span>class <span class="ident">AgentWebV34</span></span>
-<span>(</span><span>access_token: str, base_url: str, http2: bool, proxies=None, verify: bool = True)</span>
+<span>(</span><span>access_token: str, base_url: str, http2: bool, proxies=None, verify: bool = True, disable_logging: bool = False)</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Agent Web API Class containing methods in version 3.4.</p></div>
@@ -1124,8 +1126,10 @@ <h2 class="section-title" id="header-classes">Classes</h2>
                  base_url: str,
                  http2: bool,
                  proxies=None,
-                 verify: bool = True):
-        super().__init__(access_token, base_url, http2, proxies, verify)
+                 verify: bool = True,
+                 disable_logging: bool = False):
+        super().__init__(access_token, base_url, http2, proxies, verify,
+                         disable_logging)
         self.api_url = f&#39;https://{base_url}/v3.4/agent/action&#39;
 
     # Chats
@@ -4456,4 +4460,4 @@ <h4><code><a title="livechat.agent.web.api.v34.AgentWebV34" 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>
diff --git a/docs/agent/web/api/v35.html b/docs/agent/web/api/v35.html
@@ -49,8 +49,10 @@ <h1 class="title">Module <code>livechat.agent.web.api.v35</code></h1>
                  base_url: str,
                  http2: bool,
                  proxies=None,
-                 verify: bool = True):
-        super().__init__(access_token, base_url, http2, proxies, verify)
+                 verify: bool = True,
+                 disable_logging: bool = False):
+        super().__init__(access_token, base_url, http2, proxies, verify,
+                         disable_logging)
         self.api_url = f&#39;https://{base_url}/v3.5/agent/action&#39;
 
     # Chats
@@ -1109,7 +1111,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <dl>
 <dt id="livechat.agent.web.api.v35.AgentWebV35"><code class="flex name class">
 <span>class <span class="ident">AgentWebV35</span></span>
-<span>(</span><span>access_token: str, base_url: str, http2: bool, proxies=None, verify: bool = True)</span>
+<span>(</span><span>access_token: str, base_url: str, http2: bool, proxies=None, verify: bool = True, disable_logging: bool = False)</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Agent Web API Class containing methods in version 3.5.</p></div>
@@ -1124,8 +1126,10 @@ <h2 class="section-title" id="header-classes">Classes</h2>
                  base_url: str,
                  http2: bool,
                  proxies=None,
-                 verify: bool = True):
-        super().__init__(access_token, base_url, http2, proxies, verify)
+                 verify: bool = True,
+                 disable_logging: bool = False):
+        super().__init__(access_token, base_url, http2, proxies, verify,
+                         disable_logging)
         self.api_url = f&#39;https://{base_url}/v3.5/agent/action&#39;
 
     # Chats
@@ -4456,4 +4460,4 @@ <h4><code><a title="livechat.agent.web.api.v35.AgentWebV35" 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>
diff --git a/docs/agent/web/api/v36.html b/docs/agent/web/api/v36.html
@@ -49,8 +49,10 @@ <h1 class="title">Module <code>livechat.agent.web.api.v36</code></h1>
                  base_url: str,
                  http2: bool,
                  proxies=None,
-                 verify: bool = True):
-        super().__init__(access_token, base_url, http2, proxies, verify)
+                 verify: bool = True,
+                 disable_logging: bool = False):
+        super().__init__(access_token, base_url, http2, proxies, verify,
+                         disable_logging)
         self.api_url = f&#39;https://{base_url}/v3.6/agent/action&#39;
 
     # Chats
@@ -1074,7 +1076,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <dl>
 <dt id="livechat.agent.web.api.v36.AgentWebV36"><code class="flex name class">
 <span>class <span class="ident">AgentWebV36</span></span>
-<span>(</span><span>access_token: str, base_url: str, http2: bool, proxies=None, verify: bool = True)</span>
+<span>(</span><span>access_token: str, base_url: str, http2: bool, proxies=None, verify: bool = True, disable_logging: bool = False)</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Agent Web API Class containing methods in version 3.6.</p></div>
@@ -1089,8 +1091,10 @@ <h2 class="section-title" id="header-classes">Classes</h2>
                  base_url: str,
                  http2: bool,
                  proxies=None,
-                 verify: bool = True):
-        super().__init__(access_token, base_url, http2, proxies, verify)
+                 verify: bool = True,
+                 disable_logging: bool = False):
+        super().__init__(access_token, base_url, http2, proxies, verify,
+                         disable_logging)
         self.api_url = f&#39;https://{base_url}/v3.6/agent/action&#39;
 
     # Chats
@@ -4311,4 +4315,4 @@ <h4><code><a title="livechat.agent.web.api.v36.AgentWebV36" 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>
diff --git a/docs/agent/web/base.html b/docs/agent/web/base.html
@@ -49,12 +49,13 @@ <h1 class="title">Module <code>livechat.agent.web.base</code></h1>
         API version. &#39;&#39;&#39;
     @staticmethod
     def get_client(
-            access_token: str,
-            version: str = stable_version,
-            base_url: str = api_url,
-            http2: bool = False,
-            proxies: dict = None,
-            verify: bool = True
+        access_token: str,
+        version: str = stable_version,
+        base_url: str = api_url,
+        http2: bool = False,
+        proxies: dict = None,
+        verify: bool = True,
+        disable_logging: bool = False,
     ) -&gt; Union[AgentWebV33, AgentWebV34, AgentWebV35]:
         &#39;&#39;&#39; Returns client for specific API version.
 
@@ -70,6 +71,7 @@ <h1 class="title">Module <code>livechat.agent.web.base</code></h1>
                                verify the identity of requested hosts. Either `True` (default CA bundle),
                                a path to an SSL certificate file, an `ssl.SSLContext`, or `False`
                                (which will disable verification). Defaults to `True`.
+                disable_logging (bool): indicates if logging should be disabled.
 
             Returns:
                 API client object for specified version.
@@ -78,10 +80,18 @@ <h1 class="title">Module <code>livechat.agent.web.base</code></h1>
                 ValueError: If the specified version does not exist.
         &#39;&#39;&#39;
         client = {
-            &#39;3.3&#39;: AgentWebV33(access_token, base_url, http2, proxies, verify),
-            &#39;3.4&#39;: AgentWebV34(access_token, base_url, http2, proxies, verify),
-            &#39;3.5&#39;: AgentWebV35(access_token, base_url, http2, proxies, verify),
-            &#39;3.6&#39;: AgentWebV36(access_token, base_url, http2, proxies, verify),
+            &#39;3.3&#39;:
+            AgentWebV33(access_token, base_url, http2, proxies, verify,
+                        disable_logging),
+            &#39;3.4&#39;:
+            AgentWebV34(access_token, base_url, http2, proxies, verify,
+                        disable_logging),
+            &#39;3.5&#39;:
+            AgentWebV35(access_token, base_url, http2, proxies, verify,
+                        disable_logging),
+            &#39;3.6&#39;:
+            AgentWebV36(access_token, base_url, http2, proxies, verify,
+                        disable_logging),
         }.get(version)
         if not client:
             raise ValueError(&#39;Provided version does not exist.&#39;)
@@ -112,12 +122,13 @@ <h2 class="section-title" id="header-classes">Classes</h2>
         API version. &#39;&#39;&#39;
     @staticmethod
     def get_client(
-            access_token: str,
-            version: str = stable_version,
-            base_url: str = api_url,
-            http2: bool = False,
-            proxies: dict = None,
-            verify: bool = True
+        access_token: str,
+        version: str = stable_version,
+        base_url: str = api_url,
+        http2: bool = False,
+        proxies: dict = None,
+        verify: bool = True,
+        disable_logging: bool = False,
     ) -&gt; Union[AgentWebV33, AgentWebV34, AgentWebV35]:
         &#39;&#39;&#39; Returns client for specific API version.
 
@@ -133,6 +144,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
                                verify the identity of requested hosts. Either `True` (default CA bundle),
                                a path to an SSL certificate file, an `ssl.SSLContext`, or `False`
                                (which will disable verification). Defaults to `True`.
+                disable_logging (bool): indicates if logging should be disabled.
 
             Returns:
                 API client object for specified version.
@@ -141,10 +153,18 @@ <h2 class="section-title" id="header-classes">Classes</h2>
                 ValueError: If the specified version does not exist.
         &#39;&#39;&#39;
         client = {
-            &#39;3.3&#39;: AgentWebV33(access_token, base_url, http2, proxies, verify),
-            &#39;3.4&#39;: AgentWebV34(access_token, base_url, http2, proxies, verify),
-            &#39;3.5&#39;: AgentWebV35(access_token, base_url, http2, proxies, verify),
-            &#39;3.6&#39;: AgentWebV36(access_token, base_url, http2, proxies, verify),
+            &#39;3.3&#39;:
+            AgentWebV33(access_token, base_url, http2, proxies, verify,
+                        disable_logging),
+            &#39;3.4&#39;:
+            AgentWebV34(access_token, base_url, http2, proxies, verify,
+                        disable_logging),
+            &#39;3.5&#39;:
+            AgentWebV35(access_token, base_url, http2, proxies, verify,
+                        disable_logging),
+            &#39;3.6&#39;:
+            AgentWebV36(access_token, base_url, http2, proxies, verify,
+                        disable_logging),
         }.get(version)
         if not client:
             raise ValueError(&#39;Provided version does not exist.&#39;)
@@ -153,7 +173,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <h3>Static methods</h3>
 <dl>
 <dt id="livechat.agent.web.base.AgentWeb.get_client"><code class="name flex">
-<span>def <span class="ident">get_client</span></span>(<span>access_token: str, version: str = '3.5', base_url: str = 'api.livechatinc.com', http2: bool = False, proxies: dict = None, verify: bool = True) ‑> Union[<a title="livechat.agent.web.api.v33.AgentWebV33" href="api/v33.html#livechat.agent.web.api.v33.AgentWebV33">AgentWebV33</a>, <a title="livechat.agent.web.api.v34.AgentWebV34" href="api/v34.html#livechat.agent.web.api.v34.AgentWebV34">AgentWebV34</a>, <a title="livechat.agent.web.api.v35.AgentWebV35" href="api/v35.html#livechat.agent.web.api.v35.AgentWebV35">AgentWebV35</a>]</span>
+<span>def <span class="ident">get_client</span></span>(<span>access_token: str, version: str = '3.5', base_url: str = 'api.livechatinc.com', http2: bool = False, proxies: dict = None, verify: bool = True, disable_logging: bool = False) ‑> Union[<a title="livechat.agent.web.api.v33.AgentWebV33" href="api/v33.html#livechat.agent.web.api.v33.AgentWebV33">AgentWebV33</a>, <a title="livechat.agent.web.api.v34.AgentWebV34" href="api/v34.html#livechat.agent.web.api.v34.AgentWebV34">AgentWebV34</a>, <a title="livechat.agent.web.api.v35.AgentWebV35" href="api/v35.html#livechat.agent.web.api.v35.AgentWebV35">AgentWebV35</a>]</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Returns client for specific API version.</p>
@@ -176,6 +196,8 @@ <h2 id="args">Args</h2>
 verify the identity of requested hosts. Either <code>True</code> (default CA bundle),
 a path to an SSL certificate file, an <code>ssl.SSLContext</code>, or <code>False</code>
 (which will disable verification). Defaults to <code>True</code>.</dd>
+<dt><strong><code>disable_logging</code></strong> :&ensp;<code>bool</code></dt>
+<dd>indicates if logging should be disabled.</dd>
 </dl>
 <h2 id="returns">Returns</h2>
 <p>API client object for specified version.</p>
@@ -190,12 +212,13 @@ <h2 id="raises">Raises</h2>
 </summary>
 <pre><code class="python">@staticmethod
 def get_client(
-        access_token: str,
-        version: str = stable_version,
-        base_url: str = api_url,
-        http2: bool = False,
-        proxies: dict = None,
-        verify: bool = True
+    access_token: str,
+    version: str = stable_version,
+    base_url: str = api_url,
+    http2: bool = False,
+    proxies: dict = None,
+    verify: bool = True,
+    disable_logging: bool = False,
 ) -&gt; Union[AgentWebV33, AgentWebV34, AgentWebV35]:
     &#39;&#39;&#39; Returns client for specific API version.
 
@@ -211,6 +234,7 @@ <h2 id="raises">Raises</h2>
                            verify the identity of requested hosts. Either `True` (default CA bundle),
                            a path to an SSL certificate file, an `ssl.SSLContext`, or `False`
                            (which will disable verification). Defaults to `True`.
+            disable_logging (bool): indicates if logging should be disabled.
 
         Returns:
             API client object for specified version.
@@ -219,10 +243,18 @@ <h2 id="raises">Raises</h2>
             ValueError: If the specified version does not exist.
     &#39;&#39;&#39;
     client = {
-        &#39;3.3&#39;: AgentWebV33(access_token, base_url, http2, proxies, verify),
-        &#39;3.4&#39;: AgentWebV34(access_token, base_url, http2, proxies, verify),
-        &#39;3.5&#39;: AgentWebV35(access_token, base_url, http2, proxies, verify),
-        &#39;3.6&#39;: AgentWebV36(access_token, base_url, http2, proxies, verify),
+        &#39;3.3&#39;:
+        AgentWebV33(access_token, base_url, http2, proxies, verify,
+                    disable_logging),
+        &#39;3.4&#39;:
+        AgentWebV34(access_token, base_url, http2, proxies, verify,
+                    disable_logging),
+        &#39;3.5&#39;:
+        AgentWebV35(access_token, base_url, http2, proxies, verify,
+                    disable_logging),
+        &#39;3.6&#39;:
+        AgentWebV36(access_token, base_url, http2, proxies, verify,
+                    disable_logging),
     }.get(version)
     if not client:
         raise ValueError(&#39;Provided version does not exist.&#39;)
@@ -262,4 +294,4 @@ <h4><code><a title="livechat.agent.web.base.AgentWeb" href="#livechat.agent.web.
 <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>
diff --git a/docs/billing/api/v1.html b/docs/billing/api/v1.html
@@ -42,8 +42,10 @@ <h1 class="title">Module <code>livechat.billing.api.v1</code></h1>
                  base_url: str,
                  http2: bool,
                  proxies=None,
-                 verify: bool = True):
-        super().__init__(token, base_url, http2, proxies, verify)
+                 verify: bool = True,
+                 disable_logging: bool = False):
+        super().__init__(token, base_url, http2, proxies, verify,
+                         disable_logging)
         self.api_url = f&#39;https://{base_url}/v1&#39;
 
     # direct_charge
@@ -391,7 +393,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <dl>
 <dt id="livechat.billing.api.v1.BillingApiV1"><code class="flex name class">
 <span>class <span class="ident">BillingApiV1</span></span>
-<span>(</span><span>token: str, base_url: str, http2: bool, proxies=None, verify: bool = True)</span>
+<span>(</span><span>token: str, base_url: str, http2: bool, proxies=None, verify: bool = True, disable_logging: bool = False)</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Billing API client class in version 1.</p></div>
@@ -406,8 +408,10 @@ <h2 class="section-title" id="header-classes">Classes</h2>
                  base_url: str,
                  http2: bool,
                  proxies=None,
-                 verify: bool = True):
-        super().__init__(token, base_url, http2, proxies, verify)
+                 verify: bool = True,
+                 disable_logging: bool = False):
+        super().__init__(token, base_url, http2, proxies, verify,
+                         disable_logging)
         self.api_url = f&#39;https://{base_url}/v1&#39;
 
     # direct_charge
@@ -1512,4 +1516,4 @@ <h4><code><a title="livechat.billing.api.v1.BillingApiV1" href="#livechat.billin
 <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>