ngrok-api 0.9.0 → 0.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.rubocop.yml +2 -2
- data/.yardopts +1 -0
- data/LICENSE +7 -0
- data/doc/NgrokAPI/Client.html +1469 -125
- data/doc/NgrokAPI/Error.html +3 -3
- data/doc/NgrokAPI/Errors/NotFoundError.html +3 -3
- data/doc/NgrokAPI/Errors.html +3 -3
- data/doc/NgrokAPI/HttpClient.html +66 -36
- data/doc/NgrokAPI/Models/{ApiKey.html → APIKey.html} +110 -179
- data/doc/NgrokAPI/Models/AWSAuth.html +617 -0
- data/doc/NgrokAPI/Models/AWSCredentials.html +617 -0
- data/doc/NgrokAPI/Models/AWSRole.html +543 -0
- data/doc/NgrokAPI/Models/AbuseReport.html +987 -0
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +617 -0
- data/doc/NgrokAPI/Models/AgentIngress.html +1217 -0
- data/doc/NgrokAPI/Models/CertificateAuthority.html +1439 -0
- data/doc/NgrokAPI/Models/Credential.html +1149 -0
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +913 -0
- data/doc/NgrokAPI/Models/EndpointCompression.html +543 -0
- data/doc/NgrokAPI/Models/EndpointConfiguration.html +1323 -512
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +617 -0
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointLogging.html +617 -0
- data/doc/NgrokAPI/Models/EndpointLoggingMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +617 -0
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointOAuth.html +987 -0
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +987 -0
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +765 -0
- data/doc/NgrokAPI/Models/EndpointOIDC.html +1135 -0
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +691 -0
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +691 -0
- data/doc/NgrokAPI/Models/EndpointSAML.html +1653 -0
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +1283 -0
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +691 -0
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +691 -0
- data/doc/NgrokAPI/Models/EventDestination.html +1058 -0
- data/doc/NgrokAPI/Models/EventSource.html +765 -0
- data/doc/NgrokAPI/Models/EventSourceList.html +617 -0
- data/doc/NgrokAPI/Models/EventSourceReplace.html +691 -0
- data/doc/NgrokAPI/Models/EventStream.html +1309 -0
- data/doc/NgrokAPI/Models/EventSubscription.html +1058 -0
- data/doc/NgrokAPI/Models/EventTarget.html +765 -0
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +617 -0
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +617 -0
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +617 -0
- data/doc/NgrokAPI/Models/{TlsCertificate.html → IPPolicy.html} +172 -167
- data/doc/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/doc/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/doc/NgrokAPI/Models/Listable.html +120 -52
- data/doc/NgrokAPI/Models/Ref.html +617 -0
- data/doc/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/doc/NgrokAPI/Models/ReservedDomain.html +186 -1108
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +765 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +617 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +617 -0
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +1143 -0
- data/doc/NgrokAPI/Models/SSHCredential.html +1149 -0
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +1513 -0
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +1661 -0
- data/doc/NgrokAPI/Models/TLSCertificate.html +2179 -0
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +617 -0
- data/doc/NgrokAPI/Models/Tunnel.html +987 -0
- data/doc/NgrokAPI/Models/TunnelSession.html +1209 -0
- data/doc/NgrokAPI/Models.html +6 -6
- data/doc/NgrokAPI/PagedIterator.html +16 -12
- data/{docs/NgrokAPI/Services/ApiKeysClient.html → doc/NgrokAPI/Services/APIKeysClient.html} +404 -153
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +706 -0
- data/doc/NgrokAPI/Services/AgentIngressesClient.html +1600 -0
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +1602 -0
- data/doc/NgrokAPI/Services/CredentialsClient.html +1644 -0
- data/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +503 -370
- data/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +1712 -0
- data/doc/NgrokAPI/Services/EventSourcesClient.html +1532 -0
- data/doc/NgrokAPI/Services/EventStreamsClient.html +1792 -0
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +1712 -0
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +1602 -0
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +1660 -0
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +1720 -0
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +1894 -0
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +585 -344
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1644 -0
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +1662 -0
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +1680 -0
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +1720 -0
- data/{docs/NgrokAPI/Services/TlsCertificatesClient.html → doc/NgrokAPI/Services/TLSCertificatesClient.html} +404 -201
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +1587 -0
- data/doc/NgrokAPI/Services/TunnelsClient.html +669 -0
- data/doc/NgrokAPI/Services.html +6 -6
- data/doc/NgrokAPI.html +5 -5
- data/doc/README +94 -0
- data/doc/_index.html +621 -25
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +55 -28
- data/doc/frames.html +1 -1
- data/doc/index.html +55 -28
- data/doc/method_list.html +7526 -286
- data/doc/top-level-namespace.html +3 -3
- data/docs/.gitkeep +0 -0
- data/docs/CNAME +1 -0
- data/docs/NgrokAPI/Client.html +1469 -125
- data/docs/NgrokAPI/Error.html +3 -3
- data/docs/NgrokAPI/Errors/NotFoundError.html +3 -3
- data/docs/NgrokAPI/Errors.html +3 -3
- data/docs/NgrokAPI/HttpClient.html +66 -36
- data/docs/NgrokAPI/Models/{ApiKey.html → APIKey.html} +110 -179
- data/docs/NgrokAPI/Models/AWSAuth.html +617 -0
- data/docs/NgrokAPI/Models/AWSCredentials.html +617 -0
- data/docs/NgrokAPI/Models/AWSRole.html +543 -0
- data/docs/NgrokAPI/Models/AbuseReport.html +987 -0
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +617 -0
- data/docs/NgrokAPI/Models/AgentIngress.html +1217 -0
- data/docs/NgrokAPI/Models/CertificateAuthority.html +1439 -0
- data/docs/NgrokAPI/Models/Credential.html +1149 -0
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +913 -0
- data/docs/NgrokAPI/Models/EndpointCompression.html +543 -0
- data/docs/NgrokAPI/Models/EndpointConfiguration.html +1323 -512
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +617 -0
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointLogging.html +617 -0
- data/docs/NgrokAPI/Models/EndpointLoggingMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +617 -0
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointOAuth.html +987 -0
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +987 -0
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +765 -0
- data/docs/NgrokAPI/Models/EndpointOIDC.html +1135 -0
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +691 -0
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +691 -0
- data/docs/NgrokAPI/Models/EndpointSAML.html +1653 -0
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +1283 -0
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +691 -0
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +691 -0
- data/docs/NgrokAPI/Models/EventDestination.html +1058 -0
- data/docs/NgrokAPI/Models/EventSource.html +765 -0
- data/docs/NgrokAPI/Models/EventSourceList.html +617 -0
- data/docs/NgrokAPI/Models/EventSourceReplace.html +691 -0
- data/docs/NgrokAPI/Models/EventStream.html +1309 -0
- data/docs/NgrokAPI/Models/EventSubscription.html +1058 -0
- data/docs/NgrokAPI/Models/EventTarget.html +765 -0
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +617 -0
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +617 -0
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +617 -0
- data/docs/NgrokAPI/Models/{TlsCertificate.html → IPPolicy.html} +172 -167
- data/docs/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/docs/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/docs/NgrokAPI/Models/Listable.html +120 -52
- data/docs/NgrokAPI/Models/Ref.html +617 -0
- data/docs/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/docs/NgrokAPI/Models/ReservedDomain.html +186 -1108
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +765 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +617 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +617 -0
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +1143 -0
- data/docs/NgrokAPI/Models/SSHCredential.html +1149 -0
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +1513 -0
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +1661 -0
- data/docs/NgrokAPI/Models/TLSCertificate.html +2179 -0
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +617 -0
- data/docs/NgrokAPI/Models/Tunnel.html +987 -0
- data/docs/NgrokAPI/Models/TunnelSession.html +1209 -0
- data/docs/NgrokAPI/Models.html +6 -6
- data/docs/NgrokAPI/PagedIterator.html +16 -12
- data/{doc/NgrokAPI/Services/ApiKeysClient.html → docs/NgrokAPI/Services/APIKeysClient.html} +404 -153
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +706 -0
- data/docs/NgrokAPI/Services/AgentIngressesClient.html +1600 -0
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +1602 -0
- data/docs/NgrokAPI/Services/CredentialsClient.html +1644 -0
- data/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +503 -370
- data/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +1712 -0
- data/docs/NgrokAPI/Services/EventSourcesClient.html +1532 -0
- data/docs/NgrokAPI/Services/EventStreamsClient.html +1792 -0
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +1712 -0
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +1602 -0
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +1660 -0
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +1720 -0
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +1894 -0
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +585 -344
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1644 -0
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +1662 -0
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +1680 -0
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +1720 -0
- data/{doc/NgrokAPI/Services/TlsCertificatesClient.html → docs/NgrokAPI/Services/TLSCertificatesClient.html} +404 -201
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +1587 -0
- data/docs/NgrokAPI/Services/TunnelsClient.html +669 -0
- data/docs/NgrokAPI/Services.html +6 -6
- data/docs/NgrokAPI.html +5 -5
- data/docs/README +94 -0
- data/docs/_index.html +621 -25
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +55 -28
- data/docs/frames.html +1 -1
- data/docs/index.html +55 -28
- data/docs/method_list.html +7526 -286
- data/docs/top-level-namespace.html +3 -3
- data/lib/ngrokapi/client.rb +229 -49
- data/lib/ngrokapi/http_client.rb +6 -7
- data/lib/ngrokapi/models/abuse_report.rb +37 -0
- data/lib/ngrokapi/models/abuse_report_hostname.rb +27 -0
- data/lib/ngrokapi/models/agent_ingress.rb +66 -0
- data/lib/ngrokapi/models/api_key.rb +62 -64
- data/lib/ngrokapi/models/aws_auth.rb +27 -0
- data/lib/ngrokapi/models/aws_credentials.rb +27 -0
- data/lib/ngrokapi/models/aws_role.rb +25 -0
- data/lib/ngrokapi/models/certificate_authority.rb +72 -0
- data/lib/ngrokapi/models/credential.rb +67 -0
- data/lib/ngrokapi/models/endpoint_circuit_breaker.rb +35 -0
- data/lib/ngrokapi/models/endpoint_compression.rb +25 -0
- data/lib/ngrokapi/models/endpoint_configuration.rb +130 -119
- data/lib/ngrokapi/models/endpoint_ip_policy.rb +27 -0
- data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_logging.rb +27 -0
- data/lib/ngrokapi/models/endpoint_logging_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_mutual_tls.rb +27 -0
- data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_o_auth.rb +37 -0
- data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb +37 -0
- data/lib/ngrokapi/models/endpoint_o_auth_google.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_microsoft.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_provider.rb +31 -0
- data/lib/ngrokapi/models/endpoint_oidc.rb +41 -0
- data/lib/ngrokapi/models/endpoint_request_headers.rb +29 -0
- data/lib/ngrokapi/models/endpoint_response_headers.rb +29 -0
- data/lib/ngrokapi/models/endpoint_saml.rb +55 -0
- data/lib/ngrokapi/models/endpoint_saml_mutate.rb +45 -0
- data/lib/ngrokapi/models/endpoint_tls_termination.rb +29 -0
- data/lib/ngrokapi/models/endpoint_webhook_validation.rb +29 -0
- data/lib/ngrokapi/models/event_destination.rb +49 -0
- data/lib/ngrokapi/models/event_source.rb +31 -0
- data/lib/ngrokapi/models/event_source_list.rb +27 -0
- data/lib/ngrokapi/models/event_source_replace.rb +29 -0
- data/lib/ngrokapi/models/event_stream.rb +77 -0
- data/lib/ngrokapi/models/event_subscription.rb +47 -0
- data/lib/ngrokapi/models/event_target.rb +31 -0
- data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb +27 -0
- data/lib/ngrokapi/models/event_target_firehose.rb +27 -0
- data/lib/ngrokapi/models/event_target_kinesis.rb +27 -0
- data/lib/ngrokapi/models/ip_policy.rb +64 -0
- data/lib/ngrokapi/models/ip_policy_rule.rb +67 -0
- data/lib/ngrokapi/models/ip_restriction.rb +49 -0
- data/lib/ngrokapi/models/listable.rb +13 -2
- data/lib/ngrokapi/models/ref.rb +27 -0
- data/lib/ngrokapi/models/reserved_addr.rb +49 -0
- data/lib/ngrokapi/models/reserved_domain.rb +61 -211
- data/lib/ngrokapi/models/reserved_domain_cert_job.rb +31 -0
- data/lib/ngrokapi/models/reserved_domain_cert_policy.rb +27 -0
- data/lib/ngrokapi/models/reserved_domain_cert_status.rb +27 -0
- data/lib/ngrokapi/models/ssh_certificate_authority.rb +64 -0
- data/lib/ngrokapi/models/ssh_credential.rb +67 -0
- data/lib/ngrokapi/models/ssh_host_certificate.rb +74 -0
- data/lib/ngrokapi/models/ssh_user_certificate.rb +78 -0
- data/lib/ngrokapi/models/tls_certificate.rb +92 -62
- data/lib/ngrokapi/models/tls_certificate_sa_ns.rb +27 -0
- data/lib/ngrokapi/models/tunnel.rb +37 -0
- data/lib/ngrokapi/models/tunnel_session.rb +43 -0
- data/lib/ngrokapi/paged_iterator.rb +4 -2
- data/lib/ngrokapi/services/.gitkeep +0 -0
- data/lib/ngrokapi/services/abuse_reports_client.rb +77 -0
- data/lib/ngrokapi/services/agent_ingresses_client.rb +206 -0
- data/lib/ngrokapi/services/api_keys_client.rb +210 -144
- data/lib/ngrokapi/services/certificate_authorities_client.rb +211 -0
- data/lib/ngrokapi/services/credentials_client.rb +217 -0
- data/lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_compression_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +289 -313
- data/lib/ngrokapi/services/endpoint_ip_policy_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_logging_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_o_auth_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_oidc_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_request_headers_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_response_headers_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_saml_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_tls_termination_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb +108 -0
- data/lib/ngrokapi/services/event_destinations_client.rb +221 -0
- data/lib/ngrokapi/services/event_sources_client.rb +185 -0
- data/lib/ngrokapi/services/event_streams_client.rb +224 -0
- data/lib/ngrokapi/services/event_subscriptions_client.rb +215 -0
- data/lib/ngrokapi/services/ip_policies_client.rb +215 -0
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +214 -0
- data/lib/ngrokapi/services/ip_restrictions_client.rb +224 -0
- data/lib/ngrokapi/services/reserved_addrs_client.rb +246 -0
- data/lib/ngrokapi/services/reserved_domains_client.rb +360 -313
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +212 -0
- data/lib/ngrokapi/services/ssh_credentials_client.rb +215 -0
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +217 -0
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +221 -0
- data/lib/ngrokapi/services/tls_certificates_client.rb +213 -161
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +237 -0
- data/lib/ngrokapi/services/tunnels_client.rb +78 -0
- data/lib/ngrokapi/version.rb +1 -1
- data/lib/ngrokapi.rb +1 -1
- data/ngrok-api.gemspec +1 -1
- data/spec/ngrokapi/client_spec.rb +158 -33
- data/spec/ngrokapi/models/abuse_report_hostname_spec.rb +21 -0
- data/spec/ngrokapi/models/abuse_report_spec.rb +21 -0
- data/spec/ngrokapi/models/agent_ingress_spec.rb +42 -0
- data/spec/ngrokapi/models/api_key_spec.rb +42 -43
- data/spec/ngrokapi/models/aws_auth_spec.rb +21 -0
- data/spec/ngrokapi/models/aws_credentials_spec.rb +21 -0
- data/spec/ngrokapi/models/aws_role_spec.rb +21 -0
- data/spec/ngrokapi/models/certificate_authority_spec.rb +42 -0
- data/spec/ngrokapi/models/credential_spec.rb +45 -0
- data/spec/ngrokapi/models/endpoint_circuit_breaker_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_compression_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_configuration_spec.rb +78 -0
- data/spec/ngrokapi/models/endpoint_ip_policy_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_ip_policy_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_logging_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_logging_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_mutual_tls_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_mutual_tls_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_facebook_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_git_hub_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_google_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_microsoft_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_provider_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_oidc_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_request_headers_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_response_headers_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_saml_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_saml_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_tls_termination_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_webhook_validation_spec.rb +21 -0
- data/spec/ngrokapi/models/event_destination_spec.rb +28 -0
- data/spec/ngrokapi/models/event_source_list_spec.rb +21 -0
- data/spec/ngrokapi/models/event_source_replace_spec.rb +21 -0
- data/spec/ngrokapi/models/event_source_spec.rb +21 -0
- data/spec/ngrokapi/models/event_stream_spec.rb +51 -0
- data/spec/ngrokapi/models/event_subscription_spec.rb +28 -0
- data/spec/ngrokapi/models/event_target_cloudwatch_logs_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_firehose_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_kinesis_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_spec.rb +21 -0
- data/spec/ngrokapi/models/ip_policy_rule_spec.rb +45 -0
- data/spec/ngrokapi/models/ip_policy_spec.rb +42 -0
- data/spec/ngrokapi/models/ip_restriction_spec.rb +28 -0
- data/spec/ngrokapi/models/listable_spec.rb +4 -4
- data/spec/ngrokapi/models/ref_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_addr_spec.rb +28 -0
- data/spec/ngrokapi/models/reserved_domain_cert_job_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_cert_status_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_spec.rb +28 -100
- data/spec/ngrokapi/models/ssh_certificate_authority_spec.rb +42 -0
- data/spec/ngrokapi/models/ssh_credential_spec.rb +45 -0
- data/spec/ngrokapi/models/ssh_host_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/ssh_user_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/tls_certificate_sa_ns_spec.rb +21 -0
- data/spec/ngrokapi/models/tls_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/tunnel_session_spec.rb +21 -0
- data/spec/ngrokapi/models/tunnel_spec.rb +21 -0
- data/spec/ngrokapi/paged_iterator_spec.rb +7 -7
- data/spec/ngrokapi/services/.gitkeep +0 -0
- data/spec/ngrokapi/services/abuse_reports_client_spec.rb +65 -0
- data/spec/ngrokapi/services/agent_ingresses_client_spec.rb +159 -0
- data/spec/ngrokapi/services/api_keys_client_spec.rb +157 -127
- data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +159 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +163 -0
- data/spec/ngrokapi/services/endpoint_circuit_breaker_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_compression_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +237 -0
- data/spec/ngrokapi/services/endpoint_ip_policy_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_mutual_tls_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_o_auth_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_oidc_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_request_headers_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_response_headers_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_saml_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_tls_termination_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_webhook_validation_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/event_destinations_client_spec.rb +172 -0
- data/spec/ngrokapi/services/event_sources_client_spec.rb +192 -0
- data/spec/ngrokapi/services/event_streams_client_spec.rb +177 -0
- data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +169 -0
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +159 -0
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +165 -0
- data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +171 -0
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +206 -0
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +349 -0
- data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +163 -0
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +165 -0
- data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +167 -0
- data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +171 -0
- data/spec/ngrokapi/services/tls_certificates_client_spec.rb +161 -0
- data/spec/ngrokapi/services/tunnel_sessions_client_spec.rb +183 -0
- data/spec/ngrokapi/services/tunnels_client_spec.rb +21 -0
- data/spec/spec_helper.rb +1096 -80
- metadata +360 -11
|
@@ -4,9 +4,9 @@
|
|
|
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
|
-
— Documentation by YARD 0.9.
|
|
9
|
+
— Documentation by YARD 0.9.27
|
|
10
10
|
|
|
11
11
|
</title>
|
|
12
12
|
|
|
@@ -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,7 @@
|
|
|
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 key that can be used to terminate TLS traffic. TLS certificates are unused until they are attached to a Domain. TLS Certificates may also be provisioned by ngrok automatically for domains on which you have enabled automated certificate provisioning.</p>
|
|
106
106
|
|
|
107
107
|
<p><a href="https://ngrok.com/docs/api#api-tls-certificates">ngrok.com/docs/api#api-tls-certificates</a></p>
|
|
108
108
|
|
|
@@ -121,11 +121,11 @@
|
|
|
121
121
|
|
|
122
122
|
<dl class="constants">
|
|
123
123
|
|
|
124
|
-
<dt id="
|
|
124
|
+
<dt id="PATH-constant" class="">PATH =
|
|
125
125
|
<div class="docstring">
|
|
126
126
|
<div class="discussion">
|
|
127
127
|
|
|
128
|
-
<p>The
|
|
128
|
+
<p>The API path for the requests</p>
|
|
129
129
|
|
|
130
130
|
|
|
131
131
|
</div>
|
|
@@ -135,13 +135,13 @@
|
|
|
135
135
|
|
|
136
136
|
</div>
|
|
137
137
|
</dt>
|
|
138
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'
|
|
138
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/tls_certificates</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
139
139
|
|
|
140
|
-
<dt id="
|
|
140
|
+
<dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
|
|
141
141
|
<div class="docstring">
|
|
142
142
|
<div class="discussion">
|
|
143
143
|
|
|
144
|
-
<p>The API
|
|
144
|
+
<p>The List Property from the resulting API for list calls</p>
|
|
145
145
|
|
|
146
146
|
|
|
147
147
|
</div>
|
|
@@ -151,7 +151,7 @@
|
|
|
151
151
|
|
|
152
152
|
</div>
|
|
153
153
|
</dt>
|
|
154
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'
|
|
154
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>tls_certificates</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
155
155
|
|
|
156
156
|
</dl>
|
|
157
157
|
|
|
@@ -207,7 +207,7 @@
|
|
|
207
207
|
<li class="public ">
|
|
208
208
|
<span class="summary_signature">
|
|
209
209
|
|
|
210
|
-
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(
|
|
210
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: "", metadata: "", certificate_pem:, private_key_pem:) ⇒ NgrokAPI::Models::TLSCertificate </a>
|
|
211
211
|
|
|
212
212
|
|
|
213
213
|
|
|
@@ -231,7 +231,7 @@
|
|
|
231
231
|
<li class="public ">
|
|
232
232
|
<span class="summary_signature">
|
|
233
233
|
|
|
234
|
-
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id:
|
|
234
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
235
235
|
|
|
236
236
|
|
|
237
237
|
|
|
@@ -246,7 +246,7 @@
|
|
|
246
246
|
|
|
247
247
|
|
|
248
248
|
<span class="summary_desc"><div class='inline'>
|
|
249
|
-
<p>Delete a TLS certificate
|
|
249
|
+
<p>Delete a TLS certificate.</p>
|
|
250
250
|
</div></span>
|
|
251
251
|
|
|
252
252
|
</li>
|
|
@@ -255,7 +255,7 @@
|
|
|
255
255
|
<li class="public ">
|
|
256
256
|
<span class="summary_signature">
|
|
257
257
|
|
|
258
|
-
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id:
|
|
258
|
+
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
259
259
|
|
|
260
260
|
|
|
261
261
|
|
|
@@ -270,7 +270,7 @@
|
|
|
270
270
|
|
|
271
271
|
|
|
272
272
|
<span class="summary_desc"><div class='inline'>
|
|
273
|
-
<p>Delete a TLS certificate
|
|
273
|
+
<p>Delete a TLS certificate Throws an exception if API error.</p>
|
|
274
274
|
</div></span>
|
|
275
275
|
|
|
276
276
|
</li>
|
|
@@ -279,7 +279,7 @@
|
|
|
279
279
|
<li class="public ">
|
|
280
280
|
<span class="summary_signature">
|
|
281
281
|
|
|
282
|
-
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id:
|
|
282
|
+
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: "") ⇒ NgrokAPI::Models::TLSCertificate </a>
|
|
283
283
|
|
|
284
284
|
|
|
285
285
|
|
|
@@ -294,7 +294,7 @@
|
|
|
294
294
|
|
|
295
295
|
|
|
296
296
|
<span class="summary_desc"><div class='inline'>
|
|
297
|
-
<p>Get detailed information about a TLS certificate
|
|
297
|
+
<p>Get detailed information about a TLS certificate.</p>
|
|
298
298
|
</div></span>
|
|
299
299
|
|
|
300
300
|
</li>
|
|
@@ -303,7 +303,7 @@
|
|
|
303
303
|
<li class="public ">
|
|
304
304
|
<span class="summary_signature">
|
|
305
305
|
|
|
306
|
-
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id:
|
|
306
|
+
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: "") ⇒ NgrokAPI::Models::TLSCertificate </a>
|
|
307
307
|
|
|
308
308
|
|
|
309
309
|
|
|
@@ -318,7 +318,7 @@
|
|
|
318
318
|
|
|
319
319
|
|
|
320
320
|
<span class="summary_desc"><div class='inline'>
|
|
321
|
-
<p>Get detailed information about a TLS certificate
|
|
321
|
+
<p>Get detailed information about a TLS certificate Throws an exception if API error.</p>
|
|
322
322
|
</div></span>
|
|
323
323
|
|
|
324
324
|
</li>
|
|
@@ -327,7 +327,7 @@
|
|
|
327
327
|
<li class="public ">
|
|
328
328
|
<span class="summary_signature">
|
|
329
329
|
|
|
330
|
-
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒
|
|
330
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒ TLSCertificatesClient </a>
|
|
331
331
|
|
|
332
332
|
|
|
333
333
|
|
|
@@ -344,7 +344,7 @@
|
|
|
344
344
|
|
|
345
345
|
|
|
346
346
|
<span class="summary_desc"><div class='inline'>
|
|
347
|
-
<p>A new instance of
|
|
347
|
+
<p>A new instance of TLSCertificatesClient.</p>
|
|
348
348
|
</div></span>
|
|
349
349
|
|
|
350
350
|
</li>
|
|
@@ -377,7 +377,7 @@
|
|
|
377
377
|
<li class="public ">
|
|
378
378
|
<span class="summary_signature">
|
|
379
379
|
|
|
380
|
-
<a href="#
|
|
380
|
+
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
381
381
|
|
|
382
382
|
|
|
383
383
|
|
|
@@ -392,7 +392,7 @@
|
|
|
392
392
|
|
|
393
393
|
|
|
394
394
|
<span class="summary_desc"><div class='inline'>
|
|
395
|
-
<p>
|
|
395
|
+
<p>List all TLS certificates on this account Throws an exception if API error.</p>
|
|
396
396
|
</div></span>
|
|
397
397
|
|
|
398
398
|
</li>
|
|
@@ -401,7 +401,7 @@
|
|
|
401
401
|
<li class="public ">
|
|
402
402
|
<span class="summary_signature">
|
|
403
403
|
|
|
404
|
-
<a href="#update
|
|
404
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::TLSCertificate </a>
|
|
405
405
|
|
|
406
406
|
|
|
407
407
|
|
|
@@ -419,6 +419,30 @@
|
|
|
419
419
|
<p>Update attributes of a TLS Certificate by ID.</p>
|
|
420
420
|
</div></span>
|
|
421
421
|
|
|
422
|
+
</li>
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
<li class="public ">
|
|
426
|
+
<span class="summary_signature">
|
|
427
|
+
|
|
428
|
+
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::TLSCertificate </a>
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
</span>
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
<span class="summary_desc"><div class='inline'>
|
|
443
|
+
<p>Update attributes of a TLS Certificate by ID Throws an exception if API error.</p>
|
|
444
|
+
</div></span>
|
|
445
|
+
|
|
422
446
|
</li>
|
|
423
447
|
|
|
424
448
|
|
|
@@ -431,7 +455,7 @@
|
|
|
431
455
|
<div class="method_details first">
|
|
432
456
|
<h3 class="signature first" id="initialize-instance_method">
|
|
433
457
|
|
|
434
|
-
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::
|
|
458
|
+
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::TLSCertificatesClient (class)">TLSCertificatesClient</a></span></tt>
|
|
435
459
|
|
|
436
460
|
|
|
437
461
|
|
|
@@ -440,7 +464,7 @@
|
|
|
440
464
|
</h3><div class="docstring">
|
|
441
465
|
<div class="discussion">
|
|
442
466
|
|
|
443
|
-
<p>Returns a new instance of
|
|
467
|
+
<p>Returns a new instance of TLSCertificatesClient.</p>
|
|
444
468
|
|
|
445
469
|
|
|
446
470
|
</div>
|
|
@@ -454,15 +478,15 @@
|
|
|
454
478
|
<pre class="lines">
|
|
455
479
|
|
|
456
480
|
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
481
|
+
21
|
|
482
|
+
22
|
|
483
|
+
23</pre>
|
|
460
484
|
</td>
|
|
461
485
|
<td>
|
|
462
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line
|
|
486
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 21</span>
|
|
463
487
|
|
|
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>
|
|
488
|
+
<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>
|
|
489
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
466
490
|
<span class='kw'>end</span></pre>
|
|
467
491
|
</td>
|
|
468
492
|
</tr>
|
|
@@ -502,12 +526,12 @@
|
|
|
502
526
|
<pre class="lines">
|
|
503
527
|
|
|
504
528
|
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
529
|
+
19
|
|
530
|
+
20
|
|
531
|
+
21</pre>
|
|
508
532
|
</td>
|
|
509
533
|
<td>
|
|
510
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line
|
|
534
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 19</span>
|
|
511
535
|
|
|
512
536
|
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
|
513
537
|
<span class='ivar'>@client</span>
|
|
@@ -527,7 +551,7 @@
|
|
|
527
551
|
<div class="method_details first">
|
|
528
552
|
<h3 class="signature first" id="create-instance_method">
|
|
529
553
|
|
|
530
|
-
#<strong>create</strong>(
|
|
554
|
+
#<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
555
|
|
|
532
556
|
|
|
533
557
|
|
|
@@ -536,7 +560,7 @@
|
|
|
536
560
|
</h3><div class="docstring">
|
|
537
561
|
<div class="discussion">
|
|
538
562
|
|
|
539
|
-
<p>Upload a new TLS certificate
|
|
563
|
+
<p>Upload a new TLS certificate</p>
|
|
540
564
|
|
|
541
565
|
<p><a href="https://ngrok.com/docs/api#api-tls-certificates-create">ngrok.com/docs/api#api-tls-certificates-create</a></p>
|
|
542
566
|
|
|
@@ -555,7 +579,7 @@
|
|
|
555
579
|
<span class='type'>(<tt>string</tt>)</span>
|
|
556
580
|
|
|
557
581
|
|
|
558
|
-
<em class="default">(defaults to: <tt
|
|
582
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
559
583
|
|
|
560
584
|
|
|
561
585
|
—
|
|
@@ -573,7 +597,7 @@
|
|
|
573
597
|
<span class='type'>(<tt>string</tt>)</span>
|
|
574
598
|
|
|
575
599
|
|
|
576
|
-
<em class="default">(defaults to: <tt
|
|
600
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
577
601
|
|
|
578
602
|
|
|
579
603
|
—
|
|
@@ -591,12 +615,10 @@
|
|
|
591
615
|
<span class='type'>(<tt>string</tt>)</span>
|
|
592
616
|
|
|
593
617
|
|
|
594
|
-
<em class="default">(defaults to: <tt>''</tt>)</em>
|
|
595
|
-
|
|
596
618
|
|
|
597
619
|
—
|
|
598
620
|
<div class='inline'>
|
|
599
|
-
<p>chain of PEM-encoded certificates, leaf first. See
|
|
621
|
+
<p>chain of PEM-encoded certificates, leaf first. See <code>Certificate Bundles</code> <a href="https://ngrok.com/docs/api#tls-certificates-pem`_">ngrok.com/docs/api#tls-certificates-pem`_</a>.</p>
|
|
600
622
|
</div>
|
|
601
623
|
|
|
602
624
|
</li>
|
|
@@ -609,12 +631,10 @@
|
|
|
609
631
|
<span class='type'>(<tt>string</tt>)</span>
|
|
610
632
|
|
|
611
633
|
|
|
612
|
-
<em class="default">(defaults to: <tt>''</tt>)</em>
|
|
613
|
-
|
|
614
634
|
|
|
615
635
|
—
|
|
616
636
|
<div class='inline'>
|
|
617
|
-
<p>private key for the TLS certificate, PEM-encoded. See
|
|
637
|
+
<p>private key for the TLS certificate, PEM-encoded. See <code>Private Keys</code> <a href="https://ngrok.com/docs/ngrok-link#tls-certificates-key`_">ngrok.com/docs/ngrok-link#tls-certificates-key`_</a>.</p>
|
|
618
638
|
</div>
|
|
619
639
|
|
|
620
640
|
</li>
|
|
@@ -627,13 +647,13 @@
|
|
|
627
647
|
<li>
|
|
628
648
|
|
|
629
649
|
|
|
630
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
|
650
|
+
<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
651
|
|
|
632
652
|
|
|
633
653
|
|
|
634
654
|
—
|
|
635
655
|
<div class='inline'>
|
|
636
|
-
<p>result from
|
|
656
|
+
<p>result from the API request</p>
|
|
637
657
|
</div>
|
|
638
658
|
|
|
639
659
|
</li>
|
|
@@ -646,8 +666,6 @@
|
|
|
646
666
|
<pre class="lines">
|
|
647
667
|
|
|
648
668
|
|
|
649
|
-
33
|
|
650
|
-
34
|
|
651
669
|
35
|
|
652
670
|
36
|
|
653
671
|
37
|
|
@@ -659,26 +677,22 @@
|
|
|
659
677
|
43
|
|
660
678
|
44
|
|
661
679
|
45
|
|
662
|
-
46
|
|
663
|
-
47</pre>
|
|
680
|
+
46</pre>
|
|
664
681
|
</td>
|
|
665
682
|
<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='
|
|
670
|
-
<span class='
|
|
671
|
-
<span class='
|
|
672
|
-
<span class='
|
|
673
|
-
<span class='
|
|
674
|
-
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='
|
|
675
|
-
|
|
676
|
-
|
|
677
|
-
|
|
678
|
-
|
|
679
|
-
<span class='rbrace'>}</span>
|
|
680
|
-
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::TlsCertificatesClient::PATH (constant)">PATH</a></span></span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
681
|
-
<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>
|
|
683
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 35</span>
|
|
684
|
+
|
|
685
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>certificate_pem:</span><span class='comma'>,</span> <span class='label'>private_key_pem:</span><span class='rparen'>)</span>
|
|
686
|
+
<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>
|
|
687
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
688
|
+
<span class='rbrace'>}</span>
|
|
689
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
690
|
+
<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>
|
|
691
|
+
<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>
|
|
692
|
+
<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>
|
|
693
|
+
<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>
|
|
694
|
+
<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>
|
|
695
|
+
<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
696
|
<span class='kw'>end</span></pre>
|
|
683
697
|
</td>
|
|
684
698
|
</tr>
|
|
@@ -688,7 +702,7 @@
|
|
|
688
702
|
<div class="method_details ">
|
|
689
703
|
<h3 class="signature " id="delete-instance_method">
|
|
690
704
|
|
|
691
|
-
#<strong>delete</strong>(id:
|
|
705
|
+
#<strong>delete</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
692
706
|
|
|
693
707
|
|
|
694
708
|
|
|
@@ -697,7 +711,7 @@
|
|
|
697
711
|
</h3><div class="docstring">
|
|
698
712
|
<div class="discussion">
|
|
699
713
|
|
|
700
|
-
<p>Delete a TLS certificate
|
|
714
|
+
<p>Delete a TLS certificate</p>
|
|
701
715
|
|
|
702
716
|
<p><a href="https://ngrok.com/docs/api#api-tls-certificates-delete">ngrok.com/docs/api#api-tls-certificates-delete</a></p>
|
|
703
717
|
|
|
@@ -716,7 +730,7 @@
|
|
|
716
730
|
<span class='type'>(<tt>string</tt>)</span>
|
|
717
731
|
|
|
718
732
|
|
|
719
|
-
<em class="default">(defaults to: <tt
|
|
733
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
720
734
|
|
|
721
735
|
|
|
722
736
|
—
|
|
@@ -734,13 +748,13 @@
|
|
|
734
748
|
<li>
|
|
735
749
|
|
|
736
750
|
|
|
737
|
-
<span class='type'>(<tt>
|
|
751
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
738
752
|
|
|
739
753
|
|
|
740
754
|
|
|
741
755
|
—
|
|
742
756
|
<div class='inline'>
|
|
743
|
-
<p>result from
|
|
757
|
+
<p>result from the API request</p>
|
|
744
758
|
</div>
|
|
745
759
|
|
|
746
760
|
</li>
|
|
@@ -753,15 +767,23 @@
|
|
|
753
767
|
<pre class="lines">
|
|
754
768
|
|
|
755
769
|
|
|
770
|
+
55
|
|
771
|
+
56
|
|
756
772
|
57
|
|
757
773
|
58
|
|
758
|
-
59
|
|
774
|
+
59
|
|
775
|
+
60
|
|
776
|
+
61</pre>
|
|
759
777
|
</td>
|
|
760
778
|
<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><span class='label'>id:</span> <span class='
|
|
764
|
-
<span class='
|
|
779
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 55</span>
|
|
780
|
+
|
|
781
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
782
|
+
<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>
|
|
783
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
784
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
785
|
+
<span class='rbrace'>}</span>
|
|
786
|
+
<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
787
|
<span class='kw'>end</span></pre>
|
|
766
788
|
</td>
|
|
767
789
|
</tr>
|
|
@@ -771,7 +793,7 @@
|
|
|
771
793
|
<div class="method_details ">
|
|
772
794
|
<h3 class="signature " id="delete!-instance_method">
|
|
773
795
|
|
|
774
|
-
#<strong>delete!</strong>(id:
|
|
796
|
+
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
775
797
|
|
|
776
798
|
|
|
777
799
|
|
|
@@ -780,7 +802,7 @@
|
|
|
780
802
|
</h3><div class="docstring">
|
|
781
803
|
<div class="discussion">
|
|
782
804
|
|
|
783
|
-
<p>Delete a TLS certificate
|
|
805
|
+
<p>Delete a TLS certificate Throws an exception if API error.</p>
|
|
784
806
|
|
|
785
807
|
<p><a href="https://ngrok.com/docs/api#api-tls-certificates-delete">ngrok.com/docs/api#api-tls-certificates-delete</a></p>
|
|
786
808
|
|
|
@@ -799,7 +821,7 @@
|
|
|
799
821
|
<span class='type'>(<tt>string</tt>)</span>
|
|
800
822
|
|
|
801
823
|
|
|
802
|
-
<em class="default">(defaults to: <tt
|
|
824
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
803
825
|
|
|
804
826
|
|
|
805
827
|
—
|
|
@@ -817,13 +839,13 @@
|
|
|
817
839
|
<li>
|
|
818
840
|
|
|
819
841
|
|
|
820
|
-
<span class='type'>(<tt>
|
|
842
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
821
843
|
|
|
822
844
|
|
|
823
845
|
|
|
824
846
|
—
|
|
825
847
|
<div class='inline'>
|
|
826
|
-
<p>result from
|
|
848
|
+
<p>result from the API request</p>
|
|
827
849
|
</div>
|
|
828
850
|
|
|
829
851
|
</li>
|
|
@@ -836,15 +858,23 @@
|
|
|
836
858
|
<pre class="lines">
|
|
837
859
|
|
|
838
860
|
|
|
839
|
-
|
|
840
|
-
|
|
841
|
-
|
|
861
|
+
71
|
|
862
|
+
72
|
|
863
|
+
73
|
|
864
|
+
74
|
|
865
|
+
75
|
|
866
|
+
76
|
|
867
|
+
77</pre>
|
|
842
868
|
</td>
|
|
843
869
|
<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><span class='label'>id:</span> <span class='
|
|
847
|
-
<span class='
|
|
870
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 71</span>
|
|
871
|
+
|
|
872
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
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,27 @@
|
|
|
919
949
|
<pre class="lines">
|
|
920
950
|
|
|
921
951
|
|
|
922
|
-
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
|
|
952
|
+
86
|
|
953
|
+
87
|
|
954
|
+
88
|
|
955
|
+
89
|
|
956
|
+
90
|
|
957
|
+
91
|
|
958
|
+
92
|
|
959
|
+
93
|
|
960
|
+
94</pre>
|
|
926
961
|
</td>
|
|
927
962
|
<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><span class='label'>id:</span> <span class='
|
|
931
|
-
<span class='id identifier
|
|
932
|
-
<span class='
|
|
963
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 86</span>
|
|
964
|
+
|
|
965
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
966
|
+
<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>
|
|
967
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
968
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
969
|
+
<span class='rbrace'>}</span>
|
|
970
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
971
|
+
<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>
|
|
972
|
+
<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
973
|
<span class='kw'>end</span></pre>
|
|
934
974
|
</td>
|
|
935
975
|
</tr>
|
|
@@ -939,7 +979,7 @@
|
|
|
939
979
|
<div class="method_details ">
|
|
940
980
|
<h3 class="signature " id="get!-instance_method">
|
|
941
981
|
|
|
942
|
-
#<strong>get!</strong>(id:
|
|
982
|
+
#<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
983
|
|
|
944
984
|
|
|
945
985
|
|
|
@@ -948,7 +988,7 @@
|
|
|
948
988
|
</h3><div class="docstring">
|
|
949
989
|
<div class="discussion">
|
|
950
990
|
|
|
951
|
-
<p>Get detailed information about a TLS certificate
|
|
991
|
+
<p>Get detailed information about a TLS certificate Throws an exception if API error.</p>
|
|
952
992
|
|
|
953
993
|
<p><a href="https://ngrok.com/docs/api#api-tls-certificates-get">ngrok.com/docs/api#api-tls-certificates-get</a></p>
|
|
954
994
|
|
|
@@ -967,7 +1007,7 @@
|
|
|
967
1007
|
<span class='type'>(<tt>string</tt>)</span>
|
|
968
1008
|
|
|
969
1009
|
|
|
970
|
-
<em class="default">(defaults to: <tt
|
|
1010
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
971
1011
|
|
|
972
1012
|
|
|
973
1013
|
—
|
|
@@ -985,13 +1025,13 @@
|
|
|
985
1025
|
<li>
|
|
986
1026
|
|
|
987
1027
|
|
|
988
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
|
1028
|
+
<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
1029
|
|
|
990
1030
|
|
|
991
1031
|
|
|
992
1032
|
—
|
|
993
1033
|
<div class='inline'>
|
|
994
|
-
<p>result from
|
|
1034
|
+
<p>result from the API request</p>
|
|
995
1035
|
</div>
|
|
996
1036
|
|
|
997
1037
|
</li>
|
|
@@ -1004,17 +1044,27 @@
|
|
|
1004
1044
|
<pre class="lines">
|
|
1005
1045
|
|
|
1006
1046
|
|
|
1007
|
-
|
|
1008
|
-
|
|
1009
|
-
|
|
1010
|
-
|
|
1047
|
+
104
|
|
1048
|
+
105
|
|
1049
|
+
106
|
|
1050
|
+
107
|
|
1051
|
+
108
|
|
1052
|
+
109
|
|
1053
|
+
110
|
|
1054
|
+
111
|
|
1055
|
+
112</pre>
|
|
1011
1056
|
</td>
|
|
1012
1057
|
<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><span class='label'>id:</span> <span class='
|
|
1016
|
-
<span class='id identifier
|
|
1017
|
-
<span class='
|
|
1058
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 104</span>
|
|
1059
|
+
|
|
1060
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1061
|
+
<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>
|
|
1062
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1063
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1064
|
+
<span class='rbrace'>}</span>
|
|
1065
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1066
|
+
<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>
|
|
1067
|
+
<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
1068
|
<span class='kw'>end</span></pre>
|
|
1019
1069
|
</td>
|
|
1020
1070
|
</tr>
|
|
@@ -1033,7 +1083,7 @@
|
|
|
1033
1083
|
</h3><div class="docstring">
|
|
1034
1084
|
<div class="discussion">
|
|
1035
1085
|
|
|
1036
|
-
<p>List all TLS certificates on this account
|
|
1086
|
+
<p>List all TLS certificates on this account</p>
|
|
1037
1087
|
|
|
1038
1088
|
<p><a href="https://ngrok.com/docs/api#api-tls-certificates-list">ngrok.com/docs/api#api-tls-certificates-list</a></p>
|
|
1039
1089
|
|
|
@@ -1062,7 +1112,7 @@
|
|
|
1062
1112
|
<span class='name'>limit</span>
|
|
1063
1113
|
|
|
1064
1114
|
|
|
1065
|
-
<span class='type'>(<tt>
|
|
1115
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1066
1116
|
|
|
1067
1117
|
|
|
1068
1118
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -1102,7 +1152,7 @@
|
|
|
1102
1152
|
|
|
1103
1153
|
—
|
|
1104
1154
|
<div class='inline'>
|
|
1105
|
-
<p>the
|
|
1155
|
+
<p>result from the API request</p>
|
|
1106
1156
|
</div>
|
|
1107
1157
|
|
|
1108
1158
|
</li>
|
|
@@ -1115,27 +1165,180 @@
|
|
|
1115
1165
|
<pre class="lines">
|
|
1116
1166
|
|
|
1117
1167
|
|
|
1118
|
-
|
|
1119
|
-
|
|
1120
|
-
|
|
1121
|
-
|
|
1122
|
-
|
|
1123
|
-
|
|
1124
|
-
|
|
1125
|
-
|
|
1126
|
-
|
|
1168
|
+
123
|
|
1169
|
+
124
|
|
1170
|
+
125
|
|
1171
|
+
126
|
|
1172
|
+
127
|
|
1173
|
+
128
|
|
1174
|
+
129
|
|
1175
|
+
130
|
|
1176
|
+
131
|
|
1177
|
+
132
|
|
1178
|
+
133
|
|
1179
|
+
134
|
|
1180
|
+
135
|
|
1181
|
+
136
|
|
1182
|
+
137
|
|
1183
|
+
138</pre>
|
|
1127
1184
|
</td>
|
|
1128
1185
|
<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><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1132
|
-
|
|
1133
|
-
<span class='
|
|
1134
|
-
<span class='label'>
|
|
1135
|
-
<span class='label'>
|
|
1136
|
-
<span class='label'>
|
|
1137
|
-
<span class='label'>
|
|
1138
|
-
<span class='rparen'>)</span>
|
|
1186
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 123</span>
|
|
1187
|
+
|
|
1188
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1189
|
+
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1190
|
+
<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>
|
|
1191
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1192
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1193
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1194
|
+
<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>
|
|
1195
|
+
<span class='rparen'>)</span>
|
|
1196
|
+
|
|
1197
|
+
<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>
|
|
1198
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1199
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1200
|
+
<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>
|
|
1201
|
+
<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>
|
|
1202
|
+
<span class='rparen'>)</span>
|
|
1203
|
+
<span class='kw'>end</span></pre>
|
|
1204
|
+
</td>
|
|
1205
|
+
</tr>
|
|
1206
|
+
</table>
|
|
1207
|
+
</div>
|
|
1208
|
+
|
|
1209
|
+
<div class="method_details ">
|
|
1210
|
+
<h3 class="signature " id="list!-instance_method">
|
|
1211
|
+
|
|
1212
|
+
#<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>
|
|
1213
|
+
|
|
1214
|
+
|
|
1215
|
+
|
|
1216
|
+
|
|
1217
|
+
|
|
1218
|
+
</h3><div class="docstring">
|
|
1219
|
+
<div class="discussion">
|
|
1220
|
+
|
|
1221
|
+
<p>List all TLS certificates on this account Throws an exception if API error.</p>
|
|
1222
|
+
|
|
1223
|
+
<p><a href="https://ngrok.com/docs/api#api-tls-certificates-list">ngrok.com/docs/api#api-tls-certificates-list</a></p>
|
|
1224
|
+
|
|
1225
|
+
|
|
1226
|
+
</div>
|
|
1227
|
+
</div>
|
|
1228
|
+
<div class="tags">
|
|
1229
|
+
<p class="tag_title">Parameters:</p>
|
|
1230
|
+
<ul class="param">
|
|
1231
|
+
|
|
1232
|
+
<li>
|
|
1233
|
+
|
|
1234
|
+
<span class='name'>before_id</span>
|
|
1235
|
+
|
|
1236
|
+
|
|
1237
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1238
|
+
|
|
1239
|
+
|
|
1240
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1241
|
+
|
|
1242
|
+
|
|
1243
|
+
</li>
|
|
1244
|
+
|
|
1245
|
+
<li>
|
|
1246
|
+
|
|
1247
|
+
<span class='name'>limit</span>
|
|
1248
|
+
|
|
1249
|
+
|
|
1250
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1251
|
+
|
|
1252
|
+
|
|
1253
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1254
|
+
|
|
1255
|
+
|
|
1256
|
+
</li>
|
|
1257
|
+
|
|
1258
|
+
<li>
|
|
1259
|
+
|
|
1260
|
+
<span class='name'>url</span>
|
|
1261
|
+
|
|
1262
|
+
|
|
1263
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1264
|
+
|
|
1265
|
+
|
|
1266
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1267
|
+
|
|
1268
|
+
|
|
1269
|
+
—
|
|
1270
|
+
<div class='inline'>
|
|
1271
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
1272
|
+
</div>
|
|
1273
|
+
|
|
1274
|
+
</li>
|
|
1275
|
+
|
|
1276
|
+
</ul>
|
|
1277
|
+
|
|
1278
|
+
<p class="tag_title">Returns:</p>
|
|
1279
|
+
<ul class="return">
|
|
1280
|
+
|
|
1281
|
+
<li>
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
<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>
|
|
1285
|
+
|
|
1286
|
+
|
|
1287
|
+
|
|
1288
|
+
—
|
|
1289
|
+
<div class='inline'>
|
|
1290
|
+
<p>result from the API request</p>
|
|
1291
|
+
</div>
|
|
1292
|
+
|
|
1293
|
+
</li>
|
|
1294
|
+
|
|
1295
|
+
</ul>
|
|
1296
|
+
|
|
1297
|
+
</div><table class="source_code">
|
|
1298
|
+
<tr>
|
|
1299
|
+
<td>
|
|
1300
|
+
<pre class="lines">
|
|
1301
|
+
|
|
1302
|
+
|
|
1303
|
+
150
|
|
1304
|
+
151
|
|
1305
|
+
152
|
|
1306
|
+
153
|
|
1307
|
+
154
|
|
1308
|
+
155
|
|
1309
|
+
156
|
|
1310
|
+
157
|
|
1311
|
+
158
|
|
1312
|
+
159
|
|
1313
|
+
160
|
|
1314
|
+
161
|
|
1315
|
+
162
|
|
1316
|
+
163
|
|
1317
|
+
164
|
|
1318
|
+
165
|
|
1319
|
+
166
|
|
1320
|
+
167</pre>
|
|
1321
|
+
</td>
|
|
1322
|
+
<td>
|
|
1323
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 150</span>
|
|
1324
|
+
|
|
1325
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1326
|
+
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1327
|
+
<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>
|
|
1328
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1329
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1330
|
+
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
|
1331
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1332
|
+
<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>
|
|
1333
|
+
<span class='rparen'>)</span>
|
|
1334
|
+
|
|
1335
|
+
<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>
|
|
1336
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1337
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1338
|
+
<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>
|
|
1339
|
+
<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><span class='comma'>,</span>
|
|
1340
|
+
<span class='label'>danger:</span> <span class='kw'>true</span>
|
|
1341
|
+
<span class='rparen'>)</span>
|
|
1139
1342
|
<span class='kw'>end</span></pre>
|
|
1140
1343
|
</td>
|
|
1141
1344
|
</tr>
|
|
@@ -1145,7 +1348,7 @@
|
|
|
1145
1348
|
<div class="method_details ">
|
|
1146
1349
|
<h3 class="signature " id="update-instance_method">
|
|
1147
1350
|
|
|
1148
|
-
#<strong>update</strong>(id:
|
|
1351
|
+
#<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
1352
|
|
|
1150
1353
|
|
|
1151
1354
|
|
|
@@ -1154,7 +1357,7 @@
|
|
|
1154
1357
|
</h3><div class="docstring">
|
|
1155
1358
|
<div class="discussion">
|
|
1156
1359
|
|
|
1157
|
-
<p>Update attributes of a TLS Certificate by ID
|
|
1360
|
+
<p>Update attributes of a TLS Certificate by ID</p>
|
|
1158
1361
|
|
|
1159
1362
|
<p><a href="https://ngrok.com/docs/api#api-tls-certificates-update">ngrok.com/docs/api#api-tls-certificates-update</a></p>
|
|
1160
1363
|
|
|
@@ -1173,7 +1376,7 @@
|
|
|
1173
1376
|
<span class='type'>(<tt>string</tt>)</span>
|
|
1174
1377
|
|
|
1175
1378
|
|
|
1176
|
-
<em class="default">(defaults to: <tt
|
|
1379
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1177
1380
|
|
|
1178
1381
|
|
|
1179
1382
|
</li>
|
|
@@ -1222,13 +1425,13 @@
|
|
|
1222
1425
|
<li>
|
|
1223
1426
|
|
|
1224
1427
|
|
|
1225
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
|
1428
|
+
<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
1429
|
|
|
1227
1430
|
|
|
1228
1431
|
|
|
1229
1432
|
—
|
|
1230
1433
|
<div class='inline'>
|
|
1231
|
-
<p>result from
|
|
1434
|
+
<p>result from the API request</p>
|
|
1232
1435
|
</div>
|
|
1233
1436
|
|
|
1234
1437
|
</li>
|
|
@@ -1241,31 +1444,31 @@
|
|
|
1241
1444
|
<pre class="lines">
|
|
1242
1445
|
|
|
1243
1446
|
|
|
1244
|
-
|
|
1245
|
-
|
|
1246
|
-
|
|
1247
|
-
|
|
1248
|
-
|
|
1249
|
-
|
|
1250
|
-
|
|
1251
|
-
|
|
1252
|
-
|
|
1253
|
-
|
|
1254
|
-
|
|
1447
|
+
178
|
|
1448
|
+
179
|
|
1449
|
+
180
|
|
1450
|
+
181
|
|
1451
|
+
182
|
|
1452
|
+
183
|
|
1453
|
+
184
|
|
1454
|
+
185
|
|
1455
|
+
186
|
|
1456
|
+
187
|
|
1457
|
+
188</pre>
|
|
1255
1458
|
</td>
|
|
1256
1459
|
<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='
|
|
1261
|
-
<span class='
|
|
1262
|
-
|
|
1263
|
-
<span class='
|
|
1264
|
-
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1265
|
-
<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>
|
|
1266
|
-
<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>
|
|
1267
|
-
<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='
|
|
1268
|
-
<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/
|
|
1460
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 178</span>
|
|
1461
|
+
|
|
1462
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1463
|
+
<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>
|
|
1464
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1465
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1466
|
+
<span class='rbrace'>}</span>
|
|
1467
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1468
|
+
<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>
|
|
1469
|
+
<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>
|
|
1470
|
+
<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>
|
|
1471
|
+
<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
1472
|
<span class='kw'>end</span></pre>
|
|
1270
1473
|
</td>
|
|
1271
1474
|
</tr>
|
|
@@ -1275,7 +1478,7 @@
|
|
|
1275
1478
|
<div class="method_details ">
|
|
1276
1479
|
<h3 class="signature " id="update!-instance_method">
|
|
1277
1480
|
|
|
1278
|
-
#<strong>update!</strong>(id:
|
|
1481
|
+
#<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
1482
|
|
|
1280
1483
|
|
|
1281
1484
|
|
|
@@ -1284,7 +1487,7 @@
|
|
|
1284
1487
|
</h3><div class="docstring">
|
|
1285
1488
|
<div class="discussion">
|
|
1286
1489
|
|
|
1287
|
-
<p>Update attributes of a TLS Certificate by ID
|
|
1490
|
+
<p>Update attributes of a TLS Certificate by ID Throws an exception if API error.</p>
|
|
1288
1491
|
|
|
1289
1492
|
<p><a href="https://ngrok.com/docs/api#api-tls-certificates-update">ngrok.com/docs/api#api-tls-certificates-update</a></p>
|
|
1290
1493
|
|
|
@@ -1303,7 +1506,7 @@
|
|
|
1303
1506
|
<span class='type'>(<tt>string</tt>)</span>
|
|
1304
1507
|
|
|
1305
1508
|
|
|
1306
|
-
<em class="default">(defaults to: <tt
|
|
1509
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1307
1510
|
|
|
1308
1511
|
|
|
1309
1512
|
</li>
|
|
@@ -1352,13 +1555,13 @@
|
|
|
1352
1555
|
<li>
|
|
1353
1556
|
|
|
1354
1557
|
|
|
1355
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
|
1558
|
+
<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
1559
|
|
|
1357
1560
|
|
|
1358
1561
|
|
|
1359
1562
|
—
|
|
1360
1563
|
<div class='inline'>
|
|
1361
|
-
<p>result from
|
|
1564
|
+
<p>result from the API request</p>
|
|
1362
1565
|
</div>
|
|
1363
1566
|
|
|
1364
1567
|
</li>
|
|
@@ -1371,31 +1574,31 @@
|
|
|
1371
1574
|
<pre class="lines">
|
|
1372
1575
|
|
|
1373
1576
|
|
|
1374
|
-
|
|
1375
|
-
|
|
1376
|
-
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
|
|
1380
|
-
|
|
1381
|
-
|
|
1382
|
-
|
|
1383
|
-
|
|
1384
|
-
|
|
1577
|
+
200
|
|
1578
|
+
201
|
|
1579
|
+
202
|
|
1580
|
+
203
|
|
1581
|
+
204
|
|
1582
|
+
205
|
|
1583
|
+
206
|
|
1584
|
+
207
|
|
1585
|
+
208
|
|
1586
|
+
209
|
|
1587
|
+
210</pre>
|
|
1385
1588
|
</td>
|
|
1386
1589
|
<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='
|
|
1391
|
-
<span class='
|
|
1392
|
-
|
|
1393
|
-
<span class='
|
|
1394
|
-
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1395
|
-
<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>
|
|
1396
|
-
<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>
|
|
1397
|
-
<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='
|
|
1398
|
-
<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/
|
|
1590
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/tls_certificates_client.rb', line 200</span>
|
|
1591
|
+
|
|
1592
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1593
|
+
<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>
|
|
1594
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1595
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1596
|
+
<span class='rbrace'>}</span>
|
|
1597
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1598
|
+
<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>
|
|
1599
|
+
<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>
|
|
1600
|
+
<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>
|
|
1601
|
+
<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
1602
|
<span class='kw'>end</span></pre>
|
|
1400
1603
|
</td>
|
|
1401
1604
|
</tr>
|
|
@@ -1407,9 +1610,9 @@
|
|
|
1407
1610
|
</div>
|
|
1408
1611
|
|
|
1409
1612
|
<div id="footer">
|
|
1410
|
-
Generated on
|
|
1613
|
+
Generated on Thu Dec 2 18:48:55 2021 by
|
|
1411
1614
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1412
|
-
0.9.
|
|
1615
|
+
0.9.27 (ruby-3.0.1).
|
|
1413
1616
|
</div>
|
|
1414
1617
|
|
|
1415
1618
|
</div>
|