@ngrok/ngrok-api 0.9.0 → 0.10.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.eslintignore +2 -0
- package/.eslintrc.js +2 -0
- package/.prettierrc.js +2 -0
- package/CHANGELOG.md +12 -3
- package/CODE_OF_CONDUCT.md +45 -0
- package/README.md +9 -3
- package/docs/assets/js/search.js +1 -1
- package/docs/classes/client.Ngrok.html +54 -26
- package/docs/classes/services.APIKeys.html +20 -11
- package/docs/classes/services.AbuseReports.html +5 -5
- package/docs/classes/services.AgentIngresses.html +20 -11
- package/docs/classes/services.ApplicationSessions.html +288 -0
- package/docs/classes/services.ApplicationUsers.html +288 -0
- package/docs/classes/services.CertificateAuthorities.html +20 -11
- package/docs/classes/services.Credentials.html +21 -12
- package/docs/classes/services.EdgeRouteBackendModule.html +4 -4
- package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +4 -4
- package/docs/classes/services.EdgeRouteCompressionModule.html +4 -4
- package/docs/classes/services.EdgeRouteIPRestrictionModule.html +4 -4
- package/docs/classes/services.EdgeRouteOAuthModule.html +4 -4
- package/docs/classes/services.EdgeRouteOIDCModule.html +4 -4
- package/docs/classes/services.EdgeRouteRequestHeadersModule.html +4 -4
- package/docs/classes/services.EdgeRouteResponseHeadersModule.html +4 -4
- package/docs/classes/services.EdgeRouteSAMLModule.html +4 -4
- package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +4 -4
- package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +4 -4
- package/docs/classes/services.EdgesHTTPS.html +20 -11
- package/docs/classes/services.EdgesHTTPSRoutes.html +5 -5
- package/docs/classes/services.EdgesTCP.html +20 -11
- package/docs/classes/services.EdgesTLS.html +20 -11
- package/docs/classes/services.Endpoints.html +15 -6
- package/docs/classes/services.EventDestinations.html +21 -12
- package/docs/classes/services.EventSources.html +6 -6
- package/docs/classes/services.EventSubscriptions.html +20 -11
- package/docs/classes/services.FailoverBackends.html +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.TCPEdgeBackendModule.html +8 -8
- package/docs/classes/services.TCPEdgeIPRestrictionModule.html +8 -8
- package/docs/classes/services.TLSCertificates.html +20 -11
- package/docs/classes/services.TLSEdgeBackendModule.html +8 -8
- package/docs/classes/services.TLSEdgeIPRestrictionModule.html +8 -8
- package/docs/classes/services.TLSEdgeMutualTLSModule.html +8 -8
- package/docs/classes/services.TLSEdgeTLSTerminationModule.html +8 -8
- package/docs/classes/services.TunnelGroupBackends.html +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 +2 -2
- package/docs/interfaces/datatypes.APIKey.html +28 -9
- package/docs/interfaces/datatypes.APIKeyCreate.html +23 -4
- package/docs/interfaces/datatypes.APIKeyList.html +3 -3
- package/docs/interfaces/datatypes.APIKeyUpdate.html +3 -3
- package/docs/interfaces/datatypes.AWSAuth.html +2 -2
- package/docs/interfaces/datatypes.AWSCredentials.html +2 -2
- package/docs/interfaces/datatypes.AWSRole.html +1 -1
- package/docs/interfaces/datatypes.AbuseReport.html +9 -9
- package/docs/interfaces/datatypes.AbuseReportCreate.html +3 -3
- package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
- package/docs/interfaces/datatypes.AgentIngress.html +49 -11
- package/docs/interfaces/datatypes.AgentIngressCertJob.html +224 -0
- package/docs/interfaces/datatypes.AgentIngressCertPolicy.html +186 -0
- package/docs/interfaces/datatypes.AgentIngressCertStatus.html +186 -0
- package/docs/interfaces/datatypes.AgentIngressCreate.html +24 -5
- package/docs/interfaces/datatypes.AgentIngressList.html +3 -3
- package/docs/interfaces/datatypes.AgentIngressUpdate.html +22 -3
- package/docs/interfaces/datatypes.ApplicationSession.html +357 -0
- package/docs/interfaces/datatypes.ApplicationSessionList.html +205 -0
- package/docs/interfaces/datatypes.ApplicationUser.html +338 -0
- package/docs/interfaces/datatypes.ApplicationUserList.html +205 -0
- package/docs/interfaces/datatypes.BrowserSession.html +205 -0
- package/docs/interfaces/datatypes.CertificateAuthority.html +16 -16
- package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +5 -5
- package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.Credential.html +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.EdgeRouteBackendReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteCompressionReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteItem.html +2 -2
- package/docs/interfaces/datatypes.EdgeRouteOAuthReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteRequestHeadersReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteSAMLReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteWebhookVerificationReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +3 -3
- package/docs/interfaces/datatypes.EdgeTLSTerminationAtEdgeReplace.html +2 -2
- package/docs/interfaces/datatypes.EdgeTLSTerminationReplace.html +2 -2
- package/docs/interfaces/datatypes.Endpoint.html +19 -19
- package/docs/interfaces/datatypes.EndpointBackend.html +2 -2
- package/docs/interfaces/datatypes.EndpointBackendMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
- package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
- package/docs/interfaces/datatypes.EndpointIPPolicy.html +7 -2
- package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
- package/docs/interfaces/datatypes.EndpointList.html +3 -3
- package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
- package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +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.EndpointRequestHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
- package/docs/interfaces/datatypes.EndpointSAML.html +15 -15
- package/docs/interfaces/datatypes.EndpointSAMLMutate.html +10 -10
- package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
- package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +2 -2
- package/docs/interfaces/datatypes.EndpointWebhookValidation.html +4 -4
- package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +1 -1
- package/docs/interfaces/datatypes.Error.html +4 -4
- package/docs/interfaces/datatypes.EventDestination.html +10 -10
- package/docs/interfaces/datatypes.EventDestinationCreate.html +6 -6
- package/docs/interfaces/datatypes.EventDestinationList.html +3 -3
- package/docs/interfaces/datatypes.EventDestinationUpdate.html +5 -5
- package/docs/interfaces/datatypes.EventSource.html +2 -2
- package/docs/interfaces/datatypes.EventSourceCreate.html +2 -2
- package/docs/interfaces/datatypes.EventSourceItem.html +2 -2
- package/docs/interfaces/datatypes.EventSourceList.html +2 -2
- package/docs/interfaces/datatypes.EventSourcePaging.html +1 -1
- package/docs/interfaces/datatypes.EventSourceReplace.html +1 -1
- package/docs/interfaces/datatypes.EventSourceUpdate.html +2 -2
- package/docs/interfaces/datatypes.EventSubscription.html +10 -10
- package/docs/interfaces/datatypes.EventSubscriptionCreate.html +6 -6
- package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
- package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +5 -5
- package/docs/interfaces/datatypes.EventTarget.html +22 -3
- package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
- package/docs/interfaces/datatypes.EventTargetDatadog.html +224 -0
- package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
- package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
- package/docs/interfaces/datatypes.FailoverBackend.html +9 -9
- package/docs/interfaces/datatypes.FailoverBackendCreate.html +5 -5
- package/docs/interfaces/datatypes.FailoverBackendList.html +3 -3
- package/docs/interfaces/datatypes.FailoverBackendUpdate.html +4 -4
- package/docs/interfaces/datatypes.HTTPResponseBackend.html +11 -11
- package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +7 -7
- package/docs/interfaces/datatypes.HTTPResponseBackendList.html +3 -3
- package/docs/interfaces/datatypes.HTTPResponseBackendUpdate.html +6 -6
- package/docs/interfaces/datatypes.HTTPSEdge.html +12 -12
- package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +7 -7
- package/docs/interfaces/datatypes.HTTPSEdgeList.html +3 -3
- package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +22 -22
- package/docs/interfaces/datatypes.HTTPSEdgeRouteCreate.html +18 -18
- package/docs/interfaces/datatypes.HTTPSEdgeRouteUpdate.html +19 -19
- package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +6 -6
- package/docs/interfaces/datatypes.IPPolicy.html +8 -8
- package/docs/interfaces/datatypes.IPPolicyCreate.html +4 -4
- package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRule.html +11 -11
- package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +7 -7
- package/docs/interfaces/datatypes.IPPolicyRuleList.html +3 -3
- package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +4 -4
- package/docs/interfaces/datatypes.IPPolicyUpdate.html +3 -3
- package/docs/interfaces/datatypes.IPRestriction.html +11 -11
- package/docs/interfaces/datatypes.IPRestrictionCreate.html +7 -7
- package/docs/interfaces/datatypes.IPRestrictionList.html +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 +15 -15
- package/docs/interfaces/datatypes.ReservedDomainCertJob.html +6 -6
- package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
- package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomainCreate.html +18 -18
- package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
- package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -5
- package/docs/interfaces/datatypes.SSHCertificateAuthority.html +10 -10
- package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +7 -7
- package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
- package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHCredential.html +30 -11
- package/docs/interfaces/datatypes.SSHCredentialCreate.html +26 -7
- package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
- package/docs/interfaces/datatypes.SSHCredentialUpdate.html +5 -5
- package/docs/interfaces/datatypes.SSHHostCertificate.html +17 -17
- package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +11 -11
- package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
- package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.SSHUserCertificate.html +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.TCPEdge.html +11 -11
- package/docs/interfaces/datatypes.TCPEdgeCreate.html +7 -7
- package/docs/interfaces/datatypes.TCPEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TCPEdgeUpdate.html +6 -6
- package/docs/interfaces/datatypes.TLSCertificate.html +28 -28
- package/docs/interfaces/datatypes.TLSCertificateCreate.html +8 -8
- package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
- package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
- package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
- package/docs/interfaces/datatypes.TLSEdge.html +13 -13
- package/docs/interfaces/datatypes.TLSEdgeCreate.html +9 -9
- package/docs/interfaces/datatypes.TLSEdgeList.html +3 -3
- package/docs/interfaces/datatypes.TLSEdgeUpdate.html +8 -8
- package/docs/interfaces/datatypes.Tunnel.html +17 -17
- package/docs/interfaces/datatypes.TunnelGroupBackend.html +10 -10
- package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +5 -5
- package/docs/interfaces/datatypes.TunnelGroupBackendList.html +3 -3
- package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +4 -4
- package/docs/interfaces/datatypes.TunnelList.html +3 -3
- package/docs/interfaces/datatypes.TunnelSession.html +12 -12
- package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
- package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
- package/docs/interfaces/datatypes.UserAgent.html +262 -0
- package/docs/interfaces/datatypes.WeightedBackend.html +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 +64 -0
- package/docs/modules/services.html +8 -0
- package/jest.config.js +2 -0
- package/lib/client.d.ts +9 -7
- package/lib/client.d.ts.map +1 -1
- package/lib/client.js +89 -119
- package/lib/client.js.map +1 -1
- package/lib/datatypes.d.ts +392 -201
- 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 +164 -126
- package/lib/services.d.ts.map +1 -1
- package/lib/services.js +3294 -3356
- package/lib/services.js.map +1 -1
- package/lib/util.d.ts.map +1 -1
- package/lib/util.js +35 -34
- package/lib/util.js.map +1 -1
- package/package.json +3 -3
- package/src/client.ts +16 -32
- package/src/datatypes.ts +413 -204
- package/src/index.ts +2 -0
- package/src/services.ts +768 -519
- 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,9 +186,9 @@ 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>;
|
|
@@ -138,15 +208,15 @@ export declare class TunnelGroupBackends {
|
|
|
138
208
|
/**
|
|
139
209
|
* Delete a TunnelGroup backend by ID.
|
|
140
210
|
*/
|
|
141
|
-
delete(
|
|
211
|
+
delete(id: any): Promise<void>;
|
|
142
212
|
/**
|
|
143
213
|
* Get detailed information about a TunnelGroup backend by ID
|
|
144
214
|
*/
|
|
145
|
-
get(
|
|
215
|
+
get(id: any): Promise<datatypes.TunnelGroupBackend>;
|
|
146
216
|
/**
|
|
147
217
|
* List all TunnelGroup backends on this account
|
|
148
218
|
*/
|
|
149
|
-
list(): Promise<Array<datatypes.TunnelGroupBackend>>;
|
|
219
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.TunnelGroupBackend>>;
|
|
150
220
|
private _pagedList;
|
|
151
221
|
private _asyncList;
|
|
152
222
|
/**
|
|
@@ -171,15 +241,15 @@ export declare class WeightedBackends {
|
|
|
171
241
|
/**
|
|
172
242
|
* Delete a Weighted backend by ID.
|
|
173
243
|
*/
|
|
174
|
-
delete(
|
|
244
|
+
delete(id: any): Promise<void>;
|
|
175
245
|
/**
|
|
176
246
|
* Get detailed information about a Weighted backend by ID
|
|
177
247
|
*/
|
|
178
|
-
get(
|
|
248
|
+
get(id: any): Promise<datatypes.WeightedBackend>;
|
|
179
249
|
/**
|
|
180
250
|
* List all Weighted backends on this account
|
|
181
251
|
*/
|
|
182
|
-
list(): Promise<Array<datatypes.WeightedBackend>>;
|
|
252
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.WeightedBackend>>;
|
|
183
253
|
private _pagedList;
|
|
184
254
|
private _asyncList;
|
|
185
255
|
/**
|
|
@@ -205,15 +275,15 @@ export declare class CertificateAuthorities {
|
|
|
205
275
|
/**
|
|
206
276
|
* Delete a Certificate Authority
|
|
207
277
|
*/
|
|
208
|
-
delete(
|
|
278
|
+
delete(id: any): Promise<void>;
|
|
209
279
|
/**
|
|
210
280
|
* Get detailed information about a certficate authority
|
|
211
281
|
*/
|
|
212
|
-
get(
|
|
282
|
+
get(id: any): Promise<datatypes.CertificateAuthority>;
|
|
213
283
|
/**
|
|
214
284
|
* List all Certificate Authority on this account
|
|
215
285
|
*/
|
|
216
|
-
list(): Promise<Array<datatypes.CertificateAuthority>>;
|
|
286
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.CertificateAuthority>>;
|
|
217
287
|
private _pagedList;
|
|
218
288
|
private _asyncList;
|
|
219
289
|
/**
|
|
@@ -224,7 +294,7 @@ export declare class CertificateAuthorities {
|
|
|
224
294
|
/**
|
|
225
295
|
* Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok
|
|
226
296
|
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`
|
|
297
|
+
the `ngrok config add-authtoken` command or by specifying it in the `ngrok.yml`
|
|
228
298
|
configuration file with the `authtoken` property.
|
|
229
299
|
*/
|
|
230
300
|
export declare class Credentials {
|
|
@@ -238,15 +308,15 @@ export declare class Credentials {
|
|
|
238
308
|
/**
|
|
239
309
|
* Delete a tunnel authtoken credential by ID
|
|
240
310
|
*/
|
|
241
|
-
delete(
|
|
311
|
+
delete(id: any): Promise<void>;
|
|
242
312
|
/**
|
|
243
313
|
* Get detailed information about a tunnel authtoken credential
|
|
244
314
|
*/
|
|
245
|
-
get(
|
|
315
|
+
get(id: any): Promise<datatypes.Credential>;
|
|
246
316
|
/**
|
|
247
317
|
* List all tunnel authtoken credentials on this account
|
|
248
318
|
*/
|
|
249
|
-
list(): Promise<Array<datatypes.Credential>>;
|
|
319
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.Credential>>;
|
|
250
320
|
private _pagedList;
|
|
251
321
|
private _asyncList;
|
|
252
322
|
/**
|
|
@@ -286,11 +356,11 @@ export declare class EdgesHTTPS {
|
|
|
286
356
|
/**
|
|
287
357
|
* Get an HTTPS Edge by ID
|
|
288
358
|
*/
|
|
289
|
-
get(
|
|
359
|
+
get(id: any): Promise<datatypes.HTTPSEdge>;
|
|
290
360
|
/**
|
|
291
361
|
* Returns a list of all HTTPS Edges on this account
|
|
292
362
|
*/
|
|
293
|
-
list(): Promise<Array<datatypes.HTTPSEdge>>;
|
|
363
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.HTTPSEdge>>;
|
|
294
364
|
private _pagedList;
|
|
295
365
|
private _asyncList;
|
|
296
366
|
/**
|
|
@@ -300,23 +370,23 @@ export declare class EdgesHTTPS {
|
|
|
300
370
|
/**
|
|
301
371
|
* Delete an HTTPS Edge by ID
|
|
302
372
|
*/
|
|
303
|
-
delete(
|
|
373
|
+
delete(id: any): Promise<void>;
|
|
304
374
|
}
|
|
305
375
|
export declare class HTTPSEdgeMutualTLSModule {
|
|
306
376
|
private httpClient;
|
|
307
377
|
/** Do not construct this object directly, use the <code>httpsEdgeMutualTlsModule</code> property of an <code>Ngrok</code> client object instead. */
|
|
308
378
|
constructor(httpClient: Wretcher);
|
|
309
379
|
replace(arg: datatypes.EdgeMutualTLSReplace): Promise<datatypes.EndpointMutualTLS>;
|
|
310
|
-
get(
|
|
311
|
-
delete(
|
|
380
|
+
get(id: any): Promise<datatypes.EndpointMutualTLS>;
|
|
381
|
+
delete(id: any): Promise<void>;
|
|
312
382
|
}
|
|
313
383
|
export declare class HTTPSEdgeTLSTerminationModule {
|
|
314
384
|
private httpClient;
|
|
315
385
|
/** Do not construct this object directly, use the <code>httpsEdgeTlsTerminationModule</code> property of an <code>Ngrok</code> client object instead. */
|
|
316
386
|
constructor(httpClient: Wretcher);
|
|
317
387
|
replace(arg: datatypes.EdgeTLSTerminationAtEdgeReplace): Promise<datatypes.EndpointTLSTermination>;
|
|
318
|
-
get(
|
|
319
|
-
delete(
|
|
388
|
+
get(id: any): Promise<datatypes.EndpointTLSTermination>;
|
|
389
|
+
delete(id: any): Promise<void>;
|
|
320
390
|
}
|
|
321
391
|
export declare class EdgeRouteBackendModule {
|
|
322
392
|
private httpClient;
|
|
@@ -417,11 +487,11 @@ export declare class EdgesTCP {
|
|
|
417
487
|
/**
|
|
418
488
|
* Get a TCP Edge by ID
|
|
419
489
|
*/
|
|
420
|
-
get(
|
|
490
|
+
get(id: any): Promise<datatypes.TCPEdge>;
|
|
421
491
|
/**
|
|
422
492
|
* Returns a list of all TCP Edges on this account
|
|
423
493
|
*/
|
|
424
|
-
list(): Promise<Array<datatypes.TCPEdge>>;
|
|
494
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.TCPEdge>>;
|
|
425
495
|
private _pagedList;
|
|
426
496
|
private _asyncList;
|
|
427
497
|
/**
|
|
@@ -431,23 +501,23 @@ export declare class EdgesTCP {
|
|
|
431
501
|
/**
|
|
432
502
|
* Delete a TCP Edge by ID
|
|
433
503
|
*/
|
|
434
|
-
delete(
|
|
504
|
+
delete(id: any): Promise<void>;
|
|
435
505
|
}
|
|
436
506
|
export declare class TCPEdgeBackendModule {
|
|
437
507
|
private httpClient;
|
|
438
508
|
/** Do not construct this object directly, use the <code>tcpEdgeBackendModule</code> property of an <code>Ngrok</code> client object instead. */
|
|
439
509
|
constructor(httpClient: Wretcher);
|
|
440
510
|
replace(arg: datatypes.EdgeBackendReplace): Promise<datatypes.EndpointBackend>;
|
|
441
|
-
get(
|
|
442
|
-
delete(
|
|
511
|
+
get(id: any): Promise<datatypes.EndpointBackend>;
|
|
512
|
+
delete(id: any): Promise<void>;
|
|
443
513
|
}
|
|
444
514
|
export declare class TCPEdgeIPRestrictionModule {
|
|
445
515
|
private httpClient;
|
|
446
516
|
/** Do not construct this object directly, use the <code>tcpEdgeIpRestrictionModule</code> property of an <code>Ngrok</code> client object instead. */
|
|
447
517
|
constructor(httpClient: Wretcher);
|
|
448
518
|
replace(arg: datatypes.EdgeIPRestrictionReplace): Promise<datatypes.EndpointIPPolicy>;
|
|
449
|
-
get(
|
|
450
|
-
delete(
|
|
519
|
+
get(id: any): Promise<datatypes.EndpointIPPolicy>;
|
|
520
|
+
delete(id: any): Promise<void>;
|
|
451
521
|
}
|
|
452
522
|
export declare class EdgesTLS {
|
|
453
523
|
private httpClient;
|
|
@@ -460,11 +530,11 @@ export declare class EdgesTLS {
|
|
|
460
530
|
/**
|
|
461
531
|
* Get a TLS Edge by ID
|
|
462
532
|
*/
|
|
463
|
-
get(
|
|
533
|
+
get(id: any): Promise<datatypes.TLSEdge>;
|
|
464
534
|
/**
|
|
465
535
|
* Returns a list of all TLS Edges on this account
|
|
466
536
|
*/
|
|
467
|
-
list(): Promise<Array<datatypes.TLSEdge>>;
|
|
537
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.TLSEdge>>;
|
|
468
538
|
private _pagedList;
|
|
469
539
|
private _asyncList;
|
|
470
540
|
/**
|
|
@@ -474,39 +544,39 @@ export declare class EdgesTLS {
|
|
|
474
544
|
/**
|
|
475
545
|
* Delete a TLS Edge by ID
|
|
476
546
|
*/
|
|
477
|
-
delete(
|
|
547
|
+
delete(id: any): Promise<void>;
|
|
478
548
|
}
|
|
479
549
|
export declare class TLSEdgeBackendModule {
|
|
480
550
|
private httpClient;
|
|
481
551
|
/** Do not construct this object directly, use the <code>tlsEdgeBackendModule</code> property of an <code>Ngrok</code> client object instead. */
|
|
482
552
|
constructor(httpClient: Wretcher);
|
|
483
553
|
replace(arg: datatypes.EdgeBackendReplace): Promise<datatypes.EndpointBackend>;
|
|
484
|
-
get(
|
|
485
|
-
delete(
|
|
554
|
+
get(id: any): Promise<datatypes.EndpointBackend>;
|
|
555
|
+
delete(id: any): Promise<void>;
|
|
486
556
|
}
|
|
487
557
|
export declare class TLSEdgeIPRestrictionModule {
|
|
488
558
|
private httpClient;
|
|
489
559
|
/** Do not construct this object directly, use the <code>tlsEdgeIpRestrictionModule</code> property of an <code>Ngrok</code> client object instead. */
|
|
490
560
|
constructor(httpClient: Wretcher);
|
|
491
561
|
replace(arg: datatypes.EdgeIPRestrictionReplace): Promise<datatypes.EndpointIPPolicy>;
|
|
492
|
-
get(
|
|
493
|
-
delete(
|
|
562
|
+
get(id: any): Promise<datatypes.EndpointIPPolicy>;
|
|
563
|
+
delete(id: any): Promise<void>;
|
|
494
564
|
}
|
|
495
565
|
export declare class TLSEdgeMutualTLSModule {
|
|
496
566
|
private httpClient;
|
|
497
567
|
/** Do not construct this object directly, use the <code>tlsEdgeMutualTlsModule</code> property of an <code>Ngrok</code> client object instead. */
|
|
498
568
|
constructor(httpClient: Wretcher);
|
|
499
569
|
replace(arg: datatypes.EdgeMutualTLSReplace): Promise<datatypes.EndpointMutualTLS>;
|
|
500
|
-
get(
|
|
501
|
-
delete(
|
|
570
|
+
get(id: any): Promise<datatypes.EndpointMutualTLS>;
|
|
571
|
+
delete(id: any): Promise<void>;
|
|
502
572
|
}
|
|
503
573
|
export declare class TLSEdgeTLSTerminationModule {
|
|
504
574
|
private httpClient;
|
|
505
575
|
/** Do not construct this object directly, use the <code>tlsEdgeTlsTerminationModule</code> property of an <code>Ngrok</code> client object instead. */
|
|
506
576
|
constructor(httpClient: Wretcher);
|
|
507
577
|
replace(arg: datatypes.EdgeTLSTerminationReplace): Promise<datatypes.EndpointTLSTermination>;
|
|
508
|
-
get(
|
|
509
|
-
delete(
|
|
578
|
+
get(id: any): Promise<datatypes.EndpointTLSTermination>;
|
|
579
|
+
delete(id: any): Promise<void>;
|
|
510
580
|
}
|
|
511
581
|
/**
|
|
512
582
|
* Endpoints provides an API for querying the endpoint objects
|
|
@@ -520,34 +590,34 @@ export declare class Endpoints {
|
|
|
520
590
|
/**
|
|
521
591
|
* List all active endpoints on the account
|
|
522
592
|
*/
|
|
523
|
-
list(): Promise<Array<datatypes.Endpoint>>;
|
|
593
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.Endpoint>>;
|
|
524
594
|
private _pagedList;
|
|
525
595
|
private _asyncList;
|
|
526
596
|
/**
|
|
527
597
|
* Get the status of an endpoint by ID
|
|
528
598
|
*/
|
|
529
|
-
get(
|
|
599
|
+
get(id: any): Promise<datatypes.Endpoint>;
|
|
530
600
|
}
|
|
531
601
|
export declare class EventDestinations {
|
|
532
602
|
private httpClient;
|
|
533
603
|
/** Do not construct this object directly, use the <code>eventDestinations</code> property of an <code>Ngrok</code> client object instead. */
|
|
534
604
|
constructor(httpClient: Wretcher);
|
|
535
605
|
/**
|
|
536
|
-
* Create a new Event Destination. It will not apply to anything until it is associated with an Event
|
|
606
|
+
* Create a new Event Destination. It will not apply to anything until it is associated with an Event Subscription.
|
|
537
607
|
*/
|
|
538
608
|
create(arg: datatypes.EventDestinationCreate): Promise<datatypes.EventDestination>;
|
|
539
609
|
/**
|
|
540
610
|
* Delete an Event Destination. If the Event Destination is still referenced by an Event Subscription.
|
|
541
611
|
*/
|
|
542
|
-
delete(
|
|
612
|
+
delete(id: any): Promise<void>;
|
|
543
613
|
/**
|
|
544
614
|
* Get detailed information about an Event Destination by ID.
|
|
545
615
|
*/
|
|
546
|
-
get(
|
|
616
|
+
get(id: any): Promise<datatypes.EventDestination>;
|
|
547
617
|
/**
|
|
548
618
|
* List all Event Destinations on this account.
|
|
549
619
|
*/
|
|
550
|
-
list(): Promise<Array<datatypes.EventDestination>>;
|
|
620
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.EventDestination>>;
|
|
551
621
|
private _pagedList;
|
|
552
622
|
private _asyncList;
|
|
553
623
|
/**
|
|
@@ -566,15 +636,15 @@ export declare class EventSubscriptions {
|
|
|
566
636
|
/**
|
|
567
637
|
* Delete an Event Subscription.
|
|
568
638
|
*/
|
|
569
|
-
delete(
|
|
639
|
+
delete(id: any): Promise<void>;
|
|
570
640
|
/**
|
|
571
641
|
* Get an Event Subscription by ID.
|
|
572
642
|
*/
|
|
573
|
-
get(
|
|
643
|
+
get(id: any): Promise<datatypes.EventSubscription>;
|
|
574
644
|
/**
|
|
575
645
|
* List this Account's Event Subscriptions.
|
|
576
646
|
*/
|
|
577
|
-
list(): Promise<Array<datatypes.EventSubscription>>;
|
|
647
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.EventSubscription>>;
|
|
578
648
|
private _pagedList;
|
|
579
649
|
private _asyncList;
|
|
580
650
|
/**
|
|
@@ -624,15 +694,15 @@ export declare class IPPolicies {
|
|
|
624
694
|
/**
|
|
625
695
|
* 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
696
|
*/
|
|
627
|
-
delete(
|
|
697
|
+
delete(id: any): Promise<void>;
|
|
628
698
|
/**
|
|
629
699
|
* Get detailed information about an IP policy by ID.
|
|
630
700
|
*/
|
|
631
|
-
get(
|
|
701
|
+
get(id: any): Promise<datatypes.IPPolicy>;
|
|
632
702
|
/**
|
|
633
703
|
* List all IP policies on this account
|
|
634
704
|
*/
|
|
635
|
-
list(): Promise<Array<datatypes.IPPolicy>>;
|
|
705
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.IPPolicy>>;
|
|
636
706
|
private _pagedList;
|
|
637
707
|
private _asyncList;
|
|
638
708
|
/**
|
|
@@ -655,15 +725,15 @@ export declare class IPPolicyRules {
|
|
|
655
725
|
/**
|
|
656
726
|
* Delete an IP policy rule.
|
|
657
727
|
*/
|
|
658
|
-
delete(
|
|
728
|
+
delete(id: any): Promise<void>;
|
|
659
729
|
/**
|
|
660
730
|
* Get detailed information about an IP policy rule by ID.
|
|
661
731
|
*/
|
|
662
|
-
get(
|
|
732
|
+
get(id: any): Promise<datatypes.IPPolicyRule>;
|
|
663
733
|
/**
|
|
664
734
|
* List all IP policy rules on this account
|
|
665
735
|
*/
|
|
666
|
-
list(): Promise<Array<datatypes.IPPolicyRule>>;
|
|
736
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.IPPolicyRule>>;
|
|
667
737
|
private _pagedList;
|
|
668
738
|
private _asyncList;
|
|
669
739
|
/**
|
|
@@ -690,15 +760,15 @@ export declare class IPRestrictions {
|
|
|
690
760
|
/**
|
|
691
761
|
* Delete an IP restriction
|
|
692
762
|
*/
|
|
693
|
-
delete(
|
|
763
|
+
delete(id: any): Promise<void>;
|
|
694
764
|
/**
|
|
695
765
|
* Get detailed information about an IP restriction
|
|
696
766
|
*/
|
|
697
|
-
get(
|
|
767
|
+
get(id: any): Promise<datatypes.IPRestriction>;
|
|
698
768
|
/**
|
|
699
769
|
* List all IP restrictions on this account
|
|
700
770
|
*/
|
|
701
|
-
list(): Promise<Array<datatypes.IPRestriction>>;
|
|
771
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.IPRestriction>>;
|
|
702
772
|
private _pagedList;
|
|
703
773
|
private _asyncList;
|
|
704
774
|
/**
|
|
@@ -722,15 +792,15 @@ export declare class ReservedAddrs {
|
|
|
722
792
|
/**
|
|
723
793
|
* Delete a reserved address.
|
|
724
794
|
*/
|
|
725
|
-
delete(
|
|
795
|
+
delete(id: any): Promise<void>;
|
|
726
796
|
/**
|
|
727
797
|
* Get the details of a reserved address.
|
|
728
798
|
*/
|
|
729
|
-
get(
|
|
799
|
+
get(id: any): Promise<datatypes.ReservedAddr>;
|
|
730
800
|
/**
|
|
731
801
|
* List all reserved addresses on this account.
|
|
732
802
|
*/
|
|
733
|
-
list(): Promise<Array<datatypes.ReservedAddr>>;
|
|
803
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.ReservedAddr>>;
|
|
734
804
|
private _pagedList;
|
|
735
805
|
private _asyncList;
|
|
736
806
|
/**
|
|
@@ -755,15 +825,15 @@ export declare class ReservedDomains {
|
|
|
755
825
|
/**
|
|
756
826
|
* Delete a reserved domain.
|
|
757
827
|
*/
|
|
758
|
-
delete(
|
|
828
|
+
delete(id: any): Promise<void>;
|
|
759
829
|
/**
|
|
760
830
|
* Get the details of a reserved domain.
|
|
761
831
|
*/
|
|
762
|
-
get(
|
|
832
|
+
get(id: any): Promise<datatypes.ReservedDomain>;
|
|
763
833
|
/**
|
|
764
834
|
* List all reserved domains on this account.
|
|
765
835
|
*/
|
|
766
|
-
list(): Promise<Array<datatypes.ReservedDomain>>;
|
|
836
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.ReservedDomain>>;
|
|
767
837
|
private _pagedList;
|
|
768
838
|
private _asyncList;
|
|
769
839
|
/**
|
|
@@ -773,11 +843,11 @@ export declare class ReservedDomains {
|
|
|
773
843
|
/**
|
|
774
844
|
* Detach the certificate management policy attached to a reserved domain.
|
|
775
845
|
*/
|
|
776
|
-
deleteCertificateManagementPolicy(
|
|
846
|
+
deleteCertificateManagementPolicy(id: any): Promise<void>;
|
|
777
847
|
/**
|
|
778
848
|
* Detach the certificate attached to a reserved domain.
|
|
779
849
|
*/
|
|
780
|
-
deleteCertificate(
|
|
850
|
+
deleteCertificate(id: any): Promise<void>;
|
|
781
851
|
}
|
|
782
852
|
/**
|
|
783
853
|
* An SSH Certificate Authority is a pair of an SSH Certificate and its private
|
|
@@ -794,15 +864,15 @@ export declare class SSHCertificateAuthorities {
|
|
|
794
864
|
/**
|
|
795
865
|
* Delete an SSH Certificate Authority
|
|
796
866
|
*/
|
|
797
|
-
delete(
|
|
867
|
+
delete(id: any): Promise<void>;
|
|
798
868
|
/**
|
|
799
869
|
* Get detailed information about an SSH Certficate Authority
|
|
800
870
|
*/
|
|
801
|
-
get(
|
|
871
|
+
get(id: any): Promise<datatypes.SSHCertificateAuthority>;
|
|
802
872
|
/**
|
|
803
873
|
* List all SSH Certificate Authorities on this account
|
|
804
874
|
*/
|
|
805
|
-
list(): Promise<Array<datatypes.SSHCertificateAuthority>>;
|
|
875
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.SSHCertificateAuthority>>;
|
|
806
876
|
private _pagedList;
|
|
807
877
|
private _asyncList;
|
|
808
878
|
/**
|
|
@@ -825,15 +895,15 @@ export declare class SSHCredentials {
|
|
|
825
895
|
/**
|
|
826
896
|
* Delete an ssh_credential by ID
|
|
827
897
|
*/
|
|
828
|
-
delete(
|
|
898
|
+
delete(id: any): Promise<void>;
|
|
829
899
|
/**
|
|
830
900
|
* Get detailed information about an ssh_credential
|
|
831
901
|
*/
|
|
832
|
-
get(
|
|
902
|
+
get(id: any): Promise<datatypes.SSHCredential>;
|
|
833
903
|
/**
|
|
834
904
|
* List all ssh credentials on this account
|
|
835
905
|
*/
|
|
836
|
-
list(): Promise<Array<datatypes.SSHCredential>>;
|
|
906
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.SSHCredential>>;
|
|
837
907
|
private _pagedList;
|
|
838
908
|
private _asyncList;
|
|
839
909
|
/**
|
|
@@ -857,15 +927,15 @@ export declare class SSHHostCertificates {
|
|
|
857
927
|
/**
|
|
858
928
|
* Delete an SSH Host Certificate
|
|
859
929
|
*/
|
|
860
|
-
delete(
|
|
930
|
+
delete(id: any): Promise<void>;
|
|
861
931
|
/**
|
|
862
932
|
* Get detailed information about an SSH Host Certficate
|
|
863
933
|
*/
|
|
864
|
-
get(
|
|
934
|
+
get(id: any): Promise<datatypes.SSHHostCertificate>;
|
|
865
935
|
/**
|
|
866
936
|
* List all SSH Host Certificates issued on this account
|
|
867
937
|
*/
|
|
868
|
-
list(): Promise<Array<datatypes.SSHHostCertificate>>;
|
|
938
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.SSHHostCertificate>>;
|
|
869
939
|
private _pagedList;
|
|
870
940
|
private _asyncList;
|
|
871
941
|
/**
|
|
@@ -889,15 +959,15 @@ export declare class SSHUserCertificates {
|
|
|
889
959
|
/**
|
|
890
960
|
* Delete an SSH User Certificate
|
|
891
961
|
*/
|
|
892
|
-
delete(
|
|
962
|
+
delete(id: any): Promise<void>;
|
|
893
963
|
/**
|
|
894
964
|
* Get detailed information about an SSH User Certficate
|
|
895
965
|
*/
|
|
896
|
-
get(
|
|
966
|
+
get(id: any): Promise<datatypes.SSHUserCertificate>;
|
|
897
967
|
/**
|
|
898
968
|
* List all SSH User Certificates issued on this account
|
|
899
969
|
*/
|
|
900
|
-
list(): Promise<Array<datatypes.SSHUserCertificate>>;
|
|
970
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.SSHUserCertificate>>;
|
|
901
971
|
private _pagedList;
|
|
902
972
|
private _asyncList;
|
|
903
973
|
/**
|
|
@@ -923,15 +993,15 @@ export declare class TLSCertificates {
|
|
|
923
993
|
/**
|
|
924
994
|
* Delete a TLS certificate
|
|
925
995
|
*/
|
|
926
|
-
delete(
|
|
996
|
+
delete(id: any): Promise<void>;
|
|
927
997
|
/**
|
|
928
998
|
* Get detailed information about a TLS certificate
|
|
929
999
|
*/
|
|
930
|
-
get(
|
|
1000
|
+
get(id: any): Promise<datatypes.TLSCertificate>;
|
|
931
1001
|
/**
|
|
932
1002
|
* List all TLS certificates on this account
|
|
933
1003
|
*/
|
|
934
|
-
list(): Promise<Array<datatypes.TLSCertificate>>;
|
|
1004
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.TLSCertificate>>;
|
|
935
1005
|
private _pagedList;
|
|
936
1006
|
private _asyncList;
|
|
937
1007
|
/**
|
|
@@ -939,38 +1009,6 @@ export declare class TLSCertificates {
|
|
|
939
1009
|
*/
|
|
940
1010
|
update(arg: datatypes.TLSCertificateUpdate): Promise<datatypes.TLSCertificate>;
|
|
941
1011
|
}
|
|
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
1012
|
/**
|
|
975
1013
|
* Tunnels provide endpoints to access services exposed by a running ngrok
|
|
976
1014
|
agent tunnel session or an SSH reverse tunnel session.
|
|
@@ -982,12 +1020,12 @@ export declare class Tunnels {
|
|
|
982
1020
|
/**
|
|
983
1021
|
* List all online tunnels currently running on the account.
|
|
984
1022
|
*/
|
|
985
|
-
list(): Promise<Array<datatypes.Tunnel>>;
|
|
1023
|
+
list(beforeId?: string, limit?: string): Promise<Array<datatypes.Tunnel>>;
|
|
986
1024
|
private _pagedList;
|
|
987
1025
|
private _asyncList;
|
|
988
1026
|
/**
|
|
989
1027
|
* Get the status of a tunnel by ID
|
|
990
1028
|
*/
|
|
991
|
-
get(
|
|
1029
|
+
get(id: any): Promise<datatypes.Tunnel>;
|
|
992
1030
|
}
|
|
993
1031
|
//# sourceMappingURL=services.d.ts.map
|