ngrok-api 0.24.0 → 0.26.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/.github/workflows/ci.yml +1 -1
- data/CHANGELOG.md +13 -0
- data/Gemfile.lock +9 -1
- data/doc/NgrokAPI/Client.html +223 -67
- 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 +48 -42
- 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 +2 -2
- 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/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 +1336 -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 +1353 -0
- 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 +47 -31
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +2 -2
- data/doc/NgrokAPI/Services/AgentIngressesClient.html +47 -31
- data/doc/NgrokAPI/Services/ApplicationSessionsClient.html +27 -11
- data/doc/NgrokAPI/Services/ApplicationUsersClient.html +27 -11
- data/doc/NgrokAPI/Services/BotUsersClient.html +47 -31
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +47 -31
- data/doc/NgrokAPI/Services/CredentialsClient.html +47 -31
- 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 +63 -47
- data/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgesTCPClient.html +63 -47
- data/doc/NgrokAPI/Services/EdgesTLSClient.html +63 -47
- data/doc/NgrokAPI/Services/EndpointsClient.html +258 -134
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +47 -31
- data/doc/NgrokAPI/Services/EventSourcesClient.html +2 -2
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +47 -31
- data/doc/NgrokAPI/Services/FailoverBackendsClient.html +47 -31
- data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +47 -31
- data/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +47 -31
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +47 -31
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +47 -31
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +47 -31
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +79 -63
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +47 -31
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +47 -31
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +47 -31
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +47 -31
- data/doc/NgrokAPI/Services/SecretsClient.html +1941 -0
- data/doc/NgrokAPI/Services/StaticBackendsClient.html +47 -31
- 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 +47 -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 +47 -31
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +95 -79
- data/doc/NgrokAPI/Services/TunnelsClient.html +47 -31
- data/doc/NgrokAPI/Services/VaultsClient.html +2219 -0
- data/doc/NgrokAPI/Services/WeightedBackendsClient.html +47 -31
- data/doc/NgrokAPI/Services.html +5 -5
- data/doc/NgrokAPI.html +3 -3
- data/doc/_index.html +38 -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 +751 -255
- data/doc/top-level-namespace.html +2 -2
- data/docs/NgrokAPI/Client.html +223 -67
- 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 +48 -42
- 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 +2 -2
- 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/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 +1336 -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 +1353 -0
- 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 +47 -31
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +2 -2
- data/docs/NgrokAPI/Services/AgentIngressesClient.html +47 -31
- data/docs/NgrokAPI/Services/ApplicationSessionsClient.html +27 -11
- data/docs/NgrokAPI/Services/ApplicationUsersClient.html +27 -11
- data/docs/NgrokAPI/Services/BotUsersClient.html +47 -31
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +47 -31
- data/docs/NgrokAPI/Services/CredentialsClient.html +47 -31
- 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 +63 -47
- data/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgesTCPClient.html +63 -47
- data/docs/NgrokAPI/Services/EdgesTLSClient.html +63 -47
- data/docs/NgrokAPI/Services/EndpointsClient.html +258 -134
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +47 -31
- data/docs/NgrokAPI/Services/EventSourcesClient.html +2 -2
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +47 -31
- data/docs/NgrokAPI/Services/FailoverBackendsClient.html +47 -31
- data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +47 -31
- data/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +47 -31
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +47 -31
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +47 -31
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +47 -31
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +79 -63
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +47 -31
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +47 -31
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +47 -31
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +47 -31
- data/docs/NgrokAPI/Services/SecretsClient.html +1941 -0
- data/docs/NgrokAPI/Services/StaticBackendsClient.html +47 -31
- 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 +47 -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 +47 -31
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +95 -79
- data/docs/NgrokAPI/Services/TunnelsClient.html +47 -31
- data/docs/NgrokAPI/Services/VaultsClient.html +2219 -0
- data/docs/NgrokAPI/Services/WeightedBackendsClient.html +47 -31
- data/docs/NgrokAPI/Services.html +5 -5
- data/docs/NgrokAPI.html +3 -3
- data/docs/_index.html +38 -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 +751 -255
- data/docs/top-level-namespace.html +2 -2
- data/lib/ngrokapi/client.rb +18 -0
- data/lib/ngrokapi/models/endpoint.rb +10 -7
- data/lib/ngrokapi/models/secret.rb +63 -0
- data/lib/ngrokapi/models/vault.rb +81 -0
- data/lib/ngrokapi/services/agent_ingresses_client.rb +10 -2
- data/lib/ngrokapi/services/api_keys_client.rb +10 -2
- data/lib/ngrokapi/services/application_sessions_client.rb +10 -2
- data/lib/ngrokapi/services/application_users_client.rb +10 -2
- data/lib/ngrokapi/services/bot_users_client.rb +10 -2
- data/lib/ngrokapi/services/certificate_authorities_client.rb +10 -2
- data/lib/ngrokapi/services/credentials_client.rb +10 -2
- data/lib/ngrokapi/services/edges_https_client.rb +10 -2
- data/lib/ngrokapi/services/edges_tcp_client.rb +10 -2
- data/lib/ngrokapi/services/edges_tls_client.rb +10 -2
- data/lib/ngrokapi/services/endpoints_client.rb +32 -8
- data/lib/ngrokapi/services/event_destinations_client.rb +10 -2
- data/lib/ngrokapi/services/event_subscriptions_client.rb +10 -2
- data/lib/ngrokapi/services/failover_backends_client.rb +10 -2
- data/lib/ngrokapi/services/http_response_backends_client.rb +10 -2
- data/lib/ngrokapi/services/ip_policies_client.rb +10 -2
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +10 -2
- data/lib/ngrokapi/services/ip_restrictions_client.rb +10 -2
- data/lib/ngrokapi/services/reserved_addrs_client.rb +10 -2
- data/lib/ngrokapi/services/reserved_domains_client.rb +10 -2
- data/lib/ngrokapi/services/secrets_client.rb +254 -0
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +10 -2
- data/lib/ngrokapi/services/ssh_credentials_client.rb +10 -2
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +10 -2
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +10 -2
- data/lib/ngrokapi/services/static_backends_client.rb +10 -2
- data/lib/ngrokapi/services/tls_certificates_client.rb +10 -2
- data/lib/ngrokapi/services/tunnel_group_backends_client.rb +10 -2
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +10 -2
- data/lib/ngrokapi/services/tunnels_client.rb +10 -2
- data/lib/ngrokapi/services/vaults_client.rb +317 -0
- data/lib/ngrokapi/services/weighted_backends_client.rb +10 -2
- data/lib/ngrokapi/version.rb +1 -1
- data/spec/ngrokapi/client_spec.rb +12 -0
- data/spec/ngrokapi/models/endpoint_spec.rb +4 -1
- data/spec/ngrokapi/models/secret_spec.rb +30 -0
- data/spec/ngrokapi/models/vault_spec.rb +47 -0
- data/spec/ngrokapi/services/endpoints_client_spec.rb +12 -4
- data/spec/ngrokapi/services/secrets_client_spec.rb +198 -0
- data/spec/ngrokapi/services/vaults_client_spec.rb +201 -0
- data/spec/spec_helper.rb +123 -0
- metadata +18 -5
@@ -0,0 +1,2219 @@
|
|
1
|
+
<!DOCTYPE html>
|
2
|
+
<html>
|
3
|
+
<head>
|
4
|
+
<meta charset="utf-8">
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
6
|
+
<title>
|
7
|
+
Class: NgrokAPI::Services::VaultsClient
|
8
|
+
|
9
|
+
— Documentation by YARD 0.9.36
|
10
|
+
|
11
|
+
</title>
|
12
|
+
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
|
14
|
+
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
16
|
+
|
17
|
+
<script type="text/javascript">
|
18
|
+
pathId = "NgrokAPI::Services::VaultsClient";
|
19
|
+
relpath = '../../';
|
20
|
+
</script>
|
21
|
+
|
22
|
+
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
24
|
+
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
26
|
+
|
27
|
+
|
28
|
+
</head>
|
29
|
+
<body>
|
30
|
+
<div class="nav_wrap">
|
31
|
+
<iframe id="nav" src="../../class_list.html?1"></iframe>
|
32
|
+
<div id="resizer"></div>
|
33
|
+
</div>
|
34
|
+
|
35
|
+
<div id="main" tabindex="-1">
|
36
|
+
<div id="header">
|
37
|
+
<div id="menu">
|
38
|
+
|
39
|
+
<a href="../../_index.html">Index (V)</a> »
|
40
|
+
<span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> » <span class='title'><span class='object_link'><a href="../Services.html" title="NgrokAPI::Services (module)">Services</a></span></span>
|
41
|
+
»
|
42
|
+
<span class="title">VaultsClient</span>
|
43
|
+
|
44
|
+
</div>
|
45
|
+
|
46
|
+
<div id="search">
|
47
|
+
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
49
|
+
href="../../class_list.html">
|
50
|
+
|
51
|
+
<svg width="24" height="24">
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
55
|
+
</svg>
|
56
|
+
</a>
|
57
|
+
|
58
|
+
</div>
|
59
|
+
<div class="clear"></div>
|
60
|
+
</div>
|
61
|
+
|
62
|
+
<div id="content"><h1>Class: NgrokAPI::Services::VaultsClient
|
63
|
+
|
64
|
+
|
65
|
+
|
66
|
+
</h1>
|
67
|
+
<div class="box_info">
|
68
|
+
|
69
|
+
<dl>
|
70
|
+
<dt>Inherits:</dt>
|
71
|
+
<dd>
|
72
|
+
<span class="inheritName">Object</span>
|
73
|
+
|
74
|
+
<ul class="fullTree">
|
75
|
+
<li>Object</li>
|
76
|
+
|
77
|
+
<li class="next">NgrokAPI::Services::VaultsClient</li>
|
78
|
+
|
79
|
+
</ul>
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
81
|
+
|
82
|
+
</dd>
|
83
|
+
</dl>
|
84
|
+
|
85
|
+
|
86
|
+
|
87
|
+
|
88
|
+
|
89
|
+
|
90
|
+
|
91
|
+
|
92
|
+
|
93
|
+
|
94
|
+
|
95
|
+
<dl>
|
96
|
+
<dt>Defined in:</dt>
|
97
|
+
<dd>lib/ngrokapi/services/vaults_client.rb</dd>
|
98
|
+
</dl>
|
99
|
+
|
100
|
+
</div>
|
101
|
+
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
103
|
+
<div class="discussion">
|
104
|
+
|
105
|
+
<p>Vaults is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.</p>
|
106
|
+
|
107
|
+
<p><a href="https://ngrok.com/docs/api#api-vaults">ngrok.com/docs/api#api-vaults</a></p>
|
108
|
+
|
109
|
+
|
110
|
+
</div>
|
111
|
+
</div>
|
112
|
+
<div class="tags">
|
113
|
+
|
114
|
+
|
115
|
+
</div>
|
116
|
+
|
117
|
+
<h2>
|
118
|
+
Constant Summary
|
119
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
120
|
+
</h2>
|
121
|
+
|
122
|
+
<dl class="constants">
|
123
|
+
|
124
|
+
<dt id="PATH-constant" class="">PATH =
|
125
|
+
<div class="docstring">
|
126
|
+
<div class="discussion">
|
127
|
+
|
128
|
+
<p>The API path for the requests</p>
|
129
|
+
|
130
|
+
|
131
|
+
</div>
|
132
|
+
</div>
|
133
|
+
<div class="tags">
|
134
|
+
|
135
|
+
|
136
|
+
</div>
|
137
|
+
</dt>
|
138
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/vaults</span><span class='tstring_end'>'</span></span></pre></dd>
|
139
|
+
|
140
|
+
<dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
|
141
|
+
<div class="docstring">
|
142
|
+
<div class="discussion">
|
143
|
+
|
144
|
+
<p>The List Property from the resulting API for list calls</p>
|
145
|
+
|
146
|
+
|
147
|
+
</div>
|
148
|
+
</div>
|
149
|
+
<div class="tags">
|
150
|
+
|
151
|
+
|
152
|
+
</div>
|
153
|
+
</dt>
|
154
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>vaults</span><span class='tstring_end'>'</span></span></pre></dd>
|
155
|
+
|
156
|
+
</dl>
|
157
|
+
|
158
|
+
|
159
|
+
|
160
|
+
|
161
|
+
|
162
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
163
|
+
<ul class="summary">
|
164
|
+
|
165
|
+
<li class="public ">
|
166
|
+
<span class="summary_signature">
|
167
|
+
|
168
|
+
<a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> ⇒ Object </a>
|
169
|
+
|
170
|
+
|
171
|
+
|
172
|
+
</span>
|
173
|
+
|
174
|
+
|
175
|
+
|
176
|
+
|
177
|
+
<span class="note title readonly">readonly</span>
|
178
|
+
|
179
|
+
|
180
|
+
|
181
|
+
|
182
|
+
|
183
|
+
|
184
|
+
|
185
|
+
|
186
|
+
|
187
|
+
<span class="summary_desc"><div class='inline'>
|
188
|
+
<p>Returns the value of attribute client.</p>
|
189
|
+
</div></span>
|
190
|
+
|
191
|
+
</li>
|
192
|
+
|
193
|
+
|
194
|
+
</ul>
|
195
|
+
|
196
|
+
|
197
|
+
|
198
|
+
|
199
|
+
|
200
|
+
<h2>
|
201
|
+
Instance Method Summary
|
202
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
203
|
+
</h2>
|
204
|
+
|
205
|
+
<ul class="summary">
|
206
|
+
|
207
|
+
<li class="public ">
|
208
|
+
<span class="summary_signature">
|
209
|
+
|
210
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(name: "", metadata: "", description: "") ⇒ NgrokAPI::Models::Vault </a>
|
211
|
+
|
212
|
+
|
213
|
+
|
214
|
+
</span>
|
215
|
+
|
216
|
+
|
217
|
+
|
218
|
+
|
219
|
+
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
|
224
|
+
<span class="summary_desc"><div class='inline'>
|
225
|
+
<p>Create a new Vault.</p>
|
226
|
+
</div></span>
|
227
|
+
|
228
|
+
</li>
|
229
|
+
|
230
|
+
|
231
|
+
<li class="public ">
|
232
|
+
<span class="summary_signature">
|
233
|
+
|
234
|
+
<a href="#create!-instance_method" title="#create! (instance method)">#<strong>create!</strong>(name: "", metadata: "", description: "") ⇒ NgrokAPI::Models::Vault </a>
|
235
|
+
|
236
|
+
|
237
|
+
|
238
|
+
</span>
|
239
|
+
|
240
|
+
|
241
|
+
|
242
|
+
|
243
|
+
|
244
|
+
|
245
|
+
|
246
|
+
|
247
|
+
|
248
|
+
<span class="summary_desc"><div class='inline'>
|
249
|
+
<p>Create a new Vault Throws an exception if API error.</p>
|
250
|
+
</div></span>
|
251
|
+
|
252
|
+
</li>
|
253
|
+
|
254
|
+
|
255
|
+
<li class="public ">
|
256
|
+
<span class="summary_signature">
|
257
|
+
|
258
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
</span>
|
263
|
+
|
264
|
+
|
265
|
+
|
266
|
+
|
267
|
+
|
268
|
+
|
269
|
+
|
270
|
+
|
271
|
+
|
272
|
+
<span class="summary_desc"><div class='inline'>
|
273
|
+
<p>Delete a Vault.</p>
|
274
|
+
</div></span>
|
275
|
+
|
276
|
+
</li>
|
277
|
+
|
278
|
+
|
279
|
+
<li class="public ">
|
280
|
+
<span class="summary_signature">
|
281
|
+
|
282
|
+
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
283
|
+
|
284
|
+
|
285
|
+
|
286
|
+
</span>
|
287
|
+
|
288
|
+
|
289
|
+
|
290
|
+
|
291
|
+
|
292
|
+
|
293
|
+
|
294
|
+
|
295
|
+
|
296
|
+
<span class="summary_desc"><div class='inline'>
|
297
|
+
<p>Delete a Vault Throws an exception if API error.</p>
|
298
|
+
</div></span>
|
299
|
+
|
300
|
+
</li>
|
301
|
+
|
302
|
+
|
303
|
+
<li class="public ">
|
304
|
+
<span class="summary_signature">
|
305
|
+
|
306
|
+
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: "") ⇒ NgrokAPI::Models::Vault </a>
|
307
|
+
|
308
|
+
|
309
|
+
|
310
|
+
</span>
|
311
|
+
|
312
|
+
|
313
|
+
|
314
|
+
|
315
|
+
|
316
|
+
|
317
|
+
|
318
|
+
|
319
|
+
|
320
|
+
<span class="summary_desc"><div class='inline'>
|
321
|
+
<p>Get a Vault by ID.</p>
|
322
|
+
</div></span>
|
323
|
+
|
324
|
+
</li>
|
325
|
+
|
326
|
+
|
327
|
+
<li class="public ">
|
328
|
+
<span class="summary_signature">
|
329
|
+
|
330
|
+
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: "") ⇒ NgrokAPI::Models::Vault </a>
|
331
|
+
|
332
|
+
|
333
|
+
|
334
|
+
</span>
|
335
|
+
|
336
|
+
|
337
|
+
|
338
|
+
|
339
|
+
|
340
|
+
|
341
|
+
|
342
|
+
|
343
|
+
|
344
|
+
<span class="summary_desc"><div class='inline'>
|
345
|
+
<p>Get a Vault by ID Throws an exception if API error.</p>
|
346
|
+
</div></span>
|
347
|
+
|
348
|
+
</li>
|
349
|
+
|
350
|
+
|
351
|
+
<li class="public ">
|
352
|
+
<span class="summary_signature">
|
353
|
+
|
354
|
+
<a href="#get_secrets_by_vault-instance_method" title="#get_secrets_by_vault (instance method)">#<strong>get_secrets_by_vault</strong>(id: "", before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
355
|
+
|
356
|
+
|
357
|
+
|
358
|
+
</span>
|
359
|
+
|
360
|
+
|
361
|
+
|
362
|
+
|
363
|
+
|
364
|
+
|
365
|
+
|
366
|
+
|
367
|
+
|
368
|
+
<span class="summary_desc"><div class='inline'>
|
369
|
+
<p>Get Secrets by Vault ID.</p>
|
370
|
+
</div></span>
|
371
|
+
|
372
|
+
</li>
|
373
|
+
|
374
|
+
|
375
|
+
<li class="public ">
|
376
|
+
<span class="summary_signature">
|
377
|
+
|
378
|
+
<a href="#get_secrets_by_vault!-instance_method" title="#get_secrets_by_vault! (instance method)">#<strong>get_secrets_by_vault!</strong>(id: "", before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
379
|
+
|
380
|
+
|
381
|
+
|
382
|
+
</span>
|
383
|
+
|
384
|
+
|
385
|
+
|
386
|
+
|
387
|
+
|
388
|
+
|
389
|
+
|
390
|
+
|
391
|
+
|
392
|
+
<span class="summary_desc"><div class='inline'>
|
393
|
+
<p>Get Secrets by Vault ID Throws an exception if API error.</p>
|
394
|
+
</div></span>
|
395
|
+
|
396
|
+
</li>
|
397
|
+
|
398
|
+
|
399
|
+
<li class="public ">
|
400
|
+
<span class="summary_signature">
|
401
|
+
|
402
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒ VaultsClient </a>
|
403
|
+
|
404
|
+
|
405
|
+
|
406
|
+
</span>
|
407
|
+
|
408
|
+
|
409
|
+
<span class="note title constructor">constructor</span>
|
410
|
+
|
411
|
+
|
412
|
+
|
413
|
+
|
414
|
+
|
415
|
+
|
416
|
+
|
417
|
+
|
418
|
+
<span class="summary_desc"><div class='inline'>
|
419
|
+
<p>A new instance of VaultsClient.</p>
|
420
|
+
</div></span>
|
421
|
+
|
422
|
+
</li>
|
423
|
+
|
424
|
+
|
425
|
+
<li class="public ">
|
426
|
+
<span class="summary_signature">
|
427
|
+
|
428
|
+
<a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
429
|
+
|
430
|
+
|
431
|
+
|
432
|
+
</span>
|
433
|
+
|
434
|
+
|
435
|
+
|
436
|
+
|
437
|
+
|
438
|
+
|
439
|
+
|
440
|
+
|
441
|
+
|
442
|
+
<span class="summary_desc"><div class='inline'>
|
443
|
+
<p>List all Vaults owned by account.</p>
|
444
|
+
</div></span>
|
445
|
+
|
446
|
+
</li>
|
447
|
+
|
448
|
+
|
449
|
+
<li class="public ">
|
450
|
+
<span class="summary_signature">
|
451
|
+
|
452
|
+
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
453
|
+
|
454
|
+
|
455
|
+
|
456
|
+
</span>
|
457
|
+
|
458
|
+
|
459
|
+
|
460
|
+
|
461
|
+
|
462
|
+
|
463
|
+
|
464
|
+
|
465
|
+
|
466
|
+
<span class="summary_desc"><div class='inline'>
|
467
|
+
<p>List all Vaults owned by account Throws an exception if API error.</p>
|
468
|
+
</div></span>
|
469
|
+
|
470
|
+
</li>
|
471
|
+
|
472
|
+
|
473
|
+
<li class="public ">
|
474
|
+
<span class="summary_signature">
|
475
|
+
|
476
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", name: nil, metadata: nil, description: nil) ⇒ NgrokAPI::Models::Vault </a>
|
477
|
+
|
478
|
+
|
479
|
+
|
480
|
+
</span>
|
481
|
+
|
482
|
+
|
483
|
+
|
484
|
+
|
485
|
+
|
486
|
+
|
487
|
+
|
488
|
+
|
489
|
+
|
490
|
+
<span class="summary_desc"><div class='inline'>
|
491
|
+
<p>Update an existing Vault by ID.</p>
|
492
|
+
</div></span>
|
493
|
+
|
494
|
+
</li>
|
495
|
+
|
496
|
+
|
497
|
+
<li class="public ">
|
498
|
+
<span class="summary_signature">
|
499
|
+
|
500
|
+
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: "", name: nil, metadata: nil, description: nil) ⇒ NgrokAPI::Models::Vault </a>
|
501
|
+
|
502
|
+
|
503
|
+
|
504
|
+
</span>
|
505
|
+
|
506
|
+
|
507
|
+
|
508
|
+
|
509
|
+
|
510
|
+
|
511
|
+
|
512
|
+
|
513
|
+
|
514
|
+
<span class="summary_desc"><div class='inline'>
|
515
|
+
<p>Update an existing Vault by ID Throws an exception if API error.</p>
|
516
|
+
</div></span>
|
517
|
+
|
518
|
+
</li>
|
519
|
+
|
520
|
+
|
521
|
+
</ul>
|
522
|
+
|
523
|
+
|
524
|
+
<div id="constructor_details" class="method_details_list">
|
525
|
+
<h2>Constructor Details</h2>
|
526
|
+
|
527
|
+
<div class="method_details first">
|
528
|
+
<h3 class="signature first" id="initialize-instance_method">
|
529
|
+
|
530
|
+
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::VaultsClient (class)">VaultsClient</a></span></tt>
|
531
|
+
|
532
|
+
|
533
|
+
|
534
|
+
|
535
|
+
|
536
|
+
</h3><div class="docstring">
|
537
|
+
<div class="discussion">
|
538
|
+
|
539
|
+
<p>Returns a new instance of VaultsClient.</p>
|
540
|
+
|
541
|
+
|
542
|
+
</div>
|
543
|
+
</div>
|
544
|
+
<div class="tags">
|
545
|
+
|
546
|
+
|
547
|
+
</div><table class="source_code">
|
548
|
+
<tr>
|
549
|
+
<td>
|
550
|
+
<pre class="lines">
|
551
|
+
|
552
|
+
|
553
|
+
20
|
554
|
+
21
|
555
|
+
22</pre>
|
556
|
+
</td>
|
557
|
+
<td>
|
558
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/vaults_client.rb', line 20</span>
|
559
|
+
|
560
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='rparen'>)</span>
|
561
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
562
|
+
<span class='kw'>end</span></pre>
|
563
|
+
</td>
|
564
|
+
</tr>
|
565
|
+
</table>
|
566
|
+
</div>
|
567
|
+
|
568
|
+
</div>
|
569
|
+
|
570
|
+
<div id="instance_attr_details" class="attr_details">
|
571
|
+
<h2>Instance Attribute Details</h2>
|
572
|
+
|
573
|
+
|
574
|
+
<span id=""></span>
|
575
|
+
<div class="method_details first">
|
576
|
+
<h3 class="signature first" id="client-instance_method">
|
577
|
+
|
578
|
+
#<strong>client</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
579
|
+
|
580
|
+
|
581
|
+
|
582
|
+
|
583
|
+
|
584
|
+
</h3><div class="docstring">
|
585
|
+
<div class="discussion">
|
586
|
+
|
587
|
+
<p>Returns the value of attribute client.</p>
|
588
|
+
|
589
|
+
|
590
|
+
</div>
|
591
|
+
</div>
|
592
|
+
<div class="tags">
|
593
|
+
|
594
|
+
|
595
|
+
</div><table class="source_code">
|
596
|
+
<tr>
|
597
|
+
<td>
|
598
|
+
<pre class="lines">
|
599
|
+
|
600
|
+
|
601
|
+
18
|
602
|
+
19
|
603
|
+
20</pre>
|
604
|
+
</td>
|
605
|
+
<td>
|
606
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/vaults_client.rb', line 18</span>
|
607
|
+
|
608
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
609
|
+
<span class='ivar'>@client</span>
|
610
|
+
<span class='kw'>end</span></pre>
|
611
|
+
</td>
|
612
|
+
</tr>
|
613
|
+
</table>
|
614
|
+
</div>
|
615
|
+
|
616
|
+
</div>
|
617
|
+
|
618
|
+
|
619
|
+
<div id="instance_method_details" class="method_details_list">
|
620
|
+
<h2>Instance Method Details</h2>
|
621
|
+
|
622
|
+
|
623
|
+
<div class="method_details first">
|
624
|
+
<h3 class="signature first" id="create-instance_method">
|
625
|
+
|
626
|
+
#<strong>create</strong>(name: "", metadata: "", description: "") ⇒ <tt><span class='object_link'><a href="../Models/Vault.html" title="NgrokAPI::Models::Vault (class)">NgrokAPI::Models::Vault</a></span></tt>
|
627
|
+
|
628
|
+
|
629
|
+
|
630
|
+
|
631
|
+
|
632
|
+
</h3><div class="docstring">
|
633
|
+
<div class="discussion">
|
634
|
+
|
635
|
+
<p>Create a new Vault</p>
|
636
|
+
|
637
|
+
<p><a href="https://ngrok.com/docs/api#api-vaults-create">ngrok.com/docs/api#api-vaults-create</a></p>
|
638
|
+
|
639
|
+
|
640
|
+
</div>
|
641
|
+
</div>
|
642
|
+
<div class="tags">
|
643
|
+
<p class="tag_title">Parameters:</p>
|
644
|
+
<ul class="param">
|
645
|
+
|
646
|
+
<li>
|
647
|
+
|
648
|
+
<span class='name'>name</span>
|
649
|
+
|
650
|
+
|
651
|
+
<span class='type'>(<tt>string</tt>)</span>
|
652
|
+
|
653
|
+
|
654
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
655
|
+
|
656
|
+
|
657
|
+
—
|
658
|
+
<div class='inline'>
|
659
|
+
<p>Name of vault</p>
|
660
|
+
</div>
|
661
|
+
|
662
|
+
</li>
|
663
|
+
|
664
|
+
<li>
|
665
|
+
|
666
|
+
<span class='name'>metadata</span>
|
667
|
+
|
668
|
+
|
669
|
+
<span class='type'>(<tt>string</tt>)</span>
|
670
|
+
|
671
|
+
|
672
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
673
|
+
|
674
|
+
|
675
|
+
—
|
676
|
+
<div class='inline'>
|
677
|
+
<p>Arbitrary user-defined metadata for this Vault</p>
|
678
|
+
</div>
|
679
|
+
|
680
|
+
</li>
|
681
|
+
|
682
|
+
<li>
|
683
|
+
|
684
|
+
<span class='name'>description</span>
|
685
|
+
|
686
|
+
|
687
|
+
<span class='type'>(<tt>string</tt>)</span>
|
688
|
+
|
689
|
+
|
690
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
691
|
+
|
692
|
+
|
693
|
+
—
|
694
|
+
<div class='inline'>
|
695
|
+
<p>description of Vault</p>
|
696
|
+
</div>
|
697
|
+
|
698
|
+
</li>
|
699
|
+
|
700
|
+
</ul>
|
701
|
+
|
702
|
+
<p class="tag_title">Returns:</p>
|
703
|
+
<ul class="return">
|
704
|
+
|
705
|
+
<li>
|
706
|
+
|
707
|
+
|
708
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Vault.html" title="NgrokAPI::Models::Vault (class)">NgrokAPI::Models::Vault</a></span></tt>)</span>
|
709
|
+
|
710
|
+
|
711
|
+
|
712
|
+
—
|
713
|
+
<div class='inline'>
|
714
|
+
<p>result from the API request</p>
|
715
|
+
</div>
|
716
|
+
|
717
|
+
</li>
|
718
|
+
|
719
|
+
</ul>
|
720
|
+
|
721
|
+
</div><table class="source_code">
|
722
|
+
<tr>
|
723
|
+
<td>
|
724
|
+
<pre class="lines">
|
725
|
+
|
726
|
+
|
727
|
+
33
|
728
|
+
34
|
729
|
+
35
|
730
|
+
36
|
731
|
+
37
|
732
|
+
38
|
733
|
+
39
|
734
|
+
40
|
735
|
+
41
|
736
|
+
42
|
737
|
+
43</pre>
|
738
|
+
</td>
|
739
|
+
<td>
|
740
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/vaults_client.rb', line 33</span>
|
741
|
+
|
742
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>name:</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'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
743
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/vaults</span><span class='tstring_end'>'</span></span>
|
744
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
745
|
+
<span class='rbrace'>}</span>
|
746
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
747
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>if</span> <span class='id identifier rubyid_name'>name</span>
|
748
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
749
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
750
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
751
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Vault.html" title="NgrokAPI::Models::Vault (class)">Vault</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Vault.html#initialize-instance_method" title="NgrokAPI::Models::Vault#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
752
|
+
<span class='kw'>end</span></pre>
|
753
|
+
</td>
|
754
|
+
</tr>
|
755
|
+
</table>
|
756
|
+
</div>
|
757
|
+
|
758
|
+
<div class="method_details ">
|
759
|
+
<h3 class="signature " id="create!-instance_method">
|
760
|
+
|
761
|
+
#<strong>create!</strong>(name: "", metadata: "", description: "") ⇒ <tt><span class='object_link'><a href="../Models/Vault.html" title="NgrokAPI::Models::Vault (class)">NgrokAPI::Models::Vault</a></span></tt>
|
762
|
+
|
763
|
+
|
764
|
+
|
765
|
+
|
766
|
+
|
767
|
+
</h3><div class="docstring">
|
768
|
+
<div class="discussion">
|
769
|
+
|
770
|
+
<p>Create a new Vault Throws an exception if API error.</p>
|
771
|
+
|
772
|
+
<p><a href="https://ngrok.com/docs/api#api-vaults-create">ngrok.com/docs/api#api-vaults-create</a></p>
|
773
|
+
|
774
|
+
|
775
|
+
</div>
|
776
|
+
</div>
|
777
|
+
<div class="tags">
|
778
|
+
<p class="tag_title">Parameters:</p>
|
779
|
+
<ul class="param">
|
780
|
+
|
781
|
+
<li>
|
782
|
+
|
783
|
+
<span class='name'>name</span>
|
784
|
+
|
785
|
+
|
786
|
+
<span class='type'>(<tt>string</tt>)</span>
|
787
|
+
|
788
|
+
|
789
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
790
|
+
|
791
|
+
|
792
|
+
—
|
793
|
+
<div class='inline'>
|
794
|
+
<p>Name of vault</p>
|
795
|
+
</div>
|
796
|
+
|
797
|
+
</li>
|
798
|
+
|
799
|
+
<li>
|
800
|
+
|
801
|
+
<span class='name'>metadata</span>
|
802
|
+
|
803
|
+
|
804
|
+
<span class='type'>(<tt>string</tt>)</span>
|
805
|
+
|
806
|
+
|
807
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
808
|
+
|
809
|
+
|
810
|
+
—
|
811
|
+
<div class='inline'>
|
812
|
+
<p>Arbitrary user-defined metadata for this Vault</p>
|
813
|
+
</div>
|
814
|
+
|
815
|
+
</li>
|
816
|
+
|
817
|
+
<li>
|
818
|
+
|
819
|
+
<span class='name'>description</span>
|
820
|
+
|
821
|
+
|
822
|
+
<span class='type'>(<tt>string</tt>)</span>
|
823
|
+
|
824
|
+
|
825
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
826
|
+
|
827
|
+
|
828
|
+
—
|
829
|
+
<div class='inline'>
|
830
|
+
<p>description of Vault</p>
|
831
|
+
</div>
|
832
|
+
|
833
|
+
</li>
|
834
|
+
|
835
|
+
</ul>
|
836
|
+
|
837
|
+
<p class="tag_title">Returns:</p>
|
838
|
+
<ul class="return">
|
839
|
+
|
840
|
+
<li>
|
841
|
+
|
842
|
+
|
843
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Vault.html" title="NgrokAPI::Models::Vault (class)">NgrokAPI::Models::Vault</a></span></tt>)</span>
|
844
|
+
|
845
|
+
|
846
|
+
|
847
|
+
—
|
848
|
+
<div class='inline'>
|
849
|
+
<p>result from the API request</p>
|
850
|
+
</div>
|
851
|
+
|
852
|
+
</li>
|
853
|
+
|
854
|
+
</ul>
|
855
|
+
|
856
|
+
</div><table class="source_code">
|
857
|
+
<tr>
|
858
|
+
<td>
|
859
|
+
<pre class="lines">
|
860
|
+
|
861
|
+
|
862
|
+
55
|
863
|
+
56
|
864
|
+
57
|
865
|
+
58
|
866
|
+
59
|
867
|
+
60
|
868
|
+
61
|
869
|
+
62
|
870
|
+
63
|
871
|
+
64
|
872
|
+
65</pre>
|
873
|
+
</td>
|
874
|
+
<td>
|
875
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/vaults_client.rb', line 55</span>
|
876
|
+
|
877
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span><span class='label'>name:</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'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
878
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/vaults</span><span class='tstring_end'>'</span></span>
|
879
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
880
|
+
<span class='rbrace'>}</span>
|
881
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
882
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>if</span> <span class='id identifier rubyid_name'>name</span>
|
883
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
884
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
885
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
886
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Vault.html" title="NgrokAPI::Models::Vault (class)">Vault</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Vault.html#initialize-instance_method" title="NgrokAPI::Models::Vault#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
887
|
+
<span class='kw'>end</span></pre>
|
888
|
+
</td>
|
889
|
+
</tr>
|
890
|
+
</table>
|
891
|
+
</div>
|
892
|
+
|
893
|
+
<div class="method_details ">
|
894
|
+
<h3 class="signature " id="delete-instance_method">
|
895
|
+
|
896
|
+
#<strong>delete</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
897
|
+
|
898
|
+
|
899
|
+
|
900
|
+
|
901
|
+
|
902
|
+
</h3><div class="docstring">
|
903
|
+
<div class="discussion">
|
904
|
+
|
905
|
+
<p>Delete a Vault</p>
|
906
|
+
|
907
|
+
<p><a href="https://ngrok.com/docs/api#api-vaults-delete">ngrok.com/docs/api#api-vaults-delete</a></p>
|
908
|
+
|
909
|
+
|
910
|
+
</div>
|
911
|
+
</div>
|
912
|
+
<div class="tags">
|
913
|
+
<p class="tag_title">Parameters:</p>
|
914
|
+
<ul class="param">
|
915
|
+
|
916
|
+
<li>
|
917
|
+
|
918
|
+
<span class='name'>id</span>
|
919
|
+
|
920
|
+
|
921
|
+
<span class='type'>(<tt>string</tt>)</span>
|
922
|
+
|
923
|
+
|
924
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
925
|
+
|
926
|
+
|
927
|
+
—
|
928
|
+
<div class='inline'>
|
929
|
+
<p>a resource identifier</p>
|
930
|
+
</div>
|
931
|
+
|
932
|
+
</li>
|
933
|
+
|
934
|
+
</ul>
|
935
|
+
|
936
|
+
<p class="tag_title">Returns:</p>
|
937
|
+
<ul class="return">
|
938
|
+
|
939
|
+
<li>
|
940
|
+
|
941
|
+
|
942
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
943
|
+
|
944
|
+
|
945
|
+
|
946
|
+
—
|
947
|
+
<div class='inline'>
|
948
|
+
<p>result from the API request</p>
|
949
|
+
</div>
|
950
|
+
|
951
|
+
</li>
|
952
|
+
|
953
|
+
</ul>
|
954
|
+
|
955
|
+
</div><table class="source_code">
|
956
|
+
<tr>
|
957
|
+
<td>
|
958
|
+
<pre class="lines">
|
959
|
+
|
960
|
+
|
961
|
+
121
|
962
|
+
122
|
963
|
+
123
|
964
|
+
124
|
965
|
+
125
|
966
|
+
126
|
967
|
+
127</pre>
|
968
|
+
</td>
|
969
|
+
<td>
|
970
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/vaults_client.rb', line 121</span>
|
971
|
+
|
972
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
973
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/vaults/%{id}</span><span class='tstring_end'>'</span></span>
|
974
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
975
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
976
|
+
<span class='rbrace'>}</span>
|
977
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='rparen'>)</span>
|
978
|
+
<span class='kw'>end</span></pre>
|
979
|
+
</td>
|
980
|
+
</tr>
|
981
|
+
</table>
|
982
|
+
</div>
|
983
|
+
|
984
|
+
<div class="method_details ">
|
985
|
+
<h3 class="signature " id="delete!-instance_method">
|
986
|
+
|
987
|
+
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
988
|
+
|
989
|
+
|
990
|
+
|
991
|
+
|
992
|
+
|
993
|
+
</h3><div class="docstring">
|
994
|
+
<div class="discussion">
|
995
|
+
|
996
|
+
<p>Delete a Vault Throws an exception if API error.</p>
|
997
|
+
|
998
|
+
<p><a href="https://ngrok.com/docs/api#api-vaults-delete">ngrok.com/docs/api#api-vaults-delete</a></p>
|
999
|
+
|
1000
|
+
|
1001
|
+
</div>
|
1002
|
+
</div>
|
1003
|
+
<div class="tags">
|
1004
|
+
<p class="tag_title">Parameters:</p>
|
1005
|
+
<ul class="param">
|
1006
|
+
|
1007
|
+
<li>
|
1008
|
+
|
1009
|
+
<span class='name'>id</span>
|
1010
|
+
|
1011
|
+
|
1012
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1013
|
+
|
1014
|
+
|
1015
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1016
|
+
|
1017
|
+
|
1018
|
+
—
|
1019
|
+
<div class='inline'>
|
1020
|
+
<p>a resource identifier</p>
|
1021
|
+
</div>
|
1022
|
+
|
1023
|
+
</li>
|
1024
|
+
|
1025
|
+
</ul>
|
1026
|
+
|
1027
|
+
<p class="tag_title">Returns:</p>
|
1028
|
+
<ul class="return">
|
1029
|
+
|
1030
|
+
<li>
|
1031
|
+
|
1032
|
+
|
1033
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
1034
|
+
|
1035
|
+
|
1036
|
+
|
1037
|
+
—
|
1038
|
+
<div class='inline'>
|
1039
|
+
<p>result from the API request</p>
|
1040
|
+
</div>
|
1041
|
+
|
1042
|
+
</li>
|
1043
|
+
|
1044
|
+
</ul>
|
1045
|
+
|
1046
|
+
</div><table class="source_code">
|
1047
|
+
<tr>
|
1048
|
+
<td>
|
1049
|
+
<pre class="lines">
|
1050
|
+
|
1051
|
+
|
1052
|
+
137
|
1053
|
+
138
|
1054
|
+
139
|
1055
|
+
140
|
1056
|
+
141
|
1057
|
+
142
|
1058
|
+
143</pre>
|
1059
|
+
</td>
|
1060
|
+
<td>
|
1061
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/vaults_client.rb', line 137</span>
|
1062
|
+
|
1063
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
1064
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/vaults/%{id}</span><span class='tstring_end'>'</span></span>
|
1065
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1066
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1067
|
+
<span class='rbrace'>}</span>
|
1068
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
1069
|
+
<span class='kw'>end</span></pre>
|
1070
|
+
</td>
|
1071
|
+
</tr>
|
1072
|
+
</table>
|
1073
|
+
</div>
|
1074
|
+
|
1075
|
+
<div class="method_details ">
|
1076
|
+
<h3 class="signature " id="get-instance_method">
|
1077
|
+
|
1078
|
+
#<strong>get</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/Vault.html" title="NgrokAPI::Models::Vault (class)">NgrokAPI::Models::Vault</a></span></tt>
|
1079
|
+
|
1080
|
+
|
1081
|
+
|
1082
|
+
|
1083
|
+
|
1084
|
+
</h3><div class="docstring">
|
1085
|
+
<div class="discussion">
|
1086
|
+
|
1087
|
+
<p>Get a Vault by ID</p>
|
1088
|
+
|
1089
|
+
<p><a href="https://ngrok.com/docs/api#api-vaults-get">ngrok.com/docs/api#api-vaults-get</a></p>
|
1090
|
+
|
1091
|
+
|
1092
|
+
</div>
|
1093
|
+
</div>
|
1094
|
+
<div class="tags">
|
1095
|
+
<p class="tag_title">Parameters:</p>
|
1096
|
+
<ul class="param">
|
1097
|
+
|
1098
|
+
<li>
|
1099
|
+
|
1100
|
+
<span class='name'>id</span>
|
1101
|
+
|
1102
|
+
|
1103
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1104
|
+
|
1105
|
+
|
1106
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1107
|
+
|
1108
|
+
|
1109
|
+
—
|
1110
|
+
<div class='inline'>
|
1111
|
+
<p>a resource identifier</p>
|
1112
|
+
</div>
|
1113
|
+
|
1114
|
+
</li>
|
1115
|
+
|
1116
|
+
</ul>
|
1117
|
+
|
1118
|
+
<p class="tag_title">Returns:</p>
|
1119
|
+
<ul class="return">
|
1120
|
+
|
1121
|
+
<li>
|
1122
|
+
|
1123
|
+
|
1124
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Vault.html" title="NgrokAPI::Models::Vault (class)">NgrokAPI::Models::Vault</a></span></tt>)</span>
|
1125
|
+
|
1126
|
+
|
1127
|
+
|
1128
|
+
—
|
1129
|
+
<div class='inline'>
|
1130
|
+
<p>result from the API request</p>
|
1131
|
+
</div>
|
1132
|
+
|
1133
|
+
</li>
|
1134
|
+
|
1135
|
+
</ul>
|
1136
|
+
|
1137
|
+
</div><table class="source_code">
|
1138
|
+
<tr>
|
1139
|
+
<td>
|
1140
|
+
<pre class="lines">
|
1141
|
+
|
1142
|
+
|
1143
|
+
152
|
1144
|
+
153
|
1145
|
+
154
|
1146
|
+
155
|
1147
|
+
156
|
1148
|
+
157
|
1149
|
+
158
|
1150
|
+
159
|
1151
|
+
160</pre>
|
1152
|
+
</td>
|
1153
|
+
<td>
|
1154
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/vaults_client.rb', line 152</span>
|
1155
|
+
|
1156
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
1157
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/vaults/%{id}</span><span class='tstring_end'>'</span></span>
|
1158
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1159
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1160
|
+
<span class='rbrace'>}</span>
|
1161
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
1162
|
+
<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_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
1163
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Vault.html" title="NgrokAPI::Models::Vault (class)">Vault</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Vault.html#initialize-instance_method" title="NgrokAPI::Models::Vault#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
1164
|
+
<span class='kw'>end</span></pre>
|
1165
|
+
</td>
|
1166
|
+
</tr>
|
1167
|
+
</table>
|
1168
|
+
</div>
|
1169
|
+
|
1170
|
+
<div class="method_details ">
|
1171
|
+
<h3 class="signature " id="get!-instance_method">
|
1172
|
+
|
1173
|
+
#<strong>get!</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/Vault.html" title="NgrokAPI::Models::Vault (class)">NgrokAPI::Models::Vault</a></span></tt>
|
1174
|
+
|
1175
|
+
|
1176
|
+
|
1177
|
+
|
1178
|
+
|
1179
|
+
</h3><div class="docstring">
|
1180
|
+
<div class="discussion">
|
1181
|
+
|
1182
|
+
<p>Get a Vault by ID Throws an exception if API error.</p>
|
1183
|
+
|
1184
|
+
<p><a href="https://ngrok.com/docs/api#api-vaults-get">ngrok.com/docs/api#api-vaults-get</a></p>
|
1185
|
+
|
1186
|
+
|
1187
|
+
</div>
|
1188
|
+
</div>
|
1189
|
+
<div class="tags">
|
1190
|
+
<p class="tag_title">Parameters:</p>
|
1191
|
+
<ul class="param">
|
1192
|
+
|
1193
|
+
<li>
|
1194
|
+
|
1195
|
+
<span class='name'>id</span>
|
1196
|
+
|
1197
|
+
|
1198
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1199
|
+
|
1200
|
+
|
1201
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1202
|
+
|
1203
|
+
|
1204
|
+
—
|
1205
|
+
<div class='inline'>
|
1206
|
+
<p>a resource identifier</p>
|
1207
|
+
</div>
|
1208
|
+
|
1209
|
+
</li>
|
1210
|
+
|
1211
|
+
</ul>
|
1212
|
+
|
1213
|
+
<p class="tag_title">Returns:</p>
|
1214
|
+
<ul class="return">
|
1215
|
+
|
1216
|
+
<li>
|
1217
|
+
|
1218
|
+
|
1219
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Vault.html" title="NgrokAPI::Models::Vault (class)">NgrokAPI::Models::Vault</a></span></tt>)</span>
|
1220
|
+
|
1221
|
+
|
1222
|
+
|
1223
|
+
—
|
1224
|
+
<div class='inline'>
|
1225
|
+
<p>result from the API request</p>
|
1226
|
+
</div>
|
1227
|
+
|
1228
|
+
</li>
|
1229
|
+
|
1230
|
+
</ul>
|
1231
|
+
|
1232
|
+
</div><table class="source_code">
|
1233
|
+
<tr>
|
1234
|
+
<td>
|
1235
|
+
<pre class="lines">
|
1236
|
+
|
1237
|
+
|
1238
|
+
170
|
1239
|
+
171
|
1240
|
+
172
|
1241
|
+
173
|
1242
|
+
174
|
1243
|
+
175
|
1244
|
+
176
|
1245
|
+
177
|
1246
|
+
178</pre>
|
1247
|
+
</td>
|
1248
|
+
<td>
|
1249
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/vaults_client.rb', line 170</span>
|
1250
|
+
|
1251
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
1252
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/vaults/%{id}</span><span class='tstring_end'>'</span></span>
|
1253
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1254
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1255
|
+
<span class='rbrace'>}</span>
|
1256
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
1257
|
+
<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_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
1258
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Vault.html" title="NgrokAPI::Models::Vault (class)">Vault</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Vault.html#initialize-instance_method" title="NgrokAPI::Models::Vault#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
1259
|
+
<span class='kw'>end</span></pre>
|
1260
|
+
</td>
|
1261
|
+
</tr>
|
1262
|
+
</table>
|
1263
|
+
</div>
|
1264
|
+
|
1265
|
+
<div class="method_details ">
|
1266
|
+
<h3 class="signature " id="get_secrets_by_vault-instance_method">
|
1267
|
+
|
1268
|
+
#<strong>get_secrets_by_vault</strong>(id: "", 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>
|
1269
|
+
|
1270
|
+
|
1271
|
+
|
1272
|
+
|
1273
|
+
|
1274
|
+
</h3><div class="docstring">
|
1275
|
+
<div class="discussion">
|
1276
|
+
|
1277
|
+
<p>Get Secrets by Vault ID</p>
|
1278
|
+
|
1279
|
+
<p><a href="https://ngrok.com/docs/api#api-vaults-get-secrets-by-vault">ngrok.com/docs/api#api-vaults-get-secrets-by-vault</a></p>
|
1280
|
+
|
1281
|
+
|
1282
|
+
</div>
|
1283
|
+
</div>
|
1284
|
+
<div class="tags">
|
1285
|
+
<p class="tag_title">Parameters:</p>
|
1286
|
+
<ul class="param">
|
1287
|
+
|
1288
|
+
<li>
|
1289
|
+
|
1290
|
+
<span class='name'>id</span>
|
1291
|
+
|
1292
|
+
|
1293
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1294
|
+
|
1295
|
+
|
1296
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1297
|
+
|
1298
|
+
|
1299
|
+
—
|
1300
|
+
<div class='inline'>
|
1301
|
+
<p>a resource identifier</p>
|
1302
|
+
</div>
|
1303
|
+
|
1304
|
+
</li>
|
1305
|
+
|
1306
|
+
<li>
|
1307
|
+
|
1308
|
+
<span class='name'>before_id</span>
|
1309
|
+
|
1310
|
+
|
1311
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1312
|
+
|
1313
|
+
|
1314
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1315
|
+
|
1316
|
+
|
1317
|
+
</li>
|
1318
|
+
|
1319
|
+
<li>
|
1320
|
+
|
1321
|
+
<span class='name'>limit</span>
|
1322
|
+
|
1323
|
+
|
1324
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1325
|
+
|
1326
|
+
|
1327
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1328
|
+
|
1329
|
+
|
1330
|
+
</li>
|
1331
|
+
|
1332
|
+
<li>
|
1333
|
+
|
1334
|
+
<span class='name'>url</span>
|
1335
|
+
|
1336
|
+
|
1337
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1338
|
+
|
1339
|
+
|
1340
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1341
|
+
|
1342
|
+
|
1343
|
+
—
|
1344
|
+
<div class='inline'>
|
1345
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
1346
|
+
</div>
|
1347
|
+
|
1348
|
+
</li>
|
1349
|
+
|
1350
|
+
</ul>
|
1351
|
+
|
1352
|
+
<p class="tag_title">Returns:</p>
|
1353
|
+
<ul class="return">
|
1354
|
+
|
1355
|
+
<li>
|
1356
|
+
|
1357
|
+
|
1358
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
|
1359
|
+
|
1360
|
+
|
1361
|
+
|
1362
|
+
—
|
1363
|
+
<div class='inline'>
|
1364
|
+
<p>result from the API request</p>
|
1365
|
+
</div>
|
1366
|
+
|
1367
|
+
</li>
|
1368
|
+
|
1369
|
+
</ul>
|
1370
|
+
|
1371
|
+
</div><table class="source_code">
|
1372
|
+
<tr>
|
1373
|
+
<td>
|
1374
|
+
<pre class="lines">
|
1375
|
+
|
1376
|
+
|
1377
|
+
190
|
1378
|
+
191
|
1379
|
+
192
|
1380
|
+
193
|
1381
|
+
194
|
1382
|
+
195
|
1383
|
+
196
|
1384
|
+
197
|
1385
|
+
198
|
1386
|
+
199
|
1387
|
+
200
|
1388
|
+
201
|
1389
|
+
202
|
1390
|
+
203
|
1391
|
+
204
|
1392
|
+
205
|
1393
|
+
206
|
1394
|
+
207
|
1395
|
+
208
|
1396
|
+
209
|
1397
|
+
210
|
1398
|
+
211
|
1399
|
+
212
|
1400
|
+
213
|
1401
|
+
214</pre>
|
1402
|
+
</td>
|
1403
|
+
<td>
|
1404
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/vaults_client.rb', line 190</span>
|
1405
|
+
|
1406
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_secrets_by_vault'>get_secrets_by_vault</span><span class='lparen'>(</span>
|
1407
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
1408
|
+
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
1409
|
+
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
1410
|
+
<span class='label'>url:</span> <span class='kw'>nil</span>
|
1411
|
+
<span class='rparen'>)</span>
|
1412
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/vaults/%{id}/secrets</span><span class='tstring_end'>'</span></span>
|
1413
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1414
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1415
|
+
<span class='rbrace'>}</span>
|
1416
|
+
<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>
|
1417
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1418
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
1419
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
1420
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
1421
|
+
<span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span>
|
1422
|
+
<span class='rparen'>)</span>
|
1423
|
+
|
1424
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
|
1425
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
1426
|
+
<span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
1427
|
+
<span class='label'>list_property:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>secrets</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
1428
|
+
<span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Secret.html" title="NgrokAPI::Models::Secret (class)">Secret</a></span></span>
|
1429
|
+
<span class='rparen'>)</span>
|
1430
|
+
<span class='kw'>end</span></pre>
|
1431
|
+
</td>
|
1432
|
+
</tr>
|
1433
|
+
</table>
|
1434
|
+
</div>
|
1435
|
+
|
1436
|
+
<div class="method_details ">
|
1437
|
+
<h3 class="signature " id="get_secrets_by_vault!-instance_method">
|
1438
|
+
|
1439
|
+
#<strong>get_secrets_by_vault!</strong>(id: "", 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>
|
1440
|
+
|
1441
|
+
|
1442
|
+
|
1443
|
+
|
1444
|
+
|
1445
|
+
</h3><div class="docstring">
|
1446
|
+
<div class="discussion">
|
1447
|
+
|
1448
|
+
<p>Get Secrets by Vault ID Throws an exception if API error.</p>
|
1449
|
+
|
1450
|
+
<p><a href="https://ngrok.com/docs/api#api-vaults-get-secrets-by-vault">ngrok.com/docs/api#api-vaults-get-secrets-by-vault</a></p>
|
1451
|
+
|
1452
|
+
|
1453
|
+
</div>
|
1454
|
+
</div>
|
1455
|
+
<div class="tags">
|
1456
|
+
<p class="tag_title">Parameters:</p>
|
1457
|
+
<ul class="param">
|
1458
|
+
|
1459
|
+
<li>
|
1460
|
+
|
1461
|
+
<span class='name'>id</span>
|
1462
|
+
|
1463
|
+
|
1464
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1465
|
+
|
1466
|
+
|
1467
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1468
|
+
|
1469
|
+
|
1470
|
+
—
|
1471
|
+
<div class='inline'>
|
1472
|
+
<p>a resource identifier</p>
|
1473
|
+
</div>
|
1474
|
+
|
1475
|
+
</li>
|
1476
|
+
|
1477
|
+
<li>
|
1478
|
+
|
1479
|
+
<span class='name'>before_id</span>
|
1480
|
+
|
1481
|
+
|
1482
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1483
|
+
|
1484
|
+
|
1485
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1486
|
+
|
1487
|
+
|
1488
|
+
</li>
|
1489
|
+
|
1490
|
+
<li>
|
1491
|
+
|
1492
|
+
<span class='name'>limit</span>
|
1493
|
+
|
1494
|
+
|
1495
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1496
|
+
|
1497
|
+
|
1498
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1499
|
+
|
1500
|
+
|
1501
|
+
</li>
|
1502
|
+
|
1503
|
+
<li>
|
1504
|
+
|
1505
|
+
<span class='name'>url</span>
|
1506
|
+
|
1507
|
+
|
1508
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1509
|
+
|
1510
|
+
|
1511
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1512
|
+
|
1513
|
+
|
1514
|
+
—
|
1515
|
+
<div class='inline'>
|
1516
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
1517
|
+
</div>
|
1518
|
+
|
1519
|
+
</li>
|
1520
|
+
|
1521
|
+
</ul>
|
1522
|
+
|
1523
|
+
<p class="tag_title">Returns:</p>
|
1524
|
+
<ul class="return">
|
1525
|
+
|
1526
|
+
<li>
|
1527
|
+
|
1528
|
+
|
1529
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
|
1530
|
+
|
1531
|
+
|
1532
|
+
|
1533
|
+
—
|
1534
|
+
<div class='inline'>
|
1535
|
+
<p>result from the API request</p>
|
1536
|
+
</div>
|
1537
|
+
|
1538
|
+
</li>
|
1539
|
+
|
1540
|
+
</ul>
|
1541
|
+
|
1542
|
+
</div><table class="source_code">
|
1543
|
+
<tr>
|
1544
|
+
<td>
|
1545
|
+
<pre class="lines">
|
1546
|
+
|
1547
|
+
|
1548
|
+
227
|
1549
|
+
228
|
1550
|
+
229
|
1551
|
+
230
|
1552
|
+
231
|
1553
|
+
232
|
1554
|
+
233
|
1555
|
+
234
|
1556
|
+
235
|
1557
|
+
236
|
1558
|
+
237
|
1559
|
+
238
|
1560
|
+
239
|
1561
|
+
240
|
1562
|
+
241
|
1563
|
+
242
|
1564
|
+
243
|
1565
|
+
244
|
1566
|
+
245
|
1567
|
+
246
|
1568
|
+
247
|
1569
|
+
248
|
1570
|
+
249
|
1571
|
+
250
|
1572
|
+
251
|
1573
|
+
252
|
1574
|
+
253</pre>
|
1575
|
+
</td>
|
1576
|
+
<td>
|
1577
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/vaults_client.rb', line 227</span>
|
1578
|
+
|
1579
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get_secrets_by_vault!'>get_secrets_by_vault!</span><span class='lparen'>(</span>
|
1580
|
+
<span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span>
|
1581
|
+
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
1582
|
+
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
1583
|
+
<span class='label'>url:</span> <span class='kw'>nil</span>
|
1584
|
+
<span class='rparen'>)</span>
|
1585
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/vaults/%{id}/secrets</span><span class='tstring_end'>'</span></span>
|
1586
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1587
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1588
|
+
<span class='rbrace'>}</span>
|
1589
|
+
<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>
|
1590
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1591
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
1592
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
1593
|
+
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
1594
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
1595
|
+
<span class='label'>path:</span> <span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span>
|
1596
|
+
<span class='rparen'>)</span>
|
1597
|
+
|
1598
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
|
1599
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
1600
|
+
<span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
1601
|
+
<span class='label'>list_property:</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>secrets</span><span class='tstring_end'>'</span></span><span class='comma'>,</span>
|
1602
|
+
<span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Secret.html" title="NgrokAPI::Models::Secret (class)">Secret</a></span></span><span class='comma'>,</span>
|
1603
|
+
<span class='label'>danger:</span> <span class='kw'>true</span>
|
1604
|
+
<span class='rparen'>)</span>
|
1605
|
+
<span class='kw'>end</span></pre>
|
1606
|
+
</td>
|
1607
|
+
</tr>
|
1608
|
+
</table>
|
1609
|
+
</div>
|
1610
|
+
|
1611
|
+
<div class="method_details ">
|
1612
|
+
<h3 class="signature " id="list-instance_method">
|
1613
|
+
|
1614
|
+
#<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>
|
1615
|
+
|
1616
|
+
|
1617
|
+
|
1618
|
+
|
1619
|
+
|
1620
|
+
</h3><div class="docstring">
|
1621
|
+
<div class="discussion">
|
1622
|
+
|
1623
|
+
<p>List all Vaults owned by account</p>
|
1624
|
+
|
1625
|
+
<p><a href="https://ngrok.com/docs/api#api-vaults-list">ngrok.com/docs/api#api-vaults-list</a></p>
|
1626
|
+
|
1627
|
+
|
1628
|
+
</div>
|
1629
|
+
</div>
|
1630
|
+
<div class="tags">
|
1631
|
+
<p class="tag_title">Parameters:</p>
|
1632
|
+
<ul class="param">
|
1633
|
+
|
1634
|
+
<li>
|
1635
|
+
|
1636
|
+
<span class='name'>before_id</span>
|
1637
|
+
|
1638
|
+
|
1639
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1640
|
+
|
1641
|
+
|
1642
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1643
|
+
|
1644
|
+
|
1645
|
+
</li>
|
1646
|
+
|
1647
|
+
<li>
|
1648
|
+
|
1649
|
+
<span class='name'>limit</span>
|
1650
|
+
|
1651
|
+
|
1652
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1653
|
+
|
1654
|
+
|
1655
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1656
|
+
|
1657
|
+
|
1658
|
+
</li>
|
1659
|
+
|
1660
|
+
<li>
|
1661
|
+
|
1662
|
+
<span class='name'>url</span>
|
1663
|
+
|
1664
|
+
|
1665
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1666
|
+
|
1667
|
+
|
1668
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1669
|
+
|
1670
|
+
|
1671
|
+
—
|
1672
|
+
<div class='inline'>
|
1673
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
1674
|
+
</div>
|
1675
|
+
|
1676
|
+
</li>
|
1677
|
+
|
1678
|
+
</ul>
|
1679
|
+
|
1680
|
+
<p class="tag_title">Returns:</p>
|
1681
|
+
<ul class="return">
|
1682
|
+
|
1683
|
+
<li>
|
1684
|
+
|
1685
|
+
|
1686
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
|
1687
|
+
|
1688
|
+
|
1689
|
+
|
1690
|
+
—
|
1691
|
+
<div class='inline'>
|
1692
|
+
<p>result from the API request</p>
|
1693
|
+
</div>
|
1694
|
+
|
1695
|
+
</li>
|
1696
|
+
|
1697
|
+
</ul>
|
1698
|
+
|
1699
|
+
</div><table class="source_code">
|
1700
|
+
<tr>
|
1701
|
+
<td>
|
1702
|
+
<pre class="lines">
|
1703
|
+
|
1704
|
+
|
1705
|
+
264
|
1706
|
+
265
|
1707
|
+
266
|
1708
|
+
267
|
1709
|
+
268
|
1710
|
+
269
|
1711
|
+
270
|
1712
|
+
271
|
1713
|
+
272
|
1714
|
+
273
|
1715
|
+
274
|
1716
|
+
275
|
1717
|
+
276
|
1718
|
+
277
|
1719
|
+
278
|
1720
|
+
279
|
1721
|
+
280
|
1722
|
+
281
|
1723
|
+
282</pre>
|
1724
|
+
</td>
|
1725
|
+
<td>
|
1726
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/vaults_client.rb', line 264</span>
|
1727
|
+
|
1728
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
1729
|
+
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
1730
|
+
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
1731
|
+
<span class='label'>url:</span> <span class='kw'>nil</span>
|
1732
|
+
<span class='rparen'>)</span>
|
1733
|
+
<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>
|
1734
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
1735
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
1736
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
1737
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::VaultsClient::PATH (constant)">PATH</a></span></span>
|
1738
|
+
<span class='rparen'>)</span>
|
1739
|
+
|
1740
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
|
1741
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
1742
|
+
<span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
1743
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::VaultsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
1744
|
+
<span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Vault.html" title="NgrokAPI::Models::Vault (class)">Vault</a></span></span>
|
1745
|
+
<span class='rparen'>)</span>
|
1746
|
+
<span class='kw'>end</span></pre>
|
1747
|
+
</td>
|
1748
|
+
</tr>
|
1749
|
+
</table>
|
1750
|
+
</div>
|
1751
|
+
|
1752
|
+
<div class="method_details ">
|
1753
|
+
<h3 class="signature " id="list!-instance_method">
|
1754
|
+
|
1755
|
+
#<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>
|
1756
|
+
|
1757
|
+
|
1758
|
+
|
1759
|
+
|
1760
|
+
|
1761
|
+
</h3><div class="docstring">
|
1762
|
+
<div class="discussion">
|
1763
|
+
|
1764
|
+
<p>List all Vaults owned by account Throws an exception if API error.</p>
|
1765
|
+
|
1766
|
+
<p><a href="https://ngrok.com/docs/api#api-vaults-list">ngrok.com/docs/api#api-vaults-list</a></p>
|
1767
|
+
|
1768
|
+
|
1769
|
+
</div>
|
1770
|
+
</div>
|
1771
|
+
<div class="tags">
|
1772
|
+
<p class="tag_title">Parameters:</p>
|
1773
|
+
<ul class="param">
|
1774
|
+
|
1775
|
+
<li>
|
1776
|
+
|
1777
|
+
<span class='name'>before_id</span>
|
1778
|
+
|
1779
|
+
|
1780
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1781
|
+
|
1782
|
+
|
1783
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1784
|
+
|
1785
|
+
|
1786
|
+
</li>
|
1787
|
+
|
1788
|
+
<li>
|
1789
|
+
|
1790
|
+
<span class='name'>limit</span>
|
1791
|
+
|
1792
|
+
|
1793
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1794
|
+
|
1795
|
+
|
1796
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1797
|
+
|
1798
|
+
|
1799
|
+
</li>
|
1800
|
+
|
1801
|
+
<li>
|
1802
|
+
|
1803
|
+
<span class='name'>url</span>
|
1804
|
+
|
1805
|
+
|
1806
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1807
|
+
|
1808
|
+
|
1809
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1810
|
+
|
1811
|
+
|
1812
|
+
—
|
1813
|
+
<div class='inline'>
|
1814
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
1815
|
+
</div>
|
1816
|
+
|
1817
|
+
</li>
|
1818
|
+
|
1819
|
+
</ul>
|
1820
|
+
|
1821
|
+
<p class="tag_title">Returns:</p>
|
1822
|
+
<ul class="return">
|
1823
|
+
|
1824
|
+
<li>
|
1825
|
+
|
1826
|
+
|
1827
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
|
1828
|
+
|
1829
|
+
|
1830
|
+
|
1831
|
+
—
|
1832
|
+
<div class='inline'>
|
1833
|
+
<p>result from the API request</p>
|
1834
|
+
</div>
|
1835
|
+
|
1836
|
+
</li>
|
1837
|
+
|
1838
|
+
</ul>
|
1839
|
+
|
1840
|
+
</div><table class="source_code">
|
1841
|
+
<tr>
|
1842
|
+
<td>
|
1843
|
+
<pre class="lines">
|
1844
|
+
|
1845
|
+
|
1846
|
+
294
|
1847
|
+
295
|
1848
|
+
296
|
1849
|
+
297
|
1850
|
+
298
|
1851
|
+
299
|
1852
|
+
300
|
1853
|
+
301
|
1854
|
+
302
|
1855
|
+
303
|
1856
|
+
304
|
1857
|
+
305
|
1858
|
+
306
|
1859
|
+
307
|
1860
|
+
308
|
1861
|
+
309
|
1862
|
+
310
|
1863
|
+
311
|
1864
|
+
312
|
1865
|
+
313
|
1866
|
+
314</pre>
|
1867
|
+
</td>
|
1868
|
+
<td>
|
1869
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/vaults_client.rb', line 294</span>
|
1870
|
+
|
1871
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span>
|
1872
|
+
<span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
1873
|
+
<span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span>
|
1874
|
+
<span class='label'>url:</span> <span class='kw'>nil</span>
|
1875
|
+
<span class='rparen'>)</span>
|
1876
|
+
<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>
|
1877
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
1878
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
1879
|
+
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
1880
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
1881
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::VaultsClient::PATH (constant)">PATH</a></span></span>
|
1882
|
+
<span class='rparen'>)</span>
|
1883
|
+
|
1884
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
|
1885
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
1886
|
+
<span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
1887
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::VaultsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
1888
|
+
<span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Vault.html" title="NgrokAPI::Models::Vault (class)">Vault</a></span></span><span class='comma'>,</span>
|
1889
|
+
<span class='label'>danger:</span> <span class='kw'>true</span>
|
1890
|
+
<span class='rparen'>)</span>
|
1891
|
+
<span class='kw'>end</span></pre>
|
1892
|
+
</td>
|
1893
|
+
</tr>
|
1894
|
+
</table>
|
1895
|
+
</div>
|
1896
|
+
|
1897
|
+
<div class="method_details ">
|
1898
|
+
<h3 class="signature " id="update-instance_method">
|
1899
|
+
|
1900
|
+
#<strong>update</strong>(id: "", name: nil, metadata: nil, description: nil) ⇒ <tt><span class='object_link'><a href="../Models/Vault.html" title="NgrokAPI::Models::Vault (class)">NgrokAPI::Models::Vault</a></span></tt>
|
1901
|
+
|
1902
|
+
|
1903
|
+
|
1904
|
+
|
1905
|
+
|
1906
|
+
</h3><div class="docstring">
|
1907
|
+
<div class="discussion">
|
1908
|
+
|
1909
|
+
<p>Update an existing Vault by ID</p>
|
1910
|
+
|
1911
|
+
<p><a href="https://ngrok.com/docs/api#api-vaults-update">ngrok.com/docs/api#api-vaults-update</a></p>
|
1912
|
+
|
1913
|
+
|
1914
|
+
</div>
|
1915
|
+
</div>
|
1916
|
+
<div class="tags">
|
1917
|
+
<p class="tag_title">Parameters:</p>
|
1918
|
+
<ul class="param">
|
1919
|
+
|
1920
|
+
<li>
|
1921
|
+
|
1922
|
+
<span class='name'>id</span>
|
1923
|
+
|
1924
|
+
|
1925
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1926
|
+
|
1927
|
+
|
1928
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1929
|
+
|
1930
|
+
|
1931
|
+
—
|
1932
|
+
<div class='inline'>
|
1933
|
+
<p>identifier for Vault</p>
|
1934
|
+
</div>
|
1935
|
+
|
1936
|
+
</li>
|
1937
|
+
|
1938
|
+
<li>
|
1939
|
+
|
1940
|
+
<span class='name'>name</span>
|
1941
|
+
|
1942
|
+
|
1943
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1944
|
+
|
1945
|
+
|
1946
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1947
|
+
|
1948
|
+
|
1949
|
+
—
|
1950
|
+
<div class='inline'>
|
1951
|
+
<p>Name of vault</p>
|
1952
|
+
</div>
|
1953
|
+
|
1954
|
+
</li>
|
1955
|
+
|
1956
|
+
<li>
|
1957
|
+
|
1958
|
+
<span class='name'>metadata</span>
|
1959
|
+
|
1960
|
+
|
1961
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1962
|
+
|
1963
|
+
|
1964
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1965
|
+
|
1966
|
+
|
1967
|
+
—
|
1968
|
+
<div class='inline'>
|
1969
|
+
<p>Arbitrary user-defined metadata for this Vault</p>
|
1970
|
+
</div>
|
1971
|
+
|
1972
|
+
</li>
|
1973
|
+
|
1974
|
+
<li>
|
1975
|
+
|
1976
|
+
<span class='name'>description</span>
|
1977
|
+
|
1978
|
+
|
1979
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1980
|
+
|
1981
|
+
|
1982
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1983
|
+
|
1984
|
+
|
1985
|
+
—
|
1986
|
+
<div class='inline'>
|
1987
|
+
<p>description of Vault</p>
|
1988
|
+
</div>
|
1989
|
+
|
1990
|
+
</li>
|
1991
|
+
|
1992
|
+
</ul>
|
1993
|
+
|
1994
|
+
<p class="tag_title">Returns:</p>
|
1995
|
+
<ul class="return">
|
1996
|
+
|
1997
|
+
<li>
|
1998
|
+
|
1999
|
+
|
2000
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Vault.html" title="NgrokAPI::Models::Vault (class)">NgrokAPI::Models::Vault</a></span></tt>)</span>
|
2001
|
+
|
2002
|
+
|
2003
|
+
|
2004
|
+
—
|
2005
|
+
<div class='inline'>
|
2006
|
+
<p>result from the API request</p>
|
2007
|
+
</div>
|
2008
|
+
|
2009
|
+
</li>
|
2010
|
+
|
2011
|
+
</ul>
|
2012
|
+
|
2013
|
+
</div><table class="source_code">
|
2014
|
+
<tr>
|
2015
|
+
<td>
|
2016
|
+
<pre class="lines">
|
2017
|
+
|
2018
|
+
|
2019
|
+
77
|
2020
|
+
78
|
2021
|
+
79
|
2022
|
+
80
|
2023
|
+
81
|
2024
|
+
82
|
2025
|
+
83
|
2026
|
+
84
|
2027
|
+
85
|
2028
|
+
86
|
2029
|
+
87
|
2030
|
+
88</pre>
|
2031
|
+
</td>
|
2032
|
+
<td>
|
2033
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/vaults_client.rb', line 77</span>
|
2034
|
+
|
2035
|
+
<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'>name:</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'>description:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
2036
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/vaults/%{id}</span><span class='tstring_end'>'</span></span>
|
2037
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
2038
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
2039
|
+
<span class='rbrace'>}</span>
|
2040
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
2041
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>if</span> <span class='id identifier rubyid_name'>name</span>
|
2042
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
2043
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
2044
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
2045
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Vault.html" title="NgrokAPI::Models::Vault (class)">Vault</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Vault.html#initialize-instance_method" title="NgrokAPI::Models::Vault#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
2046
|
+
<span class='kw'>end</span></pre>
|
2047
|
+
</td>
|
2048
|
+
</tr>
|
2049
|
+
</table>
|
2050
|
+
</div>
|
2051
|
+
|
2052
|
+
<div class="method_details ">
|
2053
|
+
<h3 class="signature " id="update!-instance_method">
|
2054
|
+
|
2055
|
+
#<strong>update!</strong>(id: "", name: nil, metadata: nil, description: nil) ⇒ <tt><span class='object_link'><a href="../Models/Vault.html" title="NgrokAPI::Models::Vault (class)">NgrokAPI::Models::Vault</a></span></tt>
|
2056
|
+
|
2057
|
+
|
2058
|
+
|
2059
|
+
|
2060
|
+
|
2061
|
+
</h3><div class="docstring">
|
2062
|
+
<div class="discussion">
|
2063
|
+
|
2064
|
+
<p>Update an existing Vault by ID Throws an exception if API error.</p>
|
2065
|
+
|
2066
|
+
<p><a href="https://ngrok.com/docs/api#api-vaults-update">ngrok.com/docs/api#api-vaults-update</a></p>
|
2067
|
+
|
2068
|
+
|
2069
|
+
</div>
|
2070
|
+
</div>
|
2071
|
+
<div class="tags">
|
2072
|
+
<p class="tag_title">Parameters:</p>
|
2073
|
+
<ul class="param">
|
2074
|
+
|
2075
|
+
<li>
|
2076
|
+
|
2077
|
+
<span class='name'>id</span>
|
2078
|
+
|
2079
|
+
|
2080
|
+
<span class='type'>(<tt>string</tt>)</span>
|
2081
|
+
|
2082
|
+
|
2083
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
2084
|
+
|
2085
|
+
|
2086
|
+
—
|
2087
|
+
<div class='inline'>
|
2088
|
+
<p>identifier for Vault</p>
|
2089
|
+
</div>
|
2090
|
+
|
2091
|
+
</li>
|
2092
|
+
|
2093
|
+
<li>
|
2094
|
+
|
2095
|
+
<span class='name'>name</span>
|
2096
|
+
|
2097
|
+
|
2098
|
+
<span class='type'>(<tt>string</tt>)</span>
|
2099
|
+
|
2100
|
+
|
2101
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
2102
|
+
|
2103
|
+
|
2104
|
+
—
|
2105
|
+
<div class='inline'>
|
2106
|
+
<p>Name of vault</p>
|
2107
|
+
</div>
|
2108
|
+
|
2109
|
+
</li>
|
2110
|
+
|
2111
|
+
<li>
|
2112
|
+
|
2113
|
+
<span class='name'>metadata</span>
|
2114
|
+
|
2115
|
+
|
2116
|
+
<span class='type'>(<tt>string</tt>)</span>
|
2117
|
+
|
2118
|
+
|
2119
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
2120
|
+
|
2121
|
+
|
2122
|
+
—
|
2123
|
+
<div class='inline'>
|
2124
|
+
<p>Arbitrary user-defined metadata for this Vault</p>
|
2125
|
+
</div>
|
2126
|
+
|
2127
|
+
</li>
|
2128
|
+
|
2129
|
+
<li>
|
2130
|
+
|
2131
|
+
<span class='name'>description</span>
|
2132
|
+
|
2133
|
+
|
2134
|
+
<span class='type'>(<tt>string</tt>)</span>
|
2135
|
+
|
2136
|
+
|
2137
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
2138
|
+
|
2139
|
+
|
2140
|
+
—
|
2141
|
+
<div class='inline'>
|
2142
|
+
<p>description of Vault</p>
|
2143
|
+
</div>
|
2144
|
+
|
2145
|
+
</li>
|
2146
|
+
|
2147
|
+
</ul>
|
2148
|
+
|
2149
|
+
<p class="tag_title">Returns:</p>
|
2150
|
+
<ul class="return">
|
2151
|
+
|
2152
|
+
<li>
|
2153
|
+
|
2154
|
+
|
2155
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Vault.html" title="NgrokAPI::Models::Vault (class)">NgrokAPI::Models::Vault</a></span></tt>)</span>
|
2156
|
+
|
2157
|
+
|
2158
|
+
|
2159
|
+
—
|
2160
|
+
<div class='inline'>
|
2161
|
+
<p>result from the API request</p>
|
2162
|
+
</div>
|
2163
|
+
|
2164
|
+
</li>
|
2165
|
+
|
2166
|
+
</ul>
|
2167
|
+
|
2168
|
+
</div><table class="source_code">
|
2169
|
+
<tr>
|
2170
|
+
<td>
|
2171
|
+
<pre class="lines">
|
2172
|
+
|
2173
|
+
|
2174
|
+
101
|
2175
|
+
102
|
2176
|
+
103
|
2177
|
+
104
|
2178
|
+
105
|
2179
|
+
106
|
2180
|
+
107
|
2181
|
+
108
|
2182
|
+
109
|
2183
|
+
110
|
2184
|
+
111
|
2185
|
+
112</pre>
|
2186
|
+
</td>
|
2187
|
+
<td>
|
2188
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/vaults_client.rb', line 101</span>
|
2189
|
+
|
2190
|
+
<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'>name:</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'>description:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
2191
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/vaults/%{id}</span><span class='tstring_end'>'</span></span>
|
2192
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
2193
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
2194
|
+
<span class='rbrace'>}</span>
|
2195
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
2196
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:name</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_name'>name</span> <span class='kw'>if</span> <span class='id identifier rubyid_name'>name</span>
|
2197
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
2198
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
2199
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
2200
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Vault.html" title="NgrokAPI::Models::Vault (class)">Vault</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Vault.html#initialize-instance_method" title="NgrokAPI::Models::Vault#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
2201
|
+
<span class='kw'>end</span></pre>
|
2202
|
+
</td>
|
2203
|
+
</tr>
|
2204
|
+
</table>
|
2205
|
+
</div>
|
2206
|
+
|
2207
|
+
</div>
|
2208
|
+
|
2209
|
+
</div>
|
2210
|
+
|
2211
|
+
<div id="footer">
|
2212
|
+
Generated on Tue Aug 19 22:49:34 2025 by
|
2213
|
+
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
2214
|
+
0.9.36 (ruby-3.3.8).
|
2215
|
+
</div>
|
2216
|
+
|
2217
|
+
</div>
|
2218
|
+
</body>
|
2219
|
+
</html>
|