@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
@@ -117,22 +117,22 @@
117
117
  <div class="tsd-signature tsd-kind-icon">certificate<wbr>Pem<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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#L1829">datatypes.ts:1829</a></li>
120
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2234">datatypes.ts:2234</a></li>
121
121
  </ul>
122
122
  </aside>
123
123
  <div class="tsd-comment tsd-typography">
124
124
  <div class="lead">
125
- <p>chain of PEM-encoded certificates, leaf first. See <a href="https://ngrok.com/docs/api#tls-certificates-pem">Certificate Bundles</a>.</p>
125
+ <p>chain of PEM-encoded certificates, leaf first. See <a href="https://ngrok.com/docs/cloud-edge/endpoints#certificate-chains">Certificate Bundles</a>.</p>
126
126
  </div>
127
127
  </div>
128
128
  </section>
129
129
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
130
130
  <a name="createdAt" class="tsd-anchor"></a>
131
131
  <h3>created<wbr>At</h3>
132
- <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
132
+ <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</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#L1823">datatypes.ts:1823</a></li>
135
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2228">datatypes.ts:2228</a></li>
136
136
  </ul>
137
137
  </aside>
138
138
  <div class="tsd-comment tsd-typography">
@@ -143,11 +143,11 @@
143
143
  </section>
144
144
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
145
145
  <a name="description" class="tsd-anchor"></a>
146
- <h3>description</h3>
146
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
147
147
  <div class="tsd-signature tsd-kind-icon">description<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#L1825">datatypes.ts:1825</a></li>
150
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2230">datatypes.ts:2230</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">extended<wbr>Key<wbr>Usages<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
163
163
  <aside class="tsd-sources">
164
164
  <ul>
165
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1843">datatypes.ts:1843</a></li>
165
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2248">datatypes.ts:2248</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">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
178
178
  <aside class="tsd-sources">
179
179
  <ul>
180
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1819">datatypes.ts:1819</a></li>
180
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2224">datatypes.ts:2224</a></li>
181
181
  </ul>
182
182
  </aside>
183
183
  <div class="tsd-comment tsd-typography">
@@ -189,10 +189,10 @@
189
189
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
190
190
  <a name="issuedAt" class="tsd-anchor"></a>
191
191
  <h3><span class="tsd-flag ts-flagOptional">Optional</span> issued<wbr>At</h3>
192
- <div class="tsd-signature tsd-kind-icon">issued<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
192
+ <div class="tsd-signature tsd-kind-icon">issued<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
193
193
  <aside class="tsd-sources">
194
194
  <ul>
195
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1835">datatypes.ts:1835</a></li>
195
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2240">datatypes.ts:2240</a></li>
196
196
  </ul>
197
197
  </aside>
198
198
  <div class="tsd-comment tsd-typography">
@@ -207,7 +207,7 @@
207
207
  <div class="tsd-signature tsd-kind-icon">issuer<wbr>Common<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
208
208
  <aside class="tsd-sources">
209
209
  <ul>
210
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1847">datatypes.ts:1847</a></li>
210
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2252">datatypes.ts:2252</a></li>
211
211
  </ul>
212
212
  </aside>
213
213
  <div class="tsd-comment tsd-typography">
@@ -222,7 +222,7 @@
222
222
  <div class="tsd-signature tsd-kind-icon">key<wbr>Usages<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
223
223
  <aside class="tsd-sources">
224
224
  <ul>
225
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1841">datatypes.ts:1841</a></li>
225
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2246">datatypes.ts:2246</a></li>
226
226
  </ul>
227
227
  </aside>
228
228
  <div class="tsd-comment tsd-typography">
@@ -233,11 +233,11 @@
233
233
  </section>
234
234
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
235
235
  <a name="metadata" class="tsd-anchor"></a>
236
- <h3>metadata</h3>
236
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
237
237
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
238
238
  <aside class="tsd-sources">
239
239
  <ul>
240
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1827">datatypes.ts:1827</a></li>
240
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2232">datatypes.ts:2232</a></li>
241
241
  </ul>
242
242
  </aside>
243
243
  <div class="tsd-comment tsd-typography">
@@ -249,10 +249,10 @@
249
249
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
250
250
  <a name="notAfter" class="tsd-anchor"></a>
251
251
  <h3>not<wbr>After</h3>
252
- <div class="tsd-signature tsd-kind-icon">not<wbr>After<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
252
+ <div class="tsd-signature tsd-kind-icon">not<wbr>After<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
253
253
  <aside class="tsd-sources">
254
254
  <ul>
255
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1839">datatypes.ts:1839</a></li>
255
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2244">datatypes.ts:2244</a></li>
256
256
  </ul>
257
257
  </aside>
258
258
  <div class="tsd-comment tsd-typography">
@@ -264,10 +264,10 @@
264
264
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
265
265
  <a name="notBefore" class="tsd-anchor"></a>
266
266
  <h3>not<wbr>Before</h3>
267
- <div class="tsd-signature tsd-kind-icon">not<wbr>Before<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
267
+ <div class="tsd-signature tsd-kind-icon">not<wbr>Before<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
268
268
  <aside class="tsd-sources">
269
269
  <ul>
270
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1837">datatypes.ts:1837</a></li>
270
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2242">datatypes.ts:2242</a></li>
271
271
  </ul>
272
272
  </aside>
273
273
  <div class="tsd-comment tsd-typography">
@@ -282,7 +282,7 @@
282
282
  <div class="tsd-signature tsd-kind-icon">private<wbr>Key<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
283
283
  <aside class="tsd-sources">
284
284
  <ul>
285
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1845">datatypes.ts:1845</a></li>
285
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2250">datatypes.ts:2250</a></li>
286
286
  </ul>
287
287
  </aside>
288
288
  <div class="tsd-comment tsd-typography">
@@ -297,7 +297,7 @@
297
297
  <div class="tsd-signature tsd-kind-icon">serial<wbr>Number<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
298
298
  <aside class="tsd-sources">
299
299
  <ul>
300
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1849">datatypes.ts:1849</a></li>
300
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2254">datatypes.ts:2254</a></li>
301
301
  </ul>
302
302
  </aside>
303
303
  <div class="tsd-comment tsd-typography">
@@ -312,7 +312,7 @@
312
312
  <div class="tsd-signature tsd-kind-icon">subject<wbr>Alternative<wbr>Names<span class="tsd-signature-symbol">:</span> <a href="datatypes.TLSCertificateSANs.html" class="tsd-signature-type" data-tsd-kind="Interface">TLSCertificateSANs</a></div>
313
313
  <aside class="tsd-sources">
314
314
  <ul>
315
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1833">datatypes.ts:1833</a></li>
315
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2238">datatypes.ts:2238</a></li>
316
316
  </ul>
317
317
  </aside>
318
318
  <div class="tsd-comment tsd-typography">
@@ -327,7 +327,7 @@
327
327
  <div class="tsd-signature tsd-kind-icon">subject<wbr>Common<wbr>Name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
328
328
  <aside class="tsd-sources">
329
329
  <ul>
330
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1831">datatypes.ts:1831</a></li>
330
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2236">datatypes.ts:2236</a></li>
331
331
  </ul>
332
332
  </aside>
333
333
  <div class="tsd-comment tsd-typography">
@@ -342,7 +342,7 @@
342
342
  <div class="tsd-signature tsd-kind-icon">subject<wbr>Country<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
343
343
  <aside class="tsd-sources">
344
344
  <ul>
345
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1859">datatypes.ts:1859</a></li>
345
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2264">datatypes.ts:2264</a></li>
346
346
  </ul>
347
347
  </aside>
348
348
  <div class="tsd-comment tsd-typography">
@@ -357,7 +357,7 @@
357
357
  <div class="tsd-signature tsd-kind-icon">subject<wbr>Locality<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
358
358
  <aside class="tsd-sources">
359
359
  <ul>
360
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1855">datatypes.ts:1855</a></li>
360
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2260">datatypes.ts:2260</a></li>
361
361
  </ul>
362
362
  </aside>
363
363
  <div class="tsd-comment tsd-typography">
@@ -372,7 +372,7 @@
372
372
  <div class="tsd-signature tsd-kind-icon">subject<wbr>Organization<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
373
373
  <aside class="tsd-sources">
374
374
  <ul>
375
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1851">datatypes.ts:1851</a></li>
375
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2256">datatypes.ts:2256</a></li>
376
376
  </ul>
377
377
  </aside>
378
378
  <div class="tsd-comment tsd-typography">
@@ -387,7 +387,7 @@
387
387
  <div class="tsd-signature tsd-kind-icon">subject<wbr>Organizational<wbr>Unit<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
388
388
  <aside class="tsd-sources">
389
389
  <ul>
390
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1853">datatypes.ts:1853</a></li>
390
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2258">datatypes.ts:2258</a></li>
391
391
  </ul>
392
392
  </aside>
393
393
  <div class="tsd-comment tsd-typography">
@@ -402,7 +402,7 @@
402
402
  <div class="tsd-signature tsd-kind-icon">subject<wbr>Province<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
403
403
  <aside class="tsd-sources">
404
404
  <ul>
405
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1857">datatypes.ts:1857</a></li>
405
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2262">datatypes.ts:2262</a></li>
406
406
  </ul>
407
407
  </aside>
408
408
  <div class="tsd-comment tsd-typography">
@@ -417,7 +417,7 @@
417
417
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
418
418
  <aside class="tsd-sources">
419
419
  <ul>
420
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1821">datatypes.ts:1821</a></li>
420
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2226">datatypes.ts:2226</a></li>
421
421
  </ul>
422
422
  </aside>
423
423
  <div class="tsd-comment tsd-typography">
@@ -100,22 +100,22 @@
100
100
  <div class="tsd-signature tsd-kind-icon">certificate<wbr>Pem<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
101
101
  <aside class="tsd-sources">
102
102
  <ul>
103
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1804">datatypes.ts:1804</a></li>
103
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2209">datatypes.ts:2209</a></li>
104
104
  </ul>
105
105
  </aside>
106
106
  <div class="tsd-comment tsd-typography">
107
107
  <div class="lead">
108
- <p>chain of PEM-encoded certificates, leaf first. See <a href="https://ngrok.com/docs/api#tls-certificates-pem">Certificate Bundles</a>.</p>
108
+ <p>chain of PEM-encoded certificates, leaf first. See <a href="https://ngrok.com/docs/cloud-edge/endpoints#certificate-chains">Certificate Bundles</a>.</p>
109
109
  </div>
110
110
  </div>
111
111
  </section>
112
112
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
113
113
  <a name="description" class="tsd-anchor"></a>
114
- <h3>description</h3>
114
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
115
115
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
116
116
  <aside class="tsd-sources">
117
117
  <ul>
118
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1800">datatypes.ts:1800</a></li>
118
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2205">datatypes.ts:2205</a></li>
119
119
  </ul>
120
120
  </aside>
121
121
  <div class="tsd-comment tsd-typography">
@@ -126,11 +126,11 @@
126
126
  </section>
127
127
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
128
128
  <a name="metadata" class="tsd-anchor"></a>
129
- <h3>metadata</h3>
129
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
130
130
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
131
131
  <aside class="tsd-sources">
132
132
  <ul>
133
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1802">datatypes.ts:1802</a></li>
133
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2207">datatypes.ts:2207</a></li>
134
134
  </ul>
135
135
  </aside>
136
136
  <div class="tsd-comment tsd-typography">
@@ -145,12 +145,12 @@
145
145
  <div class="tsd-signature tsd-kind-icon">private<wbr>Key<wbr>Pem<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
146
146
  <aside class="tsd-sources">
147
147
  <ul>
148
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1806">datatypes.ts:1806</a></li>
148
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2211">datatypes.ts:2211</a></li>
149
149
  </ul>
150
150
  </aside>
151
151
  <div class="tsd-comment tsd-typography">
152
152
  <div class="lead">
153
- <p>private key for the TLS certificate, PEM-encoded. See <a href="https://ngrok.com/docs/ngrok-link#tls-certificates-key">Private Keys</a>.</p>
153
+ <p>private key for the TLS certificate, PEM-encoded. See <a href="https://ngrok.com/docs/cloud-edge/endpoints#private-keys">Private Keys</a>.</p>
154
154
  </div>
155
155
  </div>
156
156
  </section>
@@ -99,7 +99,7 @@
99
99
  <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>
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#L1868">datatypes.ts:1868</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2273">datatypes.ts:2273</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">tls<wbr>Certificates<span class="tsd-signature-symbol">:</span> <a href="datatypes.TLSCertificate.html" class="tsd-signature-type" data-tsd-kind="Interface">TLSCertificate</a><span class="tsd-signature-symbol">[]</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#L1864">datatypes.ts:1864</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2269">datatypes.ts:2269</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#L1866">datatypes.ts:1866</a></li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2271">datatypes.ts:2271</a></li>
133
133
  </ul>
134
134
  </aside>
135
135
  <div class="tsd-comment tsd-typography">
@@ -98,7 +98,7 @@
98
98
  <div class="tsd-signature tsd-kind-icon">dns<wbr>Names<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</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#L1873">datatypes.ts:1873</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2278">datatypes.ts:2278</a></li>
102
102
  </ul>
103
103
  </aside>
104
104
  <div class="tsd-comment tsd-typography">
@@ -113,7 +113,7 @@
113
113
  <div class="tsd-signature tsd-kind-icon">ips<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
114
114
  <aside class="tsd-sources">
115
115
  <ul>
116
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1875">datatypes.ts:1875</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2280">datatypes.ts:2280</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">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</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#L1812">datatypes.ts:1812</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2217">datatypes.ts:2217</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">id<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#L1810">datatypes.ts:1810</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2215">datatypes.ts:2215</a></li>
118
118
  </ul>
119
119
  </aside>
120
120
  </section>
@@ -124,7 +124,7 @@
124
124
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
125
125
  <aside class="tsd-sources">
126
126
  <ul>
127
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1814">datatypes.ts:1814</a></li>
127
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L2219">datatypes.ts:2219</a></li>
128
128
  </ul>
129
129
  </aside>
130
130
  <div class="tsd-comment tsd-typography">
@@ -91,6 +91,7 @@
91
91
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdge.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a></li>
92
92
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdge.html#metadata" class="tsd-kind-icon">metadata</a></li>
93
93
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdge.html#mutualTls" class="tsd-kind-icon">mutual<wbr>Tls</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdge.html#policy" class="tsd-kind-icon">policy</a></li>
94
95
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdge.html#tlsTermination" class="tsd-kind-icon">tls<wbr>Termination</a></li>
95
96
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdge.html#uri" class="tsd-kind-icon">uri</a></li>
96
97
  </ul>
@@ -106,7 +107,7 @@
106
107
  <div class="tsd-signature tsd-kind-icon">backend<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointBackend.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointBackend</a></div>
107
108
  <aside class="tsd-sources">
108
109
  <ul>
109
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1062">datatypes.ts:1062</a></li>
110
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1448">datatypes.ts:1448</a></li>
110
111
  </ul>
111
112
  </aside>
112
113
  <div class="tsd-comment tsd-typography">
@@ -118,10 +119,10 @@
118
119
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
119
120
  <a name="createdAt" class="tsd-anchor"></a>
120
121
  <h3>created<wbr>At</h3>
121
- <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
122
+ <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
122
123
  <aside class="tsd-sources">
123
124
  <ul>
124
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1056">datatypes.ts:1056</a></li>
125
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1442">datatypes.ts:1442</a></li>
125
126
  </ul>
126
127
  </aside>
127
128
  <div class="tsd-comment tsd-typography">
@@ -132,11 +133,11 @@
132
133
  </section>
133
134
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
134
135
  <a name="description" class="tsd-anchor"></a>
135
- <h3>description</h3>
136
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
136
137
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
137
138
  <aside class="tsd-sources">
138
139
  <ul>
139
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1052">datatypes.ts:1052</a></li>
140
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1438">datatypes.ts:1438</a></li>
140
141
  </ul>
141
142
  </aside>
142
143
  <div class="tsd-comment tsd-typography">
@@ -151,7 +152,7 @@
151
152
  <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>
152
153
  <aside class="tsd-sources">
153
154
  <ul>
154
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1060">datatypes.ts:1060</a></li>
155
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1446">datatypes.ts:1446</a></li>
155
156
  </ul>
156
157
  </aside>
157
158
  <div class="tsd-comment tsd-typography">
@@ -166,7 +167,7 @@
166
167
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
167
168
  <aside class="tsd-sources">
168
169
  <ul>
169
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1050">datatypes.ts:1050</a></li>
170
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1436">datatypes.ts:1436</a></li>
170
171
  </ul>
171
172
  </aside>
172
173
  <div class="tsd-comment tsd-typography">
@@ -181,17 +182,17 @@
181
182
  <div class="tsd-signature tsd-kind-icon">ip<wbr>Restriction<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointIPPolicy.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicy</a></div>
182
183
  <aside class="tsd-sources">
183
184
  <ul>
184
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1063">datatypes.ts:1063</a></li>
185
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1449">datatypes.ts:1449</a></li>
185
186
  </ul>
186
187
  </aside>
187
188
  </section>
188
189
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
189
190
  <a name="metadata" class="tsd-anchor"></a>
190
- <h3>metadata</h3>
191
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
191
192
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
192
193
  <aside class="tsd-sources">
193
194
  <ul>
194
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1054">datatypes.ts:1054</a></li>
195
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1440">datatypes.ts:1440</a></li>
195
196
  </ul>
196
197
  </aside>
197
198
  <div class="tsd-comment tsd-typography">
@@ -206,17 +207,32 @@
206
207
  <div class="tsd-signature tsd-kind-icon">mutual<wbr>Tls<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointMutualTLS.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointMutualTLS</a></div>
207
208
  <aside class="tsd-sources">
208
209
  <ul>
209
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1064">datatypes.ts:1064</a></li>
210
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1450">datatypes.ts:1450</a></li>
210
211
  </ul>
211
212
  </aside>
212
213
  </section>
214
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
215
+ <a name="policy" class="tsd-anchor"></a>
216
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> policy</h3>
217
+ <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>
218
+ <aside class="tsd-sources">
219
+ <ul>
220
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1453">datatypes.ts:1453</a></li>
221
+ </ul>
222
+ </aside>
223
+ <div class="tsd-comment tsd-typography">
224
+ <div class="lead">
225
+ <p>the traffic policy associated with this edge or null</p>
226
+ </div>
227
+ </div>
228
+ </section>
213
229
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
214
230
  <a name="tlsTermination" class="tsd-anchor"></a>
215
231
  <h3><span class="tsd-flag ts-flagOptional">Optional</span> tls<wbr>Termination</h3>
216
232
  <div class="tsd-signature tsd-kind-icon">tls<wbr>Termination<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointTLSTermination.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTLSTermination</a></div>
217
233
  <aside class="tsd-sources">
218
234
  <ul>
219
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1065">datatypes.ts:1065</a></li>
235
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1451">datatypes.ts:1451</a></li>
220
236
  </ul>
221
237
  </aside>
222
238
  </section>
@@ -226,7 +242,7 @@
226
242
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
227
243
  <aside class="tsd-sources">
228
244
  <ul>
229
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1058">datatypes.ts:1058</a></li>
245
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1444">datatypes.ts:1444</a></li>
230
246
  </ul>
231
247
  </aside>
232
248
  <div class="tsd-comment tsd-typography">
@@ -285,6 +301,9 @@
285
301
  <li class=" tsd-kind-property tsd-parent-kind-interface">
286
302
  <a href="datatypes.TLSEdge.html#mutualTls" class="tsd-kind-icon">mutual<wbr>Tls</a>
287
303
  </li>
304
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
305
+ <a href="datatypes.TLSEdge.html#policy" class="tsd-kind-icon">policy</a>
306
+ </li>
288
307
  <li class=" tsd-kind-property tsd-parent-kind-interface">
289
308
  <a href="datatypes.TLSEdge.html#tlsTermination" class="tsd-kind-icon">tls<wbr>Termination</a>
290
309
  </li>
@@ -89,6 +89,7 @@
89
89
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdgeCreate.html#ipRestriction" class="tsd-kind-icon">ip<wbr>Restriction</a></li>
90
90
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdgeCreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
91
91
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdgeCreate.html#mutualTls" class="tsd-kind-icon">mutual<wbr>Tls</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdgeCreate.html#policy" class="tsd-kind-icon">policy</a></li>
92
93
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.TLSEdgeCreate.html#tlsTermination" class="tsd-kind-icon">tls<wbr>Termination</a></li>
93
94
  </ul>
94
95
  </section>
@@ -103,7 +104,7 @@
103
104
  <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>
104
105
  <aside class="tsd-sources">
105
106
  <ul>
106
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1026">datatypes.ts:1026</a></li>
107
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1408">datatypes.ts:1408</a></li>
107
108
  </ul>
108
109
  </aside>
109
110
  <div class="tsd-comment tsd-typography">
@@ -114,11 +115,11 @@
114
115
  </section>
115
116
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
116
117
  <a name="description" class="tsd-anchor"></a>
117
- <h3>description</h3>
118
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
118
119
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
119
120
  <aside class="tsd-sources">
120
121
  <ul>
121
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1020">datatypes.ts:1020</a></li>
122
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1402">datatypes.ts:1402</a></li>
122
123
  </ul>
123
124
  </aside>
124
125
  <div class="tsd-comment tsd-typography">
@@ -133,7 +134,7 @@
133
134
  <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>
134
135
  <aside class="tsd-sources">
135
136
  <ul>
136
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1024">datatypes.ts:1024</a></li>
137
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1406">datatypes.ts:1406</a></li>
137
138
  </ul>
138
139
  </aside>
139
140
  <div class="tsd-comment tsd-typography">
@@ -148,17 +149,17 @@
148
149
  <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>
149
150
  <aside class="tsd-sources">
150
151
  <ul>
151
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1027">datatypes.ts:1027</a></li>
152
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1409">datatypes.ts:1409</a></li>
152
153
  </ul>
153
154
  </aside>
154
155
  </section>
155
156
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
156
157
  <a name="metadata" class="tsd-anchor"></a>
157
- <h3>metadata</h3>
158
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
158
159
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
159
160
  <aside class="tsd-sources">
160
161
  <ul>
161
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1022">datatypes.ts:1022</a></li>
162
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1404">datatypes.ts:1404</a></li>
162
163
  </ul>
163
164
  </aside>
164
165
  <div class="tsd-comment tsd-typography">
@@ -173,17 +174,32 @@
173
174
  <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>
174
175
  <aside class="tsd-sources">
175
176
  <ul>
176
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1028">datatypes.ts:1028</a></li>
177
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1410">datatypes.ts:1410</a></li>
177
178
  </ul>
178
179
  </aside>
179
180
  </section>
181
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
182
+ <a name="policy" class="tsd-anchor"></a>
183
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> policy</h3>
184
+ <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>
185
+ <aside class="tsd-sources">
186
+ <ul>
187
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1413">datatypes.ts:1413</a></li>
188
+ </ul>
189
+ </aside>
190
+ <div class="tsd-comment tsd-typography">
191
+ <div class="lead">
192
+ <p>the traffic policy associated with this edge or null</p>
193
+ </div>
194
+ </div>
195
+ </section>
180
196
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
181
197
  <a name="tlsTermination" class="tsd-anchor"></a>
182
198
  <h3><span class="tsd-flag ts-flagOptional">Optional</span> tls<wbr>Termination</h3>
183
199
  <div class="tsd-signature tsd-kind-icon">tls<wbr>Termination<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointTLSTermination.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTLSTermination</a></div>
184
200
  <aside class="tsd-sources">
185
201
  <ul>
186
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1029">datatypes.ts:1029</a></li>
202
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/4214cc1/src/datatypes.ts#L1411">datatypes.ts:1411</a></li>
187
203
  </ul>
188
204
  </aside>
189
205
  </section>
@@ -231,6 +247,9 @@
231
247
  <li class=" tsd-kind-property tsd-parent-kind-interface">
232
248
  <a href="datatypes.TLSEdgeCreate.html#mutualTls" class="tsd-kind-icon">mutual<wbr>Tls</a>
233
249
  </li>
250
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
251
+ <a href="datatypes.TLSEdgeCreate.html#policy" class="tsd-kind-icon">policy</a>
252
+ </li>
234
253
  <li class=" tsd-kind-property tsd-parent-kind-interface">
235
254
  <a href="datatypes.TLSEdgeCreate.html#tlsTermination" class="tsd-kind-icon">tls<wbr>Termination</a>
236
255
  </li>