Deploying to gh-pages from @ Eledio/superfaktura-client@0319228ba1 🚀

This commit is contained in:
rici4kubicek
2025-03-04 12:53:10 +00:00
parent 0e2cf78edf
commit 260765b5c2
4 changed files with 13 additions and 25 deletions

File diff suppressed because one or more lines are too long

View File

@@ -765,11 +765,7 @@ It allows for retrieving, creating, updating, and deleting invoices.</p>
</ul> </ul>
</dd> </dd>
<dt class="field-even">Returns<span class="colon">:</span></dt> <dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The response model for the invoice. <dd class="field-even"><p>The response model for the invoice.</p>
:param invoice_settings:
:param contact:
:param items:
:param invoice_model:</p>
</dd> </dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt> <dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceRespModel" title="superfaktura.invoice.InvoiceRespModel">InvoiceRespModel</a></p> <dd class="field-odd"><p><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceRespModel" title="superfaktura.invoice.InvoiceRespModel">InvoiceRespModel</a></p>
@@ -1120,7 +1116,7 @@ It allows for retrieving, creating, updating, and deleting invoices.</p>
<dl class="py attribute"> <dl class="py attribute">
<dt class="sig sig-object py"> <dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">invoice_token</span></span></dt> <span class="sig-name descname"><span class="pre">-</span> <span class="pre">invoice_token</span></span></dt>
<dd><p>The token of</p> <dd><p>The token of the invoice.</p>
<dl class="field-list simple"> <dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt> <dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[str]</p> <dd class="field-odd"><p>Optional[str]</p>
@@ -1158,7 +1154,7 @@ It allows for retrieving, creating, updating, and deleting invoices.</p>
<dl class="py method"> <dl class="py method">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.as_dict"> <dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.as_dict">
<span class="sig-name descname"><span class="pre">as_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.as_dict" title="Link to this definition"></a></dt> <span class="sig-name descname"><span class="pre">as_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.as_dict" title="Link to this definition"></a></dt>
<dd><p>Returns a dictionary representation of the ClientContactModel.</p> <dd><p>Returns a dictionary representation of the InvoiceSettings.</p>
</dd></dl> </dd></dl>
<dl class="py attribute"> <dl class="py attribute">
@@ -1286,11 +1282,9 @@ etc.).</p></li>
</dd> </dd>
</dl> </dl>
<p class="rubric">Examples</p> <p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span><span class="w"> </span><span class="nn">superfaktura.invoice</span><span class="w"> </span><span class="kn">import</span> <span class="n">Invoice</span> <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">api</span> <span class="o">=</span> <span class="n">SuperFakturaAPI</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span><span class="w"> </span><span class="nn">superfaktura.enumerations.language</span><span class="w"> </span><span class="kn">import</span> <span class="n">Language</span> <span class="gp">&gt;&gt;&gt; </span><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s2">&quot;data.pdf&quot;</span><span class="p">,</span> <span class="s2">&quot;wb&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">invoice</span> <span class="o">=</span> <span class="n">Invoice</span><span class="p">()</span> <span class="gp">&gt;&gt;&gt; </span> <span class="n">api</span><span class="o">.</span><span class="n">download</span><span class="p">(</span><span class="s2">&quot;some/endpoint&quot;</span><span class="p">,</span> <span class="n">descriptor</span><span class="o">=</span><span class="n">f</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s2">&quot;invoice.pdf&quot;</span><span class="p">,</span> <span class="s2">&quot;wb&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
<span class="gp">&gt;&gt;&gt; </span> <span class="n">invoice</span><span class="o">.</span><span class="n">get_pdf</span><span class="p">(</span><span class="n">invoice</span><span class="o">=</span><span class="n">invoice_data</span><span class="p">,</span> <span class="n">descriptor</span><span class="o">=</span><span class="n">f</span><span class="p">,</span> <span class="n">language</span><span class="o">=</span><span class="n">Language</span><span class="o">.</span><span class="n">English</span><span class="p">)</span>
</pre></div> </pre></div>
</div> </div>
<p class="rubric">Notes</p> <p class="rubric">Notes</p>

View File

@@ -203,11 +203,7 @@ It allows for retrieving, creating, updating, and deleting invoices.</p>
</ul> </ul>
</dd> </dd>
<dt class="field-even">Returns<span class="colon">:</span></dt> <dt class="field-even">Returns<span class="colon">:</span></dt>
<dd class="field-even"><p>The response model for the invoice. <dd class="field-even"><p>The response model for the invoice.</p>
:param invoice_settings:
:param contact:
:param items:
:param invoice_model:</p>
</dd> </dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt> <dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p><a class="reference internal" href="#superfaktura.invoice.InvoiceRespModel" title="superfaktura.invoice.InvoiceRespModel">InvoiceRespModel</a></p> <dd class="field-odd"><p><a class="reference internal" href="#superfaktura.invoice.InvoiceRespModel" title="superfaktura.invoice.InvoiceRespModel">InvoiceRespModel</a></p>
@@ -558,7 +554,7 @@ It allows for retrieving, creating, updating, and deleting invoices.</p>
<dl class="py attribute"> <dl class="py attribute">
<dt class="sig sig-object py"> <dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">invoice_token</span></span></dt> <span class="sig-name descname"><span class="pre">-</span> <span class="pre">invoice_token</span></span></dt>
<dd><p>The token of</p> <dd><p>The token of the invoice.</p>
<dl class="field-list simple"> <dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt> <dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>Optional[str]</p> <dd class="field-odd"><p>Optional[str]</p>
@@ -596,7 +592,7 @@ It allows for retrieving, creating, updating, and deleting invoices.</p>
<dl class="py method"> <dl class="py method">
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.as_dict"> <dt class="sig sig-object py" id="superfaktura.invoice.InvoiceSettings.as_dict">
<span class="sig-name descname"><span class="pre">as_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.as_dict" title="Link to this definition"></a></dt> <span class="sig-name descname"><span class="pre">as_dict</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">dict</span></span></span><a class="headerlink" href="#superfaktura.invoice.InvoiceSettings.as_dict" title="Link to this definition"></a></dt>
<dd><p>Returns a dictionary representation of the ClientContactModel.</p> <dd><p>Returns a dictionary representation of the InvoiceSettings.</p>
</dd></dl> </dd></dl>
<dl class="py attribute"> <dl class="py attribute">

View File

@@ -125,11 +125,9 @@ etc.).</p></li>
</dd> </dd>
</dl> </dl>
<p class="rubric">Examples</p> <p class="rubric">Examples</p>
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span><span class="w"> </span><span class="nn">superfaktura.invoice</span><span class="w"> </span><span class="kn">import</span> <span class="n">Invoice</span> <div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">&gt;&gt;&gt; </span><span class="n">api</span> <span class="o">=</span> <span class="n">SuperFakturaAPI</span><span class="p">()</span>
<span class="gp">&gt;&gt;&gt; </span><span class="kn">from</span><span class="w"> </span><span class="nn">superfaktura.enumerations.language</span><span class="w"> </span><span class="kn">import</span> <span class="n">Language</span> <span class="gp">&gt;&gt;&gt; </span><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s2">&quot;data.pdf&quot;</span><span class="p">,</span> <span class="s2">&quot;wb&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">invoice</span> <span class="o">=</span> <span class="n">Invoice</span><span class="p">()</span> <span class="gp">&gt;&gt;&gt; </span> <span class="n">api</span><span class="o">.</span><span class="n">download</span><span class="p">(</span><span class="s2">&quot;some/endpoint&quot;</span><span class="p">,</span> <span class="n">descriptor</span><span class="o">=</span><span class="n">f</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s2">&quot;invoice.pdf&quot;</span><span class="p">,</span> <span class="s2">&quot;wb&quot;</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
<span class="gp">&gt;&gt;&gt; </span> <span class="n">invoice</span><span class="o">.</span><span class="n">get_pdf</span><span class="p">(</span><span class="n">invoice</span><span class="o">=</span><span class="n">invoice_data</span><span class="p">,</span> <span class="n">descriptor</span><span class="o">=</span><span class="n">f</span><span class="p">,</span> <span class="n">language</span><span class="o">=</span><span class="n">Language</span><span class="o">.</span><span class="n">English</span><span class="p">)</span>
</pre></div> </pre></div>
</div> </div>
<p class="rubric">Notes</p> <p class="rubric">Notes</p>