ngrok-api 0.16.0 → 0.19.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/README.md +28 -1
- data/doc/NgrokAPI/Client.html +270 -180
- data/doc/NgrokAPI/Error.html +2 -2
- data/doc/NgrokAPI/Errors/NotFoundError.html +2 -2
- data/doc/NgrokAPI/Errors.html +2 -2
- data/doc/NgrokAPI/HttpClient.html +147 -4
- data/doc/NgrokAPI/Models/APIKey.html +120 -68
- data/doc/NgrokAPI/Models/AWSAuth.html +83 -31
- data/doc/NgrokAPI/Models/AWSCredentials.html +90 -38
- data/doc/NgrokAPI/Models/AWSRole.html +75 -23
- data/doc/NgrokAPI/Models/AbuseReport.html +109 -57
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +83 -31
- data/doc/NgrokAPI/Models/AgentIngress.html +142 -90
- data/doc/NgrokAPI/Models/CertificateAuthority.html +149 -97
- data/doc/NgrokAPI/Models/Credential.html +121 -69
- data/doc/NgrokAPI/Models/Endpoint.html +1483 -0
- data/doc/NgrokAPI/Models/{EndpointLoggingMutate.html → EndpointBackend.html} +105 -53
- data/doc/NgrokAPI/Models/EndpointBackendMutate.html +669 -0
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +101 -49
- data/doc/NgrokAPI/Models/EndpointCompression.html +82 -30
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +90 -38
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +90 -38
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +90 -38
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +90 -38
- data/doc/NgrokAPI/Models/EndpointOAuth.html +124 -72
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +107 -55
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +116 -64
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +107 -55
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +107 -55
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +106 -54
- data/doc/NgrokAPI/Models/EndpointOIDC.html +133 -81
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +91 -39
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +91 -39
- data/doc/NgrokAPI/Models/EndpointSAML.html +148 -96
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +133 -81
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +91 -39
- data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +669 -0
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +91 -39
- data/{docs/NgrokAPI/Models/EndpointLogging.html → doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html} +95 -117
- data/doc/NgrokAPI/Models/EventDestination.html +122 -70
- data/doc/NgrokAPI/Models/EventSource.html +92 -40
- data/doc/NgrokAPI/Models/EventSourceList.html +76 -24
- data/doc/NgrokAPI/Models/EventSourceReplace.html +91 -39
- data/doc/NgrokAPI/Models/EventSubscription.html +122 -70
- data/doc/NgrokAPI/Models/EventTarget.html +106 -54
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +90 -38
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +90 -38
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +83 -31
- data/doc/NgrokAPI/Models/FailoverBackend.html +1127 -0
- data/{docs/NgrokAPI/Models/EventStream.html → doc/NgrokAPI/Models/HTTPResponseBackend.html} +170 -196
- data/doc/NgrokAPI/Models/HTTPSEdge.html +1361 -0
- data/doc/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +278 -288
- data/doc/NgrokAPI/Models/IPPolicy.html +120 -68
- data/doc/NgrokAPI/Models/IPPolicyRule.html +222 -96
- data/doc/NgrokAPI/Models/IPRestriction.html +130 -78
- data/doc/NgrokAPI/Models/Listable.html +61 -61
- data/doc/NgrokAPI/Models/Ref.html +83 -31
- data/doc/NgrokAPI/Models/ReservedAddr.html +130 -78
- data/doc/NgrokAPI/Models/ReservedDomain.html +151 -99
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +92 -40
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +90 -38
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +90 -38
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +135 -83
- data/doc/NgrokAPI/Models/SSHCredential.html +128 -76
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +148 -96
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +154 -102
- data/doc/NgrokAPI/Models/TCPEdge.html +1287 -0
- data/doc/NgrokAPI/Models/TLSCertificate.html +165 -113
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +90 -38
- data/doc/NgrokAPI/Models/TLSEdge.html +1447 -0
- data/doc/NgrokAPI/Models/Tunnel.html +413 -65
- data/doc/NgrokAPI/Models/TunnelGroupBackend.html +1201 -0
- data/doc/NgrokAPI/Models/TunnelSession.html +126 -74
- data/doc/NgrokAPI/Models/WeightedBackend.html +1127 -0
- data/doc/NgrokAPI/Models.html +4 -4
- data/doc/NgrokAPI/PagedIterator.html +3 -3
- data/doc/NgrokAPI/Services/APIKeysClient.html +244 -109
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +162 -25
- data/doc/NgrokAPI/Services/AgentIngressesClient.html +262 -109
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +262 -109
- data/doc/NgrokAPI/Services/CredentialsClient.html +266 -111
- data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1149 -0
- data/doc/NgrokAPI/Services/{EndpointCircuitBreakerModuleClient.html → EdgeRouteCircuitBreakerModuleClient.html} +205 -99
- data/{docs/NgrokAPI/Services/EndpointCompressionModuleClient.html → doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html} +205 -99
- data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +1149 -0
- data/doc/NgrokAPI/Services/{EndpointOAuthModuleClient.html → EdgeRouteOAuthModuleClient.html} +205 -99
- data/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +1149 -0
- data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1149 -0
- data/doc/NgrokAPI/Services/{EndpointResponseHeadersModuleClient.html → EdgeRouteResponseHeadersModuleClient.html} +205 -99
- data/{docs/NgrokAPI/Services/EndpointSAMLModuleClient.html → doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html} +205 -99
- data/{docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html → doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html} +205 -99
- data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1149 -0
- data/doc/NgrokAPI/Services/EdgesHTTPSClient.html +1947 -0
- data/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +2585 -0
- data/doc/NgrokAPI/Services/EdgesTCPClient.html +1947 -0
- data/{docs/NgrokAPI/Services/EndpointConfigurationsClient.html → doc/NgrokAPI/Services/EdgesTLSClient.html} +374 -641
- data/doc/NgrokAPI/Services/EndpointsClient.html +903 -0
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +290 -115
- data/doc/NgrokAPI/Services/EventSourcesClient.html +227 -88
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +291 -116
- data/doc/NgrokAPI/Services/{EventStreamsClient.html → FailoverBackendsClient.html} +342 -335
- data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +1937 -0
- data/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +1039 -0
- data/{docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html → doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html} +76 -80
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +245 -128
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +328 -117
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +305 -114
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +160 -295
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +257 -624
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +304 -109
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +284 -111
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +340 -109
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +381 -110
- data/{docs/NgrokAPI/Services/EndpointLoggingModuleClient.html → doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html} +76 -80
- data/doc/NgrokAPI/Services/{EndpointIPPolicyModuleClient.html → TCPEdgeIPRestrictionModuleClient.html} +62 -66
- data/doc/NgrokAPI/Services/TLSCertificatesClient.html +280 -109
- data/doc/NgrokAPI/Services/{EndpointLoggingModuleClient.html → TLSEdgeBackendModuleClient.html} +76 -80
- data/{docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html → doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html} +62 -66
- data/doc/NgrokAPI/Services/{EndpointMutualTLSModuleClient.html → TLSEdgeMutualTLSModuleClient.html} +62 -66
- data/doc/NgrokAPI/Services/{EndpointTLSTerminationModuleClient.html → TLSEdgeTLSTerminationModuleClient.html} +62 -66
- data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +1799 -0
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +44 -48
- data/doc/NgrokAPI/Services/TunnelsClient.html +249 -15
- data/doc/NgrokAPI/Services/WeightedBackendsClient.html +1799 -0
- data/doc/NgrokAPI/Services.html +4 -4
- data/doc/NgrokAPI.html +3 -3
- data/doc/_index.html +237 -60
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +55 -55
- data/doc/index.html +55 -55
- data/doc/method_list.html +4555 -1843
- data/doc/top-level-namespace.html +2 -2
- data/docs/NgrokAPI/Client.html +270 -180
- data/docs/NgrokAPI/Error.html +2 -2
- data/docs/NgrokAPI/Errors/NotFoundError.html +2 -2
- data/docs/NgrokAPI/Errors.html +2 -2
- data/docs/NgrokAPI/HttpClient.html +147 -4
- data/docs/NgrokAPI/Models/APIKey.html +120 -68
- data/docs/NgrokAPI/Models/AWSAuth.html +83 -31
- data/docs/NgrokAPI/Models/AWSCredentials.html +90 -38
- data/docs/NgrokAPI/Models/AWSRole.html +75 -23
- data/docs/NgrokAPI/Models/AbuseReport.html +109 -57
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +83 -31
- data/docs/NgrokAPI/Models/AgentIngress.html +142 -90
- data/docs/NgrokAPI/Models/CertificateAuthority.html +149 -97
- data/docs/NgrokAPI/Models/Credential.html +121 -69
- data/docs/NgrokAPI/Models/Endpoint.html +1483 -0
- data/docs/NgrokAPI/Models/{EndpointLoggingMutate.html → EndpointBackend.html} +105 -53
- data/docs/NgrokAPI/Models/EndpointBackendMutate.html +669 -0
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +101 -49
- data/docs/NgrokAPI/Models/EndpointCompression.html +82 -30
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +90 -38
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +90 -38
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +90 -38
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +90 -38
- data/docs/NgrokAPI/Models/EndpointOAuth.html +124 -72
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +107 -55
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +116 -64
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +107 -55
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +107 -55
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +106 -54
- data/docs/NgrokAPI/Models/EndpointOIDC.html +133 -81
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +91 -39
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +91 -39
- data/docs/NgrokAPI/Models/EndpointSAML.html +148 -96
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +133 -81
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +91 -39
- data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +669 -0
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +91 -39
- data/{doc/NgrokAPI/Models/EndpointLogging.html → docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html} +95 -117
- data/docs/NgrokAPI/Models/EventDestination.html +122 -70
- data/docs/NgrokAPI/Models/EventSource.html +92 -40
- data/docs/NgrokAPI/Models/EventSourceList.html +76 -24
- data/docs/NgrokAPI/Models/EventSourceReplace.html +91 -39
- data/docs/NgrokAPI/Models/EventSubscription.html +122 -70
- data/docs/NgrokAPI/Models/EventTarget.html +106 -54
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +90 -38
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +90 -38
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +83 -31
- data/docs/NgrokAPI/Models/FailoverBackend.html +1127 -0
- data/{doc/NgrokAPI/Models/EventStream.html → docs/NgrokAPI/Models/HTTPResponseBackend.html} +170 -196
- data/docs/NgrokAPI/Models/HTTPSEdge.html +1361 -0
- data/docs/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +278 -288
- data/docs/NgrokAPI/Models/IPPolicy.html +120 -68
- data/docs/NgrokAPI/Models/IPPolicyRule.html +222 -96
- data/docs/NgrokAPI/Models/IPRestriction.html +130 -78
- data/docs/NgrokAPI/Models/Listable.html +61 -61
- data/docs/NgrokAPI/Models/Ref.html +83 -31
- data/docs/NgrokAPI/Models/ReservedAddr.html +130 -78
- data/docs/NgrokAPI/Models/ReservedDomain.html +151 -99
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +92 -40
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +90 -38
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +90 -38
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +135 -83
- data/docs/NgrokAPI/Models/SSHCredential.html +128 -76
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +148 -96
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +154 -102
- data/docs/NgrokAPI/Models/TCPEdge.html +1287 -0
- data/docs/NgrokAPI/Models/TLSCertificate.html +165 -113
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +90 -38
- data/docs/NgrokAPI/Models/TLSEdge.html +1447 -0
- data/docs/NgrokAPI/Models/Tunnel.html +413 -65
- data/docs/NgrokAPI/Models/TunnelGroupBackend.html +1201 -0
- data/docs/NgrokAPI/Models/TunnelSession.html +126 -74
- data/docs/NgrokAPI/Models/WeightedBackend.html +1127 -0
- data/docs/NgrokAPI/Models.html +4 -4
- data/docs/NgrokAPI/PagedIterator.html +3 -3
- data/docs/NgrokAPI/Services/APIKeysClient.html +244 -109
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +162 -25
- data/docs/NgrokAPI/Services/AgentIngressesClient.html +262 -109
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +262 -109
- data/docs/NgrokAPI/Services/CredentialsClient.html +266 -111
- data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1149 -0
- data/docs/NgrokAPI/Services/{EndpointCircuitBreakerModuleClient.html → EdgeRouteCircuitBreakerModuleClient.html} +205 -99
- data/{doc/NgrokAPI/Services/EndpointCompressionModuleClient.html → docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html} +205 -99
- data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +1149 -0
- data/docs/NgrokAPI/Services/{EndpointOAuthModuleClient.html → EdgeRouteOAuthModuleClient.html} +205 -99
- data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +1149 -0
- data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1149 -0
- data/docs/NgrokAPI/Services/{EndpointResponseHeadersModuleClient.html → EdgeRouteResponseHeadersModuleClient.html} +205 -99
- data/{doc/NgrokAPI/Services/EndpointSAMLModuleClient.html → docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html} +205 -99
- data/{doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html → docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html} +205 -99
- data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1149 -0
- data/docs/NgrokAPI/Services/EdgesHTTPSClient.html +1947 -0
- data/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +2585 -0
- data/docs/NgrokAPI/Services/EdgesTCPClient.html +1947 -0
- data/{doc/NgrokAPI/Services/EndpointConfigurationsClient.html → docs/NgrokAPI/Services/EdgesTLSClient.html} +374 -641
- data/docs/NgrokAPI/Services/EndpointsClient.html +903 -0
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +290 -115
- data/docs/NgrokAPI/Services/EventSourcesClient.html +227 -88
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +291 -116
- data/docs/NgrokAPI/Services/{EventStreamsClient.html → FailoverBackendsClient.html} +342 -335
- data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +1937 -0
- data/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +1039 -0
- data/{doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html → docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html} +76 -80
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +245 -128
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +328 -117
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +305 -114
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +160 -295
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +257 -624
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +304 -109
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +284 -111
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +340 -109
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +381 -110
- data/docs/NgrokAPI/Services/{EndpointOIDCModuleClient.html → TCPEdgeBackendModuleClient.html} +76 -80
- data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +1039 -0
- data/docs/NgrokAPI/Services/TLSCertificatesClient.html +280 -109
- data/{doc/NgrokAPI/Services/EndpointOIDCModuleClient.html → docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html} +76 -80
- data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +1039 -0
- data/docs/NgrokAPI/Services/{EndpointMutualTLSModuleClient.html → TLSEdgeMutualTLSModuleClient.html} +62 -66
- data/docs/NgrokAPI/Services/{EndpointTLSTerminationModuleClient.html → TLSEdgeTLSTerminationModuleClient.html} +62 -66
- data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +1799 -0
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +44 -48
- data/docs/NgrokAPI/Services/TunnelsClient.html +249 -15
- data/docs/NgrokAPI/Services/WeightedBackendsClient.html +1799 -0
- data/docs/NgrokAPI/Services.html +4 -4
- data/docs/NgrokAPI.html +3 -3
- data/docs/_index.html +237 -60
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +55 -55
- data/docs/index.html +55 -55
- data/docs/method_list.html +4555 -1843
- data/docs/top-level-namespace.html +2 -2
- data/lib/ngrokapi/client.rb +47 -24
- data/lib/ngrokapi/http_client.rb +21 -2
- data/lib/ngrokapi/models/abuse_report.rb +16 -12
- data/lib/ngrokapi/models/abuse_report_hostname.rb +11 -7
- data/lib/ngrokapi/models/agent_ingress.rb +17 -13
- data/lib/ngrokapi/models/api_key.rb +15 -11
- data/lib/ngrokapi/models/aws_auth.rb +11 -7
- data/lib/ngrokapi/models/aws_credentials.rb +11 -7
- data/lib/ngrokapi/models/aws_role.rb +10 -6
- data/lib/ngrokapi/models/certificate_authority.rb +20 -16
- data/lib/ngrokapi/models/credential.rb +16 -12
- data/lib/ngrokapi/models/endpoint.rb +53 -0
- data/lib/ngrokapi/models/endpoint_backend.rb +31 -0
- data/lib/ngrokapi/models/endpoint_backend_mutate.rb +31 -0
- data/lib/ngrokapi/models/endpoint_circuit_breaker.rb +15 -11
- data/lib/ngrokapi/models/endpoint_compression.rb +10 -6
- data/lib/ngrokapi/models/endpoint_ip_policy.rb +11 -7
- data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb +11 -7
- data/lib/ngrokapi/models/endpoint_mutual_tls.rb +11 -7
- data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb +11 -7
- data/lib/ngrokapi/models/endpoint_o_auth.rb +16 -12
- data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb +14 -10
- data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb +16 -12
- data/lib/ngrokapi/models/endpoint_o_auth_google.rb +14 -10
- data/lib/ngrokapi/models/endpoint_o_auth_microsoft.rb +14 -10
- data/lib/ngrokapi/models/endpoint_o_auth_provider.rb +13 -9
- data/lib/ngrokapi/models/endpoint_oidc.rb +18 -14
- data/lib/ngrokapi/models/endpoint_request_headers.rb +12 -8
- data/lib/ngrokapi/models/endpoint_response_headers.rb +12 -8
- data/lib/ngrokapi/models/endpoint_saml.rb +25 -21
- data/lib/ngrokapi/models/endpoint_saml_mutate.rb +20 -16
- data/lib/ngrokapi/models/endpoint_tls_termination.rb +12 -8
- data/lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb +31 -0
- data/lib/ngrokapi/models/endpoint_webhook_validation.rb +12 -8
- data/lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb +29 -0
- data/lib/ngrokapi/models/event_destination.rb +17 -14
- data/lib/ngrokapi/models/event_source.rb +13 -9
- data/lib/ngrokapi/models/event_source_list.rb +11 -7
- data/lib/ngrokapi/models/event_source_replace.rb +12 -8
- data/lib/ngrokapi/models/event_subscription.rb +16 -12
- data/lib/ngrokapi/models/event_target.rb +13 -9
- data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb +11 -7
- data/lib/ngrokapi/models/event_target_firehose.rb +11 -7
- data/lib/ngrokapi/models/event_target_kinesis.rb +11 -7
- data/lib/ngrokapi/models/failover_backend.rb +69 -0
- data/lib/ngrokapi/models/http_response_backend.rb +75 -0
- data/lib/ngrokapi/models/https_edge.rb +84 -0
- data/lib/ngrokapi/models/https_edge_route.rb +137 -0
- data/lib/ngrokapi/models/ip_policy.rb +15 -11
- data/lib/ngrokapi/models/ip_policy_rule.rb +19 -13
- data/lib/ngrokapi/models/ip_restriction.rb +17 -13
- data/lib/ngrokapi/models/listable.rb +9 -9
- data/lib/ngrokapi/models/ref.rb +11 -7
- data/lib/ngrokapi/models/reserved_addr.rb +17 -13
- data/lib/ngrokapi/models/reserved_domain.rb +23 -19
- data/lib/ngrokapi/models/reserved_domain_cert_job.rb +13 -9
- data/lib/ngrokapi/models/reserved_domain_cert_policy.rb +11 -7
- data/lib/ngrokapi/models/reserved_domain_cert_status.rb +11 -7
- data/lib/ngrokapi/models/ssh_certificate_authority.rb +16 -12
- data/lib/ngrokapi/models/ssh_credential.rb +16 -12
- data/lib/ngrokapi/models/ssh_host_certificate.rb +21 -17
- data/lib/ngrokapi/models/ssh_user_certificate.rb +23 -19
- data/lib/ngrokapi/models/tcp_edge.rb +82 -0
- data/lib/ngrokapi/models/tls_certificate.rb +30 -26
- data/lib/ngrokapi/models/tls_certificate_sa_ns.rb +11 -7
- data/lib/ngrokapi/models/tls_edge.rb +92 -0
- data/lib/ngrokapi/models/tunnel.rb +25 -13
- data/lib/ngrokapi/models/tunnel_group_backend.rb +71 -0
- data/lib/ngrokapi/models/tunnel_session.rb +19 -15
- data/lib/ngrokapi/models/weighted_backend.rb +69 -0
- data/lib/ngrokapi/paged_iterator.rb +1 -1
- data/lib/ngrokapi/services/abuse_reports_client.rb +25 -3
- data/lib/ngrokapi/services/agent_ingresses_client.rb +32 -11
- data/lib/ngrokapi/services/api_keys_client.rb +30 -11
- data/lib/ngrokapi/services/certificate_authorities_client.rb +31 -11
- data/lib/ngrokapi/services/credentials_client.rb +34 -11
- data/lib/ngrokapi/services/edge_route_backend_module_client.rb +118 -0
- data/lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb +118 -0
- data/lib/ngrokapi/services/edge_route_compression_module_client.rb +118 -0
- data/lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb +118 -0
- data/lib/ngrokapi/services/edge_route_o_auth_module_client.rb +118 -0
- data/lib/ngrokapi/services/edge_route_oidc_module_client.rb +118 -0
- data/lib/ngrokapi/services/edge_route_request_headers_module_client.rb +118 -0
- data/lib/ngrokapi/services/edge_route_response_headers_module_client.rb +118 -0
- data/lib/ngrokapi/services/edge_route_saml_module_client.rb +118 -0
- data/lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb +118 -0
- data/lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb +118 -0
- data/lib/ngrokapi/services/edges_https_client.rb +251 -0
- data/lib/ngrokapi/services/edges_https_routes_client.rb +292 -0
- data/lib/ngrokapi/services/edges_tcp_client.rb +251 -0
- data/lib/ngrokapi/services/edges_tls_client.rb +267 -0
- data/lib/ngrokapi/services/endpoints_client.rb +112 -0
- data/lib/ngrokapi/services/event_destinations_client.rb +37 -15
- data/lib/ngrokapi/services/event_sources_client.rb +27 -7
- data/lib/ngrokapi/services/event_subscriptions_client.rb +36 -14
- data/lib/ngrokapi/services/failover_backends_client.rb +234 -0
- data/lib/ngrokapi/services/http_response_backends_client.rb +220 -0
- data/lib/ngrokapi/services/{endpoint_oidc_module_client.rb → https_edge_mutual_tls_module_client.rb} +27 -29
- data/lib/ngrokapi/services/https_edge_tls_termination_module_client.rb +106 -0
- data/lib/ngrokapi/services/ip_policies_client.rb +31 -14
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +38 -12
- data/lib/ngrokapi/services/ip_restrictions_client.rb +36 -12
- data/lib/ngrokapi/services/reserved_addrs_client.rb +31 -48
- data/lib/ngrokapi/services/reserved_domains_client.rb +37 -85
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +35 -11
- data/lib/ngrokapi/services/ssh_credentials_client.rb +34 -11
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +39 -11
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +44 -12
- data/lib/ngrokapi/services/{endpoint_logging_module_client.rb → tcp_edge_backend_module_client.rb} +27 -29
- data/lib/ngrokapi/services/{endpoint_ip_policy_module_client.rb → tcp_edge_ip_restriction_module_client.rb} +21 -23
- data/lib/ngrokapi/services/tls_certificates_client.rb +33 -11
- data/lib/ngrokapi/services/{endpoint_saml_module_client.rb → tls_edge_backend_module_client.rb} +27 -29
- data/lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb +106 -0
- data/lib/ngrokapi/services/{endpoint_mutual_tls_module_client.rb → tls_edge_mutual_tls_module_client.rb} +21 -23
- data/lib/ngrokapi/services/{endpoint_tls_termination_module_client.rb → tls_edge_tls_termination_module_client.rb} +21 -23
- data/lib/ngrokapi/services/tunnel_group_backends_client.rb +232 -0
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +6 -8
- data/lib/ngrokapi/services/tunnels_client.rb +39 -6
- data/lib/ngrokapi/services/weighted_backends_client.rb +234 -0
- data/lib/ngrokapi/version.rb +1 -1
- data/lib/ngrokapi.rb +1 -1
- data/spec/ngrokapi/client_spec.rb +44 -23
- data/spec/ngrokapi/models/abuse_report_hostname_spec.rb +2 -2
- data/spec/ngrokapi/models/abuse_report_spec.rb +2 -2
- data/spec/ngrokapi/models/agent_ingress_spec.rb +2 -2
- data/spec/ngrokapi/models/api_key_spec.rb +2 -2
- data/spec/ngrokapi/models/aws_auth_spec.rb +2 -2
- data/spec/ngrokapi/models/aws_credentials_spec.rb +2 -2
- data/spec/ngrokapi/models/aws_role_spec.rb +2 -2
- data/spec/ngrokapi/models/certificate_authority_spec.rb +2 -2
- data/spec/ngrokapi/models/credential_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_backend_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_backend_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_circuit_breaker_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_compression_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_ip_policy_mutate_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_ip_policy_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_mutual_tls_mutate_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_mutual_tls_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_o_auth_facebook_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_o_auth_git_hub_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_o_auth_google_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_o_auth_microsoft_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_o_auth_provider_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_o_auth_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_oidc_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_request_headers_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_response_headers_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_saml_mutate_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_saml_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_tls_termination_at_edge_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_tls_termination_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_webhook_validation_spec.rb +2 -2
- data/spec/ngrokapi/models/endpoint_websocket_tcp_converter_spec.rb +21 -0
- data/spec/ngrokapi/models/event_destination_spec.rb +2 -2
- data/spec/ngrokapi/models/event_source_list_spec.rb +2 -2
- data/spec/ngrokapi/models/event_source_replace_spec.rb +2 -2
- data/spec/ngrokapi/models/event_source_spec.rb +2 -2
- data/spec/ngrokapi/models/event_subscription_spec.rb +2 -2
- data/spec/ngrokapi/models/event_target_cloudwatch_logs_spec.rb +2 -2
- data/spec/ngrokapi/models/event_target_firehose_spec.rb +2 -2
- data/spec/ngrokapi/models/event_target_kinesis_spec.rb +2 -2
- data/spec/ngrokapi/models/event_target_spec.rb +2 -2
- data/spec/ngrokapi/models/failover_backend_spec.rb +45 -0
- data/spec/ngrokapi/models/http_response_backend_spec.rb +51 -0
- data/spec/ngrokapi/models/https_edge_route_spec.rb +81 -0
- data/spec/ngrokapi/models/https_edge_spec.rb +51 -0
- data/spec/ngrokapi/models/ip_policy_rule_spec.rb +2 -2
- data/spec/ngrokapi/models/ip_policy_spec.rb +2 -2
- data/spec/ngrokapi/models/ip_restriction_spec.rb +2 -2
- data/spec/ngrokapi/models/listable_spec.rb +2 -2
- data/spec/ngrokapi/models/ref_spec.rb +2 -2
- data/spec/ngrokapi/models/reserved_addr_spec.rb +2 -2
- data/spec/ngrokapi/models/reserved_domain_cert_job_spec.rb +2 -2
- data/spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb +2 -2
- data/spec/ngrokapi/models/reserved_domain_cert_status_spec.rb +2 -2
- data/spec/ngrokapi/models/reserved_domain_spec.rb +2 -2
- data/spec/ngrokapi/models/ssh_certificate_authority_spec.rb +2 -2
- data/spec/ngrokapi/models/ssh_credential_spec.rb +2 -2
- data/spec/ngrokapi/models/ssh_host_certificate_spec.rb +2 -2
- data/spec/ngrokapi/models/ssh_user_certificate_spec.rb +2 -2
- data/spec/ngrokapi/models/tcp_edge_spec.rb +51 -0
- data/spec/ngrokapi/models/tls_certificate_sa_ns_spec.rb +2 -2
- data/spec/ngrokapi/models/tls_certificate_spec.rb +2 -2
- data/spec/ngrokapi/models/tls_edge_spec.rb +57 -0
- data/spec/ngrokapi/models/tunnel_group_backend_spec.rb +45 -0
- data/spec/ngrokapi/models/tunnel_session_spec.rb +2 -2
- data/spec/ngrokapi/models/tunnel_spec.rb +2 -2
- data/spec/ngrokapi/models/weighted_backend_spec.rb +45 -0
- data/spec/ngrokapi/paged_iterator_spec.rb +5 -5
- data/spec/ngrokapi/services/abuse_reports_client_spec.rb +19 -0
- data/spec/ngrokapi/services/agent_ingresses_client_spec.rb +21 -0
- data/spec/ngrokapi/services/api_keys_client_spec.rb +19 -0
- data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +21 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +21 -0
- data/spec/ngrokapi/services/edge_route_backend_module_client_spec.rb +137 -0
- data/spec/ngrokapi/services/{endpoint_circuit_breaker_module_client_spec.rb → edge_route_circuit_breaker_module_client_spec.rb} +33 -21
- data/spec/ngrokapi/services/{endpoint_compression_module_client_spec.rb → edge_route_compression_module_client_spec.rb} +33 -21
- data/spec/ngrokapi/services/edge_route_ip_restriction_module_client_spec.rb +137 -0
- data/spec/ngrokapi/services/{endpoint_o_auth_module_client_spec.rb → edge_route_o_auth_module_client_spec.rb} +33 -21
- data/spec/ngrokapi/services/{endpoint_oidc_module_client_spec.rb → edge_route_oidc_module_client_spec.rb} +33 -21
- data/spec/ngrokapi/services/{endpoint_request_headers_module_client_spec.rb → edge_route_request_headers_module_client_spec.rb} +33 -21
- data/spec/ngrokapi/services/{endpoint_response_headers_module_client_spec.rb → edge_route_response_headers_module_client_spec.rb} +33 -21
- data/spec/ngrokapi/services/{endpoint_saml_module_client_spec.rb → edge_route_saml_module_client_spec.rb} +33 -21
- data/spec/ngrokapi/services/{endpoint_webhook_validation_module_client_spec.rb → edge_route_webhook_verification_module_client_spec.rb} +33 -21
- data/spec/ngrokapi/services/edge_route_websocket_tcp_converter_module_client_spec.rb +137 -0
- data/spec/ngrokapi/services/edges_https_client_spec.rb +200 -0
- data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +288 -0
- data/spec/ngrokapi/services/edges_tcp_client_spec.rb +200 -0
- data/spec/ngrokapi/services/edges_tls_client_spec.rb +216 -0
- data/spec/ngrokapi/services/endpoints_client_spec.rb +57 -0
- data/spec/ngrokapi/services/event_destinations_client_spec.rb +24 -0
- data/spec/ngrokapi/services/event_sources_client_spec.rb +21 -0
- data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +23 -0
- data/spec/ngrokapi/services/failover_backends_client_spec.rb +184 -0
- data/spec/ngrokapi/services/http_response_backends_client_spec.rb +200 -0
- data/spec/ngrokapi/services/{endpoint_mutual_tls_module_client_spec.rb → https_edge_mutual_tls_module_client_spec.rb} +19 -21
- data/spec/ngrokapi/services/{endpoint_tls_termination_module_client_spec.rb → https_edge_tls_termination_module_client_spec.rb} +19 -21
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +20 -1
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +28 -1
- data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +25 -0
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +22 -44
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +29 -88
- data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +25 -0
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +23 -0
- data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +29 -0
- data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +33 -0
- data/spec/ngrokapi/services/tcp_edge_backend_module_client_spec.rb +123 -0
- data/spec/ngrokapi/services/{endpoint_ip_policy_module_client_spec.rb → tcp_edge_ip_restriction_module_client_spec.rb} +19 -21
- data/spec/ngrokapi/services/tls_certificates_client_spec.rb +23 -0
- data/spec/ngrokapi/services/tls_edge_backend_module_client_spec.rb +123 -0
- data/spec/ngrokapi/services/tls_edge_ip_restriction_module_client_spec.rb +123 -0
- data/spec/ngrokapi/services/tls_edge_mutual_tls_module_client_spec.rb +123 -0
- data/spec/ngrokapi/services/tls_edge_tls_termination_module_client_spec.rb +123 -0
- data/spec/ngrokapi/services/tunnel_group_backends_client_spec.rb +184 -0
- data/spec/ngrokapi/services/tunnels_client_spec.rb +36 -0
- data/spec/ngrokapi/services/weighted_backends_client_spec.rb +184 -0
- data/spec/spec_helper.rb +326 -33
- metadata +166 -76
- data/doc/README +0 -94
- data/docs/README +0 -94
- data/lib/ngrokapi/models/endpoint_configuration.rb +0 -130
- data/lib/ngrokapi/models/endpoint_logging.rb +0 -27
- data/lib/ngrokapi/models/endpoint_logging_mutate.rb +0 -27
- data/lib/ngrokapi/models/event_stream.rb +0 -77
- data/lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb +0 -108
- data/lib/ngrokapi/services/endpoint_compression_module_client.rb +0 -108
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +0 -289
- data/lib/ngrokapi/services/endpoint_o_auth_module_client.rb +0 -108
- data/lib/ngrokapi/services/endpoint_request_headers_module_client.rb +0 -108
- data/lib/ngrokapi/services/endpoint_response_headers_module_client.rb +0 -108
- data/lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb +0 -108
- data/lib/ngrokapi/services/event_streams_client.rb +0 -224
- data/spec/ngrokapi/models/endpoint_configuration_spec.rb +0 -78
- data/spec/ngrokapi/models/endpoint_logging_mutate_spec.rb +0 -21
- data/spec/ngrokapi/models/endpoint_logging_spec.rb +0 -21
- data/spec/ngrokapi/models/event_stream_spec.rb +0 -51
- data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +0 -237
- data/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb +0 -125
- data/spec/ngrokapi/services/event_streams_client_spec.rb +0 -177
data/docs/index.html
CHANGED
@@ -58,7 +58,7 @@
|
|
58
58
|
</div>
|
59
59
|
|
60
60
|
<div id="content"><div id='filecontents'>
|
61
|
-
<h1 id="label-ngrok
|
61
|
+
<h1 id="label-ngrok+API+client+library+for+Ruby">ngrok API client library for Ruby</h1>
|
62
62
|
|
63
63
|
<p>This library wraps the <a href="https://ngrok.com/docs/api">ngrok HTTP API</a> to make it easier to consume in Ruby.</p>
|
64
64
|
|
@@ -69,83 +69,83 @@
|
|
69
69
|
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_gem'>gem</span> <span class='id identifier rubyid_install'>install</span> <span class='id identifier rubyid_ngrok'>ngrok</span><span class='op'>-</span><span class='id identifier rubyid_api'>api</span>
|
70
70
|
</code></pre>
|
71
71
|
|
72
|
-
<h2 id="label-
|
73
|
-
|
74
|
-
<p>Please consult the <a href="https://ruby-api.docs.ngrok.com">documentation</a> for additional examples.</p>
|
75
|
-
|
76
|
-
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>'</span></span>
|
77
|
-
<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
78
|
-
|
79
|
-
<span class='comment'># Get an instance of the api_keys client and list all API keys
|
80
|
-
</span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
|
81
|
-
<span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span>
|
82
|
-
</code></pre>
|
72
|
+
<h2 id="label-Documentation">Documentation</h2>
|
83
73
|
|
84
|
-
<
|
74
|
+
<p>A quickstart guide and a full API reference are included in the <a href="https://ruby-api.docs.ngrok.com">ngrok Ruby API documentation</a></p>
|
85
75
|
|
86
|
-
<
|
76
|
+
<h2 id="label-Quickstart">Quickstart</h2>
|
87
77
|
|
88
|
-
<
|
89
|
-
<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
78
|
+
<p>Please consult the <a href="https://ruby-api.docs.ngrok.com">documentation</a> for additional examples.</p>
|
90
79
|
|
91
|
-
<span class='
|
92
|
-
</span><span class='
|
93
|
-
|
94
|
-
<span class='
|
95
|
-
|
96
|
-
<span class='
|
80
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_require'>require</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>ngrokapi</span><span class='tstring_end'>'</span></span>
|
81
|
+
<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
82
|
+
|
83
|
+
<span class='comment'># Get an instance of the api_keys client and list all API keys
|
84
|
+
</span><span class='id identifier rubyid_keys_client'>keys_client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_api_keys'>api_keys</span>
|
85
|
+
<span class='id identifier rubyid_keys_client'>keys_client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span>
|
86
|
+
|
87
|
+
<span class='comment'># Or set up an edge and backend with the ability to change your configuration later
|
88
|
+
</span><span class='id identifier rubyid_edge'>edge</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_edges'>edges</span><span class='period'>.</span><span class='id identifier rubyid_https'>https</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span>
|
89
|
+
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>A Ruby Created Edge</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
90
|
+
<span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>{"client": "ruby"}</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
91
|
+
<span class='label'>hostports:</span> <span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>your-subdomain.ngrok.io:443</span><span class='tstring_end'>"</span></span><span class='rbracket'>]</span>
|
92
|
+
<span class='rparen'>)</span>
|
93
|
+
|
94
|
+
<span class='id identifier rubyid_backend'>backend</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_backends'>backends</span><span class='period'>.</span><span class='id identifier rubyid_tunnel_group'>tunnel_group</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span>
|
95
|
+
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>A Ruby Created Backend</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
96
|
+
<span class='label'>labels:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>client_example</span><span class='label_end'>":</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>ruby</span><span class='tstring_end'>"</span></span><span class='rbrace'>}</span>
|
97
|
+
<span class='rparen'>)</span>
|
98
|
+
|
99
|
+
<span class='id identifier rubyid_route'>route</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_edges'>edges</span><span class='period'>.</span><span class='id identifier rubyid_https_routes'>https_routes</span><span class='period'>.</span><span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span>
|
100
|
+
<span class='label'>edge_id:</span> <span class='id identifier rubyid_edge'>edge</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
101
|
+
<span class='label'>match_type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>path_prefix</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
102
|
+
<span class='label'>match:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>/</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
103
|
+
<span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>Root</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
104
|
+
<span class='label'>backend:</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="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models/EndpointBackendMutate.html" title="NgrokAPI::Models::EndpointBackendMutate (class)">EndpointBackendMutate</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Models/EndpointBackendMutate.html#initialize-instance_method" title="NgrokAPI::Models::EndpointBackendMutate#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>attrs:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>enabled</span><span class='label_end'>":</span> <span class='kw'>true</span><span class='comma'>,</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>backend_id</span><span class='label_end'>":</span> <span class='id identifier rubyid_backend'>backend</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='rbrace'>}</span><span class='rparen'>)</span><span class='comma'>,</span>
|
105
|
+
<span class='label'>compression:</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="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html#initialize-instance_method" title="NgrokAPI::Models::EndpointCompression#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>attrs:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>enabled</span><span class='label_end'>":</span> <span class='kw'>true</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
106
|
+
<span class='rparen'>)</span>
|
107
|
+
|
108
|
+
<span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_edge_modules'>edge_modules</span><span class='period'>.</span><span class='id identifier rubyid_https_edge_route_compression'>https_edge_route_compression</span><span class='period'>.</span><span class='id identifier rubyid_replace!'>replace!</span><span class='lparen'>(</span>
|
109
|
+
<span class='label'>edge_id:</span> <span class='id identifier rubyid_edge'>edge</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
110
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_route'>route</span><span class='period'>.</span><span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
111
|
+
<span class='label'>a_module:</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="NgrokAPI/Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html" title="NgrokAPI::Models::EndpointCompression (class)">EndpointCompression</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Models/EndpointCompression.html#initialize-instance_method" title="NgrokAPI::Models::EndpointCompression#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>attrs:</span> <span class='lbrace'>{</span><span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_content'>enabled</span><span class='label_end'>":</span> <span class='kw'>false</span><span class='rbrace'>}</span><span class='rparen'>)</span>
|
112
|
+
<span class='rparen'>)</span>
|
97
113
|
</code></pre>
|
98
114
|
|
99
|
-
<h2 id="label-
|
100
|
-
|
101
|
-
<p>Instance methods like <code>update</code> and <code>delete</code> can be invoked on an instance of an API object itself as well as directly without needing to first fetch the object.</p>
|
115
|
+
<h2 id="label-Local+Documentation">Local Documentation</h2>
|
102
116
|
|
103
|
-
<
|
104
|
-
<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
117
|
+
<p>Documentation can be generated with the command:</p>
|
105
118
|
|
106
|
-
<span class='
|
107
|
-
</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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_content'>cr_1kYyunEyn6XHHlqyMBLrj5nxkoz</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
108
|
-
<span class='id identifier rubyid_cred'>cred</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>metadata:</span> <span class='lbrace'>{</span><span class='label'>server_name:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>giraffe-1</span><span class='tstring_end'>'</span></span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
|
109
|
-
|
110
|
-
<span class='comment'># or do it in single call
|
111
|
-
</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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_content'>cr_1kYyunEyn6XHHlqyMBLrj5nxkoz</span><span class='tstring_end'>'</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='lbrace'>{</span><span class='label'>server_name:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>giraffe-1</span><span class='tstring_end'>'</span></span><span class='rbrace'>}</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
|
119
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_yard'>yard</span> <span class='id identifier rubyid_doc'>doc</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>lib/**/*.rb</span><span class='tstring_end'>'</span></span>
|
112
120
|
</code></pre>
|
113
121
|
|
114
|
-
<
|
115
|
-
|
116
|
-
<p>Most methods that interact with the API have a <code>!</code> counterpart. It raises an error when one is returned by the API.</p>
|
122
|
+
<p>This will generate documentation which can be viewed within the doc folder.</p>
|
117
123
|
|
118
|
-
<
|
119
|
-
<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
124
|
+
<h2 id="label-Specs">Specs</h2>
|
120
125
|
|
121
|
-
<
|
122
|
-
</span><span class='comment'># the error is simply returned
|
123
|
-
</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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_content'>invalid</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
126
|
+
<p>Specs can be run with the command:</p>
|
124
127
|
|
125
|
-
<span class='
|
126
|
-
</span><span class='id identifier rubyid_cred'>cred</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span><span class='period'>.</span><span class='id identifier rubyid_credentials'>credentials</span><span class='period'>.</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_content'>invalid</span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
128
|
+
<pre class="code ruby"><code class="ruby"><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rake'>rake</span>
|
127
129
|
</code></pre>
|
128
130
|
|
129
|
-
<
|
131
|
+
<p>This will generate a coverage report which can be viewed within the coverage folder.</p>
|
130
132
|
|
131
|
-
<
|
133
|
+
<h2 id="label-Rubocop">Rubocop</h2>
|
132
134
|
|
133
|
-
<
|
134
|
-
<span class='id identifier rubyid_client'>client</span> <span class='op'>=</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="NgrokAPI/Client.html" title="NgrokAPI::Client (class)">Client</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="NgrokAPI/Client.html#initialize-instance_method" title="NgrokAPI::Client#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>api_key:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'><API KEY></span><span class='tstring_end'>'</span></span><span class='rparen'>)</span>
|
135
|
+
<p>Rubocop can be run with the command:</p>
|
135
136
|
|
136
|
-
<span class='
|
137
|
-
|
138
|
-
|
139
|
-
|
140
|
-
|
141
|
-
<span class='kw'>end</span>
|
137
|
+
<pre class="code ruby"><code class="ruby"><span class='comment'># Run rubocop on lib folder
|
138
|
+
</span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>lib</span><span class='tstring_end'>'</span></span>
|
139
|
+
|
140
|
+
<span class='comment'># Run rubcop on all files
|
141
|
+
</span><span class='id identifier rubyid_bundle'>bundle</span> <span class='id identifier rubyid_exec'>exec</span> <span class='id identifier rubyid_rubocop'>rubocop</span>
|
142
142
|
</code></pre>
|
143
143
|
</div></div>
|
144
144
|
|
145
145
|
<div id="footer">
|
146
|
-
Generated on
|
146
|
+
Generated on Mon Apr 11 19:32:55 2022 by
|
147
147
|
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
148
|
-
0.9.27 (ruby-
|
148
|
+
0.9.27 (ruby-2.7.5).
|
149
149
|
</div>
|
150
150
|
|
151
151
|
</div>
|