Skip to content

Commit

Permalink
chore: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
proohit committed Dec 23, 2022
1 parent b2e4134 commit c273ae5
Show file tree
Hide file tree
Showing 25 changed files with 129 additions and 129 deletions.
20 changes: 10 additions & 10 deletions docs/classes/NetcupApi.html
Expand Up @@ -20,7 +20,7 @@ <h4>Hierarchy</h4>
<ul class="tsd-hierarchy">
<li><span class="target">NetcupApi</span></li></ul></section><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/proohit/netcup-node/blob/8b25f82/src/index.ts#L21">index.ts:21</a></li></ul></aside>
<li>Defined in <a href="https://github.com/proohit/netcup-node/blob/b2e4134/src/index.ts#L21">index.ts:21</a></li></ul></aside>
<section class="tsd-panel-group tsd-index-group">
<section class="tsd-panel tsd-index-panel">
<details class="tsd-index-content tsd-index-accordion" open><summary class="tsd-accordion-summary tsd-index-summary">
Expand Down Expand Up @@ -59,12 +59,12 @@ <h2>Properties</h2>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code> <span>auth<wbr/>Data</span><a href="#authData" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">auth<wbr/>Data<span class="tsd-signature-symbol">:</span> <a href="../interfaces/NetcupAuth.html" class="tsd-signature-type" data-tsd-kind="Interface">NetcupAuth</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/proohit/netcup-node/blob/8b25f82/src/index.ts#L22">index.ts:22</a></li></ul></aside></section>
<li>Defined in <a href="https://github.com/proohit/netcup-node/blob/b2e4134/src/index.ts#L22">index.ts:22</a></li></ul></aside></section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class"><a id="restApi" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagReadonly">Readonly</code> <span>rest<wbr/>Api</span><a href="#restApi" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<div class="tsd-signature">rest<wbr/>Api<span class="tsd-signature-symbol">:</span> <a href="NetcupRestApi.html" class="tsd-signature-type" data-tsd-kind="Class">NetcupRestApi</a><span class="tsd-signature-symbol"> = ...</span></div><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/proohit/netcup-node/blob/8b25f82/src/index.ts#L28">index.ts:28</a></li></ul></aside></section></section>
<li>Defined in <a href="https://github.com/proohit/netcup-node/blob/b2e4134/src/index.ts#L28">index.ts:28</a></li></ul></aside></section></section>
<section class="tsd-panel-group tsd-member-group">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private"><a id="checkAndRefreshAuth" class="tsd-anchor"></a>
Expand All @@ -74,15 +74,15 @@ <h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagPrivate">Private</code>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/proohit/netcup-node/blob/8b25f82/src/index.ts#L30">index.ts:30</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/proohit/netcup-node/blob/b2e4134/src/index.ts#L30">index.ts:30</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="getAuthData" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>get<wbr/>Auth<wbr/>Data</span><a href="#getAuthData" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-anchor-link" id="getAuthData.getAuthData-1">get<wbr/>Auth<wbr/>Data<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/NetcupAuth.html" class="tsd-signature-type" data-tsd-kind="Interface">NetcupAuth</a><a href="#getAuthData.getAuthData-1" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></li>
<li class="tsd-description">
<h4 class="tsd-returns-title">Returns <a href="../interfaces/NetcupAuth.html" class="tsd-signature-type" data-tsd-kind="Interface">NetcupAuth</a></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/proohit/netcup-node/blob/8b25f82/src/index.ts#L189">index.ts:189</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/proohit/netcup-node/blob/b2e4134/src/index.ts#L189">index.ts:189</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="infoDnsRecords" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>info<wbr/>Dns<wbr/>Records</span><a href="#infoDnsRecords" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
Expand All @@ -100,7 +100,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5>params: <a href="../interfaces/InfoDNSRecordsParam.html" class="tsd-signature-type" data-tsd-kind="Interface">InfoDNSRecordsParam</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/InfoDNSRecordsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">InfoDNSRecordsResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/proohit/netcup-node/blob/8b25f82/src/index.ts#L79">index.ts:79</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/proohit/netcup-node/blob/b2e4134/src/index.ts#L79">index.ts:79</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="infoDnsZone" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>info<wbr/>Dns<wbr/>Zone</span><a href="#infoDnsZone" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
Expand All @@ -118,7 +118,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5>params: <a href="../interfaces/InfoDNSZoneParam.html" class="tsd-signature-type" data-tsd-kind="Interface">InfoDNSZoneParam</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/InfoDNSZoneResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">InfoDNSZoneResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/proohit/netcup-node/blob/8b25f82/src/index.ts#L63">index.ts:63</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/proohit/netcup-node/blob/b2e4134/src/index.ts#L63">index.ts:63</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="init" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>init</span><a href="#init" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
Expand All @@ -133,7 +133,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5>params: <a href="../interfaces/InitParams.html" class="tsd-signature-type" data-tsd-kind="Interface">InitParams</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="NetcupApi.html" class="tsd-signature-type" data-tsd-kind="Class">NetcupApi</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/proohit/netcup-node/blob/8b25f82/src/index.ts#L46">index.ts:46</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/proohit/netcup-node/blob/b2e4134/src/index.ts#L46">index.ts:46</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="updateDnsRecordWithCurrentIp" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>update<wbr/>Dns<wbr/>Record<wbr/>With<wbr/>Current<wbr/>Ip</span><a href="#updateDnsRecordWithCurrentIp" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
Expand All @@ -157,7 +157,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5>params: <a href="../interfaces/UpdateDnsRecordWithCurrentIpParams.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdateDnsRecordWithCurrentIpParams</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/UpdateDNSRecordsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdateDNSRecordsResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/proohit/netcup-node/blob/8b25f82/src/index.ts#L146">index.ts:146</a></li></ul></aside></li></ul></section>
<li>Defined in <a href="https://github.com/proohit/netcup-node/blob/b2e4134/src/index.ts#L146">index.ts:146</a></li></ul></aside></li></ul></section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="updateDnsRecords" class="tsd-anchor"></a>
<h3 class="tsd-anchor-link"><span>update<wbr/>Dns<wbr/>Records</span><a href="#updateDnsRecords" aria-label="Permalink" class="tsd-anchor-icon"><svg class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><use href="#icon-anchor-a"></use><use href="#icon-anchor-b"></use><use href="#icon-anchor-c"></use></svg></a></h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
Expand All @@ -178,7 +178,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5>params: <a href="../interfaces/UpdateDNSRecordsParam.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdateDNSRecordsParam</a></h5></li></ul></div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/UpdateDNSRecordsResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">UpdateDNSRecordsResponse</a><span class="tsd-signature-symbol">&gt;</span></h4><aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/proohit/netcup-node/blob/8b25f82/src/index.ts#L111">index.ts:111</a></li></ul></aside></li></ul></section></section></div>
<li>Defined in <a href="https://github.com/proohit/netcup-node/blob/b2e4134/src/index.ts#L111">index.ts:111</a></li></ul></aside></li></ul></section></section></div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<div class="tsd-navigation settings">
<details class="tsd-index-accordion"><summary class="tsd-accordion-summary">
Expand Down

0 comments on commit c273ae5

Please sign in to comment.