From d46240aab96fa26e92aea41c3f6ff00b257f092c Mon Sep 17 00:00:00 2001 From: "ngrok-bors-ng[bot]" <52465704+ngrok-bors-ng[bot]@users.noreply.github.com> Date: Mon, 11 Apr 2022 19:33:07 +0000 Subject: [PATCH] cut new release for ngrok-api-ruby --- README.md | 29 +- doc/NgrokAPI.html | 2 +- doc/NgrokAPI/Client.html | 2 +- doc/NgrokAPI/Error.html | 2 +- doc/NgrokAPI/Errors.html | 2 +- doc/NgrokAPI/Errors/NotFoundError.html | 2 +- doc/NgrokAPI/HttpClient.html | 149 +- doc/NgrokAPI/Models.html | 2 +- doc/NgrokAPI/Models/APIKey.html | 248 +- doc/NgrokAPI/Models/AWSAuth.html | 216 +- doc/NgrokAPI/Models/AWSCredentials.html | 216 +- doc/NgrokAPI/Models/AWSRole.html | 214 +- doc/NgrokAPI/Models/AbuseReport.html | 226 +- doc/NgrokAPI/Models/AbuseReportHostname.html | 216 +- doc/NgrokAPI/Models/AgentIngress.html | 252 +- doc/NgrokAPI/Models/CertificateAuthority.html | 258 ++- doc/NgrokAPI/Models/Credential.html | 248 +- doc/NgrokAPI/Models/Endpoint.html | 238 +- doc/NgrokAPI/Models/EndpointBackend.html | 216 +- .../Models/EndpointBackendMutate.html | 216 +- .../Models/EndpointCircuitBreaker.html | 224 +- doc/NgrokAPI/Models/EndpointCompression.html | 214 +- doc/NgrokAPI/Models/EndpointIPPolicy.html | 216 +- .../Models/EndpointIPPolicyMutate.html | 216 +- doc/NgrokAPI/Models/EndpointMutualTLS.html | 216 +- .../Models/EndpointMutualTLSMutate.html | 216 +- doc/NgrokAPI/Models/EndpointOAuth.html | 226 +- .../Models/EndpointOAuthFacebook.html | 222 +- doc/NgrokAPI/Models/EndpointOAuthGitHub.html | 226 +- doc/NgrokAPI/Models/EndpointOAuthGoogle.html | 222 +- .../Models/EndpointOAuthMicrosoft.html | 222 +- .../Models/EndpointOAuthProvider.html | 220 +- doc/NgrokAPI/Models/EndpointOIDC.html | 230 +- .../Models/EndpointRequestHeaders.html | 216 +- .../Models/EndpointResponseHeaders.html | 216 +- doc/NgrokAPI/Models/EndpointSAML.html | 242 +- doc/NgrokAPI/Models/EndpointSAMLMutate.html | 232 +- .../Models/EndpointTLSTermination.html | 218 +- .../Models/EndpointTLSTerminationAtEdge.html | 216 +- .../Models/EndpointWebhookValidation.html | 218 +- .../Models/EndpointWebsocketTCPConverter.html | 214 +- doc/NgrokAPI/Models/EventDestination.html | 238 +- doc/NgrokAPI/Models/EventSource.html | 220 +- doc/NgrokAPI/Models/EventSourceList.html | 216 +- doc/NgrokAPI/Models/EventSourceReplace.html | 218 +- doc/NgrokAPI/Models/EventSubscription.html | 238 +- doc/NgrokAPI/Models/EventTarget.html | 220 +- .../Models/EventTargetCloudwatchLogs.html | 216 +- doc/NgrokAPI/Models/EventTargetFirehose.html | 216 +- doc/NgrokAPI/Models/EventTargetKinesis.html | 216 +- doc/NgrokAPI/Models/FailoverBackend.html | 250 +- doc/NgrokAPI/Models/HTTPResponseBackend.html | 252 +- doc/NgrokAPI/Models/HTTPSEdge.html | 254 +- doc/NgrokAPI/Models/HTTPSEdgeRoute.html | 274 ++- doc/NgrokAPI/Models/IPPolicy.html | 246 +- doc/NgrokAPI/Models/IPPolicyRule.html | 250 +- doc/NgrokAPI/Models/IPRestriction.html | 240 +- doc/NgrokAPI/Models/Listable.html | 168 +- doc/NgrokAPI/Models/Ref.html | 216 +- doc/NgrokAPI/Models/ReservedAddr.html | 238 +- doc/NgrokAPI/Models/ReservedDomain.html | 250 +- .../Models/ReservedDomainCertJob.html | 220 +- .../Models/ReservedDomainCertPolicy.html | 216 +- .../Models/ReservedDomainCertStatus.html | 216 +- .../Models/SSHCertificateAuthority.html | 250 +- doc/NgrokAPI/Models/SSHCredential.html | 248 +- doc/NgrokAPI/Models/SSHHostCertificate.html | 260 ++- doc/NgrokAPI/Models/SSHUserCertificate.html | 264 ++- doc/NgrokAPI/Models/TCPEdge.html | 252 +- doc/NgrokAPI/Models/TLSCertificate.html | 278 ++- doc/NgrokAPI/Models/TLSCertificateSANs.html | 216 +- doc/NgrokAPI/Models/TLSEdge.html | 256 ++- doc/NgrokAPI/Models/Tunnel.html | 234 +- doc/NgrokAPI/Models/TunnelGroupBackend.html | 252 +- doc/NgrokAPI/Models/TunnelSession.html | 230 +- doc/NgrokAPI/Models/WeightedBackend.html | 250 +- doc/NgrokAPI/PagedIterator.html | 4 +- doc/NgrokAPI/Services.html | 2 +- doc/NgrokAPI/Services/APIKeysClient.html | 351 ++- doc/NgrokAPI/Services/AbuseReportsClient.html | 185 +- .../Services/AgentIngressesClient.html | 369 ++- .../CertificateAuthoritiesClient.html | 369 ++- doc/NgrokAPI/Services/CredentialsClient.html | 375 ++- .../EdgeRouteBackendModuleClient.html | 58 +- .../EdgeRouteCircuitBreakerModuleClient.html | 58 +- .../EdgeRouteCompressionModuleClient.html | 58 +- .../EdgeRouteIPRestrictionModuleClient.html | 58 +- .../Services/EdgeRouteOAuthModuleClient.html | 58 +- .../Services/EdgeRouteOIDCModuleClient.html | 58 +- .../EdgeRouteRequestHeadersModuleClient.html | 58 +- .../EdgeRouteResponseHeadersModuleClient.html | 58 +- .../Services/EdgeRouteSAMLModuleClient.html | 58 +- ...eRouteWebhookVerificationModuleClient.html | 58 +- ...outeWebsocketTCPConverterModuleClient.html | 58 +- doc/NgrokAPI/Services/EdgesHTTPSClient.html | 418 +++- .../Services/EdgesHTTPSRoutesClient.html | 611 ++++- doc/NgrokAPI/Services/EdgesTCPClient.html | 418 +++- doc/NgrokAPI/Services/EdgesTLSClient.html | 456 +++- doc/NgrokAPI/Services/EndpointsClient.html | 42 +- .../Services/EventDestinationsClient.html | 399 +++- doc/NgrokAPI/Services/EventSourcesClient.html | 319 ++- .../Services/EventSubscriptionsClient.html | 399 +++- .../Services/FailoverBackendsClient.html | 379 ++- .../Services/HTTPResponseBackendsClient.html | 421 +++- .../HTTPSEdgeMutualTLSModuleClient.html | 58 +- .../HTTPSEdgeTLSTerminationModuleClient.html | 58 +- doc/NgrokAPI/Services/IPPoliciesClient.html | 351 ++- .../Services/IPPolicyRulesClient.html | 411 +++- .../Services/IPRestrictionsClient.html | 415 +++- .../Services/ReservedAddrsClient.html | 371 ++- .../Services/ReservedDomainsClient.html | 501 ++-- .../SSHCertificateAuthoritiesClient.html | 411 +++- .../Services/SSHCredentialsClient.html | 393 +++- .../Services/SSHHostCertificatesClient.html | 447 +++- .../Services/SSHUserCertificatesClient.html | 489 +++- .../Services/TCPEdgeBackendModuleClient.html | 58 +- .../TCPEdgeIPRestrictionModuleClient.html | 58 +- .../Services/TLSCertificatesClient.html | 387 +++- .../Services/TLSEdgeBackendModuleClient.html | 58 +- .../TLSEdgeIPRestrictionModuleClient.html | 58 +- .../TLSEdgeMutualTLSModuleClient.html | 58 +- .../TLSEdgeTLSTerminationModuleClient.html | 58 +- .../Services/TunnelGroupBackendsClient.html | 379 ++- .../Services/TunnelSessionsClient.html | 90 +- doc/NgrokAPI/Services/TunnelsClient.html | 42 +- .../Services/WeightedBackendsClient.html | 385 +++- doc/README | 94 - doc/_index.html | 2 +- doc/file.README.html | 108 +- doc/index.html | 108 +- doc/method_list.html | 2040 +++++++++++------ doc/top-level-namespace.html | 2 +- docs/NgrokAPI.html | 2 +- docs/NgrokAPI/Client.html | 2 +- docs/NgrokAPI/Error.html | 2 +- docs/NgrokAPI/Errors.html | 2 +- docs/NgrokAPI/Errors/NotFoundError.html | 2 +- docs/NgrokAPI/HttpClient.html | 149 +- docs/NgrokAPI/Models.html | 2 +- docs/NgrokAPI/Models/APIKey.html | 248 +- docs/NgrokAPI/Models/AWSAuth.html | 216 +- docs/NgrokAPI/Models/AWSCredentials.html | 216 +- docs/NgrokAPI/Models/AWSRole.html | 214 +- docs/NgrokAPI/Models/AbuseReport.html | 226 +- docs/NgrokAPI/Models/AbuseReportHostname.html | 216 +- docs/NgrokAPI/Models/AgentIngress.html | 252 +- .../NgrokAPI/Models/CertificateAuthority.html | 258 ++- docs/NgrokAPI/Models/Credential.html | 248 +- docs/NgrokAPI/Models/Endpoint.html | 238 +- docs/NgrokAPI/Models/EndpointBackend.html | 216 +- .../Models/EndpointBackendMutate.html | 216 +- .../Models/EndpointCircuitBreaker.html | 224 +- docs/NgrokAPI/Models/EndpointCompression.html | 214 +- docs/NgrokAPI/Models/EndpointIPPolicy.html | 216 +- .../Models/EndpointIPPolicyMutate.html | 216 +- docs/NgrokAPI/Models/EndpointMutualTLS.html | 216 +- .../Models/EndpointMutualTLSMutate.html | 216 +- docs/NgrokAPI/Models/EndpointOAuth.html | 226 +- .../Models/EndpointOAuthFacebook.html | 222 +- docs/NgrokAPI/Models/EndpointOAuthGitHub.html | 226 +- docs/NgrokAPI/Models/EndpointOAuthGoogle.html | 222 +- .../Models/EndpointOAuthMicrosoft.html | 222 +- .../Models/EndpointOAuthProvider.html | 220 +- docs/NgrokAPI/Models/EndpointOIDC.html | 230 +- .../Models/EndpointRequestHeaders.html | 216 +- .../Models/EndpointResponseHeaders.html | 216 +- docs/NgrokAPI/Models/EndpointSAML.html | 242 +- docs/NgrokAPI/Models/EndpointSAMLMutate.html | 232 +- .../Models/EndpointTLSTermination.html | 218 +- .../Models/EndpointTLSTerminationAtEdge.html | 216 +- .../Models/EndpointWebhookValidation.html | 218 +- .../Models/EndpointWebsocketTCPConverter.html | 214 +- docs/NgrokAPI/Models/EventDestination.html | 238 +- docs/NgrokAPI/Models/EventSource.html | 220 +- docs/NgrokAPI/Models/EventSourceList.html | 216 +- docs/NgrokAPI/Models/EventSourceReplace.html | 218 +- docs/NgrokAPI/Models/EventSubscription.html | 238 +- docs/NgrokAPI/Models/EventTarget.html | 220 +- .../Models/EventTargetCloudwatchLogs.html | 216 +- docs/NgrokAPI/Models/EventTargetFirehose.html | 216 +- docs/NgrokAPI/Models/EventTargetKinesis.html | 216 +- docs/NgrokAPI/Models/FailoverBackend.html | 250 +- docs/NgrokAPI/Models/HTTPResponseBackend.html | 252 +- docs/NgrokAPI/Models/HTTPSEdge.html | 254 +- docs/NgrokAPI/Models/HTTPSEdgeRoute.html | 274 ++- docs/NgrokAPI/Models/IPPolicy.html | 246 +- docs/NgrokAPI/Models/IPPolicyRule.html | 250 +- docs/NgrokAPI/Models/IPRestriction.html | 240 +- docs/NgrokAPI/Models/Listable.html | 168 +- docs/NgrokAPI/Models/Ref.html | 216 +- docs/NgrokAPI/Models/ReservedAddr.html | 238 +- docs/NgrokAPI/Models/ReservedDomain.html | 250 +- .../Models/ReservedDomainCertJob.html | 220 +- .../Models/ReservedDomainCertPolicy.html | 216 +- .../Models/ReservedDomainCertStatus.html | 216 +- .../Models/SSHCertificateAuthority.html | 250 +- docs/NgrokAPI/Models/SSHCredential.html | 248 +- docs/NgrokAPI/Models/SSHHostCertificate.html | 260 ++- docs/NgrokAPI/Models/SSHUserCertificate.html | 264 ++- docs/NgrokAPI/Models/TCPEdge.html | 252 +- docs/NgrokAPI/Models/TLSCertificate.html | 278 ++- docs/NgrokAPI/Models/TLSCertificateSANs.html | 216 +- docs/NgrokAPI/Models/TLSEdge.html | 256 ++- docs/NgrokAPI/Models/Tunnel.html | 234 +- docs/NgrokAPI/Models/TunnelGroupBackend.html | 252 +- docs/NgrokAPI/Models/TunnelSession.html | 230 +- docs/NgrokAPI/Models/WeightedBackend.html | 250 +- docs/NgrokAPI/PagedIterator.html | 4 +- docs/NgrokAPI/Services.html | 2 +- docs/NgrokAPI/Services/APIKeysClient.html | 351 ++- .../NgrokAPI/Services/AbuseReportsClient.html | 185 +- .../Services/AgentIngressesClient.html | 369 ++- .../CertificateAuthoritiesClient.html | 369 ++- docs/NgrokAPI/Services/CredentialsClient.html | 375 ++- .../EdgeRouteBackendModuleClient.html | 58 +- .../EdgeRouteCircuitBreakerModuleClient.html | 58 +- .../EdgeRouteCompressionModuleClient.html | 58 +- .../EdgeRouteIPRestrictionModuleClient.html | 58 +- .../Services/EdgeRouteOAuthModuleClient.html | 58 +- .../Services/EdgeRouteOIDCModuleClient.html | 58 +- .../EdgeRouteRequestHeadersModuleClient.html | 58 +- .../EdgeRouteResponseHeadersModuleClient.html | 58 +- .../Services/EdgeRouteSAMLModuleClient.html | 58 +- ...eRouteWebhookVerificationModuleClient.html | 58 +- ...outeWebsocketTCPConverterModuleClient.html | 58 +- docs/NgrokAPI/Services/EdgesHTTPSClient.html | 418 +++- .../Services/EdgesHTTPSRoutesClient.html | 611 ++++- docs/NgrokAPI/Services/EdgesTCPClient.html | 418 +++- docs/NgrokAPI/Services/EdgesTLSClient.html | 456 +++- docs/NgrokAPI/Services/EndpointsClient.html | 42 +- .../Services/EventDestinationsClient.html | 399 +++- .../NgrokAPI/Services/EventSourcesClient.html | 319 ++- .../Services/EventSubscriptionsClient.html | 399 +++- .../Services/FailoverBackendsClient.html | 379 ++- .../Services/HTTPResponseBackendsClient.html | 421 +++- .../HTTPSEdgeMutualTLSModuleClient.html | 58 +- .../HTTPSEdgeTLSTerminationModuleClient.html | 58 +- docs/NgrokAPI/Services/IPPoliciesClient.html | 351 ++- .../Services/IPPolicyRulesClient.html | 411 +++- .../Services/IPRestrictionsClient.html | 415 +++- .../Services/ReservedAddrsClient.html | 371 ++- .../Services/ReservedDomainsClient.html | 501 ++-- .../SSHCertificateAuthoritiesClient.html | 411 +++- .../Services/SSHCredentialsClient.html | 393 +++- .../Services/SSHHostCertificatesClient.html | 447 +++- .../Services/SSHUserCertificatesClient.html | 489 +++- .../Services/TCPEdgeBackendModuleClient.html | 58 +- .../TCPEdgeIPRestrictionModuleClient.html | 58 +- .../Services/TLSCertificatesClient.html | 387 +++- .../Services/TLSEdgeBackendModuleClient.html | 58 +- .../TLSEdgeIPRestrictionModuleClient.html | 58 +- .../TLSEdgeMutualTLSModuleClient.html | 58 +- .../TLSEdgeTLSTerminationModuleClient.html | 58 +- .../Services/TunnelGroupBackendsClient.html | 379 ++- .../Services/TunnelSessionsClient.html | 90 +- docs/NgrokAPI/Services/TunnelsClient.html | 42 +- .../Services/WeightedBackendsClient.html | 385 +++- docs/README | 94 - docs/_index.html | 2 +- docs/file.README.html | 108 +- docs/index.html | 108 +- docs/method_list.html | 2040 +++++++++++------ docs/top-level-namespace.html | 2 +- lib/ngrokapi.rb | 2 +- lib/ngrokapi/http_client.rb | 23 +- lib/ngrokapi/models/abuse_report.rb | 28 +- lib/ngrokapi/models/abuse_report_hostname.rb | 18 +- lib/ngrokapi/models/agent_ingress.rb | 30 +- lib/ngrokapi/models/api_key.rb | 26 +- lib/ngrokapi/models/aws_auth.rb | 18 +- lib/ngrokapi/models/aws_credentials.rb | 18 +- lib/ngrokapi/models/aws_role.rb | 16 +- lib/ngrokapi/models/certificate_authority.rb | 36 +- lib/ngrokapi/models/credential.rb | 28 +- lib/ngrokapi/models/endpoint.rb | 40 +- lib/ngrokapi/models/endpoint_backend.rb | 18 +- .../models/endpoint_backend_mutate.rb | 18 +- .../models/endpoint_circuit_breaker.rb | 26 +- lib/ngrokapi/models/endpoint_compression.rb | 16 +- lib/ngrokapi/models/endpoint_ip_policy.rb | 18 +- .../models/endpoint_ip_policy_mutate.rb | 18 +- lib/ngrokapi/models/endpoint_mutual_tls.rb | 18 +- .../models/endpoint_mutual_tls_mutate.rb | 18 +- lib/ngrokapi/models/endpoint_o_auth.rb | 28 +- .../models/endpoint_o_auth_facebook.rb | 24 +- .../models/endpoint_o_auth_git_hub.rb | 28 +- lib/ngrokapi/models/endpoint_o_auth_google.rb | 24 +- .../models/endpoint_o_auth_microsoft.rb | 24 +- .../models/endpoint_o_auth_provider.rb | 22 +- lib/ngrokapi/models/endpoint_oidc.rb | 32 +- .../models/endpoint_request_headers.rb | 20 +- .../models/endpoint_response_headers.rb | 20 +- lib/ngrokapi/models/endpoint_saml.rb | 46 +- lib/ngrokapi/models/endpoint_saml_mutate.rb | 36 +- .../models/endpoint_tls_termination.rb | 20 +- .../endpoint_tls_termination_at_edge.rb | 18 +- .../models/endpoint_webhook_validation.rb | 20 +- .../endpoint_websocket_tcp_converter.rb | 16 +- lib/ngrokapi/models/event_destination.rb | 28 +- lib/ngrokapi/models/event_source.rb | 22 +- lib/ngrokapi/models/event_source_list.rb | 18 +- lib/ngrokapi/models/event_source_replace.rb | 20 +- lib/ngrokapi/models/event_subscription.rb | 28 +- lib/ngrokapi/models/event_target.rb | 22 +- .../models/event_target_cloudwatch_logs.rb | 18 +- lib/ngrokapi/models/event_target_firehose.rb | 18 +- lib/ngrokapi/models/event_target_kinesis.rb | 18 +- lib/ngrokapi/models/failover_backend.rb | 28 +- lib/ngrokapi/models/http_response_backend.rb | 30 +- lib/ngrokapi/models/https_edge.rb | 32 +- lib/ngrokapi/models/https_edge_route.rb | 52 +- lib/ngrokapi/models/ip_policy.rb | 26 +- lib/ngrokapi/models/ip_policy_rule.rb | 30 +- lib/ngrokapi/models/ip_restriction.rb | 30 +- lib/ngrokapi/models/listable.rb | 18 +- lib/ngrokapi/models/ref.rb | 18 +- lib/ngrokapi/models/reserved_addr.rb | 30 +- lib/ngrokapi/models/reserved_domain.rb | 42 +- .../models/reserved_domain_cert_job.rb | 22 +- .../models/reserved_domain_cert_policy.rb | 18 +- .../models/reserved_domain_cert_status.rb | 18 +- .../models/ssh_certificate_authority.rb | 28 +- lib/ngrokapi/models/ssh_credential.rb | 28 +- lib/ngrokapi/models/ssh_host_certificate.rb | 38 +- lib/ngrokapi/models/ssh_user_certificate.rb | 42 +- lib/ngrokapi/models/tcp_edge.rb | 30 +- lib/ngrokapi/models/tls_certificate.rb | 56 +- lib/ngrokapi/models/tls_certificate_sa_ns.rb | 18 +- lib/ngrokapi/models/tls_edge.rb | 34 +- lib/ngrokapi/models/tunnel.rb | 36 +- lib/ngrokapi/models/tunnel_group_backend.rb | 30 +- lib/ngrokapi/models/tunnel_session.rb | 34 +- lib/ngrokapi/models/weighted_backend.rb | 28 +- lib/ngrokapi/paged_iterator.rb | 2 +- lib/ngrokapi/services/abuse_reports_client.rb | 28 +- .../services/agent_ingresses_client.rb | 43 +- lib/ngrokapi/services/api_keys_client.rb | 41 +- .../certificate_authorities_client.rb | 42 +- lib/ngrokapi/services/credentials_client.rb | 45 +- .../edge_route_backend_module_client.rb | 14 +- ...dge_route_circuit_breaker_module_client.rb | 14 +- .../edge_route_compression_module_client.rb | 14 +- ...edge_route_ip_restriction_module_client.rb | 14 +- .../edge_route_o_auth_module_client.rb | 14 +- .../services/edge_route_oidc_module_client.rb | 14 +- ...dge_route_request_headers_module_client.rb | 14 +- ...ge_route_response_headers_module_client.rb | 14 +- .../services/edge_route_saml_module_client.rb | 14 +- ...oute_webhook_verification_module_client.rb | 14 +- ...e_websocket_tcp_converter_module_client.rb | 14 +- lib/ngrokapi/services/edges_https_client.rb | 46 +- .../services/edges_https_routes_client.rb | 58 +- lib/ngrokapi/services/edges_tcp_client.rb | 46 +- lib/ngrokapi/services/edges_tls_client.rb | 50 +- lib/ngrokapi/services/endpoints_client.rb | 14 +- .../services/event_destinations_client.rb | 46 +- lib/ngrokapi/services/event_sources_client.rb | 34 +- .../services/event_subscriptions_client.rb | 44 +- .../services/failover_backends_client.rb | 46 +- .../services/http_response_backends_client.rb | 43 +- .../https_edge_mutual_tls_module_client.rb | 14 +- ...ttps_edge_tls_termination_module_client.rb | 14 +- lib/ngrokapi/services/ip_policies_client.rb | 41 +- .../services/ip_policy_rules_client.rb | 46 +- .../services/ip_restrictions_client.rb | 46 +- .../services/reserved_addrs_client.rb | 42 +- .../services/reserved_domains_client.rb | 48 +- .../ssh_certificate_authorities_client.rb | 46 +- .../services/ssh_credentials_client.rb | 45 +- .../services/ssh_host_certificates_client.rb | 50 +- .../services/ssh_user_certificates_client.rb | 56 +- .../tcp_edge_backend_module_client.rb | 14 +- .../tcp_edge_ip_restriction_module_client.rb | 14 +- .../services/tls_certificates_client.rb | 44 +- .../tls_edge_backend_module_client.rb | 14 +- .../tls_edge_ip_restriction_module_client.rb | 14 +- .../tls_edge_mutual_tls_module_client.rb | 14 +- .../tls_edge_tls_termination_module_client.rb | 14 +- .../services/tunnel_group_backends_client.rb | 46 +- .../services/tunnel_sessions_client.rb | 14 +- lib/ngrokapi/services/tunnels_client.rb | 14 +- .../services/weighted_backends_client.rb | 52 +- lib/ngrokapi/version.rb | 2 +- .../models/abuse_report_hostname_spec.rb | 4 +- spec/ngrokapi/models/abuse_report_spec.rb | 4 +- spec/ngrokapi/models/agent_ingress_spec.rb | 4 +- spec/ngrokapi/models/api_key_spec.rb | 4 +- spec/ngrokapi/models/aws_auth_spec.rb | 4 +- spec/ngrokapi/models/aws_credentials_spec.rb | 4 +- spec/ngrokapi/models/aws_role_spec.rb | 4 +- .../models/certificate_authority_spec.rb | 4 +- spec/ngrokapi/models/credential_spec.rb | 4 +- .../models/endpoint_backend_mutate_spec.rb | 4 +- spec/ngrokapi/models/endpoint_backend_spec.rb | 4 +- .../models/endpoint_circuit_breaker_spec.rb | 4 +- .../models/endpoint_compression_spec.rb | 4 +- .../models/endpoint_ip_policy_mutate_spec.rb | 4 +- .../models/endpoint_ip_policy_spec.rb | 4 +- .../models/endpoint_mutual_tls_mutate_spec.rb | 4 +- .../models/endpoint_mutual_tls_spec.rb | 4 +- .../models/endpoint_o_auth_facebook_spec.rb | 4 +- .../models/endpoint_o_auth_git_hub_spec.rb | 4 +- .../models/endpoint_o_auth_google_spec.rb | 4 +- .../models/endpoint_o_auth_microsoft_spec.rb | 4 +- .../models/endpoint_o_auth_provider_spec.rb | 4 +- spec/ngrokapi/models/endpoint_o_auth_spec.rb | 4 +- spec/ngrokapi/models/endpoint_oidc_spec.rb | 4 +- .../models/endpoint_request_headers_spec.rb | 4 +- .../models/endpoint_response_headers_spec.rb | 4 +- .../models/endpoint_saml_mutate_spec.rb | 4 +- spec/ngrokapi/models/endpoint_saml_spec.rb | 4 +- spec/ngrokapi/models/endpoint_spec.rb | 4 +- .../endpoint_tls_termination_at_edge_spec.rb | 4 +- .../models/endpoint_tls_termination_spec.rb | 4 +- .../endpoint_webhook_validation_spec.rb | 4 +- .../endpoint_websocket_tcp_converter_spec.rb | 4 +- .../ngrokapi/models/event_destination_spec.rb | 4 +- .../ngrokapi/models/event_source_list_spec.rb | 4 +- .../models/event_source_replace_spec.rb | 4 +- spec/ngrokapi/models/event_source_spec.rb | 4 +- .../models/event_subscription_spec.rb | 4 +- .../event_target_cloudwatch_logs_spec.rb | 4 +- .../models/event_target_firehose_spec.rb | 4 +- .../models/event_target_kinesis_spec.rb | 4 +- spec/ngrokapi/models/event_target_spec.rb | 4 +- spec/ngrokapi/models/failover_backend_spec.rb | 4 +- .../models/http_response_backend_spec.rb | 4 +- spec/ngrokapi/models/https_edge_route_spec.rb | 4 +- spec/ngrokapi/models/https_edge_spec.rb | 4 +- spec/ngrokapi/models/ip_policy_rule_spec.rb | 4 +- spec/ngrokapi/models/ip_policy_spec.rb | 4 +- spec/ngrokapi/models/ip_restriction_spec.rb | 4 +- spec/ngrokapi/models/listable_spec.rb | 4 +- spec/ngrokapi/models/ref_spec.rb | 4 +- spec/ngrokapi/models/reserved_addr_spec.rb | 4 +- .../models/reserved_domain_cert_job_spec.rb | 4 +- .../reserved_domain_cert_policy_spec.rb | 4 +- .../reserved_domain_cert_status_spec.rb | 4 +- spec/ngrokapi/models/reserved_domain_spec.rb | 4 +- .../models/ssh_certificate_authority_spec.rb | 4 +- spec/ngrokapi/models/ssh_credential_spec.rb | 4 +- .../models/ssh_host_certificate_spec.rb | 4 +- .../models/ssh_user_certificate_spec.rb | 4 +- spec/ngrokapi/models/tcp_edge_spec.rb | 4 +- .../models/tls_certificate_sa_ns_spec.rb | 4 +- spec/ngrokapi/models/tls_certificate_spec.rb | 4 +- spec/ngrokapi/models/tls_edge_spec.rb | 4 +- .../models/tunnel_group_backend_spec.rb | 4 +- spec/ngrokapi/models/tunnel_session_spec.rb | 4 +- spec/ngrokapi/models/tunnel_spec.rb | 4 +- spec/ngrokapi/models/weighted_backend_spec.rb | 4 +- spec/ngrokapi/paged_iterator_spec.rb | 10 +- .../services/abuse_reports_client_spec.rb | 19 + .../services/agent_ingresses_client_spec.rb | 21 + .../ngrokapi/services/api_keys_client_spec.rb | 19 + .../certificate_authorities_client_spec.rb | 21 + .../services/credentials_client_spec.rb | 21 + .../edge_route_backend_module_client_spec.rb | 6 +- ...oute_circuit_breaker_module_client_spec.rb | 6 +- ...ge_route_compression_module_client_spec.rb | 6 +- ...route_ip_restriction_module_client_spec.rb | 6 +- .../edge_route_o_auth_module_client_spec.rb | 6 +- .../edge_route_oidc_module_client_spec.rb | 6 +- ...oute_request_headers_module_client_spec.rb | 6 +- ...ute_response_headers_module_client_spec.rb | 6 +- .../edge_route_saml_module_client_spec.rb | 6 +- ...webhook_verification_module_client_spec.rb | 6 +- ...socket_tcp_converter_module_client_spec.rb | 6 +- .../services/edges_https_client_spec.rb | 25 + .../edges_https_routes_client_spec.rb | 47 + .../services/edges_tcp_client_spec.rb | 25 + .../services/edges_tls_client_spec.rb | 29 + .../event_destinations_client_spec.rb | 24 + .../services/event_sources_client_spec.rb | 21 + .../event_subscriptions_client_spec.rb | 23 + .../services/failover_backends_client_spec.rb | 21 + .../http_response_backends_client_spec.rb | 25 + ...ttps_edge_mutual_tls_module_client_spec.rb | 6 +- ...edge_tls_termination_module_client_spec.rb | 6 +- .../services/ip_policies_client_spec.rb | 20 + .../services/ip_policy_rules_client_spec.rb | 25 + .../services/ip_restrictions_client_spec.rb | 25 + .../services/reserved_addrs_client_spec.rb | 22 + .../services/reserved_domains_client_spec.rb | 29 + ...ssh_certificate_authorities_client_spec.rb | 25 + .../services/ssh_credentials_client_spec.rb | 23 + .../ssh_host_certificates_client_spec.rb | 29 + .../ssh_user_certificates_client_spec.rb | 33 + .../tcp_edge_backend_module_client_spec.rb | 6 +- ..._edge_ip_restriction_module_client_spec.rb | 6 +- .../services/tls_certificates_client_spec.rb | 23 + .../tls_edge_backend_module_client_spec.rb | 6 +- ..._edge_ip_restriction_module_client_spec.rb | 6 +- .../tls_edge_mutual_tls_module_client_spec.rb | 6 +- ...edge_tls_termination_module_client_spec.rb | 6 +- .../tunnel_group_backends_client_spec.rb | 21 + .../services/weighted_backends_client_spec.rb | 21 + 497 files changed, 41825 insertions(+), 22302 deletions(-) delete mode 100644 doc/README delete mode 100644 docs/README diff --git a/README.md b/README.md index 6887299..9112be0 100644 --- a/README.md +++ b/README.md @@ -20,12 +20,39 @@ A quickstart guide and a full API reference are included in the [ngrok Ruby API Please consult the [documentation](https://ruby-api.docs.ngrok.com) for additional examples. ```ruby -require 'ngrokapi/client' +require 'ngrokapi' client = NgrokAPI::Client.new(api_key: '') # Get an instance of the api_keys client and list all API keys keys_client = client.api_keys keys_client.list + +# Or set up an edge and backend with the ability to change your configuration later +edge = client.edges.https.create!( + description: "A Ruby Created Edge", + metadata: '{"client": "ruby"}', + hostports: ["your-subdomain.ngrok.io:443"] +) + +backend = client.backends.tunnel_group.create!( + description: "A Ruby Created Backend", + labels: {"client_example": "ruby"} +) + +route = client.edges.https_routes.create!( + edge_id: edge.id, + match_type: "path_prefix", + match: "/", + description: "Root", + backend: NgrokAPI::Models::EndpointBackendMutate.new(attrs: {"enabled": true, "backend_id": backend.id}), + compression: NgrokAPI::Models::EndpointCompression.new(attrs: {"enabled": true}) +) + +client.edge_modules.https_edge_route_compression.replace!( + edge_id: edge.id, + id: route.id, + a_module: NgrokAPI::Models::EndpointCompression.new(attrs: {"enabled": false}) +) ``` ## Local Documentation diff --git a/doc/NgrokAPI.html b/doc/NgrokAPI.html index 0d571ed..ae57b2d 100644 --- a/doc/NgrokAPI.html +++ b/doc/NgrokAPI.html @@ -147,7 +147,7 @@ diff --git a/doc/NgrokAPI/Client.html b/doc/NgrokAPI/Client.html index c819f5e..8c06260 100644 --- a/doc/NgrokAPI/Client.html +++ b/doc/NgrokAPI/Client.html @@ -1966,7 +1966,7 @@ diff --git a/doc/NgrokAPI/Error.html b/doc/NgrokAPI/Error.html index ef37232..31bde8f 100644 --- a/doc/NgrokAPI/Error.html +++ b/doc/NgrokAPI/Error.html @@ -295,7 +295,7 @@ diff --git a/doc/NgrokAPI/Errors.html b/doc/NgrokAPI/Errors.html index f4bc9d6..5f32c18 100644 --- a/doc/NgrokAPI/Errors.html +++ b/doc/NgrokAPI/Errors.html @@ -105,7 +105,7 @@ diff --git a/doc/NgrokAPI/Errors/NotFoundError.html b/doc/NgrokAPI/Errors/NotFoundError.html index e64b79c..78e7b7b 100644 --- a/doc/NgrokAPI/Errors/NotFoundError.html +++ b/doc/NgrokAPI/Errors/NotFoundError.html @@ -299,7 +299,7 @@ diff --git a/doc/NgrokAPI/HttpClient.html b/doc/NgrokAPI/HttpClient.html index e6bddaf..7be1696 100644 --- a/doc/NgrokAPI/HttpClient.html +++ b/doc/NgrokAPI/HttpClient.html @@ -331,6 +331,30 @@

Make a POST request to a given URI with optional data.

+ + + +
  • + + + #put(path, danger: false, data: {}) ⇒ json + + + + + + + + + + + + + +
    +

    Make a PUT request to a given URI with optional data.

    +
     +
    • @@ -993,7 +1017,7 @@ def patch(path, danger: false, data: {}) uri = get_uri(path) req = Net::HTTP::Patch.new(uri, headers_with_json) - json_do(uri, req, danger: danger, data: data.to_json) + json_do(uri, req, danger: danger, data: deep_to_h(data).to_json) end @@ -1112,7 +1136,126 @@ def post(path, danger: false, data: {}) uri = get_uri(path) req = Net::HTTP::Post.new(uri, headers_with_json) - json_do(uri, req, danger: danger, data: data.to_json) + json_do(uri, req, danger: danger, data: deep_to_h(data).to_json) +end + + + + + +
    +

    + + #put(path, danger: false, data: {}) ⇒ json + + + + + +

    +
    + +

    Make a PUT request to a given URI with optional data

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + path + + + (string) + + + + — +
      +

      URL resource path

      +
      + +
      • + +
    • + + danger + + + (boolean) + + + (defaults to: false) + + + — +
      +

      determine if we should throw an exception on 404 or not

      +
      + +
      • + +
    • + + data + + + (hash) + + + (defaults to: {}) + + + — +
      +

      hash which will be converted to query parameters or form data

      +
      + +
      • + +
    + +

    Returns:

    +
      + +
    • + + + (json) + + + + — +
      +

      response body

      +
      + +
      • + +
    + +
    + + + @@ -1124,7 +1267,7 @@ diff --git a/doc/NgrokAPI/Models.html b/doc/NgrokAPI/Models.html index 01a27e4..0f25ca3 100644 --- a/doc/NgrokAPI/Models.html +++ b/doc/NgrokAPI/Models.html @@ -107,7 +107,7 @@ diff --git a/doc/NgrokAPI/Models/APIKey.html b/doc/NgrokAPI/Models/APIKey.html index d9d4570..a8f7ecb 100644 --- a/doc/NgrokAPI/Models/APIKey.html +++ b/doc/NgrokAPI/Models/APIKey.html @@ -106,6 +106,35 @@

    Instance Attribute Summary collapse

    @@ -538,7 +560,50 @@
    -

    +

    + + #attrs ⇒ Object (readonly) + + + + + +

    +
    + +

    Returns the value of attribute attrs.

    + + +
    +
    +
    + + +
    + 
    +
+
+95
+96
+97
+98
+99
    +     		+ 
    # File 'lib/ngrokapi/http_client.rb', line 95
+
+def put(path, danger: false, data: {})
+  uri = get_uri(path)
+  req = Net::HTTP::Put.new(uri, headers_with_json)
+  json_do(uri, req, danger: danger, data: deep_to_h(data).to_json)
 end
    		 
    # File 'lib/ngrokapi/models/api_key.rb', line 15
 
-def initialize(client:, result:)
+def initialize(client: nil, attrs: {})
   @client = client
-  @result = result
-  @id = @result['id']
-  @uri = @result['uri']
-  @description = @result['description']
-  @metadata = @result['metadata']
-  @created_at = @result['created_at']
-  @token = @result['token']
+  @attrs = attrs
+  @id = @attrs['id']
+  @uri = @attrs['uri']
+  @description = @attrs['description']
+  @metadata = @attrs['metadata']
+  @created_at = @attrs['created_at']
+  @token = @attrs['token']
 end
    + + + + +
    + 
    +
+
+6
+7
+8
    +     		+ 
    # File 'lib/ngrokapi/models/api_key.rb', line 6
+
+def attrs
+  @attrs
+end
    +
    +
    + + + +
    +

    #client ⇒ Object (readonly) @@ -751,49 +816,6 @@

    - -
    -

    - - #result ⇒ Object (readonly) - - - - - -

    -
    - -

    Returns the value of attribute result.

    - - -
    -
    -
    - - -
    - - - - -
    - 
    -
-
-6
-7
-8
    -     		- 
    # File 'lib/ngrokapi/models/api_key.rb', line 6
-
-def result
-  @result
-end
    -
    -
    - -

    @@ -909,7 +931,7 @@ 
    # File 'lib/ngrokapi/models/api_key.rb', line 26
 
 def ==(other)
-  @result == other.result
+  @attrs == other.attrs
 end
    @@ -944,14 +966,14 @@ 
     
 
-38
-39
-40
-41
-42
    +42 +43 +44 +45 +46 - 
    # File 'lib/ngrokapi/models/api_key.rb', line 38
+      
    # File 'lib/ngrokapi/models/api_key.rb', line 42
 
 def delete
   @client.delete(
@@ -961,6 +983,36 @@
     
   
 
+

    + +
    +

    + + #to_h ⇒ Object + + + + + +

    + + + + +
    + 
    +
+
+34
+35
+36
    +     		+ 
    # File 'lib/ngrokapi/models/api_key.rb', line 34
+
+def to_h
+  @attrs.to_h
+end
    +
    @@ -986,7 +1038,7 @@ 
    # File 'lib/ngrokapi/models/api_key.rb', line 30
 
 def to_s
-  @result.to_s
+  @attrs.to_s
 end
    @@ -1021,10 +1073,6 @@ 
     
 
-48
-49
-50
-51
 52
 53
 54
@@ -1032,10 +1080,14 @@
 56
 57
 58
-59
    +59 +60 +61 +62 +63 - 
    # File 'lib/ngrokapi/models/api_key.rb', line 48
+      
    # File 'lib/ngrokapi/models/api_key.rb', line 52
 
 def update(
   description: nil,
@@ -1059,7 +1111,7 @@
    diff --git a/doc/NgrokAPI/Models/AWSAuth.html b/doc/NgrokAPI/Models/AWSAuth.html index 956decd..2d306c9 100644 --- a/doc/NgrokAPI/Models/AWSAuth.html +++ b/doc/NgrokAPI/Models/AWSAuth.html @@ -106,6 +106,35 @@

    Instance Attribute Summary collapse