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
@@ -143,7 +143,7 @@
143
143
 
144
144
 
145
145
  <span class="summary_desc"><div class='inline'>
146
- <p>Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok&#39;s terms of service.</p>
146
+ <p>Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok&#39;s terms of service.</p>
147
147
  </div></span>
148
148
 
149
149
  </li>
@@ -167,7 +167,7 @@
167
167
 
168
168
 
169
169
  <span class="summary_desc"><div class='inline'>
170
- <p>API Keys are used to authenticate to the (<a href="https://ngrok.com/docs/api#authentication)ngrok">ngrok.com/docs/api#authentication)ngrok</a> API.</p>
170
+ <p>API Keys are used to authenticate to the <a href="https://ngrok.com/docs/api#authentication">ngrok API</a>.</p>
171
171
  </div></span>
172
172
 
173
173
  </li>
@@ -191,7 +191,7 @@
191
191
 
192
192
 
193
193
  <span class="summary_desc"><div class='inline'>
194
- <p>Certificate Authorities are x509 certificates that are used to sign other x509 certificates.</p>
194
+ <p>Certificate Authorities are x509 certificates that are used to sign other x509 certificates.</p>
195
195
  </div></span>
196
196
 
197
197
  </li>
@@ -239,7 +239,7 @@
239
239
 
240
240
 
241
241
  <span class="summary_desc"><div class='inline'>
242
- <p>Endpoint Configurations are a reusable group of modules that encapsulate how traffic to a domain or address is handled.</p>
242
+ <p>Endpoint Configurations are a reusable group of modules that encapsulate how traffic to a domain or address is handled.</p>
243
243
  </div></span>
244
244
 
245
245
  </li>
@@ -377,7 +377,7 @@
377
377
 
378
378
 
379
379
  <span class="summary_desc"><div class='inline'>
380
- <p>IP Policies are reusable groups of CIDR ranges with an allow or deny action.</p>
380
+ <p>IP Policies are reusable groups of CIDR ranges with an <code>allow</code> or <code>deny</code> action.</p>
381
381
  </div></span>
382
382
 
383
383
  </li>
@@ -401,7 +401,7 @@
401
401
 
402
402
 
403
403
  <span class="summary_desc"><div class='inline'>
404
- <p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.</p>
404
+ <p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.</p>
405
405
  </div></span>
406
406
 
407
407
  </li>
@@ -425,7 +425,7 @@
425
425
 
426
426
 
427
427
  <span class="summary_desc"><div class='inline'>
428
- <p>An IP restriction is a restriction placed on the CIDRs that are allowed to initate traffic to a specific aspect of your ngrok account.</p>
428
+ <p>An IP restriction is a restriction placed on the CIDRs that are allowed to initate traffic to a specific aspect of your ngrok account.</p>
429
429
  </div></span>
430
430
 
431
431
  </li>
@@ -452,6 +452,28 @@
452
452
  <p>The IP Whitelist is deprecated and will be removed.</p>
453
453
  </div></span>
454
454
 
455
+ </li>
456
+
457
+
458
+ <li class="public ">
459
+ <span class="summary_signature">
460
+
461
+ <a href="#pointcfg_module-instance_method" title="#pointcfg_module (instance method)">#<strong>pointcfg_module</strong> &#x21d2; Object </a>
462
+
463
+
464
+
465
+ </span>
466
+
467
+
468
+
469
+
470
+
471
+
472
+
473
+
474
+
475
+ <span class="summary_desc"><div class='inline'></div></span>
476
+
455
477
  </li>
456
478
 
457
479
 
@@ -521,7 +543,7 @@
521
543
 
522
544
 
523
545
  <span class="summary_desc"><div class='inline'>
524
- <p>An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.</p>
546
+ <p>An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.</p>
525
547
  </div></span>
526
548
 
527
549
  </li>
@@ -545,7 +567,7 @@
545
567
 
546
568
 
547
569
  <span class="summary_desc"><div class='inline'>
548
- <p>SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.</p>
570
+ <p>SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.</p>
549
571
  </div></span>
550
572
 
551
573
  </li>
@@ -569,7 +591,7 @@
569
591
 
570
592
 
571
593
  <span class="summary_desc"><div class='inline'>
572
- <p>SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate.</p>
594
+ <p>SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate.</p>
573
595
  </div></span>
574
596
 
575
597
  </li>
@@ -593,7 +615,7 @@
593
615
 
594
616
 
595
617
  <span class="summary_desc"><div class='inline'>
596
- <p>SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection.</p>
618
+ <p>SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection.</p>
597
619
  </div></span>
598
620
 
599
621
  </li>
@@ -617,7 +639,7 @@
617
639
 
618
640
 
619
641
  <span class="summary_desc"><div class='inline'>
620
- <p>TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic.</p>
642
+ <p>TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic.</p>
621
643
  </div></span>
622
644
 
623
645
  </li>
@@ -641,7 +663,7 @@
641
663
 
642
664
 
643
665
  <span class="summary_desc"><div class='inline'>
644
- <p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service.</p>
666
+ <p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service.</p>
645
667
  </div></span>
646
668
 
647
669
  </li>
@@ -665,7 +687,7 @@
665
687
 
666
688
 
667
689
  <span class="summary_desc"><div class='inline'>
668
- <p>Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.</p>
690
+ <p>Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.</p>
669
691
  </div></span>
670
692
 
671
693
  </li>
@@ -703,15 +725,15 @@
703
725
  <pre class="lines">
704
726
 
705
727
 
706
- 8
707
- 9
708
728
  10
709
729
  11
710
730
  12
711
- 13</pre>
731
+ 13
732
+ 14
733
+ 15</pre>
712
734
  </td>
713
735
  <td>
714
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 8</span>
736
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 10</span>
715
737
 
716
738
  <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span>
717
739
  <span class='label'>api_key:</span><span class='comma'>,</span>
@@ -743,10 +765,7 @@
743
765
  </h3><div class="docstring">
744
766
  <div class="discussion">
745
767
 
746
- <p>Abuse Reports allow you to submit take-down requests for URLs hosted by</p>
747
-
748
- <pre class="code ruby"><code class="ruby">ngrok that violate ngrok&#39;s terms of service.
749
- </code></pre>
768
+ <p>Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok&#39;s terms of service.</p>
750
769
 
751
770
 
752
771
  </div>
@@ -773,12 +792,12 @@
773
792
  <pre class="lines">
774
793
 
775
794
 
776
- 20
777
- 21
778
- 22</pre>
795
+ 22
796
+ 23
797
+ 24</pre>
779
798
  </td>
780
799
  <td>
781
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 20</span>
800
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 22</span>
782
801
 
783
802
  <span class='kw'>def</span> <span class='id identifier rubyid_abuse_reports'>abuse_reports</span>
784
803
  <span class='ivar'>@_abuse_reports</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/AbuseReportsClient.html" title="NgrokAPI::Services::AbuseReportsClient (class)">AbuseReportsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/AbuseReportsClient.html#initialize-instance_method" title="NgrokAPI::Services::AbuseReportsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
@@ -800,13 +819,7 @@
800
819
  </h3><div class="docstring">
801
820
  <div class="discussion">
802
821
 
803
- <p>API Keys are used to authenticate to the (<a href="https://ngrok.com/docs/api#authentication)ngrok">ngrok.com/docs/api#authentication)ngrok</a></p>
804
-
805
- <pre class="code ruby"><code class="ruby">API. You may use the API itself
806
- to provision and manage API Keys but you&#39;ll need to provision your first API
807
- key from the (https://dashboard.ngrok.com/api/keys)API Keys page on your
808
- ngrok.com dashboard.
809
- </code></pre>
822
+ <p>API Keys are used to authenticate to the <a href="https://ngrok.com/docs/api#authentication">ngrok API</a>. You may use the API itself to provision and manage API Keys but you&#39;ll need to provision your first API key from the <a href="https://dashboard.ngrok.com/api/keys">API Keys page</a> on your ngrok.com dashboard.</p>
810
823
 
811
824
 
812
825
  </div>
@@ -833,12 +846,12 @@ ngrok.com dashboard.
833
846
  <pre class="lines">
834
847
 
835
848
 
836
- 33
837
849
  34
838
- 35</pre>
850
+ 35
851
+ 36</pre>
839
852
  </td>
840
853
  <td>
841
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 33</span>
854
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 34</span>
842
855
 
843
856
  <span class='kw'>def</span> <span class='id identifier rubyid_api_keys'>api_keys</span>
844
857
  <span class='ivar'>@_api_keys</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/APIKeysClient.html" title="NgrokAPI::Services::APIKeysClient (class)">APIKeysClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/APIKeysClient.html#initialize-instance_method" title="NgrokAPI::Services::APIKeysClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
@@ -860,13 +873,7 @@ ngrok.com dashboard.
860
873
  </h3><div class="docstring">
861
874
  <div class="discussion">
862
875
 
863
- <p>Certificate Authorities are x509 certificates that are used to sign other</p>
864
-
865
- <pre class="code ruby"><code class="ruby">x509 certificates. Attach a Certificate Authority to the Mutual TLS module
866
- to verify that the TLS certificate presented by a client has been signed by
867
- this CA. Certificate Authorities are used only for mTLS validation only and
868
- thus a private key is not included in the resource.
869
- </code></pre>
876
+ <p>Certificate Authorities are x509 certificates that are used to sign other x509 certificates. Attach a Certificate Authority to the Mutual TLS module to verify that the TLS certificate presented by a client has been signed by this CA. Certificate Authorities are used only for mTLS validation only and thus a private key is not included in the resource.</p>
870
877
 
871
878
 
872
879
  </div>
@@ -893,12 +900,12 @@ thus a private key is not included in the resource.
893
900
  <pre class="lines">
894
901
 
895
902
 
896
- 45
897
903
  46
898
- 47</pre>
904
+ 47
905
+ 48</pre>
899
906
  </td>
900
907
  <td>
901
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 45</span>
908
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 46</span>
902
909
 
903
910
  <span class='kw'>def</span> <span class='id identifier rubyid_certificate_authorities'>certificate_authorities</span>
904
911
  <span class='ivar'>@_certificate_authorities</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/CertificateAuthoritiesClient.html" title="NgrokAPI::Services::CertificateAuthoritiesClient (class)">CertificateAuthoritiesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/CertificateAuthoritiesClient.html#initialize-instance_method" title="NgrokAPI::Services::CertificateAuthoritiesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
@@ -920,12 +927,7 @@ thus a private key is not included in the resource.
920
927
  </h3><div class="docstring">
921
928
  <div class="discussion">
922
929
 
923
- <p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok</p>
924
-
925
- <pre class="code ruby"><code class="ruby">agent to connect the ngrok service as your account. They are installed with
926
- the ngrok authtoken command or by specifying it in the ngrok.yml
927
- configuration file with the authtoken property.
928
- </code></pre>
930
+ <p>Tunnel Credentials are ngrok agent authtokens. They authorize the ngrok agent to connect the ngrok service as your account. They are installed with the <code>ngrok authtoken</code> command or by specifying it in the <code>ngrok.yml</code> configuration file with the <code>authtoken</code> property.</p>
929
931
 
930
932
 
931
933
  </div>
@@ -952,12 +954,12 @@ configuration file with the authtoken property.
952
954
  <pre class="lines">
953
955
 
954
956
 
955
- 56
956
957
  57
957
- 58</pre>
958
+ 58
959
+ 59</pre>
958
960
  </td>
959
961
  <td>
960
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 56</span>
962
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 57</span>
961
963
 
962
964
  <span class='kw'>def</span> <span class='id identifier rubyid_credentials'>credentials</span>
963
965
  <span class='ivar'>@_credentials</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/CredentialsClient.html" title="NgrokAPI::Services::CredentialsClient (class)">CredentialsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/CredentialsClient.html#initialize-instance_method" title="NgrokAPI::Services::CredentialsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
@@ -979,11 +981,7 @@ configuration file with the authtoken property.
979
981
  </h3><div class="docstring">
980
982
  <div class="discussion">
981
983
 
982
- <p>Endpoint Configurations are a reusable group of modules that encapsulate how</p>
983
-
984
- <pre class="code ruby"><code class="ruby">traffic to a domain or address is handled. Endpoint configurations are only
985
- applied to Domains and TCP Addresses they have been attached to.
986
- </code></pre>
984
+ <p>Endpoint Configurations are a reusable group of modules that encapsulate how traffic to a domain or address is handled. Endpoint configurations are only applied to Domains and TCP Addresses they have been attached to.</p>
987
985
 
988
986
 
989
987
  </div>
@@ -1010,12 +1008,12 @@ applied to Domains and TCP Addresses they have been attached to.
1010
1008
  <pre class="lines">
1011
1009
 
1012
1010
 
1013
- 66
1014
1011
  67
1015
- 68</pre>
1012
+ 68
1013
+ 69</pre>
1016
1014
  </td>
1017
1015
  <td>
1018
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 66</span>
1016
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 67</span>
1019
1017
 
1020
1018
  <span class='kw'>def</span> <span class='id identifier rubyid_endpoint_configurations'>endpoint_configurations</span>
1021
1019
  <span class='ivar'>@_endpoint_configurations</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointConfigurationsClient.html" title="NgrokAPI::Services::EndpointConfigurationsClient (class)">EndpointConfigurationsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointConfigurationsClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointConfigurationsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
@@ -1040,12 +1038,12 @@ applied to Domains and TCP Addresses they have been attached to.
1040
1038
  <pre class="lines">
1041
1039
 
1042
1040
 
1043
- 74
1044
1041
  75
1045
- 76</pre>
1042
+ 76
1043
+ 77</pre>
1046
1044
  </td>
1047
1045
  <td>
1048
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 74</span>
1046
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 75</span>
1049
1047
 
1050
1048
  <span class='kw'>def</span> <span class='id identifier rubyid_event_destinations'>event_destinations</span>
1051
1049
  <span class='ivar'>@_event_destinations</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EventDestinationsClient.html" title="NgrokAPI::Services::EventDestinationsClient (class)">EventDestinationsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EventDestinationsClient.html#initialize-instance_method" title="NgrokAPI::Services::EventDestinationsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
@@ -1070,12 +1068,12 @@ applied to Domains and TCP Addresses they have been attached to.
1070
1068
  <pre class="lines">
1071
1069
 
1072
1070
 
1073
- 82
1074
1071
  83
1075
- 84</pre>
1072
+ 84
1073
+ 85</pre>
1076
1074
  </td>
1077
1075
  <td>
1078
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 82</span>
1076
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 83</span>
1079
1077
 
1080
1078
  <span class='kw'>def</span> <span class='id identifier rubyid_event_sources'>event_sources</span>
1081
1079
  <span class='ivar'>@_event_sources</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EventSourcesClient.html" title="NgrokAPI::Services::EventSourcesClient (class)">EventSourcesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EventSourcesClient.html#initialize-instance_method" title="NgrokAPI::Services::EventSourcesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
@@ -1100,12 +1098,12 @@ applied to Domains and TCP Addresses they have been attached to.
1100
1098
  <pre class="lines">
1101
1099
 
1102
1100
 
1103
- 70
1104
1101
  71
1105
- 72</pre>
1102
+ 72
1103
+ 73</pre>
1106
1104
  </td>
1107
1105
  <td>
1108
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 70</span>
1106
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 71</span>
1109
1107
 
1110
1108
  <span class='kw'>def</span> <span class='id identifier rubyid_event_streams'>event_streams</span>
1111
1109
  <span class='ivar'>@_event_streams</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EventStreamsClient.html" title="NgrokAPI::Services::EventStreamsClient (class)">EventStreamsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EventStreamsClient.html#initialize-instance_method" title="NgrokAPI::Services::EventStreamsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
@@ -1130,12 +1128,12 @@ applied to Domains and TCP Addresses they have been attached to.
1130
1128
  <pre class="lines">
1131
1129
 
1132
1130
 
1133
- 78
1134
1131
  79
1135
- 80</pre>
1132
+ 80
1133
+ 81</pre>
1136
1134
  </td>
1137
1135
  <td>
1138
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 78</span>
1136
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 79</span>
1139
1137
 
1140
1138
  <span class='kw'>def</span> <span class='id identifier rubyid_event_subscriptions'>event_subscriptions</span>
1141
1139
  <span class='ivar'>@_event_subscriptions</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EventSubscriptionsClient.html" title="NgrokAPI::Services::EventSubscriptionsClient (class)">EventSubscriptionsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EventSubscriptionsClient.html#initialize-instance_method" title="NgrokAPI::Services::EventSubscriptionsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
@@ -1157,12 +1155,7 @@ applied to Domains and TCP Addresses they have been attached to.
1157
1155
  </h3><div class="docstring">
1158
1156
  <div class="discussion">
1159
1157
 
1160
- <p>IP Policies are reusable groups of CIDR ranges with an allow or deny</p>
1161
-
1162
- <pre class="code ruby"><code class="ruby">action. They can be attached to endpoints via the Endpoint Configuration IP
1163
- Policy module. They can also be used with IP Restrictions to control source
1164
- IP ranges that can start tunnel sessions and connect to the API and dashboard.
1165
- </code></pre>
1158
+ <p>IP Policies are reusable groups of CIDR ranges with an <code>allow</code> or <code>deny</code> action. They can be attached to endpoints via the Endpoint Configuration IP Policy module. They can also be used with IP Restrictions to control source IP ranges that can start tunnel sessions and connect to the API and dashboard.</p>
1166
1159
 
1167
1160
 
1168
1161
  </div>
@@ -1189,12 +1182,12 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard.
1189
1182
  <pre class="lines">
1190
1183
 
1191
1184
 
1192
- 93
1193
1185
  94
1194
- 95</pre>
1186
+ 95
1187
+ 96</pre>
1195
1188
  </td>
1196
1189
  <td>
1197
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 93</span>
1190
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 94</span>
1198
1191
 
1199
1192
  <span class='kw'>def</span> <span class='id identifier rubyid_ip_policies'>ip_policies</span>
1200
1193
  <span class='ivar'>@_ip_policies</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/IPPoliciesClient.html" title="NgrokAPI::Services::IPPoliciesClient (class)">IPPoliciesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/IPPoliciesClient.html#initialize-instance_method" title="NgrokAPI::Services::IPPoliciesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
@@ -1216,10 +1209,7 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard.
1216
1209
  </h3><div class="docstring">
1217
1210
  <div class="discussion">
1218
1211
 
1219
- <p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that</p>
1220
-
1221
- <pre class="code ruby"><code class="ruby">make up an IP Policy.
1222
- </code></pre>
1212
+ <p>IP Policy Rules are the IPv4 or IPv6 CIDRs entries that make up an IP Policy.</p>
1223
1213
 
1224
1214
 
1225
1215
  </div>
@@ -1246,12 +1236,12 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard.
1246
1236
  <pre class="lines">
1247
1237
 
1248
1238
 
1249
- 102
1250
1239
  103
1251
- 104</pre>
1240
+ 104
1241
+ 105</pre>
1252
1242
  </td>
1253
1243
  <td>
1254
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 102</span>
1244
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 103</span>
1255
1245
 
1256
1246
  <span class='kw'>def</span> <span class='id identifier rubyid_ip_policy_rules'>ip_policy_rules</span>
1257
1247
  <span class='ivar'>@_ip_policy_rules</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/IPPolicyRulesClient.html" title="NgrokAPI::Services::IPPolicyRulesClient (class)">IPPolicyRulesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/IPPolicyRulesClient.html#initialize-instance_method" title="NgrokAPI::Services::IPPolicyRulesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
@@ -1273,14 +1263,7 @@ IP ranges that can start tunnel sessions and connect to the API and dashboard.
1273
1263
  </h3><div class="docstring">
1274
1264
  <div class="discussion">
1275
1265
 
1276
- <p>An IP restriction is a restriction placed on the CIDRs that are allowed to</p>
1277
-
1278
- <pre class="code ruby"><code class="ruby">initate traffic to a specific aspect of your ngrok account. An IP
1279
- restriction has a type which defines the ingress it applies to. IP
1280
- restrictions can be used to enforce the source IPs that can make API
1281
- requests, log in to the dashboard, start ngrok agents, and connect to your
1282
- public-facing endpoints.
1283
- </code></pre>
1266
+ <p>An IP restriction is a restriction placed on the CIDRs that are allowed to initate traffic to a specific aspect of your ngrok account. An IP restriction has a type which defines the ingress it applies to. IP restrictions can be used to enforce the source IPs that can make API requests, log in to the dashboard, start ngrok agents, and connect to your public-facing endpoints.</p>
1284
1267
 
1285
1268
 
1286
1269
  </div>
@@ -1307,12 +1290,12 @@ public-facing endpoints.
1307
1290
  <pre class="lines">
1308
1291
 
1309
1292
 
1310
- 115
1311
1293
  116
1312
- 117</pre>
1294
+ 117
1295
+ 118</pre>
1313
1296
  </td>
1314
1297
  <td>
1315
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 115</span>
1298
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 116</span>
1316
1299
 
1317
1300
  <span class='kw'>def</span> <span class='id identifier rubyid_ip_restrictions'>ip_restrictions</span>
1318
1301
  <span class='ivar'>@_ip_restrictions</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/IPRestrictionsClient.html" title="NgrokAPI::Services::IPRestrictionsClient (class)">IPRestrictionsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/IPRestrictionsClient.html#initialize-instance_method" title="NgrokAPI::Services::IPRestrictionsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
@@ -1334,10 +1317,7 @@ public-facing endpoints.
1334
1317
  </h3><div class="docstring">
1335
1318
  <div class="discussion">
1336
1319
 
1337
- <p>The IP Whitelist is deprecated and will be removed. Use an IP Restriction</p>
1338
-
1339
- <pre class="code ruby"><code class="ruby">with an endpoints type instead.
1340
- </code></pre>
1320
+ <p>The IP Whitelist is deprecated and will be removed. Use an IP Restriction with an <code>endpoints</code> type instead.</p>
1341
1321
 
1342
1322
 
1343
1323
  </div>
@@ -1364,12 +1344,12 @@ public-facing endpoints.
1364
1344
  <pre class="lines">
1365
1345
 
1366
1346
 
1367
- 124
1368
1347
  125
1369
- 126</pre>
1348
+ 126
1349
+ 127</pre>
1370
1350
  </td>
1371
1351
  <td>
1372
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 124</span>
1352
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 125</span>
1373
1353
 
1374
1354
  <span class='kw'>def</span> <span class='id identifier rubyid_ip_whitelist'>ip_whitelist</span>
1375
1355
  <span class='ivar'>@_ip_whitelist</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/IPWhitelistClient.html" title="NgrokAPI::Services::IPWhitelistClient (class)">IPWhitelistClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/IPWhitelistClient.html#initialize-instance_method" title="NgrokAPI::Services::IPWhitelistClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
@@ -1377,6 +1357,64 @@ public-facing endpoints.
1377
1357
  </td>
1378
1358
  </tr>
1379
1359
  </table>
1360
+ </div>
1361
+
1362
+ <div class="method_details ">
1363
+ <h3 class="signature " id="pointcfg_module-instance_method">
1364
+
1365
+ #<strong>pointcfg_module</strong> &#x21d2; <tt>Object</tt>
1366
+
1367
+
1368
+
1369
+
1370
+
1371
+ </h3><table class="source_code">
1372
+ <tr>
1373
+ <td>
1374
+ <pre class="lines">
1375
+
1376
+
1377
+ 219
1378
+ 220
1379
+ 221
1380
+ 222
1381
+ 223
1382
+ 224
1383
+ 225
1384
+ 226
1385
+ 227
1386
+ 228
1387
+ 229
1388
+ 230
1389
+ 231
1390
+ 232
1391
+ 233
1392
+ 234
1393
+ 235</pre>
1394
+ </td>
1395
+ <td>
1396
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 219</span>
1397
+
1398
+ <span class='kw'>def</span> <span class='id identifier rubyid_pointcfg_module'>pointcfg_module</span>
1399
+ <span class='id identifier rubyid_ns'>ns</span> <span class='op'>=</span> <span class='const'>OpenStruct</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span>
1400
+ <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_logging'>logging</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointLoggingModuleClient.html" title="NgrokAPI::Services::EndpointLoggingModuleClient (class)">EndpointLoggingModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointLoggingModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointLoggingModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
1401
+ <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_circuit_breaker'>circuit_breaker</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointCircuitBreakerModuleClient.html" title="NgrokAPI::Services::EndpointCircuitBreakerModuleClient (class)">EndpointCircuitBreakerModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointCircuitBreakerModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointCircuitBreakerModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
1402
+ <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_compression'>compression</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointCompressionModuleClient.html" title="NgrokAPI::Services::EndpointCompressionModuleClient (class)">EndpointCompressionModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointCompressionModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointCompressionModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
1403
+ <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_tls_termination'>tls_termination</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointTLSTerminationModuleClient.html" title="NgrokAPI::Services::EndpointTLSTerminationModuleClient (class)">EndpointTLSTerminationModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointTLSTerminationModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointTLSTerminationModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
1404
+ <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_ip_policy'>ip_policy</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointIPPolicyModuleClient.html" title="NgrokAPI::Services::EndpointIPPolicyModuleClient (class)">EndpointIPPolicyModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointIPPolicyModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointIPPolicyModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
1405
+ <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_mutual_tls'>mutual_tls</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointMutualTLSModuleClient.html" title="NgrokAPI::Services::EndpointMutualTLSModuleClient (class)">EndpointMutualTLSModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointMutualTLSModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointMutualTLSModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
1406
+ <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_request_headers'>request_headers</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointRequestHeadersModuleClient.html" title="NgrokAPI::Services::EndpointRequestHeadersModuleClient (class)">EndpointRequestHeadersModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointRequestHeadersModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointRequestHeadersModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
1407
+ <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_response_headers'>response_headers</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointResponseHeadersModuleClient.html" title="NgrokAPI::Services::EndpointResponseHeadersModuleClient (class)">EndpointResponseHeadersModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointResponseHeadersModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointResponseHeadersModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
1408
+ <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_oauth'>oauth</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointOAuthModuleClient.html" title="NgrokAPI::Services::EndpointOAuthModuleClient (class)">EndpointOAuthModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointOAuthModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointOAuthModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
1409
+ <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_webhook_validation'>webhook_validation</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointWebhookValidationModuleClient.html" title="NgrokAPI::Services::EndpointWebhookValidationModuleClient (class)">EndpointWebhookValidationModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointWebhookValidationModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointWebhookValidationModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
1410
+ <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_saml'>saml</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointSAMLModuleClient.html" title="NgrokAPI::Services::EndpointSAMLModuleClient (class)">EndpointSAMLModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointSAMLModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointSAMLModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
1411
+ <span class='id identifier rubyid_ns'>ns</span><span class='period'>.</span><span class='id identifier rubyid_oidc'>oidc</span> <span class='op'>=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/EndpointOIDCModuleClient.html" title="NgrokAPI::Services::EndpointOIDCModuleClient (class)">EndpointOIDCModuleClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/EndpointOIDCModuleClient.html#initialize-instance_method" title="NgrokAPI::Services::EndpointOIDCModuleClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
1412
+
1413
+ <span class='id identifier rubyid_ns'>ns</span>
1414
+ <span class='kw'>end</span></pre>
1415
+ </td>
1416
+ </tr>
1417
+ </table>
1380
1418
  </div>
1381
1419
 
1382
1420
  <div class="method_details ">
@@ -1391,11 +1429,7 @@ public-facing endpoints.
1391
1429
  </h3><div class="docstring">
1392
1430
  <div class="discussion">
1393
1431
 
1394
- <p>Reserved Addresses are TCP addresses that can be used to listen for traffic.</p>
1395
-
1396
- <pre class="code ruby"><code class="ruby">TCP address hostnames and ports are assigned by ngrok, they cannot be
1397
- chosen.
1398
- </code></pre>
1432
+ <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>
1399
1433
 
1400
1434
 
1401
1435
  </div>
@@ -1422,12 +1456,12 @@ chosen.
1422
1456
  <pre class="lines">
1423
1457
 
1424
1458
 
1425
- 134
1426
1459
  135
1427
- 136</pre>
1460
+ 136
1461
+ 137</pre>
1428
1462
  </td>
1429
1463
  <td>
1430
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 134</span>
1464
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 135</span>
1431
1465
 
1432
1466
  <span class='kw'>def</span> <span class='id identifier rubyid_reserved_addrs'>reserved_addrs</span>
1433
1467
  <span class='ivar'>@_reserved_addrs</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/ReservedAddrsClient.html" title="NgrokAPI::Services::ReservedAddrsClient (class)">ReservedAddrsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/ReservedAddrsClient.html#initialize-instance_method" title="NgrokAPI::Services::ReservedAddrsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
@@ -1449,12 +1483,7 @@ chosen.
1449
1483
  </h3><div class="docstring">
1450
1484
  <div class="discussion">
1451
1485
 
1452
- <p>Reserved Domains are hostnames that you can listen for traffic on. Domains</p>
1453
-
1454
- <pre class="code ruby"><code class="ruby">can be used to listen for http, https or tls traffic. You may use a domain
1455
- that you own by creating a CNAME record specified in the returned resource.
1456
- This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
1457
- </code></pre>
1486
+ <p>Reserved Domains are hostnames that you can listen for traffic on. Domains can be used to listen for http, https or tls traffic. You may use a domain that you own by creating a CNAME record specified in the returned resource. This CNAME record points traffic for that domain to ngrok&#39;s edge servers.</p>
1458
1487
 
1459
1488
 
1460
1489
  </div>
@@ -1481,12 +1510,12 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
1481
1510
  <pre class="lines">
1482
1511
 
1483
1512
 
1484
- 145
1485
1513
  146
1486
- 147</pre>
1514
+ 147
1515
+ 148</pre>
1487
1516
  </td>
1488
1517
  <td>
1489
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 145</span>
1518
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 146</span>
1490
1519
 
1491
1520
  <span class='kw'>def</span> <span class='id identifier rubyid_reserved_domains'>reserved_domains</span>
1492
1521
  <span class='ivar'>@_reserved_domains</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">ReservedDomainsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/ReservedDomainsClient.html#initialize-instance_method" title="NgrokAPI::Services::ReservedDomainsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
@@ -1508,10 +1537,7 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
1508
1537
  </h3><div class="docstring">
1509
1538
  <div class="discussion">
1510
1539
 
1511
- <p>An SSH Certificate Authority is a pair of an SSH Certificate and its private</p>
1512
-
1513
- <pre class="code ruby"><code class="ruby">key that can be used to sign other SSH host and user certificates.
1514
- </code></pre>
1540
+ <p>An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.</p>
1515
1541
 
1516
1542
 
1517
1543
  </div>
@@ -1538,12 +1564,12 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
1538
1564
  <pre class="lines">
1539
1565
 
1540
1566
 
1541
- 154
1542
1567
  155
1543
- 156</pre>
1568
+ 156
1569
+ 157</pre>
1544
1570
  </td>
1545
1571
  <td>
1546
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 154</span>
1572
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 155</span>
1547
1573
 
1548
1574
  <span class='kw'>def</span> <span class='id identifier rubyid_ssh_certificate_authorities'>ssh_certificate_authorities</span>
1549
1575
  <span class='ivar'>@_ssh_certificate_authorities</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/SSHCertificateAuthoritiesClient.html" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient (class)">SSHCertificateAuthoritiesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/SSHCertificateAuthoritiesClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
@@ -1565,10 +1591,7 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
1565
1591
  </h3><div class="docstring">
1566
1592
  <div class="discussion">
1567
1593
 
1568
- <p>SSH Credentials are SSH public keys that can be used to start SSH tunnels</p>
1569
-
1570
- <pre class="code ruby"><code class="ruby">via the ngrok SSH tunnel gateway.
1571
- </code></pre>
1594
+ <p>SSH Credentials are SSH public keys that can be used to start SSH tunnels via the ngrok SSH tunnel gateway.</p>
1572
1595
 
1573
1596
 
1574
1597
  </div>
@@ -1595,12 +1618,12 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
1595
1618
  <pre class="lines">
1596
1619
 
1597
1620
 
1598
- 163
1599
1621
  164
1600
- 165</pre>
1622
+ 165
1623
+ 166</pre>
1601
1624
  </td>
1602
1625
  <td>
1603
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 163</span>
1626
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 164</span>
1604
1627
 
1605
1628
  <span class='kw'>def</span> <span class='id identifier rubyid_ssh_credentials'>ssh_credentials</span>
1606
1629
  <span class='ivar'>@_ssh_credentials</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/SSHCredentialsClient.html" title="NgrokAPI::Services::SSHCredentialsClient (class)">SSHCredentialsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/SSHCredentialsClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHCredentialsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
@@ -1622,11 +1645,7 @@ This CNAME record points traffic for that domain to ngrok&#39;s edge servers.
1622
1645
  </h3><div class="docstring">
1623
1646
  <div class="discussion">
1624
1647
 
1625
- <p>SSH Host Certificates along with the corresponding private key allows an SSH</p>
1626
-
1627
- <pre class="code ruby"><code class="ruby">server to assert its authenticity to connecting SSH clients who trust the
1628
- SSH Certificate Authority that was used to sign the certificate.
1629
- </code></pre>
1648
+ <p>SSH Host Certificates along with the corresponding private key allows an SSH server to assert its authenticity to connecting SSH clients who trust the SSH Certificate Authority that was used to sign the certificate.</p>
1630
1649
 
1631
1650
 
1632
1651
  </div>
@@ -1653,12 +1672,12 @@ SSH Certificate Authority that was used to sign the certificate.
1653
1672
  <pre class="lines">
1654
1673
 
1655
1674
 
1656
- 173
1657
1675
  174
1658
- 175</pre>
1676
+ 175
1677
+ 176</pre>
1659
1678
  </td>
1660
1679
  <td>
1661
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 173</span>
1680
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 174</span>
1662
1681
 
1663
1682
  <span class='kw'>def</span> <span class='id identifier rubyid_ssh_host_certificates'>ssh_host_certificates</span>
1664
1683
  <span class='ivar'>@_ssh_host_certificates</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/SSHHostCertificatesClient.html" title="NgrokAPI::Services::SSHHostCertificatesClient (class)">SSHHostCertificatesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/SSHHostCertificatesClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHHostCertificatesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
@@ -1680,11 +1699,7 @@ SSH Certificate Authority that was used to sign the certificate.
1680
1699
  </h3><div class="docstring">
1681
1700
  <div class="discussion">
1682
1701
 
1683
- <p>SSH User Certificates are presented by SSH clients when connecting to an SSH</p>
1684
-
1685
- <pre class="code ruby"><code class="ruby">server to authenticate their connection. The SSH server must trust the SSH
1686
- Certificate Authority used to sign the certificate.
1687
- </code></pre>
1702
+ <p>SSH User Certificates are presented by SSH clients when connecting to an SSH server to authenticate their connection. The SSH server must trust the SSH Certificate Authority used to sign the certificate.</p>
1688
1703
 
1689
1704
 
1690
1705
  </div>
@@ -1711,12 +1726,12 @@ Certificate Authority used to sign the certificate.
1711
1726
  <pre class="lines">
1712
1727
 
1713
1728
 
1714
- 183
1715
1729
  184
1716
- 185</pre>
1730
+ 185
1731
+ 186</pre>
1717
1732
  </td>
1718
1733
  <td>
1719
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 183</span>
1734
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 184</span>
1720
1735
 
1721
1736
  <span class='kw'>def</span> <span class='id identifier rubyid_ssh_user_certificates'>ssh_user_certificates</span>
1722
1737
  <span class='ivar'>@_ssh_user_certificates</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/SSHUserCertificatesClient.html" title="NgrokAPI::Services::SSHUserCertificatesClient (class)">SSHUserCertificatesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/SSHUserCertificatesClient.html#initialize-instance_method" title="NgrokAPI::Services::SSHUserCertificatesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
@@ -1738,13 +1753,7 @@ Certificate Authority used to sign the certificate.
1738
1753
  </h3><div class="docstring">
1739
1754
  <div class="discussion">
1740
1755
 
1741
- <p>TLS Certificates are pairs of x509 certificates and their matching private</p>
1742
-
1743
- <pre class="code ruby"><code class="ruby">key that can be used to terminate TLS traffic. TLS certificates are unused
1744
- until they are attached to a Domain. TLS Certificates may also be
1745
- provisioned by ngrok automatically for domains on which you have enabled
1746
- automated certificate provisioning.
1747
- </code></pre>
1756
+ <p>TLS Certificates are pairs of x509 certificates and their matching private key that can be used to terminate TLS traffic. TLS certificates are unused until they are attached to a Domain. TLS Certificates may also be provisioned by ngrok automatically for domains on which you have enabled automated certificate provisioning.</p>
1748
1757
 
1749
1758
 
1750
1759
  </div>
@@ -1771,12 +1780,12 @@ automated certificate provisioning.
1771
1780
  <pre class="lines">
1772
1781
 
1773
1782
 
1774
- 195
1775
1783
  196
1776
- 197</pre>
1784
+ 197
1785
+ 198</pre>
1777
1786
  </td>
1778
1787
  <td>
1779
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 195</span>
1788
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 196</span>
1780
1789
 
1781
1790
  <span class='kw'>def</span> <span class='id identifier rubyid_tls_certificates'>tls_certificates</span>
1782
1791
  <span class='ivar'>@_tls_certificates</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TLSCertificatesClient.html" title="NgrokAPI::Services::TLSCertificatesClient (class)">TLSCertificatesClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TLSCertificatesClient.html#initialize-instance_method" title="NgrokAPI::Services::TLSCertificatesClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
@@ -1798,11 +1807,7 @@ automated certificate provisioning.
1798
1807
  </h3><div class="docstring">
1799
1808
  <div class="discussion">
1800
1809
 
1801
- <p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel</p>
1802
-
1803
- <pre class="code ruby"><code class="ruby">sessions that are running and connected to the ngrok service. Each tunnel
1804
- session can include one or more Tunnels.
1805
- </code></pre>
1810
+ <p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service. Each tunnel session can include one or more Tunnels.</p>
1806
1811
 
1807
1812
 
1808
1813
  </div>
@@ -1829,12 +1834,12 @@ session can include one or more Tunnels.
1829
1834
  <pre class="lines">
1830
1835
 
1831
1836
 
1832
- 205
1833
1837
  206
1834
- 207</pre>
1838
+ 207
1839
+ 208</pre>
1835
1840
  </td>
1836
1841
  <td>
1837
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 205</span>
1842
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 206</span>
1838
1843
 
1839
1844
  <span class='kw'>def</span> <span class='id identifier rubyid_tunnel_sessions'>tunnel_sessions</span>
1840
1845
  <span class='ivar'>@_tunnel_sessions</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TunnelSessionsClient.html" title="NgrokAPI::Services::TunnelSessionsClient (class)">TunnelSessionsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TunnelSessionsClient.html#initialize-instance_method" title="NgrokAPI::Services::TunnelSessionsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
@@ -1856,10 +1861,7 @@ session can include one or more Tunnels.
1856
1861
  </h3><div class="docstring">
1857
1862
  <div class="discussion">
1858
1863
 
1859
- <p>Tunnels provide endpoints to access services exposed by a running ngrok</p>
1860
-
1861
- <pre class="code ruby"><code class="ruby">agent tunnel session or an SSH reverse tunnel session.
1862
- </code></pre>
1864
+ <p>Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.</p>
1863
1865
 
1864
1866
 
1865
1867
  </div>
@@ -1886,12 +1888,12 @@ session can include one or more Tunnels.
1886
1888
  <pre class="lines">
1887
1889
 
1888
1890
 
1889
- 214
1890
1891
  215
1891
- 216</pre>
1892
+ 216
1893
+ 217</pre>
1892
1894
  </td>
1893
1895
  <td>
1894
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 214</span>
1896
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/client.rb', line 215</span>
1895
1897
 
1896
1898
  <span class='kw'>def</span> <span class='id identifier rubyid_tunnels'>tunnels</span>
1897
1899
  <span class='ivar'>@_tunnels</span> <span class='op'>||=</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="Services.html" title="NgrokAPI::Services (module)">Services</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="Services/TunnelsClient.html" title="NgrokAPI::Services::TunnelsClient (class)">TunnelsClient</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="Services/TunnelsClient.html#initialize-instance_method" title="NgrokAPI::Services::TunnelsClient#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='ivar'>@client</span><span class='rparen'>)</span>
@@ -1906,7 +1908,7 @@ session can include one or more Tunnels.
1906
1908
  </div>
1907
1909
 
1908
1910
  <div id="footer">
1909
- Generated on Mon Oct 4 23:24:15 2021 by
1911
+ Generated on Tue Oct 19 15:48:18 2021 by
1910
1912
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1911
1913
  0.9.26 (ruby-3.0.1).
1912
1914
  </div>