ngrok-api 0.9.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 +2 -2
- data/.yardopts +1 -0
- data/LICENSE +7 -0
- data/doc/NgrokAPI/Client.html +1469 -125
- 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 +66 -36
- data/doc/NgrokAPI/Models/{ApiKey.html → APIKey.html} +110 -179
- data/doc/NgrokAPI/Models/AWSAuth.html +617 -0
- data/doc/NgrokAPI/Models/AWSCredentials.html +617 -0
- data/doc/NgrokAPI/Models/AWSRole.html +543 -0
- data/doc/NgrokAPI/Models/AbuseReport.html +987 -0
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +617 -0
- data/doc/NgrokAPI/Models/AgentIngress.html +1217 -0
- data/doc/NgrokAPI/Models/CertificateAuthority.html +1439 -0
- data/doc/NgrokAPI/Models/Credential.html +1149 -0
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +913 -0
- data/doc/NgrokAPI/Models/EndpointCompression.html +543 -0
- data/doc/NgrokAPI/Models/EndpointConfiguration.html +1323 -512
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +617 -0
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointLogging.html +617 -0
- data/doc/NgrokAPI/Models/EndpointLoggingMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +617 -0
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointOAuth.html +987 -0
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +987 -0
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +765 -0
- data/doc/NgrokAPI/Models/EndpointOIDC.html +1135 -0
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +691 -0
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +691 -0
- data/doc/NgrokAPI/Models/EndpointSAML.html +1653 -0
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +1283 -0
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +691 -0
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +691 -0
- data/doc/NgrokAPI/Models/EventDestination.html +1058 -0
- data/doc/NgrokAPI/Models/EventSource.html +765 -0
- data/doc/NgrokAPI/Models/EventSourceList.html +617 -0
- data/doc/NgrokAPI/Models/EventSourceReplace.html +691 -0
- data/doc/NgrokAPI/Models/EventStream.html +1309 -0
- data/doc/NgrokAPI/Models/EventSubscription.html +1058 -0
- data/doc/NgrokAPI/Models/EventTarget.html +765 -0
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +617 -0
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +617 -0
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +617 -0
- data/doc/NgrokAPI/Models/{TlsCertificate.html → IPPolicy.html} +172 -167
- data/doc/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/doc/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/doc/NgrokAPI/Models/Listable.html +120 -52
- data/doc/NgrokAPI/Models/Ref.html +617 -0
- data/doc/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/doc/NgrokAPI/Models/ReservedDomain.html +186 -1108
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +765 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +617 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +617 -0
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +1143 -0
- data/doc/NgrokAPI/Models/SSHCredential.html +1149 -0
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +1513 -0
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +1661 -0
- data/doc/NgrokAPI/Models/TLSCertificate.html +2179 -0
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +617 -0
- data/doc/NgrokAPI/Models/Tunnel.html +987 -0
- data/doc/NgrokAPI/Models/TunnelSession.html +1209 -0
- data/doc/NgrokAPI/Models.html +6 -6
- data/doc/NgrokAPI/PagedIterator.html +16 -12
- data/{docs/NgrokAPI/Services/ApiKeysClient.html → doc/NgrokAPI/Services/APIKeysClient.html} +404 -153
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +706 -0
- data/doc/NgrokAPI/Services/AgentIngressesClient.html +1600 -0
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +1602 -0
- data/doc/NgrokAPI/Services/CredentialsClient.html +1644 -0
- data/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +503 -370
- data/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +1712 -0
- data/doc/NgrokAPI/Services/EventSourcesClient.html +1532 -0
- data/doc/NgrokAPI/Services/EventStreamsClient.html +1792 -0
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +1712 -0
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +1602 -0
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +1660 -0
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +1720 -0
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +1894 -0
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +585 -344
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1644 -0
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +1662 -0
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +1680 -0
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +1720 -0
- data/{docs/NgrokAPI/Services/TlsCertificatesClient.html → doc/NgrokAPI/Services/TLSCertificatesClient.html} +404 -201
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +1587 -0
- data/doc/NgrokAPI/Services/TunnelsClient.html +669 -0
- data/doc/NgrokAPI/Services.html +6 -6
- data/doc/NgrokAPI.html +5 -5
- data/doc/README +94 -0
- data/doc/_index.html +621 -25
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +55 -28
- data/doc/frames.html +1 -1
- data/doc/index.html +55 -28
- data/doc/method_list.html +7526 -286
- data/doc/top-level-namespace.html +3 -3
- data/docs/.gitkeep +0 -0
- data/docs/CNAME +1 -0
- data/docs/NgrokAPI/Client.html +1469 -125
- 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 +66 -36
- data/docs/NgrokAPI/Models/{ApiKey.html → APIKey.html} +110 -179
- data/docs/NgrokAPI/Models/AWSAuth.html +617 -0
- data/docs/NgrokAPI/Models/AWSCredentials.html +617 -0
- data/docs/NgrokAPI/Models/AWSRole.html +543 -0
- data/docs/NgrokAPI/Models/AbuseReport.html +987 -0
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +617 -0
- data/docs/NgrokAPI/Models/AgentIngress.html +1217 -0
- data/docs/NgrokAPI/Models/CertificateAuthority.html +1439 -0
- data/docs/NgrokAPI/Models/Credential.html +1149 -0
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +913 -0
- data/docs/NgrokAPI/Models/EndpointCompression.html +543 -0
- data/docs/NgrokAPI/Models/EndpointConfiguration.html +1323 -512
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +617 -0
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointLogging.html +617 -0
- data/docs/NgrokAPI/Models/EndpointLoggingMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +617 -0
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointOAuth.html +987 -0
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +987 -0
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +765 -0
- data/docs/NgrokAPI/Models/EndpointOIDC.html +1135 -0
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +691 -0
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +691 -0
- data/docs/NgrokAPI/Models/EndpointSAML.html +1653 -0
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +1283 -0
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +691 -0
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +691 -0
- data/docs/NgrokAPI/Models/EventDestination.html +1058 -0
- data/docs/NgrokAPI/Models/EventSource.html +765 -0
- data/docs/NgrokAPI/Models/EventSourceList.html +617 -0
- data/docs/NgrokAPI/Models/EventSourceReplace.html +691 -0
- data/docs/NgrokAPI/Models/EventStream.html +1309 -0
- data/docs/NgrokAPI/Models/EventSubscription.html +1058 -0
- data/docs/NgrokAPI/Models/EventTarget.html +765 -0
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +617 -0
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +617 -0
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +617 -0
- data/docs/NgrokAPI/Models/{TlsCertificate.html → IPPolicy.html} +172 -167
- data/docs/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/docs/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/docs/NgrokAPI/Models/Listable.html +120 -52
- data/docs/NgrokAPI/Models/Ref.html +617 -0
- data/docs/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/docs/NgrokAPI/Models/ReservedDomain.html +186 -1108
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +765 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +617 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +617 -0
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +1143 -0
- data/docs/NgrokAPI/Models/SSHCredential.html +1149 -0
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +1513 -0
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +1661 -0
- data/docs/NgrokAPI/Models/TLSCertificate.html +2179 -0
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +617 -0
- data/docs/NgrokAPI/Models/Tunnel.html +987 -0
- data/docs/NgrokAPI/Models/TunnelSession.html +1209 -0
- data/docs/NgrokAPI/Models.html +6 -6
- data/docs/NgrokAPI/PagedIterator.html +16 -12
- data/{doc/NgrokAPI/Services/ApiKeysClient.html → docs/NgrokAPI/Services/APIKeysClient.html} +404 -153
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +706 -0
- data/docs/NgrokAPI/Services/AgentIngressesClient.html +1600 -0
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +1602 -0
- data/docs/NgrokAPI/Services/CredentialsClient.html +1644 -0
- data/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +503 -370
- data/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +1712 -0
- data/docs/NgrokAPI/Services/EventSourcesClient.html +1532 -0
- data/docs/NgrokAPI/Services/EventStreamsClient.html +1792 -0
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +1712 -0
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +1602 -0
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +1660 -0
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +1720 -0
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +1894 -0
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +585 -344
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1644 -0
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +1662 -0
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +1680 -0
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +1720 -0
- data/{doc/NgrokAPI/Services/TlsCertificatesClient.html → docs/NgrokAPI/Services/TLSCertificatesClient.html} +404 -201
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +1587 -0
- data/docs/NgrokAPI/Services/TunnelsClient.html +669 -0
- data/docs/NgrokAPI/Services.html +6 -6
- data/docs/NgrokAPI.html +5 -5
- data/docs/README +94 -0
- data/docs/_index.html +621 -25
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +55 -28
- data/docs/frames.html +1 -1
- data/docs/index.html +55 -28
- data/docs/method_list.html +7526 -286
- data/docs/top-level-namespace.html +3 -3
- data/lib/ngrokapi/client.rb +229 -49
- data/lib/ngrokapi/http_client.rb +6 -7
- data/lib/ngrokapi/models/abuse_report.rb +37 -0
- data/lib/ngrokapi/models/abuse_report_hostname.rb +27 -0
- data/lib/ngrokapi/models/agent_ingress.rb +66 -0
- data/lib/ngrokapi/models/api_key.rb +62 -64
- data/lib/ngrokapi/models/aws_auth.rb +27 -0
- data/lib/ngrokapi/models/aws_credentials.rb +27 -0
- data/lib/ngrokapi/models/aws_role.rb +25 -0
- data/lib/ngrokapi/models/certificate_authority.rb +72 -0
- data/lib/ngrokapi/models/credential.rb +67 -0
- data/lib/ngrokapi/models/endpoint_circuit_breaker.rb +35 -0
- data/lib/ngrokapi/models/endpoint_compression.rb +25 -0
- data/lib/ngrokapi/models/endpoint_configuration.rb +130 -119
- data/lib/ngrokapi/models/endpoint_ip_policy.rb +27 -0
- data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_logging.rb +27 -0
- data/lib/ngrokapi/models/endpoint_logging_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_mutual_tls.rb +27 -0
- data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_o_auth.rb +37 -0
- data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb +37 -0
- data/lib/ngrokapi/models/endpoint_o_auth_google.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_microsoft.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_provider.rb +31 -0
- data/lib/ngrokapi/models/endpoint_oidc.rb +41 -0
- data/lib/ngrokapi/models/endpoint_request_headers.rb +29 -0
- data/lib/ngrokapi/models/endpoint_response_headers.rb +29 -0
- data/lib/ngrokapi/models/endpoint_saml.rb +55 -0
- data/lib/ngrokapi/models/endpoint_saml_mutate.rb +45 -0
- data/lib/ngrokapi/models/endpoint_tls_termination.rb +29 -0
- data/lib/ngrokapi/models/endpoint_webhook_validation.rb +29 -0
- data/lib/ngrokapi/models/event_destination.rb +49 -0
- data/lib/ngrokapi/models/event_source.rb +31 -0
- data/lib/ngrokapi/models/event_source_list.rb +27 -0
- data/lib/ngrokapi/models/event_source_replace.rb +29 -0
- data/lib/ngrokapi/models/event_stream.rb +77 -0
- data/lib/ngrokapi/models/event_subscription.rb +47 -0
- data/lib/ngrokapi/models/event_target.rb +31 -0
- data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb +27 -0
- data/lib/ngrokapi/models/event_target_firehose.rb +27 -0
- data/lib/ngrokapi/models/event_target_kinesis.rb +27 -0
- data/lib/ngrokapi/models/ip_policy.rb +64 -0
- data/lib/ngrokapi/models/ip_policy_rule.rb +67 -0
- data/lib/ngrokapi/models/ip_restriction.rb +49 -0
- data/lib/ngrokapi/models/listable.rb +13 -2
- data/lib/ngrokapi/models/ref.rb +27 -0
- data/lib/ngrokapi/models/reserved_addr.rb +49 -0
- data/lib/ngrokapi/models/reserved_domain.rb +61 -211
- data/lib/ngrokapi/models/reserved_domain_cert_job.rb +31 -0
- data/lib/ngrokapi/models/reserved_domain_cert_policy.rb +27 -0
- data/lib/ngrokapi/models/reserved_domain_cert_status.rb +27 -0
- data/lib/ngrokapi/models/ssh_certificate_authority.rb +64 -0
- data/lib/ngrokapi/models/ssh_credential.rb +67 -0
- data/lib/ngrokapi/models/ssh_host_certificate.rb +74 -0
- data/lib/ngrokapi/models/ssh_user_certificate.rb +78 -0
- data/lib/ngrokapi/models/tls_certificate.rb +92 -62
- data/lib/ngrokapi/models/tls_certificate_sa_ns.rb +27 -0
- data/lib/ngrokapi/models/tunnel.rb +37 -0
- data/lib/ngrokapi/models/tunnel_session.rb +43 -0
- data/lib/ngrokapi/paged_iterator.rb +4 -2
- data/lib/ngrokapi/services/.gitkeep +0 -0
- data/lib/ngrokapi/services/abuse_reports_client.rb +77 -0
- data/lib/ngrokapi/services/agent_ingresses_client.rb +206 -0
- data/lib/ngrokapi/services/api_keys_client.rb +210 -144
- data/lib/ngrokapi/services/certificate_authorities_client.rb +211 -0
- data/lib/ngrokapi/services/credentials_client.rb +217 -0
- data/lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_compression_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +289 -313
- data/lib/ngrokapi/services/endpoint_ip_policy_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_logging_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_o_auth_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_oidc_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_request_headers_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_response_headers_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_saml_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_tls_termination_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb +108 -0
- data/lib/ngrokapi/services/event_destinations_client.rb +221 -0
- data/lib/ngrokapi/services/event_sources_client.rb +185 -0
- data/lib/ngrokapi/services/event_streams_client.rb +224 -0
- data/lib/ngrokapi/services/event_subscriptions_client.rb +215 -0
- data/lib/ngrokapi/services/ip_policies_client.rb +215 -0
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +214 -0
- data/lib/ngrokapi/services/ip_restrictions_client.rb +224 -0
- data/lib/ngrokapi/services/reserved_addrs_client.rb +246 -0
- data/lib/ngrokapi/services/reserved_domains_client.rb +360 -313
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +212 -0
- data/lib/ngrokapi/services/ssh_credentials_client.rb +215 -0
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +217 -0
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +221 -0
- data/lib/ngrokapi/services/tls_certificates_client.rb +213 -161
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +237 -0
- data/lib/ngrokapi/services/tunnels_client.rb +78 -0
- 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 +158 -33
- data/spec/ngrokapi/models/abuse_report_hostname_spec.rb +21 -0
- data/spec/ngrokapi/models/abuse_report_spec.rb +21 -0
- data/spec/ngrokapi/models/agent_ingress_spec.rb +42 -0
- data/spec/ngrokapi/models/api_key_spec.rb +42 -43
- data/spec/ngrokapi/models/aws_auth_spec.rb +21 -0
- data/spec/ngrokapi/models/aws_credentials_spec.rb +21 -0
- data/spec/ngrokapi/models/aws_role_spec.rb +21 -0
- data/spec/ngrokapi/models/certificate_authority_spec.rb +42 -0
- data/spec/ngrokapi/models/credential_spec.rb +45 -0
- data/spec/ngrokapi/models/endpoint_circuit_breaker_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_compression_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_configuration_spec.rb +78 -0
- data/spec/ngrokapi/models/endpoint_ip_policy_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_ip_policy_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_logging_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_logging_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_mutual_tls_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_mutual_tls_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_facebook_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_git_hub_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_google_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_microsoft_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_provider_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_oidc_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_request_headers_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_response_headers_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_saml_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_saml_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_tls_termination_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_webhook_validation_spec.rb +21 -0
- data/spec/ngrokapi/models/event_destination_spec.rb +28 -0
- data/spec/ngrokapi/models/event_source_list_spec.rb +21 -0
- data/spec/ngrokapi/models/event_source_replace_spec.rb +21 -0
- data/spec/ngrokapi/models/event_source_spec.rb +21 -0
- data/spec/ngrokapi/models/event_stream_spec.rb +51 -0
- data/spec/ngrokapi/models/event_subscription_spec.rb +28 -0
- data/spec/ngrokapi/models/event_target_cloudwatch_logs_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_firehose_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_kinesis_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_spec.rb +21 -0
- data/spec/ngrokapi/models/ip_policy_rule_spec.rb +45 -0
- data/spec/ngrokapi/models/ip_policy_spec.rb +42 -0
- data/spec/ngrokapi/models/ip_restriction_spec.rb +28 -0
- data/spec/ngrokapi/models/listable_spec.rb +4 -4
- data/spec/ngrokapi/models/ref_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_addr_spec.rb +28 -0
- data/spec/ngrokapi/models/reserved_domain_cert_job_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_cert_status_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_spec.rb +28 -100
- data/spec/ngrokapi/models/ssh_certificate_authority_spec.rb +42 -0
- data/spec/ngrokapi/models/ssh_credential_spec.rb +45 -0
- data/spec/ngrokapi/models/ssh_host_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/ssh_user_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/tls_certificate_sa_ns_spec.rb +21 -0
- data/spec/ngrokapi/models/tls_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/tunnel_session_spec.rb +21 -0
- data/spec/ngrokapi/models/tunnel_spec.rb +21 -0
- data/spec/ngrokapi/paged_iterator_spec.rb +7 -7
- data/spec/ngrokapi/services/.gitkeep +0 -0
- data/spec/ngrokapi/services/abuse_reports_client_spec.rb +65 -0
- data/spec/ngrokapi/services/agent_ingresses_client_spec.rb +159 -0
- data/spec/ngrokapi/services/api_keys_client_spec.rb +157 -127
- data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +159 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +163 -0
- data/spec/ngrokapi/services/endpoint_circuit_breaker_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_compression_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +237 -0
- data/spec/ngrokapi/services/endpoint_ip_policy_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_mutual_tls_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_o_auth_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_oidc_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_request_headers_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_response_headers_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_saml_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_tls_termination_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_webhook_validation_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/event_destinations_client_spec.rb +172 -0
- data/spec/ngrokapi/services/event_sources_client_spec.rb +192 -0
- data/spec/ngrokapi/services/event_streams_client_spec.rb +177 -0
- data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +169 -0
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +159 -0
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +165 -0
- data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +171 -0
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +206 -0
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +349 -0
- data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +163 -0
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +165 -0
- data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +167 -0
- data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +171 -0
- data/spec/ngrokapi/services/tls_certificates_client_spec.rb +161 -0
- data/spec/ngrokapi/services/tunnel_sessions_client_spec.rb +183 -0
- data/spec/ngrokapi/services/tunnels_client_spec.rb +21 -0
- data/spec/spec_helper.rb +1096 -80
- metadata +360 -11
|
@@ -0,0 +1,1600 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: NgrokAPI::Services::AgentIngressesClient
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.27
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "NgrokAPI::Services::AgentIngressesClient";
|
|
19
|
+
relpath = '../../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../../_index.html">Index (A)</a> »
|
|
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
|
+
»
|
|
42
|
+
<span class="title">AgentIngressesClient</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: NgrokAPI::Services::AgentIngressesClient
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">NgrokAPI::Services::AgentIngressesClient</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/ngrokapi/services/agent_ingresses_client.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p><a href="https://ngrok.com/docs/api#api-agent-ingresses">ngrok.com/docs/api#api-agent-ingresses</a></p>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
</div>
|
|
109
|
+
</div>
|
|
110
|
+
<div class="tags">
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
</div>
|
|
114
|
+
|
|
115
|
+
<h2>
|
|
116
|
+
Constant Summary
|
|
117
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
118
|
+
</h2>
|
|
119
|
+
|
|
120
|
+
<dl class="constants">
|
|
121
|
+
|
|
122
|
+
<dt id="PATH-constant" class="">PATH =
|
|
123
|
+
<div class="docstring">
|
|
124
|
+
<div class="discussion">
|
|
125
|
+
|
|
126
|
+
<p>The API path for the requests</p>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
</div>
|
|
130
|
+
</div>
|
|
131
|
+
<div class="tags">
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
</div>
|
|
135
|
+
</dt>
|
|
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>
|
|
137
|
+
|
|
138
|
+
<dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
|
|
139
|
+
<div class="docstring">
|
|
140
|
+
<div class="discussion">
|
|
141
|
+
|
|
142
|
+
<p>The List Property from the resulting API for list calls</p>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
</div>
|
|
146
|
+
</div>
|
|
147
|
+
<div class="tags">
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
</div>
|
|
151
|
+
</dt>
|
|
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>
|
|
153
|
+
|
|
154
|
+
</dl>
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
161
|
+
<ul class="summary">
|
|
162
|
+
|
|
163
|
+
<li class="public ">
|
|
164
|
+
<span class="summary_signature">
|
|
165
|
+
|
|
166
|
+
<a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> ⇒ Object </a>
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
</span>
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
<span class="note title readonly">readonly</span>
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
<span class="summary_desc"><div class='inline'>
|
|
186
|
+
<p>Returns the value of attribute client.</p>
|
|
187
|
+
</div></span>
|
|
188
|
+
|
|
189
|
+
</li>
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
</ul>
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
<h2>
|
|
199
|
+
Instance Method Summary
|
|
200
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
201
|
+
</h2>
|
|
202
|
+
|
|
203
|
+
<ul class="summary">
|
|
204
|
+
|
|
205
|
+
<li class="public ">
|
|
206
|
+
<span class="summary_signature">
|
|
207
|
+
|
|
208
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: "", metadata: "", domain:) ⇒ NgrokAPI::Models::AgentIngress </a>
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
</span>
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
<span class="summary_desc"><div class='inline'>
|
|
223
|
+
<p>Create a new Agent Ingress.</p>
|
|
224
|
+
</div></span>
|
|
225
|
+
|
|
226
|
+
</li>
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
<li class="public ">
|
|
230
|
+
<span class="summary_signature">
|
|
231
|
+
|
|
232
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
</span>
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
<span class="summary_desc"><div class='inline'>
|
|
247
|
+
<p>Delete an Agent Ingress by ID.</p>
|
|
248
|
+
</div></span>
|
|
249
|
+
|
|
250
|
+
</li>
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
<li class="public ">
|
|
254
|
+
<span class="summary_signature">
|
|
255
|
+
|
|
256
|
+
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
</span>
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
<span class="summary_desc"><div class='inline'>
|
|
271
|
+
<p>Delete an Agent Ingress by ID Throws an exception if API error.</p>
|
|
272
|
+
</div></span>
|
|
273
|
+
|
|
274
|
+
</li>
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
<li class="public ">
|
|
278
|
+
<span class="summary_signature">
|
|
279
|
+
|
|
280
|
+
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: "") ⇒ NgrokAPI::Models::AgentIngress </a>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
</span>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
<span class="summary_desc"><div class='inline'>
|
|
295
|
+
<p>Get the details of an Agent Ingress by ID.</p>
|
|
296
|
+
</div></span>
|
|
297
|
+
|
|
298
|
+
</li>
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
<li class="public ">
|
|
302
|
+
<span class="summary_signature">
|
|
303
|
+
|
|
304
|
+
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: "") ⇒ NgrokAPI::Models::AgentIngress </a>
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
</span>
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
<span class="summary_desc"><div class='inline'>
|
|
319
|
+
<p>Get the details of an Agent Ingress by ID.</p>
|
|
320
|
+
</div></span>
|
|
321
|
+
|
|
322
|
+
</li>
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
<li class="public ">
|
|
326
|
+
<span class="summary_signature">
|
|
327
|
+
|
|
328
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒ AgentIngressesClient </a>
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
</span>
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
<span class="note title constructor">constructor</span>
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
<span class="summary_desc"><div class='inline'>
|
|
345
|
+
<p>A new instance of AgentIngressesClient.</p>
|
|
346
|
+
</div></span>
|
|
347
|
+
|
|
348
|
+
</li>
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
<li class="public ">
|
|
352
|
+
<span class="summary_signature">
|
|
353
|
+
|
|
354
|
+
<a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
</span>
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
<span class="summary_desc"><div class='inline'>
|
|
369
|
+
<p>List all Agent Ingresses owned by this account.</p>
|
|
370
|
+
</div></span>
|
|
371
|
+
|
|
372
|
+
</li>
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<li class="public ">
|
|
376
|
+
<span class="summary_signature">
|
|
377
|
+
|
|
378
|
+
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
</span>
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
<span class="summary_desc"><div class='inline'>
|
|
393
|
+
<p>List all Agent Ingresses owned by this account Throws an exception if API error.</p>
|
|
394
|
+
</div></span>
|
|
395
|
+
|
|
396
|
+
</li>
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
<li class="public ">
|
|
400
|
+
<span class="summary_signature">
|
|
401
|
+
|
|
402
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::AgentIngress </a>
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
</span>
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
<span class="summary_desc"><div class='inline'>
|
|
417
|
+
<p>Update attributes of an Agent Ingress by ID.</p>
|
|
418
|
+
</div></span>
|
|
419
|
+
|
|
420
|
+
</li>
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
<li class="public ">
|
|
424
|
+
<span class="summary_signature">
|
|
425
|
+
|
|
426
|
+
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::AgentIngress </a>
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
</span>
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
<span class="summary_desc"><div class='inline'>
|
|
441
|
+
<p>Update attributes of an Agent Ingress by ID.</p>
|
|
442
|
+
</div></span>
|
|
443
|
+
|
|
444
|
+
</li>
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
</ul>
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
<div id="constructor_details" class="method_details_list">
|
|
451
|
+
<h2>Constructor Details</h2>
|
|
452
|
+
|
|
453
|
+
<div class="method_details first">
|
|
454
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
455
|
+
|
|
456
|
+
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::AgentIngressesClient (class)">AgentIngressesClient</a></span></tt>
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
</h3><div class="docstring">
|
|
463
|
+
<div class="discussion">
|
|
464
|
+
|
|
465
|
+
<p>Returns a new instance of AgentIngressesClient.</p>
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
</div>
|
|
469
|
+
</div>
|
|
470
|
+
<div class="tags">
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
</div><table class="source_code">
|
|
474
|
+
<tr>
|
|
475
|
+
<td>
|
|
476
|
+
<pre class="lines">
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
15
|
|
480
|
+
16
|
|
481
|
+
17</pre>
|
|
482
|
+
</td>
|
|
483
|
+
<td>
|
|
484
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 15</span>
|
|
485
|
+
|
|
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>
|
|
487
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
488
|
+
<span class='kw'>end</span></pre>
|
|
489
|
+
</td>
|
|
490
|
+
</tr>
|
|
491
|
+
</table>
|
|
492
|
+
</div>
|
|
493
|
+
|
|
494
|
+
</div>
|
|
495
|
+
|
|
496
|
+
<div id="instance_attr_details" class="attr_details">
|
|
497
|
+
<h2>Instance Attribute Details</h2>
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
<span id=""></span>
|
|
501
|
+
<div class="method_details first">
|
|
502
|
+
<h3 class="signature first" id="client-instance_method">
|
|
503
|
+
|
|
504
|
+
#<strong>client</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
</h3><div class="docstring">
|
|
511
|
+
<div class="discussion">
|
|
512
|
+
|
|
513
|
+
<p>Returns the value of attribute client.</p>
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
</div>
|
|
517
|
+
</div>
|
|
518
|
+
<div class="tags">
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
</div><table class="source_code">
|
|
522
|
+
<tr>
|
|
523
|
+
<td>
|
|
524
|
+
<pre class="lines">
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
13
|
|
528
|
+
14
|
|
529
|
+
15</pre>
|
|
530
|
+
</td>
|
|
531
|
+
<td>
|
|
532
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 13</span>
|
|
533
|
+
|
|
534
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
|
535
|
+
<span class='ivar'>@client</span>
|
|
536
|
+
<span class='kw'>end</span></pre>
|
|
537
|
+
</td>
|
|
538
|
+
</tr>
|
|
539
|
+
</table>
|
|
540
|
+
</div>
|
|
541
|
+
|
|
542
|
+
</div>
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
<div id="instance_method_details" class="method_details_list">
|
|
546
|
+
<h2>Instance Method Details</h2>
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
<div class="method_details first">
|
|
550
|
+
<h3 class="signature first" id="create-instance_method">
|
|
551
|
+
|
|
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>
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
</h3><div class="docstring">
|
|
559
|
+
<div class="discussion">
|
|
560
|
+
|
|
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>
|
|
562
|
+
|
|
563
|
+
<p><a href="https://ngrok.com/docs/api#api-agent-ingresses-create">ngrok.com/docs/api#api-agent-ingresses-create</a></p>
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
</div>
|
|
567
|
+
</div>
|
|
568
|
+
<div class="tags">
|
|
569
|
+
<p class="tag_title">Parameters:</p>
|
|
570
|
+
<ul class="param">
|
|
571
|
+
|
|
572
|
+
<li>
|
|
573
|
+
|
|
574
|
+
<span class='name'>description</span>
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
—
|
|
584
|
+
<div class='inline'>
|
|
585
|
+
<p>human-readable description of the use of this Agent Ingress. optional, max 255 bytes.</p>
|
|
586
|
+
</div>
|
|
587
|
+
|
|
588
|
+
</li>
|
|
589
|
+
|
|
590
|
+
<li>
|
|
591
|
+
|
|
592
|
+
<span class='name'>metadata</span>
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
—
|
|
602
|
+
<div class='inline'>
|
|
603
|
+
<p>arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes</p>
|
|
604
|
+
</div>
|
|
605
|
+
|
|
606
|
+
</li>
|
|
607
|
+
|
|
608
|
+
<li>
|
|
609
|
+
|
|
610
|
+
<span class='name'>domain</span>
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
|
|
617
|
+
—
|
|
618
|
+
<div class='inline'>
|
|
619
|
+
<p>the domain that you own to be used as the base domain name to generate regional agent ingress domains.</p>
|
|
620
|
+
</div>
|
|
621
|
+
|
|
622
|
+
</li>
|
|
623
|
+
|
|
624
|
+
</ul>
|
|
625
|
+
|
|
626
|
+
<p class="tag_title">Returns:</p>
|
|
627
|
+
<ul class="return">
|
|
628
|
+
|
|
629
|
+
<li>
|
|
630
|
+
|
|
631
|
+
|
|
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>
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
|
|
636
|
+
—
|
|
637
|
+
<div class='inline'>
|
|
638
|
+
<p>result from the API request</p>
|
|
639
|
+
</div>
|
|
640
|
+
|
|
641
|
+
</li>
|
|
642
|
+
|
|
643
|
+
</ul>
|
|
644
|
+
|
|
645
|
+
</div><table class="source_code">
|
|
646
|
+
<tr>
|
|
647
|
+
<td>
|
|
648
|
+
<pre class="lines">
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
29
|
|
652
|
+
30
|
|
653
|
+
31
|
|
654
|
+
32
|
|
655
|
+
33
|
|
656
|
+
34
|
|
657
|
+
35
|
|
658
|
+
36
|
|
659
|
+
37
|
|
660
|
+
38
|
|
661
|
+
39</pre>
|
|
662
|
+
</td>
|
|
663
|
+
<td>
|
|
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>
|
|
668
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
669
|
+
<span class='rbrace'>}</span>
|
|
670
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
676
|
+
<span class='kw'>end</span></pre>
|
|
677
|
+
</td>
|
|
678
|
+
</tr>
|
|
679
|
+
</table>
|
|
680
|
+
</div>
|
|
681
|
+
|
|
682
|
+
<div class="method_details ">
|
|
683
|
+
<h3 class="signature " id="delete-instance_method">
|
|
684
|
+
|
|
685
|
+
#<strong>delete</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
</h3><div class="docstring">
|
|
692
|
+
<div class="discussion">
|
|
693
|
+
|
|
694
|
+
<p>Delete an Agent Ingress by ID</p>
|
|
695
|
+
|
|
696
|
+
<p><a href="https://ngrok.com/docs/api#api-agent-ingresses-delete">ngrok.com/docs/api#api-agent-ingresses-delete</a></p>
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
</div>
|
|
700
|
+
</div>
|
|
701
|
+
<div class="tags">
|
|
702
|
+
<p class="tag_title">Parameters:</p>
|
|
703
|
+
<ul class="param">
|
|
704
|
+
|
|
705
|
+
<li>
|
|
706
|
+
|
|
707
|
+
<span class='name'>id</span>
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
711
|
+
|
|
712
|
+
|
|
713
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
714
|
+
|
|
715
|
+
|
|
716
|
+
—
|
|
717
|
+
<div class='inline'>
|
|
718
|
+
<p>a resource identifier</p>
|
|
719
|
+
</div>
|
|
720
|
+
|
|
721
|
+
</li>
|
|
722
|
+
|
|
723
|
+
</ul>
|
|
724
|
+
|
|
725
|
+
<p class="tag_title">Returns:</p>
|
|
726
|
+
<ul class="return">
|
|
727
|
+
|
|
728
|
+
<li>
|
|
729
|
+
|
|
730
|
+
|
|
731
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
732
|
+
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
—
|
|
736
|
+
<div class='inline'>
|
|
737
|
+
<p>result from the API request</p>
|
|
738
|
+
</div>
|
|
739
|
+
|
|
740
|
+
</li>
|
|
741
|
+
|
|
742
|
+
</ul>
|
|
743
|
+
|
|
744
|
+
</div><table class="source_code">
|
|
745
|
+
<tr>
|
|
746
|
+
<td>
|
|
747
|
+
<pre class="lines">
|
|
748
|
+
|
|
749
|
+
|
|
750
|
+
48
|
|
751
|
+
49
|
|
752
|
+
50
|
|
753
|
+
51
|
|
754
|
+
52
|
|
755
|
+
53
|
|
756
|
+
54</pre>
|
|
757
|
+
</td>
|
|
758
|
+
<td>
|
|
759
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 48</span>
|
|
760
|
+
|
|
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>
|
|
763
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
764
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
765
|
+
<span class='rbrace'>}</span>
|
|
766
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</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='rparen'>)</span>
|
|
767
|
+
<span class='kw'>end</span></pre>
|
|
768
|
+
</td>
|
|
769
|
+
</tr>
|
|
770
|
+
</table>
|
|
771
|
+
</div>
|
|
772
|
+
|
|
773
|
+
<div class="method_details ">
|
|
774
|
+
<h3 class="signature " id="delete!-instance_method">
|
|
775
|
+
|
|
776
|
+
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
777
|
+
|
|
778
|
+
|
|
779
|
+
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
</h3><div class="docstring">
|
|
783
|
+
<div class="discussion">
|
|
784
|
+
|
|
785
|
+
<p>Delete an Agent Ingress by ID Throws an exception if API error.</p>
|
|
786
|
+
|
|
787
|
+
<p><a href="https://ngrok.com/docs/api#api-agent-ingresses-delete">ngrok.com/docs/api#api-agent-ingresses-delete</a></p>
|
|
788
|
+
|
|
789
|
+
|
|
790
|
+
</div>
|
|
791
|
+
</div>
|
|
792
|
+
<div class="tags">
|
|
793
|
+
<p class="tag_title">Parameters:</p>
|
|
794
|
+
<ul class="param">
|
|
795
|
+
|
|
796
|
+
<li>
|
|
797
|
+
|
|
798
|
+
<span class='name'>id</span>
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
805
|
+
|
|
806
|
+
|
|
807
|
+
—
|
|
808
|
+
<div class='inline'>
|
|
809
|
+
<p>a resource identifier</p>
|
|
810
|
+
</div>
|
|
811
|
+
|
|
812
|
+
</li>
|
|
813
|
+
|
|
814
|
+
</ul>
|
|
815
|
+
|
|
816
|
+
<p class="tag_title">Returns:</p>
|
|
817
|
+
<ul class="return">
|
|
818
|
+
|
|
819
|
+
<li>
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
823
|
+
|
|
824
|
+
|
|
825
|
+
|
|
826
|
+
—
|
|
827
|
+
<div class='inline'>
|
|
828
|
+
<p>result from the API request</p>
|
|
829
|
+
</div>
|
|
830
|
+
|
|
831
|
+
</li>
|
|
832
|
+
|
|
833
|
+
</ul>
|
|
834
|
+
|
|
835
|
+
</div><table class="source_code">
|
|
836
|
+
<tr>
|
|
837
|
+
<td>
|
|
838
|
+
<pre class="lines">
|
|
839
|
+
|
|
840
|
+
|
|
841
|
+
64
|
|
842
|
+
65
|
|
843
|
+
66
|
|
844
|
+
67
|
|
845
|
+
68
|
|
846
|
+
69
|
|
847
|
+
70</pre>
|
|
848
|
+
</td>
|
|
849
|
+
<td>
|
|
850
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 64</span>
|
|
851
|
+
|
|
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>
|
|
854
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
855
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
856
|
+
<span class='rbrace'>}</span>
|
|
857
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</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'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
858
|
+
<span class='kw'>end</span></pre>
|
|
859
|
+
</td>
|
|
860
|
+
</tr>
|
|
861
|
+
</table>
|
|
862
|
+
</div>
|
|
863
|
+
|
|
864
|
+
<div class="method_details ">
|
|
865
|
+
<h3 class="signature " id="get-instance_method">
|
|
866
|
+
|
|
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>
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
|
|
873
|
+
</h3><div class="docstring">
|
|
874
|
+
<div class="discussion">
|
|
875
|
+
|
|
876
|
+
<p>Get the details of an Agent Ingress by ID.</p>
|
|
877
|
+
|
|
878
|
+
<p><a href="https://ngrok.com/docs/api#api-agent-ingresses-get">ngrok.com/docs/api#api-agent-ingresses-get</a></p>
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
</div>
|
|
882
|
+
</div>
|
|
883
|
+
<div class="tags">
|
|
884
|
+
<p class="tag_title">Parameters:</p>
|
|
885
|
+
<ul class="param">
|
|
886
|
+
|
|
887
|
+
<li>
|
|
888
|
+
|
|
889
|
+
<span class='name'>id</span>
|
|
890
|
+
|
|
891
|
+
|
|
892
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
896
|
+
|
|
897
|
+
|
|
898
|
+
—
|
|
899
|
+
<div class='inline'>
|
|
900
|
+
<p>a resource identifier</p>
|
|
901
|
+
</div>
|
|
902
|
+
|
|
903
|
+
</li>
|
|
904
|
+
|
|
905
|
+
</ul>
|
|
906
|
+
|
|
907
|
+
<p class="tag_title">Returns:</p>
|
|
908
|
+
<ul class="return">
|
|
909
|
+
|
|
910
|
+
<li>
|
|
911
|
+
|
|
912
|
+
|
|
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>
|
|
914
|
+
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
—
|
|
918
|
+
<div class='inline'>
|
|
919
|
+
<p>result from the API request</p>
|
|
920
|
+
</div>
|
|
921
|
+
|
|
922
|
+
</li>
|
|
923
|
+
|
|
924
|
+
</ul>
|
|
925
|
+
|
|
926
|
+
</div><table class="source_code">
|
|
927
|
+
<tr>
|
|
928
|
+
<td>
|
|
929
|
+
<pre class="lines">
|
|
930
|
+
|
|
931
|
+
|
|
932
|
+
79
|
|
933
|
+
80
|
|
934
|
+
81
|
|
935
|
+
82
|
|
936
|
+
83
|
|
937
|
+
84
|
|
938
|
+
85
|
|
939
|
+
86
|
|
940
|
+
87</pre>
|
|
941
|
+
</td>
|
|
942
|
+
<td>
|
|
943
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 79</span>
|
|
944
|
+
|
|
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>
|
|
947
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
948
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
949
|
+
<span class='rbrace'>}</span>
|
|
950
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
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>
|
|
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>
|
|
953
|
+
<span class='kw'>end</span></pre>
|
|
954
|
+
</td>
|
|
955
|
+
</tr>
|
|
956
|
+
</table>
|
|
957
|
+
</div>
|
|
958
|
+
|
|
959
|
+
<div class="method_details ">
|
|
960
|
+
<h3 class="signature " id="get!-instance_method">
|
|
961
|
+
|
|
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>
|
|
963
|
+
|
|
964
|
+
|
|
965
|
+
|
|
966
|
+
|
|
967
|
+
|
|
968
|
+
</h3><div class="docstring">
|
|
969
|
+
<div class="discussion">
|
|
970
|
+
|
|
971
|
+
<p>Get the details of an Agent Ingress by ID. Throws an exception if API error.</p>
|
|
972
|
+
|
|
973
|
+
<p><a href="https://ngrok.com/docs/api#api-agent-ingresses-get">ngrok.com/docs/api#api-agent-ingresses-get</a></p>
|
|
974
|
+
|
|
975
|
+
|
|
976
|
+
</div>
|
|
977
|
+
</div>
|
|
978
|
+
<div class="tags">
|
|
979
|
+
<p class="tag_title">Parameters:</p>
|
|
980
|
+
<ul class="param">
|
|
981
|
+
|
|
982
|
+
<li>
|
|
983
|
+
|
|
984
|
+
<span class='name'>id</span>
|
|
985
|
+
|
|
986
|
+
|
|
987
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
991
|
+
|
|
992
|
+
|
|
993
|
+
—
|
|
994
|
+
<div class='inline'>
|
|
995
|
+
<p>a resource identifier</p>
|
|
996
|
+
</div>
|
|
997
|
+
|
|
998
|
+
</li>
|
|
999
|
+
|
|
1000
|
+
</ul>
|
|
1001
|
+
|
|
1002
|
+
<p class="tag_title">Returns:</p>
|
|
1003
|
+
<ul class="return">
|
|
1004
|
+
|
|
1005
|
+
<li>
|
|
1006
|
+
|
|
1007
|
+
|
|
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>
|
|
1009
|
+
|
|
1010
|
+
|
|
1011
|
+
|
|
1012
|
+
—
|
|
1013
|
+
<div class='inline'>
|
|
1014
|
+
<p>result from the API request</p>
|
|
1015
|
+
</div>
|
|
1016
|
+
|
|
1017
|
+
</li>
|
|
1018
|
+
|
|
1019
|
+
</ul>
|
|
1020
|
+
|
|
1021
|
+
</div><table class="source_code">
|
|
1022
|
+
<tr>
|
|
1023
|
+
<td>
|
|
1024
|
+
<pre class="lines">
|
|
1025
|
+
|
|
1026
|
+
|
|
1027
|
+
97
|
|
1028
|
+
98
|
|
1029
|
+
99
|
|
1030
|
+
100
|
|
1031
|
+
101
|
|
1032
|
+
102
|
|
1033
|
+
103
|
|
1034
|
+
104
|
|
1035
|
+
105</pre>
|
|
1036
|
+
</td>
|
|
1037
|
+
<td>
|
|
1038
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 97</span>
|
|
1039
|
+
|
|
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>
|
|
1042
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1043
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1044
|
+
<span class='rbrace'>}</span>
|
|
1045
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
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>
|
|
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>
|
|
1048
|
+
<span class='kw'>end</span></pre>
|
|
1049
|
+
</td>
|
|
1050
|
+
</tr>
|
|
1051
|
+
</table>
|
|
1052
|
+
</div>
|
|
1053
|
+
|
|
1054
|
+
<div class="method_details ">
|
|
1055
|
+
<h3 class="signature " id="list-instance_method">
|
|
1056
|
+
|
|
1057
|
+
#<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>
|
|
1058
|
+
|
|
1059
|
+
|
|
1060
|
+
|
|
1061
|
+
|
|
1062
|
+
|
|
1063
|
+
</h3><div class="docstring">
|
|
1064
|
+
<div class="discussion">
|
|
1065
|
+
|
|
1066
|
+
<p>List all Agent Ingresses owned by this account</p>
|
|
1067
|
+
|
|
1068
|
+
<p><a href="https://ngrok.com/docs/api#api-agent-ingresses-list">ngrok.com/docs/api#api-agent-ingresses-list</a></p>
|
|
1069
|
+
|
|
1070
|
+
|
|
1071
|
+
</div>
|
|
1072
|
+
</div>
|
|
1073
|
+
<div class="tags">
|
|
1074
|
+
<p class="tag_title">Parameters:</p>
|
|
1075
|
+
<ul class="param">
|
|
1076
|
+
|
|
1077
|
+
<li>
|
|
1078
|
+
|
|
1079
|
+
<span class='name'>before_id</span>
|
|
1080
|
+
|
|
1081
|
+
|
|
1082
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1086
|
+
|
|
1087
|
+
|
|
1088
|
+
</li>
|
|
1089
|
+
|
|
1090
|
+
<li>
|
|
1091
|
+
|
|
1092
|
+
<span class='name'>limit</span>
|
|
1093
|
+
|
|
1094
|
+
|
|
1095
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1099
|
+
|
|
1100
|
+
|
|
1101
|
+
</li>
|
|
1102
|
+
|
|
1103
|
+
<li>
|
|
1104
|
+
|
|
1105
|
+
<span class='name'>url</span>
|
|
1106
|
+
|
|
1107
|
+
|
|
1108
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1109
|
+
|
|
1110
|
+
|
|
1111
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1112
|
+
|
|
1113
|
+
|
|
1114
|
+
—
|
|
1115
|
+
<div class='inline'>
|
|
1116
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
1117
|
+
</div>
|
|
1118
|
+
|
|
1119
|
+
</li>
|
|
1120
|
+
|
|
1121
|
+
</ul>
|
|
1122
|
+
|
|
1123
|
+
<p class="tag_title">Returns:</p>
|
|
1124
|
+
<ul class="return">
|
|
1125
|
+
|
|
1126
|
+
<li>
|
|
1127
|
+
|
|
1128
|
+
|
|
1129
|
+
<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>
|
|
1130
|
+
|
|
1131
|
+
|
|
1132
|
+
|
|
1133
|
+
—
|
|
1134
|
+
<div class='inline'>
|
|
1135
|
+
<p>result from the API request</p>
|
|
1136
|
+
</div>
|
|
1137
|
+
|
|
1138
|
+
</li>
|
|
1139
|
+
|
|
1140
|
+
</ul>
|
|
1141
|
+
|
|
1142
|
+
</div><table class="source_code">
|
|
1143
|
+
<tr>
|
|
1144
|
+
<td>
|
|
1145
|
+
<pre class="lines">
|
|
1146
|
+
|
|
1147
|
+
|
|
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>
|
|
1164
|
+
</td>
|
|
1165
|
+
<td>
|
|
1166
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 116</span>
|
|
1167
|
+
|
|
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>
|
|
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>
|
|
1171
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1172
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1173
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1174
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::AgentIngressesClient::PATH (constant)">PATH</a></span></span>
|
|
1175
|
+
<span class='rparen'>)</span>
|
|
1176
|
+
|
|
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>
|
|
1178
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1179
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1180
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::AgentIngressesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1181
|
+
<span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">AgentIngress</a></span></span>
|
|
1182
|
+
<span class='rparen'>)</span>
|
|
1183
|
+
<span class='kw'>end</span></pre>
|
|
1184
|
+
</td>
|
|
1185
|
+
</tr>
|
|
1186
|
+
</table>
|
|
1187
|
+
</div>
|
|
1188
|
+
|
|
1189
|
+
<div class="method_details ">
|
|
1190
|
+
<h3 class="signature " id="list!-instance_method">
|
|
1191
|
+
|
|
1192
|
+
#<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>
|
|
1193
|
+
|
|
1194
|
+
|
|
1195
|
+
|
|
1196
|
+
|
|
1197
|
+
|
|
1198
|
+
</h3><div class="docstring">
|
|
1199
|
+
<div class="discussion">
|
|
1200
|
+
|
|
1201
|
+
<p>List all Agent Ingresses owned by this account Throws an exception if API error.</p>
|
|
1202
|
+
|
|
1203
|
+
<p><a href="https://ngrok.com/docs/api#api-agent-ingresses-list">ngrok.com/docs/api#api-agent-ingresses-list</a></p>
|
|
1204
|
+
|
|
1205
|
+
|
|
1206
|
+
</div>
|
|
1207
|
+
</div>
|
|
1208
|
+
<div class="tags">
|
|
1209
|
+
<p class="tag_title">Parameters:</p>
|
|
1210
|
+
<ul class="param">
|
|
1211
|
+
|
|
1212
|
+
<li>
|
|
1213
|
+
|
|
1214
|
+
<span class='name'>before_id</span>
|
|
1215
|
+
|
|
1216
|
+
|
|
1217
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1218
|
+
|
|
1219
|
+
|
|
1220
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1221
|
+
|
|
1222
|
+
|
|
1223
|
+
</li>
|
|
1224
|
+
|
|
1225
|
+
<li>
|
|
1226
|
+
|
|
1227
|
+
<span class='name'>limit</span>
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1234
|
+
|
|
1235
|
+
|
|
1236
|
+
</li>
|
|
1237
|
+
|
|
1238
|
+
<li>
|
|
1239
|
+
|
|
1240
|
+
<span class='name'>url</span>
|
|
1241
|
+
|
|
1242
|
+
|
|
1243
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1244
|
+
|
|
1245
|
+
|
|
1246
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1247
|
+
|
|
1248
|
+
|
|
1249
|
+
—
|
|
1250
|
+
<div class='inline'>
|
|
1251
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
1252
|
+
</div>
|
|
1253
|
+
|
|
1254
|
+
</li>
|
|
1255
|
+
|
|
1256
|
+
</ul>
|
|
1257
|
+
|
|
1258
|
+
<p class="tag_title">Returns:</p>
|
|
1259
|
+
<ul class="return">
|
|
1260
|
+
|
|
1261
|
+
<li>
|
|
1262
|
+
|
|
1263
|
+
|
|
1264
|
+
<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>
|
|
1265
|
+
|
|
1266
|
+
|
|
1267
|
+
|
|
1268
|
+
—
|
|
1269
|
+
<div class='inline'>
|
|
1270
|
+
<p>result from the API request</p>
|
|
1271
|
+
</div>
|
|
1272
|
+
|
|
1273
|
+
</li>
|
|
1274
|
+
|
|
1275
|
+
</ul>
|
|
1276
|
+
|
|
1277
|
+
</div><table class="source_code">
|
|
1278
|
+
<tr>
|
|
1279
|
+
<td>
|
|
1280
|
+
<pre class="lines">
|
|
1281
|
+
|
|
1282
|
+
|
|
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>
|
|
1301
|
+
</td>
|
|
1302
|
+
<td>
|
|
1303
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 143</span>
|
|
1304
|
+
|
|
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>
|
|
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>
|
|
1308
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1309
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1310
|
+
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
|
1311
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1312
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::AgentIngressesClient::PATH (constant)">PATH</a></span></span>
|
|
1313
|
+
<span class='rparen'>)</span>
|
|
1314
|
+
|
|
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>
|
|
1316
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1317
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1318
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::AgentIngressesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1319
|
+
<span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/AgentIngress.html" title="NgrokAPI::Models::AgentIngress (class)">AgentIngress</a></span></span><span class='comma'>,</span>
|
|
1320
|
+
<span class='label'>danger:</span> <span class='kw'>true</span>
|
|
1321
|
+
<span class='rparen'>)</span>
|
|
1322
|
+
<span class='kw'>end</span></pre>
|
|
1323
|
+
</td>
|
|
1324
|
+
</tr>
|
|
1325
|
+
</table>
|
|
1326
|
+
</div>
|
|
1327
|
+
|
|
1328
|
+
<div class="method_details ">
|
|
1329
|
+
<h3 class="signature " id="update-instance_method">
|
|
1330
|
+
|
|
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>
|
|
1332
|
+
|
|
1333
|
+
|
|
1334
|
+
|
|
1335
|
+
|
|
1336
|
+
|
|
1337
|
+
</h3><div class="docstring">
|
|
1338
|
+
<div class="discussion">
|
|
1339
|
+
|
|
1340
|
+
<p>Update attributes of an Agent Ingress by ID.</p>
|
|
1341
|
+
|
|
1342
|
+
<p><a href="https://ngrok.com/docs/api#api-agent-ingresses-update">ngrok.com/docs/api#api-agent-ingresses-update</a></p>
|
|
1343
|
+
|
|
1344
|
+
|
|
1345
|
+
</div>
|
|
1346
|
+
</div>
|
|
1347
|
+
<div class="tags">
|
|
1348
|
+
<p class="tag_title">Parameters:</p>
|
|
1349
|
+
<ul class="param">
|
|
1350
|
+
|
|
1351
|
+
<li>
|
|
1352
|
+
|
|
1353
|
+
<span class='name'>id</span>
|
|
1354
|
+
|
|
1355
|
+
|
|
1356
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1357
|
+
|
|
1358
|
+
|
|
1359
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1360
|
+
|
|
1361
|
+
|
|
1362
|
+
</li>
|
|
1363
|
+
|
|
1364
|
+
<li>
|
|
1365
|
+
|
|
1366
|
+
<span class='name'>description</span>
|
|
1367
|
+
|
|
1368
|
+
|
|
1369
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1370
|
+
|
|
1371
|
+
|
|
1372
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1373
|
+
|
|
1374
|
+
|
|
1375
|
+
—
|
|
1376
|
+
<div class='inline'>
|
|
1377
|
+
<p>human-readable description of the use of this Agent Ingress. optional, max 255 bytes.</p>
|
|
1378
|
+
</div>
|
|
1379
|
+
|
|
1380
|
+
</li>
|
|
1381
|
+
|
|
1382
|
+
<li>
|
|
1383
|
+
|
|
1384
|
+
<span class='name'>metadata</span>
|
|
1385
|
+
|
|
1386
|
+
|
|
1387
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1388
|
+
|
|
1389
|
+
|
|
1390
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1391
|
+
|
|
1392
|
+
|
|
1393
|
+
—
|
|
1394
|
+
<div class='inline'>
|
|
1395
|
+
<p>arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes</p>
|
|
1396
|
+
</div>
|
|
1397
|
+
|
|
1398
|
+
</li>
|
|
1399
|
+
|
|
1400
|
+
</ul>
|
|
1401
|
+
|
|
1402
|
+
<p class="tag_title">Returns:</p>
|
|
1403
|
+
<ul class="return">
|
|
1404
|
+
|
|
1405
|
+
<li>
|
|
1406
|
+
|
|
1407
|
+
|
|
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>
|
|
1409
|
+
|
|
1410
|
+
|
|
1411
|
+
|
|
1412
|
+
—
|
|
1413
|
+
<div class='inline'>
|
|
1414
|
+
<p>result from the API request</p>
|
|
1415
|
+
</div>
|
|
1416
|
+
|
|
1417
|
+
</li>
|
|
1418
|
+
|
|
1419
|
+
</ul>
|
|
1420
|
+
|
|
1421
|
+
</div><table class="source_code">
|
|
1422
|
+
<tr>
|
|
1423
|
+
<td>
|
|
1424
|
+
<pre class="lines">
|
|
1425
|
+
|
|
1426
|
+
|
|
1427
|
+
171
|
|
1428
|
+
172
|
|
1429
|
+
173
|
|
1430
|
+
174
|
|
1431
|
+
175
|
|
1432
|
+
176
|
|
1433
|
+
177
|
|
1434
|
+
178
|
|
1435
|
+
179
|
|
1436
|
+
180
|
|
1437
|
+
181</pre>
|
|
1438
|
+
</td>
|
|
1439
|
+
<td>
|
|
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>
|
|
1444
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1445
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1446
|
+
<span class='rbrace'>}</span>
|
|
1447
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
1452
|
+
<span class='kw'>end</span></pre>
|
|
1453
|
+
</td>
|
|
1454
|
+
</tr>
|
|
1455
|
+
</table>
|
|
1456
|
+
</div>
|
|
1457
|
+
|
|
1458
|
+
<div class="method_details ">
|
|
1459
|
+
<h3 class="signature " id="update!-instance_method">
|
|
1460
|
+
|
|
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>
|
|
1462
|
+
|
|
1463
|
+
|
|
1464
|
+
|
|
1465
|
+
|
|
1466
|
+
|
|
1467
|
+
</h3><div class="docstring">
|
|
1468
|
+
<div class="discussion">
|
|
1469
|
+
|
|
1470
|
+
<p>Update attributes of an Agent Ingress by ID. Throws an exception if API error.</p>
|
|
1471
|
+
|
|
1472
|
+
<p><a href="https://ngrok.com/docs/api#api-agent-ingresses-update">ngrok.com/docs/api#api-agent-ingresses-update</a></p>
|
|
1473
|
+
|
|
1474
|
+
|
|
1475
|
+
</div>
|
|
1476
|
+
</div>
|
|
1477
|
+
<div class="tags">
|
|
1478
|
+
<p class="tag_title">Parameters:</p>
|
|
1479
|
+
<ul class="param">
|
|
1480
|
+
|
|
1481
|
+
<li>
|
|
1482
|
+
|
|
1483
|
+
<span class='name'>id</span>
|
|
1484
|
+
|
|
1485
|
+
|
|
1486
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1487
|
+
|
|
1488
|
+
|
|
1489
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1490
|
+
|
|
1491
|
+
|
|
1492
|
+
</li>
|
|
1493
|
+
|
|
1494
|
+
<li>
|
|
1495
|
+
|
|
1496
|
+
<span class='name'>description</span>
|
|
1497
|
+
|
|
1498
|
+
|
|
1499
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1500
|
+
|
|
1501
|
+
|
|
1502
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1503
|
+
|
|
1504
|
+
|
|
1505
|
+
—
|
|
1506
|
+
<div class='inline'>
|
|
1507
|
+
<p>human-readable description of the use of this Agent Ingress. optional, max 255 bytes.</p>
|
|
1508
|
+
</div>
|
|
1509
|
+
|
|
1510
|
+
</li>
|
|
1511
|
+
|
|
1512
|
+
<li>
|
|
1513
|
+
|
|
1514
|
+
<span class='name'>metadata</span>
|
|
1515
|
+
|
|
1516
|
+
|
|
1517
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1518
|
+
|
|
1519
|
+
|
|
1520
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1521
|
+
|
|
1522
|
+
|
|
1523
|
+
—
|
|
1524
|
+
<div class='inline'>
|
|
1525
|
+
<p>arbitrary user-defined machine-readable data of this Agent Ingress. optional, max 4096 bytes</p>
|
|
1526
|
+
</div>
|
|
1527
|
+
|
|
1528
|
+
</li>
|
|
1529
|
+
|
|
1530
|
+
</ul>
|
|
1531
|
+
|
|
1532
|
+
<p class="tag_title">Returns:</p>
|
|
1533
|
+
<ul class="return">
|
|
1534
|
+
|
|
1535
|
+
<li>
|
|
1536
|
+
|
|
1537
|
+
|
|
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>
|
|
1539
|
+
|
|
1540
|
+
|
|
1541
|
+
|
|
1542
|
+
—
|
|
1543
|
+
<div class='inline'>
|
|
1544
|
+
<p>result from the API request</p>
|
|
1545
|
+
</div>
|
|
1546
|
+
|
|
1547
|
+
</li>
|
|
1548
|
+
|
|
1549
|
+
</ul>
|
|
1550
|
+
|
|
1551
|
+
</div><table class="source_code">
|
|
1552
|
+
<tr>
|
|
1553
|
+
<td>
|
|
1554
|
+
<pre class="lines">
|
|
1555
|
+
|
|
1556
|
+
|
|
1557
|
+
193
|
|
1558
|
+
194
|
|
1559
|
+
195
|
|
1560
|
+
196
|
|
1561
|
+
197
|
|
1562
|
+
198
|
|
1563
|
+
199
|
|
1564
|
+
200
|
|
1565
|
+
201
|
|
1566
|
+
202
|
|
1567
|
+
203</pre>
|
|
1568
|
+
</td>
|
|
1569
|
+
<td>
|
|
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>
|
|
1574
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1575
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1576
|
+
<span class='rbrace'>}</span>
|
|
1577
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
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>
|
|
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>
|
|
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>
|
|
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>
|
|
1582
|
+
<span class='kw'>end</span></pre>
|
|
1583
|
+
</td>
|
|
1584
|
+
</tr>
|
|
1585
|
+
</table>
|
|
1586
|
+
</div>
|
|
1587
|
+
|
|
1588
|
+
</div>
|
|
1589
|
+
|
|
1590
|
+
</div>
|
|
1591
|
+
|
|
1592
|
+
<div id="footer">
|
|
1593
|
+
Generated on Thu Dec 2 18:48:54 2021 by
|
|
1594
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1595
|
+
0.9.27 (ruby-3.0.1).
|
|
1596
|
+
</div>
|
|
1597
|
+
|
|
1598
|
+
</div>
|
|
1599
|
+
</body>
|
|
1600
|
+
</html>
|