docs: improve and fix examples

README.rst

@@ -22,7 +22,13 @@ A modern, easy to use, feature-rich ready API wrapper for `WhatsApp Business Clo
 Features
 --------
 
-* Full `Send Messages`_ Support (text, audio, contacts, documents, images, interactive, location, sticker, and videos)
+* Full `Send Messages`_ Support:
+  * text
+  * media (audio, documents, images, sticker, and videos)
+  * contacts
+  * interactive (buttons, list, and products)
+  * location
+  * templates
 * Full `Webhook Notification`_ Parsing Support
 
 Installing

docs/_build/html/_modules/index.html

@@ -40,9 +40,9 @@ <h1>All modules for which code is available</h1>
 <li><a href="wa_me/classes/responses.html">wa_me.classes.responses</a></li>
 <li><a href="wa_me/context.html">wa_me.context</a></li>
 <li><a href="wa_me/core/client.html">wa_me.core.client</a></li>
-<li><a href="wa_me/core/converter.html">wa_me.core.converter</a></li>
 <li><a href="wa_me/core/errors.html">wa_me.core.errors</a></li>
 <li><a href="wa_me/core/http.html">wa_me.core.http</a></li>
+<li><a href="wa_me/utils/converter.html">wa_me.utils.converter</a></li>
 <li><a href="wa_me/utils/routine.html">wa_me.utils.routine</a></li>
 <li><a href="wa_me/utils/ttl_dict.html">wa_me.utils.ttl_dict</a></li>
 </ul>

docs/_build/html/_modules/wa_me/context.html

@@ -41,7 +41,7 @@ <h1>Source code for wa_me.context</h1><div class="highlight"><pre>
 
 <span class="kn">from</span> <span class="nn">.classes</span> <span class="kn">import</span> <span class="n">enums</span><span class="p">,</span> <span class="n">events</span><span class="p">,</span> <span class="n">messages</span><span class="p">,</span> <span class="n">responses</span>
 <span class="kn">from</span> <span class="nn">.core.client</span> <span class="kn">import</span> <span class="n">Client</span>
-<span class="kn">from</span> <span class="nn">.core.converter</span> <span class="kn">import</span> <span class="n">as_dict</span><span class="p">,</span> <span class="n">from_dict</span>
+<span class="kn">from</span> <span class="nn">.utils.converter</span> <span class="kn">import</span> <span class="n">as_dict</span><span class="p">,</span> <span class="n">from_dict</span>
 
 <span class="n">__all__</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot;Ctx&quot;</span><span class="p">,)</span>
 

docs/_build/html/_modules/wa_me/core/errors.html

@@ -40,7 +40,7 @@ <h1>Source code for wa_me.core.errors</h1><div class="highlight"><pre>
 <span class="kn">import</span> <span class="nn">requests</span>
 
 <span class="n">__all__</span> <span class="o">=</span> <span class="p">(</span>
-    <span class="s2">&quot;WhatsappException&quot;</span><span class="p">,</span>
+    <span class="s2">&quot;WaMeException&quot;</span><span class="p">,</span>
     <span class="s2">&quot;ValidationError&quot;</span><span class="p">,</span>
     <span class="s2">&quot;HTTPException&quot;</span><span class="p">,</span>
     <span class="s2">&quot;BadRequest&quot;</span><span class="p">,</span>
@@ -51,15 +51,15 @@ <h1>Source code for wa_me.core.errors</h1><div class="highlight"><pre>
 <span class="p">)</span>
 
 
-<div class="viewcode-block" id="WhatsappException"><a class="viewcode-back" href="../../../wa_me.core.html#wa_me.core.errors.WhatsappException">[docs]</a><span class="k">class</span> <span class="nc">WhatsappException</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
+<div class="viewcode-block" id="WaMeException"><a class="viewcode-back" href="../../../wa_me.core.html#wa_me.core.errors.WaMeException">[docs]</a><span class="k">class</span> <span class="nc">WaMeException</span><span class="p">(</span><span class="ne">Exception</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;Base exception class for wa_me.&quot;&quot;&quot;</span></div>
 
 
-<div class="viewcode-block" id="ValidationError"><a class="viewcode-back" href="../../../wa_me.core.html#wa_me.core.errors.ValidationError">[docs]</a><span class="k">class</span> <span class="nc">ValidationError</span><span class="p">(</span><span class="n">WhatsappException</span><span class="p">):</span>
+<div class="viewcode-block" id="ValidationError"><a class="viewcode-back" href="../../../wa_me.core.html#wa_me.core.errors.ValidationError">[docs]</a><span class="k">class</span> <span class="nc">ValidationError</span><span class="p">(</span><span class="n">WaMeException</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;An Exception that is raised when there is a Validation Error.&quot;&quot;&quot;</span></div>
 
 
-<div class="viewcode-block" id="HTTPException"><a class="viewcode-back" href="../../../wa_me.core.html#wa_me.core.errors.HTTPException">[docs]</a><span class="k">class</span> <span class="nc">HTTPException</span><span class="p">(</span><span class="n">WhatsappException</span><span class="p">):</span>
+<div class="viewcode-block" id="HTTPException"><a class="viewcode-back" href="../../../wa_me.core.html#wa_me.core.errors.HTTPException">[docs]</a><span class="k">class</span> <span class="nc">HTTPException</span><span class="p">(</span><span class="n">WaMeException</span><span class="p">):</span>
     <span class="sd">&quot;&quot;&quot;Exception that&#39;s raised when an HTTP request operation fails.</span>
 
 <span class="sd">    Parameters</span>

docs/_build/html/_modules/wa_me/core/converter.html → docs/_build/html/_modules/wa_me/utils/converter.html

@@ -5,7 +5,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>wa_me.core.converter &#8212; wa_me 0.1.0 documentation</title>
+    <title>wa_me.utils.converter &#8212; wa_me 0.1.0 documentation</title>
     <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" />
     <link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css" />
     <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script>
@@ -32,7 +32,7 @@
 
           <div class="body" role="main">
 
-  <h1>Source code for wa_me.core.converter</h1><div class="highlight"><pre>
+  <h1>Source code for wa_me.utils.converter</h1><div class="highlight"><pre>
 <span></span><span class="ch">#!/usr/bin/env python</span>
 
 <span class="kn">from</span> <span class="nn">dataclasses</span> <span class="kn">import</span> <span class="n">asdict</span>
@@ -41,15 +41,13 @@ <h1>Source code for wa_me.core.converter</h1><div class="highlight"><pre>
 
 <span class="kn">import</span> <span class="nn">dacite</span>
 
-<span class="kn">from</span> <span class="nn">.errors</span> <span class="kn">import</span> <span class="n">ValidationError</span>
-
 <span class="n">__all__</span> <span class="o">=</span> <span class="p">(</span><span class="s2">&quot;as_dict&quot;</span><span class="p">,</span> <span class="s2">&quot;from_dict&quot;</span><span class="p">)</span>
 
 <span class="n">T</span> <span class="o">=</span> <span class="n">TypeVar</span><span class="p">(</span><span class="s2">&quot;T&quot;</span><span class="p">)</span>
 <span class="n">config</span> <span class="o">=</span> <span class="n">dacite</span><span class="o">.</span><span class="n">Config</span><span class="p">(</span><span class="n">cast</span><span class="o">=</span><span class="p">[</span><span class="n">Enum</span><span class="p">])</span>
 
 
-<div class="viewcode-block" id="as_dict"><a class="viewcode-back" href="../../../wa_me.core.html#wa_me.core.converter.as_dict">[docs]</a><span class="k">def</span> <span class="nf">as_dict</span><span class="p">(</span><span class="n">data</span><span class="p">:</span> <span class="n">T</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]:</span>
+<div class="viewcode-block" id="as_dict"><a class="viewcode-back" href="../../../wa_me.core.html#wa_me.utils.converter.as_dict">[docs]</a><span class="k">def</span> <span class="nf">as_dict</span><span class="p">(</span><span class="n">data</span><span class="p">:</span> <span class="n">T</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">]:</span>
     <span class="sd">&quot;&quot;&quot;Create a dictionary from a data class instance.</span>
 
 <span class="sd">    Parameters</span>
@@ -80,13 +78,10 @@ <h1>Source code for wa_me.core.converter</h1><div class="highlight"><pre>
             <span class="k">if</span> <span class="n">v</span> <span class="ow">is</span> <span class="ow">not</span> <span class="kc">None</span>
         <span class="p">}</span>
 
-    <span class="k">try</span><span class="p">:</span>
-        <span class="k">return</span> <span class="n">_as_dict</span><span class="p">(</span><span class="n">asdict</span><span class="p">(</span><span class="n">data</span><span class="p">))</span>
-    <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
-        <span class="k">raise</span> <span class="n">ValidationError</span><span class="p">(</span><span class="n">e</span><span class="p">)</span></div>
+    <span class="k">return</span> <span class="n">_as_dict</span><span class="p">(</span><span class="n">asdict</span><span class="p">(</span><span class="n">data</span><span class="p">))</span></div>
 
 
-<div class="viewcode-block" id="from_dict"><a class="viewcode-back" href="../../../wa_me.core.html#wa_me.core.converter.from_dict">[docs]</a><span class="k">def</span> <span class="nf">from_dict</span><span class="p">(</span><span class="n">data_class</span><span class="p">:</span> <span class="n">Type</span><span class="p">[</span><span class="n">T</span><span class="p">],</span> <span class="n">data</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">T</span><span class="p">:</span>
+<div class="viewcode-block" id="from_dict"><a class="viewcode-back" href="../../../wa_me.core.html#wa_me.utils.converter.from_dict">[docs]</a><span class="k">def</span> <span class="nf">from_dict</span><span class="p">(</span><span class="n">data_class</span><span class="p">:</span> <span class="n">Type</span><span class="p">[</span><span class="n">T</span><span class="p">],</span> <span class="n">data</span><span class="p">:</span> <span class="n">Dict</span><span class="p">[</span><span class="nb">str</span><span class="p">,</span> <span class="n">Any</span><span class="p">])</span> <span class="o">-&gt;</span> <span class="n">T</span><span class="p">:</span>
     <span class="sd">&quot;&quot;&quot;Create a data class instance from a dictionary.</span>
 
 <span class="sd">    Parameters</span>
@@ -116,10 +111,7 @@ <h1>Source code for wa_me.core.converter</h1><div class="highlight"><pre>
             <span class="k">for</span> <span class="n">k</span><span class="p">,</span> <span class="n">v</span> <span class="ow">in</span> <span class="n">_data</span><span class="o">.</span><span class="n">items</span><span class="p">()</span>
         <span class="p">}</span>
 
-    <span class="k">try</span><span class="p">:</span>
-        <span class="k">return</span> <span class="n">dacite</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">data_class</span><span class="o">=</span><span class="n">data_class</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">_from_dict</span><span class="p">(</span><span class="n">data</span><span class="p">),</span> <span class="n">config</span><span class="o">=</span><span class="n">config</span><span class="p">)</span>
-    <span class="k">except</span> <span class="ne">Exception</span> <span class="k">as</span> <span class="n">e</span><span class="p">:</span>
-        <span class="k">raise</span> <span class="n">ValidationError</span><span class="p">(</span><span class="n">e</span><span class="p">)</span></div>
+    <span class="k">return</span> <span class="n">dacite</span><span class="o">.</span><span class="n">from_dict</span><span class="p">(</span><span class="n">data_class</span><span class="o">=</span><span class="n">data_class</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="n">_from_dict</span><span class="p">(</span><span class="n">data</span><span class="p">),</span> <span class="n">config</span><span class="o">=</span><span class="n">config</span><span class="p">)</span></div>
 </pre></div>
 
           </div>

docs/_build/html/_sources/wa_me.core.rst.txt

@@ -12,10 +12,10 @@ wa\_me.core.client module
    :undoc-members:
    :show-inheritance:
 
-wa\_me.core.converter module
+wa\_me.utils.converter module
 ----------------------------
 
-.. automodule:: wa_me.core.converter
+.. automodule:: wa_me.utils.converter
    :members:
    :undoc-members:
    :show-inheritance:

docs/_build/html/genindex.html

@@ -105,7 +105,7 @@ <h2 id="A">A</h2>
 </li>
       <li><a href="wa_me.classes.html#wa_me.classes.events.Sticker.animated">animated (wa_me.classes.events.Sticker attribute)</a>
 </li>
-      <li><a href="wa_me.core.html#wa_me.core.converter.as_dict">as_dict() (in module wa_me.core.converter)</a>
+      <li><a href="wa_me.core.html#wa_me.utils.converter.as_dict">as_dict() (in module wa_me.utils.converter)</a>
 </li>
       <li><a href="wa_me.classes.html#wa_me.classes.events.Audio">Audio (class in wa_me.classes.events)</a>
 
@@ -541,7 +541,7 @@ <h2 id="F">F</h2>
 </li>
       <li><a href="wa_me.classes.html#wa_me.classes.events.Context.frequently_forwarded">frequently_forwarded (wa_me.classes.events.Context attribute)</a>
 </li>
-      <li><a href="wa_me.core.html#wa_me.core.converter.from_dict">from_dict() (in module wa_me.core.converter)</a>
+      <li><a href="wa_me.core.html#wa_me.utils.converter.from_dict">from_dict() (in module wa_me.utils.converter)</a>
 </li>
   </ul></td>
 </tr></table>
@@ -862,14 +862,14 @@ <h2 id="M">M</h2>
         <li><a href="wa_me.core.html#module-wa_me.core">wa_me.core</a>
 </li>
         <li><a href="wa_me.core.html#module-wa_me.core.client">wa_me.core.client</a>
-</li>
-        <li><a href="wa_me.core.html#module-wa_me.core.converter">wa_me.core.converter</a>
 </li>
         <li><a href="wa_me.core.html#module-wa_me.core.errors">wa_me.core.errors</a>
 </li>
         <li><a href="wa_me.core.html#module-wa_me.core.http">wa_me.core.http</a>
 </li>
         <li><a href="wa_me.utils.html#module-wa_me.utils">wa_me.utils</a>
+</li>
+        <li><a href="wa_me.core.html#module-wa_me.utils.converter">wa_me.utils.converter</a>
 </li>
         <li><a href="wa_me.utils.html#module-wa_me.utils.routine">wa_me.utils.routine</a>
 </li>
@@ -1620,13 +1620,6 @@ <h2 id="W">W</h2>
 
       <ul>
         <li><a href="wa_me.core.html#module-wa_me.core.client">module</a>
-</li>
-      </ul></li>
-      <li>
-    wa_me.core.converter
-
-      <ul>
-        <li><a href="wa_me.core.html#module-wa_me.core.converter">module</a>
 </li>
       </ul></li>
       <li>
@@ -1648,6 +1641,13 @@ <h2 id="W">W</h2>
 
       <ul>
         <li><a href="wa_me.utils.html#module-wa_me.utils">module</a>
+</li>
+      </ul></li>
+      <li>
+    wa_me.utils.converter
+
+      <ul>
+        <li><a href="wa_me.core.html#module-wa_me.utils.converter">module</a>
 </li>
       </ul></li>
       <li>
@@ -1664,9 +1664,9 @@ <h2 id="W">W</h2>
         <li><a href="wa_me.utils.html#module-wa_me.utils.ttl_dict">module</a>
 </li>
       </ul></li>
-      <li><a href="wa_me.classes.html#wa_me.classes.responses.BusinessProfile.websites">websites (wa_me.classes.responses.BusinessProfile attribute)</a>
+      <li><a href="wa_me.core.html#wa_me.core.errors.WaMeException">WaMeException</a>
 </li>
-      <li><a href="wa_me.core.html#wa_me.core.errors.WhatsappException">WhatsappException</a>
+      <li><a href="wa_me.classes.html#wa_me.classes.responses.BusinessProfile.websites">websites (wa_me.classes.responses.BusinessProfile attribute)</a>
 </li>
       <li><a href="wa_me.core.html#wa_me.core.errors.WhatsappServerError">WhatsappServerError</a>
 </li>

docs/_build/html/modules.html

@@ -53,7 +53,7 @@ <h1>wa_me<a class="headerlink" href="#wa-me" title="Permalink to this heading">
 <li class="toctree-l3"><a class="reference internal" href="wa_me.core.html">wa_me.core package</a><ul>
 <li class="toctree-l4"><a class="reference internal" href="wa_me.core.html#submodules">Submodules</a></li>
 <li class="toctree-l4"><a class="reference internal" href="wa_me.core.html#module-wa_me.core.client">wa_me.core.client module</a></li>
-<li class="toctree-l4"><a class="reference internal" href="wa_me.core.html#module-wa_me.core.converter">wa_me.core.converter module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="wa_me.core.html#wa-me-utils-converter-module">wa_me.utils.converter module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="wa_me.core.html#module-wa_me.core.errors">wa_me.core.errors module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="wa_me.core.html#module-wa_me.core.http">wa_me.core.http module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="wa_me.core.html#module-wa_me.core">Module contents</a></li>

docs/_build/html/py-modindex.html

@@ -100,22 +100,22 @@ <h1>Python Module Index</h1>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
-       <a href="wa_me.core.html#module-wa_me.core.converter"><code class="xref">wa_me.core.converter</code></a></td><td>
+       <a href="wa_me.core.html#module-wa_me.core.errors"><code class="xref">wa_me.core.errors</code></a></td><td>
        <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
-       <a href="wa_me.core.html#module-wa_me.core.errors"><code class="xref">wa_me.core.errors</code></a></td><td>
+       <a href="wa_me.core.html#module-wa_me.core.http"><code class="xref">wa_me.core.http</code></a></td><td>
        <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
-       <a href="wa_me.core.html#module-wa_me.core.http"><code class="xref">wa_me.core.http</code></a></td><td>
+       <a href="wa_me.utils.html#module-wa_me.utils"><code class="xref">wa_me.utils</code></a></td><td>
        <em></em></td></tr>
      <tr class="cg-1">
        <td></td>
        <td>&#160;&#160;&#160;
-       <a href="wa_me.utils.html#module-wa_me.utils"><code class="xref">wa_me.utils</code></a></td><td>
+       <a href="wa_me.core.html#module-wa_me.utils.converter"><code class="xref">wa_me.utils.converter</code></a></td><td>
        <em></em></td></tr>
      <tr class="cg-1">
        <td></td>

docs/_build/html/readme.html

@@ -51,7 +51,13 @@ <h1 align="center">
 <section id="features">
 <h2>Features<a class="headerlink" href="#features" title="Permalink to this heading">¶</a></h2>
 <ul class="simple">
-<li><p>Full <a class="reference external" href="https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages">Send Messages</a> Support (text, audio, contacts, documents, images, interactive, location, sticker, and videos)</p></li>
+<li><p>Full <a class="reference external" href="https://developers.facebook.com/docs/whatsapp/cloud-api/reference/messages">Send Messages</a> Support:
+* text
+* media (audio, documents, images, sticker, and videos)
+* contacts
+* interactive (buttons, list, and products)
+* location
+* templates</p></li>
 <li><p>Full <a class="reference external" href="https://developers.facebook.com/docs/whatsapp/cloud-api/webhooks/components">Webhook Notification</a> Parsing Support</p></li>
 </ul>
 </section>