ngrok-api 0.9.0 → 0.16.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.rubocop.yml +2 -2
- data/.yardopts +1 -0
- data/LICENSE +7 -0
- data/doc/NgrokAPI/Client.html +1469 -125
- data/doc/NgrokAPI/Error.html +3 -3
- data/doc/NgrokAPI/Errors/NotFoundError.html +3 -3
- data/doc/NgrokAPI/Errors.html +3 -3
- data/doc/NgrokAPI/HttpClient.html +66 -36
- data/doc/NgrokAPI/Models/{ApiKey.html → APIKey.html} +110 -179
- data/doc/NgrokAPI/Models/AWSAuth.html +617 -0
- data/doc/NgrokAPI/Models/AWSCredentials.html +617 -0
- data/doc/NgrokAPI/Models/AWSRole.html +543 -0
- data/doc/NgrokAPI/Models/AbuseReport.html +987 -0
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +617 -0
- data/doc/NgrokAPI/Models/AgentIngress.html +1217 -0
- data/doc/NgrokAPI/Models/CertificateAuthority.html +1439 -0
- data/doc/NgrokAPI/Models/Credential.html +1149 -0
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +913 -0
- data/doc/NgrokAPI/Models/EndpointCompression.html +543 -0
- data/doc/NgrokAPI/Models/EndpointConfiguration.html +1323 -512
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +617 -0
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointLogging.html +617 -0
- data/doc/NgrokAPI/Models/EndpointLoggingMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +617 -0
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +617 -0
- data/doc/NgrokAPI/Models/EndpointOAuth.html +987 -0
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +987 -0
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +839 -0
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +765 -0
- data/doc/NgrokAPI/Models/EndpointOIDC.html +1135 -0
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +691 -0
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +691 -0
- data/doc/NgrokAPI/Models/EndpointSAML.html +1653 -0
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +1283 -0
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +691 -0
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +691 -0
- data/doc/NgrokAPI/Models/EventDestination.html +1058 -0
- data/doc/NgrokAPI/Models/EventSource.html +765 -0
- data/doc/NgrokAPI/Models/EventSourceList.html +617 -0
- data/doc/NgrokAPI/Models/EventSourceReplace.html +691 -0
- data/doc/NgrokAPI/Models/EventStream.html +1309 -0
- data/doc/NgrokAPI/Models/EventSubscription.html +1058 -0
- data/doc/NgrokAPI/Models/EventTarget.html +765 -0
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +617 -0
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +617 -0
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +617 -0
- data/doc/NgrokAPI/Models/{TlsCertificate.html → IPPolicy.html} +172 -167
- data/doc/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/doc/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/doc/NgrokAPI/Models/Listable.html +120 -52
- data/doc/NgrokAPI/Models/Ref.html +617 -0
- data/doc/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/doc/NgrokAPI/Models/ReservedDomain.html +186 -1108
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +765 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +617 -0
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +617 -0
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +1143 -0
- data/doc/NgrokAPI/Models/SSHCredential.html +1149 -0
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +1513 -0
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +1661 -0
- data/doc/NgrokAPI/Models/TLSCertificate.html +2179 -0
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +617 -0
- data/doc/NgrokAPI/Models/Tunnel.html +987 -0
- data/doc/NgrokAPI/Models/TunnelSession.html +1209 -0
- data/doc/NgrokAPI/Models.html +6 -6
- data/doc/NgrokAPI/PagedIterator.html +16 -12
- data/{docs/NgrokAPI/Services/ApiKeysClient.html → doc/NgrokAPI/Services/APIKeysClient.html} +404 -153
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +706 -0
- data/doc/NgrokAPI/Services/AgentIngressesClient.html +1600 -0
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +1602 -0
- data/doc/NgrokAPI/Services/CredentialsClient.html +1644 -0
- data/doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointCompressionModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointConfigurationsClient.html +503 -370
- data/doc/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointLoggingModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointOAuthModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointOIDCModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointSAMLModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1043 -0
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +1712 -0
- data/doc/NgrokAPI/Services/EventSourcesClient.html +1532 -0
- data/doc/NgrokAPI/Services/EventStreamsClient.html +1792 -0
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +1712 -0
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +1602 -0
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +1660 -0
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +1720 -0
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +1894 -0
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +585 -344
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1644 -0
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +1662 -0
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +1680 -0
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +1720 -0
- data/{docs/NgrokAPI/Services/TlsCertificatesClient.html → doc/NgrokAPI/Services/TLSCertificatesClient.html} +404 -201
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +1587 -0
- data/doc/NgrokAPI/Services/TunnelsClient.html +669 -0
- data/doc/NgrokAPI/Services.html +6 -6
- data/doc/NgrokAPI.html +5 -5
- data/doc/README +94 -0
- data/doc/_index.html +621 -25
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +55 -28
- data/doc/frames.html +1 -1
- data/doc/index.html +55 -28
- data/doc/method_list.html +7526 -286
- data/doc/top-level-namespace.html +3 -3
- data/docs/.gitkeep +0 -0
- data/docs/CNAME +1 -0
- data/docs/NgrokAPI/Client.html +1469 -125
- data/docs/NgrokAPI/Error.html +3 -3
- data/docs/NgrokAPI/Errors/NotFoundError.html +3 -3
- data/docs/NgrokAPI/Errors.html +3 -3
- data/docs/NgrokAPI/HttpClient.html +66 -36
- data/docs/NgrokAPI/Models/{ApiKey.html → APIKey.html} +110 -179
- data/docs/NgrokAPI/Models/AWSAuth.html +617 -0
- data/docs/NgrokAPI/Models/AWSCredentials.html +617 -0
- data/docs/NgrokAPI/Models/AWSRole.html +543 -0
- data/docs/NgrokAPI/Models/AbuseReport.html +987 -0
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +617 -0
- data/docs/NgrokAPI/Models/AgentIngress.html +1217 -0
- data/docs/NgrokAPI/Models/CertificateAuthority.html +1439 -0
- data/docs/NgrokAPI/Models/Credential.html +1149 -0
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +913 -0
- data/docs/NgrokAPI/Models/EndpointCompression.html +543 -0
- data/docs/NgrokAPI/Models/EndpointConfiguration.html +1323 -512
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +617 -0
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointLogging.html +617 -0
- data/docs/NgrokAPI/Models/EndpointLoggingMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +617 -0
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +617 -0
- data/docs/NgrokAPI/Models/EndpointOAuth.html +987 -0
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +987 -0
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +839 -0
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +765 -0
- data/docs/NgrokAPI/Models/EndpointOIDC.html +1135 -0
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +691 -0
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +691 -0
- data/docs/NgrokAPI/Models/EndpointSAML.html +1653 -0
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +1283 -0
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +691 -0
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +691 -0
- data/docs/NgrokAPI/Models/EventDestination.html +1058 -0
- data/docs/NgrokAPI/Models/EventSource.html +765 -0
- data/docs/NgrokAPI/Models/EventSourceList.html +617 -0
- data/docs/NgrokAPI/Models/EventSourceReplace.html +691 -0
- data/docs/NgrokAPI/Models/EventStream.html +1309 -0
- data/docs/NgrokAPI/Models/EventSubscription.html +1058 -0
- data/docs/NgrokAPI/Models/EventTarget.html +765 -0
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +617 -0
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +617 -0
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +617 -0
- data/docs/NgrokAPI/Models/{TlsCertificate.html → IPPolicy.html} +172 -167
- data/docs/NgrokAPI/Models/IPPolicyRule.html +1149 -0
- data/docs/NgrokAPI/Models/IPRestriction.html +1132 -0
- data/docs/NgrokAPI/Models/Listable.html +120 -52
- data/docs/NgrokAPI/Models/Ref.html +617 -0
- data/docs/NgrokAPI/Models/ReservedAddr.html +1132 -0
- data/docs/NgrokAPI/Models/ReservedDomain.html +186 -1108
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +765 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +617 -0
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +617 -0
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +1143 -0
- data/docs/NgrokAPI/Models/SSHCredential.html +1149 -0
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +1513 -0
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +1661 -0
- data/docs/NgrokAPI/Models/TLSCertificate.html +2179 -0
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +617 -0
- data/docs/NgrokAPI/Models/Tunnel.html +987 -0
- data/docs/NgrokAPI/Models/TunnelSession.html +1209 -0
- data/docs/NgrokAPI/Models.html +6 -6
- data/docs/NgrokAPI/PagedIterator.html +16 -12
- data/{doc/NgrokAPI/Services/ApiKeysClient.html → docs/NgrokAPI/Services/APIKeysClient.html} +404 -153
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +706 -0
- data/docs/NgrokAPI/Services/AgentIngressesClient.html +1600 -0
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +1602 -0
- data/docs/NgrokAPI/Services/CredentialsClient.html +1644 -0
- data/docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointCompressionModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointConfigurationsClient.html +503 -370
- data/docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointLoggingModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointOAuthModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointOIDCModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointSAMLModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +1712 -0
- data/docs/NgrokAPI/Services/EventSourcesClient.html +1532 -0
- data/docs/NgrokAPI/Services/EventStreamsClient.html +1792 -0
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +1712 -0
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +1602 -0
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +1660 -0
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +1720 -0
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +1894 -0
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +585 -344
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +1644 -0
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +1662 -0
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +1680 -0
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +1720 -0
- data/{doc/NgrokAPI/Services/TlsCertificatesClient.html → docs/NgrokAPI/Services/TLSCertificatesClient.html} +404 -201
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +1587 -0
- data/docs/NgrokAPI/Services/TunnelsClient.html +669 -0
- data/docs/NgrokAPI/Services.html +6 -6
- data/docs/NgrokAPI.html +5 -5
- data/docs/README +94 -0
- data/docs/_index.html +621 -25
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +55 -28
- data/docs/frames.html +1 -1
- data/docs/index.html +55 -28
- data/docs/method_list.html +7526 -286
- data/docs/top-level-namespace.html +3 -3
- data/lib/ngrokapi/client.rb +229 -49
- data/lib/ngrokapi/http_client.rb +6 -7
- data/lib/ngrokapi/models/abuse_report.rb +37 -0
- data/lib/ngrokapi/models/abuse_report_hostname.rb +27 -0
- data/lib/ngrokapi/models/agent_ingress.rb +66 -0
- data/lib/ngrokapi/models/api_key.rb +62 -64
- data/lib/ngrokapi/models/aws_auth.rb +27 -0
- data/lib/ngrokapi/models/aws_credentials.rb +27 -0
- data/lib/ngrokapi/models/aws_role.rb +25 -0
- data/lib/ngrokapi/models/certificate_authority.rb +72 -0
- data/lib/ngrokapi/models/credential.rb +67 -0
- data/lib/ngrokapi/models/endpoint_circuit_breaker.rb +35 -0
- data/lib/ngrokapi/models/endpoint_compression.rb +25 -0
- data/lib/ngrokapi/models/endpoint_configuration.rb +130 -119
- data/lib/ngrokapi/models/endpoint_ip_policy.rb +27 -0
- data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_logging.rb +27 -0
- data/lib/ngrokapi/models/endpoint_logging_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_mutual_tls.rb +27 -0
- data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb +27 -0
- data/lib/ngrokapi/models/endpoint_o_auth.rb +37 -0
- data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb +37 -0
- data/lib/ngrokapi/models/endpoint_o_auth_google.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_microsoft.rb +33 -0
- data/lib/ngrokapi/models/endpoint_o_auth_provider.rb +31 -0
- data/lib/ngrokapi/models/endpoint_oidc.rb +41 -0
- data/lib/ngrokapi/models/endpoint_request_headers.rb +29 -0
- data/lib/ngrokapi/models/endpoint_response_headers.rb +29 -0
- data/lib/ngrokapi/models/endpoint_saml.rb +55 -0
- data/lib/ngrokapi/models/endpoint_saml_mutate.rb +45 -0
- data/lib/ngrokapi/models/endpoint_tls_termination.rb +29 -0
- data/lib/ngrokapi/models/endpoint_webhook_validation.rb +29 -0
- data/lib/ngrokapi/models/event_destination.rb +49 -0
- data/lib/ngrokapi/models/event_source.rb +31 -0
- data/lib/ngrokapi/models/event_source_list.rb +27 -0
- data/lib/ngrokapi/models/event_source_replace.rb +29 -0
- data/lib/ngrokapi/models/event_stream.rb +77 -0
- data/lib/ngrokapi/models/event_subscription.rb +47 -0
- data/lib/ngrokapi/models/event_target.rb +31 -0
- data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb +27 -0
- data/lib/ngrokapi/models/event_target_firehose.rb +27 -0
- data/lib/ngrokapi/models/event_target_kinesis.rb +27 -0
- data/lib/ngrokapi/models/ip_policy.rb +64 -0
- data/lib/ngrokapi/models/ip_policy_rule.rb +67 -0
- data/lib/ngrokapi/models/ip_restriction.rb +49 -0
- data/lib/ngrokapi/models/listable.rb +13 -2
- data/lib/ngrokapi/models/ref.rb +27 -0
- data/lib/ngrokapi/models/reserved_addr.rb +49 -0
- data/lib/ngrokapi/models/reserved_domain.rb +61 -211
- data/lib/ngrokapi/models/reserved_domain_cert_job.rb +31 -0
- data/lib/ngrokapi/models/reserved_domain_cert_policy.rb +27 -0
- data/lib/ngrokapi/models/reserved_domain_cert_status.rb +27 -0
- data/lib/ngrokapi/models/ssh_certificate_authority.rb +64 -0
- data/lib/ngrokapi/models/ssh_credential.rb +67 -0
- data/lib/ngrokapi/models/ssh_host_certificate.rb +74 -0
- data/lib/ngrokapi/models/ssh_user_certificate.rb +78 -0
- data/lib/ngrokapi/models/tls_certificate.rb +92 -62
- data/lib/ngrokapi/models/tls_certificate_sa_ns.rb +27 -0
- data/lib/ngrokapi/models/tunnel.rb +37 -0
- data/lib/ngrokapi/models/tunnel_session.rb +43 -0
- data/lib/ngrokapi/paged_iterator.rb +4 -2
- data/lib/ngrokapi/services/.gitkeep +0 -0
- data/lib/ngrokapi/services/abuse_reports_client.rb +77 -0
- data/lib/ngrokapi/services/agent_ingresses_client.rb +206 -0
- data/lib/ngrokapi/services/api_keys_client.rb +210 -144
- data/lib/ngrokapi/services/certificate_authorities_client.rb +211 -0
- data/lib/ngrokapi/services/credentials_client.rb +217 -0
- data/lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_compression_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +289 -313
- data/lib/ngrokapi/services/endpoint_ip_policy_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_logging_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_mutual_tls_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_o_auth_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_oidc_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_request_headers_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_response_headers_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_saml_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_tls_termination_module_client.rb +108 -0
- data/lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb +108 -0
- data/lib/ngrokapi/services/event_destinations_client.rb +221 -0
- data/lib/ngrokapi/services/event_sources_client.rb +185 -0
- data/lib/ngrokapi/services/event_streams_client.rb +224 -0
- data/lib/ngrokapi/services/event_subscriptions_client.rb +215 -0
- data/lib/ngrokapi/services/ip_policies_client.rb +215 -0
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +214 -0
- data/lib/ngrokapi/services/ip_restrictions_client.rb +224 -0
- data/lib/ngrokapi/services/reserved_addrs_client.rb +246 -0
- data/lib/ngrokapi/services/reserved_domains_client.rb +360 -313
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +212 -0
- data/lib/ngrokapi/services/ssh_credentials_client.rb +215 -0
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +217 -0
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +221 -0
- data/lib/ngrokapi/services/tls_certificates_client.rb +213 -161
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +237 -0
- data/lib/ngrokapi/services/tunnels_client.rb +78 -0
- data/lib/ngrokapi/version.rb +1 -1
- data/lib/ngrokapi.rb +1 -1
- data/ngrok-api.gemspec +1 -1
- data/spec/ngrokapi/client_spec.rb +158 -33
- data/spec/ngrokapi/models/abuse_report_hostname_spec.rb +21 -0
- data/spec/ngrokapi/models/abuse_report_spec.rb +21 -0
- data/spec/ngrokapi/models/agent_ingress_spec.rb +42 -0
- data/spec/ngrokapi/models/api_key_spec.rb +42 -43
- data/spec/ngrokapi/models/aws_auth_spec.rb +21 -0
- data/spec/ngrokapi/models/aws_credentials_spec.rb +21 -0
- data/spec/ngrokapi/models/aws_role_spec.rb +21 -0
- data/spec/ngrokapi/models/certificate_authority_spec.rb +42 -0
- data/spec/ngrokapi/models/credential_spec.rb +45 -0
- data/spec/ngrokapi/models/endpoint_circuit_breaker_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_compression_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_configuration_spec.rb +78 -0
- data/spec/ngrokapi/models/endpoint_ip_policy_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_ip_policy_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_logging_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_logging_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_mutual_tls_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_mutual_tls_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_facebook_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_git_hub_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_google_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_microsoft_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_provider_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_o_auth_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_oidc_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_request_headers_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_response_headers_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_saml_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_saml_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_tls_termination_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_webhook_validation_spec.rb +21 -0
- data/spec/ngrokapi/models/event_destination_spec.rb +28 -0
- data/spec/ngrokapi/models/event_source_list_spec.rb +21 -0
- data/spec/ngrokapi/models/event_source_replace_spec.rb +21 -0
- data/spec/ngrokapi/models/event_source_spec.rb +21 -0
- data/spec/ngrokapi/models/event_stream_spec.rb +51 -0
- data/spec/ngrokapi/models/event_subscription_spec.rb +28 -0
- data/spec/ngrokapi/models/event_target_cloudwatch_logs_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_firehose_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_kinesis_spec.rb +21 -0
- data/spec/ngrokapi/models/event_target_spec.rb +21 -0
- data/spec/ngrokapi/models/ip_policy_rule_spec.rb +45 -0
- data/spec/ngrokapi/models/ip_policy_spec.rb +42 -0
- data/spec/ngrokapi/models/ip_restriction_spec.rb +28 -0
- data/spec/ngrokapi/models/listable_spec.rb +4 -4
- data/spec/ngrokapi/models/ref_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_addr_spec.rb +28 -0
- data/spec/ngrokapi/models/reserved_domain_cert_job_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_cert_status_spec.rb +21 -0
- data/spec/ngrokapi/models/reserved_domain_spec.rb +28 -100
- data/spec/ngrokapi/models/ssh_certificate_authority_spec.rb +42 -0
- data/spec/ngrokapi/models/ssh_credential_spec.rb +45 -0
- data/spec/ngrokapi/models/ssh_host_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/ssh_user_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/tls_certificate_sa_ns_spec.rb +21 -0
- data/spec/ngrokapi/models/tls_certificate_spec.rb +42 -0
- data/spec/ngrokapi/models/tunnel_session_spec.rb +21 -0
- data/spec/ngrokapi/models/tunnel_spec.rb +21 -0
- data/spec/ngrokapi/paged_iterator_spec.rb +7 -7
- data/spec/ngrokapi/services/.gitkeep +0 -0
- data/spec/ngrokapi/services/abuse_reports_client_spec.rb +65 -0
- data/spec/ngrokapi/services/agent_ingresses_client_spec.rb +159 -0
- data/spec/ngrokapi/services/api_keys_client_spec.rb +157 -127
- data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +159 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +163 -0
- data/spec/ngrokapi/services/endpoint_circuit_breaker_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_compression_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +237 -0
- data/spec/ngrokapi/services/endpoint_ip_policy_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_mutual_tls_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_o_auth_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_oidc_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_request_headers_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_response_headers_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_saml_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_tls_termination_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/endpoint_webhook_validation_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/event_destinations_client_spec.rb +172 -0
- data/spec/ngrokapi/services/event_sources_client_spec.rb +192 -0
- data/spec/ngrokapi/services/event_streams_client_spec.rb +177 -0
- data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +169 -0
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +159 -0
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +165 -0
- data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +171 -0
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +206 -0
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +349 -0
- data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +163 -0
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +165 -0
- data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +167 -0
- data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +171 -0
- data/spec/ngrokapi/services/tls_certificates_client_spec.rb +161 -0
- data/spec/ngrokapi/services/tunnel_sessions_client_spec.rb +183 -0
- data/spec/ngrokapi/services/tunnels_client_spec.rb +21 -0
- data/spec/spec_helper.rb +1096 -80
- metadata +360 -11
|
@@ -0,0 +1,1894 @@
|
|
|
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::ReservedAddrsClient
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.27
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "NgrokAPI::Services::ReservedAddrsClient";
|
|
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 (R)</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">ReservedAddrsClient</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::ReservedAddrsClient
|
|
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::ReservedAddrsClient</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/reserved_addrs_client.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p>Reserved Addresses are TCP addresses that can be used to listen for traffic. TCP address hostnames and ports are assigned by ngrok, they cannot be chosen.</p>
|
|
106
|
+
|
|
107
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-addrs">ngrok.com/docs/api#api-reserved-addrs</a></p>
|
|
108
|
+
|
|
109
|
+
|
|
110
|
+
</div>
|
|
111
|
+
</div>
|
|
112
|
+
<div class="tags">
|
|
113
|
+
|
|
114
|
+
|
|
115
|
+
</div>
|
|
116
|
+
|
|
117
|
+
<h2>
|
|
118
|
+
Constant Summary
|
|
119
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
120
|
+
</h2>
|
|
121
|
+
|
|
122
|
+
<dl class="constants">
|
|
123
|
+
|
|
124
|
+
<dt id="PATH-constant" class="">PATH =
|
|
125
|
+
<div class="docstring">
|
|
126
|
+
<div class="discussion">
|
|
127
|
+
|
|
128
|
+
<p>The API path for the requests</p>
|
|
129
|
+
|
|
130
|
+
|
|
131
|
+
</div>
|
|
132
|
+
</div>
|
|
133
|
+
<div class="tags">
|
|
134
|
+
|
|
135
|
+
|
|
136
|
+
</div>
|
|
137
|
+
</dt>
|
|
138
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_addrs</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
139
|
+
|
|
140
|
+
<dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
|
|
141
|
+
<div class="docstring">
|
|
142
|
+
<div class="discussion">
|
|
143
|
+
|
|
144
|
+
<p>The List Property from the resulting API for list calls</p>
|
|
145
|
+
|
|
146
|
+
|
|
147
|
+
</div>
|
|
148
|
+
</div>
|
|
149
|
+
<div class="tags">
|
|
150
|
+
|
|
151
|
+
|
|
152
|
+
</div>
|
|
153
|
+
</dt>
|
|
154
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>reserved_addrs</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
155
|
+
|
|
156
|
+
</dl>
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
163
|
+
<ul class="summary">
|
|
164
|
+
|
|
165
|
+
<li class="public ">
|
|
166
|
+
<span class="summary_signature">
|
|
167
|
+
|
|
168
|
+
<a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> ⇒ Object </a>
|
|
169
|
+
|
|
170
|
+
|
|
171
|
+
|
|
172
|
+
</span>
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
|
|
177
|
+
<span class="note title readonly">readonly</span>
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
|
|
186
|
+
|
|
187
|
+
<span class="summary_desc"><div class='inline'>
|
|
188
|
+
<p>Returns the value of attribute client.</p>
|
|
189
|
+
</div></span>
|
|
190
|
+
|
|
191
|
+
</li>
|
|
192
|
+
|
|
193
|
+
|
|
194
|
+
</ul>
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
|
|
199
|
+
|
|
200
|
+
<h2>
|
|
201
|
+
Instance Method Summary
|
|
202
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
203
|
+
</h2>
|
|
204
|
+
|
|
205
|
+
<ul class="summary">
|
|
206
|
+
|
|
207
|
+
<li class="public ">
|
|
208
|
+
<span class="summary_signature">
|
|
209
|
+
|
|
210
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: "", metadata: "", region: "", endpoint_configuration_id: nil) ⇒ NgrokAPI::Models::ReservedAddr </a>
|
|
211
|
+
|
|
212
|
+
|
|
213
|
+
|
|
214
|
+
</span>
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
<span class="summary_desc"><div class='inline'>
|
|
225
|
+
<p>Create a new reserved address.</p>
|
|
226
|
+
</div></span>
|
|
227
|
+
|
|
228
|
+
</li>
|
|
229
|
+
|
|
230
|
+
|
|
231
|
+
<li class="public ">
|
|
232
|
+
<span class="summary_signature">
|
|
233
|
+
|
|
234
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
235
|
+
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
</span>
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
|
|
247
|
+
|
|
248
|
+
<span class="summary_desc"><div class='inline'>
|
|
249
|
+
<p>Delete a reserved address.</p>
|
|
250
|
+
</div></span>
|
|
251
|
+
|
|
252
|
+
</li>
|
|
253
|
+
|
|
254
|
+
|
|
255
|
+
<li class="public ">
|
|
256
|
+
<span class="summary_signature">
|
|
257
|
+
|
|
258
|
+
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
259
|
+
|
|
260
|
+
|
|
261
|
+
|
|
262
|
+
</span>
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
|
|
271
|
+
|
|
272
|
+
<span class="summary_desc"><div class='inline'>
|
|
273
|
+
<p>Delete a reserved address.</p>
|
|
274
|
+
</div></span>
|
|
275
|
+
|
|
276
|
+
</li>
|
|
277
|
+
|
|
278
|
+
|
|
279
|
+
<li class="public ">
|
|
280
|
+
<span class="summary_signature">
|
|
281
|
+
|
|
282
|
+
<a href="#delete_endpoint_config-instance_method" title="#delete_endpoint_config (instance method)">#<strong>delete_endpoint_config</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
283
|
+
|
|
284
|
+
|
|
285
|
+
|
|
286
|
+
</span>
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
|
|
295
|
+
|
|
296
|
+
<span class="summary_desc"><div class='inline'>
|
|
297
|
+
<p>Detach the endpoint configuration attached to a reserved address.</p>
|
|
298
|
+
</div></span>
|
|
299
|
+
|
|
300
|
+
</li>
|
|
301
|
+
|
|
302
|
+
|
|
303
|
+
<li class="public ">
|
|
304
|
+
<span class="summary_signature">
|
|
305
|
+
|
|
306
|
+
<a href="#delete_endpoint_config!-instance_method" title="#delete_endpoint_config! (instance method)">#<strong>delete_endpoint_config!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
307
|
+
|
|
308
|
+
|
|
309
|
+
|
|
310
|
+
</span>
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
|
|
319
|
+
|
|
320
|
+
<span class="summary_desc"><div class='inline'>
|
|
321
|
+
<p>Detach the endpoint configuration attached to a reserved address.</p>
|
|
322
|
+
</div></span>
|
|
323
|
+
|
|
324
|
+
</li>
|
|
325
|
+
|
|
326
|
+
|
|
327
|
+
<li class="public ">
|
|
328
|
+
<span class="summary_signature">
|
|
329
|
+
|
|
330
|
+
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: "") ⇒ NgrokAPI::Models::ReservedAddr </a>
|
|
331
|
+
|
|
332
|
+
|
|
333
|
+
|
|
334
|
+
</span>
|
|
335
|
+
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
<span class="summary_desc"><div class='inline'>
|
|
345
|
+
<p>Get the details of a reserved address.</p>
|
|
346
|
+
</div></span>
|
|
347
|
+
|
|
348
|
+
</li>
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
<li class="public ">
|
|
352
|
+
<span class="summary_signature">
|
|
353
|
+
|
|
354
|
+
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: "") ⇒ NgrokAPI::Models::ReservedAddr </a>
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
</span>
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
<span class="summary_desc"><div class='inline'>
|
|
369
|
+
<p>Get the details of a reserved address.</p>
|
|
370
|
+
</div></span>
|
|
371
|
+
|
|
372
|
+
</li>
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<li class="public ">
|
|
376
|
+
<span class="summary_signature">
|
|
377
|
+
|
|
378
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒ ReservedAddrsClient </a>
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
</span>
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
<span class="note title constructor">constructor</span>
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
|
|
393
|
+
|
|
394
|
+
<span class="summary_desc"><div class='inline'>
|
|
395
|
+
<p>A new instance of ReservedAddrsClient.</p>
|
|
396
|
+
</div></span>
|
|
397
|
+
|
|
398
|
+
</li>
|
|
399
|
+
|
|
400
|
+
|
|
401
|
+
<li class="public ">
|
|
402
|
+
<span class="summary_signature">
|
|
403
|
+
|
|
404
|
+
<a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
405
|
+
|
|
406
|
+
|
|
407
|
+
|
|
408
|
+
</span>
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
|
|
417
|
+
|
|
418
|
+
<span class="summary_desc"><div class='inline'>
|
|
419
|
+
<p>List all reserved addresses on this account.</p>
|
|
420
|
+
</div></span>
|
|
421
|
+
|
|
422
|
+
</li>
|
|
423
|
+
|
|
424
|
+
|
|
425
|
+
<li class="public ">
|
|
426
|
+
<span class="summary_signature">
|
|
427
|
+
|
|
428
|
+
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
429
|
+
|
|
430
|
+
|
|
431
|
+
|
|
432
|
+
</span>
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
|
|
441
|
+
|
|
442
|
+
<span class="summary_desc"><div class='inline'>
|
|
443
|
+
<p>List all reserved addresses on this account.</p>
|
|
444
|
+
</div></span>
|
|
445
|
+
|
|
446
|
+
</li>
|
|
447
|
+
|
|
448
|
+
|
|
449
|
+
<li class="public ">
|
|
450
|
+
<span class="summary_signature">
|
|
451
|
+
|
|
452
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", description: nil, metadata: nil, endpoint_configuration_id: nil) ⇒ NgrokAPI::Models::ReservedAddr </a>
|
|
453
|
+
|
|
454
|
+
|
|
455
|
+
|
|
456
|
+
</span>
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
|
|
463
|
+
|
|
464
|
+
|
|
465
|
+
|
|
466
|
+
<span class="summary_desc"><div class='inline'>
|
|
467
|
+
<p>Update the attributes of a reserved address.</p>
|
|
468
|
+
</div></span>
|
|
469
|
+
|
|
470
|
+
</li>
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
<li class="public ">
|
|
474
|
+
<span class="summary_signature">
|
|
475
|
+
|
|
476
|
+
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: "", description: nil, metadata: nil, endpoint_configuration_id: nil) ⇒ NgrokAPI::Models::ReservedAddr </a>
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
</span>
|
|
481
|
+
|
|
482
|
+
|
|
483
|
+
|
|
484
|
+
|
|
485
|
+
|
|
486
|
+
|
|
487
|
+
|
|
488
|
+
|
|
489
|
+
|
|
490
|
+
<span class="summary_desc"><div class='inline'>
|
|
491
|
+
<p>Update the attributes of a reserved address.</p>
|
|
492
|
+
</div></span>
|
|
493
|
+
|
|
494
|
+
</li>
|
|
495
|
+
|
|
496
|
+
|
|
497
|
+
</ul>
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
<div id="constructor_details" class="method_details_list">
|
|
501
|
+
<h2>Constructor Details</h2>
|
|
502
|
+
|
|
503
|
+
<div class="method_details first">
|
|
504
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
505
|
+
|
|
506
|
+
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::ReservedAddrsClient (class)">ReservedAddrsClient</a></span></tt>
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
|
|
511
|
+
|
|
512
|
+
</h3><div class="docstring">
|
|
513
|
+
<div class="discussion">
|
|
514
|
+
|
|
515
|
+
<p>Returns a new instance of ReservedAddrsClient.</p>
|
|
516
|
+
|
|
517
|
+
|
|
518
|
+
</div>
|
|
519
|
+
</div>
|
|
520
|
+
<div class="tags">
|
|
521
|
+
|
|
522
|
+
|
|
523
|
+
</div><table class="source_code">
|
|
524
|
+
<tr>
|
|
525
|
+
<td>
|
|
526
|
+
<pre class="lines">
|
|
527
|
+
|
|
528
|
+
|
|
529
|
+
19
|
|
530
|
+
20
|
|
531
|
+
21</pre>
|
|
532
|
+
</td>
|
|
533
|
+
<td>
|
|
534
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 19</span>
|
|
535
|
+
|
|
536
|
+
<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>
|
|
537
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
538
|
+
<span class='kw'>end</span></pre>
|
|
539
|
+
</td>
|
|
540
|
+
</tr>
|
|
541
|
+
</table>
|
|
542
|
+
</div>
|
|
543
|
+
|
|
544
|
+
</div>
|
|
545
|
+
|
|
546
|
+
<div id="instance_attr_details" class="attr_details">
|
|
547
|
+
<h2>Instance Attribute Details</h2>
|
|
548
|
+
|
|
549
|
+
|
|
550
|
+
<span id=""></span>
|
|
551
|
+
<div class="method_details first">
|
|
552
|
+
<h3 class="signature first" id="client-instance_method">
|
|
553
|
+
|
|
554
|
+
#<strong>client</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
|
|
559
|
+
|
|
560
|
+
</h3><div class="docstring">
|
|
561
|
+
<div class="discussion">
|
|
562
|
+
|
|
563
|
+
<p>Returns the value of attribute client.</p>
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
</div>
|
|
567
|
+
</div>
|
|
568
|
+
<div class="tags">
|
|
569
|
+
|
|
570
|
+
|
|
571
|
+
</div><table class="source_code">
|
|
572
|
+
<tr>
|
|
573
|
+
<td>
|
|
574
|
+
<pre class="lines">
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
17
|
|
578
|
+
18
|
|
579
|
+
19</pre>
|
|
580
|
+
</td>
|
|
581
|
+
<td>
|
|
582
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 17</span>
|
|
583
|
+
|
|
584
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
|
585
|
+
<span class='ivar'>@client</span>
|
|
586
|
+
<span class='kw'>end</span></pre>
|
|
587
|
+
</td>
|
|
588
|
+
</tr>
|
|
589
|
+
</table>
|
|
590
|
+
</div>
|
|
591
|
+
|
|
592
|
+
</div>
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
<div id="instance_method_details" class="method_details_list">
|
|
596
|
+
<h2>Instance Method Details</h2>
|
|
597
|
+
|
|
598
|
+
|
|
599
|
+
<div class="method_details first">
|
|
600
|
+
<h3 class="signature first" id="create-instance_method">
|
|
601
|
+
|
|
602
|
+
#<strong>create</strong>(description: "", metadata: "", region: "", endpoint_configuration_id: nil) ⇒ <tt><span class='object_link'><a href="../Models/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">NgrokAPI::Models::ReservedAddr</a></span></tt>
|
|
603
|
+
|
|
604
|
+
|
|
605
|
+
|
|
606
|
+
|
|
607
|
+
|
|
608
|
+
</h3><div class="docstring">
|
|
609
|
+
<div class="discussion">
|
|
610
|
+
|
|
611
|
+
<p>Create a new reserved address.</p>
|
|
612
|
+
|
|
613
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-addrs-create">ngrok.com/docs/api#api-reserved-addrs-create</a></p>
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
</div>
|
|
617
|
+
</div>
|
|
618
|
+
<div class="tags">
|
|
619
|
+
<p class="tag_title">Parameters:</p>
|
|
620
|
+
<ul class="param">
|
|
621
|
+
|
|
622
|
+
<li>
|
|
623
|
+
|
|
624
|
+
<span class='name'>description</span>
|
|
625
|
+
|
|
626
|
+
|
|
627
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
628
|
+
|
|
629
|
+
|
|
630
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
631
|
+
|
|
632
|
+
|
|
633
|
+
—
|
|
634
|
+
<div class='inline'>
|
|
635
|
+
<p>human-readable description of what this reserved address will be used for</p>
|
|
636
|
+
</div>
|
|
637
|
+
|
|
638
|
+
</li>
|
|
639
|
+
|
|
640
|
+
<li>
|
|
641
|
+
|
|
642
|
+
<span class='name'>metadata</span>
|
|
643
|
+
|
|
644
|
+
|
|
645
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
646
|
+
|
|
647
|
+
|
|
648
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
649
|
+
|
|
650
|
+
|
|
651
|
+
—
|
|
652
|
+
<div class='inline'>
|
|
653
|
+
<p>arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.</p>
|
|
654
|
+
</div>
|
|
655
|
+
|
|
656
|
+
</li>
|
|
657
|
+
|
|
658
|
+
<li>
|
|
659
|
+
|
|
660
|
+
<span class='name'>region</span>
|
|
661
|
+
|
|
662
|
+
|
|
663
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
664
|
+
|
|
665
|
+
|
|
666
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
667
|
+
|
|
668
|
+
|
|
669
|
+
—
|
|
670
|
+
<div class='inline'>
|
|
671
|
+
<p>reserve the address in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)</p>
|
|
672
|
+
</div>
|
|
673
|
+
|
|
674
|
+
</li>
|
|
675
|
+
|
|
676
|
+
<li>
|
|
677
|
+
|
|
678
|
+
<span class='name'>endpoint_configuration_id</span>
|
|
679
|
+
|
|
680
|
+
|
|
681
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
685
|
+
|
|
686
|
+
|
|
687
|
+
—
|
|
688
|
+
<div class='inline'>
|
|
689
|
+
<p>ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address</p>
|
|
690
|
+
</div>
|
|
691
|
+
|
|
692
|
+
</li>
|
|
693
|
+
|
|
694
|
+
</ul>
|
|
695
|
+
|
|
696
|
+
<p class="tag_title">Returns:</p>
|
|
697
|
+
<ul class="return">
|
|
698
|
+
|
|
699
|
+
<li>
|
|
700
|
+
|
|
701
|
+
|
|
702
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">NgrokAPI::Models::ReservedAddr</a></span></tt>)</span>
|
|
703
|
+
|
|
704
|
+
|
|
705
|
+
|
|
706
|
+
—
|
|
707
|
+
<div class='inline'>
|
|
708
|
+
<p>result from the API request</p>
|
|
709
|
+
</div>
|
|
710
|
+
|
|
711
|
+
</li>
|
|
712
|
+
|
|
713
|
+
</ul>
|
|
714
|
+
|
|
715
|
+
</div><table class="source_code">
|
|
716
|
+
<tr>
|
|
717
|
+
<td>
|
|
718
|
+
<pre class="lines">
|
|
719
|
+
|
|
720
|
+
|
|
721
|
+
33
|
|
722
|
+
34
|
|
723
|
+
35
|
|
724
|
+
36
|
|
725
|
+
37
|
|
726
|
+
38
|
|
727
|
+
39
|
|
728
|
+
40
|
|
729
|
+
41
|
|
730
|
+
42
|
|
731
|
+
43
|
|
732
|
+
44</pre>
|
|
733
|
+
</td>
|
|
734
|
+
<td>
|
|
735
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 33</span>
|
|
736
|
+
|
|
737
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>region:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
738
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_addrs</span><span class='tstring_end'>'</span></span>
|
|
739
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
740
|
+
<span class='rbrace'>}</span>
|
|
741
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
742
|
+
<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>
|
|
743
|
+
<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>
|
|
744
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:region</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_region'>region</span> <span class='kw'>if</span> <span class='id identifier rubyid_region'>region</span>
|
|
745
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:endpoint_configuration_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_endpoint_configuration_id'>endpoint_configuration_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_endpoint_configuration_id'>endpoint_configuration_id</span>
|
|
746
|
+
<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>
|
|
747
|
+
<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/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">ReservedAddr</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedAddr.html#initialize-instance_method" title="NgrokAPI::Models::ReservedAddr#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>
|
|
748
|
+
<span class='kw'>end</span></pre>
|
|
749
|
+
</td>
|
|
750
|
+
</tr>
|
|
751
|
+
</table>
|
|
752
|
+
</div>
|
|
753
|
+
|
|
754
|
+
<div class="method_details ">
|
|
755
|
+
<h3 class="signature " id="delete-instance_method">
|
|
756
|
+
|
|
757
|
+
#<strong>delete</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
758
|
+
|
|
759
|
+
|
|
760
|
+
|
|
761
|
+
|
|
762
|
+
|
|
763
|
+
</h3><div class="docstring">
|
|
764
|
+
<div class="discussion">
|
|
765
|
+
|
|
766
|
+
<p>Delete a reserved address.</p>
|
|
767
|
+
|
|
768
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-addrs-delete">ngrok.com/docs/api#api-reserved-addrs-delete</a></p>
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
</div>
|
|
772
|
+
</div>
|
|
773
|
+
<div class="tags">
|
|
774
|
+
<p class="tag_title">Parameters:</p>
|
|
775
|
+
<ul class="param">
|
|
776
|
+
|
|
777
|
+
<li>
|
|
778
|
+
|
|
779
|
+
<span class='name'>id</span>
|
|
780
|
+
|
|
781
|
+
|
|
782
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
783
|
+
|
|
784
|
+
|
|
785
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
786
|
+
|
|
787
|
+
|
|
788
|
+
—
|
|
789
|
+
<div class='inline'>
|
|
790
|
+
<p>a resource identifier</p>
|
|
791
|
+
</div>
|
|
792
|
+
|
|
793
|
+
</li>
|
|
794
|
+
|
|
795
|
+
</ul>
|
|
796
|
+
|
|
797
|
+
<p class="tag_title">Returns:</p>
|
|
798
|
+
<ul class="return">
|
|
799
|
+
|
|
800
|
+
<li>
|
|
801
|
+
|
|
802
|
+
|
|
803
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
804
|
+
|
|
805
|
+
|
|
806
|
+
|
|
807
|
+
—
|
|
808
|
+
<div class='inline'>
|
|
809
|
+
<p>result from the API request</p>
|
|
810
|
+
</div>
|
|
811
|
+
|
|
812
|
+
</li>
|
|
813
|
+
|
|
814
|
+
</ul>
|
|
815
|
+
|
|
816
|
+
</div><table class="source_code">
|
|
817
|
+
<tr>
|
|
818
|
+
<td>
|
|
819
|
+
<pre class="lines">
|
|
820
|
+
|
|
821
|
+
|
|
822
|
+
53
|
|
823
|
+
54
|
|
824
|
+
55
|
|
825
|
+
56
|
|
826
|
+
57
|
|
827
|
+
58
|
|
828
|
+
59</pre>
|
|
829
|
+
</td>
|
|
830
|
+
<td>
|
|
831
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 53</span>
|
|
832
|
+
|
|
833
|
+
<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>
|
|
834
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_addrs/%{id}</span><span class='tstring_end'>'</span></span>
|
|
835
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
836
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
837
|
+
<span class='rbrace'>}</span>
|
|
838
|
+
<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>
|
|
839
|
+
<span class='kw'>end</span></pre>
|
|
840
|
+
</td>
|
|
841
|
+
</tr>
|
|
842
|
+
</table>
|
|
843
|
+
</div>
|
|
844
|
+
|
|
845
|
+
<div class="method_details ">
|
|
846
|
+
<h3 class="signature " id="delete!-instance_method">
|
|
847
|
+
|
|
848
|
+
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
849
|
+
|
|
850
|
+
|
|
851
|
+
|
|
852
|
+
|
|
853
|
+
|
|
854
|
+
</h3><div class="docstring">
|
|
855
|
+
<div class="discussion">
|
|
856
|
+
|
|
857
|
+
<p>Delete a reserved address. Throws an exception if API error.</p>
|
|
858
|
+
|
|
859
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-addrs-delete">ngrok.com/docs/api#api-reserved-addrs-delete</a></p>
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
</div>
|
|
863
|
+
</div>
|
|
864
|
+
<div class="tags">
|
|
865
|
+
<p class="tag_title">Parameters:</p>
|
|
866
|
+
<ul class="param">
|
|
867
|
+
|
|
868
|
+
<li>
|
|
869
|
+
|
|
870
|
+
<span class='name'>id</span>
|
|
871
|
+
|
|
872
|
+
|
|
873
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
874
|
+
|
|
875
|
+
|
|
876
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
877
|
+
|
|
878
|
+
|
|
879
|
+
—
|
|
880
|
+
<div class='inline'>
|
|
881
|
+
<p>a resource identifier</p>
|
|
882
|
+
</div>
|
|
883
|
+
|
|
884
|
+
</li>
|
|
885
|
+
|
|
886
|
+
</ul>
|
|
887
|
+
|
|
888
|
+
<p class="tag_title">Returns:</p>
|
|
889
|
+
<ul class="return">
|
|
890
|
+
|
|
891
|
+
<li>
|
|
892
|
+
|
|
893
|
+
|
|
894
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
895
|
+
|
|
896
|
+
|
|
897
|
+
|
|
898
|
+
—
|
|
899
|
+
<div class='inline'>
|
|
900
|
+
<p>result from the API request</p>
|
|
901
|
+
</div>
|
|
902
|
+
|
|
903
|
+
</li>
|
|
904
|
+
|
|
905
|
+
</ul>
|
|
906
|
+
|
|
907
|
+
</div><table class="source_code">
|
|
908
|
+
<tr>
|
|
909
|
+
<td>
|
|
910
|
+
<pre class="lines">
|
|
911
|
+
|
|
912
|
+
|
|
913
|
+
69
|
|
914
|
+
70
|
|
915
|
+
71
|
|
916
|
+
72
|
|
917
|
+
73
|
|
918
|
+
74
|
|
919
|
+
75</pre>
|
|
920
|
+
</td>
|
|
921
|
+
<td>
|
|
922
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 69</span>
|
|
923
|
+
|
|
924
|
+
<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>
|
|
925
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_addrs/%{id}</span><span class='tstring_end'>'</span></span>
|
|
926
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
927
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
928
|
+
<span class='rbrace'>}</span>
|
|
929
|
+
<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>
|
|
930
|
+
<span class='kw'>end</span></pre>
|
|
931
|
+
</td>
|
|
932
|
+
</tr>
|
|
933
|
+
</table>
|
|
934
|
+
</div>
|
|
935
|
+
|
|
936
|
+
<div class="method_details ">
|
|
937
|
+
<h3 class="signature " id="delete_endpoint_config-instance_method">
|
|
938
|
+
|
|
939
|
+
#<strong>delete_endpoint_config</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
940
|
+
|
|
941
|
+
|
|
942
|
+
|
|
943
|
+
|
|
944
|
+
|
|
945
|
+
</h3><div class="docstring">
|
|
946
|
+
<div class="discussion">
|
|
947
|
+
|
|
948
|
+
<p>Detach the endpoint configuration attached to a reserved address.</p>
|
|
949
|
+
|
|
950
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-addrs-delete-endpoint-config">ngrok.com/docs/api#api-reserved-addrs-delete-endpoint-config</a></p>
|
|
951
|
+
|
|
952
|
+
|
|
953
|
+
</div>
|
|
954
|
+
</div>
|
|
955
|
+
<div class="tags">
|
|
956
|
+
<p class="tag_title">Parameters:</p>
|
|
957
|
+
<ul class="param">
|
|
958
|
+
|
|
959
|
+
<li>
|
|
960
|
+
|
|
961
|
+
<span class='name'>id</span>
|
|
962
|
+
|
|
963
|
+
|
|
964
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
965
|
+
|
|
966
|
+
|
|
967
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
968
|
+
|
|
969
|
+
|
|
970
|
+
—
|
|
971
|
+
<div class='inline'>
|
|
972
|
+
<p>a resource identifier</p>
|
|
973
|
+
</div>
|
|
974
|
+
|
|
975
|
+
</li>
|
|
976
|
+
|
|
977
|
+
</ul>
|
|
978
|
+
|
|
979
|
+
<p class="tag_title">Returns:</p>
|
|
980
|
+
<ul class="return">
|
|
981
|
+
|
|
982
|
+
<li>
|
|
983
|
+
|
|
984
|
+
|
|
985
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
986
|
+
|
|
987
|
+
|
|
988
|
+
|
|
989
|
+
—
|
|
990
|
+
<div class='inline'>
|
|
991
|
+
<p>result from the API request</p>
|
|
992
|
+
</div>
|
|
993
|
+
|
|
994
|
+
</li>
|
|
995
|
+
|
|
996
|
+
</ul>
|
|
997
|
+
|
|
998
|
+
</div><table class="source_code">
|
|
999
|
+
<tr>
|
|
1000
|
+
<td>
|
|
1001
|
+
<pre class="lines">
|
|
1002
|
+
|
|
1003
|
+
|
|
1004
|
+
221
|
|
1005
|
+
222
|
|
1006
|
+
223
|
|
1007
|
+
224
|
|
1008
|
+
225
|
|
1009
|
+
226
|
|
1010
|
+
227</pre>
|
|
1011
|
+
</td>
|
|
1012
|
+
<td>
|
|
1013
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 221</span>
|
|
1014
|
+
|
|
1015
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_endpoint_config'>delete_endpoint_config</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>
|
|
1016
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_addrs/%{id}/endpoint_configuration</span><span class='tstring_end'>'</span></span>
|
|
1017
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1018
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1019
|
+
<span class='rbrace'>}</span>
|
|
1020
|
+
<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>
|
|
1021
|
+
<span class='kw'>end</span></pre>
|
|
1022
|
+
</td>
|
|
1023
|
+
</tr>
|
|
1024
|
+
</table>
|
|
1025
|
+
</div>
|
|
1026
|
+
|
|
1027
|
+
<div class="method_details ">
|
|
1028
|
+
<h3 class="signature " id="delete_endpoint_config!-instance_method">
|
|
1029
|
+
|
|
1030
|
+
#<strong>delete_endpoint_config!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
1031
|
+
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
|
|
1035
|
+
|
|
1036
|
+
</h3><div class="docstring">
|
|
1037
|
+
<div class="discussion">
|
|
1038
|
+
|
|
1039
|
+
<p>Detach the endpoint configuration attached to a reserved address. Throws an exception if API error.</p>
|
|
1040
|
+
|
|
1041
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-addrs-delete-endpoint-config">ngrok.com/docs/api#api-reserved-addrs-delete-endpoint-config</a></p>
|
|
1042
|
+
|
|
1043
|
+
|
|
1044
|
+
</div>
|
|
1045
|
+
</div>
|
|
1046
|
+
<div class="tags">
|
|
1047
|
+
<p class="tag_title">Parameters:</p>
|
|
1048
|
+
<ul class="param">
|
|
1049
|
+
|
|
1050
|
+
<li>
|
|
1051
|
+
|
|
1052
|
+
<span class='name'>id</span>
|
|
1053
|
+
|
|
1054
|
+
|
|
1055
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1056
|
+
|
|
1057
|
+
|
|
1058
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1059
|
+
|
|
1060
|
+
|
|
1061
|
+
—
|
|
1062
|
+
<div class='inline'>
|
|
1063
|
+
<p>a resource identifier</p>
|
|
1064
|
+
</div>
|
|
1065
|
+
|
|
1066
|
+
</li>
|
|
1067
|
+
|
|
1068
|
+
</ul>
|
|
1069
|
+
|
|
1070
|
+
<p class="tag_title">Returns:</p>
|
|
1071
|
+
<ul class="return">
|
|
1072
|
+
|
|
1073
|
+
<li>
|
|
1074
|
+
|
|
1075
|
+
|
|
1076
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
1077
|
+
|
|
1078
|
+
|
|
1079
|
+
|
|
1080
|
+
—
|
|
1081
|
+
<div class='inline'>
|
|
1082
|
+
<p>result from the API request</p>
|
|
1083
|
+
</div>
|
|
1084
|
+
|
|
1085
|
+
</li>
|
|
1086
|
+
|
|
1087
|
+
</ul>
|
|
1088
|
+
|
|
1089
|
+
</div><table class="source_code">
|
|
1090
|
+
<tr>
|
|
1091
|
+
<td>
|
|
1092
|
+
<pre class="lines">
|
|
1093
|
+
|
|
1094
|
+
|
|
1095
|
+
237
|
|
1096
|
+
238
|
|
1097
|
+
239
|
|
1098
|
+
240
|
|
1099
|
+
241
|
|
1100
|
+
242
|
|
1101
|
+
243</pre>
|
|
1102
|
+
</td>
|
|
1103
|
+
<td>
|
|
1104
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 237</span>
|
|
1105
|
+
|
|
1106
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_endpoint_config!'>delete_endpoint_config!</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>
|
|
1107
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_addrs/%{id}/endpoint_configuration</span><span class='tstring_end'>'</span></span>
|
|
1108
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1109
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1110
|
+
<span class='rbrace'>}</span>
|
|
1111
|
+
<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>
|
|
1112
|
+
<span class='kw'>end</span></pre>
|
|
1113
|
+
</td>
|
|
1114
|
+
</tr>
|
|
1115
|
+
</table>
|
|
1116
|
+
</div>
|
|
1117
|
+
|
|
1118
|
+
<div class="method_details ">
|
|
1119
|
+
<h3 class="signature " id="get-instance_method">
|
|
1120
|
+
|
|
1121
|
+
#<strong>get</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">NgrokAPI::Models::ReservedAddr</a></span></tt>
|
|
1122
|
+
|
|
1123
|
+
|
|
1124
|
+
|
|
1125
|
+
|
|
1126
|
+
|
|
1127
|
+
</h3><div class="docstring">
|
|
1128
|
+
<div class="discussion">
|
|
1129
|
+
|
|
1130
|
+
<p>Get the details of a reserved address.</p>
|
|
1131
|
+
|
|
1132
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-addrs-get">ngrok.com/docs/api#api-reserved-addrs-get</a></p>
|
|
1133
|
+
|
|
1134
|
+
|
|
1135
|
+
</div>
|
|
1136
|
+
</div>
|
|
1137
|
+
<div class="tags">
|
|
1138
|
+
<p class="tag_title">Parameters:</p>
|
|
1139
|
+
<ul class="param">
|
|
1140
|
+
|
|
1141
|
+
<li>
|
|
1142
|
+
|
|
1143
|
+
<span class='name'>id</span>
|
|
1144
|
+
|
|
1145
|
+
|
|
1146
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1147
|
+
|
|
1148
|
+
|
|
1149
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1150
|
+
|
|
1151
|
+
|
|
1152
|
+
—
|
|
1153
|
+
<div class='inline'>
|
|
1154
|
+
<p>a resource identifier</p>
|
|
1155
|
+
</div>
|
|
1156
|
+
|
|
1157
|
+
</li>
|
|
1158
|
+
|
|
1159
|
+
</ul>
|
|
1160
|
+
|
|
1161
|
+
<p class="tag_title">Returns:</p>
|
|
1162
|
+
<ul class="return">
|
|
1163
|
+
|
|
1164
|
+
<li>
|
|
1165
|
+
|
|
1166
|
+
|
|
1167
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">NgrokAPI::Models::ReservedAddr</a></span></tt>)</span>
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
|
|
1171
|
+
—
|
|
1172
|
+
<div class='inline'>
|
|
1173
|
+
<p>result from the API request</p>
|
|
1174
|
+
</div>
|
|
1175
|
+
|
|
1176
|
+
</li>
|
|
1177
|
+
|
|
1178
|
+
</ul>
|
|
1179
|
+
|
|
1180
|
+
</div><table class="source_code">
|
|
1181
|
+
<tr>
|
|
1182
|
+
<td>
|
|
1183
|
+
<pre class="lines">
|
|
1184
|
+
|
|
1185
|
+
|
|
1186
|
+
84
|
|
1187
|
+
85
|
|
1188
|
+
86
|
|
1189
|
+
87
|
|
1190
|
+
88
|
|
1191
|
+
89
|
|
1192
|
+
90
|
|
1193
|
+
91
|
|
1194
|
+
92</pre>
|
|
1195
|
+
</td>
|
|
1196
|
+
<td>
|
|
1197
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 84</span>
|
|
1198
|
+
|
|
1199
|
+
<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>
|
|
1200
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_addrs/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1201
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1202
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1203
|
+
<span class='rbrace'>}</span>
|
|
1204
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1205
|
+
<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>
|
|
1206
|
+
<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/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">ReservedAddr</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedAddr.html#initialize-instance_method" title="NgrokAPI::Models::ReservedAddr#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>
|
|
1207
|
+
<span class='kw'>end</span></pre>
|
|
1208
|
+
</td>
|
|
1209
|
+
</tr>
|
|
1210
|
+
</table>
|
|
1211
|
+
</div>
|
|
1212
|
+
|
|
1213
|
+
<div class="method_details ">
|
|
1214
|
+
<h3 class="signature " id="get!-instance_method">
|
|
1215
|
+
|
|
1216
|
+
#<strong>get!</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">NgrokAPI::Models::ReservedAddr</a></span></tt>
|
|
1217
|
+
|
|
1218
|
+
|
|
1219
|
+
|
|
1220
|
+
|
|
1221
|
+
|
|
1222
|
+
</h3><div class="docstring">
|
|
1223
|
+
<div class="discussion">
|
|
1224
|
+
|
|
1225
|
+
<p>Get the details of a reserved address. Throws an exception if API error.</p>
|
|
1226
|
+
|
|
1227
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-addrs-get">ngrok.com/docs/api#api-reserved-addrs-get</a></p>
|
|
1228
|
+
|
|
1229
|
+
|
|
1230
|
+
</div>
|
|
1231
|
+
</div>
|
|
1232
|
+
<div class="tags">
|
|
1233
|
+
<p class="tag_title">Parameters:</p>
|
|
1234
|
+
<ul class="param">
|
|
1235
|
+
|
|
1236
|
+
<li>
|
|
1237
|
+
|
|
1238
|
+
<span class='name'>id</span>
|
|
1239
|
+
|
|
1240
|
+
|
|
1241
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1242
|
+
|
|
1243
|
+
|
|
1244
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1245
|
+
|
|
1246
|
+
|
|
1247
|
+
—
|
|
1248
|
+
<div class='inline'>
|
|
1249
|
+
<p>a resource identifier</p>
|
|
1250
|
+
</div>
|
|
1251
|
+
|
|
1252
|
+
</li>
|
|
1253
|
+
|
|
1254
|
+
</ul>
|
|
1255
|
+
|
|
1256
|
+
<p class="tag_title">Returns:</p>
|
|
1257
|
+
<ul class="return">
|
|
1258
|
+
|
|
1259
|
+
<li>
|
|
1260
|
+
|
|
1261
|
+
|
|
1262
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">NgrokAPI::Models::ReservedAddr</a></span></tt>)</span>
|
|
1263
|
+
|
|
1264
|
+
|
|
1265
|
+
|
|
1266
|
+
—
|
|
1267
|
+
<div class='inline'>
|
|
1268
|
+
<p>result from the API request</p>
|
|
1269
|
+
</div>
|
|
1270
|
+
|
|
1271
|
+
</li>
|
|
1272
|
+
|
|
1273
|
+
</ul>
|
|
1274
|
+
|
|
1275
|
+
</div><table class="source_code">
|
|
1276
|
+
<tr>
|
|
1277
|
+
<td>
|
|
1278
|
+
<pre class="lines">
|
|
1279
|
+
|
|
1280
|
+
|
|
1281
|
+
102
|
|
1282
|
+
103
|
|
1283
|
+
104
|
|
1284
|
+
105
|
|
1285
|
+
106
|
|
1286
|
+
107
|
|
1287
|
+
108
|
|
1288
|
+
109
|
|
1289
|
+
110</pre>
|
|
1290
|
+
</td>
|
|
1291
|
+
<td>
|
|
1292
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 102</span>
|
|
1293
|
+
|
|
1294
|
+
<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>
|
|
1295
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_addrs/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1296
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1297
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1298
|
+
<span class='rbrace'>}</span>
|
|
1299
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1300
|
+
<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>
|
|
1301
|
+
<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/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">ReservedAddr</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedAddr.html#initialize-instance_method" title="NgrokAPI::Models::ReservedAddr#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>
|
|
1302
|
+
<span class='kw'>end</span></pre>
|
|
1303
|
+
</td>
|
|
1304
|
+
</tr>
|
|
1305
|
+
</table>
|
|
1306
|
+
</div>
|
|
1307
|
+
|
|
1308
|
+
<div class="method_details ">
|
|
1309
|
+
<h3 class="signature " id="list-instance_method">
|
|
1310
|
+
|
|
1311
|
+
#<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>
|
|
1312
|
+
|
|
1313
|
+
|
|
1314
|
+
|
|
1315
|
+
|
|
1316
|
+
|
|
1317
|
+
</h3><div class="docstring">
|
|
1318
|
+
<div class="discussion">
|
|
1319
|
+
|
|
1320
|
+
<p>List all reserved addresses on this account.</p>
|
|
1321
|
+
|
|
1322
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-addrs-list">ngrok.com/docs/api#api-reserved-addrs-list</a></p>
|
|
1323
|
+
|
|
1324
|
+
|
|
1325
|
+
</div>
|
|
1326
|
+
</div>
|
|
1327
|
+
<div class="tags">
|
|
1328
|
+
<p class="tag_title">Parameters:</p>
|
|
1329
|
+
<ul class="param">
|
|
1330
|
+
|
|
1331
|
+
<li>
|
|
1332
|
+
|
|
1333
|
+
<span class='name'>before_id</span>
|
|
1334
|
+
|
|
1335
|
+
|
|
1336
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1337
|
+
|
|
1338
|
+
|
|
1339
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1340
|
+
|
|
1341
|
+
|
|
1342
|
+
</li>
|
|
1343
|
+
|
|
1344
|
+
<li>
|
|
1345
|
+
|
|
1346
|
+
<span class='name'>limit</span>
|
|
1347
|
+
|
|
1348
|
+
|
|
1349
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1350
|
+
|
|
1351
|
+
|
|
1352
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1353
|
+
|
|
1354
|
+
|
|
1355
|
+
</li>
|
|
1356
|
+
|
|
1357
|
+
<li>
|
|
1358
|
+
|
|
1359
|
+
<span class='name'>url</span>
|
|
1360
|
+
|
|
1361
|
+
|
|
1362
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1363
|
+
|
|
1364
|
+
|
|
1365
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1366
|
+
|
|
1367
|
+
|
|
1368
|
+
—
|
|
1369
|
+
<div class='inline'>
|
|
1370
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
1371
|
+
</div>
|
|
1372
|
+
|
|
1373
|
+
</li>
|
|
1374
|
+
|
|
1375
|
+
</ul>
|
|
1376
|
+
|
|
1377
|
+
<p class="tag_title">Returns:</p>
|
|
1378
|
+
<ul class="return">
|
|
1379
|
+
|
|
1380
|
+
<li>
|
|
1381
|
+
|
|
1382
|
+
|
|
1383
|
+
<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>
|
|
1384
|
+
|
|
1385
|
+
|
|
1386
|
+
|
|
1387
|
+
—
|
|
1388
|
+
<div class='inline'>
|
|
1389
|
+
<p>result from the API request</p>
|
|
1390
|
+
</div>
|
|
1391
|
+
|
|
1392
|
+
</li>
|
|
1393
|
+
|
|
1394
|
+
</ul>
|
|
1395
|
+
|
|
1396
|
+
</div><table class="source_code">
|
|
1397
|
+
<tr>
|
|
1398
|
+
<td>
|
|
1399
|
+
<pre class="lines">
|
|
1400
|
+
|
|
1401
|
+
|
|
1402
|
+
121
|
|
1403
|
+
122
|
|
1404
|
+
123
|
|
1405
|
+
124
|
|
1406
|
+
125
|
|
1407
|
+
126
|
|
1408
|
+
127
|
|
1409
|
+
128
|
|
1410
|
+
129
|
|
1411
|
+
130
|
|
1412
|
+
131
|
|
1413
|
+
132
|
|
1414
|
+
133
|
|
1415
|
+
134
|
|
1416
|
+
135
|
|
1417
|
+
136</pre>
|
|
1418
|
+
</td>
|
|
1419
|
+
<td>
|
|
1420
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 121</span>
|
|
1421
|
+
|
|
1422
|
+
<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>
|
|
1423
|
+
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1424
|
+
<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>
|
|
1425
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1426
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1427
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1428
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedAddrsClient::PATH (constant)">PATH</a></span></span>
|
|
1429
|
+
<span class='rparen'>)</span>
|
|
1430
|
+
|
|
1431
|
+
<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>
|
|
1432
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1433
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1434
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::ReservedAddrsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1435
|
+
<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/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">ReservedAddr</a></span></span>
|
|
1436
|
+
<span class='rparen'>)</span>
|
|
1437
|
+
<span class='kw'>end</span></pre>
|
|
1438
|
+
</td>
|
|
1439
|
+
</tr>
|
|
1440
|
+
</table>
|
|
1441
|
+
</div>
|
|
1442
|
+
|
|
1443
|
+
<div class="method_details ">
|
|
1444
|
+
<h3 class="signature " id="list!-instance_method">
|
|
1445
|
+
|
|
1446
|
+
#<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>
|
|
1447
|
+
|
|
1448
|
+
|
|
1449
|
+
|
|
1450
|
+
|
|
1451
|
+
|
|
1452
|
+
</h3><div class="docstring">
|
|
1453
|
+
<div class="discussion">
|
|
1454
|
+
|
|
1455
|
+
<p>List all reserved addresses on this account. Throws an exception if API error.</p>
|
|
1456
|
+
|
|
1457
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-addrs-list">ngrok.com/docs/api#api-reserved-addrs-list</a></p>
|
|
1458
|
+
|
|
1459
|
+
|
|
1460
|
+
</div>
|
|
1461
|
+
</div>
|
|
1462
|
+
<div class="tags">
|
|
1463
|
+
<p class="tag_title">Parameters:</p>
|
|
1464
|
+
<ul class="param">
|
|
1465
|
+
|
|
1466
|
+
<li>
|
|
1467
|
+
|
|
1468
|
+
<span class='name'>before_id</span>
|
|
1469
|
+
|
|
1470
|
+
|
|
1471
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1472
|
+
|
|
1473
|
+
|
|
1474
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1475
|
+
|
|
1476
|
+
|
|
1477
|
+
</li>
|
|
1478
|
+
|
|
1479
|
+
<li>
|
|
1480
|
+
|
|
1481
|
+
<span class='name'>limit</span>
|
|
1482
|
+
|
|
1483
|
+
|
|
1484
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1485
|
+
|
|
1486
|
+
|
|
1487
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1488
|
+
|
|
1489
|
+
|
|
1490
|
+
</li>
|
|
1491
|
+
|
|
1492
|
+
<li>
|
|
1493
|
+
|
|
1494
|
+
<span class='name'>url</span>
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1498
|
+
|
|
1499
|
+
|
|
1500
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1501
|
+
|
|
1502
|
+
|
|
1503
|
+
—
|
|
1504
|
+
<div class='inline'>
|
|
1505
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
1506
|
+
</div>
|
|
1507
|
+
|
|
1508
|
+
</li>
|
|
1509
|
+
|
|
1510
|
+
</ul>
|
|
1511
|
+
|
|
1512
|
+
<p class="tag_title">Returns:</p>
|
|
1513
|
+
<ul class="return">
|
|
1514
|
+
|
|
1515
|
+
<li>
|
|
1516
|
+
|
|
1517
|
+
|
|
1518
|
+
<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>
|
|
1519
|
+
|
|
1520
|
+
|
|
1521
|
+
|
|
1522
|
+
—
|
|
1523
|
+
<div class='inline'>
|
|
1524
|
+
<p>result from the API request</p>
|
|
1525
|
+
</div>
|
|
1526
|
+
|
|
1527
|
+
</li>
|
|
1528
|
+
|
|
1529
|
+
</ul>
|
|
1530
|
+
|
|
1531
|
+
</div><table class="source_code">
|
|
1532
|
+
<tr>
|
|
1533
|
+
<td>
|
|
1534
|
+
<pre class="lines">
|
|
1535
|
+
|
|
1536
|
+
|
|
1537
|
+
148
|
|
1538
|
+
149
|
|
1539
|
+
150
|
|
1540
|
+
151
|
|
1541
|
+
152
|
|
1542
|
+
153
|
|
1543
|
+
154
|
|
1544
|
+
155
|
|
1545
|
+
156
|
|
1546
|
+
157
|
|
1547
|
+
158
|
|
1548
|
+
159
|
|
1549
|
+
160
|
|
1550
|
+
161
|
|
1551
|
+
162
|
|
1552
|
+
163
|
|
1553
|
+
164
|
|
1554
|
+
165</pre>
|
|
1555
|
+
</td>
|
|
1556
|
+
<td>
|
|
1557
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 148</span>
|
|
1558
|
+
|
|
1559
|
+
<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>
|
|
1560
|
+
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1561
|
+
<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>
|
|
1562
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1563
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1564
|
+
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
|
1565
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1566
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::ReservedAddrsClient::PATH (constant)">PATH</a></span></span>
|
|
1567
|
+
<span class='rparen'>)</span>
|
|
1568
|
+
|
|
1569
|
+
<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>
|
|
1570
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1571
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1572
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::ReservedAddrsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1573
|
+
<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/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">ReservedAddr</a></span></span><span class='comma'>,</span>
|
|
1574
|
+
<span class='label'>danger:</span> <span class='kw'>true</span>
|
|
1575
|
+
<span class='rparen'>)</span>
|
|
1576
|
+
<span class='kw'>end</span></pre>
|
|
1577
|
+
</td>
|
|
1578
|
+
</tr>
|
|
1579
|
+
</table>
|
|
1580
|
+
</div>
|
|
1581
|
+
|
|
1582
|
+
<div class="method_details ">
|
|
1583
|
+
<h3 class="signature " id="update-instance_method">
|
|
1584
|
+
|
|
1585
|
+
#<strong>update</strong>(id: "", description: nil, metadata: nil, endpoint_configuration_id: nil) ⇒ <tt><span class='object_link'><a href="../Models/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">NgrokAPI::Models::ReservedAddr</a></span></tt>
|
|
1586
|
+
|
|
1587
|
+
|
|
1588
|
+
|
|
1589
|
+
|
|
1590
|
+
|
|
1591
|
+
</h3><div class="docstring">
|
|
1592
|
+
<div class="discussion">
|
|
1593
|
+
|
|
1594
|
+
<p>Update the attributes of a reserved address.</p>
|
|
1595
|
+
|
|
1596
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-addrs-update">ngrok.com/docs/api#api-reserved-addrs-update</a></p>
|
|
1597
|
+
|
|
1598
|
+
|
|
1599
|
+
</div>
|
|
1600
|
+
</div>
|
|
1601
|
+
<div class="tags">
|
|
1602
|
+
<p class="tag_title">Parameters:</p>
|
|
1603
|
+
<ul class="param">
|
|
1604
|
+
|
|
1605
|
+
<li>
|
|
1606
|
+
|
|
1607
|
+
<span class='name'>id</span>
|
|
1608
|
+
|
|
1609
|
+
|
|
1610
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1611
|
+
|
|
1612
|
+
|
|
1613
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1614
|
+
|
|
1615
|
+
|
|
1616
|
+
</li>
|
|
1617
|
+
|
|
1618
|
+
<li>
|
|
1619
|
+
|
|
1620
|
+
<span class='name'>description</span>
|
|
1621
|
+
|
|
1622
|
+
|
|
1623
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1624
|
+
|
|
1625
|
+
|
|
1626
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1627
|
+
|
|
1628
|
+
|
|
1629
|
+
—
|
|
1630
|
+
<div class='inline'>
|
|
1631
|
+
<p>human-readable description of what this reserved address will be used for</p>
|
|
1632
|
+
</div>
|
|
1633
|
+
|
|
1634
|
+
</li>
|
|
1635
|
+
|
|
1636
|
+
<li>
|
|
1637
|
+
|
|
1638
|
+
<span class='name'>metadata</span>
|
|
1639
|
+
|
|
1640
|
+
|
|
1641
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1642
|
+
|
|
1643
|
+
|
|
1644
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1645
|
+
|
|
1646
|
+
|
|
1647
|
+
—
|
|
1648
|
+
<div class='inline'>
|
|
1649
|
+
<p>arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.</p>
|
|
1650
|
+
</div>
|
|
1651
|
+
|
|
1652
|
+
</li>
|
|
1653
|
+
|
|
1654
|
+
<li>
|
|
1655
|
+
|
|
1656
|
+
<span class='name'>endpoint_configuration_id</span>
|
|
1657
|
+
|
|
1658
|
+
|
|
1659
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1660
|
+
|
|
1661
|
+
|
|
1662
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1663
|
+
|
|
1664
|
+
|
|
1665
|
+
—
|
|
1666
|
+
<div class='inline'>
|
|
1667
|
+
<p>ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address</p>
|
|
1668
|
+
</div>
|
|
1669
|
+
|
|
1670
|
+
</li>
|
|
1671
|
+
|
|
1672
|
+
</ul>
|
|
1673
|
+
|
|
1674
|
+
<p class="tag_title">Returns:</p>
|
|
1675
|
+
<ul class="return">
|
|
1676
|
+
|
|
1677
|
+
<li>
|
|
1678
|
+
|
|
1679
|
+
|
|
1680
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">NgrokAPI::Models::ReservedAddr</a></span></tt>)</span>
|
|
1681
|
+
|
|
1682
|
+
|
|
1683
|
+
|
|
1684
|
+
—
|
|
1685
|
+
<div class='inline'>
|
|
1686
|
+
<p>result from the API request</p>
|
|
1687
|
+
</div>
|
|
1688
|
+
|
|
1689
|
+
</li>
|
|
1690
|
+
|
|
1691
|
+
</ul>
|
|
1692
|
+
|
|
1693
|
+
</div><table class="source_code">
|
|
1694
|
+
<tr>
|
|
1695
|
+
<td>
|
|
1696
|
+
<pre class="lines">
|
|
1697
|
+
|
|
1698
|
+
|
|
1699
|
+
177
|
|
1700
|
+
178
|
|
1701
|
+
179
|
|
1702
|
+
180
|
|
1703
|
+
181
|
|
1704
|
+
182
|
|
1705
|
+
183
|
|
1706
|
+
184
|
|
1707
|
+
185
|
|
1708
|
+
186
|
|
1709
|
+
187
|
|
1710
|
+
188</pre>
|
|
1711
|
+
</td>
|
|
1712
|
+
<td>
|
|
1713
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 177</span>
|
|
1714
|
+
|
|
1715
|
+
<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='comma'>,</span> <span class='label'>endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1716
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_addrs/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1717
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1718
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1719
|
+
<span class='rbrace'>}</span>
|
|
1720
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1721
|
+
<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>
|
|
1722
|
+
<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>
|
|
1723
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:endpoint_configuration_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_endpoint_configuration_id'>endpoint_configuration_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_endpoint_configuration_id'>endpoint_configuration_id</span>
|
|
1724
|
+
<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>
|
|
1725
|
+
<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/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">ReservedAddr</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedAddr.html#initialize-instance_method" title="NgrokAPI::Models::ReservedAddr#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>
|
|
1726
|
+
<span class='kw'>end</span></pre>
|
|
1727
|
+
</td>
|
|
1728
|
+
</tr>
|
|
1729
|
+
</table>
|
|
1730
|
+
</div>
|
|
1731
|
+
|
|
1732
|
+
<div class="method_details ">
|
|
1733
|
+
<h3 class="signature " id="update!-instance_method">
|
|
1734
|
+
|
|
1735
|
+
#<strong>update!</strong>(id: "", description: nil, metadata: nil, endpoint_configuration_id: nil) ⇒ <tt><span class='object_link'><a href="../Models/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">NgrokAPI::Models::ReservedAddr</a></span></tt>
|
|
1736
|
+
|
|
1737
|
+
|
|
1738
|
+
|
|
1739
|
+
|
|
1740
|
+
|
|
1741
|
+
</h3><div class="docstring">
|
|
1742
|
+
<div class="discussion">
|
|
1743
|
+
|
|
1744
|
+
<p>Update the attributes of a reserved address. Throws an exception if API error.</p>
|
|
1745
|
+
|
|
1746
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-addrs-update">ngrok.com/docs/api#api-reserved-addrs-update</a></p>
|
|
1747
|
+
|
|
1748
|
+
|
|
1749
|
+
</div>
|
|
1750
|
+
</div>
|
|
1751
|
+
<div class="tags">
|
|
1752
|
+
<p class="tag_title">Parameters:</p>
|
|
1753
|
+
<ul class="param">
|
|
1754
|
+
|
|
1755
|
+
<li>
|
|
1756
|
+
|
|
1757
|
+
<span class='name'>id</span>
|
|
1758
|
+
|
|
1759
|
+
|
|
1760
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1761
|
+
|
|
1762
|
+
|
|
1763
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1764
|
+
|
|
1765
|
+
|
|
1766
|
+
</li>
|
|
1767
|
+
|
|
1768
|
+
<li>
|
|
1769
|
+
|
|
1770
|
+
<span class='name'>description</span>
|
|
1771
|
+
|
|
1772
|
+
|
|
1773
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1774
|
+
|
|
1775
|
+
|
|
1776
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1777
|
+
|
|
1778
|
+
|
|
1779
|
+
—
|
|
1780
|
+
<div class='inline'>
|
|
1781
|
+
<p>human-readable description of what this reserved address will be used for</p>
|
|
1782
|
+
</div>
|
|
1783
|
+
|
|
1784
|
+
</li>
|
|
1785
|
+
|
|
1786
|
+
<li>
|
|
1787
|
+
|
|
1788
|
+
<span class='name'>metadata</span>
|
|
1789
|
+
|
|
1790
|
+
|
|
1791
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1792
|
+
|
|
1793
|
+
|
|
1794
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1795
|
+
|
|
1796
|
+
|
|
1797
|
+
—
|
|
1798
|
+
<div class='inline'>
|
|
1799
|
+
<p>arbitrary user-defined machine-readable data of this reserved address. Optional, max 4096 bytes.</p>
|
|
1800
|
+
</div>
|
|
1801
|
+
|
|
1802
|
+
</li>
|
|
1803
|
+
|
|
1804
|
+
<li>
|
|
1805
|
+
|
|
1806
|
+
<span class='name'>endpoint_configuration_id</span>
|
|
1807
|
+
|
|
1808
|
+
|
|
1809
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1810
|
+
|
|
1811
|
+
|
|
1812
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1813
|
+
|
|
1814
|
+
|
|
1815
|
+
—
|
|
1816
|
+
<div class='inline'>
|
|
1817
|
+
<p>ID of an endpoint configuration of type tcp that will be used to handle inbound traffic to this address</p>
|
|
1818
|
+
</div>
|
|
1819
|
+
|
|
1820
|
+
</li>
|
|
1821
|
+
|
|
1822
|
+
</ul>
|
|
1823
|
+
|
|
1824
|
+
<p class="tag_title">Returns:</p>
|
|
1825
|
+
<ul class="return">
|
|
1826
|
+
|
|
1827
|
+
<li>
|
|
1828
|
+
|
|
1829
|
+
|
|
1830
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">NgrokAPI::Models::ReservedAddr</a></span></tt>)</span>
|
|
1831
|
+
|
|
1832
|
+
|
|
1833
|
+
|
|
1834
|
+
—
|
|
1835
|
+
<div class='inline'>
|
|
1836
|
+
<p>result from the API request</p>
|
|
1837
|
+
</div>
|
|
1838
|
+
|
|
1839
|
+
</li>
|
|
1840
|
+
|
|
1841
|
+
</ul>
|
|
1842
|
+
|
|
1843
|
+
</div><table class="source_code">
|
|
1844
|
+
<tr>
|
|
1845
|
+
<td>
|
|
1846
|
+
<pre class="lines">
|
|
1847
|
+
|
|
1848
|
+
|
|
1849
|
+
201
|
|
1850
|
+
202
|
|
1851
|
+
203
|
|
1852
|
+
204
|
|
1853
|
+
205
|
|
1854
|
+
206
|
|
1855
|
+
207
|
|
1856
|
+
208
|
|
1857
|
+
209
|
|
1858
|
+
210
|
|
1859
|
+
211
|
|
1860
|
+
212</pre>
|
|
1861
|
+
</td>
|
|
1862
|
+
<td>
|
|
1863
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_addrs_client.rb', line 201</span>
|
|
1864
|
+
|
|
1865
|
+
<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='comma'>,</span> <span class='label'>endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1866
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/reserved_addrs/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1867
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1868
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1869
|
+
<span class='rbrace'>}</span>
|
|
1870
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1871
|
+
<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>
|
|
1872
|
+
<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>
|
|
1873
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:endpoint_configuration_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_endpoint_configuration_id'>endpoint_configuration_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_endpoint_configuration_id'>endpoint_configuration_id</span>
|
|
1874
|
+
<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>
|
|
1875
|
+
<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/ReservedAddr.html" title="NgrokAPI::Models::ReservedAddr (class)">ReservedAddr</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedAddr.html#initialize-instance_method" title="NgrokAPI::Models::ReservedAddr#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>
|
|
1876
|
+
<span class='kw'>end</span></pre>
|
|
1877
|
+
</td>
|
|
1878
|
+
</tr>
|
|
1879
|
+
</table>
|
|
1880
|
+
</div>
|
|
1881
|
+
|
|
1882
|
+
</div>
|
|
1883
|
+
|
|
1884
|
+
</div>
|
|
1885
|
+
|
|
1886
|
+
<div id="footer">
|
|
1887
|
+
Generated on Thu Dec 2 18:48:54 2021 by
|
|
1888
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1889
|
+
0.9.27 (ruby-3.0.1).
|
|
1890
|
+
</div>
|
|
1891
|
+
|
|
1892
|
+
</div>
|
|
1893
|
+
</body>
|
|
1894
|
+
</html>
|