ngrok-api 0.21.0 → 0.22.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +4 -0
- data/doc/NgrokAPI/Client.html +152 -96
- data/doc/NgrokAPI/Error.html +3 -3
- data/doc/NgrokAPI/Errors/NotFoundError.html +3 -3
- data/doc/NgrokAPI/Errors.html +3 -3
- data/doc/NgrokAPI/HttpClient.html +4 -4
- data/doc/NgrokAPI/Models/APIKey.html +3 -3
- data/doc/NgrokAPI/Models/AWSAuth.html +3 -3
- data/doc/NgrokAPI/Models/AWSCredentials.html +3 -3
- data/doc/NgrokAPI/Models/AWSRole.html +3 -3
- data/doc/NgrokAPI/Models/AbuseReport.html +3 -3
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +3 -3
- data/doc/NgrokAPI/Models/AgentIngress.html +3 -3
- data/doc/NgrokAPI/Models/AgentIngressCertJob.html +3 -3
- data/doc/NgrokAPI/Models/AgentIngressCertPolicy.html +3 -3
- data/doc/NgrokAPI/Models/AgentIngressCertStatus.html +3 -3
- data/doc/NgrokAPI/Models/ApplicationSession.html +3 -3
- data/doc/NgrokAPI/Models/ApplicationUser.html +3 -3
- data/doc/NgrokAPI/Models/BotUser.html +1051 -0
- data/doc/NgrokAPI/Models/BrowserSession.html +3 -3
- data/doc/NgrokAPI/Models/CertificateAuthority.html +3 -3
- data/doc/NgrokAPI/Models/Credential.html +3 -3
- data/doc/NgrokAPI/Models/Endpoint.html +3 -3
- data/doc/NgrokAPI/Models/EndpointAction.html +669 -0
- data/doc/NgrokAPI/Models/EndpointBackend.html +3 -3
- data/doc/NgrokAPI/Models/EndpointBackendMutate.html +3 -3
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +3 -3
- data/doc/NgrokAPI/Models/EndpointCompression.html +3 -3
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +3 -3
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +3 -3
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +3 -3
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuth.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthAmazon.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthGitLab.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthLinkedIn.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthTwitch.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOIDC.html +3 -3
- data/doc/NgrokAPI/Models/EndpointPolicy.html +743 -0
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +3 -3
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +3 -3
- data/doc/NgrokAPI/Models/EndpointRule.html +743 -0
- data/doc/NgrokAPI/Models/EndpointSAML.html +18 -96
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +18 -96
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +3 -3
- data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +3 -3
- data/doc/NgrokAPI/Models/EndpointUserAgentFilter.html +743 -0
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +3 -3
- data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +3 -3
- data/doc/NgrokAPI/Models/EventDestination.html +3 -3
- data/doc/NgrokAPI/Models/EventSource.html +19 -167
- data/doc/NgrokAPI/Models/EventSourceList.html +3 -3
- data/doc/NgrokAPI/Models/EventSourceReplace.html +19 -167
- data/doc/NgrokAPI/Models/EventSubscription.html +3 -3
- data/doc/NgrokAPI/Models/EventTarget.html +18 -92
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +3 -3
- data/doc/NgrokAPI/Models/EventTargetDatadog.html +3 -3
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +3 -3
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +3 -3
- data/doc/NgrokAPI/Models/FailoverBackend.html +3 -3
- data/doc/NgrokAPI/Models/HTTPResponseBackend.html +3 -3
- data/doc/NgrokAPI/Models/HTTPSEdge.html +3 -3
- data/doc/NgrokAPI/Models/HTTPSEdgeRoute.html +197 -37
- data/doc/NgrokAPI/Models/IPPolicy.html +27 -101
- data/doc/NgrokAPI/Models/IPPolicyRule.html +3 -3
- data/doc/NgrokAPI/Models/IPRestriction.html +3 -3
- data/doc/NgrokAPI/Models/IdentityProvider.html +3 -3
- data/doc/NgrokAPI/Models/Listable.html +3 -3
- data/doc/NgrokAPI/Models/Location.html +3 -3
- data/doc/NgrokAPI/Models/Ref.html +3 -3
- data/doc/NgrokAPI/Models/ReservedAddr.html +22 -96
- data/doc/NgrokAPI/Models/ReservedDomain.html +25 -173
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +3 -3
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +3 -3
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +3 -3
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +3 -3
- data/doc/NgrokAPI/Models/SSHCredential.html +3 -3
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +3 -3
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +3 -3
- data/doc/NgrokAPI/Models/StaticBackend.html +1211 -0
- data/doc/NgrokAPI/Models/StaticBackendTLS.html +595 -0
- data/doc/NgrokAPI/Models/TCPEdge.html +112 -32
- data/doc/NgrokAPI/Models/TLSCertificate.html +3 -3
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +3 -3
- data/doc/NgrokAPI/Models/TLSEdge.html +112 -32
- data/doc/NgrokAPI/Models/Tunnel.html +3 -3
- data/doc/NgrokAPI/Models/TunnelGroupBackend.html +3 -3
- data/doc/NgrokAPI/Models/TunnelSession.html +3 -3
- data/doc/NgrokAPI/Models/UserAgent.html +3 -3
- data/doc/NgrokAPI/Models/WeightedBackend.html +3 -3
- data/doc/NgrokAPI/Models.html +5 -5
- data/doc/NgrokAPI/PagedIterator.html +3 -3
- data/doc/NgrokAPI/Services/APIKeysClient.html +4 -4
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +4 -4
- data/doc/NgrokAPI/Services/AgentIngressesClient.html +3 -3
- data/doc/NgrokAPI/Services/ApplicationSessionsClient.html +3 -3
- data/doc/NgrokAPI/Services/ApplicationUsersClient.html +3 -3
- data/doc/NgrokAPI/Services/BotUsersClient.html +1717 -0
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +3 -3
- data/doc/NgrokAPI/Services/CredentialsClient.html +9 -9
- data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/EdgeRoutePolicyModuleClient.html +1149 -0
- data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html +1149 -0
- data/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/EdgesHTTPSClient.html +3 -3
- data/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +233 -93
- data/doc/NgrokAPI/Services/EdgesTCPClient.html +159 -79
- data/doc/NgrokAPI/Services/EdgesTLSClient.html +159 -79
- data/doc/NgrokAPI/Services/EndpointsClient.html +3 -3
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +3 -3
- data/doc/NgrokAPI/Services/EventSourcesClient.html +3 -3
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +7 -7
- data/doc/NgrokAPI/Services/FailoverBackendsClient.html +3 -3
- data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +3 -3
- data/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +3 -3
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +3 -3
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +3 -3
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +3 -3
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +6 -6
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +3 -3
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +5 -5
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +3 -3
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +7 -7
- data/doc/NgrokAPI/Services/StaticBackendsClient.html +1879 -0
- data/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/TCPEdgePolicyModuleClient.html +1039 -0
- data/doc/NgrokAPI/Services/TLSCertificatesClient.html +7 -7
- data/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/TLSEdgePolicyModuleClient.html +1039 -0
- data/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +3 -3
- data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +3 -3
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +5 -5
- data/doc/NgrokAPI/Services/TunnelsClient.html +3 -3
- data/doc/NgrokAPI/Services/WeightedBackendsClient.html +4 -4
- data/doc/NgrokAPI/Services.html +5 -5
- data/doc/NgrokAPI.html +4 -4
- data/doc/_index.html +95 -4
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +3 -3
- data/doc/frames.html +10 -5
- data/doc/index.html +3 -3
- data/doc/method_list.html +1778 -818
- data/doc/top-level-namespace.html +3 -3
- data/docs/NgrokAPI/Client.html +152 -96
- data/docs/NgrokAPI/Error.html +3 -3
- data/docs/NgrokAPI/Errors/NotFoundError.html +3 -3
- data/docs/NgrokAPI/Errors.html +3 -3
- data/docs/NgrokAPI/HttpClient.html +4 -4
- data/docs/NgrokAPI/Models/APIKey.html +3 -3
- data/docs/NgrokAPI/Models/AWSAuth.html +3 -3
- data/docs/NgrokAPI/Models/AWSCredentials.html +3 -3
- data/docs/NgrokAPI/Models/AWSRole.html +3 -3
- data/docs/NgrokAPI/Models/AbuseReport.html +3 -3
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +3 -3
- data/docs/NgrokAPI/Models/AgentIngress.html +3 -3
- data/docs/NgrokAPI/Models/AgentIngressCertJob.html +3 -3
- data/docs/NgrokAPI/Models/AgentIngressCertPolicy.html +3 -3
- data/docs/NgrokAPI/Models/AgentIngressCertStatus.html +3 -3
- data/docs/NgrokAPI/Models/ApplicationSession.html +3 -3
- data/docs/NgrokAPI/Models/ApplicationUser.html +3 -3
- data/docs/NgrokAPI/Models/BotUser.html +1051 -0
- data/docs/NgrokAPI/Models/BrowserSession.html +3 -3
- data/docs/NgrokAPI/Models/CertificateAuthority.html +3 -3
- data/docs/NgrokAPI/Models/Credential.html +3 -3
- data/docs/NgrokAPI/Models/Endpoint.html +3 -3
- data/docs/NgrokAPI/Models/EndpointAction.html +669 -0
- data/docs/NgrokAPI/Models/EndpointBackend.html +3 -3
- data/docs/NgrokAPI/Models/EndpointBackendMutate.html +3 -3
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +3 -3
- data/docs/NgrokAPI/Models/EndpointCompression.html +3 -3
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +3 -3
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +3 -3
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +3 -3
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuth.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthAmazon.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthGitLab.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthLinkedIn.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthTwitch.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOIDC.html +3 -3
- data/docs/NgrokAPI/Models/EndpointPolicy.html +743 -0
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +3 -3
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +3 -3
- data/docs/NgrokAPI/Models/EndpointRule.html +743 -0
- data/docs/NgrokAPI/Models/EndpointSAML.html +18 -96
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +18 -96
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +3 -3
- data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +3 -3
- data/docs/NgrokAPI/Models/EndpointUserAgentFilter.html +743 -0
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +3 -3
- data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +3 -3
- data/docs/NgrokAPI/Models/EventDestination.html +3 -3
- data/docs/NgrokAPI/Models/EventSource.html +19 -167
- data/docs/NgrokAPI/Models/EventSourceList.html +3 -3
- data/docs/NgrokAPI/Models/EventSourceReplace.html +19 -167
- data/docs/NgrokAPI/Models/EventSubscription.html +3 -3
- data/docs/NgrokAPI/Models/EventTarget.html +18 -92
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +3 -3
- data/docs/NgrokAPI/Models/EventTargetDatadog.html +3 -3
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +3 -3
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +3 -3
- data/docs/NgrokAPI/Models/FailoverBackend.html +3 -3
- data/docs/NgrokAPI/Models/HTTPResponseBackend.html +3 -3
- data/docs/NgrokAPI/Models/HTTPSEdge.html +3 -3
- data/docs/NgrokAPI/Models/HTTPSEdgeRoute.html +197 -37
- data/docs/NgrokAPI/Models/IPPolicy.html +27 -101
- data/docs/NgrokAPI/Models/IPPolicyRule.html +3 -3
- data/docs/NgrokAPI/Models/IPRestriction.html +3 -3
- data/docs/NgrokAPI/Models/IdentityProvider.html +3 -3
- data/docs/NgrokAPI/Models/Listable.html +3 -3
- data/docs/NgrokAPI/Models/Location.html +3 -3
- data/docs/NgrokAPI/Models/Ref.html +3 -3
- data/docs/NgrokAPI/Models/ReservedAddr.html +22 -96
- data/docs/NgrokAPI/Models/ReservedDomain.html +25 -173
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +3 -3
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +3 -3
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +3 -3
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +3 -3
- data/docs/NgrokAPI/Models/SSHCredential.html +3 -3
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +3 -3
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +3 -3
- data/docs/NgrokAPI/Models/StaticBackend.html +1211 -0
- data/docs/NgrokAPI/Models/StaticBackendTLS.html +595 -0
- data/docs/NgrokAPI/Models/TCPEdge.html +112 -32
- data/docs/NgrokAPI/Models/TLSCertificate.html +3 -3
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +3 -3
- data/docs/NgrokAPI/Models/TLSEdge.html +112 -32
- data/docs/NgrokAPI/Models/Tunnel.html +3 -3
- data/docs/NgrokAPI/Models/TunnelGroupBackend.html +3 -3
- data/docs/NgrokAPI/Models/TunnelSession.html +3 -3
- data/docs/NgrokAPI/Models/UserAgent.html +3 -3
- data/docs/NgrokAPI/Models/WeightedBackend.html +3 -3
- data/docs/NgrokAPI/Models.html +5 -5
- data/docs/NgrokAPI/PagedIterator.html +3 -3
- data/docs/NgrokAPI/Services/APIKeysClient.html +4 -4
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +4 -4
- data/docs/NgrokAPI/Services/AgentIngressesClient.html +3 -3
- data/docs/NgrokAPI/Services/ApplicationSessionsClient.html +3 -3
- data/docs/NgrokAPI/Services/ApplicationUsersClient.html +3 -3
- data/docs/NgrokAPI/Services/BotUsersClient.html +1717 -0
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +3 -3
- data/docs/NgrokAPI/Services/CredentialsClient.html +9 -9
- data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/EdgeRoutePolicyModuleClient.html +1149 -0
- data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html +1149 -0
- data/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/EdgesHTTPSClient.html +3 -3
- data/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +233 -93
- data/docs/NgrokAPI/Services/EdgesTCPClient.html +159 -79
- data/docs/NgrokAPI/Services/EdgesTLSClient.html +159 -79
- data/docs/NgrokAPI/Services/EndpointsClient.html +3 -3
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +3 -3
- data/docs/NgrokAPI/Services/EventSourcesClient.html +3 -3
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +7 -7
- data/docs/NgrokAPI/Services/FailoverBackendsClient.html +3 -3
- data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +3 -3
- data/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +3 -3
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +3 -3
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +3 -3
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +3 -3
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +6 -6
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +3 -3
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +5 -5
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +3 -3
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +7 -7
- data/docs/NgrokAPI/Services/StaticBackendsClient.html +1879 -0
- data/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/TCPEdgePolicyModuleClient.html +1039 -0
- data/docs/NgrokAPI/Services/TLSCertificatesClient.html +7 -7
- data/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/TLSEdgePolicyModuleClient.html +1039 -0
- data/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +3 -3
- data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +3 -3
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +5 -5
- data/docs/NgrokAPI/Services/TunnelsClient.html +3 -3
- data/docs/NgrokAPI/Services/WeightedBackendsClient.html +4 -4
- data/docs/NgrokAPI/Services.html +5 -5
- data/docs/NgrokAPI.html +4 -4
- data/docs/_index.html +95 -4
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +3 -3
- data/docs/frames.html +10 -5
- data/docs/index.html +3 -3
- data/docs/method_list.html +1778 -818
- data/docs/top-level-namespace.html +3 -3
- data/lib/ngrokapi/client.rb +6 -0
- data/lib/ngrokapi/models/bot_user.rb +70 -0
- data/lib/ngrokapi/models/endpoint_action.rb +33 -0
- data/lib/ngrokapi/models/endpoint_policy.rb +35 -0
- data/lib/ngrokapi/models/endpoint_rule.rb +35 -0
- data/lib/ngrokapi/models/endpoint_saml.rb +0 -4
- data/lib/ngrokapi/models/endpoint_saml_mutate.rb +0 -4
- data/lib/ngrokapi/models/endpoint_user_agent_filter.rb +35 -0
- data/lib/ngrokapi/models/event_source.rb +0 -4
- data/lib/ngrokapi/models/event_source_replace.rb +1 -5
- data/lib/ngrokapi/models/event_target.rb +0 -2
- data/lib/ngrokapi/models/https_edge_route.rb +13 -3
- data/lib/ngrokapi/models/ip_policy.rb +1 -3
- data/lib/ngrokapi/models/reserved_addr.rb +1 -3
- data/lib/ngrokapi/models/reserved_domain.rb +0 -4
- data/lib/ngrokapi/models/static_backend.rb +80 -0
- data/lib/ngrokapi/models/static_backend_tls.rb +31 -0
- data/lib/ngrokapi/models/tcp_edge.rb +8 -3
- data/lib/ngrokapi/models/tls_edge.rb +8 -3
- data/lib/ngrokapi/services/bot_users_client.rb +223 -0
- data/lib/ngrokapi/services/credentials_client.rb +2 -2
- data/lib/ngrokapi/services/edge_route_policy_module_client.rb +120 -0
- data/lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb +120 -0
- data/lib/ngrokapi/services/edges_https_routes_client.rb +20 -4
- data/lib/ngrokapi/services/edges_tcp_client.rb +12 -4
- data/lib/ngrokapi/services/edges_tls_client.rb +12 -4
- data/lib/ngrokapi/services/reserved_domains_client.rb +2 -2
- data/lib/ngrokapi/services/static_backends_client.rb +242 -0
- data/lib/ngrokapi/services/tcp_edge_policy_module_client.rb +108 -0
- data/lib/ngrokapi/services/tls_edge_policy_module_client.rb +108 -0
- data/lib/ngrokapi/version.rb +1 -1
- data/spec/ngrokapi/client_spec.rb +8 -0
- data/spec/ngrokapi/models/bot_user_spec.rb +44 -0
- data/spec/ngrokapi/models/endpoint_action_spec.rb +23 -0
- data/spec/ngrokapi/models/endpoint_policy_spec.rb +23 -0
- data/spec/ngrokapi/models/endpoint_rule_spec.rb +23 -0
- data/spec/ngrokapi/models/endpoint_user_agent_filter_spec.rb +23 -0
- data/spec/ngrokapi/models/https_edge_route_spec.rb +7 -1
- data/spec/ngrokapi/models/static_backend_spec.rb +50 -0
- data/spec/ngrokapi/models/static_backend_tls_spec.rb +23 -0
- data/spec/ngrokapi/models/tcp_edge_spec.rb +4 -1
- data/spec/ngrokapi/models/tls_edge_spec.rb +4 -1
- data/spec/ngrokapi/services/bot_users_client_spec.rb +178 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +4 -2
- data/spec/ngrokapi/services/edge_route_policy_module_client_spec.rb +139 -0
- data/spec/ngrokapi/services/edge_route_user_agent_filter_module_client_spec.rb +139 -0
- data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +20 -4
- data/spec/ngrokapi/services/edges_tcp_client_spec.rb +12 -4
- data/spec/ngrokapi/services/edges_tls_client_spec.rb +12 -4
- data/spec/ngrokapi/services/static_backends_client_spec.rb +194 -0
- data/spec/ngrokapi/services/tcp_edge_policy_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/tls_edge_policy_module_client_spec.rb +125 -0
- data/spec/spec_helper.rb +64 -0
- metadata +54 -2
|
@@ -6,7 +6,7 @@
|
|
|
6
6
|
<title>
|
|
7
7
|
Class: NgrokAPI::Services::EdgesHTTPSRoutesClient
|
|
8
8
|
|
|
9
|
-
— Documentation by YARD 0.9.
|
|
9
|
+
— Documentation by YARD 0.9.36
|
|
10
10
|
|
|
11
11
|
</title>
|
|
12
12
|
|
|
@@ -189,7 +189,7 @@
|
|
|
189
189
|
<li class="public ">
|
|
190
190
|
<span class="summary_signature">
|
|
191
191
|
|
|
192
|
-
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(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 </a>
|
|
192
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(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 </a>
|
|
193
193
|
|
|
194
194
|
|
|
195
195
|
|
|
@@ -213,7 +213,7 @@
|
|
|
213
213
|
<li class="public ">
|
|
214
214
|
<span class="summary_signature">
|
|
215
215
|
|
|
216
|
-
<a href="#create!-instance_method" title="#create! (instance method)">#<strong>create!</strong>(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 </a>
|
|
216
|
+
<a href="#create!-instance_method" title="#create! (instance method)">#<strong>create!</strong>(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 </a>
|
|
217
217
|
|
|
218
218
|
|
|
219
219
|
|
|
@@ -359,7 +359,7 @@
|
|
|
359
359
|
<li class="public ">
|
|
360
360
|
<span class="summary_signature">
|
|
361
361
|
|
|
362
|
-
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(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 </a>
|
|
362
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(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 </a>
|
|
363
363
|
|
|
364
364
|
|
|
365
365
|
|
|
@@ -383,7 +383,7 @@
|
|
|
383
383
|
<li class="public ">
|
|
384
384
|
<span class="summary_signature">
|
|
385
385
|
|
|
386
|
-
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(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 </a>
|
|
386
|
+
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(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 </a>
|
|
387
387
|
|
|
388
388
|
|
|
389
389
|
|
|
@@ -509,7 +509,7 @@
|
|
|
509
509
|
<div class="method_details first">
|
|
510
510
|
<h3 class="signature first" id="create-instance_method">
|
|
511
511
|
|
|
512
|
-
#<strong>create</strong>(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) ⇒ <tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>
|
|
512
|
+
#<strong>create</strong>(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) ⇒ <tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>
|
|
513
513
|
|
|
514
514
|
|
|
515
515
|
|
|
@@ -809,6 +809,37 @@
|
|
|
809
809
|
—
|
|
810
810
|
<div class='inline'>
|
|
811
811
|
<p>websocket to tcp adapter configuration or <code>null</code></p>
|
|
812
|
+
</div>
|
|
813
|
+
|
|
814
|
+
</li>
|
|
815
|
+
|
|
816
|
+
<li>
|
|
817
|
+
|
|
818
|
+
<span class='name'>user_agent_filter</span>
|
|
819
|
+
|
|
820
|
+
|
|
821
|
+
<span class='type'>(<tt>EndpointUserAgentFilter</tt>)</span>
|
|
822
|
+
|
|
823
|
+
|
|
824
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
825
|
+
|
|
826
|
+
|
|
827
|
+
</li>
|
|
828
|
+
|
|
829
|
+
<li>
|
|
830
|
+
|
|
831
|
+
<span class='name'>policy</span>
|
|
832
|
+
|
|
833
|
+
|
|
834
|
+
<span class='type'>(<tt>EndpointPolicy</tt>)</span>
|
|
835
|
+
|
|
836
|
+
|
|
837
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
838
|
+
|
|
839
|
+
|
|
840
|
+
—
|
|
841
|
+
<div class='inline'>
|
|
842
|
+
<p>the traffic policy associated with this edge or null</p>
|
|
812
843
|
</div>
|
|
813
844
|
|
|
814
845
|
</li>
|
|
@@ -840,8 +871,6 @@
|
|
|
840
871
|
<pre class="lines">
|
|
841
872
|
|
|
842
873
|
|
|
843
|
-
41
|
|
844
|
-
42
|
|
845
874
|
43
|
|
846
875
|
44
|
|
847
876
|
45
|
|
@@ -863,12 +892,16 @@
|
|
|
863
892
|
61
|
|
864
893
|
62
|
|
865
894
|
63
|
|
866
|
-
64
|
|
895
|
+
64
|
|
896
|
+
65
|
|
897
|
+
66
|
|
898
|
+
67
|
|
899
|
+
68</pre>
|
|
867
900
|
</td>
|
|
868
901
|
<td>
|
|
869
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line
|
|
902
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 43</span>
|
|
870
903
|
|
|
871
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>match_type:</span><span class='comma'>,</span> <span class='label'>match:</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>webhook_verification:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>websocket_tcp_converter:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
904
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>match_type:</span><span class='comma'>,</span> <span class='label'>match:</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>webhook_verification:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>websocket_tcp_converter:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>user_agent_filter:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>policy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
872
905
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{edge_id}/routes</span><span class='tstring_end'>'</span></span>
|
|
873
906
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
874
907
|
<span class='label'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</span>
|
|
@@ -889,6 +922,8 @@
|
|
|
889
922
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:saml</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_saml'>saml</span> <span class='kw'>if</span> <span class='id identifier rubyid_saml'>saml</span>
|
|
890
923
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oidc</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oidc'>oidc</span> <span class='kw'>if</span> <span class='id identifier rubyid_oidc'>oidc</span>
|
|
891
924
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:websocket_tcp_converter</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_websocket_tcp_converter'>websocket_tcp_converter</span> <span class='kw'>if</span> <span class='id identifier rubyid_websocket_tcp_converter'>websocket_tcp_converter</span>
|
|
925
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:user_agent_filter</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_user_agent_filter'>user_agent_filter</span> <span class='kw'>if</span> <span class='id identifier rubyid_user_agent_filter'>user_agent_filter</span>
|
|
926
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_policy'>policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_policy'>policy</span>
|
|
892
927
|
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
893
928
|
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">HTTPSEdgeRoute</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html#initialize-instance_method" title="NgrokAPI::Models::HTTPSEdgeRoute#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
894
929
|
<span class='kw'>end</span></pre>
|
|
@@ -900,7 +935,7 @@
|
|
|
900
935
|
<div class="method_details ">
|
|
901
936
|
<h3 class="signature " id="create!-instance_method">
|
|
902
937
|
|
|
903
|
-
#<strong>create!</strong>(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) ⇒ <tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>
|
|
938
|
+
#<strong>create!</strong>(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) ⇒ <tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>
|
|
904
939
|
|
|
905
940
|
|
|
906
941
|
|
|
@@ -1200,6 +1235,37 @@
|
|
|
1200
1235
|
—
|
|
1201
1236
|
<div class='inline'>
|
|
1202
1237
|
<p>websocket to tcp adapter configuration or <code>null</code></p>
|
|
1238
|
+
</div>
|
|
1239
|
+
|
|
1240
|
+
</li>
|
|
1241
|
+
|
|
1242
|
+
<li>
|
|
1243
|
+
|
|
1244
|
+
<span class='name'>user_agent_filter</span>
|
|
1245
|
+
|
|
1246
|
+
|
|
1247
|
+
<span class='type'>(<tt>EndpointUserAgentFilter</tt>)</span>
|
|
1248
|
+
|
|
1249
|
+
|
|
1250
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1251
|
+
|
|
1252
|
+
|
|
1253
|
+
</li>
|
|
1254
|
+
|
|
1255
|
+
<li>
|
|
1256
|
+
|
|
1257
|
+
<span class='name'>policy</span>
|
|
1258
|
+
|
|
1259
|
+
|
|
1260
|
+
<span class='type'>(<tt>EndpointPolicy</tt>)</span>
|
|
1261
|
+
|
|
1262
|
+
|
|
1263
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1264
|
+
|
|
1265
|
+
|
|
1266
|
+
—
|
|
1267
|
+
<div class='inline'>
|
|
1268
|
+
<p>the traffic policy associated with this edge or null</p>
|
|
1203
1269
|
</div>
|
|
1204
1270
|
|
|
1205
1271
|
</li>
|
|
@@ -1231,12 +1297,6 @@
|
|
|
1231
1297
|
<pre class="lines">
|
|
1232
1298
|
|
|
1233
1299
|
|
|
1234
|
-
89
|
|
1235
|
-
90
|
|
1236
|
-
91
|
|
1237
|
-
92
|
|
1238
|
-
93
|
|
1239
|
-
94
|
|
1240
1300
|
95
|
|
1241
1301
|
96
|
|
1242
1302
|
97
|
|
@@ -1254,12 +1314,20 @@
|
|
|
1254
1314
|
109
|
|
1255
1315
|
110
|
|
1256
1316
|
111
|
|
1257
|
-
112
|
|
1317
|
+
112
|
|
1318
|
+
113
|
|
1319
|
+
114
|
|
1320
|
+
115
|
|
1321
|
+
116
|
|
1322
|
+
117
|
|
1323
|
+
118
|
|
1324
|
+
119
|
|
1325
|
+
120</pre>
|
|
1258
1326
|
</td>
|
|
1259
1327
|
<td>
|
|
1260
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line
|
|
1328
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 95</span>
|
|
1261
1329
|
|
|
1262
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>match_type:</span><span class='comma'>,</span> <span class='label'>match:</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>webhook_verification:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>websocket_tcp_converter:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1330
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>match_type:</span><span class='comma'>,</span> <span class='label'>match:</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>webhook_verification:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>websocket_tcp_converter:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>user_agent_filter:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>policy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1263
1331
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{edge_id}/routes</span><span class='tstring_end'>'</span></span>
|
|
1264
1332
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1265
1333
|
<span class='label'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</span>
|
|
@@ -1280,6 +1348,8 @@
|
|
|
1280
1348
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:saml</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_saml'>saml</span> <span class='kw'>if</span> <span class='id identifier rubyid_saml'>saml</span>
|
|
1281
1349
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oidc</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oidc'>oidc</span> <span class='kw'>if</span> <span class='id identifier rubyid_oidc'>oidc</span>
|
|
1282
1350
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:websocket_tcp_converter</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_websocket_tcp_converter'>websocket_tcp_converter</span> <span class='kw'>if</span> <span class='id identifier rubyid_websocket_tcp_converter'>websocket_tcp_converter</span>
|
|
1351
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:user_agent_filter</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_user_agent_filter'>user_agent_filter</span> <span class='kw'>if</span> <span class='id identifier rubyid_user_agent_filter'>user_agent_filter</span>
|
|
1352
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_policy'>policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_policy'>policy</span>
|
|
1283
1353
|
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
1284
1354
|
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">HTTPSEdgeRoute</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html#initialize-instance_method" title="NgrokAPI::Models::HTTPSEdgeRoute#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
1285
1355
|
<span class='kw'>end</span></pre>
|
|
@@ -1374,17 +1444,17 @@
|
|
|
1374
1444
|
<pre class="lines">
|
|
1375
1445
|
|
|
1376
1446
|
|
|
1377
|
-
|
|
1378
|
-
|
|
1379
|
-
|
|
1380
|
-
|
|
1381
|
-
|
|
1382
|
-
|
|
1383
|
-
|
|
1384
|
-
|
|
1447
|
+
282
|
|
1448
|
+
283
|
|
1449
|
+
284
|
|
1450
|
+
285
|
|
1451
|
+
286
|
|
1452
|
+
287
|
|
1453
|
+
288
|
|
1454
|
+
289</pre>
|
|
1385
1455
|
</td>
|
|
1386
1456
|
<td>
|
|
1387
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line
|
|
1457
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 282</span>
|
|
1388
1458
|
|
|
1389
1459
|
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1390
1460
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{edge_id}/routes/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -1485,17 +1555,17 @@
|
|
|
1485
1555
|
<pre class="lines">
|
|
1486
1556
|
|
|
1487
1557
|
|
|
1488
|
-
|
|
1489
|
-
|
|
1490
|
-
|
|
1491
|
-
|
|
1492
|
-
|
|
1493
|
-
|
|
1494
|
-
|
|
1495
|
-
|
|
1558
|
+
300
|
|
1559
|
+
301
|
|
1560
|
+
302
|
|
1561
|
+
303
|
|
1562
|
+
304
|
|
1563
|
+
305
|
|
1564
|
+
306
|
|
1565
|
+
307</pre>
|
|
1496
1566
|
</td>
|
|
1497
1567
|
<td>
|
|
1498
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line
|
|
1568
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 300</span>
|
|
1499
1569
|
|
|
1500
1570
|
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1501
1571
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{edge_id}/routes/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -1596,19 +1666,19 @@
|
|
|
1596
1666
|
<pre class="lines">
|
|
1597
1667
|
|
|
1598
1668
|
|
|
1599
|
-
122
|
|
1600
|
-
123
|
|
1601
|
-
124
|
|
1602
|
-
125
|
|
1603
|
-
126
|
|
1604
|
-
127
|
|
1605
|
-
128
|
|
1606
|
-
129
|
|
1607
1669
|
130
|
|
1608
|
-
131
|
|
1670
|
+
131
|
|
1671
|
+
132
|
|
1672
|
+
133
|
|
1673
|
+
134
|
|
1674
|
+
135
|
|
1675
|
+
136
|
|
1676
|
+
137
|
|
1677
|
+
138
|
|
1678
|
+
139</pre>
|
|
1609
1679
|
</td>
|
|
1610
1680
|
<td>
|
|
1611
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line
|
|
1681
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 130</span>
|
|
1612
1682
|
|
|
1613
1683
|
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1614
1684
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{edge_id}/routes/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -1711,19 +1781,19 @@
|
|
|
1711
1781
|
<pre class="lines">
|
|
1712
1782
|
|
|
1713
1783
|
|
|
1714
|
-
142
|
|
1715
|
-
143
|
|
1716
|
-
144
|
|
1717
|
-
145
|
|
1718
|
-
146
|
|
1719
|
-
147
|
|
1720
|
-
148
|
|
1721
|
-
149
|
|
1722
1784
|
150
|
|
1723
|
-
151
|
|
1785
|
+
151
|
|
1786
|
+
152
|
|
1787
|
+
153
|
|
1788
|
+
154
|
|
1789
|
+
155
|
|
1790
|
+
156
|
|
1791
|
+
157
|
|
1792
|
+
158
|
|
1793
|
+
159</pre>
|
|
1724
1794
|
</td>
|
|
1725
1795
|
<td>
|
|
1726
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line
|
|
1796
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 150</span>
|
|
1727
1797
|
|
|
1728
1798
|
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1729
1799
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{edge_id}/routes/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -1743,7 +1813,7 @@
|
|
|
1743
1813
|
<div class="method_details ">
|
|
1744
1814
|
<h3 class="signature " id="update-instance_method">
|
|
1745
1815
|
|
|
1746
|
-
#<strong>update</strong>(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) ⇒ <tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>
|
|
1816
|
+
#<strong>update</strong>(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) ⇒ <tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>
|
|
1747
1817
|
|
|
1748
1818
|
|
|
1749
1819
|
|
|
@@ -2065,6 +2135,37 @@
|
|
|
2065
2135
|
—
|
|
2066
2136
|
<div class='inline'>
|
|
2067
2137
|
<p>websocket to tcp adapter configuration or <code>null</code></p>
|
|
2138
|
+
</div>
|
|
2139
|
+
|
|
2140
|
+
</li>
|
|
2141
|
+
|
|
2142
|
+
<li>
|
|
2143
|
+
|
|
2144
|
+
<span class='name'>user_agent_filter</span>
|
|
2145
|
+
|
|
2146
|
+
|
|
2147
|
+
<span class='type'>(<tt>EndpointUserAgentFilter</tt>)</span>
|
|
2148
|
+
|
|
2149
|
+
|
|
2150
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2151
|
+
|
|
2152
|
+
|
|
2153
|
+
</li>
|
|
2154
|
+
|
|
2155
|
+
<li>
|
|
2156
|
+
|
|
2157
|
+
<span class='name'>policy</span>
|
|
2158
|
+
|
|
2159
|
+
|
|
2160
|
+
<span class='type'>(<tt>EndpointPolicy</tt>)</span>
|
|
2161
|
+
|
|
2162
|
+
|
|
2163
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2164
|
+
|
|
2165
|
+
|
|
2166
|
+
—
|
|
2167
|
+
<div class='inline'>
|
|
2168
|
+
<p>the traffic policy associated with this edge or null</p>
|
|
2068
2169
|
</div>
|
|
2069
2170
|
|
|
2070
2171
|
</li>
|
|
@@ -2096,16 +2197,6 @@
|
|
|
2096
2197
|
<pre class="lines">
|
|
2097
2198
|
|
|
2098
2199
|
|
|
2099
|
-
179
|
|
2100
|
-
180
|
|
2101
|
-
181
|
|
2102
|
-
182
|
|
2103
|
-
183
|
|
2104
|
-
184
|
|
2105
|
-
185
|
|
2106
|
-
186
|
|
2107
|
-
187
|
|
2108
|
-
188
|
|
2109
2200
|
189
|
|
2110
2201
|
190
|
|
2111
2202
|
191
|
|
@@ -2120,12 +2211,24 @@
|
|
|
2120
2211
|
200
|
|
2121
2212
|
201
|
|
2122
2213
|
202
|
|
2123
|
-
203
|
|
2214
|
+
203
|
|
2215
|
+
204
|
|
2216
|
+
205
|
|
2217
|
+
206
|
|
2218
|
+
207
|
|
2219
|
+
208
|
|
2220
|
+
209
|
|
2221
|
+
210
|
|
2222
|
+
211
|
|
2223
|
+
212
|
|
2224
|
+
213
|
|
2225
|
+
214
|
|
2226
|
+
215</pre>
|
|
2124
2227
|
</td>
|
|
2125
2228
|
<td>
|
|
2126
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line
|
|
2229
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 189</span>
|
|
2127
2230
|
|
|
2128
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>match_type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>match:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>webhook_verification:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>websocket_tcp_converter:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
2231
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>match_type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>match:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>webhook_verification:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>websocket_tcp_converter:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>user_agent_filter:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>policy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
2129
2232
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{edge_id}/routes/%{id}</span><span class='tstring_end'>'</span></span>
|
|
2130
2233
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
2131
2234
|
<span class='label'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</span>
|
|
@@ -2147,6 +2250,8 @@
|
|
|
2147
2250
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:saml</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_saml'>saml</span> <span class='kw'>if</span> <span class='id identifier rubyid_saml'>saml</span>
|
|
2148
2251
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oidc</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oidc'>oidc</span> <span class='kw'>if</span> <span class='id identifier rubyid_oidc'>oidc</span>
|
|
2149
2252
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:websocket_tcp_converter</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_websocket_tcp_converter'>websocket_tcp_converter</span> <span class='kw'>if</span> <span class='id identifier rubyid_websocket_tcp_converter'>websocket_tcp_converter</span>
|
|
2253
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:user_agent_filter</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_user_agent_filter'>user_agent_filter</span> <span class='kw'>if</span> <span class='id identifier rubyid_user_agent_filter'>user_agent_filter</span>
|
|
2254
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_policy'>policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_policy'>policy</span>
|
|
2150
2255
|
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
|
2151
2256
|
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">HTTPSEdgeRoute</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html#initialize-instance_method" title="NgrokAPI::Models::HTTPSEdgeRoute#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
2152
2257
|
<span class='kw'>end</span></pre>
|
|
@@ -2158,7 +2263,7 @@
|
|
|
2158
2263
|
<div class="method_details ">
|
|
2159
2264
|
<h3 class="signature " id="update!-instance_method">
|
|
2160
2265
|
|
|
2161
|
-
#<strong>update!</strong>(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) ⇒ <tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>
|
|
2266
|
+
#<strong>update!</strong>(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) ⇒ <tt><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">NgrokAPI::Models::HTTPSEdgeRoute</a></span></tt>
|
|
2162
2267
|
|
|
2163
2268
|
|
|
2164
2269
|
|
|
@@ -2480,6 +2585,37 @@
|
|
|
2480
2585
|
—
|
|
2481
2586
|
<div class='inline'>
|
|
2482
2587
|
<p>websocket to tcp adapter configuration or <code>null</code></p>
|
|
2588
|
+
</div>
|
|
2589
|
+
|
|
2590
|
+
</li>
|
|
2591
|
+
|
|
2592
|
+
<li>
|
|
2593
|
+
|
|
2594
|
+
<span class='name'>user_agent_filter</span>
|
|
2595
|
+
|
|
2596
|
+
|
|
2597
|
+
<span class='type'>(<tt>EndpointUserAgentFilter</tt>)</span>
|
|
2598
|
+
|
|
2599
|
+
|
|
2600
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2601
|
+
|
|
2602
|
+
|
|
2603
|
+
</li>
|
|
2604
|
+
|
|
2605
|
+
<li>
|
|
2606
|
+
|
|
2607
|
+
<span class='name'>policy</span>
|
|
2608
|
+
|
|
2609
|
+
|
|
2610
|
+
<span class='type'>(<tt>EndpointPolicy</tt>)</span>
|
|
2611
|
+
|
|
2612
|
+
|
|
2613
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2614
|
+
|
|
2615
|
+
|
|
2616
|
+
—
|
|
2617
|
+
<div class='inline'>
|
|
2618
|
+
<p>the traffic policy associated with this edge or null</p>
|
|
2483
2619
|
</div>
|
|
2484
2620
|
|
|
2485
2621
|
</li>
|
|
@@ -2511,20 +2647,6 @@
|
|
|
2511
2647
|
<pre class="lines">
|
|
2512
2648
|
|
|
2513
2649
|
|
|
2514
|
-
232
|
|
2515
|
-
233
|
|
2516
|
-
234
|
|
2517
|
-
235
|
|
2518
|
-
236
|
|
2519
|
-
237
|
|
2520
|
-
238
|
|
2521
|
-
239
|
|
2522
|
-
240
|
|
2523
|
-
241
|
|
2524
|
-
242
|
|
2525
|
-
243
|
|
2526
|
-
244
|
|
2527
|
-
245
|
|
2528
2650
|
246
|
|
2529
2651
|
247
|
|
2530
2652
|
248
|
|
@@ -2535,12 +2657,28 @@
|
|
|
2535
2657
|
253
|
|
2536
2658
|
254
|
|
2537
2659
|
255
|
|
2538
|
-
256
|
|
2660
|
+
256
|
|
2661
|
+
257
|
|
2662
|
+
258
|
|
2663
|
+
259
|
|
2664
|
+
260
|
|
2665
|
+
261
|
|
2666
|
+
262
|
|
2667
|
+
263
|
|
2668
|
+
264
|
|
2669
|
+
265
|
|
2670
|
+
266
|
|
2671
|
+
267
|
|
2672
|
+
268
|
|
2673
|
+
269
|
|
2674
|
+
270
|
|
2675
|
+
271
|
|
2676
|
+
272</pre>
|
|
2539
2677
|
</td>
|
|
2540
2678
|
<td>
|
|
2541
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line
|
|
2679
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_https_routes_client.rb', line 246</span>
|
|
2542
2680
|
|
|
2543
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>match_type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>match:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>webhook_verification:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>websocket_tcp_converter:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
2681
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>edge_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>match_type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>match:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>circuit_breaker:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>compression:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>request_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>response_headers:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>webhook_verification:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oauth:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>saml:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>oidc:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>websocket_tcp_converter:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>user_agent_filter:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>policy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
2544
2682
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/https/%{edge_id}/routes/%{id}</span><span class='tstring_end'>'</span></span>
|
|
2545
2683
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
2546
2684
|
<span class='label'>edge_id:</span> <span class='id identifier rubyid_edge_id'>edge_id</span><span class='comma'>,</span>
|
|
@@ -2562,6 +2700,8 @@
|
|
|
2562
2700
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:saml</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_saml'>saml</span> <span class='kw'>if</span> <span class='id identifier rubyid_saml'>saml</span>
|
|
2563
2701
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:oidc</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_oidc'>oidc</span> <span class='kw'>if</span> <span class='id identifier rubyid_oidc'>oidc</span>
|
|
2564
2702
|
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:websocket_tcp_converter</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_websocket_tcp_converter'>websocket_tcp_converter</span> <span class='kw'>if</span> <span class='id identifier rubyid_websocket_tcp_converter'>websocket_tcp_converter</span>
|
|
2703
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:user_agent_filter</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_user_agent_filter'>user_agent_filter</span> <span class='kw'>if</span> <span class='id identifier rubyid_user_agent_filter'>user_agent_filter</span>
|
|
2704
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_policy'>policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_policy'>policy</span>
|
|
2565
2705
|
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
|
2566
2706
|
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html" title="NgrokAPI::Models::HTTPSEdgeRoute (class)">HTTPSEdgeRoute</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/HTTPSEdgeRoute.html#initialize-instance_method" title="NgrokAPI::Models::HTTPSEdgeRoute#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
2567
2707
|
<span class='kw'>end</span></pre>
|
|
@@ -2575,9 +2715,9 @@
|
|
|
2575
2715
|
</div>
|
|
2576
2716
|
|
|
2577
2717
|
<div id="footer">
|
|
2578
|
-
Generated on
|
|
2718
|
+
Generated on Tue Apr 30 20:26:23 2024 by
|
|
2579
2719
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
2580
|
-
0.9.
|
|
2720
|
+
0.9.36 (ruby-3.3.0).
|
|
2581
2721
|
</div>
|
|
2582
2722
|
|
|
2583
2723
|
</div>
|