Skip to content

Commit dde0c6d

Browse files
KaiSchwarz-cnicKaiSchwarz-cnic
committed
docs(documentation): updated
1 parent 7adadab commit dde0c6d

16 files changed

+4692
-2
lines changed

‎docs/centralnicreseller/apiconnector/apiclient.html‎

Lines changed: 1170 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/centralnicreseller/apiconnector/column.html‎

Lines changed: 203 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,203 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="utf-8">
5+
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
6+
<meta name="generator" content="pdoc3 0.11.5">
7+
<title>centralnicreseller.apiconnector.column API documentation</title>
8+
<meta name="description" content="centralnicreseller.apiconnector.column
9+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
10+
This module covers all necessary functionality to
11+
work with a column and wrapped …">
12+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
13+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
14+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
15+
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source > summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible;min-width:max-content}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin:1em 0}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
16+
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
17+
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
18+
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
19+
<script>window.addEventListener('DOMContentLoaded', () => {
20+
hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
21+
hljs.highlightAll();
22+
/* Collapse source docstrings */
23+
setTimeout(() => {
24+
[...document.querySelectorAll('.hljs.language-python > .hljs-string')]
25+
.filter(el => el.innerHTML.length > 200 && ['"""', "'''"].includes(el.innerHTML.substring(0, 3)))
26+
.forEach(el => {
27+
let d = document.createElement('details');
28+
d.classList.add('hljs-string');
29+
d.innerHTML = '<summary>"""</summary>' + el.innerHTML.substring(3);
30+
el.replaceWith(d);
31+
});
32+
}, 100);
33+
})</script>
34+
</head>
35+
<body>
36+
<main>
37+
<article id="content">
38+
<header>
39+
<h1 class="title">Module <code>centralnicreseller.apiconnector.column</code></h1>
40+
</header>
41+
<section id="section-intro">
42+
<p>centralnicreseller.apiconnector.column
43+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
44+
This module covers all necessary functionality to
45+
work with a column and wrapped data.
46+
:copyright: © 2024 Team Internet Group PLC.
47+
:license: MIT, see LICENSE for more details.</p>
48+
</section>
49+
<section>
50+
</section>
51+
<section>
52+
</section>
53+
<section>
54+
</section>
55+
<section>
56+
<h2 class="section-title" id="header-classes">Classes</h2>
57+
<dl>
58+
<dt id="centralnicreseller.apiconnector.column.Column"><code class="flex name class">
59+
<span>class <span class="ident">Column</span></span>
60+
<span>(</span><span>key, data)</span>
61+
</code></dt>
62+
<dd>
63+
<details class="source">
64+
<summary>
65+
<span>Expand source code</span>
66+
</summary>
67+
<pre><code class="python">class Column(object):
68+
&#34;&#34;&#34;
69+
The Column class covers all you need to access column data of a Backend API response.
70+
&#34;&#34;&#34;
71+
72+
def __init__(self, key, data):
73+
self.__key = key
74+
self.__data = data
75+
self.length = len(data)
76+
77+
def getKey(self):
78+
&#34;&#34;&#34;
79+
Get column name
80+
&#34;&#34;&#34;
81+
return self.__key
82+
83+
def getData(self):
84+
&#34;&#34;&#34;
85+
Get column data
86+
&#34;&#34;&#34;
87+
return self.__data
88+
89+
def getDataByIndex(self, idx):
90+
&#34;&#34;&#34;
91+
Get column data at given index
92+
&#34;&#34;&#34;
93+
return self.__data[idx] if self.hasDataIndex(idx) else None
94+
95+
def hasDataIndex(self, idx):
96+
&#34;&#34;&#34;
97+
Check if column has a given data index
98+
&#34;&#34;&#34;
99+
return True if ((idx &gt;= 0) and (idx &lt; self.length)) else False</code></pre>
100+
</details>
101+
<div class="desc"><p>The Column class covers all you need to access column data of a Backend API response.</p></div>
102+
<h3>Methods</h3>
103+
<dl>
104+
<dt id="centralnicreseller.apiconnector.column.Column.getData"><code class="name flex">
105+
<span>def <span class="ident">getData</span></span>(<span>self)</span>
106+
</code></dt>
107+
<dd>
108+
<details class="source">
109+
<summary>
110+
<span>Expand source code</span>
111+
</summary>
112+
<pre><code class="python">def getData(self):
113+
&#34;&#34;&#34;
114+
Get column data
115+
&#34;&#34;&#34;
116+
return self.__data</code></pre>
117+
</details>
118+
<div class="desc"><p>Get column data</p></div>
119+
</dd>
120+
<dt id="centralnicreseller.apiconnector.column.Column.getDataByIndex"><code class="name flex">
121+
<span>def <span class="ident">getDataByIndex</span></span>(<span>self, idx)</span>
122+
</code></dt>
123+
<dd>
124+
<details class="source">
125+
<summary>
126+
<span>Expand source code</span>
127+
</summary>
128+
<pre><code class="python">def getDataByIndex(self, idx):
129+
&#34;&#34;&#34;
130+
Get column data at given index
131+
&#34;&#34;&#34;
132+
return self.__data[idx] if self.hasDataIndex(idx) else None</code></pre>
133+
</details>
134+
<div class="desc"><p>Get column data at given index</p></div>
135+
</dd>
136+
<dt id="centralnicreseller.apiconnector.column.Column.getKey"><code class="name flex">
137+
<span>def <span class="ident">getKey</span></span>(<span>self)</span>
138+
</code></dt>
139+
<dd>
140+
<details class="source">
141+
<summary>
142+
<span>Expand source code</span>
143+
</summary>
144+
<pre><code class="python">def getKey(self):
145+
&#34;&#34;&#34;
146+
Get column name
147+
&#34;&#34;&#34;
148+
return self.__key</code></pre>
149+
</details>
150+
<div class="desc"><p>Get column name</p></div>
151+
</dd>
152+
<dt id="centralnicreseller.apiconnector.column.Column.hasDataIndex"><code class="name flex">
153+
<span>def <span class="ident">hasDataIndex</span></span>(<span>self, idx)</span>
154+
</code></dt>
155+
<dd>
156+
<details class="source">
157+
<summary>
158+
<span>Expand source code</span>
159+
</summary>
160+
<pre><code class="python">def hasDataIndex(self, idx):
161+
&#34;&#34;&#34;
162+
Check if column has a given data index
163+
&#34;&#34;&#34;
164+
return True if ((idx &gt;= 0) and (idx &lt; self.length)) else False</code></pre>
165+
</details>
166+
<div class="desc"><p>Check if column has a given data index</p></div>
167+
</dd>
168+
</dl>
169+
</dd>
170+
</dl>
171+
</section>
172+
</article>
173+
<nav id="sidebar">
174+
<div class="toc">
175+
<ul></ul>
176+
</div>
177+
<ul id="index">
178+
<li><h3>Super-module</h3>
179+
<ul>
180+
<li><code><a title="centralnicreseller.apiconnector" href="index.html">centralnicreseller.apiconnector</a></code></li>
181+
</ul>
182+
</li>
183+
<li><h3><a href="#header-classes">Classes</a></h3>
184+
<ul>
185+
<li>
186+
<h4><code><a title="centralnicreseller.apiconnector.column.Column" href="#centralnicreseller.apiconnector.column.Column">Column</a></code></h4>
187+
<ul class="">
188+
<li><code><a title="centralnicreseller.apiconnector.column.Column.getData" href="#centralnicreseller.apiconnector.column.Column.getData">getData</a></code></li>
189+
<li><code><a title="centralnicreseller.apiconnector.column.Column.getDataByIndex" href="#centralnicreseller.apiconnector.column.Column.getDataByIndex">getDataByIndex</a></code></li>
190+
<li><code><a title="centralnicreseller.apiconnector.column.Column.getKey" href="#centralnicreseller.apiconnector.column.Column.getKey">getKey</a></code></li>
191+
<li><code><a title="centralnicreseller.apiconnector.column.Column.hasDataIndex" href="#centralnicreseller.apiconnector.column.Column.hasDataIndex">hasDataIndex</a></code></li>
192+
</ul>
193+
</li>
194+
</ul>
195+
</li>
196+
</ul>
197+
</nav>
198+
</main>
199+
<footer id="footer">
200+
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.5</a>.</p>
201+
</footer>
202+
</body>
203+
</html>

0 commit comments

Comments
 (0)