This commit is contained in:
rici4kubicek
2025-02-08 19:25:18 +00:00
parent 927fd00c40
commit f0c4010202
88 changed files with 9945 additions and 0 deletions

4
.buildinfo Normal file
View File

@@ -0,0 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: d758b5e645f76712a6b5677043af1271
tags: 645f666f9bcd5a90fca523b33c5a78b7

8
_sources/index.rst.txt Normal file
View File

@@ -0,0 +1,8 @@
Welcome to SuperFaktura Client's documentation
=============================================
.. toctree::
:maxdepth: 2
superfaktura
installation

View File

@@ -0,0 +1,6 @@
Installation
====================
To install SuperFaktura Client, run the following command::
pip install git+https://github.com/eledio-helpers/superfaktura-client

View File

@@ -0,0 +1,7 @@
superfaktura.bank\_account module
=================================
.. automodule:: superfaktura.bank_account
:members:
:undoc-members:
:show-inheritance:

View File

@@ -0,0 +1,7 @@
superfaktura.client\_contacts module
====================================
.. automodule:: superfaktura.client_contacts
:members:
:undoc-members:
:show-inheritance:

View File

@@ -0,0 +1,7 @@
superfaktura.enumerations.currency module
=========================================
.. automodule:: superfaktura.enumerations.currency
:members:
:undoc-members:
:show-inheritance:

View File

@@ -0,0 +1,21 @@
superfaktura.enumerations package
=================================
Submodules
----------
superfaktura.enumerations.currency module
-----------------------------------------
.. automodule:: superfaktura.enumerations.currency
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: superfaktura.enumerations
:members:
:undoc-members:
:show-inheritance:

View File

@@ -0,0 +1,7 @@
superfaktura.invoice module
===========================
.. automodule:: superfaktura.invoice
:members:
:undoc-members:
:show-inheritance:

View File

@@ -0,0 +1,35 @@
SuperFaktura API client
====================
Bank account
---------------------------------
.. automodule:: superfaktura.bank_account
:members:
:undoc-members:
:show-inheritance:
Client contacts
------------------------------------
.. automodule:: superfaktura.client_contacts
:members:
:undoc-members:
:show-inheritance:
Invoice
---------------------------
.. automodule:: superfaktura.invoice
:members:
:undoc-members:
:show-inheritance:
SuperFaktura API
-------------------------------------
.. automodule:: superfaktura.superfaktura_api
:members:
:undoc-members:
:show-inheritance:

View File

@@ -0,0 +1,7 @@
superfaktura.superfaktura\_api module
=====================================
.. automodule:: superfaktura.superfaktura_api
:members:
:undoc-members:
:show-inheritance:

View File

@@ -0,0 +1,7 @@
superfaktura.utils.country module
=================================
.. automodule:: superfaktura.utils.country
:members:
:undoc-members:
:show-inheritance:

View File

@@ -0,0 +1,7 @@
superfaktura.utils.data\_types module
=====================================
.. automodule:: superfaktura.utils.data_types
:members:
:undoc-members:
:show-inheritance:

View File

@@ -0,0 +1,29 @@
superfaktura.utils package
==========================
Submodules
----------
superfaktura.utils.country module
---------------------------------
.. automodule:: superfaktura.utils.country
:members:
:undoc-members:
:show-inheritance:
superfaktura.utils.data\_types module
-------------------------------------
.. automodule:: superfaktura.utils.data_types
:members:
:undoc-members:
:show-inheritance:
Module contents
---------------
.. automodule:: superfaktura.utils
:members:
:undoc-members:
:show-inheritance:

View File

@@ -0,0 +1,123 @@
/* Compatability shim for jQuery and underscores.js.
*
* Copyright Sphinx contributors
* Released under the two clause BSD licence
*/
/**
* small helper function to urldecode strings
*
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/decodeURIComponent#Decoding_query_parameters_from_a_URL
*/
jQuery.urldecode = function(x) {
if (!x) {
return x
}
return decodeURIComponent(x.replace(/\+/g, ' '));
};
/**
* small helper function to urlencode strings
*/
jQuery.urlencode = encodeURIComponent;
/**
* This function returns the parsed url parameters of the
* current request. Multiple values per key are supported,
* it will always return arrays of strings for the value parts.
*/
jQuery.getQueryParameters = function(s) {
if (typeof s === 'undefined')
s = document.location.search;
var parts = s.substr(s.indexOf('?') + 1).split('&');
var result = {};
for (var i = 0; i < parts.length; i++) {
var tmp = parts[i].split('=', 2);
var key = jQuery.urldecode(tmp[0]);
var value = jQuery.urldecode(tmp[1]);
if (key in result)
result[key].push(value);
else
result[key] = [value];
}
return result;
};
/**
* highlight a given string on a jquery object by wrapping it in
* span elements with the given class name.
*/
jQuery.fn.highlightText = function(text, className) {
function highlight(node, addItems) {
if (node.nodeType === 3) {
var val = node.nodeValue;
var pos = val.toLowerCase().indexOf(text);
if (pos >= 0 &&
!jQuery(node.parentNode).hasClass(className) &&
!jQuery(node.parentNode).hasClass("nohighlight")) {
var span;
var isInSVG = jQuery(node).closest("body, svg, foreignObject").is("svg");
if (isInSVG) {
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
} else {
span = document.createElement("span");
span.className = className;
}
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
node.parentNode.insertBefore(span, node.parentNode.insertBefore(
document.createTextNode(val.substr(pos + text.length)),
node.nextSibling));
node.nodeValue = val.substr(0, pos);
if (isInSVG) {
var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect");
var bbox = node.parentElement.getBBox();
rect.x.baseVal.value = bbox.x;
rect.y.baseVal.value = bbox.y;
rect.width.baseVal.value = bbox.width;
rect.height.baseVal.value = bbox.height;
rect.setAttribute('class', className);
addItems.push({
"parent": node.parentNode,
"target": rect});
}
}
}
else if (!jQuery(node).is("button, select, textarea")) {
jQuery.each(node.childNodes, function() {
highlight(this, addItems);
});
}
}
var addItems = [];
var result = this.each(function() {
highlight(this, addItems);
});
for (var i = 0; i < addItems.length; ++i) {
jQuery(addItems[i].parent).before(addItems[i].target);
}
return result;
};
/*
* backward compatibility for jQuery.browser
* This will be supported until firefox bug is fixed.
*/
if (!jQuery.browser) {
jQuery.uaMatch = function(ua) {
ua = ua.toLowerCase();
var match = /(chrome)[ \/]([\w.]+)/.exec(ua) ||
/(webkit)[ \/]([\w.]+)/.exec(ua) ||
/(opera)(?:.*version|)[ \/]([\w.]+)/.exec(ua) ||
/(msie) ([\w.]+)/.exec(ua) ||
ua.indexOf("compatible") < 0 && /(mozilla)(?:.*? rv:([\w.]+)|)/.exec(ua) ||
[];
return {
browser: match[ 1 ] || "",
version: match[ 2 ] || "0"
};
};
jQuery.browser = {};
jQuery.browser[jQuery.uaMatch(navigator.userAgent).browser] = true;
}

914
_static/basic.css Normal file
View File

@@ -0,0 +1,914 @@
/*
* Sphinx stylesheet -- basic theme.
*/
/* -- main layout ----------------------------------------------------------- */
div.clearer {
clear: both;
}
div.section::after {
display: block;
content: '';
clear: left;
}
/* -- relbar ---------------------------------------------------------------- */
div.related {
width: 100%;
font-size: 90%;
}
div.related h3 {
display: none;
}
div.related ul {
margin: 0;
padding: 0 0 0 10px;
list-style: none;
}
div.related li {
display: inline;
}
div.related li.right {
float: right;
margin-right: 5px;
}
/* -- sidebar --------------------------------------------------------------- */
div.sphinxsidebarwrapper {
padding: 10px 5px 0 10px;
}
div.sphinxsidebar {
float: left;
width: 230px;
margin-left: -100%;
font-size: 90%;
word-wrap: break-word;
overflow-wrap : break-word;
}
div.sphinxsidebar ul {
list-style: none;
}
div.sphinxsidebar ul ul,
div.sphinxsidebar ul.want-points {
margin-left: 20px;
list-style: square;
}
div.sphinxsidebar ul ul {
margin-top: 0;
margin-bottom: 0;
}
div.sphinxsidebar form {
margin-top: 10px;
}
div.sphinxsidebar input {
border: 1px solid #98dbcc;
font-family: sans-serif;
font-size: 1em;
}
div.sphinxsidebar #searchbox form.search {
overflow: hidden;
}
div.sphinxsidebar #searchbox input[type="text"] {
float: left;
width: 80%;
padding: 0.25em;
box-sizing: border-box;
}
div.sphinxsidebar #searchbox input[type="submit"] {
float: left;
width: 20%;
border-left: none;
padding: 0.25em;
box-sizing: border-box;
}
img {
border: 0;
max-width: 100%;
}
/* -- search page ----------------------------------------------------------- */
ul.search {
margin-top: 10px;
}
ul.search li {
padding: 5px 0;
}
ul.search li a {
font-weight: bold;
}
ul.search li p.context {
color: #888;
margin: 2px 0 0 30px;
text-align: left;
}
ul.keywordmatches li.goodmatch a {
font-weight: bold;
}
/* -- index page ------------------------------------------------------------ */
table.contentstable {
width: 90%;
margin-left: auto;
margin-right: auto;
}
table.contentstable p.biglink {
line-height: 150%;
}
a.biglink {
font-size: 1.3em;
}
span.linkdescr {
font-style: italic;
padding-top: 5px;
font-size: 90%;
}
/* -- general index --------------------------------------------------------- */
table.indextable {
width: 100%;
}
table.indextable td {
text-align: left;
vertical-align: top;
}
table.indextable ul {
margin-top: 0;
margin-bottom: 0;
list-style-type: none;
}
table.indextable > tbody > tr > td > ul {
padding-left: 0em;
}
table.indextable tr.pcap {
height: 10px;
}
table.indextable tr.cap {
margin-top: 10px;
background-color: #f2f2f2;
}
img.toggler {
margin-right: 3px;
margin-top: 3px;
cursor: pointer;
}
div.modindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
}
div.genindex-jumpbox {
border-top: 1px solid #ddd;
border-bottom: 1px solid #ddd;
margin: 1em 0 1em 0;
padding: 0.4em;
}
/* -- domain module index --------------------------------------------------- */
table.modindextable td {
padding: 2px;
border-collapse: collapse;
}
/* -- general body styles --------------------------------------------------- */
div.body {
min-width: 360px;
max-width: 800px;
}
div.body p, div.body dd, div.body li, div.body blockquote {
-moz-hyphens: auto;
-ms-hyphens: auto;
-webkit-hyphens: auto;
hyphens: auto;
}
a.headerlink {
visibility: hidden;
}
a:visited {
color: #551A8B;
}
h1:hover > a.headerlink,
h2:hover > a.headerlink,
h3:hover > a.headerlink,
h4:hover > a.headerlink,
h5:hover > a.headerlink,
h6:hover > a.headerlink,
dt:hover > a.headerlink,
caption:hover > a.headerlink,
p.caption:hover > a.headerlink,
div.code-block-caption:hover > a.headerlink {
visibility: visible;
}
div.body p.caption {
text-align: inherit;
}
div.body td {
text-align: left;
}
.first {
margin-top: 0 !important;
}
p.rubric {
margin-top: 30px;
font-weight: bold;
}
img.align-left, figure.align-left, .figure.align-left, object.align-left {
clear: left;
float: left;
margin-right: 1em;
}
img.align-right, figure.align-right, .figure.align-right, object.align-right {
clear: right;
float: right;
margin-left: 1em;
}
img.align-center, figure.align-center, .figure.align-center, object.align-center {
display: block;
margin-left: auto;
margin-right: auto;
}
img.align-default, figure.align-default, .figure.align-default {
display: block;
margin-left: auto;
margin-right: auto;
}
.align-left {
text-align: left;
}
.align-center {
text-align: center;
}
.align-default {
text-align: center;
}
.align-right {
text-align: right;
}
/* -- sidebars -------------------------------------------------------------- */
div.sidebar,
aside.sidebar {
margin: 0 0 0.5em 1em;
border: 1px solid #ddb;
padding: 7px;
background-color: #ffe;
width: 40%;
float: right;
clear: right;
overflow-x: auto;
}
p.sidebar-title {
font-weight: bold;
}
nav.contents,
aside.topic,
div.admonition, div.topic, blockquote {
clear: left;
}
/* -- topics ---------------------------------------------------------------- */
nav.contents,
aside.topic,
div.topic {
border: 1px solid #ccc;
padding: 7px;
margin: 10px 0 10px 0;
}
p.topic-title {
font-size: 1.1em;
font-weight: bold;
margin-top: 10px;
}
/* -- admonitions ----------------------------------------------------------- */
div.admonition {
margin-top: 10px;
margin-bottom: 10px;
padding: 7px;
}
div.admonition dt {
font-weight: bold;
}
p.admonition-title {
margin: 0px 10px 5px 0px;
font-weight: bold;
}
div.body p.centered {
text-align: center;
margin-top: 25px;
}
/* -- content of sidebars/topics/admonitions -------------------------------- */
div.sidebar > :last-child,
aside.sidebar > :last-child,
nav.contents > :last-child,
aside.topic > :last-child,
div.topic > :last-child,
div.admonition > :last-child {
margin-bottom: 0;
}
div.sidebar::after,
aside.sidebar::after,
nav.contents::after,
aside.topic::after,
div.topic::after,
div.admonition::after,
blockquote::after {
display: block;
content: '';
clear: both;
}
/* -- tables ---------------------------------------------------------------- */
table.docutils {
margin-top: 10px;
margin-bottom: 10px;
border: 0;
border-collapse: collapse;
}
table.align-center {
margin-left: auto;
margin-right: auto;
}
table.align-default {
margin-left: auto;
margin-right: auto;
}
table caption span.caption-number {
font-style: italic;
}
table caption span.caption-text {
}
table.docutils td, table.docutils th {
padding: 1px 8px 1px 5px;
border-top: 0;
border-left: 0;
border-right: 0;
border-bottom: 1px solid #aaa;
}
th {
text-align: left;
padding-right: 5px;
}
table.citation {
border-left: solid 1px gray;
margin-left: 1px;
}
table.citation td {
border-bottom: none;
}
th > :first-child,
td > :first-child {
margin-top: 0px;
}
th > :last-child,
td > :last-child {
margin-bottom: 0px;
}
/* -- figures --------------------------------------------------------------- */
div.figure, figure {
margin: 0.5em;
padding: 0.5em;
}
div.figure p.caption, figcaption {
padding: 0.3em;
}
div.figure p.caption span.caption-number,
figcaption span.caption-number {
font-style: italic;
}
div.figure p.caption span.caption-text,
figcaption span.caption-text {
}
/* -- field list styles ----------------------------------------------------- */
table.field-list td, table.field-list th {
border: 0 !important;
}
.field-list ul {
margin: 0;
padding-left: 1em;
}
.field-list p {
margin: 0;
}
.field-name {
-moz-hyphens: manual;
-ms-hyphens: manual;
-webkit-hyphens: manual;
hyphens: manual;
}
/* -- hlist styles ---------------------------------------------------------- */
table.hlist {
margin: 1em 0;
}
table.hlist td {
vertical-align: top;
}
/* -- object description styles --------------------------------------------- */
.sig {
font-family: 'Consolas', 'Menlo', 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', monospace;
}
.sig-name, code.descname {
background-color: transparent;
font-weight: bold;
}
.sig-name {
font-size: 1.1em;
}
code.descname {
font-size: 1.2em;
}
.sig-prename, code.descclassname {
background-color: transparent;
}
.optional {
font-size: 1.3em;
}
.sig-paren {
font-size: larger;
}
.sig-param.n {
font-style: italic;
}
/* C++ specific styling */
.sig-inline.c-texpr,
.sig-inline.cpp-texpr {
font-family: unset;
}
.sig.c .k, .sig.c .kt,
.sig.cpp .k, .sig.cpp .kt {
color: #0033B3;
}
.sig.c .m,
.sig.cpp .m {
color: #1750EB;
}
.sig.c .s, .sig.c .sc,
.sig.cpp .s, .sig.cpp .sc {
color: #067D17;
}
/* -- other body styles ----------------------------------------------------- */
ol.arabic {
list-style: decimal;
}
ol.loweralpha {
list-style: lower-alpha;
}
ol.upperalpha {
list-style: upper-alpha;
}
ol.lowerroman {
list-style: lower-roman;
}
ol.upperroman {
list-style: upper-roman;
}
:not(li) > ol > li:first-child > :first-child,
:not(li) > ul > li:first-child > :first-child {
margin-top: 0px;
}
:not(li) > ol > li:last-child > :last-child,
:not(li) > ul > li:last-child > :last-child {
margin-bottom: 0px;
}
ol.simple ol p,
ol.simple ul p,
ul.simple ol p,
ul.simple ul p {
margin-top: 0;
}
ol.simple > li:not(:first-child) > p,
ul.simple > li:not(:first-child) > p {
margin-top: 0;
}
ol.simple p,
ul.simple p {
margin-bottom: 0;
}
aside.footnote > span,
div.citation > span {
float: left;
}
aside.footnote > span:last-of-type,
div.citation > span:last-of-type {
padding-right: 0.5em;
}
aside.footnote > p {
margin-left: 2em;
}
div.citation > p {
margin-left: 4em;
}
aside.footnote > p:last-of-type,
div.citation > p:last-of-type {
margin-bottom: 0em;
}
aside.footnote > p:last-of-type:after,
div.citation > p:last-of-type:after {
content: "";
clear: both;
}
dl.field-list {
display: grid;
grid-template-columns: fit-content(30%) auto;
}
dl.field-list > dt {
font-weight: bold;
word-break: break-word;
padding-left: 0.5em;
padding-right: 5px;
}
dl.field-list > dd {
padding-left: 0.5em;
margin-top: 0em;
margin-left: 0em;
margin-bottom: 0em;
}
dl {
margin-bottom: 15px;
}
dd > :first-child {
margin-top: 0px;
}
dd ul, dd table {
margin-bottom: 10px;
}
dd {
margin-top: 3px;
margin-bottom: 10px;
margin-left: 30px;
}
.sig dd {
margin-top: 0px;
margin-bottom: 0px;
}
.sig dl {
margin-top: 0px;
margin-bottom: 0px;
}
dl > dd:last-child,
dl > dd:last-child > :last-child {
margin-bottom: 0;
}
dt:target, span.highlighted {
background-color: #fbe54e;
}
rect.highlighted {
fill: #fbe54e;
}
dl.glossary dt {
font-weight: bold;
font-size: 1.1em;
}
.versionmodified {
font-style: italic;
}
.system-message {
background-color: #fda;
padding: 5px;
border: 3px solid red;
}
.footnote:target {
background-color: #ffa;
}
.line-block {
display: block;
margin-top: 1em;
margin-bottom: 1em;
}
.line-block .line-block {
margin-top: 0;
margin-bottom: 0;
margin-left: 1.5em;
}
.guilabel, .menuselection {
font-family: sans-serif;
}
.accelerator {
text-decoration: underline;
}
.classifier {
font-style: oblique;
}
.classifier:before {
font-style: normal;
margin: 0 0.5em;
content: ":";
display: inline-block;
}
abbr, acronym {
border-bottom: dotted 1px;
cursor: help;
}
.translated {
background-color: rgba(207, 255, 207, 0.2)
}
.untranslated {
background-color: rgba(255, 207, 207, 0.2)
}
/* -- code displays --------------------------------------------------------- */
pre {
overflow: auto;
overflow-y: hidden; /* fixes display issues on Chrome browsers */
}
pre, div[class*="highlight-"] {
clear: both;
}
span.pre {
-moz-hyphens: none;
-ms-hyphens: none;
-webkit-hyphens: none;
hyphens: none;
white-space: nowrap;
}
div[class*="highlight-"] {
margin: 1em 0;
}
td.linenos pre {
border: 0;
background-color: transparent;
color: #aaa;
}
table.highlighttable {
display: block;
}
table.highlighttable tbody {
display: block;
}
table.highlighttable tr {
display: flex;
}
table.highlighttable td {
margin: 0;
padding: 0;
}
table.highlighttable td.linenos {
padding-right: 0.5em;
}
table.highlighttable td.code {
flex: 1;
overflow: hidden;
}
.highlight .hll {
display: block;
}
div.highlight pre,
table.highlighttable pre {
margin: 0;
}
div.code-block-caption + div {
margin-top: 0;
}
div.code-block-caption {
margin-top: 1em;
padding: 2px 5px;
font-size: small;
}
div.code-block-caption code {
background-color: transparent;
}
table.highlighttable td.linenos,
span.linenos,
div.highlight span.gp { /* gp: Generic.Prompt */
user-select: none;
-webkit-user-select: text; /* Safari fallback only */
-webkit-user-select: none; /* Chrome/Safari */
-moz-user-select: none; /* Firefox */
-ms-user-select: none; /* IE10+ */
}
div.code-block-caption span.caption-number {
padding: 0.1em 0.3em;
font-style: italic;
}
div.code-block-caption span.caption-text {
}
div.literal-block-wrapper {
margin: 1em 0;
}
code.xref, a code {
background-color: transparent;
font-weight: bold;
}
h1 code, h2 code, h3 code, h4 code, h5 code, h6 code {
background-color: transparent;
}
.viewcode-link {
float: right;
}
.viewcode-back {
float: right;
font-family: sans-serif;
}
div.viewcode-block:target {
margin: -1px -10px;
padding: 0 10px;
}
/* -- math display ---------------------------------------------------------- */
img.math {
vertical-align: middle;
}
div.body div.math p {
text-align: center;
}
span.eqno {
float: right;
}
span.eqno a.headerlink {
position: absolute;
z-index: 1;
}
div.math:hover a.headerlink {
visibility: visible;
}
/* -- printout stylesheet --------------------------------------------------- */
@media print {
div.document,
div.documentwrapper,
div.bodywrapper {
margin: 0 !important;
width: 100%;
}
div.sphinxsidebar,
div.related,
div.footer,
#top-link {
display: none;
}
}

View File

@@ -0,0 +1 @@
.clearfix{*zoom:1}.clearfix:after,.clearfix:before{display:table;content:""}.clearfix:after{clear:both}@font-face{font-family:FontAwesome;font-style:normal;font-weight:400;src:url(fonts/fontawesome-webfont.eot?674f50d287a8c48dc19ba404d20fe713?#iefix) format("embedded-opentype"),url(fonts/fontawesome-webfont.woff2?af7ae505a9eed503f8b8e6982036873e) format("woff2"),url(fonts/fontawesome-webfont.woff?fee66e712a8a08eef5805a46892932ad) format("woff"),url(fonts/fontawesome-webfont.ttf?b06871f281fee6b241d60582ae9369b9) format("truetype"),url(fonts/fontawesome-webfont.svg?912ec66d7572ff821749319396470bde#FontAwesome) format("svg")}.fa:before{font-family:FontAwesome;font-style:normal;font-weight:400;line-height:1}.fa:before,a .fa{text-decoration:inherit}.fa:before,a .fa,li .fa{display:inline-block}li .fa-large:before{width:1.875em}ul.fas{list-style-type:none;margin-left:2em;text-indent:-.8em}ul.fas li .fa{width:.8em}ul.fas li .fa-large:before{vertical-align:baseline}.fa-book:before,.icon-book:before{content:"\f02d"}.fa-caret-down:before,.icon-caret-down:before{content:"\f0d7"}.fa-caret-up:before,.icon-caret-up:before{content:"\f0d8"}.fa-caret-left:before,.icon-caret-left:before{content:"\f0d9"}.fa-caret-right:before,.icon-caret-right:before{content:"\f0da"}.rst-versions{position:fixed;bottom:0;left:0;width:300px;color:#fcfcfc;background:#1f1d1d;font-family:Lato,proxima-nova,Helvetica Neue,Arial,sans-serif;z-index:400}.rst-versions a{color:#2980b9;text-decoration:none}.rst-versions .rst-badge-small{display:none}.rst-versions .rst-current-version{padding:12px;background-color:#272525;display:block;text-align:right;font-size:90%;cursor:pointer;color:#27ae60}.rst-versions .rst-current-version:after{clear:both;content:"";display:block}.rst-versions .rst-current-version .fa{color:#fcfcfc}.rst-versions .rst-current-version .fa-book,.rst-versions .rst-current-version .icon-book{float:left}.rst-versions .rst-current-version.rst-out-of-date{background-color:#e74c3c;color:#fff}.rst-versions .rst-current-version.rst-active-old-version{background-color:#f1c40f;color:#000}.rst-versions.shift-up{height:auto;max-height:100%;overflow-y:scroll}.rst-versions.shift-up .rst-other-versions{display:block}.rst-versions .rst-other-versions{font-size:90%;padding:12px;color:grey;display:none}.rst-versions .rst-other-versions hr{display:block;height:1px;border:0;margin:20px 0;padding:0;border-top:1px solid #413d3d}.rst-versions .rst-other-versions dd{display:inline-block;margin:0}.rst-versions .rst-other-versions dd a{display:inline-block;padding:6px;color:#fcfcfc}.rst-versions .rst-other-versions .rtd-current-item{font-weight:700}.rst-versions.rst-badge{width:auto;bottom:20px;right:20px;left:auto;border:none;max-width:300px;max-height:90%}.rst-versions.rst-badge .fa-book,.rst-versions.rst-badge .icon-book{float:none;line-height:30px}.rst-versions.rst-badge.shift-up .rst-current-version{text-align:right}.rst-versions.rst-badge.shift-up .rst-current-version .fa-book,.rst-versions.rst-badge.shift-up .rst-current-version .icon-book{float:left}.rst-versions.rst-badge>.rst-current-version{width:auto;height:30px;line-height:30px;padding:0 6px;display:block;text-align:center}@media screen and (max-width:768px){.rst-versions{width:85%;display:none}.rst-versions.shift{display:block}}#flyout-search-form{padding:6px}

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

File diff suppressed because it is too large Load Diff

After

Width:  |  Height:  |  Size: 434 KiB

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

4
_static/css/theme.css Normal file

File diff suppressed because one or more lines are too long

149
_static/doctools.js Normal file
View File

@@ -0,0 +1,149 @@
/*
* Base JavaScript utilities for all Sphinx HTML documentation.
*/
"use strict";
const BLACKLISTED_KEY_CONTROL_ELEMENTS = new Set([
"TEXTAREA",
"INPUT",
"SELECT",
"BUTTON",
]);
const _ready = (callback) => {
if (document.readyState !== "loading") {
callback();
} else {
document.addEventListener("DOMContentLoaded", callback);
}
};
/**
* Small JavaScript module for the documentation.
*/
const Documentation = {
init: () => {
Documentation.initDomainIndexTable();
Documentation.initOnKeyListeners();
},
/**
* i18n support
*/
TRANSLATIONS: {},
PLURAL_EXPR: (n) => (n === 1 ? 0 : 1),
LOCALE: "unknown",
// gettext and ngettext don't access this so that the functions
// can safely bound to a different name (_ = Documentation.gettext)
gettext: (string) => {
const translated = Documentation.TRANSLATIONS[string];
switch (typeof translated) {
case "undefined":
return string; // no translation
case "string":
return translated; // translation exists
default:
return translated[0]; // (singular, plural) translation tuple exists
}
},
ngettext: (singular, plural, n) => {
const translated = Documentation.TRANSLATIONS[singular];
if (typeof translated !== "undefined")
return translated[Documentation.PLURAL_EXPR(n)];
return n === 1 ? singular : plural;
},
addTranslations: (catalog) => {
Object.assign(Documentation.TRANSLATIONS, catalog.messages);
Documentation.PLURAL_EXPR = new Function(
"n",
`return (${catalog.plural_expr})`
);
Documentation.LOCALE = catalog.locale;
},
/**
* helper function to focus on search bar
*/
focusSearchBar: () => {
document.querySelectorAll("input[name=q]")[0]?.focus();
},
/**
* Initialise the domain index toggle buttons
*/
initDomainIndexTable: () => {
const toggler = (el) => {
const idNumber = el.id.substr(7);
const toggledRows = document.querySelectorAll(`tr.cg-${idNumber}`);
if (el.src.substr(-9) === "minus.png") {
el.src = `${el.src.substr(0, el.src.length - 9)}plus.png`;
toggledRows.forEach((el) => (el.style.display = "none"));
} else {
el.src = `${el.src.substr(0, el.src.length - 8)}minus.png`;
toggledRows.forEach((el) => (el.style.display = ""));
}
};
const togglerElements = document.querySelectorAll("img.toggler");
togglerElements.forEach((el) =>
el.addEventListener("click", (event) => toggler(event.currentTarget))
);
togglerElements.forEach((el) => (el.style.display = ""));
if (DOCUMENTATION_OPTIONS.COLLAPSE_INDEX) togglerElements.forEach(toggler);
},
initOnKeyListeners: () => {
// only install a listener if it is really needed
if (
!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS &&
!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS
)
return;
document.addEventListener("keydown", (event) => {
// bail for input elements
if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
// bail with special keys
if (event.altKey || event.ctrlKey || event.metaKey) return;
if (!event.shiftKey) {
switch (event.key) {
case "ArrowLeft":
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
const prevLink = document.querySelector('link[rel="prev"]');
if (prevLink && prevLink.href) {
window.location.href = prevLink.href;
event.preventDefault();
}
break;
case "ArrowRight":
if (!DOCUMENTATION_OPTIONS.NAVIGATION_WITH_KEYS) break;
const nextLink = document.querySelector('link[rel="next"]');
if (nextLink && nextLink.href) {
window.location.href = nextLink.href;
event.preventDefault();
}
break;
}
}
// some keyboard layouts may need Shift to get /
switch (event.key) {
case "/":
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) break;
Documentation.focusSearchBar();
event.preventDefault();
}
});
},
};
// quick alias for translations
const _ = Documentation.gettext;
_ready(Documentation.init);

View File

@@ -0,0 +1,13 @@
const DOCUMENTATION_OPTIONS = {
VERSION: '',
LANGUAGE: 'en',
COLLAPSE_INDEX: false,
BUILDER: 'html',
FILE_SUFFIX: '.html',
LINK_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt',
NAVIGATION_WITH_KEYS: false,
SHOW_SEARCH_SUMMARY: true,
ENABLE_SEARCH_SHORTCUTS: true,
};

BIN
_static/file.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 286 B

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

Binary file not shown.

2
_static/jquery.js vendored Normal file

File diff suppressed because one or more lines are too long

1
_static/js/badge_only.js Normal file
View File

@@ -0,0 +1 @@
!function(e){var t={};function r(n){if(t[n])return t[n].exports;var o=t[n]={i:n,l:!1,exports:{}};return e[n].call(o.exports,o,o.exports,r),o.l=!0,o.exports}r.m=e,r.c=t,r.d=function(e,t,n){r.o(e,t)||Object.defineProperty(e,t,{enumerable:!0,get:n})},r.r=function(e){"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},r.t=function(e,t){if(1&t&&(e=r(e)),8&t)return e;if(4&t&&"object"==typeof e&&e&&e.__esModule)return e;var n=Object.create(null);if(r.r(n),Object.defineProperty(n,"default",{enumerable:!0,value:e}),2&t&&"string"!=typeof e)for(var o in e)r.d(n,o,function(t){return e[t]}.bind(null,o));return n},r.n=function(e){var t=e&&e.__esModule?function(){return e.default}:function(){return e};return r.d(t,"a",t),t},r.o=function(e,t){return Object.prototype.hasOwnProperty.call(e,t)},r.p="",r(r.s=4)}({4:function(e,t,r){}});

1
_static/js/theme.js Normal file

File diff suppressed because one or more lines are too long

228
_static/js/versions.js Normal file
View File

@@ -0,0 +1,228 @@
const themeFlyoutDisplay = "hidden";
const themeVersionSelector = true;
const themeLanguageSelector = true;
if (themeFlyoutDisplay === "attached") {
function renderLanguages(config) {
if (!config.projects.translations.length) {
return "";
}
// Insert the current language to the options on the selector
let languages = config.projects.translations.concat(config.projects.current);
languages = languages.sort((a, b) => a.language.name.localeCompare(b.language.name));
const languagesHTML = `
<dl>
<dt>Languages</dt>
${languages
.map(
(translation) => `
<dd ${translation.slug == config.projects.current.slug ? 'class="rtd-current-item"' : ""}>
<a href="${translation.urls.documentation}">${translation.language.code}</a>
</dd>
`,
)
.join("\n")}
</dl>
`;
return languagesHTML;
}
function renderVersions(config) {
if (!config.versions.active.length) {
return "";
}
const versionsHTML = `
<dl>
<dt>Versions</dt>
${config.versions.active
.map(
(version) => `
<dd ${version.slug === config.versions.current.slug ? 'class="rtd-current-item"' : ""}>
<a href="${version.urls.documentation}">${version.slug}</a>
</dd>
`,
)
.join("\n")}
</dl>
`;
return versionsHTML;
}
function renderDownloads(config) {
if (!Object.keys(config.versions.current.downloads).length) {
return "";
}
const downloadsNameDisplay = {
pdf: "PDF",
epub: "Epub",
htmlzip: "HTML",
};
const downloadsHTML = `
<dl>
<dt>Downloads</dt>
${Object.entries(config.versions.current.downloads)
.map(
([name, url]) => `
<dd>
<a href="${url}">${downloadsNameDisplay[name]}</a>
</dd>
`,
)
.join("\n")}
</dl>
`;
return downloadsHTML;
}
document.addEventListener("readthedocs-addons-data-ready", function (event) {
const config = event.detail.data();
const flyout = `
<div class="rst-versions" data-toggle="rst-versions" role="note">
<span class="rst-current-version" data-toggle="rst-current-version">
<span class="fa fa-book"> Read the Docs</span>
v: ${config.versions.current.slug}
<span class="fa fa-caret-down"></span>
</span>
<div class="rst-other-versions">
<div class="injected">
${renderLanguages(config)}
${renderVersions(config)}
${renderDownloads(config)}
<dl>
<dt>On Read the Docs</dt>
<dd>
<a href="${config.projects.current.urls.home}">Project Home</a>
</dd>
<dd>
<a href="${config.projects.current.urls.builds}">Builds</a>
</dd>
<dd>
<a href="${config.projects.current.urls.downloads}">Downloads</a>
</dd>
</dl>
<dl>
<dt>Search</dt>
<dd>
<form id="flyout-search-form">
<input
class="wy-form"
type="text"
name="q"
aria-label="Search docs"
placeholder="Search docs"
/>
</form>
</dd>
</dl>
<hr />
<small>
<span>Hosted by <a href="https://about.readthedocs.org/?utm_source=&utm_content=flyout">Read the Docs</a></span>
</small>
</div>
</div>
`;
// Inject the generated flyout into the body HTML element.
document.body.insertAdjacentHTML("beforeend", flyout);
// Trigger the Read the Docs Addons Search modal when clicking on the "Search docs" input from inside the flyout.
document
.querySelector("#flyout-search-form")
.addEventListener("focusin", () => {
const event = new CustomEvent("readthedocs-search-show");
document.dispatchEvent(event);
});
})
}
if (themeLanguageSelector || themeVersionSelector) {
function onSelectorSwitch(event) {
const option = event.target.selectedIndex;
const item = event.target.options[option];
window.location.href = item.dataset.url;
}
document.addEventListener("readthedocs-addons-data-ready", function (event) {
const config = event.detail.data();
const versionSwitch = document.querySelector(
"div.switch-menus > div.version-switch",
);
if (themeVersionSelector) {
let versions = config.versions.active;
if (config.versions.current.hidden || config.versions.current.type === "external") {
versions.unshift(config.versions.current);
}
const versionSelect = `
<select>
${versions
.map(
(version) => `
<option
value="${version.slug}"
${config.versions.current.slug === version.slug ? 'selected="selected"' : ""}
data-url="${version.urls.documentation}">
${version.slug}
</option>`,
)
.join("\n")}
</select>
`;
versionSwitch.innerHTML = versionSelect;
versionSwitch.firstElementChild.addEventListener("change", onSelectorSwitch);
}
const languageSwitch = document.querySelector(
"div.switch-menus > div.language-switch",
);
if (themeLanguageSelector) {
if (config.projects.translations.length) {
// Add the current language to the options on the selector
let languages = config.projects.translations.concat(
config.projects.current,
);
languages = languages.sort((a, b) =>
a.language.name.localeCompare(b.language.name),
);
const languageSelect = `
<select>
${languages
.map(
(language) => `
<option
value="${language.language.code}"
${config.projects.current.slug === language.slug ? 'selected="selected"' : ""}
data-url="${language.urls.documentation}">
${language.language.name}
</option>`,
)
.join("\n")}
</select>
`;
languageSwitch.innerHTML = languageSelect;
languageSwitch.firstElementChild.addEventListener("change", onSelectorSwitch);
}
else {
languageSwitch.remove();
}
}
});
}
document.addEventListener("readthedocs-addons-data-ready", function (event) {
// Trigger the Read the Docs Addons Search modal when clicking on "Search docs" input from the topnav.
document
.querySelector("[role='search'] input")
.addEventListener("focusin", () => {
const event = new CustomEvent("readthedocs-search-show");
document.dispatchEvent(event);
});
});

192
_static/language_data.js Normal file
View File

@@ -0,0 +1,192 @@
/*
* This script contains the language-specific data used by searchtools.js,
* namely the list of stopwords, stemmer, scorer and splitter.
*/
var stopwords = ["a", "and", "are", "as", "at", "be", "but", "by", "for", "if", "in", "into", "is", "it", "near", "no", "not", "of", "on", "or", "such", "that", "the", "their", "then", "there", "these", "they", "this", "to", "was", "will", "with"];
/* Non-minified version is copied as a separate JS file, if available */
/**
* Porter Stemmer
*/
var Stemmer = function() {
var step2list = {
ational: 'ate',
tional: 'tion',
enci: 'ence',
anci: 'ance',
izer: 'ize',
bli: 'ble',
alli: 'al',
entli: 'ent',
eli: 'e',
ousli: 'ous',
ization: 'ize',
ation: 'ate',
ator: 'ate',
alism: 'al',
iveness: 'ive',
fulness: 'ful',
ousness: 'ous',
aliti: 'al',
iviti: 'ive',
biliti: 'ble',
logi: 'log'
};
var step3list = {
icate: 'ic',
ative: '',
alize: 'al',
iciti: 'ic',
ical: 'ic',
ful: '',
ness: ''
};
var c = "[^aeiou]"; // consonant
var v = "[aeiouy]"; // vowel
var C = c + "[^aeiouy]*"; // consonant sequence
var V = v + "[aeiou]*"; // vowel sequence
var mgr0 = "^(" + C + ")?" + V + C; // [C]VC... is m>0
var meq1 = "^(" + C + ")?" + V + C + "(" + V + ")?$"; // [C]VC[V] is m=1
var mgr1 = "^(" + C + ")?" + V + C + V + C; // [C]VCVC... is m>1
var s_v = "^(" + C + ")?" + v; // vowel in stem
this.stemWord = function (w) {
var stem;
var suffix;
var firstch;
var origword = w;
if (w.length < 3)
return w;
var re;
var re2;
var re3;
var re4;
firstch = w.substr(0,1);
if (firstch == "y")
w = firstch.toUpperCase() + w.substr(1);
// Step 1a
re = /^(.+?)(ss|i)es$/;
re2 = /^(.+?)([^s])s$/;
if (re.test(w))
w = w.replace(re,"$1$2");
else if (re2.test(w))
w = w.replace(re2,"$1$2");
// Step 1b
re = /^(.+?)eed$/;
re2 = /^(.+?)(ed|ing)$/;
if (re.test(w)) {
var fp = re.exec(w);
re = new RegExp(mgr0);
if (re.test(fp[1])) {
re = /.$/;
w = w.replace(re,"");
}
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1];
re2 = new RegExp(s_v);
if (re2.test(stem)) {
w = stem;
re2 = /(at|bl|iz)$/;
re3 = new RegExp("([^aeiouylsz])\\1$");
re4 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re2.test(w))
w = w + "e";
else if (re3.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
else if (re4.test(w))
w = w + "e";
}
}
// Step 1c
re = /^(.+?)y$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(s_v);
if (re.test(stem))
w = stem + "i";
}
// Step 2
re = /^(.+?)(ational|tional|enci|anci|izer|bli|alli|entli|eli|ousli|ization|ation|ator|alism|iveness|fulness|ousness|aliti|iviti|biliti|logi)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step2list[suffix];
}
// Step 3
re = /^(.+?)(icate|ative|alize|iciti|ical|ful|ness)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
suffix = fp[2];
re = new RegExp(mgr0);
if (re.test(stem))
w = stem + step3list[suffix];
}
// Step 4
re = /^(.+?)(al|ance|ence|er|ic|able|ible|ant|ement|ment|ent|ou|ism|ate|iti|ous|ive|ize)$/;
re2 = /^(.+?)(s|t)(ion)$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
if (re.test(stem))
w = stem;
}
else if (re2.test(w)) {
var fp = re2.exec(w);
stem = fp[1] + fp[2];
re2 = new RegExp(mgr1);
if (re2.test(stem))
w = stem;
}
// Step 5
re = /^(.+?)e$/;
if (re.test(w)) {
var fp = re.exec(w);
stem = fp[1];
re = new RegExp(mgr1);
re2 = new RegExp(meq1);
re3 = new RegExp("^" + C + v + "[^aeiouwxy]$");
if (re.test(stem) || (re2.test(stem) && !(re3.test(stem))))
w = stem;
}
re = /ll$/;
re2 = new RegExp(mgr1);
if (re.test(w) && re2.test(w)) {
re = /.$/;
w = w.replace(re,"");
}
// and turn initial Y back to y
if (firstch == "y")
w = firstch.toLowerCase() + w.substr(1);
return w;
}
}

BIN
_static/minus.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 90 B

BIN
_static/plus.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 90 B

75
_static/pygments.css Normal file
View File

@@ -0,0 +1,75 @@
pre { line-height: 125%; }
td.linenos .normal { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
span.linenos { color: inherit; background-color: transparent; padding-left: 5px; padding-right: 5px; }
td.linenos .special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: 5px; padding-right: 5px; }
.highlight .hll { background-color: #ffffcc }
.highlight { background: #f8f8f8; }
.highlight .c { color: #3D7B7B; font-style: italic } /* Comment */
.highlight .err { border: 1px solid #F00 } /* Error */
.highlight .k { color: #008000; font-weight: bold } /* Keyword */
.highlight .o { color: #666 } /* Operator */
.highlight .ch { color: #3D7B7B; font-style: italic } /* Comment.Hashbang */
.highlight .cm { color: #3D7B7B; font-style: italic } /* Comment.Multiline */
.highlight .cp { color: #9C6500 } /* Comment.Preproc */
.highlight .cpf { color: #3D7B7B; font-style: italic } /* Comment.PreprocFile */
.highlight .c1 { color: #3D7B7B; font-style: italic } /* Comment.Single */
.highlight .cs { color: #3D7B7B; font-style: italic } /* Comment.Special */
.highlight .gd { color: #A00000 } /* Generic.Deleted */
.highlight .ge { font-style: italic } /* Generic.Emph */
.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */
.highlight .gr { color: #E40000 } /* Generic.Error */
.highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */
.highlight .gi { color: #008400 } /* Generic.Inserted */
.highlight .go { color: #717171 } /* Generic.Output */
.highlight .gp { color: #000080; font-weight: bold } /* Generic.Prompt */
.highlight .gs { font-weight: bold } /* Generic.Strong */
.highlight .gu { color: #800080; font-weight: bold } /* Generic.Subheading */
.highlight .gt { color: #04D } /* Generic.Traceback */
.highlight .kc { color: #008000; font-weight: bold } /* Keyword.Constant */
.highlight .kd { color: #008000; font-weight: bold } /* Keyword.Declaration */
.highlight .kn { color: #008000; font-weight: bold } /* Keyword.Namespace */
.highlight .kp { color: #008000 } /* Keyword.Pseudo */
.highlight .kr { color: #008000; font-weight: bold } /* Keyword.Reserved */
.highlight .kt { color: #B00040 } /* Keyword.Type */
.highlight .m { color: #666 } /* Literal.Number */
.highlight .s { color: #BA2121 } /* Literal.String */
.highlight .na { color: #687822 } /* Name.Attribute */
.highlight .nb { color: #008000 } /* Name.Builtin */
.highlight .nc { color: #00F; font-weight: bold } /* Name.Class */
.highlight .no { color: #800 } /* Name.Constant */
.highlight .nd { color: #A2F } /* Name.Decorator */
.highlight .ni { color: #717171; font-weight: bold } /* Name.Entity */
.highlight .ne { color: #CB3F38; font-weight: bold } /* Name.Exception */
.highlight .nf { color: #00F } /* Name.Function */
.highlight .nl { color: #767600 } /* Name.Label */
.highlight .nn { color: #00F; font-weight: bold } /* Name.Namespace */
.highlight .nt { color: #008000; font-weight: bold } /* Name.Tag */
.highlight .nv { color: #19177C } /* Name.Variable */
.highlight .ow { color: #A2F; font-weight: bold } /* Operator.Word */
.highlight .w { color: #BBB } /* Text.Whitespace */
.highlight .mb { color: #666 } /* Literal.Number.Bin */
.highlight .mf { color: #666 } /* Literal.Number.Float */
.highlight .mh { color: #666 } /* Literal.Number.Hex */
.highlight .mi { color: #666 } /* Literal.Number.Integer */
.highlight .mo { color: #666 } /* Literal.Number.Oct */
.highlight .sa { color: #BA2121 } /* Literal.String.Affix */
.highlight .sb { color: #BA2121 } /* Literal.String.Backtick */
.highlight .sc { color: #BA2121 } /* Literal.String.Char */
.highlight .dl { color: #BA2121 } /* Literal.String.Delimiter */
.highlight .sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */
.highlight .s2 { color: #BA2121 } /* Literal.String.Double */
.highlight .se { color: #AA5D1F; font-weight: bold } /* Literal.String.Escape */
.highlight .sh { color: #BA2121 } /* Literal.String.Heredoc */
.highlight .si { color: #A45A77; font-weight: bold } /* Literal.String.Interpol */
.highlight .sx { color: #008000 } /* Literal.String.Other */
.highlight .sr { color: #A45A77 } /* Literal.String.Regex */
.highlight .s1 { color: #BA2121 } /* Literal.String.Single */
.highlight .ss { color: #19177C } /* Literal.String.Symbol */
.highlight .bp { color: #008000 } /* Name.Builtin.Pseudo */
.highlight .fm { color: #00F } /* Name.Function.Magic */
.highlight .vc { color: #19177C } /* Name.Variable.Class */
.highlight .vg { color: #19177C } /* Name.Variable.Global */
.highlight .vi { color: #19177C } /* Name.Variable.Instance */
.highlight .vm { color: #19177C } /* Name.Variable.Magic */
.highlight .il { color: #666 } /* Literal.Number.Integer.Long */

632
_static/searchtools.js Normal file
View File

@@ -0,0 +1,632 @@
/*
* Sphinx JavaScript utilities for the full-text search.
*/
"use strict";
/**
* Simple result scoring code.
*/
if (typeof Scorer === "undefined") {
var Scorer = {
// Implement the following function to further tweak the score for each result
// The function takes a result array [docname, title, anchor, descr, score, filename]
// and returns the new score.
/*
score: result => {
const [docname, title, anchor, descr, score, filename, kind] = result
return score
},
*/
// query matches the full name of an object
objNameMatch: 11,
// or matches in the last dotted part of the object name
objPartialMatch: 6,
// Additive scores depending on the priority of the object
objPrio: {
0: 15, // used to be importantResults
1: 5, // used to be objectResults
2: -5, // used to be unimportantResults
},
// Used when the priority is not in the mapping.
objPrioDefault: 0,
// query found in title
title: 15,
partialTitle: 7,
// query found in terms
term: 5,
partialTerm: 2,
};
}
// Global search result kind enum, used by themes to style search results.
class SearchResultKind {
static get index() { return "index"; }
static get object() { return "object"; }
static get text() { return "text"; }
static get title() { return "title"; }
}
const _removeChildren = (element) => {
while (element && element.lastChild) element.removeChild(element.lastChild);
};
/**
* See https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions#escaping
*/
const _escapeRegExp = (string) =>
string.replace(/[.*+\-?^${}()|[\]\\]/g, "\\$&"); // $& means the whole matched string
const _displayItem = (item, searchTerms, highlightTerms) => {
const docBuilder = DOCUMENTATION_OPTIONS.BUILDER;
const docFileSuffix = DOCUMENTATION_OPTIONS.FILE_SUFFIX;
const docLinkSuffix = DOCUMENTATION_OPTIONS.LINK_SUFFIX;
const showSearchSummary = DOCUMENTATION_OPTIONS.SHOW_SEARCH_SUMMARY;
const contentRoot = document.documentElement.dataset.content_root;
const [docName, title, anchor, descr, score, _filename, kind] = item;
let listItem = document.createElement("li");
// Add a class representing the item's type:
// can be used by a theme's CSS selector for styling
// See SearchResultKind for the class names.
listItem.classList.add(`kind-${kind}`);
let requestUrl;
let linkUrl;
if (docBuilder === "dirhtml") {
// dirhtml builder
let dirname = docName + "/";
if (dirname.match(/\/index\/$/))
dirname = dirname.substring(0, dirname.length - 6);
else if (dirname === "index/") dirname = "";
requestUrl = contentRoot + dirname;
linkUrl = requestUrl;
} else {
// normal html builders
requestUrl = contentRoot + docName + docFileSuffix;
linkUrl = docName + docLinkSuffix;
}
let linkEl = listItem.appendChild(document.createElement("a"));
linkEl.href = linkUrl + anchor;
linkEl.dataset.score = score;
linkEl.innerHTML = title;
if (descr) {
listItem.appendChild(document.createElement("span")).innerHTML =
" (" + descr + ")";
// highlight search terms in the description
if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
}
else if (showSearchSummary)
fetch(requestUrl)
.then((responseData) => responseData.text())
.then((data) => {
if (data)
listItem.appendChild(
Search.makeSearchSummary(data, searchTerms, anchor)
);
// highlight search terms in the summary
if (SPHINX_HIGHLIGHT_ENABLED) // set in sphinx_highlight.js
highlightTerms.forEach((term) => _highlightText(listItem, term, "highlighted"));
});
Search.output.appendChild(listItem);
};
const _finishSearch = (resultCount) => {
Search.stopPulse();
Search.title.innerText = _("Search Results");
if (!resultCount)
Search.status.innerText = Documentation.gettext(
"Your search did not match any documents. Please make sure that all words are spelled correctly and that you've selected enough categories."
);
else
Search.status.innerText = Documentation.ngettext(
"Search finished, found one page matching the search query.",
"Search finished, found ${resultCount} pages matching the search query.",
resultCount,
).replace('${resultCount}', resultCount);
};
const _displayNextItem = (
results,
resultCount,
searchTerms,
highlightTerms,
) => {
// results left, load the summary and display it
// this is intended to be dynamic (don't sub resultsCount)
if (results.length) {
_displayItem(results.pop(), searchTerms, highlightTerms);
setTimeout(
() => _displayNextItem(results, resultCount, searchTerms, highlightTerms),
5
);
}
// search finished, update title and status message
else _finishSearch(resultCount);
};
// Helper function used by query() to order search results.
// Each input is an array of [docname, title, anchor, descr, score, filename, kind].
// Order the results by score (in opposite order of appearance, since the
// `_displayNextItem` function uses pop() to retrieve items) and then alphabetically.
const _orderResultsByScoreThenName = (a, b) => {
const leftScore = a[4];
const rightScore = b[4];
if (leftScore === rightScore) {
// same score: sort alphabetically
const leftTitle = a[1].toLowerCase();
const rightTitle = b[1].toLowerCase();
if (leftTitle === rightTitle) return 0;
return leftTitle > rightTitle ? -1 : 1; // inverted is intentional
}
return leftScore > rightScore ? 1 : -1;
};
/**
* Default splitQuery function. Can be overridden in ``sphinx.search`` with a
* custom function per language.
*
* The regular expression works by splitting the string on consecutive characters
* that are not Unicode letters, numbers, underscores, or emoji characters.
* This is the same as ``\W+`` in Python, preserving the surrogate pair area.
*/
if (typeof splitQuery === "undefined") {
var splitQuery = (query) => query
.split(/[^\p{Letter}\p{Number}_\p{Emoji_Presentation}]+/gu)
.filter(term => term) // remove remaining empty strings
}
/**
* Search Module
*/
const Search = {
_index: null,
_queued_query: null,
_pulse_status: -1,
htmlToText: (htmlString, anchor) => {
const htmlElement = new DOMParser().parseFromString(htmlString, 'text/html');
for (const removalQuery of [".headerlink", "script", "style"]) {
htmlElement.querySelectorAll(removalQuery).forEach((el) => { el.remove() });
}
if (anchor) {
const anchorContent = htmlElement.querySelector(`[role="main"] ${anchor}`);
if (anchorContent) return anchorContent.textContent;
console.warn(
`Anchored content block not found. Sphinx search tries to obtain it via DOM query '[role=main] ${anchor}'. Check your theme or template.`
);
}
// if anchor not specified or not found, fall back to main content
const docContent = htmlElement.querySelector('[role="main"]');
if (docContent) return docContent.textContent;
console.warn(
"Content block not found. Sphinx search tries to obtain it via DOM query '[role=main]'. Check your theme or template."
);
return "";
},
init: () => {
const query = new URLSearchParams(window.location.search).get("q");
document
.querySelectorAll('input[name="q"]')
.forEach((el) => (el.value = query));
if (query) Search.performSearch(query);
},
loadIndex: (url) =>
(document.body.appendChild(document.createElement("script")).src = url),
setIndex: (index) => {
Search._index = index;
if (Search._queued_query !== null) {
const query = Search._queued_query;
Search._queued_query = null;
Search.query(query);
}
},
hasIndex: () => Search._index !== null,
deferQuery: (query) => (Search._queued_query = query),
stopPulse: () => (Search._pulse_status = -1),
startPulse: () => {
if (Search._pulse_status >= 0) return;
const pulse = () => {
Search._pulse_status = (Search._pulse_status + 1) % 4;
Search.dots.innerText = ".".repeat(Search._pulse_status);
if (Search._pulse_status >= 0) window.setTimeout(pulse, 500);
};
pulse();
},
/**
* perform a search for something (or wait until index is loaded)
*/
performSearch: (query) => {
// create the required interface elements
const searchText = document.createElement("h2");
searchText.textContent = _("Searching");
const searchSummary = document.createElement("p");
searchSummary.classList.add("search-summary");
searchSummary.innerText = "";
const searchList = document.createElement("ul");
searchList.setAttribute("role", "list");
searchList.classList.add("search");
const out = document.getElementById("search-results");
Search.title = out.appendChild(searchText);
Search.dots = Search.title.appendChild(document.createElement("span"));
Search.status = out.appendChild(searchSummary);
Search.output = out.appendChild(searchList);
const searchProgress = document.getElementById("search-progress");
// Some themes don't use the search progress node
if (searchProgress) {
searchProgress.innerText = _("Preparing search...");
}
Search.startPulse();
// index already loaded, the browser was quick!
if (Search.hasIndex()) Search.query(query);
else Search.deferQuery(query);
},
_parseQuery: (query) => {
// stem the search terms and add them to the correct list
const stemmer = new Stemmer();
const searchTerms = new Set();
const excludedTerms = new Set();
const highlightTerms = new Set();
const objectTerms = new Set(splitQuery(query.toLowerCase().trim()));
splitQuery(query.trim()).forEach((queryTerm) => {
const queryTermLower = queryTerm.toLowerCase();
// maybe skip this "word"
// stopwords array is from language_data.js
if (
stopwords.indexOf(queryTermLower) !== -1 ||
queryTerm.match(/^\d+$/)
)
return;
// stem the word
let word = stemmer.stemWord(queryTermLower);
// select the correct list
if (word[0] === "-") excludedTerms.add(word.substr(1));
else {
searchTerms.add(word);
highlightTerms.add(queryTermLower);
}
});
if (SPHINX_HIGHLIGHT_ENABLED) { // set in sphinx_highlight.js
localStorage.setItem("sphinx_highlight_terms", [...highlightTerms].join(" "))
}
// console.debug("SEARCH: searching for:");
// console.info("required: ", [...searchTerms]);
// console.info("excluded: ", [...excludedTerms]);
return [query, searchTerms, excludedTerms, highlightTerms, objectTerms];
},
/**
* execute search (requires search index to be loaded)
*/
_performSearch: (query, searchTerms, excludedTerms, highlightTerms, objectTerms) => {
const filenames = Search._index.filenames;
const docNames = Search._index.docnames;
const titles = Search._index.titles;
const allTitles = Search._index.alltitles;
const indexEntries = Search._index.indexentries;
// Collect multiple result groups to be sorted separately and then ordered.
// Each is an array of [docname, title, anchor, descr, score, filename, kind].
const normalResults = [];
const nonMainIndexResults = [];
_removeChildren(document.getElementById("search-progress"));
const queryLower = query.toLowerCase().trim();
for (const [title, foundTitles] of Object.entries(allTitles)) {
if (title.toLowerCase().trim().includes(queryLower) && (queryLower.length >= title.length/2)) {
for (const [file, id] of foundTitles) {
const score = Math.round(Scorer.title * queryLower.length / title.length);
const boost = titles[file] === title ? 1 : 0; // add a boost for document titles
normalResults.push([
docNames[file],
titles[file] !== title ? `${titles[file]} > ${title}` : title,
id !== null ? "#" + id : "",
null,
score + boost,
filenames[file],
SearchResultKind.title,
]);
}
}
}
// search for explicit entries in index directives
for (const [entry, foundEntries] of Object.entries(indexEntries)) {
if (entry.includes(queryLower) && (queryLower.length >= entry.length/2)) {
for (const [file, id, isMain] of foundEntries) {
const score = Math.round(100 * queryLower.length / entry.length);
const result = [
docNames[file],
titles[file],
id ? "#" + id : "",
null,
score,
filenames[file],
SearchResultKind.index,
];
if (isMain) {
normalResults.push(result);
} else {
nonMainIndexResults.push(result);
}
}
}
}
// lookup as object
objectTerms.forEach((term) =>
normalResults.push(...Search.performObjectSearch(term, objectTerms))
);
// lookup as search terms in fulltext
normalResults.push(...Search.performTermsSearch(searchTerms, excludedTerms));
// let the scorer override scores with a custom scoring function
if (Scorer.score) {
normalResults.forEach((item) => (item[4] = Scorer.score(item)));
nonMainIndexResults.forEach((item) => (item[4] = Scorer.score(item)));
}
// Sort each group of results by score and then alphabetically by name.
normalResults.sort(_orderResultsByScoreThenName);
nonMainIndexResults.sort(_orderResultsByScoreThenName);
// Combine the result groups in (reverse) order.
// Non-main index entries are typically arbitrary cross-references,
// so display them after other results.
let results = [...nonMainIndexResults, ...normalResults];
// remove duplicate search results
// note the reversing of results, so that in the case of duplicates, the highest-scoring entry is kept
let seen = new Set();
results = results.reverse().reduce((acc, result) => {
let resultStr = result.slice(0, 4).concat([result[5]]).map(v => String(v)).join(',');
if (!seen.has(resultStr)) {
acc.push(result);
seen.add(resultStr);
}
return acc;
}, []);
return results.reverse();
},
query: (query) => {
const [searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms] = Search._parseQuery(query);
const results = Search._performSearch(searchQuery, searchTerms, excludedTerms, highlightTerms, objectTerms);
// for debugging
//Search.lastresults = results.slice(); // a copy
// console.info("search results:", Search.lastresults);
// print the results
_displayNextItem(results, results.length, searchTerms, highlightTerms);
},
/**
* search for object names
*/
performObjectSearch: (object, objectTerms) => {
const filenames = Search._index.filenames;
const docNames = Search._index.docnames;
const objects = Search._index.objects;
const objNames = Search._index.objnames;
const titles = Search._index.titles;
const results = [];
const objectSearchCallback = (prefix, match) => {
const name = match[4]
const fullname = (prefix ? prefix + "." : "") + name;
const fullnameLower = fullname.toLowerCase();
if (fullnameLower.indexOf(object) < 0) return;
let score = 0;
const parts = fullnameLower.split(".");
// check for different match types: exact matches of full name or
// "last name" (i.e. last dotted part)
if (fullnameLower === object || parts.slice(-1)[0] === object)
score += Scorer.objNameMatch;
else if (parts.slice(-1)[0].indexOf(object) > -1)
score += Scorer.objPartialMatch; // matches in last name
const objName = objNames[match[1]][2];
const title = titles[match[0]];
// If more than one term searched for, we require other words to be
// found in the name/title/description
const otherTerms = new Set(objectTerms);
otherTerms.delete(object);
if (otherTerms.size > 0) {
const haystack = `${prefix} ${name} ${objName} ${title}`.toLowerCase();
if (
[...otherTerms].some((otherTerm) => haystack.indexOf(otherTerm) < 0)
)
return;
}
let anchor = match[3];
if (anchor === "") anchor = fullname;
else if (anchor === "-") anchor = objNames[match[1]][1] + "-" + fullname;
const descr = objName + _(", in ") + title;
// add custom score for some objects according to scorer
if (Scorer.objPrio.hasOwnProperty(match[2]))
score += Scorer.objPrio[match[2]];
else score += Scorer.objPrioDefault;
results.push([
docNames[match[0]],
fullname,
"#" + anchor,
descr,
score,
filenames[match[0]],
SearchResultKind.object,
]);
};
Object.keys(objects).forEach((prefix) =>
objects[prefix].forEach((array) =>
objectSearchCallback(prefix, array)
)
);
return results;
},
/**
* search for full-text terms in the index
*/
performTermsSearch: (searchTerms, excludedTerms) => {
// prepare search
const terms = Search._index.terms;
const titleTerms = Search._index.titleterms;
const filenames = Search._index.filenames;
const docNames = Search._index.docnames;
const titles = Search._index.titles;
const scoreMap = new Map();
const fileMap = new Map();
// perform the search on the required terms
searchTerms.forEach((word) => {
const files = [];
const arr = [
{ files: terms[word], score: Scorer.term },
{ files: titleTerms[word], score: Scorer.title },
];
// add support for partial matches
if (word.length > 2) {
const escapedWord = _escapeRegExp(word);
if (!terms.hasOwnProperty(word)) {
Object.keys(terms).forEach((term) => {
if (term.match(escapedWord))
arr.push({ files: terms[term], score: Scorer.partialTerm });
});
}
if (!titleTerms.hasOwnProperty(word)) {
Object.keys(titleTerms).forEach((term) => {
if (term.match(escapedWord))
arr.push({ files: titleTerms[term], score: Scorer.partialTitle });
});
}
}
// no match but word was a required one
if (arr.every((record) => record.files === undefined)) return;
// found search word in contents
arr.forEach((record) => {
if (record.files === undefined) return;
let recordFiles = record.files;
if (recordFiles.length === undefined) recordFiles = [recordFiles];
files.push(...recordFiles);
// set score for the word in each file
recordFiles.forEach((file) => {
if (!scoreMap.has(file)) scoreMap.set(file, {});
scoreMap.get(file)[word] = record.score;
});
});
// create the mapping
files.forEach((file) => {
if (!fileMap.has(file)) fileMap.set(file, [word]);
else if (fileMap.get(file).indexOf(word) === -1) fileMap.get(file).push(word);
});
});
// now check if the files don't contain excluded terms
const results = [];
for (const [file, wordList] of fileMap) {
// check if all requirements are matched
// as search terms with length < 3 are discarded
const filteredTermCount = [...searchTerms].filter(
(term) => term.length > 2
).length;
if (
wordList.length !== searchTerms.size &&
wordList.length !== filteredTermCount
)
continue;
// ensure that none of the excluded terms is in the search result
if (
[...excludedTerms].some(
(term) =>
terms[term] === file ||
titleTerms[term] === file ||
(terms[term] || []).includes(file) ||
(titleTerms[term] || []).includes(file)
)
)
break;
// select one (max) score for the file.
const score = Math.max(...wordList.map((w) => scoreMap.get(file)[w]));
// add result to the result list
results.push([
docNames[file],
titles[file],
"",
null,
score,
filenames[file],
SearchResultKind.text,
]);
}
return results;
},
/**
* helper function to return a node containing the
* search summary for a given text. keywords is a list
* of stemmed words.
*/
makeSearchSummary: (htmlText, keywords, anchor) => {
const text = Search.htmlToText(htmlText, anchor);
if (text === "") return null;
const textLower = text.toLowerCase();
const actualStartPosition = [...keywords]
.map((k) => textLower.indexOf(k.toLowerCase()))
.filter((i) => i > -1)
.slice(-1)[0];
const startWithContext = Math.max(actualStartPosition - 120, 0);
const top = startWithContext === 0 ? "" : "...";
const tail = startWithContext + 240 < text.length ? "..." : "";
let summary = document.createElement("p");
summary.classList.add("context");
summary.textContent = top + text.substr(startWithContext, 240).trim() + tail;
return summary;
},
};
_ready(Search.init);

154
_static/sphinx_highlight.js Normal file
View File

@@ -0,0 +1,154 @@
/* Highlighting utilities for Sphinx HTML documentation. */
"use strict";
const SPHINX_HIGHLIGHT_ENABLED = true
/**
* highlight a given string on a node by wrapping it in
* span elements with the given class name.
*/
const _highlight = (node, addItems, text, className) => {
if (node.nodeType === Node.TEXT_NODE) {
const val = node.nodeValue;
const parent = node.parentNode;
const pos = val.toLowerCase().indexOf(text);
if (
pos >= 0 &&
!parent.classList.contains(className) &&
!parent.classList.contains("nohighlight")
) {
let span;
const closestNode = parent.closest("body, svg, foreignObject");
const isInSVG = closestNode && closestNode.matches("svg");
if (isInSVG) {
span = document.createElementNS("http://www.w3.org/2000/svg", "tspan");
} else {
span = document.createElement("span");
span.classList.add(className);
}
span.appendChild(document.createTextNode(val.substr(pos, text.length)));
const rest = document.createTextNode(val.substr(pos + text.length));
parent.insertBefore(
span,
parent.insertBefore(
rest,
node.nextSibling
)
);
node.nodeValue = val.substr(0, pos);
/* There may be more occurrences of search term in this node. So call this
* function recursively on the remaining fragment.
*/
_highlight(rest, addItems, text, className);
if (isInSVG) {
const rect = document.createElementNS(
"http://www.w3.org/2000/svg",
"rect"
);
const bbox = parent.getBBox();
rect.x.baseVal.value = bbox.x;
rect.y.baseVal.value = bbox.y;
rect.width.baseVal.value = bbox.width;
rect.height.baseVal.value = bbox.height;
rect.setAttribute("class", className);
addItems.push({ parent: parent, target: rect });
}
}
} else if (node.matches && !node.matches("button, select, textarea")) {
node.childNodes.forEach((el) => _highlight(el, addItems, text, className));
}
};
const _highlightText = (thisNode, text, className) => {
let addItems = [];
_highlight(thisNode, addItems, text, className);
addItems.forEach((obj) =>
obj.parent.insertAdjacentElement("beforebegin", obj.target)
);
};
/**
* Small JavaScript module for the documentation.
*/
const SphinxHighlight = {
/**
* highlight the search words provided in localstorage in the text
*/
highlightSearchWords: () => {
if (!SPHINX_HIGHLIGHT_ENABLED) return; // bail if no highlight
// get and clear terms from localstorage
const url = new URL(window.location);
const highlight =
localStorage.getItem("sphinx_highlight_terms")
|| url.searchParams.get("highlight")
|| "";
localStorage.removeItem("sphinx_highlight_terms")
url.searchParams.delete("highlight");
window.history.replaceState({}, "", url);
// get individual terms from highlight string
const terms = highlight.toLowerCase().split(/\s+/).filter(x => x);
if (terms.length === 0) return; // nothing to do
// There should never be more than one element matching "div.body"
const divBody = document.querySelectorAll("div.body");
const body = divBody.length ? divBody[0] : document.querySelector("body");
window.setTimeout(() => {
terms.forEach((term) => _highlightText(body, term, "highlighted"));
}, 10);
const searchBox = document.getElementById("searchbox");
if (searchBox === null) return;
searchBox.appendChild(
document
.createRange()
.createContextualFragment(
'<p class="highlight-link">' +
'<a href="javascript:SphinxHighlight.hideSearchWords()">' +
_("Hide Search Matches") +
"</a></p>"
)
);
},
/**
* helper function to hide the search marks again
*/
hideSearchWords: () => {
document
.querySelectorAll("#searchbox .highlight-link")
.forEach((el) => el.remove());
document
.querySelectorAll("span.highlighted")
.forEach((el) => el.classList.remove("highlighted"));
localStorage.removeItem("sphinx_highlight_terms")
},
initEscapeListener: () => {
// only install a listener if it is really needed
if (!DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS) return;
document.addEventListener("keydown", (event) => {
// bail for input elements
if (BLACKLISTED_KEY_CONTROL_ELEMENTS.has(document.activeElement.tagName)) return;
// bail with special keys
if (event.shiftKey || event.altKey || event.ctrlKey || event.metaKey) return;
if (DOCUMENTATION_OPTIONS.ENABLE_SEARCH_SHORTCUTS && (event.key === "Escape")) {
SphinxHighlight.hideSearchWords();
event.preventDefault();
}
});
},
};
_ready(() => {
/* Do not call highlightSearchWords() when we are on the search page.
* It will highlight words from the *previous* search query.
*/
if (typeof Search === "undefined") SphinxHighlight.highlightSearchWords();
SphinxHighlight.initEscapeListener();
});

654
genindex.html Normal file
View File

@@ -0,0 +1,654 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Index &mdash; SuperFaktura API client documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="#" />
<link rel="search" title="Search" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
SuperFaktura API client
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<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>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">SuperFaktura API client</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Index</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1 id="index">Index</h1>
<div class="genindex-jumpbox">
<a href="#A"><strong>A</strong></a>
| <a href="#B"><strong>B</strong></a>
| <a href="#C"><strong>C</strong></a>
| <a href="#D"><strong>D</strong></a>
| <a href="#E"><strong>E</strong></a>
| <a href="#F"><strong>F</strong></a>
| <a href="#G"><strong>G</strong></a>
| <a href="#H"><strong>H</strong></a>
| <a href="#I"><strong>I</strong></a>
| <a href="#L"><strong>L</strong></a>
| <a href="#M"><strong>M</strong></a>
| <a href="#N"><strong>N</strong></a>
| <a href="#O"><strong>O</strong></a>
| <a href="#P"><strong>P</strong></a>
| <a href="#Q"><strong>Q</strong></a>
| <a href="#R"><strong>R</strong></a>
| <a href="#S"><strong>S</strong></a>
| <a href="#T"><strong>T</strong></a>
| <a href="#U"><strong>U</strong></a>
| <a href="#V"><strong>V</strong></a>
| <a href="#Z"><strong>Z</strong></a>
</div>
<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.bank_account.html#superfaktura.bank_account.BankAccountModel.account">account (superfaktura.bank_account.BankAccountModel attribute)</a>, <a href="superfaktura.html#superfaktura.bank_account.BankAccountModel.account">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.Invoice.add">add() (superfaktura.invoice.Invoice method)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.Invoice.add">[1]</a>
</li>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContact.add_contact">add_contact() (superfaktura.client_contacts.ClientContact method)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContact.add_contact">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.add_rounding_item">add_rounding_item (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.add_rounding_item">[1]</a>
</li>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.address">address (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.address">[1]</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.already_paid">already_paid (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.already_paid">[1]</a>
</li>
<li><a href="superfaktura.bank_account.html#superfaktura.bank_account.BankAccountModel.as_dict">as_dict() (superfaktura.bank_account.BankAccountModel method)</a>, <a href="superfaktura.html#superfaktura.bank_account.BankAccountModel.as_dict">[1]</a>
<ul>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.as_dict">(superfaktura.client_contacts.ClientContactModel method)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.as_dict">[1]</a>
</li>
<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>
</ul></li>
</ul></td>
</tr></table>
<h2 id="B">B</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.bank_account">bank_account (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.bank_account">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.bank_accounts">bank_accounts (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.bank_accounts">[1]</a>
</li>
<li><a href="superfaktura.bank_account.html#superfaktura.bank_account.BankAccountModel.bank_code">bank_code (superfaktura.bank_account.BankAccountModel attribute)</a>, <a href="superfaktura.html#superfaktura.bank_account.BankAccountModel.bank_code">[1]</a>
<ul>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.bank_code">(superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.bank_code">[1]</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.bank_account.html#superfaktura.bank_account.BankAccountModel.bank_name">bank_name (superfaktura.bank_account.BankAccountModel attribute)</a>, <a href="superfaktura.html#superfaktura.bank_account.BankAccountModel.bank_name">[1]</a>
</li>
<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>
</ul></td>
</tr></table>
<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.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>
</li>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel">ClientContactModel (class in superfaktura.client_contacts)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel">[1]</a>
</li>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientException">ClientException</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientException">[1]</a>
</li>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.comment">comment (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.comment">[1]</a>
<ul>
<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.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>
</li>
<li><a href="superfaktura.utils.country.html#superfaktura.utils.country.country_list">country_list() (in module superfaktura.utils.country)</a>, <a href="superfaktura.utils.html#superfaktura.utils.country.country_list">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.created">created (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.created">[1]</a>
</li>
<li><a href="superfaktura.enumerations.currency.html#superfaktura.enumerations.currency.Currencies">Currencies (class in superfaktura.enumerations.currency)</a>, <a href="superfaktura.enumerations.html#superfaktura.enumerations.currency.Currencies">[1]</a>
</li>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.currency">currency (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.currency">[1]</a>
</li>
<li><a href="superfaktura.enumerations.currency.html#superfaktura.enumerations.currency.Currencies.CZK">CZK (superfaktura.enumerations.currency.Currencies attribute)</a>, <a href="superfaktura.enumerations.html#superfaktura.enumerations.currency.Currencies.CZK">[1]</a>
</li>
</ul></td>
</tr></table>
<h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.utils.data_types.html#superfaktura.utils.data_types.Date">Date (class in superfaktura.utils.data_types)</a>, <a href="superfaktura.utils.html#superfaktura.utils.data_types.Date">[1]</a>
</li>
<li><a href="superfaktura.utils.data_types.html#superfaktura.utils.data_types.DateEncoder">DateEncoder (class in superfaktura.utils.data_types)</a>, <a href="superfaktura.utils.html#superfaktura.utils.data_types.DateEncoder">[1]</a>
</li>
<li><a href="superfaktura.bank_account.html#superfaktura.bank_account.BankAccountModel.default">default (superfaktura.bank_account.BankAccountModel attribute)</a>, <a href="superfaktura.html#superfaktura.bank_account.BankAccountModel.default">[1]</a>
</li>
<li><a href="superfaktura.bank_account.html#superfaktura.bank_account.BankAccount.default">default() (superfaktura.bank_account.BankAccount method)</a>, <a href="superfaktura.html#superfaktura.bank_account.BankAccount.default">[1]</a>
<ul>
<li><a href="superfaktura.utils.data_types.html#superfaktura.utils.data_types.DateEncoder.default">(superfaktura.utils.data_types.DateEncoder method)</a>, <a href="superfaktura.utils.html#superfaktura.utils.data_types.DateEncoder.default">[1]</a>
</li>
</ul></li>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.default_variable">default_variable (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.default_variable">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.delivery">delivery (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.delivery">[1]</a>
</li>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.delivery_address">delivery_address (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.delivery_address">[1]</a>
</li>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.delivery_city">delivery_city (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.delivery_city">[1]</a>
</li>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.delivery_country">delivery_country (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.delivery_country">[1]</a>
</li>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.delivery_country_id">delivery_country_id (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.delivery_country_id">[1]</a>
</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>
<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>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.deposit">deposit (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.deposit">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceItem.description">description (superfaktura.invoice.InvoiceItem attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem.description">[1]</a>
</li>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.dic">dic (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.dic">[1]</a>
</li>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.discount">discount (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.discount">[1]</a>
<ul>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceItem.discount">(superfaktura.invoice.InvoiceItem attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem.discount">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.discount">(superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.discount">[1]</a>
</li>
</ul></li>
<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.invoice.InvoiceModel.due">due (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.due">[1]</a>
</li>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.due_date">due_date (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.due_date">[1]</a>
</li>
</ul></td>
</tr></table>
<h2 id="E">E</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<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.InvoiceModel.estimate_id">estimate_id (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.estimate_id">[1]</a>
</li>
<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>
</ul></td>
</tr></table>
<h2 id="F">F</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.fax">fax (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.fax">[1]</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.bank_account.html#superfaktura.bank_account.BankAccountModel.from_dict">from_dict() (superfaktura.bank_account.BankAccountModel static method)</a>, <a href="superfaktura.html#superfaktura.bank_account.BankAccountModel.from_dict">[1]</a>
<ul>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.from_dict">(superfaktura.client_contacts.ClientContactModel static method)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.from_dict">[1]</a>
</li>
</ul></li>
</ul></td>
</tr></table>
<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.html#superfaktura.superfaktura_api.SuperFakturaAPI.get">get() (superfaktura.superfaktura_api.SuperFakturaAPI method)</a>, <a href="superfaktura.superfaktura_api.html#superfaktura.superfaktura_api.SuperFakturaAPI.get">[1]</a>
</li>
</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>
</ul></td>
</tr></table>
<h2 id="H">H</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.header_comment">header_comment (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.header_comment">[1]</a>
</li>
</ul></td>
</tr></table>
<h2 id="I">I</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.bank_account.html#superfaktura.bank_account.BankAccountModel.iban">iban (superfaktura.bank_account.BankAccountModel attribute)</a>, <a href="superfaktura.html#superfaktura.bank_account.BankAccountModel.iban">[1]</a>
<ul>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.iban">(superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.iban">[1]</a>
</li>
</ul></li>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.ic_dph">ic_dph (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.ic_dph">[1]</a>
</li>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.ico">ico (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.ico">[1]</a>
</li>
<li><a href="superfaktura.bank_account.html#superfaktura.bank_account.BankAccountModel.id">id (superfaktura.bank_account.BankAccountModel attribute)</a>, <a href="superfaktura.html#superfaktura.bank_account.BankAccountModel.id">[1]</a>
<ul>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.id">(superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.id">[1]</a>
</li>
</ul></li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.internal_comment">internal_comment (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.internal_comment">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.Invoice">Invoice (class in superfaktura.invoice)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.Invoice">[1]</a>
</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.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.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.InvoiceType">InvoiceType (class in superfaktura.invoice)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceType">[1]</a>
</li>
<li><a href="superfaktura.utils.data_types.html#superfaktura.utils.data_types.Date.is_set">is_set() (superfaktura.utils.data_types.Date method)</a>, <a href="superfaktura.utils.html#superfaktura.utils.data_types.Date.is_set">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.issued_by">issued_by (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.issued_by">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.issued_by_email">issued_by_email (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.issued_by_email">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.issued_by_phone">issued_by_phone (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.issued_by_phone">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.issued_by_web">issued_by_web (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.issued_by_web">[1]</a>
</li>
</ul></td>
</tr></table>
<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.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>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContact.list">(superfaktura.client_contacts.ClientContact method)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContact.list">[1]</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceItem.load_data_from_stock">load_data_from_stock (superfaktura.invoice.InvoiceItem attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem.load_data_from_stock">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.logo_id">logo_id (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.logo_id">[1]</a>
</li>
</ul></td>
</tr></table>
<h2 id="M">M</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<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>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.mark_sent_subject">mark_sent_subject (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.mark_sent_subject">[1]</a>
</li>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.match_address">match_address (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.match_address">[1]</a>
</li>
<li>
module
<ul>
<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>
</li>
<li><a href="superfaktura.enumerations.html#module-superfaktura.enumerations">superfaktura.enumerations</a>
</li>
<li><a href="superfaktura.enumerations.currency.html#module-superfaktura.enumerations.currency">superfaktura.enumerations.currency</a>, <a href="superfaktura.enumerations.html#module-superfaktura.enumerations.currency">[1]</a>
</li>
<li><a href="superfaktura.html#module-superfaktura.invoice">superfaktura.invoice</a>, <a href="superfaktura.invoice.html#module-superfaktura.invoice">[1]</a>
</li>
<li><a href="superfaktura.html#module-superfaktura.superfaktura_api">superfaktura.superfaktura_api</a>, <a href="superfaktura.superfaktura_api.html#module-superfaktura.superfaktura_api">[1]</a>
</li>
<li><a href="superfaktura.utils.html#module-superfaktura.utils">superfaktura.utils</a>
</li>
<li><a href="superfaktura.utils.country.html#module-superfaktura.utils.country">superfaktura.utils.country</a>, <a href="superfaktura.utils.html#module-superfaktura.utils.country">[1]</a>
</li>
<li><a href="superfaktura.utils.data_types.html#module-superfaktura.utils.data_types">superfaktura.utils.data_types</a>, <a href="superfaktura.utils.html#module-superfaktura.utils.data_types">[1]</a>
</li>
</ul></li>
</ul></td>
</tr></table>
<h2 id="N">N</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.name">name (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.name">[1]</a>
<ul>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceItem.name">(superfaktura.invoice.InvoiceItem attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem.name">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.name">(superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.name">[1]</a>
</li>
</ul></li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.bank_account.html#superfaktura.bank_account.NoDefaultBankAccountException">NoDefaultBankAccountException</a>, <a href="superfaktura.html#superfaktura.bank_account.NoDefaultBankAccountException">[1]</a>
</li>
</ul></td>
</tr></table>
<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.InvoiceModel.order_no">order_no (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.order_no">[1]</a>
</li>
</ul></td>
</tr></table>
<h2 id="P">P</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<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.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.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>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceType.PROFORMA">PROFORMA (superfaktura.invoice.InvoiceType attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceType.PROFORMA">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.proforma_id">proforma_id (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.proforma_id">[1]</a>
</li>
</ul></td>
</tr></table>
<h2 id="Q">Q</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceItem.quantity">quantity (superfaktura.invoice.InvoiceItem attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem.quantity">[1]</a>
</li>
</ul></td>
</tr></table>
<h2 id="R">R</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.rounding">rounding (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.rounding">[1]</a>
</li>
</ul></td>
</tr></table>
<h2 id="S">S</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<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.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>
superfaktura.bank_account
<ul>
<li><a href="superfaktura.bank_account.html#module-superfaktura.bank_account">module</a>, <a href="superfaktura.html#module-superfaktura.bank_account">[1]</a>
</li>
</ul></li>
<li>
superfaktura.client_contacts
<ul>
<li><a href="superfaktura.client_contacts.html#module-superfaktura.client_contacts">module</a>, <a href="superfaktura.html#module-superfaktura.client_contacts">[1]</a>
</li>
</ul></li>
<li>
superfaktura.enumerations
<ul>
<li><a href="superfaktura.enumerations.html#module-superfaktura.enumerations">module</a>
</li>
</ul></li>
<li>
superfaktura.enumerations.currency
<ul>
<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>
<li>
superfaktura.invoice
<ul>
<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
<ul>
<li><a href="superfaktura.html#module-superfaktura.superfaktura_api">module</a>, <a href="superfaktura.superfaktura_api.html#module-superfaktura.superfaktura_api">[1]</a>
</li>
</ul></li>
<li>
superfaktura.utils
<ul>
<li><a href="superfaktura.utils.html#module-superfaktura.utils">module</a>
</li>
</ul></li>
<li>
superfaktura.utils.country
<ul>
<li><a href="superfaktura.utils.country.html#module-superfaktura.utils.country">module</a>, <a href="superfaktura.utils.html#module-superfaktura.utils.country">[1]</a>
</li>
</ul></li>
<li>
superfaktura.utils.data_types
<ul>
<li><a href="superfaktura.utils.data_types.html#module-superfaktura.utils.data_types">module</a>, <a href="superfaktura.utils.html#module-superfaktura.utils.data_types">[1]</a>
</li>
</ul></li>
<li><a href="superfaktura.html#superfaktura.superfaktura_api.SuperFakturaAPI">SuperFakturaAPI (class in superfaktura.superfaktura_api)</a>, <a href="superfaktura.superfaktura_api.html#superfaktura.superfaktura_api.SuperFakturaAPI">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.superfaktura_api.SuperFakturaAPIException">SuperFakturaAPIException</a>, <a href="superfaktura.superfaktura_api.html#superfaktura.superfaktura_api.SuperFakturaAPIException">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.superfaktura_api.SuperFakturaAPIMissingCredentialsException">SuperFakturaAPIMissingCredentialsException</a>, <a href="superfaktura.superfaktura_api.html#superfaktura.superfaktura_api.SuperFakturaAPIMissingCredentialsException">[1]</a>
</li>
<li><a href="superfaktura.bank_account.html#superfaktura.bank_account.BankAccountModel.swift">swift (superfaktura.bank_account.BankAccountModel attribute)</a>, <a href="superfaktura.html#superfaktura.bank_account.BankAccountModel.swift">[1]</a>
<ul>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.swift">(superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.swift">[1]</a>
</li>
</ul></li>
</ul></td>
</tr></table>
<h2 id="T">T</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.tags">tags (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.tags">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceItem.tax">tax (superfaktura.invoice.InvoiceItem attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem.tax">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.tax_document">tax_document (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.tax_document">[1]</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.to_dict">to_dict() (superfaktura.invoice.InvoiceModel method)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.to_dict">[1]</a>
<ul>
<li><a href="superfaktura.utils.data_types.html#superfaktura.utils.data_types.Date.to_dict">(superfaktura.utils.data_types.Date method)</a>, <a href="superfaktura.utils.html#superfaktura.utils.data_types.Date.to_dict">[1]</a>
</li>
</ul></li>
<li><a href="superfaktura.utils.data_types.html#superfaktura.utils.data_types.Date.to_json">to_json() (superfaktura.utils.data_types.Date method)</a>, <a href="superfaktura.utils.html#superfaktura.utils.data_types.Date.to_json">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.type">type (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.type">[1]</a>
</li>
</ul></td>
</tr></table>
<h2 id="U">U</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceItem.unit">unit (superfaktura.invoice.InvoiceItem attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem.unit">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceItem.unit_price">unit_price (superfaktura.invoice.InvoiceItem attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem.unit_price">[1]</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.update">update (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.update">[1]</a>
</li>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceItem.use_document_currency">use_document_currency (superfaktura.invoice.InvoiceItem attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceItem.use_document_currency">[1]</a>
</li>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.uuid">uuid (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.uuid">[1]</a>
</li>
</ul></td>
</tr></table>
<h2 id="V">V</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.variable">variable (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.variable">[1]</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.html#superfaktura.invoice.InvoiceModel.vat_transfer">vat_transfer (superfaktura.invoice.InvoiceModel attribute)</a>, <a href="superfaktura.invoice.html#superfaktura.invoice.InvoiceModel.vat_transfer">[1]</a>
</li>
</ul></td>
</tr></table>
<h2 id="Z">Z</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="superfaktura.client_contacts.html#superfaktura.client_contacts.ClientContactModel.zip">zip (superfaktura.client_contacts.ClientContactModel attribute)</a>, <a href="superfaktura.html#superfaktura.client_contacts.ClientContactModel.zip">[1]</a>
</li>
</ul></td>
</tr></table>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2025, Richard Kubíček, Eledio s.r.o..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

119
index.html Normal file
View File

@@ -0,0 +1,119 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Welcome to SuperFaktura Clients documentation &mdash; SuperFaktura API client documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="next" title="SuperFaktura API client" href="superfaktura.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="#" class="icon icon-home">
SuperFaktura API client
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<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>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="#">SuperFaktura API client</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="#" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Welcome to SuperFaktura Clients documentation</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="welcome-to-superfaktura-client-s-documentation">
<h1>Welcome to SuperFaktura Clients documentation<a class="headerlink" href="#welcome-to-superfaktura-client-s-documentation" title="Link to this heading"></a></h1>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="superfaktura.html">SuperFaktura API client</a><ul>
<li class="toctree-l2"><a class="reference internal" href="superfaktura.html#module-superfaktura.bank_account">Bank account</a></li>
<li class="toctree-l2"><a class="reference internal" href="superfaktura.html#module-superfaktura.client_contacts">Client contacts</a></li>
<li class="toctree-l2"><a class="reference internal" href="superfaktura.html#module-superfaktura.invoice">Invoice</a></li>
<li class="toctree-l2"><a class="reference internal" href="superfaktura.html#module-superfaktura.superfaktura_api">SuperFaktura API</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="installation.html">Installation</a></li>
</ul>
</div>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="superfaktura.html" class="btn btn-neutral float-right" title="SuperFaktura API client" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2025, Richard Kubíček, Eledio s.r.o..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

111
installation.html Normal file
View File

@@ -0,0 +1,111 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Installation &mdash; SuperFaktura API client documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
<link rel="prev" title="SuperFaktura API client" href="superfaktura.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
SuperFaktura API client
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="superfaktura.html">SuperFaktura API client</a></li>
<li class="toctree-l1 current"><a class="current reference internal" href="#">Installation</a></li>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">SuperFaktura API client</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Installation</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/installation.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="installation">
<h1>Installation<a class="headerlink" href="#installation" title="Link to this heading"></a></h1>
<p>To install SuperFaktura Client, run the following command:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">pip</span> <span class="n">install</span> <span class="n">git</span><span class="o">+</span><span class="n">https</span><span class="p">:</span><span class="o">//</span><span class="n">github</span><span class="o">.</span><span class="n">com</span><span class="o">/</span><span class="n">eledio</span><span class="o">-</span><span class="n">helpers</span><span class="o">/</span><span class="n">superfaktura</span><span class="o">-</span><span class="n">client</span>
</pre></div>
</div>
</section>
</div>
</div>
<footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
<a href="superfaktura.html" class="btn btn-neutral float-left" title="SuperFaktura API client" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
</div>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2025, Richard Kubíček, Eledio s.r.o..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

BIN
objects.inv Normal file

Binary file not shown.

165
py-modindex.html Normal file
View File

@@ -0,0 +1,165 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Python Module Index &mdash; SuperFaktura API client documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
SuperFaktura API client
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<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>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">SuperFaktura API client</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Python Module Index</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<h1>Python Module Index</h1>
<div class="modindex-jumpbox">
<a href="#cap-s"><strong>s</strong></a>
</div>
<table class="indextable modindextable">
<tr class="pcap"><td></td><td>&#160;</td><td></td></tr>
<tr class="cap" id="cap-s"><td></td><td>
<strong>s</strong></td><td></td></tr>
<tr>
<td><img src="_static/minus.png" class="toggler"
id="toggle-1" style="display: none" alt="-" /></td>
<td>
<code class="xref">superfaktura</code></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="superfaktura.bank_account.html#module-superfaktura.bank_account"><code class="xref">superfaktura.bank_account</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="superfaktura.client_contacts.html#module-superfaktura.client_contacts"><code class="xref">superfaktura.client_contacts</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="superfaktura.enumerations.html#module-superfaktura.enumerations"><code class="xref">superfaktura.enumerations</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="superfaktura.enumerations.currency.html#module-superfaktura.enumerations.currency"><code class="xref">superfaktura.enumerations.currency</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="superfaktura.invoice.html#module-superfaktura.invoice"><code class="xref">superfaktura.invoice</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="superfaktura.superfaktura_api.html#module-superfaktura.superfaktura_api"><code class="xref">superfaktura.superfaktura_api</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="superfaktura.utils.html#module-superfaktura.utils"><code class="xref">superfaktura.utils</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="superfaktura.utils.country.html#module-superfaktura.utils.country"><code class="xref">superfaktura.utils.country</code></a></td><td>
<em></em></td></tr>
<tr class="cg-1">
<td></td>
<td>&#160;&#160;&#160;
<a href="superfaktura.utils.data_types.html#module-superfaktura.utils.data_types"><code class="xref">superfaktura.utils.data_types</code></a></td><td>
<em></em></td></tr>
</table>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2025, Richard Kubíček, Eledio s.r.o..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

120
search.html Normal file
View File

@@ -0,0 +1,120 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Search &mdash; SuperFaktura API client documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<script src="_static/searchtools.js"></script>
<script src="_static/language_data.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="#" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
SuperFaktura API client
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="#" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<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>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">SuperFaktura API client</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">Search</li>
<li class="wy-breadcrumbs-aside">
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<noscript>
<div id="fallback" class="admonition warning">
<p class="last">
Please activate JavaScript to enable the search functionality.
</p>
</div>
</noscript>
<div id="search-results">
</div>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2025, Richard Kubíček, Eledio s.r.o..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
<script>
jQuery(function() { Search.loadIndex("searchindex.js"); });
</script>
<script id="searchindexloader"></script>
</body>
</html>

1
searchindex.js Normal file

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1,246 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>superfaktura.bank_account module &mdash; SuperFaktura API client documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
SuperFaktura API client
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<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>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">SuperFaktura API client</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">superfaktura.bank_account module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/superfaktura.bank_account.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="module-superfaktura.bank_account">
<span id="superfaktura-bank-account-module"></span><h1>superfaktura.bank_account module<a class="headerlink" href="#module-superfaktura.bank_account" title="Link to this heading"></a></h1>
<p>Bank Account Module.</p>
<p>This module provides classes and functions for working with bank accounts in the SuperFaktura API.
It allows for retrieving, creating, updating, and deleting bank accounts.</p>
<dl>
<dt>Classes:</dt><dd><ul class="simple">
<li><p>BankAccountModel: Dataclass representing a bank account.</p></li>
<li><p>BankAccount: Class for interacting with bank accounts.</p></li>
</ul>
</dd>
<dt>Exceptions:</dt><dd><ul class="simple">
<li><p>NoDefaultBankAccountException: Exception for when no default bank account is found.</p></li>
</ul>
</dd>
<dt>Functions:</dt><dd><ul class="simple">
<li><p>(none)</p></li>
</ul>
</dd>
<dt>Usage:</dt><dd><p>import superfaktura.bank_account</p>
<p># Create an instance of BankAccount
bank = superfaktura.bank_account.BankAccount()</p>
<p># Retrieve a list of bank accounts
accounts = bank.list()</p>
<p># Get the default bank account
default_account = bank.default()</p>
<p># Create or update a bank account
data = {“account”: “1234567890”, “bank_code”: “1234567890”, “default”: True}
bank.post(data)</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccount">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.bank_account.</span></span><span class="sig-name descname"><span class="pre">BankAccount</span></span><a class="headerlink" href="#superfaktura.bank_account.BankAccount" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="superfaktura.superfaktura_api.html#superfaktura.superfaktura_api.SuperFakturaAPI" title="superfaktura.superfaktura_api.SuperFakturaAPI"><code class="xref py py-class docutils literal notranslate"><span class="pre">SuperFakturaAPI</span></code></a></p>
<p>Bank Account Class.</p>
<p>This class provides methods for interacting with bank accounts in the SuperFaktura API.
It allows for retrieving, creating, updating, and deleting bank accounts.</p>
<dl class="py method">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">list</span></span></dt>
<dd><p>Retrieves a list of bank accounts.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">default</span></span></dt>
<dd><p>Retrieves the default bank account.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">post</span></span></dt>
<dd><p>Creates or updates a bank account.</p>
</dd></dl>
<dl class="simple">
<dt>Usage:</dt><dd><p>bank = BankAccount()
accounts = bank.list()
default_account = bank.default()
data = {“account”: “1234567890”, “bank_code”: “1234567890”, “default”: True}
bank.post(data)</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccount.default">
<span class="sig-name descname"><span class="pre">default</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"><a class="reference internal" href="#superfaktura.bank_account.BankAccountModel" title="superfaktura.bank_account.BankAccountModel"><span class="pre">BankAccountModel</span></a><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><span class="pre">None</span></span></span><a class="headerlink" href="#superfaktura.bank_account.BankAccount.default" title="Link to this definition"></a></dt>
<dd><p>Retrieves the default bank account.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccount.list">
<span class="sig-name descname"><span class="pre">list</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.bank_account.BankAccount.list" title="Link to this definition"></a></dt>
<dd><p>Retrieves a list of bank accounts.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccountModel">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.bank_account.</span></span><span class="sig-name descname"><span class="pre">BankAccountModel</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">account</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></em>, <em class="sig-param"><span class="n"><span class="pre">bank_code</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></em>, <em class="sig-param"><span class="n"><span class="pre">bank_name</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></em>, <em class="sig-param"><span class="n"><span class="pre">default</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></em>, <em class="sig-param"><span class="n"><span class="pre">iban</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></em>, <em class="sig-param"><span class="n"><span class="pre">show</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></em>, <em class="sig-param"><span class="n"><span class="pre">swift</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></em>, <em class="sig-param"><span class="n"><span class="pre">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></em><span class="sig-paren">)</span><a class="headerlink" href="#superfaktura.bank_account.BankAccountModel" 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>Dataclass representing a bank account.</p>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccountModel.account">
<span class="sig-name descname"><span class="pre">account</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><a class="headerlink" href="#superfaktura.bank_account.BankAccountModel.account" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccountModel.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.bank_account.BankAccountModel.as_dict" title="Link to this definition"></a></dt>
<dd><p>Returns a dictionary representation of the BankAccountModel.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccountModel.bank_code">
<span class="sig-name descname"><span class="pre">bank_code</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><a class="headerlink" href="#superfaktura.bank_account.BankAccountModel.bank_code" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccountModel.bank_name">
<span class="sig-name descname"><span class="pre">bank_name</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><a class="headerlink" href="#superfaktura.bank_account.BankAccountModel.bank_name" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccountModel.default">
<span class="sig-name descname"><span class="pre">default</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><a class="headerlink" href="#superfaktura.bank_account.BankAccountModel.default" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccountModel.from_dict">
<em class="property"><span class="pre">static</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">from_dict</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">data</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">dict</span></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">&#x2192;</span> <span class="sig-return-typehint"><a class="reference internal" href="#superfaktura.bank_account.BankAccountModel" title="superfaktura.bank_account.BankAccountModel"><span class="pre">BankAccountModel</span></a></span></span><a class="headerlink" href="#superfaktura.bank_account.BankAccountModel.from_dict" title="Link to this definition"></a></dt>
<dd><p>Creates a BankAccountModel from a dictionary.</p>
</dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccountModel.iban">
<span class="sig-name descname"><span class="pre">iban</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><a class="headerlink" href="#superfaktura.bank_account.BankAccountModel.iban" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccountModel.id">
<span class="sig-name descname"><span class="pre">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><a class="headerlink" href="#superfaktura.bank_account.BankAccountModel.id" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccountModel.show">
<span class="sig-name descname"><span class="pre">show</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><a class="headerlink" href="#superfaktura.bank_account.BankAccountModel.show" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.bank_account.BankAccountModel.swift">
<span class="sig-name descname"><span class="pre">swift</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><a class="headerlink" href="#superfaktura.bank_account.BankAccountModel.swift" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="superfaktura.bank_account.NoDefaultBankAccountException">
<em class="property"><span class="pre">exception</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.bank_account.</span></span><span class="sig-name descname"><span class="pre">NoDefaultBankAccountException</span></span><a class="headerlink" href="#superfaktura.bank_account.NoDefaultBankAccountException" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
<p>Exception for when no default bank account is found.</p>
</dd></dl>
</section>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2025, Richard Kubíček, Eledio s.r.o..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1,142 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>superfaktura.enumerations.currency module &mdash; SuperFaktura API client documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
SuperFaktura API client
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<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>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">SuperFaktura API client</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">superfaktura.enumerations.currency module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/superfaktura.enumerations.currency.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="module-superfaktura.enumerations.currency">
<span id="superfaktura-enumerations-currency-module"></span><h1>superfaktura.enumerations.currency module<a class="headerlink" href="#module-superfaktura.enumerations.currency" title="Link to this heading"></a></h1>
<p>Currency Enumeration.</p>
<p>This module provides an enumeration of currencies that can be used in the SuperFaktura API.</p>
<dl class="simple">
<dt>Classes:</dt><dd><ul class="simple">
<li><p>Currencies: Enumeration of currencies.</p></li>
</ul>
</dd>
<dt>Usage:</dt><dd><p>from superfaktura.enumerations.currency import Currencies
currency = Currencies.CZK</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.enumerations.currency.Currencies">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.enumerations.currency.</span></span><span class="sig-name descname"><span class="pre">Currencies</span></span><a class="headerlink" href="#superfaktura.enumerations.currency.Currencies" 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>Currency Enumeration.</p>
<p>This enumeration represents the different currencies that can be used in the SuperFaktura API.</p>
<dl class="simple">
<dt>Values:</dt><dd><ul class="simple">
<li><p>CZK: Czech Koruna</p></li>
<li><p>EUR: Euro</p></li>
</ul>
</dd>
<dt>Usage:</dt><dd><p>currency = Currencies.CZK</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.enumerations.currency.Currencies.CZK">
<span class="sig-name descname"><span class="pre">CZK</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CZK'</span></em><a class="headerlink" href="#superfaktura.enumerations.currency.Currencies.CZK" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.enumerations.currency.Currencies.EUR">
<span class="sig-name descname"><span class="pre">EUR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'EUR'</span></em><a class="headerlink" href="#superfaktura.enumerations.currency.Currencies.EUR" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2025, Richard Kubíček, Eledio s.r.o..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

View File

@@ -0,0 +1,151 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>superfaktura.enumerations package &mdash; SuperFaktura API client documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
SuperFaktura API client
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<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>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">SuperFaktura API client</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">superfaktura.enumerations package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/superfaktura.enumerations.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="superfaktura-enumerations-package">
<h1>superfaktura.enumerations package<a class="headerlink" href="#superfaktura-enumerations-package" title="Link to this heading"></a></h1>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading"></a></h2>
</section>
<section id="module-superfaktura.enumerations.currency">
<span id="superfaktura-enumerations-currency-module"></span><h2>superfaktura.enumerations.currency module<a class="headerlink" href="#module-superfaktura.enumerations.currency" title="Link to this heading"></a></h2>
<p>Currency Enumeration.</p>
<p>This module provides an enumeration of currencies that can be used in the SuperFaktura API.</p>
<dl class="simple">
<dt>Classes:</dt><dd><ul class="simple">
<li><p>Currencies: Enumeration of currencies.</p></li>
</ul>
</dd>
<dt>Usage:</dt><dd><p>from superfaktura.enumerations.currency import Currencies
currency = Currencies.CZK</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.enumerations.currency.Currencies">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.enumerations.currency.</span></span><span class="sig-name descname"><span class="pre">Currencies</span></span><a class="headerlink" href="#superfaktura.enumerations.currency.Currencies" 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>Currency Enumeration.</p>
<p>This enumeration represents the different currencies that can be used in the SuperFaktura API.</p>
<dl class="simple">
<dt>Values:</dt><dd><ul class="simple">
<li><p>CZK: Czech Koruna</p></li>
<li><p>EUR: Euro</p></li>
</ul>
</dd>
<dt>Usage:</dt><dd><p>currency = Currencies.CZK</p>
</dd>
</dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.enumerations.currency.Currencies.CZK">
<span class="sig-name descname"><span class="pre">CZK</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'CZK'</span></em><a class="headerlink" href="#superfaktura.enumerations.currency.Currencies.CZK" title="Link to this definition"></a></dt>
<dd></dd></dl>
<dl class="py attribute">
<dt class="sig sig-object py" id="superfaktura.enumerations.currency.Currencies.EUR">
<span class="sig-name descname"><span class="pre">EUR</span></span><em class="property"><span class="w"> </span><span class="p"><span class="pre">=</span></span><span class="w"> </span><span class="pre">'EUR'</span></em><a class="headerlink" href="#superfaktura.enumerations.currency.Currencies.EUR" title="Link to this definition"></a></dt>
<dd></dd></dl>
</dd></dl>
</section>
<section id="module-superfaktura.enumerations">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-superfaktura.enumerations" title="Link to this heading"></a></h2>
</section>
</section>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2025, Richard Kubíček, Eledio s.r.o..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

1208
superfaktura.html Normal file

File diff suppressed because one or more lines are too long

550
superfaktura.invoice.html Normal file

File diff suppressed because one or more lines are too long

View File

@@ -0,0 +1,219 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>superfaktura.superfaktura_api module &mdash; SuperFaktura API client documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
SuperFaktura API client
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<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>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">SuperFaktura API client</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">superfaktura.superfaktura_api module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/superfaktura.superfaktura_api.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="module-superfaktura.superfaktura_api">
<span id="superfaktura-superfaktura-api-module"></span><h1>superfaktura.superfaktura_api module<a class="headerlink" href="#module-superfaktura.superfaktura_api" title="Link to this heading"></a></h1>
<p>SuperFaktura API Client.</p>
<p>This module provides classes and functions for working with the SuperFaktura API.
It allows for reading, creating, updating, and deleting data in SuperFaktura.</p>
<dl>
<dt>Classes:</dt><dd><ul class="simple">
<li><p>SuperFakturaAPI: The base class for working with the SuperFaktura API.</p></li>
<li><p>SuperFakturaAPIException: An exception for errors when working with the SuperFaktura API.</p></li>
<li><p>SuperFakturaAPIMissingCredentialsException: An exception for missing login credentials.</p></li>
</ul>
</dd>
<dt>Functions:</dt><dd><ul class="simple">
<li><p>get: Retrieves data from the SuperFaktura API.</p></li>
<li><p>post: Creates or updates data in the SuperFaktura API.</p></li>
</ul>
</dd>
<dt>Usage:</dt><dd><p>import superfaktura.superfaktura_api</p>
<p># Create an instance of SuperFakturaAPI
api = superfaktura.superfaktura_api.SuperFakturaAPI()</p>
<p># Retrieve data from the SuperFaktura API
data = api.get(endpoint)</p>
<p># Create or update data in the SuperFaktura API
api.post(endpoint, data)</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.superfaktura_api.SuperFakturaAPI">
<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.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">&#x2192;</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">
<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>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>The retrieved data in JSON format.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<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>
</dd>
</dl>
<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="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="n">data</span> <span class="o">=</span> <span class="n">api</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s1">&#39;invoices&#39;</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">data</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.post">
<span class="sig-name descname"><span class="pre">post</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</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">&#x2192;</span> <span class="sig-return-typehint"><span class="pre">Dict</span></span></span><a class="headerlink" href="#superfaktura.superfaktura_api.SuperFakturaAPI.post" title="Link to this definition"></a></dt>
<dd><p>Creates or updates data in the SuperFaktura API.</p>
<p>Creates or updates data in 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 create or update data in (e.g. invoices,
clients, etc.).</p></li>
<li><p><strong>data</strong> (<em>str</em>) The data to be created or updated in JSON format.</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>The created or updated data in JSON format.</p>
</dd>
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<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>
</dd>
</dl>
<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="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="n">data</span> <span class="o">=</span> <span class="s1">&#39;{&quot;name&quot;: &quot;Example Invoice&quot;, &quot;amount&quot;: 100.0}&#39;</span>
<span class="gp">&gt;&gt;&gt; </span><span class="n">response</span> <span class="o">=</span> <span class="n">api</span><span class="o">.</span><span class="n">post</span><span class="p">(</span><span class="s1">&#39;invoices&#39;</span><span class="p">,</span> <span class="n">data</span><span class="p">)</span>
<span class="gp">&gt;&gt;&gt; </span><span class="nb">print</span><span class="p">(</span><span class="n">response</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.
The data should be a valid JSON string.</p>
</dd></dl>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="superfaktura.superfaktura_api.SuperFakturaAPIException">
<em class="property"><span class="pre">exception</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">SuperFakturaAPIException</span></span><a class="headerlink" href="#superfaktura.superfaktura_api.SuperFakturaAPIException" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
<p>Exception for errors when working with the SuperFaktura API.</p>
</dd></dl>
<dl class="py exception">
<dt class="sig sig-object py" id="superfaktura.superfaktura_api.SuperFakturaAPIMissingCredentialsException">
<em class="property"><span class="pre">exception</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">SuperFakturaAPIMissingCredentialsException</span></span><a class="headerlink" href="#superfaktura.superfaktura_api.SuperFakturaAPIMissingCredentialsException" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">Exception</span></code></p>
<p>Exception for missing login credentials.</p>
</dd></dl>
</section>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2025, Richard Kubíček, Eledio s.r.o..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

View File

@@ -0,0 +1,139 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>superfaktura.utils.country module &mdash; SuperFaktura API client documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
SuperFaktura API client
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<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>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">SuperFaktura API client</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">superfaktura.utils.country module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/superfaktura.utils.country.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="module-superfaktura.utils.country">
<span id="superfaktura-utils-country-module"></span><h1>superfaktura.utils.country module<a class="headerlink" href="#module-superfaktura.utils.country" title="Link to this heading"></a></h1>
<p>Country Module.</p>
<p>This module provides utilities for working with countries in the SuperFaktura API.</p>
<dl class="simple">
<dt>Functions:</dt><dd><ul class="simple">
<li><p>country_list: Retrieves a list of countries.</p></li>
</ul>
</dd>
<dt>Usage:</dt><dd><p>from superfaktura.utils.country import country_list
countries = country_list()
print(countries)</p>
</dd>
</dl>
<dl class="py function">
<dt class="sig sig-object py" id="superfaktura.utils.country.country_list">
<span class="sig-prename descclassname"><span class="pre">superfaktura.utils.country.</span></span><span class="sig-name descname"><span class="pre">country_list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#superfaktura.utils.country.country_list" title="Link to this definition"></a></dt>
<dd><p>Retrieves a list of countries.</p>
<p>This function returns a list of countries that can be used in the SuperFaktura API.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>A list of countries.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><ul class="simple">
<li><p>list</p></li>
</ul>
</p>
</dd>
</dl>
<dl class="simple">
<dt>Usage:</dt><dd><p>countries = country_list()
print(countries)</p>
</dd>
</dl>
</dd></dl>
</section>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2025, Richard Kubíček, Eledio s.r.o..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

View File

@@ -0,0 +1,213 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>superfaktura.utils.data_types module &mdash; SuperFaktura API client documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
SuperFaktura API client
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<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>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">SuperFaktura API client</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">superfaktura.utils.data_types module</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/superfaktura.utils.data_types.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="module-superfaktura.utils.data_types">
<span id="superfaktura-utils-data-types-module"></span><h1>superfaktura.utils.data_types module<a class="headerlink" href="#module-superfaktura.utils.data_types" title="Link to this heading"></a></h1>
<p>Data Types Module.</p>
<p>This module provides data types and utilities for working with dates and other data types
in the SuperFaktura API.</p>
<dl class="simple">
<dt>Classes:</dt><dd><ul class="simple">
<li><p>Date: Represents a date in the format YYYY-MM-DD.</p></li>
<li><p>DateTime: Represents a date and time in the format YYYY-MM-DD HH:MM:SS.</p></li>
</ul>
</dd>
<dt>Functions:</dt><dd><ul class="simple">
<li><p>(none)</p></li>
</ul>
</dd>
<dt>Usage:</dt><dd><p>from superfaktura.utils.data_types import Date, DateTime
date = Date(“2022-01-01”)
datetime = DateTime(“2022-01-01 12:00:00”)</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.utils.data_types.Date">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.utils.data_types.</span></span><span class="sig-name descname"><span class="pre">Date</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">date_str</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.utils.data_types.Date" 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>Date Class.</p>
<p>This class represents a date in the format YYYY-MM-DD.</p>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">date</span></span></dt>
<dd><p>The date in the format YYYY-MM-DD.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">__str__</span></span></dt>
<dd><p>Returns the date as a string.</p>
</dd></dl>
<dl class="simple">
<dt>Usage:</dt><dd><p>date = Date(“2022-01-01”)
print(date) # Output: 2022-01-01</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.utils.data_types.Date.is_set">
<span class="sig-name descname"><span class="pre">is_set</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">bool</span></span></span><a class="headerlink" href="#superfaktura.utils.data_types.Date.is_set" title="Link to this definition"></a></dt>
<dd><p>Returns True if the date is set, otherwise False.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.utils.data_types.Date.to_dict">
<span class="sig-name descname"><span class="pre">to_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">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><a class="headerlink" href="#superfaktura.utils.data_types.Date.to_dict" title="Link to this definition"></a></dt>
<dd><p>Converts the Date object to a serializable format.
:return: The date as a string in YYYY-MM-DD format, or None if not set.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.utils.data_types.Date.to_json">
<span class="sig-name descname"><span class="pre">to_json</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">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><a class="headerlink" href="#superfaktura.utils.data_types.Date.to_json" title="Link to this definition"></a></dt>
<dd><p>Converts the Date object to a JSON serializable format.
:return: The date as a string in YYYY-MM-DD format, or None if not set.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.utils.data_types.DateEncoder">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.utils.data_types.</span></span><span class="sig-name descname"><span class="pre">DateEncoder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skipkeys</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ensure_ascii</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">check_circular</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allow_nan</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sort_keys</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separators</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#superfaktura.utils.data_types.DateEncoder" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">JSONEncoder</span></code></p>
<p>Date Encoder Class.</p>
<p>This class is a custom JSON encoder that converts Date objects to strings.</p>
<dl class="py method">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">default</span></span></dt>
<dd><p>Encodes a Date object as a string.</p>
</dd></dl>
<dl class="simple">
<dt>Usage:</dt><dd><p>encoder = DateEncoder()
date = Date(“2022-01-01”)
json_string = json.dumps(date, cls=encoder)</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.utils.data_types.DateEncoder.default">
<span class="sig-name descname"><span class="pre">default</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">o</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#superfaktura.utils.data_types.DateEncoder.default" title="Link to this definition"></a></dt>
<dd><p>Implement this method in a subclass such that it returns
a serializable object for <code class="docutils literal notranslate"><span class="pre">o</span></code>, or calls the base implementation
(to raise a <code class="docutils literal notranslate"><span class="pre">TypeError</span></code>).</p>
<p>For example, to support arbitrary iterators, you could
implement default like this:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span><span class="w"> </span><span class="nf">default</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">o</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">iterable</span> <span class="o">=</span> <span class="nb">iter</span><span class="p">(</span><span class="n">o</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">iterable</span><span class="p">)</span>
<span class="c1"># Let the base class default method raise the TypeError</span>
<span class="k">return</span> <span class="n">JSONEncoder</span><span class="o">.</span><span class="n">default</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">o</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
</dd></dl>
</section>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2025, Richard Kubíček, Eledio s.r.o..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>

260
superfaktura.utils.html Normal file
View File

@@ -0,0 +1,260 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="./">
<head>
<meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>superfaktura.utils package &mdash; SuperFaktura API client documentation</title>
<link rel="stylesheet" type="text/css" href="_static/pygments.css?v=b86133f3" />
<link rel="stylesheet" type="text/css" href="_static/css/theme.css?v=e59714d7" />
<script src="_static/jquery.js?v=5d32c60e"></script>
<script src="_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="_static/documentation_options.js?v=5929fcd5"></script>
<script src="_static/doctools.js?v=9bcbadda"></script>
<script src="_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="_static/js/theme.js"></script>
<link rel="index" title="Index" href="genindex.html" />
<link rel="search" title="Search" href="search.html" />
</head>
<body class="wy-body-for-nav">
<div class="wy-grid-for-nav">
<nav data-toggle="wy-nav-shift" class="wy-nav-side">
<div class="wy-side-scroll">
<div class="wy-side-nav-search" >
<a href="index.html" class="icon icon-home">
SuperFaktura API client
</a>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="search.html" method="get">
<input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
</div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
<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>
</ul>
</div>
</div>
</nav>
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
<i data-toggle="wy-nav-top" class="fa fa-bars"></i>
<a href="index.html">SuperFaktura API client</a>
</nav>
<div class="wy-nav-content">
<div class="rst-content">
<div role="navigation" aria-label="Page navigation">
<ul class="wy-breadcrumbs">
<li><a href="index.html" class="icon icon-home" aria-label="Home"></a></li>
<li class="breadcrumb-item active">superfaktura.utils package</li>
<li class="wy-breadcrumbs-aside">
<a href="_sources/superfaktura.utils.rst.txt" rel="nofollow"> View page source</a>
</li>
</ul>
<hr/>
</div>
<div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
<div itemprop="articleBody">
<section id="superfaktura-utils-package">
<h1>superfaktura.utils package<a class="headerlink" href="#superfaktura-utils-package" title="Link to this heading"></a></h1>
<section id="submodules">
<h2>Submodules<a class="headerlink" href="#submodules" title="Link to this heading"></a></h2>
</section>
<section id="module-superfaktura.utils.country">
<span id="superfaktura-utils-country-module"></span><h2>superfaktura.utils.country module<a class="headerlink" href="#module-superfaktura.utils.country" title="Link to this heading"></a></h2>
<p>Country Module.</p>
<p>This module provides utilities for working with countries in the SuperFaktura API.</p>
<dl class="simple">
<dt>Functions:</dt><dd><ul class="simple">
<li><p>country_list: Retrieves a list of countries.</p></li>
</ul>
</dd>
<dt>Usage:</dt><dd><p>from superfaktura.utils.country import country_list
countries = country_list()
print(countries)</p>
</dd>
</dl>
<dl class="py function">
<dt class="sig sig-object py" id="superfaktura.utils.country.country_list">
<span class="sig-prename descclassname"><span class="pre">superfaktura.utils.country.</span></span><span class="sig-name descname"><span class="pre">country_list</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="headerlink" href="#superfaktura.utils.country.country_list" title="Link to this definition"></a></dt>
<dd><p>Retrieves a list of countries.</p>
<p>This function returns a list of countries that can be used in the SuperFaktura API.</p>
<dl class="field-list simple">
<dt class="field-odd">Returns<span class="colon">:</span></dt>
<dd class="field-odd"><p>A list of countries.</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><ul class="simple">
<li><p>list</p></li>
</ul>
</p>
</dd>
</dl>
<dl class="simple">
<dt>Usage:</dt><dd><p>countries = country_list()
print(countries)</p>
</dd>
</dl>
</dd></dl>
</section>
<section id="module-superfaktura.utils.data_types">
<span id="superfaktura-utils-data-types-module"></span><h2>superfaktura.utils.data_types module<a class="headerlink" href="#module-superfaktura.utils.data_types" title="Link to this heading"></a></h2>
<p>Data Types Module.</p>
<p>This module provides data types and utilities for working with dates and other data types
in the SuperFaktura API.</p>
<dl class="simple">
<dt>Classes:</dt><dd><ul class="simple">
<li><p>Date: Represents a date in the format YYYY-MM-DD.</p></li>
<li><p>DateTime: Represents a date and time in the format YYYY-MM-DD HH:MM:SS.</p></li>
</ul>
</dd>
<dt>Functions:</dt><dd><ul class="simple">
<li><p>(none)</p></li>
</ul>
</dd>
<dt>Usage:</dt><dd><p>from superfaktura.utils.data_types import Date, DateTime
date = Date(“2022-01-01”)
datetime = DateTime(“2022-01-01 12:00:00”)</p>
</dd>
</dl>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.utils.data_types.Date">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.utils.data_types.</span></span><span class="sig-name descname"><span class="pre">Date</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">date_str</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.utils.data_types.Date" 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>Date Class.</p>
<p>This class represents a date in the format YYYY-MM-DD.</p>
<dl class="py attribute">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">date</span></span></dt>
<dd><p>The date in the format YYYY-MM-DD.</p>
<dl class="field-list simple">
<dt class="field-odd">Type<span class="colon">:</span></dt>
<dd class="field-odd"><p>str</p>
</dd>
</dl>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">__str__</span></span></dt>
<dd><p>Returns the date as a string.</p>
</dd></dl>
<dl class="simple">
<dt>Usage:</dt><dd><p>date = Date(“2022-01-01”)
print(date) # Output: 2022-01-01</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.utils.data_types.Date.is_set">
<span class="sig-name descname"><span class="pre">is_set</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">bool</span></span></span><a class="headerlink" href="#superfaktura.utils.data_types.Date.is_set" title="Link to this definition"></a></dt>
<dd><p>Returns True if the date is set, otherwise False.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.utils.data_types.Date.to_dict">
<span class="sig-name descname"><span class="pre">to_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">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><a class="headerlink" href="#superfaktura.utils.data_types.Date.to_dict" title="Link to this definition"></a></dt>
<dd><p>Converts the Date object to a serializable format.
:return: The date as a string in YYYY-MM-DD format, or None if not set.</p>
</dd></dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.utils.data_types.Date.to_json">
<span class="sig-name descname"><span class="pre">to_json</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">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><a class="headerlink" href="#superfaktura.utils.data_types.Date.to_json" title="Link to this definition"></a></dt>
<dd><p>Converts the Date object to a JSON serializable format.
:return: The date as a string in YYYY-MM-DD format, or None if not set.</p>
</dd></dl>
</dd></dl>
<dl class="py class">
<dt class="sig sig-object py" id="superfaktura.utils.data_types.DateEncoder">
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">superfaktura.utils.data_types.</span></span><span class="sig-name descname"><span class="pre">DateEncoder</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">skipkeys</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">ensure_ascii</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">check_circular</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">allow_nan</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">True</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">sort_keys</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">indent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">separators</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">default</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#superfaktura.utils.data_types.DateEncoder" title="Link to this definition"></a></dt>
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">JSONEncoder</span></code></p>
<p>Date Encoder Class.</p>
<p>This class is a custom JSON encoder that converts Date objects to strings.</p>
<dl class="py method">
<dt class="sig sig-object py">
<span class="sig-name descname"><span class="pre">-</span> <span class="pre">default</span></span></dt>
<dd><p>Encodes a Date object as a string.</p>
</dd></dl>
<dl class="simple">
<dt>Usage:</dt><dd><p>encoder = DateEncoder()
date = Date(“2022-01-01”)
json_string = json.dumps(date, cls=encoder)</p>
</dd>
</dl>
<dl class="py method">
<dt class="sig sig-object py" id="superfaktura.utils.data_types.DateEncoder.default">
<span class="sig-name descname"><span class="pre">default</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">o</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#superfaktura.utils.data_types.DateEncoder.default" title="Link to this definition"></a></dt>
<dd><p>Implement this method in a subclass such that it returns
a serializable object for <code class="docutils literal notranslate"><span class="pre">o</span></code>, or calls the base implementation
(to raise a <code class="docutils literal notranslate"><span class="pre">TypeError</span></code>).</p>
<p>For example, to support arbitrary iterators, you could
implement default like this:</p>
<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="k">def</span><span class="w"> </span><span class="nf">default</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">o</span><span class="p">):</span>
<span class="k">try</span><span class="p">:</span>
<span class="n">iterable</span> <span class="o">=</span> <span class="nb">iter</span><span class="p">(</span><span class="n">o</span><span class="p">)</span>
<span class="k">except</span> <span class="ne">TypeError</span><span class="p">:</span>
<span class="k">pass</span>
<span class="k">else</span><span class="p">:</span>
<span class="k">return</span> <span class="nb">list</span><span class="p">(</span><span class="n">iterable</span><span class="p">)</span>
<span class="c1"># Let the base class default method raise the TypeError</span>
<span class="k">return</span> <span class="n">JSONEncoder</span><span class="o">.</span><span class="n">default</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">o</span><span class="p">)</span>
</pre></div>
</div>
</dd></dl>
</dd></dl>
</section>
<section id="module-superfaktura.utils">
<span id="module-contents"></span><h2>Module contents<a class="headerlink" href="#module-superfaktura.utils" title="Link to this heading"></a></h2>
</section>
</section>
</div>
</div>
<footer>
<hr/>
<div role="contentinfo">
<p>&#169; Copyright 2025, Richard Kubíček, Eledio s.r.o..</p>
</div>
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
<a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
provided by <a href="https://readthedocs.org">Read the Docs</a>.
</footer>
</div>
</div>
</section>
</div>
<script>
jQuery(function () {
SphinxRtdTheme.Navigation.enable(true);
});
</script>
</body>
</html>