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.
- checksums.yaml +4 -4
- data/.rubocop.yml +1 -1
- data/doc/NgrokAPI/Client.html +140 -172
- data/doc/NgrokAPI/Error.html +3 -3
- data/doc/NgrokAPI/Errors/NotFoundError.html +3 -3
- data/doc/NgrokAPI/Errors.html +3 -3
- data/doc/NgrokAPI/HttpClient.html +30 -36
- data/doc/NgrokAPI/Models/APIKey.html +3 -3
- data/doc/NgrokAPI/Models/AWSAuth.html +3 -3
- data/doc/NgrokAPI/Models/AWSCredentials.html +3 -3
- data/doc/NgrokAPI/Models/AWSRole.html +3 -3
- data/doc/NgrokAPI/Models/AbuseReport.html +3 -3
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +3 -3
- data/doc/NgrokAPI/Models/{IPWhitelistEntry.html → AgentIngress.html} +216 -68
- data/doc/NgrokAPI/Models/CertificateAuthority.html +3 -3
- data/doc/NgrokAPI/Models/Credential.html +3 -3
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +3 -3
- data/doc/NgrokAPI/Models/EndpointCompression.html +3 -3
- data/doc/NgrokAPI/Models/EndpointConfiguration.html +3 -3
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +3 -3
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +3 -3
- data/doc/NgrokAPI/Models/EndpointLogging.html +3 -3
- data/doc/NgrokAPI/Models/EndpointLoggingMutate.html +3 -3
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +3 -3
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuth.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOIDC.html +3 -3
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +3 -3
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +3 -3
- data/doc/NgrokAPI/Models/EndpointSAML.html +3 -3
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +3 -3
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +3 -3
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +3 -3
- data/doc/NgrokAPI/Models/EventDestination.html +3 -3
- data/doc/NgrokAPI/Models/EventSource.html +3 -3
- data/doc/NgrokAPI/Models/EventSourceList.html +3 -3
- data/doc/NgrokAPI/Models/EventSourceReplace.html +3 -3
- data/doc/NgrokAPI/Models/EventStream.html +3 -3
- data/doc/NgrokAPI/Models/EventSubscription.html +3 -3
- data/doc/NgrokAPI/Models/EventTarget.html +3 -3
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +3 -3
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +3 -3
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +3 -3
- data/doc/NgrokAPI/Models/IPPolicy.html +3 -3
- data/doc/NgrokAPI/Models/IPPolicyRule.html +3 -3
- data/doc/NgrokAPI/Models/IPRestriction.html +3 -3
- data/doc/NgrokAPI/Models/Listable.html +3 -3
- data/doc/NgrokAPI/Models/Ref.html +3 -3
- data/doc/NgrokAPI/Models/ReservedAddr.html +3 -3
- data/doc/NgrokAPI/Models/ReservedDomain.html +3 -3
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +3 -3
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +3 -3
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +3 -3
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +3 -3
- data/doc/NgrokAPI/Models/SSHCredential.html +3 -3
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +3 -3
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +3 -3
- data/doc/NgrokAPI/Models/TLSCertificate.html +3 -3
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +3 -3
- data/doc/NgrokAPI/Models/Tunnel.html +3 -3
- data/doc/NgrokAPI/Models/TunnelSession.html +3 -3
- data/doc/NgrokAPI/Models.html +5 -5
- data/doc/NgrokAPI/PagedIterator.html +3 -3
- data/doc/NgrokAPI/Services/APIKeysClient.html +99 -149
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +19 -33
- data/doc/NgrokAPI/Services/{IPWhitelistClient.html → AgentIngressesClient.html} +209 -265
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +104 -156
- data/doc/NgrokAPI/Services/CredentialsClient.html +108 -164
- data/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +49 -77
- data/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html +49 -77
- data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +137 -273
- data/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +49 -77
- data/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html +49 -77
- data/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +49 -77
- data/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html +49 -77
- data/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html +49 -77
- data/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +49 -77
- data/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +49 -77
- data/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html +49 -77
- data/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +49 -77
- data/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +49 -77
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +116 -184
- data/doc/NgrokAPI/Services/EventSourcesClient.html +95 -157
- data/doc/NgrokAPI/Services/EventStreamsClient.html +119 -189
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +113 -175
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +104 -156
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +111 -169
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +116 -180
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +132 -198
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +193 -303
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +110 -166
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +111 -169
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +111 -171
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +111 -175
- data/doc/NgrokAPI/Services/TLSCertificatesClient.html +107 -161
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +87 -135
- data/doc/NgrokAPI/Services/TunnelsClient.html +13 -25
- data/doc/NgrokAPI/Services.html +5 -5
- data/doc/NgrokAPI.html +4 -4
- data/doc/_index.html +18 -18
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +3 -3
- data/doc/frames.html +1 -1
- data/doc/index.html +3 -3
- data/doc/method_list.html +574 -558
- data/doc/top-level-namespace.html +3 -3
- data/docs/NgrokAPI/Client.html +140 -172
- data/docs/NgrokAPI/Error.html +3 -3
- data/docs/NgrokAPI/Errors/NotFoundError.html +3 -3
- data/docs/NgrokAPI/Errors.html +3 -3
- data/docs/NgrokAPI/HttpClient.html +30 -36
- data/docs/NgrokAPI/Models/APIKey.html +3 -3
- data/docs/NgrokAPI/Models/AWSAuth.html +3 -3
- data/docs/NgrokAPI/Models/AWSCredentials.html +3 -3
- data/docs/NgrokAPI/Models/AWSRole.html +3 -3
- data/docs/NgrokAPI/Models/AbuseReport.html +3 -3
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +3 -3
- data/docs/NgrokAPI/Models/{IPWhitelistEntry.html → AgentIngress.html} +216 -68
- data/docs/NgrokAPI/Models/CertificateAuthority.html +3 -3
- data/docs/NgrokAPI/Models/Credential.html +3 -3
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +3 -3
- data/docs/NgrokAPI/Models/EndpointCompression.html +3 -3
- data/docs/NgrokAPI/Models/EndpointConfiguration.html +3 -3
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +3 -3
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +3 -3
- data/docs/NgrokAPI/Models/EndpointLogging.html +3 -3
- data/docs/NgrokAPI/Models/EndpointLoggingMutate.html +3 -3
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +3 -3
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuth.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOIDC.html +3 -3
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +3 -3
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +3 -3
- data/docs/NgrokAPI/Models/EndpointSAML.html +3 -3
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +3 -3
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +3 -3
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +3 -3
- data/docs/NgrokAPI/Models/EventDestination.html +3 -3
- data/docs/NgrokAPI/Models/EventSource.html +3 -3
- data/docs/NgrokAPI/Models/EventSourceList.html +3 -3
- data/docs/NgrokAPI/Models/EventSourceReplace.html +3 -3
- data/docs/NgrokAPI/Models/EventStream.html +3 -3
- data/docs/NgrokAPI/Models/EventSubscription.html +3 -3
- data/docs/NgrokAPI/Models/EventTarget.html +3 -3
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +3 -3
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +3 -3
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +3 -3
- data/docs/NgrokAPI/Models/IPPolicy.html +3 -3
- data/docs/NgrokAPI/Models/IPPolicyRule.html +3 -3
- data/docs/NgrokAPI/Models/IPRestriction.html +3 -3
- data/docs/NgrokAPI/Models/Listable.html +3 -3
- data/docs/NgrokAPI/Models/Ref.html +3 -3
- data/docs/NgrokAPI/Models/ReservedAddr.html +3 -3
- data/docs/NgrokAPI/Models/ReservedDomain.html +3 -3
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +3 -3
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +3 -3
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +3 -3
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +3 -3
- data/docs/NgrokAPI/Models/SSHCredential.html +3 -3
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +3 -3
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +3 -3
- data/docs/NgrokAPI/Models/TLSCertificate.html +3 -3
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +3 -3
- data/docs/NgrokAPI/Models/Tunnel.html +3 -3
- data/docs/NgrokAPI/Models/TunnelSession.html +3 -3
- data/docs/NgrokAPI/Models.html +5 -5
- data/docs/NgrokAPI/PagedIterator.html +3 -3
- data/docs/NgrokAPI/Services/APIKeysClient.html +99 -149
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +19 -33
- data/docs/NgrokAPI/Services/{IPWhitelistClient.html → AgentIngressesClient.html} +209 -265
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +104 -156
- data/docs/NgrokAPI/Services/CredentialsClient.html +108 -164
- data/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +49 -77
- data/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html +49 -77
- data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +137 -273
- data/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +49 -77
- data/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html +49 -77
- data/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +49 -77
- data/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html +49 -77
- data/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html +49 -77
- data/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +49 -77
- data/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +49 -77
- data/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html +49 -77
- data/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +49 -77
- data/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +49 -77
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +116 -184
- data/docs/NgrokAPI/Services/EventSourcesClient.html +95 -157
- data/docs/NgrokAPI/Services/EventStreamsClient.html +119 -189
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +113 -175
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +104 -156
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +111 -169
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +116 -180
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +132 -198
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +193 -303
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +110 -166
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +111 -169
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +111 -171
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +111 -175
- data/docs/NgrokAPI/Services/TLSCertificatesClient.html +107 -161
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +87 -135
- data/docs/NgrokAPI/Services/TunnelsClient.html +13 -25
- data/docs/NgrokAPI/Services.html +5 -5
- data/docs/NgrokAPI.html +4 -4
- data/docs/_index.html +18 -18
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +3 -3
- data/docs/frames.html +1 -1
- data/docs/index.html +3 -3
- data/docs/method_list.html +574 -558
- data/docs/top-level-namespace.html +3 -3
- data/lib/ngrokapi/client.rb +5 -13
- data/lib/ngrokapi/http_client.rb +1 -4
- data/lib/ngrokapi/models/{ip_whitelist_entry.rb → agent_ingress.rb} +13 -9
- data/lib/ngrokapi/services/abuse_reports_client.rb +3 -10
- data/lib/ngrokapi/services/{ip_whitelist_client.rb → agent_ingresses_client.rb} +65 -94
- data/lib/ngrokapi/services/api_keys_client.rb +11 -36
- data/lib/ngrokapi/services/certificate_authorities_client.rb +11 -37
- data/lib/ngrokapi/services/credentials_client.rb +11 -39
- data/lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb +6 -20
- data/lib/ngrokapi/services/endpoint_compression_module_client.rb +6 -20
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +11 -79
- data/lib/ngrokapi/services/endpoint_ip_policy_module_client.rb +6 -20
- data/lib/ngrokapi/services/endpoint_logging_module_client.rb +6 -20
- data/lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb +6 -20
- data/lib/ngrokapi/services/endpoint_o_auth_module_client.rb +6 -20
- data/lib/ngrokapi/services/endpoint_oidc_module_client.rb +6 -20
- data/lib/ngrokapi/services/endpoint_request_headers_module_client.rb +6 -20
- data/lib/ngrokapi/services/endpoint_response_headers_module_client.rb +6 -20
- data/lib/ngrokapi/services/endpoint_saml_module_client.rb +6 -20
- data/lib/ngrokapi/services/endpoint_tls_termination_module_client.rb +6 -20
- data/lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb +6 -20
- data/lib/ngrokapi/services/event_destinations_client.rb +11 -45
- data/lib/ngrokapi/services/event_sources_client.rb +9 -40
- data/lib/ngrokapi/services/event_streams_client.rb +11 -46
- data/lib/ngrokapi/services/event_subscriptions_client.rb +11 -42
- data/lib/ngrokapi/services/ip_policies_client.rb +11 -37
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +11 -40
- data/lib/ngrokapi/services/ip_restrictions_client.rb +11 -43
- data/lib/ngrokapi/services/reserved_addrs_client.rb +13 -46
- data/lib/ngrokapi/services/reserved_domains_client.rb +19 -74
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +11 -39
- data/lib/ngrokapi/services/ssh_credentials_client.rb +11 -40
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +11 -41
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +11 -43
- data/lib/ngrokapi/services/tls_certificates_client.rb +11 -38
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +12 -36
- data/lib/ngrokapi/services/tunnels_client.rb +4 -10
- data/lib/ngrokapi/version.rb +1 -1
- data/lib/ngrokapi.rb +1 -1
- data/ngrok-api.gemspec +1 -1
- data/spec/ngrokapi/client_spec.rb +6 -6
- data/spec/ngrokapi/models/agent_ingress_spec.rb +42 -0
- data/spec/ngrokapi/services/{ip_whitelist_client_spec.rb → agent_ingresses_client_spec.rb} +49 -49
- data/spec/spec_helper.rb +1096 -1045
- metadata +10 -10
- 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::
|
|
7
|
+
Class: NgrokAPI::Services::AgentIngressesClient
|
|
8
8
|
|
|
9
|
-
— Documentation by YARD 0.9.
|
|
9
|
+
— 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::
|
|
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 (
|
|
39
|
+
<a href="../../_index.html">Index (A)</a> »
|
|
40
40
|
<span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> » <span class='title'><span class='object_link'><a href="../Services.html" title="NgrokAPI::Services (module)">Services</a></span></span>
|
|
41
41
|
»
|
|
42
|
-
<span class="title">
|
|
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::
|
|
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::
|
|
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/
|
|
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
|
|
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'>'</span><span class='tstring_content'>/
|
|
136
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/agent_ingresses</span><span class='tstring_end'>'</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'>'</span><span class='tstring_content'>
|
|
152
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ingresses</span><span class='tstring_end'>'</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: "", metadata: "",
|
|
208
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: "", metadata: "", domain:) ⇒ 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
|
|
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
|
|
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
|
|
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: "") ⇒ NgrokAPI::Models::
|
|
280
|
+
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: "") ⇒ 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
|
|
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: "") ⇒ NgrokAPI::Models::
|
|
304
|
+
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: "") ⇒ 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
|
|
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:) ⇒
|
|
328
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒ 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
|
|
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
|
|
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
|
|
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: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::
|
|
402
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", description: nil, metadata: nil) ⇒ 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
|
|
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: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::
|
|
426
|
+
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: "", description: nil, metadata: nil) ⇒ 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
|
|
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:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::
|
|
456
|
+
#<strong>initialize</strong>(client:) ⇒ <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
|
|
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
|
-
|
|
482
|
-
|
|
483
|
-
|
|
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/
|
|
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
|
-
|
|
530
|
-
|
|
531
|
-
|
|
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/
|
|
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: "", metadata: "",
|
|
552
|
+
#<strong>create</strong>(description: "", metadata: "", domain:) ⇒ <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
|
|
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-
|
|
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
|
—
|
|
586
584
|
<div class='inline'>
|
|
587
|
-
<p>human-readable description of the
|
|
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
|
—
|
|
604
602
|
<div class='inline'>
|
|
605
|
-
<p>arbitrary user-defined machine-readable data of this
|
|
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'>
|
|
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>""</tt>)</em>
|
|
619
|
-
|
|
620
616
|
|
|
621
617
|
—
|
|
622
618
|
<div class='inline'>
|
|
623
|
-
<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/
|
|
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/
|
|
673
|
-
|
|
674
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span>
|
|
675
|
-
<span class='
|
|
676
|
-
<span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
677
|
-
<span class='label'>ip_net:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</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'>'</span><span class='tstring_content'>/ip_whitelist</span><span class='tstring_end'>'</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'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</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'>'</span><span class='tstring_content'>/agent_ingresses</span><span class='tstring_end'>'</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'>:
|
|
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/
|
|
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
|
|
694
|
+
<p>Delete an Agent Ingress by ID</p>
|
|
707
695
|
|
|
708
|
-
<p><a href="https://ngrok.com/docs/api#api-
|
|
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
|
-
|
|
763
|
-
|
|
764
|
-
|
|
765
|
-
|
|
766
|
-
|
|
767
|
-
|
|
768
|
-
|
|
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/
|
|
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='
|
|
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'>'</span><span class='tstring_content'>/ip_whitelist/%{id}</span><span class='tstring_end'>'</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'>"</span><span class='tstring_end'>"</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'>'</span><span class='tstring_content'>/agent_ingresses/%{id}</span><span class='tstring_end'>'</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
|
|
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-
|
|
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
|
-
|
|
858
|
-
|
|
859
|
-
|
|
860
|
-
|
|
861
|
-
|
|
862
|
-
|
|
863
|
-
|
|
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/
|
|
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='
|
|
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'>'</span><span class='tstring_content'>/ip_whitelist/%{id}</span><span class='tstring_end'>'</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'>"</span><span class='tstring_end'>"</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'>'</span><span class='tstring_content'>/agent_ingresses/%{id}</span><span class='tstring_end'>'</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: "") ⇒ <tt><span class='object_link'><a href="../Models/
|
|
867
|
+
#<strong>get</strong>(id: "") ⇒ <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
|
|
876
|
+
<p>Get the details of an Agent Ingress by ID.</p>
|
|
897
877
|
|
|
898
|
-
<p><a href="https://ngrok.com/docs/api#api-
|
|
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/
|
|
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
|
-
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
|
|
959
|
-
|
|
960
|
-
|
|
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/
|
|
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='
|
|
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'>'</span><span class='tstring_content'>/ip_whitelist/%{id}</span><span class='tstring_end'>'</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'>"</span><span class='tstring_end'>"</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'>'</span><span class='tstring_content'>/agent_ingresses/%{id}</span><span class='tstring_end'>'</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/
|
|
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: "") ⇒ <tt><span class='object_link'><a href="../Models/
|
|
962
|
+
#<strong>get!</strong>(id: "") ⇒ <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
|
|
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-
|
|
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/
|
|
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
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
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/
|
|
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='
|
|
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'>'</span><span class='tstring_content'>/ip_whitelist/%{id}</span><span class='tstring_end'>'</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'>"</span><span class='tstring_end'>"</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'>'</span><span class='tstring_content'>/agent_ingresses/%{id}</span><span class='tstring_end'>'</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/
|
|
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
|
|
1066
|
+
<p>List all Agent Ingresses owned by this account</p>
|
|
1095
1067
|
|
|
1096
|
-
<p><a href="https://ngrok.com/docs/api#api-
|
|
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
|
-
|
|
1177
|
-
|
|
1178
|
-
|
|
1179
|
-
|
|
1180
|
-
|
|
1181
|
-
|
|
1182
|
-
|
|
1183
|
-
|
|
1184
|
-
|
|
1185
|
-
|
|
1186
|
-
|
|
1187
|
-
|
|
1188
|
-
|
|
1189
|
-
|
|
1190
|
-
|
|
1191
|
-
|
|
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/
|
|
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
|
-
|
|
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::
|
|
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::
|
|
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/
|
|
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
|
|
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-
|
|
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
|
-
|
|
1318
|
-
|
|
1319
|
-
|
|
1320
|
-
|
|
1321
|
-
|
|
1322
|
-
|
|
1323
|
-
|
|
1324
|
-
|
|
1325
|
-
|
|
1326
|
-
|
|
1327
|
-
|
|
1328
|
-
|
|
1329
|
-
|
|
1330
|
-
|
|
1331
|
-
|
|
1332
|
-
|
|
1333
|
-
|
|
1334
|
-
|
|
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/
|
|
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
|
-
|
|
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::
|
|
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::
|
|
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/
|
|
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: "", description: nil, metadata: nil) ⇒ <tt><span class='object_link'><a href="../Models/
|
|
1331
|
+
#<strong>update</strong>(id: "", description: nil, metadata: nil) ⇒ <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
|
|
1340
|
+
<p>Update attributes of an Agent Ingress by ID.</p>
|
|
1381
1341
|
|
|
1382
|
-
<p><a href="https://ngrok.com/docs/api#api-
|
|
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
|
—
|
|
1416
1376
|
<div class='inline'>
|
|
1417
|
-
<p>human-readable description of the
|
|
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
|
—
|
|
1434
1394
|
<div class='inline'>
|
|
1435
|
-
<p>arbitrary user-defined machine-readable data of this
|
|
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/
|
|
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
|
-
|
|
1468
|
-
|
|
1469
|
-
|
|
1470
|
-
|
|
1471
|
-
|
|
1472
|
-
|
|
1473
|
-
|
|
1474
|
-
|
|
1475
|
-
|
|
1476
|
-
|
|
1477
|
-
|
|
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/
|
|
1485
|
-
|
|
1486
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
|
|
1487
|
-
<span class='
|
|
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'>'</span><span class='tstring_content'>/ip_whitelist/%{id}</span><span class='tstring_end'>'</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'>"</span><span class='tstring_end'>"</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'>'</span><span class='tstring_content'>/agent_ingresses/%{id}</span><span class='tstring_end'>'</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/
|
|
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: "", description: nil, metadata: nil) ⇒ <tt><span class='object_link'><a href="../Models/
|
|
1461
|
+
#<strong>update!</strong>(id: "", description: nil, metadata: nil) ⇒ <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
|
|
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-
|
|
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
|
—
|
|
1554
1506
|
<div class='inline'>
|
|
1555
|
-
<p>human-readable description of the
|
|
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
|
—
|
|
1572
1524
|
<div class='inline'>
|
|
1573
|
-
<p>arbitrary user-defined machine-readable data of this
|
|
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/
|
|
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
|
-
|
|
1606
|
-
|
|
1607
|
-
|
|
1608
|
-
|
|
1609
|
-
|
|
1610
|
-
|
|
1611
|
-
|
|
1612
|
-
|
|
1613
|
-
|
|
1614
|
-
|
|
1615
|
-
|
|
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/
|
|
1623
|
-
|
|
1624
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
|
|
1625
|
-
<span class='
|
|
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'>'</span><span class='tstring_content'>/ip_whitelist/%{id}</span><span class='tstring_end'>'</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'>"</span><span class='tstring_end'>"</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'>'</span><span class='tstring_content'>/agent_ingresses/%{id}</span><span class='tstring_end'>'</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/
|
|
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
|
|
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.
|
|
1595
|
+
0.9.27 (ruby-3.0.1).
|
|
1652
1596
|
</div>
|
|
1653
1597
|
|
|
1654
1598
|
</div>
|