@ngrok/ngrok-api 0.9.0 → 0.10.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 +12 -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 +54 -26
- 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.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.EdgeRouteRequestHeadersModule.html +4 -4
- package/docs/classes/services.EdgeRouteResponseHeadersModule.html +4 -4
- package/docs/classes/services.EdgeRouteSAMLModule.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 +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.TCPEdgeBackendModule.html +8 -8
- package/docs/classes/services.TCPEdgeIPRestrictionModule.html +8 -8
- 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.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 +2 -2
- 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.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.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.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.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.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.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 +22 -22
- 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 +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 +15 -15
- 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 +18 -18
- 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.TCPEdge.html +11 -11
- package/docs/interfaces/datatypes.TCPEdgeCreate.html +7 -7
- package/docs/interfaces/datatypes.TCPEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TCPEdgeUpdate.html +6 -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 +13 -13
- package/docs/interfaces/datatypes.TLSEdgeCreate.html +9 -9
- package/docs/interfaces/datatypes.TLSEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TLSEdgeUpdate.html +8 -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 +64 -0
- package/docs/modules/services.html +8 -0
- package/jest.config.js +2 -0
- package/lib/client.d.ts +9 -7
- package/lib/client.d.ts.map +1 -1
- package/lib/client.js +89 -119
- package/lib/client.js.map +1 -1
- package/lib/datatypes.d.ts +392 -201
- 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 +164 -126
- package/lib/services.d.ts.map +1 -1
- package/lib/services.js +3294 -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 +3 -3
- package/src/client.ts +16 -32
- package/src/datatypes.ts +413 -204
- package/src/index.ts +2 -0
- package/src/services.ts +768 -519
- package/src/util.ts +2 -0
- package/test/apikey.test.js +62 -63
|
@@ -92,6 +92,8 @@
|
|
|
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>
|
|
96
98
|
<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
99
|
<li class="tsd-kind-property tsd-parent-kind-class"><a href="client.Ngrok.html#credentials" class="tsd-kind-icon">credentials</a></li>
|
|
@@ -130,7 +132,7 @@
|
|
|
130
132
|
<li class="tsd-description">
|
|
131
133
|
<aside class="tsd-sources">
|
|
132
134
|
<ul>
|
|
133
|
-
<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/9fd8564/src/client.ts#L194">client.ts:194</a></li>
|
|
134
136
|
</ul>
|
|
135
137
|
</aside>
|
|
136
138
|
<div class="tsd-comment tsd-typography">
|
|
@@ -157,7 +159,7 @@
|
|
|
157
159
|
<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
160
|
<aside class="tsd-sources">
|
|
159
161
|
<ul>
|
|
160
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
162
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L28">client.ts:28</a></li>
|
|
161
163
|
</ul>
|
|
162
164
|
</aside>
|
|
163
165
|
<div class="tsd-comment tsd-typography">
|
|
@@ -173,7 +175,7 @@
|
|
|
173
175
|
<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
176
|
<aside class="tsd-sources">
|
|
175
177
|
<ul>
|
|
176
|
-
<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/9fd8564/src/client.ts#L29">client.ts:29</a></li>
|
|
177
179
|
</ul>
|
|
178
180
|
</aside>
|
|
179
181
|
</section>
|
|
@@ -183,7 +185,7 @@
|
|
|
183
185
|
<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
186
|
<aside class="tsd-sources">
|
|
185
187
|
<ul>
|
|
186
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
188
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L37">client.ts:37</a></li>
|
|
187
189
|
</ul>
|
|
188
190
|
</aside>
|
|
189
191
|
<div class="tsd-comment tsd-typography">
|
|
@@ -196,13 +198,33 @@
|
|
|
196
198
|
</div>
|
|
197
199
|
</div>
|
|
198
200
|
</section>
|
|
201
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
202
|
+
<a name="applicationSessions" class="tsd-anchor"></a>
|
|
203
|
+
<h3>application<wbr>Sessions</h3>
|
|
204
|
+
<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>
|
|
205
|
+
<aside class="tsd-sources">
|
|
206
|
+
<ul>
|
|
207
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L38">client.ts:38</a></li>
|
|
208
|
+
</ul>
|
|
209
|
+
</aside>
|
|
210
|
+
</section>
|
|
211
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
212
|
+
<a name="applicationUsers" class="tsd-anchor"></a>
|
|
213
|
+
<h3>application<wbr>Users</h3>
|
|
214
|
+
<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>
|
|
215
|
+
<aside class="tsd-sources">
|
|
216
|
+
<ul>
|
|
217
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L39">client.ts:39</a></li>
|
|
218
|
+
</ul>
|
|
219
|
+
</aside>
|
|
220
|
+
</section>
|
|
199
221
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class">
|
|
200
222
|
<a name="backends" class="tsd-anchor"></a>
|
|
201
223
|
<h3>backends</h3>
|
|
202
224
|
<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>
|
|
203
225
|
<aside class="tsd-sources">
|
|
204
226
|
<ul>
|
|
205
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
227
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L139">client.ts:139</a></li>
|
|
206
228
|
</ul>
|
|
207
229
|
</aside>
|
|
208
230
|
<div class="tsd-type-declaration">
|
|
@@ -251,7 +273,7 @@
|
|
|
251
273
|
<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
274
|
<aside class="tsd-sources">
|
|
253
275
|
<ul>
|
|
254
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
276
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L53">client.ts:53</a></li>
|
|
255
277
|
</ul>
|
|
256
278
|
</aside>
|
|
257
279
|
<div class="tsd-comment tsd-typography">
|
|
@@ -270,14 +292,14 @@
|
|
|
270
292
|
<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
293
|
<aside class="tsd-sources">
|
|
272
294
|
<ul>
|
|
273
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
295
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L60">client.ts:60</a></li>
|
|
274
296
|
</ul>
|
|
275
297
|
</aside>
|
|
276
298
|
<div class="tsd-comment tsd-typography">
|
|
277
299
|
<div class="lead">
|
|
278
300
|
<p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok
|
|
279
301
|
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>
|
|
302
|
+
the <code>ngrok config add-authtoken</code> command or by specifying it in the <code>ngrok.yml</code>
|
|
281
303
|
configuration file with the <code>authtoken</code> property.</p>
|
|
282
304
|
</div>
|
|
283
305
|
</div>
|
|
@@ -288,7 +310,7 @@
|
|
|
288
310
|
<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>
|
|
289
311
|
<aside class="tsd-sources">
|
|
290
312
|
<ul>
|
|
291
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
313
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L167">client.ts:167</a></li>
|
|
292
314
|
</ul>
|
|
293
315
|
</aside>
|
|
294
316
|
<div class="tsd-type-declaration">
|
|
@@ -360,7 +382,7 @@
|
|
|
360
382
|
<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
383
|
<aside class="tsd-sources">
|
|
362
384
|
<ul>
|
|
363
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
385
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L161">client.ts:161</a></li>
|
|
364
386
|
</ul>
|
|
365
387
|
</aside>
|
|
366
388
|
<div class="tsd-type-declaration">
|
|
@@ -387,7 +409,7 @@
|
|
|
387
409
|
<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
410
|
<aside class="tsd-sources">
|
|
389
411
|
<ul>
|
|
390
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
412
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L66">client.ts:66</a></li>
|
|
391
413
|
</ul>
|
|
392
414
|
</aside>
|
|
393
415
|
<div class="tsd-comment tsd-typography">
|
|
@@ -404,7 +426,7 @@
|
|
|
404
426
|
<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
427
|
<aside class="tsd-sources">
|
|
406
428
|
<ul>
|
|
407
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
429
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L67">client.ts:67</a></li>
|
|
408
430
|
</ul>
|
|
409
431
|
</aside>
|
|
410
432
|
</section>
|
|
@@ -414,7 +436,7 @@
|
|
|
414
436
|
<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
437
|
<aside class="tsd-sources">
|
|
416
438
|
<ul>
|
|
417
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
439
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L69">client.ts:69</a></li>
|
|
418
440
|
</ul>
|
|
419
441
|
</aside>
|
|
420
442
|
</section>
|
|
@@ -424,7 +446,7 @@
|
|
|
424
446
|
<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
447
|
<aside class="tsd-sources">
|
|
426
448
|
<ul>
|
|
427
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
449
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L68">client.ts:68</a></li>
|
|
428
450
|
</ul>
|
|
429
451
|
</aside>
|
|
430
452
|
</section>
|
|
@@ -434,7 +456,7 @@
|
|
|
434
456
|
<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
457
|
<aside class="tsd-sources">
|
|
436
458
|
<ul>
|
|
437
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
459
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L76">client.ts:76</a></li>
|
|
438
460
|
</ul>
|
|
439
461
|
</aside>
|
|
440
462
|
<div class="tsd-comment tsd-typography">
|
|
@@ -452,7 +474,7 @@
|
|
|
452
474
|
<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
475
|
<aside class="tsd-sources">
|
|
454
476
|
<ul>
|
|
455
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
477
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L81">client.ts:81</a></li>
|
|
456
478
|
</ul>
|
|
457
479
|
</aside>
|
|
458
480
|
<div class="tsd-comment tsd-typography">
|
|
@@ -468,7 +490,7 @@
|
|
|
468
490
|
<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
491
|
<aside class="tsd-sources">
|
|
470
492
|
<ul>
|
|
471
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
493
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L90">client.ts:90</a></li>
|
|
472
494
|
</ul>
|
|
473
495
|
</aside>
|
|
474
496
|
<div class="tsd-comment tsd-typography">
|
|
@@ -488,7 +510,7 @@
|
|
|
488
510
|
<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
511
|
<aside class="tsd-sources">
|
|
490
512
|
<ul>
|
|
491
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
513
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L96">client.ts:96</a></li>
|
|
492
514
|
</ul>
|
|
493
515
|
</aside>
|
|
494
516
|
<div class="tsd-comment tsd-typography">
|
|
@@ -505,7 +527,7 @@
|
|
|
505
527
|
<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
528
|
<aside class="tsd-sources">
|
|
507
529
|
<ul>
|
|
508
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
530
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L103">client.ts:103</a></li>
|
|
509
531
|
</ul>
|
|
510
532
|
</aside>
|
|
511
533
|
<div class="tsd-comment tsd-typography">
|
|
@@ -523,7 +545,7 @@
|
|
|
523
545
|
<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
546
|
<aside class="tsd-sources">
|
|
525
547
|
<ul>
|
|
526
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
548
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L108">client.ts:108</a></li>
|
|
527
549
|
</ul>
|
|
528
550
|
</aside>
|
|
529
551
|
<div class="tsd-comment tsd-typography">
|
|
@@ -539,7 +561,7 @@
|
|
|
539
561
|
<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
562
|
<aside class="tsd-sources">
|
|
541
563
|
<ul>
|
|
542
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
564
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L113">client.ts:113</a></li>
|
|
543
565
|
</ul>
|
|
544
566
|
</aside>
|
|
545
567
|
<div class="tsd-comment tsd-typography">
|
|
@@ -555,7 +577,7 @@
|
|
|
555
577
|
<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
578
|
<aside class="tsd-sources">
|
|
557
579
|
<ul>
|
|
558
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
580
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L119">client.ts:119</a></li>
|
|
559
581
|
</ul>
|
|
560
582
|
</aside>
|
|
561
583
|
<div class="tsd-comment tsd-typography">
|
|
@@ -572,7 +594,7 @@
|
|
|
572
594
|
<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
595
|
<aside class="tsd-sources">
|
|
574
596
|
<ul>
|
|
575
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
597
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L125">client.ts:125</a></li>
|
|
576
598
|
</ul>
|
|
577
599
|
</aside>
|
|
578
600
|
<div class="tsd-comment tsd-typography">
|
|
@@ -589,7 +611,7 @@
|
|
|
589
611
|
<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
612
|
<aside class="tsd-sources">
|
|
591
613
|
<ul>
|
|
592
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
614
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L133">client.ts:133</a></li>
|
|
593
615
|
</ul>
|
|
594
616
|
</aside>
|
|
595
617
|
<div class="tsd-comment tsd-typography">
|
|
@@ -608,7 +630,7 @@
|
|
|
608
630
|
<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
631
|
<aside class="tsd-sources">
|
|
610
632
|
<ul>
|
|
611
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
633
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L45">client.ts:45</a></li>
|
|
612
634
|
</ul>
|
|
613
635
|
</aside>
|
|
614
636
|
<div class="tsd-comment tsd-typography">
|
|
@@ -625,7 +647,7 @@
|
|
|
625
647
|
<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
648
|
<aside class="tsd-sources">
|
|
627
649
|
<ul>
|
|
628
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
650
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/client.ts#L138">client.ts:138</a></li>
|
|
629
651
|
</ul>
|
|
630
652
|
</aside>
|
|
631
653
|
<div class="tsd-comment tsd-typography">
|
|
@@ -673,6 +695,12 @@
|
|
|
673
695
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
674
696
|
<a href="client.Ngrok.html#apiKeys" class="tsd-kind-icon">api<wbr>Keys</a>
|
|
675
697
|
</li>
|
|
698
|
+
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
699
|
+
<a href="client.Ngrok.html#applicationSessions" class="tsd-kind-icon">application<wbr>Sessions</a>
|
|
700
|
+
</li>
|
|
701
|
+
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
702
|
+
<a href="client.Ngrok.html#applicationUsers" class="tsd-kind-icon">application<wbr>Users</a>
|
|
703
|
+
</li>
|
|
676
704
|
<li class=" tsd-kind-property tsd-parent-kind-class">
|
|
677
705
|
<a href="client.Ngrok.html#backends" class="tsd-kind-icon">backends</a>
|
|
678
706
|
</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/9fd8564/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/9fd8564/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/9fd8564/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/9fd8564/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/9fd8564/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/9fd8564/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/9fd8564/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/9fd8564/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/9fd8564/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>
|
|
@@ -111,7 +111,7 @@
|
|
|
111
111
|
<li class="tsd-description">
|
|
112
112
|
<aside class="tsd-sources">
|
|
113
113
|
<ul>
|
|
114
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
114
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L47">services.ts:47</a></li>
|
|
115
115
|
</ul>
|
|
116
116
|
</aside>
|
|
117
117
|
<div class="tsd-comment tsd-typography">
|
|
@@ -142,7 +142,7 @@
|
|
|
142
142
|
<li class="tsd-description">
|
|
143
143
|
<aside class="tsd-sources">
|
|
144
144
|
<ul>
|
|
145
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
145
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L53">services.ts:53</a></li>
|
|
146
146
|
</ul>
|
|
147
147
|
</aside>
|
|
148
148
|
<div class="tsd-comment tsd-typography">
|
|
@@ -164,13 +164,13 @@
|
|
|
164
164
|
<a name="delete" class="tsd-anchor"></a>
|
|
165
165
|
<h3>delete</h3>
|
|
166
166
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
167
|
-
<li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>
|
|
167
|
+
<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>
|
|
168
168
|
</ul>
|
|
169
169
|
<ul class="tsd-descriptions">
|
|
170
170
|
<li class="tsd-description">
|
|
171
171
|
<aside class="tsd-sources">
|
|
172
172
|
<ul>
|
|
173
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
173
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L65">services.ts:65</a></li>
|
|
174
174
|
</ul>
|
|
175
175
|
</aside>
|
|
176
176
|
<div class="tsd-comment tsd-typography">
|
|
@@ -181,7 +181,7 @@
|
|
|
181
181
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
182
182
|
<ul class="tsd-parameters">
|
|
183
183
|
<li>
|
|
184
|
-
<h5>
|
|
184
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
185
185
|
</li>
|
|
186
186
|
</ul>
|
|
187
187
|
<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>
|
|
@@ -192,13 +192,13 @@
|
|
|
192
192
|
<a name="get" class="tsd-anchor"></a>
|
|
193
193
|
<h3>get</h3>
|
|
194
194
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
195
|
-
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>
|
|
195
|
+
<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.AgentIngress.html" class="tsd-signature-type" data-tsd-kind="Interface">AgentIngress</a><span class="tsd-signature-symbol">></span></li>
|
|
196
196
|
</ul>
|
|
197
197
|
<ul class="tsd-descriptions">
|
|
198
198
|
<li class="tsd-description">
|
|
199
199
|
<aside class="tsd-sources">
|
|
200
200
|
<ul>
|
|
201
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
201
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L75">services.ts:75</a></li>
|
|
202
202
|
</ul>
|
|
203
203
|
</aside>
|
|
204
204
|
<div class="tsd-comment tsd-typography">
|
|
@@ -209,7 +209,7 @@
|
|
|
209
209
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
210
210
|
<ul class="tsd-parameters">
|
|
211
211
|
<li>
|
|
212
|
-
<h5>
|
|
212
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
213
213
|
</li>
|
|
214
214
|
</ul>
|
|
215
215
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.AgentIngress.html" class="tsd-signature-type" data-tsd-kind="Interface">AgentIngress</a><span class="tsd-signature-symbol">></span></h4>
|
|
@@ -220,13 +220,13 @@
|
|
|
220
220
|
<a name="list" class="tsd-anchor"></a>
|
|
221
221
|
<h3>list</h3>
|
|
222
222
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
223
|
-
<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.AgentIngress.html" class="tsd-signature-type" data-tsd-kind="Interface">AgentIngress</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
223
|
+
<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.AgentIngress.html" class="tsd-signature-type" data-tsd-kind="Interface">AgentIngress</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
224
224
|
</ul>
|
|
225
225
|
<ul class="tsd-descriptions">
|
|
226
226
|
<li class="tsd-description">
|
|
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/9fd8564/src/services.ts#L85">services.ts:85</a></li>
|
|
230
230
|
</ul>
|
|
231
231
|
</aside>
|
|
232
232
|
<div class="tsd-comment tsd-typography">
|
|
@@ -234,6 +234,15 @@
|
|
|
234
234
|
<p>List all Agent Ingresses owned by this account</p>
|
|
235
235
|
</div>
|
|
236
236
|
</div>
|
|
237
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
238
|
+
<ul class="tsd-parameters">
|
|
239
|
+
<li>
|
|
240
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> beforeId: <span class="tsd-signature-type">string</span></h5>
|
|
241
|
+
</li>
|
|
242
|
+
<li>
|
|
243
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">string</span></h5>
|
|
244
|
+
</li>
|
|
245
|
+
</ul>
|
|
237
246
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.AgentIngress.html" class="tsd-signature-type" data-tsd-kind="Interface">AgentIngress</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
|
238
247
|
</li>
|
|
239
248
|
</ul>
|
|
@@ -248,7 +257,7 @@
|
|
|
248
257
|
<li class="tsd-description">
|
|
249
258
|
<aside class="tsd-sources">
|
|
250
259
|
<ul>
|
|
251
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
260
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L135">services.ts:135</a></li>
|
|
252
261
|
</ul>
|
|
253
262
|
</aside>
|
|
254
263
|
<div class="tsd-comment tsd-typography">
|