@ngrok/ngrok-api 0.8.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 +30 -19
- 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 +21 -12
- 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 +21 -12
- package/docs/classes/services.TunnelSessions.html +22 -13
- package/docs/classes/services.Tunnels.html +15 -6
- package/docs/classes/services.WeightedBackends.html +21 -12
- package/docs/index.html +30 -19
- 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 +31 -12
- 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 +3 -3
- 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 +4 -4
- 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 +20 -20
- package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +14 -14
- 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 +10 -10
- package/docs/interfaces/datatypes.WeightedBackendCreate.html +6 -6
- package/docs/interfaces/datatypes.WeightedBackendList.html +3 -3
- package/docs/interfaces/datatypes.WeightedBackendUpdate.html +5 -5
- 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 +400 -209
- 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 +167 -129
- 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 +17 -33
- package/src/datatypes.ts +421 -212
- package/src/index.ts +2 -0
- package/src/services.ts +771 -522
- package/src/util.ts +2 -0
- package/test/apikey.test.js +62 -63
|
@@ -123,7 +123,7 @@
|
|
|
123
123
|
<li class="tsd-description">
|
|
124
124
|
<aside class="tsd-sources">
|
|
125
125
|
<ul>
|
|
126
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
126
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L2898">services.ts:2898</a></li>
|
|
127
127
|
</ul>
|
|
128
128
|
</aside>
|
|
129
129
|
<div class="tsd-comment tsd-typography">
|
|
@@ -154,7 +154,7 @@
|
|
|
154
154
|
<li class="tsd-description">
|
|
155
155
|
<aside class="tsd-sources">
|
|
156
156
|
<ul>
|
|
157
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
157
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L2904">services.ts:2904</a></li>
|
|
158
158
|
</ul>
|
|
159
159
|
</aside>
|
|
160
160
|
<div class="tsd-comment tsd-typography">
|
|
@@ -176,13 +176,13 @@
|
|
|
176
176
|
<a name="delete" class="tsd-anchor"></a>
|
|
177
177
|
<h3>delete</h3>
|
|
178
178
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
179
|
-
<li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>
|
|
179
|
+
<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>
|
|
180
180
|
</ul>
|
|
181
181
|
<ul class="tsd-descriptions">
|
|
182
182
|
<li class="tsd-description">
|
|
183
183
|
<aside class="tsd-sources">
|
|
184
184
|
<ul>
|
|
185
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
185
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L2916">services.ts:2916</a></li>
|
|
186
186
|
</ul>
|
|
187
187
|
</aside>
|
|
188
188
|
<div class="tsd-comment tsd-typography">
|
|
@@ -193,7 +193,7 @@
|
|
|
193
193
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
194
194
|
<ul class="tsd-parameters">
|
|
195
195
|
<li>
|
|
196
|
-
<h5>
|
|
196
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
197
197
|
</li>
|
|
198
198
|
</ul>
|
|
199
199
|
<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>
|
|
@@ -204,13 +204,13 @@
|
|
|
204
204
|
<a name="deleteCertificate" class="tsd-anchor"></a>
|
|
205
205
|
<h3>delete<wbr>Certificate</h3>
|
|
206
206
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
207
|
-
<li class="tsd-signature tsd-kind-icon">delete<wbr>Certificate<span class="tsd-signature-symbol">(</span>
|
|
207
|
+
<li class="tsd-signature tsd-kind-icon">delete<wbr>Certificate<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>
|
|
208
208
|
</ul>
|
|
209
209
|
<ul class="tsd-descriptions">
|
|
210
210
|
<li class="tsd-description">
|
|
211
211
|
<aside class="tsd-sources">
|
|
212
212
|
<ul>
|
|
213
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
213
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L3008">services.ts:3008</a></li>
|
|
214
214
|
</ul>
|
|
215
215
|
</aside>
|
|
216
216
|
<div class="tsd-comment tsd-typography">
|
|
@@ -221,7 +221,7 @@
|
|
|
221
221
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
222
222
|
<ul class="tsd-parameters">
|
|
223
223
|
<li>
|
|
224
|
-
<h5>
|
|
224
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
225
225
|
</li>
|
|
226
226
|
</ul>
|
|
227
227
|
<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>
|
|
@@ -232,13 +232,13 @@
|
|
|
232
232
|
<a name="deleteCertificateManagementPolicy" class="tsd-anchor"></a>
|
|
233
233
|
<h3>delete<wbr>Certificate<wbr>Management<wbr>Policy</h3>
|
|
234
234
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
235
|
-
<li class="tsd-signature tsd-kind-icon">delete<wbr>Certificate<wbr>Management<wbr>Policy<span class="tsd-signature-symbol">(</span>
|
|
235
|
+
<li class="tsd-signature tsd-kind-icon">delete<wbr>Certificate<wbr>Management<wbr>Policy<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>
|
|
236
236
|
</ul>
|
|
237
237
|
<ul class="tsd-descriptions">
|
|
238
238
|
<li class="tsd-description">
|
|
239
239
|
<aside class="tsd-sources">
|
|
240
240
|
<ul>
|
|
241
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
241
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L2998">services.ts:2998</a></li>
|
|
242
242
|
</ul>
|
|
243
243
|
</aside>
|
|
244
244
|
<div class="tsd-comment tsd-typography">
|
|
@@ -249,7 +249,7 @@
|
|
|
249
249
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
250
250
|
<ul class="tsd-parameters">
|
|
251
251
|
<li>
|
|
252
|
-
<h5>
|
|
252
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
253
253
|
</li>
|
|
254
254
|
</ul>
|
|
255
255
|
<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>
|
|
@@ -260,13 +260,13 @@
|
|
|
260
260
|
<a name="get" class="tsd-anchor"></a>
|
|
261
261
|
<h3>get</h3>
|
|
262
262
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
263
|
-
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>
|
|
263
|
+
<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.ReservedDomain.html" class="tsd-signature-type" data-tsd-kind="Interface">ReservedDomain</a><span class="tsd-signature-symbol">></span></li>
|
|
264
264
|
</ul>
|
|
265
265
|
<ul class="tsd-descriptions">
|
|
266
266
|
<li class="tsd-description">
|
|
267
267
|
<aside class="tsd-sources">
|
|
268
268
|
<ul>
|
|
269
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
269
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L2926">services.ts:2926</a></li>
|
|
270
270
|
</ul>
|
|
271
271
|
</aside>
|
|
272
272
|
<div class="tsd-comment tsd-typography">
|
|
@@ -277,7 +277,7 @@
|
|
|
277
277
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
278
278
|
<ul class="tsd-parameters">
|
|
279
279
|
<li>
|
|
280
|
-
<h5>
|
|
280
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
281
281
|
</li>
|
|
282
282
|
</ul>
|
|
283
283
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.ReservedDomain.html" class="tsd-signature-type" data-tsd-kind="Interface">ReservedDomain</a><span class="tsd-signature-symbol">></span></h4>
|
|
@@ -288,13 +288,13 @@
|
|
|
288
288
|
<a name="list" class="tsd-anchor"></a>
|
|
289
289
|
<h3>list</h3>
|
|
290
290
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
291
|
-
<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.ReservedDomain.html" class="tsd-signature-type" data-tsd-kind="Interface">ReservedDomain</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
291
|
+
<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.ReservedDomain.html" class="tsd-signature-type" data-tsd-kind="Interface">ReservedDomain</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
292
292
|
</ul>
|
|
293
293
|
<ul class="tsd-descriptions">
|
|
294
294
|
<li class="tsd-description">
|
|
295
295
|
<aside class="tsd-sources">
|
|
296
296
|
<ul>
|
|
297
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
297
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L2936">services.ts:2936</a></li>
|
|
298
298
|
</ul>
|
|
299
299
|
</aside>
|
|
300
300
|
<div class="tsd-comment tsd-typography">
|
|
@@ -302,6 +302,15 @@
|
|
|
302
302
|
<p>List all reserved domains on this account.</p>
|
|
303
303
|
</div>
|
|
304
304
|
</div>
|
|
305
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
306
|
+
<ul class="tsd-parameters">
|
|
307
|
+
<li>
|
|
308
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> beforeId: <span class="tsd-signature-type">string</span></h5>
|
|
309
|
+
</li>
|
|
310
|
+
<li>
|
|
311
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">string</span></h5>
|
|
312
|
+
</li>
|
|
313
|
+
</ul>
|
|
305
314
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.ReservedDomain.html" class="tsd-signature-type" data-tsd-kind="Interface">ReservedDomain</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
|
306
315
|
</li>
|
|
307
316
|
</ul>
|
|
@@ -316,7 +325,7 @@
|
|
|
316
325
|
<li class="tsd-description">
|
|
317
326
|
<aside class="tsd-sources">
|
|
318
327
|
<ul>
|
|
319
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
328
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L2986">services.ts:2986</a></li>
|
|
320
329
|
</ul>
|
|
321
330
|
</aside>
|
|
322
331
|
<div class="tsd-comment tsd-typography">
|
|
@@ -119,7 +119,7 @@
|
|
|
119
119
|
<li class="tsd-description">
|
|
120
120
|
<aside class="tsd-sources">
|
|
121
121
|
<ul>
|
|
122
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
122
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L3025">services.ts:3025</a></li>
|
|
123
123
|
</ul>
|
|
124
124
|
</aside>
|
|
125
125
|
<div class="tsd-comment tsd-typography">
|
|
@@ -150,7 +150,7 @@
|
|
|
150
150
|
<li class="tsd-description">
|
|
151
151
|
<aside class="tsd-sources">
|
|
152
152
|
<ul>
|
|
153
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
153
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L3031">services.ts:3031</a></li>
|
|
154
154
|
</ul>
|
|
155
155
|
</aside>
|
|
156
156
|
<div class="tsd-comment tsd-typography">
|
|
@@ -172,13 +172,13 @@
|
|
|
172
172
|
<a name="delete" class="tsd-anchor"></a>
|
|
173
173
|
<h3>delete</h3>
|
|
174
174
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
175
|
-
<li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>
|
|
175
|
+
<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>
|
|
176
176
|
</ul>
|
|
177
177
|
<ul class="tsd-descriptions">
|
|
178
178
|
<li class="tsd-description">
|
|
179
179
|
<aside class="tsd-sources">
|
|
180
180
|
<ul>
|
|
181
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
181
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L3043">services.ts:3043</a></li>
|
|
182
182
|
</ul>
|
|
183
183
|
</aside>
|
|
184
184
|
<div class="tsd-comment tsd-typography">
|
|
@@ -189,7 +189,7 @@
|
|
|
189
189
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
190
190
|
<ul class="tsd-parameters">
|
|
191
191
|
<li>
|
|
192
|
-
<h5>
|
|
192
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
193
193
|
</li>
|
|
194
194
|
</ul>
|
|
195
195
|
<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>
|
|
@@ -200,13 +200,13 @@
|
|
|
200
200
|
<a name="get" class="tsd-anchor"></a>
|
|
201
201
|
<h3>get</h3>
|
|
202
202
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
203
|
-
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>
|
|
203
|
+
<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.SSHCertificateAuthority.html" class="tsd-signature-type" data-tsd-kind="Interface">SSHCertificateAuthority</a><span class="tsd-signature-symbol">></span></li>
|
|
204
204
|
</ul>
|
|
205
205
|
<ul class="tsd-descriptions">
|
|
206
206
|
<li class="tsd-description">
|
|
207
207
|
<aside class="tsd-sources">
|
|
208
208
|
<ul>
|
|
209
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
209
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L3053">services.ts:3053</a></li>
|
|
210
210
|
</ul>
|
|
211
211
|
</aside>
|
|
212
212
|
<div class="tsd-comment tsd-typography">
|
|
@@ -217,7 +217,7 @@
|
|
|
217
217
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
218
218
|
<ul class="tsd-parameters">
|
|
219
219
|
<li>
|
|
220
|
-
<h5>
|
|
220
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
221
221
|
</li>
|
|
222
222
|
</ul>
|
|
223
223
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.SSHCertificateAuthority.html" class="tsd-signature-type" data-tsd-kind="Interface">SSHCertificateAuthority</a><span class="tsd-signature-symbol">></span></h4>
|
|
@@ -228,13 +228,13 @@
|
|
|
228
228
|
<a name="list" class="tsd-anchor"></a>
|
|
229
229
|
<h3>list</h3>
|
|
230
230
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
231
|
-
<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.SSHCertificateAuthority.html" class="tsd-signature-type" data-tsd-kind="Interface">SSHCertificateAuthority</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
231
|
+
<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.SSHCertificateAuthority.html" class="tsd-signature-type" data-tsd-kind="Interface">SSHCertificateAuthority</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
232
232
|
</ul>
|
|
233
233
|
<ul class="tsd-descriptions">
|
|
234
234
|
<li class="tsd-description">
|
|
235
235
|
<aside class="tsd-sources">
|
|
236
236
|
<ul>
|
|
237
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
237
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L3063">services.ts:3063</a></li>
|
|
238
238
|
</ul>
|
|
239
239
|
</aside>
|
|
240
240
|
<div class="tsd-comment tsd-typography">
|
|
@@ -242,6 +242,15 @@
|
|
|
242
242
|
<p>List all SSH Certificate Authorities on this account</p>
|
|
243
243
|
</div>
|
|
244
244
|
</div>
|
|
245
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
246
|
+
<ul class="tsd-parameters">
|
|
247
|
+
<li>
|
|
248
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> beforeId: <span class="tsd-signature-type">string</span></h5>
|
|
249
|
+
</li>
|
|
250
|
+
<li>
|
|
251
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">string</span></h5>
|
|
252
|
+
</li>
|
|
253
|
+
</ul>
|
|
245
254
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.SSHCertificateAuthority.html" class="tsd-signature-type" data-tsd-kind="Interface">SSHCertificateAuthority</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
|
246
255
|
</li>
|
|
247
256
|
</ul>
|
|
@@ -256,7 +265,7 @@
|
|
|
256
265
|
<li class="tsd-description">
|
|
257
266
|
<aside class="tsd-sources">
|
|
258
267
|
<ul>
|
|
259
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
268
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L3114">services.ts:3114</a></li>
|
|
260
269
|
</ul>
|
|
261
270
|
</aside>
|
|
262
271
|
<div class="tsd-comment tsd-typography">
|
|
@@ -119,7 +119,7 @@
|
|
|
119
119
|
<li class="tsd-description">
|
|
120
120
|
<aside class="tsd-sources">
|
|
121
121
|
<ul>
|
|
122
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
122
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L3133">services.ts:3133</a></li>
|
|
123
123
|
</ul>
|
|
124
124
|
</aside>
|
|
125
125
|
<div class="tsd-comment tsd-typography">
|
|
@@ -150,7 +150,7 @@
|
|
|
150
150
|
<li class="tsd-description">
|
|
151
151
|
<aside class="tsd-sources">
|
|
152
152
|
<ul>
|
|
153
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
153
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L3139">services.ts:3139</a></li>
|
|
154
154
|
</ul>
|
|
155
155
|
</aside>
|
|
156
156
|
<div class="tsd-comment tsd-typography">
|
|
@@ -172,13 +172,13 @@
|
|
|
172
172
|
<a name="delete" class="tsd-anchor"></a>
|
|
173
173
|
<h3>delete</h3>
|
|
174
174
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
175
|
-
<li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>
|
|
175
|
+
<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>
|
|
176
176
|
</ul>
|
|
177
177
|
<ul class="tsd-descriptions">
|
|
178
178
|
<li class="tsd-description">
|
|
179
179
|
<aside class="tsd-sources">
|
|
180
180
|
<ul>
|
|
181
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
181
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L3151">services.ts:3151</a></li>
|
|
182
182
|
</ul>
|
|
183
183
|
</aside>
|
|
184
184
|
<div class="tsd-comment tsd-typography">
|
|
@@ -189,7 +189,7 @@
|
|
|
189
189
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
190
190
|
<ul class="tsd-parameters">
|
|
191
191
|
<li>
|
|
192
|
-
<h5>
|
|
192
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
193
193
|
</li>
|
|
194
194
|
</ul>
|
|
195
195
|
<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>
|
|
@@ -200,13 +200,13 @@
|
|
|
200
200
|
<a name="get" class="tsd-anchor"></a>
|
|
201
201
|
<h3>get</h3>
|
|
202
202
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
203
|
-
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>
|
|
203
|
+
<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.SSHCredential.html" class="tsd-signature-type" data-tsd-kind="Interface">SSHCredential</a><span class="tsd-signature-symbol">></span></li>
|
|
204
204
|
</ul>
|
|
205
205
|
<ul class="tsd-descriptions">
|
|
206
206
|
<li class="tsd-description">
|
|
207
207
|
<aside class="tsd-sources">
|
|
208
208
|
<ul>
|
|
209
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
209
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L3161">services.ts:3161</a></li>
|
|
210
210
|
</ul>
|
|
211
211
|
</aside>
|
|
212
212
|
<div class="tsd-comment tsd-typography">
|
|
@@ -217,7 +217,7 @@
|
|
|
217
217
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
218
218
|
<ul class="tsd-parameters">
|
|
219
219
|
<li>
|
|
220
|
-
<h5>
|
|
220
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
221
221
|
</li>
|
|
222
222
|
</ul>
|
|
223
223
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.SSHCredential.html" class="tsd-signature-type" data-tsd-kind="Interface">SSHCredential</a><span class="tsd-signature-symbol">></span></h4>
|
|
@@ -228,13 +228,13 @@
|
|
|
228
228
|
<a name="list" class="tsd-anchor"></a>
|
|
229
229
|
<h3>list</h3>
|
|
230
230
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
231
|
-
<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.SSHCredential.html" class="tsd-signature-type" data-tsd-kind="Interface">SSHCredential</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
231
|
+
<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.SSHCredential.html" class="tsd-signature-type" data-tsd-kind="Interface">SSHCredential</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
232
232
|
</ul>
|
|
233
233
|
<ul class="tsd-descriptions">
|
|
234
234
|
<li class="tsd-description">
|
|
235
235
|
<aside class="tsd-sources">
|
|
236
236
|
<ul>
|
|
237
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
237
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L3171">services.ts:3171</a></li>
|
|
238
238
|
</ul>
|
|
239
239
|
</aside>
|
|
240
240
|
<div class="tsd-comment tsd-typography">
|
|
@@ -242,6 +242,15 @@
|
|
|
242
242
|
<p>List all ssh credentials on this account</p>
|
|
243
243
|
</div>
|
|
244
244
|
</div>
|
|
245
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
246
|
+
<ul class="tsd-parameters">
|
|
247
|
+
<li>
|
|
248
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> beforeId: <span class="tsd-signature-type">string</span></h5>
|
|
249
|
+
</li>
|
|
250
|
+
<li>
|
|
251
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">string</span></h5>
|
|
252
|
+
</li>
|
|
253
|
+
</ul>
|
|
245
254
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.SSHCredential.html" class="tsd-signature-type" data-tsd-kind="Interface">SSHCredential</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
|
246
255
|
</li>
|
|
247
256
|
</ul>
|
|
@@ -256,7 +265,7 @@
|
|
|
256
265
|
<li class="tsd-description">
|
|
257
266
|
<aside class="tsd-sources">
|
|
258
267
|
<ul>
|
|
259
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
268
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L3221">services.ts:3221</a></li>
|
|
260
269
|
</ul>
|
|
261
270
|
</aside>
|
|
262
271
|
<div class="tsd-comment tsd-typography">
|
|
@@ -120,7 +120,7 @@
|
|
|
120
120
|
<li class="tsd-description">
|
|
121
121
|
<aside class="tsd-sources">
|
|
122
122
|
<ul>
|
|
123
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
123
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L3241">services.ts:3241</a></li>
|
|
124
124
|
</ul>
|
|
125
125
|
</aside>
|
|
126
126
|
<div class="tsd-comment tsd-typography">
|
|
@@ -151,7 +151,7 @@
|
|
|
151
151
|
<li class="tsd-description">
|
|
152
152
|
<aside class="tsd-sources">
|
|
153
153
|
<ul>
|
|
154
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
154
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L3247">services.ts:3247</a></li>
|
|
155
155
|
</ul>
|
|
156
156
|
</aside>
|
|
157
157
|
<div class="tsd-comment tsd-typography">
|
|
@@ -173,13 +173,13 @@
|
|
|
173
173
|
<a name="delete" class="tsd-anchor"></a>
|
|
174
174
|
<h3>delete</h3>
|
|
175
175
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
176
|
-
<li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>
|
|
176
|
+
<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>
|
|
177
177
|
</ul>
|
|
178
178
|
<ul class="tsd-descriptions">
|
|
179
179
|
<li class="tsd-description">
|
|
180
180
|
<aside class="tsd-sources">
|
|
181
181
|
<ul>
|
|
182
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
182
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L3259">services.ts:3259</a></li>
|
|
183
183
|
</ul>
|
|
184
184
|
</aside>
|
|
185
185
|
<div class="tsd-comment tsd-typography">
|
|
@@ -190,7 +190,7 @@
|
|
|
190
190
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
191
191
|
<ul class="tsd-parameters">
|
|
192
192
|
<li>
|
|
193
|
-
<h5>
|
|
193
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
194
194
|
</li>
|
|
195
195
|
</ul>
|
|
196
196
|
<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>
|
|
@@ -201,13 +201,13 @@
|
|
|
201
201
|
<a name="get" class="tsd-anchor"></a>
|
|
202
202
|
<h3>get</h3>
|
|
203
203
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
204
|
-
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>
|
|
204
|
+
<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.SSHHostCertificate.html" class="tsd-signature-type" data-tsd-kind="Interface">SSHHostCertificate</a><span class="tsd-signature-symbol">></span></li>
|
|
205
205
|
</ul>
|
|
206
206
|
<ul class="tsd-descriptions">
|
|
207
207
|
<li class="tsd-description">
|
|
208
208
|
<aside class="tsd-sources">
|
|
209
209
|
<ul>
|
|
210
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
210
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L3269">services.ts:3269</a></li>
|
|
211
211
|
</ul>
|
|
212
212
|
</aside>
|
|
213
213
|
<div class="tsd-comment tsd-typography">
|
|
@@ -218,7 +218,7 @@
|
|
|
218
218
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
219
219
|
<ul class="tsd-parameters">
|
|
220
220
|
<li>
|
|
221
|
-
<h5>
|
|
221
|
+
<h5>id: <span class="tsd-signature-type">any</span></h5>
|
|
222
222
|
</li>
|
|
223
223
|
</ul>
|
|
224
224
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.SSHHostCertificate.html" class="tsd-signature-type" data-tsd-kind="Interface">SSHHostCertificate</a><span class="tsd-signature-symbol">></span></h4>
|
|
@@ -229,13 +229,13 @@
|
|
|
229
229
|
<a name="list" class="tsd-anchor"></a>
|
|
230
230
|
<h3>list</h3>
|
|
231
231
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
232
|
-
<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.SSHHostCertificate.html" class="tsd-signature-type" data-tsd-kind="Interface">SSHHostCertificate</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
232
|
+
<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.SSHHostCertificate.html" class="tsd-signature-type" data-tsd-kind="Interface">SSHHostCertificate</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
233
233
|
</ul>
|
|
234
234
|
<ul class="tsd-descriptions">
|
|
235
235
|
<li class="tsd-description">
|
|
236
236
|
<aside class="tsd-sources">
|
|
237
237
|
<ul>
|
|
238
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
238
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L3279">services.ts:3279</a></li>
|
|
239
239
|
</ul>
|
|
240
240
|
</aside>
|
|
241
241
|
<div class="tsd-comment tsd-typography">
|
|
@@ -243,6 +243,15 @@
|
|
|
243
243
|
<p>List all SSH Host Certificates issued on this account</p>
|
|
244
244
|
</div>
|
|
245
245
|
</div>
|
|
246
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
247
|
+
<ul class="tsd-parameters">
|
|
248
|
+
<li>
|
|
249
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> beforeId: <span class="tsd-signature-type">string</span></h5>
|
|
250
|
+
</li>
|
|
251
|
+
<li>
|
|
252
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">string</span></h5>
|
|
253
|
+
</li>
|
|
254
|
+
</ul>
|
|
246
255
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.SSHHostCertificate.html" class="tsd-signature-type" data-tsd-kind="Interface">SSHHostCertificate</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
|
247
256
|
</li>
|
|
248
257
|
</ul>
|
|
@@ -257,7 +266,7 @@
|
|
|
257
266
|
<li class="tsd-description">
|
|
258
267
|
<aside class="tsd-sources">
|
|
259
268
|
<ul>
|
|
260
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
269
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L3330">services.ts:3330</a></li>
|
|
261
270
|
</ul>
|
|
262
271
|
</aside>
|
|
263
272
|
<div class="tsd-comment tsd-typography">
|