@ngrok/ngrok-api 0.3.0 → 0.9.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/README.md +21 -44
- package/docs/assets/js/search.js +1 -1
- package/docs/classes/client.Ngrok.html +191 -100
- package/docs/classes/services.APIKeys.html +6 -105
- package/docs/classes/services.AbuseReports.html +3 -102
- package/docs/classes/services.AgentIngresses.html +6 -105
- package/docs/classes/services.CertificateAuthorities.html +6 -105
- package/docs/classes/services.Credentials.html +6 -105
- package/docs/classes/services.EdgeRouteBackendModule.html +270 -0
- package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +270 -0
- package/docs/classes/services.EdgeRouteCompressionModule.html +270 -0
- package/docs/classes/{services.EndpointCircuitBreakerModule.html → services.EdgeRouteIPRestrictionModule.html} +28 -127
- package/docs/classes/services.EdgeRouteOAuthModule.html +270 -0
- package/docs/classes/services.EdgeRouteOIDCModule.html +270 -0
- package/docs/classes/{services.EndpointResponseHeadersModule.html → services.EdgeRouteRequestHeadersModule.html} +28 -127
- package/docs/classes/services.EdgeRouteResponseHeadersModule.html +270 -0
- package/docs/classes/services.EdgeRouteSAMLModule.html +270 -0
- package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +270 -0
- package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +270 -0
- package/docs/classes/services.EdgesHTTPS.html +343 -0
- package/docs/classes/services.EdgesHTTPSRoutes.html +317 -0
- package/docs/classes/services.EdgesTCP.html +343 -0
- package/docs/classes/services.EdgesTLS.html +343 -0
- package/docs/classes/services.Endpoints.html +256 -0
- package/docs/classes/services.EventDestinations.html +7 -106
- package/docs/classes/services.EventSources.html +6 -105
- package/docs/classes/services.EventSubscriptions.html +6 -105
- package/docs/classes/services.FailoverBackends.html +353 -0
- package/docs/classes/services.HTTPResponseBackends.html +318 -0
- package/docs/classes/{services.EndpointMutualTLSModule.html → services.HTTPSEdgeMutualTLSModule.html} +22 -121
- package/docs/classes/{services.EndpointTLSTerminationModule.html → services.HTTPSEdgeTLSTerminationModule.html} +22 -121
- package/docs/classes/services.IPPolicies.html +6 -105
- package/docs/classes/services.IPPolicyRules.html +6 -105
- package/docs/classes/services.IPRestrictions.html +7 -106
- package/docs/classes/services.ReservedAddrs.html +6 -137
- package/docs/classes/services.ReservedDomains.html +8 -171
- package/docs/classes/services.SSHCertificateAuthorities.html +6 -105
- package/docs/classes/services.SSHCredentials.html +6 -105
- package/docs/classes/services.SSHHostCertificates.html +6 -105
- package/docs/classes/services.SSHUserCertificates.html +6 -105
- package/docs/classes/{services.EndpointSAMLModule.html → services.TCPEdgeBackendModule.html} +25 -124
- package/docs/classes/{services.EndpointIPPolicyModule.html → services.TCPEdgeIPRestrictionModule.html} +22 -121
- package/docs/classes/services.TLSCertificates.html +6 -105
- package/docs/classes/{services.EndpointLoggingModule.html → services.TLSEdgeBackendModule.html} +25 -124
- package/docs/classes/{services.EndpointOIDCModule.html → services.TLSEdgeIPRestrictionModule.html} +25 -124
- package/docs/classes/{services.EndpointOAuthModule.html → services.TLSEdgeMutualTLSModule.html} +25 -124
- package/docs/classes/services.TLSEdgeTLSTerminationModule.html +270 -0
- package/docs/classes/services.TunnelGroupBackends.html +351 -0
- package/docs/classes/services.TunnelSessions.html +6 -105
- package/docs/classes/services.Tunnels.html +34 -101
- package/docs/classes/{services.EventStreams.html → services.WeightedBackends.html} +51 -140
- package/docs/index.html +22 -43
- package/docs/interfaces/client.NgrokConfig.html +2 -2
- package/docs/interfaces/datatypes.APIKey.html +6 -6
- package/docs/interfaces/datatypes.APIKeyCreate.html +2 -2
- 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 +8 -8
- package/docs/interfaces/datatypes.AgentIngressCreate.html +3 -3
- package/docs/interfaces/datatypes.AgentIngressList.html +3 -3
- package/docs/interfaces/datatypes.AgentIngressUpdate.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 +3 -3
- package/docs/interfaces/datatypes.CredentialList.html +3 -3
- package/docs/interfaces/datatypes.CredentialUpdate.html +4 -4
- package/docs/interfaces/{datatypes.EndpointOIDCReplace.html → datatypes.EdgeBackendReplace.html} +12 -12
- package/docs/interfaces/{datatypes.EndpointIPPolicyReplace.html → datatypes.EdgeIPRestrictionReplace.html} +11 -11
- package/docs/interfaces/{datatypes.EndpointMutualTLSReplace.html → datatypes.EdgeMutualTLSReplace.html} +11 -11
- package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +190 -0
- package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +190 -0
- package/docs/interfaces/{datatypes.EndpointCompressionReplace.html → datatypes.EdgeRouteCompressionReplace.html} +25 -11
- package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +190 -0
- package/docs/interfaces/{datatypes.EndpointCircuitBreakerReplace.html → datatypes.EdgeRouteItem.html} +27 -17
- package/docs/interfaces/{datatypes.EndpointOAuthReplace.html → datatypes.EdgeRouteOAuthReplace.html} +25 -11
- package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +190 -0
- package/docs/interfaces/{datatypes.EndpointRequestHeadersReplace.html → datatypes.EdgeRouteRequestHeadersReplace.html} +25 -11
- package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +190 -0
- package/docs/interfaces/{datatypes.EndpointSAMLReplace.html → datatypes.EdgeRouteSAMLReplace.html} +25 -11
- package/docs/interfaces/{datatypes.EndpointWebhookValidationReplace.html → datatypes.EdgeRouteWebhookVerificationReplace.html} +25 -11
- package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +190 -0
- package/docs/interfaces/{datatypes.EndpointResponseHeadersReplace.html → datatypes.EdgeTLSTerminationAtEdgeReplace.html} +12 -12
- package/docs/interfaces/{datatypes.EndpointTLSTerminationReplace.html → datatypes.EdgeTLSTerminationReplace.html} +11 -11
- package/docs/interfaces/datatypes.Endpoint.html +395 -0
- package/docs/interfaces/{datatypes.EndpointLogging.html → datatypes.EndpointBackend.html} +19 -19
- package/docs/interfaces/{datatypes.EndpointLoggingMutate.html → datatypes.EndpointBackendMutate.html} +19 -19
- 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 +205 -0
- package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
- package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +3 -3
- package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
- package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +7 -7
- package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthProvider.html +4 -4
- 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 +186 -0
- package/docs/interfaces/datatypes.EndpointWebhookValidation.html +4 -4
- package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +167 -0
- 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 +5 -5
- package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
- package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +6 -6
- package/docs/interfaces/datatypes.EventTarget.html +3 -3
- package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
- package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
- package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
- package/docs/interfaces/{datatypes.EventStreamCreate.html → datatypes.FailoverBackend.html} +44 -44
- package/docs/interfaces/datatypes.FailoverBackendCreate.html +205 -0
- package/docs/interfaces/datatypes.FailoverBackendList.html +205 -0
- package/docs/interfaces/datatypes.FailoverBackendUpdate.html +219 -0
- package/docs/interfaces/datatypes.HTTPResponseBackend.html +295 -0
- package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +243 -0
- package/docs/interfaces/datatypes.HTTPResponseBackendList.html +190 -0
- package/docs/interfaces/{datatypes.EventStreamUpdate.html → datatypes.HTTPResponseBackendUpdate.html} +40 -45
- package/docs/interfaces/{datatypes.EventStream.html → datatypes.HTTPSEdge.html} +58 -63
- package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +238 -0
- package/docs/interfaces/{datatypes.EventStreamList.html → datatypes.HTTPSEdgeList.html} +20 -20
- package/docs/interfaces/{datatypes.EndpointConfiguration.html → datatypes.HTTPSEdgeRoute.html} +123 -104
- package/docs/interfaces/{datatypes.EndpointConfigurationCreate.html → datatypes.HTTPSEdgeRouteCreate.html} +108 -89
- package/docs/interfaces/{datatypes.EndpointConfigurationUpdate.html → datatypes.HTTPSEdgeRouteUpdate.html} +115 -77
- package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +257 -0
- package/docs/interfaces/datatypes.IPPolicy.html +5 -24
- package/docs/interfaces/datatypes.IPPolicyCreate.html +2 -21
- package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRule.html +26 -7
- package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +23 -4
- 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 +4 -4
- package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
- package/docs/interfaces/datatypes.Item.html +1 -1
- package/docs/interfaces/datatypes.Paging.html +2 -2
- package/docs/interfaces/datatypes.Ref.html +2 -2
- package/docs/interfaces/datatypes.ReservedAddr.html +7 -26
- package/docs/interfaces/datatypes.ReservedAddrCreate.html +3 -22
- package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
- package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -22
- package/docs/interfaces/datatypes.ReservedDomain.html +12 -50
- 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 +6 -44
- package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -43
- 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 +7 -7
- package/docs/interfaces/datatypes.SSHCredentialCreate.html +4 -4
- 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 +15 -15
- package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +10 -10
- package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.TCPEdge.html +295 -0
- package/docs/interfaces/datatypes.TCPEdgeCreate.html +238 -0
- package/docs/interfaces/datatypes.TCPEdgeList.html +205 -0
- package/docs/interfaces/datatypes.TCPEdgeUpdate.html +257 -0
- 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 +323 -0
- package/docs/interfaces/datatypes.TLSEdgeCreate.html +266 -0
- package/docs/interfaces/datatypes.TLSEdgeList.html +205 -0
- package/docs/interfaces/datatypes.TLSEdgeUpdate.html +285 -0
- package/docs/interfaces/datatypes.Tunnel.html +85 -9
- package/docs/interfaces/datatypes.TunnelGroupBackend.html +281 -0
- package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +205 -0
- package/docs/interfaces/datatypes.TunnelGroupBackendList.html +205 -0
- package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +219 -0
- 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.WeightedBackend.html +262 -0
- package/docs/interfaces/datatypes.WeightedBackendCreate.html +205 -0
- package/docs/interfaces/{datatypes.EndpointConfigurationList.html → datatypes.WeightedBackendList.html} +19 -19
- package/docs/interfaces/datatypes.WeightedBackendUpdate.html +219 -0
- package/docs/modules/datatypes.html +197 -69
- package/docs/modules/services.html +85 -29
- package/lib/client.d.ts +53 -19
- package/lib/client.d.ts.map +1 -1
- package/lib/client.js +43 -19
- package/lib/client.js.map +1 -1
- package/lib/datatypes.d.ts +575 -241
- package/lib/datatypes.d.ts.map +1 -1
- package/lib/services.d.ts +358 -138
- package/lib/services.d.ts.map +1 -1
- package/lib/services.js +1367 -528
- package/lib/services.js.map +1 -1
- package/package.json +2 -2
- package/src/client.ts +96 -39
- package/src/datatypes.ts +623 -257
- package/src/services.ts +1363 -543
- package/docs/classes/services.EndpointCompressionModule.html +0 -369
- package/docs/classes/services.EndpointConfigurations.html +0 -451
- package/docs/classes/services.EndpointRequestHeadersModule.html +0 -369
- package/docs/classes/services.EndpointWebhookValidationModule.html +0 -369
- package/docs/interfaces/datatypes.EndpointLoggingReplace.html +0 -176
- package/test/endpointConfigurations.test.js +0 -67
|
@@ -0,0 +1,257 @@
|
|
|
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>HTTPSEdgeUpdate | @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.HTTPSEdgeUpdate.html">HTTPSEdgeUpdate</a>
|
|
62
|
+
</li>
|
|
63
|
+
</ul>
|
|
64
|
+
<h1>Interface HTTPSEdgeUpdate</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">HTTPSEdgeUpdate</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.HTTPSEdgeUpdate.html#description" class="tsd-kind-icon">description</a></li>
|
|
87
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeUpdate.html#hostports" class="tsd-kind-icon">hostports</a></li>
|
|
88
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeUpdate.html#id" class="tsd-kind-icon">id</a></li>
|
|
89
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeUpdate.html#metadata" class="tsd-kind-icon">metadata</a></li>
|
|
90
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeUpdate.html#mutualTls" class="tsd-kind-icon">mutual<wbr>Tls</a></li>
|
|
91
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeUpdate.html#tlsTermination" class="tsd-kind-icon">tls<wbr>Termination</a></li>
|
|
92
|
+
</ul>
|
|
93
|
+
</section>
|
|
94
|
+
</div>
|
|
95
|
+
</section>
|
|
96
|
+
</section>
|
|
97
|
+
<section class="tsd-panel-group tsd-member-group ">
|
|
98
|
+
<h2>Properties</h2>
|
|
99
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
100
|
+
<a name="description" class="tsd-anchor"></a>
|
|
101
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
|
|
102
|
+
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
103
|
+
<aside class="tsd-sources">
|
|
104
|
+
<ul>
|
|
105
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L835">datatypes.ts:835</a></li>
|
|
106
|
+
</ul>
|
|
107
|
+
</aside>
|
|
108
|
+
<div class="tsd-comment tsd-typography">
|
|
109
|
+
<div class="lead">
|
|
110
|
+
<p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
|
|
111
|
+
</div>
|
|
112
|
+
</div>
|
|
113
|
+
</section>
|
|
114
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
115
|
+
<a name="hostports" class="tsd-anchor"></a>
|
|
116
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> hostports</h3>
|
|
117
|
+
<div class="tsd-signature tsd-kind-icon">hostports<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
118
|
+
<aside class="tsd-sources">
|
|
119
|
+
<ul>
|
|
120
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L839">datatypes.ts:839</a></li>
|
|
121
|
+
</ul>
|
|
122
|
+
</aside>
|
|
123
|
+
<div class="tsd-comment tsd-typography">
|
|
124
|
+
<div class="lead">
|
|
125
|
+
<p>hostports served by this edge</p>
|
|
126
|
+
</div>
|
|
127
|
+
</div>
|
|
128
|
+
</section>
|
|
129
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
130
|
+
<a name="id" class="tsd-anchor"></a>
|
|
131
|
+
<h3>id</h3>
|
|
132
|
+
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
133
|
+
<aside class="tsd-sources">
|
|
134
|
+
<ul>
|
|
135
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L833">datatypes.ts:833</a></li>
|
|
136
|
+
</ul>
|
|
137
|
+
</aside>
|
|
138
|
+
<div class="tsd-comment tsd-typography">
|
|
139
|
+
<div class="lead">
|
|
140
|
+
<p>unique identifier of this edge</p>
|
|
141
|
+
</div>
|
|
142
|
+
</div>
|
|
143
|
+
</section>
|
|
144
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
145
|
+
<a name="metadata" class="tsd-anchor"></a>
|
|
146
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
|
|
147
|
+
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
148
|
+
<aside class="tsd-sources">
|
|
149
|
+
<ul>
|
|
150
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L837">datatypes.ts:837</a></li>
|
|
151
|
+
</ul>
|
|
152
|
+
</aside>
|
|
153
|
+
<div class="tsd-comment tsd-typography">
|
|
154
|
+
<div class="lead">
|
|
155
|
+
<p>arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes.</p>
|
|
156
|
+
</div>
|
|
157
|
+
</div>
|
|
158
|
+
</section>
|
|
159
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
160
|
+
<a name="mutualTls" class="tsd-anchor"></a>
|
|
161
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> mutual<wbr>Tls</h3>
|
|
162
|
+
<div class="tsd-signature tsd-kind-icon">mutual<wbr>Tls<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointMutualTLSMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointMutualTLSMutate</a></div>
|
|
163
|
+
<aside class="tsd-sources">
|
|
164
|
+
<ul>
|
|
165
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L841">datatypes.ts:841</a></li>
|
|
166
|
+
</ul>
|
|
167
|
+
</aside>
|
|
168
|
+
<div class="tsd-comment tsd-typography">
|
|
169
|
+
<div class="lead">
|
|
170
|
+
<p>edge modules</p>
|
|
171
|
+
</div>
|
|
172
|
+
</div>
|
|
173
|
+
</section>
|
|
174
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
175
|
+
<a name="tlsTermination" class="tsd-anchor"></a>
|
|
176
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> tls<wbr>Termination</h3>
|
|
177
|
+
<div class="tsd-signature tsd-kind-icon">tls<wbr>Termination<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointTLSTerminationAtEdge.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTLSTerminationAtEdge</a></div>
|
|
178
|
+
<aside class="tsd-sources">
|
|
179
|
+
<ul>
|
|
180
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L842">datatypes.ts:842</a></li>
|
|
181
|
+
</ul>
|
|
182
|
+
</aside>
|
|
183
|
+
</section>
|
|
184
|
+
</section>
|
|
185
|
+
</div>
|
|
186
|
+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
187
|
+
<nav class="tsd-navigation primary">
|
|
188
|
+
<ul>
|
|
189
|
+
<li class=" ">
|
|
190
|
+
<a href="../modules.html">Modules</a>
|
|
191
|
+
</li>
|
|
192
|
+
<li class=" tsd-kind-module">
|
|
193
|
+
<a href="../modules/client.html">client</a>
|
|
194
|
+
</li>
|
|
195
|
+
<li class="current tsd-kind-module">
|
|
196
|
+
<a href="../modules/datatypes.html">datatypes</a>
|
|
197
|
+
</li>
|
|
198
|
+
<li class=" tsd-kind-module">
|
|
199
|
+
<a href="../modules/services.html">services</a>
|
|
200
|
+
</li>
|
|
201
|
+
</ul>
|
|
202
|
+
</nav>
|
|
203
|
+
<nav class="tsd-navigation secondary menu-sticky">
|
|
204
|
+
<ul class="before-current">
|
|
205
|
+
</ul>
|
|
206
|
+
<ul class="current">
|
|
207
|
+
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
208
|
+
<a href="datatypes.HTTPSEdgeUpdate.html" class="tsd-kind-icon">HTTPSEdge<wbr>Update</a>
|
|
209
|
+
<ul>
|
|
210
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
211
|
+
<a href="datatypes.HTTPSEdgeUpdate.html#description" class="tsd-kind-icon">description</a>
|
|
212
|
+
</li>
|
|
213
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
214
|
+
<a href="datatypes.HTTPSEdgeUpdate.html#hostports" class="tsd-kind-icon">hostports</a>
|
|
215
|
+
</li>
|
|
216
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
217
|
+
<a href="datatypes.HTTPSEdgeUpdate.html#id" class="tsd-kind-icon">id</a>
|
|
218
|
+
</li>
|
|
219
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
220
|
+
<a href="datatypes.HTTPSEdgeUpdate.html#metadata" class="tsd-kind-icon">metadata</a>
|
|
221
|
+
</li>
|
|
222
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
223
|
+
<a href="datatypes.HTTPSEdgeUpdate.html#mutualTls" class="tsd-kind-icon">mutual<wbr>Tls</a>
|
|
224
|
+
</li>
|
|
225
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
226
|
+
<a href="datatypes.HTTPSEdgeUpdate.html#tlsTermination" class="tsd-kind-icon">tls<wbr>Termination</a>
|
|
227
|
+
</li>
|
|
228
|
+
</ul>
|
|
229
|
+
</li>
|
|
230
|
+
</ul>
|
|
231
|
+
<ul class="after-current">
|
|
232
|
+
</ul>
|
|
233
|
+
</nav>
|
|
234
|
+
</div>
|
|
235
|
+
</div>
|
|
236
|
+
</div>
|
|
237
|
+
<footer class="with-border-bottom">
|
|
238
|
+
<div class="container">
|
|
239
|
+
<h2>Legend</h2>
|
|
240
|
+
<div class="tsd-legend-group">
|
|
241
|
+
<ul class="tsd-legend">
|
|
242
|
+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
243
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
244
|
+
</ul>
|
|
245
|
+
<ul class="tsd-legend">
|
|
246
|
+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
247
|
+
</ul>
|
|
248
|
+
</div>
|
|
249
|
+
</div>
|
|
250
|
+
</footer>
|
|
251
|
+
<div class="container tsd-generator">
|
|
252
|
+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
253
|
+
</div>
|
|
254
|
+
<div class="overlay"></div>
|
|
255
|
+
<script src="../assets/js/main.js"></script>
|
|
256
|
+
</body>
|
|
257
|
+
</html>
|
|
@@ -83,7 +83,6 @@
|
|
|
83
83
|
<section class="tsd-index-section ">
|
|
84
84
|
<h3>Properties</h3>
|
|
85
85
|
<ul class="tsd-index-list">
|
|
86
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicy.html#action" class="tsd-kind-icon">action</a></li>
|
|
87
86
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicy.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
|
|
88
87
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicy.html#description" class="tsd-kind-icon">description</a></li>
|
|
89
88
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicy.html#id" class="tsd-kind-icon">id</a></li>
|
|
@@ -96,28 +95,13 @@
|
|
|
96
95
|
</section>
|
|
97
96
|
<section class="tsd-panel-group tsd-member-group ">
|
|
98
97
|
<h2>Properties</h2>
|
|
99
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
100
|
-
<a name="action" class="tsd-anchor"></a>
|
|
101
|
-
<h3>action</h3>
|
|
102
|
-
<div class="tsd-signature tsd-kind-icon">action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
103
|
-
<aside class="tsd-sources">
|
|
104
|
-
<ul>
|
|
105
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L895">datatypes.ts:895</a></li>
|
|
106
|
-
</ul>
|
|
107
|
-
</aside>
|
|
108
|
-
<div class="tsd-comment tsd-typography">
|
|
109
|
-
<div class="lead">
|
|
110
|
-
<p>the IP policy action. Supported values are <code>allow</code> or <code>deny</code></p>
|
|
111
|
-
</div>
|
|
112
|
-
</div>
|
|
113
|
-
</section>
|
|
114
98
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
115
99
|
<a name="createdAt" class="tsd-anchor"></a>
|
|
116
100
|
<h3>created<wbr>At</h3>
|
|
117
101
|
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
118
102
|
<aside class="tsd-sources">
|
|
119
103
|
<ul>
|
|
120
|
-
<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/0593d03/src/datatypes.ts#L1323">datatypes.ts:1323</a></li>
|
|
121
105
|
</ul>
|
|
122
106
|
</aside>
|
|
123
107
|
<div class="tsd-comment tsd-typography">
|
|
@@ -132,7 +116,7 @@
|
|
|
132
116
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
133
117
|
<aside class="tsd-sources">
|
|
134
118
|
<ul>
|
|
135
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
119
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1325">datatypes.ts:1325</a></li>
|
|
136
120
|
</ul>
|
|
137
121
|
</aside>
|
|
138
122
|
<div class="tsd-comment tsd-typography">
|
|
@@ -147,7 +131,7 @@
|
|
|
147
131
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
148
132
|
<aside class="tsd-sources">
|
|
149
133
|
<ul>
|
|
150
|
-
<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/0593d03/src/datatypes.ts#L1319">datatypes.ts:1319</a></li>
|
|
151
135
|
</ul>
|
|
152
136
|
</aside>
|
|
153
137
|
<div class="tsd-comment tsd-typography">
|
|
@@ -162,7 +146,7 @@
|
|
|
162
146
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
163
147
|
<aside class="tsd-sources">
|
|
164
148
|
<ul>
|
|
165
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
149
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1327">datatypes.ts:1327</a></li>
|
|
166
150
|
</ul>
|
|
167
151
|
</aside>
|
|
168
152
|
<div class="tsd-comment tsd-typography">
|
|
@@ -177,7 +161,7 @@
|
|
|
177
161
|
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
178
162
|
<aside class="tsd-sources">
|
|
179
163
|
<ul>
|
|
180
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
164
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1321">datatypes.ts:1321</a></li>
|
|
181
165
|
</ul>
|
|
182
166
|
</aside>
|
|
183
167
|
<div class="tsd-comment tsd-typography">
|
|
@@ -212,9 +196,6 @@
|
|
|
212
196
|
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
213
197
|
<a href="datatypes.IPPolicy.html" class="tsd-kind-icon">IPPolicy</a>
|
|
214
198
|
<ul>
|
|
215
|
-
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
216
|
-
<a href="datatypes.IPPolicy.html#action" class="tsd-kind-icon">action</a>
|
|
217
|
-
</li>
|
|
218
199
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
219
200
|
<a href="datatypes.IPPolicy.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
|
|
220
201
|
</li>
|
|
@@ -83,7 +83,6 @@
|
|
|
83
83
|
<section class="tsd-index-section ">
|
|
84
84
|
<h3>Properties</h3>
|
|
85
85
|
<ul class="tsd-index-list">
|
|
86
|
-
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicyCreate.html#action" class="tsd-kind-icon">action</a></li>
|
|
87
86
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicyCreate.html#description" class="tsd-kind-icon">description</a></li>
|
|
88
87
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicyCreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
|
|
89
88
|
</ul>
|
|
@@ -93,28 +92,13 @@
|
|
|
93
92
|
</section>
|
|
94
93
|
<section class="tsd-panel-group tsd-member-group ">
|
|
95
94
|
<h2>Properties</h2>
|
|
96
|
-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
97
|
-
<a name="action" class="tsd-anchor"></a>
|
|
98
|
-
<h3>action</h3>
|
|
99
|
-
<div class="tsd-signature tsd-kind-icon">action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
100
|
-
<aside class="tsd-sources">
|
|
101
|
-
<ul>
|
|
102
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/datatypes.ts#L872">datatypes.ts:872</a></li>
|
|
103
|
-
</ul>
|
|
104
|
-
</aside>
|
|
105
|
-
<div class="tsd-comment tsd-typography">
|
|
106
|
-
<div class="lead">
|
|
107
|
-
<p>the IP policy action. Supported values are <code>allow</code> or <code>deny</code></p>
|
|
108
|
-
</div>
|
|
109
|
-
</div>
|
|
110
|
-
</section>
|
|
111
95
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
112
96
|
<a name="description" class="tsd-anchor"></a>
|
|
113
97
|
<h3>description</h3>
|
|
114
98
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
115
99
|
<aside class="tsd-sources">
|
|
116
100
|
<ul>
|
|
117
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
101
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1304">datatypes.ts:1304</a></li>
|
|
118
102
|
</ul>
|
|
119
103
|
</aside>
|
|
120
104
|
<div class="tsd-comment tsd-typography">
|
|
@@ -129,7 +113,7 @@
|
|
|
129
113
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
130
114
|
<aside class="tsd-sources">
|
|
131
115
|
<ul>
|
|
132
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
116
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1306">datatypes.ts:1306</a></li>
|
|
133
117
|
</ul>
|
|
134
118
|
</aside>
|
|
135
119
|
<div class="tsd-comment tsd-typography">
|
|
@@ -164,9 +148,6 @@
|
|
|
164
148
|
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
165
149
|
<a href="datatypes.IPPolicyCreate.html" class="tsd-kind-icon">IPPolicy<wbr>Create</a>
|
|
166
150
|
<ul>
|
|
167
|
-
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
168
|
-
<a href="datatypes.IPPolicyCreate.html#action" class="tsd-kind-icon">action</a>
|
|
169
|
-
</li>
|
|
170
151
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
171
152
|
<a href="datatypes.IPPolicyCreate.html#description" class="tsd-kind-icon">description</a>
|
|
172
153
|
</li>
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
<div class="tsd-signature tsd-kind-icon">ip<wbr>Policies<span class="tsd-signature-symbol">:</span> <a href="datatypes.IPPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">IPPolicy</a><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/0593d03/src/datatypes.ts#L1332">datatypes.ts:1332</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">next<wbr>Page<wbr>Uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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/0593d03/src/datatypes.ts#L1336">datatypes.ts:1336</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">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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/0593d03/src/datatypes.ts#L1334">datatypes.ts:1334</a></li>
|
|
133
133
|
</ul>
|
|
134
134
|
</aside>
|
|
135
135
|
<div class="tsd-comment tsd-typography">
|
|
@@ -83,6 +83,7 @@
|
|
|
83
83
|
<section class="tsd-index-section ">
|
|
84
84
|
<h3>Properties</h3>
|
|
85
85
|
<ul class="tsd-index-list">
|
|
86
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicyRule.html#action" class="tsd-kind-icon">action</a></li>
|
|
86
87
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicyRule.html#cidr" class="tsd-kind-icon">cidr</a></li>
|
|
87
88
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicyRule.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
|
|
88
89
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicyRule.html#description" class="tsd-kind-icon">description</a></li>
|
|
@@ -97,13 +98,28 @@
|
|
|
97
98
|
</section>
|
|
98
99
|
<section class="tsd-panel-group tsd-member-group ">
|
|
99
100
|
<h2>Properties</h2>
|
|
101
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
102
|
+
<a name="action" class="tsd-anchor"></a>
|
|
103
|
+
<h3>action</h3>
|
|
104
|
+
<div class="tsd-signature tsd-kind-icon">action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
105
|
+
<aside class="tsd-sources">
|
|
106
|
+
<ul>
|
|
107
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1378">datatypes.ts:1378</a></li>
|
|
108
|
+
</ul>
|
|
109
|
+
</aside>
|
|
110
|
+
<div class="tsd-comment tsd-typography">
|
|
111
|
+
<div class="lead">
|
|
112
|
+
<p>the action to apply to the policy rule, either <code>allow</code> or <code>deny</code></p>
|
|
113
|
+
</div>
|
|
114
|
+
</div>
|
|
115
|
+
</section>
|
|
100
116
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
101
117
|
<a name="cidr" class="tsd-anchor"></a>
|
|
102
118
|
<h3>cidr</h3>
|
|
103
119
|
<div class="tsd-signature tsd-kind-icon">cidr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
104
120
|
<aside class="tsd-sources">
|
|
105
121
|
<ul>
|
|
106
|
-
<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/0593d03/src/datatypes.ts#L1374">datatypes.ts:1374</a></li>
|
|
107
123
|
</ul>
|
|
108
124
|
</aside>
|
|
109
125
|
<div class="tsd-comment tsd-typography">
|
|
@@ -118,7 +134,7 @@
|
|
|
118
134
|
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
119
135
|
<aside class="tsd-sources">
|
|
120
136
|
<ul>
|
|
121
|
-
<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/0593d03/src/datatypes.ts#L1368">datatypes.ts:1368</a></li>
|
|
122
138
|
</ul>
|
|
123
139
|
</aside>
|
|
124
140
|
<div class="tsd-comment tsd-typography">
|
|
@@ -133,7 +149,7 @@
|
|
|
133
149
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
134
150
|
<aside class="tsd-sources">
|
|
135
151
|
<ul>
|
|
136
|
-
<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/0593d03/src/datatypes.ts#L1370">datatypes.ts:1370</a></li>
|
|
137
153
|
</ul>
|
|
138
154
|
</aside>
|
|
139
155
|
<div class="tsd-comment tsd-typography">
|
|
@@ -148,7 +164,7 @@
|
|
|
148
164
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
149
165
|
<aside class="tsd-sources">
|
|
150
166
|
<ul>
|
|
151
|
-
<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/0593d03/src/datatypes.ts#L1364">datatypes.ts:1364</a></li>
|
|
152
168
|
</ul>
|
|
153
169
|
</aside>
|
|
154
170
|
<div class="tsd-comment tsd-typography">
|
|
@@ -163,7 +179,7 @@
|
|
|
163
179
|
<div class="tsd-signature tsd-kind-icon">ip<wbr>Policy<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
|
|
164
180
|
<aside class="tsd-sources">
|
|
165
181
|
<ul>
|
|
166
|
-
<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/0593d03/src/datatypes.ts#L1376">datatypes.ts:1376</a></li>
|
|
167
183
|
</ul>
|
|
168
184
|
</aside>
|
|
169
185
|
<div class="tsd-comment tsd-typography">
|
|
@@ -178,7 +194,7 @@
|
|
|
178
194
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
179
195
|
<aside class="tsd-sources">
|
|
180
196
|
<ul>
|
|
181
|
-
<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/0593d03/src/datatypes.ts#L1372">datatypes.ts:1372</a></li>
|
|
182
198
|
</ul>
|
|
183
199
|
</aside>
|
|
184
200
|
<div class="tsd-comment tsd-typography">
|
|
@@ -193,7 +209,7 @@
|
|
|
193
209
|
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
194
210
|
<aside class="tsd-sources">
|
|
195
211
|
<ul>
|
|
196
|
-
<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/0593d03/src/datatypes.ts#L1366">datatypes.ts:1366</a></li>
|
|
197
213
|
</ul>
|
|
198
214
|
</aside>
|
|
199
215
|
<div class="tsd-comment tsd-typography">
|
|
@@ -228,6 +244,9 @@
|
|
|
228
244
|
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
229
245
|
<a href="datatypes.IPPolicyRule.html" class="tsd-kind-icon">IPPolicy<wbr>Rule</a>
|
|
230
246
|
<ul>
|
|
247
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
248
|
+
<a href="datatypes.IPPolicyRule.html#action" class="tsd-kind-icon">action</a>
|
|
249
|
+
</li>
|
|
231
250
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
232
251
|
<a href="datatypes.IPPolicyRule.html#cidr" class="tsd-kind-icon">cidr</a>
|
|
233
252
|
</li>
|
|
@@ -83,6 +83,7 @@
|
|
|
83
83
|
<section class="tsd-index-section ">
|
|
84
84
|
<h3>Properties</h3>
|
|
85
85
|
<ul class="tsd-index-list">
|
|
86
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicyRuleCreate.html#action" class="tsd-kind-icon">action</a></li>
|
|
86
87
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicyRuleCreate.html#cidr" class="tsd-kind-icon">cidr</a></li>
|
|
87
88
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicyRuleCreate.html#description" class="tsd-kind-icon">description</a></li>
|
|
88
89
|
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.IPPolicyRuleCreate.html#ipPolicyId" class="tsd-kind-icon">ip<wbr>Policy<wbr>Id</a></li>
|
|
@@ -94,13 +95,28 @@
|
|
|
94
95
|
</section>
|
|
95
96
|
<section class="tsd-panel-group tsd-member-group ">
|
|
96
97
|
<h2>Properties</h2>
|
|
98
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
99
|
+
<a name="action" class="tsd-anchor"></a>
|
|
100
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> action</h3>
|
|
101
|
+
<div class="tsd-signature tsd-kind-icon">action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
102
|
+
<aside class="tsd-sources">
|
|
103
|
+
<ul>
|
|
104
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1349">datatypes.ts:1349</a></li>
|
|
105
|
+
</ul>
|
|
106
|
+
</aside>
|
|
107
|
+
<div class="tsd-comment tsd-typography">
|
|
108
|
+
<div class="lead">
|
|
109
|
+
<p>the action to apply to the policy rule, either <code>allow</code> or <code>deny</code></p>
|
|
110
|
+
</div>
|
|
111
|
+
</div>
|
|
112
|
+
</section>
|
|
97
113
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
98
114
|
<a name="cidr" class="tsd-anchor"></a>
|
|
99
115
|
<h3>cidr</h3>
|
|
100
116
|
<div class="tsd-signature tsd-kind-icon">cidr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
101
117
|
<aside class="tsd-sources">
|
|
102
118
|
<ul>
|
|
103
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
119
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1345">datatypes.ts:1345</a></li>
|
|
104
120
|
</ul>
|
|
105
121
|
</aside>
|
|
106
122
|
<div class="tsd-comment tsd-typography">
|
|
@@ -115,7 +131,7 @@
|
|
|
115
131
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
116
132
|
<aside class="tsd-sources">
|
|
117
133
|
<ul>
|
|
118
|
-
<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/0593d03/src/datatypes.ts#L1341">datatypes.ts:1341</a></li>
|
|
119
135
|
</ul>
|
|
120
136
|
</aside>
|
|
121
137
|
<div class="tsd-comment tsd-typography">
|
|
@@ -130,7 +146,7 @@
|
|
|
130
146
|
<div class="tsd-signature tsd-kind-icon">ip<wbr>Policy<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
131
147
|
<aside class="tsd-sources">
|
|
132
148
|
<ul>
|
|
133
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
149
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1347">datatypes.ts:1347</a></li>
|
|
134
150
|
</ul>
|
|
135
151
|
</aside>
|
|
136
152
|
<div class="tsd-comment tsd-typography">
|
|
@@ -145,7 +161,7 @@
|
|
|
145
161
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
146
162
|
<aside class="tsd-sources">
|
|
147
163
|
<ul>
|
|
148
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
164
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1343">datatypes.ts:1343</a></li>
|
|
149
165
|
</ul>
|
|
150
166
|
</aside>
|
|
151
167
|
<div class="tsd-comment tsd-typography">
|
|
@@ -180,6 +196,9 @@
|
|
|
180
196
|
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
181
197
|
<a href="datatypes.IPPolicyRuleCreate.html" class="tsd-kind-icon">IPPolicy<wbr>Rule<wbr>Create</a>
|
|
182
198
|
<ul>
|
|
199
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
200
|
+
<a href="datatypes.IPPolicyRuleCreate.html#action" class="tsd-kind-icon">action</a>
|
|
201
|
+
</li>
|
|
183
202
|
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
184
203
|
<a href="datatypes.IPPolicyRuleCreate.html#cidr" class="tsd-kind-icon">cidr</a>
|
|
185
204
|
</li>
|