mirror of
https://github.com/Eledio/superfaktura-client.git
synced 2025-11-01 08:28:25 +01:00
Deploying to gh-pages from @ eledio-helpers/superfaktura-client@a4287523c3 🚀
This commit is contained in:
rici4kubicek
@@ -117,6 +117,7 @@
|
||||
<li class="toctree-l2"><a class="reference internal" href="#module-superfaktura.invoice">Invoice</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#superfaktura.invoice.Invoice"><code class="docutils literal notranslate"><span class="pre">Invoice</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.Invoice.add"><code class="docutils literal notranslate"><span class="pre">Invoice.add()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.Invoice.get_pdf"><code class="docutils literal notranslate"><span class="pre">Invoice.get_pdf()</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#superfaktura.invoice.InvoiceItem"><code class="docutils literal notranslate"><span class="pre">InvoiceItem</span></code></a><ul>
|
||||
@@ -178,6 +179,13 @@
|
||||
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceModel.vat_transfer"><code class="docutils literal notranslate"><span class="pre">InvoiceModel.vat_transfer</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#superfaktura.invoice.InvoiceRespModel"><code class="docutils literal notranslate"><span class="pre">InvoiceRespModel</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceRespModel.error"><code class="docutils literal notranslate"><span class="pre">InvoiceRespModel.error</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceRespModel.error_message"><code class="docutils literal notranslate"><span class="pre">InvoiceRespModel.error_message</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceRespModel.invoice_id"><code class="docutils literal notranslate"><span class="pre">InvoiceRespModel.invoice_id</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceRespModel.invoice_token"><code class="docutils literal notranslate"><span class="pre">InvoiceRespModel.invoice_token</span></code></a></li>
|
||||
</ul>
|
||||
</li>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#superfaktura.invoice.InvoiceType"><code class="docutils literal notranslate"><span class="pre">InvoiceType</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceType.INVOICE"><code class="docutils literal notranslate"><span class="pre">InvoiceType.INVOICE</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.invoice.InvoiceType.PROFORMA"><code class="docutils literal notranslate"><span class="pre">InvoiceType.PROFORMA</span></code></a></li>
|
||||
@@ -742,8 +750,46 @@ country_id=57,</p>
|
||||
</dl>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="superfaktura.invoice.Invoice.add">
|
||||
<span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">invoice_model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel" title="superfaktura.invoice.InvoiceModel"><span class="pre">InvoiceModel</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem" title="superfaktura.invoice.InvoiceItem"><span class="pre">InvoiceItem</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">contact</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel" title="superfaktura.client_contacts.ClientContactModel"><span class="pre">ClientContactModel</span></a></span></em><span class="sig-paren">)</span><a class="headerlink" href="#superfaktura.invoice.Invoice.add" title="Link to this definition"></a></dt>
|
||||
<dd><p>Creates a new invoice.</p>
|
||||
<span class="sig-name descname"><span class="pre">add</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">invoice_model</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel" title="superfaktura.invoice.InvoiceModel"><span class="pre">InvoiceModel</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">items</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">List</span><span class="p"><span class="pre">[</span></span><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem" title="superfaktura.invoice.InvoiceItem"><span class="pre">InvoiceItem</span></a><span class="p"><span class="pre">]</span></span></span></em>, <em class="sig-param"><span class="n"><span class="pre">contact</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel" title="superfaktura.client_contacts.ClientContactModel"><span class="pre">ClientContactModel</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceRespModel" title="superfaktura.invoice.InvoiceRespModel"><span class="pre">InvoiceRespModel</span></a></span></span><a class="headerlink" href="#superfaktura.invoice.Invoice.add" title="Link to this definition"></a></dt>
|
||||
<dd><p>Adds a new invoice.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>invoice_model</strong> (<a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel" title="superfaktura.invoice.InvoiceModel"><em>InvoiceModel</em></a>) – The invoice model.</p></li>
|
||||
<li><p><strong>items</strong> (<em>List</em><em>[</em><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem" title="superfaktura.invoice.InvoiceItem"><em>InvoiceItem</em></a><em>]</em>) – List of invoice items.</p></li>
|
||||
<li><p><strong>contact</strong> (<a class="reference internal" href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel" title="superfaktura.client_contacts.ClientContactModel"><em>ClientContactModel</em></a>) – The client contact model.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>The response model for the invoice.
|
||||
:param contact:
|
||||
:param items:
|
||||
:param invoice_model:</p>
|
||||
</dd>
|
||||
<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>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="superfaktura.invoice.Invoice.get_pdf">
|
||||
<span class="sig-name descname"><span class="pre">get_pdf</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">invoice</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceRespModel" title="superfaktura.invoice.InvoiceRespModel"><span class="pre">InvoiceRespModel</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">language</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">'cze'</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">IO</span><span class="p"><span class="pre">[</span></span><span class="pre">bytes</span><span class="p"><span class="pre">]</span></span></span></span><a class="headerlink" href="#superfaktura.invoice.Invoice.get_pdf" title="Link to this definition"></a></dt>
|
||||
<dd><p>Retrieves the PDF of the invoice.</p>
|
||||
<dl class="field-list simple">
|
||||
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><ul class="simple">
|
||||
<li><p><strong>invoice</strong> (<a class="reference internal" href="superfaktura.invoice.html#superfaktura.invoice.InvoiceRespModel" title="superfaktura.invoice.InvoiceRespModel"><em>InvoiceRespModel</em></a>) – The response model for the invoice.</p></li>
|
||||
<li><p><strong>language</strong> (<em>str</em>) – The language for the PDF.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>A file-like object containing the PDF data.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>IO[bytes]</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
@@ -1030,6 +1076,32 @@ country_id=57,</p>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceRespModel">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.invoice.</span></span><span class="sig-name descname"><span class="pre">InvoiceRespModel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">error</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">error_message</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">invoice_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">invoice_token</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#superfaktura.invoice.InvoiceRespModel" title="Link to this definition"></a></dt>
|
||||
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceRespModel.error">
|
||||
<span class="sig-name descname"><span class="pre">error</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceRespModel.error" title="Link to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceRespModel.error_message">
|
||||
<span class="sig-name descname"><span class="pre">error_message</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceRespModel.error_message" title="Link to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceRespModel.invoice_id">
|
||||
<span class="sig-name descname"><span class="pre">invoice_id</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">int</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceRespModel.invoice_id" title="Link to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
<dl class="py attribute">
|
||||
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceRespModel.invoice_token">
|
||||
<span class="sig-name descname"><span class="pre">invoice_token</span></span><em class="property"><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="pre">str</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></em><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">None</span></em><a class="headerlink" href="#superfaktura.invoice.InvoiceRespModel.invoice_token" title="Link to this definition"></a></dt>
|
||||
<dd></dd></dl>
|
||||
|
||||
</dd></dl>
|
||||
|
||||
<dl class="py class">
|
||||
<dt class="sig sig-object py" id="superfaktura.invoice.InvoiceType">
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.invoice.</span></span><span class="sig-name descname"><span class="pre">InvoiceType</span></span><a class="headerlink" href="#superfaktura.invoice.InvoiceType" title="Link to this definition"></a></dt>
|
||||
@@ -1087,7 +1159,7 @@ api.post(‘endpoint’, data)</p>
|
||||
<p>Base class for working with the SuperFaktura API.</p>
|
||||
<dl class="py method">
|
||||
<dt class="sig sig-object py" id="superfaktura.superfaktura_api.SuperFakturaAPI.get">
|
||||
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">5</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#superfaktura.superfaktura_api.SuperFakturaAPI.get" title="Link to this definition"></a></dt>
|
||||
<span class="sig-name descname"><span class="pre">get</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">endpoint</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">data_format</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">DataFormat</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">DataFormat.JSON</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">timeout</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">5</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#superfaktura.superfaktura_api.SuperFakturaAPI.get" title="Link to this definition"></a></dt>
|
||||
<dd><p>Retrieves data from the SuperFaktura API.</p>
|
||||
<p>Retrieves data from the specified endpoint in the SuperFaktura API.</p>
|
||||
<dl class="field-list simple">
|
||||
|
||||
Reference in New Issue
Block a user