@ngrok/ngrok-api 0.3.0 → 0.9.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 +21 -44
  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 +22 -43
  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 +8 -8
  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 +3 -3
  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 +4 -4
  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 +15 -15
  192. package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +10 -10
  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 +43 -19
  226. package/lib/client.js.map +1 -1
  227. package/lib/datatypes.d.ts +575 -241
  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 +96 -39
  235. package/src/datatypes.ts +623 -257
  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
@@ -121,7 +121,7 @@
121
121
  <li class="tsd-description">
122
122
  <aside class="tsd-sources">
123
123
  <ul>
124
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L355">services.ts:355</a></li>
124
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L748">services.ts:748</a></li>
125
125
  </ul>
126
126
  </aside>
127
127
  <div class="tsd-comment tsd-typography">
@@ -152,7 +152,7 @@
152
152
  <li class="tsd-description">
153
153
  <aside class="tsd-sources">
154
154
  <ul>
155
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L361">services.ts:361</a></li>
155
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L754">services.ts:754</a></li>
156
156
  </ul>
157
157
  </aside>
158
158
  <div class="tsd-comment tsd-typography">
@@ -180,7 +180,7 @@
180
180
  <li class="tsd-description">
181
181
  <aside class="tsd-sources">
182
182
  <ul>
183
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L374">services.ts:374</a></li>
183
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L767">services.ts:767</a></li>
184
184
  </ul>
185
185
  </aside>
186
186
  <div class="tsd-comment tsd-typography">
@@ -208,7 +208,7 @@
208
208
  <li class="tsd-description">
209
209
  <aside class="tsd-sources">
210
210
  <ul>
211
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L385">services.ts:385</a></li>
211
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L778">services.ts:778</a></li>
212
212
  </ul>
213
213
  </aside>
214
214
  <div class="tsd-comment tsd-typography">
@@ -236,7 +236,7 @@
236
236
  <li class="tsd-description">
237
237
  <aside class="tsd-sources">
238
238
  <ul>
239
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L396">services.ts:396</a></li>
239
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L789">services.ts:789</a></li>
240
240
  </ul>
241
241
  </aside>
242
242
  <div class="tsd-comment tsd-typography">
@@ -258,7 +258,7 @@
258
258
  <li class="tsd-description">
259
259
  <aside class="tsd-sources">
260
260
  <ul>
261
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L436">services.ts:436</a></li>
261
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L829">services.ts:829</a></li>
262
262
  </ul>
263
263
  </aside>
264
264
  <div class="tsd-comment tsd-typography">
@@ -297,18 +297,6 @@
297
297
  </nav>
298
298
  <nav class="tsd-navigation secondary menu-sticky">
299
299
  <ul class="before-current">
300
- <li class=" tsd-kind-class tsd-parent-kind-module">
301
- <a href="services.APIKeys.html" class="tsd-kind-icon">APIKeys</a>
302
- </li>
303
- <li class=" tsd-kind-class tsd-parent-kind-module">
304
- <a href="services.AbuseReports.html" class="tsd-kind-icon">Abuse<wbr>Reports</a>
305
- </li>
306
- <li class=" tsd-kind-class tsd-parent-kind-module">
307
- <a href="services.AgentIngresses.html" class="tsd-kind-icon">Agent<wbr>Ingresses</a>
308
- </li>
309
- <li class=" tsd-kind-class tsd-parent-kind-module">
310
- <a href="services.CertificateAuthorities.html" class="tsd-kind-icon">Certificate<wbr>Authorities</a>
311
- </li>
312
300
  </ul>
313
301
  <ul class="current">
314
302
  <li class="current tsd-kind-class tsd-parent-kind-module">
@@ -336,93 +324,6 @@
336
324
  </li>
337
325
  </ul>
338
326
  <ul class="after-current">
339
- <li class=" tsd-kind-class tsd-parent-kind-module">
340
- <a href="services.EndpointCircuitBreakerModule.html" class="tsd-kind-icon">Endpoint<wbr>Circuit<wbr>Breaker<wbr>Module</a>
341
- </li>
342
- <li class=" tsd-kind-class tsd-parent-kind-module">
343
- <a href="services.EndpointCompressionModule.html" class="tsd-kind-icon">Endpoint<wbr>Compression<wbr>Module</a>
344
- </li>
345
- <li class=" tsd-kind-class tsd-parent-kind-module">
346
- <a href="services.EndpointConfigurations.html" class="tsd-kind-icon">Endpoint<wbr>Configurations</a>
347
- </li>
348
- <li class=" tsd-kind-class tsd-parent-kind-module">
349
- <a href="services.EndpointIPPolicyModule.html" class="tsd-kind-icon">EndpointIPPolicy<wbr>Module</a>
350
- </li>
351
- <li class=" tsd-kind-class tsd-parent-kind-module">
352
- <a href="services.EndpointLoggingModule.html" class="tsd-kind-icon">Endpoint<wbr>Logging<wbr>Module</a>
353
- </li>
354
- <li class=" tsd-kind-class tsd-parent-kind-module">
355
- <a href="services.EndpointMutualTLSModule.html" class="tsd-kind-icon">Endpoint<wbr>MutualTLSModule</a>
356
- </li>
357
- <li class=" tsd-kind-class tsd-parent-kind-module">
358
- <a href="services.EndpointOAuthModule.html" class="tsd-kind-icon">EndpointOAuth<wbr>Module</a>
359
- </li>
360
- <li class=" tsd-kind-class tsd-parent-kind-module">
361
- <a href="services.EndpointOIDCModule.html" class="tsd-kind-icon">EndpointOIDCModule</a>
362
- </li>
363
- <li class=" tsd-kind-class tsd-parent-kind-module">
364
- <a href="services.EndpointRequestHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Request<wbr>Headers<wbr>Module</a>
365
- </li>
366
- <li class=" tsd-kind-class tsd-parent-kind-module">
367
- <a href="services.EndpointResponseHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Response<wbr>Headers<wbr>Module</a>
368
- </li>
369
- <li class=" tsd-kind-class tsd-parent-kind-module">
370
- <a href="services.EndpointSAMLModule.html" class="tsd-kind-icon">EndpointSAMLModule</a>
371
- </li>
372
- <li class=" tsd-kind-class tsd-parent-kind-module">
373
- <a href="services.EndpointTLSTerminationModule.html" class="tsd-kind-icon">EndpointTLSTermination<wbr>Module</a>
374
- </li>
375
- <li class=" tsd-kind-class tsd-parent-kind-module">
376
- <a href="services.EndpointWebhookValidationModule.html" class="tsd-kind-icon">Endpoint<wbr>Webhook<wbr>Validation<wbr>Module</a>
377
- </li>
378
- <li class=" tsd-kind-class tsd-parent-kind-module">
379
- <a href="services.EventDestinations.html" class="tsd-kind-icon">Event<wbr>Destinations</a>
380
- </li>
381
- <li class=" tsd-kind-class tsd-parent-kind-module">
382
- <a href="services.EventSources.html" class="tsd-kind-icon">Event<wbr>Sources</a>
383
- </li>
384
- <li class=" tsd-kind-class tsd-parent-kind-module">
385
- <a href="services.EventStreams.html" class="tsd-kind-icon">Event<wbr>Streams</a>
386
- </li>
387
- <li class=" tsd-kind-class tsd-parent-kind-module">
388
- <a href="services.EventSubscriptions.html" class="tsd-kind-icon">Event<wbr>Subscriptions</a>
389
- </li>
390
- <li class=" tsd-kind-class tsd-parent-kind-module">
391
- <a href="services.IPPolicies.html" class="tsd-kind-icon">IPPolicies</a>
392
- </li>
393
- <li class=" tsd-kind-class tsd-parent-kind-module">
394
- <a href="services.IPPolicyRules.html" class="tsd-kind-icon">IPPolicy<wbr>Rules</a>
395
- </li>
396
- <li class=" tsd-kind-class tsd-parent-kind-module">
397
- <a href="services.IPRestrictions.html" class="tsd-kind-icon">IPRestrictions</a>
398
- </li>
399
- <li class=" tsd-kind-class tsd-parent-kind-module">
400
- <a href="services.ReservedAddrs.html" class="tsd-kind-icon">Reserved<wbr>Addrs</a>
401
- </li>
402
- <li class=" tsd-kind-class tsd-parent-kind-module">
403
- <a href="services.ReservedDomains.html" class="tsd-kind-icon">Reserved<wbr>Domains</a>
404
- </li>
405
- <li class=" tsd-kind-class tsd-parent-kind-module">
406
- <a href="services.SSHCertificateAuthorities.html" class="tsd-kind-icon">SSHCertificate<wbr>Authorities</a>
407
- </li>
408
- <li class=" tsd-kind-class tsd-parent-kind-module">
409
- <a href="services.SSHCredentials.html" class="tsd-kind-icon">SSHCredentials</a>
410
- </li>
411
- <li class=" tsd-kind-class tsd-parent-kind-module">
412
- <a href="services.SSHHostCertificates.html" class="tsd-kind-icon">SSHHost<wbr>Certificates</a>
413
- </li>
414
- <li class=" tsd-kind-class tsd-parent-kind-module">
415
- <a href="services.SSHUserCertificates.html" class="tsd-kind-icon">SSHUser<wbr>Certificates</a>
416
- </li>
417
- <li class=" tsd-kind-class tsd-parent-kind-module">
418
- <a href="services.TLSCertificates.html" class="tsd-kind-icon">TLSCertificates</a>
419
- </li>
420
- <li class=" tsd-kind-class tsd-parent-kind-module">
421
- <a href="services.TunnelSessions.html" class="tsd-kind-icon">Tunnel<wbr>Sessions</a>
422
- </li>
423
- <li class=" tsd-kind-class tsd-parent-kind-module">
424
- <a href="services.Tunnels.html" class="tsd-kind-icon">Tunnels</a>
425
- </li>
426
327
  </ul>
427
328
  </nav>
428
329
  </div>
@@ -0,0 +1,270 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>EdgeRouteBackendModule | @ngrok/ngrok-api</title>
7
+ <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ <script async src="../assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="../index.html" class="title">@ngrok/ngrok-api</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ <input type="checkbox" id="tsd-filter-externals" checked />
43
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
+ </div>
45
+ </div>
46
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
+ </div>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ <div class="tsd-page-title">
52
+ <div class="container">
53
+ <ul class="tsd-breadcrumb">
54
+ <li>
55
+ <a href="../modules.html">@ngrok/ngrok-api</a>
56
+ </li>
57
+ <li>
58
+ <a href="../modules/services.html">services</a>
59
+ </li>
60
+ <li>
61
+ <a href="services.EdgeRouteBackendModule.html">EdgeRouteBackendModule</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Class EdgeRouteBackendModule</h1>
65
+ </div>
66
+ </div>
67
+ </header>
68
+ <div class="container container-main">
69
+ <div class="row">
70
+ <div class="col-8 col-content">
71
+ <section class="tsd-panel tsd-hierarchy">
72
+ <h3>Hierarchy</h3>
73
+ <ul class="tsd-hierarchy">
74
+ <li>
75
+ <span class="target">EdgeRouteBackendModule</span>
76
+ </li>
77
+ </ul>
78
+ </section>
79
+ <section class="tsd-panel-group tsd-index-group">
80
+ <h2>Index</h2>
81
+ <section class="tsd-panel tsd-index-panel">
82
+ <div class="tsd-index-content">
83
+ <section class="tsd-index-section ">
84
+ <h3>Constructors</h3>
85
+ <ul class="tsd-index-list">
86
+ <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="services.EdgeRouteBackendModule.html#constructor" class="tsd-kind-icon">constructor</a></li>
87
+ </ul>
88
+ </section>
89
+ <section class="tsd-index-section ">
90
+ <h3>Methods</h3>
91
+ <ul class="tsd-index-list">
92
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.EdgeRouteBackendModule.html#delete" class="tsd-kind-icon">delete</a></li>
93
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.EdgeRouteBackendModule.html#get" class="tsd-kind-icon">get</a></li>
94
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.EdgeRouteBackendModule.html#replace" class="tsd-kind-icon">replace</a></li>
95
+ </ul>
96
+ </section>
97
+ </div>
98
+ </section>
99
+ </section>
100
+ <section class="tsd-panel-group tsd-member-group ">
101
+ <h2>Constructors</h2>
102
+ <section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
103
+ <a name="constructor" class="tsd-anchor"></a>
104
+ <h3>constructor</h3>
105
+ <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
106
+ <li class="tsd-signature tsd-kind-icon">new <wbr>Edge<wbr>Route<wbr>Backend<wbr>Module<span class="tsd-signature-symbol">(</span>httpClient<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Wretcher</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="services.EdgeRouteBackendModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteBackendModule</a></li>
107
+ </ul>
108
+ <ul class="tsd-descriptions">
109
+ <li class="tsd-description">
110
+ <aside class="tsd-sources">
111
+ <ul>
112
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L1060">services.ts:1060</a></li>
113
+ </ul>
114
+ </aside>
115
+ <div class="tsd-comment tsd-typography">
116
+ <div class="lead">
117
+ <p>Do not construct this object directly, use the <code>edgeRouteBackendModule</code> property of an <code>Ngrok</code> client object instead.</p>
118
+ </div>
119
+ </div>
120
+ <h4 class="tsd-parameters-title">Parameters</h4>
121
+ <ul class="tsd-parameters">
122
+ <li>
123
+ <h5>httpClient: <span class="tsd-signature-type">Wretcher</span></h5>
124
+ </li>
125
+ </ul>
126
+ <h4 class="tsd-returns-title">Returns <a href="services.EdgeRouteBackendModule.html" class="tsd-signature-type" data-tsd-kind="Class">EdgeRouteBackendModule</a></h4>
127
+ </li>
128
+ </ul>
129
+ </section>
130
+ </section>
131
+ <section class="tsd-panel-group tsd-member-group ">
132
+ <h2>Methods</h2>
133
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
134
+ <a name="delete" class="tsd-anchor"></a>
135
+ <h3>delete</h3>
136
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
137
+ <li class="tsd-signature tsd-kind-icon">delete<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.EdgeRouteItem.html" class="tsd-signature-type" data-tsd-kind="Interface">EdgeRouteItem</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li>
138
+ </ul>
139
+ <ul class="tsd-descriptions">
140
+ <li class="tsd-description">
141
+ <aside class="tsd-sources">
142
+ <ul>
143
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L1081">services.ts:1081</a></li>
144
+ </ul>
145
+ </aside>
146
+ <h4 class="tsd-parameters-title">Parameters</h4>
147
+ <ul class="tsd-parameters">
148
+ <li>
149
+ <h5>arg: <a href="../interfaces/datatypes.EdgeRouteItem.html" class="tsd-signature-type" data-tsd-kind="Interface">EdgeRouteItem</a></h5>
150
+ </li>
151
+ </ul>
152
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4>
153
+ </li>
154
+ </ul>
155
+ </section>
156
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
157
+ <a name="get" class="tsd-anchor"></a>
158
+ <h3>get</h3>
159
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
160
+ <li class="tsd-signature tsd-kind-icon">get<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.EdgeRouteItem.html" class="tsd-signature-type" data-tsd-kind="Interface">EdgeRouteItem</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.EndpointBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointBackend</a><span class="tsd-signature-symbol">&gt;</span></li>
161
+ </ul>
162
+ <ul class="tsd-descriptions">
163
+ <li class="tsd-description">
164
+ <aside class="tsd-sources">
165
+ <ul>
166
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L1073">services.ts:1073</a></li>
167
+ </ul>
168
+ </aside>
169
+ <h4 class="tsd-parameters-title">Parameters</h4>
170
+ <ul class="tsd-parameters">
171
+ <li>
172
+ <h5>arg: <a href="../interfaces/datatypes.EdgeRouteItem.html" class="tsd-signature-type" data-tsd-kind="Interface">EdgeRouteItem</a></h5>
173
+ </li>
174
+ </ul>
175
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.EndpointBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointBackend</a><span class="tsd-signature-symbol">&gt;</span></h4>
176
+ </li>
177
+ </ul>
178
+ </section>
179
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
180
+ <a name="replace" class="tsd-anchor"></a>
181
+ <h3>replace</h3>
182
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
183
+ <li class="tsd-signature tsd-kind-icon">replace<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.EdgeRouteBackendReplace.html" class="tsd-signature-type" data-tsd-kind="Interface">EdgeRouteBackendReplace</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.EndpointBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointBackend</a><span class="tsd-signature-symbol">&gt;</span></li>
184
+ </ul>
185
+ <ul class="tsd-descriptions">
186
+ <li class="tsd-description">
187
+ <aside class="tsd-sources">
188
+ <ul>
189
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L1063">services.ts:1063</a></li>
190
+ </ul>
191
+ </aside>
192
+ <h4 class="tsd-parameters-title">Parameters</h4>
193
+ <ul class="tsd-parameters">
194
+ <li>
195
+ <h5>arg: <a href="../interfaces/datatypes.EdgeRouteBackendReplace.html" class="tsd-signature-type" data-tsd-kind="Interface">EdgeRouteBackendReplace</a></h5>
196
+ </li>
197
+ </ul>
198
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.EndpointBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointBackend</a><span class="tsd-signature-symbol">&gt;</span></h4>
199
+ </li>
200
+ </ul>
201
+ </section>
202
+ </section>
203
+ </div>
204
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
205
+ <nav class="tsd-navigation primary">
206
+ <ul>
207
+ <li class=" ">
208
+ <a href="../modules.html">Modules</a>
209
+ </li>
210
+ <li class=" tsd-kind-module">
211
+ <a href="../modules/client.html">client</a>
212
+ </li>
213
+ <li class=" tsd-kind-module">
214
+ <a href="../modules/datatypes.html">datatypes</a>
215
+ </li>
216
+ <li class="current tsd-kind-module">
217
+ <a href="../modules/services.html">services</a>
218
+ </li>
219
+ </ul>
220
+ </nav>
221
+ <nav class="tsd-navigation secondary menu-sticky">
222
+ <ul class="before-current">
223
+ </ul>
224
+ <ul class="current">
225
+ <li class="current tsd-kind-class tsd-parent-kind-module">
226
+ <a href="services.EdgeRouteBackendModule.html" class="tsd-kind-icon">Edge<wbr>Route<wbr>Backend<wbr>Module</a>
227
+ <ul>
228
+ <li class=" tsd-kind-constructor tsd-parent-kind-class">
229
+ <a href="services.EdgeRouteBackendModule.html#constructor" class="tsd-kind-icon">constructor</a>
230
+ </li>
231
+ <li class=" tsd-kind-method tsd-parent-kind-class">
232
+ <a href="services.EdgeRouteBackendModule.html#delete" class="tsd-kind-icon">delete</a>
233
+ </li>
234
+ <li class=" tsd-kind-method tsd-parent-kind-class">
235
+ <a href="services.EdgeRouteBackendModule.html#get" class="tsd-kind-icon">get</a>
236
+ </li>
237
+ <li class=" tsd-kind-method tsd-parent-kind-class">
238
+ <a href="services.EdgeRouteBackendModule.html#replace" class="tsd-kind-icon">replace</a>
239
+ </li>
240
+ </ul>
241
+ </li>
242
+ </ul>
243
+ <ul class="after-current">
244
+ </ul>
245
+ </nav>
246
+ </div>
247
+ </div>
248
+ </div>
249
+ <footer class="with-border-bottom">
250
+ <div class="container">
251
+ <h2>Legend</h2>
252
+ <div class="tsd-legend-group">
253
+ <ul class="tsd-legend">
254
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
255
+ <li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
256
+ <li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
257
+ </ul>
258
+ <ul class="tsd-legend">
259
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
260
+ </ul>
261
+ </div>
262
+ </div>
263
+ </footer>
264
+ <div class="container tsd-generator">
265
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
266
+ </div>
267
+ <div class="overlay"></div>
268
+ <script src="../assets/js/main.js"></script>
269
+ </body>
270
+ </html>