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,1712 @@
|
|
|
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::EventSubscriptionsClient
|
|
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::EventSubscriptionsClient";
|
|
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">EventSubscriptionsClient</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::EventSubscriptionsClient
|
|
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::EventSubscriptionsClient</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_subscriptions_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-subscriptions">ngrok.com/docs/api#api-event-subscriptions</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</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_subscriptions</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: "", sources: [], destination_ids: []) ⇒ NgrokAPI::Models::EventSubscription </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 an Event Subscription.</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 Subscription.</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 Subscription.</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::EventSubscription </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 an Event Subscription 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::EventSubscription </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 an Event Subscription 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:) ⇒ EventSubscriptionsClient </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 EventSubscriptionsClient.</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 this Account's Event Subscriptions.</p>
|
|
370
|
+
</div></span>
|
|
371
|
+
|
|
372
|
+
</li>
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<li class="public ">
|
|
376
|
+
<span class="summary_signature">
|
|
377
|
+
|
|
378
|
+
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
</span>
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
<span class="summary_desc"><div class='inline'>
|
|
393
|
+
<p>List this Account's Event Subscriptions.</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, sources: nil, destination_ids: nil) ⇒ NgrokAPI::Models::EventSubscription </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 an Event Subscription.</p>
|
|
418
|
+
</div></span>
|
|
419
|
+
|
|
420
|
+
</li>
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
<li class="public ">
|
|
424
|
+
<span class="summary_signature">
|
|
425
|
+
|
|
426
|
+
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: "", metadata: nil, description: nil, sources: nil, destination_ids: nil) ⇒ NgrokAPI::Models::EventSubscription </a>
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
</span>
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
<span class="summary_desc"><div class='inline'>
|
|
441
|
+
<p>Update an Event Subscription.</p>
|
|
442
|
+
</div></span>
|
|
443
|
+
|
|
444
|
+
</li>
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
</ul>
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
<div id="constructor_details" class="method_details_list">
|
|
451
|
+
<h2>Constructor Details</h2>
|
|
452
|
+
|
|
453
|
+
<div class="method_details first">
|
|
454
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
455
|
+
|
|
456
|
+
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::EventSubscriptionsClient (class)">EventSubscriptionsClient</a></span></tt>
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
</h3><div class="docstring">
|
|
463
|
+
<div class="discussion">
|
|
464
|
+
|
|
465
|
+
<p>Returns a new instance of EventSubscriptionsClient.</p>
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
</div>
|
|
469
|
+
</div>
|
|
470
|
+
<div class="tags">
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
</div><table class="source_code">
|
|
474
|
+
<tr>
|
|
475
|
+
<td>
|
|
476
|
+
<pre class="lines">
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
15
|
|
480
|
+
16
|
|
481
|
+
17</pre>
|
|
482
|
+
</td>
|
|
483
|
+
<td>
|
|
484
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 15</span>
|
|
485
|
+
|
|
486
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='rparen'>)</span>
|
|
487
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
488
|
+
<span class='kw'>end</span></pre>
|
|
489
|
+
</td>
|
|
490
|
+
</tr>
|
|
491
|
+
</table>
|
|
492
|
+
</div>
|
|
493
|
+
|
|
494
|
+
</div>
|
|
495
|
+
|
|
496
|
+
<div id="instance_attr_details" class="attr_details">
|
|
497
|
+
<h2>Instance Attribute Details</h2>
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
<span id=""></span>
|
|
501
|
+
<div class="method_details first">
|
|
502
|
+
<h3 class="signature first" id="client-instance_method">
|
|
503
|
+
|
|
504
|
+
#<strong>client</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
</h3><div class="docstring">
|
|
511
|
+
<div class="discussion">
|
|
512
|
+
|
|
513
|
+
<p>Returns the value of attribute client.</p>
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
</div>
|
|
517
|
+
</div>
|
|
518
|
+
<div class="tags">
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
</div><table class="source_code">
|
|
522
|
+
<tr>
|
|
523
|
+
<td>
|
|
524
|
+
<pre class="lines">
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
13
|
|
528
|
+
14
|
|
529
|
+
15</pre>
|
|
530
|
+
</td>
|
|
531
|
+
<td>
|
|
532
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 13</span>
|
|
533
|
+
|
|
534
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
|
535
|
+
<span class='ivar'>@client</span>
|
|
536
|
+
<span class='kw'>end</span></pre>
|
|
537
|
+
</td>
|
|
538
|
+
</tr>
|
|
539
|
+
</table>
|
|
540
|
+
</div>
|
|
541
|
+
|
|
542
|
+
</div>
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
<div id="instance_method_details" class="method_details_list">
|
|
546
|
+
<h2>Instance Method Details</h2>
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
<div class="method_details first">
|
|
550
|
+
<h3 class="signature first" id="create-instance_method">
|
|
551
|
+
|
|
552
|
+
#<strong>create</strong>(metadata: "", description: "", sources: [], destination_ids: []) ⇒ <tt><span class='object_link'><a href="../Models/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">NgrokAPI::Models::EventSubscription</a></span></tt>
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
</h3><div class="docstring">
|
|
559
|
+
<div class="discussion">
|
|
560
|
+
|
|
561
|
+
<p>Create an Event Subscription.</p>
|
|
562
|
+
|
|
563
|
+
<p><a href="https://ngrok.com/docs/api#api-event-subscriptions-create">ngrok.com/docs/api#api-event-subscriptions-create</a></p>
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
</div>
|
|
567
|
+
</div>
|
|
568
|
+
<div class="tags">
|
|
569
|
+
<p class="tag_title">Parameters:</p>
|
|
570
|
+
<ul class="param">
|
|
571
|
+
|
|
572
|
+
<li>
|
|
573
|
+
|
|
574
|
+
<span class='name'>metadata</span>
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
—
|
|
584
|
+
<div class='inline'>
|
|
585
|
+
<p>Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.</p>
|
|
586
|
+
</div>
|
|
587
|
+
|
|
588
|
+
</li>
|
|
589
|
+
|
|
590
|
+
<li>
|
|
591
|
+
|
|
592
|
+
<span class='name'>description</span>
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
—
|
|
602
|
+
<div class='inline'>
|
|
603
|
+
<p>Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.</p>
|
|
604
|
+
</div>
|
|
605
|
+
|
|
606
|
+
</li>
|
|
607
|
+
|
|
608
|
+
<li>
|
|
609
|
+
|
|
610
|
+
<span class='name'>sources</span>
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
<span class='type'>(<tt>List<EventSourceReplace></tt>)</span>
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
<em class="default">(defaults to: <tt>[]</tt>)</em>
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
—
|
|
620
|
+
<div class='inline'>
|
|
621
|
+
<p>Sources containing the types for which this event subscription will trigger</p>
|
|
622
|
+
</div>
|
|
623
|
+
|
|
624
|
+
</li>
|
|
625
|
+
|
|
626
|
+
<li>
|
|
627
|
+
|
|
628
|
+
<span class='name'>destination_ids</span>
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
<em class="default">(defaults to: <tt>[]</tt>)</em>
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
—
|
|
638
|
+
<div class='inline'>
|
|
639
|
+
<p>A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.</p>
|
|
640
|
+
</div>
|
|
641
|
+
|
|
642
|
+
</li>
|
|
643
|
+
|
|
644
|
+
</ul>
|
|
645
|
+
|
|
646
|
+
<p class="tag_title">Returns:</p>
|
|
647
|
+
<ul class="return">
|
|
648
|
+
|
|
649
|
+
<li>
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">NgrokAPI::Models::EventSubscription</a></span></tt>)</span>
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
|
|
656
|
+
—
|
|
657
|
+
<div class='inline'>
|
|
658
|
+
<p>result from the API request</p>
|
|
659
|
+
</div>
|
|
660
|
+
|
|
661
|
+
</li>
|
|
662
|
+
|
|
663
|
+
</ul>
|
|
664
|
+
|
|
665
|
+
</div><table class="source_code">
|
|
666
|
+
<tr>
|
|
667
|
+
<td>
|
|
668
|
+
<pre class="lines">
|
|
669
|
+
|
|
670
|
+
|
|
671
|
+
29
|
|
672
|
+
30
|
|
673
|
+
31
|
|
674
|
+
32
|
|
675
|
+
33
|
|
676
|
+
34
|
|
677
|
+
35
|
|
678
|
+
36
|
|
679
|
+
37
|
|
680
|
+
38
|
|
681
|
+
39
|
|
682
|
+
40</pre>
|
|
683
|
+
</td>
|
|
684
|
+
<td>
|
|
685
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 29</span>
|
|
686
|
+
|
|
687
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>sources:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>destination_ids:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span>
|
|
688
|
+
<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</span><span class='tstring_end'>'</span></span>
|
|
689
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
690
|
+
<span class='rbrace'>}</span>
|
|
691
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
692
|
+
<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>
|
|
693
|
+
<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>
|
|
694
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:sources</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_sources'>sources</span> <span class='kw'>if</span> <span class='id identifier rubyid_sources'>sources</span>
|
|
695
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:destination_ids</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_destination_ids'>destination_ids</span> <span class='kw'>if</span> <span class='id identifier rubyid_destination_ids'>destination_ids</span>
|
|
696
|
+
<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>
|
|
697
|
+
<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/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">EventSubscription</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventSubscription.html#initialize-instance_method" title="NgrokAPI::Models::EventSubscription#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>
|
|
698
|
+
<span class='kw'>end</span></pre>
|
|
699
|
+
</td>
|
|
700
|
+
</tr>
|
|
701
|
+
</table>
|
|
702
|
+
</div>
|
|
703
|
+
|
|
704
|
+
<div class="method_details ">
|
|
705
|
+
<h3 class="signature " id="delete-instance_method">
|
|
706
|
+
|
|
707
|
+
#<strong>delete</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
708
|
+
|
|
709
|
+
|
|
710
|
+
|
|
711
|
+
|
|
712
|
+
|
|
713
|
+
</h3><div class="docstring">
|
|
714
|
+
<div class="discussion">
|
|
715
|
+
|
|
716
|
+
<p>Delete an Event Subscription.</p>
|
|
717
|
+
|
|
718
|
+
<p><a href="https://ngrok.com/docs/api#api-event-subscriptions-delete">ngrok.com/docs/api#api-event-subscriptions-delete</a></p>
|
|
719
|
+
|
|
720
|
+
|
|
721
|
+
</div>
|
|
722
|
+
</div>
|
|
723
|
+
<div class="tags">
|
|
724
|
+
<p class="tag_title">Parameters:</p>
|
|
725
|
+
<ul class="param">
|
|
726
|
+
|
|
727
|
+
<li>
|
|
728
|
+
|
|
729
|
+
<span class='name'>id</span>
|
|
730
|
+
|
|
731
|
+
|
|
732
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
733
|
+
|
|
734
|
+
|
|
735
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
736
|
+
|
|
737
|
+
|
|
738
|
+
—
|
|
739
|
+
<div class='inline'>
|
|
740
|
+
<p>a resource identifier</p>
|
|
741
|
+
</div>
|
|
742
|
+
|
|
743
|
+
</li>
|
|
744
|
+
|
|
745
|
+
</ul>
|
|
746
|
+
|
|
747
|
+
<p class="tag_title">Returns:</p>
|
|
748
|
+
<ul class="return">
|
|
749
|
+
|
|
750
|
+
<li>
|
|
751
|
+
|
|
752
|
+
|
|
753
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
754
|
+
|
|
755
|
+
|
|
756
|
+
|
|
757
|
+
—
|
|
758
|
+
<div class='inline'>
|
|
759
|
+
<p>result from the API request</p>
|
|
760
|
+
</div>
|
|
761
|
+
|
|
762
|
+
</li>
|
|
763
|
+
|
|
764
|
+
</ul>
|
|
765
|
+
|
|
766
|
+
</div><table class="source_code">
|
|
767
|
+
<tr>
|
|
768
|
+
<td>
|
|
769
|
+
<pre class="lines">
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
49
|
|
773
|
+
50
|
|
774
|
+
51
|
|
775
|
+
52
|
|
776
|
+
53
|
|
777
|
+
54
|
|
778
|
+
55</pre>
|
|
779
|
+
</td>
|
|
780
|
+
<td>
|
|
781
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 49</span>
|
|
782
|
+
|
|
783
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
784
|
+
<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/%{id}</span><span class='tstring_end'>'</span></span>
|
|
785
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
786
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
787
|
+
<span class='rbrace'>}</span>
|
|
788
|
+
<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>
|
|
789
|
+
<span class='kw'>end</span></pre>
|
|
790
|
+
</td>
|
|
791
|
+
</tr>
|
|
792
|
+
</table>
|
|
793
|
+
</div>
|
|
794
|
+
|
|
795
|
+
<div class="method_details ">
|
|
796
|
+
<h3 class="signature " id="delete!-instance_method">
|
|
797
|
+
|
|
798
|
+
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
799
|
+
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
|
|
804
|
+
</h3><div class="docstring">
|
|
805
|
+
<div class="discussion">
|
|
806
|
+
|
|
807
|
+
<p>Delete an Event Subscription. Throws an exception if API error.</p>
|
|
808
|
+
|
|
809
|
+
<p><a href="https://ngrok.com/docs/api#api-event-subscriptions-delete">ngrok.com/docs/api#api-event-subscriptions-delete</a></p>
|
|
810
|
+
|
|
811
|
+
|
|
812
|
+
</div>
|
|
813
|
+
</div>
|
|
814
|
+
<div class="tags">
|
|
815
|
+
<p class="tag_title">Parameters:</p>
|
|
816
|
+
<ul class="param">
|
|
817
|
+
|
|
818
|
+
<li>
|
|
819
|
+
|
|
820
|
+
<span class='name'>id</span>
|
|
821
|
+
|
|
822
|
+
|
|
823
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
824
|
+
|
|
825
|
+
|
|
826
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
827
|
+
|
|
828
|
+
|
|
829
|
+
—
|
|
830
|
+
<div class='inline'>
|
|
831
|
+
<p>a resource identifier</p>
|
|
832
|
+
</div>
|
|
833
|
+
|
|
834
|
+
</li>
|
|
835
|
+
|
|
836
|
+
</ul>
|
|
837
|
+
|
|
838
|
+
<p class="tag_title">Returns:</p>
|
|
839
|
+
<ul class="return">
|
|
840
|
+
|
|
841
|
+
<li>
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
845
|
+
|
|
846
|
+
|
|
847
|
+
|
|
848
|
+
—
|
|
849
|
+
<div class='inline'>
|
|
850
|
+
<p>result from the API request</p>
|
|
851
|
+
</div>
|
|
852
|
+
|
|
853
|
+
</li>
|
|
854
|
+
|
|
855
|
+
</ul>
|
|
856
|
+
|
|
857
|
+
</div><table class="source_code">
|
|
858
|
+
<tr>
|
|
859
|
+
<td>
|
|
860
|
+
<pre class="lines">
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
65
|
|
864
|
+
66
|
|
865
|
+
67
|
|
866
|
+
68
|
|
867
|
+
69
|
|
868
|
+
70
|
|
869
|
+
71</pre>
|
|
870
|
+
</td>
|
|
871
|
+
<td>
|
|
872
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 65</span>
|
|
873
|
+
|
|
874
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
875
|
+
<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/%{id}</span><span class='tstring_end'>'</span></span>
|
|
876
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
877
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
878
|
+
<span class='rbrace'>}</span>
|
|
879
|
+
<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>
|
|
880
|
+
<span class='kw'>end</span></pre>
|
|
881
|
+
</td>
|
|
882
|
+
</tr>
|
|
883
|
+
</table>
|
|
884
|
+
</div>
|
|
885
|
+
|
|
886
|
+
<div class="method_details ">
|
|
887
|
+
<h3 class="signature " id="get-instance_method">
|
|
888
|
+
|
|
889
|
+
#<strong>get</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">NgrokAPI::Models::EventSubscription</a></span></tt>
|
|
890
|
+
|
|
891
|
+
|
|
892
|
+
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
</h3><div class="docstring">
|
|
896
|
+
<div class="discussion">
|
|
897
|
+
|
|
898
|
+
<p>Get an Event Subscription by ID.</p>
|
|
899
|
+
|
|
900
|
+
<p><a href="https://ngrok.com/docs/api#api-event-subscriptions-get">ngrok.com/docs/api#api-event-subscriptions-get</a></p>
|
|
901
|
+
|
|
902
|
+
|
|
903
|
+
</div>
|
|
904
|
+
</div>
|
|
905
|
+
<div class="tags">
|
|
906
|
+
<p class="tag_title">Parameters:</p>
|
|
907
|
+
<ul class="param">
|
|
908
|
+
|
|
909
|
+
<li>
|
|
910
|
+
|
|
911
|
+
<span class='name'>id</span>
|
|
912
|
+
|
|
913
|
+
|
|
914
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
918
|
+
|
|
919
|
+
|
|
920
|
+
—
|
|
921
|
+
<div class='inline'>
|
|
922
|
+
<p>a resource identifier</p>
|
|
923
|
+
</div>
|
|
924
|
+
|
|
925
|
+
</li>
|
|
926
|
+
|
|
927
|
+
</ul>
|
|
928
|
+
|
|
929
|
+
<p class="tag_title">Returns:</p>
|
|
930
|
+
<ul class="return">
|
|
931
|
+
|
|
932
|
+
<li>
|
|
933
|
+
|
|
934
|
+
|
|
935
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">NgrokAPI::Models::EventSubscription</a></span></tt>)</span>
|
|
936
|
+
|
|
937
|
+
|
|
938
|
+
|
|
939
|
+
—
|
|
940
|
+
<div class='inline'>
|
|
941
|
+
<p>result from the API request</p>
|
|
942
|
+
</div>
|
|
943
|
+
|
|
944
|
+
</li>
|
|
945
|
+
|
|
946
|
+
</ul>
|
|
947
|
+
|
|
948
|
+
</div><table class="source_code">
|
|
949
|
+
<tr>
|
|
950
|
+
<td>
|
|
951
|
+
<pre class="lines">
|
|
952
|
+
|
|
953
|
+
|
|
954
|
+
80
|
|
955
|
+
81
|
|
956
|
+
82
|
|
957
|
+
83
|
|
958
|
+
84
|
|
959
|
+
85
|
|
960
|
+
86
|
|
961
|
+
87
|
|
962
|
+
88</pre>
|
|
963
|
+
</td>
|
|
964
|
+
<td>
|
|
965
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 80</span>
|
|
966
|
+
|
|
967
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
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_subscriptions/%{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/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">EventSubscription</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventSubscription.html#initialize-instance_method" title="NgrokAPI::Models::EventSubscription#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/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">NgrokAPI::Models::EventSubscription</a></span></tt>
|
|
985
|
+
|
|
986
|
+
|
|
987
|
+
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
</h3><div class="docstring">
|
|
991
|
+
<div class="discussion">
|
|
992
|
+
|
|
993
|
+
<p>Get an Event Subscription by ID. Throws an exception if API error.</p>
|
|
994
|
+
|
|
995
|
+
<p><a href="https://ngrok.com/docs/api#api-event-subscriptions-get">ngrok.com/docs/api#api-event-subscriptions-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/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">NgrokAPI::Models::EventSubscription</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
|
+
98
|
|
1050
|
+
99
|
|
1051
|
+
100
|
|
1052
|
+
101
|
|
1053
|
+
102
|
|
1054
|
+
103
|
|
1055
|
+
104
|
|
1056
|
+
105
|
|
1057
|
+
106</pre>
|
|
1058
|
+
</td>
|
|
1059
|
+
<td>
|
|
1060
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 98</span>
|
|
1061
|
+
|
|
1062
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1063
|
+
<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/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1064
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1065
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1066
|
+
<span class='rbrace'>}</span>
|
|
1067
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1068
|
+
<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>
|
|
1069
|
+
<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/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">EventSubscription</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventSubscription.html#initialize-instance_method" title="NgrokAPI::Models::EventSubscription#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>
|
|
1070
|
+
<span class='kw'>end</span></pre>
|
|
1071
|
+
</td>
|
|
1072
|
+
</tr>
|
|
1073
|
+
</table>
|
|
1074
|
+
</div>
|
|
1075
|
+
|
|
1076
|
+
<div class="method_details ">
|
|
1077
|
+
<h3 class="signature " id="list-instance_method">
|
|
1078
|
+
|
|
1079
|
+
#<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>
|
|
1080
|
+
|
|
1081
|
+
|
|
1082
|
+
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
</h3><div class="docstring">
|
|
1086
|
+
<div class="discussion">
|
|
1087
|
+
|
|
1088
|
+
<p>List this Account's Event Subscriptions.</p>
|
|
1089
|
+
|
|
1090
|
+
<p><a href="https://ngrok.com/docs/api#api-event-subscriptions-list">ngrok.com/docs/api#api-event-subscriptions-list</a></p>
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
</div>
|
|
1094
|
+
</div>
|
|
1095
|
+
<div class="tags">
|
|
1096
|
+
<p class="tag_title">Parameters:</p>
|
|
1097
|
+
<ul class="param">
|
|
1098
|
+
|
|
1099
|
+
<li>
|
|
1100
|
+
|
|
1101
|
+
<span class='name'>before_id</span>
|
|
1102
|
+
|
|
1103
|
+
|
|
1104
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1105
|
+
|
|
1106
|
+
|
|
1107
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1108
|
+
|
|
1109
|
+
|
|
1110
|
+
</li>
|
|
1111
|
+
|
|
1112
|
+
<li>
|
|
1113
|
+
|
|
1114
|
+
<span class='name'>limit</span>
|
|
1115
|
+
|
|
1116
|
+
|
|
1117
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1118
|
+
|
|
1119
|
+
|
|
1120
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1121
|
+
|
|
1122
|
+
|
|
1123
|
+
</li>
|
|
1124
|
+
|
|
1125
|
+
<li>
|
|
1126
|
+
|
|
1127
|
+
<span class='name'>url</span>
|
|
1128
|
+
|
|
1129
|
+
|
|
1130
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1131
|
+
|
|
1132
|
+
|
|
1133
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1134
|
+
|
|
1135
|
+
|
|
1136
|
+
—
|
|
1137
|
+
<div class='inline'>
|
|
1138
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
1139
|
+
</div>
|
|
1140
|
+
|
|
1141
|
+
</li>
|
|
1142
|
+
|
|
1143
|
+
</ul>
|
|
1144
|
+
|
|
1145
|
+
<p class="tag_title">Returns:</p>
|
|
1146
|
+
<ul class="return">
|
|
1147
|
+
|
|
1148
|
+
<li>
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
<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>
|
|
1152
|
+
|
|
1153
|
+
|
|
1154
|
+
|
|
1155
|
+
—
|
|
1156
|
+
<div class='inline'>
|
|
1157
|
+
<p>result from the API request</p>
|
|
1158
|
+
</div>
|
|
1159
|
+
|
|
1160
|
+
</li>
|
|
1161
|
+
|
|
1162
|
+
</ul>
|
|
1163
|
+
|
|
1164
|
+
</div><table class="source_code">
|
|
1165
|
+
<tr>
|
|
1166
|
+
<td>
|
|
1167
|
+
<pre class="lines">
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
117
|
|
1171
|
+
118
|
|
1172
|
+
119
|
|
1173
|
+
120
|
|
1174
|
+
121
|
|
1175
|
+
122
|
|
1176
|
+
123
|
|
1177
|
+
124
|
|
1178
|
+
125
|
|
1179
|
+
126
|
|
1180
|
+
127
|
|
1181
|
+
128
|
|
1182
|
+
129
|
|
1183
|
+
130
|
|
1184
|
+
131
|
|
1185
|
+
132</pre>
|
|
1186
|
+
</td>
|
|
1187
|
+
<td>
|
|
1188
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 117</span>
|
|
1189
|
+
|
|
1190
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1191
|
+
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1192
|
+
<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>
|
|
1193
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1194
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1195
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1196
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EventSubscriptionsClient::PATH (constant)">PATH</a></span></span>
|
|
1197
|
+
<span class='rparen'>)</span>
|
|
1198
|
+
|
|
1199
|
+
<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>
|
|
1200
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1201
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1202
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EventSubscriptionsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1203
|
+
<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/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">EventSubscription</a></span></span>
|
|
1204
|
+
<span class='rparen'>)</span>
|
|
1205
|
+
<span class='kw'>end</span></pre>
|
|
1206
|
+
</td>
|
|
1207
|
+
</tr>
|
|
1208
|
+
</table>
|
|
1209
|
+
</div>
|
|
1210
|
+
|
|
1211
|
+
<div class="method_details ">
|
|
1212
|
+
<h3 class="signature " id="list!-instance_method">
|
|
1213
|
+
|
|
1214
|
+
#<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>
|
|
1215
|
+
|
|
1216
|
+
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
|
|
1220
|
+
</h3><div class="docstring">
|
|
1221
|
+
<div class="discussion">
|
|
1222
|
+
|
|
1223
|
+
<p>List this Account's Event Subscriptions. Throws an exception if API error.</p>
|
|
1224
|
+
|
|
1225
|
+
<p><a href="https://ngrok.com/docs/api#api-event-subscriptions-list">ngrok.com/docs/api#api-event-subscriptions-list</a></p>
|
|
1226
|
+
|
|
1227
|
+
|
|
1228
|
+
</div>
|
|
1229
|
+
</div>
|
|
1230
|
+
<div class="tags">
|
|
1231
|
+
<p class="tag_title">Parameters:</p>
|
|
1232
|
+
<ul class="param">
|
|
1233
|
+
|
|
1234
|
+
<li>
|
|
1235
|
+
|
|
1236
|
+
<span class='name'>before_id</span>
|
|
1237
|
+
|
|
1238
|
+
|
|
1239
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1240
|
+
|
|
1241
|
+
|
|
1242
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1243
|
+
|
|
1244
|
+
|
|
1245
|
+
</li>
|
|
1246
|
+
|
|
1247
|
+
<li>
|
|
1248
|
+
|
|
1249
|
+
<span class='name'>limit</span>
|
|
1250
|
+
|
|
1251
|
+
|
|
1252
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1253
|
+
|
|
1254
|
+
|
|
1255
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1256
|
+
|
|
1257
|
+
|
|
1258
|
+
</li>
|
|
1259
|
+
|
|
1260
|
+
<li>
|
|
1261
|
+
|
|
1262
|
+
<span class='name'>url</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>optional and mutually exclusive from before_id and limit</p>
|
|
1274
|
+
</div>
|
|
1275
|
+
|
|
1276
|
+
</li>
|
|
1277
|
+
|
|
1278
|
+
</ul>
|
|
1279
|
+
|
|
1280
|
+
<p class="tag_title">Returns:</p>
|
|
1281
|
+
<ul class="return">
|
|
1282
|
+
|
|
1283
|
+
<li>
|
|
1284
|
+
|
|
1285
|
+
|
|
1286
|
+
<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>
|
|
1287
|
+
|
|
1288
|
+
|
|
1289
|
+
|
|
1290
|
+
—
|
|
1291
|
+
<div class='inline'>
|
|
1292
|
+
<p>result from the API request</p>
|
|
1293
|
+
</div>
|
|
1294
|
+
|
|
1295
|
+
</li>
|
|
1296
|
+
|
|
1297
|
+
</ul>
|
|
1298
|
+
|
|
1299
|
+
</div><table class="source_code">
|
|
1300
|
+
<tr>
|
|
1301
|
+
<td>
|
|
1302
|
+
<pre class="lines">
|
|
1303
|
+
|
|
1304
|
+
|
|
1305
|
+
144
|
|
1306
|
+
145
|
|
1307
|
+
146
|
|
1308
|
+
147
|
|
1309
|
+
148
|
|
1310
|
+
149
|
|
1311
|
+
150
|
|
1312
|
+
151
|
|
1313
|
+
152
|
|
1314
|
+
153
|
|
1315
|
+
154
|
|
1316
|
+
155
|
|
1317
|
+
156
|
|
1318
|
+
157
|
|
1319
|
+
158
|
|
1320
|
+
159
|
|
1321
|
+
160
|
|
1322
|
+
161</pre>
|
|
1323
|
+
</td>
|
|
1324
|
+
<td>
|
|
1325
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 144</span>
|
|
1326
|
+
|
|
1327
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1328
|
+
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1329
|
+
<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>
|
|
1330
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1331
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1332
|
+
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
|
1333
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1334
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EventSubscriptionsClient::PATH (constant)">PATH</a></span></span>
|
|
1335
|
+
<span class='rparen'>)</span>
|
|
1336
|
+
|
|
1337
|
+
<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>
|
|
1338
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1339
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1340
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EventSubscriptionsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1341
|
+
<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/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">EventSubscription</a></span></span><span class='comma'>,</span>
|
|
1342
|
+
<span class='label'>danger:</span> <span class='kw'>true</span>
|
|
1343
|
+
<span class='rparen'>)</span>
|
|
1344
|
+
<span class='kw'>end</span></pre>
|
|
1345
|
+
</td>
|
|
1346
|
+
</tr>
|
|
1347
|
+
</table>
|
|
1348
|
+
</div>
|
|
1349
|
+
|
|
1350
|
+
<div class="method_details ">
|
|
1351
|
+
<h3 class="signature " id="update-instance_method">
|
|
1352
|
+
|
|
1353
|
+
#<strong>update</strong>(id: "", metadata: nil, description: nil, sources: nil, destination_ids: nil) ⇒ <tt><span class='object_link'><a href="../Models/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">NgrokAPI::Models::EventSubscription</a></span></tt>
|
|
1354
|
+
|
|
1355
|
+
|
|
1356
|
+
|
|
1357
|
+
|
|
1358
|
+
|
|
1359
|
+
</h3><div class="docstring">
|
|
1360
|
+
<div class="discussion">
|
|
1361
|
+
|
|
1362
|
+
<p>Update an Event Subscription.</p>
|
|
1363
|
+
|
|
1364
|
+
<p><a href="https://ngrok.com/docs/api#api-event-subscriptions-update">ngrok.com/docs/api#api-event-subscriptions-update</a></p>
|
|
1365
|
+
|
|
1366
|
+
|
|
1367
|
+
</div>
|
|
1368
|
+
</div>
|
|
1369
|
+
<div class="tags">
|
|
1370
|
+
<p class="tag_title">Parameters:</p>
|
|
1371
|
+
<ul class="param">
|
|
1372
|
+
|
|
1373
|
+
<li>
|
|
1374
|
+
|
|
1375
|
+
<span class='name'>id</span>
|
|
1376
|
+
|
|
1377
|
+
|
|
1378
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1379
|
+
|
|
1380
|
+
|
|
1381
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1382
|
+
|
|
1383
|
+
|
|
1384
|
+
—
|
|
1385
|
+
<div class='inline'>
|
|
1386
|
+
<p>Unique identifier for this Event Subscription.</p>
|
|
1387
|
+
</div>
|
|
1388
|
+
|
|
1389
|
+
</li>
|
|
1390
|
+
|
|
1391
|
+
<li>
|
|
1392
|
+
|
|
1393
|
+
<span class='name'>metadata</span>
|
|
1394
|
+
|
|
1395
|
+
|
|
1396
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1397
|
+
|
|
1398
|
+
|
|
1399
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1400
|
+
|
|
1401
|
+
|
|
1402
|
+
—
|
|
1403
|
+
<div class='inline'>
|
|
1404
|
+
<p>Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.</p>
|
|
1405
|
+
</div>
|
|
1406
|
+
|
|
1407
|
+
</li>
|
|
1408
|
+
|
|
1409
|
+
<li>
|
|
1410
|
+
|
|
1411
|
+
<span class='name'>description</span>
|
|
1412
|
+
|
|
1413
|
+
|
|
1414
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1415
|
+
|
|
1416
|
+
|
|
1417
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1418
|
+
|
|
1419
|
+
|
|
1420
|
+
—
|
|
1421
|
+
<div class='inline'>
|
|
1422
|
+
<p>Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.</p>
|
|
1423
|
+
</div>
|
|
1424
|
+
|
|
1425
|
+
</li>
|
|
1426
|
+
|
|
1427
|
+
<li>
|
|
1428
|
+
|
|
1429
|
+
<span class='name'>sources</span>
|
|
1430
|
+
|
|
1431
|
+
|
|
1432
|
+
<span class='type'>(<tt>List<EventSourceReplace></tt>)</span>
|
|
1433
|
+
|
|
1434
|
+
|
|
1435
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1436
|
+
|
|
1437
|
+
|
|
1438
|
+
—
|
|
1439
|
+
<div class='inline'>
|
|
1440
|
+
<p>Sources containing the types for which this event subscription will trigger</p>
|
|
1441
|
+
</div>
|
|
1442
|
+
|
|
1443
|
+
</li>
|
|
1444
|
+
|
|
1445
|
+
<li>
|
|
1446
|
+
|
|
1447
|
+
<span class='name'>destination_ids</span>
|
|
1448
|
+
|
|
1449
|
+
|
|
1450
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
|
1451
|
+
|
|
1452
|
+
|
|
1453
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1454
|
+
|
|
1455
|
+
|
|
1456
|
+
—
|
|
1457
|
+
<div class='inline'>
|
|
1458
|
+
<p>A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.</p>
|
|
1459
|
+
</div>
|
|
1460
|
+
|
|
1461
|
+
</li>
|
|
1462
|
+
|
|
1463
|
+
</ul>
|
|
1464
|
+
|
|
1465
|
+
<p class="tag_title">Returns:</p>
|
|
1466
|
+
<ul class="return">
|
|
1467
|
+
|
|
1468
|
+
<li>
|
|
1469
|
+
|
|
1470
|
+
|
|
1471
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">NgrokAPI::Models::EventSubscription</a></span></tt>)</span>
|
|
1472
|
+
|
|
1473
|
+
|
|
1474
|
+
|
|
1475
|
+
—
|
|
1476
|
+
<div class='inline'>
|
|
1477
|
+
<p>result from the API request</p>
|
|
1478
|
+
</div>
|
|
1479
|
+
|
|
1480
|
+
</li>
|
|
1481
|
+
|
|
1482
|
+
</ul>
|
|
1483
|
+
|
|
1484
|
+
</div><table class="source_code">
|
|
1485
|
+
<tr>
|
|
1486
|
+
<td>
|
|
1487
|
+
<pre class="lines">
|
|
1488
|
+
|
|
1489
|
+
|
|
1490
|
+
174
|
|
1491
|
+
175
|
|
1492
|
+
176
|
|
1493
|
+
177
|
|
1494
|
+
178
|
|
1495
|
+
179
|
|
1496
|
+
180
|
|
1497
|
+
181
|
|
1498
|
+
182
|
|
1499
|
+
183
|
|
1500
|
+
184
|
|
1501
|
+
185
|
|
1502
|
+
186</pre>
|
|
1503
|
+
</td>
|
|
1504
|
+
<td>
|
|
1505
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 174</span>
|
|
1506
|
+
|
|
1507
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>sources:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>destination_ids:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1508
|
+
<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/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1509
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1510
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1511
|
+
<span class='rbrace'>}</span>
|
|
1512
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1513
|
+
<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>
|
|
1514
|
+
<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>
|
|
1515
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:sources</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_sources'>sources</span> <span class='kw'>if</span> <span class='id identifier rubyid_sources'>sources</span>
|
|
1516
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:destination_ids</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_destination_ids'>destination_ids</span> <span class='kw'>if</span> <span class='id identifier rubyid_destination_ids'>destination_ids</span>
|
|
1517
|
+
<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>
|
|
1518
|
+
<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/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">EventSubscription</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventSubscription.html#initialize-instance_method" title="NgrokAPI::Models::EventSubscription#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>
|
|
1519
|
+
<span class='kw'>end</span></pre>
|
|
1520
|
+
</td>
|
|
1521
|
+
</tr>
|
|
1522
|
+
</table>
|
|
1523
|
+
</div>
|
|
1524
|
+
|
|
1525
|
+
<div class="method_details ">
|
|
1526
|
+
<h3 class="signature " id="update!-instance_method">
|
|
1527
|
+
|
|
1528
|
+
#<strong>update!</strong>(id: "", metadata: nil, description: nil, sources: nil, destination_ids: nil) ⇒ <tt><span class='object_link'><a href="../Models/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">NgrokAPI::Models::EventSubscription</a></span></tt>
|
|
1529
|
+
|
|
1530
|
+
|
|
1531
|
+
|
|
1532
|
+
|
|
1533
|
+
|
|
1534
|
+
</h3><div class="docstring">
|
|
1535
|
+
<div class="discussion">
|
|
1536
|
+
|
|
1537
|
+
<p>Update an Event Subscription. Throws an exception if API error.</p>
|
|
1538
|
+
|
|
1539
|
+
<p><a href="https://ngrok.com/docs/api#api-event-subscriptions-update">ngrok.com/docs/api#api-event-subscriptions-update</a></p>
|
|
1540
|
+
|
|
1541
|
+
|
|
1542
|
+
</div>
|
|
1543
|
+
</div>
|
|
1544
|
+
<div class="tags">
|
|
1545
|
+
<p class="tag_title">Parameters:</p>
|
|
1546
|
+
<ul class="param">
|
|
1547
|
+
|
|
1548
|
+
<li>
|
|
1549
|
+
|
|
1550
|
+
<span class='name'>id</span>
|
|
1551
|
+
|
|
1552
|
+
|
|
1553
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1554
|
+
|
|
1555
|
+
|
|
1556
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1557
|
+
|
|
1558
|
+
|
|
1559
|
+
—
|
|
1560
|
+
<div class='inline'>
|
|
1561
|
+
<p>Unique identifier for this Event Subscription.</p>
|
|
1562
|
+
</div>
|
|
1563
|
+
|
|
1564
|
+
</li>
|
|
1565
|
+
|
|
1566
|
+
<li>
|
|
1567
|
+
|
|
1568
|
+
<span class='name'>metadata</span>
|
|
1569
|
+
|
|
1570
|
+
|
|
1571
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1572
|
+
|
|
1573
|
+
|
|
1574
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1575
|
+
|
|
1576
|
+
|
|
1577
|
+
—
|
|
1578
|
+
<div class='inline'>
|
|
1579
|
+
<p>Arbitrary customer supplied information intended to be machine readable. Optional, max 4096 chars.</p>
|
|
1580
|
+
</div>
|
|
1581
|
+
|
|
1582
|
+
</li>
|
|
1583
|
+
|
|
1584
|
+
<li>
|
|
1585
|
+
|
|
1586
|
+
<span class='name'>description</span>
|
|
1587
|
+
|
|
1588
|
+
|
|
1589
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1590
|
+
|
|
1591
|
+
|
|
1592
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1593
|
+
|
|
1594
|
+
|
|
1595
|
+
—
|
|
1596
|
+
<div class='inline'>
|
|
1597
|
+
<p>Arbitrary customer supplied information intended to be human readable. Optional, max 255 chars.</p>
|
|
1598
|
+
</div>
|
|
1599
|
+
|
|
1600
|
+
</li>
|
|
1601
|
+
|
|
1602
|
+
<li>
|
|
1603
|
+
|
|
1604
|
+
<span class='name'>sources</span>
|
|
1605
|
+
|
|
1606
|
+
|
|
1607
|
+
<span class='type'>(<tt>List<EventSourceReplace></tt>)</span>
|
|
1608
|
+
|
|
1609
|
+
|
|
1610
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1611
|
+
|
|
1612
|
+
|
|
1613
|
+
—
|
|
1614
|
+
<div class='inline'>
|
|
1615
|
+
<p>Sources containing the types for which this event subscription will trigger</p>
|
|
1616
|
+
</div>
|
|
1617
|
+
|
|
1618
|
+
</li>
|
|
1619
|
+
|
|
1620
|
+
<li>
|
|
1621
|
+
|
|
1622
|
+
<span class='name'>destination_ids</span>
|
|
1623
|
+
|
|
1624
|
+
|
|
1625
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
|
1626
|
+
|
|
1627
|
+
|
|
1628
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1629
|
+
|
|
1630
|
+
|
|
1631
|
+
—
|
|
1632
|
+
<div class='inline'>
|
|
1633
|
+
<p>A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.</p>
|
|
1634
|
+
</div>
|
|
1635
|
+
|
|
1636
|
+
</li>
|
|
1637
|
+
|
|
1638
|
+
</ul>
|
|
1639
|
+
|
|
1640
|
+
<p class="tag_title">Returns:</p>
|
|
1641
|
+
<ul class="return">
|
|
1642
|
+
|
|
1643
|
+
<li>
|
|
1644
|
+
|
|
1645
|
+
|
|
1646
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">NgrokAPI::Models::EventSubscription</a></span></tt>)</span>
|
|
1647
|
+
|
|
1648
|
+
|
|
1649
|
+
|
|
1650
|
+
—
|
|
1651
|
+
<div class='inline'>
|
|
1652
|
+
<p>result from the API request</p>
|
|
1653
|
+
</div>
|
|
1654
|
+
|
|
1655
|
+
</li>
|
|
1656
|
+
|
|
1657
|
+
</ul>
|
|
1658
|
+
|
|
1659
|
+
</div><table class="source_code">
|
|
1660
|
+
<tr>
|
|
1661
|
+
<td>
|
|
1662
|
+
<pre class="lines">
|
|
1663
|
+
|
|
1664
|
+
|
|
1665
|
+
200
|
|
1666
|
+
201
|
|
1667
|
+
202
|
|
1668
|
+
203
|
|
1669
|
+
204
|
|
1670
|
+
205
|
|
1671
|
+
206
|
|
1672
|
+
207
|
|
1673
|
+
208
|
|
1674
|
+
209
|
|
1675
|
+
210
|
|
1676
|
+
211
|
|
1677
|
+
212</pre>
|
|
1678
|
+
</td>
|
|
1679
|
+
<td>
|
|
1680
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 200</span>
|
|
1681
|
+
|
|
1682
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>sources:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>destination_ids:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1683
|
+
<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/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1684
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1685
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1686
|
+
<span class='rbrace'>}</span>
|
|
1687
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1688
|
+
<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>
|
|
1689
|
+
<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>
|
|
1690
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:sources</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_sources'>sources</span> <span class='kw'>if</span> <span class='id identifier rubyid_sources'>sources</span>
|
|
1691
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:destination_ids</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_destination_ids'>destination_ids</span> <span class='kw'>if</span> <span class='id identifier rubyid_destination_ids'>destination_ids</span>
|
|
1692
|
+
<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>
|
|
1693
|
+
<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/EventSubscription.html" title="NgrokAPI::Models::EventSubscription (class)">EventSubscription</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventSubscription.html#initialize-instance_method" title="NgrokAPI::Models::EventSubscription#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>
|
|
1694
|
+
<span class='kw'>end</span></pre>
|
|
1695
|
+
</td>
|
|
1696
|
+
</tr>
|
|
1697
|
+
</table>
|
|
1698
|
+
</div>
|
|
1699
|
+
|
|
1700
|
+
</div>
|
|
1701
|
+
|
|
1702
|
+
</div>
|
|
1703
|
+
|
|
1704
|
+
<div id="footer">
|
|
1705
|
+
Generated on Thu Dec 2 18:48:56 2021 by
|
|
1706
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1707
|
+
0.9.27 (ruby-3.0.1).
|
|
1708
|
+
</div>
|
|
1709
|
+
|
|
1710
|
+
</div>
|
|
1711
|
+
</body>
|
|
1712
|
+
</html>
|