@ngrok/ngrok-api 0.13.0 → 0.16.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.
- package/.github/workflows/ci.yml +28 -0
- package/CHANGELOG.md +11 -0
- package/docs/assets/js/search.js +1 -1
- package/docs/classes/client.Ngrok.html +66 -28
- package/docs/classes/services.APIKeys.html +6 -6
- package/docs/classes/services.AbuseReports.html +3 -3
- package/docs/classes/services.AgentIngresses.html +6 -6
- package/docs/classes/services.ApplicationSessions.html +4 -4
- package/docs/classes/services.ApplicationUsers.html +4 -4
- package/docs/classes/services.BotUsers.html +6 -6
- package/docs/classes/services.CertificateAuthorities.html +6 -6
- package/docs/classes/services.Credentials.html +6 -6
- package/docs/classes/services.EdgeRouteBackendModule.html +4 -4
- package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +4 -4
- package/docs/classes/services.EdgeRouteCompressionModule.html +4 -4
- package/docs/classes/services.EdgeRouteIPRestrictionModule.html +4 -4
- package/docs/classes/services.EdgeRouteOAuthModule.html +4 -4
- package/docs/classes/services.EdgeRouteOIDCModule.html +4 -4
- package/docs/classes/services.EdgeRouteRequestHeadersModule.html +4 -4
- package/docs/classes/services.EdgeRouteResponseHeadersModule.html +4 -4
- package/docs/classes/services.EdgeRouteSAMLModule.html +4 -4
- package/docs/classes/services.EdgeRouteTrafficPolicyModule.html +4 -4
- package/docs/classes/services.EdgeRouteUserAgentFilterModule.html +4 -4
- package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +4 -4
- package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +4 -4
- package/docs/classes/services.EdgesHTTPS.html +6 -6
- package/docs/classes/services.EdgesHTTPSRoutes.html +5 -5
- package/docs/classes/services.EdgesTCP.html +6 -6
- package/docs/classes/services.EdgesTLS.html +6 -6
- package/docs/classes/services.Endpoints.html +6 -6
- package/docs/classes/services.EventDestinations.html +6 -6
- package/docs/classes/services.EventSources.html +6 -6
- package/docs/classes/services.EventSubscriptions.html +6 -6
- package/docs/classes/services.FailoverBackends.html +6 -6
- package/docs/classes/services.HTTPResponseBackends.html +6 -6
- package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +4 -4
- package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +4 -4
- package/docs/classes/services.IPPolicies.html +6 -6
- package/docs/classes/services.IPPolicyRules.html +6 -6
- package/docs/classes/services.IPRestrictions.html +6 -6
- package/docs/classes/services.ReservedAddrs.html +6 -6
- package/docs/classes/services.ReservedDomains.html +8 -8
- package/docs/classes/services.SSHCertificateAuthorities.html +6 -6
- package/docs/classes/services.SSHCredentials.html +6 -6
- package/docs/classes/services.SSHHostCertificates.html +6 -6
- package/docs/classes/services.SSHUserCertificates.html +6 -6
- package/docs/classes/services.Secrets.html +359 -0
- package/docs/classes/services.StaticBackends.html +6 -6
- package/docs/classes/services.TCPEdgeBackendModule.html +4 -4
- package/docs/classes/services.TCPEdgeIPRestrictionModule.html +4 -4
- package/docs/classes/services.TCPEdgeTrafficPolicyModule.html +4 -4
- package/docs/classes/services.TLSCertificates.html +6 -6
- package/docs/classes/services.TLSEdgeBackendModule.html +4 -4
- package/docs/classes/services.TLSEdgeIPRestrictionModule.html +4 -4
- package/docs/classes/services.TLSEdgeMutualTLSModule.html +4 -4
- package/docs/classes/services.TLSEdgeTLSTerminationModule.html +4 -4
- package/docs/classes/services.TLSEdgeTrafficPolicyModule.html +4 -4
- package/docs/classes/services.TunnelGroupBackends.html +6 -6
- package/docs/classes/services.TunnelSessions.html +6 -6
- package/docs/classes/services.Tunnels.html +3 -3
- package/docs/classes/services.Vaults.html +359 -0
- package/docs/classes/services.WeightedBackends.html +6 -6
- package/docs/interfaces/client.NgrokConfig.html +2 -2
- package/docs/interfaces/datatypes.APIKey.html +7 -7
- package/docs/interfaces/datatypes.APIKeyCreate.html +3 -3
- package/docs/interfaces/datatypes.APIKeyList.html +3 -3
- package/docs/interfaces/datatypes.APIKeyUpdate.html +3 -3
- package/docs/interfaces/datatypes.AWSAuth.html +2 -2
- package/docs/interfaces/datatypes.AWSCredentials.html +2 -2
- package/docs/interfaces/datatypes.AWSRole.html +1 -1
- package/docs/interfaces/datatypes.AbuseReport.html +7 -7
- package/docs/interfaces/datatypes.AbuseReportCreate.html +2 -2
- package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
- package/docs/interfaces/datatypes.AgentIngress.html +10 -10
- package/docs/interfaces/datatypes.AgentIngressCertJob.html +4 -4
- package/docs/interfaces/datatypes.AgentIngressCertPolicy.html +2 -2
- package/docs/interfaces/datatypes.AgentIngressCertStatus.html +2 -2
- package/docs/interfaces/datatypes.AgentIngressCreate.html +4 -4
- package/docs/interfaces/datatypes.AgentIngressList.html +3 -3
- package/docs/interfaces/datatypes.AgentIngressUpdate.html +4 -4
- package/docs/interfaces/datatypes.ApplicationSession.html +11 -11
- package/docs/interfaces/datatypes.ApplicationSessionList.html +3 -3
- package/docs/interfaces/datatypes.ApplicationUser.html +10 -10
- package/docs/interfaces/datatypes.ApplicationUserList.html +3 -3
- package/docs/interfaces/datatypes.BotUser.html +5 -5
- package/docs/interfaces/datatypes.BotUserCreate.html +2 -2
- package/docs/interfaces/datatypes.BotUserList.html +3 -3
- package/docs/interfaces/datatypes.BotUserUpdate.html +3 -3
- package/docs/interfaces/datatypes.BrowserSession.html +3 -3
- package/docs/interfaces/datatypes.CertificateAuthority.html +11 -11
- package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +3 -3
- package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.Credential.html +8 -8
- package/docs/interfaces/datatypes.CredentialCreate.html +4 -4
- package/docs/interfaces/datatypes.CredentialList.html +3 -3
- package/docs/interfaces/datatypes.CredentialUpdate.html +4 -4
- package/docs/interfaces/datatypes.EdgeBackendReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeIPRestrictionReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeMutualTLSReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteCompressionReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteItem.html +2 -2
- package/docs/interfaces/datatypes.EdgeRouteOAuthReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteRequestHeadersReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteSAMLReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteTrafficPolicyReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteUserAgentFilterReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteWebhookVerificationReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeTLSTerminationAtEdgeReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeTLSTerminationReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeTrafficPolicyReplace.html +2 -2
- package/docs/interfaces/datatypes.Endpoint.html +51 -51
- package/docs/interfaces/datatypes.EndpointBackend.html +2 -2
- package/docs/interfaces/datatypes.EndpointBackendMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
- package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
- package/docs/interfaces/datatypes.EndpointCreate.html +21 -7
- package/docs/interfaces/datatypes.EndpointIPPolicy.html +2 -2
- package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointList.html +3 -3
- package/docs/interfaces/datatypes.EndpointListArgs.html +204 -0
- package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
- package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
- package/docs/interfaces/datatypes.EndpointOAuthAmazon.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +7 -7
- package/docs/interfaces/datatypes.EndpointOAuthGitLab.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthLinkedIn.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthProvider.html +8 -8
- package/docs/interfaces/datatypes.EndpointOAuthTwitch.html +5 -5
- package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
- package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointSAML.html +15 -15
- package/docs/interfaces/datatypes.EndpointSAMLMutate.html +10 -10
- package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
- package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +2 -2
- package/docs/interfaces/datatypes.EndpointTrafficPolicy.html +2 -2
- package/docs/interfaces/datatypes.EndpointUpdate.html +20 -6
- package/docs/interfaces/datatypes.EndpointUserAgentFilter.html +3 -3
- package/docs/interfaces/datatypes.EndpointWebhookValidation.html +3 -3
- package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +1 -1
- package/docs/interfaces/datatypes.Error.html +4 -4
- package/docs/interfaces/datatypes.EventDestination.html +7 -7
- package/docs/interfaces/datatypes.EventDestinationCreate.html +4 -4
- package/docs/interfaces/datatypes.EventDestinationList.html +3 -3
- package/docs/interfaces/datatypes.EventDestinationUpdate.html +5 -5
- package/docs/interfaces/datatypes.EventSource.html +2 -2
- package/docs/interfaces/datatypes.EventSourceCreate.html +2 -2
- package/docs/interfaces/datatypes.EventSourceItem.html +2 -2
- package/docs/interfaces/datatypes.EventSourceList.html +2 -2
- package/docs/interfaces/datatypes.EventSourcePaging.html +1 -1
- package/docs/interfaces/datatypes.EventSourceReplace.html +1 -1
- package/docs/interfaces/datatypes.EventSourceUpdate.html +2 -2
- package/docs/interfaces/datatypes.EventSubscription.html +7 -7
- package/docs/interfaces/datatypes.EventSubscriptionCreate.html +4 -4
- package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
- package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +5 -5
- package/docs/interfaces/datatypes.EventTarget.html +5 -5
- package/docs/interfaces/datatypes.EventTargetAzureLogsIngestion.html +6 -6
- package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
- package/docs/interfaces/datatypes.EventTargetDatadog.html +4 -4
- package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
- package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
- package/docs/interfaces/datatypes.FailoverBackend.html +6 -6
- package/docs/interfaces/datatypes.FailoverBackendCreate.html +3 -3
- package/docs/interfaces/datatypes.FailoverBackendList.html +3 -3
- package/docs/interfaces/datatypes.FailoverBackendUpdate.html +4 -4
- package/docs/interfaces/datatypes.HTTPResponseBackend.html +8 -8
- package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +5 -5
- package/docs/interfaces/datatypes.HTTPResponseBackendList.html +3 -3
- package/docs/interfaces/datatypes.HTTPResponseBackendUpdate.html +6 -6
- package/docs/interfaces/datatypes.HTTPSEdge.html +9 -9
- package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +5 -5
- package/docs/interfaces/datatypes.HTTPSEdgeList.html +3 -3
- package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +21 -21
- package/docs/interfaces/datatypes.HTTPSEdgeRouteCreate.html +18 -18
- package/docs/interfaces/datatypes.HTTPSEdgeRouteUpdate.html +19 -19
- package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +6 -6
- package/docs/interfaces/datatypes.IPPolicy.html +5 -5
- package/docs/interfaces/datatypes.IPPolicyCreate.html +2 -2
- package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRule.html +8 -8
- package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +5 -5
- package/docs/interfaces/datatypes.IPPolicyRuleList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +4 -4
- package/docs/interfaces/datatypes.IPPolicyUpdate.html +3 -3
- package/docs/interfaces/datatypes.IPRestriction.html +8 -8
- package/docs/interfaces/datatypes.IPRestrictionCreate.html +5 -5
- package/docs/interfaces/datatypes.IPRestrictionList.html +3 -3
- package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
- package/docs/interfaces/datatypes.IdentityProvider.html +2 -2
- package/docs/interfaces/datatypes.Item.html +1 -1
- package/docs/interfaces/datatypes.Location.html +4 -4
- package/docs/interfaces/datatypes.Paging.html +2 -2
- package/docs/interfaces/datatypes.Ref.html +2 -2
- package/docs/interfaces/datatypes.ReservedAddr.html +7 -7
- package/docs/interfaces/datatypes.ReservedAddrCreate.html +3 -3
- package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
- package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomain.html +12 -12
- package/docs/interfaces/datatypes.ReservedDomainCertJob.html +4 -4
- package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
- package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +2 -2
- package/docs/interfaces/datatypes.ReservedDomainCreate.html +6 -6
- package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -5
- package/docs/interfaces/datatypes.SSHCertificateAuthority.html +7 -7
- package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +5 -5
- package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHCredential.html +8 -8
- package/docs/interfaces/datatypes.SSHCredentialCreate.html +5 -5
- package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
- package/docs/interfaces/datatypes.SSHCredentialUpdate.html +4 -4
- package/docs/interfaces/datatypes.SSHHostCertificate.html +12 -12
- package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +7 -7
- package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificate.html +14 -14
- package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +9 -9
- package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.Secret.html +338 -0
- package/docs/interfaces/datatypes.SecretCreate.html +243 -0
- package/docs/interfaces/datatypes.SecretList.html +200 -0
- package/docs/interfaces/datatypes.SecretUpdate.html +243 -0
- package/docs/interfaces/datatypes.StaticBackend.html +7 -7
- package/docs/interfaces/datatypes.StaticBackendCreate.html +4 -4
- package/docs/interfaces/datatypes.StaticBackendList.html +3 -3
- package/docs/interfaces/datatypes.StaticBackendTLS.html +1 -1
- package/docs/interfaces/datatypes.StaticBackendUpdate.html +5 -5
- package/docs/interfaces/datatypes.TCPEdge.html +9 -9
- package/docs/interfaces/datatypes.TCPEdgeCreate.html +6 -6
- package/docs/interfaces/datatypes.TCPEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TCPEdgeUpdate.html +7 -7
- package/docs/interfaces/datatypes.TLSCertificate.html +21 -21
- package/docs/interfaces/datatypes.TLSCertificateCreate.html +4 -4
- package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
- package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
- package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.TLSEdge.html +11 -11
- package/docs/interfaces/datatypes.TLSEdgeCreate.html +8 -8
- package/docs/interfaces/datatypes.TLSEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TLSEdgeUpdate.html +9 -9
- package/docs/interfaces/datatypes.Tunnel.html +11 -11
- package/docs/interfaces/datatypes.TunnelGroupBackend.html +7 -7
- package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +3 -3
- package/docs/interfaces/datatypes.TunnelGroupBackendList.html +3 -3
- package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +4 -4
- package/docs/interfaces/datatypes.TunnelList.html +3 -3
- package/docs/interfaces/datatypes.TunnelSession.html +10 -10
- package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
- package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
- package/docs/interfaces/datatypes.UserAgent.html +6 -6
- package/docs/interfaces/datatypes.Vault.html +319 -0
- package/docs/interfaces/datatypes.VaultCreate.html +205 -0
- package/docs/interfaces/datatypes.VaultList.html +200 -0
- package/docs/interfaces/datatypes.VaultUpdate.html +224 -0
- package/docs/interfaces/datatypes.WeightedBackend.html +6 -6
- package/docs/interfaces/datatypes.WeightedBackendCreate.html +3 -3
- package/docs/interfaces/datatypes.WeightedBackendList.html +3 -3
- package/docs/interfaces/datatypes.WeightedBackendUpdate.html +4 -4
- package/docs/modules/datatypes.html +36 -0
- package/docs/modules/services.html +8 -0
- package/lib/client.d.ts +8 -0
- package/lib/client.d.ts.map +1 -1
- package/lib/client.js +3 -1
- package/lib/client.js.map +1 -1
- package/lib/datatypes.d.ts +111 -5
- package/lib/datatypes.d.ts.map +1 -1
- package/lib/services.d.ts +60 -0
- package/lib/services.d.ts.map +1 -1
- package/lib/services.js +233 -25
- package/lib/services.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +11 -1
- package/src/datatypes.ts +120 -5
- package/src/services.ts +204 -2
|
@@ -0,0 +1,359 @@
|
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<html class="default no-js">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
6
|
+
<title>Vaults | @ngrok/ngrok-api</title>
|
|
7
|
+
<meta name="description" content="Documentation for @ngrok/ngrok-api">
|
|
8
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
9
|
+
<link rel="stylesheet" href="../assets/css/main.css">
|
|
10
|
+
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
11
|
+
</head>
|
|
12
|
+
<body>
|
|
13
|
+
<header>
|
|
14
|
+
<div class="tsd-page-toolbar">
|
|
15
|
+
<div class="container">
|
|
16
|
+
<div class="table-wrap">
|
|
17
|
+
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
18
|
+
<div class="field">
|
|
19
|
+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
20
|
+
<input id="tsd-search-field" type="text" />
|
|
21
|
+
</div>
|
|
22
|
+
<ul class="results">
|
|
23
|
+
<li class="state loading">Preparing search index...</li>
|
|
24
|
+
<li class="state failure">The search index is not available</li>
|
|
25
|
+
</ul>
|
|
26
|
+
<a href="../index.html" class="title">@ngrok/ngrok-api</a>
|
|
27
|
+
</div>
|
|
28
|
+
<div class="table-cell" id="tsd-widgets">
|
|
29
|
+
<div id="tsd-filter">
|
|
30
|
+
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
31
|
+
<div class="tsd-filter-group">
|
|
32
|
+
<div class="tsd-select" id="tsd-filter-visibility">
|
|
33
|
+
<span class="tsd-select-label">All</span>
|
|
34
|
+
<ul class="tsd-select-list">
|
|
35
|
+
<li data-value="public">Public</li>
|
|
36
|
+
<li data-value="protected">Public/Protected</li>
|
|
37
|
+
<li data-value="private" class="selected">All</li>
|
|
38
|
+
</ul>
|
|
39
|
+
</div>
|
|
40
|
+
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
41
|
+
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
42
|
+
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
43
|
+
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
44
|
+
</div>
|
|
45
|
+
</div>
|
|
46
|
+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
47
|
+
</div>
|
|
48
|
+
</div>
|
|
49
|
+
</div>
|
|
50
|
+
</div>
|
|
51
|
+
<div class="tsd-page-title">
|
|
52
|
+
<div class="container">
|
|
53
|
+
<ul class="tsd-breadcrumb">
|
|
54
|
+
<li>
|
|
55
|
+
<a href="../modules.html">@ngrok/ngrok-api</a>
|
|
56
|
+
</li>
|
|
57
|
+
<li>
|
|
58
|
+
<a href="../modules/services.html">services</a>
|
|
59
|
+
</li>
|
|
60
|
+
<li>
|
|
61
|
+
<a href="services.Vaults.html">Vaults</a>
|
|
62
|
+
</li>
|
|
63
|
+
</ul>
|
|
64
|
+
<h1>Class Vaults</h1>
|
|
65
|
+
</div>
|
|
66
|
+
</div>
|
|
67
|
+
</header>
|
|
68
|
+
<div class="container container-main">
|
|
69
|
+
<div class="row">
|
|
70
|
+
<div class="col-8 col-content">
|
|
71
|
+
<section class="tsd-panel tsd-comment">
|
|
72
|
+
<div class="tsd-comment tsd-typography">
|
|
73
|
+
<div class="lead">
|
|
74
|
+
<p>Vaults is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.</p>
|
|
75
|
+
</div>
|
|
76
|
+
</div>
|
|
77
|
+
</section>
|
|
78
|
+
<section class="tsd-panel tsd-hierarchy">
|
|
79
|
+
<h3>Hierarchy</h3>
|
|
80
|
+
<ul class="tsd-hierarchy">
|
|
81
|
+
<li>
|
|
82
|
+
<span class="target">Vaults</span>
|
|
83
|
+
</li>
|
|
84
|
+
</ul>
|
|
85
|
+
</section>
|
|
86
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
87
|
+
<h2>Index</h2>
|
|
88
|
+
<section class="tsd-panel tsd-index-panel">
|
|
89
|
+
<div class="tsd-index-content">
|
|
90
|
+
<section class="tsd-index-section ">
|
|
91
|
+
<h3>Constructors</h3>
|
|
92
|
+
<ul class="tsd-index-list">
|
|
93
|
+
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="services.Vaults.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
94
|
+
</ul>
|
|
95
|
+
</section>
|
|
96
|
+
<section class="tsd-index-section ">
|
|
97
|
+
<h3>Methods</h3>
|
|
98
|
+
<ul class="tsd-index-list">
|
|
99
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="services.Vaults.html#create" class="tsd-kind-icon">create</a></li>
|
|
100
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="services.Vaults.html#delete" class="tsd-kind-icon">delete</a></li>
|
|
101
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="services.Vaults.html#get" class="tsd-kind-icon">get</a></li>
|
|
102
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="services.Vaults.html#list" class="tsd-kind-icon">list</a></li>
|
|
103
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="services.Vaults.html#update" class="tsd-kind-icon">update</a></li>
|
|
104
|
+
</ul>
|
|
105
|
+
</section>
|
|
106
|
+
</div>
|
|
107
|
+
</section>
|
|
108
|
+
</section>
|
|
109
|
+
<section class="tsd-panel-group tsd-member-group ">
|
|
110
|
+
<h2>Constructors</h2>
|
|
111
|
+
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
|
112
|
+
<a name="constructor" class="tsd-anchor"></a>
|
|
113
|
+
<h3>constructor</h3>
|
|
114
|
+
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
115
|
+
<li class="tsd-signature tsd-kind-icon">new <wbr>Vaults<span class="tsd-signature-symbol">(</span>httpClient<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Wretcher</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="services.Vaults.html" class="tsd-signature-type" data-tsd-kind="Class">Vaults</a></li>
|
|
116
|
+
</ul>
|
|
117
|
+
<ul class="tsd-descriptions">
|
|
118
|
+
<li class="tsd-description">
|
|
119
|
+
<aside class="tsd-sources">
|
|
120
|
+
<ul>
|
|
121
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/services.ts#L4106">services.ts:4106</a></li>
|
|
122
|
+
</ul>
|
|
123
|
+
</aside>
|
|
124
|
+
<div class="tsd-comment tsd-typography">
|
|
125
|
+
<div class="lead">
|
|
126
|
+
<p>Do not construct this object directly, use the <code>vaults</code> property of an <code>Ngrok</code> client object instead.</p>
|
|
127
|
+
</div>
|
|
128
|
+
</div>
|
|
129
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
130
|
+
<ul class="tsd-parameters">
|
|
131
|
+
<li>
|
|
132
|
+
<h5>httpClient: <span class="tsd-signature-type">Wretcher</span></h5>
|
|
133
|
+
</li>
|
|
134
|
+
</ul>
|
|
135
|
+
<h4 class="tsd-returns-title">Returns <a href="services.Vaults.html" class="tsd-signature-type" data-tsd-kind="Class">Vaults</a></h4>
|
|
136
|
+
</li>
|
|
137
|
+
</ul>
|
|
138
|
+
</section>
|
|
139
|
+
</section>
|
|
140
|
+
<section class="tsd-panel-group tsd-member-group ">
|
|
141
|
+
<h2>Methods</h2>
|
|
142
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
143
|
+
<a name="create" class="tsd-anchor"></a>
|
|
144
|
+
<h3>create</h3>
|
|
145
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
146
|
+
<li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.VaultCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">VaultCreate</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.Vault.html" class="tsd-signature-type" data-tsd-kind="Interface">Vault</a><span class="tsd-signature-symbol">></span></li>
|
|
147
|
+
</ul>
|
|
148
|
+
<ul class="tsd-descriptions">
|
|
149
|
+
<li class="tsd-description">
|
|
150
|
+
<aside class="tsd-sources">
|
|
151
|
+
<ul>
|
|
152
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/services.ts#L4112">services.ts:4112</a></li>
|
|
153
|
+
</ul>
|
|
154
|
+
</aside>
|
|
155
|
+
<div class="tsd-comment tsd-typography">
|
|
156
|
+
<div class="lead">
|
|
157
|
+
<p>Create a new Vault</p>
|
|
158
|
+
</div>
|
|
159
|
+
</div>
|
|
160
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
161
|
+
<ul class="tsd-parameters">
|
|
162
|
+
<li>
|
|
163
|
+
<h5>arg: <a href="../interfaces/datatypes.VaultCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">VaultCreate</a></h5>
|
|
164
|
+
</li>
|
|
165
|
+
</ul>
|
|
166
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.Vault.html" class="tsd-signature-type" data-tsd-kind="Interface">Vault</a><span class="tsd-signature-symbol">></span></h4>
|
|
167
|
+
</li>
|
|
168
|
+
</ul>
|
|
169
|
+
</section>
|
|
170
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
171
|
+
<a name="delete" class="tsd-anchor"></a>
|
|
172
|
+
<h3>delete</h3>
|
|
173
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
174
|
+
<li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
175
|
+
</ul>
|
|
176
|
+
<ul class="tsd-descriptions">
|
|
177
|
+
<li class="tsd-description">
|
|
178
|
+
<aside class="tsd-sources">
|
|
179
|
+
<ul>
|
|
180
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/services.ts#L4132">services.ts:4132</a></li>
|
|
181
|
+
</ul>
|
|
182
|
+
</aside>
|
|
183
|
+
<div class="tsd-comment tsd-typography">
|
|
184
|
+
<div class="lead">
|
|
185
|
+
<p>Delete a Vault</p>
|
|
186
|
+
</div>
|
|
187
|
+
</div>
|
|
188
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
189
|
+
<ul class="tsd-parameters">
|
|
190
|
+
<li>
|
|
191
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
192
|
+
</li>
|
|
193
|
+
</ul>
|
|
194
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
195
|
+
</li>
|
|
196
|
+
</ul>
|
|
197
|
+
</section>
|
|
198
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
199
|
+
<a name="get" class="tsd-anchor"></a>
|
|
200
|
+
<h3>get</h3>
|
|
201
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
202
|
+
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>id<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.Vault.html" class="tsd-signature-type" data-tsd-kind="Interface">Vault</a><span class="tsd-signature-symbol">></span></li>
|
|
203
|
+
</ul>
|
|
204
|
+
<ul class="tsd-descriptions">
|
|
205
|
+
<li class="tsd-description">
|
|
206
|
+
<aside class="tsd-sources">
|
|
207
|
+
<ul>
|
|
208
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/services.ts#L4142">services.ts:4142</a></li>
|
|
209
|
+
</ul>
|
|
210
|
+
</aside>
|
|
211
|
+
<div class="tsd-comment tsd-typography">
|
|
212
|
+
<div class="lead">
|
|
213
|
+
<p>Get a Vault by ID</p>
|
|
214
|
+
</div>
|
|
215
|
+
</div>
|
|
216
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
217
|
+
<ul class="tsd-parameters">
|
|
218
|
+
<li>
|
|
219
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
220
|
+
</li>
|
|
221
|
+
</ul>
|
|
222
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.Vault.html" class="tsd-signature-type" data-tsd-kind="Interface">Vault</a><span class="tsd-signature-symbol">></span></h4>
|
|
223
|
+
</li>
|
|
224
|
+
</ul>
|
|
225
|
+
</section>
|
|
226
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
227
|
+
<a name="list" class="tsd-anchor"></a>
|
|
228
|
+
<h3>list</h3>
|
|
229
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
230
|
+
<li class="tsd-signature tsd-kind-icon">list<span class="tsd-signature-symbol">(</span>beforeId<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span>, limit<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.Vault.html" class="tsd-signature-type" data-tsd-kind="Interface">Vault</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
231
|
+
</ul>
|
|
232
|
+
<ul class="tsd-descriptions">
|
|
233
|
+
<li class="tsd-description">
|
|
234
|
+
<aside class="tsd-sources">
|
|
235
|
+
<ul>
|
|
236
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/services.ts#L4152">services.ts:4152</a></li>
|
|
237
|
+
</ul>
|
|
238
|
+
</aside>
|
|
239
|
+
<div class="tsd-comment tsd-typography">
|
|
240
|
+
<div class="lead">
|
|
241
|
+
<p>List all Vaults owned by account</p>
|
|
242
|
+
</div>
|
|
243
|
+
</div>
|
|
244
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
245
|
+
<ul class="tsd-parameters">
|
|
246
|
+
<li>
|
|
247
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> beforeId: <span class="tsd-signature-type">string</span></h5>
|
|
248
|
+
</li>
|
|
249
|
+
<li>
|
|
250
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">string</span></h5>
|
|
251
|
+
</li>
|
|
252
|
+
</ul>
|
|
253
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.Vault.html" class="tsd-signature-type" data-tsd-kind="Interface">Vault</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
|
254
|
+
</li>
|
|
255
|
+
</ul>
|
|
256
|
+
</section>
|
|
257
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
258
|
+
<a name="update" class="tsd-anchor"></a>
|
|
259
|
+
<h3>update</h3>
|
|
260
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
261
|
+
<li class="tsd-signature tsd-kind-icon">update<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.VaultUpdate.html" class="tsd-signature-type" data-tsd-kind="Interface">VaultUpdate</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.Vault.html" class="tsd-signature-type" data-tsd-kind="Interface">Vault</a><span class="tsd-signature-symbol">></span></li>
|
|
262
|
+
</ul>
|
|
263
|
+
<ul class="tsd-descriptions">
|
|
264
|
+
<li class="tsd-description">
|
|
265
|
+
<aside class="tsd-sources">
|
|
266
|
+
<ul>
|
|
267
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/services.ts#L4122">services.ts:4122</a></li>
|
|
268
|
+
</ul>
|
|
269
|
+
</aside>
|
|
270
|
+
<div class="tsd-comment tsd-typography">
|
|
271
|
+
<div class="lead">
|
|
272
|
+
<p>Update an existing Vault by ID</p>
|
|
273
|
+
</div>
|
|
274
|
+
</div>
|
|
275
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
276
|
+
<ul class="tsd-parameters">
|
|
277
|
+
<li>
|
|
278
|
+
<h5>arg: <a href="../interfaces/datatypes.VaultUpdate.html" class="tsd-signature-type" data-tsd-kind="Interface">VaultUpdate</a></h5>
|
|
279
|
+
</li>
|
|
280
|
+
</ul>
|
|
281
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.Vault.html" class="tsd-signature-type" data-tsd-kind="Interface">Vault</a><span class="tsd-signature-symbol">></span></h4>
|
|
282
|
+
</li>
|
|
283
|
+
</ul>
|
|
284
|
+
</section>
|
|
285
|
+
</section>
|
|
286
|
+
</div>
|
|
287
|
+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
288
|
+
<nav class="tsd-navigation primary">
|
|
289
|
+
<ul>
|
|
290
|
+
<li class=" ">
|
|
291
|
+
<a href="../modules.html">Modules</a>
|
|
292
|
+
</li>
|
|
293
|
+
<li class=" tsd-kind-module">
|
|
294
|
+
<a href="../modules/client.html">client</a>
|
|
295
|
+
</li>
|
|
296
|
+
<li class=" tsd-kind-module">
|
|
297
|
+
<a href="../modules/datatypes.html">datatypes</a>
|
|
298
|
+
</li>
|
|
299
|
+
<li class="current tsd-kind-module">
|
|
300
|
+
<a href="../modules/services.html">services</a>
|
|
301
|
+
</li>
|
|
302
|
+
</ul>
|
|
303
|
+
</nav>
|
|
304
|
+
<nav class="tsd-navigation secondary menu-sticky">
|
|
305
|
+
<ul class="before-current">
|
|
306
|
+
</ul>
|
|
307
|
+
<ul class="current">
|
|
308
|
+
<li class="current tsd-kind-class tsd-parent-kind-module">
|
|
309
|
+
<a href="services.Vaults.html" class="tsd-kind-icon">Vaults</a>
|
|
310
|
+
<ul>
|
|
311
|
+
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
312
|
+
<a href="services.Vaults.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
313
|
+
</li>
|
|
314
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
315
|
+
<a href="services.Vaults.html#create" class="tsd-kind-icon">create</a>
|
|
316
|
+
</li>
|
|
317
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
318
|
+
<a href="services.Vaults.html#delete" class="tsd-kind-icon">delete</a>
|
|
319
|
+
</li>
|
|
320
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
321
|
+
<a href="services.Vaults.html#get" class="tsd-kind-icon">get</a>
|
|
322
|
+
</li>
|
|
323
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
324
|
+
<a href="services.Vaults.html#list" class="tsd-kind-icon">list</a>
|
|
325
|
+
</li>
|
|
326
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
327
|
+
<a href="services.Vaults.html#update" class="tsd-kind-icon">update</a>
|
|
328
|
+
</li>
|
|
329
|
+
</ul>
|
|
330
|
+
</li>
|
|
331
|
+
</ul>
|
|
332
|
+
<ul class="after-current">
|
|
333
|
+
</ul>
|
|
334
|
+
</nav>
|
|
335
|
+
</div>
|
|
336
|
+
</div>
|
|
337
|
+
</div>
|
|
338
|
+
<footer class="with-border-bottom">
|
|
339
|
+
<div class="container">
|
|
340
|
+
<h2>Legend</h2>
|
|
341
|
+
<div class="tsd-legend-group">
|
|
342
|
+
<ul class="tsd-legend">
|
|
343
|
+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
344
|
+
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
345
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
346
|
+
</ul>
|
|
347
|
+
<ul class="tsd-legend">
|
|
348
|
+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
349
|
+
</ul>
|
|
350
|
+
</div>
|
|
351
|
+
</div>
|
|
352
|
+
</footer>
|
|
353
|
+
<div class="container tsd-generator">
|
|
354
|
+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
355
|
+
</div>
|
|
356
|
+
<div class="overlay"></div>
|
|
357
|
+
<script src="../assets/js/main.js"></script>
|
|
358
|
+
</body>
|
|
359
|
+
</html>
|
|
@@ -121,7 +121,7 @@
|
|
|
121
121
|
<li class="tsd-description">
|
|
122
122
|
<aside class="tsd-sources">
|
|
123
123
|
<ul>
|
|
124
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
124
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/services.ts#L934">services.ts:934</a></li>
|
|
125
125
|
</ul>
|
|
126
126
|
</aside>
|
|
127
127
|
<div class="tsd-comment tsd-typography">
|
|
@@ -152,7 +152,7 @@
|
|
|
152
152
|
<li class="tsd-description">
|
|
153
153
|
<aside class="tsd-sources">
|
|
154
154
|
<ul>
|
|
155
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
155
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/services.ts#L940">services.ts:940</a></li>
|
|
156
156
|
</ul>
|
|
157
157
|
</aside>
|
|
158
158
|
<div class="tsd-comment tsd-typography">
|
|
@@ -180,7 +180,7 @@
|
|
|
180
180
|
<li class="tsd-description">
|
|
181
181
|
<aside class="tsd-sources">
|
|
182
182
|
<ul>
|
|
183
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
183
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/services.ts#L952">services.ts:952</a></li>
|
|
184
184
|
</ul>
|
|
185
185
|
</aside>
|
|
186
186
|
<div class="tsd-comment tsd-typography">
|
|
@@ -208,7 +208,7 @@
|
|
|
208
208
|
<li class="tsd-description">
|
|
209
209
|
<aside class="tsd-sources">
|
|
210
210
|
<ul>
|
|
211
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
211
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/services.ts#L962">services.ts:962</a></li>
|
|
212
212
|
</ul>
|
|
213
213
|
</aside>
|
|
214
214
|
<div class="tsd-comment tsd-typography">
|
|
@@ -236,7 +236,7 @@
|
|
|
236
236
|
<li class="tsd-description">
|
|
237
237
|
<aside class="tsd-sources">
|
|
238
238
|
<ul>
|
|
239
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
239
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/services.ts#L972">services.ts:972</a></li>
|
|
240
240
|
</ul>
|
|
241
241
|
</aside>
|
|
242
242
|
<div class="tsd-comment tsd-typography">
|
|
@@ -267,7 +267,7 @@
|
|
|
267
267
|
<li class="tsd-description">
|
|
268
268
|
<aside class="tsd-sources">
|
|
269
269
|
<ul>
|
|
270
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
270
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/services.ts#L1022">services.ts:1022</a></li>
|
|
271
271
|
</ul>
|
|
272
272
|
</aside>
|
|
273
273
|
<div class="tsd-comment tsd-typography">
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
<div class="tsd-signature tsd-kind-icon">api<wbr>Token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
99
99
|
<aside class="tsd-sources">
|
|
100
100
|
<ul>
|
|
101
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
101
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/client.ts#L16">client.ts:16</a></li>
|
|
102
102
|
</ul>
|
|
103
103
|
</aside>
|
|
104
104
|
</section>
|
|
@@ -108,7 +108,7 @@
|
|
|
108
108
|
<div class="tsd-signature tsd-kind-icon">base<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
109
109
|
<aside class="tsd-sources">
|
|
110
110
|
<ul>
|
|
111
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
111
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/client.ts#L17">client.ts:17</a></li>
|
|
112
112
|
</ul>
|
|
113
113
|
</aside>
|
|
114
114
|
</section>
|
|
@@ -103,7 +103,7 @@
|
|
|
103
103
|
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
|
|
104
104
|
<aside class="tsd-sources">
|
|
105
105
|
<ul>
|
|
106
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
106
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L165">datatypes.ts:165</a></li>
|
|
107
107
|
</ul>
|
|
108
108
|
</aside>
|
|
109
109
|
<div class="tsd-comment tsd-typography">
|
|
@@ -118,7 +118,7 @@
|
|
|
118
118
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
119
119
|
<aside class="tsd-sources">
|
|
120
120
|
<ul>
|
|
121
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
121
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L161">datatypes.ts:161</a></li>
|
|
122
122
|
</ul>
|
|
123
123
|
</aside>
|
|
124
124
|
<div class="tsd-comment tsd-typography">
|
|
@@ -133,7 +133,7 @@
|
|
|
133
133
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
134
134
|
<aside class="tsd-sources">
|
|
135
135
|
<ul>
|
|
136
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
136
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L157">datatypes.ts:157</a></li>
|
|
137
137
|
</ul>
|
|
138
138
|
</aside>
|
|
139
139
|
<div class="tsd-comment tsd-typography">
|
|
@@ -148,7 +148,7 @@
|
|
|
148
148
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
149
149
|
<aside class="tsd-sources">
|
|
150
150
|
<ul>
|
|
151
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
151
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L163">datatypes.ts:163</a></li>
|
|
152
152
|
</ul>
|
|
153
153
|
</aside>
|
|
154
154
|
<div class="tsd-comment tsd-typography">
|
|
@@ -163,7 +163,7 @@
|
|
|
163
163
|
<div class="tsd-signature tsd-kind-icon">owner<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
164
164
|
<aside class="tsd-sources">
|
|
165
165
|
<ul>
|
|
166
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
166
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L169">datatypes.ts:169</a></li>
|
|
167
167
|
</ul>
|
|
168
168
|
</aside>
|
|
169
169
|
<div class="tsd-comment tsd-typography">
|
|
@@ -178,7 +178,7 @@
|
|
|
178
178
|
<div class="tsd-signature tsd-kind-icon">token<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
179
179
|
<aside class="tsd-sources">
|
|
180
180
|
<ul>
|
|
181
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
181
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L167">datatypes.ts:167</a></li>
|
|
182
182
|
</ul>
|
|
183
183
|
</aside>
|
|
184
184
|
<div class="tsd-comment tsd-typography">
|
|
@@ -193,7 +193,7 @@
|
|
|
193
193
|
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
194
194
|
<aside class="tsd-sources">
|
|
195
195
|
<ul>
|
|
196
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
196
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L159">datatypes.ts:159</a></li>
|
|
197
197
|
</ul>
|
|
198
198
|
</aside>
|
|
199
199
|
<div class="tsd-comment tsd-typography">
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
100
100
|
<aside class="tsd-sources">
|
|
101
101
|
<ul>
|
|
102
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
102
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L140">datatypes.ts:140</a></li>
|
|
103
103
|
</ul>
|
|
104
104
|
</aside>
|
|
105
105
|
<div class="tsd-comment tsd-typography">
|
|
@@ -114,7 +114,7 @@
|
|
|
114
114
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
115
115
|
<aside class="tsd-sources">
|
|
116
116
|
<ul>
|
|
117
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
117
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L142">datatypes.ts:142</a></li>
|
|
118
118
|
</ul>
|
|
119
119
|
</aside>
|
|
120
120
|
<div class="tsd-comment tsd-typography">
|
|
@@ -129,7 +129,7 @@
|
|
|
129
129
|
<div class="tsd-signature tsd-kind-icon">owner<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
130
130
|
<aside class="tsd-sources">
|
|
131
131
|
<ul>
|
|
132
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
132
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L144">datatypes.ts:144</a></li>
|
|
133
133
|
</ul>
|
|
134
134
|
</aside>
|
|
135
135
|
<div class="tsd-comment tsd-typography">
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
<div class="tsd-signature tsd-kind-icon">keys<span class="tsd-signature-symbol">:</span> <a href="datatypes.APIKey.html" class="tsd-signature-type" data-tsd-kind="Interface">APIKey</a><span class="tsd-signature-symbol">[]</span></div>
|
|
100
100
|
<aside class="tsd-sources">
|
|
101
101
|
<ul>
|
|
102
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
102
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L174">datatypes.ts:174</a></li>
|
|
103
103
|
</ul>
|
|
104
104
|
</aside>
|
|
105
105
|
<div class="tsd-comment tsd-typography">
|
|
@@ -114,7 +114,7 @@
|
|
|
114
114
|
<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>
|
|
115
115
|
<aside class="tsd-sources">
|
|
116
116
|
<ul>
|
|
117
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
117
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L178">datatypes.ts:178</a></li>
|
|
118
118
|
</ul>
|
|
119
119
|
</aside>
|
|
120
120
|
<div class="tsd-comment tsd-typography">
|
|
@@ -129,7 +129,7 @@
|
|
|
129
129
|
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
130
130
|
<aside class="tsd-sources">
|
|
131
131
|
<ul>
|
|
132
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
132
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L176">datatypes.ts:176</a></li>
|
|
133
133
|
</ul>
|
|
134
134
|
</aside>
|
|
135
135
|
<div class="tsd-comment tsd-typography">
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
100
100
|
<aside class="tsd-sources">
|
|
101
101
|
<ul>
|
|
102
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
102
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L150">datatypes.ts:150</a></li>
|
|
103
103
|
</ul>
|
|
104
104
|
</aside>
|
|
105
105
|
<div class="tsd-comment tsd-typography">
|
|
@@ -114,7 +114,7 @@
|
|
|
114
114
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
115
115
|
<aside class="tsd-sources">
|
|
116
116
|
<ul>
|
|
117
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
117
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L148">datatypes.ts:148</a></li>
|
|
118
118
|
</ul>
|
|
119
119
|
</aside>
|
|
120
120
|
</section>
|
|
@@ -124,7 +124,7 @@
|
|
|
124
124
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
125
125
|
<aside class="tsd-sources">
|
|
126
126
|
<ul>
|
|
127
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
127
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L152">datatypes.ts:152</a></li>
|
|
128
128
|
</ul>
|
|
129
129
|
</aside>
|
|
130
130
|
<div class="tsd-comment tsd-typography">
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
<div class="tsd-signature tsd-kind-icon">creds<span class="tsd-signature-symbol">:</span> <a href="datatypes.AWSCredentials.html" class="tsd-signature-type" data-tsd-kind="Interface">AWSCredentials</a></div>
|
|
99
99
|
<aside class="tsd-sources">
|
|
100
100
|
<ul>
|
|
101
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
101
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1653">datatypes.ts:1653</a></li>
|
|
102
102
|
</ul>
|
|
103
103
|
</aside>
|
|
104
104
|
<div class="tsd-comment tsd-typography">
|
|
@@ -113,7 +113,7 @@
|
|
|
113
113
|
<div class="tsd-signature tsd-kind-icon">role<span class="tsd-signature-symbol">:</span> <a href="datatypes.AWSRole.html" class="tsd-signature-type" data-tsd-kind="Interface">AWSRole</a></div>
|
|
114
114
|
<aside class="tsd-sources">
|
|
115
115
|
<ul>
|
|
116
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
116
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1651">datatypes.ts:1651</a></li>
|
|
117
117
|
</ul>
|
|
118
118
|
</aside>
|
|
119
119
|
<div class="tsd-comment tsd-typography">
|
|
@@ -98,7 +98,7 @@
|
|
|
98
98
|
<div class="tsd-signature tsd-kind-icon">aws<wbr>Access<wbr>Key<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
99
99
|
<aside class="tsd-sources">
|
|
100
100
|
<ul>
|
|
101
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
101
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1663">datatypes.ts:1663</a></li>
|
|
102
102
|
</ul>
|
|
103
103
|
</aside>
|
|
104
104
|
<div class="tsd-comment tsd-typography">
|
|
@@ -113,7 +113,7 @@
|
|
|
113
113
|
<div class="tsd-signature tsd-kind-icon">aws<wbr>Secret<wbr>Access<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
114
114
|
<aside class="tsd-sources">
|
|
115
115
|
<ul>
|
|
116
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
116
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/054c7e9/src/datatypes.ts#L1665">datatypes.ts:1665</a></li>
|
|
117
117
|
</ul>
|
|
118
118
|
</aside>
|
|
119
119
|
<div class="tsd-comment tsd-typography">
|