@ngrok/ngrok-api 0.2.0 → 0.8.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.
Files changed (244) hide show
  1. package/README.md +0 -28
  2. package/docs/CNAME +1 -0
  3. package/docs/assets/js/search.js +1 -1
  4. package/docs/classes/client.Ngrok.html +204 -119
  5. package/docs/classes/services.APIKeys.html +6 -105
  6. package/docs/classes/services.AbuseReports.html +3 -102
  7. package/docs/classes/{services.IPWhitelist.html → services.AgentIngresses.html} +41 -148
  8. package/docs/classes/services.CertificateAuthorities.html +6 -105
  9. package/docs/classes/services.Credentials.html +6 -105
  10. package/docs/classes/services.EdgeRouteBackendModule.html +270 -0
  11. package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +270 -0
  12. package/docs/classes/services.EdgeRouteCompressionModule.html +270 -0
  13. package/docs/classes/services.EdgeRouteIPRestrictionModule.html +270 -0
  14. package/docs/classes/services.EdgeRouteOAuthModule.html +270 -0
  15. package/docs/classes/services.EdgeRouteOIDCModule.html +270 -0
  16. package/docs/classes/{services.EndpointResponseHeadersModule.html → services.EdgeRouteRequestHeadersModule.html} +28 -127
  17. package/docs/classes/services.EdgeRouteResponseHeadersModule.html +270 -0
  18. package/docs/classes/services.EdgeRouteSAMLModule.html +270 -0
  19. package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +270 -0
  20. package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +270 -0
  21. package/docs/classes/services.EdgesHTTPS.html +343 -0
  22. package/docs/classes/services.EdgesHTTPSRoutes.html +317 -0
  23. package/docs/classes/services.EdgesTCP.html +343 -0
  24. package/docs/classes/services.EdgesTLS.html +343 -0
  25. package/docs/classes/services.Endpoints.html +256 -0
  26. package/docs/classes/services.EventDestinations.html +7 -106
  27. package/docs/classes/services.EventSources.html +6 -105
  28. package/docs/classes/services.EventSubscriptions.html +6 -105
  29. package/docs/classes/{services.EventStreams.html → services.FailoverBackends.html} +51 -140
  30. package/docs/classes/services.HTTPResponseBackends.html +318 -0
  31. package/docs/classes/{services.EndpointMutualTLSModule.html → services.HTTPSEdgeMutualTLSModule.html} +22 -121
  32. package/docs/classes/{services.EndpointTLSTerminationModule.html → services.HTTPSEdgeTLSTerminationModule.html} +22 -121
  33. package/docs/classes/services.IPPolicies.html +6 -105
  34. package/docs/classes/services.IPPolicyRules.html +6 -105
  35. package/docs/classes/services.IPRestrictions.html +7 -106
  36. package/docs/classes/services.ReservedAddrs.html +6 -137
  37. package/docs/classes/services.ReservedDomains.html +8 -171
  38. package/docs/classes/services.SSHCertificateAuthorities.html +6 -105
  39. package/docs/classes/services.SSHCredentials.html +6 -105
  40. package/docs/classes/services.SSHHostCertificates.html +6 -105
  41. package/docs/classes/services.SSHUserCertificates.html +6 -105
  42. package/docs/classes/{services.EndpointSAMLModule.html → services.TCPEdgeBackendModule.html} +25 -124
  43. package/docs/classes/{services.EndpointIPPolicyModule.html → services.TCPEdgeIPRestrictionModule.html} +22 -121
  44. package/docs/classes/services.TLSCertificates.html +6 -105
  45. package/docs/classes/{services.EndpointLoggingModule.html → services.TLSEdgeBackendModule.html} +25 -124
  46. package/docs/classes/{services.EndpointOIDCModule.html → services.TLSEdgeIPRestrictionModule.html} +25 -124
  47. package/docs/classes/{services.EndpointOAuthModule.html → services.TLSEdgeMutualTLSModule.html} +25 -124
  48. package/docs/classes/services.TLSEdgeTLSTerminationModule.html +270 -0
  49. package/docs/classes/services.TunnelGroupBackends.html +351 -0
  50. package/docs/classes/services.TunnelSessions.html +6 -105
  51. package/docs/classes/services.Tunnels.html +34 -101
  52. package/docs/classes/services.WeightedBackends.html +353 -0
  53. package/docs/index.html +0 -27
  54. package/docs/interfaces/client.NgrokConfig.html +2 -2
  55. package/docs/interfaces/datatypes.APIKey.html +6 -6
  56. package/docs/interfaces/datatypes.APIKeyCreate.html +2 -2
  57. package/docs/interfaces/datatypes.APIKeyList.html +3 -3
  58. package/docs/interfaces/datatypes.APIKeyUpdate.html +3 -3
  59. package/docs/interfaces/datatypes.AWSAuth.html +2 -2
  60. package/docs/interfaces/datatypes.AWSCredentials.html +2 -2
  61. package/docs/interfaces/datatypes.AWSRole.html +1 -1
  62. package/docs/interfaces/datatypes.AbuseReport.html +7 -7
  63. package/docs/interfaces/datatypes.AbuseReportCreate.html +2 -2
  64. package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
  65. package/docs/interfaces/{datatypes.EventStream.html → datatypes.AgentIngress.html} +52 -71
  66. package/docs/interfaces/datatypes.AgentIngressCreate.html +205 -0
  67. package/docs/interfaces/datatypes.AgentIngressList.html +205 -0
  68. package/docs/interfaces/{datatypes.IPWhitelistEntryUpdate.html → datatypes.AgentIngressUpdate.html} +16 -16
  69. package/docs/interfaces/datatypes.CertificateAuthority.html +11 -11
  70. package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +3 -3
  71. package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
  72. package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
  73. package/docs/interfaces/datatypes.Credential.html +7 -7
  74. package/docs/interfaces/datatypes.CredentialCreate.html +3 -3
  75. package/docs/interfaces/datatypes.CredentialList.html +3 -3
  76. package/docs/interfaces/datatypes.CredentialUpdate.html +4 -4
  77. package/docs/interfaces/{datatypes.EndpointCircuitBreakerReplace.html → datatypes.EdgeBackendReplace.html} +12 -12
  78. package/docs/interfaces/{datatypes.EndpointIPPolicyReplace.html → datatypes.EdgeIPRestrictionReplace.html} +11 -11
  79. package/docs/interfaces/{datatypes.EndpointMutualTLSReplace.html → datatypes.EdgeMutualTLSReplace.html} +11 -11
  80. package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +190 -0
  81. package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +190 -0
  82. package/docs/interfaces/{datatypes.EndpointCompressionReplace.html → datatypes.EdgeRouteCompressionReplace.html} +25 -11
  83. package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +190 -0
  84. package/docs/interfaces/{datatypes.ReservedDomainCertNSTarget.html → datatypes.EdgeRouteItem.html} +19 -19
  85. package/docs/interfaces/{datatypes.EndpointOAuthReplace.html → datatypes.EdgeRouteOAuthReplace.html} +25 -11
  86. package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +190 -0
  87. package/docs/interfaces/{datatypes.EndpointRequestHeadersReplace.html → datatypes.EdgeRouteRequestHeadersReplace.html} +25 -11
  88. package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +190 -0
  89. package/docs/interfaces/{datatypes.EndpointSAMLReplace.html → datatypes.EdgeRouteSAMLReplace.html} +25 -11
  90. package/docs/interfaces/{datatypes.EndpointWebhookValidationReplace.html → datatypes.EdgeRouteWebhookVerificationReplace.html} +25 -11
  91. package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +190 -0
  92. package/docs/interfaces/{datatypes.EndpointResponseHeadersReplace.html → datatypes.EdgeTLSTerminationAtEdgeReplace.html} +12 -12
  93. package/docs/interfaces/{datatypes.EndpointTLSTerminationReplace.html → datatypes.EdgeTLSTerminationReplace.html} +11 -11
  94. package/docs/interfaces/datatypes.Endpoint.html +395 -0
  95. package/docs/interfaces/{datatypes.EndpointLogging.html → datatypes.EndpointBackend.html} +19 -19
  96. package/docs/interfaces/{datatypes.EndpointLoggingMutate.html → datatypes.EndpointBackendMutate.html} +19 -19
  97. package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
  98. package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
  99. package/docs/interfaces/datatypes.EndpointIPPolicy.html +2 -2
  100. package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
  101. package/docs/interfaces/{datatypes.EndpointConfigurationList.html → datatypes.EndpointList.html} +19 -19
  102. package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
  103. package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +2 -2
  104. package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
  105. package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
  106. package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +7 -7
  107. package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
  108. package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
  109. package/docs/interfaces/datatypes.EndpointOAuthProvider.html +4 -4
  110. package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
  111. package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
  112. package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
  113. package/docs/interfaces/datatypes.EndpointSAML.html +33 -14
  114. package/docs/interfaces/datatypes.EndpointSAMLMutate.html +28 -9
  115. package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
  116. package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +186 -0
  117. package/docs/interfaces/datatypes.EndpointWebhookValidation.html +4 -4
  118. package/docs/interfaces/{datatypes.EndpointOIDCReplace.html → datatypes.EndpointWebsocketTCPConverter.html} +16 -25
  119. package/docs/interfaces/datatypes.Error.html +4 -4
  120. package/docs/interfaces/datatypes.EventDestination.html +7 -7
  121. package/docs/interfaces/datatypes.EventDestinationCreate.html +4 -4
  122. package/docs/interfaces/datatypes.EventDestinationList.html +3 -3
  123. package/docs/interfaces/datatypes.EventDestinationUpdate.html +5 -5
  124. package/docs/interfaces/datatypes.EventSource.html +2 -2
  125. package/docs/interfaces/datatypes.EventSourceCreate.html +2 -2
  126. package/docs/interfaces/datatypes.EventSourceItem.html +2 -2
  127. package/docs/interfaces/datatypes.EventSourceList.html +2 -2
  128. package/docs/interfaces/datatypes.EventSourcePaging.html +1 -1
  129. package/docs/interfaces/datatypes.EventSourceReplace.html +1 -1
  130. package/docs/interfaces/datatypes.EventSourceUpdate.html +2 -2
  131. package/docs/interfaces/datatypes.EventSubscription.html +7 -7
  132. package/docs/interfaces/datatypes.EventSubscriptionCreate.html +5 -5
  133. package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
  134. package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +6 -6
  135. package/docs/interfaces/datatypes.EventTarget.html +3 -3
  136. package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
  137. package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
  138. package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
  139. package/docs/interfaces/{datatypes.IPWhitelistEntry.html → datatypes.FailoverBackend.html} +41 -41
  140. package/docs/interfaces/{datatypes.IPWhitelistEntryCreate.html → datatypes.FailoverBackendCreate.html} +23 -23
  141. package/docs/interfaces/datatypes.FailoverBackendList.html +205 -0
  142. package/docs/interfaces/datatypes.FailoverBackendUpdate.html +219 -0
  143. package/docs/interfaces/datatypes.HTTPResponseBackend.html +295 -0
  144. package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +243 -0
  145. package/docs/interfaces/datatypes.HTTPResponseBackendList.html +190 -0
  146. package/docs/interfaces/datatypes.HTTPResponseBackendUpdate.html +257 -0
  147. package/docs/interfaces/datatypes.HTTPSEdge.html +314 -0
  148. package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +238 -0
  149. package/docs/interfaces/datatypes.HTTPSEdgeList.html +205 -0
  150. package/docs/interfaces/{datatypes.EndpointConfigurationUpdate.html → datatypes.HTTPSEdgeRoute.html} +154 -78
  151. package/docs/interfaces/{datatypes.EndpointConfigurationCreate.html → datatypes.HTTPSEdgeRouteCreate.html} +108 -89
  152. package/docs/interfaces/{datatypes.EndpointConfiguration.html → datatypes.HTTPSEdgeRouteUpdate.html} +104 -123
  153. package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +257 -0
  154. package/docs/interfaces/datatypes.IPPolicy.html +5 -24
  155. package/docs/interfaces/datatypes.IPPolicyCreate.html +2 -21
  156. package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
  157. package/docs/interfaces/datatypes.IPPolicyRule.html +26 -7
  158. package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +23 -4
  159. package/docs/interfaces/datatypes.IPPolicyRuleList.html +3 -3
  160. package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +4 -4
  161. package/docs/interfaces/datatypes.IPPolicyUpdate.html +3 -3
  162. package/docs/interfaces/datatypes.IPRestriction.html +8 -8
  163. package/docs/interfaces/datatypes.IPRestrictionCreate.html +5 -5
  164. package/docs/interfaces/datatypes.IPRestrictionList.html +3 -3
  165. package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
  166. package/docs/interfaces/datatypes.Item.html +1 -1
  167. package/docs/interfaces/datatypes.Paging.html +2 -2
  168. package/docs/interfaces/datatypes.Ref.html +2 -2
  169. package/docs/interfaces/datatypes.ReservedAddr.html +7 -26
  170. package/docs/interfaces/datatypes.ReservedAddrCreate.html +3 -22
  171. package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
  172. package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -22
  173. package/docs/interfaces/datatypes.ReservedDomain.html +30 -49
  174. package/docs/interfaces/datatypes.ReservedDomainCertJob.html +4 -23
  175. package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
  176. package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +2 -2
  177. package/docs/interfaces/datatypes.ReservedDomainCreate.html +6 -44
  178. package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
  179. package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -43
  180. package/docs/interfaces/datatypes.SSHCertificateAuthority.html +7 -7
  181. package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +5 -5
  182. package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
  183. package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
  184. package/docs/interfaces/datatypes.SSHCredential.html +7 -7
  185. package/docs/interfaces/datatypes.SSHCredentialCreate.html +4 -4
  186. package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
  187. package/docs/interfaces/datatypes.SSHCredentialUpdate.html +4 -4
  188. package/docs/interfaces/datatypes.SSHHostCertificate.html +12 -12
  189. package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +7 -7
  190. package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
  191. package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
  192. package/docs/interfaces/datatypes.SSHUserCertificate.html +14 -14
  193. package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +9 -9
  194. package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
  195. package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
  196. package/docs/interfaces/datatypes.TCPEdge.html +295 -0
  197. package/docs/interfaces/datatypes.TCPEdgeCreate.html +238 -0
  198. package/docs/interfaces/{datatypes.IPWhitelistEntryList.html → datatypes.TCPEdgeList.html} +22 -22
  199. package/docs/interfaces/{datatypes.EventStreamUpdate.html → datatypes.TCPEdgeUpdate.html} +43 -48
  200. package/docs/interfaces/datatypes.TLSCertificate.html +21 -21
  201. package/docs/interfaces/datatypes.TLSCertificateCreate.html +4 -4
  202. package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
  203. package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
  204. package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
  205. package/docs/interfaces/datatypes.TLSEdge.html +323 -0
  206. package/docs/interfaces/datatypes.TLSEdgeCreate.html +266 -0
  207. package/docs/interfaces/{datatypes.EventStreamList.html → datatypes.TLSEdgeList.html} +23 -23
  208. package/docs/interfaces/datatypes.TLSEdgeUpdate.html +285 -0
  209. package/docs/interfaces/datatypes.Tunnel.html +85 -9
  210. package/docs/interfaces/datatypes.TunnelGroupBackend.html +281 -0
  211. package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +205 -0
  212. package/docs/interfaces/datatypes.TunnelGroupBackendList.html +205 -0
  213. package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +219 -0
  214. package/docs/interfaces/datatypes.TunnelList.html +3 -3
  215. package/docs/interfaces/datatypes.TunnelSession.html +10 -10
  216. package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
  217. package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
  218. package/docs/interfaces/{datatypes.EventStreamCreate.html → datatypes.WeightedBackend.html} +44 -44
  219. package/docs/interfaces/datatypes.WeightedBackendCreate.html +205 -0
  220. package/docs/interfaces/datatypes.WeightedBackendList.html +205 -0
  221. package/docs/interfaces/datatypes.WeightedBackendUpdate.html +219 -0
  222. package/docs/modules/datatypes.html +213 -89
  223. package/docs/modules/services.html +89 -33
  224. package/lib/client.d.ts +54 -24
  225. package/lib/client.d.ts.map +1 -1
  226. package/lib/client.js +45 -22
  227. package/lib/client.js.map +1 -1
  228. package/lib/datatypes.d.ts +617 -281
  229. package/lib/datatypes.d.ts.map +1 -1
  230. package/lib/services.d.ts +385 -169
  231. package/lib/services.d.ts.map +1 -1
  232. package/lib/services.js +1432 -597
  233. package/lib/services.js.map +1 -1
  234. package/package.json +2 -2
  235. package/src/client.ts +98 -45
  236. package/src/datatypes.ts +669 -302
  237. package/src/services.ts +1426 -610
  238. package/docs/classes/services.EndpointCircuitBreakerModule.html +0 -369
  239. package/docs/classes/services.EndpointCompressionModule.html +0 -369
  240. package/docs/classes/services.EndpointConfigurations.html +0 -451
  241. package/docs/classes/services.EndpointRequestHeadersModule.html +0 -369
  242. package/docs/classes/services.EndpointWebhookValidationModule.html +0 -369
  243. package/docs/interfaces/datatypes.EndpointLoggingReplace.html +0 -176
  244. package/test/endpointConfigurations.test.js +0 -67
package/lib/services.d.ts CHANGED
@@ -17,6 +17,33 @@ export declare class AbuseReports {
17
17
  */
18
18
  get(arg: datatypes.Item): Promise<datatypes.AbuseReport>;
19
19
  }
20
+ export declare class AgentIngresses {
21
+ private httpClient;
22
+ /** Do not construct this object directly, use the <code>agentIngresses</code> property of an <code>Ngrok</code> client object instead. */
23
+ constructor(httpClient: Wretcher);
24
+ /**
25
+ * Create a new Agent Ingress. The ngrok agent can be configured to connect to ngrok via the new set of addresses on the returned Agent Ingress.
26
+ */
27
+ create(arg: datatypes.AgentIngressCreate): Promise<datatypes.AgentIngress>;
28
+ /**
29
+ * Delete an Agent Ingress by ID
30
+ */
31
+ delete(arg: datatypes.Item): Promise<void>;
32
+ /**
33
+ * Get the details of an Agent Ingress by ID.
34
+ */
35
+ get(arg: datatypes.Item): Promise<datatypes.AgentIngress>;
36
+ /**
37
+ * List all Agent Ingresses owned by this account
38
+ */
39
+ list(): Promise<Array<datatypes.AgentIngress>>;
40
+ private _pagedList;
41
+ private _asyncList;
42
+ /**
43
+ * Update attributes of an Agent Ingress by ID.
44
+ */
45
+ update(arg: datatypes.AgentIngressUpdate): Promise<datatypes.AgentIngress>;
46
+ }
20
47
  /**
21
48
  * API Keys are used to authenticate to the [ngrok
22
49
  API](https://ngrok.com/docs/api#authentication). You may use the API itself
@@ -51,6 +78,115 @@ export declare class APIKeys {
51
78
  */
52
79
  update(arg: datatypes.APIKeyUpdate): Promise<datatypes.APIKey>;
53
80
  }
81
+ /**
82
+ * A Failover backend defines failover behavior within a list of referenced
83
+ backends. Traffic is sent to the first backend in the list. If that backend
84
+ is offline or no connection can be established, ngrok attempts to connect to
85
+ the next backend in the list until one is successful.
86
+ */
87
+ export declare class FailoverBackends {
88
+ private httpClient;
89
+ /** Do not construct this object directly, use the <code>failoverBackends</code> property of an <code>Ngrok</code> client object instead. */
90
+ constructor(httpClient: Wretcher);
91
+ /**
92
+ * Create a new Failover backend
93
+ */
94
+ create(arg: datatypes.FailoverBackendCreate): Promise<datatypes.FailoverBackend>;
95
+ /**
96
+ * Delete a Failover backend by ID. TODO what if used?
97
+ */
98
+ delete(arg: datatypes.Item): Promise<void>;
99
+ /**
100
+ * Get detailed information about a Failover backend by ID
101
+ */
102
+ get(arg: datatypes.Item): Promise<datatypes.FailoverBackend>;
103
+ /**
104
+ * List all Failover backends on this account
105
+ */
106
+ list(): Promise<Array<datatypes.FailoverBackend>>;
107
+ private _pagedList;
108
+ private _asyncList;
109
+ /**
110
+ * Update Failover backend by ID
111
+ */
112
+ update(arg: datatypes.FailoverBackendUpdate): Promise<datatypes.FailoverBackend>;
113
+ }
114
+ export declare class HTTPResponseBackends {
115
+ private httpClient;
116
+ /** Do not construct this object directly, use the <code>httpResponseBackends</code> property of an <code>Ngrok</code> client object instead. */
117
+ constructor(httpClient: Wretcher);
118
+ create(arg: datatypes.HTTPResponseBackendCreate): Promise<datatypes.HTTPResponseBackend>;
119
+ delete(arg: datatypes.Item): Promise<void>;
120
+ get(arg: datatypes.Item): Promise<datatypes.HTTPResponseBackend>;
121
+ list(): Promise<Array<datatypes.HTTPResponseBackend>>;
122
+ private _pagedList;
123
+ private _asyncList;
124
+ update(arg: datatypes.HTTPResponseBackendUpdate): Promise<datatypes.HTTPResponseBackend>;
125
+ }
126
+ /**
127
+ * A Tunnel Group Backend balances traffic among all online tunnels that match
128
+ a label selector.
129
+ */
130
+ export declare class TunnelGroupBackends {
131
+ private httpClient;
132
+ /** Do not construct this object directly, use the <code>tunnelGroupBackends</code> property of an <code>Ngrok</code> client object instead. */
133
+ constructor(httpClient: Wretcher);
134
+ /**
135
+ * Create a new TunnelGroup backend
136
+ */
137
+ create(arg: datatypes.TunnelGroupBackendCreate): Promise<datatypes.TunnelGroupBackend>;
138
+ /**
139
+ * Delete a TunnelGroup backend by ID. TODO what if used?
140
+ */
141
+ delete(arg: datatypes.Item): Promise<void>;
142
+ /**
143
+ * Get detailed information about a TunnelGroup backend by ID
144
+ */
145
+ get(arg: datatypes.Item): Promise<datatypes.TunnelGroupBackend>;
146
+ /**
147
+ * List all TunnelGroup backends on this account
148
+ */
149
+ list(): Promise<Array<datatypes.TunnelGroupBackend>>;
150
+ private _pagedList;
151
+ private _asyncList;
152
+ /**
153
+ * Update TunnelGroup backend by ID
154
+ */
155
+ update(arg: datatypes.TunnelGroupBackendUpdate): Promise<datatypes.TunnelGroupBackend>;
156
+ }
157
+ /**
158
+ * A Weighted Backend balances traffic among the referenced backends. Traffic
159
+ is assigned proportionally to each based on its weight. The percentage of
160
+ traffic is calculated by dividing a backend's weight by the sum of all
161
+ weights.
162
+ */
163
+ export declare class WeightedBackends {
164
+ private httpClient;
165
+ /** Do not construct this object directly, use the <code>weightedBackends</code> property of an <code>Ngrok</code> client object instead. */
166
+ constructor(httpClient: Wretcher);
167
+ /**
168
+ * Create a new Weighted backend
169
+ */
170
+ create(arg: datatypes.WeightedBackendCreate): Promise<datatypes.WeightedBackend>;
171
+ /**
172
+ * Delete a Weighted backend by ID. TODO what if used?
173
+ */
174
+ delete(arg: datatypes.Item): Promise<void>;
175
+ /**
176
+ * Get detailed information about a Weighted backend by ID
177
+ */
178
+ get(arg: datatypes.Item): Promise<datatypes.WeightedBackend>;
179
+ /**
180
+ * List all Weighted backends on this account
181
+ */
182
+ list(): Promise<Array<datatypes.WeightedBackend>>;
183
+ private _pagedList;
184
+ private _asyncList;
185
+ /**
186
+ * Update Weighted backend by ID
187
+ */
188
+ update(arg: datatypes.WeightedBackendUpdate): Promise<datatypes.WeightedBackend>;
189
+ }
54
190
  /**
55
191
  * Certificate Authorities are x509 certificates that are used to sign other
56
192
  x509 certificates. Attach a Certificate Authority to the Mutual TLS module
@@ -118,64 +254,279 @@ export declare class Credentials {
118
254
  */
119
255
  update(arg: datatypes.CredentialUpdate): Promise<datatypes.Credential>;
120
256
  }
121
- /**
122
- * Endpoint Configurations are a reusable group of modules that encapsulate how
123
- traffic to a domain or address is handled. Endpoint configurations are only
124
- applied to Domains and TCP Addresses they have been attached to.
125
- */
126
- export declare class EndpointConfigurations {
257
+ export declare class EdgesHTTPSRoutes {
127
258
  private httpClient;
128
- /** Do not construct this object directly, use the <code>endpointConfigurations</code> property of an <code>Ngrok</code> client object instead. */
259
+ /** Do not construct this object directly, use the <code>edgesHttpsRoutes</code> property of an <code>Ngrok</code> client object instead. */
129
260
  constructor(httpClient: Wretcher);
130
261
  /**
131
- * Create a new endpoint configuration
262
+ * Create an HTTPS Edge Route
132
263
  */
133
- create(arg: datatypes.EndpointConfigurationCreate): Promise<datatypes.EndpointConfiguration>;
264
+ create(arg: datatypes.HTTPSEdgeRouteCreate): Promise<datatypes.HTTPSEdgeRoute>;
134
265
  /**
135
- * Delete an endpoint configuration. This operation will fail if the endpoint configuration is still referenced by any reserved domain or reserved address.
266
+ * Get an HTTPS Edge Route by ID
136
267
  */
137
- delete(arg: datatypes.Item): Promise<void>;
268
+ get(arg: datatypes.EdgeRouteItem): Promise<datatypes.HTTPSEdgeRoute>;
269
+ /**
270
+ * Updates an HTTPS Edge Route by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.
271
+ */
272
+ update(arg: datatypes.HTTPSEdgeRouteUpdate): Promise<datatypes.HTTPSEdgeRoute>;
138
273
  /**
139
- * Returns detailed information about an endpoint configuration
274
+ * Delete an HTTPS Edge Route by ID
140
275
  */
141
- get(arg: datatypes.Item): Promise<datatypes.EndpointConfiguration>;
276
+ delete(arg: datatypes.EdgeRouteItem): Promise<void>;
277
+ }
278
+ export declare class EdgesHTTPS {
279
+ private httpClient;
280
+ /** Do not construct this object directly, use the <code>edgesHttps</code> property of an <code>Ngrok</code> client object instead. */
281
+ constructor(httpClient: Wretcher);
142
282
  /**
143
- * Returns a list of all endpoint configurations on this account
283
+ * Create an HTTPS Edge
144
284
  */
145
- list(): Promise<Array<datatypes.EndpointConfiguration>>;
285
+ create(arg: datatypes.HTTPSEdgeCreate): Promise<datatypes.HTTPSEdge>;
286
+ /**
287
+ * Get an HTTPS Edge by ID
288
+ */
289
+ get(arg: datatypes.Item): Promise<datatypes.HTTPSEdge>;
290
+ /**
291
+ * Returns a list of all HTTPS Edges on this account
292
+ */
293
+ list(): Promise<Array<datatypes.HTTPSEdge>>;
146
294
  private _pagedList;
147
295
  private _asyncList;
148
296
  /**
149
- * Updates an endpoint configuration. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.
297
+ * Updates an HTTPS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.
150
298
  */
151
- update(arg: datatypes.EndpointConfigurationUpdate): Promise<datatypes.EndpointConfiguration>;
299
+ update(arg: datatypes.HTTPSEdgeUpdate): Promise<datatypes.HTTPSEdge>;
300
+ /**
301
+ * Delete an HTTPS Edge by ID
302
+ */
303
+ delete(arg: datatypes.Item): Promise<void>;
304
+ }
305
+ export declare class HTTPSEdgeMutualTLSModule {
306
+ private httpClient;
307
+ /** Do not construct this object directly, use the <code>httpsEdgeMutualTlsModule</code> property of an <code>Ngrok</code> client object instead. */
308
+ constructor(httpClient: Wretcher);
309
+ replace(arg: datatypes.EdgeMutualTLSReplace): Promise<datatypes.EndpointMutualTLS>;
310
+ get(arg: datatypes.Item): Promise<datatypes.EndpointMutualTLS>;
311
+ delete(arg: datatypes.Item): Promise<void>;
312
+ }
313
+ export declare class HTTPSEdgeTLSTerminationModule {
314
+ private httpClient;
315
+ /** Do not construct this object directly, use the <code>httpsEdgeTlsTerminationModule</code> property of an <code>Ngrok</code> client object instead. */
316
+ constructor(httpClient: Wretcher);
317
+ replace(arg: datatypes.EdgeTLSTerminationAtEdgeReplace): Promise<datatypes.EndpointTLSTermination>;
318
+ get(arg: datatypes.Item): Promise<datatypes.EndpointTLSTermination>;
319
+ delete(arg: datatypes.Item): Promise<void>;
320
+ }
321
+ export declare class EdgeRouteBackendModule {
322
+ private httpClient;
323
+ /** Do not construct this object directly, use the <code>edgeRouteBackendModule</code> property of an <code>Ngrok</code> client object instead. */
324
+ constructor(httpClient: Wretcher);
325
+ replace(arg: datatypes.EdgeRouteBackendReplace): Promise<datatypes.EndpointBackend>;
326
+ get(arg: datatypes.EdgeRouteItem): Promise<datatypes.EndpointBackend>;
327
+ delete(arg: datatypes.EdgeRouteItem): Promise<void>;
328
+ }
329
+ export declare class EdgeRouteIPRestrictionModule {
330
+ private httpClient;
331
+ /** Do not construct this object directly, use the <code>edgeRouteIpRestrictionModule</code> property of an <code>Ngrok</code> client object instead. */
332
+ constructor(httpClient: Wretcher);
333
+ replace(arg: datatypes.EdgeRouteIPRestrictionReplace): Promise<datatypes.EndpointIPPolicy>;
334
+ get(arg: datatypes.EdgeRouteItem): Promise<datatypes.EndpointIPPolicy>;
335
+ delete(arg: datatypes.EdgeRouteItem): Promise<void>;
336
+ }
337
+ export declare class EdgeRouteRequestHeadersModule {
338
+ private httpClient;
339
+ /** Do not construct this object directly, use the <code>edgeRouteRequestHeadersModule</code> property of an <code>Ngrok</code> client object instead. */
340
+ constructor(httpClient: Wretcher);
341
+ replace(arg: datatypes.EdgeRouteRequestHeadersReplace): Promise<datatypes.EndpointRequestHeaders>;
342
+ get(arg: datatypes.EdgeRouteItem): Promise<datatypes.EndpointRequestHeaders>;
343
+ delete(arg: datatypes.EdgeRouteItem): Promise<void>;
344
+ }
345
+ export declare class EdgeRouteResponseHeadersModule {
346
+ private httpClient;
347
+ /** Do not construct this object directly, use the <code>edgeRouteResponseHeadersModule</code> property of an <code>Ngrok</code> client object instead. */
348
+ constructor(httpClient: Wretcher);
349
+ replace(arg: datatypes.EdgeRouteResponseHeadersReplace): Promise<datatypes.EndpointResponseHeaders>;
350
+ get(arg: datatypes.EdgeRouteItem): Promise<datatypes.EndpointResponseHeaders>;
351
+ delete(arg: datatypes.EdgeRouteItem): Promise<void>;
352
+ }
353
+ export declare class EdgeRouteCompressionModule {
354
+ private httpClient;
355
+ /** Do not construct this object directly, use the <code>edgeRouteCompressionModule</code> property of an <code>Ngrok</code> client object instead. */
356
+ constructor(httpClient: Wretcher);
357
+ replace(arg: datatypes.EdgeRouteCompressionReplace): Promise<datatypes.EndpointCompression>;
358
+ get(arg: datatypes.EdgeRouteItem): Promise<datatypes.EndpointCompression>;
359
+ delete(arg: datatypes.EdgeRouteItem): Promise<void>;
360
+ }
361
+ export declare class EdgeRouteCircuitBreakerModule {
362
+ private httpClient;
363
+ /** Do not construct this object directly, use the <code>edgeRouteCircuitBreakerModule</code> property of an <code>Ngrok</code> client object instead. */
364
+ constructor(httpClient: Wretcher);
365
+ replace(arg: datatypes.EdgeRouteCircuitBreakerReplace): Promise<datatypes.EndpointCircuitBreaker>;
366
+ get(arg: datatypes.EdgeRouteItem): Promise<datatypes.EndpointCircuitBreaker>;
367
+ delete(arg: datatypes.EdgeRouteItem): Promise<void>;
368
+ }
369
+ export declare class EdgeRouteWebhookVerificationModule {
370
+ private httpClient;
371
+ /** Do not construct this object directly, use the <code>edgeRouteWebhookVerificationModule</code> property of an <code>Ngrok</code> client object instead. */
372
+ constructor(httpClient: Wretcher);
373
+ replace(arg: datatypes.EdgeRouteWebhookVerificationReplace): Promise<datatypes.EndpointWebhookValidation>;
374
+ get(arg: datatypes.EdgeRouteItem): Promise<datatypes.EndpointWebhookValidation>;
375
+ delete(arg: datatypes.EdgeRouteItem): Promise<void>;
376
+ }
377
+ export declare class EdgeRouteOAuthModule {
378
+ private httpClient;
379
+ /** Do not construct this object directly, use the <code>edgeRouteOAuthModule</code> property of an <code>Ngrok</code> client object instead. */
380
+ constructor(httpClient: Wretcher);
381
+ replace(arg: datatypes.EdgeRouteOAuthReplace): Promise<datatypes.EndpointOAuth>;
382
+ get(arg: datatypes.EdgeRouteItem): Promise<datatypes.EndpointOAuth>;
383
+ delete(arg: datatypes.EdgeRouteItem): Promise<void>;
384
+ }
385
+ export declare class EdgeRouteSAMLModule {
386
+ private httpClient;
387
+ /** Do not construct this object directly, use the <code>edgeRouteSamlModule</code> property of an <code>Ngrok</code> client object instead. */
388
+ constructor(httpClient: Wretcher);
389
+ replace(arg: datatypes.EdgeRouteSAMLReplace): Promise<datatypes.EndpointSAML>;
390
+ get(arg: datatypes.EdgeRouteItem): Promise<datatypes.EndpointSAML>;
391
+ delete(arg: datatypes.EdgeRouteItem): Promise<void>;
392
+ }
393
+ export declare class EdgeRouteOIDCModule {
394
+ private httpClient;
395
+ /** Do not construct this object directly, use the <code>edgeRouteOidcModule</code> property of an <code>Ngrok</code> client object instead. */
396
+ constructor(httpClient: Wretcher);
397
+ replace(arg: datatypes.EdgeRouteOIDCReplace): Promise<datatypes.EndpointOIDC>;
398
+ get(arg: datatypes.EdgeRouteItem): Promise<datatypes.EndpointOIDC>;
399
+ delete(arg: datatypes.EdgeRouteItem): Promise<void>;
400
+ }
401
+ export declare class EdgeRouteWebsocketTCPConverterModule {
402
+ private httpClient;
403
+ /** Do not construct this object directly, use the <code>edgeRouteWebsocketTcpConverterModule</code> property of an <code>Ngrok</code> client object instead. */
404
+ constructor(httpClient: Wretcher);
405
+ replace(arg: datatypes.EdgeRouteWebsocketTCPConverterReplace): Promise<datatypes.EndpointWebsocketTCPConverter>;
406
+ get(arg: datatypes.EdgeRouteItem): Promise<datatypes.EndpointWebsocketTCPConverter>;
407
+ delete(arg: datatypes.EdgeRouteItem): Promise<void>;
152
408
  }
153
- export declare class EventStreams {
409
+ export declare class EdgesTCP {
154
410
  private httpClient;
155
- /** Do not construct this object directly, use the <code>eventStreams</code> property of an <code>Ngrok</code> client object instead. */
411
+ /** Do not construct this object directly, use the <code>edgesTcp</code> property of an <code>Ngrok</code> client object instead. */
156
412
  constructor(httpClient: Wretcher);
157
413
  /**
158
- * Create a new Event Stream. It will not apply to anything until you associate it with one or more Endpoint Configs.
414
+ * Create a TCP Edge
415
+ */
416
+ create(arg: datatypes.TCPEdgeCreate): Promise<datatypes.TCPEdge>;
417
+ /**
418
+ * Get a TCP Edge by ID
419
+ */
420
+ get(arg: datatypes.Item): Promise<datatypes.TCPEdge>;
421
+ /**
422
+ * Returns a list of all TCP Edges on this account
423
+ */
424
+ list(): Promise<Array<datatypes.TCPEdge>>;
425
+ private _pagedList;
426
+ private _asyncList;
427
+ /**
428
+ * Updates a TCP Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.
159
429
  */
160
- create(arg: datatypes.EventStreamCreate): Promise<datatypes.EventStream>;
430
+ update(arg: datatypes.TCPEdgeUpdate): Promise<datatypes.TCPEdge>;
161
431
  /**
162
- * Delete an Event Stream. Associated Event Destinations will be preserved.
432
+ * Delete a TCP Edge by ID
163
433
  */
164
434
  delete(arg: datatypes.Item): Promise<void>;
435
+ }
436
+ export declare class TCPEdgeBackendModule {
437
+ private httpClient;
438
+ /** Do not construct this object directly, use the <code>tcpEdgeBackendModule</code> property of an <code>Ngrok</code> client object instead. */
439
+ constructor(httpClient: Wretcher);
440
+ replace(arg: datatypes.EdgeBackendReplace): Promise<datatypes.EndpointBackend>;
441
+ get(arg: datatypes.Item): Promise<datatypes.EndpointBackend>;
442
+ delete(arg: datatypes.Item): Promise<void>;
443
+ }
444
+ export declare class TCPEdgeIPRestrictionModule {
445
+ private httpClient;
446
+ /** Do not construct this object directly, use the <code>tcpEdgeIpRestrictionModule</code> property of an <code>Ngrok</code> client object instead. */
447
+ constructor(httpClient: Wretcher);
448
+ replace(arg: datatypes.EdgeIPRestrictionReplace): Promise<datatypes.EndpointIPPolicy>;
449
+ get(arg: datatypes.Item): Promise<datatypes.EndpointIPPolicy>;
450
+ delete(arg: datatypes.Item): Promise<void>;
451
+ }
452
+ export declare class EdgesTLS {
453
+ private httpClient;
454
+ /** Do not construct this object directly, use the <code>edgesTls</code> property of an <code>Ngrok</code> client object instead. */
455
+ constructor(httpClient: Wretcher);
165
456
  /**
166
- * Get detailed information about an Event Stream by ID.
457
+ * Create a TLS Edge
167
458
  */
168
- get(arg: datatypes.Item): Promise<datatypes.EventStream>;
459
+ create(arg: datatypes.TLSEdgeCreate): Promise<datatypes.TLSEdge>;
169
460
  /**
170
- * List all Event Streams available on this account.
461
+ * Get a TLS Edge by ID
171
462
  */
172
- list(): Promise<Array<datatypes.EventStream>>;
463
+ get(arg: datatypes.Item): Promise<datatypes.TLSEdge>;
464
+ /**
465
+ * Returns a list of all TLS Edges on this account
466
+ */
467
+ list(): Promise<Array<datatypes.TLSEdge>>;
173
468
  private _pagedList;
174
469
  private _asyncList;
175
470
  /**
176
- * Update attributes of an Event Stream by ID.
471
+ * Updates a TLS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.
472
+ */
473
+ update(arg: datatypes.TLSEdgeUpdate): Promise<datatypes.TLSEdge>;
474
+ /**
475
+ * Delete a TLS Edge by ID
177
476
  */
178
- update(arg: datatypes.EventStreamUpdate): Promise<datatypes.EventStream>;
477
+ delete(arg: datatypes.Item): Promise<void>;
478
+ }
479
+ export declare class TLSEdgeBackendModule {
480
+ private httpClient;
481
+ /** Do not construct this object directly, use the <code>tlsEdgeBackendModule</code> property of an <code>Ngrok</code> client object instead. */
482
+ constructor(httpClient: Wretcher);
483
+ replace(arg: datatypes.EdgeBackendReplace): Promise<datatypes.EndpointBackend>;
484
+ get(arg: datatypes.Item): Promise<datatypes.EndpointBackend>;
485
+ delete(arg: datatypes.Item): Promise<void>;
486
+ }
487
+ export declare class TLSEdgeIPRestrictionModule {
488
+ private httpClient;
489
+ /** Do not construct this object directly, use the <code>tlsEdgeIpRestrictionModule</code> property of an <code>Ngrok</code> client object instead. */
490
+ constructor(httpClient: Wretcher);
491
+ replace(arg: datatypes.EdgeIPRestrictionReplace): Promise<datatypes.EndpointIPPolicy>;
492
+ get(arg: datatypes.Item): Promise<datatypes.EndpointIPPolicy>;
493
+ delete(arg: datatypes.Item): Promise<void>;
494
+ }
495
+ export declare class TLSEdgeMutualTLSModule {
496
+ private httpClient;
497
+ /** Do not construct this object directly, use the <code>tlsEdgeMutualTlsModule</code> property of an <code>Ngrok</code> client object instead. */
498
+ constructor(httpClient: Wretcher);
499
+ replace(arg: datatypes.EdgeMutualTLSReplace): Promise<datatypes.EndpointMutualTLS>;
500
+ get(arg: datatypes.Item): Promise<datatypes.EndpointMutualTLS>;
501
+ delete(arg: datatypes.Item): Promise<void>;
502
+ }
503
+ export declare class TLSEdgeTLSTerminationModule {
504
+ private httpClient;
505
+ /** Do not construct this object directly, use the <code>tlsEdgeTlsTerminationModule</code> property of an <code>Ngrok</code> client object instead. */
506
+ constructor(httpClient: Wretcher);
507
+ replace(arg: datatypes.EdgeTLSTerminationReplace): Promise<datatypes.EndpointTLSTermination>;
508
+ get(arg: datatypes.Item): Promise<datatypes.EndpointTLSTermination>;
509
+ delete(arg: datatypes.Item): Promise<void>;
510
+ }
511
+ /**
512
+ * Endpoints provides an API for querying the endpoint objects
513
+ which define what tunnel or edge is used to serve a hostport.
514
+ Only active endpoints associated with a tunnel or backend are returned.
515
+ */
516
+ export declare class Endpoints {
517
+ private httpClient;
518
+ /** Do not construct this object directly, use the <code>endpoints</code> property of an <code>Ngrok</code> client object instead. */
519
+ constructor(httpClient: Wretcher);
520
+ /**
521
+ * List all active endpoints on the account
522
+ */
523
+ list(): Promise<Array<datatypes.Endpoint>>;
524
+ private _pagedList;
525
+ private _asyncList;
526
+ /**
527
+ * Get the status of an endpoint by ID
528
+ */
529
+ get(arg: datatypes.Item): Promise<datatypes.Endpoint>;
179
530
  }
180
531
  export declare class EventDestinations {
181
532
  private httpClient;
@@ -186,7 +537,7 @@ export declare class EventDestinations {
186
537
  */
187
538
  create(arg: datatypes.EventDestinationCreate): Promise<datatypes.EventDestination>;
188
539
  /**
189
- * Delete an Event Destination. If the Event Destination is still referenced by an Event Stream, this will throw an error until that Event Stream has removed that reference.
540
+ * Delete an Event Destination. If the Event Destination is still referenced by an Event Subscription.
190
541
  */
191
542
  delete(arg: datatypes.Item): Promise<void>;
192
543
  /**
@@ -322,7 +673,7 @@ export declare class IPPolicyRules {
322
673
  }
323
674
  /**
324
675
  * An IP restriction is a restriction placed on the CIDRs that are allowed to
325
- initate traffic to a specific aspect of your ngrok account. An IP
676
+ initiate traffic to a specific aspect of your ngrok account. An IP
326
677
  restriction has a type which defines the ingress it applies to. IP
327
678
  restrictions can be used to enforce the source IPs that can make API
328
679
  requests, log in to the dashboard, start ngrok agents, and connect to your
@@ -355,133 +706,6 @@ export declare class IPRestrictions {
355
706
  */
356
707
  update(arg: datatypes.IPRestrictionUpdate): Promise<datatypes.IPRestriction>;
357
708
  }
358
- /**
359
- * The IP Whitelist is deprecated and will be removed. Use an IP Restriction
360
- with an `endpoints` type instead.
361
- */
362
- export declare class IPWhitelist {
363
- private httpClient;
364
- /** Do not construct this object directly, use the <code>ipWhitelist</code> property of an <code>Ngrok</code> client object instead. */
365
- constructor(httpClient: Wretcher);
366
- /**
367
- * Create a new IP whitelist entry that will restrict traffic to all tunnel endpoints on the account.
368
- */
369
- create(arg: datatypes.IPWhitelistEntryCreate): Promise<datatypes.IPWhitelistEntry>;
370
- /**
371
- * Delete an IP whitelist entry.
372
- */
373
- delete(arg: datatypes.Item): Promise<void>;
374
- /**
375
- * Get detailed information about an IP whitelist entry by ID.
376
- */
377
- get(arg: datatypes.Item): Promise<datatypes.IPWhitelistEntry>;
378
- /**
379
- * List all IP whitelist entries on this account
380
- */
381
- list(): Promise<Array<datatypes.IPWhitelistEntry>>;
382
- private _pagedList;
383
- private _asyncList;
384
- /**
385
- * Update attributes of an IP whitelist entry by ID
386
- */
387
- update(arg: datatypes.IPWhitelistEntryUpdate): Promise<datatypes.IPWhitelistEntry>;
388
- }
389
- export declare class EndpointLoggingModule {
390
- private httpClient;
391
- /** Do not construct this object directly, use the <code>endpointLoggingModule</code> property of an <code>Ngrok</code> client object instead. */
392
- constructor(httpClient: Wretcher);
393
- replace(arg: datatypes.EndpointLoggingReplace): Promise<datatypes.EndpointLogging>;
394
- get(arg: datatypes.Item): Promise<datatypes.EndpointLogging>;
395
- delete(arg: datatypes.Item): Promise<void>;
396
- }
397
- export declare class EndpointCircuitBreakerModule {
398
- private httpClient;
399
- /** Do not construct this object directly, use the <code>endpointCircuitBreakerModule</code> property of an <code>Ngrok</code> client object instead. */
400
- constructor(httpClient: Wretcher);
401
- replace(arg: datatypes.EndpointCircuitBreakerReplace): Promise<datatypes.EndpointCircuitBreaker>;
402
- get(arg: datatypes.Item): Promise<datatypes.EndpointCircuitBreaker>;
403
- delete(arg: datatypes.Item): Promise<void>;
404
- }
405
- export declare class EndpointCompressionModule {
406
- private httpClient;
407
- /** Do not construct this object directly, use the <code>endpointCompressionModule</code> property of an <code>Ngrok</code> client object instead. */
408
- constructor(httpClient: Wretcher);
409
- replace(arg: datatypes.EndpointCompressionReplace): Promise<datatypes.EndpointCompression>;
410
- get(arg: datatypes.Item): Promise<datatypes.EndpointCompression>;
411
- delete(arg: datatypes.Item): Promise<void>;
412
- }
413
- export declare class EndpointTLSTerminationModule {
414
- private httpClient;
415
- /** Do not construct this object directly, use the <code>endpointTlsTerminationModule</code> property of an <code>Ngrok</code> client object instead. */
416
- constructor(httpClient: Wretcher);
417
- replace(arg: datatypes.EndpointTLSTerminationReplace): Promise<datatypes.EndpointTLSTermination>;
418
- get(arg: datatypes.Item): Promise<datatypes.EndpointTLSTermination>;
419
- delete(arg: datatypes.Item): Promise<void>;
420
- }
421
- export declare class EndpointIPPolicyModule {
422
- private httpClient;
423
- /** Do not construct this object directly, use the <code>endpointIpPolicyModule</code> property of an <code>Ngrok</code> client object instead. */
424
- constructor(httpClient: Wretcher);
425
- replace(arg: datatypes.EndpointIPPolicyReplace): Promise<datatypes.EndpointIPPolicy>;
426
- get(arg: datatypes.Item): Promise<datatypes.EndpointIPPolicy>;
427
- delete(arg: datatypes.Item): Promise<void>;
428
- }
429
- export declare class EndpointMutualTLSModule {
430
- private httpClient;
431
- /** Do not construct this object directly, use the <code>endpointMutualTlsModule</code> property of an <code>Ngrok</code> client object instead. */
432
- constructor(httpClient: Wretcher);
433
- replace(arg: datatypes.EndpointMutualTLSReplace): Promise<datatypes.EndpointMutualTLS>;
434
- get(arg: datatypes.Item): Promise<datatypes.EndpointMutualTLS>;
435
- delete(arg: datatypes.Item): Promise<void>;
436
- }
437
- export declare class EndpointRequestHeadersModule {
438
- private httpClient;
439
- /** Do not construct this object directly, use the <code>endpointRequestHeadersModule</code> property of an <code>Ngrok</code> client object instead. */
440
- constructor(httpClient: Wretcher);
441
- replace(arg: datatypes.EndpointRequestHeadersReplace): Promise<datatypes.EndpointRequestHeaders>;
442
- get(arg: datatypes.Item): Promise<datatypes.EndpointRequestHeaders>;
443
- delete(arg: datatypes.Item): Promise<void>;
444
- }
445
- export declare class EndpointResponseHeadersModule {
446
- private httpClient;
447
- /** Do not construct this object directly, use the <code>endpointResponseHeadersModule</code> property of an <code>Ngrok</code> client object instead. */
448
- constructor(httpClient: Wretcher);
449
- replace(arg: datatypes.EndpointResponseHeadersReplace): Promise<datatypes.EndpointResponseHeaders>;
450
- get(arg: datatypes.Item): Promise<datatypes.EndpointResponseHeaders>;
451
- delete(arg: datatypes.Item): Promise<void>;
452
- }
453
- export declare class EndpointOAuthModule {
454
- private httpClient;
455
- /** Do not construct this object directly, use the <code>endpointOAuthModule</code> property of an <code>Ngrok</code> client object instead. */
456
- constructor(httpClient: Wretcher);
457
- replace(arg: datatypes.EndpointOAuthReplace): Promise<datatypes.EndpointOAuth>;
458
- get(arg: datatypes.Item): Promise<datatypes.EndpointOAuth>;
459
- delete(arg: datatypes.Item): Promise<void>;
460
- }
461
- export declare class EndpointWebhookValidationModule {
462
- private httpClient;
463
- /** Do not construct this object directly, use the <code>endpointWebhookValidationModule</code> property of an <code>Ngrok</code> client object instead. */
464
- constructor(httpClient: Wretcher);
465
- replace(arg: datatypes.EndpointWebhookValidationReplace): Promise<datatypes.EndpointWebhookValidation>;
466
- get(arg: datatypes.Item): Promise<datatypes.EndpointWebhookValidation>;
467
- delete(arg: datatypes.Item): Promise<void>;
468
- }
469
- export declare class EndpointSAMLModule {
470
- private httpClient;
471
- /** Do not construct this object directly, use the <code>endpointSamlModule</code> property of an <code>Ngrok</code> client object instead. */
472
- constructor(httpClient: Wretcher);
473
- replace(arg: datatypes.EndpointSAMLReplace): Promise<datatypes.EndpointSAML>;
474
- get(arg: datatypes.Item): Promise<datatypes.EndpointSAML>;
475
- delete(arg: datatypes.Item): Promise<void>;
476
- }
477
- export declare class EndpointOIDCModule {
478
- private httpClient;
479
- /** Do not construct this object directly, use the <code>endpointOidcModule</code> property of an <code>Ngrok</code> client object instead. */
480
- constructor(httpClient: Wretcher);
481
- replace(arg: datatypes.EndpointOIDCReplace): Promise<datatypes.EndpointOIDC>;
482
- get(arg: datatypes.Item): Promise<datatypes.EndpointOIDC>;
483
- delete(arg: datatypes.Item): Promise<void>;
484
- }
485
709
  /**
486
710
  * Reserved Addresses are TCP addresses that can be used to listen for traffic.
487
711
  TCP address hostnames and ports are assigned by ngrok, they cannot be
@@ -513,10 +737,6 @@ export declare class ReservedAddrs {
513
737
  * Update the attributes of a reserved address.
514
738
  */
515
739
  update(arg: datatypes.ReservedAddrUpdate): Promise<datatypes.ReservedAddr>;
516
- /**
517
- * Detach the endpoint configuration attached to a reserved address.
518
- */
519
- deleteEndpointConfig(arg: datatypes.Item): Promise<void>;
520
740
  }
521
741
  /**
522
742
  * Reserved Domains are hostnames that you can listen for traffic on. Domains
@@ -558,14 +778,6 @@ export declare class ReservedDomains {
558
778
  * Detach the certificate attached to a reserved domain.
559
779
  */
560
780
  deleteCertificate(arg: datatypes.Item): Promise<void>;
561
- /**
562
- * Detach the http endpoint configuration attached to a reserved domain.
563
- */
564
- deleteHttpEndpointConfig(arg: datatypes.Item): Promise<void>;
565
- /**
566
- * Detach the https endpoint configuration attached to a reserved domain.
567
- */
568
- deleteHttpsEndpointConfig(arg: datatypes.Item): Promise<void>;
569
781
  }
570
782
  /**
571
783
  * An SSH Certificate Authority is a pair of an SSH Certificate and its private
@@ -773,5 +985,9 @@ export declare class Tunnels {
773
985
  list(): Promise<Array<datatypes.Tunnel>>;
774
986
  private _pagedList;
775
987
  private _asyncList;
988
+ /**
989
+ * Get the status of a tunnel by ID
990
+ */
991
+ get(arg: datatypes.Item): Promise<datatypes.Tunnel>;
776
992
  }
777
993
  //# sourceMappingURL=services.d.ts.map