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/class_list.html CHANGED
@@ -43,7 +43,7 @@
43
43
 
44
44
  <ul id="full_list" class="class">
45
45
  <li id="object_" class="odd"><div class="item" style="padding-left:30px"><span class='object_link'><a href="top-level-namespace.html" title="Top Level Namespace (root)">Top Level Namespace</a></span></div></li>
46
- <li id='object_NgrokAPI' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_NgrokAPI::Client' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span> &lt; Object<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Error' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/Error.html" title="NgrokAPI::Error (class)">Error</a></span> &lt; StandardError<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Errors' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI/Errors.html" title="NgrokAPI::Errors (module)">Errors</a></span><small class='search_info'>NgrokAPI</small></div><ul><li id='object_NgrokAPI::Errors::NotFoundError' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Errors/NotFoundError.html" title="NgrokAPI::Errors::NotFoundError (class)">NotFoundError</a></span> &lt; Error<small class='search_info'>NgrokAPI::Errors</small></div></li></ul></li><li id='object_NgrokAPI::HttpClient' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/HttpClient.html" title="NgrokAPI::HttpClient (class)">HttpClient</a></span> &lt; Object<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Models' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span><small class='search_info'>NgrokAPI</small></div><ul><li id='object_NgrokAPI::Models::APIKey' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AWSAuth' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AWSAuth.html" title="NgrokAPI::Models::AWSAuth (class)">AWSAuth</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AWSCredentials' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AWSCredentials.html" title="NgrokAPI::Models::AWSCredentials (class)">AWSCredentials</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AWSRole' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AWSRole.html" title="NgrokAPI::Models::AWSRole (class)">AWSRole</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AbuseReport' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AbuseReport.html" title="NgrokAPI::Models::AbuseReport (class)">AbuseReport</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AbuseReportHostname' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AbuseReportHostname.html" title="NgrokAPI::Models::AbuseReportHostname (class)">AbuseReportHostname</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::CertificateAuthority' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">CertificateAuthority</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Credential' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointCircuitBreaker' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointCircuitBreaker.html" title="NgrokAPI::Models::EndpointCircuitBreaker (class)">EndpointCircuitBreaker</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointCompression' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointConfiguration' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointIPPolicy' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicy.html" title="NgrokAPI::Models::EndpointIPPolicy (class)">EndpointIPPolicy</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointIPPolicyMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicyMutate.html" title="NgrokAPI::Models::EndpointIPPolicyMutate (class)">EndpointIPPolicyMutate</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointLogging' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointLogging.html" title="NgrokAPI::Models::EndpointLogging (class)">EndpointLogging</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointLoggingMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointLoggingMutate.html" title="NgrokAPI::Models::EndpointLoggingMutate (class)">EndpointLoggingMutate</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointMutualTLS' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLS.html" title="NgrokAPI::Models::EndpointMutualTLS (class)">EndpointMutualTLS</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointMutualTLSMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLSMutate.html" title="NgrokAPI::Models::EndpointMutualTLSMutate (class)">EndpointMutualTLSMutate</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuth' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuth.html" title="NgrokAPI::Models::EndpointOAuth (class)">EndpointOAuth</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthFacebook' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthFacebook.html" title="NgrokAPI::Models::EndpointOAuthFacebook (class)">EndpointOAuthFacebook</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthGitHub' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGitHub.html" title="NgrokAPI::Models::EndpointOAuthGitHub (class)">EndpointOAuthGitHub</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthGoogle' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGoogle.html" title="NgrokAPI::Models::EndpointOAuthGoogle (class)">EndpointOAuthGoogle</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthMicrosoft' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthMicrosoft.html" title="NgrokAPI::Models::EndpointOAuthMicrosoft (class)">EndpointOAuthMicrosoft</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthProvider' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthProvider.html" title="NgrokAPI::Models::EndpointOAuthProvider (class)">EndpointOAuthProvider</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOIDC' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOIDC.html" title="NgrokAPI::Models::EndpointOIDC (class)">EndpointOIDC</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointRequestHeaders' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointRequestHeaders.html" title="NgrokAPI::Models::EndpointRequestHeaders (class)">EndpointRequestHeaders</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointResponseHeaders' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointResponseHeaders.html" title="NgrokAPI::Models::EndpointResponseHeaders (class)">EndpointResponseHeaders</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointSAML' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointSAML.html" title="NgrokAPI::Models::EndpointSAML (class)">EndpointSAML</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointSAMLMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointSAMLMutate.html" title="NgrokAPI::Models::EndpointSAMLMutate (class)">EndpointSAMLMutate</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointTLSTermination' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointTLSTermination.html" title="NgrokAPI::Models::EndpointTLSTermination (class)">EndpointTLSTermination</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointWebhookValidation' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointWebhookValidation.html" title="NgrokAPI::Models::EndpointWebhookValidation (class)">EndpointWebhookValidation</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventDestination' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">EventDestination</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventSource' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventSource.html" title="NgrokAPI::Models::EventSource (class)">EventSource</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventSourceReplace' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventSourceReplace.html" title="NgrokAPI::Models::EventSourceReplace (class)">EventSourceReplace</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventStream' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">EventStream</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventSubscription' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">EventSubscription</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTarget' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTarget.html" title="NgrokAPI::Models::EventTarget (class)">EventTarget</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTargetCloudwatchLogs' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTargetCloudwatchLogs.html" title="NgrokAPI::Models::EventTargetCloudwatchLogs (class)">EventTargetCloudwatchLogs</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTargetFirehose' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTargetFirehose.html" title="NgrokAPI::Models::EventTargetFirehose (class)">EventTargetFirehose</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTargetKinesis' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTargetKinesis.html" title="NgrokAPI::Models::EventTargetKinesis (class)">EventTargetKinesis</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPPolicy' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">IPPolicy</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPPolicyRule' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPPolicyRule.html" title="NgrokAPI::Models::IPPolicyRule (class)">IPPolicyRule</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPRestriction' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPRestriction.html" title="NgrokAPI::Models::IPRestriction (class)">IPRestriction</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPWhitelistEntry' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">IPWhitelistEntry</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Listable' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Ref' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Ref.html" title="NgrokAPI::Models::Ref (class)">Ref</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedAddr' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">ReservedAddr</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomain' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomainCertJob' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertJob.html" title="NgrokAPI::Models::ReservedDomainCertJob (class)">ReservedDomainCertJob</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomainCertNSTarget' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertNSTarget.html" title="NgrokAPI::Models::ReservedDomainCertNSTarget (class)">ReservedDomainCertNSTarget</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomainCertPolicy' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertPolicy.html" title="NgrokAPI::Models::ReservedDomainCertPolicy (class)">ReservedDomainCertPolicy</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomainCertStatus' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertStatus.html" title="NgrokAPI::Models::ReservedDomainCertStatus (class)">ReservedDomainCertStatus</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHCertificateAuthority' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHCertificateAuthority.html" title="NgrokAPI::Models::SSHCertificateAuthority (class)">SSHCertificateAuthority</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHCredential' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHCredential.html" title="NgrokAPI::Models::SSHCredential (class)">SSHCredential</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHHostCertificate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">SSHHostCertificate</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHUserCertificate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">SSHUserCertificate</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::TLSCertificate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::TLSCertificateSANs' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/TLSCertificateSANs.html" title="NgrokAPI::Models::TLSCertificateSANs (class)">TLSCertificateSANs</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Tunnel' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Tunnel.html" title="NgrokAPI::Models::Tunnel (class)">Tunnel</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::TunnelSession' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">TunnelSession</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li></ul></li><li id='object_NgrokAPI::PagedIterator' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/PagedIterator.html" title="NgrokAPI::PagedIterator (class)">PagedIterator</a></span> &lt; Object<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Services' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI/Services.html" title="NgrokAPI::Services (module)">Services</a></span><small class='search_info'>NgrokAPI</small></div><ul><li id='object_NgrokAPI::Services::APIKeysClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/APIKeysClient.html" title="NgrokAPI::Services::APIKeysClient (class)">APIKeysClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::AbuseReportsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/AbuseReportsClient.html" title="NgrokAPI::Services::AbuseReportsClient (class)">AbuseReportsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::CertificateAuthoritiesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/CertificateAuthoritiesClient.html" title="NgrokAPI::Services::CertificateAuthoritiesClient (class)">CertificateAuthoritiesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::CredentialsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/CredentialsClient.html" title="NgrokAPI::Services::CredentialsClient (class)">CredentialsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointCircuitBreakerModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html" title="NgrokAPI::Services::EndpointCircuitBreakerModuleClient (class)">EndpointCircuitBreakerModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointCompressionModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointCompressionModuleClient.html" title="NgrokAPI::Services::EndpointCompressionModuleClient (class)">EndpointCompressionModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointConfigurationsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointConfigurationsClient.html" title="NgrokAPI::Services::EndpointConfigurationsClient (class)">EndpointConfigurationsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointIPPolicyModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointIPPolicyModuleClient.html" title="NgrokAPI::Services::EndpointIPPolicyModuleClient (class)">EndpointIPPolicyModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointLoggingModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointLoggingModuleClient.html" title="NgrokAPI::Services::EndpointLoggingModuleClient (class)">EndpointLoggingModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointMutualTLSModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointMutualTLSModuleClient.html" title="NgrokAPI::Services::EndpointMutualTLSModuleClient (class)">EndpointMutualTLSModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointOAuthModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointOAuthModuleClient.html" title="NgrokAPI::Services::EndpointOAuthModuleClient (class)">EndpointOAuthModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointOIDCModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointOIDCModuleClient.html" title="NgrokAPI::Services::EndpointOIDCModuleClient (class)">EndpointOIDCModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointRequestHeadersModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointRequestHeadersModuleClient.html" title="NgrokAPI::Services::EndpointRequestHeadersModuleClient (class)">EndpointRequestHeadersModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointResponseHeadersModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointResponseHeadersModuleClient.html" title="NgrokAPI::Services::EndpointResponseHeadersModuleClient (class)">EndpointResponseHeadersModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointSAMLModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointSAMLModuleClient.html" title="NgrokAPI::Services::EndpointSAMLModuleClient (class)">EndpointSAMLModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointTLSTerminationModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointTLSTerminationModuleClient.html" title="NgrokAPI::Services::EndpointTLSTerminationModuleClient (class)">EndpointTLSTerminationModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointWebhookValidationModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointWebhookValidationModuleClient.html" title="NgrokAPI::Services::EndpointWebhookValidationModuleClient (class)">EndpointWebhookValidationModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventDestinationsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventDestinationsClient.html" title="NgrokAPI::Services::EventDestinationsClient (class)">EventDestinationsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventSourcesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventSourcesClient.html" title="NgrokAPI::Services::EventSourcesClient (class)">EventSourcesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventStreamsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventStreamsClient.html" title="NgrokAPI::Services::EventStreamsClient (class)">EventStreamsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventSubscriptionsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventSubscriptionsClient.html" title="NgrokAPI::Services::EventSubscriptionsClient (class)">EventSubscriptionsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPPoliciesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPPoliciesClient.html" title="NgrokAPI::Services::IPPoliciesClient (class)">IPPoliciesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPPolicyRulesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPPolicyRulesClient.html" title="NgrokAPI::Services::IPPolicyRulesClient (class)">IPPolicyRulesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPRestrictionsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPRestrictionsClient.html" title="NgrokAPI::Services::IPRestrictionsClient (class)">IPRestrictionsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPWhitelistClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPWhitelistClient.html" title="NgrokAPI::Services::IPWhitelistClient (class)">IPWhitelistClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::ReservedAddrsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/ReservedAddrsClient.html" title="NgrokAPI::Services::ReservedAddrsClient (class)">ReservedAddrsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::ReservedDomainsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">ReservedDomainsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHCertificateAuthoritiesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHCertificateAuthoritiesClient.html" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient (class)">SSHCertificateAuthoritiesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHCredentialsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHCredentialsClient.html" title="NgrokAPI::Services::SSHCredentialsClient (class)">SSHCredentialsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHHostCertificatesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHHostCertificatesClient.html" title="NgrokAPI::Services::SSHHostCertificatesClient (class)">SSHHostCertificatesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHUserCertificatesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHUserCertificatesClient.html" title="NgrokAPI::Services::SSHUserCertificatesClient (class)">SSHUserCertificatesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::TLSCertificatesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/TLSCertificatesClient.html" title="NgrokAPI::Services::TLSCertificatesClient (class)">TLSCertificatesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::TunnelSessionsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/TunnelSessionsClient.html" title="NgrokAPI::Services::TunnelSessionsClient (class)">TunnelSessionsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::TunnelsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/TunnelsClient.html" title="NgrokAPI::Services::TunnelsClient (class)">TunnelsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li></ul></li></ul></li>
46
+ <li id='object_NgrokAPI' class='even'><div class='item' style='padding-left:30px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span><small class='search_info'>Top Level Namespace</small></div><ul><li id='object_NgrokAPI::Client' class='collapsed odd'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span> &lt; Object<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Error' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/Error.html" title="NgrokAPI::Error (class)">Error</a></span> &lt; StandardError<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Errors' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI/Errors.html" title="NgrokAPI::Errors (module)">Errors</a></span><small class='search_info'>NgrokAPI</small></div><ul><li id='object_NgrokAPI::Errors::NotFoundError' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Errors/NotFoundError.html" title="NgrokAPI::Errors::NotFoundError (class)">NotFoundError</a></span> &lt; Error<small class='search_info'>NgrokAPI::Errors</small></div></li></ul></li><li id='object_NgrokAPI::HttpClient' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/HttpClient.html" title="NgrokAPI::HttpClient (class)">HttpClient</a></span> &lt; Object<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Models' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span><small class='search_info'>NgrokAPI</small></div><ul><li id='object_NgrokAPI::Models::APIKey' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AWSAuth' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AWSAuth.html" title="NgrokAPI::Models::AWSAuth (class)">AWSAuth</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AWSCredentials' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AWSCredentials.html" title="NgrokAPI::Models::AWSCredentials (class)">AWSCredentials</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AWSRole' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AWSRole.html" title="NgrokAPI::Models::AWSRole (class)">AWSRole</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AbuseReport' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AbuseReport.html" title="NgrokAPI::Models::AbuseReport (class)">AbuseReport</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::AbuseReportHostname' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/AbuseReportHostname.html" title="NgrokAPI::Models::AbuseReportHostname (class)">AbuseReportHostname</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::CertificateAuthority' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">CertificateAuthority</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Credential' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Credential.html" title="NgrokAPI::Models::Credential (class)">Credential</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointCircuitBreaker' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointCircuitBreaker.html" title="NgrokAPI::Models::EndpointCircuitBreaker (class)">EndpointCircuitBreaker</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointCompression' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointConfiguration' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointConfiguration.html" title="NgrokAPI::Models::EndpointConfiguration (class)">EndpointConfiguration</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointIPPolicy' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicy.html" title="NgrokAPI::Models::EndpointIPPolicy (class)">EndpointIPPolicy</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointIPPolicyMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointIPPolicyMutate.html" title="NgrokAPI::Models::EndpointIPPolicyMutate (class)">EndpointIPPolicyMutate</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointLogging' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointLogging.html" title="NgrokAPI::Models::EndpointLogging (class)">EndpointLogging</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointLoggingMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointLoggingMutate.html" title="NgrokAPI::Models::EndpointLoggingMutate (class)">EndpointLoggingMutate</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointMutualTLS' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLS.html" title="NgrokAPI::Models::EndpointMutualTLS (class)">EndpointMutualTLS</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointMutualTLSMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointMutualTLSMutate.html" title="NgrokAPI::Models::EndpointMutualTLSMutate (class)">EndpointMutualTLSMutate</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuth' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuth.html" title="NgrokAPI::Models::EndpointOAuth (class)">EndpointOAuth</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthFacebook' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthFacebook.html" title="NgrokAPI::Models::EndpointOAuthFacebook (class)">EndpointOAuthFacebook</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthGitHub' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGitHub.html" title="NgrokAPI::Models::EndpointOAuthGitHub (class)">EndpointOAuthGitHub</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthGoogle' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthGoogle.html" title="NgrokAPI::Models::EndpointOAuthGoogle (class)">EndpointOAuthGoogle</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthMicrosoft' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthMicrosoft.html" title="NgrokAPI::Models::EndpointOAuthMicrosoft (class)">EndpointOAuthMicrosoft</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOAuthProvider' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOAuthProvider.html" title="NgrokAPI::Models::EndpointOAuthProvider (class)">EndpointOAuthProvider</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointOIDC' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointOIDC.html" title="NgrokAPI::Models::EndpointOIDC (class)">EndpointOIDC</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointRequestHeaders' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointRequestHeaders.html" title="NgrokAPI::Models::EndpointRequestHeaders (class)">EndpointRequestHeaders</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointResponseHeaders' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointResponseHeaders.html" title="NgrokAPI::Models::EndpointResponseHeaders (class)">EndpointResponseHeaders</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointSAML' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointSAML.html" title="NgrokAPI::Models::EndpointSAML (class)">EndpointSAML</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointSAMLMutate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointSAMLMutate.html" title="NgrokAPI::Models::EndpointSAMLMutate (class)">EndpointSAMLMutate</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointTLSTermination' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointTLSTermination.html" title="NgrokAPI::Models::EndpointTLSTermination (class)">EndpointTLSTermination</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EndpointWebhookValidation' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EndpointWebhookValidation.html" title="NgrokAPI::Models::EndpointWebhookValidation (class)">EndpointWebhookValidation</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventDestination' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">EventDestination</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventSource' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventSource.html" title="NgrokAPI::Models::EventSource (class)">EventSource</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventSourceList' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventSourceList.html" title="NgrokAPI::Models::EventSourceList (class)">EventSourceList</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventSourceReplace' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventSourceReplace.html" title="NgrokAPI::Models::EventSourceReplace (class)">EventSourceReplace</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventStream' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">EventStream</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventSubscription' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">EventSubscription</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTarget' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTarget.html" title="NgrokAPI::Models::EventTarget (class)">EventTarget</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTargetCloudwatchLogs' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTargetCloudwatchLogs.html" title="NgrokAPI::Models::EventTargetCloudwatchLogs (class)">EventTargetCloudwatchLogs</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTargetFirehose' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTargetFirehose.html" title="NgrokAPI::Models::EventTargetFirehose (class)">EventTargetFirehose</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::EventTargetKinesis' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/EventTargetKinesis.html" title="NgrokAPI::Models::EventTargetKinesis (class)">EventTargetKinesis</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPPolicy' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">IPPolicy</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPPolicyRule' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPPolicyRule.html" title="NgrokAPI::Models::IPPolicyRule (class)">IPPolicyRule</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPRestriction' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPRestriction.html" title="NgrokAPI::Models::IPRestriction (class)">IPRestriction</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::IPWhitelistEntry' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">IPWhitelistEntry</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Listable' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Ref' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Ref.html" title="NgrokAPI::Models::Ref (class)">Ref</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedAddr' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">ReservedAddr</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomain' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomainCertJob' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertJob.html" title="NgrokAPI::Models::ReservedDomainCertJob (class)">ReservedDomainCertJob</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomainCertPolicy' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertPolicy.html" title="NgrokAPI::Models::ReservedDomainCertPolicy (class)">ReservedDomainCertPolicy</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::ReservedDomainCertStatus' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/ReservedDomainCertStatus.html" title="NgrokAPI::Models::ReservedDomainCertStatus (class)">ReservedDomainCertStatus</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHCertificateAuthority' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHCertificateAuthority.html" title="NgrokAPI::Models::SSHCertificateAuthority (class)">SSHCertificateAuthority</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHCredential' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHCredential.html" title="NgrokAPI::Models::SSHCredential (class)">SSHCredential</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHHostCertificate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHHostCertificate.html" title="NgrokAPI::Models::SSHHostCertificate (class)">SSHHostCertificate</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::SSHUserCertificate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/SSHUserCertificate.html" title="NgrokAPI::Models::SSHUserCertificate (class)">SSHUserCertificate</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::TLSCertificate' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::TLSCertificateSANs' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/TLSCertificateSANs.html" title="NgrokAPI::Models::TLSCertificateSANs (class)">TLSCertificateSANs</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::Tunnel' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/Tunnel.html" title="NgrokAPI::Models::Tunnel (class)">Tunnel</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li><li id='object_NgrokAPI::Models::TunnelSession' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Models/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">TunnelSession</a></span> &lt; Object<small class='search_info'>NgrokAPI::Models</small></div></li></ul></li><li id='object_NgrokAPI::PagedIterator' class='collapsed even'><div class='item' style='padding-left:45px'><span class='object_link'><a href="NgrokAPI/PagedIterator.html" title="NgrokAPI::PagedIterator (class)">PagedIterator</a></span> &lt; Object<small class='search_info'>NgrokAPI</small></div></li><li id='object_NgrokAPI::Services' class='collapsed odd'><div class='item' style='padding-left:45px'><a class='toggle'></a> <span class='object_link'><a href="NgrokAPI/Services.html" title="NgrokAPI::Services (module)">Services</a></span><small class='search_info'>NgrokAPI</small></div><ul><li id='object_NgrokAPI::Services::APIKeysClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/APIKeysClient.html" title="NgrokAPI::Services::APIKeysClient (class)">APIKeysClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::AbuseReportsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/AbuseReportsClient.html" title="NgrokAPI::Services::AbuseReportsClient (class)">AbuseReportsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::CertificateAuthoritiesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/CertificateAuthoritiesClient.html" title="NgrokAPI::Services::CertificateAuthoritiesClient (class)">CertificateAuthoritiesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::CredentialsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/CredentialsClient.html" title="NgrokAPI::Services::CredentialsClient (class)">CredentialsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointCircuitBreakerModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html" title="NgrokAPI::Services::EndpointCircuitBreakerModuleClient (class)">EndpointCircuitBreakerModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointCompressionModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointCompressionModuleClient.html" title="NgrokAPI::Services::EndpointCompressionModuleClient (class)">EndpointCompressionModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointConfigurationsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointConfigurationsClient.html" title="NgrokAPI::Services::EndpointConfigurationsClient (class)">EndpointConfigurationsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointIPPolicyModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointIPPolicyModuleClient.html" title="NgrokAPI::Services::EndpointIPPolicyModuleClient (class)">EndpointIPPolicyModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointLoggingModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointLoggingModuleClient.html" title="NgrokAPI::Services::EndpointLoggingModuleClient (class)">EndpointLoggingModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointMutualTLSModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointMutualTLSModuleClient.html" title="NgrokAPI::Services::EndpointMutualTLSModuleClient (class)">EndpointMutualTLSModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointOAuthModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointOAuthModuleClient.html" title="NgrokAPI::Services::EndpointOAuthModuleClient (class)">EndpointOAuthModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointOIDCModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointOIDCModuleClient.html" title="NgrokAPI::Services::EndpointOIDCModuleClient (class)">EndpointOIDCModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointRequestHeadersModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointRequestHeadersModuleClient.html" title="NgrokAPI::Services::EndpointRequestHeadersModuleClient (class)">EndpointRequestHeadersModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointResponseHeadersModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointResponseHeadersModuleClient.html" title="NgrokAPI::Services::EndpointResponseHeadersModuleClient (class)">EndpointResponseHeadersModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointSAMLModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointSAMLModuleClient.html" title="NgrokAPI::Services::EndpointSAMLModuleClient (class)">EndpointSAMLModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointTLSTerminationModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointTLSTerminationModuleClient.html" title="NgrokAPI::Services::EndpointTLSTerminationModuleClient (class)">EndpointTLSTerminationModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EndpointWebhookValidationModuleClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EndpointWebhookValidationModuleClient.html" title="NgrokAPI::Services::EndpointWebhookValidationModuleClient (class)">EndpointWebhookValidationModuleClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventDestinationsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventDestinationsClient.html" title="NgrokAPI::Services::EventDestinationsClient (class)">EventDestinationsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventSourcesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventSourcesClient.html" title="NgrokAPI::Services::EventSourcesClient (class)">EventSourcesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventStreamsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventStreamsClient.html" title="NgrokAPI::Services::EventStreamsClient (class)">EventStreamsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::EventSubscriptionsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/EventSubscriptionsClient.html" title="NgrokAPI::Services::EventSubscriptionsClient (class)">EventSubscriptionsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPPoliciesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPPoliciesClient.html" title="NgrokAPI::Services::IPPoliciesClient (class)">IPPoliciesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPPolicyRulesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPPolicyRulesClient.html" title="NgrokAPI::Services::IPPolicyRulesClient (class)">IPPolicyRulesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPRestrictionsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPRestrictionsClient.html" title="NgrokAPI::Services::IPRestrictionsClient (class)">IPRestrictionsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::IPWhitelistClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/IPWhitelistClient.html" title="NgrokAPI::Services::IPWhitelistClient (class)">IPWhitelistClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::ReservedAddrsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/ReservedAddrsClient.html" title="NgrokAPI::Services::ReservedAddrsClient (class)">ReservedAddrsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::ReservedDomainsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/ReservedDomainsClient.html" title="NgrokAPI::Services::ReservedDomainsClient (class)">ReservedDomainsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHCertificateAuthoritiesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHCertificateAuthoritiesClient.html" title="NgrokAPI::Services::SSHCertificateAuthoritiesClient (class)">SSHCertificateAuthoritiesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHCredentialsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHCredentialsClient.html" title="NgrokAPI::Services::SSHCredentialsClient (class)">SSHCredentialsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHHostCertificatesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHHostCertificatesClient.html" title="NgrokAPI::Services::SSHHostCertificatesClient (class)">SSHHostCertificatesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::SSHUserCertificatesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/SSHUserCertificatesClient.html" title="NgrokAPI::Services::SSHUserCertificatesClient (class)">SSHUserCertificatesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::TLSCertificatesClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/TLSCertificatesClient.html" title="NgrokAPI::Services::TLSCertificatesClient (class)">TLSCertificatesClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::TunnelSessionsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/TunnelSessionsClient.html" title="NgrokAPI::Services::TunnelSessionsClient (class)">TunnelSessionsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li><li id='object_NgrokAPI::Services::TunnelsClient' class='collapsed'><div class='item' style='padding-left:60px'><span class='object_link'><a href="NgrokAPI/Services/TunnelsClient.html" title="NgrokAPI::Services::TunnelsClient (class)">TunnelsClient</a></span> &lt; Object<small class='search_info'>NgrokAPI::Services</small></div></li></ul></li></ul></li>
47
47
 
48
48
  </ul>
49
49
  </div>
data/doc/file.README.html CHANGED
@@ -58,7 +58,7 @@
58
58
  </div>
59
59
 
60
60
  <div id="content"><div id='filecontents'>
61
- <h1 id="label-ngrok+API+client+library+for+Ruby">ngrok API client library for Ruby</h1>
61
+ <h1 id="label-ngrok-api">ngrok-api</h1>
62
62
 
63
63
  <p>This library wraps the <a href="https://ngrok.com/docs/api">ngrok HTTP API</a> to make it easier to consume in Ruby.</p>
64
64
 
@@ -69,54 +69,81 @@
69
69
  <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_ngrok'>ngrok</span><span class='op'>-</span><span class='id identifier rubyid_api'>api</span>
70
70
  </code></pre>
71
71
 
72
- <h2 id="label-Documentation">Documentation</h2>
73
-
74
- <p>A quickstart guide and a full API reference are included in the <a href="https://ruby-api.docs.ngrok.com">ngrok Ruby API documentation</a></p>
75
-
76
72
  <h2 id="label-Quickstart">Quickstart</h2>
77
73
 
78
74
  <p>Please consult the <a href="https://ruby-api.docs.ngrok.com">documentation</a> for additional examples.</p>
79
75
 
80
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi/client</span><span class='tstring_end'>&#39;</span></span>
81
- <span class='id identifier rubyid_client'>client</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
82
-
83
- <span class='comment'># Get an instance of the api_keys client and list all API keys
84
- </span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
76
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
77
+ <span class='id identifier rubyid_client'>client</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
78
+
79
+ <span class='comment'># Get an instance of the api_keys client and list all API keys
80
+ </span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
85
81
  <span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span>
86
82
  </code></pre>
87
83
 
88
- <h2 id="label-Local+Documentation">Local Documentation</h2>
84
+ <h2 id="label-Automatic+Paging">Automatic Paging</h2>
89
85
 
90
- <p>Documentation can be generated with the command:</p>
86
+ <p>The ngrok API pages all list resources but this library abstracts that away from you. All response objects from any <code>list</code> or <code>list!</code> methods return an object that implements an <code>each</code> method which will automatically fetch additional pages for you.</p>
91
87
 
92
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_yard'>yard</span> <span class='id identifier rubyid_doc'>doc</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>lib/**/*.rb</span><span class='tstring_end'>&#39;</span></span>
88
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
89
+ <span class='id identifier rubyid_client'>client</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
90
+
91
+ <span class='comment'># list all api keys, transparently fetching additional
92
+ </span><span class='comment'># pages for you if necessary
93
+ </span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
94
+ <span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='op'>|</span>
95
+ <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
96
+ <span class='kw'>end</span>
93
97
  </code></pre>
94
98
 
95
- <p>This will generate documentation which can be viewed within the doc folder.</p>
99
+ <h2 id="label-Instance+Methods">Instance Methods</h2>
100
+
101
+ <p>Instance methods like <code>update</code> and <code>delete</code> can be invoked on an instance of an API object itself as well as directly without needing to first fetch the object.</p>
102
+
103
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
104
+ <span class='id identifier rubyid_client'>client</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
105
+
106
+ <span class='comment'># update the metadata of a credential
107
+ </span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cr_1kYyunEyn6XHHlqyMBLrj5nxkoz</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
108
+ <span class='id identifier rubyid_cred'>cred</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>metadata:</span> <span class='lbrace'>{</span><span class='label'>server_name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>giraffe-1</span><span class='tstring_end'>&#39;</span></span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
109
+
110
+ <span class='comment'># or do it in single call
111
+ </span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cr_1kYyunEyn6XHHlqyMBLrj5nxkoz</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='lbrace'>{</span><span class='label'>server_name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>giraffe-1</span><span class='tstring_end'>&#39;</span></span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
112
+ </code></pre>
113
+
114
+ <h2 id="label-Bang+Methods">Bang Methods</h2>
115
+
116
+ <p>Most methods that interact with the API have a <code>!</code> counterpart. It raises an error when one is returned by the API.</p>
96
117
 
97
- <h2 id="label-Specs">Specs</h2>
118
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
119
+ <span class='id identifier rubyid_client'>client</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
98
120
 
99
- <p>Specs can be run with the command:</p>
121
+ <span class='comment'># no error raised, even though it&#39;s a bad identifier
122
+ </span><span class='comment'># the error is simply returned
123
+ </span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>invalid</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
100
124
 
101
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rake'>rake</span>
125
+ <span class='comment'># this raises an NgrokAPI::Error
126
+ </span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</span><span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>invalid</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
102
127
  </code></pre>
103
128
 
104
- <p>This will generate a coverage report which can be viewed within the coverage folder.</p>
129
+ <h2 id="label-Error+Handling">Error Handling</h2>
105
130
 
106
- <h2 id="label-Rubocop">Rubocop</h2>
131
+ <p>The ngrok API returns detailed information when an API call fails. Consult the section on errors for additional details.</p>
107
132
 
108
- <p>Rubocop can be run with the command:</p>
133
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
134
+ <span class='id identifier rubyid_client'>client</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
109
135
 
110
- <pre class="code ruby"><code class="ruby"><span class='comment'># Run rubocop on lib folder
111
- </span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>lib</span><span class='tstring_end'>&#39;</span></span>
112
-
113
- <span class='comment'># Run rubcop on all files
114
- </span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span>
136
+ <span class='kw'>begin</span>
137
+ <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_ip_policies'>ip_policies</span><span class='period'>.</span><span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>invalid</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
138
+ <span class='kw'>rescue</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="NgrokAPI/Error.html" title="NgrokAPI::Error (class)">Error</a></span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
139
+ <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='rparen'>)</span>
140
+ <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span>
141
+ <span class='kw'>end</span>
115
142
  </code></pre>
116
143
  </div></div>
117
144
 
118
145
  <div id="footer">
119
- Generated on Mon Oct 4 23:24:15 2021 by
146
+ Generated on Tue Oct 19 15:48:17 2021 by
120
147
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
121
148
  0.9.26 (ruby-3.0.1).
122
149
  </div>
data/doc/index.html CHANGED
@@ -58,7 +58,7 @@
58
58
  </div>
59
59
 
60
60
  <div id="content"><div id='filecontents'>
61
- <h1 id="label-ngrok+API+client+library+for+Ruby">ngrok API client library for Ruby</h1>
61
+ <h1 id="label-ngrok-api">ngrok-api</h1>
62
62
 
63
63
  <p>This library wraps the <a href="https://ngrok.com/docs/api">ngrok HTTP API</a> to make it easier to consume in Ruby.</p>
64
64
 
@@ -69,54 +69,81 @@
69
69
  <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_ngrok'>ngrok</span><span class='op'>-</span><span class='id identifier rubyid_api'>api</span>
70
70
  </code></pre>
71
71
 
72
- <h2 id="label-Documentation">Documentation</h2>
73
-
74
- <p>A quickstart guide and a full API reference are included in the <a href="https://ruby-api.docs.ngrok.com">ngrok Ruby API documentation</a></p>
75
-
76
72
  <h2 id="label-Quickstart">Quickstart</h2>
77
73
 
78
74
  <p>Please consult the <a href="https://ruby-api.docs.ngrok.com">documentation</a> for additional examples.</p>
79
75
 
80
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi/client</span><span class='tstring_end'>&#39;</span></span>
81
- <span class='id identifier rubyid_client'>client</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
82
-
83
- <span class='comment'># Get an instance of the api_keys client and list all API keys
84
- </span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
76
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
77
+ <span class='id identifier rubyid_client'>client</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
78
+
79
+ <span class='comment'># Get an instance of the api_keys client and list all API keys
80
+ </span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
85
81
  <span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span>
86
82
  </code></pre>
87
83
 
88
- <h2 id="label-Local+Documentation">Local Documentation</h2>
84
+ <h2 id="label-Automatic+Paging">Automatic Paging</h2>
89
85
 
90
- <p>Documentation can be generated with the command:</p>
86
+ <p>The ngrok API pages all list resources but this library abstracts that away from you. All response objects from any <code>list</code> or <code>list!</code> methods return an object that implements an <code>each</code> method which will automatically fetch additional pages for you.</p>
91
87
 
92
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_yard'>yard</span> <span class='id identifier rubyid_doc'>doc</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>lib/**/*.rb</span><span class='tstring_end'>&#39;</span></span>
88
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
89
+ <span class='id identifier rubyid_client'>client</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
90
+
91
+ <span class='comment'># list all api keys, transparently fetching additional
92
+ </span><span class='comment'># pages for you if necessary
93
+ </span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
94
+ <span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='period'>.</span><span class='id identifier rubyid_each'>each</span> <span class='kw'>do</span> <span class='op'>|</span><span class='id identifier rubyid_key'>key</span><span class='op'>|</span>
95
+ <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_key'>key</span><span class='rparen'>)</span>
96
+ <span class='kw'>end</span>
93
97
  </code></pre>
94
98
 
95
- <p>This will generate documentation which can be viewed within the doc folder.</p>
99
+ <h2 id="label-Instance+Methods">Instance Methods</h2>
100
+
101
+ <p>Instance methods like <code>update</code> and <code>delete</code> can be invoked on an instance of an API object itself as well as directly without needing to first fetch the object.</p>
102
+
103
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
104
+ <span class='id identifier rubyid_client'>client</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
105
+
106
+ <span class='comment'># update the metadata of a credential
107
+ </span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cr_1kYyunEyn6XHHlqyMBLrj5nxkoz</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
108
+ <span class='id identifier rubyid_cred'>cred</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>metadata:</span> <span class='lbrace'>{</span><span class='label'>server_name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>giraffe-1</span><span class='tstring_end'>&#39;</span></span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
109
+
110
+ <span class='comment'># or do it in single call
111
+ </span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>cr_1kYyunEyn6XHHlqyMBLrj5nxkoz</span><span class='tstring_end'>&#39;</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='lbrace'>{</span><span class='label'>server_name:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>giraffe-1</span><span class='tstring_end'>&#39;</span></span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
112
+ </code></pre>
113
+
114
+ <h2 id="label-Bang+Methods">Bang Methods</h2>
115
+
116
+ <p>Most methods that interact with the API have a <code>!</code> counterpart. It raises an error when one is returned by the API.</p>
96
117
 
97
- <h2 id="label-Specs">Specs</h2>
118
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
119
+ <span class='id identifier rubyid_client'>client</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
98
120
 
99
- <p>Specs can be run with the command:</p>
121
+ <span class='comment'># no error raised, even though it&#39;s a bad identifier
122
+ </span><span class='comment'># the error is simply returned
123
+ </span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>invalid</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
100
124
 
101
- <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rake'>rake</span>
125
+ <span class='comment'># this raises an NgrokAPI::Error
126
+ </span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</span><span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>invalid</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
102
127
  </code></pre>
103
128
 
104
- <p>This will generate a coverage report which can be viewed within the coverage folder.</p>
129
+ <h2 id="label-Error+Handling">Error Handling</h2>
105
130
 
106
- <h2 id="label-Rubocop">Rubocop</h2>
131
+ <p>The ngrok API returns detailed information when an API call fails. Consult the section on errors for additional details.</p>
107
132
 
108
- <p>Rubocop can be run with the command:</p>
133
+ <pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>&#39;</span></span>
134
+ <span class='id identifier rubyid_client'>client</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>&lt;API KEY&gt;</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
109
135
 
110
- <pre class="code ruby"><code class="ruby"><span class='comment'># Run rubocop on lib folder
111
- </span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>lib</span><span class='tstring_end'>&#39;</span></span>
112
-
113
- <span class='comment'># Run rubcop on all files
114
- </span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span>
136
+ <span class='kw'>begin</span>
137
+ <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_ip_policies'>ip_policies</span><span class='period'>.</span><span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>invalid</span><span class='tstring_end'>&#39;</span></span><span class='rparen'>)</span>
138
+ <span class='kw'>rescue</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="NgrokAPI/Error.html" title="NgrokAPI::Error (class)">Error</a></span></span> <span class='op'>=&gt;</span> <span class='id identifier rubyid_e'>e</span>
139
+ <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='rparen'>)</span>
140
+ <span class='id identifier rubyid_puts'>puts</span><span class='lparen'>(</span><span class='id identifier rubyid_e'>e</span><span class='period'>.</span><span class='id identifier rubyid_response'>response</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span><span class='rparen'>)</span>
141
+ <span class='kw'>end</span>
115
142
  </code></pre>
116
143
  </div></div>
117
144
 
118
145
  <div id="footer">
119
- Generated on Mon Oct 4 23:24:15 2021 by
146
+ Generated on Tue Oct 19 15:48:17 2021 by
120
147
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
121
148
  0.9.26 (ruby-3.0.1).
122
149
  </div>