mirror of
https://github.com/Eledio/superfaktura-client.git
synced 2025-10-31 16:11:20 +01:00
Deploying to gh-pages from @ Eledio/superfaktura-client@8d5bf14be3 🚀
This commit is contained in:
rici4kubicek
@@ -222,10 +222,10 @@
|
||||
</li>
|
||||
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.delivery_name">delivery_name (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.delivery_name">[1]</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.delivery_phone">delivery_phone (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.delivery_phone">[1]</a>
|
||||
</li>
|
||||
</ul></td>
|
||||
<td style="width: 33%; vertical-align: top;"><ul>
|
||||
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.delivery_type">delivery_type (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.delivery_type">[1]</a>
|
||||
</li>
|
||||
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.delivery_zip">delivery_zip (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.delivery_zip">[1]</a>
|
||||
@@ -247,6 +247,8 @@
|
||||
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceItem.discount_description">discount_description (superfaktura.invoice.InvoiceItem attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem.discount_description">[1]</a>
|
||||
</li>
|
||||
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.discount_total">discount_total (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.discount_total">[1]</a>
|
||||
</li>
|
||||
<li><a href="superfaktura.html#superfaktura.superfaktura_api.SuperFakturaAPI.download">download() (superfaktura.superfaktura_api.SuperFakturaAPI method)</a>, <a href="superfaktura.superfaktura_api.html#superfaktura.superfaktura_api.SuperFakturaAPI.download">[1]</a>
|
||||
</li>
|
||||
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.due">due (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.due">[1]</a>
|
||||
</li>
|
||||
|
||||
BIN
objects.inv
BIN
objects.inv
Binary file not shown.
File diff suppressed because one or more lines are too long
@@ -208,6 +208,7 @@
|
||||
</li>
|
||||
<li class="toctree-l2"><a class="reference internal" href="#module-superfaktura.superfaktura_api">SuperFaktura API</a><ul>
|
||||
<li class="toctree-l3"><a class="reference internal" href="#superfaktura.superfaktura_api.SuperFakturaAPI"><code class="docutils literal notranslate"><span class="pre">SuperFakturaAPI</span></code></a><ul>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.superfaktura_api.SuperFakturaAPI.download"><code class="docutils literal notranslate"><span class="pre">SuperFakturaAPI.download()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.superfaktura_api.SuperFakturaAPI.get"><code class="docutils literal notranslate"><span class="pre">SuperFakturaAPI.get()</span></code></a></li>
|
||||
<li class="toctree-l4"><a class="reference internal" href="#superfaktura.superfaktura_api.SuperFakturaAPI.post"><code class="docutils literal notranslate"><span class="pre">SuperFakturaAPI.post()</span></code></a></li>
|
||||
</ul>
|
||||
@@ -778,20 +779,18 @@ It allows for retrieving, creating, updating, and deleting invoices.</p>
|
||||
|
||||
<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">bytes</span></span></span><a class="headerlink" href="#superfaktura.invoice.Invoice.get_pdf" title="Link to this definition"></a></dt>
|
||||
<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">descriptor</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><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></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">None</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>descriptor</strong> (<em>IO</em><em>[</em><em>bytes</em><em>]</em>) – The descriptor to write the PDF data to.</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 bytes containing the PDF data.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>bytes</p>
|
||||
<dd class="field-even"><p>None</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
@@ -1265,9 +1264,42 @@ It allows for reading, creating, updating, and deleting data in SuperFaktura.</p
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.superfaktura_api.</span></span><span class="sig-name descname"><span class="pre">SuperFakturaAPI</span></span><a class="headerlink" href="#superfaktura.superfaktura_api.SuperFakturaAPI" 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>
|
||||
<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.download">
|
||||
<span class="sig-name descname"><span class="pre">download</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">descriptor</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><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></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">None</span></span></span><a class="headerlink" href="#superfaktura.superfaktura_api.SuperFakturaAPI.download" title="Link to this definition"></a></dt>
|
||||
<dd><p>Download data stream from the SuperFaktura API.</p>
|
||||
<p>Download data stream from the specified endpoint in the SuperFaktura API.</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>endpoint</strong> (<em>str</em>) – The API endpoint to retrieve data from (e.g. ‘invoices’, ‘clients’,
|
||||
etc.).</p></li>
|
||||
<li><p><strong>descriptor</strong> (<em>IO</em><em>[</em><em>bytes</em><em>]</em>) – The descriptor to write the data stream to.</p></li>
|
||||
<li><p><strong>timeout</strong> (<em>int</em><em>, </em><em>optional</em>) – The timeout for the API request in seconds. Defaults to 5.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>None</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raises<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="superfaktura.superfaktura_api.html#superfaktura.superfaktura_api.SuperFakturaAPIException" title="superfaktura.superfaktura_api.SuperFakturaAPIException"><strong>SuperFakturaAPIException</strong></a> – If the API request fails or returns an error.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Examples</p>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </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>
|
||||
<span class="gp">>>> </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">>>> </span><span class="n">invoice</span> <span class="o">=</span> <span class="n">Invoice</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s2">"invoice.pdf"</span><span class="p">,</span> <span class="s2">"wb"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
|
||||
<span class="gp">>>> </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>
|
||||
</div>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>The available endpoints can be found in the SuperFaktura API documentation.</p>
|
||||
</dd></dl>
|
||||
|
||||
<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">bytes</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">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">
|
||||
@@ -1279,10 +1311,10 @@ etc.).</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>The retrieved data in bytes.</p>
|
||||
<dd class="field-even"><p>The retrieved data in JSON format.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>bytes</p>
|
||||
<dd class="field-odd"><p>Dict</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="superfaktura.superfaktura_api.html#superfaktura.superfaktura_api.SuperFakturaAPIException" title="superfaktura.superfaktura_api.SuperFakturaAPIException"><strong>SuperFakturaAPIException</strong></a> – If the API request fails or returns an error.</p>
|
||||
|
||||
@@ -217,20 +217,18 @@ It allows for retrieving, creating, updating, and deleting invoices.</p>
|
||||
|
||||
<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.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">bytes</span></span></span><a class="headerlink" href="#superfaktura.invoice.Invoice.get_pdf" title="Link to this definition"></a></dt>
|
||||
<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.InvoiceRespModel" title="superfaktura.invoice.InvoiceRespModel"><span class="pre">InvoiceRespModel</span></a></span></em>, <em class="sig-param"><span class="n"><span class="pre">descriptor</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><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></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">None</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.InvoiceRespModel" title="superfaktura.invoice.InvoiceRespModel"><em>InvoiceRespModel</em></a>) – The response model for the invoice.</p></li>
|
||||
<li><p><strong>descriptor</strong> (<em>IO</em><em>[</em><em>bytes</em><em>]</em>) – The descriptor to write the PDF data to.</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 bytes containing the PDF data.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>bytes</p>
|
||||
<dd class="field-even"><p>None</p>
|
||||
</dd>
|
||||
</dl>
|
||||
</dd></dl>
|
||||
|
||||
@@ -103,9 +103,42 @@ It allows for reading, creating, updating, and deleting data in SuperFaktura.</p
|
||||
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.superfaktura_api.</span></span><span class="sig-name descname"><span class="pre">SuperFakturaAPI</span></span><a class="headerlink" href="#superfaktura.superfaktura_api.SuperFakturaAPI" 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>
|
||||
<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.download">
|
||||
<span class="sig-name descname"><span class="pre">download</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">descriptor</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><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></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">None</span></span></span><a class="headerlink" href="#superfaktura.superfaktura_api.SuperFakturaAPI.download" title="Link to this definition"></a></dt>
|
||||
<dd><p>Download data stream from the SuperFaktura API.</p>
|
||||
<p>Download data stream from the specified endpoint in the SuperFaktura API.</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>endpoint</strong> (<em>str</em>) – The API endpoint to retrieve data from (e.g. ‘invoices’, ‘clients’,
|
||||
etc.).</p></li>
|
||||
<li><p><strong>descriptor</strong> (<em>IO</em><em>[</em><em>bytes</em><em>]</em>) – The descriptor to write the data stream to.</p></li>
|
||||
<li><p><strong>timeout</strong> (<em>int</em><em>, </em><em>optional</em>) – The timeout for the API request in seconds. Defaults to 5.</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>None</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Raises<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p><a class="reference internal" href="#superfaktura.superfaktura_api.SuperFakturaAPIException" title="superfaktura.superfaktura_api.SuperFakturaAPIException"><strong>SuperFakturaAPIException</strong></a> – If the API request fails or returns an error.</p>
|
||||
</dd>
|
||||
</dl>
|
||||
<p class="rubric">Examples</p>
|
||||
<div class="doctest highlight-default notranslate"><div class="highlight"><pre><span></span><span class="gp">>>> </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>
|
||||
<span class="gp">>>> </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">>>> </span><span class="n">invoice</span> <span class="o">=</span> <span class="n">Invoice</span><span class="p">()</span>
|
||||
<span class="gp">>>> </span><span class="k">with</span> <span class="nb">open</span><span class="p">(</span><span class="s2">"invoice.pdf"</span><span class="p">,</span> <span class="s2">"wb"</span><span class="p">)</span> <span class="k">as</span> <span class="n">f</span><span class="p">:</span>
|
||||
<span class="gp">>>> </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>
|
||||
</div>
|
||||
<p class="rubric">Notes</p>
|
||||
<p>The available endpoints can be found in the SuperFaktura API documentation.</p>
|
||||
</dd></dl>
|
||||
|
||||
<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">bytes</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">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">
|
||||
@@ -117,10 +150,10 @@ etc.).</p></li>
|
||||
</ul>
|
||||
</dd>
|
||||
<dt class="field-even">Returns<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p>The retrieved data in bytes.</p>
|
||||
<dd class="field-even"><p>The retrieved data in JSON format.</p>
|
||||
</dd>
|
||||
<dt class="field-odd">Return type<span class="colon">:</span></dt>
|
||||
<dd class="field-odd"><p>bytes</p>
|
||||
<dd class="field-odd"><p>Dict</p>
|
||||
</dd>
|
||||
<dt class="field-even">Raises<span class="colon">:</span></dt>
|
||||
<dd class="field-even"><p><a class="reference internal" href="#superfaktura.superfaktura_api.SuperFakturaAPIException" title="superfaktura.superfaktura_api.SuperFakturaAPIException"><strong>SuperFakturaAPIException</strong></a> – If the API request fails or returns an error.</p>
|
||||
|
||||
Reference in New Issue
Block a user