@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
package/docs/classes/services.Tunnels.html CHANGED
@@ -97,6 +97,7 @@
97
97
  <section class="tsd-index-section ">
98
98
  <h3>Methods</h3>
99
99
  <ul class="tsd-index-list">
100
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.Tunnels.html#get" class="tsd-kind-icon">get</a></li>
100
101
  <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.Tunnels.html#list" class="tsd-kind-icon">list</a></li>
101
102
  </ul>
102
103
  </section>
@@ -115,7 +116,7 @@
115
116
  <li class="tsd-description">
116
117
  <aside class="tsd-sources">
117
118
  <ul>
118
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L2517">services.ts:2517</a></li>
119
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L3327">services.ts:3327</a></li>
119
120
  </ul>
120
121
  </aside>
121
122
  <div class="tsd-comment tsd-typography">
@@ -136,6 +137,34 @@
136
137
  </section>
137
138
  <section class="tsd-panel-group tsd-member-group ">
138
139
  <h2>Methods</h2>
140
+ <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
141
+ <a name="get" class="tsd-anchor"></a>
142
+ <h3>get</h3>
143
+ <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
144
+ <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.Tunnel.html" class="tsd-signature-type" data-tsd-kind="Interface">Tunnel</a><span class="tsd-signature-symbol">&gt;</span></li>
145
+ </ul>
146
+ <ul class="tsd-descriptions">
147
+ <li class="tsd-description">
148
+ <aside class="tsd-sources">
149
+ <ul>
150
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L3373">services.ts:3373</a></li>
151
+ </ul>
152
+ </aside>
153
+ <div class="tsd-comment tsd-typography">
154
+ <div class="lead">
155
+ <p>Get the status of a tunnel by ID</p>
156
+ </div>
157
+ </div>
158
+ <h4 class="tsd-parameters-title">Parameters</h4>
159
+ <ul class="tsd-parameters">
160
+ <li>
161
+ <h5>arg: <a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a></h5>
162
+ </li>
163
+ </ul>
164
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.Tunnel.html" class="tsd-signature-type" data-tsd-kind="Interface">Tunnel</a><span class="tsd-signature-symbol">&gt;</span></h4>
165
+ </li>
166
+ </ul>
167
+ </section>
139
168
  <section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
140
169
  <a name="list" class="tsd-anchor"></a>
141
170
  <h3>list</h3>
@@ -146,7 +175,7 @@
146
175
  <li class="tsd-description">
147
176
  <aside class="tsd-sources">
148
177
  <ul>
149
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L2523">services.ts:2523</a></li>
178
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L3333">services.ts:3333</a></li>
150
179
  </ul>
151
180
  </aside>
152
181
  <div class="tsd-comment tsd-typography">
@@ -179,105 +208,6 @@
179
208
  </nav>
180
209
  <nav class="tsd-navigation secondary menu-sticky">
181
210
  <ul class="before-current">
182
- <li class=" tsd-kind-class tsd-parent-kind-module">
183
- <a href="services.APIKeys.html" class="tsd-kind-icon">APIKeys</a>
184
- </li>
185
- <li class=" tsd-kind-class tsd-parent-kind-module">
186
- <a href="services.AbuseReports.html" class="tsd-kind-icon">Abuse<wbr>Reports</a>
187
- </li>
188
- <li class=" tsd-kind-class tsd-parent-kind-module">
189
- <a href="services.AgentIngresses.html" class="tsd-kind-icon">Agent<wbr>Ingresses</a>
190
- </li>
191
- <li class=" tsd-kind-class tsd-parent-kind-module">
192
- <a href="services.CertificateAuthorities.html" class="tsd-kind-icon">Certificate<wbr>Authorities</a>
193
- </li>
194
- <li class=" tsd-kind-class tsd-parent-kind-module">
195
- <a href="services.Credentials.html" class="tsd-kind-icon">Credentials</a>
196
- </li>
197
- <li class=" tsd-kind-class tsd-parent-kind-module">
198
- <a href="services.EndpointCircuitBreakerModule.html" class="tsd-kind-icon">Endpoint<wbr>Circuit<wbr>Breaker<wbr>Module</a>
199
- </li>
200
- <li class=" tsd-kind-class tsd-parent-kind-module">
201
- <a href="services.EndpointCompressionModule.html" class="tsd-kind-icon">Endpoint<wbr>Compression<wbr>Module</a>
202
- </li>
203
- <li class=" tsd-kind-class tsd-parent-kind-module">
204
- <a href="services.EndpointConfigurations.html" class="tsd-kind-icon">Endpoint<wbr>Configurations</a>
205
- </li>
206
- <li class=" tsd-kind-class tsd-parent-kind-module">
207
- <a href="services.EndpointIPPolicyModule.html" class="tsd-kind-icon">EndpointIPPolicy<wbr>Module</a>
208
- </li>
209
- <li class=" tsd-kind-class tsd-parent-kind-module">
210
- <a href="services.EndpointLoggingModule.html" class="tsd-kind-icon">Endpoint<wbr>Logging<wbr>Module</a>
211
- </li>
212
- <li class=" tsd-kind-class tsd-parent-kind-module">
213
- <a href="services.EndpointMutualTLSModule.html" class="tsd-kind-icon">Endpoint<wbr>MutualTLSModule</a>
214
- </li>
215
- <li class=" tsd-kind-class tsd-parent-kind-module">
216
- <a href="services.EndpointOAuthModule.html" class="tsd-kind-icon">EndpointOAuth<wbr>Module</a>
217
- </li>
218
- <li class=" tsd-kind-class tsd-parent-kind-module">
219
- <a href="services.EndpointOIDCModule.html" class="tsd-kind-icon">EndpointOIDCModule</a>
220
- </li>
221
- <li class=" tsd-kind-class tsd-parent-kind-module">
222
- <a href="services.EndpointRequestHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Request<wbr>Headers<wbr>Module</a>
223
- </li>
224
- <li class=" tsd-kind-class tsd-parent-kind-module">
225
- <a href="services.EndpointResponseHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Response<wbr>Headers<wbr>Module</a>
226
- </li>
227
- <li class=" tsd-kind-class tsd-parent-kind-module">
228
- <a href="services.EndpointSAMLModule.html" class="tsd-kind-icon">EndpointSAMLModule</a>
229
- </li>
230
- <li class=" tsd-kind-class tsd-parent-kind-module">
231
- <a href="services.EndpointTLSTerminationModule.html" class="tsd-kind-icon">EndpointTLSTermination<wbr>Module</a>
232
- </li>
233
- <li class=" tsd-kind-class tsd-parent-kind-module">
234
- <a href="services.EndpointWebhookValidationModule.html" class="tsd-kind-icon">Endpoint<wbr>Webhook<wbr>Validation<wbr>Module</a>
235
- </li>
236
- <li class=" tsd-kind-class tsd-parent-kind-module">
237
- <a href="services.EventDestinations.html" class="tsd-kind-icon">Event<wbr>Destinations</a>
238
- </li>
239
- <li class=" tsd-kind-class tsd-parent-kind-module">
240
- <a href="services.EventSources.html" class="tsd-kind-icon">Event<wbr>Sources</a>
241
- </li>
242
- <li class=" tsd-kind-class tsd-parent-kind-module">
243
- <a href="services.EventStreams.html" class="tsd-kind-icon">Event<wbr>Streams</a>
244
- </li>
245
- <li class=" tsd-kind-class tsd-parent-kind-module">
246
- <a href="services.EventSubscriptions.html" class="tsd-kind-icon">Event<wbr>Subscriptions</a>
247
- </li>
248
- <li class=" tsd-kind-class tsd-parent-kind-module">
249
- <a href="services.IPPolicies.html" class="tsd-kind-icon">IPPolicies</a>
250
- </li>
251
- <li class=" tsd-kind-class tsd-parent-kind-module">
252
- <a href="services.IPPolicyRules.html" class="tsd-kind-icon">IPPolicy<wbr>Rules</a>
253
- </li>
254
- <li class=" tsd-kind-class tsd-parent-kind-module">
255
- <a href="services.IPRestrictions.html" class="tsd-kind-icon">IPRestrictions</a>
256
- </li>
257
- <li class=" tsd-kind-class tsd-parent-kind-module">
258
- <a href="services.ReservedAddrs.html" class="tsd-kind-icon">Reserved<wbr>Addrs</a>
259
- </li>
260
- <li class=" tsd-kind-class tsd-parent-kind-module">
261
- <a href="services.ReservedDomains.html" class="tsd-kind-icon">Reserved<wbr>Domains</a>
262
- </li>
263
- <li class=" tsd-kind-class tsd-parent-kind-module">
264
- <a href="services.SSHCertificateAuthorities.html" class="tsd-kind-icon">SSHCertificate<wbr>Authorities</a>
265
- </li>
266
- <li class=" tsd-kind-class tsd-parent-kind-module">
267
- <a href="services.SSHCredentials.html" class="tsd-kind-icon">SSHCredentials</a>
268
- </li>
269
- <li class=" tsd-kind-class tsd-parent-kind-module">
270
- <a href="services.SSHHostCertificates.html" class="tsd-kind-icon">SSHHost<wbr>Certificates</a>
271
- </li>
272
- <li class=" tsd-kind-class tsd-parent-kind-module">
273
- <a href="services.SSHUserCertificates.html" class="tsd-kind-icon">SSHUser<wbr>Certificates</a>
274
- </li>
275
- <li class=" tsd-kind-class tsd-parent-kind-module">
276
- <a href="services.TLSCertificates.html" class="tsd-kind-icon">TLSCertificates</a>
277
- </li>
278
- <li class=" tsd-kind-class tsd-parent-kind-module">
279
- <a href="services.TunnelSessions.html" class="tsd-kind-icon">Tunnel<wbr>Sessions</a>
280
- </li>
281
211
  </ul>
282
212
  <ul class="current">
283
213
  <li class="current tsd-kind-class tsd-parent-kind-module">
@@ -286,6 +216,9 @@
286
216
  <li class=" tsd-kind-constructor tsd-parent-kind-class">
287
217
  <a href="services.Tunnels.html#constructor" class="tsd-kind-icon">constructor</a>
288
218
  </li>
219
+ <li class=" tsd-kind-method tsd-parent-kind-class">
220
+ <a href="services.Tunnels.html#get" class="tsd-kind-icon">get</a>
221
+ </li>
289
222
  <li class=" tsd-kind-method tsd-parent-kind-class">
290
223
  <a href="services.Tunnels.html#list" class="tsd-kind-icon">list</a>
291
224
  </li>
package/docs/classes/{services.EventStreams.html → services.WeightedBackends.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>EventStreams | @ngrok/ngrok-api</title>
6
+ <title>WeightedBackends | @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,21 +58,31 @@
58
58
  <a href="../modules/services.html">services</a>
59
59
  </li>
60
60
  <li>
61
- <a href="services.EventStreams.html">EventStreams</a>
61
+ <a href="services.WeightedBackends.html">WeightedBackends</a>
62
62
  </li>
63
63
  </ul>
64
- <h1>Class EventStreams</h1>
64
+ <h1>Class WeightedBackends</h1>
65
65
  </div>
66
66
  </div>
67
67
  </header>
68
68
  <div class="container container-main">
69
69
  <div class="row">
70
70
  <div class="col-8 col-content">
71
+ <section class="tsd-panel tsd-comment">
72
+ <div class="tsd-comment tsd-typography">
73
+ <div class="lead">
74
+ <p>A Weighted Backend balances traffic among the referenced backends. Traffic
75
+ is assigned proportionally to each based on its weight. The percentage of
76
+ traffic is calculated by dividing a backend&#39;s weight by the sum of all
77
+ weights.</p>
78
+ </div>
79
+ </div>
80
+ </section>
71
81
  <section class="tsd-panel tsd-hierarchy">
72
82
  <h3>Hierarchy</h3>
73
83
  <ul class="tsd-hierarchy">
74
84
  <li>
75
- <span class="target">EventStreams</span>
85
+ <span class="target">WeightedBackends</span>
76
86
  </li>
77
87
  </ul>
78
88
  </section>
@@ -83,17 +93,17 @@
83
93
  <section class="tsd-index-section ">
84
94
  <h3>Constructors</h3>
85
95
  <ul class="tsd-index-list">
86
- <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="services.EventStreams.html#constructor" class="tsd-kind-icon">constructor</a></li>
96
+ <li class="tsd-kind-constructor tsd-parent-kind-class"><a href="services.WeightedBackends.html#constructor" class="tsd-kind-icon">constructor</a></li>
87
97
  </ul>
88
98
  </section>
89
99
  <section class="tsd-index-section ">
90
100
  <h3>Methods</h3>
91
101
  <ul class="tsd-index-list">
92
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.EventStreams.html#create" class="tsd-kind-icon">create</a></li>
93
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.EventStreams.html#delete" class="tsd-kind-icon">delete</a></li>
94
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.EventStreams.html#get" class="tsd-kind-icon">get</a></li>
95
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.EventStreams.html#list" class="tsd-kind-icon">list</a></li>
96
- <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.EventStreams.html#update" class="tsd-kind-icon">update</a></li>
102
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.WeightedBackends.html#create" class="tsd-kind-icon">create</a></li>
103
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.WeightedBackends.html#delete" class="tsd-kind-icon">delete</a></li>
104
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.WeightedBackends.html#get" class="tsd-kind-icon">get</a></li>
105
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.WeightedBackends.html#list" class="tsd-kind-icon">list</a></li>
106
+ <li class="tsd-kind-method tsd-parent-kind-class"><a href="services.WeightedBackends.html#update" class="tsd-kind-icon">update</a></li>
97
107
  </ul>
98
108
  </section>
99
109
  </div>
@@ -105,18 +115,18 @@
105
115
  <a name="constructor" class="tsd-anchor"></a>
106
116
  <h3>constructor</h3>
107
117
  <ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
108
- <li class="tsd-signature tsd-kind-icon">new <wbr>Event<wbr>Streams<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.EventStreams.html" class="tsd-signature-type" data-tsd-kind="Class">EventStreams</a></li>
118
+ <li class="tsd-signature tsd-kind-icon">new <wbr>Weighted<wbr>Backends<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.WeightedBackends.html" class="tsd-signature-type" data-tsd-kind="Class">WeightedBackends</a></li>
109
119
  </ul>
110
120
  <ul class="tsd-descriptions">
111
121
  <li class="tsd-description">
112
122
  <aside class="tsd-sources">
113
123
  <ul>
114
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L555">services.ts:555</a></li>
124
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L538">services.ts:538</a></li>
115
125
  </ul>
116
126
  </aside>
117
127
  <div class="tsd-comment tsd-typography">
118
128
  <div class="lead">
119
- <p>Do not construct this object directly, use the <code>eventStreams</code> property of an <code>Ngrok</code> client object instead.</p>
129
+ <p>Do not construct this object directly, use the <code>weightedBackends</code> property of an <code>Ngrok</code> client object instead.</p>
120
130
  </div>
121
131
  </div>
122
132
  <h4 class="tsd-parameters-title">Parameters</h4>
@@ -125,7 +135,7 @@
125
135
  <h5>httpClient: <span class="tsd-signature-type">Wretcher</span></h5>
126
136
  </li>
127
137
  </ul>
128
- <h4 class="tsd-returns-title">Returns <a href="services.EventStreams.html" class="tsd-signature-type" data-tsd-kind="Class">EventStreams</a></h4>
138
+ <h4 class="tsd-returns-title">Returns <a href="services.WeightedBackends.html" class="tsd-signature-type" data-tsd-kind="Class">WeightedBackends</a></h4>
129
139
  </li>
130
140
  </ul>
131
141
  </section>
@@ -136,27 +146,27 @@
136
146
  <a name="create" class="tsd-anchor"></a>
137
147
  <h3>create</h3>
138
148
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
139
- <li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.EventStreamCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">EventStreamCreate</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.EventStream.html" class="tsd-signature-type" data-tsd-kind="Interface">EventStream</a><span class="tsd-signature-symbol">&gt;</span></li>
149
+ <li class="tsd-signature tsd-kind-icon">create<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.WeightedBackendCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">WeightedBackendCreate</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.WeightedBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">WeightedBackend</a><span class="tsd-signature-symbol">&gt;</span></li>
140
150
  </ul>
141
151
  <ul class="tsd-descriptions">
142
152
  <li class="tsd-description">
143
153
  <aside class="tsd-sources">
144
154
  <ul>
145
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L561">services.ts:561</a></li>
155
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L544">services.ts:544</a></li>
146
156
  </ul>
147
157
  </aside>
148
158
  <div class="tsd-comment tsd-typography">
149
159
  <div class="lead">
150
- <p>Create a new Event Stream. It will not apply to anything until you associate it with one or more Endpoint Configs.</p>
160
+ <p>Create a new Weighted backend</p>
151
161
  </div>
152
162
  </div>
153
163
  <h4 class="tsd-parameters-title">Parameters</h4>
154
164
  <ul class="tsd-parameters">
155
165
  <li>
156
- <h5>arg: <a href="../interfaces/datatypes.EventStreamCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">EventStreamCreate</a></h5>
166
+ <h5>arg: <a href="../interfaces/datatypes.WeightedBackendCreate.html" class="tsd-signature-type" data-tsd-kind="Interface">WeightedBackendCreate</a></h5>
157
167
  </li>
158
168
  </ul>
159
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.EventStream.html" class="tsd-signature-type" data-tsd-kind="Interface">EventStream</a><span class="tsd-signature-symbol">&gt;</span></h4>
169
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.WeightedBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">WeightedBackend</a><span class="tsd-signature-symbol">&gt;</span></h4>
160
170
  </li>
161
171
  </ul>
162
172
  </section>
@@ -170,12 +180,12 @@
170
180
  <li class="tsd-description">
171
181
  <aside class="tsd-sources">
172
182
  <ul>
173
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L574">services.ts:574</a></li>
183
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L557">services.ts:557</a></li>
174
184
  </ul>
175
185
  </aside>
176
186
  <div class="tsd-comment tsd-typography">
177
187
  <div class="lead">
178
- <p>Delete an Event Stream. Associated Event Destinations will be preserved.</p>
188
+ <p>Delete a Weighted backend by ID.</p>
179
189
  </div>
180
190
  </div>
181
191
  <h4 class="tsd-parameters-title">Parameters</h4>
@@ -192,18 +202,18 @@
192
202
  <a name="get" class="tsd-anchor"></a>
193
203
  <h3>get</h3>
194
204
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
195
- <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.EventStream.html" class="tsd-signature-type" data-tsd-kind="Interface">EventStream</a><span class="tsd-signature-symbol">&gt;</span></li>
205
+ <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.WeightedBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">WeightedBackend</a><span class="tsd-signature-symbol">&gt;</span></li>
196
206
  </ul>
197
207
  <ul class="tsd-descriptions">
198
208
  <li class="tsd-description">
199
209
  <aside class="tsd-sources">
200
210
  <ul>
201
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L585">services.ts:585</a></li>
211
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L568">services.ts:568</a></li>
202
212
  </ul>
203
213
  </aside>
204
214
  <div class="tsd-comment tsd-typography">
205
215
  <div class="lead">
206
- <p>Get detailed information about an Event Stream by ID.</p>
216
+ <p>Get detailed information about a Weighted backend by ID</p>
207
217
  </div>
208
218
  </div>
209
219
  <h4 class="tsd-parameters-title">Parameters</h4>
@@ -212,7 +222,7 @@
212
222
  <h5>arg: <a href="../interfaces/datatypes.Item.html" class="tsd-signature-type" data-tsd-kind="Interface">Item</a></h5>
213
223
  </li>
214
224
  </ul>
215
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.EventStream.html" class="tsd-signature-type" data-tsd-kind="Interface">EventStream</a><span class="tsd-signature-symbol">&gt;</span></h4>
225
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.WeightedBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">WeightedBackend</a><span class="tsd-signature-symbol">&gt;</span></h4>
216
226
  </li>
217
227
  </ul>
218
228
  </section>
@@ -220,21 +230,21 @@
220
230
  <a name="list" class="tsd-anchor"></a>
221
231
  <h3>list</h3>
222
232
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
223
- <li class="tsd-signature tsd-kind-icon">list<span class="tsd-signature-symbol">(</span><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.EventStream.html" class="tsd-signature-type" data-tsd-kind="Interface">EventStream</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
233
+ <li class="tsd-signature tsd-kind-icon">list<span class="tsd-signature-symbol">(</span><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.WeightedBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">WeightedBackend</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li>
224
234
  </ul>
225
235
  <ul class="tsd-descriptions">
226
236
  <li class="tsd-description">
227
237
  <aside class="tsd-sources">
228
238
  <ul>
229
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L596">services.ts:596</a></li>
239
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L579">services.ts:579</a></li>
230
240
  </ul>
231
241
  </aside>
232
242
  <div class="tsd-comment tsd-typography">
233
243
  <div class="lead">
234
- <p>List all Event Streams available on this account.</p>
244
+ <p>List all Weighted backends on this account</p>
235
245
  </div>
236
246
  </div>
237
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.EventStream.html" class="tsd-signature-type" data-tsd-kind="Interface">EventStream</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
247
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.WeightedBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">WeightedBackend</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4>
238
248
  </li>
239
249
  </ul>
240
250
  </section>
@@ -242,27 +252,27 @@
242
252
  <a name="update" class="tsd-anchor"></a>
243
253
  <h3>update</h3>
244
254
  <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
245
- <li class="tsd-signature tsd-kind-icon">update<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.EventStreamUpdate.html" class="tsd-signature-type" data-tsd-kind="Interface">EventStreamUpdate</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.EventStream.html" class="tsd-signature-type" data-tsd-kind="Interface">EventStream</a><span class="tsd-signature-symbol">&gt;</span></li>
255
+ <li class="tsd-signature tsd-kind-icon">update<span class="tsd-signature-symbol">(</span>arg<span class="tsd-signature-symbol">: </span><a href="../interfaces/datatypes.WeightedBackendUpdate.html" class="tsd-signature-type" data-tsd-kind="Interface">WeightedBackendUpdate</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.WeightedBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">WeightedBackend</a><span class="tsd-signature-symbol">&gt;</span></li>
246
256
  </ul>
247
257
  <ul class="tsd-descriptions">
248
258
  <li class="tsd-description">
249
259
  <aside class="tsd-sources">
250
260
  <ul>
251
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/1a198cb/src/services.ts#L638">services.ts:638</a></li>
261
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/services.ts#L621">services.ts:621</a></li>
252
262
  </ul>
253
263
  </aside>
254
264
  <div class="tsd-comment tsd-typography">
255
265
  <div class="lead">
256
- <p>Update attributes of an Event Stream by ID.</p>
266
+ <p>Update Weighted backend by ID</p>
257
267
  </div>
258
268
  </div>
259
269
  <h4 class="tsd-parameters-title">Parameters</h4>
260
270
  <ul class="tsd-parameters">
261
271
  <li>
262
- <h5>arg: <a href="../interfaces/datatypes.EventStreamUpdate.html" class="tsd-signature-type" data-tsd-kind="Interface">EventStreamUpdate</a></h5>
272
+ <h5>arg: <a href="../interfaces/datatypes.WeightedBackendUpdate.html" class="tsd-signature-type" data-tsd-kind="Interface">WeightedBackendUpdate</a></h5>
263
273
  </li>
264
274
  </ul>
265
- <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.EventStream.html" class="tsd-signature-type" data-tsd-kind="Interface">EventStream</a><span class="tsd-signature-symbol">&gt;</span></h4>
275
+ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/datatypes.WeightedBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">WeightedBackend</a><span class="tsd-signature-symbol">&gt;</span></h4>
266
276
  </li>
267
277
  </ul>
268
278
  </section>
@@ -287,132 +297,33 @@
287
297
  </nav>
288
298
  <nav class="tsd-navigation secondary menu-sticky">
289
299
  <ul class="before-current">
290
- <li class=" tsd-kind-class tsd-parent-kind-module">
291
- <a href="services.APIKeys.html" class="tsd-kind-icon">APIKeys</a>
292
- </li>
293
- <li class=" tsd-kind-class tsd-parent-kind-module">
294
- <a href="services.AbuseReports.html" class="tsd-kind-icon">Abuse<wbr>Reports</a>
295
- </li>
296
- <li class=" tsd-kind-class tsd-parent-kind-module">
297
- <a href="services.AgentIngresses.html" class="tsd-kind-icon">Agent<wbr>Ingresses</a>
298
- </li>
299
- <li class=" tsd-kind-class tsd-parent-kind-module">
300
- <a href="services.CertificateAuthorities.html" class="tsd-kind-icon">Certificate<wbr>Authorities</a>
301
- </li>
302
- <li class=" tsd-kind-class tsd-parent-kind-module">
303
- <a href="services.Credentials.html" class="tsd-kind-icon">Credentials</a>
304
- </li>
305
- <li class=" tsd-kind-class tsd-parent-kind-module">
306
- <a href="services.EndpointCircuitBreakerModule.html" class="tsd-kind-icon">Endpoint<wbr>Circuit<wbr>Breaker<wbr>Module</a>
307
- </li>
308
- <li class=" tsd-kind-class tsd-parent-kind-module">
309
- <a href="services.EndpointCompressionModule.html" class="tsd-kind-icon">Endpoint<wbr>Compression<wbr>Module</a>
310
- </li>
311
- <li class=" tsd-kind-class tsd-parent-kind-module">
312
- <a href="services.EndpointConfigurations.html" class="tsd-kind-icon">Endpoint<wbr>Configurations</a>
313
- </li>
314
- <li class=" tsd-kind-class tsd-parent-kind-module">
315
- <a href="services.EndpointIPPolicyModule.html" class="tsd-kind-icon">EndpointIPPolicy<wbr>Module</a>
316
- </li>
317
- <li class=" tsd-kind-class tsd-parent-kind-module">
318
- <a href="services.EndpointLoggingModule.html" class="tsd-kind-icon">Endpoint<wbr>Logging<wbr>Module</a>
319
- </li>
320
- <li class=" tsd-kind-class tsd-parent-kind-module">
321
- <a href="services.EndpointMutualTLSModule.html" class="tsd-kind-icon">Endpoint<wbr>MutualTLSModule</a>
322
- </li>
323
- <li class=" tsd-kind-class tsd-parent-kind-module">
324
- <a href="services.EndpointOAuthModule.html" class="tsd-kind-icon">EndpointOAuth<wbr>Module</a>
325
- </li>
326
- <li class=" tsd-kind-class tsd-parent-kind-module">
327
- <a href="services.EndpointOIDCModule.html" class="tsd-kind-icon">EndpointOIDCModule</a>
328
- </li>
329
- <li class=" tsd-kind-class tsd-parent-kind-module">
330
- <a href="services.EndpointRequestHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Request<wbr>Headers<wbr>Module</a>
331
- </li>
332
- <li class=" tsd-kind-class tsd-parent-kind-module">
333
- <a href="services.EndpointResponseHeadersModule.html" class="tsd-kind-icon">Endpoint<wbr>Response<wbr>Headers<wbr>Module</a>
334
- </li>
335
- <li class=" tsd-kind-class tsd-parent-kind-module">
336
- <a href="services.EndpointSAMLModule.html" class="tsd-kind-icon">EndpointSAMLModule</a>
337
- </li>
338
- <li class=" tsd-kind-class tsd-parent-kind-module">
339
- <a href="services.EndpointTLSTerminationModule.html" class="tsd-kind-icon">EndpointTLSTermination<wbr>Module</a>
340
- </li>
341
- <li class=" tsd-kind-class tsd-parent-kind-module">
342
- <a href="services.EndpointWebhookValidationModule.html" class="tsd-kind-icon">Endpoint<wbr>Webhook<wbr>Validation<wbr>Module</a>
343
- </li>
344
- <li class=" tsd-kind-class tsd-parent-kind-module">
345
- <a href="services.EventDestinations.html" class="tsd-kind-icon">Event<wbr>Destinations</a>
346
- </li>
347
- <li class=" tsd-kind-class tsd-parent-kind-module">
348
- <a href="services.EventSources.html" class="tsd-kind-icon">Event<wbr>Sources</a>
349
- </li>
350
300
  </ul>
351
301
  <ul class="current">
352
302
  <li class="current tsd-kind-class tsd-parent-kind-module">
353
- <a href="services.EventStreams.html" class="tsd-kind-icon">Event<wbr>Streams</a>
303
+ <a href="services.WeightedBackends.html" class="tsd-kind-icon">Weighted<wbr>Backends</a>
354
304
  <ul>
355
305
  <li class=" tsd-kind-constructor tsd-parent-kind-class">
356
- <a href="services.EventStreams.html#constructor" class="tsd-kind-icon">constructor</a>
306
+ <a href="services.WeightedBackends.html#constructor" class="tsd-kind-icon">constructor</a>
357
307
  </li>
358
308
  <li class=" tsd-kind-method tsd-parent-kind-class">
359
- <a href="services.EventStreams.html#create" class="tsd-kind-icon">create</a>
309
+ <a href="services.WeightedBackends.html#create" class="tsd-kind-icon">create</a>
360
310
  </li>
361
311
  <li class=" tsd-kind-method tsd-parent-kind-class">
362
- <a href="services.EventStreams.html#delete" class="tsd-kind-icon">delete</a>
312
+ <a href="services.WeightedBackends.html#delete" class="tsd-kind-icon">delete</a>
363
313
  </li>
364
314
  <li class=" tsd-kind-method tsd-parent-kind-class">
365
- <a href="services.EventStreams.html#get" class="tsd-kind-icon">get</a>
315
+ <a href="services.WeightedBackends.html#get" class="tsd-kind-icon">get</a>
366
316
  </li>
367
317
  <li class=" tsd-kind-method tsd-parent-kind-class">
368
- <a href="services.EventStreams.html#list" class="tsd-kind-icon">list</a>
318
+ <a href="services.WeightedBackends.html#list" class="tsd-kind-icon">list</a>
369
319
  </li>
370
320
  <li class=" tsd-kind-method tsd-parent-kind-class">
371
- <a href="services.EventStreams.html#update" class="tsd-kind-icon">update</a>
321
+ <a href="services.WeightedBackends.html#update" class="tsd-kind-icon">update</a>
372
322
  </li>
373
323
  </ul>
374
324
  </li>
375
325
  </ul>
376
326
  <ul class="after-current">
377
- <li class=" tsd-kind-class tsd-parent-kind-module">
378
- <a href="services.EventSubscriptions.html" class="tsd-kind-icon">Event<wbr>Subscriptions</a>
379
- </li>
380
- <li class=" tsd-kind-class tsd-parent-kind-module">
381
- <a href="services.IPPolicies.html" class="tsd-kind-icon">IPPolicies</a>
382
- </li>
383
- <li class=" tsd-kind-class tsd-parent-kind-module">
384
- <a href="services.IPPolicyRules.html" class="tsd-kind-icon">IPPolicy<wbr>Rules</a>
385
- </li>
386
- <li class=" tsd-kind-class tsd-parent-kind-module">
387
- <a href="services.IPRestrictions.html" class="tsd-kind-icon">IPRestrictions</a>
388
- </li>
389
- <li class=" tsd-kind-class tsd-parent-kind-module">
390
- <a href="services.ReservedAddrs.html" class="tsd-kind-icon">Reserved<wbr>Addrs</a>
391
- </li>
392
- <li class=" tsd-kind-class tsd-parent-kind-module">
393
- <a href="services.ReservedDomains.html" class="tsd-kind-icon">Reserved<wbr>Domains</a>
394
- </li>
395
- <li class=" tsd-kind-class tsd-parent-kind-module">
396
- <a href="services.SSHCertificateAuthorities.html" class="tsd-kind-icon">SSHCertificate<wbr>Authorities</a>
397
- </li>
398
- <li class=" tsd-kind-class tsd-parent-kind-module">
399
- <a href="services.SSHCredentials.html" class="tsd-kind-icon">SSHCredentials</a>
400
- </li>
401
- <li class=" tsd-kind-class tsd-parent-kind-module">
402
- <a href="services.SSHHostCertificates.html" class="tsd-kind-icon">SSHHost<wbr>Certificates</a>
403
- </li>
404
- <li class=" tsd-kind-class tsd-parent-kind-module">
405
- <a href="services.SSHUserCertificates.html" class="tsd-kind-icon">SSHUser<wbr>Certificates</a>
406
- </li>
407
- <li class=" tsd-kind-class tsd-parent-kind-module">
408
- <a href="services.TLSCertificates.html" class="tsd-kind-icon">TLSCertificates</a>
409
- </li>
410
- <li class=" tsd-kind-class tsd-parent-kind-module">
411
- <a href="services.TunnelSessions.html" class="tsd-kind-icon">Tunnel<wbr>Sessions</a>
412
- </li>
413
- <li class=" tsd-kind-class tsd-parent-kind-module">
414
- <a href="services.Tunnels.html" class="tsd-kind-icon">Tunnels</a>
415
- </li>
416
327
  </ul>
417
328
  </nav>
418
329
  </div>