ngrok-api 0.9.0 → 0.12.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rubocop.yml +1 -1
- data/doc/.gitkeep +0 -0
- data/doc/NgrokAPI/Client.html +1499 -125
- data/doc/NgrokAPI/Error.html +1 -1
- data/doc/NgrokAPI/Errors/NotFoundError.html +1 -1
- data/doc/NgrokAPI/Errors.html +1 -1
- data/doc/NgrokAPI/HttpClient.html +1 -1
- data/doc/NgrokAPI/Models/{ApiKey.html → APIKey.html} +108 -177
- data/doc/NgrokAPI/Models/AWSAuth.html +617 -0
- data/doc/NgrokAPI/Models/AWSCredentials.html +617 -0
- data/doc/NgrokAPI/Models/AWSRole.html +543 -0
- data/doc/NgrokAPI/Models/AbuseReport.html +987 -0
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +617 -0
- data/doc/NgrokAPI/Models/CertificateAuthority.html +1439 -0
- data/doc/NgrokAPI/Models/Credential.html +1149 -0
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +913 -0
- data/doc/NgrokAPI/Models/EndpointCompression.html +543 -0
- data/doc/NgrokAPI/Models/EndpointConfiguration.html +1321 -510
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +617 -0
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointLogging.html +617 -0
- data/doc/NgrokAPI/Models/EndpointLoggingMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +617 -0
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointOAuth.html +987 -0
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +987 -0
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +765 -0
- data/doc/NgrokAPI/Models/EndpointOIDC.html +1135 -0
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +691 -0
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +691 -0
- data/doc/NgrokAPI/Models/EndpointSAML.html +1653 -0
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +1283 -0
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +691 -0
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +691 -0
- data/doc/NgrokAPI/Models/EventDestination.html +1058 -0
- data/doc/NgrokAPI/Models/EventSource.html +765 -0
- data/doc/NgrokAPI/Models/EventSourceReplace.html +691 -0
- data/doc/NgrokAPI/Models/EventStream.html +1309 -0
- data/doc/NgrokAPI/Models/EventSubscription.html +1058 -0
- data/doc/NgrokAPI/Models/EventTarget.html +765 -0
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +617 -0
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +617 -0
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +617 -0
- data/doc/NgrokAPI/Models/IPPolicy.html +1069 -0
- data/doc/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/doc/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/doc/NgrokAPI/Models/{TlsCertificate.html → IPWhitelistEntry.html} +168 -163
- data/doc/NgrokAPI/Models/Listable.html +1 -1
- data/doc/NgrokAPI/Models/Ref.html +617 -0
- data/doc/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/doc/NgrokAPI/Models/ReservedDomain.html +111 -1107
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +839 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertNSTarget.html +617 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +617 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +617 -0
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +1143 -0
- data/doc/NgrokAPI/Models/SSHCredential.html +1149 -0
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +1513 -0
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +1661 -0
- data/doc/NgrokAPI/Models/TLSCertificate.html +2179 -0
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +617 -0
- data/doc/NgrokAPI/Models/Tunnel.html +987 -0
- data/doc/NgrokAPI/Models/TunnelSession.html +1209 -0
- data/doc/NgrokAPI/Models.html +4 -4
- data/doc/NgrokAPI/PagedIterator.html +1 -1
- data/{docs/NgrokAPI/Services/ApiKeysClient.html → doc/NgrokAPI/Services/APIKeysClient.html} +287 -151
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +723 -0
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +1489 -0
- data/doc/NgrokAPI/Services/CredentialsClient.html +1534 -0
- data/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +473 -371
- data/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1071 -0
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +1609 -0
- data/doc/NgrokAPI/Services/EventSourcesClient.html +1348 -0
- data/doc/NgrokAPI/Services/EventStreamsClient.html +1691 -0
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +1603 -0
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +1488 -0
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +1550 -0
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +1620 -0
- data/doc/NgrokAPI/Services/IPWhitelistClient.html +1488 -0
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +1793 -0
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +518 -333
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1532 -0
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +1552 -0
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +1573 -0
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +1617 -0
- data/{docs/NgrokAPI/Services/TlsCertificatesClient.html → doc/NgrokAPI/Services/TLSCertificatesClient.html} +290 -198
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +1468 -0
- data/doc/NgrokAPI/Services/TunnelsClient.html +513 -0
- data/doc/NgrokAPI/Services.html +4 -4
- data/doc/NgrokAPI.html +3 -3
- data/doc/_index.html +624 -28
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +1 -1
- data/doc/index.html +1 -1
- data/doc/method_list.html +7318 -286
- data/doc/top-level-namespace.html +1 -1
- data/docs/.gitkeep +0 -0
- data/docs/NgrokAPI/Client.html +1499 -125
- data/docs/NgrokAPI/Error.html +1 -1
- data/docs/NgrokAPI/Errors/NotFoundError.html +1 -1
- data/docs/NgrokAPI/Errors.html +1 -1
- data/docs/NgrokAPI/HttpClient.html +1 -1
- data/docs/NgrokAPI/Models/{ApiKey.html → APIKey.html} +108 -177
- data/docs/NgrokAPI/Models/AWSAuth.html +617 -0
- data/docs/NgrokAPI/Models/AWSCredentials.html +617 -0
- data/docs/NgrokAPI/Models/AWSRole.html +543 -0
- data/docs/NgrokAPI/Models/AbuseReport.html +987 -0
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +617 -0
- data/docs/NgrokAPI/Models/CertificateAuthority.html +1439 -0
- data/docs/NgrokAPI/Models/Credential.html +1149 -0
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +913 -0
- data/docs/NgrokAPI/Models/EndpointCompression.html +543 -0
- data/docs/NgrokAPI/Models/EndpointConfiguration.html +1321 -510
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +617 -0
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointLogging.html +617 -0
- data/docs/NgrokAPI/Models/EndpointLoggingMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +617 -0
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointOAuth.html +987 -0
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +987 -0
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +765 -0
- data/docs/NgrokAPI/Models/EndpointOIDC.html +1135 -0
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +691 -0
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +691 -0
- data/docs/NgrokAPI/Models/EndpointSAML.html +1653 -0
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +1283 -0
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +691 -0
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +691 -0
- data/docs/NgrokAPI/Models/EventDestination.html +1058 -0
- data/docs/NgrokAPI/Models/EventSource.html +765 -0
- data/docs/NgrokAPI/Models/EventSourceReplace.html +691 -0
- data/docs/NgrokAPI/Models/EventStream.html +1309 -0
- data/docs/NgrokAPI/Models/EventSubscription.html +1058 -0
- data/docs/NgrokAPI/Models/EventTarget.html +765 -0
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +617 -0
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +617 -0
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +617 -0
- data/docs/NgrokAPI/Models/IPPolicy.html +1069 -0
- data/docs/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/docs/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/docs/NgrokAPI/Models/{TlsCertificate.html → IPWhitelistEntry.html} +168 -163
- data/docs/NgrokAPI/Models/Listable.html +1 -1
- data/docs/NgrokAPI/Models/Ref.html +617 -0
- data/docs/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/docs/NgrokAPI/Models/ReservedDomain.html +111 -1107
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +839 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertNSTarget.html +617 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +617 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +617 -0
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +1143 -0
- data/docs/NgrokAPI/Models/SSHCredential.html +1149 -0
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +1513 -0
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +1661 -0
- data/docs/NgrokAPI/Models/TLSCertificate.html +2179 -0
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +617 -0
- data/docs/NgrokAPI/Models/Tunnel.html +987 -0
- data/docs/NgrokAPI/Models/TunnelSession.html +1209 -0
- data/docs/NgrokAPI/Models.html +4 -4
- data/docs/NgrokAPI/PagedIterator.html +1 -1
- data/{doc/NgrokAPI/Services/ApiKeysClient.html → docs/NgrokAPI/Services/APIKeysClient.html} +287 -151
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +723 -0
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +1489 -0
- data/docs/NgrokAPI/Services/CredentialsClient.html +1534 -0
- data/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +473 -371
- data/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1071 -0
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +1609 -0
- data/docs/NgrokAPI/Services/EventSourcesClient.html +1348 -0
- data/docs/NgrokAPI/Services/EventStreamsClient.html +1691 -0
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +1603 -0
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +1488 -0
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +1550 -0
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +1620 -0
- data/docs/NgrokAPI/Services/IPWhitelistClient.html +1488 -0
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +1793 -0
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +518 -333
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1532 -0
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +1552 -0
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +1573 -0
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +1617 -0
- data/{doc/NgrokAPI/Services/TlsCertificatesClient.html → docs/NgrokAPI/Services/TLSCertificatesClient.html} +290 -198
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +1468 -0
- data/docs/NgrokAPI/Services/TunnelsClient.html +513 -0
- data/docs/NgrokAPI/Services.html +4 -4
- data/docs/NgrokAPI.html +3 -3
- data/docs/_index.html +624 -28
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +1 -1
- data/docs/index.html +1 -1
- data/docs/method_list.html +7318 -286
- data/docs/top-level-namespace.html +1 -1
- data/lib/ngrokapi/client.rb +218 -49
- data/lib/ngrokapi/models/abuse_report.rb +37 -0
- data/lib/ngrokapi/models/abuse_report_hostname.rb +27 -0
- data/lib/ngrokapi/models/api_key.rb +62 -64
- data/lib/ngrokapi/models/aws_auth.rb +27 -0
- data/lib/ngrokapi/models/aws_credentials.rb +27 -0
- data/lib/ngrokapi/models/aws_role.rb +25 -0
- data/lib/ngrokapi/models/certificate_authority.rb +72 -0
- data/lib/ngrokapi/models/credential.rb +67 -0
- data/lib/ngrokapi/models/endpoint_circuit_breaker.rb +35 -0
- data/lib/ngrokapi/models/endpoint_compression.rb +25 -0
- data/lib/ngrokapi/models/endpoint_configuration.rb +130 -119
- data/lib/ngrokapi/models/endpoint_ip_policy.rb +27 -0
- data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_logging.rb +27 -0
- data/lib/ngrokapi/models/endpoint_logging_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_mutual_tls.rb +27 -0
- data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_o_auth.rb +37 -0
- data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb +37 -0
- data/lib/ngrokapi/models/endpoint_o_auth_google.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_microsoft.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_provider.rb +31 -0
- data/lib/ngrokapi/models/endpoint_oidc.rb +41 -0
- data/lib/ngrokapi/models/endpoint_request_headers.rb +29 -0
- data/lib/ngrokapi/models/endpoint_response_headers.rb +29 -0
- data/lib/ngrokapi/models/endpoint_saml.rb +55 -0
- data/lib/ngrokapi/models/endpoint_saml_mutate.rb +45 -0
- data/lib/ngrokapi/models/endpoint_tls_termination.rb +29 -0
- data/lib/ngrokapi/models/endpoint_webhook_validation.rb +29 -0
- data/lib/ngrokapi/models/event_destination.rb +49 -0
- data/lib/ngrokapi/models/event_source.rb +31 -0
- data/lib/ngrokapi/models/event_source_replace.rb +29 -0
- data/lib/ngrokapi/models/event_stream.rb +77 -0
- data/lib/ngrokapi/models/event_subscription.rb +47 -0
- data/lib/ngrokapi/models/event_target.rb +31 -0
- data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb +27 -0
- data/lib/ngrokapi/models/event_target_firehose.rb +27 -0
- data/lib/ngrokapi/models/event_target_kinesis.rb +27 -0
- data/lib/ngrokapi/models/ip_policy.rb +64 -0
- data/lib/ngrokapi/models/ip_policy_rule.rb +67 -0
- data/lib/ngrokapi/models/ip_restriction.rb +49 -0
- data/lib/ngrokapi/models/ip_whitelist_entry.rb +62 -0
- data/lib/ngrokapi/models/ref.rb +27 -0
- data/lib/ngrokapi/models/reserved_addr.rb +49 -0
- data/lib/ngrokapi/models/reserved_domain.rb +59 -211
- data/lib/ngrokapi/models/reserved_domain_cert_job.rb +33 -0
- data/lib/ngrokapi/models/reserved_domain_cert_ns_target.rb +27 -0
- data/lib/ngrokapi/models/reserved_domain_cert_policy.rb +27 -0
- data/lib/ngrokapi/models/reserved_domain_cert_status.rb +27 -0
- data/lib/ngrokapi/models/ssh_certificate_authority.rb +64 -0
- data/lib/ngrokapi/models/ssh_credential.rb +67 -0
- data/lib/ngrokapi/models/ssh_host_certificate.rb +74 -0
- data/lib/ngrokapi/models/ssh_user_certificate.rb +78 -0
- data/lib/ngrokapi/models/tls_certificate.rb +92 -62
- data/lib/ngrokapi/models/tls_certificate_sa_ns.rb +27 -0
- data/lib/ngrokapi/models/tunnel.rb +37 -0
- data/lib/ngrokapi/models/tunnel_session.rb +43 -0
- data/lib/ngrokapi/services/.gitkeep +0 -0
- data/lib/ngrokapi/services/abuse_reports_client.rb +84 -0
- data/lib/ngrokapi/services/api_keys_client.rb +203 -144
- data/lib/ngrokapi/services/certificate_authorities_client.rb +204 -0
- data/lib/ngrokapi/services/credentials_client.rb +212 -0
- data/lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_compression_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +324 -313
- data/lib/ngrokapi/services/endpoint_ip_policy_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_logging_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_o_auth_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_oidc_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_request_headers_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_response_headers_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_saml_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_tls_termination_module_client.rb +122 -0
- data/lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb +122 -0
- data/lib/ngrokapi/services/event_destinations_client.rb +222 -0
- data/lib/ngrokapi/services/event_sources_client.rb +177 -0
- data/lib/ngrokapi/services/event_streams_client.rb +226 -0
- data/lib/ngrokapi/services/event_subscriptions_client.rb +213 -0
- data/lib/ngrokapi/services/ip_policies_client.rb +208 -0
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +210 -0
- data/lib/ngrokapi/services/ip_restrictions_client.rb +223 -0
- data/lib/ngrokapi/services/ip_whitelist_client.rb +202 -0
- data/lib/ngrokapi/services/reserved_addrs_client.rb +246 -0
- data/lib/ngrokapi/services/reserved_domains_client.rb +382 -313
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +207 -0
- data/lib/ngrokapi/services/ssh_credentials_client.rb +211 -0
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +214 -0
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +220 -0
- data/lib/ngrokapi/services/tls_certificates_client.rb +207 -161
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +228 -0
- data/lib/ngrokapi/services/tunnels_client.rb +51 -0
- data/lib/ngrokapi/version.rb +1 -1
- data/spec/ngrokapi/client_spec.rb +139 -33
- data/spec/ngrokapi/models/abuse_report_hostname_spec.rb +21 -0
- data/spec/ngrokapi/models/abuse_report_spec.rb +21 -0
- data/spec/ngrokapi/models/api_key_spec.rb +42 -43
- data/spec/ngrokapi/models/aws_auth_spec.rb +21 -0
- data/spec/ngrokapi/models/aws_credentials_spec.rb +21 -0
- data/spec/ngrokapi/models/aws_role_spec.rb +21 -0
- data/spec/ngrokapi/models/certificate_authority_spec.rb +42 -0
- data/spec/ngrokapi/models/credential_spec.rb +45 -0
- data/spec/ngrokapi/models/endpoint_circuit_breaker_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_compression_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_configuration_spec.rb +78 -0
- data/spec/ngrokapi/models/endpoint_ip_policy_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_ip_policy_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_logging_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_logging_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_mutual_tls_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_mutual_tls_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_facebook_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_git_hub_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_google_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_microsoft_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_provider_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_oidc_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_request_headers_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_response_headers_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_saml_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_saml_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_tls_termination_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_webhook_validation_spec.rb +21 -0
- data/spec/ngrokapi/models/event_destination_spec.rb +28 -0
- data/spec/ngrokapi/models/event_source_replace_spec.rb +21 -0
- data/spec/ngrokapi/models/event_source_spec.rb +21 -0
- data/spec/ngrokapi/models/event_stream_spec.rb +51 -0
- data/spec/ngrokapi/models/event_subscription_spec.rb +28 -0
- data/spec/ngrokapi/models/event_target_cloudwatch_logs_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_firehose_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_kinesis_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_spec.rb +21 -0
- data/spec/ngrokapi/models/ip_policy_rule_spec.rb +45 -0
- data/spec/ngrokapi/models/ip_policy_spec.rb +42 -0
- data/spec/ngrokapi/models/ip_restriction_spec.rb +28 -0
- data/spec/ngrokapi/models/ip_whitelist_entry_spec.rb +42 -0
- data/spec/ngrokapi/models/listable_spec.rb +4 -4
- data/spec/ngrokapi/models/ref_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_addr_spec.rb +28 -0
- data/spec/ngrokapi/models/reserved_domain_cert_job_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_cert_ns_target_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_cert_status_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_spec.rb +28 -100
- data/spec/ngrokapi/models/ssh_certificate_authority_spec.rb +42 -0
- data/spec/ngrokapi/models/ssh_credential_spec.rb +45 -0
- data/spec/ngrokapi/models/ssh_host_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/ssh_user_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/tls_certificate_sa_ns_spec.rb +21 -0
- data/spec/ngrokapi/models/tls_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/tunnel_session_spec.rb +21 -0
- data/spec/ngrokapi/models/tunnel_spec.rb +21 -0
- data/spec/ngrokapi/paged_iterator_spec.rb +5 -5
- data/spec/ngrokapi/services/.gitkeep +0 -0
- data/spec/ngrokapi/services/abuse_reports_client_spec.rb +67 -0
- data/spec/ngrokapi/services/api_keys_client_spec.rb +160 -127
- data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +162 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +166 -0
- data/spec/ngrokapi/services/endpoint_circuit_breaker_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_compression_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +240 -0
- data/spec/ngrokapi/services/endpoint_ip_policy_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_mutual_tls_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_o_auth_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_oidc_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_request_headers_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_response_headers_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_saml_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_tls_termination_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/endpoint_webhook_validation_module_client_spec.rb +127 -0
- data/spec/ngrokapi/services/event_destinations_client_spec.rb +175 -0
- data/spec/ngrokapi/services/event_sources_client_spec.rb +162 -0
- data/spec/ngrokapi/services/event_streams_client_spec.rb +180 -0
- data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +172 -0
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +162 -0
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +168 -0
- data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +174 -0
- data/spec/ngrokapi/services/ip_whitelist_client_spec.rb +162 -0
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +209 -0
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +352 -0
- data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +166 -0
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +168 -0
- data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +170 -0
- data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +174 -0
- data/spec/ngrokapi/services/tls_certificates_client_spec.rb +164 -0
- data/spec/ngrokapi/services/tunnel_sessions_client_spec.rb +184 -0
- data/spec/ngrokapi/services/tunnels_client_spec.rb +21 -0
- data/spec/spec_helper.rb +958 -0
- metadata +355 -10
|
@@ -0,0 +1,1488 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: NgrokAPI::Services::IPPoliciesClient
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.26
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "NgrokAPI::Services::IPPoliciesClient";
|
|
19
|
+
relpath = '../../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../../_index.html">Index (I)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> » <span class='title'><span class='object_link'><a href="../Services.html" title="NgrokAPI::Services (module)">Services</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">IPPoliciesClient</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: NgrokAPI::Services::IPPoliciesClient
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">NgrokAPI::Services::IPPoliciesClient</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/ngrokapi/services/ip_policies_client.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>IP Policies are reusable groups of CIDR ranges with an allow or deny</p>
|
|
106
|
+
|
|
107
|
+
<pre class="code ruby"><code class="ruby">action. They can be attached to endpoints via the Endpoint Configuration IP
|
|
108
|
+
Policy module. They can also be used with IP Restrictions to control source
|
|
109
|
+
IP ranges that can start tunnel sessions and connect to the API and dashboard.
|
|
110
|
+
</code></pre>
|
|
111
|
+
|
|
112
|
+
<p><a href="https://ngrok.com/docs/api#api-ip-policies">ngrok.com/docs/api#api-ip-policies</a></p>
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
</div>
|
|
116
|
+
</div>
|
|
117
|
+
<div class="tags">
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
</div>
|
|
121
|
+
|
|
122
|
+
<h2>
|
|
123
|
+
Constant Summary
|
|
124
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
125
|
+
</h2>
|
|
126
|
+
|
|
127
|
+
<dl class="constants">
|
|
128
|
+
|
|
129
|
+
<dt id="PATH-constant" class="">PATH =
|
|
130
|
+
<div class="docstring">
|
|
131
|
+
<div class="discussion">
|
|
132
|
+
|
|
133
|
+
<p>The API path for the requests</p>
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
</div>
|
|
137
|
+
</div>
|
|
138
|
+
<div class="tags">
|
|
139
|
+
|
|
140
|
+
|
|
141
|
+
</div>
|
|
142
|
+
</dt>
|
|
143
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/ip_policies</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
144
|
+
|
|
145
|
+
<dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
|
|
146
|
+
<div class="docstring">
|
|
147
|
+
<div class="discussion">
|
|
148
|
+
|
|
149
|
+
<p>The List Property from the resulting API for list calls</p>
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
</div>
|
|
153
|
+
</div>
|
|
154
|
+
<div class="tags">
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
</div>
|
|
158
|
+
</dt>
|
|
159
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ip_policies</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
160
|
+
|
|
161
|
+
</dl>
|
|
162
|
+
|
|
163
|
+
|
|
164
|
+
|
|
165
|
+
|
|
166
|
+
|
|
167
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
168
|
+
<ul class="summary">
|
|
169
|
+
|
|
170
|
+
<li class="public ">
|
|
171
|
+
<span class="summary_signature">
|
|
172
|
+
|
|
173
|
+
<a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> ⇒ Object </a>
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
</span>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
<span class="note title readonly">readonly</span>
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
|
|
189
|
+
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
<span class="summary_desc"><div class='inline'>
|
|
193
|
+
<p>Returns the value of attribute client.</p>
|
|
194
|
+
</div></span>
|
|
195
|
+
|
|
196
|
+
</li>
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
</ul>
|
|
200
|
+
|
|
201
|
+
|
|
202
|
+
|
|
203
|
+
|
|
204
|
+
|
|
205
|
+
<h2>
|
|
206
|
+
Instance Method Summary
|
|
207
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
208
|
+
</h2>
|
|
209
|
+
|
|
210
|
+
<ul class="summary">
|
|
211
|
+
|
|
212
|
+
<li class="public ">
|
|
213
|
+
<span class="summary_signature">
|
|
214
|
+
|
|
215
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: "", metadata: "", action:) ⇒ NgrokAPI::Models::IPPolicy </a>
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
</span>
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
|
|
225
|
+
|
|
226
|
+
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
<span class="summary_desc"><div class='inline'>
|
|
230
|
+
<p>Create a new IP policy.</p>
|
|
231
|
+
</div></span>
|
|
232
|
+
|
|
233
|
+
</li>
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
<li class="public ">
|
|
237
|
+
<span class="summary_signature">
|
|
238
|
+
|
|
239
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
</span>
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
|
|
249
|
+
|
|
250
|
+
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
<span class="summary_desc"><div class='inline'>
|
|
254
|
+
<p>Delete an IP policy.</p>
|
|
255
|
+
</div></span>
|
|
256
|
+
|
|
257
|
+
</li>
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
<li class="public ">
|
|
261
|
+
<span class="summary_signature">
|
|
262
|
+
|
|
263
|
+
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
</span>
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
|
|
273
|
+
|
|
274
|
+
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
<span class="summary_desc"><div class='inline'>
|
|
278
|
+
<p>Delete an IP policy.</p>
|
|
279
|
+
</div></span>
|
|
280
|
+
|
|
281
|
+
</li>
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
<li class="public ">
|
|
285
|
+
<span class="summary_signature">
|
|
286
|
+
|
|
287
|
+
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: "") ⇒ NgrokAPI::Models::IPPolicy </a>
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
</span>
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
|
|
298
|
+
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
<span class="summary_desc"><div class='inline'>
|
|
302
|
+
<p>Get detailed information about an IP policy by ID.</p>
|
|
303
|
+
</div></span>
|
|
304
|
+
|
|
305
|
+
</li>
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
<li class="public ">
|
|
309
|
+
<span class="summary_signature">
|
|
310
|
+
|
|
311
|
+
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: "") ⇒ NgrokAPI::Models::IPPolicy </a>
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
</span>
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
|
|
321
|
+
|
|
322
|
+
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
<span class="summary_desc"><div class='inline'>
|
|
326
|
+
<p>Get detailed information about an IP policy by ID.</p>
|
|
327
|
+
</div></span>
|
|
328
|
+
|
|
329
|
+
</li>
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
<li class="public ">
|
|
333
|
+
<span class="summary_signature">
|
|
334
|
+
|
|
335
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒ IPPoliciesClient </a>
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
</span>
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
<span class="note title constructor">constructor</span>
|
|
343
|
+
|
|
344
|
+
|
|
345
|
+
|
|
346
|
+
|
|
347
|
+
|
|
348
|
+
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
<span class="summary_desc"><div class='inline'>
|
|
352
|
+
<p>A new instance of IPPoliciesClient.</p>
|
|
353
|
+
</div></span>
|
|
354
|
+
|
|
355
|
+
</li>
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
<li class="public ">
|
|
359
|
+
<span class="summary_signature">
|
|
360
|
+
|
|
361
|
+
<a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
</span>
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
|
|
369
|
+
|
|
370
|
+
|
|
371
|
+
|
|
372
|
+
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<span class="summary_desc"><div class='inline'>
|
|
376
|
+
<p>List all IP policies on this account.</p>
|
|
377
|
+
</div></span>
|
|
378
|
+
|
|
379
|
+
</li>
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
<li class="public ">
|
|
383
|
+
<span class="summary_signature">
|
|
384
|
+
|
|
385
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::IPPolicy </a>
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
</span>
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
|
|
395
|
+
|
|
396
|
+
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
<span class="summary_desc"><div class='inline'>
|
|
400
|
+
<p>Update attributes of an IP policy by ID.</p>
|
|
401
|
+
</div></span>
|
|
402
|
+
|
|
403
|
+
</li>
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
<li class="public ">
|
|
407
|
+
<span class="summary_signature">
|
|
408
|
+
|
|
409
|
+
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: "", description: nil, metadata: nil) ⇒ NgrokAPI::Models::IPPolicy </a>
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
</span>
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
|
|
419
|
+
|
|
420
|
+
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
<span class="summary_desc"><div class='inline'>
|
|
424
|
+
<p>Update attributes of an IP policy by ID Throws an exception if API error.</p>
|
|
425
|
+
</div></span>
|
|
426
|
+
|
|
427
|
+
</li>
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
</ul>
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
<div id="constructor_details" class="method_details_list">
|
|
434
|
+
<h2>Constructor Details</h2>
|
|
435
|
+
|
|
436
|
+
<div class="method_details first">
|
|
437
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
438
|
+
|
|
439
|
+
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::IPPoliciesClient (class)">IPPoliciesClient</a></span></tt>
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
|
|
443
|
+
|
|
444
|
+
|
|
445
|
+
</h3><div class="docstring">
|
|
446
|
+
<div class="discussion">
|
|
447
|
+
|
|
448
|
+
<p>Returns a new instance of IPPoliciesClient.</p>
|
|
449
|
+
|
|
450
|
+
|
|
451
|
+
</div>
|
|
452
|
+
</div>
|
|
453
|
+
<div class="tags">
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
</div><table class="source_code">
|
|
457
|
+
<tr>
|
|
458
|
+
<td>
|
|
459
|
+
<pre class="lines">
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
20
|
|
463
|
+
21
|
|
464
|
+
22</pre>
|
|
465
|
+
</td>
|
|
466
|
+
<td>
|
|
467
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 20</span>
|
|
468
|
+
|
|
469
|
+
<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>
|
|
470
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
471
|
+
<span class='kw'>end</span></pre>
|
|
472
|
+
</td>
|
|
473
|
+
</tr>
|
|
474
|
+
</table>
|
|
475
|
+
</div>
|
|
476
|
+
|
|
477
|
+
</div>
|
|
478
|
+
|
|
479
|
+
<div id="instance_attr_details" class="attr_details">
|
|
480
|
+
<h2>Instance Attribute Details</h2>
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
<span id=""></span>
|
|
484
|
+
<div class="method_details first">
|
|
485
|
+
<h3 class="signature first" id="client-instance_method">
|
|
486
|
+
|
|
487
|
+
#<strong>client</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
|
|
491
|
+
|
|
492
|
+
|
|
493
|
+
</h3><div class="docstring">
|
|
494
|
+
<div class="discussion">
|
|
495
|
+
|
|
496
|
+
<p>Returns the value of attribute client.</p>
|
|
497
|
+
|
|
498
|
+
|
|
499
|
+
</div>
|
|
500
|
+
</div>
|
|
501
|
+
<div class="tags">
|
|
502
|
+
|
|
503
|
+
|
|
504
|
+
</div><table class="source_code">
|
|
505
|
+
<tr>
|
|
506
|
+
<td>
|
|
507
|
+
<pre class="lines">
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
18
|
|
511
|
+
19
|
|
512
|
+
20</pre>
|
|
513
|
+
</td>
|
|
514
|
+
<td>
|
|
515
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 18</span>
|
|
516
|
+
|
|
517
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
|
518
|
+
<span class='ivar'>@client</span>
|
|
519
|
+
<span class='kw'>end</span></pre>
|
|
520
|
+
</td>
|
|
521
|
+
</tr>
|
|
522
|
+
</table>
|
|
523
|
+
</div>
|
|
524
|
+
|
|
525
|
+
</div>
|
|
526
|
+
|
|
527
|
+
|
|
528
|
+
<div id="instance_method_details" class="method_details_list">
|
|
529
|
+
<h2>Instance Method Details</h2>
|
|
530
|
+
|
|
531
|
+
|
|
532
|
+
<div class="method_details first">
|
|
533
|
+
<h3 class="signature first" id="create-instance_method">
|
|
534
|
+
|
|
535
|
+
#<strong>create</strong>(description: "", metadata: "", action:) ⇒ <tt><span class='object_link'><a href="../Models/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">NgrokAPI::Models::IPPolicy</a></span></tt>
|
|
536
|
+
|
|
537
|
+
|
|
538
|
+
|
|
539
|
+
|
|
540
|
+
|
|
541
|
+
</h3><div class="docstring">
|
|
542
|
+
<div class="discussion">
|
|
543
|
+
|
|
544
|
+
<p>Create a new IP policy. It will not apply to any traffic until you associate to a traffic source via an endpoint configuration or IP restriction.</p>
|
|
545
|
+
|
|
546
|
+
<p><a href="https://ngrok.com/docs/api#api-ip-policies-create">ngrok.com/docs/api#api-ip-policies-create</a></p>
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
</div>
|
|
550
|
+
</div>
|
|
551
|
+
<div class="tags">
|
|
552
|
+
<p class="tag_title">Parameters:</p>
|
|
553
|
+
<ul class="param">
|
|
554
|
+
|
|
555
|
+
<li>
|
|
556
|
+
|
|
557
|
+
<span class='name'>description</span>
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
561
|
+
|
|
562
|
+
|
|
563
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
—
|
|
567
|
+
<div class='inline'>
|
|
568
|
+
<p>human-readable description of the source IPs of this IP policy. optional, max 255 bytes.</p>
|
|
569
|
+
</div>
|
|
570
|
+
|
|
571
|
+
</li>
|
|
572
|
+
|
|
573
|
+
<li>
|
|
574
|
+
|
|
575
|
+
<span class='name'>metadata</span>
|
|
576
|
+
|
|
577
|
+
|
|
578
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
579
|
+
|
|
580
|
+
|
|
581
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
582
|
+
|
|
583
|
+
|
|
584
|
+
—
|
|
585
|
+
<div class='inline'>
|
|
586
|
+
<p>arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.</p>
|
|
587
|
+
</div>
|
|
588
|
+
|
|
589
|
+
</li>
|
|
590
|
+
|
|
591
|
+
<li>
|
|
592
|
+
|
|
593
|
+
<span class='name'>action</span>
|
|
594
|
+
|
|
595
|
+
|
|
596
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
|
|
600
|
+
—
|
|
601
|
+
<div class='inline'>
|
|
602
|
+
<p>the IP policy action. Supported values are “allow“ or “deny“</p>
|
|
603
|
+
</div>
|
|
604
|
+
|
|
605
|
+
</li>
|
|
606
|
+
|
|
607
|
+
</ul>
|
|
608
|
+
|
|
609
|
+
<p class="tag_title">Returns:</p>
|
|
610
|
+
<ul class="return">
|
|
611
|
+
|
|
612
|
+
<li>
|
|
613
|
+
|
|
614
|
+
|
|
615
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">NgrokAPI::Models::IPPolicy</a></span></tt>)</span>
|
|
616
|
+
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
—
|
|
620
|
+
<div class='inline'>
|
|
621
|
+
<p>result from the API request</p>
|
|
622
|
+
</div>
|
|
623
|
+
|
|
624
|
+
</li>
|
|
625
|
+
|
|
626
|
+
</ul>
|
|
627
|
+
|
|
628
|
+
</div><table class="source_code">
|
|
629
|
+
<tr>
|
|
630
|
+
<td>
|
|
631
|
+
<pre class="lines">
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
34
|
|
635
|
+
35
|
|
636
|
+
36
|
|
637
|
+
37
|
|
638
|
+
38
|
|
639
|
+
39
|
|
640
|
+
40
|
|
641
|
+
41
|
|
642
|
+
42
|
|
643
|
+
43
|
|
644
|
+
44
|
|
645
|
+
45
|
|
646
|
+
46
|
|
647
|
+
47
|
|
648
|
+
48</pre>
|
|
649
|
+
</td>
|
|
650
|
+
<td>
|
|
651
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 34</span>
|
|
652
|
+
|
|
653
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span>
|
|
654
|
+
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
655
|
+
<span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
656
|
+
<span class='label'>action:</span>
|
|
657
|
+
<span class='rparen'>)</span>
|
|
658
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/ip_policies</span><span class='tstring_end'>'</span></span>
|
|
659
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
660
|
+
<span class='rbrace'>}</span>
|
|
661
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
662
|
+
<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>
|
|
663
|
+
<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>
|
|
664
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:action</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_action'>action</span> <span class='kw'>if</span> <span class='id identifier rubyid_action'>action</span>
|
|
665
|
+
<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>
|
|
666
|
+
<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/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">IPPolicy</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/IPPolicy.html#initialize-instance_method" title="NgrokAPI::Models::IPPolicy#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>
|
|
667
|
+
<span class='kw'>end</span></pre>
|
|
668
|
+
</td>
|
|
669
|
+
</tr>
|
|
670
|
+
</table>
|
|
671
|
+
</div>
|
|
672
|
+
|
|
673
|
+
<div class="method_details ">
|
|
674
|
+
<h3 class="signature " id="delete-instance_method">
|
|
675
|
+
|
|
676
|
+
#<strong>delete</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
677
|
+
|
|
678
|
+
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
|
|
682
|
+
</h3><div class="docstring">
|
|
683
|
+
<div class="discussion">
|
|
684
|
+
|
|
685
|
+
<p>Delete an IP policy. If the IP policy is referenced by another object for the purposes of traffic restriction it will be treated as if the IP policy remains but has zero rules.</p>
|
|
686
|
+
|
|
687
|
+
<p><a href="https://ngrok.com/docs/api#api-ip-policies-delete">ngrok.com/docs/api#api-ip-policies-delete</a></p>
|
|
688
|
+
|
|
689
|
+
|
|
690
|
+
</div>
|
|
691
|
+
</div>
|
|
692
|
+
<div class="tags">
|
|
693
|
+
<p class="tag_title">Parameters:</p>
|
|
694
|
+
<ul class="param">
|
|
695
|
+
|
|
696
|
+
<li>
|
|
697
|
+
|
|
698
|
+
<span class='name'>id</span>
|
|
699
|
+
|
|
700
|
+
|
|
701
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
702
|
+
|
|
703
|
+
|
|
704
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
705
|
+
|
|
706
|
+
|
|
707
|
+
—
|
|
708
|
+
<div class='inline'>
|
|
709
|
+
<p>a resource identifier</p>
|
|
710
|
+
</div>
|
|
711
|
+
|
|
712
|
+
</li>
|
|
713
|
+
|
|
714
|
+
</ul>
|
|
715
|
+
|
|
716
|
+
<p class="tag_title">Returns:</p>
|
|
717
|
+
<ul class="return">
|
|
718
|
+
|
|
719
|
+
<li>
|
|
720
|
+
|
|
721
|
+
|
|
722
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
|
|
726
|
+
—
|
|
727
|
+
<div class='inline'>
|
|
728
|
+
<p>result from the API request</p>
|
|
729
|
+
</div>
|
|
730
|
+
|
|
731
|
+
</li>
|
|
732
|
+
|
|
733
|
+
</ul>
|
|
734
|
+
|
|
735
|
+
</div><table class="source_code">
|
|
736
|
+
<tr>
|
|
737
|
+
<td>
|
|
738
|
+
<pre class="lines">
|
|
739
|
+
|
|
740
|
+
|
|
741
|
+
59
|
|
742
|
+
60
|
|
743
|
+
61
|
|
744
|
+
62
|
|
745
|
+
63
|
|
746
|
+
64
|
|
747
|
+
65
|
|
748
|
+
66
|
|
749
|
+
67</pre>
|
|
750
|
+
</td>
|
|
751
|
+
<td>
|
|
752
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 59</span>
|
|
753
|
+
|
|
754
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span>
|
|
755
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
756
|
+
<span class='rparen'>)</span>
|
|
757
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/ip_policies/%{id}</span><span class='tstring_end'>'</span></span>
|
|
758
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
759
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
760
|
+
<span class='rbrace'>}</span>
|
|
761
|
+
<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>
|
|
762
|
+
<span class='kw'>end</span></pre>
|
|
763
|
+
</td>
|
|
764
|
+
</tr>
|
|
765
|
+
</table>
|
|
766
|
+
</div>
|
|
767
|
+
|
|
768
|
+
<div class="method_details ">
|
|
769
|
+
<h3 class="signature " id="delete!-instance_method">
|
|
770
|
+
|
|
771
|
+
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
772
|
+
|
|
773
|
+
|
|
774
|
+
|
|
775
|
+
|
|
776
|
+
|
|
777
|
+
</h3><div class="docstring">
|
|
778
|
+
<div class="discussion">
|
|
779
|
+
|
|
780
|
+
<p>Delete an IP policy. If the IP policy is referenced by another object for the purposes of traffic restriction it will be treated as if the IP policy remains but has zero rules. Throws an exception if API error.</p>
|
|
781
|
+
|
|
782
|
+
<p><a href="https://ngrok.com/docs/api#api-ip-policies-delete">ngrok.com/docs/api#api-ip-policies-delete</a></p>
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
</div>
|
|
786
|
+
</div>
|
|
787
|
+
<div class="tags">
|
|
788
|
+
<p class="tag_title">Parameters:</p>
|
|
789
|
+
<ul class="param">
|
|
790
|
+
|
|
791
|
+
<li>
|
|
792
|
+
|
|
793
|
+
<span class='name'>id</span>
|
|
794
|
+
|
|
795
|
+
|
|
796
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
797
|
+
|
|
798
|
+
|
|
799
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
800
|
+
|
|
801
|
+
|
|
802
|
+
—
|
|
803
|
+
<div class='inline'>
|
|
804
|
+
<p>a resource identifier</p>
|
|
805
|
+
</div>
|
|
806
|
+
|
|
807
|
+
</li>
|
|
808
|
+
|
|
809
|
+
</ul>
|
|
810
|
+
|
|
811
|
+
<p class="tag_title">Returns:</p>
|
|
812
|
+
<ul class="return">
|
|
813
|
+
|
|
814
|
+
<li>
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
818
|
+
|
|
819
|
+
|
|
820
|
+
|
|
821
|
+
—
|
|
822
|
+
<div class='inline'>
|
|
823
|
+
<p>result from the API request</p>
|
|
824
|
+
</div>
|
|
825
|
+
|
|
826
|
+
</li>
|
|
827
|
+
|
|
828
|
+
</ul>
|
|
829
|
+
|
|
830
|
+
</div><table class="source_code">
|
|
831
|
+
<tr>
|
|
832
|
+
<td>
|
|
833
|
+
<pre class="lines">
|
|
834
|
+
|
|
835
|
+
|
|
836
|
+
79
|
|
837
|
+
80
|
|
838
|
+
81
|
|
839
|
+
82
|
|
840
|
+
83
|
|
841
|
+
84
|
|
842
|
+
85
|
|
843
|
+
86
|
|
844
|
+
87</pre>
|
|
845
|
+
</td>
|
|
846
|
+
<td>
|
|
847
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 79</span>
|
|
848
|
+
|
|
849
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span>
|
|
850
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
851
|
+
<span class='rparen'>)</span>
|
|
852
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/ip_policies/%{id}</span><span class='tstring_end'>'</span></span>
|
|
853
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
854
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
855
|
+
<span class='rbrace'>}</span>
|
|
856
|
+
<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>
|
|
857
|
+
<span class='kw'>end</span></pre>
|
|
858
|
+
</td>
|
|
859
|
+
</tr>
|
|
860
|
+
</table>
|
|
861
|
+
</div>
|
|
862
|
+
|
|
863
|
+
<div class="method_details ">
|
|
864
|
+
<h3 class="signature " id="get-instance_method">
|
|
865
|
+
|
|
866
|
+
#<strong>get</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">NgrokAPI::Models::IPPolicy</a></span></tt>
|
|
867
|
+
|
|
868
|
+
|
|
869
|
+
|
|
870
|
+
|
|
871
|
+
|
|
872
|
+
</h3><div class="docstring">
|
|
873
|
+
<div class="discussion">
|
|
874
|
+
|
|
875
|
+
<p>Get detailed information about an IP policy by ID.</p>
|
|
876
|
+
|
|
877
|
+
<p><a href="https://ngrok.com/docs/api#api-ip-policies-get">ngrok.com/docs/api#api-ip-policies-get</a></p>
|
|
878
|
+
|
|
879
|
+
|
|
880
|
+
</div>
|
|
881
|
+
</div>
|
|
882
|
+
<div class="tags">
|
|
883
|
+
<p class="tag_title">Parameters:</p>
|
|
884
|
+
<ul class="param">
|
|
885
|
+
|
|
886
|
+
<li>
|
|
887
|
+
|
|
888
|
+
<span class='name'>id</span>
|
|
889
|
+
|
|
890
|
+
|
|
891
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
892
|
+
|
|
893
|
+
|
|
894
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
895
|
+
|
|
896
|
+
|
|
897
|
+
—
|
|
898
|
+
<div class='inline'>
|
|
899
|
+
<p>a resource identifier</p>
|
|
900
|
+
</div>
|
|
901
|
+
|
|
902
|
+
</li>
|
|
903
|
+
|
|
904
|
+
</ul>
|
|
905
|
+
|
|
906
|
+
<p class="tag_title">Returns:</p>
|
|
907
|
+
<ul class="return">
|
|
908
|
+
|
|
909
|
+
<li>
|
|
910
|
+
|
|
911
|
+
|
|
912
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">NgrokAPI::Models::IPPolicy</a></span></tt>)</span>
|
|
913
|
+
|
|
914
|
+
|
|
915
|
+
|
|
916
|
+
—
|
|
917
|
+
<div class='inline'>
|
|
918
|
+
<p>result from the API request</p>
|
|
919
|
+
</div>
|
|
920
|
+
|
|
921
|
+
</li>
|
|
922
|
+
|
|
923
|
+
</ul>
|
|
924
|
+
|
|
925
|
+
</div><table class="source_code">
|
|
926
|
+
<tr>
|
|
927
|
+
<td>
|
|
928
|
+
<pre class="lines">
|
|
929
|
+
|
|
930
|
+
|
|
931
|
+
96
|
|
932
|
+
97
|
|
933
|
+
98
|
|
934
|
+
99
|
|
935
|
+
100
|
|
936
|
+
101
|
|
937
|
+
102
|
|
938
|
+
103
|
|
939
|
+
104
|
|
940
|
+
105
|
|
941
|
+
106</pre>
|
|
942
|
+
</td>
|
|
943
|
+
<td>
|
|
944
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 96</span>
|
|
945
|
+
|
|
946
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span>
|
|
947
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
948
|
+
<span class='rparen'>)</span>
|
|
949
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/ip_policies/%{id}</span><span class='tstring_end'>'</span></span>
|
|
950
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
951
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
952
|
+
<span class='rbrace'>}</span>
|
|
953
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
954
|
+
<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>
|
|
955
|
+
<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/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">IPPolicy</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/IPPolicy.html#initialize-instance_method" title="NgrokAPI::Models::IPPolicy#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>
|
|
956
|
+
<span class='kw'>end</span></pre>
|
|
957
|
+
</td>
|
|
958
|
+
</tr>
|
|
959
|
+
</table>
|
|
960
|
+
</div>
|
|
961
|
+
|
|
962
|
+
<div class="method_details ">
|
|
963
|
+
<h3 class="signature " id="get!-instance_method">
|
|
964
|
+
|
|
965
|
+
#<strong>get!</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">NgrokAPI::Models::IPPolicy</a></span></tt>
|
|
966
|
+
|
|
967
|
+
|
|
968
|
+
|
|
969
|
+
|
|
970
|
+
|
|
971
|
+
</h3><div class="docstring">
|
|
972
|
+
<div class="discussion">
|
|
973
|
+
|
|
974
|
+
<p>Get detailed information about an IP policy by ID. Throws an exception if API error.</p>
|
|
975
|
+
|
|
976
|
+
<p><a href="https://ngrok.com/docs/api#api-ip-policies-get">ngrok.com/docs/api#api-ip-policies-get</a></p>
|
|
977
|
+
|
|
978
|
+
|
|
979
|
+
</div>
|
|
980
|
+
</div>
|
|
981
|
+
<div class="tags">
|
|
982
|
+
<p class="tag_title">Parameters:</p>
|
|
983
|
+
<ul class="param">
|
|
984
|
+
|
|
985
|
+
<li>
|
|
986
|
+
|
|
987
|
+
<span class='name'>id</span>
|
|
988
|
+
|
|
989
|
+
|
|
990
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
991
|
+
|
|
992
|
+
|
|
993
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
994
|
+
|
|
995
|
+
|
|
996
|
+
—
|
|
997
|
+
<div class='inline'>
|
|
998
|
+
<p>a resource identifier</p>
|
|
999
|
+
</div>
|
|
1000
|
+
|
|
1001
|
+
</li>
|
|
1002
|
+
|
|
1003
|
+
</ul>
|
|
1004
|
+
|
|
1005
|
+
<p class="tag_title">Returns:</p>
|
|
1006
|
+
<ul class="return">
|
|
1007
|
+
|
|
1008
|
+
<li>
|
|
1009
|
+
|
|
1010
|
+
|
|
1011
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">NgrokAPI::Models::IPPolicy</a></span></tt>)</span>
|
|
1012
|
+
|
|
1013
|
+
|
|
1014
|
+
|
|
1015
|
+
—
|
|
1016
|
+
<div class='inline'>
|
|
1017
|
+
<p>result from the API request</p>
|
|
1018
|
+
</div>
|
|
1019
|
+
|
|
1020
|
+
</li>
|
|
1021
|
+
|
|
1022
|
+
</ul>
|
|
1023
|
+
|
|
1024
|
+
</div><table class="source_code">
|
|
1025
|
+
<tr>
|
|
1026
|
+
<td>
|
|
1027
|
+
<pre class="lines">
|
|
1028
|
+
|
|
1029
|
+
|
|
1030
|
+
116
|
|
1031
|
+
117
|
|
1032
|
+
118
|
|
1033
|
+
119
|
|
1034
|
+
120
|
|
1035
|
+
121
|
|
1036
|
+
122
|
|
1037
|
+
123
|
|
1038
|
+
124
|
|
1039
|
+
125
|
|
1040
|
+
126</pre>
|
|
1041
|
+
</td>
|
|
1042
|
+
<td>
|
|
1043
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 116</span>
|
|
1044
|
+
|
|
1045
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span>
|
|
1046
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span>
|
|
1047
|
+
<span class='rparen'>)</span>
|
|
1048
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/ip_policies/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1049
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1050
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1051
|
+
<span class='rbrace'>}</span>
|
|
1052
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1053
|
+
<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>
|
|
1054
|
+
<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/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">IPPolicy</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/IPPolicy.html#initialize-instance_method" title="NgrokAPI::Models::IPPolicy#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>
|
|
1055
|
+
<span class='kw'>end</span></pre>
|
|
1056
|
+
</td>
|
|
1057
|
+
</tr>
|
|
1058
|
+
</table>
|
|
1059
|
+
</div>
|
|
1060
|
+
|
|
1061
|
+
<div class="method_details ">
|
|
1062
|
+
<h3 class="signature " id="list-instance_method">
|
|
1063
|
+
|
|
1064
|
+
#<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>
|
|
1065
|
+
|
|
1066
|
+
|
|
1067
|
+
|
|
1068
|
+
|
|
1069
|
+
|
|
1070
|
+
</h3><div class="docstring">
|
|
1071
|
+
<div class="discussion">
|
|
1072
|
+
|
|
1073
|
+
<p>List all IP policies on this account</p>
|
|
1074
|
+
|
|
1075
|
+
<p><a href="https://ngrok.com/docs/api#api-ip-policies-list">ngrok.com/docs/api#api-ip-policies-list</a></p>
|
|
1076
|
+
|
|
1077
|
+
|
|
1078
|
+
</div>
|
|
1079
|
+
</div>
|
|
1080
|
+
<div class="tags">
|
|
1081
|
+
<p class="tag_title">Parameters:</p>
|
|
1082
|
+
<ul class="param">
|
|
1083
|
+
|
|
1084
|
+
<li>
|
|
1085
|
+
|
|
1086
|
+
<span class='name'>before_id</span>
|
|
1087
|
+
|
|
1088
|
+
|
|
1089
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1090
|
+
|
|
1091
|
+
|
|
1092
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1093
|
+
|
|
1094
|
+
|
|
1095
|
+
</li>
|
|
1096
|
+
|
|
1097
|
+
<li>
|
|
1098
|
+
|
|
1099
|
+
<span class='name'>limit</span>
|
|
1100
|
+
|
|
1101
|
+
|
|
1102
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1103
|
+
|
|
1104
|
+
|
|
1105
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1106
|
+
|
|
1107
|
+
|
|
1108
|
+
</li>
|
|
1109
|
+
|
|
1110
|
+
<li>
|
|
1111
|
+
|
|
1112
|
+
<span class='name'>url</span>
|
|
1113
|
+
|
|
1114
|
+
|
|
1115
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1116
|
+
|
|
1117
|
+
|
|
1118
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1119
|
+
|
|
1120
|
+
|
|
1121
|
+
—
|
|
1122
|
+
<div class='inline'>
|
|
1123
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
1124
|
+
</div>
|
|
1125
|
+
|
|
1126
|
+
</li>
|
|
1127
|
+
|
|
1128
|
+
</ul>
|
|
1129
|
+
|
|
1130
|
+
<p class="tag_title">Returns:</p>
|
|
1131
|
+
<ul class="return">
|
|
1132
|
+
|
|
1133
|
+
<li>
|
|
1134
|
+
|
|
1135
|
+
|
|
1136
|
+
<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>
|
|
1137
|
+
|
|
1138
|
+
|
|
1139
|
+
|
|
1140
|
+
—
|
|
1141
|
+
<div class='inline'>
|
|
1142
|
+
<p>result from the API request</p>
|
|
1143
|
+
</div>
|
|
1144
|
+
|
|
1145
|
+
</li>
|
|
1146
|
+
|
|
1147
|
+
</ul>
|
|
1148
|
+
|
|
1149
|
+
</div><table class="source_code">
|
|
1150
|
+
<tr>
|
|
1151
|
+
<td>
|
|
1152
|
+
<pre class="lines">
|
|
1153
|
+
|
|
1154
|
+
|
|
1155
|
+
137
|
|
1156
|
+
138
|
|
1157
|
+
139
|
|
1158
|
+
140
|
|
1159
|
+
141
|
|
1160
|
+
142
|
|
1161
|
+
143
|
|
1162
|
+
144
|
|
1163
|
+
145
|
|
1164
|
+
146
|
|
1165
|
+
147
|
|
1166
|
+
148
|
|
1167
|
+
149
|
|
1168
|
+
150
|
|
1169
|
+
151
|
|
1170
|
+
152
|
|
1171
|
+
153
|
|
1172
|
+
154</pre>
|
|
1173
|
+
</td>
|
|
1174
|
+
<td>
|
|
1175
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 137</span>
|
|
1176
|
+
|
|
1177
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
|
1178
|
+
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1179
|
+
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1180
|
+
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1181
|
+
<span class='rparen'>)</span>
|
|
1182
|
+
<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>
|
|
1183
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1184
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1185
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1186
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::IPPoliciesClient::PATH (constant)">PATH</a></span></span>
|
|
1187
|
+
<span class='rparen'>)</span>
|
|
1188
|
+
<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>
|
|
1189
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1190
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1191
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::IPPoliciesClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1192
|
+
<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/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">IPPolicy</a></span></span>
|
|
1193
|
+
<span class='rparen'>)</span>
|
|
1194
|
+
<span class='kw'>end</span></pre>
|
|
1195
|
+
</td>
|
|
1196
|
+
</tr>
|
|
1197
|
+
</table>
|
|
1198
|
+
</div>
|
|
1199
|
+
|
|
1200
|
+
<div class="method_details ">
|
|
1201
|
+
<h3 class="signature " id="update-instance_method">
|
|
1202
|
+
|
|
1203
|
+
#<strong>update</strong>(id: "", description: nil, metadata: nil) ⇒ <tt><span class='object_link'><a href="../Models/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">NgrokAPI::Models::IPPolicy</a></span></tt>
|
|
1204
|
+
|
|
1205
|
+
|
|
1206
|
+
|
|
1207
|
+
|
|
1208
|
+
|
|
1209
|
+
</h3><div class="docstring">
|
|
1210
|
+
<div class="discussion">
|
|
1211
|
+
|
|
1212
|
+
<p>Update attributes of an IP policy by ID</p>
|
|
1213
|
+
|
|
1214
|
+
<p><a href="https://ngrok.com/docs/api#api-ip-policies-update">ngrok.com/docs/api#api-ip-policies-update</a></p>
|
|
1215
|
+
|
|
1216
|
+
|
|
1217
|
+
</div>
|
|
1218
|
+
</div>
|
|
1219
|
+
<div class="tags">
|
|
1220
|
+
<p class="tag_title">Parameters:</p>
|
|
1221
|
+
<ul class="param">
|
|
1222
|
+
|
|
1223
|
+
<li>
|
|
1224
|
+
|
|
1225
|
+
<span class='name'>id</span>
|
|
1226
|
+
|
|
1227
|
+
|
|
1228
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1229
|
+
|
|
1230
|
+
|
|
1231
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
</li>
|
|
1235
|
+
|
|
1236
|
+
<li>
|
|
1237
|
+
|
|
1238
|
+
<span class='name'>description</span>
|
|
1239
|
+
|
|
1240
|
+
|
|
1241
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1242
|
+
|
|
1243
|
+
|
|
1244
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1245
|
+
|
|
1246
|
+
|
|
1247
|
+
—
|
|
1248
|
+
<div class='inline'>
|
|
1249
|
+
<p>human-readable description of the source IPs of this IP policy. optional, max 255 bytes.</p>
|
|
1250
|
+
</div>
|
|
1251
|
+
|
|
1252
|
+
</li>
|
|
1253
|
+
|
|
1254
|
+
<li>
|
|
1255
|
+
|
|
1256
|
+
<span class='name'>metadata</span>
|
|
1257
|
+
|
|
1258
|
+
|
|
1259
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1260
|
+
|
|
1261
|
+
|
|
1262
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1263
|
+
|
|
1264
|
+
|
|
1265
|
+
—
|
|
1266
|
+
<div class='inline'>
|
|
1267
|
+
<p>arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.</p>
|
|
1268
|
+
</div>
|
|
1269
|
+
|
|
1270
|
+
</li>
|
|
1271
|
+
|
|
1272
|
+
</ul>
|
|
1273
|
+
|
|
1274
|
+
<p class="tag_title">Returns:</p>
|
|
1275
|
+
<ul class="return">
|
|
1276
|
+
|
|
1277
|
+
<li>
|
|
1278
|
+
|
|
1279
|
+
|
|
1280
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">NgrokAPI::Models::IPPolicy</a></span></tt>)</span>
|
|
1281
|
+
|
|
1282
|
+
|
|
1283
|
+
|
|
1284
|
+
—
|
|
1285
|
+
<div class='inline'>
|
|
1286
|
+
<p>result from the API request</p>
|
|
1287
|
+
</div>
|
|
1288
|
+
|
|
1289
|
+
</li>
|
|
1290
|
+
|
|
1291
|
+
</ul>
|
|
1292
|
+
|
|
1293
|
+
</div><table class="source_code">
|
|
1294
|
+
<tr>
|
|
1295
|
+
<td>
|
|
1296
|
+
<pre class="lines">
|
|
1297
|
+
|
|
1298
|
+
|
|
1299
|
+
165
|
|
1300
|
+
166
|
|
1301
|
+
167
|
|
1302
|
+
168
|
|
1303
|
+
169
|
|
1304
|
+
170
|
|
1305
|
+
171
|
|
1306
|
+
172
|
|
1307
|
+
173
|
|
1308
|
+
174
|
|
1309
|
+
175
|
|
1310
|
+
176
|
|
1311
|
+
177
|
|
1312
|
+
178
|
|
1313
|
+
179</pre>
|
|
1314
|
+
</td>
|
|
1315
|
+
<td>
|
|
1316
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 165</span>
|
|
1317
|
+
|
|
1318
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
|
|
1319
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
1320
|
+
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1321
|
+
<span class='label'>metadata:</span> <span class='kw'>nil</span>
|
|
1322
|
+
<span class='rparen'>)</span>
|
|
1323
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/ip_policies/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1324
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1325
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1326
|
+
<span class='rbrace'>}</span>
|
|
1327
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1328
|
+
<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>
|
|
1329
|
+
<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>
|
|
1330
|
+
<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>
|
|
1331
|
+
<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/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">IPPolicy</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/IPPolicy.html#initialize-instance_method" title="NgrokAPI::Models::IPPolicy#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>
|
|
1332
|
+
<span class='kw'>end</span></pre>
|
|
1333
|
+
</td>
|
|
1334
|
+
</tr>
|
|
1335
|
+
</table>
|
|
1336
|
+
</div>
|
|
1337
|
+
|
|
1338
|
+
<div class="method_details ">
|
|
1339
|
+
<h3 class="signature " id="update!-instance_method">
|
|
1340
|
+
|
|
1341
|
+
#<strong>update!</strong>(id: "", description: nil, metadata: nil) ⇒ <tt><span class='object_link'><a href="../Models/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">NgrokAPI::Models::IPPolicy</a></span></tt>
|
|
1342
|
+
|
|
1343
|
+
|
|
1344
|
+
|
|
1345
|
+
|
|
1346
|
+
|
|
1347
|
+
</h3><div class="docstring">
|
|
1348
|
+
<div class="discussion">
|
|
1349
|
+
|
|
1350
|
+
<p>Update attributes of an IP policy by ID Throws an exception if API error.</p>
|
|
1351
|
+
|
|
1352
|
+
<p><a href="https://ngrok.com/docs/api#api-ip-policies-update">ngrok.com/docs/api#api-ip-policies-update</a></p>
|
|
1353
|
+
|
|
1354
|
+
|
|
1355
|
+
</div>
|
|
1356
|
+
</div>
|
|
1357
|
+
<div class="tags">
|
|
1358
|
+
<p class="tag_title">Parameters:</p>
|
|
1359
|
+
<ul class="param">
|
|
1360
|
+
|
|
1361
|
+
<li>
|
|
1362
|
+
|
|
1363
|
+
<span class='name'>id</span>
|
|
1364
|
+
|
|
1365
|
+
|
|
1366
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1367
|
+
|
|
1368
|
+
|
|
1369
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1370
|
+
|
|
1371
|
+
|
|
1372
|
+
</li>
|
|
1373
|
+
|
|
1374
|
+
<li>
|
|
1375
|
+
|
|
1376
|
+
<span class='name'>description</span>
|
|
1377
|
+
|
|
1378
|
+
|
|
1379
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1380
|
+
|
|
1381
|
+
|
|
1382
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1383
|
+
|
|
1384
|
+
|
|
1385
|
+
—
|
|
1386
|
+
<div class='inline'>
|
|
1387
|
+
<p>human-readable description of the source IPs of this IP policy. optional, max 255 bytes.</p>
|
|
1388
|
+
</div>
|
|
1389
|
+
|
|
1390
|
+
</li>
|
|
1391
|
+
|
|
1392
|
+
<li>
|
|
1393
|
+
|
|
1394
|
+
<span class='name'>metadata</span>
|
|
1395
|
+
|
|
1396
|
+
|
|
1397
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1398
|
+
|
|
1399
|
+
|
|
1400
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1401
|
+
|
|
1402
|
+
|
|
1403
|
+
—
|
|
1404
|
+
<div class='inline'>
|
|
1405
|
+
<p>arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.</p>
|
|
1406
|
+
</div>
|
|
1407
|
+
|
|
1408
|
+
</li>
|
|
1409
|
+
|
|
1410
|
+
</ul>
|
|
1411
|
+
|
|
1412
|
+
<p class="tag_title">Returns:</p>
|
|
1413
|
+
<ul class="return">
|
|
1414
|
+
|
|
1415
|
+
<li>
|
|
1416
|
+
|
|
1417
|
+
|
|
1418
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">NgrokAPI::Models::IPPolicy</a></span></tt>)</span>
|
|
1419
|
+
|
|
1420
|
+
|
|
1421
|
+
|
|
1422
|
+
—
|
|
1423
|
+
<div class='inline'>
|
|
1424
|
+
<p>result from the API request</p>
|
|
1425
|
+
</div>
|
|
1426
|
+
|
|
1427
|
+
</li>
|
|
1428
|
+
|
|
1429
|
+
</ul>
|
|
1430
|
+
|
|
1431
|
+
</div><table class="source_code">
|
|
1432
|
+
<tr>
|
|
1433
|
+
<td>
|
|
1434
|
+
<pre class="lines">
|
|
1435
|
+
|
|
1436
|
+
|
|
1437
|
+
191
|
|
1438
|
+
192
|
|
1439
|
+
193
|
|
1440
|
+
194
|
|
1441
|
+
195
|
|
1442
|
+
196
|
|
1443
|
+
197
|
|
1444
|
+
198
|
|
1445
|
+
199
|
|
1446
|
+
200
|
|
1447
|
+
201
|
|
1448
|
+
202
|
|
1449
|
+
203
|
|
1450
|
+
204
|
|
1451
|
+
205</pre>
|
|
1452
|
+
</td>
|
|
1453
|
+
<td>
|
|
1454
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/ip_policies_client.rb', line 191</span>
|
|
1455
|
+
|
|
1456
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span>
|
|
1457
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
|
1458
|
+
<span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1459
|
+
<span class='label'>metadata:</span> <span class='kw'>nil</span>
|
|
1460
|
+
<span class='rparen'>)</span>
|
|
1461
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/ip_policies/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1462
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1463
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1464
|
+
<span class='rbrace'>}</span>
|
|
1465
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1466
|
+
<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>
|
|
1467
|
+
<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>
|
|
1468
|
+
<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>
|
|
1469
|
+
<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/IPPolicy.html" title="NgrokAPI::Models::IPPolicy (class)">IPPolicy</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/IPPolicy.html#initialize-instance_method" title="NgrokAPI::Models::IPPolicy#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>
|
|
1470
|
+
<span class='kw'>end</span></pre>
|
|
1471
|
+
</td>
|
|
1472
|
+
</tr>
|
|
1473
|
+
</table>
|
|
1474
|
+
</div>
|
|
1475
|
+
|
|
1476
|
+
</div>
|
|
1477
|
+
|
|
1478
|
+
</div>
|
|
1479
|
+
|
|
1480
|
+
<div id="footer">
|
|
1481
|
+
Generated on Mon Oct 4 23:24:17 2021 by
|
|
1482
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1483
|
+
0.9.26 (ruby-3.0.1).
|
|
1484
|
+
</div>
|
|
1485
|
+
|
|
1486
|
+
</div>
|
|
1487
|
+
</body>
|
|
1488
|
+
</html>
|