@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/lib/services.d.ts
CHANGED
|
@@ -15,7 +15,7 @@ export declare class AbuseReports {
|
|
|
15
15
|
/**
|
|
16
16
|
* Get the detailed status of abuse report by ID.
|
|
17
17
|
*/
|
|
18
|
-
get(
|
|
18
|
+
get(id: any): Promise<datatypes.AbuseReport>;
|
|
19
19
|
}
|
|
20
20
|
export declare class AgentIngresses {
|
|
21
21
|
private httpClient;
|
|
@@ -28,15 +28,15 @@ export declare class AgentIngresses {
|
|
|
28
28
|
/**
|
|
29
29
|
* Delete an Agent Ingress by ID
|
|
30
30
|
*/
|
|
31
|
-
delete(
|
|
31
|
+
delete(id: any): Promise<void>;
|
|
32
32
|
/**
|
|
33
33
|
* Get the details of an Agent Ingress by ID.
|
|
34
34
|
*/
|
|
35
|
-
get(
|
|
35
|
+
get(id: any): Promise<datatypes.AgentIngress>;
|
|
36
36
|
/**
|
|
37
37
|
* List all Agent Ingresses owned by this account
|
|
38
38
|
*/
|
|
39
|
-
list(): Promise<Array<datatypes.AgentIngress>>;
|
|
39
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.AgentIngress>>;
|
|
40
40
|
private _pagedList;
|
|
41
41
|
private _asyncList;
|
|
42
42
|
/**
|
|
@@ -62,15 +62,15 @@ export declare class APIKeys {
|
|
|
62
62
|
/**
|
|
63
63
|
* Delete an API key by ID
|
|
64
64
|
*/
|
|
65
|
-
delete(
|
|
65
|
+
delete(id: any): Promise<void>;
|
|
66
66
|
/**
|
|
67
67
|
* Get the details of an API key by ID.
|
|
68
68
|
*/
|
|
69
|
-
get(
|
|
69
|
+
get(id: any): Promise<datatypes.APIKey>;
|
|
70
70
|
/**
|
|
71
71
|
* List all API keys owned by this account
|
|
72
72
|
*/
|
|
73
|
-
list(): Promise<Array<datatypes.APIKey>>;
|
|
73
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.APIKey>>;
|
|
74
74
|
private _pagedList;
|
|
75
75
|
private _asyncList;
|
|
76
76
|
/**
|
|
@@ -78,6 +78,76 @@ export declare class APIKeys {
|
|
|
78
78
|
*/
|
|
79
79
|
update(arg: datatypes.APIKeyUpdate): Promise<datatypes.APIKey>;
|
|
80
80
|
}
|
|
81
|
+
export declare class ApplicationSessions {
|
|
82
|
+
private httpClient;
|
|
83
|
+
/** Do not construct this object directly, use the <code>applicationSessions</code> property of an <code>Ngrok</code> client object instead. */
|
|
84
|
+
constructor(httpClient: Wretcher);
|
|
85
|
+
/**
|
|
86
|
+
* Get an application session by ID.
|
|
87
|
+
*/
|
|
88
|
+
get(id: any): Promise<datatypes.ApplicationSession>;
|
|
89
|
+
/**
|
|
90
|
+
* Delete an application session by ID.
|
|
91
|
+
*/
|
|
92
|
+
delete(id: any): Promise<void>;
|
|
93
|
+
/**
|
|
94
|
+
* List all application sessions for this account.
|
|
95
|
+
*/
|
|
96
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.ApplicationSession>>;
|
|
97
|
+
private _pagedList;
|
|
98
|
+
private _asyncList;
|
|
99
|
+
}
|
|
100
|
+
export declare class ApplicationUsers {
|
|
101
|
+
private httpClient;
|
|
102
|
+
/** Do not construct this object directly, use the <code>applicationUsers</code> property of an <code>Ngrok</code> client object instead. */
|
|
103
|
+
constructor(httpClient: Wretcher);
|
|
104
|
+
/**
|
|
105
|
+
* Get an application user by ID.
|
|
106
|
+
*/
|
|
107
|
+
get(id: any): Promise<datatypes.ApplicationUser>;
|
|
108
|
+
/**
|
|
109
|
+
* Delete an application user by ID.
|
|
110
|
+
*/
|
|
111
|
+
delete(id: any): Promise<void>;
|
|
112
|
+
/**
|
|
113
|
+
* List all application users for this account.
|
|
114
|
+
*/
|
|
115
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.ApplicationUser>>;
|
|
116
|
+
private _pagedList;
|
|
117
|
+
private _asyncList;
|
|
118
|
+
}
|
|
119
|
+
/**
|
|
120
|
+
* Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
|
|
121
|
+
sessions that are running and connected to the ngrok service. Each tunnel
|
|
122
|
+
session can include one or more Tunnels.
|
|
123
|
+
*/
|
|
124
|
+
export declare class TunnelSessions {
|
|
125
|
+
private httpClient;
|
|
126
|
+
/** Do not construct this object directly, use the <code>tunnelSessions</code> property of an <code>Ngrok</code> client object instead. */
|
|
127
|
+
constructor(httpClient: Wretcher);
|
|
128
|
+
/**
|
|
129
|
+
* List all online tunnel sessions running on this account.
|
|
130
|
+
*/
|
|
131
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.TunnelSession>>;
|
|
132
|
+
private _pagedList;
|
|
133
|
+
private _asyncList;
|
|
134
|
+
/**
|
|
135
|
+
* Get the detailed status of a tunnel session by ID
|
|
136
|
+
*/
|
|
137
|
+
get(id: any): Promise<datatypes.TunnelSession>;
|
|
138
|
+
/**
|
|
139
|
+
* Issues a command instructing the ngrok agent to restart. The agent restarts itself by calling exec() on platforms that support it. This operation is notably not supported on Windows. When an agent restarts, it reconnects with a new tunnel session ID.
|
|
140
|
+
*/
|
|
141
|
+
restart(id: any): Promise<void>;
|
|
142
|
+
/**
|
|
143
|
+
* Issues a command instructing the ngrok agent that started this tunnel session to exit.
|
|
144
|
+
*/
|
|
145
|
+
stop(id: any): Promise<void>;
|
|
146
|
+
/**
|
|
147
|
+
* Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent's configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted
|
|
148
|
+
*/
|
|
149
|
+
update(arg: datatypes.TunnelSessionsUpdate): Promise<void>;
|
|
150
|
+
}
|
|
81
151
|
/**
|
|
82
152
|
* A Failover backend defines failover behavior within a list of referenced
|
|
83
153
|
backends. Traffic is sent to the first backend in the list. If that backend
|
|
@@ -95,15 +165,15 @@ export declare class FailoverBackends {
|
|
|
95
165
|
/**
|
|
96
166
|
* Delete a Failover backend by ID.
|
|
97
167
|
*/
|
|
98
|
-
delete(
|
|
168
|
+
delete(id: any): Promise<void>;
|
|
99
169
|
/**
|
|
100
170
|
* Get detailed information about a Failover backend by ID
|
|
101
171
|
*/
|
|
102
|
-
get(
|
|
172
|
+
get(id: any): Promise<datatypes.FailoverBackend>;
|
|
103
173
|
/**
|
|
104
174
|
* List all Failover backends on this account
|
|
105
175
|
*/
|
|
106
|
-
list(): Promise<Array<datatypes.FailoverBackend>>;
|
|
176
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.FailoverBackend>>;
|
|
107
177
|
private _pagedList;
|
|
108
178
|
private _asyncList;
|
|
109
179
|
/**
|
|
@@ -116,13 +186,44 @@ export declare class HTTPResponseBackends {
|
|
|
116
186
|
/** Do not construct this object directly, use the <code>httpResponseBackends</code> property of an <code>Ngrok</code> client object instead. */
|
|
117
187
|
constructor(httpClient: Wretcher);
|
|
118
188
|
create(arg: datatypes.HTTPResponseBackendCreate): Promise<datatypes.HTTPResponseBackend>;
|
|
119
|
-
delete(
|
|
120
|
-
get(
|
|
121
|
-
list(): Promise<Array<datatypes.HTTPResponseBackend>>;
|
|
189
|
+
delete(id: any): Promise<void>;
|
|
190
|
+
get(id: any): Promise<datatypes.HTTPResponseBackend>;
|
|
191
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.HTTPResponseBackend>>;
|
|
122
192
|
private _pagedList;
|
|
123
193
|
private _asyncList;
|
|
124
194
|
update(arg: datatypes.HTTPResponseBackendUpdate): Promise<datatypes.HTTPResponseBackend>;
|
|
125
195
|
}
|
|
196
|
+
/**
|
|
197
|
+
* A static backend sends traffic to a TCP address (hostname and port) that
|
|
198
|
+
is reachable on the public internet.
|
|
199
|
+
*/
|
|
200
|
+
export declare class StaticBackends {
|
|
201
|
+
private httpClient;
|
|
202
|
+
/** Do not construct this object directly, use the <code>staticBackends</code> property of an <code>Ngrok</code> client object instead. */
|
|
203
|
+
constructor(httpClient: Wretcher);
|
|
204
|
+
/**
|
|
205
|
+
* Create a new static backend
|
|
206
|
+
*/
|
|
207
|
+
create(arg: datatypes.StaticBackendCreate): Promise<datatypes.StaticBackend>;
|
|
208
|
+
/**
|
|
209
|
+
* Delete a static backend by ID.
|
|
210
|
+
*/
|
|
211
|
+
delete(id: any): Promise<void>;
|
|
212
|
+
/**
|
|
213
|
+
* Get detailed information about a static backend by ID
|
|
214
|
+
*/
|
|
215
|
+
get(id: any): Promise<datatypes.StaticBackend>;
|
|
216
|
+
/**
|
|
217
|
+
* List all static backends on this account
|
|
218
|
+
*/
|
|
219
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.StaticBackend>>;
|
|
220
|
+
private _pagedList;
|
|
221
|
+
private _asyncList;
|
|
222
|
+
/**
|
|
223
|
+
* Update static backend by ID
|
|
224
|
+
*/
|
|
225
|
+
update(arg: datatypes.StaticBackendUpdate): Promise<datatypes.StaticBackend>;
|
|
226
|
+
}
|
|
126
227
|
/**
|
|
127
228
|
* A Tunnel Group Backend balances traffic among all online tunnels that match
|
|
128
229
|
a label selector.
|
|
@@ -138,15 +239,15 @@ export declare class TunnelGroupBackends {
|
|
|
138
239
|
/**
|
|
139
240
|
* Delete a TunnelGroup backend by ID.
|
|
140
241
|
*/
|
|
141
|
-
delete(
|
|
242
|
+
delete(id: any): Promise<void>;
|
|
142
243
|
/**
|
|
143
244
|
* Get detailed information about a TunnelGroup backend by ID
|
|
144
245
|
*/
|
|
145
|
-
get(
|
|
246
|
+
get(id: any): Promise<datatypes.TunnelGroupBackend>;
|
|
146
247
|
/**
|
|
147
248
|
* List all TunnelGroup backends on this account
|
|
148
249
|
*/
|
|
149
|
-
list(): Promise<Array<datatypes.TunnelGroupBackend>>;
|
|
250
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.TunnelGroupBackend>>;
|
|
150
251
|
private _pagedList;
|
|
151
252
|
private _asyncList;
|
|
152
253
|
/**
|
|
@@ -171,15 +272,15 @@ export declare class WeightedBackends {
|
|
|
171
272
|
/**
|
|
172
273
|
* Delete a Weighted backend by ID.
|
|
173
274
|
*/
|
|
174
|
-
delete(
|
|
275
|
+
delete(id: any): Promise<void>;
|
|
175
276
|
/**
|
|
176
277
|
* Get detailed information about a Weighted backend by ID
|
|
177
278
|
*/
|
|
178
|
-
get(
|
|
279
|
+
get(id: any): Promise<datatypes.WeightedBackend>;
|
|
179
280
|
/**
|
|
180
281
|
* List all Weighted backends on this account
|
|
181
282
|
*/
|
|
182
|
-
list(): Promise<Array<datatypes.WeightedBackend>>;
|
|
283
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.WeightedBackend>>;
|
|
183
284
|
private _pagedList;
|
|
184
285
|
private _asyncList;
|
|
185
286
|
/**
|
|
@@ -187,6 +288,33 @@ export declare class WeightedBackends {
|
|
|
187
288
|
*/
|
|
188
289
|
update(arg: datatypes.WeightedBackendUpdate): Promise<datatypes.WeightedBackend>;
|
|
189
290
|
}
|
|
291
|
+
export declare class BotUsers {
|
|
292
|
+
private httpClient;
|
|
293
|
+
/** Do not construct this object directly, use the <code>botUsers</code> property of an <code>Ngrok</code> client object instead. */
|
|
294
|
+
constructor(httpClient: Wretcher);
|
|
295
|
+
/**
|
|
296
|
+
* Create a new bot user
|
|
297
|
+
*/
|
|
298
|
+
create(arg: datatypes.BotUserCreate): Promise<datatypes.BotUser>;
|
|
299
|
+
/**
|
|
300
|
+
* Delete a bot user by ID
|
|
301
|
+
*/
|
|
302
|
+
delete(id: any): Promise<void>;
|
|
303
|
+
/**
|
|
304
|
+
* Get the details of a Bot User by ID.
|
|
305
|
+
*/
|
|
306
|
+
get(id: any): Promise<datatypes.BotUser>;
|
|
307
|
+
/**
|
|
308
|
+
* List all bot users in this account.
|
|
309
|
+
*/
|
|
310
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.BotUser>>;
|
|
311
|
+
private _pagedList;
|
|
312
|
+
private _asyncList;
|
|
313
|
+
/**
|
|
314
|
+
* Update attributes of a bot user by ID.
|
|
315
|
+
*/
|
|
316
|
+
update(arg: datatypes.BotUserUpdate): Promise<datatypes.BotUser>;
|
|
317
|
+
}
|
|
190
318
|
/**
|
|
191
319
|
* Certificate Authorities are x509 certificates that are used to sign other
|
|
192
320
|
x509 certificates. Attach a Certificate Authority to the Mutual TLS module
|
|
@@ -205,15 +333,15 @@ export declare class CertificateAuthorities {
|
|
|
205
333
|
/**
|
|
206
334
|
* Delete a Certificate Authority
|
|
207
335
|
*/
|
|
208
|
-
delete(
|
|
336
|
+
delete(id: any): Promise<void>;
|
|
209
337
|
/**
|
|
210
338
|
* Get detailed information about a certficate authority
|
|
211
339
|
*/
|
|
212
|
-
get(
|
|
340
|
+
get(id: any): Promise<datatypes.CertificateAuthority>;
|
|
213
341
|
/**
|
|
214
342
|
* List all Certificate Authority on this account
|
|
215
343
|
*/
|
|
216
|
-
list(): Promise<Array<datatypes.CertificateAuthority>>;
|
|
344
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.CertificateAuthority>>;
|
|
217
345
|
private _pagedList;
|
|
218
346
|
private _asyncList;
|
|
219
347
|
/**
|
|
@@ -224,7 +352,7 @@ export declare class CertificateAuthorities {
|
|
|
224
352
|
/**
|
|
225
353
|
* Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok
|
|
226
354
|
agent to connect the ngrok service as your account. They are installed with
|
|
227
|
-
the `ngrok authtoken` command or by specifying it in the `ngrok.yml`
|
|
355
|
+
the `ngrok config add-authtoken` command or by specifying it in the `ngrok.yml`
|
|
228
356
|
configuration file with the `authtoken` property.
|
|
229
357
|
*/
|
|
230
358
|
export declare class Credentials {
|
|
@@ -238,15 +366,15 @@ export declare class Credentials {
|
|
|
238
366
|
/**
|
|
239
367
|
* Delete a tunnel authtoken credential by ID
|
|
240
368
|
*/
|
|
241
|
-
delete(
|
|
369
|
+
delete(id: any): Promise<void>;
|
|
242
370
|
/**
|
|
243
371
|
* Get detailed information about a tunnel authtoken credential
|
|
244
372
|
*/
|
|
245
|
-
get(
|
|
373
|
+
get(id: any): Promise<datatypes.Credential>;
|
|
246
374
|
/**
|
|
247
375
|
* List all tunnel authtoken credentials on this account
|
|
248
376
|
*/
|
|
249
|
-
list(): Promise<Array<datatypes.Credential>>;
|
|
377
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.Credential>>;
|
|
250
378
|
private _pagedList;
|
|
251
379
|
private _asyncList;
|
|
252
380
|
/**
|
|
@@ -286,11 +414,11 @@ export declare class EdgesHTTPS {
|
|
|
286
414
|
/**
|
|
287
415
|
* Get an HTTPS Edge by ID
|
|
288
416
|
*/
|
|
289
|
-
get(
|
|
417
|
+
get(id: any): Promise<datatypes.HTTPSEdge>;
|
|
290
418
|
/**
|
|
291
419
|
* Returns a list of all HTTPS Edges on this account
|
|
292
420
|
*/
|
|
293
|
-
list(): Promise<Array<datatypes.HTTPSEdge>>;
|
|
421
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.HTTPSEdge>>;
|
|
294
422
|
private _pagedList;
|
|
295
423
|
private _asyncList;
|
|
296
424
|
/**
|
|
@@ -300,23 +428,23 @@ export declare class EdgesHTTPS {
|
|
|
300
428
|
/**
|
|
301
429
|
* Delete an HTTPS Edge by ID
|
|
302
430
|
*/
|
|
303
|
-
delete(
|
|
431
|
+
delete(id: any): Promise<void>;
|
|
304
432
|
}
|
|
305
433
|
export declare class HTTPSEdgeMutualTLSModule {
|
|
306
434
|
private httpClient;
|
|
307
435
|
/** Do not construct this object directly, use the <code>httpsEdgeMutualTlsModule</code> property of an <code>Ngrok</code> client object instead. */
|
|
308
436
|
constructor(httpClient: Wretcher);
|
|
309
437
|
replace(arg: datatypes.EdgeMutualTLSReplace): Promise<datatypes.EndpointMutualTLS>;
|
|
310
|
-
get(
|
|
311
|
-
delete(
|
|
438
|
+
get(id: any): Promise<datatypes.EndpointMutualTLS>;
|
|
439
|
+
delete(id: any): Promise<void>;
|
|
312
440
|
}
|
|
313
441
|
export declare class HTTPSEdgeTLSTerminationModule {
|
|
314
442
|
private httpClient;
|
|
315
443
|
/** Do not construct this object directly, use the <code>httpsEdgeTlsTerminationModule</code> property of an <code>Ngrok</code> client object instead. */
|
|
316
444
|
constructor(httpClient: Wretcher);
|
|
317
445
|
replace(arg: datatypes.EdgeTLSTerminationAtEdgeReplace): Promise<datatypes.EndpointTLSTermination>;
|
|
318
|
-
get(
|
|
319
|
-
delete(
|
|
446
|
+
get(id: any): Promise<datatypes.EndpointTLSTermination>;
|
|
447
|
+
delete(id: any): Promise<void>;
|
|
320
448
|
}
|
|
321
449
|
export declare class EdgeRouteBackendModule {
|
|
322
450
|
private httpClient;
|
|
@@ -406,6 +534,22 @@ export declare class EdgeRouteWebsocketTCPConverterModule {
|
|
|
406
534
|
get(arg: datatypes.EdgeRouteItem): Promise<datatypes.EndpointWebsocketTCPConverter>;
|
|
407
535
|
delete(arg: datatypes.EdgeRouteItem): Promise<void>;
|
|
408
536
|
}
|
|
537
|
+
export declare class EdgeRouteUserAgentFilterModule {
|
|
538
|
+
private httpClient;
|
|
539
|
+
/** Do not construct this object directly, use the <code>edgeRouteUserAgentFilterModule</code> property of an <code>Ngrok</code> client object instead. */
|
|
540
|
+
constructor(httpClient: Wretcher);
|
|
541
|
+
replace(arg: datatypes.EdgeRouteUserAgentFilterReplace): Promise<datatypes.EndpointUserAgentFilter>;
|
|
542
|
+
get(arg: datatypes.EdgeRouteItem): Promise<datatypes.EndpointUserAgentFilter>;
|
|
543
|
+
delete(arg: datatypes.EdgeRouteItem): Promise<void>;
|
|
544
|
+
}
|
|
545
|
+
export declare class EdgeRoutePolicyModule {
|
|
546
|
+
private httpClient;
|
|
547
|
+
/** Do not construct this object directly, use the <code>edgeRoutePolicyModule</code> property of an <code>Ngrok</code> client object instead. */
|
|
548
|
+
constructor(httpClient: Wretcher);
|
|
549
|
+
replace(arg: datatypes.EdgeRoutePolicyReplace): Promise<datatypes.EndpointPolicy>;
|
|
550
|
+
get(arg: datatypes.EdgeRouteItem): Promise<datatypes.EndpointPolicy>;
|
|
551
|
+
delete(arg: datatypes.EdgeRouteItem): Promise<void>;
|
|
552
|
+
}
|
|
409
553
|
export declare class EdgesTCP {
|
|
410
554
|
private httpClient;
|
|
411
555
|
/** Do not construct this object directly, use the <code>edgesTcp</code> property of an <code>Ngrok</code> client object instead. */
|
|
@@ -417,11 +561,11 @@ export declare class EdgesTCP {
|
|
|
417
561
|
/**
|
|
418
562
|
* Get a TCP Edge by ID
|
|
419
563
|
*/
|
|
420
|
-
get(
|
|
564
|
+
get(id: any): Promise<datatypes.TCPEdge>;
|
|
421
565
|
/**
|
|
422
566
|
* Returns a list of all TCP Edges on this account
|
|
423
567
|
*/
|
|
424
|
-
list(): Promise<Array<datatypes.TCPEdge>>;
|
|
568
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.TCPEdge>>;
|
|
425
569
|
private _pagedList;
|
|
426
570
|
private _asyncList;
|
|
427
571
|
/**
|
|
@@ -431,23 +575,31 @@ export declare class EdgesTCP {
|
|
|
431
575
|
/**
|
|
432
576
|
* Delete a TCP Edge by ID
|
|
433
577
|
*/
|
|
434
|
-
delete(
|
|
578
|
+
delete(id: any): Promise<void>;
|
|
435
579
|
}
|
|
436
580
|
export declare class TCPEdgeBackendModule {
|
|
437
581
|
private httpClient;
|
|
438
582
|
/** Do not construct this object directly, use the <code>tcpEdgeBackendModule</code> property of an <code>Ngrok</code> client object instead. */
|
|
439
583
|
constructor(httpClient: Wretcher);
|
|
440
584
|
replace(arg: datatypes.EdgeBackendReplace): Promise<datatypes.EndpointBackend>;
|
|
441
|
-
get(
|
|
442
|
-
delete(
|
|
585
|
+
get(id: any): Promise<datatypes.EndpointBackend>;
|
|
586
|
+
delete(id: any): Promise<void>;
|
|
443
587
|
}
|
|
444
588
|
export declare class TCPEdgeIPRestrictionModule {
|
|
445
589
|
private httpClient;
|
|
446
590
|
/** Do not construct this object directly, use the <code>tcpEdgeIpRestrictionModule</code> property of an <code>Ngrok</code> client object instead. */
|
|
447
591
|
constructor(httpClient: Wretcher);
|
|
448
592
|
replace(arg: datatypes.EdgeIPRestrictionReplace): Promise<datatypes.EndpointIPPolicy>;
|
|
449
|
-
get(
|
|
450
|
-
delete(
|
|
593
|
+
get(id: any): Promise<datatypes.EndpointIPPolicy>;
|
|
594
|
+
delete(id: any): Promise<void>;
|
|
595
|
+
}
|
|
596
|
+
export declare class TCPEdgePolicyModule {
|
|
597
|
+
private httpClient;
|
|
598
|
+
/** Do not construct this object directly, use the <code>tcpEdgePolicyModule</code> property of an <code>Ngrok</code> client object instead. */
|
|
599
|
+
constructor(httpClient: Wretcher);
|
|
600
|
+
replace(arg: datatypes.EdgePolicyReplace): Promise<datatypes.EndpointPolicy>;
|
|
601
|
+
get(id: any): Promise<datatypes.EndpointPolicy>;
|
|
602
|
+
delete(id: any): Promise<void>;
|
|
451
603
|
}
|
|
452
604
|
export declare class EdgesTLS {
|
|
453
605
|
private httpClient;
|
|
@@ -460,11 +612,11 @@ export declare class EdgesTLS {
|
|
|
460
612
|
/**
|
|
461
613
|
* Get a TLS Edge by ID
|
|
462
614
|
*/
|
|
463
|
-
get(
|
|
615
|
+
get(id: any): Promise<datatypes.TLSEdge>;
|
|
464
616
|
/**
|
|
465
617
|
* Returns a list of all TLS Edges on this account
|
|
466
618
|
*/
|
|
467
|
-
list(): Promise<Array<datatypes.TLSEdge>>;
|
|
619
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.TLSEdge>>;
|
|
468
620
|
private _pagedList;
|
|
469
621
|
private _asyncList;
|
|
470
622
|
/**
|
|
@@ -474,39 +626,47 @@ export declare class EdgesTLS {
|
|
|
474
626
|
/**
|
|
475
627
|
* Delete a TLS Edge by ID
|
|
476
628
|
*/
|
|
477
|
-
delete(
|
|
629
|
+
delete(id: any): Promise<void>;
|
|
478
630
|
}
|
|
479
631
|
export declare class TLSEdgeBackendModule {
|
|
480
632
|
private httpClient;
|
|
481
633
|
/** Do not construct this object directly, use the <code>tlsEdgeBackendModule</code> property of an <code>Ngrok</code> client object instead. */
|
|
482
634
|
constructor(httpClient: Wretcher);
|
|
483
635
|
replace(arg: datatypes.EdgeBackendReplace): Promise<datatypes.EndpointBackend>;
|
|
484
|
-
get(
|
|
485
|
-
delete(
|
|
636
|
+
get(id: any): Promise<datatypes.EndpointBackend>;
|
|
637
|
+
delete(id: any): Promise<void>;
|
|
486
638
|
}
|
|
487
639
|
export declare class TLSEdgeIPRestrictionModule {
|
|
488
640
|
private httpClient;
|
|
489
641
|
/** Do not construct this object directly, use the <code>tlsEdgeIpRestrictionModule</code> property of an <code>Ngrok</code> client object instead. */
|
|
490
642
|
constructor(httpClient: Wretcher);
|
|
491
643
|
replace(arg: datatypes.EdgeIPRestrictionReplace): Promise<datatypes.EndpointIPPolicy>;
|
|
492
|
-
get(
|
|
493
|
-
delete(
|
|
644
|
+
get(id: any): Promise<datatypes.EndpointIPPolicy>;
|
|
645
|
+
delete(id: any): Promise<void>;
|
|
494
646
|
}
|
|
495
647
|
export declare class TLSEdgeMutualTLSModule {
|
|
496
648
|
private httpClient;
|
|
497
649
|
/** Do not construct this object directly, use the <code>tlsEdgeMutualTlsModule</code> property of an <code>Ngrok</code> client object instead. */
|
|
498
650
|
constructor(httpClient: Wretcher);
|
|
499
651
|
replace(arg: datatypes.EdgeMutualTLSReplace): Promise<datatypes.EndpointMutualTLS>;
|
|
500
|
-
get(
|
|
501
|
-
delete(
|
|
652
|
+
get(id: any): Promise<datatypes.EndpointMutualTLS>;
|
|
653
|
+
delete(id: any): Promise<void>;
|
|
502
654
|
}
|
|
503
655
|
export declare class TLSEdgeTLSTerminationModule {
|
|
504
656
|
private httpClient;
|
|
505
657
|
/** Do not construct this object directly, use the <code>tlsEdgeTlsTerminationModule</code> property of an <code>Ngrok</code> client object instead. */
|
|
506
658
|
constructor(httpClient: Wretcher);
|
|
507
659
|
replace(arg: datatypes.EdgeTLSTerminationReplace): Promise<datatypes.EndpointTLSTermination>;
|
|
508
|
-
get(
|
|
509
|
-
delete(
|
|
660
|
+
get(id: any): Promise<datatypes.EndpointTLSTermination>;
|
|
661
|
+
delete(id: any): Promise<void>;
|
|
662
|
+
}
|
|
663
|
+
export declare class TLSEdgePolicyModule {
|
|
664
|
+
private httpClient;
|
|
665
|
+
/** Do not construct this object directly, use the <code>tlsEdgePolicyModule</code> property of an <code>Ngrok</code> client object instead. */
|
|
666
|
+
constructor(httpClient: Wretcher);
|
|
667
|
+
replace(arg: datatypes.EdgePolicyReplace): Promise<datatypes.EndpointPolicy>;
|
|
668
|
+
get(id: any): Promise<datatypes.EndpointPolicy>;
|
|
669
|
+
delete(id: any): Promise<void>;
|
|
510
670
|
}
|
|
511
671
|
/**
|
|
512
672
|
* Endpoints provides an API for querying the endpoint objects
|
|
@@ -520,34 +680,34 @@ export declare class Endpoints {
|
|
|
520
680
|
/**
|
|
521
681
|
* List all active endpoints on the account
|
|
522
682
|
*/
|
|
523
|
-
list(): Promise<Array<datatypes.Endpoint>>;
|
|
683
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.Endpoint>>;
|
|
524
684
|
private _pagedList;
|
|
525
685
|
private _asyncList;
|
|
526
686
|
/**
|
|
527
687
|
* Get the status of an endpoint by ID
|
|
528
688
|
*/
|
|
529
|
-
get(
|
|
689
|
+
get(id: any): Promise<datatypes.Endpoint>;
|
|
530
690
|
}
|
|
531
691
|
export declare class EventDestinations {
|
|
532
692
|
private httpClient;
|
|
533
693
|
/** Do not construct this object directly, use the <code>eventDestinations</code> property of an <code>Ngrok</code> client object instead. */
|
|
534
694
|
constructor(httpClient: Wretcher);
|
|
535
695
|
/**
|
|
536
|
-
* Create a new Event Destination. It will not apply to anything until it is associated with an Event
|
|
696
|
+
* Create a new Event Destination. It will not apply to anything until it is associated with an Event Subscription.
|
|
537
697
|
*/
|
|
538
698
|
create(arg: datatypes.EventDestinationCreate): Promise<datatypes.EventDestination>;
|
|
539
699
|
/**
|
|
540
700
|
* Delete an Event Destination. If the Event Destination is still referenced by an Event Subscription.
|
|
541
701
|
*/
|
|
542
|
-
delete(
|
|
702
|
+
delete(id: any): Promise<void>;
|
|
543
703
|
/**
|
|
544
704
|
* Get detailed information about an Event Destination by ID.
|
|
545
705
|
*/
|
|
546
|
-
get(
|
|
706
|
+
get(id: any): Promise<datatypes.EventDestination>;
|
|
547
707
|
/**
|
|
548
708
|
* List all Event Destinations on this account.
|
|
549
709
|
*/
|
|
550
|
-
list(): Promise<Array<datatypes.EventDestination>>;
|
|
710
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.EventDestination>>;
|
|
551
711
|
private _pagedList;
|
|
552
712
|
private _asyncList;
|
|
553
713
|
/**
|
|
@@ -566,15 +726,15 @@ export declare class EventSubscriptions {
|
|
|
566
726
|
/**
|
|
567
727
|
* Delete an Event Subscription.
|
|
568
728
|
*/
|
|
569
|
-
delete(
|
|
729
|
+
delete(id: any): Promise<void>;
|
|
570
730
|
/**
|
|
571
731
|
* Get an Event Subscription by ID.
|
|
572
732
|
*/
|
|
573
|
-
get(
|
|
733
|
+
get(id: any): Promise<datatypes.EventSubscription>;
|
|
574
734
|
/**
|
|
575
735
|
* List this Account's Event Subscriptions.
|
|
576
736
|
*/
|
|
577
|
-
list(): Promise<Array<datatypes.EventSubscription>>;
|
|
737
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.EventSubscription>>;
|
|
578
738
|
private _pagedList;
|
|
579
739
|
private _asyncList;
|
|
580
740
|
/**
|
|
@@ -624,15 +784,15 @@ export declare class IPPolicies {
|
|
|
624
784
|
/**
|
|
625
785
|
* Delete an IP policy. If the IP policy is referenced by another object for the purposes of traffic restriction it will be treated as if the IP policy remains but has zero rules.
|
|
626
786
|
*/
|
|
627
|
-
delete(
|
|
787
|
+
delete(id: any): Promise<void>;
|
|
628
788
|
/**
|
|
629
789
|
* Get detailed information about an IP policy by ID.
|
|
630
790
|
*/
|
|
631
|
-
get(
|
|
791
|
+
get(id: any): Promise<datatypes.IPPolicy>;
|
|
632
792
|
/**
|
|
633
793
|
* List all IP policies on this account
|
|
634
794
|
*/
|
|
635
|
-
list(): Promise<Array<datatypes.IPPolicy>>;
|
|
795
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.IPPolicy>>;
|
|
636
796
|
private _pagedList;
|
|
637
797
|
private _asyncList;
|
|
638
798
|
/**
|
|
@@ -655,15 +815,15 @@ export declare class IPPolicyRules {
|
|
|
655
815
|
/**
|
|
656
816
|
* Delete an IP policy rule.
|
|
657
817
|
*/
|
|
658
|
-
delete(
|
|
818
|
+
delete(id: any): Promise<void>;
|
|
659
819
|
/**
|
|
660
820
|
* Get detailed information about an IP policy rule by ID.
|
|
661
821
|
*/
|
|
662
|
-
get(
|
|
822
|
+
get(id: any): Promise<datatypes.IPPolicyRule>;
|
|
663
823
|
/**
|
|
664
824
|
* List all IP policy rules on this account
|
|
665
825
|
*/
|
|
666
|
-
list(): Promise<Array<datatypes.IPPolicyRule>>;
|
|
826
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.IPPolicyRule>>;
|
|
667
827
|
private _pagedList;
|
|
668
828
|
private _asyncList;
|
|
669
829
|
/**
|
|
@@ -690,15 +850,15 @@ export declare class IPRestrictions {
|
|
|
690
850
|
/**
|
|
691
851
|
* Delete an IP restriction
|
|
692
852
|
*/
|
|
693
|
-
delete(
|
|
853
|
+
delete(id: any): Promise<void>;
|
|
694
854
|
/**
|
|
695
855
|
* Get detailed information about an IP restriction
|
|
696
856
|
*/
|
|
697
|
-
get(
|
|
857
|
+
get(id: any): Promise<datatypes.IPRestriction>;
|
|
698
858
|
/**
|
|
699
859
|
* List all IP restrictions on this account
|
|
700
860
|
*/
|
|
701
|
-
list(): Promise<Array<datatypes.IPRestriction>>;
|
|
861
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.IPRestriction>>;
|
|
702
862
|
private _pagedList;
|
|
703
863
|
private _asyncList;
|
|
704
864
|
/**
|
|
@@ -722,15 +882,15 @@ export declare class ReservedAddrs {
|
|
|
722
882
|
/**
|
|
723
883
|
* Delete a reserved address.
|
|
724
884
|
*/
|
|
725
|
-
delete(
|
|
885
|
+
delete(id: any): Promise<void>;
|
|
726
886
|
/**
|
|
727
887
|
* Get the details of a reserved address.
|
|
728
888
|
*/
|
|
729
|
-
get(
|
|
889
|
+
get(id: any): Promise<datatypes.ReservedAddr>;
|
|
730
890
|
/**
|
|
731
891
|
* List all reserved addresses on this account.
|
|
732
892
|
*/
|
|
733
|
-
list(): Promise<Array<datatypes.ReservedAddr>>;
|
|
893
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.ReservedAddr>>;
|
|
734
894
|
private _pagedList;
|
|
735
895
|
private _asyncList;
|
|
736
896
|
/**
|
|
@@ -755,15 +915,15 @@ export declare class ReservedDomains {
|
|
|
755
915
|
/**
|
|
756
916
|
* Delete a reserved domain.
|
|
757
917
|
*/
|
|
758
|
-
delete(
|
|
918
|
+
delete(id: any): Promise<void>;
|
|
759
919
|
/**
|
|
760
920
|
* Get the details of a reserved domain.
|
|
761
921
|
*/
|
|
762
|
-
get(
|
|
922
|
+
get(id: any): Promise<datatypes.ReservedDomain>;
|
|
763
923
|
/**
|
|
764
924
|
* List all reserved domains on this account.
|
|
765
925
|
*/
|
|
766
|
-
list(): Promise<Array<datatypes.ReservedDomain>>;
|
|
926
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.ReservedDomain>>;
|
|
767
927
|
private _pagedList;
|
|
768
928
|
private _asyncList;
|
|
769
929
|
/**
|
|
@@ -773,11 +933,11 @@ export declare class ReservedDomains {
|
|
|
773
933
|
/**
|
|
774
934
|
* Detach the certificate management policy attached to a reserved domain.
|
|
775
935
|
*/
|
|
776
|
-
deleteCertificateManagementPolicy(
|
|
936
|
+
deleteCertificateManagementPolicy(id: any): Promise<void>;
|
|
777
937
|
/**
|
|
778
938
|
* Detach the certificate attached to a reserved domain.
|
|
779
939
|
*/
|
|
780
|
-
deleteCertificate(
|
|
940
|
+
deleteCertificate(id: any): Promise<void>;
|
|
781
941
|
}
|
|
782
942
|
/**
|
|
783
943
|
* An SSH Certificate Authority is a pair of an SSH Certificate and its private
|
|
@@ -794,15 +954,15 @@ export declare class SSHCertificateAuthorities {
|
|
|
794
954
|
/**
|
|
795
955
|
* Delete an SSH Certificate Authority
|
|
796
956
|
*/
|
|
797
|
-
delete(
|
|
957
|
+
delete(id: any): Promise<void>;
|
|
798
958
|
/**
|
|
799
959
|
* Get detailed information about an SSH Certficate Authority
|
|
800
960
|
*/
|
|
801
|
-
get(
|
|
961
|
+
get(id: any): Promise<datatypes.SSHCertificateAuthority>;
|
|
802
962
|
/**
|
|
803
963
|
* List all SSH Certificate Authorities on this account
|
|
804
964
|
*/
|
|
805
|
-
list(): Promise<Array<datatypes.SSHCertificateAuthority>>;
|
|
965
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.SSHCertificateAuthority>>;
|
|
806
966
|
private _pagedList;
|
|
807
967
|
private _asyncList;
|
|
808
968
|
/**
|
|
@@ -825,15 +985,15 @@ export declare class SSHCredentials {
|
|
|
825
985
|
/**
|
|
826
986
|
* Delete an ssh_credential by ID
|
|
827
987
|
*/
|
|
828
|
-
delete(
|
|
988
|
+
delete(id: any): Promise<void>;
|
|
829
989
|
/**
|
|
830
990
|
* Get detailed information about an ssh_credential
|
|
831
991
|
*/
|
|
832
|
-
get(
|
|
992
|
+
get(id: any): Promise<datatypes.SSHCredential>;
|
|
833
993
|
/**
|
|
834
994
|
* List all ssh credentials on this account
|
|
835
995
|
*/
|
|
836
|
-
list(): Promise<Array<datatypes.SSHCredential>>;
|
|
996
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.SSHCredential>>;
|
|
837
997
|
private _pagedList;
|
|
838
998
|
private _asyncList;
|
|
839
999
|
/**
|
|
@@ -857,15 +1017,15 @@ export declare class SSHHostCertificates {
|
|
|
857
1017
|
/**
|
|
858
1018
|
* Delete an SSH Host Certificate
|
|
859
1019
|
*/
|
|
860
|
-
delete(
|
|
1020
|
+
delete(id: any): Promise<void>;
|
|
861
1021
|
/**
|
|
862
1022
|
* Get detailed information about an SSH Host Certficate
|
|
863
1023
|
*/
|
|
864
|
-
get(
|
|
1024
|
+
get(id: any): Promise<datatypes.SSHHostCertificate>;
|
|
865
1025
|
/**
|
|
866
1026
|
* List all SSH Host Certificates issued on this account
|
|
867
1027
|
*/
|
|
868
|
-
list(): Promise<Array<datatypes.SSHHostCertificate>>;
|
|
1028
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.SSHHostCertificate>>;
|
|
869
1029
|
private _pagedList;
|
|
870
1030
|
private _asyncList;
|
|
871
1031
|
/**
|
|
@@ -889,15 +1049,15 @@ export declare class SSHUserCertificates {
|
|
|
889
1049
|
/**
|
|
890
1050
|
* Delete an SSH User Certificate
|
|
891
1051
|
*/
|
|
892
|
-
delete(
|
|
1052
|
+
delete(id: any): Promise<void>;
|
|
893
1053
|
/**
|
|
894
1054
|
* Get detailed information about an SSH User Certficate
|
|
895
1055
|
*/
|
|
896
|
-
get(
|
|
1056
|
+
get(id: any): Promise<datatypes.SSHUserCertificate>;
|
|
897
1057
|
/**
|
|
898
1058
|
* List all SSH User Certificates issued on this account
|
|
899
1059
|
*/
|
|
900
|
-
list(): Promise<Array<datatypes.SSHUserCertificate>>;
|
|
1060
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.SSHUserCertificate>>;
|
|
901
1061
|
private _pagedList;
|
|
902
1062
|
private _asyncList;
|
|
903
1063
|
/**
|
|
@@ -923,15 +1083,15 @@ export declare class TLSCertificates {
|
|
|
923
1083
|
/**
|
|
924
1084
|
* Delete a TLS certificate
|
|
925
1085
|
*/
|
|
926
|
-
delete(
|
|
1086
|
+
delete(id: any): Promise<void>;
|
|
927
1087
|
/**
|
|
928
1088
|
* Get detailed information about a TLS certificate
|
|
929
1089
|
*/
|
|
930
|
-
get(
|
|
1090
|
+
get(id: any): Promise<datatypes.TLSCertificate>;
|
|
931
1091
|
/**
|
|
932
1092
|
* List all TLS certificates on this account
|
|
933
1093
|
*/
|
|
934
|
-
list(): Promise<Array<datatypes.TLSCertificate>>;
|
|
1094
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.TLSCertificate>>;
|
|
935
1095
|
private _pagedList;
|
|
936
1096
|
private _asyncList;
|
|
937
1097
|
/**
|
|
@@ -939,38 +1099,6 @@ export declare class TLSCertificates {
|
|
|
939
1099
|
*/
|
|
940
1100
|
update(arg: datatypes.TLSCertificateUpdate): Promise<datatypes.TLSCertificate>;
|
|
941
1101
|
}
|
|
942
|
-
/**
|
|
943
|
-
* Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
|
|
944
|
-
sessions that are running and connected to the ngrok service. Each tunnel
|
|
945
|
-
session can include one or more Tunnels.
|
|
946
|
-
*/
|
|
947
|
-
export declare class TunnelSessions {
|
|
948
|
-
private httpClient;
|
|
949
|
-
/** Do not construct this object directly, use the <code>tunnelSessions</code> property of an <code>Ngrok</code> client object instead. */
|
|
950
|
-
constructor(httpClient: Wretcher);
|
|
951
|
-
/**
|
|
952
|
-
* List all online tunnel sessions running on this account.
|
|
953
|
-
*/
|
|
954
|
-
list(): Promise<Array<datatypes.TunnelSession>>;
|
|
955
|
-
private _pagedList;
|
|
956
|
-
private _asyncList;
|
|
957
|
-
/**
|
|
958
|
-
* Get the detailed status of a tunnel session by ID
|
|
959
|
-
*/
|
|
960
|
-
get(arg: datatypes.Item): Promise<datatypes.TunnelSession>;
|
|
961
|
-
/**
|
|
962
|
-
* Issues a command instructing the ngrok agent to restart. The agent restarts itself by calling exec() on platforms that support it. This operation is notably not supported on Windows. When an agent restarts, it reconnects with a new tunnel session ID.
|
|
963
|
-
*/
|
|
964
|
-
restart(arg: datatypes.Item): Promise<void>;
|
|
965
|
-
/**
|
|
966
|
-
* Issues a command instructing the ngrok agent that started this tunnel session to exit.
|
|
967
|
-
*/
|
|
968
|
-
stop(arg: datatypes.Item): Promise<void>;
|
|
969
|
-
/**
|
|
970
|
-
* Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent's configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted
|
|
971
|
-
*/
|
|
972
|
-
update(arg: datatypes.TunnelSessionsUpdate): Promise<void>;
|
|
973
|
-
}
|
|
974
1102
|
/**
|
|
975
1103
|
* Tunnels provide endpoints to access services exposed by a running ngrok
|
|
976
1104
|
agent tunnel session or an SSH reverse tunnel session.
|
|
@@ -982,12 +1110,12 @@ export declare class Tunnels {
|
|
|
982
1110
|
/**
|
|
983
1111
|
* List all online tunnels currently running on the account.
|
|
984
1112
|
*/
|
|
985
|
-
list(): Promise<Array<datatypes.Tunnel>>;
|
|
1113
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.Tunnel>>;
|
|
986
1114
|
private _pagedList;
|
|
987
1115
|
private _asyncList;
|
|
988
1116
|
/**
|
|
989
1117
|
* Get the status of a tunnel by ID
|
|
990
1118
|
*/
|
|
991
|
-
get(
|
|
1119
|
+
get(id: any): Promise<datatypes.Tunnel>;
|
|
992
1120
|
}
|
|
993
1121
|
//# sourceMappingURL=services.d.ts.map
|