@ngrok/ngrok-api 0.8.0 → 0.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.eslintignore +2 -0
- package/.eslintrc.js +2 -0
- package/.prettierrc.js +2 -0
- package/CHANGELOG.md +12 -3
- package/CODE_OF_CONDUCT.md +45 -0
- package/README.md +30 -19
- package/docs/assets/js/search.js +1 -1
- package/docs/classes/client.Ngrok.html +54 -26
- package/docs/classes/services.APIKeys.html +20 -11
- package/docs/classes/services.AbuseReports.html +5 -5
- package/docs/classes/services.AgentIngresses.html +20 -11
- package/docs/classes/services.ApplicationSessions.html +288 -0
- package/docs/classes/services.ApplicationUsers.html +288 -0
- package/docs/classes/services.CertificateAuthorities.html +20 -11
- package/docs/classes/services.Credentials.html +21 -12
- package/docs/classes/services.EdgeRouteBackendModule.html +4 -4
- package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +4 -4
- package/docs/classes/services.EdgeRouteCompressionModule.html +4 -4
- package/docs/classes/services.EdgeRouteIPRestrictionModule.html +4 -4
- package/docs/classes/services.EdgeRouteOAuthModule.html +4 -4
- package/docs/classes/services.EdgeRouteOIDCModule.html +4 -4
- package/docs/classes/services.EdgeRouteRequestHeadersModule.html +4 -4
- package/docs/classes/services.EdgeRouteResponseHeadersModule.html +4 -4
- package/docs/classes/services.EdgeRouteSAMLModule.html +4 -4
- package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +4 -4
- package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +4 -4
- package/docs/classes/services.EdgesHTTPS.html +20 -11
- package/docs/classes/services.EdgesHTTPSRoutes.html +5 -5
- package/docs/classes/services.EdgesTCP.html +20 -11
- package/docs/classes/services.EdgesTLS.html +20 -11
- package/docs/classes/services.Endpoints.html +15 -6
- package/docs/classes/services.EventDestinations.html +21 -12
- package/docs/classes/services.EventSources.html +6 -6
- package/docs/classes/services.EventSubscriptions.html +20 -11
- package/docs/classes/services.FailoverBackends.html +21 -12
- package/docs/classes/services.HTTPResponseBackends.html +20 -11
- package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +8 -8
- package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +8 -8
- package/docs/classes/services.IPPolicies.html +20 -11
- package/docs/classes/services.IPPolicyRules.html +20 -11
- package/docs/classes/services.IPRestrictions.html +20 -11
- package/docs/classes/services.ReservedAddrs.html +20 -11
- package/docs/classes/services.ReservedDomains.html +26 -17
- package/docs/classes/services.SSHCertificateAuthorities.html +20 -11
- package/docs/classes/services.SSHCredentials.html +20 -11
- package/docs/classes/services.SSHHostCertificates.html +20 -11
- package/docs/classes/services.SSHUserCertificates.html +20 -11
- package/docs/classes/services.TCPEdgeBackendModule.html +8 -8
- package/docs/classes/services.TCPEdgeIPRestrictionModule.html +8 -8
- package/docs/classes/services.TLSCertificates.html +20 -11
- package/docs/classes/services.TLSEdgeBackendModule.html +8 -8
- package/docs/classes/services.TLSEdgeIPRestrictionModule.html +8 -8
- package/docs/classes/services.TLSEdgeMutualTLSModule.html +8 -8
- package/docs/classes/services.TLSEdgeTLSTerminationModule.html +8 -8
- package/docs/classes/services.TunnelGroupBackends.html +21 -12
- package/docs/classes/services.TunnelSessions.html +22 -13
- package/docs/classes/services.Tunnels.html +15 -6
- package/docs/classes/services.WeightedBackends.html +21 -12
- package/docs/index.html +30 -19
- package/docs/interfaces/client.NgrokConfig.html +2 -2
- package/docs/interfaces/datatypes.APIKey.html +28 -9
- package/docs/interfaces/datatypes.APIKeyCreate.html +23 -4
- package/docs/interfaces/datatypes.APIKeyList.html +3 -3
- package/docs/interfaces/datatypes.APIKeyUpdate.html +3 -3
- package/docs/interfaces/datatypes.AWSAuth.html +2 -2
- package/docs/interfaces/datatypes.AWSCredentials.html +2 -2
- package/docs/interfaces/datatypes.AWSRole.html +1 -1
- package/docs/interfaces/datatypes.AbuseReport.html +9 -9
- package/docs/interfaces/datatypes.AbuseReportCreate.html +3 -3
- package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
- package/docs/interfaces/datatypes.AgentIngress.html +49 -11
- package/docs/interfaces/datatypes.AgentIngressCertJob.html +224 -0
- package/docs/interfaces/datatypes.AgentIngressCertPolicy.html +186 -0
- package/docs/interfaces/datatypes.AgentIngressCertStatus.html +186 -0
- package/docs/interfaces/datatypes.AgentIngressCreate.html +24 -5
- package/docs/interfaces/datatypes.AgentIngressList.html +3 -3
- package/docs/interfaces/datatypes.AgentIngressUpdate.html +22 -3
- package/docs/interfaces/datatypes.ApplicationSession.html +357 -0
- package/docs/interfaces/datatypes.ApplicationSessionList.html +205 -0
- package/docs/interfaces/datatypes.ApplicationUser.html +338 -0
- package/docs/interfaces/datatypes.ApplicationUserList.html +205 -0
- package/docs/interfaces/datatypes.BrowserSession.html +205 -0
- package/docs/interfaces/datatypes.CertificateAuthority.html +16 -16
- package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +5 -5
- package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.Credential.html +31 -12
- package/docs/interfaces/datatypes.CredentialCreate.html +25 -6
- package/docs/interfaces/datatypes.CredentialList.html +3 -3
- package/docs/interfaces/datatypes.CredentialUpdate.html +5 -5
- package/docs/interfaces/datatypes.EdgeBackendReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeIPRestrictionReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeMutualTLSReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteCompressionReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteItem.html +2 -2
- package/docs/interfaces/datatypes.EdgeRouteOAuthReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteRequestHeadersReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteSAMLReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteWebhookVerificationReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeTLSTerminationAtEdgeReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeTLSTerminationReplace.html +2 -2
- package/docs/interfaces/datatypes.Endpoint.html +19 -19
- package/docs/interfaces/datatypes.EndpointBackend.html +2 -2
- package/docs/interfaces/datatypes.EndpointBackendMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
- package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
- package/docs/interfaces/datatypes.EndpointIPPolicy.html +7 -2
- package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointList.html +3 -3
- package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
- package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +3 -3
- package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
- package/docs/interfaces/datatypes.EndpointOAuthAmazon.html +218 -0
- package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +12 -12
- package/docs/interfaces/datatypes.EndpointOAuthGitLab.html +218 -0
- package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthLinkedIn.html +218 -0
- package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthProvider.html +80 -4
- package/docs/interfaces/datatypes.EndpointOAuthTwitch.html +218 -0
- package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
- package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointSAML.html +15 -15
- package/docs/interfaces/datatypes.EndpointSAMLMutate.html +10 -10
- package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
- package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +2 -2
- package/docs/interfaces/datatypes.EndpointWebhookValidation.html +4 -4
- package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +1 -1
- package/docs/interfaces/datatypes.Error.html +4 -4
- package/docs/interfaces/datatypes.EventDestination.html +10 -10
- package/docs/interfaces/datatypes.EventDestinationCreate.html +6 -6
- package/docs/interfaces/datatypes.EventDestinationList.html +3 -3
- package/docs/interfaces/datatypes.EventDestinationUpdate.html +5 -5
- package/docs/interfaces/datatypes.EventSource.html +2 -2
- package/docs/interfaces/datatypes.EventSourceCreate.html +2 -2
- package/docs/interfaces/datatypes.EventSourceItem.html +2 -2
- package/docs/interfaces/datatypes.EventSourceList.html +2 -2
- package/docs/interfaces/datatypes.EventSourcePaging.html +1 -1
- package/docs/interfaces/datatypes.EventSourceReplace.html +1 -1
- package/docs/interfaces/datatypes.EventSourceUpdate.html +2 -2
- package/docs/interfaces/datatypes.EventSubscription.html +10 -10
- package/docs/interfaces/datatypes.EventSubscriptionCreate.html +6 -6
- package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
- package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +5 -5
- package/docs/interfaces/datatypes.EventTarget.html +22 -3
- package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
- package/docs/interfaces/datatypes.EventTargetDatadog.html +224 -0
- package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
- package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
- package/docs/interfaces/datatypes.FailoverBackend.html +9 -9
- package/docs/interfaces/datatypes.FailoverBackendCreate.html +5 -5
- package/docs/interfaces/datatypes.FailoverBackendList.html +3 -3
- package/docs/interfaces/datatypes.FailoverBackendUpdate.html +4 -4
- package/docs/interfaces/datatypes.HTTPResponseBackend.html +11 -11
- package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +7 -7
- package/docs/interfaces/datatypes.HTTPResponseBackendList.html +3 -3
- package/docs/interfaces/datatypes.HTTPResponseBackendUpdate.html +6 -6
- package/docs/interfaces/datatypes.HTTPSEdge.html +12 -12
- package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +7 -7
- package/docs/interfaces/datatypes.HTTPSEdgeList.html +3 -3
- package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +22 -22
- package/docs/interfaces/datatypes.HTTPSEdgeRouteCreate.html +18 -18
- package/docs/interfaces/datatypes.HTTPSEdgeRouteUpdate.html +19 -19
- package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +6 -6
- package/docs/interfaces/datatypes.IPPolicy.html +8 -8
- package/docs/interfaces/datatypes.IPPolicyCreate.html +4 -4
- package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRule.html +11 -11
- package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +7 -7
- package/docs/interfaces/datatypes.IPPolicyRuleList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +4 -4
- package/docs/interfaces/datatypes.IPPolicyUpdate.html +3 -3
- package/docs/interfaces/datatypes.IPRestriction.html +11 -11
- package/docs/interfaces/datatypes.IPRestrictionCreate.html +7 -7
- package/docs/interfaces/datatypes.IPRestrictionList.html +4 -4
- package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
- package/docs/interfaces/datatypes.IdentityProvider.html +186 -0
- package/docs/interfaces/datatypes.Item.html +1 -1
- package/docs/interfaces/datatypes.Location.html +224 -0
- package/docs/interfaces/datatypes.Paging.html +2 -2
- package/docs/interfaces/datatypes.Ref.html +2 -2
- package/docs/interfaces/datatypes.ReservedAddr.html +10 -10
- package/docs/interfaces/datatypes.ReservedAddrCreate.html +5 -5
- package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
- package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomain.html +15 -15
- package/docs/interfaces/datatypes.ReservedDomainCertJob.html +6 -6
- package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
- package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomainCreate.html +18 -18
- package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -5
- package/docs/interfaces/datatypes.SSHCertificateAuthority.html +10 -10
- package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +7 -7
- package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHCredential.html +30 -11
- package/docs/interfaces/datatypes.SSHCredentialCreate.html +26 -7
- package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
- package/docs/interfaces/datatypes.SSHCredentialUpdate.html +5 -5
- package/docs/interfaces/datatypes.SSHHostCertificate.html +17 -17
- package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +11 -11
- package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificate.html +20 -20
- package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +14 -14
- package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.TCPEdge.html +11 -11
- package/docs/interfaces/datatypes.TCPEdgeCreate.html +7 -7
- package/docs/interfaces/datatypes.TCPEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TCPEdgeUpdate.html +6 -6
- package/docs/interfaces/datatypes.TLSCertificate.html +28 -28
- package/docs/interfaces/datatypes.TLSCertificateCreate.html +8 -8
- package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
- package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
- package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.TLSEdge.html +13 -13
- package/docs/interfaces/datatypes.TLSEdgeCreate.html +9 -9
- package/docs/interfaces/datatypes.TLSEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TLSEdgeUpdate.html +8 -8
- package/docs/interfaces/datatypes.Tunnel.html +17 -17
- package/docs/interfaces/datatypes.TunnelGroupBackend.html +10 -10
- package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +5 -5
- package/docs/interfaces/datatypes.TunnelGroupBackendList.html +3 -3
- package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +4 -4
- package/docs/interfaces/datatypes.TunnelList.html +3 -3
- package/docs/interfaces/datatypes.TunnelSession.html +12 -12
- package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
- package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
- package/docs/interfaces/datatypes.UserAgent.html +262 -0
- package/docs/interfaces/datatypes.WeightedBackend.html +10 -10
- package/docs/interfaces/datatypes.WeightedBackendCreate.html +6 -6
- package/docs/interfaces/datatypes.WeightedBackendList.html +3 -3
- package/docs/interfaces/datatypes.WeightedBackendUpdate.html +5 -5
- package/docs/modules/datatypes.html +64 -0
- package/docs/modules/services.html +8 -0
- package/jest.config.js +2 -0
- package/lib/client.d.ts +9 -7
- package/lib/client.d.ts.map +1 -1
- package/lib/client.js +89 -119
- package/lib/client.js.map +1 -1
- package/lib/datatypes.d.ts +400 -209
- package/lib/datatypes.d.ts.map +1 -1
- package/lib/datatypes.js +4 -3
- package/lib/datatypes.js.map +1 -1
- package/lib/index.d.ts.map +1 -1
- package/lib/index.js +16 -28
- package/lib/index.js.map +1 -1
- package/lib/services.d.ts +167 -129
- package/lib/services.d.ts.map +1 -1
- package/lib/services.js +3294 -3356
- package/lib/services.js.map +1 -1
- package/lib/util.d.ts.map +1 -1
- package/lib/util.js +35 -34
- package/lib/util.js.map +1 -1
- package/package.json +3 -3
- package/src/client.ts +17 -33
- package/src/datatypes.ts +421 -212
- package/src/index.ts +2 -0
- package/src/services.ts +771 -522
- package/src/util.ts +2 -0
- package/test/apikey.test.js +62 -63
|
@@ -104,7 +104,7 @@
|
|
|
104
104
|
<div class="tsd-signature tsd-kind-icon">body<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></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/9fd8564/src/datatypes.ts#L379">datatypes.ts:379</a></li>
|
|
108
108
|
</ul>
|
|
109
109
|
</aside>
|
|
110
110
|
<div class="tsd-comment tsd-typography">
|
|
@@ -116,10 +116,10 @@
|
|
|
116
116
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
117
117
|
<a name="createdAt" class="tsd-anchor"></a>
|
|
118
118
|
<h3>created<wbr>At</h3>
|
|
119
|
-
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">
|
|
119
|
+
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></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/9fd8564/src/datatypes.ts#L373">datatypes.ts:373</a></li>
|
|
123
123
|
</ul>
|
|
124
124
|
</aside>
|
|
125
125
|
<div class="tsd-comment tsd-typography">
|
|
@@ -130,11 +130,11 @@
|
|
|
130
130
|
</section>
|
|
131
131
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
132
132
|
<a name="description" class="tsd-anchor"></a>
|
|
133
|
-
<h3>description</h3>
|
|
133
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
|
|
134
134
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></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/9fd8564/src/datatypes.ts#L375">datatypes.ts:375</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">headers<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>
|
|
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/9fd8564/src/datatypes.ts#L381">datatypes.ts:381</a></li>
|
|
153
153
|
</ul>
|
|
154
154
|
</aside>
|
|
155
155
|
<div class="tsd-comment tsd-typography">
|
|
@@ -164,17 +164,17 @@
|
|
|
164
164
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></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/9fd8564/src/datatypes.ts#L369">datatypes.ts:369</a></li>
|
|
168
168
|
</ul>
|
|
169
169
|
</aside>
|
|
170
170
|
</section>
|
|
171
171
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
172
172
|
<a name="metadata" class="tsd-anchor"></a>
|
|
173
|
-
<h3>metadata</h3>
|
|
173
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
|
|
174
174
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
175
175
|
<aside class="tsd-sources">
|
|
176
176
|
<ul>
|
|
177
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
177
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L377">datatypes.ts:377</a></li>
|
|
178
178
|
</ul>
|
|
179
179
|
</aside>
|
|
180
180
|
<div class="tsd-comment tsd-typography">
|
|
@@ -189,7 +189,7 @@
|
|
|
189
189
|
<div class="tsd-signature tsd-kind-icon">status<wbr>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
190
190
|
<aside class="tsd-sources">
|
|
191
191
|
<ul>
|
|
192
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
192
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L383">datatypes.ts:383</a></li>
|
|
193
193
|
</ul>
|
|
194
194
|
</aside>
|
|
195
195
|
<div class="tsd-comment tsd-typography">
|
|
@@ -204,7 +204,7 @@
|
|
|
204
204
|
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
205
205
|
<aside class="tsd-sources">
|
|
206
206
|
<ul>
|
|
207
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
207
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L371">datatypes.ts:371</a></li>
|
|
208
208
|
</ul>
|
|
209
209
|
</aside>
|
|
210
210
|
<div class="tsd-comment tsd-typography">
|
|
@@ -101,7 +101,7 @@
|
|
|
101
101
|
<div class="tsd-signature tsd-kind-icon">body<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/9fd8564/src/datatypes.ts#L392">datatypes.ts:392</a></li>
|
|
105
105
|
</ul>
|
|
106
106
|
</aside>
|
|
107
107
|
<div class="tsd-comment tsd-typography">
|
|
@@ -112,11 +112,11 @@
|
|
|
112
112
|
</section>
|
|
113
113
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
114
114
|
<a name="description" class="tsd-anchor"></a>
|
|
115
|
-
<h3>description</h3>
|
|
115
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
|
|
116
116
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
117
117
|
<aside class="tsd-sources">
|
|
118
118
|
<ul>
|
|
119
|
-
<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/9fd8564/src/datatypes.ts#L388">datatypes.ts:388</a></li>
|
|
120
120
|
</ul>
|
|
121
121
|
</aside>
|
|
122
122
|
<div class="tsd-comment tsd-typography">
|
|
@@ -131,7 +131,7 @@
|
|
|
131
131
|
<div class="tsd-signature tsd-kind-icon">headers<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>
|
|
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/9fd8564/src/datatypes.ts#L394">datatypes.ts:394</a></li>
|
|
135
135
|
</ul>
|
|
136
136
|
</aside>
|
|
137
137
|
<div class="tsd-comment tsd-typography">
|
|
@@ -142,11 +142,11 @@
|
|
|
142
142
|
</section>
|
|
143
143
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
144
144
|
<a name="metadata" class="tsd-anchor"></a>
|
|
145
|
-
<h3>metadata</h3>
|
|
145
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
|
|
146
146
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
147
147
|
<aside class="tsd-sources">
|
|
148
148
|
<ul>
|
|
149
|
-
<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/9fd8564/src/datatypes.ts#L390">datatypes.ts:390</a></li>
|
|
150
150
|
</ul>
|
|
151
151
|
</aside>
|
|
152
152
|
<div class="tsd-comment tsd-typography">
|
|
@@ -161,7 +161,7 @@
|
|
|
161
161
|
<div class="tsd-signature tsd-kind-icon">status<wbr>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
162
162
|
<aside class="tsd-sources">
|
|
163
163
|
<ul>
|
|
164
|
-
<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/9fd8564/src/datatypes.ts#L396">datatypes.ts:396</a></li>
|
|
165
165
|
</ul>
|
|
166
166
|
</aside>
|
|
167
167
|
<div class="tsd-comment tsd-typography">
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
<div class="tsd-signature tsd-kind-icon">backends<span class="tsd-signature-symbol">:</span> <a href="datatypes.HTTPResponseBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">HTTPResponseBackend</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/9fd8564/src/datatypes.ts#L414">datatypes.ts:414</a></li>
|
|
103
103
|
</ul>
|
|
104
104
|
</aside>
|
|
105
105
|
</section>
|
|
@@ -109,7 +109,7 @@
|
|
|
109
109
|
<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>
|
|
110
110
|
<aside class="tsd-sources">
|
|
111
111
|
<ul>
|
|
112
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
112
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L416">datatypes.ts:416</a></li>
|
|
113
113
|
</ul>
|
|
114
114
|
</aside>
|
|
115
115
|
</section>
|
|
@@ -119,7 +119,7 @@
|
|
|
119
119
|
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></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/9fd8564/src/datatypes.ts#L415">datatypes.ts:415</a></li>
|
|
123
123
|
</ul>
|
|
124
124
|
</aside>
|
|
125
125
|
</section>
|
|
@@ -102,7 +102,7 @@
|
|
|
102
102
|
<div class="tsd-signature tsd-kind-icon">body<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
103
103
|
<aside class="tsd-sources">
|
|
104
104
|
<ul>
|
|
105
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
105
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L406">datatypes.ts:406</a></li>
|
|
106
106
|
</ul>
|
|
107
107
|
</aside>
|
|
108
108
|
<div class="tsd-comment tsd-typography">
|
|
@@ -117,7 +117,7 @@
|
|
|
117
117
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
118
118
|
<aside class="tsd-sources">
|
|
119
119
|
<ul>
|
|
120
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
120
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L402">datatypes.ts:402</a></li>
|
|
121
121
|
</ul>
|
|
122
122
|
</aside>
|
|
123
123
|
<div class="tsd-comment tsd-typography">
|
|
@@ -132,7 +132,7 @@
|
|
|
132
132
|
<div class="tsd-signature tsd-kind-icon">headers<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>
|
|
133
133
|
<aside class="tsd-sources">
|
|
134
134
|
<ul>
|
|
135
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
135
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L408">datatypes.ts:408</a></li>
|
|
136
136
|
</ul>
|
|
137
137
|
</aside>
|
|
138
138
|
<div class="tsd-comment tsd-typography">
|
|
@@ -147,7 +147,7 @@
|
|
|
147
147
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
148
148
|
<aside class="tsd-sources">
|
|
149
149
|
<ul>
|
|
150
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
150
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L400">datatypes.ts:400</a></li>
|
|
151
151
|
</ul>
|
|
152
152
|
</aside>
|
|
153
153
|
</section>
|
|
@@ -157,7 +157,7 @@
|
|
|
157
157
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
158
158
|
<aside class="tsd-sources">
|
|
159
159
|
<ul>
|
|
160
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
160
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L404">datatypes.ts:404</a></li>
|
|
161
161
|
</ul>
|
|
162
162
|
</aside>
|
|
163
163
|
<div class="tsd-comment tsd-typography">
|
|
@@ -172,7 +172,7 @@
|
|
|
172
172
|
<div class="tsd-signature tsd-kind-icon">status<wbr>Code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
173
173
|
<aside class="tsd-sources">
|
|
174
174
|
<ul>
|
|
175
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
175
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L410">datatypes.ts:410</a></li>
|
|
176
176
|
</ul>
|
|
177
177
|
</aside>
|
|
178
178
|
<div class="tsd-comment tsd-typography">
|
|
@@ -102,10 +102,10 @@
|
|
|
102
102
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
103
103
|
<a name="createdAt" class="tsd-anchor"></a>
|
|
104
104
|
<h3>created<wbr>At</h3>
|
|
105
|
-
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">
|
|
105
|
+
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</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/9fd8564/src/datatypes.ts#L1081">datatypes.ts:1081</a></li>
|
|
109
109
|
</ul>
|
|
110
110
|
</aside>
|
|
111
111
|
<div class="tsd-comment tsd-typography">
|
|
@@ -116,11 +116,11 @@
|
|
|
116
116
|
</section>
|
|
117
117
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
118
118
|
<a name="description" class="tsd-anchor"></a>
|
|
119
|
-
<h3>description</h3>
|
|
119
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
|
|
120
120
|
<div class="tsd-signature tsd-kind-icon">description<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/9fd8564/src/datatypes.ts#L1077">datatypes.ts:1077</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">hostports<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</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/9fd8564/src/datatypes.ts#L1085">datatypes.ts:1085</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">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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/9fd8564/src/datatypes.ts#L1075">datatypes.ts:1075</a></li>
|
|
154
154
|
</ul>
|
|
155
155
|
</aside>
|
|
156
156
|
<div class="tsd-comment tsd-typography">
|
|
@@ -161,11 +161,11 @@
|
|
|
161
161
|
</section>
|
|
162
162
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
163
163
|
<a name="metadata" class="tsd-anchor"></a>
|
|
164
|
-
<h3>metadata</h3>
|
|
164
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
|
|
165
165
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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/9fd8564/src/datatypes.ts#L1079">datatypes.ts:1079</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">mutual<wbr>Tls<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointMutualTLS.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointMutualTLS</a></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/9fd8564/src/datatypes.ts#L1087">datatypes.ts:1087</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">routes<span class="tsd-signature-symbol">:</span> <a href="datatypes.HTTPSEdgeRoute.html" class="tsd-signature-type" data-tsd-kind="Interface">HTTPSEdgeRoute</a><span class="tsd-signature-symbol">[]</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/9fd8564/src/datatypes.ts#L1090">datatypes.ts:1090</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">tls<wbr>Termination<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointTLSTermination.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTLSTermination</a></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/9fd8564/src/datatypes.ts#L1088">datatypes.ts:1088</a></li>
|
|
214
214
|
</ul>
|
|
215
215
|
</aside>
|
|
216
216
|
</section>
|
|
@@ -220,7 +220,7 @@
|
|
|
220
220
|
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
221
221
|
<aside class="tsd-sources">
|
|
222
222
|
<ul>
|
|
223
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
223
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1083">datatypes.ts:1083</a></li>
|
|
224
224
|
</ul>
|
|
225
225
|
</aside>
|
|
226
226
|
<div class="tsd-comment tsd-typography">
|
|
@@ -97,11 +97,11 @@
|
|
|
97
97
|
<h2>Properties</h2>
|
|
98
98
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
99
99
|
<a name="description" class="tsd-anchor"></a>
|
|
100
|
-
<h3>description</h3>
|
|
100
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
|
|
101
101
|
<div class="tsd-signature tsd-kind-icon">description<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/9fd8564/src/datatypes.ts#L1049">datatypes.ts:1049</a></li>
|
|
105
105
|
</ul>
|
|
106
106
|
</aside>
|
|
107
107
|
<div class="tsd-comment tsd-typography">
|
|
@@ -116,7 +116,7 @@
|
|
|
116
116
|
<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>
|
|
117
117
|
<aside class="tsd-sources">
|
|
118
118
|
<ul>
|
|
119
|
-
<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/9fd8564/src/datatypes.ts#L1053">datatypes.ts:1053</a></li>
|
|
120
120
|
</ul>
|
|
121
121
|
</aside>
|
|
122
122
|
<div class="tsd-comment tsd-typography">
|
|
@@ -127,11 +127,11 @@
|
|
|
127
127
|
</section>
|
|
128
128
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
129
129
|
<a name="metadata" class="tsd-anchor"></a>
|
|
130
|
-
<h3>metadata</h3>
|
|
130
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
|
|
131
131
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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/9fd8564/src/datatypes.ts#L1051">datatypes.ts:1051</a></li>
|
|
135
135
|
</ul>
|
|
136
136
|
</aside>
|
|
137
137
|
<div class="tsd-comment tsd-typography">
|
|
@@ -146,7 +146,7 @@
|
|
|
146
146
|
<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>
|
|
147
147
|
<aside class="tsd-sources">
|
|
148
148
|
<ul>
|
|
149
|
-
<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/9fd8564/src/datatypes.ts#L1055">datatypes.ts:1055</a></li>
|
|
150
150
|
</ul>
|
|
151
151
|
</aside>
|
|
152
152
|
<div class="tsd-comment tsd-typography">
|
|
@@ -161,7 +161,7 @@
|
|
|
161
161
|
<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>
|
|
162
162
|
<aside class="tsd-sources">
|
|
163
163
|
<ul>
|
|
164
|
-
<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/9fd8564/src/datatypes.ts#L1056">datatypes.ts:1056</a></li>
|
|
165
165
|
</ul>
|
|
166
166
|
</aside>
|
|
167
167
|
</section>
|
|
@@ -99,7 +99,7 @@
|
|
|
99
99
|
<div class="tsd-signature tsd-kind-icon">https<wbr>Edges<span class="tsd-signature-symbol">:</span> <a href="datatypes.HTTPSEdge.html" class="tsd-signature-type" data-tsd-kind="Interface">HTTPSEdge</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/9fd8564/src/datatypes.ts#L1040">datatypes.ts:1040</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/9fd8564/src/datatypes.ts#L1044">datatypes.ts:1044</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/9fd8564/src/datatypes.ts#L1042">datatypes.ts:1042</a></li>
|
|
133
133
|
</ul>
|
|
134
134
|
</aside>
|
|
135
135
|
<div class="tsd-comment tsd-typography">
|
|
@@ -115,7 +115,7 @@
|
|
|
115
115
|
<div class="tsd-signature tsd-kind-icon">backend<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointBackend</a></div>
|
|
116
116
|
<aside class="tsd-sources">
|
|
117
117
|
<ul>
|
|
118
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
118
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1015">datatypes.ts:1015</a></li>
|
|
119
119
|
</ul>
|
|
120
120
|
</aside>
|
|
121
121
|
<div class="tsd-comment tsd-typography">
|
|
@@ -130,7 +130,7 @@
|
|
|
130
130
|
<div class="tsd-signature tsd-kind-icon">circuit<wbr>Breaker<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointCircuitBreaker.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointCircuitBreaker</a></div>
|
|
131
131
|
<aside class="tsd-sources">
|
|
132
132
|
<ul>
|
|
133
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
133
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1019">datatypes.ts:1019</a></li>
|
|
134
134
|
</ul>
|
|
135
135
|
</aside>
|
|
136
136
|
<div class="tsd-comment tsd-typography">
|
|
@@ -145,7 +145,7 @@
|
|
|
145
145
|
<div class="tsd-signature tsd-kind-icon">compression<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointCompression.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointCompression</a></div>
|
|
146
146
|
<aside class="tsd-sources">
|
|
147
147
|
<ul>
|
|
148
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
148
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1021">datatypes.ts:1021</a></li>
|
|
149
149
|
</ul>
|
|
150
150
|
</aside>
|
|
151
151
|
<div class="tsd-comment tsd-typography">
|
|
@@ -157,10 +157,10 @@
|
|
|
157
157
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
158
158
|
<a name="createdAt" class="tsd-anchor"></a>
|
|
159
159
|
<h3>created<wbr>At</h3>
|
|
160
|
-
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">
|
|
160
|
+
<div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
|
|
161
161
|
<aside class="tsd-sources">
|
|
162
162
|
<ul>
|
|
163
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
163
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1003">datatypes.ts:1003</a></li>
|
|
164
164
|
</ul>
|
|
165
165
|
</aside>
|
|
166
166
|
<div class="tsd-comment tsd-typography">
|
|
@@ -171,11 +171,11 @@
|
|
|
171
171
|
</section>
|
|
172
172
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
173
173
|
<a name="description" class="tsd-anchor"></a>
|
|
174
|
-
<h3>description</h3>
|
|
174
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
|
|
175
175
|
<div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
176
176
|
<aside class="tsd-sources">
|
|
177
177
|
<ul>
|
|
178
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
178
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1011">datatypes.ts:1011</a></li>
|
|
179
179
|
</ul>
|
|
180
180
|
</aside>
|
|
181
181
|
<div class="tsd-comment tsd-typography">
|
|
@@ -190,7 +190,7 @@
|
|
|
190
190
|
<div class="tsd-signature tsd-kind-icon">edge<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
191
191
|
<aside class="tsd-sources">
|
|
192
192
|
<ul>
|
|
193
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
193
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L999">datatypes.ts:999</a></li>
|
|
194
194
|
</ul>
|
|
195
195
|
</aside>
|
|
196
196
|
<div class="tsd-comment tsd-typography">
|
|
@@ -205,7 +205,7 @@
|
|
|
205
205
|
<div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
206
206
|
<aside class="tsd-sources">
|
|
207
207
|
<ul>
|
|
208
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
208
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1001">datatypes.ts:1001</a></li>
|
|
209
209
|
</ul>
|
|
210
210
|
</aside>
|
|
211
211
|
<div class="tsd-comment tsd-typography">
|
|
@@ -220,7 +220,7 @@
|
|
|
220
220
|
<div class="tsd-signature tsd-kind-icon">ip<wbr>Restriction<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointIPPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicy</a></div>
|
|
221
221
|
<aside class="tsd-sources">
|
|
222
222
|
<ul>
|
|
223
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
223
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1017">datatypes.ts:1017</a></li>
|
|
224
224
|
</ul>
|
|
225
225
|
</aside>
|
|
226
226
|
<div class="tsd-comment tsd-typography">
|
|
@@ -235,7 +235,7 @@
|
|
|
235
235
|
<div class="tsd-signature tsd-kind-icon">match<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
236
236
|
<aside class="tsd-sources">
|
|
237
237
|
<ul>
|
|
238
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
238
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1007">datatypes.ts:1007</a></li>
|
|
239
239
|
</ul>
|
|
240
240
|
</aside>
|
|
241
241
|
<div class="tsd-comment tsd-typography">
|
|
@@ -250,7 +250,7 @@
|
|
|
250
250
|
<div class="tsd-signature tsd-kind-icon">match<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
251
251
|
<aside class="tsd-sources">
|
|
252
252
|
<ul>
|
|
253
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
253
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1005">datatypes.ts:1005</a></li>
|
|
254
254
|
</ul>
|
|
255
255
|
</aside>
|
|
256
256
|
<div class="tsd-comment tsd-typography">
|
|
@@ -261,11 +261,11 @@
|
|
|
261
261
|
</section>
|
|
262
262
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
263
263
|
<a name="metadata" class="tsd-anchor"></a>
|
|
264
|
-
<h3>metadata</h3>
|
|
264
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
|
|
265
265
|
<div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
266
266
|
<aside class="tsd-sources">
|
|
267
267
|
<ul>
|
|
268
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
268
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1013">datatypes.ts:1013</a></li>
|
|
269
269
|
</ul>
|
|
270
270
|
</aside>
|
|
271
271
|
<div class="tsd-comment tsd-typography">
|
|
@@ -280,7 +280,7 @@
|
|
|
280
280
|
<div class="tsd-signature tsd-kind-icon">oauth<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuth.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuth</a></div>
|
|
281
281
|
<aside class="tsd-sources">
|
|
282
282
|
<ul>
|
|
283
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
283
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1029">datatypes.ts:1029</a></li>
|
|
284
284
|
</ul>
|
|
285
285
|
</aside>
|
|
286
286
|
<div class="tsd-comment tsd-typography">
|
|
@@ -295,7 +295,7 @@
|
|
|
295
295
|
<div class="tsd-signature tsd-kind-icon">oidc<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOIDC.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOIDC</a></div>
|
|
296
296
|
<aside class="tsd-sources">
|
|
297
297
|
<ul>
|
|
298
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
298
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1033">datatypes.ts:1033</a></li>
|
|
299
299
|
</ul>
|
|
300
300
|
</aside>
|
|
301
301
|
<div class="tsd-comment tsd-typography">
|
|
@@ -310,7 +310,7 @@
|
|
|
310
310
|
<div class="tsd-signature tsd-kind-icon">request<wbr>Headers<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointRequestHeaders.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointRequestHeaders</a></div>
|
|
311
311
|
<aside class="tsd-sources">
|
|
312
312
|
<ul>
|
|
313
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
313
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1023">datatypes.ts:1023</a></li>
|
|
314
314
|
</ul>
|
|
315
315
|
</aside>
|
|
316
316
|
<div class="tsd-comment tsd-typography">
|
|
@@ -325,7 +325,7 @@
|
|
|
325
325
|
<div class="tsd-signature tsd-kind-icon">response<wbr>Headers<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointResponseHeaders.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointResponseHeaders</a></div>
|
|
326
326
|
<aside class="tsd-sources">
|
|
327
327
|
<ul>
|
|
328
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
328
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1025">datatypes.ts:1025</a></li>
|
|
329
329
|
</ul>
|
|
330
330
|
</aside>
|
|
331
331
|
<div class="tsd-comment tsd-typography">
|
|
@@ -340,7 +340,7 @@
|
|
|
340
340
|
<div class="tsd-signature tsd-kind-icon">saml<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointSAML.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointSAML</a></div>
|
|
341
341
|
<aside class="tsd-sources">
|
|
342
342
|
<ul>
|
|
343
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
343
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1031">datatypes.ts:1031</a></li>
|
|
344
344
|
</ul>
|
|
345
345
|
</aside>
|
|
346
346
|
<div class="tsd-comment tsd-typography">
|
|
@@ -355,7 +355,7 @@
|
|
|
355
355
|
<div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
356
356
|
<aside class="tsd-sources">
|
|
357
357
|
<ul>
|
|
358
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
358
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1009">datatypes.ts:1009</a></li>
|
|
359
359
|
</ul>
|
|
360
360
|
</aside>
|
|
361
361
|
<div class="tsd-comment tsd-typography">
|
|
@@ -370,7 +370,7 @@
|
|
|
370
370
|
<div class="tsd-signature tsd-kind-icon">webhook<wbr>Verification<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointWebhookValidation.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointWebhookValidation</a></div>
|
|
371
371
|
<aside class="tsd-sources">
|
|
372
372
|
<ul>
|
|
373
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
373
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1027">datatypes.ts:1027</a></li>
|
|
374
374
|
</ul>
|
|
375
375
|
</aside>
|
|
376
376
|
<div class="tsd-comment tsd-typography">
|
|
@@ -385,7 +385,7 @@
|
|
|
385
385
|
<div class="tsd-signature tsd-kind-icon">websocket<wbr>Tcp<wbr>Converter<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointWebsocketTCPConverter.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointWebsocketTCPConverter</a></div>
|
|
386
386
|
<aside class="tsd-sources">
|
|
387
387
|
<ul>
|
|
388
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
388
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1035">datatypes.ts:1035</a></li>
|
|
389
389
|
</ul>
|
|
390
390
|
</aside>
|
|
391
391
|
<div class="tsd-comment tsd-typography">
|