@ngrok/ngrok-api 0.13.0 → 0.17.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 +15 -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 +397 -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.ItemPaging.html +195 -0
- 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 +40 -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 +117 -5
- package/lib/datatypes.d.ts.map +1 -1
- package/lib/services.d.ts +66 -0
- package/lib/services.d.ts.map +1 -1
- package/lib/services.js +289 -25
- package/lib/services.js.map +1 -1
- package/package.json +1 -1
- package/src/client.ts +11 -1
- package/src/datatypes.ts +127 -5
- package/src/services.ts +265 -2
|
@@ -106,7 +106,7 @@
|
|
|
106
106
|
<div class="tsd-signature tsd-kind-icon">agent<wbr>Version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
107
107
|
<aside class="tsd-sources">
|
|
108
108
|
<ul>
|
|
109
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
109
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L298">datatypes.ts:298</a></li>
|
|
110
110
|
</ul>
|
|
111
111
|
</aside>
|
|
112
112
|
<div class="tsd-comment tsd-typography">
|
|
@@ -121,7 +121,7 @@
|
|
|
121
121
|
<div class="tsd-signature tsd-kind-icon">credential<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
|
|
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/b737e9b/src/datatypes.ts#L300">datatypes.ts:300</a></li>
|
|
125
125
|
</ul>
|
|
126
126
|
</aside>
|
|
127
127
|
<div class="tsd-comment tsd-typography">
|
|
@@ -136,7 +136,7 @@
|
|
|
136
136
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
137
137
|
<aside class="tsd-sources">
|
|
138
138
|
<ul>
|
|
139
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
139
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L302">datatypes.ts:302</a></li>
|
|
140
140
|
</ul>
|
|
141
141
|
</aside>
|
|
142
142
|
<div class="tsd-comment tsd-typography">
|
|
@@ -151,7 +151,7 @@
|
|
|
151
151
|
<div class="tsd-signature tsd-kind-icon">ip<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
152
152
|
<aside class="tsd-sources">
|
|
153
153
|
<ul>
|
|
154
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
154
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L304">datatypes.ts:304</a></li>
|
|
155
155
|
</ul>
|
|
156
156
|
</aside>
|
|
157
157
|
<div class="tsd-comment tsd-typography">
|
|
@@ -166,7 +166,7 @@
|
|
|
166
166
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
167
167
|
<aside class="tsd-sources">
|
|
168
168
|
<ul>
|
|
169
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
169
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L306">datatypes.ts:306</a></li>
|
|
170
170
|
</ul>
|
|
171
171
|
</aside>
|
|
172
172
|
<div class="tsd-comment tsd-typography">
|
|
@@ -181,7 +181,7 @@
|
|
|
181
181
|
<div class="tsd-signature tsd-kind-icon">os<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
182
182
|
<aside class="tsd-sources">
|
|
183
183
|
<ul>
|
|
184
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
184
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L308">datatypes.ts:308</a></li>
|
|
185
185
|
</ul>
|
|
186
186
|
</aside>
|
|
187
187
|
<div class="tsd-comment tsd-typography">
|
|
@@ -196,7 +196,7 @@
|
|
|
196
196
|
<div class="tsd-signature tsd-kind-icon">region<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
197
197
|
<aside class="tsd-sources">
|
|
198
198
|
<ul>
|
|
199
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
199
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L310">datatypes.ts:310</a></li>
|
|
200
200
|
</ul>
|
|
201
201
|
</aside>
|
|
202
202
|
<div class="tsd-comment tsd-typography">
|
|
@@ -211,7 +211,7 @@
|
|
|
211
211
|
<div class="tsd-signature tsd-kind-icon">started<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
|
|
212
212
|
<aside class="tsd-sources">
|
|
213
213
|
<ul>
|
|
214
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
214
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L312">datatypes.ts:312</a></li>
|
|
215
215
|
</ul>
|
|
216
216
|
</aside>
|
|
217
217
|
<div class="tsd-comment tsd-typography">
|
|
@@ -226,7 +226,7 @@
|
|
|
226
226
|
<div class="tsd-signature tsd-kind-icon">transport<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
227
227
|
<aside class="tsd-sources">
|
|
228
228
|
<ul>
|
|
229
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
229
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L314">datatypes.ts:314</a></li>
|
|
230
230
|
</ul>
|
|
231
231
|
</aside>
|
|
232
232
|
<div class="tsd-comment tsd-typography">
|
|
@@ -241,7 +241,7 @@
|
|
|
241
241
|
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
242
242
|
<aside class="tsd-sources">
|
|
243
243
|
<ul>
|
|
244
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
244
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L316">datatypes.ts:316</a></li>
|
|
245
245
|
</ul>
|
|
246
246
|
</aside>
|
|
247
247
|
<div class="tsd-comment tsd-typography">
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
<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>
|
|
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/b737e9b/src/datatypes.ts#L325">datatypes.ts:325</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">tunnel<wbr>Sessions<span class="tsd-signature-symbol">:</span> <a href="datatypes.TunnelSession.html" class="tsd-signature-type" data-tsd-kind="Interface">TunnelSession</a><span class="tsd-signature-symbol">[]</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/b737e9b/src/datatypes.ts#L321">datatypes.ts:321</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/b737e9b/src/datatypes.ts#L323">datatypes.ts:323</a></li>
|
|
133
133
|
</ul>
|
|
134
134
|
</aside>
|
|
135
135
|
<div class="tsd-comment tsd-typography">
|
|
@@ -97,7 +97,7 @@
|
|
|
97
97
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
98
98
|
<aside class="tsd-sources">
|
|
99
99
|
<ul>
|
|
100
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
100
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L329">datatypes.ts:329</a></li>
|
|
101
101
|
</ul>
|
|
102
102
|
</aside>
|
|
103
103
|
</section>
|
|
@@ -102,7 +102,7 @@
|
|
|
102
102
|
<div class="tsd-signature tsd-kind-icon">browser<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
103
103
|
<aside class="tsd-sources">
|
|
104
104
|
<ul>
|
|
105
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
105
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L235">datatypes.ts:235</a></li>
|
|
106
106
|
</ul>
|
|
107
107
|
</aside>
|
|
108
108
|
<div class="tsd-comment tsd-typography">
|
|
@@ -117,7 +117,7 @@
|
|
|
117
117
|
<div class="tsd-signature tsd-kind-icon">browser<wbr>Version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
118
118
|
<aside class="tsd-sources">
|
|
119
119
|
<ul>
|
|
120
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
120
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L237">datatypes.ts:237</a></li>
|
|
121
121
|
</ul>
|
|
122
122
|
</aside>
|
|
123
123
|
<div class="tsd-comment tsd-typography">
|
|
@@ -132,7 +132,7 @@
|
|
|
132
132
|
<div class="tsd-signature tsd-kind-icon">device<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
133
133
|
<aside class="tsd-sources">
|
|
134
134
|
<ul>
|
|
135
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
135
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L239">datatypes.ts:239</a></li>
|
|
136
136
|
</ul>
|
|
137
137
|
</aside>
|
|
138
138
|
<div class="tsd-comment tsd-typography">
|
|
@@ -147,7 +147,7 @@
|
|
|
147
147
|
<div class="tsd-signature tsd-kind-icon">os<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
148
148
|
<aside class="tsd-sources">
|
|
149
149
|
<ul>
|
|
150
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
150
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L241">datatypes.ts:241</a></li>
|
|
151
151
|
</ul>
|
|
152
152
|
</aside>
|
|
153
153
|
<div class="tsd-comment tsd-typography">
|
|
@@ -162,7 +162,7 @@
|
|
|
162
162
|
<div class="tsd-signature tsd-kind-icon">os<wbr>Version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
163
163
|
<aside class="tsd-sources">
|
|
164
164
|
<ul>
|
|
165
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
165
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L243">datatypes.ts:243</a></li>
|
|
166
166
|
</ul>
|
|
167
167
|
</aside>
|
|
168
168
|
<div class="tsd-comment tsd-typography">
|
|
@@ -177,7 +177,7 @@
|
|
|
177
177
|
<div class="tsd-signature tsd-kind-icon">raw<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
178
178
|
<aside class="tsd-sources">
|
|
179
179
|
<ul>
|
|
180
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
180
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L233">datatypes.ts:233</a></li>
|
|
181
181
|
</ul>
|
|
182
182
|
</aside>
|
|
183
183
|
<div class="tsd-comment tsd-typography">
|
|
@@ -0,0 +1,319 @@
|
|
|
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>Vault | @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/datatypes.html">datatypes</a>
|
|
59
|
+
</li>
|
|
60
|
+
<li>
|
|
61
|
+
<a href="datatypes.Vault.html">Vault</a>
|
|
62
|
+
</li>
|
|
63
|
+
</ul>
|
|
64
|
+
<h1>Interface Vault</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-hierarchy">
|
|
72
|
+
<h3>Hierarchy</h3>
|
|
73
|
+
<ul class="tsd-hierarchy">
|
|
74
|
+
<li>
|
|
75
|
+
<span class="target">Vault</span>
|
|
76
|
+
</li>
|
|
77
|
+
</ul>
|
|
78
|
+
</section>
|
|
79
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
80
|
+
<h2>Index</h2>
|
|
81
|
+
<section class="tsd-panel tsd-index-panel">
|
|
82
|
+
<div class="tsd-index-content">
|
|
83
|
+
<section class="tsd-index-section ">
|
|
84
|
+
<h3>Properties</h3>
|
|
85
|
+
<ul class="tsd-index-list">
|
|
86
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Vault.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
|
|
87
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Vault.html#createdBy" class="tsd-kind-icon">created<wbr>By</a></li>
|
|
88
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Vault.html#description" class="tsd-kind-icon">description</a></li>
|
|
89
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Vault.html#id" class="tsd-kind-icon">id</a></li>
|
|
90
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Vault.html#lastUpdatedBy" class="tsd-kind-icon">last<wbr>Updated<wbr>By</a></li>
|
|
91
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Vault.html#metadata" class="tsd-kind-icon">metadata</a></li>
|
|
92
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Vault.html#name" class="tsd-kind-icon">name</a></li>
|
|
93
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Vault.html#updatedAt" class="tsd-kind-icon">updated<wbr>At</a></li>
|
|
94
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Vault.html#uri" class="tsd-kind-icon">uri</a></li>
|
|
95
|
+
</ul>
|
|
96
|
+
</section>
|
|
97
|
+
</div>
|
|
98
|
+
</section>
|
|
99
|
+
</section>
|
|
100
|
+
<section class="tsd-panel-group tsd-member-group ">
|
|
101
|
+
<h2>Properties</h2>
|
|
102
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
103
|
+
<a name="createdAt" class="tsd-anchor"></a>
|
|
104
|
+
<h3>created<wbr>At</h3>
|
|
105
|
+
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
|
|
106
|
+
<aside class="tsd-sources">
|
|
107
|
+
<ul>
|
|
108
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2469">datatypes.ts:2469</a></li>
|
|
109
|
+
</ul>
|
|
110
|
+
</aside>
|
|
111
|
+
<div class="tsd-comment tsd-typography">
|
|
112
|
+
<div class="lead">
|
|
113
|
+
<p>Timestamp when the Vault was created (RFC 3339 format)</p>
|
|
114
|
+
</div>
|
|
115
|
+
</div>
|
|
116
|
+
</section>
|
|
117
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
118
|
+
<a name="createdBy" class="tsd-anchor"></a>
|
|
119
|
+
<h3>created<wbr>By</h3>
|
|
120
|
+
<div class="tsd-signature tsd-kind-icon">created<wbr>By<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
121
|
+
<aside class="tsd-sources">
|
|
122
|
+
<ul>
|
|
123
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2479">datatypes.ts:2479</a></li>
|
|
124
|
+
</ul>
|
|
125
|
+
</aside>
|
|
126
|
+
<div class="tsd-comment tsd-typography">
|
|
127
|
+
<div class="lead">
|
|
128
|
+
<p>Reference to who created this Vault</p>
|
|
129
|
+
</div>
|
|
130
|
+
</div>
|
|
131
|
+
</section>
|
|
132
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
133
|
+
<a name="description" class="tsd-anchor"></a>
|
|
134
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
|
|
135
|
+
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
136
|
+
<aside class="tsd-sources">
|
|
137
|
+
<ul>
|
|
138
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2475">datatypes.ts:2475</a></li>
|
|
139
|
+
</ul>
|
|
140
|
+
</aside>
|
|
141
|
+
<div class="tsd-comment tsd-typography">
|
|
142
|
+
<div class="lead">
|
|
143
|
+
<p>description of Vault</p>
|
|
144
|
+
</div>
|
|
145
|
+
</div>
|
|
146
|
+
</section>
|
|
147
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
148
|
+
<a name="id" class="tsd-anchor"></a>
|
|
149
|
+
<h3>id</h3>
|
|
150
|
+
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
151
|
+
<aside class="tsd-sources">
|
|
152
|
+
<ul>
|
|
153
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2465">datatypes.ts:2465</a></li>
|
|
154
|
+
</ul>
|
|
155
|
+
</aside>
|
|
156
|
+
<div class="tsd-comment tsd-typography">
|
|
157
|
+
<div class="lead">
|
|
158
|
+
<p>identifier for Vault</p>
|
|
159
|
+
</div>
|
|
160
|
+
</div>
|
|
161
|
+
</section>
|
|
162
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
163
|
+
<a name="lastUpdatedBy" class="tsd-anchor"></a>
|
|
164
|
+
<h3>last<wbr>Updated<wbr>By</h3>
|
|
165
|
+
<div class="tsd-signature tsd-kind-icon">last<wbr>Updated<wbr>By<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
166
|
+
<aside class="tsd-sources">
|
|
167
|
+
<ul>
|
|
168
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2481">datatypes.ts:2481</a></li>
|
|
169
|
+
</ul>
|
|
170
|
+
</aside>
|
|
171
|
+
<div class="tsd-comment tsd-typography">
|
|
172
|
+
<div class="lead">
|
|
173
|
+
<p>Reference to who created this Vault</p>
|
|
174
|
+
</div>
|
|
175
|
+
</div>
|
|
176
|
+
</section>
|
|
177
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
178
|
+
<a name="metadata" class="tsd-anchor"></a>
|
|
179
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
|
|
180
|
+
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
181
|
+
<aside class="tsd-sources">
|
|
182
|
+
<ul>
|
|
183
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2477">datatypes.ts:2477</a></li>
|
|
184
|
+
</ul>
|
|
185
|
+
</aside>
|
|
186
|
+
<div class="tsd-comment tsd-typography">
|
|
187
|
+
<div class="lead">
|
|
188
|
+
<p>Arbitrary user-defined metadata for this Vault</p>
|
|
189
|
+
</div>
|
|
190
|
+
</div>
|
|
191
|
+
</section>
|
|
192
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
193
|
+
<a name="name" class="tsd-anchor"></a>
|
|
194
|
+
<h3>name</h3>
|
|
195
|
+
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
196
|
+
<aside class="tsd-sources">
|
|
197
|
+
<ul>
|
|
198
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2473">datatypes.ts:2473</a></li>
|
|
199
|
+
</ul>
|
|
200
|
+
</aside>
|
|
201
|
+
<div class="tsd-comment tsd-typography">
|
|
202
|
+
<div class="lead">
|
|
203
|
+
<p>Name of vault</p>
|
|
204
|
+
</div>
|
|
205
|
+
</div>
|
|
206
|
+
</section>
|
|
207
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
208
|
+
<a name="updatedAt" class="tsd-anchor"></a>
|
|
209
|
+
<h3>updated<wbr>At</h3>
|
|
210
|
+
<div class="tsd-signature tsd-kind-icon">updated<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
|
|
211
|
+
<aside class="tsd-sources">
|
|
212
|
+
<ul>
|
|
213
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2471">datatypes.ts:2471</a></li>
|
|
214
|
+
</ul>
|
|
215
|
+
</aside>
|
|
216
|
+
<div class="tsd-comment tsd-typography">
|
|
217
|
+
<div class="lead">
|
|
218
|
+
<p>Timestamp when the Vault was last updated (RFC 3339 format)</p>
|
|
219
|
+
</div>
|
|
220
|
+
</div>
|
|
221
|
+
</section>
|
|
222
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
223
|
+
<a name="uri" class="tsd-anchor"></a>
|
|
224
|
+
<h3>uri</h3>
|
|
225
|
+
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
226
|
+
<aside class="tsd-sources">
|
|
227
|
+
<ul>
|
|
228
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2467">datatypes.ts:2467</a></li>
|
|
229
|
+
</ul>
|
|
230
|
+
</aside>
|
|
231
|
+
<div class="tsd-comment tsd-typography">
|
|
232
|
+
<div class="lead">
|
|
233
|
+
<p>URI of this Vault API resource</p>
|
|
234
|
+
</div>
|
|
235
|
+
</div>
|
|
236
|
+
</section>
|
|
237
|
+
</section>
|
|
238
|
+
</div>
|
|
239
|
+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
240
|
+
<nav class="tsd-navigation primary">
|
|
241
|
+
<ul>
|
|
242
|
+
<li class=" ">
|
|
243
|
+
<a href="../modules.html">Modules</a>
|
|
244
|
+
</li>
|
|
245
|
+
<li class=" tsd-kind-module">
|
|
246
|
+
<a href="../modules/client.html">client</a>
|
|
247
|
+
</li>
|
|
248
|
+
<li class="current tsd-kind-module">
|
|
249
|
+
<a href="../modules/datatypes.html">datatypes</a>
|
|
250
|
+
</li>
|
|
251
|
+
<li class=" tsd-kind-module">
|
|
252
|
+
<a href="../modules/services.html">services</a>
|
|
253
|
+
</li>
|
|
254
|
+
</ul>
|
|
255
|
+
</nav>
|
|
256
|
+
<nav class="tsd-navigation secondary menu-sticky">
|
|
257
|
+
<ul class="before-current">
|
|
258
|
+
</ul>
|
|
259
|
+
<ul class="current">
|
|
260
|
+
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
261
|
+
<a href="datatypes.Vault.html" class="tsd-kind-icon">Vault</a>
|
|
262
|
+
<ul>
|
|
263
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
264
|
+
<a href="datatypes.Vault.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
|
|
265
|
+
</li>
|
|
266
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
267
|
+
<a href="datatypes.Vault.html#createdBy" class="tsd-kind-icon">created<wbr>By</a>
|
|
268
|
+
</li>
|
|
269
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
270
|
+
<a href="datatypes.Vault.html#description" class="tsd-kind-icon">description</a>
|
|
271
|
+
</li>
|
|
272
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
273
|
+
<a href="datatypes.Vault.html#id" class="tsd-kind-icon">id</a>
|
|
274
|
+
</li>
|
|
275
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
276
|
+
<a href="datatypes.Vault.html#lastUpdatedBy" class="tsd-kind-icon">last<wbr>Updated<wbr>By</a>
|
|
277
|
+
</li>
|
|
278
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
279
|
+
<a href="datatypes.Vault.html#metadata" class="tsd-kind-icon">metadata</a>
|
|
280
|
+
</li>
|
|
281
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
282
|
+
<a href="datatypes.Vault.html#name" class="tsd-kind-icon">name</a>
|
|
283
|
+
</li>
|
|
284
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
285
|
+
<a href="datatypes.Vault.html#updatedAt" class="tsd-kind-icon">updated<wbr>At</a>
|
|
286
|
+
</li>
|
|
287
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
288
|
+
<a href="datatypes.Vault.html#uri" class="tsd-kind-icon">uri</a>
|
|
289
|
+
</li>
|
|
290
|
+
</ul>
|
|
291
|
+
</li>
|
|
292
|
+
</ul>
|
|
293
|
+
<ul class="after-current">
|
|
294
|
+
</ul>
|
|
295
|
+
</nav>
|
|
296
|
+
</div>
|
|
297
|
+
</div>
|
|
298
|
+
</div>
|
|
299
|
+
<footer class="with-border-bottom">
|
|
300
|
+
<div class="container">
|
|
301
|
+
<h2>Legend</h2>
|
|
302
|
+
<div class="tsd-legend-group">
|
|
303
|
+
<ul class="tsd-legend">
|
|
304
|
+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
305
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
306
|
+
</ul>
|
|
307
|
+
<ul class="tsd-legend">
|
|
308
|
+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
309
|
+
</ul>
|
|
310
|
+
</div>
|
|
311
|
+
</div>
|
|
312
|
+
</footer>
|
|
313
|
+
<div class="container tsd-generator">
|
|
314
|
+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
315
|
+
</div>
|
|
316
|
+
<div class="overlay"></div>
|
|
317
|
+
<script src="../assets/js/main.js"></script>
|
|
318
|
+
</body>
|
|
319
|
+
</html>
|