ngrok-api 0.16.0 → 0.19.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +28 -1
- data/doc/NgrokAPI/Client.html +270 -180
- data/doc/NgrokAPI/Error.html +2 -2
- data/doc/NgrokAPI/Errors/NotFoundError.html +2 -2
- data/doc/NgrokAPI/Errors.html +2 -2
- data/doc/NgrokAPI/HttpClient.html +147 -4
- data/doc/NgrokAPI/Models/APIKey.html +120 -68
- data/doc/NgrokAPI/Models/AWSAuth.html +83 -31
- data/doc/NgrokAPI/Models/AWSCredentials.html +90 -38
- data/doc/NgrokAPI/Models/AWSRole.html +75 -23
- data/doc/NgrokAPI/Models/AbuseReport.html +109 -57
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +83 -31
- data/doc/NgrokAPI/Models/AgentIngress.html +142 -90
- data/doc/NgrokAPI/Models/CertificateAuthority.html +149 -97
- data/doc/NgrokAPI/Models/Credential.html +121 -69
- data/doc/NgrokAPI/Models/Endpoint.html +1483 -0
- data/doc/NgrokAPI/Models/{EndpointLoggingMutate.html → EndpointBackend.html} +105 -53
- data/doc/NgrokAPI/Models/EndpointBackendMutate.html +669 -0
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +101 -49
- data/doc/NgrokAPI/Models/EndpointCompression.html +82 -30
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +90 -38
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +90 -38
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +90 -38
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +90 -38
- data/doc/NgrokAPI/Models/EndpointOAuth.html +124 -72
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +107 -55
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +116 -64
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +107 -55
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +107 -55
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +106 -54
- data/doc/NgrokAPI/Models/EndpointOIDC.html +133 -81
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +91 -39
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +91 -39
- data/doc/NgrokAPI/Models/EndpointSAML.html +148 -96
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +133 -81
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +91 -39
- data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +669 -0
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +91 -39
- data/{docs/NgrokAPI/Models/EndpointLogging.html → doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html} +95 -117
- data/doc/NgrokAPI/Models/EventDestination.html +122 -70
- data/doc/NgrokAPI/Models/EventSource.html +92 -40
- data/doc/NgrokAPI/Models/EventSourceList.html +76 -24
- data/doc/NgrokAPI/Models/EventSourceReplace.html +91 -39
- data/doc/NgrokAPI/Models/EventSubscription.html +122 -70
- data/doc/NgrokAPI/Models/EventTarget.html +106 -54
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +90 -38
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +90 -38
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +83 -31
- data/doc/NgrokAPI/Models/FailoverBackend.html +1127 -0
- data/{docs/NgrokAPI/Models/EventStream.html → doc/NgrokAPI/Models/HTTPResponseBackend.html} +170 -196
- data/doc/NgrokAPI/Models/HTTPSEdge.html +1361 -0
- data/doc/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +278 -288
- data/doc/NgrokAPI/Models/IPPolicy.html +120 -68
- data/doc/NgrokAPI/Models/IPPolicyRule.html +222 -96
- data/doc/NgrokAPI/Models/IPRestriction.html +130 -78
- data/doc/NgrokAPI/Models/Listable.html +61 -61
- data/doc/NgrokAPI/Models/Ref.html +83 -31
- data/doc/NgrokAPI/Models/ReservedAddr.html +130 -78
- data/doc/NgrokAPI/Models/ReservedDomain.html +151 -99
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +92 -40
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +90 -38
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +90 -38
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +135 -83
- data/doc/NgrokAPI/Models/SSHCredential.html +128 -76
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +148 -96
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +154 -102
- data/doc/NgrokAPI/Models/TCPEdge.html +1287 -0
- data/doc/NgrokAPI/Models/TLSCertificate.html +165 -113
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +90 -38
- data/doc/NgrokAPI/Models/TLSEdge.html +1447 -0
- data/doc/NgrokAPI/Models/Tunnel.html +413 -65
- data/doc/NgrokAPI/Models/TunnelGroupBackend.html +1201 -0
- data/doc/NgrokAPI/Models/TunnelSession.html +126 -74
- data/doc/NgrokAPI/Models/WeightedBackend.html +1127 -0
- data/doc/NgrokAPI/Models.html +4 -4
- data/doc/NgrokAPI/PagedIterator.html +3 -3
- data/doc/NgrokAPI/Services/APIKeysClient.html +244 -109
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +162 -25
- data/doc/NgrokAPI/Services/AgentIngressesClient.html +262 -109
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +262 -109
- data/doc/NgrokAPI/Services/CredentialsClient.html +266 -111
- data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1149 -0
- data/doc/NgrokAPI/Services/{EndpointCircuitBreakerModuleClient.html → EdgeRouteCircuitBreakerModuleClient.html} +205 -99
- data/{docs/NgrokAPI/Services/EndpointCompressionModuleClient.html → doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html} +205 -99
- data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +1149 -0
- data/doc/NgrokAPI/Services/{EndpointOAuthModuleClient.html → EdgeRouteOAuthModuleClient.html} +205 -99
- data/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +1149 -0
- data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1149 -0
- data/doc/NgrokAPI/Services/{EndpointResponseHeadersModuleClient.html → EdgeRouteResponseHeadersModuleClient.html} +205 -99
- data/{docs/NgrokAPI/Services/EndpointSAMLModuleClient.html → doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html} +205 -99
- data/{docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html → doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html} +205 -99
- data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1149 -0
- data/doc/NgrokAPI/Services/EdgesHTTPSClient.html +1947 -0
- data/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +2585 -0
- data/doc/NgrokAPI/Services/EdgesTCPClient.html +1947 -0
- data/{docs/NgrokAPI/Services/EndpointConfigurationsClient.html → doc/NgrokAPI/Services/EdgesTLSClient.html} +374 -641
- data/doc/NgrokAPI/Services/EndpointsClient.html +903 -0
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +290 -115
- data/doc/NgrokAPI/Services/EventSourcesClient.html +227 -88
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +291 -116
- data/doc/NgrokAPI/Services/{EventStreamsClient.html → FailoverBackendsClient.html} +342 -335
- data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +1937 -0
- data/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +1039 -0
- data/{docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html → doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html} +76 -80
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +245 -128
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +328 -117
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +305 -114
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +160 -295
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +257 -624
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +304 -109
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +284 -111
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +340 -109
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +381 -110
- data/{docs/NgrokAPI/Services/EndpointLoggingModuleClient.html → doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html} +76 -80
- data/doc/NgrokAPI/Services/{EndpointIPPolicyModuleClient.html → TCPEdgeIPRestrictionModuleClient.html} +62 -66
- data/doc/NgrokAPI/Services/TLSCertificatesClient.html +280 -109
- data/doc/NgrokAPI/Services/{EndpointLoggingModuleClient.html → TLSEdgeBackendModuleClient.html} +76 -80
- data/{docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html → doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html} +62 -66
- data/doc/NgrokAPI/Services/{EndpointMutualTLSModuleClient.html → TLSEdgeMutualTLSModuleClient.html} +62 -66
- data/doc/NgrokAPI/Services/{EndpointTLSTerminationModuleClient.html → TLSEdgeTLSTerminationModuleClient.html} +62 -66
- data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +1799 -0
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +44 -48
- data/doc/NgrokAPI/Services/TunnelsClient.html +249 -15
- data/doc/NgrokAPI/Services/WeightedBackendsClient.html +1799 -0
- data/doc/NgrokAPI/Services.html +4 -4
- data/doc/NgrokAPI.html +3 -3
- data/doc/_index.html +237 -60
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +55 -55
- data/doc/index.html +55 -55
- data/doc/method_list.html +4555 -1843
- data/doc/top-level-namespace.html +2 -2
- data/docs/NgrokAPI/Client.html +270 -180
- data/docs/NgrokAPI/Error.html +2 -2
- data/docs/NgrokAPI/Errors/NotFoundError.html +2 -2
- data/docs/NgrokAPI/Errors.html +2 -2
- data/docs/NgrokAPI/HttpClient.html +147 -4
- data/docs/NgrokAPI/Models/APIKey.html +120 -68
- data/docs/NgrokAPI/Models/AWSAuth.html +83 -31
- data/docs/NgrokAPI/Models/AWSCredentials.html +90 -38
- data/docs/NgrokAPI/Models/AWSRole.html +75 -23
- data/docs/NgrokAPI/Models/AbuseReport.html +109 -57
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +83 -31
- data/docs/NgrokAPI/Models/AgentIngress.html +142 -90
- data/docs/NgrokAPI/Models/CertificateAuthority.html +149 -97
- data/docs/NgrokAPI/Models/Credential.html +121 -69
- data/docs/NgrokAPI/Models/Endpoint.html +1483 -0
- data/docs/NgrokAPI/Models/{EndpointLoggingMutate.html → EndpointBackend.html} +105 -53
- data/docs/NgrokAPI/Models/EndpointBackendMutate.html +669 -0
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +101 -49
- data/docs/NgrokAPI/Models/EndpointCompression.html +82 -30
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +90 -38
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +90 -38
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +90 -38
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +90 -38
- data/docs/NgrokAPI/Models/EndpointOAuth.html +124 -72
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +107 -55
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +116 -64
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +107 -55
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +107 -55
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +106 -54
- data/docs/NgrokAPI/Models/EndpointOIDC.html +133 -81
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +91 -39
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +91 -39
- data/docs/NgrokAPI/Models/EndpointSAML.html +148 -96
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +133 -81
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +91 -39
- data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +669 -0
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +91 -39
- data/{doc/NgrokAPI/Models/EndpointLogging.html → docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html} +95 -117
- data/docs/NgrokAPI/Models/EventDestination.html +122 -70
- data/docs/NgrokAPI/Models/EventSource.html +92 -40
- data/docs/NgrokAPI/Models/EventSourceList.html +76 -24
- data/docs/NgrokAPI/Models/EventSourceReplace.html +91 -39
- data/docs/NgrokAPI/Models/EventSubscription.html +122 -70
- data/docs/NgrokAPI/Models/EventTarget.html +106 -54
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +90 -38
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +90 -38
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +83 -31
- data/docs/NgrokAPI/Models/FailoverBackend.html +1127 -0
- data/{doc/NgrokAPI/Models/EventStream.html → docs/NgrokAPI/Models/HTTPResponseBackend.html} +170 -196
- data/docs/NgrokAPI/Models/HTTPSEdge.html +1361 -0
- data/docs/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +278 -288
- data/docs/NgrokAPI/Models/IPPolicy.html +120 -68
- data/docs/NgrokAPI/Models/IPPolicyRule.html +222 -96
- data/docs/NgrokAPI/Models/IPRestriction.html +130 -78
- data/docs/NgrokAPI/Models/Listable.html +61 -61
- data/docs/NgrokAPI/Models/Ref.html +83 -31
- data/docs/NgrokAPI/Models/ReservedAddr.html +130 -78
- data/docs/NgrokAPI/Models/ReservedDomain.html +151 -99
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +92 -40
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +90 -38
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +90 -38
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +135 -83
- data/docs/NgrokAPI/Models/SSHCredential.html +128 -76
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +148 -96
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +154 -102
- data/docs/NgrokAPI/Models/TCPEdge.html +1287 -0
- data/docs/NgrokAPI/Models/TLSCertificate.html +165 -113
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +90 -38
- data/docs/NgrokAPI/Models/TLSEdge.html +1447 -0
- data/docs/NgrokAPI/Models/Tunnel.html +413 -65
- data/docs/NgrokAPI/Models/TunnelGroupBackend.html +1201 -0
- data/docs/NgrokAPI/Models/TunnelSession.html +126 -74
- data/docs/NgrokAPI/Models/WeightedBackend.html +1127 -0
- data/docs/NgrokAPI/Models.html +4 -4
- data/docs/NgrokAPI/PagedIterator.html +3 -3
- data/docs/NgrokAPI/Services/APIKeysClient.html +244 -109
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +162 -25
- data/docs/NgrokAPI/Services/AgentIngressesClient.html +262 -109
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +262 -109
- data/docs/NgrokAPI/Services/CredentialsClient.html +266 -111
- data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1149 -0
- data/docs/NgrokAPI/Services/{EndpointCircuitBreakerModuleClient.html → EdgeRouteCircuitBreakerModuleClient.html} +205 -99
- data/{doc/NgrokAPI/Services/EndpointCompressionModuleClient.html → docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html} +205 -99
- data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +1149 -0
- data/docs/NgrokAPI/Services/{EndpointOAuthModuleClient.html → EdgeRouteOAuthModuleClient.html} +205 -99
- data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +1149 -0
- data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1149 -0
- data/docs/NgrokAPI/Services/{EndpointResponseHeadersModuleClient.html → EdgeRouteResponseHeadersModuleClient.html} +205 -99
- data/{doc/NgrokAPI/Services/EndpointSAMLModuleClient.html → docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html} +205 -99
- data/{doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html → docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html} +205 -99
- data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1149 -0
- data/docs/NgrokAPI/Services/EdgesHTTPSClient.html +1947 -0
- data/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +2585 -0
- data/docs/NgrokAPI/Services/EdgesTCPClient.html +1947 -0
- data/{doc/NgrokAPI/Services/EndpointConfigurationsClient.html → docs/NgrokAPI/Services/EdgesTLSClient.html} +374 -641
- data/docs/NgrokAPI/Services/EndpointsClient.html +903 -0
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +290 -115
- data/docs/NgrokAPI/Services/EventSourcesClient.html +227 -88
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +291 -116
- data/docs/NgrokAPI/Services/{EventStreamsClient.html → FailoverBackendsClient.html} +342 -335
- data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +1937 -0
- data/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +1039 -0
- data/{doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html → docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html} +76 -80
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +245 -128
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +328 -117
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +305 -114
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +160 -295
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +257 -624
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +304 -109
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +284 -111
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +340 -109
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +381 -110
- data/docs/NgrokAPI/Services/{EndpointOIDCModuleClient.html → TCPEdgeBackendModuleClient.html} +76 -80
- data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +1039 -0
- data/docs/NgrokAPI/Services/TLSCertificatesClient.html +280 -109
- data/{doc/NgrokAPI/Services/EndpointOIDCModuleClient.html → docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html} +76 -80
- data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +1039 -0
- data/docs/NgrokAPI/Services/{EndpointMutualTLSModuleClient.html → TLSEdgeMutualTLSModuleClient.html} +62 -66
- data/docs/NgrokAPI/Services/{EndpointTLSTerminationModuleClient.html → TLSEdgeTLSTerminationModuleClient.html} +62 -66
- data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +1799 -0
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +44 -48
- data/docs/NgrokAPI/Services/TunnelsClient.html +249 -15
- data/docs/NgrokAPI/Services/WeightedBackendsClient.html +1799 -0
- data/docs/NgrokAPI/Services.html +4 -4
- data/docs/NgrokAPI.html +3 -3
- data/docs/_index.html +237 -60
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +55 -55
- data/docs/index.html +55 -55
- data/docs/method_list.html +4555 -1843
- data/docs/top-level-namespace.html +2 -2
- data/lib/ngrokapi/client.rb +47 -24
- data/lib/ngrokapi/http_client.rb +21 -2
- data/lib/ngrokapi/models/abuse_report.rb +16 -12
- data/lib/ngrokapi/models/abuse_report_hostname.rb +11 -7
- data/lib/ngrokapi/models/agent_ingress.rb +17 -13
- data/lib/ngrokapi/models/api_key.rb +15 -11
- data/lib/ngrokapi/models/aws_auth.rb +11 -7
- data/lib/ngrokapi/models/aws_credentials.rb +11 -7
- data/lib/ngrokapi/models/aws_role.rb +10 -6
- data/lib/ngrokapi/models/certificate_authority.rb +20 -16
- data/lib/ngrokapi/models/credential.rb +16 -12
- data/lib/ngrokapi/models/endpoint.rb +53 -0
- data/lib/ngrokapi/models/endpoint_backend.rb +31 -0
- data/lib/ngrokapi/models/endpoint_backend_mutate.rb +31 -0
- data/lib/ngrokapi/models/endpoint_circuit_breaker.rb +15 -11
- data/lib/ngrokapi/models/endpoint_compression.rb +10 -6
- data/lib/ngrokapi/models/endpoint_ip_policy.rb +11 -7
- data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb +11 -7
- data/lib/ngrokapi/models/endpoint_mutual_tls.rb +11 -7
- data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb +11 -7
- data/lib/ngrokapi/models/endpoint_o_auth.rb +16 -12
- data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb +14 -10
- data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb +16 -12
- data/lib/ngrokapi/models/endpoint_o_auth_google.rb +14 -10
- data/lib/ngrokapi/models/endpoint_o_auth_microsoft.rb +14 -10
- data/lib/ngrokapi/models/endpoint_o_auth_provider.rb +13 -9
- data/lib/ngrokapi/models/endpoint_oidc.rb +18 -14
- data/lib/ngrokapi/models/endpoint_request_headers.rb +12 -8
- data/lib/ngrokapi/models/endpoint_response_headers.rb +12 -8
- data/lib/ngrokapi/models/endpoint_saml.rb +25 -21
- data/lib/ngrokapi/models/endpoint_saml_mutate.rb +20 -16
- data/lib/ngrokapi/models/endpoint_tls_termination.rb +12 -8
- data/lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb +31 -0
- data/lib/ngrokapi/models/endpoint_webhook_validation.rb +12 -8
- data/lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb +29 -0
- data/lib/ngrokapi/models/event_destination.rb +17 -14
- data/lib/ngrokapi/models/event_source.rb +13 -9
- data/lib/ngrokapi/models/event_source_list.rb +11 -7
- data/lib/ngrokapi/models/event_source_replace.rb +12 -8
- data/lib/ngrokapi/models/event_subscription.rb +16 -12
- data/lib/ngrokapi/models/event_target.rb +13 -9
- data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb +11 -7
- data/lib/ngrokapi/models/event_target_firehose.rb +11 -7
- data/lib/ngrokapi/models/event_target_kinesis.rb +11 -7
- data/lib/ngrokapi/models/failover_backend.rb +69 -0
- data/lib/ngrokapi/models/http_response_backend.rb +75 -0
- data/lib/ngrokapi/models/https_edge.rb +84 -0
- data/lib/ngrokapi/models/https_edge_route.rb +137 -0
- data/lib/ngrokapi/models/ip_policy.rb +15 -11
- data/lib/ngrokapi/models/ip_policy_rule.rb +19 -13
- data/lib/ngrokapi/models/ip_restriction.rb +17 -13
- data/lib/ngrokapi/models/listable.rb +9 -9
- data/lib/ngrokapi/models/ref.rb +11 -7
- data/lib/ngrokapi/models/reserved_addr.rb +17 -13
- data/lib/ngrokapi/models/reserved_domain.rb +23 -19
- data/lib/ngrokapi/models/reserved_domain_cert_job.rb +13 -9
- data/lib/ngrokapi/models/reserved_domain_cert_policy.rb +11 -7
- data/lib/ngrokapi/models/reserved_domain_cert_status.rb +11 -7
- data/lib/ngrokapi/models/ssh_certificate_authority.rb +16 -12
- data/lib/ngrokapi/models/ssh_credential.rb +16 -12
- data/lib/ngrokapi/models/ssh_host_certificate.rb +21 -17
- data/lib/ngrokapi/models/ssh_user_certificate.rb +23 -19
- data/lib/ngrokapi/models/tcp_edge.rb +82 -0
- data/lib/ngrokapi/models/tls_certificate.rb +30 -26
- data/lib/ngrokapi/models/tls_certificate_sa_ns.rb +11 -7
- data/lib/ngrokapi/models/tls_edge.rb +92 -0
- data/lib/ngrokapi/models/tunnel.rb +25 -13
- data/lib/ngrokapi/models/tunnel_group_backend.rb +71 -0
- data/lib/ngrokapi/models/tunnel_session.rb +19 -15
- data/lib/ngrokapi/models/weighted_backend.rb +69 -0
- data/lib/ngrokapi/paged_iterator.rb +1 -1
- data/lib/ngrokapi/services/abuse_reports_client.rb +25 -3
- data/lib/ngrokapi/services/agent_ingresses_client.rb +32 -11
- data/lib/ngrokapi/services/api_keys_client.rb +30 -11
- data/lib/ngrokapi/services/certificate_authorities_client.rb +31 -11
- data/lib/ngrokapi/services/credentials_client.rb +34 -11
- data/lib/ngrokapi/services/edge_route_backend_module_client.rb +118 -0
- data/lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb +118 -0
- data/lib/ngrokapi/services/edge_route_compression_module_client.rb +118 -0
- data/lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb +118 -0
- data/lib/ngrokapi/services/edge_route_o_auth_module_client.rb +118 -0
- data/lib/ngrokapi/services/edge_route_oidc_module_client.rb +118 -0
- data/lib/ngrokapi/services/edge_route_request_headers_module_client.rb +118 -0
- data/lib/ngrokapi/services/edge_route_response_headers_module_client.rb +118 -0
- data/lib/ngrokapi/services/edge_route_saml_module_client.rb +118 -0
- data/lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb +118 -0
- data/lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb +118 -0
- data/lib/ngrokapi/services/edges_https_client.rb +251 -0
- data/lib/ngrokapi/services/edges_https_routes_client.rb +292 -0
- data/lib/ngrokapi/services/edges_tcp_client.rb +251 -0
- data/lib/ngrokapi/services/edges_tls_client.rb +267 -0
- data/lib/ngrokapi/services/endpoints_client.rb +112 -0
- data/lib/ngrokapi/services/event_destinations_client.rb +37 -15
- data/lib/ngrokapi/services/event_sources_client.rb +27 -7
- data/lib/ngrokapi/services/event_subscriptions_client.rb +36 -14
- data/lib/ngrokapi/services/failover_backends_client.rb +234 -0
- data/lib/ngrokapi/services/http_response_backends_client.rb +220 -0
- data/lib/ngrokapi/services/{endpoint_oidc_module_client.rb → https_edge_mutual_tls_module_client.rb} +27 -29
- data/lib/ngrokapi/services/https_edge_tls_termination_module_client.rb +106 -0
- data/lib/ngrokapi/services/ip_policies_client.rb +31 -14
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +38 -12
- data/lib/ngrokapi/services/ip_restrictions_client.rb +36 -12
- data/lib/ngrokapi/services/reserved_addrs_client.rb +31 -48
- data/lib/ngrokapi/services/reserved_domains_client.rb +37 -85
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +35 -11
- data/lib/ngrokapi/services/ssh_credentials_client.rb +34 -11
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +39 -11
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +44 -12
- data/lib/ngrokapi/services/{endpoint_logging_module_client.rb → tcp_edge_backend_module_client.rb} +27 -29
- data/lib/ngrokapi/services/{endpoint_ip_policy_module_client.rb → tcp_edge_ip_restriction_module_client.rb} +21 -23
- data/lib/ngrokapi/services/tls_certificates_client.rb +33 -11
- data/lib/ngrokapi/services/{endpoint_saml_module_client.rb → tls_edge_backend_module_client.rb} +27 -29
- data/lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb +106 -0
- data/lib/ngrokapi/services/{endpoint_mutual_tls_module_client.rb → tls_edge_mutual_tls_module_client.rb} +21 -23
- data/lib/ngrokapi/services/{endpoint_tls_termination_module_client.rb → tls_edge_tls_termination_module_client.rb} +21 -23
- data/lib/ngrokapi/services/tunnel_group_backends_client.rb +232 -0
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +6 -8
- data/lib/ngrokapi/services/tunnels_client.rb +39 -6
- data/lib/ngrokapi/services/weighted_backends_client.rb +234 -0
- data/lib/ngrokapi/version.rb +1 -1
- data/lib/ngrokapi.rb +1 -1
- data/spec/ngrokapi/client_spec.rb +44 -23
- data/spec/ngrokapi/models/abuse_report_hostname_spec.rb +2 -2
- data/spec/ngrokapi/models/abuse_report_spec.rb +2 -2
- data/spec/ngrokapi/models/agent_ingress_spec.rb +2 -2
- data/spec/ngrokapi/models/api_key_spec.rb +2 -2
- data/spec/ngrokapi/models/aws_auth_spec.rb +2 -2
- data/spec/ngrokapi/models/aws_credentials_spec.rb +2 -2
- data/spec/ngrokapi/models/aws_role_spec.rb +2 -2
- data/spec/ngrokapi/models/certificate_authority_spec.rb +2 -2
- data/spec/ngrokapi/models/credential_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_backend_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_backend_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_circuit_breaker_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_compression_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_ip_policy_mutate_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_ip_policy_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_mutual_tls_mutate_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_mutual_tls_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_o_auth_facebook_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_o_auth_git_hub_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_o_auth_google_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_o_auth_microsoft_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_o_auth_provider_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_o_auth_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_oidc_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_request_headers_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_response_headers_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_saml_mutate_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_saml_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_tls_termination_at_edge_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_tls_termination_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_webhook_validation_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_websocket_tcp_converter_spec.rb +21 -0
- data/spec/ngrokapi/models/event_destination_spec.rb +2 -2
- data/spec/ngrokapi/models/event_source_list_spec.rb +2 -2
- data/spec/ngrokapi/models/event_source_replace_spec.rb +2 -2
- data/spec/ngrokapi/models/event_source_spec.rb +2 -2
- data/spec/ngrokapi/models/event_subscription_spec.rb +2 -2
- data/spec/ngrokapi/models/event_target_cloudwatch_logs_spec.rb +2 -2
- data/spec/ngrokapi/models/event_target_firehose_spec.rb +2 -2
- data/spec/ngrokapi/models/event_target_kinesis_spec.rb +2 -2
- data/spec/ngrokapi/models/event_target_spec.rb +2 -2
- data/spec/ngrokapi/models/failover_backend_spec.rb +45 -0
- data/spec/ngrokapi/models/http_response_backend_spec.rb +51 -0
- data/spec/ngrokapi/models/https_edge_route_spec.rb +81 -0
- data/spec/ngrokapi/models/https_edge_spec.rb +51 -0
- data/spec/ngrokapi/models/ip_policy_rule_spec.rb +2 -2
- data/spec/ngrokapi/models/ip_policy_spec.rb +2 -2
- data/spec/ngrokapi/models/ip_restriction_spec.rb +2 -2
- data/spec/ngrokapi/models/listable_spec.rb +2 -2
- data/spec/ngrokapi/models/ref_spec.rb +2 -2
- data/spec/ngrokapi/models/reserved_addr_spec.rb +2 -2
- data/spec/ngrokapi/models/reserved_domain_cert_job_spec.rb +2 -2
- data/spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb +2 -2
- data/spec/ngrokapi/models/reserved_domain_cert_status_spec.rb +2 -2
- data/spec/ngrokapi/models/reserved_domain_spec.rb +2 -2
- data/spec/ngrokapi/models/ssh_certificate_authority_spec.rb +2 -2
- data/spec/ngrokapi/models/ssh_credential_spec.rb +2 -2
- data/spec/ngrokapi/models/ssh_host_certificate_spec.rb +2 -2
- data/spec/ngrokapi/models/ssh_user_certificate_spec.rb +2 -2
- data/spec/ngrokapi/models/tcp_edge_spec.rb +51 -0
- data/spec/ngrokapi/models/tls_certificate_sa_ns_spec.rb +2 -2
- data/spec/ngrokapi/models/tls_certificate_spec.rb +2 -2
- data/spec/ngrokapi/models/tls_edge_spec.rb +57 -0
- data/spec/ngrokapi/models/tunnel_group_backend_spec.rb +45 -0
- data/spec/ngrokapi/models/tunnel_session_spec.rb +2 -2
- data/spec/ngrokapi/models/tunnel_spec.rb +2 -2
- data/spec/ngrokapi/models/weighted_backend_spec.rb +45 -0
- data/spec/ngrokapi/paged_iterator_spec.rb +5 -5
- data/spec/ngrokapi/services/abuse_reports_client_spec.rb +19 -0
- data/spec/ngrokapi/services/agent_ingresses_client_spec.rb +21 -0
- data/spec/ngrokapi/services/api_keys_client_spec.rb +19 -0
- data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +21 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +21 -0
- data/spec/ngrokapi/services/edge_route_backend_module_client_spec.rb +137 -0
- data/spec/ngrokapi/services/{endpoint_circuit_breaker_module_client_spec.rb → edge_route_circuit_breaker_module_client_spec.rb} +33 -21
- data/spec/ngrokapi/services/{endpoint_compression_module_client_spec.rb → edge_route_compression_module_client_spec.rb} +33 -21
- data/spec/ngrokapi/services/edge_route_ip_restriction_module_client_spec.rb +137 -0
- data/spec/ngrokapi/services/{endpoint_o_auth_module_client_spec.rb → edge_route_o_auth_module_client_spec.rb} +33 -21
- data/spec/ngrokapi/services/{endpoint_oidc_module_client_spec.rb → edge_route_oidc_module_client_spec.rb} +33 -21
- data/spec/ngrokapi/services/{endpoint_request_headers_module_client_spec.rb → edge_route_request_headers_module_client_spec.rb} +33 -21
- data/spec/ngrokapi/services/{endpoint_response_headers_module_client_spec.rb → edge_route_response_headers_module_client_spec.rb} +33 -21
- data/spec/ngrokapi/services/{endpoint_saml_module_client_spec.rb → edge_route_saml_module_client_spec.rb} +33 -21
- data/spec/ngrokapi/services/{endpoint_webhook_validation_module_client_spec.rb → edge_route_webhook_verification_module_client_spec.rb} +33 -21
- data/spec/ngrokapi/services/edge_route_websocket_tcp_converter_module_client_spec.rb +137 -0
- data/spec/ngrokapi/services/edges_https_client_spec.rb +200 -0
- data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +288 -0
- data/spec/ngrokapi/services/edges_tcp_client_spec.rb +200 -0
- data/spec/ngrokapi/services/edges_tls_client_spec.rb +216 -0
- data/spec/ngrokapi/services/endpoints_client_spec.rb +57 -0
- data/spec/ngrokapi/services/event_destinations_client_spec.rb +24 -0
- data/spec/ngrokapi/services/event_sources_client_spec.rb +21 -0
- data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +23 -0
- data/spec/ngrokapi/services/failover_backends_client_spec.rb +184 -0
- data/spec/ngrokapi/services/http_response_backends_client_spec.rb +200 -0
- data/spec/ngrokapi/services/{endpoint_mutual_tls_module_client_spec.rb → https_edge_mutual_tls_module_client_spec.rb} +19 -21
- data/spec/ngrokapi/services/{endpoint_tls_termination_module_client_spec.rb → https_edge_tls_termination_module_client_spec.rb} +19 -21
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +20 -1
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +28 -1
- data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +25 -0
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +22 -44
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +29 -88
- data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +25 -0
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +23 -0
- data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +29 -0
- data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +33 -0
- data/spec/ngrokapi/services/tcp_edge_backend_module_client_spec.rb +123 -0
- data/spec/ngrokapi/services/{endpoint_ip_policy_module_client_spec.rb → tcp_edge_ip_restriction_module_client_spec.rb} +19 -21
- data/spec/ngrokapi/services/tls_certificates_client_spec.rb +23 -0
- data/spec/ngrokapi/services/tls_edge_backend_module_client_spec.rb +123 -0
- data/spec/ngrokapi/services/tls_edge_ip_restriction_module_client_spec.rb +123 -0
- data/spec/ngrokapi/services/tls_edge_mutual_tls_module_client_spec.rb +123 -0
- data/spec/ngrokapi/services/tls_edge_tls_termination_module_client_spec.rb +123 -0
- data/spec/ngrokapi/services/tunnel_group_backends_client_spec.rb +184 -0
- data/spec/ngrokapi/services/tunnels_client_spec.rb +36 -0
- data/spec/ngrokapi/services/weighted_backends_client_spec.rb +184 -0
- data/spec/spec_helper.rb +326 -33
- metadata +166 -76
- data/doc/README +0 -94
- data/docs/README +0 -94
- data/lib/ngrokapi/models/endpoint_configuration.rb +0 -130
- data/lib/ngrokapi/models/endpoint_logging.rb +0 -27
- data/lib/ngrokapi/models/endpoint_logging_mutate.rb +0 -27
- data/lib/ngrokapi/models/event_stream.rb +0 -77
- data/lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb +0 -108
- data/lib/ngrokapi/services/endpoint_compression_module_client.rb +0 -108
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +0 -289
- data/lib/ngrokapi/services/endpoint_o_auth_module_client.rb +0 -108
- data/lib/ngrokapi/services/endpoint_request_headers_module_client.rb +0 -108
- data/lib/ngrokapi/services/endpoint_response_headers_module_client.rb +0 -108
- data/lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb +0 -108
- data/lib/ngrokapi/services/event_streams_client.rb +0 -224
- data/spec/ngrokapi/models/endpoint_configuration_spec.rb +0 -78
- data/spec/ngrokapi/models/endpoint_logging_mutate_spec.rb +0 -21
- data/spec/ngrokapi/models/endpoint_logging_spec.rb +0 -21
- data/spec/ngrokapi/models/event_stream_spec.rb +0 -51
- data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +0 -237
- data/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb +0 -125
- data/spec/ngrokapi/services/event_streams_client_spec.rb +0 -177
@@ -231,7 +231,7 @@
|
|
231
231
|
<li class="public ">
|
232
232
|
<span class="summary_signature">
|
233
233
|
|
234
|
-
<a href="#
|
234
|
+
<a href="#create!-instance_method" title="#create! (instance method)">#<strong>create!</strong>(name:, region: "", description: "", metadata: "", http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil) ⇒ NgrokAPI::Models::ReservedDomain </a>
|
235
235
|
|
236
236
|
|
237
237
|
|
@@ -246,7 +246,7 @@
|
|
246
246
|
|
247
247
|
|
248
248
|
<span class="summary_desc"><div class='inline'>
|
249
|
-
<p>
|
249
|
+
<p>Create a new reserved domain.</p>
|
250
250
|
</div></span>
|
251
251
|
|
252
252
|
</li>
|
@@ -255,7 +255,7 @@
|
|
255
255
|
<li class="public ">
|
256
256
|
<span class="summary_signature">
|
257
257
|
|
258
|
-
<a href="#delete
|
258
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
259
259
|
|
260
260
|
|
261
261
|
|
@@ -279,7 +279,7 @@
|
|
279
279
|
<li class="public ">
|
280
280
|
<span class="summary_signature">
|
281
281
|
|
282
|
-
<a href="#
|
282
|
+
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
283
283
|
|
284
284
|
|
285
285
|
|
@@ -294,7 +294,7 @@
|
|
294
294
|
|
295
295
|
|
296
296
|
<span class="summary_desc"><div class='inline'>
|
297
|
-
<p>
|
297
|
+
<p>Delete a reserved domain.</p>
|
298
298
|
</div></span>
|
299
299
|
|
300
300
|
</li>
|
@@ -303,7 +303,7 @@
|
|
303
303
|
<li class="public ">
|
304
304
|
<span class="summary_signature">
|
305
305
|
|
306
|
-
<a href="#delete_certificate
|
306
|
+
<a href="#delete_certificate-instance_method" title="#delete_certificate (instance method)">#<strong>delete_certificate</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
307
307
|
|
308
308
|
|
309
309
|
|
@@ -327,7 +327,7 @@
|
|
327
327
|
<li class="public ">
|
328
328
|
<span class="summary_signature">
|
329
329
|
|
330
|
-
<a href="#
|
330
|
+
<a href="#delete_certificate!-instance_method" title="#delete_certificate! (instance method)">#<strong>delete_certificate!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
331
331
|
|
332
332
|
|
333
333
|
|
@@ -342,7 +342,7 @@
|
|
342
342
|
|
343
343
|
|
344
344
|
<span class="summary_desc"><div class='inline'>
|
345
|
-
<p>Detach the certificate
|
345
|
+
<p>Detach the certificate attached to a reserved domain.</p>
|
346
346
|
</div></span>
|
347
347
|
|
348
348
|
</li>
|
@@ -351,7 +351,7 @@
|
|
351
351
|
<li class="public ">
|
352
352
|
<span class="summary_signature">
|
353
353
|
|
354
|
-
<a href="#delete_certificate_management_policy
|
354
|
+
<a href="#delete_certificate_management_policy-instance_method" title="#delete_certificate_management_policy (instance method)">#<strong>delete_certificate_management_policy</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
355
355
|
|
356
356
|
|
357
357
|
|
@@ -375,79 +375,7 @@
|
|
375
375
|
<li class="public ">
|
376
376
|
<span class="summary_signature">
|
377
377
|
|
378
|
-
<a href="#
|
379
|
-
|
380
|
-
|
381
|
-
|
382
|
-
</span>
|
383
|
-
|
384
|
-
|
385
|
-
|
386
|
-
|
387
|
-
|
388
|
-
|
389
|
-
|
390
|
-
|
391
|
-
|
392
|
-
<span class="summary_desc"><div class='inline'>
|
393
|
-
<p>Detach the http endpoint configuration attached to a reserved domain.</p>
|
394
|
-
</div></span>
|
395
|
-
|
396
|
-
</li>
|
397
|
-
|
398
|
-
|
399
|
-
<li class="public ">
|
400
|
-
<span class="summary_signature">
|
401
|
-
|
402
|
-
<a href="#delete_http_endpoint_config!-instance_method" title="#delete_http_endpoint_config! (instance method)">#<strong>delete_http_endpoint_config!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
403
|
-
|
404
|
-
|
405
|
-
|
406
|
-
</span>
|
407
|
-
|
408
|
-
|
409
|
-
|
410
|
-
|
411
|
-
|
412
|
-
|
413
|
-
|
414
|
-
|
415
|
-
|
416
|
-
<span class="summary_desc"><div class='inline'>
|
417
|
-
<p>Detach the http endpoint configuration attached to a reserved domain.</p>
|
418
|
-
</div></span>
|
419
|
-
|
420
|
-
</li>
|
421
|
-
|
422
|
-
|
423
|
-
<li class="public ">
|
424
|
-
<span class="summary_signature">
|
425
|
-
|
426
|
-
<a href="#delete_https_endpoint_config-instance_method" title="#delete_https_endpoint_config (instance method)">#<strong>delete_https_endpoint_config</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
427
|
-
|
428
|
-
|
429
|
-
|
430
|
-
</span>
|
431
|
-
|
432
|
-
|
433
|
-
|
434
|
-
|
435
|
-
|
436
|
-
|
437
|
-
|
438
|
-
|
439
|
-
|
440
|
-
<span class="summary_desc"><div class='inline'>
|
441
|
-
<p>Detach the https endpoint configuration attached to a reserved domain.</p>
|
442
|
-
</div></span>
|
443
|
-
|
444
|
-
</li>
|
445
|
-
|
446
|
-
|
447
|
-
<li class="public ">
|
448
|
-
<span class="summary_signature">
|
449
|
-
|
450
|
-
<a href="#delete_https_endpoint_config!-instance_method" title="#delete_https_endpoint_config! (instance method)">#<strong>delete_https_endpoint_config!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
378
|
+
<a href="#delete_certificate_management_policy!-instance_method" title="#delete_certificate_management_policy! (instance method)">#<strong>delete_certificate_management_policy!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
451
379
|
|
452
380
|
|
453
381
|
|
@@ -462,7 +390,7 @@
|
|
462
390
|
|
463
391
|
|
464
392
|
<span class="summary_desc"><div class='inline'>
|
465
|
-
<p>Detach the
|
393
|
+
<p>Detach the certificate management policy attached to a reserved domain.</p>
|
466
394
|
</div></span>
|
467
395
|
|
468
396
|
</li>
|
@@ -833,42 +761,6 @@
|
|
833
761
|
|
834
762
|
</li>
|
835
763
|
|
836
|
-
<li>
|
837
|
-
|
838
|
-
<span class='name'>http_endpoint_configuration_id</span>
|
839
|
-
|
840
|
-
|
841
|
-
<span class='type'>(<tt>string</tt>)</span>
|
842
|
-
|
843
|
-
|
844
|
-
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
845
|
-
|
846
|
-
|
847
|
-
—
|
848
|
-
<div class='inline'>
|
849
|
-
<p>ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain</p>
|
850
|
-
</div>
|
851
|
-
|
852
|
-
</li>
|
853
|
-
|
854
|
-
<li>
|
855
|
-
|
856
|
-
<span class='name'>https_endpoint_configuration_id</span>
|
857
|
-
|
858
|
-
|
859
|
-
<span class='type'>(<tt>string</tt>)</span>
|
860
|
-
|
861
|
-
|
862
|
-
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
863
|
-
|
864
|
-
|
865
|
-
—
|
866
|
-
<div class='inline'>
|
867
|
-
<p>ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain</p>
|
868
|
-
</div>
|
869
|
-
|
870
|
-
</li>
|
871
|
-
|
872
764
|
<li>
|
873
765
|
|
874
766
|
<span class='name'>certificate_id</span>
|
@@ -932,6 +824,8 @@
|
|
932
824
|
<pre class="lines">
|
933
825
|
|
934
826
|
|
827
|
+
36
|
828
|
+
37
|
935
829
|
38
|
936
830
|
39
|
937
831
|
40
|
@@ -943,14 +837,10 @@
|
|
943
837
|
46
|
944
838
|
47
|
945
839
|
48
|
946
|
-
49
|
947
|
-
50
|
948
|
-
51
|
949
|
-
52
|
950
|
-
53</pre>
|
840
|
+
49</pre>
|
951
841
|
</td>
|
952
842
|
<td>
|
953
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
843
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 36</span>
|
954
844
|
|
955
845
|
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>name:</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'>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'>http_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>https_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>certificate_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>certificate_management_policy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
956
846
|
<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_domains</span><span class='tstring_end'>'</span></span>
|
@@ -961,12 +851,10 @@
|
|
961
851
|
<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>
|
962
852
|
<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>
|
963
853
|
<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>
|
964
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:http_endpoint_configuration_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_http_endpoint_configuration_id'>http_endpoint_configuration_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_http_endpoint_configuration_id'>http_endpoint_configuration_id</span>
|
965
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:https_endpoint_configuration_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_https_endpoint_configuration_id'>https_endpoint_configuration_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_https_endpoint_configuration_id'>https_endpoint_configuration_id</span>
|
966
854
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:certificate_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_certificate_id'>certificate_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_certificate_id'>certificate_id</span>
|
967
855
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:certificate_management_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span>
|
968
856
|
<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>
|
969
|
-
<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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#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'>
|
857
|
+
<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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#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'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
970
858
|
<span class='kw'>end</span></pre>
|
971
859
|
</td>
|
972
860
|
</tr>
|
@@ -974,9 +862,9 @@
|
|
974
862
|
</div>
|
975
863
|
|
976
864
|
<div class="method_details ">
|
977
|
-
<h3 class="signature " id="
|
865
|
+
<h3 class="signature " id="create!-instance_method">
|
978
866
|
|
979
|
-
#<strong>
|
867
|
+
#<strong>create!</strong>(name:, region: "", description: "", metadata: "", http_endpoint_configuration_id: nil, https_endpoint_configuration_id: nil, certificate_id: nil, certificate_management_policy: nil) ⇒ <tt><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>
|
980
868
|
|
981
869
|
|
982
870
|
|
@@ -985,9 +873,9 @@
|
|
985
873
|
</h3><div class="docstring">
|
986
874
|
<div class="discussion">
|
987
875
|
|
988
|
-
<p>
|
876
|
+
<p>Create a new reserved domain. Throws an exception if API error.</p>
|
989
877
|
|
990
|
-
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-
|
878
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-create">ngrok.com/docs/api#api-reserved-domains-create</a></p>
|
991
879
|
|
992
880
|
|
993
881
|
</div>
|
@@ -998,98 +886,23 @@
|
|
998
886
|
|
999
887
|
<li>
|
1000
888
|
|
1001
|
-
<span class='name'>
|
889
|
+
<span class='name'>name</span>
|
1002
890
|
|
1003
891
|
|
1004
892
|
<span class='type'>(<tt>string</tt>)</span>
|
1005
893
|
|
1006
894
|
|
1007
|
-
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1008
|
-
|
1009
895
|
|
1010
896
|
—
|
1011
897
|
<div class='inline'>
|
1012
|
-
<p>a
|
898
|
+
<p>the domain name to reserve. It may be a full domain name like app.example.com. If the name does not contain a '.' it will reserve that subdomain on ngrok.io.</p>
|
1013
899
|
</div>
|
1014
900
|
|
1015
901
|
</li>
|
1016
902
|
|
1017
|
-
</ul>
|
1018
|
-
|
1019
|
-
<p class="tag_title">Returns:</p>
|
1020
|
-
<ul class="return">
|
1021
|
-
|
1022
903
|
<li>
|
1023
904
|
|
1024
|
-
|
1025
|
-
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
1026
|
-
|
1027
|
-
|
1028
|
-
|
1029
|
-
—
|
1030
|
-
<div class='inline'>
|
1031
|
-
<p>result from the API request</p>
|
1032
|
-
</div>
|
1033
|
-
|
1034
|
-
</li>
|
1035
|
-
|
1036
|
-
</ul>
|
1037
|
-
|
1038
|
-
</div><table class="source_code">
|
1039
|
-
<tr>
|
1040
|
-
<td>
|
1041
|
-
<pre class="lines">
|
1042
|
-
|
1043
|
-
|
1044
|
-
62
|
1045
|
-
63
|
1046
|
-
64
|
1047
|
-
65
|
1048
|
-
66
|
1049
|
-
67
|
1050
|
-
68</pre>
|
1051
|
-
</td>
|
1052
|
-
<td>
|
1053
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 62</span>
|
1054
|
-
|
1055
|
-
<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>
|
1056
|
-
<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_domains/%{id}</span><span class='tstring_end'>'</span></span>
|
1057
|
-
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1058
|
-
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1059
|
-
<span class='rbrace'>}</span>
|
1060
|
-
<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>
|
1061
|
-
<span class='kw'>end</span></pre>
|
1062
|
-
</td>
|
1063
|
-
</tr>
|
1064
|
-
</table>
|
1065
|
-
</div>
|
1066
|
-
|
1067
|
-
<div class="method_details ">
|
1068
|
-
<h3 class="signature " id="delete!-instance_method">
|
1069
|
-
|
1070
|
-
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
1071
|
-
|
1072
|
-
|
1073
|
-
|
1074
|
-
|
1075
|
-
|
1076
|
-
</h3><div class="docstring">
|
1077
|
-
<div class="discussion">
|
1078
|
-
|
1079
|
-
<p>Delete a reserved domain. Throws an exception if API error.</p>
|
1080
|
-
|
1081
|
-
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete">ngrok.com/docs/api#api-reserved-domains-delete</a></p>
|
1082
|
-
|
1083
|
-
|
1084
|
-
</div>
|
1085
|
-
</div>
|
1086
|
-
<div class="tags">
|
1087
|
-
<p class="tag_title">Parameters:</p>
|
1088
|
-
<ul class="param">
|
1089
|
-
|
1090
|
-
<li>
|
1091
|
-
|
1092
|
-
<span class='name'>id</span>
|
905
|
+
<span class='name'>region</span>
|
1093
906
|
|
1094
907
|
|
1095
908
|
<span class='type'>(<tt>string</tt>)</span>
|
@@ -1100,87 +913,14 @@
|
|
1100
913
|
|
1101
914
|
—
|
1102
915
|
<div class='inline'>
|
1103
|
-
<p>
|
916
|
+
<p>reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)</p>
|
1104
917
|
</div>
|
1105
918
|
|
1106
919
|
</li>
|
1107
920
|
|
1108
|
-
</ul>
|
1109
|
-
|
1110
|
-
<p class="tag_title">Returns:</p>
|
1111
|
-
<ul class="return">
|
1112
|
-
|
1113
921
|
<li>
|
1114
922
|
|
1115
|
-
|
1116
|
-
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
1117
|
-
|
1118
|
-
|
1119
|
-
|
1120
|
-
—
|
1121
|
-
<div class='inline'>
|
1122
|
-
<p>result from the API request</p>
|
1123
|
-
</div>
|
1124
|
-
|
1125
|
-
</li>
|
1126
|
-
|
1127
|
-
</ul>
|
1128
|
-
|
1129
|
-
</div><table class="source_code">
|
1130
|
-
<tr>
|
1131
|
-
<td>
|
1132
|
-
<pre class="lines">
|
1133
|
-
|
1134
|
-
|
1135
|
-
78
|
1136
|
-
79
|
1137
|
-
80
|
1138
|
-
81
|
1139
|
-
82
|
1140
|
-
83
|
1141
|
-
84</pre>
|
1142
|
-
</td>
|
1143
|
-
<td>
|
1144
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 78</span>
|
1145
|
-
|
1146
|
-
<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>
|
1147
|
-
<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_domains/%{id}</span><span class='tstring_end'>'</span></span>
|
1148
|
-
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1149
|
-
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1150
|
-
<span class='rbrace'>}</span>
|
1151
|
-
<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>
|
1152
|
-
<span class='kw'>end</span></pre>
|
1153
|
-
</td>
|
1154
|
-
</tr>
|
1155
|
-
</table>
|
1156
|
-
</div>
|
1157
|
-
|
1158
|
-
<div class="method_details ">
|
1159
|
-
<h3 class="signature " id="delete_certificate-instance_method">
|
1160
|
-
|
1161
|
-
#<strong>delete_certificate</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
1162
|
-
|
1163
|
-
|
1164
|
-
|
1165
|
-
|
1166
|
-
|
1167
|
-
</h3><div class="docstring">
|
1168
|
-
<div class="discussion">
|
1169
|
-
|
1170
|
-
<p>Detach the certificate attached to a reserved domain.</p>
|
1171
|
-
|
1172
|
-
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-certificate">ngrok.com/docs/api#api-reserved-domains-delete-certificate</a></p>
|
1173
|
-
|
1174
|
-
|
1175
|
-
</div>
|
1176
|
-
</div>
|
1177
|
-
<div class="tags">
|
1178
|
-
<p class="tag_title">Parameters:</p>
|
1179
|
-
<ul class="param">
|
1180
|
-
|
1181
|
-
<li>
|
1182
|
-
|
1183
|
-
<span class='name'>id</span>
|
923
|
+
<span class='name'>description</span>
|
1184
924
|
|
1185
925
|
|
1186
926
|
<span class='type'>(<tt>string</tt>)</span>
|
@@ -1191,98 +931,61 @@
|
|
1191
931
|
|
1192
932
|
—
|
1193
933
|
<div class='inline'>
|
1194
|
-
<p>
|
934
|
+
<p>human-readable description of what this reserved domain will be used for</p>
|
1195
935
|
</div>
|
1196
936
|
|
1197
937
|
</li>
|
1198
938
|
|
1199
|
-
</ul>
|
1200
|
-
|
1201
|
-
<p class="tag_title">Returns:</p>
|
1202
|
-
<ul class="return">
|
1203
|
-
|
1204
939
|
<li>
|
1205
940
|
|
941
|
+
<span class='name'>metadata</span>
|
1206
942
|
|
1207
|
-
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
1208
943
|
|
944
|
+
<span class='type'>(<tt>string</tt>)</span>
|
945
|
+
|
946
|
+
|
947
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1209
948
|
|
1210
949
|
|
1211
950
|
—
|
1212
951
|
<div class='inline'>
|
1213
|
-
<p>
|
952
|
+
<p>arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.</p>
|
1214
953
|
</div>
|
1215
954
|
|
1216
|
-
</li>
|
1217
|
-
|
1218
|
-
</ul>
|
1219
|
-
|
1220
|
-
</div><table class="source_code">
|
1221
|
-
<tr>
|
1222
|
-
<td>
|
1223
|
-
<pre class="lines">
|
1224
|
-
|
1225
|
-
|
1226
|
-
273
|
1227
|
-
274
|
1228
|
-
275
|
1229
|
-
276
|
1230
|
-
277
|
1231
|
-
278
|
1232
|
-
279</pre>
|
1233
|
-
</td>
|
1234
|
-
<td>
|
1235
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 273</span>
|
1236
|
-
|
1237
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate'>delete_certificate</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>
|
1238
|
-
<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_domains/%{id}/certificate</span><span class='tstring_end'>'</span></span>
|
1239
|
-
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1240
|
-
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1241
|
-
<span class='rbrace'>}</span>
|
1242
|
-
<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>
|
1243
|
-
<span class='kw'>end</span></pre>
|
1244
|
-
</td>
|
1245
|
-
</tr>
|
1246
|
-
</table>
|
1247
|
-
</div>
|
1248
|
-
|
1249
|
-
<div class="method_details ">
|
1250
|
-
<h3 class="signature " id="delete_certificate!-instance_method">
|
1251
|
-
|
1252
|
-
#<strong>delete_certificate!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
1253
|
-
|
1254
|
-
|
1255
|
-
|
1256
|
-
|
1257
|
-
|
1258
|
-
</h3><div class="docstring">
|
1259
|
-
<div class="discussion">
|
1260
|
-
|
1261
|
-
<p>Detach the certificate attached to a reserved domain. Throws an exception if API error.</p>
|
1262
|
-
|
1263
|
-
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-certificate">ngrok.com/docs/api#api-reserved-domains-delete-certificate</a></p>
|
1264
|
-
|
1265
|
-
|
1266
|
-
</div>
|
1267
|
-
</div>
|
1268
|
-
<div class="tags">
|
1269
|
-
<p class="tag_title">Parameters:</p>
|
1270
|
-
<ul class="param">
|
955
|
+
</li>
|
1271
956
|
|
1272
957
|
<li>
|
1273
958
|
|
1274
|
-
<span class='name'>
|
959
|
+
<span class='name'>certificate_id</span>
|
1275
960
|
|
1276
961
|
|
1277
962
|
<span class='type'>(<tt>string</tt>)</span>
|
1278
963
|
|
1279
964
|
|
1280
|
-
<em class="default">(defaults to: <tt
|
965
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1281
966
|
|
1282
967
|
|
1283
968
|
—
|
1284
969
|
<div class='inline'>
|
1285
|
-
<p>a
|
970
|
+
<p>ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with <code>certificate_management_policy</code>.</p>
|
971
|
+
</div>
|
972
|
+
|
973
|
+
</li>
|
974
|
+
|
975
|
+
<li>
|
976
|
+
|
977
|
+
<span class='name'>certificate_management_policy</span>
|
978
|
+
|
979
|
+
|
980
|
+
<span class='type'>(<tt>ReservedDomainCertPolicy</tt>)</span>
|
981
|
+
|
982
|
+
|
983
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
984
|
+
|
985
|
+
|
986
|
+
—
|
987
|
+
<div class='inline'>
|
988
|
+
<p>configuration for automatic management of TLS certificates for this domain, or null if automatic management is disabled. Optional, mutually exclusive with <code>certificate_id</code>.</p>
|
1286
989
|
</div>
|
1287
990
|
|
1288
991
|
</li>
|
@@ -1295,7 +998,7 @@
|
|
1295
998
|
<li>
|
1296
999
|
|
1297
1000
|
|
1298
|
-
<span class='type'>(<tt>NgrokAPI::Models::
|
1001
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">NgrokAPI::Models::ReservedDomain</a></span></tt>)</span>
|
1299
1002
|
|
1300
1003
|
|
1301
1004
|
|
@@ -1314,23 +1017,37 @@
|
|
1314
1017
|
<pre class="lines">
|
1315
1018
|
|
1316
1019
|
|
1317
|
-
|
1318
|
-
|
1319
|
-
|
1320
|
-
|
1321
|
-
|
1322
|
-
|
1323
|
-
|
1020
|
+
64
|
1021
|
+
65
|
1022
|
+
66
|
1023
|
+
67
|
1024
|
+
68
|
1025
|
+
69
|
1026
|
+
70
|
1027
|
+
71
|
1028
|
+
72
|
1029
|
+
73
|
1030
|
+
74
|
1031
|
+
75
|
1032
|
+
76
|
1033
|
+
77</pre>
|
1324
1034
|
</td>
|
1325
1035
|
<td>
|
1326
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
1036
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 64</span>
|
1327
1037
|
|
1328
|
-
<span class='kw'>def</span> <span class='id identifier
|
1329
|
-
<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_domains
|
1038
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span><span class='label'>name:</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'>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'>http_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>https_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>certificate_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>certificate_management_policy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
1039
|
+
<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_domains</span><span class='tstring_end'>'</span></span>
|
1330
1040
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1331
|
-
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1332
1041
|
<span class='rbrace'>}</span>
|
1333
|
-
<span class='
|
1042
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
1043
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>if</span> <span class='id identifier rubyid_name'>name</span>
|
1044
|
+
<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>
|
1045
|
+
<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>
|
1046
|
+
<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>
|
1047
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:certificate_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_certificate_id'>certificate_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_certificate_id'>certificate_id</span>
|
1048
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:certificate_management_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span>
|
1049
|
+
<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='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
1050
|
+
<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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#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'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
1334
1051
|
<span class='kw'>end</span></pre>
|
1335
1052
|
</td>
|
1336
1053
|
</tr>
|
@@ -1338,9 +1055,9 @@
|
|
1338
1055
|
</div>
|
1339
1056
|
|
1340
1057
|
<div class="method_details ">
|
1341
|
-
<h3 class="signature " id="
|
1058
|
+
<h3 class="signature " id="delete-instance_method">
|
1342
1059
|
|
1343
|
-
#<strong>
|
1060
|
+
#<strong>delete</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
1344
1061
|
|
1345
1062
|
|
1346
1063
|
|
@@ -1349,9 +1066,9 @@
|
|
1349
1066
|
</h3><div class="docstring">
|
1350
1067
|
<div class="discussion">
|
1351
1068
|
|
1352
|
-
<p>
|
1069
|
+
<p>Delete a reserved domain.</p>
|
1353
1070
|
|
1354
|
-
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete
|
1071
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete">ngrok.com/docs/api#api-reserved-domains-delete</a></p>
|
1355
1072
|
|
1356
1073
|
|
1357
1074
|
</div>
|
@@ -1405,19 +1122,19 @@
|
|
1405
1122
|
<pre class="lines">
|
1406
1123
|
|
1407
1124
|
|
1408
|
-
|
1409
|
-
|
1410
|
-
|
1411
|
-
|
1412
|
-
|
1413
|
-
|
1414
|
-
|
1125
|
+
86
|
1126
|
+
87
|
1127
|
+
88
|
1128
|
+
89
|
1129
|
+
90
|
1130
|
+
91
|
1131
|
+
92</pre>
|
1415
1132
|
</td>
|
1416
1133
|
<td>
|
1417
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
1134
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 86</span>
|
1418
1135
|
|
1419
|
-
<span class='kw'>def</span> <span class='id identifier
|
1420
|
-
<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_domains/%{id}
|
1136
|
+
<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>
|
1137
|
+
<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_domains/%{id}</span><span class='tstring_end'>'</span></span>
|
1421
1138
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1422
1139
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1423
1140
|
<span class='rbrace'>}</span>
|
@@ -1429,9 +1146,9 @@
|
|
1429
1146
|
</div>
|
1430
1147
|
|
1431
1148
|
<div class="method_details ">
|
1432
|
-
<h3 class="signature " id="
|
1149
|
+
<h3 class="signature " id="delete!-instance_method">
|
1433
1150
|
|
1434
|
-
#<strong>
|
1151
|
+
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
1435
1152
|
|
1436
1153
|
|
1437
1154
|
|
@@ -1440,9 +1157,9 @@
|
|
1440
1157
|
</h3><div class="docstring">
|
1441
1158
|
<div class="discussion">
|
1442
1159
|
|
1443
|
-
<p>
|
1160
|
+
<p>Delete a reserved domain. Throws an exception if API error.</p>
|
1444
1161
|
|
1445
|
-
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete
|
1162
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete">ngrok.com/docs/api#api-reserved-domains-delete</a></p>
|
1446
1163
|
|
1447
1164
|
|
1448
1165
|
</div>
|
@@ -1496,19 +1213,19 @@
|
|
1496
1213
|
<pre class="lines">
|
1497
1214
|
|
1498
1215
|
|
1499
|
-
|
1500
|
-
|
1501
|
-
|
1502
|
-
|
1503
|
-
|
1504
|
-
|
1505
|
-
|
1216
|
+
102
|
1217
|
+
103
|
1218
|
+
104
|
1219
|
+
105
|
1220
|
+
106
|
1221
|
+
107
|
1222
|
+
108</pre>
|
1506
1223
|
</td>
|
1507
1224
|
<td>
|
1508
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
1225
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 102</span>
|
1509
1226
|
|
1510
|
-
<span class='kw'>def</span> <span class='id identifier
|
1511
|
-
<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_domains/%{id}
|
1227
|
+
<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>
|
1228
|
+
<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_domains/%{id}</span><span class='tstring_end'>'</span></span>
|
1512
1229
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1513
1230
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1514
1231
|
<span class='rbrace'>}</span>
|
@@ -1520,9 +1237,9 @@
|
|
1520
1237
|
</div>
|
1521
1238
|
|
1522
1239
|
<div class="method_details ">
|
1523
|
-
<h3 class="signature " id="
|
1240
|
+
<h3 class="signature " id="delete_certificate-instance_method">
|
1524
1241
|
|
1525
|
-
#<strong>
|
1242
|
+
#<strong>delete_certificate</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
1526
1243
|
|
1527
1244
|
|
1528
1245
|
|
@@ -1531,9 +1248,9 @@
|
|
1531
1248
|
</h3><div class="docstring">
|
1532
1249
|
<div class="discussion">
|
1533
1250
|
|
1534
|
-
<p>Detach the
|
1251
|
+
<p>Detach the certificate attached to a reserved domain.</p>
|
1535
1252
|
|
1536
|
-
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-
|
1253
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-certificate">ngrok.com/docs/api#api-reserved-domains-delete-certificate</a></p>
|
1537
1254
|
|
1538
1255
|
|
1539
1256
|
</div>
|
@@ -1587,19 +1304,19 @@
|
|
1587
1304
|
<pre class="lines">
|
1588
1305
|
|
1589
1306
|
|
1590
|
-
|
1591
|
-
|
1592
|
-
|
1593
|
-
|
1594
|
-
|
1595
|
-
|
1596
|
-
|
1307
|
+
287
|
1308
|
+
288
|
1309
|
+
289
|
1310
|
+
290
|
1311
|
+
291
|
1312
|
+
292
|
1313
|
+
293</pre>
|
1597
1314
|
</td>
|
1598
1315
|
<td>
|
1599
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
1316
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 287</span>
|
1600
1317
|
|
1601
|
-
<span class='kw'>def</span> <span class='id identifier
|
1602
|
-
<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_domains/%{id}/
|
1318
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate'>delete_certificate</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>
|
1319
|
+
<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_domains/%{id}/certificate</span><span class='tstring_end'>'</span></span>
|
1603
1320
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1604
1321
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1605
1322
|
<span class='rbrace'>}</span>
|
@@ -1611,9 +1328,9 @@
|
|
1611
1328
|
</div>
|
1612
1329
|
|
1613
1330
|
<div class="method_details ">
|
1614
|
-
<h3 class="signature " id="
|
1331
|
+
<h3 class="signature " id="delete_certificate!-instance_method">
|
1615
1332
|
|
1616
|
-
#<strong>
|
1333
|
+
#<strong>delete_certificate!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
1617
1334
|
|
1618
1335
|
|
1619
1336
|
|
@@ -1622,9 +1339,9 @@
|
|
1622
1339
|
</h3><div class="docstring">
|
1623
1340
|
<div class="discussion">
|
1624
1341
|
|
1625
|
-
<p>Detach the
|
1342
|
+
<p>Detach the certificate attached to a reserved domain. Throws an exception if API error.</p>
|
1626
1343
|
|
1627
|
-
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-
|
1344
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-certificate">ngrok.com/docs/api#api-reserved-domains-delete-certificate</a></p>
|
1628
1345
|
|
1629
1346
|
|
1630
1347
|
</div>
|
@@ -1678,19 +1395,19 @@
|
|
1678
1395
|
<pre class="lines">
|
1679
1396
|
|
1680
1397
|
|
1681
|
-
|
1682
|
-
|
1683
|
-
|
1684
|
-
|
1685
|
-
|
1686
|
-
|
1687
|
-
|
1398
|
+
303
|
1399
|
+
304
|
1400
|
+
305
|
1401
|
+
306
|
1402
|
+
307
|
1403
|
+
308
|
1404
|
+
309</pre>
|
1688
1405
|
</td>
|
1689
1406
|
<td>
|
1690
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
1407
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 303</span>
|
1691
1408
|
|
1692
|
-
<span class='kw'>def</span> <span class='id identifier
|
1693
|
-
<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_domains/%{id}/
|
1409
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate!'>delete_certificate!</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>
|
1410
|
+
<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_domains/%{id}/certificate</span><span class='tstring_end'>'</span></span>
|
1694
1411
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1695
1412
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1696
1413
|
<span class='rbrace'>}</span>
|
@@ -1702,9 +1419,9 @@
|
|
1702
1419
|
</div>
|
1703
1420
|
|
1704
1421
|
<div class="method_details ">
|
1705
|
-
<h3 class="signature " id="
|
1422
|
+
<h3 class="signature " id="delete_certificate_management_policy-instance_method">
|
1706
1423
|
|
1707
|
-
#<strong>
|
1424
|
+
#<strong>delete_certificate_management_policy</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
1708
1425
|
|
1709
1426
|
|
1710
1427
|
|
@@ -1713,9 +1430,9 @@
|
|
1713
1430
|
</h3><div class="docstring">
|
1714
1431
|
<div class="discussion">
|
1715
1432
|
|
1716
|
-
<p>Detach the
|
1433
|
+
<p>Detach the certificate management policy attached to a reserved domain.</p>
|
1717
1434
|
|
1718
|
-
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-
|
1435
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy">ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy</a></p>
|
1719
1436
|
|
1720
1437
|
|
1721
1438
|
</div>
|
@@ -1769,19 +1486,19 @@
|
|
1769
1486
|
<pre class="lines">
|
1770
1487
|
|
1771
1488
|
|
1772
|
-
|
1773
|
-
|
1774
|
-
|
1775
|
-
|
1776
|
-
|
1777
|
-
|
1778
|
-
|
1489
|
+
256
|
1490
|
+
257
|
1491
|
+
258
|
1492
|
+
259
|
1493
|
+
260
|
1494
|
+
261
|
1495
|
+
262</pre>
|
1779
1496
|
</td>
|
1780
1497
|
<td>
|
1781
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
1498
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 256</span>
|
1782
1499
|
|
1783
|
-
<span class='kw'>def</span> <span class='id identifier
|
1784
|
-
<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_domains/%{id}/
|
1500
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate_management_policy'>delete_certificate_management_policy</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>
|
1501
|
+
<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_domains/%{id}/certificate_management_policy</span><span class='tstring_end'>'</span></span>
|
1785
1502
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1786
1503
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1787
1504
|
<span class='rbrace'>}</span>
|
@@ -1793,9 +1510,9 @@
|
|
1793
1510
|
</div>
|
1794
1511
|
|
1795
1512
|
<div class="method_details ">
|
1796
|
-
<h3 class="signature " id="
|
1513
|
+
<h3 class="signature " id="delete_certificate_management_policy!-instance_method">
|
1797
1514
|
|
1798
|
-
#<strong>
|
1515
|
+
#<strong>delete_certificate_management_policy!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
1799
1516
|
|
1800
1517
|
|
1801
1518
|
|
@@ -1804,9 +1521,9 @@
|
|
1804
1521
|
</h3><div class="docstring">
|
1805
1522
|
<div class="discussion">
|
1806
1523
|
|
1807
|
-
<p>Detach the
|
1524
|
+
<p>Detach the certificate management policy attached to a reserved domain. Throws an exception if API error.</p>
|
1808
1525
|
|
1809
|
-
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-
|
1526
|
+
<p><a href="https://ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy">ngrok.com/docs/api#api-reserved-domains-delete-certificate-management-policy</a></p>
|
1810
1527
|
|
1811
1528
|
|
1812
1529
|
</div>
|
@@ -1860,19 +1577,19 @@
|
|
1860
1577
|
<pre class="lines">
|
1861
1578
|
|
1862
1579
|
|
1863
|
-
|
1864
|
-
|
1865
|
-
|
1866
|
-
|
1867
|
-
|
1868
|
-
|
1869
|
-
|
1580
|
+
272
|
1581
|
+
273
|
1582
|
+
274
|
1583
|
+
275
|
1584
|
+
276
|
1585
|
+
277
|
1586
|
+
278</pre>
|
1870
1587
|
</td>
|
1871
1588
|
<td>
|
1872
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
1589
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 272</span>
|
1873
1590
|
|
1874
|
-
<span class='kw'>def</span> <span class='id identifier
|
1875
|
-
<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_domains/%{id}/
|
1591
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete_certificate_management_policy!'>delete_certificate_management_policy!</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>
|
1592
|
+
<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_domains/%{id}/certificate_management_policy</span><span class='tstring_end'>'</span></span>
|
1876
1593
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1877
1594
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1878
1595
|
<span class='rbrace'>}</span>
|
@@ -1951,18 +1668,18 @@
|
|
1951
1668
|
<pre class="lines">
|
1952
1669
|
|
1953
1670
|
|
1954
|
-
|
1955
|
-
|
1956
|
-
|
1957
|
-
|
1958
|
-
|
1959
|
-
|
1960
|
-
|
1961
|
-
|
1962
|
-
|
1671
|
+
117
|
1672
|
+
118
|
1673
|
+
119
|
1674
|
+
120
|
1675
|
+
121
|
1676
|
+
122
|
1677
|
+
123
|
1678
|
+
124
|
1679
|
+
125</pre>
|
1963
1680
|
</td>
|
1964
1681
|
<td>
|
1965
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
1682
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 117</span>
|
1966
1683
|
|
1967
1684
|
<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>
|
1968
1685
|
<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_domains/%{id}</span><span class='tstring_end'>'</span></span>
|
@@ -1971,7 +1688,7 @@
|
|
1971
1688
|
<span class='rbrace'>}</span>
|
1972
1689
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
1973
1690
|
<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>
|
1974
|
-
<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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#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'>
|
1691
|
+
<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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#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'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
1975
1692
|
<span class='kw'>end</span></pre>
|
1976
1693
|
</td>
|
1977
1694
|
</tr>
|
@@ -2046,18 +1763,18 @@
|
|
2046
1763
|
<pre class="lines">
|
2047
1764
|
|
2048
1765
|
|
2049
|
-
|
2050
|
-
|
2051
|
-
|
2052
|
-
|
2053
|
-
|
2054
|
-
|
2055
|
-
|
2056
|
-
|
2057
|
-
|
1766
|
+
135
|
1767
|
+
136
|
1768
|
+
137
|
1769
|
+
138
|
1770
|
+
139
|
1771
|
+
140
|
1772
|
+
141
|
1773
|
+
142
|
1774
|
+
143</pre>
|
2058
1775
|
</td>
|
2059
1776
|
<td>
|
2060
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
1777
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 135</span>
|
2061
1778
|
|
2062
1779
|
<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>
|
2063
1780
|
<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_domains/%{id}</span><span class='tstring_end'>'</span></span>
|
@@ -2066,7 +1783,7 @@
|
|
2066
1783
|
<span class='rbrace'>}</span>
|
2067
1784
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
2068
1785
|
<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>
|
2069
|
-
<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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#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'>
|
1786
|
+
<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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#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'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
2070
1787
|
<span class='kw'>end</span></pre>
|
2071
1788
|
</td>
|
2072
1789
|
</tr>
|
@@ -2167,28 +1884,26 @@
|
|
2167
1884
|
<pre class="lines">
|
2168
1885
|
|
2169
1886
|
|
2170
|
-
|
2171
|
-
|
2172
|
-
|
2173
|
-
|
2174
|
-
|
2175
|
-
|
2176
|
-
|
2177
|
-
|
2178
|
-
|
2179
|
-
|
2180
|
-
|
2181
|
-
|
2182
|
-
|
2183
|
-
|
2184
|
-
|
2185
|
-
145</pre>
|
1887
|
+
154
|
1888
|
+
155
|
1889
|
+
156
|
1890
|
+
157
|
1891
|
+
158
|
1892
|
+
159
|
1893
|
+
160
|
1894
|
+
161
|
1895
|
+
162
|
1896
|
+
163
|
1897
|
+
164
|
1898
|
+
165
|
1899
|
+
166
|
1900
|
+
167
|
1901
|
+
168</pre>
|
2186
1902
|
</td>
|
2187
1903
|
<td>
|
2188
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
1904
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 154</span>
|
2189
1905
|
|
2190
|
-
<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>
|
2191
|
-
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
1906
|
+
<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> <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
2192
1907
|
<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>
|
2193
1908
|
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
2194
1909
|
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
@@ -2198,7 +1913,7 @@
|
|
2198
1913
|
|
2199
1914
|
<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>
|
2200
1915
|
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
2201
|
-
<span class='label'>
|
1916
|
+
<span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
2202
1917
|
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::ReservedDomainsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
2203
1918
|
<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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span>
|
2204
1919
|
<span class='rparen'>)</span>
|
@@ -2302,30 +2017,28 @@
|
|
2302
2017
|
<pre class="lines">
|
2303
2018
|
|
2304
2019
|
|
2305
|
-
|
2306
|
-
|
2307
|
-
|
2308
|
-
|
2309
|
-
|
2310
|
-
|
2311
|
-
|
2312
|
-
|
2313
|
-
|
2314
|
-
|
2315
|
-
|
2316
|
-
|
2317
|
-
|
2318
|
-
|
2319
|
-
|
2320
|
-
|
2321
|
-
|
2322
|
-
174</pre>
|
2020
|
+
180
|
2021
|
+
181
|
2022
|
+
182
|
2023
|
+
183
|
2024
|
+
184
|
2025
|
+
185
|
2026
|
+
186
|
2027
|
+
187
|
2028
|
+
188
|
2029
|
+
189
|
2030
|
+
190
|
2031
|
+
191
|
2032
|
+
192
|
2033
|
+
193
|
2034
|
+
194
|
2035
|
+
195
|
2036
|
+
196</pre>
|
2323
2037
|
</td>
|
2324
2038
|
<td>
|
2325
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
2039
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 180</span>
|
2326
2040
|
|
2327
|
-
<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>
|
2328
|
-
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
2041
|
+
<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> <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
2329
2042
|
<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>
|
2330
2043
|
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
2331
2044
|
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
@@ -2336,7 +2049,7 @@
|
|
2336
2049
|
|
2337
2050
|
<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>
|
2338
2051
|
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
2339
|
-
<span class='label'>
|
2052
|
+
<span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
2340
2053
|
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::ReservedDomainsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
2341
2054
|
<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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='comma'>,</span>
|
2342
2055
|
<span class='label'>danger:</span> <span class='kw'>true</span>
|
@@ -2419,42 +2132,6 @@
|
|
2419
2132
|
|
2420
2133
|
</li>
|
2421
2134
|
|
2422
|
-
<li>
|
2423
|
-
|
2424
|
-
<span class='name'>http_endpoint_configuration_id</span>
|
2425
|
-
|
2426
|
-
|
2427
|
-
<span class='type'>(<tt>string</tt>)</span>
|
2428
|
-
|
2429
|
-
|
2430
|
-
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
2431
|
-
|
2432
|
-
|
2433
|
-
—
|
2434
|
-
<div class='inline'>
|
2435
|
-
<p>ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain</p>
|
2436
|
-
</div>
|
2437
|
-
|
2438
|
-
</li>
|
2439
|
-
|
2440
|
-
<li>
|
2441
|
-
|
2442
|
-
<span class='name'>https_endpoint_configuration_id</span>
|
2443
|
-
|
2444
|
-
|
2445
|
-
<span class='type'>(<tt>string</tt>)</span>
|
2446
|
-
|
2447
|
-
|
2448
|
-
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
2449
|
-
|
2450
|
-
|
2451
|
-
—
|
2452
|
-
<div class='inline'>
|
2453
|
-
<p>ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain</p>
|
2454
|
-
</div>
|
2455
|
-
|
2456
|
-
</li>
|
2457
|
-
|
2458
2135
|
<li>
|
2459
2136
|
|
2460
2137
|
<span class='name'>certificate_id</span>
|
@@ -2518,24 +2195,22 @@
|
|
2518
2195
|
<pre class="lines">
|
2519
2196
|
|
2520
2197
|
|
2521
|
-
|
2522
|
-
|
2523
|
-
|
2524
|
-
|
2525
|
-
|
2526
|
-
|
2527
|
-
|
2528
|
-
|
2529
|
-
|
2530
|
-
|
2531
|
-
|
2532
|
-
|
2533
|
-
|
2534
|
-
202
|
2535
|
-
203</pre>
|
2198
|
+
209
|
2199
|
+
210
|
2200
|
+
211
|
2201
|
+
212
|
2202
|
+
213
|
2203
|
+
214
|
2204
|
+
215
|
2205
|
+
216
|
2206
|
+
217
|
2207
|
+
218
|
2208
|
+
219
|
2209
|
+
220
|
2210
|
+
221</pre>
|
2536
2211
|
</td>
|
2537
2212
|
<td>
|
2538
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
2213
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 209</span>
|
2539
2214
|
|
2540
2215
|
<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'>http_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>https_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>certificate_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>certificate_management_policy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
2541
2216
|
<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_domains/%{id}</span><span class='tstring_end'>'</span></span>
|
@@ -2545,12 +2220,10 @@
|
|
2545
2220
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
2546
2221
|
<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>
|
2547
2222
|
<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>
|
2548
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:http_endpoint_configuration_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_http_endpoint_configuration_id'>http_endpoint_configuration_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_http_endpoint_configuration_id'>http_endpoint_configuration_id</span>
|
2549
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:https_endpoint_configuration_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_https_endpoint_configuration_id'>https_endpoint_configuration_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_https_endpoint_configuration_id'>https_endpoint_configuration_id</span>
|
2550
2223
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:certificate_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_certificate_id'>certificate_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_certificate_id'>certificate_id</span>
|
2551
2224
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:certificate_management_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span>
|
2552
2225
|
<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>
|
2553
|
-
<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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#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'>
|
2226
|
+
<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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#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'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
2554
2227
|
<span class='kw'>end</span></pre>
|
2555
2228
|
</td>
|
2556
2229
|
</tr>
|
@@ -2629,42 +2302,6 @@
|
|
2629
2302
|
|
2630
2303
|
</li>
|
2631
2304
|
|
2632
|
-
<li>
|
2633
|
-
|
2634
|
-
<span class='name'>http_endpoint_configuration_id</span>
|
2635
|
-
|
2636
|
-
|
2637
|
-
<span class='type'>(<tt>string</tt>)</span>
|
2638
|
-
|
2639
|
-
|
2640
|
-
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
2641
|
-
|
2642
|
-
|
2643
|
-
—
|
2644
|
-
<div class='inline'>
|
2645
|
-
<p>ID of an endpoint configuration of type http that will be used to handle inbound http traffic to this domain</p>
|
2646
|
-
</div>
|
2647
|
-
|
2648
|
-
</li>
|
2649
|
-
|
2650
|
-
<li>
|
2651
|
-
|
2652
|
-
<span class='name'>https_endpoint_configuration_id</span>
|
2653
|
-
|
2654
|
-
|
2655
|
-
<span class='type'>(<tt>string</tt>)</span>
|
2656
|
-
|
2657
|
-
|
2658
|
-
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
2659
|
-
|
2660
|
-
|
2661
|
-
—
|
2662
|
-
<div class='inline'>
|
2663
|
-
<p>ID of an endpoint configuration of type https that will be used to handle inbound https traffic to this domain</p>
|
2664
|
-
</div>
|
2665
|
-
|
2666
|
-
</li>
|
2667
|
-
|
2668
2305
|
<li>
|
2669
2306
|
|
2670
2307
|
<span class='name'>certificate_id</span>
|
@@ -2728,24 +2365,22 @@
|
|
2728
2365
|
<pre class="lines">
|
2729
2366
|
|
2730
2367
|
|
2731
|
-
|
2732
|
-
|
2733
|
-
|
2734
|
-
|
2735
|
-
|
2736
|
-
|
2737
|
-
|
2738
|
-
|
2739
|
-
|
2740
|
-
|
2741
|
-
|
2742
|
-
|
2743
|
-
|
2744
|
-
232
|
2745
|
-
233</pre>
|
2368
|
+
235
|
2369
|
+
236
|
2370
|
+
237
|
2371
|
+
238
|
2372
|
+
239
|
2373
|
+
240
|
2374
|
+
241
|
2375
|
+
242
|
2376
|
+
243
|
2377
|
+
244
|
2378
|
+
245
|
2379
|
+
246
|
2380
|
+
247</pre>
|
2746
2381
|
</td>
|
2747
2382
|
<td>
|
2748
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line
|
2383
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/reserved_domains_client.rb', line 235</span>
|
2749
2384
|
|
2750
2385
|
<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'>http_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>https_endpoint_configuration_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>certificate_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>certificate_management_policy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
2751
2386
|
<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_domains/%{id}</span><span class='tstring_end'>'</span></span>
|
@@ -2755,12 +2390,10 @@
|
|
2755
2390
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
2756
2391
|
<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>
|
2757
2392
|
<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>
|
2758
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:http_endpoint_configuration_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_http_endpoint_configuration_id'>http_endpoint_configuration_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_http_endpoint_configuration_id'>http_endpoint_configuration_id</span>
|
2759
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:https_endpoint_configuration_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_https_endpoint_configuration_id'>https_endpoint_configuration_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_https_endpoint_configuration_id'>https_endpoint_configuration_id</span>
|
2760
2393
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:certificate_id</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_certificate_id'>certificate_id</span> <span class='kw'>if</span> <span class='id identifier rubyid_certificate_id'>certificate_id</span>
|
2761
2394
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:certificate_management_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_certificate_management_policy'>certificate_management_policy</span>
|
2762
2395
|
<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>
|
2763
|
-
<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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#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'>
|
2396
|
+
<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/ReservedDomain.html" title="NgrokAPI::Models::ReservedDomain (class)">ReservedDomain</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/ReservedDomain.html#initialize-instance_method" title="NgrokAPI::Models::ReservedDomain#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'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
2764
2397
|
<span class='kw'>end</span></pre>
|
2765
2398
|
</td>
|
2766
2399
|
</tr>
|
@@ -2772,9 +2405,9 @@
|
|
2772
2405
|
</div>
|
2773
2406
|
|
2774
2407
|
<div id="footer">
|
2775
|
-
Generated on
|
2408
|
+
Generated on Mon Apr 11 19:33:02 2022 by
|
2776
2409
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
2777
|
-
0.9.27 (ruby-
|
2410
|
+
0.9.27 (ruby-2.7.5).
|
2778
2411
|
</div>
|
2779
2412
|
|
2780
2413
|
</div>
|