ngrok-api 0.9.0 → 0.16.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 +2 -2
- data/.yardopts +1 -0
- data/LICENSE +7 -0
- data/doc/NgrokAPI/Client.html +1469 -125
- data/doc/NgrokAPI/Error.html +3 -3
- data/doc/NgrokAPI/Errors/NotFoundError.html +3 -3
- data/doc/NgrokAPI/Errors.html +3 -3
- data/doc/NgrokAPI/HttpClient.html +66 -36
- data/doc/NgrokAPI/Models/{ApiKey.html → APIKey.html} +110 -179
- data/doc/NgrokAPI/Models/AWSAuth.html +617 -0
- data/doc/NgrokAPI/Models/AWSCredentials.html +617 -0
- data/doc/NgrokAPI/Models/AWSRole.html +543 -0
- data/doc/NgrokAPI/Models/AbuseReport.html +987 -0
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +617 -0
- data/doc/NgrokAPI/Models/AgentIngress.html +1217 -0
- data/doc/NgrokAPI/Models/CertificateAuthority.html +1439 -0
- data/doc/NgrokAPI/Models/Credential.html +1149 -0
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +913 -0
- data/doc/NgrokAPI/Models/EndpointCompression.html +543 -0
- data/doc/NgrokAPI/Models/EndpointConfiguration.html +1323 -512
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +617 -0
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointLogging.html +617 -0
- data/doc/NgrokAPI/Models/EndpointLoggingMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +617 -0
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointOAuth.html +987 -0
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +987 -0
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +765 -0
- data/doc/NgrokAPI/Models/EndpointOIDC.html +1135 -0
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +691 -0
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +691 -0
- data/doc/NgrokAPI/Models/EndpointSAML.html +1653 -0
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +1283 -0
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +691 -0
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +691 -0
- data/doc/NgrokAPI/Models/EventDestination.html +1058 -0
- data/doc/NgrokAPI/Models/EventSource.html +765 -0
- data/doc/NgrokAPI/Models/EventSourceList.html +617 -0
- data/doc/NgrokAPI/Models/EventSourceReplace.html +691 -0
- data/doc/NgrokAPI/Models/EventStream.html +1309 -0
- data/doc/NgrokAPI/Models/EventSubscription.html +1058 -0
- data/doc/NgrokAPI/Models/EventTarget.html +765 -0
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +617 -0
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +617 -0
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +617 -0
- data/doc/NgrokAPI/Models/{TlsCertificate.html → IPPolicy.html} +172 -167
- data/doc/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/doc/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/doc/NgrokAPI/Models/Listable.html +120 -52
- data/doc/NgrokAPI/Models/Ref.html +617 -0
- data/doc/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/doc/NgrokAPI/Models/ReservedDomain.html +186 -1108
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +765 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +617 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +617 -0
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +1143 -0
- data/doc/NgrokAPI/Models/SSHCredential.html +1149 -0
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +1513 -0
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +1661 -0
- data/doc/NgrokAPI/Models/TLSCertificate.html +2179 -0
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +617 -0
- data/doc/NgrokAPI/Models/Tunnel.html +987 -0
- data/doc/NgrokAPI/Models/TunnelSession.html +1209 -0
- data/doc/NgrokAPI/Models.html +6 -6
- data/doc/NgrokAPI/PagedIterator.html +16 -12
- data/{docs/NgrokAPI/Services/ApiKeysClient.html → doc/NgrokAPI/Services/APIKeysClient.html} +404 -153
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +706 -0
- data/doc/NgrokAPI/Services/AgentIngressesClient.html +1600 -0
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +1602 -0
- data/doc/NgrokAPI/Services/CredentialsClient.html +1644 -0
- data/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +503 -370
- data/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +1712 -0
- data/doc/NgrokAPI/Services/EventSourcesClient.html +1532 -0
- data/doc/NgrokAPI/Services/EventStreamsClient.html +1792 -0
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +1712 -0
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +1602 -0
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +1660 -0
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +1720 -0
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +1894 -0
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +585 -344
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1644 -0
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +1662 -0
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +1680 -0
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +1720 -0
- data/{docs/NgrokAPI/Services/TlsCertificatesClient.html → doc/NgrokAPI/Services/TLSCertificatesClient.html} +404 -201
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +1587 -0
- data/doc/NgrokAPI/Services/TunnelsClient.html +669 -0
- data/doc/NgrokAPI/Services.html +6 -6
- data/doc/NgrokAPI.html +5 -5
- data/doc/README +94 -0
- data/doc/_index.html +621 -25
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +55 -28
- data/doc/frames.html +1 -1
- data/doc/index.html +55 -28
- data/doc/method_list.html +7526 -286
- data/doc/top-level-namespace.html +3 -3
- data/docs/.gitkeep +0 -0
- data/docs/CNAME +1 -0
- data/docs/NgrokAPI/Client.html +1469 -125
- data/docs/NgrokAPI/Error.html +3 -3
- data/docs/NgrokAPI/Errors/NotFoundError.html +3 -3
- data/docs/NgrokAPI/Errors.html +3 -3
- data/docs/NgrokAPI/HttpClient.html +66 -36
- data/docs/NgrokAPI/Models/{ApiKey.html → APIKey.html} +110 -179
- data/docs/NgrokAPI/Models/AWSAuth.html +617 -0
- data/docs/NgrokAPI/Models/AWSCredentials.html +617 -0
- data/docs/NgrokAPI/Models/AWSRole.html +543 -0
- data/docs/NgrokAPI/Models/AbuseReport.html +987 -0
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +617 -0
- data/docs/NgrokAPI/Models/AgentIngress.html +1217 -0
- data/docs/NgrokAPI/Models/CertificateAuthority.html +1439 -0
- data/docs/NgrokAPI/Models/Credential.html +1149 -0
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +913 -0
- data/docs/NgrokAPI/Models/EndpointCompression.html +543 -0
- data/docs/NgrokAPI/Models/EndpointConfiguration.html +1323 -512
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +617 -0
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointLogging.html +617 -0
- data/docs/NgrokAPI/Models/EndpointLoggingMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +617 -0
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointOAuth.html +987 -0
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +987 -0
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +765 -0
- data/docs/NgrokAPI/Models/EndpointOIDC.html +1135 -0
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +691 -0
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +691 -0
- data/docs/NgrokAPI/Models/EndpointSAML.html +1653 -0
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +1283 -0
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +691 -0
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +691 -0
- data/docs/NgrokAPI/Models/EventDestination.html +1058 -0
- data/docs/NgrokAPI/Models/EventSource.html +765 -0
- data/docs/NgrokAPI/Models/EventSourceList.html +617 -0
- data/docs/NgrokAPI/Models/EventSourceReplace.html +691 -0
- data/docs/NgrokAPI/Models/EventStream.html +1309 -0
- data/docs/NgrokAPI/Models/EventSubscription.html +1058 -0
- data/docs/NgrokAPI/Models/EventTarget.html +765 -0
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +617 -0
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +617 -0
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +617 -0
- data/docs/NgrokAPI/Models/{TlsCertificate.html → IPPolicy.html} +172 -167
- data/docs/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/docs/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/docs/NgrokAPI/Models/Listable.html +120 -52
- data/docs/NgrokAPI/Models/Ref.html +617 -0
- data/docs/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/docs/NgrokAPI/Models/ReservedDomain.html +186 -1108
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +765 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +617 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +617 -0
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +1143 -0
- data/docs/NgrokAPI/Models/SSHCredential.html +1149 -0
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +1513 -0
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +1661 -0
- data/docs/NgrokAPI/Models/TLSCertificate.html +2179 -0
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +617 -0
- data/docs/NgrokAPI/Models/Tunnel.html +987 -0
- data/docs/NgrokAPI/Models/TunnelSession.html +1209 -0
- data/docs/NgrokAPI/Models.html +6 -6
- data/docs/NgrokAPI/PagedIterator.html +16 -12
- data/{doc/NgrokAPI/Services/ApiKeysClient.html → docs/NgrokAPI/Services/APIKeysClient.html} +404 -153
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +706 -0
- data/docs/NgrokAPI/Services/AgentIngressesClient.html +1600 -0
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +1602 -0
- data/docs/NgrokAPI/Services/CredentialsClient.html +1644 -0
- data/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +503 -370
- data/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +1712 -0
- data/docs/NgrokAPI/Services/EventSourcesClient.html +1532 -0
- data/docs/NgrokAPI/Services/EventStreamsClient.html +1792 -0
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +1712 -0
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +1602 -0
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +1660 -0
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +1720 -0
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +1894 -0
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +585 -344
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1644 -0
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +1662 -0
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +1680 -0
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +1720 -0
- data/{doc/NgrokAPI/Services/TlsCertificatesClient.html → docs/NgrokAPI/Services/TLSCertificatesClient.html} +404 -201
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +1587 -0
- data/docs/NgrokAPI/Services/TunnelsClient.html +669 -0
- data/docs/NgrokAPI/Services.html +6 -6
- data/docs/NgrokAPI.html +5 -5
- data/docs/README +94 -0
- data/docs/_index.html +621 -25
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +55 -28
- data/docs/frames.html +1 -1
- data/docs/index.html +55 -28
- data/docs/method_list.html +7526 -286
- data/docs/top-level-namespace.html +3 -3
- data/lib/ngrokapi/client.rb +229 -49
- data/lib/ngrokapi/http_client.rb +6 -7
- data/lib/ngrokapi/models/abuse_report.rb +37 -0
- data/lib/ngrokapi/models/abuse_report_hostname.rb +27 -0
- data/lib/ngrokapi/models/agent_ingress.rb +66 -0
- data/lib/ngrokapi/models/api_key.rb +62 -64
- data/lib/ngrokapi/models/aws_auth.rb +27 -0
- data/lib/ngrokapi/models/aws_credentials.rb +27 -0
- data/lib/ngrokapi/models/aws_role.rb +25 -0
- data/lib/ngrokapi/models/certificate_authority.rb +72 -0
- data/lib/ngrokapi/models/credential.rb +67 -0
- data/lib/ngrokapi/models/endpoint_circuit_breaker.rb +35 -0
- data/lib/ngrokapi/models/endpoint_compression.rb +25 -0
- data/lib/ngrokapi/models/endpoint_configuration.rb +130 -119
- data/lib/ngrokapi/models/endpoint_ip_policy.rb +27 -0
- data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_logging.rb +27 -0
- data/lib/ngrokapi/models/endpoint_logging_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_mutual_tls.rb +27 -0
- data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_o_auth.rb +37 -0
- data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb +37 -0
- data/lib/ngrokapi/models/endpoint_o_auth_google.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_microsoft.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_provider.rb +31 -0
- data/lib/ngrokapi/models/endpoint_oidc.rb +41 -0
- data/lib/ngrokapi/models/endpoint_request_headers.rb +29 -0
- data/lib/ngrokapi/models/endpoint_response_headers.rb +29 -0
- data/lib/ngrokapi/models/endpoint_saml.rb +55 -0
- data/lib/ngrokapi/models/endpoint_saml_mutate.rb +45 -0
- data/lib/ngrokapi/models/endpoint_tls_termination.rb +29 -0
- data/lib/ngrokapi/models/endpoint_webhook_validation.rb +29 -0
- data/lib/ngrokapi/models/event_destination.rb +49 -0
- data/lib/ngrokapi/models/event_source.rb +31 -0
- data/lib/ngrokapi/models/event_source_list.rb +27 -0
- data/lib/ngrokapi/models/event_source_replace.rb +29 -0
- data/lib/ngrokapi/models/event_stream.rb +77 -0
- data/lib/ngrokapi/models/event_subscription.rb +47 -0
- data/lib/ngrokapi/models/event_target.rb +31 -0
- data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb +27 -0
- data/lib/ngrokapi/models/event_target_firehose.rb +27 -0
- data/lib/ngrokapi/models/event_target_kinesis.rb +27 -0
- data/lib/ngrokapi/models/ip_policy.rb +64 -0
- data/lib/ngrokapi/models/ip_policy_rule.rb +67 -0
- data/lib/ngrokapi/models/ip_restriction.rb +49 -0
- data/lib/ngrokapi/models/listable.rb +13 -2
- data/lib/ngrokapi/models/ref.rb +27 -0
- data/lib/ngrokapi/models/reserved_addr.rb +49 -0
- data/lib/ngrokapi/models/reserved_domain.rb +61 -211
- data/lib/ngrokapi/models/reserved_domain_cert_job.rb +31 -0
- data/lib/ngrokapi/models/reserved_domain_cert_policy.rb +27 -0
- data/lib/ngrokapi/models/reserved_domain_cert_status.rb +27 -0
- data/lib/ngrokapi/models/ssh_certificate_authority.rb +64 -0
- data/lib/ngrokapi/models/ssh_credential.rb +67 -0
- data/lib/ngrokapi/models/ssh_host_certificate.rb +74 -0
- data/lib/ngrokapi/models/ssh_user_certificate.rb +78 -0
- data/lib/ngrokapi/models/tls_certificate.rb +92 -62
- data/lib/ngrokapi/models/tls_certificate_sa_ns.rb +27 -0
- data/lib/ngrokapi/models/tunnel.rb +37 -0
- data/lib/ngrokapi/models/tunnel_session.rb +43 -0
- data/lib/ngrokapi/paged_iterator.rb +4 -2
- data/lib/ngrokapi/services/.gitkeep +0 -0
- data/lib/ngrokapi/services/abuse_reports_client.rb +77 -0
- data/lib/ngrokapi/services/agent_ingresses_client.rb +206 -0
- data/lib/ngrokapi/services/api_keys_client.rb +210 -144
- data/lib/ngrokapi/services/certificate_authorities_client.rb +211 -0
- data/lib/ngrokapi/services/credentials_client.rb +217 -0
- data/lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_compression_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +289 -313
- data/lib/ngrokapi/services/endpoint_ip_policy_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_logging_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_o_auth_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_oidc_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_request_headers_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_response_headers_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_saml_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_tls_termination_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb +108 -0
- data/lib/ngrokapi/services/event_destinations_client.rb +221 -0
- data/lib/ngrokapi/services/event_sources_client.rb +185 -0
- data/lib/ngrokapi/services/event_streams_client.rb +224 -0
- data/lib/ngrokapi/services/event_subscriptions_client.rb +215 -0
- data/lib/ngrokapi/services/ip_policies_client.rb +215 -0
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +214 -0
- data/lib/ngrokapi/services/ip_restrictions_client.rb +224 -0
- data/lib/ngrokapi/services/reserved_addrs_client.rb +246 -0
- data/lib/ngrokapi/services/reserved_domains_client.rb +360 -313
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +212 -0
- data/lib/ngrokapi/services/ssh_credentials_client.rb +215 -0
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +217 -0
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +221 -0
- data/lib/ngrokapi/services/tls_certificates_client.rb +213 -161
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +237 -0
- data/lib/ngrokapi/services/tunnels_client.rb +78 -0
- data/lib/ngrokapi/version.rb +1 -1
- data/lib/ngrokapi.rb +1 -1
- data/ngrok-api.gemspec +1 -1
- data/spec/ngrokapi/client_spec.rb +158 -33
- data/spec/ngrokapi/models/abuse_report_hostname_spec.rb +21 -0
- data/spec/ngrokapi/models/abuse_report_spec.rb +21 -0
- data/spec/ngrokapi/models/agent_ingress_spec.rb +42 -0
- data/spec/ngrokapi/models/api_key_spec.rb +42 -43
- data/spec/ngrokapi/models/aws_auth_spec.rb +21 -0
- data/spec/ngrokapi/models/aws_credentials_spec.rb +21 -0
- data/spec/ngrokapi/models/aws_role_spec.rb +21 -0
- data/spec/ngrokapi/models/certificate_authority_spec.rb +42 -0
- data/spec/ngrokapi/models/credential_spec.rb +45 -0
- data/spec/ngrokapi/models/endpoint_circuit_breaker_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_compression_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_configuration_spec.rb +78 -0
- data/spec/ngrokapi/models/endpoint_ip_policy_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_ip_policy_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_logging_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_logging_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_mutual_tls_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_mutual_tls_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_facebook_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_git_hub_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_google_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_microsoft_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_provider_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_oidc_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_request_headers_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_response_headers_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_saml_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_saml_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_tls_termination_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_webhook_validation_spec.rb +21 -0
- data/spec/ngrokapi/models/event_destination_spec.rb +28 -0
- data/spec/ngrokapi/models/event_source_list_spec.rb +21 -0
- data/spec/ngrokapi/models/event_source_replace_spec.rb +21 -0
- data/spec/ngrokapi/models/event_source_spec.rb +21 -0
- data/spec/ngrokapi/models/event_stream_spec.rb +51 -0
- data/spec/ngrokapi/models/event_subscription_spec.rb +28 -0
- data/spec/ngrokapi/models/event_target_cloudwatch_logs_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_firehose_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_kinesis_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_spec.rb +21 -0
- data/spec/ngrokapi/models/ip_policy_rule_spec.rb +45 -0
- data/spec/ngrokapi/models/ip_policy_spec.rb +42 -0
- data/spec/ngrokapi/models/ip_restriction_spec.rb +28 -0
- data/spec/ngrokapi/models/listable_spec.rb +4 -4
- data/spec/ngrokapi/models/ref_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_addr_spec.rb +28 -0
- data/spec/ngrokapi/models/reserved_domain_cert_job_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_cert_status_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_spec.rb +28 -100
- data/spec/ngrokapi/models/ssh_certificate_authority_spec.rb +42 -0
- data/spec/ngrokapi/models/ssh_credential_spec.rb +45 -0
- data/spec/ngrokapi/models/ssh_host_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/ssh_user_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/tls_certificate_sa_ns_spec.rb +21 -0
- data/spec/ngrokapi/models/tls_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/tunnel_session_spec.rb +21 -0
- data/spec/ngrokapi/models/tunnel_spec.rb +21 -0
- data/spec/ngrokapi/paged_iterator_spec.rb +7 -7
- data/spec/ngrokapi/services/.gitkeep +0 -0
- data/spec/ngrokapi/services/abuse_reports_client_spec.rb +65 -0
- data/spec/ngrokapi/services/agent_ingresses_client_spec.rb +159 -0
- data/spec/ngrokapi/services/api_keys_client_spec.rb +157 -127
- data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +159 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +163 -0
- data/spec/ngrokapi/services/endpoint_circuit_breaker_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_compression_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +237 -0
- data/spec/ngrokapi/services/endpoint_ip_policy_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_mutual_tls_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_o_auth_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_oidc_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_request_headers_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_response_headers_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_saml_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_tls_termination_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_webhook_validation_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/event_destinations_client_spec.rb +172 -0
- data/spec/ngrokapi/services/event_sources_client_spec.rb +192 -0
- data/spec/ngrokapi/services/event_streams_client_spec.rb +177 -0
- data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +169 -0
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +159 -0
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +165 -0
- data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +171 -0
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +206 -0
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +349 -0
- data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +163 -0
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +165 -0
- data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +167 -0
- data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +171 -0
- data/spec/ngrokapi/services/tls_certificates_client_spec.rb +161 -0
- data/spec/ngrokapi/services/tunnel_sessions_client_spec.rb +183 -0
- data/spec/ngrokapi/services/tunnels_client_spec.rb +21 -0
- data/spec/spec_helper.rb +1096 -80
- metadata +360 -11
@@ -4,9 +4,9 @@
|
|
4
4
|
<meta charset="utf-8">
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
6
|
<title>
|
7
|
-
Class: NgrokAPI::Models::
|
7
|
+
Class: NgrokAPI::Models::APIKey
|
8
8
|
|
9
|
-
— Documentation by YARD 0.9.
|
9
|
+
— Documentation by YARD 0.9.27
|
10
10
|
|
11
11
|
</title>
|
12
12
|
|
@@ -15,7 +15,7 @@
|
|
15
15
|
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
16
16
|
|
17
17
|
<script type="text/javascript">
|
18
|
-
pathId = "NgrokAPI::Models::
|
18
|
+
pathId = "NgrokAPI::Models::APIKey";
|
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="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span>
|
41
41
|
»
|
42
|
-
<span class="title">
|
42
|
+
<span class="title">APIKey</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::Models::
|
62
|
+
<div id="content"><h1>Class: NgrokAPI::Models::APIKey
|
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::Models::
|
77
|
+
<li class="next">NgrokAPI::Models::APIKey</li>
|
78
78
|
|
79
79
|
</ul>
|
80
80
|
<a href="#" class="inheritanceTree">show all</a>
|
@@ -99,19 +99,8 @@
|
|
99
99
|
|
100
100
|
</div>
|
101
101
|
|
102
|
-
<h2>Overview</h2><div class="docstring">
|
103
|
-
<div class="discussion">
|
104
|
-
|
105
|
-
<p>A resource representing data from the api_keys API</p>
|
106
102
|
|
107
103
|
|
108
|
-
</div>
|
109
|
-
</div>
|
110
|
-
<div class="tags">
|
111
|
-
|
112
|
-
|
113
|
-
</div>
|
114
|
-
|
115
104
|
|
116
105
|
|
117
106
|
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
@@ -387,7 +376,7 @@
|
|
387
376
|
<li class="public ">
|
388
377
|
<span class="summary_signature">
|
389
378
|
|
390
|
-
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong> ⇒
|
379
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong> ⇒ Object </a>
|
391
380
|
|
392
381
|
|
393
382
|
|
@@ -402,7 +391,7 @@
|
|
402
391
|
|
403
392
|
|
404
393
|
<span class="summary_desc"><div class='inline'>
|
405
|
-
<p>Delete
|
394
|
+
<p>Delete an API key by ID.</p>
|
406
395
|
</div></span>
|
407
396
|
|
408
397
|
</li>
|
@@ -411,7 +400,7 @@
|
|
411
400
|
<li class="public ">
|
412
401
|
<span class="summary_signature">
|
413
402
|
|
414
|
-
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:, result:) ⇒
|
403
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:, result:) ⇒ APIKey </a>
|
415
404
|
|
416
405
|
|
417
406
|
|
@@ -428,7 +417,7 @@
|
|
428
417
|
|
429
418
|
|
430
419
|
<span class="summary_desc"><div class='inline'>
|
431
|
-
<p>A new instance of
|
420
|
+
<p>A new instance of APIKey.</p>
|
432
421
|
</div></span>
|
433
422
|
|
434
423
|
</li>
|
@@ -459,7 +448,7 @@
|
|
459
448
|
<li class="public ">
|
460
449
|
<span class="summary_signature">
|
461
450
|
|
462
|
-
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(description: nil, metadata: nil) ⇒
|
451
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(description: nil, metadata: nil) ⇒ Object </a>
|
463
452
|
|
464
453
|
|
465
454
|
|
@@ -474,7 +463,7 @@
|
|
474
463
|
|
475
464
|
|
476
465
|
<span class="summary_desc"><div class='inline'>
|
477
|
-
<p>Update
|
466
|
+
<p>Update attributes of an API key by ID.</p>
|
478
467
|
</div></span>
|
479
468
|
|
480
469
|
</li>
|
@@ -489,7 +478,7 @@
|
|
489
478
|
<div class="method_details first">
|
490
479
|
<h3 class="signature first" id="initialize-instance_method">
|
491
480
|
|
492
|
-
#<strong>initialize</strong>(client:, result:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Models::
|
481
|
+
#<strong>initialize</strong>(client:, result:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Models::APIKey (class)">APIKey</a></span></tt>
|
493
482
|
|
494
483
|
|
495
484
|
|
@@ -498,7 +487,7 @@
|
|
498
487
|
</h3><div class="docstring">
|
499
488
|
<div class="discussion">
|
500
489
|
|
501
|
-
<p>Returns a new instance of
|
490
|
+
<p>Returns a new instance of APIKey.</p>
|
502
491
|
|
503
492
|
|
504
493
|
</div>
|
@@ -512,6 +501,8 @@
|
|
512
501
|
<pre class="lines">
|
513
502
|
|
514
503
|
|
504
|
+
15
|
505
|
+
16
|
515
506
|
17
|
516
507
|
18
|
517
508
|
19
|
@@ -519,22 +510,20 @@
|
|
519
510
|
21
|
520
511
|
22
|
521
512
|
23
|
522
|
-
24
|
523
|
-
25
|
524
|
-
26</pre>
|
513
|
+
24</pre>
|
525
514
|
</td>
|
526
515
|
<td>
|
527
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line
|
528
|
-
|
529
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='comma'>,</span> <span class='label'>result:</span><span class='rparen'>)</span>
|
530
|
-
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
531
|
-
<span class='ivar'>@result</span> <span class='op'>=</span> <span class='id identifier rubyid_result'>result</span>
|
532
|
-
<span class='ivar'>@
|
533
|
-
<span class='ivar'>@
|
534
|
-
<span class='ivar'>@description</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>description</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
535
|
-
<span class='ivar'>@metadata</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>metadata</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
536
|
-
<span class='ivar'>@
|
537
|
-
<span class='ivar'>@
|
516
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 15</span>
|
517
|
+
|
518
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='comma'>,</span> <span class='label'>result:</span><span class='rparen'>)</span>
|
519
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
520
|
+
<span class='ivar'>@result</span> <span class='op'>=</span> <span class='id identifier rubyid_result'>result</span>
|
521
|
+
<span class='ivar'>@id</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>id</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
522
|
+
<span class='ivar'>@uri</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>uri</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
523
|
+
<span class='ivar'>@description</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>description</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
524
|
+
<span class='ivar'>@metadata</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>metadata</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
525
|
+
<span class='ivar'>@created_at</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>created_at</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
526
|
+
<span class='ivar'>@token</span> <span class='op'>=</span> <span class='ivar'>@result</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>token</span><span class='tstring_end'>'</span></span><span class='rbracket'>]</span>
|
538
527
|
<span class='kw'>end</span></pre>
|
539
528
|
</td>
|
540
529
|
</tr>
|
@@ -574,12 +563,12 @@
|
|
574
563
|
<pre class="lines">
|
575
564
|
|
576
565
|
|
577
|
-
|
578
|
-
|
579
|
-
|
566
|
+
6
|
567
|
+
7
|
568
|
+
8</pre>
|
580
569
|
</td>
|
581
570
|
<td>
|
582
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line
|
571
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 6</span>
|
583
572
|
|
584
573
|
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
585
574
|
<span class='ivar'>@client</span>
|
@@ -617,12 +606,12 @@
|
|
617
606
|
<pre class="lines">
|
618
607
|
|
619
608
|
|
620
|
-
|
621
|
-
|
622
|
-
|
609
|
+
6
|
610
|
+
7
|
611
|
+
8</pre>
|
623
612
|
</td>
|
624
613
|
<td>
|
625
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line
|
614
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 6</span>
|
626
615
|
|
627
616
|
<span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span>
|
628
617
|
<span class='ivar'>@created_at</span>
|
@@ -660,12 +649,12 @@
|
|
660
649
|
<pre class="lines">
|
661
650
|
|
662
651
|
|
663
|
-
|
664
|
-
|
665
|
-
|
652
|
+
6
|
653
|
+
7
|
654
|
+
8</pre>
|
666
655
|
</td>
|
667
656
|
<td>
|
668
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line
|
657
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 6</span>
|
669
658
|
|
670
659
|
<span class='kw'>def</span> <span class='id identifier rubyid_description'>description</span>
|
671
660
|
<span class='ivar'>@description</span>
|
@@ -703,12 +692,12 @@
|
|
703
692
|
<pre class="lines">
|
704
693
|
|
705
694
|
|
706
|
-
|
707
|
-
|
708
|
-
|
695
|
+
6
|
696
|
+
7
|
697
|
+
8</pre>
|
709
698
|
</td>
|
710
699
|
<td>
|
711
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line
|
700
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 6</span>
|
712
701
|
|
713
702
|
<span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
|
714
703
|
<span class='ivar'>@id</span>
|
@@ -746,12 +735,12 @@
|
|
746
735
|
<pre class="lines">
|
747
736
|
|
748
737
|
|
749
|
-
|
750
|
-
|
751
|
-
|
738
|
+
6
|
739
|
+
7
|
740
|
+
8</pre>
|
752
741
|
</td>
|
753
742
|
<td>
|
754
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line
|
743
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 6</span>
|
755
744
|
|
756
745
|
<span class='kw'>def</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
757
746
|
<span class='ivar'>@metadata</span>
|
@@ -789,12 +778,12 @@
|
|
789
778
|
<pre class="lines">
|
790
779
|
|
791
780
|
|
792
|
-
|
793
|
-
|
794
|
-
|
781
|
+
6
|
782
|
+
7
|
783
|
+
8</pre>
|
795
784
|
</td>
|
796
785
|
<td>
|
797
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line
|
786
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 6</span>
|
798
787
|
|
799
788
|
<span class='kw'>def</span> <span class='id identifier rubyid_result'>result</span>
|
800
789
|
<span class='ivar'>@result</span>
|
@@ -832,12 +821,12 @@
|
|
832
821
|
<pre class="lines">
|
833
822
|
|
834
823
|
|
835
|
-
|
836
|
-
|
837
|
-
|
824
|
+
6
|
825
|
+
7
|
826
|
+
8</pre>
|
838
827
|
</td>
|
839
828
|
<td>
|
840
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line
|
829
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 6</span>
|
841
830
|
|
842
831
|
<span class='kw'>def</span> <span class='id identifier rubyid_token'>token</span>
|
843
832
|
<span class='ivar'>@token</span>
|
@@ -875,12 +864,12 @@
|
|
875
864
|
<pre class="lines">
|
876
865
|
|
877
866
|
|
878
|
-
|
879
|
-
|
880
|
-
|
867
|
+
6
|
868
|
+
7
|
869
|
+
8</pre>
|
881
870
|
</td>
|
882
871
|
<td>
|
883
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line
|
872
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 6</span>
|
884
873
|
|
885
874
|
<span class='kw'>def</span> <span class='id identifier rubyid_uri'>uri</span>
|
886
875
|
<span class='ivar'>@uri</span>
|
@@ -912,15 +901,15 @@
|
|
912
901
|
<pre class="lines">
|
913
902
|
|
914
903
|
|
915
|
-
|
916
|
-
|
917
|
-
|
904
|
+
26
|
905
|
+
27
|
906
|
+
28</pre>
|
918
907
|
</td>
|
919
908
|
<td>
|
920
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line
|
909
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 26</span>
|
921
910
|
|
922
|
-
<span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
|
923
|
-
<span class='ivar'>@result</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span>
|
911
|
+
<span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
|
912
|
+
<span class='ivar'>@result</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_result'>result</span>
|
924
913
|
<span class='kw'>end</span></pre>
|
925
914
|
</td>
|
926
915
|
</tr>
|
@@ -930,7 +919,7 @@
|
|
930
919
|
<div class="method_details ">
|
931
920
|
<h3 class="signature " id="delete-instance_method">
|
932
921
|
|
933
|
-
#<strong>delete</strong> ⇒ <tt>
|
922
|
+
#<strong>delete</strong> ⇒ <tt>Object</tt>
|
934
923
|
|
935
924
|
|
936
925
|
|
@@ -939,7 +928,7 @@
|
|
939
928
|
</h3><div class="docstring">
|
940
929
|
<div class="discussion">
|
941
930
|
|
942
|
-
<p>Delete
|
931
|
+
<p>Delete an API key by ID</p>
|
943
932
|
|
944
933
|
<p><a href="https://ngrok.com/docs/api#api-api-keys-delete">ngrok.com/docs/api#api-api-keys-delete</a></p>
|
945
934
|
|
@@ -948,24 +937,6 @@
|
|
948
937
|
</div>
|
949
938
|
<div class="tags">
|
950
939
|
|
951
|
-
<p class="tag_title">Returns:</p>
|
952
|
-
<ul class="return">
|
953
|
-
|
954
|
-
<li>
|
955
|
-
|
956
|
-
|
957
|
-
<span class='type'>(<tt>nil</tt>)</span>
|
958
|
-
|
959
|
-
|
960
|
-
|
961
|
-
—
|
962
|
-
<div class='inline'>
|
963
|
-
<p>result from delete request</p>
|
964
|
-
</div>
|
965
|
-
|
966
|
-
</li>
|
967
|
-
|
968
|
-
</ul>
|
969
940
|
|
970
941
|
</div><table class="source_code">
|
971
942
|
<tr>
|
@@ -973,15 +944,19 @@
|
|
973
944
|
<pre class="lines">
|
974
945
|
|
975
946
|
|
976
|
-
|
977
|
-
|
978
|
-
|
947
|
+
38
|
948
|
+
39
|
949
|
+
40
|
950
|
+
41
|
951
|
+
42</pre>
|
979
952
|
</td>
|
980
953
|
<td>
|
981
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line
|
954
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 38</span>
|
982
955
|
|
983
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span>
|
984
|
-
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span
|
956
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span>
|
957
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span>
|
958
|
+
<span class='label'>id:</span> <span class='ivar'>@id</span>
|
959
|
+
<span class='rparen'>)</span>
|
985
960
|
<span class='kw'>end</span></pre>
|
986
961
|
</td>
|
987
962
|
</tr>
|
@@ -1003,15 +978,15 @@
|
|
1003
978
|
<pre class="lines">
|
1004
979
|
|
1005
980
|
|
1006
|
-
|
1007
|
-
|
1008
|
-
|
981
|
+
30
|
982
|
+
31
|
983
|
+
32</pre>
|
1009
984
|
</td>
|
1010
985
|
<td>
|
1011
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line
|
986
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 30</span>
|
1012
987
|
|
1013
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
|
1014
|
-
<span class='ivar'>@result</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
988
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
|
989
|
+
<span class='ivar'>@result</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
|
1015
990
|
<span class='kw'>end</span></pre>
|
1016
991
|
</td>
|
1017
992
|
</tr>
|
@@ -1021,7 +996,7 @@
|
|
1021
996
|
<div class="method_details ">
|
1022
997
|
<h3 class="signature " id="update-instance_method">
|
1023
998
|
|
1024
|
-
#<strong>update</strong>(description: nil, metadata: nil) ⇒ <tt
|
999
|
+
#<strong>update</strong>(description: nil, metadata: nil) ⇒ <tt>Object</tt>
|
1025
1000
|
|
1026
1001
|
|
1027
1002
|
|
@@ -1030,7 +1005,7 @@
|
|
1030
1005
|
</h3><div class="docstring">
|
1031
1006
|
<div class="discussion">
|
1032
1007
|
|
1033
|
-
<p>Update
|
1008
|
+
<p>Update attributes of an API key by ID.</p>
|
1034
1009
|
|
1035
1010
|
<p><a href="https://ngrok.com/docs/api#api-api-keys-update">ngrok.com/docs/api#api-api-keys-update</a></p>
|
1036
1011
|
|
@@ -1038,65 +1013,7 @@
|
|
1038
1013
|
</div>
|
1039
1014
|
</div>
|
1040
1015
|
<div class="tags">
|
1041
|
-
<p class="tag_title">Parameters:</p>
|
1042
|
-
<ul class="param">
|
1043
1016
|
|
1044
|
-
<li>
|
1045
|
-
|
1046
|
-
<span class='name'>description</span>
|
1047
|
-
|
1048
|
-
|
1049
|
-
<span class='type'>(<tt>string</tt>)</span>
|
1050
|
-
|
1051
|
-
|
1052
|
-
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1053
|
-
|
1054
|
-
|
1055
|
-
—
|
1056
|
-
<div class='inline'>
|
1057
|
-
<p>human-readable description of what uses the API key to authenticate. optional, max 255 bytes.</p>
|
1058
|
-
</div>
|
1059
|
-
|
1060
|
-
</li>
|
1061
|
-
|
1062
|
-
<li>
|
1063
|
-
|
1064
|
-
<span class='name'>metadata</span>
|
1065
|
-
|
1066
|
-
|
1067
|
-
<span class='type'>(<tt>string</tt>)</span>
|
1068
|
-
|
1069
|
-
|
1070
|
-
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1071
|
-
|
1072
|
-
|
1073
|
-
—
|
1074
|
-
<div class='inline'>
|
1075
|
-
<p>arbitrary user-defined data of this API key. optional, max 4096 bytes</p>
|
1076
|
-
</div>
|
1077
|
-
|
1078
|
-
</li>
|
1079
|
-
|
1080
|
-
</ul>
|
1081
|
-
|
1082
|
-
<p class="tag_title">Returns:</p>
|
1083
|
-
<ul class="return">
|
1084
|
-
|
1085
|
-
<li>
|
1086
|
-
|
1087
|
-
|
1088
|
-
<span class='type'>(<tt><span class='object_link'><a href="" title="NgrokAPI::Models::ApiKey (class)">NgrokAPI::Models::ApiKey</a></span></tt>)</span>
|
1089
|
-
|
1090
|
-
|
1091
|
-
|
1092
|
-
—
|
1093
|
-
<div class='inline'>
|
1094
|
-
<p>result from update request</p>
|
1095
|
-
</div>
|
1096
|
-
|
1097
|
-
</li>
|
1098
|
-
|
1099
|
-
</ul>
|
1100
1017
|
|
1101
1018
|
</div><table class="source_code">
|
1102
1019
|
<tr>
|
@@ -1104,19 +1021,33 @@
|
|
1104
1021
|
<pre class="lines">
|
1105
1022
|
|
1106
1023
|
|
1024
|
+
48
|
1025
|
+
49
|
1026
|
+
50
|
1027
|
+
51
|
1028
|
+
52
|
1029
|
+
53
|
1030
|
+
54
|
1031
|
+
55
|
1107
1032
|
56
|
1108
1033
|
57
|
1109
1034
|
58
|
1110
|
-
59
|
1111
|
-
60</pre>
|
1035
|
+
59</pre>
|
1112
1036
|
</td>
|
1113
1037
|
<td>
|
1114
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line
|
1115
|
-
|
1116
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span
|
1117
|
-
<span class='
|
1118
|
-
<span class='
|
1119
|
-
|
1038
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/models/api_key.rb', line 48</span>
|
1039
|
+
|
1040
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
|
1041
|
+
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
1042
|
+
<span class='label'>metadata:</span> <span class='kw'>nil</span>
|
1043
|
+
<span class='rparen'>)</span>
|
1044
|
+
<span class='ivar'>@description</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>
|
1045
|
+
<span class='ivar'>@metadata</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>
|
1046
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
|
1047
|
+
<span class='label'>id:</span> <span class='ivar'>@id</span><span class='comma'>,</span>
|
1048
|
+
<span class='label'>description:</span> <span class='id identifier rubyid_description'>description</span><span class='comma'>,</span>
|
1049
|
+
<span class='label'>metadata:</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
1050
|
+
<span class='rparen'>)</span>
|
1120
1051
|
<span class='kw'>end</span></pre>
|
1121
1052
|
</td>
|
1122
1053
|
</tr>
|
@@ -1128,9 +1059,9 @@
|
|
1128
1059
|
</div>
|
1129
1060
|
|
1130
1061
|
<div id="footer">
|
1131
|
-
Generated on
|
1062
|
+
Generated on Thu Dec 2 18:48:49 2021 by
|
1132
1063
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1133
|
-
0.9.
|
1064
|
+
0.9.27 (ruby-3.0.1).
|
1134
1065
|
</div>
|
1135
1066
|
|
1136
1067
|
</div>
|