@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/docs/classes/services.SSHHostCertificates.html CHANGED
@@ -120,7 +120,7 @@
120
120
  <li class="tsd-description">
121
121
  <aside class="tsd-sources">
122
122
  <ul>
123
- <li>Defined in services.ts:2110</li>
123
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L2916">services.ts:2916</a></li>
124
124
  </ul>
125
125
  </aside>
126
126
  <div class="tsd-comment tsd-typography">
@@ -151,7 +151,7 @@
151
151
  <li class="tsd-description">
152
152
  <aside class="tsd-sources">
153
153
  <ul>
154
- <li>Defined in services.ts:2116</li>
154
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L2922">services.ts:2922</a></li>
155
155
  </ul>
156
156
  </aside>
157
157
  <div class="tsd-comment tsd-typography">
@@ -179,7 +179,7 @@
179
179
  <li class="tsd-description">
180
180
  <aside class="tsd-sources">
181
181
  <ul>
182
- <li>Defined in services.ts:2129</li>
182
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L2935">services.ts:2935</a></li>
183
183
  </ul>
184
184
  </aside>
185
185
  <div class="tsd-comment tsd-typography">
@@ -207,7 +207,7 @@
207
207
  <li class="tsd-description">
208
208
  <aside class="tsd-sources">
209
209
  <ul>
210
- <li>Defined in services.ts:2140</li>
210
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L2946">services.ts:2946</a></li>
211
211
  </ul>
212
212
  </aside>
213
213
  <div class="tsd-comment tsd-typography">
@@ -235,7 +235,7 @@
235
235
  <li class="tsd-description">
236
236
  <aside class="tsd-sources">
237
237
  <ul>
238
- <li>Defined in services.ts:2151</li>
238
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L2957">services.ts:2957</a></li>
239
239
  </ul>
240
240
  </aside>
241
241
  <div class="tsd-comment tsd-typography">
@@ -257,7 +257,7 @@
257
257
  <li class="tsd-description">
258
258
  <aside class="tsd-sources">
259
259
  <ul>
260
- <li>Defined in services.ts:2194</li>
260
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L3000">services.ts:3000</a></li>
261
261
  </ul>
262
262
  </aside>
263
263
  <div class="tsd-comment tsd-typography">
@@ -296,93 +296,6 @@
296
296
  </nav>
297
297
  <nav class="tsd-navigation secondary menu-sticky">
298
298
  <ul class="before-current">
299
- <li class=" tsd-kind-class tsd-parent-kind-module">
300
- <a href="services.APIKeys.html" class="tsd-kind-icon">APIKeys</a>
301
- </li>
302
- <li class=" tsd-kind-class tsd-parent-kind-module">
303
- <a href="services.AbuseReports.html" class="tsd-kind-icon">Abuse<wbr>Reports</a>
304
- </li>
305
- <li class=" tsd-kind-class tsd-parent-kind-module">
306
- <a href="services.CertificateAuthorities.html" class="tsd-kind-icon">Certificate<wbr>Authorities</a>
307
- </li>
308
- <li class=" tsd-kind-class tsd-parent-kind-module">
309
- <a href="services.Credentials.html" class="tsd-kind-icon">Credentials</a>
310
- </li>
311
- <li class=" tsd-kind-class tsd-parent-kind-module">
312
- <a href="services.EndpointCircuitBreakerModule.html" class="tsd-kind-icon">Endpoint<wbr>Circuit<wbr>Breaker<wbr>Module</a>
313
- </li>
314
- <li class=" tsd-kind-class tsd-parent-kind-module">
315
- <a href="services.EndpointCompressionModule.html" class="tsd-kind-icon">Endpoint<wbr>Compression<wbr>Module</a>
316
- </li>
317
- <li class=" tsd-kind-class tsd-parent-kind-module">
318
- <a href="services.EndpointConfigurations.html" class="tsd-kind-icon">Endpoint<wbr>Configurations</a>
319
- </li>
320
- <li class=" tsd-kind-class tsd-parent-kind-module">
321
- <a href="services.EndpointIPPolicyModule.html" class="tsd-kind-icon">EndpointIPPolicy<wbr>Module</a>
322
- </li>
323
- <li class=" tsd-kind-class tsd-parent-kind-module">
324
- <a href="services.EndpointLoggingModule.html" class="tsd-kind-icon">Endpoint<wbr>Logging<wbr>Module</a>
325
- </li>
326
- <li class=" tsd-kind-class tsd-parent-kind-module">
327
- <a href="services.EndpointMutualTLSModule.html" class="tsd-kind-icon">Endpoint<wbr>MutualTLSModule</a>
328
- </li>
329
- <li class=" tsd-kind-class tsd-parent-kind-module">
330
- <a href="services.EndpointOAuthModule.html" class="tsd-kind-icon">EndpointOAuth<wbr>Module</a>
331
- </li>
332
- <li class=" tsd-kind-class tsd-parent-kind-module">
333
- <a href="services.EndpointOIDCModule.html" class="tsd-kind-icon">EndpointOIDCModule</a>
334
- </li>
335
- <li class=" tsd-kind-class tsd-parent-kind-module">
336
- <a href="services.EndpointRequestHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Request<wbr>Headers<wbr>Module</a>
337
- </li>
338
- <li class=" tsd-kind-class tsd-parent-kind-module">
339
- <a href="services.EndpointResponseHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Response<wbr>Headers<wbr>Module</a>
340
- </li>
341
- <li class=" tsd-kind-class tsd-parent-kind-module">
342
- <a href="services.EndpointSAMLModule.html" class="tsd-kind-icon">EndpointSAMLModule</a>
343
- </li>
344
- <li class=" tsd-kind-class tsd-parent-kind-module">
345
- <a href="services.EndpointTLSTerminationModule.html" class="tsd-kind-icon">EndpointTLSTermination<wbr>Module</a>
346
- </li>
347
- <li class=" tsd-kind-class tsd-parent-kind-module">
348
- <a href="services.EndpointWebhookValidationModule.html" class="tsd-kind-icon">Endpoint<wbr>Webhook<wbr>Validation<wbr>Module</a>
349
- </li>
350
- <li class=" tsd-kind-class tsd-parent-kind-module">
351
- <a href="services.EventDestinations.html" class="tsd-kind-icon">Event<wbr>Destinations</a>
352
- </li>
353
- <li class=" tsd-kind-class tsd-parent-kind-module">
354
- <a href="services.EventSources.html" class="tsd-kind-icon">Event<wbr>Sources</a>
355
- </li>
356
- <li class=" tsd-kind-class tsd-parent-kind-module">
357
- <a href="services.EventStreams.html" class="tsd-kind-icon">Event<wbr>Streams</a>
358
- </li>
359
- <li class=" tsd-kind-class tsd-parent-kind-module">
360
- <a href="services.EventSubscriptions.html" class="tsd-kind-icon">Event<wbr>Subscriptions</a>
361
- </li>
362
- <li class=" tsd-kind-class tsd-parent-kind-module">
363
- <a href="services.IPPolicies.html" class="tsd-kind-icon">IPPolicies</a>
364
- </li>
365
- <li class=" tsd-kind-class tsd-parent-kind-module">
366
- <a href="services.IPPolicyRules.html" class="tsd-kind-icon">IPPolicy<wbr>Rules</a>
367
- </li>
368
- <li class=" tsd-kind-class tsd-parent-kind-module">
369
- <a href="services.IPRestrictions.html" class="tsd-kind-icon">IPRestrictions</a>
370
- </li>
371
- <li class=" tsd-kind-class tsd-parent-kind-module">
372
- <a href="services.IPWhitelist.html" class="tsd-kind-icon">IPWhitelist</a>
373
- </li>
374
- <li class=" tsd-kind-class tsd-parent-kind-module">
375
- <a href="services.ReservedAddrs.html" class="tsd-kind-icon">Reserved<wbr>Addrs</a>
376
- </li>
377
- <li class=" tsd-kind-class tsd-parent-kind-module">
378
- <a href="services.ReservedDomains.html" class="tsd-kind-icon">Reserved<wbr>Domains</a>
379
- </li>
380
- <li class=" tsd-kind-class tsd-parent-kind-module">
381
- <a href="services.SSHCertificateAuthorities.html" class="tsd-kind-icon">SSHCertificate<wbr>Authorities</a>
382
- </li>
383
- <li class=" tsd-kind-class tsd-parent-kind-module">
384
- <a href="services.SSHCredentials.html" class="tsd-kind-icon">SSHCredentials</a>
385
- </li>
386
299
  </ul>
387
300
  <ul class="current">
388
301
  <li class="current tsd-kind-class tsd-parent-kind-module">
@@ -410,18 +323,6 @@
410
323
  </li>
411
324
  </ul>
412
325
  <ul class="after-current">
413
- <li class=" tsd-kind-class tsd-parent-kind-module">
414
- <a href="services.SSHUserCertificates.html" class="tsd-kind-icon">SSHUser<wbr>Certificates</a>
415
- </li>
416
- <li class=" tsd-kind-class tsd-parent-kind-module">
417
- <a href="services.TLSCertificates.html" class="tsd-kind-icon">TLSCertificates</a>
418
- </li>
419
- <li class=" tsd-kind-class tsd-parent-kind-module">
420
- <a href="services.TunnelSessions.html" class="tsd-kind-icon">Tunnel<wbr>Sessions</a>
421
- </li>
422
- <li class=" tsd-kind-class tsd-parent-kind-module">
423
- <a href="services.Tunnels.html" class="tsd-kind-icon">Tunnels</a>
424
- </li>
425
326
  </ul>
426
327
  </nav>
427
328
  </div>
package/docs/classes/services.SSHUserCertificates.html CHANGED
@@ -120,7 +120,7 @@
120
120
  <li class="tsd-description">
121
121
  <aside class="tsd-sources">
122
122
  <ul>
123
- <li>Defined in services.ts:2214</li>
123
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L3020">services.ts:3020</a></li>
124
124
  </ul>
125
125
  </aside>
126
126
  <div class="tsd-comment tsd-typography">
@@ -151,7 +151,7 @@
151
151
  <li class="tsd-description">
152
152
  <aside class="tsd-sources">
153
153
  <ul>
154
- <li>Defined in services.ts:2220</li>
154
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L3026">services.ts:3026</a></li>
155
155
  </ul>
156
156
  </aside>
157
157
  <div class="tsd-comment tsd-typography">
@@ -179,7 +179,7 @@
179
179
  <li class="tsd-description">
180
180
  <aside class="tsd-sources">
181
181
  <ul>
182
- <li>Defined in services.ts:2233</li>
182
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L3039">services.ts:3039</a></li>
183
183
  </ul>
184
184
  </aside>
185
185
  <div class="tsd-comment tsd-typography">
@@ -207,7 +207,7 @@
207
207
  <li class="tsd-description">
208
208
  <aside class="tsd-sources">
209
209
  <ul>
210
- <li>Defined in services.ts:2244</li>
210
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L3050">services.ts:3050</a></li>
211
211
  </ul>
212
212
  </aside>
213
213
  <div class="tsd-comment tsd-typography">
@@ -235,7 +235,7 @@
235
235
  <li class="tsd-description">
236
236
  <aside class="tsd-sources">
237
237
  <ul>
238
- <li>Defined in services.ts:2255</li>
238
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L3061">services.ts:3061</a></li>
239
239
  </ul>
240
240
  </aside>
241
241
  <div class="tsd-comment tsd-typography">
@@ -257,7 +257,7 @@
257
257
  <li class="tsd-description">
258
258
  <aside class="tsd-sources">
259
259
  <ul>
260
- <li>Defined in services.ts:2298</li>
260
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L3104">services.ts:3104</a></li>
261
261
  </ul>
262
262
  </aside>
263
263
  <div class="tsd-comment tsd-typography">
@@ -296,96 +296,6 @@
296
296
  </nav>
297
297
  <nav class="tsd-navigation secondary menu-sticky">
298
298
  <ul class="before-current">
299
- <li class=" tsd-kind-class tsd-parent-kind-module">
300
- <a href="services.APIKeys.html" class="tsd-kind-icon">APIKeys</a>
301
- </li>
302
- <li class=" tsd-kind-class tsd-parent-kind-module">
303
- <a href="services.AbuseReports.html" class="tsd-kind-icon">Abuse<wbr>Reports</a>
304
- </li>
305
- <li class=" tsd-kind-class tsd-parent-kind-module">
306
- <a href="services.CertificateAuthorities.html" class="tsd-kind-icon">Certificate<wbr>Authorities</a>
307
- </li>
308
- <li class=" tsd-kind-class tsd-parent-kind-module">
309
- <a href="services.Credentials.html" class="tsd-kind-icon">Credentials</a>
310
- </li>
311
- <li class=" tsd-kind-class tsd-parent-kind-module">
312
- <a href="services.EndpointCircuitBreakerModule.html" class="tsd-kind-icon">Endpoint<wbr>Circuit<wbr>Breaker<wbr>Module</a>
313
- </li>
314
- <li class=" tsd-kind-class tsd-parent-kind-module">
315
- <a href="services.EndpointCompressionModule.html" class="tsd-kind-icon">Endpoint<wbr>Compression<wbr>Module</a>
316
- </li>
317
- <li class=" tsd-kind-class tsd-parent-kind-module">
318
- <a href="services.EndpointConfigurations.html" class="tsd-kind-icon">Endpoint<wbr>Configurations</a>
319
- </li>
320
- <li class=" tsd-kind-class tsd-parent-kind-module">
321
- <a href="services.EndpointIPPolicyModule.html" class="tsd-kind-icon">EndpointIPPolicy<wbr>Module</a>
322
- </li>
323
- <li class=" tsd-kind-class tsd-parent-kind-module">
324
- <a href="services.EndpointLoggingModule.html" class="tsd-kind-icon">Endpoint<wbr>Logging<wbr>Module</a>
325
- </li>
326
- <li class=" tsd-kind-class tsd-parent-kind-module">
327
- <a href="services.EndpointMutualTLSModule.html" class="tsd-kind-icon">Endpoint<wbr>MutualTLSModule</a>
328
- </li>
329
- <li class=" tsd-kind-class tsd-parent-kind-module">
330
- <a href="services.EndpointOAuthModule.html" class="tsd-kind-icon">EndpointOAuth<wbr>Module</a>
331
- </li>
332
- <li class=" tsd-kind-class tsd-parent-kind-module">
333
- <a href="services.EndpointOIDCModule.html" class="tsd-kind-icon">EndpointOIDCModule</a>
334
- </li>
335
- <li class=" tsd-kind-class tsd-parent-kind-module">
336
- <a href="services.EndpointRequestHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Request<wbr>Headers<wbr>Module</a>
337
- </li>
338
- <li class=" tsd-kind-class tsd-parent-kind-module">
339
- <a href="services.EndpointResponseHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Response<wbr>Headers<wbr>Module</a>
340
- </li>
341
- <li class=" tsd-kind-class tsd-parent-kind-module">
342
- <a href="services.EndpointSAMLModule.html" class="tsd-kind-icon">EndpointSAMLModule</a>
343
- </li>
344
- <li class=" tsd-kind-class tsd-parent-kind-module">
345
- <a href="services.EndpointTLSTerminationModule.html" class="tsd-kind-icon">EndpointTLSTermination<wbr>Module</a>
346
- </li>
347
- <li class=" tsd-kind-class tsd-parent-kind-module">
348
- <a href="services.EndpointWebhookValidationModule.html" class="tsd-kind-icon">Endpoint<wbr>Webhook<wbr>Validation<wbr>Module</a>
349
- </li>
350
- <li class=" tsd-kind-class tsd-parent-kind-module">
351
- <a href="services.EventDestinations.html" class="tsd-kind-icon">Event<wbr>Destinations</a>
352
- </li>
353
- <li class=" tsd-kind-class tsd-parent-kind-module">
354
- <a href="services.EventSources.html" class="tsd-kind-icon">Event<wbr>Sources</a>
355
- </li>
356
- <li class=" tsd-kind-class tsd-parent-kind-module">
357
- <a href="services.EventStreams.html" class="tsd-kind-icon">Event<wbr>Streams</a>
358
- </li>
359
- <li class=" tsd-kind-class tsd-parent-kind-module">
360
- <a href="services.EventSubscriptions.html" class="tsd-kind-icon">Event<wbr>Subscriptions</a>
361
- </li>
362
- <li class=" tsd-kind-class tsd-parent-kind-module">
363
- <a href="services.IPPolicies.html" class="tsd-kind-icon">IPPolicies</a>
364
- </li>
365
- <li class=" tsd-kind-class tsd-parent-kind-module">
366
- <a href="services.IPPolicyRules.html" class="tsd-kind-icon">IPPolicy<wbr>Rules</a>
367
- </li>
368
- <li class=" tsd-kind-class tsd-parent-kind-module">
369
- <a href="services.IPRestrictions.html" class="tsd-kind-icon">IPRestrictions</a>
370
- </li>
371
- <li class=" tsd-kind-class tsd-parent-kind-module">
372
- <a href="services.IPWhitelist.html" class="tsd-kind-icon">IPWhitelist</a>
373
- </li>
374
- <li class=" tsd-kind-class tsd-parent-kind-module">
375
- <a href="services.ReservedAddrs.html" class="tsd-kind-icon">Reserved<wbr>Addrs</a>
376
- </li>
377
- <li class=" tsd-kind-class tsd-parent-kind-module">
378
- <a href="services.ReservedDomains.html" class="tsd-kind-icon">Reserved<wbr>Domains</a>
379
- </li>
380
- <li class=" tsd-kind-class tsd-parent-kind-module">
381
- <a href="services.SSHCertificateAuthorities.html" class="tsd-kind-icon">SSHCertificate<wbr>Authorities</a>
382
- </li>
383
- <li class=" tsd-kind-class tsd-parent-kind-module">
384
- <a href="services.SSHCredentials.html" class="tsd-kind-icon">SSHCredentials</a>
385
- </li>
386
- <li class=" tsd-kind-class tsd-parent-kind-module">
387
- <a href="services.SSHHostCertificates.html" class="tsd-kind-icon">SSHHost<wbr>Certificates</a>
388
- </li>
389
299
  </ul>
390
300
  <ul class="current">
391
301
  <li class="current tsd-kind-class tsd-parent-kind-module">
@@ -413,15 +323,6 @@
413
323
  </li>
414
324
  </ul>
415
325
  <ul class="after-current">
416
- <li class=" tsd-kind-class tsd-parent-kind-module">
417
- <a href="services.TLSCertificates.html" class="tsd-kind-icon">TLSCertificates</a>
418
- </li>
419
- <li class=" tsd-kind-class tsd-parent-kind-module">
420
- <a href="services.TunnelSessions.html" class="tsd-kind-icon">Tunnel<wbr>Sessions</a>
421
- </li>
422
- <li class=" tsd-kind-class tsd-parent-kind-module">
423
- <a href="services.Tunnels.html" class="tsd-kind-icon">Tunnels</a>
424
- </li>
425
326
  </ul>
426
327
  </nav>
427
328
  </div>
package/docs/classes/{services.EndpointSAMLModule.html → services.TCPEdgeBackendModule.html} RENAMED
@@ -3,7 +3,7 @@
3
3
  <head>
4
4
  <meta charset="utf-8">
5
5
  <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
- <title>EndpointSAMLModule | @ngrok/ngrok-api</title>
6
+ <title>TCPEdgeBackendModule | @ngrok/ngrok-api</title>
7
7
  <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
8
  <meta name="viewport" content="width=device-width, initial-scale=1">
9
9
  <link rel="stylesheet" href="../assets/css/main.css">
@@ -58,10 +58,10 @@
58
58
  <a href="../modules/services.html">services</a>
59
59
  </li>
60
60
  <li>
61
- <a href="services.EndpointSAMLModule.html">EndpointSAMLModule</a>
61
+ <a href="services.TCPEdgeBackendModule.html">TCPEdgeBackendModule</a>
62
62
  </li>
63
63
  </ul>
64
- <h1>Class EndpointSAMLModule</h1>
64
+ <h1>Class TCPEdgeBackendModule</h1>
65
65
  </div>
66
66
  </div>
67
67
  </header>
@@ -72,7 +72,7 @@
72
72
  <h3>Hierarchy</h3>
73
73
  <ul class="tsd-hierarchy">
74
74
  <li>
75
- <span class="target">EndpointSAMLModule</span>
75
+ <span class="target">TCPEdgeBackendModule</span>
76
76
  </li>
77
77
  </ul>
78
78
  </section>
@@ -83,15 +83,15 @@
83
83
  <section class="tsd-index-section ">
84
84
  <h3>Constructors</h3>
85
85
  <ul class="tsd-index-list">
86
- <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="services.EndpointSAMLModule.html#constructor" class="tsd-kind-icon">constructor</a></li>
86
+ <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="services.TCPEdgeBackendModule.html#constructor" class="tsd-kind-icon">constructor</a></li>
87
87
  </ul>
88
88
  </section>
89
89
  <section class="tsd-index-section ">
90
90
  <h3>Methods</h3>
91
91
  <ul class="tsd-index-list">
92
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.EndpointSAMLModule.html#delete" class="tsd-kind-icon">delete</a></li>
93
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.EndpointSAMLModule.html#get" class="tsd-kind-icon">get</a></li>
94
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.EndpointSAMLModule.html#replace" class="tsd-kind-icon">replace</a></li>
92
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.TCPEdgeBackendModule.html#delete" class="tsd-kind-icon">delete</a></li>
93
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.TCPEdgeBackendModule.html#get" class="tsd-kind-icon">get</a></li>
94
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.TCPEdgeBackendModule.html#replace" class="tsd-kind-icon">replace</a></li>
95
95
  </ul>
96
96
  </section>
97
97
  </div>
@@ -103,18 +103,18 @@
103
103
  <a name="constructor" class="tsd-anchor"></a>
104
104
  <h3>constructor</h3>
105
105
  <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
106
- <li class="tsd-signature tsd-kind-icon">new <wbr>EndpointSAMLModule<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.EndpointSAMLModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointSAMLModule</a></li>
106
+ <li class="tsd-signature tsd-kind-icon">new TCPEdge<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.TCPEdgeBackendModule.html" class="tsd-signature-type" data-tsd-kind="Class">TCPEdgeBackendModule</a></li>
107
107
  </ul>
108
108
  <ul class="tsd-descriptions">
109
109
  <li class="tsd-description">
110
110
  <aside class="tsd-sources">
111
111
  <ul>
112
- <li>Defined in services.ts:1570</li>
112
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L1546">services.ts:1546</a></li>
113
113
  </ul>
114
114
  </aside>
115
115
  <div class="tsd-comment tsd-typography">
116
116
  <div class="lead">
117
- <p>Do not construct this object directly, use the <code>endpointSamlModule</code> property of an <code>Ngrok</code> client object instead.</p>
117
+ <p>Do not construct this object directly, use the <code>tcpEdgeBackendModule</code> property of an <code>Ngrok</code> client object instead.</p>
118
118
  </div>
119
119
  </div>
120
120
  <h4 class="tsd-parameters-title">Parameters</h4>
@@ -123,7 +123,7 @@
123
123
  <h5>httpClient: <span class="tsd-signature-type">Wretcher</span></h5>
124
124
  </li>
125
125
  </ul>
126
- <h4 class="tsd-returns-title">Returns <a href="services.EndpointSAMLModule.html" class="tsd-signature-type" data-tsd-kind="Class">EndpointSAMLModule</a></h4>
126
+ <h4 class="tsd-returns-title">Returns <a href="services.TCPEdgeBackendModule.html" class="tsd-signature-type" data-tsd-kind="Class">TCPEdgeBackendModule</a></h4>
127
127
  </li>
128
128
  </ul>
129
129
  </section>
@@ -140,7 +140,7 @@
140
140
  <li class="tsd-description">
141
141
  <aside class="tsd-sources">
142
142
  <ul>
143
- <li>Defined in services.ts:1591</li>
143
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L1567">services.ts:1567</a></li>
144
144
  </ul>
145
145
  </aside>
146
146
  <h4 class="tsd-parameters-title">Parameters</h4>
@@ -157,13 +157,13 @@
157
157
  <a name="get" class="tsd-anchor"></a>
158
158
  <h3>get</h3>
159
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.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</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.EndpointSAML.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointSAML</a><span class="tsd-signature-symbol">&gt;</span></li>
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.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</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
161
  </ul>
162
162
  <ul class="tsd-descriptions">
163
163
  <li class="tsd-description">
164
164
  <aside class="tsd-sources">
165
165
  <ul>
166
- <li>Defined in services.ts:1583</li>
166
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L1559">services.ts:1559</a></li>
167
167
  </ul>
168
168
  </aside>
169
169
  <h4 class="tsd-parameters-title">Parameters</h4>
@@ -172,7 +172,7 @@
172
172
  <h5>arg: <a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a></h5>
173
173
  </li>
174
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.EndpointSAML.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointSAML</a><span class="tsd-signature-symbol">&gt;</span></h4>
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
176
  </li>
177
177
  </ul>
178
178
  </section>
@@ -180,22 +180,22 @@
180
180
  <a name="replace" class="tsd-anchor"></a>
181
181
  <h3>replace</h3>
182
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.EndpointSAMLReplace.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointSAMLReplace</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.EndpointSAML.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointSAML</a><span class="tsd-signature-symbol">&gt;</span></li>
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.EdgeBackendReplace.html" class="tsd-signature-type" data-tsd-kind="Interface">EdgeBackendReplace</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
184
  </ul>
185
185
  <ul class="tsd-descriptions">
186
186
  <li class="tsd-description">
187
187
  <aside class="tsd-sources">
188
188
  <ul>
189
- <li>Defined in services.ts:1573</li>
189
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/services.ts#L1549">services.ts:1549</a></li>
190
190
  </ul>
191
191
  </aside>
192
192
  <h4 class="tsd-parameters-title">Parameters</h4>
193
193
  <ul class="tsd-parameters">
194
194
  <li>
195
- <h5>arg: <a href="../interfaces/datatypes.EndpointSAMLReplace.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointSAMLReplace</a></h5>
195
+ <h5>arg: <a href="../interfaces/datatypes.EdgeBackendReplace.html" class="tsd-signature-type" data-tsd-kind="Interface">EdgeBackendReplace</a></h5>
196
196
  </li>
197
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.EndpointSAML.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointSAML</a><span class="tsd-signature-symbol">&gt;</span></h4>
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
199
  </li>
200
200
  </ul>
201
201
  </section>
@@ -220,126 +220,27 @@
220
220
  </nav>
221
221
  <nav class="tsd-navigation secondary menu-sticky">
222
222
  <ul class="before-current">
223
- <li class=" tsd-kind-class tsd-parent-kind-module">
224
- <a href="services.APIKeys.html" class="tsd-kind-icon">APIKeys</a>
225
- </li>
226
- <li class=" tsd-kind-class tsd-parent-kind-module">
227
- <a href="services.AbuseReports.html" class="tsd-kind-icon">Abuse<wbr>Reports</a>
228
- </li>
229
- <li class=" tsd-kind-class tsd-parent-kind-module">
230
- <a href="services.CertificateAuthorities.html" class="tsd-kind-icon">Certificate<wbr>Authorities</a>
231
- </li>
232
- <li class=" tsd-kind-class tsd-parent-kind-module">
233
- <a href="services.Credentials.html" class="tsd-kind-icon">Credentials</a>
234
- </li>
235
- <li class=" tsd-kind-class tsd-parent-kind-module">
236
- <a href="services.EndpointCircuitBreakerModule.html" class="tsd-kind-icon">Endpoint<wbr>Circuit<wbr>Breaker<wbr>Module</a>
237
- </li>
238
- <li class=" tsd-kind-class tsd-parent-kind-module">
239
- <a href="services.EndpointCompressionModule.html" class="tsd-kind-icon">Endpoint<wbr>Compression<wbr>Module</a>
240
- </li>
241
- <li class=" tsd-kind-class tsd-parent-kind-module">
242
- <a href="services.EndpointConfigurations.html" class="tsd-kind-icon">Endpoint<wbr>Configurations</a>
243
- </li>
244
- <li class=" tsd-kind-class tsd-parent-kind-module">
245
- <a href="services.EndpointIPPolicyModule.html" class="tsd-kind-icon">EndpointIPPolicy<wbr>Module</a>
246
- </li>
247
- <li class=" tsd-kind-class tsd-parent-kind-module">
248
- <a href="services.EndpointLoggingModule.html" class="tsd-kind-icon">Endpoint<wbr>Logging<wbr>Module</a>
249
- </li>
250
- <li class=" tsd-kind-class tsd-parent-kind-module">
251
- <a href="services.EndpointMutualTLSModule.html" class="tsd-kind-icon">Endpoint<wbr>MutualTLSModule</a>
252
- </li>
253
- <li class=" tsd-kind-class tsd-parent-kind-module">
254
- <a href="services.EndpointOAuthModule.html" class="tsd-kind-icon">EndpointOAuth<wbr>Module</a>
255
- </li>
256
- <li class=" tsd-kind-class tsd-parent-kind-module">
257
- <a href="services.EndpointOIDCModule.html" class="tsd-kind-icon">EndpointOIDCModule</a>
258
- </li>
259
- <li class=" tsd-kind-class tsd-parent-kind-module">
260
- <a href="services.EndpointRequestHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Request<wbr>Headers<wbr>Module</a>
261
- </li>
262
- <li class=" tsd-kind-class tsd-parent-kind-module">
263
- <a href="services.EndpointResponseHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Response<wbr>Headers<wbr>Module</a>
264
- </li>
265
223
  </ul>
266
224
  <ul class="current">
267
225
  <li class="current tsd-kind-class tsd-parent-kind-module">
268
- <a href="services.EndpointSAMLModule.html" class="tsd-kind-icon">EndpointSAMLModule</a>
226
+ <a href="services.TCPEdgeBackendModule.html" class="tsd-kind-icon">TCPEdge<wbr>Backend<wbr>Module</a>
269
227
  <ul>
270
228
  <li class=" tsd-kind-constructor tsd-parent-kind-class">
271
- <a href="services.EndpointSAMLModule.html#constructor" class="tsd-kind-icon">constructor</a>
229
+ <a href="services.TCPEdgeBackendModule.html#constructor" class="tsd-kind-icon">constructor</a>
272
230
  </li>
273
231
  <li class=" tsd-kind-method tsd-parent-kind-class">
274
- <a href="services.EndpointSAMLModule.html#delete" class="tsd-kind-icon">delete</a>
232
+ <a href="services.TCPEdgeBackendModule.html#delete" class="tsd-kind-icon">delete</a>
275
233
  </li>
276
234
  <li class=" tsd-kind-method tsd-parent-kind-class">
277
- <a href="services.EndpointSAMLModule.html#get" class="tsd-kind-icon">get</a>
235
+ <a href="services.TCPEdgeBackendModule.html#get" class="tsd-kind-icon">get</a>
278
236
  </li>
279
237
  <li class=" tsd-kind-method tsd-parent-kind-class">
280
- <a href="services.EndpointSAMLModule.html#replace" class="tsd-kind-icon">replace</a>
238
+ <a href="services.TCPEdgeBackendModule.html#replace" class="tsd-kind-icon">replace</a>
281
239
  </li>
282
240
  </ul>
283
241
  </li>
284
242
  </ul>
285
243
  <ul class="after-current">
286
- <li class=" tsd-kind-class tsd-parent-kind-module">
287
- <a href="services.EndpointTLSTerminationModule.html" class="tsd-kind-icon">EndpointTLSTermination<wbr>Module</a>
288
- </li>
289
- <li class=" tsd-kind-class tsd-parent-kind-module">
290
- <a href="services.EndpointWebhookValidationModule.html" class="tsd-kind-icon">Endpoint<wbr>Webhook<wbr>Validation<wbr>Module</a>
291
- </li>
292
- <li class=" tsd-kind-class tsd-parent-kind-module">
293
- <a href="services.EventDestinations.html" class="tsd-kind-icon">Event<wbr>Destinations</a>
294
- </li>
295
- <li class=" tsd-kind-class tsd-parent-kind-module">
296
- <a href="services.EventSources.html" class="tsd-kind-icon">Event<wbr>Sources</a>
297
- </li>
298
- <li class=" tsd-kind-class tsd-parent-kind-module">
299
- <a href="services.EventStreams.html" class="tsd-kind-icon">Event<wbr>Streams</a>
300
- </li>
301
- <li class=" tsd-kind-class tsd-parent-kind-module">
302
- <a href="services.EventSubscriptions.html" class="tsd-kind-icon">Event<wbr>Subscriptions</a>
303
- </li>
304
- <li class=" tsd-kind-class tsd-parent-kind-module">
305
- <a href="services.IPPolicies.html" class="tsd-kind-icon">IPPolicies</a>
306
- </li>
307
- <li class=" tsd-kind-class tsd-parent-kind-module">
308
- <a href="services.IPPolicyRules.html" class="tsd-kind-icon">IPPolicy<wbr>Rules</a>
309
- </li>
310
- <li class=" tsd-kind-class tsd-parent-kind-module">
311
- <a href="services.IPRestrictions.html" class="tsd-kind-icon">IPRestrictions</a>
312
- </li>
313
- <li class=" tsd-kind-class tsd-parent-kind-module">
314
- <a href="services.IPWhitelist.html" class="tsd-kind-icon">IPWhitelist</a>
315
- </li>
316
- <li class=" tsd-kind-class tsd-parent-kind-module">
317
- <a href="services.ReservedAddrs.html" class="tsd-kind-icon">Reserved<wbr>Addrs</a>
318
- </li>
319
- <li class=" tsd-kind-class tsd-parent-kind-module">
320
- <a href="services.ReservedDomains.html" class="tsd-kind-icon">Reserved<wbr>Domains</a>
321
- </li>
322
- <li class=" tsd-kind-class tsd-parent-kind-module">
323
- <a href="services.SSHCertificateAuthorities.html" class="tsd-kind-icon">SSHCertificate<wbr>Authorities</a>
324
- </li>
325
- <li class=" tsd-kind-class tsd-parent-kind-module">
326
- <a href="services.SSHCredentials.html" class="tsd-kind-icon">SSHCredentials</a>
327
- </li>
328
- <li class=" tsd-kind-class tsd-parent-kind-module">
329
- <a href="services.SSHHostCertificates.html" class="tsd-kind-icon">SSHHost<wbr>Certificates</a>
330
- </li>
331
- <li class=" tsd-kind-class tsd-parent-kind-module">
332
- <a href="services.SSHUserCertificates.html" class="tsd-kind-icon">SSHUser<wbr>Certificates</a>
333
- </li>
334
- <li class=" tsd-kind-class tsd-parent-kind-module">
335
- <a href="services.TLSCertificates.html" class="tsd-kind-icon">TLSCertificates</a>
336
- </li>
337
- <li class=" tsd-kind-class tsd-parent-kind-module">
338
- <a href="services.TunnelSessions.html" class="tsd-kind-icon">Tunnel<wbr>Sessions</a>
339
- </li>
340
- <li class=" tsd-kind-class tsd-parent-kind-module">
341
- <a href="services.Tunnels.html" class="tsd-kind-icon">Tunnels</a>
342
- </li>
343
244
  </ul>
344
245
  </nav>
345
246
  </div>