Skip to content

Commit

Permalink
compiled docs with latest types update
Browse files Browse the repository at this point in the history
  • Loading branch information
@ibalosh
ibalosh committed Mar 8, 2021
1 parent 51387cb commit c8b063b
Show file tree
Hide file tree
Showing 127 changed files with 5,892 additions and 842 deletions.
2 changes: 1 addition & 1 deletion docs/assets/js/search.js
View file

Large diffs are not rendered by default.

66 changes: 33 additions & 33 deletions docs/classes/accountclient.html
View file

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions docs/classes/apiinputerror.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2451,7 +2451,7 @@ <h3>constructor</h3>
<aside class="tsd-sources">
<p>Overrides <a href="httperror.html">HttpError</a>.<a href="httperror.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/models/client/Errors.ts#L41">client/models/client/Errors.ts:41</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/models/client/Errors.ts#L41">client/models/client/Errors.ts:41</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -2480,7 +2480,7 @@ <h3>code</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="postmarkerror.html">PostmarkError</a>.<a href="postmarkerror.html#code">code</a></p>
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/models/client/Errors.ts#L5">client/models/client/Errors.ts:5</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/models/client/Errors.ts#L5">client/models/client/Errors.ts:5</a></li>
</ul>
</aside>
</section>
Expand Down Expand Up @@ -2525,7 +2525,7 @@ <h3>status<wbr>Code</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="postmarkerror.html">PostmarkError</a>.<a href="postmarkerror.html#statuscode">statusCode</a></p>
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/models/client/Errors.ts#L6">client/models/client/Errors.ts:6</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/models/client/Errors.ts#L6">client/models/client/Errors.ts:6</a></li>
</ul>
</aside>
</section>
Expand Down
10 changes: 5 additions & 5 deletions docs/classes/attachment.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2441,7 +2441,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/models/message/SupportingTypes.ts#L34">client/models/message/SupportingTypes.ts:34</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/models/message/SupportingTypes.ts#L34">client/models/message/SupportingTypes.ts:34</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -2472,7 +2472,7 @@ <h3>Content</h3>
<div class="tsd-signature tsd-kind-icon">Content<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/models/message/SupportingTypes.ts#L33">client/models/message/SupportingTypes.ts:33</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/models/message/SupportingTypes.ts#L33">client/models/message/SupportingTypes.ts:33</a></li>
</ul>
</aside>
</section>
Expand All @@ -2482,7 +2482,7 @@ <h3>ContentID</h3>
<div class="tsd-signature tsd-kind-icon">ContentID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">null</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/models/message/SupportingTypes.ts#L32">client/models/message/SupportingTypes.ts:32</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/models/message/SupportingTypes.ts#L32">client/models/message/SupportingTypes.ts:32</a></li>
</ul>
</aside>
</section>
Expand All @@ -2492,7 +2492,7 @@ <h3>Content<wbr>Type</h3>
<div class="tsd-signature tsd-kind-icon">Content<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/models/message/SupportingTypes.ts#L34">client/models/message/SupportingTypes.ts:34</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/models/message/SupportingTypes.ts#L34">client/models/message/SupportingTypes.ts:34</a></li>
</ul>
</aside>
</section>
Expand All @@ -2502,7 +2502,7 @@ <h3>Name</h3>
<div class="tsd-signature tsd-kind-icon">Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/models/message/SupportingTypes.ts#L31">client/models/message/SupportingTypes.ts:31</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/models/message/SupportingTypes.ts#L31">client/models/message/SupportingTypes.ts:31</a></li>
</ul>
</aside>
</section>
Expand Down
18 changes: 9 additions & 9 deletions docs/classes/baseclient.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2454,7 +2454,7 @@ <h3>client<wbr>Version</h3>
<div class="tsd-signature tsd-kind-icon">client<wbr>Version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/BaseClient.ts#L26">client/BaseClient.ts:26</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/BaseClient.ts#L26">client/BaseClient.ts:26</a></li>
</ul>
</aside>
</section>
Expand All @@ -2464,7 +2464,7 @@ <h3>http<wbr>Client</h3>
<div class="tsd-signature tsd-kind-icon">http<wbr>Client<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">AxiosInstance</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/BaseClient.ts#L27">client/BaseClient.ts:27</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/BaseClient.ts#L27">client/BaseClient.ts:27</a></li>
</ul>
</aside>
</section>
Expand All @@ -2481,7 +2481,7 @@ <h3>get<wbr>Client<wbr>Options</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/BaseClient.ts#L48">client/BaseClient.ts:48</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/BaseClient.ts#L48">client/BaseClient.ts:48</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <a href="clientoptions.configuration.html" class="tsd-signature-type">Configuration</a></h4>
Expand All @@ -2498,7 +2498,7 @@ <h3>get<wbr>Composed<wbr>Http<wbr>Request<wbr>Headers</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/BaseClient.ts#L55">client/BaseClient.ts:55</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/BaseClient.ts#L55">client/BaseClient.ts:55</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">object</span></h4>
Expand All @@ -2515,7 +2515,7 @@ <h3>set<wbr>Client<wbr>Options</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/BaseClient.ts#L43">client/BaseClient.ts:43</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/BaseClient.ts#L43">client/BaseClient.ts:43</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -2537,7 +2537,7 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> Default<wbr>Options</h3>
<div class="tsd-signature tsd-kind-icon">Default<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">object</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/BaseClient.ts#L20">client/BaseClient.ts:20</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/BaseClient.ts#L20">client/BaseClient.ts:20</a></li>
</ul>
</aside>
<section class="tsd-panel tsd-member tsd-kind-variable tsd-parent-kind-object-literal">
Expand All @@ -2546,7 +2546,7 @@ <h3>request<wbr>Host</h3>
<div class="tsd-signature tsd-kind-icon">request<wbr>Host<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;&quot;api.postmarkapp.com&quot;</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/BaseClient.ts#L22">client/BaseClient.ts:22</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/BaseClient.ts#L22">client/BaseClient.ts:22</a></li>
</ul>
</aside>
</section>
Expand All @@ -2556,7 +2556,7 @@ <h3>timeout</h3>
<div class="tsd-signature tsd-kind-icon">timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> =&nbsp;180</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/BaseClient.ts#L23">client/BaseClient.ts:23</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/BaseClient.ts#L23">client/BaseClient.ts:23</a></li>
</ul>
</aside>
</section>
Expand All @@ -2566,7 +2566,7 @@ <h3>use<wbr>Https</h3>
<div class="tsd-signature tsd-kind-icon">use<wbr>Https<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">true</span><span class="tsd-signature-symbol"> =&nbsp;true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/BaseClient.ts#L21">client/BaseClient.ts:21</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/BaseClient.ts#L21">client/BaseClient.ts:21</a></li>
</ul>
</aside>
</section>
Expand Down
22 changes: 11 additions & 11 deletions docs/classes/bouncefilteringparameters.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2477,7 +2477,7 @@ <h3>constructor</h3>
<aside class="tsd-sources">
<p>Overrides <a href="filteringparameters.html">FilteringParameters</a>.<a href="filteringparameters.html#constructor">constructor</a></p>
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/models/bounces/BounceFilteringParameters.ts#L40">client/models/bounces/BounceFilteringParameters.ts:40</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/models/bounces/BounceFilteringParameters.ts#L40">client/models/bounces/BounceFilteringParameters.ts:40</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -2527,7 +2527,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> count</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="filteringparameters.html">FilteringParameters</a>.<a href="filteringparameters.html#count">count</a></p>
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/models/client/FilteringParameters.ts#L8">client/models/client/FilteringParameters.ts:8</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/models/client/FilteringParameters.ts#L8">client/models/client/FilteringParameters.ts:8</a></li>
</ul>
</aside>
</section>
Expand All @@ -2537,7 +2537,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> email<wbr>Filter</h3>
<div class="tsd-signature tsd-kind-icon">email<wbr>Filter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/models/bounces/BounceFilteringParameters.ts#L35">client/models/bounces/BounceFilteringParameters.ts:35</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/models/bounces/BounceFilteringParameters.ts#L35">client/models/bounces/BounceFilteringParameters.ts:35</a></li>
</ul>
</aside>
</section>
Expand All @@ -2547,7 +2547,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> from<wbr>Date</h3>
<div class="tsd-signature tsd-kind-icon">from<wbr>Date<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/models/bounces/BounceFilteringParameters.ts#L38">client/models/bounces/BounceFilteringParameters.ts:38</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/models/bounces/BounceFilteringParameters.ts#L38">client/models/bounces/BounceFilteringParameters.ts:38</a></li>
</ul>
</aside>
</section>
Expand All @@ -2557,7 +2557,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> inactive</h3>
<div class="tsd-signature tsd-kind-icon">inactive<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">false</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">true</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/models/bounces/BounceFilteringParameters.ts#L34">client/models/bounces/BounceFilteringParameters.ts:34</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/models/bounces/BounceFilteringParameters.ts#L34">client/models/bounces/BounceFilteringParameters.ts:34</a></li>
</ul>
</aside>
</section>
Expand All @@ -2567,7 +2567,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> messageID</h3>
<div class="tsd-signature tsd-kind-icon">messageID<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/models/bounces/BounceFilteringParameters.ts#L37">client/models/bounces/BounceFilteringParameters.ts:37</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/models/bounces/BounceFilteringParameters.ts#L37">client/models/bounces/BounceFilteringParameters.ts:37</a></li>
</ul>
</aside>
</section>
Expand All @@ -2577,7 +2577,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> message<wbr>Stream</h
<div class="tsd-signature tsd-kind-icon">message<wbr>Stream<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/models/bounces/BounceFilteringParameters.ts#L40">client/models/bounces/BounceFilteringParameters.ts:40</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/models/bounces/BounceFilteringParameters.ts#L40">client/models/bounces/BounceFilteringParameters.ts:40</a></li>
</ul>
</aside>
</section>
Expand All @@ -2588,7 +2588,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> offset</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="filteringparameters.html">FilteringParameters</a>.<a href="filteringparameters.html#offset">offset</a></p>
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/models/client/FilteringParameters.ts#L9">client/models/client/FilteringParameters.ts:9</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/models/client/FilteringParameters.ts#L9">client/models/client/FilteringParameters.ts:9</a></li>
</ul>
</aside>
</section>
Expand All @@ -2598,7 +2598,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> tag</h3>
<div class="tsd-signature tsd-kind-icon">tag<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/models/bounces/BounceFilteringParameters.ts#L36">client/models/bounces/BounceFilteringParameters.ts:36</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/models/bounces/BounceFilteringParameters.ts#L36">client/models/bounces/BounceFilteringParameters.ts:36</a></li>
</ul>
</aside>
</section>
Expand All @@ -2608,7 +2608,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> to<wbr>Date</h3>
<div class="tsd-signature tsd-kind-icon">to<wbr>Date<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">undefined</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/models/bounces/BounceFilteringParameters.ts#L39">client/models/bounces/BounceFilteringParameters.ts:39</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/models/bounces/BounceFilteringParameters.ts#L39">client/models/bounces/BounceFilteringParameters.ts:39</a></li>
</ul>
</aside>
</section>
Expand All @@ -2618,7 +2618,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> type</h3>
<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <a href="../enums/bouncetype.html" class="tsd-signature-type">BounceType</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/8400c1f/src/client/models/bounces/BounceFilteringParameters.ts#L33">client/models/bounces/BounceFilteringParameters.ts:33</a></li>
<li>Defined in <a href="https://github.com/wildbit/postmark.js/blob/51387cb/src/client/models/bounces/BounceFilteringParameters.ts#L33">client/models/bounces/BounceFilteringParameters.ts:33</a></li>
</ul>
</aside>
</section>
Expand Down
Loading

0 comments on commit c8b063b

Please sign in to comment.