@ngrok/ngrok-api 0.8.0 → 0.10.0

package/docs/index.html

@@ -58,20 +58,32 @@
 	<div class="row">
 		<div class="col-8 col-content">
 			<div class="tsd-panel tsd-typography">
+				<!-- Code generated for API Clients. DO NOT EDIT. -->
+				<a href="#unstable" id="unstable" style="color: inherit; text-decoration: none;">
+					<h1>Unstable</h1>
+				</a>
+				<p>This library is currently unstable. We know of rough edges
+					and are working to bring it to parity with our other API client
+					libraries. Please feel free to try it out and let us know if you find
+				it useful!</p>
 				<a href="#ngrok-api-client-library-for-javascript-and-typescript" id="ngrok-api-client-library-for-javascript-and-typescript" style="color: inherit; text-decoration: none;">
-					<h2>ngrok API client library for JavaScript and TypeScript</h2>
+					<h1>ngrok API client library for JavaScript and TypeScript</h1>
 				</a>
 				<p>This library wraps the <a href="https://ngrok.com/docs/api">ngrok HTTP API</a> to make it
 				easier to consume in JavaScript or TypeScript.</p>
 				<a href="#installation" id="installation" style="color: inherit; text-decoration: none;">
-					<h3>Installation</h3>
+					<h2>Installation</h2>
 				</a>
 				<p>The published library is available on
 				<a href="https://www.npmjs.com/package/@ngrok/ngrok-api">npm</a>.</p>
 				<pre><code class="language-shell"><span style="color: #000000">npm install @ngrok/ngrok-api</span>
 </code></pre>
+				<a href="#support" id="support" style="color: inherit; text-decoration: none;">
+					<h2>Support</h2>
+				</a>
+				<p>The best place to get support using this library is through the <a href="https://ngrok.com/slack">ngrok Slack Community</a>. If you find any bugs, please contribute by opening a <a href="https://github.com/ngrok/ngrok-api-typescript/issues/new/choose">new GitHub issue</a>.</p>
 				<a href="#documentation" id="documentation" style="color: inherit; text-decoration: none;">
-					<h3>Documentation</h3>
+					<h2>Documentation</h2>
 				</a>
 				<p>A quickstart guide and a full API reference are included in the <a href="https://typescript-api.docs.ngrok.com">ngrok
 				TypeScript API documentation</a></p>
@@ -85,12 +97,12 @@
 				<pre><code class="language-typescript"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">Ngrok</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;@ngrok/ngrok-api&#039;</span><span style="color: #000000">;</span>
 
 <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">ngrok</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">Ngrok</span><span style="color: #000000">({</span>
-<span style="color: #000000">    </span><span style="color: #001080">apiToken:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;&lt;API KEY&gt;&#039;</span><span style="color: #000000">,</span>
+<span style="color: #000000">  </span><span style="color: #001080">apiToken:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;&lt;API KEY&gt;&#039;</span><span style="color: #000000">,</span>
 <span style="color: #000000">});</span>
 
 <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">domain</span><span style="color: #000000"> = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">ngrok</span><span style="color: #000000">.</span><span style="color: #001080">domains</span><span style="color: #000000">.</span><span style="color: #795E26">create</span><span style="color: #000000">({</span>
-<span style="color: #000000">  </span><span style="color: #001080">name:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;your-name.ngrok.io&#039;</span>
-<span style="color: #000000">})</span>
+<span style="color: #000000">  </span><span style="color: #001080">name:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;your-name.ngrok.io&#039;</span><span style="color: #000000">,</span>
+<span style="color: #000000">});</span>
 <span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">domain</span><span style="color: #000000">);</span>
 </code></pre>
 				<a href="#automatic-paging" id="automatic-paging" style="color: inherit; text-decoration: none;">
@@ -103,7 +115,7 @@
 				<pre><code class="language-typescript"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">Ngrok</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;@ngrok/ngrok-api&#039;</span><span style="color: #000000">;</span>
 
 <span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">ngrok</span><span style="color: #000000"> = </span><span style="color: #0000FF">new</span><span style="color: #000000"> </span><span style="color: #795E26">Ngrok</span><span style="color: #000000">({</span>
-<span style="color: #000000">    </span><span style="color: #001080">apiToken:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;&lt;API KEY&gt;&#039;</span><span style="color: #000000">,</span>
+<span style="color: #000000">  </span><span style="color: #001080">apiToken:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;&lt;API KEY&gt;&#039;</span><span style="color: #000000">,</span>
 <span style="color: #000000">});</span>
 
 <span style="color: #000000">(</span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">ngrok</span><span style="color: #000000">.</span><span style="color: #001080">tunnels</span><span style="color: #000000">.</span><span style="color: #795E26">list</span><span style="color: #000000">()).</span><span style="color: #795E26">forEach</span><span style="color: #000000">(</span><span style="color: #001080">t</span><span style="color: #000000"> </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">t</span><span style="color: #000000">));</span>
@@ -115,13 +127,13 @@
 					programming. You can use callback chaining with <code>.then()</code> and <code>.catch()</code> syntax
 				or the <code>await</code> keyword to wait for completion of an API call.</p>
 				<pre><code class="language-typescript"><span style="color: #008000">// await style</span>
-<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">cred</span><span style="color: #000000"> = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">ngrok</span><span style="color: #000000">.</span><span style="color: #001080">credentials</span><span style="color: #000000">.</span><span style="color: #795E26">create</span><span style="color: #000000">({</span><span style="color: #001080">description:</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;example&quot;</span><span style="color: #000000">});</span>
+<span style="color: #0000FF">const</span><span style="color: #000000"> </span><span style="color: #0070C1">cred</span><span style="color: #000000"> = </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">ngrok</span><span style="color: #000000">.</span><span style="color: #001080">credentials</span><span style="color: #000000">.</span><span style="color: #795E26">create</span><span style="color: #000000">({ </span><span style="color: #001080">description:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;example&#039;</span><span style="color: #000000"> });</span>
 <span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">cred</span><span style="color: #000000">);</span>
 
 <span style="color: #008000">// callback chaining</span>
-<span style="color: #001080">ngrok</span><span style="color: #000000">.</span><span style="color: #001080">credentials</span><span style="color: #000000">.</span><span style="color: #795E26">create</span><span style="color: #000000">({</span><span style="color: #001080">description:</span><span style="color: #000000"> </span><span style="color: #A31515">&quot;example&quot;</span><span style="color: #000000">}).</span><span style="color: #795E26">then</span><span style="color: #000000">((</span><span style="color: #001080">cred</span><span style="color: #000000"> </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
-<span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">cred</span><span style="color: #000000">)</span>
-<span style="color: #000000">}));</span>
+<span style="color: #001080">ngrok</span><span style="color: #000000">.</span><span style="color: #001080">credentials</span><span style="color: #000000">.</span><span style="color: #795E26">create</span><span style="color: #000000">({ </span><span style="color: #001080">description:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;example&#039;</span><span style="color: #000000"> }).</span><span style="color: #795E26">then</span><span style="color: #000000">(</span><span style="color: #001080">cred</span><span style="color: #000000"> </span><span style="color: #0000FF">=&gt;</span><span style="color: #000000"> {</span>
+<span style="color: #000000">  </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #001080">cred</span><span style="color: #000000">);</span>
+<span style="color: #000000">});</span>
 </code></pre>
 				<a href="#error-handling" id="error-handling" style="color: inherit; text-decoration: none;">
 					<h3>Error Handling</h3>
@@ -132,17 +144,16 @@
 				conditions.</p>
 				<p>The <code>Error</code> type includes a <code>statusCode</code> property which can be used to
 				distinguish not found errors when a resource does not exist:</p>
-				<pre><code class="language-typescript">
-<span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">Error</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;@ngrok/ngrok-api&#039;</span><span style="color: #000000">;</span>
+				<pre><code class="language-typescript"><span style="color: #AF00DB">import</span><span style="color: #000000"> { </span><span style="color: #001080">Error</span><span style="color: #000000"> } </span><span style="color: #AF00DB">from</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;@ngrok/ngrok-api&#039;</span><span style="color: #000000">;</span>
 
 <span style="color: #AF00DB">try</span><span style="color: #000000"> {</span>
 <span style="color: #000000">  </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">ngrok</span><span style="color: #000000">.</span><span style="color: #001080">ipPolicies</span><span style="color: #000000">.</span><span style="color: #795E26">update</span><span style="color: #000000">({</span>
 <span style="color: #000000">    </span><span style="color: #001080">id:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;someInvalidId&#039;</span><span style="color: #000000">,</span>
 <span style="color: #000000">    </span><span style="color: #001080">description:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;updated description&#039;</span><span style="color: #000000">,</span>
-<span style="color: #000000">  })</span>
+<span style="color: #000000">  });</span>
 <span style="color: #000000">} </span><span style="color: #AF00DB">catch</span><span style="color: #000000"> (</span><span style="color: #001080">err</span><span style="color: #000000">: </span><span style="color: #267F99">Error</span><span style="color: #000000">) {</span>
 <span style="color: #000000">  </span><span style="color: #AF00DB">if</span><span style="color: #000000"> (</span><span style="color: #001080">err</span><span style="color: #000000">.</span><span style="color: #001080">statusCode</span><span style="color: #000000"> == </span><span style="color: #098658">404</span><span style="color: #000000">) {</span>
-<span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;no ip policy with that id to update&#039;</span><span style="color: #000000">)</span>
+<span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;no ip policy with that id to update&#039;</span><span style="color: #000000">);</span>
 <span style="color: #000000">  }</span>
 <span style="color: #000000">}</span>
 </code></pre>
@@ -155,12 +166,12 @@
 <span style="color: #AF00DB">try</span><span style="color: #000000"> {</span>
 <span style="color: #000000">  </span><span style="color: #AF00DB">await</span><span style="color: #000000"> </span><span style="color: #001080">ngrok</span><span style="color: #000000">.</span><span style="color: #001080">ipPolicies</span><span style="color: #000000">.</span><span style="color: #795E26">create</span><span style="color: #000000">({</span>
 <span style="color: #000000">    </span><span style="color: #001080">action:</span><span style="color: #000000"> </span><span style="color: #A31515">&#039;something invalid&#039;</span><span style="color: #000000">,</span>
-<span style="color: #000000">  })</span>
+<span style="color: #000000">  });</span>
 <span style="color: #000000">} </span><span style="color: #AF00DB">catch</span><span style="color: #000000"> (</span><span style="color: #001080">err</span><span style="color: #000000">: </span><span style="color: #267F99">Error</span><span style="color: #000000">) {</span>
-<span style="color: #000000">  </span><span style="color: #AF00DB">if</span><span style="color: #000000"> (</span><span style="color: #001080">err</span><span style="color: #000000">.</span><span style="color: #001080">errorCode</span><span style="color: #000000"> == </span><span style="color: #A31515">&quot;ERR_NGROK_1410&quot;</span><span style="color: #000000">) {</span>
-<span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;not a valid ip policy action&#039;</span><span style="color: #000000">)</span>
+<span style="color: #000000">  </span><span style="color: #AF00DB">if</span><span style="color: #000000"> (</span><span style="color: #001080">err</span><span style="color: #000000">.</span><span style="color: #001080">errorCode</span><span style="color: #000000"> == </span><span style="color: #A31515">&#039;ERR_NGROK_1410&#039;</span><span style="color: #000000">) {</span>
+<span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;not a valid ip policy action&#039;</span><span style="color: #000000">);</span>
 <span style="color: #000000">  } </span><span style="color: #AF00DB">else</span><span style="color: #000000"> {</span>
-<span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;some other error&#039;</span><span style="color: #000000">, </span><span style="color: #001080">err</span><span style="color: #000000">)</span>
+<span style="color: #000000">    </span><span style="color: #001080">console</span><span style="color: #000000">.</span><span style="color: #795E26">log</span><span style="color: #000000">(</span><span style="color: #A31515">&#039;some other error&#039;</span><span style="color: #000000">, </span><span style="color: #001080">err</span><span style="color: #000000">);</span>
 <span style="color: #000000">  }</span>
 <span style="color: #000000">}</span>
 </code></pre>

package/docs/interfaces/client.NgrokConfig.html

@@ -98,7 +98,7 @@
 					<div class="tsd-signature tsd-kind-icon">api<wbr>Token<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/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L16">client.ts:16</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L16">client.ts:16</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -108,7 +108,7 @@
 					<div class="tsd-signature tsd-kind-icon">base<wbr>Url<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/ngrok/ngrok-api-typescript/blob/2b8fd06/src/client.ts#L17">client.ts:17</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L17">client.ts:17</a></li>
 						</ul>
 					</aside>
 				</section>

package/docs/interfaces/datatypes.APIKey.html

@@ -87,6 +87,7 @@
 								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.APIKey.html#description" class="tsd-kind-icon">description</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.APIKey.html#id" class="tsd-kind-icon">id</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.APIKey.html#metadata" class="tsd-kind-icon">metadata</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.APIKey.html#ownerId" class="tsd-kind-icon">owner<wbr>Id</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.APIKey.html#token" class="tsd-kind-icon">token</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.APIKey.html#uri" class="tsd-kind-icon">uri</a></li>
 							</ul>
@@ -99,10 +100,10 @@
 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
 					<a name="createdAt" class="tsd-anchor"></a>
 					<h3>created<wbr>At</h3>
-					<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
+					<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L128">datatypes.ts:128</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L165">datatypes.ts:165</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -113,11 +114,11 @@
 				</section>
 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
 					<a name="description" class="tsd-anchor"></a>
-					<h3>description</h3>
+					<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
 					<div class="tsd-signature tsd-kind-icon">description<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/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L124">datatypes.ts:124</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L161">datatypes.ts:161</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -132,7 +133,7 @@
 					<div class="tsd-signature tsd-kind-icon">id<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/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L120">datatypes.ts:120</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L157">datatypes.ts:157</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -143,11 +144,11 @@
 				</section>
 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
 					<a name="metadata" class="tsd-anchor"></a>
-					<h3>metadata</h3>
+					<h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
 					<div class="tsd-signature tsd-kind-icon">metadata<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/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L126">datatypes.ts:126</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L163">datatypes.ts:163</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -156,13 +157,28 @@
 						</div>
 					</div>
 				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="ownerId" class="tsd-anchor"></a>
+					<h3><span class="tsd-flag ts-flagOptional">Optional</span> owner<wbr>Id</h3>
+					<div class="tsd-signature tsd-kind-icon">owner<wbr>Id<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/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L169">datatypes.ts:169</a></li>
+						</ul>
+					</aside>
+					<div class="tsd-comment tsd-typography">
+						<div class="lead">
+							<p>If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.</p>
+						</div>
+					</div>
+				</section>
 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
 					<a name="token" class="tsd-anchor"></a>
 					<h3><span class="tsd-flag ts-flagOptional">Optional</span> token</h3>
 					<div class="tsd-signature tsd-kind-icon">token<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/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L130">datatypes.ts:130</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L167">datatypes.ts:167</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -177,7 +193,7 @@
 					<div class="tsd-signature tsd-kind-icon">uri<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/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L122">datatypes.ts:122</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L159">datatypes.ts:159</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -224,6 +240,9 @@
 							<li class=" tsd-kind-property tsd-parent-kind-interface">
 								<a href="datatypes.APIKey.html#metadata" class="tsd-kind-icon">metadata</a>
 							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="datatypes.APIKey.html#ownerId" class="tsd-kind-icon">owner<wbr>Id</a>
+							</li>
 							<li class=" tsd-kind-property tsd-parent-kind-interface">
 								<a href="datatypes.APIKey.html#token" class="tsd-kind-icon">token</a>
 							</li>

package/docs/interfaces/datatypes.APIKeyCreate.html

@@ -85,6 +85,7 @@
 							<ul class="tsd-index-list">
 								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.APIKeyCreate.html#description" class="tsd-kind-icon">description</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.APIKeyCreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.APIKeyCreate.html#ownerId" class="tsd-kind-icon">owner<wbr>Id</a></li>
 							</ul>
 						</section>
 					</div>
@@ -94,11 +95,11 @@
 				<h2>Properties</h2>
 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
 					<a name="description" class="tsd-anchor"></a>
-					<h3>description</h3>
+					<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
 					<div class="tsd-signature tsd-kind-icon">description<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/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L105">datatypes.ts:105</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L140">datatypes.ts:140</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -109,11 +110,11 @@
 				</section>
 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
 					<a name="metadata" class="tsd-anchor"></a>
-					<h3>metadata</h3>
+					<h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
 					<div class="tsd-signature tsd-kind-icon">metadata<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/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L107">datatypes.ts:107</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L142">datatypes.ts:142</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -122,6 +123,21 @@
 						</div>
 					</div>
 				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="ownerId" class="tsd-anchor"></a>
+					<h3><span class="tsd-flag ts-flagOptional">Optional</span> owner<wbr>Id</h3>
+					<div class="tsd-signature tsd-kind-icon">owner<wbr>Id<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/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L144">datatypes.ts:144</a></li>
+						</ul>
+					</aside>
+					<div class="tsd-comment tsd-typography">
+						<div class="lead">
+							<p>If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.</p>
+						</div>
+					</div>
+				</section>
 			</section>
 		</div>
 		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
@@ -154,6 +170,9 @@
 							<li class=" tsd-kind-property tsd-parent-kind-interface">
 								<a href="datatypes.APIKeyCreate.html#metadata" class="tsd-kind-icon">metadata</a>
 							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="datatypes.APIKeyCreate.html#ownerId" class="tsd-kind-icon">owner<wbr>Id</a>
+							</li>
 						</ul>
 					</li>
 				</ul>

package/docs/interfaces/datatypes.APIKeyList.html

@@ -99,7 +99,7 @@
 					<div class="tsd-signature tsd-kind-icon">keys<span class="tsd-signature-symbol">:</span> <a href="datatypes.APIKey.html" class="tsd-signature-type" data-tsd-kind="Interface">APIKey</a><span class="tsd-signature-symbol">[]</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L135">datatypes.ts:135</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L174">datatypes.ts:174</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -114,7 +114,7 @@
 					<div class="tsd-signature tsd-kind-icon">next<wbr>Page<wbr>Uri<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/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L139">datatypes.ts:139</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L178">datatypes.ts:178</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -129,7 +129,7 @@
 					<div class="tsd-signature tsd-kind-icon">uri<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/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L137">datatypes.ts:137</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L176">datatypes.ts:176</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">

package/docs/interfaces/datatypes.APIKeyUpdate.html

@@ -99,7 +99,7 @@
 					<div class="tsd-signature tsd-kind-icon">description<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/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L113">datatypes.ts:113</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L150">datatypes.ts:150</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -114,7 +114,7 @@
 					<div class="tsd-signature tsd-kind-icon">id<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/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L111">datatypes.ts:111</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L148">datatypes.ts:148</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -124,7 +124,7 @@
 					<div class="tsd-signature tsd-kind-icon">metadata<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/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L115">datatypes.ts:115</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L152">datatypes.ts:152</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">

package/docs/interfaces/datatypes.AWSAuth.html

@@ -98,7 +98,7 @@
 					<div class="tsd-signature tsd-kind-icon">creds<span class="tsd-signature-symbol">:</span> <a href="datatypes.AWSCredentials.html" class="tsd-signature-type" data-tsd-kind="Interface">AWSCredentials</a></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1190">datatypes.ts:1190</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1431">datatypes.ts:1431</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -113,7 +113,7 @@
 					<div class="tsd-signature tsd-kind-icon">role<span class="tsd-signature-symbol">:</span> <a href="datatypes.AWSRole.html" class="tsd-signature-type" data-tsd-kind="Interface">AWSRole</a></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1188">datatypes.ts:1188</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1429">datatypes.ts:1429</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">

package/docs/interfaces/datatypes.AWSCredentials.html

@@ -98,7 +98,7 @@
 					<div class="tsd-signature tsd-kind-icon">aws<wbr>Access<wbr>Key<wbr>Id<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/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1200">datatypes.ts:1200</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1441">datatypes.ts:1441</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -113,7 +113,7 @@
 					<div class="tsd-signature tsd-kind-icon">aws<wbr>Secret<wbr>Access<wbr>Key<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/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1202">datatypes.ts:1202</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1443">datatypes.ts:1443</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">

package/docs/interfaces/datatypes.AWSRole.html

@@ -97,7 +97,7 @@
 					<div class="tsd-signature tsd-kind-icon">role<wbr>Arn<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/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L1195">datatypes.ts:1195</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1436">datatypes.ts:1436</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">

package/docs/interfaces/datatypes.AbuseReport.html

@@ -100,10 +100,10 @@
 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
 					<a name="createdAt" class="tsd-anchor"></a>
 					<h3>created<wbr>At</h3>
-					<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
+					<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L33">datatypes.ts:33</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L35">datatypes.ts:35</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -118,7 +118,7 @@
 					<div class="tsd-signature tsd-kind-icon">hostnames<span class="tsd-signature-symbol">:</span> <a href="datatypes.AbuseReportHostname.html" class="tsd-signature-type" data-tsd-kind="Interface">AbuseReportHostname</a><span class="tsd-signature-symbol">[]</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L41">datatypes.ts:41</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L43">datatypes.ts:43</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -133,7 +133,7 @@
 					<div class="tsd-signature tsd-kind-icon">id<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/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L29">datatypes.ts:29</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L31">datatypes.ts:31</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -144,11 +144,11 @@
 				</section>
 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
 					<a name="metadata" class="tsd-anchor"></a>
-					<h3>metadata</h3>
+					<h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
 					<div class="tsd-signature tsd-kind-icon">metadata<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/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L37">datatypes.ts:37</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L39">datatypes.ts:39</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -163,7 +163,7 @@
 					<div class="tsd-signature tsd-kind-icon">status<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/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L39">datatypes.ts:39</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L41">datatypes.ts:41</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -178,7 +178,7 @@
 					<div class="tsd-signature tsd-kind-icon">uri<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/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L31">datatypes.ts:31</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L33">datatypes.ts:33</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -193,7 +193,7 @@
 					<div class="tsd-signature tsd-kind-icon">urls<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L35">datatypes.ts:35</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L37">datatypes.ts:37</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">

package/docs/interfaces/datatypes.AbuseReportCreate.html

@@ -94,11 +94,11 @@
 				<h2>Properties</h2>
 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
 					<a name="metadata" class="tsd-anchor"></a>
-					<h3>metadata</h3>
+					<h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
 					<div class="tsd-signature tsd-kind-icon">metadata<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/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L55">datatypes.ts:55</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L57">datatypes.ts:57</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -113,7 +113,7 @@
 					<div class="tsd-signature tsd-kind-icon">urls<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L53">datatypes.ts:53</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L55">datatypes.ts:55</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">

package/docs/interfaces/datatypes.AbuseReportHostname.html

@@ -98,7 +98,7 @@
 					<div class="tsd-signature tsd-kind-icon">hostname<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/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L46">datatypes.ts:46</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L48">datatypes.ts:48</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -113,7 +113,7 @@
 					<div class="tsd-signature tsd-kind-icon">status<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/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L48">datatypes.ts:48</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L50">datatypes.ts:50</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">