ngrok-api 0.9.0 → 0.12.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rubocop.yml +1 -1
- data/doc/.gitkeep +0 -0
- data/doc/NgrokAPI/Client.html +1499 -125
- data/doc/NgrokAPI/Error.html +1 -1
- data/doc/NgrokAPI/Errors/NotFoundError.html +1 -1
- data/doc/NgrokAPI/Errors.html +1 -1
- data/doc/NgrokAPI/HttpClient.html +1 -1
- data/doc/NgrokAPI/Models/{ApiKey.html → APIKey.html} +108 -177
- data/doc/NgrokAPI/Models/AWSAuth.html +617 -0
- data/doc/NgrokAPI/Models/AWSCredentials.html +617 -0
- data/doc/NgrokAPI/Models/AWSRole.html +543 -0
- data/doc/NgrokAPI/Models/AbuseReport.html +987 -0
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +617 -0
- data/doc/NgrokAPI/Models/CertificateAuthority.html +1439 -0
- data/doc/NgrokAPI/Models/Credential.html +1149 -0
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +913 -0
- data/doc/NgrokAPI/Models/EndpointCompression.html +543 -0
- data/doc/NgrokAPI/Models/EndpointConfiguration.html +1321 -510
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +617 -0
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointLogging.html +617 -0
- data/doc/NgrokAPI/Models/EndpointLoggingMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +617 -0
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointOAuth.html +987 -0
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +987 -0
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +765 -0
- data/doc/NgrokAPI/Models/EndpointOIDC.html +1135 -0
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +691 -0
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +691 -0
- data/doc/NgrokAPI/Models/EndpointSAML.html +1653 -0
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +1283 -0
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +691 -0
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +691 -0
- data/doc/NgrokAPI/Models/EventDestination.html +1058 -0
- data/doc/NgrokAPI/Models/EventSource.html +765 -0
- data/doc/NgrokAPI/Models/EventSourceReplace.html +691 -0
- data/doc/NgrokAPI/Models/EventStream.html +1309 -0
- data/doc/NgrokAPI/Models/EventSubscription.html +1058 -0
- data/doc/NgrokAPI/Models/EventTarget.html +765 -0
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +617 -0
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +617 -0
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +617 -0
- data/doc/NgrokAPI/Models/IPPolicy.html +1069 -0
- data/doc/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/doc/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/doc/NgrokAPI/Models/{TlsCertificate.html → IPWhitelistEntry.html} +168 -163
- data/doc/NgrokAPI/Models/Listable.html +1 -1
- data/doc/NgrokAPI/Models/Ref.html +617 -0
- data/doc/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/doc/NgrokAPI/Models/ReservedDomain.html +111 -1107
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +839 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertNSTarget.html +617 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +617 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +617 -0
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +1143 -0
- data/doc/NgrokAPI/Models/SSHCredential.html +1149 -0
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +1513 -0
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +1661 -0
- data/doc/NgrokAPI/Models/TLSCertificate.html +2179 -0
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +617 -0
- data/doc/NgrokAPI/Models/Tunnel.html +987 -0
- data/doc/NgrokAPI/Models/TunnelSession.html +1209 -0
- data/doc/NgrokAPI/Models.html +4 -4
- data/doc/NgrokAPI/PagedIterator.html +1 -1
- data/{docs/NgrokAPI/Services/ApiKeysClient.html → doc/NgrokAPI/Services/APIKeysClient.html} +287 -151
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +723 -0
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +1489 -0
- data/doc/NgrokAPI/Services/CredentialsClient.html +1534 -0
- data/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +473 -371
- data/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +1609 -0
- data/doc/NgrokAPI/Services/EventSourcesClient.html +1348 -0
- data/doc/NgrokAPI/Services/EventStreamsClient.html +1691 -0
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +1603 -0
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +1488 -0
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +1550 -0
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +1620 -0
- data/doc/NgrokAPI/Services/IPWhitelistClient.html +1488 -0
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +1793 -0
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +518 -333
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1532 -0
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +1552 -0
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +1573 -0
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +1617 -0
- data/{docs/NgrokAPI/Services/TlsCertificatesClient.html → doc/NgrokAPI/Services/TLSCertificatesClient.html} +290 -198
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +1468 -0
- data/doc/NgrokAPI/Services/TunnelsClient.html +513 -0
- data/doc/NgrokAPI/Services.html +4 -4
- data/doc/NgrokAPI.html +3 -3
- data/doc/_index.html +624 -28
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +1 -1
- data/doc/index.html +1 -1
- data/doc/method_list.html +7318 -286
- data/doc/top-level-namespace.html +1 -1
- data/docs/.gitkeep +0 -0
- data/docs/NgrokAPI/Client.html +1499 -125
- data/docs/NgrokAPI/Error.html +1 -1
- data/docs/NgrokAPI/Errors/NotFoundError.html +1 -1
- data/docs/NgrokAPI/Errors.html +1 -1
- data/docs/NgrokAPI/HttpClient.html +1 -1
- data/docs/NgrokAPI/Models/{ApiKey.html → APIKey.html} +108 -177
- data/docs/NgrokAPI/Models/AWSAuth.html +617 -0
- data/docs/NgrokAPI/Models/AWSCredentials.html +617 -0
- data/docs/NgrokAPI/Models/AWSRole.html +543 -0
- data/docs/NgrokAPI/Models/AbuseReport.html +987 -0
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +617 -0
- data/docs/NgrokAPI/Models/CertificateAuthority.html +1439 -0
- data/docs/NgrokAPI/Models/Credential.html +1149 -0
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +913 -0
- data/docs/NgrokAPI/Models/EndpointCompression.html +543 -0
- data/docs/NgrokAPI/Models/EndpointConfiguration.html +1321 -510
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +617 -0
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointLogging.html +617 -0
- data/docs/NgrokAPI/Models/EndpointLoggingMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +617 -0
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointOAuth.html +987 -0
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +987 -0
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +765 -0
- data/docs/NgrokAPI/Models/EndpointOIDC.html +1135 -0
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +691 -0
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +691 -0
- data/docs/NgrokAPI/Models/EndpointSAML.html +1653 -0
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +1283 -0
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +691 -0
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +691 -0
- data/docs/NgrokAPI/Models/EventDestination.html +1058 -0
- data/docs/NgrokAPI/Models/EventSource.html +765 -0
- data/docs/NgrokAPI/Models/EventSourceReplace.html +691 -0
- data/docs/NgrokAPI/Models/EventStream.html +1309 -0
- data/docs/NgrokAPI/Models/EventSubscription.html +1058 -0
- data/docs/NgrokAPI/Models/EventTarget.html +765 -0
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +617 -0
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +617 -0
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +617 -0
- data/docs/NgrokAPI/Models/IPPolicy.html +1069 -0
- data/docs/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/docs/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/docs/NgrokAPI/Models/{TlsCertificate.html → IPWhitelistEntry.html} +168 -163
- data/docs/NgrokAPI/Models/Listable.html +1 -1
- data/docs/NgrokAPI/Models/Ref.html +617 -0
- data/docs/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/docs/NgrokAPI/Models/ReservedDomain.html +111 -1107
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +839 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertNSTarget.html +617 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +617 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +617 -0
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +1143 -0
- data/docs/NgrokAPI/Models/SSHCredential.html +1149 -0
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +1513 -0
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +1661 -0
- data/docs/NgrokAPI/Models/TLSCertificate.html +2179 -0
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +617 -0
- data/docs/NgrokAPI/Models/Tunnel.html +987 -0
- data/docs/NgrokAPI/Models/TunnelSession.html +1209 -0
- data/docs/NgrokAPI/Models.html +4 -4
- data/docs/NgrokAPI/PagedIterator.html +1 -1
- data/{doc/NgrokAPI/Services/ApiKeysClient.html → docs/NgrokAPI/Services/APIKeysClient.html} +287 -151
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +723 -0
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +1489 -0
- data/docs/NgrokAPI/Services/CredentialsClient.html +1534 -0
- data/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +473 -371
- data/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +1609 -0
- data/docs/NgrokAPI/Services/EventSourcesClient.html +1348 -0
- data/docs/NgrokAPI/Services/EventStreamsClient.html +1691 -0
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +1603 -0
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +1488 -0
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +1550 -0
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +1620 -0
- data/docs/NgrokAPI/Services/IPWhitelistClient.html +1488 -0
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +1793 -0
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +518 -333
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1532 -0
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +1552 -0
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +1573 -0
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +1617 -0
- data/{doc/NgrokAPI/Services/TlsCertificatesClient.html → docs/NgrokAPI/Services/TLSCertificatesClient.html} +290 -198
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +1468 -0
- data/docs/NgrokAPI/Services/TunnelsClient.html +513 -0
- data/docs/NgrokAPI/Services.html +4 -4
- data/docs/NgrokAPI.html +3 -3
- data/docs/_index.html +624 -28
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +1 -1
- data/docs/index.html +1 -1
- data/docs/method_list.html +7318 -286
- data/docs/top-level-namespace.html +1 -1
- data/lib/ngrokapi/client.rb +218 -49
- data/lib/ngrokapi/models/abuse_report.rb +37 -0
- data/lib/ngrokapi/models/abuse_report_hostname.rb +27 -0
- data/lib/ngrokapi/models/api_key.rb +62 -64
- data/lib/ngrokapi/models/aws_auth.rb +27 -0
- data/lib/ngrokapi/models/aws_credentials.rb +27 -0
- data/lib/ngrokapi/models/aws_role.rb +25 -0
- data/lib/ngrokapi/models/certificate_authority.rb +72 -0
- data/lib/ngrokapi/models/credential.rb +67 -0
- data/lib/ngrokapi/models/endpoint_circuit_breaker.rb +35 -0
- data/lib/ngrokapi/models/endpoint_compression.rb +25 -0
- data/lib/ngrokapi/models/endpoint_configuration.rb +130 -119
- data/lib/ngrokapi/models/endpoint_ip_policy.rb +27 -0
- data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_logging.rb +27 -0
- data/lib/ngrokapi/models/endpoint_logging_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_mutual_tls.rb +27 -0
- data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_o_auth.rb +37 -0
- data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb +37 -0
- data/lib/ngrokapi/models/endpoint_o_auth_google.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_microsoft.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_provider.rb +31 -0
- data/lib/ngrokapi/models/endpoint_oidc.rb +41 -0
- data/lib/ngrokapi/models/endpoint_request_headers.rb +29 -0
- data/lib/ngrokapi/models/endpoint_response_headers.rb +29 -0
- data/lib/ngrokapi/models/endpoint_saml.rb +55 -0
- data/lib/ngrokapi/models/endpoint_saml_mutate.rb +45 -0
- data/lib/ngrokapi/models/endpoint_tls_termination.rb +29 -0
- data/lib/ngrokapi/models/endpoint_webhook_validation.rb +29 -0
- data/lib/ngrokapi/models/event_destination.rb +49 -0
- data/lib/ngrokapi/models/event_source.rb +31 -0
- data/lib/ngrokapi/models/event_source_replace.rb +29 -0
- data/lib/ngrokapi/models/event_stream.rb +77 -0
- data/lib/ngrokapi/models/event_subscription.rb +47 -0
- data/lib/ngrokapi/models/event_target.rb +31 -0
- data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb +27 -0
- data/lib/ngrokapi/models/event_target_firehose.rb +27 -0
- data/lib/ngrokapi/models/event_target_kinesis.rb +27 -0
- data/lib/ngrokapi/models/ip_policy.rb +64 -0
- data/lib/ngrokapi/models/ip_policy_rule.rb +67 -0
- data/lib/ngrokapi/models/ip_restriction.rb +49 -0
- data/lib/ngrokapi/models/ip_whitelist_entry.rb +62 -0
- data/lib/ngrokapi/models/ref.rb +27 -0
- data/lib/ngrokapi/models/reserved_addr.rb +49 -0
- data/lib/ngrokapi/models/reserved_domain.rb +59 -211
- data/lib/ngrokapi/models/reserved_domain_cert_job.rb +33 -0
- data/lib/ngrokapi/models/reserved_domain_cert_ns_target.rb +27 -0
- data/lib/ngrokapi/models/reserved_domain_cert_policy.rb +27 -0
- data/lib/ngrokapi/models/reserved_domain_cert_status.rb +27 -0
- data/lib/ngrokapi/models/ssh_certificate_authority.rb +64 -0
- data/lib/ngrokapi/models/ssh_credential.rb +67 -0
- data/lib/ngrokapi/models/ssh_host_certificate.rb +74 -0
- data/lib/ngrokapi/models/ssh_user_certificate.rb +78 -0
- data/lib/ngrokapi/models/tls_certificate.rb +92 -62
- data/lib/ngrokapi/models/tls_certificate_sa_ns.rb +27 -0
- data/lib/ngrokapi/models/tunnel.rb +37 -0
- data/lib/ngrokapi/models/tunnel_session.rb +43 -0
- data/lib/ngrokapi/services/.gitkeep +0 -0
- data/lib/ngrokapi/services/abuse_reports_client.rb +84 -0
- data/lib/ngrokapi/services/api_keys_client.rb +203 -144
- data/lib/ngrokapi/services/certificate_authorities_client.rb +204 -0
- data/lib/ngrokapi/services/credentials_client.rb +212 -0
- data/lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_compression_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +324 -313
- data/lib/ngrokapi/services/endpoint_ip_policy_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_logging_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_o_auth_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_oidc_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_request_headers_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_response_headers_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_saml_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_tls_termination_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb +122 -0
- data/lib/ngrokapi/services/event_destinations_client.rb +222 -0
- data/lib/ngrokapi/services/event_sources_client.rb +177 -0
- data/lib/ngrokapi/services/event_streams_client.rb +226 -0
- data/lib/ngrokapi/services/event_subscriptions_client.rb +213 -0
- data/lib/ngrokapi/services/ip_policies_client.rb +208 -0
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +210 -0
- data/lib/ngrokapi/services/ip_restrictions_client.rb +223 -0
- data/lib/ngrokapi/services/ip_whitelist_client.rb +202 -0
- data/lib/ngrokapi/services/reserved_addrs_client.rb +246 -0
- data/lib/ngrokapi/services/reserved_domains_client.rb +382 -313
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +207 -0
- data/lib/ngrokapi/services/ssh_credentials_client.rb +211 -0
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +214 -0
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +220 -0
- data/lib/ngrokapi/services/tls_certificates_client.rb +207 -161
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +228 -0
- data/lib/ngrokapi/services/tunnels_client.rb +51 -0
- data/lib/ngrokapi/version.rb +1 -1
- data/spec/ngrokapi/client_spec.rb +139 -33
- data/spec/ngrokapi/models/abuse_report_hostname_spec.rb +21 -0
- data/spec/ngrokapi/models/abuse_report_spec.rb +21 -0
- data/spec/ngrokapi/models/api_key_spec.rb +42 -43
- data/spec/ngrokapi/models/aws_auth_spec.rb +21 -0
- data/spec/ngrokapi/models/aws_credentials_spec.rb +21 -0
- data/spec/ngrokapi/models/aws_role_spec.rb +21 -0
- data/spec/ngrokapi/models/certificate_authority_spec.rb +42 -0
- data/spec/ngrokapi/models/credential_spec.rb +45 -0
- data/spec/ngrokapi/models/endpoint_circuit_breaker_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_compression_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_configuration_spec.rb +78 -0
- data/spec/ngrokapi/models/endpoint_ip_policy_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_ip_policy_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_logging_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_logging_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_mutual_tls_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_mutual_tls_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_facebook_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_git_hub_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_google_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_microsoft_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_provider_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_oidc_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_request_headers_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_response_headers_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_saml_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_saml_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_tls_termination_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_webhook_validation_spec.rb +21 -0
- data/spec/ngrokapi/models/event_destination_spec.rb +28 -0
- data/spec/ngrokapi/models/event_source_replace_spec.rb +21 -0
- data/spec/ngrokapi/models/event_source_spec.rb +21 -0
- data/spec/ngrokapi/models/event_stream_spec.rb +51 -0
- data/spec/ngrokapi/models/event_subscription_spec.rb +28 -0
- data/spec/ngrokapi/models/event_target_cloudwatch_logs_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_firehose_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_kinesis_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_spec.rb +21 -0
- data/spec/ngrokapi/models/ip_policy_rule_spec.rb +45 -0
- data/spec/ngrokapi/models/ip_policy_spec.rb +42 -0
- data/spec/ngrokapi/models/ip_restriction_spec.rb +28 -0
- data/spec/ngrokapi/models/ip_whitelist_entry_spec.rb +42 -0
- data/spec/ngrokapi/models/listable_spec.rb +4 -4
- data/spec/ngrokapi/models/ref_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_addr_spec.rb +28 -0
- data/spec/ngrokapi/models/reserved_domain_cert_job_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_cert_ns_target_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_cert_status_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_spec.rb +28 -100
- data/spec/ngrokapi/models/ssh_certificate_authority_spec.rb +42 -0
- data/spec/ngrokapi/models/ssh_credential_spec.rb +45 -0
- data/spec/ngrokapi/models/ssh_host_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/ssh_user_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/tls_certificate_sa_ns_spec.rb +21 -0
- data/spec/ngrokapi/models/tls_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/tunnel_session_spec.rb +21 -0
- data/spec/ngrokapi/models/tunnel_spec.rb +21 -0
- data/spec/ngrokapi/paged_iterator_spec.rb +5 -5
- data/spec/ngrokapi/services/.gitkeep +0 -0
- data/spec/ngrokapi/services/abuse_reports_client_spec.rb +67 -0
- data/spec/ngrokapi/services/api_keys_client_spec.rb +160 -127
- data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +162 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +166 -0
- data/spec/ngrokapi/services/endpoint_circuit_breaker_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_compression_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +240 -0
- data/spec/ngrokapi/services/endpoint_ip_policy_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_mutual_tls_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_o_auth_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_oidc_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_request_headers_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_response_headers_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_saml_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_tls_termination_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_webhook_validation_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/event_destinations_client_spec.rb +175 -0
- data/spec/ngrokapi/services/event_sources_client_spec.rb +162 -0
- data/spec/ngrokapi/services/event_streams_client_spec.rb +180 -0
- data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +172 -0
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +162 -0
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +168 -0
- data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +174 -0
- data/spec/ngrokapi/services/ip_whitelist_client_spec.rb +162 -0
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +209 -0
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +352 -0
- data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +166 -0
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +168 -0
- data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +170 -0
- data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +174 -0
- data/spec/ngrokapi/services/tls_certificates_client_spec.rb +164 -0
- data/spec/ngrokapi/services/tunnel_sessions_client_spec.rb +184 -0
- data/spec/ngrokapi/services/tunnels_client_spec.rb +21 -0
- data/spec/spec_helper.rb +958 -0
- metadata +355 -10
|
@@ -4,7 +4,7 @@
|
|
|
4
4
|
<meta charset="utf-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
6
|
<title>
|
|
7
|
-
Class: NgrokAPI::Services::
|
|
7
|
+
Class: NgrokAPI::Services::APIKeysClient
|
|
8
8
|
|
|
9
9
|
— Documentation by YARD 0.9.26
|
|
10
10
|
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
|
16
16
|
|
|
17
17
|
<script type="text/javascript">
|
|
18
|
-
pathId = "NgrokAPI::Services::
|
|
18
|
+
pathId = "NgrokAPI::Services::APIKeysClient";
|
|
19
19
|
relpath = '../../';
|
|
20
20
|
</script>
|
|
21
21
|
|
|
@@ -39,7 +39,7 @@
|
|
|
39
39
|
<a href="../../_index.html">Index (A)</a> »
|
|
40
40
|
<span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> » <span class='title'><span class='object_link'><a href="../Services.html" title="NgrokAPI::Services (module)">Services</a></span></span>
|
|
41
41
|
»
|
|
42
|
-
<span class="title">
|
|
42
|
+
<span class="title">APIKeysClient</span>
|
|
43
43
|
|
|
44
44
|
</div>
|
|
45
45
|
|
|
@@ -59,7 +59,7 @@
|
|
|
59
59
|
<div class="clear"></div>
|
|
60
60
|
</div>
|
|
61
61
|
|
|
62
|
-
<div id="content"><h1>Class: NgrokAPI::Services::
|
|
62
|
+
<div id="content"><h1>Class: NgrokAPI::Services::APIKeysClient
|
|
63
63
|
|
|
64
64
|
|
|
65
65
|
|
|
@@ -74,7 +74,7 @@
|
|
|
74
74
|
<ul class="fullTree">
|
|
75
75
|
<li>Object</li>
|
|
76
76
|
|
|
77
|
-
<li class="next">NgrokAPI::Services::
|
|
77
|
+
<li class="next">NgrokAPI::Services::APIKeysClient</li>
|
|
78
78
|
|
|
79
79
|
</ul>
|
|
80
80
|
<a href="#" class="inheritanceTree">show all</a>
|
|
@@ -102,7 +102,13 @@
|
|
|
102
102
|
<h2>Overview</h2><div class="docstring">
|
|
103
103
|
<div class="discussion">
|
|
104
104
|
|
|
105
|
-
<p>
|
|
105
|
+
<p>API Keys are used to authenticate to the (<a href="https://ngrok.com/docs/api#authentication)ngrok">ngrok.com/docs/api#authentication)ngrok</a></p>
|
|
106
|
+
|
|
107
|
+
<pre class="code ruby"><code class="ruby">API. You may use the API itself
|
|
108
|
+
to provision and manage API Keys but you'll need to provision your first API
|
|
109
|
+
key from the (https://dashboard.ngrok.com/api/keys)API Keys page on your
|
|
110
|
+
ngrok.com dashboard.
|
|
111
|
+
</code></pre>
|
|
106
112
|
|
|
107
113
|
<p><a href="https://ngrok.com/docs/api#api-api-keys">ngrok.com/docs/api#api-api-keys</a></p>
|
|
108
114
|
|
|
@@ -121,11 +127,11 @@
|
|
|
121
127
|
|
|
122
128
|
<dl class="constants">
|
|
123
129
|
|
|
124
|
-
<dt id="
|
|
130
|
+
<dt id="PATH-constant" class="">PATH =
|
|
125
131
|
<div class="docstring">
|
|
126
132
|
<div class="discussion">
|
|
127
133
|
|
|
128
|
-
<p>The
|
|
134
|
+
<p>The API path for the requests</p>
|
|
129
135
|
|
|
130
136
|
|
|
131
137
|
</div>
|
|
@@ -135,13 +141,13 @@
|
|
|
135
141
|
|
|
136
142
|
</div>
|
|
137
143
|
</dt>
|
|
138
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'
|
|
144
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/api_keys</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
139
145
|
|
|
140
|
-
<dt id="
|
|
146
|
+
<dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
|
|
141
147
|
<div class="docstring">
|
|
142
148
|
<div class="discussion">
|
|
143
149
|
|
|
144
|
-
<p>The
|
|
150
|
+
<p>The List Property from the resulting API for list calls</p>
|
|
145
151
|
|
|
146
152
|
|
|
147
153
|
</div>
|
|
@@ -151,7 +157,7 @@
|
|
|
151
157
|
|
|
152
158
|
</div>
|
|
153
159
|
</dt>
|
|
154
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'
|
|
160
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>keys</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
155
161
|
|
|
156
162
|
</dl>
|
|
157
163
|
|
|
@@ -207,7 +213,7 @@
|
|
|
207
213
|
<li class="public ">
|
|
208
214
|
<span class="summary_signature">
|
|
209
215
|
|
|
210
|
-
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description:
|
|
216
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: "", metadata: "") ⇒ NgrokAPI::Models::APIKey </a>
|
|
211
217
|
|
|
212
218
|
|
|
213
219
|
|
|
@@ -231,7 +237,7 @@
|
|
|
231
237
|
<li class="public ">
|
|
232
238
|
<span class="summary_signature">
|
|
233
239
|
|
|
234
|
-
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id:
|
|
240
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
235
241
|
|
|
236
242
|
|
|
237
243
|
|
|
@@ -255,7 +261,7 @@
|
|
|
255
261
|
<li class="public ">
|
|
256
262
|
<span class="summary_signature">
|
|
257
263
|
|
|
258
|
-
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id:
|
|
264
|
+
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
259
265
|
|
|
260
266
|
|
|
261
267
|
|
|
@@ -270,7 +276,7 @@
|
|
|
270
276
|
|
|
271
277
|
|
|
272
278
|
<span class="summary_desc"><div class='inline'>
|
|
273
|
-
<p>Delete an API key by ID.</p>
|
|
279
|
+
<p>Delete an API key by ID Throws an exception if API error.</p>
|
|
274
280
|
</div></span>
|
|
275
281
|
|
|
276
282
|
</li>
|
|
@@ -279,7 +285,7 @@
|
|
|
279
285
|
<li class="public ">
|
|
280
286
|
<span class="summary_signature">
|
|
281
287
|
|
|
282
|
-
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id:
|
|
288
|
+
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: "") ⇒ NgrokAPI::Models::APIKey </a>
|
|
283
289
|
|
|
284
290
|
|
|
285
291
|
|
|
@@ -303,7 +309,7 @@
|
|
|
303
309
|
<li class="public ">
|
|
304
310
|
<span class="summary_signature">
|
|
305
311
|
|
|
306
|
-
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id:
|
|
312
|
+
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: "") ⇒ NgrokAPI::Models::APIKey </a>
|
|
307
313
|
|
|
308
314
|
|
|
309
315
|
|
|
@@ -327,7 +333,7 @@
|
|
|
327
333
|
<li class="public ">
|
|
328
334
|
<span class="summary_signature">
|
|
329
335
|
|
|
330
|
-
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒
|
|
336
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒ APIKeysClient </a>
|
|
331
337
|
|
|
332
338
|
|
|
333
339
|
|
|
@@ -344,7 +350,7 @@
|
|
|
344
350
|
|
|
345
351
|
|
|
346
352
|
<span class="summary_desc"><div class='inline'>
|
|
347
|
-
<p>A new instance of
|
|
353
|
+
<p>A new instance of APIKeysClient.</p>
|
|
348
354
|
</div></span>
|
|
349
355
|
|
|
350
356
|
</li>
|
|
@@ -377,7 +383,7 @@
|
|
|
377
383
|
<li class="public ">
|
|
378
384
|
<span class="summary_signature">
|
|
379
385
|
|
|
380
|
-
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id:
|
|
386
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::APIKey </a>
|
|
381
387
|
|
|
382
388
|
|
|
383
389
|
|
|
@@ -401,7 +407,7 @@
|
|
|
401
407
|
<li class="public ">
|
|
402
408
|
<span class="summary_signature">
|
|
403
409
|
|
|
404
|
-
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id:
|
|
410
|
+
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::APIKey </a>
|
|
405
411
|
|
|
406
412
|
|
|
407
413
|
|
|
@@ -431,7 +437,7 @@
|
|
|
431
437
|
<div class="method_details first">
|
|
432
438
|
<h3 class="signature first" id="initialize-instance_method">
|
|
433
439
|
|
|
434
|
-
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::
|
|
440
|
+
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::APIKeysClient (class)">APIKeysClient</a></span></tt>
|
|
435
441
|
|
|
436
442
|
|
|
437
443
|
|
|
@@ -440,7 +446,7 @@
|
|
|
440
446
|
</h3><div class="docstring">
|
|
441
447
|
<div class="discussion">
|
|
442
448
|
|
|
443
|
-
<p>Returns a new instance of
|
|
449
|
+
<p>Returns a new instance of APIKeysClient.</p>
|
|
444
450
|
|
|
445
451
|
|
|
446
452
|
</div>
|
|
@@ -454,15 +460,15 @@
|
|
|
454
460
|
<pre class="lines">
|
|
455
461
|
|
|
456
462
|
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
463
|
+
22
|
|
464
|
+
23
|
|
465
|
+
24</pre>
|
|
460
466
|
</td>
|
|
461
467
|
<td>
|
|
462
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line
|
|
468
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 22</span>
|
|
463
469
|
|
|
464
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='rparen'>)</span>
|
|
465
|
-
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
470
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='rparen'>)</span>
|
|
471
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
466
472
|
<span class='kw'>end</span></pre>
|
|
467
473
|
</td>
|
|
468
474
|
</tr>
|
|
@@ -502,12 +508,12 @@
|
|
|
502
508
|
<pre class="lines">
|
|
503
509
|
|
|
504
510
|
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
511
|
+
20
|
|
512
|
+
21
|
|
513
|
+
22</pre>
|
|
508
514
|
</td>
|
|
509
515
|
<td>
|
|
510
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line
|
|
516
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 20</span>
|
|
511
517
|
|
|
512
518
|
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
|
513
519
|
<span class='ivar'>@client</span>
|
|
@@ -527,7 +533,7 @@
|
|
|
527
533
|
<div class="method_details first">
|
|
528
534
|
<h3 class="signature first" id="create-instance_method">
|
|
529
535
|
|
|
530
|
-
#<strong>create</strong>(description:
|
|
536
|
+
#<strong>create</strong>(description: "", metadata: "") ⇒ <tt><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">NgrokAPI::Models::APIKey</a></span></tt>
|
|
531
537
|
|
|
532
538
|
|
|
533
539
|
|
|
@@ -555,7 +561,7 @@
|
|
|
555
561
|
<span class='type'>(<tt>string</tt>)</span>
|
|
556
562
|
|
|
557
563
|
|
|
558
|
-
<em class="default">(defaults to: <tt
|
|
564
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
559
565
|
|
|
560
566
|
|
|
561
567
|
—
|
|
@@ -573,7 +579,7 @@
|
|
|
573
579
|
<span class='type'>(<tt>string</tt>)</span>
|
|
574
580
|
|
|
575
581
|
|
|
576
|
-
<em class="default">(defaults to: <tt
|
|
582
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
577
583
|
|
|
578
584
|
|
|
579
585
|
—
|
|
@@ -591,13 +597,13 @@
|
|
|
591
597
|
<li>
|
|
592
598
|
|
|
593
599
|
|
|
594
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
|
600
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">NgrokAPI::Models::APIKey</a></span></tt>)</span>
|
|
595
601
|
|
|
596
602
|
|
|
597
603
|
|
|
598
604
|
—
|
|
599
605
|
<div class='inline'>
|
|
600
|
-
<p>result from
|
|
606
|
+
<p>result from the API request</p>
|
|
601
607
|
</div>
|
|
602
608
|
|
|
603
609
|
</li>
|
|
@@ -610,17 +616,35 @@
|
|
|
610
616
|
<pre class="lines">
|
|
611
617
|
|
|
612
618
|
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
619
|
+
35
|
|
620
|
+
36
|
|
621
|
+
37
|
|
622
|
+
38
|
|
623
|
+
39
|
|
624
|
+
40
|
|
625
|
+
41
|
|
626
|
+
42
|
|
627
|
+
43
|
|
628
|
+
44
|
|
629
|
+
45
|
|
630
|
+
46
|
|
631
|
+
47</pre>
|
|
617
632
|
</td>
|
|
618
633
|
<td>
|
|
619
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line
|
|
620
|
-
|
|
621
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span
|
|
622
|
-
<span class='
|
|
623
|
-
<span class='
|
|
634
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 35</span>
|
|
635
|
+
|
|
636
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span>
|
|
637
|
+
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
638
|
+
<span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
639
|
+
<span class='rparen'>)</span>
|
|
640
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/api_keys</span><span class='tstring_end'>'</span></span>
|
|
641
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
642
|
+
<span class='rbrace'>}</span>
|
|
643
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
644
|
+
<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>
|
|
645
|
+
<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>
|
|
646
|
+
<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>
|
|
647
|
+
<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/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/APIKey.html#initialize-instance_method" title="NgrokAPI::Models::APIKey#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>
|
|
624
648
|
<span class='kw'>end</span></pre>
|
|
625
649
|
</td>
|
|
626
650
|
</tr>
|
|
@@ -630,7 +654,7 @@
|
|
|
630
654
|
<div class="method_details ">
|
|
631
655
|
<h3 class="signature " id="delete-instance_method">
|
|
632
656
|
|
|
633
|
-
#<strong>delete</strong>(id:
|
|
657
|
+
#<strong>delete</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
634
658
|
|
|
635
659
|
|
|
636
660
|
|
|
@@ -639,7 +663,7 @@
|
|
|
639
663
|
</h3><div class="docstring">
|
|
640
664
|
<div class="discussion">
|
|
641
665
|
|
|
642
|
-
<p>Delete an API key by ID
|
|
666
|
+
<p>Delete an API key by ID</p>
|
|
643
667
|
|
|
644
668
|
<p><a href="https://ngrok.com/docs/api#api-api-keys-delete">ngrok.com/docs/api#api-api-keys-delete</a></p>
|
|
645
669
|
|
|
@@ -658,7 +682,7 @@
|
|
|
658
682
|
<span class='type'>(<tt>string</tt>)</span>
|
|
659
683
|
|
|
660
684
|
|
|
661
|
-
<em class="default">(defaults to: <tt
|
|
685
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
662
686
|
|
|
663
687
|
|
|
664
688
|
—
|
|
@@ -676,13 +700,13 @@
|
|
|
676
700
|
<li>
|
|
677
701
|
|
|
678
702
|
|
|
679
|
-
<span class='type'>(<tt>
|
|
703
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
680
704
|
|
|
681
705
|
|
|
682
706
|
|
|
683
707
|
—
|
|
684
708
|
<div class='inline'>
|
|
685
|
-
<p>result from
|
|
709
|
+
<p>result from the API request</p>
|
|
686
710
|
</div>
|
|
687
711
|
|
|
688
712
|
</li>
|
|
@@ -695,15 +719,27 @@
|
|
|
695
719
|
<pre class="lines">
|
|
696
720
|
|
|
697
721
|
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
722
|
+
56
|
|
723
|
+
57
|
|
724
|
+
58
|
|
725
|
+
59
|
|
726
|
+
60
|
|
727
|
+
61
|
|
728
|
+
62
|
|
729
|
+
63
|
|
730
|
+
64</pre>
|
|
701
731
|
</td>
|
|
702
732
|
<td>
|
|
703
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line
|
|
704
|
-
|
|
705
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span
|
|
706
|
-
<span class='
|
|
733
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 56</span>
|
|
734
|
+
|
|
735
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span>
|
|
736
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
737
|
+
<span class='rparen'>)</span>
|
|
738
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/api_keys/%{id}</span><span class='tstring_end'>'</span></span>
|
|
739
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
740
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
741
|
+
<span class='rbrace'>}</span>
|
|
742
|
+
<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>
|
|
707
743
|
<span class='kw'>end</span></pre>
|
|
708
744
|
</td>
|
|
709
745
|
</tr>
|
|
@@ -713,7 +749,7 @@
|
|
|
713
749
|
<div class="method_details ">
|
|
714
750
|
<h3 class="signature " id="delete!-instance_method">
|
|
715
751
|
|
|
716
|
-
#<strong>delete!</strong>(id:
|
|
752
|
+
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
717
753
|
|
|
718
754
|
|
|
719
755
|
|
|
@@ -722,7 +758,7 @@
|
|
|
722
758
|
</h3><div class="docstring">
|
|
723
759
|
<div class="discussion">
|
|
724
760
|
|
|
725
|
-
<p>Delete an API key by ID
|
|
761
|
+
<p>Delete an API key by ID Throws an exception if API error.</p>
|
|
726
762
|
|
|
727
763
|
<p><a href="https://ngrok.com/docs/api#api-api-keys-delete">ngrok.com/docs/api#api-api-keys-delete</a></p>
|
|
728
764
|
|
|
@@ -741,7 +777,7 @@
|
|
|
741
777
|
<span class='type'>(<tt>string</tt>)</span>
|
|
742
778
|
|
|
743
779
|
|
|
744
|
-
<em class="default">(defaults to: <tt
|
|
780
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
745
781
|
|
|
746
782
|
|
|
747
783
|
—
|
|
@@ -759,13 +795,13 @@
|
|
|
759
795
|
<li>
|
|
760
796
|
|
|
761
797
|
|
|
762
|
-
<span class='type'>(<tt>
|
|
798
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
763
799
|
|
|
764
800
|
|
|
765
801
|
|
|
766
802
|
—
|
|
767
803
|
<div class='inline'>
|
|
768
|
-
<p>result from
|
|
804
|
+
<p>result from the API request</p>
|
|
769
805
|
</div>
|
|
770
806
|
|
|
771
807
|
</li>
|
|
@@ -778,15 +814,27 @@
|
|
|
778
814
|
<pre class="lines">
|
|
779
815
|
|
|
780
816
|
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
817
|
+
74
|
|
818
|
+
75
|
|
819
|
+
76
|
|
820
|
+
77
|
|
821
|
+
78
|
|
822
|
+
79
|
|
823
|
+
80
|
|
824
|
+
81
|
|
825
|
+
82</pre>
|
|
784
826
|
</td>
|
|
785
827
|
<td>
|
|
786
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line
|
|
787
|
-
|
|
788
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span
|
|
789
|
-
<span class='
|
|
828
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 74</span>
|
|
829
|
+
|
|
830
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span>
|
|
831
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
832
|
+
<span class='rparen'>)</span>
|
|
833
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/api_keys/%{id}</span><span class='tstring_end'>'</span></span>
|
|
834
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
835
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
836
|
+
<span class='rbrace'>}</span>
|
|
837
|
+
<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>
|
|
790
838
|
<span class='kw'>end</span></pre>
|
|
791
839
|
</td>
|
|
792
840
|
</tr>
|
|
@@ -796,7 +844,7 @@
|
|
|
796
844
|
<div class="method_details ">
|
|
797
845
|
<h3 class="signature " id="get-instance_method">
|
|
798
846
|
|
|
799
|
-
#<strong>get</strong>(id:
|
|
847
|
+
#<strong>get</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">NgrokAPI::Models::APIKey</a></span></tt>
|
|
800
848
|
|
|
801
849
|
|
|
802
850
|
|
|
@@ -824,7 +872,7 @@
|
|
|
824
872
|
<span class='type'>(<tt>string</tt>)</span>
|
|
825
873
|
|
|
826
874
|
|
|
827
|
-
<em class="default">(defaults to: <tt
|
|
875
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
828
876
|
|
|
829
877
|
|
|
830
878
|
—
|
|
@@ -842,13 +890,13 @@
|
|
|
842
890
|
<li>
|
|
843
891
|
|
|
844
892
|
|
|
845
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
|
893
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">NgrokAPI::Models::APIKey</a></span></tt>)</span>
|
|
846
894
|
|
|
847
895
|
|
|
848
896
|
|
|
849
897
|
—
|
|
850
898
|
<div class='inline'>
|
|
851
|
-
<p>result from
|
|
899
|
+
<p>result from the API request</p>
|
|
852
900
|
</div>
|
|
853
901
|
|
|
854
902
|
</li>
|
|
@@ -861,17 +909,31 @@
|
|
|
861
909
|
<pre class="lines">
|
|
862
910
|
|
|
863
911
|
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
912
|
+
91
|
|
913
|
+
92
|
|
914
|
+
93
|
|
915
|
+
94
|
|
916
|
+
95
|
|
917
|
+
96
|
|
918
|
+
97
|
|
919
|
+
98
|
|
920
|
+
99
|
|
921
|
+
100
|
|
922
|
+
101</pre>
|
|
868
923
|
</td>
|
|
869
924
|
<td>
|
|
870
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line
|
|
871
|
-
|
|
872
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span
|
|
873
|
-
<span class='
|
|
874
|
-
|
|
925
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 91</span>
|
|
926
|
+
|
|
927
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span>
|
|
928
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
929
|
+
<span class='rparen'>)</span>
|
|
930
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/api_keys/%{id}</span><span class='tstring_end'>'</span></span>
|
|
931
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
932
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
933
|
+
<span class='rbrace'>}</span>
|
|
934
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
935
|
+
<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>
|
|
936
|
+
<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/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/APIKey.html#initialize-instance_method" title="NgrokAPI::Models::APIKey#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>
|
|
875
937
|
<span class='kw'>end</span></pre>
|
|
876
938
|
</td>
|
|
877
939
|
</tr>
|
|
@@ -881,7 +943,7 @@
|
|
|
881
943
|
<div class="method_details ">
|
|
882
944
|
<h3 class="signature " id="get!-instance_method">
|
|
883
945
|
|
|
884
|
-
#<strong>get!</strong>(id:
|
|
946
|
+
#<strong>get!</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">NgrokAPI::Models::APIKey</a></span></tt>
|
|
885
947
|
|
|
886
948
|
|
|
887
949
|
|
|
@@ -890,7 +952,7 @@
|
|
|
890
952
|
</h3><div class="docstring">
|
|
891
953
|
<div class="discussion">
|
|
892
954
|
|
|
893
|
-
<p>Get the details of an API key by ID.
|
|
955
|
+
<p>Get the details of an API key by ID. Throws an exception if API error.</p>
|
|
894
956
|
|
|
895
957
|
<p><a href="https://ngrok.com/docs/api#api-api-keys-get">ngrok.com/docs/api#api-api-keys-get</a></p>
|
|
896
958
|
|
|
@@ -909,7 +971,7 @@
|
|
|
909
971
|
<span class='type'>(<tt>string</tt>)</span>
|
|
910
972
|
|
|
911
973
|
|
|
912
|
-
<em class="default">(defaults to: <tt
|
|
974
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
913
975
|
|
|
914
976
|
|
|
915
977
|
—
|
|
@@ -927,13 +989,13 @@
|
|
|
927
989
|
<li>
|
|
928
990
|
|
|
929
991
|
|
|
930
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
|
992
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">NgrokAPI::Models::APIKey</a></span></tt>)</span>
|
|
931
993
|
|
|
932
994
|
|
|
933
995
|
|
|
934
996
|
—
|
|
935
997
|
<div class='inline'>
|
|
936
|
-
<p>result from
|
|
998
|
+
<p>result from the API request</p>
|
|
937
999
|
</div>
|
|
938
1000
|
|
|
939
1001
|
</li>
|
|
@@ -946,17 +1008,31 @@
|
|
|
946
1008
|
<pre class="lines">
|
|
947
1009
|
|
|
948
1010
|
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
|
|
1011
|
+
111
|
|
1012
|
+
112
|
|
1013
|
+
113
|
|
1014
|
+
114
|
|
1015
|
+
115
|
|
1016
|
+
116
|
|
1017
|
+
117
|
|
1018
|
+
118
|
|
1019
|
+
119
|
|
1020
|
+
120
|
|
1021
|
+
121</pre>
|
|
953
1022
|
</td>
|
|
954
1023
|
<td>
|
|
955
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line
|
|
956
|
-
|
|
957
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span
|
|
958
|
-
<span class='
|
|
959
|
-
|
|
1024
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 111</span>
|
|
1025
|
+
|
|
1026
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span>
|
|
1027
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
1028
|
+
<span class='rparen'>)</span>
|
|
1029
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/api_keys/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1030
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1031
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1032
|
+
<span class='rbrace'>}</span>
|
|
1033
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1034
|
+
<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>
|
|
1035
|
+
<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/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/APIKey.html#initialize-instance_method" title="NgrokAPI::Models::APIKey#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>
|
|
960
1036
|
<span class='kw'>end</span></pre>
|
|
961
1037
|
</td>
|
|
962
1038
|
</tr>
|
|
@@ -975,7 +1051,7 @@
|
|
|
975
1051
|
</h3><div class="docstring">
|
|
976
1052
|
<div class="discussion">
|
|
977
1053
|
|
|
978
|
-
<p>List all API keys owned by this account
|
|
1054
|
+
<p>List all API keys owned by this account</p>
|
|
979
1055
|
|
|
980
1056
|
<p><a href="https://ngrok.com/docs/api#api-api-keys-list">ngrok.com/docs/api#api-api-keys-list</a></p>
|
|
981
1057
|
|
|
@@ -1004,7 +1080,7 @@
|
|
|
1004
1080
|
<span class='name'>limit</span>
|
|
1005
1081
|
|
|
1006
1082
|
|
|
1007
|
-
<span class='type'>(<tt>
|
|
1083
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1008
1084
|
|
|
1009
1085
|
|
|
1010
1086
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -1044,7 +1120,7 @@
|
|
|
1044
1120
|
|
|
1045
1121
|
—
|
|
1046
1122
|
<div class='inline'>
|
|
1047
|
-
<p>the
|
|
1123
|
+
<p>result from the API request</p>
|
|
1048
1124
|
</div>
|
|
1049
1125
|
|
|
1050
1126
|
</li>
|
|
@@ -1057,27 +1133,45 @@
|
|
|
1057
1133
|
<pre class="lines">
|
|
1058
1134
|
|
|
1059
1135
|
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1136
|
+
132
|
|
1137
|
+
133
|
|
1138
|
+
134
|
|
1139
|
+
135
|
|
1140
|
+
136
|
|
1141
|
+
137
|
|
1142
|
+
138
|
|
1143
|
+
139
|
|
1144
|
+
140
|
|
1145
|
+
141
|
|
1146
|
+
142
|
|
1147
|
+
143
|
|
1148
|
+
144
|
|
1149
|
+
145
|
|
1150
|
+
146
|
|
1151
|
+
147
|
|
1152
|
+
148
|
|
1153
|
+
149</pre>
|
|
1069
1154
|
</td>
|
|
1070
1155
|
<td>
|
|
1071
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line
|
|
1072
|
-
|
|
1073
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span
|
|
1074
|
-
<span class='
|
|
1075
|
-
<span class='
|
|
1076
|
-
|
|
1077
|
-
|
|
1078
|
-
|
|
1079
|
-
<span class='label'>
|
|
1080
|
-
|
|
1156
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 132</span>
|
|
1157
|
+
|
|
1158
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
|
1159
|
+
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1160
|
+
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1161
|
+
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1162
|
+
<span class='rparen'>)</span>
|
|
1163
|
+
<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>
|
|
1164
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1165
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1166
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1167
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::APIKeysClient::PATH (constant)">PATH</a></span></span>
|
|
1168
|
+
<span class='rparen'>)</span>
|
|
1169
|
+
<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>
|
|
1170
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1171
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1172
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::APIKeysClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1173
|
+
<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/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></span>
|
|
1174
|
+
<span class='rparen'>)</span>
|
|
1081
1175
|
<span class='kw'>end</span></pre>
|
|
1082
1176
|
</td>
|
|
1083
1177
|
</tr>
|
|
@@ -1087,7 +1181,7 @@
|
|
|
1087
1181
|
<div class="method_details ">
|
|
1088
1182
|
<h3 class="signature " id="update-instance_method">
|
|
1089
1183
|
|
|
1090
|
-
#<strong>update</strong>(id:
|
|
1184
|
+
#<strong>update</strong>(id: "", description: nil, metadata: nil) ⇒ <tt><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">NgrokAPI::Models::APIKey</a></span></tt>
|
|
1091
1185
|
|
|
1092
1186
|
|
|
1093
1187
|
|
|
@@ -1115,7 +1209,7 @@
|
|
|
1115
1209
|
<span class='type'>(<tt>string</tt>)</span>
|
|
1116
1210
|
|
|
1117
1211
|
|
|
1118
|
-
<em class="default">(defaults to: <tt
|
|
1212
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1119
1213
|
|
|
1120
1214
|
|
|
1121
1215
|
</li>
|
|
@@ -1164,13 +1258,13 @@
|
|
|
1164
1258
|
<li>
|
|
1165
1259
|
|
|
1166
1260
|
|
|
1167
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
|
1261
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">NgrokAPI::Models::APIKey</a></span></tt>)</span>
|
|
1168
1262
|
|
|
1169
1263
|
|
|
1170
1264
|
|
|
1171
1265
|
—
|
|
1172
1266
|
<div class='inline'>
|
|
1173
|
-
<p>result from
|
|
1267
|
+
<p>result from the API request</p>
|
|
1174
1268
|
</div>
|
|
1175
1269
|
|
|
1176
1270
|
</li>
|
|
@@ -1183,17 +1277,39 @@
|
|
|
1183
1277
|
<pre class="lines">
|
|
1184
1278
|
|
|
1185
1279
|
|
|
1186
|
-
|
|
1187
|
-
|
|
1188
|
-
|
|
1189
|
-
|
|
1280
|
+
160
|
|
1281
|
+
161
|
|
1282
|
+
162
|
|
1283
|
+
163
|
|
1284
|
+
164
|
|
1285
|
+
165
|
|
1286
|
+
166
|
|
1287
|
+
167
|
|
1288
|
+
168
|
|
1289
|
+
169
|
|
1290
|
+
170
|
|
1291
|
+
171
|
|
1292
|
+
172
|
|
1293
|
+
173
|
|
1294
|
+
174</pre>
|
|
1190
1295
|
</td>
|
|
1191
1296
|
<td>
|
|
1192
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line
|
|
1193
|
-
|
|
1194
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span
|
|
1195
|
-
<span class='
|
|
1196
|
-
<span class='
|
|
1297
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 160</span>
|
|
1298
|
+
|
|
1299
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
|
|
1300
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
1301
|
+
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1302
|
+
<span class='label'>metadata:</span> <span class='kw'>nil</span>
|
|
1303
|
+
<span class='rparen'>)</span>
|
|
1304
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/api_keys/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1305
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1306
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1307
|
+
<span class='rbrace'>}</span>
|
|
1308
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1309
|
+
<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>
|
|
1310
|
+
<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>
|
|
1311
|
+
<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>
|
|
1312
|
+
<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/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/APIKey.html#initialize-instance_method" title="NgrokAPI::Models::APIKey#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>
|
|
1197
1313
|
<span class='kw'>end</span></pre>
|
|
1198
1314
|
</td>
|
|
1199
1315
|
</tr>
|
|
@@ -1203,7 +1319,7 @@
|
|
|
1203
1319
|
<div class="method_details ">
|
|
1204
1320
|
<h3 class="signature " id="update!-instance_method">
|
|
1205
1321
|
|
|
1206
|
-
#<strong>update!</strong>(id:
|
|
1322
|
+
#<strong>update!</strong>(id: "", description: nil, metadata: nil) ⇒ <tt><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">NgrokAPI::Models::APIKey</a></span></tt>
|
|
1207
1323
|
|
|
1208
1324
|
|
|
1209
1325
|
|
|
@@ -1212,7 +1328,7 @@
|
|
|
1212
1328
|
</h3><div class="docstring">
|
|
1213
1329
|
<div class="discussion">
|
|
1214
1330
|
|
|
1215
|
-
<p>Update attributes of an API key by ID.</p>
|
|
1331
|
+
<p>Update attributes of an API key by ID. Throws an exception if API error.</p>
|
|
1216
1332
|
|
|
1217
1333
|
<p><a href="https://ngrok.com/docs/api#api-api-keys-update">ngrok.com/docs/api#api-api-keys-update</a></p>
|
|
1218
1334
|
|
|
@@ -1231,7 +1347,7 @@
|
|
|
1231
1347
|
<span class='type'>(<tt>string</tt>)</span>
|
|
1232
1348
|
|
|
1233
1349
|
|
|
1234
|
-
<em class="default">(defaults to: <tt
|
|
1350
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1235
1351
|
|
|
1236
1352
|
|
|
1237
1353
|
</li>
|
|
@@ -1280,13 +1396,13 @@
|
|
|
1280
1396
|
<li>
|
|
1281
1397
|
|
|
1282
1398
|
|
|
1283
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
|
1399
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/APIKey.html" title="NgrokAPI::Models::APIKey (class)">NgrokAPI::Models::APIKey</a></span></tt>)</span>
|
|
1284
1400
|
|
|
1285
1401
|
|
|
1286
1402
|
|
|
1287
1403
|
—
|
|
1288
1404
|
<div class='inline'>
|
|
1289
|
-
<p>result from
|
|
1405
|
+
<p>result from the API request</p>
|
|
1290
1406
|
</div>
|
|
1291
1407
|
|
|
1292
1408
|
</li>
|
|
@@ -1299,19 +1415,39 @@
|
|
|
1299
1415
|
<pre class="lines">
|
|
1300
1416
|
|
|
1301
1417
|
|
|
1302
|
-
|
|
1303
|
-
|
|
1304
|
-
|
|
1305
|
-
|
|
1306
|
-
|
|
1418
|
+
186
|
|
1419
|
+
187
|
|
1420
|
+
188
|
|
1421
|
+
189
|
|
1422
|
+
190
|
|
1423
|
+
191
|
|
1424
|
+
192
|
|
1425
|
+
193
|
|
1426
|
+
194
|
|
1427
|
+
195
|
|
1428
|
+
196
|
|
1429
|
+
197
|
|
1430
|
+
198
|
|
1431
|
+
199
|
|
1432
|
+
200</pre>
|
|
1307
1433
|
</td>
|
|
1308
1434
|
<td>
|
|
1309
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line
|
|
1310
|
-
|
|
1311
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span
|
|
1312
|
-
<span class='
|
|
1313
|
-
<span class='
|
|
1314
|
-
<span class='
|
|
1435
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 186</span>
|
|
1436
|
+
|
|
1437
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
|
|
1438
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
1439
|
+
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1440
|
+
<span class='label'>metadata:</span> <span class='kw'>nil</span>
|
|
1441
|
+
<span class='rparen'>)</span>
|
|
1442
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/api_keys/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1443
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1444
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1445
|
+
<span class='rbrace'>}</span>
|
|
1446
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1447
|
+
<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>
|
|
1448
|
+
<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>
|
|
1449
|
+
<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>
|
|
1450
|
+
<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/APIKey.html" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/APIKey.html#initialize-instance_method" title="NgrokAPI::Models::APIKey#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>
|
|
1315
1451
|
<span class='kw'>end</span></pre>
|
|
1316
1452
|
</td>
|
|
1317
1453
|
</tr>
|
|
@@ -1323,7 +1459,7 @@
|
|
|
1323
1459
|
</div>
|
|
1324
1460
|
|
|
1325
1461
|
<div id="footer">
|
|
1326
|
-
Generated on
|
|
1462
|
+
Generated on Mon Oct 4 23:24:16 2021 by
|
|
1327
1463
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1328
1464
|
0.9.26 (ruby-3.0.1).
|
|
1329
1465
|
</div>
|