npm - @ngrok/ngrok-api - Versions diffs - 0.1.0 → 0.7.0 - Mend

@ngrok/ngrok-api 0.1.0 → 0.7.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (283) hide show

package/docs/interfaces/{staticbackendupdate.html → datatypes.HTTPSEdgeCreate.html} RENAMED Viewed

@@ -3,7 +3,7 @@
 <head>
 	<meta charset="utf-8">
 	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>StaticBackendUpdate | @ngrok/ngrok-api</title>
+	<title>HTTPSEdgeCreate | @ngrok/ngrok-api</title>
 	<meta name="description" content="Documentation for @ngrok/ngrok-api">
 	<meta name="viewport" content="width=device-width, initial-scale=1">
 	<link rel="stylesheet" href="../assets/css/main.css">
@@ -55,10 +55,13 @@
 					<a href="../modules.html">@ngrok/ngrok-api</a>
 				</li>
 				<li>
-					<a href="staticbackendupdate.html">StaticBackendUpdate</a>
+					<a href="../modules/datatypes.html">datatypes</a>
+				</li>
+				<li>
+					<a href="datatypes.HTTPSEdgeCreate.html">HTTPSEdgeCreate</a>
 				</li>
 			</ul>
-			<h1>Interface StaticBackendUpdate</h1>
+			<h1>Interface HTTPSEdgeCreate</h1>
 		</div>
 	</div>
 </header>
@@ -69,7 +72,7 @@
 				<h3>Hierarchy</h3>
 				<ul class="tsd-hierarchy">
 					<li>
-						<span class="target">StaticBackendUpdate</span>
+						<span class="target">HTTPSEdgeCreate</span>
 					</li>
 				</ul>
 			</section>
@@ -80,11 +83,11 @@
 						<section class="tsd-index-section ">
 							<h3>Properties</h3>
 							<ul class="tsd-index-list">
-								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="staticbackendupdate.html#address" class="tsd-kind-icon">address</a></li>
-								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="staticbackendupdate.html#description" class="tsd-kind-icon">description</a></li>
-								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="staticbackendupdate.html#id" class="tsd-kind-icon">id</a></li>
-								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="staticbackendupdate.html#metadata" class="tsd-kind-icon">metadata</a></li>
-								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="staticbackendupdate.html#tls" class="tsd-kind-icon">tls</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeCreate.html#description" class="tsd-kind-icon">description</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeCreate.html#hostports" class="tsd-kind-icon">hostports</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeCreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeCreate.html#mutualTls" class="tsd-kind-icon">mutual<wbr>Tls</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeCreate.html#tlsTermination" class="tsd-kind-icon">tls<wbr>Termination</a></li>
 							</ul>
 						</section>
 					</div>
@@ -93,82 +96,91 @@
 			<section class="tsd-panel-group tsd-member-group ">
 				<h2>Properties</h2>
 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
-					<a name="address" class="tsd-anchor"></a>
-					<h3>address</h3>
-					<div class="tsd-signature tsd-kind-icon">address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
+					<a name="description" class="tsd-anchor"></a>
+					<h3>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/5488ad8/src/types.ts#L176">types.ts:176</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L821">datatypes.ts:821</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
 						<div class="lead">
-							<p>the address to forward to</p>
+							<p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
 						</div>
 					</div>
 				</section>
 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
-					<a name="description" class="tsd-anchor"></a>
-					<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>
+					<a name="hostports" class="tsd-anchor"></a>
+					<h3><span class="tsd-flag ts-flagOptional">Optional</span> hostports</h3>
+					<div class="tsd-signature tsd-kind-icon">hostports<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/5488ad8/src/types.ts#L172">types.ts:172</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L825">datatypes.ts:825</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
 						<div class="lead">
-							<p>human-readable description of this backend. Optional</p>
+							<p>hostports served by this edge</p>
 						</div>
 					</div>
 				</section>
-				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
-					<a name="id" class="tsd-anchor"></a>
-					<h3>id</h3>
-					<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/5488ad8/src/types.ts#L170">types.ts:170</a></li>
-						</ul>
-					</aside>
-				</section>
 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
 					<a name="metadata" class="tsd-anchor"></a>
-					<h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
+					<h3>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/5488ad8/src/types.ts#L174">types.ts:174</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L823">datatypes.ts:823</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
 						<div class="lead">
-							<p>arbitrary user-defined machine-readable data of this backend. Optional</p>
+							<p>arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes.</p>
 						</div>
 					</div>
 				</section>
 				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
-					<a name="tls" class="tsd-anchor"></a>
-					<h3>tls</h3>
-					<div class="tsd-signature tsd-kind-icon">tls<span class="tsd-signature-symbol">:</span> <a href="staticbackendtls.html" class="tsd-signature-type" data-tsd-kind="Interface">StaticBackendTLS</a></div>
+					<a name="mutualTls" class="tsd-anchor"></a>
+					<h3><span class="tsd-flag ts-flagOptional">Optional</span> mutual<wbr>Tls</h3>
+					<div class="tsd-signature tsd-kind-icon">mutual<wbr>Tls<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointMutualTLSMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointMutualTLSMutate</a></div>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/5488ad8/src/types.ts#L178">types.ts:178</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L827">datatypes.ts:827</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
 						<div class="lead">
-							<p>tls configuration to use</p>
+							<p>edge modules</p>
 						</div>
 					</div>
 				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="tlsTermination" class="tsd-anchor"></a>
+					<h3><span class="tsd-flag ts-flagOptional">Optional</span> tls<wbr>Termination</h3>
+					<div class="tsd-signature tsd-kind-icon">tls<wbr>Termination<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointTLSTerminationAtEdge.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTLSTerminationAtEdge</a></div>
+					<aside class="tsd-sources">
+						<ul>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L828">datatypes.ts:828</a></li>
+						</ul>
+					</aside>
+				</section>
 			</section>
 		</div>
 		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
 			<nav class="tsd-navigation primary">
 				<ul>
 					<li class=" ">
-						<a href="../modules.html">Exports</a>
+						<a href="../modules.html">Modules</a>
+					</li>
+					<li class=" tsd-kind-module">
+						<a href="../modules/client.html">client</a>
+					</li>
+					<li class="current tsd-kind-module">
+						<a href="../modules/datatypes.html">datatypes</a>
+					</li>
+					<li class=" tsd-kind-module">
+						<a href="../modules/services.html">services</a>
 					</li>
 				</ul>
 			</nav>
@@ -176,23 +188,23 @@
 				<ul class="before-current">
 				</ul>
 				<ul class="current">
-					<li class="current tsd-kind-interface">
-						<a href="staticbackendupdate.html" class="tsd-kind-icon">Static<wbr>Backend<wbr>Update</a>
+					<li class="current tsd-kind-interface tsd-parent-kind-module">
+						<a href="datatypes.HTTPSEdgeCreate.html" class="tsd-kind-icon">HTTPSEdge<wbr>Create</a>
 						<ul>
 							<li class=" tsd-kind-property tsd-parent-kind-interface">
-								<a href="staticbackendupdate.html#address" class="tsd-kind-icon">address</a>
+								<a href="datatypes.HTTPSEdgeCreate.html#description" class="tsd-kind-icon">description</a>
 							</li>
 							<li class=" tsd-kind-property tsd-parent-kind-interface">
-								<a href="staticbackendupdate.html#description" class="tsd-kind-icon">description</a>
+								<a href="datatypes.HTTPSEdgeCreate.html#hostports" class="tsd-kind-icon">hostports</a>
 							</li>
 							<li class=" tsd-kind-property tsd-parent-kind-interface">
-								<a href="staticbackendupdate.html#id" class="tsd-kind-icon">id</a>
+								<a href="datatypes.HTTPSEdgeCreate.html#metadata" class="tsd-kind-icon">metadata</a>
 							</li>
 							<li class=" tsd-kind-property tsd-parent-kind-interface">
-								<a href="staticbackendupdate.html#metadata" class="tsd-kind-icon">metadata</a>
+								<a href="datatypes.HTTPSEdgeCreate.html#mutualTls" class="tsd-kind-icon">mutual<wbr>Tls</a>
 							</li>
 							<li class=" tsd-kind-property tsd-parent-kind-interface">
-								<a href="staticbackendupdate.html#tls" class="tsd-kind-icon">tls</a>
+								<a href="datatypes.HTTPSEdgeCreate.html#tlsTermination" class="tsd-kind-icon">tls<wbr>Termination</a>
 							</li>
 						</ul>
 					</li>
@@ -208,11 +220,11 @@
 		<h2>Legend</h2>
 		<div class="tsd-legend-group">
 			<ul class="tsd-legend">
-				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
-				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
+				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
 			</ul>
 			<ul class="tsd-legend">
-				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
+				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
 			</ul>
 		</div>
 	</div>

package/docs/interfaces/datatypes.HTTPSEdgeList.html ADDED Viewed

@@ -0,0 +1,205 @@
+<!doctype html>
+<html class="default no-js">
+<head>
+	<meta charset="utf-8">
+	<meta http-equiv="X-UA-Compatible" content="IE=edge">
+	<title>HTTPSEdgeList | @ngrok/ngrok-api</title>
+	<meta name="description" content="Documentation for @ngrok/ngrok-api">
+	<meta name="viewport" content="width=device-width, initial-scale=1">
+	<link rel="stylesheet" href="../assets/css/main.css">
+	<script async src="../assets/js/search.js" id="search-script"></script>
+</head>
+<body>
+<header>
+	<div class="tsd-page-toolbar">
+		<div class="container">
+			<div class="table-wrap">
+				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
+					<div class="field">
+						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
+						<input id="tsd-search-field" type="text" />
+					</div>
+					<ul class="results">
+						<li class="state loading">Preparing search index...</li>
+						<li class="state failure">The search index is not available</li>
+					</ul>
+					<a href="../index.html" class="title">@ngrok/ngrok-api</a>
+				</div>
+				<div class="table-cell" id="tsd-widgets">
+					<div id="tsd-filter">
+						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
+						<div class="tsd-filter-group">
+							<div class="tsd-select" id="tsd-filter-visibility">
+								<span class="tsd-select-label">All</span>
+								<ul class="tsd-select-list">
+									<li data-value="public">Public</li>
+									<li data-value="protected">Public/Protected</li>
+									<li data-value="private" class="selected">All</li>
+								</ul>
+							</div>
+							<input type="checkbox" id="tsd-filter-inherited" checked />
+							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
+							<input type="checkbox" id="tsd-filter-externals" checked />
+							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
+						</div>
+					</div>
+					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
+				</div>
+			</div>
+		</div>
+	</div>
+	<div class="tsd-page-title">
+		<div class="container">
+			<ul class="tsd-breadcrumb">
+				<li>
+					<a href="../modules.html">@ngrok/ngrok-api</a>
+				</li>
+				<li>
+					<a href="../modules/datatypes.html">datatypes</a>
+				</li>
+				<li>
+					<a href="datatypes.HTTPSEdgeList.html">HTTPSEdgeList</a>
+				</li>
+			</ul>
+			<h1>Interface HTTPSEdgeList</h1>
+		</div>
+	</div>
+</header>
+<div class="container container-main">
+	<div class="row">
+		<div class="col-8 col-content">
+			<section class="tsd-panel tsd-hierarchy">
+				<h3>Hierarchy</h3>
+				<ul class="tsd-hierarchy">
+					<li>
+						<span class="target">HTTPSEdgeList</span>
+					</li>
+				</ul>
+			</section>
+			<section class="tsd-panel-group tsd-index-group">
+				<h2>Index</h2>
+				<section class="tsd-panel tsd-index-panel">
+					<div class="tsd-index-content">
+						<section class="tsd-index-section ">
+							<h3>Properties</h3>
+							<ul class="tsd-index-list">
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeList.html#httpsEdges" class="tsd-kind-icon">https<wbr>Edges</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeList.html#uri" class="tsd-kind-icon">uri</a></li>
+							</ul>
+						</section>
+					</div>
+				</section>
+			</section>
+			<section class="tsd-panel-group tsd-member-group ">
+				<h2>Properties</h2>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="httpsEdges" class="tsd-anchor"></a>
+					<h3>https<wbr>Edges</h3>
+					<div class="tsd-signature tsd-kind-icon">https<wbr>Edges<span class="tsd-signature-symbol">:</span> <a href="datatypes.HTTPSEdge.html" class="tsd-signature-type" data-tsd-kind="Interface">HTTPSEdge</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#L812">datatypes.ts:812</a></li>
+						</ul>
+					</aside>
+					<div class="tsd-comment tsd-typography">
+						<div class="lead">
+							<p>the list of all HTTPS Edges on this account</p>
+						</div>
+					</div>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="nextPageUri" class="tsd-anchor"></a>
+					<h3><span class="tsd-flag ts-flagOptional">Optional</span> next<wbr>Page<wbr>Uri</h3>
+					<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#L816">datatypes.ts:816</a></li>
+						</ul>
+					</aside>
+					<div class="tsd-comment tsd-typography">
+						<div class="lead">
+							<p>URI of the next page, or null if there is no next page</p>
+						</div>
+					</div>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="uri" class="tsd-anchor"></a>
+					<h3>uri</h3>
+					<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#L814">datatypes.ts:814</a></li>
+						</ul>
+					</aside>
+					<div class="tsd-comment tsd-typography">
+						<div class="lead">
+							<p>URI of the HTTPS Edge list API resource</p>
+						</div>
+					</div>
+				</section>
+			</section>
+		</div>
+		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
+			<nav class="tsd-navigation primary">
+				<ul>
+					<li class=" ">
+						<a href="../modules.html">Modules</a>
+					</li>
+					<li class=" tsd-kind-module">
+						<a href="../modules/client.html">client</a>
+					</li>
+					<li class="current tsd-kind-module">
+						<a href="../modules/datatypes.html">datatypes</a>
+					</li>
+					<li class=" tsd-kind-module">
+						<a href="../modules/services.html">services</a>
+					</li>
+				</ul>
+			</nav>
+			<nav class="tsd-navigation secondary menu-sticky">
+				<ul class="before-current">
+				</ul>
+				<ul class="current">
+					<li class="current tsd-kind-interface tsd-parent-kind-module">
+						<a href="datatypes.HTTPSEdgeList.html" class="tsd-kind-icon">HTTPSEdge<wbr>List</a>
+						<ul>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="datatypes.HTTPSEdgeList.html#httpsEdges" class="tsd-kind-icon">https<wbr>Edges</a>
+							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="datatypes.HTTPSEdgeList.html#nextPageUri" class="tsd-kind-icon">next<wbr>Page<wbr>Uri</a>
+							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="datatypes.HTTPSEdgeList.html#uri" class="tsd-kind-icon">uri</a>
+							</li>
+						</ul>
+					</li>
+				</ul>
+				<ul class="after-current">
+				</ul>
+			</nav>
+		</div>
+	</div>
+</div>
+<footer class="with-border-bottom">
+	<div class="container">
+		<h2>Legend</h2>
+		<div class="tsd-legend-group">
+			<ul class="tsd-legend">
+				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
+				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
+			</ul>
+			<ul class="tsd-legend">
+				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
+			</ul>
+		</div>
+	</div>
+</footer>
+<div class="container tsd-generator">
+	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
+</div>
+<div class="overlay"></div>
+<script src="../assets/js/main.js"></script>
+</body>
+</html>