@ngrok/ngrok-api 0.10.0 → 0.12.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 (282) hide show
  1. package/CHANGELOG.md +9 -0
  2. package/docs/assets/js/search.js +1 -1
  3. package/docs/classes/client.Ngrok.html +55 -29
  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 +352 -0
  10. package/docs/classes/services.CertificateAuthorities.html +6 -6
  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.EdgeRoutePolicyModule.html +270 -0
  19. package/docs/classes/services.EdgeRouteRequestHeadersModule.html +4 -4
  20. package/docs/classes/services.EdgeRouteResponseHeadersModule.html +4 -4
  21. package/docs/classes/services.EdgeRouteSAMLModule.html +4 -4
  22. package/docs/classes/services.EdgeRouteTrafficPolicyModule.html +270 -0
  23. package/docs/classes/services.EdgeRouteUserAgentFilterModule.html +270 -0
  24. package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +4 -4
  25. package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +4 -4
  26. package/docs/classes/services.EdgesHTTPS.html +6 -6
  27. package/docs/classes/services.EdgesHTTPSRoutes.html +5 -5
  28. package/docs/classes/services.EdgesTCP.html +6 -6
  29. package/docs/classes/services.EdgesTLS.html +6 -6
  30. package/docs/classes/services.Endpoints.html +3 -3
  31. package/docs/classes/services.EventDestinations.html +6 -6
  32. package/docs/classes/services.EventSources.html +6 -6
  33. package/docs/classes/services.EventSubscriptions.html +6 -6
  34. package/docs/classes/services.FailoverBackends.html +6 -6
  35. package/docs/classes/services.HTTPResponseBackends.html +6 -6
  36. package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +4 -4
  37. package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +4 -4
  38. package/docs/classes/services.IPPolicies.html +6 -6
  39. package/docs/classes/services.IPPolicyRules.html +6 -6
  40. package/docs/classes/services.IPRestrictions.html +6 -6
  41. package/docs/classes/services.ReservedAddrs.html +6 -6
  42. package/docs/classes/services.ReservedDomains.html +8 -8
  43. package/docs/classes/services.SSHCertificateAuthorities.html +6 -6
  44. package/docs/classes/services.SSHCredentials.html +6 -6
  45. package/docs/classes/services.SSHHostCertificates.html +6 -6
  46. package/docs/classes/services.SSHUserCertificates.html +6 -6
  47. package/docs/classes/services.StaticBackends.html +360 -0
  48. package/docs/classes/services.TCPEdgeBackendModule.html +4 -4
  49. package/docs/classes/services.TCPEdgeIPRestrictionModule.html +4 -4
  50. package/docs/classes/services.TCPEdgePolicyModule.html +270 -0
  51. package/docs/classes/services.TCPEdgeTrafficPolicyModule.html +270 -0
  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.TLSEdgePolicyModule.html +270 -0
  57. package/docs/classes/services.TLSEdgeTLSTerminationModule.html +4 -4
  58. package/docs/classes/services.TLSEdgeTrafficPolicyModule.html +270 -0
  59. package/docs/classes/services.TunnelGroupBackends.html +6 -6
  60. package/docs/classes/services.TunnelSessions.html +6 -6
  61. package/docs/classes/services.Tunnels.html +3 -3
  62. package/docs/classes/services.WeightedBackends.html +6 -6
  63. package/docs/interfaces/client.NgrokConfig.html +3 -3
  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 +243 -0
  86. package/docs/interfaces/datatypes.BotUserCreate.html +186 -0
  87. package/docs/interfaces/datatypes.BotUserList.html +205 -0
  88. package/docs/interfaces/datatypes.BotUserUpdate.html +200 -0
  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 +8 -8
  95. package/docs/interfaces/datatypes.CredentialCreate.html +4 -4
  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.EdgePolicyReplace.html +176 -0
  102. package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +3 -3
  103. package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +3 -3
  104. package/docs/interfaces/datatypes.EdgeRouteCompressionReplace.html +3 -3
  105. package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +3 -3
  106. package/docs/interfaces/datatypes.EdgeRouteItem.html +2 -2
  107. package/docs/interfaces/datatypes.EdgeRouteOAuthReplace.html +3 -3
  108. package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +3 -3
  109. package/docs/interfaces/datatypes.EdgeRoutePolicyReplace.html +190 -0
  110. package/docs/interfaces/datatypes.EdgeRouteRequestHeadersReplace.html +3 -3
  111. package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +3 -3
  112. package/docs/interfaces/datatypes.EdgeRouteSAMLReplace.html +3 -3
  113. package/docs/interfaces/datatypes.EdgeRouteTrafficPolicyReplace.html +190 -0
  114. package/docs/interfaces/datatypes.EdgeRouteUserAgentFilterReplace.html +190 -0
  115. package/docs/interfaces/datatypes.EdgeRouteWebhookVerificationReplace.html +3 -3
  116. package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +3 -3
  117. package/docs/interfaces/datatypes.EdgeTLSTerminationAtEdgeReplace.html +2 -2
  118. package/docs/interfaces/datatypes.EdgeTLSTerminationReplace.html +2 -2
  119. package/docs/interfaces/datatypes.EdgeTrafficPolicyReplace.html +176 -0
  120. package/docs/interfaces/datatypes.Endpoint.html +13 -13
  121. package/docs/interfaces/datatypes.EndpointAction.html +186 -0
  122. package/docs/interfaces/datatypes.EndpointBackend.html +2 -2
  123. package/docs/interfaces/datatypes.EndpointBackendMutate.html +2 -2
  124. package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
  125. package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
  126. package/docs/interfaces/datatypes.EndpointIPPolicy.html +2 -2
  127. package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
  128. package/docs/interfaces/datatypes.EndpointList.html +3 -3
  129. package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
  130. package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +2 -2
  131. package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
  132. package/docs/interfaces/datatypes.EndpointOAuthAmazon.html +5 -5
  133. package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
  134. package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +7 -7
  135. package/docs/interfaces/datatypes.EndpointOAuthGitLab.html +5 -5
  136. package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
  137. package/docs/interfaces/datatypes.EndpointOAuthLinkedIn.html +5 -5
  138. package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
  139. package/docs/interfaces/datatypes.EndpointOAuthProvider.html +8 -8
  140. package/docs/interfaces/datatypes.EndpointOAuthTwitch.html +5 -5
  141. package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
  142. package/docs/interfaces/datatypes.EndpointPolicy.html +205 -0
  143. package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
  144. package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
  145. package/docs/interfaces/datatypes.EndpointRule.html +205 -0
  146. package/docs/interfaces/datatypes.EndpointSAML.html +15 -15
  147. package/docs/interfaces/datatypes.EndpointSAMLMutate.html +10 -10
  148. package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
  149. package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +2 -2
  150. package/docs/interfaces/datatypes.EndpointTrafficPolicy.html +186 -0
  151. package/docs/interfaces/datatypes.EndpointUserAgentFilter.html +190 -0
  152. package/docs/interfaces/datatypes.EndpointWebhookValidation.html +4 -4
  153. package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +1 -1
  154. package/docs/interfaces/datatypes.Error.html +4 -4
  155. package/docs/interfaces/datatypes.EventDestination.html +7 -7
  156. package/docs/interfaces/datatypes.EventDestinationCreate.html +4 -4
  157. package/docs/interfaces/datatypes.EventDestinationList.html +3 -3
  158. package/docs/interfaces/datatypes.EventDestinationUpdate.html +5 -5
  159. package/docs/interfaces/datatypes.EventSource.html +2 -2
  160. package/docs/interfaces/datatypes.EventSourceCreate.html +2 -2
  161. package/docs/interfaces/datatypes.EventSourceItem.html +2 -2
  162. package/docs/interfaces/datatypes.EventSourceList.html +2 -2
  163. package/docs/interfaces/datatypes.EventSourcePaging.html +1 -1
  164. package/docs/interfaces/datatypes.EventSourceReplace.html +1 -1
  165. package/docs/interfaces/datatypes.EventSourceUpdate.html +2 -2
  166. package/docs/interfaces/datatypes.EventSubscription.html +7 -7
  167. package/docs/interfaces/datatypes.EventSubscriptionCreate.html +4 -4
  168. package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
  169. package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +5 -5
  170. package/docs/interfaces/datatypes.EventTarget.html +18 -4
  171. package/docs/interfaces/datatypes.EventTargetAzureLogsIngestion.html +262 -0
  172. package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
  173. package/docs/interfaces/datatypes.EventTargetDatadog.html +4 -4
  174. package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
  175. package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
  176. package/docs/interfaces/datatypes.FailoverBackend.html +6 -6
  177. package/docs/interfaces/datatypes.FailoverBackendCreate.html +3 -3
  178. package/docs/interfaces/datatypes.FailoverBackendList.html +3 -3
  179. package/docs/interfaces/datatypes.FailoverBackendUpdate.html +4 -4
  180. package/docs/interfaces/datatypes.HTTPResponseBackend.html +8 -8
  181. package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +5 -5
  182. package/docs/interfaces/datatypes.HTTPResponseBackendList.html +3 -3
  183. package/docs/interfaces/datatypes.HTTPResponseBackendUpdate.html +6 -6
  184. package/docs/interfaces/datatypes.HTTPSEdge.html +9 -9
  185. package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +5 -5
  186. package/docs/interfaces/datatypes.HTTPSEdgeList.html +3 -3
  187. package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +52 -19
  188. package/docs/interfaces/datatypes.HTTPSEdgeRouteCreate.html +49 -16
  189. package/docs/interfaces/datatypes.HTTPSEdgeRouteUpdate.html +50 -17
  190. package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +6 -6
  191. package/docs/interfaces/datatypes.IPPolicy.html +5 -5
  192. package/docs/interfaces/datatypes.IPPolicyCreate.html +2 -2
  193. package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
  194. package/docs/interfaces/datatypes.IPPolicyRule.html +8 -8
  195. package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +5 -5
  196. package/docs/interfaces/datatypes.IPPolicyRuleList.html +3 -3
  197. package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +4 -4
  198. package/docs/interfaces/datatypes.IPPolicyUpdate.html +3 -3
  199. package/docs/interfaces/datatypes.IPRestriction.html +8 -8
  200. package/docs/interfaces/datatypes.IPRestrictionCreate.html +5 -5
  201. package/docs/interfaces/datatypes.IPRestrictionList.html +3 -3
  202. package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
  203. package/docs/interfaces/datatypes.IdentityProvider.html +2 -2
  204. package/docs/interfaces/datatypes.Item.html +1 -1
  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 +14 -14
  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 +7 -7
  217. package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
  218. package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -5
  219. package/docs/interfaces/datatypes.SSHCertificateAuthority.html +7 -7
  220. package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +5 -5
  221. package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
  222. package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
  223. package/docs/interfaces/datatypes.SSHCredential.html +8 -8
  224. package/docs/interfaces/datatypes.SSHCredentialCreate.html +5 -5
  225. package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
  226. package/docs/interfaces/datatypes.SSHCredentialUpdate.html +4 -4
  227. package/docs/interfaces/datatypes.SSHHostCertificate.html +12 -12
  228. package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +7 -7
  229. package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
  230. package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
  231. package/docs/interfaces/datatypes.SSHUserCertificate.html +14 -14
  232. package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +9 -9
  233. package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
  234. package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
  235. package/docs/interfaces/datatypes.StaticBackend.html +281 -0
  236. package/docs/interfaces/datatypes.StaticBackendCreate.html +224 -0
  237. package/docs/interfaces/datatypes.StaticBackendList.html +205 -0
  238. package/docs/interfaces/datatypes.StaticBackendTLS.html +167 -0
  239. package/docs/interfaces/datatypes.StaticBackendUpdate.html +238 -0
  240. package/docs/interfaces/datatypes.TCPEdge.html +27 -8
  241. package/docs/interfaces/datatypes.TCPEdgeCreate.html +24 -5
  242. package/docs/interfaces/datatypes.TCPEdgeList.html +3 -3
  243. package/docs/interfaces/datatypes.TCPEdgeUpdate.html +25 -6
  244. package/docs/interfaces/datatypes.TLSCertificate.html +21 -21
  245. package/docs/interfaces/datatypes.TLSCertificateCreate.html +4 -4
  246. package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
  247. package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
  248. package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
  249. package/docs/interfaces/datatypes.TLSEdge.html +29 -10
  250. package/docs/interfaces/datatypes.TLSEdgeCreate.html +26 -7
  251. package/docs/interfaces/datatypes.TLSEdgeList.html +3 -3
  252. package/docs/interfaces/datatypes.TLSEdgeUpdate.html +27 -8
  253. package/docs/interfaces/datatypes.Tunnel.html +11 -11
  254. package/docs/interfaces/datatypes.TunnelGroupBackend.html +7 -7
  255. package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +3 -3
  256. package/docs/interfaces/datatypes.TunnelGroupBackendList.html +3 -3
  257. package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +4 -4
  258. package/docs/interfaces/datatypes.TunnelList.html +3 -3
  259. package/docs/interfaces/datatypes.TunnelSession.html +10 -10
  260. package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
  261. package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
  262. package/docs/interfaces/datatypes.UserAgent.html +6 -6
  263. package/docs/interfaces/datatypes.WeightedBackend.html +6 -6
  264. package/docs/interfaces/datatypes.WeightedBackendCreate.html +3 -3
  265. package/docs/interfaces/datatypes.WeightedBackendList.html +3 -3
  266. package/docs/interfaces/datatypes.WeightedBackendUpdate.html +4 -4
  267. package/docs/modules/datatypes.html +60 -0
  268. package/docs/modules/services.html +24 -0
  269. package/lib/client.d.ts +8 -1
  270. package/lib/client.d.ts.map +1 -1
  271. package/lib/client.js +4 -1
  272. package/lib/client.js.map +1 -1
  273. package/lib/datatypes.d.ts +147 -4
  274. package/lib/datatypes.d.ts.map +1 -1
  275. package/lib/services.d.ts +90 -0
  276. package/lib/services.d.ts.map +1 -1
  277. package/lib/services.js +545 -226
  278. package/lib/services.js.map +1 -1
  279. package/package.json +2 -1
  280. package/src/client.ts +13 -2
  281. package/src/datatypes.ts +162 -4
  282. package/src/services.ts +458 -122
@@ -77,6 +77,7 @@
77
77
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.AgentIngresses.html" class="tsd-kind-icon">Agent<wbr>Ingresses</a></li>
78
78
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.ApplicationSessions.html" class="tsd-kind-icon">Application<wbr>Sessions</a></li>
79
79
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.ApplicationUsers.html" class="tsd-kind-icon">Application<wbr>Users</a></li>
80
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.BotUsers.html" class="tsd-kind-icon">Bot<wbr>Users</a></li>
80
81
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.CertificateAuthorities.html" class="tsd-kind-icon">Certificate<wbr>Authorities</a></li>
81
82
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.Credentials.html" class="tsd-kind-icon">Credentials</a></li>
82
83
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EdgeRouteBackendModule.html" class="tsd-kind-icon">Edge<wbr>Route<wbr>Backend<wbr>Module</a></li>
@@ -88,6 +89,8 @@
88
89
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EdgeRouteRequestHeadersModule.html" class="tsd-kind-icon">Edge<wbr>Route<wbr>Request<wbr>Headers<wbr>Module</a></li>
89
90
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EdgeRouteResponseHeadersModule.html" class="tsd-kind-icon">Edge<wbr>Route<wbr>Response<wbr>Headers<wbr>Module</a></li>
90
91
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EdgeRouteSAMLModule.html" class="tsd-kind-icon">Edge<wbr>RouteSAMLModule</a></li>
92
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EdgeRouteTrafficPolicyModule.html" class="tsd-kind-icon">Edge<wbr>Route<wbr>Traffic<wbr>Policy<wbr>Module</a></li>
93
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EdgeRouteUserAgentFilterModule.html" class="tsd-kind-icon">Edge<wbr>Route<wbr>User<wbr>Agent<wbr>Filter<wbr>Module</a></li>
91
94
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EdgeRouteWebhookVerificationModule.html" class="tsd-kind-icon">Edge<wbr>Route<wbr>Webhook<wbr>Verification<wbr>Module</a></li>
92
95
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EdgeRouteWebsocketTCPConverterModule.html" class="tsd-kind-icon">Edge<wbr>Route<wbr>WebsocketTCPConverter<wbr>Module</a></li>
93
96
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.EdgesHTTPS.html" class="tsd-kind-icon">EdgesHTTPS</a></li>
@@ -111,13 +114,16 @@
111
114
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.SSHCredentials.html" class="tsd-kind-icon">SSHCredentials</a></li>
112
115
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.SSHHostCertificates.html" class="tsd-kind-icon">SSHHost<wbr>Certificates</a></li>
113
116
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.SSHUserCertificates.html" class="tsd-kind-icon">SSHUser<wbr>Certificates</a></li>
117
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.StaticBackends.html" class="tsd-kind-icon">Static<wbr>Backends</a></li>
114
118
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.TCPEdgeBackendModule.html" class="tsd-kind-icon">TCPEdge<wbr>Backend<wbr>Module</a></li>
115
119
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.TCPEdgeIPRestrictionModule.html" class="tsd-kind-icon">TCPEdgeIPRestriction<wbr>Module</a></li>
120
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.TCPEdgeTrafficPolicyModule.html" class="tsd-kind-icon">TCPEdge<wbr>Traffic<wbr>Policy<wbr>Module</a></li>
116
121
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.TLSCertificates.html" class="tsd-kind-icon">TLSCertificates</a></li>
117
122
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.TLSEdgeBackendModule.html" class="tsd-kind-icon">TLSEdge<wbr>Backend<wbr>Module</a></li>
118
123
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.TLSEdgeIPRestrictionModule.html" class="tsd-kind-icon">TLSEdgeIPRestriction<wbr>Module</a></li>
119
124
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.TLSEdgeMutualTLSModule.html" class="tsd-kind-icon">TLSEdge<wbr>MutualTLSModule</a></li>
120
125
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.TLSEdgeTLSTerminationModule.html" class="tsd-kind-icon">TLSEdgeTLSTermination<wbr>Module</a></li>
126
+ <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.TLSEdgeTrafficPolicyModule.html" class="tsd-kind-icon">TLSEdge<wbr>Traffic<wbr>Policy<wbr>Module</a></li>
121
127
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.TunnelGroupBackends.html" class="tsd-kind-icon">Tunnel<wbr>Group<wbr>Backends</a></li>
122
128
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.TunnelSessions.html" class="tsd-kind-icon">Tunnel<wbr>Sessions</a></li>
123
129
  <li class="tsd-kind-class tsd-parent-kind-module"><a href="../classes/services.Tunnels.html" class="tsd-kind-icon">Tunnels</a></li>
@@ -162,6 +168,9 @@
162
168
  <li class=" tsd-kind-class tsd-parent-kind-module">
163
169
  <a href="../classes/services.ApplicationUsers.html" class="tsd-kind-icon">Application<wbr>Users</a>
164
170
  </li>
171
+ <li class=" tsd-kind-class tsd-parent-kind-module">
172
+ <a href="../classes/services.BotUsers.html" class="tsd-kind-icon">Bot<wbr>Users</a>
173
+ </li>
165
174
  <li class=" tsd-kind-class tsd-parent-kind-module">
166
175
  <a href="../classes/services.CertificateAuthorities.html" class="tsd-kind-icon">Certificate<wbr>Authorities</a>
167
176
  </li>
@@ -195,6 +204,12 @@
195
204
  <li class=" tsd-kind-class tsd-parent-kind-module">
196
205
  <a href="../classes/services.EdgeRouteSAMLModule.html" class="tsd-kind-icon">Edge<wbr>RouteSAMLModule</a>
197
206
  </li>
207
+ <li class=" tsd-kind-class tsd-parent-kind-module">
208
+ <a href="../classes/services.EdgeRouteTrafficPolicyModule.html" class="tsd-kind-icon">Edge<wbr>Route<wbr>Traffic<wbr>Policy<wbr>Module</a>
209
+ </li>
210
+ <li class=" tsd-kind-class tsd-parent-kind-module">
211
+ <a href="../classes/services.EdgeRouteUserAgentFilterModule.html" class="tsd-kind-icon">Edge<wbr>Route<wbr>User<wbr>Agent<wbr>Filter<wbr>Module</a>
212
+ </li>
198
213
  <li class=" tsd-kind-class tsd-parent-kind-module">
199
214
  <a href="../classes/services.EdgeRouteWebhookVerificationModule.html" class="tsd-kind-icon">Edge<wbr>Route<wbr>Webhook<wbr>Verification<wbr>Module</a>
200
215
  </li>
@@ -264,12 +279,18 @@
264
279
  <li class=" tsd-kind-class tsd-parent-kind-module">
265
280
  <a href="../classes/services.SSHUserCertificates.html" class="tsd-kind-icon">SSHUser<wbr>Certificates</a>
266
281
  </li>
282
+ <li class=" tsd-kind-class tsd-parent-kind-module">
283
+ <a href="../classes/services.StaticBackends.html" class="tsd-kind-icon">Static<wbr>Backends</a>
284
+ </li>
267
285
  <li class=" tsd-kind-class tsd-parent-kind-module">
268
286
  <a href="../classes/services.TCPEdgeBackendModule.html" class="tsd-kind-icon">TCPEdge<wbr>Backend<wbr>Module</a>
269
287
  </li>
270
288
  <li class=" tsd-kind-class tsd-parent-kind-module">
271
289
  <a href="../classes/services.TCPEdgeIPRestrictionModule.html" class="tsd-kind-icon">TCPEdgeIPRestriction<wbr>Module</a>
272
290
  </li>
291
+ <li class=" tsd-kind-class tsd-parent-kind-module">
292
+ <a href="../classes/services.TCPEdgeTrafficPolicyModule.html" class="tsd-kind-icon">TCPEdge<wbr>Traffic<wbr>Policy<wbr>Module</a>
293
+ </li>
273
294
  <li class=" tsd-kind-class tsd-parent-kind-module">
274
295
  <a href="../classes/services.TLSCertificates.html" class="tsd-kind-icon">TLSCertificates</a>
275
296
  </li>
@@ -285,6 +306,9 @@
285
306
  <li class=" tsd-kind-class tsd-parent-kind-module">
286
307
  <a href="../classes/services.TLSEdgeTLSTerminationModule.html" class="tsd-kind-icon">TLSEdgeTLSTermination<wbr>Module</a>
287
308
  </li>
309
+ <li class=" tsd-kind-class tsd-parent-kind-module">
310
+ <a href="../classes/services.TLSEdgeTrafficPolicyModule.html" class="tsd-kind-icon">TLSEdge<wbr>Traffic<wbr>Policy<wbr>Module</a>
311
+ </li>
288
312
  <li class=" tsd-kind-class tsd-parent-kind-module">
289
313
  <a href="../classes/services.TunnelGroupBackends.html" class="tsd-kind-icon">Tunnel<wbr>Group<wbr>Backends</a>
290
314
  </li>
package/lib/client.d.ts CHANGED
@@ -1,7 +1,7 @@
1
1
  import * as services from './services';
2
2
  export interface NgrokConfig {
3
3
  apiToken: string;
4
- baseUrl: string;
4
+ baseUrl?: string;
5
5
  }
6
6
  export declare class Ngrok {
7
7
  private token;
@@ -29,6 +29,7 @@ export declare class Ngrok {
29
29
  session can include one or more Tunnels.
30
30
  */
31
31
  tunnelSessions: services.TunnelSessions;
32
+ botUsers: services.BotUsers;
32
33
  /**
33
34
  * Certificate Authorities are x509 certificates that are used to sign other
34
35
  x509 certificates. Attach a Certificate Authority to the Mutual TLS module
@@ -131,6 +132,11 @@ export declare class Ngrok {
131
132
  */
132
133
  failoverBackends: services.FailoverBackends;
133
134
  httpResponseBackends: services.HTTPResponseBackends;
135
+ /**
136
+ * A static backend sends traffic to a TCP address (hostname and port) that
137
+ is reachable on the public internet.
138
+ */
139
+ staticBackends: services.StaticBackends;
134
140
  /**
135
141
  * A Tunnel Group Backend balances traffic among all online tunnels that match
136
142
  a label selector.
@@ -164,6 +170,7 @@ export declare class Ngrok {
164
170
  edgeRouteSamlModule: services.EdgeRouteSAMLModule;
165
171
  edgeRouteOidcModule: services.EdgeRouteOIDCModule;
166
172
  edgeRouteWebsocketTcpConverterModule: services.EdgeRouteWebsocketTCPConverterModule;
173
+ edgeRouteUserAgentFilterModule: services.EdgeRouteUserAgentFilterModule;
167
174
  tcpEdgeBackendModule: services.TCPEdgeBackendModule;
168
175
  tcpEdgeIpRestrictionModule: services.TCPEdgeIPRestrictionModule;
169
176
  tlsEdgeBackendModule: services.TLSEdgeBackendModule;
@@ -1 +1 @@
1
- {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AAQvC,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,qBAAa,KAAK;IAChB,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,UAAU,CAAW;IAC7B;;;OAGG;IACI,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC;IACpC,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC;IAC/C;;;;;;OAMG;IACI,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC;IAC1B,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,CAAC;IAClD,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB,CAAC;IACnD;;;;OAIG;IACI,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC;IAC/C;;;;;;OAMG;IACI,sBAAsB,EAAE,QAAQ,CAAC,sBAAsB,CAAC;IAC/D;;;;;OAKG;IACI,WAAW,EAAE,QAAQ,CAAC,WAAW,CAAC;IACzC;;;;OAIG;IACI,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC;IAC9B,iBAAiB,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAC9C,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB,CAAC;IAChD,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC;IAC3C;;;;;OAKG;IACI,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC;IACvC;;;OAGG;IACI,aAAa,EAAE,QAAQ,CAAC,aAAa,CAAC;IAC7C;;;;;;;OAOG;IACI,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC;IAC/C;;;;OAIG;IACI,aAAa,EAAE,QAAQ,CAAC,aAAa,CAAC;IAC7C;;;;;OAKG;IACI,eAAe,EAAE,QAAQ,CAAC,eAAe,CAAC;IACjD;;;OAGG;IACI,yBAAyB,EAAE,QAAQ,CAAC,yBAAyB,CAAC;IACrE;;;OAGG;IACI,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC;IAC/C;;;;OAIG;IACI,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,CAAC;IACzD;;;;OAIG;IACI,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,CAAC;IACzD;;;;;;OAMG;IACI,eAAe,EAAE,QAAQ,CAAC,eAAe,CAAC;IACjD;;;OAGG;IACI,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC;IAC1B,QAAQ,EAAE;QACf;;;;;WAKG;QACH,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB,CAAC;QAC5C,oBAAoB,EAAE,QAAQ,CAAC,oBAAoB,CAAC;QACpD;;;WAGG;QACH,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,CAAC;QAClD;;;;;WAKG;QACH,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB,CAAC;KAC7C,CAAC;IACK,KAAK,EAAE;QACZ,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB,CAAC;QAC5C,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC;QAChC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC;QAC5B,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC;KAC7B,CAAC;IACK,WAAW,EAAE;QAClB,wBAAwB,EAAE,QAAQ,CAAC,wBAAwB,CAAC;QAC5D,6BAA6B,EAAE,QAAQ,CAAC,6BAA6B,CAAC;QACtE,sBAAsB,EAAE,QAAQ,CAAC,sBAAsB,CAAC;QACxD,4BAA4B,EAAE,QAAQ,CAAC,4BAA4B,CAAC;QACpE,6BAA6B,EAAE,QAAQ,CAAC,6BAA6B,CAAC;QACtE,8BAA8B,EAAE,QAAQ,CAAC,8BAA8B,CAAC;QACxE,0BAA0B,EAAE,QAAQ,CAAC,0BAA0B,CAAC;QAChE,6BAA6B,EAAE,QAAQ,CAAC,6BAA6B,CAAC;QACtE,kCAAkC,EAAE,QAAQ,CAAC,kCAAkC,CAAC;QAChF,oBAAoB,EAAE,QAAQ,CAAC,oBAAoB,CAAC;QACpD,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,CAAC;QAClD,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,CAAC;QAClD,oCAAoC,EAAE,QAAQ,CAAC,oCAAoC,CAAC;QACpF,oBAAoB,EAAE,QAAQ,CAAC,oBAAoB,CAAC;QACpD,0BAA0B,EAAE,QAAQ,CAAC,0BAA0B,CAAC;QAChE,oBAAoB,EAAE,QAAQ,CAAC,oBAAoB,CAAC;QACpD,0BAA0B,EAAE,QAAQ,CAAC,0BAA0B,CAAC;QAChE,sBAAsB,EAAE,QAAQ,CAAC,sBAAsB,CAAC;QACxD,2BAA2B,EAAE,QAAQ,CAAC,2BAA2B,CAAC;KACnE,CAAC;IAEF;;;;OAIG;gBACgB,EAAC,OAAiC,EAAE,QAAQ,EAAC,EAAE,WAAW;CA0E9E"}
1
+ {"version":3,"file":"client.d.ts","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,QAAQ,MAAM,YAAY,CAAC;AAQvC,MAAM,WAAW,WAAW;IAC1B,QAAQ,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,qBAAa,KAAK;IAChB,OAAO,CAAC,KAAK,CAAS;IACtB,OAAO,CAAC,OAAO,CAAS;IACxB,OAAO,CAAC,UAAU,CAAW;IAC7B;;;OAGG;IACI,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC;IACpC,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC;IAC/C;;;;;;OAMG;IACI,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC;IAC1B,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,CAAC;IAClD,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB,CAAC;IACnD;;;;OAIG;IACI,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC;IACxC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC;IACnC;;;;;;OAMG;IACI,sBAAsB,EAAE,QAAQ,CAAC,sBAAsB,CAAC;IAC/D;;;;;OAKG;IACI,WAAW,EAAE,QAAQ,CAAC,WAAW,CAAC;IACzC;;;;OAIG;IACI,SAAS,EAAE,QAAQ,CAAC,SAAS,CAAC;IAC9B,iBAAiB,EAAE,QAAQ,CAAC,iBAAiB,CAAC;IAC9C,kBAAkB,EAAE,QAAQ,CAAC,kBAAkB,CAAC;IAChD,YAAY,EAAE,QAAQ,CAAC,YAAY,CAAC;IAC3C;;;;;OAKG;IACI,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC;IACvC;;;OAGG;IACI,aAAa,EAAE,QAAQ,CAAC,aAAa,CAAC;IAC7C;;;;;;;OAOG;IACI,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC;IAC/C;;;;OAIG;IACI,aAAa,EAAE,QAAQ,CAAC,aAAa,CAAC;IAC7C;;;;;OAKG;IACI,eAAe,EAAE,QAAQ,CAAC,eAAe,CAAC;IACjD;;;OAGG;IACI,yBAAyB,EAAE,QAAQ,CAAC,yBAAyB,CAAC;IACrE;;;OAGG;IACI,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC;IAC/C;;;;OAIG;IACI,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,CAAC;IACzD;;;;OAIG;IACI,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,CAAC;IACzD;;;;;;OAMG;IACI,eAAe,EAAE,QAAQ,CAAC,eAAe,CAAC;IACjD;;;OAGG;IACI,OAAO,EAAE,QAAQ,CAAC,OAAO,CAAC;IAC1B,QAAQ,EAAE;QACf;;;;;WAKG;QACH,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB,CAAC;QAC5C,oBAAoB,EAAE,QAAQ,CAAC,oBAAoB,CAAC;QACpD;;;WAGG;QACH,cAAc,EAAE,QAAQ,CAAC,cAAc,CAAC;QACxC;;;WAGG;QACH,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,CAAC;QAClD;;;;;WAKG;QACH,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB,CAAC;KAC7C,CAAC;IACK,KAAK,EAAE;QACZ,gBAAgB,EAAE,QAAQ,CAAC,gBAAgB,CAAC;QAC5C,UAAU,EAAE,QAAQ,CAAC,UAAU,CAAC;QAChC,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC;QAC5B,QAAQ,EAAE,QAAQ,CAAC,QAAQ,CAAC;KAC7B,CAAC;IACK,WAAW,EAAE;QAClB,wBAAwB,EAAE,QAAQ,CAAC,wBAAwB,CAAC;QAC5D,6BAA6B,EAAE,QAAQ,CAAC,6BAA6B,CAAC;QACtE,sBAAsB,EAAE,QAAQ,CAAC,sBAAsB,CAAC;QACxD,4BAA4B,EAAE,QAAQ,CAAC,4BAA4B,CAAC;QACpE,6BAA6B,EAAE,QAAQ,CAAC,6BAA6B,CAAC;QACtE,8BAA8B,EAAE,QAAQ,CAAC,8BAA8B,CAAC;QACxE,0BAA0B,EAAE,QAAQ,CAAC,0BAA0B,CAAC;QAChE,6BAA6B,EAAE,QAAQ,CAAC,6BAA6B,CAAC;QACtE,kCAAkC,EAAE,QAAQ,CAAC,kCAAkC,CAAC;QAChF,oBAAoB,EAAE,QAAQ,CAAC,oBAAoB,CAAC;QACpD,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,CAAC;QAClD,mBAAmB,EAAE,QAAQ,CAAC,mBAAmB,CAAC;QAClD,oCAAoC,EAAE,QAAQ,CAAC,oCAAoC,CAAC;QACpF,8BAA8B,EAAE,QAAQ,CAAC,8BAA8B,CAAC;QACxE,oBAAoB,EAAE,QAAQ,CAAC,oBAAoB,CAAC;QACpD,0BAA0B,EAAE,QAAQ,CAAC,0BAA0B,CAAC;QAChE,oBAAoB,EAAE,QAAQ,CAAC,oBAAoB,CAAC;QACpD,0BAA0B,EAAE,QAAQ,CAAC,0BAA0B,CAAC;QAChE,sBAAsB,EAAE,QAAQ,CAAC,sBAAsB,CAAC;QACxD,2BAA2B,EAAE,QAAQ,CAAC,2BAA2B,CAAC;KACnE,CAAC;IAEF;;;;OAIG;gBACgB,EAAC,OAAiC,EAAE,QAAQ,EAAC,EAAE,WAAW;CA6E9E"}
package/lib/client.js CHANGED
@@ -29,7 +29,7 @@ class Ngrok {
29
29
  this.httpClient = (0, wretch_1.default)()
30
30
  .url(baseUrl)
31
31
  .headers({
32
- 'User-Agent': 'ngrok-api-typescript/0.10.0/' + process.version,
32
+ 'User-Agent': 'ngrok-api-typescript/0.11.0/' + process.version,
33
33
  'Ngrok-Version': '2',
34
34
  })
35
35
  .content("application/json")
@@ -40,6 +40,7 @@ class Ngrok {
40
40
  this.applicationSessions = new services.ApplicationSessions(this.httpClient);
41
41
  this.applicationUsers = new services.ApplicationUsers(this.httpClient);
42
42
  this.tunnelSessions = new services.TunnelSessions(this.httpClient);
43
+ this.botUsers = new services.BotUsers(this.httpClient);
43
44
  this.certificateAuthorities = new services.CertificateAuthorities(this.httpClient);
44
45
  this.credentials = new services.Credentials(this.httpClient);
45
46
  this.endpoints = new services.Endpoints(this.httpClient);
@@ -60,6 +61,7 @@ class Ngrok {
60
61
  this.backends = {
61
62
  failoverBackends: new services.FailoverBackends(this.httpClient),
62
63
  httpResponseBackends: new services.HTTPResponseBackends(this.httpClient),
64
+ staticBackends: new services.StaticBackends(this.httpClient),
63
65
  tunnelGroupBackends: new services.TunnelGroupBackends(this.httpClient),
64
66
  weightedBackends: new services.WeightedBackends(this.httpClient),
65
67
  };
@@ -83,6 +85,7 @@ class Ngrok {
83
85
  edgeRouteSamlModule: new services.EdgeRouteSAMLModule(this.httpClient),
84
86
  edgeRouteOidcModule: new services.EdgeRouteOIDCModule(this.httpClient),
85
87
  edgeRouteWebsocketTcpConverterModule: new services.EdgeRouteWebsocketTCPConverterModule(this.httpClient),
88
+ edgeRouteUserAgentFilterModule: new services.EdgeRouteUserAgentFilterModule(this.httpClient),
86
89
  tcpEdgeBackendModule: new services.TCPEdgeBackendModule(this.httpClient),
87
90
  tcpEdgeIpRestrictionModule: new services.TCPEdgeIPRestrictionModule(this.httpClient),
88
91
  tlsEdgeBackendModule: new services.TLSEdgeBackendModule(this.httpClient),
package/lib/client.js.map CHANGED
@@ -1 +1 @@
1
- {"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";AAAA,+CAA+C;;;AAG/C,mCAA0C;AAC1C,sCAAsC;AACtC,6BAAsC;AACtC,2CAAmC;AACnC,uCAAuC;AAEvC,IAAA,gBAAM,GAAE,CAAC,SAAS,CAAC;IACf,KAAK,EAAE,oBAAS;IAChB,QAAQ,EAAE,QAAQ;IAClB,eAAe,EAAf,qBAAe;CAClB,CAAC,CAAC;AAOH,MAAa,KAAK;IAyKhB;;;;OAIG;IACH,YAAmB,EAAC,OAAO,GAAG,uBAAuB,EAAE,QAAQ,EAAc;QAC3E,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,IAAI,QAAQ,EAAE;YACZ,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC;SACvB;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;SACnE;QAED,IAAI,CAAC,UAAU,GAAG,IAAA,gBAAM,GAAE;aACvB,GAAG,CAAC,OAAO,CAAC;aACZ,OAAO,CAAC;YACP,YAAY,EAAE,8BAA8B,GAAG,OAAO,CAAC,OAAO;YAC9D,eAAe,EAAE,GAAG;SACrB,CAAC;aACD,OAAO,CAAC,kBAAkB,CAAC;aAC3B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QAChC,IAAI,CAAC,YAAY,GAAG,IAAI,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/D,IAAI,CAAC,cAAc,GAAG,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACnE,IAAI,CAAC,OAAO,GAAG,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACrD,IAAI,CAAC,mBAAmB,GAAG,IAAI,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC7E,IAAI,CAAC,gBAAgB,GAAG,IAAI,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACvE,IAAI,CAAC,cAAc,GAAG,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACnE,IAAI,CAAC,sBAAsB,GAAG,IAAI,QAAQ,CAAC,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACnF,IAAI,CAAC,WAAW,GAAG,IAAI,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC7D,IAAI,CAAC,SAAS,GAAG,IAAI,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACzD,IAAI,CAAC,iBAAiB,GAAG,IAAI,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACzE,IAAI,CAAC,kBAAkB,GAAG,IAAI,QAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC3E,IAAI,CAAC,YAAY,GAAG,IAAI,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/D,IAAI,CAAC,UAAU,GAAG,IAAI,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC3D,IAAI,CAAC,aAAa,GAAG,IAAI,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACjE,IAAI,CAAC,cAAc,GAAG,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACnE,IAAI,CAAC,aAAa,GAAG,IAAI,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACjE,IAAI,CAAC,eAAe,GAAG,IAAI,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACrE,IAAI,CAAC,yBAAyB,GAAG,IAAI,QAAQ,CAAC,yBAAyB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACzF,IAAI,CAAC,cAAc,GAAG,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACnE,IAAI,CAAC,mBAAmB,GAAG,IAAI,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC7E,IAAI,CAAC,mBAAmB,GAAG,IAAI,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC7E,IAAI,CAAC,eAAe,GAAG,IAAI,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACrE,IAAI,CAAC,OAAO,GAAG,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACrD,IAAI,CAAC,QAAQ,GAAG;YACd,gBAAgB,EAAE,IAAI,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC;YAChE,oBAAoB,EAAE,IAAI,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,UAAU,CAAC;YACxE,mBAAmB,EAAE,IAAI,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC;YACtE,gBAAgB,EAAE,IAAI,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC;SACjE,CAAC;QACF,IAAI,CAAC,KAAK,GAAG;YACX,gBAAgB,EAAE,IAAI,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC;YAChE,UAAU,EAAE,IAAI,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC;YACpD,QAAQ,EAAE,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC;YAChD,QAAQ,EAAE,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC;SACjD,CAAC;QACF,IAAI,CAAC,WAAW,GAAG;YACjB,wBAAwB,EAAE,IAAI,QAAQ,CAAC,wBAAwB,CAAC,IAAI,CAAC,UAAU,CAAC;YAChF,6BAA6B,EAAE,IAAI,QAAQ,CAAC,6BAA6B,CAAC,IAAI,CAAC,UAAU,CAAC;YAC1F,sBAAsB,EAAE,IAAI,QAAQ,CAAC,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC;YAC5E,4BAA4B,EAAE,IAAI,QAAQ,CAAC,4BAA4B,CAAC,IAAI,CAAC,UAAU,CAAC;YACxF,6BAA6B,EAAE,IAAI,QAAQ,CAAC,6BAA6B,CAAC,IAAI,CAAC,UAAU,CAAC;YAC1F,8BAA8B,EAAE,IAAI,QAAQ,CAAC,8BAA8B,CAAC,IAAI,CAAC,UAAU,CAAC;YAC5F,0BAA0B,EAAE,IAAI,QAAQ,CAAC,0BAA0B,CAAC,IAAI,CAAC,UAAU,CAAC;YACpF,6BAA6B,EAAE,IAAI,QAAQ,CAAC,6BAA6B,CAAC,IAAI,CAAC,UAAU,CAAC;YAC1F,kCAAkC,EAAE,IAAI,QAAQ,CAAC,kCAAkC,CAAC,IAAI,CAAC,UAAU,CAAC;YACpG,oBAAoB,EAAE,IAAI,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,UAAU,CAAC;YACxE,mBAAmB,EAAE,IAAI,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC;YACtE,mBAAmB,EAAE,IAAI,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC;YACtE,oCAAoC,EAAE,IAAI,QAAQ,CAAC,oCAAoC,CAAC,IAAI,CAAC,UAAU,CAAC;YACxG,oBAAoB,EAAE,IAAI,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,UAAU,CAAC;YACxE,0BAA0B,EAAE,IAAI,QAAQ,CAAC,0BAA0B,CAAC,IAAI,CAAC,UAAU,CAAC;YACpF,oBAAoB,EAAE,IAAI,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,UAAU,CAAC;YACxE,0BAA0B,EAAE,IAAI,QAAQ,CAAC,0BAA0B,CAAC,IAAI,CAAC,UAAU,CAAC;YACpF,sBAAsB,EAAE,IAAI,QAAQ,CAAC,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC;YAC5E,2BAA2B,EAAE,IAAI,QAAQ,CAAC,2BAA2B,CAAC,IAAI,CAAC,UAAU,CAAC;SACvF,CAAC;IACJ,CAAC;CACF;AAxPD,sBAwPC"}
1
+ {"version":3,"file":"client.js","sourceRoot":"","sources":["../src/client.ts"],"names":[],"mappings":";AAAA,+CAA+C;;;AAG/C,mCAA0C;AAC1C,sCAAsC;AACtC,6BAAsC;AACtC,2CAAmC;AACnC,uCAAuC;AAEvC,IAAA,gBAAM,GAAE,CAAC,SAAS,CAAC;IACf,KAAK,EAAE,oBAAS;IAChB,QAAQ,EAAE,QAAQ;IAClB,eAAe,EAAf,qBAAe;CAClB,CAAC,CAAC;AAOH,MAAa,KAAK;IAgLhB;;;;OAIG;IACH,YAAmB,EAAC,OAAO,GAAG,uBAAuB,EAAE,QAAQ,EAAc;QAC3E,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QAEvB,IAAI,QAAQ,EAAE;YACZ,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC;SACvB;aAAM;YACL,MAAM,IAAI,KAAK,CAAC,gDAAgD,CAAC,CAAC;SACnE;QAED,IAAI,CAAC,UAAU,GAAG,IAAA,gBAAM,GAAE;aACvB,GAAG,CAAC,OAAO,CAAC;aACZ,OAAO,CAAC;YACP,YAAY,EAAE,8BAA8B,GAAG,OAAO,CAAC,OAAO;YAC9D,eAAe,EAAE,GAAG;SACrB,CAAC;aACD,OAAO,CAAC,kBAAkB,CAAC;aAC3B,IAAI,CAAC,SAAS,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC;QAChC,IAAI,CAAC,YAAY,GAAG,IAAI,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/D,IAAI,CAAC,cAAc,GAAG,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACnE,IAAI,CAAC,OAAO,GAAG,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACrD,IAAI,CAAC,mBAAmB,GAAG,IAAI,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC7E,IAAI,CAAC,gBAAgB,GAAG,IAAI,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACvE,IAAI,CAAC,cAAc,GAAG,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACnE,IAAI,CAAC,QAAQ,GAAG,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACvD,IAAI,CAAC,sBAAsB,GAAG,IAAI,QAAQ,CAAC,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACnF,IAAI,CAAC,WAAW,GAAG,IAAI,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC7D,IAAI,CAAC,SAAS,GAAG,IAAI,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACzD,IAAI,CAAC,iBAAiB,GAAG,IAAI,QAAQ,CAAC,iBAAiB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACzE,IAAI,CAAC,kBAAkB,GAAG,IAAI,QAAQ,CAAC,kBAAkB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC3E,IAAI,CAAC,YAAY,GAAG,IAAI,QAAQ,CAAC,YAAY,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC/D,IAAI,CAAC,UAAU,GAAG,IAAI,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC3D,IAAI,CAAC,aAAa,GAAG,IAAI,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACjE,IAAI,CAAC,cAAc,GAAG,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACnE,IAAI,CAAC,aAAa,GAAG,IAAI,QAAQ,CAAC,aAAa,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACjE,IAAI,CAAC,eAAe,GAAG,IAAI,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACrE,IAAI,CAAC,yBAAyB,GAAG,IAAI,QAAQ,CAAC,yBAAyB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACzF,IAAI,CAAC,cAAc,GAAG,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACnE,IAAI,CAAC,mBAAmB,GAAG,IAAI,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC7E,IAAI,CAAC,mBAAmB,GAAG,IAAI,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QAC7E,IAAI,CAAC,eAAe,GAAG,IAAI,QAAQ,CAAC,eAAe,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACrE,IAAI,CAAC,OAAO,GAAG,IAAI,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;QACrD,IAAI,CAAC,QAAQ,GAAG;YACd,gBAAgB,EAAE,IAAI,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC;YAChE,oBAAoB,EAAE,IAAI,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,UAAU,CAAC;YACxE,cAAc,EAAE,IAAI,QAAQ,CAAC,cAAc,CAAC,IAAI,CAAC,UAAU,CAAC;YAC5D,mBAAmB,EAAE,IAAI,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC;YACtE,gBAAgB,EAAE,IAAI,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC;SACjE,CAAC;QACF,IAAI,CAAC,KAAK,GAAG;YACX,gBAAgB,EAAE,IAAI,QAAQ,CAAC,gBAAgB,CAAC,IAAI,CAAC,UAAU,CAAC;YAChE,UAAU,EAAE,IAAI,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,UAAU,CAAC;YACpD,QAAQ,EAAE,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC;YAChD,QAAQ,EAAE,IAAI,QAAQ,CAAC,QAAQ,CAAC,IAAI,CAAC,UAAU,CAAC;SACjD,CAAC;QACF,IAAI,CAAC,WAAW,GAAG;YACjB,wBAAwB,EAAE,IAAI,QAAQ,CAAC,wBAAwB,CAAC,IAAI,CAAC,UAAU,CAAC;YAChF,6BAA6B,EAAE,IAAI,QAAQ,CAAC,6BAA6B,CAAC,IAAI,CAAC,UAAU,CAAC;YAC1F,sBAAsB,EAAE,IAAI,QAAQ,CAAC,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC;YAC5E,4BAA4B,EAAE,IAAI,QAAQ,CAAC,4BAA4B,CAAC,IAAI,CAAC,UAAU,CAAC;YACxF,6BAA6B,EAAE,IAAI,QAAQ,CAAC,6BAA6B,CAAC,IAAI,CAAC,UAAU,CAAC;YAC1F,8BAA8B,EAAE,IAAI,QAAQ,CAAC,8BAA8B,CAAC,IAAI,CAAC,UAAU,CAAC;YAC5F,0BAA0B,EAAE,IAAI,QAAQ,CAAC,0BAA0B,CAAC,IAAI,CAAC,UAAU,CAAC;YACpF,6BAA6B,EAAE,IAAI,QAAQ,CAAC,6BAA6B,CAAC,IAAI,CAAC,UAAU,CAAC;YAC1F,kCAAkC,EAAE,IAAI,QAAQ,CAAC,kCAAkC,CAAC,IAAI,CAAC,UAAU,CAAC;YACpG,oBAAoB,EAAE,IAAI,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,UAAU,CAAC;YACxE,mBAAmB,EAAE,IAAI,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC;YACtE,mBAAmB,EAAE,IAAI,QAAQ,CAAC,mBAAmB,CAAC,IAAI,CAAC,UAAU,CAAC;YACtE,oCAAoC,EAAE,IAAI,QAAQ,CAAC,oCAAoC,CAAC,IAAI,CAAC,UAAU,CAAC;YACxG,8BAA8B,EAAE,IAAI,QAAQ,CAAC,8BAA8B,CAAC,IAAI,CAAC,UAAU,CAAC;YAC5F,oBAAoB,EAAE,IAAI,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,UAAU,CAAC;YACxE,0BAA0B,EAAE,IAAI,QAAQ,CAAC,0BAA0B,CAAC,IAAI,CAAC,UAAU,CAAC;YACpF,oBAAoB,EAAE,IAAI,QAAQ,CAAC,oBAAoB,CAAC,IAAI,CAAC,UAAU,CAAC;YACxE,0BAA0B,EAAE,IAAI,QAAQ,CAAC,0BAA0B,CAAC,IAAI,CAAC,UAAU,CAAC;YACpF,sBAAsB,EAAE,IAAI,QAAQ,CAAC,sBAAsB,CAAC,IAAI,CAAC,UAAU,CAAC;YAC5E,2BAA2B,EAAE,IAAI,QAAQ,CAAC,2BAA2B,CAAC,IAAI,CAAC,UAAU,CAAC;SACvF,CAAC;IACJ,CAAC;CACF;AAlQD,sBAkQC"}
@@ -377,6 +377,55 @@ export interface HTTPResponseBackendList {
377
377
  uri: string;
378
378
  nextPageUri?: string;
379
379
  }
380
+ export interface StaticBackend {
381
+ /** unique identifier for this static backend */
382
+ id: string;
383
+ /** URI of the StaticBackend API resource */
384
+ uri: string;
385
+ /** timestamp when the backend was created, RFC 3339 format */
386
+ createdAt: Date;
387
+ /** human-readable description of this backend. Optional */
388
+ description?: string;
389
+ /** arbitrary user-defined machine-readable data of this backend. Optional */
390
+ metadata?: string;
391
+ /** the address to forward to */
392
+ address: string;
393
+ /** tls configuration to use */
394
+ tls: StaticBackendTLS;
395
+ }
396
+ export interface StaticBackendTLS {
397
+ /** if TLS is checked */
398
+ enabled: boolean;
399
+ }
400
+ export interface StaticBackendCreate {
401
+ /** human-readable description of this backend. Optional */
402
+ description?: string;
403
+ /** arbitrary user-defined machine-readable data of this backend. Optional */
404
+ metadata?: string;
405
+ /** the address to forward to */
406
+ address: string;
407
+ /** tls configuration to use */
408
+ tls: StaticBackendTLS;
409
+ }
410
+ export interface StaticBackendUpdate {
411
+ id: string;
412
+ /** human-readable description of this backend. Optional */
413
+ description?: string;
414
+ /** arbitrary user-defined machine-readable data of this backend. Optional */
415
+ metadata?: string;
416
+ /** the address to forward to */
417
+ address: string;
418
+ /** tls configuration to use */
419
+ tls: StaticBackendTLS;
420
+ }
421
+ export interface StaticBackendList {
422
+ /** the list of all static backends on this account */
423
+ backends: Array<StaticBackend>;
424
+ /** URI of the static backends list API resource */
425
+ uri: string;
426
+ /** URI of the next page, or null if there is no next page */
427
+ nextPageUri?: string;
428
+ }
380
429
  export interface TunnelGroupBackend {
381
430
  /** unique identifier for this TunnelGroup backend */
382
431
  id: string;
@@ -457,6 +506,39 @@ export interface WeightedBackendList {
457
506
  /** URI of the next page, or null if there is no next page */
458
507
  nextPageUri?: string;
459
508
  }
509
+ export interface BotUser {
510
+ /** unique API key resource identifier */
511
+ id: string;
512
+ /** URI to the API resource of this bot user */
513
+ uri: string;
514
+ /** human-readable name used to identify the bot */
515
+ name: string;
516
+ /** whether or not the bot is active */
517
+ active: boolean;
518
+ /** timestamp when the api key was created, RFC 3339 format */
519
+ createdAt: Date;
520
+ }
521
+ export interface BotUserCreate {
522
+ /** human-readable name used to identify the bot */
523
+ name: string;
524
+ /** whether or not the bot is active */
525
+ active?: boolean;
526
+ }
527
+ export interface BotUserUpdate {
528
+ id: string;
529
+ /** human-readable name used to identify the bot */
530
+ name?: string;
531
+ /** whether or not the bot is active */
532
+ active?: boolean;
533
+ }
534
+ export interface BotUserList {
535
+ /** the list of all bot users on this account */
536
+ botUsers: Array<BotUser>;
537
+ /** URI of the bot users list API resource */
538
+ uri: string;
539
+ /** URI of the next page, or null if there is no next page */
540
+ nextPageUri?: string;
541
+ }
460
542
  export interface CertificateAuthorityCreate {
461
543
  /** human-readable description of this Certificate Authority. optional, max 255 bytes. */
462
544
  description?: string;
@@ -552,7 +634,7 @@ export interface CredentialList {
552
634
  export interface EndpointWebhookValidation {
553
635
  /** `true` if the module will be applied to traffic, `false` to disable. default `true` if unspecified */
554
636
  enabled?: boolean;
555
- /** a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers defined at https://ngrok.com/docs/cloud-edge/modules/webhook */
637
+ /** a string indicating which webhook provider will be sending webhooks to this endpoint. Value must be one of the supported providers defined at https://ngrok.com/docs/cloud-edge/modules/webhook-verification */
556
638
  provider: string;
557
639
  /** a string secret used to validate requests from the given provider. All providers except AWS SNS require a secret */
558
640
  secret: string;
@@ -833,6 +915,17 @@ export interface EndpointWebsocketTCPConverter {
833
915
  /** `true` if the module will be applied to traffic, `false` to disable. default `true` if unspecified */
834
916
  enabled?: boolean;
835
917
  }
918
+ export interface EndpointUserAgentFilter {
919
+ enabled?: boolean;
920
+ allow: Array<string>;
921
+ deny: Array<string>;
922
+ }
923
+ export interface EndpointTrafficPolicy {
924
+ /** `true` if the module will be applied to traffic, `false` to disable. default `true` if unspecified */
925
+ enabled?: boolean;
926
+ /** the traffic policy that should be applied to the traffic on your endpoint. */
927
+ value: string;
928
+ }
836
929
  export interface EdgeRouteItem {
837
930
  /** unique identifier of this edge */
838
931
  edgeId: string;
@@ -872,6 +965,9 @@ export interface HTTPSEdgeRouteCreate {
872
965
  oidc?: EndpointOIDC;
873
966
  /** websocket to tcp adapter configuration or `null` */
874
967
  websocketTcpConverter?: EndpointWebsocketTCPConverter;
968
+ userAgentFilter?: EndpointUserAgentFilter;
969
+ /** the traffic policy associated with this edge or null */
970
+ trafficPolicy?: EndpointTrafficPolicy;
875
971
  }
876
972
  export interface HTTPSEdgeRouteUpdate {
877
973
  /** unique identifier of this edge */
@@ -908,6 +1004,9 @@ export interface HTTPSEdgeRouteUpdate {
908
1004
  oidc?: EndpointOIDC;
909
1005
  /** websocket to tcp adapter configuration or `null` */
910
1006
  websocketTcpConverter?: EndpointWebsocketTCPConverter;
1007
+ userAgentFilter?: EndpointUserAgentFilter;
1008
+ /** the traffic policy associated with this edge or null */
1009
+ trafficPolicy?: EndpointTrafficPolicy;
911
1010
  }
912
1011
  export interface HTTPSEdgeRoute {
913
1012
  /** unique identifier of this edge */
@@ -948,6 +1047,9 @@ export interface HTTPSEdgeRoute {
948
1047
  oidc?: EndpointOIDC;
949
1048
  /** websocket to tcp adapter configuration or `null` */
950
1049
  websocketTcpConverter?: EndpointWebsocketTCPConverter;
1050
+ userAgentFilter?: EndpointUserAgentFilter;
1051
+ /** the traffic policy associated with this edge or null */
1052
+ trafficPolicy?: EndpointTrafficPolicy;
951
1053
  }
952
1054
  export interface HTTPSEdgeList {
953
1055
  /** the list of all HTTPS Edges on this account */
@@ -1020,6 +1122,10 @@ export interface EdgeTLSTerminationAtEdgeReplace {
1020
1122
  id: string;
1021
1123
  module: EndpointTLSTerminationAtEdge;
1022
1124
  }
1125
+ export interface EdgeTrafficPolicyReplace {
1126
+ id: string;
1127
+ module: EndpointTrafficPolicy;
1128
+ }
1023
1129
  export interface EdgeRouteBackendReplace {
1024
1130
  edgeId: string;
1025
1131
  id: string;
@@ -1075,6 +1181,16 @@ export interface EdgeRouteWebsocketTCPConverterReplace {
1075
1181
  id: string;
1076
1182
  module: EndpointWebsocketTCPConverter;
1077
1183
  }
1184
+ export interface EdgeRouteUserAgentFilterReplace {
1185
+ edgeId: string;
1186
+ id: string;
1187
+ module: EndpointUserAgentFilter;
1188
+ }
1189
+ export interface EdgeRouteTrafficPolicyReplace {
1190
+ edgeId: string;
1191
+ id: string;
1192
+ module: EndpointTrafficPolicy;
1193
+ }
1078
1194
  export interface TCPEdgeList {
1079
1195
  /** the list of all TCP Edges on this account */
1080
1196
  tcpEdges: Array<TCPEdge>;
@@ -1093,6 +1209,8 @@ export interface TCPEdgeCreate {
1093
1209
  /** edge modules */
1094
1210
  backend?: EndpointBackendMutate;
1095
1211
  ipRestriction?: EndpointIPPolicyMutate;
1212
+ /** the traffic policy associated with this edge or null */
1213
+ trafficPolicy?: EndpointTrafficPolicy;
1096
1214
  }
1097
1215
  export interface TCPEdgeUpdate {
1098
1216
  /** unique identifier of this edge */
@@ -1106,6 +1224,8 @@ export interface TCPEdgeUpdate {
1106
1224
  /** edge modules */
1107
1225
  backend?: EndpointBackendMutate;
1108
1226
  ipRestriction?: EndpointIPPolicyMutate;
1227
+ /** the traffic policy associated with this edge or null */
1228
+ trafficPolicy?: EndpointTrafficPolicy;
1109
1229
  }
1110
1230
  export interface TCPEdge {
1111
1231
  /** unique identifier of this edge */
@@ -1123,6 +1243,8 @@ export interface TCPEdge {
1123
1243
  /** edge modules */
1124
1244
  backend?: EndpointBackend;
1125
1245
  ipRestriction?: EndpointIPPolicy;
1246
+ /** the traffic policy associated with this edge or null */
1247
+ trafficPolicy?: EndpointTrafficPolicy;
1126
1248
  }
1127
1249
  export interface TLSEdgeList {
1128
1250
  /** the list of all TLS Edges on this account */
@@ -1144,6 +1266,8 @@ export interface TLSEdgeCreate {
1144
1266
  ipRestriction?: EndpointIPPolicyMutate;
1145
1267
  mutualTls?: EndpointMutualTLSMutate;
1146
1268
  tlsTermination?: EndpointTLSTermination;
1269
+ /** the traffic policy associated with this edge or null */
1270
+ trafficPolicy?: EndpointTrafficPolicy;
1147
1271
  }
1148
1272
  export interface TLSEdgeUpdate {
1149
1273
  /** unique identifier of this edge */
@@ -1159,6 +1283,8 @@ export interface TLSEdgeUpdate {
1159
1283
  ipRestriction?: EndpointIPPolicyMutate;
1160
1284
  mutualTls?: EndpointMutualTLSMutate;
1161
1285
  tlsTermination?: EndpointTLSTermination;
1286
+ /** the traffic policy associated with this edge or null */
1287
+ trafficPolicy?: EndpointTrafficPolicy;
1162
1288
  }
1163
1289
  export interface TLSEdge {
1164
1290
  /** unique identifier of this edge */
@@ -1178,6 +1304,8 @@ export interface TLSEdge {
1178
1304
  ipRestriction?: EndpointIPPolicy;
1179
1305
  mutualTls?: EndpointMutualTLS;
1180
1306
  tlsTermination?: EndpointTLSTermination;
1307
+ /** the traffic policy associated with this edge or null */
1308
+ trafficPolicy?: EndpointTrafficPolicy;
1181
1309
  }
1182
1310
  export interface Endpoint {
1183
1311
  /** unique endpoint resource identifier */
@@ -1270,6 +1398,7 @@ export interface EventTarget {
1270
1398
  cloudwatchLogs?: EventTargetCloudwatchLogs;
1271
1399
  /** Configuration used to send events to Datadog. */
1272
1400
  datadog?: EventTargetDatadog;
1401
+ azureLogsIngestion?: EventTargetAzureLogsIngestion;
1273
1402
  }
1274
1403
  export interface EventTargetFirehose {
1275
1404
  /** Configuration for how to authenticate into your AWS account. Exactly one of `role` or `creds` should be configured. */
@@ -1299,6 +1428,20 @@ export interface EventTargetDatadog {
1299
1428
  /** Datadog site to send event to. */
1300
1429
  ddsite?: string;
1301
1430
  }
1431
+ export interface EventTargetAzureLogsIngestion {
1432
+ /** Tenant ID for the Azure account */
1433
+ tenantId: string;
1434
+ /** Client ID for the application client */
1435
+ clientId: string;
1436
+ /** Client Secret for the application client */
1437
+ clientSecret: string;
1438
+ /** Data collection endpoint logs ingestion URI */
1439
+ logsIngestionUri: string;
1440
+ /** Data collection rule immutable ID */
1441
+ dataCollectionRuleId: string;
1442
+ /** Data collection stream name to use as destination, located instide the DCR */
1443
+ dataCollectionStreamName: string;
1444
+ }
1302
1445
  export interface AWSAuth {
1303
1446
  /** A role for ngrok to assume on your behalf to deposit events into your AWS account. */
1304
1447
  role?: AWSRole;
@@ -1572,7 +1715,7 @@ export interface ReservedAddrList {
1572
1715
  export interface ReservedDomainCreate {
1573
1716
  /** hostname of the reserved domain */
1574
1717
  domain: string;
1575
- /** reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa) */
1718
+ /** deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa) */
1576
1719
  region: string;
1577
1720
  /** human-readable description of what this reserved domain will be used for */
1578
1721
  description?: string;
@@ -1607,9 +1750,9 @@ export interface ReservedDomain {
1607
1750
  metadata?: string;
1608
1751
  /** hostname of the reserved domain */
1609
1752
  domain: string;
1610
- /** reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa) */
1753
+ /** deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa) */
1611
1754
  region: string;
1612
- /** DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of *.ngrok.io */
1755
+ /** DNS CNAME target for a custom hostname, or null if the reserved domain is a subdomain of an ngrok owned domain (e.g. *.ngrok.app) */
1613
1756
  cnameTarget?: string;
1614
1757
  /** object referencing the TLS certificate used for connections to this domain. This can be either a user-uploaded certificate, the most recently issued automatic one, or null otherwise. */
1615
1758
  certificate?: Ref;