Deploying to gh-pages from @ Eledio/superfaktura-client@62274e47f7 🚀

2025-11-01 00:18:25 +01:00 · 2025-03-03 19:14:31 +00:00
parent 26694f6987
commit fa9085ec83
20 changed files with 671 additions and 34 deletions
--- a/genindex.html
+++ b/genindex.html
@@ -42,6 +42,7 @@
              <ul>
 <li class="toctree-l1"><a class="reference internal" href="superfaktura.html">SuperFaktura API client</a></li>
 <li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
+<li class="toctree-l1"><a class="reference internal" href="examples.html">Examples of SuperFaktura API client usage</a></li>
 </ul>

        </div>
@@ -119,6 +120,8 @@
        <li><a href="superfaktura.html#superfaktura.invoice.InvoiceItem.as_dict">(superfaktura.invoice.InvoiceItem method)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem.as_dict">[1]</a>
 </li>
        <li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.as_dict">(superfaktura.invoice.InvoiceModel method)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.as_dict">[1]</a>
+</li>
+        <li><a href="superfaktura.html#superfaktura.invoice.InvoiceSettings.as_dict">(superfaktura.invoice.InvoiceSettings method)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings.as_dict">[1]</a>
 </li>
      </ul></li>
  </ul></td>
@@ -144,6 +147,8 @@
      <li><a href="superfaktura.bank_account.html#superfaktura.bank_account.BankAccount">BankAccount (class in superfaktura.bank_account)</a>, <a href="superfaktura.html#superfaktura.bank_account.BankAccount">[1]</a>
 </li>
      <li><a href="superfaktura.bank_account.html#superfaktura.bank_account.BankAccountModel">BankAccountModel (class in superfaktura.bank_account)</a>, <a href="superfaktura.html#superfaktura.bank_account.BankAccountModel">[1]</a>
+</li>
+      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceSettings.bysquare">bysquare (superfaktura.invoice.InvoiceSettings attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings.bysquare">[1]</a>
 </li>
  </ul></td>
 </tr></table>
@@ -151,6 +156,8 @@
 <h2 id="C">C</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceSettings.callback_payment">callback_payment (superfaktura.invoice.InvoiceSettings attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings.callback_payment">[1]</a>
+</li>
      <li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.city">city (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.city">[1]</a>
 </li>
      <li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContact">ClientContact (class in superfaktura.client_contacts)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContact">[1]</a>
@@ -165,10 +172,10 @@
        <li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.comment">(superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.comment">[1]</a>
 </li>
      </ul></li>
-      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.constant">constant (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.constant">[1]</a>
-</li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.constant">constant (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.constant">[1]</a>
+</li>
      <li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.country">country (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.country">[1]</a>
 </li>
      <li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.country_id">country_id (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.country_id">[1]</a>
@@ -253,12 +260,30 @@
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.email">email (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.email">[1]</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceRespModel.error">error (superfaktura.invoice.InvoiceRespModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceRespModel.error">[1]</a>
+</li>
+      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceRespModel.error_message">error_message (superfaktura.invoice.InvoiceRespModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceRespModel.error_message">[1]</a>
+</li>
      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.estimate_id">estimate_id (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.estimate_id">[1]</a>
 </li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="superfaktura.enumerations.currency.html#superfaktura.enumerations.currency.Currencies.EUR">EUR (superfaktura.enumerations.currency.Currencies attribute)</a>, <a href="superfaktura.enumerations.html#superfaktura.enumerations.currency.Currencies.EUR">[1]</a>
 </li>
+      <li>
+    examples.add_invoice
+
+      <ul>
+        <li><a href="examples.html#module-examples.add_invoice">module</a>
+</li>
+      </ul></li>
+      <li>
+    examples.get_country_list
+
+      <ul>
+        <li><a href="examples.html#module-examples.get_country_list">module</a>
+</li>
+      </ul></li>
  </ul></td>
 </tr></table>

@@ -286,6 +311,8 @@
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContact.get_client">get_client() (superfaktura.client_contacts.ClientContact method)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContact.get_client">[1]</a>
+</li>
+      <li><a href="superfaktura.html#superfaktura.invoice.Invoice.get_pdf">get_pdf() (superfaktura.invoice.Invoice method)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.Invoice.get_pdf">[1]</a>
 </li>
  </ul></td>
 </tr></table>
@@ -323,15 +350,23 @@
 </li>
      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceType.INVOICE">INVOICE (superfaktura.invoice.InvoiceType attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceType.INVOICE">[1]</a>
 </li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.invoice_currency">invoice_currency (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.invoice_currency">[1]</a>
 </li>
+      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceRespModel.invoice_id">invoice_id (superfaktura.invoice.InvoiceRespModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceRespModel.invoice_id">[1]</a>
+</li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.invoice_no_formatted">invoice_no_formatted (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.invoice_no_formatted">[1]</a>
+</li>
+      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceRespModel.invoice_token">invoice_token (superfaktura.invoice.InvoiceRespModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceRespModel.invoice_token">[1]</a>
 </li>
      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceItem">InvoiceItem (class in superfaktura.invoice)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem">[1]</a>
 </li>
      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel">InvoiceModel (class in superfaktura.invoice)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel">[1]</a>
+</li>
+      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceRespModel">InvoiceRespModel (class in superfaktura.invoice)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceRespModel">[1]</a>
+</li>
+      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceSettings">InvoiceSettings (class in superfaktura.invoice)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings">[1]</a>
 </li>
      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceType">InvoiceType (class in superfaktura.invoice)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceType">[1]</a>
 </li>
@@ -351,6 +386,8 @@
 <h2 id="L">L</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceSettings.language">language (superfaktura.invoice.InvoiceSettings attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings.language">[1]</a>
+</li>
      <li><a href="superfaktura.bank_account.html#superfaktura.bank_account.BankAccount.list">list() (superfaktura.bank_account.BankAccount method)</a>, <a href="superfaktura.html#superfaktura.bank_account.BankAccount.list">[1]</a>

      <ul>
@@ -369,6 +406,12 @@
 <h2 id="M">M</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="examples.html#examples.add_invoice.main">main() (in module examples.add_invoice)</a>
+
+      <ul>
+        <li><a href="examples.html#examples.get_country_list.main">(in module examples.get_country_list)</a>
+</li>
+      </ul></li>
      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.mark_sent">mark_sent (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.mark_sent">[1]</a>
 </li>
      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.mark_sent_message">mark_sent_message (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.mark_sent_message">[1]</a>
@@ -381,6 +424,10 @@
    module

      <ul>
+        <li><a href="examples.html#module-examples.add_invoice">examples.add_invoice</a>
+</li>
+        <li><a href="examples.html#module-examples.get_country_list">examples.get_country_list</a>
+</li>
        <li><a href="superfaktura.bank_account.html#module-superfaktura.bank_account">superfaktura.bank_account</a>, <a href="superfaktura.html#module-superfaktura.bank_account">[1]</a>
 </li>
        <li><a href="superfaktura.client_contacts.html#module-superfaktura.client_contacts">superfaktura.client_contacts</a>, <a href="superfaktura.html#module-superfaktura.client_contacts">[1]</a>
@@ -423,6 +470,10 @@

 <h2 id="O">O</h2>
 <table style="width: 100%" class="indextable genindextable"><tr>
+  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceSettings.online_payment">online_payment (superfaktura.invoice.InvoiceSettings attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings.online_payment">[1]</a>
+</li>
+  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.order_no">order_no (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.order_no">[1]</a>
 </li>
@@ -435,11 +486,15 @@
      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.parent_id">parent_id (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.parent_id">[1]</a>
 </li>
      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.paydate">paydate (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.paydate">[1]</a>
+</li>
+      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceSettings.payment_info">payment_info (superfaktura.invoice.InvoiceSettings attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings.payment_info">[1]</a>
 </li>
      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.payment_type">payment_type (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.payment_type">[1]</a>
 </li>
  </ul></td>
  <td style="width: 33%; vertical-align: top;"><ul>
+      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceSettings.paypal">paypal (superfaktura.invoice.InvoiceSettings attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings.paypal">[1]</a>
+</li>
      <li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.phone">phone (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.phone">[1]</a>
 </li>
      <li><a href="superfaktura.html#superfaktura.superfaktura_api.SuperFakturaAPI.post">post() (superfaktura.superfaktura_api.SuperFakturaAPI method)</a>, <a href="superfaktura.superfaktura_api.html#superfaktura.superfaktura_api.SuperFakturaAPI.post">[1]</a>
@@ -473,12 +528,18 @@
      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.sequence_id">sequence_id (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.sequence_id">[1]</a>
 </li>
      <li><a href="superfaktura.bank_account.html#superfaktura.bank_account.BankAccountModel.show">show (superfaktura.bank_account.BankAccountModel attribute)</a>, <a href="superfaktura.html#superfaktura.bank_account.BankAccountModel.show">[1]</a>
+</li>
+      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceSettings.show_prices">show_prices (superfaktura.invoice.InvoiceSettings attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings.show_prices">[1]</a>
+</li>
+      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceSettings.signature">signature (superfaktura.invoice.InvoiceSettings attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings.signature">[1]</a>
 </li>
      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceItem.sku">sku (superfaktura.invoice.InvoiceItem attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem.sku">[1]</a>
 </li>
      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.specific">specific (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.specific">[1]</a>
 </li>
      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceItem.stock_item_id">stock_item_id (superfaktura.invoice.InvoiceItem attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem.stock_item_id">[1]</a>
+</li>
+      <li><a href="superfaktura.html#superfaktura.invoice.InvoiceSettings.summary_bg_color">summary_bg_color (superfaktura.invoice.InvoiceSettings attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceSettings.summary_bg_color">[1]</a>
 </li>
      <li>
    superfaktura.bank_account
@@ -508,6 +569,8 @@
        <li><a href="superfaktura.enumerations.currency.html#module-superfaktura.enumerations.currency">module</a>, <a href="superfaktura.enumerations.html#module-superfaktura.enumerations.currency">[1]</a>
 </li>
      </ul></li>
+  </ul></td>
+  <td style="width: 33%; vertical-align: top;"><ul>
      <li>
    superfaktura.invoice

@@ -515,8 +578,6 @@
        <li><a href="superfaktura.html#module-superfaktura.invoice">module</a>, <a href="superfaktura.invoice.html#module-superfaktura.invoice">[1]</a>
 </li>
      </ul></li>
-  </ul></td>
-  <td style="width: 33%; vertical-align: top;"><ul>
      <li>
    superfaktura.superfaktura_api