Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
p-zielinski committed Sep 6, 2023
1 parent 888db98 commit 4d1aa28
Show file tree
Hide file tree
Showing 14 changed files with 6,564 additions and 4,879 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.js

Large diffs are not rendered by default.

8 changes: 4 additions & 4 deletions docs/classes/Validations.html
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ <h2>Methods</h2>
<a name="validate" class="tsd-anchor"></a>
<h3>validate</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">validate<span class="tsd-signature-symbol">(</span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/PromotionsValidateParams.html" class="tsd-signature-type" data-tsd-kind="Interface">PromotionsValidateParams</a>, context<span class="tsd-signature-symbol">?: </span><a href="../interfaces/ValidationsValidateVoucherParams.html" class="tsd-signature-type" data-tsd-kind="Interface">ValidationsValidateVoucherParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/PromotionsValidateResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">PromotionsValidateResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ValidationsValidateVoucherResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ValidationsValidateVoucherResponse</a><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">validate<span class="tsd-signature-symbol">(</span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><a href="../interfaces/PromotionsValidateParams.html" class="tsd-signature-type" data-tsd-kind="Interface">PromotionsValidateParams</a>, context<span class="tsd-signature-symbol">?: </span><a href="../interfaces/ValidationsValidateVoucherParams.html" class="tsd-signature-type" data-tsd-kind="Interface">ValidationsValidateVoucherParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/PromotionsValidateResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">PromotionsValidateResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules.html#ValidationsValidateVoucherResponse" class="tsd-signature-type" data-tsd-kind="Type alias">ValidationsValidateVoucherResponse</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
Expand All @@ -141,7 +141,7 @@ <h5>code: <span class="tsd-signature-type">string</span><span class="tsd-signatu
<h5>context: <a href="../interfaces/ValidationsValidateVoucherParams.html" class="tsd-signature-type" data-tsd-kind="Interface">ValidationsValidateVoucherParams</a><span class="tsd-signature-symbol"> = {}</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/PromotionsValidateResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">PromotionsValidateResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ValidationsValidateVoucherResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ValidationsValidateVoucherResponse</a><span class="tsd-signature-symbol">&gt;</span></h4>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/PromotionsValidateResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">PromotionsValidateResponse</a><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules.html#ValidationsValidateVoucherResponse" class="tsd-signature-type" data-tsd-kind="Type alias">ValidationsValidateVoucherResponse</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
Expand Down Expand Up @@ -176,7 +176,7 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</
<a name="validateVoucher" class="tsd-anchor"></a>
<h3>validate<wbr>Voucher</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">validate<wbr>Voucher<span class="tsd-signature-symbol">(</span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">?: </span><a href="../interfaces/ValidationsValidateVoucherParams.html" class="tsd-signature-type" data-tsd-kind="Interface">ValidationsValidateVoucherParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ValidationsValidateVoucherResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ValidationsValidateVoucherResponse</a><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">validate<wbr>Voucher<span class="tsd-signature-symbol">(</span>code<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">?: </span><a href="../interfaces/ValidationsValidateVoucherParams.html" class="tsd-signature-type" data-tsd-kind="Interface">ValidationsValidateVoucherParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules.html#ValidationsValidateVoucherResponse" class="tsd-signature-type" data-tsd-kind="Type alias">ValidationsValidateVoucherResponse</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
Expand All @@ -198,7 +198,7 @@ <h5>code: <span class="tsd-signature-type">string</span></h5>
<h5>params: <a href="../interfaces/ValidationsValidateVoucherParams.html" class="tsd-signature-type" data-tsd-kind="Interface">ValidationsValidateVoucherParams</a><span class="tsd-signature-symbol"> = {}</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/ValidationsValidateVoucherResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">ValidationsValidateVoucherResponse</a><span class="tsd-signature-symbol">&gt;</span></h4>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../modules.html#ValidationsValidateVoucherResponse" class="tsd-signature-type" data-tsd-kind="Type alias">ValidationsValidateVoucherResponse</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
Expand Down
6 changes: 3 additions & 3 deletions docs/classes/VoucherifyError.html
Original file line number Diff line number Diff line change
Expand Up @@ -131,7 +131,7 @@ <h2>Constructors</h2>
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-overwrite">
<li class="tsd-signature tsd-kind-icon">new <wbr>Voucherify<wbr>Error<span class="tsd-signature-symbol">(</span>statusCode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, body<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span>, axiosError<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="VoucherifyError.html" class="tsd-signature-type" data-tsd-kind="Class">VoucherifyError</a></li>
<li class="tsd-signature tsd-kind-icon">new <wbr>Voucherify<wbr>Error<span class="tsd-signature-symbol">(</span>statusCode<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, body<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">unknown</span>, axiosError<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="VoucherifyError.html" class="tsd-signature-type" data-tsd-kind="Class">VoucherifyError</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
Expand All @@ -147,7 +147,7 @@ <h5>statusCode: <span class="tsd-signature-type">number</span></h5>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> body: <span class="tsd-signature-type">unknown</span></h5>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> axiosError: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> axiosError: <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="VoucherifyError.html" class="tsd-signature-type" data-tsd-kind="Class">VoucherifyError</a></h4>
Expand All @@ -160,7 +160,7 @@ <h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
<a name="cause" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> cause</h3>
<div class="tsd-signature tsd-kind-icon">cause<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></div>
<div class="tsd-signature tsd-kind-icon">cause<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosError</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">unknown</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">&gt;</span></div>
<aside class="tsd-sources">
</aside>
</section>
Expand Down
Loading

0 comments on commit 4d1aa28

Please sign in to comment.