ngrok-api 0.24.0 → 0.26.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 (376) hide show
  1. checksums.yaml +4 -4
  2. data/.github/workflows/ci.yml +1 -1
  3. data/CHANGELOG.md +13 -0
  4. data/Gemfile.lock +9 -1
  5. data/doc/NgrokAPI/Client.html +223 -67
  6. data/doc/NgrokAPI/Error.html +2 -2
  7. data/doc/NgrokAPI/Errors/NotFoundError.html +2 -2
  8. data/doc/NgrokAPI/Errors.html +2 -2
  9. data/doc/NgrokAPI/HttpClient.html +2 -2
  10. data/doc/NgrokAPI/Models/APIKey.html +2 -2
  11. data/doc/NgrokAPI/Models/AWSAuth.html +2 -2
  12. data/doc/NgrokAPI/Models/AWSCredentials.html +2 -2
  13. data/doc/NgrokAPI/Models/AWSRole.html +2 -2
  14. data/doc/NgrokAPI/Models/AbuseReport.html +2 -2
  15. data/doc/NgrokAPI/Models/AbuseReportHostname.html +2 -2
  16. data/doc/NgrokAPI/Models/AgentIngress.html +2 -2
  17. data/doc/NgrokAPI/Models/AgentIngressCertJob.html +2 -2
  18. data/doc/NgrokAPI/Models/AgentIngressCertPolicy.html +2 -2
  19. data/doc/NgrokAPI/Models/AgentIngressCertStatus.html +2 -2
  20. data/doc/NgrokAPI/Models/ApplicationSession.html +2 -2
  21. data/doc/NgrokAPI/Models/ApplicationUser.html +2 -2
  22. data/doc/NgrokAPI/Models/BotUser.html +2 -2
  23. data/doc/NgrokAPI/Models/BrowserSession.html +2 -2
  24. data/doc/NgrokAPI/Models/CertificateAuthority.html +2 -2
  25. data/doc/NgrokAPI/Models/Credential.html +2 -2
  26. data/doc/NgrokAPI/Models/Endpoint.html +48 -42
  27. data/doc/NgrokAPI/Models/EndpointBackend.html +2 -2
  28. data/doc/NgrokAPI/Models/EndpointBackendMutate.html +2 -2
  29. data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +2 -2
  30. data/doc/NgrokAPI/Models/EndpointCompression.html +2 -2
  31. data/doc/NgrokAPI/Models/EndpointIPPolicy.html +2 -2
  32. data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +2 -2
  33. data/doc/NgrokAPI/Models/EndpointMutualTLS.html +2 -2
  34. data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +2 -2
  35. data/doc/NgrokAPI/Models/EndpointOAuth.html +2 -2
  36. data/doc/NgrokAPI/Models/EndpointOAuthAmazon.html +2 -2
  37. data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +2 -2
  38. data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +2 -2
  39. data/doc/NgrokAPI/Models/EndpointOAuthGitLab.html +2 -2
  40. data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +2 -2
  41. data/doc/NgrokAPI/Models/EndpointOAuthLinkedIn.html +2 -2
  42. data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +2 -2
  43. data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +2 -2
  44. data/doc/NgrokAPI/Models/EndpointOAuthTwitch.html +2 -2
  45. data/doc/NgrokAPI/Models/EndpointOIDC.html +2 -2
  46. data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +2 -2
  47. data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +2 -2
  48. data/doc/NgrokAPI/Models/EndpointSAML.html +2 -2
  49. data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +2 -2
  50. data/doc/NgrokAPI/Models/EndpointTLSTermination.html +2 -2
  51. data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +2 -2
  52. data/doc/NgrokAPI/Models/EndpointTrafficPolicy.html +2 -2
  53. data/doc/NgrokAPI/Models/EndpointUserAgentFilter.html +2 -2
  54. data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +2 -2
  55. data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +2 -2
  56. data/doc/NgrokAPI/Models/EventDestination.html +2 -2
  57. data/doc/NgrokAPI/Models/EventSource.html +2 -2
  58. data/doc/NgrokAPI/Models/EventSourceList.html +2 -2
  59. data/doc/NgrokAPI/Models/EventSourceReplace.html +2 -2
  60. data/doc/NgrokAPI/Models/EventSubscription.html +2 -2
  61. data/doc/NgrokAPI/Models/EventTarget.html +2 -2
  62. data/doc/NgrokAPI/Models/EventTargetAzureLogsIngestion.html +2 -2
  63. data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +2 -2
  64. data/doc/NgrokAPI/Models/EventTargetDatadog.html +2 -2
  65. data/doc/NgrokAPI/Models/EventTargetFirehose.html +2 -2
  66. data/doc/NgrokAPI/Models/EventTargetKinesis.html +2 -2
  67. data/doc/NgrokAPI/Models/FailoverBackend.html +2 -2
  68. data/doc/NgrokAPI/Models/HTTPResponseBackend.html +2 -2
  69. data/doc/NgrokAPI/Models/HTTPSEdge.html +2 -2
  70. data/doc/NgrokAPI/Models/HTTPSEdgeRoute.html +2 -2
  71. data/doc/NgrokAPI/Models/IPPolicy.html +2 -2
  72. data/doc/NgrokAPI/Models/IPPolicyRule.html +2 -2
  73. data/doc/NgrokAPI/Models/IPRestriction.html +2 -2
  74. data/doc/NgrokAPI/Models/IdentityProvider.html +2 -2
  75. data/doc/NgrokAPI/Models/Listable.html +2 -2
  76. data/doc/NgrokAPI/Models/Location.html +2 -2
  77. data/doc/NgrokAPI/Models/Ref.html +2 -2
  78. data/doc/NgrokAPI/Models/ReservedAddr.html +2 -2
  79. data/doc/NgrokAPI/Models/ReservedDomain.html +2 -2
  80. data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +2 -2
  81. data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +2 -2
  82. data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +2 -2
  83. data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +2 -2
  84. data/doc/NgrokAPI/Models/SSHCredential.html +2 -2
  85. data/doc/NgrokAPI/Models/SSHHostCertificate.html +2 -2
  86. data/doc/NgrokAPI/Models/SSHUserCertificate.html +2 -2
  87. data/doc/NgrokAPI/Models/Secret.html +1336 -0
  88. data/doc/NgrokAPI/Models/StaticBackend.html +2 -2
  89. data/doc/NgrokAPI/Models/StaticBackendTLS.html +2 -2
  90. data/doc/NgrokAPI/Models/TCPEdge.html +2 -2
  91. data/doc/NgrokAPI/Models/TLSCertificate.html +2 -2
  92. data/doc/NgrokAPI/Models/TLSCertificateSANs.html +2 -2
  93. data/doc/NgrokAPI/Models/TLSEdge.html +2 -2
  94. data/doc/NgrokAPI/Models/Tunnel.html +2 -2
  95. data/doc/NgrokAPI/Models/TunnelGroupBackend.html +2 -2
  96. data/doc/NgrokAPI/Models/TunnelSession.html +2 -2
  97. data/doc/NgrokAPI/Models/UserAgent.html +2 -2
  98. data/doc/NgrokAPI/Models/Vault.html +1353 -0
  99. data/doc/NgrokAPI/Models/WeightedBackend.html +2 -2
  100. data/doc/NgrokAPI/Models.html +4 -4
  101. data/doc/NgrokAPI/PagedIterator.html +2 -2
  102. data/doc/NgrokAPI/Services/APIKeysClient.html +47 -31
  103. data/doc/NgrokAPI/Services/AbuseReportsClient.html +2 -2
  104. data/doc/NgrokAPI/Services/AgentIngressesClient.html +47 -31
  105. data/doc/NgrokAPI/Services/ApplicationSessionsClient.html +27 -11
  106. data/doc/NgrokAPI/Services/ApplicationUsersClient.html +27 -11
  107. data/doc/NgrokAPI/Services/BotUsersClient.html +47 -31
  108. data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +47 -31
  109. data/doc/NgrokAPI/Services/CredentialsClient.html +47 -31
  110. data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +2 -2
  111. data/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +2 -2
  112. data/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +2 -2
  113. data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +2 -2
  114. data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +2 -2
  115. data/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +2 -2
  116. data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +2 -2
  117. data/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +2 -2
  118. data/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +2 -2
  119. data/doc/NgrokAPI/Services/EdgeRouteTrafficPolicyModuleClient.html +2 -2
  120. data/doc/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html +2 -2
  121. data/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +2 -2
  122. data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +2 -2
  123. data/doc/NgrokAPI/Services/EdgesHTTPSClient.html +63 -47
  124. data/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +2 -2
  125. data/doc/NgrokAPI/Services/EdgesTCPClient.html +63 -47
  126. data/doc/NgrokAPI/Services/EdgesTLSClient.html +63 -47
  127. data/doc/NgrokAPI/Services/EndpointsClient.html +258 -134
  128. data/doc/NgrokAPI/Services/EventDestinationsClient.html +47 -31
  129. data/doc/NgrokAPI/Services/EventSourcesClient.html +2 -2
  130. data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +47 -31
  131. data/doc/NgrokAPI/Services/FailoverBackendsClient.html +47 -31
  132. data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +47 -31
  133. data/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +2 -2
  134. data/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +2 -2
  135. data/doc/NgrokAPI/Services/IPPoliciesClient.html +47 -31
  136. data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +47 -31
  137. data/doc/NgrokAPI/Services/IPRestrictionsClient.html +47 -31
  138. data/doc/NgrokAPI/Services/ReservedAddrsClient.html +47 -31
  139. data/doc/NgrokAPI/Services/ReservedDomainsClient.html +79 -63
  140. data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +47 -31
  141. data/doc/NgrokAPI/Services/SSHCredentialsClient.html +47 -31
  142. data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +47 -31
  143. data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +47 -31
  144. data/doc/NgrokAPI/Services/SecretsClient.html +1941 -0
  145. data/doc/NgrokAPI/Services/StaticBackendsClient.html +47 -31
  146. data/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +2 -2
  147. data/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +2 -2
  148. data/doc/NgrokAPI/Services/TCPEdgeTrafficPolicyModuleClient.html +2 -2
  149. data/doc/NgrokAPI/Services/TLSCertificatesClient.html +47 -31
  150. data/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +2 -2
  151. data/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +2 -2
  152. data/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +2 -2
  153. data/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +2 -2
  154. data/doc/NgrokAPI/Services/TLSEdgeTrafficPolicyModuleClient.html +2 -2
  155. data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +47 -31
  156. data/doc/NgrokAPI/Services/TunnelSessionsClient.html +95 -79
  157. data/doc/NgrokAPI/Services/TunnelsClient.html +47 -31
  158. data/doc/NgrokAPI/Services/VaultsClient.html +2219 -0
  159. data/doc/NgrokAPI/Services/WeightedBackendsClient.html +47 -31
  160. data/doc/NgrokAPI/Services.html +5 -5
  161. data/doc/NgrokAPI.html +3 -3
  162. data/doc/_index.html +38 -2
  163. data/doc/class_list.html +1 -1
  164. data/doc/file.README.html +2 -2
  165. data/doc/index.html +2 -2
  166. data/doc/method_list.html +751 -255
  167. data/doc/top-level-namespace.html +2 -2
  168. data/docs/NgrokAPI/Client.html +223 -67
  169. data/docs/NgrokAPI/Error.html +2 -2
  170. data/docs/NgrokAPI/Errors/NotFoundError.html +2 -2
  171. data/docs/NgrokAPI/Errors.html +2 -2
  172. data/docs/NgrokAPI/HttpClient.html +2 -2
  173. data/docs/NgrokAPI/Models/APIKey.html +2 -2
  174. data/docs/NgrokAPI/Models/AWSAuth.html +2 -2
  175. data/docs/NgrokAPI/Models/AWSCredentials.html +2 -2
  176. data/docs/NgrokAPI/Models/AWSRole.html +2 -2
  177. data/docs/NgrokAPI/Models/AbuseReport.html +2 -2
  178. data/docs/NgrokAPI/Models/AbuseReportHostname.html +2 -2
  179. data/docs/NgrokAPI/Models/AgentIngress.html +2 -2
  180. data/docs/NgrokAPI/Models/AgentIngressCertJob.html +2 -2
  181. data/docs/NgrokAPI/Models/AgentIngressCertPolicy.html +2 -2
  182. data/docs/NgrokAPI/Models/AgentIngressCertStatus.html +2 -2
  183. data/docs/NgrokAPI/Models/ApplicationSession.html +2 -2
  184. data/docs/NgrokAPI/Models/ApplicationUser.html +2 -2
  185. data/docs/NgrokAPI/Models/BotUser.html +2 -2
  186. data/docs/NgrokAPI/Models/BrowserSession.html +2 -2
  187. data/docs/NgrokAPI/Models/CertificateAuthority.html +2 -2
  188. data/docs/NgrokAPI/Models/Credential.html +2 -2
  189. data/docs/NgrokAPI/Models/Endpoint.html +48 -42
  190. data/docs/NgrokAPI/Models/EndpointBackend.html +2 -2
  191. data/docs/NgrokAPI/Models/EndpointBackendMutate.html +2 -2
  192. data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +2 -2
  193. data/docs/NgrokAPI/Models/EndpointCompression.html +2 -2
  194. data/docs/NgrokAPI/Models/EndpointIPPolicy.html +2 -2
  195. data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +2 -2
  196. data/docs/NgrokAPI/Models/EndpointMutualTLS.html +2 -2
  197. data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +2 -2
  198. data/docs/NgrokAPI/Models/EndpointOAuth.html +2 -2
  199. data/docs/NgrokAPI/Models/EndpointOAuthAmazon.html +2 -2
  200. data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +2 -2
  201. data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +2 -2
  202. data/docs/NgrokAPI/Models/EndpointOAuthGitLab.html +2 -2
  203. data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +2 -2
  204. data/docs/NgrokAPI/Models/EndpointOAuthLinkedIn.html +2 -2
  205. data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +2 -2
  206. data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +2 -2
  207. data/docs/NgrokAPI/Models/EndpointOAuthTwitch.html +2 -2
  208. data/docs/NgrokAPI/Models/EndpointOIDC.html +2 -2
  209. data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +2 -2
  210. data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +2 -2
  211. data/docs/NgrokAPI/Models/EndpointSAML.html +2 -2
  212. data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +2 -2
  213. data/docs/NgrokAPI/Models/EndpointTLSTermination.html +2 -2
  214. data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +2 -2
  215. data/docs/NgrokAPI/Models/EndpointTrafficPolicy.html +2 -2
  216. data/docs/NgrokAPI/Models/EndpointUserAgentFilter.html +2 -2
  217. data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +2 -2
  218. data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +2 -2
  219. data/docs/NgrokAPI/Models/EventDestination.html +2 -2
  220. data/docs/NgrokAPI/Models/EventSource.html +2 -2
  221. data/docs/NgrokAPI/Models/EventSourceList.html +2 -2
  222. data/docs/NgrokAPI/Models/EventSourceReplace.html +2 -2
  223. data/docs/NgrokAPI/Models/EventSubscription.html +2 -2
  224. data/docs/NgrokAPI/Models/EventTarget.html +2 -2
  225. data/docs/NgrokAPI/Models/EventTargetAzureLogsIngestion.html +2 -2
  226. data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +2 -2
  227. data/docs/NgrokAPI/Models/EventTargetDatadog.html +2 -2
  228. data/docs/NgrokAPI/Models/EventTargetFirehose.html +2 -2
  229. data/docs/NgrokAPI/Models/EventTargetKinesis.html +2 -2
  230. data/docs/NgrokAPI/Models/FailoverBackend.html +2 -2
  231. data/docs/NgrokAPI/Models/HTTPResponseBackend.html +2 -2
  232. data/docs/NgrokAPI/Models/HTTPSEdge.html +2 -2
  233. data/docs/NgrokAPI/Models/HTTPSEdgeRoute.html +2 -2
  234. data/docs/NgrokAPI/Models/IPPolicy.html +2 -2
  235. data/docs/NgrokAPI/Models/IPPolicyRule.html +2 -2
  236. data/docs/NgrokAPI/Models/IPRestriction.html +2 -2
  237. data/docs/NgrokAPI/Models/IdentityProvider.html +2 -2
  238. data/docs/NgrokAPI/Models/Listable.html +2 -2
  239. data/docs/NgrokAPI/Models/Location.html +2 -2
  240. data/docs/NgrokAPI/Models/Ref.html +2 -2
  241. data/docs/NgrokAPI/Models/ReservedAddr.html +2 -2
  242. data/docs/NgrokAPI/Models/ReservedDomain.html +2 -2
  243. data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +2 -2
  244. data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +2 -2
  245. data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +2 -2
  246. data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +2 -2
  247. data/docs/NgrokAPI/Models/SSHCredential.html +2 -2
  248. data/docs/NgrokAPI/Models/SSHHostCertificate.html +2 -2
  249. data/docs/NgrokAPI/Models/SSHUserCertificate.html +2 -2
  250. data/docs/NgrokAPI/Models/Secret.html +1336 -0
  251. data/docs/NgrokAPI/Models/StaticBackend.html +2 -2
  252. data/docs/NgrokAPI/Models/StaticBackendTLS.html +2 -2
  253. data/docs/NgrokAPI/Models/TCPEdge.html +2 -2
  254. data/docs/NgrokAPI/Models/TLSCertificate.html +2 -2
  255. data/docs/NgrokAPI/Models/TLSCertificateSANs.html +2 -2
  256. data/docs/NgrokAPI/Models/TLSEdge.html +2 -2
  257. data/docs/NgrokAPI/Models/Tunnel.html +2 -2
  258. data/docs/NgrokAPI/Models/TunnelGroupBackend.html +2 -2
  259. data/docs/NgrokAPI/Models/TunnelSession.html +2 -2
  260. data/docs/NgrokAPI/Models/UserAgent.html +2 -2
  261. data/docs/NgrokAPI/Models/Vault.html +1353 -0
  262. data/docs/NgrokAPI/Models/WeightedBackend.html +2 -2
  263. data/docs/NgrokAPI/Models.html +4 -4
  264. data/docs/NgrokAPI/PagedIterator.html +2 -2
  265. data/docs/NgrokAPI/Services/APIKeysClient.html +47 -31
  266. data/docs/NgrokAPI/Services/AbuseReportsClient.html +2 -2
  267. data/docs/NgrokAPI/Services/AgentIngressesClient.html +47 -31
  268. data/docs/NgrokAPI/Services/ApplicationSessionsClient.html +27 -11
  269. data/docs/NgrokAPI/Services/ApplicationUsersClient.html +27 -11
  270. data/docs/NgrokAPI/Services/BotUsersClient.html +47 -31
  271. data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +47 -31
  272. data/docs/NgrokAPI/Services/CredentialsClient.html +47 -31
  273. data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +2 -2
  274. data/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +2 -2
  275. data/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +2 -2
  276. data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +2 -2
  277. data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +2 -2
  278. data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +2 -2
  279. data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +2 -2
  280. data/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +2 -2
  281. data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +2 -2
  282. data/docs/NgrokAPI/Services/EdgeRouteTrafficPolicyModuleClient.html +2 -2
  283. data/docs/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html +2 -2
  284. data/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +2 -2
  285. data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +2 -2
  286. data/docs/NgrokAPI/Services/EdgesHTTPSClient.html +63 -47
  287. data/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +2 -2
  288. data/docs/NgrokAPI/Services/EdgesTCPClient.html +63 -47
  289. data/docs/NgrokAPI/Services/EdgesTLSClient.html +63 -47
  290. data/docs/NgrokAPI/Services/EndpointsClient.html +258 -134
  291. data/docs/NgrokAPI/Services/EventDestinationsClient.html +47 -31
  292. data/docs/NgrokAPI/Services/EventSourcesClient.html +2 -2
  293. data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +47 -31
  294. data/docs/NgrokAPI/Services/FailoverBackendsClient.html +47 -31
  295. data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +47 -31
  296. data/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +2 -2
  297. data/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +2 -2
  298. data/docs/NgrokAPI/Services/IPPoliciesClient.html +47 -31
  299. data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +47 -31
  300. data/docs/NgrokAPI/Services/IPRestrictionsClient.html +47 -31
  301. data/docs/NgrokAPI/Services/ReservedAddrsClient.html +47 -31
  302. data/docs/NgrokAPI/Services/ReservedDomainsClient.html +79 -63
  303. data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +47 -31
  304. data/docs/NgrokAPI/Services/SSHCredentialsClient.html +47 -31
  305. data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +47 -31
  306. data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +47 -31
  307. data/docs/NgrokAPI/Services/SecretsClient.html +1941 -0
  308. data/docs/NgrokAPI/Services/StaticBackendsClient.html +47 -31
  309. data/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +2 -2
  310. data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +2 -2
  311. data/docs/NgrokAPI/Services/TCPEdgeTrafficPolicyModuleClient.html +2 -2
  312. data/docs/NgrokAPI/Services/TLSCertificatesClient.html +47 -31
  313. data/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +2 -2
  314. data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +2 -2
  315. data/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +2 -2
  316. data/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +2 -2
  317. data/docs/NgrokAPI/Services/TLSEdgeTrafficPolicyModuleClient.html +2 -2
  318. data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +47 -31
  319. data/docs/NgrokAPI/Services/TunnelSessionsClient.html +95 -79
  320. data/docs/NgrokAPI/Services/TunnelsClient.html +47 -31
  321. data/docs/NgrokAPI/Services/VaultsClient.html +2219 -0
  322. data/docs/NgrokAPI/Services/WeightedBackendsClient.html +47 -31
  323. data/docs/NgrokAPI/Services.html +5 -5
  324. data/docs/NgrokAPI.html +3 -3
  325. data/docs/_index.html +38 -2
  326. data/docs/class_list.html +1 -1
  327. data/docs/file.README.html +2 -2
  328. data/docs/index.html +2 -2
  329. data/docs/method_list.html +751 -255
  330. data/docs/top-level-namespace.html +2 -2
  331. data/lib/ngrokapi/client.rb +18 -0
  332. data/lib/ngrokapi/models/endpoint.rb +10 -7
  333. data/lib/ngrokapi/models/secret.rb +63 -0
  334. data/lib/ngrokapi/models/vault.rb +81 -0
  335. data/lib/ngrokapi/services/agent_ingresses_client.rb +10 -2
  336. data/lib/ngrokapi/services/api_keys_client.rb +10 -2
  337. data/lib/ngrokapi/services/application_sessions_client.rb +10 -2
  338. data/lib/ngrokapi/services/application_users_client.rb +10 -2
  339. data/lib/ngrokapi/services/bot_users_client.rb +10 -2
  340. data/lib/ngrokapi/services/certificate_authorities_client.rb +10 -2
  341. data/lib/ngrokapi/services/credentials_client.rb +10 -2
  342. data/lib/ngrokapi/services/edges_https_client.rb +10 -2
  343. data/lib/ngrokapi/services/edges_tcp_client.rb +10 -2
  344. data/lib/ngrokapi/services/edges_tls_client.rb +10 -2
  345. data/lib/ngrokapi/services/endpoints_client.rb +32 -8
  346. data/lib/ngrokapi/services/event_destinations_client.rb +10 -2
  347. data/lib/ngrokapi/services/event_subscriptions_client.rb +10 -2
  348. data/lib/ngrokapi/services/failover_backends_client.rb +10 -2
  349. data/lib/ngrokapi/services/http_response_backends_client.rb +10 -2
  350. data/lib/ngrokapi/services/ip_policies_client.rb +10 -2
  351. data/lib/ngrokapi/services/ip_policy_rules_client.rb +10 -2
  352. data/lib/ngrokapi/services/ip_restrictions_client.rb +10 -2
  353. data/lib/ngrokapi/services/reserved_addrs_client.rb +10 -2
  354. data/lib/ngrokapi/services/reserved_domains_client.rb +10 -2
  355. data/lib/ngrokapi/services/secrets_client.rb +254 -0
  356. data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +10 -2
  357. data/lib/ngrokapi/services/ssh_credentials_client.rb +10 -2
  358. data/lib/ngrokapi/services/ssh_host_certificates_client.rb +10 -2
  359. data/lib/ngrokapi/services/ssh_user_certificates_client.rb +10 -2
  360. data/lib/ngrokapi/services/static_backends_client.rb +10 -2
  361. data/lib/ngrokapi/services/tls_certificates_client.rb +10 -2
  362. data/lib/ngrokapi/services/tunnel_group_backends_client.rb +10 -2
  363. data/lib/ngrokapi/services/tunnel_sessions_client.rb +10 -2
  364. data/lib/ngrokapi/services/tunnels_client.rb +10 -2
  365. data/lib/ngrokapi/services/vaults_client.rb +317 -0
  366. data/lib/ngrokapi/services/weighted_backends_client.rb +10 -2
  367. data/lib/ngrokapi/version.rb +1 -1
  368. data/spec/ngrokapi/client_spec.rb +12 -0
  369. data/spec/ngrokapi/models/endpoint_spec.rb +4 -1
  370. data/spec/ngrokapi/models/secret_spec.rb +30 -0
  371. data/spec/ngrokapi/models/vault_spec.rb +47 -0
  372. data/spec/ngrokapi/services/endpoints_client_spec.rb +12 -4
  373. data/spec/ngrokapi/services/secrets_client_spec.rb +198 -0
  374. data/spec/ngrokapi/services/vaults_client_spec.rb +201 -0
  375. data/spec/spec_helper.rb +123 -0
  376. metadata +18 -5
@@ -0,0 +1,1941 @@
1
+ <!DOCTYPE html>
2
+ <html>
3
+ <head>
4
+ <meta charset="utf-8">
5
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
+ <title>
7
+ Class: NgrokAPI::Services::SecretsClient
8
+
9
+ &mdash; Documentation by YARD 0.9.36
10
+
11
+ </title>
12
+
13
+ <link rel="stylesheet" href="../../css/style.css" type="text/css" />
14
+
15
+ <link rel="stylesheet" href="../../css/common.css" type="text/css" />
16
+
17
+ <script type="text/javascript">
18
+ pathId = "NgrokAPI::Services::SecretsClient";
19
+ relpath = '../../';
20
+ </script>
21
+
22
+
23
+ <script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
24
+
25
+ <script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
26
+
27
+
28
+ </head>
29
+ <body>
30
+ <div class="nav_wrap">
31
+ <iframe id="nav" src="../../class_list.html?1"></iframe>
32
+ <div id="resizer"></div>
33
+ </div>
34
+
35
+ <div id="main" tabindex="-1">
36
+ <div id="header">
37
+ <div id="menu">
38
+
39
+ <a href="../../_index.html">Index (S)</a> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Services.html" title="NgrokAPI::Services (module)">Services</a></span></span>
41
+ &raquo;
42
+ <span class="title">SecretsClient</span>
43
+
44
+ </div>
45
+
46
+ <div id="search">
47
+
48
+ <a class="full_list_link" id="class_list_link"
49
+ href="../../class_list.html">
50
+
51
+ <svg width="24" height="24">
52
+ <rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
53
+ <rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
54
+ <rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
55
+ </svg>
56
+ </a>
57
+
58
+ </div>
59
+ <div class="clear"></div>
60
+ </div>
61
+
62
+ <div id="content"><h1>Class: NgrokAPI::Services::SecretsClient
63
+
64
+
65
+
66
+ </h1>
67
+ <div class="box_info">
68
+
69
+ <dl>
70
+ <dt>Inherits:</dt>
71
+ <dd>
72
+ <span class="inheritName">Object</span>
73
+
74
+ <ul class="fullTree">
75
+ <li>Object</li>
76
+
77
+ <li class="next">NgrokAPI::Services::SecretsClient</li>
78
+
79
+ </ul>
80
+ <a href="#" class="inheritanceTree">show all</a>
81
+
82
+ </dd>
83
+ </dl>
84
+
85
+
86
+
87
+
88
+
89
+
90
+
91
+
92
+
93
+
94
+
95
+ <dl>
96
+ <dt>Defined in:</dt>
97
+ <dd>lib/ngrokapi/services/secrets_client.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+ <h2>Overview</h2><div class="docstring">
103
+ <div class="discussion">
104
+
105
+ <p>Secrets is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.</p>
106
+
107
+ <p><a href="https://ngrok.com/docs/api#api-secrets">ngrok.com/docs/api#api-secrets</a></p>
108
+
109
+
110
+ </div>
111
+ </div>
112
+ <div class="tags">
113
+
114
+
115
+ </div>
116
+
117
+ <h2>
118
+ Constant Summary
119
+ <small><a href="#" class="constants_summary_toggle">collapse</a></small>
120
+ </h2>
121
+
122
+ <dl class="constants">
123
+
124
+ <dt id="PATH-constant" class="">PATH =
125
+ <div class="docstring">
126
+ <div class="discussion">
127
+
128
+ <p>The API path for the requests</p>
129
+
130
+
131
+ </div>
132
+ </div>
133
+ <div class="tags">
134
+
135
+
136
+ </div>
137
+ </dt>
138
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/vault_secrets</span><span class='tstring_end'>&#39;</span></span></pre></dd>
139
+
140
+ <dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
141
+ <div class="docstring">
142
+ <div class="discussion">
143
+
144
+ <p>The List Property from the resulting API for list calls</p>
145
+
146
+
147
+ </div>
148
+ </div>
149
+ <div class="tags">
150
+
151
+
152
+ </div>
153
+ </dt>
154
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>secrets</span><span class='tstring_end'>&#39;</span></span></pre></dd>
155
+
156
+ </dl>
157
+
158
+
159
+
160
+
161
+
162
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
163
+ <ul class="summary">
164
+
165
+ <li class="public ">
166
+ <span class="summary_signature">
167
+
168
+ <a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> &#x21d2; Object </a>
169
+
170
+
171
+
172
+ </span>
173
+
174
+
175
+
176
+
177
+ <span class="note title readonly">readonly</span>
178
+
179
+
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+ <span class="summary_desc"><div class='inline'>
188
+ <p>Returns the value of attribute client.</p>
189
+ </div></span>
190
+
191
+ </li>
192
+
193
+
194
+ </ul>
195
+
196
+
197
+
198
+
199
+
200
+ <h2>
201
+ Instance Method Summary
202
+ <small><a href="#" class="summary_toggle">collapse</a></small>
203
+ </h2>
204
+
205
+ <ul class="summary">
206
+
207
+ <li class="public ">
208
+ <span class="summary_signature">
209
+
210
+ <a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(name: &quot;&quot;, value: &quot;&quot;, metadata: &quot;&quot;, description: &quot;&quot;, vault_id:) &#x21d2; NgrokAPI::Models::Secret </a>
211
+
212
+
213
+
214
+ </span>
215
+
216
+
217
+
218
+
219
+
220
+
221
+
222
+
223
+
224
+ <span class="summary_desc"><div class='inline'>
225
+ <p>Create a new Secret.</p>
226
+ </div></span>
227
+
228
+ </li>
229
+
230
+
231
+ <li class="public ">
232
+ <span class="summary_signature">
233
+
234
+ <a href="#create!-instance_method" title="#create! (instance method)">#<strong>create!</strong>(name: &quot;&quot;, value: &quot;&quot;, metadata: &quot;&quot;, description: &quot;&quot;, vault_id:) &#x21d2; NgrokAPI::Models::Secret </a>
235
+
236
+
237
+
238
+ </span>
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+ <span class="summary_desc"><div class='inline'>
249
+ <p>Create a new Secret Throws an exception if API error.</p>
250
+ </div></span>
251
+
252
+ </li>
253
+
254
+
255
+ <li class="public ">
256
+ <span class="summary_signature">
257
+
258
+ <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::Empty </a>
259
+
260
+
261
+
262
+ </span>
263
+
264
+
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+ <span class="summary_desc"><div class='inline'>
273
+ <p>Delete a Secret.</p>
274
+ </div></span>
275
+
276
+ </li>
277
+
278
+
279
+ <li class="public ">
280
+ <span class="summary_signature">
281
+
282
+ <a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::Empty </a>
283
+
284
+
285
+
286
+ </span>
287
+
288
+
289
+
290
+
291
+
292
+
293
+
294
+
295
+
296
+ <span class="summary_desc"><div class='inline'>
297
+ <p>Delete a Secret Throws an exception if API error.</p>
298
+ </div></span>
299
+
300
+ </li>
301
+
302
+
303
+ <li class="public ">
304
+ <span class="summary_signature">
305
+
306
+ <a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::Secret </a>
307
+
308
+
309
+
310
+ </span>
311
+
312
+
313
+
314
+
315
+
316
+
317
+
318
+
319
+
320
+ <span class="summary_desc"><div class='inline'>
321
+ <p>Get a Secret by ID.</p>
322
+ </div></span>
323
+
324
+ </li>
325
+
326
+
327
+ <li class="public ">
328
+ <span class="summary_signature">
329
+
330
+ <a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::Secret </a>
331
+
332
+
333
+
334
+ </span>
335
+
336
+
337
+
338
+
339
+
340
+
341
+
342
+
343
+
344
+ <span class="summary_desc"><div class='inline'>
345
+ <p>Get a Secret by ID Throws an exception if API error.</p>
346
+ </div></span>
347
+
348
+ </li>
349
+
350
+
351
+ <li class="public ">
352
+ <span class="summary_signature">
353
+
354
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) &#x21d2; SecretsClient </a>
355
+
356
+
357
+
358
+ </span>
359
+
360
+
361
+ <span class="note title constructor">constructor</span>
362
+
363
+
364
+
365
+
366
+
367
+
368
+
369
+
370
+ <span class="summary_desc"><div class='inline'>
371
+ <p>A new instance of SecretsClient.</p>
372
+ </div></span>
373
+
374
+ </li>
375
+
376
+
377
+ <li class="public ">
378
+ <span class="summary_signature">
379
+
380
+ <a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, url: nil) &#x21d2; NgrokAPI::Models::Listable </a>
381
+
382
+
383
+
384
+ </span>
385
+
386
+
387
+
388
+
389
+
390
+
391
+
392
+
393
+
394
+ <span class="summary_desc"><div class='inline'>
395
+ <p>List all Secrets owned by account.</p>
396
+ </div></span>
397
+
398
+ </li>
399
+
400
+
401
+ <li class="public ">
402
+ <span class="summary_signature">
403
+
404
+ <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) &#x21d2; NgrokAPI::Models::Listable </a>
405
+
406
+
407
+
408
+ </span>
409
+
410
+
411
+
412
+
413
+
414
+
415
+
416
+
417
+
418
+ <span class="summary_desc"><div class='inline'>
419
+ <p>List all Secrets owned by account Throws an exception if API error.</p>
420
+ </div></span>
421
+
422
+ </li>
423
+
424
+
425
+ <li class="public ">
426
+ <span class="summary_signature">
427
+
428
+ <a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: &quot;&quot;, name: nil, value: nil, metadata: nil, description: nil) &#x21d2; NgrokAPI::Models::Secret </a>
429
+
430
+
431
+
432
+ </span>
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+
441
+
442
+ <span class="summary_desc"><div class='inline'>
443
+ <p>Update an existing Secret by ID.</p>
444
+ </div></span>
445
+
446
+ </li>
447
+
448
+
449
+ <li class="public ">
450
+ <span class="summary_signature">
451
+
452
+ <a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: &quot;&quot;, name: nil, value: nil, metadata: nil, description: nil) &#x21d2; NgrokAPI::Models::Secret </a>
453
+
454
+
455
+
456
+ </span>
457
+
458
+
459
+
460
+
461
+
462
+
463
+
464
+
465
+
466
+ <span class="summary_desc"><div class='inline'>
467
+ <p>Update an existing Secret by ID Throws an exception if API error.</p>
468
+ </div></span>
469
+
470
+ </li>
471
+
472
+
473
+ </ul>
474
+
475
+
476
+ <div id="constructor_details" class="method_details_list">
477
+ <h2>Constructor Details</h2>
478
+
479
+ <div class="method_details first">
480
+ <h3 class="signature first" id="initialize-instance_method">
481
+
482
+ #<strong>initialize</strong>(client:) &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Services::SecretsClient (class)">SecretsClient</a></span></tt>
483
+
484
+
485
+
486
+
487
+
488
+ </h3><div class="docstring">
489
+ <div class="discussion">
490
+
491
+ <p>Returns a new instance of SecretsClient.</p>
492
+
493
+
494
+ </div>
495
+ </div>
496
+ <div class="tags">
497
+
498
+
499
+ </div><table class="source_code">
500
+ <tr>
501
+ <td>
502
+ <pre class="lines">
503
+
504
+
505
+ 20
506
+ 21
507
+ 22</pre>
508
+ </td>
509
+ <td>
510
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/secrets_client.rb', line 20</span>
511
+
512
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='rparen'>)</span>
513
+ <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
514
+ <span class='kw'>end</span></pre>
515
+ </td>
516
+ </tr>
517
+ </table>
518
+ </div>
519
+
520
+ </div>
521
+
522
+ <div id="instance_attr_details" class="attr_details">
523
+ <h2>Instance Attribute Details</h2>
524
+
525
+
526
+ <span id=""></span>
527
+ <div class="method_details first">
528
+ <h3 class="signature first" id="client-instance_method">
529
+
530
+ #<strong>client</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
531
+
532
+
533
+
534
+
535
+
536
+ </h3><div class="docstring">
537
+ <div class="discussion">
538
+
539
+ <p>Returns the value of attribute client.</p>
540
+
541
+
542
+ </div>
543
+ </div>
544
+ <div class="tags">
545
+
546
+
547
+ </div><table class="source_code">
548
+ <tr>
549
+ <td>
550
+ <pre class="lines">
551
+
552
+
553
+ 18
554
+ 19
555
+ 20</pre>
556
+ </td>
557
+ <td>
558
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/secrets_client.rb', line 18</span>
559
+
560
+ <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
561
+ <span class='ivar'>@client</span>
562
+ <span class='kw'>end</span></pre>
563
+ </td>
564
+ </tr>
565
+ </table>
566
+ </div>
567
+
568
+ </div>
569
+
570
+
571
+ <div id="instance_method_details" class="method_details_list">
572
+ <h2>Instance Method Details</h2>
573
+
574
+
575
+ <div class="method_details first">
576
+ <h3 class="signature first" id="create-instance_method">
577
+
578
+ #<strong>create</strong>(name: &quot;&quot;, value: &quot;&quot;, metadata: &quot;&quot;, description: &quot;&quot;, vault_id:) &#x21d2; <tt><span class='object_link'><a href="../Models/Secret.html" title="NgrokAPI::Models::Secret (class)">NgrokAPI::Models::Secret</a></span></tt>
579
+
580
+
581
+
582
+
583
+
584
+ </h3><div class="docstring">
585
+ <div class="discussion">
586
+
587
+ <p>Create a new Secret</p>
588
+
589
+ <p><a href="https://ngrok.com/docs/api#api-secrets-create">ngrok.com/docs/api#api-secrets-create</a></p>
590
+
591
+
592
+ </div>
593
+ </div>
594
+ <div class="tags">
595
+ <p class="tag_title">Parameters:</p>
596
+ <ul class="param">
597
+
598
+ <li>
599
+
600
+ <span class='name'>name</span>
601
+
602
+
603
+ <span class='type'>(<tt>string</tt>)</span>
604
+
605
+
606
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
607
+
608
+
609
+ &mdash;
610
+ <div class='inline'>
611
+ <p>Name of secret</p>
612
+ </div>
613
+
614
+ </li>
615
+
616
+ <li>
617
+
618
+ <span class='name'>value</span>
619
+
620
+
621
+ <span class='type'>(<tt>string</tt>)</span>
622
+
623
+
624
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
625
+
626
+
627
+ &mdash;
628
+ <div class='inline'>
629
+ <p>Value of secret</p>
630
+ </div>
631
+
632
+ </li>
633
+
634
+ <li>
635
+
636
+ <span class='name'>metadata</span>
637
+
638
+
639
+ <span class='type'>(<tt>string</tt>)</span>
640
+
641
+
642
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
643
+
644
+
645
+ &mdash;
646
+ <div class='inline'>
647
+ <p>Arbitrary user-defined metadata for this Secret</p>
648
+ </div>
649
+
650
+ </li>
651
+
652
+ <li>
653
+
654
+ <span class='name'>description</span>
655
+
656
+
657
+ <span class='type'>(<tt>string</tt>)</span>
658
+
659
+
660
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
661
+
662
+
663
+ &mdash;
664
+ <div class='inline'>
665
+ <p>description of Secret</p>
666
+ </div>
667
+
668
+ </li>
669
+
670
+ <li>
671
+
672
+ <span class='name'>vault_id</span>
673
+
674
+
675
+ <span class='type'>(<tt>string</tt>)</span>
676
+
677
+
678
+
679
+ &mdash;
680
+ <div class='inline'>
681
+ <p>unique identifier of the referenced vault</p>
682
+ </div>
683
+
684
+ </li>
685
+
686
+ </ul>
687
+
688
+ <p class="tag_title">Returns:</p>
689
+ <ul class="return">
690
+
691
+ <li>
692
+
693
+
694
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/Secret.html" title="NgrokAPI::Models::Secret (class)">NgrokAPI::Models::Secret</a></span></tt>)</span>
695
+
696
+
697
+
698
+ &mdash;
699
+ <div class='inline'>
700
+ <p>result from the API request</p>
701
+ </div>
702
+
703
+ </li>
704
+
705
+ </ul>
706
+
707
+ </div><table class="source_code">
708
+ <tr>
709
+ <td>
710
+ <pre class="lines">
711
+
712
+
713
+ 35
714
+ 36
715
+ 37
716
+ 38
717
+ 39
718
+ 40
719
+ 41
720
+ 42
721
+ 43
722
+ 44
723
+ 45
724
+ 46
725
+ 47</pre>
726
+ </td>
727
+ <td>
728
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/secrets_client.rb', line 35</span>
729
+
730
+ <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>value:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>vault_id:</span><span class='rparen'>)</span>
731
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/vault_secrets</span><span class='tstring_end'>&#39;</span></span>
732
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
733
+ <span class='rbrace'>}</span>
734
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
735
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>if</span> <span class='id identifier rubyid_name'>name</span>
736
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:value</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span> <span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span>
737
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
738
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
739
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:vault_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_vault_id'>vault_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_vault_id'>vault_id</span>
740
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
741
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Secret.html" title="NgrokAPI::Models::Secret (class)">Secret</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Secret.html#initialize-instance_method" title="NgrokAPI::Models::Secret#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
742
+ <span class='kw'>end</span></pre>
743
+ </td>
744
+ </tr>
745
+ </table>
746
+ </div>
747
+
748
+ <div class="method_details ">
749
+ <h3 class="signature " id="create!-instance_method">
750
+
751
+ #<strong>create!</strong>(name: &quot;&quot;, value: &quot;&quot;, metadata: &quot;&quot;, description: &quot;&quot;, vault_id:) &#x21d2; <tt><span class='object_link'><a href="../Models/Secret.html" title="NgrokAPI::Models::Secret (class)">NgrokAPI::Models::Secret</a></span></tt>
752
+
753
+
754
+
755
+
756
+
757
+ </h3><div class="docstring">
758
+ <div class="discussion">
759
+
760
+ <p>Create a new Secret Throws an exception if API error.</p>
761
+
762
+ <p><a href="https://ngrok.com/docs/api#api-secrets-create">ngrok.com/docs/api#api-secrets-create</a></p>
763
+
764
+
765
+ </div>
766
+ </div>
767
+ <div class="tags">
768
+ <p class="tag_title">Parameters:</p>
769
+ <ul class="param">
770
+
771
+ <li>
772
+
773
+ <span class='name'>name</span>
774
+
775
+
776
+ <span class='type'>(<tt>string</tt>)</span>
777
+
778
+
779
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
780
+
781
+
782
+ &mdash;
783
+ <div class='inline'>
784
+ <p>Name of secret</p>
785
+ </div>
786
+
787
+ </li>
788
+
789
+ <li>
790
+
791
+ <span class='name'>value</span>
792
+
793
+
794
+ <span class='type'>(<tt>string</tt>)</span>
795
+
796
+
797
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
798
+
799
+
800
+ &mdash;
801
+ <div class='inline'>
802
+ <p>Value of secret</p>
803
+ </div>
804
+
805
+ </li>
806
+
807
+ <li>
808
+
809
+ <span class='name'>metadata</span>
810
+
811
+
812
+ <span class='type'>(<tt>string</tt>)</span>
813
+
814
+
815
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
816
+
817
+
818
+ &mdash;
819
+ <div class='inline'>
820
+ <p>Arbitrary user-defined metadata for this Secret</p>
821
+ </div>
822
+
823
+ </li>
824
+
825
+ <li>
826
+
827
+ <span class='name'>description</span>
828
+
829
+
830
+ <span class='type'>(<tt>string</tt>)</span>
831
+
832
+
833
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
834
+
835
+
836
+ &mdash;
837
+ <div class='inline'>
838
+ <p>description of Secret</p>
839
+ </div>
840
+
841
+ </li>
842
+
843
+ <li>
844
+
845
+ <span class='name'>vault_id</span>
846
+
847
+
848
+ <span class='type'>(<tt>string</tt>)</span>
849
+
850
+
851
+
852
+ &mdash;
853
+ <div class='inline'>
854
+ <p>unique identifier of the referenced vault</p>
855
+ </div>
856
+
857
+ </li>
858
+
859
+ </ul>
860
+
861
+ <p class="tag_title">Returns:</p>
862
+ <ul class="return">
863
+
864
+ <li>
865
+
866
+
867
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/Secret.html" title="NgrokAPI::Models::Secret (class)">NgrokAPI::Models::Secret</a></span></tt>)</span>
868
+
869
+
870
+
871
+ &mdash;
872
+ <div class='inline'>
873
+ <p>result from the API request</p>
874
+ </div>
875
+
876
+ </li>
877
+
878
+ </ul>
879
+
880
+ </div><table class="source_code">
881
+ <tr>
882
+ <td>
883
+ <pre class="lines">
884
+
885
+
886
+ 61
887
+ 62
888
+ 63
889
+ 64
890
+ 65
891
+ 66
892
+ 67
893
+ 68
894
+ 69
895
+ 70
896
+ 71
897
+ 72
898
+ 73</pre>
899
+ </td>
900
+ <td>
901
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/secrets_client.rb', line 61</span>
902
+
903
+ <span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span><span class='label'>name:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>value:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>vault_id:</span><span class='rparen'>)</span>
904
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/vault_secrets</span><span class='tstring_end'>&#39;</span></span>
905
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
906
+ <span class='rbrace'>}</span>
907
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
908
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>if</span> <span class='id identifier rubyid_name'>name</span>
909
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:value</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span> <span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span>
910
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
911
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
912
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:vault_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_vault_id'>vault_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_vault_id'>vault_id</span>
913
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
914
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Secret.html" title="NgrokAPI::Models::Secret (class)">Secret</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Secret.html#initialize-instance_method" title="NgrokAPI::Models::Secret#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
915
+ <span class='kw'>end</span></pre>
916
+ </td>
917
+ </tr>
918
+ </table>
919
+ </div>
920
+
921
+ <div class="method_details ">
922
+ <h3 class="signature " id="delete-instance_method">
923
+
924
+ #<strong>delete</strong>(id: &quot;&quot;) &#x21d2; <tt>NgrokAPI::Models::Empty</tt>
925
+
926
+
927
+
928
+
929
+
930
+ </h3><div class="docstring">
931
+ <div class="discussion">
932
+
933
+ <p>Delete a Secret</p>
934
+
935
+ <p><a href="https://ngrok.com/docs/api#api-secrets-delete">ngrok.com/docs/api#api-secrets-delete</a></p>
936
+
937
+
938
+ </div>
939
+ </div>
940
+ <div class="tags">
941
+ <p class="tag_title">Parameters:</p>
942
+ <ul class="param">
943
+
944
+ <li>
945
+
946
+ <span class='name'>id</span>
947
+
948
+
949
+ <span class='type'>(<tt>string</tt>)</span>
950
+
951
+
952
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
953
+
954
+
955
+ &mdash;
956
+ <div class='inline'>
957
+ <p>a resource identifier</p>
958
+ </div>
959
+
960
+ </li>
961
+
962
+ </ul>
963
+
964
+ <p class="tag_title">Returns:</p>
965
+ <ul class="return">
966
+
967
+ <li>
968
+
969
+
970
+ <span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
971
+
972
+
973
+
974
+ &mdash;
975
+ <div class='inline'>
976
+ <p>result from the API request</p>
977
+ </div>
978
+
979
+ </li>
980
+
981
+ </ul>
982
+
983
+ </div><table class="source_code">
984
+ <tr>
985
+ <td>
986
+ <pre class="lines">
987
+
988
+
989
+ 133
990
+ 134
991
+ 135
992
+ 136
993
+ 137
994
+ 138
995
+ 139</pre>
996
+ </td>
997
+ <td>
998
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/secrets_client.rb', line 133</span>
999
+
1000
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
1001
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/vault_secrets/%{id}</span><span class='tstring_end'>&#39;</span></span>
1002
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1003
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1004
+ <span class='rbrace'>}</span>
1005
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='rparen'>)</span>
1006
+ <span class='kw'>end</span></pre>
1007
+ </td>
1008
+ </tr>
1009
+ </table>
1010
+ </div>
1011
+
1012
+ <div class="method_details ">
1013
+ <h3 class="signature " id="delete!-instance_method">
1014
+
1015
+ #<strong>delete!</strong>(id: &quot;&quot;) &#x21d2; <tt>NgrokAPI::Models::Empty</tt>
1016
+
1017
+
1018
+
1019
+
1020
+
1021
+ </h3><div class="docstring">
1022
+ <div class="discussion">
1023
+
1024
+ <p>Delete a Secret Throws an exception if API error.</p>
1025
+
1026
+ <p><a href="https://ngrok.com/docs/api#api-secrets-delete">ngrok.com/docs/api#api-secrets-delete</a></p>
1027
+
1028
+
1029
+ </div>
1030
+ </div>
1031
+ <div class="tags">
1032
+ <p class="tag_title">Parameters:</p>
1033
+ <ul class="param">
1034
+
1035
+ <li>
1036
+
1037
+ <span class='name'>id</span>
1038
+
1039
+
1040
+ <span class='type'>(<tt>string</tt>)</span>
1041
+
1042
+
1043
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
1044
+
1045
+
1046
+ &mdash;
1047
+ <div class='inline'>
1048
+ <p>a resource identifier</p>
1049
+ </div>
1050
+
1051
+ </li>
1052
+
1053
+ </ul>
1054
+
1055
+ <p class="tag_title">Returns:</p>
1056
+ <ul class="return">
1057
+
1058
+ <li>
1059
+
1060
+
1061
+ <span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
1062
+
1063
+
1064
+
1065
+ &mdash;
1066
+ <div class='inline'>
1067
+ <p>result from the API request</p>
1068
+ </div>
1069
+
1070
+ </li>
1071
+
1072
+ </ul>
1073
+
1074
+ </div><table class="source_code">
1075
+ <tr>
1076
+ <td>
1077
+ <pre class="lines">
1078
+
1079
+
1080
+ 149
1081
+ 150
1082
+ 151
1083
+ 152
1084
+ 153
1085
+ 154
1086
+ 155</pre>
1087
+ </td>
1088
+ <td>
1089
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/secrets_client.rb', line 149</span>
1090
+
1091
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
1092
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/vault_secrets/%{id}</span><span class='tstring_end'>&#39;</span></span>
1093
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1094
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1095
+ <span class='rbrace'>}</span>
1096
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
1097
+ <span class='kw'>end</span></pre>
1098
+ </td>
1099
+ </tr>
1100
+ </table>
1101
+ </div>
1102
+
1103
+ <div class="method_details ">
1104
+ <h3 class="signature " id="get-instance_method">
1105
+
1106
+ #<strong>get</strong>(id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/Secret.html" title="NgrokAPI::Models::Secret (class)">NgrokAPI::Models::Secret</a></span></tt>
1107
+
1108
+
1109
+
1110
+
1111
+
1112
+ </h3><div class="docstring">
1113
+ <div class="discussion">
1114
+
1115
+ <p>Get a Secret by ID</p>
1116
+
1117
+ <p><a href="https://ngrok.com/docs/api#api-secrets-get">ngrok.com/docs/api#api-secrets-get</a></p>
1118
+
1119
+
1120
+ </div>
1121
+ </div>
1122
+ <div class="tags">
1123
+ <p class="tag_title">Parameters:</p>
1124
+ <ul class="param">
1125
+
1126
+ <li>
1127
+
1128
+ <span class='name'>id</span>
1129
+
1130
+
1131
+ <span class='type'>(<tt>string</tt>)</span>
1132
+
1133
+
1134
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
1135
+
1136
+
1137
+ &mdash;
1138
+ <div class='inline'>
1139
+ <p>a resource identifier</p>
1140
+ </div>
1141
+
1142
+ </li>
1143
+
1144
+ </ul>
1145
+
1146
+ <p class="tag_title">Returns:</p>
1147
+ <ul class="return">
1148
+
1149
+ <li>
1150
+
1151
+
1152
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/Secret.html" title="NgrokAPI::Models::Secret (class)">NgrokAPI::Models::Secret</a></span></tt>)</span>
1153
+
1154
+
1155
+
1156
+ &mdash;
1157
+ <div class='inline'>
1158
+ <p>result from the API request</p>
1159
+ </div>
1160
+
1161
+ </li>
1162
+
1163
+ </ul>
1164
+
1165
+ </div><table class="source_code">
1166
+ <tr>
1167
+ <td>
1168
+ <pre class="lines">
1169
+
1170
+
1171
+ 164
1172
+ 165
1173
+ 166
1174
+ 167
1175
+ 168
1176
+ 169
1177
+ 170
1178
+ 171
1179
+ 172</pre>
1180
+ </td>
1181
+ <td>
1182
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/secrets_client.rb', line 164</span>
1183
+
1184
+ <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
1185
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/vault_secrets/%{id}</span><span class='tstring_end'>&#39;</span></span>
1186
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1187
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1188
+ <span class='rbrace'>}</span>
1189
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1190
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
1191
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Secret.html" title="NgrokAPI::Models::Secret (class)">Secret</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Secret.html#initialize-instance_method" title="NgrokAPI::Models::Secret#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1192
+ <span class='kw'>end</span></pre>
1193
+ </td>
1194
+ </tr>
1195
+ </table>
1196
+ </div>
1197
+
1198
+ <div class="method_details ">
1199
+ <h3 class="signature " id="get!-instance_method">
1200
+
1201
+ #<strong>get!</strong>(id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/Secret.html" title="NgrokAPI::Models::Secret (class)">NgrokAPI::Models::Secret</a></span></tt>
1202
+
1203
+
1204
+
1205
+
1206
+
1207
+ </h3><div class="docstring">
1208
+ <div class="discussion">
1209
+
1210
+ <p>Get a Secret by ID Throws an exception if API error.</p>
1211
+
1212
+ <p><a href="https://ngrok.com/docs/api#api-secrets-get">ngrok.com/docs/api#api-secrets-get</a></p>
1213
+
1214
+
1215
+ </div>
1216
+ </div>
1217
+ <div class="tags">
1218
+ <p class="tag_title">Parameters:</p>
1219
+ <ul class="param">
1220
+
1221
+ <li>
1222
+
1223
+ <span class='name'>id</span>
1224
+
1225
+
1226
+ <span class='type'>(<tt>string</tt>)</span>
1227
+
1228
+
1229
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
1230
+
1231
+
1232
+ &mdash;
1233
+ <div class='inline'>
1234
+ <p>a resource identifier</p>
1235
+ </div>
1236
+
1237
+ </li>
1238
+
1239
+ </ul>
1240
+
1241
+ <p class="tag_title">Returns:</p>
1242
+ <ul class="return">
1243
+
1244
+ <li>
1245
+
1246
+
1247
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/Secret.html" title="NgrokAPI::Models::Secret (class)">NgrokAPI::Models::Secret</a></span></tt>)</span>
1248
+
1249
+
1250
+
1251
+ &mdash;
1252
+ <div class='inline'>
1253
+ <p>result from the API request</p>
1254
+ </div>
1255
+
1256
+ </li>
1257
+
1258
+ </ul>
1259
+
1260
+ </div><table class="source_code">
1261
+ <tr>
1262
+ <td>
1263
+ <pre class="lines">
1264
+
1265
+
1266
+ 182
1267
+ 183
1268
+ 184
1269
+ 185
1270
+ 186
1271
+ 187
1272
+ 188
1273
+ 189
1274
+ 190</pre>
1275
+ </td>
1276
+ <td>
1277
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/secrets_client.rb', line 182</span>
1278
+
1279
+ <span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
1280
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/vault_secrets/%{id}</span><span class='tstring_end'>&#39;</span></span>
1281
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1282
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1283
+ <span class='rbrace'>}</span>
1284
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1285
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
1286
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Secret.html" title="NgrokAPI::Models::Secret (class)">Secret</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Secret.html#initialize-instance_method" title="NgrokAPI::Models::Secret#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1287
+ <span class='kw'>end</span></pre>
1288
+ </td>
1289
+ </tr>
1290
+ </table>
1291
+ </div>
1292
+
1293
+ <div class="method_details ">
1294
+ <h3 class="signature " id="list-instance_method">
1295
+
1296
+ #<strong>list</strong>(before_id: nil, limit: nil, url: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
1297
+
1298
+
1299
+
1300
+
1301
+
1302
+ </h3><div class="docstring">
1303
+ <div class="discussion">
1304
+
1305
+ <p>List all Secrets owned by account</p>
1306
+
1307
+ <p><a href="https://ngrok.com/docs/api#api-secrets-list">ngrok.com/docs/api#api-secrets-list</a></p>
1308
+
1309
+
1310
+ </div>
1311
+ </div>
1312
+ <div class="tags">
1313
+ <p class="tag_title">Parameters:</p>
1314
+ <ul class="param">
1315
+
1316
+ <li>
1317
+
1318
+ <span class='name'>before_id</span>
1319
+
1320
+
1321
+ <span class='type'>(<tt>string</tt>)</span>
1322
+
1323
+
1324
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1325
+
1326
+
1327
+ </li>
1328
+
1329
+ <li>
1330
+
1331
+ <span class='name'>limit</span>
1332
+
1333
+
1334
+ <span class='type'>(<tt>string</tt>)</span>
1335
+
1336
+
1337
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1338
+
1339
+
1340
+ </li>
1341
+
1342
+ <li>
1343
+
1344
+ <span class='name'>url</span>
1345
+
1346
+
1347
+ <span class='type'>(<tt>string</tt>)</span>
1348
+
1349
+
1350
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1351
+
1352
+
1353
+ &mdash;
1354
+ <div class='inline'>
1355
+ <p>optional and mutually exclusive from before_id and limit</p>
1356
+ </div>
1357
+
1358
+ </li>
1359
+
1360
+ </ul>
1361
+
1362
+ <p class="tag_title">Returns:</p>
1363
+ <ul class="return">
1364
+
1365
+ <li>
1366
+
1367
+
1368
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
1369
+
1370
+
1371
+
1372
+ &mdash;
1373
+ <div class='inline'>
1374
+ <p>result from the API request</p>
1375
+ </div>
1376
+
1377
+ </li>
1378
+
1379
+ </ul>
1380
+
1381
+ </div><table class="source_code">
1382
+ <tr>
1383
+ <td>
1384
+ <pre class="lines">
1385
+
1386
+
1387
+ 201
1388
+ 202
1389
+ 203
1390
+ 204
1391
+ 205
1392
+ 206
1393
+ 207
1394
+ 208
1395
+ 209
1396
+ 210
1397
+ 211
1398
+ 212
1399
+ 213
1400
+ 214
1401
+ 215
1402
+ 216
1403
+ 217
1404
+ 218
1405
+ 219</pre>
1406
+ </td>
1407
+ <td>
1408
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/secrets_client.rb', line 201</span>
1409
+
1410
+ <span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
1411
+ <span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1412
+ <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1413
+ <span class='label'>url:</span> <span class='kw'>nil</span>
1414
+ <span class='rparen'>)</span>
1415
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
1416
+ <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
1417
+ <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
1418
+ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
1419
+ <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SecretsClient::PATH (constant)">PATH</a></span></span>
1420
+ <span class='rparen'>)</span>
1421
+
1422
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
1423
+ <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
1424
+ <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1425
+ <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::SecretsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1426
+ <span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Secret.html" title="NgrokAPI::Models::Secret (class)">Secret</a></span></span>
1427
+ <span class='rparen'>)</span>
1428
+ <span class='kw'>end</span></pre>
1429
+ </td>
1430
+ </tr>
1431
+ </table>
1432
+ </div>
1433
+
1434
+ <div class="method_details ">
1435
+ <h3 class="signature " id="list!-instance_method">
1436
+
1437
+ #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
1438
+
1439
+
1440
+
1441
+
1442
+
1443
+ </h3><div class="docstring">
1444
+ <div class="discussion">
1445
+
1446
+ <p>List all Secrets owned by account Throws an exception if API error.</p>
1447
+
1448
+ <p><a href="https://ngrok.com/docs/api#api-secrets-list">ngrok.com/docs/api#api-secrets-list</a></p>
1449
+
1450
+
1451
+ </div>
1452
+ </div>
1453
+ <div class="tags">
1454
+ <p class="tag_title">Parameters:</p>
1455
+ <ul class="param">
1456
+
1457
+ <li>
1458
+
1459
+ <span class='name'>before_id</span>
1460
+
1461
+
1462
+ <span class='type'>(<tt>string</tt>)</span>
1463
+
1464
+
1465
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1466
+
1467
+
1468
+ </li>
1469
+
1470
+ <li>
1471
+
1472
+ <span class='name'>limit</span>
1473
+
1474
+
1475
+ <span class='type'>(<tt>string</tt>)</span>
1476
+
1477
+
1478
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1479
+
1480
+
1481
+ </li>
1482
+
1483
+ <li>
1484
+
1485
+ <span class='name'>url</span>
1486
+
1487
+
1488
+ <span class='type'>(<tt>string</tt>)</span>
1489
+
1490
+
1491
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1492
+
1493
+
1494
+ &mdash;
1495
+ <div class='inline'>
1496
+ <p>optional and mutually exclusive from before_id and limit</p>
1497
+ </div>
1498
+
1499
+ </li>
1500
+
1501
+ </ul>
1502
+
1503
+ <p class="tag_title">Returns:</p>
1504
+ <ul class="return">
1505
+
1506
+ <li>
1507
+
1508
+
1509
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
1510
+
1511
+
1512
+
1513
+ &mdash;
1514
+ <div class='inline'>
1515
+ <p>result from the API request</p>
1516
+ </div>
1517
+
1518
+ </li>
1519
+
1520
+ </ul>
1521
+
1522
+ </div><table class="source_code">
1523
+ <tr>
1524
+ <td>
1525
+ <pre class="lines">
1526
+
1527
+
1528
+ 231
1529
+ 232
1530
+ 233
1531
+ 234
1532
+ 235
1533
+ 236
1534
+ 237
1535
+ 238
1536
+ 239
1537
+ 240
1538
+ 241
1539
+ 242
1540
+ 243
1541
+ 244
1542
+ 245
1543
+ 246
1544
+ 247
1545
+ 248
1546
+ 249
1547
+ 250
1548
+ 251</pre>
1549
+ </td>
1550
+ <td>
1551
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/secrets_client.rb', line 231</span>
1552
+
1553
+ <span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span>
1554
+ <span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1555
+ <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1556
+ <span class='label'>url:</span> <span class='kw'>nil</span>
1557
+ <span class='rparen'>)</span>
1558
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
1559
+ <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
1560
+ <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
1561
+ <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
1562
+ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
1563
+ <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::SecretsClient::PATH (constant)">PATH</a></span></span>
1564
+ <span class='rparen'>)</span>
1565
+
1566
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
1567
+ <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
1568
+ <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1569
+ <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::SecretsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1570
+ <span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Secret.html" title="NgrokAPI::Models::Secret (class)">Secret</a></span></span><span class='comma'>,</span>
1571
+ <span class='label'>danger:</span> <span class='kw'>true</span>
1572
+ <span class='rparen'>)</span>
1573
+ <span class='kw'>end</span></pre>
1574
+ </td>
1575
+ </tr>
1576
+ </table>
1577
+ </div>
1578
+
1579
+ <div class="method_details ">
1580
+ <h3 class="signature " id="update-instance_method">
1581
+
1582
+ #<strong>update</strong>(id: &quot;&quot;, name: nil, value: nil, metadata: nil, description: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/Secret.html" title="NgrokAPI::Models::Secret (class)">NgrokAPI::Models::Secret</a></span></tt>
1583
+
1584
+
1585
+
1586
+
1587
+
1588
+ </h3><div class="docstring">
1589
+ <div class="discussion">
1590
+
1591
+ <p>Update an existing Secret by ID</p>
1592
+
1593
+ <p><a href="https://ngrok.com/docs/api#api-secrets-update">ngrok.com/docs/api#api-secrets-update</a></p>
1594
+
1595
+
1596
+ </div>
1597
+ </div>
1598
+ <div class="tags">
1599
+ <p class="tag_title">Parameters:</p>
1600
+ <ul class="param">
1601
+
1602
+ <li>
1603
+
1604
+ <span class='name'>id</span>
1605
+
1606
+
1607
+ <span class='type'>(<tt>string</tt>)</span>
1608
+
1609
+
1610
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
1611
+
1612
+
1613
+ &mdash;
1614
+ <div class='inline'>
1615
+ <p>identifier for Secret</p>
1616
+ </div>
1617
+
1618
+ </li>
1619
+
1620
+ <li>
1621
+
1622
+ <span class='name'>name</span>
1623
+
1624
+
1625
+ <span class='type'>(<tt>string</tt>)</span>
1626
+
1627
+
1628
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1629
+
1630
+
1631
+ &mdash;
1632
+ <div class='inline'>
1633
+ <p>Name of secret</p>
1634
+ </div>
1635
+
1636
+ </li>
1637
+
1638
+ <li>
1639
+
1640
+ <span class='name'>value</span>
1641
+
1642
+
1643
+ <span class='type'>(<tt>string</tt>)</span>
1644
+
1645
+
1646
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1647
+
1648
+
1649
+ &mdash;
1650
+ <div class='inline'>
1651
+ <p>Value of secret</p>
1652
+ </div>
1653
+
1654
+ </li>
1655
+
1656
+ <li>
1657
+
1658
+ <span class='name'>metadata</span>
1659
+
1660
+
1661
+ <span class='type'>(<tt>string</tt>)</span>
1662
+
1663
+
1664
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1665
+
1666
+
1667
+ &mdash;
1668
+ <div class='inline'>
1669
+ <p>Arbitrary user-defined metadata for this Secret</p>
1670
+ </div>
1671
+
1672
+ </li>
1673
+
1674
+ <li>
1675
+
1676
+ <span class='name'>description</span>
1677
+
1678
+
1679
+ <span class='type'>(<tt>string</tt>)</span>
1680
+
1681
+
1682
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1683
+
1684
+
1685
+ &mdash;
1686
+ <div class='inline'>
1687
+ <p>description of Secret</p>
1688
+ </div>
1689
+
1690
+ </li>
1691
+
1692
+ </ul>
1693
+
1694
+ <p class="tag_title">Returns:</p>
1695
+ <ul class="return">
1696
+
1697
+ <li>
1698
+
1699
+
1700
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/Secret.html" title="NgrokAPI::Models::Secret (class)">NgrokAPI::Models::Secret</a></span></tt>)</span>
1701
+
1702
+
1703
+
1704
+ &mdash;
1705
+ <div class='inline'>
1706
+ <p>result from the API request</p>
1707
+ </div>
1708
+
1709
+ </li>
1710
+
1711
+ </ul>
1712
+
1713
+ </div><table class="source_code">
1714
+ <tr>
1715
+ <td>
1716
+ <pre class="lines">
1717
+
1718
+
1719
+ 86
1720
+ 87
1721
+ 88
1722
+ 89
1723
+ 90
1724
+ 91
1725
+ 92
1726
+ 93
1727
+ 94
1728
+ 95
1729
+ 96
1730
+ 97
1731
+ 98</pre>
1732
+ </td>
1733
+ <td>
1734
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/secrets_client.rb', line 86</span>
1735
+
1736
+ <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>name:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>value:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1737
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/vault_secrets/%{id}</span><span class='tstring_end'>&#39;</span></span>
1738
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1739
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1740
+ <span class='rbrace'>}</span>
1741
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1742
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>if</span> <span class='id identifier rubyid_name'>name</span>
1743
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:value</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span> <span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span>
1744
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
1745
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
1746
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
1747
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Secret.html" title="NgrokAPI::Models::Secret (class)">Secret</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Secret.html#initialize-instance_method" title="NgrokAPI::Models::Secret#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1748
+ <span class='kw'>end</span></pre>
1749
+ </td>
1750
+ </tr>
1751
+ </table>
1752
+ </div>
1753
+
1754
+ <div class="method_details ">
1755
+ <h3 class="signature " id="update!-instance_method">
1756
+
1757
+ #<strong>update!</strong>(id: &quot;&quot;, name: nil, value: nil, metadata: nil, description: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/Secret.html" title="NgrokAPI::Models::Secret (class)">NgrokAPI::Models::Secret</a></span></tt>
1758
+
1759
+
1760
+
1761
+
1762
+
1763
+ </h3><div class="docstring">
1764
+ <div class="discussion">
1765
+
1766
+ <p>Update an existing Secret by ID Throws an exception if API error.</p>
1767
+
1768
+ <p><a href="https://ngrok.com/docs/api#api-secrets-update">ngrok.com/docs/api#api-secrets-update</a></p>
1769
+
1770
+
1771
+ </div>
1772
+ </div>
1773
+ <div class="tags">
1774
+ <p class="tag_title">Parameters:</p>
1775
+ <ul class="param">
1776
+
1777
+ <li>
1778
+
1779
+ <span class='name'>id</span>
1780
+
1781
+
1782
+ <span class='type'>(<tt>string</tt>)</span>
1783
+
1784
+
1785
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
1786
+
1787
+
1788
+ &mdash;
1789
+ <div class='inline'>
1790
+ <p>identifier for Secret</p>
1791
+ </div>
1792
+
1793
+ </li>
1794
+
1795
+ <li>
1796
+
1797
+ <span class='name'>name</span>
1798
+
1799
+
1800
+ <span class='type'>(<tt>string</tt>)</span>
1801
+
1802
+
1803
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1804
+
1805
+
1806
+ &mdash;
1807
+ <div class='inline'>
1808
+ <p>Name of secret</p>
1809
+ </div>
1810
+
1811
+ </li>
1812
+
1813
+ <li>
1814
+
1815
+ <span class='name'>value</span>
1816
+
1817
+
1818
+ <span class='type'>(<tt>string</tt>)</span>
1819
+
1820
+
1821
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1822
+
1823
+
1824
+ &mdash;
1825
+ <div class='inline'>
1826
+ <p>Value of secret</p>
1827
+ </div>
1828
+
1829
+ </li>
1830
+
1831
+ <li>
1832
+
1833
+ <span class='name'>metadata</span>
1834
+
1835
+
1836
+ <span class='type'>(<tt>string</tt>)</span>
1837
+
1838
+
1839
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1840
+
1841
+
1842
+ &mdash;
1843
+ <div class='inline'>
1844
+ <p>Arbitrary user-defined metadata for this Secret</p>
1845
+ </div>
1846
+
1847
+ </li>
1848
+
1849
+ <li>
1850
+
1851
+ <span class='name'>description</span>
1852
+
1853
+
1854
+ <span class='type'>(<tt>string</tt>)</span>
1855
+
1856
+
1857
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1858
+
1859
+
1860
+ &mdash;
1861
+ <div class='inline'>
1862
+ <p>description of Secret</p>
1863
+ </div>
1864
+
1865
+ </li>
1866
+
1867
+ </ul>
1868
+
1869
+ <p class="tag_title">Returns:</p>
1870
+ <ul class="return">
1871
+
1872
+ <li>
1873
+
1874
+
1875
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/Secret.html" title="NgrokAPI::Models::Secret (class)">NgrokAPI::Models::Secret</a></span></tt>)</span>
1876
+
1877
+
1878
+
1879
+ &mdash;
1880
+ <div class='inline'>
1881
+ <p>result from the API request</p>
1882
+ </div>
1883
+
1884
+ </li>
1885
+
1886
+ </ul>
1887
+
1888
+ </div><table class="source_code">
1889
+ <tr>
1890
+ <td>
1891
+ <pre class="lines">
1892
+
1893
+
1894
+ 112
1895
+ 113
1896
+ 114
1897
+ 115
1898
+ 116
1899
+ 117
1900
+ 118
1901
+ 119
1902
+ 120
1903
+ 121
1904
+ 122
1905
+ 123
1906
+ 124</pre>
1907
+ </td>
1908
+ <td>
1909
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/secrets_client.rb', line 112</span>
1910
+
1911
+ <span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>name:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>value:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1912
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/vault_secrets/%{id}</span><span class='tstring_end'>&#39;</span></span>
1913
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1914
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1915
+ <span class='rbrace'>}</span>
1916
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1917
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>if</span> <span class='id identifier rubyid_name'>name</span>
1918
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:value</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_value'>value</span> <span class='kw'>if</span> <span class='id identifier rubyid_value'>value</span>
1919
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
1920
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
1921
+ <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
1922
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Secret.html" title="NgrokAPI::Models::Secret (class)">Secret</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Secret.html#initialize-instance_method" title="NgrokAPI::Models::Secret#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1923
+ <span class='kw'>end</span></pre>
1924
+ </td>
1925
+ </tr>
1926
+ </table>
1927
+ </div>
1928
+
1929
+ </div>
1930
+
1931
+ </div>
1932
+
1933
+ <div id="footer">
1934
+ Generated on Tue Aug 19 22:49:34 2025 by
1935
+ <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1936
+ 0.9.36 (ruby-3.3.8).
1937
+ </div>
1938
+
1939
+ </div>
1940
+ </body>
1941
+ </html>