@ngrok/ngrok-api 0.9.0 → 0.11.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 +16 -3
- package/CODE_OF_CONDUCT.md +45 -0
- package/README.md +9 -3
- package/docs/assets/js/search.js +1 -1
- package/docs/classes/client.Ngrok.html +82 -28
- 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.BotUsers.html +352 -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.EdgeRoutePolicyModule.html +270 -0
- package/docs/classes/services.EdgeRouteRequestHeadersModule.html +4 -4
- package/docs/classes/services.EdgeRouteResponseHeadersModule.html +4 -4
- package/docs/classes/services.EdgeRouteSAMLModule.html +4 -4
- package/docs/classes/services.EdgeRouteUserAgentFilterModule.html +270 -0
- package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +4 -4
- package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +4 -4
- package/docs/classes/services.EdgesHTTPS.html +20 -11
- package/docs/classes/services.EdgesHTTPSRoutes.html +5 -5
- package/docs/classes/services.EdgesTCP.html +20 -11
- package/docs/classes/services.EdgesTLS.html +20 -11
- package/docs/classes/services.Endpoints.html +15 -6
- package/docs/classes/services.EventDestinations.html +21 -12
- package/docs/classes/services.EventSources.html +6 -6
- package/docs/classes/services.EventSubscriptions.html +20 -11
- package/docs/classes/services.FailoverBackends.html +20 -11
- package/docs/classes/services.HTTPResponseBackends.html +20 -11
- package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +8 -8
- package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +8 -8
- package/docs/classes/services.IPPolicies.html +20 -11
- package/docs/classes/services.IPPolicyRules.html +20 -11
- package/docs/classes/services.IPRestrictions.html +20 -11
- package/docs/classes/services.ReservedAddrs.html +20 -11
- package/docs/classes/services.ReservedDomains.html +26 -17
- package/docs/classes/services.SSHCertificateAuthorities.html +20 -11
- package/docs/classes/services.SSHCredentials.html +20 -11
- package/docs/classes/services.SSHHostCertificates.html +20 -11
- package/docs/classes/services.SSHUserCertificates.html +20 -11
- package/docs/classes/services.StaticBackends.html +360 -0
- package/docs/classes/services.TCPEdgeBackendModule.html +8 -8
- package/docs/classes/services.TCPEdgeIPRestrictionModule.html +8 -8
- package/docs/classes/services.TCPEdgePolicyModule.html +270 -0
- 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.TLSEdgePolicyModule.html +270 -0
- package/docs/classes/services.TLSEdgeTLSTerminationModule.html +8 -8
- package/docs/classes/services.TunnelGroupBackends.html +20 -11
- package/docs/classes/services.TunnelSessions.html +22 -13
- package/docs/classes/services.Tunnels.html +15 -6
- package/docs/classes/services.WeightedBackends.html +20 -11
- package/docs/index.html +8 -3
- package/docs/interfaces/client.NgrokConfig.html +3 -3
- 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.BotUser.html +243 -0
- package/docs/interfaces/datatypes.BotUserCreate.html +186 -0
- package/docs/interfaces/datatypes.BotUserList.html +205 -0
- package/docs/interfaces/datatypes.BotUserUpdate.html +200 -0
- package/docs/interfaces/datatypes.BrowserSession.html +205 -0
- package/docs/interfaces/datatypes.CertificateAuthority.html +16 -16
- package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +5 -5
- package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.Credential.html +30 -11
- package/docs/interfaces/datatypes.CredentialCreate.html +25 -6
- package/docs/interfaces/datatypes.CredentialList.html +3 -3
- package/docs/interfaces/datatypes.CredentialUpdate.html +5 -5
- package/docs/interfaces/datatypes.EdgeBackendReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeIPRestrictionReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeMutualTLSReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgePolicyReplace.html +176 -0
- package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteCompressionReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteItem.html +2 -2
- package/docs/interfaces/datatypes.EdgeRouteOAuthReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRoutePolicyReplace.html +190 -0
- package/docs/interfaces/datatypes.EdgeRouteRequestHeadersReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteSAMLReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteUserAgentFilterReplace.html +190 -0
- package/docs/interfaces/datatypes.EdgeRouteWebhookVerificationReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeTLSTerminationAtEdgeReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeTLSTerminationReplace.html +2 -2
- package/docs/interfaces/datatypes.Endpoint.html +19 -19
- package/docs/interfaces/datatypes.EndpointAction.html +186 -0
- package/docs/interfaces/datatypes.EndpointBackend.html +2 -2
- package/docs/interfaces/datatypes.EndpointBackendMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
- package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
- package/docs/interfaces/datatypes.EndpointIPPolicy.html +7 -2
- package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointList.html +3 -3
- package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
- package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
- package/docs/interfaces/datatypes.EndpointOAuthAmazon.html +218 -0
- package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +12 -12
- package/docs/interfaces/datatypes.EndpointOAuthGitLab.html +218 -0
- package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthLinkedIn.html +218 -0
- package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
- package/docs/interfaces/datatypes.EndpointOAuthProvider.html +80 -4
- package/docs/interfaces/datatypes.EndpointOAuthTwitch.html +218 -0
- package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
- package/docs/interfaces/datatypes.EndpointPolicy.html +205 -0
- package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointRule.html +205 -0
- package/docs/interfaces/datatypes.EndpointSAML.html +15 -15
- package/docs/interfaces/datatypes.EndpointSAMLMutate.html +10 -10
- package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
- package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +2 -2
- package/docs/interfaces/datatypes.EndpointUserAgentFilter.html +190 -0
- package/docs/interfaces/datatypes.EndpointWebhookValidation.html +4 -4
- package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +1 -1
- package/docs/interfaces/datatypes.Error.html +4 -4
- package/docs/interfaces/datatypes.EventDestination.html +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 +55 -22
- package/docs/interfaces/datatypes.HTTPSEdgeRouteCreate.html +51 -18
- package/docs/interfaces/datatypes.HTTPSEdgeRouteUpdate.html +52 -19
- package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +6 -6
- package/docs/interfaces/datatypes.IPPolicy.html +8 -8
- package/docs/interfaces/datatypes.IPPolicyCreate.html +4 -4
- package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRule.html +11 -11
- package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +7 -7
- package/docs/interfaces/datatypes.IPPolicyRuleList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +4 -4
- package/docs/interfaces/datatypes.IPPolicyUpdate.html +3 -3
- package/docs/interfaces/datatypes.IPRestriction.html +11 -11
- package/docs/interfaces/datatypes.IPRestrictionCreate.html +7 -7
- package/docs/interfaces/datatypes.IPRestrictionList.html +3 -3
- package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
- package/docs/interfaces/datatypes.IdentityProvider.html +186 -0
- package/docs/interfaces/datatypes.Item.html +1 -1
- package/docs/interfaces/datatypes.Location.html +224 -0
- package/docs/interfaces/datatypes.Paging.html +2 -2
- package/docs/interfaces/datatypes.Ref.html +2 -2
- package/docs/interfaces/datatypes.ReservedAddr.html +10 -10
- package/docs/interfaces/datatypes.ReservedAddrCreate.html +5 -5
- package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
- package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomain.html +17 -17
- 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 +19 -19
- package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -5
- package/docs/interfaces/datatypes.SSHCertificateAuthority.html +10 -10
- package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +7 -7
- package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHCredential.html +30 -11
- package/docs/interfaces/datatypes.SSHCredentialCreate.html +26 -7
- package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
- package/docs/interfaces/datatypes.SSHCredentialUpdate.html +5 -5
- package/docs/interfaces/datatypes.SSHHostCertificate.html +17 -17
- package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +11 -11
- package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificate.html +19 -19
- package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +13 -13
- package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.StaticBackend.html +281 -0
- package/docs/interfaces/datatypes.StaticBackendCreate.html +224 -0
- package/docs/interfaces/datatypes.StaticBackendList.html +205 -0
- package/docs/interfaces/datatypes.StaticBackendTLS.html +167 -0
- package/docs/interfaces/datatypes.StaticBackendUpdate.html +238 -0
- package/docs/interfaces/datatypes.TCPEdge.html +30 -11
- package/docs/interfaces/datatypes.TCPEdgeCreate.html +26 -7
- package/docs/interfaces/datatypes.TCPEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TCPEdgeUpdate.html +25 -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 +32 -13
- package/docs/interfaces/datatypes.TLSEdgeCreate.html +28 -9
- package/docs/interfaces/datatypes.TLSEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TLSEdgeUpdate.html +27 -8
- package/docs/interfaces/datatypes.Tunnel.html +17 -17
- package/docs/interfaces/datatypes.TunnelGroupBackend.html +10 -10
- package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +5 -5
- package/docs/interfaces/datatypes.TunnelGroupBackendList.html +3 -3
- package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +4 -4
- package/docs/interfaces/datatypes.TunnelList.html +3 -3
- package/docs/interfaces/datatypes.TunnelSession.html +12 -12
- package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
- package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
- package/docs/interfaces/datatypes.UserAgent.html +262 -0
- package/docs/interfaces/datatypes.WeightedBackend.html +9 -9
- package/docs/interfaces/datatypes.WeightedBackendCreate.html +5 -5
- package/docs/interfaces/datatypes.WeightedBackendList.html +3 -3
- package/docs/interfaces/datatypes.WeightedBackendUpdate.html +4 -4
- package/docs/modules/datatypes.html +128 -0
- package/docs/modules/services.html +32 -0
- package/jest.config.js +2 -0
- package/lib/client.d.ts +17 -8
- package/lib/client.d.ts.map +1 -1
- package/lib/client.js +92 -119
- package/lib/client.js.map +1 -1
- package/lib/datatypes.d.ts +539 -204
- 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 +254 -126
- package/lib/services.d.ts.map +1 -1
- package/lib/services.js +3613 -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 +4 -3
- package/src/client.ts +28 -33
- package/src/datatypes.ts +576 -207
- package/src/index.ts +2 -0
- package/src/services.ts +1136 -553
- package/src/util.ts +2 -0
- package/test/apikey.test.js +62 -63
|
@@ -103,7 +103,7 @@
|
|
|
103
103
|
<div class="tsd-signature tsd-kind-icon">auth<wbr>Check<wbr>Interval<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
104
104
|
<aside class="tsd-sources">
|
|
105
105
|
<ul>
|
|
106
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
106
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L803">datatypes.ts:803</a></li>
|
|
107
107
|
</ul>
|
|
108
108
|
</aside>
|
|
109
109
|
<div class="tsd-comment tsd-typography">
|
|
@@ -118,7 +118,7 @@
|
|
|
118
118
|
<div class="tsd-signature tsd-kind-icon">cookie<wbr>Prefix<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
119
119
|
<aside class="tsd-sources">
|
|
120
120
|
<ul>
|
|
121
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
121
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L797">datatypes.ts:797</a></li>
|
|
122
122
|
</ul>
|
|
123
123
|
</aside>
|
|
124
124
|
<div class="tsd-comment tsd-typography">
|
|
@@ -133,7 +133,7 @@
|
|
|
133
133
|
<div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
134
134
|
<aside class="tsd-sources">
|
|
135
135
|
<ul>
|
|
136
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
136
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L791">datatypes.ts:791</a></li>
|
|
137
137
|
</ul>
|
|
138
138
|
</aside>
|
|
139
139
|
<div class="tsd-comment tsd-typography">
|
|
@@ -148,7 +148,7 @@
|
|
|
148
148
|
<div class="tsd-signature tsd-kind-icon">inactivity<wbr>Timeout<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
149
149
|
<aside class="tsd-sources">
|
|
150
150
|
<ul>
|
|
151
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
151
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L799">datatypes.ts:799</a></li>
|
|
152
152
|
</ul>
|
|
153
153
|
</aside>
|
|
154
154
|
<div class="tsd-comment tsd-typography">
|
|
@@ -163,7 +163,7 @@
|
|
|
163
163
|
<div class="tsd-signature tsd-kind-icon">maximum<wbr>Duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
|
|
164
164
|
<aside class="tsd-sources">
|
|
165
165
|
<ul>
|
|
166
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
166
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L801">datatypes.ts:801</a></li>
|
|
167
167
|
</ul>
|
|
168
168
|
</aside>
|
|
169
169
|
<div class="tsd-comment tsd-typography">
|
|
@@ -178,7 +178,7 @@
|
|
|
178
178
|
<div class="tsd-signature tsd-kind-icon">options<wbr>Passthrough<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
|
|
179
179
|
<aside class="tsd-sources">
|
|
180
180
|
<ul>
|
|
181
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
181
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L795">datatypes.ts:795</a></li>
|
|
182
182
|
</ul>
|
|
183
183
|
</aside>
|
|
184
184
|
<div class="tsd-comment tsd-typography">
|
|
@@ -193,7 +193,7 @@
|
|
|
193
193
|
<div class="tsd-signature tsd-kind-icon">provider<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuthProvider.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuthProvider</a></div>
|
|
194
194
|
<aside class="tsd-sources">
|
|
195
195
|
<ul>
|
|
196
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
196
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L793">datatypes.ts:793</a></li>
|
|
197
197
|
</ul>
|
|
198
198
|
</aside>
|
|
199
199
|
<div class="tsd-comment tsd-typography">
|
|
@@ -0,0 +1,218 @@
|
|
|
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>EndpointOAuthAmazon | @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.EndpointOAuthAmazon.html">EndpointOAuthAmazon</a>
|
|
62
|
+
</li>
|
|
63
|
+
</ul>
|
|
64
|
+
<h1>Interface EndpointOAuthAmazon</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">EndpointOAuthAmazon</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.EndpointOAuthAmazon.html#clientId" class="tsd-kind-icon">client<wbr>Id</a></li>
|
|
87
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOAuthAmazon.html#clientSecret" class="tsd-kind-icon">client<wbr>Secret</a></li>
|
|
88
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOAuthAmazon.html#emailAddresses" class="tsd-kind-icon">email<wbr>Addresses</a></li>
|
|
89
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOAuthAmazon.html#emailDomains" class="tsd-kind-icon">email<wbr>Domains</a></li>
|
|
90
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOAuthAmazon.html#scopes" class="tsd-kind-icon">scopes</a></li>
|
|
91
|
+
</ul>
|
|
92
|
+
</section>
|
|
93
|
+
</div>
|
|
94
|
+
</section>
|
|
95
|
+
</section>
|
|
96
|
+
<section class="tsd-panel-group tsd-member-group ">
|
|
97
|
+
<h2>Properties</h2>
|
|
98
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
99
|
+
<a name="clientId" class="tsd-anchor"></a>
|
|
100
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> client<wbr>Id</h3>
|
|
101
|
+
<div class="tsd-signature tsd-kind-icon">client<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
102
|
+
<aside class="tsd-sources">
|
|
103
|
+
<ul>
|
|
104
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L906">datatypes.ts:906</a></li>
|
|
105
|
+
</ul>
|
|
106
|
+
</aside>
|
|
107
|
+
</section>
|
|
108
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
109
|
+
<a name="clientSecret" class="tsd-anchor"></a>
|
|
110
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> client<wbr>Secret</h3>
|
|
111
|
+
<div class="tsd-signature tsd-kind-icon">client<wbr>Secret<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
112
|
+
<aside class="tsd-sources">
|
|
113
|
+
<ul>
|
|
114
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L907">datatypes.ts:907</a></li>
|
|
115
|
+
</ul>
|
|
116
|
+
</aside>
|
|
117
|
+
</section>
|
|
118
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
119
|
+
<a name="emailAddresses" class="tsd-anchor"></a>
|
|
120
|
+
<h3>email<wbr>Addresses</h3>
|
|
121
|
+
<div class="tsd-signature tsd-kind-icon">email<wbr>Addresses<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
122
|
+
<aside class="tsd-sources">
|
|
123
|
+
<ul>
|
|
124
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L909">datatypes.ts:909</a></li>
|
|
125
|
+
</ul>
|
|
126
|
+
</aside>
|
|
127
|
+
</section>
|
|
128
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
129
|
+
<a name="emailDomains" class="tsd-anchor"></a>
|
|
130
|
+
<h3>email<wbr>Domains</h3>
|
|
131
|
+
<div class="tsd-signature tsd-kind-icon">email<wbr>Domains<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
132
|
+
<aside class="tsd-sources">
|
|
133
|
+
<ul>
|
|
134
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L910">datatypes.ts:910</a></li>
|
|
135
|
+
</ul>
|
|
136
|
+
</aside>
|
|
137
|
+
</section>
|
|
138
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
139
|
+
<a name="scopes" class="tsd-anchor"></a>
|
|
140
|
+
<h3>scopes</h3>
|
|
141
|
+
<div class="tsd-signature tsd-kind-icon">scopes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
142
|
+
<aside class="tsd-sources">
|
|
143
|
+
<ul>
|
|
144
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L908">datatypes.ts:908</a></li>
|
|
145
|
+
</ul>
|
|
146
|
+
</aside>
|
|
147
|
+
</section>
|
|
148
|
+
</section>
|
|
149
|
+
</div>
|
|
150
|
+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
151
|
+
<nav class="tsd-navigation primary">
|
|
152
|
+
<ul>
|
|
153
|
+
<li class=" ">
|
|
154
|
+
<a href="../modules.html">Modules</a>
|
|
155
|
+
</li>
|
|
156
|
+
<li class=" tsd-kind-module">
|
|
157
|
+
<a href="../modules/client.html">client</a>
|
|
158
|
+
</li>
|
|
159
|
+
<li class="current tsd-kind-module">
|
|
160
|
+
<a href="../modules/datatypes.html">datatypes</a>
|
|
161
|
+
</li>
|
|
162
|
+
<li class=" tsd-kind-module">
|
|
163
|
+
<a href="../modules/services.html">services</a>
|
|
164
|
+
</li>
|
|
165
|
+
</ul>
|
|
166
|
+
</nav>
|
|
167
|
+
<nav class="tsd-navigation secondary menu-sticky">
|
|
168
|
+
<ul class="before-current">
|
|
169
|
+
</ul>
|
|
170
|
+
<ul class="current">
|
|
171
|
+
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
172
|
+
<a href="datatypes.EndpointOAuthAmazon.html" class="tsd-kind-icon">EndpointOAuth<wbr>Amazon</a>
|
|
173
|
+
<ul>
|
|
174
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
175
|
+
<a href="datatypes.EndpointOAuthAmazon.html#clientId" class="tsd-kind-icon">client<wbr>Id</a>
|
|
176
|
+
</li>
|
|
177
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
178
|
+
<a href="datatypes.EndpointOAuthAmazon.html#clientSecret" class="tsd-kind-icon">client<wbr>Secret</a>
|
|
179
|
+
</li>
|
|
180
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
181
|
+
<a href="datatypes.EndpointOAuthAmazon.html#emailAddresses" class="tsd-kind-icon">email<wbr>Addresses</a>
|
|
182
|
+
</li>
|
|
183
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
184
|
+
<a href="datatypes.EndpointOAuthAmazon.html#emailDomains" class="tsd-kind-icon">email<wbr>Domains</a>
|
|
185
|
+
</li>
|
|
186
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
187
|
+
<a href="datatypes.EndpointOAuthAmazon.html#scopes" class="tsd-kind-icon">scopes</a>
|
|
188
|
+
</li>
|
|
189
|
+
</ul>
|
|
190
|
+
</li>
|
|
191
|
+
</ul>
|
|
192
|
+
<ul class="after-current">
|
|
193
|
+
</ul>
|
|
194
|
+
</nav>
|
|
195
|
+
</div>
|
|
196
|
+
</div>
|
|
197
|
+
</div>
|
|
198
|
+
<footer class="with-border-bottom">
|
|
199
|
+
<div class="container">
|
|
200
|
+
<h2>Legend</h2>
|
|
201
|
+
<div class="tsd-legend-group">
|
|
202
|
+
<ul class="tsd-legend">
|
|
203
|
+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
204
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
205
|
+
</ul>
|
|
206
|
+
<ul class="tsd-legend">
|
|
207
|
+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
208
|
+
</ul>
|
|
209
|
+
</div>
|
|
210
|
+
</div>
|
|
211
|
+
</footer>
|
|
212
|
+
<div class="container tsd-generator">
|
|
213
|
+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
214
|
+
</div>
|
|
215
|
+
<div class="overlay"></div>
|
|
216
|
+
<script src="../assets/js/main.js"></script>
|
|
217
|
+
</body>
|
|
218
|
+
</html>
|
|
@@ -101,7 +101,7 @@
|
|
|
101
101
|
<div class="tsd-signature tsd-kind-icon">client<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
102
102
|
<aside class="tsd-sources">
|
|
103
103
|
<ul>
|
|
104
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
104
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L844">datatypes.ts:844</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">client<wbr>Secret<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/4214cc1/src/datatypes.ts#L846">datatypes.ts:846</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">email<wbr>Addresses<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/4214cc1/src/datatypes.ts#L850">datatypes.ts:850</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">email<wbr>Domains<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</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/4214cc1/src/datatypes.ts#L852">datatypes.ts:852</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">scopes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</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/4214cc1/src/datatypes.ts#L848">datatypes.ts:848</a></li>
|
|
165
165
|
</ul>
|
|
166
166
|
</aside>
|
|
167
167
|
<div class="tsd-comment tsd-typography">
|
|
@@ -103,7 +103,7 @@
|
|
|
103
103
|
<div class="tsd-signature tsd-kind-icon">client<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
104
104
|
<aside class="tsd-sources">
|
|
105
105
|
<ul>
|
|
106
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
106
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L827">datatypes.ts:827</a></li>
|
|
107
107
|
</ul>
|
|
108
108
|
</aside>
|
|
109
109
|
<div class="tsd-comment tsd-typography">
|
|
@@ -118,7 +118,7 @@
|
|
|
118
118
|
<div class="tsd-signature tsd-kind-icon">client<wbr>Secret<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
119
119
|
<aside class="tsd-sources">
|
|
120
120
|
<ul>
|
|
121
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
121
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L829">datatypes.ts:829</a></li>
|
|
122
122
|
</ul>
|
|
123
123
|
</aside>
|
|
124
124
|
<div class="tsd-comment tsd-typography">
|
|
@@ -129,11 +129,11 @@
|
|
|
129
129
|
</section>
|
|
130
130
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
131
131
|
<a name="emailAddresses" class="tsd-anchor"></a>
|
|
132
|
-
<h3>email<wbr>Addresses</h3>
|
|
132
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> email<wbr>Addresses</h3>
|
|
133
133
|
<div class="tsd-signature tsd-kind-icon">email<wbr>Addresses<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
134
134
|
<aside class="tsd-sources">
|
|
135
135
|
<ul>
|
|
136
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
136
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L833">datatypes.ts:833</a></li>
|
|
137
137
|
</ul>
|
|
138
138
|
</aside>
|
|
139
139
|
<div class="tsd-comment tsd-typography">
|
|
@@ -144,11 +144,11 @@
|
|
|
144
144
|
</section>
|
|
145
145
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
146
146
|
<a name="emailDomains" class="tsd-anchor"></a>
|
|
147
|
-
<h3>email<wbr>Domains</h3>
|
|
147
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> email<wbr>Domains</h3>
|
|
148
148
|
<div class="tsd-signature tsd-kind-icon">email<wbr>Domains<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
149
149
|
<aside class="tsd-sources">
|
|
150
150
|
<ul>
|
|
151
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
151
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L835">datatypes.ts:835</a></li>
|
|
152
152
|
</ul>
|
|
153
153
|
</aside>
|
|
154
154
|
<div class="tsd-comment tsd-typography">
|
|
@@ -159,11 +159,11 @@
|
|
|
159
159
|
</section>
|
|
160
160
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
161
161
|
<a name="organizations" class="tsd-anchor"></a>
|
|
162
|
-
<h3>organizations</h3>
|
|
162
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> organizations</h3>
|
|
163
163
|
<div class="tsd-signature tsd-kind-icon">organizations<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
164
164
|
<aside class="tsd-sources">
|
|
165
165
|
<ul>
|
|
166
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
166
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L839">datatypes.ts:839</a></li>
|
|
167
167
|
</ul>
|
|
168
168
|
</aside>
|
|
169
169
|
<div class="tsd-comment tsd-typography">
|
|
@@ -174,11 +174,11 @@
|
|
|
174
174
|
</section>
|
|
175
175
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
176
176
|
<a name="scopes" class="tsd-anchor"></a>
|
|
177
|
-
<h3>scopes</h3>
|
|
177
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> scopes</h3>
|
|
178
178
|
<div class="tsd-signature tsd-kind-icon">scopes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
179
179
|
<aside class="tsd-sources">
|
|
180
180
|
<ul>
|
|
181
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
181
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L831">datatypes.ts:831</a></li>
|
|
182
182
|
</ul>
|
|
183
183
|
</aside>
|
|
184
184
|
<div class="tsd-comment tsd-typography">
|
|
@@ -189,11 +189,11 @@
|
|
|
189
189
|
</section>
|
|
190
190
|
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
191
191
|
<a name="teams" class="tsd-anchor"></a>
|
|
192
|
-
<h3>teams</h3>
|
|
192
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> teams</h3>
|
|
193
193
|
<div class="tsd-signature tsd-kind-icon">teams<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
194
194
|
<aside class="tsd-sources">
|
|
195
195
|
<ul>
|
|
196
|
-
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/
|
|
196
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L837">datatypes.ts:837</a></li>
|
|
197
197
|
</ul>
|
|
198
198
|
</aside>
|
|
199
199
|
<div class="tsd-comment tsd-typography">
|
|
@@ -0,0 +1,218 @@
|
|
|
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>EndpointOAuthGitLab | @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.EndpointOAuthGitLab.html">EndpointOAuthGitLab</a>
|
|
62
|
+
</li>
|
|
63
|
+
</ul>
|
|
64
|
+
<h1>Interface EndpointOAuthGitLab</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">EndpointOAuthGitLab</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.EndpointOAuthGitLab.html#clientId" class="tsd-kind-icon">client<wbr>Id</a></li>
|
|
87
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOAuthGitLab.html#clientSecret" class="tsd-kind-icon">client<wbr>Secret</a></li>
|
|
88
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOAuthGitLab.html#emailAddresses" class="tsd-kind-icon">email<wbr>Addresses</a></li>
|
|
89
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOAuthGitLab.html#emailDomains" class="tsd-kind-icon">email<wbr>Domains</a></li>
|
|
90
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointOAuthGitLab.html#scopes" class="tsd-kind-icon">scopes</a></li>
|
|
91
|
+
</ul>
|
|
92
|
+
</section>
|
|
93
|
+
</div>
|
|
94
|
+
</section>
|
|
95
|
+
</section>
|
|
96
|
+
<section class="tsd-panel-group tsd-member-group ">
|
|
97
|
+
<h2>Properties</h2>
|
|
98
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
99
|
+
<a name="clientId" class="tsd-anchor"></a>
|
|
100
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> client<wbr>Id</h3>
|
|
101
|
+
<div class="tsd-signature tsd-kind-icon">client<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
102
|
+
<aside class="tsd-sources">
|
|
103
|
+
<ul>
|
|
104
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L890">datatypes.ts:890</a></li>
|
|
105
|
+
</ul>
|
|
106
|
+
</aside>
|
|
107
|
+
</section>
|
|
108
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
109
|
+
<a name="clientSecret" class="tsd-anchor"></a>
|
|
110
|
+
<h3><span class="tsd-flag ts-flagOptional">Optional</span> client<wbr>Secret</h3>
|
|
111
|
+
<div class="tsd-signature tsd-kind-icon">client<wbr>Secret<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
|
|
112
|
+
<aside class="tsd-sources">
|
|
113
|
+
<ul>
|
|
114
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L891">datatypes.ts:891</a></li>
|
|
115
|
+
</ul>
|
|
116
|
+
</aside>
|
|
117
|
+
</section>
|
|
118
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
119
|
+
<a name="emailAddresses" class="tsd-anchor"></a>
|
|
120
|
+
<h3>email<wbr>Addresses</h3>
|
|
121
|
+
<div class="tsd-signature tsd-kind-icon">email<wbr>Addresses<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
122
|
+
<aside class="tsd-sources">
|
|
123
|
+
<ul>
|
|
124
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L893">datatypes.ts:893</a></li>
|
|
125
|
+
</ul>
|
|
126
|
+
</aside>
|
|
127
|
+
</section>
|
|
128
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
129
|
+
<a name="emailDomains" class="tsd-anchor"></a>
|
|
130
|
+
<h3>email<wbr>Domains</h3>
|
|
131
|
+
<div class="tsd-signature tsd-kind-icon">email<wbr>Domains<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
132
|
+
<aside class="tsd-sources">
|
|
133
|
+
<ul>
|
|
134
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L894">datatypes.ts:894</a></li>
|
|
135
|
+
</ul>
|
|
136
|
+
</aside>
|
|
137
|
+
</section>
|
|
138
|
+
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
|
|
139
|
+
<a name="scopes" class="tsd-anchor"></a>
|
|
140
|
+
<h3>scopes</h3>
|
|
141
|
+
<div class="tsd-signature tsd-kind-icon">scopes<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
|
|
142
|
+
<aside class="tsd-sources">
|
|
143
|
+
<ul>
|
|
144
|
+
<li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L892">datatypes.ts:892</a></li>
|
|
145
|
+
</ul>
|
|
146
|
+
</aside>
|
|
147
|
+
</section>
|
|
148
|
+
</section>
|
|
149
|
+
</div>
|
|
150
|
+
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
|
|
151
|
+
<nav class="tsd-navigation primary">
|
|
152
|
+
<ul>
|
|
153
|
+
<li class=" ">
|
|
154
|
+
<a href="../modules.html">Modules</a>
|
|
155
|
+
</li>
|
|
156
|
+
<li class=" tsd-kind-module">
|
|
157
|
+
<a href="../modules/client.html">client</a>
|
|
158
|
+
</li>
|
|
159
|
+
<li class="current tsd-kind-module">
|
|
160
|
+
<a href="../modules/datatypes.html">datatypes</a>
|
|
161
|
+
</li>
|
|
162
|
+
<li class=" tsd-kind-module">
|
|
163
|
+
<a href="../modules/services.html">services</a>
|
|
164
|
+
</li>
|
|
165
|
+
</ul>
|
|
166
|
+
</nav>
|
|
167
|
+
<nav class="tsd-navigation secondary menu-sticky">
|
|
168
|
+
<ul class="before-current">
|
|
169
|
+
</ul>
|
|
170
|
+
<ul class="current">
|
|
171
|
+
<li class="current tsd-kind-interface tsd-parent-kind-module">
|
|
172
|
+
<a href="datatypes.EndpointOAuthGitLab.html" class="tsd-kind-icon">EndpointOAuth<wbr>Git<wbr>Lab</a>
|
|
173
|
+
<ul>
|
|
174
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
175
|
+
<a href="datatypes.EndpointOAuthGitLab.html#clientId" class="tsd-kind-icon">client<wbr>Id</a>
|
|
176
|
+
</li>
|
|
177
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
178
|
+
<a href="datatypes.EndpointOAuthGitLab.html#clientSecret" class="tsd-kind-icon">client<wbr>Secret</a>
|
|
179
|
+
</li>
|
|
180
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
181
|
+
<a href="datatypes.EndpointOAuthGitLab.html#emailAddresses" class="tsd-kind-icon">email<wbr>Addresses</a>
|
|
182
|
+
</li>
|
|
183
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
184
|
+
<a href="datatypes.EndpointOAuthGitLab.html#emailDomains" class="tsd-kind-icon">email<wbr>Domains</a>
|
|
185
|
+
</li>
|
|
186
|
+
<li class=" tsd-kind-property tsd-parent-kind-interface">
|
|
187
|
+
<a href="datatypes.EndpointOAuthGitLab.html#scopes" class="tsd-kind-icon">scopes</a>
|
|
188
|
+
</li>
|
|
189
|
+
</ul>
|
|
190
|
+
</li>
|
|
191
|
+
</ul>
|
|
192
|
+
<ul class="after-current">
|
|
193
|
+
</ul>
|
|
194
|
+
</nav>
|
|
195
|
+
</div>
|
|
196
|
+
</div>
|
|
197
|
+
</div>
|
|
198
|
+
<footer class="with-border-bottom">
|
|
199
|
+
<div class="container">
|
|
200
|
+
<h2>Legend</h2>
|
|
201
|
+
<div class="tsd-legend-group">
|
|
202
|
+
<ul class="tsd-legend">
|
|
203
|
+
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
|
|
204
|
+
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
|
|
205
|
+
</ul>
|
|
206
|
+
<ul class="tsd-legend">
|
|
207
|
+
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
|
|
208
|
+
</ul>
|
|
209
|
+
</div>
|
|
210
|
+
</div>
|
|
211
|
+
</footer>
|
|
212
|
+
<div class="container tsd-generator">
|
|
213
|
+
<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
|
|
214
|
+
</div>
|
|
215
|
+
<div class="overlay"></div>
|
|
216
|
+
<script src="../assets/js/main.js"></script>
|
|
217
|
+
</body>
|
|
218
|
+
</html>
|