ngrok-api 0.9.0 → 0.16.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rubocop.yml +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
@@ -6,7 +6,7 @@
|
|
6
6
|
<title>
|
7
7
|
Class: NgrokAPI::Services::ReservedDomainsClient
|
8
8
|
|
9
|
-
— Documentation by YARD 0.9.
|
9
|
+
— Documentation by YARD 0.9.27
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -102,7 +102,7 @@
|
|
102
102
|
<h2>Overview</h2><div class="docstring">
|
103
103
|
<div class="discussion">
|
104
104
|
|
105
|
-
<p>
|
105
|
+
<p>Reserved Domains are hostnames that you can listen for traffic on. Domains can be used to listen for http, https or tls traffic. You may use a domain that you own by creating a CNAME record specified in the returned resource. This CNAME record points traffic for that domain to ngrok's edge servers.</p>
|
106
106
|
|
107
107
|
<p><a href="https://ngrok.com/docs/api#api-reserved-domains">ngrok.com/docs/api#api-reserved-domains</a></p>
|
108
108
|
|
@@ -121,11 +121,11 @@
|
|
121
121
|
|
122
122
|
<dl class="constants">
|
123
123
|
|
124
|
-
<dt id="
|
124
|
+
<dt id="PATH-constant" class="">PATH =
|
125
125
|
<div class="docstring">
|
126
126
|
<div class="discussion">
|
127
127
|
|
128
|
-
<p>The
|
128
|
+
<p>The API path for the requests</p>
|
129
129
|
|
130
130
|
|
131
131
|
</div>
|
@@ -135,13 +135,13 @@
|
|
135
135
|
|
136
136
|
</div>
|
137
137
|
</dt>
|
138
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'
|
138
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_domains</span><span class='tstring_end'>'</span></span></pre></dd>
|
139
139
|
|
140
|
-
<dt id="
|
140
|
+
<dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
|
141
141
|
<div class="docstring">
|
142
142
|
<div class="discussion">
|
143
143
|
|
144
|
-
<p>The API
|
144
|
+
<p>The List Property from the resulting API for list calls</p>
|
145
145
|
|
146
146
|
|
147
147
|
</div>
|
@@ -151,7 +151,7 @@
|
|
151
151
|
|
152
152
|
</div>
|
153
153
|
</dt>
|
154
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'
|
154
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>reserved_domains</span><span class='tstring_end'>'</span></span></pre></dd>
|
155
155
|
|
156
156
|
</dl>
|
157
157
|
|
@@ -207,7 +207,7 @@
|
|
207
207
|
<li class="public ">
|
208
208
|
<span class="summary_signature">
|
209
209
|
|
210
|
-
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(name
|
210
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(name:, region: "", description: "", metadata: "", http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil) ⇒ NgrokAPI::Models::ReservedDomain </a>
|
211
211
|
|
212
212
|
|
213
213
|
|
@@ -231,7 +231,7 @@
|
|
231
231
|
<li class="public ">
|
232
232
|
<span class="summary_signature">
|
233
233
|
|
234
|
-
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id:
|
234
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
235
235
|
|
236
236
|
|
237
237
|
|
@@ -255,7 +255,7 @@
|
|
255
255
|
<li class="public ">
|
256
256
|
<span class="summary_signature">
|
257
257
|
|
258
|
-
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id:
|
258
|
+
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
259
259
|
|
260
260
|
|
261
261
|
|
@@ -279,7 +279,7 @@
|
|
279
279
|
<li class="public ">
|
280
280
|
<span class="summary_signature">
|
281
281
|
|
282
|
-
<a href="#delete_certificate-instance_method" title="#delete_certificate (instance method)">#<strong>delete_certificate</strong>(id:
|
282
|
+
<a href="#delete_certificate-instance_method" title="#delete_certificate (instance method)">#<strong>delete_certificate</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
283
283
|
|
284
284
|
|
285
285
|
|
@@ -294,7 +294,7 @@
|
|
294
294
|
|
295
295
|
|
296
296
|
<span class="summary_desc"><div class='inline'>
|
297
|
-
<p>Detach the certificate attached
|
297
|
+
<p>Detach the certificate attached to a reserved domain.</p>
|
298
298
|
</div></span>
|
299
299
|
|
300
300
|
</li>
|
@@ -303,7 +303,7 @@
|
|
303
303
|
<li class="public ">
|
304
304
|
<span class="summary_signature">
|
305
305
|
|
306
|
-
<a href="#delete_certificate!-instance_method" title="#delete_certificate! (instance method)">#<strong>delete_certificate!</strong>(id:
|
306
|
+
<a href="#delete_certificate!-instance_method" title="#delete_certificate! (instance method)">#<strong>delete_certificate!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
307
307
|
|
308
308
|
|
309
309
|
|
@@ -318,7 +318,7 @@
|
|
318
318
|
|
319
319
|
|
320
320
|
<span class="summary_desc"><div class='inline'>
|
321
|
-
<p>Detach the certificate attached
|
321
|
+
<p>Detach the certificate attached to a reserved domain.</p>
|
322
322
|
</div></span>
|
323
323
|
|
324
324
|
</li>
|
@@ -327,7 +327,7 @@
|
|
327
327
|
<li class="public ">
|
328
328
|
<span class="summary_signature">
|
329
329
|
|
330
|
-
<a href="#delete_certificate_management_policy-instance_method" title="#delete_certificate_management_policy (instance method)">#<strong>delete_certificate_management_policy</strong>(id:
|
330
|
+
<a href="#delete_certificate_management_policy-instance_method" title="#delete_certificate_management_policy (instance method)">#<strong>delete_certificate_management_policy</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
331
331
|
|
332
332
|
|
333
333
|
|
@@ -342,7 +342,7 @@
|
|
342
342
|
|
343
343
|
|
344
344
|
<span class="summary_desc"><div class='inline'>
|
345
|
-
<p>Detach the certificate management policy attached
|
345
|
+
<p>Detach the certificate management policy attached to a reserved domain.</p>
|
346
346
|
</div></span>
|
347
347
|
|
348
348
|
</li>
|
@@ -351,7 +351,7 @@
|
|
351
351
|
<li class="public ">
|
352
352
|
<span class="summary_signature">
|
353
353
|
|
354
|
-
<a href="#delete_certificate_management_policy!-instance_method" title="#delete_certificate_management_policy! (instance method)">#<strong>delete_certificate_management_policy!</strong>(id:
|
354
|
+
<a href="#delete_certificate_management_policy!-instance_method" title="#delete_certificate_management_policy! (instance method)">#<strong>delete_certificate_management_policy!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
355
355
|
|
356
356
|
|
357
357
|
|
@@ -366,7 +366,7 @@
|
|
366
366
|
|
367
367
|
|
368
368
|
<span class="summary_desc"><div class='inline'>
|
369
|
-
<p>Detach the certificate management policy attached
|
369
|
+
<p>Detach the certificate management policy attached to a reserved domain.</p>
|
370
370
|
</div></span>
|
371
371
|
|
372
372
|
</li>
|
@@ -375,7 +375,7 @@
|
|
375
375
|
<li class="public ">
|
376
376
|
<span class="summary_signature">
|
377
377
|
|
378
|
-
<a href="#delete_http_endpoint_config-instance_method" title="#delete_http_endpoint_config (instance method)">#<strong>delete_http_endpoint_config</strong>(id:
|
378
|
+
<a href="#delete_http_endpoint_config-instance_method" title="#delete_http_endpoint_config (instance method)">#<strong>delete_http_endpoint_config</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
379
379
|
|
380
380
|
|
381
381
|
|
@@ -390,7 +390,7 @@
|
|
390
390
|
|
391
391
|
|
392
392
|
<span class="summary_desc"><div class='inline'>
|
393
|
-
<p>Detach the http endpoint configuration attached
|
393
|
+
<p>Detach the http endpoint configuration attached to a reserved domain.</p>
|
394
394
|
</div></span>
|
395
395
|
|
396
396
|
</li>
|
@@ -399,7 +399,7 @@
|
|
399
399
|
<li class="public ">
|
400
400
|
<span class="summary_signature">
|
401
401
|
|
402
|
-
<a href="#delete_http_endpoint_config!-instance_method" title="#delete_http_endpoint_config! (instance method)">#<strong>delete_http_endpoint_config!</strong>(id:
|
402
|
+
<a href="#delete_http_endpoint_config!-instance_method" title="#delete_http_endpoint_config! (instance method)">#<strong>delete_http_endpoint_config!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
403
403
|
|
404
404
|
|
405
405
|
|
@@ -414,7 +414,7 @@
|
|
414
414
|
|
415
415
|
|
416
416
|
<span class="summary_desc"><div class='inline'>
|
417
|
-
<p>Detach the http endpoint configuration attached
|
417
|
+
<p>Detach the http endpoint configuration attached to a reserved domain.</p>
|
418
418
|
</div></span>
|
419
419
|
|
420
420
|
</li>
|
@@ -423,7 +423,7 @@
|
|
423
423
|
<li class="public ">
|
424
424
|
<span class="summary_signature">
|
425
425
|
|
426
|
-
<a href="#delete_https_endpoint_config-instance_method" title="#delete_https_endpoint_config (instance method)">#<strong>delete_https_endpoint_config</strong>(id:
|
426
|
+
<a href="#delete_https_endpoint_config-instance_method" title="#delete_https_endpoint_config (instance method)">#<strong>delete_https_endpoint_config</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
427
427
|
|
428
428
|
|
429
429
|
|
@@ -438,7 +438,7 @@
|
|
438
438
|
|
439
439
|
|
440
440
|
<span class="summary_desc"><div class='inline'>
|
441
|
-
<p>Detach the https endpoint configuration attached
|
441
|
+
<p>Detach the https endpoint configuration attached to a reserved domain.</p>
|
442
442
|
</div></span>
|
443
443
|
|
444
444
|
</li>
|
@@ -447,7 +447,7 @@
|
|
447
447
|
<li class="public ">
|
448
448
|
<span class="summary_signature">
|
449
449
|
|
450
|
-
<a href="#delete_https_endpoint_config!-instance_method" title="#delete_https_endpoint_config! (instance method)">#<strong>delete_https_endpoint_config!</strong>(id:
|
450
|
+
<a href="#delete_https_endpoint_config!-instance_method" title="#delete_https_endpoint_config! (instance method)">#<strong>delete_https_endpoint_config!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
451
451
|
|
452
452
|
|
453
453
|
|
@@ -462,7 +462,7 @@
|
|
462
462
|
|
463
463
|
|
464
464
|
<span class="summary_desc"><div class='inline'>
|
465
|
-
<p>Detach the https endpoint configuration attached
|
465
|
+
<p>Detach the https endpoint configuration attached to a reserved domain.</p>
|
466
466
|
</div></span>
|
467
467
|
|
468
468
|
</li>
|
@@ -471,7 +471,7 @@
|
|
471
471
|
<li class="public ">
|
472
472
|
<span class="summary_signature">
|
473
473
|
|
474
|
-
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id:
|
474
|
+
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: "") ⇒ NgrokAPI::Models::ReservedDomain </a>
|
475
475
|
|
476
476
|
|
477
477
|
|
@@ -495,7 +495,7 @@
|
|
495
495
|
<li class="public ">
|
496
496
|
<span class="summary_signature">
|
497
497
|
|
498
|
-
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id:
|
498
|
+
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: "") ⇒ NgrokAPI::Models::ReservedDomain </a>
|
499
499
|
|
500
500
|
|
501
501
|
|
@@ -569,7 +569,31 @@
|
|
569
569
|
<li class="public ">
|
570
570
|
<span class="summary_signature">
|
571
571
|
|
572
|
-
<a href="#
|
572
|
+
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
573
|
+
|
574
|
+
|
575
|
+
|
576
|
+
</span>
|
577
|
+
|
578
|
+
|
579
|
+
|
580
|
+
|
581
|
+
|
582
|
+
|
583
|
+
|
584
|
+
|
585
|
+
|
586
|
+
<span class="summary_desc"><div class='inline'>
|
587
|
+
<p>List all reserved domains on this account.</p>
|
588
|
+
</div></span>
|
589
|
+
|
590
|
+
</li>
|
591
|
+
|
592
|
+
|
593
|
+
<li class="public ">
|
594
|
+
<span class="summary_signature">
|
595
|
+
|
596
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", description: nil, metadata: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil) ⇒ NgrokAPI::Models::ReservedDomain </a>
|
573
597
|
|
574
598
|
|
575
599
|
|
@@ -593,7 +617,7 @@
|
|
593
617
|
<li class="public ">
|
594
618
|
<span class="summary_signature">
|
595
619
|
|
596
|
-
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id:
|
620
|
+
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: "", description: nil, metadata: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil) ⇒ NgrokAPI::Models::ReservedDomain </a>
|
597
621
|
|
598
622
|
|
599
623
|
|
@@ -646,15 +670,15 @@
|
|
646
670
|
<pre class="lines">
|
647
671
|
|
648
672
|
|
649
|
-
|
650
|
-
|
651
|
-
|
673
|
+
20
|
674
|
+
21
|
675
|
+
22</pre>
|
652
676
|
</td>
|
653
677
|
<td>
|
654
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
678
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 20</span>
|
655
679
|
|
656
|
-
<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>
|
657
|
-
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
680
|
+
<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>
|
681
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
658
682
|
<span class='kw'>end</span></pre>
|
659
683
|
</td>
|
660
684
|
</tr>
|
@@ -694,12 +718,12 @@
|
|
694
718
|
<pre class="lines">
|
695
719
|
|
696
720
|
|
697
|
-
|
698
|
-
|
699
|
-
|
721
|
+
18
|
722
|
+
19
|
723
|
+
20</pre>
|
700
724
|
</td>
|
701
725
|
<td>
|
702
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
726
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 18</span>
|
703
727
|
|
704
728
|
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
705
729
|
<span class='ivar'>@client</span>
|
@@ -719,7 +743,7 @@
|
|
719
743
|
<div class="method_details first">
|
720
744
|
<h3 class="signature first" id="create-instance_method">
|
721
745
|
|
722
|
-
#<strong>create</strong>(name
|
746
|
+
#<strong>create</strong>(name:, region: "", description: "", metadata: "", http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil) ⇒ <tt><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>
|
723
747
|
|
724
748
|
|
725
749
|
|
@@ -747,8 +771,6 @@
|
|
747
771
|
<span class='type'>(<tt>string</tt>)</span>
|
748
772
|
|
749
773
|
|
750
|
-
<em class="default">(defaults to: <tt>''</tt>)</em>
|
751
|
-
|
752
774
|
|
753
775
|
—
|
754
776
|
<div class='inline'>
|
@@ -765,7 +787,7 @@
|
|
765
787
|
<span class='type'>(<tt>string</tt>)</span>
|
766
788
|
|
767
789
|
|
768
|
-
<em class="default">(defaults to: <tt
|
790
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
769
791
|
|
770
792
|
|
771
793
|
—
|
@@ -783,7 +805,7 @@
|
|
783
805
|
<span class='type'>(<tt>string</tt>)</span>
|
784
806
|
|
785
807
|
|
786
|
-
<em class="default">(defaults to: <tt
|
808
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
787
809
|
|
788
810
|
|
789
811
|
—
|
@@ -801,7 +823,7 @@
|
|
801
823
|
<span class='type'>(<tt>string</tt>)</span>
|
802
824
|
|
803
825
|
|
804
|
-
<em class="default">(defaults to: <tt
|
826
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
805
827
|
|
806
828
|
|
807
829
|
—
|
@@ -819,7 +841,7 @@
|
|
819
841
|
<span class='type'>(<tt>string</tt>)</span>
|
820
842
|
|
821
843
|
|
822
|
-
<em class="default">(defaults to: <tt
|
844
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
823
845
|
|
824
846
|
|
825
847
|
—
|
@@ -837,7 +859,7 @@
|
|
837
859
|
<span class='type'>(<tt>string</tt>)</span>
|
838
860
|
|
839
861
|
|
840
|
-
<em class="default">(defaults to: <tt
|
862
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
841
863
|
|
842
864
|
|
843
865
|
—
|
@@ -860,7 +882,7 @@
|
|
860
882
|
|
861
883
|
—
|
862
884
|
<div class='inline'>
|
863
|
-
<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with
|
885
|
+
<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with <code>certificate_management_policy</code>.</p>
|
864
886
|
</div>
|
865
887
|
|
866
888
|
</li>
|
@@ -870,7 +892,7 @@
|
|
870
892
|
<span class='name'>certificate_management_policy</span>
|
871
893
|
|
872
894
|
|
873
|
-
<span class='type'>(<tt>
|
895
|
+
<span class='type'>(<tt>ReservedDomainCertPolicy</tt>)</span>
|
874
896
|
|
875
897
|
|
876
898
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -878,7 +900,7 @@
|
|
878
900
|
|
879
901
|
—
|
880
902
|
<div class='inline'>
|
881
|
-
<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with
|
903
|
+
<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with <code>certificate_id</code>.</p>
|
882
904
|
</div>
|
883
905
|
|
884
906
|
</li>
|
@@ -897,7 +919,7 @@
|
|
897
919
|
|
898
920
|
—
|
899
921
|
<div class='inline'>
|
900
|
-
<p>result from
|
922
|
+
<p>result from the API request</p>
|
901
923
|
</div>
|
902
924
|
|
903
925
|
</li>
|
@@ -910,7 +932,6 @@
|
|
910
932
|
<pre class="lines">
|
911
933
|
|
912
934
|
|
913
|
-
37
|
914
935
|
38
|
915
936
|
39
|
916
937
|
40
|
@@ -926,39 +947,26 @@
|
|
926
947
|
50
|
927
948
|
51
|
928
949
|
52
|
929
|
-
53
|
930
|
-
54
|
931
|
-
55
|
932
|
-
56
|
933
|
-
57
|
934
|
-
58
|
935
|
-
59</pre>
|
950
|
+
53</pre>
|
936
951
|
</td>
|
937
952
|
<td>
|
938
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
939
|
-
|
940
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span>
|
941
|
-
<span class='
|
942
|
-
<span class='
|
943
|
-
<span class='
|
944
|
-
<span class='
|
945
|
-
<span class='
|
946
|
-
<span class='
|
947
|
-
<span class='
|
948
|
-
<span class='
|
949
|
-
<span class='
|
950
|
-
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='
|
951
|
-
|
952
|
-
|
953
|
-
|
954
|
-
|
955
|
-
<span class='label'>http_endpoint_configuration_id:</span> <span class='id identifier rubyid_http_endpoint_configuration_id'>http_endpoint_configuration_id</span><span class='comma'>,</span>
|
956
|
-
<span class='label'>https_endpoint_configuration_id:</span> <span class='id identifier rubyid_https_endpoint_configuration_id'>https_endpoint_configuration_id</span><span class='comma'>,</span>
|
957
|
-
<span class='label'>certificate_id:</span> <span class='id identifier rubyid_certificate_id'>certificate_id</span><span class='comma'>,</span>
|
958
|
-
<span class='label'>certificate_management_policy:</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span><span class='comma'>,</span>
|
959
|
-
<span class='rbrace'>}</span>
|
960
|
-
<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='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
961
|
-
<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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
953
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 38</span>
|
954
|
+
|
955
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>name:</span><span class='comma'>,</span> <span class='label'>region:</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'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>http_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>https_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>certificate_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>certificate_management_policy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
956
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_domains</span><span class='tstring_end'>'</span></span>
|
957
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
958
|
+
<span class='rbrace'>}</span>
|
959
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
960
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>if</span> <span class='id identifier rubyid_name'>name</span>
|
961
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:region</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_region'>region</span> <span class='kw'>if</span> <span class='id identifier rubyid_region'>region</span>
|
962
|
+
<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>
|
963
|
+
<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>
|
964
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:http_endpoint_configuration_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_http_endpoint_configuration_id'>http_endpoint_configuration_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_http_endpoint_configuration_id'>http_endpoint_configuration_id</span>
|
965
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:https_endpoint_configuration_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_https_endpoint_configuration_id'>https_endpoint_configuration_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_https_endpoint_configuration_id'>https_endpoint_configuration_id</span>
|
966
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:certificate_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_certificate_id'>certificate_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_certificate_id'>certificate_id</span>
|
967
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:certificate_management_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span>
|
968
|
+
<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>
|
969
|
+
<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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#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>
|
962
970
|
<span class='kw'>end</span></pre>
|
963
971
|
</td>
|
964
972
|
</tr>
|
@@ -968,7 +976,7 @@
|
|
968
976
|
<div class="method_details ">
|
969
977
|
<h3 class="signature " id="delete-instance_method">
|
970
978
|
|
971
|
-
#<strong>delete</strong>(id:
|
979
|
+
#<strong>delete</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
972
980
|
|
973
981
|
|
974
982
|
|
@@ -996,7 +1004,7 @@
|
|
996
1004
|
<span class='type'>(<tt>string</tt>)</span>
|
997
1005
|
|
998
1006
|
|
999
|
-
<em class="default">(defaults to: <tt
|
1007
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1000
1008
|
|
1001
1009
|
|
1002
1010
|
—
|
@@ -1014,13 +1022,13 @@
|
|
1014
1022
|
<li>
|
1015
1023
|
|
1016
1024
|
|
1017
|
-
<span class='type'>(<tt>
|
1025
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
1018
1026
|
|
1019
1027
|
|
1020
1028
|
|
1021
1029
|
—
|
1022
1030
|
<div class='inline'>
|
1023
|
-
<p>result from
|
1031
|
+
<p>result from the API request</p>
|
1024
1032
|
</div>
|
1025
1033
|
|
1026
1034
|
</li>
|
@@ -1033,15 +1041,23 @@
|
|
1033
1041
|
<pre class="lines">
|
1034
1042
|
|
1035
1043
|
|
1036
|
-
|
1037
|
-
|
1038
|
-
|
1044
|
+
62
|
1045
|
+
63
|
1046
|
+
64
|
1047
|
+
65
|
1048
|
+
66
|
1049
|
+
67
|
1050
|
+
68</pre>
|
1039
1051
|
</td>
|
1040
1052
|
<td>
|
1041
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
1042
|
-
|
1043
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='
|
1044
|
-
<span class='
|
1053
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 62</span>
|
1054
|
+
|
1055
|
+
<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>
|
1056
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_domains/%{id}</span><span class='tstring_end'>'</span></span>
|
1057
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1058
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1059
|
+
<span class='rbrace'>}</span>
|
1060
|
+
<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>
|
1045
1061
|
<span class='kw'>end</span></pre>
|
1046
1062
|
</td>
|
1047
1063
|
</tr>
|
@@ -1051,7 +1067,7 @@
|
|
1051
1067
|
<div class="method_details ">
|
1052
1068
|
<h3 class="signature " id="delete!-instance_method">
|
1053
1069
|
|
1054
|
-
#<strong>delete!</strong>(id:
|
1070
|
+
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
1055
1071
|
|
1056
1072
|
|
1057
1073
|
|
@@ -1060,7 +1076,7 @@
|
|
1060
1076
|
</h3><div class="docstring">
|
1061
1077
|
<div class="discussion">
|
1062
1078
|
|
1063
|
-
<p>Delete a reserved domain.
|
1079
|
+
<p>Delete a reserved domain. Throws an exception if API error.</p>
|
1064
1080
|
|
1065
1081
|
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete">ngrok.com/docs/api#api-reserved-domains-delete</a></p>
|
1066
1082
|
|
@@ -1079,7 +1095,7 @@
|
|
1079
1095
|
<span class='type'>(<tt>string</tt>)</span>
|
1080
1096
|
|
1081
1097
|
|
1082
|
-
<em class="default">(defaults to: <tt
|
1098
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1083
1099
|
|
1084
1100
|
|
1085
1101
|
—
|
@@ -1097,13 +1113,13 @@
|
|
1097
1113
|
<li>
|
1098
1114
|
|
1099
1115
|
|
1100
|
-
<span class='type'>(<tt>
|
1116
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
1101
1117
|
|
1102
1118
|
|
1103
1119
|
|
1104
1120
|
—
|
1105
1121
|
<div class='inline'>
|
1106
|
-
<p>result from
|
1122
|
+
<p>result from the API request</p>
|
1107
1123
|
</div>
|
1108
1124
|
|
1109
1125
|
</li>
|
@@ -1116,15 +1132,23 @@
|
|
1116
1132
|
<pre class="lines">
|
1117
1133
|
|
1118
1134
|
|
1135
|
+
78
|
1136
|
+
79
|
1119
1137
|
80
|
1120
1138
|
81
|
1121
|
-
82
|
1139
|
+
82
|
1140
|
+
83
|
1141
|
+
84</pre>
|
1122
1142
|
</td>
|
1123
1143
|
<td>
|
1124
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
1125
|
-
|
1126
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='
|
1127
|
-
<span class='
|
1144
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 78</span>
|
1145
|
+
|
1146
|
+
<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>
|
1147
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_domains/%{id}</span><span class='tstring_end'>'</span></span>
|
1148
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1149
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1150
|
+
<span class='rbrace'>}</span>
|
1151
|
+
<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>
|
1128
1152
|
<span class='kw'>end</span></pre>
|
1129
1153
|
</td>
|
1130
1154
|
</tr>
|
@@ -1134,7 +1158,7 @@
|
|
1134
1158
|
<div class="method_details ">
|
1135
1159
|
<h3 class="signature " id="delete_certificate-instance_method">
|
1136
1160
|
|
1137
|
-
#<strong>delete_certificate</strong>(id:
|
1161
|
+
#<strong>delete_certificate</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
1138
1162
|
|
1139
1163
|
|
1140
1164
|
|
@@ -1143,7 +1167,7 @@
|
|
1143
1167
|
</h3><div class="docstring">
|
1144
1168
|
<div class="discussion">
|
1145
1169
|
|
1146
|
-
<p>Detach the certificate attached
|
1170
|
+
<p>Detach the certificate attached to a reserved domain.</p>
|
1147
1171
|
|
1148
1172
|
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-certificate">ngrok.com/docs/api#api-reserved-domains-delete-certificate</a></p>
|
1149
1173
|
|
@@ -1162,7 +1186,7 @@
|
|
1162
1186
|
<span class='type'>(<tt>string</tt>)</span>
|
1163
1187
|
|
1164
1188
|
|
1165
|
-
<em class="default">(defaults to: <tt
|
1189
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1166
1190
|
|
1167
1191
|
|
1168
1192
|
—
|
@@ -1180,13 +1204,13 @@
|
|
1180
1204
|
<li>
|
1181
1205
|
|
1182
1206
|
|
1183
|
-
<span class='type'>(<tt>
|
1207
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
1184
1208
|
|
1185
1209
|
|
1186
1210
|
|
1187
1211
|
—
|
1188
1212
|
<div class='inline'>
|
1189
|
-
<p>result from
|
1213
|
+
<p>result from the API request</p>
|
1190
1214
|
</div>
|
1191
1215
|
|
1192
1216
|
</li>
|
@@ -1199,15 +1223,23 @@
|
|
1199
1223
|
<pre class="lines">
|
1200
1224
|
|
1201
1225
|
|
1202
|
-
|
1203
|
-
|
1204
|
-
|
1226
|
+
273
|
1227
|
+
274
|
1228
|
+
275
|
1229
|
+
276
|
1230
|
+
277
|
1231
|
+
278
|
1232
|
+
279</pre>
|
1205
1233
|
</td>
|
1206
1234
|
<td>
|
1207
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
1208
|
-
|
1209
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate'>delete_certificate</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='
|
1210
|
-
<span class='
|
1235
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 273</span>
|
1236
|
+
|
1237
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate'>delete_certificate</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>
|
1238
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_domains/%{id}/certificate</span><span class='tstring_end'>'</span></span>
|
1239
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1240
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1241
|
+
<span class='rbrace'>}</span>
|
1242
|
+
<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>
|
1211
1243
|
<span class='kw'>end</span></pre>
|
1212
1244
|
</td>
|
1213
1245
|
</tr>
|
@@ -1217,7 +1249,7 @@
|
|
1217
1249
|
<div class="method_details ">
|
1218
1250
|
<h3 class="signature " id="delete_certificate!-instance_method">
|
1219
1251
|
|
1220
|
-
#<strong>delete_certificate!</strong>(id:
|
1252
|
+
#<strong>delete_certificate!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
1221
1253
|
|
1222
1254
|
|
1223
1255
|
|
@@ -1226,7 +1258,7 @@
|
|
1226
1258
|
</h3><div class="docstring">
|
1227
1259
|
<div class="discussion">
|
1228
1260
|
|
1229
|
-
<p>Detach the certificate attached
|
1261
|
+
<p>Detach the certificate attached to a reserved domain. Throws an exception if API error.</p>
|
1230
1262
|
|
1231
1263
|
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-certificate">ngrok.com/docs/api#api-reserved-domains-delete-certificate</a></p>
|
1232
1264
|
|
@@ -1245,7 +1277,7 @@
|
|
1245
1277
|
<span class='type'>(<tt>string</tt>)</span>
|
1246
1278
|
|
1247
1279
|
|
1248
|
-
<em class="default">(defaults to: <tt
|
1280
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1249
1281
|
|
1250
1282
|
|
1251
1283
|
—
|
@@ -1263,13 +1295,13 @@
|
|
1263
1295
|
<li>
|
1264
1296
|
|
1265
1297
|
|
1266
|
-
<span class='type'>(<tt>
|
1298
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
1267
1299
|
|
1268
1300
|
|
1269
1301
|
|
1270
1302
|
—
|
1271
1303
|
<div class='inline'>
|
1272
|
-
<p>result from
|
1304
|
+
<p>result from the API request</p>
|
1273
1305
|
</div>
|
1274
1306
|
|
1275
1307
|
</li>
|
@@ -1282,15 +1314,23 @@
|
|
1282
1314
|
<pre class="lines">
|
1283
1315
|
|
1284
1316
|
|
1285
|
-
|
1286
|
-
|
1287
|
-
|
1317
|
+
289
|
1318
|
+
290
|
1319
|
+
291
|
1320
|
+
292
|
1321
|
+
293
|
1322
|
+
294
|
1323
|
+
295</pre>
|
1288
1324
|
</td>
|
1289
1325
|
<td>
|
1290
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
1291
|
-
|
1292
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate!'>delete_certificate!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='
|
1293
|
-
<span class='
|
1326
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 289</span>
|
1327
|
+
|
1328
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate!'>delete_certificate!</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>
|
1329
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_domains/%{id}/certificate</span><span class='tstring_end'>'</span></span>
|
1330
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1331
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1332
|
+
<span class='rbrace'>}</span>
|
1333
|
+
<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>
|
1294
1334
|
<span class='kw'>end</span></pre>
|
1295
1335
|
</td>
|
1296
1336
|
</tr>
|
@@ -1300,7 +1340,7 @@
|
|
1300
1340
|
<div class="method_details ">
|
1301
1341
|
<h3 class="signature " id="delete_certificate_management_policy-instance_method">
|
1302
1342
|
|
1303
|
-
#<strong>delete_certificate_management_policy</strong>(id:
|
1343
|
+
#<strong>delete_certificate_management_policy</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
1304
1344
|
|
1305
1345
|
|
1306
1346
|
|
@@ -1309,7 +1349,7 @@
|
|
1309
1349
|
</h3><div class="docstring">
|
1310
1350
|
<div class="discussion">
|
1311
1351
|
|
1312
|
-
<p>Detach the certificate management policy attached
|
1352
|
+
<p>Detach the certificate management policy attached to a reserved domain.</p>
|
1313
1353
|
|
1314
1354
|
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy">ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy</a></p>
|
1315
1355
|
|
@@ -1328,7 +1368,7 @@
|
|
1328
1368
|
<span class='type'>(<tt>string</tt>)</span>
|
1329
1369
|
|
1330
1370
|
|
1331
|
-
<em class="default">(defaults to: <tt
|
1371
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1332
1372
|
|
1333
1373
|
|
1334
1374
|
—
|
@@ -1346,13 +1386,13 @@
|
|
1346
1386
|
<li>
|
1347
1387
|
|
1348
1388
|
|
1349
|
-
<span class='type'>(<tt>
|
1389
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
1350
1390
|
|
1351
1391
|
|
1352
1392
|
|
1353
1393
|
—
|
1354
1394
|
<div class='inline'>
|
1355
|
-
<p>result from
|
1395
|
+
<p>result from the API request</p>
|
1356
1396
|
</div>
|
1357
1397
|
|
1358
1398
|
</li>
|
@@ -1365,15 +1405,23 @@
|
|
1365
1405
|
<pre class="lines">
|
1366
1406
|
|
1367
1407
|
|
1368
|
-
|
1369
|
-
|
1370
|
-
|
1408
|
+
242
|
1409
|
+
243
|
1410
|
+
244
|
1411
|
+
245
|
1412
|
+
246
|
1413
|
+
247
|
1414
|
+
248</pre>
|
1371
1415
|
</td>
|
1372
1416
|
<td>
|
1373
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
1374
|
-
|
1375
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate_management_policy'>delete_certificate_management_policy</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='
|
1376
|
-
<span class='
|
1417
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 242</span>
|
1418
|
+
|
1419
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate_management_policy'>delete_certificate_management_policy</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>
|
1420
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_domains/%{id}/certificate_management_policy</span><span class='tstring_end'>'</span></span>
|
1421
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1422
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1423
|
+
<span class='rbrace'>}</span>
|
1424
|
+
<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>
|
1377
1425
|
<span class='kw'>end</span></pre>
|
1378
1426
|
</td>
|
1379
1427
|
</tr>
|
@@ -1383,7 +1431,7 @@
|
|
1383
1431
|
<div class="method_details ">
|
1384
1432
|
<h3 class="signature " id="delete_certificate_management_policy!-instance_method">
|
1385
1433
|
|
1386
|
-
#<strong>delete_certificate_management_policy!</strong>(id:
|
1434
|
+
#<strong>delete_certificate_management_policy!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
1387
1435
|
|
1388
1436
|
|
1389
1437
|
|
@@ -1392,7 +1440,7 @@
|
|
1392
1440
|
</h3><div class="docstring">
|
1393
1441
|
<div class="discussion">
|
1394
1442
|
|
1395
|
-
<p>Detach the certificate management policy attached
|
1443
|
+
<p>Detach the certificate management policy attached to a reserved domain. Throws an exception if API error.</p>
|
1396
1444
|
|
1397
1445
|
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy">ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy</a></p>
|
1398
1446
|
|
@@ -1411,7 +1459,7 @@
|
|
1411
1459
|
<span class='type'>(<tt>string</tt>)</span>
|
1412
1460
|
|
1413
1461
|
|
1414
|
-
<em class="default">(defaults to: <tt
|
1462
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1415
1463
|
|
1416
1464
|
|
1417
1465
|
—
|
@@ -1429,13 +1477,13 @@
|
|
1429
1477
|
<li>
|
1430
1478
|
|
1431
1479
|
|
1432
|
-
<span class='type'>(<tt>
|
1480
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
1433
1481
|
|
1434
1482
|
|
1435
1483
|
|
1436
1484
|
—
|
1437
1485
|
<div class='inline'>
|
1438
|
-
<p>result from
|
1486
|
+
<p>result from the API request</p>
|
1439
1487
|
</div>
|
1440
1488
|
|
1441
1489
|
</li>
|
@@ -1448,15 +1496,23 @@
|
|
1448
1496
|
<pre class="lines">
|
1449
1497
|
|
1450
1498
|
|
1451
|
-
|
1452
|
-
|
1453
|
-
|
1499
|
+
258
|
1500
|
+
259
|
1501
|
+
260
|
1502
|
+
261
|
1503
|
+
262
|
1504
|
+
263
|
1505
|
+
264</pre>
|
1454
1506
|
</td>
|
1455
1507
|
<td>
|
1456
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
1457
|
-
|
1458
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate_management_policy!'>delete_certificate_management_policy!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='
|
1459
|
-
<span class='
|
1508
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 258</span>
|
1509
|
+
|
1510
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate_management_policy!'>delete_certificate_management_policy!</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>
|
1511
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_domains/%{id}/certificate_management_policy</span><span class='tstring_end'>'</span></span>
|
1512
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1513
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1514
|
+
<span class='rbrace'>}</span>
|
1515
|
+
<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>
|
1460
1516
|
<span class='kw'>end</span></pre>
|
1461
1517
|
</td>
|
1462
1518
|
</tr>
|
@@ -1466,7 +1522,7 @@
|
|
1466
1522
|
<div class="method_details ">
|
1467
1523
|
<h3 class="signature " id="delete_http_endpoint_config-instance_method">
|
1468
1524
|
|
1469
|
-
#<strong>delete_http_endpoint_config</strong>(id:
|
1525
|
+
#<strong>delete_http_endpoint_config</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
1470
1526
|
|
1471
1527
|
|
1472
1528
|
|
@@ -1475,7 +1531,7 @@
|
|
1475
1531
|
</h3><div class="docstring">
|
1476
1532
|
<div class="discussion">
|
1477
1533
|
|
1478
|
-
<p>Detach the http endpoint configuration attached
|
1534
|
+
<p>Detach the http endpoint configuration attached to a reserved domain.</p>
|
1479
1535
|
|
1480
1536
|
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-http-endpoint-config">ngrok.com/docs/api#api-reserved-domains-delete-http-endpoint-config</a></p>
|
1481
1537
|
|
@@ -1494,7 +1550,7 @@
|
|
1494
1550
|
<span class='type'>(<tt>string</tt>)</span>
|
1495
1551
|
|
1496
1552
|
|
1497
|
-
<em class="default">(defaults to: <tt
|
1553
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1498
1554
|
|
1499
1555
|
|
1500
1556
|
—
|
@@ -1512,13 +1568,13 @@
|
|
1512
1568
|
<li>
|
1513
1569
|
|
1514
1570
|
|
1515
|
-
<span class='type'>(<tt>
|
1571
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
1516
1572
|
|
1517
1573
|
|
1518
1574
|
|
1519
1575
|
—
|
1520
1576
|
<div class='inline'>
|
1521
|
-
<p>result from
|
1577
|
+
<p>result from the API request</p>
|
1522
1578
|
</div>
|
1523
1579
|
|
1524
1580
|
</li>
|
@@ -1531,15 +1587,23 @@
|
|
1531
1587
|
<pre class="lines">
|
1532
1588
|
|
1533
1589
|
|
1534
|
-
|
1535
|
-
|
1536
|
-
|
1590
|
+
304
|
1591
|
+
305
|
1592
|
+
306
|
1593
|
+
307
|
1594
|
+
308
|
1595
|
+
309
|
1596
|
+
310</pre>
|
1537
1597
|
</td>
|
1538
1598
|
<td>
|
1539
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
1540
|
-
|
1541
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete_http_endpoint_config'>delete_http_endpoint_config</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='
|
1542
|
-
<span class='
|
1599
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 304</span>
|
1600
|
+
|
1601
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_http_endpoint_config'>delete_http_endpoint_config</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>
|
1602
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_domains/%{id}/http_endpoint_configuration</span><span class='tstring_end'>'</span></span>
|
1603
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1604
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1605
|
+
<span class='rbrace'>}</span>
|
1606
|
+
<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>
|
1543
1607
|
<span class='kw'>end</span></pre>
|
1544
1608
|
</td>
|
1545
1609
|
</tr>
|
@@ -1549,7 +1613,7 @@
|
|
1549
1613
|
<div class="method_details ">
|
1550
1614
|
<h3 class="signature " id="delete_http_endpoint_config!-instance_method">
|
1551
1615
|
|
1552
|
-
#<strong>delete_http_endpoint_config!</strong>(id:
|
1616
|
+
#<strong>delete_http_endpoint_config!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
1553
1617
|
|
1554
1618
|
|
1555
1619
|
|
@@ -1558,7 +1622,7 @@
|
|
1558
1622
|
</h3><div class="docstring">
|
1559
1623
|
<div class="discussion">
|
1560
1624
|
|
1561
|
-
<p>Detach the http endpoint configuration attached
|
1625
|
+
<p>Detach the http endpoint configuration attached to a reserved domain. Throws an exception if API error.</p>
|
1562
1626
|
|
1563
1627
|
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-http-endpoint-config">ngrok.com/docs/api#api-reserved-domains-delete-http-endpoint-config</a></p>
|
1564
1628
|
|
@@ -1577,7 +1641,7 @@
|
|
1577
1641
|
<span class='type'>(<tt>string</tt>)</span>
|
1578
1642
|
|
1579
1643
|
|
1580
|
-
<em class="default">(defaults to: <tt
|
1644
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1581
1645
|
|
1582
1646
|
|
1583
1647
|
—
|
@@ -1595,13 +1659,13 @@
|
|
1595
1659
|
<li>
|
1596
1660
|
|
1597
1661
|
|
1598
|
-
<span class='type'>(<tt>
|
1662
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
1599
1663
|
|
1600
1664
|
|
1601
1665
|
|
1602
1666
|
—
|
1603
1667
|
<div class='inline'>
|
1604
|
-
<p>result from
|
1668
|
+
<p>result from the API request</p>
|
1605
1669
|
</div>
|
1606
1670
|
|
1607
1671
|
</li>
|
@@ -1614,15 +1678,23 @@
|
|
1614
1678
|
<pre class="lines">
|
1615
1679
|
|
1616
1680
|
|
1617
|
-
|
1618
|
-
|
1619
|
-
|
1681
|
+
320
|
1682
|
+
321
|
1683
|
+
322
|
1684
|
+
323
|
1685
|
+
324
|
1686
|
+
325
|
1687
|
+
326</pre>
|
1620
1688
|
</td>
|
1621
1689
|
<td>
|
1622
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
1623
|
-
|
1624
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete_http_endpoint_config!'>delete_http_endpoint_config!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='
|
1625
|
-
<span class='
|
1690
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 320</span>
|
1691
|
+
|
1692
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_http_endpoint_config!'>delete_http_endpoint_config!</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>
|
1693
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_domains/%{id}/http_endpoint_configuration</span><span class='tstring_end'>'</span></span>
|
1694
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1695
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1696
|
+
<span class='rbrace'>}</span>
|
1697
|
+
<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>
|
1626
1698
|
<span class='kw'>end</span></pre>
|
1627
1699
|
</td>
|
1628
1700
|
</tr>
|
@@ -1632,7 +1704,7 @@
|
|
1632
1704
|
<div class="method_details ">
|
1633
1705
|
<h3 class="signature " id="delete_https_endpoint_config-instance_method">
|
1634
1706
|
|
1635
|
-
#<strong>delete_https_endpoint_config</strong>(id:
|
1707
|
+
#<strong>delete_https_endpoint_config</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
1636
1708
|
|
1637
1709
|
|
1638
1710
|
|
@@ -1641,7 +1713,7 @@
|
|
1641
1713
|
</h3><div class="docstring">
|
1642
1714
|
<div class="discussion">
|
1643
1715
|
|
1644
|
-
<p>Detach the https endpoint configuration attached
|
1716
|
+
<p>Detach the https endpoint configuration attached to a reserved domain.</p>
|
1645
1717
|
|
1646
1718
|
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-https-endpoint-config">ngrok.com/docs/api#api-reserved-domains-delete-https-endpoint-config</a></p>
|
1647
1719
|
|
@@ -1660,7 +1732,7 @@
|
|
1660
1732
|
<span class='type'>(<tt>string</tt>)</span>
|
1661
1733
|
|
1662
1734
|
|
1663
|
-
<em class="default">(defaults to: <tt
|
1735
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1664
1736
|
|
1665
1737
|
|
1666
1738
|
—
|
@@ -1678,13 +1750,13 @@
|
|
1678
1750
|
<li>
|
1679
1751
|
|
1680
1752
|
|
1681
|
-
<span class='type'>(<tt>
|
1753
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
1682
1754
|
|
1683
1755
|
|
1684
1756
|
|
1685
1757
|
—
|
1686
1758
|
<div class='inline'>
|
1687
|
-
<p>result from
|
1759
|
+
<p>result from the API request</p>
|
1688
1760
|
</div>
|
1689
1761
|
|
1690
1762
|
</li>
|
@@ -1697,15 +1769,23 @@
|
|
1697
1769
|
<pre class="lines">
|
1698
1770
|
|
1699
1771
|
|
1700
|
-
|
1701
|
-
|
1702
|
-
|
1772
|
+
335
|
1773
|
+
336
|
1774
|
+
337
|
1775
|
+
338
|
1776
|
+
339
|
1777
|
+
340
|
1778
|
+
341</pre>
|
1703
1779
|
</td>
|
1704
1780
|
<td>
|
1705
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
1706
|
-
|
1707
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete_https_endpoint_config'>delete_https_endpoint_config</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='
|
1708
|
-
<span class='
|
1781
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 335</span>
|
1782
|
+
|
1783
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_https_endpoint_config'>delete_https_endpoint_config</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>
|
1784
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_domains/%{id}/https_endpoint_configuration</span><span class='tstring_end'>'</span></span>
|
1785
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1786
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1787
|
+
<span class='rbrace'>}</span>
|
1788
|
+
<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>
|
1709
1789
|
<span class='kw'>end</span></pre>
|
1710
1790
|
</td>
|
1711
1791
|
</tr>
|
@@ -1715,7 +1795,7 @@
|
|
1715
1795
|
<div class="method_details ">
|
1716
1796
|
<h3 class="signature " id="delete_https_endpoint_config!-instance_method">
|
1717
1797
|
|
1718
|
-
#<strong>delete_https_endpoint_config!</strong>(id:
|
1798
|
+
#<strong>delete_https_endpoint_config!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
1719
1799
|
|
1720
1800
|
|
1721
1801
|
|
@@ -1724,7 +1804,7 @@
|
|
1724
1804
|
</h3><div class="docstring">
|
1725
1805
|
<div class="discussion">
|
1726
1806
|
|
1727
|
-
<p>Detach the https endpoint configuration attached
|
1807
|
+
<p>Detach the https endpoint configuration attached to a reserved domain. Throws an exception if API error.</p>
|
1728
1808
|
|
1729
1809
|
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-https-endpoint-config">ngrok.com/docs/api#api-reserved-domains-delete-https-endpoint-config</a></p>
|
1730
1810
|
|
@@ -1743,7 +1823,7 @@
|
|
1743
1823
|
<span class='type'>(<tt>string</tt>)</span>
|
1744
1824
|
|
1745
1825
|
|
1746
|
-
<em class="default">(defaults to: <tt
|
1826
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1747
1827
|
|
1748
1828
|
|
1749
1829
|
—
|
@@ -1761,13 +1841,13 @@
|
|
1761
1841
|
<li>
|
1762
1842
|
|
1763
1843
|
|
1764
|
-
<span class='type'>(<tt>
|
1844
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
1765
1845
|
|
1766
1846
|
|
1767
1847
|
|
1768
1848
|
—
|
1769
1849
|
<div class='inline'>
|
1770
|
-
<p>result from
|
1850
|
+
<p>result from the API request</p>
|
1771
1851
|
</div>
|
1772
1852
|
|
1773
1853
|
</li>
|
@@ -1780,15 +1860,23 @@
|
|
1780
1860
|
<pre class="lines">
|
1781
1861
|
|
1782
1862
|
|
1783
|
-
|
1784
|
-
|
1785
|
-
|
1863
|
+
351
|
1864
|
+
352
|
1865
|
+
353
|
1866
|
+
354
|
1867
|
+
355
|
1868
|
+
356
|
1869
|
+
357</pre>
|
1786
1870
|
</td>
|
1787
1871
|
<td>
|
1788
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
1789
|
-
|
1790
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete_https_endpoint_config!'>delete_https_endpoint_config!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='
|
1791
|
-
<span class='
|
1872
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 351</span>
|
1873
|
+
|
1874
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_https_endpoint_config!'>delete_https_endpoint_config!</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>
|
1875
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_domains/%{id}/https_endpoint_configuration</span><span class='tstring_end'>'</span></span>
|
1876
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1877
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1878
|
+
<span class='rbrace'>}</span>
|
1879
|
+
<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>
|
1792
1880
|
<span class='kw'>end</span></pre>
|
1793
1881
|
</td>
|
1794
1882
|
</tr>
|
@@ -1798,7 +1886,7 @@
|
|
1798
1886
|
<div class="method_details ">
|
1799
1887
|
<h3 class="signature " id="get-instance_method">
|
1800
1888
|
|
1801
|
-
#<strong>get</strong>(id:
|
1889
|
+
#<strong>get</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>
|
1802
1890
|
|
1803
1891
|
|
1804
1892
|
|
@@ -1826,7 +1914,7 @@
|
|
1826
1914
|
<span class='type'>(<tt>string</tt>)</span>
|
1827
1915
|
|
1828
1916
|
|
1829
|
-
<em class="default">(defaults to: <tt
|
1917
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1830
1918
|
|
1831
1919
|
|
1832
1920
|
—
|
@@ -1850,7 +1938,7 @@
|
|
1850
1938
|
|
1851
1939
|
—
|
1852
1940
|
<div class='inline'>
|
1853
|
-
<p>result from
|
1941
|
+
<p>result from the API request</p>
|
1854
1942
|
</div>
|
1855
1943
|
|
1856
1944
|
</li>
|
@@ -1863,17 +1951,27 @@
|
|
1863
1951
|
<pre class="lines">
|
1864
1952
|
|
1865
1953
|
|
1866
|
-
91
|
1867
|
-
92
|
1868
1954
|
93
|
1869
|
-
94
|
1955
|
+
94
|
1956
|
+
95
|
1957
|
+
96
|
1958
|
+
97
|
1959
|
+
98
|
1960
|
+
99
|
1961
|
+
100
|
1962
|
+
101</pre>
|
1870
1963
|
</td>
|
1871
1964
|
<td>
|
1872
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
1873
|
-
|
1874
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='
|
1875
|
-
<span class='id identifier
|
1876
|
-
<span class='
|
1965
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 93</span>
|
1966
|
+
|
1967
|
+
<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>
|
1968
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_domains/%{id}</span><span class='tstring_end'>'</span></span>
|
1969
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1970
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1971
|
+
<span class='rbrace'>}</span>
|
1972
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
1973
|
+
<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>
|
1974
|
+
<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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#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>
|
1877
1975
|
<span class='kw'>end</span></pre>
|
1878
1976
|
</td>
|
1879
1977
|
</tr>
|
@@ -1883,7 +1981,7 @@
|
|
1883
1981
|
<div class="method_details ">
|
1884
1982
|
<h3 class="signature " id="get!-instance_method">
|
1885
1983
|
|
1886
|
-
#<strong>get!</strong>(id:
|
1984
|
+
#<strong>get!</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>
|
1887
1985
|
|
1888
1986
|
|
1889
1987
|
|
@@ -1892,7 +1990,7 @@
|
|
1892
1990
|
</h3><div class="docstring">
|
1893
1991
|
<div class="discussion">
|
1894
1992
|
|
1895
|
-
<p>Get the details of a reserved domain.
|
1993
|
+
<p>Get the details of a reserved domain. Throws an exception if API error.</p>
|
1896
1994
|
|
1897
1995
|
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-get">ngrok.com/docs/api#api-reserved-domains-get</a></p>
|
1898
1996
|
|
@@ -1911,7 +2009,7 @@
|
|
1911
2009
|
<span class='type'>(<tt>string</tt>)</span>
|
1912
2010
|
|
1913
2011
|
|
1914
|
-
<em class="default">(defaults to: <tt
|
2012
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1915
2013
|
|
1916
2014
|
|
1917
2015
|
—
|
@@ -1935,7 +2033,7 @@
|
|
1935
2033
|
|
1936
2034
|
—
|
1937
2035
|
<div class='inline'>
|
1938
|
-
<p>result from
|
2036
|
+
<p>result from the API request</p>
|
1939
2037
|
</div>
|
1940
2038
|
|
1941
2039
|
</li>
|
@@ -1948,17 +2046,27 @@
|
|
1948
2046
|
<pre class="lines">
|
1949
2047
|
|
1950
2048
|
|
1951
|
-
|
1952
|
-
|
1953
|
-
|
1954
|
-
|
2049
|
+
111
|
2050
|
+
112
|
2051
|
+
113
|
2052
|
+
114
|
2053
|
+
115
|
2054
|
+
116
|
2055
|
+
117
|
2056
|
+
118
|
2057
|
+
119</pre>
|
1955
2058
|
</td>
|
1956
2059
|
<td>
|
1957
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
1958
|
-
|
1959
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='
|
1960
|
-
<span class='id identifier
|
1961
|
-
<span class='
|
2060
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 111</span>
|
2061
|
+
|
2062
|
+
<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>
|
2063
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_domains/%{id}</span><span class='tstring_end'>'</span></span>
|
2064
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
2065
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
2066
|
+
<span class='rbrace'>}</span>
|
2067
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
2068
|
+
<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>
|
2069
|
+
<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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#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>
|
1962
2070
|
<span class='kw'>end</span></pre>
|
1963
2071
|
</td>
|
1964
2072
|
</tr>
|
@@ -2006,7 +2114,7 @@
|
|
2006
2114
|
<span class='name'>limit</span>
|
2007
2115
|
|
2008
2116
|
|
2009
|
-
<span class='type'>(<tt>
|
2117
|
+
<span class='type'>(<tt>string</tt>)</span>
|
2010
2118
|
|
2011
2119
|
|
2012
2120
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -2046,7 +2154,7 @@
|
|
2046
2154
|
|
2047
2155
|
—
|
2048
2156
|
<div class='inline'>
|
2049
|
-
<p>result from
|
2157
|
+
<p>result from the API request</p>
|
2050
2158
|
</div>
|
2051
2159
|
|
2052
2160
|
</li>
|
@@ -2059,27 +2167,180 @@
|
|
2059
2167
|
<pre class="lines">
|
2060
2168
|
|
2061
2169
|
|
2062
|
-
|
2063
|
-
|
2064
|
-
|
2065
|
-
|
2066
|
-
|
2067
|
-
|
2068
|
-
|
2069
|
-
|
2070
|
-
|
2170
|
+
130
|
2171
|
+
131
|
2172
|
+
132
|
2173
|
+
133
|
2174
|
+
134
|
2175
|
+
135
|
2176
|
+
136
|
2177
|
+
137
|
2178
|
+
138
|
2179
|
+
139
|
2180
|
+
140
|
2181
|
+
141
|
2182
|
+
142
|
2183
|
+
143
|
2184
|
+
144
|
2185
|
+
145</pre>
|
2186
|
+
</td>
|
2187
|
+
<td>
|
2188
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 130</span>
|
2189
|
+
|
2190
|
+
<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>
|
2191
|
+
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
2192
|
+
<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>
|
2193
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
2194
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
2195
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
2196
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span>
|
2197
|
+
<span class='rparen'>)</span>
|
2198
|
+
|
2199
|
+
<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>
|
2200
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
2201
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
2202
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::ReservedDomainsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
2203
|
+
<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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span>
|
2204
|
+
<span class='rparen'>)</span>
|
2205
|
+
<span class='kw'>end</span></pre>
|
2206
|
+
</td>
|
2207
|
+
</tr>
|
2208
|
+
</table>
|
2209
|
+
</div>
|
2210
|
+
|
2211
|
+
<div class="method_details ">
|
2212
|
+
<h3 class="signature " id="list!-instance_method">
|
2213
|
+
|
2214
|
+
#<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>
|
2215
|
+
|
2216
|
+
|
2217
|
+
|
2218
|
+
|
2219
|
+
|
2220
|
+
</h3><div class="docstring">
|
2221
|
+
<div class="discussion">
|
2222
|
+
|
2223
|
+
<p>List all reserved domains on this account. Throws an exception if API error.</p>
|
2224
|
+
|
2225
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-list">ngrok.com/docs/api#api-reserved-domains-list</a></p>
|
2226
|
+
|
2227
|
+
|
2228
|
+
</div>
|
2229
|
+
</div>
|
2230
|
+
<div class="tags">
|
2231
|
+
<p class="tag_title">Parameters:</p>
|
2232
|
+
<ul class="param">
|
2233
|
+
|
2234
|
+
<li>
|
2235
|
+
|
2236
|
+
<span class='name'>before_id</span>
|
2237
|
+
|
2238
|
+
|
2239
|
+
<span class='type'>(<tt>string</tt>)</span>
|
2240
|
+
|
2241
|
+
|
2242
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
2243
|
+
|
2244
|
+
|
2245
|
+
</li>
|
2246
|
+
|
2247
|
+
<li>
|
2248
|
+
|
2249
|
+
<span class='name'>limit</span>
|
2250
|
+
|
2251
|
+
|
2252
|
+
<span class='type'>(<tt>string</tt>)</span>
|
2253
|
+
|
2254
|
+
|
2255
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
2256
|
+
|
2257
|
+
|
2258
|
+
</li>
|
2259
|
+
|
2260
|
+
<li>
|
2261
|
+
|
2262
|
+
<span class='name'>url</span>
|
2263
|
+
|
2264
|
+
|
2265
|
+
<span class='type'>(<tt>string</tt>)</span>
|
2266
|
+
|
2267
|
+
|
2268
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
2269
|
+
|
2270
|
+
|
2271
|
+
—
|
2272
|
+
<div class='inline'>
|
2273
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
2274
|
+
</div>
|
2275
|
+
|
2276
|
+
</li>
|
2277
|
+
|
2278
|
+
</ul>
|
2279
|
+
|
2280
|
+
<p class="tag_title">Returns:</p>
|
2281
|
+
<ul class="return">
|
2282
|
+
|
2283
|
+
<li>
|
2284
|
+
|
2285
|
+
|
2286
|
+
<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>
|
2287
|
+
|
2288
|
+
|
2289
|
+
|
2290
|
+
—
|
2291
|
+
<div class='inline'>
|
2292
|
+
<p>result from the API request</p>
|
2293
|
+
</div>
|
2294
|
+
|
2295
|
+
</li>
|
2296
|
+
|
2297
|
+
</ul>
|
2298
|
+
|
2299
|
+
</div><table class="source_code">
|
2300
|
+
<tr>
|
2301
|
+
<td>
|
2302
|
+
<pre class="lines">
|
2303
|
+
|
2304
|
+
|
2305
|
+
157
|
2306
|
+
158
|
2307
|
+
159
|
2308
|
+
160
|
2309
|
+
161
|
2310
|
+
162
|
2311
|
+
163
|
2312
|
+
164
|
2313
|
+
165
|
2314
|
+
166
|
2315
|
+
167
|
2316
|
+
168
|
2317
|
+
169
|
2318
|
+
170
|
2319
|
+
171
|
2320
|
+
172
|
2321
|
+
173
|
2322
|
+
174</pre>
|
2071
2323
|
</td>
|
2072
2324
|
<td>
|
2073
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
2074
|
-
|
2075
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list
|
2076
|
-
|
2077
|
-
<span class='
|
2078
|
-
<span class='label'>
|
2079
|
-
<span class='label'>
|
2080
|
-
<span class='label'>
|
2081
|
-
<span class='label'>
|
2082
|
-
|
2325
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 157</span>
|
2326
|
+
|
2327
|
+
<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>
|
2328
|
+
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
2329
|
+
<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>
|
2330
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
2331
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
2332
|
+
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
2333
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
2334
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span>
|
2335
|
+
<span class='rparen'>)</span>
|
2336
|
+
|
2337
|
+
<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>
|
2338
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
2339
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
2340
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::ReservedDomainsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
2341
|
+
<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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='comma'>,</span>
|
2342
|
+
<span class='label'>danger:</span> <span class='kw'>true</span>
|
2343
|
+
<span class='rparen'>)</span>
|
2083
2344
|
<span class='kw'>end</span></pre>
|
2084
2345
|
</td>
|
2085
2346
|
</tr>
|
@@ -2089,7 +2350,7 @@
|
|
2089
2350
|
<div class="method_details ">
|
2090
2351
|
<h3 class="signature " id="update-instance_method">
|
2091
2352
|
|
2092
|
-
#<strong>update</strong>(id:
|
2353
|
+
#<strong>update</strong>(id: "", description: nil, metadata: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil) ⇒ <tt><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>
|
2093
2354
|
|
2094
2355
|
|
2095
2356
|
|
@@ -2117,7 +2378,7 @@
|
|
2117
2378
|
<span class='type'>(<tt>string</tt>)</span>
|
2118
2379
|
|
2119
2380
|
|
2120
|
-
<em class="default">(defaults to: <tt
|
2381
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
2121
2382
|
|
2122
2383
|
|
2123
2384
|
</li>
|
@@ -2207,7 +2468,7 @@
|
|
2207
2468
|
|
2208
2469
|
—
|
2209
2470
|
<div class='inline'>
|
2210
|
-
<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with
|
2471
|
+
<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with <code>certificate_management_policy</code>.</p>
|
2211
2472
|
</div>
|
2212
2473
|
|
2213
2474
|
</li>
|
@@ -2217,7 +2478,7 @@
|
|
2217
2478
|
<span class='name'>certificate_management_policy</span>
|
2218
2479
|
|
2219
2480
|
|
2220
|
-
<span class='type'>(<tt>
|
2481
|
+
<span class='type'>(<tt>ReservedDomainCertPolicy</tt>)</span>
|
2221
2482
|
|
2222
2483
|
|
2223
2484
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -2225,7 +2486,7 @@
|
|
2225
2486
|
|
2226
2487
|
—
|
2227
2488
|
<div class='inline'>
|
2228
|
-
<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with
|
2489
|
+
<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with <code>certificate_id</code>.</p>
|
2229
2490
|
</div>
|
2230
2491
|
|
2231
2492
|
</li>
|
@@ -2244,7 +2505,7 @@
|
|
2244
2505
|
|
2245
2506
|
—
|
2246
2507
|
<div class='inline'>
|
2247
|
-
<p>result from
|
2508
|
+
<p>result from the API request</p>
|
2248
2509
|
</div>
|
2249
2510
|
|
2250
2511
|
</li>
|
@@ -2257,49 +2518,39 @@
|
|
2257
2518
|
<pre class="lines">
|
2258
2519
|
|
2259
2520
|
|
2260
|
-
|
2261
|
-
|
2262
|
-
|
2263
|
-
|
2264
|
-
|
2265
|
-
|
2266
|
-
|
2267
|
-
|
2268
|
-
|
2269
|
-
|
2270
|
-
|
2271
|
-
|
2272
|
-
|
2273
|
-
|
2274
|
-
|
2275
|
-
157
|
2276
|
-
158
|
2277
|
-
159
|
2278
|
-
160
|
2279
|
-
161</pre>
|
2521
|
+
189
|
2522
|
+
190
|
2523
|
+
191
|
2524
|
+
192
|
2525
|
+
193
|
2526
|
+
194
|
2527
|
+
195
|
2528
|
+
196
|
2529
|
+
197
|
2530
|
+
198
|
2531
|
+
199
|
2532
|
+
200
|
2533
|
+
201
|
2534
|
+
202
|
2535
|
+
203</pre>
|
2280
2536
|
</td>
|
2281
2537
|
<td>
|
2282
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
2283
|
-
|
2284
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
|
2285
|
-
<span class='
|
2286
|
-
<span class='
|
2287
|
-
|
2288
|
-
<span class='
|
2289
|
-
<span class='
|
2290
|
-
<span class='
|
2291
|
-
<span class='
|
2292
|
-
<span class='
|
2293
|
-
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier
|
2294
|
-
|
2295
|
-
|
2296
|
-
|
2297
|
-
|
2298
|
-
<span class='label'>certificate_id:</span> <span class='id identifier rubyid_certificate_id'>certificate_id</span><span class='comma'>,</span>
|
2299
|
-
<span class='label'>certificate_management_policy:</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span>
|
2300
|
-
<span class='rparen'>)</span>
|
2301
|
-
<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='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
2302
|
-
<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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#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>
|
2538
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 189</span>
|
2539
|
+
|
2540
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>http_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>https_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>certificate_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>certificate_management_policy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
2541
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_domains/%{id}</span><span class='tstring_end'>'</span></span>
|
2542
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
2543
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
2544
|
+
<span class='rbrace'>}</span>
|
2545
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
2546
|
+
<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>
|
2547
|
+
<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>
|
2548
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:http_endpoint_configuration_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_http_endpoint_configuration_id'>http_endpoint_configuration_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_http_endpoint_configuration_id'>http_endpoint_configuration_id</span>
|
2549
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:https_endpoint_configuration_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_https_endpoint_configuration_id'>https_endpoint_configuration_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_https_endpoint_configuration_id'>https_endpoint_configuration_id</span>
|
2550
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:certificate_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_certificate_id'>certificate_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_certificate_id'>certificate_id</span>
|
2551
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:certificate_management_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span>
|
2552
|
+
<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>
|
2553
|
+
<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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#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>
|
2303
2554
|
<span class='kw'>end</span></pre>
|
2304
2555
|
</td>
|
2305
2556
|
</tr>
|
@@ -2309,7 +2560,7 @@
|
|
2309
2560
|
<div class="method_details ">
|
2310
2561
|
<h3 class="signature " id="update!-instance_method">
|
2311
2562
|
|
2312
|
-
#<strong>update!</strong>(id:
|
2563
|
+
#<strong>update!</strong>(id: "", description: nil, metadata: nil, http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil) ⇒ <tt><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>
|
2313
2564
|
|
2314
2565
|
|
2315
2566
|
|
@@ -2318,7 +2569,7 @@
|
|
2318
2569
|
</h3><div class="docstring">
|
2319
2570
|
<div class="discussion">
|
2320
2571
|
|
2321
|
-
<p>Update the attributes of a reserved domain.
|
2572
|
+
<p>Update the attributes of a reserved domain. Throws an exception if API error.</p>
|
2322
2573
|
|
2323
2574
|
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-update">ngrok.com/docs/api#api-reserved-domains-update</a></p>
|
2324
2575
|
|
@@ -2337,7 +2588,7 @@
|
|
2337
2588
|
<span class='type'>(<tt>string</tt>)</span>
|
2338
2589
|
|
2339
2590
|
|
2340
|
-
<em class="default">(defaults to: <tt
|
2591
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
2341
2592
|
|
2342
2593
|
|
2343
2594
|
</li>
|
@@ -2427,7 +2678,7 @@
|
|
2427
2678
|
|
2428
2679
|
—
|
2429
2680
|
<div class='inline'>
|
2430
|
-
<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with
|
2681
|
+
<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with <code>certificate_management_policy</code>.</p>
|
2431
2682
|
</div>
|
2432
2683
|
|
2433
2684
|
</li>
|
@@ -2437,7 +2688,7 @@
|
|
2437
2688
|
<span class='name'>certificate_management_policy</span>
|
2438
2689
|
|
2439
2690
|
|
2440
|
-
<span class='type'>(<tt>
|
2691
|
+
<span class='type'>(<tt>ReservedDomainCertPolicy</tt>)</span>
|
2441
2692
|
|
2442
2693
|
|
2443
2694
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -2445,7 +2696,7 @@
|
|
2445
2696
|
|
2446
2697
|
—
|
2447
2698
|
<div class='inline'>
|
2448
|
-
<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with
|
2699
|
+
<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with <code>certificate_id</code>.</p>
|
2449
2700
|
</div>
|
2450
2701
|
|
2451
2702
|
</li>
|
@@ -2464,7 +2715,7 @@
|
|
2464
2715
|
|
2465
2716
|
—
|
2466
2717
|
<div class='inline'>
|
2467
|
-
<p>result from
|
2718
|
+
<p>result from the API request</p>
|
2468
2719
|
</div>
|
2469
2720
|
|
2470
2721
|
</li>
|
@@ -2477,49 +2728,39 @@
|
|
2477
2728
|
<pre class="lines">
|
2478
2729
|
|
2479
2730
|
|
2480
|
-
|
2481
|
-
|
2482
|
-
|
2483
|
-
|
2484
|
-
|
2485
|
-
|
2486
|
-
|
2487
|
-
|
2488
|
-
|
2489
|
-
|
2490
|
-
|
2491
|
-
|
2492
|
-
|
2493
|
-
|
2494
|
-
|
2495
|
-
191
|
2496
|
-
192
|
2497
|
-
193
|
2498
|
-
194
|
2499
|
-
195</pre>
|
2731
|
+
219
|
2732
|
+
220
|
2733
|
+
221
|
2734
|
+
222
|
2735
|
+
223
|
2736
|
+
224
|
2737
|
+
225
|
2738
|
+
226
|
2739
|
+
227
|
2740
|
+
228
|
2741
|
+
229
|
2742
|
+
230
|
2743
|
+
231
|
2744
|
+
232
|
2745
|
+
233</pre>
|
2500
2746
|
</td>
|
2501
2747
|
<td>
|
2502
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
2503
|
-
|
2504
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
|
2505
|
-
<span class='
|
2506
|
-
<span class='
|
2507
|
-
|
2508
|
-
<span class='
|
2509
|
-
<span class='
|
2510
|
-
<span class='
|
2511
|
-
<span class='
|
2512
|
-
<span class='
|
2513
|
-
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='id identifier
|
2514
|
-
|
2515
|
-
|
2516
|
-
|
2517
|
-
|
2518
|
-
<span class='label'>certificate_id:</span> <span class='id identifier rubyid_certificate_id'>certificate_id</span><span class='comma'>,</span>
|
2519
|
-
<span class='label'>certificate_management_policy:</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span>
|
2520
|
-
<span class='rparen'>)</span>
|
2521
|
-
<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='tstring'><span class='tstring_beg'>"</span><span class='embexpr_beg'>#{</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedDomainsClient::PATH (constant)">PATH</a></span></span><span class='embexpr_end'>}</span><span class='tstring_content'>/</span><span class='embexpr_beg'>#{</span><span class='id identifier rubyid_id'>id</span><span class='embexpr_end'>}</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
2522
|
-
<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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#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>
|
2748
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 219</span>
|
2749
|
+
|
2750
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>http_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>https_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>certificate_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>certificate_management_policy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
2751
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_domains/%{id}</span><span class='tstring_end'>'</span></span>
|
2752
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
2753
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
2754
|
+
<span class='rbrace'>}</span>
|
2755
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
2756
|
+
<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>
|
2757
|
+
<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>
|
2758
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:http_endpoint_configuration_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_http_endpoint_configuration_id'>http_endpoint_configuration_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_http_endpoint_configuration_id'>http_endpoint_configuration_id</span>
|
2759
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:https_endpoint_configuration_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_https_endpoint_configuration_id'>https_endpoint_configuration_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_https_endpoint_configuration_id'>https_endpoint_configuration_id</span>
|
2760
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:certificate_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_certificate_id'>certificate_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_certificate_id'>certificate_id</span>
|
2761
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:certificate_management_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span>
|
2762
|
+
<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>
|
2763
|
+
<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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#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>
|
2523
2764
|
<span class='kw'>end</span></pre>
|
2524
2765
|
</td>
|
2525
2766
|
</tr>
|
@@ -2531,9 +2772,9 @@
|
|
2531
2772
|
</div>
|
2532
2773
|
|
2533
2774
|
<div id="footer">
|
2534
|
-
Generated on
|
2775
|
+
Generated on Thu Dec 2 18:48:55 2021 by
|
2535
2776
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
2536
|
-
0.9.
|
2777
|
+
0.9.27 (ruby-3.0.1).
|
2537
2778
|
</div>
|
2538
2779
|
|
2539
2780
|
</div>
|