ngrok-api 0.12.0 → 0.14.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.yardopts +1 -0
- data/LICENSE +7 -0
- data/doc/NgrokAPI/Client.html +184 -182
- data/doc/NgrokAPI/Error.html +1 -1
- data/doc/NgrokAPI/Errors/NotFoundError.html +1 -1
- data/doc/NgrokAPI/Errors.html +1 -1
- data/doc/NgrokAPI/HttpClient.html +55 -19
- data/doc/NgrokAPI/Models/APIKey.html +1 -1
- data/doc/NgrokAPI/Models/AWSAuth.html +1 -1
- data/doc/NgrokAPI/Models/AWSCredentials.html +1 -1
- data/doc/NgrokAPI/Models/AWSRole.html +1 -1
- data/doc/NgrokAPI/Models/AbuseReport.html +1 -1
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +1 -1
- data/doc/NgrokAPI/Models/CertificateAuthority.html +1 -1
- data/doc/NgrokAPI/Models/Credential.html +1 -1
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +1 -1
- data/doc/NgrokAPI/Models/EndpointCompression.html +1 -1
- data/doc/NgrokAPI/Models/EndpointConfiguration.html +1 -1
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +1 -1
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +1 -1
- data/doc/NgrokAPI/Models/EndpointLogging.html +1 -1
- data/doc/NgrokAPI/Models/EndpointLoggingMutate.html +1 -1
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +1 -1
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOAuth.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +1 -1
- data/doc/NgrokAPI/Models/EndpointOIDC.html +1 -1
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +1 -1
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +1 -1
- data/doc/NgrokAPI/Models/EndpointSAML.html +1 -1
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +1 -1
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +1 -1
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +1 -1
- data/doc/NgrokAPI/Models/EventDestination.html +1 -1
- data/doc/NgrokAPI/Models/EventSource.html +1 -1
- data/doc/NgrokAPI/Models/{ReservedDomainCertNSTarget.html → EventSourceList.html} +42 -42
- data/doc/NgrokAPI/Models/EventSourceReplace.html +1 -1
- data/doc/NgrokAPI/Models/EventStream.html +1 -1
- data/doc/NgrokAPI/Models/EventSubscription.html +1 -1
- data/doc/NgrokAPI/Models/EventTarget.html +1 -1
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +1 -1
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +1 -1
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +1 -1
- data/doc/NgrokAPI/Models/IPPolicy.html +1 -1
- data/doc/NgrokAPI/Models/IPPolicyRule.html +1 -1
- data/doc/NgrokAPI/Models/IPRestriction.html +1 -1
- data/doc/NgrokAPI/Models/IPWhitelistEntry.html +1 -1
- data/doc/NgrokAPI/Models/Listable.html +118 -50
- data/doc/NgrokAPI/Models/Ref.html +1 -1
- data/doc/NgrokAPI/Models/ReservedAddr.html +1 -1
- data/doc/NgrokAPI/Models/ReservedDomain.html +91 -17
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +12 -86
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +1 -1
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +1 -1
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +1 -1
- data/doc/NgrokAPI/Models/SSHCredential.html +1 -1
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +1 -1
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +1 -1
- data/doc/NgrokAPI/Models/TLSCertificate.html +1 -1
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +1 -1
- data/doc/NgrokAPI/Models/Tunnel.html +1 -1
- data/doc/NgrokAPI/Models/TunnelSession.html +1 -1
- data/doc/NgrokAPI/Models.html +3 -3
- data/doc/NgrokAPI/PagedIterator.html +14 -10
- data/doc/NgrokAPI/Services/APIKeysClient.html +227 -62
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +2 -5
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +206 -41
- data/doc/NgrokAPI/Services/CredentialsClient.html +213 -47
- data/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +281 -114
- data/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1 -1
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +221 -50
- data/doc/NgrokAPI/Services/EventSourcesClient.html +279 -33
- data/doc/NgrokAPI/Services/EventStreamsClient.html +218 -47
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +213 -42
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +207 -41
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +210 -42
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +215 -51
- data/doc/NgrokAPI/Services/IPWhitelistClient.html +206 -38
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +230 -63
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +308 -142
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +208 -40
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +213 -45
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +207 -40
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +209 -42
- data/doc/NgrokAPI/Services/TLSCertificatesClient.html +208 -43
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +260 -93
- data/doc/NgrokAPI/Services/TunnelsClient.html +174 -6
- data/doc/NgrokAPI/Services.html +1 -1
- data/doc/NgrokAPI.html +2 -2
- data/doc/README +94 -0
- data/doc/_index.html +8 -8
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +53 -26
- data/doc/index.html +53 -26
- data/doc/method_list.html +822 -630
- data/doc/top-level-namespace.html +1 -1
- data/docs/NgrokAPI/Client.html +184 -182
- data/docs/NgrokAPI/Error.html +1 -1
- data/docs/NgrokAPI/Errors/NotFoundError.html +1 -1
- data/docs/NgrokAPI/Errors.html +1 -1
- data/docs/NgrokAPI/HttpClient.html +55 -19
- data/docs/NgrokAPI/Models/APIKey.html +1 -1
- data/docs/NgrokAPI/Models/AWSAuth.html +1 -1
- data/docs/NgrokAPI/Models/AWSCredentials.html +1 -1
- data/docs/NgrokAPI/Models/AWSRole.html +1 -1
- data/docs/NgrokAPI/Models/AbuseReport.html +1 -1
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +1 -1
- data/docs/NgrokAPI/Models/CertificateAuthority.html +1 -1
- data/docs/NgrokAPI/Models/Credential.html +1 -1
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +1 -1
- data/docs/NgrokAPI/Models/EndpointCompression.html +1 -1
- data/docs/NgrokAPI/Models/EndpointConfiguration.html +1 -1
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +1 -1
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +1 -1
- data/docs/NgrokAPI/Models/EndpointLogging.html +1 -1
- data/docs/NgrokAPI/Models/EndpointLoggingMutate.html +1 -1
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +1 -1
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOAuth.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +1 -1
- data/docs/NgrokAPI/Models/EndpointOIDC.html +1 -1
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +1 -1
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +1 -1
- data/docs/NgrokAPI/Models/EndpointSAML.html +1 -1
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +1 -1
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +1 -1
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +1 -1
- data/docs/NgrokAPI/Models/EventDestination.html +1 -1
- data/docs/NgrokAPI/Models/EventSource.html +1 -1
- data/docs/NgrokAPI/Models/{ReservedDomainCertNSTarget.html → EventSourceList.html} +42 -42
- data/docs/NgrokAPI/Models/EventSourceReplace.html +1 -1
- data/docs/NgrokAPI/Models/EventStream.html +1 -1
- data/docs/NgrokAPI/Models/EventSubscription.html +1 -1
- data/docs/NgrokAPI/Models/EventTarget.html +1 -1
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +1 -1
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +1 -1
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +1 -1
- data/docs/NgrokAPI/Models/IPPolicy.html +1 -1
- data/docs/NgrokAPI/Models/IPPolicyRule.html +1 -1
- data/docs/NgrokAPI/Models/IPRestriction.html +1 -1
- data/docs/NgrokAPI/Models/IPWhitelistEntry.html +1 -1
- data/docs/NgrokAPI/Models/Listable.html +118 -50
- data/docs/NgrokAPI/Models/Ref.html +1 -1
- data/docs/NgrokAPI/Models/ReservedAddr.html +1 -1
- data/docs/NgrokAPI/Models/ReservedDomain.html +91 -17
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +12 -86
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +1 -1
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +1 -1
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +1 -1
- data/docs/NgrokAPI/Models/SSHCredential.html +1 -1
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +1 -1
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +1 -1
- data/docs/NgrokAPI/Models/TLSCertificate.html +1 -1
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +1 -1
- data/docs/NgrokAPI/Models/Tunnel.html +1 -1
- data/docs/NgrokAPI/Models/TunnelSession.html +1 -1
- data/docs/NgrokAPI/Models.html +3 -3
- data/docs/NgrokAPI/PagedIterator.html +14 -10
- data/docs/NgrokAPI/Services/APIKeysClient.html +227 -62
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +2 -5
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +206 -41
- data/docs/NgrokAPI/Services/CredentialsClient.html +213 -47
- data/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +281 -114
- data/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1 -1
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +221 -50
- data/docs/NgrokAPI/Services/EventSourcesClient.html +279 -33
- data/docs/NgrokAPI/Services/EventStreamsClient.html +218 -47
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +213 -42
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +207 -41
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +210 -42
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +215 -51
- data/docs/NgrokAPI/Services/IPWhitelistClient.html +206 -38
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +230 -63
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +308 -142
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +208 -40
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +213 -45
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +207 -40
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +209 -42
- data/docs/NgrokAPI/Services/TLSCertificatesClient.html +208 -43
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +260 -93
- data/docs/NgrokAPI/Services/TunnelsClient.html +174 -6
- data/docs/NgrokAPI/Services.html +1 -1
- data/docs/NgrokAPI.html +2 -2
- data/docs/README +94 -0
- data/docs/_index.html +8 -8
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +53 -26
- data/docs/index.html +53 -26
- data/docs/method_list.html +822 -630
- data/docs/top-level-namespace.html +1 -1
- data/lib/ngrokapi/client.rb +27 -8
- data/lib/ngrokapi/http_client.rb +5 -3
- data/lib/ngrokapi/models/{reserved_domain_cert_ns_target.rb → event_source_list.rb} +5 -5
- data/lib/ngrokapi/models/listable.rb +13 -2
- data/lib/ngrokapi/models/reserved_domain.rb +3 -1
- data/lib/ngrokapi/models/reserved_domain_cert_job.rb +1 -3
- data/lib/ngrokapi/paged_iterator.rb +4 -2
- data/lib/ngrokapi/services/api_keys_client.rb +36 -4
- data/lib/ngrokapi/services/certificate_authorities_client.rb +33 -0
- data/lib/ngrokapi/services/credentials_client.rb +35 -2
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +33 -0
- data/lib/ngrokapi/services/event_destinations_client.rb +33 -0
- data/lib/ngrokapi/services/event_sources_client.rb +39 -0
- data/lib/ngrokapi/services/event_streams_client.rb +33 -0
- data/lib/ngrokapi/services/event_subscriptions_client.rb +33 -0
- data/lib/ngrokapi/services/ip_policies_client.rb +34 -1
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +33 -0
- data/lib/ngrokapi/services/ip_restrictions_client.rb +33 -0
- data/lib/ngrokapi/services/ip_whitelist_client.rb +34 -1
- data/lib/ngrokapi/services/reserved_addrs_client.rb +33 -0
- data/lib/ngrokapi/services/reserved_domains_client.rb +33 -0
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +33 -0
- data/lib/ngrokapi/services/ssh_credentials_client.rb +33 -0
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +33 -0
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +33 -0
- data/lib/ngrokapi/services/tls_certificates_client.rb +33 -0
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +33 -0
- data/lib/ngrokapi/services/tunnels_client.rb +33 -0
- data/lib/ngrokapi/version.rb +1 -1
- data/spec/ngrokapi/client_spec.rb +19 -0
- data/spec/ngrokapi/models/event_source_list_spec.rb +21 -0
- data/spec/ngrokapi/paged_iterator_spec.rb +2 -2
- data/spec/ngrokapi/services/abuse_reports_client_spec.rb +0 -2
- data/spec/ngrokapi/services/api_keys_client_spec.rb +0 -3
- data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +0 -3
- data/spec/ngrokapi/services/credentials_client_spec.rb +0 -3
- data/spec/ngrokapi/services/endpoint_circuit_breaker_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_compression_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +0 -3
- data/spec/ngrokapi/services/endpoint_ip_policy_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_mutual_tls_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_o_auth_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_oidc_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_request_headers_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_response_headers_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_saml_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_tls_termination_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/endpoint_webhook_validation_module_client_spec.rb +0 -2
- data/spec/ngrokapi/services/event_destinations_client_spec.rb +0 -3
- data/spec/ngrokapi/services/event_sources_client_spec.rb +33 -3
- data/spec/ngrokapi/services/event_streams_client_spec.rb +0 -3
- data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ip_whitelist_client_spec.rb +0 -3
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +0 -3
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +0 -3
- data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +0 -3
- data/spec/ngrokapi/services/tls_certificates_client_spec.rb +0 -3
- data/spec/ngrokapi/services/tunnel_sessions_client_spec.rb +0 -1
- data/spec/spec_helper.rb +7 -0
- metadata +10 -7
- data/doc/.gitkeep +0 -0
- data/spec/ngrokapi/models/reserved_domain_cert_ns_target_spec.rb +0 -21
|
@@ -102,11 +102,7 @@
|
|
|
102
102
|
<h2>Overview</h2><div class="docstring">
|
|
103
103
|
<div class="discussion">
|
|
104
104
|
|
|
105
|
-
<p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel
|
|
106
|
-
|
|
107
|
-
<pre class="code ruby"><code class="ruby">sessions that are running and connected to the ngrok service. Each tunnel
|
|
108
|
-
session can include one or more Tunnels.
|
|
109
|
-
</code></pre>
|
|
105
|
+
<p>Tunnel Sessions represent instances of ngrok agents or SSH reverse tunnel sessions that are running and connected to the ngrok service. Each tunnel session can include one or more Tunnels.</p>
|
|
110
106
|
|
|
111
107
|
<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions">ngrok.com/docs/api#api-tunnel-sessions</a></p>
|
|
112
108
|
|
|
@@ -299,6 +295,30 @@ session can include one or more Tunnels.
|
|
|
299
295
|
|
|
300
296
|
|
|
301
297
|
|
|
298
|
+
<span class="summary_desc"><div class='inline'>
|
|
299
|
+
<p>List all online tunnel sessions running on this account.</p>
|
|
300
|
+
</div></span>
|
|
301
|
+
|
|
302
|
+
</li>
|
|
303
|
+
|
|
304
|
+
|
|
305
|
+
<li class="public ">
|
|
306
|
+
<span class="summary_signature">
|
|
307
|
+
|
|
308
|
+
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
</span>
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
302
322
|
<span class="summary_desc"><div class='inline'>
|
|
303
323
|
<p>List all online tunnel sessions running on this account.</p>
|
|
304
324
|
</div></span>
|
|
@@ -620,20 +640,20 @@ session can include one or more Tunnels.
|
|
|
620
640
|
<pre class="lines">
|
|
621
641
|
|
|
622
642
|
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
629
|
-
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
|
|
633
|
-
|
|
643
|
+
91
|
|
644
|
+
92
|
|
645
|
+
93
|
|
646
|
+
94
|
|
647
|
+
95
|
|
648
|
+
96
|
|
649
|
+
97
|
|
650
|
+
98
|
|
651
|
+
99
|
|
652
|
+
100
|
|
653
|
+
101</pre>
|
|
634
654
|
</td>
|
|
635
655
|
<td>
|
|
636
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line
|
|
656
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 91</span>
|
|
637
657
|
|
|
638
658
|
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span>
|
|
639
659
|
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
@@ -719,20 +739,20 @@ session can include one or more Tunnels.
|
|
|
719
739
|
<pre class="lines">
|
|
720
740
|
|
|
721
741
|
|
|
722
|
-
|
|
723
|
-
|
|
724
|
-
|
|
725
|
-
|
|
726
|
-
|
|
727
|
-
|
|
728
|
-
|
|
729
|
-
|
|
730
|
-
|
|
731
|
-
|
|
732
|
-
|
|
742
|
+
111
|
|
743
|
+
112
|
|
744
|
+
113
|
|
745
|
+
114
|
|
746
|
+
115
|
|
747
|
+
116
|
|
748
|
+
117
|
|
749
|
+
118
|
|
750
|
+
119
|
|
751
|
+
120
|
|
752
|
+
121</pre>
|
|
733
753
|
</td>
|
|
734
754
|
<td>
|
|
735
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line
|
|
755
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 111</span>
|
|
736
756
|
|
|
737
757
|
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span>
|
|
738
758
|
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
@@ -861,7 +881,8 @@ session can include one or more Tunnels.
|
|
|
861
881
|
46
|
|
862
882
|
47
|
|
863
883
|
48
|
|
864
|
-
49
|
|
884
|
+
49
|
|
885
|
+
50</pre>
|
|
865
886
|
</td>
|
|
866
887
|
<td>
|
|
867
888
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 32</span>
|
|
@@ -877,6 +898,7 @@ session can include one or more Tunnels.
|
|
|
877
898
|
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
878
899
|
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::TunnelSessionsClient::PATH (constant)">PATH</a></span></span>
|
|
879
900
|
<span class='rparen'>)</span>
|
|
901
|
+
|
|
880
902
|
<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>
|
|
881
903
|
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
882
904
|
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
@@ -887,6 +909,151 @@ session can include one or more Tunnels.
|
|
|
887
909
|
</td>
|
|
888
910
|
</tr>
|
|
889
911
|
</table>
|
|
912
|
+
</div>
|
|
913
|
+
|
|
914
|
+
<div class="method_details ">
|
|
915
|
+
<h3 class="signature " id="list!-instance_method">
|
|
916
|
+
|
|
917
|
+
#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
|
|
918
|
+
|
|
919
|
+
|
|
920
|
+
|
|
921
|
+
|
|
922
|
+
|
|
923
|
+
</h3><div class="docstring">
|
|
924
|
+
<div class="discussion">
|
|
925
|
+
|
|
926
|
+
<p>List all online tunnel sessions running on this account. Throws an exception if API error.</p>
|
|
927
|
+
|
|
928
|
+
<p><a href="https://ngrok.com/docs/api#api-tunnel-sessions-list">ngrok.com/docs/api#api-tunnel-sessions-list</a></p>
|
|
929
|
+
|
|
930
|
+
|
|
931
|
+
</div>
|
|
932
|
+
</div>
|
|
933
|
+
<div class="tags">
|
|
934
|
+
<p class="tag_title">Parameters:</p>
|
|
935
|
+
<ul class="param">
|
|
936
|
+
|
|
937
|
+
<li>
|
|
938
|
+
|
|
939
|
+
<span class='name'>before_id</span>
|
|
940
|
+
|
|
941
|
+
|
|
942
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
946
|
+
|
|
947
|
+
|
|
948
|
+
</li>
|
|
949
|
+
|
|
950
|
+
<li>
|
|
951
|
+
|
|
952
|
+
<span class='name'>limit</span>
|
|
953
|
+
|
|
954
|
+
|
|
955
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
956
|
+
|
|
957
|
+
|
|
958
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
959
|
+
|
|
960
|
+
|
|
961
|
+
</li>
|
|
962
|
+
|
|
963
|
+
<li>
|
|
964
|
+
|
|
965
|
+
<span class='name'>url</span>
|
|
966
|
+
|
|
967
|
+
|
|
968
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
969
|
+
|
|
970
|
+
|
|
971
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
972
|
+
|
|
973
|
+
|
|
974
|
+
—
|
|
975
|
+
<div class='inline'>
|
|
976
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
977
|
+
</div>
|
|
978
|
+
|
|
979
|
+
</li>
|
|
980
|
+
|
|
981
|
+
</ul>
|
|
982
|
+
|
|
983
|
+
<p class="tag_title">Returns:</p>
|
|
984
|
+
<ul class="return">
|
|
985
|
+
|
|
986
|
+
<li>
|
|
987
|
+
|
|
988
|
+
|
|
989
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
|
|
990
|
+
|
|
991
|
+
|
|
992
|
+
|
|
993
|
+
—
|
|
994
|
+
<div class='inline'>
|
|
995
|
+
<p>result from the API request</p>
|
|
996
|
+
</div>
|
|
997
|
+
|
|
998
|
+
</li>
|
|
999
|
+
|
|
1000
|
+
</ul>
|
|
1001
|
+
|
|
1002
|
+
</div><table class="source_code">
|
|
1003
|
+
<tr>
|
|
1004
|
+
<td>
|
|
1005
|
+
<pre class="lines">
|
|
1006
|
+
|
|
1007
|
+
|
|
1008
|
+
62
|
|
1009
|
+
63
|
|
1010
|
+
64
|
|
1011
|
+
65
|
|
1012
|
+
66
|
|
1013
|
+
67
|
|
1014
|
+
68
|
|
1015
|
+
69
|
|
1016
|
+
70
|
|
1017
|
+
71
|
|
1018
|
+
72
|
|
1019
|
+
73
|
|
1020
|
+
74
|
|
1021
|
+
75
|
|
1022
|
+
76
|
|
1023
|
+
77
|
|
1024
|
+
78
|
|
1025
|
+
79
|
|
1026
|
+
80
|
|
1027
|
+
81
|
|
1028
|
+
82</pre>
|
|
1029
|
+
</td>
|
|
1030
|
+
<td>
|
|
1031
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 62</span>
|
|
1032
|
+
|
|
1033
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span>
|
|
1034
|
+
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1035
|
+
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1036
|
+
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1037
|
+
<span class='rparen'>)</span>
|
|
1038
|
+
<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>
|
|
1039
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1040
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1041
|
+
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
|
1042
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1043
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::TunnelSessionsClient::PATH (constant)">PATH</a></span></span>
|
|
1044
|
+
<span class='rparen'>)</span>
|
|
1045
|
+
|
|
1046
|
+
<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>
|
|
1047
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1048
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1049
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::TunnelSessionsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1050
|
+
<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/TunnelSession.html" title="NgrokAPI::Models::TunnelSession (class)">TunnelSession</a></span></span><span class='comma'>,</span>
|
|
1051
|
+
<span class='label'>danger:</span> <span class='kw'>true</span>
|
|
1052
|
+
<span class='rparen'>)</span>
|
|
1053
|
+
<span class='kw'>end</span></pre>
|
|
1054
|
+
</td>
|
|
1055
|
+
</tr>
|
|
1056
|
+
</table>
|
|
890
1057
|
</div>
|
|
891
1058
|
|
|
892
1059
|
<div class="method_details ">
|
|
@@ -957,18 +1124,18 @@ session can include one or more Tunnels.
|
|
|
957
1124
|
<pre class="lines">
|
|
958
1125
|
|
|
959
1126
|
|
|
960
|
-
|
|
961
|
-
|
|
962
|
-
|
|
963
|
-
|
|
964
|
-
|
|
965
|
-
|
|
966
|
-
|
|
967
|
-
|
|
968
|
-
|
|
1127
|
+
133
|
|
1128
|
+
134
|
|
1129
|
+
135
|
|
1130
|
+
136
|
|
1131
|
+
137
|
|
1132
|
+
138
|
|
1133
|
+
139
|
|
1134
|
+
140
|
|
1135
|
+
141</pre>
|
|
969
1136
|
</td>
|
|
970
1137
|
<td>
|
|
971
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line
|
|
1138
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 133</span>
|
|
972
1139
|
|
|
973
1140
|
<span class='kw'>def</span> <span class='id identifier rubyid_restart'>restart</span><span class='lparen'>(</span>
|
|
974
1141
|
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
@@ -1052,18 +1219,18 @@ session can include one or more Tunnels.
|
|
|
1052
1219
|
<pre class="lines">
|
|
1053
1220
|
|
|
1054
1221
|
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
|
|
1058
|
-
|
|
1059
|
-
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1222
|
+
154
|
|
1223
|
+
155
|
|
1224
|
+
156
|
|
1225
|
+
157
|
|
1226
|
+
158
|
|
1227
|
+
159
|
|
1228
|
+
160
|
|
1229
|
+
161
|
|
1230
|
+
162</pre>
|
|
1064
1231
|
</td>
|
|
1065
1232
|
<td>
|
|
1066
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line
|
|
1233
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 154</span>
|
|
1067
1234
|
|
|
1068
1235
|
<span class='kw'>def</span> <span class='id identifier rubyid_restart!'>restart!</span><span class='lparen'>(</span>
|
|
1069
1236
|
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
@@ -1147,18 +1314,18 @@ session can include one or more Tunnels.
|
|
|
1147
1314
|
<pre class="lines">
|
|
1148
1315
|
|
|
1149
1316
|
|
|
1150
|
-
|
|
1151
|
-
|
|
1152
|
-
|
|
1153
|
-
|
|
1154
|
-
|
|
1155
|
-
|
|
1156
|
-
|
|
1157
|
-
|
|
1158
|
-
|
|
1317
|
+
172
|
|
1318
|
+
173
|
|
1319
|
+
174
|
|
1320
|
+
175
|
|
1321
|
+
176
|
|
1322
|
+
177
|
|
1323
|
+
178
|
|
1324
|
+
179
|
|
1325
|
+
180</pre>
|
|
1159
1326
|
</td>
|
|
1160
1327
|
<td>
|
|
1161
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line
|
|
1328
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 172</span>
|
|
1162
1329
|
|
|
1163
1330
|
<span class='kw'>def</span> <span class='id identifier rubyid_stop'>stop</span><span class='lparen'>(</span>
|
|
1164
1331
|
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
@@ -1242,18 +1409,18 @@ session can include one or more Tunnels.
|
|
|
1242
1409
|
<pre class="lines">
|
|
1243
1410
|
|
|
1244
1411
|
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
|
|
1412
|
+
191
|
|
1413
|
+
192
|
|
1414
|
+
193
|
|
1415
|
+
194
|
|
1416
|
+
195
|
|
1417
|
+
196
|
|
1418
|
+
197
|
|
1419
|
+
198
|
|
1420
|
+
199</pre>
|
|
1254
1421
|
</td>
|
|
1255
1422
|
<td>
|
|
1256
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line
|
|
1423
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 191</span>
|
|
1257
1424
|
|
|
1258
1425
|
<span class='kw'>def</span> <span class='id identifier rubyid_stop!'>stop!</span><span class='lparen'>(</span>
|
|
1259
1426
|
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
@@ -1332,19 +1499,19 @@ session can include one or more Tunnels.
|
|
|
1332
1499
|
<pre class="lines">
|
|
1333
1500
|
|
|
1334
1501
|
|
|
1335
|
-
|
|
1336
|
-
|
|
1337
|
-
|
|
1338
|
-
|
|
1339
|
-
|
|
1340
|
-
|
|
1341
|
-
|
|
1342
|
-
|
|
1343
|
-
|
|
1344
|
-
|
|
1502
|
+
219
|
|
1503
|
+
220
|
|
1504
|
+
221
|
|
1505
|
+
222
|
|
1506
|
+
223
|
|
1507
|
+
224
|
|
1508
|
+
225
|
|
1509
|
+
226
|
|
1510
|
+
227
|
|
1511
|
+
228</pre>
|
|
1345
1512
|
</td>
|
|
1346
1513
|
<td>
|
|
1347
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line
|
|
1514
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 219</span>
|
|
1348
1515
|
|
|
1349
1516
|
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
|
|
1350
1517
|
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
@@ -1424,19 +1591,19 @@ session can include one or more Tunnels.
|
|
|
1424
1591
|
<pre class="lines">
|
|
1425
1592
|
|
|
1426
1593
|
|
|
1427
|
-
|
|
1428
|
-
|
|
1429
|
-
|
|
1430
|
-
|
|
1431
|
-
|
|
1432
|
-
|
|
1433
|
-
|
|
1434
|
-
|
|
1435
|
-
|
|
1436
|
-
|
|
1594
|
+
249
|
|
1595
|
+
250
|
|
1596
|
+
251
|
|
1597
|
+
252
|
|
1598
|
+
253
|
|
1599
|
+
254
|
|
1600
|
+
255
|
|
1601
|
+
256
|
|
1602
|
+
257
|
|
1603
|
+
258</pre>
|
|
1437
1604
|
</td>
|
|
1438
1605
|
<td>
|
|
1439
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line
|
|
1606
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tunnel_sessions_client.rb', line 249</span>
|
|
1440
1607
|
|
|
1441
1608
|
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
|
|
1442
1609
|
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
@@ -1458,7 +1625,7 @@ session can include one or more Tunnels.
|
|
|
1458
1625
|
</div>
|
|
1459
1626
|
|
|
1460
1627
|
<div id="footer">
|
|
1461
|
-
Generated on
|
|
1628
|
+
Generated on Tue Oct 19 15:48:23 2021 by
|
|
1462
1629
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1463
1630
|
0.9.26 (ruby-3.0.1).
|
|
1464
1631
|
</div>
|