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
|
@@ -375,7 +375,7 @@
|
|
|
375
375
|
<li class="public ">
|
|
376
376
|
<span class="summary_signature">
|
|
377
377
|
|
|
378
|
-
<a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
378
|
+
<a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, filter: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
379
379
|
|
|
380
380
|
|
|
381
381
|
|
|
@@ -399,7 +399,7 @@
|
|
|
399
399
|
<li class="public ">
|
|
400
400
|
<span class="summary_signature">
|
|
401
401
|
|
|
402
|
-
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
402
|
+
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, filter: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
403
403
|
|
|
404
404
|
|
|
405
405
|
|
|
@@ -1255,7 +1255,7 @@
|
|
|
1255
1255
|
<div class="method_details ">
|
|
1256
1256
|
<h3 class="signature " id="list-instance_method">
|
|
1257
1257
|
|
|
1258
|
-
#<strong>list</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
|
|
1258
|
+
#<strong>list</strong>(before_id: nil, limit: nil, 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>
|
|
1259
1259
|
|
|
1260
1260
|
|
|
1261
1261
|
|
|
@@ -1286,6 +1286,11 @@
|
|
|
1286
1286
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1287
1287
|
|
|
1288
1288
|
|
|
1289
|
+
—
|
|
1290
|
+
<div class='inline'>
|
|
1291
|
+
<p>Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.</p>
|
|
1292
|
+
</div>
|
|
1293
|
+
|
|
1289
1294
|
</li>
|
|
1290
1295
|
|
|
1291
1296
|
<li>
|
|
@@ -1299,6 +1304,29 @@
|
|
|
1299
1304
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1300
1305
|
|
|
1301
1306
|
|
|
1307
|
+
—
|
|
1308
|
+
<div class='inline'>
|
|
1309
|
+
<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>
|
|
1310
|
+
</div>
|
|
1311
|
+
|
|
1312
|
+
</li>
|
|
1313
|
+
|
|
1314
|
+
<li>
|
|
1315
|
+
|
|
1316
|
+
<span class='name'>filter</span>
|
|
1317
|
+
|
|
1318
|
+
|
|
1319
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1320
|
+
|
|
1321
|
+
|
|
1322
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1323
|
+
|
|
1324
|
+
|
|
1325
|
+
—
|
|
1326
|
+
<div class='inline'>
|
|
1327
|
+
<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>
|
|
1328
|
+
</div>
|
|
1329
|
+
|
|
1302
1330
|
</li>
|
|
1303
1331
|
|
|
1304
1332
|
<li>
|
|
@@ -1346,7 +1374,6 @@
|
|
|
1346
1374
|
<pre class="lines">
|
|
1347
1375
|
|
|
1348
1376
|
|
|
1349
|
-
147
|
|
1350
1377
|
148
|
|
1351
1378
|
149
|
|
1352
1379
|
150
|
|
@@ -1364,19 +1391,24 @@
|
|
|
1364
1391
|
162
|
|
1365
1392
|
163
|
|
1366
1393
|
164
|
|
1367
|
-
165
|
|
1394
|
+
165
|
|
1395
|
+
166
|
|
1396
|
+
167
|
|
1397
|
+
168</pre>
|
|
1368
1398
|
</td>
|
|
1369
1399
|
<td>
|
|
1370
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line
|
|
1400
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 148</span>
|
|
1371
1401
|
|
|
1372
1402
|
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
|
1373
1403
|
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1374
1404
|
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1405
|
+
<span class='label'>filter:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1375
1406
|
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1376
1407
|
<span class='rparen'>)</span>
|
|
1377
1408
|
<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>
|
|
1378
1409
|
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1379
1410
|
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1411
|
+
<span class='label'>filter:</span> <span class='id identifier rubyid_filter'>filter</span><span class='comma'>,</span>
|
|
1380
1412
|
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1381
1413
|
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EventDestinationsClient::PATH (constant)">PATH</a></span></span>
|
|
1382
1414
|
<span class='rparen'>)</span>
|
|
@@ -1396,7 +1428,7 @@
|
|
|
1396
1428
|
<div class="method_details ">
|
|
1397
1429
|
<h3 class="signature " id="list!-instance_method">
|
|
1398
1430
|
|
|
1399
|
-
#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
|
|
1431
|
+
#<strong>list!</strong>(before_id: nil, limit: nil, 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>
|
|
1400
1432
|
|
|
1401
1433
|
|
|
1402
1434
|
|
|
@@ -1427,6 +1459,11 @@
|
|
|
1427
1459
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1428
1460
|
|
|
1429
1461
|
|
|
1462
|
+
—
|
|
1463
|
+
<div class='inline'>
|
|
1464
|
+
<p>Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.</p>
|
|
1465
|
+
</div>
|
|
1466
|
+
|
|
1430
1467
|
</li>
|
|
1431
1468
|
|
|
1432
1469
|
<li>
|
|
@@ -1440,6 +1477,29 @@
|
|
|
1440
1477
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1441
1478
|
|
|
1442
1479
|
|
|
1480
|
+
—
|
|
1481
|
+
<div class='inline'>
|
|
1482
|
+
<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>
|
|
1483
|
+
</div>
|
|
1484
|
+
|
|
1485
|
+
</li>
|
|
1486
|
+
|
|
1487
|
+
<li>
|
|
1488
|
+
|
|
1489
|
+
<span class='name'>filter</span>
|
|
1490
|
+
|
|
1491
|
+
|
|
1492
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1493
|
+
|
|
1494
|
+
|
|
1495
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1496
|
+
|
|
1497
|
+
|
|
1498
|
+
—
|
|
1499
|
+
<div class='inline'>
|
|
1500
|
+
<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>
|
|
1501
|
+
</div>
|
|
1502
|
+
|
|
1443
1503
|
</li>
|
|
1444
1504
|
|
|
1445
1505
|
<li>
|
|
@@ -1487,10 +1547,6 @@
|
|
|
1487
1547
|
<pre class="lines">
|
|
1488
1548
|
|
|
1489
1549
|
|
|
1490
|
-
177
|
|
1491
|
-
178
|
|
1492
|
-
179
|
|
1493
|
-
180
|
|
1494
1550
|
181
|
|
1495
1551
|
182
|
|
1496
1552
|
183
|
|
@@ -1507,19 +1563,27 @@
|
|
|
1507
1563
|
194
|
|
1508
1564
|
195
|
|
1509
1565
|
196
|
|
1510
|
-
197
|
|
1566
|
+
197
|
|
1567
|
+
198
|
|
1568
|
+
199
|
|
1569
|
+
200
|
|
1570
|
+
201
|
|
1571
|
+
202
|
|
1572
|
+
203</pre>
|
|
1511
1573
|
</td>
|
|
1512
1574
|
<td>
|
|
1513
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line
|
|
1575
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 181</span>
|
|
1514
1576
|
|
|
1515
1577
|
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span>
|
|
1516
1578
|
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1517
1579
|
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1580
|
+
<span class='label'>filter:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1518
1581
|
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1519
1582
|
<span class='rparen'>)</span>
|
|
1520
1583
|
<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>
|
|
1521
1584
|
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1522
1585
|
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1586
|
+
<span class='label'>filter:</span> <span class='id identifier rubyid_filter'>filter</span><span class='comma'>,</span>
|
|
1523
1587
|
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
|
1524
1588
|
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1525
1589
|
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EventDestinationsClient::PATH (constant)">PATH</a></span></span>
|
|
@@ -1678,22 +1742,22 @@
|
|
|
1678
1742
|
<pre class="lines">
|
|
1679
1743
|
|
|
1680
1744
|
|
|
1681
|
-
210
|
|
1682
|
-
211
|
|
1683
|
-
212
|
|
1684
|
-
213
|
|
1685
|
-
214
|
|
1686
|
-
215
|
|
1687
1745
|
216
|
|
1688
1746
|
217
|
|
1689
1747
|
218
|
|
1690
1748
|
219
|
|
1691
1749
|
220
|
|
1692
1750
|
221
|
|
1693
|
-
222
|
|
1751
|
+
222
|
|
1752
|
+
223
|
|
1753
|
+
224
|
|
1754
|
+
225
|
|
1755
|
+
226
|
|
1756
|
+
227
|
|
1757
|
+
228</pre>
|
|
1694
1758
|
</td>
|
|
1695
1759
|
<td>
|
|
1696
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line
|
|
1760
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 216</span>
|
|
1697
1761
|
|
|
1698
1762
|
<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'>metadata:</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'>format:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>target:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>verify_with_test_event:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1699
1763
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/event_destinations/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -1853,22 +1917,22 @@
|
|
|
1853
1917
|
<pre class="lines">
|
|
1854
1918
|
|
|
1855
1919
|
|
|
1856
|
-
236
|
|
1857
|
-
237
|
|
1858
|
-
238
|
|
1859
|
-
239
|
|
1860
|
-
240
|
|
1861
|
-
241
|
|
1862
1920
|
242
|
|
1863
1921
|
243
|
|
1864
1922
|
244
|
|
1865
1923
|
245
|
|
1866
1924
|
246
|
|
1867
1925
|
247
|
|
1868
|
-
248
|
|
1926
|
+
248
|
|
1927
|
+
249
|
|
1928
|
+
250
|
|
1929
|
+
251
|
|
1930
|
+
252
|
|
1931
|
+
253
|
|
1932
|
+
254</pre>
|
|
1869
1933
|
</td>
|
|
1870
1934
|
<td>
|
|
1871
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line
|
|
1935
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_destinations_client.rb', line 242</span>
|
|
1872
1936
|
|
|
1873
1937
|
<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'>metadata:</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'>format:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>target:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>verify_with_test_event:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1874
1938
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/event_destinations/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -1893,9 +1957,9 @@
|
|
|
1893
1957
|
</div>
|
|
1894
1958
|
|
|
1895
1959
|
<div id="footer">
|
|
1896
|
-
Generated on
|
|
1960
|
+
Generated on Fri Jan 23 21:38:08 2026 by
|
|
1897
1961
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1898
|
-
0.9.36 (ruby-3.3.
|
|
1962
|
+
0.9.36 (ruby-3.3.10).
|
|
1899
1963
|
</div>
|
|
1900
1964
|
|
|
1901
1965
|
</div>
|
|
@@ -1661,9 +1661,9 @@
|
|
|
1661
1661
|
</div>
|
|
1662
1662
|
|
|
1663
1663
|
<div id="footer">
|
|
1664
|
-
Generated on
|
|
1664
|
+
Generated on Fri Jan 23 21:38:05 2026 by
|
|
1665
1665
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1666
|
-
0.9.36 (ruby-3.3.
|
|
1666
|
+
0.9.36 (ruby-3.3.10).
|
|
1667
1667
|
</div>
|
|
1668
1668
|
|
|
1669
1669
|
</div>
|
|
@@ -375,7 +375,7 @@
|
|
|
375
375
|
<li class="public ">
|
|
376
376
|
<span class="summary_signature">
|
|
377
377
|
|
|
378
|
-
<a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
378
|
+
<a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, filter: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
379
379
|
|
|
380
380
|
|
|
381
381
|
|
|
@@ -399,7 +399,7 @@
|
|
|
399
399
|
<li class="public ">
|
|
400
400
|
<span class="summary_signature">
|
|
401
401
|
|
|
402
|
-
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
402
|
+
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, filter: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
403
403
|
|
|
404
404
|
|
|
405
405
|
|
|
@@ -1255,7 +1255,7 @@
|
|
|
1255
1255
|
<div class="method_details ">
|
|
1256
1256
|
<h3 class="signature " id="list-instance_method">
|
|
1257
1257
|
|
|
1258
|
-
#<strong>list</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
|
|
1258
|
+
#<strong>list</strong>(before_id: nil, limit: nil, 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>
|
|
1259
1259
|
|
|
1260
1260
|
|
|
1261
1261
|
|
|
@@ -1286,6 +1286,11 @@
|
|
|
1286
1286
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1287
1287
|
|
|
1288
1288
|
|
|
1289
|
+
—
|
|
1290
|
+
<div class='inline'>
|
|
1291
|
+
<p>Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.</p>
|
|
1292
|
+
</div>
|
|
1293
|
+
|
|
1289
1294
|
</li>
|
|
1290
1295
|
|
|
1291
1296
|
<li>
|
|
@@ -1299,6 +1304,29 @@
|
|
|
1299
1304
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1300
1305
|
|
|
1301
1306
|
|
|
1307
|
+
—
|
|
1308
|
+
<div class='inline'>
|
|
1309
|
+
<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>
|
|
1310
|
+
</div>
|
|
1311
|
+
|
|
1312
|
+
</li>
|
|
1313
|
+
|
|
1314
|
+
<li>
|
|
1315
|
+
|
|
1316
|
+
<span class='name'>filter</span>
|
|
1317
|
+
|
|
1318
|
+
|
|
1319
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1320
|
+
|
|
1321
|
+
|
|
1322
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1323
|
+
|
|
1324
|
+
|
|
1325
|
+
—
|
|
1326
|
+
<div class='inline'>
|
|
1327
|
+
<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>
|
|
1328
|
+
</div>
|
|
1329
|
+
|
|
1302
1330
|
</li>
|
|
1303
1331
|
|
|
1304
1332
|
<li>
|
|
@@ -1346,7 +1374,6 @@
|
|
|
1346
1374
|
<pre class="lines">
|
|
1347
1375
|
|
|
1348
1376
|
|
|
1349
|
-
143
|
|
1350
1377
|
144
|
|
1351
1378
|
145
|
|
1352
1379
|
146
|
|
@@ -1364,19 +1391,24 @@
|
|
|
1364
1391
|
158
|
|
1365
1392
|
159
|
|
1366
1393
|
160
|
|
1367
|
-
161
|
|
1394
|
+
161
|
|
1395
|
+
162
|
|
1396
|
+
163
|
|
1397
|
+
164</pre>
|
|
1368
1398
|
</td>
|
|
1369
1399
|
<td>
|
|
1370
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line
|
|
1400
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 144</span>
|
|
1371
1401
|
|
|
1372
1402
|
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
|
1373
1403
|
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1374
1404
|
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1405
|
+
<span class='label'>filter:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1375
1406
|
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1376
1407
|
<span class='rparen'>)</span>
|
|
1377
1408
|
<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>
|
|
1378
1409
|
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1379
1410
|
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1411
|
+
<span class='label'>filter:</span> <span class='id identifier rubyid_filter'>filter</span><span class='comma'>,</span>
|
|
1380
1412
|
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1381
1413
|
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EventSubscriptionsClient::PATH (constant)">PATH</a></span></span>
|
|
1382
1414
|
<span class='rparen'>)</span>
|
|
@@ -1396,7 +1428,7 @@
|
|
|
1396
1428
|
<div class="method_details ">
|
|
1397
1429
|
<h3 class="signature " id="list!-instance_method">
|
|
1398
1430
|
|
|
1399
|
-
#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
|
|
1431
|
+
#<strong>list!</strong>(before_id: nil, limit: nil, 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>
|
|
1400
1432
|
|
|
1401
1433
|
|
|
1402
1434
|
|
|
@@ -1427,6 +1459,11 @@
|
|
|
1427
1459
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1428
1460
|
|
|
1429
1461
|
|
|
1462
|
+
—
|
|
1463
|
+
<div class='inline'>
|
|
1464
|
+
<p>Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.</p>
|
|
1465
|
+
</div>
|
|
1466
|
+
|
|
1430
1467
|
</li>
|
|
1431
1468
|
|
|
1432
1469
|
<li>
|
|
@@ -1440,6 +1477,29 @@
|
|
|
1440
1477
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1441
1478
|
|
|
1442
1479
|
|
|
1480
|
+
—
|
|
1481
|
+
<div class='inline'>
|
|
1482
|
+
<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>
|
|
1483
|
+
</div>
|
|
1484
|
+
|
|
1485
|
+
</li>
|
|
1486
|
+
|
|
1487
|
+
<li>
|
|
1488
|
+
|
|
1489
|
+
<span class='name'>filter</span>
|
|
1490
|
+
|
|
1491
|
+
|
|
1492
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1493
|
+
|
|
1494
|
+
|
|
1495
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1496
|
+
|
|
1497
|
+
|
|
1498
|
+
—
|
|
1499
|
+
<div class='inline'>
|
|
1500
|
+
<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>
|
|
1501
|
+
</div>
|
|
1502
|
+
|
|
1443
1503
|
</li>
|
|
1444
1504
|
|
|
1445
1505
|
<li>
|
|
@@ -1487,10 +1547,6 @@
|
|
|
1487
1547
|
<pre class="lines">
|
|
1488
1548
|
|
|
1489
1549
|
|
|
1490
|
-
173
|
|
1491
|
-
174
|
|
1492
|
-
175
|
|
1493
|
-
176
|
|
1494
1550
|
177
|
|
1495
1551
|
178
|
|
1496
1552
|
179
|
|
@@ -1507,19 +1563,27 @@
|
|
|
1507
1563
|
190
|
|
1508
1564
|
191
|
|
1509
1565
|
192
|
|
1510
|
-
193
|
|
1566
|
+
193
|
|
1567
|
+
194
|
|
1568
|
+
195
|
|
1569
|
+
196
|
|
1570
|
+
197
|
|
1571
|
+
198
|
|
1572
|
+
199</pre>
|
|
1511
1573
|
</td>
|
|
1512
1574
|
<td>
|
|
1513
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line
|
|
1575
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 177</span>
|
|
1514
1576
|
|
|
1515
1577
|
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span>
|
|
1516
1578
|
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1517
1579
|
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1580
|
+
<span class='label'>filter:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1518
1581
|
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1519
1582
|
<span class='rparen'>)</span>
|
|
1520
1583
|
<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>
|
|
1521
1584
|
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1522
1585
|
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1586
|
+
<span class='label'>filter:</span> <span class='id identifier rubyid_filter'>filter</span><span class='comma'>,</span>
|
|
1523
1587
|
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
|
1524
1588
|
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1525
1589
|
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EventSubscriptionsClient::PATH (constant)">PATH</a></span></span>
|
|
@@ -1678,22 +1742,22 @@
|
|
|
1678
1742
|
<pre class="lines">
|
|
1679
1743
|
|
|
1680
1744
|
|
|
1681
|
-
206
|
|
1682
|
-
207
|
|
1683
|
-
208
|
|
1684
|
-
209
|
|
1685
|
-
210
|
|
1686
|
-
211
|
|
1687
1745
|
212
|
|
1688
1746
|
213
|
|
1689
1747
|
214
|
|
1690
1748
|
215
|
|
1691
1749
|
216
|
|
1692
1750
|
217
|
|
1693
|
-
218
|
|
1751
|
+
218
|
|
1752
|
+
219
|
|
1753
|
+
220
|
|
1754
|
+
221
|
|
1755
|
+
222
|
|
1756
|
+
223
|
|
1757
|
+
224</pre>
|
|
1694
1758
|
</td>
|
|
1695
1759
|
<td>
|
|
1696
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line
|
|
1760
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 212</span>
|
|
1697
1761
|
|
|
1698
1762
|
<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'>metadata:</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'>sources:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>destination_ids:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1699
1763
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/event_subscriptions/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -1853,22 +1917,22 @@
|
|
|
1853
1917
|
<pre class="lines">
|
|
1854
1918
|
|
|
1855
1919
|
|
|
1856
|
-
232
|
|
1857
|
-
233
|
|
1858
|
-
234
|
|
1859
|
-
235
|
|
1860
|
-
236
|
|
1861
|
-
237
|
|
1862
1920
|
238
|
|
1863
1921
|
239
|
|
1864
1922
|
240
|
|
1865
1923
|
241
|
|
1866
1924
|
242
|
|
1867
1925
|
243
|
|
1868
|
-
244
|
|
1926
|
+
244
|
|
1927
|
+
245
|
|
1928
|
+
246
|
|
1929
|
+
247
|
|
1930
|
+
248
|
|
1931
|
+
249
|
|
1932
|
+
250</pre>
|
|
1869
1933
|
</td>
|
|
1870
1934
|
<td>
|
|
1871
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line
|
|
1935
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_subscriptions_client.rb', line 238</span>
|
|
1872
1936
|
|
|
1873
1937
|
<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'>metadata:</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'>sources:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>destination_ids:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1874
1938
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/event_subscriptions/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -1893,9 +1957,9 @@
|
|
|
1893
1957
|
</div>
|
|
1894
1958
|
|
|
1895
1959
|
<div id="footer">
|
|
1896
|
-
Generated on
|
|
1960
|
+
Generated on Fri Jan 23 21:38:08 2026 by
|
|
1897
1961
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1898
|
-
0.9.36 (ruby-3.3.
|
|
1962
|
+
0.9.36 (ruby-3.3.10).
|
|
1899
1963
|
</div>
|
|
1900
1964
|
|
|
1901
1965
|
</div>
|
|
@@ -1805,9 +1805,9 @@
|
|
|
1805
1805
|
</div>
|
|
1806
1806
|
|
|
1807
1807
|
<div id="footer">
|
|
1808
|
-
Generated on
|
|
1808
|
+
Generated on Fri Jan 23 21:38:08 2026 by
|
|
1809
1809
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1810
|
-
0.9.36 (ruby-3.3.
|
|
1810
|
+
0.9.36 (ruby-3.3.10).
|
|
1811
1811
|
</div>
|
|
1812
1812
|
|
|
1813
1813
|
</div>
|
|
@@ -1943,9 +1943,9 @@
|
|
|
1943
1943
|
</div>
|
|
1944
1944
|
|
|
1945
1945
|
<div id="footer">
|
|
1946
|
-
Generated on
|
|
1946
|
+
Generated on Fri Jan 23 21:38:09 2026 by
|
|
1947
1947
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1948
|
-
0.9.36 (ruby-3.3.
|
|
1948
|
+
0.9.36 (ruby-3.3.10).
|
|
1949
1949
|
</div>
|
|
1950
1950
|
|
|
1951
1951
|
</div>
|
|
@@ -1029,9 +1029,9 @@
|
|
|
1029
1029
|
</div>
|
|
1030
1030
|
|
|
1031
1031
|
<div id="footer">
|
|
1032
|
-
Generated on
|
|
1032
|
+
Generated on Fri Jan 23 21:38:10 2026 by
|
|
1033
1033
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1034
|
-
0.9.36 (ruby-3.3.
|
|
1034
|
+
0.9.36 (ruby-3.3.10).
|
|
1035
1035
|
</div>
|
|
1036
1036
|
|
|
1037
1037
|
</div>
|
|
@@ -1029,9 +1029,9 @@
|
|
|
1029
1029
|
</div>
|
|
1030
1030
|
|
|
1031
1031
|
<div id="footer">
|
|
1032
|
-
Generated on
|
|
1032
|
+
Generated on Fri Jan 23 21:38:11 2026 by
|
|
1033
1033
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1034
|
-
0.9.36 (ruby-3.3.
|
|
1034
|
+
0.9.36 (ruby-3.3.10).
|
|
1035
1035
|
</div>
|
|
1036
1036
|
|
|
1037
1037
|
</div>
|