@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
package/src/client.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
// Code generated
|
|
1
|
+
// Code generated for API Clients. DO NOT EDIT.
|
|
2
2
|
|
|
3
3
|
import wretch, { Wretcher } from 'wretch';
|
|
4
4
|
import * as formData from 'form-data';
|
|
@@ -14,7 +14,7 @@ wretch().polyfills({
|
|
|
14
14
|
|
|
15
15
|
export interface NgrokConfig {
|
|
16
16
|
apiToken: string;
|
|
17
|
-
baseUrl
|
|
17
|
+
baseUrl?: string;
|
|
18
18
|
}
|
|
19
19
|
|
|
20
20
|
export class Ngrok {
|
|
@@ -35,6 +35,15 @@ export class Ngrok {
|
|
|
35
35
|
ngrok.com dashboard.
|
|
36
36
|
*/
|
|
37
37
|
public apiKeys: services.APIKeys;
|
|
38
|
+
public applicationSessions: services.ApplicationSessions;
|
|
39
|
+
public applicationUsers: services.ApplicationUsers;
|
|
40
|
+
/**
|
|
41
|
+
* Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
|
|
42
|
+
sessions that are running and connected to the ngrok service. Each tunnel
|
|
43
|
+
session can include one or more Tunnels.
|
|
44
|
+
*/
|
|
45
|
+
public tunnelSessions: services.TunnelSessions;
|
|
46
|
+
public botUsers: services.BotUsers;
|
|
38
47
|
/**
|
|
39
48
|
* Certificate Authorities are x509 certificates that are used to sign other
|
|
40
49
|
x509 certificates. Attach a Certificate Authority to the Mutual TLS module
|
|
@@ -46,7 +55,7 @@ export class Ngrok {
|
|
|
46
55
|
/**
|
|
47
56
|
* Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok
|
|
48
57
|
agent to connect the ngrok service as your account. They are installed with
|
|
49
|
-
the `ngrok authtoken` command or by specifying it in the `ngrok.yml`
|
|
58
|
+
the `ngrok config add-authtoken` command or by specifying it in the `ngrok.yml`
|
|
50
59
|
configuration file with the `authtoken` property.
|
|
51
60
|
*/
|
|
52
61
|
public credentials: services.Credentials;
|
|
@@ -123,12 +132,6 @@ export class Ngrok {
|
|
|
123
132
|
automated certificate provisioning.
|
|
124
133
|
*/
|
|
125
134
|
public tlsCertificates: services.TLSCertificates;
|
|
126
|
-
/**
|
|
127
|
-
* Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
|
|
128
|
-
sessions that are running and connected to the ngrok service. Each tunnel
|
|
129
|
-
session can include one or more Tunnels.
|
|
130
|
-
*/
|
|
131
|
-
public tunnelSessions: services.TunnelSessions;
|
|
132
135
|
/**
|
|
133
136
|
* Tunnels provide endpoints to access services exposed by a running ngrok
|
|
134
137
|
agent tunnel session or an SSH reverse tunnel session.
|
|
@@ -143,6 +146,11 @@ export class Ngrok {
|
|
|
143
146
|
*/
|
|
144
147
|
failoverBackends: services.FailoverBackends;
|
|
145
148
|
httpResponseBackends: services.HTTPResponseBackends;
|
|
149
|
+
/**
|
|
150
|
+
* A static backend sends traffic to a TCP address (hostname and port) that
|
|
151
|
+
is reachable on the public internet.
|
|
152
|
+
*/
|
|
153
|
+
staticBackends: services.StaticBackends;
|
|
146
154
|
/**
|
|
147
155
|
* A Tunnel Group Backend balances traffic among all online tunnels that match
|
|
148
156
|
a label selector.
|
|
@@ -176,6 +184,7 @@ export class Ngrok {
|
|
|
176
184
|
edgeRouteSamlModule: services.EdgeRouteSAMLModule;
|
|
177
185
|
edgeRouteOidcModule: services.EdgeRouteOIDCModule;
|
|
178
186
|
edgeRouteWebsocketTcpConverterModule: services.EdgeRouteWebsocketTCPConverterModule;
|
|
187
|
+
edgeRouteUserAgentFilterModule: services.EdgeRouteUserAgentFilterModule;
|
|
179
188
|
tcpEdgeBackendModule: services.TCPEdgeBackendModule;
|
|
180
189
|
tcpEdgeIpRestrictionModule: services.TCPEdgeIPRestrictionModule;
|
|
181
190
|
tlsEdgeBackendModule: services.TLSEdgeBackendModule;
|
|
@@ -204,65 +213,49 @@ export class Ngrok {
|
|
|
204
213
|
this.httpClient = wretch()
|
|
205
214
|
.url(baseUrl)
|
|
206
215
|
.headers({
|
|
207
|
-
'User-Agent': 'ngrok-
|
|
216
|
+
'User-Agent': 'ngrok-api-typescript/0.10.0/' + process.version,
|
|
208
217
|
'Ngrok-Version': '2',
|
|
209
218
|
})
|
|
210
219
|
.content('application/json')
|
|
211
220
|
.auth('Bearer ' + this.token);
|
|
212
|
-
|
|
213
221
|
this.abuseReports = new services.AbuseReports(this.httpClient);
|
|
214
|
-
|
|
215
222
|
this.agentIngresses = new services.AgentIngresses(this.httpClient);
|
|
216
|
-
|
|
217
223
|
this.apiKeys = new services.APIKeys(this.httpClient);
|
|
218
|
-
|
|
224
|
+
this.applicationSessions = new services.ApplicationSessions(
|
|
225
|
+
this.httpClient
|
|
226
|
+
);
|
|
227
|
+
this.applicationUsers = new services.ApplicationUsers(this.httpClient);
|
|
228
|
+
this.tunnelSessions = new services.TunnelSessions(this.httpClient);
|
|
229
|
+
this.botUsers = new services.BotUsers(this.httpClient);
|
|
219
230
|
this.certificateAuthorities = new services.CertificateAuthorities(
|
|
220
231
|
this.httpClient
|
|
221
232
|
);
|
|
222
|
-
|
|
223
233
|
this.credentials = new services.Credentials(this.httpClient);
|
|
224
|
-
|
|
225
234
|
this.endpoints = new services.Endpoints(this.httpClient);
|
|
226
|
-
|
|
227
235
|
this.eventDestinations = new services.EventDestinations(this.httpClient);
|
|
228
|
-
|
|
229
236
|
this.eventSubscriptions = new services.EventSubscriptions(this.httpClient);
|
|
230
|
-
|
|
231
237
|
this.eventSources = new services.EventSources(this.httpClient);
|
|
232
|
-
|
|
233
238
|
this.ipPolicies = new services.IPPolicies(this.httpClient);
|
|
234
|
-
|
|
235
239
|
this.ipPolicyRules = new services.IPPolicyRules(this.httpClient);
|
|
236
|
-
|
|
237
240
|
this.ipRestrictions = new services.IPRestrictions(this.httpClient);
|
|
238
|
-
|
|
239
241
|
this.reservedAddrs = new services.ReservedAddrs(this.httpClient);
|
|
240
|
-
|
|
241
242
|
this.reservedDomains = new services.ReservedDomains(this.httpClient);
|
|
242
|
-
|
|
243
243
|
this.sshCertificateAuthorities = new services.SSHCertificateAuthorities(
|
|
244
244
|
this.httpClient
|
|
245
245
|
);
|
|
246
|
-
|
|
247
246
|
this.sshCredentials = new services.SSHCredentials(this.httpClient);
|
|
248
|
-
|
|
249
247
|
this.sshHostCertificates = new services.SSHHostCertificates(
|
|
250
248
|
this.httpClient
|
|
251
249
|
);
|
|
252
|
-
|
|
253
250
|
this.sshUserCertificates = new services.SSHUserCertificates(
|
|
254
251
|
this.httpClient
|
|
255
252
|
);
|
|
256
|
-
|
|
257
253
|
this.tlsCertificates = new services.TLSCertificates(this.httpClient);
|
|
258
|
-
|
|
259
|
-
this.tunnelSessions = new services.TunnelSessions(this.httpClient);
|
|
260
|
-
|
|
261
254
|
this.tunnels = new services.Tunnels(this.httpClient);
|
|
262
|
-
|
|
263
255
|
this.backends = {
|
|
264
256
|
failoverBackends: new services.FailoverBackends(this.httpClient),
|
|
265
257
|
httpResponseBackends: new services.HTTPResponseBackends(this.httpClient),
|
|
258
|
+
staticBackends: new services.StaticBackends(this.httpClient),
|
|
266
259
|
tunnelGroupBackends: new services.TunnelGroupBackends(this.httpClient),
|
|
267
260
|
weightedBackends: new services.WeightedBackends(this.httpClient),
|
|
268
261
|
};
|
|
@@ -303,6 +296,8 @@ export class Ngrok {
|
|
|
303
296
|
edgeRouteOidcModule: new services.EdgeRouteOIDCModule(this.httpClient),
|
|
304
297
|
edgeRouteWebsocketTcpConverterModule:
|
|
305
298
|
new services.EdgeRouteWebsocketTCPConverterModule(this.httpClient),
|
|
299
|
+
edgeRouteUserAgentFilterModule:
|
|
300
|
+
new services.EdgeRouteUserAgentFilterModule(this.httpClient),
|
|
306
301
|
tcpEdgeBackendModule: new services.TCPEdgeBackendModule(this.httpClient),
|
|
307
302
|
tcpEdgeIpRestrictionModule: new services.TCPEdgeIPRestrictionModule(
|
|
308
303
|
this.httpClient
|