ngrok-api 0.12.0 → 0.14.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 (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
data/doc/NgrokAPI/Services/ReservedAddrsClient.html CHANGED
@@ -102,11 +102,7 @@
102
102
  <h2>Overview</h2><div class="docstring">
103
103
  <div class="discussion">
104
104
 
105
- <p>Reserved Addresses are TCP addresses that can be used to listen for traffic.</p>
106
-
107
- <pre class="code ruby"><code class="ruby">TCP address hostnames and ports are assigned by ngrok, they cannot be
108
- chosen.
109
- </code></pre>
105
+ <p>Reserved Addresses are TCP addresses that can be used to listen for traffic. TCP address hostnames and ports are assigned by ngrok, they cannot be chosen.</p>
110
106
 
111
107
  <p><a href="https://ngrok.com/docs/api#api-reserved-addrs">ngrok.com/docs/api#api-reserved-addrs</a></p>
112
108
 
@@ -419,6 +415,30 @@ chosen.
419
415
 
420
416
 
421
417
 
418
+ <span class="summary_desc"><div class='inline'>
419
+ <p>List all reserved addresses on this account.</p>
420
+ </div></span>
421
+
422
+ </li>
423
+
424
+
425
+ <li class="public ">
426
+ <span class="summary_signature">
427
+
428
+ <a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) &#x21d2; NgrokAPI::Models::Listable </a>
429
+
430
+
431
+
432
+ </span>
433
+
434
+
435
+
436
+
437
+
438
+
439
+
440
+
441
+
422
442
  <span class="summary_desc"><div class='inline'>
423
443
  <p>List all reserved addresses on this account.</p>
424
444
  </div></span>
@@ -999,18 +1019,18 @@ chosen.
999
1019
  <pre class="lines">
1000
1020
 
1001
1021
 
1002
- 217
1003
- 218
1004
- 219
1005
- 220
1006
- 221
1007
- 222
1008
- 223
1009
- 224
1010
- 225</pre>
1022
+ 250
1023
+ 251
1024
+ 252
1025
+ 253
1026
+ 254
1027
+ 255
1028
+ 256
1029
+ 257
1030
+ 258</pre>
1011
1031
  </td>
1012
1032
  <td>
1013
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 217</span>
1033
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 250</span>
1014
1034
 
1015
1035
  <span class='kw'>def</span> <span class='id identifier rubyid_delete_endpoint_config'>delete_endpoint_config</span><span class='lparen'>(</span>
1016
1036
  <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span>
@@ -1094,18 +1114,18 @@ chosen.
1094
1114
  <pre class="lines">
1095
1115
 
1096
1116
 
1097
- 235
1098
- 236
1099
- 237
1100
- 238
1101
- 239
1102
- 240
1103
- 241
1104
- 242
1105
- 243</pre>
1117
+ 268
1118
+ 269
1119
+ 270
1120
+ 271
1121
+ 272
1122
+ 273
1123
+ 274
1124
+ 275
1125
+ 276</pre>
1106
1126
  </td>
1107
1127
  <td>
1108
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 235</span>
1128
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 268</span>
1109
1129
 
1110
1130
  <span class='kw'>def</span> <span class='id identifier rubyid_delete_endpoint_config!'>delete_endpoint_config!</span><span class='lparen'>(</span>
1111
1131
  <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span>
@@ -1430,7 +1450,8 @@ chosen.
1430
1450
  148
1431
1451
  149
1432
1452
  150
1433
- 151</pre>
1453
+ 151
1454
+ 152</pre>
1434
1455
  </td>
1435
1456
  <td>
1436
1457
  <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 134</span>
@@ -1446,6 +1467,7 @@ chosen.
1446
1467
  <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
1447
1468
  <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedAddrsClient::PATH (constant)">PATH</a></span></span>
1448
1469
  <span class='rparen'>)</span>
1470
+
1449
1471
  <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>
1450
1472
  <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
1451
1473
  <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
@@ -1456,6 +1478,151 @@ chosen.
1456
1478
  </td>
1457
1479
  </tr>
1458
1480
  </table>
1481
+ </div>
1482
+
1483
+ <div class="method_details ">
1484
+ <h3 class="signature " id="list!-instance_method">
1485
+
1486
+ #<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>
1487
+
1488
+
1489
+
1490
+
1491
+
1492
+ </h3><div class="docstring">
1493
+ <div class="discussion">
1494
+
1495
+ <p>List all reserved addresses on this account. Throws an exception if API error.</p>
1496
+
1497
+ <p><a href="https://ngrok.com/docs/api#api-reserved-addrs-list">ngrok.com/docs/api#api-reserved-addrs-list</a></p>
1498
+
1499
+
1500
+ </div>
1501
+ </div>
1502
+ <div class="tags">
1503
+ <p class="tag_title">Parameters:</p>
1504
+ <ul class="param">
1505
+
1506
+ <li>
1507
+
1508
+ <span class='name'>before_id</span>
1509
+
1510
+
1511
+ <span class='type'>(<tt>string</tt>)</span>
1512
+
1513
+
1514
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1515
+
1516
+
1517
+ </li>
1518
+
1519
+ <li>
1520
+
1521
+ <span class='name'>limit</span>
1522
+
1523
+
1524
+ <span class='type'>(<tt>string</tt>)</span>
1525
+
1526
+
1527
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1528
+
1529
+
1530
+ </li>
1531
+
1532
+ <li>
1533
+
1534
+ <span class='name'>url</span>
1535
+
1536
+
1537
+ <span class='type'>(<tt>string</tt>)</span>
1538
+
1539
+
1540
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1541
+
1542
+
1543
+ &mdash;
1544
+ <div class='inline'>
1545
+ <p>optional and mutually exclusive from before_id and limit</p>
1546
+ </div>
1547
+
1548
+ </li>
1549
+
1550
+ </ul>
1551
+
1552
+ <p class="tag_title">Returns:</p>
1553
+ <ul class="return">
1554
+
1555
+ <li>
1556
+
1557
+
1558
+ <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>
1559
+
1560
+
1561
+
1562
+ &mdash;
1563
+ <div class='inline'>
1564
+ <p>result from the API request</p>
1565
+ </div>
1566
+
1567
+ </li>
1568
+
1569
+ </ul>
1570
+
1571
+ </div><table class="source_code">
1572
+ <tr>
1573
+ <td>
1574
+ <pre class="lines">
1575
+
1576
+
1577
+ 164
1578
+ 165
1579
+ 166
1580
+ 167
1581
+ 168
1582
+ 169
1583
+ 170
1584
+ 171
1585
+ 172
1586
+ 173
1587
+ 174
1588
+ 175
1589
+ 176
1590
+ 177
1591
+ 178
1592
+ 179
1593
+ 180
1594
+ 181
1595
+ 182
1596
+ 183
1597
+ 184</pre>
1598
+ </td>
1599
+ <td>
1600
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 164</span>
1601
+
1602
+ <span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span>
1603
+ <span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1604
+ <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1605
+ <span class='label'>url:</span> <span class='kw'>nil</span>
1606
+ <span class='rparen'>)</span>
1607
+ <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>
1608
+ <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
1609
+ <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
1610
+ <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
1611
+ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
1612
+ <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedAddrsClient::PATH (constant)">PATH</a></span></span>
1613
+ <span class='rparen'>)</span>
1614
+
1615
+ <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>
1616
+ <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
1617
+ <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1618
+ <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::ReservedAddrsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1619
+ <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/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">ReservedAddr</a></span></span><span class='comma'>,</span>
1620
+ <span class='label'>danger:</span> <span class='kw'>true</span>
1621
+ <span class='rparen'>)</span>
1622
+ <span class='kw'>end</span></pre>
1623
+ </td>
1624
+ </tr>
1625
+ </table>
1459
1626
  </div>
1460
1627
 
1461
1628
  <div class="method_details ">
@@ -1575,26 +1742,26 @@ chosen.
1575
1742
  <pre class="lines">
1576
1743
 
1577
1744
 
1578
- 163
1579
- 164
1580
- 165
1581
- 166
1582
- 167
1583
- 168
1584
- 169
1585
- 170
1586
- 171
1587
- 172
1588
- 173
1589
- 174
1590
- 175
1591
- 176
1592
- 177
1593
- 178
1594
- 179</pre>
1745
+ 196
1746
+ 197
1747
+ 198
1748
+ 199
1749
+ 200
1750
+ 201
1751
+ 202
1752
+ 203
1753
+ 204
1754
+ 205
1755
+ 206
1756
+ 207
1757
+ 208
1758
+ 209
1759
+ 210
1760
+ 211
1761
+ 212</pre>
1595
1762
  </td>
1596
1763
  <td>
1597
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 163</span>
1764
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 196</span>
1598
1765
 
1599
1766
  <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
1600
1767
  <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>
@@ -1735,26 +1902,26 @@ chosen.
1735
1902
  <pre class="lines">
1736
1903
 
1737
1904
 
1738
- 192
1739
- 193
1740
- 194
1741
- 195
1742
- 196
1743
- 197
1744
- 198
1745
- 199
1746
- 200
1747
- 201
1748
- 202
1749
- 203
1750
- 204
1751
- 205
1752
- 206
1753
- 207
1754
- 208</pre>
1905
+ 225
1906
+ 226
1907
+ 227
1908
+ 228
1909
+ 229
1910
+ 230
1911
+ 231
1912
+ 232
1913
+ 233
1914
+ 234
1915
+ 235
1916
+ 236
1917
+ 237
1918
+ 238
1919
+ 239
1920
+ 240
1921
+ 241</pre>
1755
1922
  </td>
1756
1923
  <td>
1757
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 192</span>
1924
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 225</span>
1758
1925
 
1759
1926
  <span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
1760
1927
  <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>
@@ -1783,7 +1950,7 @@ chosen.
1783
1950
  </div>
1784
1951
 
1785
1952
  <div id="footer">
1786
- Generated on Mon Oct 4 23:24:17 2021 by
1953
+ Generated on Tue Oct 19 15:48:22 2021 by
1787
1954
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1788
1955
  0.9.26 (ruby-3.0.1).
1789
1956
  </div>