@ngrok/ngrok-api 0.13.0 → 0.17.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 (289) hide show
  1. package/.github/workflows/ci.yml +28 -0
  2. package/CHANGELOG.md +15 -0
  3. package/docs/assets/js/search.js +1 -1
  4. package/docs/classes/client.Ngrok.html +66 -28
  5. package/docs/classes/services.APIKeys.html +6 -6
  6. package/docs/classes/services.AbuseReports.html +3 -3
  7. package/docs/classes/services.AgentIngresses.html +6 -6
  8. package/docs/classes/services.ApplicationSessions.html +4 -4
  9. package/docs/classes/services.ApplicationUsers.html +4 -4
  10. package/docs/classes/services.BotUsers.html +6 -6
  11. package/docs/classes/services.CertificateAuthorities.html +6 -6
  12. package/docs/classes/services.Credentials.html +6 -6
  13. package/docs/classes/services.EdgeRouteBackendModule.html +4 -4
  14. package/docs/classes/services.EdgeRouteCircuitBreakerModule.html +4 -4
  15. package/docs/classes/services.EdgeRouteCompressionModule.html +4 -4
  16. package/docs/classes/services.EdgeRouteIPRestrictionModule.html +4 -4
  17. package/docs/classes/services.EdgeRouteOAuthModule.html +4 -4
  18. package/docs/classes/services.EdgeRouteOIDCModule.html +4 -4
  19. package/docs/classes/services.EdgeRouteRequestHeadersModule.html +4 -4
  20. package/docs/classes/services.EdgeRouteResponseHeadersModule.html +4 -4
  21. package/docs/classes/services.EdgeRouteSAMLModule.html +4 -4
  22. package/docs/classes/services.EdgeRouteTrafficPolicyModule.html +4 -4
  23. package/docs/classes/services.EdgeRouteUserAgentFilterModule.html +4 -4
  24. package/docs/classes/services.EdgeRouteWebhookVerificationModule.html +4 -4
  25. package/docs/classes/services.EdgeRouteWebsocketTCPConverterModule.html +4 -4
  26. package/docs/classes/services.EdgesHTTPS.html +6 -6
  27. package/docs/classes/services.EdgesHTTPSRoutes.html +5 -5
  28. package/docs/classes/services.EdgesTCP.html +6 -6
  29. package/docs/classes/services.EdgesTLS.html +6 -6
  30. package/docs/classes/services.Endpoints.html +6 -6
  31. package/docs/classes/services.EventDestinations.html +6 -6
  32. package/docs/classes/services.EventSources.html +6 -6
  33. package/docs/classes/services.EventSubscriptions.html +6 -6
  34. package/docs/classes/services.FailoverBackends.html +6 -6
  35. package/docs/classes/services.HTTPResponseBackends.html +6 -6
  36. package/docs/classes/services.HTTPSEdgeMutualTLSModule.html +4 -4
  37. package/docs/classes/services.HTTPSEdgeTLSTerminationModule.html +4 -4
  38. package/docs/classes/services.IPPolicies.html +6 -6
  39. package/docs/classes/services.IPPolicyRules.html +6 -6
  40. package/docs/classes/services.IPRestrictions.html +6 -6
  41. package/docs/classes/services.ReservedAddrs.html +6 -6
  42. package/docs/classes/services.ReservedDomains.html +8 -8
  43. package/docs/classes/services.SSHCertificateAuthorities.html +6 -6
  44. package/docs/classes/services.SSHCredentials.html +6 -6
  45. package/docs/classes/services.SSHHostCertificates.html +6 -6
  46. package/docs/classes/services.SSHUserCertificates.html +6 -6
  47. package/docs/classes/services.Secrets.html +359 -0
  48. package/docs/classes/services.StaticBackends.html +6 -6
  49. package/docs/classes/services.TCPEdgeBackendModule.html +4 -4
  50. package/docs/classes/services.TCPEdgeIPRestrictionModule.html +4 -4
  51. package/docs/classes/services.TCPEdgeTrafficPolicyModule.html +4 -4
  52. package/docs/classes/services.TLSCertificates.html +6 -6
  53. package/docs/classes/services.TLSEdgeBackendModule.html +4 -4
  54. package/docs/classes/services.TLSEdgeIPRestrictionModule.html +4 -4
  55. package/docs/classes/services.TLSEdgeMutualTLSModule.html +4 -4
  56. package/docs/classes/services.TLSEdgeTLSTerminationModule.html +4 -4
  57. package/docs/classes/services.TLSEdgeTrafficPolicyModule.html +4 -4
  58. package/docs/classes/services.TunnelGroupBackends.html +6 -6
  59. package/docs/classes/services.TunnelSessions.html +6 -6
  60. package/docs/classes/services.Tunnels.html +3 -3
  61. package/docs/classes/services.Vaults.html +397 -0
  62. package/docs/classes/services.WeightedBackends.html +6 -6
  63. package/docs/interfaces/client.NgrokConfig.html +2 -2
  64. package/docs/interfaces/datatypes.APIKey.html +7 -7
  65. package/docs/interfaces/datatypes.APIKeyCreate.html +3 -3
  66. package/docs/interfaces/datatypes.APIKeyList.html +3 -3
  67. package/docs/interfaces/datatypes.APIKeyUpdate.html +3 -3
  68. package/docs/interfaces/datatypes.AWSAuth.html +2 -2
  69. package/docs/interfaces/datatypes.AWSCredentials.html +2 -2
  70. package/docs/interfaces/datatypes.AWSRole.html +1 -1
  71. package/docs/interfaces/datatypes.AbuseReport.html +7 -7
  72. package/docs/interfaces/datatypes.AbuseReportCreate.html +2 -2
  73. package/docs/interfaces/datatypes.AbuseReportHostname.html +2 -2
  74. package/docs/interfaces/datatypes.AgentIngress.html +10 -10
  75. package/docs/interfaces/datatypes.AgentIngressCertJob.html +4 -4
  76. package/docs/interfaces/datatypes.AgentIngressCertPolicy.html +2 -2
  77. package/docs/interfaces/datatypes.AgentIngressCertStatus.html +2 -2
  78. package/docs/interfaces/datatypes.AgentIngressCreate.html +4 -4
  79. package/docs/interfaces/datatypes.AgentIngressList.html +3 -3
  80. package/docs/interfaces/datatypes.AgentIngressUpdate.html +4 -4
  81. package/docs/interfaces/datatypes.ApplicationSession.html +11 -11
  82. package/docs/interfaces/datatypes.ApplicationSessionList.html +3 -3
  83. package/docs/interfaces/datatypes.ApplicationUser.html +10 -10
  84. package/docs/interfaces/datatypes.ApplicationUserList.html +3 -3
  85. package/docs/interfaces/datatypes.BotUser.html +5 -5
  86. package/docs/interfaces/datatypes.BotUserCreate.html +2 -2
  87. package/docs/interfaces/datatypes.BotUserList.html +3 -3
  88. package/docs/interfaces/datatypes.BotUserUpdate.html +3 -3
  89. package/docs/interfaces/datatypes.BrowserSession.html +3 -3
  90. package/docs/interfaces/datatypes.CertificateAuthority.html +11 -11
  91. package/docs/interfaces/datatypes.CertificateAuthorityCreate.html +3 -3
  92. package/docs/interfaces/datatypes.CertificateAuthorityList.html +3 -3
  93. package/docs/interfaces/datatypes.CertificateAuthorityUpdate.html +3 -3
  94. package/docs/interfaces/datatypes.Credential.html +8 -8
  95. package/docs/interfaces/datatypes.CredentialCreate.html +4 -4
  96. package/docs/interfaces/datatypes.CredentialList.html +3 -3
  97. package/docs/interfaces/datatypes.CredentialUpdate.html +4 -4
  98. package/docs/interfaces/datatypes.EdgeBackendReplace.html +2 -2
  99. package/docs/interfaces/datatypes.EdgeIPRestrictionReplace.html +2 -2
  100. package/docs/interfaces/datatypes.EdgeMutualTLSReplace.html +2 -2
  101. package/docs/interfaces/datatypes.EdgeRouteBackendReplace.html +3 -3
  102. package/docs/interfaces/datatypes.EdgeRouteCircuitBreakerReplace.html +3 -3
  103. package/docs/interfaces/datatypes.EdgeRouteCompressionReplace.html +3 -3
  104. package/docs/interfaces/datatypes.EdgeRouteIPRestrictionReplace.html +3 -3
  105. package/docs/interfaces/datatypes.EdgeRouteItem.html +2 -2
  106. package/docs/interfaces/datatypes.EdgeRouteOAuthReplace.html +3 -3
  107. package/docs/interfaces/datatypes.EdgeRouteOIDCReplace.html +3 -3
  108. package/docs/interfaces/datatypes.EdgeRouteRequestHeadersReplace.html +3 -3
  109. package/docs/interfaces/datatypes.EdgeRouteResponseHeadersReplace.html +3 -3
  110. package/docs/interfaces/datatypes.EdgeRouteSAMLReplace.html +3 -3
  111. package/docs/interfaces/datatypes.EdgeRouteTrafficPolicyReplace.html +3 -3
  112. package/docs/interfaces/datatypes.EdgeRouteUserAgentFilterReplace.html +3 -3
  113. package/docs/interfaces/datatypes.EdgeRouteWebhookVerificationReplace.html +3 -3
  114. package/docs/interfaces/datatypes.EdgeRouteWebsocketTCPConverterReplace.html +3 -3
  115. package/docs/interfaces/datatypes.EdgeTLSTerminationAtEdgeReplace.html +2 -2
  116. package/docs/interfaces/datatypes.EdgeTLSTerminationReplace.html +2 -2
  117. package/docs/interfaces/datatypes.EdgeTrafficPolicyReplace.html +2 -2
  118. package/docs/interfaces/datatypes.Endpoint.html +51 -51
  119. package/docs/interfaces/datatypes.EndpointBackend.html +2 -2
  120. package/docs/interfaces/datatypes.EndpointBackendMutate.html +2 -2
  121. package/docs/interfaces/datatypes.EndpointCircuitBreaker.html +6 -6
  122. package/docs/interfaces/datatypes.EndpointCompression.html +1 -1
  123. package/docs/interfaces/datatypes.EndpointCreate.html +21 -7
  124. package/docs/interfaces/datatypes.EndpointIPPolicy.html +2 -2
  125. package/docs/interfaces/datatypes.EndpointIPPolicyMutate.html +2 -2
  126. package/docs/interfaces/datatypes.EndpointList.html +3 -3
  127. package/docs/interfaces/datatypes.EndpointListArgs.html +204 -0
  128. package/docs/interfaces/datatypes.EndpointMutualTLS.html +2 -2
  129. package/docs/interfaces/datatypes.EndpointMutualTLSMutate.html +2 -2
  130. package/docs/interfaces/datatypes.EndpointOAuth.html +7 -7
  131. package/docs/interfaces/datatypes.EndpointOAuthAmazon.html +5 -5
  132. package/docs/interfaces/datatypes.EndpointOAuthFacebook.html +5 -5
  133. package/docs/interfaces/datatypes.EndpointOAuthGitHub.html +7 -7
  134. package/docs/interfaces/datatypes.EndpointOAuthGitLab.html +5 -5
  135. package/docs/interfaces/datatypes.EndpointOAuthGoogle.html +5 -5
  136. package/docs/interfaces/datatypes.EndpointOAuthLinkedIn.html +5 -5
  137. package/docs/interfaces/datatypes.EndpointOAuthMicrosoft.html +5 -5
  138. package/docs/interfaces/datatypes.EndpointOAuthProvider.html +8 -8
  139. package/docs/interfaces/datatypes.EndpointOAuthTwitch.html +5 -5
  140. package/docs/interfaces/datatypes.EndpointOIDC.html +9 -9
  141. package/docs/interfaces/datatypes.EndpointRequestHeaders.html +3 -3
  142. package/docs/interfaces/datatypes.EndpointResponseHeaders.html +3 -3
  143. package/docs/interfaces/datatypes.EndpointSAML.html +15 -15
  144. package/docs/interfaces/datatypes.EndpointSAMLMutate.html +10 -10
  145. package/docs/interfaces/datatypes.EndpointTLSTermination.html +3 -3
  146. package/docs/interfaces/datatypes.EndpointTLSTerminationAtEdge.html +2 -2
  147. package/docs/interfaces/datatypes.EndpointTrafficPolicy.html +2 -2
  148. package/docs/interfaces/datatypes.EndpointUpdate.html +20 -6
  149. package/docs/interfaces/datatypes.EndpointUserAgentFilter.html +3 -3
  150. package/docs/interfaces/datatypes.EndpointWebhookValidation.html +3 -3
  151. package/docs/interfaces/datatypes.EndpointWebsocketTCPConverter.html +1 -1
  152. package/docs/interfaces/datatypes.Error.html +4 -4
  153. package/docs/interfaces/datatypes.EventDestination.html +7 -7
  154. package/docs/interfaces/datatypes.EventDestinationCreate.html +4 -4
  155. package/docs/interfaces/datatypes.EventDestinationList.html +3 -3
  156. package/docs/interfaces/datatypes.EventDestinationUpdate.html +5 -5
  157. package/docs/interfaces/datatypes.EventSource.html +2 -2
  158. package/docs/interfaces/datatypes.EventSourceCreate.html +2 -2
  159. package/docs/interfaces/datatypes.EventSourceItem.html +2 -2
  160. package/docs/interfaces/datatypes.EventSourceList.html +2 -2
  161. package/docs/interfaces/datatypes.EventSourcePaging.html +1 -1
  162. package/docs/interfaces/datatypes.EventSourceReplace.html +1 -1
  163. package/docs/interfaces/datatypes.EventSourceUpdate.html +2 -2
  164. package/docs/interfaces/datatypes.EventSubscription.html +7 -7
  165. package/docs/interfaces/datatypes.EventSubscriptionCreate.html +4 -4
  166. package/docs/interfaces/datatypes.EventSubscriptionList.html +3 -3
  167. package/docs/interfaces/datatypes.EventSubscriptionUpdate.html +5 -5
  168. package/docs/interfaces/datatypes.EventTarget.html +5 -5
  169. package/docs/interfaces/datatypes.EventTargetAzureLogsIngestion.html +6 -6
  170. package/docs/interfaces/datatypes.EventTargetCloudwatchLogs.html +2 -2
  171. package/docs/interfaces/datatypes.EventTargetDatadog.html +4 -4
  172. package/docs/interfaces/datatypes.EventTargetFirehose.html +2 -2
  173. package/docs/interfaces/datatypes.EventTargetKinesis.html +2 -2
  174. package/docs/interfaces/datatypes.FailoverBackend.html +6 -6
  175. package/docs/interfaces/datatypes.FailoverBackendCreate.html +3 -3
  176. package/docs/interfaces/datatypes.FailoverBackendList.html +3 -3
  177. package/docs/interfaces/datatypes.FailoverBackendUpdate.html +4 -4
  178. package/docs/interfaces/datatypes.HTTPResponseBackend.html +8 -8
  179. package/docs/interfaces/datatypes.HTTPResponseBackendCreate.html +5 -5
  180. package/docs/interfaces/datatypes.HTTPResponseBackendList.html +3 -3
  181. package/docs/interfaces/datatypes.HTTPResponseBackendUpdate.html +6 -6
  182. package/docs/interfaces/datatypes.HTTPSEdge.html +9 -9
  183. package/docs/interfaces/datatypes.HTTPSEdgeCreate.html +5 -5
  184. package/docs/interfaces/datatypes.HTTPSEdgeList.html +3 -3
  185. package/docs/interfaces/datatypes.HTTPSEdgeRoute.html +21 -21
  186. package/docs/interfaces/datatypes.HTTPSEdgeRouteCreate.html +18 -18
  187. package/docs/interfaces/datatypes.HTTPSEdgeRouteUpdate.html +19 -19
  188. package/docs/interfaces/datatypes.HTTPSEdgeUpdate.html +6 -6
  189. package/docs/interfaces/datatypes.IPPolicy.html +5 -5
  190. package/docs/interfaces/datatypes.IPPolicyCreate.html +2 -2
  191. package/docs/interfaces/datatypes.IPPolicyList.html +3 -3
  192. package/docs/interfaces/datatypes.IPPolicyRule.html +8 -8
  193. package/docs/interfaces/datatypes.IPPolicyRuleCreate.html +5 -5
  194. package/docs/interfaces/datatypes.IPPolicyRuleList.html +3 -3
  195. package/docs/interfaces/datatypes.IPPolicyRuleUpdate.html +4 -4
  196. package/docs/interfaces/datatypes.IPPolicyUpdate.html +3 -3
  197. package/docs/interfaces/datatypes.IPRestriction.html +8 -8
  198. package/docs/interfaces/datatypes.IPRestrictionCreate.html +5 -5
  199. package/docs/interfaces/datatypes.IPRestrictionList.html +3 -3
  200. package/docs/interfaces/datatypes.IPRestrictionUpdate.html +5 -5
  201. package/docs/interfaces/datatypes.IdentityProvider.html +2 -2
  202. package/docs/interfaces/datatypes.Item.html +1 -1
  203. package/docs/interfaces/datatypes.ItemPaging.html +195 -0
  204. package/docs/interfaces/datatypes.Location.html +4 -4
  205. package/docs/interfaces/datatypes.Paging.html +2 -2
  206. package/docs/interfaces/datatypes.Ref.html +2 -2
  207. package/docs/interfaces/datatypes.ReservedAddr.html +7 -7
  208. package/docs/interfaces/datatypes.ReservedAddrCreate.html +3 -3
  209. package/docs/interfaces/datatypes.ReservedAddrList.html +3 -3
  210. package/docs/interfaces/datatypes.ReservedAddrUpdate.html +3 -3
  211. package/docs/interfaces/datatypes.ReservedDomain.html +12 -12
  212. package/docs/interfaces/datatypes.ReservedDomainCertJob.html +4 -4
  213. package/docs/interfaces/datatypes.ReservedDomainCertPolicy.html +2 -2
  214. package/docs/interfaces/datatypes.ReservedDomainCertStatus.html +2 -2
  215. package/docs/interfaces/datatypes.ReservedDomainCreate.html +6 -6
  216. package/docs/interfaces/datatypes.ReservedDomainList.html +3 -3
  217. package/docs/interfaces/datatypes.ReservedDomainUpdate.html +5 -5
  218. package/docs/interfaces/datatypes.SSHCertificateAuthority.html +7 -7
  219. package/docs/interfaces/datatypes.SSHCertificateAuthorityCreate.html +5 -5
  220. package/docs/interfaces/datatypes.SSHCertificateAuthorityList.html +3 -3
  221. package/docs/interfaces/datatypes.SSHCertificateAuthorityUpdate.html +3 -3
  222. package/docs/interfaces/datatypes.SSHCredential.html +8 -8
  223. package/docs/interfaces/datatypes.SSHCredentialCreate.html +5 -5
  224. package/docs/interfaces/datatypes.SSHCredentialList.html +3 -3
  225. package/docs/interfaces/datatypes.SSHCredentialUpdate.html +4 -4
  226. package/docs/interfaces/datatypes.SSHHostCertificate.html +12 -12
  227. package/docs/interfaces/datatypes.SSHHostCertificateCreate.html +7 -7
  228. package/docs/interfaces/datatypes.SSHHostCertificateList.html +3 -3
  229. package/docs/interfaces/datatypes.SSHHostCertificateUpdate.html +3 -3
  230. package/docs/interfaces/datatypes.SSHUserCertificate.html +14 -14
  231. package/docs/interfaces/datatypes.SSHUserCertificateCreate.html +9 -9
  232. package/docs/interfaces/datatypes.SSHUserCertificateList.html +3 -3
  233. package/docs/interfaces/datatypes.SSHUserCertificateUpdate.html +3 -3
  234. package/docs/interfaces/datatypes.Secret.html +338 -0
  235. package/docs/interfaces/datatypes.SecretCreate.html +243 -0
  236. package/docs/interfaces/datatypes.SecretList.html +200 -0
  237. package/docs/interfaces/datatypes.SecretUpdate.html +243 -0
  238. package/docs/interfaces/datatypes.StaticBackend.html +7 -7
  239. package/docs/interfaces/datatypes.StaticBackendCreate.html +4 -4
  240. package/docs/interfaces/datatypes.StaticBackendList.html +3 -3
  241. package/docs/interfaces/datatypes.StaticBackendTLS.html +1 -1
  242. package/docs/interfaces/datatypes.StaticBackendUpdate.html +5 -5
  243. package/docs/interfaces/datatypes.TCPEdge.html +9 -9
  244. package/docs/interfaces/datatypes.TCPEdgeCreate.html +6 -6
  245. package/docs/interfaces/datatypes.TCPEdgeList.html +3 -3
  246. package/docs/interfaces/datatypes.TCPEdgeUpdate.html +7 -7
  247. package/docs/interfaces/datatypes.TLSCertificate.html +21 -21
  248. package/docs/interfaces/datatypes.TLSCertificateCreate.html +4 -4
  249. package/docs/interfaces/datatypes.TLSCertificateList.html +3 -3
  250. package/docs/interfaces/datatypes.TLSCertificateSANs.html +2 -2
  251. package/docs/interfaces/datatypes.TLSCertificateUpdate.html +3 -3
  252. package/docs/interfaces/datatypes.TLSEdge.html +11 -11
  253. package/docs/interfaces/datatypes.TLSEdgeCreate.html +8 -8
  254. package/docs/interfaces/datatypes.TLSEdgeList.html +3 -3
  255. package/docs/interfaces/datatypes.TLSEdgeUpdate.html +9 -9
  256. package/docs/interfaces/datatypes.Tunnel.html +11 -11
  257. package/docs/interfaces/datatypes.TunnelGroupBackend.html +7 -7
  258. package/docs/interfaces/datatypes.TunnelGroupBackendCreate.html +3 -3
  259. package/docs/interfaces/datatypes.TunnelGroupBackendList.html +3 -3
  260. package/docs/interfaces/datatypes.TunnelGroupBackendUpdate.html +4 -4
  261. package/docs/interfaces/datatypes.TunnelList.html +3 -3
  262. package/docs/interfaces/datatypes.TunnelSession.html +10 -10
  263. package/docs/interfaces/datatypes.TunnelSessionList.html +3 -3
  264. package/docs/interfaces/datatypes.TunnelSessionsUpdate.html +1 -1
  265. package/docs/interfaces/datatypes.UserAgent.html +6 -6
  266. package/docs/interfaces/datatypes.Vault.html +319 -0
  267. package/docs/interfaces/datatypes.VaultCreate.html +205 -0
  268. package/docs/interfaces/datatypes.VaultList.html +200 -0
  269. package/docs/interfaces/datatypes.VaultUpdate.html +224 -0
  270. package/docs/interfaces/datatypes.WeightedBackend.html +6 -6
  271. package/docs/interfaces/datatypes.WeightedBackendCreate.html +3 -3
  272. package/docs/interfaces/datatypes.WeightedBackendList.html +3 -3
  273. package/docs/interfaces/datatypes.WeightedBackendUpdate.html +4 -4
  274. package/docs/modules/datatypes.html +40 -0
  275. package/docs/modules/services.html +8 -0
  276. package/lib/client.d.ts +8 -0
  277. package/lib/client.d.ts.map +1 -1
  278. package/lib/client.js +3 -1
  279. package/lib/client.js.map +1 -1
  280. package/lib/datatypes.d.ts +117 -5
  281. package/lib/datatypes.d.ts.map +1 -1
  282. package/lib/services.d.ts +66 -0
  283. package/lib/services.d.ts.map +1 -1
  284. package/lib/services.js +289 -25
  285. package/lib/services.js.map +1 -1
  286. package/package.json +1 -1
  287. package/src/client.ts +11 -1
  288. package/src/datatypes.ts +127 -5
  289. package/src/services.ts +265 -2
@@ -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/d5a6bc0/src/datatypes.ts#L2211">datatypes.ts:2211</a></li>
102
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2284">datatypes.ts:2284</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/d5a6bc0/src/datatypes.ts#L2209">datatypes.ts:2209</a></li>
117
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2282">datatypes.ts:2282</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/d5a6bc0/src/datatypes.ts#L2213">datatypes.ts:2213</a></li>
127
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2286">datatypes.ts:2286</a></li>
128
128
  </ul>
129
129
  </aside>
130
130
  <div class="tsd-comment tsd-typography">
@@ -0,0 +1,338 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>Secret | @ngrok/ngrok-api</title>
7
+ <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ <script async src="../assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="../index.html" class="title">@ngrok/ngrok-api</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ <input type="checkbox" id="tsd-filter-externals" checked />
43
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
+ </div>
45
+ </div>
46
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
+ </div>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ <div class="tsd-page-title">
52
+ <div class="container">
53
+ <ul class="tsd-breadcrumb">
54
+ <li>
55
+ <a href="../modules.html">@ngrok/ngrok-api</a>
56
+ </li>
57
+ <li>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.Secret.html">Secret</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface Secret</h1>
65
+ </div>
66
+ </div>
67
+ </header>
68
+ <div class="container container-main">
69
+ <div class="row">
70
+ <div class="col-8 col-content">
71
+ <section class="tsd-panel tsd-hierarchy">
72
+ <h3>Hierarchy</h3>
73
+ <ul class="tsd-hierarchy">
74
+ <li>
75
+ <span class="target">Secret</span>
76
+ </li>
77
+ </ul>
78
+ </section>
79
+ <section class="tsd-panel-group tsd-index-group">
80
+ <h2>Index</h2>
81
+ <section class="tsd-panel tsd-index-panel">
82
+ <div class="tsd-index-content">
83
+ <section class="tsd-index-section ">
84
+ <h3>Properties</h3>
85
+ <ul class="tsd-index-list">
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Secret.html#createdAt" class="tsd-kind-icon">created<wbr>At</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Secret.html#createdBy" class="tsd-kind-icon">created<wbr>By</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Secret.html#description" class="tsd-kind-icon">description</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Secret.html#id" class="tsd-kind-icon">id</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Secret.html#lastUpdatedBy" class="tsd-kind-icon">last<wbr>Updated<wbr>By</a></li>
91
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Secret.html#metadata" class="tsd-kind-icon">metadata</a></li>
92
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Secret.html#name" class="tsd-kind-icon">name</a></li>
93
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Secret.html#updatedAt" class="tsd-kind-icon">updated<wbr>At</a></li>
94
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Secret.html#uri" class="tsd-kind-icon">uri</a></li>
95
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.Secret.html#vault" class="tsd-kind-icon">vault</a></li>
96
+ </ul>
97
+ </section>
98
+ </div>
99
+ </section>
100
+ </section>
101
+ <section class="tsd-panel-group tsd-member-group ">
102
+ <h2>Properties</h2>
103
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
104
+ <a name="createdAt" class="tsd-anchor"></a>
105
+ <h3>created<wbr>At</h3>
106
+ <div class="tsd-signature tsd-kind-icon">created<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
107
+ <aside class="tsd-sources">
108
+ <ul>
109
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2076">datatypes.ts:2076</a></li>
110
+ </ul>
111
+ </aside>
112
+ <div class="tsd-comment tsd-typography">
113
+ <div class="lead">
114
+ <p>Timestamp when the Secret was created (RFC 3339 format)</p>
115
+ </div>
116
+ </div>
117
+ </section>
118
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
119
+ <a name="createdBy" class="tsd-anchor"></a>
120
+ <h3>created<wbr>By</h3>
121
+ <div class="tsd-signature tsd-kind-icon">created<wbr>By<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
122
+ <aside class="tsd-sources">
123
+ <ul>
124
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2086">datatypes.ts:2086</a></li>
125
+ </ul>
126
+ </aside>
127
+ <div class="tsd-comment tsd-typography">
128
+ <div class="lead">
129
+ <p>Reference to who created this Secret</p>
130
+ </div>
131
+ </div>
132
+ </section>
133
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
134
+ <a name="description" class="tsd-anchor"></a>
135
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
136
+ <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
137
+ <aside class="tsd-sources">
138
+ <ul>
139
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2082">datatypes.ts:2082</a></li>
140
+ </ul>
141
+ </aside>
142
+ <div class="tsd-comment tsd-typography">
143
+ <div class="lead">
144
+ <p>description of Secret</p>
145
+ </div>
146
+ </div>
147
+ </section>
148
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
149
+ <a name="id" class="tsd-anchor"></a>
150
+ <h3>id</h3>
151
+ <div class="tsd-signature tsd-kind-icon">id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
152
+ <aside class="tsd-sources">
153
+ <ul>
154
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2072">datatypes.ts:2072</a></li>
155
+ </ul>
156
+ </aside>
157
+ <div class="tsd-comment tsd-typography">
158
+ <div class="lead">
159
+ <p>identifier for Secret</p>
160
+ </div>
161
+ </div>
162
+ </section>
163
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
164
+ <a name="lastUpdatedBy" class="tsd-anchor"></a>
165
+ <h3>last<wbr>Updated<wbr>By</h3>
166
+ <div class="tsd-signature tsd-kind-icon">last<wbr>Updated<wbr>By<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
167
+ <aside class="tsd-sources">
168
+ <ul>
169
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2088">datatypes.ts:2088</a></li>
170
+ </ul>
171
+ </aside>
172
+ <div class="tsd-comment tsd-typography">
173
+ <div class="lead">
174
+ <p>Reference to who created this Secret</p>
175
+ </div>
176
+ </div>
177
+ </section>
178
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
179
+ <a name="metadata" class="tsd-anchor"></a>
180
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
181
+ <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
182
+ <aside class="tsd-sources">
183
+ <ul>
184
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2084">datatypes.ts:2084</a></li>
185
+ </ul>
186
+ </aside>
187
+ <div class="tsd-comment tsd-typography">
188
+ <div class="lead">
189
+ <p>Arbitrary user-defined metadata for this Secret</p>
190
+ </div>
191
+ </div>
192
+ </section>
193
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
194
+ <a name="name" class="tsd-anchor"></a>
195
+ <h3>name</h3>
196
+ <div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
197
+ <aside class="tsd-sources">
198
+ <ul>
199
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2080">datatypes.ts:2080</a></li>
200
+ </ul>
201
+ </aside>
202
+ <div class="tsd-comment tsd-typography">
203
+ <div class="lead">
204
+ <p>Name of secret</p>
205
+ </div>
206
+ </div>
207
+ </section>
208
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
209
+ <a name="updatedAt" class="tsd-anchor"></a>
210
+ <h3>updated<wbr>At</h3>
211
+ <div class="tsd-signature tsd-kind-icon">updated<wbr>At<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Date</span></div>
212
+ <aside class="tsd-sources">
213
+ <ul>
214
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2078">datatypes.ts:2078</a></li>
215
+ </ul>
216
+ </aside>
217
+ <div class="tsd-comment tsd-typography">
218
+ <div class="lead">
219
+ <p>Timestamp when the Secret was last updated (RFC 3339 format)</p>
220
+ </div>
221
+ </div>
222
+ </section>
223
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
224
+ <a name="uri" class="tsd-anchor"></a>
225
+ <h3>uri</h3>
226
+ <div class="tsd-signature tsd-kind-icon">uri<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
227
+ <aside class="tsd-sources">
228
+ <ul>
229
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2074">datatypes.ts:2074</a></li>
230
+ </ul>
231
+ </aside>
232
+ <div class="tsd-comment tsd-typography">
233
+ <div class="lead">
234
+ <p>URI of this Secret API resource</p>
235
+ </div>
236
+ </div>
237
+ </section>
238
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
239
+ <a name="vault" class="tsd-anchor"></a>
240
+ <h3>vault</h3>
241
+ <div class="tsd-signature tsd-kind-icon">vault<span class="tsd-signature-symbol">:</span> <a href="datatypes.Ref.html" class="tsd-signature-type" data-tsd-kind="Interface">Ref</a></div>
242
+ <aside class="tsd-sources">
243
+ <ul>
244
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2090">datatypes.ts:2090</a></li>
245
+ </ul>
246
+ </aside>
247
+ <div class="tsd-comment tsd-typography">
248
+ <div class="lead">
249
+ <p>Reference to the vault the secret is stored in</p>
250
+ </div>
251
+ </div>
252
+ </section>
253
+ </section>
254
+ </div>
255
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
256
+ <nav class="tsd-navigation primary">
257
+ <ul>
258
+ <li class=" ">
259
+ <a href="../modules.html">Modules</a>
260
+ </li>
261
+ <li class=" tsd-kind-module">
262
+ <a href="../modules/client.html">client</a>
263
+ </li>
264
+ <li class="current tsd-kind-module">
265
+ <a href="../modules/datatypes.html">datatypes</a>
266
+ </li>
267
+ <li class=" tsd-kind-module">
268
+ <a href="../modules/services.html">services</a>
269
+ </li>
270
+ </ul>
271
+ </nav>
272
+ <nav class="tsd-navigation secondary menu-sticky">
273
+ <ul class="before-current">
274
+ </ul>
275
+ <ul class="current">
276
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
277
+ <a href="datatypes.Secret.html" class="tsd-kind-icon">Secret</a>
278
+ <ul>
279
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
280
+ <a href="datatypes.Secret.html#createdAt" class="tsd-kind-icon">created<wbr>At</a>
281
+ </li>
282
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
283
+ <a href="datatypes.Secret.html#createdBy" class="tsd-kind-icon">created<wbr>By</a>
284
+ </li>
285
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
286
+ <a href="datatypes.Secret.html#description" class="tsd-kind-icon">description</a>
287
+ </li>
288
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
289
+ <a href="datatypes.Secret.html#id" class="tsd-kind-icon">id</a>
290
+ </li>
291
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
292
+ <a href="datatypes.Secret.html#lastUpdatedBy" class="tsd-kind-icon">last<wbr>Updated<wbr>By</a>
293
+ </li>
294
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
295
+ <a href="datatypes.Secret.html#metadata" class="tsd-kind-icon">metadata</a>
296
+ </li>
297
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
298
+ <a href="datatypes.Secret.html#name" class="tsd-kind-icon">name</a>
299
+ </li>
300
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
301
+ <a href="datatypes.Secret.html#updatedAt" class="tsd-kind-icon">updated<wbr>At</a>
302
+ </li>
303
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
304
+ <a href="datatypes.Secret.html#uri" class="tsd-kind-icon">uri</a>
305
+ </li>
306
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
307
+ <a href="datatypes.Secret.html#vault" class="tsd-kind-icon">vault</a>
308
+ </li>
309
+ </ul>
310
+ </li>
311
+ </ul>
312
+ <ul class="after-current">
313
+ </ul>
314
+ </nav>
315
+ </div>
316
+ </div>
317
+ </div>
318
+ <footer class="with-border-bottom">
319
+ <div class="container">
320
+ <h2>Legend</h2>
321
+ <div class="tsd-legend-group">
322
+ <ul class="tsd-legend">
323
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
324
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
325
+ </ul>
326
+ <ul class="tsd-legend">
327
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
328
+ </ul>
329
+ </div>
330
+ </div>
331
+ </footer>
332
+ <div class="container tsd-generator">
333
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
334
+ </div>
335
+ <div class="overlay"></div>
336
+ <script src="../assets/js/main.js"></script>
337
+ </body>
338
+ </html>
@@ -0,0 +1,243 @@
1
+ <!doctype html>
2
+ <html class="default no-js">
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta http-equiv="X-UA-Compatible" content="IE=edge">
6
+ <title>SecretCreate | @ngrok/ngrok-api</title>
7
+ <meta name="description" content="Documentation for @ngrok/ngrok-api">
8
+ <meta name="viewport" content="width=device-width, initial-scale=1">
9
+ <link rel="stylesheet" href="../assets/css/main.css">
10
+ <script async src="../assets/js/search.js" id="search-script"></script>
11
+ </head>
12
+ <body>
13
+ <header>
14
+ <div class="tsd-page-toolbar">
15
+ <div class="container">
16
+ <div class="table-wrap">
17
+ <div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
18
+ <div class="field">
19
+ <label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
20
+ <input id="tsd-search-field" type="text" />
21
+ </div>
22
+ <ul class="results">
23
+ <li class="state loading">Preparing search index...</li>
24
+ <li class="state failure">The search index is not available</li>
25
+ </ul>
26
+ <a href="../index.html" class="title">@ngrok/ngrok-api</a>
27
+ </div>
28
+ <div class="table-cell" id="tsd-widgets">
29
+ <div id="tsd-filter">
30
+ <a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
31
+ <div class="tsd-filter-group">
32
+ <div class="tsd-select" id="tsd-filter-visibility">
33
+ <span class="tsd-select-label">All</span>
34
+ <ul class="tsd-select-list">
35
+ <li data-value="public">Public</li>
36
+ <li data-value="protected">Public/Protected</li>
37
+ <li data-value="private" class="selected">All</li>
38
+ </ul>
39
+ </div>
40
+ <input type="checkbox" id="tsd-filter-inherited" checked />
41
+ <label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
42
+ <input type="checkbox" id="tsd-filter-externals" checked />
43
+ <label class="tsd-widget" for="tsd-filter-externals">Externals</label>
44
+ </div>
45
+ </div>
46
+ <a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
47
+ </div>
48
+ </div>
49
+ </div>
50
+ </div>
51
+ <div class="tsd-page-title">
52
+ <div class="container">
53
+ <ul class="tsd-breadcrumb">
54
+ <li>
55
+ <a href="../modules.html">@ngrok/ngrok-api</a>
56
+ </li>
57
+ <li>
58
+ <a href="../modules/datatypes.html">datatypes</a>
59
+ </li>
60
+ <li>
61
+ <a href="datatypes.SecretCreate.html">SecretCreate</a>
62
+ </li>
63
+ </ul>
64
+ <h1>Interface SecretCreate</h1>
65
+ </div>
66
+ </div>
67
+ </header>
68
+ <div class="container container-main">
69
+ <div class="row">
70
+ <div class="col-8 col-content">
71
+ <section class="tsd-panel tsd-hierarchy">
72
+ <h3>Hierarchy</h3>
73
+ <ul class="tsd-hierarchy">
74
+ <li>
75
+ <span class="target">SecretCreate</span>
76
+ </li>
77
+ </ul>
78
+ </section>
79
+ <section class="tsd-panel-group tsd-index-group">
80
+ <h2>Index</h2>
81
+ <section class="tsd-panel tsd-index-panel">
82
+ <div class="tsd-index-content">
83
+ <section class="tsd-index-section ">
84
+ <h3>Properties</h3>
85
+ <ul class="tsd-index-list">
86
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SecretCreate.html#description" class="tsd-kind-icon">description</a></li>
87
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SecretCreate.html#metadata" class="tsd-kind-icon">metadata</a></li>
88
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SecretCreate.html#name" class="tsd-kind-icon">name</a></li>
89
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SecretCreate.html#value" class="tsd-kind-icon">value</a></li>
90
+ <li class="tsd-kind-property tsd-parent-kind-interface"><a href="datatypes.SecretCreate.html#vaultId" class="tsd-kind-icon">vault<wbr>Id</a></li>
91
+ </ul>
92
+ </section>
93
+ </div>
94
+ </section>
95
+ </section>
96
+ <section class="tsd-panel-group tsd-member-group ">
97
+ <h2>Properties</h2>
98
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
99
+ <a name="description" class="tsd-anchor"></a>
100
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> description</h3>
101
+ <div class="tsd-signature tsd-kind-icon">description<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
102
+ <aside class="tsd-sources">
103
+ <ul>
104
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2052">datatypes.ts:2052</a></li>
105
+ </ul>
106
+ </aside>
107
+ <div class="tsd-comment tsd-typography">
108
+ <div class="lead">
109
+ <p>description of Secret</p>
110
+ </div>
111
+ </div>
112
+ </section>
113
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
114
+ <a name="metadata" class="tsd-anchor"></a>
115
+ <h3><span class="tsd-flag ts-flagOptional">Optional</span> metadata</h3>
116
+ <div class="tsd-signature tsd-kind-icon">metadata<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
117
+ <aside class="tsd-sources">
118
+ <ul>
119
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2050">datatypes.ts:2050</a></li>
120
+ </ul>
121
+ </aside>
122
+ <div class="tsd-comment tsd-typography">
123
+ <div class="lead">
124
+ <p>Arbitrary user-defined metadata for this Secret</p>
125
+ </div>
126
+ </div>
127
+ </section>
128
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
129
+ <a name="name" class="tsd-anchor"></a>
130
+ <h3>name</h3>
131
+ <div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
132
+ <aside class="tsd-sources">
133
+ <ul>
134
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2046">datatypes.ts:2046</a></li>
135
+ </ul>
136
+ </aside>
137
+ <div class="tsd-comment tsd-typography">
138
+ <div class="lead">
139
+ <p>Name of secret</p>
140
+ </div>
141
+ </div>
142
+ </section>
143
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
144
+ <a name="value" class="tsd-anchor"></a>
145
+ <h3>value</h3>
146
+ <div class="tsd-signature tsd-kind-icon">value<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/b737e9b/src/datatypes.ts#L2048">datatypes.ts:2048</a></li>
150
+ </ul>
151
+ </aside>
152
+ <div class="tsd-comment tsd-typography">
153
+ <div class="lead">
154
+ <p>Value of secret</p>
155
+ </div>
156
+ </div>
157
+ </section>
158
+ <section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
159
+ <a name="vaultId" class="tsd-anchor"></a>
160
+ <h3>vault<wbr>Id</h3>
161
+ <div class="tsd-signature tsd-kind-icon">vault<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
162
+ <aside class="tsd-sources">
163
+ <ul>
164
+ <li>Defined in <a href="https://github.com/ngrok/ngrok-api-typescript/blob/b737e9b/src/datatypes.ts#L2054">datatypes.ts:2054</a></li>
165
+ </ul>
166
+ </aside>
167
+ <div class="tsd-comment tsd-typography">
168
+ <div class="lead">
169
+ <p>unique identifier of the referenced vault</p>
170
+ </div>
171
+ </div>
172
+ </section>
173
+ </section>
174
+ </div>
175
+ <div class="col-4 col-menu menu-sticky-wrap menu-highlight">
176
+ <nav class="tsd-navigation primary">
177
+ <ul>
178
+ <li class=" ">
179
+ <a href="../modules.html">Modules</a>
180
+ </li>
181
+ <li class=" tsd-kind-module">
182
+ <a href="../modules/client.html">client</a>
183
+ </li>
184
+ <li class="current tsd-kind-module">
185
+ <a href="../modules/datatypes.html">datatypes</a>
186
+ </li>
187
+ <li class=" tsd-kind-module">
188
+ <a href="../modules/services.html">services</a>
189
+ </li>
190
+ </ul>
191
+ </nav>
192
+ <nav class="tsd-navigation secondary menu-sticky">
193
+ <ul class="before-current">
194
+ </ul>
195
+ <ul class="current">
196
+ <li class="current tsd-kind-interface tsd-parent-kind-module">
197
+ <a href="datatypes.SecretCreate.html" class="tsd-kind-icon">Secret<wbr>Create</a>
198
+ <ul>
199
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
200
+ <a href="datatypes.SecretCreate.html#description" class="tsd-kind-icon">description</a>
201
+ </li>
202
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
203
+ <a href="datatypes.SecretCreate.html#metadata" class="tsd-kind-icon">metadata</a>
204
+ </li>
205
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
206
+ <a href="datatypes.SecretCreate.html#name" class="tsd-kind-icon">name</a>
207
+ </li>
208
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
209
+ <a href="datatypes.SecretCreate.html#value" class="tsd-kind-icon">value</a>
210
+ </li>
211
+ <li class=" tsd-kind-property tsd-parent-kind-interface">
212
+ <a href="datatypes.SecretCreate.html#vaultId" class="tsd-kind-icon">vault<wbr>Id</a>
213
+ </li>
214
+ </ul>
215
+ </li>
216
+ </ul>
217
+ <ul class="after-current">
218
+ </ul>
219
+ </nav>
220
+ </div>
221
+ </div>
222
+ </div>
223
+ <footer class="with-border-bottom">
224
+ <div class="container">
225
+ <h2>Legend</h2>
226
+ <div class="tsd-legend-group">
227
+ <ul class="tsd-legend">
228
+ <li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
229
+ <li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
230
+ </ul>
231
+ <ul class="tsd-legend">
232
+ <li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
233
+ </ul>
234
+ </div>
235
+ </div>
236
+ </footer>
237
+ <div class="container tsd-generator">
238
+ <p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
239
+ </div>
240
+ <div class="overlay"></div>
241
+ <script src="../assets/js/main.js"></script>
242
+ </body>
243
+ </html>