@ngrok/ngrok-api 0.17.0 → 0.19.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 (295) hide show
  1. package/CHANGELOG.md +10 -0
  2. package/docs/assets/js/search.js +1 -1
  3. package/docs/classes/client.Ngrok.html +44 -30
  4. package/docs/classes/services.APIKeys.html +6 -6
  5. package/docs/classes/services.AbuseReports.html +3 -3
  6. package/docs/classes/services.AgentIngresses.html +6 -6
  7. package/docs/classes/services.ApplicationSessions.html +4 -4
  8. package/docs/classes/services.ApplicationUsers.html +4 -4
  9. package/docs/classes/services.BotUsers.html +6 -6
  10. package/docs/classes/services.CertificateAuthorities.html +7 -7
  11. package/docs/classes/services.Credentials.html +6 -6
  12. package/docs/classes/services.EdgeRouteBackendModule.html +4 -4
  13. package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +4 -4
  14. package/docs/classes/services.EdgeRouteCompressionModule.html +4 -4
  15. package/docs/classes/services.EdgeRouteIPRestrictionModule.html +4 -4
  16. package/docs/classes/services.EdgeRouteOAuthModule.html +4 -4
  17. package/docs/classes/services.EdgeRouteOIDCModule.html +4 -4
  18. package/docs/classes/services.EdgeRouteRequestHeadersModule.html +4 -4
  19. package/docs/classes/services.EdgeRouteResponseHeadersModule.html +4 -4
  20. package/docs/classes/services.EdgeRouteSAMLModule.html +4 -4
  21. package/docs/classes/services.EdgeRouteTrafficPolicyModule.html +4 -4
  22. package/docs/classes/services.EdgeRouteUserAgentFilterModule.html +4 -4
  23. package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +4 -4
  24. package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +4 -4
  25. package/docs/classes/services.EdgesHTTPS.html +6 -6
  26. package/docs/classes/services.EdgesHTTPSRoutes.html +5 -5
  27. package/docs/classes/services.EdgesTCP.html +6 -6
  28. package/docs/classes/services.EdgesTLS.html +6 -6
  29. package/docs/classes/services.Endpoints.html +6 -6
  30. package/docs/classes/services.EventDestinations.html +6 -6
  31. package/docs/classes/services.EventSources.html +6 -6
  32. package/docs/classes/services.EventSubscriptions.html +6 -6
  33. package/docs/classes/services.FailoverBackends.html +6 -6
  34. package/docs/classes/services.HTTPResponseBackends.html +6 -6
  35. package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +4 -4
  36. package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +4 -4
  37. package/docs/classes/services.IPPolicies.html +6 -6
  38. package/docs/classes/services.IPPolicyRules.html +6 -6
  39. package/docs/classes/services.IPRestrictions.html +6 -6
  40. package/docs/classes/services.ReservedAddrs.html +6 -6
  41. package/docs/classes/services.ReservedDomains.html +8 -8
  42. package/docs/classes/services.SSHCertificateAuthorities.html +7 -7
  43. package/docs/classes/services.SSHCredentials.html +6 -6
  44. package/docs/classes/services.SSHHostCertificates.html +7 -7
  45. package/docs/classes/services.SSHUserCertificates.html +7 -7
  46. package/docs/classes/services.Secrets.html +6 -6
  47. package/docs/classes/services.ServiceUsers.html +352 -0
  48. package/docs/classes/services.StaticBackends.html +6 -6
  49. package/docs/classes/services.TCPEdgeBackendModule.html +4 -4
  50. package/docs/classes/services.TCPEdgeIPRestrictionModule.html +4 -4
  51. package/docs/classes/services.TCPEdgeTrafficPolicyModule.html +4 -4
  52. package/docs/classes/services.TLSCertificates.html +6 -6
  53. package/docs/classes/services.TLSEdgeBackendModule.html +4 -4
  54. package/docs/classes/services.TLSEdgeIPRestrictionModule.html +4 -4
  55. package/docs/classes/services.TLSEdgeMutualTLSModule.html +4 -4
  56. package/docs/classes/services.TLSEdgeTLSTerminationModule.html +4 -4
  57. package/docs/classes/services.TLSEdgeTrafficPolicyModule.html +4 -4
  58. package/docs/classes/services.TunnelGroupBackends.html +6 -6
  59. package/docs/classes/services.TunnelSessions.html +6 -6
  60. package/docs/classes/services.Tunnels.html +3 -3
  61. package/docs/classes/services.Vaults.html +7 -7
  62. package/docs/classes/services.WeightedBackends.html +6 -6
  63. package/docs/interfaces/client.NgrokConfig.html +2 -2
  64. package/docs/interfaces/datatypes.APIKey.html +7 -7
  65. package/docs/interfaces/datatypes.APIKeyCreate.html +3 -3
  66. package/docs/interfaces/datatypes.APIKeyList.html +3 -3
  67. package/docs/interfaces/datatypes.APIKeyUpdate.html +3 -3
  68. package/docs/interfaces/datatypes.AWSAuth.html +2 -2
  69. package/docs/interfaces/datatypes.AWSCredentials.html +2 -2
  70. package/docs/interfaces/datatypes.AWSRole.html +1 -1
  71. package/docs/interfaces/datatypes.AbuseReport.html +7 -7
  72. package/docs/interfaces/datatypes.AbuseReportCreate.html +2 -2
  73. package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
  74. package/docs/interfaces/datatypes.AgentIngress.html +10 -10
  75. package/docs/interfaces/datatypes.AgentIngressCertJob.html +4 -4
  76. package/docs/interfaces/datatypes.AgentIngressCertPolicy.html +2 -2
  77. package/docs/interfaces/datatypes.AgentIngressCertStatus.html +2 -2
  78. package/docs/interfaces/datatypes.AgentIngressCreate.html +4 -4
  79. package/docs/interfaces/datatypes.AgentIngressList.html +3 -3
  80. package/docs/interfaces/datatypes.AgentIngressUpdate.html +4 -4
  81. package/docs/interfaces/datatypes.ApplicationSession.html +11 -11
  82. package/docs/interfaces/datatypes.ApplicationSessionList.html +3 -3
  83. package/docs/interfaces/datatypes.ApplicationUser.html +10 -10
  84. package/docs/interfaces/datatypes.ApplicationUserList.html +3 -3
  85. package/docs/interfaces/datatypes.BotUser.html +5 -5
  86. package/docs/interfaces/datatypes.BotUserCreate.html +2 -2
  87. package/docs/interfaces/datatypes.BotUserList.html +3 -3
  88. package/docs/interfaces/datatypes.BotUserUpdate.html +3 -3
  89. package/docs/interfaces/datatypes.BrowserSession.html +3 -3
  90. package/docs/interfaces/datatypes.CertificateAuthority.html +11 -11
  91. package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +3 -3
  92. package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
  93. package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
  94. package/docs/interfaces/datatypes.Credential.html +9 -9
  95. package/docs/interfaces/datatypes.CredentialCreate.html +5 -5
  96. package/docs/interfaces/datatypes.CredentialList.html +3 -3
  97. package/docs/interfaces/datatypes.CredentialUpdate.html +4 -4
  98. package/docs/interfaces/datatypes.EdgeBackendReplace.html +2 -2
  99. package/docs/interfaces/datatypes.EdgeIPRestrictionReplace.html +2 -2
  100. package/docs/interfaces/datatypes.EdgeMutualTLSReplace.html +2 -2
  101. package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +3 -3
  102. package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +3 -3
  103. package/docs/interfaces/datatypes.EdgeRouteCompressionReplace.html +3 -3
  104. package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +3 -3
  105. package/docs/interfaces/datatypes.EdgeRouteItem.html +2 -2
  106. package/docs/interfaces/datatypes.EdgeRouteOAuthReplace.html +3 -3
  107. package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +3 -3
  108. package/docs/interfaces/datatypes.EdgeRouteRequestHeadersReplace.html +3 -3
  109. package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +3 -3
  110. package/docs/interfaces/datatypes.EdgeRouteSAMLReplace.html +3 -3
  111. package/docs/interfaces/datatypes.EdgeRouteTrafficPolicyReplace.html +3 -3
  112. package/docs/interfaces/datatypes.EdgeRouteUserAgentFilterReplace.html +3 -3
  113. package/docs/interfaces/datatypes.EdgeRouteWebhookVerificationReplace.html +3 -3
  114. package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +3 -3
  115. package/docs/interfaces/datatypes.EdgeTLSTerminationAtEdgeReplace.html +2 -2
  116. package/docs/interfaces/datatypes.EdgeTLSTerminationReplace.html +2 -2
  117. package/docs/interfaces/datatypes.EdgeTrafficPolicyReplace.html +2 -2
  118. package/docs/interfaces/datatypes.Endpoint.html +28 -28
  119. package/docs/interfaces/datatypes.EndpointBackend.html +2 -2
  120. package/docs/interfaces/datatypes.EndpointBackendMutate.html +2 -2
  121. package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
  122. package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
  123. package/docs/interfaces/datatypes.EndpointCreate.html +8 -8
  124. package/docs/interfaces/datatypes.EndpointIPPolicy.html +2 -2
  125. package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
  126. package/docs/interfaces/datatypes.EndpointList.html +3 -3
  127. package/docs/interfaces/datatypes.EndpointListArgs.html +43 -4
  128. package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
  129. package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +2 -2
  130. package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
  131. package/docs/interfaces/datatypes.EndpointOAuthAmazon.html +5 -5
  132. package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
  133. package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +7 -7
  134. package/docs/interfaces/datatypes.EndpointOAuthGitLab.html +5 -5
  135. package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
  136. package/docs/interfaces/datatypes.EndpointOAuthLinkedIn.html +5 -5
  137. package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
  138. package/docs/interfaces/datatypes.EndpointOAuthProvider.html +8 -8
  139. package/docs/interfaces/datatypes.EndpointOAuthTwitch.html +5 -5
  140. package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
  141. package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
  142. package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
  143. package/docs/interfaces/datatypes.EndpointSAML.html +15 -15
  144. package/docs/interfaces/datatypes.EndpointSAMLMutate.html +10 -10
  145. package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
  146. package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +2 -2
  147. package/docs/interfaces/datatypes.EndpointTrafficPolicy.html +2 -2
  148. package/docs/interfaces/datatypes.EndpointUpdate.html +8 -8
  149. package/docs/interfaces/datatypes.EndpointUserAgentFilter.html +3 -3
  150. package/docs/interfaces/datatypes.EndpointWebhookValidation.html +3 -3
  151. package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +1 -1
  152. package/docs/interfaces/datatypes.Error.html +4 -4
  153. package/docs/interfaces/datatypes.EventDestination.html +7 -7
  154. package/docs/interfaces/datatypes.EventDestinationCreate.html +4 -4
  155. package/docs/interfaces/datatypes.EventDestinationList.html +3 -3
  156. package/docs/interfaces/datatypes.EventDestinationUpdate.html +5 -5
  157. package/docs/interfaces/datatypes.EventSource.html +2 -2
  158. package/docs/interfaces/datatypes.EventSourceCreate.html +2 -2
  159. package/docs/interfaces/datatypes.EventSourceItem.html +2 -2
  160. package/docs/interfaces/datatypes.EventSourceList.html +2 -2
  161. package/docs/interfaces/datatypes.EventSourcePaging.html +1 -1
  162. package/docs/interfaces/datatypes.EventSourceReplace.html +1 -1
  163. package/docs/interfaces/datatypes.EventSourceUpdate.html +2 -2
  164. package/docs/interfaces/datatypes.EventSubscription.html +7 -7
  165. package/docs/interfaces/datatypes.EventSubscriptionCreate.html +4 -4
  166. package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
  167. package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +5 -5
  168. package/docs/interfaces/datatypes.EventTarget.html +5 -5
  169. package/docs/interfaces/datatypes.EventTargetAzureLogsIngestion.html +6 -6
  170. package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
  171. package/docs/interfaces/datatypes.EventTargetDatadog.html +4 -4
  172. package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
  173. package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
  174. package/docs/interfaces/datatypes.FailoverBackend.html +6 -6
  175. package/docs/interfaces/datatypes.FailoverBackendCreate.html +3 -3
  176. package/docs/interfaces/datatypes.FailoverBackendList.html +3 -3
  177. package/docs/interfaces/datatypes.FailoverBackendUpdate.html +4 -4
  178. package/docs/interfaces/datatypes.FilteredPaging.html +205 -0
  179. package/docs/interfaces/datatypes.HTTPResponseBackend.html +8 -8
  180. package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +5 -5
  181. package/docs/interfaces/datatypes.HTTPResponseBackendList.html +3 -3
  182. package/docs/interfaces/datatypes.HTTPResponseBackendUpdate.html +6 -6
  183. package/docs/interfaces/datatypes.HTTPSEdge.html +9 -9
  184. package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +5 -5
  185. package/docs/interfaces/datatypes.HTTPSEdgeList.html +3 -3
  186. package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +21 -21
  187. package/docs/interfaces/datatypes.HTTPSEdgeRouteCreate.html +18 -18
  188. package/docs/interfaces/datatypes.HTTPSEdgeRouteUpdate.html +19 -19
  189. package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +6 -6
  190. package/docs/interfaces/datatypes.IPPolicy.html +5 -5
  191. package/docs/interfaces/datatypes.IPPolicyCreate.html +2 -2
  192. package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
  193. package/docs/interfaces/datatypes.IPPolicyRule.html +8 -8
  194. package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +5 -5
  195. package/docs/interfaces/datatypes.IPPolicyRuleList.html +3 -3
  196. package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +4 -4
  197. package/docs/interfaces/datatypes.IPPolicyUpdate.html +3 -3
  198. package/docs/interfaces/datatypes.IPRestriction.html +8 -8
  199. package/docs/interfaces/datatypes.IPRestrictionCreate.html +5 -5
  200. package/docs/interfaces/datatypes.IPRestrictionList.html +3 -3
  201. package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
  202. package/docs/interfaces/datatypes.IdentityProvider.html +2 -2
  203. package/docs/interfaces/datatypes.Item.html +1 -1
  204. package/docs/interfaces/datatypes.ItemPaging.html +3 -3
  205. package/docs/interfaces/datatypes.Location.html +4 -4
  206. package/docs/interfaces/datatypes.Paging.html +2 -2
  207. package/docs/interfaces/datatypes.Ref.html +2 -2
  208. package/docs/interfaces/datatypes.ReservedAddr.html +7 -7
  209. package/docs/interfaces/datatypes.ReservedAddrCreate.html +3 -3
  210. package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
  211. package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -3
  212. package/docs/interfaces/datatypes.ReservedDomain.html +31 -12
  213. package/docs/interfaces/datatypes.ReservedDomainCertJob.html +4 -4
  214. package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
  215. package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +2 -2
  216. package/docs/interfaces/datatypes.ReservedDomainCreate.html +25 -6
  217. package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
  218. package/docs/interfaces/datatypes.ReservedDomainResolvesToEntry.html +167 -0
  219. package/docs/interfaces/datatypes.ReservedDomainUpdate.html +24 -5
  220. package/docs/interfaces/datatypes.SSHCertificateAuthority.html +7 -7
  221. package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +5 -5
  222. package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
  223. package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
  224. package/docs/interfaces/datatypes.SSHCredential.html +8 -8
  225. package/docs/interfaces/datatypes.SSHCredentialCreate.html +5 -5
  226. package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
  227. package/docs/interfaces/datatypes.SSHCredentialUpdate.html +4 -4
  228. package/docs/interfaces/datatypes.SSHHostCertificate.html +12 -12
  229. package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +7 -7
  230. package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
  231. package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
  232. package/docs/interfaces/datatypes.SSHUserCertificate.html +14 -14
  233. package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +9 -9
  234. package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
  235. package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
  236. package/docs/interfaces/datatypes.Secret.html +29 -10
  237. package/docs/interfaces/datatypes.SecretCreate.html +24 -5
  238. package/docs/interfaces/datatypes.SecretList.html +3 -3
  239. package/docs/interfaces/datatypes.SecretUpdate.html +5 -5
  240. package/docs/interfaces/datatypes.ServiceUser.html +243 -0
  241. package/docs/interfaces/datatypes.ServiceUserCreate.html +186 -0
  242. package/docs/interfaces/datatypes.ServiceUserList.html +205 -0
  243. package/docs/interfaces/datatypes.ServiceUserUpdate.html +200 -0
  244. package/docs/interfaces/datatypes.StaticBackend.html +7 -7
  245. package/docs/interfaces/datatypes.StaticBackendCreate.html +4 -4
  246. package/docs/interfaces/datatypes.StaticBackendList.html +3 -3
  247. package/docs/interfaces/datatypes.StaticBackendTLS.html +1 -1
  248. package/docs/interfaces/datatypes.StaticBackendUpdate.html +5 -5
  249. package/docs/interfaces/datatypes.TCPEdge.html +9 -9
  250. package/docs/interfaces/datatypes.TCPEdgeCreate.html +6 -6
  251. package/docs/interfaces/datatypes.TCPEdgeList.html +3 -3
  252. package/docs/interfaces/datatypes.TCPEdgeUpdate.html +7 -7
  253. package/docs/interfaces/datatypes.TLSCertificate.html +21 -21
  254. package/docs/interfaces/datatypes.TLSCertificateCreate.html +4 -4
  255. package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
  256. package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
  257. package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
  258. package/docs/interfaces/datatypes.TLSEdge.html +11 -11
  259. package/docs/interfaces/datatypes.TLSEdgeCreate.html +8 -8
  260. package/docs/interfaces/datatypes.TLSEdgeList.html +3 -3
  261. package/docs/interfaces/datatypes.TLSEdgeUpdate.html +9 -9
  262. package/docs/interfaces/datatypes.Tunnel.html +11 -11
  263. package/docs/interfaces/datatypes.TunnelGroupBackend.html +7 -7
  264. package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +3 -3
  265. package/docs/interfaces/datatypes.TunnelGroupBackendList.html +3 -3
  266. package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +4 -4
  267. package/docs/interfaces/datatypes.TunnelList.html +3 -3
  268. package/docs/interfaces/datatypes.TunnelSession.html +10 -10
  269. package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
  270. package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
  271. package/docs/interfaces/datatypes.UserAgent.html +6 -6
  272. package/docs/interfaces/datatypes.Vault.html +9 -9
  273. package/docs/interfaces/datatypes.VaultCreate.html +3 -3
  274. package/docs/interfaces/datatypes.VaultList.html +3 -3
  275. package/docs/interfaces/datatypes.VaultUpdate.html +4 -4
  276. package/docs/interfaces/datatypes.WeightedBackend.html +6 -6
  277. package/docs/interfaces/datatypes.WeightedBackendCreate.html +3 -3
  278. package/docs/interfaces/datatypes.WeightedBackendList.html +3 -3
  279. package/docs/interfaces/datatypes.WeightedBackendUpdate.html +4 -4
  280. package/docs/modules/datatypes.html +24 -0
  281. package/docs/modules/services.html +4 -0
  282. package/lib/client.d.ts +1 -0
  283. package/lib/client.d.ts.map +1 -1
  284. package/lib/client.js +2 -1
  285. package/lib/client.js.map +1 -1
  286. package/lib/datatypes.d.ts +66 -5
  287. package/lib/datatypes.d.ts.map +1 -1
  288. package/lib/services.d.ts +31 -4
  289. package/lib/services.d.ts.map +1 -1
  290. package/lib/services.js +137 -36
  291. package/lib/services.js.map +1 -1
  292. package/package.json +1 -1
  293. package/src/client.ts +3 -1
  294. package/src/datatypes.ts +72 -5
  295. package/src/services.ts +151 -38
@@ -123,7 +123,7 @@
123
123
  <div class="tsd-signature tsd-kind-icon">bindings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
124
124
  <aside class="tsd-sources">
125
125
  <ul>
126
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1488">datatypes.ts:1488</a></li>
126
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1497">datatypes.ts:1497</a></li>
127
127
  </ul>
128
128
  </aside>
129
129
  <div class="tsd-comment tsd-typography">
@@ -138,7 +138,7 @@
138
138
  <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
139
139
  <aside class="tsd-sources">
140
140
  <ul>
141
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1451">datatypes.ts:1451</a></li>
141
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1460">datatypes.ts:1460</a></li>
142
142
  </ul>
143
143
  </aside>
144
144
  <div class="tsd-comment tsd-typography">
@@ -153,7 +153,7 @@
153
153
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
154
154
  <aside class="tsd-sources">
155
155
  <ul>
156
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1468">datatypes.ts:1468</a></li>
156
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1477">datatypes.ts:1477</a></li>
157
157
  </ul>
158
158
  </aside>
159
159
  <div class="tsd-comment tsd-typography">
@@ -168,7 +168,7 @@
168
168
  <div class="tsd-signature tsd-kind-icon">domain<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
169
169
  <aside class="tsd-sources">
170
170
  <ul>
171
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1470">datatypes.ts:1470</a></li>
171
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1479">datatypes.ts:1479</a></li>
172
172
  </ul>
173
173
  </aside>
174
174
  <div class="tsd-comment tsd-typography">
@@ -183,7 +183,7 @@
183
183
  <div class="tsd-signature tsd-kind-icon">edge<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
184
184
  <aside class="tsd-sources">
185
185
  <ul>
186
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1476">datatypes.ts:1476</a></li>
186
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1485">datatypes.ts:1485</a></li>
187
187
  </ul>
188
188
  </aside>
189
189
  <div class="tsd-comment tsd-typography">
@@ -198,7 +198,7 @@
198
198
  <div class="tsd-signature tsd-kind-icon">host<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
199
199
  <aside class="tsd-sources">
200
200
  <ul>
201
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1461">datatypes.ts:1461</a></li>
201
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1470">datatypes.ts:1470</a></li>
202
202
  </ul>
203
203
  </aside>
204
204
  </section>
@@ -208,7 +208,7 @@
208
208
  <div class="tsd-signature tsd-kind-icon">hostport<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
209
209
  <aside class="tsd-sources">
210
210
  <ul>
211
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1460">datatypes.ts:1460</a></li>
211
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1469">datatypes.ts:1469</a></li>
212
212
  </ul>
213
213
  </aside>
214
214
  <div class="tsd-comment tsd-typography">
@@ -223,7 +223,7 @@
223
223
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
224
224
  <aside class="tsd-sources">
225
225
  <ul>
226
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1447">datatypes.ts:1447</a></li>
226
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1456">datatypes.ts:1456</a></li>
227
227
  </ul>
228
228
  </aside>
229
229
  <div class="tsd-comment tsd-typography">
@@ -238,7 +238,7 @@
238
238
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
239
239
  <aside class="tsd-sources">
240
240
  <ul>
241
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1466">datatypes.ts:1466</a></li>
241
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1475">datatypes.ts:1475</a></li>
242
242
  </ul>
243
243
  </aside>
244
244
  <div class="tsd-comment tsd-typography">
@@ -253,7 +253,7 @@
253
253
  <div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
254
254
  <aside class="tsd-sources">
255
255
  <ul>
256
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1494">datatypes.ts:1494</a></li>
256
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1503">datatypes.ts:1503</a></li>
257
257
  </ul>
258
258
  </aside>
259
259
  <div class="tsd-comment tsd-typography">
@@ -268,7 +268,7 @@
268
268
  <div class="tsd-signature tsd-kind-icon">pooling<wbr>Enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
269
269
  <aside class="tsd-sources">
270
270
  <ul>
271
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1496">datatypes.ts:1496</a></li>
271
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1505">datatypes.ts:1505</a></li>
272
272
  </ul>
273
273
  </aside>
274
274
  <div class="tsd-comment tsd-typography">
@@ -283,7 +283,7 @@
283
283
  <div class="tsd-signature tsd-kind-icon">port<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
284
284
  <aside class="tsd-sources">
285
285
  <ul>
286
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1462">datatypes.ts:1462</a></li>
286
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1471">datatypes.ts:1471</a></li>
287
287
  </ul>
288
288
  </aside>
289
289
  </section>
@@ -293,7 +293,7 @@
293
293
  <div class="tsd-signature tsd-kind-icon">principal<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
294
294
  <aside class="tsd-sources">
295
295
  <ul>
296
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1484">datatypes.ts:1484</a></li>
296
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1493">datatypes.ts:1493</a></li>
297
297
  </ul>
298
298
  </aside>
299
299
  <div class="tsd-comment tsd-typography">
@@ -308,7 +308,7 @@
308
308
  <div class="tsd-signature tsd-kind-icon">proto<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
309
309
  <aside class="tsd-sources">
310
310
  <ul>
311
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1457">datatypes.ts:1457</a></li>
311
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1466">datatypes.ts:1466</a></li>
312
312
  </ul>
313
313
  </aside>
314
314
  <div class="tsd-comment tsd-typography">
@@ -323,12 +323,12 @@
323
323
  <div class="tsd-signature tsd-kind-icon">public<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
324
324
  <aside class="tsd-sources">
325
325
  <ul>
326
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1455">datatypes.ts:1455</a></li>
326
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1464">datatypes.ts:1464</a></li>
327
327
  </ul>
328
328
  </aside>
329
329
  <div class="tsd-comment tsd-typography">
330
330
  <div class="lead">
331
- <p>URL of the hostport served by this endpoint</p>
331
+ <p>deprecated [replaced by URL]: URL of the hostport served by this endpoint</p>
332
332
  </div>
333
333
  </div>
334
334
  </section>
@@ -338,7 +338,7 @@
338
338
  <div class="tsd-signature tsd-kind-icon">region<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
339
339
  <aside class="tsd-sources">
340
340
  <ul>
341
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1449">datatypes.ts:1449</a></li>
341
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1458">datatypes.ts:1458</a></li>
342
342
  </ul>
343
343
  </aside>
344
344
  <div class="tsd-comment tsd-typography">
@@ -353,7 +353,7 @@
353
353
  <div class="tsd-signature tsd-kind-icon">scheme<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
354
354
  <aside class="tsd-sources">
355
355
  <ul>
356
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1458">datatypes.ts:1458</a></li>
356
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1467">datatypes.ts:1467</a></li>
357
357
  </ul>
358
358
  </aside>
359
359
  </section>
@@ -363,7 +363,7 @@
363
363
  <div class="tsd-signature tsd-kind-icon">tcp<wbr>Addr<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
364
364
  <aside class="tsd-sources">
365
365
  <ul>
366
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1472">datatypes.ts:1472</a></li>
366
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1481">datatypes.ts:1481</a></li>
367
367
  </ul>
368
368
  </aside>
369
369
  <div class="tsd-comment tsd-typography">
@@ -378,7 +378,7 @@
378
378
  <div class="tsd-signature tsd-kind-icon">traffic<wbr>Policy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
379
379
  <aside class="tsd-sources">
380
380
  <ul>
381
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1486">datatypes.ts:1486</a></li>
381
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1495">datatypes.ts:1495</a></li>
382
382
  </ul>
383
383
  </aside>
384
384
  <div class="tsd-comment tsd-typography">
@@ -393,7 +393,7 @@
393
393
  <div class="tsd-signature tsd-kind-icon">tunnel<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
394
394
  <aside class="tsd-sources">
395
395
  <ul>
396
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1474">datatypes.ts:1474</a></li>
396
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1483">datatypes.ts:1483</a></li>
397
397
  </ul>
398
398
  </aside>
399
399
  <div class="tsd-comment tsd-typography">
@@ -408,7 +408,7 @@
408
408
  <div class="tsd-signature tsd-kind-icon">tunnel<wbr>Session<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
409
409
  <aside class="tsd-sources">
410
410
  <ul>
411
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1490">datatypes.ts:1490</a></li>
411
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1499">datatypes.ts:1499</a></li>
412
412
  </ul>
413
413
  </aside>
414
414
  <div class="tsd-comment tsd-typography">
@@ -423,7 +423,7 @@
423
423
  <div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
424
424
  <aside class="tsd-sources">
425
425
  <ul>
426
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1464">datatypes.ts:1464</a></li>
426
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1473">datatypes.ts:1473</a></li>
427
427
  </ul>
428
428
  </aside>
429
429
  <div class="tsd-comment tsd-typography">
@@ -438,7 +438,7 @@
438
438
  <div class="tsd-signature tsd-kind-icon">updated<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
439
439
  <aside class="tsd-sources">
440
440
  <ul>
441
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1453">datatypes.ts:1453</a></li>
441
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1462">datatypes.ts:1462</a></li>
442
442
  </ul>
443
443
  </aside>
444
444
  <div class="tsd-comment tsd-typography">
@@ -453,7 +453,7 @@
453
453
  <div class="tsd-signature tsd-kind-icon">upstream<wbr>Protocol<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
454
454
  <aside class="tsd-sources">
455
455
  <ul>
456
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1480">datatypes.ts:1480</a></li>
456
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1489">datatypes.ts:1489</a></li>
457
457
  </ul>
458
458
  </aside>
459
459
  <div class="tsd-comment tsd-typography">
@@ -468,7 +468,7 @@
468
468
  <div class="tsd-signature tsd-kind-icon">upstream<wbr>Url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
469
469
  <aside class="tsd-sources">
470
470
  <ul>
471
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1478">datatypes.ts:1478</a></li>
471
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1487">datatypes.ts:1487</a></li>
472
472
  </ul>
473
473
  </aside>
474
474
  <div class="tsd-comment tsd-typography">
@@ -483,7 +483,7 @@
483
483
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
484
484
  <aside class="tsd-sources">
485
485
  <ul>
486
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1492">datatypes.ts:1492</a></li>
486
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1501">datatypes.ts:1501</a></li>
487
487
  </ul>
488
488
  </aside>
489
489
  <div class="tsd-comment tsd-typography">
@@ -498,7 +498,7 @@
498
498
  <div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
499
499
  <aside class="tsd-sources">
500
500
  <ul>
501
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1482">datatypes.ts:1482</a></li>
501
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1491">datatypes.ts:1491</a></li>
502
502
  </ul>
503
503
  </aside>
504
504
  <div class="tsd-comment tsd-typography">
@@ -98,7 +98,7 @@
98
98
  <div class="tsd-signature tsd-kind-icon">backend<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
99
99
  <aside class="tsd-sources">
100
100
  <ul>
101
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1001">datatypes.ts:1001</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1010">datatypes.ts:1010</a></li>
102
102
  </ul>
103
103
  </aside>
104
104
  <div class="tsd-comment tsd-typography">
@@ -113,7 +113,7 @@
113
113
  <div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
114
114
  <aside class="tsd-sources">
115
115
  <ul>
116
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L999">datatypes.ts:999</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1008">datatypes.ts:1008</a></li>
117
117
  </ul>
118
118
  </aside>
119
119
  <div class="tsd-comment tsd-typography">
@@ -98,7 +98,7 @@
98
98
  <div class="tsd-signature tsd-kind-icon">backend<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
99
99
  <aside class="tsd-sources">
100
100
  <ul>
101
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1008">datatypes.ts:1008</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1017">datatypes.ts:1017</a></li>
102
102
  </ul>
103
103
  </aside>
104
104
  <div class="tsd-comment tsd-typography">
@@ -113,7 +113,7 @@
113
113
  <div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
114
114
  <aside class="tsd-sources">
115
115
  <ul>
116
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1006">datatypes.ts:1006</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1015">datatypes.ts:1015</a></li>
117
117
  </ul>
118
118
  </aside>
119
119
  <div class="tsd-comment tsd-typography">
@@ -102,7 +102,7 @@
102
102
  <div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
103
103
  <aside class="tsd-sources">
104
104
  <ul>
105
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L783">datatypes.ts:783</a></li>
105
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L792">datatypes.ts:792</a></li>
106
106
  </ul>
107
107
  </aside>
108
108
  <div class="tsd-comment tsd-typography">
@@ -117,7 +117,7 @@
117
117
  <div class="tsd-signature tsd-kind-icon">error<wbr>Threshold<wbr>Percentage<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
118
118
  <aside class="tsd-sources">
119
119
  <ul>
120
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L793">datatypes.ts:793</a></li>
120
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L802">datatypes.ts:802</a></li>
121
121
  </ul>
122
122
  </aside>
123
123
  <div class="tsd-comment tsd-typography">
@@ -132,7 +132,7 @@
132
132
  <div class="tsd-signature tsd-kind-icon">num<wbr>Buckets<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
133
133
  <aside class="tsd-sources">
134
134
  <ul>
135
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L789">datatypes.ts:789</a></li>
135
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L798">datatypes.ts:798</a></li>
136
136
  </ul>
137
137
  </aside>
138
138
  <div class="tsd-comment tsd-typography">
@@ -147,7 +147,7 @@
147
147
  <div class="tsd-signature tsd-kind-icon">rolling<wbr>Window<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
148
148
  <aside class="tsd-sources">
149
149
  <ul>
150
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L787">datatypes.ts:787</a></li>
150
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L796">datatypes.ts:796</a></li>
151
151
  </ul>
152
152
  </aside>
153
153
  <div class="tsd-comment tsd-typography">
@@ -162,7 +162,7 @@
162
162
  <div class="tsd-signature tsd-kind-icon">tripped<wbr>Duration<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
163
163
  <aside class="tsd-sources">
164
164
  <ul>
165
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L785">datatypes.ts:785</a></li>
165
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L794">datatypes.ts:794</a></li>
166
166
  </ul>
167
167
  </aside>
168
168
  <div class="tsd-comment tsd-typography">
@@ -177,7 +177,7 @@
177
177
  <div class="tsd-signature tsd-kind-icon">volume<wbr>Threshold<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
178
178
  <aside class="tsd-sources">
179
179
  <ul>
180
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L791">datatypes.ts:791</a></li>
180
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L800">datatypes.ts:800</a></li>
181
181
  </ul>
182
182
  </aside>
183
183
  <div class="tsd-comment tsd-typography">
@@ -97,7 +97,7 @@
97
97
  <div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
98
98
  <aside class="tsd-sources">
99
99
  <ul>
100
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L716">datatypes.ts:716</a></li>
100
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L725">datatypes.ts:725</a></li>
101
101
  </ul>
102
102
  </aside>
103
103
  <div class="tsd-comment tsd-typography">
@@ -103,7 +103,7 @@
103
103
  <div class="tsd-signature tsd-kind-icon">bindings<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
104
104
  <aside class="tsd-sources">
105
105
  <ul>
106
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1520">datatypes.ts:1520</a></li>
106
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1529">datatypes.ts:1529</a></li>
107
107
  </ul>
108
108
  </aside>
109
109
  <div class="tsd-comment tsd-typography">
@@ -118,7 +118,7 @@
118
118
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
119
119
  <aside class="tsd-sources">
120
120
  <ul>
121
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1516">datatypes.ts:1516</a></li>
121
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1525">datatypes.ts:1525</a></li>
122
122
  </ul>
123
123
  </aside>
124
124
  <div class="tsd-comment tsd-typography">
@@ -133,7 +133,7 @@
133
133
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
134
134
  <aside class="tsd-sources">
135
135
  <ul>
136
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1518">datatypes.ts:1518</a></li>
136
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1527">datatypes.ts:1527</a></li>
137
137
  </ul>
138
138
  </aside>
139
139
  <div class="tsd-comment tsd-typography">
@@ -144,11 +144,11 @@
144
144
  </section>
145
145
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
146
146
  <a name="poolingEnabled" class="tsd-anchor"></a>
147
- <h3>pooling<wbr>Enabled</h3>
147
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> pooling<wbr>Enabled</h3>
148
148
  <div class="tsd-signature tsd-kind-icon">pooling<wbr>Enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
149
149
  <aside class="tsd-sources">
150
150
  <ul>
151
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1521">datatypes.ts:1521</a></li>
151
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1530">datatypes.ts:1530</a></li>
152
152
  </ul>
153
153
  </aside>
154
154
  </section>
@@ -158,7 +158,7 @@
158
158
  <div class="tsd-signature tsd-kind-icon">traffic<wbr>Policy<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
159
159
  <aside class="tsd-sources">
160
160
  <ul>
161
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1514">datatypes.ts:1514</a></li>
161
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1523">datatypes.ts:1523</a></li>
162
162
  </ul>
163
163
  </aside>
164
164
  <div class="tsd-comment tsd-typography">
@@ -173,7 +173,7 @@
173
173
  <div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
174
174
  <aside class="tsd-sources">
175
175
  <ul>
176
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1512">datatypes.ts:1512</a></li>
176
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1521">datatypes.ts:1521</a></li>
177
177
  </ul>
178
178
  </aside>
179
179
  <div class="tsd-comment tsd-typography">
@@ -188,7 +188,7 @@
188
188
  <div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
189
189
  <aside class="tsd-sources">
190
190
  <ul>
191
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1510">datatypes.ts:1510</a></li>
191
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1519">datatypes.ts:1519</a></li>
192
192
  </ul>
193
193
  </aside>
194
194
  <div class="tsd-comment tsd-typography">
@@ -98,7 +98,7 @@
98
98
  <div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
99
99
  <aside class="tsd-sources">
100
100
  <ul>
101
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L769">datatypes.ts:769</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L778">datatypes.ts:778</a></li>
102
102
  </ul>
103
103
  </aside>
104
104
  <div class="tsd-comment tsd-typography">
@@ -113,7 +113,7 @@
113
113
  <div class="tsd-signature tsd-kind-icon">ip<wbr>Policies<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a><span class="tsd-signature-symbol">[]</span></div>
114
114
  <aside class="tsd-sources">
115
115
  <ul>
116
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L771">datatypes.ts:771</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L780">datatypes.ts:780</a></li>
117
117
  </ul>
118
118
  </aside>
119
119
  <div class="tsd-comment tsd-typography">
@@ -98,7 +98,7 @@
98
98
  <div class="tsd-signature tsd-kind-icon">enabled<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">boolean</span></div>
99
99
  <aside class="tsd-sources">
100
100
  <ul>
101
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L776">datatypes.ts:776</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L785">datatypes.ts:785</a></li>
102
102
  </ul>
103
103
  </aside>
104
104
  <div class="tsd-comment tsd-typography">
@@ -113,7 +113,7 @@
113
113
  <div class="tsd-signature tsd-kind-icon">ip<wbr>Policy<wbr>Ids<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
114
114
  <aside class="tsd-sources">
115
115
  <ul>
116
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L778">datatypes.ts:778</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L787">datatypes.ts:787</a></li>
117
117
  </ul>
118
118
  </aside>
119
119
  <div class="tsd-comment tsd-typography">
@@ -99,7 +99,7 @@
99
99
  <div class="tsd-signature tsd-kind-icon">endpoints<span class="tsd-signature-symbol">:</span> <a href="datatypes.Endpoint.html" class="tsd-signature-type" data-tsd-kind="Interface">Endpoint</a><span class="tsd-signature-symbol">[]</span></div>
100
100
  <aside class="tsd-sources">
101
101
  <ul>
102
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1501">datatypes.ts:1501</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1510">datatypes.ts:1510</a></li>
103
103
  </ul>
104
104
  </aside>
105
105
  <div class="tsd-comment tsd-typography">
@@ -114,7 +114,7 @@
114
114
  <div class="tsd-signature tsd-kind-icon">next<wbr>Page<wbr>Uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
115
115
  <aside class="tsd-sources">
116
116
  <ul>
117
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1505">datatypes.ts:1505</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1514">datatypes.ts:1514</a></li>
118
118
  </ul>
119
119
  </aside>
120
120
  <div class="tsd-comment tsd-typography">
@@ -129,7 +129,7 @@
129
129
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
130
130
  <aside class="tsd-sources">
131
131
  <ul>
132
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1503">datatypes.ts:1503</a></li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1512">datatypes.ts:1512</a></li>
133
133
  </ul>
134
134
  </aside>
135
135
  <div class="tsd-comment tsd-typography">
@@ -84,6 +84,7 @@
84
84
  <h3>Properties</h3>
85
85
  <ul class="tsd-index-list">
86
86
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointListArgs.html#beforeId" class="tsd-kind-icon">before<wbr>Id</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointListArgs.html#filter" class="tsd-kind-icon">filter</a></li>
87
88
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointListArgs.html#id" class="tsd-kind-icon">id</a></li>
88
89
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointListArgs.html#limit" class="tsd-kind-icon">limit</a></li>
89
90
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.EndpointListArgs.html#url" class="tsd-kind-icon">url</a></li>
@@ -100,9 +101,29 @@
100
101
  <div class="tsd-signature tsd-kind-icon">before<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
101
102
  <aside class="tsd-sources">
102
103
  <ul>
103
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1525">datatypes.ts:1525</a></li>
104
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1535">datatypes.ts:1535</a></li>
104
105
  </ul>
105
106
  </aside>
107
+ <div class="tsd-comment tsd-typography">
108
+ <div class="lead">
109
+ <p>Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.</p>
110
+ </div>
111
+ </div>
112
+ </section>
113
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
114
+ <a name="filter" class="tsd-anchor"></a>
115
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> filter</h3>
116
+ <div class="tsd-signature tsd-kind-icon">filter<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
117
+ <aside class="tsd-sources">
118
+ <ul>
119
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1543">datatypes.ts:1543</a></li>
120
+ </ul>
121
+ </aside>
122
+ <div class="tsd-comment tsd-typography">
123
+ <div class="lead">
124
+ <p>A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as <code>id</code>, <code>metadata</code>, <code>created_at</code>, and more. See ngrok API Filtering for syntax and field details: <a href="https://ngrok.com/docs/api/api-filtering">https://ngrok.com/docs/api/api-filtering</a>.</p>
125
+ </div>
126
+ </div>
106
127
  </section>
107
128
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
108
129
  <a name="id" class="tsd-anchor"></a>
@@ -110,9 +131,14 @@
110
131
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
111
132
  <aside class="tsd-sources">
112
133
  <ul>
113
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1527">datatypes.ts:1527</a></li>
134
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1539">datatypes.ts:1539</a></li>
114
135
  </ul>
115
136
  </aside>
137
+ <div class="tsd-comment tsd-typography">
138
+ <div class="lead">
139
+ <p>Filter results by endpoint IDs. Deprecated: use <code>filter</code> instead.</p>
140
+ </div>
141
+ </div>
116
142
  </section>
117
143
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
118
144
  <a name="limit" class="tsd-anchor"></a>
@@ -120,9 +146,14 @@
120
146
  <div class="tsd-signature tsd-kind-icon">limit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
121
147
  <aside class="tsd-sources">
122
148
  <ul>
123
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1526">datatypes.ts:1526</a></li>
149
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1537">datatypes.ts:1537</a></li>
124
150
  </ul>
125
151
  </aside>
152
+ <div class="tsd-comment tsd-typography">
153
+ <div class="lead">
154
+ <p>Constrains the number of results in the dataset. See the <a href="https://ngrok.com/docs/api/index#pagination">API Overview</a> for details.</p>
155
+ </div>
156
+ </div>
126
157
  </section>
127
158
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
128
159
  <a name="url" class="tsd-anchor"></a>
@@ -130,9 +161,14 @@
130
161
  <div class="tsd-signature tsd-kind-icon">url<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
131
162
  <aside class="tsd-sources">
132
163
  <ul>
133
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L1528">datatypes.ts:1528</a></li>
164
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/fbbc742/src/datatypes.ts#L1541">datatypes.ts:1541</a></li>
134
165
  </ul>
135
166
  </aside>
167
+ <div class="tsd-comment tsd-typography">
168
+ <div class="lead">
169
+ <p>Filter results by endpoint URLs. Deprecated: use <code>filter</code> instead.</p>
170
+ </div>
171
+ </div>
136
172
  </section>
137
173
  </section>
138
174
  </div>
@@ -163,6 +199,9 @@
163
199
  <li class=" tsd-kind-property tsd-parent-kind-interface">
164
200
  <a href="datatypes.EndpointListArgs.html#beforeId" class="tsd-kind-icon">before<wbr>Id</a>
165
201
  </li>
202
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
203
+ <a href="datatypes.EndpointListArgs.html#filter" class="tsd-kind-icon">filter</a>
204
+ </li>
166
205
  <li class=" tsd-kind-property tsd-parent-kind-interface">
167
206
  <a href="datatypes.EndpointListArgs.html#id" class="tsd-kind-icon">id</a>
168
207
  </li>