From a01a9c9fb2d75c97bd31229a00d68522b4c21d93 Mon Sep 17 00:00:00 2001 From: ngrok release bot Date: Fri, 8 Mar 2024 23:11:42 +0000 Subject: [PATCH] Update generated files --- doc/NgrokAPI.html | 8 +- doc/NgrokAPI/Client.html | 34 +- doc/NgrokAPI/Error.html | 6 +- doc/NgrokAPI/Errors.html | 6 +- doc/NgrokAPI/Errors/NotFoundError.html | 6 +- doc/NgrokAPI/HttpClient.html | 8 +- doc/NgrokAPI/Models.html | 10 +- doc/NgrokAPI/Models/APIKey.html | 6 +- doc/NgrokAPI/Models/AWSAuth.html | 6 +- doc/NgrokAPI/Models/AWSCredentials.html | 6 +- doc/NgrokAPI/Models/AWSRole.html | 6 +- doc/NgrokAPI/Models/AbuseReport.html | 6 +- doc/NgrokAPI/Models/AbuseReportHostname.html | 6 +- doc/NgrokAPI/Models/AgentIngress.html | 6 +- doc/NgrokAPI/Models/AgentIngressCertJob.html | 6 +- .../Models/AgentIngressCertPolicy.html | 6 +- .../Models/AgentIngressCertStatus.html | 6 +- doc/NgrokAPI/Models/ApplicationSession.html | 6 +- doc/NgrokAPI/Models/ApplicationUser.html | 6 +- doc/NgrokAPI/Models/BrowserSession.html | 6 +- doc/NgrokAPI/Models/CertificateAuthority.html | 6 +- doc/NgrokAPI/Models/Credential.html | 6 +- doc/NgrokAPI/Models/Endpoint.html | 6 +- doc/NgrokAPI/Models/EndpointAction.html | 669 +++++ doc/NgrokAPI/Models/EndpointBackend.html | 6 +- .../Models/EndpointBackendMutate.html | 6 +- .../Models/EndpointCircuitBreaker.html | 6 +- doc/NgrokAPI/Models/EndpointCompression.html | 6 +- doc/NgrokAPI/Models/EndpointIPPolicy.html | 6 +- .../Models/EndpointIPPolicyMutate.html | 6 +- doc/NgrokAPI/Models/EndpointMutualTLS.html | 6 +- .../Models/EndpointMutualTLSMutate.html | 6 +- doc/NgrokAPI/Models/EndpointOAuth.html | 6 +- doc/NgrokAPI/Models/EndpointOAuthAmazon.html | 6 +- .../Models/EndpointOAuthFacebook.html | 6 +- doc/NgrokAPI/Models/EndpointOAuthGitHub.html | 6 +- doc/NgrokAPI/Models/EndpointOAuthGitLab.html | 6 +- doc/NgrokAPI/Models/EndpointOAuthGoogle.html | 6 +- .../Models/EndpointOAuthLinkedIn.html | 6 +- .../Models/EndpointOAuthMicrosoft.html | 6 +- .../Models/EndpointOAuthProvider.html | 6 +- doc/NgrokAPI/Models/EndpointOAuthTwitch.html | 6 +- doc/NgrokAPI/Models/EndpointOIDC.html | 6 +- doc/NgrokAPI/Models/EndpointPolicy.html | 743 +++++ .../Models/EndpointRequestHeaders.html | 6 +- .../Models/EndpointResponseHeaders.html | 6 +- doc/NgrokAPI/Models/EndpointRule.html | 743 +++++ doc/NgrokAPI/Models/EndpointSAML.html | 114 +- doc/NgrokAPI/Models/EndpointSAMLMutate.html | 114 +- .../Models/EndpointTLSTermination.html | 6 +- .../Models/EndpointTLSTerminationAtEdge.html | 6 +- .../Models/EndpointUserAgentFilter.html | 743 +++++ .../Models/EndpointWebhookValidation.html | 6 +- .../Models/EndpointWebsocketTCPConverter.html | 6 +- doc/NgrokAPI/Models/EventDestination.html | 6 +- doc/NgrokAPI/Models/EventSource.html | 186 +- doc/NgrokAPI/Models/EventSourceList.html | 6 +- doc/NgrokAPI/Models/EventSourceReplace.html | 186 +- doc/NgrokAPI/Models/EventSubscription.html | 6 +- doc/NgrokAPI/Models/EventTarget.html | 110 +- .../Models/EventTargetCloudwatchLogs.html | 6 +- doc/NgrokAPI/Models/EventTargetDatadog.html | 6 +- doc/NgrokAPI/Models/EventTargetFirehose.html | 6 +- doc/NgrokAPI/Models/EventTargetKinesis.html | 6 +- doc/NgrokAPI/Models/FailoverBackend.html | 6 +- doc/NgrokAPI/Models/HTTPResponseBackend.html | 6 +- doc/NgrokAPI/Models/HTTPSEdge.html | 6 +- doc/NgrokAPI/Models/HTTPSEdgeRoute.html | 234 +- doc/NgrokAPI/Models/IPPolicy.html | 128 +- doc/NgrokAPI/Models/IPPolicyRule.html | 6 +- doc/NgrokAPI/Models/IPRestriction.html | 6 +- doc/NgrokAPI/Models/IdentityProvider.html | 6 +- doc/NgrokAPI/Models/Listable.html | 6 +- doc/NgrokAPI/Models/Location.html | 6 +- doc/NgrokAPI/Models/Ref.html | 6 +- doc/NgrokAPI/Models/ReservedAddr.html | 118 +- doc/NgrokAPI/Models/ReservedDomain.html | 198 +- .../Models/ReservedDomainCertJob.html | 6 +- .../Models/ReservedDomainCertPolicy.html | 6 +- .../Models/ReservedDomainCertStatus.html | 6 +- .../Models/SSHCertificateAuthority.html | 6 +- doc/NgrokAPI/Models/SSHCredential.html | 6 +- doc/NgrokAPI/Models/SSHHostCertificate.html | 6 +- doc/NgrokAPI/Models/SSHUserCertificate.html | 6 +- doc/NgrokAPI/Models/StaticBackend.html | 1211 ++++++++ doc/NgrokAPI/Models/StaticBackendTLS.html | 595 ++++ doc/NgrokAPI/Models/TCPEdge.html | 144 +- doc/NgrokAPI/Models/TLSCertificate.html | 6 +- doc/NgrokAPI/Models/TLSCertificateSANs.html | 6 +- doc/NgrokAPI/Models/TLSEdge.html | 144 +- doc/NgrokAPI/Models/Tunnel.html | 6 +- doc/NgrokAPI/Models/TunnelGroupBackend.html | 6 +- doc/NgrokAPI/Models/TunnelSession.html | 6 +- doc/NgrokAPI/Models/UserAgent.html | 6 +- doc/NgrokAPI/Models/WeightedBackend.html | 6 +- doc/NgrokAPI/PagedIterator.html | 6 +- doc/NgrokAPI/Services.html | 10 +- doc/NgrokAPI/Services/APIKeysClient.html | 8 +- doc/NgrokAPI/Services/AbuseReportsClient.html | 8 +- .../Services/AgentIngressesClient.html | 6 +- .../Services/ApplicationSessionsClient.html | 6 +- .../Services/ApplicationUsersClient.html | 6 +- .../CertificateAuthoritiesClient.html | 6 +- doc/NgrokAPI/Services/CredentialsClient.html | 18 +- .../EdgeRouteBackendModuleClient.html | 6 +- .../EdgeRouteCircuitBreakerModuleClient.html | 6 +- .../EdgeRouteCompressionModuleClient.html | 6 +- .../EdgeRouteIPRestrictionModuleClient.html | 6 +- .../Services/EdgeRouteOAuthModuleClient.html | 6 +- .../Services/EdgeRouteOIDCModuleClient.html | 6 +- .../Services/EdgeRoutePolicyModuleClient.html | 1149 ++++++++ .../EdgeRouteRequestHeadersModuleClient.html | 6 +- .../EdgeRouteResponseHeadersModuleClient.html | 6 +- .../Services/EdgeRouteSAMLModuleClient.html | 6 +- .../EdgeRouteUserAgentFilterModuleClient.html | 1149 ++++++++ ...eRouteWebhookVerificationModuleClient.html | 6 +- ...outeWebsocketTCPConverterModuleClient.html | 6 +- doc/NgrokAPI/Services/EdgesHTTPSClient.html | 6 +- .../Services/EdgesHTTPSRoutesClient.html | 326 ++- doc/NgrokAPI/Services/EdgesTCPClient.html | 238 +- doc/NgrokAPI/Services/EdgesTLSClient.html | 238 +- doc/NgrokAPI/Services/EndpointsClient.html | 6 +- .../Services/EventDestinationsClient.html | 6 +- doc/NgrokAPI/Services/EventSourcesClient.html | 6 +- .../Services/EventSubscriptionsClient.html | 14 +- .../Services/FailoverBackendsClient.html | 6 +- .../Services/HTTPResponseBackendsClient.html | 6 +- .../HTTPSEdgeMutualTLSModuleClient.html | 6 +- .../HTTPSEdgeTLSTerminationModuleClient.html | 6 +- doc/NgrokAPI/Services/IPPoliciesClient.html | 6 +- .../Services/IPPolicyRulesClient.html | 6 +- .../Services/IPRestrictionsClient.html | 6 +- .../Services/ReservedAddrsClient.html | 6 +- .../Services/ReservedDomainsClient.html | 12 +- .../SSHCertificateAuthoritiesClient.html | 6 +- .../Services/SSHCredentialsClient.html | 10 +- .../Services/SSHHostCertificatesClient.html | 6 +- .../Services/SSHUserCertificatesClient.html | 14 +- .../Services/StaticBackendsClient.html | 1879 ++++++++++++ .../Services/TCPEdgeBackendModuleClient.html | 6 +- .../TCPEdgeIPRestrictionModuleClient.html | 6 +- .../Services/TCPEdgePolicyModuleClient.html | 1039 +++++++ .../Services/TLSCertificatesClient.html | 14 +- .../Services/TLSEdgeBackendModuleClient.html | 6 +- .../TLSEdgeIPRestrictionModuleClient.html | 6 +- .../TLSEdgeMutualTLSModuleClient.html | 6 +- .../Services/TLSEdgePolicyModuleClient.html | 1039 +++++++ .../TLSEdgeTLSTerminationModuleClient.html | 6 +- .../Services/TunnelGroupBackendsClient.html | 6 +- .../Services/TunnelSessionsClient.html | 10 +- doc/NgrokAPI/Services/TunnelsClient.html | 6 +- .../Services/WeightedBackendsClient.html | 8 +- doc/_index.html | 85 +- doc/class_list.html | 2 +- doc/file.README.html | 6 +- doc/frames.html | 15 +- doc/index.html | 6 +- doc/method_list.html | 2536 +++++++++++------ doc/top-level-namespace.html | 6 +- docs/NgrokAPI.html | 8 +- docs/NgrokAPI/Client.html | 34 +- docs/NgrokAPI/Error.html | 6 +- docs/NgrokAPI/Errors.html | 6 +- docs/NgrokAPI/Errors/NotFoundError.html | 6 +- docs/NgrokAPI/HttpClient.html | 8 +- docs/NgrokAPI/Models.html | 10 +- docs/NgrokAPI/Models/APIKey.html | 6 +- docs/NgrokAPI/Models/AWSAuth.html | 6 +- docs/NgrokAPI/Models/AWSCredentials.html | 6 +- docs/NgrokAPI/Models/AWSRole.html | 6 +- docs/NgrokAPI/Models/AbuseReport.html | 6 +- docs/NgrokAPI/Models/AbuseReportHostname.html | 6 +- docs/NgrokAPI/Models/AgentIngress.html | 6 +- docs/NgrokAPI/Models/AgentIngressCertJob.html | 6 +- .../Models/AgentIngressCertPolicy.html | 6 +- .../Models/AgentIngressCertStatus.html | 6 +- docs/NgrokAPI/Models/ApplicationSession.html | 6 +- docs/NgrokAPI/Models/ApplicationUser.html | 6 +- docs/NgrokAPI/Models/BrowserSession.html | 6 +- .../NgrokAPI/Models/CertificateAuthority.html | 6 +- docs/NgrokAPI/Models/Credential.html | 6 +- docs/NgrokAPI/Models/Endpoint.html | 6 +- docs/NgrokAPI/Models/EndpointAction.html | 669 +++++ docs/NgrokAPI/Models/EndpointBackend.html | 6 +- .../Models/EndpointBackendMutate.html | 6 +- .../Models/EndpointCircuitBreaker.html | 6 +- docs/NgrokAPI/Models/EndpointCompression.html | 6 +- docs/NgrokAPI/Models/EndpointIPPolicy.html | 6 +- .../Models/EndpointIPPolicyMutate.html | 6 +- docs/NgrokAPI/Models/EndpointMutualTLS.html | 6 +- .../Models/EndpointMutualTLSMutate.html | 6 +- docs/NgrokAPI/Models/EndpointOAuth.html | 6 +- docs/NgrokAPI/Models/EndpointOAuthAmazon.html | 6 +- .../Models/EndpointOAuthFacebook.html | 6 +- docs/NgrokAPI/Models/EndpointOAuthGitHub.html | 6 +- docs/NgrokAPI/Models/EndpointOAuthGitLab.html | 6 +- docs/NgrokAPI/Models/EndpointOAuthGoogle.html | 6 +- .../Models/EndpointOAuthLinkedIn.html | 6 +- .../Models/EndpointOAuthMicrosoft.html | 6 +- .../Models/EndpointOAuthProvider.html | 6 +- docs/NgrokAPI/Models/EndpointOAuthTwitch.html | 6 +- docs/NgrokAPI/Models/EndpointOIDC.html | 6 +- docs/NgrokAPI/Models/EndpointPolicy.html | 743 +++++ .../Models/EndpointRequestHeaders.html | 6 +- .../Models/EndpointResponseHeaders.html | 6 +- docs/NgrokAPI/Models/EndpointRule.html | 743 +++++ docs/NgrokAPI/Models/EndpointSAML.html | 114 +- docs/NgrokAPI/Models/EndpointSAMLMutate.html | 114 +- .../Models/EndpointTLSTermination.html | 6 +- .../Models/EndpointTLSTerminationAtEdge.html | 6 +- .../Models/EndpointUserAgentFilter.html | 743 +++++ .../Models/EndpointWebhookValidation.html | 6 +- .../Models/EndpointWebsocketTCPConverter.html | 6 +- docs/NgrokAPI/Models/EventDestination.html | 6 +- docs/NgrokAPI/Models/EventSource.html | 186 +- docs/NgrokAPI/Models/EventSourceList.html | 6 +- docs/NgrokAPI/Models/EventSourceReplace.html | 186 +- docs/NgrokAPI/Models/EventSubscription.html | 6 +- docs/NgrokAPI/Models/EventTarget.html | 110 +- .../Models/EventTargetCloudwatchLogs.html | 6 +- docs/NgrokAPI/Models/EventTargetDatadog.html | 6 +- docs/NgrokAPI/Models/EventTargetFirehose.html | 6 +- docs/NgrokAPI/Models/EventTargetKinesis.html | 6 +- docs/NgrokAPI/Models/FailoverBackend.html | 6 +- docs/NgrokAPI/Models/HTTPResponseBackend.html | 6 +- docs/NgrokAPI/Models/HTTPSEdge.html | 6 +- docs/NgrokAPI/Models/HTTPSEdgeRoute.html | 234 +- docs/NgrokAPI/Models/IPPolicy.html | 128 +- docs/NgrokAPI/Models/IPPolicyRule.html | 6 +- docs/NgrokAPI/Models/IPRestriction.html | 6 +- docs/NgrokAPI/Models/IdentityProvider.html | 6 +- docs/NgrokAPI/Models/Listable.html | 6 +- docs/NgrokAPI/Models/Location.html | 6 +- docs/NgrokAPI/Models/Ref.html | 6 +- docs/NgrokAPI/Models/ReservedAddr.html | 118 +- docs/NgrokAPI/Models/ReservedDomain.html | 198 +- .../Models/ReservedDomainCertJob.html | 6 +- .../Models/ReservedDomainCertPolicy.html | 6 +- .../Models/ReservedDomainCertStatus.html | 6 +- .../Models/SSHCertificateAuthority.html | 6 +- docs/NgrokAPI/Models/SSHCredential.html | 6 +- docs/NgrokAPI/Models/SSHHostCertificate.html | 6 +- docs/NgrokAPI/Models/SSHUserCertificate.html | 6 +- docs/NgrokAPI/Models/StaticBackend.html | 1211 ++++++++ docs/NgrokAPI/Models/StaticBackendTLS.html | 595 ++++ docs/NgrokAPI/Models/TCPEdge.html | 144 +- docs/NgrokAPI/Models/TLSCertificate.html | 6 +- docs/NgrokAPI/Models/TLSCertificateSANs.html | 6 +- docs/NgrokAPI/Models/TLSEdge.html | 144 +- docs/NgrokAPI/Models/Tunnel.html | 6 +- docs/NgrokAPI/Models/TunnelGroupBackend.html | 6 +- docs/NgrokAPI/Models/TunnelSession.html | 6 +- docs/NgrokAPI/Models/UserAgent.html | 6 +- docs/NgrokAPI/Models/WeightedBackend.html | 6 +- docs/NgrokAPI/PagedIterator.html | 6 +- docs/NgrokAPI/Services.html | 10 +- docs/NgrokAPI/Services/APIKeysClient.html | 8 +- .../NgrokAPI/Services/AbuseReportsClient.html | 8 +- .../Services/AgentIngressesClient.html | 6 +- .../Services/ApplicationSessionsClient.html | 6 +- .../Services/ApplicationUsersClient.html | 6 +- .../CertificateAuthoritiesClient.html | 6 +- docs/NgrokAPI/Services/CredentialsClient.html | 18 +- .../EdgeRouteBackendModuleClient.html | 6 +- .../EdgeRouteCircuitBreakerModuleClient.html | 6 +- .../EdgeRouteCompressionModuleClient.html | 6 +- .../EdgeRouteIPRestrictionModuleClient.html | 6 +- .../Services/EdgeRouteOAuthModuleClient.html | 6 +- .../Services/EdgeRouteOIDCModuleClient.html | 6 +- .../Services/EdgeRoutePolicyModuleClient.html | 1149 ++++++++ .../EdgeRouteRequestHeadersModuleClient.html | 6 +- .../EdgeRouteResponseHeadersModuleClient.html | 6 +- .../Services/EdgeRouteSAMLModuleClient.html | 6 +- .../EdgeRouteUserAgentFilterModuleClient.html | 1149 ++++++++ ...eRouteWebhookVerificationModuleClient.html | 6 +- ...outeWebsocketTCPConverterModuleClient.html | 6 +- docs/NgrokAPI/Services/EdgesHTTPSClient.html | 6 +- .../Services/EdgesHTTPSRoutesClient.html | 326 ++- docs/NgrokAPI/Services/EdgesTCPClient.html | 238 +- docs/NgrokAPI/Services/EdgesTLSClient.html | 238 +- docs/NgrokAPI/Services/EndpointsClient.html | 6 +- .../Services/EventDestinationsClient.html | 6 +- .../NgrokAPI/Services/EventSourcesClient.html | 6 +- .../Services/EventSubscriptionsClient.html | 14 +- .../Services/FailoverBackendsClient.html | 6 +- .../Services/HTTPResponseBackendsClient.html | 6 +- .../HTTPSEdgeMutualTLSModuleClient.html | 6 +- .../HTTPSEdgeTLSTerminationModuleClient.html | 6 +- docs/NgrokAPI/Services/IPPoliciesClient.html | 6 +- .../Services/IPPolicyRulesClient.html | 6 +- .../Services/IPRestrictionsClient.html | 6 +- .../Services/ReservedAddrsClient.html | 6 +- .../Services/ReservedDomainsClient.html | 12 +- .../SSHCertificateAuthoritiesClient.html | 6 +- .../Services/SSHCredentialsClient.html | 10 +- .../Services/SSHHostCertificatesClient.html | 6 +- .../Services/SSHUserCertificatesClient.html | 14 +- .../Services/StaticBackendsClient.html | 1879 ++++++++++++ .../Services/TCPEdgeBackendModuleClient.html | 6 +- .../TCPEdgeIPRestrictionModuleClient.html | 6 +- .../Services/TCPEdgePolicyModuleClient.html | 1039 +++++++ .../Services/TLSCertificatesClient.html | 14 +- .../Services/TLSEdgeBackendModuleClient.html | 6 +- .../TLSEdgeIPRestrictionModuleClient.html | 6 +- .../TLSEdgeMutualTLSModuleClient.html | 6 +- .../Services/TLSEdgePolicyModuleClient.html | 1039 +++++++ .../TLSEdgeTLSTerminationModuleClient.html | 6 +- .../Services/TunnelGroupBackendsClient.html | 6 +- .../Services/TunnelSessionsClient.html | 10 +- docs/NgrokAPI/Services/TunnelsClient.html | 6 +- .../Services/WeightedBackendsClient.html | 8 +- docs/_index.html | 85 +- docs/class_list.html | 2 +- docs/file.README.html | 6 +- docs/frames.html | 15 +- docs/index.html | 6 +- docs/method_list.html | 2536 +++++++++++------ docs/top-level-namespace.html | 6 +- lib/ngrokapi/client.rb | 2 + lib/ngrokapi/models/endpoint_action.rb | 33 + lib/ngrokapi/models/endpoint_policy.rb | 35 + lib/ngrokapi/models/endpoint_rule.rb | 35 + lib/ngrokapi/models/endpoint_saml.rb | 4 - lib/ngrokapi/models/endpoint_saml_mutate.rb | 4 - .../models/endpoint_user_agent_filter.rb | 35 + lib/ngrokapi/models/event_source.rb | 4 - lib/ngrokapi/models/event_source_replace.rb | 6 +- lib/ngrokapi/models/event_target.rb | 2 - lib/ngrokapi/models/https_edge_route.rb | 16 +- lib/ngrokapi/models/ip_policy.rb | 4 +- lib/ngrokapi/models/reserved_addr.rb | 4 +- lib/ngrokapi/models/reserved_domain.rb | 4 - lib/ngrokapi/models/static_backend.rb | 80 + lib/ngrokapi/models/static_backend_tls.rb | 31 + lib/ngrokapi/models/tcp_edge.rb | 11 +- lib/ngrokapi/models/tls_edge.rb | 11 +- lib/ngrokapi/services/credentials_client.rb | 4 +- .../edge_route_policy_module_client.rb | 120 + ...e_route_user_agent_filter_module_client.rb | 120 + .../services/edges_https_routes_client.rb | 24 +- lib/ngrokapi/services/edges_tcp_client.rb | 16 +- lib/ngrokapi/services/edges_tls_client.rb | 16 +- .../services/reserved_domains_client.rb | 4 +- .../services/static_backends_client.rb | 242 ++ .../services/tcp_edge_policy_module_client.rb | 108 + .../services/tls_edge_policy_module_client.rb | 108 + lib/ngrokapi/version.rb | 2 +- spec/ngrokapi/client_spec.rb | 2 + spec/ngrokapi/models/endpoint_action_spec.rb | 23 + spec/ngrokapi/models/endpoint_policy_spec.rb | 23 + spec/ngrokapi/models/endpoint_rule_spec.rb | 23 + .../models/endpoint_user_agent_filter_spec.rb | 23 + spec/ngrokapi/models/https_edge_route_spec.rb | 8 +- spec/ngrokapi/models/static_backend_spec.rb | 50 + .../models/static_backend_tls_spec.rb | 23 + spec/ngrokapi/models/tcp_edge_spec.rb | 5 +- spec/ngrokapi/models/tls_edge_spec.rb | 5 +- .../services/credentials_client_spec.rb | 6 +- .../edge_route_policy_module_client_spec.rb | 139 + ...te_user_agent_filter_module_client_spec.rb | 139 + .../edges_https_routes_client_spec.rb | 24 +- .../services/edges_tcp_client_spec.rb | 16 +- .../services/edges_tls_client_spec.rb | 16 +- .../services/static_backends_client_spec.rb | 194 ++ .../tcp_edge_policy_module_client_spec.rb | 125 + .../tls_edge_policy_module_client_spec.rb | 125 + spec/spec_helper.rb | 43 + 367 files changed, 30571 insertions(+), 5428 deletions(-) create mode 100644 doc/NgrokAPI/Models/EndpointAction.html create mode 100644 doc/NgrokAPI/Models/EndpointPolicy.html create mode 100644 doc/NgrokAPI/Models/EndpointRule.html create mode 100644 doc/NgrokAPI/Models/EndpointUserAgentFilter.html create mode 100644 doc/NgrokAPI/Models/StaticBackend.html create mode 100644 doc/NgrokAPI/Models/StaticBackendTLS.html create mode 100644 doc/NgrokAPI/Services/EdgeRoutePolicyModuleClient.html create mode 100644 doc/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html create mode 100644 doc/NgrokAPI/Services/StaticBackendsClient.html create mode 100644 doc/NgrokAPI/Services/TCPEdgePolicyModuleClient.html create mode 100644 doc/NgrokAPI/Services/TLSEdgePolicyModuleClient.html create mode 100644 docs/NgrokAPI/Models/EndpointAction.html create mode 100644 docs/NgrokAPI/Models/EndpointPolicy.html create mode 100644 docs/NgrokAPI/Models/EndpointRule.html create mode 100644 docs/NgrokAPI/Models/EndpointUserAgentFilter.html create mode 100644 docs/NgrokAPI/Models/StaticBackend.html create mode 100644 docs/NgrokAPI/Models/StaticBackendTLS.html create mode 100644 docs/NgrokAPI/Services/EdgeRoutePolicyModuleClient.html create mode 100644 docs/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html create mode 100644 docs/NgrokAPI/Services/StaticBackendsClient.html create mode 100644 docs/NgrokAPI/Services/TCPEdgePolicyModuleClient.html create mode 100644 docs/NgrokAPI/Services/TLSEdgePolicyModuleClient.html create mode 100644 lib/ngrokapi/models/endpoint_action.rb create mode 100644 lib/ngrokapi/models/endpoint_policy.rb create mode 100644 lib/ngrokapi/models/endpoint_rule.rb create mode 100644 lib/ngrokapi/models/endpoint_user_agent_filter.rb create mode 100644 lib/ngrokapi/models/static_backend.rb create mode 100644 lib/ngrokapi/models/static_backend_tls.rb create mode 100644 lib/ngrokapi/services/edge_route_policy_module_client.rb create mode 100644 lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb create mode 100644 lib/ngrokapi/services/static_backends_client.rb create mode 100644 lib/ngrokapi/services/tcp_edge_policy_module_client.rb create mode 100644 lib/ngrokapi/services/tls_edge_policy_module_client.rb create mode 100644 spec/ngrokapi/models/endpoint_action_spec.rb create mode 100644 spec/ngrokapi/models/endpoint_policy_spec.rb create mode 100644 spec/ngrokapi/models/endpoint_rule_spec.rb create mode 100644 spec/ngrokapi/models/endpoint_user_agent_filter_spec.rb create mode 100644 spec/ngrokapi/models/static_backend_spec.rb create mode 100644 spec/ngrokapi/models/static_backend_tls_spec.rb create mode 100644 spec/ngrokapi/services/edge_route_policy_module_client_spec.rb create mode 100644 spec/ngrokapi/services/edge_route_user_agent_filter_module_client_spec.rb create mode 100644 spec/ngrokapi/services/static_backends_client_spec.rb create mode 100644 spec/ngrokapi/services/tcp_edge_policy_module_client_spec.rb create mode 100644 spec/ngrokapi/services/tls_edge_policy_module_client_spec.rb diff --git a/doc/NgrokAPI.html b/doc/NgrokAPI.html index a6d5c96..a043993 100644 --- a/doc/NgrokAPI.html +++ b/doc/NgrokAPI.html @@ -6,7 +6,7 @@ Module: NgrokAPI - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -79,7 +79,7 @@
Defined in:
lib/ngrokapi.rb,
- lib/ngrokapi/error.rb,
lib/ngrokapi/client.rb,
lib/ngrokapi/version.rb,
lib/ngrokapi/models/ref.rb,
lib/ngrokapi/http_client.rb,
lib/ngrokapi/models/tunnel.rb,
lib/ngrokapi/models/api_key.rb,
lib/ngrokapi/paged_iterator.rb,
lib/ngrokapi/models/aws_auth.rb,
lib/ngrokapi/models/aws_role.rb,
lib/ngrokapi/models/endpoint.rb,
lib/ngrokapi/models/listable.rb,
lib/ngrokapi/models/location.rb,
lib/ngrokapi/models/tcp_edge.rb,
lib/ngrokapi/models/tls_edge.rb,
lib/ngrokapi/models/ip_policy.rb,
lib/ngrokapi/models/credential.rb,
lib/ngrokapi/models/https_edge.rb,
lib/ngrokapi/models/user_agent.rb,
lib/ngrokapi/models/abuse_report.rb,
lib/ngrokapi/models/event_source.rb,
lib/ngrokapi/models/event_target.rb,
lib/ngrokapi/models/agent_ingress.rb,
lib/ngrokapi/models/endpoint_oidc.rb,
lib/ngrokapi/models/endpoint_saml.rb,
lib/ngrokapi/models/reserved_addr.rb,
lib/ngrokapi/models/ip_policy_rule.rb,
lib/ngrokapi/models/ip_restriction.rb,
lib/ngrokapi/models/ssh_credential.rb,
lib/ngrokapi/models/tunnel_session.rb,
lib/ngrokapi/errors/not_found_error.rb,
lib/ngrokapi/models/aws_credentials.rb,
lib/ngrokapi/models/browser_session.rb,
lib/ngrokapi/models/endpoint_o_auth.rb,
lib/ngrokapi/models/reserved_domain.rb,
lib/ngrokapi/models/tls_certificate.rb,
lib/ngrokapi/models/application_user.rb,
lib/ngrokapi/models/endpoint_backend.rb,
lib/ngrokapi/models/failover_backend.rb,
lib/ngrokapi/models/https_edge_route.rb,
lib/ngrokapi/models/weighted_backend.rb,
lib/ngrokapi/services/tunnels_client.rb,
lib/ngrokapi/models/event_destination.rb,
lib/ngrokapi/models/event_source_list.rb,
lib/ngrokapi/models/identity_provider.rb,
lib/ngrokapi/services/api_keys_client.rb,
lib/ngrokapi/models/endpoint_ip_policy.rb,
lib/ngrokapi/models/event_subscription.rb,
lib/ngrokapi/services/edges_tcp_client.rb,
lib/ngrokapi/services/edges_tls_client.rb,
lib/ngrokapi/services/endpoints_client.rb,
lib/ngrokapi/models/application_session.rb,
lib/ngrokapi/models/endpoint_mutual_tls.rb,
lib/ngrokapi/models/endpoint_compression.rb,
lib/ngrokapi/models/endpoint_saml_mutate.rb,
lib/ngrokapi/models/event_source_replace.rb,
lib/ngrokapi/models/event_target_datadog.rb,
lib/ngrokapi/models/event_target_kinesis.rb,
lib/ngrokapi/models/ssh_host_certificate.rb,
lib/ngrokapi/models/ssh_user_certificate.rb,
lib/ngrokapi/models/tunnel_group_backend.rb,
lib/ngrokapi/services/credentials_client.rb,
lib/ngrokapi/services/edges_https_client.rb,
lib/ngrokapi/services/ip_policies_client.rb,
lib/ngrokapi/models/abuse_report_hostname.rb,
lib/ngrokapi/models/certificate_authority.rb,
lib/ngrokapi/models/event_target_firehose.rb,
lib/ngrokapi/models/http_response_backend.rb,
lib/ngrokapi/models/tls_certificate_sa_ns.rb,
lib/ngrokapi/models/agent_ingress_cert_job.rb,
lib/ngrokapi/models/endpoint_o_auth_amazon.rb,
lib/ngrokapi/models/endpoint_o_auth_google.rb,
lib/ngrokapi/models/endpoint_o_auth_twitch.rb,
lib/ngrokapi/services/abuse_reports_client.rb,
lib/ngrokapi/services/event_sources_client.rb,
lib/ngrokapi/models/endpoint_backend_mutate.rb,
lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,
lib/ngrokapi/models/endpoint_o_auth_git_lab.rb,
lib/ngrokapi/services/reserved_addrs_client.rb,
lib/ngrokapi/models/endpoint_circuit_breaker.rb,
lib/ngrokapi/models/endpoint_o_auth_facebook.rb,
lib/ngrokapi/models/endpoint_o_auth_provider.rb,
lib/ngrokapi/models/endpoint_request_headers.rb,
lib/ngrokapi/models/endpoint_tls_termination.rb,
lib/ngrokapi/models/reserved_domain_cert_job.rb,
lib/ngrokapi/services/agent_ingresses_client.rb,
lib/ngrokapi/services/ip_policy_rules_client.rb,
lib/ngrokapi/services/ip_restrictions_client.rb,
lib/ngrokapi/services/ssh_credentials_client.rb,
lib/ngrokapi/services/tunnel_sessions_client.rb,
lib/ngrokapi/models/agent_ingress_cert_policy.rb,
lib/ngrokapi/models/agent_ingress_cert_status.rb,
lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,
lib/ngrokapi/models/endpoint_o_auth_linked_in.rb,
lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,
lib/ngrokapi/models/endpoint_response_headers.rb,
lib/ngrokapi/models/ssh_certificate_authority.rb,
lib/ngrokapi/services/reserved_domains_client.rb,
lib/ngrokapi/services/tls_certificates_client.rb,
lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,
lib/ngrokapi/services/application_users_client.rb,
lib/ngrokapi/services/failover_backends_client.rb,
lib/ngrokapi/services/weighted_backends_client.rb,
lib/ngrokapi/models/endpoint_webhook_validation.rb,
lib/ngrokapi/models/reserved_domain_cert_policy.rb,
lib/ngrokapi/models/reserved_domain_cert_status.rb,
lib/ngrokapi/services/edges_https_routes_client.rb,
lib/ngrokapi/services/event_destinations_client.rb,
lib/ngrokapi/models/event_target_cloudwatch_logs.rb,
lib/ngrokapi/services/event_subscriptions_client.rb,
lib/ngrokapi/services/application_sessions_client.rb,
lib/ngrokapi/services/ssh_host_certificates_client.rb,
lib/ngrokapi/services/ssh_user_certificates_client.rb,
lib/ngrokapi/services/tunnel_group_backends_client.rb,
lib/ngrokapi/services/edge_route_oidc_module_client.rb,
lib/ngrokapi/services/edge_route_saml_module_client.rb,
lib/ngrokapi/services/http_response_backends_client.rb,
lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb,
lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb,
lib/ngrokapi/services/certificate_authorities_client.rb,
lib/ngrokapi/services/tcp_edge_backend_module_client.rb,
lib/ngrokapi/services/tls_edge_backend_module_client.rb,
lib/ngrokapi/services/edge_route_o_auth_module_client.rb,
lib/ngrokapi/services/edge_route_backend_module_client.rb,
lib/ngrokapi/services/tls_edge_mutual_tls_module_client.rb,
lib/ngrokapi/services/ssh_certificate_authorities_client.rb,
lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb,
lib/ngrokapi/services/edge_route_compression_module_client.rb,
lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb,
lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb,
lib/ngrokapi/services/tls_edge_tls_termination_module_client.rb,
lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb,
lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb,
lib/ngrokapi/services/edge_route_request_headers_module_client.rb,
lib/ngrokapi/services/https_edge_tls_termination_module_client.rb,
lib/ngrokapi/services/edge_route_response_headers_module_client.rb,
lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb,
lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb
+ lib/ngrokapi/error.rb,
lib/ngrokapi/client.rb,
lib/ngrokapi/version.rb,
lib/ngrokapi/models/ref.rb,
lib/ngrokapi/http_client.rb,
lib/ngrokapi/models/tunnel.rb,
lib/ngrokapi/models/api_key.rb,
lib/ngrokapi/paged_iterator.rb,
lib/ngrokapi/models/aws_auth.rb,
lib/ngrokapi/models/aws_role.rb,
lib/ngrokapi/models/endpoint.rb,
lib/ngrokapi/models/listable.rb,
lib/ngrokapi/models/location.rb,
lib/ngrokapi/models/tcp_edge.rb,
lib/ngrokapi/models/tls_edge.rb,
lib/ngrokapi/models/ip_policy.rb,
lib/ngrokapi/models/credential.rb,
lib/ngrokapi/models/https_edge.rb,
lib/ngrokapi/models/user_agent.rb,
lib/ngrokapi/models/abuse_report.rb,
lib/ngrokapi/models/event_source.rb,
lib/ngrokapi/models/event_target.rb,
lib/ngrokapi/models/agent_ingress.rb,
lib/ngrokapi/models/endpoint_oidc.rb,
lib/ngrokapi/models/endpoint_rule.rb,
lib/ngrokapi/models/endpoint_saml.rb,
lib/ngrokapi/models/reserved_addr.rb,
lib/ngrokapi/models/ip_policy_rule.rb,
lib/ngrokapi/models/ip_restriction.rb,
lib/ngrokapi/models/ssh_credential.rb,
lib/ngrokapi/models/static_backend.rb,
lib/ngrokapi/models/tunnel_session.rb,
lib/ngrokapi/errors/not_found_error.rb,
lib/ngrokapi/models/aws_credentials.rb,
lib/ngrokapi/models/browser_session.rb,
lib/ngrokapi/models/endpoint_action.rb,
lib/ngrokapi/models/endpoint_o_auth.rb,
lib/ngrokapi/models/endpoint_policy.rb,
lib/ngrokapi/models/reserved_domain.rb,
lib/ngrokapi/models/tls_certificate.rb,
lib/ngrokapi/models/application_user.rb,
lib/ngrokapi/models/endpoint_backend.rb,
lib/ngrokapi/models/failover_backend.rb,
lib/ngrokapi/models/https_edge_route.rb,
lib/ngrokapi/models/weighted_backend.rb,
lib/ngrokapi/services/tunnels_client.rb,
lib/ngrokapi/models/event_destination.rb,
lib/ngrokapi/models/event_source_list.rb,
lib/ngrokapi/models/identity_provider.rb,
lib/ngrokapi/services/api_keys_client.rb,
lib/ngrokapi/models/endpoint_ip_policy.rb,
lib/ngrokapi/models/event_subscription.rb,
lib/ngrokapi/models/static_backend_tls.rb,
lib/ngrokapi/services/edges_tcp_client.rb,
lib/ngrokapi/services/edges_tls_client.rb,
lib/ngrokapi/services/endpoints_client.rb,
lib/ngrokapi/models/application_session.rb,
lib/ngrokapi/models/endpoint_mutual_tls.rb,
lib/ngrokapi/models/endpoint_compression.rb,
lib/ngrokapi/models/endpoint_saml_mutate.rb,
lib/ngrokapi/models/event_source_replace.rb,
lib/ngrokapi/models/event_target_datadog.rb,
lib/ngrokapi/models/event_target_kinesis.rb,
lib/ngrokapi/models/ssh_host_certificate.rb,
lib/ngrokapi/models/ssh_user_certificate.rb,
lib/ngrokapi/models/tunnel_group_backend.rb,
lib/ngrokapi/services/credentials_client.rb,
lib/ngrokapi/services/edges_https_client.rb,
lib/ngrokapi/services/ip_policies_client.rb,
lib/ngrokapi/models/abuse_report_hostname.rb,
lib/ngrokapi/models/certificate_authority.rb,
lib/ngrokapi/models/event_target_firehose.rb,
lib/ngrokapi/models/http_response_backend.rb,
lib/ngrokapi/models/tls_certificate_sa_ns.rb,
lib/ngrokapi/models/agent_ingress_cert_job.rb,
lib/ngrokapi/models/endpoint_o_auth_amazon.rb,
lib/ngrokapi/models/endpoint_o_auth_google.rb,
lib/ngrokapi/models/endpoint_o_auth_twitch.rb,
lib/ngrokapi/services/abuse_reports_client.rb,
lib/ngrokapi/services/event_sources_client.rb,
lib/ngrokapi/models/endpoint_backend_mutate.rb,
lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,
lib/ngrokapi/models/endpoint_o_auth_git_lab.rb,
lib/ngrokapi/services/reserved_addrs_client.rb,
lib/ngrokapi/models/endpoint_circuit_breaker.rb,
lib/ngrokapi/models/endpoint_o_auth_facebook.rb,
lib/ngrokapi/models/endpoint_o_auth_provider.rb,
lib/ngrokapi/models/endpoint_request_headers.rb,
lib/ngrokapi/models/endpoint_tls_termination.rb,
lib/ngrokapi/models/reserved_domain_cert_job.rb,
lib/ngrokapi/services/agent_ingresses_client.rb,
lib/ngrokapi/services/ip_policy_rules_client.rb,
lib/ngrokapi/services/ip_restrictions_client.rb,
lib/ngrokapi/services/ssh_credentials_client.rb,
lib/ngrokapi/services/static_backends_client.rb,
lib/ngrokapi/services/tunnel_sessions_client.rb,
lib/ngrokapi/models/agent_ingress_cert_policy.rb,
lib/ngrokapi/models/agent_ingress_cert_status.rb,
lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,
lib/ngrokapi/models/endpoint_o_auth_linked_in.rb,
lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,
lib/ngrokapi/models/endpoint_response_headers.rb,
lib/ngrokapi/models/ssh_certificate_authority.rb,
lib/ngrokapi/services/reserved_domains_client.rb,
lib/ngrokapi/services/tls_certificates_client.rb,
lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,
lib/ngrokapi/models/endpoint_user_agent_filter.rb,
lib/ngrokapi/services/application_users_client.rb,
lib/ngrokapi/services/failover_backends_client.rb,
lib/ngrokapi/services/weighted_backends_client.rb,
lib/ngrokapi/models/endpoint_webhook_validation.rb,
lib/ngrokapi/models/reserved_domain_cert_policy.rb,
lib/ngrokapi/models/reserved_domain_cert_status.rb,
lib/ngrokapi/services/edges_https_routes_client.rb,
lib/ngrokapi/services/event_destinations_client.rb,
lib/ngrokapi/models/event_target_cloudwatch_logs.rb,
lib/ngrokapi/services/event_subscriptions_client.rb,
lib/ngrokapi/services/application_sessions_client.rb,
lib/ngrokapi/services/ssh_host_certificates_client.rb,
lib/ngrokapi/services/ssh_user_certificates_client.rb,
lib/ngrokapi/services/tunnel_group_backends_client.rb,
lib/ngrokapi/services/edge_route_oidc_module_client.rb,
lib/ngrokapi/services/edge_route_saml_module_client.rb,
lib/ngrokapi/services/http_response_backends_client.rb,
lib/ngrokapi/services/tcp_edge_policy_module_client.rb,
lib/ngrokapi/services/tls_edge_policy_module_client.rb,
lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb,
lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb,
lib/ngrokapi/services/certificate_authorities_client.rb,
lib/ngrokapi/services/tcp_edge_backend_module_client.rb,
lib/ngrokapi/services/tls_edge_backend_module_client.rb,
lib/ngrokapi/services/edge_route_o_auth_module_client.rb,
lib/ngrokapi/services/edge_route_policy_module_client.rb,
lib/ngrokapi/services/edge_route_backend_module_client.rb,
lib/ngrokapi/services/tls_edge_mutual_tls_module_client.rb,
lib/ngrokapi/services/ssh_certificate_authorities_client.rb,
lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb,
lib/ngrokapi/services/edge_route_compression_module_client.rb,
lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb,
lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb,
lib/ngrokapi/services/tls_edge_tls_termination_module_client.rb,
lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb,
lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb,
lib/ngrokapi/services/edge_route_request_headers_module_client.rb,
lib/ngrokapi/services/https_edge_tls_termination_module_client.rb,
lib/ngrokapi/services/edge_route_response_headers_module_client.rb,
lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb,
lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb,
lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb
@@ -147,9 +147,9 @@ diff --git a/doc/NgrokAPI/Client.html b/doc/NgrokAPI/Client.html index b09694d..942d4b7 100644 --- a/doc/NgrokAPI/Client.html +++ b/doc/NgrokAPI/Client.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Client - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -102,7 +102,7 @@

Overview

-

Low-level api client for communicating with Ngrok's HTTP API. Use this object to instantiate your clients.

+

Low-level api client for communicating with Ngrok’s HTTP API. Use this object to instantiate your clients.

@@ -143,7 +143,7 @@
-

Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok's terms of service.

+

Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok’s terms of service.

@@ -823,7 +823,7 @@
-

Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok's terms of service.

+

Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok’s terms of service.

@@ -907,7 +907,7 @@
-

API Keys are used to authenticate to the ngrok API. You may use the API itself to provision and manage API Keys but you'll need to provision your first API key from the API Keys page on your ngrok.com dashboard.

+

API Keys are used to authenticate to the ngrok API. You may use the API itself to provision and manage API Keys but you’ll need to provision your first API key from the API Keys page on your ngrok.com dashboard.

@@ -1032,7 +1032,8 @@ 222 223 224 -225 +225 +226
# File 'lib/ngrokapi/client.rb', line 217
@@ -1041,6 +1042,7 @@
   ns = OpenStruct.new
   ns.failover = NgrokAPI::Services::FailoverBackendsClient.new(client: @client)
   ns.http_response = NgrokAPI::Services::HTTPResponseBackendsClient.new(client: @client)
+  ns.static_address = NgrokAPI::Services::StaticBackendsClient.new(client: @client)
   ns.tunnel_group = NgrokAPI::Services::TunnelGroupBackendsClient.new(client: @client)
   ns.weighted = NgrokAPI::Services::WeightedBackendsClient.new(client: @client)
 
@@ -1174,7 +1176,6 @@
       
 
 
-237
 238
 239
 240
@@ -1197,10 +1198,12 @@
 257
 258
 259
-260
+260 +261 +262
-
# File 'lib/ngrokapi/client.rb', line 237
+      
# File 'lib/ngrokapi/client.rb', line 238
 
 def edge_modules
   ns = OpenStruct.new
@@ -1217,6 +1220,7 @@
   ns.https_edge_route_saml = NgrokAPI::Services::EdgeRouteSAMLModuleClient.new(client: @client)
   ns.https_edge_route_oidc = NgrokAPI::Services::EdgeRouteOIDCModuleClient.new(client: @client)
   ns.https_edge_route_websocket_tcp_converter = NgrokAPI::Services::EdgeRouteWebsocketTCPConverterModuleClient.new(client: @client)
+  ns.https_edge_route_user_agent_filter = NgrokAPI::Services::EdgeRouteUserAgentFilterModuleClient.new(client: @client)
   ns.tcp_edge_backend = NgrokAPI::Services::TCPEdgeBackendModuleClient.new(client: @client)
   ns.tcp_edge_ip_restriction = NgrokAPI::Services::TCPEdgeIPRestrictionModuleClient.new(client: @client)
   ns.tls_edge_backend = NgrokAPI::Services::TLSEdgeBackendModuleClient.new(client: @client)
@@ -1246,7 +1250,6 @@
       
 
 
-227
 228
 229
 230
@@ -1254,10 +1257,11 @@
 232
 233
 234
-235
+235 +236
-
# File 'lib/ngrokapi/client.rb', line 227
+      
# File 'lib/ngrokapi/client.rb', line 228
 
 def edges
   ns = OpenStruct.new
@@ -1645,7 +1649,7 @@
 
-

Reserved Domains are hostnames that you can listen for traffic on. Domains can be used to listen for http, https or tls traffic. You may use a domain that you own by creating a CNAME record specified in the returned resource. This CNAME record points traffic for that domain to ngrok's edge servers.

+

Reserved Domains are hostnames that you can listen for traffic on. Domains can be used to listen for http, https or tls traffic. You may use a domain that you own by creating a CNAME record specified in the returned resource. This CNAME record points traffic for that domain to ngrok’s edge servers.

@@ -2070,9 +2074,9 @@
diff --git a/doc/NgrokAPI/Error.html b/doc/NgrokAPI/Error.html index 36dbb60..a970820 100644 --- a/doc/NgrokAPI/Error.html +++ b/doc/NgrokAPI/Error.html @@ -6,7 +6,7 @@ Exception: NgrokAPI::Error - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -295,9 +295,9 @@
diff --git a/doc/NgrokAPI/Errors.html b/doc/NgrokAPI/Errors.html index f943d8d..5fe14a4 100644 --- a/doc/NgrokAPI/Errors.html +++ b/doc/NgrokAPI/Errors.html @@ -6,7 +6,7 @@ Module: NgrokAPI::Errors - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -105,9 +105,9 @@ diff --git a/doc/NgrokAPI/Errors/NotFoundError.html b/doc/NgrokAPI/Errors/NotFoundError.html index 13e59e0..1c2e0c6 100644 --- a/doc/NgrokAPI/Errors/NotFoundError.html +++ b/doc/NgrokAPI/Errors/NotFoundError.html @@ -6,7 +6,7 @@ Exception: NgrokAPI::Errors::NotFoundError - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -299,9 +299,9 @@ diff --git a/doc/NgrokAPI/HttpClient.html b/doc/NgrokAPI/HttpClient.html index 9692928..c098dbb 100644 --- a/doc/NgrokAPI/HttpClient.html +++ b/doc/NgrokAPI/HttpClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::HttpClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -102,7 +102,7 @@

Overview

-

Low-level api client for communicating with Ngrok's HTTP API using HTTP. You should not have to use this class directly, but use the individual clients to make your API calls.

+

Low-level api client for communicating with Ngrok’s HTTP API using HTTP. You should not have to use this class directly, but use the individual clients to make your API calls.

@@ -1267,9 +1267,9 @@
diff --git a/doc/NgrokAPI/Models.html b/doc/NgrokAPI/Models.html index 8a8a87b..dc16213 100644 --- a/doc/NgrokAPI/Models.html +++ b/doc/NgrokAPI/Models.html @@ -6,7 +6,7 @@ Module: NgrokAPI::Models - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -79,7 +79,7 @@
Defined in:
lib/ngrokapi/models/ref.rb,
- lib/ngrokapi/models/tunnel.rb,
lib/ngrokapi/models/api_key.rb,
lib/ngrokapi/models/aws_auth.rb,
lib/ngrokapi/models/aws_role.rb,
lib/ngrokapi/models/endpoint.rb,
lib/ngrokapi/models/listable.rb,
lib/ngrokapi/models/location.rb,
lib/ngrokapi/models/tcp_edge.rb,
lib/ngrokapi/models/tls_edge.rb,
lib/ngrokapi/models/ip_policy.rb,
lib/ngrokapi/models/credential.rb,
lib/ngrokapi/models/https_edge.rb,
lib/ngrokapi/models/user_agent.rb,
lib/ngrokapi/models/abuse_report.rb,
lib/ngrokapi/models/event_source.rb,
lib/ngrokapi/models/event_target.rb,
lib/ngrokapi/models/agent_ingress.rb,
lib/ngrokapi/models/endpoint_oidc.rb,
lib/ngrokapi/models/endpoint_saml.rb,
lib/ngrokapi/models/reserved_addr.rb,
lib/ngrokapi/models/ip_policy_rule.rb,
lib/ngrokapi/models/ip_restriction.rb,
lib/ngrokapi/models/ssh_credential.rb,
lib/ngrokapi/models/tunnel_session.rb,
lib/ngrokapi/models/aws_credentials.rb,
lib/ngrokapi/models/browser_session.rb,
lib/ngrokapi/models/endpoint_o_auth.rb,
lib/ngrokapi/models/reserved_domain.rb,
lib/ngrokapi/models/tls_certificate.rb,
lib/ngrokapi/models/application_user.rb,
lib/ngrokapi/models/endpoint_backend.rb,
lib/ngrokapi/models/failover_backend.rb,
lib/ngrokapi/models/https_edge_route.rb,
lib/ngrokapi/models/weighted_backend.rb,
lib/ngrokapi/models/event_destination.rb,
lib/ngrokapi/models/event_source_list.rb,
lib/ngrokapi/models/identity_provider.rb,
lib/ngrokapi/models/endpoint_ip_policy.rb,
lib/ngrokapi/models/event_subscription.rb,
lib/ngrokapi/models/application_session.rb,
lib/ngrokapi/models/endpoint_mutual_tls.rb,
lib/ngrokapi/models/endpoint_compression.rb,
lib/ngrokapi/models/endpoint_saml_mutate.rb,
lib/ngrokapi/models/event_source_replace.rb,
lib/ngrokapi/models/event_target_datadog.rb,
lib/ngrokapi/models/event_target_kinesis.rb,
lib/ngrokapi/models/ssh_host_certificate.rb,
lib/ngrokapi/models/ssh_user_certificate.rb,
lib/ngrokapi/models/tunnel_group_backend.rb,
lib/ngrokapi/models/abuse_report_hostname.rb,
lib/ngrokapi/models/certificate_authority.rb,
lib/ngrokapi/models/event_target_firehose.rb,
lib/ngrokapi/models/http_response_backend.rb,
lib/ngrokapi/models/tls_certificate_sa_ns.rb,
lib/ngrokapi/models/agent_ingress_cert_job.rb,
lib/ngrokapi/models/endpoint_o_auth_amazon.rb,
lib/ngrokapi/models/endpoint_o_auth_google.rb,
lib/ngrokapi/models/endpoint_o_auth_twitch.rb,
lib/ngrokapi/models/endpoint_backend_mutate.rb,
lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,
lib/ngrokapi/models/endpoint_o_auth_git_lab.rb,
lib/ngrokapi/models/endpoint_circuit_breaker.rb,
lib/ngrokapi/models/endpoint_o_auth_facebook.rb,
lib/ngrokapi/models/endpoint_o_auth_provider.rb,
lib/ngrokapi/models/endpoint_request_headers.rb,
lib/ngrokapi/models/endpoint_tls_termination.rb,
lib/ngrokapi/models/reserved_domain_cert_job.rb,
lib/ngrokapi/models/agent_ingress_cert_policy.rb,
lib/ngrokapi/models/agent_ingress_cert_status.rb,
lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,
lib/ngrokapi/models/endpoint_o_auth_linked_in.rb,
lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,
lib/ngrokapi/models/endpoint_response_headers.rb,
lib/ngrokapi/models/ssh_certificate_authority.rb,
lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,
lib/ngrokapi/models/endpoint_webhook_validation.rb,
lib/ngrokapi/models/reserved_domain_cert_policy.rb,
lib/ngrokapi/models/reserved_domain_cert_status.rb,
lib/ngrokapi/models/event_target_cloudwatch_logs.rb,
lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb,
lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb
+ lib/ngrokapi/models/tunnel.rb,
lib/ngrokapi/models/api_key.rb,
lib/ngrokapi/models/aws_auth.rb,
lib/ngrokapi/models/aws_role.rb,
lib/ngrokapi/models/endpoint.rb,
lib/ngrokapi/models/listable.rb,
lib/ngrokapi/models/location.rb,
lib/ngrokapi/models/tcp_edge.rb,
lib/ngrokapi/models/tls_edge.rb,
lib/ngrokapi/models/ip_policy.rb,
lib/ngrokapi/models/credential.rb,
lib/ngrokapi/models/https_edge.rb,
lib/ngrokapi/models/user_agent.rb,
lib/ngrokapi/models/abuse_report.rb,
lib/ngrokapi/models/event_source.rb,
lib/ngrokapi/models/event_target.rb,
lib/ngrokapi/models/agent_ingress.rb,
lib/ngrokapi/models/endpoint_oidc.rb,
lib/ngrokapi/models/endpoint_rule.rb,
lib/ngrokapi/models/endpoint_saml.rb,
lib/ngrokapi/models/reserved_addr.rb,
lib/ngrokapi/models/ip_policy_rule.rb,
lib/ngrokapi/models/ip_restriction.rb,
lib/ngrokapi/models/ssh_credential.rb,
lib/ngrokapi/models/static_backend.rb,
lib/ngrokapi/models/tunnel_session.rb,
lib/ngrokapi/models/aws_credentials.rb,
lib/ngrokapi/models/browser_session.rb,
lib/ngrokapi/models/endpoint_action.rb,
lib/ngrokapi/models/endpoint_o_auth.rb,
lib/ngrokapi/models/endpoint_policy.rb,
lib/ngrokapi/models/reserved_domain.rb,
lib/ngrokapi/models/tls_certificate.rb,
lib/ngrokapi/models/application_user.rb,
lib/ngrokapi/models/endpoint_backend.rb,
lib/ngrokapi/models/failover_backend.rb,
lib/ngrokapi/models/https_edge_route.rb,
lib/ngrokapi/models/weighted_backend.rb,
lib/ngrokapi/models/event_destination.rb,
lib/ngrokapi/models/event_source_list.rb,
lib/ngrokapi/models/identity_provider.rb,
lib/ngrokapi/models/endpoint_ip_policy.rb,
lib/ngrokapi/models/event_subscription.rb,
lib/ngrokapi/models/static_backend_tls.rb,
lib/ngrokapi/models/application_session.rb,
lib/ngrokapi/models/endpoint_mutual_tls.rb,
lib/ngrokapi/models/endpoint_compression.rb,
lib/ngrokapi/models/endpoint_saml_mutate.rb,
lib/ngrokapi/models/event_source_replace.rb,
lib/ngrokapi/models/event_target_datadog.rb,
lib/ngrokapi/models/event_target_kinesis.rb,
lib/ngrokapi/models/ssh_host_certificate.rb,
lib/ngrokapi/models/ssh_user_certificate.rb,
lib/ngrokapi/models/tunnel_group_backend.rb,
lib/ngrokapi/models/abuse_report_hostname.rb,
lib/ngrokapi/models/certificate_authority.rb,
lib/ngrokapi/models/event_target_firehose.rb,
lib/ngrokapi/models/http_response_backend.rb,
lib/ngrokapi/models/tls_certificate_sa_ns.rb,
lib/ngrokapi/models/agent_ingress_cert_job.rb,
lib/ngrokapi/models/endpoint_o_auth_amazon.rb,
lib/ngrokapi/models/endpoint_o_auth_google.rb,
lib/ngrokapi/models/endpoint_o_auth_twitch.rb,
lib/ngrokapi/models/endpoint_backend_mutate.rb,
lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,
lib/ngrokapi/models/endpoint_o_auth_git_lab.rb,
lib/ngrokapi/models/endpoint_circuit_breaker.rb,
lib/ngrokapi/models/endpoint_o_auth_facebook.rb,
lib/ngrokapi/models/endpoint_o_auth_provider.rb,
lib/ngrokapi/models/endpoint_request_headers.rb,
lib/ngrokapi/models/endpoint_tls_termination.rb,
lib/ngrokapi/models/reserved_domain_cert_job.rb,
lib/ngrokapi/models/agent_ingress_cert_policy.rb,
lib/ngrokapi/models/agent_ingress_cert_status.rb,
lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,
lib/ngrokapi/models/endpoint_o_auth_linked_in.rb,
lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,
lib/ngrokapi/models/endpoint_response_headers.rb,
lib/ngrokapi/models/ssh_certificate_authority.rb,
lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,
lib/ngrokapi/models/endpoint_user_agent_filter.rb,
lib/ngrokapi/models/endpoint_webhook_validation.rb,
lib/ngrokapi/models/reserved_domain_cert_policy.rb,
lib/ngrokapi/models/reserved_domain_cert_status.rb,
lib/ngrokapi/models/event_target_cloudwatch_logs.rb,
lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb,
lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb
@@ -91,7 +91,7 @@ - Classes: APIKey, AWSAuth, AWSCredentials, AWSRole, AbuseReport, AbuseReportHostname, AgentIngress, AgentIngressCertJob, AgentIngressCertPolicy, AgentIngressCertStatus, ApplicationSession, ApplicationUser, BrowserSession, CertificateAuthority, Credential, Endpoint, EndpointBackend, EndpointBackendMutate, EndpointCircuitBreaker, EndpointCompression, EndpointIPPolicy, EndpointIPPolicyMutate, EndpointMutualTLS, EndpointMutualTLSMutate, EndpointOAuth, EndpointOAuthAmazon, EndpointOAuthFacebook, EndpointOAuthGitHub, EndpointOAuthGitLab, EndpointOAuthGoogle, EndpointOAuthLinkedIn, EndpointOAuthMicrosoft, EndpointOAuthProvider, EndpointOAuthTwitch, EndpointOIDC, EndpointRequestHeaders, EndpointResponseHeaders, EndpointSAML, EndpointSAMLMutate, EndpointTLSTermination, EndpointTLSTerminationAtEdge, EndpointWebhookValidation, EndpointWebsocketTCPConverter, EventDestination, EventSource, EventSourceList, EventSourceReplace, EventSubscription, EventTarget, EventTargetCloudwatchLogs, EventTargetDatadog, EventTargetFirehose, EventTargetKinesis, FailoverBackend, HTTPResponseBackend, HTTPSEdge, HTTPSEdgeRoute, IPPolicy, IPPolicyRule, IPRestriction, IdentityProvider, Listable, Location, Ref, ReservedAddr, ReservedDomain, ReservedDomainCertJob, ReservedDomainCertPolicy, ReservedDomainCertStatus, SSHCertificateAuthority, SSHCredential, SSHHostCertificate, SSHUserCertificate, TCPEdge, TLSCertificate, TLSCertificateSANs, TLSEdge, Tunnel, TunnelGroupBackend, TunnelSession, UserAgent, WeightedBackend + Classes: APIKey, AWSAuth, AWSCredentials, AWSRole, AbuseReport, AbuseReportHostname, AgentIngress, AgentIngressCertJob, AgentIngressCertPolicy, AgentIngressCertStatus, ApplicationSession, ApplicationUser, BrowserSession, CertificateAuthority, Credential, Endpoint, EndpointAction, EndpointBackend, EndpointBackendMutate, EndpointCircuitBreaker, EndpointCompression, EndpointIPPolicy, EndpointIPPolicyMutate, EndpointMutualTLS, EndpointMutualTLSMutate, EndpointOAuth, EndpointOAuthAmazon, EndpointOAuthFacebook, EndpointOAuthGitHub, EndpointOAuthGitLab, EndpointOAuthGoogle, EndpointOAuthLinkedIn, EndpointOAuthMicrosoft, EndpointOAuthProvider, EndpointOAuthTwitch, EndpointOIDC, EndpointPolicy, EndpointRequestHeaders, EndpointResponseHeaders, EndpointRule, EndpointSAML, EndpointSAMLMutate, EndpointTLSTermination, EndpointTLSTerminationAtEdge, EndpointUserAgentFilter, EndpointWebhookValidation, EndpointWebsocketTCPConverter, EventDestination, EventSource, EventSourceList, EventSourceReplace, EventSubscription, EventTarget, EventTargetCloudwatchLogs, EventTargetDatadog, EventTargetFirehose, EventTargetKinesis, FailoverBackend, HTTPResponseBackend, HTTPSEdge, HTTPSEdgeRoute, IPPolicy, IPPolicyRule, IPRestriction, IdentityProvider, Listable, Location, Ref, ReservedAddr, ReservedDomain, ReservedDomainCertJob, ReservedDomainCertPolicy, ReservedDomainCertStatus, SSHCertificateAuthority, SSHCredential, SSHHostCertificate, SSHUserCertificate, StaticBackend, StaticBackendTLS, TCPEdge, TLSCertificate, TLSCertificateSANs, TLSEdge, Tunnel, TunnelGroupBackend, TunnelSession, UserAgent, WeightedBackend

@@ -107,9 +107,9 @@ diff --git a/doc/NgrokAPI/Models/APIKey.html b/doc/NgrokAPI/Models/APIKey.html index e8450fb..dc12078 100644 --- a/doc/NgrokAPI/Models/APIKey.html +++ b/doc/NgrokAPI/Models/APIKey.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::APIKey - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1189,9 +1189,9 @@ diff --git a/doc/NgrokAPI/Models/AWSAuth.html b/doc/NgrokAPI/Models/AWSAuth.html index e384deb..424b4c7 100644 --- a/doc/NgrokAPI/Models/AWSAuth.html +++ b/doc/NgrokAPI/Models/AWSAuth.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::AWSAuth - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -659,9 +659,9 @@ diff --git a/doc/NgrokAPI/Models/AWSCredentials.html b/doc/NgrokAPI/Models/AWSCredentials.html index c2cadd9..03d6937 100644 --- a/doc/NgrokAPI/Models/AWSCredentials.html +++ b/doc/NgrokAPI/Models/AWSCredentials.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::AWSCredentials - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -659,9 +659,9 @@ diff --git a/doc/NgrokAPI/Models/AWSRole.html b/doc/NgrokAPI/Models/AWSRole.html index fbfcdd7..38e57eb 100644 --- a/doc/NgrokAPI/Models/AWSRole.html +++ b/doc/NgrokAPI/Models/AWSRole.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::AWSRole - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -585,9 +585,9 @@ diff --git a/doc/NgrokAPI/Models/AbuseReport.html b/doc/NgrokAPI/Models/AbuseReport.html index 41a0f87..dd27ebd 100644 --- a/doc/NgrokAPI/Models/AbuseReport.html +++ b/doc/NgrokAPI/Models/AbuseReport.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::AbuseReport - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1033,9 +1033,9 @@ diff --git a/doc/NgrokAPI/Models/AbuseReportHostname.html b/doc/NgrokAPI/Models/AbuseReportHostname.html index e6e8d32..0e0c456 100644 --- a/doc/NgrokAPI/Models/AbuseReportHostname.html +++ b/doc/NgrokAPI/Models/AbuseReportHostname.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::AbuseReportHostname - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -659,9 +659,9 @@ diff --git a/doc/NgrokAPI/Models/AgentIngress.html b/doc/NgrokAPI/Models/AgentIngress.html index 8b4a132..f77ddde 100644 --- a/doc/NgrokAPI/Models/AgentIngress.html +++ b/doc/NgrokAPI/Models/AgentIngress.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::AgentIngress - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1417,9 +1417,9 @@ diff --git a/doc/NgrokAPI/Models/AgentIngressCertJob.html b/doc/NgrokAPI/Models/AgentIngressCertJob.html index 5253aa0..00dde45 100644 --- a/doc/NgrokAPI/Models/AgentIngressCertJob.html +++ b/doc/NgrokAPI/Models/AgentIngressCertJob.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::AgentIngressCertJob - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -807,9 +807,9 @@ diff --git a/doc/NgrokAPI/Models/AgentIngressCertPolicy.html b/doc/NgrokAPI/Models/AgentIngressCertPolicy.html index 200c458..15d0ea3 100644 --- a/doc/NgrokAPI/Models/AgentIngressCertPolicy.html +++ b/doc/NgrokAPI/Models/AgentIngressCertPolicy.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::AgentIngressCertPolicy - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -659,9 +659,9 @@ diff --git a/doc/NgrokAPI/Models/AgentIngressCertStatus.html b/doc/NgrokAPI/Models/AgentIngressCertStatus.html index c409c81..827c568 100644 --- a/doc/NgrokAPI/Models/AgentIngressCertStatus.html +++ b/doc/NgrokAPI/Models/AgentIngressCertStatus.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::AgentIngressCertStatus - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -659,9 +659,9 @@ diff --git a/doc/NgrokAPI/Models/ApplicationSession.html b/doc/NgrokAPI/Models/ApplicationSession.html index 6515482..bd833d9 100644 --- a/doc/NgrokAPI/Models/ApplicationSession.html +++ b/doc/NgrokAPI/Models/ApplicationSession.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::ApplicationSession - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1404,9 +1404,9 @@ diff --git a/doc/NgrokAPI/Models/ApplicationUser.html b/doc/NgrokAPI/Models/ApplicationUser.html index fa9ac1f..843d22f 100644 --- a/doc/NgrokAPI/Models/ApplicationUser.html +++ b/doc/NgrokAPI/Models/ApplicationUser.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::ApplicationUser - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1326,9 +1326,9 @@ diff --git a/doc/NgrokAPI/Models/BrowserSession.html b/doc/NgrokAPI/Models/BrowserSession.html index d083d07..1dacba2 100644 --- a/doc/NgrokAPI/Models/BrowserSession.html +++ b/doc/NgrokAPI/Models/BrowserSession.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::BrowserSession - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -733,9 +733,9 @@ diff --git a/doc/NgrokAPI/Models/CertificateAuthority.html b/doc/NgrokAPI/Models/CertificateAuthority.html index b96bba4..9d84e11 100644 --- a/doc/NgrokAPI/Models/CertificateAuthority.html +++ b/doc/NgrokAPI/Models/CertificateAuthority.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::CertificateAuthority - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1485,9 +1485,9 @@ diff --git a/doc/NgrokAPI/Models/Credential.html b/doc/NgrokAPI/Models/Credential.html index b288a1d..7de3452 100644 --- a/doc/NgrokAPI/Models/Credential.html +++ b/doc/NgrokAPI/Models/Credential.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::Credential - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1269,9 +1269,9 @@ diff --git a/doc/NgrokAPI/Models/Endpoint.html b/doc/NgrokAPI/Models/Endpoint.html index cae5c69..6d73ade 100644 --- a/doc/NgrokAPI/Models/Endpoint.html +++ b/doc/NgrokAPI/Models/Endpoint.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::Endpoint - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1477,9 +1477,9 @@ diff --git a/doc/NgrokAPI/Models/EndpointAction.html b/doc/NgrokAPI/Models/EndpointAction.html new file mode 100644 index 0000000..81c056b --- /dev/null +++ b/doc/NgrokAPI/Models/EndpointAction.html @@ -0,0 +1,669 @@ + + + + + + + Class: NgrokAPI::Models::EndpointAction + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
+ + +

Class: NgrokAPI::Models::EndpointAction + + + +

+
+ +
+
Inherits:
+
+ Object + +
    +
  • Object
  • + + + +
+ show all + +
+
+ + + + + + + + + + + +
+
Defined in:
+
lib/ngrokapi/models/endpoint_action.rb
+
+ +
+ + + + + +

Instance Attribute Summary collapse

+
    + +
  • + + + #attrs ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
    +

    Returns the value of attribute attrs.

    +
    + +
  • + + +
  • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
    +

    Returns the value of attribute client.

    +
    + +
  • + + +
  • + + + #config ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
    +

    Returns the value of attribute config.

    +
    + +
  • + + +
  • + + + #type ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
    +

    Returns the value of attribute type.

    +
    + +
  • + + +
+ + + + + +

+ Instance Method Summary + collapse +

+ + + + +
+

Constructor Details

+ +
+

+ + #initialize(client: nil, attrs: {}) ⇒ EndpointAction + + + + + +

+
+ +

Returns a new instance of EndpointAction.

+ + +
+
+
+ + +
+ + + + +
+
+
+
+13
+14
+15
+16
+17
+18
+
+
# File 'lib/ngrokapi/models/endpoint_action.rb', line 13
+
+def initialize(client: nil, attrs: {})
+  @client = client
+  @attrs = attrs
+  @type = @attrs['type']
+  @config = @attrs['config']
+end
+
+
+ +
+ +
+

Instance Attribute Details

+ + + +
+

+ + #attrsObject (readonly) + + + + + +

+
+ +

Returns the value of attribute attrs.

+ + +
+
+
+ + +
+ + + + +
+
+
+
+8
+9
+10
+
+
# File 'lib/ngrokapi/models/endpoint_action.rb', line 8
+
+def attrs
+  @attrs
+end
+
+
+ + + +
+

+ + #clientObject (readonly) + + + + + +

+
+ +

Returns the value of attribute client.

+ + +
+
+
+ + +
+ + + + +
+
+
+
+8
+9
+10
+
+
# File 'lib/ngrokapi/models/endpoint_action.rb', line 8
+
+def client
+  @client
+end
+
+
+ + + +
+

+ + #configObject (readonly) + + + + + +

+
+ +

Returns the value of attribute config.

+ + +
+
+
+ + +
+ + + + +
+
+
+
+8
+9
+10
+
+
# File 'lib/ngrokapi/models/endpoint_action.rb', line 8
+
+def config
+  @config
+end
+
+
+ + + +
+

+ + #typeObject (readonly) + + + + + +

+
+ +

Returns the value of attribute type.

+ + +
+
+
+ + +
+ + + + +
+
+
+
+8
+9
+10
+
+
# File 'lib/ngrokapi/models/endpoint_action.rb', line 8
+
+def type
+  @type
+end
+
+
+ +
+ + +
+

Instance Method Details

+ + +
+

+ + #==(other) ⇒ Object + + + + + +

+ + + + +
+
+
+
+20
+21
+22
+
+
# File 'lib/ngrokapi/models/endpoint_action.rb', line 20
+
+def ==(other)
+  @attrs == other.attrs
+end
+
+
+ +
+

+ + #to_hObject + + + + + +

+ + + + +
+
+
+
+28
+29
+30
+
+
# File 'lib/ngrokapi/models/endpoint_action.rb', line 28
+
+def to_h
+  @attrs.to_h
+end
+
+
+ +
+

+ + #to_sObject + + + + + +

+ + + + +
+
+
+
+24
+25
+26
+
+
# File 'lib/ngrokapi/models/endpoint_action.rb', line 24
+
+def to_s
+  @attrs.to_s
+end
+
+
+ +
+ +
+ + + +
+ + \ No newline at end of file diff --git a/doc/NgrokAPI/Models/EndpointBackend.html b/doc/NgrokAPI/Models/EndpointBackend.html index 03c2901..2cd4bde 100644 --- a/doc/NgrokAPI/Models/EndpointBackend.html +++ b/doc/NgrokAPI/Models/EndpointBackend.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointBackend - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -659,9 +659,9 @@ diff --git a/doc/NgrokAPI/Models/EndpointBackendMutate.html b/doc/NgrokAPI/Models/EndpointBackendMutate.html index 0e7987f..420199e 100644 --- a/doc/NgrokAPI/Models/EndpointBackendMutate.html +++ b/doc/NgrokAPI/Models/EndpointBackendMutate.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointBackendMutate - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -659,9 +659,9 @@ diff --git a/doc/NgrokAPI/Models/EndpointCircuitBreaker.html b/doc/NgrokAPI/Models/EndpointCircuitBreaker.html index ad02b39..7e64d0a 100644 --- a/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +++ b/doc/NgrokAPI/Models/EndpointCircuitBreaker.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointCircuitBreaker - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -955,9 +955,9 @@ diff --git a/doc/NgrokAPI/Models/EndpointCompression.html b/doc/NgrokAPI/Models/EndpointCompression.html index 2845492..9ccbef3 100644 --- a/doc/NgrokAPI/Models/EndpointCompression.html +++ b/doc/NgrokAPI/Models/EndpointCompression.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointCompression - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -585,9 +585,9 @@ diff --git a/doc/NgrokAPI/Models/EndpointIPPolicy.html b/doc/NgrokAPI/Models/EndpointIPPolicy.html index 7ea8592..017ed08 100644 --- a/doc/NgrokAPI/Models/EndpointIPPolicy.html +++ b/doc/NgrokAPI/Models/EndpointIPPolicy.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointIPPolicy - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -659,9 +659,9 @@ diff --git a/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html b/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html index 9f6ec1a..f578265 100644 --- a/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +++ b/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointIPPolicyMutate - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -659,9 +659,9 @@ diff --git a/doc/NgrokAPI/Models/EndpointMutualTLS.html b/doc/NgrokAPI/Models/EndpointMutualTLS.html index a5ccf66..d280789 100644 --- a/doc/NgrokAPI/Models/EndpointMutualTLS.html +++ b/doc/NgrokAPI/Models/EndpointMutualTLS.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointMutualTLS - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -659,9 +659,9 @@ diff --git a/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html b/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html index 6a69739..58b45d7 100644 --- a/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +++ b/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointMutualTLSMutate - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -659,9 +659,9 @@ diff --git a/doc/NgrokAPI/Models/EndpointOAuth.html b/doc/NgrokAPI/Models/EndpointOAuth.html index c91f722..bbaf4c0 100644 --- a/doc/NgrokAPI/Models/EndpointOAuth.html +++ b/doc/NgrokAPI/Models/EndpointOAuth.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointOAuth - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1029,9 +1029,9 @@ diff --git a/doc/NgrokAPI/Models/EndpointOAuthAmazon.html b/doc/NgrokAPI/Models/EndpointOAuthAmazon.html index 89d9472..228a483 100644 --- a/doc/NgrokAPI/Models/EndpointOAuthAmazon.html +++ b/doc/NgrokAPI/Models/EndpointOAuthAmazon.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointOAuthAmazon - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -881,9 +881,9 @@ diff --git a/doc/NgrokAPI/Models/EndpointOAuthFacebook.html b/doc/NgrokAPI/Models/EndpointOAuthFacebook.html index 67c0760..ded7c49 100644 --- a/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +++ b/doc/NgrokAPI/Models/EndpointOAuthFacebook.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointOAuthFacebook - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -881,9 +881,9 @@ diff --git a/doc/NgrokAPI/Models/EndpointOAuthGitHub.html b/doc/NgrokAPI/Models/EndpointOAuthGitHub.html index e8f5e98..f86cb5f 100644 --- a/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +++ b/doc/NgrokAPI/Models/EndpointOAuthGitHub.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointOAuthGitHub - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1029,9 +1029,9 @@ diff --git a/doc/NgrokAPI/Models/EndpointOAuthGitLab.html b/doc/NgrokAPI/Models/EndpointOAuthGitLab.html index c78037d..1be5f1a 100644 --- a/doc/NgrokAPI/Models/EndpointOAuthGitLab.html +++ b/doc/NgrokAPI/Models/EndpointOAuthGitLab.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointOAuthGitLab - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -881,9 +881,9 @@ diff --git a/doc/NgrokAPI/Models/EndpointOAuthGoogle.html b/doc/NgrokAPI/Models/EndpointOAuthGoogle.html index fade8a0..82b81ca 100644 --- a/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +++ b/doc/NgrokAPI/Models/EndpointOAuthGoogle.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointOAuthGoogle - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -881,9 +881,9 @@ diff --git a/doc/NgrokAPI/Models/EndpointOAuthLinkedIn.html b/doc/NgrokAPI/Models/EndpointOAuthLinkedIn.html index 160847c..27a98ee 100644 --- a/doc/NgrokAPI/Models/EndpointOAuthLinkedIn.html +++ b/doc/NgrokAPI/Models/EndpointOAuthLinkedIn.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointOAuthLinkedIn - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -881,9 +881,9 @@ diff --git a/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html b/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html index 35ec201..9000447 100644 --- a/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +++ b/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointOAuthMicrosoft - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -881,9 +881,9 @@ diff --git a/doc/NgrokAPI/Models/EndpointOAuthProvider.html b/doc/NgrokAPI/Models/EndpointOAuthProvider.html index 0dc60ba..7a5b2d9 100644 --- a/doc/NgrokAPI/Models/EndpointOAuthProvider.html +++ b/doc/NgrokAPI/Models/EndpointOAuthProvider.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointOAuthProvider - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1103,9 +1103,9 @@ diff --git a/doc/NgrokAPI/Models/EndpointOAuthTwitch.html b/doc/NgrokAPI/Models/EndpointOAuthTwitch.html index 2e27907..50d771b 100644 --- a/doc/NgrokAPI/Models/EndpointOAuthTwitch.html +++ b/doc/NgrokAPI/Models/EndpointOAuthTwitch.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointOAuthTwitch - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -881,9 +881,9 @@ diff --git a/doc/NgrokAPI/Models/EndpointOIDC.html b/doc/NgrokAPI/Models/EndpointOIDC.html index 35e05c2..f879a86 100644 --- a/doc/NgrokAPI/Models/EndpointOIDC.html +++ b/doc/NgrokAPI/Models/EndpointOIDC.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointOIDC - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1177,9 +1177,9 @@ diff --git a/doc/NgrokAPI/Models/EndpointPolicy.html b/doc/NgrokAPI/Models/EndpointPolicy.html new file mode 100644 index 0000000..c5fb399 --- /dev/null +++ b/doc/NgrokAPI/Models/EndpointPolicy.html @@ -0,0 +1,743 @@ + + + + + + + Class: NgrokAPI::Models::EndpointPolicy + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
+ + +

Class: NgrokAPI::Models::EndpointPolicy + + + +

+
+ +
+
Inherits:
+
+ Object + +
    +
  • Object
  • + + + +
+ show all + +
+
+ + + + + + + + + + + +
+
Defined in:
+
lib/ngrokapi/models/endpoint_policy.rb
+
+ +
+ + + + + +

Instance Attribute Summary collapse

+
    + +
  • + + + #attrs ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
    +

    Returns the value of attribute attrs.

    +
    + +
  • + + +
  • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
    +

    Returns the value of attribute client.

    +
    + +
  • + + +
  • + + + #enabled ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
    +

    Returns the value of attribute enabled.

    +
    + +
  • + + +
  • + + + #inbound ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
    +

    Returns the value of attribute inbound.

    +
    + +
  • + + +
  • + + + #outbound ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
    +

    Returns the value of attribute outbound.

    +
    + +
  • + + +
+ + + + + +

+ Instance Method Summary + collapse +

+ + + + +
+

Constructor Details

+ +
+

+ + #initialize(client: nil, attrs: {}) ⇒ EndpointPolicy + + + + + +

+
+ +

Returns a new instance of EndpointPolicy.

+ + +
+
+
+ + +
+ + + + +
+
+
+
+14
+15
+16
+17
+18
+19
+20
+
+
# File 'lib/ngrokapi/models/endpoint_policy.rb', line 14
+
+def initialize(client: nil, attrs: {})
+  @client = client
+  @attrs = attrs
+  @enabled = @attrs['enabled']
+  @inbound = @attrs['inbound']
+  @outbound = @attrs['outbound']
+end
+
+
+ +
+ +
+

Instance Attribute Details

+ + + +
+

+ + #attrsObject (readonly) + + + + + +

+
+ +

Returns the value of attribute attrs.

+ + +
+
+
+ + +
+ + + + +
+
+
+
+8
+9
+10
+
+
# File 'lib/ngrokapi/models/endpoint_policy.rb', line 8
+
+def attrs
+  @attrs
+end
+
+
+ + + +
+

+ + #clientObject (readonly) + + + + + +

+
+ +

Returns the value of attribute client.

+ + +
+
+
+ + +
+ + + + +
+
+
+
+8
+9
+10
+
+
# File 'lib/ngrokapi/models/endpoint_policy.rb', line 8
+
+def client
+  @client
+end
+
+
+ + + +
+

+ + #enabledObject (readonly) + + + + + +

+
+ +

Returns the value of attribute enabled.

+ + +
+
+
+ + +
+ + + + +
+
+
+
+8
+9
+10
+
+
# File 'lib/ngrokapi/models/endpoint_policy.rb', line 8
+
+def enabled
+  @enabled
+end
+
+
+ + + +
+

+ + #inboundObject (readonly) + + + + + +

+
+ +

Returns the value of attribute inbound.

+ + +
+
+
+ + +
+ + + + +
+
+
+
+8
+9
+10
+
+
# File 'lib/ngrokapi/models/endpoint_policy.rb', line 8
+
+def inbound
+  @inbound
+end
+
+
+ + + +
+

+ + #outboundObject (readonly) + + + + + +

+
+ +

Returns the value of attribute outbound.

+ + +
+
+
+ + +
+ + + + +
+
+
+
+8
+9
+10
+
+
# File 'lib/ngrokapi/models/endpoint_policy.rb', line 8
+
+def outbound
+  @outbound
+end
+
+
+ +
+ + +
+

Instance Method Details

+ + +
+

+ + #==(other) ⇒ Object + + + + + +

+ + + + +
+
+
+
+22
+23
+24
+
+
# File 'lib/ngrokapi/models/endpoint_policy.rb', line 22
+
+def ==(other)
+  @attrs == other.attrs
+end
+
+
+ +
+

+ + #to_hObject + + + + + +

+ + + + +
+
+
+
+30
+31
+32
+
+
# File 'lib/ngrokapi/models/endpoint_policy.rb', line 30
+
+def to_h
+  @attrs.to_h
+end
+
+
+ +
+

+ + #to_sObject + + + + + +

+ + + + +
+
+
+
+26
+27
+28
+
+
# File 'lib/ngrokapi/models/endpoint_policy.rb', line 26
+
+def to_s
+  @attrs.to_s
+end
+
+
+ +
+ +
+ + + +
+ + \ No newline at end of file diff --git a/doc/NgrokAPI/Models/EndpointRequestHeaders.html b/doc/NgrokAPI/Models/EndpointRequestHeaders.html index 08814fd..b8d4e09 100644 --- a/doc/NgrokAPI/Models/EndpointRequestHeaders.html +++ b/doc/NgrokAPI/Models/EndpointRequestHeaders.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointRequestHeaders - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -733,9 +733,9 @@ diff --git a/doc/NgrokAPI/Models/EndpointResponseHeaders.html b/doc/NgrokAPI/Models/EndpointResponseHeaders.html index 8e9a7a8..aab23f9 100644 --- a/doc/NgrokAPI/Models/EndpointResponseHeaders.html +++ b/doc/NgrokAPI/Models/EndpointResponseHeaders.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointResponseHeaders - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -733,9 +733,9 @@ diff --git a/doc/NgrokAPI/Models/EndpointRule.html b/doc/NgrokAPI/Models/EndpointRule.html new file mode 100644 index 0000000..c7c23b7 --- /dev/null +++ b/doc/NgrokAPI/Models/EndpointRule.html @@ -0,0 +1,743 @@ + + + + + + + Class: NgrokAPI::Models::EndpointRule + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
+ + +

Class: NgrokAPI::Models::EndpointRule + + + +

+
+ +
+
Inherits:
+
+ Object + +
    +
  • Object
  • + + + +
+ show all + +
+
+ + + + + + + + + + + +
+
Defined in:
+
lib/ngrokapi/models/endpoint_rule.rb
+
+ +
+ + + + + +

Instance Attribute Summary collapse

+
    + +
  • + + + #actions ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
    +

    Returns the value of attribute actions.

    +
    + +
  • + + +
  • + + + #attrs ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
    +

    Returns the value of attribute attrs.

    +
    + +
  • + + +
  • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
    +

    Returns the value of attribute client.

    +
    + +
  • + + +
  • + + + #expressions ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
    +

    Returns the value of attribute expressions.

    +
    + +
  • + + +
  • + + + #name ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
    +

    Returns the value of attribute name.

    +
    + +
  • + + +
+ + + + + +

+ Instance Method Summary + collapse +

+ + + + +
+

Constructor Details

+ +
+

+ + #initialize(client: nil, attrs: {}) ⇒ EndpointRule + + + + + +

+
+ +

Returns a new instance of EndpointRule.

+ + +
+
+
+ + +
+ + + + +
+
+
+
+14
+15
+16
+17
+18
+19
+20
+
+
# File 'lib/ngrokapi/models/endpoint_rule.rb', line 14
+
+def initialize(client: nil, attrs: {})
+  @client = client
+  @attrs = attrs
+  @expressions = @attrs['expressions']
+  @actions = @attrs['actions']
+  @name = @attrs['name']
+end
+
+
+ +
+ +
+

Instance Attribute Details

+ + + +
+

+ + #actionsObject (readonly) + + + + + +

+
+ +

Returns the value of attribute actions.

+ + +
+
+
+ + +
+ + + + +
+
+
+
+8
+9
+10
+
+
# File 'lib/ngrokapi/models/endpoint_rule.rb', line 8
+
+def actions
+  @actions
+end
+
+
+ + + +
+

+ + #attrsObject (readonly) + + + + + +

+
+ +

Returns the value of attribute attrs.

+ + +
+
+
+ + +
+ + + + +
+
+
+
+8
+9
+10
+
+
# File 'lib/ngrokapi/models/endpoint_rule.rb', line 8
+
+def attrs
+  @attrs
+end
+
+
+ + + +
+

+ + #clientObject (readonly) + + + + + +

+
+ +

Returns the value of attribute client.

+ + +
+
+
+ + +
+ + + + +
+
+
+
+8
+9
+10
+
+
# File 'lib/ngrokapi/models/endpoint_rule.rb', line 8
+
+def client
+  @client
+end
+
+
+ + + +
+

+ + #expressionsObject (readonly) + + + + + +

+
+ +

Returns the value of attribute expressions.

+ + +
+
+
+ + +
+ + + + +
+
+
+
+8
+9
+10
+
+
# File 'lib/ngrokapi/models/endpoint_rule.rb', line 8
+
+def expressions
+  @expressions
+end
+
+
+ + + +
+

+ + #nameObject (readonly) + + + + + +

+
+ +

Returns the value of attribute name.

+ + +
+
+
+ + +
+ + + + +
+
+
+
+8
+9
+10
+
+
# File 'lib/ngrokapi/models/endpoint_rule.rb', line 8
+
+def name
+  @name
+end
+
+
+ +
+ + +
+

Instance Method Details

+ + +
+

+ + #==(other) ⇒ Object + + + + + +

+ + + + +
+
+
+
+22
+23
+24
+
+
# File 'lib/ngrokapi/models/endpoint_rule.rb', line 22
+
+def ==(other)
+  @attrs == other.attrs
+end
+
+
+ +
+

+ + #to_hObject + + + + + +

+ + + + +
+
+
+
+30
+31
+32
+
+
# File 'lib/ngrokapi/models/endpoint_rule.rb', line 30
+
+def to_h
+  @attrs.to_h
+end
+
+
+ +
+

+ + #to_sObject + + + + + +

+ + + + +
+
+
+
+26
+27
+28
+
+
# File 'lib/ngrokapi/models/endpoint_rule.rb', line 26
+
+def to_s
+  @attrs.to_s
+end
+
+
+ +
+ +
+ + + +
+ + \ No newline at end of file diff --git a/doc/NgrokAPI/Models/EndpointSAML.html b/doc/NgrokAPI/Models/EndpointSAML.html index dd4be33..ebda7a3 100644 --- a/doc/NgrokAPI/Models/EndpointSAML.html +++ b/doc/NgrokAPI/Models/EndpointSAML.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointSAML - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -393,35 +393,6 @@

Returns the value of attribute idp_metadata.

- - - -
  • - - - #idp_metadata_url ⇒ Object - - - - - - - - - readonly - - - - - - - - - -
    -

    Returns the value of attribute idp_metadata_url.

    -
    -
  • @@ -765,6 +736,7 @@
     
     
    +28
     29
     30
     31
    @@ -788,14 +760,10 @@
     49
     50
     51
    -52
    -53
    -54
    -55
    -56
    +52 -
    # File 'lib/ngrokapi/models/endpoint_saml.rb', line 29
    +      
    # File 'lib/ngrokapi/models/endpoint_saml.rb', line 28
     
     def initialize(client: nil, attrs: {})
       @client = client
    @@ -805,9 +773,6 @@
       @cookie_prefix = @attrs['cookie_prefix']
       @inactivity_timeout = @attrs['inactivity_timeout']
       @maximum_duration = @attrs['maximum_duration']
    -  unless @attrs['idp_metadata_url'].nil?
    -    @idp_metadata_url = URI(@attrs['idp_metadata_url'])
    -  end
       @idp_metadata = @attrs['idp_metadata']
       @force_authn = @attrs['force_authn']
       @allow_idp_initiated = @attrs['allow_idp_initiated']
    @@ -1266,49 +1231,6 @@
     
         
           
    -      
    -      
    -

    - - #idp_metadata_urlObject (readonly) - - - - - -

    -
    - -

    Returns the value of attribute idp_metadata_url.

    - - -
    -
    -
    - - -
    - - - - -
    -
    -
    -
    -10
    -11
    -12
    -
    -
    # File 'lib/ngrokapi/models/endpoint_saml.rb', line 10
    -
    -def 
    -  @idp_metadata_url
    -end
    -
    -
    - -

    @@ -1631,12 +1553,12 @@
     
     
    -58
    -59
    -60
    +54 +55 +56

    -
    # File 'lib/ngrokapi/models/endpoint_saml.rb', line 58
    +      
    # File 'lib/ngrokapi/models/endpoint_saml.rb', line 54
     
     def ==(other)
       @attrs == other.attrs
    @@ -1661,12 +1583,12 @@
           
     
     
    -66
    -67
    -68
    +62 +63 +64
    -
    # File 'lib/ngrokapi/models/endpoint_saml.rb', line 66
    +      
    # File 'lib/ngrokapi/models/endpoint_saml.rb', line 62
     
     def to_h
       @attrs.to_h
    @@ -1691,12 +1613,12 @@
           
     
     
    -62
    -63
    -64
    +58 +59 +60
    -
    # File 'lib/ngrokapi/models/endpoint_saml.rb', line 62
    +      
    # File 'lib/ngrokapi/models/endpoint_saml.rb', line 58
     
     def to_s
       @attrs.to_s
    @@ -1711,9 +1633,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/EndpointSAMLMutate.html b/doc/NgrokAPI/Models/EndpointSAMLMutate.html
    index 00c7de6..7f394d1 100644
    --- a/doc/NgrokAPI/Models/EndpointSAMLMutate.html
    +++ b/doc/NgrokAPI/Models/EndpointSAMLMutate.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::EndpointSAMLMutate
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -335,35 +335,6 @@
     

    Returns the value of attribute idp_metadata.

    - - - -
  • - - - #idp_metadata_url ⇒ Object - - - - - - - - - readonly - - - - - - - - - -
    -

    Returns the value of attribute idp_metadata_url.

    -
    -
  • @@ -620,6 +591,7 @@
     
     
    +23
     24
     25
     26
    @@ -632,14 +604,10 @@
     33
     34
     35
    -36
    -37
    -38
    -39
    -40
    +36
    -
    # File 'lib/ngrokapi/models/endpoint_saml_mutate.rb', line 24
    +      
    # File 'lib/ngrokapi/models/endpoint_saml_mutate.rb', line 23
     
     def initialize(client: nil, attrs: {})
       @client = client
    @@ -649,9 +617,6 @@
       @cookie_prefix = @attrs['cookie_prefix']
       @inactivity_timeout = @attrs['inactivity_timeout']
       @maximum_duration = @attrs['maximum_duration']
    -  unless @attrs['idp_metadata_url'].nil?
    -    @idp_metadata_url = URI(@attrs['idp_metadata_url'])
    -  end
       @idp_metadata = @attrs['idp_metadata']
       @force_authn = @attrs['force_authn']
       @allow_idp_initiated = @attrs['allow_idp_initiated']
    @@ -1013,49 +978,6 @@
     
         
           
    -      
    -      
    -

    - - #idp_metadata_urlObject (readonly) - - - - - -

    -
    - -

    Returns the value of attribute idp_metadata_url.

    - - -
    -
    -
    - - -
    - - - - -
    -
    -
    -
    -10
    -11
    -12
    -
    -
    # File 'lib/ngrokapi/models/endpoint_saml_mutate.rb', line 10
    -
    -def 
    -  @idp_metadata_url
    -end
    -
    -
    - -

    @@ -1249,12 +1171,12 @@
     
     
    -42
    -43
    -44
    +38 +39 +40

    -
    # File 'lib/ngrokapi/models/endpoint_saml_mutate.rb', line 42
    +      
    # File 'lib/ngrokapi/models/endpoint_saml_mutate.rb', line 38
     
     def ==(other)
       @attrs == other.attrs
    @@ -1279,12 +1201,12 @@
           
     
     
    -50
    -51
    -52
    +46 +47 +48
    -
    # File 'lib/ngrokapi/models/endpoint_saml_mutate.rb', line 50
    +      
    # File 'lib/ngrokapi/models/endpoint_saml_mutate.rb', line 46
     
     def to_h
       @attrs.to_h
    @@ -1309,12 +1231,12 @@
           
     
     
    -46
    -47
    -48
    +42 +43 +44
    -
    # File 'lib/ngrokapi/models/endpoint_saml_mutate.rb', line 46
    +      
    # File 'lib/ngrokapi/models/endpoint_saml_mutate.rb', line 42
     
     def to_s
       @attrs.to_s
    @@ -1329,9 +1251,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/EndpointTLSTermination.html b/doc/NgrokAPI/Models/EndpointTLSTermination.html
    index 459373b..bca1358 100644
    --- a/doc/NgrokAPI/Models/EndpointTLSTermination.html
    +++ b/doc/NgrokAPI/Models/EndpointTLSTermination.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::EndpointTLSTermination
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -733,9 +733,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html b/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html
    index 5b88bd2..de774d1 100644
    --- a/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html
    +++ b/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::EndpointTLSTerminationAtEdge
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -659,9 +659,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/EndpointUserAgentFilter.html b/doc/NgrokAPI/Models/EndpointUserAgentFilter.html
    new file mode 100644
    index 0000000..5634197
    --- /dev/null
    +++ b/doc/NgrokAPI/Models/EndpointUserAgentFilter.html
    @@ -0,0 +1,743 @@
    +
    +
    +  
    +    
    +
    +
    +  Class: NgrokAPI::Models::EndpointUserAgentFilter
    +  
    +    — Documentation by YARD 0.9.36
    +  
    +
    +
    +  
    +
    +  
    +
    +
    +
    +
    +  
    +
    +  
    +
    +
    +  
    +  
    +    
    +
    +    
    + + +

    Class: NgrokAPI::Models::EndpointUserAgentFilter + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/models/endpoint_user_agent_filter.rb
    +
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #allow ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute allow.

      +
      + +
    • + + +
    • + + + #attrs ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute attrs.

      +
      + +
    • + + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    • + + + #deny ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute deny.

      +
      + +
    • + + +
    • + + + #enabled ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute enabled.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client: nil, attrs: {}) ⇒ EndpointUserAgentFilter + + + + + +

    +
    + +

    Returns a new instance of EndpointUserAgentFilter.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +14
    +15
    +16
    +17
    +18
    +19
    +20
    +
    +
    # File 'lib/ngrokapi/models/endpoint_user_agent_filter.rb', line 14
    +
    +def initialize(client: nil, attrs: {})
    +  @client = client
    +  @attrs = attrs
    +  @enabled = @attrs['enabled']
    +  @allow = @attrs['allow']
    +  @deny = @attrs['deny']
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #allowObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute allow.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/endpoint_user_agent_filter.rb', line 8
    +
    +def allow
    +  @allow
    +end
    +
    +
    + + + +
    +

    + + #attrsObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute attrs.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/endpoint_user_agent_filter.rb', line 8
    +
    +def attrs
    +  @attrs
    +end
    +
    +
    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/endpoint_user_agent_filter.rb', line 8
    +
    +def client
    +  @client
    +end
    +
    +
    + + + +
    +

    + + #denyObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute deny.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/endpoint_user_agent_filter.rb', line 8
    +
    +def deny
    +  @deny
    +end
    +
    +
    + + + +
    +

    + + #enabledObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute enabled.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/endpoint_user_agent_filter.rb', line 8
    +
    +def enabled
    +  @enabled
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #==(other) ⇒ Object + + + + + +

    + + + + +
    +
    +
    +
    +22
    +23
    +24
    +
    +
    # File 'lib/ngrokapi/models/endpoint_user_agent_filter.rb', line 22
    +
    +def ==(other)
    +  @attrs == other.attrs
    +end
    +
    +
    + +
    +

    + + #to_hObject + + + + + +

    + + + + +
    +
    +
    +
    +30
    +31
    +32
    +
    +
    # File 'lib/ngrokapi/models/endpoint_user_agent_filter.rb', line 30
    +
    +def to_h
    +  @attrs.to_h
    +end
    +
    +
    + +
    +

    + + #to_sObject + + + + + +

    + + + + +
    +
    +
    +
    +26
    +27
    +28
    +
    +
    # File 'lib/ngrokapi/models/endpoint_user_agent_filter.rb', line 26
    +
    +def to_s
    +  @attrs.to_s
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/doc/NgrokAPI/Models/EndpointWebhookValidation.html b/doc/NgrokAPI/Models/EndpointWebhookValidation.html index 7ff0267..668a6ea 100644 --- a/doc/NgrokAPI/Models/EndpointWebhookValidation.html +++ b/doc/NgrokAPI/Models/EndpointWebhookValidation.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointWebhookValidation - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -733,9 +733,9 @@ diff --git a/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html b/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html index 7935585..4afc4b2 100644 --- a/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +++ b/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointWebsocketTCPConverter - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -585,9 +585,9 @@ diff --git a/doc/NgrokAPI/Models/EventDestination.html b/doc/NgrokAPI/Models/EventDestination.html index 0725692..7681261 100644 --- a/doc/NgrokAPI/Models/EventDestination.html +++ b/doc/NgrokAPI/Models/EventDestination.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EventDestination - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1104,9 +1104,9 @@ diff --git a/doc/NgrokAPI/Models/EventSource.html b/doc/NgrokAPI/Models/EventSource.html index b5e416a..fa202ce 100644 --- a/doc/NgrokAPI/Models/EventSource.html +++ b/doc/NgrokAPI/Models/EventSource.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EventSource - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -161,64 +161,6 @@

    Returns the value of attribute client.

    - - - -
  • - - - #fields ⇒ Object - - - - - - - - - readonly - - - - - - - - - -
    -

    Returns the value of attribute fields.

    -
    - -
  • - - -
  • - - - #filter ⇒ Object - - - - - - - - - readonly - - - - - - - - - -
    -

    Returns the value of attribute filter.

    -
    -
  • @@ -417,26 +359,22 @@
     
     
    +15
    +16
     17
     18
     19
     20
     21
    -22
    -23
    -24
    -25
    -26
    +22
    -
    # File 'lib/ngrokapi/models/event_source.rb', line 17
    +      
    # File 'lib/ngrokapi/models/event_source.rb', line 15
     
     def initialize(client: nil, attrs: {})
       @client = client
       @attrs = attrs
       @type = @attrs['type']
    -  @filter = @attrs['filter']
    -  @fields = @attrs['fields']
       unless @attrs['uri'].nil?
         @uri = URI(@attrs['uri'])
       end
    @@ -538,92 +476,6 @@
     
         
           
    -      
    -      
    -

    - - #fieldsObject (readonly) - - - - - -

    -
    - -

    Returns the value of attribute fields.

    - - -
    -
    -
    - - -
    - - - - -
    -
    -
    -
    -10
    -11
    -12
    -
    -
    # File 'lib/ngrokapi/models/event_source.rb', line 10
    -
    -def fields
    -  @fields
    -end
    -
    -
    - - - -
    -

    - - #filterObject (readonly) - - - - - -

    -
    - -

    Returns the value of attribute filter.

    - - -
    -
    -
    - - -
    - - - - -
    -
    -
    -
    -10
    -11
    -12
    -
    -
    # File 'lib/ngrokapi/models/event_source.rb', line 10
    -
    -def filter
    -  @filter
    -end
    -
    -
    - -

    @@ -731,12 +583,12 @@
     
     
    -28
    -29
    -30
    +24 +25 +26

    -
    # File 'lib/ngrokapi/models/event_source.rb', line 28
    +      
    # File 'lib/ngrokapi/models/event_source.rb', line 24
     
     def ==(other)
       @attrs == other.attrs
    @@ -761,12 +613,12 @@
           
     
     
    -36
    -37
    -38
    +32 +33 +34
    -
    # File 'lib/ngrokapi/models/event_source.rb', line 36
    +      
    # File 'lib/ngrokapi/models/event_source.rb', line 32
     
     def to_h
       @attrs.to_h
    @@ -791,12 +643,12 @@
           
     
     
    -32
    -33
    -34
    +28 +29 +30
    -
    # File 'lib/ngrokapi/models/event_source.rb', line 32
    +      
    # File 'lib/ngrokapi/models/event_source.rb', line 28
     
     def to_s
       @attrs.to_s
    @@ -811,9 +663,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/EventSourceList.html b/doc/NgrokAPI/Models/EventSourceList.html
    index 1fefcca..ca40c34 100644
    --- a/doc/NgrokAPI/Models/EventSourceList.html
    +++ b/doc/NgrokAPI/Models/EventSourceList.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::EventSourceList
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -663,9 +663,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/EventSourceReplace.html b/doc/NgrokAPI/Models/EventSourceReplace.html
    index 1844b86..a369804 100644
    --- a/doc/NgrokAPI/Models/EventSourceReplace.html
    +++ b/doc/NgrokAPI/Models/EventSourceReplace.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::EventSourceReplace
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -161,64 +161,6 @@
     

    Returns the value of attribute client.

    - - - -
  • - - - #fields ⇒ Object - - - - - - - - - readonly - - - - - - - - - -
    -

    Returns the value of attribute fields.

    -
    - -
  • - - -
  • - - - #filter ⇒ Object - - - - - - - - - readonly - - - - - - - - - -
    -

    Returns the value of attribute filter.

    -
    -
  • @@ -388,23 +330,19 @@
     
     
    +12
    +13
     14
     15
    -16
    -17
    -18
    -19
    -20
    +16
    -
    # File 'lib/ngrokapi/models/event_source_replace.rb', line 14
    +      
    # File 'lib/ngrokapi/models/event_source_replace.rb', line 12
     
     def initialize(client: nil, attrs: {})
       @client = client
       @attrs = attrs
       @type = @attrs['type']
    -  @filter = @attrs['filter']
    -  @fields = @attrs['fields']
     end
    @@ -503,92 +441,6 @@ - -
    -

    - - #fieldsObject (readonly) - - - - - -

    -
    - -

    Returns the value of attribute fields.

    - - -
    -
    -
    - - -
    - - - - -
    -
    -
    -
    -8
    -9
    -10
    -
    -
    # File 'lib/ngrokapi/models/event_source_replace.rb', line 8
    -
    -def fields
    -  @fields
    -end
    -
    -
    - - - -
    -

    - - #filterObject (readonly) - - - - - -

    -
    - -

    Returns the value of attribute filter.

    - - -
    -
    -
    - - -
    - - - - -
    -
    -
    -
    -8
    -9
    -10
    -
    -
    # File 'lib/ngrokapi/models/event_source_replace.rb', line 8
    -
    -def filter
    -  @filter
    -end
    -
    -
    - -

    @@ -653,12 +505,12 @@
     
     
    -22
    -23
    -24
    +18 +19 +20

    -
    # File 'lib/ngrokapi/models/event_source_replace.rb', line 22
    +      
    # File 'lib/ngrokapi/models/event_source_replace.rb', line 18
     
     def ==(other)
       @attrs == other.attrs
    @@ -683,12 +535,12 @@
           
     
     
    -30
    -31
    -32
    +26 +27 +28
    -
    # File 'lib/ngrokapi/models/event_source_replace.rb', line 30
    +      
    # File 'lib/ngrokapi/models/event_source_replace.rb', line 26
     
     def to_h
       @attrs.to_h
    @@ -713,12 +565,12 @@
           
     
     
    -26
    -27
    -28
    +22 +23 +24
    -
    # File 'lib/ngrokapi/models/event_source_replace.rb', line 26
    +      
    # File 'lib/ngrokapi/models/event_source_replace.rb', line 22
     
     def to_s
       @attrs.to_s
    @@ -733,9 +585,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/EventSubscription.html b/doc/NgrokAPI/Models/EventSubscription.html
    index ff24b76..1d2a848 100644
    --- a/doc/NgrokAPI/Models/EventSubscription.html
    +++ b/doc/NgrokAPI/Models/EventSubscription.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::EventSubscription
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -1104,9 +1104,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/EventTarget.html b/doc/NgrokAPI/Models/EventTarget.html
    index 158684d..dabe1e2 100644
    --- a/doc/NgrokAPI/Models/EventTarget.html
    +++ b/doc/NgrokAPI/Models/EventTarget.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::EventTarget
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -219,35 +219,6 @@
     

    Returns the value of attribute datadog.

    - - - -
  • - - - #debug ⇒ Object - - - - - - - - - readonly - - - - - - - - - -
    -

    Returns the value of attribute debug.

    -
    -
  • @@ -446,18 +417,17 @@
     
     
    +15
     16
     17
     18
     19
     20
     21
    -22
    -23
    -24
    +22
    -
    # File 'lib/ngrokapi/models/event_target.rb', line 16
    +      
    # File 'lib/ngrokapi/models/event_target.rb', line 15
     
     def initialize(client: nil, attrs: {})
       @client = client
    @@ -465,7 +435,6 @@
       @firehose = @attrs['firehose']
       @kinesis = @attrs['kinesis']
       @cloudwatch_logs = @attrs['cloudwatch_logs']
    -  @debug = @attrs['debug']
       @datadog = @attrs['datadog']
     end
    @@ -651,49 +620,6 @@ - -
    -

    - - #debugObject (readonly) - - - - - -

    -
    - -

    Returns the value of attribute debug.

    - - -
    -
    -
    - - -
    - - - - -
    -
    -
    -
    -8
    -9
    -10
    -
    -
    # File 'lib/ngrokapi/models/event_target.rb', line 8
    -
    -def debug
    -  @debug
    -end
    -
    -
    - -

    @@ -801,12 +727,12 @@
     
     
    -26
    -27
    -28
    +24 +25 +26

    -
    # File 'lib/ngrokapi/models/event_target.rb', line 26
    +      
    # File 'lib/ngrokapi/models/event_target.rb', line 24
     
     def ==(other)
       @attrs == other.attrs
    @@ -831,12 +757,12 @@
           
     
     
    -34
    -35
    -36
    +32 +33 +34
    -
    # File 'lib/ngrokapi/models/event_target.rb', line 34
    +      
    # File 'lib/ngrokapi/models/event_target.rb', line 32
     
     def to_h
       @attrs.to_h
    @@ -861,12 +787,12 @@
           
     
     
    -30
    -31
    -32
    +28 +29 +30
    -
    # File 'lib/ngrokapi/models/event_target.rb', line 30
    +      
    # File 'lib/ngrokapi/models/event_target.rb', line 28
     
     def to_s
       @attrs.to_s
    @@ -881,9 +807,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html b/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html
    index 68f2492..e8430c6 100644
    --- a/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html
    +++ b/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::EventTargetCloudwatchLogs
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -659,9 +659,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/EventTargetDatadog.html b/doc/NgrokAPI/Models/EventTargetDatadog.html
    index a2d2115..37573a0 100644
    --- a/doc/NgrokAPI/Models/EventTargetDatadog.html
    +++ b/doc/NgrokAPI/Models/EventTargetDatadog.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::EventTargetDatadog
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -807,9 +807,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/EventTargetFirehose.html b/doc/NgrokAPI/Models/EventTargetFirehose.html
    index 9257319..9f1d202 100644
    --- a/doc/NgrokAPI/Models/EventTargetFirehose.html
    +++ b/doc/NgrokAPI/Models/EventTargetFirehose.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::EventTargetFirehose
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -659,9 +659,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/EventTargetKinesis.html b/doc/NgrokAPI/Models/EventTargetKinesis.html
    index a5cd8c8..eb4c5de 100644
    --- a/doc/NgrokAPI/Models/EventTargetKinesis.html
    +++ b/doc/NgrokAPI/Models/EventTargetKinesis.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::EventTargetKinesis
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -659,9 +659,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/FailoverBackend.html b/doc/NgrokAPI/Models/FailoverBackend.html
    index ed025b8..4be3f1c 100644
    --- a/doc/NgrokAPI/Models/FailoverBackend.html
    +++ b/doc/NgrokAPI/Models/FailoverBackend.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::FailoverBackend
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -1121,9 +1121,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/HTTPResponseBackend.html b/doc/NgrokAPI/Models/HTTPResponseBackend.html
    index e5b2359..e7bd557 100644
    --- a/doc/NgrokAPI/Models/HTTPResponseBackend.html
    +++ b/doc/NgrokAPI/Models/HTTPResponseBackend.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::HTTPResponseBackend
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -1277,9 +1277,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/HTTPSEdge.html b/doc/NgrokAPI/Models/HTTPSEdge.html
    index 44f2ee8..8b1b3fa 100644
    --- a/doc/NgrokAPI/Models/HTTPSEdge.html
    +++ b/doc/NgrokAPI/Models/HTTPSEdge.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::HTTPSEdge
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -1355,9 +1355,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/HTTPSEdgeRoute.html b/doc/NgrokAPI/Models/HTTPSEdgeRoute.html
    index 8137f31..8931a3c 100644
    --- a/doc/NgrokAPI/Models/HTTPSEdgeRoute.html
    +++ b/doc/NgrokAPI/Models/HTTPSEdgeRoute.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::HTTPSEdgeRoute
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -538,6 +538,35 @@
     

    Returns the value of attribute oidc.

    + + + +
  • + + + #policy ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
    +

    Returns the value of attribute policy.

    +
    +
  • @@ -654,6 +683,35 @@

    Returns the value of attribute uri.

    + + + +
  • + + + #user_agent_filter ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
    +

    Returns the value of attribute user_agent_filter.

    +
    +
  • @@ -847,7 +905,7 @@
  • - #update(match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ Object + #update(match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil) ⇒ Object @@ -900,8 +958,6 @@
     
     
    -32
    -33
     34
     35
     36
    @@ -924,10 +980,14 @@
     53
     54
     55
    -56
    +56 +57 +58 +59 +60
  • -
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 32
    +      
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 34
     
     def initialize(client: nil, attrs: {})
       @client = client
    @@ -953,6 +1013,8 @@
       @saml = @attrs['saml']
       @oidc = @attrs['oidc']
       @websocket_tcp_converter = @attrs['websocket_tcp_converter']
    +  @user_agent_filter = @attrs['user_agent_filter']
    +  @policy = @attrs['policy']
     end
    @@ -1610,6 +1672,49 @@ + +
    +

    + + #policyObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute policy.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 10
    +
    +def policy
    +  @policy
    +end
    +
    +
    + +

    @@ -1782,6 +1887,49 @@

    + +
    +

    + + #user_agent_filterObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute user_agent_filter.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 10
    +
    +def user_agent_filter
    +  @user_agent_filter
    +end
    +
    +
    + +

    @@ -1889,12 +2037,12 @@
     
     
    -58
    -59
    -60
    +62 +63 +64

    -
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 58
    +      
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 62
     
     def ==(other)
       @attrs == other.attrs
    @@ -1932,16 +2080,16 @@
           
     
     
    -134
    -135
    -136
    -137
    -138
    -139
    -140
    +144 +145 +146 +147 +148 +149 +150
    -
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 134
    +      
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 144
     
     def delete(
     )
    @@ -1970,12 +2118,12 @@
           
     
     
    -66
    -67
    -68
    +70 +71 +72
    -
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 66
    +      
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 70
     
     def to_h
       @attrs.to_h
    @@ -2000,12 +2148,12 @@
           
     
     
    -62
    -63
    -64
    +66 +67 +68
    -
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 62
    +      
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 66
     
     def to_s
       @attrs.to_s
    @@ -2018,7 +2166,7 @@
           

    - #update(match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ Object + #update(match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil) ⇒ Object @@ -2043,10 +2191,6 @@
     
     
    -77
    -78
    -79
    -80
     81
     82
     83
    @@ -2094,10 +2238,20 @@
     125
     126
     127
    -128
    +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138

    -
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 77
    +      
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 81
     
     def update(
       match_type: "",
    @@ -2114,7 +2268,9 @@
       oauth: nil,
       saml: nil,
       oidc: nil,
    -  websocket_tcp_converter: nil
    +  websocket_tcp_converter: nil,
    +  user_agent_filter: nil,
    +  policy: nil
     )
       @match_type = match_type if match_type
       @match = match if match
    @@ -2131,6 +2287,8 @@
       @saml = saml if saml
       @oidc = oidc if oidc
       @websocket_tcp_converter = websocket_tcp_converter if websocket_tcp_converter
    +  @user_agent_filter = user_agent_filter if user_agent_filter
    +  @policy = policy if policy
       @client.update(
         edge_id: @edge_id,
         id: @id,
    @@ -2148,7 +2306,9 @@
         oauth: oauth,
         saml: saml,
         oidc: oidc,
    -    websocket_tcp_converter: websocket_tcp_converter
    +    websocket_tcp_converter: websocket_tcp_converter,
    +    user_agent_filter: user_agent_filter,
    +    policy: policy
       )
     end
    @@ -2161,9 +2321,9 @@ diff --git a/doc/NgrokAPI/Models/IPPolicy.html b/doc/NgrokAPI/Models/IPPolicy.html index fc520ec..d7b1483 100644 --- a/doc/NgrokAPI/Models/IPPolicy.html +++ b/doc/NgrokAPI/Models/IPPolicy.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::IPPolicy - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -106,35 +106,6 @@

    Instance Attribute Summary collapse

      -
    • - - - #action ⇒ Object - - - - - - - - - readonly - - - - - - - - - -
      -

      Returns the value of attribute action.

      -
      - -
    • - -
    • @@ -523,6 +494,7 @@
       
       
      +18
       19
       20
       21
      @@ -532,12 +504,10 @@
       25
       26
       27
      -28
      -29
      -30
      +28
    -
    # File 'lib/ngrokapi/models/ip_policy.rb', line 19
    +      
    # File 'lib/ngrokapi/models/ip_policy.rb', line 18
     
     def initialize(client: nil, attrs: {})
       @client = client
    @@ -549,7 +519,6 @@
       @created_at = @attrs['created_at']
       @description = @attrs['description']
       @metadata = @attrs['metadata']
    -  @action = @attrs['action']
     end
    @@ -564,50 +533,7 @@
    -

    - - #actionObject (readonly) - - - - - -

    -
    - -

    Returns the value of attribute action.

    - - -
    -
    -
    - - -
    - - - - -
    -
    -
    -
    -10
    -11
    -12
    -
    -
    # File 'lib/ngrokapi/models/ip_policy.rb', line 10
    -
    -def action
    -  @action
    -end
    -
    -
    - - - -
    -

    +

    #attrsObject (readonly) @@ -927,12 +853,12 @@
     
     
    -32
    -33
    -34
    +30 +31 +32

    -
    # File 'lib/ngrokapi/models/ip_policy.rb', line 32
    +      
    # File 'lib/ngrokapi/models/ip_policy.rb', line 30
     
     def ==(other)
       @attrs == other.attrs
    @@ -970,14 +896,14 @@
           
     
     
    +48
    +49
     50
     51
    -52
    -53
    -54
    +52
    -
    # File 'lib/ngrokapi/models/ip_policy.rb', line 50
    +      
    # File 'lib/ngrokapi/models/ip_policy.rb', line 48
     
     def delete
       @client.delete(
    @@ -1004,12 +930,12 @@
           
     
     
    -40
    -41
    -42
    +38 +39 +40
    -
    # File 'lib/ngrokapi/models/ip_policy.rb', line 40
    +      
    # File 'lib/ngrokapi/models/ip_policy.rb', line 38
     
     def to_h
       @attrs.to_h
    @@ -1034,12 +960,12 @@
           
     
     
    -36
    -37
    -38
    +34 +35 +36
    -
    # File 'lib/ngrokapi/models/ip_policy.rb', line 36
    +      
    # File 'lib/ngrokapi/models/ip_policy.rb', line 34
     
     def to_s
       @attrs.to_s
    @@ -1077,6 +1003,8 @@
           
     
     
    +58
    +59
     60
     61
     62
    @@ -1086,12 +1014,10 @@
     66
     67
     68
    -69
    -70
    -71
    +69
    -
    # File 'lib/ngrokapi/models/ip_policy.rb', line 60
    +      
    # File 'lib/ngrokapi/models/ip_policy.rb', line 58
     
     def update(
       description: nil,
    @@ -1115,9 +1041,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/IPPolicyRule.html b/doc/NgrokAPI/Models/IPPolicyRule.html
    index 53380dc..da87ed7 100644
    --- a/doc/NgrokAPI/Models/IPPolicyRule.html
    +++ b/doc/NgrokAPI/Models/IPPolicyRule.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::IPPolicyRule
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -1269,9 +1269,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/IPRestriction.html b/doc/NgrokAPI/Models/IPRestriction.html
    index 7ea708a..3dac825 100644
    --- a/doc/NgrokAPI/Models/IPRestriction.html
    +++ b/doc/NgrokAPI/Models/IPRestriction.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::IPRestriction
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -1178,9 +1178,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/IdentityProvider.html b/doc/NgrokAPI/Models/IdentityProvider.html
    index 1ea0ba7..e64a411 100644
    --- a/doc/NgrokAPI/Models/IdentityProvider.html
    +++ b/doc/NgrokAPI/Models/IdentityProvider.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::IdentityProvider
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -659,9 +659,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/Listable.html b/doc/NgrokAPI/Models/Listable.html
    index 28b081b..231272f 100644
    --- a/doc/NgrokAPI/Models/Listable.html
    +++ b/doc/NgrokAPI/Models/Listable.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::Listable
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -992,9 +992,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/Location.html b/doc/NgrokAPI/Models/Location.html
    index 5c84972..3f31036 100644
    --- a/doc/NgrokAPI/Models/Location.html
    +++ b/doc/NgrokAPI/Models/Location.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::Location
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -807,9 +807,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/Ref.html b/doc/NgrokAPI/Models/Ref.html
    index ed58e76..95eeaab 100644
    --- a/doc/NgrokAPI/Models/Ref.html
    +++ b/doc/NgrokAPI/Models/Ref.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::Ref
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -663,9 +663,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/ReservedAddr.html b/doc/NgrokAPI/Models/ReservedAddr.html
    index 4fbeba2..093eee3 100644
    --- a/doc/NgrokAPI/Models/ReservedAddr.html
    +++ b/doc/NgrokAPI/Models/ReservedAddr.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::ReservedAddr
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -248,35 +248,6 @@
     

    Returns the value of attribute description.

    - - - -
  • - - - #endpoint_configuration ⇒ Object - - - - - - - - - readonly - - - - - - - - - -
    -

    Returns the value of attribute endpoint_configuration.

    -
    -
  • @@ -557,6 +528,7 @@
     
     
    +20
     21
     22
     23
    @@ -568,12 +540,10 @@
     29
     30
     31
    -32
    -33
    -34
    +32
    -
    # File 'lib/ngrokapi/models/reserved_addr.rb', line 21
    +      
    # File 'lib/ngrokapi/models/reserved_addr.rb', line 20
     
     def initialize(client: nil, attrs: {})
       @client = client
    @@ -587,7 +557,6 @@
       @metadata = @attrs['metadata']
       @addr = @attrs['addr']
       @region = @attrs['region']
    -  @endpoint_configuration = @attrs['endpoint_configuration']
     end
    @@ -815,49 +784,6 @@ - -
    -

    - - #endpoint_configurationObject (readonly) - - - - - -

    -
    - -

    Returns the value of attribute endpoint_configuration.

    - - -
    -
    -
    - - -
    - - - - -
    -
    -
    -
    -10
    -11
    -12
    -
    -
    # File 'lib/ngrokapi/models/reserved_addr.rb', line 10
    -
    -def endpoint_configuration
    -  @endpoint_configuration
    -end
    -
    -
    - -

    @@ -1051,12 +977,12 @@
     
     
    -36
    -37
    -38
    +34 +35 +36

    -
    # File 'lib/ngrokapi/models/reserved_addr.rb', line 36
    +      
    # File 'lib/ngrokapi/models/reserved_addr.rb', line 34
     
     def ==(other)
       @attrs == other.attrs
    @@ -1094,14 +1020,14 @@
           
     
     
    +50
    +51
     52
     53
    -54
    -55
    -56
    +54
    -
    # File 'lib/ngrokapi/models/reserved_addr.rb', line 52
    +      
    # File 'lib/ngrokapi/models/reserved_addr.rb', line 50
     
     def delete
       @client.delete(
    @@ -1128,12 +1054,12 @@
           
     
     
    -44
    -45
    -46
    +42 +43 +44
    -
    # File 'lib/ngrokapi/models/reserved_addr.rb', line 44
    +      
    # File 'lib/ngrokapi/models/reserved_addr.rb', line 42
     
     def to_h
       @attrs.to_h
    @@ -1158,12 +1084,12 @@
           
     
     
    -40
    -41
    -42
    +38 +39 +40
    -
    # File 'lib/ngrokapi/models/reserved_addr.rb', line 40
    +      
    # File 'lib/ngrokapi/models/reserved_addr.rb', line 38
     
     def to_s
       @attrs.to_s
    @@ -1178,9 +1104,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/ReservedDomain.html b/doc/NgrokAPI/Models/ReservedDomain.html
    index d754779..551b368 100644
    --- a/doc/NgrokAPI/Models/ReservedDomain.html
    +++ b/doc/NgrokAPI/Models/ReservedDomain.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::ReservedDomain
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -393,64 +393,6 @@
     

    Returns the value of attribute domain.

    - - - -
  • - - - #http_endpoint_configuration ⇒ Object - - - - - - - - - readonly - - - - - - - - - -
    -

    Returns the value of attribute http_endpoint_configuration.

    -
    - -
  • - - -
  • - - - #https_endpoint_configuration ⇒ Object - - - - - - - - - readonly - - - - - - - - - -
    -

    Returns the value of attribute https_endpoint_configuration.

    -
    -
  • @@ -731,6 +673,8 @@
     
     
    +25
    +26
     27
     28
     29
    @@ -746,14 +690,10 @@
     39
     40
     41
    -42
    -43
    -44
    -45
    -46
    +42
    -
    # File 'lib/ngrokapi/models/reserved_domain.rb', line 27
    +      
    # File 'lib/ngrokapi/models/reserved_domain.rb', line 25
     
     def initialize(client: nil, attrs: {})
       @client = client
    @@ -768,8 +708,6 @@
       @domain = @attrs['domain']
       @region = @attrs['region']
       @cname_target = @attrs['cname_target']
    -  @http_endpoint_configuration = @attrs['http_endpoint_configuration']
    -  @https_endpoint_configuration = @attrs['https_endpoint_configuration']
       @certificate = @attrs['certificate']
       @certificate_management_policy = @attrs['certificate_management_policy']
       @certificate_management_status = @attrs['certificate_management_status']
    @@ -1216,92 +1154,6 @@
     
         
           
    -      
    -      
    -

    - - #http_endpoint_configurationObject (readonly) - - - - - -

    -
    - -

    Returns the value of attribute http_endpoint_configuration.

    - - -
    -
    -
    - - -
    - - - - -
    -
    -
    -
    -10
    -11
    -12
    -
    -
    # File 'lib/ngrokapi/models/reserved_domain.rb', line 10
    -
    -def http_endpoint_configuration
    -  @http_endpoint_configuration
    -end
    -
    -
    - - - -
    -

    - - #https_endpoint_configurationObject (readonly) - - - - - -

    -
    - -

    Returns the value of attribute https_endpoint_configuration.

    - - -
    -
    -
    - - -
    - - - - -
    -
    -
    -
    -10
    -11
    -12
    -
    -
    # File 'lib/ngrokapi/models/reserved_domain.rb', line 10
    -
    -def https_endpoint_configuration
    -  @https_endpoint_configuration
    -end
    -
    -
    - -

    @@ -1495,12 +1347,12 @@
     
     
    -48
    -49
    -50
    +44 +45 +46

    -
    # File 'lib/ngrokapi/models/reserved_domain.rb', line 48
    +      
    # File 'lib/ngrokapi/models/reserved_domain.rb', line 44
     
     def ==(other)
       @attrs == other.attrs
    @@ -1538,14 +1390,14 @@
           
     
     
    -64
    -65
    -66
    -67
    -68
    +60 +61 +62 +63 +64
    -
    # File 'lib/ngrokapi/models/reserved_domain.rb', line 64
    +      
    # File 'lib/ngrokapi/models/reserved_domain.rb', line 60
     
     def delete
       @client.delete(
    @@ -1572,12 +1424,12 @@
           
     
     
    -56
    -57
    -58
    +52 +53 +54
    -
    # File 'lib/ngrokapi/models/reserved_domain.rb', line 56
    +      
    # File 'lib/ngrokapi/models/reserved_domain.rb', line 52
     
     def to_h
       @attrs.to_h
    @@ -1602,12 +1454,12 @@
           
     
     
    -52
    -53
    -54
    +48 +49 +50
    -
    # File 'lib/ngrokapi/models/reserved_domain.rb', line 52
    +      
    # File 'lib/ngrokapi/models/reserved_domain.rb', line 48
     
     def to_s
       @attrs.to_s
    @@ -1622,9 +1474,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/ReservedDomainCertJob.html b/doc/NgrokAPI/Models/ReservedDomainCertJob.html
    index 1f97431..6bc9bdf 100644
    --- a/doc/NgrokAPI/Models/ReservedDomainCertJob.html
    +++ b/doc/NgrokAPI/Models/ReservedDomainCertJob.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::ReservedDomainCertJob
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -807,9 +807,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html b/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html
    index 1a37f6e..6d9bd81 100644
    --- a/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html
    +++ b/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::ReservedDomainCertPolicy
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -659,9 +659,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/ReservedDomainCertStatus.html b/doc/NgrokAPI/Models/ReservedDomainCertStatus.html
    index 884ed4e..7e63978 100644
    --- a/doc/NgrokAPI/Models/ReservedDomainCertStatus.html
    +++ b/doc/NgrokAPI/Models/ReservedDomainCertStatus.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::ReservedDomainCertStatus
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -659,9 +659,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/SSHCertificateAuthority.html b/doc/NgrokAPI/Models/SSHCertificateAuthority.html
    index 3612b04..077a1bb 100644
    --- a/doc/NgrokAPI/Models/SSHCertificateAuthority.html
    +++ b/doc/NgrokAPI/Models/SSHCertificateAuthority.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::SSHCertificateAuthority
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -1189,9 +1189,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/SSHCredential.html b/doc/NgrokAPI/Models/SSHCredential.html
    index 60f6e27..b222200 100644
    --- a/doc/NgrokAPI/Models/SSHCredential.html
    +++ b/doc/NgrokAPI/Models/SSHCredential.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::SSHCredential
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -1269,9 +1269,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/SSHHostCertificate.html b/doc/NgrokAPI/Models/SSHHostCertificate.html
    index c58955c..ac854f5 100644
    --- a/doc/NgrokAPI/Models/SSHHostCertificate.html
    +++ b/doc/NgrokAPI/Models/SSHHostCertificate.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::SSHHostCertificate
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -1559,9 +1559,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/SSHUserCertificate.html b/doc/NgrokAPI/Models/SSHUserCertificate.html
    index f0b1b2d..05f7abf 100644
    --- a/doc/NgrokAPI/Models/SSHUserCertificate.html
    +++ b/doc/NgrokAPI/Models/SSHUserCertificate.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::SSHUserCertificate
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -1707,9 +1707,9 @@
     
     
           
     
         
    diff --git a/doc/NgrokAPI/Models/StaticBackend.html b/doc/NgrokAPI/Models/StaticBackend.html
    new file mode 100644
    index 0000000..fde0ca1
    --- /dev/null
    +++ b/doc/NgrokAPI/Models/StaticBackend.html
    @@ -0,0 +1,1211 @@
    +
    +
    +  
    +    
    +
    +
    +  Class: NgrokAPI::Models::StaticBackend
    +  
    +    — Documentation by YARD 0.9.36
    +  
    +
    +
    +  
    +
    +  
    +
    +
    +
    +
    +  
    +
    +  
    +
    +
    +  
    +  
    +    
    +
    +    
    + + +

    Class: NgrokAPI::Models::StaticBackend + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/models/static_backend.rb
    +
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #address ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute address.

      +
      + +
    • + + +
    • + + + #attrs ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute attrs.

      +
      + +
    • + + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    • + + + #created_at ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute created_at.

      +
      + +
    • + + +
    • + + + #description ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute description.

      +
      + +
    • + + +
    • + + + #id ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute id.

      +
      + +
    • + + +
    • + + + #metadata ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute metadata.

      +
      + +
    • + + +
    • + + + #tls ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute tls.

      +
      + +
    • + + +
    • + + + #uri ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute uri.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client: nil, attrs: {}) ⇒ StaticBackend + + + + + +

    +
    + +

    Returns a new instance of StaticBackend.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +20
    +21
    +22
    +23
    +24
    +25
    +26
    +27
    +28
    +29
    +30
    +31
    +32
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 20
    +
    +def initialize(client: nil, attrs: {})
    +  @client = client
    +  @attrs = attrs
    +  @id = @attrs['id']
    +  unless @attrs['uri'].nil?
    +    @uri = URI(@attrs['uri'])
    +  end
    +  @created_at = @attrs['created_at']
    +  @description = @attrs['description']
    +  @metadata = @attrs['metadata']
    +  @address = @attrs['address']
    +  @tls = @attrs['tls']
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #addressObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute address.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 10
    +
    +def address
    +  @address
    +end
    +
    +
    + + + +
    +

    + + #attrsObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute attrs.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 10
    +
    +def attrs
    +  @attrs
    +end
    +
    +
    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 10
    +
    +def client
    +  @client
    +end
    +
    +
    + + + +
    +

    + + #created_atObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute created_at.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 10
    +
    +def created_at
    +  @created_at
    +end
    +
    +
    + + + +
    +

    + + #descriptionObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute description.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 10
    +
    +def description
    +  @description
    +end
    +
    +
    + + + +
    +

    + + #idObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute id.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 10
    +
    +def id
    +  @id
    +end
    +
    +
    + + + +
    +

    + + #metadataObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute metadata.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 10
    +
    +def 
    +  @metadata
    +end
    +
    +
    + + + +
    +

    + + #tlsObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute tls.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 10
    +
    +def tls
    +  @tls
    +end
    +
    +
    + + + +
    +

    + + #uriObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute uri.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 10
    +
    +def uri
    +  @uri
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #==(other) ⇒ Object + + + + + +

    + + + + +
    +
    +
    +
    +34
    +35
    +36
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 34
    +
    +def ==(other)
    +  @attrs == other.attrs
    +end
    +
    +
    + +
    +

    + + #deleteObject + + + + + +

    +
    + +

    Delete a static backend by ID.

    + +

    ngrok.com/docs/api#api-static-backends-delete

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +50
    +51
    +52
    +53
    +54
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 50
    +
    +def delete
    +  @client.delete(
    +    id: @id
    +  )
    +end
    +
    +
    + +
    +

    + + #to_hObject + + + + + +

    + + + + +
    +
    +
    +
    +42
    +43
    +44
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 42
    +
    +def to_h
    +  @attrs.to_h
    +end
    +
    +
    + +
    +

    + + #to_sObject + + + + + +

    + + + + +
    +
    +
    +
    +38
    +39
    +40
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 38
    +
    +def to_s
    +  @attrs.to_s
    +end
    +
    +
    + +
    +

    + + #update(description: nil, metadata: nil, address: "", tls: nil) ⇒ Object + + + + + +

    +
    + +

    Update static backend by ID

    + +

    ngrok.com/docs/api#api-static-backends-update

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +60
    +61
    +62
    +63
    +64
    +65
    +66
    +67
    +68
    +69
    +70
    +71
    +72
    +73
    +74
    +75
    +76
    +77
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 60
    +
    +def update(
    +  description: nil,
    +  metadata: nil,
    +  address: "",
    +  tls: nil
    +)
    +  @description = description if description
    +  @metadata =  if 
    +  @address = address if address
    +  @tls = tls if tls
    +  @client.update(
    +    id: @id,
    +    description: description,
    +    metadata: ,
    +    address: address,
    +    tls: tls
    +  )
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/doc/NgrokAPI/Models/StaticBackendTLS.html b/doc/NgrokAPI/Models/StaticBackendTLS.html new file mode 100644 index 0000000..ab32079 --- /dev/null +++ b/doc/NgrokAPI/Models/StaticBackendTLS.html @@ -0,0 +1,595 @@ + + + + + + + Class: NgrokAPI::Models::StaticBackendTLS + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: NgrokAPI::Models::StaticBackendTLS + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/models/static_backend_tls.rb
    +
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #attrs ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute attrs.

      +
      + +
    • + + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    • + + + #enabled ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute enabled.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client: nil, attrs: {}) ⇒ StaticBackendTLS + + + + + +

    +
    + +

    Returns a new instance of StaticBackendTLS.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +12
    +13
    +14
    +15
    +16
    +
    +
    # File 'lib/ngrokapi/models/static_backend_tls.rb', line 12
    +
    +def initialize(client: nil, attrs: {})
    +  @client = client
    +  @attrs = attrs
    +  @enabled = @attrs['enabled']
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #attrsObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute attrs.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/static_backend_tls.rb', line 8
    +
    +def attrs
    +  @attrs
    +end
    +
    +
    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/static_backend_tls.rb', line 8
    +
    +def client
    +  @client
    +end
    +
    +
    + + + +
    +

    + + #enabledObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute enabled.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/static_backend_tls.rb', line 8
    +
    +def enabled
    +  @enabled
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #==(other) ⇒ Object + + + + + +

    + + + + +
    +
    +
    +
    +18
    +19
    +20
    +
    +
    # File 'lib/ngrokapi/models/static_backend_tls.rb', line 18
    +
    +def ==(other)
    +  @attrs == other.attrs
    +end
    +
    +
    + +
    +

    + + #to_hObject + + + + + +

    + + + + +
    +
    +
    +
    +26
    +27
    +28
    +
    +
    # File 'lib/ngrokapi/models/static_backend_tls.rb', line 26
    +
    +def to_h
    +  @attrs.to_h
    +end
    +
    +
    + +
    +

    + + #to_sObject + + + + + +

    + + + + +
    +
    +
    +
    +22
    +23
    +24
    +
    +
    # File 'lib/ngrokapi/models/static_backend_tls.rb', line 22
    +
    +def to_s
    +  @attrs.to_s
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/doc/NgrokAPI/Models/TCPEdge.html b/doc/NgrokAPI/Models/TCPEdge.html index 0ac6a9a..71c09b4 100644 --- a/doc/NgrokAPI/Models/TCPEdge.html +++ b/doc/NgrokAPI/Models/TCPEdge.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::TCPEdge - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -364,6 +364,35 @@

    Returns the value of attribute metadata.

    + + + +
  • + + + #policy ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
    +

    Returns the value of attribute policy.

    +
    +
  • @@ -528,7 +557,7 @@
  • - #update(description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil) ⇒ Object + #update(description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, policy: nil) ⇒ Object @@ -581,7 +610,6 @@
     
     
    -21
     22
     23
     24
    @@ -594,10 +622,12 @@
     31
     32
     33
    -34
    +34 +35 +36
  • -
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 21
    +      
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 22
     
     def initialize(client: nil, attrs: {})
       @client = client
    @@ -612,6 +642,7 @@
       @hostports = @attrs['hostports']
       @backend = @attrs['backend']
       @ip_restriction = @attrs['ip_restriction']
    +  @policy = @attrs['policy']
     end
    @@ -1011,6 +1042,49 @@ + +
    +

    + + #policyObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute policy.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 10
    +
    +def policy
    +  @policy
    +end
    +
    +
    + +

    @@ -1075,12 +1149,12 @@
     
     
    -36
    -37
    -38
    +38 +39 +40

    -
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 36
    +      
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 38
     
     def ==(other)
       @attrs == other.attrs
    @@ -1118,14 +1192,14 @@
           
     
     
    -81
    -82
    -83
    -84
    -85
    +86 +87 +88 +89 +90
    -
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 81
    +      
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 86
     
     def delete
       @client.delete(
    @@ -1152,12 +1226,12 @@
           
     
     
    -44
    -45
    -46
    +46 +47 +48
    -
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 44
    +      
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 46
     
     def to_h
       @attrs.to_h
    @@ -1182,12 +1256,12 @@
           
     
     
    -40
    -41
    -42
    +42 +43 +44
    -
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 40
    +      
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 42
     
     def to_s
       @attrs.to_s
    @@ -1200,7 +1274,7 @@
           

    - #update(description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil) ⇒ Object + #update(description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, policy: nil) ⇒ Object @@ -1225,8 +1299,6 @@
     
     
    -55
    -56
     57
     58
     59
    @@ -1245,30 +1317,38 @@
     72
     73
     74
    -75
    +75 +76 +77 +78 +79 +80

    -
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 55
    +      
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 57
     
     def update(
       description: nil,
       metadata: nil,
       hostports: nil,
       backend: nil,
    -  ip_restriction: nil
    +  ip_restriction: nil,
    +  policy: nil
     )
       @description = description if description
       @metadata =  if 
       @hostports = hostports if hostports
       @backend = backend if backend
       @ip_restriction = ip_restriction if ip_restriction
    +  @policy = policy if policy
       @client.update(
         id: @id,
         description: description,
         metadata: ,
         hostports: hostports,
         backend: backend,
    -    ip_restriction: ip_restriction
    +    ip_restriction: ip_restriction,
    +    policy: policy
       )
     end
    @@ -1281,9 +1361,9 @@ diff --git a/doc/NgrokAPI/Models/TLSCertificate.html b/doc/NgrokAPI/Models/TLSCertificate.html index f70e6ec..d6b18b4 100644 --- a/doc/NgrokAPI/Models/TLSCertificate.html +++ b/doc/NgrokAPI/Models/TLSCertificate.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::TLSCertificate - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -2225,9 +2225,9 @@ diff --git a/doc/NgrokAPI/Models/TLSCertificateSANs.html b/doc/NgrokAPI/Models/TLSCertificateSANs.html index 37853e5..661a388 100644 --- a/doc/NgrokAPI/Models/TLSCertificateSANs.html +++ b/doc/NgrokAPI/Models/TLSCertificateSANs.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::TLSCertificateSANs - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -659,9 +659,9 @@ diff --git a/doc/NgrokAPI/Models/TLSEdge.html b/doc/NgrokAPI/Models/TLSEdge.html index 2ef88f6..b77b57d 100644 --- a/doc/NgrokAPI/Models/TLSEdge.html +++ b/doc/NgrokAPI/Models/TLSEdge.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::TLSEdge - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -393,6 +393,35 @@

    Returns the value of attribute mutual_tls.

    + + + +
  • + + + #policy ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
    +

    Returns the value of attribute policy.

    +
    +
  • @@ -586,7 +615,7 @@
  • - #update(description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) ⇒ Object + #update(description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil) ⇒ Object @@ -639,7 +668,6 @@
     
     
    -23
     24
     25
     26
    @@ -654,10 +682,12 @@
     35
     36
     37
    -38
    +38 +39 +40
  • -
    # File 'lib/ngrokapi/models/tls_edge.rb', line 23
    +      
    # File 'lib/ngrokapi/models/tls_edge.rb', line 24
     
     def initialize(client: nil, attrs: {})
       @client = client
    @@ -674,6 +704,7 @@
       @ip_restriction = @attrs['ip_restriction']
       @mutual_tls = @attrs['mutual_tls']
       @tls_termination = @attrs['tls_termination']
    +  @policy = @attrs['policy']
     end
    @@ -1116,6 +1147,49 @@ + +
    +

    + + #policyObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute policy.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/tls_edge.rb', line 10
    +
    +def policy
    +  @policy
    +end
    +
    +
    + +

    @@ -1223,12 +1297,12 @@
     
     
    -40
    -41
    -42
    +42 +43 +44

    -
    # File 'lib/ngrokapi/models/tls_edge.rb', line 40
    +      
    # File 'lib/ngrokapi/models/tls_edge.rb', line 42
     
     def ==(other)
       @attrs == other.attrs
    @@ -1266,14 +1340,14 @@
           
     
     
    -91
    -92
    -93
    -94
    -95
    +96 +97 +98 +99 +100
    -
    # File 'lib/ngrokapi/models/tls_edge.rb', line 91
    +      
    # File 'lib/ngrokapi/models/tls_edge.rb', line 96
     
     def delete
       @client.delete(
    @@ -1300,12 +1374,12 @@
           
     
     
    -48
    -49
    -50
    +50 +51 +52
    -
    # File 'lib/ngrokapi/models/tls_edge.rb', line 48
    +      
    # File 'lib/ngrokapi/models/tls_edge.rb', line 50
     
     def to_h
       @attrs.to_h
    @@ -1330,12 +1404,12 @@
           
     
     
    -44
    -45
    -46
    +46 +47 +48
    -
    # File 'lib/ngrokapi/models/tls_edge.rb', line 44
    +      
    # File 'lib/ngrokapi/models/tls_edge.rb', line 46
     
     def to_s
       @attrs.to_s
    @@ -1348,7 +1422,7 @@
           

    - #update(description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) ⇒ Object + #update(description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil) ⇒ Object @@ -1373,8 +1447,6 @@
     
     
    -59
    -60
     61
     62
     63
    @@ -1399,10 +1471,15 @@
     82
     83
     84
    -85
    +85 +86 +87 +88 +89 +90

    -
    # File 'lib/ngrokapi/models/tls_edge.rb', line 59
    +      
    # File 'lib/ngrokapi/models/tls_edge.rb', line 61
     
     def update(
       description: nil,
    @@ -1411,7 +1488,8 @@
       backend: nil,
       ip_restriction: nil,
       mutual_tls: nil,
    -  tls_termination: nil
    +  tls_termination: nil,
    +  policy: nil
     )
       @description = description if description
       @metadata =  if 
    @@ -1420,6 +1498,7 @@
       @ip_restriction = ip_restriction if ip_restriction
       @mutual_tls = mutual_tls if mutual_tls
       @tls_termination = tls_termination if tls_termination
    +  @policy = policy if policy
       @client.update(
         id: @id,
         description: description,
    @@ -1428,7 +1507,8 @@
         backend: backend,
         ip_restriction: ip_restriction,
         mutual_tls: mutual_tls,
    -    tls_termination: tls_termination
    +    tls_termination: tls_termination,
    +    policy: policy
       )
     end
    @@ -1441,9 +1521,9 @@ diff --git a/doc/NgrokAPI/Models/Tunnel.html b/doc/NgrokAPI/Models/Tunnel.html index 868bf13..31cc9db 100644 --- a/doc/NgrokAPI/Models/Tunnel.html +++ b/doc/NgrokAPI/Models/Tunnel.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::Tunnel - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1329,9 +1329,9 @@ diff --git a/doc/NgrokAPI/Models/TunnelGroupBackend.html b/doc/NgrokAPI/Models/TunnelGroupBackend.html index 8b3b67e..ea66422 100644 --- a/doc/NgrokAPI/Models/TunnelGroupBackend.html +++ b/doc/NgrokAPI/Models/TunnelGroupBackend.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::TunnelGroupBackend - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1195,9 +1195,9 @@ diff --git a/doc/NgrokAPI/Models/TunnelSession.html b/doc/NgrokAPI/Models/TunnelSession.html index 15ae96c..8e0fd7c 100644 --- a/doc/NgrokAPI/Models/TunnelSession.html +++ b/doc/NgrokAPI/Models/TunnelSession.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::TunnelSession - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1255,9 +1255,9 @@ diff --git a/doc/NgrokAPI/Models/UserAgent.html b/doc/NgrokAPI/Models/UserAgent.html index 4d41c05..b50beb4 100644 --- a/doc/NgrokAPI/Models/UserAgent.html +++ b/doc/NgrokAPI/Models/UserAgent.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::UserAgent - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -955,9 +955,9 @@ diff --git a/doc/NgrokAPI/Models/WeightedBackend.html b/doc/NgrokAPI/Models/WeightedBackend.html index 3417777..ecdc35a 100644 --- a/doc/NgrokAPI/Models/WeightedBackend.html +++ b/doc/NgrokAPI/Models/WeightedBackend.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::WeightedBackend - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1121,9 +1121,9 @@ diff --git a/doc/NgrokAPI/PagedIterator.html b/doc/NgrokAPI/PagedIterator.html index d4dc750..f7e82b0 100644 --- a/doc/NgrokAPI/PagedIterator.html +++ b/doc/NgrokAPI/PagedIterator.html @@ -6,7 +6,7 @@ Class: NgrokAPI::PagedIterator - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -625,9 +625,9 @@ diff --git a/doc/NgrokAPI/Services.html b/doc/NgrokAPI/Services.html index c107337..e317413 100644 --- a/doc/NgrokAPI/Services.html +++ b/doc/NgrokAPI/Services.html @@ -6,7 +6,7 @@ Module: NgrokAPI::Services - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -79,7 +79,7 @@
    Defined in:
    lib/ngrokapi/services/tunnels_client.rb,
    - lib/ngrokapi/services/api_keys_client.rb,
    lib/ngrokapi/services/edges_tcp_client.rb,
    lib/ngrokapi/services/edges_tls_client.rb,
    lib/ngrokapi/services/endpoints_client.rb,
    lib/ngrokapi/services/credentials_client.rb,
    lib/ngrokapi/services/edges_https_client.rb,
    lib/ngrokapi/services/ip_policies_client.rb,
    lib/ngrokapi/services/abuse_reports_client.rb,
    lib/ngrokapi/services/event_sources_client.rb,
    lib/ngrokapi/services/reserved_addrs_client.rb,
    lib/ngrokapi/services/agent_ingresses_client.rb,
    lib/ngrokapi/services/ip_policy_rules_client.rb,
    lib/ngrokapi/services/ip_restrictions_client.rb,
    lib/ngrokapi/services/ssh_credentials_client.rb,
    lib/ngrokapi/services/tunnel_sessions_client.rb,
    lib/ngrokapi/services/reserved_domains_client.rb,
    lib/ngrokapi/services/tls_certificates_client.rb,
    lib/ngrokapi/services/application_users_client.rb,
    lib/ngrokapi/services/failover_backends_client.rb,
    lib/ngrokapi/services/weighted_backends_client.rb,
    lib/ngrokapi/services/edges_https_routes_client.rb,
    lib/ngrokapi/services/event_destinations_client.rb,
    lib/ngrokapi/services/event_subscriptions_client.rb,
    lib/ngrokapi/services/application_sessions_client.rb,
    lib/ngrokapi/services/ssh_host_certificates_client.rb,
    lib/ngrokapi/services/ssh_user_certificates_client.rb,
    lib/ngrokapi/services/tunnel_group_backends_client.rb,
    lib/ngrokapi/services/edge_route_oidc_module_client.rb,
    lib/ngrokapi/services/edge_route_saml_module_client.rb,
    lib/ngrokapi/services/http_response_backends_client.rb,
    lib/ngrokapi/services/certificate_authorities_client.rb,
    lib/ngrokapi/services/tcp_edge_backend_module_client.rb,
    lib/ngrokapi/services/tls_edge_backend_module_client.rb,
    lib/ngrokapi/services/edge_route_o_auth_module_client.rb,
    lib/ngrokapi/services/edge_route_backend_module_client.rb,
    lib/ngrokapi/services/tls_edge_mutual_tls_module_client.rb,
    lib/ngrokapi/services/ssh_certificate_authorities_client.rb,
    lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb,
    lib/ngrokapi/services/edge_route_compression_module_client.rb,
    lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb,
    lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb,
    lib/ngrokapi/services/tls_edge_tls_termination_module_client.rb,
    lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb,
    lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb,
    lib/ngrokapi/services/edge_route_request_headers_module_client.rb,
    lib/ngrokapi/services/https_edge_tls_termination_module_client.rb,
    lib/ngrokapi/services/edge_route_response_headers_module_client.rb,
    lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb,
    lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb
    + lib/ngrokapi/services/api_keys_client.rb,
    lib/ngrokapi/services/edges_tcp_client.rb,
    lib/ngrokapi/services/edges_tls_client.rb,
    lib/ngrokapi/services/endpoints_client.rb,
    lib/ngrokapi/services/credentials_client.rb,
    lib/ngrokapi/services/edges_https_client.rb,
    lib/ngrokapi/services/ip_policies_client.rb,
    lib/ngrokapi/services/abuse_reports_client.rb,
    lib/ngrokapi/services/event_sources_client.rb,
    lib/ngrokapi/services/reserved_addrs_client.rb,
    lib/ngrokapi/services/agent_ingresses_client.rb,
    lib/ngrokapi/services/ip_policy_rules_client.rb,
    lib/ngrokapi/services/ip_restrictions_client.rb,
    lib/ngrokapi/services/ssh_credentials_client.rb,
    lib/ngrokapi/services/static_backends_client.rb,
    lib/ngrokapi/services/tunnel_sessions_client.rb,
    lib/ngrokapi/services/reserved_domains_client.rb,
    lib/ngrokapi/services/tls_certificates_client.rb,
    lib/ngrokapi/services/application_users_client.rb,
    lib/ngrokapi/services/failover_backends_client.rb,
    lib/ngrokapi/services/weighted_backends_client.rb,
    lib/ngrokapi/services/edges_https_routes_client.rb,
    lib/ngrokapi/services/event_destinations_client.rb,
    lib/ngrokapi/services/event_subscriptions_client.rb,
    lib/ngrokapi/services/application_sessions_client.rb,
    lib/ngrokapi/services/ssh_host_certificates_client.rb,
    lib/ngrokapi/services/ssh_user_certificates_client.rb,
    lib/ngrokapi/services/tunnel_group_backends_client.rb,
    lib/ngrokapi/services/edge_route_oidc_module_client.rb,
    lib/ngrokapi/services/edge_route_saml_module_client.rb,
    lib/ngrokapi/services/http_response_backends_client.rb,
    lib/ngrokapi/services/tcp_edge_policy_module_client.rb,
    lib/ngrokapi/services/tls_edge_policy_module_client.rb,
    lib/ngrokapi/services/certificate_authorities_client.rb,
    lib/ngrokapi/services/tcp_edge_backend_module_client.rb,
    lib/ngrokapi/services/tls_edge_backend_module_client.rb,
    lib/ngrokapi/services/edge_route_o_auth_module_client.rb,
    lib/ngrokapi/services/edge_route_policy_module_client.rb,
    lib/ngrokapi/services/edge_route_backend_module_client.rb,
    lib/ngrokapi/services/tls_edge_mutual_tls_module_client.rb,
    lib/ngrokapi/services/ssh_certificate_authorities_client.rb,
    lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb,
    lib/ngrokapi/services/edge_route_compression_module_client.rb,
    lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb,
    lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb,
    lib/ngrokapi/services/tls_edge_tls_termination_module_client.rb,
    lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb,
    lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb,
    lib/ngrokapi/services/edge_route_request_headers_module_client.rb,
    lib/ngrokapi/services/https_edge_tls_termination_module_client.rb,
    lib/ngrokapi/services/edge_route_response_headers_module_client.rb,
    lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb,
    lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb,
    lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb
    @@ -91,7 +91,7 @@ - Classes: APIKeysClient, AbuseReportsClient, AgentIngressesClient, ApplicationSessionsClient, ApplicationUsersClient, CertificateAuthoritiesClient, CredentialsClient, EdgeRouteBackendModuleClient, EdgeRouteCircuitBreakerModuleClient, EdgeRouteCompressionModuleClient, EdgeRouteIPRestrictionModuleClient, EdgeRouteOAuthModuleClient, EdgeRouteOIDCModuleClient, EdgeRouteRequestHeadersModuleClient, EdgeRouteResponseHeadersModuleClient, EdgeRouteSAMLModuleClient, EdgeRouteWebhookVerificationModuleClient, EdgeRouteWebsocketTCPConverterModuleClient, EdgesHTTPSClient, EdgesHTTPSRoutesClient, EdgesTCPClient, EdgesTLSClient, EndpointsClient, EventDestinationsClient, EventSourcesClient, EventSubscriptionsClient, FailoverBackendsClient, HTTPResponseBackendsClient, HTTPSEdgeMutualTLSModuleClient, HTTPSEdgeTLSTerminationModuleClient, IPPoliciesClient, IPPolicyRulesClient, IPRestrictionsClient, ReservedAddrsClient, ReservedDomainsClient, SSHCertificateAuthoritiesClient, SSHCredentialsClient, SSHHostCertificatesClient, SSHUserCertificatesClient, TCPEdgeBackendModuleClient, TCPEdgeIPRestrictionModuleClient, TLSCertificatesClient, TLSEdgeBackendModuleClient, TLSEdgeIPRestrictionModuleClient, TLSEdgeMutualTLSModuleClient, TLSEdgeTLSTerminationModuleClient, TunnelGroupBackendsClient, TunnelSessionsClient, TunnelsClient, WeightedBackendsClient + Classes: APIKeysClient, AbuseReportsClient, AgentIngressesClient, ApplicationSessionsClient, ApplicationUsersClient, CertificateAuthoritiesClient, CredentialsClient, EdgeRouteBackendModuleClient, EdgeRouteCircuitBreakerModuleClient, EdgeRouteCompressionModuleClient, EdgeRouteIPRestrictionModuleClient, EdgeRouteOAuthModuleClient, EdgeRouteOIDCModuleClient, EdgeRoutePolicyModuleClient, EdgeRouteRequestHeadersModuleClient, EdgeRouteResponseHeadersModuleClient, EdgeRouteSAMLModuleClient, EdgeRouteUserAgentFilterModuleClient, EdgeRouteWebhookVerificationModuleClient, EdgeRouteWebsocketTCPConverterModuleClient, EdgesHTTPSClient, EdgesHTTPSRoutesClient, EdgesTCPClient, EdgesTLSClient, EndpointsClient, EventDestinationsClient, EventSourcesClient, EventSubscriptionsClient, FailoverBackendsClient, HTTPResponseBackendsClient, HTTPSEdgeMutualTLSModuleClient, HTTPSEdgeTLSTerminationModuleClient, IPPoliciesClient, IPPolicyRulesClient, IPRestrictionsClient, ReservedAddrsClient, ReservedDomainsClient, SSHCertificateAuthoritiesClient, SSHCredentialsClient, SSHHostCertificatesClient, SSHUserCertificatesClient, StaticBackendsClient, TCPEdgeBackendModuleClient, TCPEdgeIPRestrictionModuleClient, TCPEdgePolicyModuleClient, TLSCertificatesClient, TLSEdgeBackendModuleClient, TLSEdgeIPRestrictionModuleClient, TLSEdgeMutualTLSModuleClient, TLSEdgePolicyModuleClient, TLSEdgeTLSTerminationModuleClient, TunnelGroupBackendsClient, TunnelSessionsClient, TunnelsClient, WeightedBackendsClient

    @@ -107,9 +107,9 @@ diff --git a/doc/NgrokAPI/Services/APIKeysClient.html b/doc/NgrokAPI/Services/APIKeysClient.html index 9dde7cf..a9b6337 100644 --- a/doc/NgrokAPI/Services/APIKeysClient.html +++ b/doc/NgrokAPI/Services/APIKeysClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::APIKeysClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -102,7 +102,7 @@

    Overview

    -

    API Keys are used to authenticate to the ngrok API. You may use the API itself to provision and manage API Keys but you'll need to provision your first API key from the API Keys page on your ngrok.com dashboard.

    +

    API Keys are used to authenticate to the ngrok API. You may use the API itself to provision and manage API Keys but you’ll need to provision your first API key from the API Keys page on your ngrok.com dashboard.

    ngrok.com/docs/api#api-api-keys

    @@ -1749,9 +1749,9 @@
    diff --git a/doc/NgrokAPI/Services/AbuseReportsClient.html b/doc/NgrokAPI/Services/AbuseReportsClient.html index 95ff995..cb33610 100644 --- a/doc/NgrokAPI/Services/AbuseReportsClient.html +++ b/doc/NgrokAPI/Services/AbuseReportsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::AbuseReportsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -102,7 +102,7 @@

    Overview

    -

    Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok's terms of service.

    +

    Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok’s terms of service.

    ngrok.com/docs/api#api-abuse-reports

    @@ -833,9 +833,9 @@
    diff --git a/doc/NgrokAPI/Services/AgentIngressesClient.html b/doc/NgrokAPI/Services/AgentIngressesClient.html index 4c664b9..f80473e 100644 --- a/doc/NgrokAPI/Services/AgentIngressesClient.html +++ b/doc/NgrokAPI/Services/AgentIngressesClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::AgentIngressesClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1823,9 +1823,9 @@ diff --git a/doc/NgrokAPI/Services/ApplicationSessionsClient.html b/doc/NgrokAPI/Services/ApplicationSessionsClient.html index e28f9bf..cd2671a 100644 --- a/doc/NgrokAPI/Services/ApplicationSessionsClient.html +++ b/doc/NgrokAPI/Services/ApplicationSessionsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::ApplicationSessionsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1121,9 +1121,9 @@ diff --git a/doc/NgrokAPI/Services/ApplicationUsersClient.html b/doc/NgrokAPI/Services/ApplicationUsersClient.html index 0282017..1468a70 100644 --- a/doc/NgrokAPI/Services/ApplicationUsersClient.html +++ b/doc/NgrokAPI/Services/ApplicationUsersClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::ApplicationUsersClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1121,9 +1121,9 @@ diff --git a/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html b/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html index 2a3eb3d..4a8c4f8 100644 --- a/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +++ b/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::CertificateAuthoritiesClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1745,9 +1745,9 @@ diff --git a/doc/NgrokAPI/Services/CredentialsClient.html b/doc/NgrokAPI/Services/CredentialsClient.html index a57a0b0..1c6fafa 100644 --- a/doc/NgrokAPI/Services/CredentialsClient.html +++ b/doc/NgrokAPI/Services/CredentialsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::CredentialsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -207,7 +207,7 @@
  • - #create(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "") ⇒ NgrokAPI::Models::Credential + #create(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil) ⇒ NgrokAPI::Models::Credential @@ -231,7 +231,7 @@
  • - #create!(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "") ⇒ NgrokAPI::Models::Credential + #create!(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil) ⇒ NgrokAPI::Models::Credential @@ -575,7 +575,7 @@

    - #create(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "") ⇒ NgrokAPI::Models::Credential + #create(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil) ⇒ NgrokAPI::Models::Credential @@ -710,7 +710,7 @@
    # File 'lib/ngrokapi/services/credentials_client.rb', line 39
     
    -def create(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "")
    +def create(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil)
       path = '/credentials'
       replacements = {
       }
    @@ -730,7 +730,7 @@
           

    - #create!(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "") ⇒ NgrokAPI::Models::Credential + #create!(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil) ⇒ NgrokAPI::Models::Credential @@ -865,7 +865,7 @@
    # File 'lib/ngrokapi/services/credentials_client.rb', line 66
     
    -def create!(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "")
    +def create!(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil)
       path = '/credentials'
       replacements = {
       }
    @@ -1829,9 +1829,9 @@
     

    diff --git a/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html b/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html index a9835d9..8942df1 100644 --- a/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +++ b/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgeRouteBackendModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1139,9 +1139,9 @@ diff --git a/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html b/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html index 9fff48a..9460d48 100644 --- a/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +++ b/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgeRouteCircuitBreakerModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1139,9 +1139,9 @@ diff --git a/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html b/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html index 13d2746..114133e 100644 --- a/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +++ b/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgeRouteCompressionModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1139,9 +1139,9 @@ diff --git a/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html b/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html index 1d0dd6d..57638e5 100644 --- a/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +++ b/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgeRouteIPRestrictionModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1139,9 +1139,9 @@ diff --git a/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html b/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html index e209d7c..0c9926c 100644 --- a/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +++ b/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgeRouteOAuthModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1139,9 +1139,9 @@ diff --git a/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html b/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html index d20417e..8c5406e 100644 --- a/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +++ b/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgeRouteOIDCModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1139,9 +1139,9 @@ diff --git a/doc/NgrokAPI/Services/EdgeRoutePolicyModuleClient.html b/doc/NgrokAPI/Services/EdgeRoutePolicyModuleClient.html new file mode 100644 index 0000000..eac6e80 --- /dev/null +++ b/doc/NgrokAPI/Services/EdgeRoutePolicyModuleClient.html @@ -0,0 +1,1149 @@ + + + + + + + Class: NgrokAPI::Services::EdgeRoutePolicyModuleClient + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: NgrokAPI::Services::EdgeRoutePolicyModuleClient + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/services/edge_route_policy_module_client.rb
    +
    + +
    + +

    Overview

    +
    + + +
    + +

    + Constant Summary + collapse +

    + +
    + +
    PATH = +
    +
    + +

    The API path for the requests

    + + +
    +
    +
    + + +
    +
    +
    '/edges/https/%{edge_id}/routes/%{id}/policy'
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client:) ⇒ EdgeRoutePolicyModuleClient + + + + + +

    +
    + +

    Returns a new instance of EdgeRoutePolicyModuleClient.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +15
    +16
    +17
    +
    +
    # File 'lib/ngrokapi/services/edge_route_policy_module_client.rb', line 15
    +
    +def initialize(client:)
    +  @client = client
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +13
    +14
    +15
    +
    +
    # File 'lib/ngrokapi/services/edge_route_policy_module_client.rb', line 13
    +
    +def client
    +  @client
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #delete(edge_id: "", id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + edge_id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge

      +
      + +
    • + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge route

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +95
    +96
    +97
    +98
    +99
    +100
    +101
    +102
    +
    +
    # File 'lib/ngrokapi/services/edge_route_policy_module_client.rb', line 95
    +
    +def delete(edge_id: "", id: "")
    +  path = '/edges/https/%{edge_id}/routes/%{id}/policy'
    +  replacements = {
    +    edge_id: edge_id,
    +    id: id,
    +  }
    +  @client.delete(path % replacements)
    +end
    +
    +
    + +
    +

    + + #delete!(edge_id: "", id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + edge_id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge

      +
      + +
    • + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge route

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +110
    +111
    +112
    +113
    +114
    +115
    +116
    +117
    +
    +
    # File 'lib/ngrokapi/services/edge_route_policy_module_client.rb', line 110
    +
    +def delete!(edge_id: "", id: "")
    +  path = '/edges/https/%{edge_id}/routes/%{id}/policy'
    +  replacements = {
    +    edge_id: edge_id,
    +    id: id,
    +  }
    +  @client.delete(path % replacements, danger: true)
    +end
    +
    +
    + +
    +

    + + #get(edge_id: "", id: "") ⇒ NgrokAPI::Models::EndpointPolicy + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + edge_id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge

      +
      + +
    • + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge route

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +61
    +62
    +63
    +64
    +65
    +66
    +67
    +68
    +69
    +70
    +
    +
    # File 'lib/ngrokapi/services/edge_route_policy_module_client.rb', line 61
    +
    +def get(edge_id: "", id: "")
    +  path = '/edges/https/%{edge_id}/routes/%{id}/policy'
    +  replacements = {
    +    edge_id: edge_id,
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data)
    +  NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #get!(edge_id: "", id: "") ⇒ NgrokAPI::Models::EndpointPolicy + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + edge_id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge

      +
      + +
    • + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge route

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +78
    +79
    +80
    +81
    +82
    +83
    +84
    +85
    +86
    +87
    +
    +
    # File 'lib/ngrokapi/services/edge_route_policy_module_client.rb', line 78
    +
    +def get!(edge_id: "", id: "")
    +  path = '/edges/https/%{edge_id}/routes/%{id}/policy'
    +  replacements = {
    +    edge_id: edge_id,
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #replace(edge_id: "", id: "", a_module: nil) ⇒ NgrokAPI::Models::EndpointPolicy + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + edge_id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + a_module + + + (EndpointPolicy) + + + (defaults to: nil) + + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +26
    +27
    +28
    +29
    +30
    +31
    +32
    +33
    +34
    +35
    +
    +
    # File 'lib/ngrokapi/services/edge_route_policy_module_client.rb', line 26
    +
    +def replace(edge_id: "", id: "", a_module: nil)
    +  path = '/edges/https/%{edge_id}/routes/%{id}/policy'
    +  replacements = {
    +    edge_id: edge_id,
    +    id: id,
    +  }
    +  data = a_module
    +  result = @client.put(path % replacements, data: data)
    +  NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #replace!(edge_id: "", id: "", a_module: nil) ⇒ NgrokAPI::Models::EndpointPolicy + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + edge_id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + a_module + + + (EndpointPolicy) + + + (defaults to: nil) + + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +44
    +45
    +46
    +47
    +48
    +49
    +50
    +51
    +52
    +53
    +
    +
    # File 'lib/ngrokapi/services/edge_route_policy_module_client.rb', line 44
    +
    +def replace!(edge_id: "", id: "", a_module: nil)
    +  path = '/edges/https/%{edge_id}/routes/%{id}/policy'
    +  replacements = {
    +    edge_id: edge_id,
    +    id: id,
    +  }
    +  data = a_module
    +  result = @client.put(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html b/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html index a315d15..b9d1456 100644 --- a/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +++ b/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgeRouteRequestHeadersModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1139,9 +1139,9 @@ diff --git a/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html b/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html index 9a3b374..add776a 100644 --- a/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +++ b/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgeRouteResponseHeadersModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1139,9 +1139,9 @@ diff --git a/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html b/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html index e5f6a51..d1263d5 100644 --- a/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +++ b/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgeRouteSAMLModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1139,9 +1139,9 @@ diff --git a/doc/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html b/doc/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html new file mode 100644 index 0000000..aa0c7ba --- /dev/null +++ b/doc/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html @@ -0,0 +1,1149 @@ + + + + + + + Class: NgrokAPI::Services::EdgeRouteUserAgentFilterModuleClient + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: NgrokAPI::Services::EdgeRouteUserAgentFilterModuleClient + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb
    +
    + +
    + +

    Overview

    +
    + + +
    + +

    + Constant Summary + collapse +

    + +
    + +
    PATH = +
    +
    + +

    The API path for the requests

    + + +
    +
    +
    + + +
    +
    +
    '/edges/https/%{edge_id}/routes/%{id}/user_agent_filter'
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client:) ⇒ EdgeRouteUserAgentFilterModuleClient + + + + + +

    +
    + +

    Returns a new instance of EdgeRouteUserAgentFilterModuleClient.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +15
    +16
    +17
    +
    +
    # File 'lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb', line 15
    +
    +def initialize(client:)
    +  @client = client
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +13
    +14
    +15
    +
    +
    # File 'lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb', line 13
    +
    +def client
    +  @client
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #delete(edge_id: "", id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + edge_id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge

      +
      + +
    • + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge route

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +95
    +96
    +97
    +98
    +99
    +100
    +101
    +102
    +
    +
    # File 'lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb', line 95
    +
    +def delete(edge_id: "", id: "")
    +  path = '/edges/https/%{edge_id}/routes/%{id}/user_agent_filter'
    +  replacements = {
    +    edge_id: edge_id,
    +    id: id,
    +  }
    +  @client.delete(path % replacements)
    +end
    +
    +
    + +
    +

    + + #delete!(edge_id: "", id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + edge_id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge

      +
      + +
    • + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge route

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +110
    +111
    +112
    +113
    +114
    +115
    +116
    +117
    +
    +
    # File 'lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb', line 110
    +
    +def delete!(edge_id: "", id: "")
    +  path = '/edges/https/%{edge_id}/routes/%{id}/user_agent_filter'
    +  replacements = {
    +    edge_id: edge_id,
    +    id: id,
    +  }
    +  @client.delete(path % replacements, danger: true)
    +end
    +
    +
    + +
    +

    + + #get(edge_id: "", id: "") ⇒ NgrokAPI::Models::EndpointUserAgentFilter + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + edge_id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge

      +
      + +
    • + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge route

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +61
    +62
    +63
    +64
    +65
    +66
    +67
    +68
    +69
    +70
    +
    +
    # File 'lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb', line 61
    +
    +def get(edge_id: "", id: "")
    +  path = '/edges/https/%{edge_id}/routes/%{id}/user_agent_filter'
    +  replacements = {
    +    edge_id: edge_id,
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data)
    +  NgrokAPI::Models::EndpointUserAgentFilter.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #get!(edge_id: "", id: "") ⇒ NgrokAPI::Models::EndpointUserAgentFilter + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + edge_id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge

      +
      + +
    • + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge route

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +78
    +79
    +80
    +81
    +82
    +83
    +84
    +85
    +86
    +87
    +
    +
    # File 'lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb', line 78
    +
    +def get!(edge_id: "", id: "")
    +  path = '/edges/https/%{edge_id}/routes/%{id}/user_agent_filter'
    +  replacements = {
    +    edge_id: edge_id,
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::EndpointUserAgentFilter.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #replace(edge_id: "", id: "", a_module: nil) ⇒ NgrokAPI::Models::EndpointUserAgentFilter + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + edge_id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + a_module + + + (EndpointUserAgentFilter) + + + (defaults to: nil) + + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +26
    +27
    +28
    +29
    +30
    +31
    +32
    +33
    +34
    +35
    +
    +
    # File 'lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb', line 26
    +
    +def replace(edge_id: "", id: "", a_module: nil)
    +  path = '/edges/https/%{edge_id}/routes/%{id}/user_agent_filter'
    +  replacements = {
    +    edge_id: edge_id,
    +    id: id,
    +  }
    +  data = a_module
    +  result = @client.put(path % replacements, data: data)
    +  NgrokAPI::Models::EndpointUserAgentFilter.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #replace!(edge_id: "", id: "", a_module: nil) ⇒ NgrokAPI::Models::EndpointUserAgentFilter + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + edge_id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + a_module + + + (EndpointUserAgentFilter) + + + (defaults to: nil) + + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +44
    +45
    +46
    +47
    +48
    +49
    +50
    +51
    +52
    +53
    +
    +
    # File 'lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb', line 44
    +
    +def replace!(edge_id: "", id: "", a_module: nil)
    +  path = '/edges/https/%{edge_id}/routes/%{id}/user_agent_filter'
    +  replacements = {
    +    edge_id: edge_id,
    +    id: id,
    +  }
    +  data = a_module
    +  result = @client.put(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::EndpointUserAgentFilter.new(client: self, attrs: result)
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html b/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html index 9a1097c..953d746 100644 --- a/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +++ b/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgeRouteWebhookVerificationModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1139,9 +1139,9 @@ diff --git a/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html b/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html index 4f943dd..b149c43 100644 --- a/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +++ b/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgeRouteWebsocketTCPConverterModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1139,9 +1139,9 @@ diff --git a/doc/NgrokAPI/Services/EdgesHTTPSClient.html b/doc/NgrokAPI/Services/EdgesHTTPSClient.html index 0b5b70e..e71261f 100644 --- a/doc/NgrokAPI/Services/EdgesHTTPSClient.html +++ b/doc/NgrokAPI/Services/EdgesHTTPSClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgesHTTPSClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1937,9 +1937,9 @@ diff --git a/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html b/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html index fc9cfbb..393068c 100644 --- a/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +++ b/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgesHTTPSRoutesClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -189,7 +189,7 @@
  • - #create(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute + #create(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute @@ -213,7 +213,7 @@
  • - #create!(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute + #create!(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute @@ -359,7 +359,7 @@
  • - #update(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute + #update(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute @@ -383,7 +383,7 @@
  • - #update!(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute + #update!(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute @@ -509,7 +509,7 @@

    - #create(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute + #create(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute @@ -809,6 +809,37 @@ —

    websocket to tcp adapter configuration or null

    +
    + +

  • + +
  • + + user_agent_filter + + + (EndpointUserAgentFilter) + + + (defaults to: nil) + + +
  • + +
  • + + policy + + + (EndpointPolicy) + + + (defaults to: nil) + + + — +
    +

    the traffic policy associated with this edge or null

  • @@ -840,8 +871,6 @@
     
     
    -41
    -42
     43
     44
     45
    @@ -863,12 +892,16 @@
     61
     62
     63
    -64
    +64 +65 +66 +67 +68
    -
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 41
    +      
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 43
     
    -def create(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil)
    +def create(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil)
       path = '/edges/https/%{edge_id}/routes'
       replacements = {
         edge_id: edge_id,
    @@ -889,6 +922,8 @@
       data[:saml] = saml if saml
       data[:oidc] = oidc if oidc
       data[:websocket_tcp_converter] = websocket_tcp_converter if websocket_tcp_converter
    +  data[:user_agent_filter] = user_agent_filter if user_agent_filter
    +  data[:policy] = policy if policy
       result = @client.post(path % replacements, data: data)
       NgrokAPI::Models::HTTPSEdgeRoute.new(client: self, attrs: result)
     end
    @@ -900,7 +935,7 @@

    - #create!(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute + #create!(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute @@ -1200,6 +1235,37 @@ —

    websocket to tcp adapter configuration or null

    +
    + + + +
  • + + user_agent_filter + + + (EndpointUserAgentFilter) + + + (defaults to: nil) + + +
  • + +
  • + + policy + + + (EndpointPolicy) + + + (defaults to: nil) + + + — +
    +

    the traffic policy associated with this edge or null

  • @@ -1231,12 +1297,6 @@
     
     
    -89
    -90
    -91
    -92
    -93
    -94
     95
     96
     97
    @@ -1254,12 +1314,20 @@
     109
     110
     111
    -112
    +112 +113 +114 +115 +116 +117 +118 +119 +120

    -
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 89
    +      
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 95
     
    -def create!(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil)
    +def create!(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil)
       path = '/edges/https/%{edge_id}/routes'
       replacements = {
         edge_id: edge_id,
    @@ -1280,6 +1348,8 @@
       data[:saml] = saml if saml
       data[:oidc] = oidc if oidc
       data[:websocket_tcp_converter] = websocket_tcp_converter if websocket_tcp_converter
    +  data[:user_agent_filter] = user_agent_filter if user_agent_filter
    +  data[:policy] = policy if policy
       result = @client.post(path % replacements, data: data, danger: true)
       NgrokAPI::Models::HTTPSEdgeRoute.new(client: self, attrs: result)
     end
    @@ -1374,17 +1444,17 @@
     
     
    -266
    -267
    -268
    -269
    -270
    -271
    -272
    -273
    +282 +283 +284 +285 +286 +287 +288 +289
    -
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 266
    +      
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 282
     
     def delete(edge_id: "", id: "")
       path = '/edges/https/%{edge_id}/routes/%{id}'
    @@ -1485,17 +1555,17 @@
           
     
     
    -284
    -285
    -286
    -287
    -288
    -289
    -290
    -291
    +300 +301 +302 +303 +304 +305 +306 +307
    -
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 284
    +      
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 300
     
     def delete!(edge_id: "", id: "")
       path = '/edges/https/%{edge_id}/routes/%{id}'
    @@ -1596,19 +1666,19 @@
           
     
     
    -122
    -123
    -124
    -125
    -126
    -127
    -128
    -129
     130
    -131
    +131 +132 +133 +134 +135 +136 +137 +138 +139
    -
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 122
    +      
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 130
     
     def get(edge_id: "", id: "")
       path = '/edges/https/%{edge_id}/routes/%{id}'
    @@ -1711,19 +1781,19 @@
           
     
     
    -142
    -143
    -144
    -145
    -146
    -147
    -148
    -149
     150
    -151
    +151 +152 +153 +154 +155 +156 +157 +158 +159
    -
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 142
    +      
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 150
     
     def get!(edge_id: "", id: "")
       path = '/edges/https/%{edge_id}/routes/%{id}'
    @@ -1743,7 +1813,7 @@
           

    - #update(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute + #update(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute @@ -2065,6 +2135,37 @@ —

    websocket to tcp adapter configuration or null

    +
    + + + +
  • + + user_agent_filter + + + (EndpointUserAgentFilter) + + + (defaults to: nil) + + +
  • + +
  • + + policy + + + (EndpointPolicy) + + + (defaults to: nil) + + + — +
    +

    the traffic policy associated with this edge or null

  • @@ -2096,16 +2197,6 @@
     
     
    -179
    -180
    -181
    -182
    -183
    -184
    -185
    -186
    -187
    -188
     189
     190
     191
    @@ -2120,12 +2211,24 @@
     200
     201
     202
    -203
    +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215

    -
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 179
    +      
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 189
     
    -def update(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil)
    +def update(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil)
       path = '/edges/https/%{edge_id}/routes/%{id}'
       replacements = {
         edge_id: edge_id,
    @@ -2147,6 +2250,8 @@
       data[:saml] = saml if saml
       data[:oidc] = oidc if oidc
       data[:websocket_tcp_converter] = websocket_tcp_converter if websocket_tcp_converter
    +  data[:user_agent_filter] = user_agent_filter if user_agent_filter
    +  data[:policy] = policy if policy
       result = @client.patch(path % replacements, data: data)
       NgrokAPI::Models::HTTPSEdgeRoute.new(client: self, attrs: result)
     end
    @@ -2158,7 +2263,7 @@

    - #update!(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute + #update!(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute @@ -2480,6 +2585,37 @@ —

    websocket to tcp adapter configuration or null

    +
    + + + +
  • + + user_agent_filter + + + (EndpointUserAgentFilter) + + + (defaults to: nil) + + +
  • + +
  • + + policy + + + (EndpointPolicy) + + + (defaults to: nil) + + + — +
    +

    the traffic policy associated with this edge or null

  • @@ -2511,20 +2647,6 @@
     
     
    -232
    -233
    -234
    -235
    -236
    -237
    -238
    -239
    -240
    -241
    -242
    -243
    -244
    -245
     246
     247
     248
    @@ -2535,12 +2657,28 @@
     253
     254
     255
    -256
    +256 +257 +258 +259 +260 +261 +262 +263 +264 +265 +266 +267 +268 +269 +270 +271 +272

    -
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 232
    +      
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 246
     
    -def update!(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil)
    +def update!(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil)
       path = '/edges/https/%{edge_id}/routes/%{id}'
       replacements = {
         edge_id: edge_id,
    @@ -2562,6 +2700,8 @@
       data[:saml] = saml if saml
       data[:oidc] = oidc if oidc
       data[:websocket_tcp_converter] = websocket_tcp_converter if websocket_tcp_converter
    +  data[:user_agent_filter] = user_agent_filter if user_agent_filter
    +  data[:policy] = policy if policy
       result = @client.patch(path % replacements, data: data, danger: true)
       NgrokAPI::Models::HTTPSEdgeRoute.new(client: self, attrs: result)
     end
    @@ -2575,9 +2715,9 @@ diff --git a/doc/NgrokAPI/Services/EdgesTCPClient.html b/doc/NgrokAPI/Services/EdgesTCPClient.html index cadf33a..b03c269 100644 --- a/doc/NgrokAPI/Services/EdgesTCPClient.html +++ b/doc/NgrokAPI/Services/EdgesTCPClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgesTCPClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -205,7 +205,7 @@
  • - #create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil) ⇒ NgrokAPI::Models::TCPEdge + #create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, policy: nil) ⇒ NgrokAPI::Models::TCPEdge @@ -229,7 +229,7 @@
  • - #create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil) ⇒ NgrokAPI::Models::TCPEdge + #create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, policy: nil) ⇒ NgrokAPI::Models::TCPEdge @@ -423,7 +423,7 @@
  • - #update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil) ⇒ NgrokAPI::Models::TCPEdge + #update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, policy: nil) ⇒ NgrokAPI::Models::TCPEdge @@ -447,7 +447,7 @@
  • - #update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil) ⇒ NgrokAPI::Models::TCPEdge + #update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, policy: nil) ⇒ NgrokAPI::Models::TCPEdge @@ -573,7 +573,7 @@

    - #create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil) ⇒ NgrokAPI::Models::TCPEdge + #create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, policy: nil) ⇒ NgrokAPI::Models::TCPEdge @@ -678,6 +678,24 @@

  • +
  • + + policy + + + (EndpointPolicy) + + + (defaults to: nil) + + + — +
    +

    the traffic policy associated with this edge or null

    +
    + +
  • +

    Returns:

    @@ -705,7 +723,6 @@
     
     
    -32
     33
     34
     35
    @@ -717,12 +734,14 @@
     41
     42
     43
    -44
    +44 +45 +46
    -
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 32
    +      
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 33
     
    -def create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil)
    +def create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, policy: nil)
       path = '/edges/tcp'
       replacements = {
       }
    @@ -732,6 +751,7 @@
       data[:hostports] = hostports if hostports
       data[:backend] = backend if backend
       data[:ip_restriction] = ip_restriction if ip_restriction
    +  data[:policy] = policy if policy
       result = @client.post(path % replacements, data: data)
       NgrokAPI::Models::TCPEdge.new(client: self, attrs: result)
     end
    @@ -743,7 +763,7 @@

    - #create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil) ⇒ NgrokAPI::Models::TCPEdge + #create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, policy: nil) ⇒ NgrokAPI::Models::TCPEdge @@ -848,6 +868,24 @@ +
  • + + policy + + + (EndpointPolicy) + + + (defaults to: nil) + + + — +
    +

    the traffic policy associated with this edge or null

    +
    + +
  • +

    Returns:

    @@ -875,9 +913,6 @@
     
     
    -58
    -59
    -60
     61
     62
     63
    @@ -887,12 +922,16 @@
     67
     68
     69
    -70
    +70 +71 +72 +73 +74

    -
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 58
    +      
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 61
     
    -def create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil)
    +def create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, policy: nil)
       path = '/edges/tcp'
       replacements = {
       }
    @@ -902,6 +941,7 @@
       data[:hostports] = hostports if hostports
       data[:backend] = backend if backend
       data[:ip_restriction] = ip_restriction if ip_restriction
    +  data[:policy] = policy if policy
       result = @client.post(path % replacements, data: data, danger: true)
       NgrokAPI::Models::TCPEdge.new(client: self, attrs: result)
     end
    @@ -978,16 +1018,16 @@
     
     
    -228
    -229
    -230
    -231
    -232
    -233
    -234
    +236 +237 +238 +239 +240 +241 +242
    -
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 228
    +      
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 236
     
     def delete(id: "")
       path = '/edges/tcp/%{id}'
    @@ -1069,16 +1109,16 @@
           
     
     
    -244
    -245
    -246
    -247
    -248
    -249
    -250
    +252 +253 +254 +255 +256 +257 +258
    -
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 244
    +      
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 252
     
     def delete!(id: "")
       path = '/edges/tcp/%{id}'
    @@ -1160,18 +1200,18 @@
           
     
     
    -79
    -80
    -81
    -82
     83
     84
     85
     86
    -87
    +87 +88 +89 +90 +91
    -
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 79
    +      
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 83
     
     def get(id: "")
       path = '/edges/tcp/%{id}'
    @@ -1255,18 +1295,18 @@
           
     
     
    -97
    -98
    -99
    -100
     101
     102
     103
     104
    -105
    +105 +106 +107 +108 +109
    -
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 97
    +      
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 101
     
     def get!(id: "")
       path = '/edges/tcp/%{id}'
    @@ -1376,10 +1416,6 @@
           
     
     
    -116
    -117
    -118
    -119
     120
     121
     122
    @@ -1390,10 +1426,14 @@
     127
     128
     129
    -130
    +130 +131 +132 +133 +134
    -
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 116
    +      
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 120
     
     def list(before_id: nil, limit: nil, url: nil)
       result = @client.list(
    @@ -1509,10 +1549,6 @@
           
     
     
    -142
    -143
    -144
    -145
     146
     147
     148
    @@ -1525,10 +1561,14 @@
     155
     156
     157
    -158
    +158 +159 +160 +161 +162
    -
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 142
    +      
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 146
     
     def list!(before_id: nil, limit: nil, url: nil)
       result = @client.list(
    @@ -1555,7 +1595,7 @@
           

    - #update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil) ⇒ NgrokAPI::Models::TCPEdge + #update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, policy: nil) ⇒ NgrokAPI::Models::TCPEdge @@ -1678,6 +1718,24 @@ +
  • + + policy + + + (EndpointPolicy) + + + (defaults to: nil) + + + — +
    +

    the traffic policy associated with this edge or null

    +
    + +
  • +

    Returns:

    @@ -1705,11 +1763,6 @@
     
     
    -175
    -176
    -177
    -178
    -179
     180
     181
     182
    @@ -1718,12 +1771,18 @@
     185
     186
     187
    -188
    +188 +189 +190 +191 +192 +193 +194

    -
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 175
    +      
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 180
     
    -def update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil)
    +def update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, policy: nil)
       path = '/edges/tcp/%{id}'
       replacements = {
         id: id,
    @@ -1734,6 +1793,7 @@
       data[:hostports] = hostports if hostports
       data[:backend] = backend if backend
       data[:ip_restriction] = ip_restriction if ip_restriction
    +  data[:policy] = policy if policy
       result = @client.patch(path % replacements, data: data)
       NgrokAPI::Models::TCPEdge.new(client: self, attrs: result)
     end
    @@ -1745,7 +1805,7 @@

    - #update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil) ⇒ NgrokAPI::Models::TCPEdge + #update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, policy: nil) ⇒ NgrokAPI::Models::TCPEdge @@ -1868,6 +1928,24 @@ +
  • + + policy + + + (EndpointPolicy) + + + (defaults to: nil) + + + — +
    +

    the traffic policy associated with this edge or null

    +
    + +
  • +

    Returns:

    @@ -1895,25 +1973,26 @@
     
     
    -206
    -207
    -208
    -209
    -210
    -211
    -212
     213
     214
     215
     216
     217
     218
    -219
    +219 +220 +221 +222 +223 +224 +225 +226 +227

    -
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 206
    +      
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 213
     
    -def update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil)
    +def update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, policy: nil)
       path = '/edges/tcp/%{id}'
       replacements = {
         id: id,
    @@ -1924,6 +2003,7 @@
       data[:hostports] = hostports if hostports
       data[:backend] = backend if backend
       data[:ip_restriction] = ip_restriction if ip_restriction
    +  data[:policy] = policy if policy
       result = @client.patch(path % replacements, data: data, danger: true)
       NgrokAPI::Models::TCPEdge.new(client: self, attrs: result)
     end
    @@ -1937,9 +2017,9 @@ diff --git a/doc/NgrokAPI/Services/EdgesTLSClient.html b/doc/NgrokAPI/Services/EdgesTLSClient.html index a7aa0cd..62cb865 100644 --- a/doc/NgrokAPI/Services/EdgesTLSClient.html +++ b/doc/NgrokAPI/Services/EdgesTLSClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgesTLSClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -205,7 +205,7 @@
  • - #create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) ⇒ NgrokAPI::Models::TLSEdge + #create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil) ⇒ NgrokAPI::Models::TLSEdge @@ -229,7 +229,7 @@
  • - #create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) ⇒ NgrokAPI::Models::TLSEdge + #create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil) ⇒ NgrokAPI::Models::TLSEdge @@ -423,7 +423,7 @@
  • - #update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) ⇒ NgrokAPI::Models::TLSEdge + #update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil) ⇒ NgrokAPI::Models::TLSEdge @@ -447,7 +447,7 @@
  • - #update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) ⇒ NgrokAPI::Models::TLSEdge + #update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil) ⇒ NgrokAPI::Models::TLSEdge @@ -573,7 +573,7 @@

    - #create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) ⇒ NgrokAPI::Models::TLSEdge + #create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil) ⇒ NgrokAPI::Models::TLSEdge @@ -704,6 +704,24 @@

  • +
  • + + policy + + + (EndpointPolicy) + + + (defaults to: nil) + + + — +
    +

    the traffic policy associated with this edge or null

    +
    + +
  • +

    Returns:

    @@ -731,7 +749,6 @@
     
     
    -34
     35
     36
     37
    @@ -745,12 +762,14 @@
     45
     46
     47
    -48
    +48 +49 +50
    -
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 34
    +      
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 35
     
    -def create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil)
    +def create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil)
       path = '/edges/tls'
       replacements = {
       }
    @@ -762,6 +781,7 @@
       data[:ip_restriction] = ip_restriction if ip_restriction
       data[:mutual_tls] = mutual_tls if mutual_tls
       data[:tls_termination] = tls_termination if tls_termination
    +  data[:policy] = policy if policy
       result = @client.post(path % replacements, data: data)
       NgrokAPI::Models::TLSEdge.new(client: self, attrs: result)
     end
    @@ -773,7 +793,7 @@

    - #create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) ⇒ NgrokAPI::Models::TLSEdge + #create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil) ⇒ NgrokAPI::Models::TLSEdge @@ -904,6 +924,24 @@ +
  • + + policy + + + (EndpointPolicy) + + + (defaults to: nil) + + + — +
    +

    the traffic policy associated with this edge or null

    +
    + +
  • +

    Returns:

    @@ -931,9 +969,6 @@
     
     
    -64
    -65
    -66
     67
     68
     69
    @@ -945,12 +980,16 @@
     75
     76
     77
    -78
    +78 +79 +80 +81 +82

    -
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 64
    +      
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 67
     
    -def create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil)
    +def create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil)
       path = '/edges/tls'
       replacements = {
       }
    @@ -962,6 +1001,7 @@
       data[:ip_restriction] = ip_restriction if ip_restriction
       data[:mutual_tls] = mutual_tls if mutual_tls
       data[:tls_termination] = tls_termination if tls_termination
    +  data[:policy] = policy if policy
       result = @client.post(path % replacements, data: data, danger: true)
       NgrokAPI::Models::TLSEdge.new(client: self, attrs: result)
     end
    @@ -1038,16 +1078,16 @@
     
     
    -244
    -245
    -246
    -247
    -248
    -249
    -250
    +252 +253 +254 +255 +256 +257 +258
    -
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 244
    +      
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 252
     
     def delete(id: "")
       path = '/edges/tls/%{id}'
    @@ -1129,16 +1169,16 @@
           
     
     
    -260
    -261
    -262
    -263
    -264
    -265
    -266
    +268 +269 +270 +271 +272 +273 +274
    -
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 260
    +      
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 268
     
     def delete!(id: "")
       path = '/edges/tls/%{id}'
    @@ -1220,18 +1260,18 @@
           
     
     
    -87
    -88
    -89
    -90
     91
     92
     93
     94
    -95
    +95 +96 +97 +98 +99
    -
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 87
    +      
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 91
     
     def get(id: "")
       path = '/edges/tls/%{id}'
    @@ -1315,18 +1355,18 @@
           
     
     
    -105
    -106
    -107
    -108
     109
     110
     111
     112
    -113
    +113 +114 +115 +116 +117
    -
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 105
    +      
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 109
     
     def get!(id: "")
       path = '/edges/tls/%{id}'
    @@ -1436,10 +1476,6 @@
           
     
     
    -124
    -125
    -126
    -127
     128
     129
     130
    @@ -1450,10 +1486,14 @@
     135
     136
     137
    -138
    +138 +139 +140 +141 +142
    -
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 124
    +      
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 128
     
     def list(before_id: nil, limit: nil, url: nil)
       result = @client.list(
    @@ -1569,10 +1609,6 @@
           
     
     
    -150
    -151
    -152
    -153
     154
     155
     156
    @@ -1585,10 +1621,14 @@
     163
     164
     165
    -166
    +166 +167 +168 +169 +170
    -
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 150
    +      
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 154
     
     def list!(before_id: nil, limit: nil, url: nil)
       result = @client.list(
    @@ -1615,7 +1655,7 @@
           

    - #update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) ⇒ NgrokAPI::Models::TLSEdge + #update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil) ⇒ NgrokAPI::Models::TLSEdge @@ -1764,6 +1804,24 @@ +
  • + + policy + + + (EndpointPolicy) + + + (defaults to: nil) + + + — +
    +

    the traffic policy associated with this edge or null

    +
    + +
  • +

    Returns:

    @@ -1791,11 +1849,6 @@
     
     
    -185
    -186
    -187
    -188
    -189
     190
     191
     192
    @@ -1806,12 +1859,18 @@
     197
     198
     199
    -200
    +200 +201 +202 +203 +204 +205 +206

    -
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 185
    +      
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 190
     
    -def update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil)
    +def update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil)
       path = '/edges/tls/%{id}'
       replacements = {
         id: id,
    @@ -1824,6 +1883,7 @@
       data[:ip_restriction] = ip_restriction if ip_restriction
       data[:mutual_tls] = mutual_tls if mutual_tls
       data[:tls_termination] = tls_termination if tls_termination
    +  data[:policy] = policy if policy
       result = @client.patch(path % replacements, data: data)
       NgrokAPI::Models::TLSEdge.new(client: self, attrs: result)
     end
    @@ -1835,7 +1895,7 @@

    - #update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) ⇒ NgrokAPI::Models::TLSEdge + #update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil) ⇒ NgrokAPI::Models::TLSEdge @@ -1984,6 +2044,24 @@ +
  • + + policy + + + (EndpointPolicy) + + + (defaults to: nil) + + + — +
    +

    the traffic policy associated with this edge or null

    +
    + +
  • +

    Returns:

    @@ -2011,13 +2089,6 @@
     
     
    -220
    -221
    -222
    -223
    -224
    -225
    -226
     227
     228
     229
    @@ -2026,12 +2097,20 @@
     232
     233
     234
    -235
    +235 +236 +237 +238 +239 +240 +241 +242 +243

    -
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 220
    +      
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 227
     
    -def update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil)
    +def update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil)
       path = '/edges/tls/%{id}'
       replacements = {
         id: id,
    @@ -2044,6 +2123,7 @@
       data[:ip_restriction] = ip_restriction if ip_restriction
       data[:mutual_tls] = mutual_tls if mutual_tls
       data[:tls_termination] = tls_termination if tls_termination
    +  data[:policy] = policy if policy
       result = @client.patch(path % replacements, data: data, danger: true)
       NgrokAPI::Models::TLSEdge.new(client: self, attrs: result)
     end
    @@ -2057,9 +2137,9 @@ diff --git a/doc/NgrokAPI/Services/EndpointsClient.html b/doc/NgrokAPI/Services/EndpointsClient.html index bdfd4d3..2009489 100644 --- a/doc/NgrokAPI/Services/EndpointsClient.html +++ b/doc/NgrokAPI/Services/EndpointsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EndpointsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -893,9 +893,9 @@ diff --git a/doc/NgrokAPI/Services/EventDestinationsClient.html b/doc/NgrokAPI/Services/EventDestinationsClient.html index b4f355e..b168d7d 100644 --- a/doc/NgrokAPI/Services/EventDestinationsClient.html +++ b/doc/NgrokAPI/Services/EventDestinationsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EventDestinationsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1877,9 +1877,9 @@ diff --git a/doc/NgrokAPI/Services/EventSourcesClient.html b/doc/NgrokAPI/Services/EventSourcesClient.html index 337b43b..201f8e7 100644 --- a/doc/NgrokAPI/Services/EventSourcesClient.html +++ b/doc/NgrokAPI/Services/EventSourcesClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EventSourcesClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1661,9 +1661,9 @@ diff --git a/doc/NgrokAPI/Services/EventSubscriptionsClient.html b/doc/NgrokAPI/Services/EventSubscriptionsClient.html index 683db69..ca530e6 100644 --- a/doc/NgrokAPI/Services/EventSubscriptionsClient.html +++ b/doc/NgrokAPI/Services/EventSubscriptionsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EventSubscriptionsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -390,7 +390,7 @@
    -

    List this Account's Event Subscriptions.

    +

    List this Account’s Event Subscriptions.

    @@ -414,7 +414,7 @@
    -

    List this Account's Event Subscriptions.

    +

    List this Account’s Event Subscriptions.

    @@ -1264,7 +1264,7 @@
    -

    List this Account's Event Subscriptions.

    +

    List this Account’s Event Subscriptions.

    ngrok.com/docs/api#api-event-subscriptions-list

    @@ -1397,7 +1397,7 @@
    -

    List this Account's Event Subscriptions. Throws an exception if API error.

    +

    List this Account’s Event Subscriptions. Throws an exception if API error.

    ngrok.com/docs/api#api-event-subscriptions-list

    @@ -1877,9 +1877,9 @@
    diff --git a/doc/NgrokAPI/Services/FailoverBackendsClient.html b/doc/NgrokAPI/Services/FailoverBackendsClient.html index da49cdb..e2e1ad4 100644 --- a/doc/NgrokAPI/Services/FailoverBackendsClient.html +++ b/doc/NgrokAPI/Services/FailoverBackendsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::FailoverBackendsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1789,9 +1789,9 @@
    diff --git a/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html b/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html index 5798a18..48f8729 100644 --- a/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +++ b/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::HTTPResponseBackendsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1927,9 +1927,9 @@ diff --git a/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html b/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html index 8c92901..5d05313 100644 --- a/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +++ b/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::HTTPSEdgeMutualTLSModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1029,9 +1029,9 @@ diff --git a/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html b/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html index 0e08c99..8cb81a4 100644 --- a/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +++ b/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::HTTPSEdgeTLSTerminationModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1029,9 +1029,9 @@ diff --git a/doc/NgrokAPI/Services/IPPoliciesClient.html b/doc/NgrokAPI/Services/IPPoliciesClient.html index 128aa61..adc4fa2 100644 --- a/doc/NgrokAPI/Services/IPPoliciesClient.html +++ b/doc/NgrokAPI/Services/IPPoliciesClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::IPPoliciesClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1709,9 +1709,9 @@ diff --git a/doc/NgrokAPI/Services/IPPolicyRulesClient.html b/doc/NgrokAPI/Services/IPPolicyRulesClient.html index 406bea1..2a664ad 100644 --- a/doc/NgrokAPI/Services/IPPolicyRulesClient.html +++ b/doc/NgrokAPI/Services/IPPolicyRulesClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::IPPolicyRulesClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1857,9 +1857,9 @@ diff --git a/doc/NgrokAPI/Services/IPRestrictionsClient.html b/doc/NgrokAPI/Services/IPRestrictionsClient.html index 999097f..2d45f0a 100644 --- a/doc/NgrokAPI/Services/IPRestrictionsClient.html +++ b/doc/NgrokAPI/Services/IPRestrictionsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::IPRestrictionsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1901,9 +1901,9 @@ diff --git a/doc/NgrokAPI/Services/ReservedAddrsClient.html b/doc/NgrokAPI/Services/ReservedAddrsClient.html index 308c5a5..ca0e619 100644 --- a/doc/NgrokAPI/Services/ReservedAddrsClient.html +++ b/doc/NgrokAPI/Services/ReservedAddrsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::ReservedAddrsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1749,9 +1749,9 @@ diff --git a/doc/NgrokAPI/Services/ReservedDomainsClient.html b/doc/NgrokAPI/Services/ReservedDomainsClient.html index 990873a..98c6f9b 100644 --- a/doc/NgrokAPI/Services/ReservedDomainsClient.html +++ b/doc/NgrokAPI/Services/ReservedDomainsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::ReservedDomainsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -102,7 +102,7 @@

    Overview

    -

    Reserved Domains are hostnames that you can listen for traffic on. Domains can be used to listen for http, https or tls traffic. You may use a domain that you own by creating a CNAME record specified in the returned resource. This CNAME record points traffic for that domain to ngrok's edge servers.

    +

    Reserved Domains are hostnames that you can listen for traffic on. Domains can be used to listen for http, https or tls traffic. You may use a domain that you own by creating a CNAME record specified in the returned resource. This CNAME record points traffic for that domain to ngrok’s edge servers.

    ngrok.com/docs/api#api-reserved-domains

    @@ -722,7 +722,7 @@ —
    -

    reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)

    +

    deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa)

    @@ -917,7 +917,7 @@ —
    -

    reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)

    +

    deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa)

    @@ -2409,9 +2409,9 @@
    diff --git a/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html b/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html index feeb77f..b8c715a 100644 --- a/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +++ b/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::SSHCertificateAuthoritiesClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1829,9 +1829,9 @@ diff --git a/doc/NgrokAPI/Services/SSHCredentialsClient.html b/doc/NgrokAPI/Services/SSHCredentialsClient.html index b3b9603..8b61455 100644 --- a/doc/NgrokAPI/Services/SSHCredentialsClient.html +++ b/doc/NgrokAPI/Services/SSHCredentialsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::SSHCredentialsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -584,7 +584,7 @@
    -

    Create a new ssh_credential from an uploaded public SSH key. This ssh credential can be used to start new tunnels via ngrok's SSH gateway.

    +

    Create a new ssh_credential from an uploaded public SSH key. This ssh credential can be used to start new tunnels via ngrok’s SSH gateway.

    ngrok.com/docs/api#api-ssh-credentials-create

    @@ -757,7 +757,7 @@
    -

    Create a new ssh_credential from an uploaded public SSH key. This ssh credential can be used to start new tunnels via ngrok's SSH gateway. Throws an exception if API error.

    +

    Create a new ssh_credential from an uploaded public SSH key. This ssh credential can be used to start new tunnels via ngrok’s SSH gateway. Throws an exception if API error.

    ngrok.com/docs/api#api-ssh-credentials-create

    @@ -1865,9 +1865,9 @@
    diff --git a/doc/NgrokAPI/Services/SSHHostCertificatesClient.html b/doc/NgrokAPI/Services/SSHHostCertificatesClient.html index 3b05917..e3e18f3 100644 --- a/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +++ b/doc/NgrokAPI/Services/SSHHostCertificatesClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::SSHHostCertificatesClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1901,9 +1901,9 @@
    diff --git a/doc/NgrokAPI/Services/SSHUserCertificatesClient.html b/doc/NgrokAPI/Services/SSHUserCertificatesClient.html index c6e0d9f..8fcf5f3 100644 --- a/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +++ b/doc/NgrokAPI/Services/SSHUserCertificatesClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::SSHUserCertificatesClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -658,7 +658,7 @@ —
    -

    A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>_ for additional details.

    +

    A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>_ for additional details.

    @@ -676,7 +676,7 @@ —
    -

    A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>_ for additional details.

    +

    A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>_ for additional details.

    @@ -909,7 +909,7 @@ —
    -

    A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>_ for additional details.

    +

    A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>_ for additional details.

    @@ -927,7 +927,7 @@ —
    -

    A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>_ for additional details.

    +

    A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>_ for additional details.

    @@ -1981,9 +1981,9 @@ diff --git a/doc/NgrokAPI/Services/StaticBackendsClient.html b/doc/NgrokAPI/Services/StaticBackendsClient.html new file mode 100644 index 0000000..de247d8 --- /dev/null +++ b/doc/NgrokAPI/Services/StaticBackendsClient.html @@ -0,0 +1,1879 @@ + + + + + + + Class: NgrokAPI::Services::StaticBackendsClient + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: NgrokAPI::Services::StaticBackendsClient + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/services/static_backends_client.rb
    +
    + +
    + +

    Overview

    +
    + +

    A static backend sends traffic to a TCP address (hostname and port) that is reachable on the public internet.

    + +

    ngrok.com/docs/api#api-static-backends

    + + +
    +
    +
    + + +
    + +

    + Constant Summary + collapse +

    + +
    + +
    PATH = +
    +
    + +

    The API path for the requests

    + + +
    +
    +
    + + +
    +
    +
    '/backends/static'
    + +
    LIST_PROPERTY = +
    +
    + +

    The List Property from the resulting API for list calls

    + + +
    +
    +
    + + +
    +
    +
    'backends'
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client:) ⇒ StaticBackendsClient + + + + + +

    +
    + +

    Returns a new instance of StaticBackendsClient.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +20
    +21
    +22
    +
    +
    # File 'lib/ngrokapi/services/static_backends_client.rb', line 20
    +
    +def initialize(client:)
    +  @client = client
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +18
    +19
    +20
    +
    +
    # File 'lib/ngrokapi/services/static_backends_client.rb', line 18
    +
    +def client
    +  @client
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #create(description: "", metadata: "", address: "", tls: nil) ⇒ NgrokAPI::Models::StaticBackend + + + + + +

    +
    + +

    Create a new static backend

    + +

    ngrok.com/docs/api#api-static-backends-create

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + description + + + (string) + + + (defaults to: "") + + + — +
      +

      human-readable description of this backend. Optional

      +
      + +
    • + +
    • + + metadata + + + (string) + + + (defaults to: "") + + + — +
      +

      arbitrary user-defined machine-readable data of this backend. Optional

      +
      + +
    • + +
    • + + address + + + (string) + + + (defaults to: "") + + + — +
      +

      the address to forward to

      +
      + +
    • + +
    • + + tls + + + (StaticBackendTLS) + + + (defaults to: nil) + + + — +
      +

      tls configuration to use

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +34
    +35
    +36
    +37
    +38
    +39
    +40
    +41
    +42
    +43
    +44
    +45
    +
    +
    # File 'lib/ngrokapi/services/static_backends_client.rb', line 34
    +
    +def create(description: "", metadata: "", address: "", tls: nil)
    +  path = '/backends/static'
    +  replacements = {
    +  }
    +  data = {}
    +  data[:description] = description if description
    +  data[:metadata] =  if 
    +  data[:address] = address if address
    +  data[:tls] = tls if tls
    +  result = @client.post(path % replacements, data: data)
    +  NgrokAPI::Models::StaticBackend.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #create!(description: "", metadata: "", address: "", tls: nil) ⇒ NgrokAPI::Models::StaticBackend + + + + + +

    +
    + +

    Create a new static backend Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-static-backends-create

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + description + + + (string) + + + (defaults to: "") + + + — +
      +

      human-readable description of this backend. Optional

      +
      + +
    • + +
    • + + metadata + + + (string) + + + (defaults to: "") + + + — +
      +

      arbitrary user-defined machine-readable data of this backend. Optional

      +
      + +
    • + +
    • + + address + + + (string) + + + (defaults to: "") + + + — +
      +

      the address to forward to

      +
      + +
    • + +
    • + + tls + + + (StaticBackendTLS) + + + (defaults to: nil) + + + — +
      +

      tls configuration to use

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +58
    +59
    +60
    +61
    +62
    +63
    +64
    +65
    +66
    +67
    +68
    +69
    +
    +
    # File 'lib/ngrokapi/services/static_backends_client.rb', line 58
    +
    +def create!(description: "", metadata: "", address: "", tls: nil)
    +  path = '/backends/static'
    +  replacements = {
    +  }
    +  data = {}
    +  data[:description] = description if description
    +  data[:metadata] =  if 
    +  data[:address] = address if address
    +  data[:tls] = tls if tls
    +  result = @client.post(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::StaticBackend.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #delete(id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    + +

    Delete a static backend by ID.

    + +

    ngrok.com/docs/api#api-static-backends-delete

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +78
    +79
    +80
    +81
    +82
    +83
    +84
    +
    +
    # File 'lib/ngrokapi/services/static_backends_client.rb', line 78
    +
    +def delete(id: "")
    +  path = '/backends/static/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  @client.delete(path % replacements)
    +end
    +
    +
    + +
    +

    + + #delete!(id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    + +

    Delete a static backend by ID. Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-static-backends-delete

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +94
    +95
    +96
    +97
    +98
    +99
    +100
    +
    +
    # File 'lib/ngrokapi/services/static_backends_client.rb', line 94
    +
    +def delete!(id: "")
    +  path = '/backends/static/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  @client.delete(path % replacements, danger: true)
    +end
    +
    +
    + +
    +

    + + #get(id: "") ⇒ NgrokAPI::Models::StaticBackend + + + + + +

    +
    + +

    Get detailed information about a static backend by ID

    + +

    ngrok.com/docs/api#api-static-backends-get

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +109
    +110
    +111
    +112
    +113
    +114
    +115
    +116
    +117
    +
    +
    # File 'lib/ngrokapi/services/static_backends_client.rb', line 109
    +
    +def get(id: "")
    +  path = '/backends/static/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data)
    +  NgrokAPI::Models::StaticBackend.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #get!(id: "") ⇒ NgrokAPI::Models::StaticBackend + + + + + +

    +
    + +

    Get detailed information about a static backend by ID Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-static-backends-get

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +127
    +128
    +129
    +130
    +131
    +132
    +133
    +134
    +135
    +
    +
    # File 'lib/ngrokapi/services/static_backends_client.rb', line 127
    +
    +def get!(id: "")
    +  path = '/backends/static/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::StaticBackend.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable + + + + + +

    +
    + +

    List all static backends on this account

    + +

    ngrok.com/docs/api#api-static-backends-list

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + before_id + + + (string) + + + (defaults to: nil) + + +
    • + +
    • + + limit + + + (string) + + + (defaults to: nil) + + +
    • + +
    • + + url + + + (string) + + + (defaults to: nil) + + + — +
      +

      optional and mutually exclusive from before_id and limit

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +146
    +147
    +148
    +149
    +150
    +151
    +152
    +153
    +154
    +155
    +156
    +157
    +158
    +159
    +160
    +
    +
    # File 'lib/ngrokapi/services/static_backends_client.rb', line 146
    +
    +def list(before_id: nil, limit: nil, url: nil)
    +  result = @client.list(
    +    before_id: before_id,
    +    limit: limit,
    +    url: url,
    +    path: PATH
    +  )
    +
    +  NgrokAPI::Models::Listable.new(
    +    client: self,
    +    attrs: result,
    +    list_property: LIST_PROPERTY,
    +    klass: NgrokAPI::Models::StaticBackend
    +  )
    +end
    +
    +
    + +
    +

    + + #list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable + + + + + +

    +
    + +

    List all static backends on this account Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-static-backends-list

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + before_id + + + (string) + + + (defaults to: nil) + + +
    • + +
    • + + limit + + + (string) + + + (defaults to: nil) + + +
    • + +
    • + + url + + + (string) + + + (defaults to: nil) + + + — +
      +

      optional and mutually exclusive from before_id and limit

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +172
    +173
    +174
    +175
    +176
    +177
    +178
    +179
    +180
    +181
    +182
    +183
    +184
    +185
    +186
    +187
    +188
    +
    +
    # File 'lib/ngrokapi/services/static_backends_client.rb', line 172
    +
    +def list!(before_id: nil, limit: nil, url: nil)
    +  result = @client.list(
    +    before_id: before_id,
    +    limit: limit,
    +    danger: true,
    +    url: url,
    +    path: PATH
    +  )
    +
    +  NgrokAPI::Models::Listable.new(
    +    client: self,
    +    attrs: result,
    +    list_property: LIST_PROPERTY,
    +    klass: NgrokAPI::Models::StaticBackend,
    +    danger: true
    +  )
    +end
    +
    +
    + +
    +

    + + #update(id: "", description: nil, metadata: nil, address: "", tls: nil) ⇒ NgrokAPI::Models::StaticBackend + + + + + +

    +
    + +

    Update static backend by ID

    + +

    ngrok.com/docs/api#api-static-backends-update

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + description + + + (string) + + + (defaults to: nil) + + + — +
      +

      human-readable description of this backend. Optional

      +
      + +
    • + +
    • + + metadata + + + (string) + + + (defaults to: nil) + + + — +
      +

      arbitrary user-defined machine-readable data of this backend. Optional

      +
      + +
    • + +
    • + + address + + + (string) + + + (defaults to: "") + + + — +
      +

      the address to forward to

      +
      + +
    • + +
    • + + tls + + + (StaticBackendTLS) + + + (defaults to: nil) + + + — +
      +

      tls configuration to use

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +201
    +202
    +203
    +204
    +205
    +206
    +207
    +208
    +209
    +210
    +211
    +212
    +213
    +
    +
    # File 'lib/ngrokapi/services/static_backends_client.rb', line 201
    +
    +def update(id: "", description: nil, metadata: nil, address: "", tls: nil)
    +  path = '/backends/static/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  data[:description] = description if description
    +  data[:metadata] =  if 
    +  data[:address] = address if address
    +  data[:tls] = tls if tls
    +  result = @client.patch(path % replacements, data: data)
    +  NgrokAPI::Models::StaticBackend.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #update!(id: "", description: nil, metadata: nil, address: "", tls: nil) ⇒ NgrokAPI::Models::StaticBackend + + + + + +

    +
    + +

    Update static backend by ID Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-static-backends-update

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + description + + + (string) + + + (defaults to: nil) + + + — +
      +

      human-readable description of this backend. Optional

      +
      + +
    • + +
    • + + metadata + + + (string) + + + (defaults to: nil) + + + — +
      +

      arbitrary user-defined machine-readable data of this backend. Optional

      +
      + +
    • + +
    • + + address + + + (string) + + + (defaults to: "") + + + — +
      +

      the address to forward to

      +
      + +
    • + +
    • + + tls + + + (StaticBackendTLS) + + + (defaults to: nil) + + + — +
      +

      tls configuration to use

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +227
    +228
    +229
    +230
    +231
    +232
    +233
    +234
    +235
    +236
    +237
    +238
    +239
    +
    +
    # File 'lib/ngrokapi/services/static_backends_client.rb', line 227
    +
    +def update!(id: "", description: nil, metadata: nil, address: "", tls: nil)
    +  path = '/backends/static/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  data[:description] = description if description
    +  data[:metadata] =  if 
    +  data[:address] = address if address
    +  data[:tls] = tls if tls
    +  result = @client.patch(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::StaticBackend.new(client: self, attrs: result)
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html b/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html index 6fb3ca9..5f19577 100644 --- a/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +++ b/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::TCPEdgeBackendModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1029,9 +1029,9 @@ diff --git a/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html b/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html index f2491d8..e794218 100644 --- a/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +++ b/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::TCPEdgeIPRestrictionModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1029,9 +1029,9 @@ diff --git a/doc/NgrokAPI/Services/TCPEdgePolicyModuleClient.html b/doc/NgrokAPI/Services/TCPEdgePolicyModuleClient.html new file mode 100644 index 0000000..080d60f --- /dev/null +++ b/doc/NgrokAPI/Services/TCPEdgePolicyModuleClient.html @@ -0,0 +1,1039 @@ + + + + + + + Class: NgrokAPI::Services::TCPEdgePolicyModuleClient + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: NgrokAPI::Services::TCPEdgePolicyModuleClient + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/services/tcp_edge_policy_module_client.rb
    +
    + +
    + +

    Overview

    +
    + + +
    + +

    + Constant Summary + collapse +

    + +
    + +
    PATH = +
    +
    + +

    The API path for the requests

    + + +
    +
    +
    + + +
    +
    +
    '/edges/tcp/%{id}/policy'
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client:) ⇒ TCPEdgePolicyModuleClient + + + + + +

    +
    + +

    Returns a new instance of TCPEdgePolicyModuleClient.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +15
    +16
    +17
    +
    +
    # File 'lib/ngrokapi/services/tcp_edge_policy_module_client.rb', line 15
    +
    +def initialize(client:)
    +  @client = client
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +13
    +14
    +15
    +
    +
    # File 'lib/ngrokapi/services/tcp_edge_policy_module_client.rb', line 13
    +
    +def client
    +  @client
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #delete(id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +86
    +87
    +88
    +89
    +90
    +91
    +92
    +
    +
    # File 'lib/ngrokapi/services/tcp_edge_policy_module_client.rb', line 86
    +
    +def delete(id: "")
    +  path = '/edges/tcp/%{id}/policy'
    +  replacements = {
    +    id: id,
    +  }
    +  @client.delete(path % replacements)
    +end
    +
    +
    + +
    +

    + + #delete!(id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +99
    +100
    +101
    +102
    +103
    +104
    +105
    +
    +
    # File 'lib/ngrokapi/services/tcp_edge_policy_module_client.rb', line 99
    +
    +def delete!(id: "")
    +  path = '/edges/tcp/%{id}/policy'
    +  replacements = {
    +    id: id,
    +  }
    +  @client.delete(path % replacements, danger: true)
    +end
    +
    +
    + +
    +

    + + #get(id: "") ⇒ NgrokAPI::Models::EndpointPolicy + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +56
    +57
    +58
    +59
    +60
    +61
    +62
    +63
    +64
    +
    +
    # File 'lib/ngrokapi/services/tcp_edge_policy_module_client.rb', line 56
    +
    +def get(id: "")
    +  path = '/edges/tcp/%{id}/policy'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data)
    +  NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #get!(id: "") ⇒ NgrokAPI::Models::EndpointPolicy + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +71
    +72
    +73
    +74
    +75
    +76
    +77
    +78
    +79
    +
    +
    # File 'lib/ngrokapi/services/tcp_edge_policy_module_client.rb', line 71
    +
    +def get!(id: "")
    +  path = '/edges/tcp/%{id}/policy'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #replace(id: "", a_module: nil) ⇒ NgrokAPI::Models::EndpointPolicy + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + a_module + + + (EndpointPolicy) + + + (defaults to: nil) + + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +25
    +26
    +27
    +28
    +29
    +30
    +31
    +32
    +33
    +
    +
    # File 'lib/ngrokapi/services/tcp_edge_policy_module_client.rb', line 25
    +
    +def replace(id: "", a_module: nil)
    +  path = '/edges/tcp/%{id}/policy'
    +  replacements = {
    +    id: id,
    +  }
    +  data = a_module
    +  result = @client.put(path % replacements, data: data)
    +  NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #replace!(id: "", a_module: nil) ⇒ NgrokAPI::Models::EndpointPolicy + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + a_module + + + (EndpointPolicy) + + + (defaults to: nil) + + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +41
    +42
    +43
    +44
    +45
    +46
    +47
    +48
    +49
    +
    +
    # File 'lib/ngrokapi/services/tcp_edge_policy_module_client.rb', line 41
    +
    +def replace!(id: "", a_module: nil)
    +  path = '/edges/tcp/%{id}/policy'
    +  replacements = {
    +    id: id,
    +  }
    +  data = a_module
    +  result = @client.put(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/doc/NgrokAPI/Services/TLSCertificatesClient.html b/doc/NgrokAPI/Services/TLSCertificatesClient.html index 5b797a2..a3602b5 100644 --- a/doc/NgrokAPI/Services/TLSCertificatesClient.html +++ b/doc/NgrokAPI/Services/TLSCertificatesClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::TLSCertificatesClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -642,7 +642,7 @@ —
    -

    chain of PEM-encoded certificates, leaf first. See Certificate Bundles <https://ngrok.com/docs/cloud-edge/endpoints#certificate-chains>_.

    +

    chain of PEM-encoded certificates, leaf first. See Certificate Bundles <https://ngrok.com/docs/cloud-edge/endpoints#certificate-chains>_.

    @@ -658,7 +658,7 @@ —
    -

    private key for the TLS certificate, PEM-encoded. See Private Keys <https://ngrok.com/docs/cloud-edge/endpoints#private-keys>_.

    +

    private key for the TLS certificate, PEM-encoded. See Private Keys <https://ngrok.com/docs/cloud-edge/endpoints#private-keys>_.

    @@ -793,7 +793,7 @@ —
    -

    chain of PEM-encoded certificates, leaf first. See Certificate Bundles <https://ngrok.com/docs/cloud-edge/endpoints#certificate-chains>_.

    +

    chain of PEM-encoded certificates, leaf first. See Certificate Bundles <https://ngrok.com/docs/cloud-edge/endpoints#certificate-chains>_.

    @@ -809,7 +809,7 @@ —
    -

    private key for the TLS certificate, PEM-encoded. See Private Keys <https://ngrok.com/docs/cloud-edge/endpoints#private-keys>_.

    +

    private key for the TLS certificate, PEM-encoded. See Private Keys <https://ngrok.com/docs/cloud-edge/endpoints#private-keys>_.

    @@ -1781,9 +1781,9 @@ diff --git a/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html b/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html index 210e5d5..e28560a 100644 --- a/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +++ b/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::TLSEdgeBackendModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1029,9 +1029,9 @@ diff --git a/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html b/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html index 00a6ff5..98ec1e4 100644 --- a/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +++ b/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::TLSEdgeIPRestrictionModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1029,9 +1029,9 @@ diff --git a/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html b/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html index b5dc2e7..ba6d9bd 100644 --- a/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +++ b/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::TLSEdgeMutualTLSModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1029,9 +1029,9 @@ diff --git a/doc/NgrokAPI/Services/TLSEdgePolicyModuleClient.html b/doc/NgrokAPI/Services/TLSEdgePolicyModuleClient.html new file mode 100644 index 0000000..5a864d2 --- /dev/null +++ b/doc/NgrokAPI/Services/TLSEdgePolicyModuleClient.html @@ -0,0 +1,1039 @@ + + + + + + + Class: NgrokAPI::Services::TLSEdgePolicyModuleClient + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: NgrokAPI::Services::TLSEdgePolicyModuleClient + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/services/tls_edge_policy_module_client.rb
    +
    + +
    + +

    Overview

    +
    + + +
    + +

    + Constant Summary + collapse +

    + +
    + +
    PATH = +
    +
    + +

    The API path for the requests

    + + +
    +
    +
    + + +
    +
    +
    '/edges/tls/%{id}/policy'
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client:) ⇒ TLSEdgePolicyModuleClient + + + + + +

    +
    + +

    Returns a new instance of TLSEdgePolicyModuleClient.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +15
    +16
    +17
    +
    +
    # File 'lib/ngrokapi/services/tls_edge_policy_module_client.rb', line 15
    +
    +def initialize(client:)
    +  @client = client
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +13
    +14
    +15
    +
    +
    # File 'lib/ngrokapi/services/tls_edge_policy_module_client.rb', line 13
    +
    +def client
    +  @client
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #delete(id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +86
    +87
    +88
    +89
    +90
    +91
    +92
    +
    +
    # File 'lib/ngrokapi/services/tls_edge_policy_module_client.rb', line 86
    +
    +def delete(id: "")
    +  path = '/edges/tls/%{id}/policy'
    +  replacements = {
    +    id: id,
    +  }
    +  @client.delete(path % replacements)
    +end
    +
    +
    + +
    +

    + + #delete!(id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +99
    +100
    +101
    +102
    +103
    +104
    +105
    +
    +
    # File 'lib/ngrokapi/services/tls_edge_policy_module_client.rb', line 99
    +
    +def delete!(id: "")
    +  path = '/edges/tls/%{id}/policy'
    +  replacements = {
    +    id: id,
    +  }
    +  @client.delete(path % replacements, danger: true)
    +end
    +
    +
    + +
    +

    + + #get(id: "") ⇒ NgrokAPI::Models::EndpointPolicy + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +56
    +57
    +58
    +59
    +60
    +61
    +62
    +63
    +64
    +
    +
    # File 'lib/ngrokapi/services/tls_edge_policy_module_client.rb', line 56
    +
    +def get(id: "")
    +  path = '/edges/tls/%{id}/policy'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data)
    +  NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #get!(id: "") ⇒ NgrokAPI::Models::EndpointPolicy + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +71
    +72
    +73
    +74
    +75
    +76
    +77
    +78
    +79
    +
    +
    # File 'lib/ngrokapi/services/tls_edge_policy_module_client.rb', line 71
    +
    +def get!(id: "")
    +  path = '/edges/tls/%{id}/policy'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #replace(id: "", a_module: nil) ⇒ NgrokAPI::Models::EndpointPolicy + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + a_module + + + (EndpointPolicy) + + + (defaults to: nil) + + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +25
    +26
    +27
    +28
    +29
    +30
    +31
    +32
    +33
    +
    +
    # File 'lib/ngrokapi/services/tls_edge_policy_module_client.rb', line 25
    +
    +def replace(id: "", a_module: nil)
    +  path = '/edges/tls/%{id}/policy'
    +  replacements = {
    +    id: id,
    +  }
    +  data = a_module
    +  result = @client.put(path % replacements, data: data)
    +  NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #replace!(id: "", a_module: nil) ⇒ NgrokAPI::Models::EndpointPolicy + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + a_module + + + (EndpointPolicy) + + + (defaults to: nil) + + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +41
    +42
    +43
    +44
    +45
    +46
    +47
    +48
    +49
    +
    +
    # File 'lib/ngrokapi/services/tls_edge_policy_module_client.rb', line 41
    +
    +def replace!(id: "", a_module: nil)
    +  path = '/edges/tls/%{id}/policy'
    +  replacements = {
    +    id: id,
    +  }
    +  data = a_module
    +  result = @client.put(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html b/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html index b4d295d..052431b 100644 --- a/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +++ b/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::TLSEdgeTLSTerminationModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1029,9 +1029,9 @@ diff --git a/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html b/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html index 786a877..34cbe87 100644 --- a/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +++ b/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::TunnelGroupBackendsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1789,9 +1789,9 @@ diff --git a/doc/NgrokAPI/Services/TunnelSessionsClient.html b/doc/NgrokAPI/Services/TunnelSessionsClient.html index 654935b..70e09c4 100644 --- a/doc/NgrokAPI/Services/TunnelSessionsClient.html +++ b/doc/NgrokAPI/Services/TunnelSessionsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::TunnelSessionsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1408,7 +1408,7 @@
    -

    Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent's configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted

    +

    Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent’s configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted

    ngrok.com/docs/api#api-tunnel-sessions-update

    @@ -1494,7 +1494,7 @@
    -

    Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent's configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted Throws an exception if API error.

    +

    Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent’s configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted Throws an exception if API error.

    ngrok.com/docs/api#api-tunnel-sessions-update

    @@ -1573,9 +1573,9 @@
    diff --git a/doc/NgrokAPI/Services/TunnelsClient.html b/doc/NgrokAPI/Services/TunnelsClient.html index 39fb2cc..9035180 100644 --- a/doc/NgrokAPI/Services/TunnelsClient.html +++ b/doc/NgrokAPI/Services/TunnelsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::TunnelsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -893,9 +893,9 @@
    diff --git a/doc/NgrokAPI/Services/WeightedBackendsClient.html b/doc/NgrokAPI/Services/WeightedBackendsClient.html index a9d5410..dca86e9 100644 --- a/doc/NgrokAPI/Services/WeightedBackendsClient.html +++ b/doc/NgrokAPI/Services/WeightedBackendsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::WeightedBackendsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -102,7 +102,7 @@

    Overview

    -

    A Weighted Backend balances traffic among the referenced backends. Traffic is assigned proportionally to each based on its weight. The percentage of traffic is calculated by dividing a backend's weight by the sum of all weights.

    +

    A Weighted Backend balances traffic among the referenced backends. Traffic is assigned proportionally to each based on its weight. The percentage of traffic is calculated by dividing a backend’s weight by the sum of all weights.

    ngrok.com/docs/api#api-weighted-backends

    @@ -1789,9 +1789,9 @@
    diff --git a/doc/_index.html b/doc/_index.html index 294b44d..f077f4b 100644 --- a/doc/_index.html +++ b/doc/_index.html @@ -4,7 +4,7 @@ - Documentation by YARD 0.9.34 + Documentation by YARD 0.9.36 @@ -52,7 +52,7 @@
    -

    Documentation by YARD 0.9.34

    +

    Documentation by YARD 0.9.36

    Alphabetic Index

    @@ -307,6 +307,13 @@ +
  • + EdgeRoutePolicyModuleClient + + (NgrokAPI::Services) + +
  • +
  • EdgeRouteRequestHeadersModuleClient @@ -328,6 +335,13 @@
  • +
  • + EdgeRouteUserAgentFilterModuleClient + + (NgrokAPI::Services) + +
  • +
  • EdgeRouteWebhookVerificationModuleClient @@ -377,6 +391,13 @@
  • +
  • + EndpointAction + + (NgrokAPI::Models) + +
  • +
  • EndpointBackend @@ -510,6 +531,13 @@
  • +
  • + EndpointPolicy + + (NgrokAPI::Models) + +
  • +
  • EndpointRequestHeaders @@ -524,6 +552,13 @@
  • +
  • + EndpointRule + + (NgrokAPI::Models) + +
  • +
  • EndpointSAML @@ -552,6 +587,13 @@
  • +
  • + EndpointUserAgentFilter + + (NgrokAPI::Models) + +
  • +
  • EndpointWebhookValidation @@ -1024,6 +1066,27 @@
  • +
  • + StaticBackend + + (NgrokAPI::Models) + +
  • + +
  • + StaticBackendTLS + + (NgrokAPI::Models) + +
  • + +
  • + StaticBackendsClient + + (NgrokAPI::Services) + +
  • + @@ -1053,6 +1116,13 @@ +
  • + TCPEdgePolicyModuleClient + + (NgrokAPI::Services) + +
  • +
  • TLSCertificate @@ -1102,6 +1172,13 @@
  • +
  • + TLSEdgePolicyModuleClient + + (NgrokAPI::Services) + +
  • +
  • TLSEdgeTLSTerminationModuleClient @@ -1203,9 +1280,9 @@
  • diff --git a/doc/class_list.html b/doc/class_list.html index 4ad7273..6c9277a 100644 --- a/doc/class_list.html +++ b/doc/class_list.html @@ -43,7 +43,7 @@
    diff --git a/doc/file.README.html b/doc/file.README.html index d046120..a0433cf 100644 --- a/doc/file.README.html +++ b/doc/file.README.html @@ -6,7 +6,7 @@ File: README - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -147,9 +147,9 @@ diff --git a/doc/frames.html b/doc/frames.html index 4f918f5..53734c2 100644 --- a/doc/frames.html +++ b/doc/frames.html @@ -2,13 +2,18 @@ - Documentation by YARD 0.9.34 + Documentation by YARD 0.9.36
    +225 +226
    # File 'lib/ngrokapi/client.rb', line 217
    @@ -1041,6 +1042,7 @@
       ns = OpenStruct.new
       ns.failover = NgrokAPI::Services::FailoverBackendsClient.new(client: @client)
       ns.http_response = NgrokAPI::Services::HTTPResponseBackendsClient.new(client: @client)
    +  ns.static_address = NgrokAPI::Services::StaticBackendsClient.new(client: @client)
       ns.tunnel_group = NgrokAPI::Services::TunnelGroupBackendsClient.new(client: @client)
       ns.weighted = NgrokAPI::Services::WeightedBackendsClient.new(client: @client)
     
    @@ -1174,7 +1176,6 @@
           
     
     
    -237
     238
     239
     240
    @@ -1197,10 +1198,12 @@
     257
     258
     259
    -260
    +260 +261 +262
    -
    # File 'lib/ngrokapi/client.rb', line 237
    +      
    # File 'lib/ngrokapi/client.rb', line 238
     
     def edge_modules
       ns = OpenStruct.new
    @@ -1217,6 +1220,7 @@
       ns.https_edge_route_saml = NgrokAPI::Services::EdgeRouteSAMLModuleClient.new(client: @client)
       ns.https_edge_route_oidc = NgrokAPI::Services::EdgeRouteOIDCModuleClient.new(client: @client)
       ns.https_edge_route_websocket_tcp_converter = NgrokAPI::Services::EdgeRouteWebsocketTCPConverterModuleClient.new(client: @client)
    +  ns.https_edge_route_user_agent_filter = NgrokAPI::Services::EdgeRouteUserAgentFilterModuleClient.new(client: @client)
       ns.tcp_edge_backend = NgrokAPI::Services::TCPEdgeBackendModuleClient.new(client: @client)
       ns.tcp_edge_ip_restriction = NgrokAPI::Services::TCPEdgeIPRestrictionModuleClient.new(client: @client)
       ns.tls_edge_backend = NgrokAPI::Services::TLSEdgeBackendModuleClient.new(client: @client)
    @@ -1246,7 +1250,6 @@
           
     
     
    -227
     228
     229
     230
    @@ -1254,10 +1257,11 @@
     232
     233
     234
    -235
    +235 +236
    -
    # File 'lib/ngrokapi/client.rb', line 227
    +      
    # File 'lib/ngrokapi/client.rb', line 228
     
     def edges
       ns = OpenStruct.new
    @@ -1645,7 +1649,7 @@
     
    -

    Reserved Domains are hostnames that you can listen for traffic on. Domains can be used to listen for http, https or tls traffic. You may use a domain that you own by creating a CNAME record specified in the returned resource. This CNAME record points traffic for that domain to ngrok's edge servers.

    +

    Reserved Domains are hostnames that you can listen for traffic on. Domains can be used to listen for http, https or tls traffic. You may use a domain that you own by creating a CNAME record specified in the returned resource. This CNAME record points traffic for that domain to ngrok’s edge servers.

    @@ -2070,9 +2074,9 @@
    diff --git a/docs/NgrokAPI/Error.html b/docs/NgrokAPI/Error.html index 36dbb60..a970820 100644 --- a/docs/NgrokAPI/Error.html +++ b/docs/NgrokAPI/Error.html @@ -6,7 +6,7 @@ Exception: NgrokAPI::Error - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -295,9 +295,9 @@ diff --git a/docs/NgrokAPI/Errors.html b/docs/NgrokAPI/Errors.html index f943d8d..5fe14a4 100644 --- a/docs/NgrokAPI/Errors.html +++ b/docs/NgrokAPI/Errors.html @@ -6,7 +6,7 @@ Module: NgrokAPI::Errors - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -105,9 +105,9 @@ diff --git a/docs/NgrokAPI/Errors/NotFoundError.html b/docs/NgrokAPI/Errors/NotFoundError.html index 13e59e0..1c2e0c6 100644 --- a/docs/NgrokAPI/Errors/NotFoundError.html +++ b/docs/NgrokAPI/Errors/NotFoundError.html @@ -6,7 +6,7 @@ Exception: NgrokAPI::Errors::NotFoundError - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -299,9 +299,9 @@ diff --git a/docs/NgrokAPI/HttpClient.html b/docs/NgrokAPI/HttpClient.html index 9692928..c098dbb 100644 --- a/docs/NgrokAPI/HttpClient.html +++ b/docs/NgrokAPI/HttpClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::HttpClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -102,7 +102,7 @@

    Overview

    -

    Low-level api client for communicating with Ngrok's HTTP API using HTTP. You should not have to use this class directly, but use the individual clients to make your API calls.

    +

    Low-level api client for communicating with Ngrok’s HTTP API using HTTP. You should not have to use this class directly, but use the individual clients to make your API calls.

    @@ -1267,9 +1267,9 @@
    diff --git a/docs/NgrokAPI/Models.html b/docs/NgrokAPI/Models.html index 8a8a87b..dc16213 100644 --- a/docs/NgrokAPI/Models.html +++ b/docs/NgrokAPI/Models.html @@ -6,7 +6,7 @@ Module: NgrokAPI::Models - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -79,7 +79,7 @@
    Defined in:
    lib/ngrokapi/models/ref.rb,
    - lib/ngrokapi/models/tunnel.rb,
    lib/ngrokapi/models/api_key.rb,
    lib/ngrokapi/models/aws_auth.rb,
    lib/ngrokapi/models/aws_role.rb,
    lib/ngrokapi/models/endpoint.rb,
    lib/ngrokapi/models/listable.rb,
    lib/ngrokapi/models/location.rb,
    lib/ngrokapi/models/tcp_edge.rb,
    lib/ngrokapi/models/tls_edge.rb,
    lib/ngrokapi/models/ip_policy.rb,
    lib/ngrokapi/models/credential.rb,
    lib/ngrokapi/models/https_edge.rb,
    lib/ngrokapi/models/user_agent.rb,
    lib/ngrokapi/models/abuse_report.rb,
    lib/ngrokapi/models/event_source.rb,
    lib/ngrokapi/models/event_target.rb,
    lib/ngrokapi/models/agent_ingress.rb,
    lib/ngrokapi/models/endpoint_oidc.rb,
    lib/ngrokapi/models/endpoint_saml.rb,
    lib/ngrokapi/models/reserved_addr.rb,
    lib/ngrokapi/models/ip_policy_rule.rb,
    lib/ngrokapi/models/ip_restriction.rb,
    lib/ngrokapi/models/ssh_credential.rb,
    lib/ngrokapi/models/tunnel_session.rb,
    lib/ngrokapi/models/aws_credentials.rb,
    lib/ngrokapi/models/browser_session.rb,
    lib/ngrokapi/models/endpoint_o_auth.rb,
    lib/ngrokapi/models/reserved_domain.rb,
    lib/ngrokapi/models/tls_certificate.rb,
    lib/ngrokapi/models/application_user.rb,
    lib/ngrokapi/models/endpoint_backend.rb,
    lib/ngrokapi/models/failover_backend.rb,
    lib/ngrokapi/models/https_edge_route.rb,
    lib/ngrokapi/models/weighted_backend.rb,
    lib/ngrokapi/models/event_destination.rb,
    lib/ngrokapi/models/event_source_list.rb,
    lib/ngrokapi/models/identity_provider.rb,
    lib/ngrokapi/models/endpoint_ip_policy.rb,
    lib/ngrokapi/models/event_subscription.rb,
    lib/ngrokapi/models/application_session.rb,
    lib/ngrokapi/models/endpoint_mutual_tls.rb,
    lib/ngrokapi/models/endpoint_compression.rb,
    lib/ngrokapi/models/endpoint_saml_mutate.rb,
    lib/ngrokapi/models/event_source_replace.rb,
    lib/ngrokapi/models/event_target_datadog.rb,
    lib/ngrokapi/models/event_target_kinesis.rb,
    lib/ngrokapi/models/ssh_host_certificate.rb,
    lib/ngrokapi/models/ssh_user_certificate.rb,
    lib/ngrokapi/models/tunnel_group_backend.rb,
    lib/ngrokapi/models/abuse_report_hostname.rb,
    lib/ngrokapi/models/certificate_authority.rb,
    lib/ngrokapi/models/event_target_firehose.rb,
    lib/ngrokapi/models/http_response_backend.rb,
    lib/ngrokapi/models/tls_certificate_sa_ns.rb,
    lib/ngrokapi/models/agent_ingress_cert_job.rb,
    lib/ngrokapi/models/endpoint_o_auth_amazon.rb,
    lib/ngrokapi/models/endpoint_o_auth_google.rb,
    lib/ngrokapi/models/endpoint_o_auth_twitch.rb,
    lib/ngrokapi/models/endpoint_backend_mutate.rb,
    lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,
    lib/ngrokapi/models/endpoint_o_auth_git_lab.rb,
    lib/ngrokapi/models/endpoint_circuit_breaker.rb,
    lib/ngrokapi/models/endpoint_o_auth_facebook.rb,
    lib/ngrokapi/models/endpoint_o_auth_provider.rb,
    lib/ngrokapi/models/endpoint_request_headers.rb,
    lib/ngrokapi/models/endpoint_tls_termination.rb,
    lib/ngrokapi/models/reserved_domain_cert_job.rb,
    lib/ngrokapi/models/agent_ingress_cert_policy.rb,
    lib/ngrokapi/models/agent_ingress_cert_status.rb,
    lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,
    lib/ngrokapi/models/endpoint_o_auth_linked_in.rb,
    lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,
    lib/ngrokapi/models/endpoint_response_headers.rb,
    lib/ngrokapi/models/ssh_certificate_authority.rb,
    lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,
    lib/ngrokapi/models/endpoint_webhook_validation.rb,
    lib/ngrokapi/models/reserved_domain_cert_policy.rb,
    lib/ngrokapi/models/reserved_domain_cert_status.rb,
    lib/ngrokapi/models/event_target_cloudwatch_logs.rb,
    lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb,
    lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb
    + lib/ngrokapi/models/tunnel.rb,
    lib/ngrokapi/models/api_key.rb,
    lib/ngrokapi/models/aws_auth.rb,
    lib/ngrokapi/models/aws_role.rb,
    lib/ngrokapi/models/endpoint.rb,
    lib/ngrokapi/models/listable.rb,
    lib/ngrokapi/models/location.rb,
    lib/ngrokapi/models/tcp_edge.rb,
    lib/ngrokapi/models/tls_edge.rb,
    lib/ngrokapi/models/ip_policy.rb,
    lib/ngrokapi/models/credential.rb,
    lib/ngrokapi/models/https_edge.rb,
    lib/ngrokapi/models/user_agent.rb,
    lib/ngrokapi/models/abuse_report.rb,
    lib/ngrokapi/models/event_source.rb,
    lib/ngrokapi/models/event_target.rb,
    lib/ngrokapi/models/agent_ingress.rb,
    lib/ngrokapi/models/endpoint_oidc.rb,
    lib/ngrokapi/models/endpoint_rule.rb,
    lib/ngrokapi/models/endpoint_saml.rb,
    lib/ngrokapi/models/reserved_addr.rb,
    lib/ngrokapi/models/ip_policy_rule.rb,
    lib/ngrokapi/models/ip_restriction.rb,
    lib/ngrokapi/models/ssh_credential.rb,
    lib/ngrokapi/models/static_backend.rb,
    lib/ngrokapi/models/tunnel_session.rb,
    lib/ngrokapi/models/aws_credentials.rb,
    lib/ngrokapi/models/browser_session.rb,
    lib/ngrokapi/models/endpoint_action.rb,
    lib/ngrokapi/models/endpoint_o_auth.rb,
    lib/ngrokapi/models/endpoint_policy.rb,
    lib/ngrokapi/models/reserved_domain.rb,
    lib/ngrokapi/models/tls_certificate.rb,
    lib/ngrokapi/models/application_user.rb,
    lib/ngrokapi/models/endpoint_backend.rb,
    lib/ngrokapi/models/failover_backend.rb,
    lib/ngrokapi/models/https_edge_route.rb,
    lib/ngrokapi/models/weighted_backend.rb,
    lib/ngrokapi/models/event_destination.rb,
    lib/ngrokapi/models/event_source_list.rb,
    lib/ngrokapi/models/identity_provider.rb,
    lib/ngrokapi/models/endpoint_ip_policy.rb,
    lib/ngrokapi/models/event_subscription.rb,
    lib/ngrokapi/models/static_backend_tls.rb,
    lib/ngrokapi/models/application_session.rb,
    lib/ngrokapi/models/endpoint_mutual_tls.rb,
    lib/ngrokapi/models/endpoint_compression.rb,
    lib/ngrokapi/models/endpoint_saml_mutate.rb,
    lib/ngrokapi/models/event_source_replace.rb,
    lib/ngrokapi/models/event_target_datadog.rb,
    lib/ngrokapi/models/event_target_kinesis.rb,
    lib/ngrokapi/models/ssh_host_certificate.rb,
    lib/ngrokapi/models/ssh_user_certificate.rb,
    lib/ngrokapi/models/tunnel_group_backend.rb,
    lib/ngrokapi/models/abuse_report_hostname.rb,
    lib/ngrokapi/models/certificate_authority.rb,
    lib/ngrokapi/models/event_target_firehose.rb,
    lib/ngrokapi/models/http_response_backend.rb,
    lib/ngrokapi/models/tls_certificate_sa_ns.rb,
    lib/ngrokapi/models/agent_ingress_cert_job.rb,
    lib/ngrokapi/models/endpoint_o_auth_amazon.rb,
    lib/ngrokapi/models/endpoint_o_auth_google.rb,
    lib/ngrokapi/models/endpoint_o_auth_twitch.rb,
    lib/ngrokapi/models/endpoint_backend_mutate.rb,
    lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,
    lib/ngrokapi/models/endpoint_o_auth_git_lab.rb,
    lib/ngrokapi/models/endpoint_circuit_breaker.rb,
    lib/ngrokapi/models/endpoint_o_auth_facebook.rb,
    lib/ngrokapi/models/endpoint_o_auth_provider.rb,
    lib/ngrokapi/models/endpoint_request_headers.rb,
    lib/ngrokapi/models/endpoint_tls_termination.rb,
    lib/ngrokapi/models/reserved_domain_cert_job.rb,
    lib/ngrokapi/models/agent_ingress_cert_policy.rb,
    lib/ngrokapi/models/agent_ingress_cert_status.rb,
    lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,
    lib/ngrokapi/models/endpoint_o_auth_linked_in.rb,
    lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,
    lib/ngrokapi/models/endpoint_response_headers.rb,
    lib/ngrokapi/models/ssh_certificate_authority.rb,
    lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,
    lib/ngrokapi/models/endpoint_user_agent_filter.rb,
    lib/ngrokapi/models/endpoint_webhook_validation.rb,
    lib/ngrokapi/models/reserved_domain_cert_policy.rb,
    lib/ngrokapi/models/reserved_domain_cert_status.rb,
    lib/ngrokapi/models/event_target_cloudwatch_logs.rb,
    lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb,
    lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb
    @@ -91,7 +91,7 @@ - Classes: APIKey, AWSAuth, AWSCredentials, AWSRole, AbuseReport, AbuseReportHostname, AgentIngress, AgentIngressCertJob, AgentIngressCertPolicy, AgentIngressCertStatus, ApplicationSession, ApplicationUser, BrowserSession, CertificateAuthority, Credential, Endpoint, EndpointBackend, EndpointBackendMutate, EndpointCircuitBreaker, EndpointCompression, EndpointIPPolicy, EndpointIPPolicyMutate, EndpointMutualTLS, EndpointMutualTLSMutate, EndpointOAuth, EndpointOAuthAmazon, EndpointOAuthFacebook, EndpointOAuthGitHub, EndpointOAuthGitLab, EndpointOAuthGoogle, EndpointOAuthLinkedIn, EndpointOAuthMicrosoft, EndpointOAuthProvider, EndpointOAuthTwitch, EndpointOIDC, EndpointRequestHeaders, EndpointResponseHeaders, EndpointSAML, EndpointSAMLMutate, EndpointTLSTermination, EndpointTLSTerminationAtEdge, EndpointWebhookValidation, EndpointWebsocketTCPConverter, EventDestination, EventSource, EventSourceList, EventSourceReplace, EventSubscription, EventTarget, EventTargetCloudwatchLogs, EventTargetDatadog, EventTargetFirehose, EventTargetKinesis, FailoverBackend, HTTPResponseBackend, HTTPSEdge, HTTPSEdgeRoute, IPPolicy, IPPolicyRule, IPRestriction, IdentityProvider, Listable, Location, Ref, ReservedAddr, ReservedDomain, ReservedDomainCertJob, ReservedDomainCertPolicy, ReservedDomainCertStatus, SSHCertificateAuthority, SSHCredential, SSHHostCertificate, SSHUserCertificate, TCPEdge, TLSCertificate, TLSCertificateSANs, TLSEdge, Tunnel, TunnelGroupBackend, TunnelSession, UserAgent, WeightedBackend + Classes: APIKey, AWSAuth, AWSCredentials, AWSRole, AbuseReport, AbuseReportHostname, AgentIngress, AgentIngressCertJob, AgentIngressCertPolicy, AgentIngressCertStatus, ApplicationSession, ApplicationUser, BrowserSession, CertificateAuthority, Credential, Endpoint, EndpointAction, EndpointBackend, EndpointBackendMutate, EndpointCircuitBreaker, EndpointCompression, EndpointIPPolicy, EndpointIPPolicyMutate, EndpointMutualTLS, EndpointMutualTLSMutate, EndpointOAuth, EndpointOAuthAmazon, EndpointOAuthFacebook, EndpointOAuthGitHub, EndpointOAuthGitLab, EndpointOAuthGoogle, EndpointOAuthLinkedIn, EndpointOAuthMicrosoft, EndpointOAuthProvider, EndpointOAuthTwitch, EndpointOIDC, EndpointPolicy, EndpointRequestHeaders, EndpointResponseHeaders, EndpointRule, EndpointSAML, EndpointSAMLMutate, EndpointTLSTermination, EndpointTLSTerminationAtEdge, EndpointUserAgentFilter, EndpointWebhookValidation, EndpointWebsocketTCPConverter, EventDestination, EventSource, EventSourceList, EventSourceReplace, EventSubscription, EventTarget, EventTargetCloudwatchLogs, EventTargetDatadog, EventTargetFirehose, EventTargetKinesis, FailoverBackend, HTTPResponseBackend, HTTPSEdge, HTTPSEdgeRoute, IPPolicy, IPPolicyRule, IPRestriction, IdentityProvider, Listable, Location, Ref, ReservedAddr, ReservedDomain, ReservedDomainCertJob, ReservedDomainCertPolicy, ReservedDomainCertStatus, SSHCertificateAuthority, SSHCredential, SSHHostCertificate, SSHUserCertificate, StaticBackend, StaticBackendTLS, TCPEdge, TLSCertificate, TLSCertificateSANs, TLSEdge, Tunnel, TunnelGroupBackend, TunnelSession, UserAgent, WeightedBackend

    @@ -107,9 +107,9 @@ diff --git a/docs/NgrokAPI/Models/APIKey.html b/docs/NgrokAPI/Models/APIKey.html index e8450fb..dc12078 100644 --- a/docs/NgrokAPI/Models/APIKey.html +++ b/docs/NgrokAPI/Models/APIKey.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::APIKey - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1189,9 +1189,9 @@ diff --git a/docs/NgrokAPI/Models/AWSAuth.html b/docs/NgrokAPI/Models/AWSAuth.html index e384deb..424b4c7 100644 --- a/docs/NgrokAPI/Models/AWSAuth.html +++ b/docs/NgrokAPI/Models/AWSAuth.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::AWSAuth - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -659,9 +659,9 @@ diff --git a/docs/NgrokAPI/Models/AWSCredentials.html b/docs/NgrokAPI/Models/AWSCredentials.html index c2cadd9..03d6937 100644 --- a/docs/NgrokAPI/Models/AWSCredentials.html +++ b/docs/NgrokAPI/Models/AWSCredentials.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::AWSCredentials - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -659,9 +659,9 @@ diff --git a/docs/NgrokAPI/Models/AWSRole.html b/docs/NgrokAPI/Models/AWSRole.html index fbfcdd7..38e57eb 100644 --- a/docs/NgrokAPI/Models/AWSRole.html +++ b/docs/NgrokAPI/Models/AWSRole.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::AWSRole - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -585,9 +585,9 @@ diff --git a/docs/NgrokAPI/Models/AbuseReport.html b/docs/NgrokAPI/Models/AbuseReport.html index 41a0f87..dd27ebd 100644 --- a/docs/NgrokAPI/Models/AbuseReport.html +++ b/docs/NgrokAPI/Models/AbuseReport.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::AbuseReport - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1033,9 +1033,9 @@ diff --git a/docs/NgrokAPI/Models/AbuseReportHostname.html b/docs/NgrokAPI/Models/AbuseReportHostname.html index e6e8d32..0e0c456 100644 --- a/docs/NgrokAPI/Models/AbuseReportHostname.html +++ b/docs/NgrokAPI/Models/AbuseReportHostname.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::AbuseReportHostname - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -659,9 +659,9 @@ diff --git a/docs/NgrokAPI/Models/AgentIngress.html b/docs/NgrokAPI/Models/AgentIngress.html index 8b4a132..f77ddde 100644 --- a/docs/NgrokAPI/Models/AgentIngress.html +++ b/docs/NgrokAPI/Models/AgentIngress.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::AgentIngress - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1417,9 +1417,9 @@ diff --git a/docs/NgrokAPI/Models/AgentIngressCertJob.html b/docs/NgrokAPI/Models/AgentIngressCertJob.html index 5253aa0..00dde45 100644 --- a/docs/NgrokAPI/Models/AgentIngressCertJob.html +++ b/docs/NgrokAPI/Models/AgentIngressCertJob.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::AgentIngressCertJob - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -807,9 +807,9 @@ diff --git a/docs/NgrokAPI/Models/AgentIngressCertPolicy.html b/docs/NgrokAPI/Models/AgentIngressCertPolicy.html index 200c458..15d0ea3 100644 --- a/docs/NgrokAPI/Models/AgentIngressCertPolicy.html +++ b/docs/NgrokAPI/Models/AgentIngressCertPolicy.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::AgentIngressCertPolicy - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -659,9 +659,9 @@ diff --git a/docs/NgrokAPI/Models/AgentIngressCertStatus.html b/docs/NgrokAPI/Models/AgentIngressCertStatus.html index c409c81..827c568 100644 --- a/docs/NgrokAPI/Models/AgentIngressCertStatus.html +++ b/docs/NgrokAPI/Models/AgentIngressCertStatus.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::AgentIngressCertStatus - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -659,9 +659,9 @@ diff --git a/docs/NgrokAPI/Models/ApplicationSession.html b/docs/NgrokAPI/Models/ApplicationSession.html index 6515482..bd833d9 100644 --- a/docs/NgrokAPI/Models/ApplicationSession.html +++ b/docs/NgrokAPI/Models/ApplicationSession.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::ApplicationSession - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1404,9 +1404,9 @@ diff --git a/docs/NgrokAPI/Models/ApplicationUser.html b/docs/NgrokAPI/Models/ApplicationUser.html index fa9ac1f..843d22f 100644 --- a/docs/NgrokAPI/Models/ApplicationUser.html +++ b/docs/NgrokAPI/Models/ApplicationUser.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::ApplicationUser - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1326,9 +1326,9 @@ diff --git a/docs/NgrokAPI/Models/BrowserSession.html b/docs/NgrokAPI/Models/BrowserSession.html index d083d07..1dacba2 100644 --- a/docs/NgrokAPI/Models/BrowserSession.html +++ b/docs/NgrokAPI/Models/BrowserSession.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::BrowserSession - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -733,9 +733,9 @@ diff --git a/docs/NgrokAPI/Models/CertificateAuthority.html b/docs/NgrokAPI/Models/CertificateAuthority.html index b96bba4..9d84e11 100644 --- a/docs/NgrokAPI/Models/CertificateAuthority.html +++ b/docs/NgrokAPI/Models/CertificateAuthority.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::CertificateAuthority - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1485,9 +1485,9 @@ diff --git a/docs/NgrokAPI/Models/Credential.html b/docs/NgrokAPI/Models/Credential.html index b288a1d..7de3452 100644 --- a/docs/NgrokAPI/Models/Credential.html +++ b/docs/NgrokAPI/Models/Credential.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::Credential - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1269,9 +1269,9 @@ diff --git a/docs/NgrokAPI/Models/Endpoint.html b/docs/NgrokAPI/Models/Endpoint.html index cae5c69..6d73ade 100644 --- a/docs/NgrokAPI/Models/Endpoint.html +++ b/docs/NgrokAPI/Models/Endpoint.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::Endpoint - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1477,9 +1477,9 @@ diff --git a/docs/NgrokAPI/Models/EndpointAction.html b/docs/NgrokAPI/Models/EndpointAction.html new file mode 100644 index 0000000..81c056b --- /dev/null +++ b/docs/NgrokAPI/Models/EndpointAction.html @@ -0,0 +1,669 @@ + + + + + + + Class: NgrokAPI::Models::EndpointAction + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: NgrokAPI::Models::EndpointAction + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/models/endpoint_action.rb
    +
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #attrs ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute attrs.

      +
      + +
    • + + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    • + + + #config ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute config.

      +
      + +
    • + + +
    • + + + #type ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute type.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client: nil, attrs: {}) ⇒ EndpointAction + + + + + +

    +
    + +

    Returns a new instance of EndpointAction.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +13
    +14
    +15
    +16
    +17
    +18
    +
    +
    # File 'lib/ngrokapi/models/endpoint_action.rb', line 13
    +
    +def initialize(client: nil, attrs: {})
    +  @client = client
    +  @attrs = attrs
    +  @type = @attrs['type']
    +  @config = @attrs['config']
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #attrsObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute attrs.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/endpoint_action.rb', line 8
    +
    +def attrs
    +  @attrs
    +end
    +
    +
    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/endpoint_action.rb', line 8
    +
    +def client
    +  @client
    +end
    +
    +
    + + + +
    +

    + + #configObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute config.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/endpoint_action.rb', line 8
    +
    +def config
    +  @config
    +end
    +
    +
    + + + +
    +

    + + #typeObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute type.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/endpoint_action.rb', line 8
    +
    +def type
    +  @type
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #==(other) ⇒ Object + + + + + +

    + + + + +
    +
    +
    +
    +20
    +21
    +22
    +
    +
    # File 'lib/ngrokapi/models/endpoint_action.rb', line 20
    +
    +def ==(other)
    +  @attrs == other.attrs
    +end
    +
    +
    + +
    +

    + + #to_hObject + + + + + +

    + + + + +
    +
    +
    +
    +28
    +29
    +30
    +
    +
    # File 'lib/ngrokapi/models/endpoint_action.rb', line 28
    +
    +def to_h
    +  @attrs.to_h
    +end
    +
    +
    + +
    +

    + + #to_sObject + + + + + +

    + + + + +
    +
    +
    +
    +24
    +25
    +26
    +
    +
    # File 'lib/ngrokapi/models/endpoint_action.rb', line 24
    +
    +def to_s
    +  @attrs.to_s
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/NgrokAPI/Models/EndpointBackend.html b/docs/NgrokAPI/Models/EndpointBackend.html index 03c2901..2cd4bde 100644 --- a/docs/NgrokAPI/Models/EndpointBackend.html +++ b/docs/NgrokAPI/Models/EndpointBackend.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointBackend - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -659,9 +659,9 @@ diff --git a/docs/NgrokAPI/Models/EndpointBackendMutate.html b/docs/NgrokAPI/Models/EndpointBackendMutate.html index 0e7987f..420199e 100644 --- a/docs/NgrokAPI/Models/EndpointBackendMutate.html +++ b/docs/NgrokAPI/Models/EndpointBackendMutate.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointBackendMutate - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -659,9 +659,9 @@ diff --git a/docs/NgrokAPI/Models/EndpointCircuitBreaker.html b/docs/NgrokAPI/Models/EndpointCircuitBreaker.html index ad02b39..7e64d0a 100644 --- a/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +++ b/docs/NgrokAPI/Models/EndpointCircuitBreaker.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointCircuitBreaker - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -955,9 +955,9 @@ diff --git a/docs/NgrokAPI/Models/EndpointCompression.html b/docs/NgrokAPI/Models/EndpointCompression.html index 2845492..9ccbef3 100644 --- a/docs/NgrokAPI/Models/EndpointCompression.html +++ b/docs/NgrokAPI/Models/EndpointCompression.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointCompression - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -585,9 +585,9 @@ diff --git a/docs/NgrokAPI/Models/EndpointIPPolicy.html b/docs/NgrokAPI/Models/EndpointIPPolicy.html index 7ea8592..017ed08 100644 --- a/docs/NgrokAPI/Models/EndpointIPPolicy.html +++ b/docs/NgrokAPI/Models/EndpointIPPolicy.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointIPPolicy - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -659,9 +659,9 @@ diff --git a/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html b/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html index 9f6ec1a..f578265 100644 --- a/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +++ b/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointIPPolicyMutate - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -659,9 +659,9 @@ diff --git a/docs/NgrokAPI/Models/EndpointMutualTLS.html b/docs/NgrokAPI/Models/EndpointMutualTLS.html index a5ccf66..d280789 100644 --- a/docs/NgrokAPI/Models/EndpointMutualTLS.html +++ b/docs/NgrokAPI/Models/EndpointMutualTLS.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointMutualTLS - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -659,9 +659,9 @@ diff --git a/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html b/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html index 6a69739..58b45d7 100644 --- a/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +++ b/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointMutualTLSMutate - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -659,9 +659,9 @@ diff --git a/docs/NgrokAPI/Models/EndpointOAuth.html b/docs/NgrokAPI/Models/EndpointOAuth.html index c91f722..bbaf4c0 100644 --- a/docs/NgrokAPI/Models/EndpointOAuth.html +++ b/docs/NgrokAPI/Models/EndpointOAuth.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointOAuth - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1029,9 +1029,9 @@ diff --git a/docs/NgrokAPI/Models/EndpointOAuthAmazon.html b/docs/NgrokAPI/Models/EndpointOAuthAmazon.html index 89d9472..228a483 100644 --- a/docs/NgrokAPI/Models/EndpointOAuthAmazon.html +++ b/docs/NgrokAPI/Models/EndpointOAuthAmazon.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointOAuthAmazon - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -881,9 +881,9 @@ diff --git a/docs/NgrokAPI/Models/EndpointOAuthFacebook.html b/docs/NgrokAPI/Models/EndpointOAuthFacebook.html index 67c0760..ded7c49 100644 --- a/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +++ b/docs/NgrokAPI/Models/EndpointOAuthFacebook.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointOAuthFacebook - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -881,9 +881,9 @@ diff --git a/docs/NgrokAPI/Models/EndpointOAuthGitHub.html b/docs/NgrokAPI/Models/EndpointOAuthGitHub.html index e8f5e98..f86cb5f 100644 --- a/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +++ b/docs/NgrokAPI/Models/EndpointOAuthGitHub.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointOAuthGitHub - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1029,9 +1029,9 @@ diff --git a/docs/NgrokAPI/Models/EndpointOAuthGitLab.html b/docs/NgrokAPI/Models/EndpointOAuthGitLab.html index c78037d..1be5f1a 100644 --- a/docs/NgrokAPI/Models/EndpointOAuthGitLab.html +++ b/docs/NgrokAPI/Models/EndpointOAuthGitLab.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointOAuthGitLab - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -881,9 +881,9 @@ diff --git a/docs/NgrokAPI/Models/EndpointOAuthGoogle.html b/docs/NgrokAPI/Models/EndpointOAuthGoogle.html index fade8a0..82b81ca 100644 --- a/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +++ b/docs/NgrokAPI/Models/EndpointOAuthGoogle.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointOAuthGoogle - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -881,9 +881,9 @@ diff --git a/docs/NgrokAPI/Models/EndpointOAuthLinkedIn.html b/docs/NgrokAPI/Models/EndpointOAuthLinkedIn.html index 160847c..27a98ee 100644 --- a/docs/NgrokAPI/Models/EndpointOAuthLinkedIn.html +++ b/docs/NgrokAPI/Models/EndpointOAuthLinkedIn.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointOAuthLinkedIn - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -881,9 +881,9 @@ diff --git a/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html b/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html index 35ec201..9000447 100644 --- a/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +++ b/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointOAuthMicrosoft - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -881,9 +881,9 @@ diff --git a/docs/NgrokAPI/Models/EndpointOAuthProvider.html b/docs/NgrokAPI/Models/EndpointOAuthProvider.html index 0dc60ba..7a5b2d9 100644 --- a/docs/NgrokAPI/Models/EndpointOAuthProvider.html +++ b/docs/NgrokAPI/Models/EndpointOAuthProvider.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointOAuthProvider - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1103,9 +1103,9 @@ diff --git a/docs/NgrokAPI/Models/EndpointOAuthTwitch.html b/docs/NgrokAPI/Models/EndpointOAuthTwitch.html index 2e27907..50d771b 100644 --- a/docs/NgrokAPI/Models/EndpointOAuthTwitch.html +++ b/docs/NgrokAPI/Models/EndpointOAuthTwitch.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointOAuthTwitch - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -881,9 +881,9 @@ diff --git a/docs/NgrokAPI/Models/EndpointOIDC.html b/docs/NgrokAPI/Models/EndpointOIDC.html index 35e05c2..f879a86 100644 --- a/docs/NgrokAPI/Models/EndpointOIDC.html +++ b/docs/NgrokAPI/Models/EndpointOIDC.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointOIDC - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1177,9 +1177,9 @@ diff --git a/docs/NgrokAPI/Models/EndpointPolicy.html b/docs/NgrokAPI/Models/EndpointPolicy.html new file mode 100644 index 0000000..c5fb399 --- /dev/null +++ b/docs/NgrokAPI/Models/EndpointPolicy.html @@ -0,0 +1,743 @@ + + + + + + + Class: NgrokAPI::Models::EndpointPolicy + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: NgrokAPI::Models::EndpointPolicy + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/models/endpoint_policy.rb
    +
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #attrs ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute attrs.

      +
      + +
    • + + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    • + + + #enabled ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute enabled.

      +
      + +
    • + + +
    • + + + #inbound ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute inbound.

      +
      + +
    • + + +
    • + + + #outbound ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute outbound.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client: nil, attrs: {}) ⇒ EndpointPolicy + + + + + +

    +
    + +

    Returns a new instance of EndpointPolicy.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +14
    +15
    +16
    +17
    +18
    +19
    +20
    +
    +
    # File 'lib/ngrokapi/models/endpoint_policy.rb', line 14
    +
    +def initialize(client: nil, attrs: {})
    +  @client = client
    +  @attrs = attrs
    +  @enabled = @attrs['enabled']
    +  @inbound = @attrs['inbound']
    +  @outbound = @attrs['outbound']
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #attrsObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute attrs.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/endpoint_policy.rb', line 8
    +
    +def attrs
    +  @attrs
    +end
    +
    +
    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/endpoint_policy.rb', line 8
    +
    +def client
    +  @client
    +end
    +
    +
    + + + +
    +

    + + #enabledObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute enabled.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/endpoint_policy.rb', line 8
    +
    +def enabled
    +  @enabled
    +end
    +
    +
    + + + +
    +

    + + #inboundObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute inbound.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/endpoint_policy.rb', line 8
    +
    +def inbound
    +  @inbound
    +end
    +
    +
    + + + +
    +

    + + #outboundObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute outbound.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/endpoint_policy.rb', line 8
    +
    +def outbound
    +  @outbound
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #==(other) ⇒ Object + + + + + +

    + + + + +
    +
    +
    +
    +22
    +23
    +24
    +
    +
    # File 'lib/ngrokapi/models/endpoint_policy.rb', line 22
    +
    +def ==(other)
    +  @attrs == other.attrs
    +end
    +
    +
    + +
    +

    + + #to_hObject + + + + + +

    + + + + +
    +
    +
    +
    +30
    +31
    +32
    +
    +
    # File 'lib/ngrokapi/models/endpoint_policy.rb', line 30
    +
    +def to_h
    +  @attrs.to_h
    +end
    +
    +
    + +
    +

    + + #to_sObject + + + + + +

    + + + + +
    +
    +
    +
    +26
    +27
    +28
    +
    +
    # File 'lib/ngrokapi/models/endpoint_policy.rb', line 26
    +
    +def to_s
    +  @attrs.to_s
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/NgrokAPI/Models/EndpointRequestHeaders.html b/docs/NgrokAPI/Models/EndpointRequestHeaders.html index 08814fd..b8d4e09 100644 --- a/docs/NgrokAPI/Models/EndpointRequestHeaders.html +++ b/docs/NgrokAPI/Models/EndpointRequestHeaders.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointRequestHeaders - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -733,9 +733,9 @@ diff --git a/docs/NgrokAPI/Models/EndpointResponseHeaders.html b/docs/NgrokAPI/Models/EndpointResponseHeaders.html index 8e9a7a8..aab23f9 100644 --- a/docs/NgrokAPI/Models/EndpointResponseHeaders.html +++ b/docs/NgrokAPI/Models/EndpointResponseHeaders.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointResponseHeaders - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -733,9 +733,9 @@ diff --git a/docs/NgrokAPI/Models/EndpointRule.html b/docs/NgrokAPI/Models/EndpointRule.html new file mode 100644 index 0000000..c7c23b7 --- /dev/null +++ b/docs/NgrokAPI/Models/EndpointRule.html @@ -0,0 +1,743 @@ + + + + + + + Class: NgrokAPI::Models::EndpointRule + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: NgrokAPI::Models::EndpointRule + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/models/endpoint_rule.rb
    +
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #actions ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute actions.

      +
      + +
    • + + +
    • + + + #attrs ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute attrs.

      +
      + +
    • + + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    • + + + #expressions ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute expressions.

      +
      + +
    • + + +
    • + + + #name ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute name.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client: nil, attrs: {}) ⇒ EndpointRule + + + + + +

    +
    + +

    Returns a new instance of EndpointRule.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +14
    +15
    +16
    +17
    +18
    +19
    +20
    +
    +
    # File 'lib/ngrokapi/models/endpoint_rule.rb', line 14
    +
    +def initialize(client: nil, attrs: {})
    +  @client = client
    +  @attrs = attrs
    +  @expressions = @attrs['expressions']
    +  @actions = @attrs['actions']
    +  @name = @attrs['name']
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #actionsObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute actions.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/endpoint_rule.rb', line 8
    +
    +def actions
    +  @actions
    +end
    +
    +
    + + + +
    +

    + + #attrsObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute attrs.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/endpoint_rule.rb', line 8
    +
    +def attrs
    +  @attrs
    +end
    +
    +
    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/endpoint_rule.rb', line 8
    +
    +def client
    +  @client
    +end
    +
    +
    + + + +
    +

    + + #expressionsObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute expressions.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/endpoint_rule.rb', line 8
    +
    +def expressions
    +  @expressions
    +end
    +
    +
    + + + +
    +

    + + #nameObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute name.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/endpoint_rule.rb', line 8
    +
    +def name
    +  @name
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #==(other) ⇒ Object + + + + + +

    + + + + +
    +
    +
    +
    +22
    +23
    +24
    +
    +
    # File 'lib/ngrokapi/models/endpoint_rule.rb', line 22
    +
    +def ==(other)
    +  @attrs == other.attrs
    +end
    +
    +
    + +
    +

    + + #to_hObject + + + + + +

    + + + + +
    +
    +
    +
    +30
    +31
    +32
    +
    +
    # File 'lib/ngrokapi/models/endpoint_rule.rb', line 30
    +
    +def to_h
    +  @attrs.to_h
    +end
    +
    +
    + +
    +

    + + #to_sObject + + + + + +

    + + + + +
    +
    +
    +
    +26
    +27
    +28
    +
    +
    # File 'lib/ngrokapi/models/endpoint_rule.rb', line 26
    +
    +def to_s
    +  @attrs.to_s
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/NgrokAPI/Models/EndpointSAML.html b/docs/NgrokAPI/Models/EndpointSAML.html index dd4be33..ebda7a3 100644 --- a/docs/NgrokAPI/Models/EndpointSAML.html +++ b/docs/NgrokAPI/Models/EndpointSAML.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointSAML - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -393,35 +393,6 @@

    Returns the value of attribute idp_metadata.

    - - - -
  • - - - #idp_metadata_url ⇒ Object - - - - - - - - - readonly - - - - - - - - - -
    -

    Returns the value of attribute idp_metadata_url.

    -
    -
  • @@ -765,6 +736,7 @@
     
     
    +28
     29
     30
     31
    @@ -788,14 +760,10 @@
     49
     50
     51
    -52
    -53
    -54
    -55
    -56
    +52
    -
    # File 'lib/ngrokapi/models/endpoint_saml.rb', line 29
    +      
    # File 'lib/ngrokapi/models/endpoint_saml.rb', line 28
     
     def initialize(client: nil, attrs: {})
       @client = client
    @@ -805,9 +773,6 @@
       @cookie_prefix = @attrs['cookie_prefix']
       @inactivity_timeout = @attrs['inactivity_timeout']
       @maximum_duration = @attrs['maximum_duration']
    -  unless @attrs['idp_metadata_url'].nil?
    -    @idp_metadata_url = URI(@attrs['idp_metadata_url'])
    -  end
       @idp_metadata = @attrs['idp_metadata']
       @force_authn = @attrs['force_authn']
       @allow_idp_initiated = @attrs['allow_idp_initiated']
    @@ -1266,49 +1231,6 @@
     
         
           
    -      
    -      
    -

    - - #idp_metadata_urlObject (readonly) - - - - - -

    -
    - -

    Returns the value of attribute idp_metadata_url.

    - - -
    -
    -
    - - -
    - - - - -
    -
    -
    -
    -10
    -11
    -12
    -
    -
    # File 'lib/ngrokapi/models/endpoint_saml.rb', line 10
    -
    -def 
    -  @idp_metadata_url
    -end
    -
    -
    - -

    @@ -1631,12 +1553,12 @@
     
     
    -58
    -59
    -60
    +54 +55 +56

    -
    # File 'lib/ngrokapi/models/endpoint_saml.rb', line 58
    +      
    # File 'lib/ngrokapi/models/endpoint_saml.rb', line 54
     
     def ==(other)
       @attrs == other.attrs
    @@ -1661,12 +1583,12 @@
           
     
     
    -66
    -67
    -68
    +62 +63 +64
    -
    # File 'lib/ngrokapi/models/endpoint_saml.rb', line 66
    +      
    # File 'lib/ngrokapi/models/endpoint_saml.rb', line 62
     
     def to_h
       @attrs.to_h
    @@ -1691,12 +1613,12 @@
           
     
     
    -62
    -63
    -64
    +58 +59 +60
    -
    # File 'lib/ngrokapi/models/endpoint_saml.rb', line 62
    +      
    # File 'lib/ngrokapi/models/endpoint_saml.rb', line 58
     
     def to_s
       @attrs.to_s
    @@ -1711,9 +1633,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/EndpointSAMLMutate.html b/docs/NgrokAPI/Models/EndpointSAMLMutate.html
    index 00c7de6..7f394d1 100644
    --- a/docs/NgrokAPI/Models/EndpointSAMLMutate.html
    +++ b/docs/NgrokAPI/Models/EndpointSAMLMutate.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::EndpointSAMLMutate
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -335,35 +335,6 @@
     

    Returns the value of attribute idp_metadata.

    - - - -
  • - - - #idp_metadata_url ⇒ Object - - - - - - - - - readonly - - - - - - - - - -
    -

    Returns the value of attribute idp_metadata_url.

    -
    -
  • @@ -620,6 +591,7 @@
     
     
    +23
     24
     25
     26
    @@ -632,14 +604,10 @@
     33
     34
     35
    -36
    -37
    -38
    -39
    -40
    +36
    -
    # File 'lib/ngrokapi/models/endpoint_saml_mutate.rb', line 24
    +      
    # File 'lib/ngrokapi/models/endpoint_saml_mutate.rb', line 23
     
     def initialize(client: nil, attrs: {})
       @client = client
    @@ -649,9 +617,6 @@
       @cookie_prefix = @attrs['cookie_prefix']
       @inactivity_timeout = @attrs['inactivity_timeout']
       @maximum_duration = @attrs['maximum_duration']
    -  unless @attrs['idp_metadata_url'].nil?
    -    @idp_metadata_url = URI(@attrs['idp_metadata_url'])
    -  end
       @idp_metadata = @attrs['idp_metadata']
       @force_authn = @attrs['force_authn']
       @allow_idp_initiated = @attrs['allow_idp_initiated']
    @@ -1013,49 +978,6 @@
     
         
           
    -      
    -      
    -

    - - #idp_metadata_urlObject (readonly) - - - - - -

    -
    - -

    Returns the value of attribute idp_metadata_url.

    - - -
    -
    -
    - - -
    - - - - -
    -
    -
    -
    -10
    -11
    -12
    -
    -
    # File 'lib/ngrokapi/models/endpoint_saml_mutate.rb', line 10
    -
    -def 
    -  @idp_metadata_url
    -end
    -
    -
    - -

    @@ -1249,12 +1171,12 @@
     
     
    -42
    -43
    -44
    +38 +39 +40

    -
    # File 'lib/ngrokapi/models/endpoint_saml_mutate.rb', line 42
    +      
    # File 'lib/ngrokapi/models/endpoint_saml_mutate.rb', line 38
     
     def ==(other)
       @attrs == other.attrs
    @@ -1279,12 +1201,12 @@
           
     
     
    -50
    -51
    -52
    +46 +47 +48
    -
    # File 'lib/ngrokapi/models/endpoint_saml_mutate.rb', line 50
    +      
    # File 'lib/ngrokapi/models/endpoint_saml_mutate.rb', line 46
     
     def to_h
       @attrs.to_h
    @@ -1309,12 +1231,12 @@
           
     
     
    -46
    -47
    -48
    +42 +43 +44
    -
    # File 'lib/ngrokapi/models/endpoint_saml_mutate.rb', line 46
    +      
    # File 'lib/ngrokapi/models/endpoint_saml_mutate.rb', line 42
     
     def to_s
       @attrs.to_s
    @@ -1329,9 +1251,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/EndpointTLSTermination.html b/docs/NgrokAPI/Models/EndpointTLSTermination.html
    index 459373b..bca1358 100644
    --- a/docs/NgrokAPI/Models/EndpointTLSTermination.html
    +++ b/docs/NgrokAPI/Models/EndpointTLSTermination.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::EndpointTLSTermination
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -733,9 +733,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html b/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html
    index 5b88bd2..de774d1 100644
    --- a/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html
    +++ b/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::EndpointTLSTerminationAtEdge
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -659,9 +659,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/EndpointUserAgentFilter.html b/docs/NgrokAPI/Models/EndpointUserAgentFilter.html
    new file mode 100644
    index 0000000..5634197
    --- /dev/null
    +++ b/docs/NgrokAPI/Models/EndpointUserAgentFilter.html
    @@ -0,0 +1,743 @@
    +
    +
    +  
    +    
    +
    +
    +  Class: NgrokAPI::Models::EndpointUserAgentFilter
    +  
    +    — Documentation by YARD 0.9.36
    +  
    +
    +
    +  
    +
    +  
    +
    +
    +
    +
    +  
    +
    +  
    +
    +
    +  
    +  
    +    
    +
    +    
    + + +

    Class: NgrokAPI::Models::EndpointUserAgentFilter + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/models/endpoint_user_agent_filter.rb
    +
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #allow ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute allow.

      +
      + +
    • + + +
    • + + + #attrs ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute attrs.

      +
      + +
    • + + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    • + + + #deny ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute deny.

      +
      + +
    • + + +
    • + + + #enabled ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute enabled.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client: nil, attrs: {}) ⇒ EndpointUserAgentFilter + + + + + +

    +
    + +

    Returns a new instance of EndpointUserAgentFilter.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +14
    +15
    +16
    +17
    +18
    +19
    +20
    +
    +
    # File 'lib/ngrokapi/models/endpoint_user_agent_filter.rb', line 14
    +
    +def initialize(client: nil, attrs: {})
    +  @client = client
    +  @attrs = attrs
    +  @enabled = @attrs['enabled']
    +  @allow = @attrs['allow']
    +  @deny = @attrs['deny']
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #allowObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute allow.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/endpoint_user_agent_filter.rb', line 8
    +
    +def allow
    +  @allow
    +end
    +
    +
    + + + +
    +

    + + #attrsObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute attrs.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/endpoint_user_agent_filter.rb', line 8
    +
    +def attrs
    +  @attrs
    +end
    +
    +
    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/endpoint_user_agent_filter.rb', line 8
    +
    +def client
    +  @client
    +end
    +
    +
    + + + +
    +

    + + #denyObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute deny.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/endpoint_user_agent_filter.rb', line 8
    +
    +def deny
    +  @deny
    +end
    +
    +
    + + + +
    +

    + + #enabledObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute enabled.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/endpoint_user_agent_filter.rb', line 8
    +
    +def enabled
    +  @enabled
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #==(other) ⇒ Object + + + + + +

    + + + + +
    +
    +
    +
    +22
    +23
    +24
    +
    +
    # File 'lib/ngrokapi/models/endpoint_user_agent_filter.rb', line 22
    +
    +def ==(other)
    +  @attrs == other.attrs
    +end
    +
    +
    + +
    +

    + + #to_hObject + + + + + +

    + + + + +
    +
    +
    +
    +30
    +31
    +32
    +
    +
    # File 'lib/ngrokapi/models/endpoint_user_agent_filter.rb', line 30
    +
    +def to_h
    +  @attrs.to_h
    +end
    +
    +
    + +
    +

    + + #to_sObject + + + + + +

    + + + + +
    +
    +
    +
    +26
    +27
    +28
    +
    +
    # File 'lib/ngrokapi/models/endpoint_user_agent_filter.rb', line 26
    +
    +def to_s
    +  @attrs.to_s
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/NgrokAPI/Models/EndpointWebhookValidation.html b/docs/NgrokAPI/Models/EndpointWebhookValidation.html index 7ff0267..668a6ea 100644 --- a/docs/NgrokAPI/Models/EndpointWebhookValidation.html +++ b/docs/NgrokAPI/Models/EndpointWebhookValidation.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointWebhookValidation - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -733,9 +733,9 @@ diff --git a/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html b/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html index 7935585..4afc4b2 100644 --- a/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +++ b/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EndpointWebsocketTCPConverter - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -585,9 +585,9 @@ diff --git a/docs/NgrokAPI/Models/EventDestination.html b/docs/NgrokAPI/Models/EventDestination.html index 0725692..7681261 100644 --- a/docs/NgrokAPI/Models/EventDestination.html +++ b/docs/NgrokAPI/Models/EventDestination.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EventDestination - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1104,9 +1104,9 @@ diff --git a/docs/NgrokAPI/Models/EventSource.html b/docs/NgrokAPI/Models/EventSource.html index b5e416a..fa202ce 100644 --- a/docs/NgrokAPI/Models/EventSource.html +++ b/docs/NgrokAPI/Models/EventSource.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::EventSource - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -161,64 +161,6 @@

    Returns the value of attribute client.

    - - - -
  • - - - #fields ⇒ Object - - - - - - - - - readonly - - - - - - - - - -
    -

    Returns the value of attribute fields.

    -
    - -
  • - - -
  • - - - #filter ⇒ Object - - - - - - - - - readonly - - - - - - - - - -
    -

    Returns the value of attribute filter.

    -
    -
  • @@ -417,26 +359,22 @@
     
     
    +15
    +16
     17
     18
     19
     20
     21
    -22
    -23
    -24
    -25
    -26
    +22
    -
    # File 'lib/ngrokapi/models/event_source.rb', line 17
    +      
    # File 'lib/ngrokapi/models/event_source.rb', line 15
     
     def initialize(client: nil, attrs: {})
       @client = client
       @attrs = attrs
       @type = @attrs['type']
    -  @filter = @attrs['filter']
    -  @fields = @attrs['fields']
       unless @attrs['uri'].nil?
         @uri = URI(@attrs['uri'])
       end
    @@ -538,92 +476,6 @@
     
         
           
    -      
    -      
    -

    - - #fieldsObject (readonly) - - - - - -

    -
    - -

    Returns the value of attribute fields.

    - - -
    -
    -
    - - -
    - - - - -
    -
    -
    -
    -10
    -11
    -12
    -
    -
    # File 'lib/ngrokapi/models/event_source.rb', line 10
    -
    -def fields
    -  @fields
    -end
    -
    -
    - - - -
    -

    - - #filterObject (readonly) - - - - - -

    -
    - -

    Returns the value of attribute filter.

    - - -
    -
    -
    - - -
    - - - - -
    -
    -
    -
    -10
    -11
    -12
    -
    -
    # File 'lib/ngrokapi/models/event_source.rb', line 10
    -
    -def filter
    -  @filter
    -end
    -
    -
    - -

    @@ -731,12 +583,12 @@
     
     
    -28
    -29
    -30
    +24 +25 +26

    -
    # File 'lib/ngrokapi/models/event_source.rb', line 28
    +      
    # File 'lib/ngrokapi/models/event_source.rb', line 24
     
     def ==(other)
       @attrs == other.attrs
    @@ -761,12 +613,12 @@
           
     
     
    -36
    -37
    -38
    +32 +33 +34
    -
    # File 'lib/ngrokapi/models/event_source.rb', line 36
    +      
    # File 'lib/ngrokapi/models/event_source.rb', line 32
     
     def to_h
       @attrs.to_h
    @@ -791,12 +643,12 @@
           
     
     
    -32
    -33
    -34
    +28 +29 +30
    -
    # File 'lib/ngrokapi/models/event_source.rb', line 32
    +      
    # File 'lib/ngrokapi/models/event_source.rb', line 28
     
     def to_s
       @attrs.to_s
    @@ -811,9 +663,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/EventSourceList.html b/docs/NgrokAPI/Models/EventSourceList.html
    index 1fefcca..ca40c34 100644
    --- a/docs/NgrokAPI/Models/EventSourceList.html
    +++ b/docs/NgrokAPI/Models/EventSourceList.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::EventSourceList
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -663,9 +663,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/EventSourceReplace.html b/docs/NgrokAPI/Models/EventSourceReplace.html
    index 1844b86..a369804 100644
    --- a/docs/NgrokAPI/Models/EventSourceReplace.html
    +++ b/docs/NgrokAPI/Models/EventSourceReplace.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::EventSourceReplace
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -161,64 +161,6 @@
     

    Returns the value of attribute client.

    - - - -
  • - - - #fields ⇒ Object - - - - - - - - - readonly - - - - - - - - - -
    -

    Returns the value of attribute fields.

    -
    - -
  • - - -
  • - - - #filter ⇒ Object - - - - - - - - - readonly - - - - - - - - - -
    -

    Returns the value of attribute filter.

    -
    -
  • @@ -388,23 +330,19 @@
     
     
    +12
    +13
     14
     15
    -16
    -17
    -18
    -19
    -20
    +16
    -
    # File 'lib/ngrokapi/models/event_source_replace.rb', line 14
    +      
    # File 'lib/ngrokapi/models/event_source_replace.rb', line 12
     
     def initialize(client: nil, attrs: {})
       @client = client
       @attrs = attrs
       @type = @attrs['type']
    -  @filter = @attrs['filter']
    -  @fields = @attrs['fields']
     end
    @@ -503,92 +441,6 @@ - -
    -

    - - #fieldsObject (readonly) - - - - - -

    -
    - -

    Returns the value of attribute fields.

    - - -
    -
    -
    - - -
    - - - - -
    -
    -
    -
    -8
    -9
    -10
    -
    -
    # File 'lib/ngrokapi/models/event_source_replace.rb', line 8
    -
    -def fields
    -  @fields
    -end
    -
    -
    - - - -
    -

    - - #filterObject (readonly) - - - - - -

    -
    - -

    Returns the value of attribute filter.

    - - -
    -
    -
    - - -
    - - - - -
    -
    -
    -
    -8
    -9
    -10
    -
    -
    # File 'lib/ngrokapi/models/event_source_replace.rb', line 8
    -
    -def filter
    -  @filter
    -end
    -
    -
    - -

    @@ -653,12 +505,12 @@
     
     
    -22
    -23
    -24
    +18 +19 +20

    -
    # File 'lib/ngrokapi/models/event_source_replace.rb', line 22
    +      
    # File 'lib/ngrokapi/models/event_source_replace.rb', line 18
     
     def ==(other)
       @attrs == other.attrs
    @@ -683,12 +535,12 @@
           
     
     
    -30
    -31
    -32
    +26 +27 +28
    -
    # File 'lib/ngrokapi/models/event_source_replace.rb', line 30
    +      
    # File 'lib/ngrokapi/models/event_source_replace.rb', line 26
     
     def to_h
       @attrs.to_h
    @@ -713,12 +565,12 @@
           
     
     
    -26
    -27
    -28
    +22 +23 +24
    -
    # File 'lib/ngrokapi/models/event_source_replace.rb', line 26
    +      
    # File 'lib/ngrokapi/models/event_source_replace.rb', line 22
     
     def to_s
       @attrs.to_s
    @@ -733,9 +585,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/EventSubscription.html b/docs/NgrokAPI/Models/EventSubscription.html
    index ff24b76..1d2a848 100644
    --- a/docs/NgrokAPI/Models/EventSubscription.html
    +++ b/docs/NgrokAPI/Models/EventSubscription.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::EventSubscription
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -1104,9 +1104,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/EventTarget.html b/docs/NgrokAPI/Models/EventTarget.html
    index 158684d..dabe1e2 100644
    --- a/docs/NgrokAPI/Models/EventTarget.html
    +++ b/docs/NgrokAPI/Models/EventTarget.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::EventTarget
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -219,35 +219,6 @@
     

    Returns the value of attribute datadog.

    - - - -
  • - - - #debug ⇒ Object - - - - - - - - - readonly - - - - - - - - - -
    -

    Returns the value of attribute debug.

    -
    -
  • @@ -446,18 +417,17 @@
     
     
    +15
     16
     17
     18
     19
     20
     21
    -22
    -23
    -24
    +22
    -
    # File 'lib/ngrokapi/models/event_target.rb', line 16
    +      
    # File 'lib/ngrokapi/models/event_target.rb', line 15
     
     def initialize(client: nil, attrs: {})
       @client = client
    @@ -465,7 +435,6 @@
       @firehose = @attrs['firehose']
       @kinesis = @attrs['kinesis']
       @cloudwatch_logs = @attrs['cloudwatch_logs']
    -  @debug = @attrs['debug']
       @datadog = @attrs['datadog']
     end
    @@ -651,49 +620,6 @@ - -
    -

    - - #debugObject (readonly) - - - - - -

    -
    - -

    Returns the value of attribute debug.

    - - -
    -
    -
    - - -
    - - - - -
    -
    -
    -
    -8
    -9
    -10
    -
    -
    # File 'lib/ngrokapi/models/event_target.rb', line 8
    -
    -def debug
    -  @debug
    -end
    -
    -
    - -

    @@ -801,12 +727,12 @@
     
     
    -26
    -27
    -28
    +24 +25 +26

    -
    # File 'lib/ngrokapi/models/event_target.rb', line 26
    +      
    # File 'lib/ngrokapi/models/event_target.rb', line 24
     
     def ==(other)
       @attrs == other.attrs
    @@ -831,12 +757,12 @@
           
     
     
    -34
    -35
    -36
    +32 +33 +34
    -
    # File 'lib/ngrokapi/models/event_target.rb', line 34
    +      
    # File 'lib/ngrokapi/models/event_target.rb', line 32
     
     def to_h
       @attrs.to_h
    @@ -861,12 +787,12 @@
           
     
     
    -30
    -31
    -32
    +28 +29 +30
    -
    # File 'lib/ngrokapi/models/event_target.rb', line 30
    +      
    # File 'lib/ngrokapi/models/event_target.rb', line 28
     
     def to_s
       @attrs.to_s
    @@ -881,9 +807,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html b/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html
    index 68f2492..e8430c6 100644
    --- a/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html
    +++ b/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::EventTargetCloudwatchLogs
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -659,9 +659,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/EventTargetDatadog.html b/docs/NgrokAPI/Models/EventTargetDatadog.html
    index a2d2115..37573a0 100644
    --- a/docs/NgrokAPI/Models/EventTargetDatadog.html
    +++ b/docs/NgrokAPI/Models/EventTargetDatadog.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::EventTargetDatadog
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -807,9 +807,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/EventTargetFirehose.html b/docs/NgrokAPI/Models/EventTargetFirehose.html
    index 9257319..9f1d202 100644
    --- a/docs/NgrokAPI/Models/EventTargetFirehose.html
    +++ b/docs/NgrokAPI/Models/EventTargetFirehose.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::EventTargetFirehose
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -659,9 +659,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/EventTargetKinesis.html b/docs/NgrokAPI/Models/EventTargetKinesis.html
    index a5cd8c8..eb4c5de 100644
    --- a/docs/NgrokAPI/Models/EventTargetKinesis.html
    +++ b/docs/NgrokAPI/Models/EventTargetKinesis.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::EventTargetKinesis
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -659,9 +659,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/FailoverBackend.html b/docs/NgrokAPI/Models/FailoverBackend.html
    index ed025b8..4be3f1c 100644
    --- a/docs/NgrokAPI/Models/FailoverBackend.html
    +++ b/docs/NgrokAPI/Models/FailoverBackend.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::FailoverBackend
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -1121,9 +1121,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/HTTPResponseBackend.html b/docs/NgrokAPI/Models/HTTPResponseBackend.html
    index e5b2359..e7bd557 100644
    --- a/docs/NgrokAPI/Models/HTTPResponseBackend.html
    +++ b/docs/NgrokAPI/Models/HTTPResponseBackend.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::HTTPResponseBackend
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -1277,9 +1277,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/HTTPSEdge.html b/docs/NgrokAPI/Models/HTTPSEdge.html
    index 44f2ee8..8b1b3fa 100644
    --- a/docs/NgrokAPI/Models/HTTPSEdge.html
    +++ b/docs/NgrokAPI/Models/HTTPSEdge.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::HTTPSEdge
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -1355,9 +1355,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/HTTPSEdgeRoute.html b/docs/NgrokAPI/Models/HTTPSEdgeRoute.html
    index 8137f31..8931a3c 100644
    --- a/docs/NgrokAPI/Models/HTTPSEdgeRoute.html
    +++ b/docs/NgrokAPI/Models/HTTPSEdgeRoute.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::HTTPSEdgeRoute
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -538,6 +538,35 @@
     

    Returns the value of attribute oidc.

    + + + +
  • + + + #policy ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
    +

    Returns the value of attribute policy.

    +
    +
  • @@ -654,6 +683,35 @@

    Returns the value of attribute uri.

    + + + +
  • + + + #user_agent_filter ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
    +

    Returns the value of attribute user_agent_filter.

    +
    +
  • @@ -847,7 +905,7 @@
  • - #update(match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ Object + #update(match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil) ⇒ Object @@ -900,8 +958,6 @@
     
     
    -32
    -33
     34
     35
     36
    @@ -924,10 +980,14 @@
     53
     54
     55
    -56
    +56 +57 +58 +59 +60
  • -
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 32
    +      
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 34
     
     def initialize(client: nil, attrs: {})
       @client = client
    @@ -953,6 +1013,8 @@
       @saml = @attrs['saml']
       @oidc = @attrs['oidc']
       @websocket_tcp_converter = @attrs['websocket_tcp_converter']
    +  @user_agent_filter = @attrs['user_agent_filter']
    +  @policy = @attrs['policy']
     end
    @@ -1610,6 +1672,49 @@ + +
    +

    + + #policyObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute policy.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 10
    +
    +def policy
    +  @policy
    +end
    +
    +
    + +

    @@ -1782,6 +1887,49 @@

    + +
    +

    + + #user_agent_filterObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute user_agent_filter.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 10
    +
    +def user_agent_filter
    +  @user_agent_filter
    +end
    +
    +
    + +

    @@ -1889,12 +2037,12 @@
     
     
    -58
    -59
    -60
    +62 +63 +64

    -
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 58
    +      
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 62
     
     def ==(other)
       @attrs == other.attrs
    @@ -1932,16 +2080,16 @@
           
     
     
    -134
    -135
    -136
    -137
    -138
    -139
    -140
    +144 +145 +146 +147 +148 +149 +150
    -
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 134
    +      
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 144
     
     def delete(
     )
    @@ -1970,12 +2118,12 @@
           
     
     
    -66
    -67
    -68
    +70 +71 +72
    -
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 66
    +      
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 70
     
     def to_h
       @attrs.to_h
    @@ -2000,12 +2148,12 @@
           
     
     
    -62
    -63
    -64
    +66 +67 +68
    -
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 62
    +      
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 66
     
     def to_s
       @attrs.to_s
    @@ -2018,7 +2166,7 @@
           

    - #update(match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ Object + #update(match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil) ⇒ Object @@ -2043,10 +2191,6 @@
     
     
    -77
    -78
    -79
    -80
     81
     82
     83
    @@ -2094,10 +2238,20 @@
     125
     126
     127
    -128
    +128 +129 +130 +131 +132 +133 +134 +135 +136 +137 +138

    -
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 77
    +      
    # File 'lib/ngrokapi/models/https_edge_route.rb', line 81
     
     def update(
       match_type: "",
    @@ -2114,7 +2268,9 @@
       oauth: nil,
       saml: nil,
       oidc: nil,
    -  websocket_tcp_converter: nil
    +  websocket_tcp_converter: nil,
    +  user_agent_filter: nil,
    +  policy: nil
     )
       @match_type = match_type if match_type
       @match = match if match
    @@ -2131,6 +2287,8 @@
       @saml = saml if saml
       @oidc = oidc if oidc
       @websocket_tcp_converter = websocket_tcp_converter if websocket_tcp_converter
    +  @user_agent_filter = user_agent_filter if user_agent_filter
    +  @policy = policy if policy
       @client.update(
         edge_id: @edge_id,
         id: @id,
    @@ -2148,7 +2306,9 @@
         oauth: oauth,
         saml: saml,
         oidc: oidc,
    -    websocket_tcp_converter: websocket_tcp_converter
    +    websocket_tcp_converter: websocket_tcp_converter,
    +    user_agent_filter: user_agent_filter,
    +    policy: policy
       )
     end
    @@ -2161,9 +2321,9 @@ diff --git a/docs/NgrokAPI/Models/IPPolicy.html b/docs/NgrokAPI/Models/IPPolicy.html index fc520ec..d7b1483 100644 --- a/docs/NgrokAPI/Models/IPPolicy.html +++ b/docs/NgrokAPI/Models/IPPolicy.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::IPPolicy - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -106,35 +106,6 @@

    Instance Attribute Summary collapse

      -
    • - - - #action ⇒ Object - - - - - - - - - readonly - - - - - - - - - -
      -

      Returns the value of attribute action.

      -
      - -
    • - -
    • @@ -523,6 +494,7 @@
       
       
      +18
       19
       20
       21
      @@ -532,12 +504,10 @@
       25
       26
       27
      -28
      -29
      -30
      +28
    -
    # File 'lib/ngrokapi/models/ip_policy.rb', line 19
    +      
    # File 'lib/ngrokapi/models/ip_policy.rb', line 18
     
     def initialize(client: nil, attrs: {})
       @client = client
    @@ -549,7 +519,6 @@
       @created_at = @attrs['created_at']
       @description = @attrs['description']
       @metadata = @attrs['metadata']
    -  @action = @attrs['action']
     end
    @@ -564,50 +533,7 @@
    -

    - - #actionObject (readonly) - - - - - -

    -
    - -

    Returns the value of attribute action.

    - - -
    -
    -
    - - -
    - - - - -
    -
    -
    -
    -10
    -11
    -12
    -
    -
    # File 'lib/ngrokapi/models/ip_policy.rb', line 10
    -
    -def action
    -  @action
    -end
    -
    -
    - - - -
    -

    +

    #attrsObject (readonly) @@ -927,12 +853,12 @@
     
     
    -32
    -33
    -34
    +30 +31 +32

    -
    # File 'lib/ngrokapi/models/ip_policy.rb', line 32
    +      
    # File 'lib/ngrokapi/models/ip_policy.rb', line 30
     
     def ==(other)
       @attrs == other.attrs
    @@ -970,14 +896,14 @@
           
     
     
    +48
    +49
     50
     51
    -52
    -53
    -54
    +52
    -
    # File 'lib/ngrokapi/models/ip_policy.rb', line 50
    +      
    # File 'lib/ngrokapi/models/ip_policy.rb', line 48
     
     def delete
       @client.delete(
    @@ -1004,12 +930,12 @@
           
     
     
    -40
    -41
    -42
    +38 +39 +40
    -
    # File 'lib/ngrokapi/models/ip_policy.rb', line 40
    +      
    # File 'lib/ngrokapi/models/ip_policy.rb', line 38
     
     def to_h
       @attrs.to_h
    @@ -1034,12 +960,12 @@
           
     
     
    -36
    -37
    -38
    +34 +35 +36
    -
    # File 'lib/ngrokapi/models/ip_policy.rb', line 36
    +      
    # File 'lib/ngrokapi/models/ip_policy.rb', line 34
     
     def to_s
       @attrs.to_s
    @@ -1077,6 +1003,8 @@
           
     
     
    +58
    +59
     60
     61
     62
    @@ -1086,12 +1014,10 @@
     66
     67
     68
    -69
    -70
    -71
    +69
    -
    # File 'lib/ngrokapi/models/ip_policy.rb', line 60
    +      
    # File 'lib/ngrokapi/models/ip_policy.rb', line 58
     
     def update(
       description: nil,
    @@ -1115,9 +1041,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/IPPolicyRule.html b/docs/NgrokAPI/Models/IPPolicyRule.html
    index 53380dc..da87ed7 100644
    --- a/docs/NgrokAPI/Models/IPPolicyRule.html
    +++ b/docs/NgrokAPI/Models/IPPolicyRule.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::IPPolicyRule
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -1269,9 +1269,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/IPRestriction.html b/docs/NgrokAPI/Models/IPRestriction.html
    index 7ea708a..3dac825 100644
    --- a/docs/NgrokAPI/Models/IPRestriction.html
    +++ b/docs/NgrokAPI/Models/IPRestriction.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::IPRestriction
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -1178,9 +1178,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/IdentityProvider.html b/docs/NgrokAPI/Models/IdentityProvider.html
    index 1ea0ba7..e64a411 100644
    --- a/docs/NgrokAPI/Models/IdentityProvider.html
    +++ b/docs/NgrokAPI/Models/IdentityProvider.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::IdentityProvider
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -659,9 +659,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/Listable.html b/docs/NgrokAPI/Models/Listable.html
    index 28b081b..231272f 100644
    --- a/docs/NgrokAPI/Models/Listable.html
    +++ b/docs/NgrokAPI/Models/Listable.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::Listable
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -992,9 +992,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/Location.html b/docs/NgrokAPI/Models/Location.html
    index 5c84972..3f31036 100644
    --- a/docs/NgrokAPI/Models/Location.html
    +++ b/docs/NgrokAPI/Models/Location.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::Location
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -807,9 +807,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/Ref.html b/docs/NgrokAPI/Models/Ref.html
    index ed58e76..95eeaab 100644
    --- a/docs/NgrokAPI/Models/Ref.html
    +++ b/docs/NgrokAPI/Models/Ref.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::Ref
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -663,9 +663,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/ReservedAddr.html b/docs/NgrokAPI/Models/ReservedAddr.html
    index 4fbeba2..093eee3 100644
    --- a/docs/NgrokAPI/Models/ReservedAddr.html
    +++ b/docs/NgrokAPI/Models/ReservedAddr.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::ReservedAddr
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -248,35 +248,6 @@
     

    Returns the value of attribute description.

    - - - -
  • - - - #endpoint_configuration ⇒ Object - - - - - - - - - readonly - - - - - - - - - -
    -

    Returns the value of attribute endpoint_configuration.

    -
    -
  • @@ -557,6 +528,7 @@
     
     
    +20
     21
     22
     23
    @@ -568,12 +540,10 @@
     29
     30
     31
    -32
    -33
    -34
    +32
    -
    # File 'lib/ngrokapi/models/reserved_addr.rb', line 21
    +      
    # File 'lib/ngrokapi/models/reserved_addr.rb', line 20
     
     def initialize(client: nil, attrs: {})
       @client = client
    @@ -587,7 +557,6 @@
       @metadata = @attrs['metadata']
       @addr = @attrs['addr']
       @region = @attrs['region']
    -  @endpoint_configuration = @attrs['endpoint_configuration']
     end
    @@ -815,49 +784,6 @@ - -
    -

    - - #endpoint_configurationObject (readonly) - - - - - -

    -
    - -

    Returns the value of attribute endpoint_configuration.

    - - -
    -
    -
    - - -
    - - - - -
    -
    -
    -
    -10
    -11
    -12
    -
    -
    # File 'lib/ngrokapi/models/reserved_addr.rb', line 10
    -
    -def endpoint_configuration
    -  @endpoint_configuration
    -end
    -
    -
    - -

    @@ -1051,12 +977,12 @@
     
     
    -36
    -37
    -38
    +34 +35 +36

    -
    # File 'lib/ngrokapi/models/reserved_addr.rb', line 36
    +      
    # File 'lib/ngrokapi/models/reserved_addr.rb', line 34
     
     def ==(other)
       @attrs == other.attrs
    @@ -1094,14 +1020,14 @@
           
     
     
    +50
    +51
     52
     53
    -54
    -55
    -56
    +54
    -
    # File 'lib/ngrokapi/models/reserved_addr.rb', line 52
    +      
    # File 'lib/ngrokapi/models/reserved_addr.rb', line 50
     
     def delete
       @client.delete(
    @@ -1128,12 +1054,12 @@
           
     
     
    -44
    -45
    -46
    +42 +43 +44
    -
    # File 'lib/ngrokapi/models/reserved_addr.rb', line 44
    +      
    # File 'lib/ngrokapi/models/reserved_addr.rb', line 42
     
     def to_h
       @attrs.to_h
    @@ -1158,12 +1084,12 @@
           
     
     
    -40
    -41
    -42
    +38 +39 +40
    -
    # File 'lib/ngrokapi/models/reserved_addr.rb', line 40
    +      
    # File 'lib/ngrokapi/models/reserved_addr.rb', line 38
     
     def to_s
       @attrs.to_s
    @@ -1178,9 +1104,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/ReservedDomain.html b/docs/NgrokAPI/Models/ReservedDomain.html
    index d754779..551b368 100644
    --- a/docs/NgrokAPI/Models/ReservedDomain.html
    +++ b/docs/NgrokAPI/Models/ReservedDomain.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::ReservedDomain
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -393,64 +393,6 @@
     

    Returns the value of attribute domain.

    - - - -
  • - - - #http_endpoint_configuration ⇒ Object - - - - - - - - - readonly - - - - - - - - - -
    -

    Returns the value of attribute http_endpoint_configuration.

    -
    - -
  • - - -
  • - - - #https_endpoint_configuration ⇒ Object - - - - - - - - - readonly - - - - - - - - - -
    -

    Returns the value of attribute https_endpoint_configuration.

    -
    -
  • @@ -731,6 +673,8 @@
     
     
    +25
    +26
     27
     28
     29
    @@ -746,14 +690,10 @@
     39
     40
     41
    -42
    -43
    -44
    -45
    -46
    +42
    -
    # File 'lib/ngrokapi/models/reserved_domain.rb', line 27
    +      
    # File 'lib/ngrokapi/models/reserved_domain.rb', line 25
     
     def initialize(client: nil, attrs: {})
       @client = client
    @@ -768,8 +708,6 @@
       @domain = @attrs['domain']
       @region = @attrs['region']
       @cname_target = @attrs['cname_target']
    -  @http_endpoint_configuration = @attrs['http_endpoint_configuration']
    -  @https_endpoint_configuration = @attrs['https_endpoint_configuration']
       @certificate = @attrs['certificate']
       @certificate_management_policy = @attrs['certificate_management_policy']
       @certificate_management_status = @attrs['certificate_management_status']
    @@ -1216,92 +1154,6 @@
     
         
           
    -      
    -      
    -

    - - #http_endpoint_configurationObject (readonly) - - - - - -

    -
    - -

    Returns the value of attribute http_endpoint_configuration.

    - - -
    -
    -
    - - -
    - - - - -
    -
    -
    -
    -10
    -11
    -12
    -
    -
    # File 'lib/ngrokapi/models/reserved_domain.rb', line 10
    -
    -def http_endpoint_configuration
    -  @http_endpoint_configuration
    -end
    -
    -
    - - - -
    -

    - - #https_endpoint_configurationObject (readonly) - - - - - -

    -
    - -

    Returns the value of attribute https_endpoint_configuration.

    - - -
    -
    -
    - - -
    - - - - -
    -
    -
    -
    -10
    -11
    -12
    -
    -
    # File 'lib/ngrokapi/models/reserved_domain.rb', line 10
    -
    -def https_endpoint_configuration
    -  @https_endpoint_configuration
    -end
    -
    -
    - -

    @@ -1495,12 +1347,12 @@
     
     
    -48
    -49
    -50
    +44 +45 +46

    -
    # File 'lib/ngrokapi/models/reserved_domain.rb', line 48
    +      
    # File 'lib/ngrokapi/models/reserved_domain.rb', line 44
     
     def ==(other)
       @attrs == other.attrs
    @@ -1538,14 +1390,14 @@
           
     
     
    -64
    -65
    -66
    -67
    -68
    +60 +61 +62 +63 +64
    -
    # File 'lib/ngrokapi/models/reserved_domain.rb', line 64
    +      
    # File 'lib/ngrokapi/models/reserved_domain.rb', line 60
     
     def delete
       @client.delete(
    @@ -1572,12 +1424,12 @@
           
     
     
    -56
    -57
    -58
    +52 +53 +54
    -
    # File 'lib/ngrokapi/models/reserved_domain.rb', line 56
    +      
    # File 'lib/ngrokapi/models/reserved_domain.rb', line 52
     
     def to_h
       @attrs.to_h
    @@ -1602,12 +1454,12 @@
           
     
     
    -52
    -53
    -54
    +48 +49 +50
    -
    # File 'lib/ngrokapi/models/reserved_domain.rb', line 52
    +      
    # File 'lib/ngrokapi/models/reserved_domain.rb', line 48
     
     def to_s
       @attrs.to_s
    @@ -1622,9 +1474,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/ReservedDomainCertJob.html b/docs/NgrokAPI/Models/ReservedDomainCertJob.html
    index 1f97431..6bc9bdf 100644
    --- a/docs/NgrokAPI/Models/ReservedDomainCertJob.html
    +++ b/docs/NgrokAPI/Models/ReservedDomainCertJob.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::ReservedDomainCertJob
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -807,9 +807,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html b/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html
    index 1a37f6e..6d9bd81 100644
    --- a/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html
    +++ b/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::ReservedDomainCertPolicy
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -659,9 +659,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/ReservedDomainCertStatus.html b/docs/NgrokAPI/Models/ReservedDomainCertStatus.html
    index 884ed4e..7e63978 100644
    --- a/docs/NgrokAPI/Models/ReservedDomainCertStatus.html
    +++ b/docs/NgrokAPI/Models/ReservedDomainCertStatus.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::ReservedDomainCertStatus
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -659,9 +659,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/SSHCertificateAuthority.html b/docs/NgrokAPI/Models/SSHCertificateAuthority.html
    index 3612b04..077a1bb 100644
    --- a/docs/NgrokAPI/Models/SSHCertificateAuthority.html
    +++ b/docs/NgrokAPI/Models/SSHCertificateAuthority.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::SSHCertificateAuthority
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -1189,9 +1189,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/SSHCredential.html b/docs/NgrokAPI/Models/SSHCredential.html
    index 60f6e27..b222200 100644
    --- a/docs/NgrokAPI/Models/SSHCredential.html
    +++ b/docs/NgrokAPI/Models/SSHCredential.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::SSHCredential
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -1269,9 +1269,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/SSHHostCertificate.html b/docs/NgrokAPI/Models/SSHHostCertificate.html
    index c58955c..ac854f5 100644
    --- a/docs/NgrokAPI/Models/SSHHostCertificate.html
    +++ b/docs/NgrokAPI/Models/SSHHostCertificate.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::SSHHostCertificate
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -1559,9 +1559,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/SSHUserCertificate.html b/docs/NgrokAPI/Models/SSHUserCertificate.html
    index f0b1b2d..05f7abf 100644
    --- a/docs/NgrokAPI/Models/SSHUserCertificate.html
    +++ b/docs/NgrokAPI/Models/SSHUserCertificate.html
    @@ -6,7 +6,7 @@
     
       Class: NgrokAPI::Models::SSHUserCertificate
       
    -    — Documentation by YARD 0.9.34
    +    — Documentation by YARD 0.9.36
       
     
     
    @@ -1707,9 +1707,9 @@
     
     
           
     
         
    diff --git a/docs/NgrokAPI/Models/StaticBackend.html b/docs/NgrokAPI/Models/StaticBackend.html
    new file mode 100644
    index 0000000..fde0ca1
    --- /dev/null
    +++ b/docs/NgrokAPI/Models/StaticBackend.html
    @@ -0,0 +1,1211 @@
    +
    +
    +  
    +    
    +
    +
    +  Class: NgrokAPI::Models::StaticBackend
    +  
    +    — Documentation by YARD 0.9.36
    +  
    +
    +
    +  
    +
    +  
    +
    +
    +
    +
    +  
    +
    +  
    +
    +
    +  
    +  
    +    
    +
    +    
    + + +

    Class: NgrokAPI::Models::StaticBackend + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/models/static_backend.rb
    +
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #address ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute address.

      +
      + +
    • + + +
    • + + + #attrs ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute attrs.

      +
      + +
    • + + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    • + + + #created_at ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute created_at.

      +
      + +
    • + + +
    • + + + #description ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute description.

      +
      + +
    • + + +
    • + + + #id ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute id.

      +
      + +
    • + + +
    • + + + #metadata ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute metadata.

      +
      + +
    • + + +
    • + + + #tls ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute tls.

      +
      + +
    • + + +
    • + + + #uri ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute uri.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client: nil, attrs: {}) ⇒ StaticBackend + + + + + +

    +
    + +

    Returns a new instance of StaticBackend.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +20
    +21
    +22
    +23
    +24
    +25
    +26
    +27
    +28
    +29
    +30
    +31
    +32
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 20
    +
    +def initialize(client: nil, attrs: {})
    +  @client = client
    +  @attrs = attrs
    +  @id = @attrs['id']
    +  unless @attrs['uri'].nil?
    +    @uri = URI(@attrs['uri'])
    +  end
    +  @created_at = @attrs['created_at']
    +  @description = @attrs['description']
    +  @metadata = @attrs['metadata']
    +  @address = @attrs['address']
    +  @tls = @attrs['tls']
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #addressObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute address.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 10
    +
    +def address
    +  @address
    +end
    +
    +
    + + + +
    +

    + + #attrsObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute attrs.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 10
    +
    +def attrs
    +  @attrs
    +end
    +
    +
    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 10
    +
    +def client
    +  @client
    +end
    +
    +
    + + + +
    +

    + + #created_atObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute created_at.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 10
    +
    +def created_at
    +  @created_at
    +end
    +
    +
    + + + +
    +

    + + #descriptionObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute description.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 10
    +
    +def description
    +  @description
    +end
    +
    +
    + + + +
    +

    + + #idObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute id.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 10
    +
    +def id
    +  @id
    +end
    +
    +
    + + + +
    +

    + + #metadataObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute metadata.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 10
    +
    +def 
    +  @metadata
    +end
    +
    +
    + + + +
    +

    + + #tlsObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute tls.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 10
    +
    +def tls
    +  @tls
    +end
    +
    +
    + + + +
    +

    + + #uriObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute uri.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 10
    +
    +def uri
    +  @uri
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #==(other) ⇒ Object + + + + + +

    + + + + +
    +
    +
    +
    +34
    +35
    +36
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 34
    +
    +def ==(other)
    +  @attrs == other.attrs
    +end
    +
    +
    + +
    +

    + + #deleteObject + + + + + +

    +
    + +

    Delete a static backend by ID.

    + +

    ngrok.com/docs/api#api-static-backends-delete

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +50
    +51
    +52
    +53
    +54
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 50
    +
    +def delete
    +  @client.delete(
    +    id: @id
    +  )
    +end
    +
    +
    + +
    +

    + + #to_hObject + + + + + +

    + + + + +
    +
    +
    +
    +42
    +43
    +44
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 42
    +
    +def to_h
    +  @attrs.to_h
    +end
    +
    +
    + +
    +

    + + #to_sObject + + + + + +

    + + + + +
    +
    +
    +
    +38
    +39
    +40
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 38
    +
    +def to_s
    +  @attrs.to_s
    +end
    +
    +
    + +
    +

    + + #update(description: nil, metadata: nil, address: "", tls: nil) ⇒ Object + + + + + +

    +
    + +

    Update static backend by ID

    + +

    ngrok.com/docs/api#api-static-backends-update

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +60
    +61
    +62
    +63
    +64
    +65
    +66
    +67
    +68
    +69
    +70
    +71
    +72
    +73
    +74
    +75
    +76
    +77
    +
    +
    # File 'lib/ngrokapi/models/static_backend.rb', line 60
    +
    +def update(
    +  description: nil,
    +  metadata: nil,
    +  address: "",
    +  tls: nil
    +)
    +  @description = description if description
    +  @metadata =  if 
    +  @address = address if address
    +  @tls = tls if tls
    +  @client.update(
    +    id: @id,
    +    description: description,
    +    metadata: ,
    +    address: address,
    +    tls: tls
    +  )
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/NgrokAPI/Models/StaticBackendTLS.html b/docs/NgrokAPI/Models/StaticBackendTLS.html new file mode 100644 index 0000000..ab32079 --- /dev/null +++ b/docs/NgrokAPI/Models/StaticBackendTLS.html @@ -0,0 +1,595 @@ + + + + + + + Class: NgrokAPI::Models::StaticBackendTLS + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: NgrokAPI::Models::StaticBackendTLS + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/models/static_backend_tls.rb
    +
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #attrs ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute attrs.

      +
      + +
    • + + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    • + + + #enabled ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute enabled.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client: nil, attrs: {}) ⇒ StaticBackendTLS + + + + + +

    +
    + +

    Returns a new instance of StaticBackendTLS.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +12
    +13
    +14
    +15
    +16
    +
    +
    # File 'lib/ngrokapi/models/static_backend_tls.rb', line 12
    +
    +def initialize(client: nil, attrs: {})
    +  @client = client
    +  @attrs = attrs
    +  @enabled = @attrs['enabled']
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #attrsObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute attrs.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/static_backend_tls.rb', line 8
    +
    +def attrs
    +  @attrs
    +end
    +
    +
    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/static_backend_tls.rb', line 8
    +
    +def client
    +  @client
    +end
    +
    +
    + + + +
    +

    + + #enabledObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute enabled.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +8
    +9
    +10
    +
    +
    # File 'lib/ngrokapi/models/static_backend_tls.rb', line 8
    +
    +def enabled
    +  @enabled
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #==(other) ⇒ Object + + + + + +

    + + + + +
    +
    +
    +
    +18
    +19
    +20
    +
    +
    # File 'lib/ngrokapi/models/static_backend_tls.rb', line 18
    +
    +def ==(other)
    +  @attrs == other.attrs
    +end
    +
    +
    + +
    +

    + + #to_hObject + + + + + +

    + + + + +
    +
    +
    +
    +26
    +27
    +28
    +
    +
    # File 'lib/ngrokapi/models/static_backend_tls.rb', line 26
    +
    +def to_h
    +  @attrs.to_h
    +end
    +
    +
    + +
    +

    + + #to_sObject + + + + + +

    + + + + +
    +
    +
    +
    +22
    +23
    +24
    +
    +
    # File 'lib/ngrokapi/models/static_backend_tls.rb', line 22
    +
    +def to_s
    +  @attrs.to_s
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/NgrokAPI/Models/TCPEdge.html b/docs/NgrokAPI/Models/TCPEdge.html index 0ac6a9a..71c09b4 100644 --- a/docs/NgrokAPI/Models/TCPEdge.html +++ b/docs/NgrokAPI/Models/TCPEdge.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::TCPEdge - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -364,6 +364,35 @@

    Returns the value of attribute metadata.

    + + + +
  • + + + #policy ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
    +

    Returns the value of attribute policy.

    +
    +
  • @@ -528,7 +557,7 @@
  • - #update(description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil) ⇒ Object + #update(description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, policy: nil) ⇒ Object @@ -581,7 +610,6 @@
     
     
    -21
     22
     23
     24
    @@ -594,10 +622,12 @@
     31
     32
     33
    -34
    +34 +35 +36
  • -
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 21
    +      
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 22
     
     def initialize(client: nil, attrs: {})
       @client = client
    @@ -612,6 +642,7 @@
       @hostports = @attrs['hostports']
       @backend = @attrs['backend']
       @ip_restriction = @attrs['ip_restriction']
    +  @policy = @attrs['policy']
     end
    @@ -1011,6 +1042,49 @@ + +
    +

    + + #policyObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute policy.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 10
    +
    +def policy
    +  @policy
    +end
    +
    +
    + +

    @@ -1075,12 +1149,12 @@
     
     
    -36
    -37
    -38
    +38 +39 +40

    -
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 36
    +      
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 38
     
     def ==(other)
       @attrs == other.attrs
    @@ -1118,14 +1192,14 @@
           
     
     
    -81
    -82
    -83
    -84
    -85
    +86 +87 +88 +89 +90
    -
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 81
    +      
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 86
     
     def delete
       @client.delete(
    @@ -1152,12 +1226,12 @@
           
     
     
    -44
    -45
    -46
    +46 +47 +48
    -
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 44
    +      
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 46
     
     def to_h
       @attrs.to_h
    @@ -1182,12 +1256,12 @@
           
     
     
    -40
    -41
    -42
    +42 +43 +44
    -
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 40
    +      
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 42
     
     def to_s
       @attrs.to_s
    @@ -1200,7 +1274,7 @@
           

    - #update(description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil) ⇒ Object + #update(description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, policy: nil) ⇒ Object @@ -1225,8 +1299,6 @@
     
     
    -55
    -56
     57
     58
     59
    @@ -1245,30 +1317,38 @@
     72
     73
     74
    -75
    +75 +76 +77 +78 +79 +80

    -
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 55
    +      
    # File 'lib/ngrokapi/models/tcp_edge.rb', line 57
     
     def update(
       description: nil,
       metadata: nil,
       hostports: nil,
       backend: nil,
    -  ip_restriction: nil
    +  ip_restriction: nil,
    +  policy: nil
     )
       @description = description if description
       @metadata =  if 
       @hostports = hostports if hostports
       @backend = backend if backend
       @ip_restriction = ip_restriction if ip_restriction
    +  @policy = policy if policy
       @client.update(
         id: @id,
         description: description,
         metadata: ,
         hostports: hostports,
         backend: backend,
    -    ip_restriction: ip_restriction
    +    ip_restriction: ip_restriction,
    +    policy: policy
       )
     end
    @@ -1281,9 +1361,9 @@ diff --git a/docs/NgrokAPI/Models/TLSCertificate.html b/docs/NgrokAPI/Models/TLSCertificate.html index f70e6ec..d6b18b4 100644 --- a/docs/NgrokAPI/Models/TLSCertificate.html +++ b/docs/NgrokAPI/Models/TLSCertificate.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::TLSCertificate - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -2225,9 +2225,9 @@ diff --git a/docs/NgrokAPI/Models/TLSCertificateSANs.html b/docs/NgrokAPI/Models/TLSCertificateSANs.html index 37853e5..661a388 100644 --- a/docs/NgrokAPI/Models/TLSCertificateSANs.html +++ b/docs/NgrokAPI/Models/TLSCertificateSANs.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::TLSCertificateSANs - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -659,9 +659,9 @@ diff --git a/docs/NgrokAPI/Models/TLSEdge.html b/docs/NgrokAPI/Models/TLSEdge.html index 2ef88f6..b77b57d 100644 --- a/docs/NgrokAPI/Models/TLSEdge.html +++ b/docs/NgrokAPI/Models/TLSEdge.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::TLSEdge - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -393,6 +393,35 @@

    Returns the value of attribute mutual_tls.

    + + + +
  • + + + #policy ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
    +

    Returns the value of attribute policy.

    +
    +
  • @@ -586,7 +615,7 @@
  • - #update(description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) ⇒ Object + #update(description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil) ⇒ Object @@ -639,7 +668,6 @@
     
     
    -23
     24
     25
     26
    @@ -654,10 +682,12 @@
     35
     36
     37
    -38
    +38 +39 +40
  • -
    # File 'lib/ngrokapi/models/tls_edge.rb', line 23
    +      
    # File 'lib/ngrokapi/models/tls_edge.rb', line 24
     
     def initialize(client: nil, attrs: {})
       @client = client
    @@ -674,6 +704,7 @@
       @ip_restriction = @attrs['ip_restriction']
       @mutual_tls = @attrs['mutual_tls']
       @tls_termination = @attrs['tls_termination']
    +  @policy = @attrs['policy']
     end
    @@ -1116,6 +1147,49 @@ + +
    +

    + + #policyObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute policy.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/tls_edge.rb', line 10
    +
    +def policy
    +  @policy
    +end
    +
    +
    + +

    @@ -1223,12 +1297,12 @@
     
     
    -40
    -41
    -42
    +42 +43 +44

    -
    # File 'lib/ngrokapi/models/tls_edge.rb', line 40
    +      
    # File 'lib/ngrokapi/models/tls_edge.rb', line 42
     
     def ==(other)
       @attrs == other.attrs
    @@ -1266,14 +1340,14 @@
           
     
     
    -91
    -92
    -93
    -94
    -95
    +96 +97 +98 +99 +100
    -
    # File 'lib/ngrokapi/models/tls_edge.rb', line 91
    +      
    # File 'lib/ngrokapi/models/tls_edge.rb', line 96
     
     def delete
       @client.delete(
    @@ -1300,12 +1374,12 @@
           
     
     
    -48
    -49
    -50
    +50 +51 +52
    -
    # File 'lib/ngrokapi/models/tls_edge.rb', line 48
    +      
    # File 'lib/ngrokapi/models/tls_edge.rb', line 50
     
     def to_h
       @attrs.to_h
    @@ -1330,12 +1404,12 @@
           
     
     
    -44
    -45
    -46
    +46 +47 +48
    -
    # File 'lib/ngrokapi/models/tls_edge.rb', line 44
    +      
    # File 'lib/ngrokapi/models/tls_edge.rb', line 46
     
     def to_s
       @attrs.to_s
    @@ -1348,7 +1422,7 @@
           

    - #update(description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) ⇒ Object + #update(description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil) ⇒ Object @@ -1373,8 +1447,6 @@
     
     
    -59
    -60
     61
     62
     63
    @@ -1399,10 +1471,15 @@
     82
     83
     84
    -85
    +85 +86 +87 +88 +89 +90

    -
    # File 'lib/ngrokapi/models/tls_edge.rb', line 59
    +      
    # File 'lib/ngrokapi/models/tls_edge.rb', line 61
     
     def update(
       description: nil,
    @@ -1411,7 +1488,8 @@
       backend: nil,
       ip_restriction: nil,
       mutual_tls: nil,
    -  tls_termination: nil
    +  tls_termination: nil,
    +  policy: nil
     )
       @description = description if description
       @metadata =  if 
    @@ -1420,6 +1498,7 @@
       @ip_restriction = ip_restriction if ip_restriction
       @mutual_tls = mutual_tls if mutual_tls
       @tls_termination = tls_termination if tls_termination
    +  @policy = policy if policy
       @client.update(
         id: @id,
         description: description,
    @@ -1428,7 +1507,8 @@
         backend: backend,
         ip_restriction: ip_restriction,
         mutual_tls: mutual_tls,
    -    tls_termination: tls_termination
    +    tls_termination: tls_termination,
    +    policy: policy
       )
     end
    @@ -1441,9 +1521,9 @@ diff --git a/docs/NgrokAPI/Models/Tunnel.html b/docs/NgrokAPI/Models/Tunnel.html index 868bf13..31cc9db 100644 --- a/docs/NgrokAPI/Models/Tunnel.html +++ b/docs/NgrokAPI/Models/Tunnel.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::Tunnel - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1329,9 +1329,9 @@ diff --git a/docs/NgrokAPI/Models/TunnelGroupBackend.html b/docs/NgrokAPI/Models/TunnelGroupBackend.html index 8b3b67e..ea66422 100644 --- a/docs/NgrokAPI/Models/TunnelGroupBackend.html +++ b/docs/NgrokAPI/Models/TunnelGroupBackend.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::TunnelGroupBackend - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1195,9 +1195,9 @@ diff --git a/docs/NgrokAPI/Models/TunnelSession.html b/docs/NgrokAPI/Models/TunnelSession.html index 15ae96c..8e0fd7c 100644 --- a/docs/NgrokAPI/Models/TunnelSession.html +++ b/docs/NgrokAPI/Models/TunnelSession.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::TunnelSession - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1255,9 +1255,9 @@ diff --git a/docs/NgrokAPI/Models/UserAgent.html b/docs/NgrokAPI/Models/UserAgent.html index 4d41c05..b50beb4 100644 --- a/docs/NgrokAPI/Models/UserAgent.html +++ b/docs/NgrokAPI/Models/UserAgent.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::UserAgent - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -955,9 +955,9 @@ diff --git a/docs/NgrokAPI/Models/WeightedBackend.html b/docs/NgrokAPI/Models/WeightedBackend.html index 3417777..ecdc35a 100644 --- a/docs/NgrokAPI/Models/WeightedBackend.html +++ b/docs/NgrokAPI/Models/WeightedBackend.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Models::WeightedBackend - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1121,9 +1121,9 @@ diff --git a/docs/NgrokAPI/PagedIterator.html b/docs/NgrokAPI/PagedIterator.html index d4dc750..f7e82b0 100644 --- a/docs/NgrokAPI/PagedIterator.html +++ b/docs/NgrokAPI/PagedIterator.html @@ -6,7 +6,7 @@ Class: NgrokAPI::PagedIterator - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -625,9 +625,9 @@ diff --git a/docs/NgrokAPI/Services.html b/docs/NgrokAPI/Services.html index c107337..e317413 100644 --- a/docs/NgrokAPI/Services.html +++ b/docs/NgrokAPI/Services.html @@ -6,7 +6,7 @@ Module: NgrokAPI::Services - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -79,7 +79,7 @@
    Defined in:
    lib/ngrokapi/services/tunnels_client.rb,
    - lib/ngrokapi/services/api_keys_client.rb,
    lib/ngrokapi/services/edges_tcp_client.rb,
    lib/ngrokapi/services/edges_tls_client.rb,
    lib/ngrokapi/services/endpoints_client.rb,
    lib/ngrokapi/services/credentials_client.rb,
    lib/ngrokapi/services/edges_https_client.rb,
    lib/ngrokapi/services/ip_policies_client.rb,
    lib/ngrokapi/services/abuse_reports_client.rb,
    lib/ngrokapi/services/event_sources_client.rb,
    lib/ngrokapi/services/reserved_addrs_client.rb,
    lib/ngrokapi/services/agent_ingresses_client.rb,
    lib/ngrokapi/services/ip_policy_rules_client.rb,
    lib/ngrokapi/services/ip_restrictions_client.rb,
    lib/ngrokapi/services/ssh_credentials_client.rb,
    lib/ngrokapi/services/tunnel_sessions_client.rb,
    lib/ngrokapi/services/reserved_domains_client.rb,
    lib/ngrokapi/services/tls_certificates_client.rb,
    lib/ngrokapi/services/application_users_client.rb,
    lib/ngrokapi/services/failover_backends_client.rb,
    lib/ngrokapi/services/weighted_backends_client.rb,
    lib/ngrokapi/services/edges_https_routes_client.rb,
    lib/ngrokapi/services/event_destinations_client.rb,
    lib/ngrokapi/services/event_subscriptions_client.rb,
    lib/ngrokapi/services/application_sessions_client.rb,
    lib/ngrokapi/services/ssh_host_certificates_client.rb,
    lib/ngrokapi/services/ssh_user_certificates_client.rb,
    lib/ngrokapi/services/tunnel_group_backends_client.rb,
    lib/ngrokapi/services/edge_route_oidc_module_client.rb,
    lib/ngrokapi/services/edge_route_saml_module_client.rb,
    lib/ngrokapi/services/http_response_backends_client.rb,
    lib/ngrokapi/services/certificate_authorities_client.rb,
    lib/ngrokapi/services/tcp_edge_backend_module_client.rb,
    lib/ngrokapi/services/tls_edge_backend_module_client.rb,
    lib/ngrokapi/services/edge_route_o_auth_module_client.rb,
    lib/ngrokapi/services/edge_route_backend_module_client.rb,
    lib/ngrokapi/services/tls_edge_mutual_tls_module_client.rb,
    lib/ngrokapi/services/ssh_certificate_authorities_client.rb,
    lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb,
    lib/ngrokapi/services/edge_route_compression_module_client.rb,
    lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb,
    lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb,
    lib/ngrokapi/services/tls_edge_tls_termination_module_client.rb,
    lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb,
    lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb,
    lib/ngrokapi/services/edge_route_request_headers_module_client.rb,
    lib/ngrokapi/services/https_edge_tls_termination_module_client.rb,
    lib/ngrokapi/services/edge_route_response_headers_module_client.rb,
    lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb,
    lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb
    + lib/ngrokapi/services/api_keys_client.rb,
    lib/ngrokapi/services/edges_tcp_client.rb,
    lib/ngrokapi/services/edges_tls_client.rb,
    lib/ngrokapi/services/endpoints_client.rb,
    lib/ngrokapi/services/credentials_client.rb,
    lib/ngrokapi/services/edges_https_client.rb,
    lib/ngrokapi/services/ip_policies_client.rb,
    lib/ngrokapi/services/abuse_reports_client.rb,
    lib/ngrokapi/services/event_sources_client.rb,
    lib/ngrokapi/services/reserved_addrs_client.rb,
    lib/ngrokapi/services/agent_ingresses_client.rb,
    lib/ngrokapi/services/ip_policy_rules_client.rb,
    lib/ngrokapi/services/ip_restrictions_client.rb,
    lib/ngrokapi/services/ssh_credentials_client.rb,
    lib/ngrokapi/services/static_backends_client.rb,
    lib/ngrokapi/services/tunnel_sessions_client.rb,
    lib/ngrokapi/services/reserved_domains_client.rb,
    lib/ngrokapi/services/tls_certificates_client.rb,
    lib/ngrokapi/services/application_users_client.rb,
    lib/ngrokapi/services/failover_backends_client.rb,
    lib/ngrokapi/services/weighted_backends_client.rb,
    lib/ngrokapi/services/edges_https_routes_client.rb,
    lib/ngrokapi/services/event_destinations_client.rb,
    lib/ngrokapi/services/event_subscriptions_client.rb,
    lib/ngrokapi/services/application_sessions_client.rb,
    lib/ngrokapi/services/ssh_host_certificates_client.rb,
    lib/ngrokapi/services/ssh_user_certificates_client.rb,
    lib/ngrokapi/services/tunnel_group_backends_client.rb,
    lib/ngrokapi/services/edge_route_oidc_module_client.rb,
    lib/ngrokapi/services/edge_route_saml_module_client.rb,
    lib/ngrokapi/services/http_response_backends_client.rb,
    lib/ngrokapi/services/tcp_edge_policy_module_client.rb,
    lib/ngrokapi/services/tls_edge_policy_module_client.rb,
    lib/ngrokapi/services/certificate_authorities_client.rb,
    lib/ngrokapi/services/tcp_edge_backend_module_client.rb,
    lib/ngrokapi/services/tls_edge_backend_module_client.rb,
    lib/ngrokapi/services/edge_route_o_auth_module_client.rb,
    lib/ngrokapi/services/edge_route_policy_module_client.rb,
    lib/ngrokapi/services/edge_route_backend_module_client.rb,
    lib/ngrokapi/services/tls_edge_mutual_tls_module_client.rb,
    lib/ngrokapi/services/ssh_certificate_authorities_client.rb,
    lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb,
    lib/ngrokapi/services/edge_route_compression_module_client.rb,
    lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb,
    lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb,
    lib/ngrokapi/services/tls_edge_tls_termination_module_client.rb,
    lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb,
    lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb,
    lib/ngrokapi/services/edge_route_request_headers_module_client.rb,
    lib/ngrokapi/services/https_edge_tls_termination_module_client.rb,
    lib/ngrokapi/services/edge_route_response_headers_module_client.rb,
    lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb,
    lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb,
    lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb
    @@ -91,7 +91,7 @@ - Classes: APIKeysClient, AbuseReportsClient, AgentIngressesClient, ApplicationSessionsClient, ApplicationUsersClient, CertificateAuthoritiesClient, CredentialsClient, EdgeRouteBackendModuleClient, EdgeRouteCircuitBreakerModuleClient, EdgeRouteCompressionModuleClient, EdgeRouteIPRestrictionModuleClient, EdgeRouteOAuthModuleClient, EdgeRouteOIDCModuleClient, EdgeRouteRequestHeadersModuleClient, EdgeRouteResponseHeadersModuleClient, EdgeRouteSAMLModuleClient, EdgeRouteWebhookVerificationModuleClient, EdgeRouteWebsocketTCPConverterModuleClient, EdgesHTTPSClient, EdgesHTTPSRoutesClient, EdgesTCPClient, EdgesTLSClient, EndpointsClient, EventDestinationsClient, EventSourcesClient, EventSubscriptionsClient, FailoverBackendsClient, HTTPResponseBackendsClient, HTTPSEdgeMutualTLSModuleClient, HTTPSEdgeTLSTerminationModuleClient, IPPoliciesClient, IPPolicyRulesClient, IPRestrictionsClient, ReservedAddrsClient, ReservedDomainsClient, SSHCertificateAuthoritiesClient, SSHCredentialsClient, SSHHostCertificatesClient, SSHUserCertificatesClient, TCPEdgeBackendModuleClient, TCPEdgeIPRestrictionModuleClient, TLSCertificatesClient, TLSEdgeBackendModuleClient, TLSEdgeIPRestrictionModuleClient, TLSEdgeMutualTLSModuleClient, TLSEdgeTLSTerminationModuleClient, TunnelGroupBackendsClient, TunnelSessionsClient, TunnelsClient, WeightedBackendsClient + Classes: APIKeysClient, AbuseReportsClient, AgentIngressesClient, ApplicationSessionsClient, ApplicationUsersClient, CertificateAuthoritiesClient, CredentialsClient, EdgeRouteBackendModuleClient, EdgeRouteCircuitBreakerModuleClient, EdgeRouteCompressionModuleClient, EdgeRouteIPRestrictionModuleClient, EdgeRouteOAuthModuleClient, EdgeRouteOIDCModuleClient, EdgeRoutePolicyModuleClient, EdgeRouteRequestHeadersModuleClient, EdgeRouteResponseHeadersModuleClient, EdgeRouteSAMLModuleClient, EdgeRouteUserAgentFilterModuleClient, EdgeRouteWebhookVerificationModuleClient, EdgeRouteWebsocketTCPConverterModuleClient, EdgesHTTPSClient, EdgesHTTPSRoutesClient, EdgesTCPClient, EdgesTLSClient, EndpointsClient, EventDestinationsClient, EventSourcesClient, EventSubscriptionsClient, FailoverBackendsClient, HTTPResponseBackendsClient, HTTPSEdgeMutualTLSModuleClient, HTTPSEdgeTLSTerminationModuleClient, IPPoliciesClient, IPPolicyRulesClient, IPRestrictionsClient, ReservedAddrsClient, ReservedDomainsClient, SSHCertificateAuthoritiesClient, SSHCredentialsClient, SSHHostCertificatesClient, SSHUserCertificatesClient, StaticBackendsClient, TCPEdgeBackendModuleClient, TCPEdgeIPRestrictionModuleClient, TCPEdgePolicyModuleClient, TLSCertificatesClient, TLSEdgeBackendModuleClient, TLSEdgeIPRestrictionModuleClient, TLSEdgeMutualTLSModuleClient, TLSEdgePolicyModuleClient, TLSEdgeTLSTerminationModuleClient, TunnelGroupBackendsClient, TunnelSessionsClient, TunnelsClient, WeightedBackendsClient

    @@ -107,9 +107,9 @@ diff --git a/docs/NgrokAPI/Services/APIKeysClient.html b/docs/NgrokAPI/Services/APIKeysClient.html index 9dde7cf..a9b6337 100644 --- a/docs/NgrokAPI/Services/APIKeysClient.html +++ b/docs/NgrokAPI/Services/APIKeysClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::APIKeysClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -102,7 +102,7 @@

    Overview

    -

    API Keys are used to authenticate to the ngrok API. You may use the API itself to provision and manage API Keys but you'll need to provision your first API key from the API Keys page on your ngrok.com dashboard.

    +

    API Keys are used to authenticate to the ngrok API. You may use the API itself to provision and manage API Keys but you’ll need to provision your first API key from the API Keys page on your ngrok.com dashboard.

    ngrok.com/docs/api#api-api-keys

    @@ -1749,9 +1749,9 @@
    diff --git a/docs/NgrokAPI/Services/AbuseReportsClient.html b/docs/NgrokAPI/Services/AbuseReportsClient.html index 95ff995..cb33610 100644 --- a/docs/NgrokAPI/Services/AbuseReportsClient.html +++ b/docs/NgrokAPI/Services/AbuseReportsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::AbuseReportsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -102,7 +102,7 @@

    Overview

    -

    Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok's terms of service.

    +

    Abuse Reports allow you to submit take-down requests for URLs hosted by ngrok that violate ngrok’s terms of service.

    ngrok.com/docs/api#api-abuse-reports

    @@ -833,9 +833,9 @@
    diff --git a/docs/NgrokAPI/Services/AgentIngressesClient.html b/docs/NgrokAPI/Services/AgentIngressesClient.html index 4c664b9..f80473e 100644 --- a/docs/NgrokAPI/Services/AgentIngressesClient.html +++ b/docs/NgrokAPI/Services/AgentIngressesClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::AgentIngressesClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1823,9 +1823,9 @@ diff --git a/docs/NgrokAPI/Services/ApplicationSessionsClient.html b/docs/NgrokAPI/Services/ApplicationSessionsClient.html index e28f9bf..cd2671a 100644 --- a/docs/NgrokAPI/Services/ApplicationSessionsClient.html +++ b/docs/NgrokAPI/Services/ApplicationSessionsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::ApplicationSessionsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1121,9 +1121,9 @@ diff --git a/docs/NgrokAPI/Services/ApplicationUsersClient.html b/docs/NgrokAPI/Services/ApplicationUsersClient.html index 0282017..1468a70 100644 --- a/docs/NgrokAPI/Services/ApplicationUsersClient.html +++ b/docs/NgrokAPI/Services/ApplicationUsersClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::ApplicationUsersClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1121,9 +1121,9 @@ diff --git a/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html b/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html index 2a3eb3d..4a8c4f8 100644 --- a/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +++ b/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::CertificateAuthoritiesClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1745,9 +1745,9 @@ diff --git a/docs/NgrokAPI/Services/CredentialsClient.html b/docs/NgrokAPI/Services/CredentialsClient.html index a57a0b0..1c6fafa 100644 --- a/docs/NgrokAPI/Services/CredentialsClient.html +++ b/docs/NgrokAPI/Services/CredentialsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::CredentialsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -207,7 +207,7 @@
  • - #create(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "") ⇒ NgrokAPI::Models::Credential + #create(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil) ⇒ NgrokAPI::Models::Credential @@ -231,7 +231,7 @@
  • - #create!(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "") ⇒ NgrokAPI::Models::Credential + #create!(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil) ⇒ NgrokAPI::Models::Credential @@ -575,7 +575,7 @@

    - #create(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "") ⇒ NgrokAPI::Models::Credential + #create(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil) ⇒ NgrokAPI::Models::Credential @@ -710,7 +710,7 @@
    # File 'lib/ngrokapi/services/credentials_client.rb', line 39
     
    -def create(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "")
    +def create(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil)
       path = '/credentials'
       replacements = {
       }
    @@ -730,7 +730,7 @@
           

    - #create!(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "") ⇒ NgrokAPI::Models::Credential + #create!(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil) ⇒ NgrokAPI::Models::Credential @@ -865,7 +865,7 @@
    # File 'lib/ngrokapi/services/credentials_client.rb', line 66
     
    -def create!(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "")
    +def create!(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil)
       path = '/credentials'
       replacements = {
       }
    @@ -1829,9 +1829,9 @@
     

    diff --git a/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html b/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html index a9835d9..8942df1 100644 --- a/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +++ b/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgeRouteBackendModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1139,9 +1139,9 @@ diff --git a/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html b/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html index 9fff48a..9460d48 100644 --- a/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +++ b/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgeRouteCircuitBreakerModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1139,9 +1139,9 @@ diff --git a/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html b/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html index 13d2746..114133e 100644 --- a/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +++ b/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgeRouteCompressionModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1139,9 +1139,9 @@ diff --git a/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html b/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html index 1d0dd6d..57638e5 100644 --- a/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +++ b/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgeRouteIPRestrictionModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1139,9 +1139,9 @@ diff --git a/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html b/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html index e209d7c..0c9926c 100644 --- a/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +++ b/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgeRouteOAuthModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1139,9 +1139,9 @@ diff --git a/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html b/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html index d20417e..8c5406e 100644 --- a/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +++ b/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgeRouteOIDCModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1139,9 +1139,9 @@ diff --git a/docs/NgrokAPI/Services/EdgeRoutePolicyModuleClient.html b/docs/NgrokAPI/Services/EdgeRoutePolicyModuleClient.html new file mode 100644 index 0000000..eac6e80 --- /dev/null +++ b/docs/NgrokAPI/Services/EdgeRoutePolicyModuleClient.html @@ -0,0 +1,1149 @@ + + + + + + + Class: NgrokAPI::Services::EdgeRoutePolicyModuleClient + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: NgrokAPI::Services::EdgeRoutePolicyModuleClient + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/services/edge_route_policy_module_client.rb
    +
    + +
    + +

    Overview

    +
    + + +
    + +

    + Constant Summary + collapse +

    + +
    + +
    PATH = +
    +
    + +

    The API path for the requests

    + + +
    +
    +
    + + +
    +
    +
    '/edges/https/%{edge_id}/routes/%{id}/policy'
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client:) ⇒ EdgeRoutePolicyModuleClient + + + + + +

    +
    + +

    Returns a new instance of EdgeRoutePolicyModuleClient.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +15
    +16
    +17
    +
    +
    # File 'lib/ngrokapi/services/edge_route_policy_module_client.rb', line 15
    +
    +def initialize(client:)
    +  @client = client
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +13
    +14
    +15
    +
    +
    # File 'lib/ngrokapi/services/edge_route_policy_module_client.rb', line 13
    +
    +def client
    +  @client
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #delete(edge_id: "", id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + edge_id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge

      +
      + +
    • + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge route

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +95
    +96
    +97
    +98
    +99
    +100
    +101
    +102
    +
    +
    # File 'lib/ngrokapi/services/edge_route_policy_module_client.rb', line 95
    +
    +def delete(edge_id: "", id: "")
    +  path = '/edges/https/%{edge_id}/routes/%{id}/policy'
    +  replacements = {
    +    edge_id: edge_id,
    +    id: id,
    +  }
    +  @client.delete(path % replacements)
    +end
    +
    +
    + +
    +

    + + #delete!(edge_id: "", id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + edge_id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge

      +
      + +
    • + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge route

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +110
    +111
    +112
    +113
    +114
    +115
    +116
    +117
    +
    +
    # File 'lib/ngrokapi/services/edge_route_policy_module_client.rb', line 110
    +
    +def delete!(edge_id: "", id: "")
    +  path = '/edges/https/%{edge_id}/routes/%{id}/policy'
    +  replacements = {
    +    edge_id: edge_id,
    +    id: id,
    +  }
    +  @client.delete(path % replacements, danger: true)
    +end
    +
    +
    + +
    +

    + + #get(edge_id: "", id: "") ⇒ NgrokAPI::Models::EndpointPolicy + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + edge_id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge

      +
      + +
    • + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge route

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +61
    +62
    +63
    +64
    +65
    +66
    +67
    +68
    +69
    +70
    +
    +
    # File 'lib/ngrokapi/services/edge_route_policy_module_client.rb', line 61
    +
    +def get(edge_id: "", id: "")
    +  path = '/edges/https/%{edge_id}/routes/%{id}/policy'
    +  replacements = {
    +    edge_id: edge_id,
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data)
    +  NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #get!(edge_id: "", id: "") ⇒ NgrokAPI::Models::EndpointPolicy + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + edge_id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge

      +
      + +
    • + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge route

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +78
    +79
    +80
    +81
    +82
    +83
    +84
    +85
    +86
    +87
    +
    +
    # File 'lib/ngrokapi/services/edge_route_policy_module_client.rb', line 78
    +
    +def get!(edge_id: "", id: "")
    +  path = '/edges/https/%{edge_id}/routes/%{id}/policy'
    +  replacements = {
    +    edge_id: edge_id,
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #replace(edge_id: "", id: "", a_module: nil) ⇒ NgrokAPI::Models::EndpointPolicy + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + edge_id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + a_module + + + (EndpointPolicy) + + + (defaults to: nil) + + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +26
    +27
    +28
    +29
    +30
    +31
    +32
    +33
    +34
    +35
    +
    +
    # File 'lib/ngrokapi/services/edge_route_policy_module_client.rb', line 26
    +
    +def replace(edge_id: "", id: "", a_module: nil)
    +  path = '/edges/https/%{edge_id}/routes/%{id}/policy'
    +  replacements = {
    +    edge_id: edge_id,
    +    id: id,
    +  }
    +  data = a_module
    +  result = @client.put(path % replacements, data: data)
    +  NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #replace!(edge_id: "", id: "", a_module: nil) ⇒ NgrokAPI::Models::EndpointPolicy + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + edge_id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + a_module + + + (EndpointPolicy) + + + (defaults to: nil) + + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +44
    +45
    +46
    +47
    +48
    +49
    +50
    +51
    +52
    +53
    +
    +
    # File 'lib/ngrokapi/services/edge_route_policy_module_client.rb', line 44
    +
    +def replace!(edge_id: "", id: "", a_module: nil)
    +  path = '/edges/https/%{edge_id}/routes/%{id}/policy'
    +  replacements = {
    +    edge_id: edge_id,
    +    id: id,
    +  }
    +  data = a_module
    +  result = @client.put(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html b/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html index a315d15..b9d1456 100644 --- a/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +++ b/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgeRouteRequestHeadersModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1139,9 +1139,9 @@ diff --git a/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html b/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html index 9a3b374..add776a 100644 --- a/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +++ b/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgeRouteResponseHeadersModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1139,9 +1139,9 @@ diff --git a/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html b/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html index e5f6a51..d1263d5 100644 --- a/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +++ b/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgeRouteSAMLModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1139,9 +1139,9 @@ diff --git a/docs/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html b/docs/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html new file mode 100644 index 0000000..aa0c7ba --- /dev/null +++ b/docs/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html @@ -0,0 +1,1149 @@ + + + + + + + Class: NgrokAPI::Services::EdgeRouteUserAgentFilterModuleClient + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: NgrokAPI::Services::EdgeRouteUserAgentFilterModuleClient + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb
    +
    + +
    + +

    Overview

    +
    + + +
    + +

    + Constant Summary + collapse +

    + +
    + +
    PATH = +
    +
    + +

    The API path for the requests

    + + +
    +
    +
    + + +
    +
    +
    '/edges/https/%{edge_id}/routes/%{id}/user_agent_filter'
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client:) ⇒ EdgeRouteUserAgentFilterModuleClient + + + + + +

    +
    + +

    Returns a new instance of EdgeRouteUserAgentFilterModuleClient.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +15
    +16
    +17
    +
    +
    # File 'lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb', line 15
    +
    +def initialize(client:)
    +  @client = client
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +13
    +14
    +15
    +
    +
    # File 'lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb', line 13
    +
    +def client
    +  @client
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #delete(edge_id: "", id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + edge_id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge

      +
      + +
    • + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge route

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +95
    +96
    +97
    +98
    +99
    +100
    +101
    +102
    +
    +
    # File 'lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb', line 95
    +
    +def delete(edge_id: "", id: "")
    +  path = '/edges/https/%{edge_id}/routes/%{id}/user_agent_filter'
    +  replacements = {
    +    edge_id: edge_id,
    +    id: id,
    +  }
    +  @client.delete(path % replacements)
    +end
    +
    +
    + +
    +

    + + #delete!(edge_id: "", id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + edge_id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge

      +
      + +
    • + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge route

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +110
    +111
    +112
    +113
    +114
    +115
    +116
    +117
    +
    +
    # File 'lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb', line 110
    +
    +def delete!(edge_id: "", id: "")
    +  path = '/edges/https/%{edge_id}/routes/%{id}/user_agent_filter'
    +  replacements = {
    +    edge_id: edge_id,
    +    id: id,
    +  }
    +  @client.delete(path % replacements, danger: true)
    +end
    +
    +
    + +
    +

    + + #get(edge_id: "", id: "") ⇒ NgrokAPI::Models::EndpointUserAgentFilter + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + edge_id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge

      +
      + +
    • + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge route

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +61
    +62
    +63
    +64
    +65
    +66
    +67
    +68
    +69
    +70
    +
    +
    # File 'lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb', line 61
    +
    +def get(edge_id: "", id: "")
    +  path = '/edges/https/%{edge_id}/routes/%{id}/user_agent_filter'
    +  replacements = {
    +    edge_id: edge_id,
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data)
    +  NgrokAPI::Models::EndpointUserAgentFilter.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #get!(edge_id: "", id: "") ⇒ NgrokAPI::Models::EndpointUserAgentFilter + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + edge_id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge

      +
      + +
    • + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      unique identifier of this edge route

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +78
    +79
    +80
    +81
    +82
    +83
    +84
    +85
    +86
    +87
    +
    +
    # File 'lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb', line 78
    +
    +def get!(edge_id: "", id: "")
    +  path = '/edges/https/%{edge_id}/routes/%{id}/user_agent_filter'
    +  replacements = {
    +    edge_id: edge_id,
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::EndpointUserAgentFilter.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #replace(edge_id: "", id: "", a_module: nil) ⇒ NgrokAPI::Models::EndpointUserAgentFilter + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + edge_id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + a_module + + + (EndpointUserAgentFilter) + + + (defaults to: nil) + + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +26
    +27
    +28
    +29
    +30
    +31
    +32
    +33
    +34
    +35
    +
    +
    # File 'lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb', line 26
    +
    +def replace(edge_id: "", id: "", a_module: nil)
    +  path = '/edges/https/%{edge_id}/routes/%{id}/user_agent_filter'
    +  replacements = {
    +    edge_id: edge_id,
    +    id: id,
    +  }
    +  data = a_module
    +  result = @client.put(path % replacements, data: data)
    +  NgrokAPI::Models::EndpointUserAgentFilter.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #replace!(edge_id: "", id: "", a_module: nil) ⇒ NgrokAPI::Models::EndpointUserAgentFilter + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + edge_id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + a_module + + + (EndpointUserAgentFilter) + + + (defaults to: nil) + + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +44
    +45
    +46
    +47
    +48
    +49
    +50
    +51
    +52
    +53
    +
    +
    # File 'lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb', line 44
    +
    +def replace!(edge_id: "", id: "", a_module: nil)
    +  path = '/edges/https/%{edge_id}/routes/%{id}/user_agent_filter'
    +  replacements = {
    +    edge_id: edge_id,
    +    id: id,
    +  }
    +  data = a_module
    +  result = @client.put(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::EndpointUserAgentFilter.new(client: self, attrs: result)
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html b/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html index 9a1097c..953d746 100644 --- a/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +++ b/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgeRouteWebhookVerificationModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1139,9 +1139,9 @@ diff --git a/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html b/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html index 4f943dd..b149c43 100644 --- a/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +++ b/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgeRouteWebsocketTCPConverterModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1139,9 +1139,9 @@ diff --git a/docs/NgrokAPI/Services/EdgesHTTPSClient.html b/docs/NgrokAPI/Services/EdgesHTTPSClient.html index 0b5b70e..e71261f 100644 --- a/docs/NgrokAPI/Services/EdgesHTTPSClient.html +++ b/docs/NgrokAPI/Services/EdgesHTTPSClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgesHTTPSClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1937,9 +1937,9 @@ diff --git a/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html b/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html index fc9cfbb..393068c 100644 --- a/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +++ b/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgesHTTPSRoutesClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -189,7 +189,7 @@
  • - #create(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute + #create(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute @@ -213,7 +213,7 @@
  • - #create!(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute + #create!(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute @@ -359,7 +359,7 @@
  • - #update(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute + #update(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute @@ -383,7 +383,7 @@
  • - #update!(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute + #update!(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute @@ -509,7 +509,7 @@

    - #create(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute + #create(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute @@ -809,6 +809,37 @@ —

    websocket to tcp adapter configuration or null

    +
    + +

  • + +
  • + + user_agent_filter + + + (EndpointUserAgentFilter) + + + (defaults to: nil) + + +
  • + +
  • + + policy + + + (EndpointPolicy) + + + (defaults to: nil) + + + — +
    +

    the traffic policy associated with this edge or null

  • @@ -840,8 +871,6 @@
     
     
    -41
    -42
     43
     44
     45
    @@ -863,12 +892,16 @@
     61
     62
     63
    -64
    +64 +65 +66 +67 +68
    -
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 41
    +      
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 43
     
    -def create(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil)
    +def create(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil)
       path = '/edges/https/%{edge_id}/routes'
       replacements = {
         edge_id: edge_id,
    @@ -889,6 +922,8 @@
       data[:saml] = saml if saml
       data[:oidc] = oidc if oidc
       data[:websocket_tcp_converter] = websocket_tcp_converter if websocket_tcp_converter
    +  data[:user_agent_filter] = user_agent_filter if user_agent_filter
    +  data[:policy] = policy if policy
       result = @client.post(path % replacements, data: data)
       NgrokAPI::Models::HTTPSEdgeRoute.new(client: self, attrs: result)
     end
    @@ -900,7 +935,7 @@

    - #create!(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute + #create!(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute @@ -1200,6 +1235,37 @@ —

    websocket to tcp adapter configuration or null

    +
    + + + +
  • + + user_agent_filter + + + (EndpointUserAgentFilter) + + + (defaults to: nil) + + +
  • + +
  • + + policy + + + (EndpointPolicy) + + + (defaults to: nil) + + + — +
    +

    the traffic policy associated with this edge or null

  • @@ -1231,12 +1297,6 @@
     
     
    -89
    -90
    -91
    -92
    -93
    -94
     95
     96
     97
    @@ -1254,12 +1314,20 @@
     109
     110
     111
    -112
    +112 +113 +114 +115 +116 +117 +118 +119 +120

    -
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 89
    +      
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 95
     
    -def create!(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil)
    +def create!(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil)
       path = '/edges/https/%{edge_id}/routes'
       replacements = {
         edge_id: edge_id,
    @@ -1280,6 +1348,8 @@
       data[:saml] = saml if saml
       data[:oidc] = oidc if oidc
       data[:websocket_tcp_converter] = websocket_tcp_converter if websocket_tcp_converter
    +  data[:user_agent_filter] = user_agent_filter if user_agent_filter
    +  data[:policy] = policy if policy
       result = @client.post(path % replacements, data: data, danger: true)
       NgrokAPI::Models::HTTPSEdgeRoute.new(client: self, attrs: result)
     end
    @@ -1374,17 +1444,17 @@
     
     
    -266
    -267
    -268
    -269
    -270
    -271
    -272
    -273
    +282 +283 +284 +285 +286 +287 +288 +289
    -
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 266
    +      
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 282
     
     def delete(edge_id: "", id: "")
       path = '/edges/https/%{edge_id}/routes/%{id}'
    @@ -1485,17 +1555,17 @@
           
     
     
    -284
    -285
    -286
    -287
    -288
    -289
    -290
    -291
    +300 +301 +302 +303 +304 +305 +306 +307
    -
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 284
    +      
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 300
     
     def delete!(edge_id: "", id: "")
       path = '/edges/https/%{edge_id}/routes/%{id}'
    @@ -1596,19 +1666,19 @@
           
     
     
    -122
    -123
    -124
    -125
    -126
    -127
    -128
    -129
     130
    -131
    +131 +132 +133 +134 +135 +136 +137 +138 +139
    -
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 122
    +      
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 130
     
     def get(edge_id: "", id: "")
       path = '/edges/https/%{edge_id}/routes/%{id}'
    @@ -1711,19 +1781,19 @@
           
     
     
    -142
    -143
    -144
    -145
    -146
    -147
    -148
    -149
     150
    -151
    +151 +152 +153 +154 +155 +156 +157 +158 +159
    -
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 142
    +      
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 150
     
     def get!(edge_id: "", id: "")
       path = '/edges/https/%{edge_id}/routes/%{id}'
    @@ -1743,7 +1813,7 @@
           

    - #update(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute + #update(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute @@ -2065,6 +2135,37 @@ —

    websocket to tcp adapter configuration or null

    +
    + + + +
  • + + user_agent_filter + + + (EndpointUserAgentFilter) + + + (defaults to: nil) + + +
  • + +
  • + + policy + + + (EndpointPolicy) + + + (defaults to: nil) + + + — +
    +

    the traffic policy associated with this edge or null

  • @@ -2096,16 +2197,6 @@
     
     
    -179
    -180
    -181
    -182
    -183
    -184
    -185
    -186
    -187
    -188
     189
     190
     191
    @@ -2120,12 +2211,24 @@
     200
     201
     202
    -203
    +203 +204 +205 +206 +207 +208 +209 +210 +211 +212 +213 +214 +215

    -
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 179
    +      
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 189
     
    -def update(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil)
    +def update(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil)
       path = '/edges/https/%{edge_id}/routes/%{id}'
       replacements = {
         edge_id: edge_id,
    @@ -2147,6 +2250,8 @@
       data[:saml] = saml if saml
       data[:oidc] = oidc if oidc
       data[:websocket_tcp_converter] = websocket_tcp_converter if websocket_tcp_converter
    +  data[:user_agent_filter] = user_agent_filter if user_agent_filter
    +  data[:policy] = policy if policy
       result = @client.patch(path % replacements, data: data)
       NgrokAPI::Models::HTTPSEdgeRoute.new(client: self, attrs: result)
     end
    @@ -2158,7 +2263,7 @@

    - #update!(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute + #update!(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil) ⇒ NgrokAPI::Models::HTTPSEdgeRoute @@ -2480,6 +2585,37 @@ —

    websocket to tcp adapter configuration or null

    +
    + + + +
  • + + user_agent_filter + + + (EndpointUserAgentFilter) + + + (defaults to: nil) + + +
  • + +
  • + + policy + + + (EndpointPolicy) + + + (defaults to: nil) + + + — +
    +

    the traffic policy associated with this edge or null

  • @@ -2511,20 +2647,6 @@
     
     
    -232
    -233
    -234
    -235
    -236
    -237
    -238
    -239
    -240
    -241
    -242
    -243
    -244
    -245
     246
     247
     248
    @@ -2535,12 +2657,28 @@
     253
     254
     255
    -256
    +256 +257 +258 +259 +260 +261 +262 +263 +264 +265 +266 +267 +268 +269 +270 +271 +272

    -
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 232
    +      
    # File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 246
     
    -def update!(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil)
    +def update!(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil)
       path = '/edges/https/%{edge_id}/routes/%{id}'
       replacements = {
         edge_id: edge_id,
    @@ -2562,6 +2700,8 @@
       data[:saml] = saml if saml
       data[:oidc] = oidc if oidc
       data[:websocket_tcp_converter] = websocket_tcp_converter if websocket_tcp_converter
    +  data[:user_agent_filter] = user_agent_filter if user_agent_filter
    +  data[:policy] = policy if policy
       result = @client.patch(path % replacements, data: data, danger: true)
       NgrokAPI::Models::HTTPSEdgeRoute.new(client: self, attrs: result)
     end
    @@ -2575,9 +2715,9 @@ diff --git a/docs/NgrokAPI/Services/EdgesTCPClient.html b/docs/NgrokAPI/Services/EdgesTCPClient.html index cadf33a..b03c269 100644 --- a/docs/NgrokAPI/Services/EdgesTCPClient.html +++ b/docs/NgrokAPI/Services/EdgesTCPClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgesTCPClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -205,7 +205,7 @@
  • - #create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil) ⇒ NgrokAPI::Models::TCPEdge + #create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, policy: nil) ⇒ NgrokAPI::Models::TCPEdge @@ -229,7 +229,7 @@
  • - #create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil) ⇒ NgrokAPI::Models::TCPEdge + #create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, policy: nil) ⇒ NgrokAPI::Models::TCPEdge @@ -423,7 +423,7 @@
  • - #update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil) ⇒ NgrokAPI::Models::TCPEdge + #update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, policy: nil) ⇒ NgrokAPI::Models::TCPEdge @@ -447,7 +447,7 @@
  • - #update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil) ⇒ NgrokAPI::Models::TCPEdge + #update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, policy: nil) ⇒ NgrokAPI::Models::TCPEdge @@ -573,7 +573,7 @@

    - #create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil) ⇒ NgrokAPI::Models::TCPEdge + #create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, policy: nil) ⇒ NgrokAPI::Models::TCPEdge @@ -678,6 +678,24 @@

  • +
  • + + policy + + + (EndpointPolicy) + + + (defaults to: nil) + + + — +
    +

    the traffic policy associated with this edge or null

    +
    + +
  • +

    Returns:

    @@ -705,7 +723,6 @@
     
     
    -32
     33
     34
     35
    @@ -717,12 +734,14 @@
     41
     42
     43
    -44
    +44 +45 +46
    -
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 32
    +      
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 33
     
    -def create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil)
    +def create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, policy: nil)
       path = '/edges/tcp'
       replacements = {
       }
    @@ -732,6 +751,7 @@
       data[:hostports] = hostports if hostports
       data[:backend] = backend if backend
       data[:ip_restriction] = ip_restriction if ip_restriction
    +  data[:policy] = policy if policy
       result = @client.post(path % replacements, data: data)
       NgrokAPI::Models::TCPEdge.new(client: self, attrs: result)
     end
    @@ -743,7 +763,7 @@

    - #create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil) ⇒ NgrokAPI::Models::TCPEdge + #create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, policy: nil) ⇒ NgrokAPI::Models::TCPEdge @@ -848,6 +868,24 @@ +
  • + + policy + + + (EndpointPolicy) + + + (defaults to: nil) + + + — +
    +

    the traffic policy associated with this edge or null

    +
    + +
  • +

    Returns:

    @@ -875,9 +913,6 @@
     
     
    -58
    -59
    -60
     61
     62
     63
    @@ -887,12 +922,16 @@
     67
     68
     69
    -70
    +70 +71 +72 +73 +74

    -
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 58
    +      
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 61
     
    -def create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil)
    +def create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, policy: nil)
       path = '/edges/tcp'
       replacements = {
       }
    @@ -902,6 +941,7 @@
       data[:hostports] = hostports if hostports
       data[:backend] = backend if backend
       data[:ip_restriction] = ip_restriction if ip_restriction
    +  data[:policy] = policy if policy
       result = @client.post(path % replacements, data: data, danger: true)
       NgrokAPI::Models::TCPEdge.new(client: self, attrs: result)
     end
    @@ -978,16 +1018,16 @@
     
     
    -228
    -229
    -230
    -231
    -232
    -233
    -234
    +236 +237 +238 +239 +240 +241 +242
    -
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 228
    +      
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 236
     
     def delete(id: "")
       path = '/edges/tcp/%{id}'
    @@ -1069,16 +1109,16 @@
           
     
     
    -244
    -245
    -246
    -247
    -248
    -249
    -250
    +252 +253 +254 +255 +256 +257 +258
    -
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 244
    +      
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 252
     
     def delete!(id: "")
       path = '/edges/tcp/%{id}'
    @@ -1160,18 +1200,18 @@
           
     
     
    -79
    -80
    -81
    -82
     83
     84
     85
     86
    -87
    +87 +88 +89 +90 +91
    -
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 79
    +      
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 83
     
     def get(id: "")
       path = '/edges/tcp/%{id}'
    @@ -1255,18 +1295,18 @@
           
     
     
    -97
    -98
    -99
    -100
     101
     102
     103
     104
    -105
    +105 +106 +107 +108 +109
    -
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 97
    +      
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 101
     
     def get!(id: "")
       path = '/edges/tcp/%{id}'
    @@ -1376,10 +1416,6 @@
           
     
     
    -116
    -117
    -118
    -119
     120
     121
     122
    @@ -1390,10 +1426,14 @@
     127
     128
     129
    -130
    +130 +131 +132 +133 +134
    -
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 116
    +      
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 120
     
     def list(before_id: nil, limit: nil, url: nil)
       result = @client.list(
    @@ -1509,10 +1549,6 @@
           
     
     
    -142
    -143
    -144
    -145
     146
     147
     148
    @@ -1525,10 +1561,14 @@
     155
     156
     157
    -158
    +158 +159 +160 +161 +162
    -
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 142
    +      
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 146
     
     def list!(before_id: nil, limit: nil, url: nil)
       result = @client.list(
    @@ -1555,7 +1595,7 @@
           

    - #update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil) ⇒ NgrokAPI::Models::TCPEdge + #update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, policy: nil) ⇒ NgrokAPI::Models::TCPEdge @@ -1678,6 +1718,24 @@ +
  • + + policy + + + (EndpointPolicy) + + + (defaults to: nil) + + + — +
    +

    the traffic policy associated with this edge or null

    +
    + +
  • +

    Returns:

    @@ -1705,11 +1763,6 @@
     
     
    -175
    -176
    -177
    -178
    -179
     180
     181
     182
    @@ -1718,12 +1771,18 @@
     185
     186
     187
    -188
    +188 +189 +190 +191 +192 +193 +194

    -
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 175
    +      
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 180
     
    -def update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil)
    +def update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, policy: nil)
       path = '/edges/tcp/%{id}'
       replacements = {
         id: id,
    @@ -1734,6 +1793,7 @@
       data[:hostports] = hostports if hostports
       data[:backend] = backend if backend
       data[:ip_restriction] = ip_restriction if ip_restriction
    +  data[:policy] = policy if policy
       result = @client.patch(path % replacements, data: data)
       NgrokAPI::Models::TCPEdge.new(client: self, attrs: result)
     end
    @@ -1745,7 +1805,7 @@

    - #update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil) ⇒ NgrokAPI::Models::TCPEdge + #update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, policy: nil) ⇒ NgrokAPI::Models::TCPEdge @@ -1868,6 +1928,24 @@ +
  • + + policy + + + (EndpointPolicy) + + + (defaults to: nil) + + + — +
    +

    the traffic policy associated with this edge or null

    +
    + +
  • +

    Returns:

    @@ -1895,25 +1973,26 @@
     
     
    -206
    -207
    -208
    -209
    -210
    -211
    -212
     213
     214
     215
     216
     217
     218
    -219
    +219 +220 +221 +222 +223 +224 +225 +226 +227

    -
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 206
    +      
    # File 'lib/ngrokapi/services/edges_tcp_client.rb', line 213
     
    -def update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil)
    +def update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, policy: nil)
       path = '/edges/tcp/%{id}'
       replacements = {
         id: id,
    @@ -1924,6 +2003,7 @@
       data[:hostports] = hostports if hostports
       data[:backend] = backend if backend
       data[:ip_restriction] = ip_restriction if ip_restriction
    +  data[:policy] = policy if policy
       result = @client.patch(path % replacements, data: data, danger: true)
       NgrokAPI::Models::TCPEdge.new(client: self, attrs: result)
     end
    @@ -1937,9 +2017,9 @@ diff --git a/docs/NgrokAPI/Services/EdgesTLSClient.html b/docs/NgrokAPI/Services/EdgesTLSClient.html index a7aa0cd..62cb865 100644 --- a/docs/NgrokAPI/Services/EdgesTLSClient.html +++ b/docs/NgrokAPI/Services/EdgesTLSClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EdgesTLSClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -205,7 +205,7 @@
  • - #create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) ⇒ NgrokAPI::Models::TLSEdge + #create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil) ⇒ NgrokAPI::Models::TLSEdge @@ -229,7 +229,7 @@
  • - #create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) ⇒ NgrokAPI::Models::TLSEdge + #create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil) ⇒ NgrokAPI::Models::TLSEdge @@ -423,7 +423,7 @@
  • - #update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) ⇒ NgrokAPI::Models::TLSEdge + #update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil) ⇒ NgrokAPI::Models::TLSEdge @@ -447,7 +447,7 @@
  • - #update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) ⇒ NgrokAPI::Models::TLSEdge + #update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil) ⇒ NgrokAPI::Models::TLSEdge @@ -573,7 +573,7 @@

    - #create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) ⇒ NgrokAPI::Models::TLSEdge + #create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil) ⇒ NgrokAPI::Models::TLSEdge @@ -704,6 +704,24 @@

  • +
  • + + policy + + + (EndpointPolicy) + + + (defaults to: nil) + + + — +
    +

    the traffic policy associated with this edge or null

    +
    + +
  • +

    Returns:

    @@ -731,7 +749,6 @@
     
     
    -34
     35
     36
     37
    @@ -745,12 +762,14 @@
     45
     46
     47
    -48
    +48 +49 +50
    -
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 34
    +      
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 35
     
    -def create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil)
    +def create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil)
       path = '/edges/tls'
       replacements = {
       }
    @@ -762,6 +781,7 @@
       data[:ip_restriction] = ip_restriction if ip_restriction
       data[:mutual_tls] = mutual_tls if mutual_tls
       data[:tls_termination] = tls_termination if tls_termination
    +  data[:policy] = policy if policy
       result = @client.post(path % replacements, data: data)
       NgrokAPI::Models::TLSEdge.new(client: self, attrs: result)
     end
    @@ -773,7 +793,7 @@

    - #create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) ⇒ NgrokAPI::Models::TLSEdge + #create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil) ⇒ NgrokAPI::Models::TLSEdge @@ -904,6 +924,24 @@ +
  • + + policy + + + (EndpointPolicy) + + + (defaults to: nil) + + + — +
    +

    the traffic policy associated with this edge or null

    +
    + +
  • +

    Returns:

    @@ -931,9 +969,6 @@
     
     
    -64
    -65
    -66
     67
     68
     69
    @@ -945,12 +980,16 @@
     75
     76
     77
    -78
    +78 +79 +80 +81 +82

    -
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 64
    +      
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 67
     
    -def create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil)
    +def create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil)
       path = '/edges/tls'
       replacements = {
       }
    @@ -962,6 +1001,7 @@
       data[:ip_restriction] = ip_restriction if ip_restriction
       data[:mutual_tls] = mutual_tls if mutual_tls
       data[:tls_termination] = tls_termination if tls_termination
    +  data[:policy] = policy if policy
       result = @client.post(path % replacements, data: data, danger: true)
       NgrokAPI::Models::TLSEdge.new(client: self, attrs: result)
     end
    @@ -1038,16 +1078,16 @@
     
     
    -244
    -245
    -246
    -247
    -248
    -249
    -250
    +252 +253 +254 +255 +256 +257 +258
    -
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 244
    +      
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 252
     
     def delete(id: "")
       path = '/edges/tls/%{id}'
    @@ -1129,16 +1169,16 @@
           
     
     
    -260
    -261
    -262
    -263
    -264
    -265
    -266
    +268 +269 +270 +271 +272 +273 +274
    -
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 260
    +      
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 268
     
     def delete!(id: "")
       path = '/edges/tls/%{id}'
    @@ -1220,18 +1260,18 @@
           
     
     
    -87
    -88
    -89
    -90
     91
     92
     93
     94
    -95
    +95 +96 +97 +98 +99
    -
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 87
    +      
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 91
     
     def get(id: "")
       path = '/edges/tls/%{id}'
    @@ -1315,18 +1355,18 @@
           
     
     
    -105
    -106
    -107
    -108
     109
     110
     111
     112
    -113
    +113 +114 +115 +116 +117
    -
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 105
    +      
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 109
     
     def get!(id: "")
       path = '/edges/tls/%{id}'
    @@ -1436,10 +1476,6 @@
           
     
     
    -124
    -125
    -126
    -127
     128
     129
     130
    @@ -1450,10 +1486,14 @@
     135
     136
     137
    -138
    +138 +139 +140 +141 +142
    -
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 124
    +      
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 128
     
     def list(before_id: nil, limit: nil, url: nil)
       result = @client.list(
    @@ -1569,10 +1609,6 @@
           
     
     
    -150
    -151
    -152
    -153
     154
     155
     156
    @@ -1585,10 +1621,14 @@
     163
     164
     165
    -166
    +166 +167 +168 +169 +170
    -
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 150
    +      
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 154
     
     def list!(before_id: nil, limit: nil, url: nil)
       result = @client.list(
    @@ -1615,7 +1655,7 @@
           

    - #update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) ⇒ NgrokAPI::Models::TLSEdge + #update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil) ⇒ NgrokAPI::Models::TLSEdge @@ -1764,6 +1804,24 @@ +
  • + + policy + + + (EndpointPolicy) + + + (defaults to: nil) + + + — +
    +

    the traffic policy associated with this edge or null

    +
    + +
  • +

    Returns:

    @@ -1791,11 +1849,6 @@
     
     
    -185
    -186
    -187
    -188
    -189
     190
     191
     192
    @@ -1806,12 +1859,18 @@
     197
     198
     199
    -200
    +200 +201 +202 +203 +204 +205 +206

    -
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 185
    +      
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 190
     
    -def update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil)
    +def update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil)
       path = '/edges/tls/%{id}'
       replacements = {
         id: id,
    @@ -1824,6 +1883,7 @@
       data[:ip_restriction] = ip_restriction if ip_restriction
       data[:mutual_tls] = mutual_tls if mutual_tls
       data[:tls_termination] = tls_termination if tls_termination
    +  data[:policy] = policy if policy
       result = @client.patch(path % replacements, data: data)
       NgrokAPI::Models::TLSEdge.new(client: self, attrs: result)
     end
    @@ -1835,7 +1895,7 @@

    - #update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) ⇒ NgrokAPI::Models::TLSEdge + #update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil) ⇒ NgrokAPI::Models::TLSEdge @@ -1984,6 +2044,24 @@ +
  • + + policy + + + (EndpointPolicy) + + + (defaults to: nil) + + + — +
    +

    the traffic policy associated with this edge or null

    +
    + +
  • +

    Returns:

    @@ -2011,13 +2089,6 @@
     
     
    -220
    -221
    -222
    -223
    -224
    -225
    -226
     227
     228
     229
    @@ -2026,12 +2097,20 @@
     232
     233
     234
    -235
    +235 +236 +237 +238 +239 +240 +241 +242 +243

    -
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 220
    +      
    # File 'lib/ngrokapi/services/edges_tls_client.rb', line 227
     
    -def update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil)
    +def update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil)
       path = '/edges/tls/%{id}'
       replacements = {
         id: id,
    @@ -2044,6 +2123,7 @@
       data[:ip_restriction] = ip_restriction if ip_restriction
       data[:mutual_tls] = mutual_tls if mutual_tls
       data[:tls_termination] = tls_termination if tls_termination
    +  data[:policy] = policy if policy
       result = @client.patch(path % replacements, data: data, danger: true)
       NgrokAPI::Models::TLSEdge.new(client: self, attrs: result)
     end
    @@ -2057,9 +2137,9 @@ diff --git a/docs/NgrokAPI/Services/EndpointsClient.html b/docs/NgrokAPI/Services/EndpointsClient.html index bdfd4d3..2009489 100644 --- a/docs/NgrokAPI/Services/EndpointsClient.html +++ b/docs/NgrokAPI/Services/EndpointsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EndpointsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -893,9 +893,9 @@ diff --git a/docs/NgrokAPI/Services/EventDestinationsClient.html b/docs/NgrokAPI/Services/EventDestinationsClient.html index b4f355e..b168d7d 100644 --- a/docs/NgrokAPI/Services/EventDestinationsClient.html +++ b/docs/NgrokAPI/Services/EventDestinationsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EventDestinationsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1877,9 +1877,9 @@ diff --git a/docs/NgrokAPI/Services/EventSourcesClient.html b/docs/NgrokAPI/Services/EventSourcesClient.html index 337b43b..201f8e7 100644 --- a/docs/NgrokAPI/Services/EventSourcesClient.html +++ b/docs/NgrokAPI/Services/EventSourcesClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EventSourcesClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1661,9 +1661,9 @@ diff --git a/docs/NgrokAPI/Services/EventSubscriptionsClient.html b/docs/NgrokAPI/Services/EventSubscriptionsClient.html index 683db69..ca530e6 100644 --- a/docs/NgrokAPI/Services/EventSubscriptionsClient.html +++ b/docs/NgrokAPI/Services/EventSubscriptionsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::EventSubscriptionsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -390,7 +390,7 @@
    -

    List this Account's Event Subscriptions.

    +

    List this Account’s Event Subscriptions.

    @@ -414,7 +414,7 @@
    -

    List this Account's Event Subscriptions.

    +

    List this Account’s Event Subscriptions.

    @@ -1264,7 +1264,7 @@
    -

    List this Account's Event Subscriptions.

    +

    List this Account’s Event Subscriptions.

    ngrok.com/docs/api#api-event-subscriptions-list

    @@ -1397,7 +1397,7 @@
    -

    List this Account's Event Subscriptions. Throws an exception if API error.

    +

    List this Account’s Event Subscriptions. Throws an exception if API error.

    ngrok.com/docs/api#api-event-subscriptions-list

    @@ -1877,9 +1877,9 @@
    diff --git a/docs/NgrokAPI/Services/FailoverBackendsClient.html b/docs/NgrokAPI/Services/FailoverBackendsClient.html index da49cdb..e2e1ad4 100644 --- a/docs/NgrokAPI/Services/FailoverBackendsClient.html +++ b/docs/NgrokAPI/Services/FailoverBackendsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::FailoverBackendsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1789,9 +1789,9 @@
    diff --git a/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html b/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html index 5798a18..48f8729 100644 --- a/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +++ b/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::HTTPResponseBackendsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1927,9 +1927,9 @@ diff --git a/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html b/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html index 8c92901..5d05313 100644 --- a/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +++ b/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::HTTPSEdgeMutualTLSModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1029,9 +1029,9 @@ diff --git a/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html b/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html index 0e08c99..8cb81a4 100644 --- a/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +++ b/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::HTTPSEdgeTLSTerminationModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1029,9 +1029,9 @@ diff --git a/docs/NgrokAPI/Services/IPPoliciesClient.html b/docs/NgrokAPI/Services/IPPoliciesClient.html index 128aa61..adc4fa2 100644 --- a/docs/NgrokAPI/Services/IPPoliciesClient.html +++ b/docs/NgrokAPI/Services/IPPoliciesClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::IPPoliciesClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1709,9 +1709,9 @@ diff --git a/docs/NgrokAPI/Services/IPPolicyRulesClient.html b/docs/NgrokAPI/Services/IPPolicyRulesClient.html index 406bea1..2a664ad 100644 --- a/docs/NgrokAPI/Services/IPPolicyRulesClient.html +++ b/docs/NgrokAPI/Services/IPPolicyRulesClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::IPPolicyRulesClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1857,9 +1857,9 @@ diff --git a/docs/NgrokAPI/Services/IPRestrictionsClient.html b/docs/NgrokAPI/Services/IPRestrictionsClient.html index 999097f..2d45f0a 100644 --- a/docs/NgrokAPI/Services/IPRestrictionsClient.html +++ b/docs/NgrokAPI/Services/IPRestrictionsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::IPRestrictionsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1901,9 +1901,9 @@ diff --git a/docs/NgrokAPI/Services/ReservedAddrsClient.html b/docs/NgrokAPI/Services/ReservedAddrsClient.html index 308c5a5..ca0e619 100644 --- a/docs/NgrokAPI/Services/ReservedAddrsClient.html +++ b/docs/NgrokAPI/Services/ReservedAddrsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::ReservedAddrsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1749,9 +1749,9 @@ diff --git a/docs/NgrokAPI/Services/ReservedDomainsClient.html b/docs/NgrokAPI/Services/ReservedDomainsClient.html index 990873a..98c6f9b 100644 --- a/docs/NgrokAPI/Services/ReservedDomainsClient.html +++ b/docs/NgrokAPI/Services/ReservedDomainsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::ReservedDomainsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -102,7 +102,7 @@

    Overview

    -

    Reserved Domains are hostnames that you can listen for traffic on. Domains can be used to listen for http, https or tls traffic. You may use a domain that you own by creating a CNAME record specified in the returned resource. This CNAME record points traffic for that domain to ngrok's edge servers.

    +

    Reserved Domains are hostnames that you can listen for traffic on. Domains can be used to listen for http, https or tls traffic. You may use a domain that you own by creating a CNAME record specified in the returned resource. This CNAME record points traffic for that domain to ngrok’s edge servers.

    ngrok.com/docs/api#api-reserved-domains

    @@ -722,7 +722,7 @@ —
    -

    reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)

    +

    deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa)

    @@ -917,7 +917,7 @@ —
    -

    reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)

    +

    deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa)

    @@ -2409,9 +2409,9 @@
    diff --git a/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html b/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html index feeb77f..b8c715a 100644 --- a/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +++ b/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::SSHCertificateAuthoritiesClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1829,9 +1829,9 @@ diff --git a/docs/NgrokAPI/Services/SSHCredentialsClient.html b/docs/NgrokAPI/Services/SSHCredentialsClient.html index b3b9603..8b61455 100644 --- a/docs/NgrokAPI/Services/SSHCredentialsClient.html +++ b/docs/NgrokAPI/Services/SSHCredentialsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::SSHCredentialsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -584,7 +584,7 @@
    -

    Create a new ssh_credential from an uploaded public SSH key. This ssh credential can be used to start new tunnels via ngrok's SSH gateway.

    +

    Create a new ssh_credential from an uploaded public SSH key. This ssh credential can be used to start new tunnels via ngrok’s SSH gateway.

    ngrok.com/docs/api#api-ssh-credentials-create

    @@ -757,7 +757,7 @@
    -

    Create a new ssh_credential from an uploaded public SSH key. This ssh credential can be used to start new tunnels via ngrok's SSH gateway. Throws an exception if API error.

    +

    Create a new ssh_credential from an uploaded public SSH key. This ssh credential can be used to start new tunnels via ngrok’s SSH gateway. Throws an exception if API error.

    ngrok.com/docs/api#api-ssh-credentials-create

    @@ -1865,9 +1865,9 @@
    diff --git a/docs/NgrokAPI/Services/SSHHostCertificatesClient.html b/docs/NgrokAPI/Services/SSHHostCertificatesClient.html index 3b05917..e3e18f3 100644 --- a/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +++ b/docs/NgrokAPI/Services/SSHHostCertificatesClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::SSHHostCertificatesClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1901,9 +1901,9 @@
    diff --git a/docs/NgrokAPI/Services/SSHUserCertificatesClient.html b/docs/NgrokAPI/Services/SSHUserCertificatesClient.html index c6e0d9f..8fcf5f3 100644 --- a/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +++ b/docs/NgrokAPI/Services/SSHUserCertificatesClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::SSHUserCertificatesClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -658,7 +658,7 @@ —
    -

    A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>_ for additional details.

    +

    A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>_ for additional details.

    @@ -676,7 +676,7 @@ —
    -

    A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>_ for additional details.

    +

    A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>_ for additional details.

    @@ -909,7 +909,7 @@ —
    -

    A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>_ for additional details.

    +

    A map of critical options included in the certificate. Only two critical options are currently defined by OpenSSH: force-command and source-address. See the OpenSSH certificate protocol spec <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>_ for additional details.

    @@ -927,7 +927,7 @@ —
    -

    A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>_ for additional details.

    +

    A map of extensions included in the certificate. Extensions are additional metadata that can be interpreted by the SSH server for any purpose. These can be used to permit or deny the ability to open a terminal, do port forwarding, x11 forwarding, and more. If unspecified, the certificate will include limited permissions with the following extension map: {"permit-pty": "", "permit-user-rc": ""} OpenSSH understands a number of predefined extensions. See the OpenSSH certificate protocol spec <https://github.com/openssh/openssh-portable/blob/master/PROTOCOL.certkeys>_ for additional details.

    @@ -1981,9 +1981,9 @@ diff --git a/docs/NgrokAPI/Services/StaticBackendsClient.html b/docs/NgrokAPI/Services/StaticBackendsClient.html new file mode 100644 index 0000000..de247d8 --- /dev/null +++ b/docs/NgrokAPI/Services/StaticBackendsClient.html @@ -0,0 +1,1879 @@ + + + + + + + Class: NgrokAPI::Services::StaticBackendsClient + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: NgrokAPI::Services::StaticBackendsClient + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/services/static_backends_client.rb
    +
    + +
    + +

    Overview

    +
    + +

    A static backend sends traffic to a TCP address (hostname and port) that is reachable on the public internet.

    + +

    ngrok.com/docs/api#api-static-backends

    + + +
    +
    +
    + + +
    + +

    + Constant Summary + collapse +

    + +
    + +
    PATH = +
    +
    + +

    The API path for the requests

    + + +
    +
    +
    + + +
    +
    +
    '/backends/static'
    + +
    LIST_PROPERTY = +
    +
    + +

    The List Property from the resulting API for list calls

    + + +
    +
    +
    + + +
    +
    +
    'backends'
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client:) ⇒ StaticBackendsClient + + + + + +

    +
    + +

    Returns a new instance of StaticBackendsClient.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +20
    +21
    +22
    +
    +
    # File 'lib/ngrokapi/services/static_backends_client.rb', line 20
    +
    +def initialize(client:)
    +  @client = client
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +18
    +19
    +20
    +
    +
    # File 'lib/ngrokapi/services/static_backends_client.rb', line 18
    +
    +def client
    +  @client
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #create(description: "", metadata: "", address: "", tls: nil) ⇒ NgrokAPI::Models::StaticBackend + + + + + +

    +
    + +

    Create a new static backend

    + +

    ngrok.com/docs/api#api-static-backends-create

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + description + + + (string) + + + (defaults to: "") + + + — +
      +

      human-readable description of this backend. Optional

      +
      + +
    • + +
    • + + metadata + + + (string) + + + (defaults to: "") + + + — +
      +

      arbitrary user-defined machine-readable data of this backend. Optional

      +
      + +
    • + +
    • + + address + + + (string) + + + (defaults to: "") + + + — +
      +

      the address to forward to

      +
      + +
    • + +
    • + + tls + + + (StaticBackendTLS) + + + (defaults to: nil) + + + — +
      +

      tls configuration to use

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +34
    +35
    +36
    +37
    +38
    +39
    +40
    +41
    +42
    +43
    +44
    +45
    +
    +
    # File 'lib/ngrokapi/services/static_backends_client.rb', line 34
    +
    +def create(description: "", metadata: "", address: "", tls: nil)
    +  path = '/backends/static'
    +  replacements = {
    +  }
    +  data = {}
    +  data[:description] = description if description
    +  data[:metadata] =  if 
    +  data[:address] = address if address
    +  data[:tls] = tls if tls
    +  result = @client.post(path % replacements, data: data)
    +  NgrokAPI::Models::StaticBackend.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #create!(description: "", metadata: "", address: "", tls: nil) ⇒ NgrokAPI::Models::StaticBackend + + + + + +

    +
    + +

    Create a new static backend Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-static-backends-create

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + description + + + (string) + + + (defaults to: "") + + + — +
      +

      human-readable description of this backend. Optional

      +
      + +
    • + +
    • + + metadata + + + (string) + + + (defaults to: "") + + + — +
      +

      arbitrary user-defined machine-readable data of this backend. Optional

      +
      + +
    • + +
    • + + address + + + (string) + + + (defaults to: "") + + + — +
      +

      the address to forward to

      +
      + +
    • + +
    • + + tls + + + (StaticBackendTLS) + + + (defaults to: nil) + + + — +
      +

      tls configuration to use

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +58
    +59
    +60
    +61
    +62
    +63
    +64
    +65
    +66
    +67
    +68
    +69
    +
    +
    # File 'lib/ngrokapi/services/static_backends_client.rb', line 58
    +
    +def create!(description: "", metadata: "", address: "", tls: nil)
    +  path = '/backends/static'
    +  replacements = {
    +  }
    +  data = {}
    +  data[:description] = description if description
    +  data[:metadata] =  if 
    +  data[:address] = address if address
    +  data[:tls] = tls if tls
    +  result = @client.post(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::StaticBackend.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #delete(id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    + +

    Delete a static backend by ID.

    + +

    ngrok.com/docs/api#api-static-backends-delete

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +78
    +79
    +80
    +81
    +82
    +83
    +84
    +
    +
    # File 'lib/ngrokapi/services/static_backends_client.rb', line 78
    +
    +def delete(id: "")
    +  path = '/backends/static/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  @client.delete(path % replacements)
    +end
    +
    +
    + +
    +

    + + #delete!(id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    + +

    Delete a static backend by ID. Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-static-backends-delete

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +94
    +95
    +96
    +97
    +98
    +99
    +100
    +
    +
    # File 'lib/ngrokapi/services/static_backends_client.rb', line 94
    +
    +def delete!(id: "")
    +  path = '/backends/static/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  @client.delete(path % replacements, danger: true)
    +end
    +
    +
    + +
    +

    + + #get(id: "") ⇒ NgrokAPI::Models::StaticBackend + + + + + +

    +
    + +

    Get detailed information about a static backend by ID

    + +

    ngrok.com/docs/api#api-static-backends-get

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +109
    +110
    +111
    +112
    +113
    +114
    +115
    +116
    +117
    +
    +
    # File 'lib/ngrokapi/services/static_backends_client.rb', line 109
    +
    +def get(id: "")
    +  path = '/backends/static/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data)
    +  NgrokAPI::Models::StaticBackend.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #get!(id: "") ⇒ NgrokAPI::Models::StaticBackend + + + + + +

    +
    + +

    Get detailed information about a static backend by ID Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-static-backends-get

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +127
    +128
    +129
    +130
    +131
    +132
    +133
    +134
    +135
    +
    +
    # File 'lib/ngrokapi/services/static_backends_client.rb', line 127
    +
    +def get!(id: "")
    +  path = '/backends/static/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::StaticBackend.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable + + + + + +

    +
    + +

    List all static backends on this account

    + +

    ngrok.com/docs/api#api-static-backends-list

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + before_id + + + (string) + + + (defaults to: nil) + + +
    • + +
    • + + limit + + + (string) + + + (defaults to: nil) + + +
    • + +
    • + + url + + + (string) + + + (defaults to: nil) + + + — +
      +

      optional and mutually exclusive from before_id and limit

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +146
    +147
    +148
    +149
    +150
    +151
    +152
    +153
    +154
    +155
    +156
    +157
    +158
    +159
    +160
    +
    +
    # File 'lib/ngrokapi/services/static_backends_client.rb', line 146
    +
    +def list(before_id: nil, limit: nil, url: nil)
    +  result = @client.list(
    +    before_id: before_id,
    +    limit: limit,
    +    url: url,
    +    path: PATH
    +  )
    +
    +  NgrokAPI::Models::Listable.new(
    +    client: self,
    +    attrs: result,
    +    list_property: LIST_PROPERTY,
    +    klass: NgrokAPI::Models::StaticBackend
    +  )
    +end
    +
    +
    + +
    +

    + + #list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable + + + + + +

    +
    + +

    List all static backends on this account Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-static-backends-list

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + before_id + + + (string) + + + (defaults to: nil) + + +
    • + +
    • + + limit + + + (string) + + + (defaults to: nil) + + +
    • + +
    • + + url + + + (string) + + + (defaults to: nil) + + + — +
      +

      optional and mutually exclusive from before_id and limit

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +172
    +173
    +174
    +175
    +176
    +177
    +178
    +179
    +180
    +181
    +182
    +183
    +184
    +185
    +186
    +187
    +188
    +
    +
    # File 'lib/ngrokapi/services/static_backends_client.rb', line 172
    +
    +def list!(before_id: nil, limit: nil, url: nil)
    +  result = @client.list(
    +    before_id: before_id,
    +    limit: limit,
    +    danger: true,
    +    url: url,
    +    path: PATH
    +  )
    +
    +  NgrokAPI::Models::Listable.new(
    +    client: self,
    +    attrs: result,
    +    list_property: LIST_PROPERTY,
    +    klass: NgrokAPI::Models::StaticBackend,
    +    danger: true
    +  )
    +end
    +
    +
    + +
    +

    + + #update(id: "", description: nil, metadata: nil, address: "", tls: nil) ⇒ NgrokAPI::Models::StaticBackend + + + + + +

    +
    + +

    Update static backend by ID

    + +

    ngrok.com/docs/api#api-static-backends-update

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + description + + + (string) + + + (defaults to: nil) + + + — +
      +

      human-readable description of this backend. Optional

      +
      + +
    • + +
    • + + metadata + + + (string) + + + (defaults to: nil) + + + — +
      +

      arbitrary user-defined machine-readable data of this backend. Optional

      +
      + +
    • + +
    • + + address + + + (string) + + + (defaults to: "") + + + — +
      +

      the address to forward to

      +
      + +
    • + +
    • + + tls + + + (StaticBackendTLS) + + + (defaults to: nil) + + + — +
      +

      tls configuration to use

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +201
    +202
    +203
    +204
    +205
    +206
    +207
    +208
    +209
    +210
    +211
    +212
    +213
    +
    +
    # File 'lib/ngrokapi/services/static_backends_client.rb', line 201
    +
    +def update(id: "", description: nil, metadata: nil, address: "", tls: nil)
    +  path = '/backends/static/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  data[:description] = description if description
    +  data[:metadata] =  if 
    +  data[:address] = address if address
    +  data[:tls] = tls if tls
    +  result = @client.patch(path % replacements, data: data)
    +  NgrokAPI::Models::StaticBackend.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #update!(id: "", description: nil, metadata: nil, address: "", tls: nil) ⇒ NgrokAPI::Models::StaticBackend + + + + + +

    +
    + +

    Update static backend by ID Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-static-backends-update

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + description + + + (string) + + + (defaults to: nil) + + + — +
      +

      human-readable description of this backend. Optional

      +
      + +
    • + +
    • + + metadata + + + (string) + + + (defaults to: nil) + + + — +
      +

      arbitrary user-defined machine-readable data of this backend. Optional

      +
      + +
    • + +
    • + + address + + + (string) + + + (defaults to: "") + + + — +
      +

      the address to forward to

      +
      + +
    • + +
    • + + tls + + + (StaticBackendTLS) + + + (defaults to: nil) + + + — +
      +

      tls configuration to use

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +227
    +228
    +229
    +230
    +231
    +232
    +233
    +234
    +235
    +236
    +237
    +238
    +239
    +
    +
    # File 'lib/ngrokapi/services/static_backends_client.rb', line 227
    +
    +def update!(id: "", description: nil, metadata: nil, address: "", tls: nil)
    +  path = '/backends/static/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  data[:description] = description if description
    +  data[:metadata] =  if 
    +  data[:address] = address if address
    +  data[:tls] = tls if tls
    +  result = @client.patch(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::StaticBackend.new(client: self, attrs: result)
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html b/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html index 6fb3ca9..5f19577 100644 --- a/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +++ b/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::TCPEdgeBackendModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1029,9 +1029,9 @@ diff --git a/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html b/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html index f2491d8..e794218 100644 --- a/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +++ b/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::TCPEdgeIPRestrictionModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1029,9 +1029,9 @@ diff --git a/docs/NgrokAPI/Services/TCPEdgePolicyModuleClient.html b/docs/NgrokAPI/Services/TCPEdgePolicyModuleClient.html new file mode 100644 index 0000000..080d60f --- /dev/null +++ b/docs/NgrokAPI/Services/TCPEdgePolicyModuleClient.html @@ -0,0 +1,1039 @@ + + + + + + + Class: NgrokAPI::Services::TCPEdgePolicyModuleClient + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: NgrokAPI::Services::TCPEdgePolicyModuleClient + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/services/tcp_edge_policy_module_client.rb
    +
    + +
    + +

    Overview

    +
    + + +
    + +

    + Constant Summary + collapse +

    + +
    + +
    PATH = +
    +
    + +

    The API path for the requests

    + + +
    +
    +
    + + +
    +
    +
    '/edges/tcp/%{id}/policy'
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client:) ⇒ TCPEdgePolicyModuleClient + + + + + +

    +
    + +

    Returns a new instance of TCPEdgePolicyModuleClient.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +15
    +16
    +17
    +
    +
    # File 'lib/ngrokapi/services/tcp_edge_policy_module_client.rb', line 15
    +
    +def initialize(client:)
    +  @client = client
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +13
    +14
    +15
    +
    +
    # File 'lib/ngrokapi/services/tcp_edge_policy_module_client.rb', line 13
    +
    +def client
    +  @client
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #delete(id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +86
    +87
    +88
    +89
    +90
    +91
    +92
    +
    +
    # File 'lib/ngrokapi/services/tcp_edge_policy_module_client.rb', line 86
    +
    +def delete(id: "")
    +  path = '/edges/tcp/%{id}/policy'
    +  replacements = {
    +    id: id,
    +  }
    +  @client.delete(path % replacements)
    +end
    +
    +
    + +
    +

    + + #delete!(id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +99
    +100
    +101
    +102
    +103
    +104
    +105
    +
    +
    # File 'lib/ngrokapi/services/tcp_edge_policy_module_client.rb', line 99
    +
    +def delete!(id: "")
    +  path = '/edges/tcp/%{id}/policy'
    +  replacements = {
    +    id: id,
    +  }
    +  @client.delete(path % replacements, danger: true)
    +end
    +
    +
    + +
    +

    + + #get(id: "") ⇒ NgrokAPI::Models::EndpointPolicy + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +56
    +57
    +58
    +59
    +60
    +61
    +62
    +63
    +64
    +
    +
    # File 'lib/ngrokapi/services/tcp_edge_policy_module_client.rb', line 56
    +
    +def get(id: "")
    +  path = '/edges/tcp/%{id}/policy'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data)
    +  NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #get!(id: "") ⇒ NgrokAPI::Models::EndpointPolicy + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +71
    +72
    +73
    +74
    +75
    +76
    +77
    +78
    +79
    +
    +
    # File 'lib/ngrokapi/services/tcp_edge_policy_module_client.rb', line 71
    +
    +def get!(id: "")
    +  path = '/edges/tcp/%{id}/policy'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #replace(id: "", a_module: nil) ⇒ NgrokAPI::Models::EndpointPolicy + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + a_module + + + (EndpointPolicy) + + + (defaults to: nil) + + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +25
    +26
    +27
    +28
    +29
    +30
    +31
    +32
    +33
    +
    +
    # File 'lib/ngrokapi/services/tcp_edge_policy_module_client.rb', line 25
    +
    +def replace(id: "", a_module: nil)
    +  path = '/edges/tcp/%{id}/policy'
    +  replacements = {
    +    id: id,
    +  }
    +  data = a_module
    +  result = @client.put(path % replacements, data: data)
    +  NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #replace!(id: "", a_module: nil) ⇒ NgrokAPI::Models::EndpointPolicy + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + a_module + + + (EndpointPolicy) + + + (defaults to: nil) + + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +41
    +42
    +43
    +44
    +45
    +46
    +47
    +48
    +49
    +
    +
    # File 'lib/ngrokapi/services/tcp_edge_policy_module_client.rb', line 41
    +
    +def replace!(id: "", a_module: nil)
    +  path = '/edges/tcp/%{id}/policy'
    +  replacements = {
    +    id: id,
    +  }
    +  data = a_module
    +  result = @client.put(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/NgrokAPI/Services/TLSCertificatesClient.html b/docs/NgrokAPI/Services/TLSCertificatesClient.html index 5b797a2..a3602b5 100644 --- a/docs/NgrokAPI/Services/TLSCertificatesClient.html +++ b/docs/NgrokAPI/Services/TLSCertificatesClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::TLSCertificatesClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -642,7 +642,7 @@ —
    -

    chain of PEM-encoded certificates, leaf first. See Certificate Bundles <https://ngrok.com/docs/cloud-edge/endpoints#certificate-chains>_.

    +

    chain of PEM-encoded certificates, leaf first. See Certificate Bundles <https://ngrok.com/docs/cloud-edge/endpoints#certificate-chains>_.

    @@ -658,7 +658,7 @@ —
    -

    private key for the TLS certificate, PEM-encoded. See Private Keys <https://ngrok.com/docs/cloud-edge/endpoints#private-keys>_.

    +

    private key for the TLS certificate, PEM-encoded. See Private Keys <https://ngrok.com/docs/cloud-edge/endpoints#private-keys>_.

    @@ -793,7 +793,7 @@ —
    -

    chain of PEM-encoded certificates, leaf first. See Certificate Bundles <https://ngrok.com/docs/cloud-edge/endpoints#certificate-chains>_.

    +

    chain of PEM-encoded certificates, leaf first. See Certificate Bundles <https://ngrok.com/docs/cloud-edge/endpoints#certificate-chains>_.

    @@ -809,7 +809,7 @@ —
    -

    private key for the TLS certificate, PEM-encoded. See Private Keys <https://ngrok.com/docs/cloud-edge/endpoints#private-keys>_.

    +

    private key for the TLS certificate, PEM-encoded. See Private Keys <https://ngrok.com/docs/cloud-edge/endpoints#private-keys>_.

    @@ -1781,9 +1781,9 @@ diff --git a/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html b/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html index 210e5d5..e28560a 100644 --- a/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +++ b/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::TLSEdgeBackendModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1029,9 +1029,9 @@ diff --git a/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html b/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html index 00a6ff5..98ec1e4 100644 --- a/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +++ b/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::TLSEdgeIPRestrictionModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1029,9 +1029,9 @@ diff --git a/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html b/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html index b5dc2e7..ba6d9bd 100644 --- a/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +++ b/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::TLSEdgeMutualTLSModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1029,9 +1029,9 @@ diff --git a/docs/NgrokAPI/Services/TLSEdgePolicyModuleClient.html b/docs/NgrokAPI/Services/TLSEdgePolicyModuleClient.html new file mode 100644 index 0000000..5a864d2 --- /dev/null +++ b/docs/NgrokAPI/Services/TLSEdgePolicyModuleClient.html @@ -0,0 +1,1039 @@ + + + + + + + Class: NgrokAPI::Services::TLSEdgePolicyModuleClient + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: NgrokAPI::Services::TLSEdgePolicyModuleClient + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/services/tls_edge_policy_module_client.rb
    +
    + +
    + +

    Overview

    +
    + + +
    + +

    + Constant Summary + collapse +

    + +
    + +
    PATH = +
    +
    + +

    The API path for the requests

    + + +
    +
    +
    + + +
    +
    +
    '/edges/tls/%{id}/policy'
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client:) ⇒ TLSEdgePolicyModuleClient + + + + + +

    +
    + +

    Returns a new instance of TLSEdgePolicyModuleClient.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +15
    +16
    +17
    +
    +
    # File 'lib/ngrokapi/services/tls_edge_policy_module_client.rb', line 15
    +
    +def initialize(client:)
    +  @client = client
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +13
    +14
    +15
    +
    +
    # File 'lib/ngrokapi/services/tls_edge_policy_module_client.rb', line 13
    +
    +def client
    +  @client
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #delete(id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +86
    +87
    +88
    +89
    +90
    +91
    +92
    +
    +
    # File 'lib/ngrokapi/services/tls_edge_policy_module_client.rb', line 86
    +
    +def delete(id: "")
    +  path = '/edges/tls/%{id}/policy'
    +  replacements = {
    +    id: id,
    +  }
    +  @client.delete(path % replacements)
    +end
    +
    +
    + +
    +

    + + #delete!(id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +99
    +100
    +101
    +102
    +103
    +104
    +105
    +
    +
    # File 'lib/ngrokapi/services/tls_edge_policy_module_client.rb', line 99
    +
    +def delete!(id: "")
    +  path = '/edges/tls/%{id}/policy'
    +  replacements = {
    +    id: id,
    +  }
    +  @client.delete(path % replacements, danger: true)
    +end
    +
    +
    + +
    +

    + + #get(id: "") ⇒ NgrokAPI::Models::EndpointPolicy + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +56
    +57
    +58
    +59
    +60
    +61
    +62
    +63
    +64
    +
    +
    # File 'lib/ngrokapi/services/tls_edge_policy_module_client.rb', line 56
    +
    +def get(id: "")
    +  path = '/edges/tls/%{id}/policy'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data)
    +  NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #get!(id: "") ⇒ NgrokAPI::Models::EndpointPolicy + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +71
    +72
    +73
    +74
    +75
    +76
    +77
    +78
    +79
    +
    +
    # File 'lib/ngrokapi/services/tls_edge_policy_module_client.rb', line 71
    +
    +def get!(id: "")
    +  path = '/edges/tls/%{id}/policy'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #replace(id: "", a_module: nil) ⇒ NgrokAPI::Models::EndpointPolicy + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + a_module + + + (EndpointPolicy) + + + (defaults to: nil) + + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +25
    +26
    +27
    +28
    +29
    +30
    +31
    +32
    +33
    +
    +
    # File 'lib/ngrokapi/services/tls_edge_policy_module_client.rb', line 25
    +
    +def replace(id: "", a_module: nil)
    +  path = '/edges/tls/%{id}/policy'
    +  replacements = {
    +    id: id,
    +  }
    +  data = a_module
    +  result = @client.put(path % replacements, data: data)
    +  NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #replace!(id: "", a_module: nil) ⇒ NgrokAPI::Models::EndpointPolicy + + + + + +

    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + +
    • + +
    • + + a_module + + + (EndpointPolicy) + + + (defaults to: nil) + + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +41
    +42
    +43
    +44
    +45
    +46
    +47
    +48
    +49
    +
    +
    # File 'lib/ngrokapi/services/tls_edge_policy_module_client.rb', line 41
    +
    +def replace!(id: "", a_module: nil)
    +  path = '/edges/tls/%{id}/policy'
    +  replacements = {
    +    id: id,
    +  }
    +  data = a_module
    +  result = @client.put(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html b/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html index b4d295d..052431b 100644 --- a/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +++ b/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::TLSEdgeTLSTerminationModuleClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1029,9 +1029,9 @@ diff --git a/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html b/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html index 786a877..34cbe87 100644 --- a/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +++ b/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::TunnelGroupBackendsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1789,9 +1789,9 @@ diff --git a/docs/NgrokAPI/Services/TunnelSessionsClient.html b/docs/NgrokAPI/Services/TunnelSessionsClient.html index 654935b..70e09c4 100644 --- a/docs/NgrokAPI/Services/TunnelSessionsClient.html +++ b/docs/NgrokAPI/Services/TunnelSessionsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::TunnelSessionsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -1408,7 +1408,7 @@
    -

    Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent's configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted

    +

    Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent’s configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted

    ngrok.com/docs/api#api-tunnel-sessions-update

    @@ -1494,7 +1494,7 @@
    -

    Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent's configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted Throws an exception if API error.

    +

    Issues a command instructing the ngrok agent to update itself to the latest version. After this call completes successfully, the ngrok agent will be in the update process. A caller should wait some amount of time to allow the update to complete (at least 10 seconds) before making a call to the Restart endpoint to request that the agent restart itself to start using the new code. This call will never update an ngrok agent to a new major version which could cause breaking compatibility issues. If you wish to update to a new major version, that must be done manually. Still, please be aware that updating your ngrok agent could break your integration. This call will fail in any of the following circumstances: there is no update available the ngrok agent’s configuration disabled update checks the agent is currently in process of updating the agent has already successfully updated but has not yet been restarted Throws an exception if API error.

    ngrok.com/docs/api#api-tunnel-sessions-update

    @@ -1573,9 +1573,9 @@
    diff --git a/docs/NgrokAPI/Services/TunnelsClient.html b/docs/NgrokAPI/Services/TunnelsClient.html index 39fb2cc..9035180 100644 --- a/docs/NgrokAPI/Services/TunnelsClient.html +++ b/docs/NgrokAPI/Services/TunnelsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::TunnelsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -893,9 +893,9 @@
    diff --git a/docs/NgrokAPI/Services/WeightedBackendsClient.html b/docs/NgrokAPI/Services/WeightedBackendsClient.html index a9d5410..dca86e9 100644 --- a/docs/NgrokAPI/Services/WeightedBackendsClient.html +++ b/docs/NgrokAPI/Services/WeightedBackendsClient.html @@ -6,7 +6,7 @@ Class: NgrokAPI::Services::WeightedBackendsClient - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -102,7 +102,7 @@

    Overview

    -

    A Weighted Backend balances traffic among the referenced backends. Traffic is assigned proportionally to each based on its weight. The percentage of traffic is calculated by dividing a backend's weight by the sum of all weights.

    +

    A Weighted Backend balances traffic among the referenced backends. Traffic is assigned proportionally to each based on its weight. The percentage of traffic is calculated by dividing a backend’s weight by the sum of all weights.

    ngrok.com/docs/api#api-weighted-backends

    @@ -1789,9 +1789,9 @@
    diff --git a/docs/_index.html b/docs/_index.html index 294b44d..f077f4b 100644 --- a/docs/_index.html +++ b/docs/_index.html @@ -4,7 +4,7 @@ - Documentation by YARD 0.9.34 + Documentation by YARD 0.9.36 @@ -52,7 +52,7 @@
    -

    Documentation by YARD 0.9.34

    +

    Documentation by YARD 0.9.36

    Alphabetic Index

    @@ -307,6 +307,13 @@ +
  • + EdgeRoutePolicyModuleClient + + (NgrokAPI::Services) + +
  • +
  • EdgeRouteRequestHeadersModuleClient @@ -328,6 +335,13 @@
  • +
  • + EdgeRouteUserAgentFilterModuleClient + + (NgrokAPI::Services) + +
  • +
  • EdgeRouteWebhookVerificationModuleClient @@ -377,6 +391,13 @@
  • +
  • + EndpointAction + + (NgrokAPI::Models) + +
  • +
  • EndpointBackend @@ -510,6 +531,13 @@
  • +
  • + EndpointPolicy + + (NgrokAPI::Models) + +
  • +
  • EndpointRequestHeaders @@ -524,6 +552,13 @@
  • +
  • + EndpointRule + + (NgrokAPI::Models) + +
  • +
  • EndpointSAML @@ -552,6 +587,13 @@
  • +
  • + EndpointUserAgentFilter + + (NgrokAPI::Models) + +
  • +
  • EndpointWebhookValidation @@ -1024,6 +1066,27 @@
  • +
  • + StaticBackend + + (NgrokAPI::Models) + +
  • + +
  • + StaticBackendTLS + + (NgrokAPI::Models) + +
  • + +
  • + StaticBackendsClient + + (NgrokAPI::Services) + +
  • + @@ -1053,6 +1116,13 @@ +
  • + TCPEdgePolicyModuleClient + + (NgrokAPI::Services) + +
  • +
  • TLSCertificate @@ -1102,6 +1172,13 @@
  • +
  • + TLSEdgePolicyModuleClient + + (NgrokAPI::Services) + +
  • +
  • TLSEdgeTLSTerminationModuleClient @@ -1203,9 +1280,9 @@
  • diff --git a/docs/class_list.html b/docs/class_list.html index 4ad7273..6c9277a 100644 --- a/docs/class_list.html +++ b/docs/class_list.html @@ -43,7 +43,7 @@
    diff --git a/docs/file.README.html b/docs/file.README.html index d046120..a0433cf 100644 --- a/docs/file.README.html +++ b/docs/file.README.html @@ -6,7 +6,7 @@ File: README - — Documentation by YARD 0.9.34 + — Documentation by YARD 0.9.36 @@ -147,9 +147,9 @@ diff --git a/docs/frames.html b/docs/frames.html index 4f918f5..53734c2 100644 --- a/docs/frames.html +++ b/docs/frames.html @@ -2,13 +2,18 @@ - Documentation by YARD 0.9.34 + Documentation by YARD 0.9.36