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
|
|
|
@@ -1251,7 +1251,7 @@
|
|
|
1251
1251
|
<div class="method_details ">
|
|
1252
1252
|
<h3 class="signature " id="list-instance_method">
|
|
1253
1253
|
|
|
1254
|
-
#<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>
|
|
1254
|
+
#<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>
|
|
1255
1255
|
|
|
1256
1256
|
|
|
1257
1257
|
|
|
@@ -1282,6 +1282,11 @@
|
|
|
1282
1282
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1283
1283
|
|
|
1284
1284
|
|
|
1285
|
+
—
|
|
1286
|
+
<div class='inline'>
|
|
1287
|
+
<p>Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.</p>
|
|
1288
|
+
</div>
|
|
1289
|
+
|
|
1285
1290
|
</li>
|
|
1286
1291
|
|
|
1287
1292
|
<li>
|
|
@@ -1295,6 +1300,29 @@
|
|
|
1295
1300
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1296
1301
|
|
|
1297
1302
|
|
|
1303
|
+
—
|
|
1304
|
+
<div class='inline'>
|
|
1305
|
+
<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>
|
|
1306
|
+
</div>
|
|
1307
|
+
|
|
1308
|
+
</li>
|
|
1309
|
+
|
|
1310
|
+
<li>
|
|
1311
|
+
|
|
1312
|
+
<span class='name'>filter</span>
|
|
1313
|
+
|
|
1314
|
+
|
|
1315
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1316
|
+
|
|
1317
|
+
|
|
1318
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1319
|
+
|
|
1320
|
+
|
|
1321
|
+
—
|
|
1322
|
+
<div class='inline'>
|
|
1323
|
+
<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>
|
|
1324
|
+
</div>
|
|
1325
|
+
|
|
1298
1326
|
</li>
|
|
1299
1327
|
|
|
1300
1328
|
<li>
|
|
@@ -1342,7 +1370,6 @@
|
|
|
1342
1370
|
<pre class="lines">
|
|
1343
1371
|
|
|
1344
1372
|
|
|
1345
|
-
145
|
|
1346
1373
|
146
|
|
1347
1374
|
147
|
|
1348
1375
|
148
|
|
@@ -1360,19 +1387,24 @@
|
|
|
1360
1387
|
160
|
|
1361
1388
|
161
|
|
1362
1389
|
162
|
|
1363
|
-
163
|
|
1390
|
+
163
|
|
1391
|
+
164
|
|
1392
|
+
165
|
|
1393
|
+
166</pre>
|
|
1364
1394
|
</td>
|
|
1365
1395
|
<td>
|
|
1366
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line
|
|
1396
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 146</span>
|
|
1367
1397
|
|
|
1368
1398
|
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
|
1369
1399
|
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1370
1400
|
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1401
|
+
<span class='label'>filter:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1371
1402
|
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1372
1403
|
<span class='rparen'>)</span>
|
|
1373
1404
|
<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>
|
|
1374
1405
|
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1375
1406
|
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1407
|
+
<span class='label'>filter:</span> <span class='id identifier rubyid_filter'>filter</span><span class='comma'>,</span>
|
|
1376
1408
|
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1377
1409
|
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::AgentIngressesClient::PATH (constant)">PATH</a></span></span>
|
|
1378
1410
|
<span class='rparen'>)</span>
|
|
@@ -1392,7 +1424,7 @@
|
|
|
1392
1424
|
<div class="method_details ">
|
|
1393
1425
|
<h3 class="signature " id="list!-instance_method">
|
|
1394
1426
|
|
|
1395
|
-
#<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>
|
|
1427
|
+
#<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>
|
|
1396
1428
|
|
|
1397
1429
|
|
|
1398
1430
|
|
|
@@ -1423,6 +1455,11 @@
|
|
|
1423
1455
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1424
1456
|
|
|
1425
1457
|
|
|
1458
|
+
—
|
|
1459
|
+
<div class='inline'>
|
|
1460
|
+
<p>Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.</p>
|
|
1461
|
+
</div>
|
|
1462
|
+
|
|
1426
1463
|
</li>
|
|
1427
1464
|
|
|
1428
1465
|
<li>
|
|
@@ -1436,6 +1473,29 @@
|
|
|
1436
1473
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1437
1474
|
|
|
1438
1475
|
|
|
1476
|
+
—
|
|
1477
|
+
<div class='inline'>
|
|
1478
|
+
<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>
|
|
1479
|
+
</div>
|
|
1480
|
+
|
|
1481
|
+
</li>
|
|
1482
|
+
|
|
1483
|
+
<li>
|
|
1484
|
+
|
|
1485
|
+
<span class='name'>filter</span>
|
|
1486
|
+
|
|
1487
|
+
|
|
1488
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1489
|
+
|
|
1490
|
+
|
|
1491
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1492
|
+
|
|
1493
|
+
|
|
1494
|
+
—
|
|
1495
|
+
<div class='inline'>
|
|
1496
|
+
<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>
|
|
1497
|
+
</div>
|
|
1498
|
+
|
|
1439
1499
|
</li>
|
|
1440
1500
|
|
|
1441
1501
|
<li>
|
|
@@ -1483,10 +1543,6 @@
|
|
|
1483
1543
|
<pre class="lines">
|
|
1484
1544
|
|
|
1485
1545
|
|
|
1486
|
-
175
|
|
1487
|
-
176
|
|
1488
|
-
177
|
|
1489
|
-
178
|
|
1490
1546
|
179
|
|
1491
1547
|
180
|
|
1492
1548
|
181
|
|
@@ -1503,19 +1559,27 @@
|
|
|
1503
1559
|
192
|
|
1504
1560
|
193
|
|
1505
1561
|
194
|
|
1506
|
-
195
|
|
1562
|
+
195
|
|
1563
|
+
196
|
|
1564
|
+
197
|
|
1565
|
+
198
|
|
1566
|
+
199
|
|
1567
|
+
200
|
|
1568
|
+
201</pre>
|
|
1507
1569
|
</td>
|
|
1508
1570
|
<td>
|
|
1509
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line
|
|
1571
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 179</span>
|
|
1510
1572
|
|
|
1511
1573
|
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span>
|
|
1512
1574
|
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1513
1575
|
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1576
|
+
<span class='label'>filter:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1514
1577
|
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1515
1578
|
<span class='rparen'>)</span>
|
|
1516
1579
|
<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>
|
|
1517
1580
|
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1518
1581
|
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1582
|
+
<span class='label'>filter:</span> <span class='id identifier rubyid_filter'>filter</span><span class='comma'>,</span>
|
|
1519
1583
|
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
|
1520
1584
|
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1521
1585
|
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::AgentIngressesClient::PATH (constant)">PATH</a></span></span>
|
|
@@ -1651,21 +1715,21 @@
|
|
|
1651
1715
|
<pre class="lines">
|
|
1652
1716
|
|
|
1653
1717
|
|
|
1654
|
-
207
|
|
1655
|
-
208
|
|
1656
|
-
209
|
|
1657
|
-
210
|
|
1658
|
-
211
|
|
1659
|
-
212
|
|
1660
1718
|
213
|
|
1661
1719
|
214
|
|
1662
1720
|
215
|
|
1663
1721
|
216
|
|
1664
1722
|
217
|
|
1665
|
-
218
|
|
1723
|
+
218
|
|
1724
|
+
219
|
|
1725
|
+
220
|
|
1726
|
+
221
|
|
1727
|
+
222
|
|
1728
|
+
223
|
|
1729
|
+
224</pre>
|
|
1666
1730
|
</td>
|
|
1667
1731
|
<td>
|
|
1668
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line
|
|
1732
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 213</span>
|
|
1669
1733
|
|
|
1670
1734
|
<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'>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'>certificate_management_policy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1671
1735
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/agent_ingresses/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -1801,21 +1865,21 @@
|
|
|
1801
1865
|
<pre class="lines">
|
|
1802
1866
|
|
|
1803
1867
|
|
|
1804
|
-
231
|
|
1805
|
-
232
|
|
1806
|
-
233
|
|
1807
|
-
234
|
|
1808
|
-
235
|
|
1809
|
-
236
|
|
1810
1868
|
237
|
|
1811
1869
|
238
|
|
1812
1870
|
239
|
|
1813
1871
|
240
|
|
1814
1872
|
241
|
|
1815
|
-
242
|
|
1873
|
+
242
|
|
1874
|
+
243
|
|
1875
|
+
244
|
|
1876
|
+
245
|
|
1877
|
+
246
|
|
1878
|
+
247
|
|
1879
|
+
248</pre>
|
|
1816
1880
|
</td>
|
|
1817
1881
|
<td>
|
|
1818
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line
|
|
1882
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/agent_ingresses_client.rb', line 237</span>
|
|
1819
1883
|
|
|
1820
1884
|
<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'>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'>certificate_management_policy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1821
1885
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/agent_ingresses/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -1839,9 +1903,9 @@
|
|
|
1839
1903
|
</div>
|
|
1840
1904
|
|
|
1841
1905
|
<div id="footer">
|
|
1842
|
-
Generated on
|
|
1906
|
+
Generated on Fri Jan 23 21:38:06 2026 by
|
|
1843
1907
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1844
|
-
0.9.36 (ruby-3.3.
|
|
1908
|
+
0.9.36 (ruby-3.3.10).
|
|
1845
1909
|
</div>
|
|
1846
1910
|
|
|
1847
1911
|
</div>
|
|
@@ -1137,9 +1137,9 @@
|
|
|
1137
1137
|
</div>
|
|
1138
1138
|
|
|
1139
1139
|
<div id="footer">
|
|
1140
|
-
Generated on
|
|
1140
|
+
Generated on Fri Jan 23 21:38:08 2026 by
|
|
1141
1141
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1142
|
-
0.9.36 (ruby-3.3.
|
|
1142
|
+
0.9.36 (ruby-3.3.10).
|
|
1143
1143
|
</div>
|
|
1144
1144
|
|
|
1145
1145
|
</div>
|
|
@@ -1137,9 +1137,9 @@
|
|
|
1137
1137
|
</div>
|
|
1138
1138
|
|
|
1139
1139
|
<div id="footer">
|
|
1140
|
-
Generated on
|
|
1140
|
+
Generated on Fri Jan 23 21:38:07 2026 by
|
|
1141
1141
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1142
|
-
0.9.36 (ruby-3.3.
|
|
1142
|
+
0.9.36 (ruby-3.3.10).
|
|
1143
1143
|
</div>
|
|
1144
1144
|
|
|
1145
1145
|
</div>
|
|
@@ -1723,9 +1723,9 @@
|
|
|
1723
1723
|
</div>
|
|
1724
1724
|
|
|
1725
1725
|
<div id="footer">
|
|
1726
|
-
Generated on
|
|
1726
|
+
Generated on Fri Jan 23 21:38:03 2026 by
|
|
1727
1727
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1728
|
-
0.9.36 (ruby-3.3.
|
|
1728
|
+
0.9.36 (ruby-3.3.10).
|
|
1729
1729
|
</div>
|
|
1730
1730
|
|
|
1731
1731
|
</div>
|
|
@@ -318,7 +318,7 @@
|
|
|
318
318
|
|
|
319
319
|
|
|
320
320
|
<span class="summary_desc"><div class='inline'>
|
|
321
|
-
<p>Get detailed information about a
|
|
321
|
+
<p>Get detailed information about a certificate authority.</p>
|
|
322
322
|
</div></span>
|
|
323
323
|
|
|
324
324
|
</li>
|
|
@@ -342,7 +342,7 @@
|
|
|
342
342
|
|
|
343
343
|
|
|
344
344
|
<span class="summary_desc"><div class='inline'>
|
|
345
|
-
<p>Get detailed information about a
|
|
345
|
+
<p>Get detailed information about a certificate authority Throws an exception if API error.</p>
|
|
346
346
|
</div></span>
|
|
347
347
|
|
|
348
348
|
</li>
|
|
@@ -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, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
380
|
+
<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>
|
|
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, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
404
|
+
<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>
|
|
405
405
|
|
|
406
406
|
|
|
407
407
|
|
|
@@ -1032,7 +1032,7 @@
|
|
|
1032
1032
|
</h3><div class="docstring">
|
|
1033
1033
|
<div class="discussion">
|
|
1034
1034
|
|
|
1035
|
-
<p>Get detailed information about a
|
|
1035
|
+
<p>Get detailed information about a certificate authority</p>
|
|
1036
1036
|
|
|
1037
1037
|
<p><a href="https://ngrok.com/docs/api#api-certificate-authorities-get">ngrok.com/docs/api#api-certificate-authorities-get</a></p>
|
|
1038
1038
|
|
|
@@ -1127,7 +1127,7 @@
|
|
|
1127
1127
|
</h3><div class="docstring">
|
|
1128
1128
|
<div class="discussion">
|
|
1129
1129
|
|
|
1130
|
-
<p>Get detailed information about a
|
|
1130
|
+
<p>Get detailed information about a certificate authority Throws an exception if API error.</p>
|
|
1131
1131
|
|
|
1132
1132
|
<p><a href="https://ngrok.com/docs/api#api-certificate-authorities-get">ngrok.com/docs/api#api-certificate-authorities-get</a></p>
|
|
1133
1133
|
|
|
@@ -1213,7 +1213,7 @@
|
|
|
1213
1213
|
<div class="method_details ">
|
|
1214
1214
|
<h3 class="signature " id="list-instance_method">
|
|
1215
1215
|
|
|
1216
|
-
#<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>
|
|
1216
|
+
#<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>
|
|
1217
1217
|
|
|
1218
1218
|
|
|
1219
1219
|
|
|
@@ -1244,6 +1244,11 @@
|
|
|
1244
1244
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1245
1245
|
|
|
1246
1246
|
|
|
1247
|
+
—
|
|
1248
|
+
<div class='inline'>
|
|
1249
|
+
<p>Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.</p>
|
|
1250
|
+
</div>
|
|
1251
|
+
|
|
1247
1252
|
</li>
|
|
1248
1253
|
|
|
1249
1254
|
<li>
|
|
@@ -1257,6 +1262,29 @@
|
|
|
1257
1262
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1258
1263
|
|
|
1259
1264
|
|
|
1265
|
+
—
|
|
1266
|
+
<div class='inline'>
|
|
1267
|
+
<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>
|
|
1268
|
+
</div>
|
|
1269
|
+
|
|
1270
|
+
</li>
|
|
1271
|
+
|
|
1272
|
+
<li>
|
|
1273
|
+
|
|
1274
|
+
<span class='name'>filter</span>
|
|
1275
|
+
|
|
1276
|
+
|
|
1277
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1278
|
+
|
|
1279
|
+
|
|
1280
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1281
|
+
|
|
1282
|
+
|
|
1283
|
+
—
|
|
1284
|
+
<div class='inline'>
|
|
1285
|
+
<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>
|
|
1286
|
+
</div>
|
|
1287
|
+
|
|
1260
1288
|
</li>
|
|
1261
1289
|
|
|
1262
1290
|
<li>
|
|
@@ -1304,7 +1332,6 @@
|
|
|
1304
1332
|
<pre class="lines">
|
|
1305
1333
|
|
|
1306
1334
|
|
|
1307
|
-
145
|
|
1308
1335
|
146
|
|
1309
1336
|
147
|
|
1310
1337
|
148
|
|
@@ -1322,19 +1349,24 @@
|
|
|
1322
1349
|
160
|
|
1323
1350
|
161
|
|
1324
1351
|
162
|
|
1325
|
-
163
|
|
1352
|
+
163
|
|
1353
|
+
164
|
|
1354
|
+
165
|
|
1355
|
+
166</pre>
|
|
1326
1356
|
</td>
|
|
1327
1357
|
<td>
|
|
1328
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line
|
|
1358
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 146</span>
|
|
1329
1359
|
|
|
1330
1360
|
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
|
1331
1361
|
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1332
1362
|
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1363
|
+
<span class='label'>filter:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1333
1364
|
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1334
1365
|
<span class='rparen'>)</span>
|
|
1335
1366
|
<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>
|
|
1336
1367
|
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1337
1368
|
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1369
|
+
<span class='label'>filter:</span> <span class='id identifier rubyid_filter'>filter</span><span class='comma'>,</span>
|
|
1338
1370
|
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1339
1371
|
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::CertificateAuthoritiesClient::PATH (constant)">PATH</a></span></span>
|
|
1340
1372
|
<span class='rparen'>)</span>
|
|
@@ -1354,7 +1386,7 @@
|
|
|
1354
1386
|
<div class="method_details ">
|
|
1355
1387
|
<h3 class="signature " id="list!-instance_method">
|
|
1356
1388
|
|
|
1357
|
-
#<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>
|
|
1389
|
+
#<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>
|
|
1358
1390
|
|
|
1359
1391
|
|
|
1360
1392
|
|
|
@@ -1385,6 +1417,11 @@
|
|
|
1385
1417
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1386
1418
|
|
|
1387
1419
|
|
|
1420
|
+
—
|
|
1421
|
+
<div class='inline'>
|
|
1422
|
+
<p>Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.</p>
|
|
1423
|
+
</div>
|
|
1424
|
+
|
|
1388
1425
|
</li>
|
|
1389
1426
|
|
|
1390
1427
|
<li>
|
|
@@ -1398,6 +1435,29 @@
|
|
|
1398
1435
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1399
1436
|
|
|
1400
1437
|
|
|
1438
|
+
—
|
|
1439
|
+
<div class='inline'>
|
|
1440
|
+
<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>
|
|
1441
|
+
</div>
|
|
1442
|
+
|
|
1443
|
+
</li>
|
|
1444
|
+
|
|
1445
|
+
<li>
|
|
1446
|
+
|
|
1447
|
+
<span class='name'>filter</span>
|
|
1448
|
+
|
|
1449
|
+
|
|
1450
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1451
|
+
|
|
1452
|
+
|
|
1453
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1454
|
+
|
|
1455
|
+
|
|
1456
|
+
—
|
|
1457
|
+
<div class='inline'>
|
|
1458
|
+
<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>
|
|
1459
|
+
</div>
|
|
1460
|
+
|
|
1401
1461
|
</li>
|
|
1402
1462
|
|
|
1403
1463
|
<li>
|
|
@@ -1445,10 +1505,6 @@
|
|
|
1445
1505
|
<pre class="lines">
|
|
1446
1506
|
|
|
1447
1507
|
|
|
1448
|
-
175
|
|
1449
|
-
176
|
|
1450
|
-
177
|
|
1451
|
-
178
|
|
1452
1508
|
179
|
|
1453
1509
|
180
|
|
1454
1510
|
181
|
|
@@ -1465,19 +1521,27 @@
|
|
|
1465
1521
|
192
|
|
1466
1522
|
193
|
|
1467
1523
|
194
|
|
1468
|
-
195
|
|
1524
|
+
195
|
|
1525
|
+
196
|
|
1526
|
+
197
|
|
1527
|
+
198
|
|
1528
|
+
199
|
|
1529
|
+
200
|
|
1530
|
+
201</pre>
|
|
1469
1531
|
</td>
|
|
1470
1532
|
<td>
|
|
1471
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line
|
|
1533
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 179</span>
|
|
1472
1534
|
|
|
1473
1535
|
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span>
|
|
1474
1536
|
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1475
1537
|
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1538
|
+
<span class='label'>filter:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1476
1539
|
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1477
1540
|
<span class='rparen'>)</span>
|
|
1478
1541
|
<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>
|
|
1479
1542
|
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1480
1543
|
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1544
|
+
<span class='label'>filter:</span> <span class='id identifier rubyid_filter'>filter</span><span class='comma'>,</span>
|
|
1481
1545
|
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
|
1482
1546
|
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1483
1547
|
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::CertificateAuthoritiesClient::PATH (constant)">PATH</a></span></span>
|
|
@@ -1595,20 +1659,20 @@
|
|
|
1595
1659
|
<pre class="lines">
|
|
1596
1660
|
|
|
1597
1661
|
|
|
1598
|
-
206
|
|
1599
|
-
207
|
|
1600
|
-
208
|
|
1601
|
-
209
|
|
1602
|
-
210
|
|
1603
|
-
211
|
|
1604
1662
|
212
|
|
1605
1663
|
213
|
|
1606
1664
|
214
|
|
1607
1665
|
215
|
|
1608
|
-
216
|
|
1666
|
+
216
|
|
1667
|
+
217
|
|
1668
|
+
218
|
|
1669
|
+
219
|
|
1670
|
+
220
|
|
1671
|
+
221
|
|
1672
|
+
222</pre>
|
|
1609
1673
|
</td>
|
|
1610
1674
|
<td>
|
|
1611
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line
|
|
1675
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 212</span>
|
|
1612
1676
|
|
|
1613
1677
|
<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'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1614
1678
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/certificate_authorities/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -1725,20 +1789,20 @@
|
|
|
1725
1789
|
<pre class="lines">
|
|
1726
1790
|
|
|
1727
1791
|
|
|
1728
|
-
228
|
|
1729
|
-
229
|
|
1730
|
-
230
|
|
1731
|
-
231
|
|
1732
|
-
232
|
|
1733
|
-
233
|
|
1734
1792
|
234
|
|
1735
1793
|
235
|
|
1736
1794
|
236
|
|
1737
1795
|
237
|
|
1738
|
-
238
|
|
1796
|
+
238
|
|
1797
|
+
239
|
|
1798
|
+
240
|
|
1799
|
+
241
|
|
1800
|
+
242
|
|
1801
|
+
243
|
|
1802
|
+
244</pre>
|
|
1739
1803
|
</td>
|
|
1740
1804
|
<td>
|
|
1741
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line
|
|
1805
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/certificate_authorities_client.rb', line 234</span>
|
|
1742
1806
|
|
|
1743
1807
|
<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'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1744
1808
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/certificate_authorities/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -1761,9 +1825,9 @@
|
|
|
1761
1825
|
</div>
|
|
1762
1826
|
|
|
1763
1827
|
<div id="footer">
|
|
1764
|
-
Generated on
|
|
1828
|
+
Generated on Fri Jan 23 21:38:09 2026 by
|
|
1765
1829
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1766
|
-
0.9.36 (ruby-3.3.
|
|
1830
|
+
0.9.36 (ruby-3.3.10).
|
|
1767
1831
|
</div>
|
|
1768
1832
|
|
|
1769
1833
|
</div>
|