+
+ Read the Docs
+ v: ${config.versions.current.slug}
+
+
+
+ ${renderLanguages(config)}
+ ${renderVersions(config)}
+ ${renderDownloads(config)}
+
+ On Read the Docs
+
+ Project Home
+
+
+ Builds
+
+
+ Downloads
+
+
+
+ Search
+
+
+
+
+
+
+ Hosted by Read the Docs
+
+
+
+ `;
+
+ // 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 = `
+
+ ${versions
+ .map(
+ (version) => `
+
+ ${version.slug}
+ `,
+ )
+ .join("\n")}
+
+ `;
+
+ 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 = `
+
+ ${languages
+ .map(
+ (language) => `
+
+ ${language.language.name}
+ `,
+ )
+ .join("\n")}
+
+ `;
+
+ 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);
+ });
+});
\ No newline at end of file
diff --git a/_static/language_data.js b/_static/language_data.js
new file mode 100644
index 0000000..c7fe6c6
--- /dev/null
+++ b/_static/language_data.js
@@ -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;
+ }
+}
+
diff --git a/_static/minus.png b/_static/minus.png
new file mode 100644
index 0000000..d96755f
Binary files /dev/null and b/_static/minus.png differ
diff --git a/_static/plus.png b/_static/plus.png
new file mode 100644
index 0000000..7107cec
Binary files /dev/null and b/_static/plus.png differ
diff --git a/_static/pygments.css b/_static/pygments.css
new file mode 100644
index 0000000..6f8b210
--- /dev/null
+++ b/_static/pygments.css
@@ -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 */
\ No newline at end of file
diff --git a/_static/searchtools.js b/_static/searchtools.js
new file mode 100644
index 0000000..2c774d1
--- /dev/null
+++ b/_static/searchtools.js
@@ -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);
diff --git a/_static/sphinx_highlight.js b/_static/sphinx_highlight.js
new file mode 100644
index 0000000..8a96c69
--- /dev/null
+++ b/_static/sphinx_highlight.js
@@ -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(
+ '
' +
+ '' +
+ _("Hide Search Matches") +
+ "
"
+ )
+ );
+ },
+
+ /**
+ * 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();
+});
diff --git a/genindex.html b/genindex.html
new file mode 100644
index 0000000..b5a3056
--- /dev/null
+++ b/genindex.html
@@ -0,0 +1,654 @@
+
+
+
+
+
+
+
+
Index — SuperFaktura API client documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SuperFaktura API client
+
+
+
+
+
+
+
+
+
+
Index
+
+
+
A
+ |
B
+ |
C
+ |
D
+ |
E
+ |
F
+ |
G
+ |
H
+ |
I
+ |
L
+ |
M
+ |
N
+ |
O
+ |
P
+ |
Q
+ |
R
+ |
S
+ |
T
+ |
U
+ |
V
+ |
Z
+
+
+
A
+
+
+
B
+
+
+
C
+
+
+
D
+
+
+ Date (class in superfaktura.utils.data_types) , [1]
+DateEncoder (class in superfaktura.utils.data_types) , [1]
+default (superfaktura.bank_account.BankAccountModel attribute) , [1]
+default() (superfaktura.bank_account.BankAccount method) , [1]
+
+ default_variable (superfaktura.client_contacts.ClientContactModel attribute) , [1]
+delivery (superfaktura.invoice.InvoiceModel attribute) , [1]
+delivery_address (superfaktura.client_contacts.ClientContactModel attribute) , [1]
+delivery_city (superfaktura.client_contacts.ClientContactModel attribute) , [1]
+delivery_country (superfaktura.client_contacts.ClientContactModel attribute) , [1]
+delivery_country_id (superfaktura.client_contacts.ClientContactModel attribute) , [1]
+delivery_name (superfaktura.client_contacts.ClientContactModel attribute) , [1]
+
+ delivery_phone (superfaktura.client_contacts.ClientContactModel attribute) , [1]
+delivery_type (superfaktura.invoice.InvoiceModel attribute) , [1]
+delivery_zip (superfaktura.client_contacts.ClientContactModel attribute) , [1]
+deposit (superfaktura.invoice.InvoiceModel attribute) , [1]
+description (superfaktura.invoice.InvoiceItem attribute) , [1]
+dic (superfaktura.client_contacts.ClientContactModel attribute) , [1]
+discount (superfaktura.client_contacts.ClientContactModel attribute) , [1]
+
+ discount_description (superfaktura.invoice.InvoiceItem attribute) , [1]
+discount_total (superfaktura.invoice.InvoiceModel attribute) , [1]
+due (superfaktura.invoice.InvoiceModel attribute) , [1]
+due_date (superfaktura.client_contacts.ClientContactModel attribute) , [1]
+
+
+
E
+
+
+
F
+
+
+
G
+
+
+
H
+
+
+
I
+
+
+ invoice_currency (superfaktura.invoice.InvoiceModel attribute) , [1]
+invoice_no_formatted (superfaktura.invoice.InvoiceModel attribute) , [1]
+InvoiceItem (class in superfaktura.invoice) , [1]
+InvoiceModel (class in superfaktura.invoice) , [1]
+InvoiceType (class in superfaktura.invoice) , [1]
+is_set() (superfaktura.utils.data_types.Date method) , [1]
+issued_by (superfaktura.invoice.InvoiceModel attribute) , [1]
+issued_by_email (superfaktura.invoice.InvoiceModel attribute) , [1]
+issued_by_phone (superfaktura.invoice.InvoiceModel attribute) , [1]
+issued_by_web (superfaktura.invoice.InvoiceModel attribute) , [1]
+
+
+
L
+
+
+
M
+
+
+
N
+
+
+
O
+
+
+
P
+
+
+
Q
+
+
+
R
+
+
+
S
+
+
+
T
+
+
+
U
+
+
+
V
+
+
+
Z
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/index.html b/index.html
new file mode 100644
index 0000000..70d23ce
--- /dev/null
+++ b/index.html
@@ -0,0 +1,119 @@
+
+
+
+
+
+
+
+
+
Welcome to SuperFaktura Client’s documentation — SuperFaktura API client documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SuperFaktura API client
+
+
+
+
+
+
+
+
+
+Welcome to SuperFaktura Client’s documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/installation.html b/installation.html
new file mode 100644
index 0000000..0dde245
--- /dev/null
+++ b/installation.html
@@ -0,0 +1,111 @@
+
+
+
+
+
+
+
+
+
Installation — SuperFaktura API client documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SuperFaktura API client
+
+
+
+
+
+
+
+
+
+Installation
+To install SuperFaktura Client, run the following command:
+pip install git + https : // github . com / eledio - helpers / superfaktura - client
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/objects.inv b/objects.inv
new file mode 100644
index 0000000..887e92c
Binary files /dev/null and b/objects.inv differ
diff --git a/py-modindex.html b/py-modindex.html
new file mode 100644
index 0000000..e724a2d
--- /dev/null
+++ b/py-modindex.html
@@ -0,0 +1,165 @@
+
+
+
+
+
+
+
+
Python Module Index — SuperFaktura API client documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SuperFaktura API client
+
+
+
+
+
+
+ Python Module Index
+
+
+
+
+
+
+
+
+
+
Python Module Index
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/search.html b/search.html
new file mode 100644
index 0000000..5661239
--- /dev/null
+++ b/search.html
@@ -0,0 +1,120 @@
+
+
+
+
+
+
+
+
Search — SuperFaktura API client documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SuperFaktura API client
+
+
+
+
+
+
+
+
+
+
+
+ Please activate JavaScript to enable the search functionality.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/searchindex.js b/searchindex.js
new file mode 100644
index 0000000..0072669
--- /dev/null
+++ b/searchindex.js
@@ -0,0 +1 @@
+Search.setIndex({"alltitles": {"Bank account": [[2, "module-superfaktura.bank_account"]], "Client contacts": [[2, "module-superfaktura.client_contacts"]], "Installation": [[1, null]], "Invoice": [[2, "module-superfaktura.invoice"]], "Module contents": [[5, "module-superfaktura.enumerations"], [9, "module-superfaktura.utils"]], "Submodules": [[5, "submodules"], [9, "submodules"]], "SuperFaktura API": [[2, "module-superfaktura.superfaktura_api"]], "SuperFaktura API client": [[2, null]], "Welcome to SuperFaktura Client\u2019s documentation": [[0, null]], "superfaktura.bank_account module": [[3, null]], "superfaktura.client_contacts module": [[4, null]], "superfaktura.enumerations package": [[5, null]], "superfaktura.enumerations.currency module": [[5, "module-superfaktura.enumerations.currency"], [6, null]], "superfaktura.invoice module": [[7, null]], "superfaktura.superfaktura_api module": [[8, null]], "superfaktura.utils package": [[9, null]], "superfaktura.utils.country module": [[9, "module-superfaktura.utils.country"], [10, null]], "superfaktura.utils.data_types module": [[9, "module-superfaktura.utils.data_types"], [11, null]]}, "docnames": ["index", "installation", "superfaktura", "superfaktura.bank_account", "superfaktura.client_contacts", "superfaktura.enumerations", "superfaktura.enumerations.currency", "superfaktura.invoice", "superfaktura.superfaktura_api", "superfaktura.utils", "superfaktura.utils.country", "superfaktura.utils.data_types"], "envversion": {"sphinx": 64, "sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2}, "filenames": ["index.rst", "installation.rst", "superfaktura.rst", "superfaktura.bank_account.rst", "superfaktura.client_contacts.rst", "superfaktura.enumerations.rst", "superfaktura.enumerations.currency.rst", "superfaktura.invoice.rst", "superfaktura.superfaktura_api.rst", "superfaktura.utils.rst", "superfaktura.utils.country.rst", "superfaktura.utils.data_types.rst"], "indexentries": {"account (superfaktura.bank_account.bankaccountmodel attribute)": [[2, "superfaktura.bank_account.BankAccountModel.account", false], [3, "superfaktura.bank_account.BankAccountModel.account", false]], "add() (superfaktura.invoice.invoice method)": [[2, "superfaktura.invoice.Invoice.add", false], [7, "superfaktura.invoice.Invoice.add", false]], "add_contact() (superfaktura.client_contacts.clientcontact method)": [[2, "superfaktura.client_contacts.ClientContact.add_contact", false], [4, "superfaktura.client_contacts.ClientContact.add_contact", false]], "add_rounding_item (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.add_rounding_item", false], [7, "superfaktura.invoice.InvoiceModel.add_rounding_item", false]], "address (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.address", false], [4, "superfaktura.client_contacts.ClientContactModel.address", false]], "already_paid (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.already_paid", false], [7, "superfaktura.invoice.InvoiceModel.already_paid", false]], "as_dict() (superfaktura.bank_account.bankaccountmodel method)": [[2, "superfaktura.bank_account.BankAccountModel.as_dict", false], [3, "superfaktura.bank_account.BankAccountModel.as_dict", false]], "as_dict() (superfaktura.client_contacts.clientcontactmodel method)": [[2, "superfaktura.client_contacts.ClientContactModel.as_dict", false], [4, "superfaktura.client_contacts.ClientContactModel.as_dict", false]], "as_dict() (superfaktura.invoice.invoiceitem method)": [[2, "superfaktura.invoice.InvoiceItem.as_dict", false], [7, "superfaktura.invoice.InvoiceItem.as_dict", false]], "as_dict() (superfaktura.invoice.invoicemodel method)": [[2, "superfaktura.invoice.InvoiceModel.as_dict", false], [7, "superfaktura.invoice.InvoiceModel.as_dict", false]], "bank_account (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.bank_account", false], [4, "superfaktura.client_contacts.ClientContactModel.bank_account", false]], "bank_accounts (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.bank_accounts", false], [7, "superfaktura.invoice.InvoiceModel.bank_accounts", false]], "bank_code (superfaktura.bank_account.bankaccountmodel attribute)": [[2, "superfaktura.bank_account.BankAccountModel.bank_code", false], [3, "superfaktura.bank_account.BankAccountModel.bank_code", false]], "bank_code (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.bank_code", false], [4, "superfaktura.client_contacts.ClientContactModel.bank_code", false]], "bank_name (superfaktura.bank_account.bankaccountmodel attribute)": [[2, "superfaktura.bank_account.BankAccountModel.bank_name", false], [3, "superfaktura.bank_account.BankAccountModel.bank_name", false]], "bankaccount (class in superfaktura.bank_account)": [[2, "superfaktura.bank_account.BankAccount", false], [3, "superfaktura.bank_account.BankAccount", false]], "bankaccountmodel (class in superfaktura.bank_account)": [[2, "superfaktura.bank_account.BankAccountModel", false], [3, "superfaktura.bank_account.BankAccountModel", false]], "city (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.city", false], [4, "superfaktura.client_contacts.ClientContactModel.city", false]], "clientcontact (class in superfaktura.client_contacts)": [[2, "superfaktura.client_contacts.ClientContact", false], [4, "superfaktura.client_contacts.ClientContact", false]], "clientcontactmodel (class in superfaktura.client_contacts)": [[2, "superfaktura.client_contacts.ClientContactModel", false], [4, "superfaktura.client_contacts.ClientContactModel", false]], "clientexception": [[2, "superfaktura.client_contacts.ClientException", false], [4, "superfaktura.client_contacts.ClientException", false]], "comment (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.comment", false], [4, "superfaktura.client_contacts.ClientContactModel.comment", false]], "comment (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.comment", false], [7, "superfaktura.invoice.InvoiceModel.comment", false]], "constant (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.constant", false], [7, "superfaktura.invoice.InvoiceModel.constant", false]], "country (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.country", false], [4, "superfaktura.client_contacts.ClientContactModel.country", false]], "country_id (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.country_id", false], [4, "superfaktura.client_contacts.ClientContactModel.country_id", false]], "country_list() (in module superfaktura.utils.country)": [[9, "superfaktura.utils.country.country_list", false], [10, "superfaktura.utils.country.country_list", false]], "created (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.created", false], [7, "superfaktura.invoice.InvoiceModel.created", false]], "currencies (class in superfaktura.enumerations.currency)": [[5, "superfaktura.enumerations.currency.Currencies", false], [6, "superfaktura.enumerations.currency.Currencies", false]], "currency (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.currency", false], [4, "superfaktura.client_contacts.ClientContactModel.currency", false]], "czk (superfaktura.enumerations.currency.currencies attribute)": [[5, "superfaktura.enumerations.currency.Currencies.CZK", false], [6, "superfaktura.enumerations.currency.Currencies.CZK", false]], "date (class in superfaktura.utils.data_types)": [[9, "superfaktura.utils.data_types.Date", false], [11, "superfaktura.utils.data_types.Date", false]], "dateencoder (class in superfaktura.utils.data_types)": [[9, "superfaktura.utils.data_types.DateEncoder", false], [11, "superfaktura.utils.data_types.DateEncoder", false]], "default (superfaktura.bank_account.bankaccountmodel attribute)": [[2, "superfaktura.bank_account.BankAccountModel.default", false], [3, "superfaktura.bank_account.BankAccountModel.default", false]], "default() (superfaktura.bank_account.bankaccount method)": [[2, "superfaktura.bank_account.BankAccount.default", false], [3, "superfaktura.bank_account.BankAccount.default", false]], "default() (superfaktura.utils.data_types.dateencoder method)": [[9, "superfaktura.utils.data_types.DateEncoder.default", false], [11, "superfaktura.utils.data_types.DateEncoder.default", false]], "default_variable (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.default_variable", false], [4, "superfaktura.client_contacts.ClientContactModel.default_variable", false]], "delivery (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.delivery", false], [7, "superfaktura.invoice.InvoiceModel.delivery", false]], "delivery_address (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.delivery_address", false], [4, "superfaktura.client_contacts.ClientContactModel.delivery_address", false]], "delivery_city (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.delivery_city", false], [4, "superfaktura.client_contacts.ClientContactModel.delivery_city", false]], "delivery_country (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.delivery_country", false], [4, "superfaktura.client_contacts.ClientContactModel.delivery_country", false]], "delivery_country_id (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.delivery_country_id", false], [4, "superfaktura.client_contacts.ClientContactModel.delivery_country_id", false]], "delivery_name (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.delivery_name", false], [4, "superfaktura.client_contacts.ClientContactModel.delivery_name", false]], "delivery_phone (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.delivery_phone", false], [4, "superfaktura.client_contacts.ClientContactModel.delivery_phone", false]], "delivery_type (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.delivery_type", false], [7, "superfaktura.invoice.InvoiceModel.delivery_type", false]], "delivery_zip (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.delivery_zip", false], [4, "superfaktura.client_contacts.ClientContactModel.delivery_zip", false]], "deposit (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.deposit", false], [7, "superfaktura.invoice.InvoiceModel.deposit", false]], "description (superfaktura.invoice.invoiceitem attribute)": [[2, "superfaktura.invoice.InvoiceItem.description", false], [7, "superfaktura.invoice.InvoiceItem.description", false]], "dic (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.dic", false], [4, "superfaktura.client_contacts.ClientContactModel.dic", false]], "discount (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.discount", false], [4, "superfaktura.client_contacts.ClientContactModel.discount", false]], "discount (superfaktura.invoice.invoiceitem attribute)": [[2, "superfaktura.invoice.InvoiceItem.discount", false], [7, "superfaktura.invoice.InvoiceItem.discount", false]], "discount (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.discount", false], [7, "superfaktura.invoice.InvoiceModel.discount", false]], "discount_description (superfaktura.invoice.invoiceitem attribute)": [[2, "superfaktura.invoice.InvoiceItem.discount_description", false], [7, "superfaktura.invoice.InvoiceItem.discount_description", false]], "discount_total (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.discount_total", false], [7, "superfaktura.invoice.InvoiceModel.discount_total", false]], "due (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.due", false], [7, "superfaktura.invoice.InvoiceModel.due", false]], "due_date (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.due_date", false], [4, "superfaktura.client_contacts.ClientContactModel.due_date", false]], "email (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.email", false], [4, "superfaktura.client_contacts.ClientContactModel.email", false]], "estimate_id (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.estimate_id", false], [7, "superfaktura.invoice.InvoiceModel.estimate_id", false]], "eur (superfaktura.enumerations.currency.currencies attribute)": [[5, "superfaktura.enumerations.currency.Currencies.EUR", false], [6, "superfaktura.enumerations.currency.Currencies.EUR", false]], "fax (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.fax", false], [4, "superfaktura.client_contacts.ClientContactModel.fax", false]], "from_dict() (superfaktura.bank_account.bankaccountmodel static method)": [[2, "superfaktura.bank_account.BankAccountModel.from_dict", false], [3, "superfaktura.bank_account.BankAccountModel.from_dict", false]], "from_dict() (superfaktura.client_contacts.clientcontactmodel static method)": [[2, "superfaktura.client_contacts.ClientContactModel.from_dict", false], [4, "superfaktura.client_contacts.ClientContactModel.from_dict", false]], "get() (superfaktura.superfaktura_api.superfakturaapi method)": [[2, "superfaktura.superfaktura_api.SuperFakturaAPI.get", false], [8, "superfaktura.superfaktura_api.SuperFakturaAPI.get", false]], "get_client() (superfaktura.client_contacts.clientcontact method)": [[2, "superfaktura.client_contacts.ClientContact.get_client", false], [4, "superfaktura.client_contacts.ClientContact.get_client", false]], "header_comment (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.header_comment", false], [7, "superfaktura.invoice.InvoiceModel.header_comment", false]], "iban (superfaktura.bank_account.bankaccountmodel attribute)": [[2, "superfaktura.bank_account.BankAccountModel.iban", false], [3, "superfaktura.bank_account.BankAccountModel.iban", false]], "iban (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.iban", false], [4, "superfaktura.client_contacts.ClientContactModel.iban", false]], "ic_dph (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.ic_dph", false], [4, "superfaktura.client_contacts.ClientContactModel.ic_dph", false]], "ico (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.ico", false], [4, "superfaktura.client_contacts.ClientContactModel.ico", false]], "id (superfaktura.bank_account.bankaccountmodel attribute)": [[2, "superfaktura.bank_account.BankAccountModel.id", false], [3, "superfaktura.bank_account.BankAccountModel.id", false]], "id (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.id", false], [4, "superfaktura.client_contacts.ClientContactModel.id", false]], "internal_comment (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.internal_comment", false], [7, "superfaktura.invoice.InvoiceModel.internal_comment", false]], "invoice (class in superfaktura.invoice)": [[2, "superfaktura.invoice.Invoice", false], [7, "superfaktura.invoice.Invoice", false]], "invoice (superfaktura.invoice.invoicetype attribute)": [[2, "superfaktura.invoice.InvoiceType.INVOICE", false], [7, "superfaktura.invoice.InvoiceType.INVOICE", false]], "invoice_currency (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.invoice_currency", false], [7, "superfaktura.invoice.InvoiceModel.invoice_currency", false]], "invoice_no_formatted (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.invoice_no_formatted", false], [7, "superfaktura.invoice.InvoiceModel.invoice_no_formatted", false]], "invoiceitem (class in superfaktura.invoice)": [[2, "superfaktura.invoice.InvoiceItem", false], [7, "superfaktura.invoice.InvoiceItem", false]], "invoicemodel (class in superfaktura.invoice)": [[2, "superfaktura.invoice.InvoiceModel", false], [7, "superfaktura.invoice.InvoiceModel", false]], "invoicetype (class in superfaktura.invoice)": [[2, "superfaktura.invoice.InvoiceType", false], [7, "superfaktura.invoice.InvoiceType", false]], "is_set() (superfaktura.utils.data_types.date method)": [[9, "superfaktura.utils.data_types.Date.is_set", false], [11, "superfaktura.utils.data_types.Date.is_set", false]], "issued_by (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.issued_by", false], [7, "superfaktura.invoice.InvoiceModel.issued_by", false]], "issued_by_email (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.issued_by_email", false], [7, "superfaktura.invoice.InvoiceModel.issued_by_email", false]], "issued_by_phone (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.issued_by_phone", false], [7, "superfaktura.invoice.InvoiceModel.issued_by_phone", false]], "issued_by_web (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.issued_by_web", false], [7, "superfaktura.invoice.InvoiceModel.issued_by_web", false]], "list() (superfaktura.bank_account.bankaccount method)": [[2, "superfaktura.bank_account.BankAccount.list", false], [3, "superfaktura.bank_account.BankAccount.list", false]], "list() (superfaktura.client_contacts.clientcontact method)": [[2, "superfaktura.client_contacts.ClientContact.list", false], [4, "superfaktura.client_contacts.ClientContact.list", false]], "load_data_from_stock (superfaktura.invoice.invoiceitem attribute)": [[2, "superfaktura.invoice.InvoiceItem.load_data_from_stock", false], [7, "superfaktura.invoice.InvoiceItem.load_data_from_stock", false]], "logo_id (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.logo_id", false], [7, "superfaktura.invoice.InvoiceModel.logo_id", false]], "mark_sent (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.mark_sent", false], [7, "superfaktura.invoice.InvoiceModel.mark_sent", false]], "mark_sent_message (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.mark_sent_message", false], [7, "superfaktura.invoice.InvoiceModel.mark_sent_message", false]], "mark_sent_subject (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.mark_sent_subject", false], [7, "superfaktura.invoice.InvoiceModel.mark_sent_subject", false]], "match_address (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.match_address", false], [4, "superfaktura.client_contacts.ClientContactModel.match_address", false]], "module": [[2, "module-superfaktura.bank_account", false], [2, "module-superfaktura.client_contacts", false], [2, "module-superfaktura.invoice", false], [2, "module-superfaktura.superfaktura_api", false], [3, "module-superfaktura.bank_account", false], [4, "module-superfaktura.client_contacts", false], [5, "module-superfaktura.enumerations", false], [5, "module-superfaktura.enumerations.currency", false], [6, "module-superfaktura.enumerations.currency", false], [7, "module-superfaktura.invoice", false], [8, "module-superfaktura.superfaktura_api", false], [9, "module-superfaktura.utils", false], [9, "module-superfaktura.utils.country", false], [9, "module-superfaktura.utils.data_types", false], [10, "module-superfaktura.utils.country", false], [11, "module-superfaktura.utils.data_types", false]], "name (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.name", false], [4, "superfaktura.client_contacts.ClientContactModel.name", false]], "name (superfaktura.invoice.invoiceitem attribute)": [[2, "superfaktura.invoice.InvoiceItem.name", false], [7, "superfaktura.invoice.InvoiceItem.name", false]], "name (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.name", false], [7, "superfaktura.invoice.InvoiceModel.name", false]], "nodefaultbankaccountexception": [[2, "superfaktura.bank_account.NoDefaultBankAccountException", false], [3, "superfaktura.bank_account.NoDefaultBankAccountException", false]], "order_no (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.order_no", false], [7, "superfaktura.invoice.InvoiceModel.order_no", false]], "parent_id (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.parent_id", false], [7, "superfaktura.invoice.InvoiceModel.parent_id", false]], "paydate (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.paydate", false], [7, "superfaktura.invoice.InvoiceModel.paydate", false]], "payment_type (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.payment_type", false], [7, "superfaktura.invoice.InvoiceModel.payment_type", false]], "phone (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.phone", false], [4, "superfaktura.client_contacts.ClientContactModel.phone", false]], "post() (superfaktura.superfaktura_api.superfakturaapi method)": [[2, "superfaktura.superfaktura_api.SuperFakturaAPI.post", false], [8, "superfaktura.superfaktura_api.SuperFakturaAPI.post", false]], "proforma (superfaktura.invoice.invoicetype attribute)": [[2, "superfaktura.invoice.InvoiceType.PROFORMA", false], [7, "superfaktura.invoice.InvoiceType.PROFORMA", false]], "proforma_id (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.proforma_id", false], [7, "superfaktura.invoice.InvoiceModel.proforma_id", false]], "quantity (superfaktura.invoice.invoiceitem attribute)": [[2, "superfaktura.invoice.InvoiceItem.quantity", false], [7, "superfaktura.invoice.InvoiceItem.quantity", false]], "rounding (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.rounding", false], [7, "superfaktura.invoice.InvoiceModel.rounding", false]], "sequence_id (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.sequence_id", false], [7, "superfaktura.invoice.InvoiceModel.sequence_id", false]], "show (superfaktura.bank_account.bankaccountmodel attribute)": [[2, "superfaktura.bank_account.BankAccountModel.show", false], [3, "superfaktura.bank_account.BankAccountModel.show", false]], "sku (superfaktura.invoice.invoiceitem attribute)": [[2, "superfaktura.invoice.InvoiceItem.sku", false], [7, "superfaktura.invoice.InvoiceItem.sku", false]], "specific (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.specific", false], [7, "superfaktura.invoice.InvoiceModel.specific", false]], "stock_item_id (superfaktura.invoice.invoiceitem attribute)": [[2, "superfaktura.invoice.InvoiceItem.stock_item_id", false], [7, "superfaktura.invoice.InvoiceItem.stock_item_id", false]], "superfaktura.bank_account": [[2, "module-superfaktura.bank_account", false], [3, "module-superfaktura.bank_account", false]], "superfaktura.client_contacts": [[2, "module-superfaktura.client_contacts", false], [4, "module-superfaktura.client_contacts", false]], "superfaktura.enumerations": [[5, "module-superfaktura.enumerations", false]], "superfaktura.enumerations.currency": [[5, "module-superfaktura.enumerations.currency", false], [6, "module-superfaktura.enumerations.currency", false]], "superfaktura.invoice": [[2, "module-superfaktura.invoice", false], [7, "module-superfaktura.invoice", false]], "superfaktura.superfaktura_api": [[2, "module-superfaktura.superfaktura_api", false], [8, "module-superfaktura.superfaktura_api", false]], "superfaktura.utils": [[9, "module-superfaktura.utils", false]], "superfaktura.utils.country": [[9, "module-superfaktura.utils.country", false], [10, "module-superfaktura.utils.country", false]], "superfaktura.utils.data_types": [[9, "module-superfaktura.utils.data_types", false], [11, "module-superfaktura.utils.data_types", false]], "superfakturaapi (class in superfaktura.superfaktura_api)": [[2, "superfaktura.superfaktura_api.SuperFakturaAPI", false], [8, "superfaktura.superfaktura_api.SuperFakturaAPI", false]], "superfakturaapiexception": [[2, "superfaktura.superfaktura_api.SuperFakturaAPIException", false], [8, "superfaktura.superfaktura_api.SuperFakturaAPIException", false]], "superfakturaapimissingcredentialsexception": [[2, "superfaktura.superfaktura_api.SuperFakturaAPIMissingCredentialsException", false], [8, "superfaktura.superfaktura_api.SuperFakturaAPIMissingCredentialsException", false]], "swift (superfaktura.bank_account.bankaccountmodel attribute)": [[2, "superfaktura.bank_account.BankAccountModel.swift", false], [3, "superfaktura.bank_account.BankAccountModel.swift", false]], "swift (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.swift", false], [4, "superfaktura.client_contacts.ClientContactModel.swift", false]], "tags (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.tags", false], [4, "superfaktura.client_contacts.ClientContactModel.tags", false]], "tax (superfaktura.invoice.invoiceitem attribute)": [[2, "superfaktura.invoice.InvoiceItem.tax", false], [7, "superfaktura.invoice.InvoiceItem.tax", false]], "tax_document (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.tax_document", false], [7, "superfaktura.invoice.InvoiceModel.tax_document", false]], "to_dict() (superfaktura.invoice.invoicemodel method)": [[2, "superfaktura.invoice.InvoiceModel.to_dict", false], [7, "superfaktura.invoice.InvoiceModel.to_dict", false]], "to_dict() (superfaktura.utils.data_types.date method)": [[9, "superfaktura.utils.data_types.Date.to_dict", false], [11, "superfaktura.utils.data_types.Date.to_dict", false]], "to_json() (superfaktura.utils.data_types.date method)": [[9, "superfaktura.utils.data_types.Date.to_json", false], [11, "superfaktura.utils.data_types.Date.to_json", false]], "type (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.type", false], [7, "superfaktura.invoice.InvoiceModel.type", false]], "unit (superfaktura.invoice.invoiceitem attribute)": [[2, "superfaktura.invoice.InvoiceItem.unit", false], [7, "superfaktura.invoice.InvoiceItem.unit", false]], "unit_price (superfaktura.invoice.invoiceitem attribute)": [[2, "superfaktura.invoice.InvoiceItem.unit_price", false], [7, "superfaktura.invoice.InvoiceItem.unit_price", false]], "update (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.update", false], [4, "superfaktura.client_contacts.ClientContactModel.update", false]], "use_document_currency (superfaktura.invoice.invoiceitem attribute)": [[2, "superfaktura.invoice.InvoiceItem.use_document_currency", false], [7, "superfaktura.invoice.InvoiceItem.use_document_currency", false]], "uuid (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.uuid", false], [4, "superfaktura.client_contacts.ClientContactModel.uuid", false]], "variable (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.variable", false], [7, "superfaktura.invoice.InvoiceModel.variable", false]], "vat_transfer (superfaktura.invoice.invoicemodel attribute)": [[2, "superfaktura.invoice.InvoiceModel.vat_transfer", false], [7, "superfaktura.invoice.InvoiceModel.vat_transfer", false]], "zip (superfaktura.client_contacts.clientcontactmodel attribute)": [[2, "superfaktura.client_contacts.ClientContactModel.zip", false], [4, "superfaktura.client_contacts.ClientContactModel.zip", false]]}, "objects": {"superfaktura": [[3, 0, 0, "-", "bank_account"], [4, 0, 0, "-", "client_contacts"], [5, 0, 0, "-", "enumerations"], [7, 0, 0, "-", "invoice"], [8, 0, 0, "-", "superfaktura_api"], [9, 0, 0, "-", "utils"]], "superfaktura.bank_account": [[3, 1, 1, "", "BankAccount"], [3, 1, 1, "", "BankAccountModel"], [3, 4, 1, "", "NoDefaultBankAccountException"]], "superfaktura.bank_account.BankAccount": [[3, 2, 1, "", "default"], [3, 2, 1, "", "list"]], "superfaktura.bank_account.BankAccountModel": [[3, 3, 1, "", "account"], [3, 2, 1, "", "as_dict"], [3, 3, 1, "", "bank_code"], [3, 3, 1, "", "bank_name"], [3, 3, 1, "", "default"], [3, 2, 1, "", "from_dict"], [3, 3, 1, "", "iban"], [3, 3, 1, "", "id"], [3, 3, 1, "", "show"], [3, 3, 1, "", "swift"]], "superfaktura.client_contacts": [[4, 1, 1, "", "ClientContact"], [4, 1, 1, "", "ClientContactModel"], [4, 4, 1, "", "ClientException"]], "superfaktura.client_contacts.ClientContact": [[4, 2, 1, "", "add_contact"], [4, 2, 1, "", "get_client"], [4, 2, 1, "", "list"]], "superfaktura.client_contacts.ClientContactModel": [[4, 3, 1, "", "address"], [4, 2, 1, "", "as_dict"], [4, 3, 1, "", "bank_account"], [4, 3, 1, "", "bank_code"], [4, 3, 1, "", "city"], [4, 3, 1, "", "comment"], [4, 3, 1, "", "country"], [4, 3, 1, "", "country_id"], [4, 3, 1, "", "currency"], [4, 3, 1, "", "default_variable"], [4, 3, 1, "", "delivery_address"], [4, 3, 1, "", "delivery_city"], [4, 3, 1, "", "delivery_country"], [4, 3, 1, "", "delivery_country_id"], [4, 3, 1, "", "delivery_name"], [4, 3, 1, "", "delivery_phone"], [4, 3, 1, "", "delivery_zip"], [4, 3, 1, "", "dic"], [4, 3, 1, "", "discount"], [4, 3, 1, "", "due_date"], [4, 3, 1, "", "email"], [4, 3, 1, "", "fax"], [4, 2, 1, "", "from_dict"], [4, 3, 1, "", "iban"], [4, 3, 1, "", "ic_dph"], [4, 3, 1, "", "ico"], [4, 3, 1, "", "id"], [4, 3, 1, "", "match_address"], [4, 3, 1, "", "name"], [4, 3, 1, "", "phone"], [4, 3, 1, "", "swift"], [4, 3, 1, "", "tags"], [4, 3, 1, "", "update"], [4, 3, 1, "", "uuid"], [4, 3, 1, "", "zip"]], "superfaktura.enumerations": [[6, 0, 0, "-", "currency"]], "superfaktura.enumerations.currency": [[6, 1, 1, "", "Currencies"]], "superfaktura.enumerations.currency.Currencies": [[6, 3, 1, "", "CZK"], [6, 3, 1, "", "EUR"]], "superfaktura.invoice": [[7, 1, 1, "", "Invoice"], [7, 1, 1, "", "InvoiceItem"], [7, 1, 1, "", "InvoiceModel"], [7, 1, 1, "", "InvoiceType"]], "superfaktura.invoice.Invoice": [[7, 2, 1, "", "add"]], "superfaktura.invoice.InvoiceItem": [[7, 2, 1, "", "as_dict"], [7, 3, 1, "", "description"], [7, 3, 1, "", "discount"], [7, 3, 1, "", "discount_description"], [7, 3, 1, "", "load_data_from_stock"], [7, 3, 1, "", "name"], [7, 3, 1, "", "quantity"], [7, 3, 1, "", "sku"], [7, 3, 1, "", "stock_item_id"], [7, 3, 1, "", "tax"], [7, 3, 1, "", "unit"], [7, 3, 1, "", "unit_price"], [7, 3, 1, "", "use_document_currency"]], "superfaktura.invoice.InvoiceModel": [[7, 3, 1, "", "add_rounding_item"], [7, 3, 1, "", "already_paid"], [7, 2, 1, "", "as_dict"], [7, 3, 1, "", "bank_accounts"], [7, 3, 1, "", "comment"], [7, 3, 1, "", "constant"], [7, 3, 1, "", "created"], [7, 3, 1, "", "delivery"], [7, 3, 1, "", "delivery_type"], [7, 3, 1, "", "deposit"], [7, 3, 1, "", "discount"], [7, 3, 1, "", "discount_total"], [7, 3, 1, "", "due"], [7, 3, 1, "", "estimate_id"], [7, 3, 1, "", "header_comment"], [7, 3, 1, "", "internal_comment"], [7, 3, 1, "", "invoice_currency"], [7, 3, 1, "", "invoice_no_formatted"], [7, 3, 1, "", "issued_by"], [7, 3, 1, "", "issued_by_email"], [7, 3, 1, "", "issued_by_phone"], [7, 3, 1, "", "issued_by_web"], [7, 3, 1, "", "logo_id"], [7, 3, 1, "", "mark_sent"], [7, 3, 1, "", "mark_sent_message"], [7, 3, 1, "", "mark_sent_subject"], [7, 3, 1, "", "name"], [7, 3, 1, "", "order_no"], [7, 3, 1, "", "parent_id"], [7, 3, 1, "", "paydate"], [7, 3, 1, "", "payment_type"], [7, 3, 1, "", "proforma_id"], [7, 3, 1, "", "rounding"], [7, 3, 1, "", "sequence_id"], [7, 3, 1, "", "specific"], [7, 3, 1, "", "tax_document"], [7, 2, 1, "", "to_dict"], [7, 3, 1, "", "type"], [7, 3, 1, "", "variable"], [7, 3, 1, "", "vat_transfer"]], "superfaktura.invoice.InvoiceType": [[7, 3, 1, "", "INVOICE"], [7, 3, 1, "", "PROFORMA"]], "superfaktura.superfaktura_api": [[8, 1, 1, "", "SuperFakturaAPI"], [8, 4, 1, "", "SuperFakturaAPIException"], [8, 4, 1, "", "SuperFakturaAPIMissingCredentialsException"]], "superfaktura.superfaktura_api.SuperFakturaAPI": [[8, 2, 1, "", "get"], [8, 2, 1, "", "post"]], "superfaktura.utils": [[10, 0, 0, "-", "country"], [11, 0, 0, "-", "data_types"]], "superfaktura.utils.country": [[10, 5, 1, "", "country_list"]], "superfaktura.utils.data_types": [[11, 1, 1, "", "Date"], [11, 1, 1, "", "DateEncoder"]], "superfaktura.utils.data_types.Date": [[11, 2, 1, "", "is_set"], [11, 2, 1, "", "to_dict"], [11, 2, 1, "", "to_json"]], "superfaktura.utils.data_types.DateEncoder": [[11, 2, 1, "", "default"]]}, "objnames": {"0": ["py", "module", "Python module"], "1": ["py", "class", "Python class"], "2": ["py", "method", "Python method"], "3": ["py", "attribute", "Python attribute"], "4": ["py", "exception", "Python exception"], "5": ["py", "function", "Python function"]}, "objtypes": {"0": "py:module", "1": "py:class", "2": "py:method", "3": "py:attribute", "4": "py:exception", "5": "py:function"}, "terms": {"0": [2, 7, 8], "00": [9, 11], "01": [2, 7, 9, 11], "02": [2, 7], "1": [2, 7], "100": [2, 7, 8], "12": [9, 11], "123": [2, 7], "1234567890": [2, 3], "2": [2, 7], "2022": [9, 11], "2025": [2, 7], "21": [2, 7], "3": [2, 7], "420": [2, 7], "456": [2, 7], "5": [2, 8], "50": [2, 7], "57": [2, 7], "75": [2, 7], "789": [2, 7], "861": [2, 7], "A": [9, 10], "For": [9, 11], "If": [2, 8], "It": [2, 3, 7, 8], "The": [2, 8, 9, 11], "To": 1, "__str__": [9, 11], "account": [0, 3, 7], "add": [2, 4, 7], "add_contact": [2, 4], "add_rounding_item": [2, 7], "address": [2, 4, 7], "all": [2, 4], "allow": [2, 3, 7, 8], "allow_nan": [9, 11], "already_paid": [2, 7], "amount": [2, 8], "an": [2, 3, 5, 6, 7, 8], "api": [0, 3, 4, 5, 6, 7, 8, 9, 10, 11], "arbitrari": [9, 11], "as_dict": [2, 3, 4, 7], "avail": [2, 8], "bank": [0, 3, 7], "bank_account": [2, 4, 7], "bank_cod": [2, 3, 4], "bank_nam": [2, 3], "bankaccount": [2, 3], "bankaccountmodel": [2, 3], "base": [2, 3, 4, 5, 6, 7, 8, 9, 11], "bool": [2, 4, 9, 11], "call": [9, 11], "can": [2, 5, 6, 7, 8, 9, 10], "card": [2, 7], "check_circular": [9, 11], "citi": [2, 4], "cl": [9, 11], "class": [2, 3, 4, 5, 6, 7, 8, 9, 11], "client": [1, 4, 8], "client_contact": [2, 7], "client_id": [2, 4], "clientcontact": [2, 4], "clientcontactmodel": [2, 4, 7], "clientexcept": [2, 4], "com": [1, 2, 7], "command": 1, "comment": [2, 4, 7], "constant": [2, 7], "contact": [0, 4, 7], "convert": [2, 7, 9, 11], "could": [9, 11], "countri": [2, 4], "country_id": [2, 4, 7], "country_list": [9, 10], "creat": [2, 3, 4, 7, 8], "credenti": [2, 4, 8], "currenc": [2, 4, 7], "custom": [9, 11], "czech": [5, 6], "czk": [2, 5, 6, 7], "data": [2, 3, 4, 8, 9, 11], "dataclass": [2, 3, 4, 7], "date": [2, 7, 9, 11], "date_str": [9, 11], "dateencod": [9, 11], "datetim": [9, 11], "dd": [9, 11], "def": [9, 11], "default": [2, 3, 7, 8, 9, 11], "default_account": [2, 3], "default_vari": [2, 4], "delet": [2, 3, 7, 8], "deliveri": [2, 7], "delivery_address": [2, 4], "delivery_c": [2, 4], "delivery_countri": [2, 4], "delivery_country_id": [2, 4], "delivery_nam": [2, 4], "delivery_phon": [2, 4], "delivery_typ": [2, 7], "delivery_zip": [2, 4], "deposit": [2, 7], "descript": [2, 7], "dic": [2, 4], "dict": [2, 3, 4, 7, 8], "dictionari": [2, 3, 4, 7], "differ": [2, 5, 6, 7], "discount": [2, 4, 7], "discount_descript": [2, 7], "discount_tot": [2, 7], "document": [2, 8], "due": [2, 7], "due_dat": [2, 4], "dump": [9, 11], "e": [2, 8], "eledio": [1, 2, 7], "els": [9, 11], "email": [2, 4, 7], "encod": [9, 11], "endpoint": [2, 8], "ensure_ascii": [9, 11], "enumer": [2, 7], "error": [2, 8], "estimate_id": [2, 7], "etc": [2, 8], "eur": [5, 6], "euro": [5, 6], "exampl": [2, 8, 9, 11], "except": [2, 3, 4, 7, 8, 9, 11], "exist": [2, 4, 7], "fail": [2, 8], "fals": [9, 11], "fax": [2, 4], "float": [2, 4, 7], "foglara": [2, 7], "follow": 1, "format": [2, 8, 9, 11], "found": [2, 3, 7, 8], "from": [2, 3, 4, 5, 6, 8, 9, 10, 11], "from_dict": [2, 3, 4], "function": [2, 3, 4, 7, 8, 9, 10, 11], "g": [2, 8], "get": [2, 3, 4, 7, 8], "get_client": [2, 4], "git": 1, "github": 1, "have": [2, 4], "header_com": [2, 7], "helper": 1, "hh": [9, 11], "http": 1, "i": [2, 3, 7, 9, 11], "iban": [2, 3, 4], "ic_dph": [2, 4], "ico": [2, 4, 7], "id": [2, 3, 4, 7], "implement": [9, 11], "import": [2, 3, 5, 6, 7, 8, 9, 10, 11], "includ": [2, 4], "indent": [9, 11], "inform": [2, 4], "instal": 0, "instanc": [2, 3, 7, 8], "int": [2, 3, 4, 7, 8], "interact": [2, 3, 4, 7], "internal_com": [2, 7], "invoic": [0, 8], "invoice_curr": [2, 7], "invoice_model": [2, 7], "invoice_no_format": [2, 7], "invoice_typ": [2, 7], "invoiceitem": [2, 7], "invoicemodel": [2, 7], "invoicetyp": [2, 7], "is_set": [9, 11], "issued_bi": [2, 7], "issued_by_email": [2, 7], "issued_by_phon": [2, 7], "issued_by_web": [2, 7], "item": [2, 7], "iter": [9, 11], "jaroslava": [2, 7], "json": [2, 7, 8, 9, 11], "json_str": [9, 11], "jsonencod": [9, 11], "k": [2, 7], "kei": [2, 4], "koruna": [5, 6], "kubicekr": [2, 7], "kub\u00ed\u010dek": [2, 7], "let": [9, 11], "like": [9, 11], "list": [2, 3, 4, 7, 9, 10, 11], "load_data_from_stock": [2, 7], "login": [2, 8], "logo_id": [2, 7], "mark_sent": [2, 7], "mark_sent_messag": [2, 7], "mark_sent_subject": [2, 7], "match_address": [2, 4], "method": [2, 3, 7, 9, 11], "miss": [2, 8], "mm": [9, 11], "model": [2, 4], "modul": 2, "must": [2, 4], "name": [2, 4, 7, 8], "new": [2, 4, 7], "nodefaultbankaccountexcept": [2, 3, 7], "none": [2, 3, 4, 7, 9, 11], "note": [2, 4, 8], "o": [9, 11], "object": [2, 3, 4, 5, 6, 7, 8, 9, 11], "option": [2, 8], "order_no": [2, 7], "other": [9, 11], "otherwis": [9, 11], "output": [9, 11], "paramet": [2, 8], "parent_id": [2, 7], "pass": [9, 11], "paydat": [2, 7], "payment_typ": [2, 7], "phone": [2, 4, 7], "pip": 1, "post": [2, 3, 8], "print": [2, 8, 9, 10, 11], "proforma": [2, 7], "proforma_id": [2, 7], "provid": [2, 3, 4, 5, 6, 7, 8, 9, 10, 11], "quantiti": [2, 7], "rais": [2, 8, 9, 11], "read": [2, 4, 8], "record": [2, 7], "regular": [2, 7], "repres": [2, 3, 4, 5, 6, 7, 9, 11], "represent": [2, 3, 4, 7], "request": [2, 8], "respons": [2, 8], "retriev": [2, 3, 7, 8, 9, 10], "return": [2, 3, 4, 7, 8, 9, 10, 11], "richard": [2, 7], "round": [2, 7], "run": 1, "second": [2, 8], "self": [9, 11], "separ": [9, 11], "sequence_id": [2, 7], "serial": [2, 7], "serializ": [9, 11], "servic": [2, 7], "set": [9, 11], "should": [2, 8], "show": [2, 3], "sim": [2, 7], "skipkei": [9, 11], "sku": [2, 7], "sort_kei": [9, 11], "specif": [2, 7], "specifi": [2, 8], "ss": [9, 11], "static": [2, 3, 4], "stock_item_id": [2, 7], "str": [2, 3, 4, 7, 8, 9, 11], "string": [2, 8, 9, 11], "subclass": [9, 11], "superfaktura": 1, "superfaktura_api": 2, "superfakturaapi": [2, 3, 4, 7, 8], "superfakturaapiexcept": [2, 8], "superfakturaapimissingcredentialsexcept": [2, 8], "support": [9, 11], "swift": [2, 3, 4], "tag": [2, 4], "tax": [2, 7], "tax_docu": [2, 7], "thi": [2, 3, 4, 5, 6, 7, 8, 9, 10, 11], "time": [9, 11], "timeout": [2, 8], "to_dict": [2, 7, 9, 11], "to_json": [9, 11], "true": [2, 3, 7, 9, 11], "try": [9, 11], "type": [2, 7, 8, 9, 10, 11], "typeerror": [9, 11], "unit": [2, 7], "unit_pric": [2, 7], "updat": [2, 3, 4, 7, 8], "us": [2, 4, 5, 6, 9, 10], "usag": [2, 3, 5, 6, 7, 8, 9, 10, 11], "use_document_curr": [2, 7], "uuid": [2, 4], "valid": [2, 4, 8], "valu": [5, 6], "variabl": [2, 4, 7], "vat_transf": [2, 7], "we": [2, 7], "when": [2, 3, 7, 8], "work": [2, 3, 4, 7, 8, 9, 10, 11], "you": [2, 4, 7, 9, 11], "yyyi": [9, 11], "zip": [2, 4]}, "titles": ["Welcome to SuperFaktura Client\u2019s documentation", "Installation", "SuperFaktura API client", "superfaktura.bank_account module", "superfaktura.client_contacts module", "superfaktura.enumerations package", "superfaktura.enumerations.currency module", "superfaktura.invoice module", "superfaktura.superfaktura_api module", "superfaktura.utils package", "superfaktura.utils.country module", "superfaktura.utils.data_types module"], "titleterms": {"": 0, "account": 2, "api": 2, "bank": 2, "bank_account": 3, "client": [0, 2], "client_contact": 4, "contact": 2, "content": [5, 9], "countri": [9, 10], "currenc": [5, 6], "data_typ": [9, 11], "document": 0, "enumer": [5, 6], "instal": 1, "invoic": [2, 7], "modul": [3, 4, 5, 6, 7, 8, 9, 10, 11], "packag": [5, 9], "submodul": [5, 9], "superfaktura": [0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11], "superfaktura_api": 8, "util": [9, 10, 11], "welcom": 0}})
\ No newline at end of file
diff --git a/superfaktura.bank_account.html b/superfaktura.bank_account.html
new file mode 100644
index 0000000..cd4b9ce
--- /dev/null
+++ b/superfaktura.bank_account.html
@@ -0,0 +1,246 @@
+
+
+
+
+
+
+
+
+
superfaktura.bank_account module — SuperFaktura API client documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SuperFaktura API client
+
+
+
+
+
+
+
+
+
+superfaktura.bank_account module
+Bank Account Module.
+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.
+
+Classes:
+
+Exceptions:
+
+Functions:
+
+Usage: import superfaktura.bank_account
+# Create an instance of BankAccount
+bank = superfaktura.bank_account.BankAccount()
+# Retrieve a list of bank accounts
+accounts = bank.list()
+# Get the default bank account
+default_account = bank.default()
+# Create or update a bank account
+data = {“account”: “1234567890”, “bank_code”: “1234567890”, “default”: True}
+bank.post(data)
+
+
+
+class superfaktura.bank_account. BankAccount
+Bases: SuperFakturaAPI
+Bank Account Class.
+This class provides methods for interacting with bank accounts in the SuperFaktura API.
+It allows for retrieving, creating, updating, and deleting bank accounts.
+
+
+- list
+Retrieves a list of bank accounts.
+
+
+
+
+- default
+Retrieves the default bank account.
+
+
+
+
+- post
+Creates or updates a bank account.
+
+
+
+Usage: bank = BankAccount()
+accounts = bank.list()
+default_account = bank.default()
+data = {“account”: “1234567890”, “bank_code”: “1234567890”, “default”: True}
+bank.post(data)
+
+
+
+default ( ) → BankAccountModel | None
+Retrieves the default bank account.
+
+
+
+
+list ( ) → dict
+Retrieves a list of bank accounts.
+
+
+
+
+
+
+class superfaktura.bank_account. BankAccountModel ( account : str | None bank_code : str | None bank_name : str | None default : int | None iban : str | None show : int | None swift : str | None id : int | None )
+Bases: object
+Dataclass representing a bank account.
+
+
+account : str | None
+
+
+
+
+as_dict ( ) → dict
+Returns a dictionary representation of the BankAccountModel.
+
+
+
+
+bank_code : str | None
+
+
+
+
+bank_name : str | None
+
+
+
+
+default : int | None
+
+
+
+
+static from_dict ( data : dict ) → BankAccountModel
+Creates a BankAccountModel from a dictionary.
+
+
+
+
+iban : str | None
+
+
+
+
+id : int | None
+
+
+
+
+show : int | None
+
+
+
+
+swift : str | None
+
+
+
+
+
+
+exception superfaktura.bank_account. NoDefaultBankAccountException
+Bases: Exception
+Exception for when no default bank account is found.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/superfaktura.client_contacts.html b/superfaktura.client_contacts.html
new file mode 100644
index 0000000..803eedb
--- /dev/null
+++ b/superfaktura.client_contacts.html
@@ -0,0 +1,335 @@
+
+
+
+
+
+
+
+
+
superfaktura.client_contacts module — SuperFaktura API client documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/superfaktura.enumerations.currency.html b/superfaktura.enumerations.currency.html
new file mode 100644
index 0000000..1989795
--- /dev/null
+++ b/superfaktura.enumerations.currency.html
@@ -0,0 +1,142 @@
+
+
+
+
+
+
+
+
+
superfaktura.enumerations.currency module — SuperFaktura API client documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SuperFaktura API client
+
+
+
+
+
+
+
+
+
+superfaktura.enumerations.currency module
+Currency Enumeration.
+This module provides an enumeration of currencies that can be used in the SuperFaktura API.
+
+Classes:
+
+Usage: from superfaktura.enumerations.currency import Currencies
+currency = Currencies.CZK
+
+
+
+class superfaktura.enumerations.currency. Currencies
+Bases: object
+Currency Enumeration.
+This enumeration represents the different currencies that can be used in the SuperFaktura API.
+
+Values:
+CZK: Czech Koruna
EUR: Euro
+Usage: currency = Currencies.CZK
+
+
+
+CZK = 'CZK'
+
+
+
+
+EUR = 'EUR'
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/superfaktura.enumerations.html b/superfaktura.enumerations.html
new file mode 100644
index 0000000..1d18a2d
--- /dev/null
+++ b/superfaktura.enumerations.html
@@ -0,0 +1,151 @@
+
+
+
+
+
+
+
+
+
superfaktura.enumerations package — SuperFaktura API client documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SuperFaktura API client
+
+
+
+
+
+
+
+
+
+superfaktura.enumerations package
+
+
+superfaktura.enumerations.currency module
+Currency Enumeration.
+This module provides an enumeration of currencies that can be used in the SuperFaktura API.
+
+Classes:
+
+Usage: from superfaktura.enumerations.currency import Currencies
+currency = Currencies.CZK
+
+
+
+class superfaktura.enumerations.currency. Currencies
+Bases: object
+Currency Enumeration.
+This enumeration represents the different currencies that can be used in the SuperFaktura API.
+
+Values:
+CZK: Czech Koruna
EUR: Euro
+Usage: currency = Currencies.CZK
+
+
+
+CZK = 'CZK'
+
+
+
+
+EUR = 'EUR'
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/superfaktura.html b/superfaktura.html
new file mode 100644
index 0000000..3c10317
--- /dev/null
+++ b/superfaktura.html
@@ -0,0 +1,1208 @@
+
+
+
+
+
+
+
+
+
SuperFaktura API client — SuperFaktura API client documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SuperFaktura API client
+
+
+
+
+
+
+
+
+
+SuperFaktura API client
+
+Bank account
+Bank Account Module.
+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.
+
+Classes:
+
+Exceptions:
+
+Functions:
+
+Usage: import superfaktura.bank_account
+# Create an instance of BankAccount
+bank = superfaktura.bank_account.BankAccount()
+# Retrieve a list of bank accounts
+accounts = bank.list()
+# Get the default bank account
+default_account = bank.default()
+# Create or update a bank account
+data = {“account”: “1234567890”, “bank_code”: “1234567890”, “default”: True}
+bank.post(data)
+
+
+
+class superfaktura.bank_account. BankAccount
+Bases: SuperFakturaAPI
+Bank Account Class.
+This class provides methods for interacting with bank accounts in the SuperFaktura API.
+It allows for retrieving, creating, updating, and deleting bank accounts.
+
+
+- list
+Retrieves a list of bank accounts.
+
+
+
+
+- default
+Retrieves the default bank account.
+
+
+
+
+- post
+Creates or updates a bank account.
+
+
+
+Usage: bank = BankAccount()
+accounts = bank.list()
+default_account = bank.default()
+data = {“account”: “1234567890”, “bank_code”: “1234567890”, “default”: True}
+bank.post(data)
+
+
+
+default ( ) → BankAccountModel | None
+Retrieves the default bank account.
+
+
+
+
+list ( ) → dict
+Retrieves a list of bank accounts.
+
+
+
+
+
+
+class superfaktura.bank_account. BankAccountModel ( account : str | None bank_code : str | None bank_name : str | None default : int | None iban : str | None show : int | None swift : str | None id : int | None )
+Bases: object
+Dataclass representing a bank account.
+
+
+account : str | None
+
+
+
+
+as_dict ( ) → dict
+Returns a dictionary representation of the BankAccountModel.
+
+
+
+
+bank_code : str | None
+
+
+
+
+bank_name : str | None
+
+
+
+
+default : int | None
+
+
+
+
+static from_dict ( data : dict ) → BankAccountModel
+Creates a BankAccountModel from a dictionary.
+
+
+
+
+iban : str | None
+
+
+
+
+id : int | None
+
+
+
+
+show : int | None
+
+
+
+
+swift : str | None
+
+
+
+
+
+
+exception superfaktura.bank_account. NoDefaultBankAccountException
+Bases: Exception
+Exception for when no default bank account is found.
+
+
+
+
+
+Invoice
+Invoice Module.
+This module provides classes and functions for working with invoices in the SuperFaktura API.
+It allows for retrieving, creating, updating, and deleting invoices.
+
+Classes:
+InvoiceModel: Dataclass representing an invoice.
InvoiceItem: Dataclass representing an invoice item.
Invoice: Class for interacting with invoices.
+Exceptions:
+
+Functions:
+
+Usage: import superfaktura.invoice
+# Create an instance of Invoice
+invoice = superfaktura.invoice.Invoice()
+# Create an invoice
+invoice.add(
+
+
+invoice=superfaktura.invoice.InvoiceModel( type=superfaktura.invoice.InvoiceType.PROFORMA,
+name=”Invoice 3”,
+due=superfaktura.invoice.Date(“2025-02-01”),
+invoice_currency=superfaktura.invoice.Currencies.CZK,
+header_comment=”We invoice you for services”,
+bank_accounts=[bank.default().as_dict()],
+
+
),
+items=[
+
+
+superfaktura.invoice.InvoiceItem(name=”Services”, unit_price=100, quantity=1, unit=”ks”, tax=21),
+superfaktura.invoice.InvoiceItem(name=”SIM card”, unit_price=50, quantity=1, tax=21, unit=”ks”),
+superfaktura.invoice.InvoiceItem( name=”SIM card 2”, unit_price=75, quantity=1, tax=21, unit=”ks”
+
+
),
+
+
],
+contact=superfaktura.client_contacts.ClientContactModel(
+
+name=”Richard Kubíček”,
+email=”kubicekr@ eledio. com ”,
+phone=”+420 123 456 789”,
+address=”Jaroslava Foglara 861/1”,
+ico=”123”,
+update=True,
+country_id=57,
+
+
),
+
+)
+
+
+
+class superfaktura.invoice. Invoice
+Bases: SuperFakturaAPI
+Invoice Class.
+This class provides methods for interacting with invoices in the SuperFaktura API.
+It allows for retrieving, creating, updating, and deleting invoices.
+
+
+- add
+Creates a new invoice.
+
+
+
+
+- get
+Retrieves an invoice by ID.
+
+
+
+
+- list
+Retrieves a list of invoices.
+
+
+
+
+- update
+Updates an existing invoice.
+
+
+
+Usage: invoice = Invoice()
+invoice.add(
+
+
+invoice=InvoiceModel( type=InvoiceType.PROFORMA,
+name=”Invoice 3”,
+due=Date(“2025-02-01”),
+invoice_currency=Currencies.CZK,
+header_comment=”We invoice you for services”,
+bank_accounts=[bank.default().as_dict()],
+
+
),
+items=[
+
+InvoiceItem(name=”Services”, unit_price=100, quantity=1, unit=”ks”, tax=21),
+InvoiceItem(name=”SIM card”, unit_price=50, quantity=1, tax=21, unit=”ks”),
+InvoiceItem(
+
+name=”SIM card 2”, unit_price=75, quantity=1, tax=21, unit=”ks”
+
+
),
+
+
],
+contact=ClientContactModel(
+
+name=”Richard Kubíček”,
+email=”kubicekr@ eledio. com ”,
+phone=”+420 123 456 789”,
+address=”Jaroslava Foglara 861/1”,
+ico=”123”,
+update=True,
+country_id=57,
+
+
),
+
+)
+
+
+
+add ( invoice_model : InvoiceModel items : List [ InvoiceItem ] contact : ClientContactModel )
+Creates a new invoice.
+
+
+
+
+
+
+class superfaktura.invoice. InvoiceItem ( name : str unit_price : float description : str | None = None discount : float | None = 0 discount_description : str | None = None load_data_from_stock : int = 0 quantity : float | None = 1 sku : str | None = None stock_item_id : int | None = None tax : float | None = None unit : str | None = None use_document_currency : int | None = 0 )
+Bases: object
+This dataclass represents an invoice item in the SuperFaktura API.
+
+
+as_dict ( ) → dict
+Returns a dictionary representation of the InvoiceItem.
+
+
+
+
+description : str | None = None
+
+
+
+
+discount : float | None = 0
+
+
+
+
+discount_description : str | None = None
+
+
+
+
+load_data_from_stock : int = 0
+
+
+
+
+name : str
+
+
+
+
+quantity : float | None = 1
+
+
+
+
+sku : str | None = None
+
+
+
+
+stock_item_id : int | None = None
+
+
+
+
+tax : float | None = None
+
+
+
+
+unit : str | None = None
+
+
+
+
+unit_price : float
+
+
+
+
+use_document_currency : int | None = 0
+
+
+
+
+
+
+class superfaktura.invoice. InvoiceModel ( add_rounding_item : int | None = 0 already_paid : int | None = None bank_accounts : List [ dict ] | None = None comment : str | None = None constant : str | None = None created : Date | None = None delivery : Date | None = None delivery_type : str | None = None deposit : float | None = None discount : float | None = 0 discount_total : float | None = None due : Date | None = None estimate_id : int | None = None header_comment : str | None = None internal_comment : str | None = None invoice_currency : str | None = None invoice_no_formatted : str | None = None issued_by : str | None = None issued_by_email : str | None = None issued_by_phone : str | None = None issued_by_web : str | None = None logo_id : int | None = None mark_sent : int | None = None mark_sent_message : str | None = None mark_sent_subject : str | None = None name : str | None = None order_no : str | None = None parent_id : int | None = None paydate : Date | None = None payment_type : str | None = None proforma_id : str | None = None rounding : str | None = None sequence_id : int | None = None specific : str | None = None tax_document : int | None = None type : str | None = None variable : str | None = None vat_transfer : int | None = None )
+Bases: object
+This dataclass represents an invoice in the SuperFaktura API.
+
+
+add_rounding_item : int | None = 0
+
+
+
+
+already_paid : int | None = None
+
+
+
+
+as_dict ( ) → dict
+Returns a dictionary representation of the InvoiceModel.
+
+
+
+
+bank_accounts : List [ dict ] | None = None
+
+
+
+
+
+
+
+
+constant : str | None = None
+
+
+
+
+created : Date | None = None
+
+
+
+
+delivery : Date | None = None
+
+
+
+
+delivery_type : str | None = None
+
+
+
+
+deposit : float | None = None
+
+
+
+
+discount : float | None = 0
+
+
+
+
+discount_total : float | None = None
+
+
+
+
+due : Date | None = None
+
+
+
+
+estimate_id : int | None = None
+
+
+
+
+
+
+
+
+
+
+
+
+invoice_currency : str | None = None
+
+
+
+
+invoice_no_formatted : str | None = None
+
+
+
+
+issued_by : str | None = None
+
+
+
+
+issued_by_email : str | None = None
+
+
+
+
+issued_by_phone : str | None = None
+
+
+
+
+issued_by_web : str | None = None
+
+
+
+
+logo_id : int | None = None
+
+
+
+
+mark_sent : int | None = None
+
+
+
+
+mark_sent_message : str | None = None
+
+
+
+
+mark_sent_subject : str | None = None
+
+
+
+
+name : str | None = None
+
+
+
+
+order_no : str | None = None
+
+
+
+
+parent_id : int | None = None
+
+
+
+
+paydate : Date | None = None
+
+
+
+
+payment_type : str | None = None
+
+
+
+
+proforma_id : str | None = None
+
+
+
+
+rounding : str | None = None
+
+
+
+
+sequence_id : int | None = None
+
+
+
+
+specific : str | None = None
+
+
+
+
+tax_document : int | None = None
+
+
+
+
+to_dict ( ) → dict
+Converts the Record object to a dictionary for JSON serialization.
+
+
+
+
+type : str | None = None
+
+
+
+
+variable : str | None = None
+
+
+
+
+vat_transfer : int | None = None
+
+
+
+
+
+
+class superfaktura.invoice. InvoiceType
+Bases: object
+”
+Invoice Type Enumeration.
+This enumeration represents the different types of invoices that can be created.
+
+Usage: invoice_type = InvoiceType.PROFORMA
+
+
+
+INVOICE = 'regular'
+
+
+
+
+PROFORMA = 'proforma'
+
+
+
+
+
+
+SuperFaktura API
+SuperFaktura API Client.
+This module provides classes and functions for working with the SuperFaktura API.
+It allows for reading, creating, updating, and deleting data in SuperFaktura.
+
+Classes:
+SuperFakturaAPI: The base class for working with the SuperFaktura API.
SuperFakturaAPIException: An exception for errors when working with the SuperFaktura API.
SuperFakturaAPIMissingCredentialsException: An exception for missing login credentials.
+Functions:
+
+Usage: import superfaktura.superfaktura_api
+# Create an instance of SuperFakturaAPI
+api = superfaktura.superfaktura_api.SuperFakturaAPI()
+# Retrieve data from the SuperFaktura API
+data = api.get(‘endpoint’)
+# Create or update data in the SuperFaktura API
+api.post(‘endpoint’, data)
+
+
+
+class superfaktura.superfaktura_api. SuperFakturaAPI
+Bases: object
+Base class for working with the SuperFaktura API.
+
+
+get ( endpoint : str timeout : int = 5 ) → Dict
+Retrieves data from the SuperFaktura API.
+Retrieves data from the specified endpoint in the SuperFaktura API.
+
+Parameters:
+
+endpoint (str ) – The API endpoint to retrieve data from (e.g. ‘invoices’, ‘clients’,
+etc.).
timeout (int , optional ) – The timeout for the API request in seconds. Defaults to 5.
+Returns:
+The retrieved data in JSON format.
+Return type:
+Dict
+Raises:
+SuperFakturaAPIException
+
+Examples
+>>> api = SuperFakturaAPI ()
+>>> data = api . get ( 'invoices' )
+>>> print ( data )
+
+
Notes
+The available endpoints can be found in the SuperFaktura API documentation.
+
+
+
+
+post ( endpoint : str data : str timeout : int = 5 ) → Dict
+Creates or updates data in the SuperFaktura API.
+Creates or updates data in the specified endpoint in the SuperFaktura API.
+
+Parameters:
+
+endpoint (str ) – The API endpoint to create or update data in (e.g. ‘invoices’,
+‘clients’, etc.).
data (str ) – The data to be created or updated in JSON format.
timeout (int , optional ) – The timeout for the API request in seconds. Defaults
+to 5.
+Returns:
+The created or updated data in JSON format.
+Return type:
+Dict
+Raises:
+SuperFakturaAPIException
+
+Examples
+>>> api = SuperFakturaAPI ()
+>>> data = '{"name": "Example Invoice", "amount": 100.0}'
+>>> response = api . post ( 'invoices' , data )
+>>> print ( response )
+
+
Notes
+The available endpoints can be found in the SuperFaktura API documentation.
+The data should be a valid JSON string.
+
+
+
+
+
+
+exception superfaktura.superfaktura_api. SuperFakturaAPIException
+Bases: Exception
+Exception for errors when working with the SuperFaktura API.
+
+
+
+
+exception superfaktura.superfaktura_api. SuperFakturaAPIMissingCredentialsException
+Bases: Exception
+Exception for missing login credentials.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/superfaktura.invoice.html b/superfaktura.invoice.html
new file mode 100644
index 0000000..e0cd2f4
--- /dev/null
+++ b/superfaktura.invoice.html
@@ -0,0 +1,550 @@
+
+
+
+
+
+
+
+
+
superfaktura.invoice module — SuperFaktura API client documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SuperFaktura API client
+
+
+
+
+
+
+
+
+
+superfaktura.invoice module
+Invoice Module.
+This module provides classes and functions for working with invoices in the SuperFaktura API.
+It allows for retrieving, creating, updating, and deleting invoices.
+
+Classes:
+InvoiceModel: Dataclass representing an invoice.
InvoiceItem: Dataclass representing an invoice item.
Invoice: Class for interacting with invoices.
+Exceptions:
+
+Functions:
+
+Usage: import superfaktura.invoice
+# Create an instance of Invoice
+invoice = superfaktura.invoice.Invoice()
+# Create an invoice
+invoice.add(
+
+
+invoice=superfaktura.invoice.InvoiceModel( type=superfaktura.invoice.InvoiceType.PROFORMA,
+name=”Invoice 3”,
+due=superfaktura.invoice.Date(“2025-02-01”),
+invoice_currency=superfaktura.invoice.Currencies.CZK,
+header_comment=”We invoice you for services”,
+bank_accounts=[bank.default().as_dict()],
+
+
),
+items=[
+
+
+superfaktura.invoice.InvoiceItem(name=”Services”, unit_price=100, quantity=1, unit=”ks”, tax=21),
+superfaktura.invoice.InvoiceItem(name=”SIM card”, unit_price=50, quantity=1, tax=21, unit=”ks”),
+superfaktura.invoice.InvoiceItem( name=”SIM card 2”, unit_price=75, quantity=1, tax=21, unit=”ks”
+
+
),
+
+
],
+contact=superfaktura.client_contacts.ClientContactModel(
+
+name=”Richard Kubíček”,
+email=”kubicekr@ eledio. com ”,
+phone=”+420 123 456 789”,
+address=”Jaroslava Foglara 861/1”,
+ico=”123”,
+update=True,
+country_id=57,
+
+
),
+
+)
+
+
+
+class superfaktura.invoice. Invoice
+Bases: SuperFakturaAPI
+Invoice Class.
+This class provides methods for interacting with invoices in the SuperFaktura API.
+It allows for retrieving, creating, updating, and deleting invoices.
+
+
+- add
+Creates a new invoice.
+
+
+
+
+- get
+Retrieves an invoice by ID.
+
+
+
+
+- list
+Retrieves a list of invoices.
+
+
+
+
+- update
+Updates an existing invoice.
+
+
+
+Usage: invoice = Invoice()
+invoice.add(
+
+
+invoice=InvoiceModel( type=InvoiceType.PROFORMA,
+name=”Invoice 3”,
+due=Date(“2025-02-01”),
+invoice_currency=Currencies.CZK,
+header_comment=”We invoice you for services”,
+bank_accounts=[bank.default().as_dict()],
+
+
),
+items=[
+
+InvoiceItem(name=”Services”, unit_price=100, quantity=1, unit=”ks”, tax=21),
+InvoiceItem(name=”SIM card”, unit_price=50, quantity=1, tax=21, unit=”ks”),
+InvoiceItem(
+
+name=”SIM card 2”, unit_price=75, quantity=1, tax=21, unit=”ks”
+
+
),
+
+
],
+contact=ClientContactModel(
+
+name=”Richard Kubíček”,
+email=”kubicekr@ eledio. com ”,
+phone=”+420 123 456 789”,
+address=”Jaroslava Foglara 861/1”,
+ico=”123”,
+update=True,
+country_id=57,
+
+
),
+
+)
+
+
+
+add ( invoice_model : InvoiceModel items : List [ InvoiceItem ] contact : ClientContactModel )
+Creates a new invoice.
+
+
+
+
+
+
+class superfaktura.invoice. InvoiceItem ( name : str unit_price : float description : str | None = None discount : float | None = 0 discount_description : str | None = None load_data_from_stock : int = 0 quantity : float | None = 1 sku : str | None = None stock_item_id : int | None = None tax : float | None = None unit : str | None = None use_document_currency : int | None = 0 )
+Bases: object
+This dataclass represents an invoice item in the SuperFaktura API.
+
+
+as_dict ( ) → dict
+Returns a dictionary representation of the InvoiceItem.
+
+
+
+
+description : str | None = None
+
+
+
+
+discount : float | None = 0
+
+
+
+
+discount_description : str | None = None
+
+
+
+
+load_data_from_stock : int = 0
+
+
+
+
+name : str
+
+
+
+
+quantity : float | None = 1
+
+
+
+
+sku : str | None = None
+
+
+
+
+stock_item_id : int | None = None
+
+
+
+
+tax : float | None = None
+
+
+
+
+unit : str | None = None
+
+
+
+
+unit_price : float
+
+
+
+
+use_document_currency : int | None = 0
+
+
+
+
+
+
+class superfaktura.invoice. InvoiceModel ( add_rounding_item : int | None = 0 already_paid : int | None = None bank_accounts : List [ dict ] | None = None comment : str | None = None constant : str | None = None created : Date | None = None delivery : Date | None = None delivery_type : str | None = None deposit : float | None = None discount : float | None = 0 discount_total : float | None = None due : Date | None = None estimate_id : int | None = None header_comment : str | None = None internal_comment : str | None = None invoice_currency : str | None = None invoice_no_formatted : str | None = None issued_by : str | None = None issued_by_email : str | None = None issued_by_phone : str | None = None issued_by_web : str | None = None logo_id : int | None = None mark_sent : int | None = None mark_sent_message : str | None = None mark_sent_subject : str | None = None name : str | None = None order_no : str | None = None parent_id : int | None = None paydate : Date | None = None payment_type : str | None = None proforma_id : str | None = None rounding : str | None = None sequence_id : int | None = None specific : str | None = None tax_document : int | None = None type : str | None = None variable : str | None = None vat_transfer : int | None = None )
+Bases: object
+This dataclass represents an invoice in the SuperFaktura API.
+
+
+add_rounding_item : int | None = 0
+
+
+
+
+already_paid : int | None = None
+
+
+
+
+as_dict ( ) → dict
+Returns a dictionary representation of the InvoiceModel.
+
+
+
+
+bank_accounts : List [ dict ] | None = None
+
+
+
+
+
+
+
+
+constant : str | None = None
+
+
+
+
+created : Date | None = None
+
+
+
+
+delivery : Date | None = None
+
+
+
+
+delivery_type : str | None = None
+
+
+
+
+deposit : float | None = None
+
+
+
+
+discount : float | None = 0
+
+
+
+
+discount_total : float | None = None
+
+
+
+
+due : Date | None = None
+
+
+
+
+estimate_id : int | None = None
+
+
+
+
+
+
+
+
+
+
+
+
+invoice_currency : str | None = None
+
+
+
+
+invoice_no_formatted : str | None = None
+
+
+
+
+issued_by : str | None = None
+
+
+
+
+issued_by_email : str | None = None
+
+
+
+
+issued_by_phone : str | None = None
+
+
+
+
+issued_by_web : str | None = None
+
+
+
+
+logo_id : int | None = None
+
+
+
+
+mark_sent : int | None = None
+
+
+
+
+mark_sent_message : str | None = None
+
+
+
+
+mark_sent_subject : str | None = None
+
+
+
+
+name : str | None = None
+
+
+
+
+order_no : str | None = None
+
+
+
+
+parent_id : int | None = None
+
+
+
+
+paydate : Date | None = None
+
+
+
+
+payment_type : str | None = None
+
+
+
+
+proforma_id : str | None = None
+
+
+
+
+rounding : str | None = None
+
+
+
+
+sequence_id : int | None = None
+
+
+
+
+specific : str | None = None
+
+
+
+
+tax_document : int | None = None
+
+
+
+
+to_dict ( ) → dict
+Converts the Record object to a dictionary for JSON serialization.
+
+
+
+
+type : str | None = None
+
+
+
+
+variable : str | None = None
+
+
+
+
+vat_transfer : int | None = None
+
+
+
+
+
+
+class superfaktura.invoice. InvoiceType
+Bases: object
+”
+Invoice Type Enumeration.
+This enumeration represents the different types of invoices that can be created.
+
+Usage: invoice_type = InvoiceType.PROFORMA
+
+
+
+INVOICE = 'regular'
+
+
+
+
+PROFORMA = 'proforma'
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/superfaktura.superfaktura_api.html b/superfaktura.superfaktura_api.html
new file mode 100644
index 0000000..bd338a7
--- /dev/null
+++ b/superfaktura.superfaktura_api.html
@@ -0,0 +1,219 @@
+
+
+
+
+
+
+
+
+
superfaktura.superfaktura_api module — SuperFaktura API client documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SuperFaktura API client
+
+
+
+
+
+
+
+
+
+superfaktura.superfaktura_api module
+SuperFaktura API Client.
+This module provides classes and functions for working with the SuperFaktura API.
+It allows for reading, creating, updating, and deleting data in SuperFaktura.
+
+Classes:
+SuperFakturaAPI: The base class for working with the SuperFaktura API.
SuperFakturaAPIException: An exception for errors when working with the SuperFaktura API.
SuperFakturaAPIMissingCredentialsException: An exception for missing login credentials.
+Functions:
+
+Usage: import superfaktura.superfaktura_api
+# Create an instance of SuperFakturaAPI
+api = superfaktura.superfaktura_api.SuperFakturaAPI()
+# Retrieve data from the SuperFaktura API
+data = api.get(‘endpoint’)
+# Create or update data in the SuperFaktura API
+api.post(‘endpoint’, data)
+
+
+
+class superfaktura.superfaktura_api. SuperFakturaAPI
+Bases: object
+Base class for working with the SuperFaktura API.
+
+
+get ( endpoint : str timeout : int = 5 ) → Dict
+Retrieves data from the SuperFaktura API.
+Retrieves data from the specified endpoint in the SuperFaktura API.
+
+Parameters:
+
+endpoint (str ) – The API endpoint to retrieve data from (e.g. ‘invoices’, ‘clients’,
+etc.).
timeout (int , optional ) – The timeout for the API request in seconds. Defaults to 5.
+Returns:
+The retrieved data in JSON format.
+Return type:
+Dict
+Raises:
+SuperFakturaAPIException
+
+Examples
+>>> api = SuperFakturaAPI ()
+>>> data = api . get ( 'invoices' )
+>>> print ( data )
+
+
Notes
+The available endpoints can be found in the SuperFaktura API documentation.
+
+
+
+
+post ( endpoint : str data : str timeout : int = 5 ) → Dict
+Creates or updates data in the SuperFaktura API.
+Creates or updates data in the specified endpoint in the SuperFaktura API.
+
+Parameters:
+
+endpoint (str ) – The API endpoint to create or update data in (e.g. ‘invoices’,
+‘clients’, etc.).
data (str ) – The data to be created or updated in JSON format.
timeout (int , optional ) – The timeout for the API request in seconds. Defaults
+to 5.
+Returns:
+The created or updated data in JSON format.
+Return type:
+Dict
+Raises:
+SuperFakturaAPIException
+
+Examples
+>>> api = SuperFakturaAPI ()
+>>> data = '{"name": "Example Invoice", "amount": 100.0}'
+>>> response = api . post ( 'invoices' , data )
+>>> print ( response )
+
+
Notes
+The available endpoints can be found in the SuperFaktura API documentation.
+The data should be a valid JSON string.
+
+
+
+
+
+
+exception superfaktura.superfaktura_api. SuperFakturaAPIException
+Bases: Exception
+Exception for errors when working with the SuperFaktura API.
+
+
+
+
+exception superfaktura.superfaktura_api. SuperFakturaAPIMissingCredentialsException
+Bases: Exception
+Exception for missing login credentials.
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/superfaktura.utils.country.html b/superfaktura.utils.country.html
new file mode 100644
index 0000000..884aad7
--- /dev/null
+++ b/superfaktura.utils.country.html
@@ -0,0 +1,139 @@
+
+
+
+
+
+
+
+
+
superfaktura.utils.country module — SuperFaktura API client documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SuperFaktura API client
+
+
+
+
+
+
+
+
+
+superfaktura.utils.country module
+Country Module.
+This module provides utilities for working with countries in the SuperFaktura API.
+
+Functions:
+
+Usage: from superfaktura.utils.country import country_list
+countries = country_list()
+print(countries)
+
+
+
+superfaktura.utils.country. country_list ( )
+Retrieves a list of countries.
+This function returns a list of countries that can be used in the SuperFaktura API.
+
+Returns:
+A list of countries.
+Return type:
+
+
+
+
+Usage: countries = country_list()
+print(countries)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/superfaktura.utils.data_types.html b/superfaktura.utils.data_types.html
new file mode 100644
index 0000000..92e6a61
--- /dev/null
+++ b/superfaktura.utils.data_types.html
@@ -0,0 +1,213 @@
+
+
+
+
+
+
+
+
+
superfaktura.utils.data_types module — SuperFaktura API client documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SuperFaktura API client
+
+
+
+
+
+
+
+
+
+superfaktura.utils.data_types module
+Data Types Module.
+This module provides data types and utilities for working with dates and other data types
+in the SuperFaktura API.
+
+Classes:
+
+Functions:
+
+Usage: from superfaktura.utils.data_types import Date, DateTime
+date = Date(“2022-01-01”)
+datetime = DateTime(“2022-01-01 12:00:00”)
+
+
+
+class superfaktura.utils.data_types. Date ( date_str : str | None = None )
+Bases: object
+Date Class.
+This class represents a date in the format YYYY-MM-DD.
+
+
+- date
+The date in the format YYYY-MM-DD.
+
+Type:
+str
+
+
+
+
+
+- __str__
+Returns the date as a string.
+
+
+
+Usage: date = Date(“2022-01-01”)
+print(date) # Output: 2022-01-01
+
+
+
+is_set ( ) → bool
+Returns True if the date is set, otherwise False.
+
+
+
+
+to_dict ( ) → str | None
+Converts the Date object to a serializable format.
+:return: The date as a string in YYYY-MM-DD format, or None if not set.
+
+
+
+
+to_json ( ) → str | None
+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.
+
+
+
+
+
+
+class superfaktura.utils.data_types. DateEncoder ( * skipkeys = False ensure_ascii = True check_circular = True allow_nan = True sort_keys = False indent = None separators = None default = None )
+Bases: JSONEncoder
+Date Encoder Class.
+This class is a custom JSON encoder that converts Date objects to strings.
+
+
+- default
+Encodes a Date object as a string.
+
+
+
+Usage: encoder = DateEncoder()
+date = Date(“2022-01-01”)
+json_string = json.dumps(date, cls=encoder)
+
+
+
+default ( o )
+Implement this method in a subclass such that it returns
+a serializable object for o TypeError
+For example, to support arbitrary iterators, you could
+implement default like this:
+def default ( self , o ):
+ try :
+ iterable = iter ( o )
+ except TypeError :
+ pass
+ else :
+ return list ( iterable )
+ # Let the base class default method raise the TypeError
+ return JSONEncoder . default ( self , o )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
diff --git a/superfaktura.utils.html b/superfaktura.utils.html
new file mode 100644
index 0000000..7e6e83a
--- /dev/null
+++ b/superfaktura.utils.html
@@ -0,0 +1,260 @@
+
+
+
+
+
+
+
+
+
superfaktura.utils package — SuperFaktura API client documentation
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ SuperFaktura API client
+
+
+
+
+
+
+
+
+
+superfaktura.utils package
+
+
+superfaktura.utils.country module
+Country Module.
+This module provides utilities for working with countries in the SuperFaktura API.
+
+Functions:
+
+Usage: from superfaktura.utils.country import country_list
+countries = country_list()
+print(countries)
+
+
+
+superfaktura.utils.country. country_list ( )
+Retrieves a list of countries.
+This function returns a list of countries that can be used in the SuperFaktura API.
+
+Returns:
+A list of countries.
+Return type:
+
+
+
+
+Usage: countries = country_list()
+print(countries)
+
+
+
+
+
+superfaktura.utils.data_types module
+Data Types Module.
+This module provides data types and utilities for working with dates and other data types
+in the SuperFaktura API.
+
+Classes:
+
+Functions:
+
+Usage: from superfaktura.utils.data_types import Date, DateTime
+date = Date(“2022-01-01”)
+datetime = DateTime(“2022-01-01 12:00:00”)
+
+
+
+class superfaktura.utils.data_types. Date ( date_str : str | None = None )
+Bases: object
+Date Class.
+This class represents a date in the format YYYY-MM-DD.
+
+
+- date
+The date in the format YYYY-MM-DD.
+
+Type:
+str
+
+
+
+
+
+- __str__
+Returns the date as a string.
+
+
+
+Usage: date = Date(“2022-01-01”)
+print(date) # Output: 2022-01-01
+
+
+
+is_set ( ) → bool
+Returns True if the date is set, otherwise False.
+
+
+
+
+to_dict ( ) → str | None
+Converts the Date object to a serializable format.
+:return: The date as a string in YYYY-MM-DD format, or None if not set.
+
+
+
+
+to_json ( ) → str | None
+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.
+
+
+
+
+
+
+class superfaktura.utils.data_types. DateEncoder ( * skipkeys = False ensure_ascii = True check_circular = True allow_nan = True sort_keys = False indent = None separators = None default = None )
+Bases: JSONEncoder
+Date Encoder Class.
+This class is a custom JSON encoder that converts Date objects to strings.
+
+
+- default
+Encodes a Date object as a string.
+
+
+
+Usage: encoder = DateEncoder()
+date = Date(“2022-01-01”)
+json_string = json.dumps(date, cls=encoder)
+
+
+
+default ( o )
+Implement this method in a subclass such that it returns
+a serializable object for o TypeError
+For example, to support arbitrary iterators, you could
+implement default like this:
+def default ( self , o ):
+ try :
+ iterable = iter ( o )
+ except TypeError :
+ pass
+ else :
+ return list ( iterable )
+ # Let the base class default method raise the TypeError
+ return JSONEncoder . default ( self , o )
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
\ No newline at end of file
