Bug fixes and documentation updates

CHANGES.md

@@ -1,3 +1,8 @@
+## 0.1.9 ##
+
+* Bug fixes
+* Documentation updates
+
 ## 0.1.8 ##
 
 * Improve errors

docs/classes/apierror.html

@@ -69,7 +69,8 @@ <h1>Class ApiError</h1>
 			<section class="tsd-panel tsd-comment">
 				<div class="tsd-comment tsd-typography">
 					<div class="lead">
-						<p>Error thrown during API requests.</p>
+						<p>This error is thrown after a failed API request and contains additional
+						information about the failed request.</p>
 					</div>
 				</div>
 			</section>
@@ -123,7 +124,7 @@ <h3>constructor</h3>
 						<li class="tsd-description">
 							<aside class="tsd-sources">
 								<ul>
-									<li>Defined in api.ts:132</li>
+									<li>Defined in api.ts:133</li>
 								</ul>
 							</aside>
 							<div class="tsd-comment tsd-typography">
@@ -171,7 +172,7 @@ <h3>message</h3>
 					<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in api.ts:124</li>
+							<li>Defined in api.ts:125</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -186,7 +187,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> response<wbr>Code</h3
 					<div class="tsd-signature tsd-kind-icon">response<wbr>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in api.ts:128</li>
+							<li>Defined in api.ts:129</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -201,7 +202,7 @@ <h3><span class="tsd-flag ts-flagOptional">Optional</span> response<wbr>Text</h3
 					<div class="tsd-signature tsd-kind-icon">response<wbr>Text<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in api.ts:132</li>
+							<li>Defined in api.ts:133</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -307,12 +308,6 @@ <h3><span class="tsd-flag ts-flagStatic">Static</span> <span class="tsd-flag ts-
 					<li class=" tsd-kind-class">
 						<a href="nsapi.html" class="tsd-kind-icon">Ns<wbr>Api</a>
 					</li>
-					<li class=" tsd-kind-interface tsd-is-not-exported">
-						<a href="../interfaces/apirequest.html" class="tsd-kind-icon">Api<wbr>Request</a>
-					</li>
-					<li class=" tsd-kind-interface tsd-is-not-exported">
-						<a href="../interfaces/cache.html" class="tsd-kind-icon">Cache</a>
-					</li>
 					<li class=" tsd-kind-interface">
 						<a href="../interfaces/privateshardsauth.html" class="tsd-kind-icon">Private<wbr>Shards<wbr>Auth</a>
 					</li>

docs/enums/telegramtype.html

@@ -69,7 +69,8 @@ <h1>Enumeration TelegramType</h1>
 			<section class="tsd-panel tsd-comment">
 				<div class="tsd-comment tsd-typography">
 					<div class="lead">
-						<p>The telegram type specified for the purposes of rate limitation.</p>
+						<p>The telegram type for rate limit purposes. Recruitment telegrams have a
+						stricter rate limit than non-recruitment telegrams.</p>
 					</div>
 				</div>
 			</section>
@@ -92,32 +93,22 @@ <h2>Enumeration members</h2>
 				<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
 					<a name="nonrecruitment" class="tsd-anchor"></a>
 					<h3>Non<wbr>Recruitment</h3>
-					<div class="tsd-signature tsd-kind-icon">Non<wbr>Recruitment<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;2</span></div>
+					<div class="tsd-signature tsd-kind-icon">Non<wbr>Recruitment<span class="tsd-signature-symbol">:</span> </div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in api.ts:85</li>
+							<li>Defined in api.ts:72</li>
 						</ul>
 					</aside>
-					<div class="tsd-comment tsd-typography">
-						<div class="lead">
-							<p>A telegram that is not for the purposes of recruitment.</p>
-						</div>
-					</div>
 				</section>
 				<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
 					<a name="recruitment" class="tsd-anchor"></a>
 					<h3>Recruitment</h3>
-					<div class="tsd-signature tsd-kind-icon">Recruitment<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;1</span></div>
+					<div class="tsd-signature tsd-kind-icon">Recruitment<span class="tsd-signature-symbol">:</span> </div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in api.ts:81</li>
+							<li>Defined in api.ts:71</li>
 						</ul>
 					</aside>
-					<div class="tsd-comment tsd-typography">
-						<div class="lead">
-							<p>A telegram that is for the purposes of recruitment.</p>
-						</div>
-					</div>
 				</section>
 			</section>
 		</div>
@@ -155,12 +146,6 @@ <h3>Recruitment</h3>
 					<li class=" tsd-kind-class">
 						<a href="../classes/nsapi.html" class="tsd-kind-icon">Ns<wbr>Api</a>
 					</li>
-					<li class=" tsd-kind-interface tsd-is-not-exported">
-						<a href="../interfaces/apirequest.html" class="tsd-kind-icon">Api<wbr>Request</a>
-					</li>
-					<li class=" tsd-kind-interface tsd-is-not-exported">
-						<a href="../interfaces/cache.html" class="tsd-kind-icon">Cache</a>
-					</li>
 					<li class=" tsd-kind-interface">
 						<a href="../interfaces/privateshardsauth.html" class="tsd-kind-icon">Private<wbr>Shards<wbr>Auth</a>
 					</li>

docs/enums/worldassemblycouncil.html

@@ -69,8 +69,7 @@ <h1>Enumeration WorldAssemblyCouncil</h1>
 			<section class="tsd-panel tsd-comment">
 				<div class="tsd-comment tsd-typography">
 					<div class="lead">
-						<p>The council of the World Assembly to be specified in World Assembly API
-						requests.</p>
+						<p>The council specified in World Assembly API requests.</p>
 					</div>
 				</div>
 			</section>
@@ -96,29 +95,19 @@ <h3>General<wbr>Assembly</h3>
 					<div class="tsd-signature tsd-kind-icon">General<wbr>Assembly<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;1</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in api.ts:67</li>
+							<li>Defined in api.ts:62</li>
 						</ul>
 					</aside>
-					<div class="tsd-comment tsd-typography">
-						<div class="lead">
-							<p>The General Assembly.</p>
-						</div>
-					</div>
 				</section>
 				<section class="tsd-panel tsd-member tsd-kind-enum-member tsd-parent-kind-enum">
 					<a name="securitycouncil" class="tsd-anchor"></a>
 					<h3>Security<wbr>Council</h3>
 					<div class="tsd-signature tsd-kind-icon">Security<wbr>Council<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol"> =&nbsp;2</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in api.ts:71</li>
+							<li>Defined in api.ts:63</li>
 						</ul>
 					</aside>
-					<div class="tsd-comment tsd-typography">
-						<div class="lead">
-							<p>The Security Council.</p>
-						</div>
-					</div>
 				</section>
 			</section>
 		</div>
@@ -156,12 +145,6 @@ <h3>Security<wbr>Council</h3>
 					<li class=" tsd-kind-class">
 						<a href="../classes/nsapi.html" class="tsd-kind-icon">Ns<wbr>Api</a>
 					</li>
-					<li class=" tsd-kind-interface tsd-is-not-exported">
-						<a href="../interfaces/apirequest.html" class="tsd-kind-icon">Api<wbr>Request</a>
-					</li>
-					<li class=" tsd-kind-interface tsd-is-not-exported">
-						<a href="../interfaces/cache.html" class="tsd-kind-icon">Cache</a>
-					</li>
 					<li class=" tsd-kind-interface">
 						<a href="../interfaces/privateshardsauth.html" class="tsd-kind-icon">Private<wbr>Shards<wbr>Auth</a>
 					</li>

docs/globals.html

@@ -84,8 +84,6 @@ <h3>Classes</h3>
 						<section class="tsd-index-section ">
 							<h3>Interfaces</h3>
 							<ul class="tsd-index-list">
-								<li class="tsd-kind-interface tsd-is-not-exported"><a href="interfaces/apirequest.html" class="tsd-kind-icon">Api<wbr>Request</a></li>
-								<li class="tsd-kind-interface tsd-is-not-exported"><a href="interfaces/cache.html" class="tsd-kind-icon">Cache</a></li>
 								<li class="tsd-kind-interface"><a href="interfaces/privateshardsauth.html" class="tsd-kind-icon">Private<wbr>Shards<wbr>Auth</a></li>
 							</ul>
 						</section>
@@ -108,27 +106,27 @@ <h3>API_<wbr>VERSION</h3>
 					<div class="tsd-signature tsd-kind-icon">API_<wbr>VERSION<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> =&nbsp;9</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in api.ts:57</li>
+							<li>Defined in api.ts:56</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
 						<div class="lead">
-							<p>The API version specified in API requests.</p>
+							<p>The version specified in API requests.</p>
 						</div>
 					</div>
 				</section>
 				<section class="tsd-panel tsd-member tsd-kind-variable">
 					<a name="version" class="tsd-anchor"></a>
 					<h3>VERSION</h3>
-					<div class="tsd-signature tsd-kind-icon">VERSION<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;&quot;0.1.8&quot;</span></div>
+					<div class="tsd-signature tsd-kind-icon">VERSION<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> =&nbsp;&quot;0.1.9&quot;</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in api.ts:52</li>
+							<li>Defined in api.ts:51</li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
 						<div class="lead">
-							<p>The current version of nsapi.</p>
+							<p>The version of nsapi.</p>
 						</div>
 					</div>
 				</section>
@@ -138,7 +136,7 @@ <h3>xml<wbr>Parser</h3>
 					<div class="tsd-signature tsd-kind-icon">xml<wbr>Parser<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Parser</span><span class="tsd-signature-symbol"> =&nbsp;new xml2js.Parser({charkey: &quot;value&quot;,trim: true,normalizeTags: true,normalize: true,explicitRoot: false,explicitArray: false,mergeAttrs: true,attrValueProcessors: [(value: any) &#x3D;&gt; {let num &#x3D; Number(value);if (!isNaN(num)) {return num;} else {return value;}}],valueProcessors: [(value: any) &#x3D;&gt; {let num &#x3D; Number(value);if (!isNaN(num)) {return num;} else {return value;}}]})</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in api.ts:22</li>
+							<li>Defined in api.ts:21</li>
 						</ul>
 					</aside>
 				</section>
@@ -166,12 +164,6 @@ <h3>xml<wbr>Parser</h3>
 					<li class=" tsd-kind-class">
 						<a href="classes/nsapi.html" class="tsd-kind-icon">Ns<wbr>Api</a>
 					</li>
-					<li class=" tsd-kind-interface tsd-is-not-exported">
-						<a href="interfaces/apirequest.html" class="tsd-kind-icon">Api<wbr>Request</a>
-					</li>
-					<li class=" tsd-kind-interface tsd-is-not-exported">
-						<a href="interfaces/cache.html" class="tsd-kind-icon">Cache</a>
-					</li>
 					<li class=" tsd-kind-interface">
 						<a href="interfaces/privateshardsauth.html" class="tsd-kind-icon">Private<wbr>Shards<wbr>Auth</a>
 					</li>

docs/index.html

@@ -128,12 +128,6 @@ <h2 id="license">License</h2>
 					<li class=" tsd-kind-class">
 						<a href="classes/nsapi.html" class="tsd-kind-icon">Ns<wbr>Api</a>
 					</li>
-					<li class=" tsd-kind-interface tsd-is-not-exported">
-						<a href="interfaces/apirequest.html" class="tsd-kind-icon">Api<wbr>Request</a>
-					</li>
-					<li class=" tsd-kind-interface tsd-is-not-exported">
-						<a href="interfaces/cache.html" class="tsd-kind-icon">Cache</a>
-					</li>
 					<li class=" tsd-kind-interface">
 						<a href="interfaces/privateshardsauth.html" class="tsd-kind-icon">Private<wbr>Shards<wbr>Auth</a>
 					</li>