@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
|
@@ -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#L2192">services.ts:2192</a></li>
|
|
115
115
|
</ul>
|
|
116
116
|
</aside>
|
|
117
117
|
<div class="tsd-comment tsd-typography">
|
|
@@ -142,12 +142,12 @@
|
|
|
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#L2198">services.ts:2198</a></li>
|
|
146
146
|
</ul>
|
|
147
147
|
</aside>
|
|
148
148
|
<div class="tsd-comment tsd-typography">
|
|
149
149
|
<div class="lead">
|
|
150
|
-
<p>Create a new Event Destination. It will not apply to anything until it is associated with an Event
|
|
150
|
+
<p>Create a new Event Destination. It will not apply to anything until it is associated with an Event Subscription.</p>
|
|
151
151
|
</div>
|
|
152
152
|
</div>
|
|
153
153
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -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#L2210">services.ts:2210</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.EventDestination.html" class="tsd-signature-type" data-tsd-kind="Interface">EventDestination</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#L2220">services.ts:2220</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.EventDestination.html" class="tsd-signature-type" data-tsd-kind="Interface">EventDestination</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.EventDestination.html" class="tsd-signature-type" data-tsd-kind="Interface">EventDestination</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.EventDestination.html" class="tsd-signature-type" data-tsd-kind="Interface">EventDestination</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#L2230">services.ts:2230</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 Event Destinations on 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.EventDestination.html" class="tsd-signature-type" data-tsd-kind="Interface">EventDestination</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#L2280">services.ts:2280</a></li>
|
|
252
261
|
</ul>
|
|
253
262
|
</aside>
|
|
254
263
|
<div class="tsd-comment tsd-typography">
|
|
@@ -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#L2398">services.ts:2398</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#L2404">services.ts:2404</a></li>
|
|
146
146
|
</ul>
|
|
147
147
|
</aside>
|
|
148
148
|
<div class="tsd-comment tsd-typography">
|
|
@@ -170,7 +170,7 @@
|
|
|
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#L2416">services.ts:2416</a></li>
|
|
174
174
|
</ul>
|
|
175
175
|
</aside>
|
|
176
176
|
<div class="tsd-comment tsd-typography">
|
|
@@ -198,7 +198,7 @@
|
|
|
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#L2426">services.ts:2426</a></li>
|
|
202
202
|
</ul>
|
|
203
203
|
</aside>
|
|
204
204
|
<div class="tsd-comment tsd-typography">
|
|
@@ -226,7 +226,7 @@
|
|
|
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#L2436">services.ts:2436</a></li>
|
|
230
230
|
</ul>
|
|
231
231
|
</aside>
|
|
232
232
|
<div class="tsd-comment tsd-typography">
|
|
@@ -254,7 +254,7 @@
|
|
|
254
254
|
<li class="tsd-description">
|
|
255
255
|
<aside class="tsd-sources">
|
|
256
256
|
<ul>
|
|
257
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
257
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L2448">services.ts:2448</a></li>
|
|
258
258
|
</ul>
|
|
259
259
|
</aside>
|
|
260
260
|
<div class="tsd-comment tsd-typography">
|
|
@@ -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#L2295">services.ts:2295</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#L2301">services.ts:2301</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#L2313">services.ts:2313</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.EventSubscription.html" class="tsd-signature-type" data-tsd-kind="Interface">EventSubscription</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#L2323">services.ts:2323</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.EventSubscription.html" class="tsd-signature-type" data-tsd-kind="Interface">EventSubscription</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.EventSubscription.html" class="tsd-signature-type" data-tsd-kind="Interface">EventSubscription</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.EventSubscription.html" class="tsd-signature-type" data-tsd-kind="Interface">EventSubscription</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#L2333">services.ts:2333</a></li>
|
|
230
230
|
</ul>
|
|
231
231
|
</aside>
|
|
232
232
|
<div class="tsd-comment tsd-typography">
|
|
@@ -234,6 +234,15 @@
|
|
|
234
234
|
<p>List this Account's Event Subscriptions.</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.EventSubscription.html" class="tsd-signature-type" data-tsd-kind="Interface">EventSubscription</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#L2383">services.ts:2383</a></li>
|
|
252
261
|
</ul>
|
|
253
262
|
</aside>
|
|
254
263
|
<div class="tsd-comment tsd-typography">
|
|
@@ -121,7 +121,7 @@
|
|
|
121
121
|
<li class="tsd-description">
|
|
122
122
|
<aside class="tsd-sources">
|
|
123
123
|
<ul>
|
|
124
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
124
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L523">services.ts:523</a></li>
|
|
125
125
|
</ul>
|
|
126
126
|
</aside>
|
|
127
127
|
<div class="tsd-comment tsd-typography">
|
|
@@ -152,7 +152,7 @@
|
|
|
152
152
|
<li class="tsd-description">
|
|
153
153
|
<aside class="tsd-sources">
|
|
154
154
|
<ul>
|
|
155
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
155
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L529">services.ts:529</a></li>
|
|
156
156
|
</ul>
|
|
157
157
|
</aside>
|
|
158
158
|
<div class="tsd-comment tsd-typography">
|
|
@@ -174,13 +174,13 @@
|
|
|
174
174
|
<a name="delete" class="tsd-anchor"></a>
|
|
175
175
|
<h3>delete</h3>
|
|
176
176
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
177
|
-
<li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>
|
|
177
|
+
<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>
|
|
178
178
|
</ul>
|
|
179
179
|
<ul class="tsd-descriptions">
|
|
180
180
|
<li class="tsd-description">
|
|
181
181
|
<aside class="tsd-sources">
|
|
182
182
|
<ul>
|
|
183
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
183
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L541">services.ts:541</a></li>
|
|
184
184
|
</ul>
|
|
185
185
|
</aside>
|
|
186
186
|
<div class="tsd-comment tsd-typography">
|
|
@@ -191,7 +191,7 @@
|
|
|
191
191
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
192
192
|
<ul class="tsd-parameters">
|
|
193
193
|
<li>
|
|
194
|
-
<h5>
|
|
194
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
195
195
|
</li>
|
|
196
196
|
</ul>
|
|
197
197
|
<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>
|
|
@@ -202,13 +202,13 @@
|
|
|
202
202
|
<a name="get" class="tsd-anchor"></a>
|
|
203
203
|
<h3>get</h3>
|
|
204
204
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
205
|
-
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>
|
|
205
|
+
<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.FailoverBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">FailoverBackend</a><span class="tsd-signature-symbol">></span></li>
|
|
206
206
|
</ul>
|
|
207
207
|
<ul class="tsd-descriptions">
|
|
208
208
|
<li class="tsd-description">
|
|
209
209
|
<aside class="tsd-sources">
|
|
210
210
|
<ul>
|
|
211
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
211
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L551">services.ts:551</a></li>
|
|
212
212
|
</ul>
|
|
213
213
|
</aside>
|
|
214
214
|
<div class="tsd-comment tsd-typography">
|
|
@@ -219,7 +219,7 @@
|
|
|
219
219
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
220
220
|
<ul class="tsd-parameters">
|
|
221
221
|
<li>
|
|
222
|
-
<h5>
|
|
222
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
223
223
|
</li>
|
|
224
224
|
</ul>
|
|
225
225
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.FailoverBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">FailoverBackend</a><span class="tsd-signature-symbol">></span></h4>
|
|
@@ -230,13 +230,13 @@
|
|
|
230
230
|
<a name="list" class="tsd-anchor"></a>
|
|
231
231
|
<h3>list</h3>
|
|
232
232
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
233
|
-
<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.FailoverBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">FailoverBackend</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
233
|
+
<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.FailoverBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">FailoverBackend</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
234
234
|
</ul>
|
|
235
235
|
<ul class="tsd-descriptions">
|
|
236
236
|
<li class="tsd-description">
|
|
237
237
|
<aside class="tsd-sources">
|
|
238
238
|
<ul>
|
|
239
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
239
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L561">services.ts:561</a></li>
|
|
240
240
|
</ul>
|
|
241
241
|
</aside>
|
|
242
242
|
<div class="tsd-comment tsd-typography">
|
|
@@ -244,6 +244,15 @@
|
|
|
244
244
|
<p>List all Failover backends on this account</p>
|
|
245
245
|
</div>
|
|
246
246
|
</div>
|
|
247
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
248
|
+
<ul class="tsd-parameters">
|
|
249
|
+
<li>
|
|
250
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> beforeId: <span class="tsd-signature-type">string</span></h5>
|
|
251
|
+
</li>
|
|
252
|
+
<li>
|
|
253
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">string</span></h5>
|
|
254
|
+
</li>
|
|
255
|
+
</ul>
|
|
247
256
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.FailoverBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">FailoverBackend</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
|
248
257
|
</li>
|
|
249
258
|
</ul>
|
|
@@ -258,7 +267,7 @@
|
|
|
258
267
|
<li class="tsd-description">
|
|
259
268
|
<aside class="tsd-sources">
|
|
260
269
|
<ul>
|
|
261
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
270
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L611">services.ts:611</a></li>
|
|
262
271
|
</ul>
|
|
263
272
|
</aside>
|
|
264
273
|
<div class="tsd-comment tsd-typography">
|
|
@@ -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#L626">services.ts:626</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#L629">services.ts:629</a></li>
|
|
146
146
|
</ul>
|
|
147
147
|
</aside>
|
|
148
148
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -159,19 +159,19 @@
|
|
|
159
159
|
<a name="delete" class="tsd-anchor"></a>
|
|
160
160
|
<h3>delete</h3>
|
|
161
161
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
162
|
-
<li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>
|
|
162
|
+
<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>
|
|
163
163
|
</ul>
|
|
164
164
|
<ul class="tsd-descriptions">
|
|
165
165
|
<li class="tsd-description">
|
|
166
166
|
<aside class="tsd-sources">
|
|
167
167
|
<ul>
|
|
168
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
168
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L638">services.ts:638</a></li>
|
|
169
169
|
</ul>
|
|
170
170
|
</aside>
|
|
171
171
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
172
172
|
<ul class="tsd-parameters">
|
|
173
173
|
<li>
|
|
174
|
-
<h5>
|
|
174
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
175
175
|
</li>
|
|
176
176
|
</ul>
|
|
177
177
|
<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>
|
|
@@ -182,19 +182,19 @@
|
|
|
182
182
|
<a name="get" class="tsd-anchor"></a>
|
|
183
183
|
<h3>get</h3>
|
|
184
184
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
185
|
-
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>
|
|
185
|
+
<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.HTTPResponseBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">HTTPResponseBackend</a><span class="tsd-signature-symbol">></span></li>
|
|
186
186
|
</ul>
|
|
187
187
|
<ul class="tsd-descriptions">
|
|
188
188
|
<li class="tsd-description">
|
|
189
189
|
<aside class="tsd-sources">
|
|
190
190
|
<ul>
|
|
191
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
191
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L645">services.ts:645</a></li>
|
|
192
192
|
</ul>
|
|
193
193
|
</aside>
|
|
194
194
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
195
195
|
<ul class="tsd-parameters">
|
|
196
196
|
<li>
|
|
197
|
-
<h5>
|
|
197
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
198
198
|
</li>
|
|
199
199
|
</ul>
|
|
200
200
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.HTTPResponseBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">HTTPResponseBackend</a><span class="tsd-signature-symbol">></span></h4>
|
|
@@ -205,15 +205,24 @@
|
|
|
205
205
|
<a name="list" class="tsd-anchor"></a>
|
|
206
206
|
<h3>list</h3>
|
|
207
207
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
208
|
-
<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.HTTPResponseBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">HTTPResponseBackend</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
208
|
+
<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.HTTPResponseBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">HTTPResponseBackend</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
209
209
|
</ul>
|
|
210
210
|
<ul class="tsd-descriptions">
|
|
211
211
|
<li class="tsd-description">
|
|
212
212
|
<aside class="tsd-sources">
|
|
213
213
|
<ul>
|
|
214
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
214
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L652">services.ts:652</a></li>
|
|
215
215
|
</ul>
|
|
216
216
|
</aside>
|
|
217
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
218
|
+
<ul class="tsd-parameters">
|
|
219
|
+
<li>
|
|
220
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> beforeId: <span class="tsd-signature-type">string</span></h5>
|
|
221
|
+
</li>
|
|
222
|
+
<li>
|
|
223
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">string</span></h5>
|
|
224
|
+
</li>
|
|
225
|
+
</ul>
|
|
217
226
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.HTTPResponseBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">HTTPResponseBackend</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
|
218
227
|
</li>
|
|
219
228
|
</ul>
|
|
@@ -228,7 +237,7 @@
|
|
|
228
237
|
<li class="tsd-description">
|
|
229
238
|
<aside class="tsd-sources">
|
|
230
239
|
<ul>
|
|
231
|
-
<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#L699">services.ts:699</a></li>
|
|
232
241
|
</ul>
|
|
233
242
|
</aside>
|
|
234
243
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -109,7 +109,7 @@
|
|
|
109
109
|
<li class="tsd-description">
|
|
110
110
|
<aside class="tsd-sources">
|
|
111
111
|
<ul>
|
|
112
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
112
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L1298">services.ts:1298</a></li>
|
|
113
113
|
</ul>
|
|
114
114
|
</aside>
|
|
115
115
|
<div class="tsd-comment tsd-typography">
|
|
@@ -134,19 +134,19 @@
|
|
|
134
134
|
<a name="delete" class="tsd-anchor"></a>
|
|
135
135
|
<h3>delete</h3>
|
|
136
136
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
137
|
-
<li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>
|
|
137
|
+
<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>
|
|
138
138
|
</ul>
|
|
139
139
|
<ul class="tsd-descriptions">
|
|
140
140
|
<li class="tsd-description">
|
|
141
141
|
<aside class="tsd-sources">
|
|
142
142
|
<ul>
|
|
143
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
143
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L1317">services.ts:1317</a></li>
|
|
144
144
|
</ul>
|
|
145
145
|
</aside>
|
|
146
146
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
147
147
|
<ul class="tsd-parameters">
|
|
148
148
|
<li>
|
|
149
|
-
<h5>
|
|
149
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
150
150
|
</li>
|
|
151
151
|
</ul>
|
|
152
152
|
<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>
|
|
@@ -157,19 +157,19 @@
|
|
|
157
157
|
<a name="get" class="tsd-anchor"></a>
|
|
158
158
|
<h3>get</h3>
|
|
159
159
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
160
|
-
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>
|
|
160
|
+
<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.EndpointMutualTLS.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointMutualTLS</a><span class="tsd-signature-symbol">></span></li>
|
|
161
161
|
</ul>
|
|
162
162
|
<ul class="tsd-descriptions">
|
|
163
163
|
<li class="tsd-description">
|
|
164
164
|
<aside class="tsd-sources">
|
|
165
165
|
<ul>
|
|
166
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
166
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L1310">services.ts:1310</a></li>
|
|
167
167
|
</ul>
|
|
168
168
|
</aside>
|
|
169
169
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
170
170
|
<ul class="tsd-parameters">
|
|
171
171
|
<li>
|
|
172
|
-
<h5>
|
|
172
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
173
173
|
</li>
|
|
174
174
|
</ul>
|
|
175
175
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.EndpointMutualTLS.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointMutualTLS</a><span class="tsd-signature-symbol">></span></h4>
|
|
@@ -186,7 +186,7 @@
|
|
|
186
186
|
<li class="tsd-description">
|
|
187
187
|
<aside class="tsd-sources">
|
|
188
188
|
<ul>
|
|
189
|
-
<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/9fd8564/src/services.ts#L1301">services.ts:1301</a></li>
|
|
190
190
|
</ul>
|
|
191
191
|
</aside>
|
|
192
192
|
<h4 class="tsd-parameters-title">Parameters</h4>
|