ngrok-api 0.15.0 → 0.16.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 (266) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +1 -1
  3. data/doc/NgrokAPI/Client.html +140 -172
  4. data/doc/NgrokAPI/Error.html +3 -3
  5. data/doc/NgrokAPI/Errors/NotFoundError.html +3 -3
  6. data/doc/NgrokAPI/Errors.html +3 -3
  7. data/doc/NgrokAPI/HttpClient.html +30 -36
  8. data/doc/NgrokAPI/Models/APIKey.html +3 -3
  9. data/doc/NgrokAPI/Models/AWSAuth.html +3 -3
  10. data/doc/NgrokAPI/Models/AWSCredentials.html +3 -3
  11. data/doc/NgrokAPI/Models/AWSRole.html +3 -3
  12. data/doc/NgrokAPI/Models/AbuseReport.html +3 -3
  13. data/doc/NgrokAPI/Models/AbuseReportHostname.html +3 -3
  14. data/doc/NgrokAPI/Models/{IPWhitelistEntry.html → AgentIngress.html} +216 -68
  15. data/doc/NgrokAPI/Models/CertificateAuthority.html +3 -3
  16. data/doc/NgrokAPI/Models/Credential.html +3 -3
  17. data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +3 -3
  18. data/doc/NgrokAPI/Models/EndpointCompression.html +3 -3
  19. data/doc/NgrokAPI/Models/EndpointConfiguration.html +3 -3
  20. data/doc/NgrokAPI/Models/EndpointIPPolicy.html +3 -3
  21. data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +3 -3
  22. data/doc/NgrokAPI/Models/EndpointLogging.html +3 -3
  23. data/doc/NgrokAPI/Models/EndpointLoggingMutate.html +3 -3
  24. data/doc/NgrokAPI/Models/EndpointMutualTLS.html +3 -3
  25. data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +3 -3
  26. data/doc/NgrokAPI/Models/EndpointOAuth.html +3 -3
  27. data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +3 -3
  28. data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +3 -3
  29. data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +3 -3
  30. data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +3 -3
  31. data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +3 -3
  32. data/doc/NgrokAPI/Models/EndpointOIDC.html +3 -3
  33. data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +3 -3
  34. data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +3 -3
  35. data/doc/NgrokAPI/Models/EndpointSAML.html +3 -3
  36. data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +3 -3
  37. data/doc/NgrokAPI/Models/EndpointTLSTermination.html +3 -3
  38. data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +3 -3
  39. data/doc/NgrokAPI/Models/EventDestination.html +3 -3
  40. data/doc/NgrokAPI/Models/EventSource.html +3 -3
  41. data/doc/NgrokAPI/Models/EventSourceList.html +3 -3
  42. data/doc/NgrokAPI/Models/EventSourceReplace.html +3 -3
  43. data/doc/NgrokAPI/Models/EventStream.html +3 -3
  44. data/doc/NgrokAPI/Models/EventSubscription.html +3 -3
  45. data/doc/NgrokAPI/Models/EventTarget.html +3 -3
  46. data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +3 -3
  47. data/doc/NgrokAPI/Models/EventTargetFirehose.html +3 -3
  48. data/doc/NgrokAPI/Models/EventTargetKinesis.html +3 -3
  49. data/doc/NgrokAPI/Models/IPPolicy.html +3 -3
  50. data/doc/NgrokAPI/Models/IPPolicyRule.html +3 -3
  51. data/doc/NgrokAPI/Models/IPRestriction.html +3 -3
  52. data/doc/NgrokAPI/Models/Listable.html +3 -3
  53. data/doc/NgrokAPI/Models/Ref.html +3 -3
  54. data/doc/NgrokAPI/Models/ReservedAddr.html +3 -3
  55. data/doc/NgrokAPI/Models/ReservedDomain.html +3 -3
  56. data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +3 -3
  57. data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +3 -3
  58. data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +3 -3
  59. data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +3 -3
  60. data/doc/NgrokAPI/Models/SSHCredential.html +3 -3
  61. data/doc/NgrokAPI/Models/SSHHostCertificate.html +3 -3
  62. data/doc/NgrokAPI/Models/SSHUserCertificate.html +3 -3
  63. data/doc/NgrokAPI/Models/TLSCertificate.html +3 -3
  64. data/doc/NgrokAPI/Models/TLSCertificateSANs.html +3 -3
  65. data/doc/NgrokAPI/Models/Tunnel.html +3 -3
  66. data/doc/NgrokAPI/Models/TunnelSession.html +3 -3
  67. data/doc/NgrokAPI/Models.html +5 -5
  68. data/doc/NgrokAPI/PagedIterator.html +3 -3
  69. data/doc/NgrokAPI/Services/APIKeysClient.html +99 -149
  70. data/doc/NgrokAPI/Services/AbuseReportsClient.html +19 -33
  71. data/doc/NgrokAPI/Services/{IPWhitelistClient.html → AgentIngressesClient.html} +209 -265
  72. data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +104 -156
  73. data/doc/NgrokAPI/Services/CredentialsClient.html +108 -164
  74. data/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +49 -77
  75. data/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html +49 -77
  76. data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +137 -273
  77. data/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +49 -77
  78. data/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html +49 -77
  79. data/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +49 -77
  80. data/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html +49 -77
  81. data/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html +49 -77
  82. data/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +49 -77
  83. data/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +49 -77
  84. data/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html +49 -77
  85. data/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +49 -77
  86. data/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +49 -77
  87. data/doc/NgrokAPI/Services/EventDestinationsClient.html +116 -184
  88. data/doc/NgrokAPI/Services/EventSourcesClient.html +95 -157
  89. data/doc/NgrokAPI/Services/EventStreamsClient.html +119 -189
  90. data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +113 -175
  91. data/doc/NgrokAPI/Services/IPPoliciesClient.html +104 -156
  92. data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +111 -169
  93. data/doc/NgrokAPI/Services/IPRestrictionsClient.html +116 -180
  94. data/doc/NgrokAPI/Services/ReservedAddrsClient.html +132 -198
  95. data/doc/NgrokAPI/Services/ReservedDomainsClient.html +193 -303
  96. data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +110 -166
  97. data/doc/NgrokAPI/Services/SSHCredentialsClient.html +111 -169
  98. data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +111 -171
  99. data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +111 -175
  100. data/doc/NgrokAPI/Services/TLSCertificatesClient.html +107 -161
  101. data/doc/NgrokAPI/Services/TunnelSessionsClient.html +87 -135
  102. data/doc/NgrokAPI/Services/TunnelsClient.html +13 -25
  103. data/doc/NgrokAPI/Services.html +5 -5
  104. data/doc/NgrokAPI.html +4 -4
  105. data/doc/_index.html +18 -18
  106. data/doc/class_list.html +1 -1
  107. data/doc/file.README.html +3 -3
  108. data/doc/frames.html +1 -1
  109. data/doc/index.html +3 -3
  110. data/doc/method_list.html +574 -558
  111. data/doc/top-level-namespace.html +3 -3
  112. data/docs/NgrokAPI/Client.html +140 -172
  113. data/docs/NgrokAPI/Error.html +3 -3
  114. data/docs/NgrokAPI/Errors/NotFoundError.html +3 -3
  115. data/docs/NgrokAPI/Errors.html +3 -3
  116. data/docs/NgrokAPI/HttpClient.html +30 -36
  117. data/docs/NgrokAPI/Models/APIKey.html +3 -3
  118. data/docs/NgrokAPI/Models/AWSAuth.html +3 -3
  119. data/docs/NgrokAPI/Models/AWSCredentials.html +3 -3
  120. data/docs/NgrokAPI/Models/AWSRole.html +3 -3
  121. data/docs/NgrokAPI/Models/AbuseReport.html +3 -3
  122. data/docs/NgrokAPI/Models/AbuseReportHostname.html +3 -3
  123. data/docs/NgrokAPI/Models/{IPWhitelistEntry.html → AgentIngress.html} +216 -68
  124. data/docs/NgrokAPI/Models/CertificateAuthority.html +3 -3
  125. data/docs/NgrokAPI/Models/Credential.html +3 -3
  126. data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +3 -3
  127. data/docs/NgrokAPI/Models/EndpointCompression.html +3 -3
  128. data/docs/NgrokAPI/Models/EndpointConfiguration.html +3 -3
  129. data/docs/NgrokAPI/Models/EndpointIPPolicy.html +3 -3
  130. data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +3 -3
  131. data/docs/NgrokAPI/Models/EndpointLogging.html +3 -3
  132. data/docs/NgrokAPI/Models/EndpointLoggingMutate.html +3 -3
  133. data/docs/NgrokAPI/Models/EndpointMutualTLS.html +3 -3
  134. data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +3 -3
  135. data/docs/NgrokAPI/Models/EndpointOAuth.html +3 -3
  136. data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +3 -3
  137. data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +3 -3
  138. data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +3 -3
  139. data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +3 -3
  140. data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +3 -3
  141. data/docs/NgrokAPI/Models/EndpointOIDC.html +3 -3
  142. data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +3 -3
  143. data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +3 -3
  144. data/docs/NgrokAPI/Models/EndpointSAML.html +3 -3
  145. data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +3 -3
  146. data/docs/NgrokAPI/Models/EndpointTLSTermination.html +3 -3
  147. data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +3 -3
  148. data/docs/NgrokAPI/Models/EventDestination.html +3 -3
  149. data/docs/NgrokAPI/Models/EventSource.html +3 -3
  150. data/docs/NgrokAPI/Models/EventSourceList.html +3 -3
  151. data/docs/NgrokAPI/Models/EventSourceReplace.html +3 -3
  152. data/docs/NgrokAPI/Models/EventStream.html +3 -3
  153. data/docs/NgrokAPI/Models/EventSubscription.html +3 -3
  154. data/docs/NgrokAPI/Models/EventTarget.html +3 -3
  155. data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +3 -3
  156. data/docs/NgrokAPI/Models/EventTargetFirehose.html +3 -3
  157. data/docs/NgrokAPI/Models/EventTargetKinesis.html +3 -3
  158. data/docs/NgrokAPI/Models/IPPolicy.html +3 -3
  159. data/docs/NgrokAPI/Models/IPPolicyRule.html +3 -3
  160. data/docs/NgrokAPI/Models/IPRestriction.html +3 -3
  161. data/docs/NgrokAPI/Models/Listable.html +3 -3
  162. data/docs/NgrokAPI/Models/Ref.html +3 -3
  163. data/docs/NgrokAPI/Models/ReservedAddr.html +3 -3
  164. data/docs/NgrokAPI/Models/ReservedDomain.html +3 -3
  165. data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +3 -3
  166. data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +3 -3
  167. data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +3 -3
  168. data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +3 -3
  169. data/docs/NgrokAPI/Models/SSHCredential.html +3 -3
  170. data/docs/NgrokAPI/Models/SSHHostCertificate.html +3 -3
  171. data/docs/NgrokAPI/Models/SSHUserCertificate.html +3 -3
  172. data/docs/NgrokAPI/Models/TLSCertificate.html +3 -3
  173. data/docs/NgrokAPI/Models/TLSCertificateSANs.html +3 -3
  174. data/docs/NgrokAPI/Models/Tunnel.html +3 -3
  175. data/docs/NgrokAPI/Models/TunnelSession.html +3 -3
  176. data/docs/NgrokAPI/Models.html +5 -5
  177. data/docs/NgrokAPI/PagedIterator.html +3 -3
  178. data/docs/NgrokAPI/Services/APIKeysClient.html +99 -149
  179. data/docs/NgrokAPI/Services/AbuseReportsClient.html +19 -33
  180. data/docs/NgrokAPI/Services/{IPWhitelistClient.html → AgentIngressesClient.html} +209 -265
  181. data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +104 -156
  182. data/docs/NgrokAPI/Services/CredentialsClient.html +108 -164
  183. data/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +49 -77
  184. data/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html +49 -77
  185. data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +137 -273
  186. data/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +49 -77
  187. data/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html +49 -77
  188. data/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +49 -77
  189. data/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html +49 -77
  190. data/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html +49 -77
  191. data/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +49 -77
  192. data/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +49 -77
  193. data/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html +49 -77
  194. data/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +49 -77
  195. data/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +49 -77
  196. data/docs/NgrokAPI/Services/EventDestinationsClient.html +116 -184
  197. data/docs/NgrokAPI/Services/EventSourcesClient.html +95 -157
  198. data/docs/NgrokAPI/Services/EventStreamsClient.html +119 -189
  199. data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +113 -175
  200. data/docs/NgrokAPI/Services/IPPoliciesClient.html +104 -156
  201. data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +111 -169
  202. data/docs/NgrokAPI/Services/IPRestrictionsClient.html +116 -180
  203. data/docs/NgrokAPI/Services/ReservedAddrsClient.html +132 -198
  204. data/docs/NgrokAPI/Services/ReservedDomainsClient.html +193 -303
  205. data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +110 -166
  206. data/docs/NgrokAPI/Services/SSHCredentialsClient.html +111 -169
  207. data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +111 -171
  208. data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +111 -175
  209. data/docs/NgrokAPI/Services/TLSCertificatesClient.html +107 -161
  210. data/docs/NgrokAPI/Services/TunnelSessionsClient.html +87 -135
  211. data/docs/NgrokAPI/Services/TunnelsClient.html +13 -25
  212. data/docs/NgrokAPI/Services.html +5 -5
  213. data/docs/NgrokAPI.html +4 -4
  214. data/docs/_index.html +18 -18
  215. data/docs/class_list.html +1 -1
  216. data/docs/file.README.html +3 -3
  217. data/docs/frames.html +1 -1
  218. data/docs/index.html +3 -3
  219. data/docs/method_list.html +574 -558
  220. data/docs/top-level-namespace.html +3 -3
  221. data/lib/ngrokapi/client.rb +5 -13
  222. data/lib/ngrokapi/http_client.rb +1 -4
  223. data/lib/ngrokapi/models/{ip_whitelist_entry.rb → agent_ingress.rb} +13 -9
  224. data/lib/ngrokapi/services/abuse_reports_client.rb +3 -10
  225. data/lib/ngrokapi/services/{ip_whitelist_client.rb → agent_ingresses_client.rb} +65 -94
  226. data/lib/ngrokapi/services/api_keys_client.rb +11 -36
  227. data/lib/ngrokapi/services/certificate_authorities_client.rb +11 -37
  228. data/lib/ngrokapi/services/credentials_client.rb +11 -39
  229. data/lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb +6 -20
  230. data/lib/ngrokapi/services/endpoint_compression_module_client.rb +6 -20
  231. data/lib/ngrokapi/services/endpoint_configurations_client.rb +11 -79
  232. data/lib/ngrokapi/services/endpoint_ip_policy_module_client.rb +6 -20
  233. data/lib/ngrokapi/services/endpoint_logging_module_client.rb +6 -20
  234. data/lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb +6 -20
  235. data/lib/ngrokapi/services/endpoint_o_auth_module_client.rb +6 -20
  236. data/lib/ngrokapi/services/endpoint_oidc_module_client.rb +6 -20
  237. data/lib/ngrokapi/services/endpoint_request_headers_module_client.rb +6 -20
  238. data/lib/ngrokapi/services/endpoint_response_headers_module_client.rb +6 -20
  239. data/lib/ngrokapi/services/endpoint_saml_module_client.rb +6 -20
  240. data/lib/ngrokapi/services/endpoint_tls_termination_module_client.rb +6 -20
  241. data/lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb +6 -20
  242. data/lib/ngrokapi/services/event_destinations_client.rb +11 -45
  243. data/lib/ngrokapi/services/event_sources_client.rb +9 -40
  244. data/lib/ngrokapi/services/event_streams_client.rb +11 -46
  245. data/lib/ngrokapi/services/event_subscriptions_client.rb +11 -42
  246. data/lib/ngrokapi/services/ip_policies_client.rb +11 -37
  247. data/lib/ngrokapi/services/ip_policy_rules_client.rb +11 -40
  248. data/lib/ngrokapi/services/ip_restrictions_client.rb +11 -43
  249. data/lib/ngrokapi/services/reserved_addrs_client.rb +13 -46
  250. data/lib/ngrokapi/services/reserved_domains_client.rb +19 -74
  251. data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +11 -39
  252. data/lib/ngrokapi/services/ssh_credentials_client.rb +11 -40
  253. data/lib/ngrokapi/services/ssh_host_certificates_client.rb +11 -41
  254. data/lib/ngrokapi/services/ssh_user_certificates_client.rb +11 -43
  255. data/lib/ngrokapi/services/tls_certificates_client.rb +11 -38
  256. data/lib/ngrokapi/services/tunnel_sessions_client.rb +12 -36
  257. data/lib/ngrokapi/services/tunnels_client.rb +4 -10
  258. data/lib/ngrokapi/version.rb +1 -1
  259. data/lib/ngrokapi.rb +1 -1
  260. data/ngrok-api.gemspec +1 -1
  261. data/spec/ngrokapi/client_spec.rb +6 -6
  262. data/spec/ngrokapi/models/agent_ingress_spec.rb +42 -0
  263. data/spec/ngrokapi/services/{ip_whitelist_client_spec.rb → agent_ingresses_client_spec.rb} +49 -49
  264. data/spec/spec_helper.rb +1096 -1045
  265. metadata +10 -10
  266. data/spec/ngrokapi/models/ip_whitelist_entry_spec.rb +0 -42
@@ -4,9 +4,9 @@
4
4
  <meta charset="utf-8">
5
5
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
6
  <title>
7
- Class: NgrokAPI::Services::IPWhitelistClient
7
+ Class: NgrokAPI::Services::AgentIngressesClient
8
8
 
9
- &mdash; Documentation by YARD 0.9.26
9
+ &mdash; Documentation by YARD 0.9.27
10
10
 
11
11
  </title>
12
12
 
@@ -15,7 +15,7 @@
15
15
  <link rel="stylesheet" href="../../css/common.css" type="text/css" />
16
16
 
17
17
  <script type="text/javascript">
18
- pathId = "NgrokAPI::Services::IPWhitelistClient";
18
+ pathId = "NgrokAPI::Services::AgentIngressesClient";
19
19
  relpath = '../../';
20
20
  </script>
21
21
 
@@ -36,10 +36,10 @@
36
36
  <div id="header">
37
37
  <div id="menu">
38
38
 
39
- <a href="../../_index.html">Index (I)</a> &raquo;
39
+ <a href="../../_index.html">Index (A)</a> &raquo;
40
40
  <span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Services.html" title="NgrokAPI::Services (module)">Services</a></span></span>
41
41
  &raquo;
42
- <span class="title">IPWhitelistClient</span>
42
+ <span class="title">AgentIngressesClient</span>
43
43
 
44
44
  </div>
45
45
 
@@ -59,7 +59,7 @@
59
59
  <div class="clear"></div>
60
60
  </div>
61
61
 
62
- <div id="content"><h1>Class: NgrokAPI::Services::IPWhitelistClient
62
+ <div id="content"><h1>Class: NgrokAPI::Services::AgentIngressesClient
63
63
 
64
64
 
65
65
 
@@ -74,7 +74,7 @@
74
74
  <ul class="fullTree">
75
75
  <li>Object</li>
76
76
 
77
- <li class="next">NgrokAPI::Services::IPWhitelistClient</li>
77
+ <li class="next">NgrokAPI::Services::AgentIngressesClient</li>
78
78
 
79
79
  </ul>
80
80
  <a href="#" class="inheritanceTree">show all</a>
@@ -94,7 +94,7 @@
94
94
 
95
95
  <dl>
96
96
  <dt>Defined in:</dt>
97
- <dd>lib/ngrokapi/services/ip_whitelist_client.rb</dd>
97
+ <dd>lib/ngrokapi/services/agent_ingresses_client.rb</dd>
98
98
  </dl>
99
99
 
100
100
  </div>
@@ -102,9 +102,7 @@
102
102
  <h2>Overview</h2><div class="docstring">
103
103
  <div class="discussion">
104
104
 
105
- <p>The IP Whitelist is deprecated and will be removed. Use an IP Restriction with an <code>endpoints</code> type instead.</p>
106
-
107
- <p><a href="https://ngrok.com/docs/api#api-ip-whitelist">ngrok.com/docs/api#api-ip-whitelist</a></p>
105
+ <p><a href="https://ngrok.com/docs/api#api-agent-ingresses">ngrok.com/docs/api#api-agent-ingresses</a></p>
108
106
 
109
107
 
110
108
  </div>
@@ -135,7 +133,7 @@
135
133
 
136
134
  </div>
137
135
  </dt>
138
- <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/ip_whitelist</span><span class='tstring_end'>&#39;</span></span></pre></dd>
136
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/agent_ingresses</span><span class='tstring_end'>&#39;</span></span></pre></dd>
139
137
 
140
138
  <dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
141
139
  <div class="docstring">
@@ -151,7 +149,7 @@
151
149
 
152
150
  </div>
153
151
  </dt>
154
- <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>whitelist</span><span class='tstring_end'>&#39;</span></span></pre></dd>
152
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>ingresses</span><span class='tstring_end'>&#39;</span></span></pre></dd>
155
153
 
156
154
  </dl>
157
155
 
@@ -207,7 +205,7 @@
207
205
  <li class="public ">
208
206
  <span class="summary_signature">
209
207
 
210
- <a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: &quot;&quot;, metadata: &quot;&quot;, ip_net: &quot;&quot;) &#x21d2; NgrokAPI::Models::IPWhitelistEntry </a>
208
+ <a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: &quot;&quot;, metadata: &quot;&quot;, domain:) &#x21d2; NgrokAPI::Models::AgentIngress </a>
211
209
 
212
210
 
213
211
 
@@ -222,7 +220,7 @@
222
220
 
223
221
 
224
222
  <span class="summary_desc"><div class='inline'>
225
- <p>Create a new IP whitelist entry that will restrict traffic to all tunnel endpoints on the account.</p>
223
+ <p>Create a new Agent Ingress.</p>
226
224
  </div></span>
227
225
 
228
226
  </li>
@@ -246,7 +244,7 @@
246
244
 
247
245
 
248
246
  <span class="summary_desc"><div class='inline'>
249
- <p>Delete an IP whitelist entry.</p>
247
+ <p>Delete an Agent Ingress by ID.</p>
250
248
  </div></span>
251
249
 
252
250
  </li>
@@ -270,7 +268,7 @@
270
268
 
271
269
 
272
270
  <span class="summary_desc"><div class='inline'>
273
- <p>Delete an IP whitelist entry.</p>
271
+ <p>Delete an Agent Ingress by ID Throws an exception if API error.</p>
274
272
  </div></span>
275
273
 
276
274
  </li>
@@ -279,7 +277,7 @@
279
277
  <li class="public ">
280
278
  <span class="summary_signature">
281
279
 
282
- <a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::IPWhitelistEntry </a>
280
+ <a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::AgentIngress </a>
283
281
 
284
282
 
285
283
 
@@ -294,7 +292,7 @@
294
292
 
295
293
 
296
294
  <span class="summary_desc"><div class='inline'>
297
- <p>Get detailed information about an IP whitelist entry by ID.</p>
295
+ <p>Get the details of an Agent Ingress by ID.</p>
298
296
  </div></span>
299
297
 
300
298
  </li>
@@ -303,7 +301,7 @@
303
301
  <li class="public ">
304
302
  <span class="summary_signature">
305
303
 
306
- <a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::IPWhitelistEntry </a>
304
+ <a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::AgentIngress </a>
307
305
 
308
306
 
309
307
 
@@ -318,7 +316,7 @@
318
316
 
319
317
 
320
318
  <span class="summary_desc"><div class='inline'>
321
- <p>Get detailed information about an IP whitelist entry by ID.</p>
319
+ <p>Get the details of an Agent Ingress by ID.</p>
322
320
  </div></span>
323
321
 
324
322
  </li>
@@ -327,7 +325,7 @@
327
325
  <li class="public ">
328
326
  <span class="summary_signature">
329
327
 
330
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) &#x21d2; IPWhitelistClient </a>
328
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) &#x21d2; AgentIngressesClient </a>
331
329
 
332
330
 
333
331
 
@@ -344,7 +342,7 @@
344
342
 
345
343
 
346
344
  <span class="summary_desc"><div class='inline'>
347
- <p>A new instance of IPWhitelistClient.</p>
345
+ <p>A new instance of AgentIngressesClient.</p>
348
346
  </div></span>
349
347
 
350
348
  </li>
@@ -368,7 +366,7 @@
368
366
 
369
367
 
370
368
  <span class="summary_desc"><div class='inline'>
371
- <p>List all IP whitelist entries on this account.</p>
369
+ <p>List all Agent Ingresses owned by this account.</p>
372
370
  </div></span>
373
371
 
374
372
  </li>
@@ -392,7 +390,7 @@
392
390
 
393
391
 
394
392
  <span class="summary_desc"><div class='inline'>
395
- <p>List all IP whitelist entries on this account Throws an exception if API error.</p>
393
+ <p>List all Agent Ingresses owned by this account Throws an exception if API error.</p>
396
394
  </div></span>
397
395
 
398
396
  </li>
@@ -401,7 +399,7 @@
401
399
  <li class="public ">
402
400
  <span class="summary_signature">
403
401
 
404
- <a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: &quot;&quot;, description: nil, metadata: nil) &#x21d2; NgrokAPI::Models::IPWhitelistEntry </a>
402
+ <a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: &quot;&quot;, description: nil, metadata: nil) &#x21d2; NgrokAPI::Models::AgentIngress </a>
405
403
 
406
404
 
407
405
 
@@ -416,7 +414,7 @@
416
414
 
417
415
 
418
416
  <span class="summary_desc"><div class='inline'>
419
- <p>Update attributes of an IP whitelist entry by ID.</p>
417
+ <p>Update attributes of an Agent Ingress by ID.</p>
420
418
  </div></span>
421
419
 
422
420
  </li>
@@ -425,7 +423,7 @@
425
423
  <li class="public ">
426
424
  <span class="summary_signature">
427
425
 
428
- <a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: &quot;&quot;, description: nil, metadata: nil) &#x21d2; NgrokAPI::Models::IPWhitelistEntry </a>
426
+ <a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: &quot;&quot;, description: nil, metadata: nil) &#x21d2; NgrokAPI::Models::AgentIngress </a>
429
427
 
430
428
 
431
429
 
@@ -440,7 +438,7 @@
440
438
 
441
439
 
442
440
  <span class="summary_desc"><div class='inline'>
443
- <p>Update attributes of an IP whitelist entry by ID Throws an exception if API error.</p>
441
+ <p>Update attributes of an Agent Ingress by ID.</p>
444
442
  </div></span>
445
443
 
446
444
  </li>
@@ -455,7 +453,7 @@
455
453
  <div class="method_details first">
456
454
  <h3 class="signature first" id="initialize-instance_method">
457
455
 
458
- #<strong>initialize</strong>(client:) &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Services::IPWhitelistClient (class)">IPWhitelistClient</a></span></tt>
456
+ #<strong>initialize</strong>(client:) &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Services::AgentIngressesClient (class)">AgentIngressesClient</a></span></tt>
459
457
 
460
458
 
461
459
 
@@ -464,7 +462,7 @@
464
462
  </h3><div class="docstring">
465
463
  <div class="discussion">
466
464
 
467
- <p>Returns a new instance of IPWhitelistClient.</p>
465
+ <p>Returns a new instance of AgentIngressesClient.</p>
468
466
 
469
467
 
470
468
  </div>
@@ -478,12 +476,12 @@
478
476
  <pre class="lines">
479
477
 
480
478
 
481
- 18
482
- 19
483
- 20</pre>
479
+ 15
480
+ 16
481
+ 17</pre>
484
482
  </td>
485
483
  <td>
486
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 18</span>
484
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 15</span>
487
485
 
488
486
  <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='rparen'>)</span>
489
487
  <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
@@ -526,12 +524,12 @@
526
524
  <pre class="lines">
527
525
 
528
526
 
529
- 16
530
- 17
531
- 18</pre>
527
+ 13
528
+ 14
529
+ 15</pre>
532
530
  </td>
533
531
  <td>
534
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 16</span>
532
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 13</span>
535
533
 
536
534
  <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
537
535
  <span class='ivar'>@client</span>
@@ -551,7 +549,7 @@
551
549
  <div class="method_details first">
552
550
  <h3 class="signature first" id="create-instance_method">
553
551
 
554
- #<strong>create</strong>(description: &quot;&quot;, metadata: &quot;&quot;, ip_net: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">NgrokAPI::Models::IPWhitelistEntry</a></span></tt>
552
+ #<strong>create</strong>(description: &quot;&quot;, metadata: &quot;&quot;, domain:) &#x21d2; <tt><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">NgrokAPI::Models::AgentIngress</a></span></tt>
555
553
 
556
554
 
557
555
 
@@ -560,9 +558,9 @@
560
558
  </h3><div class="docstring">
561
559
  <div class="discussion">
562
560
 
563
- <p>Create a new IP whitelist entry that will restrict traffic to all tunnel endpoints on the account.</p>
561
+ <p>Create a new Agent Ingress. The ngrok agent can be configured to connect to ngrok via the new set of addresses on the returned Agent Ingress.</p>
564
562
 
565
- <p><a href="https://ngrok.com/docs/api#api-ip-whitelist-create">ngrok.com/docs/api#api-ip-whitelist-create</a></p>
563
+ <p><a href="https://ngrok.com/docs/api#api-agent-ingresses-create">ngrok.com/docs/api#api-agent-ingresses-create</a></p>
566
564
 
567
565
 
568
566
  </div>
@@ -584,7 +582,7 @@
584
582
 
585
583
  &mdash;
586
584
  <div class='inline'>
587
- <p>human-readable description of the source IPs for this IP whitelist entry. optional, max 255 bytes.</p>
585
+ <p>human-readable description of the use of this Agent Ingress. optional, max 255 bytes.</p>
588
586
  </div>
589
587
 
590
588
  </li>
@@ -602,25 +600,23 @@
602
600
 
603
601
  &mdash;
604
602
  <div class='inline'>
605
- <p>arbitrary user-defined machine-readable data of this IP whitelist entry. optional, max 4096 bytes.</p>
603
+ <p>arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes</p>
606
604
  </div>
607
605
 
608
606
  </li>
609
607
 
610
608
  <li>
611
609
 
612
- <span class='name'>ip_net</span>
610
+ <span class='name'>domain</span>
613
611
 
614
612
 
615
613
  <span class='type'>(<tt>string</tt>)</span>
616
614
 
617
615
 
618
- <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
619
-
620
616
 
621
617
  &mdash;
622
618
  <div class='inline'>
623
- <p>an IP address or IP network range in CIDR notation (e.g. 10.1.1.1 or 10.1.0.0/16) of addresses that will be whitelisted to communicate with your tunnel endpoints</p>
619
+ <p>the domain that you own to be used as the base domain name to generate regional agent ingress domains.</p>
624
620
  </div>
625
621
 
626
622
  </li>
@@ -633,7 +629,7 @@
633
629
  <li>
634
630
 
635
631
 
636
- <span class='type'>(<tt><span class='object_link'><a href="../Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">NgrokAPI::Models::IPWhitelistEntry</a></span></tt>)</span>
632
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">NgrokAPI::Models::AgentIngress</a></span></tt>)</span>
637
633
 
638
634
 
639
635
 
@@ -652,6 +648,9 @@
652
648
  <pre class="lines">
653
649
 
654
650
 
651
+ 29
652
+ 30
653
+ 31
655
654
  32
656
655
  33
657
656
  34
@@ -659,32 +658,21 @@
659
658
  36
660
659
  37
661
660
  38
662
- 39
663
- 40
664
- 41
665
- 42
666
- 43
667
- 44
668
- 45
669
- 46</pre>
661
+ 39</pre>
670
662
  </td>
671
663
  <td>
672
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 32</span>
673
-
674
- <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span>
675
- <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
676
- <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
677
- <span class='label'>ip_net:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span>
678
- <span class='rparen'>)</span>
679
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/ip_whitelist</span><span class='tstring_end'>&#39;</span></span>
664
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 29</span>
665
+
666
+ <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>domain:</span><span class='rparen'>)</span>
667
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/agent_ingresses</span><span class='tstring_end'>&#39;</span></span>
680
668
  <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
681
669
  <span class='rbrace'>}</span>
682
670
  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
683
671
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
684
672
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
685
- <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ip_net</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ip_net'>ip_net</span> <span class='kw'>if</span> <span class='id identifier rubyid_ip_net'>ip_net</span>
673
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:domain</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_domain'>domain</span> <span class='kw'>if</span> <span class='id identifier rubyid_domain'>domain</span>
686
674
  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
687
- <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">IPWhitelistEntry</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/IPWhitelistEntry.html#initialize-instance_method" title="NgrokAPI::Models::IPWhitelistEntry#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
675
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">AgentIngress</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/AgentIngress.html#initialize-instance_method" title="NgrokAPI::Models::AgentIngress#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
688
676
  <span class='kw'>end</span></pre>
689
677
  </td>
690
678
  </tr>
@@ -703,9 +691,9 @@
703
691
  </h3><div class="docstring">
704
692
  <div class="discussion">
705
693
 
706
- <p>Delete an IP whitelist entry.</p>
694
+ <p>Delete an Agent Ingress by ID</p>
707
695
 
708
- <p><a href="https://ngrok.com/docs/api#api-ip-whitelist-delete">ngrok.com/docs/api#api-ip-whitelist-delete</a></p>
696
+ <p><a href="https://ngrok.com/docs/api#api-agent-ingresses-delete">ngrok.com/docs/api#api-agent-ingresses-delete</a></p>
709
697
 
710
698
 
711
699
  </div>
@@ -759,23 +747,19 @@
759
747
  <pre class="lines">
760
748
 
761
749
 
762
- 55
763
- 56
764
- 57
765
- 58
766
- 59
767
- 60
768
- 61
769
- 62
770
- 63</pre>
750
+ 48
751
+ 49
752
+ 50
753
+ 51
754
+ 52
755
+ 53
756
+ 54</pre>
771
757
  </td>
772
758
  <td>
773
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 55</span>
759
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 48</span>
774
760
 
775
- <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span>
776
- <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span>
777
- <span class='rparen'>)</span>
778
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/ip_whitelist/%{id}</span><span class='tstring_end'>&#39;</span></span>
761
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
762
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/agent_ingresses/%{id}</span><span class='tstring_end'>&#39;</span></span>
779
763
  <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
780
764
  <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
781
765
  <span class='rbrace'>}</span>
@@ -798,9 +782,9 @@
798
782
  </h3><div class="docstring">
799
783
  <div class="discussion">
800
784
 
801
- <p>Delete an IP whitelist entry. Throws an exception if API error.</p>
785
+ <p>Delete an Agent Ingress by ID Throws an exception if API error.</p>
802
786
 
803
- <p><a href="https://ngrok.com/docs/api#api-ip-whitelist-delete">ngrok.com/docs/api#api-ip-whitelist-delete</a></p>
787
+ <p><a href="https://ngrok.com/docs/api#api-agent-ingresses-delete">ngrok.com/docs/api#api-agent-ingresses-delete</a></p>
804
788
 
805
789
 
806
790
  </div>
@@ -854,23 +838,19 @@
854
838
  <pre class="lines">
855
839
 
856
840
 
857
- 73
858
- 74
859
- 75
860
- 76
861
- 77
862
- 78
863
- 79
864
- 80
865
- 81</pre>
841
+ 64
842
+ 65
843
+ 66
844
+ 67
845
+ 68
846
+ 69
847
+ 70</pre>
866
848
  </td>
867
849
  <td>
868
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 73</span>
850
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 64</span>
869
851
 
870
- <span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span>
871
- <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span>
872
- <span class='rparen'>)</span>
873
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/ip_whitelist/%{id}</span><span class='tstring_end'>&#39;</span></span>
852
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
853
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/agent_ingresses/%{id}</span><span class='tstring_end'>&#39;</span></span>
874
854
  <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
875
855
  <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
876
856
  <span class='rbrace'>}</span>
@@ -884,7 +864,7 @@
884
864
  <div class="method_details ">
885
865
  <h3 class="signature " id="get-instance_method">
886
866
 
887
- #<strong>get</strong>(id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">NgrokAPI::Models::IPWhitelistEntry</a></span></tt>
867
+ #<strong>get</strong>(id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">NgrokAPI::Models::AgentIngress</a></span></tt>
888
868
 
889
869
 
890
870
 
@@ -893,9 +873,9 @@
893
873
  </h3><div class="docstring">
894
874
  <div class="discussion">
895
875
 
896
- <p>Get detailed information about an IP whitelist entry by ID.</p>
876
+ <p>Get the details of an Agent Ingress by ID.</p>
897
877
 
898
- <p><a href="https://ngrok.com/docs/api#api-ip-whitelist-get">ngrok.com/docs/api#api-ip-whitelist-get</a></p>
878
+ <p><a href="https://ngrok.com/docs/api#api-agent-ingresses-get">ngrok.com/docs/api#api-agent-ingresses-get</a></p>
899
879
 
900
880
 
901
881
  </div>
@@ -930,7 +910,7 @@
930
910
  <li>
931
911
 
932
912
 
933
- <span class='type'>(<tt><span class='object_link'><a href="../Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">NgrokAPI::Models::IPWhitelistEntry</a></span></tt>)</span>
913
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">NgrokAPI::Models::AgentIngress</a></span></tt>)</span>
934
914
 
935
915
 
936
916
 
@@ -949,31 +929,27 @@
949
929
  <pre class="lines">
950
930
 
951
931
 
952
- 90
953
- 91
954
- 92
955
- 93
956
- 94
957
- 95
958
- 96
959
- 97
960
- 98
961
- 99
962
- 100</pre>
932
+ 79
933
+ 80
934
+ 81
935
+ 82
936
+ 83
937
+ 84
938
+ 85
939
+ 86
940
+ 87</pre>
963
941
  </td>
964
942
  <td>
965
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 90</span>
943
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 79</span>
966
944
 
967
- <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span>
968
- <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span>
969
- <span class='rparen'>)</span>
970
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/ip_whitelist/%{id}</span><span class='tstring_end'>&#39;</span></span>
945
+ <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
946
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/agent_ingresses/%{id}</span><span class='tstring_end'>&#39;</span></span>
971
947
  <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
972
948
  <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
973
949
  <span class='rbrace'>}</span>
974
950
  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
975
951
  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
976
- <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">IPWhitelistEntry</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/IPWhitelistEntry.html#initialize-instance_method" title="NgrokAPI::Models::IPWhitelistEntry#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
952
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">AgentIngress</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/AgentIngress.html#initialize-instance_method" title="NgrokAPI::Models::AgentIngress#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
977
953
  <span class='kw'>end</span></pre>
978
954
  </td>
979
955
  </tr>
@@ -983,7 +959,7 @@
983
959
  <div class="method_details ">
984
960
  <h3 class="signature " id="get!-instance_method">
985
961
 
986
- #<strong>get!</strong>(id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">NgrokAPI::Models::IPWhitelistEntry</a></span></tt>
962
+ #<strong>get!</strong>(id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">NgrokAPI::Models::AgentIngress</a></span></tt>
987
963
 
988
964
 
989
965
 
@@ -992,9 +968,9 @@
992
968
  </h3><div class="docstring">
993
969
  <div class="discussion">
994
970
 
995
- <p>Get detailed information about an IP whitelist entry by ID. Throws an exception if API error.</p>
971
+ <p>Get the details of an Agent Ingress by ID. Throws an exception if API error.</p>
996
972
 
997
- <p><a href="https://ngrok.com/docs/api#api-ip-whitelist-get">ngrok.com/docs/api#api-ip-whitelist-get</a></p>
973
+ <p><a href="https://ngrok.com/docs/api#api-agent-ingresses-get">ngrok.com/docs/api#api-agent-ingresses-get</a></p>
998
974
 
999
975
 
1000
976
  </div>
@@ -1029,7 +1005,7 @@
1029
1005
  <li>
1030
1006
 
1031
1007
 
1032
- <span class='type'>(<tt><span class='object_link'><a href="../Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">NgrokAPI::Models::IPWhitelistEntry</a></span></tt>)</span>
1008
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">NgrokAPI::Models::AgentIngress</a></span></tt>)</span>
1033
1009
 
1034
1010
 
1035
1011
 
@@ -1048,31 +1024,27 @@
1048
1024
  <pre class="lines">
1049
1025
 
1050
1026
 
1051
- 110
1052
- 111
1053
- 112
1054
- 113
1055
- 114
1056
- 115
1057
- 116
1058
- 117
1059
- 118
1060
- 119
1061
- 120</pre>
1027
+ 97
1028
+ 98
1029
+ 99
1030
+ 100
1031
+ 101
1032
+ 102
1033
+ 103
1034
+ 104
1035
+ 105</pre>
1062
1036
  </td>
1063
1037
  <td>
1064
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 110</span>
1038
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 97</span>
1065
1039
 
1066
- <span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span>
1067
- <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span>
1068
- <span class='rparen'>)</span>
1069
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/ip_whitelist/%{id}</span><span class='tstring_end'>&#39;</span></span>
1040
+ <span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
1041
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/agent_ingresses/%{id}</span><span class='tstring_end'>&#39;</span></span>
1070
1042
  <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1071
1043
  <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1072
1044
  <span class='rbrace'>}</span>
1073
1045
  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1074
1046
  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
1075
- <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">IPWhitelistEntry</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/IPWhitelistEntry.html#initialize-instance_method" title="NgrokAPI::Models::IPWhitelistEntry#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1047
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">AgentIngress</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/AgentIngress.html#initialize-instance_method" title="NgrokAPI::Models::AgentIngress#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1076
1048
  <span class='kw'>end</span></pre>
1077
1049
  </td>
1078
1050
  </tr>
@@ -1091,9 +1063,9 @@
1091
1063
  </h3><div class="docstring">
1092
1064
  <div class="discussion">
1093
1065
 
1094
- <p>List all IP whitelist entries on this account</p>
1066
+ <p>List all Agent Ingresses owned by this account</p>
1095
1067
 
1096
- <p><a href="https://ngrok.com/docs/api#api-ip-whitelist-list">ngrok.com/docs/api#api-ip-whitelist-list</a></p>
1068
+ <p><a href="https://ngrok.com/docs/api#api-agent-ingresses-list">ngrok.com/docs/api#api-agent-ingresses-list</a></p>
1097
1069
 
1098
1070
 
1099
1071
  </div>
@@ -1173,46 +1145,40 @@
1173
1145
  <pre class="lines">
1174
1146
 
1175
1147
 
1176
- 131
1177
- 132
1178
- 133
1179
- 134
1180
- 135
1181
- 136
1182
- 137
1183
- 138
1184
- 139
1185
- 140
1186
- 141
1187
- 142
1188
- 143
1189
- 144
1190
- 145
1191
- 146
1192
- 147
1193
- 148
1194
- 149</pre>
1148
+ 116
1149
+ 117
1150
+ 118
1151
+ 119
1152
+ 120
1153
+ 121
1154
+ 122
1155
+ 123
1156
+ 124
1157
+ 125
1158
+ 126
1159
+ 127
1160
+ 128
1161
+ 129
1162
+ 130
1163
+ 131</pre>
1195
1164
  </td>
1196
1165
  <td>
1197
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 131</span>
1166
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 116</span>
1198
1167
 
1199
- <span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
1200
- <span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1201
- <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1202
- <span class='label'>url:</span> <span class='kw'>nil</span>
1203
- <span class='rparen'>)</span>
1168
+ <span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1169
+ <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1204
1170
  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
1205
1171
  <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
1206
1172
  <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
1207
1173
  <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
1208
- <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::IPWhitelistClient::PATH (constant)">PATH</a></span></span>
1174
+ <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::AgentIngressesClient::PATH (constant)">PATH</a></span></span>
1209
1175
  <span class='rparen'>)</span>
1210
1176
 
1211
1177
  <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
1212
1178
  <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
1213
1179
  <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1214
- <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::IPWhitelistClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1215
- <span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">IPWhitelistEntry</a></span></span>
1180
+ <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::AgentIngressesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1181
+ <span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">AgentIngress</a></span></span>
1216
1182
  <span class='rparen'>)</span>
1217
1183
  <span class='kw'>end</span></pre>
1218
1184
  </td>
@@ -1232,9 +1198,9 @@
1232
1198
  </h3><div class="docstring">
1233
1199
  <div class="discussion">
1234
1200
 
1235
- <p>List all IP whitelist entries on this account Throws an exception if API error.</p>
1201
+ <p>List all Agent Ingresses owned by this account Throws an exception if API error.</p>
1236
1202
 
1237
- <p><a href="https://ngrok.com/docs/api#api-ip-whitelist-list">ngrok.com/docs/api#api-ip-whitelist-list</a></p>
1203
+ <p><a href="https://ngrok.com/docs/api#api-agent-ingresses-list">ngrok.com/docs/api#api-agent-ingresses-list</a></p>
1238
1204
 
1239
1205
 
1240
1206
  </div>
@@ -1314,49 +1280,43 @@
1314
1280
  <pre class="lines">
1315
1281
 
1316
1282
 
1317
- 161
1318
- 162
1319
- 163
1320
- 164
1321
- 165
1322
- 166
1323
- 167
1324
- 168
1325
- 169
1326
- 170
1327
- 171
1328
- 172
1329
- 173
1330
- 174
1331
- 175
1332
- 176
1333
- 177
1334
- 178
1335
- 179
1336
- 180
1337
- 181</pre>
1283
+ 143
1284
+ 144
1285
+ 145
1286
+ 146
1287
+ 147
1288
+ 148
1289
+ 149
1290
+ 150
1291
+ 151
1292
+ 152
1293
+ 153
1294
+ 154
1295
+ 155
1296
+ 156
1297
+ 157
1298
+ 158
1299
+ 159
1300
+ 160</pre>
1338
1301
  </td>
1339
1302
  <td>
1340
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 161</span>
1303
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 143</span>
1341
1304
 
1342
- <span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span>
1343
- <span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1344
- <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1345
- <span class='label'>url:</span> <span class='kw'>nil</span>
1346
- <span class='rparen'>)</span>
1305
+ <span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1306
+ <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1347
1307
  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
1348
1308
  <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
1349
1309
  <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
1350
1310
  <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
1351
1311
  <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
1352
- <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::IPWhitelistClient::PATH (constant)">PATH</a></span></span>
1312
+ <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::AgentIngressesClient::PATH (constant)">PATH</a></span></span>
1353
1313
  <span class='rparen'>)</span>
1354
1314
 
1355
1315
  <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
1356
1316
  <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
1357
1317
  <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1358
- <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::IPWhitelistClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1359
- <span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">IPWhitelistEntry</a></span></span><span class='comma'>,</span>
1318
+ <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::AgentIngressesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1319
+ <span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">AgentIngress</a></span></span><span class='comma'>,</span>
1360
1320
  <span class='label'>danger:</span> <span class='kw'>true</span>
1361
1321
  <span class='rparen'>)</span>
1362
1322
  <span class='kw'>end</span></pre>
@@ -1368,7 +1328,7 @@
1368
1328
  <div class="method_details ">
1369
1329
  <h3 class="signature " id="update-instance_method">
1370
1330
 
1371
- #<strong>update</strong>(id: &quot;&quot;, description: nil, metadata: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">NgrokAPI::Models::IPWhitelistEntry</a></span></tt>
1331
+ #<strong>update</strong>(id: &quot;&quot;, description: nil, metadata: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">NgrokAPI::Models::AgentIngress</a></span></tt>
1372
1332
 
1373
1333
 
1374
1334
 
@@ -1377,9 +1337,9 @@
1377
1337
  </h3><div class="docstring">
1378
1338
  <div class="discussion">
1379
1339
 
1380
- <p>Update attributes of an IP whitelist entry by ID</p>
1340
+ <p>Update attributes of an Agent Ingress by ID.</p>
1381
1341
 
1382
- <p><a href="https://ngrok.com/docs/api#api-ip-whitelist-update">ngrok.com/docs/api#api-ip-whitelist-update</a></p>
1342
+ <p><a href="https://ngrok.com/docs/api#api-agent-ingresses-update">ngrok.com/docs/api#api-agent-ingresses-update</a></p>
1383
1343
 
1384
1344
 
1385
1345
  </div>
@@ -1414,7 +1374,7 @@
1414
1374
 
1415
1375
  &mdash;
1416
1376
  <div class='inline'>
1417
- <p>human-readable description of the source IPs for this IP whitelist entry. optional, max 255 bytes.</p>
1377
+ <p>human-readable description of the use of this Agent Ingress. optional, max 255 bytes.</p>
1418
1378
  </div>
1419
1379
 
1420
1380
  </li>
@@ -1432,7 +1392,7 @@
1432
1392
 
1433
1393
  &mdash;
1434
1394
  <div class='inline'>
1435
- <p>arbitrary user-defined machine-readable data of this IP whitelist entry. optional, max 4096 bytes.</p>
1395
+ <p>arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes</p>
1436
1396
  </div>
1437
1397
 
1438
1398
  </li>
@@ -1445,7 +1405,7 @@
1445
1405
  <li>
1446
1406
 
1447
1407
 
1448
- <span class='type'>(<tt><span class='object_link'><a href="../Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">NgrokAPI::Models::IPWhitelistEntry</a></span></tt>)</span>
1408
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">NgrokAPI::Models::AgentIngress</a></span></tt>)</span>
1449
1409
 
1450
1410
 
1451
1411
 
@@ -1464,31 +1424,23 @@
1464
1424
  <pre class="lines">
1465
1425
 
1466
1426
 
1467
- 192
1468
- 193
1469
- 194
1470
- 195
1471
- 196
1472
- 197
1473
- 198
1474
- 199
1475
- 200
1476
- 201
1477
- 202
1478
- 203
1479
- 204
1480
- 205
1481
- 206</pre>
1427
+ 171
1428
+ 172
1429
+ 173
1430
+ 174
1431
+ 175
1432
+ 176
1433
+ 177
1434
+ 178
1435
+ 179
1436
+ 180
1437
+ 181</pre>
1482
1438
  </td>
1483
1439
  <td>
1484
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 192</span>
1485
-
1486
- <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
1487
- <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
1488
- <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1489
- <span class='label'>metadata:</span> <span class='kw'>nil</span>
1490
- <span class='rparen'>)</span>
1491
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/ip_whitelist/%{id}</span><span class='tstring_end'>&#39;</span></span>
1440
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 171</span>
1441
+
1442
+ <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1443
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/agent_ingresses/%{id}</span><span class='tstring_end'>&#39;</span></span>
1492
1444
  <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1493
1445
  <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1494
1446
  <span class='rbrace'>}</span>
@@ -1496,7 +1448,7 @@
1496
1448
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
1497
1449
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
1498
1450
  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
1499
- <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">IPWhitelistEntry</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/IPWhitelistEntry.html#initialize-instance_method" title="NgrokAPI::Models::IPWhitelistEntry#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1451
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">AgentIngress</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/AgentIngress.html#initialize-instance_method" title="NgrokAPI::Models::AgentIngress#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1500
1452
  <span class='kw'>end</span></pre>
1501
1453
  </td>
1502
1454
  </tr>
@@ -1506,7 +1458,7 @@
1506
1458
  <div class="method_details ">
1507
1459
  <h3 class="signature " id="update!-instance_method">
1508
1460
 
1509
- #<strong>update!</strong>(id: &quot;&quot;, description: nil, metadata: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">NgrokAPI::Models::IPWhitelistEntry</a></span></tt>
1461
+ #<strong>update!</strong>(id: &quot;&quot;, description: nil, metadata: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">NgrokAPI::Models::AgentIngress</a></span></tt>
1510
1462
 
1511
1463
 
1512
1464
 
@@ -1515,9 +1467,9 @@
1515
1467
  </h3><div class="docstring">
1516
1468
  <div class="discussion">
1517
1469
 
1518
- <p>Update attributes of an IP whitelist entry by ID Throws an exception if API error.</p>
1470
+ <p>Update attributes of an Agent Ingress by ID. Throws an exception if API error.</p>
1519
1471
 
1520
- <p><a href="https://ngrok.com/docs/api#api-ip-whitelist-update">ngrok.com/docs/api#api-ip-whitelist-update</a></p>
1472
+ <p><a href="https://ngrok.com/docs/api#api-agent-ingresses-update">ngrok.com/docs/api#api-agent-ingresses-update</a></p>
1521
1473
 
1522
1474
 
1523
1475
  </div>
@@ -1552,7 +1504,7 @@
1552
1504
 
1553
1505
  &mdash;
1554
1506
  <div class='inline'>
1555
- <p>human-readable description of the source IPs for this IP whitelist entry. optional, max 255 bytes.</p>
1507
+ <p>human-readable description of the use of this Agent Ingress. optional, max 255 bytes.</p>
1556
1508
  </div>
1557
1509
 
1558
1510
  </li>
@@ -1570,7 +1522,7 @@
1570
1522
 
1571
1523
  &mdash;
1572
1524
  <div class='inline'>
1573
- <p>arbitrary user-defined machine-readable data of this IP whitelist entry. optional, max 4096 bytes.</p>
1525
+ <p>arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes</p>
1574
1526
  </div>
1575
1527
 
1576
1528
  </li>
@@ -1583,7 +1535,7 @@
1583
1535
  <li>
1584
1536
 
1585
1537
 
1586
- <span class='type'>(<tt><span class='object_link'><a href="../Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">NgrokAPI::Models::IPWhitelistEntry</a></span></tt>)</span>
1538
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">NgrokAPI::Models::AgentIngress</a></span></tt>)</span>
1587
1539
 
1588
1540
 
1589
1541
 
@@ -1602,31 +1554,23 @@
1602
1554
  <pre class="lines">
1603
1555
 
1604
1556
 
1605
- 218
1606
- 219
1607
- 220
1608
- 221
1609
- 222
1610
- 223
1611
- 224
1612
- 225
1613
- 226
1614
- 227
1615
- 228
1616
- 229
1617
- 230
1618
- 231
1619
- 232</pre>
1557
+ 193
1558
+ 194
1559
+ 195
1560
+ 196
1561
+ 197
1562
+ 198
1563
+ 199
1564
+ 200
1565
+ 201
1566
+ 202
1567
+ 203</pre>
1620
1568
  </td>
1621
1569
  <td>
1622
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_whitelist_client.rb', line 218</span>
1623
-
1624
- <span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
1625
- <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span>
1626
- <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1627
- <span class='label'>metadata:</span> <span class='kw'>nil</span>
1628
- <span class='rparen'>)</span>
1629
- <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/ip_whitelist/%{id}</span><span class='tstring_end'>&#39;</span></span>
1570
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 193</span>
1571
+
1572
+ <span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1573
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/agent_ingresses/%{id}</span><span class='tstring_end'>&#39;</span></span>
1630
1574
  <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1631
1575
  <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1632
1576
  <span class='rbrace'>}</span>
@@ -1634,7 +1578,7 @@
1634
1578
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
1635
1579
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
1636
1580
  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
1637
- <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/IPWhitelistEntry.html" title="NgrokAPI::Models::IPWhitelistEntry (class)">IPWhitelistEntry</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/IPWhitelistEntry.html#initialize-instance_method" title="NgrokAPI::Models::IPWhitelistEntry#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1581
+ <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">AgentIngress</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/AgentIngress.html#initialize-instance_method" title="NgrokAPI::Models::AgentIngress#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1638
1582
  <span class='kw'>end</span></pre>
1639
1583
  </td>
1640
1584
  </tr>
@@ -1646,9 +1590,9 @@
1646
1590
  </div>
1647
1591
 
1648
1592
  <div id="footer">
1649
- Generated on Tue Oct 19 23:01:36 2021 by
1593
+ Generated on Thu Dec 2 18:48:54 2021 by
1650
1594
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1651
- 0.9.26 (ruby-3.0.1).
1595
+ 0.9.27 (ruby-3.0.1).
1652
1596
  </div>
1653
1597
 
1654
1598
  </div>