@ngrok/ngrok-api 0.8.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 +30 -19
  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 +21 -12
  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 +21 -12
  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 +21 -12
  59. package/docs/index.html +30 -19
  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 +31 -12
  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 +3 -3
  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 +4 -4
  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 +20 -20
  214. package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +14 -14
  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 +10 -10
  241. package/docs/interfaces/datatypes.WeightedBackendCreate.html +6 -6
  242. package/docs/interfaces/datatypes.WeightedBackendList.html +3 -3
  243. package/docs/interfaces/datatypes.WeightedBackendUpdate.html +5 -5
  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 +400 -209
  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 +167 -129
  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 +17 -33
  267. package/src/datatypes.ts +421 -212
  268. package/src/index.ts +2 -0
  269. package/src/services.ts +771 -522
  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.CredentialCreate.html#acl" class="tsd-kind-icon">acl</a></li>
87
87
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.CredentialCreate.html#description" class="tsd-kind-icon">description</a></li>
88
88
  <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.CredentialCreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.CredentialCreate.html#ownerId" class="tsd-kind-icon">owner<wbr>Id</a></li>
89
90
  </ul>
90
91
  </section>
91
92
  </div>
@@ -99,22 +100,22 @@
99
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>
100
101
  <aside class="tsd-sources">
101
102
  <ul>
102
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L381">datatypes.ts:381</a></li>
103
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L564">datatypes.ts:564</a></li>
103
104
  </ul>
104
105
  </aside>
105
106
  <div class="tsd-comment tsd-typography">
106
107
  <div class="lead">
107
- <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>
108
109
  </div>
109
110
  </div>
110
111
  </section>
111
112
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
112
113
  <a name="description" class="tsd-anchor"></a>
113
- <h3>description</h3>
114
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
114
115
  <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
115
116
  <aside class="tsd-sources">
116
117
  <ul>
117
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L377">datatypes.ts:377</a></li>
118
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L560">datatypes.ts:560</a></li>
118
119
  </ul>
119
120
  </aside>
120
121
  <div class="tsd-comment tsd-typography">
@@ -125,11 +126,11 @@
125
126
  </section>
126
127
  <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
127
128
  <a name="metadata" class="tsd-anchor"></a>
128
- <h3>metadata</h3>
129
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
129
130
  <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
130
131
  <aside class="tsd-sources">
131
132
  <ul>
132
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L379">datatypes.ts:379</a></li>
133
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L562">datatypes.ts:562</a></li>
133
134
  </ul>
134
135
  </aside>
135
136
  <div class="tsd-comment tsd-typography">
@@ -138,6 +139,21 @@
138
139
  </div>
139
140
  </div>
140
141
  </section>
142
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
143
+ <a name="ownerId" class="tsd-anchor"></a>
144
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> owner<wbr>Id</h3>
145
+ <div class="tsd-signature tsd-kind-icon">owner<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
146
+ <aside class="tsd-sources">
147
+ <ul>
148
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L566">datatypes.ts:566</a></li>
149
+ </ul>
150
+ </aside>
151
+ <div class="tsd-comment tsd-typography">
152
+ <div class="lead">
153
+ <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>
154
+ </div>
155
+ </div>
156
+ </section>
141
157
  </section>
142
158
  </div>
143
159
  <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
@@ -173,6 +189,9 @@
173
189
  <li class=" tsd-kind-property tsd-parent-kind-interface">
174
190
  <a href="datatypes.CredentialCreate.html#metadata" class="tsd-kind-icon">metadata</a>
175
191
  </li>
192
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
193
+ <a href="datatypes.CredentialCreate.html#ownerId" class="tsd-kind-icon">owner<wbr>Id</a>
194
+ </li>
176
195
  </ul>
177
196
  </li>
178
197
  </ul>
@@ -99,7 +99,7 @@
99
99
  <div class="tsd-signature tsd-kind-icon">credentials<span class="tsd-signature-symbol">:</span> <a href="datatypes.Credential.html" class="tsd-signature-type" data-tsd-kind="Interface">Credential</a><span class="tsd-signature-symbol">[]</span></div>
100
100
  <aside class="tsd-sources">
101
101
  <ul>
102
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L413">datatypes.ts:413</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L600">datatypes.ts:600</a></li>
103
103
  </ul>
104
104
  </aside>
105
105
  <div class="tsd-comment tsd-typography">
@@ -114,7 +114,7 @@
114
114
  <div class="tsd-signature tsd-kind-icon">next<wbr>Page<wbr>Uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
115
115
  <aside class="tsd-sources">
116
116
  <ul>
117
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L417">datatypes.ts:417</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L604">datatypes.ts:604</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/2b8fd06/src/datatypes.ts#L415">datatypes.ts:415</a></li>
132
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L602">datatypes.ts:602</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/2b8fd06/src/datatypes.ts#L391">datatypes.ts:391</a></li>
103
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L576">datatypes.ts:576</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/2b8fd06/src/datatypes.ts#L387">datatypes.ts:387</a></li>
118
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L572">datatypes.ts:572</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/2b8fd06/src/datatypes.ts#L385">datatypes.ts:385</a></li>
133
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L570">datatypes.ts:570</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/2b8fd06/src/datatypes.ts#L389">datatypes.ts:389</a></li>
143
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L574">datatypes.ts:574</a></li>
144
144
  </ul>
145
145
  </aside>
146
146
  <div class="tsd-comment tsd-typography">
@@ -98,7 +98,7 @@
98
98
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
99
99
  <aside class="tsd-sources">
100
100
  <ul>
101
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L866">datatypes.ts:866</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1094">datatypes.ts:1094</a></li>
102
102
  </ul>
103
103
  </aside>
104
104
  </section>
@@ -108,7 +108,7 @@
108
108
  <div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointBackendMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointBackendMutate</a></div>
109
109
  <aside class="tsd-sources">
110
110
  <ul>
111
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L867">datatypes.ts:867</a></li>
111
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1095">datatypes.ts:1095</a></li>
112
112
  </ul>
113
113
  </aside>
114
114
  </section>
@@ -98,7 +98,7 @@
98
98
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
99
99
  <aside class="tsd-sources">
100
100
  <ul>
101
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L871">datatypes.ts:871</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1099">datatypes.ts:1099</a></li>
102
102
  </ul>
103
103
  </aside>
104
104
  </section>
@@ -108,7 +108,7 @@
108
108
  <div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointIPPolicyMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicyMutate</a></div>
109
109
  <aside class="tsd-sources">
110
110
  <ul>
111
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L872">datatypes.ts:872</a></li>
111
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1100">datatypes.ts:1100</a></li>
112
112
  </ul>
113
113
  </aside>
114
114
  </section>
@@ -98,7 +98,7 @@
98
98
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
99
99
  <aside class="tsd-sources">
100
100
  <ul>
101
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L876">datatypes.ts:876</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1104">datatypes.ts:1104</a></li>
102
102
  </ul>
103
103
  </aside>
104
104
  </section>
@@ -108,7 +108,7 @@
108
108
  <div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointMutualTLSMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointMutualTLSMutate</a></div>
109
109
  <aside class="tsd-sources">
110
110
  <ul>
111
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L877">datatypes.ts:877</a></li>
111
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1105">datatypes.ts:1105</a></li>
112
112
  </ul>
113
113
  </aside>
114
114
  </section>
@@ -99,7 +99,7 @@
99
99
  <div class="tsd-signature tsd-kind-icon">edge<wbr>Id<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/2b8fd06/src/datatypes.ts#L891">datatypes.ts:891</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1119">datatypes.ts:1119</a></li>
103
103
  </ul>
104
104
  </aside>
105
105
  </section>
@@ -109,7 +109,7 @@
109
109
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
110
110
  <aside class="tsd-sources">
111
111
  <ul>
112
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L892">datatypes.ts:892</a></li>
112
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1120">datatypes.ts:1120</a></li>
113
113
  </ul>
114
114
  </aside>
115
115
  </section>
@@ -119,7 +119,7 @@
119
119
  <div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointBackendMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointBackendMutate</a></div>
120
120
  <aside class="tsd-sources">
121
121
  <ul>
122
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L893">datatypes.ts:893</a></li>
122
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1121">datatypes.ts:1121</a></li>
123
123
  </ul>
124
124
  </aside>
125
125
  </section>
@@ -99,7 +99,7 @@
99
99
  <div class="tsd-signature tsd-kind-icon">edge<wbr>Id<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/2b8fd06/src/datatypes.ts#L921">datatypes.ts:921</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1149">datatypes.ts:1149</a></li>
103
103
  </ul>
104
104
  </aside>
105
105
  </section>
@@ -109,7 +109,7 @@
109
109
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
110
110
  <aside class="tsd-sources">
111
111
  <ul>
112
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L922">datatypes.ts:922</a></li>
112
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1150">datatypes.ts:1150</a></li>
113
113
  </ul>
114
114
  </aside>
115
115
  </section>
@@ -119,7 +119,7 @@
119
119
  <div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointCircuitBreaker.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointCircuitBreaker</a></div>
120
120
  <aside class="tsd-sources">
121
121
  <ul>
122
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L923">datatypes.ts:923</a></li>
122
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1151">datatypes.ts:1151</a></li>
123
123
  </ul>
124
124
  </aside>
125
125
  </section>
@@ -99,7 +99,7 @@
99
99
  <div class="tsd-signature tsd-kind-icon">edge<wbr>Id<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/2b8fd06/src/datatypes.ts#L915">datatypes.ts:915</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1143">datatypes.ts:1143</a></li>
103
103
  </ul>
104
104
  </aside>
105
105
  </section>
@@ -109,7 +109,7 @@
109
109
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
110
110
  <aside class="tsd-sources">
111
111
  <ul>
112
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L916">datatypes.ts:916</a></li>
112
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1144">datatypes.ts:1144</a></li>
113
113
  </ul>
114
114
  </aside>
115
115
  </section>
@@ -119,7 +119,7 @@
119
119
  <div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointCompression.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointCompression</a></div>
120
120
  <aside class="tsd-sources">
121
121
  <ul>
122
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L917">datatypes.ts:917</a></li>
122
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1145">datatypes.ts:1145</a></li>
123
123
  </ul>
124
124
  </aside>
125
125
  </section>
@@ -99,7 +99,7 @@
99
99
  <div class="tsd-signature tsd-kind-icon">edge<wbr>Id<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/2b8fd06/src/datatypes.ts#L897">datatypes.ts:897</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1125">datatypes.ts:1125</a></li>
103
103
  </ul>
104
104
  </aside>
105
105
  </section>
@@ -109,7 +109,7 @@
109
109
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
110
110
  <aside class="tsd-sources">
111
111
  <ul>
112
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L898">datatypes.ts:898</a></li>
112
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1126">datatypes.ts:1126</a></li>
113
113
  </ul>
114
114
  </aside>
115
115
  </section>
@@ -119,7 +119,7 @@
119
119
  <div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointIPPolicyMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointIPPolicyMutate</a></div>
120
120
  <aside class="tsd-sources">
121
121
  <ul>
122
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L899">datatypes.ts:899</a></li>
122
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1127">datatypes.ts:1127</a></li>
123
123
  </ul>
124
124
  </aside>
125
125
  </section>
@@ -98,7 +98,7 @@
98
98
  <div class="tsd-signature tsd-kind-icon">edge<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
99
99
  <aside class="tsd-sources">
100
100
  <ul>
101
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L692">datatypes.ts:692</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L920">datatypes.ts:920</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">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
114
114
  <aside class="tsd-sources">
115
115
  <ul>
116
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L694">datatypes.ts:694</a></li>
116
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L922">datatypes.ts:922</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">edge<wbr>Id<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/2b8fd06/src/datatypes.ts#L933">datatypes.ts:933</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1161">datatypes.ts:1161</a></li>
103
103
  </ul>
104
104
  </aside>
105
105
  </section>
@@ -109,7 +109,7 @@
109
109
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
110
110
  <aside class="tsd-sources">
111
111
  <ul>
112
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L934">datatypes.ts:934</a></li>
112
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1162">datatypes.ts:1162</a></li>
113
113
  </ul>
114
114
  </aside>
115
115
  </section>
@@ -119,7 +119,7 @@
119
119
  <div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOAuth.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOAuth</a></div>
120
120
  <aside class="tsd-sources">
121
121
  <ul>
122
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L935">datatypes.ts:935</a></li>
122
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1163">datatypes.ts:1163</a></li>
123
123
  </ul>
124
124
  </aside>
125
125
  </section>
@@ -99,7 +99,7 @@
99
99
  <div class="tsd-signature tsd-kind-icon">edge<wbr>Id<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/2b8fd06/src/datatypes.ts#L945">datatypes.ts:945</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1173">datatypes.ts:1173</a></li>
103
103
  </ul>
104
104
  </aside>
105
105
  </section>
@@ -109,7 +109,7 @@
109
109
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
110
110
  <aside class="tsd-sources">
111
111
  <ul>
112
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L946">datatypes.ts:946</a></li>
112
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1174">datatypes.ts:1174</a></li>
113
113
  </ul>
114
114
  </aside>
115
115
  </section>
@@ -119,7 +119,7 @@
119
119
  <div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointOIDC.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointOIDC</a></div>
120
120
  <aside class="tsd-sources">
121
121
  <ul>
122
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L947">datatypes.ts:947</a></li>
122
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1175">datatypes.ts:1175</a></li>
123
123
  </ul>
124
124
  </aside>
125
125
  </section>
@@ -99,7 +99,7 @@
99
99
  <div class="tsd-signature tsd-kind-icon">edge<wbr>Id<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/2b8fd06/src/datatypes.ts#L903">datatypes.ts:903</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1131">datatypes.ts:1131</a></li>
103
103
  </ul>
104
104
  </aside>
105
105
  </section>
@@ -109,7 +109,7 @@
109
109
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
110
110
  <aside class="tsd-sources">
111
111
  <ul>
112
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L904">datatypes.ts:904</a></li>
112
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1132">datatypes.ts:1132</a></li>
113
113
  </ul>
114
114
  </aside>
115
115
  </section>
@@ -119,7 +119,7 @@
119
119
  <div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointRequestHeaders.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointRequestHeaders</a></div>
120
120
  <aside class="tsd-sources">
121
121
  <ul>
122
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L905">datatypes.ts:905</a></li>
122
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1133">datatypes.ts:1133</a></li>
123
123
  </ul>
124
124
  </aside>
125
125
  </section>
@@ -99,7 +99,7 @@
99
99
  <div class="tsd-signature tsd-kind-icon">edge<wbr>Id<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/2b8fd06/src/datatypes.ts#L909">datatypes.ts:909</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1137">datatypes.ts:1137</a></li>
103
103
  </ul>
104
104
  </aside>
105
105
  </section>
@@ -109,7 +109,7 @@
109
109
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
110
110
  <aside class="tsd-sources">
111
111
  <ul>
112
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L910">datatypes.ts:910</a></li>
112
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1138">datatypes.ts:1138</a></li>
113
113
  </ul>
114
114
  </aside>
115
115
  </section>
@@ -119,7 +119,7 @@
119
119
  <div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointResponseHeaders.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointResponseHeaders</a></div>
120
120
  <aside class="tsd-sources">
121
121
  <ul>
122
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L911">datatypes.ts:911</a></li>
122
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1139">datatypes.ts:1139</a></li>
123
123
  </ul>
124
124
  </aside>
125
125
  </section>
@@ -99,7 +99,7 @@
99
99
  <div class="tsd-signature tsd-kind-icon">edge<wbr>Id<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/2b8fd06/src/datatypes.ts#L939">datatypes.ts:939</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1167">datatypes.ts:1167</a></li>
103
103
  </ul>
104
104
  </aside>
105
105
  </section>
@@ -109,7 +109,7 @@
109
109
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
110
110
  <aside class="tsd-sources">
111
111
  <ul>
112
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L940">datatypes.ts:940</a></li>
112
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1168">datatypes.ts:1168</a></li>
113
113
  </ul>
114
114
  </aside>
115
115
  </section>
@@ -119,7 +119,7 @@
119
119
  <div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointSAMLMutate.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointSAMLMutate</a></div>
120
120
  <aside class="tsd-sources">
121
121
  <ul>
122
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L941">datatypes.ts:941</a></li>
122
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1169">datatypes.ts:1169</a></li>
123
123
  </ul>
124
124
  </aside>
125
125
  </section>
@@ -99,7 +99,7 @@
99
99
  <div class="tsd-signature tsd-kind-icon">edge<wbr>Id<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/2b8fd06/src/datatypes.ts#L927">datatypes.ts:927</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1155">datatypes.ts:1155</a></li>
103
103
  </ul>
104
104
  </aside>
105
105
  </section>
@@ -109,7 +109,7 @@
109
109
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
110
110
  <aside class="tsd-sources">
111
111
  <ul>
112
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L928">datatypes.ts:928</a></li>
112
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1156">datatypes.ts:1156</a></li>
113
113
  </ul>
114
114
  </aside>
115
115
  </section>
@@ -119,7 +119,7 @@
119
119
  <div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointWebhookValidation.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointWebhookValidation</a></div>
120
120
  <aside class="tsd-sources">
121
121
  <ul>
122
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L929">datatypes.ts:929</a></li>
122
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1157">datatypes.ts:1157</a></li>
123
123
  </ul>
124
124
  </aside>
125
125
  </section>
@@ -99,7 +99,7 @@
99
99
  <div class="tsd-signature tsd-kind-icon">edge<wbr>Id<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/2b8fd06/src/datatypes.ts#L951">datatypes.ts:951</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1179">datatypes.ts:1179</a></li>
103
103
  </ul>
104
104
  </aside>
105
105
  </section>
@@ -109,7 +109,7 @@
109
109
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
110
110
  <aside class="tsd-sources">
111
111
  <ul>
112
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L952">datatypes.ts:952</a></li>
112
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1180">datatypes.ts:1180</a></li>
113
113
  </ul>
114
114
  </aside>
115
115
  </section>
@@ -119,7 +119,7 @@
119
119
  <div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointWebsocketTCPConverter.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointWebsocketTCPConverter</a></div>
120
120
  <aside class="tsd-sources">
121
121
  <ul>
122
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L953">datatypes.ts:953</a></li>
122
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1181">datatypes.ts:1181</a></li>
123
123
  </ul>
124
124
  </aside>
125
125
  </section>
@@ -98,7 +98,7 @@
98
98
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
99
99
  <aside class="tsd-sources">
100
100
  <ul>
101
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L886">datatypes.ts:886</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1114">datatypes.ts:1114</a></li>
102
102
  </ul>
103
103
  </aside>
104
104
  </section>
@@ -108,7 +108,7 @@
108
108
  <div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointTLSTerminationAtEdge.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTLSTerminationAtEdge</a></div>
109
109
  <aside class="tsd-sources">
110
110
  <ul>
111
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L887">datatypes.ts:887</a></li>
111
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1115">datatypes.ts:1115</a></li>
112
112
  </ul>
113
113
  </aside>
114
114
  </section>
@@ -98,7 +98,7 @@
98
98
  <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
99
99
  <aside class="tsd-sources">
100
100
  <ul>
101
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L881">datatypes.ts:881</a></li>
101
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1109">datatypes.ts:1109</a></li>
102
102
  </ul>
103
103
  </aside>
104
104
  </section>
@@ -108,7 +108,7 @@
108
108
  <div class="tsd-signature tsd-kind-icon">module<span class="tsd-signature-symbol">:</span> <a href="datatypes.EndpointTLSTermination.html" class="tsd-signature-type" data-tsd-kind="Interface">EndpointTLSTermination</a></div>
109
109
  <aside class="tsd-sources">
110
110
  <ul>
111
- <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/2b8fd06/src/datatypes.ts#L882">datatypes.ts:882</a></li>
111
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/9fd8564/src/datatypes.ts#L1110">datatypes.ts:1110</a></li>
112
112
  </ul>
113
113
  </aside>
114
114
  </section>