ngrok-api 0.16.0 → 0.17.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- 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 +2 -2
- data/doc/NgrokAPI/Models/APIKey.html +2 -2
- data/doc/NgrokAPI/Models/AWSAuth.html +2 -2
- data/doc/NgrokAPI/Models/AWSCredentials.html +2 -2
- data/doc/NgrokAPI/Models/AWSRole.html +2 -2
- data/doc/NgrokAPI/Models/AbuseReport.html +2 -2
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +2 -2
- data/doc/NgrokAPI/Models/AgentIngress.html +2 -2
- data/doc/NgrokAPI/Models/CertificateAuthority.html +2 -2
- data/doc/NgrokAPI/Models/Credential.html +2 -2
- data/doc/NgrokAPI/Models/Endpoint.html +1431 -0
- data/{docs/NgrokAPI/Models/EndpointLogging.html → doc/NgrokAPI/Models/EndpointBackend.html} +41 -41
- data/doc/NgrokAPI/Models/{EndpointLoggingMutate.html → EndpointBackendMutate.html} +41 -41
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +2 -2
- data/doc/NgrokAPI/Models/EndpointCompression.html +2 -2
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +2 -2
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +2 -2
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +2 -2
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuth.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOIDC.html +2 -2
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +2 -2
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +2 -2
- data/doc/NgrokAPI/Models/EndpointSAML.html +2 -2
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +2 -2
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +2 -2
- data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +617 -0
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +2 -2
- data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +543 -0
- data/doc/NgrokAPI/Models/EventDestination.html +6 -6
- data/doc/NgrokAPI/Models/EventSource.html +2 -2
- data/doc/NgrokAPI/Models/EventSourceList.html +2 -2
- data/doc/NgrokAPI/Models/EventSourceReplace.html +2 -2
- data/doc/NgrokAPI/Models/EventSubscription.html +2 -2
- data/doc/NgrokAPI/Models/EventTarget.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +2 -2
- data/doc/NgrokAPI/Models/FailoverBackend.html +1075 -0
- data/doc/NgrokAPI/Models/HTTPResponseBackend.html +1231 -0
- data/{docs/NgrokAPI/Models/EventStream.html → doc/NgrokAPI/Models/HTTPSEdge.html} +118 -118
- data/doc/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +202 -264
- data/doc/NgrokAPI/Models/IPPolicy.html +2 -2
- data/doc/NgrokAPI/Models/IPPolicyRule.html +96 -22
- data/doc/NgrokAPI/Models/IPRestriction.html +2 -2
- data/doc/NgrokAPI/Models/Listable.html +2 -2
- data/doc/NgrokAPI/Models/Ref.html +2 -2
- data/doc/NgrokAPI/Models/ReservedAddr.html +2 -2
- data/doc/NgrokAPI/Models/ReservedDomain.html +2 -2
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +2 -2
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +2 -2
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +2 -2
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +2 -2
- data/doc/NgrokAPI/Models/SSHCredential.html +2 -2
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +2 -2
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +2 -2
- data/doc/NgrokAPI/Models/TCPEdge.html +1235 -0
- data/doc/NgrokAPI/Models/TLSCertificate.html +2 -2
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +2 -2
- data/doc/NgrokAPI/Models/TLSEdge.html +1395 -0
- data/doc/NgrokAPI/Models/Tunnel.html +313 -17
- data/doc/NgrokAPI/Models/TunnelGroupBackend.html +1149 -0
- data/doc/NgrokAPI/Models/TunnelSession.html +2 -2
- data/doc/NgrokAPI/Models/WeightedBackend.html +1075 -0
- data/doc/NgrokAPI/Models.html +4 -4
- data/doc/NgrokAPI/PagedIterator.html +2 -2
- data/doc/NgrokAPI/Services/APIKeysClient.html +2 -2
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +2 -2
- data/doc/NgrokAPI/Services/AgentIngressesClient.html +2 -2
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +2 -2
- data/doc/NgrokAPI/Services/CredentialsClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1153 -0
- data/doc/NgrokAPI/Services/{EndpointCircuitBreakerModuleClient.html → EdgeRouteCircuitBreakerModuleClient.html} +206 -96
- data/{docs/NgrokAPI/Services/EndpointCompressionModuleClient.html → doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html} +206 -96
- data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +1153 -0
- data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +1153 -0
- data/{docs/NgrokAPI/Services/EndpointOIDCModuleClient.html → doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html} +206 -96
- data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1153 -0
- data/{docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html → doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html} +206 -96
- data/{docs/NgrokAPI/Services/EndpointSAMLModuleClient.html → doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html} +206 -96
- data/doc/NgrokAPI/Services/{EndpointWebhookValidationModuleClient.html → EdgeRouteWebhookVerificationModuleClient.html} +206 -96
- data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1153 -0
- data/doc/NgrokAPI/Services/{EventStreamsClient.html → EdgesHTTPSClient.html} +236 -271
- data/{docs/NgrokAPI/Services/EndpointConfigurationsClient.html → doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html} +456 -620
- data/doc/NgrokAPI/Services/EdgesTCPClient.html +1757 -0
- data/doc/NgrokAPI/Services/EdgesTLSClient.html +1847 -0
- data/doc/NgrokAPI/Services/EndpointsClient.html +907 -0
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +35 -35
- data/doc/NgrokAPI/Services/EventSourcesClient.html +2 -2
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +5 -5
- data/doc/NgrokAPI/Services/FailoverBackendsClient.html +1644 -0
- data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +1744 -0
- data/doc/NgrokAPI/Services/{EndpointOIDCModuleClient.html → HTTPSEdgeMutualTLSModuleClient.html} +59 -59
- data/doc/NgrokAPI/Services/{EndpointRequestHeadersModuleClient.html → HTTPSEdgeTLSTerminationModuleClient.html} +59 -59
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +40 -58
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +60 -40
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +3 -3
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +41 -331
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +94 -674
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +2 -2
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +2 -2
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +2 -2
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +2 -2
- data/{docs/NgrokAPI/Services/EndpointLoggingModuleClient.html → doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html} +59 -59
- data/doc/NgrokAPI/Services/{EndpointIPPolicyModuleClient.html → TCPEdgeIPRestrictionModuleClient.html} +41 -41
- data/doc/NgrokAPI/Services/TLSCertificatesClient.html +2 -2
- data/doc/NgrokAPI/Services/{EndpointLoggingModuleClient.html → TLSEdgeBackendModuleClient.html} +59 -59
- data/{docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html → doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html} +41 -41
- data/doc/NgrokAPI/Services/{EndpointMutualTLSModuleClient.html → TLSEdgeMutualTLSModuleClient.html} +41 -41
- data/{docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html → doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html} +41 -41
- data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +1644 -0
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +2 -2
- data/doc/NgrokAPI/Services/TunnelsClient.html +241 -3
- data/doc/NgrokAPI/Services/WeightedBackendsClient.html +1644 -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 +2 -2
- data/doc/index.html +2 -2
- data/doc/method_list.html +3393 -1433
- 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 +2 -2
- data/docs/NgrokAPI/Models/APIKey.html +2 -2
- data/docs/NgrokAPI/Models/AWSAuth.html +2 -2
- data/docs/NgrokAPI/Models/AWSCredentials.html +2 -2
- data/docs/NgrokAPI/Models/AWSRole.html +2 -2
- data/docs/NgrokAPI/Models/AbuseReport.html +2 -2
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +2 -2
- data/docs/NgrokAPI/Models/AgentIngress.html +2 -2
- data/docs/NgrokAPI/Models/CertificateAuthority.html +2 -2
- data/docs/NgrokAPI/Models/Credential.html +2 -2
- data/docs/NgrokAPI/Models/Endpoint.html +1431 -0
- data/{doc/NgrokAPI/Models/EndpointLogging.html → docs/NgrokAPI/Models/EndpointBackend.html} +41 -41
- data/docs/NgrokAPI/Models/{EndpointLoggingMutate.html → EndpointBackendMutate.html} +41 -41
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +2 -2
- data/docs/NgrokAPI/Models/EndpointCompression.html +2 -2
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +2 -2
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +2 -2
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +2 -2
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuth.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOIDC.html +2 -2
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +2 -2
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +2 -2
- data/docs/NgrokAPI/Models/EndpointSAML.html +2 -2
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +2 -2
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +2 -2
- data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +617 -0
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +2 -2
- data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +543 -0
- data/docs/NgrokAPI/Models/EventDestination.html +6 -6
- data/docs/NgrokAPI/Models/EventSource.html +2 -2
- data/docs/NgrokAPI/Models/EventSourceList.html +2 -2
- data/docs/NgrokAPI/Models/EventSourceReplace.html +2 -2
- data/docs/NgrokAPI/Models/EventSubscription.html +2 -2
- data/docs/NgrokAPI/Models/EventTarget.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +2 -2
- data/docs/NgrokAPI/Models/FailoverBackend.html +1075 -0
- data/docs/NgrokAPI/Models/HTTPResponseBackend.html +1231 -0
- data/{doc/NgrokAPI/Models/EventStream.html → docs/NgrokAPI/Models/HTTPSEdge.html} +118 -118
- data/docs/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +202 -264
- data/docs/NgrokAPI/Models/IPPolicy.html +2 -2
- data/docs/NgrokAPI/Models/IPPolicyRule.html +96 -22
- data/docs/NgrokAPI/Models/IPRestriction.html +2 -2
- data/docs/NgrokAPI/Models/Listable.html +2 -2
- data/docs/NgrokAPI/Models/Ref.html +2 -2
- data/docs/NgrokAPI/Models/ReservedAddr.html +2 -2
- data/docs/NgrokAPI/Models/ReservedDomain.html +2 -2
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +2 -2
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +2 -2
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +2 -2
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +2 -2
- data/docs/NgrokAPI/Models/SSHCredential.html +2 -2
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +2 -2
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +2 -2
- data/docs/NgrokAPI/Models/TCPEdge.html +1235 -0
- data/docs/NgrokAPI/Models/TLSCertificate.html +2 -2
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +2 -2
- data/docs/NgrokAPI/Models/TLSEdge.html +1395 -0
- data/docs/NgrokAPI/Models/Tunnel.html +313 -17
- data/docs/NgrokAPI/Models/TunnelGroupBackend.html +1149 -0
- data/docs/NgrokAPI/Models/TunnelSession.html +2 -2
- data/docs/NgrokAPI/Models/WeightedBackend.html +1075 -0
- data/docs/NgrokAPI/Models.html +4 -4
- data/docs/NgrokAPI/PagedIterator.html +2 -2
- data/docs/NgrokAPI/Services/APIKeysClient.html +2 -2
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +2 -2
- data/docs/NgrokAPI/Services/AgentIngressesClient.html +2 -2
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +2 -2
- data/docs/NgrokAPI/Services/CredentialsClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1153 -0
- data/docs/NgrokAPI/Services/{EndpointCircuitBreakerModuleClient.html → EdgeRouteCircuitBreakerModuleClient.html} +206 -96
- data/{doc/NgrokAPI/Services/EndpointCompressionModuleClient.html → docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html} +206 -96
- data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +1153 -0
- data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +1153 -0
- data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +1153 -0
- data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1153 -0
- data/{doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html → docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html} +206 -96
- data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +1153 -0
- data/docs/NgrokAPI/Services/{EndpointWebhookValidationModuleClient.html → EdgeRouteWebhookVerificationModuleClient.html} +206 -96
- data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1153 -0
- data/docs/NgrokAPI/Services/{EventStreamsClient.html → EdgesHTTPSClient.html} +236 -271
- data/{doc/NgrokAPI/Services/EndpointConfigurationsClient.html → docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html} +456 -620
- data/docs/NgrokAPI/Services/EdgesTCPClient.html +1757 -0
- data/docs/NgrokAPI/Services/EdgesTLSClient.html +1847 -0
- data/docs/NgrokAPI/Services/EndpointsClient.html +907 -0
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +35 -35
- data/docs/NgrokAPI/Services/EventSourcesClient.html +2 -2
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +5 -5
- data/docs/NgrokAPI/Services/FailoverBackendsClient.html +1644 -0
- data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +1744 -0
- data/{doc/NgrokAPI/Services/EndpointSAMLModuleClient.html → docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html} +59 -59
- data/docs/NgrokAPI/Services/{EndpointRequestHeadersModuleClient.html → HTTPSEdgeTLSTerminationModuleClient.html} +59 -59
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +40 -58
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +60 -40
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +3 -3
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +41 -331
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +94 -674
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +2 -2
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +2 -2
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +2 -2
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +2 -2
- data/docs/NgrokAPI/Services/{EndpointOAuthModuleClient.html → TCPEdgeBackendModuleClient.html} +59 -59
- data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/TLSCertificatesClient.html +2 -2
- data/{doc/NgrokAPI/Services/EndpointOAuthModuleClient.html → docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html} +59 -59
- data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/{EndpointMutualTLSModuleClient.html → TLSEdgeMutualTLSModuleClient.html} +41 -41
- data/{doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html → docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html} +41 -41
- data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +1644 -0
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +2 -2
- data/docs/NgrokAPI/Services/TunnelsClient.html +241 -3
- data/docs/NgrokAPI/Services/WeightedBackendsClient.html +1644 -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 +2 -2
- data/docs/index.html +2 -2
- data/docs/method_list.html +3393 -1433
- data/docs/top-level-namespace.html +2 -2
- data/lib/ngrokapi/client.rb +47 -24
- data/lib/ngrokapi/models/endpoint.rb +49 -0
- data/lib/ngrokapi/models/{endpoint_logging.rb → endpoint_backend.rb} +3 -3
- data/lib/ngrokapi/models/{endpoint_logging_mutate.rb → endpoint_backend_mutate.rb} +3 -3
- data/lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb +27 -0
- data/lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb +25 -0
- data/lib/ngrokapi/models/event_destination.rb +1 -2
- data/lib/ngrokapi/models/{event_stream.rb → failover_backend.rb} +15 -27
- data/lib/ngrokapi/models/http_response_backend.rb +71 -0
- data/lib/ngrokapi/models/https_edge.rb +80 -0
- data/lib/ngrokapi/models/{endpoint_configuration.rb → https_edge_route.rb} +56 -53
- data/lib/ngrokapi/models/ip_policy_rule.rb +3 -1
- data/lib/ngrokapi/models/tcp_edge.rb +78 -0
- data/lib/ngrokapi/models/tls_edge.rb +88 -0
- data/lib/ngrokapi/models/tunnel.rb +9 -1
- data/lib/ngrokapi/models/tunnel_group_backend.rb +67 -0
- data/lib/ngrokapi/models/weighted_backend.rb +65 -0
- data/lib/ngrokapi/services/edge_route_backend_module_client.rb +120 -0
- data/lib/ngrokapi/services/{endpoint_circuit_breaker_module_client.rb → edge_route_circuit_breaker_module_client.rb} +37 -25
- data/lib/ngrokapi/services/{endpoint_compression_module_client.rb → edge_route_compression_module_client.rb} +37 -25
- data/lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb +120 -0
- data/lib/ngrokapi/services/edge_route_o_auth_module_client.rb +120 -0
- data/lib/ngrokapi/services/edge_route_oidc_module_client.rb +120 -0
- data/lib/ngrokapi/services/edge_route_request_headers_module_client.rb +120 -0
- data/lib/ngrokapi/services/{endpoint_response_headers_module_client.rb → edge_route_response_headers_module_client.rb} +37 -25
- data/lib/ngrokapi/services/edge_route_saml_module_client.rb +120 -0
- data/lib/ngrokapi/services/{endpoint_webhook_validation_module_client.rb → edge_route_webhook_verification_module_client.rb} +37 -25
- data/lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb +120 -0
- data/lib/ngrokapi/services/edges_https_client.rb +227 -0
- data/lib/ngrokapi/services/edges_https_routes_client.rb +244 -0
- data/lib/ngrokapi/services/edges_tcp_client.rb +227 -0
- data/lib/ngrokapi/services/edges_tls_client.rb +239 -0
- data/lib/ngrokapi/services/endpoints_client.rb +114 -0
- data/lib/ngrokapi/services/event_destinations_client.rb +2 -4
- data/lib/ngrokapi/services/event_subscriptions_client.rb +3 -3
- data/lib/ngrokapi/services/failover_backends_client.rb +214 -0
- data/lib/ngrokapi/services/http_response_backends_client.rb +199 -0
- data/lib/ngrokapi/services/{endpoint_saml_module_client.rb → https_edge_mutual_tls_module_client.rb} +25 -25
- data/lib/ngrokapi/services/{endpoint_request_headers_module_client.rb → https_edge_tls_termination_module_client.rb} +25 -25
- data/lib/ngrokapi/services/ip_policies_client.rb +1 -3
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +3 -1
- data/lib/ngrokapi/services/ip_restrictions_client.rb +1 -1
- data/lib/ngrokapi/services/reserved_addrs_client.rb +0 -37
- data/lib/ngrokapi/services/reserved_domains_client.rb +0 -74
- data/lib/ngrokapi/services/{endpoint_logging_module_client.rb → tcp_edge_backend_module_client.rb} +25 -25
- data/lib/ngrokapi/services/{endpoint_ip_policy_module_client.rb → tcp_edge_ip_restriction_module_client.rb} +15 -15
- data/lib/ngrokapi/services/{endpoint_oidc_module_client.rb → tls_edge_backend_module_client.rb} +25 -25
- data/lib/ngrokapi/services/{endpoint_o_auth_module_client.rb → tls_edge_ip_restriction_module_client.rb} +25 -25
- data/lib/ngrokapi/services/{endpoint_mutual_tls_module_client.rb → tls_edge_mutual_tls_module_client.rb} +15 -15
- data/lib/ngrokapi/services/{endpoint_tls_termination_module_client.rb → tls_edge_tls_termination_module_client.rb} +15 -15
- data/lib/ngrokapi/services/tunnel_group_backends_client.rb +212 -0
- data/lib/ngrokapi/services/tunnels_client.rb +35 -0
- data/lib/ngrokapi/services/weighted_backends_client.rb +214 -0
- data/lib/ngrokapi/version.rb +1 -1
- data/spec/ngrokapi/client_spec.rb +44 -23
- 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_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_tls_termination_at_edge_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_websocket_tcp_converter_spec.rb +21 -0
- 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/tcp_edge_spec.rb +51 -0
- 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/weighted_backend_spec.rb +45 -0
- data/spec/ngrokapi/services/edge_route_backend_module_client_spec.rb +139 -0
- data/spec/ngrokapi/services/{endpoint_circuit_breaker_module_client_spec.rb → edge_route_circuit_breaker_module_client_spec.rb} +31 -17
- data/spec/ngrokapi/services/{endpoint_compression_module_client_spec.rb → edge_route_compression_module_client_spec.rb} +31 -17
- data/spec/ngrokapi/services/edge_route_ip_restriction_module_client_spec.rb +139 -0
- data/spec/ngrokapi/services/{endpoint_o_auth_module_client_spec.rb → edge_route_o_auth_module_client_spec.rb} +31 -17
- data/spec/ngrokapi/services/{endpoint_oidc_module_client_spec.rb → edge_route_oidc_module_client_spec.rb} +31 -17
- data/spec/ngrokapi/services/{endpoint_request_headers_module_client_spec.rb → edge_route_request_headers_module_client_spec.rb} +31 -17
- data/spec/ngrokapi/services/{endpoint_response_headers_module_client_spec.rb → edge_route_response_headers_module_client_spec.rb} +31 -17
- data/spec/ngrokapi/services/{endpoint_saml_module_client_spec.rb → edge_route_saml_module_client_spec.rb} +31 -17
- data/spec/ngrokapi/services/{endpoint_webhook_validation_module_client_spec.rb → edge_route_webhook_verification_module_client_spec.rb} +31 -17
- data/spec/ngrokapi/services/edge_route_websocket_tcp_converter_module_client_spec.rb +139 -0
- data/spec/ngrokapi/services/{event_streams_client_spec.rb → edges_https_client_spec.rb} +106 -108
- data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +241 -0
- data/spec/ngrokapi/services/edges_tcp_client_spec.rb +175 -0
- data/spec/ngrokapi/services/edges_tls_client_spec.rb +187 -0
- data/spec/ngrokapi/services/endpoints_client_spec.rb +57 -0
- data/spec/ngrokapi/services/failover_backends_client_spec.rb +163 -0
- data/spec/ngrokapi/services/http_response_backends_client_spec.rb +175 -0
- data/spec/ngrokapi/services/{endpoint_mutual_tls_module_client_spec.rb → https_edge_mutual_tls_module_client_spec.rb} +17 -17
- data/spec/ngrokapi/services/{endpoint_tls_termination_module_client_spec.rb → https_edge_tls_termination_module_client_spec.rb} +17 -17
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +0 -1
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +3 -1
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +0 -44
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +0 -88
- data/spec/ngrokapi/services/{endpoint_logging_module_client_spec.rb → tcp_edge_backend_module_client_spec.rb} +40 -40
- data/spec/ngrokapi/services/{endpoint_ip_policy_module_client_spec.rb → tcp_edge_ip_restriction_module_client_spec.rb} +17 -17
- data/spec/ngrokapi/services/tls_edge_backend_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/tls_edge_ip_restriction_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/tls_edge_mutual_tls_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/tls_edge_tls_termination_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/tunnel_group_backends_client_spec.rb +163 -0
- data/spec/ngrokapi/services/tunnels_client_spec.rb +36 -0
- data/spec/ngrokapi/services/weighted_backends_client_spec.rb +163 -0
- data/spec/spec_helper.rb +326 -33
- metadata +166 -74
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +0 -289
- 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
@@ -4,7 +4,7 @@
|
|
4
4
|
<meta charset="utf-8">
|
5
5
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
6
|
<title>
|
7
|
-
Class: NgrokAPI::Services::
|
7
|
+
Class: NgrokAPI::Services::EdgesHTTPSClient
|
8
8
|
|
9
9
|
— Documentation by YARD 0.9.27
|
10
10
|
|
@@ -15,7 +15,7 @@
|
|
15
15
|
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
16
16
|
|
17
17
|
<script type="text/javascript">
|
18
|
-
pathId = "NgrokAPI::Services::
|
18
|
+
pathId = "NgrokAPI::Services::EdgesHTTPSClient";
|
19
19
|
relpath = '../../';
|
20
20
|
</script>
|
21
21
|
|
@@ -39,7 +39,7 @@
|
|
39
39
|
<a href="../../_index.html">Index (E)</a> »
|
40
40
|
<span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> » <span class='title'><span class='object_link'><a href="../Services.html" title="NgrokAPI::Services (module)">Services</a></span></span>
|
41
41
|
»
|
42
|
-
<span class="title">
|
42
|
+
<span class="title">EdgesHTTPSClient</span>
|
43
43
|
|
44
44
|
</div>
|
45
45
|
|
@@ -59,7 +59,7 @@
|
|
59
59
|
<div class="clear"></div>
|
60
60
|
</div>
|
61
61
|
|
62
|
-
<div id="content"><h1>Class: NgrokAPI::Services::
|
62
|
+
<div id="content"><h1>Class: NgrokAPI::Services::EdgesHTTPSClient
|
63
63
|
|
64
64
|
|
65
65
|
|
@@ -74,7 +74,7 @@
|
|
74
74
|
<ul class="fullTree">
|
75
75
|
<li>Object</li>
|
76
76
|
|
77
|
-
<li class="next">NgrokAPI::Services::
|
77
|
+
<li class="next">NgrokAPI::Services::EdgesHTTPSClient</li>
|
78
78
|
|
79
79
|
</ul>
|
80
80
|
<a href="#" class="inheritanceTree">show all</a>
|
@@ -94,7 +94,7 @@
|
|
94
94
|
|
95
95
|
<dl>
|
96
96
|
<dt>Defined in:</dt>
|
97
|
-
<dd>lib/ngrokapi/services/
|
97
|
+
<dd>lib/ngrokapi/services/edges_https_client.rb</dd>
|
98
98
|
</dl>
|
99
99
|
|
100
100
|
</div>
|
@@ -102,7 +102,7 @@
|
|
102
102
|
<h2>Overview</h2><div class="docstring">
|
103
103
|
<div class="discussion">
|
104
104
|
|
105
|
-
<p><a href="https://ngrok.com/docs/api#api-
|
105
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-https">ngrok.com/docs/api#api-edges-https</a></p>
|
106
106
|
|
107
107
|
|
108
108
|
</div>
|
@@ -133,7 +133,7 @@
|
|
133
133
|
|
134
134
|
</div>
|
135
135
|
</dt>
|
136
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/
|
136
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https</span><span class='tstring_end'>'</span></span></pre></dd>
|
137
137
|
|
138
138
|
<dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
|
139
139
|
<div class="docstring">
|
@@ -149,7 +149,7 @@
|
|
149
149
|
|
150
150
|
</div>
|
151
151
|
</dt>
|
152
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>
|
152
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>https_edges</span><span class='tstring_end'>'</span></span></pre></dd>
|
153
153
|
|
154
154
|
</dl>
|
155
155
|
|
@@ -205,7 +205,7 @@
|
|
205
205
|
<li class="public ">
|
206
206
|
<span class="summary_signature">
|
207
207
|
|
208
|
-
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(
|
208
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: "", metadata: "", hostports: nil, mutual_tls: nil, tls_termination: nil) ⇒ NgrokAPI::Models::HTTPSEdge </a>
|
209
209
|
|
210
210
|
|
211
211
|
|
@@ -220,7 +220,7 @@
|
|
220
220
|
|
221
221
|
|
222
222
|
<span class="summary_desc"><div class='inline'>
|
223
|
-
<p>Create
|
223
|
+
<p>Create an HTTPS Edge.</p>
|
224
224
|
</div></span>
|
225
225
|
|
226
226
|
</li>
|
@@ -244,7 +244,7 @@
|
|
244
244
|
|
245
245
|
|
246
246
|
<span class="summary_desc"><div class='inline'>
|
247
|
-
<p>Delete an
|
247
|
+
<p>Delete an HTTPS Edge by ID.</p>
|
248
248
|
</div></span>
|
249
249
|
|
250
250
|
</li>
|
@@ -268,7 +268,7 @@
|
|
268
268
|
|
269
269
|
|
270
270
|
<span class="summary_desc"><div class='inline'>
|
271
|
-
<p>Delete an
|
271
|
+
<p>Delete an HTTPS Edge by ID Throws an exception if API error.</p>
|
272
272
|
</div></span>
|
273
273
|
|
274
274
|
</li>
|
@@ -277,7 +277,7 @@
|
|
277
277
|
<li class="public ">
|
278
278
|
<span class="summary_signature">
|
279
279
|
|
280
|
-
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: "") ⇒ NgrokAPI::Models::
|
280
|
+
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: "") ⇒ NgrokAPI::Models::HTTPSEdge </a>
|
281
281
|
|
282
282
|
|
283
283
|
|
@@ -292,7 +292,7 @@
|
|
292
292
|
|
293
293
|
|
294
294
|
<span class="summary_desc"><div class='inline'>
|
295
|
-
<p>Get
|
295
|
+
<p>Get an HTTPS Edge by ID.</p>
|
296
296
|
</div></span>
|
297
297
|
|
298
298
|
</li>
|
@@ -301,7 +301,7 @@
|
|
301
301
|
<li class="public ">
|
302
302
|
<span class="summary_signature">
|
303
303
|
|
304
|
-
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: "") ⇒ NgrokAPI::Models::
|
304
|
+
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: "") ⇒ NgrokAPI::Models::HTTPSEdge </a>
|
305
305
|
|
306
306
|
|
307
307
|
|
@@ -316,7 +316,7 @@
|
|
316
316
|
|
317
317
|
|
318
318
|
<span class="summary_desc"><div class='inline'>
|
319
|
-
<p>Get
|
319
|
+
<p>Get an HTTPS Edge by ID Throws an exception if API error.</p>
|
320
320
|
</div></span>
|
321
321
|
|
322
322
|
</li>
|
@@ -325,7 +325,7 @@
|
|
325
325
|
<li class="public ">
|
326
326
|
<span class="summary_signature">
|
327
327
|
|
328
|
-
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒
|
328
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒ EdgesHTTPSClient </a>
|
329
329
|
|
330
330
|
|
331
331
|
|
@@ -342,7 +342,7 @@
|
|
342
342
|
|
343
343
|
|
344
344
|
<span class="summary_desc"><div class='inline'>
|
345
|
-
<p>A new instance of
|
345
|
+
<p>A new instance of EdgesHTTPSClient.</p>
|
346
346
|
</div></span>
|
347
347
|
|
348
348
|
</li>
|
@@ -366,7 +366,7 @@
|
|
366
366
|
|
367
367
|
|
368
368
|
<span class="summary_desc"><div class='inline'>
|
369
|
-
<p>
|
369
|
+
<p>Returns a list of all HTTPS Edges on this account.</p>
|
370
370
|
</div></span>
|
371
371
|
|
372
372
|
</li>
|
@@ -390,7 +390,7 @@
|
|
390
390
|
|
391
391
|
|
392
392
|
<span class="summary_desc"><div class='inline'>
|
393
|
-
<p>
|
393
|
+
<p>Returns a list of all HTTPS Edges on this account Throws an exception if API error.</p>
|
394
394
|
</div></span>
|
395
395
|
|
396
396
|
</li>
|
@@ -399,7 +399,7 @@
|
|
399
399
|
<li class="public ">
|
400
400
|
<span class="summary_signature">
|
401
401
|
|
402
|
-
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "",
|
402
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", description: nil, metadata: nil, hostports: nil, mutual_tls: nil, tls_termination: nil) ⇒ NgrokAPI::Models::HTTPSEdge </a>
|
403
403
|
|
404
404
|
|
405
405
|
|
@@ -414,7 +414,7 @@
|
|
414
414
|
|
415
415
|
|
416
416
|
<span class="summary_desc"><div class='inline'>
|
417
|
-
<p>
|
417
|
+
<p>Updates an HTTPS Edge by ID.</p>
|
418
418
|
</div></span>
|
419
419
|
|
420
420
|
</li>
|
@@ -423,7 +423,7 @@
|
|
423
423
|
<li class="public ">
|
424
424
|
<span class="summary_signature">
|
425
425
|
|
426
|
-
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: "",
|
426
|
+
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: "", description: nil, metadata: nil, hostports: nil, mutual_tls: nil, tls_termination: nil) ⇒ NgrokAPI::Models::HTTPSEdge </a>
|
427
427
|
|
428
428
|
|
429
429
|
|
@@ -438,7 +438,7 @@
|
|
438
438
|
|
439
439
|
|
440
440
|
<span class="summary_desc"><div class='inline'>
|
441
|
-
<p>
|
441
|
+
<p>Updates an HTTPS Edge by ID.</p>
|
442
442
|
</div></span>
|
443
443
|
|
444
444
|
</li>
|
@@ -453,7 +453,7 @@
|
|
453
453
|
<div class="method_details first">
|
454
454
|
<h3 class="signature first" id="initialize-instance_method">
|
455
455
|
|
456
|
-
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::
|
456
|
+
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::EdgesHTTPSClient (class)">EdgesHTTPSClient</a></span></tt>
|
457
457
|
|
458
458
|
|
459
459
|
|
@@ -462,7 +462,7 @@
|
|
462
462
|
</h3><div class="docstring">
|
463
463
|
<div class="discussion">
|
464
464
|
|
465
|
-
<p>Returns a new instance of
|
465
|
+
<p>Returns a new instance of EdgesHTTPSClient.</p>
|
466
466
|
|
467
467
|
|
468
468
|
</div>
|
@@ -481,7 +481,7 @@
|
|
481
481
|
17</pre>
|
482
482
|
</td>
|
483
483
|
<td>
|
484
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/
|
484
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_client.rb', line 15</span>
|
485
485
|
|
486
486
|
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='rparen'>)</span>
|
487
487
|
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
@@ -529,7 +529,7 @@
|
|
529
529
|
15</pre>
|
530
530
|
</td>
|
531
531
|
<td>
|
532
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/
|
532
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_client.rb', line 13</span>
|
533
533
|
|
534
534
|
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
535
535
|
<span class='ivar'>@client</span>
|
@@ -549,7 +549,7 @@
|
|
549
549
|
<div class="method_details first">
|
550
550
|
<h3 class="signature first" id="create-instance_method">
|
551
551
|
|
552
|
-
#<strong>create</strong>(
|
552
|
+
#<strong>create</strong>(description: "", metadata: "", hostports: nil, mutual_tls: nil, tls_termination: nil) ⇒ <tt><span class='object_link'><a href="../Models/HTTPSEdge.html" title="NgrokAPI::Models::HTTPSEdge (class)">NgrokAPI::Models::HTTPSEdge</a></span></tt>
|
553
553
|
|
554
554
|
|
555
555
|
|
@@ -558,9 +558,9 @@
|
|
558
558
|
</h3><div class="docstring">
|
559
559
|
<div class="discussion">
|
560
560
|
|
561
|
-
<p>Create
|
561
|
+
<p>Create an HTTPS Edge</p>
|
562
562
|
|
563
|
-
<p><a href="https://ngrok.com/docs/api#api-
|
563
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-https-create">ngrok.com/docs/api#api-edges-https-create</a></p>
|
564
564
|
|
565
565
|
|
566
566
|
</div>
|
@@ -571,7 +571,7 @@
|
|
571
571
|
|
572
572
|
<li>
|
573
573
|
|
574
|
-
<span class='name'>
|
574
|
+
<span class='name'>description</span>
|
575
575
|
|
576
576
|
|
577
577
|
<span class='type'>(<tt>string</tt>)</span>
|
@@ -582,14 +582,14 @@
|
|
582
582
|
|
583
583
|
—
|
584
584
|
<div class='inline'>
|
585
|
-
<p>
|
585
|
+
<p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
|
586
586
|
</div>
|
587
587
|
|
588
588
|
</li>
|
589
589
|
|
590
590
|
<li>
|
591
591
|
|
592
|
-
<span class='name'>
|
592
|
+
<span class='name'>metadata</span>
|
593
593
|
|
594
594
|
|
595
595
|
<span class='type'>(<tt>string</tt>)</span>
|
@@ -600,80 +600,57 @@
|
|
600
600
|
|
601
601
|
—
|
602
602
|
<div class='inline'>
|
603
|
-
<p>
|
603
|
+
<p>arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes.</p>
|
604
604
|
</div>
|
605
605
|
|
606
606
|
</li>
|
607
607
|
|
608
608
|
<li>
|
609
609
|
|
610
|
-
<span class='name'>
|
610
|
+
<span class='name'>hostports</span>
|
611
611
|
|
612
612
|
|
613
613
|
<span class='type'>(<tt>List<string></tt>)</span>
|
614
614
|
|
615
615
|
|
616
|
-
<em class="default">(defaults to: <tt>
|
616
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
617
617
|
|
618
618
|
|
619
619
|
—
|
620
620
|
<div class='inline'>
|
621
|
-
<p>
|
621
|
+
<p>hostports served by this edge</p>
|
622
622
|
</div>
|
623
623
|
|
624
624
|
</li>
|
625
625
|
|
626
626
|
<li>
|
627
627
|
|
628
|
-
<span class='name'>
|
628
|
+
<span class='name'>mutual_tls</span>
|
629
629
|
|
630
630
|
|
631
|
-
<span class='type'>(<tt>
|
631
|
+
<span class='type'>(<tt>EndpointMutualTLSMutate</tt>)</span>
|
632
632
|
|
633
633
|
|
634
|
-
<em class="default">(defaults to: <tt
|
635
|
-
|
636
|
-
|
637
|
-
—
|
638
|
-
<div class='inline'>
|
639
|
-
<p>The protocol that determines which events will be collected. Supported values are <code>tcp_connection_closed</code> and <code>http_request_complete</code>.</p>
|
640
|
-
</div>
|
641
|
-
|
642
|
-
</li>
|
643
|
-
|
644
|
-
<li>
|
645
|
-
|
646
|
-
<span class='name'>destination_ids</span>
|
647
|
-
|
648
|
-
|
649
|
-
<span class='type'>(<tt>List<string></tt>)</span>
|
650
|
-
|
651
|
-
|
652
|
-
<em class="default">(defaults to: <tt>[]</tt>)</em>
|
634
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
653
635
|
|
654
636
|
|
655
637
|
—
|
656
638
|
<div class='inline'>
|
657
|
-
<p>
|
639
|
+
<p>edge modules</p>
|
658
640
|
</div>
|
659
641
|
|
660
642
|
</li>
|
661
643
|
|
662
644
|
<li>
|
663
645
|
|
664
|
-
<span class='name'>
|
665
|
-
|
646
|
+
<span class='name'>tls_termination</span>
|
666
647
|
|
667
|
-
<span class='type'>(<tt>float64</tt>)</span>
|
668
648
|
|
649
|
+
<span class='type'>(<tt>EndpointTLSTerminationAtEdge</tt>)</span>
|
669
650
|
|
670
|
-
<em class="default">(defaults to: <tt>0</tt>)</em>
|
671
651
|
|
652
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
672
653
|
|
673
|
-
—
|
674
|
-
<div class='inline'>
|
675
|
-
<p>The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events.</p>
|
676
|
-
</div>
|
677
654
|
|
678
655
|
</li>
|
679
656
|
|
@@ -685,7 +662,7 @@
|
|
685
662
|
<li>
|
686
663
|
|
687
664
|
|
688
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
665
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/HTTPSEdge.html" title="NgrokAPI::Models::HTTPSEdge (class)">NgrokAPI::Models::HTTPSEdge</a></span></tt>)</span>
|
689
666
|
|
690
667
|
|
691
668
|
|
@@ -704,6 +681,8 @@
|
|
704
681
|
<pre class="lines">
|
705
682
|
|
706
683
|
|
684
|
+
30
|
685
|
+
31
|
707
686
|
32
|
708
687
|
33
|
709
688
|
34
|
@@ -714,27 +693,23 @@
|
|
714
693
|
39
|
715
694
|
40
|
716
695
|
41
|
717
|
-
42
|
718
|
-
43
|
719
|
-
44
|
720
|
-
45</pre>
|
696
|
+
42</pre>
|
721
697
|
</td>
|
722
698
|
<td>
|
723
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/
|
699
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_client.rb', line 30</span>
|
724
700
|
|
725
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>
|
726
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/
|
701
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>hostports:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>mutual_tls:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>tls_termination:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
702
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https</span><span class='tstring_end'>'</span></span>
|
727
703
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
728
704
|
<span class='rbrace'>}</span>
|
729
705
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
730
|
-
<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>
|
731
706
|
<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>
|
732
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:
|
733
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:
|
734
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:
|
735
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:
|
707
|
+
<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>
|
708
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:hostports</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_hostports'>hostports</span> <span class='kw'>if</span> <span class='id identifier rubyid_hostports'>hostports</span>
|
709
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:mutual_tls</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span> <span class='kw'>if</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span>
|
710
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:tls_termination</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span> <span class='kw'>if</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span>
|
736
711
|
<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>
|
737
|
-
<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/
|
712
|
+
<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/HTTPSEdge.html" title="NgrokAPI::Models::HTTPSEdge (class)">HTTPSEdge</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/HTTPSEdge.html#initialize-instance_method" title="NgrokAPI::Models::HTTPSEdge#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
738
713
|
<span class='kw'>end</span></pre>
|
739
714
|
</td>
|
740
715
|
</tr>
|
@@ -753,9 +728,9 @@
|
|
753
728
|
</h3><div class="docstring">
|
754
729
|
<div class="discussion">
|
755
730
|
|
756
|
-
<p>Delete an
|
731
|
+
<p>Delete an HTTPS Edge by ID</p>
|
757
732
|
|
758
|
-
<p><a href="https://ngrok.com/docs/api#api-
|
733
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-https-delete">ngrok.com/docs/api#api-edges-https-delete</a></p>
|
759
734
|
|
760
735
|
|
761
736
|
</div>
|
@@ -809,19 +784,19 @@
|
|
809
784
|
<pre class="lines">
|
810
785
|
|
811
786
|
|
812
|
-
|
813
|
-
|
814
|
-
|
815
|
-
|
816
|
-
|
817
|
-
|
818
|
-
|
787
|
+
202
|
788
|
+
203
|
789
|
+
204
|
790
|
+
205
|
791
|
+
206
|
792
|
+
207
|
793
|
+
208</pre>
|
819
794
|
</td>
|
820
795
|
<td>
|
821
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/
|
796
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_client.rb', line 202</span>
|
822
797
|
|
823
798
|
<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>
|
824
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/
|
799
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{id}</span><span class='tstring_end'>'</span></span>
|
825
800
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
826
801
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
827
802
|
<span class='rbrace'>}</span>
|
@@ -844,9 +819,9 @@
|
|
844
819
|
</h3><div class="docstring">
|
845
820
|
<div class="discussion">
|
846
821
|
|
847
|
-
<p>Delete an
|
822
|
+
<p>Delete an HTTPS Edge by ID Throws an exception if API error.</p>
|
848
823
|
|
849
|
-
<p><a href="https://ngrok.com/docs/api#api-
|
824
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-https-delete">ngrok.com/docs/api#api-edges-https-delete</a></p>
|
850
825
|
|
851
826
|
|
852
827
|
</div>
|
@@ -900,19 +875,19 @@
|
|
900
875
|
<pre class="lines">
|
901
876
|
|
902
877
|
|
903
|
-
|
904
|
-
|
905
|
-
|
906
|
-
|
907
|
-
|
908
|
-
|
909
|
-
|
878
|
+
218
|
879
|
+
219
|
880
|
+
220
|
881
|
+
221
|
882
|
+
222
|
883
|
+
223
|
884
|
+
224</pre>
|
910
885
|
</td>
|
911
886
|
<td>
|
912
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/
|
887
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_client.rb', line 218</span>
|
913
888
|
|
914
889
|
<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>
|
915
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/
|
890
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{id}</span><span class='tstring_end'>'</span></span>
|
916
891
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
917
892
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
918
893
|
<span class='rbrace'>}</span>
|
@@ -926,7 +901,7 @@
|
|
926
901
|
<div class="method_details ">
|
927
902
|
<h3 class="signature " id="get-instance_method">
|
928
903
|
|
929
|
-
#<strong>get</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/
|
904
|
+
#<strong>get</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/HTTPSEdge.html" title="NgrokAPI::Models::HTTPSEdge (class)">NgrokAPI::Models::HTTPSEdge</a></span></tt>
|
930
905
|
|
931
906
|
|
932
907
|
|
@@ -935,9 +910,9 @@
|
|
935
910
|
</h3><div class="docstring">
|
936
911
|
<div class="discussion">
|
937
912
|
|
938
|
-
<p>Get
|
913
|
+
<p>Get an HTTPS Edge by ID</p>
|
939
914
|
|
940
|
-
<p><a href="https://ngrok.com/docs/api#api-
|
915
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-https-get">ngrok.com/docs/api#api-edges-https-get</a></p>
|
941
916
|
|
942
917
|
|
943
918
|
</div>
|
@@ -972,7 +947,7 @@
|
|
972
947
|
<li>
|
973
948
|
|
974
949
|
|
975
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
950
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/HTTPSEdge.html" title="NgrokAPI::Models::HTTPSEdge (class)">NgrokAPI::Models::HTTPSEdge</a></span></tt>)</span>
|
976
951
|
|
977
952
|
|
978
953
|
|
@@ -991,27 +966,27 @@
|
|
991
966
|
<pre class="lines">
|
992
967
|
|
993
968
|
|
994
|
-
|
995
|
-
|
996
|
-
|
997
|
-
|
998
|
-
|
999
|
-
|
1000
|
-
|
1001
|
-
|
1002
|
-
|
969
|
+
51
|
970
|
+
52
|
971
|
+
53
|
972
|
+
54
|
973
|
+
55
|
974
|
+
56
|
975
|
+
57
|
976
|
+
58
|
977
|
+
59</pre>
|
1003
978
|
</td>
|
1004
979
|
<td>
|
1005
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/
|
980
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_client.rb', line 51</span>
|
1006
981
|
|
1007
982
|
<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>
|
1008
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/
|
983
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{id}</span><span class='tstring_end'>'</span></span>
|
1009
984
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1010
985
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1011
986
|
<span class='rbrace'>}</span>
|
1012
987
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
1013
988
|
<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>
|
1014
|
-
<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/
|
989
|
+
<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/HTTPSEdge.html" title="NgrokAPI::Models::HTTPSEdge (class)">HTTPSEdge</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/HTTPSEdge.html#initialize-instance_method" title="NgrokAPI::Models::HTTPSEdge#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
1015
990
|
<span class='kw'>end</span></pre>
|
1016
991
|
</td>
|
1017
992
|
</tr>
|
@@ -1021,7 +996,7 @@
|
|
1021
996
|
<div class="method_details ">
|
1022
997
|
<h3 class="signature " id="get!-instance_method">
|
1023
998
|
|
1024
|
-
#<strong>get!</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/
|
999
|
+
#<strong>get!</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/HTTPSEdge.html" title="NgrokAPI::Models::HTTPSEdge (class)">NgrokAPI::Models::HTTPSEdge</a></span></tt>
|
1025
1000
|
|
1026
1001
|
|
1027
1002
|
|
@@ -1030,9 +1005,9 @@
|
|
1030
1005
|
</h3><div class="docstring">
|
1031
1006
|
<div class="discussion">
|
1032
1007
|
|
1033
|
-
<p>Get
|
1008
|
+
<p>Get an HTTPS Edge by ID Throws an exception if API error.</p>
|
1034
1009
|
|
1035
|
-
<p><a href="https://ngrok.com/docs/api#api-
|
1010
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-https-get">ngrok.com/docs/api#api-edges-https-get</a></p>
|
1036
1011
|
|
1037
1012
|
|
1038
1013
|
</div>
|
@@ -1067,7 +1042,7 @@
|
|
1067
1042
|
<li>
|
1068
1043
|
|
1069
1044
|
|
1070
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
1045
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/HTTPSEdge.html" title="NgrokAPI::Models::HTTPSEdge (class)">NgrokAPI::Models::HTTPSEdge</a></span></tt>)</span>
|
1071
1046
|
|
1072
1047
|
|
1073
1048
|
|
@@ -1086,27 +1061,27 @@
|
|
1086
1061
|
<pre class="lines">
|
1087
1062
|
|
1088
1063
|
|
1089
|
-
|
1090
|
-
|
1091
|
-
|
1092
|
-
|
1093
|
-
|
1094
|
-
|
1095
|
-
|
1096
|
-
|
1097
|
-
|
1064
|
+
69
|
1065
|
+
70
|
1066
|
+
71
|
1067
|
+
72
|
1068
|
+
73
|
1069
|
+
74
|
1070
|
+
75
|
1071
|
+
76
|
1072
|
+
77</pre>
|
1098
1073
|
</td>
|
1099
1074
|
<td>
|
1100
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/
|
1075
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_client.rb', line 69</span>
|
1101
1076
|
|
1102
1077
|
<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>
|
1103
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/
|
1078
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{id}</span><span class='tstring_end'>'</span></span>
|
1104
1079
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1105
1080
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1106
1081
|
<span class='rbrace'>}</span>
|
1107
1082
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
1108
1083
|
<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>
|
1109
|
-
<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/
|
1084
|
+
<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/HTTPSEdge.html" title="NgrokAPI::Models::HTTPSEdge (class)">HTTPSEdge</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/HTTPSEdge.html#initialize-instance_method" title="NgrokAPI::Models::HTTPSEdge#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
1110
1085
|
<span class='kw'>end</span></pre>
|
1111
1086
|
</td>
|
1112
1087
|
</tr>
|
@@ -1125,9 +1100,9 @@
|
|
1125
1100
|
</h3><div class="docstring">
|
1126
1101
|
<div class="discussion">
|
1127
1102
|
|
1128
|
-
<p>
|
1103
|
+
<p>Returns a list of all HTTPS Edges on this account</p>
|
1129
1104
|
|
1130
|
-
<p><a href="https://ngrok.com/docs/api#api-
|
1105
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-https-list">ngrok.com/docs/api#api-edges-https-list</a></p>
|
1131
1106
|
|
1132
1107
|
|
1133
1108
|
</div>
|
@@ -1207,25 +1182,25 @@
|
|
1207
1182
|
<pre class="lines">
|
1208
1183
|
|
1209
1184
|
|
1210
|
-
|
1211
|
-
|
1212
|
-
|
1213
|
-
|
1214
|
-
|
1215
|
-
|
1216
|
-
|
1217
|
-
|
1218
|
-
|
1219
|
-
|
1220
|
-
|
1221
|
-
|
1222
|
-
|
1223
|
-
|
1224
|
-
|
1225
|
-
|
1185
|
+
88
|
1186
|
+
89
|
1187
|
+
90
|
1188
|
+
91
|
1189
|
+
92
|
1190
|
+
93
|
1191
|
+
94
|
1192
|
+
95
|
1193
|
+
96
|
1194
|
+
97
|
1195
|
+
98
|
1196
|
+
99
|
1197
|
+
100
|
1198
|
+
101
|
1199
|
+
102
|
1200
|
+
103</pre>
|
1226
1201
|
</td>
|
1227
1202
|
<td>
|
1228
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/
|
1203
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_client.rb', line 88</span>
|
1229
1204
|
|
1230
1205
|
<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>
|
1231
1206
|
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
@@ -1233,14 +1208,14 @@
|
|
1233
1208
|
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
1234
1209
|
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
1235
1210
|
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
1236
|
-
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::
|
1211
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EdgesHTTPSClient::PATH (constant)">PATH</a></span></span>
|
1237
1212
|
<span class='rparen'>)</span>
|
1238
1213
|
|
1239
1214
|
<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>
|
1240
1215
|
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
1241
1216
|
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
1242
|
-
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::
|
1243
|
-
<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/
|
1217
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EdgesHTTPSClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
1218
|
+
<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/HTTPSEdge.html" title="NgrokAPI::Models::HTTPSEdge (class)">HTTPSEdge</a></span></span>
|
1244
1219
|
<span class='rparen'>)</span>
|
1245
1220
|
<span class='kw'>end</span></pre>
|
1246
1221
|
</td>
|
@@ -1260,9 +1235,9 @@
|
|
1260
1235
|
</h3><div class="docstring">
|
1261
1236
|
<div class="discussion">
|
1262
1237
|
|
1263
|
-
<p>
|
1238
|
+
<p>Returns a list of all HTTPS Edges on this account Throws an exception if API error.</p>
|
1264
1239
|
|
1265
|
-
<p><a href="https://ngrok.com/docs/api#api-
|
1240
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-https-list">ngrok.com/docs/api#api-edges-https-list</a></p>
|
1266
1241
|
|
1267
1242
|
|
1268
1243
|
</div>
|
@@ -1342,27 +1317,27 @@
|
|
1342
1317
|
<pre class="lines">
|
1343
1318
|
|
1344
1319
|
|
1345
|
-
|
1346
|
-
|
1347
|
-
|
1348
|
-
|
1349
|
-
|
1350
|
-
|
1351
|
-
|
1352
|
-
|
1353
|
-
|
1354
|
-
|
1355
|
-
|
1356
|
-
|
1357
|
-
|
1358
|
-
|
1359
|
-
|
1360
|
-
|
1361
|
-
|
1362
|
-
|
1320
|
+
115
|
1321
|
+
116
|
1322
|
+
117
|
1323
|
+
118
|
1324
|
+
119
|
1325
|
+
120
|
1326
|
+
121
|
1327
|
+
122
|
1328
|
+
123
|
1329
|
+
124
|
1330
|
+
125
|
1331
|
+
126
|
1332
|
+
127
|
1333
|
+
128
|
1334
|
+
129
|
1335
|
+
130
|
1336
|
+
131
|
1337
|
+
132</pre>
|
1363
1338
|
</td>
|
1364
1339
|
<td>
|
1365
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/
|
1340
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_client.rb', line 115</span>
|
1366
1341
|
|
1367
1342
|
<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>
|
1368
1343
|
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
@@ -1371,14 +1346,14 @@
|
|
1371
1346
|
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
1372
1347
|
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
1373
1348
|
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
1374
|
-
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::
|
1349
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EdgesHTTPSClient::PATH (constant)">PATH</a></span></span>
|
1375
1350
|
<span class='rparen'>)</span>
|
1376
1351
|
|
1377
1352
|
<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>
|
1378
1353
|
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
1379
1354
|
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
1380
|
-
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::
|
1381
|
-
<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/
|
1355
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EdgesHTTPSClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
1356
|
+
<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/HTTPSEdge.html" title="NgrokAPI::Models::HTTPSEdge (class)">HTTPSEdge</a></span></span><span class='comma'>,</span>
|
1382
1357
|
<span class='label'>danger:</span> <span class='kw'>true</span>
|
1383
1358
|
<span class='rparen'>)</span>
|
1384
1359
|
<span class='kw'>end</span></pre>
|
@@ -1390,7 +1365,7 @@
|
|
1390
1365
|
<div class="method_details ">
|
1391
1366
|
<h3 class="signature " id="update-instance_method">
|
1392
1367
|
|
1393
|
-
#<strong>update</strong>(id: "",
|
1368
|
+
#<strong>update</strong>(id: "", description: nil, metadata: nil, hostports: nil, mutual_tls: nil, tls_termination: nil) ⇒ <tt><span class='object_link'><a href="../Models/HTTPSEdge.html" title="NgrokAPI::Models::HTTPSEdge (class)">NgrokAPI::Models::HTTPSEdge</a></span></tt>
|
1394
1369
|
|
1395
1370
|
|
1396
1371
|
|
@@ -1399,9 +1374,9 @@
|
|
1399
1374
|
</h3><div class="docstring">
|
1400
1375
|
<div class="discussion">
|
1401
1376
|
|
1402
|
-
<p>
|
1377
|
+
<p>Updates an HTTPS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.</p>
|
1403
1378
|
|
1404
|
-
<p><a href="https://ngrok.com/docs/api#api-
|
1379
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-https-update">ngrok.com/docs/api#api-edges-https-update</a></p>
|
1405
1380
|
|
1406
1381
|
|
1407
1382
|
</div>
|
@@ -1423,14 +1398,14 @@
|
|
1423
1398
|
|
1424
1399
|
—
|
1425
1400
|
<div class='inline'>
|
1426
|
-
<p>
|
1401
|
+
<p>unique identifier of this edge</p>
|
1427
1402
|
</div>
|
1428
1403
|
|
1429
1404
|
</li>
|
1430
1405
|
|
1431
1406
|
<li>
|
1432
1407
|
|
1433
|
-
<span class='name'>
|
1408
|
+
<span class='name'>description</span>
|
1434
1409
|
|
1435
1410
|
|
1436
1411
|
<span class='type'>(<tt>string</tt>)</span>
|
@@ -1441,14 +1416,14 @@
|
|
1441
1416
|
|
1442
1417
|
—
|
1443
1418
|
<div class='inline'>
|
1444
|
-
<p>
|
1419
|
+
<p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
|
1445
1420
|
</div>
|
1446
1421
|
|
1447
1422
|
</li>
|
1448
1423
|
|
1449
1424
|
<li>
|
1450
1425
|
|
1451
|
-
<span class='name'>
|
1426
|
+
<span class='name'>metadata</span>
|
1452
1427
|
|
1453
1428
|
|
1454
1429
|
<span class='type'>(<tt>string</tt>)</span>
|
@@ -1459,14 +1434,14 @@
|
|
1459
1434
|
|
1460
1435
|
—
|
1461
1436
|
<div class='inline'>
|
1462
|
-
<p>
|
1437
|
+
<p>arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes.</p>
|
1463
1438
|
</div>
|
1464
1439
|
|
1465
1440
|
</li>
|
1466
1441
|
|
1467
1442
|
<li>
|
1468
1443
|
|
1469
|
-
<span class='name'>
|
1444
|
+
<span class='name'>hostports</span>
|
1470
1445
|
|
1471
1446
|
|
1472
1447
|
<span class='type'>(<tt>List<string></tt>)</span>
|
@@ -1477,17 +1452,17 @@
|
|
1477
1452
|
|
1478
1453
|
—
|
1479
1454
|
<div class='inline'>
|
1480
|
-
<p>
|
1455
|
+
<p>hostports served by this edge</p>
|
1481
1456
|
</div>
|
1482
1457
|
|
1483
1458
|
</li>
|
1484
1459
|
|
1485
1460
|
<li>
|
1486
1461
|
|
1487
|
-
<span class='name'>
|
1462
|
+
<span class='name'>mutual_tls</span>
|
1488
1463
|
|
1489
1464
|
|
1490
|
-
<span class='type'>(<tt>
|
1465
|
+
<span class='type'>(<tt>EndpointMutualTLSMutate</tt>)</span>
|
1491
1466
|
|
1492
1467
|
|
1493
1468
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -1495,27 +1470,22 @@
|
|
1495
1470
|
|
1496
1471
|
—
|
1497
1472
|
<div class='inline'>
|
1498
|
-
<p>
|
1473
|
+
<p>edge modules</p>
|
1499
1474
|
</div>
|
1500
1475
|
|
1501
1476
|
</li>
|
1502
1477
|
|
1503
1478
|
<li>
|
1504
1479
|
|
1505
|
-
<span class='name'>
|
1480
|
+
<span class='name'>tls_termination</span>
|
1506
1481
|
|
1507
1482
|
|
1508
|
-
<span class='type'>(<tt>
|
1483
|
+
<span class='type'>(<tt>EndpointTLSTerminationAtEdge</tt>)</span>
|
1509
1484
|
|
1510
1485
|
|
1511
1486
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1512
1487
|
|
1513
1488
|
|
1514
|
-
—
|
1515
|
-
<div class='inline'>
|
1516
|
-
<p>The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events.</p>
|
1517
|
-
</div>
|
1518
|
-
|
1519
1489
|
</li>
|
1520
1490
|
|
1521
1491
|
</ul>
|
@@ -1526,7 +1496,7 @@
|
|
1526
1496
|
<li>
|
1527
1497
|
|
1528
1498
|
|
1529
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
1499
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/HTTPSEdge.html" title="NgrokAPI::Models::HTTPSEdge (class)">NgrokAPI::Models::HTTPSEdge</a></span></tt>)</span>
|
1530
1500
|
|
1531
1501
|
|
1532
1502
|
|
@@ -1545,37 +1515,37 @@
|
|
1545
1515
|
<pre class="lines">
|
1546
1516
|
|
1547
1517
|
|
1548
|
-
|
1549
|
-
|
1550
|
-
|
1551
|
-
|
1552
|
-
|
1553
|
-
|
1554
|
-
|
1555
|
-
|
1556
|
-
|
1557
|
-
|
1558
|
-
|
1559
|
-
|
1560
|
-
|
1561
|
-
|
1518
|
+
149
|
1519
|
+
150
|
1520
|
+
151
|
1521
|
+
152
|
1522
|
+
153
|
1523
|
+
154
|
1524
|
+
155
|
1525
|
+
156
|
1526
|
+
157
|
1527
|
+
158
|
1528
|
+
159
|
1529
|
+
160
|
1530
|
+
161
|
1531
|
+
162</pre>
|
1562
1532
|
</td>
|
1563
1533
|
<td>
|
1564
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/
|
1534
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_client.rb', line 149</span>
|
1565
1535
|
|
1566
|
-
<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'>
|
1567
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/
|
1536
|
+
<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'>hostports:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>mutual_tls:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>tls_termination:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
1537
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{id}</span><span class='tstring_end'>'</span></span>
|
1568
1538
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1569
1539
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1570
1540
|
<span class='rbrace'>}</span>
|
1571
1541
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
1572
|
-
<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>
|
1573
1542
|
<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>
|
1574
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:
|
1575
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:
|
1576
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:
|
1543
|
+
<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>
|
1544
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:hostports</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_hostports'>hostports</span> <span class='kw'>if</span> <span class='id identifier rubyid_hostports'>hostports</span>
|
1545
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:mutual_tls</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span> <span class='kw'>if</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span>
|
1546
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:tls_termination</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span> <span class='kw'>if</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span>
|
1577
1547
|
<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>
|
1578
|
-
<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/
|
1548
|
+
<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/HTTPSEdge.html" title="NgrokAPI::Models::HTTPSEdge (class)">HTTPSEdge</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/HTTPSEdge.html#initialize-instance_method" title="NgrokAPI::Models::HTTPSEdge#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
1579
1549
|
<span class='kw'>end</span></pre>
|
1580
1550
|
</td>
|
1581
1551
|
</tr>
|
@@ -1585,7 +1555,7 @@
|
|
1585
1555
|
<div class="method_details ">
|
1586
1556
|
<h3 class="signature " id="update!-instance_method">
|
1587
1557
|
|
1588
|
-
#<strong>update!</strong>(id: "",
|
1558
|
+
#<strong>update!</strong>(id: "", description: nil, metadata: nil, hostports: nil, mutual_tls: nil, tls_termination: nil) ⇒ <tt><span class='object_link'><a href="../Models/HTTPSEdge.html" title="NgrokAPI::Models::HTTPSEdge (class)">NgrokAPI::Models::HTTPSEdge</a></span></tt>
|
1589
1559
|
|
1590
1560
|
|
1591
1561
|
|
@@ -1594,9 +1564,9 @@
|
|
1594
1564
|
</h3><div class="docstring">
|
1595
1565
|
<div class="discussion">
|
1596
1566
|
|
1597
|
-
<p>
|
1567
|
+
<p>Updates an HTTPS Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API. Throws an exception if API error.</p>
|
1598
1568
|
|
1599
|
-
<p><a href="https://ngrok.com/docs/api#api-
|
1569
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-https-update">ngrok.com/docs/api#api-edges-https-update</a></p>
|
1600
1570
|
|
1601
1571
|
|
1602
1572
|
</div>
|
@@ -1618,14 +1588,14 @@
|
|
1618
1588
|
|
1619
1589
|
—
|
1620
1590
|
<div class='inline'>
|
1621
|
-
<p>
|
1591
|
+
<p>unique identifier of this edge</p>
|
1622
1592
|
</div>
|
1623
1593
|
|
1624
1594
|
</li>
|
1625
1595
|
|
1626
1596
|
<li>
|
1627
1597
|
|
1628
|
-
<span class='name'>
|
1598
|
+
<span class='name'>description</span>
|
1629
1599
|
|
1630
1600
|
|
1631
1601
|
<span class='type'>(<tt>string</tt>)</span>
|
@@ -1636,14 +1606,14 @@
|
|
1636
1606
|
|
1637
1607
|
—
|
1638
1608
|
<div class='inline'>
|
1639
|
-
<p>
|
1609
|
+
<p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
|
1640
1610
|
</div>
|
1641
1611
|
|
1642
1612
|
</li>
|
1643
1613
|
|
1644
1614
|
<li>
|
1645
1615
|
|
1646
|
-
<span class='name'>
|
1616
|
+
<span class='name'>metadata</span>
|
1647
1617
|
|
1648
1618
|
|
1649
1619
|
<span class='type'>(<tt>string</tt>)</span>
|
@@ -1654,14 +1624,14 @@
|
|
1654
1624
|
|
1655
1625
|
—
|
1656
1626
|
<div class='inline'>
|
1657
|
-
<p>
|
1627
|
+
<p>arbitrary user-defined machine-readable data of this edge; optional, max 4096 bytes.</p>
|
1658
1628
|
</div>
|
1659
1629
|
|
1660
1630
|
</li>
|
1661
1631
|
|
1662
1632
|
<li>
|
1663
1633
|
|
1664
|
-
<span class='name'>
|
1634
|
+
<span class='name'>hostports</span>
|
1665
1635
|
|
1666
1636
|
|
1667
1637
|
<span class='type'>(<tt>List<string></tt>)</span>
|
@@ -1672,17 +1642,17 @@
|
|
1672
1642
|
|
1673
1643
|
—
|
1674
1644
|
<div class='inline'>
|
1675
|
-
<p>
|
1645
|
+
<p>hostports served by this edge</p>
|
1676
1646
|
</div>
|
1677
1647
|
|
1678
1648
|
</li>
|
1679
1649
|
|
1680
1650
|
<li>
|
1681
1651
|
|
1682
|
-
<span class='name'>
|
1652
|
+
<span class='name'>mutual_tls</span>
|
1683
1653
|
|
1684
1654
|
|
1685
|
-
<span class='type'>(<tt>
|
1655
|
+
<span class='type'>(<tt>EndpointMutualTLSMutate</tt>)</span>
|
1686
1656
|
|
1687
1657
|
|
1688
1658
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
@@ -1690,27 +1660,22 @@
|
|
1690
1660
|
|
1691
1661
|
—
|
1692
1662
|
<div class='inline'>
|
1693
|
-
<p>
|
1663
|
+
<p>edge modules</p>
|
1694
1664
|
</div>
|
1695
1665
|
|
1696
1666
|
</li>
|
1697
1667
|
|
1698
1668
|
<li>
|
1699
1669
|
|
1700
|
-
<span class='name'>
|
1670
|
+
<span class='name'>tls_termination</span>
|
1701
1671
|
|
1702
1672
|
|
1703
|
-
<span class='type'>(<tt>
|
1673
|
+
<span class='type'>(<tt>EndpointTLSTerminationAtEdge</tt>)</span>
|
1704
1674
|
|
1705
1675
|
|
1706
1676
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1707
1677
|
|
1708
1678
|
|
1709
|
-
—
|
1710
|
-
<div class='inline'>
|
1711
|
-
<p>The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events.</p>
|
1712
|
-
</div>
|
1713
|
-
|
1714
1679
|
</li>
|
1715
1680
|
|
1716
1681
|
</ul>
|
@@ -1721,7 +1686,7 @@
|
|
1721
1686
|
<li>
|
1722
1687
|
|
1723
1688
|
|
1724
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
1689
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/HTTPSEdge.html" title="NgrokAPI::Models::HTTPSEdge (class)">NgrokAPI::Models::HTTPSEdge</a></span></tt>)</span>
|
1725
1690
|
|
1726
1691
|
|
1727
1692
|
|
@@ -1740,37 +1705,37 @@
|
|
1740
1705
|
<pre class="lines">
|
1741
1706
|
|
1742
1707
|
|
1743
|
-
|
1744
|
-
|
1745
|
-
|
1746
|
-
|
1747
|
-
|
1748
|
-
|
1749
|
-
|
1750
|
-
|
1751
|
-
|
1752
|
-
|
1753
|
-
|
1754
|
-
|
1755
|
-
|
1756
|
-
|
1708
|
+
180
|
1709
|
+
181
|
1710
|
+
182
|
1711
|
+
183
|
1712
|
+
184
|
1713
|
+
185
|
1714
|
+
186
|
1715
|
+
187
|
1716
|
+
188
|
1717
|
+
189
|
1718
|
+
190
|
1719
|
+
191
|
1720
|
+
192
|
1721
|
+
193</pre>
|
1757
1722
|
</td>
|
1758
1723
|
<td>
|
1759
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/
|
1724
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_client.rb', line 180</span>
|
1760
1725
|
|
1761
|
-
<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'>
|
1762
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/
|
1726
|
+
<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'>hostports:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>mutual_tls:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>tls_termination:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
1727
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{id}</span><span class='tstring_end'>'</span></span>
|
1763
1728
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1764
1729
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1765
1730
|
<span class='rbrace'>}</span>
|
1766
1731
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
1767
|
-
<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>
|
1768
1732
|
<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>
|
1769
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:
|
1770
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:
|
1771
|
-
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:
|
1733
|
+
<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>
|
1734
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:hostports</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_hostports'>hostports</span> <span class='kw'>if</span> <span class='id identifier rubyid_hostports'>hostports</span>
|
1735
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:mutual_tls</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span> <span class='kw'>if</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span>
|
1736
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:tls_termination</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span> <span class='kw'>if</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span>
|
1772
1737
|
<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>
|
1773
|
-
<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/
|
1738
|
+
<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/HTTPSEdge.html" title="NgrokAPI::Models::HTTPSEdge (class)">HTTPSEdge</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/HTTPSEdge.html#initialize-instance_method" title="NgrokAPI::Models::HTTPSEdge#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
1774
1739
|
<span class='kw'>end</span></pre>
|
1775
1740
|
</td>
|
1776
1741
|
</tr>
|
@@ -1782,9 +1747,9 @@
|
|
1782
1747
|
</div>
|
1783
1748
|
|
1784
1749
|
<div id="footer">
|
1785
|
-
Generated on Thu
|
1750
|
+
Generated on Thu Mar 10 04:54:51 2022 by
|
1786
1751
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
1787
|
-
0.9.27 (ruby-
|
1752
|
+
0.9.27 (ruby-2.7.5).
|
1788
1753
|
</div>
|
1789
1754
|
|
1790
1755
|
</div>
|