ngrok-api 0.26.0 → 0.28.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +10 -0
- data/Gemfile.lock +1 -11
- data/doc/NgrokAPI/Client.html +100 -48
- data/doc/NgrokAPI/Error.html +2 -2
- data/doc/NgrokAPI/Errors/NotFoundError.html +2 -2
- data/doc/NgrokAPI/Errors.html +2 -2
- data/doc/NgrokAPI/HttpClient.html +2 -2
- data/doc/NgrokAPI/Models/APIKey.html +2 -2
- data/doc/NgrokAPI/Models/AWSAuth.html +2 -2
- data/doc/NgrokAPI/Models/AWSCredentials.html +2 -2
- data/doc/NgrokAPI/Models/AWSRole.html +2 -2
- data/doc/NgrokAPI/Models/AbuseReport.html +2 -2
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +2 -2
- data/doc/NgrokAPI/Models/AgentIngress.html +2 -2
- data/doc/NgrokAPI/Models/AgentIngressCertJob.html +2 -2
- data/doc/NgrokAPI/Models/AgentIngressCertPolicy.html +2 -2
- data/doc/NgrokAPI/Models/AgentIngressCertStatus.html +2 -2
- data/doc/NgrokAPI/Models/ApplicationSession.html +2 -2
- data/doc/NgrokAPI/Models/ApplicationUser.html +2 -2
- data/doc/NgrokAPI/Models/BotUser.html +2 -2
- data/doc/NgrokAPI/Models/BrowserSession.html +2 -2
- data/doc/NgrokAPI/Models/CertificateAuthority.html +2 -2
- data/doc/NgrokAPI/Models/Credential.html +2 -2
- data/doc/NgrokAPI/Models/Endpoint.html +5 -5
- data/doc/NgrokAPI/Models/EndpointBackend.html +2 -2
- data/doc/NgrokAPI/Models/EndpointBackendMutate.html +2 -2
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +2 -2
- data/doc/NgrokAPI/Models/EndpointCompression.html +2 -2
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +2 -2
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +2 -2
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +2 -2
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuth.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthAmazon.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthGitLab.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthLinkedIn.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthTwitch.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOIDC.html +2 -2
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +2 -2
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +2 -2
- data/doc/NgrokAPI/Models/EndpointSAML.html +2 -2
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +2 -2
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +2 -2
- data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +2 -2
- data/doc/NgrokAPI/Models/EndpointTrafficPolicy.html +2 -2
- data/doc/NgrokAPI/Models/EndpointUserAgentFilter.html +2 -2
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +2 -2
- data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +2 -2
- data/doc/NgrokAPI/Models/EventDestination.html +2 -2
- data/doc/NgrokAPI/Models/EventSource.html +2 -2
- data/doc/NgrokAPI/Models/EventSourceList.html +2 -2
- data/doc/NgrokAPI/Models/EventSourceReplace.html +2 -2
- data/doc/NgrokAPI/Models/EventSubscription.html +2 -2
- data/doc/NgrokAPI/Models/EventTarget.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetAzureLogsIngestion.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetDatadog.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +2 -2
- data/doc/NgrokAPI/Models/FailoverBackend.html +2 -2
- data/doc/NgrokAPI/Models/HTTPResponseBackend.html +2 -2
- data/doc/NgrokAPI/Models/HTTPSEdge.html +2 -2
- data/doc/NgrokAPI/Models/HTTPSEdgeRoute.html +2 -2
- data/doc/NgrokAPI/Models/IPPolicy.html +2 -2
- data/doc/NgrokAPI/Models/IPPolicyRule.html +2 -2
- data/doc/NgrokAPI/Models/IPRestriction.html +2 -2
- data/doc/NgrokAPI/Models/IdentityProvider.html +2 -2
- data/doc/NgrokAPI/Models/Listable.html +2 -2
- data/doc/NgrokAPI/Models/Location.html +2 -2
- data/doc/NgrokAPI/Models/Ref.html +2 -2
- data/doc/NgrokAPI/Models/ReservedAddr.html +2 -2
- data/doc/NgrokAPI/Models/ReservedDomain.html +95 -21
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +2 -2
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +2 -2
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +2 -2
- data/doc/NgrokAPI/Models/ReservedDomainResolvesToEntry.html +595 -0
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +2 -2
- data/doc/NgrokAPI/Models/SSHCredential.html +2 -2
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +2 -2
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +2 -2
- data/doc/NgrokAPI/Models/Secret.html +95 -21
- data/doc/NgrokAPI/Models/ServiceUser.html +1051 -0
- data/doc/NgrokAPI/Models/StaticBackend.html +2 -2
- data/doc/NgrokAPI/Models/StaticBackendTLS.html +2 -2
- data/doc/NgrokAPI/Models/TCPEdge.html +2 -2
- data/doc/NgrokAPI/Models/TLSCertificate.html +2 -2
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +2 -2
- data/doc/NgrokAPI/Models/TLSEdge.html +2 -2
- data/doc/NgrokAPI/Models/Tunnel.html +2 -2
- data/doc/NgrokAPI/Models/TunnelGroupBackend.html +2 -2
- data/doc/NgrokAPI/Models/TunnelSession.html +2 -2
- data/doc/NgrokAPI/Models/UserAgent.html +2 -2
- data/doc/NgrokAPI/Models/Vault.html +2 -2
- data/doc/NgrokAPI/Models/WeightedBackend.html +2 -2
- data/doc/NgrokAPI/Models.html +4 -4
- data/doc/NgrokAPI/PagedIterator.html +2 -2
- data/doc/NgrokAPI/Services/APIKeysClient.html +95 -31
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +2 -2
- data/doc/NgrokAPI/Services/AgentIngressesClient.html +95 -31
- data/doc/NgrokAPI/Services/ApplicationSessionsClient.html +2 -2
- data/doc/NgrokAPI/Services/ApplicationUsersClient.html +2 -2
- data/doc/NgrokAPI/Services/BotUsersClient.html +2 -2
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +99 -35
- data/doc/NgrokAPI/Services/CredentialsClient.html +103 -39
- data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteTrafficPolicyModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgesHTTPSClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgesTCPClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgesTLSClient.html +2 -2
- data/doc/NgrokAPI/Services/EndpointsClient.html +163 -79
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +95 -31
- data/doc/NgrokAPI/Services/EventSourcesClient.html +2 -2
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +95 -31
- data/doc/NgrokAPI/Services/FailoverBackendsClient.html +2 -2
- data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +2 -2
- data/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +95 -31
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +95 -31
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +95 -31
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +95 -31
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +270 -126
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +99 -35
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +101 -37
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +6 -6
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +6 -6
- data/doc/NgrokAPI/Services/SecretsClient.html +181 -73
- data/doc/NgrokAPI/Services/ServiceUsersClient.html +1797 -0
- data/doc/NgrokAPI/Services/StaticBackendsClient.html +2 -2
- data/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TCPEdgeTrafficPolicyModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TLSCertificatesClient.html +95 -31
- data/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TLSEdgeTrafficPolicyModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +2 -2
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +143 -79
- data/doc/NgrokAPI/Services/TunnelsClient.html +2 -2
- data/doc/NgrokAPI/Services/VaultsClient.html +79 -15
- data/doc/NgrokAPI/Services/WeightedBackendsClient.html +2 -2
- data/doc/NgrokAPI/Services.html +4 -4
- data/doc/NgrokAPI.html +3 -3
- data/doc/_index.html +23 -2
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +2 -2
- data/doc/index.html +2 -2
- data/doc/method_list.html +1092 -812
- data/doc/top-level-namespace.html +2 -2
- data/docs/NgrokAPI/Client.html +100 -48
- data/docs/NgrokAPI/Error.html +2 -2
- data/docs/NgrokAPI/Errors/NotFoundError.html +2 -2
- data/docs/NgrokAPI/Errors.html +2 -2
- data/docs/NgrokAPI/HttpClient.html +2 -2
- data/docs/NgrokAPI/Models/APIKey.html +2 -2
- data/docs/NgrokAPI/Models/AWSAuth.html +2 -2
- data/docs/NgrokAPI/Models/AWSCredentials.html +2 -2
- data/docs/NgrokAPI/Models/AWSRole.html +2 -2
- data/docs/NgrokAPI/Models/AbuseReport.html +2 -2
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +2 -2
- data/docs/NgrokAPI/Models/AgentIngress.html +2 -2
- data/docs/NgrokAPI/Models/AgentIngressCertJob.html +2 -2
- data/docs/NgrokAPI/Models/AgentIngressCertPolicy.html +2 -2
- data/docs/NgrokAPI/Models/AgentIngressCertStatus.html +2 -2
- data/docs/NgrokAPI/Models/ApplicationSession.html +2 -2
- data/docs/NgrokAPI/Models/ApplicationUser.html +2 -2
- data/docs/NgrokAPI/Models/BotUser.html +2 -2
- data/docs/NgrokAPI/Models/BrowserSession.html +2 -2
- data/docs/NgrokAPI/Models/CertificateAuthority.html +2 -2
- data/docs/NgrokAPI/Models/Credential.html +2 -2
- data/docs/NgrokAPI/Models/Endpoint.html +5 -5
- data/docs/NgrokAPI/Models/EndpointBackend.html +2 -2
- data/docs/NgrokAPI/Models/EndpointBackendMutate.html +2 -2
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +2 -2
- data/docs/NgrokAPI/Models/EndpointCompression.html +2 -2
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +2 -2
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +2 -2
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +2 -2
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuth.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthAmazon.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthGitLab.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthLinkedIn.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthTwitch.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOIDC.html +2 -2
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +2 -2
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +2 -2
- data/docs/NgrokAPI/Models/EndpointSAML.html +2 -2
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +2 -2
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +2 -2
- data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +2 -2
- data/docs/NgrokAPI/Models/EndpointTrafficPolicy.html +2 -2
- data/docs/NgrokAPI/Models/EndpointUserAgentFilter.html +2 -2
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +2 -2
- data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +2 -2
- data/docs/NgrokAPI/Models/EventDestination.html +2 -2
- data/docs/NgrokAPI/Models/EventSource.html +2 -2
- data/docs/NgrokAPI/Models/EventSourceList.html +2 -2
- data/docs/NgrokAPI/Models/EventSourceReplace.html +2 -2
- data/docs/NgrokAPI/Models/EventSubscription.html +2 -2
- data/docs/NgrokAPI/Models/EventTarget.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetAzureLogsIngestion.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetDatadog.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +2 -2
- data/docs/NgrokAPI/Models/FailoverBackend.html +2 -2
- data/docs/NgrokAPI/Models/HTTPResponseBackend.html +2 -2
- data/docs/NgrokAPI/Models/HTTPSEdge.html +2 -2
- data/docs/NgrokAPI/Models/HTTPSEdgeRoute.html +2 -2
- data/docs/NgrokAPI/Models/IPPolicy.html +2 -2
- data/docs/NgrokAPI/Models/IPPolicyRule.html +2 -2
- data/docs/NgrokAPI/Models/IPRestriction.html +2 -2
- data/docs/NgrokAPI/Models/IdentityProvider.html +2 -2
- data/docs/NgrokAPI/Models/Listable.html +2 -2
- data/docs/NgrokAPI/Models/Location.html +2 -2
- data/docs/NgrokAPI/Models/Ref.html +2 -2
- data/docs/NgrokAPI/Models/ReservedAddr.html +2 -2
- data/docs/NgrokAPI/Models/ReservedDomain.html +95 -21
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +2 -2
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +2 -2
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +2 -2
- data/docs/NgrokAPI/Models/ReservedDomainResolvesToEntry.html +595 -0
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +2 -2
- data/docs/NgrokAPI/Models/SSHCredential.html +2 -2
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +2 -2
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +2 -2
- data/docs/NgrokAPI/Models/Secret.html +95 -21
- data/docs/NgrokAPI/Models/ServiceUser.html +1051 -0
- data/docs/NgrokAPI/Models/StaticBackend.html +2 -2
- data/docs/NgrokAPI/Models/StaticBackendTLS.html +2 -2
- data/docs/NgrokAPI/Models/TCPEdge.html +2 -2
- data/docs/NgrokAPI/Models/TLSCertificate.html +2 -2
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +2 -2
- data/docs/NgrokAPI/Models/TLSEdge.html +2 -2
- data/docs/NgrokAPI/Models/Tunnel.html +2 -2
- data/docs/NgrokAPI/Models/TunnelGroupBackend.html +2 -2
- data/docs/NgrokAPI/Models/TunnelSession.html +2 -2
- data/docs/NgrokAPI/Models/UserAgent.html +2 -2
- data/docs/NgrokAPI/Models/Vault.html +2 -2
- data/docs/NgrokAPI/Models/WeightedBackend.html +2 -2
- data/docs/NgrokAPI/Models.html +4 -4
- data/docs/NgrokAPI/PagedIterator.html +2 -2
- data/docs/NgrokAPI/Services/APIKeysClient.html +95 -31
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +2 -2
- data/docs/NgrokAPI/Services/AgentIngressesClient.html +95 -31
- data/docs/NgrokAPI/Services/ApplicationSessionsClient.html +2 -2
- data/docs/NgrokAPI/Services/ApplicationUsersClient.html +2 -2
- data/docs/NgrokAPI/Services/BotUsersClient.html +2 -2
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +99 -35
- data/docs/NgrokAPI/Services/CredentialsClient.html +103 -39
- data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteTrafficPolicyModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgesHTTPSClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgesTCPClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgesTLSClient.html +2 -2
- data/docs/NgrokAPI/Services/EndpointsClient.html +163 -79
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +95 -31
- data/docs/NgrokAPI/Services/EventSourcesClient.html +2 -2
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +95 -31
- data/docs/NgrokAPI/Services/FailoverBackendsClient.html +2 -2
- data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +2 -2
- data/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +95 -31
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +95 -31
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +95 -31
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +95 -31
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +270 -126
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +99 -35
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +101 -37
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +6 -6
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +6 -6
- data/docs/NgrokAPI/Services/SecretsClient.html +181 -73
- data/docs/NgrokAPI/Services/ServiceUsersClient.html +1797 -0
- data/docs/NgrokAPI/Services/StaticBackendsClient.html +2 -2
- data/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TCPEdgeTrafficPolicyModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TLSCertificatesClient.html +95 -31
- data/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TLSEdgeTrafficPolicyModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +2 -2
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +143 -79
- data/docs/NgrokAPI/Services/TunnelsClient.html +2 -2
- data/docs/NgrokAPI/Services/VaultsClient.html +79 -15
- data/docs/NgrokAPI/Services/WeightedBackendsClient.html +2 -2
- data/docs/NgrokAPI/Services.html +4 -4
- data/docs/NgrokAPI.html +3 -3
- data/docs/_index.html +23 -2
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +2 -2
- data/docs/index.html +2 -2
- data/docs/method_list.html +1092 -812
- data/docs/top-level-namespace.html +2 -2
- data/lib/ngrokapi/client.rb +4 -0
- data/lib/ngrokapi/models/endpoint.rb +1 -1
- data/lib/ngrokapi/models/reserved_domain.rb +3 -1
- data/lib/ngrokapi/models/reserved_domain_resolves_to_entry.rb +31 -0
- data/lib/ngrokapi/models/secret.rb +3 -1
- data/lib/ngrokapi/models/service_user.rb +70 -0
- data/lib/ngrokapi/services/agent_ingresses_client.rb +10 -4
- data/lib/ngrokapi/services/api_keys_client.rb +10 -4
- data/lib/ngrokapi/services/certificate_authorities_client.rb +12 -6
- data/lib/ngrokapi/services/credentials_client.rb +14 -8
- data/lib/ngrokapi/services/endpoints_client.rb +18 -12
- data/lib/ngrokapi/services/event_destinations_client.rb +10 -4
- data/lib/ngrokapi/services/event_subscriptions_client.rb +10 -4
- data/lib/ngrokapi/services/ip_policies_client.rb +10 -4
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +10 -4
- data/lib/ngrokapi/services/ip_restrictions_client.rb +10 -4
- data/lib/ngrokapi/services/reserved_addrs_client.rb +10 -4
- data/lib/ngrokapi/services/reserved_domains_client.rb +22 -8
- data/lib/ngrokapi/services/secrets_client.rb +16 -6
- data/lib/ngrokapi/services/service_users_client.rb +237 -0
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +12 -6
- data/lib/ngrokapi/services/ssh_credentials_client.rb +12 -6
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +2 -2
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +2 -2
- data/lib/ngrokapi/services/tls_certificates_client.rb +10 -4
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +10 -4
- data/lib/ngrokapi/services/vaults_client.rb +10 -4
- data/lib/ngrokapi/version.rb +1 -1
- data/spec/ngrokapi/client_spec.rb +6 -0
- data/spec/ngrokapi/models/reserved_domain_resolves_to_entry_spec.rb +23 -0
- data/spec/ngrokapi/models/service_user_spec.rb +44 -0
- data/spec/ngrokapi/services/credentials_client_spec.rb +4 -2
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +12 -4
- data/spec/ngrokapi/services/secrets_client_spec.rb +6 -2
- data/spec/ngrokapi/services/service_users_client_spec.rb +178 -0
- data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +4 -2
- data/spec/spec_helper.rb +26 -0
- metadata +14 -2
|
@@ -207,7 +207,7 @@
|
|
|
207
207
|
<li class="public ">
|
|
208
208
|
<span class="summary_signature">
|
|
209
209
|
|
|
210
|
-
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil) ⇒ NgrokAPI::Models::Credential </a>
|
|
210
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil, scim_user_id: "") ⇒ NgrokAPI::Models::Credential </a>
|
|
211
211
|
|
|
212
212
|
|
|
213
213
|
|
|
@@ -231,7 +231,7 @@
|
|
|
231
231
|
<li class="public ">
|
|
232
232
|
<span class="summary_signature">
|
|
233
233
|
|
|
234
|
-
<a href="#create!-instance_method" title="#create! (instance method)">#<strong>create!</strong>(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil) ⇒ NgrokAPI::Models::Credential </a>
|
|
234
|
+
<a href="#create!-instance_method" title="#create! (instance method)">#<strong>create!</strong>(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil, scim_user_id: "") ⇒ NgrokAPI::Models::Credential </a>
|
|
235
235
|
|
|
236
236
|
|
|
237
237
|
|
|
@@ -377,7 +377,7 @@
|
|
|
377
377
|
<li class="public ">
|
|
378
378
|
<span class="summary_signature">
|
|
379
379
|
|
|
380
|
-
<a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, 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
|
|
|
@@ -575,7 +575,7 @@
|
|
|
575
575
|
<div class="method_details first">
|
|
576
576
|
<h3 class="signature first" id="create-instance_method">
|
|
577
577
|
|
|
578
|
-
#<strong>create</strong>(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil) ⇒ <tt><span class='object_link'><a href="../Models/Credential.html" title="NgrokAPI::Models::Credential (class)">NgrokAPI::Models::Credential</a></span></tt>
|
|
578
|
+
#<strong>create</strong>(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil, scim_user_id: "") ⇒ <tt><span class='object_link'><a href="../Models/Credential.html" title="NgrokAPI::Models::Credential (class)">NgrokAPI::Models::Credential</a></span></tt>
|
|
579
579
|
|
|
580
580
|
|
|
581
581
|
|
|
@@ -662,7 +662,7 @@
|
|
|
662
662
|
|
|
663
663
|
—
|
|
664
664
|
<div class='inline'>
|
|
665
|
-
<p>If supplied at credential creation, ownership will be assigned to the specified User or
|
|
665
|
+
<p>If supplied at credential creation, ownership will be assigned to the specified User or Service User. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Service User. Accepts one of: User ID, User email, or SCIM User ID.</p>
|
|
666
666
|
</div>
|
|
667
667
|
|
|
668
668
|
</li>
|
|
@@ -710,7 +710,7 @@
|
|
|
710
710
|
<td>
|
|
711
711
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 39</span>
|
|
712
712
|
|
|
713
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>acl:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>owner_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>owner_email:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>precomputed_token:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
713
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>acl:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>owner_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>owner_email:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>precomputed_token:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>scim_user_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
714
714
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/credentials</span><span class='tstring_end'>'</span></span>
|
|
715
715
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
716
716
|
<span class='rbrace'>}</span>
|
|
@@ -730,7 +730,7 @@
|
|
|
730
730
|
<div class="method_details ">
|
|
731
731
|
<h3 class="signature " id="create!-instance_method">
|
|
732
732
|
|
|
733
|
-
#<strong>create!</strong>(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil) ⇒ <tt><span class='object_link'><a href="../Models/Credential.html" title="NgrokAPI::Models::Credential (class)">NgrokAPI::Models::Credential</a></span></tt>
|
|
733
|
+
#<strong>create!</strong>(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil, scim_user_id: "") ⇒ <tt><span class='object_link'><a href="../Models/Credential.html" title="NgrokAPI::Models::Credential (class)">NgrokAPI::Models::Credential</a></span></tt>
|
|
734
734
|
|
|
735
735
|
|
|
736
736
|
|
|
@@ -817,7 +817,7 @@
|
|
|
817
817
|
|
|
818
818
|
—
|
|
819
819
|
<div class='inline'>
|
|
820
|
-
<p>If supplied at credential creation, ownership will be assigned to the specified User or
|
|
820
|
+
<p>If supplied at credential creation, ownership will be assigned to the specified User or Service User. Only admins may specify an owner other than themselves. Defaults to the authenticated User or Service User. Accepts one of: User ID, User email, or SCIM User ID.</p>
|
|
821
821
|
</div>
|
|
822
822
|
|
|
823
823
|
</li>
|
|
@@ -865,7 +865,7 @@
|
|
|
865
865
|
<td>
|
|
866
866
|
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 66</span>
|
|
867
867
|
|
|
868
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>acl:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>owner_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>owner_email:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>precomputed_token:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
868
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>acl:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>owner_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>owner_email:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>precomputed_token:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>scim_user_id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
|
869
869
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/credentials</span><span class='tstring_end'>'</span></span>
|
|
870
870
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
871
871
|
<span class='rbrace'>}</span>
|
|
@@ -1257,7 +1257,7 @@
|
|
|
1257
1257
|
<div class="method_details ">
|
|
1258
1258
|
<h3 class="signature " id="list-instance_method">
|
|
1259
1259
|
|
|
1260
|
-
#<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>
|
|
1260
|
+
#<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>
|
|
1261
1261
|
|
|
1262
1262
|
|
|
1263
1263
|
|
|
@@ -1288,6 +1288,11 @@
|
|
|
1288
1288
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1289
1289
|
|
|
1290
1290
|
|
|
1291
|
+
—
|
|
1292
|
+
<div class='inline'>
|
|
1293
|
+
<p>Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.</p>
|
|
1294
|
+
</div>
|
|
1295
|
+
|
|
1291
1296
|
</li>
|
|
1292
1297
|
|
|
1293
1298
|
<li>
|
|
@@ -1301,6 +1306,29 @@
|
|
|
1301
1306
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1302
1307
|
|
|
1303
1308
|
|
|
1309
|
+
—
|
|
1310
|
+
<div class='inline'>
|
|
1311
|
+
<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>
|
|
1312
|
+
</div>
|
|
1313
|
+
|
|
1314
|
+
</li>
|
|
1315
|
+
|
|
1316
|
+
<li>
|
|
1317
|
+
|
|
1318
|
+
<span class='name'>filter</span>
|
|
1319
|
+
|
|
1320
|
+
|
|
1321
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1322
|
+
|
|
1323
|
+
|
|
1324
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1325
|
+
|
|
1326
|
+
|
|
1327
|
+
—
|
|
1328
|
+
<div class='inline'>
|
|
1329
|
+
<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>
|
|
1330
|
+
</div>
|
|
1331
|
+
|
|
1304
1332
|
</li>
|
|
1305
1333
|
|
|
1306
1334
|
<li>
|
|
@@ -1348,7 +1376,6 @@
|
|
|
1348
1376
|
<pre class="lines">
|
|
1349
1377
|
|
|
1350
1378
|
|
|
1351
|
-
154
|
|
1352
1379
|
155
|
|
1353
1380
|
156
|
|
1354
1381
|
157
|
|
@@ -1366,19 +1393,24 @@
|
|
|
1366
1393
|
169
|
|
1367
1394
|
170
|
|
1368
1395
|
171
|
|
1369
|
-
172
|
|
1396
|
+
172
|
|
1397
|
+
173
|
|
1398
|
+
174
|
|
1399
|
+
175</pre>
|
|
1370
1400
|
</td>
|
|
1371
1401
|
<td>
|
|
1372
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line
|
|
1402
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 155</span>
|
|
1373
1403
|
|
|
1374
1404
|
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
|
1375
1405
|
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1376
1406
|
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1407
|
+
<span class='label'>filter:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1377
1408
|
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1378
1409
|
<span class='rparen'>)</span>
|
|
1379
1410
|
<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>
|
|
1380
1411
|
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1381
1412
|
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1413
|
+
<span class='label'>filter:</span> <span class='id identifier rubyid_filter'>filter</span><span class='comma'>,</span>
|
|
1382
1414
|
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1383
1415
|
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::CredentialsClient::PATH (constant)">PATH</a></span></span>
|
|
1384
1416
|
<span class='rparen'>)</span>
|
|
@@ -1398,7 +1430,7 @@
|
|
|
1398
1430
|
<div class="method_details ">
|
|
1399
1431
|
<h3 class="signature " id="list!-instance_method">
|
|
1400
1432
|
|
|
1401
|
-
#<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>
|
|
1433
|
+
#<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>
|
|
1402
1434
|
|
|
1403
1435
|
|
|
1404
1436
|
|
|
@@ -1429,6 +1461,11 @@
|
|
|
1429
1461
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1430
1462
|
|
|
1431
1463
|
|
|
1464
|
+
—
|
|
1465
|
+
<div class='inline'>
|
|
1466
|
+
<p>Expects a resource ID as its input. Returns earlier entries in the result set, sorted by ID.</p>
|
|
1467
|
+
</div>
|
|
1468
|
+
|
|
1432
1469
|
</li>
|
|
1433
1470
|
|
|
1434
1471
|
<li>
|
|
@@ -1442,6 +1479,29 @@
|
|
|
1442
1479
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1443
1480
|
|
|
1444
1481
|
|
|
1482
|
+
—
|
|
1483
|
+
<div class='inline'>
|
|
1484
|
+
<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>
|
|
1485
|
+
</div>
|
|
1486
|
+
|
|
1487
|
+
</li>
|
|
1488
|
+
|
|
1489
|
+
<li>
|
|
1490
|
+
|
|
1491
|
+
<span class='name'>filter</span>
|
|
1492
|
+
|
|
1493
|
+
|
|
1494
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1495
|
+
|
|
1496
|
+
|
|
1497
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1498
|
+
|
|
1499
|
+
|
|
1500
|
+
—
|
|
1501
|
+
<div class='inline'>
|
|
1502
|
+
<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>
|
|
1503
|
+
</div>
|
|
1504
|
+
|
|
1445
1505
|
</li>
|
|
1446
1506
|
|
|
1447
1507
|
<li>
|
|
@@ -1489,10 +1549,6 @@
|
|
|
1489
1549
|
<pre class="lines">
|
|
1490
1550
|
|
|
1491
1551
|
|
|
1492
|
-
184
|
|
1493
|
-
185
|
|
1494
|
-
186
|
|
1495
|
-
187
|
|
1496
1552
|
188
|
|
1497
1553
|
189
|
|
1498
1554
|
190
|
|
@@ -1509,19 +1565,27 @@
|
|
|
1509
1565
|
201
|
|
1510
1566
|
202
|
|
1511
1567
|
203
|
|
1512
|
-
204
|
|
1568
|
+
204
|
|
1569
|
+
205
|
|
1570
|
+
206
|
|
1571
|
+
207
|
|
1572
|
+
208
|
|
1573
|
+
209
|
|
1574
|
+
210</pre>
|
|
1513
1575
|
</td>
|
|
1514
1576
|
<td>
|
|
1515
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line
|
|
1577
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 188</span>
|
|
1516
1578
|
|
|
1517
1579
|
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span>
|
|
1518
1580
|
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1519
1581
|
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1582
|
+
<span class='label'>filter:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
|
1520
1583
|
<span class='label'>url:</span> <span class='kw'>nil</span>
|
|
1521
1584
|
<span class='rparen'>)</span>
|
|
1522
1585
|
<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>
|
|
1523
1586
|
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1524
1587
|
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1588
|
+
<span class='label'>filter:</span> <span class='id identifier rubyid_filter'>filter</span><span class='comma'>,</span>
|
|
1525
1589
|
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
|
1526
1590
|
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1527
1591
|
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::CredentialsClient::PATH (constant)">PATH</a></span></span>
|
|
@@ -1657,21 +1721,21 @@
|
|
|
1657
1721
|
<pre class="lines">
|
|
1658
1722
|
|
|
1659
1723
|
|
|
1660
|
-
216
|
|
1661
|
-
217
|
|
1662
|
-
218
|
|
1663
|
-
219
|
|
1664
|
-
220
|
|
1665
|
-
221
|
|
1666
1724
|
222
|
|
1667
1725
|
223
|
|
1668
1726
|
224
|
|
1669
1727
|
225
|
|
1670
1728
|
226
|
|
1671
|
-
227
|
|
1729
|
+
227
|
|
1730
|
+
228
|
|
1731
|
+
229
|
|
1732
|
+
230
|
|
1733
|
+
231
|
|
1734
|
+
232
|
|
1735
|
+
233</pre>
|
|
1672
1736
|
</td>
|
|
1673
1737
|
<td>
|
|
1674
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line
|
|
1738
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 222</span>
|
|
1675
1739
|
|
|
1676
1740
|
<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'>acl:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1677
1741
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/credentials/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -1807,21 +1871,21 @@
|
|
|
1807
1871
|
<pre class="lines">
|
|
1808
1872
|
|
|
1809
1873
|
|
|
1810
|
-
240
|
|
1811
|
-
241
|
|
1812
|
-
242
|
|
1813
|
-
243
|
|
1814
|
-
244
|
|
1815
|
-
245
|
|
1816
1874
|
246
|
|
1817
1875
|
247
|
|
1818
1876
|
248
|
|
1819
1877
|
249
|
|
1820
1878
|
250
|
|
1821
|
-
251
|
|
1879
|
+
251
|
|
1880
|
+
252
|
|
1881
|
+
253
|
|
1882
|
+
254
|
|
1883
|
+
255
|
|
1884
|
+
256
|
|
1885
|
+
257</pre>
|
|
1822
1886
|
</td>
|
|
1823
1887
|
<td>
|
|
1824
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line
|
|
1888
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/credentials_client.rb', line 246</span>
|
|
1825
1889
|
|
|
1826
1890
|
<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'>acl:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1827
1891
|
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/credentials/%{id}</span><span class='tstring_end'>'</span></span>
|
|
@@ -1845,9 +1909,9 @@
|
|
|
1845
1909
|
</div>
|
|
1846
1910
|
|
|
1847
1911
|
<div id="footer">
|
|
1848
|
-
Generated on
|
|
1912
|
+
Generated on Fri Jan 23 21:38:04 2026 by
|
|
1849
1913
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1850
|
-
0.9.36 (ruby-3.3.
|
|
1914
|
+
0.9.36 (ruby-3.3.10).
|
|
1851
1915
|
</div>
|
|
1852
1916
|
|
|
1853
1917
|
</div>
|
|
@@ -1139,9 +1139,9 @@
|
|
|
1139
1139
|
</div>
|
|
1140
1140
|
|
|
1141
1141
|
<div id="footer">
|
|
1142
|
-
Generated on
|
|
1142
|
+
Generated on Fri Jan 23 21:38:10 2026 by
|
|
1143
1143
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1144
|
-
0.9.36 (ruby-3.3.
|
|
1144
|
+
0.9.36 (ruby-3.3.10).
|
|
1145
1145
|
</div>
|
|
1146
1146
|
|
|
1147
1147
|
</div>
|
|
@@ -1139,9 +1139,9 @@
|
|
|
1139
1139
|
</div>
|
|
1140
1140
|
|
|
1141
1141
|
<div id="footer">
|
|
1142
|
-
Generated on
|
|
1142
|
+
Generated on Fri Jan 23 21:38:11 2026 by
|
|
1143
1143
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1144
|
-
0.9.36 (ruby-3.3.
|
|
1144
|
+
0.9.36 (ruby-3.3.10).
|
|
1145
1145
|
</div>
|
|
1146
1146
|
|
|
1147
1147
|
</div>
|
|
@@ -1139,9 +1139,9 @@
|
|
|
1139
1139
|
</div>
|
|
1140
1140
|
|
|
1141
1141
|
<div id="footer">
|
|
1142
|
-
Generated on
|
|
1142
|
+
Generated on Fri Jan 23 21:38:10 2026 by
|
|
1143
1143
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1144
|
-
0.9.36 (ruby-3.3.
|
|
1144
|
+
0.9.36 (ruby-3.3.10).
|
|
1145
1145
|
</div>
|
|
1146
1146
|
|
|
1147
1147
|
</div>
|
|
@@ -1139,9 +1139,9 @@
|
|
|
1139
1139
|
</div>
|
|
1140
1140
|
|
|
1141
1141
|
<div id="footer">
|
|
1142
|
-
Generated on
|
|
1142
|
+
Generated on Fri Jan 23 21:38:10 2026 by
|
|
1143
1143
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1144
|
-
0.9.36 (ruby-3.3.
|
|
1144
|
+
0.9.36 (ruby-3.3.10).
|
|
1145
1145
|
</div>
|
|
1146
1146
|
|
|
1147
1147
|
</div>
|
|
@@ -1139,9 +1139,9 @@
|
|
|
1139
1139
|
</div>
|
|
1140
1140
|
|
|
1141
1141
|
<div id="footer">
|
|
1142
|
-
Generated on
|
|
1142
|
+
Generated on Fri Jan 23 21:38:10 2026 by
|
|
1143
1143
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1144
|
-
0.9.36 (ruby-3.3.
|
|
1144
|
+
0.9.36 (ruby-3.3.10).
|
|
1145
1145
|
</div>
|
|
1146
1146
|
|
|
1147
1147
|
</div>
|
|
@@ -1139,9 +1139,9 @@
|
|
|
1139
1139
|
</div>
|
|
1140
1140
|
|
|
1141
1141
|
<div id="footer">
|
|
1142
|
-
Generated on
|
|
1142
|
+
Generated on Fri Jan 23 21:38:09 2026 by
|
|
1143
1143
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1144
|
-
0.9.36 (ruby-3.3.
|
|
1144
|
+
0.9.36 (ruby-3.3.10).
|
|
1145
1145
|
</div>
|
|
1146
1146
|
|
|
1147
1147
|
</div>
|
|
@@ -1139,9 +1139,9 @@
|
|
|
1139
1139
|
</div>
|
|
1140
1140
|
|
|
1141
1141
|
<div id="footer">
|
|
1142
|
-
Generated on
|
|
1142
|
+
Generated on Fri Jan 23 21:38:11 2026 by
|
|
1143
1143
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1144
|
-
0.9.36 (ruby-3.3.
|
|
1144
|
+
0.9.36 (ruby-3.3.10).
|
|
1145
1145
|
</div>
|
|
1146
1146
|
|
|
1147
1147
|
</div>
|
|
@@ -1139,9 +1139,9 @@
|
|
|
1139
1139
|
</div>
|
|
1140
1140
|
|
|
1141
1141
|
<div id="footer">
|
|
1142
|
-
Generated on
|
|
1142
|
+
Generated on Fri Jan 23 21:38:11 2026 by
|
|
1143
1143
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1144
|
-
0.9.36 (ruby-3.3.
|
|
1144
|
+
0.9.36 (ruby-3.3.10).
|
|
1145
1145
|
</div>
|
|
1146
1146
|
|
|
1147
1147
|
</div>
|
|
@@ -1139,9 +1139,9 @@
|
|
|
1139
1139
|
</div>
|
|
1140
1140
|
|
|
1141
1141
|
<div id="footer">
|
|
1142
|
-
Generated on
|
|
1142
|
+
Generated on Fri Jan 23 21:38:09 2026 by
|
|
1143
1143
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1144
|
-
0.9.36 (ruby-3.3.
|
|
1144
|
+
0.9.36 (ruby-3.3.10).
|
|
1145
1145
|
</div>
|
|
1146
1146
|
|
|
1147
1147
|
</div>
|
|
@@ -1139,9 +1139,9 @@
|
|
|
1139
1139
|
</div>
|
|
1140
1140
|
|
|
1141
1141
|
<div id="footer">
|
|
1142
|
-
Generated on
|
|
1142
|
+
Generated on Fri Jan 23 21:38:11 2026 by
|
|
1143
1143
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1144
|
-
0.9.36 (ruby-3.3.
|
|
1144
|
+
0.9.36 (ruby-3.3.10).
|
|
1145
1145
|
</div>
|
|
1146
1146
|
|
|
1147
1147
|
</div>
|
|
@@ -1139,9 +1139,9 @@
|
|
|
1139
1139
|
</div>
|
|
1140
1140
|
|
|
1141
1141
|
<div id="footer">
|
|
1142
|
-
Generated on
|
|
1142
|
+
Generated on Fri Jan 23 21:38:11 2026 by
|
|
1143
1143
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1144
|
-
0.9.36 (ruby-3.3.
|
|
1144
|
+
0.9.36 (ruby-3.3.10).
|
|
1145
1145
|
</div>
|
|
1146
1146
|
|
|
1147
1147
|
</div>
|
|
@@ -1139,9 +1139,9 @@
|
|
|
1139
1139
|
</div>
|
|
1140
1140
|
|
|
1141
1141
|
<div id="footer">
|
|
1142
|
-
Generated on
|
|
1142
|
+
Generated on Fri Jan 23 21:38:11 2026 by
|
|
1143
1143
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1144
|
-
0.9.36 (ruby-3.3.
|
|
1144
|
+
0.9.36 (ruby-3.3.10).
|
|
1145
1145
|
</div>
|
|
1146
1146
|
|
|
1147
1147
|
</div>
|
|
@@ -1139,9 +1139,9 @@
|
|
|
1139
1139
|
</div>
|
|
1140
1140
|
|
|
1141
1141
|
<div id="footer">
|
|
1142
|
-
Generated on
|
|
1142
|
+
Generated on Fri Jan 23 21:38:11 2026 by
|
|
1143
1143
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1144
|
-
0.9.36 (ruby-3.3.
|
|
1144
|
+
0.9.36 (ruby-3.3.10).
|
|
1145
1145
|
</div>
|
|
1146
1146
|
|
|
1147
1147
|
</div>
|
|
@@ -1953,9 +1953,9 @@
|
|
|
1953
1953
|
</div>
|
|
1954
1954
|
|
|
1955
1955
|
<div id="footer">
|
|
1956
|
-
Generated on
|
|
1956
|
+
Generated on Fri Jan 23 21:38:05 2026 by
|
|
1957
1957
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1958
|
-
0.9.36 (ruby-3.3.
|
|
1958
|
+
0.9.36 (ruby-3.3.10).
|
|
1959
1959
|
</div>
|
|
1960
1960
|
|
|
1961
1961
|
</div>
|
|
@@ -2715,9 +2715,9 @@
|
|
|
2715
2715
|
</div>
|
|
2716
2716
|
|
|
2717
2717
|
<div id="footer">
|
|
2718
|
-
Generated on
|
|
2718
|
+
Generated on Fri Jan 23 21:38:08 2026 by
|
|
2719
2719
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
2720
|
-
0.9.36 (ruby-3.3.
|
|
2720
|
+
0.9.36 (ruby-3.3.10).
|
|
2721
2721
|
</div>
|
|
2722
2722
|
|
|
2723
2723
|
</div>
|
|
@@ -2033,9 +2033,9 @@
|
|
|
2033
2033
|
</div>
|
|
2034
2034
|
|
|
2035
2035
|
<div id="footer">
|
|
2036
|
-
Generated on
|
|
2036
|
+
Generated on Fri Jan 23 21:38:04 2026 by
|
|
2037
2037
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
2038
|
-
0.9.36 (ruby-3.3.
|
|
2038
|
+
0.9.36 (ruby-3.3.10).
|
|
2039
2039
|
</div>
|
|
2040
2040
|
|
|
2041
2041
|
</div>
|
|
@@ -2153,9 +2153,9 @@
|
|
|
2153
2153
|
</div>
|
|
2154
2154
|
|
|
2155
2155
|
<div id="footer">
|
|
2156
|
-
Generated on
|
|
2156
|
+
Generated on Fri Jan 23 21:38:04 2026 by
|
|
2157
2157
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
2158
|
-
0.9.36 (ruby-3.3.
|
|
2158
|
+
0.9.36 (ruby-3.3.10).
|
|
2159
2159
|
</div>
|
|
2160
2160
|
|
|
2161
2161
|
</div>
|