ngrok-api 0.12.0 → 0.14.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (290) hide show
  1. checksums.yaml +4 -4
  2. data/.yardopts +1 -0
  3. data/LICENSE +7 -0
  4. data/doc/NgrokAPI/Client.html +184 -182
  5. data/doc/NgrokAPI/Error.html +1 -1
  6. data/doc/NgrokAPI/Errors/NotFoundError.html +1 -1
  7. data/doc/NgrokAPI/Errors.html +1 -1
  8. data/doc/NgrokAPI/HttpClient.html +55 -19
  9. data/doc/NgrokAPI/Models/APIKey.html +1 -1
  10. data/doc/NgrokAPI/Models/AWSAuth.html +1 -1
  11. data/doc/NgrokAPI/Models/AWSCredentials.html +1 -1
  12. data/doc/NgrokAPI/Models/AWSRole.html +1 -1
  13. data/doc/NgrokAPI/Models/AbuseReport.html +1 -1
  14. data/doc/NgrokAPI/Models/AbuseReportHostname.html +1 -1
  15. data/doc/NgrokAPI/Models/CertificateAuthority.html +1 -1
  16. data/doc/NgrokAPI/Models/Credential.html +1 -1
  17. data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +1 -1
  18. data/doc/NgrokAPI/Models/EndpointCompression.html +1 -1
  19. data/doc/NgrokAPI/Models/EndpointConfiguration.html +1 -1
  20. data/doc/NgrokAPI/Models/EndpointIPPolicy.html +1 -1
  21. data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +1 -1
  22. data/doc/NgrokAPI/Models/EndpointLogging.html +1 -1
  23. data/doc/NgrokAPI/Models/EndpointLoggingMutate.html +1 -1
  24. data/doc/NgrokAPI/Models/EndpointMutualTLS.html +1 -1
  25. data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +1 -1
  26. data/doc/NgrokAPI/Models/EndpointOAuth.html +1 -1
  27. data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +1 -1
  28. data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +1 -1
  29. data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +1 -1
  30. data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +1 -1
  31. data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +1 -1
  32. data/doc/NgrokAPI/Models/EndpointOIDC.html +1 -1
  33. data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +1 -1
  34. data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +1 -1
  35. data/doc/NgrokAPI/Models/EndpointSAML.html +1 -1
  36. data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +1 -1
  37. data/doc/NgrokAPI/Models/EndpointTLSTermination.html +1 -1
  38. data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +1 -1
  39. data/doc/NgrokAPI/Models/EventDestination.html +1 -1
  40. data/doc/NgrokAPI/Models/EventSource.html +1 -1
  41. data/doc/NgrokAPI/Models/{ReservedDomainCertNSTarget.html → EventSourceList.html} +42 -42
  42. data/doc/NgrokAPI/Models/EventSourceReplace.html +1 -1
  43. data/doc/NgrokAPI/Models/EventStream.html +1 -1
  44. data/doc/NgrokAPI/Models/EventSubscription.html +1 -1
  45. data/doc/NgrokAPI/Models/EventTarget.html +1 -1
  46. data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +1 -1
  47. data/doc/NgrokAPI/Models/EventTargetFirehose.html +1 -1
  48. data/doc/NgrokAPI/Models/EventTargetKinesis.html +1 -1
  49. data/doc/NgrokAPI/Models/IPPolicy.html +1 -1
  50. data/doc/NgrokAPI/Models/IPPolicyRule.html +1 -1
  51. data/doc/NgrokAPI/Models/IPRestriction.html +1 -1
  52. data/doc/NgrokAPI/Models/IPWhitelistEntry.html +1 -1
  53. data/doc/NgrokAPI/Models/Listable.html +118 -50
  54. data/doc/NgrokAPI/Models/Ref.html +1 -1
  55. data/doc/NgrokAPI/Models/ReservedAddr.html +1 -1
  56. data/doc/NgrokAPI/Models/ReservedDomain.html +91 -17
  57. data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +12 -86
  58. data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +1 -1
  59. data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +1 -1
  60. data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +1 -1
  61. data/doc/NgrokAPI/Models/SSHCredential.html +1 -1
  62. data/doc/NgrokAPI/Models/SSHHostCertificate.html +1 -1
  63. data/doc/NgrokAPI/Models/SSHUserCertificate.html +1 -1
  64. data/doc/NgrokAPI/Models/TLSCertificate.html +1 -1
  65. data/doc/NgrokAPI/Models/TLSCertificateSANs.html +1 -1
  66. data/doc/NgrokAPI/Models/Tunnel.html +1 -1
  67. data/doc/NgrokAPI/Models/TunnelSession.html +1 -1
  68. data/doc/NgrokAPI/Models.html +3 -3
  69. data/doc/NgrokAPI/PagedIterator.html +14 -10
  70. data/doc/NgrokAPI/Services/APIKeysClient.html +227 -62
  71. data/doc/NgrokAPI/Services/AbuseReportsClient.html +2 -5
  72. data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +206 -41
  73. data/doc/NgrokAPI/Services/CredentialsClient.html +213 -47
  74. data/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1 -1
  75. data/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html +1 -1
  76. data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +281 -114
  77. data/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1 -1
  78. data/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html +1 -1
  79. data/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1 -1
  80. data/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html +1 -1
  81. data/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html +1 -1
  82. data/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1 -1
  83. data/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1 -1
  84. data/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html +1 -1
  85. data/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1 -1
  86. data/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1 -1
  87. data/doc/NgrokAPI/Services/EventDestinationsClient.html +221 -50
  88. data/doc/NgrokAPI/Services/EventSourcesClient.html +279 -33
  89. data/doc/NgrokAPI/Services/EventStreamsClient.html +218 -47
  90. data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +213 -42
  91. data/doc/NgrokAPI/Services/IPPoliciesClient.html +207 -41
  92. data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +210 -42
  93. data/doc/NgrokAPI/Services/IPRestrictionsClient.html +215 -51
  94. data/doc/NgrokAPI/Services/IPWhitelistClient.html +206 -38
  95. data/doc/NgrokAPI/Services/ReservedAddrsClient.html +230 -63
  96. data/doc/NgrokAPI/Services/ReservedDomainsClient.html +308 -142
  97. data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +208 -40
  98. data/doc/NgrokAPI/Services/SSHCredentialsClient.html +213 -45
  99. data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +207 -40
  100. data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +209 -42
  101. data/doc/NgrokAPI/Services/TLSCertificatesClient.html +208 -43
  102. data/doc/NgrokAPI/Services/TunnelSessionsClient.html +260 -93
  103. data/doc/NgrokAPI/Services/TunnelsClient.html +174 -6
  104. data/doc/NgrokAPI/Services.html +1 -1
  105. data/doc/NgrokAPI.html +2 -2
  106. data/doc/README +94 -0
  107. data/doc/_index.html +8 -8
  108. data/doc/class_list.html +1 -1
  109. data/doc/file.README.html +53 -26
  110. data/doc/index.html +53 -26
  111. data/doc/method_list.html +822 -630
  112. data/doc/top-level-namespace.html +1 -1
  113. data/docs/NgrokAPI/Client.html +184 -182
  114. data/docs/NgrokAPI/Error.html +1 -1
  115. data/docs/NgrokAPI/Errors/NotFoundError.html +1 -1
  116. data/docs/NgrokAPI/Errors.html +1 -1
  117. data/docs/NgrokAPI/HttpClient.html +55 -19
  118. data/docs/NgrokAPI/Models/APIKey.html +1 -1
  119. data/docs/NgrokAPI/Models/AWSAuth.html +1 -1
  120. data/docs/NgrokAPI/Models/AWSCredentials.html +1 -1
  121. data/docs/NgrokAPI/Models/AWSRole.html +1 -1
  122. data/docs/NgrokAPI/Models/AbuseReport.html +1 -1
  123. data/docs/NgrokAPI/Models/AbuseReportHostname.html +1 -1
  124. data/docs/NgrokAPI/Models/CertificateAuthority.html +1 -1
  125. data/docs/NgrokAPI/Models/Credential.html +1 -1
  126. data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +1 -1
  127. data/docs/NgrokAPI/Models/EndpointCompression.html +1 -1
  128. data/docs/NgrokAPI/Models/EndpointConfiguration.html +1 -1
  129. data/docs/NgrokAPI/Models/EndpointIPPolicy.html +1 -1
  130. data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +1 -1
  131. data/docs/NgrokAPI/Models/EndpointLogging.html +1 -1
  132. data/docs/NgrokAPI/Models/EndpointLoggingMutate.html +1 -1
  133. data/docs/NgrokAPI/Models/EndpointMutualTLS.html +1 -1
  134. data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +1 -1
  135. data/docs/NgrokAPI/Models/EndpointOAuth.html +1 -1
  136. data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +1 -1
  137. data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +1 -1
  138. data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +1 -1
  139. data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +1 -1
  140. data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +1 -1
  141. data/docs/NgrokAPI/Models/EndpointOIDC.html +1 -1
  142. data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +1 -1
  143. data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +1 -1
  144. data/docs/NgrokAPI/Models/EndpointSAML.html +1 -1
  145. data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +1 -1
  146. data/docs/NgrokAPI/Models/EndpointTLSTermination.html +1 -1
  147. data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +1 -1
  148. data/docs/NgrokAPI/Models/EventDestination.html +1 -1
  149. data/docs/NgrokAPI/Models/EventSource.html +1 -1
  150. data/docs/NgrokAPI/Models/{ReservedDomainCertNSTarget.html → EventSourceList.html} +42 -42
  151. data/docs/NgrokAPI/Models/EventSourceReplace.html +1 -1
  152. data/docs/NgrokAPI/Models/EventStream.html +1 -1
  153. data/docs/NgrokAPI/Models/EventSubscription.html +1 -1
  154. data/docs/NgrokAPI/Models/EventTarget.html +1 -1
  155. data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +1 -1
  156. data/docs/NgrokAPI/Models/EventTargetFirehose.html +1 -1
  157. data/docs/NgrokAPI/Models/EventTargetKinesis.html +1 -1
  158. data/docs/NgrokAPI/Models/IPPolicy.html +1 -1
  159. data/docs/NgrokAPI/Models/IPPolicyRule.html +1 -1
  160. data/docs/NgrokAPI/Models/IPRestriction.html +1 -1
  161. data/docs/NgrokAPI/Models/IPWhitelistEntry.html +1 -1
  162. data/docs/NgrokAPI/Models/Listable.html +118 -50
  163. data/docs/NgrokAPI/Models/Ref.html +1 -1
  164. data/docs/NgrokAPI/Models/ReservedAddr.html +1 -1
  165. data/docs/NgrokAPI/Models/ReservedDomain.html +91 -17
  166. data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +12 -86
  167. data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +1 -1
  168. data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +1 -1
  169. data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +1 -1
  170. data/docs/NgrokAPI/Models/SSHCredential.html +1 -1
  171. data/docs/NgrokAPI/Models/SSHHostCertificate.html +1 -1
  172. data/docs/NgrokAPI/Models/SSHUserCertificate.html +1 -1
  173. data/docs/NgrokAPI/Models/TLSCertificate.html +1 -1
  174. data/docs/NgrokAPI/Models/TLSCertificateSANs.html +1 -1
  175. data/docs/NgrokAPI/Models/Tunnel.html +1 -1
  176. data/docs/NgrokAPI/Models/TunnelSession.html +1 -1
  177. data/docs/NgrokAPI/Models.html +3 -3
  178. data/docs/NgrokAPI/PagedIterator.html +14 -10
  179. data/docs/NgrokAPI/Services/APIKeysClient.html +227 -62
  180. data/docs/NgrokAPI/Services/AbuseReportsClient.html +2 -5
  181. data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +206 -41
  182. data/docs/NgrokAPI/Services/CredentialsClient.html +213 -47
  183. data/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1 -1
  184. data/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html +1 -1
  185. data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +281 -114
  186. data/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1 -1
  187. data/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html +1 -1
  188. data/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1 -1
  189. data/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html +1 -1
  190. data/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html +1 -1
  191. data/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1 -1
  192. data/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1 -1
  193. data/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html +1 -1
  194. data/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1 -1
  195. data/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1 -1
  196. data/docs/NgrokAPI/Services/EventDestinationsClient.html +221 -50
  197. data/docs/NgrokAPI/Services/EventSourcesClient.html +279 -33
  198. data/docs/NgrokAPI/Services/EventStreamsClient.html +218 -47
  199. data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +213 -42
  200. data/docs/NgrokAPI/Services/IPPoliciesClient.html +207 -41
  201. data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +210 -42
  202. data/docs/NgrokAPI/Services/IPRestrictionsClient.html +215 -51
  203. data/docs/NgrokAPI/Services/IPWhitelistClient.html +206 -38
  204. data/docs/NgrokAPI/Services/ReservedAddrsClient.html +230 -63
  205. data/docs/NgrokAPI/Services/ReservedDomainsClient.html +308 -142
  206. data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +208 -40
  207. data/docs/NgrokAPI/Services/SSHCredentialsClient.html +213 -45
  208. data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +207 -40
  209. data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +209 -42
  210. data/docs/NgrokAPI/Services/TLSCertificatesClient.html +208 -43
  211. data/docs/NgrokAPI/Services/TunnelSessionsClient.html +260 -93
  212. data/docs/NgrokAPI/Services/TunnelsClient.html +174 -6
  213. data/docs/NgrokAPI/Services.html +1 -1
  214. data/docs/NgrokAPI.html +2 -2
  215. data/docs/README +94 -0
  216. data/docs/_index.html +8 -8
  217. data/docs/class_list.html +1 -1
  218. data/docs/file.README.html +53 -26
  219. data/docs/index.html +53 -26
  220. data/docs/method_list.html +822 -630
  221. data/docs/top-level-namespace.html +1 -1
  222. data/lib/ngrokapi/client.rb +27 -8
  223. data/lib/ngrokapi/http_client.rb +5 -3
  224. data/lib/ngrokapi/models/{reserved_domain_cert_ns_target.rb → event_source_list.rb} +5 -5
  225. data/lib/ngrokapi/models/listable.rb +13 -2
  226. data/lib/ngrokapi/models/reserved_domain.rb +3 -1
  227. data/lib/ngrokapi/models/reserved_domain_cert_job.rb +1 -3
  228. data/lib/ngrokapi/paged_iterator.rb +4 -2
  229. data/lib/ngrokapi/services/api_keys_client.rb +36 -4
  230. data/lib/ngrokapi/services/certificate_authorities_client.rb +33 -0
  231. data/lib/ngrokapi/services/credentials_client.rb +35 -2
  232. data/lib/ngrokapi/services/endpoint_configurations_client.rb +33 -0
  233. data/lib/ngrokapi/services/event_destinations_client.rb +33 -0
  234. data/lib/ngrokapi/services/event_sources_client.rb +39 -0
  235. data/lib/ngrokapi/services/event_streams_client.rb +33 -0
  236. data/lib/ngrokapi/services/event_subscriptions_client.rb +33 -0
  237. data/lib/ngrokapi/services/ip_policies_client.rb +34 -1
  238. data/lib/ngrokapi/services/ip_policy_rules_client.rb +33 -0
  239. data/lib/ngrokapi/services/ip_restrictions_client.rb +33 -0
  240. data/lib/ngrokapi/services/ip_whitelist_client.rb +34 -1
  241. data/lib/ngrokapi/services/reserved_addrs_client.rb +33 -0
  242. data/lib/ngrokapi/services/reserved_domains_client.rb +33 -0
  243. data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +33 -0
  244. data/lib/ngrokapi/services/ssh_credentials_client.rb +33 -0
  245. data/lib/ngrokapi/services/ssh_host_certificates_client.rb +33 -0
  246. data/lib/ngrokapi/services/ssh_user_certificates_client.rb +33 -0
  247. data/lib/ngrokapi/services/tls_certificates_client.rb +33 -0
  248. data/lib/ngrokapi/services/tunnel_sessions_client.rb +33 -0
  249. data/lib/ngrokapi/services/tunnels_client.rb +33 -0
  250. data/lib/ngrokapi/version.rb +1 -1
  251. data/spec/ngrokapi/client_spec.rb +19 -0
  252. data/spec/ngrokapi/models/event_source_list_spec.rb +21 -0
  253. data/spec/ngrokapi/paged_iterator_spec.rb +2 -2
  254. data/spec/ngrokapi/services/abuse_reports_client_spec.rb +0 -2
  255. data/spec/ngrokapi/services/api_keys_client_spec.rb +0 -3
  256. data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +0 -3
  257. data/spec/ngrokapi/services/credentials_client_spec.rb +0 -3
  258. data/spec/ngrokapi/services/endpoint_circuit_breaker_module_client_spec.rb +0 -2
  259. data/spec/ngrokapi/services/endpoint_compression_module_client_spec.rb +0 -2
  260. data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +0 -3
  261. data/spec/ngrokapi/services/endpoint_ip_policy_module_client_spec.rb +0 -2
  262. data/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb +0 -2
  263. data/spec/ngrokapi/services/endpoint_mutual_tls_module_client_spec.rb +0 -2
  264. data/spec/ngrokapi/services/endpoint_o_auth_module_client_spec.rb +0 -2
  265. data/spec/ngrokapi/services/endpoint_oidc_module_client_spec.rb +0 -2
  266. data/spec/ngrokapi/services/endpoint_request_headers_module_client_spec.rb +0 -2
  267. data/spec/ngrokapi/services/endpoint_response_headers_module_client_spec.rb +0 -2
  268. data/spec/ngrokapi/services/endpoint_saml_module_client_spec.rb +0 -2
  269. data/spec/ngrokapi/services/endpoint_tls_termination_module_client_spec.rb +0 -2
  270. data/spec/ngrokapi/services/endpoint_webhook_validation_module_client_spec.rb +0 -2
  271. data/spec/ngrokapi/services/event_destinations_client_spec.rb +0 -3
  272. data/spec/ngrokapi/services/event_sources_client_spec.rb +33 -3
  273. data/spec/ngrokapi/services/event_streams_client_spec.rb +0 -3
  274. data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +0 -3
  275. data/spec/ngrokapi/services/ip_policies_client_spec.rb +0 -3
  276. data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +0 -3
  277. data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +0 -3
  278. data/spec/ngrokapi/services/ip_whitelist_client_spec.rb +0 -3
  279. data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +0 -3
  280. data/spec/ngrokapi/services/reserved_domains_client_spec.rb +0 -3
  281. data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +0 -3
  282. data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +0 -3
  283. data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +0 -3
  284. data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +0 -3
  285. data/spec/ngrokapi/services/tls_certificates_client_spec.rb +0 -3
  286. data/spec/ngrokapi/services/tunnel_sessions_client_spec.rb +0 -1
  287. data/spec/spec_helper.rb +7 -0
  288. metadata +10 -7
  289. data/doc/.gitkeep +0 -0
  290. data/spec/ngrokapi/models/reserved_domain_cert_ns_target_spec.rb +0 -21
@@ -102,10 +102,7 @@
102
102
  <h2>Overview</h2><div class="docstring">
103
103
  <div class="discussion">
104
104
 
105
- <p>Tunnels provide endpoints to access services exposed by a running ngrok</p>
106
-
107
- <pre class="code ruby"><code class="ruby">agent tunnel session or an SSH reverse tunnel session.
108
- </code></pre>
105
+ <p>Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.</p>
109
106
 
110
107
  <p><a href="https://ngrok.com/docs/api#api-tunnels">ngrok.com/docs/api#api-tunnels</a></p>
111
108
 
@@ -250,6 +247,30 @@
250
247
 
251
248
 
252
249
 
250
+ <span class="summary_desc"><div class='inline'>
251
+ <p>List all online tunnels currently running on the account.</p>
252
+ </div></span>
253
+
254
+ </li>
255
+
256
+
257
+ <li class="public ">
258
+ <span class="summary_signature">
259
+
260
+ <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) &#x21d2; NgrokAPI::Models::Listable </a>
261
+
262
+
263
+
264
+ </span>
265
+
266
+
267
+
268
+
269
+
270
+
271
+
272
+
273
+
253
274
  <span class="summary_desc"><div class='inline'>
254
275
  <p>List all online tunnels currently running on the account.</p>
255
276
  </div></span>
@@ -470,7 +491,8 @@
470
491
  45
471
492
  46
472
493
  47
473
- 48</pre>
494
+ 48
495
+ 49</pre>
474
496
  </td>
475
497
  <td>
476
498
  <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnels_client.rb', line 31</span>
@@ -486,6 +508,7 @@
486
508
  <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
487
509
  <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::TunnelsClient::PATH (constant)">PATH</a></span></span>
488
510
  <span class='rparen'>)</span>
511
+
489
512
  <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>
490
513
  <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
491
514
  <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
@@ -496,6 +519,151 @@
496
519
  </td>
497
520
  </tr>
498
521
  </table>
522
+ </div>
523
+
524
+ <div class="method_details ">
525
+ <h3 class="signature " id="list!-instance_method">
526
+
527
+ #<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>
528
+
529
+
530
+
531
+
532
+
533
+ </h3><div class="docstring">
534
+ <div class="discussion">
535
+
536
+ <p>List all online tunnels currently running on the account. Throws an exception if API error.</p>
537
+
538
+ <p><a href="https://ngrok.com/docs/api#api-tunnels-list">ngrok.com/docs/api#api-tunnels-list</a></p>
539
+
540
+
541
+ </div>
542
+ </div>
543
+ <div class="tags">
544
+ <p class="tag_title">Parameters:</p>
545
+ <ul class="param">
546
+
547
+ <li>
548
+
549
+ <span class='name'>before_id</span>
550
+
551
+
552
+ <span class='type'>(<tt>string</tt>)</span>
553
+
554
+
555
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
556
+
557
+
558
+ </li>
559
+
560
+ <li>
561
+
562
+ <span class='name'>limit</span>
563
+
564
+
565
+ <span class='type'>(<tt>string</tt>)</span>
566
+
567
+
568
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
569
+
570
+
571
+ </li>
572
+
573
+ <li>
574
+
575
+ <span class='name'>url</span>
576
+
577
+
578
+ <span class='type'>(<tt>string</tt>)</span>
579
+
580
+
581
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
582
+
583
+
584
+ &mdash;
585
+ <div class='inline'>
586
+ <p>optional and mutually exclusive from before_id and limit</p>
587
+ </div>
588
+
589
+ </li>
590
+
591
+ </ul>
592
+
593
+ <p class="tag_title">Returns:</p>
594
+ <ul class="return">
595
+
596
+ <li>
597
+
598
+
599
+ <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>
600
+
601
+
602
+
603
+ &mdash;
604
+ <div class='inline'>
605
+ <p>result from the API request</p>
606
+ </div>
607
+
608
+ </li>
609
+
610
+ </ul>
611
+
612
+ </div><table class="source_code">
613
+ <tr>
614
+ <td>
615
+ <pre class="lines">
616
+
617
+
618
+ 61
619
+ 62
620
+ 63
621
+ 64
622
+ 65
623
+ 66
624
+ 67
625
+ 68
626
+ 69
627
+ 70
628
+ 71
629
+ 72
630
+ 73
631
+ 74
632
+ 75
633
+ 76
634
+ 77
635
+ 78
636
+ 79
637
+ 80
638
+ 81</pre>
639
+ </td>
640
+ <td>
641
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnels_client.rb', line 61</span>
642
+
643
+ <span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span>
644
+ <span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
645
+ <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
646
+ <span class='label'>url:</span> <span class='kw'>nil</span>
647
+ <span class='rparen'>)</span>
648
+ <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>
649
+ <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
650
+ <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
651
+ <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
652
+ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
653
+ <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::TunnelsClient::PATH (constant)">PATH</a></span></span>
654
+ <span class='rparen'>)</span>
655
+
656
+ <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>
657
+ <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
658
+ <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
659
+ <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::TunnelsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
660
+ <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/Tunnel.html" title="NgrokAPI::Models::Tunnel (class)">Tunnel</a></span></span><span class='comma'>,</span>
661
+ <span class='label'>danger:</span> <span class='kw'>true</span>
662
+ <span class='rparen'>)</span>
663
+ <span class='kw'>end</span></pre>
664
+ </td>
665
+ </tr>
666
+ </table>
499
667
  </div>
500
668
 
501
669
  </div>
@@ -503,7 +671,7 @@
503
671
  </div>
504
672
 
505
673
  <div id="footer">
506
- Generated on Mon Oct 4 23:24:16 2021 by
674
+ Generated on Tue Oct 19 15:48:19 2021 by
507
675
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
508
676
  0.9.26 (ruby-3.0.1).
509
677
  </div>
@@ -107,7 +107,7 @@
107
107
  </div>
108
108
 
109
109
  <div id="footer">
110
- Generated on Mon Oct 4 23:24:15 2021 by
110
+ Generated on Tue Oct 19 15:48:17 2021 by
111
111
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
112
112
  0.9.26 (ruby-3.0.1).
113
113
  </div>
data/docs/NgrokAPI.html CHANGED
@@ -79,7 +79,7 @@
79
79
  <dl>
80
80
  <dt>Defined in:</dt>
81
81
  <dd>lib/ngrokapi.rb<span class="defines">,<br />
82
- lib/ngrokapi/error.rb,<br /> lib/ngrokapi/client.rb,<br /> lib/ngrokapi/version.rb,<br /> lib/ngrokapi/models/ref.rb,<br /> lib/ngrokapi/http_client.rb,<br /> lib/ngrokapi/models/tunnel.rb,<br /> lib/ngrokapi/models/api_key.rb,<br /> lib/ngrokapi/paged_iterator.rb,<br /> lib/ngrokapi/models/aws_auth.rb,<br /> lib/ngrokapi/models/aws_role.rb,<br /> lib/ngrokapi/models/listable.rb,<br /> lib/ngrokapi/models/ip_policy.rb,<br /> lib/ngrokapi/models/credential.rb,<br /> lib/ngrokapi/models/abuse_report.rb,<br /> lib/ngrokapi/models/event_source.rb,<br /> lib/ngrokapi/models/event_stream.rb,<br /> lib/ngrokapi/models/event_target.rb,<br /> lib/ngrokapi/models/endpoint_oidc.rb,<br /> lib/ngrokapi/models/endpoint_saml.rb,<br /> lib/ngrokapi/models/reserved_addr.rb,<br /> lib/ngrokapi/models/ip_policy_rule.rb,<br /> lib/ngrokapi/models/ip_restriction.rb,<br /> lib/ngrokapi/models/ssh_credential.rb,<br /> lib/ngrokapi/models/tunnel_session.rb,<br /> lib/ngrokapi/errors/not_found_error.rb,<br /> lib/ngrokapi/models/aws_credentials.rb,<br /> lib/ngrokapi/models/endpoint_o_auth.rb,<br /> lib/ngrokapi/models/reserved_domain.rb,<br /> lib/ngrokapi/models/tls_certificate.rb,<br /> lib/ngrokapi/models/endpoint_logging.rb,<br /> lib/ngrokapi/services/tunnels_client.rb,<br /> lib/ngrokapi/models/event_destination.rb,<br /> lib/ngrokapi/services/api_keys_client.rb,<br /> lib/ngrokapi/models/endpoint_ip_policy.rb,<br /> lib/ngrokapi/models/event_subscription.rb,<br /> lib/ngrokapi/models/ip_whitelist_entry.rb,<br /> lib/ngrokapi/models/endpoint_mutual_tls.rb,<br /> lib/ngrokapi/models/endpoint_compression.rb,<br /> lib/ngrokapi/models/endpoint_saml_mutate.rb,<br /> lib/ngrokapi/models/event_source_replace.rb,<br /> lib/ngrokapi/models/event_target_kinesis.rb,<br /> lib/ngrokapi/models/ssh_host_certificate.rb,<br /> lib/ngrokapi/models/ssh_user_certificate.rb,<br /> lib/ngrokapi/services/credentials_client.rb,<br /> lib/ngrokapi/services/ip_policies_client.rb,<br /> lib/ngrokapi/models/abuse_report_hostname.rb,<br /> lib/ngrokapi/models/certificate_authority.rb,<br /> lib/ngrokapi/models/event_target_firehose.rb,<br /> lib/ngrokapi/models/tls_certificate_sa_ns.rb,<br /> lib/ngrokapi/services/ip_whitelist_client.rb,<br /> lib/ngrokapi/models/endpoint_configuration.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_google.rb,<br /> lib/ngrokapi/services/abuse_reports_client.rb,<br /> lib/ngrokapi/services/event_sources_client.rb,<br /> lib/ngrokapi/services/event_streams_client.rb,<br /> lib/ngrokapi/models/endpoint_logging_mutate.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,<br /> lib/ngrokapi/services/reserved_addrs_client.rb,<br /> lib/ngrokapi/models/endpoint_circuit_breaker.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_facebook.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_provider.rb,<br /> lib/ngrokapi/models/endpoint_request_headers.rb,<br /> lib/ngrokapi/models/endpoint_tls_termination.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_job.rb,<br /> lib/ngrokapi/services/ip_policy_rules_client.rb,<br /> lib/ngrokapi/services/ip_restrictions_client.rb,<br /> lib/ngrokapi/services/ssh_credentials_client.rb,<br /> lib/ngrokapi/services/tunnel_sessions_client.rb,<br /> lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,<br /> lib/ngrokapi/models/endpoint_response_headers.rb,<br /> lib/ngrokapi/models/ssh_certificate_authority.rb,<br /> lib/ngrokapi/services/reserved_domains_client.rb,<br /> lib/ngrokapi/services/tls_certificates_client.rb,<br /> lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,<br /> lib/ngrokapi/models/endpoint_webhook_validation.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_policy.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_status.rb,<br /> lib/ngrokapi/services/event_destinations_client.rb,<br /> lib/ngrokapi/models/event_target_cloudwatch_logs.rb,<br /> lib/ngrokapi/services/event_subscriptions_client.rb,<br /> lib/ngrokapi/services/endpoint_oidc_module_client.rb,<br /> lib/ngrokapi/services/endpoint_saml_module_client.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_ns_target.rb,<br /> lib/ngrokapi/services/ssh_host_certificates_client.rb,<br /> lib/ngrokapi/services/ssh_user_certificates_client.rb,<br /> lib/ngrokapi/services/endpoint_o_auth_module_client.rb,<br /> lib/ngrokapi/services/certificate_authorities_client.rb,<br /> lib/ngrokapi/services/endpoint_configurations_client.rb,<br /> lib/ngrokapi/services/endpoint_logging_module_client.rb,<br /> lib/ngrokapi/services/endpoint_ip_policy_module_client.rb,<br /> lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb,<br /> lib/ngrokapi/services/endpoint_compression_module_client.rb,<br /> lib/ngrokapi/services/ssh_certificate_authorities_client.rb,<br /> lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb,<br /> lib/ngrokapi/services/endpoint_request_headers_module_client.rb,<br /> lib/ngrokapi/services/endpoint_tls_termination_module_client.rb,<br /> lib/ngrokapi/services/endpoint_response_headers_module_client.rb,<br /> lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb</span>
82
+ lib/ngrokapi/error.rb,<br /> lib/ngrokapi/client.rb,<br /> lib/ngrokapi/version.rb,<br /> lib/ngrokapi/models/ref.rb,<br /> lib/ngrokapi/http_client.rb,<br /> lib/ngrokapi/models/tunnel.rb,<br /> lib/ngrokapi/models/api_key.rb,<br /> lib/ngrokapi/paged_iterator.rb,<br /> lib/ngrokapi/models/aws_auth.rb,<br /> lib/ngrokapi/models/aws_role.rb,<br /> lib/ngrokapi/models/listable.rb,<br /> lib/ngrokapi/models/ip_policy.rb,<br /> lib/ngrokapi/models/credential.rb,<br /> lib/ngrokapi/models/abuse_report.rb,<br /> lib/ngrokapi/models/event_source.rb,<br /> lib/ngrokapi/models/event_stream.rb,<br /> lib/ngrokapi/models/event_target.rb,<br /> lib/ngrokapi/models/endpoint_oidc.rb,<br /> lib/ngrokapi/models/endpoint_saml.rb,<br /> lib/ngrokapi/models/reserved_addr.rb,<br /> lib/ngrokapi/models/ip_policy_rule.rb,<br /> lib/ngrokapi/models/ip_restriction.rb,<br /> lib/ngrokapi/models/ssh_credential.rb,<br /> lib/ngrokapi/models/tunnel_session.rb,<br /> lib/ngrokapi/errors/not_found_error.rb,<br /> lib/ngrokapi/models/aws_credentials.rb,<br /> lib/ngrokapi/models/endpoint_o_auth.rb,<br /> lib/ngrokapi/models/reserved_domain.rb,<br /> lib/ngrokapi/models/tls_certificate.rb,<br /> lib/ngrokapi/models/endpoint_logging.rb,<br /> lib/ngrokapi/services/tunnels_client.rb,<br /> lib/ngrokapi/models/event_destination.rb,<br /> lib/ngrokapi/models/event_source_list.rb,<br /> lib/ngrokapi/services/api_keys_client.rb,<br /> lib/ngrokapi/models/endpoint_ip_policy.rb,<br /> lib/ngrokapi/models/event_subscription.rb,<br /> lib/ngrokapi/models/ip_whitelist_entry.rb,<br /> lib/ngrokapi/models/endpoint_mutual_tls.rb,<br /> lib/ngrokapi/models/endpoint_compression.rb,<br /> lib/ngrokapi/models/endpoint_saml_mutate.rb,<br /> lib/ngrokapi/models/event_source_replace.rb,<br /> lib/ngrokapi/models/event_target_kinesis.rb,<br /> lib/ngrokapi/models/ssh_host_certificate.rb,<br /> lib/ngrokapi/models/ssh_user_certificate.rb,<br /> lib/ngrokapi/services/credentials_client.rb,<br /> lib/ngrokapi/services/ip_policies_client.rb,<br /> lib/ngrokapi/models/abuse_report_hostname.rb,<br /> lib/ngrokapi/models/certificate_authority.rb,<br /> lib/ngrokapi/models/event_target_firehose.rb,<br /> lib/ngrokapi/models/tls_certificate_sa_ns.rb,<br /> lib/ngrokapi/services/ip_whitelist_client.rb,<br /> lib/ngrokapi/models/endpoint_configuration.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_google.rb,<br /> lib/ngrokapi/services/abuse_reports_client.rb,<br /> lib/ngrokapi/services/event_sources_client.rb,<br /> lib/ngrokapi/services/event_streams_client.rb,<br /> lib/ngrokapi/models/endpoint_logging_mutate.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,<br /> lib/ngrokapi/services/reserved_addrs_client.rb,<br /> lib/ngrokapi/models/endpoint_circuit_breaker.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_facebook.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_provider.rb,<br /> lib/ngrokapi/models/endpoint_request_headers.rb,<br /> lib/ngrokapi/models/endpoint_tls_termination.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_job.rb,<br /> lib/ngrokapi/services/ip_policy_rules_client.rb,<br /> lib/ngrokapi/services/ip_restrictions_client.rb,<br /> lib/ngrokapi/services/ssh_credentials_client.rb,<br /> lib/ngrokapi/services/tunnel_sessions_client.rb,<br /> lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,<br /> lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,<br /> lib/ngrokapi/models/endpoint_response_headers.rb,<br /> lib/ngrokapi/models/ssh_certificate_authority.rb,<br /> lib/ngrokapi/services/reserved_domains_client.rb,<br /> lib/ngrokapi/services/tls_certificates_client.rb,<br /> lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,<br /> lib/ngrokapi/models/endpoint_webhook_validation.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_policy.rb,<br /> lib/ngrokapi/models/reserved_domain_cert_status.rb,<br /> lib/ngrokapi/services/event_destinations_client.rb,<br /> lib/ngrokapi/models/event_target_cloudwatch_logs.rb,<br /> lib/ngrokapi/services/event_subscriptions_client.rb,<br /> lib/ngrokapi/services/endpoint_oidc_module_client.rb,<br /> lib/ngrokapi/services/endpoint_saml_module_client.rb,<br /> lib/ngrokapi/services/ssh_host_certificates_client.rb,<br /> lib/ngrokapi/services/ssh_user_certificates_client.rb,<br /> lib/ngrokapi/services/endpoint_o_auth_module_client.rb,<br /> lib/ngrokapi/services/certificate_authorities_client.rb,<br /> lib/ngrokapi/services/endpoint_configurations_client.rb,<br /> lib/ngrokapi/services/endpoint_logging_module_client.rb,<br /> lib/ngrokapi/services/endpoint_ip_policy_module_client.rb,<br /> lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb,<br /> lib/ngrokapi/services/endpoint_compression_module_client.rb,<br /> lib/ngrokapi/services/ssh_certificate_authorities_client.rb,<br /> lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb,<br /> lib/ngrokapi/services/endpoint_request_headers_module_client.rb,<br /> lib/ngrokapi/services/endpoint_tls_termination_module_client.rb,<br /> lib/ngrokapi/services/endpoint_response_headers_module_client.rb,<br /> lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb</span>
83
83
  </dd>
84
84
  </dl>
85
85
 
@@ -147,7 +147,7 @@
147
147
  </div>
148
148
 
149
149
  <div id="footer">
150
- Generated on Mon Oct 4 23:24:15 2021 by
150
+ Generated on Tue Oct 19 15:48:17 2021 by
151
151
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
152
152
  0.9.26 (ruby-3.0.1).
153
153
  </div>
data/docs/README ADDED
@@ -0,0 +1,94 @@
1
+ # ngrok-api
2
+
3
+ This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make it
4
+ easier to consume in Ruby.
5
+
6
+ ## Installation
7
+
8
+ This library is published on [Rubygems](https://rubygems.org/gems/ngrok-api)
9
+
10
+ ```ruby
11
+ gem install ngrok-api
12
+ ```
13
+
14
+ ## Quickstart
15
+
16
+ Please consult the [documentation](https://ruby-api.docs.ngrok.com) for additional examples.
17
+
18
+ ```ruby
19
+ require 'ngrokapi'
20
+ client = NgrokAPI::Client.new(api_key: '<API KEY>')
21
+
22
+ # Get an instance of the api_keys client and list all API keys
23
+ keys_client = client.api_keys
24
+ keys_client.list
25
+ ```
26
+
27
+ ## Automatic Paging
28
+
29
+ The ngrok API pages all list resources but this library abstracts that away
30
+ from you. All response objects from any ``list`` or ``list!`` methods return an object that
31
+ implements an ``each`` method which will automatically fetch additional
32
+ pages for you.
33
+
34
+ ```ruby
35
+ require 'ngrokapi'
36
+ client = NgrokAPI::Client.new(api_key: '<API KEY>')
37
+
38
+ # list all api keys, transparently fetching additional
39
+ # pages for you if necessary
40
+ keys_client = client.api_keys
41
+ keys_client.list.each do |key|
42
+ puts(key)
43
+ end
44
+ ```
45
+
46
+ ## Instance Methods
47
+
48
+ Instance methods like ``update`` and ``delete`` can be invoked on an instance of an
49
+ API object itself as well as directly without needing to first fetch the object.
50
+
51
+ ```ruby
52
+ require 'ngrokapi'
53
+ client = NgrokAPI::Client.new(api_key: '<API KEY>')
54
+
55
+ # update the metadata of a credential
56
+ cred = client.credentials.get(id: 'cr_1kYyunEyn6XHHlqyMBLrj5nxkoz')
57
+ cred.update(metadata: {server_name: 'giraffe-1'}.to_json)
58
+
59
+ # or do it in single call
60
+ cred = client.credentials.update(id: 'cr_1kYyunEyn6XHHlqyMBLrj5nxkoz', metadata: {server_name: 'giraffe-1'}.to_json)
61
+ ```
62
+
63
+ ## Bang Methods
64
+ Most methods that interact with the API have a `!` counterpart. It raises an error when
65
+ one is returned by the API.
66
+
67
+ ```ruby
68
+ require 'ngrokapi'
69
+ client = NgrokAPI::Client.new(api_key: '<API KEY>')
70
+
71
+ # no error raised, even though it's a bad identifier
72
+ # the error is simply returned
73
+ cred = client.credentials.get(id: 'invalid')
74
+
75
+ # this raises an NgrokAPI::Error
76
+ cred = client.credentials.get!(id: 'invalid')
77
+ ```
78
+
79
+ ## Error Handling
80
+
81
+ The ngrok API returns detailed information when an API call fails. Consult the
82
+ section on errors for additional details.
83
+
84
+ ```ruby
85
+ require 'ngrokapi'
86
+ client = NgrokAPI::Client.new(api_key: '<API KEY>')
87
+
88
+ begin
89
+ client.ip_policies.get!(id: 'invalid')
90
+ rescue NgrokAPI::Error => e
91
+ puts(e)
92
+ puts(e.response.to_s)
93
+ end
94
+ ```
data/docs/_index.html CHANGED
@@ -467,6 +467,13 @@
467
467
 
468
468
  </li>
469
469
 
470
+ <li>
471
+ <span class='object_link'><a href="NgrokAPI/Models/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">EventSourceList</a></span>
472
+
473
+ <small>(NgrokAPI::Models)</small>
474
+
475
+ </li>
476
+
470
477
  <li>
471
478
  <span class='object_link'><a href="NgrokAPI/Models/EventSourceReplace.html" title="NgrokAPI::Models::EventSourceReplace (class)">EventSourceReplace</a></span>
472
479
 
@@ -727,13 +734,6 @@
727
734
 
728
735
  </li>
729
736
 
730
- <li>
731
- <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertNSTarget.html" title="NgrokAPI::Models::ReservedDomainCertNSTarget (class)">ReservedDomainCertNSTarget</a></span>
732
-
733
- <small>(NgrokAPI::Models)</small>
734
-
735
- </li>
736
-
737
737
  <li>
738
738
  <span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertPolicy.html" title="NgrokAPI::Models::ReservedDomainCertPolicy (class)">ReservedDomainCertPolicy</a></span>
739
739
 
@@ -895,7 +895,7 @@
895
895
  </div>
896
896
 
897
897
  <div id="footer">
898
- Generated on Mon Oct 4 23:24:15 2021 by
898
+ Generated on Tue Oct 19 15:48:17 2021 by
899
899
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
900
900
  0.9.26 (ruby-3.0.1).
901
901
  </div>