@ngrok/ngrok-api 0.9.0 → 0.11.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/.eslintignore +2 -0
- package/.eslintrc.js +2 -0
- package/.prettierrc.js +2 -0
- package/CHANGELOG.md +16 -3
- package/CODE_OF_CONDUCT.md +45 -0
- package/README.md +9 -3
- package/docs/assets/js/search.js +1 -1
- package/docs/classes/client.Ngrok.html +82 -28
- package/docs/classes/services.APIKeys.html +20 -11
- package/docs/classes/services.AbuseReports.html +5 -5
- package/docs/classes/services.AgentIngresses.html +20 -11
- package/docs/classes/services.ApplicationSessions.html +288 -0
- package/docs/classes/services.ApplicationUsers.html +288 -0
- package/docs/classes/services.BotUsers.html +352 -0
- package/docs/classes/services.CertificateAuthorities.html +20 -11
- package/docs/classes/services.Credentials.html +21 -12
- 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.EdgeRoutePolicyModule.html +270 -0
- 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.EdgeRouteUserAgentFilterModule.html +270 -0
- package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +4 -4
- package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +4 -4
- package/docs/classes/services.EdgesHTTPS.html +20 -11
- package/docs/classes/services.EdgesHTTPSRoutes.html +5 -5
- package/docs/classes/services.EdgesTCP.html +20 -11
- package/docs/classes/services.EdgesTLS.html +20 -11
- package/docs/classes/services.Endpoints.html +15 -6
- package/docs/classes/services.EventDestinations.html +21 -12
- package/docs/classes/services.EventSources.html +6 -6
- package/docs/classes/services.EventSubscriptions.html +20 -11
- package/docs/classes/services.FailoverBackends.html +20 -11
- package/docs/classes/services.HTTPResponseBackends.html +20 -11
- package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +8 -8
- package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +8 -8
- package/docs/classes/services.IPPolicies.html +20 -11
- package/docs/classes/services.IPPolicyRules.html +20 -11
- package/docs/classes/services.IPRestrictions.html +20 -11
- package/docs/classes/services.ReservedAddrs.html +20 -11
- package/docs/classes/services.ReservedDomains.html +26 -17
- package/docs/classes/services.SSHCertificateAuthorities.html +20 -11
- package/docs/classes/services.SSHCredentials.html +20 -11
- package/docs/classes/services.SSHHostCertificates.html +20 -11
- package/docs/classes/services.SSHUserCertificates.html +20 -11
- package/docs/classes/services.StaticBackends.html +360 -0
- package/docs/classes/services.TCPEdgeBackendModule.html +8 -8
- package/docs/classes/services.TCPEdgeIPRestrictionModule.html +8 -8
- package/docs/classes/services.TCPEdgePolicyModule.html +270 -0
- package/docs/classes/services.TLSCertificates.html +20 -11
- package/docs/classes/services.TLSEdgeBackendModule.html +8 -8
- package/docs/classes/services.TLSEdgeIPRestrictionModule.html +8 -8
- package/docs/classes/services.TLSEdgeMutualTLSModule.html +8 -8
- package/docs/classes/services.TLSEdgePolicyModule.html +270 -0
- package/docs/classes/services.TLSEdgeTLSTerminationModule.html +8 -8
- package/docs/classes/services.TunnelGroupBackends.html +20 -11
- package/docs/classes/services.TunnelSessions.html +22 -13
- package/docs/classes/services.Tunnels.html +15 -6
- package/docs/classes/services.WeightedBackends.html +20 -11
- package/docs/index.html +8 -3
- package/docs/interfaces/client.NgrokConfig.html +3 -3
- package/docs/interfaces/datatypes.APIKey.html +28 -9
- package/docs/interfaces/datatypes.APIKeyCreate.html +23 -4
- 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 +9 -9
- package/docs/interfaces/datatypes.AbuseReportCreate.html +3 -3
- package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
- package/docs/interfaces/datatypes.AgentIngress.html +49 -11
- package/docs/interfaces/datatypes.AgentIngressCertJob.html +224 -0
- package/docs/interfaces/datatypes.AgentIngressCertPolicy.html +186 -0
- package/docs/interfaces/datatypes.AgentIngressCertStatus.html +186 -0
- package/docs/interfaces/datatypes.AgentIngressCreate.html +24 -5
- package/docs/interfaces/datatypes.AgentIngressList.html +3 -3
- package/docs/interfaces/datatypes.AgentIngressUpdate.html +22 -3
- package/docs/interfaces/datatypes.ApplicationSession.html +357 -0
- package/docs/interfaces/datatypes.ApplicationSessionList.html +205 -0
- package/docs/interfaces/datatypes.ApplicationUser.html +338 -0
- package/docs/interfaces/datatypes.ApplicationUserList.html +205 -0
- package/docs/interfaces/datatypes.BotUser.html +243 -0
- package/docs/interfaces/datatypes.BotUserCreate.html +186 -0
- package/docs/interfaces/datatypes.BotUserList.html +205 -0
- package/docs/interfaces/datatypes.BotUserUpdate.html +200 -0
- package/docs/interfaces/datatypes.BrowserSession.html +205 -0
- package/docs/interfaces/datatypes.CertificateAuthority.html +16 -16
- package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +5 -5
- package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.Credential.html +30 -11
- package/docs/interfaces/datatypes.CredentialCreate.html +25 -6
- package/docs/interfaces/datatypes.CredentialList.html +3 -3
- package/docs/interfaces/datatypes.CredentialUpdate.html +5 -5
- 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.EdgePolicyReplace.html +176 -0
- 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.EdgeRoutePolicyReplace.html +190 -0
- 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.EdgeRouteUserAgentFilterReplace.html +190 -0
- 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.Endpoint.html +19 -19
- package/docs/interfaces/datatypes.EndpointAction.html +186 -0
- 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.EndpointIPPolicy.html +7 -2
- package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointList.html +3 -3
- 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 +218 -0
- package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +12 -12
- package/docs/interfaces/datatypes.EndpointOAuthGitLab.html +218 -0
- package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthLinkedIn.html +218 -0
- package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthProvider.html +80 -4
- package/docs/interfaces/datatypes.EndpointOAuthTwitch.html +218 -0
- package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
- package/docs/interfaces/datatypes.EndpointPolicy.html +205 -0
- package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointRule.html +205 -0
- 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.EndpointUserAgentFilter.html +190 -0
- package/docs/interfaces/datatypes.EndpointWebhookValidation.html +4 -4
- package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +1 -1
- package/docs/interfaces/datatypes.Error.html +4 -4
- package/docs/interfaces/datatypes.EventDestination.html +10 -10
- package/docs/interfaces/datatypes.EventDestinationCreate.html +6 -6
- 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 +10 -10
- package/docs/interfaces/datatypes.EventSubscriptionCreate.html +6 -6
- package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
- package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +5 -5
- package/docs/interfaces/datatypes.EventTarget.html +22 -3
- package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
- package/docs/interfaces/datatypes.EventTargetDatadog.html +224 -0
- package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
- package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
- package/docs/interfaces/datatypes.FailoverBackend.html +9 -9
- package/docs/interfaces/datatypes.FailoverBackendCreate.html +5 -5
- package/docs/interfaces/datatypes.FailoverBackendList.html +3 -3
- package/docs/interfaces/datatypes.FailoverBackendUpdate.html +4 -4
- package/docs/interfaces/datatypes.HTTPResponseBackend.html +11 -11
- package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +7 -7
- package/docs/interfaces/datatypes.HTTPResponseBackendList.html +3 -3
- package/docs/interfaces/datatypes.HTTPResponseBackendUpdate.html +6 -6
- package/docs/interfaces/datatypes.HTTPSEdge.html +12 -12
- package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +7 -7
- package/docs/interfaces/datatypes.HTTPSEdgeList.html +3 -3
- package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +55 -22
- package/docs/interfaces/datatypes.HTTPSEdgeRouteCreate.html +51 -18
- package/docs/interfaces/datatypes.HTTPSEdgeRouteUpdate.html +52 -19
- package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +6 -6
- package/docs/interfaces/datatypes.IPPolicy.html +8 -8
- package/docs/interfaces/datatypes.IPPolicyCreate.html +4 -4
- package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRule.html +11 -11
- package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +7 -7
- 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 +11 -11
- package/docs/interfaces/datatypes.IPRestrictionCreate.html +7 -7
- package/docs/interfaces/datatypes.IPRestrictionList.html +3 -3
- package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
- package/docs/interfaces/datatypes.IdentityProvider.html +186 -0
- package/docs/interfaces/datatypes.Item.html +1 -1
- package/docs/interfaces/datatypes.Location.html +224 -0
- package/docs/interfaces/datatypes.Paging.html +2 -2
- package/docs/interfaces/datatypes.Ref.html +2 -2
- package/docs/interfaces/datatypes.ReservedAddr.html +10 -10
- package/docs/interfaces/datatypes.ReservedAddrCreate.html +5 -5
- package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
- package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomain.html +17 -17
- package/docs/interfaces/datatypes.ReservedDomainCertJob.html +6 -6
- package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
- package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomainCreate.html +19 -19
- package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -5
- package/docs/interfaces/datatypes.SSHCertificateAuthority.html +10 -10
- package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +7 -7
- package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHCredential.html +30 -11
- package/docs/interfaces/datatypes.SSHCredentialCreate.html +26 -7
- package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
- package/docs/interfaces/datatypes.SSHCredentialUpdate.html +5 -5
- package/docs/interfaces/datatypes.SSHHostCertificate.html +17 -17
- package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +11 -11
- package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificate.html +19 -19
- package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +13 -13
- package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.StaticBackend.html +281 -0
- package/docs/interfaces/datatypes.StaticBackendCreate.html +224 -0
- package/docs/interfaces/datatypes.StaticBackendList.html +205 -0
- package/docs/interfaces/datatypes.StaticBackendTLS.html +167 -0
- package/docs/interfaces/datatypes.StaticBackendUpdate.html +238 -0
- package/docs/interfaces/datatypes.TCPEdge.html +30 -11
- package/docs/interfaces/datatypes.TCPEdgeCreate.html +26 -7
- package/docs/interfaces/datatypes.TCPEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TCPEdgeUpdate.html +25 -6
- package/docs/interfaces/datatypes.TLSCertificate.html +28 -28
- package/docs/interfaces/datatypes.TLSCertificateCreate.html +8 -8
- 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 +32 -13
- package/docs/interfaces/datatypes.TLSEdgeCreate.html +28 -9
- package/docs/interfaces/datatypes.TLSEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TLSEdgeUpdate.html +27 -8
- package/docs/interfaces/datatypes.Tunnel.html +17 -17
- package/docs/interfaces/datatypes.TunnelGroupBackend.html +10 -10
- package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +5 -5
- 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 +12 -12
- package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
- package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
- package/docs/interfaces/datatypes.UserAgent.html +262 -0
- package/docs/interfaces/datatypes.WeightedBackend.html +9 -9
- package/docs/interfaces/datatypes.WeightedBackendCreate.html +5 -5
- package/docs/interfaces/datatypes.WeightedBackendList.html +3 -3
- package/docs/interfaces/datatypes.WeightedBackendUpdate.html +4 -4
- package/docs/modules/datatypes.html +128 -0
- package/docs/modules/services.html +32 -0
- package/jest.config.js +2 -0
- package/lib/client.d.ts +17 -8
- package/lib/client.d.ts.map +1 -1
- package/lib/client.js +92 -119
- package/lib/client.js.map +1 -1
- package/lib/datatypes.d.ts +539 -204
- package/lib/datatypes.d.ts.map +1 -1
- package/lib/datatypes.js +4 -3
- package/lib/datatypes.js.map +1 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +16 -28
- package/lib/index.js.map +1 -1
- package/lib/services.d.ts +254 -126
- package/lib/services.d.ts.map +1 -1
- package/lib/services.js +3613 -3356
- package/lib/services.js.map +1 -1
- package/lib/util.d.ts.map +1 -1
- package/lib/util.js +35 -34
- package/lib/util.js.map +1 -1
- package/package.json +4 -3
- package/src/client.ts +28 -33
- package/src/datatypes.ts +576 -207
- package/src/index.ts +2 -0
- package/src/services.ts +1136 -553
- package/src/util.ts +2 -0
- package/test/apikey.test.js +62 -63
|
@@ -92,7 +92,10 @@
|
|
|
92
92
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#abuseReports" class="tsd-kind-icon">abuse<wbr>Reports</a></li>
|
|
93
93
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#agentIngresses" class="tsd-kind-icon">agent<wbr>Ingresses</a></li>
|
|
94
94
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#apiKeys" class="tsd-kind-icon">api<wbr>Keys</a></li>
|
|
95
|
+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#applicationSessions" class="tsd-kind-icon">application<wbr>Sessions</a></li>
|
|
96
|
+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#applicationUsers" class="tsd-kind-icon">application<wbr>Users</a></li>
|
|
95
97
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#backends" class="tsd-kind-icon">backends</a></li>
|
|
98
|
+
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#botUsers" class="tsd-kind-icon">bot<wbr>Users</a></li>
|
|
96
99
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#certificateAuthorities" class="tsd-kind-icon">certificate<wbr>Authorities</a></li>
|
|
97
100
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#credentials" class="tsd-kind-icon">credentials</a></li>
|
|
98
101
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#edgeModules" class="tsd-kind-icon">edge<wbr>Modules</a></li>
|
|
@@ -130,7 +133,7 @@
|
|
|
130
133
|
<li class="tsd-description">
|
|
131
134
|
<aside class="tsd-sources">
|
|
132
135
|
<ul>
|
|
133
|
-
<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/4214cc1/src/client.ts#L201">client.ts:201</a></li>
|
|
134
137
|
</ul>
|
|
135
138
|
</aside>
|
|
136
139
|
<div class="tsd-comment tsd-typography">
|
|
@@ -157,7 +160,7 @@
|
|
|
157
160
|
<div class="tsd-signature tsd-kind-icon">abuse<wbr>Reports<span class="tsd-signature-symbol">:</span> <a href="services.AbuseReports.html" class="tsd-signature-type" data-tsd-kind="Class">AbuseReports</a></div>
|
|
158
161
|
<aside class="tsd-sources">
|
|
159
162
|
<ul>
|
|
160
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
163
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L28">client.ts:28</a></li>
|
|
161
164
|
</ul>
|
|
162
165
|
</aside>
|
|
163
166
|
<div class="tsd-comment tsd-typography">
|
|
@@ -173,7 +176,7 @@
|
|
|
173
176
|
<div class="tsd-signature tsd-kind-icon">agent<wbr>Ingresses<span class="tsd-signature-symbol">:</span> <a href="services.AgentIngresses.html" class="tsd-signature-type" data-tsd-kind="Class">AgentIngresses</a></div>
|
|
174
177
|
<aside class="tsd-sources">
|
|
175
178
|
<ul>
|
|
176
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
179
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L29">client.ts:29</a></li>
|
|
177
180
|
</ul>
|
|
178
181
|
</aside>
|
|
179
182
|
</section>
|
|
@@ -183,7 +186,7 @@
|
|
|
183
186
|
<div class="tsd-signature tsd-kind-icon">api<wbr>Keys<span class="tsd-signature-symbol">:</span> <a href="services.APIKeys.html" class="tsd-signature-type" data-tsd-kind="Class">APIKeys</a></div>
|
|
184
187
|
<aside class="tsd-sources">
|
|
185
188
|
<ul>
|
|
186
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
189
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L37">client.ts:37</a></li>
|
|
187
190
|
</ul>
|
|
188
191
|
</aside>
|
|
189
192
|
<div class="tsd-comment tsd-typography">
|
|
@@ -196,13 +199,33 @@
|
|
|
196
199
|
</div>
|
|
197
200
|
</div>
|
|
198
201
|
</section>
|
|
202
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
203
|
+
<a name="applicationSessions" class="tsd-anchor"></a>
|
|
204
|
+
<h3>application<wbr>Sessions</h3>
|
|
205
|
+
<div class="tsd-signature tsd-kind-icon">application<wbr>Sessions<span class="tsd-signature-symbol">:</span> <a href="services.ApplicationSessions.html" class="tsd-signature-type" data-tsd-kind="Class">ApplicationSessions</a></div>
|
|
206
|
+
<aside class="tsd-sources">
|
|
207
|
+
<ul>
|
|
208
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L38">client.ts:38</a></li>
|
|
209
|
+
</ul>
|
|
210
|
+
</aside>
|
|
211
|
+
</section>
|
|
212
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
213
|
+
<a name="applicationUsers" class="tsd-anchor"></a>
|
|
214
|
+
<h3>application<wbr>Users</h3>
|
|
215
|
+
<div class="tsd-signature tsd-kind-icon">application<wbr>Users<span class="tsd-signature-symbol">:</span> <a href="services.ApplicationUsers.html" class="tsd-signature-type" data-tsd-kind="Class">ApplicationUsers</a></div>
|
|
216
|
+
<aside class="tsd-sources">
|
|
217
|
+
<ul>
|
|
218
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L39">client.ts:39</a></li>
|
|
219
|
+
</ul>
|
|
220
|
+
</aside>
|
|
221
|
+
</section>
|
|
199
222
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
200
223
|
<a name="backends" class="tsd-anchor"></a>
|
|
201
224
|
<h3>backends</h3>
|
|
202
|
-
<div class="tsd-signature tsd-kind-icon">backends<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>failoverBackends<span class="tsd-signature-symbol">: </span><a href="services.FailoverBackends.html" class="tsd-signature-type" data-tsd-kind="Class">FailoverBackends</a><span class="tsd-signature-symbol">; </span>httpResponseBackends<span class="tsd-signature-symbol">: </span><a href="services.HTTPResponseBackends.html" class="tsd-signature-type" data-tsd-kind="Class">HTTPResponseBackends</a><span class="tsd-signature-symbol">; </span>tunnelGroupBackends<span class="tsd-signature-symbol">: </span><a href="services.TunnelGroupBackends.html" class="tsd-signature-type" data-tsd-kind="Class">TunnelGroupBackends</a><span class="tsd-signature-symbol">; </span>weightedBackends<span class="tsd-signature-symbol">: </span><a href="services.WeightedBackends.html" class="tsd-signature-type" data-tsd-kind="Class">WeightedBackends</a><span class="tsd-signature-symbol"> }</span></div>
|
|
225
|
+
<div class="tsd-signature tsd-kind-icon">backends<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>failoverBackends<span class="tsd-signature-symbol">: </span><a href="services.FailoverBackends.html" class="tsd-signature-type" data-tsd-kind="Class">FailoverBackends</a><span class="tsd-signature-symbol">; </span>httpResponseBackends<span class="tsd-signature-symbol">: </span><a href="services.HTTPResponseBackends.html" class="tsd-signature-type" data-tsd-kind="Class">HTTPResponseBackends</a><span class="tsd-signature-symbol">; </span>staticBackends<span class="tsd-signature-symbol">: </span><a href="services.StaticBackends.html" class="tsd-signature-type" data-tsd-kind="Class">StaticBackends</a><span class="tsd-signature-symbol">; </span>tunnelGroupBackends<span class="tsd-signature-symbol">: </span><a href="services.TunnelGroupBackends.html" class="tsd-signature-type" data-tsd-kind="Class">TunnelGroupBackends</a><span class="tsd-signature-symbol">; </span>weightedBackends<span class="tsd-signature-symbol">: </span><a href="services.WeightedBackends.html" class="tsd-signature-type" data-tsd-kind="Class">WeightedBackends</a><span class="tsd-signature-symbol"> }</span></div>
|
|
203
226
|
<aside class="tsd-sources">
|
|
204
227
|
<ul>
|
|
205
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
228
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L140">client.ts:140</a></li>
|
|
206
229
|
</ul>
|
|
207
230
|
</aside>
|
|
208
231
|
<div class="tsd-type-declaration">
|
|
@@ -222,6 +245,15 @@
|
|
|
222
245
|
<li class="tsd-parameter">
|
|
223
246
|
<h5>http<wbr>Response<wbr>Backends<span class="tsd-signature-symbol">: </span><a href="services.HTTPResponseBackends.html" class="tsd-signature-type" data-tsd-kind="Class">HTTPResponseBackends</a></h5>
|
|
224
247
|
</li>
|
|
248
|
+
<li class="tsd-parameter">
|
|
249
|
+
<h5>static<wbr>Backends<span class="tsd-signature-symbol">: </span><a href="services.StaticBackends.html" class="tsd-signature-type" data-tsd-kind="Class">StaticBackends</a></h5>
|
|
250
|
+
<div class="tsd-comment tsd-typography">
|
|
251
|
+
<div class="lead">
|
|
252
|
+
<p>A static backend sends traffic to a TCP address (hostname and port) that
|
|
253
|
+
is reachable on the public internet.</p>
|
|
254
|
+
</div>
|
|
255
|
+
</div>
|
|
256
|
+
</li>
|
|
225
257
|
<li class="tsd-parameter">
|
|
226
258
|
<h5>tunnel<wbr>Group<wbr>Backends<span class="tsd-signature-symbol">: </span><a href="services.TunnelGroupBackends.html" class="tsd-signature-type" data-tsd-kind="Class">TunnelGroupBackends</a></h5>
|
|
227
259
|
<div class="tsd-comment tsd-typography">
|
|
@@ -245,13 +277,23 @@
|
|
|
245
277
|
</ul>
|
|
246
278
|
</div>
|
|
247
279
|
</section>
|
|
280
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
281
|
+
<a name="botUsers" class="tsd-anchor"></a>
|
|
282
|
+
<h3>bot<wbr>Users</h3>
|
|
283
|
+
<div class="tsd-signature tsd-kind-icon">bot<wbr>Users<span class="tsd-signature-symbol">:</span> <a href="services.BotUsers.html" class="tsd-signature-type" data-tsd-kind="Class">BotUsers</a></div>
|
|
284
|
+
<aside class="tsd-sources">
|
|
285
|
+
<ul>
|
|
286
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L46">client.ts:46</a></li>
|
|
287
|
+
</ul>
|
|
288
|
+
</aside>
|
|
289
|
+
</section>
|
|
248
290
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
249
291
|
<a name="certificateAuthorities" class="tsd-anchor"></a>
|
|
250
292
|
<h3>certificate<wbr>Authorities</h3>
|
|
251
293
|
<div class="tsd-signature tsd-kind-icon">certificate<wbr>Authorities<span class="tsd-signature-symbol">:</span> <a href="services.CertificateAuthorities.html" class="tsd-signature-type" data-tsd-kind="Class">CertificateAuthorities</a></div>
|
|
252
294
|
<aside class="tsd-sources">
|
|
253
295
|
<ul>
|
|
254
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
296
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L54">client.ts:54</a></li>
|
|
255
297
|
</ul>
|
|
256
298
|
</aside>
|
|
257
299
|
<div class="tsd-comment tsd-typography">
|
|
@@ -270,14 +312,14 @@
|
|
|
270
312
|
<div class="tsd-signature tsd-kind-icon">credentials<span class="tsd-signature-symbol">:</span> <a href="services.Credentials.html" class="tsd-signature-type" data-tsd-kind="Class">Credentials</a></div>
|
|
271
313
|
<aside class="tsd-sources">
|
|
272
314
|
<ul>
|
|
273
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
315
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L61">client.ts:61</a></li>
|
|
274
316
|
</ul>
|
|
275
317
|
</aside>
|
|
276
318
|
<div class="tsd-comment tsd-typography">
|
|
277
319
|
<div class="lead">
|
|
278
320
|
<p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok
|
|
279
321
|
agent to connect the ngrok service as your account. They are installed with
|
|
280
|
-
the <code>ngrok authtoken</code> command or by specifying it in the <code>ngrok.yml</code>
|
|
322
|
+
the <code>ngrok config add-authtoken</code> command or by specifying it in the <code>ngrok.yml</code>
|
|
281
323
|
configuration file with the <code>authtoken</code> property.</p>
|
|
282
324
|
</div>
|
|
283
325
|
</div>
|
|
@@ -285,10 +327,10 @@
|
|
|
285
327
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
286
328
|
<a name="edgeModules" class="tsd-anchor"></a>
|
|
287
329
|
<h3>edge<wbr>Modules</h3>
|
|
288
|
-
<div class="tsd-signature tsd-kind-icon">edge<wbr>Modules<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>edgeRouteBackendModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteBackendModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteBackendModule</a><span class="tsd-signature-symbol">; </span>edgeRouteCircuitBreakerModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteCircuitBreakerModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteCircuitBreakerModule</a><span class="tsd-signature-symbol">; </span>edgeRouteCompressionModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteCompressionModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteCompressionModule</a><span class="tsd-signature-symbol">; </span>edgeRouteIpRestrictionModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteIPRestrictionModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteIPRestrictionModule</a><span class="tsd-signature-symbol">; </span>edgeRouteOAuthModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteOAuthModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteOAuthModule</a><span class="tsd-signature-symbol">; </span>edgeRouteOidcModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteOIDCModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteOIDCModule</a><span class="tsd-signature-symbol">; </span>edgeRouteRequestHeadersModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteRequestHeadersModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteRequestHeadersModule</a><span class="tsd-signature-symbol">; </span>edgeRouteResponseHeadersModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteResponseHeadersModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteResponseHeadersModule</a><span class="tsd-signature-symbol">; </span>edgeRouteSamlModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteSAMLModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteSAMLModule</a><span class="tsd-signature-symbol">; </span>edgeRouteWebhookVerificationModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteWebhookVerificationModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteWebhookVerificationModule</a><span class="tsd-signature-symbol">; </span>edgeRouteWebsocketTcpConverterModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteWebsocketTCPConverterModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteWebsocketTCPConverterModule</a><span class="tsd-signature-symbol">; </span>httpsEdgeMutualTlsModule<span class="tsd-signature-symbol">: </span><a href="services.HTTPSEdgeMutualTLSModule.html" class="tsd-signature-type" data-tsd-kind="Class">HTTPSEdgeMutualTLSModule</a><span class="tsd-signature-symbol">; </span>httpsEdgeTlsTerminationModule<span class="tsd-signature-symbol">: </span><a href="services.HTTPSEdgeTLSTerminationModule.html" class="tsd-signature-type" data-tsd-kind="Class">HTTPSEdgeTLSTerminationModule</a><span class="tsd-signature-symbol">; </span>tcpEdgeBackendModule<span class="tsd-signature-symbol">: </span><a href="services.TCPEdgeBackendModule.html" class="tsd-signature-type" data-tsd-kind="Class">TCPEdgeBackendModule</a><span class="tsd-signature-symbol">; </span>tcpEdgeIpRestrictionModule<span class="tsd-signature-symbol">: </span><a href="services.TCPEdgeIPRestrictionModule.html" class="tsd-signature-type" data-tsd-kind="Class">TCPEdgeIPRestrictionModule</a><span class="tsd-signature-symbol">; </span>tlsEdgeBackendModule<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeBackendModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeBackendModule</a><span class="tsd-signature-symbol">; </span>tlsEdgeIpRestrictionModule<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeIPRestrictionModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeIPRestrictionModule</a><span class="tsd-signature-symbol">; </span>tlsEdgeMutualTlsModule<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeMutualTLSModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeMutualTLSModule</a><span class="tsd-signature-symbol">; </span>tlsEdgeTlsTerminationModule<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeTLSTerminationModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeTLSTerminationModule</a><span class="tsd-signature-symbol"> }</span></div>
|
|
330
|
+
<div class="tsd-signature tsd-kind-icon">edge<wbr>Modules<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>edgeRouteBackendModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteBackendModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteBackendModule</a><span class="tsd-signature-symbol">; </span>edgeRouteCircuitBreakerModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteCircuitBreakerModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteCircuitBreakerModule</a><span class="tsd-signature-symbol">; </span>edgeRouteCompressionModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteCompressionModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteCompressionModule</a><span class="tsd-signature-symbol">; </span>edgeRouteIpRestrictionModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteIPRestrictionModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteIPRestrictionModule</a><span class="tsd-signature-symbol">; </span>edgeRouteOAuthModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteOAuthModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteOAuthModule</a><span class="tsd-signature-symbol">; </span>edgeRouteOidcModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteOIDCModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteOIDCModule</a><span class="tsd-signature-symbol">; </span>edgeRouteRequestHeadersModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteRequestHeadersModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteRequestHeadersModule</a><span class="tsd-signature-symbol">; </span>edgeRouteResponseHeadersModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteResponseHeadersModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteResponseHeadersModule</a><span class="tsd-signature-symbol">; </span>edgeRouteSamlModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteSAMLModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteSAMLModule</a><span class="tsd-signature-symbol">; </span>edgeRouteUserAgentFilterModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteUserAgentFilterModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteUserAgentFilterModule</a><span class="tsd-signature-symbol">; </span>edgeRouteWebhookVerificationModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteWebhookVerificationModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteWebhookVerificationModule</a><span class="tsd-signature-symbol">; </span>edgeRouteWebsocketTcpConverterModule<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteWebsocketTCPConverterModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteWebsocketTCPConverterModule</a><span class="tsd-signature-symbol">; </span>httpsEdgeMutualTlsModule<span class="tsd-signature-symbol">: </span><a href="services.HTTPSEdgeMutualTLSModule.html" class="tsd-signature-type" data-tsd-kind="Class">HTTPSEdgeMutualTLSModule</a><span class="tsd-signature-symbol">; </span>httpsEdgeTlsTerminationModule<span class="tsd-signature-symbol">: </span><a href="services.HTTPSEdgeTLSTerminationModule.html" class="tsd-signature-type" data-tsd-kind="Class">HTTPSEdgeTLSTerminationModule</a><span class="tsd-signature-symbol">; </span>tcpEdgeBackendModule<span class="tsd-signature-symbol">: </span><a href="services.TCPEdgeBackendModule.html" class="tsd-signature-type" data-tsd-kind="Class">TCPEdgeBackendModule</a><span class="tsd-signature-symbol">; </span>tcpEdgeIpRestrictionModule<span class="tsd-signature-symbol">: </span><a href="services.TCPEdgeIPRestrictionModule.html" class="tsd-signature-type" data-tsd-kind="Class">TCPEdgeIPRestrictionModule</a><span class="tsd-signature-symbol">; </span>tlsEdgeBackendModule<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeBackendModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeBackendModule</a><span class="tsd-signature-symbol">; </span>tlsEdgeIpRestrictionModule<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeIPRestrictionModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeIPRestrictionModule</a><span class="tsd-signature-symbol">; </span>tlsEdgeMutualTlsModule<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeMutualTLSModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeMutualTLSModule</a><span class="tsd-signature-symbol">; </span>tlsEdgeTlsTerminationModule<span class="tsd-signature-symbol">: </span><a href="services.TLSEdgeTLSTerminationModule.html" class="tsd-signature-type" data-tsd-kind="Class">TLSEdgeTLSTerminationModule</a><span class="tsd-signature-symbol"> }</span></div>
|
|
289
331
|
<aside class="tsd-sources">
|
|
290
332
|
<ul>
|
|
291
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
333
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L173">client.ts:173</a></li>
|
|
292
334
|
</ul>
|
|
293
335
|
</aside>
|
|
294
336
|
<div class="tsd-type-declaration">
|
|
@@ -321,6 +363,9 @@
|
|
|
321
363
|
<li class="tsd-parameter">
|
|
322
364
|
<h5>edge<wbr>Route<wbr>Saml<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteSAMLModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteSAMLModule</a></h5>
|
|
323
365
|
</li>
|
|
366
|
+
<li class="tsd-parameter">
|
|
367
|
+
<h5>edge<wbr>Route<wbr>User<wbr>Agent<wbr>Filter<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteUserAgentFilterModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteUserAgentFilterModule</a></h5>
|
|
368
|
+
</li>
|
|
324
369
|
<li class="tsd-parameter">
|
|
325
370
|
<h5>edge<wbr>Route<wbr>Webhook<wbr>Verification<wbr>Module<span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteWebhookVerificationModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteWebhookVerificationModule</a></h5>
|
|
326
371
|
</li>
|
|
@@ -360,7 +405,7 @@
|
|
|
360
405
|
<div class="tsd-signature tsd-kind-icon">edges<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{ </span>edgesHttps<span class="tsd-signature-symbol">: </span><a href="services.EdgesHTTPS.html" class="tsd-signature-type" data-tsd-kind="Class">EdgesHTTPS</a><span class="tsd-signature-symbol">; </span>edgesHttpsRoutes<span class="tsd-signature-symbol">: </span><a href="services.EdgesHTTPSRoutes.html" class="tsd-signature-type" data-tsd-kind="Class">EdgesHTTPSRoutes</a><span class="tsd-signature-symbol">; </span>edgesTcp<span class="tsd-signature-symbol">: </span><a href="services.EdgesTCP.html" class="tsd-signature-type" data-tsd-kind="Class">EdgesTCP</a><span class="tsd-signature-symbol">; </span>edgesTls<span class="tsd-signature-symbol">: </span><a href="services.EdgesTLS.html" class="tsd-signature-type" data-tsd-kind="Class">EdgesTLS</a><span class="tsd-signature-symbol"> }</span></div>
|
|
361
406
|
<aside class="tsd-sources">
|
|
362
407
|
<ul>
|
|
363
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
408
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L167">client.ts:167</a></li>
|
|
364
409
|
</ul>
|
|
365
410
|
</aside>
|
|
366
411
|
<div class="tsd-type-declaration">
|
|
@@ -387,7 +432,7 @@
|
|
|
387
432
|
<div class="tsd-signature tsd-kind-icon">endpoints<span class="tsd-signature-symbol">:</span> <a href="services.Endpoints.html" class="tsd-signature-type" data-tsd-kind="Class">Endpoints</a></div>
|
|
388
433
|
<aside class="tsd-sources">
|
|
389
434
|
<ul>
|
|
390
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
435
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L67">client.ts:67</a></li>
|
|
391
436
|
</ul>
|
|
392
437
|
</aside>
|
|
393
438
|
<div class="tsd-comment tsd-typography">
|
|
@@ -404,7 +449,7 @@
|
|
|
404
449
|
<div class="tsd-signature tsd-kind-icon">event<wbr>Destinations<span class="tsd-signature-symbol">:</span> <a href="services.EventDestinations.html" class="tsd-signature-type" data-tsd-kind="Class">EventDestinations</a></div>
|
|
405
450
|
<aside class="tsd-sources">
|
|
406
451
|
<ul>
|
|
407
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
452
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L68">client.ts:68</a></li>
|
|
408
453
|
</ul>
|
|
409
454
|
</aside>
|
|
410
455
|
</section>
|
|
@@ -414,7 +459,7 @@
|
|
|
414
459
|
<div class="tsd-signature tsd-kind-icon">event<wbr>Sources<span class="tsd-signature-symbol">:</span> <a href="services.EventSources.html" class="tsd-signature-type" data-tsd-kind="Class">EventSources</a></div>
|
|
415
460
|
<aside class="tsd-sources">
|
|
416
461
|
<ul>
|
|
417
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
462
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L70">client.ts:70</a></li>
|
|
418
463
|
</ul>
|
|
419
464
|
</aside>
|
|
420
465
|
</section>
|
|
@@ -424,7 +469,7 @@
|
|
|
424
469
|
<div class="tsd-signature tsd-kind-icon">event<wbr>Subscriptions<span class="tsd-signature-symbol">:</span> <a href="services.EventSubscriptions.html" class="tsd-signature-type" data-tsd-kind="Class">EventSubscriptions</a></div>
|
|
425
470
|
<aside class="tsd-sources">
|
|
426
471
|
<ul>
|
|
427
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
472
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L69">client.ts:69</a></li>
|
|
428
473
|
</ul>
|
|
429
474
|
</aside>
|
|
430
475
|
</section>
|
|
@@ -434,7 +479,7 @@
|
|
|
434
479
|
<div class="tsd-signature tsd-kind-icon">ip<wbr>Policies<span class="tsd-signature-symbol">:</span> <a href="services.IPPolicies.html" class="tsd-signature-type" data-tsd-kind="Class">IPPolicies</a></div>
|
|
435
480
|
<aside class="tsd-sources">
|
|
436
481
|
<ul>
|
|
437
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
482
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L77">client.ts:77</a></li>
|
|
438
483
|
</ul>
|
|
439
484
|
</aside>
|
|
440
485
|
<div class="tsd-comment tsd-typography">
|
|
@@ -452,7 +497,7 @@
|
|
|
452
497
|
<div class="tsd-signature tsd-kind-icon">ip<wbr>Policy<wbr>Rules<span class="tsd-signature-symbol">:</span> <a href="services.IPPolicyRules.html" class="tsd-signature-type" data-tsd-kind="Class">IPPolicyRules</a></div>
|
|
453
498
|
<aside class="tsd-sources">
|
|
454
499
|
<ul>
|
|
455
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
500
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L82">client.ts:82</a></li>
|
|
456
501
|
</ul>
|
|
457
502
|
</aside>
|
|
458
503
|
<div class="tsd-comment tsd-typography">
|
|
@@ -468,7 +513,7 @@
|
|
|
468
513
|
<div class="tsd-signature tsd-kind-icon">ip<wbr>Restrictions<span class="tsd-signature-symbol">:</span> <a href="services.IPRestrictions.html" class="tsd-signature-type" data-tsd-kind="Class">IPRestrictions</a></div>
|
|
469
514
|
<aside class="tsd-sources">
|
|
470
515
|
<ul>
|
|
471
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
516
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L91">client.ts:91</a></li>
|
|
472
517
|
</ul>
|
|
473
518
|
</aside>
|
|
474
519
|
<div class="tsd-comment tsd-typography">
|
|
@@ -488,7 +533,7 @@
|
|
|
488
533
|
<div class="tsd-signature tsd-kind-icon">reserved<wbr>Addrs<span class="tsd-signature-symbol">:</span> <a href="services.ReservedAddrs.html" class="tsd-signature-type" data-tsd-kind="Class">ReservedAddrs</a></div>
|
|
489
534
|
<aside class="tsd-sources">
|
|
490
535
|
<ul>
|
|
491
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
536
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L97">client.ts:97</a></li>
|
|
492
537
|
</ul>
|
|
493
538
|
</aside>
|
|
494
539
|
<div class="tsd-comment tsd-typography">
|
|
@@ -505,7 +550,7 @@
|
|
|
505
550
|
<div class="tsd-signature tsd-kind-icon">reserved<wbr>Domains<span class="tsd-signature-symbol">:</span> <a href="services.ReservedDomains.html" class="tsd-signature-type" data-tsd-kind="Class">ReservedDomains</a></div>
|
|
506
551
|
<aside class="tsd-sources">
|
|
507
552
|
<ul>
|
|
508
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
553
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L104">client.ts:104</a></li>
|
|
509
554
|
</ul>
|
|
510
555
|
</aside>
|
|
511
556
|
<div class="tsd-comment tsd-typography">
|
|
@@ -523,7 +568,7 @@
|
|
|
523
568
|
<div class="tsd-signature tsd-kind-icon">ssh<wbr>Certificate<wbr>Authorities<span class="tsd-signature-symbol">:</span> <a href="services.SSHCertificateAuthorities.html" class="tsd-signature-type" data-tsd-kind="Class">SSHCertificateAuthorities</a></div>
|
|
524
569
|
<aside class="tsd-sources">
|
|
525
570
|
<ul>
|
|
526
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
571
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L109">client.ts:109</a></li>
|
|
527
572
|
</ul>
|
|
528
573
|
</aside>
|
|
529
574
|
<div class="tsd-comment tsd-typography">
|
|
@@ -539,7 +584,7 @@
|
|
|
539
584
|
<div class="tsd-signature tsd-kind-icon">ssh<wbr>Credentials<span class="tsd-signature-symbol">:</span> <a href="services.SSHCredentials.html" class="tsd-signature-type" data-tsd-kind="Class">SSHCredentials</a></div>
|
|
540
585
|
<aside class="tsd-sources">
|
|
541
586
|
<ul>
|
|
542
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
587
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L114">client.ts:114</a></li>
|
|
543
588
|
</ul>
|
|
544
589
|
</aside>
|
|
545
590
|
<div class="tsd-comment tsd-typography">
|
|
@@ -555,7 +600,7 @@
|
|
|
555
600
|
<div class="tsd-signature tsd-kind-icon">ssh<wbr>Host<wbr>Certificates<span class="tsd-signature-symbol">:</span> <a href="services.SSHHostCertificates.html" class="tsd-signature-type" data-tsd-kind="Class">SSHHostCertificates</a></div>
|
|
556
601
|
<aside class="tsd-sources">
|
|
557
602
|
<ul>
|
|
558
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
603
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L120">client.ts:120</a></li>
|
|
559
604
|
</ul>
|
|
560
605
|
</aside>
|
|
561
606
|
<div class="tsd-comment tsd-typography">
|
|
@@ -572,7 +617,7 @@
|
|
|
572
617
|
<div class="tsd-signature tsd-kind-icon">ssh<wbr>User<wbr>Certificates<span class="tsd-signature-symbol">:</span> <a href="services.SSHUserCertificates.html" class="tsd-signature-type" data-tsd-kind="Class">SSHUserCertificates</a></div>
|
|
573
618
|
<aside class="tsd-sources">
|
|
574
619
|
<ul>
|
|
575
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
620
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L126">client.ts:126</a></li>
|
|
576
621
|
</ul>
|
|
577
622
|
</aside>
|
|
578
623
|
<div class="tsd-comment tsd-typography">
|
|
@@ -589,7 +634,7 @@
|
|
|
589
634
|
<div class="tsd-signature tsd-kind-icon">tls<wbr>Certificates<span class="tsd-signature-symbol">:</span> <a href="services.TLSCertificates.html" class="tsd-signature-type" data-tsd-kind="Class">TLSCertificates</a></div>
|
|
590
635
|
<aside class="tsd-sources">
|
|
591
636
|
<ul>
|
|
592
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
637
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L134">client.ts:134</a></li>
|
|
593
638
|
</ul>
|
|
594
639
|
</aside>
|
|
595
640
|
<div class="tsd-comment tsd-typography">
|
|
@@ -608,7 +653,7 @@
|
|
|
608
653
|
<div class="tsd-signature tsd-kind-icon">tunnel<wbr>Sessions<span class="tsd-signature-symbol">:</span> <a href="services.TunnelSessions.html" class="tsd-signature-type" data-tsd-kind="Class">TunnelSessions</a></div>
|
|
609
654
|
<aside class="tsd-sources">
|
|
610
655
|
<ul>
|
|
611
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
656
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L45">client.ts:45</a></li>
|
|
612
657
|
</ul>
|
|
613
658
|
</aside>
|
|
614
659
|
<div class="tsd-comment tsd-typography">
|
|
@@ -625,7 +670,7 @@
|
|
|
625
670
|
<div class="tsd-signature tsd-kind-icon">tunnels<span class="tsd-signature-symbol">:</span> <a href="services.Tunnels.html" class="tsd-signature-type" data-tsd-kind="Class">Tunnels</a></div>
|
|
626
671
|
<aside class="tsd-sources">
|
|
627
672
|
<ul>
|
|
628
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
673
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/client.ts#L139">client.ts:139</a></li>
|
|
629
674
|
</ul>
|
|
630
675
|
</aside>
|
|
631
676
|
<div class="tsd-comment tsd-typography">
|
|
@@ -673,9 +718,18 @@
|
|
|
673
718
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
674
719
|
<a href="client.Ngrok.html#apiKeys" class="tsd-kind-icon">api<wbr>Keys</a>
|
|
675
720
|
</li>
|
|
721
|
+
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
722
|
+
<a href="client.Ngrok.html#applicationSessions" class="tsd-kind-icon">application<wbr>Sessions</a>
|
|
723
|
+
</li>
|
|
724
|
+
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
725
|
+
<a href="client.Ngrok.html#applicationUsers" class="tsd-kind-icon">application<wbr>Users</a>
|
|
726
|
+
</li>
|
|
676
727
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
677
728
|
<a href="client.Ngrok.html#backends" class="tsd-kind-icon">backends</a>
|
|
678
729
|
</li>
|
|
730
|
+
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
731
|
+
<a href="client.Ngrok.html#botUsers" class="tsd-kind-icon">bot<wbr>Users</a>
|
|
732
|
+
</li>
|
|
679
733
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
680
734
|
<a href="client.Ngrok.html#certificateAuthorities" class="tsd-kind-icon">certificate<wbr>Authorities</a>
|
|
681
735
|
</li>
|
|
@@ -122,7 +122,7 @@
|
|
|
122
122
|
<li class="tsd-description">
|
|
123
123
|
<aside class="tsd-sources">
|
|
124
124
|
<ul>
|
|
125
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
125
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/services.ts#L157">services.ts:157</a></li>
|
|
126
126
|
</ul>
|
|
127
127
|
</aside>
|
|
128
128
|
<div class="tsd-comment tsd-typography">
|
|
@@ -153,7 +153,7 @@
|
|
|
153
153
|
<li class="tsd-description">
|
|
154
154
|
<aside class="tsd-sources">
|
|
155
155
|
<ul>
|
|
156
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
156
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/services.ts#L163">services.ts:163</a></li>
|
|
157
157
|
</ul>
|
|
158
158
|
</aside>
|
|
159
159
|
<div class="tsd-comment tsd-typography">
|
|
@@ -175,13 +175,13 @@
|
|
|
175
175
|
<a name="delete" class="tsd-anchor"></a>
|
|
176
176
|
<h3>delete</h3>
|
|
177
177
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
178
|
-
<li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>
|
|
178
|
+
<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>
|
|
179
179
|
</ul>
|
|
180
180
|
<ul class="tsd-descriptions">
|
|
181
181
|
<li class="tsd-description">
|
|
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/4214cc1/src/services.ts#L173">services.ts:173</a></li>
|
|
185
185
|
</ul>
|
|
186
186
|
</aside>
|
|
187
187
|
<div class="tsd-comment tsd-typography">
|
|
@@ -192,7 +192,7 @@
|
|
|
192
192
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
193
193
|
<ul class="tsd-parameters">
|
|
194
194
|
<li>
|
|
195
|
-
<h5>
|
|
195
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
196
196
|
</li>
|
|
197
197
|
</ul>
|
|
198
198
|
<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>
|
|
@@ -203,13 +203,13 @@
|
|
|
203
203
|
<a name="get" class="tsd-anchor"></a>
|
|
204
204
|
<h3>get</h3>
|
|
205
205
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
206
|
-
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>
|
|
206
|
+
<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.APIKey.html" class="tsd-signature-type" data-tsd-kind="Interface">APIKey</a><span class="tsd-signature-symbol">></span></li>
|
|
207
207
|
</ul>
|
|
208
208
|
<ul class="tsd-descriptions">
|
|
209
209
|
<li class="tsd-description">
|
|
210
210
|
<aside class="tsd-sources">
|
|
211
211
|
<ul>
|
|
212
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
212
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/services.ts#L183">services.ts:183</a></li>
|
|
213
213
|
</ul>
|
|
214
214
|
</aside>
|
|
215
215
|
<div class="tsd-comment tsd-typography">
|
|
@@ -220,7 +220,7 @@
|
|
|
220
220
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
221
221
|
<ul class="tsd-parameters">
|
|
222
222
|
<li>
|
|
223
|
-
<h5>
|
|
223
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
224
224
|
</li>
|
|
225
225
|
</ul>
|
|
226
226
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.APIKey.html" class="tsd-signature-type" data-tsd-kind="Interface">APIKey</a><span class="tsd-signature-symbol">></span></h4>
|
|
@@ -231,13 +231,13 @@
|
|
|
231
231
|
<a name="list" class="tsd-anchor"></a>
|
|
232
232
|
<h3>list</h3>
|
|
233
233
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
234
|
-
<li class="tsd-signature tsd-kind-icon">list<span class="tsd-signature-symbol">(</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.APIKey.html" class="tsd-signature-type" data-tsd-kind="Interface">APIKey</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
234
|
+
<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.APIKey.html" class="tsd-signature-type" data-tsd-kind="Interface">APIKey</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
235
235
|
</ul>
|
|
236
236
|
<ul class="tsd-descriptions">
|
|
237
237
|
<li class="tsd-description">
|
|
238
238
|
<aside class="tsd-sources">
|
|
239
239
|
<ul>
|
|
240
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
240
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/services.ts#L193">services.ts:193</a></li>
|
|
241
241
|
</ul>
|
|
242
242
|
</aside>
|
|
243
243
|
<div class="tsd-comment tsd-typography">
|
|
@@ -245,6 +245,15 @@
|
|
|
245
245
|
<p>List all API keys owned by this account</p>
|
|
246
246
|
</div>
|
|
247
247
|
</div>
|
|
248
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
249
|
+
<ul class="tsd-parameters">
|
|
250
|
+
<li>
|
|
251
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> beforeId: <span class="tsd-signature-type">string</span></h5>
|
|
252
|
+
</li>
|
|
253
|
+
<li>
|
|
254
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">string</span></h5>
|
|
255
|
+
</li>
|
|
256
|
+
</ul>
|
|
248
257
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.APIKey.html" class="tsd-signature-type" data-tsd-kind="Interface">APIKey</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
|
249
258
|
</li>
|
|
250
259
|
</ul>
|
|
@@ -259,7 +268,7 @@
|
|
|
259
268
|
<li class="tsd-description">
|
|
260
269
|
<aside class="tsd-sources">
|
|
261
270
|
<ul>
|
|
262
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
271
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/services.ts#L241">services.ts:241</a></li>
|
|
263
272
|
</ul>
|
|
264
273
|
</aside>
|
|
265
274
|
<div class="tsd-comment tsd-typography">
|
|
@@ -116,7 +116,7 @@
|
|
|
116
116
|
<li class="tsd-description">
|
|
117
117
|
<aside class="tsd-sources">
|
|
118
118
|
<ul>
|
|
119
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
119
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/services.ts#L16">services.ts:16</a></li>
|
|
120
120
|
</ul>
|
|
121
121
|
</aside>
|
|
122
122
|
<div class="tsd-comment tsd-typography">
|
|
@@ -147,7 +147,7 @@
|
|
|
147
147
|
<li class="tsd-description">
|
|
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/4214cc1/src/services.ts#L22">services.ts:22</a></li>
|
|
151
151
|
</ul>
|
|
152
152
|
</aside>
|
|
153
153
|
<div class="tsd-comment tsd-typography">
|
|
@@ -169,13 +169,13 @@
|
|
|
169
169
|
<a name="get" class="tsd-anchor"></a>
|
|
170
170
|
<h3>get</h3>
|
|
171
171
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
172
|
-
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>
|
|
172
|
+
<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.AbuseReport.html" class="tsd-signature-type" data-tsd-kind="Interface">AbuseReport</a><span class="tsd-signature-symbol">></span></li>
|
|
173
173
|
</ul>
|
|
174
174
|
<ul class="tsd-descriptions">
|
|
175
175
|
<li class="tsd-description">
|
|
176
176
|
<aside class="tsd-sources">
|
|
177
177
|
<ul>
|
|
178
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
178
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/services.ts#L34">services.ts:34</a></li>
|
|
179
179
|
</ul>
|
|
180
180
|
</aside>
|
|
181
181
|
<div class="tsd-comment tsd-typography">
|
|
@@ -186,7 +186,7 @@
|
|
|
186
186
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
187
187
|
<ul class="tsd-parameters">
|
|
188
188
|
<li>
|
|
189
|
-
<h5>
|
|
189
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
190
190
|
</li>
|
|
191
191
|
</ul>
|
|
192
192
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.AbuseReport.html" class="tsd-signature-type" data-tsd-kind="Interface">AbuseReport</a><span class="tsd-signature-symbol">></span></h4>
|