ngrok-api 0.9.0 → 0.12.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rubocop.yml +1 -1
- data/doc/.gitkeep +0 -0
- data/doc/NgrokAPI/Client.html +1499 -125
- data/doc/NgrokAPI/Error.html +1 -1
- data/doc/NgrokAPI/Errors/NotFoundError.html +1 -1
- data/doc/NgrokAPI/Errors.html +1 -1
- data/doc/NgrokAPI/HttpClient.html +1 -1
- data/doc/NgrokAPI/Models/{ApiKey.html → APIKey.html} +108 -177
- 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/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 +1321 -510
- 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/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/IPPolicy.html +1069 -0
- data/doc/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/doc/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/doc/NgrokAPI/Models/{TlsCertificate.html → IPWhitelistEntry.html} +168 -163
- data/doc/NgrokAPI/Models/Listable.html +1 -1
- data/doc/NgrokAPI/Models/Ref.html +617 -0
- data/doc/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/doc/NgrokAPI/Models/ReservedDomain.html +111 -1107
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +839 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertNSTarget.html +617 -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 +4 -4
- data/doc/NgrokAPI/PagedIterator.html +1 -1
- data/{docs/NgrokAPI/Services/ApiKeysClient.html → doc/NgrokAPI/Services/APIKeysClient.html} +287 -151
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +723 -0
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +1489 -0
- data/doc/NgrokAPI/Services/CredentialsClient.html +1534 -0
- data/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +473 -371
- data/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +1609 -0
- data/doc/NgrokAPI/Services/EventSourcesClient.html +1348 -0
- data/doc/NgrokAPI/Services/EventStreamsClient.html +1691 -0
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +1603 -0
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +1488 -0
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +1550 -0
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +1620 -0
- data/doc/NgrokAPI/Services/IPWhitelistClient.html +1488 -0
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +1793 -0
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +518 -333
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1532 -0
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +1552 -0
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +1573 -0
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +1617 -0
- data/{docs/NgrokAPI/Services/TlsCertificatesClient.html → doc/NgrokAPI/Services/TLSCertificatesClient.html} +290 -198
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +1468 -0
- data/doc/NgrokAPI/Services/TunnelsClient.html +513 -0
- data/doc/NgrokAPI/Services.html +4 -4
- data/doc/NgrokAPI.html +3 -3
- data/doc/_index.html +624 -28
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +1 -1
- data/doc/index.html +1 -1
- data/doc/method_list.html +7318 -286
- data/doc/top-level-namespace.html +1 -1
- data/docs/.gitkeep +0 -0
- data/docs/NgrokAPI/Client.html +1499 -125
- data/docs/NgrokAPI/Error.html +1 -1
- data/docs/NgrokAPI/Errors/NotFoundError.html +1 -1
- data/docs/NgrokAPI/Errors.html +1 -1
- data/docs/NgrokAPI/HttpClient.html +1 -1
- data/docs/NgrokAPI/Models/{ApiKey.html → APIKey.html} +108 -177
- 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/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 +1321 -510
- 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/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/IPPolicy.html +1069 -0
- data/docs/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/docs/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/docs/NgrokAPI/Models/{TlsCertificate.html → IPWhitelistEntry.html} +168 -163
- data/docs/NgrokAPI/Models/Listable.html +1 -1
- data/docs/NgrokAPI/Models/Ref.html +617 -0
- data/docs/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/docs/NgrokAPI/Models/ReservedDomain.html +111 -1107
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +839 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertNSTarget.html +617 -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 +4 -4
- data/docs/NgrokAPI/PagedIterator.html +1 -1
- data/{doc/NgrokAPI/Services/ApiKeysClient.html → docs/NgrokAPI/Services/APIKeysClient.html} +287 -151
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +723 -0
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +1489 -0
- data/docs/NgrokAPI/Services/CredentialsClient.html +1534 -0
- data/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +473 -371
- data/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +1609 -0
- data/docs/NgrokAPI/Services/EventSourcesClient.html +1348 -0
- data/docs/NgrokAPI/Services/EventStreamsClient.html +1691 -0
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +1603 -0
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +1488 -0
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +1550 -0
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +1620 -0
- data/docs/NgrokAPI/Services/IPWhitelistClient.html +1488 -0
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +1793 -0
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +518 -333
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1532 -0
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +1552 -0
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +1573 -0
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +1617 -0
- data/{doc/NgrokAPI/Services/TlsCertificatesClient.html → docs/NgrokAPI/Services/TLSCertificatesClient.html} +290 -198
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +1468 -0
- data/docs/NgrokAPI/Services/TunnelsClient.html +513 -0
- data/docs/NgrokAPI/Services.html +4 -4
- data/docs/NgrokAPI.html +3 -3
- data/docs/_index.html +624 -28
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +1 -1
- data/docs/index.html +1 -1
- data/docs/method_list.html +7318 -286
- data/docs/top-level-namespace.html +1 -1
- data/lib/ngrokapi/client.rb +218 -49
- data/lib/ngrokapi/models/abuse_report.rb +37 -0
- data/lib/ngrokapi/models/abuse_report_hostname.rb +27 -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_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/ip_whitelist_entry.rb +62 -0
- data/lib/ngrokapi/models/ref.rb +27 -0
- data/lib/ngrokapi/models/reserved_addr.rb +49 -0
- data/lib/ngrokapi/models/reserved_domain.rb +59 -211
- data/lib/ngrokapi/models/reserved_domain_cert_job.rb +33 -0
- data/lib/ngrokapi/models/reserved_domain_cert_ns_target.rb +27 -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/services/.gitkeep +0 -0
- data/lib/ngrokapi/services/abuse_reports_client.rb +84 -0
- data/lib/ngrokapi/services/api_keys_client.rb +203 -144
- data/lib/ngrokapi/services/certificate_authorities_client.rb +204 -0
- data/lib/ngrokapi/services/credentials_client.rb +212 -0
- data/lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_compression_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +324 -313
- data/lib/ngrokapi/services/endpoint_ip_policy_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_logging_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_o_auth_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_oidc_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_request_headers_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_response_headers_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_saml_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_tls_termination_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb +122 -0
- data/lib/ngrokapi/services/event_destinations_client.rb +222 -0
- data/lib/ngrokapi/services/event_sources_client.rb +177 -0
- data/lib/ngrokapi/services/event_streams_client.rb +226 -0
- data/lib/ngrokapi/services/event_subscriptions_client.rb +213 -0
- data/lib/ngrokapi/services/ip_policies_client.rb +208 -0
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +210 -0
- data/lib/ngrokapi/services/ip_restrictions_client.rb +223 -0
- data/lib/ngrokapi/services/ip_whitelist_client.rb +202 -0
- data/lib/ngrokapi/services/reserved_addrs_client.rb +246 -0
- data/lib/ngrokapi/services/reserved_domains_client.rb +382 -313
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +207 -0
- data/lib/ngrokapi/services/ssh_credentials_client.rb +211 -0
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +214 -0
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +220 -0
- data/lib/ngrokapi/services/tls_certificates_client.rb +207 -161
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +228 -0
- data/lib/ngrokapi/services/tunnels_client.rb +51 -0
- data/lib/ngrokapi/version.rb +1 -1
- data/spec/ngrokapi/client_spec.rb +139 -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/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_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/ip_whitelist_entry_spec.rb +42 -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_ns_target_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 +5 -5
- data/spec/ngrokapi/services/.gitkeep +0 -0
- data/spec/ngrokapi/services/abuse_reports_client_spec.rb +67 -0
- data/spec/ngrokapi/services/api_keys_client_spec.rb +160 -127
- data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +162 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +166 -0
- data/spec/ngrokapi/services/endpoint_circuit_breaker_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_compression_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +240 -0
- data/spec/ngrokapi/services/endpoint_ip_policy_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_mutual_tls_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_o_auth_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_oidc_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_request_headers_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_response_headers_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_saml_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_tls_termination_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_webhook_validation_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/event_destinations_client_spec.rb +175 -0
- data/spec/ngrokapi/services/event_sources_client_spec.rb +162 -0
- data/spec/ngrokapi/services/event_streams_client_spec.rb +180 -0
- data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +172 -0
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +162 -0
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +168 -0
- data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +174 -0
- data/spec/ngrokapi/services/ip_whitelist_client_spec.rb +162 -0
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +209 -0
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +352 -0
- data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +166 -0
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +168 -0
- data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +170 -0
- data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +174 -0
- data/spec/ngrokapi/services/tls_certificates_client_spec.rb +164 -0
- data/spec/ngrokapi/services/tunnel_sessions_client_spec.rb +184 -0
- data/spec/ngrokapi/services/tunnels_client_spec.rb +21 -0
- data/spec/spec_helper.rb +958 -0
- metadata +355 -10
|
@@ -0,0 +1,1609 @@
|
|
|
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::EventDestinationsClient
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.26
|
|
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::EventDestinationsClient";
|
|
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">EventDestinationsClient</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::EventDestinationsClient
|
|
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::EventDestinationsClient</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_destinations_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-destinations">ngrok.com/docs/api#api-event-destinations</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_destinations</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_destinations</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: "", format: "", target: nil, verify_with_test_event: nil) ⇒ NgrokAPI::Models::EventDestination </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 Destination.</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 Destination.</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 Destination.</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::EventDestination </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 Destination 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::EventDestination </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 Destination 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:) ⇒ EventDestinationsClient </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 EventDestinationsClient.</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 Destinations 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="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", metadata: nil, description: nil, format: nil, target: nil, verify_with_test_event: nil) ⇒ NgrokAPI::Models::EventDestination </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>Update attributes of an Event Destination.</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, format: nil, target: nil, verify_with_test_event: nil) ⇒ NgrokAPI::Models::EventDestination </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 Destination.</p>
|
|
418
|
+
</div></span>
|
|
419
|
+
|
|
420
|
+
</li>
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
</ul>
|
|
424
|
+
|
|
425
|
+
|
|
426
|
+
<div id="constructor_details" class="method_details_list">
|
|
427
|
+
<h2>Constructor Details</h2>
|
|
428
|
+
|
|
429
|
+
<div class="method_details first">
|
|
430
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
431
|
+
|
|
432
|
+
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::EventDestinationsClient (class)">EventDestinationsClient</a></span></tt>
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
</h3><div class="docstring">
|
|
439
|
+
<div class="discussion">
|
|
440
|
+
|
|
441
|
+
<p>Returns a new instance of EventDestinationsClient.</p>
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
</div>
|
|
445
|
+
</div>
|
|
446
|
+
<div class="tags">
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
</div><table class="source_code">
|
|
450
|
+
<tr>
|
|
451
|
+
<td>
|
|
452
|
+
<pre class="lines">
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
15
|
|
456
|
+
16
|
|
457
|
+
17</pre>
|
|
458
|
+
</td>
|
|
459
|
+
<td>
|
|
460
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 15</span>
|
|
461
|
+
|
|
462
|
+
<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>
|
|
463
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
464
|
+
<span class='kw'>end</span></pre>
|
|
465
|
+
</td>
|
|
466
|
+
</tr>
|
|
467
|
+
</table>
|
|
468
|
+
</div>
|
|
469
|
+
|
|
470
|
+
</div>
|
|
471
|
+
|
|
472
|
+
<div id="instance_attr_details" class="attr_details">
|
|
473
|
+
<h2>Instance Attribute Details</h2>
|
|
474
|
+
|
|
475
|
+
|
|
476
|
+
<span id=""></span>
|
|
477
|
+
<div class="method_details first">
|
|
478
|
+
<h3 class="signature first" id="client-instance_method">
|
|
479
|
+
|
|
480
|
+
#<strong>client</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
</h3><div class="docstring">
|
|
487
|
+
<div class="discussion">
|
|
488
|
+
|
|
489
|
+
<p>Returns the value of attribute client.</p>
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
</div>
|
|
493
|
+
</div>
|
|
494
|
+
<div class="tags">
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
</div><table class="source_code">
|
|
498
|
+
<tr>
|
|
499
|
+
<td>
|
|
500
|
+
<pre class="lines">
|
|
501
|
+
|
|
502
|
+
|
|
503
|
+
13
|
|
504
|
+
14
|
|
505
|
+
15</pre>
|
|
506
|
+
</td>
|
|
507
|
+
<td>
|
|
508
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 13</span>
|
|
509
|
+
|
|
510
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
|
511
|
+
<span class='ivar'>@client</span>
|
|
512
|
+
<span class='kw'>end</span></pre>
|
|
513
|
+
</td>
|
|
514
|
+
</tr>
|
|
515
|
+
</table>
|
|
516
|
+
</div>
|
|
517
|
+
|
|
518
|
+
</div>
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
<div id="instance_method_details" class="method_details_list">
|
|
522
|
+
<h2>Instance Method Details</h2>
|
|
523
|
+
|
|
524
|
+
|
|
525
|
+
<div class="method_details first">
|
|
526
|
+
<h3 class="signature first" id="create-instance_method">
|
|
527
|
+
|
|
528
|
+
#<strong>create</strong>(metadata: "", description: "", format: "", target: nil, verify_with_test_event: nil) ⇒ <tt><span class='object_link'><a href="../Models/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">NgrokAPI::Models::EventDestination</a></span></tt>
|
|
529
|
+
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
|
|
534
|
+
</h3><div class="docstring">
|
|
535
|
+
<div class="discussion">
|
|
536
|
+
|
|
537
|
+
<p>Create a new Event Destination. It will not apply to anything until it is associated with an Event Stream, and that Event Stream is associated with an Endpoint Config.</p>
|
|
538
|
+
|
|
539
|
+
<p><a href="https://ngrok.com/docs/api#api-event-destinations-create">ngrok.com/docs/api#api-event-destinations-create</a></p>
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
</div>
|
|
543
|
+
</div>
|
|
544
|
+
<div class="tags">
|
|
545
|
+
<p class="tag_title">Parameters:</p>
|
|
546
|
+
<ul class="param">
|
|
547
|
+
|
|
548
|
+
<li>
|
|
549
|
+
|
|
550
|
+
<span class='name'>metadata</span>
|
|
551
|
+
|
|
552
|
+
|
|
553
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
—
|
|
560
|
+
<div class='inline'>
|
|
561
|
+
<p>Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.</p>
|
|
562
|
+
</div>
|
|
563
|
+
|
|
564
|
+
</li>
|
|
565
|
+
|
|
566
|
+
<li>
|
|
567
|
+
|
|
568
|
+
<span class='name'>description</span>
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
572
|
+
|
|
573
|
+
|
|
574
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
—
|
|
578
|
+
<div class='inline'>
|
|
579
|
+
<p>Human-readable description of the Event Destination. Optional, max 255 bytes.</p>
|
|
580
|
+
</div>
|
|
581
|
+
|
|
582
|
+
</li>
|
|
583
|
+
|
|
584
|
+
<li>
|
|
585
|
+
|
|
586
|
+
<span class='name'>format</span>
|
|
587
|
+
|
|
588
|
+
|
|
589
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
590
|
+
|
|
591
|
+
|
|
592
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
—
|
|
596
|
+
<div class='inline'>
|
|
597
|
+
<p>The output format you would like to serialize events into when sending to their target. Currently the only accepted value is “JSON“.</p>
|
|
598
|
+
</div>
|
|
599
|
+
|
|
600
|
+
</li>
|
|
601
|
+
|
|
602
|
+
<li>
|
|
603
|
+
|
|
604
|
+
<span class='name'>target</span>
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
<span class='type'>(<tt>EventTarget</tt>)</span>
|
|
608
|
+
|
|
609
|
+
|
|
610
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
—
|
|
614
|
+
<div class='inline'>
|
|
615
|
+
<p>An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: “kinesis“, “firehose“, “cloudwatch_logs“, or “s3“.</p>
|
|
616
|
+
</div>
|
|
617
|
+
|
|
618
|
+
</li>
|
|
619
|
+
|
|
620
|
+
</ul>
|
|
621
|
+
|
|
622
|
+
<p class="tag_title">Returns:</p>
|
|
623
|
+
<ul class="return">
|
|
624
|
+
|
|
625
|
+
<li>
|
|
626
|
+
|
|
627
|
+
|
|
628
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">NgrokAPI::Models::EventDestination</a></span></tt>)</span>
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
|
|
632
|
+
—
|
|
633
|
+
<div class='inline'>
|
|
634
|
+
<p>result from the API request</p>
|
|
635
|
+
</div>
|
|
636
|
+
|
|
637
|
+
</li>
|
|
638
|
+
|
|
639
|
+
</ul>
|
|
640
|
+
|
|
641
|
+
</div><table class="source_code">
|
|
642
|
+
<tr>
|
|
643
|
+
<td>
|
|
644
|
+
<pre class="lines">
|
|
645
|
+
|
|
646
|
+
|
|
647
|
+
31
|
|
648
|
+
32
|
|
649
|
+
33
|
|
650
|
+
34
|
|
651
|
+
35
|
|
652
|
+
36
|
|
653
|
+
37
|
|
654
|
+
38
|
|
655
|
+
39
|
|
656
|
+
40
|
|
657
|
+
41
|
|
658
|
+
42
|
|
659
|
+
43
|
|
660
|
+
44
|
|
661
|
+
45
|
|
662
|
+
46
|
|
663
|
+
47
|
|
664
|
+
48</pre>
|
|
665
|
+
</td>
|
|
666
|
+
<td>
|
|
667
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 31</span>
|
|
668
|
+
|
|
669
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span>
|
|
670
|
+
<span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
671
|
+
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
672
|
+
<span class='label'>format:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
673
|
+
<span class='label'>target:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
674
|
+
<span class='label'>verify_with_test_event:</span> <span class='kw'>nil</span>
|
|
675
|
+
<span class='rparen'>)</span>
|
|
676
|
+
<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_destinations</span><span class='tstring_end'>'</span></span>
|
|
677
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
678
|
+
<span class='rbrace'>}</span>
|
|
679
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
680
|
+
<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>
|
|
681
|
+
<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>
|
|
682
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:format</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_format'>format</span> <span class='kw'>if</span> <span class='id identifier rubyid_format'>format</span>
|
|
683
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:target</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_target'>target</span> <span class='kw'>if</span> <span class='id identifier rubyid_target'>target</span>
|
|
684
|
+
<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>
|
|
685
|
+
<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/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">EventDestination</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventDestination.html#initialize-instance_method" title="NgrokAPI::Models::EventDestination#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>
|
|
686
|
+
<span class='kw'>end</span></pre>
|
|
687
|
+
</td>
|
|
688
|
+
</tr>
|
|
689
|
+
</table>
|
|
690
|
+
</div>
|
|
691
|
+
|
|
692
|
+
<div class="method_details ">
|
|
693
|
+
<h3 class="signature " id="delete-instance_method">
|
|
694
|
+
|
|
695
|
+
#<strong>delete</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
696
|
+
|
|
697
|
+
|
|
698
|
+
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
</h3><div class="docstring">
|
|
702
|
+
<div class="discussion">
|
|
703
|
+
|
|
704
|
+
<p>Delete an Event Destination. If the Event Destination is still referenced by an Event Stream, this will throw an error until that Event Stream has removed that reference.</p>
|
|
705
|
+
|
|
706
|
+
<p><a href="https://ngrok.com/docs/api#api-event-destinations-delete">ngrok.com/docs/api#api-event-destinations-delete</a></p>
|
|
707
|
+
|
|
708
|
+
|
|
709
|
+
</div>
|
|
710
|
+
</div>
|
|
711
|
+
<div class="tags">
|
|
712
|
+
<p class="tag_title">Parameters:</p>
|
|
713
|
+
<ul class="param">
|
|
714
|
+
|
|
715
|
+
<li>
|
|
716
|
+
|
|
717
|
+
<span class='name'>id</span>
|
|
718
|
+
|
|
719
|
+
|
|
720
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
724
|
+
|
|
725
|
+
|
|
726
|
+
—
|
|
727
|
+
<div class='inline'>
|
|
728
|
+
<p>a resource identifier</p>
|
|
729
|
+
</div>
|
|
730
|
+
|
|
731
|
+
</li>
|
|
732
|
+
|
|
733
|
+
</ul>
|
|
734
|
+
|
|
735
|
+
<p class="tag_title">Returns:</p>
|
|
736
|
+
<ul class="return">
|
|
737
|
+
|
|
738
|
+
<li>
|
|
739
|
+
|
|
740
|
+
|
|
741
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
742
|
+
|
|
743
|
+
|
|
744
|
+
|
|
745
|
+
—
|
|
746
|
+
<div class='inline'>
|
|
747
|
+
<p>result from the API request</p>
|
|
748
|
+
</div>
|
|
749
|
+
|
|
750
|
+
</li>
|
|
751
|
+
|
|
752
|
+
</ul>
|
|
753
|
+
|
|
754
|
+
</div><table class="source_code">
|
|
755
|
+
<tr>
|
|
756
|
+
<td>
|
|
757
|
+
<pre class="lines">
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
59
|
|
761
|
+
60
|
|
762
|
+
61
|
|
763
|
+
62
|
|
764
|
+
63
|
|
765
|
+
64
|
|
766
|
+
65
|
|
767
|
+
66
|
|
768
|
+
67</pre>
|
|
769
|
+
</td>
|
|
770
|
+
<td>
|
|
771
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 59</span>
|
|
772
|
+
|
|
773
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span>
|
|
774
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
775
|
+
<span class='rparen'>)</span>
|
|
776
|
+
<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_destinations/%{id}</span><span class='tstring_end'>'</span></span>
|
|
777
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
778
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
779
|
+
<span class='rbrace'>}</span>
|
|
780
|
+
<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>
|
|
781
|
+
<span class='kw'>end</span></pre>
|
|
782
|
+
</td>
|
|
783
|
+
</tr>
|
|
784
|
+
</table>
|
|
785
|
+
</div>
|
|
786
|
+
|
|
787
|
+
<div class="method_details ">
|
|
788
|
+
<h3 class="signature " id="delete!-instance_method">
|
|
789
|
+
|
|
790
|
+
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
791
|
+
|
|
792
|
+
|
|
793
|
+
|
|
794
|
+
|
|
795
|
+
|
|
796
|
+
</h3><div class="docstring">
|
|
797
|
+
<div class="discussion">
|
|
798
|
+
|
|
799
|
+
<p>Delete an Event Destination. If the Event Destination is still referenced by an Event Stream, this will throw an error until that Event Stream has removed that reference. Throws an exception if API error.</p>
|
|
800
|
+
|
|
801
|
+
<p><a href="https://ngrok.com/docs/api#api-event-destinations-delete">ngrok.com/docs/api#api-event-destinations-delete</a></p>
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
</div>
|
|
805
|
+
</div>
|
|
806
|
+
<div class="tags">
|
|
807
|
+
<p class="tag_title">Parameters:</p>
|
|
808
|
+
<ul class="param">
|
|
809
|
+
|
|
810
|
+
<li>
|
|
811
|
+
|
|
812
|
+
<span class='name'>id</span>
|
|
813
|
+
|
|
814
|
+
|
|
815
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
819
|
+
|
|
820
|
+
|
|
821
|
+
—
|
|
822
|
+
<div class='inline'>
|
|
823
|
+
<p>a resource identifier</p>
|
|
824
|
+
</div>
|
|
825
|
+
|
|
826
|
+
</li>
|
|
827
|
+
|
|
828
|
+
</ul>
|
|
829
|
+
|
|
830
|
+
<p class="tag_title">Returns:</p>
|
|
831
|
+
<ul class="return">
|
|
832
|
+
|
|
833
|
+
<li>
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
837
|
+
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
—
|
|
841
|
+
<div class='inline'>
|
|
842
|
+
<p>result from the API request</p>
|
|
843
|
+
</div>
|
|
844
|
+
|
|
845
|
+
</li>
|
|
846
|
+
|
|
847
|
+
</ul>
|
|
848
|
+
|
|
849
|
+
</div><table class="source_code">
|
|
850
|
+
<tr>
|
|
851
|
+
<td>
|
|
852
|
+
<pre class="lines">
|
|
853
|
+
|
|
854
|
+
|
|
855
|
+
79
|
|
856
|
+
80
|
|
857
|
+
81
|
|
858
|
+
82
|
|
859
|
+
83
|
|
860
|
+
84
|
|
861
|
+
85
|
|
862
|
+
86
|
|
863
|
+
87</pre>
|
|
864
|
+
</td>
|
|
865
|
+
<td>
|
|
866
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 79</span>
|
|
867
|
+
|
|
868
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span>
|
|
869
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
870
|
+
<span class='rparen'>)</span>
|
|
871
|
+
<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_destinations/%{id}</span><span class='tstring_end'>'</span></span>
|
|
872
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
873
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
874
|
+
<span class='rbrace'>}</span>
|
|
875
|
+
<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>
|
|
876
|
+
<span class='kw'>end</span></pre>
|
|
877
|
+
</td>
|
|
878
|
+
</tr>
|
|
879
|
+
</table>
|
|
880
|
+
</div>
|
|
881
|
+
|
|
882
|
+
<div class="method_details ">
|
|
883
|
+
<h3 class="signature " id="get-instance_method">
|
|
884
|
+
|
|
885
|
+
#<strong>get</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">NgrokAPI::Models::EventDestination</a></span></tt>
|
|
886
|
+
|
|
887
|
+
|
|
888
|
+
|
|
889
|
+
|
|
890
|
+
|
|
891
|
+
</h3><div class="docstring">
|
|
892
|
+
<div class="discussion">
|
|
893
|
+
|
|
894
|
+
<p>Get detailed information about an Event Destination by ID.</p>
|
|
895
|
+
|
|
896
|
+
<p><a href="https://ngrok.com/docs/api#api-event-destinations-get">ngrok.com/docs/api#api-event-destinations-get</a></p>
|
|
897
|
+
|
|
898
|
+
|
|
899
|
+
</div>
|
|
900
|
+
</div>
|
|
901
|
+
<div class="tags">
|
|
902
|
+
<p class="tag_title">Parameters:</p>
|
|
903
|
+
<ul class="param">
|
|
904
|
+
|
|
905
|
+
<li>
|
|
906
|
+
|
|
907
|
+
<span class='name'>id</span>
|
|
908
|
+
|
|
909
|
+
|
|
910
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
914
|
+
|
|
915
|
+
|
|
916
|
+
—
|
|
917
|
+
<div class='inline'>
|
|
918
|
+
<p>a resource identifier</p>
|
|
919
|
+
</div>
|
|
920
|
+
|
|
921
|
+
</li>
|
|
922
|
+
|
|
923
|
+
</ul>
|
|
924
|
+
|
|
925
|
+
<p class="tag_title">Returns:</p>
|
|
926
|
+
<ul class="return">
|
|
927
|
+
|
|
928
|
+
<li>
|
|
929
|
+
|
|
930
|
+
|
|
931
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">NgrokAPI::Models::EventDestination</a></span></tt>)</span>
|
|
932
|
+
|
|
933
|
+
|
|
934
|
+
|
|
935
|
+
—
|
|
936
|
+
<div class='inline'>
|
|
937
|
+
<p>result from the API request</p>
|
|
938
|
+
</div>
|
|
939
|
+
|
|
940
|
+
</li>
|
|
941
|
+
|
|
942
|
+
</ul>
|
|
943
|
+
|
|
944
|
+
</div><table class="source_code">
|
|
945
|
+
<tr>
|
|
946
|
+
<td>
|
|
947
|
+
<pre class="lines">
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
96
|
|
951
|
+
97
|
|
952
|
+
98
|
|
953
|
+
99
|
|
954
|
+
100
|
|
955
|
+
101
|
|
956
|
+
102
|
|
957
|
+
103
|
|
958
|
+
104
|
|
959
|
+
105
|
|
960
|
+
106</pre>
|
|
961
|
+
</td>
|
|
962
|
+
<td>
|
|
963
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 96</span>
|
|
964
|
+
|
|
965
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span>
|
|
966
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
967
|
+
<span class='rparen'>)</span>
|
|
968
|
+
<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_destinations/%{id}</span><span class='tstring_end'>'</span></span>
|
|
969
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
970
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
971
|
+
<span class='rbrace'>}</span>
|
|
972
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
973
|
+
<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>
|
|
974
|
+
<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/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">EventDestination</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventDestination.html#initialize-instance_method" title="NgrokAPI::Models::EventDestination#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>
|
|
975
|
+
<span class='kw'>end</span></pre>
|
|
976
|
+
</td>
|
|
977
|
+
</tr>
|
|
978
|
+
</table>
|
|
979
|
+
</div>
|
|
980
|
+
|
|
981
|
+
<div class="method_details ">
|
|
982
|
+
<h3 class="signature " id="get!-instance_method">
|
|
983
|
+
|
|
984
|
+
#<strong>get!</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">NgrokAPI::Models::EventDestination</a></span></tt>
|
|
985
|
+
|
|
986
|
+
|
|
987
|
+
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
</h3><div class="docstring">
|
|
991
|
+
<div class="discussion">
|
|
992
|
+
|
|
993
|
+
<p>Get detailed information about an Event Destination by ID. Throws an exception if API error.</p>
|
|
994
|
+
|
|
995
|
+
<p><a href="https://ngrok.com/docs/api#api-event-destinations-get">ngrok.com/docs/api#api-event-destinations-get</a></p>
|
|
996
|
+
|
|
997
|
+
|
|
998
|
+
</div>
|
|
999
|
+
</div>
|
|
1000
|
+
<div class="tags">
|
|
1001
|
+
<p class="tag_title">Parameters:</p>
|
|
1002
|
+
<ul class="param">
|
|
1003
|
+
|
|
1004
|
+
<li>
|
|
1005
|
+
|
|
1006
|
+
<span class='name'>id</span>
|
|
1007
|
+
|
|
1008
|
+
|
|
1009
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1010
|
+
|
|
1011
|
+
|
|
1012
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1013
|
+
|
|
1014
|
+
|
|
1015
|
+
—
|
|
1016
|
+
<div class='inline'>
|
|
1017
|
+
<p>a resource identifier</p>
|
|
1018
|
+
</div>
|
|
1019
|
+
|
|
1020
|
+
</li>
|
|
1021
|
+
|
|
1022
|
+
</ul>
|
|
1023
|
+
|
|
1024
|
+
<p class="tag_title">Returns:</p>
|
|
1025
|
+
<ul class="return">
|
|
1026
|
+
|
|
1027
|
+
<li>
|
|
1028
|
+
|
|
1029
|
+
|
|
1030
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">NgrokAPI::Models::EventDestination</a></span></tt>)</span>
|
|
1031
|
+
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
—
|
|
1035
|
+
<div class='inline'>
|
|
1036
|
+
<p>result from the API request</p>
|
|
1037
|
+
</div>
|
|
1038
|
+
|
|
1039
|
+
</li>
|
|
1040
|
+
|
|
1041
|
+
</ul>
|
|
1042
|
+
|
|
1043
|
+
</div><table class="source_code">
|
|
1044
|
+
<tr>
|
|
1045
|
+
<td>
|
|
1046
|
+
<pre class="lines">
|
|
1047
|
+
|
|
1048
|
+
|
|
1049
|
+
116
|
|
1050
|
+
117
|
|
1051
|
+
118
|
|
1052
|
+
119
|
|
1053
|
+
120
|
|
1054
|
+
121
|
|
1055
|
+
122
|
|
1056
|
+
123
|
|
1057
|
+
124
|
|
1058
|
+
125
|
|
1059
|
+
126</pre>
|
|
1060
|
+
</td>
|
|
1061
|
+
<td>
|
|
1062
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 116</span>
|
|
1063
|
+
|
|
1064
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span>
|
|
1065
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
1066
|
+
<span class='rparen'>)</span>
|
|
1067
|
+
<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_destinations/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1068
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1069
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1070
|
+
<span class='rbrace'>}</span>
|
|
1071
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1072
|
+
<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>
|
|
1073
|
+
<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/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">EventDestination</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventDestination.html#initialize-instance_method" title="NgrokAPI::Models::EventDestination#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>
|
|
1074
|
+
<span class='kw'>end</span></pre>
|
|
1075
|
+
</td>
|
|
1076
|
+
</tr>
|
|
1077
|
+
</table>
|
|
1078
|
+
</div>
|
|
1079
|
+
|
|
1080
|
+
<div class="method_details ">
|
|
1081
|
+
<h3 class="signature " id="list-instance_method">
|
|
1082
|
+
|
|
1083
|
+
#<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>
|
|
1084
|
+
|
|
1085
|
+
|
|
1086
|
+
|
|
1087
|
+
|
|
1088
|
+
|
|
1089
|
+
</h3><div class="docstring">
|
|
1090
|
+
<div class="discussion">
|
|
1091
|
+
|
|
1092
|
+
<p>List all Event Destinations on this account.</p>
|
|
1093
|
+
|
|
1094
|
+
<p><a href="https://ngrok.com/docs/api#api-event-destinations-list">ngrok.com/docs/api#api-event-destinations-list</a></p>
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
</div>
|
|
1098
|
+
</div>
|
|
1099
|
+
<div class="tags">
|
|
1100
|
+
<p class="tag_title">Parameters:</p>
|
|
1101
|
+
<ul class="param">
|
|
1102
|
+
|
|
1103
|
+
<li>
|
|
1104
|
+
|
|
1105
|
+
<span class='name'>before_id</span>
|
|
1106
|
+
|
|
1107
|
+
|
|
1108
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1109
|
+
|
|
1110
|
+
|
|
1111
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1112
|
+
|
|
1113
|
+
|
|
1114
|
+
</li>
|
|
1115
|
+
|
|
1116
|
+
<li>
|
|
1117
|
+
|
|
1118
|
+
<span class='name'>limit</span>
|
|
1119
|
+
|
|
1120
|
+
|
|
1121
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1122
|
+
|
|
1123
|
+
|
|
1124
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1125
|
+
|
|
1126
|
+
|
|
1127
|
+
</li>
|
|
1128
|
+
|
|
1129
|
+
<li>
|
|
1130
|
+
|
|
1131
|
+
<span class='name'>url</span>
|
|
1132
|
+
|
|
1133
|
+
|
|
1134
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1135
|
+
|
|
1136
|
+
|
|
1137
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1138
|
+
|
|
1139
|
+
|
|
1140
|
+
—
|
|
1141
|
+
<div class='inline'>
|
|
1142
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
1143
|
+
</div>
|
|
1144
|
+
|
|
1145
|
+
</li>
|
|
1146
|
+
|
|
1147
|
+
</ul>
|
|
1148
|
+
|
|
1149
|
+
<p class="tag_title">Returns:</p>
|
|
1150
|
+
<ul class="return">
|
|
1151
|
+
|
|
1152
|
+
<li>
|
|
1153
|
+
|
|
1154
|
+
|
|
1155
|
+
<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>
|
|
1156
|
+
|
|
1157
|
+
|
|
1158
|
+
|
|
1159
|
+
—
|
|
1160
|
+
<div class='inline'>
|
|
1161
|
+
<p>result from the API request</p>
|
|
1162
|
+
</div>
|
|
1163
|
+
|
|
1164
|
+
</li>
|
|
1165
|
+
|
|
1166
|
+
</ul>
|
|
1167
|
+
|
|
1168
|
+
</div><table class="source_code">
|
|
1169
|
+
<tr>
|
|
1170
|
+
<td>
|
|
1171
|
+
<pre class="lines">
|
|
1172
|
+
|
|
1173
|
+
|
|
1174
|
+
137
|
|
1175
|
+
138
|
|
1176
|
+
139
|
|
1177
|
+
140
|
|
1178
|
+
141
|
|
1179
|
+
142
|
|
1180
|
+
143
|
|
1181
|
+
144
|
|
1182
|
+
145
|
|
1183
|
+
146
|
|
1184
|
+
147
|
|
1185
|
+
148
|
|
1186
|
+
149
|
|
1187
|
+
150
|
|
1188
|
+
151
|
|
1189
|
+
152
|
|
1190
|
+
153
|
|
1191
|
+
154</pre>
|
|
1192
|
+
</td>
|
|
1193
|
+
<td>
|
|
1194
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 137</span>
|
|
1195
|
+
|
|
1196
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
|
1197
|
+
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1198
|
+
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1199
|
+
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1200
|
+
<span class='rparen'>)</span>
|
|
1201
|
+
<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>
|
|
1202
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1203
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1204
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1205
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EventDestinationsClient::PATH (constant)">PATH</a></span></span>
|
|
1206
|
+
<span class='rparen'>)</span>
|
|
1207
|
+
<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>
|
|
1208
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1209
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1210
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EventDestinationsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1211
|
+
<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/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">EventDestination</a></span></span>
|
|
1212
|
+
<span class='rparen'>)</span>
|
|
1213
|
+
<span class='kw'>end</span></pre>
|
|
1214
|
+
</td>
|
|
1215
|
+
</tr>
|
|
1216
|
+
</table>
|
|
1217
|
+
</div>
|
|
1218
|
+
|
|
1219
|
+
<div class="method_details ">
|
|
1220
|
+
<h3 class="signature " id="update-instance_method">
|
|
1221
|
+
|
|
1222
|
+
#<strong>update</strong>(id: "", metadata: nil, description: nil, format: nil, target: nil, verify_with_test_event: nil) ⇒ <tt><span class='object_link'><a href="../Models/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">NgrokAPI::Models::EventDestination</a></span></tt>
|
|
1223
|
+
|
|
1224
|
+
|
|
1225
|
+
|
|
1226
|
+
|
|
1227
|
+
|
|
1228
|
+
</h3><div class="docstring">
|
|
1229
|
+
<div class="discussion">
|
|
1230
|
+
|
|
1231
|
+
<p>Update attributes of an Event Destination.</p>
|
|
1232
|
+
|
|
1233
|
+
<p><a href="https://ngrok.com/docs/api#api-event-destinations-update">ngrok.com/docs/api#api-event-destinations-update</a></p>
|
|
1234
|
+
|
|
1235
|
+
|
|
1236
|
+
</div>
|
|
1237
|
+
</div>
|
|
1238
|
+
<div class="tags">
|
|
1239
|
+
<p class="tag_title">Parameters:</p>
|
|
1240
|
+
<ul class="param">
|
|
1241
|
+
|
|
1242
|
+
<li>
|
|
1243
|
+
|
|
1244
|
+
<span class='name'>id</span>
|
|
1245
|
+
|
|
1246
|
+
|
|
1247
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1248
|
+
|
|
1249
|
+
|
|
1250
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1251
|
+
|
|
1252
|
+
|
|
1253
|
+
—
|
|
1254
|
+
<div class='inline'>
|
|
1255
|
+
<p>Unique identifier for this Event Destination.</p>
|
|
1256
|
+
</div>
|
|
1257
|
+
|
|
1258
|
+
</li>
|
|
1259
|
+
|
|
1260
|
+
<li>
|
|
1261
|
+
|
|
1262
|
+
<span class='name'>metadata</span>
|
|
1263
|
+
|
|
1264
|
+
|
|
1265
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1266
|
+
|
|
1267
|
+
|
|
1268
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1269
|
+
|
|
1270
|
+
|
|
1271
|
+
—
|
|
1272
|
+
<div class='inline'>
|
|
1273
|
+
<p>Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.</p>
|
|
1274
|
+
</div>
|
|
1275
|
+
|
|
1276
|
+
</li>
|
|
1277
|
+
|
|
1278
|
+
<li>
|
|
1279
|
+
|
|
1280
|
+
<span class='name'>description</span>
|
|
1281
|
+
|
|
1282
|
+
|
|
1283
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1284
|
+
|
|
1285
|
+
|
|
1286
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1287
|
+
|
|
1288
|
+
|
|
1289
|
+
—
|
|
1290
|
+
<div class='inline'>
|
|
1291
|
+
<p>Human-readable description of the Event Destination. Optional, max 255 bytes.</p>
|
|
1292
|
+
</div>
|
|
1293
|
+
|
|
1294
|
+
</li>
|
|
1295
|
+
|
|
1296
|
+
<li>
|
|
1297
|
+
|
|
1298
|
+
<span class='name'>format</span>
|
|
1299
|
+
|
|
1300
|
+
|
|
1301
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1302
|
+
|
|
1303
|
+
|
|
1304
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1305
|
+
|
|
1306
|
+
|
|
1307
|
+
—
|
|
1308
|
+
<div class='inline'>
|
|
1309
|
+
<p>The output format you would like to serialize events into when sending to their target. Currently the only accepted value is “JSON“.</p>
|
|
1310
|
+
</div>
|
|
1311
|
+
|
|
1312
|
+
</li>
|
|
1313
|
+
|
|
1314
|
+
<li>
|
|
1315
|
+
|
|
1316
|
+
<span class='name'>target</span>
|
|
1317
|
+
|
|
1318
|
+
|
|
1319
|
+
<span class='type'>(<tt>EventTarget</tt>)</span>
|
|
1320
|
+
|
|
1321
|
+
|
|
1322
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1323
|
+
|
|
1324
|
+
|
|
1325
|
+
—
|
|
1326
|
+
<div class='inline'>
|
|
1327
|
+
<p>An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: “kinesis“, “firehose“, “cloudwatch_logs“, or “s3“.</p>
|
|
1328
|
+
</div>
|
|
1329
|
+
|
|
1330
|
+
</li>
|
|
1331
|
+
|
|
1332
|
+
</ul>
|
|
1333
|
+
|
|
1334
|
+
<p class="tag_title">Returns:</p>
|
|
1335
|
+
<ul class="return">
|
|
1336
|
+
|
|
1337
|
+
<li>
|
|
1338
|
+
|
|
1339
|
+
|
|
1340
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">NgrokAPI::Models::EventDestination</a></span></tt>)</span>
|
|
1341
|
+
|
|
1342
|
+
|
|
1343
|
+
|
|
1344
|
+
—
|
|
1345
|
+
<div class='inline'>
|
|
1346
|
+
<p>result from the API request</p>
|
|
1347
|
+
</div>
|
|
1348
|
+
|
|
1349
|
+
</li>
|
|
1350
|
+
|
|
1351
|
+
</ul>
|
|
1352
|
+
|
|
1353
|
+
</div><table class="source_code">
|
|
1354
|
+
<tr>
|
|
1355
|
+
<td>
|
|
1356
|
+
<pre class="lines">
|
|
1357
|
+
|
|
1358
|
+
|
|
1359
|
+
167
|
|
1360
|
+
168
|
|
1361
|
+
169
|
|
1362
|
+
170
|
|
1363
|
+
171
|
|
1364
|
+
172
|
|
1365
|
+
173
|
|
1366
|
+
174
|
|
1367
|
+
175
|
|
1368
|
+
176
|
|
1369
|
+
177
|
|
1370
|
+
178
|
|
1371
|
+
179
|
|
1372
|
+
180
|
|
1373
|
+
181
|
|
1374
|
+
182
|
|
1375
|
+
183
|
|
1376
|
+
184
|
|
1377
|
+
185
|
|
1378
|
+
186</pre>
|
|
1379
|
+
</td>
|
|
1380
|
+
<td>
|
|
1381
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 167</span>
|
|
1382
|
+
|
|
1383
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
|
|
1384
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
1385
|
+
<span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1386
|
+
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1387
|
+
<span class='label'>format:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1388
|
+
<span class='label'>target:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1389
|
+
<span class='label'>verify_with_test_event:</span> <span class='kw'>nil</span>
|
|
1390
|
+
<span class='rparen'>)</span>
|
|
1391
|
+
<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_destinations/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1392
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1393
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1394
|
+
<span class='rbrace'>}</span>
|
|
1395
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1396
|
+
<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>
|
|
1397
|
+
<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>
|
|
1398
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:format</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_format'>format</span> <span class='kw'>if</span> <span class='id identifier rubyid_format'>format</span>
|
|
1399
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:target</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_target'>target</span> <span class='kw'>if</span> <span class='id identifier rubyid_target'>target</span>
|
|
1400
|
+
<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>
|
|
1401
|
+
<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/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">EventDestination</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventDestination.html#initialize-instance_method" title="NgrokAPI::Models::EventDestination#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>
|
|
1402
|
+
<span class='kw'>end</span></pre>
|
|
1403
|
+
</td>
|
|
1404
|
+
</tr>
|
|
1405
|
+
</table>
|
|
1406
|
+
</div>
|
|
1407
|
+
|
|
1408
|
+
<div class="method_details ">
|
|
1409
|
+
<h3 class="signature " id="update!-instance_method">
|
|
1410
|
+
|
|
1411
|
+
#<strong>update!</strong>(id: "", metadata: nil, description: nil, format: nil, target: nil, verify_with_test_event: nil) ⇒ <tt><span class='object_link'><a href="../Models/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">NgrokAPI::Models::EventDestination</a></span></tt>
|
|
1412
|
+
|
|
1413
|
+
|
|
1414
|
+
|
|
1415
|
+
|
|
1416
|
+
|
|
1417
|
+
</h3><div class="docstring">
|
|
1418
|
+
<div class="discussion">
|
|
1419
|
+
|
|
1420
|
+
<p>Update attributes of an Event Destination. Throws an exception if API error.</p>
|
|
1421
|
+
|
|
1422
|
+
<p><a href="https://ngrok.com/docs/api#api-event-destinations-update">ngrok.com/docs/api#api-event-destinations-update</a></p>
|
|
1423
|
+
|
|
1424
|
+
|
|
1425
|
+
</div>
|
|
1426
|
+
</div>
|
|
1427
|
+
<div class="tags">
|
|
1428
|
+
<p class="tag_title">Parameters:</p>
|
|
1429
|
+
<ul class="param">
|
|
1430
|
+
|
|
1431
|
+
<li>
|
|
1432
|
+
|
|
1433
|
+
<span class='name'>id</span>
|
|
1434
|
+
|
|
1435
|
+
|
|
1436
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1437
|
+
|
|
1438
|
+
|
|
1439
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1440
|
+
|
|
1441
|
+
|
|
1442
|
+
—
|
|
1443
|
+
<div class='inline'>
|
|
1444
|
+
<p>Unique identifier for this Event Destination.</p>
|
|
1445
|
+
</div>
|
|
1446
|
+
|
|
1447
|
+
</li>
|
|
1448
|
+
|
|
1449
|
+
<li>
|
|
1450
|
+
|
|
1451
|
+
<span class='name'>metadata</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>Arbitrary user-defined machine-readable data of this Event Destination. Optional, max 4096 bytes.</p>
|
|
1463
|
+
</div>
|
|
1464
|
+
|
|
1465
|
+
</li>
|
|
1466
|
+
|
|
1467
|
+
<li>
|
|
1468
|
+
|
|
1469
|
+
<span class='name'>description</span>
|
|
1470
|
+
|
|
1471
|
+
|
|
1472
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1473
|
+
|
|
1474
|
+
|
|
1475
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1476
|
+
|
|
1477
|
+
|
|
1478
|
+
—
|
|
1479
|
+
<div class='inline'>
|
|
1480
|
+
<p>Human-readable description of the Event Destination. Optional, max 255 bytes.</p>
|
|
1481
|
+
</div>
|
|
1482
|
+
|
|
1483
|
+
</li>
|
|
1484
|
+
|
|
1485
|
+
<li>
|
|
1486
|
+
|
|
1487
|
+
<span class='name'>format</span>
|
|
1488
|
+
|
|
1489
|
+
|
|
1490
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1491
|
+
|
|
1492
|
+
|
|
1493
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1494
|
+
|
|
1495
|
+
|
|
1496
|
+
—
|
|
1497
|
+
<div class='inline'>
|
|
1498
|
+
<p>The output format you would like to serialize events into when sending to their target. Currently the only accepted value is “JSON“.</p>
|
|
1499
|
+
</div>
|
|
1500
|
+
|
|
1501
|
+
</li>
|
|
1502
|
+
|
|
1503
|
+
<li>
|
|
1504
|
+
|
|
1505
|
+
<span class='name'>target</span>
|
|
1506
|
+
|
|
1507
|
+
|
|
1508
|
+
<span class='type'>(<tt>EventTarget</tt>)</span>
|
|
1509
|
+
|
|
1510
|
+
|
|
1511
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1512
|
+
|
|
1513
|
+
|
|
1514
|
+
—
|
|
1515
|
+
<div class='inline'>
|
|
1516
|
+
<p>An object that encapsulates where and how to send your events. An event destination must contain exactly one of the following objects, leaving the rest null: “kinesis“, “firehose“, “cloudwatch_logs“, or “s3“.</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/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">NgrokAPI::Models::EventDestination</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
|
+
200
|
|
1549
|
+
201
|
|
1550
|
+
202
|
|
1551
|
+
203
|
|
1552
|
+
204
|
|
1553
|
+
205
|
|
1554
|
+
206
|
|
1555
|
+
207
|
|
1556
|
+
208
|
|
1557
|
+
209
|
|
1558
|
+
210
|
|
1559
|
+
211
|
|
1560
|
+
212
|
|
1561
|
+
213
|
|
1562
|
+
214
|
|
1563
|
+
215
|
|
1564
|
+
216
|
|
1565
|
+
217
|
|
1566
|
+
218
|
|
1567
|
+
219</pre>
|
|
1568
|
+
</td>
|
|
1569
|
+
<td>
|
|
1570
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 200</span>
|
|
1571
|
+
|
|
1572
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
|
|
1573
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
1574
|
+
<span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1575
|
+
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1576
|
+
<span class='label'>format:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1577
|
+
<span class='label'>target:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1578
|
+
<span class='label'>verify_with_test_event:</span> <span class='kw'>nil</span>
|
|
1579
|
+
<span class='rparen'>)</span>
|
|
1580
|
+
<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_destinations/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1581
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1582
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1583
|
+
<span class='rbrace'>}</span>
|
|
1584
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1585
|
+
<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>
|
|
1586
|
+
<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>
|
|
1587
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:format</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_format'>format</span> <span class='kw'>if</span> <span class='id identifier rubyid_format'>format</span>
|
|
1588
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:target</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_target'>target</span> <span class='kw'>if</span> <span class='id identifier rubyid_target'>target</span>
|
|
1589
|
+
<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>
|
|
1590
|
+
<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/EventDestination.html" title="NgrokAPI::Models::EventDestination (class)">EventDestination</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventDestination.html#initialize-instance_method" title="NgrokAPI::Models::EventDestination#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>
|
|
1591
|
+
<span class='kw'>end</span></pre>
|
|
1592
|
+
</td>
|
|
1593
|
+
</tr>
|
|
1594
|
+
</table>
|
|
1595
|
+
</div>
|
|
1596
|
+
|
|
1597
|
+
</div>
|
|
1598
|
+
|
|
1599
|
+
</div>
|
|
1600
|
+
|
|
1601
|
+
<div id="footer">
|
|
1602
|
+
Generated on Mon Oct 4 23:24:18 2021 by
|
|
1603
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1604
|
+
0.9.26 (ruby-3.0.1).
|
|
1605
|
+
</div>
|
|
1606
|
+
|
|
1607
|
+
</div>
|
|
1608
|
+
</body>
|
|
1609
|
+
</html>
|