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,1792 @@
|
|
|
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::EventStreamsClient
|
|
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::EventStreamsClient";
|
|
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 (E)</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">EventStreamsClient</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::EventStreamsClient
|
|
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::EventStreamsClient</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/event_streams_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-event-streams">ngrok.com/docs/api#api-event-streams</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'>/event_streams</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'>event_streams</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>(metadata: "", description: "", fields: [], event_type: "", destination_ids: [], sampling_rate: 0) ⇒ NgrokAPI::Models::EventStream </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 Event Stream.</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 Event Stream.</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 Event Stream.</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::EventStream </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 detailed information about an Event Stream 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::EventStream </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 detailed information about an Event Stream 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:) ⇒ EventStreamsClient </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 EventStreamsClient.</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 Event Streams available on 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 Event Streams available on this account.</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: "", metadata: nil, description: nil, fields: nil, destination_ids: nil, sampling_rate: nil) ⇒ NgrokAPI::Models::EventStream </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 Event Stream 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: "", metadata: nil, description: nil, fields: nil, destination_ids: nil, sampling_rate: nil) ⇒ NgrokAPI::Models::EventStream </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 Event Stream 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::EventStreamsClient (class)">EventStreamsClient</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 EventStreamsClient.</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/event_streams_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/event_streams_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>(metadata: "", description: "", fields: [], event_type: "", destination_ids: [], sampling_rate: 0) ⇒ <tt><span class='object_link'><a href="../Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">NgrokAPI::Models::EventStream</a></span></tt>
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
</h3><div class="docstring">
|
|
559
|
+
<div class="discussion">
|
|
560
|
+
|
|
561
|
+
<p>Create a new Event Stream. It will not apply to anything until you associate it with one or more Endpoint Configs.</p>
|
|
562
|
+
|
|
563
|
+
<p><a href="https://ngrok.com/docs/api#api-event-streams-create">ngrok.com/docs/api#api-event-streams-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'>metadata</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>Arbitrary user-defined machine-readable data of this Event Stream. Optional, max 4096 bytes.</p>
|
|
586
|
+
</div>
|
|
587
|
+
|
|
588
|
+
</li>
|
|
589
|
+
|
|
590
|
+
<li>
|
|
591
|
+
|
|
592
|
+
<span class='name'>description</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>Human-readable description of the Event Stream. Optional, max 255 bytes.</p>
|
|
604
|
+
</div>
|
|
605
|
+
|
|
606
|
+
</li>
|
|
607
|
+
|
|
608
|
+
<li>
|
|
609
|
+
|
|
610
|
+
<span class='name'>fields</span>
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
<em class="default">(defaults to: <tt>[]</tt>)</em>
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
—
|
|
620
|
+
<div class='inline'>
|
|
621
|
+
<p>A list of protocol-specific fields you want to collect on each event.</p>
|
|
622
|
+
</div>
|
|
623
|
+
|
|
624
|
+
</li>
|
|
625
|
+
|
|
626
|
+
<li>
|
|
627
|
+
|
|
628
|
+
<span class='name'>event_type</span>
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
—
|
|
638
|
+
<div class='inline'>
|
|
639
|
+
<p>The protocol that determines which events will be collected. Supported values are <code>tcp_connection_closed</code> and <code>http_request_complete</code>.</p>
|
|
640
|
+
</div>
|
|
641
|
+
|
|
642
|
+
</li>
|
|
643
|
+
|
|
644
|
+
<li>
|
|
645
|
+
|
|
646
|
+
<span class='name'>destination_ids</span>
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
<em class="default">(defaults to: <tt>[]</tt>)</em>
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
—
|
|
656
|
+
<div class='inline'>
|
|
657
|
+
<p>A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.</p>
|
|
658
|
+
</div>
|
|
659
|
+
|
|
660
|
+
</li>
|
|
661
|
+
|
|
662
|
+
<li>
|
|
663
|
+
|
|
664
|
+
<span class='name'>sampling_rate</span>
|
|
665
|
+
|
|
666
|
+
|
|
667
|
+
<span class='type'>(<tt>float64</tt>)</span>
|
|
668
|
+
|
|
669
|
+
|
|
670
|
+
<em class="default">(defaults to: <tt>0</tt>)</em>
|
|
671
|
+
|
|
672
|
+
|
|
673
|
+
—
|
|
674
|
+
<div class='inline'>
|
|
675
|
+
<p>The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events.</p>
|
|
676
|
+
</div>
|
|
677
|
+
|
|
678
|
+
</li>
|
|
679
|
+
|
|
680
|
+
</ul>
|
|
681
|
+
|
|
682
|
+
<p class="tag_title">Returns:</p>
|
|
683
|
+
<ul class="return">
|
|
684
|
+
|
|
685
|
+
<li>
|
|
686
|
+
|
|
687
|
+
|
|
688
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">NgrokAPI::Models::EventStream</a></span></tt>)</span>
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
|
|
692
|
+
—
|
|
693
|
+
<div class='inline'>
|
|
694
|
+
<p>result from the API request</p>
|
|
695
|
+
</div>
|
|
696
|
+
|
|
697
|
+
</li>
|
|
698
|
+
|
|
699
|
+
</ul>
|
|
700
|
+
|
|
701
|
+
</div><table class="source_code">
|
|
702
|
+
<tr>
|
|
703
|
+
<td>
|
|
704
|
+
<pre class="lines">
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
32
|
|
708
|
+
33
|
|
709
|
+
34
|
|
710
|
+
35
|
|
711
|
+
36
|
|
712
|
+
37
|
|
713
|
+
38
|
|
714
|
+
39
|
|
715
|
+
40
|
|
716
|
+
41
|
|
717
|
+
42
|
|
718
|
+
43
|
|
719
|
+
44
|
|
720
|
+
45</pre>
|
|
721
|
+
</td>
|
|
722
|
+
<td>
|
|
723
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 32</span>
|
|
724
|
+
|
|
725
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</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'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>fields:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>event_type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>destination_ids:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>sampling_rate:</span> <span class='int'>0</span><span class='rparen'>)</span>
|
|
726
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/event_streams</span><span class='tstring_end'>'</span></span>
|
|
727
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
728
|
+
<span class='rbrace'>}</span>
|
|
729
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
730
|
+
<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>
|
|
731
|
+
<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>
|
|
732
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:fields</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_fields'>fields</span> <span class='kw'>if</span> <span class='id identifier rubyid_fields'>fields</span>
|
|
733
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:event_type</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_event_type'>event_type</span> <span class='kw'>if</span> <span class='id identifier rubyid_event_type'>event_type</span>
|
|
734
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:destination_ids</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_destination_ids'>destination_ids</span> <span class='kw'>if</span> <span class='id identifier rubyid_destination_ids'>destination_ids</span>
|
|
735
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:sampling_rate</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_sampling_rate'>sampling_rate</span> <span class='kw'>if</span> <span class='id identifier rubyid_sampling_rate'>sampling_rate</span>
|
|
736
|
+
<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>
|
|
737
|
+
<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/EventStream.html" title="NgrokAPI::Models::EventStream (class)">EventStream</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventStream.html#initialize-instance_method" title="NgrokAPI::Models::EventStream#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>
|
|
738
|
+
<span class='kw'>end</span></pre>
|
|
739
|
+
</td>
|
|
740
|
+
</tr>
|
|
741
|
+
</table>
|
|
742
|
+
</div>
|
|
743
|
+
|
|
744
|
+
<div class="method_details ">
|
|
745
|
+
<h3 class="signature " id="delete-instance_method">
|
|
746
|
+
|
|
747
|
+
#<strong>delete</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
748
|
+
|
|
749
|
+
|
|
750
|
+
|
|
751
|
+
|
|
752
|
+
|
|
753
|
+
</h3><div class="docstring">
|
|
754
|
+
<div class="discussion">
|
|
755
|
+
|
|
756
|
+
<p>Delete an Event Stream. Associated Event Destinations will be preserved.</p>
|
|
757
|
+
|
|
758
|
+
<p><a href="https://ngrok.com/docs/api#api-event-streams-delete">ngrok.com/docs/api#api-event-streams-delete</a></p>
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
</div>
|
|
762
|
+
</div>
|
|
763
|
+
<div class="tags">
|
|
764
|
+
<p class="tag_title">Parameters:</p>
|
|
765
|
+
<ul class="param">
|
|
766
|
+
|
|
767
|
+
<li>
|
|
768
|
+
|
|
769
|
+
<span class='name'>id</span>
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
776
|
+
|
|
777
|
+
|
|
778
|
+
—
|
|
779
|
+
<div class='inline'>
|
|
780
|
+
<p>a resource identifier</p>
|
|
781
|
+
</div>
|
|
782
|
+
|
|
783
|
+
</li>
|
|
784
|
+
|
|
785
|
+
</ul>
|
|
786
|
+
|
|
787
|
+
<p class="tag_title">Returns:</p>
|
|
788
|
+
<ul class="return">
|
|
789
|
+
|
|
790
|
+
<li>
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
794
|
+
|
|
795
|
+
|
|
796
|
+
|
|
797
|
+
—
|
|
798
|
+
<div class='inline'>
|
|
799
|
+
<p>result from the API request</p>
|
|
800
|
+
</div>
|
|
801
|
+
|
|
802
|
+
</li>
|
|
803
|
+
|
|
804
|
+
</ul>
|
|
805
|
+
|
|
806
|
+
</div><table class="source_code">
|
|
807
|
+
<tr>
|
|
808
|
+
<td>
|
|
809
|
+
<pre class="lines">
|
|
810
|
+
|
|
811
|
+
|
|
812
|
+
54
|
|
813
|
+
55
|
|
814
|
+
56
|
|
815
|
+
57
|
|
816
|
+
58
|
|
817
|
+
59
|
|
818
|
+
60</pre>
|
|
819
|
+
</td>
|
|
820
|
+
<td>
|
|
821
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 54</span>
|
|
822
|
+
|
|
823
|
+
<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>
|
|
824
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/event_streams/%{id}</span><span class='tstring_end'>'</span></span>
|
|
825
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
826
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
827
|
+
<span class='rbrace'>}</span>
|
|
828
|
+
<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>
|
|
829
|
+
<span class='kw'>end</span></pre>
|
|
830
|
+
</td>
|
|
831
|
+
</tr>
|
|
832
|
+
</table>
|
|
833
|
+
</div>
|
|
834
|
+
|
|
835
|
+
<div class="method_details ">
|
|
836
|
+
<h3 class="signature " id="delete!-instance_method">
|
|
837
|
+
|
|
838
|
+
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
839
|
+
|
|
840
|
+
|
|
841
|
+
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
</h3><div class="docstring">
|
|
845
|
+
<div class="discussion">
|
|
846
|
+
|
|
847
|
+
<p>Delete an Event Stream. Associated Event Destinations will be preserved. Throws an exception if API error.</p>
|
|
848
|
+
|
|
849
|
+
<p><a href="https://ngrok.com/docs/api#api-event-streams-delete">ngrok.com/docs/api#api-event-streams-delete</a></p>
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
</div>
|
|
853
|
+
</div>
|
|
854
|
+
<div class="tags">
|
|
855
|
+
<p class="tag_title">Parameters:</p>
|
|
856
|
+
<ul class="param">
|
|
857
|
+
|
|
858
|
+
<li>
|
|
859
|
+
|
|
860
|
+
<span class='name'>id</span>
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
864
|
+
|
|
865
|
+
|
|
866
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
—
|
|
870
|
+
<div class='inline'>
|
|
871
|
+
<p>a resource identifier</p>
|
|
872
|
+
</div>
|
|
873
|
+
|
|
874
|
+
</li>
|
|
875
|
+
|
|
876
|
+
</ul>
|
|
877
|
+
|
|
878
|
+
<p class="tag_title">Returns:</p>
|
|
879
|
+
<ul class="return">
|
|
880
|
+
|
|
881
|
+
<li>
|
|
882
|
+
|
|
883
|
+
|
|
884
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
885
|
+
|
|
886
|
+
|
|
887
|
+
|
|
888
|
+
—
|
|
889
|
+
<div class='inline'>
|
|
890
|
+
<p>result from the API request</p>
|
|
891
|
+
</div>
|
|
892
|
+
|
|
893
|
+
</li>
|
|
894
|
+
|
|
895
|
+
</ul>
|
|
896
|
+
|
|
897
|
+
</div><table class="source_code">
|
|
898
|
+
<tr>
|
|
899
|
+
<td>
|
|
900
|
+
<pre class="lines">
|
|
901
|
+
|
|
902
|
+
|
|
903
|
+
70
|
|
904
|
+
71
|
|
905
|
+
72
|
|
906
|
+
73
|
|
907
|
+
74
|
|
908
|
+
75
|
|
909
|
+
76</pre>
|
|
910
|
+
</td>
|
|
911
|
+
<td>
|
|
912
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 70</span>
|
|
913
|
+
|
|
914
|
+
<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>
|
|
915
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/event_streams/%{id}</span><span class='tstring_end'>'</span></span>
|
|
916
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
917
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
918
|
+
<span class='rbrace'>}</span>
|
|
919
|
+
<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>
|
|
920
|
+
<span class='kw'>end</span></pre>
|
|
921
|
+
</td>
|
|
922
|
+
</tr>
|
|
923
|
+
</table>
|
|
924
|
+
</div>
|
|
925
|
+
|
|
926
|
+
<div class="method_details ">
|
|
927
|
+
<h3 class="signature " id="get-instance_method">
|
|
928
|
+
|
|
929
|
+
#<strong>get</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">NgrokAPI::Models::EventStream</a></span></tt>
|
|
930
|
+
|
|
931
|
+
|
|
932
|
+
|
|
933
|
+
|
|
934
|
+
|
|
935
|
+
</h3><div class="docstring">
|
|
936
|
+
<div class="discussion">
|
|
937
|
+
|
|
938
|
+
<p>Get detailed information about an Event Stream by ID.</p>
|
|
939
|
+
|
|
940
|
+
<p><a href="https://ngrok.com/docs/api#api-event-streams-get">ngrok.com/docs/api#api-event-streams-get</a></p>
|
|
941
|
+
|
|
942
|
+
|
|
943
|
+
</div>
|
|
944
|
+
</div>
|
|
945
|
+
<div class="tags">
|
|
946
|
+
<p class="tag_title">Parameters:</p>
|
|
947
|
+
<ul class="param">
|
|
948
|
+
|
|
949
|
+
<li>
|
|
950
|
+
|
|
951
|
+
<span class='name'>id</span>
|
|
952
|
+
|
|
953
|
+
|
|
954
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
955
|
+
|
|
956
|
+
|
|
957
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
958
|
+
|
|
959
|
+
|
|
960
|
+
—
|
|
961
|
+
<div class='inline'>
|
|
962
|
+
<p>a resource identifier</p>
|
|
963
|
+
</div>
|
|
964
|
+
|
|
965
|
+
</li>
|
|
966
|
+
|
|
967
|
+
</ul>
|
|
968
|
+
|
|
969
|
+
<p class="tag_title">Returns:</p>
|
|
970
|
+
<ul class="return">
|
|
971
|
+
|
|
972
|
+
<li>
|
|
973
|
+
|
|
974
|
+
|
|
975
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">NgrokAPI::Models::EventStream</a></span></tt>)</span>
|
|
976
|
+
|
|
977
|
+
|
|
978
|
+
|
|
979
|
+
—
|
|
980
|
+
<div class='inline'>
|
|
981
|
+
<p>result from the API request</p>
|
|
982
|
+
</div>
|
|
983
|
+
|
|
984
|
+
</li>
|
|
985
|
+
|
|
986
|
+
</ul>
|
|
987
|
+
|
|
988
|
+
</div><table class="source_code">
|
|
989
|
+
<tr>
|
|
990
|
+
<td>
|
|
991
|
+
<pre class="lines">
|
|
992
|
+
|
|
993
|
+
|
|
994
|
+
85
|
|
995
|
+
86
|
|
996
|
+
87
|
|
997
|
+
88
|
|
998
|
+
89
|
|
999
|
+
90
|
|
1000
|
+
91
|
|
1001
|
+
92
|
|
1002
|
+
93</pre>
|
|
1003
|
+
</td>
|
|
1004
|
+
<td>
|
|
1005
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 85</span>
|
|
1006
|
+
|
|
1007
|
+
<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>
|
|
1008
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/event_streams/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1009
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1010
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1011
|
+
<span class='rbrace'>}</span>
|
|
1012
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1013
|
+
<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>
|
|
1014
|
+
<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/EventStream.html" title="NgrokAPI::Models::EventStream (class)">EventStream</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventStream.html#initialize-instance_method" title="NgrokAPI::Models::EventStream#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>
|
|
1015
|
+
<span class='kw'>end</span></pre>
|
|
1016
|
+
</td>
|
|
1017
|
+
</tr>
|
|
1018
|
+
</table>
|
|
1019
|
+
</div>
|
|
1020
|
+
|
|
1021
|
+
<div class="method_details ">
|
|
1022
|
+
<h3 class="signature " id="get!-instance_method">
|
|
1023
|
+
|
|
1024
|
+
#<strong>get!</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">NgrokAPI::Models::EventStream</a></span></tt>
|
|
1025
|
+
|
|
1026
|
+
|
|
1027
|
+
|
|
1028
|
+
|
|
1029
|
+
|
|
1030
|
+
</h3><div class="docstring">
|
|
1031
|
+
<div class="discussion">
|
|
1032
|
+
|
|
1033
|
+
<p>Get detailed information about an Event Stream by ID. Throws an exception if API error.</p>
|
|
1034
|
+
|
|
1035
|
+
<p><a href="https://ngrok.com/docs/api#api-event-streams-get">ngrok.com/docs/api#api-event-streams-get</a></p>
|
|
1036
|
+
|
|
1037
|
+
|
|
1038
|
+
</div>
|
|
1039
|
+
</div>
|
|
1040
|
+
<div class="tags">
|
|
1041
|
+
<p class="tag_title">Parameters:</p>
|
|
1042
|
+
<ul class="param">
|
|
1043
|
+
|
|
1044
|
+
<li>
|
|
1045
|
+
|
|
1046
|
+
<span class='name'>id</span>
|
|
1047
|
+
|
|
1048
|
+
|
|
1049
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1050
|
+
|
|
1051
|
+
|
|
1052
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1053
|
+
|
|
1054
|
+
|
|
1055
|
+
—
|
|
1056
|
+
<div class='inline'>
|
|
1057
|
+
<p>a resource identifier</p>
|
|
1058
|
+
</div>
|
|
1059
|
+
|
|
1060
|
+
</li>
|
|
1061
|
+
|
|
1062
|
+
</ul>
|
|
1063
|
+
|
|
1064
|
+
<p class="tag_title">Returns:</p>
|
|
1065
|
+
<ul class="return">
|
|
1066
|
+
|
|
1067
|
+
<li>
|
|
1068
|
+
|
|
1069
|
+
|
|
1070
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">NgrokAPI::Models::EventStream</a></span></tt>)</span>
|
|
1071
|
+
|
|
1072
|
+
|
|
1073
|
+
|
|
1074
|
+
—
|
|
1075
|
+
<div class='inline'>
|
|
1076
|
+
<p>result from the API request</p>
|
|
1077
|
+
</div>
|
|
1078
|
+
|
|
1079
|
+
</li>
|
|
1080
|
+
|
|
1081
|
+
</ul>
|
|
1082
|
+
|
|
1083
|
+
</div><table class="source_code">
|
|
1084
|
+
<tr>
|
|
1085
|
+
<td>
|
|
1086
|
+
<pre class="lines">
|
|
1087
|
+
|
|
1088
|
+
|
|
1089
|
+
103
|
|
1090
|
+
104
|
|
1091
|
+
105
|
|
1092
|
+
106
|
|
1093
|
+
107
|
|
1094
|
+
108
|
|
1095
|
+
109
|
|
1096
|
+
110
|
|
1097
|
+
111</pre>
|
|
1098
|
+
</td>
|
|
1099
|
+
<td>
|
|
1100
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 103</span>
|
|
1101
|
+
|
|
1102
|
+
<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>
|
|
1103
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/event_streams/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1104
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1105
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1106
|
+
<span class='rbrace'>}</span>
|
|
1107
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1108
|
+
<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>
|
|
1109
|
+
<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/EventStream.html" title="NgrokAPI::Models::EventStream (class)">EventStream</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventStream.html#initialize-instance_method" title="NgrokAPI::Models::EventStream#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>
|
|
1110
|
+
<span class='kw'>end</span></pre>
|
|
1111
|
+
</td>
|
|
1112
|
+
</tr>
|
|
1113
|
+
</table>
|
|
1114
|
+
</div>
|
|
1115
|
+
|
|
1116
|
+
<div class="method_details ">
|
|
1117
|
+
<h3 class="signature " id="list-instance_method">
|
|
1118
|
+
|
|
1119
|
+
#<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>
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
|
|
1123
|
+
|
|
1124
|
+
|
|
1125
|
+
</h3><div class="docstring">
|
|
1126
|
+
<div class="discussion">
|
|
1127
|
+
|
|
1128
|
+
<p>List all Event Streams available on this account.</p>
|
|
1129
|
+
|
|
1130
|
+
<p><a href="https://ngrok.com/docs/api#api-event-streams-list">ngrok.com/docs/api#api-event-streams-list</a></p>
|
|
1131
|
+
|
|
1132
|
+
|
|
1133
|
+
</div>
|
|
1134
|
+
</div>
|
|
1135
|
+
<div class="tags">
|
|
1136
|
+
<p class="tag_title">Parameters:</p>
|
|
1137
|
+
<ul class="param">
|
|
1138
|
+
|
|
1139
|
+
<li>
|
|
1140
|
+
|
|
1141
|
+
<span class='name'>before_id</span>
|
|
1142
|
+
|
|
1143
|
+
|
|
1144
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1145
|
+
|
|
1146
|
+
|
|
1147
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1148
|
+
|
|
1149
|
+
|
|
1150
|
+
</li>
|
|
1151
|
+
|
|
1152
|
+
<li>
|
|
1153
|
+
|
|
1154
|
+
<span class='name'>limit</span>
|
|
1155
|
+
|
|
1156
|
+
|
|
1157
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1158
|
+
|
|
1159
|
+
|
|
1160
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1161
|
+
|
|
1162
|
+
|
|
1163
|
+
</li>
|
|
1164
|
+
|
|
1165
|
+
<li>
|
|
1166
|
+
|
|
1167
|
+
<span class='name'>url</span>
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1171
|
+
|
|
1172
|
+
|
|
1173
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1174
|
+
|
|
1175
|
+
|
|
1176
|
+
—
|
|
1177
|
+
<div class='inline'>
|
|
1178
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
1179
|
+
</div>
|
|
1180
|
+
|
|
1181
|
+
</li>
|
|
1182
|
+
|
|
1183
|
+
</ul>
|
|
1184
|
+
|
|
1185
|
+
<p class="tag_title">Returns:</p>
|
|
1186
|
+
<ul class="return">
|
|
1187
|
+
|
|
1188
|
+
<li>
|
|
1189
|
+
|
|
1190
|
+
|
|
1191
|
+
<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>
|
|
1192
|
+
|
|
1193
|
+
|
|
1194
|
+
|
|
1195
|
+
—
|
|
1196
|
+
<div class='inline'>
|
|
1197
|
+
<p>result from the API request</p>
|
|
1198
|
+
</div>
|
|
1199
|
+
|
|
1200
|
+
</li>
|
|
1201
|
+
|
|
1202
|
+
</ul>
|
|
1203
|
+
|
|
1204
|
+
</div><table class="source_code">
|
|
1205
|
+
<tr>
|
|
1206
|
+
<td>
|
|
1207
|
+
<pre class="lines">
|
|
1208
|
+
|
|
1209
|
+
|
|
1210
|
+
122
|
|
1211
|
+
123
|
|
1212
|
+
124
|
|
1213
|
+
125
|
|
1214
|
+
126
|
|
1215
|
+
127
|
|
1216
|
+
128
|
|
1217
|
+
129
|
|
1218
|
+
130
|
|
1219
|
+
131
|
|
1220
|
+
132
|
|
1221
|
+
133
|
|
1222
|
+
134
|
|
1223
|
+
135
|
|
1224
|
+
136
|
|
1225
|
+
137</pre>
|
|
1226
|
+
</td>
|
|
1227
|
+
<td>
|
|
1228
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 122</span>
|
|
1229
|
+
|
|
1230
|
+
<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>
|
|
1231
|
+
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1232
|
+
<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>
|
|
1233
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1234
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1235
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1236
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EventStreamsClient::PATH (constant)">PATH</a></span></span>
|
|
1237
|
+
<span class='rparen'>)</span>
|
|
1238
|
+
|
|
1239
|
+
<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>
|
|
1240
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1241
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1242
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EventStreamsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1243
|
+
<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/EventStream.html" title="NgrokAPI::Models::EventStream (class)">EventStream</a></span></span>
|
|
1244
|
+
<span class='rparen'>)</span>
|
|
1245
|
+
<span class='kw'>end</span></pre>
|
|
1246
|
+
</td>
|
|
1247
|
+
</tr>
|
|
1248
|
+
</table>
|
|
1249
|
+
</div>
|
|
1250
|
+
|
|
1251
|
+
<div class="method_details ">
|
|
1252
|
+
<h3 class="signature " id="list!-instance_method">
|
|
1253
|
+
|
|
1254
|
+
#<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>
|
|
1255
|
+
|
|
1256
|
+
|
|
1257
|
+
|
|
1258
|
+
|
|
1259
|
+
|
|
1260
|
+
</h3><div class="docstring">
|
|
1261
|
+
<div class="discussion">
|
|
1262
|
+
|
|
1263
|
+
<p>List all Event Streams available on this account. Throws an exception if API error.</p>
|
|
1264
|
+
|
|
1265
|
+
<p><a href="https://ngrok.com/docs/api#api-event-streams-list">ngrok.com/docs/api#api-event-streams-list</a></p>
|
|
1266
|
+
|
|
1267
|
+
|
|
1268
|
+
</div>
|
|
1269
|
+
</div>
|
|
1270
|
+
<div class="tags">
|
|
1271
|
+
<p class="tag_title">Parameters:</p>
|
|
1272
|
+
<ul class="param">
|
|
1273
|
+
|
|
1274
|
+
<li>
|
|
1275
|
+
|
|
1276
|
+
<span class='name'>before_id</span>
|
|
1277
|
+
|
|
1278
|
+
|
|
1279
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1280
|
+
|
|
1281
|
+
|
|
1282
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1283
|
+
|
|
1284
|
+
|
|
1285
|
+
</li>
|
|
1286
|
+
|
|
1287
|
+
<li>
|
|
1288
|
+
|
|
1289
|
+
<span class='name'>limit</span>
|
|
1290
|
+
|
|
1291
|
+
|
|
1292
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1293
|
+
|
|
1294
|
+
|
|
1295
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1296
|
+
|
|
1297
|
+
|
|
1298
|
+
</li>
|
|
1299
|
+
|
|
1300
|
+
<li>
|
|
1301
|
+
|
|
1302
|
+
<span class='name'>url</span>
|
|
1303
|
+
|
|
1304
|
+
|
|
1305
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1306
|
+
|
|
1307
|
+
|
|
1308
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1309
|
+
|
|
1310
|
+
|
|
1311
|
+
—
|
|
1312
|
+
<div class='inline'>
|
|
1313
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
1314
|
+
</div>
|
|
1315
|
+
|
|
1316
|
+
</li>
|
|
1317
|
+
|
|
1318
|
+
</ul>
|
|
1319
|
+
|
|
1320
|
+
<p class="tag_title">Returns:</p>
|
|
1321
|
+
<ul class="return">
|
|
1322
|
+
|
|
1323
|
+
<li>
|
|
1324
|
+
|
|
1325
|
+
|
|
1326
|
+
<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>
|
|
1327
|
+
|
|
1328
|
+
|
|
1329
|
+
|
|
1330
|
+
—
|
|
1331
|
+
<div class='inline'>
|
|
1332
|
+
<p>result from the API request</p>
|
|
1333
|
+
</div>
|
|
1334
|
+
|
|
1335
|
+
</li>
|
|
1336
|
+
|
|
1337
|
+
</ul>
|
|
1338
|
+
|
|
1339
|
+
</div><table class="source_code">
|
|
1340
|
+
<tr>
|
|
1341
|
+
<td>
|
|
1342
|
+
<pre class="lines">
|
|
1343
|
+
|
|
1344
|
+
|
|
1345
|
+
149
|
|
1346
|
+
150
|
|
1347
|
+
151
|
|
1348
|
+
152
|
|
1349
|
+
153
|
|
1350
|
+
154
|
|
1351
|
+
155
|
|
1352
|
+
156
|
|
1353
|
+
157
|
|
1354
|
+
158
|
|
1355
|
+
159
|
|
1356
|
+
160
|
|
1357
|
+
161
|
|
1358
|
+
162
|
|
1359
|
+
163
|
|
1360
|
+
164
|
|
1361
|
+
165
|
|
1362
|
+
166</pre>
|
|
1363
|
+
</td>
|
|
1364
|
+
<td>
|
|
1365
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 149</span>
|
|
1366
|
+
|
|
1367
|
+
<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>
|
|
1368
|
+
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1369
|
+
<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>
|
|
1370
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1371
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1372
|
+
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
|
1373
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1374
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EventStreamsClient::PATH (constant)">PATH</a></span></span>
|
|
1375
|
+
<span class='rparen'>)</span>
|
|
1376
|
+
|
|
1377
|
+
<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>
|
|
1378
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1379
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1380
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EventStreamsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1381
|
+
<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/EventStream.html" title="NgrokAPI::Models::EventStream (class)">EventStream</a></span></span><span class='comma'>,</span>
|
|
1382
|
+
<span class='label'>danger:</span> <span class='kw'>true</span>
|
|
1383
|
+
<span class='rparen'>)</span>
|
|
1384
|
+
<span class='kw'>end</span></pre>
|
|
1385
|
+
</td>
|
|
1386
|
+
</tr>
|
|
1387
|
+
</table>
|
|
1388
|
+
</div>
|
|
1389
|
+
|
|
1390
|
+
<div class="method_details ">
|
|
1391
|
+
<h3 class="signature " id="update-instance_method">
|
|
1392
|
+
|
|
1393
|
+
#<strong>update</strong>(id: "", metadata: nil, description: nil, fields: nil, destination_ids: nil, sampling_rate: nil) ⇒ <tt><span class='object_link'><a href="../Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">NgrokAPI::Models::EventStream</a></span></tt>
|
|
1394
|
+
|
|
1395
|
+
|
|
1396
|
+
|
|
1397
|
+
|
|
1398
|
+
|
|
1399
|
+
</h3><div class="docstring">
|
|
1400
|
+
<div class="discussion">
|
|
1401
|
+
|
|
1402
|
+
<p>Update attributes of an Event Stream by ID.</p>
|
|
1403
|
+
|
|
1404
|
+
<p><a href="https://ngrok.com/docs/api#api-event-streams-update">ngrok.com/docs/api#api-event-streams-update</a></p>
|
|
1405
|
+
|
|
1406
|
+
|
|
1407
|
+
</div>
|
|
1408
|
+
</div>
|
|
1409
|
+
<div class="tags">
|
|
1410
|
+
<p class="tag_title">Parameters:</p>
|
|
1411
|
+
<ul class="param">
|
|
1412
|
+
|
|
1413
|
+
<li>
|
|
1414
|
+
|
|
1415
|
+
<span class='name'>id</span>
|
|
1416
|
+
|
|
1417
|
+
|
|
1418
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1419
|
+
|
|
1420
|
+
|
|
1421
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1422
|
+
|
|
1423
|
+
|
|
1424
|
+
—
|
|
1425
|
+
<div class='inline'>
|
|
1426
|
+
<p>Unique identifier for this Event Stream.</p>
|
|
1427
|
+
</div>
|
|
1428
|
+
|
|
1429
|
+
</li>
|
|
1430
|
+
|
|
1431
|
+
<li>
|
|
1432
|
+
|
|
1433
|
+
<span class='name'>metadata</span>
|
|
1434
|
+
|
|
1435
|
+
|
|
1436
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1437
|
+
|
|
1438
|
+
|
|
1439
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1440
|
+
|
|
1441
|
+
|
|
1442
|
+
—
|
|
1443
|
+
<div class='inline'>
|
|
1444
|
+
<p>Arbitrary user-defined machine-readable data of this Event Stream. Optional, max 4096 bytes.</p>
|
|
1445
|
+
</div>
|
|
1446
|
+
|
|
1447
|
+
</li>
|
|
1448
|
+
|
|
1449
|
+
<li>
|
|
1450
|
+
|
|
1451
|
+
<span class='name'>description</span>
|
|
1452
|
+
|
|
1453
|
+
|
|
1454
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1455
|
+
|
|
1456
|
+
|
|
1457
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1458
|
+
|
|
1459
|
+
|
|
1460
|
+
—
|
|
1461
|
+
<div class='inline'>
|
|
1462
|
+
<p>Human-readable description of the Event Stream. Optional, max 255 bytes.</p>
|
|
1463
|
+
</div>
|
|
1464
|
+
|
|
1465
|
+
</li>
|
|
1466
|
+
|
|
1467
|
+
<li>
|
|
1468
|
+
|
|
1469
|
+
<span class='name'>fields</span>
|
|
1470
|
+
|
|
1471
|
+
|
|
1472
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
|
1473
|
+
|
|
1474
|
+
|
|
1475
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1476
|
+
|
|
1477
|
+
|
|
1478
|
+
—
|
|
1479
|
+
<div class='inline'>
|
|
1480
|
+
<p>A list of protocol-specific fields you want to collect on each event.</p>
|
|
1481
|
+
</div>
|
|
1482
|
+
|
|
1483
|
+
</li>
|
|
1484
|
+
|
|
1485
|
+
<li>
|
|
1486
|
+
|
|
1487
|
+
<span class='name'>destination_ids</span>
|
|
1488
|
+
|
|
1489
|
+
|
|
1490
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
|
1491
|
+
|
|
1492
|
+
|
|
1493
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1494
|
+
|
|
1495
|
+
|
|
1496
|
+
—
|
|
1497
|
+
<div class='inline'>
|
|
1498
|
+
<p>A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.</p>
|
|
1499
|
+
</div>
|
|
1500
|
+
|
|
1501
|
+
</li>
|
|
1502
|
+
|
|
1503
|
+
<li>
|
|
1504
|
+
|
|
1505
|
+
<span class='name'>sampling_rate</span>
|
|
1506
|
+
|
|
1507
|
+
|
|
1508
|
+
<span class='type'>(<tt>float64</tt>)</span>
|
|
1509
|
+
|
|
1510
|
+
|
|
1511
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1512
|
+
|
|
1513
|
+
|
|
1514
|
+
—
|
|
1515
|
+
<div class='inline'>
|
|
1516
|
+
<p>The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events.</p>
|
|
1517
|
+
</div>
|
|
1518
|
+
|
|
1519
|
+
</li>
|
|
1520
|
+
|
|
1521
|
+
</ul>
|
|
1522
|
+
|
|
1523
|
+
<p class="tag_title">Returns:</p>
|
|
1524
|
+
<ul class="return">
|
|
1525
|
+
|
|
1526
|
+
<li>
|
|
1527
|
+
|
|
1528
|
+
|
|
1529
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">NgrokAPI::Models::EventStream</a></span></tt>)</span>
|
|
1530
|
+
|
|
1531
|
+
|
|
1532
|
+
|
|
1533
|
+
—
|
|
1534
|
+
<div class='inline'>
|
|
1535
|
+
<p>result from the API request</p>
|
|
1536
|
+
</div>
|
|
1537
|
+
|
|
1538
|
+
</li>
|
|
1539
|
+
|
|
1540
|
+
</ul>
|
|
1541
|
+
|
|
1542
|
+
</div><table class="source_code">
|
|
1543
|
+
<tr>
|
|
1544
|
+
<td>
|
|
1545
|
+
<pre class="lines">
|
|
1546
|
+
|
|
1547
|
+
|
|
1548
|
+
180
|
|
1549
|
+
181
|
|
1550
|
+
182
|
|
1551
|
+
183
|
|
1552
|
+
184
|
|
1553
|
+
185
|
|
1554
|
+
186
|
|
1555
|
+
187
|
|
1556
|
+
188
|
|
1557
|
+
189
|
|
1558
|
+
190
|
|
1559
|
+
191
|
|
1560
|
+
192
|
|
1561
|
+
193</pre>
|
|
1562
|
+
</td>
|
|
1563
|
+
<td>
|
|
1564
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 180</span>
|
|
1565
|
+
|
|
1566
|
+
<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'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>fields:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>destination_ids:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>sampling_rate:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1567
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/event_streams/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1568
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1569
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1570
|
+
<span class='rbrace'>}</span>
|
|
1571
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1572
|
+
<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>
|
|
1573
|
+
<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>
|
|
1574
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:fields</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_fields'>fields</span> <span class='kw'>if</span> <span class='id identifier rubyid_fields'>fields</span>
|
|
1575
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:destination_ids</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_destination_ids'>destination_ids</span> <span class='kw'>if</span> <span class='id identifier rubyid_destination_ids'>destination_ids</span>
|
|
1576
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:sampling_rate</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_sampling_rate'>sampling_rate</span> <span class='kw'>if</span> <span class='id identifier rubyid_sampling_rate'>sampling_rate</span>
|
|
1577
|
+
<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>
|
|
1578
|
+
<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/EventStream.html" title="NgrokAPI::Models::EventStream (class)">EventStream</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventStream.html#initialize-instance_method" title="NgrokAPI::Models::EventStream#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>
|
|
1579
|
+
<span class='kw'>end</span></pre>
|
|
1580
|
+
</td>
|
|
1581
|
+
</tr>
|
|
1582
|
+
</table>
|
|
1583
|
+
</div>
|
|
1584
|
+
|
|
1585
|
+
<div class="method_details ">
|
|
1586
|
+
<h3 class="signature " id="update!-instance_method">
|
|
1587
|
+
|
|
1588
|
+
#<strong>update!</strong>(id: "", metadata: nil, description: nil, fields: nil, destination_ids: nil, sampling_rate: nil) ⇒ <tt><span class='object_link'><a href="../Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">NgrokAPI::Models::EventStream</a></span></tt>
|
|
1589
|
+
|
|
1590
|
+
|
|
1591
|
+
|
|
1592
|
+
|
|
1593
|
+
|
|
1594
|
+
</h3><div class="docstring">
|
|
1595
|
+
<div class="discussion">
|
|
1596
|
+
|
|
1597
|
+
<p>Update attributes of an Event Stream by ID. Throws an exception if API error.</p>
|
|
1598
|
+
|
|
1599
|
+
<p><a href="https://ngrok.com/docs/api#api-event-streams-update">ngrok.com/docs/api#api-event-streams-update</a></p>
|
|
1600
|
+
|
|
1601
|
+
|
|
1602
|
+
</div>
|
|
1603
|
+
</div>
|
|
1604
|
+
<div class="tags">
|
|
1605
|
+
<p class="tag_title">Parameters:</p>
|
|
1606
|
+
<ul class="param">
|
|
1607
|
+
|
|
1608
|
+
<li>
|
|
1609
|
+
|
|
1610
|
+
<span class='name'>id</span>
|
|
1611
|
+
|
|
1612
|
+
|
|
1613
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1614
|
+
|
|
1615
|
+
|
|
1616
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1617
|
+
|
|
1618
|
+
|
|
1619
|
+
—
|
|
1620
|
+
<div class='inline'>
|
|
1621
|
+
<p>Unique identifier for this Event Stream.</p>
|
|
1622
|
+
</div>
|
|
1623
|
+
|
|
1624
|
+
</li>
|
|
1625
|
+
|
|
1626
|
+
<li>
|
|
1627
|
+
|
|
1628
|
+
<span class='name'>metadata</span>
|
|
1629
|
+
|
|
1630
|
+
|
|
1631
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1632
|
+
|
|
1633
|
+
|
|
1634
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1635
|
+
|
|
1636
|
+
|
|
1637
|
+
—
|
|
1638
|
+
<div class='inline'>
|
|
1639
|
+
<p>Arbitrary user-defined machine-readable data of this Event Stream. Optional, max 4096 bytes.</p>
|
|
1640
|
+
</div>
|
|
1641
|
+
|
|
1642
|
+
</li>
|
|
1643
|
+
|
|
1644
|
+
<li>
|
|
1645
|
+
|
|
1646
|
+
<span class='name'>description</span>
|
|
1647
|
+
|
|
1648
|
+
|
|
1649
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1650
|
+
|
|
1651
|
+
|
|
1652
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1653
|
+
|
|
1654
|
+
|
|
1655
|
+
—
|
|
1656
|
+
<div class='inline'>
|
|
1657
|
+
<p>Human-readable description of the Event Stream. Optional, max 255 bytes.</p>
|
|
1658
|
+
</div>
|
|
1659
|
+
|
|
1660
|
+
</li>
|
|
1661
|
+
|
|
1662
|
+
<li>
|
|
1663
|
+
|
|
1664
|
+
<span class='name'>fields</span>
|
|
1665
|
+
|
|
1666
|
+
|
|
1667
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
|
1668
|
+
|
|
1669
|
+
|
|
1670
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1671
|
+
|
|
1672
|
+
|
|
1673
|
+
—
|
|
1674
|
+
<div class='inline'>
|
|
1675
|
+
<p>A list of protocol-specific fields you want to collect on each event.</p>
|
|
1676
|
+
</div>
|
|
1677
|
+
|
|
1678
|
+
</li>
|
|
1679
|
+
|
|
1680
|
+
<li>
|
|
1681
|
+
|
|
1682
|
+
<span class='name'>destination_ids</span>
|
|
1683
|
+
|
|
1684
|
+
|
|
1685
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
|
1686
|
+
|
|
1687
|
+
|
|
1688
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1689
|
+
|
|
1690
|
+
|
|
1691
|
+
—
|
|
1692
|
+
<div class='inline'>
|
|
1693
|
+
<p>A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.</p>
|
|
1694
|
+
</div>
|
|
1695
|
+
|
|
1696
|
+
</li>
|
|
1697
|
+
|
|
1698
|
+
<li>
|
|
1699
|
+
|
|
1700
|
+
<span class='name'>sampling_rate</span>
|
|
1701
|
+
|
|
1702
|
+
|
|
1703
|
+
<span class='type'>(<tt>float64</tt>)</span>
|
|
1704
|
+
|
|
1705
|
+
|
|
1706
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1707
|
+
|
|
1708
|
+
|
|
1709
|
+
—
|
|
1710
|
+
<div class='inline'>
|
|
1711
|
+
<p>The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events.</p>
|
|
1712
|
+
</div>
|
|
1713
|
+
|
|
1714
|
+
</li>
|
|
1715
|
+
|
|
1716
|
+
</ul>
|
|
1717
|
+
|
|
1718
|
+
<p class="tag_title">Returns:</p>
|
|
1719
|
+
<ul class="return">
|
|
1720
|
+
|
|
1721
|
+
<li>
|
|
1722
|
+
|
|
1723
|
+
|
|
1724
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">NgrokAPI::Models::EventStream</a></span></tt>)</span>
|
|
1725
|
+
|
|
1726
|
+
|
|
1727
|
+
|
|
1728
|
+
—
|
|
1729
|
+
<div class='inline'>
|
|
1730
|
+
<p>result from the API request</p>
|
|
1731
|
+
</div>
|
|
1732
|
+
|
|
1733
|
+
</li>
|
|
1734
|
+
|
|
1735
|
+
</ul>
|
|
1736
|
+
|
|
1737
|
+
</div><table class="source_code">
|
|
1738
|
+
<tr>
|
|
1739
|
+
<td>
|
|
1740
|
+
<pre class="lines">
|
|
1741
|
+
|
|
1742
|
+
|
|
1743
|
+
208
|
|
1744
|
+
209
|
|
1745
|
+
210
|
|
1746
|
+
211
|
|
1747
|
+
212
|
|
1748
|
+
213
|
|
1749
|
+
214
|
|
1750
|
+
215
|
|
1751
|
+
216
|
|
1752
|
+
217
|
|
1753
|
+
218
|
|
1754
|
+
219
|
|
1755
|
+
220
|
|
1756
|
+
221</pre>
|
|
1757
|
+
</td>
|
|
1758
|
+
<td>
|
|
1759
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 208</span>
|
|
1760
|
+
|
|
1761
|
+
<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'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>fields:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>destination_ids:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>sampling_rate:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1762
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/event_streams/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1763
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1764
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1765
|
+
<span class='rbrace'>}</span>
|
|
1766
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1767
|
+
<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>
|
|
1768
|
+
<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>
|
|
1769
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:fields</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_fields'>fields</span> <span class='kw'>if</span> <span class='id identifier rubyid_fields'>fields</span>
|
|
1770
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:destination_ids</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_destination_ids'>destination_ids</span> <span class='kw'>if</span> <span class='id identifier rubyid_destination_ids'>destination_ids</span>
|
|
1771
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:sampling_rate</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_sampling_rate'>sampling_rate</span> <span class='kw'>if</span> <span class='id identifier rubyid_sampling_rate'>sampling_rate</span>
|
|
1772
|
+
<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>
|
|
1773
|
+
<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/EventStream.html" title="NgrokAPI::Models::EventStream (class)">EventStream</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventStream.html#initialize-instance_method" title="NgrokAPI::Models::EventStream#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>
|
|
1774
|
+
<span class='kw'>end</span></pre>
|
|
1775
|
+
</td>
|
|
1776
|
+
</tr>
|
|
1777
|
+
</table>
|
|
1778
|
+
</div>
|
|
1779
|
+
|
|
1780
|
+
</div>
|
|
1781
|
+
|
|
1782
|
+
</div>
|
|
1783
|
+
|
|
1784
|
+
<div id="footer">
|
|
1785
|
+
Generated on Thu Dec 2 18:48:53 2021 by
|
|
1786
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1787
|
+
0.9.27 (ruby-3.0.1).
|
|
1788
|
+
</div>
|
|
1789
|
+
|
|
1790
|
+
</div>
|
|
1791
|
+
</body>
|
|
1792
|
+
</html>
|