ngrok-api 0.9.0 → 0.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.rubocop.yml +2 -2
- data/.yardopts +1 -0
- data/LICENSE +7 -0
- data/doc/NgrokAPI/Client.html +1469 -125
- data/doc/NgrokAPI/Error.html +3 -3
- data/doc/NgrokAPI/Errors/NotFoundError.html +3 -3
- data/doc/NgrokAPI/Errors.html +3 -3
- data/doc/NgrokAPI/HttpClient.html +66 -36
- data/doc/NgrokAPI/Models/{ApiKey.html → APIKey.html} +110 -179
- data/doc/NgrokAPI/Models/AWSAuth.html +617 -0
- data/doc/NgrokAPI/Models/AWSCredentials.html +617 -0
- data/doc/NgrokAPI/Models/AWSRole.html +543 -0
- data/doc/NgrokAPI/Models/AbuseReport.html +987 -0
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +617 -0
- data/doc/NgrokAPI/Models/AgentIngress.html +1217 -0
- data/doc/NgrokAPI/Models/CertificateAuthority.html +1439 -0
- data/doc/NgrokAPI/Models/Credential.html +1149 -0
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +913 -0
- data/doc/NgrokAPI/Models/EndpointCompression.html +543 -0
- data/doc/NgrokAPI/Models/EndpointConfiguration.html +1323 -512
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +617 -0
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointLogging.html +617 -0
- data/doc/NgrokAPI/Models/EndpointLoggingMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +617 -0
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointOAuth.html +987 -0
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +987 -0
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +765 -0
- data/doc/NgrokAPI/Models/EndpointOIDC.html +1135 -0
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +691 -0
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +691 -0
- data/doc/NgrokAPI/Models/EndpointSAML.html +1653 -0
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +1283 -0
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +691 -0
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +691 -0
- data/doc/NgrokAPI/Models/EventDestination.html +1058 -0
- data/doc/NgrokAPI/Models/EventSource.html +765 -0
- data/doc/NgrokAPI/Models/EventSourceList.html +617 -0
- data/doc/NgrokAPI/Models/EventSourceReplace.html +691 -0
- data/doc/NgrokAPI/Models/EventStream.html +1309 -0
- data/doc/NgrokAPI/Models/EventSubscription.html +1058 -0
- data/doc/NgrokAPI/Models/EventTarget.html +765 -0
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +617 -0
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +617 -0
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +617 -0
- data/doc/NgrokAPI/Models/{TlsCertificate.html → IPPolicy.html} +172 -167
- data/doc/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/doc/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/doc/NgrokAPI/Models/Listable.html +120 -52
- data/doc/NgrokAPI/Models/Ref.html +617 -0
- data/doc/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/doc/NgrokAPI/Models/ReservedDomain.html +186 -1108
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +765 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +617 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +617 -0
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +1143 -0
- data/doc/NgrokAPI/Models/SSHCredential.html +1149 -0
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +1513 -0
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +1661 -0
- data/doc/NgrokAPI/Models/TLSCertificate.html +2179 -0
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +617 -0
- data/doc/NgrokAPI/Models/Tunnel.html +987 -0
- data/doc/NgrokAPI/Models/TunnelSession.html +1209 -0
- data/doc/NgrokAPI/Models.html +6 -6
- data/doc/NgrokAPI/PagedIterator.html +16 -12
- data/{docs/NgrokAPI/Services/ApiKeysClient.html → doc/NgrokAPI/Services/APIKeysClient.html} +404 -153
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +706 -0
- data/doc/NgrokAPI/Services/AgentIngressesClient.html +1600 -0
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +1602 -0
- data/doc/NgrokAPI/Services/CredentialsClient.html +1644 -0
- data/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +503 -370
- data/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +1712 -0
- data/doc/NgrokAPI/Services/EventSourcesClient.html +1532 -0
- data/doc/NgrokAPI/Services/EventStreamsClient.html +1792 -0
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +1712 -0
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +1602 -0
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +1660 -0
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +1720 -0
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +1894 -0
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +585 -344
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1644 -0
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +1662 -0
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +1680 -0
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +1720 -0
- data/{docs/NgrokAPI/Services/TlsCertificatesClient.html → doc/NgrokAPI/Services/TLSCertificatesClient.html} +404 -201
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +1587 -0
- data/doc/NgrokAPI/Services/TunnelsClient.html +669 -0
- data/doc/NgrokAPI/Services.html +6 -6
- data/doc/NgrokAPI.html +5 -5
- data/doc/README +94 -0
- data/doc/_index.html +621 -25
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +55 -28
- data/doc/frames.html +1 -1
- data/doc/index.html +55 -28
- data/doc/method_list.html +7526 -286
- data/doc/top-level-namespace.html +3 -3
- data/docs/.gitkeep +0 -0
- data/docs/CNAME +1 -0
- data/docs/NgrokAPI/Client.html +1469 -125
- data/docs/NgrokAPI/Error.html +3 -3
- data/docs/NgrokAPI/Errors/NotFoundError.html +3 -3
- data/docs/NgrokAPI/Errors.html +3 -3
- data/docs/NgrokAPI/HttpClient.html +66 -36
- data/docs/NgrokAPI/Models/{ApiKey.html → APIKey.html} +110 -179
- data/docs/NgrokAPI/Models/AWSAuth.html +617 -0
- data/docs/NgrokAPI/Models/AWSCredentials.html +617 -0
- data/docs/NgrokAPI/Models/AWSRole.html +543 -0
- data/docs/NgrokAPI/Models/AbuseReport.html +987 -0
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +617 -0
- data/docs/NgrokAPI/Models/AgentIngress.html +1217 -0
- data/docs/NgrokAPI/Models/CertificateAuthority.html +1439 -0
- data/docs/NgrokAPI/Models/Credential.html +1149 -0
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +913 -0
- data/docs/NgrokAPI/Models/EndpointCompression.html +543 -0
- data/docs/NgrokAPI/Models/EndpointConfiguration.html +1323 -512
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +617 -0
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointLogging.html +617 -0
- data/docs/NgrokAPI/Models/EndpointLoggingMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +617 -0
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointOAuth.html +987 -0
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +987 -0
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +765 -0
- data/docs/NgrokAPI/Models/EndpointOIDC.html +1135 -0
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +691 -0
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +691 -0
- data/docs/NgrokAPI/Models/EndpointSAML.html +1653 -0
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +1283 -0
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +691 -0
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +691 -0
- data/docs/NgrokAPI/Models/EventDestination.html +1058 -0
- data/docs/NgrokAPI/Models/EventSource.html +765 -0
- data/docs/NgrokAPI/Models/EventSourceList.html +617 -0
- data/docs/NgrokAPI/Models/EventSourceReplace.html +691 -0
- data/docs/NgrokAPI/Models/EventStream.html +1309 -0
- data/docs/NgrokAPI/Models/EventSubscription.html +1058 -0
- data/docs/NgrokAPI/Models/EventTarget.html +765 -0
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +617 -0
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +617 -0
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +617 -0
- data/docs/NgrokAPI/Models/{TlsCertificate.html → IPPolicy.html} +172 -167
- data/docs/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/docs/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/docs/NgrokAPI/Models/Listable.html +120 -52
- data/docs/NgrokAPI/Models/Ref.html +617 -0
- data/docs/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/docs/NgrokAPI/Models/ReservedDomain.html +186 -1108
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +765 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +617 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +617 -0
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +1143 -0
- data/docs/NgrokAPI/Models/SSHCredential.html +1149 -0
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +1513 -0
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +1661 -0
- data/docs/NgrokAPI/Models/TLSCertificate.html +2179 -0
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +617 -0
- data/docs/NgrokAPI/Models/Tunnel.html +987 -0
- data/docs/NgrokAPI/Models/TunnelSession.html +1209 -0
- data/docs/NgrokAPI/Models.html +6 -6
- data/docs/NgrokAPI/PagedIterator.html +16 -12
- data/{doc/NgrokAPI/Services/ApiKeysClient.html → docs/NgrokAPI/Services/APIKeysClient.html} +404 -153
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +706 -0
- data/docs/NgrokAPI/Services/AgentIngressesClient.html +1600 -0
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +1602 -0
- data/docs/NgrokAPI/Services/CredentialsClient.html +1644 -0
- data/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +503 -370
- data/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +1712 -0
- data/docs/NgrokAPI/Services/EventSourcesClient.html +1532 -0
- data/docs/NgrokAPI/Services/EventStreamsClient.html +1792 -0
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +1712 -0
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +1602 -0
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +1660 -0
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +1720 -0
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +1894 -0
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +585 -344
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1644 -0
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +1662 -0
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +1680 -0
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +1720 -0
- data/{doc/NgrokAPI/Services/TlsCertificatesClient.html → docs/NgrokAPI/Services/TLSCertificatesClient.html} +404 -201
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +1587 -0
- data/docs/NgrokAPI/Services/TunnelsClient.html +669 -0
- data/docs/NgrokAPI/Services.html +6 -6
- data/docs/NgrokAPI.html +5 -5
- data/docs/README +94 -0
- data/docs/_index.html +621 -25
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +55 -28
- data/docs/frames.html +1 -1
- data/docs/index.html +55 -28
- data/docs/method_list.html +7526 -286
- data/docs/top-level-namespace.html +3 -3
- data/lib/ngrokapi/client.rb +229 -49
- data/lib/ngrokapi/http_client.rb +6 -7
- data/lib/ngrokapi/models/abuse_report.rb +37 -0
- data/lib/ngrokapi/models/abuse_report_hostname.rb +27 -0
- data/lib/ngrokapi/models/agent_ingress.rb +66 -0
- data/lib/ngrokapi/models/api_key.rb +62 -64
- data/lib/ngrokapi/models/aws_auth.rb +27 -0
- data/lib/ngrokapi/models/aws_credentials.rb +27 -0
- data/lib/ngrokapi/models/aws_role.rb +25 -0
- data/lib/ngrokapi/models/certificate_authority.rb +72 -0
- data/lib/ngrokapi/models/credential.rb +67 -0
- data/lib/ngrokapi/models/endpoint_circuit_breaker.rb +35 -0
- data/lib/ngrokapi/models/endpoint_compression.rb +25 -0
- data/lib/ngrokapi/models/endpoint_configuration.rb +130 -119
- data/lib/ngrokapi/models/endpoint_ip_policy.rb +27 -0
- data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_logging.rb +27 -0
- data/lib/ngrokapi/models/endpoint_logging_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_mutual_tls.rb +27 -0
- data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_o_auth.rb +37 -0
- data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb +37 -0
- data/lib/ngrokapi/models/endpoint_o_auth_google.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_microsoft.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_provider.rb +31 -0
- data/lib/ngrokapi/models/endpoint_oidc.rb +41 -0
- data/lib/ngrokapi/models/endpoint_request_headers.rb +29 -0
- data/lib/ngrokapi/models/endpoint_response_headers.rb +29 -0
- data/lib/ngrokapi/models/endpoint_saml.rb +55 -0
- data/lib/ngrokapi/models/endpoint_saml_mutate.rb +45 -0
- data/lib/ngrokapi/models/endpoint_tls_termination.rb +29 -0
- data/lib/ngrokapi/models/endpoint_webhook_validation.rb +29 -0
- data/lib/ngrokapi/models/event_destination.rb +49 -0
- data/lib/ngrokapi/models/event_source.rb +31 -0
- data/lib/ngrokapi/models/event_source_list.rb +27 -0
- data/lib/ngrokapi/models/event_source_replace.rb +29 -0
- data/lib/ngrokapi/models/event_stream.rb +77 -0
- data/lib/ngrokapi/models/event_subscription.rb +47 -0
- data/lib/ngrokapi/models/event_target.rb +31 -0
- data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb +27 -0
- data/lib/ngrokapi/models/event_target_firehose.rb +27 -0
- data/lib/ngrokapi/models/event_target_kinesis.rb +27 -0
- data/lib/ngrokapi/models/ip_policy.rb +64 -0
- data/lib/ngrokapi/models/ip_policy_rule.rb +67 -0
- data/lib/ngrokapi/models/ip_restriction.rb +49 -0
- data/lib/ngrokapi/models/listable.rb +13 -2
- data/lib/ngrokapi/models/ref.rb +27 -0
- data/lib/ngrokapi/models/reserved_addr.rb +49 -0
- data/lib/ngrokapi/models/reserved_domain.rb +61 -211
- data/lib/ngrokapi/models/reserved_domain_cert_job.rb +31 -0
- data/lib/ngrokapi/models/reserved_domain_cert_policy.rb +27 -0
- data/lib/ngrokapi/models/reserved_domain_cert_status.rb +27 -0
- data/lib/ngrokapi/models/ssh_certificate_authority.rb +64 -0
- data/lib/ngrokapi/models/ssh_credential.rb +67 -0
- data/lib/ngrokapi/models/ssh_host_certificate.rb +74 -0
- data/lib/ngrokapi/models/ssh_user_certificate.rb +78 -0
- data/lib/ngrokapi/models/tls_certificate.rb +92 -62
- data/lib/ngrokapi/models/tls_certificate_sa_ns.rb +27 -0
- data/lib/ngrokapi/models/tunnel.rb +37 -0
- data/lib/ngrokapi/models/tunnel_session.rb +43 -0
- data/lib/ngrokapi/paged_iterator.rb +4 -2
- data/lib/ngrokapi/services/.gitkeep +0 -0
- data/lib/ngrokapi/services/abuse_reports_client.rb +77 -0
- data/lib/ngrokapi/services/agent_ingresses_client.rb +206 -0
- data/lib/ngrokapi/services/api_keys_client.rb +210 -144
- data/lib/ngrokapi/services/certificate_authorities_client.rb +211 -0
- data/lib/ngrokapi/services/credentials_client.rb +217 -0
- data/lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_compression_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +289 -313
- data/lib/ngrokapi/services/endpoint_ip_policy_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_logging_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_o_auth_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_oidc_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_request_headers_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_response_headers_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_saml_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_tls_termination_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb +108 -0
- data/lib/ngrokapi/services/event_destinations_client.rb +221 -0
- data/lib/ngrokapi/services/event_sources_client.rb +185 -0
- data/lib/ngrokapi/services/event_streams_client.rb +224 -0
- data/lib/ngrokapi/services/event_subscriptions_client.rb +215 -0
- data/lib/ngrokapi/services/ip_policies_client.rb +215 -0
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +214 -0
- data/lib/ngrokapi/services/ip_restrictions_client.rb +224 -0
- data/lib/ngrokapi/services/reserved_addrs_client.rb +246 -0
- data/lib/ngrokapi/services/reserved_domains_client.rb +360 -313
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +212 -0
- data/lib/ngrokapi/services/ssh_credentials_client.rb +215 -0
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +217 -0
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +221 -0
- data/lib/ngrokapi/services/tls_certificates_client.rb +213 -161
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +237 -0
- data/lib/ngrokapi/services/tunnels_client.rb +78 -0
- data/lib/ngrokapi/version.rb +1 -1
- data/lib/ngrokapi.rb +1 -1
- data/ngrok-api.gemspec +1 -1
- data/spec/ngrokapi/client_spec.rb +158 -33
- data/spec/ngrokapi/models/abuse_report_hostname_spec.rb +21 -0
- data/spec/ngrokapi/models/abuse_report_spec.rb +21 -0
- data/spec/ngrokapi/models/agent_ingress_spec.rb +42 -0
- data/spec/ngrokapi/models/api_key_spec.rb +42 -43
- data/spec/ngrokapi/models/aws_auth_spec.rb +21 -0
- data/spec/ngrokapi/models/aws_credentials_spec.rb +21 -0
- data/spec/ngrokapi/models/aws_role_spec.rb +21 -0
- data/spec/ngrokapi/models/certificate_authority_spec.rb +42 -0
- data/spec/ngrokapi/models/credential_spec.rb +45 -0
- data/spec/ngrokapi/models/endpoint_circuit_breaker_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_compression_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_configuration_spec.rb +78 -0
- data/spec/ngrokapi/models/endpoint_ip_policy_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_ip_policy_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_logging_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_logging_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_mutual_tls_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_mutual_tls_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_facebook_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_git_hub_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_google_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_microsoft_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_provider_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_oidc_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_request_headers_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_response_headers_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_saml_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_saml_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_tls_termination_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_webhook_validation_spec.rb +21 -0
- data/spec/ngrokapi/models/event_destination_spec.rb +28 -0
- data/spec/ngrokapi/models/event_source_list_spec.rb +21 -0
- data/spec/ngrokapi/models/event_source_replace_spec.rb +21 -0
- data/spec/ngrokapi/models/event_source_spec.rb +21 -0
- data/spec/ngrokapi/models/event_stream_spec.rb +51 -0
- data/spec/ngrokapi/models/event_subscription_spec.rb +28 -0
- data/spec/ngrokapi/models/event_target_cloudwatch_logs_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_firehose_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_kinesis_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_spec.rb +21 -0
- data/spec/ngrokapi/models/ip_policy_rule_spec.rb +45 -0
- data/spec/ngrokapi/models/ip_policy_spec.rb +42 -0
- data/spec/ngrokapi/models/ip_restriction_spec.rb +28 -0
- data/spec/ngrokapi/models/listable_spec.rb +4 -4
- data/spec/ngrokapi/models/ref_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_addr_spec.rb +28 -0
- data/spec/ngrokapi/models/reserved_domain_cert_job_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_cert_status_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_spec.rb +28 -100
- data/spec/ngrokapi/models/ssh_certificate_authority_spec.rb +42 -0
- data/spec/ngrokapi/models/ssh_credential_spec.rb +45 -0
- data/spec/ngrokapi/models/ssh_host_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/ssh_user_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/tls_certificate_sa_ns_spec.rb +21 -0
- data/spec/ngrokapi/models/tls_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/tunnel_session_spec.rb +21 -0
- data/spec/ngrokapi/models/tunnel_spec.rb +21 -0
- data/spec/ngrokapi/paged_iterator_spec.rb +7 -7
- data/spec/ngrokapi/services/.gitkeep +0 -0
- data/spec/ngrokapi/services/abuse_reports_client_spec.rb +65 -0
- data/spec/ngrokapi/services/agent_ingresses_client_spec.rb +159 -0
- data/spec/ngrokapi/services/api_keys_client_spec.rb +157 -127
- data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +159 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +163 -0
- data/spec/ngrokapi/services/endpoint_circuit_breaker_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_compression_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +237 -0
- data/spec/ngrokapi/services/endpoint_ip_policy_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_mutual_tls_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_o_auth_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_oidc_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_request_headers_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_response_headers_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_saml_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_tls_termination_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_webhook_validation_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/event_destinations_client_spec.rb +172 -0
- data/spec/ngrokapi/services/event_sources_client_spec.rb +192 -0
- data/spec/ngrokapi/services/event_streams_client_spec.rb +177 -0
- data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +169 -0
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +159 -0
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +165 -0
- data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +171 -0
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +206 -0
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +349 -0
- data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +163 -0
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +165 -0
- data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +167 -0
- data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +171 -0
- data/spec/ngrokapi/services/tls_certificates_client_spec.rb +161 -0
- data/spec/ngrokapi/services/tunnel_sessions_client_spec.rb +183 -0
- data/spec/ngrokapi/services/tunnels_client_spec.rb +21 -0
- data/spec/spec_helper.rb +1096 -80
- metadata +360 -11
|
@@ -4,9 +4,9 @@
|
|
|
4
4
|
<meta charset="utf-8">
|
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
6
|
<title>
|
|
7
|
-
Class: NgrokAPI::Services::
|
|
7
|
+
Class: NgrokAPI::Services::APIKeysClient
|
|
8
8
|
|
|
9
|
-
— Documentation by YARD 0.9.
|
|
9
|
+
— Documentation by YARD 0.9.27
|
|
10
10
|
|
|
11
11
|
</title>
|
|
12
12
|
|
|
@@ -15,7 +15,7 @@
|
|
|
15
15
|
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
|
16
16
|
|
|
17
17
|
<script type="text/javascript">
|
|
18
|
-
pathId = "NgrokAPI::Services::
|
|
18
|
+
pathId = "NgrokAPI::Services::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,7 @@
|
|
|
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 API</a>. You may use the API itself to provision and manage API Keys but you'll need to provision your first API key from the <a href="https://dashboard.ngrok.com/api/keys">API Keys page</a> on your ngrok.com dashboard.</p>
|
|
106
106
|
|
|
107
107
|
<p><a href="https://ngrok.com/docs/api#api-api-keys">ngrok.com/docs/api#api-api-keys</a></p>
|
|
108
108
|
|
|
@@ -121,11 +121,11 @@
|
|
|
121
121
|
|
|
122
122
|
<dl class="constants">
|
|
123
123
|
|
|
124
|
-
<dt id="
|
|
124
|
+
<dt id="PATH-constant" class="">PATH =
|
|
125
125
|
<div class="docstring">
|
|
126
126
|
<div class="discussion">
|
|
127
127
|
|
|
128
|
-
<p>The
|
|
128
|
+
<p>The API path for the requests</p>
|
|
129
129
|
|
|
130
130
|
|
|
131
131
|
</div>
|
|
@@ -135,13 +135,13 @@
|
|
|
135
135
|
|
|
136
136
|
</div>
|
|
137
137
|
</dt>
|
|
138
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'
|
|
138
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/api_keys</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
139
139
|
|
|
140
|
-
<dt id="
|
|
140
|
+
<dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
|
|
141
141
|
<div class="docstring">
|
|
142
142
|
<div class="discussion">
|
|
143
143
|
|
|
144
|
-
<p>The
|
|
144
|
+
<p>The List Property from the resulting API for list calls</p>
|
|
145
145
|
|
|
146
146
|
|
|
147
147
|
</div>
|
|
@@ -151,7 +151,7 @@
|
|
|
151
151
|
|
|
152
152
|
</div>
|
|
153
153
|
</dt>
|
|
154
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'
|
|
154
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>keys</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
155
155
|
|
|
156
156
|
</dl>
|
|
157
157
|
|
|
@@ -207,7 +207,7 @@
|
|
|
207
207
|
<li class="public ">
|
|
208
208
|
<span class="summary_signature">
|
|
209
209
|
|
|
210
|
-
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description:
|
|
210
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: "", metadata: "") ⇒ NgrokAPI::Models::APIKey </a>
|
|
211
211
|
|
|
212
212
|
|
|
213
213
|
|
|
@@ -231,7 +231,7 @@
|
|
|
231
231
|
<li class="public ">
|
|
232
232
|
<span class="summary_signature">
|
|
233
233
|
|
|
234
|
-
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id:
|
|
234
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
235
235
|
|
|
236
236
|
|
|
237
237
|
|
|
@@ -255,7 +255,7 @@
|
|
|
255
255
|
<li class="public ">
|
|
256
256
|
<span class="summary_signature">
|
|
257
257
|
|
|
258
|
-
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id:
|
|
258
|
+
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
259
259
|
|
|
260
260
|
|
|
261
261
|
|
|
@@ -270,7 +270,7 @@
|
|
|
270
270
|
|
|
271
271
|
|
|
272
272
|
<span class="summary_desc"><div class='inline'>
|
|
273
|
-
<p>Delete an API key by ID.</p>
|
|
273
|
+
<p>Delete an API key by ID Throws an exception if API error.</p>
|
|
274
274
|
</div></span>
|
|
275
275
|
|
|
276
276
|
</li>
|
|
@@ -279,7 +279,7 @@
|
|
|
279
279
|
<li class="public ">
|
|
280
280
|
<span class="summary_signature">
|
|
281
281
|
|
|
282
|
-
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id:
|
|
282
|
+
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: "") ⇒ NgrokAPI::Models::APIKey </a>
|
|
283
283
|
|
|
284
284
|
|
|
285
285
|
|
|
@@ -303,7 +303,7 @@
|
|
|
303
303
|
<li class="public ">
|
|
304
304
|
<span class="summary_signature">
|
|
305
305
|
|
|
306
|
-
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id:
|
|
306
|
+
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: "") ⇒ NgrokAPI::Models::APIKey </a>
|
|
307
307
|
|
|
308
308
|
|
|
309
309
|
|
|
@@ -327,7 +327,7 @@
|
|
|
327
327
|
<li class="public ">
|
|
328
328
|
<span class="summary_signature">
|
|
329
329
|
|
|
330
|
-
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒
|
|
330
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒ APIKeysClient </a>
|
|
331
331
|
|
|
332
332
|
|
|
333
333
|
|
|
@@ -344,7 +344,7 @@
|
|
|
344
344
|
|
|
345
345
|
|
|
346
346
|
<span class="summary_desc"><div class='inline'>
|
|
347
|
-
<p>A new instance of
|
|
347
|
+
<p>A new instance of APIKeysClient.</p>
|
|
348
348
|
</div></span>
|
|
349
349
|
|
|
350
350
|
</li>
|
|
@@ -377,7 +377,31 @@
|
|
|
377
377
|
<li class="public ">
|
|
378
378
|
<span class="summary_signature">
|
|
379
379
|
|
|
380
|
-
<a href="#
|
|
380
|
+
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
381
|
+
|
|
382
|
+
|
|
383
|
+
|
|
384
|
+
</span>
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
<span class="summary_desc"><div class='inline'>
|
|
395
|
+
<p>List all API keys owned by this account Throws an exception if API error.</p>
|
|
396
|
+
</div></span>
|
|
397
|
+
|
|
398
|
+
</li>
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
<li class="public ">
|
|
402
|
+
<span class="summary_signature">
|
|
403
|
+
|
|
404
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::APIKey </a>
|
|
381
405
|
|
|
382
406
|
|
|
383
407
|
|
|
@@ -401,7 +425,7 @@
|
|
|
401
425
|
<li class="public ">
|
|
402
426
|
<span class="summary_signature">
|
|
403
427
|
|
|
404
|
-
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id:
|
|
428
|
+
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::APIKey </a>
|
|
405
429
|
|
|
406
430
|
|
|
407
431
|
|
|
@@ -431,7 +455,7 @@
|
|
|
431
455
|
<div class="method_details first">
|
|
432
456
|
<h3 class="signature first" id="initialize-instance_method">
|
|
433
457
|
|
|
434
|
-
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::
|
|
458
|
+
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::APIKeysClient (class)">APIKeysClient</a></span></tt>
|
|
435
459
|
|
|
436
460
|
|
|
437
461
|
|
|
@@ -440,7 +464,7 @@
|
|
|
440
464
|
</h3><div class="docstring">
|
|
441
465
|
<div class="discussion">
|
|
442
466
|
|
|
443
|
-
<p>Returns a new instance of
|
|
467
|
+
<p>Returns a new instance of APIKeysClient.</p>
|
|
444
468
|
|
|
445
469
|
|
|
446
470
|
</div>
|
|
@@ -454,15 +478,15 @@
|
|
|
454
478
|
<pre class="lines">
|
|
455
479
|
|
|
456
480
|
|
|
457
|
-
|
|
458
|
-
|
|
459
|
-
|
|
481
|
+
21
|
|
482
|
+
22
|
|
483
|
+
23</pre>
|
|
460
484
|
</td>
|
|
461
485
|
<td>
|
|
462
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line
|
|
486
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 21</span>
|
|
463
487
|
|
|
464
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='rparen'>)</span>
|
|
465
|
-
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
488
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='rparen'>)</span>
|
|
489
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
466
490
|
<span class='kw'>end</span></pre>
|
|
467
491
|
</td>
|
|
468
492
|
</tr>
|
|
@@ -502,12 +526,12 @@
|
|
|
502
526
|
<pre class="lines">
|
|
503
527
|
|
|
504
528
|
|
|
505
|
-
|
|
506
|
-
|
|
507
|
-
|
|
529
|
+
19
|
|
530
|
+
20
|
|
531
|
+
21</pre>
|
|
508
532
|
</td>
|
|
509
533
|
<td>
|
|
510
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line
|
|
534
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 19</span>
|
|
511
535
|
|
|
512
536
|
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
|
513
537
|
<span class='ivar'>@client</span>
|
|
@@ -527,7 +551,7 @@
|
|
|
527
551
|
<div class="method_details first">
|
|
528
552
|
<h3 class="signature first" id="create-instance_method">
|
|
529
553
|
|
|
530
|
-
#<strong>create</strong>(description:
|
|
554
|
+
#<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
555
|
|
|
532
556
|
|
|
533
557
|
|
|
@@ -555,7 +579,7 @@
|
|
|
555
579
|
<span class='type'>(<tt>string</tt>)</span>
|
|
556
580
|
|
|
557
581
|
|
|
558
|
-
<em class="default">(defaults to: <tt
|
|
582
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
559
583
|
|
|
560
584
|
|
|
561
585
|
—
|
|
@@ -573,7 +597,7 @@
|
|
|
573
597
|
<span class='type'>(<tt>string</tt>)</span>
|
|
574
598
|
|
|
575
599
|
|
|
576
|
-
<em class="default">(defaults to: <tt
|
|
600
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
577
601
|
|
|
578
602
|
|
|
579
603
|
—
|
|
@@ -591,13 +615,13 @@
|
|
|
591
615
|
<li>
|
|
592
616
|
|
|
593
617
|
|
|
594
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
|
618
|
+
<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
619
|
|
|
596
620
|
|
|
597
621
|
|
|
598
622
|
—
|
|
599
623
|
<div class='inline'>
|
|
600
|
-
<p>result from
|
|
624
|
+
<p>result from the API request</p>
|
|
601
625
|
</div>
|
|
602
626
|
|
|
603
627
|
</li>
|
|
@@ -610,17 +634,29 @@
|
|
|
610
634
|
<pre class="lines">
|
|
611
635
|
|
|
612
636
|
|
|
613
|
-
|
|
614
|
-
|
|
615
|
-
|
|
616
|
-
|
|
637
|
+
34
|
|
638
|
+
35
|
|
639
|
+
36
|
|
640
|
+
37
|
|
641
|
+
38
|
|
642
|
+
39
|
|
643
|
+
40
|
|
644
|
+
41
|
|
645
|
+
42
|
|
646
|
+
43</pre>
|
|
617
647
|
</td>
|
|
618
648
|
<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><span class='label'>description:</span> <span class='
|
|
622
|
-
<span class='id identifier
|
|
623
|
-
<span class='
|
|
649
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 34</span>
|
|
650
|
+
|
|
651
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
652
|
+
<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>
|
|
653
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
654
|
+
<span class='rbrace'>}</span>
|
|
655
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
656
|
+
<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>
|
|
657
|
+
<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>
|
|
658
|
+
<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>
|
|
659
|
+
<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
660
|
<span class='kw'>end</span></pre>
|
|
625
661
|
</td>
|
|
626
662
|
</tr>
|
|
@@ -630,7 +666,7 @@
|
|
|
630
666
|
<div class="method_details ">
|
|
631
667
|
<h3 class="signature " id="delete-instance_method">
|
|
632
668
|
|
|
633
|
-
#<strong>delete</strong>(id:
|
|
669
|
+
#<strong>delete</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
634
670
|
|
|
635
671
|
|
|
636
672
|
|
|
@@ -639,7 +675,7 @@
|
|
|
639
675
|
</h3><div class="docstring">
|
|
640
676
|
<div class="discussion">
|
|
641
677
|
|
|
642
|
-
<p>Delete an API key by ID
|
|
678
|
+
<p>Delete an API key by ID</p>
|
|
643
679
|
|
|
644
680
|
<p><a href="https://ngrok.com/docs/api#api-api-keys-delete">ngrok.com/docs/api#api-api-keys-delete</a></p>
|
|
645
681
|
|
|
@@ -658,7 +694,7 @@
|
|
|
658
694
|
<span class='type'>(<tt>string</tt>)</span>
|
|
659
695
|
|
|
660
696
|
|
|
661
|
-
<em class="default">(defaults to: <tt
|
|
697
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
662
698
|
|
|
663
699
|
|
|
664
700
|
—
|
|
@@ -676,13 +712,13 @@
|
|
|
676
712
|
<li>
|
|
677
713
|
|
|
678
714
|
|
|
679
|
-
<span class='type'>(<tt>
|
|
715
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
680
716
|
|
|
681
717
|
|
|
682
718
|
|
|
683
719
|
—
|
|
684
720
|
<div class='inline'>
|
|
685
|
-
<p>result from
|
|
721
|
+
<p>result from the API request</p>
|
|
686
722
|
</div>
|
|
687
723
|
|
|
688
724
|
</li>
|
|
@@ -695,15 +731,23 @@
|
|
|
695
731
|
<pre class="lines">
|
|
696
732
|
|
|
697
733
|
|
|
698
|
-
|
|
699
|
-
|
|
700
|
-
|
|
734
|
+
52
|
|
735
|
+
53
|
|
736
|
+
54
|
|
737
|
+
55
|
|
738
|
+
56
|
|
739
|
+
57
|
|
740
|
+
58</pre>
|
|
701
741
|
</td>
|
|
702
742
|
<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><span class='label'>id:</span> <span class='
|
|
706
|
-
<span class='
|
|
743
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 52</span>
|
|
744
|
+
|
|
745
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
746
|
+
<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>
|
|
747
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
748
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
749
|
+
<span class='rbrace'>}</span>
|
|
750
|
+
<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
751
|
<span class='kw'>end</span></pre>
|
|
708
752
|
</td>
|
|
709
753
|
</tr>
|
|
@@ -713,7 +757,7 @@
|
|
|
713
757
|
<div class="method_details ">
|
|
714
758
|
<h3 class="signature " id="delete!-instance_method">
|
|
715
759
|
|
|
716
|
-
#<strong>delete!</strong>(id:
|
|
760
|
+
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
717
761
|
|
|
718
762
|
|
|
719
763
|
|
|
@@ -722,7 +766,7 @@
|
|
|
722
766
|
</h3><div class="docstring">
|
|
723
767
|
<div class="discussion">
|
|
724
768
|
|
|
725
|
-
<p>Delete an API key by ID
|
|
769
|
+
<p>Delete an API key by ID Throws an exception if API error.</p>
|
|
726
770
|
|
|
727
771
|
<p><a href="https://ngrok.com/docs/api#api-api-keys-delete">ngrok.com/docs/api#api-api-keys-delete</a></p>
|
|
728
772
|
|
|
@@ -741,7 +785,7 @@
|
|
|
741
785
|
<span class='type'>(<tt>string</tt>)</span>
|
|
742
786
|
|
|
743
787
|
|
|
744
|
-
<em class="default">(defaults to: <tt
|
|
788
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
745
789
|
|
|
746
790
|
|
|
747
791
|
—
|
|
@@ -759,13 +803,13 @@
|
|
|
759
803
|
<li>
|
|
760
804
|
|
|
761
805
|
|
|
762
|
-
<span class='type'>(<tt>
|
|
806
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
763
807
|
|
|
764
808
|
|
|
765
809
|
|
|
766
810
|
—
|
|
767
811
|
<div class='inline'>
|
|
768
|
-
<p>result from
|
|
812
|
+
<p>result from the API request</p>
|
|
769
813
|
</div>
|
|
770
814
|
|
|
771
815
|
</li>
|
|
@@ -778,15 +822,23 @@
|
|
|
778
822
|
<pre class="lines">
|
|
779
823
|
|
|
780
824
|
|
|
781
|
-
|
|
782
|
-
|
|
783
|
-
|
|
825
|
+
68
|
|
826
|
+
69
|
|
827
|
+
70
|
|
828
|
+
71
|
|
829
|
+
72
|
|
830
|
+
73
|
|
831
|
+
74</pre>
|
|
784
832
|
</td>
|
|
785
833
|
<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><span class='label'>id:</span> <span class='
|
|
789
|
-
<span class='
|
|
834
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 68</span>
|
|
835
|
+
|
|
836
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
837
|
+
<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>
|
|
838
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
839
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
840
|
+
<span class='rbrace'>}</span>
|
|
841
|
+
<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
842
|
<span class='kw'>end</span></pre>
|
|
791
843
|
</td>
|
|
792
844
|
</tr>
|
|
@@ -796,7 +848,7 @@
|
|
|
796
848
|
<div class="method_details ">
|
|
797
849
|
<h3 class="signature " id="get-instance_method">
|
|
798
850
|
|
|
799
|
-
#<strong>get</strong>(id:
|
|
851
|
+
#<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
852
|
|
|
801
853
|
|
|
802
854
|
|
|
@@ -824,7 +876,7 @@
|
|
|
824
876
|
<span class='type'>(<tt>string</tt>)</span>
|
|
825
877
|
|
|
826
878
|
|
|
827
|
-
<em class="default">(defaults to: <tt
|
|
879
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
828
880
|
|
|
829
881
|
|
|
830
882
|
—
|
|
@@ -842,13 +894,13 @@
|
|
|
842
894
|
<li>
|
|
843
895
|
|
|
844
896
|
|
|
845
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
|
897
|
+
<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
898
|
|
|
847
899
|
|
|
848
900
|
|
|
849
901
|
—
|
|
850
902
|
<div class='inline'>
|
|
851
|
-
<p>result from
|
|
903
|
+
<p>result from the API request</p>
|
|
852
904
|
</div>
|
|
853
905
|
|
|
854
906
|
</li>
|
|
@@ -861,17 +913,27 @@
|
|
|
861
913
|
<pre class="lines">
|
|
862
914
|
|
|
863
915
|
|
|
864
|
-
|
|
865
|
-
|
|
866
|
-
|
|
867
|
-
|
|
916
|
+
83
|
|
917
|
+
84
|
|
918
|
+
85
|
|
919
|
+
86
|
|
920
|
+
87
|
|
921
|
+
88
|
|
922
|
+
89
|
|
923
|
+
90
|
|
924
|
+
91</pre>
|
|
868
925
|
</td>
|
|
869
926
|
<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><span class='label'>id:</span> <span class='
|
|
873
|
-
<span class='id identifier
|
|
874
|
-
<span class='
|
|
927
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 83</span>
|
|
928
|
+
|
|
929
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
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,27 @@
|
|
|
946
1008
|
<pre class="lines">
|
|
947
1009
|
|
|
948
1010
|
|
|
949
|
-
|
|
950
|
-
|
|
951
|
-
|
|
952
|
-
|
|
1011
|
+
101
|
|
1012
|
+
102
|
|
1013
|
+
103
|
|
1014
|
+
104
|
|
1015
|
+
105
|
|
1016
|
+
106
|
|
1017
|
+
107
|
|
1018
|
+
108
|
|
1019
|
+
109</pre>
|
|
953
1020
|
</td>
|
|
954
1021
|
<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><span class='label'>id:</span> <span class='
|
|
958
|
-
<span class='id identifier
|
|
959
|
-
<span class='
|
|
1022
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 101</span>
|
|
1023
|
+
|
|
1024
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1025
|
+
<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>
|
|
1026
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1027
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1028
|
+
<span class='rbrace'>}</span>
|
|
1029
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1030
|
+
<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>
|
|
1031
|
+
<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
1032
|
<span class='kw'>end</span></pre>
|
|
961
1033
|
</td>
|
|
962
1034
|
</tr>
|
|
@@ -975,7 +1047,142 @@
|
|
|
975
1047
|
</h3><div class="docstring">
|
|
976
1048
|
<div class="discussion">
|
|
977
1049
|
|
|
978
|
-
<p>List all API keys owned by this account
|
|
1050
|
+
<p>List all API keys owned by this account</p>
|
|
1051
|
+
|
|
1052
|
+
<p><a href="https://ngrok.com/docs/api#api-api-keys-list">ngrok.com/docs/api#api-api-keys-list</a></p>
|
|
1053
|
+
|
|
1054
|
+
|
|
1055
|
+
</div>
|
|
1056
|
+
</div>
|
|
1057
|
+
<div class="tags">
|
|
1058
|
+
<p class="tag_title">Parameters:</p>
|
|
1059
|
+
<ul class="param">
|
|
1060
|
+
|
|
1061
|
+
<li>
|
|
1062
|
+
|
|
1063
|
+
<span class='name'>before_id</span>
|
|
1064
|
+
|
|
1065
|
+
|
|
1066
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1067
|
+
|
|
1068
|
+
|
|
1069
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1070
|
+
|
|
1071
|
+
|
|
1072
|
+
</li>
|
|
1073
|
+
|
|
1074
|
+
<li>
|
|
1075
|
+
|
|
1076
|
+
<span class='name'>limit</span>
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1080
|
+
|
|
1081
|
+
|
|
1082
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1083
|
+
|
|
1084
|
+
|
|
1085
|
+
</li>
|
|
1086
|
+
|
|
1087
|
+
<li>
|
|
1088
|
+
|
|
1089
|
+
<span class='name'>url</span>
|
|
1090
|
+
|
|
1091
|
+
|
|
1092
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1093
|
+
|
|
1094
|
+
|
|
1095
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
—
|
|
1099
|
+
<div class='inline'>
|
|
1100
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
1101
|
+
</div>
|
|
1102
|
+
|
|
1103
|
+
</li>
|
|
1104
|
+
|
|
1105
|
+
</ul>
|
|
1106
|
+
|
|
1107
|
+
<p class="tag_title">Returns:</p>
|
|
1108
|
+
<ul class="return">
|
|
1109
|
+
|
|
1110
|
+
<li>
|
|
1111
|
+
|
|
1112
|
+
|
|
1113
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
|
|
1114
|
+
|
|
1115
|
+
|
|
1116
|
+
|
|
1117
|
+
—
|
|
1118
|
+
<div class='inline'>
|
|
1119
|
+
<p>result from the API request</p>
|
|
1120
|
+
</div>
|
|
1121
|
+
|
|
1122
|
+
</li>
|
|
1123
|
+
|
|
1124
|
+
</ul>
|
|
1125
|
+
|
|
1126
|
+
</div><table class="source_code">
|
|
1127
|
+
<tr>
|
|
1128
|
+
<td>
|
|
1129
|
+
<pre class="lines">
|
|
1130
|
+
|
|
1131
|
+
|
|
1132
|
+
120
|
|
1133
|
+
121
|
|
1134
|
+
122
|
|
1135
|
+
123
|
|
1136
|
+
124
|
|
1137
|
+
125
|
|
1138
|
+
126
|
|
1139
|
+
127
|
|
1140
|
+
128
|
|
1141
|
+
129
|
|
1142
|
+
130
|
|
1143
|
+
131
|
|
1144
|
+
132
|
|
1145
|
+
133
|
|
1146
|
+
134
|
|
1147
|
+
135</pre>
|
|
1148
|
+
</td>
|
|
1149
|
+
<td>
|
|
1150
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 120</span>
|
|
1151
|
+
|
|
1152
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1153
|
+
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1154
|
+
<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>
|
|
1155
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1156
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1157
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1158
|
+
<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>
|
|
1159
|
+
<span class='rparen'>)</span>
|
|
1160
|
+
|
|
1161
|
+
<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>
|
|
1162
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1163
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1164
|
+
<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>
|
|
1165
|
+
<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>
|
|
1166
|
+
<span class='rparen'>)</span>
|
|
1167
|
+
<span class='kw'>end</span></pre>
|
|
1168
|
+
</td>
|
|
1169
|
+
</tr>
|
|
1170
|
+
</table>
|
|
1171
|
+
</div>
|
|
1172
|
+
|
|
1173
|
+
<div class="method_details ">
|
|
1174
|
+
<h3 class="signature " id="list!-instance_method">
|
|
1175
|
+
|
|
1176
|
+
#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
|
|
1177
|
+
|
|
1178
|
+
|
|
1179
|
+
|
|
1180
|
+
|
|
1181
|
+
|
|
1182
|
+
</h3><div class="docstring">
|
|
1183
|
+
<div class="discussion">
|
|
1184
|
+
|
|
1185
|
+
<p>List all API keys owned by this account Throws an exception if API error.</p>
|
|
979
1186
|
|
|
980
1187
|
<p><a href="https://ngrok.com/docs/api#api-api-keys-list">ngrok.com/docs/api#api-api-keys-list</a></p>
|
|
981
1188
|
|
|
@@ -1004,7 +1211,7 @@
|
|
|
1004
1211
|
<span class='name'>limit</span>
|
|
1005
1212
|
|
|
1006
1213
|
|
|
1007
|
-
<span class='type'>(<tt>
|
|
1214
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1008
1215
|
|
|
1009
1216
|
|
|
1010
1217
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
@@ -1044,7 +1251,7 @@
|
|
|
1044
1251
|
|
|
1045
1252
|
—
|
|
1046
1253
|
<div class='inline'>
|
|
1047
|
-
<p>the
|
|
1254
|
+
<p>result from the API request</p>
|
|
1048
1255
|
</div>
|
|
1049
1256
|
|
|
1050
1257
|
</li>
|
|
@@ -1057,27 +1264,45 @@
|
|
|
1057
1264
|
<pre class="lines">
|
|
1058
1265
|
|
|
1059
1266
|
|
|
1060
|
-
|
|
1061
|
-
|
|
1062
|
-
|
|
1063
|
-
|
|
1064
|
-
|
|
1065
|
-
|
|
1066
|
-
|
|
1067
|
-
|
|
1068
|
-
|
|
1267
|
+
147
|
|
1268
|
+
148
|
|
1269
|
+
149
|
|
1270
|
+
150
|
|
1271
|
+
151
|
|
1272
|
+
152
|
|
1273
|
+
153
|
|
1274
|
+
154
|
|
1275
|
+
155
|
|
1276
|
+
156
|
|
1277
|
+
157
|
|
1278
|
+
158
|
|
1279
|
+
159
|
|
1280
|
+
160
|
|
1281
|
+
161
|
|
1282
|
+
162
|
|
1283
|
+
163
|
|
1284
|
+
164</pre>
|
|
1069
1285
|
</td>
|
|
1070
1286
|
<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
|
|
1074
|
-
|
|
1075
|
-
<span class='
|
|
1076
|
-
<span class='label'>
|
|
1077
|
-
<span class='label'>
|
|
1078
|
-
<span class='label'>
|
|
1079
|
-
<span class='label'>
|
|
1080
|
-
|
|
1287
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 147</span>
|
|
1288
|
+
|
|
1289
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1290
|
+
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1291
|
+
<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>
|
|
1292
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1293
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1294
|
+
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
|
1295
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1296
|
+
<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>
|
|
1297
|
+
<span class='rparen'>)</span>
|
|
1298
|
+
|
|
1299
|
+
<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>
|
|
1300
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1301
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1302
|
+
<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>
|
|
1303
|
+
<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><span class='comma'>,</span>
|
|
1304
|
+
<span class='label'>danger:</span> <span class='kw'>true</span>
|
|
1305
|
+
<span class='rparen'>)</span>
|
|
1081
1306
|
<span class='kw'>end</span></pre>
|
|
1082
1307
|
</td>
|
|
1083
1308
|
</tr>
|
|
@@ -1087,7 +1312,7 @@
|
|
|
1087
1312
|
<div class="method_details ">
|
|
1088
1313
|
<h3 class="signature " id="update-instance_method">
|
|
1089
1314
|
|
|
1090
|
-
#<strong>update</strong>(id:
|
|
1315
|
+
#<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
1316
|
|
|
1092
1317
|
|
|
1093
1318
|
|
|
@@ -1115,7 +1340,7 @@
|
|
|
1115
1340
|
<span class='type'>(<tt>string</tt>)</span>
|
|
1116
1341
|
|
|
1117
1342
|
|
|
1118
|
-
<em class="default">(defaults to: <tt
|
|
1343
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1119
1344
|
|
|
1120
1345
|
|
|
1121
1346
|
</li>
|
|
@@ -1164,13 +1389,13 @@
|
|
|
1164
1389
|
<li>
|
|
1165
1390
|
|
|
1166
1391
|
|
|
1167
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
|
1392
|
+
<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
1393
|
|
|
1169
1394
|
|
|
1170
1395
|
|
|
1171
1396
|
—
|
|
1172
1397
|
<div class='inline'>
|
|
1173
|
-
<p>result from
|
|
1398
|
+
<p>result from the API request</p>
|
|
1174
1399
|
</div>
|
|
1175
1400
|
|
|
1176
1401
|
</li>
|
|
@@ -1183,17 +1408,31 @@
|
|
|
1183
1408
|
<pre class="lines">
|
|
1184
1409
|
|
|
1185
1410
|
|
|
1186
|
-
|
|
1187
|
-
|
|
1188
|
-
|
|
1189
|
-
|
|
1411
|
+
175
|
|
1412
|
+
176
|
|
1413
|
+
177
|
|
1414
|
+
178
|
|
1415
|
+
179
|
|
1416
|
+
180
|
|
1417
|
+
181
|
|
1418
|
+
182
|
|
1419
|
+
183
|
|
1420
|
+
184
|
|
1421
|
+
185</pre>
|
|
1190
1422
|
</td>
|
|
1191
1423
|
<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><span class='label'>id:</span> <span class='
|
|
1195
|
-
<span class='id identifier
|
|
1196
|
-
<span class='
|
|
1424
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 175</span>
|
|
1425
|
+
|
|
1426
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1427
|
+
<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>
|
|
1428
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1429
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1430
|
+
<span class='rbrace'>}</span>
|
|
1431
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1432
|
+
<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>
|
|
1433
|
+
<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>
|
|
1434
|
+
<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>
|
|
1435
|
+
<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
1436
|
<span class='kw'>end</span></pre>
|
|
1198
1437
|
</td>
|
|
1199
1438
|
</tr>
|
|
@@ -1203,7 +1442,7 @@
|
|
|
1203
1442
|
<div class="method_details ">
|
|
1204
1443
|
<h3 class="signature " id="update!-instance_method">
|
|
1205
1444
|
|
|
1206
|
-
#<strong>update!</strong>(id:
|
|
1445
|
+
#<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
1446
|
|
|
1208
1447
|
|
|
1209
1448
|
|
|
@@ -1212,7 +1451,7 @@
|
|
|
1212
1451
|
</h3><div class="docstring">
|
|
1213
1452
|
<div class="discussion">
|
|
1214
1453
|
|
|
1215
|
-
<p>Update attributes of an API key by ID.</p>
|
|
1454
|
+
<p>Update attributes of an API key by ID. Throws an exception if API error.</p>
|
|
1216
1455
|
|
|
1217
1456
|
<p><a href="https://ngrok.com/docs/api#api-api-keys-update">ngrok.com/docs/api#api-api-keys-update</a></p>
|
|
1218
1457
|
|
|
@@ -1231,7 +1470,7 @@
|
|
|
1231
1470
|
<span class='type'>(<tt>string</tt>)</span>
|
|
1232
1471
|
|
|
1233
1472
|
|
|
1234
|
-
<em class="default">(defaults to: <tt
|
|
1473
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1235
1474
|
|
|
1236
1475
|
|
|
1237
1476
|
</li>
|
|
@@ -1280,13 +1519,13 @@
|
|
|
1280
1519
|
<li>
|
|
1281
1520
|
|
|
1282
1521
|
|
|
1283
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
|
1522
|
+
<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
1523
|
|
|
1285
1524
|
|
|
1286
1525
|
|
|
1287
1526
|
—
|
|
1288
1527
|
<div class='inline'>
|
|
1289
|
-
<p>result from
|
|
1528
|
+
<p>result from the API request</p>
|
|
1290
1529
|
</div>
|
|
1291
1530
|
|
|
1292
1531
|
</li>
|
|
@@ -1299,19 +1538,31 @@
|
|
|
1299
1538
|
<pre class="lines">
|
|
1300
1539
|
|
|
1301
1540
|
|
|
1302
|
-
|
|
1303
|
-
|
|
1304
|
-
|
|
1305
|
-
|
|
1306
|
-
|
|
1541
|
+
197
|
|
1542
|
+
198
|
|
1543
|
+
199
|
|
1544
|
+
200
|
|
1545
|
+
201
|
|
1546
|
+
202
|
|
1547
|
+
203
|
|
1548
|
+
204
|
|
1549
|
+
205
|
|
1550
|
+
206
|
|
1551
|
+
207</pre>
|
|
1307
1552
|
</td>
|
|
1308
1553
|
<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><span class='label'>id:</span> <span class='
|
|
1312
|
-
<span class='id identifier
|
|
1313
|
-
<span class='id identifier
|
|
1314
|
-
|
|
1554
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/api_keys_client.rb', line 197</span>
|
|
1555
|
+
|
|
1556
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1557
|
+
<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>
|
|
1558
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1559
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1560
|
+
<span class='rbrace'>}</span>
|
|
1561
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1562
|
+
<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>
|
|
1563
|
+
<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>
|
|
1564
|
+
<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>
|
|
1565
|
+
<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
1566
|
<span class='kw'>end</span></pre>
|
|
1316
1567
|
</td>
|
|
1317
1568
|
</tr>
|
|
@@ -1323,9 +1574,9 @@
|
|
|
1323
1574
|
</div>
|
|
1324
1575
|
|
|
1325
1576
|
<div id="footer">
|
|
1326
|
-
Generated on
|
|
1577
|
+
Generated on Thu Dec 2 18:48:51 2021 by
|
|
1327
1578
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1328
|
-
0.9.
|
|
1579
|
+
0.9.27 (ruby-3.0.1).
|
|
1329
1580
|
</div>
|
|
1330
1581
|
|
|
1331
1582
|
</div>
|