@ngrok/ngrok-api 0.0.9 → 0.3.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/.eslintrc.js +4 -1
- package/CHANGELOG.md +34 -0
- package/README.md +148 -2
- package/docs/CNAME +1 -0
- package/docs/assets/css/main.css +2660 -0
- package/docs/assets/images/icons.png +0 -0
- package/docs/assets/images/icons@2x.png +0 -0
- package/docs/assets/images/widgets.png +0 -0
- package/docs/assets/images/widgets@2x.png +0 -0
- package/docs/assets/js/main.js +248 -0
- package/docs/assets/js/search.js +1 -0
- package/docs/classes/client.Ngrok.html +681 -0
- package/docs/classes/services.APIKeys.html +453 -0
- package/docs/classes/services.AbuseReports.html +360 -0
- package/docs/classes/services.AgentIngresses.html +442 -0
- package/docs/classes/services.CertificateAuthorities.html +453 -0
- package/docs/classes/services.Credentials.html +452 -0
- package/docs/classes/services.EndpointCircuitBreakerModule.html +369 -0
- package/docs/classes/services.EndpointCompressionModule.html +369 -0
- package/docs/classes/services.EndpointConfigurations.html +451 -0
- package/docs/classes/services.EndpointIPPolicyModule.html +369 -0
- package/docs/classes/services.EndpointLoggingModule.html +369 -0
- package/docs/classes/services.EndpointMutualTLSModule.html +369 -0
- package/docs/classes/services.EndpointOAuthModule.html +369 -0
- package/docs/classes/services.EndpointOIDCModule.html +369 -0
- package/docs/classes/services.EndpointRequestHeadersModule.html +369 -0
- package/docs/classes/services.EndpointResponseHeadersModule.html +369 -0
- package/docs/classes/services.EndpointSAMLModule.html +369 -0
- package/docs/classes/services.EndpointTLSTerminationModule.html +369 -0
- package/docs/classes/services.EndpointWebhookValidationModule.html +369 -0
- package/docs/classes/services.EventDestinations.html +442 -0
- package/docs/classes/services.EventSources.html +448 -0
- package/docs/classes/services.EventStreams.html +442 -0
- package/docs/classes/services.EventSubscriptions.html +442 -0
- package/docs/classes/services.IPPolicies.html +452 -0
- package/docs/classes/services.IPPolicyRules.html +450 -0
- package/docs/classes/services.IPRestrictions.html +454 -0
- package/docs/classes/services.ReservedAddrs.html +483 -0
- package/docs/classes/services.ReservedDomains.html +580 -0
- package/docs/classes/services.SSHCertificateAuthorities.html +450 -0
- package/docs/classes/services.SSHCredentials.html +450 -0
- package/docs/classes/services.SSHHostCertificates.html +451 -0
- package/docs/classes/services.SSHUserCertificates.html +451 -0
- package/docs/classes/services.TLSCertificates.html +453 -0
- package/docs/classes/services.TunnelSessions.html +451 -0
- package/docs/classes/services.Tunnels.html +322 -0
- package/docs/index.html +239 -0
- package/docs/interfaces/client.NgrokConfig.html +179 -0
- package/docs/interfaces/datatypes.APIKey.html +262 -0
- package/docs/interfaces/datatypes.APIKeyCreate.html +186 -0
- package/docs/interfaces/datatypes.APIKeyList.html +205 -0
- package/docs/interfaces/datatypes.APIKeyUpdate.html +200 -0
- package/docs/interfaces/datatypes.AWSAuth.html +186 -0
- package/docs/interfaces/datatypes.AWSCredentials.html +186 -0
- package/docs/interfaces/datatypes.AWSRole.html +167 -0
- package/docs/interfaces/datatypes.AbuseReport.html +281 -0
- package/docs/interfaces/datatypes.AbuseReportCreate.html +186 -0
- package/docs/interfaces/datatypes.AbuseReportHostname.html +186 -0
- package/docs/interfaces/datatypes.AgentIngress.html +300 -0
- package/docs/interfaces/datatypes.AgentIngressCreate.html +205 -0
- package/docs/interfaces/datatypes.AgentIngressList.html +205 -0
- package/docs/interfaces/datatypes.AgentIngressUpdate.html +200 -0
- package/docs/interfaces/datatypes.CertificateAuthority.html +357 -0
- package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +205 -0
- package/docs/interfaces/datatypes.CertificateAuthorityList.html +205 -0
- package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +200 -0
- package/docs/interfaces/datatypes.Credential.html +281 -0
- package/docs/interfaces/datatypes.CredentialCreate.html +205 -0
- package/docs/interfaces/datatypes.CredentialList.html +205 -0
- package/docs/interfaces/datatypes.CredentialUpdate.html +219 -0
- package/docs/interfaces/datatypes.Empty.html +130 -0
- package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +262 -0
- package/docs/interfaces/datatypes.EndpointCircuitBreakerReplace.html +176 -0
- package/docs/interfaces/datatypes.EndpointCompression.html +167 -0
- package/docs/interfaces/datatypes.EndpointCompressionReplace.html +176 -0
- package/docs/interfaces/datatypes.EndpointConfiguration.html +490 -0
- package/docs/interfaces/datatypes.EndpointConfigurationCreate.html +433 -0
- package/docs/interfaces/datatypes.EndpointConfigurationList.html +205 -0
- package/docs/interfaces/datatypes.EndpointConfigurationUpdate.html +433 -0
- package/docs/interfaces/datatypes.EndpointIPPolicy.html +181 -0
- package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +186 -0
- package/docs/interfaces/datatypes.EndpointIPPolicyReplace.html +176 -0
- package/docs/interfaces/datatypes.EndpointLogging.html +186 -0
- package/docs/interfaces/datatypes.EndpointLoggingMutate.html +186 -0
- package/docs/interfaces/datatypes.EndpointLoggingReplace.html +176 -0
- package/docs/interfaces/datatypes.EndpointMutualTLS.html +186 -0
- package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +186 -0
- package/docs/interfaces/datatypes.EndpointMutualTLSReplace.html +176 -0
- package/docs/interfaces/datatypes.EndpointOAuth.html +281 -0
- package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +243 -0
- package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +281 -0
- package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +243 -0
- package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +243 -0
- package/docs/interfaces/datatypes.EndpointOAuthProvider.html +224 -0
- package/docs/interfaces/datatypes.EndpointOAuthReplace.html +176 -0
- package/docs/interfaces/datatypes.EndpointOIDC.html +319 -0
- package/docs/interfaces/datatypes.EndpointOIDCReplace.html +176 -0
- package/docs/interfaces/datatypes.EndpointRequestHeaders.html +205 -0
- package/docs/interfaces/datatypes.EndpointRequestHeadersReplace.html +176 -0
- package/docs/interfaces/datatypes.EndpointResponseHeaders.html +205 -0
- package/docs/interfaces/datatypes.EndpointResponseHeadersReplace.html +176 -0
- package/docs/interfaces/datatypes.EndpointSAML.html +433 -0
- package/docs/interfaces/datatypes.EndpointSAMLMutate.html +338 -0
- package/docs/interfaces/datatypes.EndpointSAMLReplace.html +176 -0
- package/docs/interfaces/datatypes.EndpointTLSTermination.html +205 -0
- package/docs/interfaces/datatypes.EndpointTLSTerminationReplace.html +176 -0
- package/docs/interfaces/datatypes.EndpointWebhookValidation.html +205 -0
- package/docs/interfaces/datatypes.EndpointWebhookValidationReplace.html +176 -0
- package/docs/interfaces/datatypes.Error.html +204 -0
- package/docs/interfaces/datatypes.EventDestination.html +281 -0
- package/docs/interfaces/datatypes.EventDestinationCreate.html +224 -0
- package/docs/interfaces/datatypes.EventDestinationList.html +205 -0
- package/docs/interfaces/datatypes.EventDestinationUpdate.html +243 -0
- package/docs/interfaces/datatypes.EventSource.html +186 -0
- package/docs/interfaces/datatypes.EventSourceCreate.html +186 -0
- package/docs/interfaces/datatypes.EventSourceItem.html +193 -0
- package/docs/interfaces/datatypes.EventSourceList.html +186 -0
- package/docs/interfaces/datatypes.EventSourcePaging.html +174 -0
- package/docs/interfaces/datatypes.EventSourceReplace.html +167 -0
- package/docs/interfaces/datatypes.EventSourceUpdate.html +186 -0
- package/docs/interfaces/datatypes.EventStream.html +319 -0
- package/docs/interfaces/datatypes.EventStreamCreate.html +262 -0
- package/docs/interfaces/datatypes.EventStreamList.html +205 -0
- package/docs/interfaces/datatypes.EventStreamUpdate.html +262 -0
- package/docs/interfaces/datatypes.EventSubscription.html +281 -0
- package/docs/interfaces/datatypes.EventSubscriptionCreate.html +224 -0
- package/docs/interfaces/datatypes.EventSubscriptionList.html +205 -0
- package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +243 -0
- package/docs/interfaces/datatypes.EventTarget.html +205 -0
- package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +186 -0
- package/docs/interfaces/datatypes.EventTargetFirehose.html +186 -0
- package/docs/interfaces/datatypes.EventTargetKinesis.html +186 -0
- package/docs/interfaces/datatypes.IPPolicy.html +262 -0
- package/docs/interfaces/datatypes.IPPolicyCreate.html +205 -0
- package/docs/interfaces/datatypes.IPPolicyList.html +205 -0
- package/docs/interfaces/datatypes.IPPolicyRule.html +281 -0
- package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +224 -0
- package/docs/interfaces/datatypes.IPPolicyRuleList.html +205 -0
- package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +219 -0
- package/docs/interfaces/datatypes.IPPolicyUpdate.html +200 -0
- package/docs/interfaces/datatypes.IPRestriction.html +300 -0
- package/docs/interfaces/datatypes.IPRestrictionCreate.html +243 -0
- package/docs/interfaces/datatypes.IPRestrictionList.html +205 -0
- package/docs/interfaces/datatypes.IPRestrictionUpdate.html +238 -0
- package/docs/interfaces/datatypes.Item.html +167 -0
- package/docs/interfaces/datatypes.Paging.html +176 -0
- package/docs/interfaces/datatypes.Ref.html +186 -0
- package/docs/interfaces/datatypes.ReservedAddr.html +300 -0
- package/docs/interfaces/datatypes.ReservedAddrCreate.html +224 -0
- package/docs/interfaces/datatypes.ReservedAddrList.html +205 -0
- package/docs/interfaces/datatypes.ReservedAddrUpdate.html +219 -0
- package/docs/interfaces/datatypes.ReservedDomain.html +414 -0
- package/docs/interfaces/datatypes.ReservedDomainCertJob.html +224 -0
- package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +186 -0
- package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +186 -0
- package/docs/interfaces/datatypes.ReservedDomainCreate.html +300 -0
- package/docs/interfaces/datatypes.ReservedDomainList.html +205 -0
- package/docs/interfaces/datatypes.ReservedDomainUpdate.html +276 -0
- package/docs/interfaces/datatypes.SSHCertificateAuthority.html +281 -0
- package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +243 -0
- package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +205 -0
- package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +200 -0
- package/docs/interfaces/datatypes.SSHCredential.html +281 -0
- package/docs/interfaces/datatypes.SSHCredentialCreate.html +224 -0
- package/docs/interfaces/datatypes.SSHCredentialList.html +205 -0
- package/docs/interfaces/datatypes.SSHCredentialUpdate.html +219 -0
- package/docs/interfaces/datatypes.SSHHostCertificate.html +376 -0
- package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +281 -0
- package/docs/interfaces/datatypes.SSHHostCertificateList.html +205 -0
- package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +200 -0
- package/docs/interfaces/datatypes.SSHUserCertificate.html +414 -0
- package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +319 -0
- package/docs/interfaces/datatypes.SSHUserCertificateList.html +205 -0
- package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +200 -0
- package/docs/interfaces/datatypes.TLSCertificate.html +547 -0
- package/docs/interfaces/datatypes.TLSCertificateCreate.html +224 -0
- package/docs/interfaces/datatypes.TLSCertificateList.html +205 -0
- package/docs/interfaces/datatypes.TLSCertificateSANs.html +186 -0
- package/docs/interfaces/datatypes.TLSCertificateUpdate.html +200 -0
- package/docs/interfaces/datatypes.Tunnel.html +281 -0
- package/docs/interfaces/datatypes.TunnelList.html +205 -0
- package/docs/interfaces/datatypes.TunnelSession.html +338 -0
- package/docs/interfaces/datatypes.TunnelSessionList.html +205 -0
- package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +162 -0
- package/docs/modules/client.html +137 -0
- package/docs/modules/datatypes.html +668 -0
- package/docs/modules/services.html +260 -0
- package/docs/modules.html +119 -0
- package/lib/client.d.ts +145 -0
- package/lib/client.d.ts.map +1 -0
- package/lib/client.js +102 -0
- package/lib/client.js.map +1 -0
- package/lib/{types.d.ts → datatypes.d.ts} +620 -816
- package/lib/datatypes.d.ts.map +1 -0
- package/lib/{types.js → datatypes.js} +1 -1
- package/lib/datatypes.js.map +1 -0
- package/lib/index.d.ts +3 -314
- package/lib/index.d.ts.map +1 -0
- package/lib/index.js +25 -887
- package/lib/index.js.map +1 -1
- package/lib/services.d.ts +773 -0
- package/lib/services.d.ts.map +1 -0
- package/lib/services.js +2761 -0
- package/lib/services.js.map +1 -0
- package/lib/util.d.ts +5 -0
- package/lib/util.d.ts.map +1 -0
- package/lib/util.js +53 -0
- package/lib/util.js.map +1 -0
- package/package.json +12 -3
- package/src/client.ts +265 -0
- package/src/{types.ts → datatypes.ts} +648 -869
- package/src/index.ts +2 -616
- package/src/services.ts +2560 -0
- package/src/util.ts +48 -0
- package/test/apikey.test.js +44 -30
- package/test/endpointConfigurations.test.js +38 -34
- package/tsconfig.json +17 -7
- package/lib/types.js.map +0 -1
|
@@ -0,0 +1,369 @@
|
|
|
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>EndpointIPPolicyModule | @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/services.html">services</a>
|
|
59
|
+
</li>
|
|
60
|
+
<li>
|
|
61
|
+
<a href="services.EndpointIPPolicyModule.html">EndpointIPPolicyModule</a>
|
|
62
|
+
</li>
|
|
63
|
+
</ul>
|
|
64
|
+
<h1>Class EndpointIPPolicyModule</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">EndpointIPPolicyModule</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>Constructors</h3>
|
|
85
|
+
<ul class="tsd-index-list">
|
|
86
|
+
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="services.EndpointIPPolicyModule.html#constructor" class="tsd-kind-icon">constructor</a></li>
|
|
87
|
+
</ul>
|
|
88
|
+
</section>
|
|
89
|
+
<section class="tsd-index-section ">
|
|
90
|
+
<h3>Methods</h3>
|
|
91
|
+
<ul class="tsd-index-list">
|
|
92
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="services.EndpointIPPolicyModule.html#delete" class="tsd-kind-icon">delete</a></li>
|
|
93
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="services.EndpointIPPolicyModule.html#get" class="tsd-kind-icon">get</a></li>
|
|
94
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="services.EndpointIPPolicyModule.html#replace" class="tsd-kind-icon">replace</a></li>
|
|
95
|
+
</ul>
|
|
96
|
+
</section>
|
|
97
|
+
</div>
|
|
98
|
+
</section>
|
|
99
|
+
</section>
|
|
100
|
+
<section class="tsd-panel-group tsd-member-group ">
|
|
101
|
+
<h2>Constructors</h2>
|
|
102
|
+
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
|
|
103
|
+
<a name="constructor" class="tsd-anchor"></a>
|
|
104
|
+
<h3>constructor</h3>
|
|
105
|
+
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
|
|
106
|
+
<li class="tsd-signature tsd-kind-icon">new <wbr>EndpointIPPolicy<wbr>Module<span class="tsd-signature-symbol">(</span>httpClient<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Wretcher</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="services.EndpointIPPolicyModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointIPPolicyModule</a></li>
|
|
107
|
+
</ul>
|
|
108
|
+
<ul class="tsd-descriptions">
|
|
109
|
+
<li class="tsd-description">
|
|
110
|
+
<aside class="tsd-sources">
|
|
111
|
+
<ul>
|
|
112
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L1360">services.ts:1360</a></li>
|
|
113
|
+
</ul>
|
|
114
|
+
</aside>
|
|
115
|
+
<div class="tsd-comment tsd-typography">
|
|
116
|
+
<div class="lead">
|
|
117
|
+
<p>Do not construct this object directly, use the <code>endpointIpPolicyModule</code> property of an <code>Ngrok</code> client object instead.</p>
|
|
118
|
+
</div>
|
|
119
|
+
</div>
|
|
120
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
121
|
+
<ul class="tsd-parameters">
|
|
122
|
+
<li>
|
|
123
|
+
<h5>httpClient: <span class="tsd-signature-type">Wretcher</span></h5>
|
|
124
|
+
</li>
|
|
125
|
+
</ul>
|
|
126
|
+
<h4 class="tsd-returns-title">Returns <a href="services.EndpointIPPolicyModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointIPPolicyModule</a></h4>
|
|
127
|
+
</li>
|
|
128
|
+
</ul>
|
|
129
|
+
</section>
|
|
130
|
+
</section>
|
|
131
|
+
<section class="tsd-panel-group tsd-member-group ">
|
|
132
|
+
<h2>Methods</h2>
|
|
133
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
134
|
+
<a name="delete" class="tsd-anchor"></a>
|
|
135
|
+
<h3>delete</h3>
|
|
136
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
137
|
+
<li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></li>
|
|
138
|
+
</ul>
|
|
139
|
+
<ul class="tsd-descriptions">
|
|
140
|
+
<li class="tsd-description">
|
|
141
|
+
<aside class="tsd-sources">
|
|
142
|
+
<ul>
|
|
143
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L1381">services.ts:1381</a></li>
|
|
144
|
+
</ul>
|
|
145
|
+
</aside>
|
|
146
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
147
|
+
<ul class="tsd-parameters">
|
|
148
|
+
<li>
|
|
149
|
+
<h5>arg: <a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a></h5>
|
|
150
|
+
</li>
|
|
151
|
+
</ul>
|
|
152
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">></span></h4>
|
|
153
|
+
</li>
|
|
154
|
+
</ul>
|
|
155
|
+
</section>
|
|
156
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
157
|
+
<a name="get" class="tsd-anchor"></a>
|
|
158
|
+
<h3>get</h3>
|
|
159
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
160
|
+
<li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.EndpointIPPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicy</a><span class="tsd-signature-symbol">></span></li>
|
|
161
|
+
</ul>
|
|
162
|
+
<ul class="tsd-descriptions">
|
|
163
|
+
<li class="tsd-description">
|
|
164
|
+
<aside class="tsd-sources">
|
|
165
|
+
<ul>
|
|
166
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L1373">services.ts:1373</a></li>
|
|
167
|
+
</ul>
|
|
168
|
+
</aside>
|
|
169
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
170
|
+
<ul class="tsd-parameters">
|
|
171
|
+
<li>
|
|
172
|
+
<h5>arg: <a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a></h5>
|
|
173
|
+
</li>
|
|
174
|
+
</ul>
|
|
175
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.EndpointIPPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicy</a><span class="tsd-signature-symbol">></span></h4>
|
|
176
|
+
</li>
|
|
177
|
+
</ul>
|
|
178
|
+
</section>
|
|
179
|
+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
|
|
180
|
+
<a name="replace" class="tsd-anchor"></a>
|
|
181
|
+
<h3>replace</h3>
|
|
182
|
+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
|
|
183
|
+
<li class="tsd-signature tsd-kind-icon">replace<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.EndpointIPPolicyReplace.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicyReplace</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.EndpointIPPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicy</a><span class="tsd-signature-symbol">></span></li>
|
|
184
|
+
</ul>
|
|
185
|
+
<ul class="tsd-descriptions">
|
|
186
|
+
<li class="tsd-description">
|
|
187
|
+
<aside class="tsd-sources">
|
|
188
|
+
<ul>
|
|
189
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L1363">services.ts:1363</a></li>
|
|
190
|
+
</ul>
|
|
191
|
+
</aside>
|
|
192
|
+
<h4 class="tsd-parameters-title">Parameters</h4>
|
|
193
|
+
<ul class="tsd-parameters">
|
|
194
|
+
<li>
|
|
195
|
+
<h5>arg: <a href="../interfaces/datatypes.EndpointIPPolicyReplace.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicyReplace</a></h5>
|
|
196
|
+
</li>
|
|
197
|
+
</ul>
|
|
198
|
+
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/datatypes.EndpointIPPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicy</a><span class="tsd-signature-symbol">></span></h4>
|
|
199
|
+
</li>
|
|
200
|
+
</ul>
|
|
201
|
+
</section>
|
|
202
|
+
</section>
|
|
203
|
+
</div>
|
|
204
|
+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
205
|
+
<nav class="tsd-navigation primary">
|
|
206
|
+
<ul>
|
|
207
|
+
<li class=" ">
|
|
208
|
+
<a href="../modules.html">Modules</a>
|
|
209
|
+
</li>
|
|
210
|
+
<li class=" tsd-kind-module">
|
|
211
|
+
<a href="../modules/client.html">client</a>
|
|
212
|
+
</li>
|
|
213
|
+
<li class=" tsd-kind-module">
|
|
214
|
+
<a href="../modules/datatypes.html">datatypes</a>
|
|
215
|
+
</li>
|
|
216
|
+
<li class="current tsd-kind-module">
|
|
217
|
+
<a href="../modules/services.html">services</a>
|
|
218
|
+
</li>
|
|
219
|
+
</ul>
|
|
220
|
+
</nav>
|
|
221
|
+
<nav class="tsd-navigation secondary menu-sticky">
|
|
222
|
+
<ul class="before-current">
|
|
223
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
224
|
+
<a href="services.APIKeys.html" class="tsd-kind-icon">APIKeys</a>
|
|
225
|
+
</li>
|
|
226
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
227
|
+
<a href="services.AbuseReports.html" class="tsd-kind-icon">Abuse<wbr>Reports</a>
|
|
228
|
+
</li>
|
|
229
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
230
|
+
<a href="services.AgentIngresses.html" class="tsd-kind-icon">Agent<wbr>Ingresses</a>
|
|
231
|
+
</li>
|
|
232
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
233
|
+
<a href="services.CertificateAuthorities.html" class="tsd-kind-icon">Certificate<wbr>Authorities</a>
|
|
234
|
+
</li>
|
|
235
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
236
|
+
<a href="services.Credentials.html" class="tsd-kind-icon">Credentials</a>
|
|
237
|
+
</li>
|
|
238
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
239
|
+
<a href="services.EndpointCircuitBreakerModule.html" class="tsd-kind-icon">Endpoint<wbr>Circuit<wbr>Breaker<wbr>Module</a>
|
|
240
|
+
</li>
|
|
241
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
242
|
+
<a href="services.EndpointCompressionModule.html" class="tsd-kind-icon">Endpoint<wbr>Compression<wbr>Module</a>
|
|
243
|
+
</li>
|
|
244
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
245
|
+
<a href="services.EndpointConfigurations.html" class="tsd-kind-icon">Endpoint<wbr>Configurations</a>
|
|
246
|
+
</li>
|
|
247
|
+
</ul>
|
|
248
|
+
<ul class="current">
|
|
249
|
+
<li class="current tsd-kind-class tsd-parent-kind-module">
|
|
250
|
+
<a href="services.EndpointIPPolicyModule.html" class="tsd-kind-icon">EndpointIPPolicy<wbr>Module</a>
|
|
251
|
+
<ul>
|
|
252
|
+
<li class=" tsd-kind-constructor tsd-parent-kind-class">
|
|
253
|
+
<a href="services.EndpointIPPolicyModule.html#constructor" class="tsd-kind-icon">constructor</a>
|
|
254
|
+
</li>
|
|
255
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
256
|
+
<a href="services.EndpointIPPolicyModule.html#delete" class="tsd-kind-icon">delete</a>
|
|
257
|
+
</li>
|
|
258
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
259
|
+
<a href="services.EndpointIPPolicyModule.html#get" class="tsd-kind-icon">get</a>
|
|
260
|
+
</li>
|
|
261
|
+
<li class=" tsd-kind-method tsd-parent-kind-class">
|
|
262
|
+
<a href="services.EndpointIPPolicyModule.html#replace" class="tsd-kind-icon">replace</a>
|
|
263
|
+
</li>
|
|
264
|
+
</ul>
|
|
265
|
+
</li>
|
|
266
|
+
</ul>
|
|
267
|
+
<ul class="after-current">
|
|
268
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
269
|
+
<a href="services.EndpointLoggingModule.html" class="tsd-kind-icon">Endpoint<wbr>Logging<wbr>Module</a>
|
|
270
|
+
</li>
|
|
271
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
272
|
+
<a href="services.EndpointMutualTLSModule.html" class="tsd-kind-icon">Endpoint<wbr>MutualTLSModule</a>
|
|
273
|
+
</li>
|
|
274
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
275
|
+
<a href="services.EndpointOAuthModule.html" class="tsd-kind-icon">EndpointOAuth<wbr>Module</a>
|
|
276
|
+
</li>
|
|
277
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
278
|
+
<a href="services.EndpointOIDCModule.html" class="tsd-kind-icon">EndpointOIDCModule</a>
|
|
279
|
+
</li>
|
|
280
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
281
|
+
<a href="services.EndpointRequestHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Request<wbr>Headers<wbr>Module</a>
|
|
282
|
+
</li>
|
|
283
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
284
|
+
<a href="services.EndpointResponseHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Response<wbr>Headers<wbr>Module</a>
|
|
285
|
+
</li>
|
|
286
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
287
|
+
<a href="services.EndpointSAMLModule.html" class="tsd-kind-icon">EndpointSAMLModule</a>
|
|
288
|
+
</li>
|
|
289
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
290
|
+
<a href="services.EndpointTLSTerminationModule.html" class="tsd-kind-icon">EndpointTLSTermination<wbr>Module</a>
|
|
291
|
+
</li>
|
|
292
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
293
|
+
<a href="services.EndpointWebhookValidationModule.html" class="tsd-kind-icon">Endpoint<wbr>Webhook<wbr>Validation<wbr>Module</a>
|
|
294
|
+
</li>
|
|
295
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
296
|
+
<a href="services.EventDestinations.html" class="tsd-kind-icon">Event<wbr>Destinations</a>
|
|
297
|
+
</li>
|
|
298
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
299
|
+
<a href="services.EventSources.html" class="tsd-kind-icon">Event<wbr>Sources</a>
|
|
300
|
+
</li>
|
|
301
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
302
|
+
<a href="services.EventStreams.html" class="tsd-kind-icon">Event<wbr>Streams</a>
|
|
303
|
+
</li>
|
|
304
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
305
|
+
<a href="services.EventSubscriptions.html" class="tsd-kind-icon">Event<wbr>Subscriptions</a>
|
|
306
|
+
</li>
|
|
307
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
308
|
+
<a href="services.IPPolicies.html" class="tsd-kind-icon">IPPolicies</a>
|
|
309
|
+
</li>
|
|
310
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
311
|
+
<a href="services.IPPolicyRules.html" class="tsd-kind-icon">IPPolicy<wbr>Rules</a>
|
|
312
|
+
</li>
|
|
313
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
314
|
+
<a href="services.IPRestrictions.html" class="tsd-kind-icon">IPRestrictions</a>
|
|
315
|
+
</li>
|
|
316
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
317
|
+
<a href="services.ReservedAddrs.html" class="tsd-kind-icon">Reserved<wbr>Addrs</a>
|
|
318
|
+
</li>
|
|
319
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
320
|
+
<a href="services.ReservedDomains.html" class="tsd-kind-icon">Reserved<wbr>Domains</a>
|
|
321
|
+
</li>
|
|
322
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
323
|
+
<a href="services.SSHCertificateAuthorities.html" class="tsd-kind-icon">SSHCertificate<wbr>Authorities</a>
|
|
324
|
+
</li>
|
|
325
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
326
|
+
<a href="services.SSHCredentials.html" class="tsd-kind-icon">SSHCredentials</a>
|
|
327
|
+
</li>
|
|
328
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
329
|
+
<a href="services.SSHHostCertificates.html" class="tsd-kind-icon">SSHHost<wbr>Certificates</a>
|
|
330
|
+
</li>
|
|
331
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
332
|
+
<a href="services.SSHUserCertificates.html" class="tsd-kind-icon">SSHUser<wbr>Certificates</a>
|
|
333
|
+
</li>
|
|
334
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
335
|
+
<a href="services.TLSCertificates.html" class="tsd-kind-icon">TLSCertificates</a>
|
|
336
|
+
</li>
|
|
337
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
338
|
+
<a href="services.TunnelSessions.html" class="tsd-kind-icon">Tunnel<wbr>Sessions</a>
|
|
339
|
+
</li>
|
|
340
|
+
<li class=" tsd-kind-class tsd-parent-kind-module">
|
|
341
|
+
<a href="services.Tunnels.html" class="tsd-kind-icon">Tunnels</a>
|
|
342
|
+
</li>
|
|
343
|
+
</ul>
|
|
344
|
+
</nav>
|
|
345
|
+
</div>
|
|
346
|
+
</div>
|
|
347
|
+
</div>
|
|
348
|
+
<footer class="with-border-bottom">
|
|
349
|
+
<div class="container">
|
|
350
|
+
<h2>Legend</h2>
|
|
351
|
+
<div class="tsd-legend-group">
|
|
352
|
+
<ul class="tsd-legend">
|
|
353
|
+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
354
|
+
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
|
|
355
|
+
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
|
|
356
|
+
</ul>
|
|
357
|
+
<ul class="tsd-legend">
|
|
358
|
+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
359
|
+
</ul>
|
|
360
|
+
</div>
|
|
361
|
+
</div>
|
|
362
|
+
</footer>
|
|
363
|
+
<div class="container tsd-generator">
|
|
364
|
+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
365
|
+
</div>
|
|
366
|
+
<div class="overlay"></div>
|
|
367
|
+
<script src="../assets/js/main.js"></script>
|
|
368
|
+
</body>
|
|
369
|
+
</html>
|