@ngrok/ngrok-api 0.2.0 → 0.3.0

package/src/services.ts

@@ -39,6 +39,104 @@ export class AbuseReports {
   }
 }
 
+export class AgentIngresses {
+  private httpClient: Wretcher;
+
+  /** Do not construct this object directly, use the <code>agentIngresses</code> property of an <code>Ngrok</code> client object instead. */
+  public constructor(httpClient: Wretcher) {
+    this.httpClient = httpClient;
+  }
+  /**
+   * Create a new Agent Ingress. The ngrok agent can be configured to connect to ngrok via the new set of addresses on the returned Agent Ingress.
+   */
+  public create(
+    arg: datatypes.AgentIngressCreate
+  ): Promise<datatypes.AgentIngress> {
+    return this.httpClient
+      .url(`/agent_ingresses`)
+      .post(util.serializeArgument(arg))
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+
+  /**
+   * Delete an Agent Ingress by ID
+   */
+  public delete(arg: datatypes.Item): Promise<void> {
+    return this.httpClient
+      .url(`/agent_ingresses/${arg.id}`)
+      .delete()
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+
+  /**
+   * Get the details of an Agent Ingress by ID.
+   */
+  public get(arg: datatypes.Item): Promise<datatypes.AgentIngress> {
+    return this.httpClient
+      .url(`/agent_ingresses/${arg.id}`)
+      .get()
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+
+  /**
+   * List all Agent Ingresses owned by this account
+   */
+  public async list(): Promise<Array<datatypes.AgentIngress>> {
+    const array: Array<datatypes.AgentIngress> = [];
+    for await (const item of this._asyncList()) {
+      array.push(item);
+    }
+    return array;
+  }
+  private _pagedList(
+    arg: datatypes.Paging
+  ): Promise<datatypes.AgentIngressList> {
+    return this.httpClient
+      .url(`/agent_ingresses`)
+      .query(arg)
+      .get()
+      .json(payload => util.deserializeResult(payload))
+      .then(util.onFulfilled, util.onRejected);
+  }
+  private async *_asyncList() {
+    const limit = '100';
+    let nextPage = 'initial loop';
+    let page: datatypes.Paging = { limit: limit };
+
+    while (nextPage) {
+      const pagedList = await this._pagedList(page);
+      nextPage = pagedList.nextPageUri;
+      const items: datatypes.AgentIngress[] = pagedList.ingresses;
+
+      if (nextPage) {
+        page = {
+          beforeId: items[items.length - 1].id,
+          limit: limit,
+        };
+      }
+
+      for (const item of items) {
+        yield item;
+      }
+    }
+  }
+  /**
+   * Update attributes of an Agent Ingress by ID.
+   */
+  public update(
+    arg: datatypes.AgentIngressUpdate
+  ): Promise<datatypes.AgentIngress> {
+    return this.httpClient
+      .url(`/agent_ingresses/${arg.id}`)
+      .patch(util.serializeArgument(arg))
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+}
+
 /**
  * API Keys are used to authenticate to the [ngrok
  API](https://ngrok.com/docs/api#authentication). You may use the API itself
@@ -1119,108 +1217,6 @@ export class IPRestrictions {
   }
 }
 
-/**
- * The IP Whitelist is deprecated and will be removed. Use an IP Restriction
- with an `endpoints` type instead.
- */
-export class IPWhitelist {
-  private httpClient: Wretcher;
-
-  /** Do not construct this object directly, use the <code>ipWhitelist</code> property of an <code>Ngrok</code> client object instead. */
-  public constructor(httpClient: Wretcher) {
-    this.httpClient = httpClient;
-  }
-  /**
-   * Create a new IP whitelist entry that will restrict traffic to all tunnel endpoints on the account.
-   */
-  public create(
-    arg: datatypes.IPWhitelistEntryCreate
-  ): Promise<datatypes.IPWhitelistEntry> {
-    return this.httpClient
-      .url(`/ip_whitelist`)
-      .post(util.serializeArgument(arg))
-      .json(payload => util.deserializeResult(payload))
-      .then(f => f, util.onRejected);
-  }
-
-  /**
-   * Delete an IP whitelist entry.
-   */
-  public delete(arg: datatypes.Item): Promise<void> {
-    return this.httpClient
-      .url(`/ip_whitelist/${arg.id}`)
-      .delete()
-      .json(payload => util.deserializeResult(payload))
-      .then(f => f, util.onRejected);
-  }
-
-  /**
-   * Get detailed information about an IP whitelist entry by ID.
-   */
-  public get(arg: datatypes.Item): Promise<datatypes.IPWhitelistEntry> {
-    return this.httpClient
-      .url(`/ip_whitelist/${arg.id}`)
-      .get()
-      .json(payload => util.deserializeResult(payload))
-      .then(f => f, util.onRejected);
-  }
-
-  /**
-   * List all IP whitelist entries on this account
-   */
-  public async list(): Promise<Array<datatypes.IPWhitelistEntry>> {
-    const array: Array<datatypes.IPWhitelistEntry> = [];
-    for await (const item of this._asyncList()) {
-      array.push(item);
-    }
-    return array;
-  }
-  private _pagedList(
-    arg: datatypes.Paging
-  ): Promise<datatypes.IPWhitelistEntryList> {
-    return this.httpClient
-      .url(`/ip_whitelist`)
-      .query(arg)
-      .get()
-      .json(payload => util.deserializeResult(payload))
-      .then(util.onFulfilled, util.onRejected);
-  }
-  private async *_asyncList() {
-    const limit = '100';
-    let nextPage = 'initial loop';
-    let page: datatypes.Paging = { limit: limit };
-
-    while (nextPage) {
-      const pagedList = await this._pagedList(page);
-      nextPage = pagedList.nextPageUri;
-      const items: datatypes.IPWhitelistEntry[] = pagedList.whitelist;
-
-      if (nextPage) {
-        page = {
-          beforeId: items[items.length - 1].id,
-          limit: limit,
-        };
-      }
-
-      for (const item of items) {
-        yield item;
-      }
-    }
-  }
-  /**
-   * Update attributes of an IP whitelist entry by ID
-   */
-  public update(
-    arg: datatypes.IPWhitelistEntryUpdate
-  ): Promise<datatypes.IPWhitelistEntry> {
-    return this.httpClient
-      .url(`/ip_whitelist/${arg.id}`)
-      .patch(util.serializeArgument(arg))
-      .json(payload => util.deserializeResult(payload))
-      .then(f => f, util.onRejected);
-  }
-}
-
 export class EndpointLoggingModule {
   private httpClient: Wretcher;
 

package/docs/interfaces/datatypes.ReservedDomainCertNSTarget.html

@@ -1,186 +0,0 @@
-<!doctype html>
-<html class="default no-js">
-<head>
-	<meta charset="utf-8">
-	<meta http-equiv="X-UA-Compatible" content="IE=edge">
-	<title>ReservedDomainCertNSTarget | @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.ReservedDomainCertNSTarget.html">ReservedDomainCertNSTarget</a>
-				</li>
-			</ul>
-			<h1>Interface ReservedDomainCertNSTarget</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">ReservedDomainCertNSTarget</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.ReservedDomainCertNSTarget.html#nameservers" class="tsd-kind-icon">nameservers</a></li>
-								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.ReservedDomainCertNSTarget.html#zone" class="tsd-kind-icon">zone</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="nameservers" class="tsd-anchor"></a>
-					<h3>nameservers</h3>
-					<div class="tsd-signature tsd-kind-icon">nameservers<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 datatypes.ts:1199</li>
-						</ul>
-					</aside>
-					<div class="tsd-comment tsd-typography">
-						<div class="lead">
-							<p>the nameservers the user must add</p>
-						</div>
-					</div>
-				</section>
-				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
-					<a name="zone" class="tsd-anchor"></a>
-					<h3>zone</h3>
-					<div class="tsd-signature tsd-kind-icon">zone<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
-					<aside class="tsd-sources">
-						<ul>
-							<li>Defined in datatypes.ts:1197</li>
-						</ul>
-					</aside>
-					<div class="tsd-comment tsd-typography">
-						<div class="lead">
-							<p>the zone that the nameservers need to be applied to</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.ReservedDomainCertNSTarget.html" class="tsd-kind-icon">Reserved<wbr>Domain<wbr>CertNSTarget</a>
-						<ul>
-							<li class=" tsd-kind-property tsd-parent-kind-interface">
-								<a href="datatypes.ReservedDomainCertNSTarget.html#nameservers" class="tsd-kind-icon">nameservers</a>
-							</li>
-							<li class=" tsd-kind-property tsd-parent-kind-interface">
-								<a href="datatypes.ReservedDomainCertNSTarget.html#zone" class="tsd-kind-icon">zone</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>