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