@ngrok/ngrok-api 0.13.0 → 0.17.0

package/lib/services.js

@@ -30,7 +30,7 @@ var __asyncGenerator = (this && this.__asyncGenerator) || function (thisArg, _ar
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.ReservedDomains = exports.ReservedAddrs = exports.IPRestrictions = exports.IPPolicyRules = exports.IPPolicies = exports.EventSources = exports.EventSubscriptions = exports.EventDestinations = exports.Endpoints = exports.TLSEdgeTrafficPolicyModule = exports.TLSEdgeTLSTerminationModule = exports.TLSEdgeMutualTLSModule = exports.TLSEdgeIPRestrictionModule = exports.TLSEdgeBackendModule = exports.EdgesTLS = exports.TCPEdgeTrafficPolicyModule = exports.TCPEdgeIPRestrictionModule = exports.TCPEdgeBackendModule = exports.EdgesTCP = exports.EdgeRouteTrafficPolicyModule = exports.EdgeRouteUserAgentFilterModule = exports.EdgeRouteWebsocketTCPConverterModule = exports.EdgeRouteOIDCModule = exports.EdgeRouteSAMLModule = exports.EdgeRouteOAuthModule = exports.EdgeRouteWebhookVerificationModule = exports.EdgeRouteCircuitBreakerModule = exports.EdgeRouteCompressionModule = exports.EdgeRouteResponseHeadersModule = exports.EdgeRouteRequestHeadersModule = exports.EdgeRouteIPRestrictionModule = exports.EdgeRouteBackendModule = exports.HTTPSEdgeTLSTerminationModule = exports.HTTPSEdgeMutualTLSModule = exports.EdgesHTTPS = exports.EdgesHTTPSRoutes = exports.Credentials = exports.CertificateAuthorities = exports.BotUsers = exports.WeightedBackends = exports.TunnelGroupBackends = exports.StaticBackends = exports.HTTPResponseBackends = exports.FailoverBackends = exports.TunnelSessions = exports.ApplicationUsers = exports.ApplicationSessions = exports.APIKeys = exports.AgentIngresses = exports.AbuseReports = void 0;
-exports.Tunnels = exports.TLSCertificates = exports.SSHUserCertificates = exports.SSHHostCertificates = exports.SSHCredentials = exports.SSHCertificateAuthorities = void 0;
+exports.Vaults = exports.Tunnels = exports.TLSCertificates = exports.SSHUserCertificates = exports.SSHHostCertificates = exports.SSHCredentials = exports.SSHCertificateAuthorities = exports.Secrets = void 0;
 const util = require("./util");
 /**
  * Abuse Reports allow you to submit take-down requests for URLs hosted by
@@ -3279,6 +3279,110 @@ class ReservedDomains {
     }
 }
 exports.ReservedDomains = ReservedDomains;
+/**
+ * Secrets is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.
+ */
+class Secrets {
+    /** Do not construct this object directly, use the <code>secrets</code> property of an <code>Ngrok</code> client object instead. */
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Create a new Secret
+     */
+    create(arg) {
+        return this.httpClient
+            .url(`/vault_secrets`)
+            .post(util.serializeArgument(arg))
+            .json(payload => util.deserializeResult(payload))
+            .then(f => f, util.onRejected);
+    }
+    /**
+     * Update an existing Secret by ID
+     */
+    update(arg) {
+        return this.httpClient
+            .url(`/vault_secrets/${arg.id}`)
+            .patch(util.serializeArgument(arg))
+            .json(payload => util.deserializeResult(payload))
+            .then(f => f, util.onRejected);
+    }
+    /**
+     * Delete a Secret
+     */
+    delete(id) {
+        return this.httpClient
+            .url(`/vault_secrets/${id}`)
+            .delete()
+            .res()
+            .then(f => f, util.onRejected);
+    }
+    /**
+     * Get a Secret by ID
+     */
+    get(id) {
+        return this.httpClient
+            .url(`/vault_secrets/${id}`)
+            .get()
+            .json(payload => util.deserializeResult(payload))
+            .then(f => f, util.onRejected);
+    }
+    /**
+     * List all Secrets owned by account
+     */
+    list(beforeId, limit) {
+        var e_25, _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const array = [];
+            try {
+                for (var _b = __asyncValues(this._asyncList(beforeId, limit)), _c; _c = yield _b.next(), !_c.done;) {
+                    let item = _c.value;
+                    array.push(item);
+                }
+            }
+            catch (e_25_1) { e_25 = { error: e_25_1 }; }
+            finally {
+                try {
+                    if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b);
+                }
+                finally { if (e_25) throw e_25.error; }
+            }
+            return array;
+        });
+    }
+    _pagedList(arg) {
+        return this.httpClient
+            .url(`/vault_secrets`)
+            .query(arg)
+            .get()
+            .json(payload => util.deserializeResult(payload))
+            .then(util.onFulfilled, util.onRejected);
+    }
+    _asyncList(beforeId, limit = '100') {
+        return __asyncGenerator(this, arguments, function* _asyncList_25() {
+            let nextPage = 'initial loop';
+            let page = { limit: limit };
+            if (beforeId) {
+                page.beforeId = beforeId;
+            }
+            while (nextPage) {
+                const pagedList = yield __await(this._pagedList(page));
+                nextPage = pagedList.nextPageUri;
+                const items = pagedList.secrets;
+                if (nextPage) {
+                    page = {
+                        beforeId: items[items.length - 1].id,
+                        limit: limit,
+                    };
+                }
+                for (const item of items) {
+                    yield yield __await(item);
+                }
+            }
+        });
+    }
+}
+exports.Secrets = Secrets;
 /**
  * An SSH Certificate Authority is a pair of an SSH Certificate and its private
  key that can be used to sign other SSH host and user certificates.
@@ -3322,7 +3426,7 @@ class SSHCertificateAuthorities {
      * List all SSH Certificate Authorities on this account
      */
     list(beforeId, limit) {
-        var e_25, _a;
+        var e_26, _a;
         return __awaiter(this, void 0, void 0, function* () {
             const array = [];
             try {
@@ -3331,12 +3435,12 @@ class SSHCertificateAuthorities {
                     array.push(item);
                 }
             }
-            catch (e_25_1) { e_25 = { error: e_25_1 }; }
+            catch (e_26_1) { e_26 = { error: e_26_1 }; }
             finally {
                 try {
                     if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b);
                 }
-                finally { if (e_25) throw e_25.error; }
+                finally { if (e_26) throw e_26.error; }
             }
             return array;
         });
@@ -3350,7 +3454,7 @@ class SSHCertificateAuthorities {
             .then(util.onFulfilled, util.onRejected);
     }
     _asyncList(beforeId, limit = '100') {
-        return __asyncGenerator(this, arguments, function* _asyncList_25() {
+        return __asyncGenerator(this, arguments, function* _asyncList_26() {
             let nextPage = 'initial loop';
             let page = { limit: limit };
             if (beforeId) {
@@ -3427,7 +3531,7 @@ class SSHCredentials {
      * List all ssh credentials on this account
      */
     list(beforeId, limit) {
-        var e_26, _a;
+        var e_27, _a;
         return __awaiter(this, void 0, void 0, function* () {
             const array = [];
             try {
@@ -3436,12 +3540,12 @@ class SSHCredentials {
                     array.push(item);
                 }
             }
-            catch (e_26_1) { e_26 = { error: e_26_1 }; }
+            catch (e_27_1) { e_27 = { error: e_27_1 }; }
             finally {
                 try {
                     if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b);
                 }
-                finally { if (e_26) throw e_26.error; }
+                finally { if (e_27) throw e_27.error; }
             }
             return array;
         });
@@ -3455,7 +3559,7 @@ class SSHCredentials {
             .then(util.onFulfilled, util.onRejected);
     }
     _asyncList(beforeId, limit = '100') {
-        return __asyncGenerator(this, arguments, function* _asyncList_26() {
+        return __asyncGenerator(this, arguments, function* _asyncList_27() {
             let nextPage = 'initial loop';
             let page = { limit: limit };
             if (beforeId) {
@@ -3533,7 +3637,7 @@ class SSHHostCertificates {
      * List all SSH Host Certificates issued on this account
      */
     list(beforeId, limit) {
-        var e_27, _a;
+        var e_28, _a;
         return __awaiter(this, void 0, void 0, function* () {
             const array = [];
             try {
@@ -3542,12 +3646,12 @@ class SSHHostCertificates {
                     array.push(item);
                 }
             }
-            catch (e_27_1) { e_27 = { error: e_27_1 }; }
+            catch (e_28_1) { e_28 = { error: e_28_1 }; }
             finally {
                 try {
                     if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b);
                 }
-                finally { if (e_27) throw e_27.error; }
+                finally { if (e_28) throw e_28.error; }
             }
             return array;
         });
@@ -3561,7 +3665,7 @@ class SSHHostCertificates {
             .then(util.onFulfilled, util.onRejected);
     }
     _asyncList(beforeId, limit = '100') {
-        return __asyncGenerator(this, arguments, function* _asyncList_27() {
+        return __asyncGenerator(this, arguments, function* _asyncList_28() {
             let nextPage = 'initial loop';
             let page = { limit: limit };
             if (beforeId) {
@@ -3639,7 +3743,7 @@ class SSHUserCertificates {
      * List all SSH User Certificates issued on this account
      */
     list(beforeId, limit) {
-        var e_28, _a;
+        var e_29, _a;
         return __awaiter(this, void 0, void 0, function* () {
             const array = [];
             try {
@@ -3648,12 +3752,12 @@ class SSHUserCertificates {
                     array.push(item);
                 }
             }
-            catch (e_28_1) { e_28 = { error: e_28_1 }; }
+            catch (e_29_1) { e_29 = { error: e_29_1 }; }
             finally {
                 try {
                     if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b);
                 }
-                finally { if (e_28) throw e_28.error; }
+                finally { if (e_29) throw e_29.error; }
             }
             return array;
         });
@@ -3667,7 +3771,7 @@ class SSHUserCertificates {
             .then(util.onFulfilled, util.onRejected);
     }
     _asyncList(beforeId, limit = '100') {
-        return __asyncGenerator(this, arguments, function* _asyncList_28() {
+        return __asyncGenerator(this, arguments, function* _asyncList_29() {
             let nextPage = 'initial loop';
             let page = { limit: limit };
             if (beforeId) {
@@ -3747,7 +3851,7 @@ class TLSCertificates {
      * List all TLS certificates on this account
      */
     list(beforeId, limit) {
-        var e_29, _a;
+        var e_30, _a;
         return __awaiter(this, void 0, void 0, function* () {
             const array = [];
             try {
@@ -3756,12 +3860,12 @@ class TLSCertificates {
                     array.push(item);
                 }
             }
-            catch (e_29_1) { e_29 = { error: e_29_1 }; }
+            catch (e_30_1) { e_30 = { error: e_30_1 }; }
             finally {
                 try {
                     if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b);
                 }
-                finally { if (e_29) throw e_29.error; }
+                finally { if (e_30) throw e_30.error; }
             }
             return array;
         });
@@ -3775,7 +3879,7 @@ class TLSCertificates {
             .then(util.onFulfilled, util.onRejected);
     }
     _asyncList(beforeId, limit = '100') {
-        return __asyncGenerator(this, arguments, function* _asyncList_29() {
+        return __asyncGenerator(this, arguments, function* _asyncList_30() {
             let nextPage = 'initial loop';
             let page = { limit: limit };
             if (beforeId) {
@@ -3822,7 +3926,7 @@ class Tunnels {
      * List all online tunnels currently running on the account.
      */
     list(beforeId, limit) {
-        var e_30, _a;
+        var e_31, _a;
         return __awaiter(this, void 0, void 0, function* () {
             const array = [];
             try {
@@ -3831,12 +3935,12 @@ class Tunnels {
                     array.push(item);
                 }
             }
-            catch (e_30_1) { e_30 = { error: e_30_1 }; }
+            catch (e_31_1) { e_31 = { error: e_31_1 }; }
             finally {
                 try {
                     if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b);
                 }
-                finally { if (e_30) throw e_30.error; }
+                finally { if (e_31) throw e_31.error; }
             }
             return array;
         });
@@ -3850,7 +3954,7 @@ class Tunnels {
             .then(util.onFulfilled, util.onRejected);
     }
     _asyncList(beforeId, limit = '100') {
-        return __asyncGenerator(this, arguments, function* _asyncList_30() {
+        return __asyncGenerator(this, arguments, function* _asyncList_31() {
             let nextPage = 'initial loop';
             let page = { limit: limit };
             if (beforeId) {
@@ -3884,4 +3988,164 @@ class Tunnels {
     }
 }
 exports.Tunnels = Tunnels;
+/**
+ * Vaults is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.
+ */
+class Vaults {
+    /** Do not construct this object directly, use the <code>vaults</code> property of an <code>Ngrok</code> client object instead. */
+    constructor(httpClient) {
+        this.httpClient = httpClient;
+    }
+    /**
+     * Create a new Vault
+     */
+    create(arg) {
+        return this.httpClient
+            .url(`/vaults`)
+            .post(util.serializeArgument(arg))
+            .json(payload => util.deserializeResult(payload))
+            .then(f => f, util.onRejected);
+    }
+    /**
+     * Update an existing Vault by ID
+     */
+    update(arg) {
+        return this.httpClient
+            .url(`/vaults/${arg.id}`)
+            .patch(util.serializeArgument(arg))
+            .json(payload => util.deserializeResult(payload))
+            .then(f => f, util.onRejected);
+    }
+    /**
+     * Delete a Vault
+     */
+    delete(id) {
+        return this.httpClient
+            .url(`/vaults/${id}`)
+            .delete()
+            .res()
+            .then(f => f, util.onRejected);
+    }
+    /**
+     * Get a Vault by ID
+     */
+    get(id) {
+        return this.httpClient
+            .url(`/vaults/${id}`)
+            .get()
+            .json(payload => util.deserializeResult(payload))
+            .then(f => f, util.onRejected);
+    }
+    /**
+     * Get Secrets by Vault ID
+     */
+    getSecretsByVault(id, beforeId, limit) {
+        var e_32, _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const array = [];
+            try {
+                for (var _b = __asyncValues(this._getSecretsByVault_asyncList(id, beforeId, limit)), _c; _c = yield _b.next(), !_c.done;) {
+                    let item = _c.value;
+                    array.push(item);
+                }
+            }
+            catch (e_32_1) { e_32 = { error: e_32_1 }; }
+            finally {
+                try {
+                    if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b);
+                }
+                finally { if (e_32) throw e_32.error; }
+            }
+            return array;
+        });
+    }
+    _getSecretsByVault_pagedList(arg) {
+        return this.httpClient
+            .url(`/vaults/${arg.id}/secrets`)
+            .query(arg)
+            .get()
+            .json(payload => util.deserializeResult(payload))
+            .then(util.onFulfilled, util.onRejected);
+    }
+    _getSecretsByVault_asyncList(id, beforeId, limit = '100') {
+        return __asyncGenerator(this, arguments, function* _getSecretsByVault_asyncList_1() {
+            let nextPage = 'initial loop';
+            let page = { id: id, limit: limit };
+            if (beforeId) {
+                page.beforeId = beforeId;
+            }
+            page.id = id;
+            while (nextPage) {
+                const pagedList = yield __await(this._getSecretsByVault_pagedList(page));
+                nextPage = pagedList.nextPageUri;
+                const items = pagedList.secrets;
+                if (nextPage) {
+                    page = {
+                        id: id,
+                        beforeId: items[items.length - 1].id,
+                        limit: limit,
+                    };
+                }
+                for (const item of items) {
+                    yield yield __await(item);
+                }
+            }
+        });
+    }
+    /**
+     * List all Vaults owned by account
+     */
+    list(beforeId, limit) {
+        var e_33, _a;
+        return __awaiter(this, void 0, void 0, function* () {
+            const array = [];
+            try {
+                for (var _b = __asyncValues(this._asyncList(beforeId, limit)), _c; _c = yield _b.next(), !_c.done;) {
+                    let item = _c.value;
+                    array.push(item);
+                }
+            }
+            catch (e_33_1) { e_33 = { error: e_33_1 }; }
+            finally {
+                try {
+                    if (_c && !_c.done && (_a = _b.return)) yield _a.call(_b);
+                }
+                finally { if (e_33) throw e_33.error; }
+            }
+            return array;
+        });
+    }
+    _pagedList(arg) {
+        return this.httpClient
+            .url(`/vaults`)
+            .query(arg)
+            .get()
+            .json(payload => util.deserializeResult(payload))
+            .then(util.onFulfilled, util.onRejected);
+    }
+    _asyncList(beforeId, limit = '100') {
+        return __asyncGenerator(this, arguments, function* _asyncList_32() {
+            let nextPage = 'initial loop';
+            let page = { limit: limit };
+            if (beforeId) {
+                page.beforeId = beforeId;
+            }
+            while (nextPage) {
+                const pagedList = yield __await(this._pagedList(page));
+                nextPage = pagedList.nextPageUri;
+                const items = pagedList.vaults;
+                if (nextPage) {
+                    page = {
+                        beforeId: items[items.length - 1].id,
+                        limit: limit,
+                    };
+                }
+                for (const item of items) {
+                    yield yield __await(item);
+                }
+            }
+        });
+    }
+}
+exports.Vaults = Vaults;
 //# sourceMappingURL=services.js.map