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