@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
|
@@ -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#L1330">services.ts:1330</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#L1349">services.ts:1349</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.EndpointTLSTermination.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTLSTermination</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#L1342">services.ts:1342</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.EndpointTLSTermination.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTLSTermination</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#L1333">services.ts:1333</a></li>
|
|
190
190
|
</ul>
|
|
191
191
|
</aside>
|
|
192
192
|
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
@@ -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#L2469">services.ts:2469</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#L2475">services.ts:2475</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#L2485">services.ts:2485</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.IPPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">IPPolicy</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#L2495">services.ts:2495</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.IPPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">IPPolicy</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.IPPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">IPPolicy</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.IPPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">IPPolicy</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#L2505">services.ts:2505</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 IP policies 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.IPPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">IPPolicy</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#L2553">services.ts:2553</a></li>
|
|
262
271
|
</ul>
|
|
263
272
|
</aside>
|
|
264
273
|
<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#L2570">services.ts:2570</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#L2576">services.ts:2576</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#L2588">services.ts:2588</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.IPPolicyRule.html" class="tsd-signature-type" data-tsd-kind="Interface">IPPolicyRule</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#L2598">services.ts:2598</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.IPPolicyRule.html" class="tsd-signature-type" data-tsd-kind="Interface">IPPolicyRule</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.IPPolicyRule.html" class="tsd-signature-type" data-tsd-kind="Interface">IPPolicyRule</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.IPPolicyRule.html" class="tsd-signature-type" data-tsd-kind="Interface">IPPolicyRule</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#L2608">services.ts:2608</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 IP policy rules 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.IPPolicyRule.html" class="tsd-signature-type" data-tsd-kind="Interface">IPPolicyRule</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#L2658">services.ts:2658</a></li>
|
|
260
269
|
</ul>
|
|
261
270
|
</aside>
|
|
262
271
|
<div class="tsd-comment tsd-typography">
|
|
@@ -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#L2681">services.ts:2681</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#L2687">services.ts:2687</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#L2699">services.ts:2699</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="get" class="tsd-anchor"></a>
|
|
205
205
|
<h3>get</h3>
|
|
206
206
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
207
|
-
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>
|
|
207
|
+
<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.IPRestriction.html" class="tsd-signature-type" data-tsd-kind="Interface">IPRestriction</a><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#L2709">services.ts:2709</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><a href="../interfaces/datatypes.IPRestriction.html" class="tsd-signature-type" data-tsd-kind="Interface">IPRestriction</a><span class="tsd-signature-symbol">></span></h4>
|
|
@@ -232,13 +232,13 @@
|
|
|
232
232
|
<a name="list" class="tsd-anchor"></a>
|
|
233
233
|
<h3>list</h3>
|
|
234
234
|
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
235
|
-
<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.IPRestriction.html" class="tsd-signature-type" data-tsd-kind="Interface">IPRestriction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></li>
|
|
235
|
+
<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.IPRestriction.html" class="tsd-signature-type" data-tsd-kind="Interface">IPRestriction</a><span class="tsd-signature-symbol">[]</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#L2719">services.ts:2719</a></li>
|
|
242
242
|
</ul>
|
|
243
243
|
</aside>
|
|
244
244
|
<div class="tsd-comment tsd-typography">
|
|
@@ -246,6 +246,15 @@
|
|
|
246
246
|
<p>List all IP restrictions on this account</p>
|
|
247
247
|
</div>
|
|
248
248
|
</div>
|
|
249
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
250
|
+
<ul class="tsd-parameters">
|
|
251
|
+
<li>
|
|
252
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> beforeId: <span class="tsd-signature-type">string</span></h5>
|
|
253
|
+
</li>
|
|
254
|
+
<li>
|
|
255
|
+
<h5><span class="tsd-flag ts-flagOptional">Optional</span> limit: <span class="tsd-signature-type">string</span></h5>
|
|
256
|
+
</li>
|
|
257
|
+
</ul>
|
|
249
258
|
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.IPRestriction.html" class="tsd-signature-type" data-tsd-kind="Interface">IPRestriction</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">></span></h4>
|
|
250
259
|
</li>
|
|
251
260
|
</ul>
|
|
@@ -260,7 +269,7 @@
|
|
|
260
269
|
<li class="tsd-description">
|
|
261
270
|
<aside class="tsd-sources">
|
|
262
271
|
<ul>
|
|
263
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
272
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/services.ts#L2769">services.ts:2769</a></li>
|
|
264
273
|
</ul>
|
|
265
274
|
</aside>
|
|
266
275
|
<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#L2789">services.ts:2789</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#L2795">services.ts:2795</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#L2807">services.ts:2807</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.ReservedAddr.html" class="tsd-signature-type" data-tsd-kind="Interface">ReservedAddr</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#L2817">services.ts:2817</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.ReservedAddr.html" class="tsd-signature-type" data-tsd-kind="Interface">ReservedAddr</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.ReservedAddr.html" class="tsd-signature-type" data-tsd-kind="Interface">ReservedAddr</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.ReservedAddr.html" class="tsd-signature-type" data-tsd-kind="Interface">ReservedAddr</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#L2827">services.ts:2827</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 reserved addresses 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.ReservedAddr.html" class="tsd-signature-type" data-tsd-kind="Interface">ReservedAddr</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#L2877">services.ts:2877</a></li>
|
|
261
270
|
</ul>
|
|
262
271
|
</aside>
|
|
263
272
|
<div class="tsd-comment tsd-typography">
|