@ngrok/ngrok-api 0.2.0 → 0.3.0

package/lib/services.js

@@ -141,7 +141,6 @@ exports.Tunnels =
   exports.EndpointCompressionModule =
   exports.EndpointCircuitBreakerModule =
   exports.EndpointLoggingModule =
-  exports.IPWhitelist =
   exports.IPRestrictions =
   exports.IPPolicyRules =
   exports.IPPolicies =
@@ -153,6 +152,7 @@ exports.Tunnels =
   exports.Credentials =
   exports.CertificateAuthorities =
   exports.APIKeys =
+  exports.AgentIngresses =
   exports.AbuseReports =
     void 0;
 const util = require('./util');
@@ -187,6 +187,110 @@ class AbuseReports {
   }
 }
 exports.AbuseReports = AbuseReports;
+class AgentIngresses {
+  /** Do not construct this object directly, use the <code>agentIngresses</code> property of an <code>Ngrok</code> client object instead. */
+  constructor(httpClient) {
+    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.
+   */
+  create(arg) {
+    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
+   */
+  delete(arg) {
+    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.
+   */
+  get(arg) {
+    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
+   */
+  list() {
+    var e_1, _a;
+    return __awaiter(this, void 0, void 0, function* () {
+      const array = [];
+      try {
+        for (
+          var _b = __asyncValues(this._asyncList()), _c;
+          (_c = yield _b.next()), !_c.done;
+
+        ) {
+          let item = _c.value;
+          array.push(item);
+        }
+      } catch (e_1_1) {
+        e_1 = { error: e_1_1 };
+      } finally {
+        try {
+          if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b);
+        } finally {
+          if (e_1) throw e_1.error;
+        }
+      }
+      return array;
+    });
+  }
+  _pagedList(arg) {
+    return this.httpClient
+      .url(`/agent_ingresses`)
+      .query(arg)
+      .get()
+      .json(payload => util.deserializeResult(payload))
+      .then(util.onFulfilled, util.onRejected);
+  }
+  _asyncList() {
+    return __asyncGenerator(this, arguments, function* _asyncList_1() {
+      const limit = '100';
+      let nextPage = 'initial loop';
+      let page = { limit: limit };
+      while (nextPage) {
+        const pagedList = yield __await(this._pagedList(page));
+        nextPage = pagedList.nextPageUri;
+        const items = pagedList.ingresses;
+        if (nextPage) {
+          page = {
+            beforeId: items[items.length - 1].id,
+            limit: limit,
+          };
+        }
+        for (let item of items) {
+          yield yield __await(item);
+        }
+      }
+    });
+  }
+  /**
+   * Update attributes of an Agent Ingress by ID.
+   */
+  update(arg) {
+    return this.httpClient
+      .url(`/agent_ingresses/${arg.id}`)
+      .patch(util.serializeArgument(arg))
+      .json(payload => util.deserializeResult(payload))
+      .then(f => f, util.onRejected);
+  }
+}
+exports.AgentIngresses = AgentIngresses;
 /**
  * API Keys are used to authenticate to the [ngrok
  API](https://ngrok.com/docs/api#authentication). You may use the API itself
@@ -233,7 +337,7 @@ class APIKeys {
    * List all API keys owned by this account
    */
   list() {
-    var e_1, _a;
+    var e_2, _a;
     return __awaiter(this, void 0, void 0, function* () {
       const array = [];
       try {
@@ -245,13 +349,13 @@ class APIKeys {
           let item = _c.value;
           array.push(item);
         }
-      } catch (e_1_1) {
-        e_1 = { error: e_1_1 };
+      } catch (e_2_1) {
+        e_2 = { error: e_2_1 };
       } finally {
         try {
           if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b);
         } finally {
-          if (e_1) throw e_1.error;
+          if (e_2) throw e_2.error;
         }
       }
       return array;
@@ -266,7 +370,7 @@ class APIKeys {
       .then(util.onFulfilled, util.onRejected);
   }
   _asyncList() {
-    return __asyncGenerator(this, arguments, function* _asyncList_1() {
+    return __asyncGenerator(this, arguments, function* _asyncList_2() {
       const limit = '100';
       let nextPage = 'initial loop';
       let page = { limit: limit };
@@ -344,7 +448,7 @@ class CertificateAuthorities {
    * List all Certificate Authority on this account
    */
   list() {
-    var e_2, _a;
+    var e_3, _a;
     return __awaiter(this, void 0, void 0, function* () {
       const array = [];
       try {
@@ -356,13 +460,13 @@ class CertificateAuthorities {
           let item = _c.value;
           array.push(item);
         }
-      } catch (e_2_1) {
-        e_2 = { error: e_2_1 };
+      } catch (e_3_1) {
+        e_3 = { error: e_3_1 };
       } finally {
         try {
           if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b);
         } finally {
-          if (e_2) throw e_2.error;
+          if (e_3) throw e_3.error;
         }
       }
       return array;
@@ -377,7 +481,7 @@ class CertificateAuthorities {
       .then(util.onFulfilled, util.onRejected);
   }
   _asyncList() {
-    return __asyncGenerator(this, arguments, function* _asyncList_2() {
+    return __asyncGenerator(this, arguments, function* _asyncList_3() {
       const limit = '100';
       let nextPage = 'initial loop';
       let page = { limit: limit };
@@ -454,7 +558,7 @@ class Credentials {
    * List all tunnel authtoken credentials on this account
    */
   list() {
-    var e_3, _a;
+    var e_4, _a;
     return __awaiter(this, void 0, void 0, function* () {
       const array = [];
       try {
@@ -466,13 +570,13 @@ class Credentials {
           let item = _c.value;
           array.push(item);
         }
-      } catch (e_3_1) {
-        e_3 = { error: e_3_1 };
+      } catch (e_4_1) {
+        e_4 = { error: e_4_1 };
       } finally {
         try {
           if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b);
         } finally {
-          if (e_3) throw e_3.error;
+          if (e_4) throw e_4.error;
         }
       }
       return array;
@@ -487,7 +591,7 @@ class Credentials {
       .then(util.onFulfilled, util.onRejected);
   }
   _asyncList() {
-    return __asyncGenerator(this, arguments, function* _asyncList_3() {
+    return __asyncGenerator(this, arguments, function* _asyncList_4() {
       const limit = '100';
       let nextPage = 'initial loop';
       let page = { limit: limit };
@@ -563,7 +667,7 @@ class EndpointConfigurations {
    * Returns a list of all endpoint configurations on this account
    */
   list() {
-    var e_4, _a;
+    var e_5, _a;
     return __awaiter(this, void 0, void 0, function* () {
       const array = [];
       try {
@@ -575,13 +679,13 @@ class EndpointConfigurations {
           let item = _c.value;
           array.push(item);
         }
-      } catch (e_4_1) {
-        e_4 = { error: e_4_1 };
+      } catch (e_5_1) {
+        e_5 = { error: e_5_1 };
       } finally {
         try {
           if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b);
         } finally {
-          if (e_4) throw e_4.error;
+          if (e_5) throw e_5.error;
         }
       }
       return array;
@@ -596,7 +700,7 @@ class EndpointConfigurations {
       .then(util.onFulfilled, util.onRejected);
   }
   _asyncList() {
-    return __asyncGenerator(this, arguments, function* _asyncList_4() {
+    return __asyncGenerator(this, arguments, function* _asyncList_5() {
       const limit = '100';
       let nextPage = 'initial loop';
       let page = { limit: limit };
@@ -667,7 +771,7 @@ class EventStreams {
    * List all Event Streams available on this account.
    */
   list() {
-    var e_5, _a;
+    var e_6, _a;
     return __awaiter(this, void 0, void 0, function* () {
       const array = [];
       try {
@@ -679,13 +783,13 @@ class EventStreams {
           let item = _c.value;
           array.push(item);
         }
-      } catch (e_5_1) {
-        e_5 = { error: e_5_1 };
+      } catch (e_6_1) {
+        e_6 = { error: e_6_1 };
       } finally {
         try {
           if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b);
         } finally {
-          if (e_5) throw e_5.error;
+          if (e_6) throw e_6.error;
         }
       }
       return array;
@@ -700,7 +804,7 @@ class EventStreams {
       .then(util.onFulfilled, util.onRejected);
   }
   _asyncList() {
-    return __asyncGenerator(this, arguments, function* _asyncList_5() {
+    return __asyncGenerator(this, arguments, function* _asyncList_6() {
       const limit = '100';
       let nextPage = 'initial loop';
       let page = { limit: limit };
@@ -771,7 +875,7 @@ class EventDestinations {
    * List all Event Destinations on this account.
    */
   list() {
-    var e_6, _a;
+    var e_7, _a;
     return __awaiter(this, void 0, void 0, function* () {
       const array = [];
       try {
@@ -783,13 +887,13 @@ class EventDestinations {
           let item = _c.value;
           array.push(item);
         }
-      } catch (e_6_1) {
-        e_6 = { error: e_6_1 };
+      } catch (e_7_1) {
+        e_7 = { error: e_7_1 };
       } finally {
         try {
           if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b);
         } finally {
-          if (e_6) throw e_6.error;
+          if (e_7) throw e_7.error;
         }
       }
       return array;
@@ -804,7 +908,7 @@ class EventDestinations {
       .then(util.onFulfilled, util.onRejected);
   }
   _asyncList() {
-    return __asyncGenerator(this, arguments, function* _asyncList_6() {
+    return __asyncGenerator(this, arguments, function* _asyncList_7() {
       const limit = '100';
       let nextPage = 'initial loop';
       let page = { limit: limit };
@@ -875,7 +979,7 @@ class EventSubscriptions {
    * List this Account's Event Subscriptions.
    */
   list() {
-    var e_7, _a;
+    var e_8, _a;
     return __awaiter(this, void 0, void 0, function* () {
       const array = [];
       try {
@@ -887,13 +991,13 @@ class EventSubscriptions {
           let item = _c.value;
           array.push(item);
         }
-      } catch (e_7_1) {
-        e_7 = { error: e_7_1 };
+      } catch (e_8_1) {
+        e_8 = { error: e_8_1 };
       } finally {
         try {
           if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b);
         } finally {
-          if (e_7) throw e_7.error;
+          if (e_8) throw e_8.error;
         }
       }
       return array;
@@ -908,7 +1012,7 @@ class EventSubscriptions {
       .then(util.onFulfilled, util.onRejected);
   }
   _asyncList() {
-    return __asyncGenerator(this, arguments, function* _asyncList_7() {
+    return __asyncGenerator(this, arguments, function* _asyncList_8() {
       const limit = '100';
       let nextPage = 'initial loop';
       let page = { limit: limit };
@@ -1042,7 +1146,7 @@ class IPPolicies {
    * List all IP policies on this account
    */
   list() {
-    var e_8, _a;
+    var e_9, _a;
     return __awaiter(this, void 0, void 0, function* () {
       const array = [];
       try {
@@ -1054,13 +1158,13 @@ class IPPolicies {
           let item = _c.value;
           array.push(item);
         }
-      } catch (e_8_1) {
-        e_8 = { error: e_8_1 };
+      } catch (e_9_1) {
+        e_9 = { error: e_9_1 };
       } finally {
         try {
           if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b);
         } finally {
-          if (e_8) throw e_8.error;
+          if (e_9) throw e_9.error;
         }
       }
       return array;
@@ -1075,7 +1179,7 @@ class IPPolicies {
       .then(util.onFulfilled, util.onRejected);
   }
   _asyncList() {
-    return __asyncGenerator(this, arguments, function* _asyncList_8() {
+    return __asyncGenerator(this, arguments, function* _asyncList_9() {
       const limit = '100';
       let nextPage = 'initial loop';
       let page = { limit: limit };
@@ -1150,7 +1254,7 @@ class IPPolicyRules {
    * List all IP policy rules on this account
    */
   list() {
-    var e_9, _a;
+    var e_10, _a;
     return __awaiter(this, void 0, void 0, function* () {
       const array = [];
       try {
@@ -1162,13 +1266,13 @@ class IPPolicyRules {
           let item = _c.value;
           array.push(item);
         }
-      } catch (e_9_1) {
-        e_9 = { error: e_9_1 };
+      } catch (e_10_1) {
+        e_10 = { error: e_10_1 };
       } finally {
         try {
           if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b);
         } finally {
-          if (e_9) throw e_9.error;
+          if (e_10) throw e_10.error;
         }
       }
       return array;
@@ -1183,7 +1287,7 @@ class IPPolicyRules {
       .then(util.onFulfilled, util.onRejected);
   }
   _asyncList() {
-    return __asyncGenerator(this, arguments, function* _asyncList_9() {
+    return __asyncGenerator(this, arguments, function* _asyncList_10() {
       const limit = '100';
       let nextPage = 'initial loop';
       let page = { limit: limit };
@@ -1261,114 +1365,6 @@ class IPRestrictions {
   /**
    * List all IP restrictions on this account
    */
-  list() {
-    var e_10, _a;
-    return __awaiter(this, void 0, void 0, function* () {
-      const array = [];
-      try {
-        for (
-          var _b = __asyncValues(this._asyncList()), _c;
-          (_c = yield _b.next()), !_c.done;
-
-        ) {
-          let item = _c.value;
-          array.push(item);
-        }
-      } catch (e_10_1) {
-        e_10 = { error: e_10_1 };
-      } finally {
-        try {
-          if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b);
-        } finally {
-          if (e_10) throw e_10.error;
-        }
-      }
-      return array;
-    });
-  }
-  _pagedList(arg) {
-    return this.httpClient
-      .url(`/ip_restrictions`)
-      .query(arg)
-      .get()
-      .json(payload => util.deserializeResult(payload))
-      .then(util.onFulfilled, util.onRejected);
-  }
-  _asyncList() {
-    return __asyncGenerator(this, arguments, function* _asyncList_10() {
-      const limit = '100';
-      let nextPage = 'initial loop';
-      let page = { limit: limit };
-      while (nextPage) {
-        const pagedList = yield __await(this._pagedList(page));
-        nextPage = pagedList.nextPageUri;
-        const items = pagedList.ipRestrictions;
-        if (nextPage) {
-          page = {
-            beforeId: items[items.length - 1].id,
-            limit: limit,
-          };
-        }
-        for (let item of items) {
-          yield yield __await(item);
-        }
-      }
-    });
-  }
-  /**
-   * Update attributes of an IP restriction by ID
-   */
-  update(arg) {
-    return this.httpClient
-      .url(`/ip_restrictions/${arg.id}`)
-      .patch(util.serializeArgument(arg))
-      .json(payload => util.deserializeResult(payload))
-      .then(f => f, util.onRejected);
-  }
-}
-exports.IPRestrictions = IPRestrictions;
-/**
- * The IP Whitelist is deprecated and will be removed. Use an IP Restriction
- with an `endpoints` type instead.
- */
-class IPWhitelist {
-  /** Do not construct this object directly, use the <code>ipWhitelist</code> property of an <code>Ngrok</code> client object instead. */
-  constructor(httpClient) {
-    this.httpClient = httpClient;
-  }
-  /**
-   * Create a new IP whitelist entry that will restrict traffic to all tunnel endpoints on the account.
-   */
-  create(arg) {
-    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.
-   */
-  delete(arg) {
-    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.
-   */
-  get(arg) {
-    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
-   */
   list() {
     var e_11, _a;
     return __awaiter(this, void 0, void 0, function* () {
@@ -1396,7 +1392,7 @@ class IPWhitelist {
   }
   _pagedList(arg) {
     return this.httpClient
-      .url(`/ip_whitelist`)
+      .url(`/ip_restrictions`)
       .query(arg)
       .get()
       .json(payload => util.deserializeResult(payload))
@@ -1410,7 +1406,7 @@ class IPWhitelist {
       while (nextPage) {
         const pagedList = yield __await(this._pagedList(page));
         nextPage = pagedList.nextPageUri;
-        const items = pagedList.whitelist;
+        const items = pagedList.ipRestrictions;
         if (nextPage) {
           page = {
             beforeId: items[items.length - 1].id,
@@ -1424,17 +1420,17 @@ class IPWhitelist {
     });
   }
   /**
-   * Update attributes of an IP whitelist entry by ID
+   * Update attributes of an IP restriction by ID
    */
   update(arg) {
     return this.httpClient
-      .url(`/ip_whitelist/${arg.id}`)
+      .url(`/ip_restrictions/${arg.id}`)
       .patch(util.serializeArgument(arg))
       .json(payload => util.deserializeResult(payload))
       .then(f => f, util.onRejected);
   }
 }
-exports.IPWhitelist = IPWhitelist;
+exports.IPRestrictions = IPRestrictions;
 class EndpointLoggingModule {
   /** Do not construct this object directly, use the <code>endpointLoggingModule</code> property of an <code>Ngrok</code> client object instead. */
   constructor(httpClient) {