npm - @ngrok/ngrok-api - Versions diffs - 0.9.0 → 0.11.0 - Mend

@ngrok/ngrok-api 0.9.0 → 0.11.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 (293) hide show

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

@@ -0,0 +1,186 @@
+<!doctype html>
+<html class="default no-js">
+<head>
+	<meta charset="utf-8">
+	<meta http-equiv="X-UA-Compatible" content="IE=edge">
+	<title>AgentIngressCertStatus | @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.AgentIngressCertStatus.html">AgentIngressCertStatus</a>
+				</li>
+			</ul>
+			<h1>Interface AgentIngressCertStatus</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">AgentIngressCertStatus</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.AgentIngressCertStatus.html#provisioningJob" class="tsd-kind-icon">provisioning<wbr>Job</a></li>
+								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.AgentIngressCertStatus.html#renewsAt" class="tsd-kind-icon">renews<wbr>At</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="provisioningJob" class="tsd-anchor"></a>
+					<h3><span class="tsd-flag ts-flagOptional">Optional</span> provisioning<wbr>Job</h3>
+					<div class="tsd-signature tsd-kind-icon">provisioning<wbr>Job<span class="tsd-signature-symbol">:</span> <a href="datatypes.AgentIngressCertJob.html" class="tsd-signature-type" data-tsd-kind="Interface">AgentIngressCertJob</a></div>
+					<aside class="tsd-sources">
+						<ul>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L124">datatypes.ts:124</a></li>
+						</ul>
+					</aside>
+					<div class="tsd-comment tsd-typography">
+						<div class="lead">
+							<p>status of the certificate provisioning job, or null if the certificiate isn&#39;t being provisioned or renewed</p>
+						</div>
+					</div>
+				</section>
+				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
+					<a name="renewsAt" class="tsd-anchor"></a>
+					<h3><span class="tsd-flag ts-flagOptional">Optional</span> renews<wbr>At</h3>
+					<div class="tsd-signature tsd-kind-icon">renews<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/4214cc1/src/datatypes.ts#L122">datatypes.ts:122</a></li>
+						</ul>
+					</aside>
+					<div class="tsd-comment tsd-typography">
+						<div class="lead">
+							<p>timestamp when the next renewal will be requested, RFC 3339 format</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.AgentIngressCertStatus.html" class="tsd-kind-icon">Agent<wbr>Ingress<wbr>Cert<wbr>Status</a>
+						<ul>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="datatypes.AgentIngressCertStatus.html#provisioningJob" class="tsd-kind-icon">provisioning<wbr>Job</a>
+							</li>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="datatypes.AgentIngressCertStatus.html#renewsAt" class="tsd-kind-icon">renews<wbr>At</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>

package/docs/interfaces/datatypes.AgentIngressCreate.html CHANGED Viewed

@@ -83,6 +83,7 @@
 						<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.AgentIngressCreate.html#certificateManagementPolicy" class="tsd-kind-icon">certificate<wbr>Management<wbr>Policy</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.AgentIngressCreate.html#description" class="tsd-kind-icon">description</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.AgentIngressCreate.html#domain" class="tsd-kind-icon">domain</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.AgentIngressCreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
@@ -93,13 +94,28 @@
 			</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="certificateManagementPolicy" class="tsd-anchor"></a>
+					<h3><span class="tsd-flag ts-flagOptional">Optional</span> certificate<wbr>Management<wbr>Policy</h3>
+					<div class="tsd-signature tsd-kind-icon">certificate<wbr>Management<wbr>Policy<span class="tsd-signature-symbol">:</span> <a href="datatypes.AgentIngressCertPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">AgentIngressCertPolicy</a></div>
+					<aside class="tsd-sources">
+						<ul>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L68">datatypes.ts:68</a></li>
+						</ul>
+					</aside>
+					<div class="tsd-comment tsd-typography">
+						<div class="lead">
+							<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional.</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>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/0593d03/src/datatypes.ts#L60">datatypes.ts:60</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L62">datatypes.ts:62</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -114,7 +130,7 @@
 					<div class="tsd-signature tsd-kind-icon">domain<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/0593d03/src/datatypes.ts#L64">datatypes.ts:64</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L66">datatypes.ts:66</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -125,11 +141,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/0593d03/src/datatypes.ts#L62">datatypes.ts:62</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L64">datatypes.ts:64</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -164,6 +180,9 @@
 					<li class="current tsd-kind-interface tsd-parent-kind-module">
 						<a href="datatypes.AgentIngressCreate.html" class="tsd-kind-icon">Agent<wbr>Ingress<wbr>Create</a>
 						<ul>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="datatypes.AgentIngressCreate.html#certificateManagementPolicy" class="tsd-kind-icon">certificate<wbr>Management<wbr>Policy</a>
+							</li>
 							<li class=" tsd-kind-property tsd-parent-kind-interface">
 								<a href="datatypes.AgentIngressCreate.html#description" class="tsd-kind-icon">description</a>
 							</li>

package/docs/interfaces/datatypes.AgentIngressList.html CHANGED Viewed

@@ -99,7 +99,7 @@
 					<div class="tsd-signature tsd-kind-icon">ingresses<span class="tsd-signature-symbol">:</span> <a href="datatypes.AgentIngress.html" class="tsd-signature-type" data-tsd-kind="Interface">AgentIngress</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/0593d03/src/datatypes.ts#L96">datatypes.ts:96</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L106">datatypes.ts:106</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/0593d03/src/datatypes.ts#L100">datatypes.ts:100</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L110">datatypes.ts:110</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/0593d03/src/datatypes.ts#L98">datatypes.ts:98</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L108">datatypes.ts:108</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">

package/docs/interfaces/datatypes.AgentIngressUpdate.html CHANGED Viewed

@@ -83,6 +83,7 @@
 						<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.AgentIngressUpdate.html#certificateManagementPolicy" class="tsd-kind-icon">certificate<wbr>Management<wbr>Policy</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.AgentIngressUpdate.html#description" class="tsd-kind-icon">description</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.AgentIngressUpdate.html#id" class="tsd-kind-icon">id</a></li>
 								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.AgentIngressUpdate.html#metadata" class="tsd-kind-icon">metadata</a></li>
@@ -93,13 +94,28 @@
 			</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="certificateManagementPolicy" class="tsd-anchor"></a>
+					<h3><span class="tsd-flag ts-flagOptional">Optional</span> certificate<wbr>Management<wbr>Policy</h3>
+					<div class="tsd-signature tsd-kind-icon">certificate<wbr>Management<wbr>Policy<span class="tsd-signature-symbol">:</span> <a href="datatypes.AgentIngressCertPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">AgentIngressCertPolicy</a></div>
+					<aside class="tsd-sources">
+						<ul>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L78">datatypes.ts:78</a></li>
+						</ul>
+					</aside>
+					<div class="tsd-comment tsd-typography">
+						<div class="lead">
+							<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional.</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>
 					<aside class="tsd-sources">
 						<ul>
-							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L70">datatypes.ts:70</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L74">datatypes.ts:74</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -114,7 +130,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/0593d03/src/datatypes.ts#L68">datatypes.ts:68</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L72">datatypes.ts:72</a></li>
 						</ul>
 					</aside>
 				</section>
@@ -124,7 +140,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/0593d03/src/datatypes.ts#L72">datatypes.ts:72</a></li>
+							<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L76">datatypes.ts:76</a></li>
 						</ul>
 					</aside>
 					<div class="tsd-comment tsd-typography">
@@ -159,6 +175,9 @@
 					<li class="current tsd-kind-interface tsd-parent-kind-module">
 						<a href="datatypes.AgentIngressUpdate.html" class="tsd-kind-icon">Agent<wbr>Ingress<wbr>Update</a>
 						<ul>
+							<li class=" tsd-kind-property tsd-parent-kind-interface">
+								<a href="datatypes.AgentIngressUpdate.html#certificateManagementPolicy" class="tsd-kind-icon">certificate<wbr>Management<wbr>Policy</a>
+							</li>
 							<li class=" tsd-kind-property tsd-parent-kind-interface">
 								<a href="datatypes.AgentIngressUpdate.html#description" class="tsd-kind-icon">description</a>
 							</li>