@ngrok/ngrok-api 0.3.0 → 0.7.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 (242) hide show
  1. package/README.md +0 -28
  2. package/docs/assets/js/search.js +1 -1
  3. package/docs/classes/client.Ngrok.html +191 -100
  4. package/docs/classes/services.APIKeys.html +6 -105
  5. package/docs/classes/services.AbuseReports.html +3 -102
  6. package/docs/classes/services.AgentIngresses.html +6 -105
  7. package/docs/classes/services.CertificateAuthorities.html +6 -105
  8. package/docs/classes/services.Credentials.html +6 -105
  9. package/docs/classes/services.EdgeRouteBackendModule.html +270 -0
  10. package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +270 -0
  11. package/docs/classes/services.EdgeRouteCompressionModule.html +270 -0
  12. package/docs/classes/{services.EndpointCircuitBreakerModule.html → services.EdgeRouteIPRestrictionModule.html} +28 -127
  13. package/docs/classes/services.EdgeRouteOAuthModule.html +270 -0
  14. package/docs/classes/services.EdgeRouteOIDCModule.html +270 -0
  15. package/docs/classes/{services.EndpointResponseHeadersModule.html → services.EdgeRouteRequestHeadersModule.html} +28 -127
  16. package/docs/classes/services.EdgeRouteResponseHeadersModule.html +270 -0
  17. package/docs/classes/services.EdgeRouteSAMLModule.html +270 -0
  18. package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +270 -0
  19. package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +270 -0
  20. package/docs/classes/services.EdgesHTTPS.html +343 -0
  21. package/docs/classes/services.EdgesHTTPSRoutes.html +317 -0
  22. package/docs/classes/services.EdgesTCP.html +343 -0
  23. package/docs/classes/services.EdgesTLS.html +343 -0
  24. package/docs/classes/services.Endpoints.html +256 -0
  25. package/docs/classes/services.EventDestinations.html +7 -106
  26. package/docs/classes/services.EventSources.html +6 -105
  27. package/docs/classes/services.EventSubscriptions.html +6 -105
  28. package/docs/classes/services.FailoverBackends.html +353 -0
  29. package/docs/classes/services.HTTPResponseBackends.html +318 -0
  30. package/docs/classes/{services.EndpointMutualTLSModule.html → services.HTTPSEdgeMutualTLSModule.html} +22 -121
  31. package/docs/classes/{services.EndpointTLSTerminationModule.html → services.HTTPSEdgeTLSTerminationModule.html} +22 -121
  32. package/docs/classes/services.IPPolicies.html +6 -105
  33. package/docs/classes/services.IPPolicyRules.html +6 -105
  34. package/docs/classes/services.IPRestrictions.html +7 -106
  35. package/docs/classes/services.ReservedAddrs.html +6 -137
  36. package/docs/classes/services.ReservedDomains.html +8 -171
  37. package/docs/classes/services.SSHCertificateAuthorities.html +6 -105
  38. package/docs/classes/services.SSHCredentials.html +6 -105
  39. package/docs/classes/services.SSHHostCertificates.html +6 -105
  40. package/docs/classes/services.SSHUserCertificates.html +6 -105
  41. package/docs/classes/{services.EndpointSAMLModule.html → services.TCPEdgeBackendModule.html} +25 -124
  42. package/docs/classes/{services.EndpointIPPolicyModule.html → services.TCPEdgeIPRestrictionModule.html} +22 -121
  43. package/docs/classes/services.TLSCertificates.html +6 -105
  44. package/docs/classes/{services.EndpointLoggingModule.html → services.TLSEdgeBackendModule.html} +25 -124
  45. package/docs/classes/{services.EndpointOIDCModule.html → services.TLSEdgeIPRestrictionModule.html} +25 -124
  46. package/docs/classes/{services.EndpointOAuthModule.html → services.TLSEdgeMutualTLSModule.html} +25 -124
  47. package/docs/classes/services.TLSEdgeTLSTerminationModule.html +270 -0
  48. package/docs/classes/services.TunnelGroupBackends.html +351 -0
  49. package/docs/classes/services.TunnelSessions.html +6 -105
  50. package/docs/classes/services.Tunnels.html +34 -101
  51. package/docs/classes/{services.EventStreams.html → services.WeightedBackends.html} +51 -140
  52. package/docs/index.html +0 -27
  53. package/docs/interfaces/client.NgrokConfig.html +2 -2
  54. package/docs/interfaces/datatypes.APIKey.html +6 -6
  55. package/docs/interfaces/datatypes.APIKeyCreate.html +2 -2
  56. package/docs/interfaces/datatypes.APIKeyList.html +3 -3
  57. package/docs/interfaces/datatypes.APIKeyUpdate.html +3 -3
  58. package/docs/interfaces/datatypes.AWSAuth.html +2 -2
  59. package/docs/interfaces/datatypes.AWSCredentials.html +2 -2
  60. package/docs/interfaces/datatypes.AWSRole.html +1 -1
  61. package/docs/interfaces/datatypes.AbuseReport.html +7 -7
  62. package/docs/interfaces/datatypes.AbuseReportCreate.html +2 -2
  63. package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
  64. package/docs/interfaces/datatypes.AgentIngress.html +8 -8
  65. package/docs/interfaces/datatypes.AgentIngressCreate.html +3 -3
  66. package/docs/interfaces/datatypes.AgentIngressList.html +3 -3
  67. package/docs/interfaces/datatypes.AgentIngressUpdate.html +3 -3
  68. package/docs/interfaces/datatypes.CertificateAuthority.html +11 -11
  69. package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +3 -3
  70. package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
  71. package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
  72. package/docs/interfaces/datatypes.Credential.html +7 -7
  73. package/docs/interfaces/datatypes.CredentialCreate.html +3 -3
  74. package/docs/interfaces/datatypes.CredentialList.html +3 -3
  75. package/docs/interfaces/datatypes.CredentialUpdate.html +4 -4
  76. package/docs/interfaces/{datatypes.EndpointOIDCReplace.html → datatypes.EdgeBackendReplace.html} +12 -12
  77. package/docs/interfaces/{datatypes.EndpointIPPolicyReplace.html → datatypes.EdgeIPRestrictionReplace.html} +11 -11
  78. package/docs/interfaces/{datatypes.EndpointMutualTLSReplace.html → datatypes.EdgeMutualTLSReplace.html} +11 -11
  79. package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +190 -0
  80. package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +190 -0
  81. package/docs/interfaces/{datatypes.EndpointCompressionReplace.html → datatypes.EdgeRouteCompressionReplace.html} +25 -11
  82. package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +190 -0
  83. package/docs/interfaces/{datatypes.EndpointCircuitBreakerReplace.html → datatypes.EdgeRouteItem.html} +27 -17
  84. package/docs/interfaces/{datatypes.EndpointOAuthReplace.html → datatypes.EdgeRouteOAuthReplace.html} +25 -11
  85. package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +190 -0
  86. package/docs/interfaces/{datatypes.EndpointRequestHeadersReplace.html → datatypes.EdgeRouteRequestHeadersReplace.html} +25 -11
  87. package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +190 -0
  88. package/docs/interfaces/{datatypes.EndpointSAMLReplace.html → datatypes.EdgeRouteSAMLReplace.html} +25 -11
  89. package/docs/interfaces/{datatypes.EndpointWebhookValidationReplace.html → datatypes.EdgeRouteWebhookVerificationReplace.html} +25 -11
  90. package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +190 -0
  91. package/docs/interfaces/{datatypes.EndpointResponseHeadersReplace.html → datatypes.EdgeTLSTerminationAtEdgeReplace.html} +12 -12
  92. package/docs/interfaces/{datatypes.EndpointTLSTerminationReplace.html → datatypes.EdgeTLSTerminationReplace.html} +11 -11
  93. package/docs/interfaces/datatypes.Endpoint.html +395 -0
  94. package/docs/interfaces/{datatypes.EndpointLogging.html → datatypes.EndpointBackend.html} +19 -19
  95. package/docs/interfaces/{datatypes.EndpointLoggingMutate.html → datatypes.EndpointBackendMutate.html} +19 -19
  96. package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
  97. package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
  98. package/docs/interfaces/datatypes.EndpointIPPolicy.html +2 -2
  99. package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
  100. package/docs/interfaces/datatypes.EndpointList.html +205 -0
  101. package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
  102. package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +2 -2
  103. package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
  104. package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
  105. package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +7 -7
  106. package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
  107. package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
  108. package/docs/interfaces/datatypes.EndpointOAuthProvider.html +4 -4
  109. package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
  110. package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
  111. package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
  112. package/docs/interfaces/datatypes.EndpointSAML.html +15 -15
  113. package/docs/interfaces/datatypes.EndpointSAMLMutate.html +10 -10
  114. package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
  115. package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +186 -0
  116. package/docs/interfaces/datatypes.EndpointWebhookValidation.html +4 -4
  117. package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +167 -0
  118. package/docs/interfaces/datatypes.Error.html +4 -4
  119. package/docs/interfaces/datatypes.EventDestination.html +7 -7
  120. package/docs/interfaces/datatypes.EventDestinationCreate.html +4 -4
  121. package/docs/interfaces/datatypes.EventDestinationList.html +3 -3
  122. package/docs/interfaces/datatypes.EventDestinationUpdate.html +5 -5
  123. package/docs/interfaces/datatypes.EventSource.html +2 -2
  124. package/docs/interfaces/datatypes.EventSourceCreate.html +2 -2
  125. package/docs/interfaces/datatypes.EventSourceItem.html +2 -2
  126. package/docs/interfaces/datatypes.EventSourceList.html +2 -2
  127. package/docs/interfaces/datatypes.EventSourcePaging.html +1 -1
  128. package/docs/interfaces/datatypes.EventSourceReplace.html +1 -1
  129. package/docs/interfaces/datatypes.EventSourceUpdate.html +2 -2
  130. package/docs/interfaces/datatypes.EventSubscription.html +7 -7
  131. package/docs/interfaces/datatypes.EventSubscriptionCreate.html +5 -5
  132. package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
  133. package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +6 -6
  134. package/docs/interfaces/datatypes.EventTarget.html +3 -3
  135. package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
  136. package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
  137. package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
  138. package/docs/interfaces/{datatypes.EventStreamCreate.html → datatypes.FailoverBackend.html} +44 -44
  139. package/docs/interfaces/datatypes.FailoverBackendCreate.html +205 -0
  140. package/docs/interfaces/datatypes.FailoverBackendList.html +205 -0
  141. package/docs/interfaces/datatypes.FailoverBackendUpdate.html +219 -0
  142. package/docs/interfaces/datatypes.HTTPResponseBackend.html +295 -0
  143. package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +243 -0
  144. package/docs/interfaces/datatypes.HTTPResponseBackendList.html +190 -0
  145. package/docs/interfaces/{datatypes.EventStreamUpdate.html → datatypes.HTTPResponseBackendUpdate.html} +40 -45
  146. package/docs/interfaces/{datatypes.EventStream.html → datatypes.HTTPSEdge.html} +58 -63
  147. package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +238 -0
  148. package/docs/interfaces/{datatypes.EventStreamList.html → datatypes.HTTPSEdgeList.html} +20 -20
  149. package/docs/interfaces/{datatypes.EndpointConfiguration.html → datatypes.HTTPSEdgeRoute.html} +123 -104
  150. package/docs/interfaces/{datatypes.EndpointConfigurationCreate.html → datatypes.HTTPSEdgeRouteCreate.html} +108 -89
  151. package/docs/interfaces/{datatypes.EndpointConfigurationUpdate.html → datatypes.HTTPSEdgeRouteUpdate.html} +115 -77
  152. package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +257 -0
  153. package/docs/interfaces/datatypes.IPPolicy.html +5 -24
  154. package/docs/interfaces/datatypes.IPPolicyCreate.html +2 -21
  155. package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
  156. package/docs/interfaces/datatypes.IPPolicyRule.html +26 -7
  157. package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +23 -4
  158. package/docs/interfaces/datatypes.IPPolicyRuleList.html +3 -3
  159. package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +4 -4
  160. package/docs/interfaces/datatypes.IPPolicyUpdate.html +3 -3
  161. package/docs/interfaces/datatypes.IPRestriction.html +8 -8
  162. package/docs/interfaces/datatypes.IPRestrictionCreate.html +5 -5
  163. package/docs/interfaces/datatypes.IPRestrictionList.html +3 -3
  164. package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
  165. package/docs/interfaces/datatypes.Item.html +1 -1
  166. package/docs/interfaces/datatypes.Paging.html +2 -2
  167. package/docs/interfaces/datatypes.Ref.html +2 -2
  168. package/docs/interfaces/datatypes.ReservedAddr.html +7 -26
  169. package/docs/interfaces/datatypes.ReservedAddrCreate.html +3 -22
  170. package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
  171. package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -22
  172. package/docs/interfaces/datatypes.ReservedDomain.html +12 -50
  173. package/docs/interfaces/datatypes.ReservedDomainCertJob.html +4 -4
  174. package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
  175. package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +2 -2
  176. package/docs/interfaces/datatypes.ReservedDomainCreate.html +6 -44
  177. package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
  178. package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -43
  179. package/docs/interfaces/datatypes.SSHCertificateAuthority.html +7 -7
  180. package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +5 -5
  181. package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
  182. package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
  183. package/docs/interfaces/datatypes.SSHCredential.html +7 -7
  184. package/docs/interfaces/datatypes.SSHCredentialCreate.html +4 -4
  185. package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
  186. package/docs/interfaces/datatypes.SSHCredentialUpdate.html +4 -4
  187. package/docs/interfaces/datatypes.SSHHostCertificate.html +12 -12
  188. package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +7 -7
  189. package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
  190. package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
  191. package/docs/interfaces/datatypes.SSHUserCertificate.html +14 -14
  192. package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +9 -9
  193. package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
  194. package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
  195. package/docs/interfaces/datatypes.TCPEdge.html +295 -0
  196. package/docs/interfaces/datatypes.TCPEdgeCreate.html +238 -0
  197. package/docs/interfaces/datatypes.TCPEdgeList.html +205 -0
  198. package/docs/interfaces/datatypes.TCPEdgeUpdate.html +257 -0
  199. package/docs/interfaces/datatypes.TLSCertificate.html +21 -21
  200. package/docs/interfaces/datatypes.TLSCertificateCreate.html +4 -4
  201. package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
  202. package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
  203. package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
  204. package/docs/interfaces/datatypes.TLSEdge.html +323 -0
  205. package/docs/interfaces/datatypes.TLSEdgeCreate.html +266 -0
  206. package/docs/interfaces/datatypes.TLSEdgeList.html +205 -0
  207. package/docs/interfaces/datatypes.TLSEdgeUpdate.html +285 -0
  208. package/docs/interfaces/datatypes.Tunnel.html +85 -9
  209. package/docs/interfaces/datatypes.TunnelGroupBackend.html +281 -0
  210. package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +205 -0
  211. package/docs/interfaces/datatypes.TunnelGroupBackendList.html +205 -0
  212. package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +219 -0
  213. package/docs/interfaces/datatypes.TunnelList.html +3 -3
  214. package/docs/interfaces/datatypes.TunnelSession.html +10 -10
  215. package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
  216. package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
  217. package/docs/interfaces/datatypes.WeightedBackend.html +262 -0
  218. package/docs/interfaces/datatypes.WeightedBackendCreate.html +205 -0
  219. package/docs/interfaces/{datatypes.EndpointConfigurationList.html → datatypes.WeightedBackendList.html} +19 -19
  220. package/docs/interfaces/datatypes.WeightedBackendUpdate.html +219 -0
  221. package/docs/modules/datatypes.html +197 -69
  222. package/docs/modules/services.html +85 -29
  223. package/lib/client.d.ts +53 -19
  224. package/lib/client.d.ts.map +1 -1
  225. package/lib/client.js +42 -18
  226. package/lib/client.js.map +1 -1
  227. package/lib/datatypes.d.ts +570 -236
  228. package/lib/datatypes.d.ts.map +1 -1
  229. package/lib/services.d.ts +358 -138
  230. package/lib/services.d.ts.map +1 -1
  231. package/lib/services.js +1367 -528
  232. package/lib/services.js.map +1 -1
  233. package/package.json +2 -2
  234. package/src/client.ts +95 -38
  235. package/src/datatypes.ts +618 -252
  236. package/src/services.ts +1363 -543
  237. package/docs/classes/services.EndpointCompressionModule.html +0 -369
  238. package/docs/classes/services.EndpointConfigurations.html +0 -451
  239. package/docs/classes/services.EndpointRequestHeadersModule.html +0 -369
  240. package/docs/classes/services.EndpointWebhookValidationModule.html +0 -369
  241. package/docs/interfaces/datatypes.EndpointLoggingReplace.html +0 -176
  242. package/test/endpointConfigurations.test.js +0 -67
package/lib/services.d.ts CHANGED
@@ -78,6 +78,115 @@ export declare class APIKeys {
78
78
  */
79
79
  update(arg: datatypes.APIKeyUpdate): Promise<datatypes.APIKey>;
80
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
+ }
81
190
  /**
82
191
  * Certificate Authorities are x509 certificates that are used to sign other
83
192
  x509 certificates. Attach a Certificate Authority to the Mutual TLS module
@@ -145,64 +254,279 @@ export declare class Credentials {
145
254
  */
146
255
  update(arg: datatypes.CredentialUpdate): Promise<datatypes.Credential>;
147
256
  }
148
- /**
149
- * Endpoint Configurations are a reusable group of modules that encapsulate how
150
- traffic to a domain or address is handled. Endpoint configurations are only
151
- applied to Domains and TCP Addresses they have been attached to.
152
- */
153
- export declare class EndpointConfigurations {
257
+ export declare class EdgesHTTPSRoutes {
154
258
  private httpClient;
155
- /** 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. */
156
260
  constructor(httpClient: Wretcher);
157
261
  /**
158
- * Create a new endpoint configuration
262
+ * Create an HTTPS Edge Route
159
263
  */
160
- create(arg: datatypes.EndpointConfigurationCreate): Promise<datatypes.EndpointConfiguration>;
264
+ create(arg: datatypes.HTTPSEdgeRouteCreate): Promise<datatypes.HTTPSEdgeRoute>;
161
265
  /**
162
- * 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
163
267
  */
164
- delete(arg: datatypes.Item): Promise<void>;
268
+ get(arg: datatypes.EdgeRouteItem): Promise<datatypes.HTTPSEdgeRoute>;
165
269
  /**
166
- * Returns detailed information about an endpoint configuration
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.
167
271
  */
168
- get(arg: datatypes.Item): Promise<datatypes.EndpointConfiguration>;
272
+ update(arg: datatypes.HTTPSEdgeRouteUpdate): Promise<datatypes.HTTPSEdgeRoute>;
169
273
  /**
170
- * Returns a list of all endpoint configurations on this account
274
+ * Delete an HTTPS Edge Route by ID
171
275
  */
172
- list(): Promise<Array<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);
282
+ /**
283
+ * Create an HTTPS Edge
284
+ */
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>>;
173
294
  private _pagedList;
174
295
  private _asyncList;
175
296
  /**
176
- * 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.
177
298
  */
178
- 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>;
179
408
  }
180
- export declare class EventStreams {
409
+ export declare class EdgesTCP {
181
410
  private httpClient;
182
- /** 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. */
183
412
  constructor(httpClient: Wretcher);
184
413
  /**
185
- * 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
186
419
  */
187
- create(arg: datatypes.EventStreamCreate): Promise<datatypes.EventStream>;
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;
188
427
  /**
189
- * Delete an Event Stream. Associated Event Destinations will be preserved.
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.
429
+ */
430
+ update(arg: datatypes.TCPEdgeUpdate): Promise<datatypes.TCPEdge>;
431
+ /**
432
+ * Delete a TCP Edge by ID
190
433
  */
191
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);
456
+ /**
457
+ * Create a TLS Edge
458
+ */
459
+ create(arg: datatypes.TLSEdgeCreate): Promise<datatypes.TLSEdge>;
460
+ /**
461
+ * Get a TLS Edge by ID
462
+ */
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>>;
468
+ private _pagedList;
469
+ private _asyncList;
192
470
  /**
193
- * Get detailed information about 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.
194
472
  */
195
- get(arg: datatypes.Item): Promise<datatypes.EventStream>;
473
+ update(arg: datatypes.TLSEdgeUpdate): Promise<datatypes.TLSEdge>;
196
474
  /**
197
- * List all Event Streams available on this account.
475
+ * Delete a TLS Edge by ID
198
476
  */
199
- list(): Promise<Array<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>>;
200
524
  private _pagedList;
201
525
  private _asyncList;
202
526
  /**
203
- * Update attributes of an Event Stream by ID.
527
+ * Get the status of an endpoint by ID
204
528
  */
205
- update(arg: datatypes.EventStreamUpdate): Promise<datatypes.EventStream>;
529
+ get(arg: datatypes.Item): Promise<datatypes.Endpoint>;
206
530
  }
207
531
  export declare class EventDestinations {
208
532
  private httpClient;
@@ -213,7 +537,7 @@ export declare class EventDestinations {
213
537
  */
214
538
  create(arg: datatypes.EventDestinationCreate): Promise<datatypes.EventDestination>;
215
539
  /**
216
- * 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.
217
541
  */
218
542
  delete(arg: datatypes.Item): Promise<void>;
219
543
  /**
@@ -349,7 +673,7 @@ export declare class IPPolicyRules {
349
673
  }
350
674
  /**
351
675
  * An IP restriction is a restriction placed on the CIDRs that are allowed to
352
- 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
353
677
  restriction has a type which defines the ingress it applies to. IP
354
678
  restrictions can be used to enforce the source IPs that can make API
355
679
  requests, log in to the dashboard, start ngrok agents, and connect to your
@@ -382,102 +706,6 @@ export declare class IPRestrictions {
382
706
  */
383
707
  update(arg: datatypes.IPRestrictionUpdate): Promise<datatypes.IPRestriction>;
384
708
  }
385
- export declare class EndpointLoggingModule {
386
- private httpClient;
387
- /** Do not construct this object directly, use the <code>endpointLoggingModule</code> property of an <code>Ngrok</code> client object instead. */
388
- constructor(httpClient: Wretcher);
389
- replace(arg: datatypes.EndpointLoggingReplace): Promise<datatypes.EndpointLogging>;
390
- get(arg: datatypes.Item): Promise<datatypes.EndpointLogging>;
391
- delete(arg: datatypes.Item): Promise<void>;
392
- }
393
- export declare class EndpointCircuitBreakerModule {
394
- private httpClient;
395
- /** Do not construct this object directly, use the <code>endpointCircuitBreakerModule</code> property of an <code>Ngrok</code> client object instead. */
396
- constructor(httpClient: Wretcher);
397
- replace(arg: datatypes.EndpointCircuitBreakerReplace): Promise<datatypes.EndpointCircuitBreaker>;
398
- get(arg: datatypes.Item): Promise<datatypes.EndpointCircuitBreaker>;
399
- delete(arg: datatypes.Item): Promise<void>;
400
- }
401
- export declare class EndpointCompressionModule {
402
- private httpClient;
403
- /** Do not construct this object directly, use the <code>endpointCompressionModule</code> property of an <code>Ngrok</code> client object instead. */
404
- constructor(httpClient: Wretcher);
405
- replace(arg: datatypes.EndpointCompressionReplace): Promise<datatypes.EndpointCompression>;
406
- get(arg: datatypes.Item): Promise<datatypes.EndpointCompression>;
407
- delete(arg: datatypes.Item): Promise<void>;
408
- }
409
- export declare class EndpointTLSTerminationModule {
410
- private httpClient;
411
- /** Do not construct this object directly, use the <code>endpointTlsTerminationModule</code> property of an <code>Ngrok</code> client object instead. */
412
- constructor(httpClient: Wretcher);
413
- replace(arg: datatypes.EndpointTLSTerminationReplace): Promise<datatypes.EndpointTLSTermination>;
414
- get(arg: datatypes.Item): Promise<datatypes.EndpointTLSTermination>;
415
- delete(arg: datatypes.Item): Promise<void>;
416
- }
417
- export declare class EndpointIPPolicyModule {
418
- private httpClient;
419
- /** Do not construct this object directly, use the <code>endpointIpPolicyModule</code> property of an <code>Ngrok</code> client object instead. */
420
- constructor(httpClient: Wretcher);
421
- replace(arg: datatypes.EndpointIPPolicyReplace): Promise<datatypes.EndpointIPPolicy>;
422
- get(arg: datatypes.Item): Promise<datatypes.EndpointIPPolicy>;
423
- delete(arg: datatypes.Item): Promise<void>;
424
- }
425
- export declare class EndpointMutualTLSModule {
426
- private httpClient;
427
- /** Do not construct this object directly, use the <code>endpointMutualTlsModule</code> property of an <code>Ngrok</code> client object instead. */
428
- constructor(httpClient: Wretcher);
429
- replace(arg: datatypes.EndpointMutualTLSReplace): Promise<datatypes.EndpointMutualTLS>;
430
- get(arg: datatypes.Item): Promise<datatypes.EndpointMutualTLS>;
431
- delete(arg: datatypes.Item): Promise<void>;
432
- }
433
- export declare class EndpointRequestHeadersModule {
434
- private httpClient;
435
- /** Do not construct this object directly, use the <code>endpointRequestHeadersModule</code> property of an <code>Ngrok</code> client object instead. */
436
- constructor(httpClient: Wretcher);
437
- replace(arg: datatypes.EndpointRequestHeadersReplace): Promise<datatypes.EndpointRequestHeaders>;
438
- get(arg: datatypes.Item): Promise<datatypes.EndpointRequestHeaders>;
439
- delete(arg: datatypes.Item): Promise<void>;
440
- }
441
- export declare class EndpointResponseHeadersModule {
442
- private httpClient;
443
- /** Do not construct this object directly, use the <code>endpointResponseHeadersModule</code> property of an <code>Ngrok</code> client object instead. */
444
- constructor(httpClient: Wretcher);
445
- replace(arg: datatypes.EndpointResponseHeadersReplace): Promise<datatypes.EndpointResponseHeaders>;
446
- get(arg: datatypes.Item): Promise<datatypes.EndpointResponseHeaders>;
447
- delete(arg: datatypes.Item): Promise<void>;
448
- }
449
- export declare class EndpointOAuthModule {
450
- private httpClient;
451
- /** Do not construct this object directly, use the <code>endpointOAuthModule</code> property of an <code>Ngrok</code> client object instead. */
452
- constructor(httpClient: Wretcher);
453
- replace(arg: datatypes.EndpointOAuthReplace): Promise<datatypes.EndpointOAuth>;
454
- get(arg: datatypes.Item): Promise<datatypes.EndpointOAuth>;
455
- delete(arg: datatypes.Item): Promise<void>;
456
- }
457
- export declare class EndpointWebhookValidationModule {
458
- private httpClient;
459
- /** Do not construct this object directly, use the <code>endpointWebhookValidationModule</code> property of an <code>Ngrok</code> client object instead. */
460
- constructor(httpClient: Wretcher);
461
- replace(arg: datatypes.EndpointWebhookValidationReplace): Promise<datatypes.EndpointWebhookValidation>;
462
- get(arg: datatypes.Item): Promise<datatypes.EndpointWebhookValidation>;
463
- delete(arg: datatypes.Item): Promise<void>;
464
- }
465
- export declare class EndpointSAMLModule {
466
- private httpClient;
467
- /** Do not construct this object directly, use the <code>endpointSamlModule</code> property of an <code>Ngrok</code> client object instead. */
468
- constructor(httpClient: Wretcher);
469
- replace(arg: datatypes.EndpointSAMLReplace): Promise<datatypes.EndpointSAML>;
470
- get(arg: datatypes.Item): Promise<datatypes.EndpointSAML>;
471
- delete(arg: datatypes.Item): Promise<void>;
472
- }
473
- export declare class EndpointOIDCModule {
474
- private httpClient;
475
- /** Do not construct this object directly, use the <code>endpointOidcModule</code> property of an <code>Ngrok</code> client object instead. */
476
- constructor(httpClient: Wretcher);
477
- replace(arg: datatypes.EndpointOIDCReplace): Promise<datatypes.EndpointOIDC>;
478
- get(arg: datatypes.Item): Promise<datatypes.EndpointOIDC>;
479
- delete(arg: datatypes.Item): Promise<void>;
480
- }
481
709
  /**
482
710
  * Reserved Addresses are TCP addresses that can be used to listen for traffic.
483
711
  TCP address hostnames and ports are assigned by ngrok, they cannot be
@@ -509,10 +737,6 @@ export declare class ReservedAddrs {
509
737
  * Update the attributes of a reserved address.
510
738
  */
511
739
  update(arg: datatypes.ReservedAddrUpdate): Promise<datatypes.ReservedAddr>;
512
- /**
513
- * Detach the endpoint configuration attached to a reserved address.
514
- */
515
- deleteEndpointConfig(arg: datatypes.Item): Promise<void>;
516
740
  }
517
741
  /**
518
742
  * Reserved Domains are hostnames that you can listen for traffic on. Domains
@@ -554,14 +778,6 @@ export declare class ReservedDomains {
554
778
  * Detach the certificate attached to a reserved domain.
555
779
  */
556
780
  deleteCertificate(arg: datatypes.Item): Promise<void>;
557
- /**
558
- * Detach the http endpoint configuration attached to a reserved domain.
559
- */
560
- deleteHttpEndpointConfig(arg: datatypes.Item): Promise<void>;
561
- /**
562
- * Detach the https endpoint configuration attached to a reserved domain.
563
- */
564
- deleteHttpsEndpointConfig(arg: datatypes.Item): Promise<void>;
565
781
  }
566
782
  /**
567
783
  * An SSH Certificate Authority is a pair of an SSH Certificate and its private
@@ -769,5 +985,9 @@ export declare class Tunnels {
769
985
  list(): Promise<Array<datatypes.Tunnel>>;
770
986
  private _pagedList;
771
987
  private _asyncList;
988
+ /**
989
+ * Get the status of a tunnel by ID
990
+ */
991
+ get(arg: datatypes.Item): Promise<datatypes.Tunnel>;
772
992
  }
773
993
  //# sourceMappingURL=services.d.ts.map