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
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
<meta charset="utf-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
6
|
<title>
|
|
7
|
-
Class: NgrokAPI::Services::
|
|
7
|
+
Class: NgrokAPI::Services::TLSCertificatesClient
|
|
8
8
|
|
|
9
9
|
— Documentation by YARD 0.9.26
|
|
10
10
|
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
|
16
16
|
|
|
17
17
|
<script type="text/javascript">
|
|
18
|
-
pathId = "NgrokAPI::Services::
|
|
18
|
+
pathId = "NgrokAPI::Services::TLSCertificatesClient";
|
|
19
19
|
relpath = '../../';
|
|
20
20
|
</script>
|
|
21
21
|
|
|
@@ -39,7 +39,7 @@
|
|
|
39
39
|
<a href="../../_index.html">Index (T)</a> »
|
|
40
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
41
|
»
|
|
42
|
-
<span class="title">
|
|
42
|
+
<span class="title">TLSCertificatesClient</span>
|
|
43
43
|
|
|
44
44
|
</div>
|
|
45
45
|
|
|
@@ -59,7 +59,7 @@
|
|
|
59
59
|
<div class="clear"></div>
|
|
60
60
|
</div>
|
|
61
61
|
|
|
62
|
-
<div id="content"><h1>Class: NgrokAPI::Services::
|
|
62
|
+
<div id="content"><h1>Class: NgrokAPI::Services::TLSCertificatesClient
|
|
63
63
|
|
|
64
64
|
|
|
65
65
|
|
|
@@ -74,7 +74,7 @@
|
|
|
74
74
|
<ul class="fullTree">
|
|
75
75
|
<li>Object</li>
|
|
76
76
|
|
|
77
|
-
<li class="next">NgrokAPI::Services::
|
|
77
|
+
<li class="next">NgrokAPI::Services::TLSCertificatesClient</li>
|
|
78
78
|
|
|
79
79
|
</ul>
|
|
80
80
|
<a href="#" class="inheritanceTree">show all</a>
|
|
@@ -102,7 +102,13 @@
|
|
|
102
102
|
<h2>Overview</h2><div class="docstring">
|
|
103
103
|
<div class="discussion">
|
|
104
104
|
|
|
105
|
-
<p>
|
|
105
|
+
<p>TLS Certificates are pairs of x509 certificates and their matching private</p>
|
|
106
|
+
|
|
107
|
+
<pre class="code ruby"><code class="ruby">key that can be used to terminate TLS traffic. TLS certificates are unused
|
|
108
|
+
until they are attached to a Domain. TLS Certificates may also be
|
|
109
|
+
provisioned by ngrok automatically for domains on which you have enabled
|
|
110
|
+
automated certificate provisioning.
|
|
111
|
+
</code></pre>
|
|
106
112
|
|
|
107
113
|
<p><a href="https://ngrok.com/docs/api#api-tls-certificates">ngrok.com/docs/api#api-tls-certificates</a></p>
|
|
108
114
|
|
|
@@ -121,11 +127,11 @@
|
|
|
121
127
|
|
|
122
128
|
<dl class="constants">
|
|
123
129
|
|
|
124
|
-
<dt id="
|
|
130
|
+
<dt id="PATH-constant" class="">PATH =
|
|
125
131
|
<div class="docstring">
|
|
126
132
|
<div class="discussion">
|
|
127
133
|
|
|
128
|
-
<p>The
|
|
134
|
+
<p>The API path for the requests</p>
|
|
129
135
|
|
|
130
136
|
|
|
131
137
|
</div>
|
|
@@ -135,13 +141,13 @@
|
|
|
135
141
|
|
|
136
142
|
</div>
|
|
137
143
|
</dt>
|
|
138
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'
|
|
144
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tls_certificates</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
139
145
|
|
|
140
|
-
<dt id="
|
|
146
|
+
<dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
|
|
141
147
|
<div class="docstring">
|
|
142
148
|
<div class="discussion">
|
|
143
149
|
|
|
144
|
-
<p>The API
|
|
150
|
+
<p>The List Property from the resulting API for list calls</p>
|
|
145
151
|
|
|
146
152
|
|
|
147
153
|
</div>
|
|
@@ -151,7 +157,7 @@
|
|
|
151
157
|
|
|
152
158
|
</div>
|
|
153
159
|
</dt>
|
|
154
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'
|
|
160
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>tls_certificates</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
155
161
|
|
|
156
162
|
</dl>
|
|
157
163
|
|
|
@@ -207,7 +213,7 @@
|
|
|
207
213
|
<li class="public ">
|
|
208
214
|
<span class="summary_signature">
|
|
209
215
|
|
|
210
|
-
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(
|
|
216
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: "", metadata: "", certificate_pem:, private_key_pem:) ⇒ NgrokAPI::Models::TLSCertificate </a>
|
|
211
217
|
|
|
212
218
|
|
|
213
219
|
|
|
@@ -231,7 +237,7 @@
|
|
|
231
237
|
<li class="public ">
|
|
232
238
|
<span class="summary_signature">
|
|
233
239
|
|
|
234
|
-
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id:
|
|
240
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
235
241
|
|
|
236
242
|
|
|
237
243
|
|
|
@@ -246,7 +252,7 @@
|
|
|
246
252
|
|
|
247
253
|
|
|
248
254
|
<span class="summary_desc"><div class='inline'>
|
|
249
|
-
<p>Delete a TLS certificate
|
|
255
|
+
<p>Delete a TLS certificate.</p>
|
|
250
256
|
</div></span>
|
|
251
257
|
|
|
252
258
|
</li>
|
|
@@ -255,7 +261,7 @@
|
|
|
255
261
|
<li class="public ">
|
|
256
262
|
<span class="summary_signature">
|
|
257
263
|
|
|
258
|
-
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id:
|
|
264
|
+
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
259
265
|
|
|
260
266
|
|
|
261
267
|
|
|
@@ -270,7 +276,7 @@
|
|
|
270
276
|
|
|
271
277
|
|
|
272
278
|
<span class="summary_desc"><div class='inline'>
|
|
273
|
-
<p>Delete a TLS certificate
|
|
279
|
+
<p>Delete a TLS certificate Throws an exception if API error.</p>
|
|
274
280
|
</div></span>
|
|
275
281
|
|
|
276
282
|
</li>
|
|
@@ -279,7 +285,7 @@
|
|
|
279
285
|
<li class="public ">
|
|
280
286
|
<span class="summary_signature">
|
|
281
287
|
|
|
282
|
-
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id:
|
|
288
|
+
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: "") ⇒ NgrokAPI::Models::TLSCertificate </a>
|
|
283
289
|
|
|
284
290
|
|
|
285
291
|
|
|
@@ -294,7 +300,7 @@
|
|
|
294
300
|
|
|
295
301
|
|
|
296
302
|
<span class="summary_desc"><div class='inline'>
|
|
297
|
-
<p>Get detailed information about a TLS certificate
|
|
303
|
+
<p>Get detailed information about a TLS certificate.</p>
|
|
298
304
|
</div></span>
|
|
299
305
|
|
|
300
306
|
</li>
|
|
@@ -303,7 +309,7 @@
|
|
|
303
309
|
<li class="public ">
|
|
304
310
|
<span class="summary_signature">
|
|
305
311
|
|
|
306
|
-
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id:
|
|
312
|
+
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: "") ⇒ NgrokAPI::Models::TLSCertificate </a>
|
|
307
313
|
|
|
308
314
|
|
|
309
315
|
|
|
@@ -318,7 +324,7 @@
|
|
|
318
324
|
|
|
319
325
|
|
|
320
326
|
<span class="summary_desc"><div class='inline'>
|
|
321
|
-
<p>Get detailed information about a TLS certificate
|
|
327
|
+
<p>Get detailed information about a TLS certificate Throws an exception if API error.</p>
|
|
322
328
|
</div></span>
|
|
323
329
|
|
|
324
330
|
</li>
|
|
@@ -327,7 +333,7 @@
|
|
|
327
333
|
<li class="public ">
|
|
328
334
|
<span class="summary_signature">
|
|
329
335
|
|
|
330
|
-
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒
|
|
336
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒ TLSCertificatesClient </a>
|
|
331
337
|
|
|
332
338
|
|
|
333
339
|
|
|
@@ -344,7 +350,7 @@
|
|
|
344
350
|
|
|
345
351
|
|
|
346
352
|
<span class="summary_desc"><div class='inline'>
|
|
347
|
-
<p>A new instance of
|
|
353
|
+
<p>A new instance of TLSCertificatesClient.</p>
|
|
348
354
|
</div></span>
|
|
349
355
|
|
|
350
356
|
</li>
|
|
@@ -377,7 +383,7 @@
|
|
|
377
383
|
<li class="public ">
|
|
378
384
|
<span class="summary_signature">
|
|
379
385
|
|
|
380
|
-
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id:
|
|
386
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::TLSCertificate </a>
|
|
381
387
|
|
|
382
388
|
|
|
383
389
|
|
|
@@ -401,7 +407,7 @@
|
|
|
401
407
|
<li class="public ">
|
|
402
408
|
<span class="summary_signature">
|
|
403
409
|
|
|
404
|
-
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id:
|
|
410
|
+
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::TLSCertificate </a>
|
|
405
411
|
|
|
406
412
|
|
|
407
413
|
|
|
@@ -416,7 +422,7 @@
|
|
|
416
422
|
|
|
417
423
|
|
|
418
424
|
<span class="summary_desc"><div class='inline'>
|
|
419
|
-
<p>Update attributes of a TLS Certificate by ID.</p>
|
|
425
|
+
<p>Update attributes of a TLS Certificate by ID Throws an exception if API error.</p>
|
|
420
426
|
</div></span>
|
|
421
427
|
|
|
422
428
|
</li>
|
|
@@ -431,7 +437,7 @@
|
|
|
431
437
|
<div class="method_details first">
|
|
432
438
|
<h3 class="signature first" id="initialize-instance_method">
|
|
433
439
|
|
|
434
|
-
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::
|
|
440
|
+
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::TLSCertificatesClient (class)">TLSCertificatesClient</a></span></tt>
|
|
435
441
|
|
|
436
442
|
|
|
437
443
|
|
|
@@ -440,7 +446,7 @@
|
|
|
440
446
|
</h3><div class="docstring">
|
|
441
447
|
<div class="discussion">
|
|
442
448
|
|
|
443
|
-
<p>Returns a new instance of
|
|
449
|
+
<p>Returns a new instance of TLSCertificatesClient.</p>
|
|
444
450
|
|
|
445
451
|
|
|
446
452
|
</div>
|
|
@@ -454,15 +460,15 @@
|
|
|
454
460
|
<pre class="lines">
|
|
455
461
|
|
|
456
462
|
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
463
|
+
21
|
|
464
|
+
22
|
|
465
|
+
23</pre>
|
|
460
466
|
</td>
|
|
461
467
|
<td>
|
|
462
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line
|
|
468
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 21</span>
|
|
463
469
|
|
|
464
|
-
<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>
|
|
465
|
-
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
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>
|
|
466
472
|
<span class='kw'>end</span></pre>
|
|
467
473
|
</td>
|
|
468
474
|
</tr>
|
|
@@ -502,12 +508,12 @@
|
|
|
502
508
|
<pre class="lines">
|
|
503
509
|
|
|
504
510
|
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
511
|
+
19
|
|
512
|
+
20
|
|
513
|
+
21</pre>
|
|
508
514
|
</td>
|
|
509
515
|
<td>
|
|
510
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line
|
|
516
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 19</span>
|
|
511
517
|
|
|
512
518
|
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
|
513
519
|
<span class='ivar'>@client</span>
|
|
@@ -527,7 +533,7 @@
|
|
|
527
533
|
<div class="method_details first">
|
|
528
534
|
<h3 class="signature first" id="create-instance_method">
|
|
529
535
|
|
|
530
|
-
#<strong>create</strong>(
|
|
536
|
+
#<strong>create</strong>(description: "", metadata: "", certificate_pem:, private_key_pem:) ⇒ <tt><span class='object_link'><a href="../Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">NgrokAPI::Models::TLSCertificate</a></span></tt>
|
|
531
537
|
|
|
532
538
|
|
|
533
539
|
|
|
@@ -536,7 +542,7 @@
|
|
|
536
542
|
</h3><div class="docstring">
|
|
537
543
|
<div class="discussion">
|
|
538
544
|
|
|
539
|
-
<p>Upload a new TLS certificate
|
|
545
|
+
<p>Upload a new TLS certificate</p>
|
|
540
546
|
|
|
541
547
|
<p><a href="https://ngrok.com/docs/api#api-tls-certificates-create">ngrok.com/docs/api#api-tls-certificates-create</a></p>
|
|
542
548
|
|
|
@@ -555,7 +561,7 @@
|
|
|
555
561
|
<span class='type'>(<tt>string</tt>)</span>
|
|
556
562
|
|
|
557
563
|
|
|
558
|
-
<em class="default">(defaults to: <tt
|
|
564
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
559
565
|
|
|
560
566
|
|
|
561
567
|
—
|
|
@@ -573,7 +579,7 @@
|
|
|
573
579
|
<span class='type'>(<tt>string</tt>)</span>
|
|
574
580
|
|
|
575
581
|
|
|
576
|
-
<em class="default">(defaults to: <tt
|
|
582
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
577
583
|
|
|
578
584
|
|
|
579
585
|
—
|
|
@@ -591,8 +597,6 @@
|
|
|
591
597
|
<span class='type'>(<tt>string</tt>)</span>
|
|
592
598
|
|
|
593
599
|
|
|
594
|
-
<em class="default">(defaults to: <tt>''</tt>)</em>
|
|
595
|
-
|
|
596
600
|
|
|
597
601
|
—
|
|
598
602
|
<div class='inline'>
|
|
@@ -609,8 +613,6 @@
|
|
|
609
613
|
<span class='type'>(<tt>string</tt>)</span>
|
|
610
614
|
|
|
611
615
|
|
|
612
|
-
<em class="default">(defaults to: <tt>''</tt>)</em>
|
|
613
|
-
|
|
614
616
|
|
|
615
617
|
—
|
|
616
618
|
<div class='inline'>
|
|
@@ -627,13 +629,13 @@
|
|
|
627
629
|
<li>
|
|
628
630
|
|
|
629
631
|
|
|
630
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
|
632
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">NgrokAPI::Models::TLSCertificate</a></span></tt>)</span>
|
|
631
633
|
|
|
632
634
|
|
|
633
635
|
|
|
634
636
|
—
|
|
635
637
|
<div class='inline'>
|
|
636
|
-
<p>result from
|
|
638
|
+
<p>result from the API request</p>
|
|
637
639
|
</div>
|
|
638
640
|
|
|
639
641
|
</li>
|
|
@@ -646,8 +648,6 @@
|
|
|
646
648
|
<pre class="lines">
|
|
647
649
|
|
|
648
650
|
|
|
649
|
-
33
|
|
650
|
-
34
|
|
651
651
|
35
|
|
652
652
|
36
|
|
653
653
|
37
|
|
@@ -660,25 +660,31 @@
|
|
|
660
660
|
44
|
|
661
661
|
45
|
|
662
662
|
46
|
|
663
|
-
47
|
|
663
|
+
47
|
|
664
|
+
48
|
|
665
|
+
49
|
|
666
|
+
50
|
|
667
|
+
51</pre>
|
|
664
668
|
</td>
|
|
665
669
|
<td>
|
|
666
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line
|
|
667
|
-
|
|
668
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span>
|
|
669
|
-
<span class='label'>
|
|
670
|
-
<span class='label'>
|
|
671
|
-
<span class='label'>
|
|
672
|
-
<span class='label'>private_key_pem:</span>
|
|
673
|
-
<span class='rparen'>)</span>
|
|
674
|
-
<span class='id identifier
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
<span class='
|
|
680
|
-
<span class='id identifier
|
|
681
|
-
<span class='
|
|
670
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 35</span>
|
|
671
|
+
|
|
672
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span>
|
|
673
|
+
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
674
|
+
<span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
675
|
+
<span class='label'>certificate_pem:</span><span class='comma'>,</span>
|
|
676
|
+
<span class='label'>private_key_pem:</span>
|
|
677
|
+
<span class='rparen'>)</span>
|
|
678
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tls_certificates</span><span class='tstring_end'>'</span></span>
|
|
679
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
680
|
+
<span class='rbrace'>}</span>
|
|
681
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
682
|
+
<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>
|
|
683
|
+
<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>
|
|
684
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:certificate_pem</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_certificate_pem'>certificate_pem</span> <span class='kw'>if</span> <span class='id identifier rubyid_certificate_pem'>certificate_pem</span>
|
|
685
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:private_key_pem</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_private_key_pem'>private_key_pem</span> <span class='kw'>if</span> <span class='id identifier rubyid_private_key_pem'>private_key_pem</span>
|
|
686
|
+
<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>
|
|
687
|
+
<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/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TLSCertificate.html#initialize-instance_method" title="NgrokAPI::Models::TLSCertificate#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>
|
|
682
688
|
<span class='kw'>end</span></pre>
|
|
683
689
|
</td>
|
|
684
690
|
</tr>
|
|
@@ -688,7 +694,7 @@
|
|
|
688
694
|
<div class="method_details ">
|
|
689
695
|
<h3 class="signature " id="delete-instance_method">
|
|
690
696
|
|
|
691
|
-
#<strong>delete</strong>(id:
|
|
697
|
+
#<strong>delete</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
692
698
|
|
|
693
699
|
|
|
694
700
|
|
|
@@ -697,7 +703,7 @@
|
|
|
697
703
|
</h3><div class="docstring">
|
|
698
704
|
<div class="discussion">
|
|
699
705
|
|
|
700
|
-
<p>Delete a TLS certificate
|
|
706
|
+
<p>Delete a TLS certificate</p>
|
|
701
707
|
|
|
702
708
|
<p><a href="https://ngrok.com/docs/api#api-tls-certificates-delete">ngrok.com/docs/api#api-tls-certificates-delete</a></p>
|
|
703
709
|
|
|
@@ -716,7 +722,7 @@
|
|
|
716
722
|
<span class='type'>(<tt>string</tt>)</span>
|
|
717
723
|
|
|
718
724
|
|
|
719
|
-
<em class="default">(defaults to: <tt
|
|
725
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
720
726
|
|
|
721
727
|
|
|
722
728
|
—
|
|
@@ -734,13 +740,13 @@
|
|
|
734
740
|
<li>
|
|
735
741
|
|
|
736
742
|
|
|
737
|
-
<span class='type'>(<tt>
|
|
743
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
738
744
|
|
|
739
745
|
|
|
740
746
|
|
|
741
747
|
—
|
|
742
748
|
<div class='inline'>
|
|
743
|
-
<p>result from
|
|
749
|
+
<p>result from the API request</p>
|
|
744
750
|
</div>
|
|
745
751
|
|
|
746
752
|
</li>
|
|
@@ -753,15 +759,27 @@
|
|
|
753
759
|
<pre class="lines">
|
|
754
760
|
|
|
755
761
|
|
|
756
|
-
|
|
757
|
-
|
|
758
|
-
|
|
762
|
+
60
|
|
763
|
+
61
|
|
764
|
+
62
|
|
765
|
+
63
|
|
766
|
+
64
|
|
767
|
+
65
|
|
768
|
+
66
|
|
769
|
+
67
|
|
770
|
+
68</pre>
|
|
759
771
|
</td>
|
|
760
772
|
<td>
|
|
761
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line
|
|
762
|
-
|
|
763
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span
|
|
764
|
-
<span class='
|
|
773
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 60</span>
|
|
774
|
+
|
|
775
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span>
|
|
776
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
777
|
+
<span class='rparen'>)</span>
|
|
778
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tls_certificates/%{id}</span><span class='tstring_end'>'</span></span>
|
|
779
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
780
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
781
|
+
<span class='rbrace'>}</span>
|
|
782
|
+
<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>
|
|
765
783
|
<span class='kw'>end</span></pre>
|
|
766
784
|
</td>
|
|
767
785
|
</tr>
|
|
@@ -771,7 +789,7 @@
|
|
|
771
789
|
<div class="method_details ">
|
|
772
790
|
<h3 class="signature " id="delete!-instance_method">
|
|
773
791
|
|
|
774
|
-
#<strong>delete!</strong>(id:
|
|
792
|
+
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
775
793
|
|
|
776
794
|
|
|
777
795
|
|
|
@@ -780,7 +798,7 @@
|
|
|
780
798
|
</h3><div class="docstring">
|
|
781
799
|
<div class="discussion">
|
|
782
800
|
|
|
783
|
-
<p>Delete a TLS certificate
|
|
801
|
+
<p>Delete a TLS certificate Throws an exception if API error.</p>
|
|
784
802
|
|
|
785
803
|
<p><a href="https://ngrok.com/docs/api#api-tls-certificates-delete">ngrok.com/docs/api#api-tls-certificates-delete</a></p>
|
|
786
804
|
|
|
@@ -799,7 +817,7 @@
|
|
|
799
817
|
<span class='type'>(<tt>string</tt>)</span>
|
|
800
818
|
|
|
801
819
|
|
|
802
|
-
<em class="default">(defaults to: <tt
|
|
820
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
803
821
|
|
|
804
822
|
|
|
805
823
|
—
|
|
@@ -817,13 +835,13 @@
|
|
|
817
835
|
<li>
|
|
818
836
|
|
|
819
837
|
|
|
820
|
-
<span class='type'>(<tt>
|
|
838
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
821
839
|
|
|
822
840
|
|
|
823
841
|
|
|
824
842
|
—
|
|
825
843
|
<div class='inline'>
|
|
826
|
-
<p>result from
|
|
844
|
+
<p>result from the API request</p>
|
|
827
845
|
</div>
|
|
828
846
|
|
|
829
847
|
</li>
|
|
@@ -836,15 +854,27 @@
|
|
|
836
854
|
<pre class="lines">
|
|
837
855
|
|
|
838
856
|
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
857
|
+
78
|
|
858
|
+
79
|
|
859
|
+
80
|
|
860
|
+
81
|
|
861
|
+
82
|
|
862
|
+
83
|
|
863
|
+
84
|
|
864
|
+
85
|
|
865
|
+
86</pre>
|
|
842
866
|
</td>
|
|
843
867
|
<td>
|
|
844
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line
|
|
845
|
-
|
|
846
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span
|
|
847
|
-
<span class='
|
|
868
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 78</span>
|
|
869
|
+
|
|
870
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span>
|
|
871
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
872
|
+
<span class='rparen'>)</span>
|
|
873
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tls_certificates/%{id}</span><span class='tstring_end'>'</span></span>
|
|
874
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
875
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
876
|
+
<span class='rbrace'>}</span>
|
|
877
|
+
<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>
|
|
848
878
|
<span class='kw'>end</span></pre>
|
|
849
879
|
</td>
|
|
850
880
|
</tr>
|
|
@@ -854,7 +884,7 @@
|
|
|
854
884
|
<div class="method_details ">
|
|
855
885
|
<h3 class="signature " id="get-instance_method">
|
|
856
886
|
|
|
857
|
-
#<strong>get</strong>(id:
|
|
887
|
+
#<strong>get</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">NgrokAPI::Models::TLSCertificate</a></span></tt>
|
|
858
888
|
|
|
859
889
|
|
|
860
890
|
|
|
@@ -863,7 +893,7 @@
|
|
|
863
893
|
</h3><div class="docstring">
|
|
864
894
|
<div class="discussion">
|
|
865
895
|
|
|
866
|
-
<p>Get detailed information about a TLS certificate
|
|
896
|
+
<p>Get detailed information about a TLS certificate</p>
|
|
867
897
|
|
|
868
898
|
<p><a href="https://ngrok.com/docs/api#api-tls-certificates-get">ngrok.com/docs/api#api-tls-certificates-get</a></p>
|
|
869
899
|
|
|
@@ -882,7 +912,7 @@
|
|
|
882
912
|
<span class='type'>(<tt>string</tt>)</span>
|
|
883
913
|
|
|
884
914
|
|
|
885
|
-
<em class="default">(defaults to: <tt
|
|
915
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
886
916
|
|
|
887
917
|
|
|
888
918
|
—
|
|
@@ -900,13 +930,13 @@
|
|
|
900
930
|
<li>
|
|
901
931
|
|
|
902
932
|
|
|
903
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
|
933
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">NgrokAPI::Models::TLSCertificate</a></span></tt>)</span>
|
|
904
934
|
|
|
905
935
|
|
|
906
936
|
|
|
907
937
|
—
|
|
908
938
|
<div class='inline'>
|
|
909
|
-
<p>result from
|
|
939
|
+
<p>result from the API request</p>
|
|
910
940
|
</div>
|
|
911
941
|
|
|
912
942
|
</li>
|
|
@@ -919,17 +949,31 @@
|
|
|
919
949
|
<pre class="lines">
|
|
920
950
|
|
|
921
951
|
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
|
|
952
|
+
95
|
|
953
|
+
96
|
|
954
|
+
97
|
|
955
|
+
98
|
|
956
|
+
99
|
|
957
|
+
100
|
|
958
|
+
101
|
|
959
|
+
102
|
|
960
|
+
103
|
|
961
|
+
104
|
|
962
|
+
105</pre>
|
|
926
963
|
</td>
|
|
927
964
|
<td>
|
|
928
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line
|
|
929
|
-
|
|
930
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span
|
|
931
|
-
<span class='
|
|
932
|
-
|
|
965
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 95</span>
|
|
966
|
+
|
|
967
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span>
|
|
968
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
969
|
+
<span class='rparen'>)</span>
|
|
970
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tls_certificates/%{id}</span><span class='tstring_end'>'</span></span>
|
|
971
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
972
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
973
|
+
<span class='rbrace'>}</span>
|
|
974
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
975
|
+
<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>
|
|
976
|
+
<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/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TLSCertificate.html#initialize-instance_method" title="NgrokAPI::Models::TLSCertificate#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>
|
|
933
977
|
<span class='kw'>end</span></pre>
|
|
934
978
|
</td>
|
|
935
979
|
</tr>
|
|
@@ -939,7 +983,7 @@
|
|
|
939
983
|
<div class="method_details ">
|
|
940
984
|
<h3 class="signature " id="get!-instance_method">
|
|
941
985
|
|
|
942
|
-
#<strong>get!</strong>(id:
|
|
986
|
+
#<strong>get!</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">NgrokAPI::Models::TLSCertificate</a></span></tt>
|
|
943
987
|
|
|
944
988
|
|
|
945
989
|
|
|
@@ -948,7 +992,7 @@
|
|
|
948
992
|
</h3><div class="docstring">
|
|
949
993
|
<div class="discussion">
|
|
950
994
|
|
|
951
|
-
<p>Get detailed information about a TLS certificate
|
|
995
|
+
<p>Get detailed information about a TLS certificate Throws an exception if API error.</p>
|
|
952
996
|
|
|
953
997
|
<p><a href="https://ngrok.com/docs/api#api-tls-certificates-get">ngrok.com/docs/api#api-tls-certificates-get</a></p>
|
|
954
998
|
|
|
@@ -967,7 +1011,7 @@
|
|
|
967
1011
|
<span class='type'>(<tt>string</tt>)</span>
|
|
968
1012
|
|
|
969
1013
|
|
|
970
|
-
<em class="default">(defaults to: <tt
|
|
1014
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
971
1015
|
|
|
972
1016
|
|
|
973
1017
|
—
|
|
@@ -985,13 +1029,13 @@
|
|
|
985
1029
|
<li>
|
|
986
1030
|
|
|
987
1031
|
|
|
988
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
|
1032
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">NgrokAPI::Models::TLSCertificate</a></span></tt>)</span>
|
|
989
1033
|
|
|
990
1034
|
|
|
991
1035
|
|
|
992
1036
|
—
|
|
993
1037
|
<div class='inline'>
|
|
994
|
-
<p>result from
|
|
1038
|
+
<p>result from the API request</p>
|
|
995
1039
|
</div>
|
|
996
1040
|
|
|
997
1041
|
</li>
|
|
@@ -1004,17 +1048,31 @@
|
|
|
1004
1048
|
<pre class="lines">
|
|
1005
1049
|
|
|
1006
1050
|
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1051
|
+
115
|
|
1052
|
+
116
|
|
1053
|
+
117
|
|
1054
|
+
118
|
|
1055
|
+
119
|
|
1056
|
+
120
|
|
1057
|
+
121
|
|
1058
|
+
122
|
|
1059
|
+
123
|
|
1060
|
+
124
|
|
1061
|
+
125</pre>
|
|
1011
1062
|
</td>
|
|
1012
1063
|
<td>
|
|
1013
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line
|
|
1014
|
-
|
|
1015
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span
|
|
1016
|
-
<span class='
|
|
1017
|
-
|
|
1064
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 115</span>
|
|
1065
|
+
|
|
1066
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span>
|
|
1067
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
1068
|
+
<span class='rparen'>)</span>
|
|
1069
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tls_certificates/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1070
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1071
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1072
|
+
<span class='rbrace'>}</span>
|
|
1073
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1074
|
+
<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>
|
|
1075
|
+
<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/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TLSCertificate.html#initialize-instance_method" title="NgrokAPI::Models::TLSCertificate#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>
|
|
1018
1076
|
<span class='kw'>end</span></pre>
|
|
1019
1077
|
</td>
|
|
1020
1078
|
</tr>
|
|
@@ -1033,7 +1091,7 @@
|
|
|
1033
1091
|
</h3><div class="docstring">
|
|
1034
1092
|
<div class="discussion">
|
|
1035
1093
|
|
|
1036
|
-
<p>List all TLS certificates on this account
|
|
1094
|
+
<p>List all TLS certificates on this account</p>
|
|
1037
1095
|
|
|
1038
1096
|
<p><a href="https://ngrok.com/docs/api#api-tls-certificates-list">ngrok.com/docs/api#api-tls-certificates-list</a></p>
|
|
1039
1097
|
|
|
@@ -1062,7 +1120,7 @@
|
|
|
1062
1120
|
<span class='name'>limit</span>
|
|
1063
1121
|
|
|
1064
1122
|
|
|
1065
|
-
<span class='type'>(<tt>
|
|
1123
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1066
1124
|
|
|
1067
1125
|
|
|
1068
1126
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -1102,7 +1160,7 @@
|
|
|
1102
1160
|
|
|
1103
1161
|
—
|
|
1104
1162
|
<div class='inline'>
|
|
1105
|
-
<p>the
|
|
1163
|
+
<p>result from the API request</p>
|
|
1106
1164
|
</div>
|
|
1107
1165
|
|
|
1108
1166
|
</li>
|
|
@@ -1115,27 +1173,45 @@
|
|
|
1115
1173
|
<pre class="lines">
|
|
1116
1174
|
|
|
1117
1175
|
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
|
|
1176
|
+
136
|
|
1177
|
+
137
|
|
1178
|
+
138
|
|
1179
|
+
139
|
|
1180
|
+
140
|
|
1181
|
+
141
|
|
1182
|
+
142
|
|
1183
|
+
143
|
|
1184
|
+
144
|
|
1185
|
+
145
|
|
1186
|
+
146
|
|
1187
|
+
147
|
|
1188
|
+
148
|
|
1189
|
+
149
|
|
1190
|
+
150
|
|
1191
|
+
151
|
|
1192
|
+
152
|
|
1193
|
+
153</pre>
|
|
1127
1194
|
</td>
|
|
1128
1195
|
<td>
|
|
1129
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line
|
|
1130
|
-
|
|
1131
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span
|
|
1132
|
-
<span class='
|
|
1133
|
-
<span class='
|
|
1134
|
-
|
|
1135
|
-
|
|
1136
|
-
|
|
1137
|
-
<span class='label'>
|
|
1138
|
-
|
|
1196
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 136</span>
|
|
1197
|
+
|
|
1198
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
|
1199
|
+
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1200
|
+
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1201
|
+
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1202
|
+
<span class='rparen'>)</span>
|
|
1203
|
+
<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>
|
|
1204
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1205
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1206
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1207
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::TLSCertificatesClient::PATH (constant)">PATH</a></span></span>
|
|
1208
|
+
<span class='rparen'>)</span>
|
|
1209
|
+
<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>
|
|
1210
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1211
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1212
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::TLSCertificatesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1213
|
+
<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/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</a></span></span>
|
|
1214
|
+
<span class='rparen'>)</span>
|
|
1139
1215
|
<span class='kw'>end</span></pre>
|
|
1140
1216
|
</td>
|
|
1141
1217
|
</tr>
|
|
@@ -1145,7 +1221,7 @@
|
|
|
1145
1221
|
<div class="method_details ">
|
|
1146
1222
|
<h3 class="signature " id="update-instance_method">
|
|
1147
1223
|
|
|
1148
|
-
#<strong>update</strong>(id:
|
|
1224
|
+
#<strong>update</strong>(id: "", description: nil, metadata: nil) ⇒ <tt><span class='object_link'><a href="../Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">NgrokAPI::Models::TLSCertificate</a></span></tt>
|
|
1149
1225
|
|
|
1150
1226
|
|
|
1151
1227
|
|
|
@@ -1154,7 +1230,7 @@
|
|
|
1154
1230
|
</h3><div class="docstring">
|
|
1155
1231
|
<div class="discussion">
|
|
1156
1232
|
|
|
1157
|
-
<p>Update attributes of a TLS Certificate by ID
|
|
1233
|
+
<p>Update attributes of a TLS Certificate by ID</p>
|
|
1158
1234
|
|
|
1159
1235
|
<p><a href="https://ngrok.com/docs/api#api-tls-certificates-update">ngrok.com/docs/api#api-tls-certificates-update</a></p>
|
|
1160
1236
|
|
|
@@ -1173,7 +1249,7 @@
|
|
|
1173
1249
|
<span class='type'>(<tt>string</tt>)</span>
|
|
1174
1250
|
|
|
1175
1251
|
|
|
1176
|
-
<em class="default">(defaults to: <tt
|
|
1252
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1177
1253
|
|
|
1178
1254
|
|
|
1179
1255
|
</li>
|
|
@@ -1222,13 +1298,13 @@
|
|
|
1222
1298
|
<li>
|
|
1223
1299
|
|
|
1224
1300
|
|
|
1225
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
|
1301
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">NgrokAPI::Models::TLSCertificate</a></span></tt>)</span>
|
|
1226
1302
|
|
|
1227
1303
|
|
|
1228
1304
|
|
|
1229
1305
|
—
|
|
1230
1306
|
<div class='inline'>
|
|
1231
|
-
<p>result from
|
|
1307
|
+
<p>result from the API request</p>
|
|
1232
1308
|
</div>
|
|
1233
1309
|
|
|
1234
1310
|
</li>
|
|
@@ -1241,31 +1317,39 @@
|
|
|
1241
1317
|
<pre class="lines">
|
|
1242
1318
|
|
|
1243
1319
|
|
|
1244
|
-
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
|
|
1254
|
-
|
|
1320
|
+
164
|
|
1321
|
+
165
|
|
1322
|
+
166
|
|
1323
|
+
167
|
|
1324
|
+
168
|
|
1325
|
+
169
|
|
1326
|
+
170
|
|
1327
|
+
171
|
|
1328
|
+
172
|
|
1329
|
+
173
|
|
1330
|
+
174
|
|
1331
|
+
175
|
|
1332
|
+
176
|
|
1333
|
+
177
|
|
1334
|
+
178</pre>
|
|
1255
1335
|
</td>
|
|
1256
1336
|
<td>
|
|
1257
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line
|
|
1258
|
-
|
|
1259
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
|
|
1260
|
-
<span class='label'>id:</span> <span class='
|
|
1261
|
-
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1262
|
-
<span class='label'>metadata:</span> <span class='kw'>nil</span>
|
|
1263
|
-
<span class='rparen'>)</span>
|
|
1264
|
-
<span class='id identifier
|
|
1265
|
-
<span class='id identifier
|
|
1266
|
-
|
|
1267
|
-
<span class='
|
|
1268
|
-
<span class='
|
|
1337
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 164</span>
|
|
1338
|
+
|
|
1339
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
|
|
1340
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
1341
|
+
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1342
|
+
<span class='label'>metadata:</span> <span class='kw'>nil</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'>/tls_certificates/%{id}</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='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1349
|
+
<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>
|
|
1350
|
+
<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>
|
|
1351
|
+
<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>
|
|
1352
|
+
<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/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TLSCertificate.html#initialize-instance_method" title="NgrokAPI::Models::TLSCertificate#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>
|
|
1269
1353
|
<span class='kw'>end</span></pre>
|
|
1270
1354
|
</td>
|
|
1271
1355
|
</tr>
|
|
@@ -1275,7 +1359,7 @@
|
|
|
1275
1359
|
<div class="method_details ">
|
|
1276
1360
|
<h3 class="signature " id="update!-instance_method">
|
|
1277
1361
|
|
|
1278
|
-
#<strong>update!</strong>(id:
|
|
1362
|
+
#<strong>update!</strong>(id: "", description: nil, metadata: nil) ⇒ <tt><span class='object_link'><a href="../Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">NgrokAPI::Models::TLSCertificate</a></span></tt>
|
|
1279
1363
|
|
|
1280
1364
|
|
|
1281
1365
|
|
|
@@ -1284,7 +1368,7 @@
|
|
|
1284
1368
|
</h3><div class="docstring">
|
|
1285
1369
|
<div class="discussion">
|
|
1286
1370
|
|
|
1287
|
-
<p>Update attributes of a TLS Certificate by ID
|
|
1371
|
+
<p>Update attributes of a TLS Certificate by ID Throws an exception if API error.</p>
|
|
1288
1372
|
|
|
1289
1373
|
<p><a href="https://ngrok.com/docs/api#api-tls-certificates-update">ngrok.com/docs/api#api-tls-certificates-update</a></p>
|
|
1290
1374
|
|
|
@@ -1303,7 +1387,7 @@
|
|
|
1303
1387
|
<span class='type'>(<tt>string</tt>)</span>
|
|
1304
1388
|
|
|
1305
1389
|
|
|
1306
|
-
<em class="default">(defaults to: <tt
|
|
1390
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1307
1391
|
|
|
1308
1392
|
|
|
1309
1393
|
</li>
|
|
@@ -1352,13 +1436,13 @@
|
|
|
1352
1436
|
<li>
|
|
1353
1437
|
|
|
1354
1438
|
|
|
1355
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
|
1439
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">NgrokAPI::Models::TLSCertificate</a></span></tt>)</span>
|
|
1356
1440
|
|
|
1357
1441
|
|
|
1358
1442
|
|
|
1359
1443
|
—
|
|
1360
1444
|
<div class='inline'>
|
|
1361
|
-
<p>result from
|
|
1445
|
+
<p>result from the API request</p>
|
|
1362
1446
|
</div>
|
|
1363
1447
|
|
|
1364
1448
|
</li>
|
|
@@ -1371,31 +1455,39 @@
|
|
|
1371
1455
|
<pre class="lines">
|
|
1372
1456
|
|
|
1373
1457
|
|
|
1374
|
-
|
|
1375
|
-
|
|
1376
|
-
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
|
|
1380
|
-
|
|
1381
|
-
|
|
1382
|
-
|
|
1383
|
-
|
|
1384
|
-
|
|
1458
|
+
190
|
|
1459
|
+
191
|
|
1460
|
+
192
|
|
1461
|
+
193
|
|
1462
|
+
194
|
|
1463
|
+
195
|
|
1464
|
+
196
|
|
1465
|
+
197
|
|
1466
|
+
198
|
|
1467
|
+
199
|
|
1468
|
+
200
|
|
1469
|
+
201
|
|
1470
|
+
202
|
|
1471
|
+
203
|
|
1472
|
+
204</pre>
|
|
1385
1473
|
</td>
|
|
1386
1474
|
<td>
|
|
1387
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line
|
|
1388
|
-
|
|
1389
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
|
|
1390
|
-
<span class='label'>id:</span> <span class='
|
|
1391
|
-
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1392
|
-
<span class='label'>metadata:</span> <span class='kw'>nil</span>
|
|
1393
|
-
<span class='rparen'>)</span>
|
|
1394
|
-
<span class='id identifier
|
|
1395
|
-
<span class='id identifier
|
|
1396
|
-
|
|
1397
|
-
<span class='
|
|
1398
|
-
<span class='
|
|
1475
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 190</span>
|
|
1476
|
+
|
|
1477
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
|
|
1478
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
1479
|
+
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1480
|
+
<span class='label'>metadata:</span> <span class='kw'>nil</span>
|
|
1481
|
+
<span class='rparen'>)</span>
|
|
1482
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tls_certificates/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1483
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1484
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1485
|
+
<span class='rbrace'>}</span>
|
|
1486
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1487
|
+
<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>
|
|
1488
|
+
<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>
|
|
1489
|
+
<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>
|
|
1490
|
+
<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/TLSCertificate.html" title="NgrokAPI::Models::TLSCertificate (class)">TLSCertificate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TLSCertificate.html#initialize-instance_method" title="NgrokAPI::Models::TLSCertificate#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
1399
1491
|
<span class='kw'>end</span></pre>
|
|
1400
1492
|
</td>
|
|
1401
1493
|
</tr>
|
|
@@ -1407,7 +1499,7 @@
|
|
|
1407
1499
|
</div>
|
|
1408
1500
|
|
|
1409
1501
|
<div id="footer">
|
|
1410
|
-
Generated on
|
|
1502
|
+
Generated on Mon Oct 4 23:24:18 2021 by
|
|
1411
1503
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1412
1504
|
0.9.26 (ruby-3.0.1).
|
|
1413
1505
|
</div>
|