@ngrok/ngrok-api 0.9.0 → 0.11.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 (293) hide show
  1. package/.eslintignore +2 -0
  2. package/.eslintrc.js +2 -0
  3. package/.prettierrc.js +2 -0
  4. package/CHANGELOG.md +16 -3
  5. package/CODE_OF_CONDUCT.md +45 -0
  6. package/README.md +9 -3
  7. package/docs/assets/js/search.js +1 -1
  8. package/docs/classes/client.Ngrok.html +82 -28
  9. package/docs/classes/services.APIKeys.html +20 -11
  10. package/docs/classes/services.AbuseReports.html +5 -5
  11. package/docs/classes/services.AgentIngresses.html +20 -11
  12. package/docs/classes/services.ApplicationSessions.html +288 -0
  13. package/docs/classes/services.ApplicationUsers.html +288 -0
  14. package/docs/classes/services.BotUsers.html +352 -0
  15. package/docs/classes/services.CertificateAuthorities.html +20 -11
  16. package/docs/classes/services.Credentials.html +21 -12
  17. package/docs/classes/services.EdgeRouteBackendModule.html +4 -4
  18. package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +4 -4
  19. package/docs/classes/services.EdgeRouteCompressionModule.html +4 -4
  20. package/docs/classes/services.EdgeRouteIPRestrictionModule.html +4 -4
  21. package/docs/classes/services.EdgeRouteOAuthModule.html +4 -4
  22. package/docs/classes/services.EdgeRouteOIDCModule.html +4 -4
  23. package/docs/classes/services.EdgeRoutePolicyModule.html +270 -0
  24. package/docs/classes/services.EdgeRouteRequestHeadersModule.html +4 -4
  25. package/docs/classes/services.EdgeRouteResponseHeadersModule.html +4 -4
  26. package/docs/classes/services.EdgeRouteSAMLModule.html +4 -4
  27. package/docs/classes/services.EdgeRouteUserAgentFilterModule.html +270 -0
  28. package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +4 -4
  29. package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +4 -4
  30. package/docs/classes/services.EdgesHTTPS.html +20 -11
  31. package/docs/classes/services.EdgesHTTPSRoutes.html +5 -5
  32. package/docs/classes/services.EdgesTCP.html +20 -11
  33. package/docs/classes/services.EdgesTLS.html +20 -11
  34. package/docs/classes/services.Endpoints.html +15 -6
  35. package/docs/classes/services.EventDestinations.html +21 -12
  36. package/docs/classes/services.EventSources.html +6 -6
  37. package/docs/classes/services.EventSubscriptions.html +20 -11
  38. package/docs/classes/services.FailoverBackends.html +20 -11
  39. package/docs/classes/services.HTTPResponseBackends.html +20 -11
  40. package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +8 -8
  41. package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +8 -8
  42. package/docs/classes/services.IPPolicies.html +20 -11
  43. package/docs/classes/services.IPPolicyRules.html +20 -11
  44. package/docs/classes/services.IPRestrictions.html +20 -11
  45. package/docs/classes/services.ReservedAddrs.html +20 -11
  46. package/docs/classes/services.ReservedDomains.html +26 -17
  47. package/docs/classes/services.SSHCertificateAuthorities.html +20 -11
  48. package/docs/classes/services.SSHCredentials.html +20 -11
  49. package/docs/classes/services.SSHHostCertificates.html +20 -11
  50. package/docs/classes/services.SSHUserCertificates.html +20 -11
  51. package/docs/classes/services.StaticBackends.html +360 -0
  52. package/docs/classes/services.TCPEdgeBackendModule.html +8 -8
  53. package/docs/classes/services.TCPEdgeIPRestrictionModule.html +8 -8
  54. package/docs/classes/services.TCPEdgePolicyModule.html +270 -0
  55. package/docs/classes/services.TLSCertificates.html +20 -11
  56. package/docs/classes/services.TLSEdgeBackendModule.html +8 -8
  57. package/docs/classes/services.TLSEdgeIPRestrictionModule.html +8 -8
  58. package/docs/classes/services.TLSEdgeMutualTLSModule.html +8 -8
  59. package/docs/classes/services.TLSEdgePolicyModule.html +270 -0
  60. package/docs/classes/services.TLSEdgeTLSTerminationModule.html +8 -8
  61. package/docs/classes/services.TunnelGroupBackends.html +20 -11
  62. package/docs/classes/services.TunnelSessions.html +22 -13
  63. package/docs/classes/services.Tunnels.html +15 -6
  64. package/docs/classes/services.WeightedBackends.html +20 -11
  65. package/docs/index.html +8 -3
  66. package/docs/interfaces/client.NgrokConfig.html +3 -3
  67. package/docs/interfaces/datatypes.APIKey.html +28 -9
  68. package/docs/interfaces/datatypes.APIKeyCreate.html +23 -4
  69. package/docs/interfaces/datatypes.APIKeyList.html +3 -3
  70. package/docs/interfaces/datatypes.APIKeyUpdate.html +3 -3
  71. package/docs/interfaces/datatypes.AWSAuth.html +2 -2
  72. package/docs/interfaces/datatypes.AWSCredentials.html +2 -2
  73. package/docs/interfaces/datatypes.AWSRole.html +1 -1
  74. package/docs/interfaces/datatypes.AbuseReport.html +9 -9
  75. package/docs/interfaces/datatypes.AbuseReportCreate.html +3 -3
  76. package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
  77. package/docs/interfaces/datatypes.AgentIngress.html +49 -11
  78. package/docs/interfaces/datatypes.AgentIngressCertJob.html +224 -0
  79. package/docs/interfaces/datatypes.AgentIngressCertPolicy.html +186 -0
  80. package/docs/interfaces/datatypes.AgentIngressCertStatus.html +186 -0
  81. package/docs/interfaces/datatypes.AgentIngressCreate.html +24 -5
  82. package/docs/interfaces/datatypes.AgentIngressList.html +3 -3
  83. package/docs/interfaces/datatypes.AgentIngressUpdate.html +22 -3
  84. package/docs/interfaces/datatypes.ApplicationSession.html +357 -0
  85. package/docs/interfaces/datatypes.ApplicationSessionList.html +205 -0
  86. package/docs/interfaces/datatypes.ApplicationUser.html +338 -0
  87. package/docs/interfaces/datatypes.ApplicationUserList.html +205 -0
  88. package/docs/interfaces/datatypes.BotUser.html +243 -0
  89. package/docs/interfaces/datatypes.BotUserCreate.html +186 -0
  90. package/docs/interfaces/datatypes.BotUserList.html +205 -0
  91. package/docs/interfaces/datatypes.BotUserUpdate.html +200 -0
  92. package/docs/interfaces/datatypes.BrowserSession.html +205 -0
  93. package/docs/interfaces/datatypes.CertificateAuthority.html +16 -16
  94. package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +5 -5
  95. package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
  96. package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
  97. package/docs/interfaces/datatypes.Credential.html +30 -11
  98. package/docs/interfaces/datatypes.CredentialCreate.html +25 -6
  99. package/docs/interfaces/datatypes.CredentialList.html +3 -3
  100. package/docs/interfaces/datatypes.CredentialUpdate.html +5 -5
  101. package/docs/interfaces/datatypes.EdgeBackendReplace.html +2 -2
  102. package/docs/interfaces/datatypes.EdgeIPRestrictionReplace.html +2 -2
  103. package/docs/interfaces/datatypes.EdgeMutualTLSReplace.html +2 -2
  104. package/docs/interfaces/datatypes.EdgePolicyReplace.html +176 -0
  105. package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +3 -3
  106. package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +3 -3
  107. package/docs/interfaces/datatypes.EdgeRouteCompressionReplace.html +3 -3
  108. package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +3 -3
  109. package/docs/interfaces/datatypes.EdgeRouteItem.html +2 -2
  110. package/docs/interfaces/datatypes.EdgeRouteOAuthReplace.html +3 -3
  111. package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +3 -3
  112. package/docs/interfaces/datatypes.EdgeRoutePolicyReplace.html +190 -0
  113. package/docs/interfaces/datatypes.EdgeRouteRequestHeadersReplace.html +3 -3
  114. package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +3 -3
  115. package/docs/interfaces/datatypes.EdgeRouteSAMLReplace.html +3 -3
  116. package/docs/interfaces/datatypes.EdgeRouteUserAgentFilterReplace.html +190 -0
  117. package/docs/interfaces/datatypes.EdgeRouteWebhookVerificationReplace.html +3 -3
  118. package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +3 -3
  119. package/docs/interfaces/datatypes.EdgeTLSTerminationAtEdgeReplace.html +2 -2
  120. package/docs/interfaces/datatypes.EdgeTLSTerminationReplace.html +2 -2
  121. package/docs/interfaces/datatypes.Endpoint.html +19 -19
  122. package/docs/interfaces/datatypes.EndpointAction.html +186 -0
  123. package/docs/interfaces/datatypes.EndpointBackend.html +2 -2
  124. package/docs/interfaces/datatypes.EndpointBackendMutate.html +2 -2
  125. package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
  126. package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
  127. package/docs/interfaces/datatypes.EndpointIPPolicy.html +7 -2
  128. package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
  129. package/docs/interfaces/datatypes.EndpointList.html +3 -3
  130. package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
  131. package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +2 -2
  132. package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
  133. package/docs/interfaces/datatypes.EndpointOAuthAmazon.html +218 -0
  134. package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
  135. package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +12 -12
  136. package/docs/interfaces/datatypes.EndpointOAuthGitLab.html +218 -0
  137. package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
  138. package/docs/interfaces/datatypes.EndpointOAuthLinkedIn.html +218 -0
  139. package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
  140. package/docs/interfaces/datatypes.EndpointOAuthProvider.html +80 -4
  141. package/docs/interfaces/datatypes.EndpointOAuthTwitch.html +218 -0
  142. package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
  143. package/docs/interfaces/datatypes.EndpointPolicy.html +205 -0
  144. package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
  145. package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
  146. package/docs/interfaces/datatypes.EndpointRule.html +205 -0
  147. package/docs/interfaces/datatypes.EndpointSAML.html +15 -15
  148. package/docs/interfaces/datatypes.EndpointSAMLMutate.html +10 -10
  149. package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
  150. package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +2 -2
  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 +10 -10
  156. package/docs/interfaces/datatypes.EventDestinationCreate.html +6 -6
  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 +10 -10
  167. package/docs/interfaces/datatypes.EventSubscriptionCreate.html +6 -6
  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 +22 -3
  171. package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
  172. package/docs/interfaces/datatypes.EventTargetDatadog.html +224 -0
  173. package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
  174. package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
  175. package/docs/interfaces/datatypes.FailoverBackend.html +9 -9
  176. package/docs/interfaces/datatypes.FailoverBackendCreate.html +5 -5
  177. package/docs/interfaces/datatypes.FailoverBackendList.html +3 -3
  178. package/docs/interfaces/datatypes.FailoverBackendUpdate.html +4 -4
  179. package/docs/interfaces/datatypes.HTTPResponseBackend.html +11 -11
  180. package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +7 -7
  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 +12 -12
  184. package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +7 -7
  185. package/docs/interfaces/datatypes.HTTPSEdgeList.html +3 -3
  186. package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +55 -22
  187. package/docs/interfaces/datatypes.HTTPSEdgeRouteCreate.html +51 -18
  188. package/docs/interfaces/datatypes.HTTPSEdgeRouteUpdate.html +52 -19
  189. package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +6 -6
  190. package/docs/interfaces/datatypes.IPPolicy.html +8 -8
  191. package/docs/interfaces/datatypes.IPPolicyCreate.html +4 -4
  192. package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
  193. package/docs/interfaces/datatypes.IPPolicyRule.html +11 -11
  194. package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +7 -7
  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 +11 -11
  199. package/docs/interfaces/datatypes.IPRestrictionCreate.html +7 -7
  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 +186 -0
  203. package/docs/interfaces/datatypes.Item.html +1 -1
  204. package/docs/interfaces/datatypes.Location.html +224 -0
  205. package/docs/interfaces/datatypes.Paging.html +2 -2
  206. package/docs/interfaces/datatypes.Ref.html +2 -2
  207. package/docs/interfaces/datatypes.ReservedAddr.html +10 -10
  208. package/docs/interfaces/datatypes.ReservedAddrCreate.html +5 -5
  209. package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
  210. package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -3
  211. package/docs/interfaces/datatypes.ReservedDomain.html +17 -17
  212. package/docs/interfaces/datatypes.ReservedDomainCertJob.html +6 -6
  213. package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
  214. package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +3 -3
  215. package/docs/interfaces/datatypes.ReservedDomainCreate.html +19 -19
  216. package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
  217. package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -5
  218. package/docs/interfaces/datatypes.SSHCertificateAuthority.html +10 -10
  219. package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +7 -7
  220. package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
  221. package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
  222. package/docs/interfaces/datatypes.SSHCredential.html +30 -11
  223. package/docs/interfaces/datatypes.SSHCredentialCreate.html +26 -7
  224. package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
  225. package/docs/interfaces/datatypes.SSHCredentialUpdate.html +5 -5
  226. package/docs/interfaces/datatypes.SSHHostCertificate.html +17 -17
  227. package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +11 -11
  228. package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
  229. package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
  230. package/docs/interfaces/datatypes.SSHUserCertificate.html +19 -19
  231. package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +13 -13
  232. package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
  233. package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
  234. package/docs/interfaces/datatypes.StaticBackend.html +281 -0
  235. package/docs/interfaces/datatypes.StaticBackendCreate.html +224 -0
  236. package/docs/interfaces/datatypes.StaticBackendList.html +205 -0
  237. package/docs/interfaces/datatypes.StaticBackendTLS.html +167 -0
  238. package/docs/interfaces/datatypes.StaticBackendUpdate.html +238 -0
  239. package/docs/interfaces/datatypes.TCPEdge.html +30 -11
  240. package/docs/interfaces/datatypes.TCPEdgeCreate.html +26 -7
  241. package/docs/interfaces/datatypes.TCPEdgeList.html +3 -3
  242. package/docs/interfaces/datatypes.TCPEdgeUpdate.html +25 -6
  243. package/docs/interfaces/datatypes.TLSCertificate.html +28 -28
  244. package/docs/interfaces/datatypes.TLSCertificateCreate.html +8 -8
  245. package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
  246. package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
  247. package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
  248. package/docs/interfaces/datatypes.TLSEdge.html +32 -13
  249. package/docs/interfaces/datatypes.TLSEdgeCreate.html +28 -9
  250. package/docs/interfaces/datatypes.TLSEdgeList.html +3 -3
  251. package/docs/interfaces/datatypes.TLSEdgeUpdate.html +27 -8
  252. package/docs/interfaces/datatypes.Tunnel.html +17 -17
  253. package/docs/interfaces/datatypes.TunnelGroupBackend.html +10 -10
  254. package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +5 -5
  255. package/docs/interfaces/datatypes.TunnelGroupBackendList.html +3 -3
  256. package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +4 -4
  257. package/docs/interfaces/datatypes.TunnelList.html +3 -3
  258. package/docs/interfaces/datatypes.TunnelSession.html +12 -12
  259. package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
  260. package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
  261. package/docs/interfaces/datatypes.UserAgent.html +262 -0
  262. package/docs/interfaces/datatypes.WeightedBackend.html +9 -9
  263. package/docs/interfaces/datatypes.WeightedBackendCreate.html +5 -5
  264. package/docs/interfaces/datatypes.WeightedBackendList.html +3 -3
  265. package/docs/interfaces/datatypes.WeightedBackendUpdate.html +4 -4
  266. package/docs/modules/datatypes.html +128 -0
  267. package/docs/modules/services.html +32 -0
  268. package/jest.config.js +2 -0
  269. package/lib/client.d.ts +17 -8
  270. package/lib/client.d.ts.map +1 -1
  271. package/lib/client.js +92 -119
  272. package/lib/client.js.map +1 -1
  273. package/lib/datatypes.d.ts +539 -204
  274. package/lib/datatypes.d.ts.map +1 -1
  275. package/lib/datatypes.js +4 -3
  276. package/lib/datatypes.js.map +1 -1
  277. package/lib/index.d.ts.map +1 -1
  278. package/lib/index.js +16 -28
  279. package/lib/index.js.map +1 -1
  280. package/lib/services.d.ts +254 -126
  281. package/lib/services.d.ts.map +1 -1
  282. package/lib/services.js +3613 -3356
  283. package/lib/services.js.map +1 -1
  284. package/lib/util.d.ts.map +1 -1
  285. package/lib/util.js +35 -34
  286. package/lib/util.js.map +1 -1
  287. package/package.json +4 -3
  288. package/src/client.ts +28 -33
  289. package/src/datatypes.ts +576 -207
  290. package/src/index.ts +2 -0
  291. package/src/services.ts +1136 -553
  292. package/src/util.ts +2 -0
  293. package/test/apikey.test.js +62 -63
@@ -95,9 +95,11 @@
95
95
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#metadata" class="tsd-kind-icon">metadata</a></li>
96
96
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#oauth" class="tsd-kind-icon">oauth</a></li>
97
97
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#oidc" class="tsd-kind-icon">oidc</a></li>
98
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#policy" class="tsd-kind-icon">policy</a></li>
98
99
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#requestHeaders" class="tsd-kind-icon">request<wbr>Headers</a></li>
99
100
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#responseHeaders" class="tsd-kind-icon">response<wbr>Headers</a></li>
100
101
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#saml" class="tsd-kind-icon">saml</a></li>
102
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#userAgentFilter" class="tsd-kind-icon">user<wbr>Agent<wbr>Filter</a></li>
101
103
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#webhookVerification" class="tsd-kind-icon">webhook<wbr>Verification</a></li>
102
104
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.HTTPSEdgeRouteUpdate.html#websocketTcpConverter" class="tsd-kind-icon">websocket<wbr>Tcp<wbr>Converter</a></li>
103
105
  </ul>
@@ -113,7 +115,7 @@
113
115
  <div class="tsd-signature tsd-kind-icon">backend<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointBackendMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointBackendMutate</a></div>
114
116
  <aside class="tsd-sources">
115
117
  <ul>
116
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L746">datatypes.ts:746</a></li>
118
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1099">datatypes.ts:1099</a></li>
117
119
  </ul>
118
120
  </aside>
119
121
  <div class="tsd-comment tsd-typography">
@@ -128,7 +130,7 @@
128
130
  <div class="tsd-signature tsd-kind-icon">circuit<wbr>Breaker<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointCircuitBreaker.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointCircuitBreaker</a></div>
129
131
  <aside class="tsd-sources">
130
132
  <ul>
131
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L750">datatypes.ts:750</a></li>
133
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1103">datatypes.ts:1103</a></li>
132
134
  </ul>
133
135
  </aside>
134
136
  <div class="tsd-comment tsd-typography">
@@ -143,7 +145,7 @@
143
145
  <div class="tsd-signature tsd-kind-icon">compression<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointCompression.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointCompression</a></div>
144
146
  <aside class="tsd-sources">
145
147
  <ul>
146
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L752">datatypes.ts:752</a></li>
148
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1105">datatypes.ts:1105</a></li>
147
149
  </ul>
148
150
  </aside>
149
151
  <div class="tsd-comment tsd-typography">
@@ -154,11 +156,11 @@
154
156
  </section>
155
157
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
156
158
  <a name="description" class="tsd-anchor"></a>
157
- <h3>description</h3>
159
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
158
160
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
159
161
  <aside class="tsd-sources">
160
162
  <ul>
161
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L742">datatypes.ts:742</a></li>
163
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1095">datatypes.ts:1095</a></li>
162
164
  </ul>
163
165
  </aside>
164
166
  <div class="tsd-comment tsd-typography">
@@ -173,7 +175,7 @@
173
175
  <div class="tsd-signature tsd-kind-icon">edge<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
174
176
  <aside class="tsd-sources">
175
177
  <ul>
176
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L734">datatypes.ts:734</a></li>
178
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1087">datatypes.ts:1087</a></li>
177
179
  </ul>
178
180
  </aside>
179
181
  <div class="tsd-comment tsd-typography">
@@ -188,7 +190,7 @@
188
190
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
189
191
  <aside class="tsd-sources">
190
192
  <ul>
191
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L736">datatypes.ts:736</a></li>
193
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1089">datatypes.ts:1089</a></li>
192
194
  </ul>
193
195
  </aside>
194
196
  <div class="tsd-comment tsd-typography">
@@ -203,7 +205,7 @@
203
205
  <div class="tsd-signature tsd-kind-icon">ip<wbr>Restriction<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointIPPolicyMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicyMutate</a></div>
204
206
  <aside class="tsd-sources">
205
207
  <ul>
206
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L748">datatypes.ts:748</a></li>
208
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1101">datatypes.ts:1101</a></li>
207
209
  </ul>
208
210
  </aside>
209
211
  <div class="tsd-comment tsd-typography">
@@ -218,7 +220,7 @@
218
220
  <div class="tsd-signature tsd-kind-icon">match<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
219
221
  <aside class="tsd-sources">
220
222
  <ul>
221
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L740">datatypes.ts:740</a></li>
223
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1093">datatypes.ts:1093</a></li>
222
224
  </ul>
223
225
  </aside>
224
226
  <div class="tsd-comment tsd-typography">
@@ -233,7 +235,7 @@
233
235
  <div class="tsd-signature tsd-kind-icon">match<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
234
236
  <aside class="tsd-sources">
235
237
  <ul>
236
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L738">datatypes.ts:738</a></li>
238
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1091">datatypes.ts:1091</a></li>
237
239
  </ul>
238
240
  </aside>
239
241
  <div class="tsd-comment tsd-typography">
@@ -244,11 +246,11 @@
244
246
  </section>
245
247
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
246
248
  <a name="metadata" class="tsd-anchor"></a>
247
- <h3>metadata</h3>
249
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
248
250
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
249
251
  <aside class="tsd-sources">
250
252
  <ul>
251
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L744">datatypes.ts:744</a></li>
253
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1097">datatypes.ts:1097</a></li>
252
254
  </ul>
253
255
  </aside>
254
256
  <div class="tsd-comment tsd-typography">
@@ -263,7 +265,7 @@
263
265
  <div class="tsd-signature tsd-kind-icon">oauth<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuth.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuth</a></div>
264
266
  <aside class="tsd-sources">
265
267
  <ul>
266
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L760">datatypes.ts:760</a></li>
268
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1113">datatypes.ts:1113</a></li>
267
269
  </ul>
268
270
  </aside>
269
271
  <div class="tsd-comment tsd-typography">
@@ -278,7 +280,7 @@
278
280
  <div class="tsd-signature tsd-kind-icon">oidc<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOIDC.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOIDC</a></div>
279
281
  <aside class="tsd-sources">
280
282
  <ul>
281
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L764">datatypes.ts:764</a></li>
283
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1117">datatypes.ts:1117</a></li>
282
284
  </ul>
283
285
  </aside>
284
286
  <div class="tsd-comment tsd-typography">
@@ -287,13 +289,28 @@
287
289
  </div>
288
290
  </div>
289
291
  </section>
292
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
293
+ <a name="policy" class="tsd-anchor"></a>
294
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> policy</h3>
295
+ <div class="tsd-signature tsd-kind-icon">policy<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointPolicy</a></div>
296
+ <aside class="tsd-sources">
297
+ <ul>
298
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1122">datatypes.ts:1122</a></li>
299
+ </ul>
300
+ </aside>
301
+ <div class="tsd-comment tsd-typography">
302
+ <div class="lead">
303
+ <p>the traffic policy associated with this edge or null</p>
304
+ </div>
305
+ </div>
306
+ </section>
290
307
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
291
308
  <a name="requestHeaders" class="tsd-anchor"></a>
292
309
  <h3><span class="tsd-flag ts-flagOptional">Optional</span> request<wbr>Headers</h3>
293
310
  <div class="tsd-signature tsd-kind-icon">request<wbr>Headers<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointRequestHeaders.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointRequestHeaders</a></div>
294
311
  <aside class="tsd-sources">
295
312
  <ul>
296
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L754">datatypes.ts:754</a></li>
313
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1107">datatypes.ts:1107</a></li>
297
314
  </ul>
298
315
  </aside>
299
316
  <div class="tsd-comment tsd-typography">
@@ -308,7 +325,7 @@
308
325
  <div class="tsd-signature tsd-kind-icon">response<wbr>Headers<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointResponseHeaders.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointResponseHeaders</a></div>
309
326
  <aside class="tsd-sources">
310
327
  <ul>
311
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L756">datatypes.ts:756</a></li>
328
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1109">datatypes.ts:1109</a></li>
312
329
  </ul>
313
330
  </aside>
314
331
  <div class="tsd-comment tsd-typography">
@@ -323,7 +340,7 @@
323
340
  <div class="tsd-signature tsd-kind-icon">saml<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointSAMLMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointSAMLMutate</a></div>
324
341
  <aside class="tsd-sources">
325
342
  <ul>
326
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L762">datatypes.ts:762</a></li>
343
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1115">datatypes.ts:1115</a></li>
327
344
  </ul>
328
345
  </aside>
329
346
  <div class="tsd-comment tsd-typography">
@@ -332,13 +349,23 @@
332
349
  </div>
333
350
  </div>
334
351
  </section>
352
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
353
+ <a name="userAgentFilter" class="tsd-anchor"></a>
354
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> user<wbr>Agent<wbr>Filter</h3>
355
+ <div class="tsd-signature tsd-kind-icon">user<wbr>Agent<wbr>Filter<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointUserAgentFilter.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointUserAgentFilter</a></div>
356
+ <aside class="tsd-sources">
357
+ <ul>
358
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1120">datatypes.ts:1120</a></li>
359
+ </ul>
360
+ </aside>
361
+ </section>
335
362
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
336
363
  <a name="webhookVerification" class="tsd-anchor"></a>
337
364
  <h3><span class="tsd-flag ts-flagOptional">Optional</span> webhook<wbr>Verification</h3>
338
365
  <div class="tsd-signature tsd-kind-icon">webhook<wbr>Verification<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointWebhookValidation.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointWebhookValidation</a></div>
339
366
  <aside class="tsd-sources">
340
367
  <ul>
341
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L758">datatypes.ts:758</a></li>
368
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1111">datatypes.ts:1111</a></li>
342
369
  </ul>
343
370
  </aside>
344
371
  <div class="tsd-comment tsd-typography">
@@ -353,7 +380,7 @@
353
380
  <div class="tsd-signature tsd-kind-icon">websocket<wbr>Tcp<wbr>Converter<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointWebsocketTCPConverter.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointWebsocketTCPConverter</a></div>
354
381
  <aside class="tsd-sources">
355
382
  <ul>
356
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L766">datatypes.ts:766</a></li>
383
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1119">datatypes.ts:1119</a></li>
357
384
  </ul>
358
385
  </aside>
359
386
  <div class="tsd-comment tsd-typography">
@@ -424,6 +451,9 @@
424
451
  <li class=" tsd-kind-property tsd-parent-kind-interface">
425
452
  <a href="datatypes.HTTPSEdgeRouteUpdate.html#oidc" class="tsd-kind-icon">oidc</a>
426
453
  </li>
454
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
455
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#policy" class="tsd-kind-icon">policy</a>
456
+ </li>
427
457
  <li class=" tsd-kind-property tsd-parent-kind-interface">
428
458
  <a href="datatypes.HTTPSEdgeRouteUpdate.html#requestHeaders" class="tsd-kind-icon">request<wbr>Headers</a>
429
459
  </li>
@@ -433,6 +463,9 @@
433
463
  <li class=" tsd-kind-property tsd-parent-kind-interface">
434
464
  <a href="datatypes.HTTPSEdgeRouteUpdate.html#saml" class="tsd-kind-icon">saml</a>
435
465
  </li>
466
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
467
+ <a href="datatypes.HTTPSEdgeRouteUpdate.html#userAgentFilter" class="tsd-kind-icon">user<wbr>Agent<wbr>Filter</a>
468
+ </li>
436
469
  <li class=" tsd-kind-property tsd-parent-kind-interface">
437
470
  <a href="datatypes.HTTPSEdgeRouteUpdate.html#webhookVerification" class="tsd-kind-icon">webhook<wbr>Verification</a>
438
471
  </li>
@@ -102,7 +102,7 @@
102
102
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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/0593d03/src/datatypes.ts#L835">datatypes.ts:835</a></li>
105
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1194">datatypes.ts:1194</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">hostports<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</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/0593d03/src/datatypes.ts#L839">datatypes.ts:839</a></li>
120
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1198">datatypes.ts:1198</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">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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/0593d03/src/datatypes.ts#L833">datatypes.ts:833</a></li>
135
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1192">datatypes.ts:1192</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">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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/0593d03/src/datatypes.ts#L837">datatypes.ts:837</a></li>
150
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1196">datatypes.ts:1196</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">mutual<wbr>Tls<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointMutualTLSMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointMutualTLSMutate</a></div>
163
163
  <aside class="tsd-sources">
164
164
  <ul>
165
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L841">datatypes.ts:841</a></li>
165
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1200">datatypes.ts:1200</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">tls<wbr>Termination<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointTLSTerminationAtEdge.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTLSTerminationAtEdge</a></div>
178
178
  <aside class="tsd-sources">
179
179
  <ul>
180
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L842">datatypes.ts:842</a></li>
180
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1201">datatypes.ts:1201</a></li>
181
181
  </ul>
182
182
  </aside>
183
183
  </section>
@@ -98,10 +98,10 @@
98
98
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
99
99
  <a name="createdAt" class="tsd-anchor"></a>
100
100
  <h3>created<wbr>At</h3>
101
- <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
101
+ <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
102
102
  <aside class="tsd-sources">
103
103
  <ul>
104
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1323">datatypes.ts:1323</a></li>
104
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1724">datatypes.ts:1724</a></li>
105
105
  </ul>
106
106
  </aside>
107
107
  <div class="tsd-comment tsd-typography">
@@ -112,11 +112,11 @@
112
112
  </section>
113
113
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
114
114
  <a name="description" class="tsd-anchor"></a>
115
- <h3>description</h3>
115
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
116
116
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
117
117
  <aside class="tsd-sources">
118
118
  <ul>
119
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1325">datatypes.ts:1325</a></li>
119
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1726">datatypes.ts:1726</a></li>
120
120
  </ul>
121
121
  </aside>
122
122
  <div class="tsd-comment tsd-typography">
@@ -131,7 +131,7 @@
131
131
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
132
132
  <aside class="tsd-sources">
133
133
  <ul>
134
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1319">datatypes.ts:1319</a></li>
134
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1720">datatypes.ts:1720</a></li>
135
135
  </ul>
136
136
  </aside>
137
137
  <div class="tsd-comment tsd-typography">
@@ -142,11 +142,11 @@
142
142
  </section>
143
143
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
144
144
  <a name="metadata" class="tsd-anchor"></a>
145
- <h3>metadata</h3>
145
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
146
146
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
147
147
  <aside class="tsd-sources">
148
148
  <ul>
149
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1327">datatypes.ts:1327</a></li>
149
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1728">datatypes.ts:1728</a></li>
150
150
  </ul>
151
151
  </aside>
152
152
  <div class="tsd-comment tsd-typography">
@@ -161,7 +161,7 @@
161
161
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
162
162
  <aside class="tsd-sources">
163
163
  <ul>
164
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1321">datatypes.ts:1321</a></li>
164
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1722">datatypes.ts:1722</a></li>
165
165
  </ul>
166
166
  </aside>
167
167
  <div class="tsd-comment tsd-typography">
@@ -94,11 +94,11 @@
94
94
  <h2>Properties</h2>
95
95
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
96
96
  <a name="description" class="tsd-anchor"></a>
97
- <h3>description</h3>
97
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
98
98
  <div class="tsd-signature tsd-kind-icon">description<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/0593d03/src/datatypes.ts#L1304">datatypes.ts:1304</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1705">datatypes.ts:1705</a></li>
102
102
  </ul>
103
103
  </aside>
104
104
  <div class="tsd-comment tsd-typography">
@@ -109,11 +109,11 @@
109
109
  </section>
110
110
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
111
111
  <a name="metadata" class="tsd-anchor"></a>
112
- <h3>metadata</h3>
112
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
113
113
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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/0593d03/src/datatypes.ts#L1306">datatypes.ts:1306</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1707">datatypes.ts:1707</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">ip<wbr>Policies<span class="tsd-signature-symbol">:</span> <a href="datatypes.IPPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">IPPolicy</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/0593d03/src/datatypes.ts#L1332">datatypes.ts:1332</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1733">datatypes.ts:1733</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/0593d03/src/datatypes.ts#L1336">datatypes.ts:1336</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1737">datatypes.ts:1737</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/0593d03/src/datatypes.ts#L1334">datatypes.ts:1334</a></li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1735">datatypes.ts:1735</a></li>
133
133
  </ul>
134
134
  </aside>
135
135
  <div class="tsd-comment tsd-typography">
@@ -104,7 +104,7 @@
104
104
  <div class="tsd-signature tsd-kind-icon">action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
105
105
  <aside class="tsd-sources">
106
106
  <ul>
107
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1378">datatypes.ts:1378</a></li>
107
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1779">datatypes.ts:1779</a></li>
108
108
  </ul>
109
109
  </aside>
110
110
  <div class="tsd-comment tsd-typography">
@@ -119,7 +119,7 @@
119
119
  <div class="tsd-signature tsd-kind-icon">cidr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
120
120
  <aside class="tsd-sources">
121
121
  <ul>
122
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1374">datatypes.ts:1374</a></li>
122
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1775">datatypes.ts:1775</a></li>
123
123
  </ul>
124
124
  </aside>
125
125
  <div class="tsd-comment tsd-typography">
@@ -131,10 +131,10 @@
131
131
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
132
132
  <a name="createdAt" class="tsd-anchor"></a>
133
133
  <h3>created<wbr>At</h3>
134
- <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
134
+ <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
135
135
  <aside class="tsd-sources">
136
136
  <ul>
137
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1368">datatypes.ts:1368</a></li>
137
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1769">datatypes.ts:1769</a></li>
138
138
  </ul>
139
139
  </aside>
140
140
  <div class="tsd-comment tsd-typography">
@@ -145,11 +145,11 @@
145
145
  </section>
146
146
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
147
147
  <a name="description" class="tsd-anchor"></a>
148
- <h3>description</h3>
148
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
149
149
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
150
150
  <aside class="tsd-sources">
151
151
  <ul>
152
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1370">datatypes.ts:1370</a></li>
152
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1771">datatypes.ts:1771</a></li>
153
153
  </ul>
154
154
  </aside>
155
155
  <div class="tsd-comment tsd-typography">
@@ -164,7 +164,7 @@
164
164
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
165
165
  <aside class="tsd-sources">
166
166
  <ul>
167
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1364">datatypes.ts:1364</a></li>
167
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1765">datatypes.ts:1765</a></li>
168
168
  </ul>
169
169
  </aside>
170
170
  <div class="tsd-comment tsd-typography">
@@ -179,7 +179,7 @@
179
179
  <div class="tsd-signature tsd-kind-icon">ip<wbr>Policy<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
180
180
  <aside class="tsd-sources">
181
181
  <ul>
182
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1376">datatypes.ts:1376</a></li>
182
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1777">datatypes.ts:1777</a></li>
183
183
  </ul>
184
184
  </aside>
185
185
  <div class="tsd-comment tsd-typography">
@@ -190,11 +190,11 @@
190
190
  </section>
191
191
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
192
192
  <a name="metadata" class="tsd-anchor"></a>
193
- <h3>metadata</h3>
193
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
194
194
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
195
195
  <aside class="tsd-sources">
196
196
  <ul>
197
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1372">datatypes.ts:1372</a></li>
197
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1773">datatypes.ts:1773</a></li>
198
198
  </ul>
199
199
  </aside>
200
200
  <div class="tsd-comment tsd-typography">
@@ -209,7 +209,7 @@
209
209
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
210
210
  <aside class="tsd-sources">
211
211
  <ul>
212
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1366">datatypes.ts:1366</a></li>
212
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1767">datatypes.ts:1767</a></li>
213
213
  </ul>
214
214
  </aside>
215
215
  <div class="tsd-comment tsd-typography">
@@ -101,7 +101,7 @@
101
101
  <div class="tsd-signature tsd-kind-icon">action<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
102
102
  <aside class="tsd-sources">
103
103
  <ul>
104
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1349">datatypes.ts:1349</a></li>
104
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1750">datatypes.ts:1750</a></li>
105
105
  </ul>
106
106
  </aside>
107
107
  <div class="tsd-comment tsd-typography">
@@ -116,7 +116,7 @@
116
116
  <div class="tsd-signature tsd-kind-icon">cidr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
117
117
  <aside class="tsd-sources">
118
118
  <ul>
119
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1345">datatypes.ts:1345</a></li>
119
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1746">datatypes.ts:1746</a></li>
120
120
  </ul>
121
121
  </aside>
122
122
  <div class="tsd-comment tsd-typography">
@@ -127,11 +127,11 @@
127
127
  </section>
128
128
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
129
129
  <a name="description" class="tsd-anchor"></a>
130
- <h3>description</h3>
130
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
131
131
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
132
132
  <aside class="tsd-sources">
133
133
  <ul>
134
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1341">datatypes.ts:1341</a></li>
134
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1742">datatypes.ts:1742</a></li>
135
135
  </ul>
136
136
  </aside>
137
137
  <div class="tsd-comment tsd-typography">
@@ -146,7 +146,7 @@
146
146
  <div class="tsd-signature tsd-kind-icon">ip<wbr>Policy<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
147
147
  <aside class="tsd-sources">
148
148
  <ul>
149
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1347">datatypes.ts:1347</a></li>
149
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1748">datatypes.ts:1748</a></li>
150
150
  </ul>
151
151
  </aside>
152
152
  <div class="tsd-comment tsd-typography">
@@ -157,11 +157,11 @@
157
157
  </section>
158
158
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
159
159
  <a name="metadata" class="tsd-anchor"></a>
160
- <h3>metadata</h3>
160
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
161
161
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
162
162
  <aside class="tsd-sources">
163
163
  <ul>
164
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1343">datatypes.ts:1343</a></li>
164
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1744">datatypes.ts:1744</a></li>
165
165
  </ul>
166
166
  </aside>
167
167
  <div class="tsd-comment tsd-typography">
@@ -99,7 +99,7 @@
99
99
  <div class="tsd-signature tsd-kind-icon">ip<wbr>Policy<wbr>Rules<span class="tsd-signature-symbol">:</span> <a href="datatypes.IPPolicyRule.html" class="tsd-signature-type" data-tsd-kind="Interface">IPPolicyRule</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/0593d03/src/datatypes.ts#L1383">datatypes.ts:1383</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1784">datatypes.ts:1784</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/0593d03/src/datatypes.ts#L1387">datatypes.ts:1387</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1788">datatypes.ts:1788</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/0593d03/src/datatypes.ts#L1385">datatypes.ts:1385</a></li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1786">datatypes.ts:1786</a></li>
133
133
  </ul>
134
134
  </aside>
135
135
  <div class="tsd-comment tsd-typography">