ngrok-api 0.16.0 → 0.17.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/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
|
@@ -1,289 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module NgrokAPI
|
|
4
|
-
module Services
|
|
5
|
-
##
|
|
6
|
-
# Endpoint Configurations are a reusable group of modules that encapsulate how
|
|
7
|
-
# traffic to a domain or address is handled. Endpoint configurations are only
|
|
8
|
-
# applied to Domains and TCP Addresses they have been attached to.
|
|
9
|
-
#
|
|
10
|
-
# https://ngrok.com/docs/api#api-endpoint-configurations
|
|
11
|
-
class EndpointConfigurationsClient
|
|
12
|
-
# The API path for the requests
|
|
13
|
-
PATH = '/endpoint_configurations'
|
|
14
|
-
# The List Property from the resulting API for list calls
|
|
15
|
-
LIST_PROPERTY = 'endpoint_configurations'
|
|
16
|
-
|
|
17
|
-
attr_reader :client
|
|
18
|
-
|
|
19
|
-
def initialize(client:)
|
|
20
|
-
@client = client
|
|
21
|
-
end
|
|
22
|
-
|
|
23
|
-
##
|
|
24
|
-
# Create a new endpoint configuration
|
|
25
|
-
#
|
|
26
|
-
# @param [string] type they type of traffic this endpoint configuration can be applied to. one of: ``http``, ``https``, ``tcp``
|
|
27
|
-
# @param [string] description human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes
|
|
28
|
-
# @param [string] metadata arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.
|
|
29
|
-
# @param [EndpointCircuitBreaker] circuit_breaker circuit breaker module configuration or ``null``
|
|
30
|
-
# @param [EndpointCompression] compression compression module configuration or ``null``
|
|
31
|
-
# @param [EndpointRequestHeaders] request_headers request headers module configuration or ``null``
|
|
32
|
-
# @param [EndpointResponseHeaders] response_headers response headers module configuration or ``null``
|
|
33
|
-
# @param [EndpointIPPolicyMutate] ip_policy ip policy module configuration or ``null``
|
|
34
|
-
# @param [EndpointMutualTLSMutate] mutual_tls mutual TLS module configuration or ``null``
|
|
35
|
-
# @param [EndpointTLSTermination] tls_termination TLS termination module configuration or ``null``
|
|
36
|
-
# @param [EndpointWebhookValidation] webhook_validation webhook validation module configuration or ``null``
|
|
37
|
-
# @param [EndpointOAuth] oauth oauth module configuration or ``null``
|
|
38
|
-
# @param [EndpointLoggingMutate] logging logging module configuration or ``null``
|
|
39
|
-
# @param [EndpointSAMLMutate] saml saml module configuration or ``null``
|
|
40
|
-
# @param [EndpointOIDC] oidc oidc module configuration or ``null``
|
|
41
|
-
# @return [NgrokAPI::Models::EndpointConfiguration] result from the API request
|
|
42
|
-
#
|
|
43
|
-
# https://ngrok.com/docs/api#api-endpoint-configurations-create
|
|
44
|
-
def create(type: "", description: "", metadata: "", basic_auth: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, ip_policy: nil, mutual_tls: nil, tls_termination: nil, webhook_validation: nil, oauth: nil, logging: nil, saml: nil, oidc: nil, backend: nil)
|
|
45
|
-
path = '/endpoint_configurations'
|
|
46
|
-
replacements = {
|
|
47
|
-
}
|
|
48
|
-
data = {}
|
|
49
|
-
data[:type] = type if type
|
|
50
|
-
data[:description] = description if description
|
|
51
|
-
data[:metadata] = metadata if metadata
|
|
52
|
-
data[:circuit_breaker] = circuit_breaker if circuit_breaker
|
|
53
|
-
data[:compression] = compression if compression
|
|
54
|
-
data[:request_headers] = request_headers if request_headers
|
|
55
|
-
data[:response_headers] = response_headers if response_headers
|
|
56
|
-
data[:ip_policy] = ip_policy if ip_policy
|
|
57
|
-
data[:mutual_tls] = mutual_tls if mutual_tls
|
|
58
|
-
data[:tls_termination] = tls_termination if tls_termination
|
|
59
|
-
data[:webhook_validation] = webhook_validation if webhook_validation
|
|
60
|
-
data[:oauth] = oauth if oauth
|
|
61
|
-
data[:logging] = logging if logging
|
|
62
|
-
data[:saml] = saml if saml
|
|
63
|
-
data[:oidc] = oidc if oidc
|
|
64
|
-
result = @client.post(path % replacements, data: data)
|
|
65
|
-
NgrokAPI::Models::EndpointConfiguration.new(client: self, result: result)
|
|
66
|
-
end
|
|
67
|
-
|
|
68
|
-
##
|
|
69
|
-
# Delete an endpoint configuration. This operation will fail if the endpoint
|
|
70
|
-
# configuration is still referenced by any reserved domain or reserved address.
|
|
71
|
-
#
|
|
72
|
-
# @param [string] id a resource identifier
|
|
73
|
-
# @return [NgrokAPI::Models::Empty] result from the API request
|
|
74
|
-
#
|
|
75
|
-
# https://ngrok.com/docs/api#api-endpoint-configurations-delete
|
|
76
|
-
def delete(id: "")
|
|
77
|
-
path = '/endpoint_configurations/%{id}'
|
|
78
|
-
replacements = {
|
|
79
|
-
id: id,
|
|
80
|
-
}
|
|
81
|
-
@client.delete(path % replacements)
|
|
82
|
-
end
|
|
83
|
-
|
|
84
|
-
##
|
|
85
|
-
# Delete an endpoint configuration. This operation will fail if the endpoint
|
|
86
|
-
# configuration is still referenced by any reserved domain or reserved address.
|
|
87
|
-
# Throws an exception if API error.
|
|
88
|
-
#
|
|
89
|
-
# @param [string] id a resource identifier
|
|
90
|
-
# @return [NgrokAPI::Models::Empty] result from the API request
|
|
91
|
-
#
|
|
92
|
-
# https://ngrok.com/docs/api#api-endpoint-configurations-delete
|
|
93
|
-
def delete!(id: "")
|
|
94
|
-
path = '/endpoint_configurations/%{id}'
|
|
95
|
-
replacements = {
|
|
96
|
-
id: id,
|
|
97
|
-
}
|
|
98
|
-
@client.delete(path % replacements, danger: true)
|
|
99
|
-
end
|
|
100
|
-
|
|
101
|
-
##
|
|
102
|
-
# Returns detailed information about an endpoint configuration
|
|
103
|
-
#
|
|
104
|
-
# @param [string] id a resource identifier
|
|
105
|
-
# @return [NgrokAPI::Models::EndpointConfiguration] result from the API request
|
|
106
|
-
#
|
|
107
|
-
# https://ngrok.com/docs/api#api-endpoint-configurations-get
|
|
108
|
-
def get(id: "")
|
|
109
|
-
path = '/endpoint_configurations/%{id}'
|
|
110
|
-
replacements = {
|
|
111
|
-
id: id,
|
|
112
|
-
}
|
|
113
|
-
data = {}
|
|
114
|
-
result = @client.get(path % replacements, data: data)
|
|
115
|
-
NgrokAPI::Models::EndpointConfiguration.new(client: self, result: result)
|
|
116
|
-
end
|
|
117
|
-
|
|
118
|
-
##
|
|
119
|
-
# Returns detailed information about an endpoint configuration
|
|
120
|
-
# Throws an exception if API error.
|
|
121
|
-
#
|
|
122
|
-
# @param [string] id a resource identifier
|
|
123
|
-
# @return [NgrokAPI::Models::EndpointConfiguration] result from the API request
|
|
124
|
-
#
|
|
125
|
-
# https://ngrok.com/docs/api#api-endpoint-configurations-get
|
|
126
|
-
def get!(id: "")
|
|
127
|
-
path = '/endpoint_configurations/%{id}'
|
|
128
|
-
replacements = {
|
|
129
|
-
id: id,
|
|
130
|
-
}
|
|
131
|
-
data = {}
|
|
132
|
-
result = @client.get(path % replacements, data: data, danger: true)
|
|
133
|
-
NgrokAPI::Models::EndpointConfiguration.new(client: self, result: result)
|
|
134
|
-
end
|
|
135
|
-
|
|
136
|
-
##
|
|
137
|
-
# Returns a list of all endpoint configurations on this account
|
|
138
|
-
#
|
|
139
|
-
# @param [string] before_id
|
|
140
|
-
# @param [string] limit
|
|
141
|
-
# @param [string] url optional and mutually exclusive from before_id and limit
|
|
142
|
-
# @return [NgrokAPI::Models::Listable] result from the API request
|
|
143
|
-
#
|
|
144
|
-
# https://ngrok.com/docs/api#api-endpoint-configurations-list
|
|
145
|
-
def list(before_id: nil, limit: nil,
|
|
146
|
-
url: nil)
|
|
147
|
-
result = @client.list(
|
|
148
|
-
before_id: before_id,
|
|
149
|
-
limit: limit,
|
|
150
|
-
url: url,
|
|
151
|
-
path: PATH
|
|
152
|
-
)
|
|
153
|
-
|
|
154
|
-
NgrokAPI::Models::Listable.new(
|
|
155
|
-
client: self,
|
|
156
|
-
result: result,
|
|
157
|
-
list_property: LIST_PROPERTY,
|
|
158
|
-
klass: NgrokAPI::Models::EndpointConfiguration
|
|
159
|
-
)
|
|
160
|
-
end
|
|
161
|
-
|
|
162
|
-
##
|
|
163
|
-
# Returns a list of all endpoint configurations on this account
|
|
164
|
-
# Throws an exception if API error.
|
|
165
|
-
#
|
|
166
|
-
# @param [string] before_id
|
|
167
|
-
# @param [string] limit
|
|
168
|
-
# @param [string] url optional and mutually exclusive from before_id and limit
|
|
169
|
-
# @return [NgrokAPI::Models::Listable] result from the API request
|
|
170
|
-
#
|
|
171
|
-
# https://ngrok.com/docs/api#api-endpoint-configurations-list
|
|
172
|
-
def list!(before_id: nil, limit: nil,
|
|
173
|
-
url: nil)
|
|
174
|
-
result = @client.list(
|
|
175
|
-
before_id: before_id,
|
|
176
|
-
limit: limit,
|
|
177
|
-
danger: true,
|
|
178
|
-
url: url,
|
|
179
|
-
path: PATH
|
|
180
|
-
)
|
|
181
|
-
|
|
182
|
-
NgrokAPI::Models::Listable.new(
|
|
183
|
-
client: self,
|
|
184
|
-
result: result,
|
|
185
|
-
list_property: LIST_PROPERTY,
|
|
186
|
-
klass: NgrokAPI::Models::EndpointConfiguration,
|
|
187
|
-
danger: true
|
|
188
|
-
)
|
|
189
|
-
end
|
|
190
|
-
|
|
191
|
-
##
|
|
192
|
-
# Updates an endpoint configuration. If a module is not specified in the update,
|
|
193
|
-
# it will not be modified. However, each module configuration that is specified
|
|
194
|
-
# will completely replace the existing value. There is no way to delete an
|
|
195
|
-
# existing module via this API, instead use the delete module API.
|
|
196
|
-
#
|
|
197
|
-
# @param [string] id unique identifier of this endpoint configuration
|
|
198
|
-
# @param [string] description human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes
|
|
199
|
-
# @param [string] metadata arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.
|
|
200
|
-
# @param [EndpointCircuitBreaker] circuit_breaker circuit breaker module configuration or ``null``
|
|
201
|
-
# @param [EndpointCompression] compression compression module configuration or ``null``
|
|
202
|
-
# @param [EndpointRequestHeaders] request_headers request headers module configuration or ``null``
|
|
203
|
-
# @param [EndpointResponseHeaders] response_headers response headers module configuration or ``null``
|
|
204
|
-
# @param [EndpointIPPolicyMutate] ip_policy ip policy module configuration or ``null``
|
|
205
|
-
# @param [EndpointMutualTLSMutate] mutual_tls mutual TLS module configuration or ``null``
|
|
206
|
-
# @param [EndpointTLSTermination] tls_termination TLS termination module configuration or ``null``
|
|
207
|
-
# @param [EndpointWebhookValidation] webhook_validation webhook validation module configuration or ``null``
|
|
208
|
-
# @param [EndpointOAuth] oauth oauth module configuration or ``null``
|
|
209
|
-
# @param [EndpointLoggingMutate] logging logging module configuration or ``null``
|
|
210
|
-
# @param [EndpointSAMLMutate] saml saml module configuration or ``null``
|
|
211
|
-
# @param [EndpointOIDC] oidc oidc module configuration or ``null``
|
|
212
|
-
# @return [NgrokAPI::Models::EndpointConfiguration] result from the API request
|
|
213
|
-
#
|
|
214
|
-
# https://ngrok.com/docs/api#api-endpoint-configurations-update
|
|
215
|
-
def update(id: "", description: nil, metadata: nil, basic_auth: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, ip_policy: nil, mutual_tls: nil, tls_termination: nil, webhook_validation: nil, oauth: nil, logging: nil, saml: nil, oidc: nil, backend: nil)
|
|
216
|
-
path = '/endpoint_configurations/%{id}'
|
|
217
|
-
replacements = {
|
|
218
|
-
id: id,
|
|
219
|
-
}
|
|
220
|
-
data = {}
|
|
221
|
-
data[:description] = description if description
|
|
222
|
-
data[:metadata] = metadata if metadata
|
|
223
|
-
data[:circuit_breaker] = circuit_breaker if circuit_breaker
|
|
224
|
-
data[:compression] = compression if compression
|
|
225
|
-
data[:request_headers] = request_headers if request_headers
|
|
226
|
-
data[:response_headers] = response_headers if response_headers
|
|
227
|
-
data[:ip_policy] = ip_policy if ip_policy
|
|
228
|
-
data[:mutual_tls] = mutual_tls if mutual_tls
|
|
229
|
-
data[:tls_termination] = tls_termination if tls_termination
|
|
230
|
-
data[:webhook_validation] = webhook_validation if webhook_validation
|
|
231
|
-
data[:oauth] = oauth if oauth
|
|
232
|
-
data[:logging] = logging if logging
|
|
233
|
-
data[:saml] = saml if saml
|
|
234
|
-
data[:oidc] = oidc if oidc
|
|
235
|
-
result = @client.patch(path % replacements, data: data)
|
|
236
|
-
NgrokAPI::Models::EndpointConfiguration.new(client: self, result: result)
|
|
237
|
-
end
|
|
238
|
-
|
|
239
|
-
##
|
|
240
|
-
# Updates an endpoint configuration. If a module is not specified in the update,
|
|
241
|
-
# it will not be modified. However, each module configuration that is specified
|
|
242
|
-
# will completely replace the existing value. There is no way to delete an
|
|
243
|
-
# existing module via this API, instead use the delete module API.
|
|
244
|
-
# Throws an exception if API error.
|
|
245
|
-
#
|
|
246
|
-
# @param [string] id unique identifier of this endpoint configuration
|
|
247
|
-
# @param [string] description human-readable description of what this endpoint configuration will be do when applied or what traffic it will be applied to. Optional, max 255 bytes
|
|
248
|
-
# @param [string] metadata arbitrary user-defined machine-readable data of this endpoint configuration. Optional, max 4096 bytes.
|
|
249
|
-
# @param [EndpointCircuitBreaker] circuit_breaker circuit breaker module configuration or ``null``
|
|
250
|
-
# @param [EndpointCompression] compression compression module configuration or ``null``
|
|
251
|
-
# @param [EndpointRequestHeaders] request_headers request headers module configuration or ``null``
|
|
252
|
-
# @param [EndpointResponseHeaders] response_headers response headers module configuration or ``null``
|
|
253
|
-
# @param [EndpointIPPolicyMutate] ip_policy ip policy module configuration or ``null``
|
|
254
|
-
# @param [EndpointMutualTLSMutate] mutual_tls mutual TLS module configuration or ``null``
|
|
255
|
-
# @param [EndpointTLSTermination] tls_termination TLS termination module configuration or ``null``
|
|
256
|
-
# @param [EndpointWebhookValidation] webhook_validation webhook validation module configuration or ``null``
|
|
257
|
-
# @param [EndpointOAuth] oauth oauth module configuration or ``null``
|
|
258
|
-
# @param [EndpointLoggingMutate] logging logging module configuration or ``null``
|
|
259
|
-
# @param [EndpointSAMLMutate] saml saml module configuration or ``null``
|
|
260
|
-
# @param [EndpointOIDC] oidc oidc module configuration or ``null``
|
|
261
|
-
# @return [NgrokAPI::Models::EndpointConfiguration] result from the API request
|
|
262
|
-
#
|
|
263
|
-
# https://ngrok.com/docs/api#api-endpoint-configurations-update
|
|
264
|
-
def update!(id: "", description: nil, metadata: nil, basic_auth: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, ip_policy: nil, mutual_tls: nil, tls_termination: nil, webhook_validation: nil, oauth: nil, logging: nil, saml: nil, oidc: nil, backend: nil)
|
|
265
|
-
path = '/endpoint_configurations/%{id}'
|
|
266
|
-
replacements = {
|
|
267
|
-
id: id,
|
|
268
|
-
}
|
|
269
|
-
data = {}
|
|
270
|
-
data[:description] = description if description
|
|
271
|
-
data[:metadata] = metadata if metadata
|
|
272
|
-
data[:circuit_breaker] = circuit_breaker if circuit_breaker
|
|
273
|
-
data[:compression] = compression if compression
|
|
274
|
-
data[:request_headers] = request_headers if request_headers
|
|
275
|
-
data[:response_headers] = response_headers if response_headers
|
|
276
|
-
data[:ip_policy] = ip_policy if ip_policy
|
|
277
|
-
data[:mutual_tls] = mutual_tls if mutual_tls
|
|
278
|
-
data[:tls_termination] = tls_termination if tls_termination
|
|
279
|
-
data[:webhook_validation] = webhook_validation if webhook_validation
|
|
280
|
-
data[:oauth] = oauth if oauth
|
|
281
|
-
data[:logging] = logging if logging
|
|
282
|
-
data[:saml] = saml if saml
|
|
283
|
-
data[:oidc] = oidc if oidc
|
|
284
|
-
result = @client.patch(path % replacements, data: data, danger: true)
|
|
285
|
-
NgrokAPI::Models::EndpointConfiguration.new(client: self, result: result)
|
|
286
|
-
end
|
|
287
|
-
end
|
|
288
|
-
end
|
|
289
|
-
end
|
|
@@ -1,224 +0,0 @@
|
|
|
1
|
-
# frozen_string_literal: true
|
|
2
|
-
|
|
3
|
-
module NgrokAPI
|
|
4
|
-
module Services
|
|
5
|
-
##
|
|
6
|
-
# https://ngrok.com/docs/api#api-event-streams
|
|
7
|
-
class EventStreamsClient
|
|
8
|
-
# The API path for the requests
|
|
9
|
-
PATH = '/event_streams'
|
|
10
|
-
# The List Property from the resulting API for list calls
|
|
11
|
-
LIST_PROPERTY = 'event_streams'
|
|
12
|
-
|
|
13
|
-
attr_reader :client
|
|
14
|
-
|
|
15
|
-
def initialize(client:)
|
|
16
|
-
@client = client
|
|
17
|
-
end
|
|
18
|
-
|
|
19
|
-
##
|
|
20
|
-
# Create a new Event Stream. It will not apply to anything until you associate it
|
|
21
|
-
# with one or more Endpoint Configs.
|
|
22
|
-
#
|
|
23
|
-
# @param [string] metadata Arbitrary user-defined machine-readable data of this Event Stream. Optional, max 4096 bytes.
|
|
24
|
-
# @param [string] description Human-readable description of the Event Stream. Optional, max 255 bytes.
|
|
25
|
-
# @param [List<string>] fields A list of protocol-specific fields you want to collect on each event.
|
|
26
|
-
# @param [string] event_type The protocol that determines which events will be collected. Supported values are ``tcp_connection_closed`` and ``http_request_complete``.
|
|
27
|
-
# @param [List<string>] destination_ids A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.
|
|
28
|
-
# @param [float64] sampling_rate 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.
|
|
29
|
-
# @return [NgrokAPI::Models::EventStream] result from the API request
|
|
30
|
-
#
|
|
31
|
-
# https://ngrok.com/docs/api#api-event-streams-create
|
|
32
|
-
def create(metadata: "", description: "", fields: [], event_type: "", destination_ids: [], sampling_rate: 0)
|
|
33
|
-
path = '/event_streams'
|
|
34
|
-
replacements = {
|
|
35
|
-
}
|
|
36
|
-
data = {}
|
|
37
|
-
data[:metadata] = metadata if metadata
|
|
38
|
-
data[:description] = description if description
|
|
39
|
-
data[:fields] = fields if fields
|
|
40
|
-
data[:event_type] = event_type if event_type
|
|
41
|
-
data[:destination_ids] = destination_ids if destination_ids
|
|
42
|
-
data[:sampling_rate] = sampling_rate if sampling_rate
|
|
43
|
-
result = @client.post(path % replacements, data: data)
|
|
44
|
-
NgrokAPI::Models::EventStream.new(client: self, result: result)
|
|
45
|
-
end
|
|
46
|
-
|
|
47
|
-
##
|
|
48
|
-
# Delete an Event Stream. Associated Event Destinations will be preserved.
|
|
49
|
-
#
|
|
50
|
-
# @param [string] id a resource identifier
|
|
51
|
-
# @return [NgrokAPI::Models::Empty] result from the API request
|
|
52
|
-
#
|
|
53
|
-
# https://ngrok.com/docs/api#api-event-streams-delete
|
|
54
|
-
def delete(id: "")
|
|
55
|
-
path = '/event_streams/%{id}'
|
|
56
|
-
replacements = {
|
|
57
|
-
id: id,
|
|
58
|
-
}
|
|
59
|
-
@client.delete(path % replacements)
|
|
60
|
-
end
|
|
61
|
-
|
|
62
|
-
##
|
|
63
|
-
# Delete an Event Stream. Associated Event Destinations will be preserved.
|
|
64
|
-
# Throws an exception if API error.
|
|
65
|
-
#
|
|
66
|
-
# @param [string] id a resource identifier
|
|
67
|
-
# @return [NgrokAPI::Models::Empty] result from the API request
|
|
68
|
-
#
|
|
69
|
-
# https://ngrok.com/docs/api#api-event-streams-delete
|
|
70
|
-
def delete!(id: "")
|
|
71
|
-
path = '/event_streams/%{id}'
|
|
72
|
-
replacements = {
|
|
73
|
-
id: id,
|
|
74
|
-
}
|
|
75
|
-
@client.delete(path % replacements, danger: true)
|
|
76
|
-
end
|
|
77
|
-
|
|
78
|
-
##
|
|
79
|
-
# Get detailed information about an Event Stream by ID.
|
|
80
|
-
#
|
|
81
|
-
# @param [string] id a resource identifier
|
|
82
|
-
# @return [NgrokAPI::Models::EventStream] result from the API request
|
|
83
|
-
#
|
|
84
|
-
# https://ngrok.com/docs/api#api-event-streams-get
|
|
85
|
-
def get(id: "")
|
|
86
|
-
path = '/event_streams/%{id}'
|
|
87
|
-
replacements = {
|
|
88
|
-
id: id,
|
|
89
|
-
}
|
|
90
|
-
data = {}
|
|
91
|
-
result = @client.get(path % replacements, data: data)
|
|
92
|
-
NgrokAPI::Models::EventStream.new(client: self, result: result)
|
|
93
|
-
end
|
|
94
|
-
|
|
95
|
-
##
|
|
96
|
-
# Get detailed information about an Event Stream by ID.
|
|
97
|
-
# Throws an exception if API error.
|
|
98
|
-
#
|
|
99
|
-
# @param [string] id a resource identifier
|
|
100
|
-
# @return [NgrokAPI::Models::EventStream] result from the API request
|
|
101
|
-
#
|
|
102
|
-
# https://ngrok.com/docs/api#api-event-streams-get
|
|
103
|
-
def get!(id: "")
|
|
104
|
-
path = '/event_streams/%{id}'
|
|
105
|
-
replacements = {
|
|
106
|
-
id: id,
|
|
107
|
-
}
|
|
108
|
-
data = {}
|
|
109
|
-
result = @client.get(path % replacements, data: data, danger: true)
|
|
110
|
-
NgrokAPI::Models::EventStream.new(client: self, result: result)
|
|
111
|
-
end
|
|
112
|
-
|
|
113
|
-
##
|
|
114
|
-
# List all Event Streams available on this account.
|
|
115
|
-
#
|
|
116
|
-
# @param [string] before_id
|
|
117
|
-
# @param [string] limit
|
|
118
|
-
# @param [string] url optional and mutually exclusive from before_id and limit
|
|
119
|
-
# @return [NgrokAPI::Models::Listable] result from the API request
|
|
120
|
-
#
|
|
121
|
-
# https://ngrok.com/docs/api#api-event-streams-list
|
|
122
|
-
def list(before_id: nil, limit: nil,
|
|
123
|
-
url: nil)
|
|
124
|
-
result = @client.list(
|
|
125
|
-
before_id: before_id,
|
|
126
|
-
limit: limit,
|
|
127
|
-
url: url,
|
|
128
|
-
path: PATH
|
|
129
|
-
)
|
|
130
|
-
|
|
131
|
-
NgrokAPI::Models::Listable.new(
|
|
132
|
-
client: self,
|
|
133
|
-
result: result,
|
|
134
|
-
list_property: LIST_PROPERTY,
|
|
135
|
-
klass: NgrokAPI::Models::EventStream
|
|
136
|
-
)
|
|
137
|
-
end
|
|
138
|
-
|
|
139
|
-
##
|
|
140
|
-
# List all Event Streams available on this account.
|
|
141
|
-
# Throws an exception if API error.
|
|
142
|
-
#
|
|
143
|
-
# @param [string] before_id
|
|
144
|
-
# @param [string] limit
|
|
145
|
-
# @param [string] url optional and mutually exclusive from before_id and limit
|
|
146
|
-
# @return [NgrokAPI::Models::Listable] result from the API request
|
|
147
|
-
#
|
|
148
|
-
# https://ngrok.com/docs/api#api-event-streams-list
|
|
149
|
-
def list!(before_id: nil, limit: nil,
|
|
150
|
-
url: nil)
|
|
151
|
-
result = @client.list(
|
|
152
|
-
before_id: before_id,
|
|
153
|
-
limit: limit,
|
|
154
|
-
danger: true,
|
|
155
|
-
url: url,
|
|
156
|
-
path: PATH
|
|
157
|
-
)
|
|
158
|
-
|
|
159
|
-
NgrokAPI::Models::Listable.new(
|
|
160
|
-
client: self,
|
|
161
|
-
result: result,
|
|
162
|
-
list_property: LIST_PROPERTY,
|
|
163
|
-
klass: NgrokAPI::Models::EventStream,
|
|
164
|
-
danger: true
|
|
165
|
-
)
|
|
166
|
-
end
|
|
167
|
-
|
|
168
|
-
##
|
|
169
|
-
# Update attributes of an Event Stream by ID.
|
|
170
|
-
#
|
|
171
|
-
# @param [string] id Unique identifier for this Event Stream.
|
|
172
|
-
# @param [string] metadata Arbitrary user-defined machine-readable data of this Event Stream. Optional, max 4096 bytes.
|
|
173
|
-
# @param [string] description Human-readable description of the Event Stream. Optional, max 255 bytes.
|
|
174
|
-
# @param [List<string>] fields A list of protocol-specific fields you want to collect on each event.
|
|
175
|
-
# @param [List<string>] destination_ids A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.
|
|
176
|
-
# @param [float64] sampling_rate 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.
|
|
177
|
-
# @return [NgrokAPI::Models::EventStream] result from the API request
|
|
178
|
-
#
|
|
179
|
-
# https://ngrok.com/docs/api#api-event-streams-update
|
|
180
|
-
def update(id: "", metadata: nil, description: nil, fields: nil, destination_ids: nil, sampling_rate: nil)
|
|
181
|
-
path = '/event_streams/%{id}'
|
|
182
|
-
replacements = {
|
|
183
|
-
id: id,
|
|
184
|
-
}
|
|
185
|
-
data = {}
|
|
186
|
-
data[:metadata] = metadata if metadata
|
|
187
|
-
data[:description] = description if description
|
|
188
|
-
data[:fields] = fields if fields
|
|
189
|
-
data[:destination_ids] = destination_ids if destination_ids
|
|
190
|
-
data[:sampling_rate] = sampling_rate if sampling_rate
|
|
191
|
-
result = @client.patch(path % replacements, data: data)
|
|
192
|
-
NgrokAPI::Models::EventStream.new(client: self, result: result)
|
|
193
|
-
end
|
|
194
|
-
|
|
195
|
-
##
|
|
196
|
-
# Update attributes of an Event Stream by ID.
|
|
197
|
-
# Throws an exception if API error.
|
|
198
|
-
#
|
|
199
|
-
# @param [string] id Unique identifier for this Event Stream.
|
|
200
|
-
# @param [string] metadata Arbitrary user-defined machine-readable data of this Event Stream. Optional, max 4096 bytes.
|
|
201
|
-
# @param [string] description Human-readable description of the Event Stream. Optional, max 255 bytes.
|
|
202
|
-
# @param [List<string>] fields A list of protocol-specific fields you want to collect on each event.
|
|
203
|
-
# @param [List<string>] destination_ids A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.
|
|
204
|
-
# @param [float64] sampling_rate 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.
|
|
205
|
-
# @return [NgrokAPI::Models::EventStream] result from the API request
|
|
206
|
-
#
|
|
207
|
-
# https://ngrok.com/docs/api#api-event-streams-update
|
|
208
|
-
def update!(id: "", metadata: nil, description: nil, fields: nil, destination_ids: nil, sampling_rate: nil)
|
|
209
|
-
path = '/event_streams/%{id}'
|
|
210
|
-
replacements = {
|
|
211
|
-
id: id,
|
|
212
|
-
}
|
|
213
|
-
data = {}
|
|
214
|
-
data[:metadata] = metadata if metadata
|
|
215
|
-
data[:description] = description if description
|
|
216
|
-
data[:fields] = fields if fields
|
|
217
|
-
data[:destination_ids] = destination_ids if destination_ids
|
|
218
|
-
data[:sampling_rate] = sampling_rate if sampling_rate
|
|
219
|
-
result = @client.patch(path % replacements, data: data, danger: true)
|
|
220
|
-
NgrokAPI::Models::EventStream.new(client: self, result: result)
|
|
221
|
-
end
|
|
222
|
-
end
|
|
223
|
-
end
|
|
224
|
-
end
|
|
@@ -1,78 +0,0 @@
|
|
|
1
|
-
require 'spec_helper'
|
|
2
|
-
|
|
3
|
-
RSpec.describe NgrokAPI::Models::EndpointConfiguration do
|
|
4
|
-
before(:each) do
|
|
5
|
-
@client = class_double("EndpointConfigurationsClient")
|
|
6
|
-
@endpoint_configuration = NgrokAPI::Models::EndpointConfiguration.new(client: @client, result: endpoint_configuration_result)
|
|
7
|
-
end
|
|
8
|
-
|
|
9
|
-
describe "#==" do
|
|
10
|
-
it "is equal if the results are the same" do
|
|
11
|
-
other = NgrokAPI::Models::EndpointConfiguration.new(client: @client, result: endpoint_configuration_result)
|
|
12
|
-
expect(@endpoint_configuration == other).to eq true
|
|
13
|
-
end
|
|
14
|
-
end
|
|
15
|
-
|
|
16
|
-
describe "#to_s" do
|
|
17
|
-
it "stringifies as result.to_s" do
|
|
18
|
-
expect(@endpoint_configuration.to_s).to eq endpoint_configuration_result.to_s
|
|
19
|
-
end
|
|
20
|
-
end
|
|
21
|
-
|
|
22
|
-
describe "#delete" do
|
|
23
|
-
it "calls delete on the client" do
|
|
24
|
-
expect(@endpoint_configuration.client).to receive(:delete)
|
|
25
|
-
@endpoint_configuration.delete
|
|
26
|
-
end
|
|
27
|
-
end
|
|
28
|
-
|
|
29
|
-
describe "#update" do
|
|
30
|
-
it "calls update on the client" do
|
|
31
|
-
new_description = 'New description'
|
|
32
|
-
new_metadata = 'New metadata'
|
|
33
|
-
new_circuit_breaker = 'New circuit_breaker'
|
|
34
|
-
new_compression = 'New compression'
|
|
35
|
-
new_request_headers = 'New request_headers'
|
|
36
|
-
new_response_headers = 'New response_headers'
|
|
37
|
-
new_ip_policy = 'New ip_policy'
|
|
38
|
-
new_mutual_tls = 'New mutual_tls'
|
|
39
|
-
new_tls_termination = 'New tls_termination'
|
|
40
|
-
new_webhook_validation = 'New webhook_validation'
|
|
41
|
-
new_oauth = 'New oauth'
|
|
42
|
-
new_logging = 'New logging'
|
|
43
|
-
new_saml = 'New saml'
|
|
44
|
-
new_oidc = 'New oidc'
|
|
45
|
-
expect(@endpoint_configuration.client).to receive(:update)
|
|
46
|
-
@endpoint_configuration.update(
|
|
47
|
-
description: new_description,
|
|
48
|
-
metadata: new_metadata,
|
|
49
|
-
circuit_breaker: new_circuit_breaker,
|
|
50
|
-
compression: new_compression,
|
|
51
|
-
request_headers: new_request_headers,
|
|
52
|
-
response_headers: new_response_headers,
|
|
53
|
-
ip_policy: new_ip_policy,
|
|
54
|
-
mutual_tls: new_mutual_tls,
|
|
55
|
-
tls_termination: new_tls_termination,
|
|
56
|
-
webhook_validation: new_webhook_validation,
|
|
57
|
-
oauth: new_oauth,
|
|
58
|
-
logging: new_logging,
|
|
59
|
-
saml: new_saml,
|
|
60
|
-
oidc: new_oidc
|
|
61
|
-
)
|
|
62
|
-
expect(@endpoint_configuration.description).to eq new_description
|
|
63
|
-
expect(@endpoint_configuration.metadata).to eq new_metadata
|
|
64
|
-
expect(@endpoint_configuration.circuit_breaker).to eq new_circuit_breaker
|
|
65
|
-
expect(@endpoint_configuration.compression).to eq new_compression
|
|
66
|
-
expect(@endpoint_configuration.request_headers).to eq new_request_headers
|
|
67
|
-
expect(@endpoint_configuration.response_headers).to eq new_response_headers
|
|
68
|
-
expect(@endpoint_configuration.ip_policy).to eq new_ip_policy
|
|
69
|
-
expect(@endpoint_configuration.mutual_tls).to eq new_mutual_tls
|
|
70
|
-
expect(@endpoint_configuration.tls_termination).to eq new_tls_termination
|
|
71
|
-
expect(@endpoint_configuration.webhook_validation).to eq new_webhook_validation
|
|
72
|
-
expect(@endpoint_configuration.oauth).to eq new_oauth
|
|
73
|
-
expect(@endpoint_configuration.logging).to eq new_logging
|
|
74
|
-
expect(@endpoint_configuration.saml).to eq new_saml
|
|
75
|
-
expect(@endpoint_configuration.oidc).to eq new_oidc
|
|
76
|
-
end
|
|
77
|
-
end
|
|
78
|
-
end
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
require 'spec_helper'
|
|
2
|
-
|
|
3
|
-
RSpec.describe NgrokAPI::Models::EndpointLoggingMutate do
|
|
4
|
-
before(:each) do
|
|
5
|
-
@client = class_double("EndpointLoggingMutatesClient")
|
|
6
|
-
@endpoint_logging_mutate = NgrokAPI::Models::EndpointLoggingMutate.new(client: @client, result: endpoint_logging_mutate_result)
|
|
7
|
-
end
|
|
8
|
-
|
|
9
|
-
describe "#==" do
|
|
10
|
-
it "is equal if the results are the same" do
|
|
11
|
-
other = NgrokAPI::Models::EndpointLoggingMutate.new(client: @client, result: endpoint_logging_mutate_result)
|
|
12
|
-
expect(@endpoint_logging_mutate == other).to eq true
|
|
13
|
-
end
|
|
14
|
-
end
|
|
15
|
-
|
|
16
|
-
describe "#to_s" do
|
|
17
|
-
it "stringifies as result.to_s" do
|
|
18
|
-
expect(@endpoint_logging_mutate.to_s).to eq endpoint_logging_mutate_result.to_s
|
|
19
|
-
end
|
|
20
|
-
end
|
|
21
|
-
end
|
|
@@ -1,21 +0,0 @@
|
|
|
1
|
-
require 'spec_helper'
|
|
2
|
-
|
|
3
|
-
RSpec.describe NgrokAPI::Models::EndpointLogging do
|
|
4
|
-
before(:each) do
|
|
5
|
-
@client = class_double("EndpointLoggingsClient")
|
|
6
|
-
@endpoint_logging = NgrokAPI::Models::EndpointLogging.new(client: @client, result: endpoint_logging_result)
|
|
7
|
-
end
|
|
8
|
-
|
|
9
|
-
describe "#==" do
|
|
10
|
-
it "is equal if the results are the same" do
|
|
11
|
-
other = NgrokAPI::Models::EndpointLogging.new(client: @client, result: endpoint_logging_result)
|
|
12
|
-
expect(@endpoint_logging == other).to eq true
|
|
13
|
-
end
|
|
14
|
-
end
|
|
15
|
-
|
|
16
|
-
describe "#to_s" do
|
|
17
|
-
it "stringifies as result.to_s" do
|
|
18
|
-
expect(@endpoint_logging.to_s).to eq endpoint_logging_result.to_s
|
|
19
|
-
end
|
|
20
|
-
end
|
|
21
|
-
end
|