@ngrok/ngrok-api 0.9.0 → 0.10.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 (271) hide show
  1. package/.eslintignore +2 -0
  2. package/.eslintrc.js +2 -0
  3. package/.prettierrc.js +2 -0
  4. package/CHANGELOG.md +12 -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 +54 -26
  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.CertificateAuthorities.html +20 -11
  15. package/docs/classes/services.Credentials.html +21 -12
  16. package/docs/classes/services.EdgeRouteBackendModule.html +4 -4
  17. package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +4 -4
  18. package/docs/classes/services.EdgeRouteCompressionModule.html +4 -4
  19. package/docs/classes/services.EdgeRouteIPRestrictionModule.html +4 -4
  20. package/docs/classes/services.EdgeRouteOAuthModule.html +4 -4
  21. package/docs/classes/services.EdgeRouteOIDCModule.html +4 -4
  22. package/docs/classes/services.EdgeRouteRequestHeadersModule.html +4 -4
  23. package/docs/classes/services.EdgeRouteResponseHeadersModule.html +4 -4
  24. package/docs/classes/services.EdgeRouteSAMLModule.html +4 -4
  25. package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +4 -4
  26. package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +4 -4
  27. package/docs/classes/services.EdgesHTTPS.html +20 -11
  28. package/docs/classes/services.EdgesHTTPSRoutes.html +5 -5
  29. package/docs/classes/services.EdgesTCP.html +20 -11
  30. package/docs/classes/services.EdgesTLS.html +20 -11
  31. package/docs/classes/services.Endpoints.html +15 -6
  32. package/docs/classes/services.EventDestinations.html +21 -12
  33. package/docs/classes/services.EventSources.html +6 -6
  34. package/docs/classes/services.EventSubscriptions.html +20 -11
  35. package/docs/classes/services.FailoverBackends.html +20 -11
  36. package/docs/classes/services.HTTPResponseBackends.html +20 -11
  37. package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +8 -8
  38. package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +8 -8
  39. package/docs/classes/services.IPPolicies.html +20 -11
  40. package/docs/classes/services.IPPolicyRules.html +20 -11
  41. package/docs/classes/services.IPRestrictions.html +20 -11
  42. package/docs/classes/services.ReservedAddrs.html +20 -11
  43. package/docs/classes/services.ReservedDomains.html +26 -17
  44. package/docs/classes/services.SSHCertificateAuthorities.html +20 -11
  45. package/docs/classes/services.SSHCredentials.html +20 -11
  46. package/docs/classes/services.SSHHostCertificates.html +20 -11
  47. package/docs/classes/services.SSHUserCertificates.html +20 -11
  48. package/docs/classes/services.TCPEdgeBackendModule.html +8 -8
  49. package/docs/classes/services.TCPEdgeIPRestrictionModule.html +8 -8
  50. package/docs/classes/services.TLSCertificates.html +20 -11
  51. package/docs/classes/services.TLSEdgeBackendModule.html +8 -8
  52. package/docs/classes/services.TLSEdgeIPRestrictionModule.html +8 -8
  53. package/docs/classes/services.TLSEdgeMutualTLSModule.html +8 -8
  54. package/docs/classes/services.TLSEdgeTLSTerminationModule.html +8 -8
  55. package/docs/classes/services.TunnelGroupBackends.html +20 -11
  56. package/docs/classes/services.TunnelSessions.html +22 -13
  57. package/docs/classes/services.Tunnels.html +15 -6
  58. package/docs/classes/services.WeightedBackends.html +20 -11
  59. package/docs/index.html +8 -3
  60. package/docs/interfaces/client.NgrokConfig.html +2 -2
  61. package/docs/interfaces/datatypes.APIKey.html +28 -9
  62. package/docs/interfaces/datatypes.APIKeyCreate.html +23 -4
  63. package/docs/interfaces/datatypes.APIKeyList.html +3 -3
  64. package/docs/interfaces/datatypes.APIKeyUpdate.html +3 -3
  65. package/docs/interfaces/datatypes.AWSAuth.html +2 -2
  66. package/docs/interfaces/datatypes.AWSCredentials.html +2 -2
  67. package/docs/interfaces/datatypes.AWSRole.html +1 -1
  68. package/docs/interfaces/datatypes.AbuseReport.html +9 -9
  69. package/docs/interfaces/datatypes.AbuseReportCreate.html +3 -3
  70. package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
  71. package/docs/interfaces/datatypes.AgentIngress.html +49 -11
  72. package/docs/interfaces/datatypes.AgentIngressCertJob.html +224 -0
  73. package/docs/interfaces/datatypes.AgentIngressCertPolicy.html +186 -0
  74. package/docs/interfaces/datatypes.AgentIngressCertStatus.html +186 -0
  75. package/docs/interfaces/datatypes.AgentIngressCreate.html +24 -5
  76. package/docs/interfaces/datatypes.AgentIngressList.html +3 -3
  77. package/docs/interfaces/datatypes.AgentIngressUpdate.html +22 -3
  78. package/docs/interfaces/datatypes.ApplicationSession.html +357 -0
  79. package/docs/interfaces/datatypes.ApplicationSessionList.html +205 -0
  80. package/docs/interfaces/datatypes.ApplicationUser.html +338 -0
  81. package/docs/interfaces/datatypes.ApplicationUserList.html +205 -0
  82. package/docs/interfaces/datatypes.BrowserSession.html +205 -0
  83. package/docs/interfaces/datatypes.CertificateAuthority.html +16 -16
  84. package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +5 -5
  85. package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
  86. package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
  87. package/docs/interfaces/datatypes.Credential.html +30 -11
  88. package/docs/interfaces/datatypes.CredentialCreate.html +25 -6
  89. package/docs/interfaces/datatypes.CredentialList.html +3 -3
  90. package/docs/interfaces/datatypes.CredentialUpdate.html +5 -5
  91. package/docs/interfaces/datatypes.EdgeBackendReplace.html +2 -2
  92. package/docs/interfaces/datatypes.EdgeIPRestrictionReplace.html +2 -2
  93. package/docs/interfaces/datatypes.EdgeMutualTLSReplace.html +2 -2
  94. package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +3 -3
  95. package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +3 -3
  96. package/docs/interfaces/datatypes.EdgeRouteCompressionReplace.html +3 -3
  97. package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +3 -3
  98. package/docs/interfaces/datatypes.EdgeRouteItem.html +2 -2
  99. package/docs/interfaces/datatypes.EdgeRouteOAuthReplace.html +3 -3
  100. package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +3 -3
  101. package/docs/interfaces/datatypes.EdgeRouteRequestHeadersReplace.html +3 -3
  102. package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +3 -3
  103. package/docs/interfaces/datatypes.EdgeRouteSAMLReplace.html +3 -3
  104. package/docs/interfaces/datatypes.EdgeRouteWebhookVerificationReplace.html +3 -3
  105. package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +3 -3
  106. package/docs/interfaces/datatypes.EdgeTLSTerminationAtEdgeReplace.html +2 -2
  107. package/docs/interfaces/datatypes.EdgeTLSTerminationReplace.html +2 -2
  108. package/docs/interfaces/datatypes.Endpoint.html +19 -19
  109. package/docs/interfaces/datatypes.EndpointBackend.html +2 -2
  110. package/docs/interfaces/datatypes.EndpointBackendMutate.html +2 -2
  111. package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
  112. package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
  113. package/docs/interfaces/datatypes.EndpointIPPolicy.html +7 -2
  114. package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
  115. package/docs/interfaces/datatypes.EndpointList.html +3 -3
  116. package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
  117. package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +2 -2
  118. package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
  119. package/docs/interfaces/datatypes.EndpointOAuthAmazon.html +218 -0
  120. package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
  121. package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +12 -12
  122. package/docs/interfaces/datatypes.EndpointOAuthGitLab.html +218 -0
  123. package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
  124. package/docs/interfaces/datatypes.EndpointOAuthLinkedIn.html +218 -0
  125. package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
  126. package/docs/interfaces/datatypes.EndpointOAuthProvider.html +80 -4
  127. package/docs/interfaces/datatypes.EndpointOAuthTwitch.html +218 -0
  128. package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
  129. package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
  130. package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
  131. package/docs/interfaces/datatypes.EndpointSAML.html +15 -15
  132. package/docs/interfaces/datatypes.EndpointSAMLMutate.html +10 -10
  133. package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
  134. package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +2 -2
  135. package/docs/interfaces/datatypes.EndpointWebhookValidation.html +4 -4
  136. package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +1 -1
  137. package/docs/interfaces/datatypes.Error.html +4 -4
  138. package/docs/interfaces/datatypes.EventDestination.html +10 -10
  139. package/docs/interfaces/datatypes.EventDestinationCreate.html +6 -6
  140. package/docs/interfaces/datatypes.EventDestinationList.html +3 -3
  141. package/docs/interfaces/datatypes.EventDestinationUpdate.html +5 -5
  142. package/docs/interfaces/datatypes.EventSource.html +2 -2
  143. package/docs/interfaces/datatypes.EventSourceCreate.html +2 -2
  144. package/docs/interfaces/datatypes.EventSourceItem.html +2 -2
  145. package/docs/interfaces/datatypes.EventSourceList.html +2 -2
  146. package/docs/interfaces/datatypes.EventSourcePaging.html +1 -1
  147. package/docs/interfaces/datatypes.EventSourceReplace.html +1 -1
  148. package/docs/interfaces/datatypes.EventSourceUpdate.html +2 -2
  149. package/docs/interfaces/datatypes.EventSubscription.html +10 -10
  150. package/docs/interfaces/datatypes.EventSubscriptionCreate.html +6 -6
  151. package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
  152. package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +5 -5
  153. package/docs/interfaces/datatypes.EventTarget.html +22 -3
  154. package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
  155. package/docs/interfaces/datatypes.EventTargetDatadog.html +224 -0
  156. package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
  157. package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
  158. package/docs/interfaces/datatypes.FailoverBackend.html +9 -9
  159. package/docs/interfaces/datatypes.FailoverBackendCreate.html +5 -5
  160. package/docs/interfaces/datatypes.FailoverBackendList.html +3 -3
  161. package/docs/interfaces/datatypes.FailoverBackendUpdate.html +4 -4
  162. package/docs/interfaces/datatypes.HTTPResponseBackend.html +11 -11
  163. package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +7 -7
  164. package/docs/interfaces/datatypes.HTTPResponseBackendList.html +3 -3
  165. package/docs/interfaces/datatypes.HTTPResponseBackendUpdate.html +6 -6
  166. package/docs/interfaces/datatypes.HTTPSEdge.html +12 -12
  167. package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +7 -7
  168. package/docs/interfaces/datatypes.HTTPSEdgeList.html +3 -3
  169. package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +22 -22
  170. package/docs/interfaces/datatypes.HTTPSEdgeRouteCreate.html +18 -18
  171. package/docs/interfaces/datatypes.HTTPSEdgeRouteUpdate.html +19 -19
  172. package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +6 -6
  173. package/docs/interfaces/datatypes.IPPolicy.html +8 -8
  174. package/docs/interfaces/datatypes.IPPolicyCreate.html +4 -4
  175. package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
  176. package/docs/interfaces/datatypes.IPPolicyRule.html +11 -11
  177. package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +7 -7
  178. package/docs/interfaces/datatypes.IPPolicyRuleList.html +3 -3
  179. package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +4 -4
  180. package/docs/interfaces/datatypes.IPPolicyUpdate.html +3 -3
  181. package/docs/interfaces/datatypes.IPRestriction.html +11 -11
  182. package/docs/interfaces/datatypes.IPRestrictionCreate.html +7 -7
  183. package/docs/interfaces/datatypes.IPRestrictionList.html +3 -3
  184. package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
  185. package/docs/interfaces/datatypes.IdentityProvider.html +186 -0
  186. package/docs/interfaces/datatypes.Item.html +1 -1
  187. package/docs/interfaces/datatypes.Location.html +224 -0
  188. package/docs/interfaces/datatypes.Paging.html +2 -2
  189. package/docs/interfaces/datatypes.Ref.html +2 -2
  190. package/docs/interfaces/datatypes.ReservedAddr.html +10 -10
  191. package/docs/interfaces/datatypes.ReservedAddrCreate.html +5 -5
  192. package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
  193. package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -3
  194. package/docs/interfaces/datatypes.ReservedDomain.html +15 -15
  195. package/docs/interfaces/datatypes.ReservedDomainCertJob.html +6 -6
  196. package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
  197. package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +3 -3
  198. package/docs/interfaces/datatypes.ReservedDomainCreate.html +18 -18
  199. package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
  200. package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -5
  201. package/docs/interfaces/datatypes.SSHCertificateAuthority.html +10 -10
  202. package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +7 -7
  203. package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
  204. package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
  205. package/docs/interfaces/datatypes.SSHCredential.html +30 -11
  206. package/docs/interfaces/datatypes.SSHCredentialCreate.html +26 -7
  207. package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
  208. package/docs/interfaces/datatypes.SSHCredentialUpdate.html +5 -5
  209. package/docs/interfaces/datatypes.SSHHostCertificate.html +17 -17
  210. package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +11 -11
  211. package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
  212. package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
  213. package/docs/interfaces/datatypes.SSHUserCertificate.html +19 -19
  214. package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +13 -13
  215. package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
  216. package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
  217. package/docs/interfaces/datatypes.TCPEdge.html +11 -11
  218. package/docs/interfaces/datatypes.TCPEdgeCreate.html +7 -7
  219. package/docs/interfaces/datatypes.TCPEdgeList.html +3 -3
  220. package/docs/interfaces/datatypes.TCPEdgeUpdate.html +6 -6
  221. package/docs/interfaces/datatypes.TLSCertificate.html +28 -28
  222. package/docs/interfaces/datatypes.TLSCertificateCreate.html +8 -8
  223. package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
  224. package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
  225. package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
  226. package/docs/interfaces/datatypes.TLSEdge.html +13 -13
  227. package/docs/interfaces/datatypes.TLSEdgeCreate.html +9 -9
  228. package/docs/interfaces/datatypes.TLSEdgeList.html +3 -3
  229. package/docs/interfaces/datatypes.TLSEdgeUpdate.html +8 -8
  230. package/docs/interfaces/datatypes.Tunnel.html +17 -17
  231. package/docs/interfaces/datatypes.TunnelGroupBackend.html +10 -10
  232. package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +5 -5
  233. package/docs/interfaces/datatypes.TunnelGroupBackendList.html +3 -3
  234. package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +4 -4
  235. package/docs/interfaces/datatypes.TunnelList.html +3 -3
  236. package/docs/interfaces/datatypes.TunnelSession.html +12 -12
  237. package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
  238. package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
  239. package/docs/interfaces/datatypes.UserAgent.html +262 -0
  240. package/docs/interfaces/datatypes.WeightedBackend.html +9 -9
  241. package/docs/interfaces/datatypes.WeightedBackendCreate.html +5 -5
  242. package/docs/interfaces/datatypes.WeightedBackendList.html +3 -3
  243. package/docs/interfaces/datatypes.WeightedBackendUpdate.html +4 -4
  244. package/docs/modules/datatypes.html +64 -0
  245. package/docs/modules/services.html +8 -0
  246. package/jest.config.js +2 -0
  247. package/lib/client.d.ts +9 -7
  248. package/lib/client.d.ts.map +1 -1
  249. package/lib/client.js +89 -119
  250. package/lib/client.js.map +1 -1
  251. package/lib/datatypes.d.ts +392 -201
  252. package/lib/datatypes.d.ts.map +1 -1
  253. package/lib/datatypes.js +4 -3
  254. package/lib/datatypes.js.map +1 -1
  255. package/lib/index.d.ts.map +1 -1
  256. package/lib/index.js +16 -28
  257. package/lib/index.js.map +1 -1
  258. package/lib/services.d.ts +164 -126
  259. package/lib/services.d.ts.map +1 -1
  260. package/lib/services.js +3294 -3356
  261. package/lib/services.js.map +1 -1
  262. package/lib/util.d.ts.map +1 -1
  263. package/lib/util.js +35 -34
  264. package/lib/util.js.map +1 -1
  265. package/package.json +3 -3
  266. package/src/client.ts +16 -32
  267. package/src/datatypes.ts +413 -204
  268. package/src/index.ts +2 -0
  269. package/src/services.ts +768 -519
  270. package/src/util.ts +2 -0
  271. package/test/apikey.test.js +62 -63
@@ -86,6 +86,7 @@
86
86
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredentialCreate.html#acl" class="tsd-kind-icon">acl</a></li>
87
87
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredentialCreate.html#description" class="tsd-kind-icon">description</a></li>
88
88
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredentialCreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredentialCreate.html#ownerId" class="tsd-kind-icon">owner<wbr>Id</a></li>
89
90
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SSHCredentialCreate.html#publicKey" class="tsd-kind-icon">public<wbr>Key</a></li>
90
91
  </ul>
91
92
  </section>
@@ -100,22 +101,22 @@
100
101
  <div class="tsd-signature tsd-kind-icon">acl<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
101
102
  <aside class="tsd-sources">
102
103
  <ul>
103
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1627">datatypes.ts:1627</a></li>
104
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1868">datatypes.ts:1868</a></li>
104
105
  </ul>
105
106
  </aside>
106
107
  <div class="tsd-comment tsd-typography">
107
108
  <div class="lead">
108
- <p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>&#39;*&#39;</code> is equivalent to no acl at all and will explicitly permit all actions.</p>
109
+ <p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of <code>bind:*=example</code> which will allow <code>x=example</code>, <code>y=example</code>, etc. A rule of <code>&#39;*&#39;</code> is equivalent to no acl at all and will explicitly permit all actions.</p>
109
110
  </div>
110
111
  </div>
111
112
  </section>
112
113
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
113
114
  <a name="description" class="tsd-anchor"></a>
114
- <h3>description</h3>
115
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
115
116
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
116
117
  <aside class="tsd-sources">
117
118
  <ul>
118
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1623">datatypes.ts:1623</a></li>
119
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1864">datatypes.ts:1864</a></li>
119
120
  </ul>
120
121
  </aside>
121
122
  <div class="tsd-comment tsd-typography">
@@ -126,11 +127,11 @@
126
127
  </section>
127
128
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
128
129
  <a name="metadata" class="tsd-anchor"></a>
129
- <h3>metadata</h3>
130
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
130
131
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
131
132
  <aside class="tsd-sources">
132
133
  <ul>
133
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1625">datatypes.ts:1625</a></li>
134
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1866">datatypes.ts:1866</a></li>
134
135
  </ul>
135
136
  </aside>
136
137
  <div class="tsd-comment tsd-typography">
@@ -139,13 +140,28 @@
139
140
  </div>
140
141
  </div>
141
142
  </section>
143
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
144
+ <a name="ownerId" class="tsd-anchor"></a>
145
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> owner<wbr>Id</h3>
146
+ <div class="tsd-signature tsd-kind-icon">owner<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
147
+ <aside class="tsd-sources">
148
+ <ul>
149
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1872">datatypes.ts:1872</a></li>
150
+ </ul>
151
+ </aside>
152
+ <div class="tsd-comment tsd-typography">
153
+ <div class="lead">
154
+ <p>If supplied at credential creation, ownership will be assigned to the specified User or Bot. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Bot.</p>
155
+ </div>
156
+ </div>
157
+ </section>
142
158
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
143
159
  <a name="publicKey" class="tsd-anchor"></a>
144
160
  <h3>public<wbr>Key</h3>
145
161
  <div class="tsd-signature tsd-kind-icon">public<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
146
162
  <aside class="tsd-sources">
147
163
  <ul>
148
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1629">datatypes.ts:1629</a></li>
164
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1870">datatypes.ts:1870</a></li>
149
165
  </ul>
150
166
  </aside>
151
167
  <div class="tsd-comment tsd-typography">
@@ -189,6 +205,9 @@
189
205
  <li class=" tsd-kind-property tsd-parent-kind-interface">
190
206
  <a href="datatypes.SSHCredentialCreate.html#metadata" class="tsd-kind-icon">metadata</a>
191
207
  </li>
208
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
209
+ <a href="datatypes.SSHCredentialCreate.html#ownerId" class="tsd-kind-icon">owner<wbr>Id</a>
210
+ </li>
192
211
  <li class=" tsd-kind-property tsd-parent-kind-interface">
193
212
  <a href="datatypes.SSHCredentialCreate.html#publicKey" class="tsd-kind-icon">public<wbr>Key</a>
194
213
  </li>
@@ -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#L1665">datatypes.ts:1665</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1910">datatypes.ts:1910</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">ssh<wbr>Credentials<span class="tsd-signature-symbol">:</span> <a href="datatypes.SSHCredential.html" class="tsd-signature-type" data-tsd-kind="Interface">SSHCredential</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#L1661">datatypes.ts:1661</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1906">datatypes.ts:1906</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#L1663">datatypes.ts:1663</a></li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1908">datatypes.ts:1908</a></li>
133
133
  </ul>
134
134
  </aside>
135
135
  <div class="tsd-comment tsd-typography">
@@ -100,12 +100,12 @@
100
100
  <div class="tsd-signature tsd-kind-icon">acl<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</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#L1639">datatypes.ts:1639</a></li>
103
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1882">datatypes.ts:1882</a></li>
104
104
  </ul>
105
105
  </aside>
106
106
  <div class="tsd-comment tsd-typography">
107
107
  <div class="lead">
108
- <p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains and addresses the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. A rule of <code>&#39;*&#39;</code> is equivalent to no acl at all and will explicitly permit all actions.</p>
108
+ <p>optional list of ACL rules. If unspecified, the credential will have no restrictions. The only allowed ACL rule at this time is the <code>bind</code> rule. The <code>bind</code> rule allows the caller to restrict what domains, addresses, and labels the token is allowed to bind. For example, to allow the token to open a tunnel on example.ngrok.io your ACL would include the rule <code>bind:example.ngrok.io</code>. Bind rules for domains may specify a leading wildcard to match multiple domains with a common suffix. For example, you may specify a rule of <code>bind:*.example.com</code> which will allow <code>x.example.com</code>, <code>y.example.com</code>, <code>*.example.com</code>, etc. Bind rules for labels may specify a wildcard key and/or value to match multiple labels. For example, you may specify a rule of <code>bind:*=example</code> which will allow <code>x=example</code>, <code>y=example</code>, etc. A rule of <code>&#39;*&#39;</code> is equivalent to no acl at all and will explicitly permit all actions.</p>
109
109
  </div>
110
110
  </div>
111
111
  </section>
@@ -115,7 +115,7 @@
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#L1635">datatypes.ts:1635</a></li>
118
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1878">datatypes.ts:1878</a></li>
119
119
  </ul>
120
120
  </aside>
121
121
  <div class="tsd-comment tsd-typography">
@@ -130,7 +130,7 @@
130
130
  <div class="tsd-signature tsd-kind-icon">id<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#L1633">datatypes.ts:1633</a></li>
133
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1876">datatypes.ts:1876</a></li>
134
134
  </ul>
135
135
  </aside>
136
136
  </section>
@@ -140,7 +140,7 @@
140
140
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
141
141
  <aside class="tsd-sources">
142
142
  <ul>
143
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1637">datatypes.ts:1637</a></li>
143
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1880">datatypes.ts:1880</a></li>
144
144
  </ul>
145
145
  </aside>
146
146
  <div class="tsd-comment tsd-typography">
@@ -108,7 +108,7 @@
108
108
  <div class="tsd-signature tsd-kind-icon">certificate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
109
109
  <aside class="tsd-sources">
110
110
  <ul>
111
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1717">datatypes.ts:1717</a></li>
111
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1962">datatypes.ts:1962</a></li>
112
112
  </ul>
113
113
  </aside>
114
114
  <div class="tsd-comment tsd-typography">
@@ -120,10 +120,10 @@
120
120
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
121
121
  <a name="createdAt" class="tsd-anchor"></a>
122
122
  <h3>created<wbr>At</h3>
123
- <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
123
+ <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
124
124
  <aside class="tsd-sources">
125
125
  <ul>
126
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1699">datatypes.ts:1699</a></li>
126
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1944">datatypes.ts:1944</a></li>
127
127
  </ul>
128
128
  </aside>
129
129
  <div class="tsd-comment tsd-typography">
@@ -134,11 +134,11 @@
134
134
  </section>
135
135
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
136
136
  <a name="description" class="tsd-anchor"></a>
137
- <h3>description</h3>
137
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
138
138
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
139
139
  <aside class="tsd-sources">
140
140
  <ul>
141
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1701">datatypes.ts:1701</a></li>
141
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1946">datatypes.ts:1946</a></li>
142
142
  </ul>
143
143
  </aside>
144
144
  <div class="tsd-comment tsd-typography">
@@ -153,7 +153,7 @@
153
153
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
154
154
  <aside class="tsd-sources">
155
155
  <ul>
156
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1695">datatypes.ts:1695</a></li>
156
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1940">datatypes.ts:1940</a></li>
157
157
  </ul>
158
158
  </aside>
159
159
  <div class="tsd-comment tsd-typography">
@@ -168,7 +168,7 @@
168
168
  <div class="tsd-signature tsd-kind-icon">key<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
169
169
  <aside class="tsd-sources">
170
170
  <ul>
171
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1707">datatypes.ts:1707</a></li>
171
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1952">datatypes.ts:1952</a></li>
172
172
  </ul>
173
173
  </aside>
174
174
  <div class="tsd-comment tsd-typography">
@@ -179,11 +179,11 @@
179
179
  </section>
180
180
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
181
181
  <a name="metadata" class="tsd-anchor"></a>
182
- <h3>metadata</h3>
182
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
183
183
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
184
184
  <aside class="tsd-sources">
185
185
  <ul>
186
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1703">datatypes.ts:1703</a></li>
186
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1948">datatypes.ts:1948</a></li>
187
187
  </ul>
188
188
  </aside>
189
189
  <div class="tsd-comment tsd-typography">
@@ -198,7 +198,7 @@
198
198
  <div class="tsd-signature tsd-kind-icon">principals<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
199
199
  <aside class="tsd-sources">
200
200
  <ul>
201
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1711">datatypes.ts:1711</a></li>
201
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1956">datatypes.ts:1956</a></li>
202
202
  </ul>
203
203
  </aside>
204
204
  <div class="tsd-comment tsd-typography">
@@ -213,7 +213,7 @@
213
213
  <div class="tsd-signature tsd-kind-icon">public<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
214
214
  <aside class="tsd-sources">
215
215
  <ul>
216
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1705">datatypes.ts:1705</a></li>
216
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1950">datatypes.ts:1950</a></li>
217
217
  </ul>
218
218
  </aside>
219
219
  <div class="tsd-comment tsd-typography">
@@ -228,7 +228,7 @@
228
228
  <div class="tsd-signature tsd-kind-icon">ssh<wbr>Certificate<wbr>Authority<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
229
229
  <aside class="tsd-sources">
230
230
  <ul>
231
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1709">datatypes.ts:1709</a></li>
231
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1954">datatypes.ts:1954</a></li>
232
232
  </ul>
233
233
  </aside>
234
234
  <div class="tsd-comment tsd-typography">
@@ -243,7 +243,7 @@
243
243
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
244
244
  <aside class="tsd-sources">
245
245
  <ul>
246
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1697">datatypes.ts:1697</a></li>
246
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1942">datatypes.ts:1942</a></li>
247
247
  </ul>
248
248
  </aside>
249
249
  <div class="tsd-comment tsd-typography">
@@ -255,10 +255,10 @@
255
255
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
256
256
  <a name="validAfter" class="tsd-anchor"></a>
257
257
  <h3>valid<wbr>After</h3>
258
- <div class="tsd-signature tsd-kind-icon">valid<wbr>After<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
258
+ <div class="tsd-signature tsd-kind-icon">valid<wbr>After<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
259
259
  <aside class="tsd-sources">
260
260
  <ul>
261
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1713">datatypes.ts:1713</a></li>
261
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1958">datatypes.ts:1958</a></li>
262
262
  </ul>
263
263
  </aside>
264
264
  <div class="tsd-comment tsd-typography">
@@ -270,10 +270,10 @@
270
270
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
271
271
  <a name="validUntil" class="tsd-anchor"></a>
272
272
  <h3>valid<wbr>Until</h3>
273
- <div class="tsd-signature tsd-kind-icon">valid<wbr>Until<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
273
+ <div class="tsd-signature tsd-kind-icon">valid<wbr>Until<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
274
274
  <aside class="tsd-sources">
275
275
  <ul>
276
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1715">datatypes.ts:1715</a></li>
276
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1960">datatypes.ts:1960</a></li>
277
277
  </ul>
278
278
  </aside>
279
279
  <div class="tsd-comment tsd-typography">
@@ -99,11 +99,11 @@
99
99
  <h2>Properties</h2>
100
100
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
101
101
  <a name="description" class="tsd-anchor"></a>
102
- <h3>description</h3>
102
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
103
103
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
104
104
  <aside class="tsd-sources">
105
105
  <ul>
106
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1680">datatypes.ts:1680</a></li>
106
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1925">datatypes.ts:1925</a></li>
107
107
  </ul>
108
108
  </aside>
109
109
  <div class="tsd-comment tsd-typography">
@@ -114,11 +114,11 @@
114
114
  </section>
115
115
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
116
116
  <a name="metadata" class="tsd-anchor"></a>
117
- <h3>metadata</h3>
117
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
118
118
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
119
119
  <aside class="tsd-sources">
120
120
  <ul>
121
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1682">datatypes.ts:1682</a></li>
121
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1927">datatypes.ts:1927</a></li>
122
122
  </ul>
123
123
  </aside>
124
124
  <div class="tsd-comment tsd-typography">
@@ -133,7 +133,7 @@
133
133
  <div class="tsd-signature tsd-kind-icon">principals<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
134
134
  <aside class="tsd-sources">
135
135
  <ul>
136
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1674">datatypes.ts:1674</a></li>
136
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1919">datatypes.ts:1919</a></li>
137
137
  </ul>
138
138
  </aside>
139
139
  <div class="tsd-comment tsd-typography">
@@ -148,7 +148,7 @@
148
148
  <div class="tsd-signature tsd-kind-icon">public<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
149
149
  <aside class="tsd-sources">
150
150
  <ul>
151
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1672">datatypes.ts:1672</a></li>
151
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1917">datatypes.ts:1917</a></li>
152
152
  </ul>
153
153
  </aside>
154
154
  <div class="tsd-comment tsd-typography">
@@ -163,7 +163,7 @@
163
163
  <div class="tsd-signature tsd-kind-icon">ssh<wbr>Certificate<wbr>Authority<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
164
164
  <aside class="tsd-sources">
165
165
  <ul>
166
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1670">datatypes.ts:1670</a></li>
166
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1915">datatypes.ts:1915</a></li>
167
167
  </ul>
168
168
  </aside>
169
169
  <div class="tsd-comment tsd-typography">
@@ -175,10 +175,10 @@
175
175
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
176
176
  <a name="validAfter" class="tsd-anchor"></a>
177
177
  <h3>valid<wbr>After</h3>
178
- <div class="tsd-signature tsd-kind-icon">valid<wbr>After<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
178
+ <div class="tsd-signature tsd-kind-icon">valid<wbr>After<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
179
179
  <aside class="tsd-sources">
180
180
  <ul>
181
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1676">datatypes.ts:1676</a></li>
181
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1921">datatypes.ts:1921</a></li>
182
182
  </ul>
183
183
  </aside>
184
184
  <div class="tsd-comment tsd-typography">
@@ -190,10 +190,10 @@
190
190
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
191
191
  <a name="validUntil" class="tsd-anchor"></a>
192
192
  <h3>valid<wbr>Until</h3>
193
- <div class="tsd-signature tsd-kind-icon">valid<wbr>Until<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
193
+ <div class="tsd-signature tsd-kind-icon">valid<wbr>Until<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
194
194
  <aside class="tsd-sources">
195
195
  <ul>
196
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1678">datatypes.ts:1678</a></li>
196
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1923">datatypes.ts:1923</a></li>
197
197
  </ul>
198
198
  </aside>
199
199
  <div class="tsd-comment tsd-typography">
@@ -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#L1726">datatypes.ts:1726</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1971">datatypes.ts:1971</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">ssh<wbr>Host<wbr>Certificates<span class="tsd-signature-symbol">:</span> <a href="datatypes.SSHHostCertificate.html" class="tsd-signature-type" data-tsd-kind="Interface">SSHHostCertificate</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#L1722">datatypes.ts:1722</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1967">datatypes.ts:1967</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#L1724">datatypes.ts:1724</a></li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1969">datatypes.ts:1969</a></li>
133
133
  </ul>
134
134
  </aside>
135
135
  <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#L1688">datatypes.ts:1688</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1933">datatypes.ts:1933</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#L1686">datatypes.ts:1686</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1931">datatypes.ts:1931</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#L1690">datatypes.ts:1690</a></li>
127
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1935">datatypes.ts:1935</a></li>
128
128
  </ul>
129
129
  </aside>
130
130
  <div class="tsd-comment tsd-typography">
@@ -110,7 +110,7 @@
110
110
  <div class="tsd-signature tsd-kind-icon">certificate<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
111
111
  <aside class="tsd-sources">
112
112
  <ul>
113
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1786">datatypes.ts:1786</a></li>
113
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L2031">datatypes.ts:2031</a></li>
114
114
  </ul>
115
115
  </aside>
116
116
  <div class="tsd-comment tsd-typography">
@@ -122,10 +122,10 @@
122
122
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
123
123
  <a name="createdAt" class="tsd-anchor"></a>
124
124
  <h3>created<wbr>At</h3>
125
- <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
125
+ <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
126
126
  <aside class="tsd-sources">
127
127
  <ul>
128
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1764">datatypes.ts:1764</a></li>
128
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L2009">datatypes.ts:2009</a></li>
129
129
  </ul>
130
130
  </aside>
131
131
  <div class="tsd-comment tsd-typography">
@@ -140,7 +140,7 @@
140
140
  <div class="tsd-signature tsd-kind-icon">critical<wbr>Options<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
141
141
  <aside class="tsd-sources">
142
142
  <ul>
143
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1778">datatypes.ts:1778</a></li>
143
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L2023">datatypes.ts:2023</a></li>
144
144
  </ul>
145
145
  </aside>
146
146
  <div class="tsd-comment tsd-typography">
@@ -151,11 +151,11 @@
151
151
  </section>
152
152
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
153
153
  <a name="description" class="tsd-anchor"></a>
154
- <h3>description</h3>
154
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
155
155
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
156
156
  <aside class="tsd-sources">
157
157
  <ul>
158
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1766">datatypes.ts:1766</a></li>
158
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L2011">datatypes.ts:2011</a></li>
159
159
  </ul>
160
160
  </aside>
161
161
  <div class="tsd-comment tsd-typography">
@@ -170,7 +170,7 @@
170
170
  <div class="tsd-signature tsd-kind-icon">extensions<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Map</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">, </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">&gt;</span></div>
171
171
  <aside class="tsd-sources">
172
172
  <ul>
173
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1780">datatypes.ts:1780</a></li>
173
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L2025">datatypes.ts:2025</a></li>
174
174
  </ul>
175
175
  </aside>
176
176
  <div class="tsd-comment tsd-typography">
@@ -185,7 +185,7 @@
185
185
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
186
186
  <aside class="tsd-sources">
187
187
  <ul>
188
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1760">datatypes.ts:1760</a></li>
188
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L2005">datatypes.ts:2005</a></li>
189
189
  </ul>
190
190
  </aside>
191
191
  <div class="tsd-comment tsd-typography">
@@ -200,7 +200,7 @@
200
200
  <div class="tsd-signature tsd-kind-icon">key<wbr>Type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
201
201
  <aside class="tsd-sources">
202
202
  <ul>
203
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1772">datatypes.ts:1772</a></li>
203
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L2017">datatypes.ts:2017</a></li>
204
204
  </ul>
205
205
  </aside>
206
206
  <div class="tsd-comment tsd-typography">
@@ -211,11 +211,11 @@
211
211
  </section>
212
212
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
213
213
  <a name="metadata" class="tsd-anchor"></a>
214
- <h3>metadata</h3>
214
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
215
215
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
216
216
  <aside class="tsd-sources">
217
217
  <ul>
218
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1768">datatypes.ts:1768</a></li>
218
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L2013">datatypes.ts:2013</a></li>
219
219
  </ul>
220
220
  </aside>
221
221
  <div class="tsd-comment tsd-typography">
@@ -230,7 +230,7 @@
230
230
  <div class="tsd-signature tsd-kind-icon">principals<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">[]</span></div>
231
231
  <aside class="tsd-sources">
232
232
  <ul>
233
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1776">datatypes.ts:1776</a></li>
233
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L2021">datatypes.ts:2021</a></li>
234
234
  </ul>
235
235
  </aside>
236
236
  <div class="tsd-comment tsd-typography">
@@ -245,7 +245,7 @@
245
245
  <div class="tsd-signature tsd-kind-icon">public<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
246
246
  <aside class="tsd-sources">
247
247
  <ul>
248
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1770">datatypes.ts:1770</a></li>
248
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L2015">datatypes.ts:2015</a></li>
249
249
  </ul>
250
250
  </aside>
251
251
  <div class="tsd-comment tsd-typography">
@@ -260,7 +260,7 @@
260
260
  <div class="tsd-signature tsd-kind-icon">ssh<wbr>Certificate<wbr>Authority<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
261
261
  <aside class="tsd-sources">
262
262
  <ul>
263
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1774">datatypes.ts:1774</a></li>
263
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L2019">datatypes.ts:2019</a></li>
264
264
  </ul>
265
265
  </aside>
266
266
  <div class="tsd-comment tsd-typography">
@@ -275,7 +275,7 @@
275
275
  <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
276
276
  <aside class="tsd-sources">
277
277
  <ul>
278
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1762">datatypes.ts:1762</a></li>
278
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L2007">datatypes.ts:2007</a></li>
279
279
  </ul>
280
280
  </aside>
281
281
  <div class="tsd-comment tsd-typography">
@@ -287,10 +287,10 @@
287
287
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
288
288
  <a name="validAfter" class="tsd-anchor"></a>
289
289
  <h3>valid<wbr>After</h3>
290
- <div class="tsd-signature tsd-kind-icon">valid<wbr>After<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
290
+ <div class="tsd-signature tsd-kind-icon">valid<wbr>After<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
291
291
  <aside class="tsd-sources">
292
292
  <ul>
293
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1782">datatypes.ts:1782</a></li>
293
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L2027">datatypes.ts:2027</a></li>
294
294
  </ul>
295
295
  </aside>
296
296
  <div class="tsd-comment tsd-typography">
@@ -302,10 +302,10 @@
302
302
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
303
303
  <a name="validUntil" class="tsd-anchor"></a>
304
304
  <h3>valid<wbr>Until</h3>
305
- <div class="tsd-signature tsd-kind-icon">valid<wbr>Until<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
305
+ <div class="tsd-signature tsd-kind-icon">valid<wbr>Until<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
306
306
  <aside class="tsd-sources">
307
307
  <ul>
308
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/0593d03/src/datatypes.ts#L1784">datatypes.ts:1784</a></li>
308
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L2029">datatypes.ts:2029</a></li>
309
309
  </ul>
310
310
  </aside>
311
311
  <div class="tsd-comment tsd-typography">