ngrok-api 0.26.0 → 0.28.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 +10 -0
- data/Gemfile.lock +1 -11
- data/doc/NgrokAPI/Client.html +100 -48
- data/doc/NgrokAPI/Error.html +2 -2
- data/doc/NgrokAPI/Errors/NotFoundError.html +2 -2
- data/doc/NgrokAPI/Errors.html +2 -2
- data/doc/NgrokAPI/HttpClient.html +2 -2
- data/doc/NgrokAPI/Models/APIKey.html +2 -2
- data/doc/NgrokAPI/Models/AWSAuth.html +2 -2
- data/doc/NgrokAPI/Models/AWSCredentials.html +2 -2
- data/doc/NgrokAPI/Models/AWSRole.html +2 -2
- data/doc/NgrokAPI/Models/AbuseReport.html +2 -2
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +2 -2
- data/doc/NgrokAPI/Models/AgentIngress.html +2 -2
- data/doc/NgrokAPI/Models/AgentIngressCertJob.html +2 -2
- data/doc/NgrokAPI/Models/AgentIngressCertPolicy.html +2 -2
- data/doc/NgrokAPI/Models/AgentIngressCertStatus.html +2 -2
- data/doc/NgrokAPI/Models/ApplicationSession.html +2 -2
- data/doc/NgrokAPI/Models/ApplicationUser.html +2 -2
- data/doc/NgrokAPI/Models/BotUser.html +2 -2
- data/doc/NgrokAPI/Models/BrowserSession.html +2 -2
- data/doc/NgrokAPI/Models/CertificateAuthority.html +2 -2
- data/doc/NgrokAPI/Models/Credential.html +2 -2
- data/doc/NgrokAPI/Models/Endpoint.html +5 -5
- data/doc/NgrokAPI/Models/EndpointBackend.html +2 -2
- data/doc/NgrokAPI/Models/EndpointBackendMutate.html +2 -2
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +2 -2
- data/doc/NgrokAPI/Models/EndpointCompression.html +2 -2
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +2 -2
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +2 -2
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +2 -2
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuth.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthAmazon.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthGitLab.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthLinkedIn.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthTwitch.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOIDC.html +2 -2
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +2 -2
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +2 -2
- data/doc/NgrokAPI/Models/EndpointSAML.html +2 -2
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +2 -2
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +2 -2
- data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +2 -2
- data/doc/NgrokAPI/Models/EndpointTrafficPolicy.html +2 -2
- data/doc/NgrokAPI/Models/EndpointUserAgentFilter.html +2 -2
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +2 -2
- data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +2 -2
- data/doc/NgrokAPI/Models/EventDestination.html +2 -2
- data/doc/NgrokAPI/Models/EventSource.html +2 -2
- data/doc/NgrokAPI/Models/EventSourceList.html +2 -2
- data/doc/NgrokAPI/Models/EventSourceReplace.html +2 -2
- data/doc/NgrokAPI/Models/EventSubscription.html +2 -2
- data/doc/NgrokAPI/Models/EventTarget.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetAzureLogsIngestion.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetDatadog.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +2 -2
- data/doc/NgrokAPI/Models/FailoverBackend.html +2 -2
- data/doc/NgrokAPI/Models/HTTPResponseBackend.html +2 -2
- data/doc/NgrokAPI/Models/HTTPSEdge.html +2 -2
- data/doc/NgrokAPI/Models/HTTPSEdgeRoute.html +2 -2
- data/doc/NgrokAPI/Models/IPPolicy.html +2 -2
- data/doc/NgrokAPI/Models/IPPolicyRule.html +2 -2
- data/doc/NgrokAPI/Models/IPRestriction.html +2 -2
- data/doc/NgrokAPI/Models/IdentityProvider.html +2 -2
- data/doc/NgrokAPI/Models/Listable.html +2 -2
- data/doc/NgrokAPI/Models/Location.html +2 -2
- data/doc/NgrokAPI/Models/Ref.html +2 -2
- data/doc/NgrokAPI/Models/ReservedAddr.html +2 -2
- data/doc/NgrokAPI/Models/ReservedDomain.html +95 -21
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +2 -2
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +2 -2
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +2 -2
- data/doc/NgrokAPI/Models/ReservedDomainResolvesToEntry.html +595 -0
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +2 -2
- data/doc/NgrokAPI/Models/SSHCredential.html +2 -2
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +2 -2
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +2 -2
- data/doc/NgrokAPI/Models/Secret.html +95 -21
- data/doc/NgrokAPI/Models/ServiceUser.html +1051 -0
- data/doc/NgrokAPI/Models/StaticBackend.html +2 -2
- data/doc/NgrokAPI/Models/StaticBackendTLS.html +2 -2
- data/doc/NgrokAPI/Models/TCPEdge.html +2 -2
- data/doc/NgrokAPI/Models/TLSCertificate.html +2 -2
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +2 -2
- data/doc/NgrokAPI/Models/TLSEdge.html +2 -2
- data/doc/NgrokAPI/Models/Tunnel.html +2 -2
- data/doc/NgrokAPI/Models/TunnelGroupBackend.html +2 -2
- data/doc/NgrokAPI/Models/TunnelSession.html +2 -2
- data/doc/NgrokAPI/Models/UserAgent.html +2 -2
- data/doc/NgrokAPI/Models/Vault.html +2 -2
- data/doc/NgrokAPI/Models/WeightedBackend.html +2 -2
- data/doc/NgrokAPI/Models.html +4 -4
- data/doc/NgrokAPI/PagedIterator.html +2 -2
- data/doc/NgrokAPI/Services/APIKeysClient.html +95 -31
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +2 -2
- data/doc/NgrokAPI/Services/AgentIngressesClient.html +95 -31
- data/doc/NgrokAPI/Services/ApplicationSessionsClient.html +2 -2
- data/doc/NgrokAPI/Services/ApplicationUsersClient.html +2 -2
- data/doc/NgrokAPI/Services/BotUsersClient.html +2 -2
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +99 -35
- data/doc/NgrokAPI/Services/CredentialsClient.html +103 -39
- data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteTrafficPolicyModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgesHTTPSClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgesTCPClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgesTLSClient.html +2 -2
- data/doc/NgrokAPI/Services/EndpointsClient.html +163 -79
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +95 -31
- data/doc/NgrokAPI/Services/EventSourcesClient.html +2 -2
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +95 -31
- data/doc/NgrokAPI/Services/FailoverBackendsClient.html +2 -2
- data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +2 -2
- data/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +95 -31
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +95 -31
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +95 -31
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +95 -31
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +270 -126
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +99 -35
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +101 -37
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +6 -6
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +6 -6
- data/doc/NgrokAPI/Services/SecretsClient.html +181 -73
- data/doc/NgrokAPI/Services/ServiceUsersClient.html +1797 -0
- data/doc/NgrokAPI/Services/StaticBackendsClient.html +2 -2
- data/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TCPEdgeTrafficPolicyModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TLSCertificatesClient.html +95 -31
- data/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TLSEdgeTrafficPolicyModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +2 -2
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +143 -79
- data/doc/NgrokAPI/Services/TunnelsClient.html +2 -2
- data/doc/NgrokAPI/Services/VaultsClient.html +79 -15
- data/doc/NgrokAPI/Services/WeightedBackendsClient.html +2 -2
- data/doc/NgrokAPI/Services.html +4 -4
- data/doc/NgrokAPI.html +3 -3
- data/doc/_index.html +23 -2
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +2 -2
- data/doc/index.html +2 -2
- data/doc/method_list.html +1092 -812
- data/doc/top-level-namespace.html +2 -2
- data/docs/NgrokAPI/Client.html +100 -48
- data/docs/NgrokAPI/Error.html +2 -2
- data/docs/NgrokAPI/Errors/NotFoundError.html +2 -2
- data/docs/NgrokAPI/Errors.html +2 -2
- data/docs/NgrokAPI/HttpClient.html +2 -2
- data/docs/NgrokAPI/Models/APIKey.html +2 -2
- data/docs/NgrokAPI/Models/AWSAuth.html +2 -2
- data/docs/NgrokAPI/Models/AWSCredentials.html +2 -2
- data/docs/NgrokAPI/Models/AWSRole.html +2 -2
- data/docs/NgrokAPI/Models/AbuseReport.html +2 -2
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +2 -2
- data/docs/NgrokAPI/Models/AgentIngress.html +2 -2
- data/docs/NgrokAPI/Models/AgentIngressCertJob.html +2 -2
- data/docs/NgrokAPI/Models/AgentIngressCertPolicy.html +2 -2
- data/docs/NgrokAPI/Models/AgentIngressCertStatus.html +2 -2
- data/docs/NgrokAPI/Models/ApplicationSession.html +2 -2
- data/docs/NgrokAPI/Models/ApplicationUser.html +2 -2
- data/docs/NgrokAPI/Models/BotUser.html +2 -2
- data/docs/NgrokAPI/Models/BrowserSession.html +2 -2
- data/docs/NgrokAPI/Models/CertificateAuthority.html +2 -2
- data/docs/NgrokAPI/Models/Credential.html +2 -2
- data/docs/NgrokAPI/Models/Endpoint.html +5 -5
- data/docs/NgrokAPI/Models/EndpointBackend.html +2 -2
- data/docs/NgrokAPI/Models/EndpointBackendMutate.html +2 -2
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +2 -2
- data/docs/NgrokAPI/Models/EndpointCompression.html +2 -2
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +2 -2
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +2 -2
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +2 -2
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuth.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthAmazon.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthGitLab.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthLinkedIn.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthTwitch.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOIDC.html +2 -2
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +2 -2
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +2 -2
- data/docs/NgrokAPI/Models/EndpointSAML.html +2 -2
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +2 -2
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +2 -2
- data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +2 -2
- data/docs/NgrokAPI/Models/EndpointTrafficPolicy.html +2 -2
- data/docs/NgrokAPI/Models/EndpointUserAgentFilter.html +2 -2
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +2 -2
- data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +2 -2
- data/docs/NgrokAPI/Models/EventDestination.html +2 -2
- data/docs/NgrokAPI/Models/EventSource.html +2 -2
- data/docs/NgrokAPI/Models/EventSourceList.html +2 -2
- data/docs/NgrokAPI/Models/EventSourceReplace.html +2 -2
- data/docs/NgrokAPI/Models/EventSubscription.html +2 -2
- data/docs/NgrokAPI/Models/EventTarget.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetAzureLogsIngestion.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetDatadog.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +2 -2
- data/docs/NgrokAPI/Models/FailoverBackend.html +2 -2
- data/docs/NgrokAPI/Models/HTTPResponseBackend.html +2 -2
- data/docs/NgrokAPI/Models/HTTPSEdge.html +2 -2
- data/docs/NgrokAPI/Models/HTTPSEdgeRoute.html +2 -2
- data/docs/NgrokAPI/Models/IPPolicy.html +2 -2
- data/docs/NgrokAPI/Models/IPPolicyRule.html +2 -2
- data/docs/NgrokAPI/Models/IPRestriction.html +2 -2
- data/docs/NgrokAPI/Models/IdentityProvider.html +2 -2
- data/docs/NgrokAPI/Models/Listable.html +2 -2
- data/docs/NgrokAPI/Models/Location.html +2 -2
- data/docs/NgrokAPI/Models/Ref.html +2 -2
- data/docs/NgrokAPI/Models/ReservedAddr.html +2 -2
- data/docs/NgrokAPI/Models/ReservedDomain.html +95 -21
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +2 -2
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +2 -2
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +2 -2
- data/docs/NgrokAPI/Models/ReservedDomainResolvesToEntry.html +595 -0
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +2 -2
- data/docs/NgrokAPI/Models/SSHCredential.html +2 -2
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +2 -2
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +2 -2
- data/docs/NgrokAPI/Models/Secret.html +95 -21
- data/docs/NgrokAPI/Models/ServiceUser.html +1051 -0
- data/docs/NgrokAPI/Models/StaticBackend.html +2 -2
- data/docs/NgrokAPI/Models/StaticBackendTLS.html +2 -2
- data/docs/NgrokAPI/Models/TCPEdge.html +2 -2
- data/docs/NgrokAPI/Models/TLSCertificate.html +2 -2
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +2 -2
- data/docs/NgrokAPI/Models/TLSEdge.html +2 -2
- data/docs/NgrokAPI/Models/Tunnel.html +2 -2
- data/docs/NgrokAPI/Models/TunnelGroupBackend.html +2 -2
- data/docs/NgrokAPI/Models/TunnelSession.html +2 -2
- data/docs/NgrokAPI/Models/UserAgent.html +2 -2
- data/docs/NgrokAPI/Models/Vault.html +2 -2
- data/docs/NgrokAPI/Models/WeightedBackend.html +2 -2
- data/docs/NgrokAPI/Models.html +4 -4
- data/docs/NgrokAPI/PagedIterator.html +2 -2
- data/docs/NgrokAPI/Services/APIKeysClient.html +95 -31
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +2 -2
- data/docs/NgrokAPI/Services/AgentIngressesClient.html +95 -31
- data/docs/NgrokAPI/Services/ApplicationSessionsClient.html +2 -2
- data/docs/NgrokAPI/Services/ApplicationUsersClient.html +2 -2
- data/docs/NgrokAPI/Services/BotUsersClient.html +2 -2
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +99 -35
- data/docs/NgrokAPI/Services/CredentialsClient.html +103 -39
- data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteTrafficPolicyModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgesHTTPSClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgesTCPClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgesTLSClient.html +2 -2
- data/docs/NgrokAPI/Services/EndpointsClient.html +163 -79
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +95 -31
- data/docs/NgrokAPI/Services/EventSourcesClient.html +2 -2
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +95 -31
- data/docs/NgrokAPI/Services/FailoverBackendsClient.html +2 -2
- data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +2 -2
- data/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +95 -31
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +95 -31
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +95 -31
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +95 -31
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +270 -126
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +99 -35
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +101 -37
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +6 -6
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +6 -6
- data/docs/NgrokAPI/Services/SecretsClient.html +181 -73
- data/docs/NgrokAPI/Services/ServiceUsersClient.html +1797 -0
- data/docs/NgrokAPI/Services/StaticBackendsClient.html +2 -2
- data/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TCPEdgeTrafficPolicyModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TLSCertificatesClient.html +95 -31
- data/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TLSEdgeTrafficPolicyModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +2 -2
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +143 -79
- data/docs/NgrokAPI/Services/TunnelsClient.html +2 -2
- data/docs/NgrokAPI/Services/VaultsClient.html +79 -15
- data/docs/NgrokAPI/Services/WeightedBackendsClient.html +2 -2
- data/docs/NgrokAPI/Services.html +4 -4
- data/docs/NgrokAPI.html +3 -3
- data/docs/_index.html +23 -2
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +2 -2
- data/docs/index.html +2 -2
- data/docs/method_list.html +1092 -812
- data/docs/top-level-namespace.html +2 -2
- data/lib/ngrokapi/client.rb +4 -0
- data/lib/ngrokapi/models/endpoint.rb +1 -1
- data/lib/ngrokapi/models/reserved_domain.rb +3 -1
- data/lib/ngrokapi/models/reserved_domain_resolves_to_entry.rb +31 -0
- data/lib/ngrokapi/models/secret.rb +3 -1
- data/lib/ngrokapi/models/service_user.rb +70 -0
- data/lib/ngrokapi/services/agent_ingresses_client.rb +10 -4
- data/lib/ngrokapi/services/api_keys_client.rb +10 -4
- data/lib/ngrokapi/services/certificate_authorities_client.rb +12 -6
- data/lib/ngrokapi/services/credentials_client.rb +14 -8
- data/lib/ngrokapi/services/endpoints_client.rb +18 -12
- data/lib/ngrokapi/services/event_destinations_client.rb +10 -4
- data/lib/ngrokapi/services/event_subscriptions_client.rb +10 -4
- data/lib/ngrokapi/services/ip_policies_client.rb +10 -4
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +10 -4
- data/lib/ngrokapi/services/ip_restrictions_client.rb +10 -4
- data/lib/ngrokapi/services/reserved_addrs_client.rb +10 -4
- data/lib/ngrokapi/services/reserved_domains_client.rb +22 -8
- data/lib/ngrokapi/services/secrets_client.rb +16 -6
- data/lib/ngrokapi/services/service_users_client.rb +237 -0
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +12 -6
- data/lib/ngrokapi/services/ssh_credentials_client.rb +12 -6
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +2 -2
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +2 -2
- data/lib/ngrokapi/services/tls_certificates_client.rb +10 -4
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +10 -4
- data/lib/ngrokapi/services/vaults_client.rb +10 -4
- data/lib/ngrokapi/version.rb +1 -1
- data/spec/ngrokapi/client_spec.rb +6 -0
- data/spec/ngrokapi/models/reserved_domain_resolves_to_entry_spec.rb +23 -0
- data/spec/ngrokapi/models/service_user_spec.rb +44 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +4 -2
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +12 -4
- data/spec/ngrokapi/services/secrets_client_spec.rb +6 -2
- data/spec/ngrokapi/services/service_users_client_spec.rb +178 -0
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +4 -2
- data/spec/spec_helper.rb +26 -0
- metadata +14 -2
|
@@ -207,7 +207,7 @@
|
|
|
207
207
|
<li class="public ">
|
|
208
208
|
<span class="summary_signature">
|
|
209
209
|
|
|
210
|
-
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled:
|
|
210
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: nil) ⇒ NgrokAPI::Models::Endpoint </a>
|
|
211
211
|
|
|
212
212
|
|
|
213
213
|
|
|
@@ -231,7 +231,7 @@
|
|
|
231
231
|
<li class="public ">
|
|
232
232
|
<span class="summary_signature">
|
|
233
233
|
|
|
234
|
-
<a href="#create!-instance_method" title="#create! (instance method)">#<strong>create!</strong>(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled:
|
|
234
|
+
<a href="#create!-instance_method" title="#create! (instance method)">#<strong>create!</strong>(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: nil) ⇒ NgrokAPI::Models::Endpoint </a>
|
|
235
235
|
|
|
236
236
|
|
|
237
237
|
|
|
@@ -377,7 +377,7 @@
|
|
|
377
377
|
<li class="public ">
|
|
378
378
|
<span class="summary_signature">
|
|
379
379
|
|
|
380
|
-
<a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, id: [], url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
380
|
+
<a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, id: [], filter: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
381
381
|
|
|
382
382
|
|
|
383
383
|
|
|
@@ -401,7 +401,7 @@
|
|
|
401
401
|
<li class="public ">
|
|
402
402
|
<span class="summary_signature">
|
|
403
403
|
|
|
404
|
-
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, id: [], url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
404
|
+
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, id: [], filter: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
405
405
|
|
|
406
406
|
|
|
407
407
|
|
|
@@ -425,7 +425,7 @@
|
|
|
425
425
|
<li class="public ">
|
|
426
426
|
<span class="summary_signature">
|
|
427
427
|
|
|
428
|
-
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled:
|
|
428
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: nil) ⇒ NgrokAPI::Models::Endpoint </a>
|
|
429
429
|
|
|
430
430
|
|
|
431
431
|
|
|
@@ -449,7 +449,7 @@
|
|
|
449
449
|
<li class="public ">
|
|
450
450
|
<span class="summary_signature">
|
|
451
451
|
|
|
452
|
-
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled:
|
|
452
|
+
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: nil) ⇒ NgrokAPI::Models::Endpoint </a>
|
|
453
453
|
|
|
454
454
|
|
|
455
455
|
|
|
@@ -575,7 +575,7 @@
|
|
|
575
575
|
<div class="method_details first">
|
|
576
576
|
<h3 class="signature first" id="create-instance_method">
|
|
577
577
|
|
|
578
|
-
#<strong>create</strong>(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled:
|
|
578
|
+
#<strong>create</strong>(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: nil) ⇒ <tt><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">NgrokAPI::Models::Endpoint</a></span></tt>
|
|
579
579
|
|
|
580
580
|
|
|
581
581
|
|
|
@@ -705,7 +705,7 @@
|
|
|
705
705
|
<span class='type'>(<tt>boolean</tt>)</span>
|
|
706
706
|
|
|
707
707
|
|
|
708
|
-
<em class="default">(defaults to: <tt>
|
|
708
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
709
709
|
|
|
710
710
|
|
|
711
711
|
</li>
|
|
@@ -756,7 +756,7 @@
|
|
|
756
756
|
<td>
|
|
757
757
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 38</span>
|
|
758
758
|
|
|
759
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>url:</span><span class='comma'>,</span> <span class='label'>type:</span><span class='comma'>,</span> <span class='label'>traffic_policy:</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>bindings:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>pooling_enabled:</span> <span class='
|
|
759
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>url:</span><span class='comma'>,</span> <span class='label'>type:</span><span class='comma'>,</span> <span class='label'>traffic_policy:</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>bindings:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>pooling_enabled:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
760
760
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/endpoints</span><span class='tstring_end'>'</span></span>
|
|
761
761
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
762
762
|
<span class='rbrace'>}</span>
|
|
@@ -779,7 +779,7 @@
|
|
|
779
779
|
<div class="method_details ">
|
|
780
780
|
<h3 class="signature " id="create!-instance_method">
|
|
781
781
|
|
|
782
|
-
#<strong>create!</strong>(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled:
|
|
782
|
+
#<strong>create!</strong>(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: nil) ⇒ <tt><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">NgrokAPI::Models::Endpoint</a></span></tt>
|
|
783
783
|
|
|
784
784
|
|
|
785
785
|
|
|
@@ -909,7 +909,7 @@
|
|
|
909
909
|
<span class='type'>(<tt>boolean</tt>)</span>
|
|
910
910
|
|
|
911
911
|
|
|
912
|
-
<em class="default">(defaults to: <tt>
|
|
912
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
913
913
|
|
|
914
914
|
|
|
915
915
|
</li>
|
|
@@ -960,7 +960,7 @@
|
|
|
960
960
|
<td>
|
|
961
961
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 68</span>
|
|
962
962
|
|
|
963
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span><span class='label'>url:</span><span class='comma'>,</span> <span class='label'>type:</span><span class='comma'>,</span> <span class='label'>traffic_policy:</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>bindings:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>pooling_enabled:</span> <span class='
|
|
963
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span><span class='label'>url:</span><span class='comma'>,</span> <span class='label'>type:</span><span class='comma'>,</span> <span class='label'>traffic_policy:</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>bindings:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>pooling_enabled:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
964
964
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/endpoints</span><span class='tstring_end'>'</span></span>
|
|
965
965
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
966
966
|
<span class='rbrace'>}</span>
|
|
@@ -1048,16 +1048,16 @@
|
|
|
1048
1048
|
<pre class="lines">
|
|
1049
1049
|
|
|
1050
1050
|
|
|
1051
|
-
|
|
1052
|
-
|
|
1053
|
-
|
|
1054
|
-
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
|
|
1051
|
+
260
|
|
1052
|
+
261
|
|
1053
|
+
262
|
|
1054
|
+
263
|
|
1055
|
+
264
|
|
1056
|
+
265
|
|
1057
|
+
266</pre>
|
|
1058
1058
|
</td>
|
|
1059
1059
|
<td>
|
|
1060
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line
|
|
1060
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 260</span>
|
|
1061
1061
|
|
|
1062
1062
|
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1063
1063
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/endpoints/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -1139,16 +1139,16 @@
|
|
|
1139
1139
|
<pre class="lines">
|
|
1140
1140
|
|
|
1141
1141
|
|
|
1142
|
-
|
|
1143
|
-
|
|
1144
|
-
|
|
1145
|
-
|
|
1146
|
-
|
|
1147
|
-
|
|
1148
|
-
|
|
1142
|
+
276
|
|
1143
|
+
277
|
|
1144
|
+
278
|
|
1145
|
+
279
|
|
1146
|
+
280
|
|
1147
|
+
281
|
|
1148
|
+
282</pre>
|
|
1149
1149
|
</td>
|
|
1150
1150
|
<td>
|
|
1151
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line
|
|
1151
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 276</span>
|
|
1152
1152
|
|
|
1153
1153
|
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1154
1154
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/endpoints/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -1230,18 +1230,18 @@
|
|
|
1230
1230
|
<pre class="lines">
|
|
1231
1231
|
|
|
1232
1232
|
|
|
1233
|
-
160
|
|
1234
|
-
161
|
|
1235
|
-
162
|
|
1236
|
-
163
|
|
1237
|
-
164
|
|
1238
|
-
165
|
|
1239
1233
|
166
|
|
1240
1234
|
167
|
|
1241
|
-
168
|
|
1235
|
+
168
|
|
1236
|
+
169
|
|
1237
|
+
170
|
|
1238
|
+
171
|
|
1239
|
+
172
|
|
1240
|
+
173
|
|
1241
|
+
174</pre>
|
|
1242
1242
|
</td>
|
|
1243
1243
|
<td>
|
|
1244
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line
|
|
1244
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 166</span>
|
|
1245
1245
|
|
|
1246
1246
|
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1247
1247
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/endpoints/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -1325,18 +1325,18 @@
|
|
|
1325
1325
|
<pre class="lines">
|
|
1326
1326
|
|
|
1327
1327
|
|
|
1328
|
-
178
|
|
1329
|
-
179
|
|
1330
|
-
180
|
|
1331
|
-
181
|
|
1332
|
-
182
|
|
1333
|
-
183
|
|
1334
1328
|
184
|
|
1335
1329
|
185
|
|
1336
|
-
186
|
|
1330
|
+
186
|
|
1331
|
+
187
|
|
1332
|
+
188
|
|
1333
|
+
189
|
|
1334
|
+
190
|
|
1335
|
+
191
|
|
1336
|
+
192</pre>
|
|
1337
1337
|
</td>
|
|
1338
1338
|
<td>
|
|
1339
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line
|
|
1339
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 184</span>
|
|
1340
1340
|
|
|
1341
1341
|
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
1342
1342
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/endpoints/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -1355,7 +1355,7 @@
|
|
|
1355
1355
|
<div class="method_details ">
|
|
1356
1356
|
<h3 class="signature " id="list-instance_method">
|
|
1357
1357
|
|
|
1358
|
-
#<strong>list</strong>(before_id: nil, limit: nil, id: [], url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
|
|
1358
|
+
#<strong>list</strong>(before_id: nil, limit: nil, id: [], filter: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
|
|
1359
1359
|
|
|
1360
1360
|
|
|
1361
1361
|
|
|
@@ -1386,6 +1386,11 @@
|
|
|
1386
1386
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1387
1387
|
|
|
1388
1388
|
|
|
1389
|
+
—
|
|
1390
|
+
<div class='inline'>
|
|
1391
|
+
<p>Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.</p>
|
|
1392
|
+
</div>
|
|
1393
|
+
|
|
1389
1394
|
</li>
|
|
1390
1395
|
|
|
1391
1396
|
<li>
|
|
@@ -1399,6 +1404,11 @@
|
|
|
1399
1404
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1400
1405
|
|
|
1401
1406
|
|
|
1407
|
+
—
|
|
1408
|
+
<div class='inline'>
|
|
1409
|
+
<p>Constrains the number of results in the dataset. See the <code>API Overview <https://ngrok.com/docs/api/index#pagination></code>_ for details.</p>
|
|
1410
|
+
</div>
|
|
1411
|
+
|
|
1402
1412
|
</li>
|
|
1403
1413
|
|
|
1404
1414
|
<li>
|
|
@@ -1412,6 +1422,11 @@
|
|
|
1412
1422
|
<em class="default">(defaults to: <tt>[]</tt>)</em>
|
|
1413
1423
|
|
|
1414
1424
|
|
|
1425
|
+
—
|
|
1426
|
+
<div class='inline'>
|
|
1427
|
+
<p>Filter results by endpoint IDs. Deprecated: use <code>filter</code> instead.</p>
|
|
1428
|
+
</div>
|
|
1429
|
+
|
|
1415
1430
|
</li>
|
|
1416
1431
|
|
|
1417
1432
|
<li>
|
|
@@ -1425,6 +1440,29 @@
|
|
|
1425
1440
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1426
1441
|
|
|
1427
1442
|
|
|
1443
|
+
—
|
|
1444
|
+
<div class='inline'>
|
|
1445
|
+
<p>Filter results by endpoint URLs. Deprecated: use <code>filter</code> instead.</p>
|
|
1446
|
+
</div>
|
|
1447
|
+
|
|
1448
|
+
</li>
|
|
1449
|
+
|
|
1450
|
+
<li>
|
|
1451
|
+
|
|
1452
|
+
<span class='name'>filter</span>
|
|
1453
|
+
|
|
1454
|
+
|
|
1455
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1456
|
+
|
|
1457
|
+
|
|
1458
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1459
|
+
|
|
1460
|
+
|
|
1461
|
+
—
|
|
1462
|
+
<div class='inline'>
|
|
1463
|
+
<p>A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as <code>id</code>, <code>metadata</code>, <code>created_at</code>, and more. See ngrok API Filtering for syntax and field details: <code>https://ngrok.com/docs/api/api-filtering <https://ngrok.com/docs/api/api-filtering></code>_.</p>
|
|
1464
|
+
</div>
|
|
1465
|
+
|
|
1428
1466
|
</li>
|
|
1429
1467
|
|
|
1430
1468
|
<li>
|
|
@@ -1472,7 +1510,6 @@
|
|
|
1472
1510
|
<pre class="lines">
|
|
1473
1511
|
|
|
1474
1512
|
|
|
1475
|
-
95
|
|
1476
1513
|
96
|
|
1477
1514
|
97
|
|
1478
1515
|
98
|
|
@@ -1492,21 +1529,26 @@
|
|
|
1492
1529
|
112
|
|
1493
1530
|
113
|
|
1494
1531
|
114
|
|
1495
|
-
115
|
|
1532
|
+
115
|
|
1533
|
+
116
|
|
1534
|
+
117
|
|
1535
|
+
118</pre>
|
|
1496
1536
|
</td>
|
|
1497
1537
|
<td>
|
|
1498
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line
|
|
1538
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 96</span>
|
|
1499
1539
|
|
|
1500
1540
|
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
|
1501
1541
|
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1502
1542
|
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1503
1543
|
<span class='label'>id:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
1544
|
+
<span class='label'>filter:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1504
1545
|
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1505
1546
|
<span class='rparen'>)</span>
|
|
1506
1547
|
<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_list'>list</span><span class='lparen'>(</span>
|
|
1507
1548
|
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1508
1549
|
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1509
1550
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1551
|
+
<span class='label'>filter:</span> <span class='id identifier rubyid_filter'>filter</span><span class='comma'>,</span>
|
|
1510
1552
|
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1511
1553
|
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EndpointsClient::PATH (constant)">PATH</a></span></span>
|
|
1512
1554
|
<span class='rparen'>)</span>
|
|
@@ -1526,7 +1568,7 @@
|
|
|
1526
1568
|
<div class="method_details ">
|
|
1527
1569
|
<h3 class="signature " id="list!-instance_method">
|
|
1528
1570
|
|
|
1529
|
-
#<strong>list!</strong>(before_id: nil, limit: nil, id: [], url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
|
|
1571
|
+
#<strong>list!</strong>(before_id: nil, limit: nil, id: [], filter: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
|
|
1530
1572
|
|
|
1531
1573
|
|
|
1532
1574
|
|
|
@@ -1557,6 +1599,11 @@
|
|
|
1557
1599
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1558
1600
|
|
|
1559
1601
|
|
|
1602
|
+
—
|
|
1603
|
+
<div class='inline'>
|
|
1604
|
+
<p>Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.</p>
|
|
1605
|
+
</div>
|
|
1606
|
+
|
|
1560
1607
|
</li>
|
|
1561
1608
|
|
|
1562
1609
|
<li>
|
|
@@ -1570,6 +1617,11 @@
|
|
|
1570
1617
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1571
1618
|
|
|
1572
1619
|
|
|
1620
|
+
—
|
|
1621
|
+
<div class='inline'>
|
|
1622
|
+
<p>Constrains the number of results in the dataset. See the <code>API Overview <https://ngrok.com/docs/api/index#pagination></code>_ for details.</p>
|
|
1623
|
+
</div>
|
|
1624
|
+
|
|
1573
1625
|
</li>
|
|
1574
1626
|
|
|
1575
1627
|
<li>
|
|
@@ -1583,6 +1635,11 @@
|
|
|
1583
1635
|
<em class="default">(defaults to: <tt>[]</tt>)</em>
|
|
1584
1636
|
|
|
1585
1637
|
|
|
1638
|
+
—
|
|
1639
|
+
<div class='inline'>
|
|
1640
|
+
<p>Filter results by endpoint IDs. Deprecated: use <code>filter</code> instead.</p>
|
|
1641
|
+
</div>
|
|
1642
|
+
|
|
1586
1643
|
</li>
|
|
1587
1644
|
|
|
1588
1645
|
<li>
|
|
@@ -1596,6 +1653,29 @@
|
|
|
1596
1653
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1597
1654
|
|
|
1598
1655
|
|
|
1656
|
+
—
|
|
1657
|
+
<div class='inline'>
|
|
1658
|
+
<p>Filter results by endpoint URLs. Deprecated: use <code>filter</code> instead.</p>
|
|
1659
|
+
</div>
|
|
1660
|
+
|
|
1661
|
+
</li>
|
|
1662
|
+
|
|
1663
|
+
<li>
|
|
1664
|
+
|
|
1665
|
+
<span class='name'>filter</span>
|
|
1666
|
+
|
|
1667
|
+
|
|
1668
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1669
|
+
|
|
1670
|
+
|
|
1671
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1672
|
+
|
|
1673
|
+
|
|
1674
|
+
—
|
|
1675
|
+
<div class='inline'>
|
|
1676
|
+
<p>A CEL expression to filter the list results. Supports logical and comparison operators to match on fields such as <code>id</code>, <code>metadata</code>, <code>created_at</code>, and more. See ngrok API Filtering for syntax and field details: <code>https://ngrok.com/docs/api/api-filtering <https://ngrok.com/docs/api/api-filtering></code>_.</p>
|
|
1677
|
+
</div>
|
|
1678
|
+
|
|
1599
1679
|
</li>
|
|
1600
1680
|
|
|
1601
1681
|
<li>
|
|
@@ -1643,10 +1723,6 @@
|
|
|
1643
1723
|
<pre class="lines">
|
|
1644
1724
|
|
|
1645
1725
|
|
|
1646
|
-
129
|
|
1647
|
-
130
|
|
1648
|
-
131
|
|
1649
|
-
132
|
|
1650
1726
|
133
|
|
1651
1727
|
134
|
|
1652
1728
|
135
|
|
@@ -1665,21 +1741,29 @@
|
|
|
1665
1741
|
148
|
|
1666
1742
|
149
|
|
1667
1743
|
150
|
|
1668
|
-
151
|
|
1744
|
+
151
|
|
1745
|
+
152
|
|
1746
|
+
153
|
|
1747
|
+
154
|
|
1748
|
+
155
|
|
1749
|
+
156
|
|
1750
|
+
157</pre>
|
|
1669
1751
|
</td>
|
|
1670
1752
|
<td>
|
|
1671
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line
|
|
1753
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 133</span>
|
|
1672
1754
|
|
|
1673
1755
|
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span>
|
|
1674
1756
|
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1675
1757
|
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1676
1758
|
<span class='label'>id:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span>
|
|
1759
|
+
<span class='label'>filter:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1677
1760
|
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1678
1761
|
<span class='rparen'>)</span>
|
|
1679
1762
|
<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_list'>list</span><span class='lparen'>(</span>
|
|
1680
1763
|
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1681
1764
|
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1682
1765
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1766
|
+
<span class='label'>filter:</span> <span class='id identifier rubyid_filter'>filter</span><span class='comma'>,</span>
|
|
1683
1767
|
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
|
1684
1768
|
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1685
1769
|
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EndpointsClient::PATH (constant)">PATH</a></span></span>
|
|
@@ -1701,7 +1785,7 @@
|
|
|
1701
1785
|
<div class="method_details ">
|
|
1702
1786
|
<h3 class="signature " id="update-instance_method">
|
|
1703
1787
|
|
|
1704
|
-
#<strong>update</strong>(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled:
|
|
1788
|
+
#<strong>update</strong>(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: nil) ⇒ <tt><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">NgrokAPI::Models::Endpoint</a></span></tt>
|
|
1705
1789
|
|
|
1706
1790
|
|
|
1707
1791
|
|
|
@@ -1837,7 +1921,7 @@
|
|
|
1837
1921
|
<span class='type'>(<tt>boolean</tt>)</span>
|
|
1838
1922
|
|
|
1839
1923
|
|
|
1840
|
-
<em class="default">(defaults to: <tt>
|
|
1924
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1841
1925
|
|
|
1842
1926
|
|
|
1843
1927
|
</li>
|
|
@@ -1869,12 +1953,6 @@
|
|
|
1869
1953
|
<pre class="lines">
|
|
1870
1954
|
|
|
1871
1955
|
|
|
1872
|
-
201
|
|
1873
|
-
202
|
|
1874
|
-
203
|
|
1875
|
-
204
|
|
1876
|
-
205
|
|
1877
|
-
206
|
|
1878
1956
|
207
|
|
1879
1957
|
208
|
|
1880
1958
|
209
|
|
@@ -1883,12 +1961,18 @@
|
|
|
1883
1961
|
212
|
|
1884
1962
|
213
|
|
1885
1963
|
214
|
|
1886
|
-
215
|
|
1964
|
+
215
|
|
1965
|
+
216
|
|
1966
|
+
217
|
|
1967
|
+
218
|
|
1968
|
+
219
|
|
1969
|
+
220
|
|
1970
|
+
221</pre>
|
|
1887
1971
|
</td>
|
|
1888
1972
|
<td>
|
|
1889
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line
|
|
1973
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 207</span>
|
|
1890
1974
|
|
|
1891
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>url:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>traffic_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>bindings:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>pooling_enabled:</span> <span class='
|
|
1975
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>url:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>traffic_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>bindings:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>pooling_enabled:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1892
1976
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/endpoints/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1893
1977
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1894
1978
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
@@ -1911,7 +1995,7 @@
|
|
|
1911
1995
|
<div class="method_details ">
|
|
1912
1996
|
<h3 class="signature " id="update!-instance_method">
|
|
1913
1997
|
|
|
1914
|
-
#<strong>update!</strong>(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled:
|
|
1998
|
+
#<strong>update!</strong>(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: nil) ⇒ <tt><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">NgrokAPI::Models::Endpoint</a></span></tt>
|
|
1915
1999
|
|
|
1916
2000
|
|
|
1917
2001
|
|
|
@@ -2047,7 +2131,7 @@
|
|
|
2047
2131
|
<span class='type'>(<tt>boolean</tt>)</span>
|
|
2048
2132
|
|
|
2049
2133
|
|
|
2050
|
-
<em class="default">(defaults to: <tt>
|
|
2134
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
2051
2135
|
|
|
2052
2136
|
|
|
2053
2137
|
</li>
|
|
@@ -2079,12 +2163,6 @@
|
|
|
2079
2163
|
<pre class="lines">
|
|
2080
2164
|
|
|
2081
2165
|
|
|
2082
|
-
231
|
|
2083
|
-
232
|
|
2084
|
-
233
|
|
2085
|
-
234
|
|
2086
|
-
235
|
|
2087
|
-
236
|
|
2088
2166
|
237
|
|
2089
2167
|
238
|
|
2090
2168
|
239
|
|
@@ -2093,12 +2171,18 @@
|
|
|
2093
2171
|
242
|
|
2094
2172
|
243
|
|
2095
2173
|
244
|
|
2096
|
-
245
|
|
2174
|
+
245
|
|
2175
|
+
246
|
|
2176
|
+
247
|
|
2177
|
+
248
|
|
2178
|
+
249
|
|
2179
|
+
250
|
|
2180
|
+
251</pre>
|
|
2097
2181
|
</td>
|
|
2098
2182
|
<td>
|
|
2099
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line
|
|
2183
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 237</span>
|
|
2100
2184
|
|
|
2101
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>url:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>traffic_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>bindings:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>pooling_enabled:</span> <span class='
|
|
2185
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>url:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>traffic_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>bindings:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>pooling_enabled:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
2102
2186
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/endpoints/%{id}</span><span class='tstring_end'>'</span></span>
|
|
2103
2187
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
2104
2188
|
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
@@ -2123,9 +2207,9 @@
|
|
|
2123
2207
|
</div>
|
|
2124
2208
|
|
|
2125
2209
|
<div id="footer">
|
|
2126
|
-
Generated on
|
|
2210
|
+
Generated on Fri Jan 23 21:38:04 2026 by
|
|
2127
2211
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
2128
|
-
0.9.36 (ruby-3.3.
|
|
2212
|
+
0.9.36 (ruby-3.3.10).
|
|
2129
2213
|
</div>
|
|
2130
2214
|
|
|
2131
2215
|
</div>
|