ngrok-api 0.9.0 → 0.12.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.rubocop.yml +1 -1
- data/doc/.gitkeep +0 -0
- data/doc/NgrokAPI/Client.html +1499 -125
- data/doc/NgrokAPI/Error.html +1 -1
- data/doc/NgrokAPI/Errors/NotFoundError.html +1 -1
- data/doc/NgrokAPI/Errors.html +1 -1
- data/doc/NgrokAPI/HttpClient.html +1 -1
- data/doc/NgrokAPI/Models/{ApiKey.html → APIKey.html} +108 -177
- data/doc/NgrokAPI/Models/AWSAuth.html +617 -0
- data/doc/NgrokAPI/Models/AWSCredentials.html +617 -0
- data/doc/NgrokAPI/Models/AWSRole.html +543 -0
- data/doc/NgrokAPI/Models/AbuseReport.html +987 -0
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +617 -0
- data/doc/NgrokAPI/Models/CertificateAuthority.html +1439 -0
- data/doc/NgrokAPI/Models/Credential.html +1149 -0
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +913 -0
- data/doc/NgrokAPI/Models/EndpointCompression.html +543 -0
- data/doc/NgrokAPI/Models/EndpointConfiguration.html +1321 -510
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +617 -0
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointLogging.html +617 -0
- data/doc/NgrokAPI/Models/EndpointLoggingMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +617 -0
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointOAuth.html +987 -0
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +987 -0
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +765 -0
- data/doc/NgrokAPI/Models/EndpointOIDC.html +1135 -0
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +691 -0
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +691 -0
- data/doc/NgrokAPI/Models/EndpointSAML.html +1653 -0
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +1283 -0
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +691 -0
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +691 -0
- data/doc/NgrokAPI/Models/EventDestination.html +1058 -0
- data/doc/NgrokAPI/Models/EventSource.html +765 -0
- data/doc/NgrokAPI/Models/EventSourceReplace.html +691 -0
- data/doc/NgrokAPI/Models/EventStream.html +1309 -0
- data/doc/NgrokAPI/Models/EventSubscription.html +1058 -0
- data/doc/NgrokAPI/Models/EventTarget.html +765 -0
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +617 -0
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +617 -0
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +617 -0
- data/doc/NgrokAPI/Models/IPPolicy.html +1069 -0
- data/doc/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/doc/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/doc/NgrokAPI/Models/{TlsCertificate.html → IPWhitelistEntry.html} +168 -163
- data/doc/NgrokAPI/Models/Listable.html +1 -1
- data/doc/NgrokAPI/Models/Ref.html +617 -0
- data/doc/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/doc/NgrokAPI/Models/ReservedDomain.html +111 -1107
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +839 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertNSTarget.html +617 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +617 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +617 -0
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +1143 -0
- data/doc/NgrokAPI/Models/SSHCredential.html +1149 -0
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +1513 -0
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +1661 -0
- data/doc/NgrokAPI/Models/TLSCertificate.html +2179 -0
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +617 -0
- data/doc/NgrokAPI/Models/Tunnel.html +987 -0
- data/doc/NgrokAPI/Models/TunnelSession.html +1209 -0
- data/doc/NgrokAPI/Models.html +4 -4
- data/doc/NgrokAPI/PagedIterator.html +1 -1
- data/{docs/NgrokAPI/Services/ApiKeysClient.html → doc/NgrokAPI/Services/APIKeysClient.html} +287 -151
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +723 -0
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +1489 -0
- data/doc/NgrokAPI/Services/CredentialsClient.html +1534 -0
- data/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +473 -371
- data/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +1609 -0
- data/doc/NgrokAPI/Services/EventSourcesClient.html +1348 -0
- data/doc/NgrokAPI/Services/EventStreamsClient.html +1691 -0
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +1603 -0
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +1488 -0
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +1550 -0
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +1620 -0
- data/doc/NgrokAPI/Services/IPWhitelistClient.html +1488 -0
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +1793 -0
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +518 -333
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1532 -0
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +1552 -0
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +1573 -0
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +1617 -0
- data/{docs/NgrokAPI/Services/TlsCertificatesClient.html → doc/NgrokAPI/Services/TLSCertificatesClient.html} +290 -198
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +1468 -0
- data/doc/NgrokAPI/Services/TunnelsClient.html +513 -0
- data/doc/NgrokAPI/Services.html +4 -4
- data/doc/NgrokAPI.html +3 -3
- data/doc/_index.html +624 -28
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +1 -1
- data/doc/index.html +1 -1
- data/doc/method_list.html +7318 -286
- data/doc/top-level-namespace.html +1 -1
- data/docs/.gitkeep +0 -0
- data/docs/NgrokAPI/Client.html +1499 -125
- data/docs/NgrokAPI/Error.html +1 -1
- data/docs/NgrokAPI/Errors/NotFoundError.html +1 -1
- data/docs/NgrokAPI/Errors.html +1 -1
- data/docs/NgrokAPI/HttpClient.html +1 -1
- data/docs/NgrokAPI/Models/{ApiKey.html → APIKey.html} +108 -177
- data/docs/NgrokAPI/Models/AWSAuth.html +617 -0
- data/docs/NgrokAPI/Models/AWSCredentials.html +617 -0
- data/docs/NgrokAPI/Models/AWSRole.html +543 -0
- data/docs/NgrokAPI/Models/AbuseReport.html +987 -0
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +617 -0
- data/docs/NgrokAPI/Models/CertificateAuthority.html +1439 -0
- data/docs/NgrokAPI/Models/Credential.html +1149 -0
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +913 -0
- data/docs/NgrokAPI/Models/EndpointCompression.html +543 -0
- data/docs/NgrokAPI/Models/EndpointConfiguration.html +1321 -510
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +617 -0
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointLogging.html +617 -0
- data/docs/NgrokAPI/Models/EndpointLoggingMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +617 -0
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointOAuth.html +987 -0
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +987 -0
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +765 -0
- data/docs/NgrokAPI/Models/EndpointOIDC.html +1135 -0
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +691 -0
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +691 -0
- data/docs/NgrokAPI/Models/EndpointSAML.html +1653 -0
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +1283 -0
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +691 -0
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +691 -0
- data/docs/NgrokAPI/Models/EventDestination.html +1058 -0
- data/docs/NgrokAPI/Models/EventSource.html +765 -0
- data/docs/NgrokAPI/Models/EventSourceReplace.html +691 -0
- data/docs/NgrokAPI/Models/EventStream.html +1309 -0
- data/docs/NgrokAPI/Models/EventSubscription.html +1058 -0
- data/docs/NgrokAPI/Models/EventTarget.html +765 -0
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +617 -0
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +617 -0
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +617 -0
- data/docs/NgrokAPI/Models/IPPolicy.html +1069 -0
- data/docs/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/docs/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/docs/NgrokAPI/Models/{TlsCertificate.html → IPWhitelistEntry.html} +168 -163
- data/docs/NgrokAPI/Models/Listable.html +1 -1
- data/docs/NgrokAPI/Models/Ref.html +617 -0
- data/docs/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/docs/NgrokAPI/Models/ReservedDomain.html +111 -1107
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +839 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertNSTarget.html +617 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +617 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +617 -0
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +1143 -0
- data/docs/NgrokAPI/Models/SSHCredential.html +1149 -0
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +1513 -0
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +1661 -0
- data/docs/NgrokAPI/Models/TLSCertificate.html +2179 -0
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +617 -0
- data/docs/NgrokAPI/Models/Tunnel.html +987 -0
- data/docs/NgrokAPI/Models/TunnelSession.html +1209 -0
- data/docs/NgrokAPI/Models.html +4 -4
- data/docs/NgrokAPI/PagedIterator.html +1 -1
- data/{doc/NgrokAPI/Services/ApiKeysClient.html → docs/NgrokAPI/Services/APIKeysClient.html} +287 -151
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +723 -0
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +1489 -0
- data/docs/NgrokAPI/Services/CredentialsClient.html +1534 -0
- data/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +473 -371
- data/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +1609 -0
- data/docs/NgrokAPI/Services/EventSourcesClient.html +1348 -0
- data/docs/NgrokAPI/Services/EventStreamsClient.html +1691 -0
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +1603 -0
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +1488 -0
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +1550 -0
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +1620 -0
- data/docs/NgrokAPI/Services/IPWhitelistClient.html +1488 -0
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +1793 -0
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +518 -333
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1532 -0
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +1552 -0
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +1573 -0
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +1617 -0
- data/{doc/NgrokAPI/Services/TlsCertificatesClient.html → docs/NgrokAPI/Services/TLSCertificatesClient.html} +290 -198
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +1468 -0
- data/docs/NgrokAPI/Services/TunnelsClient.html +513 -0
- data/docs/NgrokAPI/Services.html +4 -4
- data/docs/NgrokAPI.html +3 -3
- data/docs/_index.html +624 -28
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +1 -1
- data/docs/index.html +1 -1
- data/docs/method_list.html +7318 -286
- data/docs/top-level-namespace.html +1 -1
- data/lib/ngrokapi/client.rb +218 -49
- data/lib/ngrokapi/models/abuse_report.rb +37 -0
- data/lib/ngrokapi/models/abuse_report_hostname.rb +27 -0
- data/lib/ngrokapi/models/api_key.rb +62 -64
- data/lib/ngrokapi/models/aws_auth.rb +27 -0
- data/lib/ngrokapi/models/aws_credentials.rb +27 -0
- data/lib/ngrokapi/models/aws_role.rb +25 -0
- data/lib/ngrokapi/models/certificate_authority.rb +72 -0
- data/lib/ngrokapi/models/credential.rb +67 -0
- data/lib/ngrokapi/models/endpoint_circuit_breaker.rb +35 -0
- data/lib/ngrokapi/models/endpoint_compression.rb +25 -0
- data/lib/ngrokapi/models/endpoint_configuration.rb +130 -119
- data/lib/ngrokapi/models/endpoint_ip_policy.rb +27 -0
- data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_logging.rb +27 -0
- data/lib/ngrokapi/models/endpoint_logging_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_mutual_tls.rb +27 -0
- data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_o_auth.rb +37 -0
- data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb +37 -0
- data/lib/ngrokapi/models/endpoint_o_auth_google.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_microsoft.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_provider.rb +31 -0
- data/lib/ngrokapi/models/endpoint_oidc.rb +41 -0
- data/lib/ngrokapi/models/endpoint_request_headers.rb +29 -0
- data/lib/ngrokapi/models/endpoint_response_headers.rb +29 -0
- data/lib/ngrokapi/models/endpoint_saml.rb +55 -0
- data/lib/ngrokapi/models/endpoint_saml_mutate.rb +45 -0
- data/lib/ngrokapi/models/endpoint_tls_termination.rb +29 -0
- data/lib/ngrokapi/models/endpoint_webhook_validation.rb +29 -0
- data/lib/ngrokapi/models/event_destination.rb +49 -0
- data/lib/ngrokapi/models/event_source.rb +31 -0
- data/lib/ngrokapi/models/event_source_replace.rb +29 -0
- data/lib/ngrokapi/models/event_stream.rb +77 -0
- data/lib/ngrokapi/models/event_subscription.rb +47 -0
- data/lib/ngrokapi/models/event_target.rb +31 -0
- data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb +27 -0
- data/lib/ngrokapi/models/event_target_firehose.rb +27 -0
- data/lib/ngrokapi/models/event_target_kinesis.rb +27 -0
- data/lib/ngrokapi/models/ip_policy.rb +64 -0
- data/lib/ngrokapi/models/ip_policy_rule.rb +67 -0
- data/lib/ngrokapi/models/ip_restriction.rb +49 -0
- data/lib/ngrokapi/models/ip_whitelist_entry.rb +62 -0
- data/lib/ngrokapi/models/ref.rb +27 -0
- data/lib/ngrokapi/models/reserved_addr.rb +49 -0
- data/lib/ngrokapi/models/reserved_domain.rb +59 -211
- data/lib/ngrokapi/models/reserved_domain_cert_job.rb +33 -0
- data/lib/ngrokapi/models/reserved_domain_cert_ns_target.rb +27 -0
- data/lib/ngrokapi/models/reserved_domain_cert_policy.rb +27 -0
- data/lib/ngrokapi/models/reserved_domain_cert_status.rb +27 -0
- data/lib/ngrokapi/models/ssh_certificate_authority.rb +64 -0
- data/lib/ngrokapi/models/ssh_credential.rb +67 -0
- data/lib/ngrokapi/models/ssh_host_certificate.rb +74 -0
- data/lib/ngrokapi/models/ssh_user_certificate.rb +78 -0
- data/lib/ngrokapi/models/tls_certificate.rb +92 -62
- data/lib/ngrokapi/models/tls_certificate_sa_ns.rb +27 -0
- data/lib/ngrokapi/models/tunnel.rb +37 -0
- data/lib/ngrokapi/models/tunnel_session.rb +43 -0
- data/lib/ngrokapi/services/.gitkeep +0 -0
- data/lib/ngrokapi/services/abuse_reports_client.rb +84 -0
- data/lib/ngrokapi/services/api_keys_client.rb +203 -144
- data/lib/ngrokapi/services/certificate_authorities_client.rb +204 -0
- data/lib/ngrokapi/services/credentials_client.rb +212 -0
- data/lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_compression_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +324 -313
- data/lib/ngrokapi/services/endpoint_ip_policy_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_logging_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_o_auth_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_oidc_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_request_headers_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_response_headers_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_saml_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_tls_termination_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb +122 -0
- data/lib/ngrokapi/services/event_destinations_client.rb +222 -0
- data/lib/ngrokapi/services/event_sources_client.rb +177 -0
- data/lib/ngrokapi/services/event_streams_client.rb +226 -0
- data/lib/ngrokapi/services/event_subscriptions_client.rb +213 -0
- data/lib/ngrokapi/services/ip_policies_client.rb +208 -0
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +210 -0
- data/lib/ngrokapi/services/ip_restrictions_client.rb +223 -0
- data/lib/ngrokapi/services/ip_whitelist_client.rb +202 -0
- data/lib/ngrokapi/services/reserved_addrs_client.rb +246 -0
- data/lib/ngrokapi/services/reserved_domains_client.rb +382 -313
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +207 -0
- data/lib/ngrokapi/services/ssh_credentials_client.rb +211 -0
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +214 -0
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +220 -0
- data/lib/ngrokapi/services/tls_certificates_client.rb +207 -161
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +228 -0
- data/lib/ngrokapi/services/tunnels_client.rb +51 -0
- data/lib/ngrokapi/version.rb +1 -1
- data/spec/ngrokapi/client_spec.rb +139 -33
- data/spec/ngrokapi/models/abuse_report_hostname_spec.rb +21 -0
- data/spec/ngrokapi/models/abuse_report_spec.rb +21 -0
- data/spec/ngrokapi/models/api_key_spec.rb +42 -43
- data/spec/ngrokapi/models/aws_auth_spec.rb +21 -0
- data/spec/ngrokapi/models/aws_credentials_spec.rb +21 -0
- data/spec/ngrokapi/models/aws_role_spec.rb +21 -0
- data/spec/ngrokapi/models/certificate_authority_spec.rb +42 -0
- data/spec/ngrokapi/models/credential_spec.rb +45 -0
- data/spec/ngrokapi/models/endpoint_circuit_breaker_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_compression_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_configuration_spec.rb +78 -0
- data/spec/ngrokapi/models/endpoint_ip_policy_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_ip_policy_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_logging_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_logging_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_mutual_tls_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_mutual_tls_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_facebook_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_git_hub_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_google_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_microsoft_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_provider_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_oidc_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_request_headers_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_response_headers_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_saml_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_saml_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_tls_termination_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_webhook_validation_spec.rb +21 -0
- data/spec/ngrokapi/models/event_destination_spec.rb +28 -0
- data/spec/ngrokapi/models/event_source_replace_spec.rb +21 -0
- data/spec/ngrokapi/models/event_source_spec.rb +21 -0
- data/spec/ngrokapi/models/event_stream_spec.rb +51 -0
- data/spec/ngrokapi/models/event_subscription_spec.rb +28 -0
- data/spec/ngrokapi/models/event_target_cloudwatch_logs_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_firehose_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_kinesis_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_spec.rb +21 -0
- data/spec/ngrokapi/models/ip_policy_rule_spec.rb +45 -0
- data/spec/ngrokapi/models/ip_policy_spec.rb +42 -0
- data/spec/ngrokapi/models/ip_restriction_spec.rb +28 -0
- data/spec/ngrokapi/models/ip_whitelist_entry_spec.rb +42 -0
- data/spec/ngrokapi/models/listable_spec.rb +4 -4
- data/spec/ngrokapi/models/ref_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_addr_spec.rb +28 -0
- data/spec/ngrokapi/models/reserved_domain_cert_job_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_cert_ns_target_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_cert_status_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_spec.rb +28 -100
- data/spec/ngrokapi/models/ssh_certificate_authority_spec.rb +42 -0
- data/spec/ngrokapi/models/ssh_credential_spec.rb +45 -0
- data/spec/ngrokapi/models/ssh_host_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/ssh_user_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/tls_certificate_sa_ns_spec.rb +21 -0
- data/spec/ngrokapi/models/tls_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/tunnel_session_spec.rb +21 -0
- data/spec/ngrokapi/models/tunnel_spec.rb +21 -0
- data/spec/ngrokapi/paged_iterator_spec.rb +5 -5
- data/spec/ngrokapi/services/.gitkeep +0 -0
- data/spec/ngrokapi/services/abuse_reports_client_spec.rb +67 -0
- data/spec/ngrokapi/services/api_keys_client_spec.rb +160 -127
- data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +162 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +166 -0
- data/spec/ngrokapi/services/endpoint_circuit_breaker_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_compression_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +240 -0
- data/spec/ngrokapi/services/endpoint_ip_policy_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_mutual_tls_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_o_auth_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_oidc_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_request_headers_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_response_headers_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_saml_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_tls_termination_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_webhook_validation_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/event_destinations_client_spec.rb +175 -0
- data/spec/ngrokapi/services/event_sources_client_spec.rb +162 -0
- data/spec/ngrokapi/services/event_streams_client_spec.rb +180 -0
- data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +172 -0
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +162 -0
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +168 -0
- data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +174 -0
- data/spec/ngrokapi/services/ip_whitelist_client_spec.rb +162 -0
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +209 -0
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +352 -0
- data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +166 -0
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +168 -0
- data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +170 -0
- data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +174 -0
- data/spec/ngrokapi/services/tls_certificates_client_spec.rb +164 -0
- data/spec/ngrokapi/services/tunnel_sessions_client_spec.rb +184 -0
- data/spec/ngrokapi/services/tunnels_client_spec.rb +21 -0
- data/spec/spec_helper.rb +958 -0
- metadata +355 -10
|
@@ -102,7 +102,12 @@
|
|
|
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</p>
|
|
106
|
+
|
|
107
|
+
<pre class="code ruby"><code class="ruby">can be used to listen for http, https or tls traffic. You may use a domain
|
|
108
|
+
that you own by creating a CNAME record specified in the returned resource.
|
|
109
|
+
This CNAME record points traffic for that domain to ngrok's edge servers.
|
|
110
|
+
</code></pre>
|
|
106
111
|
|
|
107
112
|
<p><a href="https://ngrok.com/docs/api#api-reserved-domains">ngrok.com/docs/api#api-reserved-domains</a></p>
|
|
108
113
|
|
|
@@ -121,11 +126,11 @@
|
|
|
121
126
|
|
|
122
127
|
<dl class="constants">
|
|
123
128
|
|
|
124
|
-
<dt id="
|
|
129
|
+
<dt id="PATH-constant" class="">PATH =
|
|
125
130
|
<div class="docstring">
|
|
126
131
|
<div class="discussion">
|
|
127
132
|
|
|
128
|
-
<p>The
|
|
133
|
+
<p>The API path for the requests</p>
|
|
129
134
|
|
|
130
135
|
|
|
131
136
|
</div>
|
|
@@ -135,13 +140,13 @@
|
|
|
135
140
|
|
|
136
141
|
</div>
|
|
137
142
|
</dt>
|
|
138
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'
|
|
143
|
+
<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
144
|
|
|
140
|
-
<dt id="
|
|
145
|
+
<dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
|
|
141
146
|
<div class="docstring">
|
|
142
147
|
<div class="discussion">
|
|
143
148
|
|
|
144
|
-
<p>The API
|
|
149
|
+
<p>The List Property from the resulting API for list calls</p>
|
|
145
150
|
|
|
146
151
|
|
|
147
152
|
</div>
|
|
@@ -151,7 +156,7 @@
|
|
|
151
156
|
|
|
152
157
|
</div>
|
|
153
158
|
</dt>
|
|
154
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'
|
|
159
|
+
<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
160
|
|
|
156
161
|
</dl>
|
|
157
162
|
|
|
@@ -207,7 +212,7 @@
|
|
|
207
212
|
<li class="public ">
|
|
208
213
|
<span class="summary_signature">
|
|
209
214
|
|
|
210
|
-
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(name
|
|
215
|
+
<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
216
|
|
|
212
217
|
|
|
213
218
|
|
|
@@ -231,7 +236,7 @@
|
|
|
231
236
|
<li class="public ">
|
|
232
237
|
<span class="summary_signature">
|
|
233
238
|
|
|
234
|
-
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id:
|
|
239
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
235
240
|
|
|
236
241
|
|
|
237
242
|
|
|
@@ -255,7 +260,7 @@
|
|
|
255
260
|
<li class="public ">
|
|
256
261
|
<span class="summary_signature">
|
|
257
262
|
|
|
258
|
-
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id:
|
|
263
|
+
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
259
264
|
|
|
260
265
|
|
|
261
266
|
|
|
@@ -279,7 +284,7 @@
|
|
|
279
284
|
<li class="public ">
|
|
280
285
|
<span class="summary_signature">
|
|
281
286
|
|
|
282
|
-
<a href="#delete_certificate-instance_method" title="#delete_certificate (instance method)">#<strong>delete_certificate</strong>(id:
|
|
287
|
+
<a href="#delete_certificate-instance_method" title="#delete_certificate (instance method)">#<strong>delete_certificate</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
283
288
|
|
|
284
289
|
|
|
285
290
|
|
|
@@ -294,7 +299,7 @@
|
|
|
294
299
|
|
|
295
300
|
|
|
296
301
|
<span class="summary_desc"><div class='inline'>
|
|
297
|
-
<p>Detach the certificate attached
|
|
302
|
+
<p>Detach the certificate attached to a reserved domain.</p>
|
|
298
303
|
</div></span>
|
|
299
304
|
|
|
300
305
|
</li>
|
|
@@ -303,7 +308,7 @@
|
|
|
303
308
|
<li class="public ">
|
|
304
309
|
<span class="summary_signature">
|
|
305
310
|
|
|
306
|
-
<a href="#delete_certificate!-instance_method" title="#delete_certificate! (instance method)">#<strong>delete_certificate!</strong>(id:
|
|
311
|
+
<a href="#delete_certificate!-instance_method" title="#delete_certificate! (instance method)">#<strong>delete_certificate!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
307
312
|
|
|
308
313
|
|
|
309
314
|
|
|
@@ -318,7 +323,7 @@
|
|
|
318
323
|
|
|
319
324
|
|
|
320
325
|
<span class="summary_desc"><div class='inline'>
|
|
321
|
-
<p>Detach the certificate attached
|
|
326
|
+
<p>Detach the certificate attached to a reserved domain.</p>
|
|
322
327
|
</div></span>
|
|
323
328
|
|
|
324
329
|
</li>
|
|
@@ -327,7 +332,7 @@
|
|
|
327
332
|
<li class="public ">
|
|
328
333
|
<span class="summary_signature">
|
|
329
334
|
|
|
330
|
-
<a href="#delete_certificate_management_policy-instance_method" title="#delete_certificate_management_policy (instance method)">#<strong>delete_certificate_management_policy</strong>(id:
|
|
335
|
+
<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
336
|
|
|
332
337
|
|
|
333
338
|
|
|
@@ -342,7 +347,7 @@
|
|
|
342
347
|
|
|
343
348
|
|
|
344
349
|
<span class="summary_desc"><div class='inline'>
|
|
345
|
-
<p>Detach the certificate management policy attached
|
|
350
|
+
<p>Detach the certificate management policy attached to a reserved domain.</p>
|
|
346
351
|
</div></span>
|
|
347
352
|
|
|
348
353
|
</li>
|
|
@@ -351,7 +356,7 @@
|
|
|
351
356
|
<li class="public ">
|
|
352
357
|
<span class="summary_signature">
|
|
353
358
|
|
|
354
|
-
<a href="#delete_certificate_management_policy!-instance_method" title="#delete_certificate_management_policy! (instance method)">#<strong>delete_certificate_management_policy!</strong>(id:
|
|
359
|
+
<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
360
|
|
|
356
361
|
|
|
357
362
|
|
|
@@ -366,7 +371,7 @@
|
|
|
366
371
|
|
|
367
372
|
|
|
368
373
|
<span class="summary_desc"><div class='inline'>
|
|
369
|
-
<p>Detach the certificate management policy attached
|
|
374
|
+
<p>Detach the certificate management policy attached to a reserved domain.</p>
|
|
370
375
|
</div></span>
|
|
371
376
|
|
|
372
377
|
</li>
|
|
@@ -375,7 +380,7 @@
|
|
|
375
380
|
<li class="public ">
|
|
376
381
|
<span class="summary_signature">
|
|
377
382
|
|
|
378
|
-
<a href="#delete_http_endpoint_config-instance_method" title="#delete_http_endpoint_config (instance method)">#<strong>delete_http_endpoint_config</strong>(id:
|
|
383
|
+
<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
384
|
|
|
380
385
|
|
|
381
386
|
|
|
@@ -390,7 +395,7 @@
|
|
|
390
395
|
|
|
391
396
|
|
|
392
397
|
<span class="summary_desc"><div class='inline'>
|
|
393
|
-
<p>Detach the http endpoint configuration attached
|
|
398
|
+
<p>Detach the http endpoint configuration attached to a reserved domain.</p>
|
|
394
399
|
</div></span>
|
|
395
400
|
|
|
396
401
|
</li>
|
|
@@ -399,7 +404,7 @@
|
|
|
399
404
|
<li class="public ">
|
|
400
405
|
<span class="summary_signature">
|
|
401
406
|
|
|
402
|
-
<a href="#delete_http_endpoint_config!-instance_method" title="#delete_http_endpoint_config! (instance method)">#<strong>delete_http_endpoint_config!</strong>(id:
|
|
407
|
+
<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
408
|
|
|
404
409
|
|
|
405
410
|
|
|
@@ -414,7 +419,7 @@
|
|
|
414
419
|
|
|
415
420
|
|
|
416
421
|
<span class="summary_desc"><div class='inline'>
|
|
417
|
-
<p>Detach the http endpoint configuration attached
|
|
422
|
+
<p>Detach the http endpoint configuration attached to a reserved domain.</p>
|
|
418
423
|
</div></span>
|
|
419
424
|
|
|
420
425
|
</li>
|
|
@@ -423,7 +428,7 @@
|
|
|
423
428
|
<li class="public ">
|
|
424
429
|
<span class="summary_signature">
|
|
425
430
|
|
|
426
|
-
<a href="#delete_https_endpoint_config-instance_method" title="#delete_https_endpoint_config (instance method)">#<strong>delete_https_endpoint_config</strong>(id:
|
|
431
|
+
<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
432
|
|
|
428
433
|
|
|
429
434
|
|
|
@@ -438,7 +443,7 @@
|
|
|
438
443
|
|
|
439
444
|
|
|
440
445
|
<span class="summary_desc"><div class='inline'>
|
|
441
|
-
<p>Detach the https endpoint configuration attached
|
|
446
|
+
<p>Detach the https endpoint configuration attached to a reserved domain.</p>
|
|
442
447
|
</div></span>
|
|
443
448
|
|
|
444
449
|
</li>
|
|
@@ -447,7 +452,7 @@
|
|
|
447
452
|
<li class="public ">
|
|
448
453
|
<span class="summary_signature">
|
|
449
454
|
|
|
450
|
-
<a href="#delete_https_endpoint_config!-instance_method" title="#delete_https_endpoint_config! (instance method)">#<strong>delete_https_endpoint_config!</strong>(id:
|
|
455
|
+
<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
456
|
|
|
452
457
|
|
|
453
458
|
|
|
@@ -462,7 +467,7 @@
|
|
|
462
467
|
|
|
463
468
|
|
|
464
469
|
<span class="summary_desc"><div class='inline'>
|
|
465
|
-
<p>Detach the https endpoint configuration attached
|
|
470
|
+
<p>Detach the https endpoint configuration attached to a reserved domain.</p>
|
|
466
471
|
</div></span>
|
|
467
472
|
|
|
468
473
|
</li>
|
|
@@ -471,7 +476,7 @@
|
|
|
471
476
|
<li class="public ">
|
|
472
477
|
<span class="summary_signature">
|
|
473
478
|
|
|
474
|
-
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id:
|
|
479
|
+
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: "") ⇒ NgrokAPI::Models::ReservedDomain </a>
|
|
475
480
|
|
|
476
481
|
|
|
477
482
|
|
|
@@ -495,7 +500,7 @@
|
|
|
495
500
|
<li class="public ">
|
|
496
501
|
<span class="summary_signature">
|
|
497
502
|
|
|
498
|
-
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id:
|
|
503
|
+
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: "") ⇒ NgrokAPI::Models::ReservedDomain </a>
|
|
499
504
|
|
|
500
505
|
|
|
501
506
|
|
|
@@ -569,7 +574,7 @@
|
|
|
569
574
|
<li class="public ">
|
|
570
575
|
<span class="summary_signature">
|
|
571
576
|
|
|
572
|
-
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id:
|
|
577
|
+
<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
578
|
|
|
574
579
|
|
|
575
580
|
|
|
@@ -593,7 +598,7 @@
|
|
|
593
598
|
<li class="public ">
|
|
594
599
|
<span class="summary_signature">
|
|
595
600
|
|
|
596
|
-
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id:
|
|
601
|
+
<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
602
|
|
|
598
603
|
|
|
599
604
|
|
|
@@ -646,15 +651,15 @@
|
|
|
646
651
|
<pre class="lines">
|
|
647
652
|
|
|
648
653
|
|
|
649
|
-
|
|
650
|
-
|
|
651
|
-
|
|
654
|
+
20
|
|
655
|
+
21
|
|
656
|
+
22</pre>
|
|
652
657
|
</td>
|
|
653
658
|
<td>
|
|
654
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
|
659
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 20</span>
|
|
655
660
|
|
|
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>
|
|
661
|
+
<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>
|
|
662
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
658
663
|
<span class='kw'>end</span></pre>
|
|
659
664
|
</td>
|
|
660
665
|
</tr>
|
|
@@ -694,12 +699,12 @@
|
|
|
694
699
|
<pre class="lines">
|
|
695
700
|
|
|
696
701
|
|
|
697
|
-
|
|
698
|
-
|
|
699
|
-
|
|
702
|
+
18
|
|
703
|
+
19
|
|
704
|
+
20</pre>
|
|
700
705
|
</td>
|
|
701
706
|
<td>
|
|
702
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
|
707
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 18</span>
|
|
703
708
|
|
|
704
709
|
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
|
705
710
|
<span class='ivar'>@client</span>
|
|
@@ -719,7 +724,7 @@
|
|
|
719
724
|
<div class="method_details first">
|
|
720
725
|
<h3 class="signature first" id="create-instance_method">
|
|
721
726
|
|
|
722
|
-
#<strong>create</strong>(name
|
|
727
|
+
#<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
728
|
|
|
724
729
|
|
|
725
730
|
|
|
@@ -747,8 +752,6 @@
|
|
|
747
752
|
<span class='type'>(<tt>string</tt>)</span>
|
|
748
753
|
|
|
749
754
|
|
|
750
|
-
<em class="default">(defaults to: <tt>''</tt>)</em>
|
|
751
|
-
|
|
752
755
|
|
|
753
756
|
—
|
|
754
757
|
<div class='inline'>
|
|
@@ -765,7 +768,7 @@
|
|
|
765
768
|
<span class='type'>(<tt>string</tt>)</span>
|
|
766
769
|
|
|
767
770
|
|
|
768
|
-
<em class="default">(defaults to: <tt
|
|
771
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
769
772
|
|
|
770
773
|
|
|
771
774
|
—
|
|
@@ -783,7 +786,7 @@
|
|
|
783
786
|
<span class='type'>(<tt>string</tt>)</span>
|
|
784
787
|
|
|
785
788
|
|
|
786
|
-
<em class="default">(defaults to: <tt
|
|
789
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
787
790
|
|
|
788
791
|
|
|
789
792
|
—
|
|
@@ -801,7 +804,7 @@
|
|
|
801
804
|
<span class='type'>(<tt>string</tt>)</span>
|
|
802
805
|
|
|
803
806
|
|
|
804
|
-
<em class="default">(defaults to: <tt
|
|
807
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
805
808
|
|
|
806
809
|
|
|
807
810
|
—
|
|
@@ -819,7 +822,7 @@
|
|
|
819
822
|
<span class='type'>(<tt>string</tt>)</span>
|
|
820
823
|
|
|
821
824
|
|
|
822
|
-
<em class="default">(defaults to: <tt
|
|
825
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
823
826
|
|
|
824
827
|
|
|
825
828
|
—
|
|
@@ -837,7 +840,7 @@
|
|
|
837
840
|
<span class='type'>(<tt>string</tt>)</span>
|
|
838
841
|
|
|
839
842
|
|
|
840
|
-
<em class="default">(defaults to: <tt
|
|
843
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
841
844
|
|
|
842
845
|
|
|
843
846
|
—
|
|
@@ -870,7 +873,7 @@
|
|
|
870
873
|
<span class='name'>certificate_management_policy</span>
|
|
871
874
|
|
|
872
875
|
|
|
873
|
-
<span class='type'>(<tt>
|
|
876
|
+
<span class='type'>(<tt>ReservedDomainCertPolicy</tt>)</span>
|
|
874
877
|
|
|
875
878
|
|
|
876
879
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -897,7 +900,7 @@
|
|
|
897
900
|
|
|
898
901
|
—
|
|
899
902
|
<div class='inline'>
|
|
900
|
-
<p>result from
|
|
903
|
+
<p>result from the API request</p>
|
|
901
904
|
</div>
|
|
902
905
|
|
|
903
906
|
</li>
|
|
@@ -910,7 +913,6 @@
|
|
|
910
913
|
<pre class="lines">
|
|
911
914
|
|
|
912
915
|
|
|
913
|
-
37
|
|
914
916
|
38
|
|
915
917
|
39
|
|
916
918
|
40
|
|
@@ -932,33 +934,38 @@
|
|
|
932
934
|
56
|
|
933
935
|
57
|
|
934
936
|
58
|
|
935
|
-
59
|
|
937
|
+
59
|
|
938
|
+
60
|
|
939
|
+
61
|
|
940
|
+
62</pre>
|
|
936
941
|
</td>
|
|
937
942
|
<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='label'>name:</span
|
|
942
|
-
<span class='label'>region:</span> <span class='tstring'><span class='tstring_beg'
|
|
943
|
-
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'
|
|
944
|
-
<span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'
|
|
945
|
-
<span class='label'>http_endpoint_configuration_id:</span> <span class='
|
|
946
|
-
<span class='label'>https_endpoint_configuration_id:</span> <span class='
|
|
947
|
-
<span class='label'>certificate_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
948
|
-
<span class='label'>certificate_management_policy:</span> <span class='kw'>nil</span>
|
|
949
|
-
<span class='rparen'>)</span>
|
|
950
|
-
<span class='id identifier
|
|
951
|
-
|
|
952
|
-
|
|
953
|
-
|
|
954
|
-
|
|
955
|
-
|
|
956
|
-
|
|
957
|
-
|
|
958
|
-
|
|
959
|
-
<span class='
|
|
960
|
-
<span class='id identifier
|
|
961
|
-
<span class='
|
|
943
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 38</span>
|
|
944
|
+
|
|
945
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span>
|
|
946
|
+
<span class='label'>name:</span><span class='comma'>,</span>
|
|
947
|
+
<span class='label'>region:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
948
|
+
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
949
|
+
<span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
950
|
+
<span class='label'>http_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
951
|
+
<span class='label'>https_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
952
|
+
<span class='label'>certificate_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
953
|
+
<span class='label'>certificate_management_policy:</span> <span class='kw'>nil</span>
|
|
954
|
+
<span class='rparen'>)</span>
|
|
955
|
+
<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>
|
|
956
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
957
|
+
<span class='rbrace'>}</span>
|
|
958
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
959
|
+
<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>
|
|
960
|
+
<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>
|
|
961
|
+
<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>
|
|
962
|
+
<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>
|
|
963
|
+
<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>
|
|
964
|
+
<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>
|
|
965
|
+
<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>
|
|
966
|
+
<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>
|
|
967
|
+
<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>
|
|
968
|
+
<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
969
|
<span class='kw'>end</span></pre>
|
|
963
970
|
</td>
|
|
964
971
|
</tr>
|
|
@@ -968,7 +975,7 @@
|
|
|
968
975
|
<div class="method_details ">
|
|
969
976
|
<h3 class="signature " id="delete-instance_method">
|
|
970
977
|
|
|
971
|
-
#<strong>delete</strong>(id:
|
|
978
|
+
#<strong>delete</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
972
979
|
|
|
973
980
|
|
|
974
981
|
|
|
@@ -996,7 +1003,7 @@
|
|
|
996
1003
|
<span class='type'>(<tt>string</tt>)</span>
|
|
997
1004
|
|
|
998
1005
|
|
|
999
|
-
<em class="default">(defaults to: <tt
|
|
1006
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1000
1007
|
|
|
1001
1008
|
|
|
1002
1009
|
—
|
|
@@ -1014,13 +1021,13 @@
|
|
|
1014
1021
|
<li>
|
|
1015
1022
|
|
|
1016
1023
|
|
|
1017
|
-
<span class='type'>(<tt>
|
|
1024
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
1018
1025
|
|
|
1019
1026
|
|
|
1020
1027
|
|
|
1021
1028
|
—
|
|
1022
1029
|
<div class='inline'>
|
|
1023
|
-
<p>result from
|
|
1030
|
+
<p>result from the API request</p>
|
|
1024
1031
|
</div>
|
|
1025
1032
|
|
|
1026
1033
|
</li>
|
|
@@ -1033,15 +1040,27 @@
|
|
|
1033
1040
|
<pre class="lines">
|
|
1034
1041
|
|
|
1035
1042
|
|
|
1036
|
-
|
|
1037
|
-
|
|
1038
|
-
|
|
1043
|
+
71
|
|
1044
|
+
72
|
|
1045
|
+
73
|
|
1046
|
+
74
|
|
1047
|
+
75
|
|
1048
|
+
76
|
|
1049
|
+
77
|
|
1050
|
+
78
|
|
1051
|
+
79</pre>
|
|
1039
1052
|
</td>
|
|
1040
1053
|
<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
|
|
1044
|
-
<span class='
|
|
1054
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 71</span>
|
|
1055
|
+
|
|
1056
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span>
|
|
1057
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
1058
|
+
<span class='rparen'>)</span>
|
|
1059
|
+
<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>
|
|
1060
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1061
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1062
|
+
<span class='rbrace'>}</span>
|
|
1063
|
+
<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
1064
|
<span class='kw'>end</span></pre>
|
|
1046
1065
|
</td>
|
|
1047
1066
|
</tr>
|
|
@@ -1051,7 +1070,7 @@
|
|
|
1051
1070
|
<div class="method_details ">
|
|
1052
1071
|
<h3 class="signature " id="delete!-instance_method">
|
|
1053
1072
|
|
|
1054
|
-
#<strong>delete!</strong>(id:
|
|
1073
|
+
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
1055
1074
|
|
|
1056
1075
|
|
|
1057
1076
|
|
|
@@ -1060,7 +1079,7 @@
|
|
|
1060
1079
|
</h3><div class="docstring">
|
|
1061
1080
|
<div class="discussion">
|
|
1062
1081
|
|
|
1063
|
-
<p>Delete a reserved domain.
|
|
1082
|
+
<p>Delete a reserved domain. Throws an exception if API error.</p>
|
|
1064
1083
|
|
|
1065
1084
|
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete">ngrok.com/docs/api#api-reserved-domains-delete</a></p>
|
|
1066
1085
|
|
|
@@ -1079,7 +1098,7 @@
|
|
|
1079
1098
|
<span class='type'>(<tt>string</tt>)</span>
|
|
1080
1099
|
|
|
1081
1100
|
|
|
1082
|
-
<em class="default">(defaults to: <tt
|
|
1101
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1083
1102
|
|
|
1084
1103
|
|
|
1085
1104
|
—
|
|
@@ -1097,13 +1116,13 @@
|
|
|
1097
1116
|
<li>
|
|
1098
1117
|
|
|
1099
1118
|
|
|
1100
|
-
<span class='type'>(<tt>
|
|
1119
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
1101
1120
|
|
|
1102
1121
|
|
|
1103
1122
|
|
|
1104
1123
|
—
|
|
1105
1124
|
<div class='inline'>
|
|
1106
|
-
<p>result from
|
|
1125
|
+
<p>result from the API request</p>
|
|
1107
1126
|
</div>
|
|
1108
1127
|
|
|
1109
1128
|
</li>
|
|
@@ -1116,15 +1135,27 @@
|
|
|
1116
1135
|
<pre class="lines">
|
|
1117
1136
|
|
|
1118
1137
|
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
|
|
1138
|
+
89
|
|
1139
|
+
90
|
|
1140
|
+
91
|
|
1141
|
+
92
|
|
1142
|
+
93
|
|
1143
|
+
94
|
|
1144
|
+
95
|
|
1145
|
+
96
|
|
1146
|
+
97</pre>
|
|
1122
1147
|
</td>
|
|
1123
1148
|
<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
|
|
1127
|
-
<span class='
|
|
1149
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 89</span>
|
|
1150
|
+
|
|
1151
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span>
|
|
1152
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
1153
|
+
<span class='rparen'>)</span>
|
|
1154
|
+
<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>
|
|
1155
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1156
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1157
|
+
<span class='rbrace'>}</span>
|
|
1158
|
+
<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
1159
|
<span class='kw'>end</span></pre>
|
|
1129
1160
|
</td>
|
|
1130
1161
|
</tr>
|
|
@@ -1134,7 +1165,7 @@
|
|
|
1134
1165
|
<div class="method_details ">
|
|
1135
1166
|
<h3 class="signature " id="delete_certificate-instance_method">
|
|
1136
1167
|
|
|
1137
|
-
#<strong>delete_certificate</strong>(id:
|
|
1168
|
+
#<strong>delete_certificate</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
1138
1169
|
|
|
1139
1170
|
|
|
1140
1171
|
|
|
@@ -1143,7 +1174,7 @@
|
|
|
1143
1174
|
</h3><div class="docstring">
|
|
1144
1175
|
<div class="discussion">
|
|
1145
1176
|
|
|
1146
|
-
<p>Detach the certificate attached
|
|
1177
|
+
<p>Detach the certificate attached to a reserved domain.</p>
|
|
1147
1178
|
|
|
1148
1179
|
<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
1180
|
|
|
@@ -1162,7 +1193,7 @@
|
|
|
1162
1193
|
<span class='type'>(<tt>string</tt>)</span>
|
|
1163
1194
|
|
|
1164
1195
|
|
|
1165
|
-
<em class="default">(defaults to: <tt
|
|
1196
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1166
1197
|
|
|
1167
1198
|
|
|
1168
1199
|
—
|
|
@@ -1180,13 +1211,13 @@
|
|
|
1180
1211
|
<li>
|
|
1181
1212
|
|
|
1182
1213
|
|
|
1183
|
-
<span class='type'>(<tt>
|
|
1214
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
1184
1215
|
|
|
1185
1216
|
|
|
1186
1217
|
|
|
1187
1218
|
—
|
|
1188
1219
|
<div class='inline'>
|
|
1189
|
-
<p>result from
|
|
1220
|
+
<p>result from the API request</p>
|
|
1190
1221
|
</div>
|
|
1191
1222
|
|
|
1192
1223
|
</li>
|
|
@@ -1199,15 +1230,27 @@
|
|
|
1199
1230
|
<pre class="lines">
|
|
1200
1231
|
|
|
1201
1232
|
|
|
1202
|
-
|
|
1203
|
-
|
|
1204
|
-
|
|
1233
|
+
283
|
|
1234
|
+
284
|
|
1235
|
+
285
|
|
1236
|
+
286
|
|
1237
|
+
287
|
|
1238
|
+
288
|
|
1239
|
+
289
|
|
1240
|
+
290
|
|
1241
|
+
291</pre>
|
|
1205
1242
|
</td>
|
|
1206
1243
|
<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
|
|
1210
|
-
<span class='
|
|
1244
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 283</span>
|
|
1245
|
+
|
|
1246
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate'>delete_certificate</span><span class='lparen'>(</span>
|
|
1247
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
1248
|
+
<span class='rparen'>)</span>
|
|
1249
|
+
<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>
|
|
1250
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1251
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1252
|
+
<span class='rbrace'>}</span>
|
|
1253
|
+
<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
1254
|
<span class='kw'>end</span></pre>
|
|
1212
1255
|
</td>
|
|
1213
1256
|
</tr>
|
|
@@ -1217,7 +1260,7 @@
|
|
|
1217
1260
|
<div class="method_details ">
|
|
1218
1261
|
<h3 class="signature " id="delete_certificate!-instance_method">
|
|
1219
1262
|
|
|
1220
|
-
#<strong>delete_certificate!</strong>(id:
|
|
1263
|
+
#<strong>delete_certificate!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
1221
1264
|
|
|
1222
1265
|
|
|
1223
1266
|
|
|
@@ -1226,7 +1269,7 @@
|
|
|
1226
1269
|
</h3><div class="docstring">
|
|
1227
1270
|
<div class="discussion">
|
|
1228
1271
|
|
|
1229
|
-
<p>Detach the certificate attached
|
|
1272
|
+
<p>Detach the certificate attached to a reserved domain. Throws an exception if API error.</p>
|
|
1230
1273
|
|
|
1231
1274
|
<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
1275
|
|
|
@@ -1245,7 +1288,7 @@
|
|
|
1245
1288
|
<span class='type'>(<tt>string</tt>)</span>
|
|
1246
1289
|
|
|
1247
1290
|
|
|
1248
|
-
<em class="default">(defaults to: <tt
|
|
1291
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1249
1292
|
|
|
1250
1293
|
|
|
1251
1294
|
—
|
|
@@ -1263,13 +1306,13 @@
|
|
|
1263
1306
|
<li>
|
|
1264
1307
|
|
|
1265
1308
|
|
|
1266
|
-
<span class='type'>(<tt>
|
|
1309
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
1267
1310
|
|
|
1268
1311
|
|
|
1269
1312
|
|
|
1270
1313
|
—
|
|
1271
1314
|
<div class='inline'>
|
|
1272
|
-
<p>result from
|
|
1315
|
+
<p>result from the API request</p>
|
|
1273
1316
|
</div>
|
|
1274
1317
|
|
|
1275
1318
|
</li>
|
|
@@ -1282,15 +1325,27 @@
|
|
|
1282
1325
|
<pre class="lines">
|
|
1283
1326
|
|
|
1284
1327
|
|
|
1285
|
-
|
|
1286
|
-
|
|
1287
|
-
|
|
1328
|
+
301
|
|
1329
|
+
302
|
|
1330
|
+
303
|
|
1331
|
+
304
|
|
1332
|
+
305
|
|
1333
|
+
306
|
|
1334
|
+
307
|
|
1335
|
+
308
|
|
1336
|
+
309</pre>
|
|
1288
1337
|
</td>
|
|
1289
1338
|
<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
|
|
1293
|
-
<span class='
|
|
1339
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 301</span>
|
|
1340
|
+
|
|
1341
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate!'>delete_certificate!</span><span class='lparen'>(</span>
|
|
1342
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
1343
|
+
<span class='rparen'>)</span>
|
|
1344
|
+
<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>
|
|
1345
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1346
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1347
|
+
<span class='rbrace'>}</span>
|
|
1348
|
+
<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
1349
|
<span class='kw'>end</span></pre>
|
|
1295
1350
|
</td>
|
|
1296
1351
|
</tr>
|
|
@@ -1300,7 +1355,7 @@
|
|
|
1300
1355
|
<div class="method_details ">
|
|
1301
1356
|
<h3 class="signature " id="delete_certificate_management_policy-instance_method">
|
|
1302
1357
|
|
|
1303
|
-
#<strong>delete_certificate_management_policy</strong>(id:
|
|
1358
|
+
#<strong>delete_certificate_management_policy</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
1304
1359
|
|
|
1305
1360
|
|
|
1306
1361
|
|
|
@@ -1309,7 +1364,7 @@
|
|
|
1309
1364
|
</h3><div class="docstring">
|
|
1310
1365
|
<div class="discussion">
|
|
1311
1366
|
|
|
1312
|
-
<p>Detach the certificate management policy attached
|
|
1367
|
+
<p>Detach the certificate management policy attached to a reserved domain.</p>
|
|
1313
1368
|
|
|
1314
1369
|
<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
1370
|
|
|
@@ -1328,7 +1383,7 @@
|
|
|
1328
1383
|
<span class='type'>(<tt>string</tt>)</span>
|
|
1329
1384
|
|
|
1330
1385
|
|
|
1331
|
-
<em class="default">(defaults to: <tt
|
|
1386
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1332
1387
|
|
|
1333
1388
|
|
|
1334
1389
|
—
|
|
@@ -1346,13 +1401,13 @@
|
|
|
1346
1401
|
<li>
|
|
1347
1402
|
|
|
1348
1403
|
|
|
1349
|
-
<span class='type'>(<tt>
|
|
1404
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
1350
1405
|
|
|
1351
1406
|
|
|
1352
1407
|
|
|
1353
1408
|
—
|
|
1354
1409
|
<div class='inline'>
|
|
1355
|
-
<p>result from
|
|
1410
|
+
<p>result from the API request</p>
|
|
1356
1411
|
</div>
|
|
1357
1412
|
|
|
1358
1413
|
</li>
|
|
@@ -1365,15 +1420,27 @@
|
|
|
1365
1420
|
<pre class="lines">
|
|
1366
1421
|
|
|
1367
1422
|
|
|
1368
|
-
|
|
1369
|
-
|
|
1370
|
-
|
|
1423
|
+
248
|
|
1424
|
+
249
|
|
1425
|
+
250
|
|
1426
|
+
251
|
|
1427
|
+
252
|
|
1428
|
+
253
|
|
1429
|
+
254
|
|
1430
|
+
255
|
|
1431
|
+
256</pre>
|
|
1371
1432
|
</td>
|
|
1372
1433
|
<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
|
|
1376
|
-
<span class='
|
|
1434
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 248</span>
|
|
1435
|
+
|
|
1436
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate_management_policy'>delete_certificate_management_policy</span><span class='lparen'>(</span>
|
|
1437
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
1438
|
+
<span class='rparen'>)</span>
|
|
1439
|
+
<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>
|
|
1440
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1441
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1442
|
+
<span class='rbrace'>}</span>
|
|
1443
|
+
<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
1444
|
<span class='kw'>end</span></pre>
|
|
1378
1445
|
</td>
|
|
1379
1446
|
</tr>
|
|
@@ -1383,7 +1450,7 @@
|
|
|
1383
1450
|
<div class="method_details ">
|
|
1384
1451
|
<h3 class="signature " id="delete_certificate_management_policy!-instance_method">
|
|
1385
1452
|
|
|
1386
|
-
#<strong>delete_certificate_management_policy!</strong>(id:
|
|
1453
|
+
#<strong>delete_certificate_management_policy!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
1387
1454
|
|
|
1388
1455
|
|
|
1389
1456
|
|
|
@@ -1392,7 +1459,7 @@
|
|
|
1392
1459
|
</h3><div class="docstring">
|
|
1393
1460
|
<div class="discussion">
|
|
1394
1461
|
|
|
1395
|
-
<p>Detach the certificate management policy attached
|
|
1462
|
+
<p>Detach the certificate management policy attached to a reserved domain. Throws an exception if API error.</p>
|
|
1396
1463
|
|
|
1397
1464
|
<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
1465
|
|
|
@@ -1411,7 +1478,7 @@
|
|
|
1411
1478
|
<span class='type'>(<tt>string</tt>)</span>
|
|
1412
1479
|
|
|
1413
1480
|
|
|
1414
|
-
<em class="default">(defaults to: <tt
|
|
1481
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1415
1482
|
|
|
1416
1483
|
|
|
1417
1484
|
—
|
|
@@ -1429,13 +1496,13 @@
|
|
|
1429
1496
|
<li>
|
|
1430
1497
|
|
|
1431
1498
|
|
|
1432
|
-
<span class='type'>(<tt>
|
|
1499
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
1433
1500
|
|
|
1434
1501
|
|
|
1435
1502
|
|
|
1436
1503
|
—
|
|
1437
1504
|
<div class='inline'>
|
|
1438
|
-
<p>result from
|
|
1505
|
+
<p>result from the API request</p>
|
|
1439
1506
|
</div>
|
|
1440
1507
|
|
|
1441
1508
|
</li>
|
|
@@ -1448,15 +1515,27 @@
|
|
|
1448
1515
|
<pre class="lines">
|
|
1449
1516
|
|
|
1450
1517
|
|
|
1451
|
-
|
|
1452
|
-
|
|
1453
|
-
|
|
1518
|
+
266
|
|
1519
|
+
267
|
|
1520
|
+
268
|
|
1521
|
+
269
|
|
1522
|
+
270
|
|
1523
|
+
271
|
|
1524
|
+
272
|
|
1525
|
+
273
|
|
1526
|
+
274</pre>
|
|
1454
1527
|
</td>
|
|
1455
1528
|
<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
|
|
1459
|
-
<span class='
|
|
1529
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 266</span>
|
|
1530
|
+
|
|
1531
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate_management_policy!'>delete_certificate_management_policy!</span><span class='lparen'>(</span>
|
|
1532
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
1533
|
+
<span class='rparen'>)</span>
|
|
1534
|
+
<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>
|
|
1535
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1536
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1537
|
+
<span class='rbrace'>}</span>
|
|
1538
|
+
<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
1539
|
<span class='kw'>end</span></pre>
|
|
1461
1540
|
</td>
|
|
1462
1541
|
</tr>
|
|
@@ -1466,7 +1545,7 @@
|
|
|
1466
1545
|
<div class="method_details ">
|
|
1467
1546
|
<h3 class="signature " id="delete_http_endpoint_config-instance_method">
|
|
1468
1547
|
|
|
1469
|
-
#<strong>delete_http_endpoint_config</strong>(id:
|
|
1548
|
+
#<strong>delete_http_endpoint_config</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
1470
1549
|
|
|
1471
1550
|
|
|
1472
1551
|
|
|
@@ -1475,7 +1554,7 @@
|
|
|
1475
1554
|
</h3><div class="docstring">
|
|
1476
1555
|
<div class="discussion">
|
|
1477
1556
|
|
|
1478
|
-
<p>Detach the http endpoint configuration attached
|
|
1557
|
+
<p>Detach the http endpoint configuration attached to a reserved domain.</p>
|
|
1479
1558
|
|
|
1480
1559
|
<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
1560
|
|
|
@@ -1494,7 +1573,7 @@
|
|
|
1494
1573
|
<span class='type'>(<tt>string</tt>)</span>
|
|
1495
1574
|
|
|
1496
1575
|
|
|
1497
|
-
<em class="default">(defaults to: <tt
|
|
1576
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1498
1577
|
|
|
1499
1578
|
|
|
1500
1579
|
—
|
|
@@ -1512,13 +1591,13 @@
|
|
|
1512
1591
|
<li>
|
|
1513
1592
|
|
|
1514
1593
|
|
|
1515
|
-
<span class='type'>(<tt>
|
|
1594
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
1516
1595
|
|
|
1517
1596
|
|
|
1518
1597
|
|
|
1519
1598
|
—
|
|
1520
1599
|
<div class='inline'>
|
|
1521
|
-
<p>result from
|
|
1600
|
+
<p>result from the API request</p>
|
|
1522
1601
|
</div>
|
|
1523
1602
|
|
|
1524
1603
|
</li>
|
|
@@ -1531,15 +1610,27 @@
|
|
|
1531
1610
|
<pre class="lines">
|
|
1532
1611
|
|
|
1533
1612
|
|
|
1534
|
-
|
|
1535
|
-
|
|
1536
|
-
|
|
1613
|
+
318
|
|
1614
|
+
319
|
|
1615
|
+
320
|
|
1616
|
+
321
|
|
1617
|
+
322
|
|
1618
|
+
323
|
|
1619
|
+
324
|
|
1620
|
+
325
|
|
1621
|
+
326</pre>
|
|
1537
1622
|
</td>
|
|
1538
1623
|
<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
|
|
1542
|
-
<span class='
|
|
1624
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 318</span>
|
|
1625
|
+
|
|
1626
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_http_endpoint_config'>delete_http_endpoint_config</span><span class='lparen'>(</span>
|
|
1627
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
1628
|
+
<span class='rparen'>)</span>
|
|
1629
|
+
<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>
|
|
1630
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1631
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1632
|
+
<span class='rbrace'>}</span>
|
|
1633
|
+
<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
1634
|
<span class='kw'>end</span></pre>
|
|
1544
1635
|
</td>
|
|
1545
1636
|
</tr>
|
|
@@ -1549,7 +1640,7 @@
|
|
|
1549
1640
|
<div class="method_details ">
|
|
1550
1641
|
<h3 class="signature " id="delete_http_endpoint_config!-instance_method">
|
|
1551
1642
|
|
|
1552
|
-
#<strong>delete_http_endpoint_config!</strong>(id:
|
|
1643
|
+
#<strong>delete_http_endpoint_config!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
1553
1644
|
|
|
1554
1645
|
|
|
1555
1646
|
|
|
@@ -1558,7 +1649,7 @@
|
|
|
1558
1649
|
</h3><div class="docstring">
|
|
1559
1650
|
<div class="discussion">
|
|
1560
1651
|
|
|
1561
|
-
<p>Detach the http endpoint configuration attached
|
|
1652
|
+
<p>Detach the http endpoint configuration attached to a reserved domain. Throws an exception if API error.</p>
|
|
1562
1653
|
|
|
1563
1654
|
<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
1655
|
|
|
@@ -1577,7 +1668,7 @@
|
|
|
1577
1668
|
<span class='type'>(<tt>string</tt>)</span>
|
|
1578
1669
|
|
|
1579
1670
|
|
|
1580
|
-
<em class="default">(defaults to: <tt
|
|
1671
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1581
1672
|
|
|
1582
1673
|
|
|
1583
1674
|
—
|
|
@@ -1595,13 +1686,13 @@
|
|
|
1595
1686
|
<li>
|
|
1596
1687
|
|
|
1597
1688
|
|
|
1598
|
-
<span class='type'>(<tt>
|
|
1689
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
1599
1690
|
|
|
1600
1691
|
|
|
1601
1692
|
|
|
1602
1693
|
—
|
|
1603
1694
|
<div class='inline'>
|
|
1604
|
-
<p>result from
|
|
1695
|
+
<p>result from the API request</p>
|
|
1605
1696
|
</div>
|
|
1606
1697
|
|
|
1607
1698
|
</li>
|
|
@@ -1614,15 +1705,27 @@
|
|
|
1614
1705
|
<pre class="lines">
|
|
1615
1706
|
|
|
1616
1707
|
|
|
1617
|
-
|
|
1618
|
-
|
|
1619
|
-
|
|
1708
|
+
336
|
|
1709
|
+
337
|
|
1710
|
+
338
|
|
1711
|
+
339
|
|
1712
|
+
340
|
|
1713
|
+
341
|
|
1714
|
+
342
|
|
1715
|
+
343
|
|
1716
|
+
344</pre>
|
|
1620
1717
|
</td>
|
|
1621
1718
|
<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
|
|
1625
|
-
<span class='
|
|
1719
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 336</span>
|
|
1720
|
+
|
|
1721
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_http_endpoint_config!'>delete_http_endpoint_config!</span><span class='lparen'>(</span>
|
|
1722
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
1723
|
+
<span class='rparen'>)</span>
|
|
1724
|
+
<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>
|
|
1725
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1726
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1727
|
+
<span class='rbrace'>}</span>
|
|
1728
|
+
<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
1729
|
<span class='kw'>end</span></pre>
|
|
1627
1730
|
</td>
|
|
1628
1731
|
</tr>
|
|
@@ -1632,7 +1735,7 @@
|
|
|
1632
1735
|
<div class="method_details ">
|
|
1633
1736
|
<h3 class="signature " id="delete_https_endpoint_config-instance_method">
|
|
1634
1737
|
|
|
1635
|
-
#<strong>delete_https_endpoint_config</strong>(id:
|
|
1738
|
+
#<strong>delete_https_endpoint_config</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
1636
1739
|
|
|
1637
1740
|
|
|
1638
1741
|
|
|
@@ -1641,7 +1744,7 @@
|
|
|
1641
1744
|
</h3><div class="docstring">
|
|
1642
1745
|
<div class="discussion">
|
|
1643
1746
|
|
|
1644
|
-
<p>Detach the https endpoint configuration attached
|
|
1747
|
+
<p>Detach the https endpoint configuration attached to a reserved domain.</p>
|
|
1645
1748
|
|
|
1646
1749
|
<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
1750
|
|
|
@@ -1660,7 +1763,7 @@
|
|
|
1660
1763
|
<span class='type'>(<tt>string</tt>)</span>
|
|
1661
1764
|
|
|
1662
1765
|
|
|
1663
|
-
<em class="default">(defaults to: <tt
|
|
1766
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1664
1767
|
|
|
1665
1768
|
|
|
1666
1769
|
—
|
|
@@ -1678,13 +1781,13 @@
|
|
|
1678
1781
|
<li>
|
|
1679
1782
|
|
|
1680
1783
|
|
|
1681
|
-
<span class='type'>(<tt>
|
|
1784
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
1682
1785
|
|
|
1683
1786
|
|
|
1684
1787
|
|
|
1685
1788
|
—
|
|
1686
1789
|
<div class='inline'>
|
|
1687
|
-
<p>result from
|
|
1790
|
+
<p>result from the API request</p>
|
|
1688
1791
|
</div>
|
|
1689
1792
|
|
|
1690
1793
|
</li>
|
|
@@ -1697,15 +1800,27 @@
|
|
|
1697
1800
|
<pre class="lines">
|
|
1698
1801
|
|
|
1699
1802
|
|
|
1700
|
-
|
|
1701
|
-
|
|
1702
|
-
|
|
1803
|
+
353
|
|
1804
|
+
354
|
|
1805
|
+
355
|
|
1806
|
+
356
|
|
1807
|
+
357
|
|
1808
|
+
358
|
|
1809
|
+
359
|
|
1810
|
+
360
|
|
1811
|
+
361</pre>
|
|
1703
1812
|
</td>
|
|
1704
1813
|
<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
|
|
1708
|
-
<span class='
|
|
1814
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 353</span>
|
|
1815
|
+
|
|
1816
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_https_endpoint_config'>delete_https_endpoint_config</span><span class='lparen'>(</span>
|
|
1817
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
1818
|
+
<span class='rparen'>)</span>
|
|
1819
|
+
<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>
|
|
1820
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1821
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1822
|
+
<span class='rbrace'>}</span>
|
|
1823
|
+
<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
1824
|
<span class='kw'>end</span></pre>
|
|
1710
1825
|
</td>
|
|
1711
1826
|
</tr>
|
|
@@ -1715,7 +1830,7 @@
|
|
|
1715
1830
|
<div class="method_details ">
|
|
1716
1831
|
<h3 class="signature " id="delete_https_endpoint_config!-instance_method">
|
|
1717
1832
|
|
|
1718
|
-
#<strong>delete_https_endpoint_config!</strong>(id:
|
|
1833
|
+
#<strong>delete_https_endpoint_config!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
1719
1834
|
|
|
1720
1835
|
|
|
1721
1836
|
|
|
@@ -1724,7 +1839,7 @@
|
|
|
1724
1839
|
</h3><div class="docstring">
|
|
1725
1840
|
<div class="discussion">
|
|
1726
1841
|
|
|
1727
|
-
<p>Detach the https endpoint configuration attached
|
|
1842
|
+
<p>Detach the https endpoint configuration attached to a reserved domain. Throws an exception if API error.</p>
|
|
1728
1843
|
|
|
1729
1844
|
<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
1845
|
|
|
@@ -1743,7 +1858,7 @@
|
|
|
1743
1858
|
<span class='type'>(<tt>string</tt>)</span>
|
|
1744
1859
|
|
|
1745
1860
|
|
|
1746
|
-
<em class="default">(defaults to: <tt
|
|
1861
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1747
1862
|
|
|
1748
1863
|
|
|
1749
1864
|
—
|
|
@@ -1761,13 +1876,13 @@
|
|
|
1761
1876
|
<li>
|
|
1762
1877
|
|
|
1763
1878
|
|
|
1764
|
-
<span class='type'>(<tt>
|
|
1879
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
1765
1880
|
|
|
1766
1881
|
|
|
1767
1882
|
|
|
1768
1883
|
—
|
|
1769
1884
|
<div class='inline'>
|
|
1770
|
-
<p>result from
|
|
1885
|
+
<p>result from the API request</p>
|
|
1771
1886
|
</div>
|
|
1772
1887
|
|
|
1773
1888
|
</li>
|
|
@@ -1780,15 +1895,27 @@
|
|
|
1780
1895
|
<pre class="lines">
|
|
1781
1896
|
|
|
1782
1897
|
|
|
1783
|
-
|
|
1784
|
-
|
|
1785
|
-
|
|
1898
|
+
371
|
|
1899
|
+
372
|
|
1900
|
+
373
|
|
1901
|
+
374
|
|
1902
|
+
375
|
|
1903
|
+
376
|
|
1904
|
+
377
|
|
1905
|
+
378
|
|
1906
|
+
379</pre>
|
|
1786
1907
|
</td>
|
|
1787
1908
|
<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
|
|
1791
|
-
<span class='
|
|
1909
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 371</span>
|
|
1910
|
+
|
|
1911
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_https_endpoint_config!'>delete_https_endpoint_config!</span><span class='lparen'>(</span>
|
|
1912
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
1913
|
+
<span class='rparen'>)</span>
|
|
1914
|
+
<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>
|
|
1915
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1916
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1917
|
+
<span class='rbrace'>}</span>
|
|
1918
|
+
<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
1919
|
<span class='kw'>end</span></pre>
|
|
1793
1920
|
</td>
|
|
1794
1921
|
</tr>
|
|
@@ -1798,7 +1925,7 @@
|
|
|
1798
1925
|
<div class="method_details ">
|
|
1799
1926
|
<h3 class="signature " id="get-instance_method">
|
|
1800
1927
|
|
|
1801
|
-
#<strong>get</strong>(id:
|
|
1928
|
+
#<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
1929
|
|
|
1803
1930
|
|
|
1804
1931
|
|
|
@@ -1826,7 +1953,7 @@
|
|
|
1826
1953
|
<span class='type'>(<tt>string</tt>)</span>
|
|
1827
1954
|
|
|
1828
1955
|
|
|
1829
|
-
<em class="default">(defaults to: <tt
|
|
1956
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1830
1957
|
|
|
1831
1958
|
|
|
1832
1959
|
—
|
|
@@ -1850,7 +1977,7 @@
|
|
|
1850
1977
|
|
|
1851
1978
|
—
|
|
1852
1979
|
<div class='inline'>
|
|
1853
|
-
<p>result from
|
|
1980
|
+
<p>result from the API request</p>
|
|
1854
1981
|
</div>
|
|
1855
1982
|
|
|
1856
1983
|
</li>
|
|
@@ -1863,17 +1990,31 @@
|
|
|
1863
1990
|
<pre class="lines">
|
|
1864
1991
|
|
|
1865
1992
|
|
|
1866
|
-
|
|
1867
|
-
|
|
1868
|
-
|
|
1869
|
-
|
|
1993
|
+
106
|
|
1994
|
+
107
|
|
1995
|
+
108
|
|
1996
|
+
109
|
|
1997
|
+
110
|
|
1998
|
+
111
|
|
1999
|
+
112
|
|
2000
|
+
113
|
|
2001
|
+
114
|
|
2002
|
+
115
|
|
2003
|
+
116</pre>
|
|
1870
2004
|
</td>
|
|
1871
2005
|
<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
|
|
1875
|
-
<span class='
|
|
1876
|
-
|
|
2006
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 106</span>
|
|
2007
|
+
|
|
2008
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span>
|
|
2009
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
2010
|
+
<span class='rparen'>)</span>
|
|
2011
|
+
<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>
|
|
2012
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
2013
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
2014
|
+
<span class='rbrace'>}</span>
|
|
2015
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
2016
|
+
<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>
|
|
2017
|
+
<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
2018
|
<span class='kw'>end</span></pre>
|
|
1878
2019
|
</td>
|
|
1879
2020
|
</tr>
|
|
@@ -1883,7 +2024,7 @@
|
|
|
1883
2024
|
<div class="method_details ">
|
|
1884
2025
|
<h3 class="signature " id="get!-instance_method">
|
|
1885
2026
|
|
|
1886
|
-
#<strong>get!</strong>(id:
|
|
2027
|
+
#<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
2028
|
|
|
1888
2029
|
|
|
1889
2030
|
|
|
@@ -1892,7 +2033,7 @@
|
|
|
1892
2033
|
</h3><div class="docstring">
|
|
1893
2034
|
<div class="discussion">
|
|
1894
2035
|
|
|
1895
|
-
<p>Get the details of a reserved domain.
|
|
2036
|
+
<p>Get the details of a reserved domain. Throws an exception if API error.</p>
|
|
1896
2037
|
|
|
1897
2038
|
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-get">ngrok.com/docs/api#api-reserved-domains-get</a></p>
|
|
1898
2039
|
|
|
@@ -1911,7 +2052,7 @@
|
|
|
1911
2052
|
<span class='type'>(<tt>string</tt>)</span>
|
|
1912
2053
|
|
|
1913
2054
|
|
|
1914
|
-
<em class="default">(defaults to: <tt
|
|
2055
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1915
2056
|
|
|
1916
2057
|
|
|
1917
2058
|
—
|
|
@@ -1935,7 +2076,7 @@
|
|
|
1935
2076
|
|
|
1936
2077
|
—
|
|
1937
2078
|
<div class='inline'>
|
|
1938
|
-
<p>result from
|
|
2079
|
+
<p>result from the API request</p>
|
|
1939
2080
|
</div>
|
|
1940
2081
|
|
|
1941
2082
|
</li>
|
|
@@ -1948,17 +2089,31 @@
|
|
|
1948
2089
|
<pre class="lines">
|
|
1949
2090
|
|
|
1950
2091
|
|
|
1951
|
-
|
|
1952
|
-
|
|
1953
|
-
|
|
1954
|
-
|
|
2092
|
+
126
|
|
2093
|
+
127
|
|
2094
|
+
128
|
|
2095
|
+
129
|
|
2096
|
+
130
|
|
2097
|
+
131
|
|
2098
|
+
132
|
|
2099
|
+
133
|
|
2100
|
+
134
|
|
2101
|
+
135
|
|
2102
|
+
136</pre>
|
|
1955
2103
|
</td>
|
|
1956
2104
|
<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
|
|
1960
|
-
<span class='
|
|
1961
|
-
|
|
2105
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 126</span>
|
|
2106
|
+
|
|
2107
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span>
|
|
2108
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
2109
|
+
<span class='rparen'>)</span>
|
|
2110
|
+
<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>
|
|
2111
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
2112
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
2113
|
+
<span class='rbrace'>}</span>
|
|
2114
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
2115
|
+
<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>
|
|
2116
|
+
<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
2117
|
<span class='kw'>end</span></pre>
|
|
1963
2118
|
</td>
|
|
1964
2119
|
</tr>
|
|
@@ -2006,7 +2161,7 @@
|
|
|
2006
2161
|
<span class='name'>limit</span>
|
|
2007
2162
|
|
|
2008
2163
|
|
|
2009
|
-
<span class='type'>(<tt>
|
|
2164
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
2010
2165
|
|
|
2011
2166
|
|
|
2012
2167
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -2046,7 +2201,7 @@
|
|
|
2046
2201
|
|
|
2047
2202
|
—
|
|
2048
2203
|
<div class='inline'>
|
|
2049
|
-
<p>result from
|
|
2204
|
+
<p>result from the API request</p>
|
|
2050
2205
|
</div>
|
|
2051
2206
|
|
|
2052
2207
|
</li>
|
|
@@ -2059,27 +2214,45 @@
|
|
|
2059
2214
|
<pre class="lines">
|
|
2060
2215
|
|
|
2061
2216
|
|
|
2062
|
-
|
|
2063
|
-
|
|
2064
|
-
|
|
2065
|
-
|
|
2066
|
-
|
|
2067
|
-
|
|
2068
|
-
|
|
2069
|
-
|
|
2070
|
-
|
|
2217
|
+
147
|
|
2218
|
+
148
|
|
2219
|
+
149
|
|
2220
|
+
150
|
|
2221
|
+
151
|
|
2222
|
+
152
|
|
2223
|
+
153
|
|
2224
|
+
154
|
|
2225
|
+
155
|
|
2226
|
+
156
|
|
2227
|
+
157
|
|
2228
|
+
158
|
|
2229
|
+
159
|
|
2230
|
+
160
|
|
2231
|
+
161
|
|
2232
|
+
162
|
|
2233
|
+
163
|
|
2234
|
+
164</pre>
|
|
2071
2235
|
</td>
|
|
2072
2236
|
<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</span><span class='lparen'>(</span
|
|
2076
|
-
<span class='
|
|
2077
|
-
<span class='
|
|
2078
|
-
|
|
2079
|
-
|
|
2080
|
-
|
|
2081
|
-
<span class='label'>
|
|
2082
|
-
|
|
2237
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 147</span>
|
|
2238
|
+
|
|
2239
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
|
2240
|
+
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2241
|
+
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2242
|
+
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
2243
|
+
<span class='rparen'>)</span>
|
|
2244
|
+
<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>
|
|
2245
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
2246
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
2247
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
2248
|
+
<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>
|
|
2249
|
+
<span class='rparen'>)</span>
|
|
2250
|
+
<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>
|
|
2251
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
2252
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
2253
|
+
<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>
|
|
2254
|
+
<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>
|
|
2255
|
+
<span class='rparen'>)</span>
|
|
2083
2256
|
<span class='kw'>end</span></pre>
|
|
2084
2257
|
</td>
|
|
2085
2258
|
</tr>
|
|
@@ -2089,7 +2262,7 @@
|
|
|
2089
2262
|
<div class="method_details ">
|
|
2090
2263
|
<h3 class="signature " id="update-instance_method">
|
|
2091
2264
|
|
|
2092
|
-
#<strong>update</strong>(id:
|
|
2265
|
+
#<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
2266
|
|
|
2094
2267
|
|
|
2095
2268
|
|
|
@@ -2117,7 +2290,7 @@
|
|
|
2117
2290
|
<span class='type'>(<tt>string</tt>)</span>
|
|
2118
2291
|
|
|
2119
2292
|
|
|
2120
|
-
<em class="default">(defaults to: <tt
|
|
2293
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
2121
2294
|
|
|
2122
2295
|
|
|
2123
2296
|
</li>
|
|
@@ -2217,7 +2390,7 @@
|
|
|
2217
2390
|
<span class='name'>certificate_management_policy</span>
|
|
2218
2391
|
|
|
2219
2392
|
|
|
2220
|
-
<span class='type'>(<tt>
|
|
2393
|
+
<span class='type'>(<tt>ReservedDomainCertPolicy</tt>)</span>
|
|
2221
2394
|
|
|
2222
2395
|
|
|
2223
2396
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -2244,7 +2417,7 @@
|
|
|
2244
2417
|
|
|
2245
2418
|
—
|
|
2246
2419
|
<div class='inline'>
|
|
2247
|
-
<p>result from
|
|
2420
|
+
<p>result from the API request</p>
|
|
2248
2421
|
</div>
|
|
2249
2422
|
|
|
2250
2423
|
</li>
|
|
@@ -2257,49 +2430,55 @@
|
|
|
2257
2430
|
<pre class="lines">
|
|
2258
2431
|
|
|
2259
2432
|
|
|
2260
|
-
|
|
2261
|
-
|
|
2262
|
-
|
|
2263
|
-
|
|
2264
|
-
|
|
2265
|
-
|
|
2266
|
-
|
|
2267
|
-
|
|
2268
|
-
|
|
2269
|
-
|
|
2270
|
-
|
|
2271
|
-
|
|
2272
|
-
|
|
2273
|
-
|
|
2274
|
-
|
|
2275
|
-
|
|
2276
|
-
|
|
2277
|
-
|
|
2278
|
-
|
|
2279
|
-
|
|
2433
|
+
179
|
|
2434
|
+
180
|
|
2435
|
+
181
|
|
2436
|
+
182
|
|
2437
|
+
183
|
|
2438
|
+
184
|
|
2439
|
+
185
|
|
2440
|
+
186
|
|
2441
|
+
187
|
|
2442
|
+
188
|
|
2443
|
+
189
|
|
2444
|
+
190
|
|
2445
|
+
191
|
|
2446
|
+
192
|
|
2447
|
+
193
|
|
2448
|
+
194
|
|
2449
|
+
195
|
|
2450
|
+
196
|
|
2451
|
+
197
|
|
2452
|
+
198
|
|
2453
|
+
199
|
|
2454
|
+
200
|
|
2455
|
+
201</pre>
|
|
2280
2456
|
</td>
|
|
2281
2457
|
<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='label'>id:</span> <span class='
|
|
2286
|
-
<span class='label'>
|
|
2287
|
-
<span class='label'>
|
|
2288
|
-
<span class='label'>
|
|
2289
|
-
<span class='label'>
|
|
2290
|
-
<span class='label'>
|
|
2291
|
-
<span class='label'>
|
|
2292
|
-
<span class='rparen'>)</span>
|
|
2293
|
-
<span class='id identifier
|
|
2294
|
-
|
|
2295
|
-
<span class='label'>
|
|
2296
|
-
|
|
2297
|
-
|
|
2298
|
-
|
|
2299
|
-
|
|
2300
|
-
<span class='
|
|
2301
|
-
<span class='id identifier
|
|
2302
|
-
<span class='
|
|
2458
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 179</span>
|
|
2459
|
+
|
|
2460
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
|
|
2461
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
2462
|
+
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2463
|
+
<span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2464
|
+
<span class='label'>http_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2465
|
+
<span class='label'>https_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2466
|
+
<span class='label'>certificate_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2467
|
+
<span class='label'>certificate_management_policy:</span> <span class='kw'>nil</span>
|
|
2468
|
+
<span class='rparen'>)</span>
|
|
2469
|
+
<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>
|
|
2470
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
2471
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
2472
|
+
<span class='rbrace'>}</span>
|
|
2473
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
2474
|
+
<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>
|
|
2475
|
+
<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>
|
|
2476
|
+
<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>
|
|
2477
|
+
<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>
|
|
2478
|
+
<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>
|
|
2479
|
+
<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>
|
|
2480
|
+
<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>
|
|
2481
|
+
<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
2482
|
<span class='kw'>end</span></pre>
|
|
2304
2483
|
</td>
|
|
2305
2484
|
</tr>
|
|
@@ -2309,7 +2488,7 @@
|
|
|
2309
2488
|
<div class="method_details ">
|
|
2310
2489
|
<h3 class="signature " id="update!-instance_method">
|
|
2311
2490
|
|
|
2312
|
-
#<strong>update!</strong>(id:
|
|
2491
|
+
#<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
2492
|
|
|
2314
2493
|
|
|
2315
2494
|
|
|
@@ -2318,7 +2497,7 @@
|
|
|
2318
2497
|
</h3><div class="docstring">
|
|
2319
2498
|
<div class="discussion">
|
|
2320
2499
|
|
|
2321
|
-
<p>Update the attributes of a reserved domain.
|
|
2500
|
+
<p>Update the attributes of a reserved domain. Throws an exception if API error.</p>
|
|
2322
2501
|
|
|
2323
2502
|
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-update">ngrok.com/docs/api#api-reserved-domains-update</a></p>
|
|
2324
2503
|
|
|
@@ -2337,7 +2516,7 @@
|
|
|
2337
2516
|
<span class='type'>(<tt>string</tt>)</span>
|
|
2338
2517
|
|
|
2339
2518
|
|
|
2340
|
-
<em class="default">(defaults to: <tt
|
|
2519
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
2341
2520
|
|
|
2342
2521
|
|
|
2343
2522
|
</li>
|
|
@@ -2437,7 +2616,7 @@
|
|
|
2437
2616
|
<span class='name'>certificate_management_policy</span>
|
|
2438
2617
|
|
|
2439
2618
|
|
|
2440
|
-
<span class='type'>(<tt>
|
|
2619
|
+
<span class='type'>(<tt>ReservedDomainCertPolicy</tt>)</span>
|
|
2441
2620
|
|
|
2442
2621
|
|
|
2443
2622
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -2464,7 +2643,7 @@
|
|
|
2464
2643
|
|
|
2465
2644
|
—
|
|
2466
2645
|
<div class='inline'>
|
|
2467
|
-
<p>result from
|
|
2646
|
+
<p>result from the API request</p>
|
|
2468
2647
|
</div>
|
|
2469
2648
|
|
|
2470
2649
|
</li>
|
|
@@ -2477,49 +2656,55 @@
|
|
|
2477
2656
|
<pre class="lines">
|
|
2478
2657
|
|
|
2479
2658
|
|
|
2480
|
-
|
|
2481
|
-
|
|
2482
|
-
|
|
2483
|
-
|
|
2484
|
-
|
|
2485
|
-
|
|
2486
|
-
|
|
2487
|
-
|
|
2488
|
-
|
|
2489
|
-
|
|
2490
|
-
|
|
2491
|
-
|
|
2492
|
-
|
|
2493
|
-
|
|
2494
|
-
|
|
2495
|
-
|
|
2496
|
-
|
|
2497
|
-
|
|
2498
|
-
|
|
2499
|
-
|
|
2659
|
+
217
|
|
2660
|
+
218
|
|
2661
|
+
219
|
|
2662
|
+
220
|
|
2663
|
+
221
|
|
2664
|
+
222
|
|
2665
|
+
223
|
|
2666
|
+
224
|
|
2667
|
+
225
|
|
2668
|
+
226
|
|
2669
|
+
227
|
|
2670
|
+
228
|
|
2671
|
+
229
|
|
2672
|
+
230
|
|
2673
|
+
231
|
|
2674
|
+
232
|
|
2675
|
+
233
|
|
2676
|
+
234
|
|
2677
|
+
235
|
|
2678
|
+
236
|
|
2679
|
+
237
|
|
2680
|
+
238
|
|
2681
|
+
239</pre>
|
|
2500
2682
|
</td>
|
|
2501
2683
|
<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='label'>id:</span> <span class='
|
|
2506
|
-
<span class='label'>
|
|
2507
|
-
<span class='label'>
|
|
2508
|
-
<span class='label'>
|
|
2509
|
-
<span class='label'>
|
|
2510
|
-
<span class='label'>
|
|
2511
|
-
<span class='label'>
|
|
2512
|
-
<span class='rparen'>)</span>
|
|
2513
|
-
<span class='id identifier
|
|
2514
|
-
|
|
2515
|
-
<span class='label'>
|
|
2516
|
-
|
|
2517
|
-
|
|
2518
|
-
|
|
2519
|
-
|
|
2520
|
-
<span class='
|
|
2521
|
-
<span class='id identifier
|
|
2522
|
-
<span class='
|
|
2684
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 217</span>
|
|
2685
|
+
|
|
2686
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
|
|
2687
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
2688
|
+
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2689
|
+
<span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2690
|
+
<span class='label'>http_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2691
|
+
<span class='label'>https_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2692
|
+
<span class='label'>certificate_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
2693
|
+
<span class='label'>certificate_management_policy:</span> <span class='kw'>nil</span>
|
|
2694
|
+
<span class='rparen'>)</span>
|
|
2695
|
+
<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>
|
|
2696
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
2697
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
2698
|
+
<span class='rbrace'>}</span>
|
|
2699
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
2700
|
+
<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>
|
|
2701
|
+
<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>
|
|
2702
|
+
<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>
|
|
2703
|
+
<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>
|
|
2704
|
+
<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>
|
|
2705
|
+
<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>
|
|
2706
|
+
<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>
|
|
2707
|
+
<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
2708
|
<span class='kw'>end</span></pre>
|
|
2524
2709
|
</td>
|
|
2525
2710
|
</tr>
|
|
@@ -2531,7 +2716,7 @@
|
|
|
2531
2716
|
</div>
|
|
2532
2717
|
|
|
2533
2718
|
<div id="footer">
|
|
2534
|
-
Generated on
|
|
2719
|
+
Generated on Mon Oct 4 23:24:18 2021 by
|
|
2535
2720
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
2536
2721
|
0.9.26 (ruby-3.0.1).
|
|
2537
2722
|
</div>
|