@ngrok/ngrok-api 0.10.0 → 0.12.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/CHANGELOG.md +9 -0
- package/docs/assets/js/search.js +1 -1
- package/docs/classes/client.Ngrok.html +55 -29
- package/docs/classes/services.APIKeys.html +6 -6
- package/docs/classes/services.AbuseReports.html +3 -3
- package/docs/classes/services.AgentIngresses.html +6 -6
- package/docs/classes/services.ApplicationSessions.html +4 -4
- package/docs/classes/services.ApplicationUsers.html +4 -4
- package/docs/classes/services.BotUsers.html +352 -0
- package/docs/classes/services.CertificateAuthorities.html +6 -6
- package/docs/classes/services.Credentials.html +6 -6
- package/docs/classes/services.EdgeRouteBackendModule.html +4 -4
- package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +4 -4
- package/docs/classes/services.EdgeRouteCompressionModule.html +4 -4
- package/docs/classes/services.EdgeRouteIPRestrictionModule.html +4 -4
- package/docs/classes/services.EdgeRouteOAuthModule.html +4 -4
- package/docs/classes/services.EdgeRouteOIDCModule.html +4 -4
- package/docs/classes/services.EdgeRoutePolicyModule.html +270 -0
- package/docs/classes/services.EdgeRouteRequestHeadersModule.html +4 -4
- package/docs/classes/services.EdgeRouteResponseHeadersModule.html +4 -4
- package/docs/classes/services.EdgeRouteSAMLModule.html +4 -4
- package/docs/classes/services.EdgeRouteTrafficPolicyModule.html +270 -0
- package/docs/classes/services.EdgeRouteUserAgentFilterModule.html +270 -0
- package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +4 -4
- package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +4 -4
- package/docs/classes/services.EdgesHTTPS.html +6 -6
- package/docs/classes/services.EdgesHTTPSRoutes.html +5 -5
- package/docs/classes/services.EdgesTCP.html +6 -6
- package/docs/classes/services.EdgesTLS.html +6 -6
- package/docs/classes/services.Endpoints.html +3 -3
- package/docs/classes/services.EventDestinations.html +6 -6
- package/docs/classes/services.EventSources.html +6 -6
- package/docs/classes/services.EventSubscriptions.html +6 -6
- package/docs/classes/services.FailoverBackends.html +6 -6
- package/docs/classes/services.HTTPResponseBackends.html +6 -6
- package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +4 -4
- package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +4 -4
- package/docs/classes/services.IPPolicies.html +6 -6
- package/docs/classes/services.IPPolicyRules.html +6 -6
- package/docs/classes/services.IPRestrictions.html +6 -6
- package/docs/classes/services.ReservedAddrs.html +6 -6
- package/docs/classes/services.ReservedDomains.html +8 -8
- package/docs/classes/services.SSHCertificateAuthorities.html +6 -6
- package/docs/classes/services.SSHCredentials.html +6 -6
- package/docs/classes/services.SSHHostCertificates.html +6 -6
- package/docs/classes/services.SSHUserCertificates.html +6 -6
- package/docs/classes/services.StaticBackends.html +360 -0
- package/docs/classes/services.TCPEdgeBackendModule.html +4 -4
- package/docs/classes/services.TCPEdgeIPRestrictionModule.html +4 -4
- package/docs/classes/services.TCPEdgePolicyModule.html +270 -0
- package/docs/classes/services.TCPEdgeTrafficPolicyModule.html +270 -0
- package/docs/classes/services.TLSCertificates.html +6 -6
- package/docs/classes/services.TLSEdgeBackendModule.html +4 -4
- package/docs/classes/services.TLSEdgeIPRestrictionModule.html +4 -4
- package/docs/classes/services.TLSEdgeMutualTLSModule.html +4 -4
- package/docs/classes/services.TLSEdgePolicyModule.html +270 -0
- package/docs/classes/services.TLSEdgeTLSTerminationModule.html +4 -4
- package/docs/classes/services.TLSEdgeTrafficPolicyModule.html +270 -0
- package/docs/classes/services.TunnelGroupBackends.html +6 -6
- package/docs/classes/services.TunnelSessions.html +6 -6
- package/docs/classes/services.Tunnels.html +3 -3
- package/docs/classes/services.WeightedBackends.html +6 -6
- package/docs/interfaces/client.NgrokConfig.html +3 -3
- package/docs/interfaces/datatypes.APIKey.html +7 -7
- package/docs/interfaces/datatypes.APIKeyCreate.html +3 -3
- 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 +7 -7
- package/docs/interfaces/datatypes.AbuseReportCreate.html +2 -2
- package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
- package/docs/interfaces/datatypes.AgentIngress.html +10 -10
- package/docs/interfaces/datatypes.AgentIngressCertJob.html +4 -4
- package/docs/interfaces/datatypes.AgentIngressCertPolicy.html +2 -2
- package/docs/interfaces/datatypes.AgentIngressCertStatus.html +2 -2
- package/docs/interfaces/datatypes.AgentIngressCreate.html +4 -4
- package/docs/interfaces/datatypes.AgentIngressList.html +3 -3
- package/docs/interfaces/datatypes.AgentIngressUpdate.html +4 -4
- package/docs/interfaces/datatypes.ApplicationSession.html +11 -11
- package/docs/interfaces/datatypes.ApplicationSessionList.html +3 -3
- package/docs/interfaces/datatypes.ApplicationUser.html +10 -10
- package/docs/interfaces/datatypes.ApplicationUserList.html +3 -3
- package/docs/interfaces/datatypes.BotUser.html +243 -0
- package/docs/interfaces/datatypes.BotUserCreate.html +186 -0
- package/docs/interfaces/datatypes.BotUserList.html +205 -0
- package/docs/interfaces/datatypes.BotUserUpdate.html +200 -0
- package/docs/interfaces/datatypes.BrowserSession.html +3 -3
- package/docs/interfaces/datatypes.CertificateAuthority.html +11 -11
- package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +3 -3
- package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.Credential.html +8 -8
- package/docs/interfaces/datatypes.CredentialCreate.html +4 -4
- package/docs/interfaces/datatypes.CredentialList.html +3 -3
- package/docs/interfaces/datatypes.CredentialUpdate.html +4 -4
- package/docs/interfaces/datatypes.EdgeBackendReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeIPRestrictionReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeMutualTLSReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgePolicyReplace.html +176 -0
- package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteCompressionReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteItem.html +2 -2
- package/docs/interfaces/datatypes.EdgeRouteOAuthReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRoutePolicyReplace.html +190 -0
- package/docs/interfaces/datatypes.EdgeRouteRequestHeadersReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteSAMLReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteTrafficPolicyReplace.html +190 -0
- package/docs/interfaces/datatypes.EdgeRouteUserAgentFilterReplace.html +190 -0
- package/docs/interfaces/datatypes.EdgeRouteWebhookVerificationReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeTLSTerminationAtEdgeReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeTLSTerminationReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeTrafficPolicyReplace.html +176 -0
- package/docs/interfaces/datatypes.Endpoint.html +13 -13
- package/docs/interfaces/datatypes.EndpointAction.html +186 -0
- package/docs/interfaces/datatypes.EndpointBackend.html +2 -2
- package/docs/interfaces/datatypes.EndpointBackendMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
- package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
- package/docs/interfaces/datatypes.EndpointIPPolicy.html +2 -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 +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +7 -7
- package/docs/interfaces/datatypes.EndpointOAuthGitLab.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthLinkedIn.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthProvider.html +8 -8
- package/docs/interfaces/datatypes.EndpointOAuthTwitch.html +5 -5
- package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
- package/docs/interfaces/datatypes.EndpointPolicy.html +205 -0
- package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointRule.html +205 -0
- package/docs/interfaces/datatypes.EndpointSAML.html +15 -15
- package/docs/interfaces/datatypes.EndpointSAMLMutate.html +10 -10
- package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
- package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +2 -2
- package/docs/interfaces/datatypes.EndpointTrafficPolicy.html +186 -0
- package/docs/interfaces/datatypes.EndpointUserAgentFilter.html +190 -0
- package/docs/interfaces/datatypes.EndpointWebhookValidation.html +4 -4
- package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +1 -1
- package/docs/interfaces/datatypes.Error.html +4 -4
- package/docs/interfaces/datatypes.EventDestination.html +7 -7
- package/docs/interfaces/datatypes.EventDestinationCreate.html +4 -4
- 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 +7 -7
- package/docs/interfaces/datatypes.EventSubscriptionCreate.html +4 -4
- package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
- package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +5 -5
- package/docs/interfaces/datatypes.EventTarget.html +18 -4
- package/docs/interfaces/datatypes.EventTargetAzureLogsIngestion.html +262 -0
- package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
- package/docs/interfaces/datatypes.EventTargetDatadog.html +4 -4
- package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
- package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
- package/docs/interfaces/datatypes.FailoverBackend.html +6 -6
- package/docs/interfaces/datatypes.FailoverBackendCreate.html +3 -3
- package/docs/interfaces/datatypes.FailoverBackendList.html +3 -3
- package/docs/interfaces/datatypes.FailoverBackendUpdate.html +4 -4
- package/docs/interfaces/datatypes.HTTPResponseBackend.html +8 -8
- package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +5 -5
- package/docs/interfaces/datatypes.HTTPResponseBackendList.html +3 -3
- package/docs/interfaces/datatypes.HTTPResponseBackendUpdate.html +6 -6
- package/docs/interfaces/datatypes.HTTPSEdge.html +9 -9
- package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +5 -5
- package/docs/interfaces/datatypes.HTTPSEdgeList.html +3 -3
- package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +52 -19
- package/docs/interfaces/datatypes.HTTPSEdgeRouteCreate.html +49 -16
- package/docs/interfaces/datatypes.HTTPSEdgeRouteUpdate.html +50 -17
- package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +6 -6
- package/docs/interfaces/datatypes.IPPolicy.html +5 -5
- package/docs/interfaces/datatypes.IPPolicyCreate.html +2 -2
- package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRule.html +8 -8
- package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +5 -5
- 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 +8 -8
- package/docs/interfaces/datatypes.IPRestrictionCreate.html +5 -5
- package/docs/interfaces/datatypes.IPRestrictionList.html +3 -3
- package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
- package/docs/interfaces/datatypes.IdentityProvider.html +2 -2
- package/docs/interfaces/datatypes.Item.html +1 -1
- package/docs/interfaces/datatypes.Location.html +4 -4
- package/docs/interfaces/datatypes.Paging.html +2 -2
- package/docs/interfaces/datatypes.Ref.html +2 -2
- package/docs/interfaces/datatypes.ReservedAddr.html +7 -7
- package/docs/interfaces/datatypes.ReservedAddrCreate.html +3 -3
- package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
- package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomain.html +14 -14
- package/docs/interfaces/datatypes.ReservedDomainCertJob.html +4 -4
- package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
- package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +2 -2
- package/docs/interfaces/datatypes.ReservedDomainCreate.html +7 -7
- package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -5
- package/docs/interfaces/datatypes.SSHCertificateAuthority.html +7 -7
- package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +5 -5
- package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHCredential.html +8 -8
- package/docs/interfaces/datatypes.SSHCredentialCreate.html +5 -5
- package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
- package/docs/interfaces/datatypes.SSHCredentialUpdate.html +4 -4
- package/docs/interfaces/datatypes.SSHHostCertificate.html +12 -12
- package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +7 -7
- package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificate.html +14 -14
- package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +9 -9
- package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.StaticBackend.html +281 -0
- package/docs/interfaces/datatypes.StaticBackendCreate.html +224 -0
- package/docs/interfaces/datatypes.StaticBackendList.html +205 -0
- package/docs/interfaces/datatypes.StaticBackendTLS.html +167 -0
- package/docs/interfaces/datatypes.StaticBackendUpdate.html +238 -0
- package/docs/interfaces/datatypes.TCPEdge.html +27 -8
- package/docs/interfaces/datatypes.TCPEdgeCreate.html +24 -5
- package/docs/interfaces/datatypes.TCPEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TCPEdgeUpdate.html +25 -6
- package/docs/interfaces/datatypes.TLSCertificate.html +21 -21
- package/docs/interfaces/datatypes.TLSCertificateCreate.html +4 -4
- 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 +29 -10
- package/docs/interfaces/datatypes.TLSEdgeCreate.html +26 -7
- package/docs/interfaces/datatypes.TLSEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TLSEdgeUpdate.html +27 -8
- package/docs/interfaces/datatypes.Tunnel.html +11 -11
- package/docs/interfaces/datatypes.TunnelGroupBackend.html +7 -7
- package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +3 -3
- 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 +10 -10
- package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
- package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
- package/docs/interfaces/datatypes.UserAgent.html +6 -6
- package/docs/interfaces/datatypes.WeightedBackend.html +6 -6
- package/docs/interfaces/datatypes.WeightedBackendCreate.html +3 -3
- package/docs/interfaces/datatypes.WeightedBackendList.html +3 -3
- package/docs/interfaces/datatypes.WeightedBackendUpdate.html +4 -4
- package/docs/modules/datatypes.html +60 -0
- package/docs/modules/services.html +24 -0
- package/lib/client.d.ts +8 -1
- package/lib/client.d.ts.map +1 -1
- package/lib/client.js +4 -1
- package/lib/client.js.map +1 -1
- package/lib/datatypes.d.ts +147 -4
- package/lib/datatypes.d.ts.map +1 -1
- package/lib/services.d.ts +90 -0
- package/lib/services.d.ts.map +1 -1
- package/lib/services.js +545 -226
- package/lib/services.js.map +1 -1
- package/package.json +2 -1
- package/src/client.ts +13 -2
- package/src/datatypes.ts +162 -4
- package/src/services.ts +458 -122
|
@@ -104,7 +104,7 @@
|
|
|
104
104
|
<div class="tsd-signature tsd-kind-icon">amazon<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuthAmazon.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuthAmazon</a></div>
|
|
105
105
|
<aside class="tsd-sources">
|
|
106
106
|
<ul>
|
|
107
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
107
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/datatypes.ts#L822">datatypes.ts:822</a></li>
|
|
108
108
|
</ul>
|
|
109
109
|
</aside>
|
|
110
110
|
<div class="tsd-comment tsd-typography">
|
|
@@ -119,7 +119,7 @@
|
|
|
119
119
|
<div class="tsd-signature tsd-kind-icon">facebook<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuthFacebook.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuthFacebook</a></div>
|
|
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/e084758/src/datatypes.ts#L810">datatypes.ts:810</a></li>
|
|
123
123
|
</ul>
|
|
124
124
|
</aside>
|
|
125
125
|
<div class="tsd-comment tsd-typography">
|
|
@@ -134,7 +134,7 @@
|
|
|
134
134
|
<div class="tsd-signature tsd-kind-icon">github<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuthGitHub.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuthGitHub</a></div>
|
|
135
135
|
<aside class="tsd-sources">
|
|
136
136
|
<ul>
|
|
137
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
137
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/datatypes.ts#L808">datatypes.ts:808</a></li>
|
|
138
138
|
</ul>
|
|
139
139
|
</aside>
|
|
140
140
|
<div class="tsd-comment tsd-typography">
|
|
@@ -149,7 +149,7 @@
|
|
|
149
149
|
<div class="tsd-signature tsd-kind-icon">gitlab<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuthGitLab.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuthGitLab</a></div>
|
|
150
150
|
<aside class="tsd-sources">
|
|
151
151
|
<ul>
|
|
152
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
152
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/datatypes.ts#L818">datatypes.ts:818</a></li>
|
|
153
153
|
</ul>
|
|
154
154
|
</aside>
|
|
155
155
|
<div class="tsd-comment tsd-typography">
|
|
@@ -164,7 +164,7 @@
|
|
|
164
164
|
<div class="tsd-signature tsd-kind-icon">google<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuthGoogle.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuthGoogle</a></div>
|
|
165
165
|
<aside class="tsd-sources">
|
|
166
166
|
<ul>
|
|
167
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
167
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/datatypes.ts#L814">datatypes.ts:814</a></li>
|
|
168
168
|
</ul>
|
|
169
169
|
</aside>
|
|
170
170
|
<div class="tsd-comment tsd-typography">
|
|
@@ -179,7 +179,7 @@
|
|
|
179
179
|
<div class="tsd-signature tsd-kind-icon">linkedin<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuthLinkedIn.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuthLinkedIn</a></div>
|
|
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/e084758/src/datatypes.ts#L816">datatypes.ts:816</a></li>
|
|
183
183
|
</ul>
|
|
184
184
|
</aside>
|
|
185
185
|
<div class="tsd-comment tsd-typography">
|
|
@@ -194,7 +194,7 @@
|
|
|
194
194
|
<div class="tsd-signature tsd-kind-icon">microsoft<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuthMicrosoft.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuthMicrosoft</a></div>
|
|
195
195
|
<aside class="tsd-sources">
|
|
196
196
|
<ul>
|
|
197
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
197
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/datatypes.ts#L812">datatypes.ts:812</a></li>
|
|
198
198
|
</ul>
|
|
199
199
|
</aside>
|
|
200
200
|
<div class="tsd-comment tsd-typography">
|
|
@@ -209,7 +209,7 @@
|
|
|
209
209
|
<div class="tsd-signature tsd-kind-icon">twitch<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuthTwitch.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuthTwitch</a></div>
|
|
210
210
|
<aside class="tsd-sources">
|
|
211
211
|
<ul>
|
|
212
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
212
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/datatypes.ts#L820">datatypes.ts:820</a></li>
|
|
213
213
|
</ul>
|
|
214
214
|
</aside>
|
|
215
215
|
<div class="tsd-comment tsd-typography">
|
|
@@ -101,7 +101,7 @@
|
|
|
101
101
|
<div class="tsd-signature tsd-kind-icon">client<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
102
102
|
<aside class="tsd-sources">
|
|
103
103
|
<ul>
|
|
104
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
104
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/datatypes.ts#L898">datatypes.ts:898</a></li>
|
|
105
105
|
</ul>
|
|
106
106
|
</aside>
|
|
107
107
|
</section>
|
|
@@ -111,7 +111,7 @@
|
|
|
111
111
|
<div class="tsd-signature tsd-kind-icon">client<wbr>Secret<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
112
112
|
<aside class="tsd-sources">
|
|
113
113
|
<ul>
|
|
114
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
114
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/datatypes.ts#L899">datatypes.ts:899</a></li>
|
|
115
115
|
</ul>
|
|
116
116
|
</aside>
|
|
117
117
|
</section>
|
|
@@ -121,7 +121,7 @@
|
|
|
121
121
|
<div class="tsd-signature tsd-kind-icon">email<wbr>Addresses<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
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/e084758/src/datatypes.ts#L901">datatypes.ts:901</a></li>
|
|
125
125
|
</ul>
|
|
126
126
|
</aside>
|
|
127
127
|
</section>
|
|
@@ -131,7 +131,7 @@
|
|
|
131
131
|
<div class="tsd-signature tsd-kind-icon">email<wbr>Domains<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
132
132
|
<aside class="tsd-sources">
|
|
133
133
|
<ul>
|
|
134
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
134
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/datatypes.ts#L902">datatypes.ts:902</a></li>
|
|
135
135
|
</ul>
|
|
136
136
|
</aside>
|
|
137
137
|
</section>
|
|
@@ -141,7 +141,7 @@
|
|
|
141
141
|
<div class="tsd-signature tsd-kind-icon">scopes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
142
142
|
<aside class="tsd-sources">
|
|
143
143
|
<ul>
|
|
144
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
144
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/datatypes.ts#L900">datatypes.ts:900</a></li>
|
|
145
145
|
</ul>
|
|
146
146
|
</aside>
|
|
147
147
|
</section>
|
|
@@ -105,7 +105,7 @@
|
|
|
105
105
|
<div class="tsd-signature tsd-kind-icon">client<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
106
106
|
<aside class="tsd-sources">
|
|
107
107
|
<ul>
|
|
108
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
108
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/datatypes.ts#L983">datatypes.ts:983</a></li>
|
|
109
109
|
</ul>
|
|
110
110
|
</aside>
|
|
111
111
|
<div class="tsd-comment tsd-typography">
|
|
@@ -120,7 +120,7 @@
|
|
|
120
120
|
<div class="tsd-signature tsd-kind-icon">client<wbr>Secret<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
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/e084758/src/datatypes.ts#L985">datatypes.ts:985</a></li>
|
|
124
124
|
</ul>
|
|
125
125
|
</aside>
|
|
126
126
|
<div class="tsd-comment tsd-typography">
|
|
@@ -135,7 +135,7 @@
|
|
|
135
135
|
<div class="tsd-signature tsd-kind-icon">cookie<wbr>Prefix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
136
136
|
<aside class="tsd-sources">
|
|
137
137
|
<ul>
|
|
138
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
138
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/datatypes.ts#L975">datatypes.ts:975</a></li>
|
|
139
139
|
</ul>
|
|
140
140
|
</aside>
|
|
141
141
|
<div class="tsd-comment tsd-typography">
|
|
@@ -150,7 +150,7 @@
|
|
|
150
150
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
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/e084758/src/datatypes.ts#L971">datatypes.ts:971</a></li>
|
|
154
154
|
</ul>
|
|
155
155
|
</aside>
|
|
156
156
|
<div class="tsd-comment tsd-typography">
|
|
@@ -165,7 +165,7 @@
|
|
|
165
165
|
<div class="tsd-signature tsd-kind-icon">inactivity<wbr>Timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
166
166
|
<aside class="tsd-sources">
|
|
167
167
|
<ul>
|
|
168
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
168
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/datatypes.ts#L977">datatypes.ts:977</a></li>
|
|
169
169
|
</ul>
|
|
170
170
|
</aside>
|
|
171
171
|
<div class="tsd-comment tsd-typography">
|
|
@@ -180,7 +180,7 @@
|
|
|
180
180
|
<div class="tsd-signature tsd-kind-icon">issuer<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
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/e084758/src/datatypes.ts#L981">datatypes.ts:981</a></li>
|
|
184
184
|
</ul>
|
|
185
185
|
</aside>
|
|
186
186
|
<div class="tsd-comment tsd-typography">
|
|
@@ -195,7 +195,7 @@
|
|
|
195
195
|
<div class="tsd-signature tsd-kind-icon">maximum<wbr>Duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
196
196
|
<aside class="tsd-sources">
|
|
197
197
|
<ul>
|
|
198
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
198
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/datatypes.ts#L979">datatypes.ts:979</a></li>
|
|
199
199
|
</ul>
|
|
200
200
|
</aside>
|
|
201
201
|
<div class="tsd-comment tsd-typography">
|
|
@@ -210,7 +210,7 @@
|
|
|
210
210
|
<div class="tsd-signature tsd-kind-icon">options<wbr>Passthrough<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
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/e084758/src/datatypes.ts#L973">datatypes.ts:973</a></li>
|
|
214
214
|
</ul>
|
|
215
215
|
</aside>
|
|
216
216
|
<div class="tsd-comment tsd-typography">
|
|
@@ -225,7 +225,7 @@
|
|
|
225
225
|
<div class="tsd-signature tsd-kind-icon">scopes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
226
226
|
<aside class="tsd-sources">
|
|
227
227
|
<ul>
|
|
228
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
228
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/datatypes.ts#L987">datatypes.ts:987</a></li>
|
|
229
229
|
</ul>
|
|
230
230
|
</aside>
|
|
231
231
|
<div class="tsd-comment tsd-typography">
|
|
@@ -0,0 +1,205 @@
|
|
|
1
|
+
<!doctype html>
|
|
2
|
+
<html class="default no-js">
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta http-equiv="X-UA-Compatible" content="IE=edge">
|
|
6
|
+
<title>EndpointPolicy | @ngrok/ngrok-api</title>
|
|
7
|
+
<meta name="description" content="Documentation for @ngrok/ngrok-api">
|
|
8
|
+
<meta name="viewport" content="width=device-width, initial-scale=1">
|
|
9
|
+
<link rel="stylesheet" href="../assets/css/main.css">
|
|
10
|
+
<script async src="../assets/js/search.js" id="search-script"></script>
|
|
11
|
+
</head>
|
|
12
|
+
<body>
|
|
13
|
+
<header>
|
|
14
|
+
<div class="tsd-page-toolbar">
|
|
15
|
+
<div class="container">
|
|
16
|
+
<div class="table-wrap">
|
|
17
|
+
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
|
|
18
|
+
<div class="field">
|
|
19
|
+
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
|
|
20
|
+
<input id="tsd-search-field" type="text" />
|
|
21
|
+
</div>
|
|
22
|
+
<ul class="results">
|
|
23
|
+
<li class="state loading">Preparing search index...</li>
|
|
24
|
+
<li class="state failure">The search index is not available</li>
|
|
25
|
+
</ul>
|
|
26
|
+
<a href="../index.html" class="title">@ngrok/ngrok-api</a>
|
|
27
|
+
</div>
|
|
28
|
+
<div class="table-cell" id="tsd-widgets">
|
|
29
|
+
<div id="tsd-filter">
|
|
30
|
+
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
|
|
31
|
+
<div class="tsd-filter-group">
|
|
32
|
+
<div class="tsd-select" id="tsd-filter-visibility">
|
|
33
|
+
<span class="tsd-select-label">All</span>
|
|
34
|
+
<ul class="tsd-select-list">
|
|
35
|
+
<li data-value="public">Public</li>
|
|
36
|
+
<li data-value="protected">Public/Protected</li>
|
|
37
|
+
<li data-value="private" class="selected">All</li>
|
|
38
|
+
</ul>
|
|
39
|
+
</div>
|
|
40
|
+
<input type="checkbox" id="tsd-filter-inherited" checked />
|
|
41
|
+
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
|
|
42
|
+
<input type="checkbox" id="tsd-filter-externals" checked />
|
|
43
|
+
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
|
|
44
|
+
</div>
|
|
45
|
+
</div>
|
|
46
|
+
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
|
|
47
|
+
</div>
|
|
48
|
+
</div>
|
|
49
|
+
</div>
|
|
50
|
+
</div>
|
|
51
|
+
<div class="tsd-page-title">
|
|
52
|
+
<div class="container">
|
|
53
|
+
<ul class="tsd-breadcrumb">
|
|
54
|
+
<li>
|
|
55
|
+
<a href="../modules.html">@ngrok/ngrok-api</a>
|
|
56
|
+
</li>
|
|
57
|
+
<li>
|
|
58
|
+
<a href="../modules/datatypes.html">datatypes</a>
|
|
59
|
+
</li>
|
|
60
|
+
<li>
|
|
61
|
+
<a href="datatypes.EndpointPolicy.html">EndpointPolicy</a>
|
|
62
|
+
</li>
|
|
63
|
+
</ul>
|
|
64
|
+
<h1>Interface EndpointPolicy</h1>
|
|
65
|
+
</div>
|
|
66
|
+
</div>
|
|
67
|
+
</header>
|
|
68
|
+
<div class="container container-main">
|
|
69
|
+
<div class="row">
|
|
70
|
+
<div class="col-8 col-content">
|
|
71
|
+
<section class="tsd-panel tsd-hierarchy">
|
|
72
|
+
<h3>Hierarchy</h3>
|
|
73
|
+
<ul class="tsd-hierarchy">
|
|
74
|
+
<li>
|
|
75
|
+
<span class="target">EndpointPolicy</span>
|
|
76
|
+
</li>
|
|
77
|
+
</ul>
|
|
78
|
+
</section>
|
|
79
|
+
<section class="tsd-panel-group tsd-index-group">
|
|
80
|
+
<h2>Index</h2>
|
|
81
|
+
<section class="tsd-panel tsd-index-panel">
|
|
82
|
+
<div class="tsd-index-content">
|
|
83
|
+
<section class="tsd-index-section ">
|
|
84
|
+
<h3>Properties</h3>
|
|
85
|
+
<ul class="tsd-index-list">
|
|
86
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointPolicy.html#enabled" class="tsd-kind-icon">enabled</a></li>
|
|
87
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointPolicy.html#inbound" class="tsd-kind-icon">inbound</a></li>
|
|
88
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointPolicy.html#outbound" class="tsd-kind-icon">outbound</a></li>
|
|
89
|
+
</ul>
|
|
90
|
+
</section>
|
|
91
|
+
</div>
|
|
92
|
+
</section>
|
|
93
|
+
</section>
|
|
94
|
+
<section class="tsd-panel-group tsd-member-group ">
|
|
95
|
+
<h2>Properties</h2>
|
|
96
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
97
|
+
<a name="enabled" class="tsd-anchor"></a>
|
|
98
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> enabled</h3>
|
|
99
|
+
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
100
|
+
<aside class="tsd-sources">
|
|
101
|
+
<ul>
|
|
102
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1017">datatypes.ts:1017</a></li>
|
|
103
|
+
</ul>
|
|
104
|
+
</aside>
|
|
105
|
+
<div class="tsd-comment tsd-typography">
|
|
106
|
+
<div class="lead">
|
|
107
|
+
<p><code>true</code> if the module will be applied to traffic, <code>false</code> to disable. default <code>true</code> if unspecified</p>
|
|
108
|
+
</div>
|
|
109
|
+
</div>
|
|
110
|
+
</section>
|
|
111
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
112
|
+
<a name="inbound" class="tsd-anchor"></a>
|
|
113
|
+
<h3>inbound</h3>
|
|
114
|
+
<div class="tsd-signature tsd-kind-icon">inbound<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointRule.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointRule</a><span class="tsd-signature-symbol">[]</span></div>
|
|
115
|
+
<aside class="tsd-sources">
|
|
116
|
+
<ul>
|
|
117
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1019">datatypes.ts:1019</a></li>
|
|
118
|
+
</ul>
|
|
119
|
+
</aside>
|
|
120
|
+
<div class="tsd-comment tsd-typography">
|
|
121
|
+
<div class="lead">
|
|
122
|
+
<p>the inbound rules of the traffic policy.</p>
|
|
123
|
+
</div>
|
|
124
|
+
</div>
|
|
125
|
+
</section>
|
|
126
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
127
|
+
<a name="outbound" class="tsd-anchor"></a>
|
|
128
|
+
<h3>outbound</h3>
|
|
129
|
+
<div class="tsd-signature tsd-kind-icon">outbound<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointRule.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointRule</a><span class="tsd-signature-symbol">[]</span></div>
|
|
130
|
+
<aside class="tsd-sources">
|
|
131
|
+
<ul>
|
|
132
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1021">datatypes.ts:1021</a></li>
|
|
133
|
+
</ul>
|
|
134
|
+
</aside>
|
|
135
|
+
<div class="tsd-comment tsd-typography">
|
|
136
|
+
<div class="lead">
|
|
137
|
+
<p>the outbound rules on the traffic policy.</p>
|
|
138
|
+
</div>
|
|
139
|
+
</div>
|
|
140
|
+
</section>
|
|
141
|
+
</section>
|
|
142
|
+
</div>
|
|
143
|
+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
144
|
+
<nav class="tsd-navigation primary">
|
|
145
|
+
<ul>
|
|
146
|
+
<li class=" ">
|
|
147
|
+
<a href="../modules.html">Modules</a>
|
|
148
|
+
</li>
|
|
149
|
+
<li class=" tsd-kind-module">
|
|
150
|
+
<a href="../modules/client.html">client</a>
|
|
151
|
+
</li>
|
|
152
|
+
<li class="current tsd-kind-module">
|
|
153
|
+
<a href="../modules/datatypes.html">datatypes</a>
|
|
154
|
+
</li>
|
|
155
|
+
<li class=" tsd-kind-module">
|
|
156
|
+
<a href="../modules/services.html">services</a>
|
|
157
|
+
</li>
|
|
158
|
+
</ul>
|
|
159
|
+
</nav>
|
|
160
|
+
<nav class="tsd-navigation secondary menu-sticky">
|
|
161
|
+
<ul class="before-current">
|
|
162
|
+
</ul>
|
|
163
|
+
<ul class="current">
|
|
164
|
+
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
165
|
+
<a href="datatypes.EndpointPolicy.html" class="tsd-kind-icon">Endpoint<wbr>Policy</a>
|
|
166
|
+
<ul>
|
|
167
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
168
|
+
<a href="datatypes.EndpointPolicy.html#enabled" class="tsd-kind-icon">enabled</a>
|
|
169
|
+
</li>
|
|
170
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
171
|
+
<a href="datatypes.EndpointPolicy.html#inbound" class="tsd-kind-icon">inbound</a>
|
|
172
|
+
</li>
|
|
173
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
174
|
+
<a href="datatypes.EndpointPolicy.html#outbound" class="tsd-kind-icon">outbound</a>
|
|
175
|
+
</li>
|
|
176
|
+
</ul>
|
|
177
|
+
</li>
|
|
178
|
+
</ul>
|
|
179
|
+
<ul class="after-current">
|
|
180
|
+
</ul>
|
|
181
|
+
</nav>
|
|
182
|
+
</div>
|
|
183
|
+
</div>
|
|
184
|
+
</div>
|
|
185
|
+
<footer class="with-border-bottom">
|
|
186
|
+
<div class="container">
|
|
187
|
+
<h2>Legend</h2>
|
|
188
|
+
<div class="tsd-legend-group">
|
|
189
|
+
<ul class="tsd-legend">
|
|
190
|
+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
191
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
192
|
+
</ul>
|
|
193
|
+
<ul class="tsd-legend">
|
|
194
|
+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
195
|
+
</ul>
|
|
196
|
+
</div>
|
|
197
|
+
</div>
|
|
198
|
+
</footer>
|
|
199
|
+
<div class="container tsd-generator">
|
|
200
|
+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
201
|
+
</div>
|
|
202
|
+
<div class="overlay"></div>
|
|
203
|
+
<script src="../assets/js/main.js"></script>
|
|
204
|
+
</body>
|
|
205
|
+
</html>
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
<div class="tsd-signature tsd-kind-icon">add<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></div>
|
|
100
100
|
<aside class="tsd-sources">
|
|
101
101
|
<ul>
|
|
102
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
102
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/datatypes.ts#L746">datatypes.ts:746</a></li>
|
|
103
103
|
</ul>
|
|
104
104
|
</aside>
|
|
105
105
|
<div class="tsd-comment tsd-typography">
|
|
@@ -114,7 +114,7 @@
|
|
|
114
114
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
115
115
|
<aside class="tsd-sources">
|
|
116
116
|
<ul>
|
|
117
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
117
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/datatypes.ts#L744">datatypes.ts:744</a></li>
|
|
118
118
|
</ul>
|
|
119
119
|
</aside>
|
|
120
120
|
<div class="tsd-comment tsd-typography">
|
|
@@ -129,7 +129,7 @@
|
|
|
129
129
|
<div class="tsd-signature tsd-kind-icon">remove<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
130
130
|
<aside class="tsd-sources">
|
|
131
131
|
<ul>
|
|
132
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
132
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/datatypes.ts#L748">datatypes.ts:748</a></li>
|
|
133
133
|
</ul>
|
|
134
134
|
</aside>
|
|
135
135
|
<div class="tsd-comment tsd-typography">
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
<div class="tsd-signature tsd-kind-icon">add<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">></span></div>
|
|
100
100
|
<aside class="tsd-sources">
|
|
101
101
|
<ul>
|
|
102
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
102
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/datatypes.ts#L755">datatypes.ts:755</a></li>
|
|
103
103
|
</ul>
|
|
104
104
|
</aside>
|
|
105
105
|
<div class="tsd-comment tsd-typography">
|
|
@@ -114,7 +114,7 @@
|
|
|
114
114
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
115
115
|
<aside class="tsd-sources">
|
|
116
116
|
<ul>
|
|
117
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
117
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/datatypes.ts#L753">datatypes.ts:753</a></li>
|
|
118
118
|
</ul>
|
|
119
119
|
</aside>
|
|
120
120
|
<div class="tsd-comment tsd-typography">
|
|
@@ -129,7 +129,7 @@
|
|
|
129
129
|
<div class="tsd-signature tsd-kind-icon">remove<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
130
130
|
<aside class="tsd-sources">
|
|
131
131
|
<ul>
|
|
132
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
132
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/e084758/src/datatypes.ts#L757">datatypes.ts:757</a></li>
|
|
133
133
|
</ul>
|
|
134
134
|
</aside>
|
|
135
135
|
<div class="tsd-comment tsd-typography">
|