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
|
@@ -0,0 +1,1489 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: NgrokAPI::Services::CertificateAuthoritiesClient
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.26
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "NgrokAPI::Services::CertificateAuthoritiesClient";
|
|
19
|
+
relpath = '../../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../../_index.html">Index (C)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> » <span class='title'><span class='object_link'><a href="../Services.html" title="NgrokAPI::Services (module)">Services</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">CertificateAuthoritiesClient</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: NgrokAPI::Services::CertificateAuthoritiesClient
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">NgrokAPI::Services::CertificateAuthoritiesClient</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/ngrokapi/services/certificate_authorities_client.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>Certificate Authorities are x509 certificates that are used to sign other</p>
|
|
106
|
+
|
|
107
|
+
<pre class="code ruby"><code class="ruby">x509 certificates. Attach a Certificate Authority to the Mutual TLS module
|
|
108
|
+
to verify that the TLS certificate presented by a client has been signed by
|
|
109
|
+
this CA. Certificate Authorities are used only for mTLS validation only and
|
|
110
|
+
thus a private key is not included in the resource.
|
|
111
|
+
</code></pre>
|
|
112
|
+
|
|
113
|
+
<p><a href="https://ngrok.com/docs/api#api-certificate-authorities">ngrok.com/docs/api#api-certificate-authorities</a></p>
|
|
114
|
+
|
|
115
|
+
|
|
116
|
+
</div>
|
|
117
|
+
</div>
|
|
118
|
+
<div class="tags">
|
|
119
|
+
|
|
120
|
+
|
|
121
|
+
</div>
|
|
122
|
+
|
|
123
|
+
<h2>
|
|
124
|
+
Constant Summary
|
|
125
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
126
|
+
</h2>
|
|
127
|
+
|
|
128
|
+
<dl class="constants">
|
|
129
|
+
|
|
130
|
+
<dt id="PATH-constant" class="">PATH =
|
|
131
|
+
<div class="docstring">
|
|
132
|
+
<div class="discussion">
|
|
133
|
+
|
|
134
|
+
<p>The API path for the requests</p>
|
|
135
|
+
|
|
136
|
+
|
|
137
|
+
</div>
|
|
138
|
+
</div>
|
|
139
|
+
<div class="tags">
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
</div>
|
|
143
|
+
</dt>
|
|
144
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/certificate_authorities</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
145
|
+
|
|
146
|
+
<dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
|
|
147
|
+
<div class="docstring">
|
|
148
|
+
<div class="discussion">
|
|
149
|
+
|
|
150
|
+
<p>The List Property from the resulting API for list calls</p>
|
|
151
|
+
|
|
152
|
+
|
|
153
|
+
</div>
|
|
154
|
+
</div>
|
|
155
|
+
<div class="tags">
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
</div>
|
|
159
|
+
</dt>
|
|
160
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>certificate_authorities</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
161
|
+
|
|
162
|
+
</dl>
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
|
|
168
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
169
|
+
<ul class="summary">
|
|
170
|
+
|
|
171
|
+
<li class="public ">
|
|
172
|
+
<span class="summary_signature">
|
|
173
|
+
|
|
174
|
+
<a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> ⇒ Object </a>
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
</span>
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
<span class="note title readonly">readonly</span>
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
|
|
193
|
+
<span class="summary_desc"><div class='inline'>
|
|
194
|
+
<p>Returns the value of attribute client.</p>
|
|
195
|
+
</div></span>
|
|
196
|
+
|
|
197
|
+
</li>
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
</ul>
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
|
|
206
|
+
<h2>
|
|
207
|
+
Instance Method Summary
|
|
208
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
209
|
+
</h2>
|
|
210
|
+
|
|
211
|
+
<ul class="summary">
|
|
212
|
+
|
|
213
|
+
<li class="public ">
|
|
214
|
+
<span class="summary_signature">
|
|
215
|
+
|
|
216
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: "", metadata: "", ca_pem:) ⇒ NgrokAPI::Models::CertificateAuthority </a>
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
</span>
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
|
|
230
|
+
<span class="summary_desc"><div class='inline'>
|
|
231
|
+
<p>Upload a new Certificate Authority.</p>
|
|
232
|
+
</div></span>
|
|
233
|
+
|
|
234
|
+
</li>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
<li class="public ">
|
|
238
|
+
<span class="summary_signature">
|
|
239
|
+
|
|
240
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
</span>
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
|
|
254
|
+
<span class="summary_desc"><div class='inline'>
|
|
255
|
+
<p>Delete a Certificate Authority.</p>
|
|
256
|
+
</div></span>
|
|
257
|
+
|
|
258
|
+
</li>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
<li class="public ">
|
|
262
|
+
<span class="summary_signature">
|
|
263
|
+
|
|
264
|
+
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
</span>
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
|
|
278
|
+
<span class="summary_desc"><div class='inline'>
|
|
279
|
+
<p>Delete a Certificate Authority Throws an exception if API error.</p>
|
|
280
|
+
</div></span>
|
|
281
|
+
|
|
282
|
+
</li>
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
<li class="public ">
|
|
286
|
+
<span class="summary_signature">
|
|
287
|
+
|
|
288
|
+
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: "") ⇒ NgrokAPI::Models::CertificateAuthority </a>
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
</span>
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
|
|
302
|
+
<span class="summary_desc"><div class='inline'>
|
|
303
|
+
<p>Get detailed information about a certficate authority.</p>
|
|
304
|
+
</div></span>
|
|
305
|
+
|
|
306
|
+
</li>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
<li class="public ">
|
|
310
|
+
<span class="summary_signature">
|
|
311
|
+
|
|
312
|
+
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: "") ⇒ NgrokAPI::Models::CertificateAuthority </a>
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
</span>
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
|
|
326
|
+
<span class="summary_desc"><div class='inline'>
|
|
327
|
+
<p>Get detailed information about a certficate authority Throws an exception if API error.</p>
|
|
328
|
+
</div></span>
|
|
329
|
+
|
|
330
|
+
</li>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
<li class="public ">
|
|
334
|
+
<span class="summary_signature">
|
|
335
|
+
|
|
336
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒ CertificateAuthoritiesClient </a>
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
</span>
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
<span class="note title constructor">constructor</span>
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
|
|
352
|
+
<span class="summary_desc"><div class='inline'>
|
|
353
|
+
<p>A new instance of CertificateAuthoritiesClient.</p>
|
|
354
|
+
</div></span>
|
|
355
|
+
|
|
356
|
+
</li>
|
|
357
|
+
|
|
358
|
+
|
|
359
|
+
<li class="public ">
|
|
360
|
+
<span class="summary_signature">
|
|
361
|
+
|
|
362
|
+
<a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
</span>
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
|
|
376
|
+
<span class="summary_desc"><div class='inline'>
|
|
377
|
+
<p>List all Certificate Authority on this account.</p>
|
|
378
|
+
</div></span>
|
|
379
|
+
|
|
380
|
+
</li>
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
<li class="public ">
|
|
384
|
+
<span class="summary_signature">
|
|
385
|
+
|
|
386
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::CertificateAuthority </a>
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
</span>
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
|
|
400
|
+
<span class="summary_desc"><div class='inline'>
|
|
401
|
+
<p>Update attributes of a Certificate Authority by ID.</p>
|
|
402
|
+
</div></span>
|
|
403
|
+
|
|
404
|
+
</li>
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
<li class="public ">
|
|
408
|
+
<span class="summary_signature">
|
|
409
|
+
|
|
410
|
+
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::CertificateAuthority </a>
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
</span>
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
|
|
424
|
+
<span class="summary_desc"><div class='inline'>
|
|
425
|
+
<p>Update attributes of a Certificate Authority by ID Throws an exception if API error.</p>
|
|
426
|
+
</div></span>
|
|
427
|
+
|
|
428
|
+
</li>
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
</ul>
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
<div id="constructor_details" class="method_details_list">
|
|
435
|
+
<h2>Constructor Details</h2>
|
|
436
|
+
|
|
437
|
+
<div class="method_details first">
|
|
438
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
439
|
+
|
|
440
|
+
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::CertificateAuthoritiesClient (class)">CertificateAuthoritiesClient</a></span></tt>
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
|
|
446
|
+
</h3><div class="docstring">
|
|
447
|
+
<div class="discussion">
|
|
448
|
+
|
|
449
|
+
<p>Returns a new instance of CertificateAuthoritiesClient.</p>
|
|
450
|
+
|
|
451
|
+
|
|
452
|
+
</div>
|
|
453
|
+
</div>
|
|
454
|
+
<div class="tags">
|
|
455
|
+
|
|
456
|
+
|
|
457
|
+
</div><table class="source_code">
|
|
458
|
+
<tr>
|
|
459
|
+
<td>
|
|
460
|
+
<pre class="lines">
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
21
|
|
464
|
+
22
|
|
465
|
+
23</pre>
|
|
466
|
+
</td>
|
|
467
|
+
<td>
|
|
468
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 21</span>
|
|
469
|
+
|
|
470
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='rparen'>)</span>
|
|
471
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
472
|
+
<span class='kw'>end</span></pre>
|
|
473
|
+
</td>
|
|
474
|
+
</tr>
|
|
475
|
+
</table>
|
|
476
|
+
</div>
|
|
477
|
+
|
|
478
|
+
</div>
|
|
479
|
+
|
|
480
|
+
<div id="instance_attr_details" class="attr_details">
|
|
481
|
+
<h2>Instance Attribute Details</h2>
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
<span id=""></span>
|
|
485
|
+
<div class="method_details first">
|
|
486
|
+
<h3 class="signature first" id="client-instance_method">
|
|
487
|
+
|
|
488
|
+
#<strong>client</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
|
|
494
|
+
</h3><div class="docstring">
|
|
495
|
+
<div class="discussion">
|
|
496
|
+
|
|
497
|
+
<p>Returns the value of attribute client.</p>
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
</div>
|
|
501
|
+
</div>
|
|
502
|
+
<div class="tags">
|
|
503
|
+
|
|
504
|
+
|
|
505
|
+
</div><table class="source_code">
|
|
506
|
+
<tr>
|
|
507
|
+
<td>
|
|
508
|
+
<pre class="lines">
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
19
|
|
512
|
+
20
|
|
513
|
+
21</pre>
|
|
514
|
+
</td>
|
|
515
|
+
<td>
|
|
516
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 19</span>
|
|
517
|
+
|
|
518
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
|
519
|
+
<span class='ivar'>@client</span>
|
|
520
|
+
<span class='kw'>end</span></pre>
|
|
521
|
+
</td>
|
|
522
|
+
</tr>
|
|
523
|
+
</table>
|
|
524
|
+
</div>
|
|
525
|
+
|
|
526
|
+
</div>
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
<div id="instance_method_details" class="method_details_list">
|
|
530
|
+
<h2>Instance Method Details</h2>
|
|
531
|
+
|
|
532
|
+
|
|
533
|
+
<div class="method_details first">
|
|
534
|
+
<h3 class="signature first" id="create-instance_method">
|
|
535
|
+
|
|
536
|
+
#<strong>create</strong>(description: "", metadata: "", ca_pem:) ⇒ <tt><span class='object_link'><a href="../Models/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">NgrokAPI::Models::CertificateAuthority</a></span></tt>
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
|
|
542
|
+
</h3><div class="docstring">
|
|
543
|
+
<div class="discussion">
|
|
544
|
+
|
|
545
|
+
<p>Upload a new Certificate Authority</p>
|
|
546
|
+
|
|
547
|
+
<p><a href="https://ngrok.com/docs/api#api-certificate-authorities-create">ngrok.com/docs/api#api-certificate-authorities-create</a></p>
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
</div>
|
|
551
|
+
</div>
|
|
552
|
+
<div class="tags">
|
|
553
|
+
<p class="tag_title">Parameters:</p>
|
|
554
|
+
<ul class="param">
|
|
555
|
+
|
|
556
|
+
<li>
|
|
557
|
+
|
|
558
|
+
<span class='name'>description</span>
|
|
559
|
+
|
|
560
|
+
|
|
561
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
562
|
+
|
|
563
|
+
|
|
564
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
565
|
+
|
|
566
|
+
|
|
567
|
+
—
|
|
568
|
+
<div class='inline'>
|
|
569
|
+
<p>human-readable description of this Certificate Authority. optional, max 255 bytes.</p>
|
|
570
|
+
</div>
|
|
571
|
+
|
|
572
|
+
</li>
|
|
573
|
+
|
|
574
|
+
<li>
|
|
575
|
+
|
|
576
|
+
<span class='name'>metadata</span>
|
|
577
|
+
|
|
578
|
+
|
|
579
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
580
|
+
|
|
581
|
+
|
|
582
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
583
|
+
|
|
584
|
+
|
|
585
|
+
—
|
|
586
|
+
<div class='inline'>
|
|
587
|
+
<p>arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.</p>
|
|
588
|
+
</div>
|
|
589
|
+
|
|
590
|
+
</li>
|
|
591
|
+
|
|
592
|
+
<li>
|
|
593
|
+
|
|
594
|
+
<span class='name'>ca_pem</span>
|
|
595
|
+
|
|
596
|
+
|
|
597
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
—
|
|
602
|
+
<div class='inline'>
|
|
603
|
+
<p>raw PEM of the Certificate Authority</p>
|
|
604
|
+
</div>
|
|
605
|
+
|
|
606
|
+
</li>
|
|
607
|
+
|
|
608
|
+
</ul>
|
|
609
|
+
|
|
610
|
+
<p class="tag_title">Returns:</p>
|
|
611
|
+
<ul class="return">
|
|
612
|
+
|
|
613
|
+
<li>
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">NgrokAPI::Models::CertificateAuthority</a></span></tt>)</span>
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
|
|
620
|
+
—
|
|
621
|
+
<div class='inline'>
|
|
622
|
+
<p>result from the API request</p>
|
|
623
|
+
</div>
|
|
624
|
+
|
|
625
|
+
</li>
|
|
626
|
+
|
|
627
|
+
</ul>
|
|
628
|
+
|
|
629
|
+
</div><table class="source_code">
|
|
630
|
+
<tr>
|
|
631
|
+
<td>
|
|
632
|
+
<pre class="lines">
|
|
633
|
+
|
|
634
|
+
|
|
635
|
+
34
|
|
636
|
+
35
|
|
637
|
+
36
|
|
638
|
+
37
|
|
639
|
+
38
|
|
640
|
+
39
|
|
641
|
+
40
|
|
642
|
+
41
|
|
643
|
+
42
|
|
644
|
+
43
|
|
645
|
+
44
|
|
646
|
+
45
|
|
647
|
+
46
|
|
648
|
+
47
|
|
649
|
+
48</pre>
|
|
650
|
+
</td>
|
|
651
|
+
<td>
|
|
652
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 34</span>
|
|
653
|
+
|
|
654
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span>
|
|
655
|
+
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
656
|
+
<span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
657
|
+
<span class='label'>ca_pem:</span>
|
|
658
|
+
<span class='rparen'>)</span>
|
|
659
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/certificate_authorities</span><span class='tstring_end'>'</span></span>
|
|
660
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
661
|
+
<span class='rbrace'>}</span>
|
|
662
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
663
|
+
<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>
|
|
664
|
+
<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>
|
|
665
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ca_pem</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ca_pem'>ca_pem</span> <span class='kw'>if</span> <span class='id identifier rubyid_ca_pem'>ca_pem</span>
|
|
666
|
+
<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>
|
|
667
|
+
<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/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">CertificateAuthority</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/CertificateAuthority.html#initialize-instance_method" title="NgrokAPI::Models::CertificateAuthority#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>
|
|
668
|
+
<span class='kw'>end</span></pre>
|
|
669
|
+
</td>
|
|
670
|
+
</tr>
|
|
671
|
+
</table>
|
|
672
|
+
</div>
|
|
673
|
+
|
|
674
|
+
<div class="method_details ">
|
|
675
|
+
<h3 class="signature " id="delete-instance_method">
|
|
676
|
+
|
|
677
|
+
#<strong>delete</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
|
|
683
|
+
</h3><div class="docstring">
|
|
684
|
+
<div class="discussion">
|
|
685
|
+
|
|
686
|
+
<p>Delete a Certificate Authority</p>
|
|
687
|
+
|
|
688
|
+
<p><a href="https://ngrok.com/docs/api#api-certificate-authorities-delete">ngrok.com/docs/api#api-certificate-authorities-delete</a></p>
|
|
689
|
+
|
|
690
|
+
|
|
691
|
+
</div>
|
|
692
|
+
</div>
|
|
693
|
+
<div class="tags">
|
|
694
|
+
<p class="tag_title">Parameters:</p>
|
|
695
|
+
<ul class="param">
|
|
696
|
+
|
|
697
|
+
<li>
|
|
698
|
+
|
|
699
|
+
<span class='name'>id</span>
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
706
|
+
|
|
707
|
+
|
|
708
|
+
—
|
|
709
|
+
<div class='inline'>
|
|
710
|
+
<p>a resource identifier</p>
|
|
711
|
+
</div>
|
|
712
|
+
|
|
713
|
+
</li>
|
|
714
|
+
|
|
715
|
+
</ul>
|
|
716
|
+
|
|
717
|
+
<p class="tag_title">Returns:</p>
|
|
718
|
+
<ul class="return">
|
|
719
|
+
|
|
720
|
+
<li>
|
|
721
|
+
|
|
722
|
+
|
|
723
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
724
|
+
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
—
|
|
728
|
+
<div class='inline'>
|
|
729
|
+
<p>result from the API request</p>
|
|
730
|
+
</div>
|
|
731
|
+
|
|
732
|
+
</li>
|
|
733
|
+
|
|
734
|
+
</ul>
|
|
735
|
+
|
|
736
|
+
</div><table class="source_code">
|
|
737
|
+
<tr>
|
|
738
|
+
<td>
|
|
739
|
+
<pre class="lines">
|
|
740
|
+
|
|
741
|
+
|
|
742
|
+
57
|
|
743
|
+
58
|
|
744
|
+
59
|
|
745
|
+
60
|
|
746
|
+
61
|
|
747
|
+
62
|
|
748
|
+
63
|
|
749
|
+
64
|
|
750
|
+
65</pre>
|
|
751
|
+
</td>
|
|
752
|
+
<td>
|
|
753
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 57</span>
|
|
754
|
+
|
|
755
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span>
|
|
756
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
757
|
+
<span class='rparen'>)</span>
|
|
758
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/certificate_authorities/%{id}</span><span class='tstring_end'>'</span></span>
|
|
759
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
760
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
761
|
+
<span class='rbrace'>}</span>
|
|
762
|
+
<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>
|
|
763
|
+
<span class='kw'>end</span></pre>
|
|
764
|
+
</td>
|
|
765
|
+
</tr>
|
|
766
|
+
</table>
|
|
767
|
+
</div>
|
|
768
|
+
|
|
769
|
+
<div class="method_details ">
|
|
770
|
+
<h3 class="signature " id="delete!-instance_method">
|
|
771
|
+
|
|
772
|
+
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
|
|
777
|
+
|
|
778
|
+
</h3><div class="docstring">
|
|
779
|
+
<div class="discussion">
|
|
780
|
+
|
|
781
|
+
<p>Delete a Certificate Authority Throws an exception if API error.</p>
|
|
782
|
+
|
|
783
|
+
<p><a href="https://ngrok.com/docs/api#api-certificate-authorities-delete">ngrok.com/docs/api#api-certificate-authorities-delete</a></p>
|
|
784
|
+
|
|
785
|
+
|
|
786
|
+
</div>
|
|
787
|
+
</div>
|
|
788
|
+
<div class="tags">
|
|
789
|
+
<p class="tag_title">Parameters:</p>
|
|
790
|
+
<ul class="param">
|
|
791
|
+
|
|
792
|
+
<li>
|
|
793
|
+
|
|
794
|
+
<span class='name'>id</span>
|
|
795
|
+
|
|
796
|
+
|
|
797
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
798
|
+
|
|
799
|
+
|
|
800
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
—
|
|
804
|
+
<div class='inline'>
|
|
805
|
+
<p>a resource identifier</p>
|
|
806
|
+
</div>
|
|
807
|
+
|
|
808
|
+
</li>
|
|
809
|
+
|
|
810
|
+
</ul>
|
|
811
|
+
|
|
812
|
+
<p class="tag_title">Returns:</p>
|
|
813
|
+
<ul class="return">
|
|
814
|
+
|
|
815
|
+
<li>
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
819
|
+
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
—
|
|
823
|
+
<div class='inline'>
|
|
824
|
+
<p>result from the API request</p>
|
|
825
|
+
</div>
|
|
826
|
+
|
|
827
|
+
</li>
|
|
828
|
+
|
|
829
|
+
</ul>
|
|
830
|
+
|
|
831
|
+
</div><table class="source_code">
|
|
832
|
+
<tr>
|
|
833
|
+
<td>
|
|
834
|
+
<pre class="lines">
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
75
|
|
838
|
+
76
|
|
839
|
+
77
|
|
840
|
+
78
|
|
841
|
+
79
|
|
842
|
+
80
|
|
843
|
+
81
|
|
844
|
+
82
|
|
845
|
+
83</pre>
|
|
846
|
+
</td>
|
|
847
|
+
<td>
|
|
848
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 75</span>
|
|
849
|
+
|
|
850
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span>
|
|
851
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
852
|
+
<span class='rparen'>)</span>
|
|
853
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/certificate_authorities/%{id}</span><span class='tstring_end'>'</span></span>
|
|
854
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
855
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
856
|
+
<span class='rbrace'>}</span>
|
|
857
|
+
<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>
|
|
858
|
+
<span class='kw'>end</span></pre>
|
|
859
|
+
</td>
|
|
860
|
+
</tr>
|
|
861
|
+
</table>
|
|
862
|
+
</div>
|
|
863
|
+
|
|
864
|
+
<div class="method_details ">
|
|
865
|
+
<h3 class="signature " id="get-instance_method">
|
|
866
|
+
|
|
867
|
+
#<strong>get</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">NgrokAPI::Models::CertificateAuthority</a></span></tt>
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
|
|
873
|
+
</h3><div class="docstring">
|
|
874
|
+
<div class="discussion">
|
|
875
|
+
|
|
876
|
+
<p>Get detailed information about a certficate authority</p>
|
|
877
|
+
|
|
878
|
+
<p><a href="https://ngrok.com/docs/api#api-certificate-authorities-get">ngrok.com/docs/api#api-certificate-authorities-get</a></p>
|
|
879
|
+
|
|
880
|
+
|
|
881
|
+
</div>
|
|
882
|
+
</div>
|
|
883
|
+
<div class="tags">
|
|
884
|
+
<p class="tag_title">Parameters:</p>
|
|
885
|
+
<ul class="param">
|
|
886
|
+
|
|
887
|
+
<li>
|
|
888
|
+
|
|
889
|
+
<span class='name'>id</span>
|
|
890
|
+
|
|
891
|
+
|
|
892
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
893
|
+
|
|
894
|
+
|
|
895
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
896
|
+
|
|
897
|
+
|
|
898
|
+
—
|
|
899
|
+
<div class='inline'>
|
|
900
|
+
<p>a resource identifier</p>
|
|
901
|
+
</div>
|
|
902
|
+
|
|
903
|
+
</li>
|
|
904
|
+
|
|
905
|
+
</ul>
|
|
906
|
+
|
|
907
|
+
<p class="tag_title">Returns:</p>
|
|
908
|
+
<ul class="return">
|
|
909
|
+
|
|
910
|
+
<li>
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">NgrokAPI::Models::CertificateAuthority</a></span></tt>)</span>
|
|
914
|
+
|
|
915
|
+
|
|
916
|
+
|
|
917
|
+
—
|
|
918
|
+
<div class='inline'>
|
|
919
|
+
<p>result from the API request</p>
|
|
920
|
+
</div>
|
|
921
|
+
|
|
922
|
+
</li>
|
|
923
|
+
|
|
924
|
+
</ul>
|
|
925
|
+
|
|
926
|
+
</div><table class="source_code">
|
|
927
|
+
<tr>
|
|
928
|
+
<td>
|
|
929
|
+
<pre class="lines">
|
|
930
|
+
|
|
931
|
+
|
|
932
|
+
92
|
|
933
|
+
93
|
|
934
|
+
94
|
|
935
|
+
95
|
|
936
|
+
96
|
|
937
|
+
97
|
|
938
|
+
98
|
|
939
|
+
99
|
|
940
|
+
100
|
|
941
|
+
101
|
|
942
|
+
102</pre>
|
|
943
|
+
</td>
|
|
944
|
+
<td>
|
|
945
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 92</span>
|
|
946
|
+
|
|
947
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span>
|
|
948
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
949
|
+
<span class='rparen'>)</span>
|
|
950
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/certificate_authorities/%{id}</span><span class='tstring_end'>'</span></span>
|
|
951
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
952
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
953
|
+
<span class='rbrace'>}</span>
|
|
954
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
955
|
+
<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>
|
|
956
|
+
<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/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">CertificateAuthority</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/CertificateAuthority.html#initialize-instance_method" title="NgrokAPI::Models::CertificateAuthority#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>
|
|
957
|
+
<span class='kw'>end</span></pre>
|
|
958
|
+
</td>
|
|
959
|
+
</tr>
|
|
960
|
+
</table>
|
|
961
|
+
</div>
|
|
962
|
+
|
|
963
|
+
<div class="method_details ">
|
|
964
|
+
<h3 class="signature " id="get!-instance_method">
|
|
965
|
+
|
|
966
|
+
#<strong>get!</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">NgrokAPI::Models::CertificateAuthority</a></span></tt>
|
|
967
|
+
|
|
968
|
+
|
|
969
|
+
|
|
970
|
+
|
|
971
|
+
|
|
972
|
+
</h3><div class="docstring">
|
|
973
|
+
<div class="discussion">
|
|
974
|
+
|
|
975
|
+
<p>Get detailed information about a certficate authority Throws an exception if API error.</p>
|
|
976
|
+
|
|
977
|
+
<p><a href="https://ngrok.com/docs/api#api-certificate-authorities-get">ngrok.com/docs/api#api-certificate-authorities-get</a></p>
|
|
978
|
+
|
|
979
|
+
|
|
980
|
+
</div>
|
|
981
|
+
</div>
|
|
982
|
+
<div class="tags">
|
|
983
|
+
<p class="tag_title">Parameters:</p>
|
|
984
|
+
<ul class="param">
|
|
985
|
+
|
|
986
|
+
<li>
|
|
987
|
+
|
|
988
|
+
<span class='name'>id</span>
|
|
989
|
+
|
|
990
|
+
|
|
991
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
992
|
+
|
|
993
|
+
|
|
994
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
995
|
+
|
|
996
|
+
|
|
997
|
+
—
|
|
998
|
+
<div class='inline'>
|
|
999
|
+
<p>a resource identifier</p>
|
|
1000
|
+
</div>
|
|
1001
|
+
|
|
1002
|
+
</li>
|
|
1003
|
+
|
|
1004
|
+
</ul>
|
|
1005
|
+
|
|
1006
|
+
<p class="tag_title">Returns:</p>
|
|
1007
|
+
<ul class="return">
|
|
1008
|
+
|
|
1009
|
+
<li>
|
|
1010
|
+
|
|
1011
|
+
|
|
1012
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">NgrokAPI::Models::CertificateAuthority</a></span></tt>)</span>
|
|
1013
|
+
|
|
1014
|
+
|
|
1015
|
+
|
|
1016
|
+
—
|
|
1017
|
+
<div class='inline'>
|
|
1018
|
+
<p>result from the API request</p>
|
|
1019
|
+
</div>
|
|
1020
|
+
|
|
1021
|
+
</li>
|
|
1022
|
+
|
|
1023
|
+
</ul>
|
|
1024
|
+
|
|
1025
|
+
</div><table class="source_code">
|
|
1026
|
+
<tr>
|
|
1027
|
+
<td>
|
|
1028
|
+
<pre class="lines">
|
|
1029
|
+
|
|
1030
|
+
|
|
1031
|
+
112
|
|
1032
|
+
113
|
|
1033
|
+
114
|
|
1034
|
+
115
|
|
1035
|
+
116
|
|
1036
|
+
117
|
|
1037
|
+
118
|
|
1038
|
+
119
|
|
1039
|
+
120
|
|
1040
|
+
121
|
|
1041
|
+
122</pre>
|
|
1042
|
+
</td>
|
|
1043
|
+
<td>
|
|
1044
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 112</span>
|
|
1045
|
+
|
|
1046
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span>
|
|
1047
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
1048
|
+
<span class='rparen'>)</span>
|
|
1049
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/certificate_authorities/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1050
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1051
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1052
|
+
<span class='rbrace'>}</span>
|
|
1053
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1054
|
+
<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>
|
|
1055
|
+
<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/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">CertificateAuthority</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/CertificateAuthority.html#initialize-instance_method" title="NgrokAPI::Models::CertificateAuthority#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>
|
|
1056
|
+
<span class='kw'>end</span></pre>
|
|
1057
|
+
</td>
|
|
1058
|
+
</tr>
|
|
1059
|
+
</table>
|
|
1060
|
+
</div>
|
|
1061
|
+
|
|
1062
|
+
<div class="method_details ">
|
|
1063
|
+
<h3 class="signature " id="list-instance_method">
|
|
1064
|
+
|
|
1065
|
+
#<strong>list</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
|
|
1069
|
+
|
|
1070
|
+
|
|
1071
|
+
</h3><div class="docstring">
|
|
1072
|
+
<div class="discussion">
|
|
1073
|
+
|
|
1074
|
+
<p>List all Certificate Authority on this account</p>
|
|
1075
|
+
|
|
1076
|
+
<p><a href="https://ngrok.com/docs/api#api-certificate-authorities-list">ngrok.com/docs/api#api-certificate-authorities-list</a></p>
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
</div>
|
|
1080
|
+
</div>
|
|
1081
|
+
<div class="tags">
|
|
1082
|
+
<p class="tag_title">Parameters:</p>
|
|
1083
|
+
<ul class="param">
|
|
1084
|
+
|
|
1085
|
+
<li>
|
|
1086
|
+
|
|
1087
|
+
<span class='name'>before_id</span>
|
|
1088
|
+
|
|
1089
|
+
|
|
1090
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1091
|
+
|
|
1092
|
+
|
|
1093
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1094
|
+
|
|
1095
|
+
|
|
1096
|
+
</li>
|
|
1097
|
+
|
|
1098
|
+
<li>
|
|
1099
|
+
|
|
1100
|
+
<span class='name'>limit</span>
|
|
1101
|
+
|
|
1102
|
+
|
|
1103
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1104
|
+
|
|
1105
|
+
|
|
1106
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1107
|
+
|
|
1108
|
+
|
|
1109
|
+
</li>
|
|
1110
|
+
|
|
1111
|
+
<li>
|
|
1112
|
+
|
|
1113
|
+
<span class='name'>url</span>
|
|
1114
|
+
|
|
1115
|
+
|
|
1116
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1117
|
+
|
|
1118
|
+
|
|
1119
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
—
|
|
1123
|
+
<div class='inline'>
|
|
1124
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
1125
|
+
</div>
|
|
1126
|
+
|
|
1127
|
+
</li>
|
|
1128
|
+
|
|
1129
|
+
</ul>
|
|
1130
|
+
|
|
1131
|
+
<p class="tag_title">Returns:</p>
|
|
1132
|
+
<ul class="return">
|
|
1133
|
+
|
|
1134
|
+
<li>
|
|
1135
|
+
|
|
1136
|
+
|
|
1137
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
|
|
1138
|
+
|
|
1139
|
+
|
|
1140
|
+
|
|
1141
|
+
—
|
|
1142
|
+
<div class='inline'>
|
|
1143
|
+
<p>result from the API request</p>
|
|
1144
|
+
</div>
|
|
1145
|
+
|
|
1146
|
+
</li>
|
|
1147
|
+
|
|
1148
|
+
</ul>
|
|
1149
|
+
|
|
1150
|
+
</div><table class="source_code">
|
|
1151
|
+
<tr>
|
|
1152
|
+
<td>
|
|
1153
|
+
<pre class="lines">
|
|
1154
|
+
|
|
1155
|
+
|
|
1156
|
+
133
|
|
1157
|
+
134
|
|
1158
|
+
135
|
|
1159
|
+
136
|
|
1160
|
+
137
|
|
1161
|
+
138
|
|
1162
|
+
139
|
|
1163
|
+
140
|
|
1164
|
+
141
|
|
1165
|
+
142
|
|
1166
|
+
143
|
|
1167
|
+
144
|
|
1168
|
+
145
|
|
1169
|
+
146
|
|
1170
|
+
147
|
|
1171
|
+
148
|
|
1172
|
+
149
|
|
1173
|
+
150</pre>
|
|
1174
|
+
</td>
|
|
1175
|
+
<td>
|
|
1176
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 133</span>
|
|
1177
|
+
|
|
1178
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
|
1179
|
+
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1180
|
+
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1181
|
+
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1182
|
+
<span class='rparen'>)</span>
|
|
1183
|
+
<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>
|
|
1184
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1185
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1186
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1187
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::CertificateAuthoritiesClient::PATH (constant)">PATH</a></span></span>
|
|
1188
|
+
<span class='rparen'>)</span>
|
|
1189
|
+
<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>
|
|
1190
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1191
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1192
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::CertificateAuthoritiesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1193
|
+
<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/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">CertificateAuthority</a></span></span>
|
|
1194
|
+
<span class='rparen'>)</span>
|
|
1195
|
+
<span class='kw'>end</span></pre>
|
|
1196
|
+
</td>
|
|
1197
|
+
</tr>
|
|
1198
|
+
</table>
|
|
1199
|
+
</div>
|
|
1200
|
+
|
|
1201
|
+
<div class="method_details ">
|
|
1202
|
+
<h3 class="signature " id="update-instance_method">
|
|
1203
|
+
|
|
1204
|
+
#<strong>update</strong>(id: "", description: nil, metadata: nil) ⇒ <tt><span class='object_link'><a href="../Models/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">NgrokAPI::Models::CertificateAuthority</a></span></tt>
|
|
1205
|
+
|
|
1206
|
+
|
|
1207
|
+
|
|
1208
|
+
|
|
1209
|
+
|
|
1210
|
+
</h3><div class="docstring">
|
|
1211
|
+
<div class="discussion">
|
|
1212
|
+
|
|
1213
|
+
<p>Update attributes of a Certificate Authority by ID</p>
|
|
1214
|
+
|
|
1215
|
+
<p><a href="https://ngrok.com/docs/api#api-certificate-authorities-update">ngrok.com/docs/api#api-certificate-authorities-update</a></p>
|
|
1216
|
+
|
|
1217
|
+
|
|
1218
|
+
</div>
|
|
1219
|
+
</div>
|
|
1220
|
+
<div class="tags">
|
|
1221
|
+
<p class="tag_title">Parameters:</p>
|
|
1222
|
+
<ul class="param">
|
|
1223
|
+
|
|
1224
|
+
<li>
|
|
1225
|
+
|
|
1226
|
+
<span class='name'>id</span>
|
|
1227
|
+
|
|
1228
|
+
|
|
1229
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1230
|
+
|
|
1231
|
+
|
|
1232
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1233
|
+
|
|
1234
|
+
|
|
1235
|
+
</li>
|
|
1236
|
+
|
|
1237
|
+
<li>
|
|
1238
|
+
|
|
1239
|
+
<span class='name'>description</span>
|
|
1240
|
+
|
|
1241
|
+
|
|
1242
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1243
|
+
|
|
1244
|
+
|
|
1245
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1246
|
+
|
|
1247
|
+
|
|
1248
|
+
—
|
|
1249
|
+
<div class='inline'>
|
|
1250
|
+
<p>human-readable description of this Certificate Authority. optional, max 255 bytes.</p>
|
|
1251
|
+
</div>
|
|
1252
|
+
|
|
1253
|
+
</li>
|
|
1254
|
+
|
|
1255
|
+
<li>
|
|
1256
|
+
|
|
1257
|
+
<span class='name'>metadata</span>
|
|
1258
|
+
|
|
1259
|
+
|
|
1260
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1261
|
+
|
|
1262
|
+
|
|
1263
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1264
|
+
|
|
1265
|
+
|
|
1266
|
+
—
|
|
1267
|
+
<div class='inline'>
|
|
1268
|
+
<p>arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.</p>
|
|
1269
|
+
</div>
|
|
1270
|
+
|
|
1271
|
+
</li>
|
|
1272
|
+
|
|
1273
|
+
</ul>
|
|
1274
|
+
|
|
1275
|
+
<p class="tag_title">Returns:</p>
|
|
1276
|
+
<ul class="return">
|
|
1277
|
+
|
|
1278
|
+
<li>
|
|
1279
|
+
|
|
1280
|
+
|
|
1281
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">NgrokAPI::Models::CertificateAuthority</a></span></tt>)</span>
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
|
|
1285
|
+
—
|
|
1286
|
+
<div class='inline'>
|
|
1287
|
+
<p>result from the API request</p>
|
|
1288
|
+
</div>
|
|
1289
|
+
|
|
1290
|
+
</li>
|
|
1291
|
+
|
|
1292
|
+
</ul>
|
|
1293
|
+
|
|
1294
|
+
</div><table class="source_code">
|
|
1295
|
+
<tr>
|
|
1296
|
+
<td>
|
|
1297
|
+
<pre class="lines">
|
|
1298
|
+
|
|
1299
|
+
|
|
1300
|
+
161
|
|
1301
|
+
162
|
|
1302
|
+
163
|
|
1303
|
+
164
|
|
1304
|
+
165
|
|
1305
|
+
166
|
|
1306
|
+
167
|
|
1307
|
+
168
|
|
1308
|
+
169
|
|
1309
|
+
170
|
|
1310
|
+
171
|
|
1311
|
+
172
|
|
1312
|
+
173
|
|
1313
|
+
174
|
|
1314
|
+
175</pre>
|
|
1315
|
+
</td>
|
|
1316
|
+
<td>
|
|
1317
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 161</span>
|
|
1318
|
+
|
|
1319
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
|
|
1320
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
1321
|
+
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1322
|
+
<span class='label'>metadata:</span> <span class='kw'>nil</span>
|
|
1323
|
+
<span class='rparen'>)</span>
|
|
1324
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/certificate_authorities/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1325
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1326
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1327
|
+
<span class='rbrace'>}</span>
|
|
1328
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1329
|
+
<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>
|
|
1330
|
+
<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>
|
|
1331
|
+
<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>
|
|
1332
|
+
<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/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">CertificateAuthority</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/CertificateAuthority.html#initialize-instance_method" title="NgrokAPI::Models::CertificateAuthority#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>
|
|
1333
|
+
<span class='kw'>end</span></pre>
|
|
1334
|
+
</td>
|
|
1335
|
+
</tr>
|
|
1336
|
+
</table>
|
|
1337
|
+
</div>
|
|
1338
|
+
|
|
1339
|
+
<div class="method_details ">
|
|
1340
|
+
<h3 class="signature " id="update!-instance_method">
|
|
1341
|
+
|
|
1342
|
+
#<strong>update!</strong>(id: "", description: nil, metadata: nil) ⇒ <tt><span class='object_link'><a href="../Models/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">NgrokAPI::Models::CertificateAuthority</a></span></tt>
|
|
1343
|
+
|
|
1344
|
+
|
|
1345
|
+
|
|
1346
|
+
|
|
1347
|
+
|
|
1348
|
+
</h3><div class="docstring">
|
|
1349
|
+
<div class="discussion">
|
|
1350
|
+
|
|
1351
|
+
<p>Update attributes of a Certificate Authority by ID Throws an exception if API error.</p>
|
|
1352
|
+
|
|
1353
|
+
<p><a href="https://ngrok.com/docs/api#api-certificate-authorities-update">ngrok.com/docs/api#api-certificate-authorities-update</a></p>
|
|
1354
|
+
|
|
1355
|
+
|
|
1356
|
+
</div>
|
|
1357
|
+
</div>
|
|
1358
|
+
<div class="tags">
|
|
1359
|
+
<p class="tag_title">Parameters:</p>
|
|
1360
|
+
<ul class="param">
|
|
1361
|
+
|
|
1362
|
+
<li>
|
|
1363
|
+
|
|
1364
|
+
<span class='name'>id</span>
|
|
1365
|
+
|
|
1366
|
+
|
|
1367
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1368
|
+
|
|
1369
|
+
|
|
1370
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1371
|
+
|
|
1372
|
+
|
|
1373
|
+
</li>
|
|
1374
|
+
|
|
1375
|
+
<li>
|
|
1376
|
+
|
|
1377
|
+
<span class='name'>description</span>
|
|
1378
|
+
|
|
1379
|
+
|
|
1380
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1381
|
+
|
|
1382
|
+
|
|
1383
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1384
|
+
|
|
1385
|
+
|
|
1386
|
+
—
|
|
1387
|
+
<div class='inline'>
|
|
1388
|
+
<p>human-readable description of this Certificate Authority. optional, max 255 bytes.</p>
|
|
1389
|
+
</div>
|
|
1390
|
+
|
|
1391
|
+
</li>
|
|
1392
|
+
|
|
1393
|
+
<li>
|
|
1394
|
+
|
|
1395
|
+
<span class='name'>metadata</span>
|
|
1396
|
+
|
|
1397
|
+
|
|
1398
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1399
|
+
|
|
1400
|
+
|
|
1401
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1402
|
+
|
|
1403
|
+
|
|
1404
|
+
—
|
|
1405
|
+
<div class='inline'>
|
|
1406
|
+
<p>arbitrary user-defined machine-readable data of this Certificate Authority. optional, max 4096 bytes.</p>
|
|
1407
|
+
</div>
|
|
1408
|
+
|
|
1409
|
+
</li>
|
|
1410
|
+
|
|
1411
|
+
</ul>
|
|
1412
|
+
|
|
1413
|
+
<p class="tag_title">Returns:</p>
|
|
1414
|
+
<ul class="return">
|
|
1415
|
+
|
|
1416
|
+
<li>
|
|
1417
|
+
|
|
1418
|
+
|
|
1419
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">NgrokAPI::Models::CertificateAuthority</a></span></tt>)</span>
|
|
1420
|
+
|
|
1421
|
+
|
|
1422
|
+
|
|
1423
|
+
—
|
|
1424
|
+
<div class='inline'>
|
|
1425
|
+
<p>result from the API request</p>
|
|
1426
|
+
</div>
|
|
1427
|
+
|
|
1428
|
+
</li>
|
|
1429
|
+
|
|
1430
|
+
</ul>
|
|
1431
|
+
|
|
1432
|
+
</div><table class="source_code">
|
|
1433
|
+
<tr>
|
|
1434
|
+
<td>
|
|
1435
|
+
<pre class="lines">
|
|
1436
|
+
|
|
1437
|
+
|
|
1438
|
+
187
|
|
1439
|
+
188
|
|
1440
|
+
189
|
|
1441
|
+
190
|
|
1442
|
+
191
|
|
1443
|
+
192
|
|
1444
|
+
193
|
|
1445
|
+
194
|
|
1446
|
+
195
|
|
1447
|
+
196
|
|
1448
|
+
197
|
|
1449
|
+
198
|
|
1450
|
+
199
|
|
1451
|
+
200
|
|
1452
|
+
201</pre>
|
|
1453
|
+
</td>
|
|
1454
|
+
<td>
|
|
1455
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 187</span>
|
|
1456
|
+
|
|
1457
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
|
|
1458
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
1459
|
+
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1460
|
+
<span class='label'>metadata:</span> <span class='kw'>nil</span>
|
|
1461
|
+
<span class='rparen'>)</span>
|
|
1462
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/certificate_authorities/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1463
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1464
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1465
|
+
<span class='rbrace'>}</span>
|
|
1466
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1467
|
+
<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>
|
|
1468
|
+
<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>
|
|
1469
|
+
<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>
|
|
1470
|
+
<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/CertificateAuthority.html" title="NgrokAPI::Models::CertificateAuthority (class)">CertificateAuthority</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/CertificateAuthority.html#initialize-instance_method" title="NgrokAPI::Models::CertificateAuthority#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>
|
|
1471
|
+
<span class='kw'>end</span></pre>
|
|
1472
|
+
</td>
|
|
1473
|
+
</tr>
|
|
1474
|
+
</table>
|
|
1475
|
+
</div>
|
|
1476
|
+
|
|
1477
|
+
</div>
|
|
1478
|
+
|
|
1479
|
+
</div>
|
|
1480
|
+
|
|
1481
|
+
<div id="footer">
|
|
1482
|
+
Generated on Mon Oct 4 23:24:18 2021 by
|
|
1483
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1484
|
+
0.9.26 (ruby-3.0.1).
|
|
1485
|
+
</div>
|
|
1486
|
+
|
|
1487
|
+
</div>
|
|
1488
|
+
</body>
|
|
1489
|
+
</html>
|