From d510c798f4dc911e314d1f6e0ece6f6fd8bc386a Mon Sep 17 00:00:00 2001 From: ngrok release bot Date: Thu, 14 Aug 2025 22:44:27 +0000 Subject: [PATCH 1/2] Update generated files --- CHANGELOG.md | 9 + doc/NgrokAPI.html | 6 +- doc/NgrokAPI/Client.html | 290 ++- doc/NgrokAPI/Error.html | 4 +- doc/NgrokAPI/Errors.html | 4 +- doc/NgrokAPI/Errors/NotFoundError.html | 4 +- doc/NgrokAPI/HttpClient.html | 4 +- doc/NgrokAPI/Models.html | 8 +- doc/NgrokAPI/Models/APIKey.html | 4 +- doc/NgrokAPI/Models/AWSAuth.html | 4 +- doc/NgrokAPI/Models/AWSCredentials.html | 4 +- doc/NgrokAPI/Models/AWSRole.html | 4 +- doc/NgrokAPI/Models/AbuseReport.html | 4 +- doc/NgrokAPI/Models/AbuseReportHostname.html | 4 +- doc/NgrokAPI/Models/AgentIngress.html | 4 +- doc/NgrokAPI/Models/AgentIngressCertJob.html | 4 +- .../Models/AgentIngressCertPolicy.html | 4 +- .../Models/AgentIngressCertStatus.html | 4 +- doc/NgrokAPI/Models/ApplicationSession.html | 4 +- doc/NgrokAPI/Models/ApplicationUser.html | 4 +- doc/NgrokAPI/Models/BotUser.html | 4 +- doc/NgrokAPI/Models/BrowserSession.html | 4 +- doc/NgrokAPI/Models/CertificateAuthority.html | 4 +- doc/NgrokAPI/Models/Credential.html | 4 +- doc/NgrokAPI/Models/Endpoint.html | 90 +- doc/NgrokAPI/Models/EndpointBackend.html | 4 +- .../Models/EndpointBackendMutate.html | 4 +- .../Models/EndpointCircuitBreaker.html | 4 +- doc/NgrokAPI/Models/EndpointCompression.html | 4 +- doc/NgrokAPI/Models/EndpointIPPolicy.html | 4 +- .../Models/EndpointIPPolicyMutate.html | 4 +- doc/NgrokAPI/Models/EndpointMutualTLS.html | 4 +- .../Models/EndpointMutualTLSMutate.html | 4 +- doc/NgrokAPI/Models/EndpointOAuth.html | 4 +- doc/NgrokAPI/Models/EndpointOAuthAmazon.html | 4 +- .../Models/EndpointOAuthFacebook.html | 4 +- doc/NgrokAPI/Models/EndpointOAuthGitHub.html | 4 +- doc/NgrokAPI/Models/EndpointOAuthGitLab.html | 4 +- doc/NgrokAPI/Models/EndpointOAuthGoogle.html | 4 +- .../Models/EndpointOAuthLinkedIn.html | 4 +- .../Models/EndpointOAuthMicrosoft.html | 4 +- .../Models/EndpointOAuthProvider.html | 4 +- doc/NgrokAPI/Models/EndpointOAuthTwitch.html | 4 +- doc/NgrokAPI/Models/EndpointOIDC.html | 4 +- .../Models/EndpointRequestHeaders.html | 4 +- .../Models/EndpointResponseHeaders.html | 4 +- doc/NgrokAPI/Models/EndpointSAML.html | 4 +- doc/NgrokAPI/Models/EndpointSAMLMutate.html | 4 +- .../Models/EndpointTLSTermination.html | 4 +- .../Models/EndpointTLSTerminationAtEdge.html | 4 +- .../Models/EndpointTrafficPolicy.html | 4 +- .../Models/EndpointUserAgentFilter.html | 4 +- .../Models/EndpointWebhookValidation.html | 4 +- .../Models/EndpointWebsocketTCPConverter.html | 4 +- doc/NgrokAPI/Models/EventDestination.html | 4 +- doc/NgrokAPI/Models/EventSource.html | 4 +- doc/NgrokAPI/Models/EventSourceList.html | 4 +- doc/NgrokAPI/Models/EventSourceReplace.html | 4 +- doc/NgrokAPI/Models/EventSubscription.html | 4 +- doc/NgrokAPI/Models/EventTarget.html | 4 +- .../Models/EventTargetAzureLogsIngestion.html | 4 +- .../Models/EventTargetCloudwatchLogs.html | 4 +- doc/NgrokAPI/Models/EventTargetDatadog.html | 4 +- doc/NgrokAPI/Models/EventTargetFirehose.html | 4 +- doc/NgrokAPI/Models/EventTargetKinesis.html | 4 +- doc/NgrokAPI/Models/FailoverBackend.html | 4 +- doc/NgrokAPI/Models/HTTPResponseBackend.html | 4 +- doc/NgrokAPI/Models/HTTPSEdge.html | 4 +- doc/NgrokAPI/Models/HTTPSEdgeRoute.html | 4 +- doc/NgrokAPI/Models/IPPolicy.html | 4 +- doc/NgrokAPI/Models/IPPolicyRule.html | 4 +- doc/NgrokAPI/Models/IPRestriction.html | 4 +- doc/NgrokAPI/Models/IdentityProvider.html | 4 +- doc/NgrokAPI/Models/Listable.html | 4 +- doc/NgrokAPI/Models/Location.html | 4 +- doc/NgrokAPI/Models/Ref.html | 4 +- doc/NgrokAPI/Models/ReservedAddr.html | 4 +- doc/NgrokAPI/Models/ReservedDomain.html | 4 +- .../Models/ReservedDomainCertJob.html | 4 +- .../Models/ReservedDomainCertPolicy.html | 4 +- .../Models/ReservedDomainCertStatus.html | 4 +- .../Models/SSHCertificateAuthority.html | 4 +- doc/NgrokAPI/Models/SSHCredential.html | 4 +- doc/NgrokAPI/Models/SSHHostCertificate.html | 4 +- doc/NgrokAPI/Models/SSHUserCertificate.html | 4 +- doc/NgrokAPI/Models/Secret.html | 1336 ++++++++++++ doc/NgrokAPI/Models/StaticBackend.html | 4 +- doc/NgrokAPI/Models/StaticBackendTLS.html | 4 +- doc/NgrokAPI/Models/TCPEdge.html | 4 +- doc/NgrokAPI/Models/TLSCertificate.html | 4 +- doc/NgrokAPI/Models/TLSCertificateSANs.html | 4 +- doc/NgrokAPI/Models/TLSEdge.html | 4 +- doc/NgrokAPI/Models/Tunnel.html | 4 +- doc/NgrokAPI/Models/TunnelGroupBackend.html | 4 +- doc/NgrokAPI/Models/TunnelSession.html | 4 +- doc/NgrokAPI/Models/UserAgent.html | 4 +- doc/NgrokAPI/Models/Vault.html | 1353 ++++++++++++ doc/NgrokAPI/Models/WeightedBackend.html | 4 +- doc/NgrokAPI/PagedIterator.html | 4 +- doc/NgrokAPI/Services.html | 10 +- doc/NgrokAPI/Services/APIKeysClient.html | 4 +- doc/NgrokAPI/Services/AbuseReportsClient.html | 4 +- .../Services/AgentIngressesClient.html | 4 +- .../Services/ApplicationSessionsClient.html | 4 +- .../Services/ApplicationUsersClient.html | 4 +- doc/NgrokAPI/Services/BotUsersClient.html | 4 +- .../CertificateAuthoritiesClient.html | 4 +- doc/NgrokAPI/Services/CredentialsClient.html | 4 +- .../EdgeRouteBackendModuleClient.html | 4 +- .../EdgeRouteCircuitBreakerModuleClient.html | 4 +- .../EdgeRouteCompressionModuleClient.html | 4 +- .../EdgeRouteIPRestrictionModuleClient.html | 4 +- .../Services/EdgeRouteOAuthModuleClient.html | 4 +- .../Services/EdgeRouteOIDCModuleClient.html | 4 +- .../EdgeRouteRequestHeadersModuleClient.html | 4 +- .../EdgeRouteResponseHeadersModuleClient.html | 4 +- .../Services/EdgeRouteSAMLModuleClient.html | 4 +- .../EdgeRouteTrafficPolicyModuleClient.html | 4 +- .../EdgeRouteUserAgentFilterModuleClient.html | 4 +- ...eRouteWebhookVerificationModuleClient.html | 4 +- ...outeWebsocketTCPConverterModuleClient.html | 4 +- doc/NgrokAPI/Services/EdgesHTTPSClient.html | 4 +- .../Services/EdgesHTTPSRoutesClient.html | 4 +- doc/NgrokAPI/Services/EdgesTCPClient.html | 4 +- doc/NgrokAPI/Services/EdgesTLSClient.html | 4 +- doc/NgrokAPI/Services/EndpointsClient.html | 364 ++-- .../Services/EventDestinationsClient.html | 4 +- doc/NgrokAPI/Services/EventSourcesClient.html | 4 +- .../Services/EventSubscriptionsClient.html | 4 +- .../Services/FailoverBackendsClient.html | 4 +- .../Services/HTTPResponseBackendsClient.html | 4 +- .../HTTPSEdgeMutualTLSModuleClient.html | 4 +- .../HTTPSEdgeTLSTerminationModuleClient.html | 4 +- doc/NgrokAPI/Services/IPPoliciesClient.html | 4 +- .../Services/IPPolicyRulesClient.html | 4 +- .../Services/IPRestrictionsClient.html | 4 +- .../Services/ReservedAddrsClient.html | 4 +- .../Services/ReservedDomainsClient.html | 4 +- .../SSHCertificateAuthoritiesClient.html | 4 +- .../Services/SSHCredentialsClient.html | 4 +- .../Services/SSHHostCertificatesClient.html | 4 +- .../Services/SSHUserCertificatesClient.html | 4 +- doc/NgrokAPI/Services/SecretsClient.html | 1925 +++++++++++++++++ .../Services/StaticBackendsClient.html | 4 +- .../Services/TCPEdgeBackendModuleClient.html | 4 +- .../TCPEdgeIPRestrictionModuleClient.html | 4 +- .../TCPEdgeTrafficPolicyModuleClient.html | 4 +- .../Services/TLSCertificatesClient.html | 4 +- .../Services/TLSEdgeBackendModuleClient.html | 4 +- .../TLSEdgeIPRestrictionModuleClient.html | 4 +- .../TLSEdgeMutualTLSModuleClient.html | 4 +- .../TLSEdgeTLSTerminationModuleClient.html | 4 +- .../TLSEdgeTrafficPolicyModuleClient.html | 4 +- .../Services/TunnelGroupBackendsClient.html | 4 +- .../Services/TunnelSessionsClient.html | 4 +- doc/NgrokAPI/Services/TunnelsClient.html | 4 +- doc/NgrokAPI/Services/VaultsClient.html | 1809 ++++++++++++++++ .../Services/WeightedBackendsClient.html | 4 +- doc/_index.html | 40 +- doc/class_list.html | 2 +- doc/file.README.html | 4 +- doc/index.html | 4 +- doc/method_list.html | 990 ++++++--- doc/top-level-namespace.html | 4 +- docs/NgrokAPI.html | 6 +- docs/NgrokAPI/Client.html | 290 ++- docs/NgrokAPI/Error.html | 4 +- docs/NgrokAPI/Errors.html | 4 +- docs/NgrokAPI/Errors/NotFoundError.html | 4 +- docs/NgrokAPI/HttpClient.html | 4 +- docs/NgrokAPI/Models.html | 8 +- docs/NgrokAPI/Models/APIKey.html | 4 +- docs/NgrokAPI/Models/AWSAuth.html | 4 +- docs/NgrokAPI/Models/AWSCredentials.html | 4 +- docs/NgrokAPI/Models/AWSRole.html | 4 +- docs/NgrokAPI/Models/AbuseReport.html | 4 +- docs/NgrokAPI/Models/AbuseReportHostname.html | 4 +- docs/NgrokAPI/Models/AgentIngress.html | 4 +- docs/NgrokAPI/Models/AgentIngressCertJob.html | 4 +- .../Models/AgentIngressCertPolicy.html | 4 +- .../Models/AgentIngressCertStatus.html | 4 +- docs/NgrokAPI/Models/ApplicationSession.html | 4 +- docs/NgrokAPI/Models/ApplicationUser.html | 4 +- docs/NgrokAPI/Models/BotUser.html | 4 +- docs/NgrokAPI/Models/BrowserSession.html | 4 +- .../NgrokAPI/Models/CertificateAuthority.html | 4 +- docs/NgrokAPI/Models/Credential.html | 4 +- docs/NgrokAPI/Models/Endpoint.html | 90 +- docs/NgrokAPI/Models/EndpointBackend.html | 4 +- .../Models/EndpointBackendMutate.html | 4 +- .../Models/EndpointCircuitBreaker.html | 4 +- docs/NgrokAPI/Models/EndpointCompression.html | 4 +- docs/NgrokAPI/Models/EndpointIPPolicy.html | 4 +- .../Models/EndpointIPPolicyMutate.html | 4 +- docs/NgrokAPI/Models/EndpointMutualTLS.html | 4 +- .../Models/EndpointMutualTLSMutate.html | 4 +- docs/NgrokAPI/Models/EndpointOAuth.html | 4 +- docs/NgrokAPI/Models/EndpointOAuthAmazon.html | 4 +- .../Models/EndpointOAuthFacebook.html | 4 +- docs/NgrokAPI/Models/EndpointOAuthGitHub.html | 4 +- docs/NgrokAPI/Models/EndpointOAuthGitLab.html | 4 +- docs/NgrokAPI/Models/EndpointOAuthGoogle.html | 4 +- .../Models/EndpointOAuthLinkedIn.html | 4 +- .../Models/EndpointOAuthMicrosoft.html | 4 +- .../Models/EndpointOAuthProvider.html | 4 +- docs/NgrokAPI/Models/EndpointOAuthTwitch.html | 4 +- docs/NgrokAPI/Models/EndpointOIDC.html | 4 +- .../Models/EndpointRequestHeaders.html | 4 +- .../Models/EndpointResponseHeaders.html | 4 +- docs/NgrokAPI/Models/EndpointSAML.html | 4 +- docs/NgrokAPI/Models/EndpointSAMLMutate.html | 4 +- .../Models/EndpointTLSTermination.html | 4 +- .../Models/EndpointTLSTerminationAtEdge.html | 4 +- .../Models/EndpointTrafficPolicy.html | 4 +- .../Models/EndpointUserAgentFilter.html | 4 +- .../Models/EndpointWebhookValidation.html | 4 +- .../Models/EndpointWebsocketTCPConverter.html | 4 +- docs/NgrokAPI/Models/EventDestination.html | 4 +- docs/NgrokAPI/Models/EventSource.html | 4 +- docs/NgrokAPI/Models/EventSourceList.html | 4 +- docs/NgrokAPI/Models/EventSourceReplace.html | 4 +- docs/NgrokAPI/Models/EventSubscription.html | 4 +- docs/NgrokAPI/Models/EventTarget.html | 4 +- .../Models/EventTargetAzureLogsIngestion.html | 4 +- .../Models/EventTargetCloudwatchLogs.html | 4 +- docs/NgrokAPI/Models/EventTargetDatadog.html | 4 +- docs/NgrokAPI/Models/EventTargetFirehose.html | 4 +- docs/NgrokAPI/Models/EventTargetKinesis.html | 4 +- docs/NgrokAPI/Models/FailoverBackend.html | 4 +- docs/NgrokAPI/Models/HTTPResponseBackend.html | 4 +- docs/NgrokAPI/Models/HTTPSEdge.html | 4 +- docs/NgrokAPI/Models/HTTPSEdgeRoute.html | 4 +- docs/NgrokAPI/Models/IPPolicy.html | 4 +- docs/NgrokAPI/Models/IPPolicyRule.html | 4 +- docs/NgrokAPI/Models/IPRestriction.html | 4 +- docs/NgrokAPI/Models/IdentityProvider.html | 4 +- docs/NgrokAPI/Models/Listable.html | 4 +- docs/NgrokAPI/Models/Location.html | 4 +- docs/NgrokAPI/Models/Ref.html | 4 +- docs/NgrokAPI/Models/ReservedAddr.html | 4 +- docs/NgrokAPI/Models/ReservedDomain.html | 4 +- .../Models/ReservedDomainCertJob.html | 4 +- .../Models/ReservedDomainCertPolicy.html | 4 +- .../Models/ReservedDomainCertStatus.html | 4 +- .../Models/SSHCertificateAuthority.html | 4 +- docs/NgrokAPI/Models/SSHCredential.html | 4 +- docs/NgrokAPI/Models/SSHHostCertificate.html | 4 +- docs/NgrokAPI/Models/SSHUserCertificate.html | 4 +- docs/NgrokAPI/Models/Secret.html | 1336 ++++++++++++ docs/NgrokAPI/Models/StaticBackend.html | 4 +- docs/NgrokAPI/Models/StaticBackendTLS.html | 4 +- docs/NgrokAPI/Models/TCPEdge.html | 4 +- docs/NgrokAPI/Models/TLSCertificate.html | 4 +- docs/NgrokAPI/Models/TLSCertificateSANs.html | 4 +- docs/NgrokAPI/Models/TLSEdge.html | 4 +- docs/NgrokAPI/Models/Tunnel.html | 4 +- docs/NgrokAPI/Models/TunnelGroupBackend.html | 4 +- docs/NgrokAPI/Models/TunnelSession.html | 4 +- docs/NgrokAPI/Models/UserAgent.html | 4 +- docs/NgrokAPI/Models/Vault.html | 1353 ++++++++++++ docs/NgrokAPI/Models/WeightedBackend.html | 4 +- docs/NgrokAPI/PagedIterator.html | 4 +- docs/NgrokAPI/Services.html | 10 +- docs/NgrokAPI/Services/APIKeysClient.html | 4 +- .../NgrokAPI/Services/AbuseReportsClient.html | 4 +- .../Services/AgentIngressesClient.html | 4 +- .../Services/ApplicationSessionsClient.html | 4 +- .../Services/ApplicationUsersClient.html | 4 +- docs/NgrokAPI/Services/BotUsersClient.html | 4 +- .../CertificateAuthoritiesClient.html | 4 +- docs/NgrokAPI/Services/CredentialsClient.html | 4 +- .../EdgeRouteBackendModuleClient.html | 4 +- .../EdgeRouteCircuitBreakerModuleClient.html | 4 +- .../EdgeRouteCompressionModuleClient.html | 4 +- .../EdgeRouteIPRestrictionModuleClient.html | 4 +- .../Services/EdgeRouteOAuthModuleClient.html | 4 +- .../Services/EdgeRouteOIDCModuleClient.html | 4 +- .../EdgeRouteRequestHeadersModuleClient.html | 4 +- .../EdgeRouteResponseHeadersModuleClient.html | 4 +- .../Services/EdgeRouteSAMLModuleClient.html | 4 +- .../EdgeRouteTrafficPolicyModuleClient.html | 4 +- .../EdgeRouteUserAgentFilterModuleClient.html | 4 +- ...eRouteWebhookVerificationModuleClient.html | 4 +- ...outeWebsocketTCPConverterModuleClient.html | 4 +- docs/NgrokAPI/Services/EdgesHTTPSClient.html | 4 +- .../Services/EdgesHTTPSRoutesClient.html | 4 +- docs/NgrokAPI/Services/EdgesTCPClient.html | 4 +- docs/NgrokAPI/Services/EdgesTLSClient.html | 4 +- docs/NgrokAPI/Services/EndpointsClient.html | 364 ++-- .../Services/EventDestinationsClient.html | 4 +- .../NgrokAPI/Services/EventSourcesClient.html | 4 +- .../Services/EventSubscriptionsClient.html | 4 +- .../Services/FailoverBackendsClient.html | 4 +- .../Services/HTTPResponseBackendsClient.html | 4 +- .../HTTPSEdgeMutualTLSModuleClient.html | 4 +- .../HTTPSEdgeTLSTerminationModuleClient.html | 4 +- docs/NgrokAPI/Services/IPPoliciesClient.html | 4 +- .../Services/IPPolicyRulesClient.html | 4 +- .../Services/IPRestrictionsClient.html | 4 +- .../Services/ReservedAddrsClient.html | 4 +- .../Services/ReservedDomainsClient.html | 4 +- .../SSHCertificateAuthoritiesClient.html | 4 +- .../Services/SSHCredentialsClient.html | 4 +- .../Services/SSHHostCertificatesClient.html | 4 +- .../Services/SSHUserCertificatesClient.html | 4 +- docs/NgrokAPI/Services/SecretsClient.html | 1925 +++++++++++++++++ .../Services/StaticBackendsClient.html | 4 +- .../Services/TCPEdgeBackendModuleClient.html | 4 +- .../TCPEdgeIPRestrictionModuleClient.html | 4 +- .../TCPEdgeTrafficPolicyModuleClient.html | 4 +- .../Services/TLSCertificatesClient.html | 4 +- .../Services/TLSEdgeBackendModuleClient.html | 4 +- .../TLSEdgeIPRestrictionModuleClient.html | 4 +- .../TLSEdgeMutualTLSModuleClient.html | 4 +- .../TLSEdgeTLSTerminationModuleClient.html | 4 +- .../TLSEdgeTrafficPolicyModuleClient.html | 4 +- .../Services/TunnelGroupBackendsClient.html | 4 +- .../Services/TunnelSessionsClient.html | 4 +- docs/NgrokAPI/Services/TunnelsClient.html | 4 +- docs/NgrokAPI/Services/VaultsClient.html | 1809 ++++++++++++++++ .../Services/WeightedBackendsClient.html | 4 +- docs/_index.html | 40 +- docs/class_list.html | 2 +- docs/file.README.html | 4 +- docs/index.html | 4 +- docs/method_list.html | 990 ++++++--- docs/top-level-namespace.html | 4 +- lib/ngrokapi/client.rb | 18 + lib/ngrokapi/models/endpoint.rb | 17 +- lib/ngrokapi/models/secret.rb | 63 + lib/ngrokapi/models/vault.rb | 81 + lib/ngrokapi/services/endpoints_client.rb | 32 +- lib/ngrokapi/services/secrets_client.rb | 246 +++ lib/ngrokapi/services/vaults_client.rb | 234 ++ lib/ngrokapi/version.rb | 2 +- spec/ngrokapi/client_spec.rb | 12 + spec/ngrokapi/models/endpoint_spec.rb | 5 +- spec/ngrokapi/models/secret_spec.rb | 30 + spec/ngrokapi/models/vault_spec.rb | 47 + .../services/endpoints_client_spec.rb | 16 +- spec/ngrokapi/services/secrets_client_spec.rb | 198 ++ spec/ngrokapi/services/vaults_client_spec.rb | 186 ++ spec/spec_helper.rb | 117 + 343 files changed, 17324 insertions(+), 1635 deletions(-) create mode 100644 doc/NgrokAPI/Models/Secret.html create mode 100644 doc/NgrokAPI/Models/Vault.html create mode 100644 doc/NgrokAPI/Services/SecretsClient.html create mode 100644 doc/NgrokAPI/Services/VaultsClient.html create mode 100644 docs/NgrokAPI/Models/Secret.html create mode 100644 docs/NgrokAPI/Models/Vault.html create mode 100644 docs/NgrokAPI/Services/SecretsClient.html create mode 100644 docs/NgrokAPI/Services/VaultsClient.html create mode 100644 lib/ngrokapi/models/secret.rb create mode 100644 lib/ngrokapi/models/vault.rb create mode 100644 lib/ngrokapi/services/secrets_client.rb create mode 100644 lib/ngrokapi/services/vaults_client.rb create mode 100644 spec/ngrokapi/models/secret_spec.rb create mode 100644 spec/ngrokapi/models/vault_spec.rb create mode 100644 spec/ngrokapi/services/secrets_client_spec.rb create mode 100644 spec/ngrokapi/services/vaults_client_spec.rb diff --git a/CHANGELOG.md b/CHANGELOG.md index 7445afb5..cc5687dc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,7 +1,16 @@ +## 0.26.0 +* Add support for `ids` and `urls` query parameters when listing endpoint resources. + +## 0.25.0 +* Renamed `upstream_proto` to `upstream_protocol` for `endpoint` resources +* Added support for `pooling_enabled` on Endpoints +* Add support for `vaults` +* Add support for `secrets` ## 0.24.0 * Added support for Cloud Endpoints (currently in private beta). +* Renamed `principal_id` to `principal` for `endpoint` resources ## 0.23.0 * Renamed the Policy Module to the Traffic Policy Module on HTTP Edge Routes, TCP Edges, and TLS Edges, which allows you to configure rules that can be used to influence and control traffic to and from your upstream service. The Traffic Policy itself is now specified as either a JSON or YAML string. diff --git a/doc/NgrokAPI.html b/doc/NgrokAPI.html index 7c3522f4..4f00b7ad 100644 --- a/doc/NgrokAPI.html +++ b/doc/NgrokAPI.html @@ -79,7 +79,7 @@
Defined in:
lib/ngrokapi.rb,
- lib/ngrokapi/error.rb,
lib/ngrokapi/client.rb,
lib/ngrokapi/version.rb,
lib/ngrokapi/models/ref.rb,
lib/ngrokapi/http_client.rb,
lib/ngrokapi/models/tunnel.rb,
lib/ngrokapi/models/api_key.rb,
lib/ngrokapi/paged_iterator.rb,
lib/ngrokapi/models/aws_auth.rb,
lib/ngrokapi/models/aws_role.rb,
lib/ngrokapi/models/bot_user.rb,
lib/ngrokapi/models/endpoint.rb,
lib/ngrokapi/models/listable.rb,
lib/ngrokapi/models/location.rb,
lib/ngrokapi/models/tcp_edge.rb,
lib/ngrokapi/models/tls_edge.rb,
lib/ngrokapi/models/ip_policy.rb,
lib/ngrokapi/models/credential.rb,
lib/ngrokapi/models/https_edge.rb,
lib/ngrokapi/models/user_agent.rb,
lib/ngrokapi/models/abuse_report.rb,
lib/ngrokapi/models/event_source.rb,
lib/ngrokapi/models/event_target.rb,
lib/ngrokapi/models/agent_ingress.rb,
lib/ngrokapi/models/endpoint_oidc.rb,
lib/ngrokapi/models/endpoint_saml.rb,
lib/ngrokapi/models/reserved_addr.rb,
lib/ngrokapi/models/ip_policy_rule.rb,
lib/ngrokapi/models/ip_restriction.rb,
lib/ngrokapi/models/ssh_credential.rb,
lib/ngrokapi/models/static_backend.rb,
lib/ngrokapi/models/tunnel_session.rb,
lib/ngrokapi/errors/not_found_error.rb,
lib/ngrokapi/models/aws_credentials.rb,
lib/ngrokapi/models/browser_session.rb,
lib/ngrokapi/models/endpoint_o_auth.rb,
lib/ngrokapi/models/reserved_domain.rb,
lib/ngrokapi/models/tls_certificate.rb,
lib/ngrokapi/models/application_user.rb,
lib/ngrokapi/models/endpoint_backend.rb,
lib/ngrokapi/models/failover_backend.rb,
lib/ngrokapi/models/https_edge_route.rb,
lib/ngrokapi/models/weighted_backend.rb,
lib/ngrokapi/services/tunnels_client.rb,
lib/ngrokapi/models/event_destination.rb,
lib/ngrokapi/models/event_source_list.rb,
lib/ngrokapi/models/identity_provider.rb,
lib/ngrokapi/services/api_keys_client.rb,
lib/ngrokapi/models/endpoint_ip_policy.rb,
lib/ngrokapi/models/event_subscription.rb,
lib/ngrokapi/models/static_backend_tls.rb,
lib/ngrokapi/services/bot_users_client.rb,
lib/ngrokapi/services/edges_tcp_client.rb,
lib/ngrokapi/services/edges_tls_client.rb,
lib/ngrokapi/services/endpoints_client.rb,
lib/ngrokapi/models/application_session.rb,
lib/ngrokapi/models/endpoint_mutual_tls.rb,
lib/ngrokapi/models/endpoint_compression.rb,
lib/ngrokapi/models/endpoint_saml_mutate.rb,
lib/ngrokapi/models/event_source_replace.rb,
lib/ngrokapi/models/event_target_datadog.rb,
lib/ngrokapi/models/event_target_kinesis.rb,
lib/ngrokapi/models/ssh_host_certificate.rb,
lib/ngrokapi/models/ssh_user_certificate.rb,
lib/ngrokapi/models/tunnel_group_backend.rb,
lib/ngrokapi/services/credentials_client.rb,
lib/ngrokapi/services/edges_https_client.rb,
lib/ngrokapi/services/ip_policies_client.rb,
lib/ngrokapi/models/abuse_report_hostname.rb,
lib/ngrokapi/models/certificate_authority.rb,
lib/ngrokapi/models/event_target_firehose.rb,
lib/ngrokapi/models/http_response_backend.rb,
lib/ngrokapi/models/tls_certificate_sa_ns.rb,
lib/ngrokapi/models/agent_ingress_cert_job.rb,
lib/ngrokapi/models/endpoint_o_auth_amazon.rb,
lib/ngrokapi/models/endpoint_o_auth_google.rb,
lib/ngrokapi/models/endpoint_o_auth_twitch.rb,
lib/ngrokapi/services/abuse_reports_client.rb,
lib/ngrokapi/services/event_sources_client.rb,
lib/ngrokapi/models/endpoint_backend_mutate.rb,
lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,
lib/ngrokapi/models/endpoint_o_auth_git_lab.rb,
lib/ngrokapi/models/endpoint_traffic_policy.rb,
lib/ngrokapi/services/reserved_addrs_client.rb,
lib/ngrokapi/models/endpoint_circuit_breaker.rb,
lib/ngrokapi/models/endpoint_o_auth_facebook.rb,
lib/ngrokapi/models/endpoint_o_auth_provider.rb,
lib/ngrokapi/models/endpoint_request_headers.rb,
lib/ngrokapi/models/endpoint_tls_termination.rb,
lib/ngrokapi/models/reserved_domain_cert_job.rb,
lib/ngrokapi/services/agent_ingresses_client.rb,
lib/ngrokapi/services/ip_policy_rules_client.rb,
lib/ngrokapi/services/ip_restrictions_client.rb,
lib/ngrokapi/services/ssh_credentials_client.rb,
lib/ngrokapi/services/static_backends_client.rb,
lib/ngrokapi/services/tunnel_sessions_client.rb,
lib/ngrokapi/models/agent_ingress_cert_policy.rb,
lib/ngrokapi/models/agent_ingress_cert_status.rb,
lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,
lib/ngrokapi/models/endpoint_o_auth_linked_in.rb,
lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,
lib/ngrokapi/models/endpoint_response_headers.rb,
lib/ngrokapi/models/ssh_certificate_authority.rb,
lib/ngrokapi/services/reserved_domains_client.rb,
lib/ngrokapi/services/tls_certificates_client.rb,
lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,
lib/ngrokapi/models/endpoint_user_agent_filter.rb,
lib/ngrokapi/services/application_users_client.rb,
lib/ngrokapi/services/failover_backends_client.rb,
lib/ngrokapi/services/weighted_backends_client.rb,
lib/ngrokapi/models/endpoint_webhook_validation.rb,
lib/ngrokapi/models/reserved_domain_cert_policy.rb,
lib/ngrokapi/models/reserved_domain_cert_status.rb,
lib/ngrokapi/services/edges_https_routes_client.rb,
lib/ngrokapi/services/event_destinations_client.rb,
lib/ngrokapi/models/event_target_cloudwatch_logs.rb,
lib/ngrokapi/services/event_subscriptions_client.rb,
lib/ngrokapi/services/application_sessions_client.rb,
lib/ngrokapi/services/ssh_host_certificates_client.rb,
lib/ngrokapi/services/ssh_user_certificates_client.rb,
lib/ngrokapi/services/tunnel_group_backends_client.rb,
lib/ngrokapi/services/edge_route_oidc_module_client.rb,
lib/ngrokapi/services/edge_route_saml_module_client.rb,
lib/ngrokapi/services/http_response_backends_client.rb,
lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb,
lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb,
lib/ngrokapi/services/certificate_authorities_client.rb,
lib/ngrokapi/services/tcp_edge_backend_module_client.rb,
lib/ngrokapi/services/tls_edge_backend_module_client.rb,
lib/ngrokapi/models/event_target_azure_logs_ingestion.rb,
lib/ngrokapi/services/edge_route_o_auth_module_client.rb,
lib/ngrokapi/services/edge_route_backend_module_client.rb,
lib/ngrokapi/services/tls_edge_mutual_tls_module_client.rb,
lib/ngrokapi/services/ssh_certificate_authorities_client.rb,
lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb,
lib/ngrokapi/services/edge_route_compression_module_client.rb,
lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb,
lib/ngrokapi/services/tcp_edge_traffic_policy_module_client.rb,
lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb,
lib/ngrokapi/services/tls_edge_traffic_policy_module_client.rb,
lib/ngrokapi/services/tls_edge_tls_termination_module_client.rb,
lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb,
lib/ngrokapi/services/edge_route_traffic_policy_module_client.rb,
lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb,
lib/ngrokapi/services/edge_route_request_headers_module_client.rb,
lib/ngrokapi/services/https_edge_tls_termination_module_client.rb,
lib/ngrokapi/services/edge_route_response_headers_module_client.rb,
lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb,
lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb,
lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb
+ lib/ngrokapi/error.rb,
lib/ngrokapi/client.rb,
lib/ngrokapi/version.rb,
lib/ngrokapi/models/ref.rb,
lib/ngrokapi/http_client.rb,
lib/ngrokapi/models/vault.rb,
lib/ngrokapi/models/secret.rb,
lib/ngrokapi/models/tunnel.rb,
lib/ngrokapi/models/api_key.rb,
lib/ngrokapi/paged_iterator.rb,
lib/ngrokapi/models/aws_auth.rb,
lib/ngrokapi/models/aws_role.rb,
lib/ngrokapi/models/bot_user.rb,
lib/ngrokapi/models/endpoint.rb,
lib/ngrokapi/models/listable.rb,
lib/ngrokapi/models/location.rb,
lib/ngrokapi/models/tcp_edge.rb,
lib/ngrokapi/models/tls_edge.rb,
lib/ngrokapi/models/ip_policy.rb,
lib/ngrokapi/models/credential.rb,
lib/ngrokapi/models/https_edge.rb,
lib/ngrokapi/models/user_agent.rb,
lib/ngrokapi/models/abuse_report.rb,
lib/ngrokapi/models/event_source.rb,
lib/ngrokapi/models/event_target.rb,
lib/ngrokapi/models/agent_ingress.rb,
lib/ngrokapi/models/endpoint_oidc.rb,
lib/ngrokapi/models/endpoint_saml.rb,
lib/ngrokapi/models/reserved_addr.rb,
lib/ngrokapi/models/ip_policy_rule.rb,
lib/ngrokapi/models/ip_restriction.rb,
lib/ngrokapi/models/ssh_credential.rb,
lib/ngrokapi/models/static_backend.rb,
lib/ngrokapi/models/tunnel_session.rb,
lib/ngrokapi/errors/not_found_error.rb,
lib/ngrokapi/models/aws_credentials.rb,
lib/ngrokapi/models/browser_session.rb,
lib/ngrokapi/models/endpoint_o_auth.rb,
lib/ngrokapi/models/reserved_domain.rb,
lib/ngrokapi/models/tls_certificate.rb,
lib/ngrokapi/services/vaults_client.rb,
lib/ngrokapi/models/application_user.rb,
lib/ngrokapi/models/endpoint_backend.rb,
lib/ngrokapi/models/failover_backend.rb,
lib/ngrokapi/models/https_edge_route.rb,
lib/ngrokapi/models/weighted_backend.rb,
lib/ngrokapi/services/secrets_client.rb,
lib/ngrokapi/services/tunnels_client.rb,
lib/ngrokapi/models/event_destination.rb,
lib/ngrokapi/models/event_source_list.rb,
lib/ngrokapi/models/identity_provider.rb,
lib/ngrokapi/services/api_keys_client.rb,
lib/ngrokapi/models/endpoint_ip_policy.rb,
lib/ngrokapi/models/event_subscription.rb,
lib/ngrokapi/models/static_backend_tls.rb,
lib/ngrokapi/services/bot_users_client.rb,
lib/ngrokapi/services/edges_tcp_client.rb,
lib/ngrokapi/services/edges_tls_client.rb,
lib/ngrokapi/services/endpoints_client.rb,
lib/ngrokapi/models/application_session.rb,
lib/ngrokapi/models/endpoint_mutual_tls.rb,
lib/ngrokapi/models/endpoint_compression.rb,
lib/ngrokapi/models/endpoint_saml_mutate.rb,
lib/ngrokapi/models/event_source_replace.rb,
lib/ngrokapi/models/event_target_datadog.rb,
lib/ngrokapi/models/event_target_kinesis.rb,
lib/ngrokapi/models/ssh_host_certificate.rb,
lib/ngrokapi/models/ssh_user_certificate.rb,
lib/ngrokapi/models/tunnel_group_backend.rb,
lib/ngrokapi/services/credentials_client.rb,
lib/ngrokapi/services/edges_https_client.rb,
lib/ngrokapi/services/ip_policies_client.rb,
lib/ngrokapi/models/abuse_report_hostname.rb,
lib/ngrokapi/models/certificate_authority.rb,
lib/ngrokapi/models/event_target_firehose.rb,
lib/ngrokapi/models/http_response_backend.rb,
lib/ngrokapi/models/tls_certificate_sa_ns.rb,
lib/ngrokapi/models/agent_ingress_cert_job.rb,
lib/ngrokapi/models/endpoint_o_auth_amazon.rb,
lib/ngrokapi/models/endpoint_o_auth_google.rb,
lib/ngrokapi/models/endpoint_o_auth_twitch.rb,
lib/ngrokapi/services/abuse_reports_client.rb,
lib/ngrokapi/services/event_sources_client.rb,
lib/ngrokapi/models/endpoint_backend_mutate.rb,
lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,
lib/ngrokapi/models/endpoint_o_auth_git_lab.rb,
lib/ngrokapi/models/endpoint_traffic_policy.rb,
lib/ngrokapi/services/reserved_addrs_client.rb,
lib/ngrokapi/models/endpoint_circuit_breaker.rb,
lib/ngrokapi/models/endpoint_o_auth_facebook.rb,
lib/ngrokapi/models/endpoint_o_auth_provider.rb,
lib/ngrokapi/models/endpoint_request_headers.rb,
lib/ngrokapi/models/endpoint_tls_termination.rb,
lib/ngrokapi/models/reserved_domain_cert_job.rb,
lib/ngrokapi/services/agent_ingresses_client.rb,
lib/ngrokapi/services/ip_policy_rules_client.rb,
lib/ngrokapi/services/ip_restrictions_client.rb,
lib/ngrokapi/services/ssh_credentials_client.rb,
lib/ngrokapi/services/static_backends_client.rb,
lib/ngrokapi/services/tunnel_sessions_client.rb,
lib/ngrokapi/models/agent_ingress_cert_policy.rb,
lib/ngrokapi/models/agent_ingress_cert_status.rb,
lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,
lib/ngrokapi/models/endpoint_o_auth_linked_in.rb,
lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,
lib/ngrokapi/models/endpoint_response_headers.rb,
lib/ngrokapi/models/ssh_certificate_authority.rb,
lib/ngrokapi/services/reserved_domains_client.rb,
lib/ngrokapi/services/tls_certificates_client.rb,
lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,
lib/ngrokapi/models/endpoint_user_agent_filter.rb,
lib/ngrokapi/services/application_users_client.rb,
lib/ngrokapi/services/failover_backends_client.rb,
lib/ngrokapi/services/weighted_backends_client.rb,
lib/ngrokapi/models/endpoint_webhook_validation.rb,
lib/ngrokapi/models/reserved_domain_cert_policy.rb,
lib/ngrokapi/models/reserved_domain_cert_status.rb,
lib/ngrokapi/services/edges_https_routes_client.rb,
lib/ngrokapi/services/event_destinations_client.rb,
lib/ngrokapi/models/event_target_cloudwatch_logs.rb,
lib/ngrokapi/services/event_subscriptions_client.rb,
lib/ngrokapi/services/application_sessions_client.rb,
lib/ngrokapi/services/ssh_host_certificates_client.rb,
lib/ngrokapi/services/ssh_user_certificates_client.rb,
lib/ngrokapi/services/tunnel_group_backends_client.rb,
lib/ngrokapi/services/edge_route_oidc_module_client.rb,
lib/ngrokapi/services/edge_route_saml_module_client.rb,
lib/ngrokapi/services/http_response_backends_client.rb,
lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb,
lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb,
lib/ngrokapi/services/certificate_authorities_client.rb,
lib/ngrokapi/services/tcp_edge_backend_module_client.rb,
lib/ngrokapi/services/tls_edge_backend_module_client.rb,
lib/ngrokapi/models/event_target_azure_logs_ingestion.rb,
lib/ngrokapi/services/edge_route_o_auth_module_client.rb,
lib/ngrokapi/services/edge_route_backend_module_client.rb,
lib/ngrokapi/services/tls_edge_mutual_tls_module_client.rb,
lib/ngrokapi/services/ssh_certificate_authorities_client.rb,
lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb,
lib/ngrokapi/services/edge_route_compression_module_client.rb,
lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb,
lib/ngrokapi/services/tcp_edge_traffic_policy_module_client.rb,
lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb,
lib/ngrokapi/services/tls_edge_traffic_policy_module_client.rb,
lib/ngrokapi/services/tls_edge_tls_termination_module_client.rb,
lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb,
lib/ngrokapi/services/edge_route_traffic_policy_module_client.rb,
lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb,
lib/ngrokapi/services/edge_route_request_headers_module_client.rb,
lib/ngrokapi/services/https_edge_tls_termination_module_client.rb,
lib/ngrokapi/services/edge_route_response_headers_module_client.rb,
lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb,
lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb,
lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb
@@ -147,9 +147,9 @@

diff --git a/doc/NgrokAPI/Client.html b/doc/NgrokAPI/Client.html index 165f9d1f..43f40b7b 100644 --- a/doc/NgrokAPI/Client.html +++ b/doc/NgrokAPI/Client.html @@ -608,6 +608,30 @@

Reserved Domains are hostnames that you can listen for traffic on.

+ + + +
  • + + + #secrets ⇒ NgrokAPI::Services::SecretsClient + + + + + + + + + + + + + +
    +

    Secrets is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.

    +
    +
  • @@ -776,6 +800,30 @@

    Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.

    + + + +
  • + + + #vaults ⇒ NgrokAPI::Services::VaultsClient + + + + + + + + + + + + + +
    +

    Vaults is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.

    +
    +
  • @@ -1046,19 +1094,19 @@

     
     
    -221
    -222
    -223
    -224
    -225
    -226
    -227
    -228
    -229
    -230
    +239 +240 +241 +242 +243 +244 +245 +246 +247 +248 -
    # File 'lib/ngrokapi/client.rb', line 221
    +      
    # File 'lib/ngrokapi/client.rb', line 239
     
     def backends
       ns = OpenStruct.new
    @@ -1228,24 +1276,6 @@ 

     
     
    -242
    -243
    -244
    -245
    -246
    -247
    -248
    -249
    -250
    -251
    -252
    -253
    -254
    -255
    -256
    -257
    -258
    -259
     260
     261
     262
    @@ -1255,10 +1285,28 @@ 

    266 267 268 -269

    +269 +270 +271 +272 +273 +274 +275 +276 +277 +278 +279 +280 +281 +282 +283 +284 +285 +286 +287

    -
    # File 'lib/ngrokapi/client.rb', line 242
    +      
    # File 'lib/ngrokapi/client.rb', line 260
     
     def edge_modules
       ns = OpenStruct.new
    @@ -1308,18 +1356,18 @@ 

     
     
    -232
    -233
    -234
    -235
    -236
    -237
    -238
    -239
    -240
    +250 +251 +252 +253 +254 +255 +256 +257 +258

    -
    # File 'lib/ngrokapi/client.rb', line 232
    +      
    # File 'lib/ngrokapi/client.rb', line 250
     
     def edges
       ns = OpenStruct.new
    @@ -1750,9 +1798,9 @@ 

    -

    +

    - #ssh_certificate_authoritiesNgrokAPI::Services::SSHCertificateAuthoritiesClient + #secretsNgrokAPI::Services::SecretsClient @@ -1761,7 +1809,7 @@

    -

    An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.

    +

    Secrets is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.

    @@ -1774,7 +1822,7 @@

  • - (NgrokAPI::Services::SSHCertificateAuthoritiesClient) + (NgrokAPI::Services::SecretsClient) @@ -1795,6 +1843,60 @@

    # File 'lib/ngrokapi/client.rb', line 167
     
    +def secrets
    +  @_secrets ||= NgrokAPI::Services::SecretsClient.new(client: @client)
    +end
    + + + +

  • + +
    +

    + + #ssh_certificate_authoritiesNgrokAPI::Services::SSHCertificateAuthoritiesClient + + + + + +

    +
    + +

    An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.

    + + +
    +
    +
    + +

    Returns:

    + + +
    + + +
    +
    +
    +
    +176
    +177
    +178
    +
    +
    # File 'lib/ngrokapi/client.rb', line 176
    +
     def ssh_certificate_authorities
       @_ssh_certificate_authorities ||= NgrokAPI::Services::SSHCertificateAuthoritiesClient.new(client: @client)
     end
    @@ -1842,12 +1944,12 @@

     
     
    -176
    -177
    -178
    +185 +186 +187

    -
    # File 'lib/ngrokapi/client.rb', line 176
    +      
    # File 'lib/ngrokapi/client.rb', line 185
     
     def ssh_credentials
       @_ssh_credentials ||= NgrokAPI::Services::SSHCredentialsClient.new(client: @client)
    @@ -1896,12 +1998,12 @@ 

     
     
    -186
    -187
    -188
    +195 +196 +197

    -
    # File 'lib/ngrokapi/client.rb', line 186
    +      
    # File 'lib/ngrokapi/client.rb', line 195
     
     def ssh_host_certificates
       @_ssh_host_certificates ||= NgrokAPI::Services::SSHHostCertificatesClient.new(client: @client)
    @@ -1950,12 +2052,12 @@ 

     
     
    -196
    -197
    -198
    +205 +206 +207

    -
    # File 'lib/ngrokapi/client.rb', line 196
    +      
    # File 'lib/ngrokapi/client.rb', line 205
     
     def ssh_user_certificates
       @_ssh_user_certificates ||= NgrokAPI::Services::SSHUserCertificatesClient.new(client: @client)
    @@ -2004,12 +2106,12 @@ 

     
     
    -208
    -209
    -210
    +217 +218 +219

    -
    # File 'lib/ngrokapi/client.rb', line 208
    +      
    # File 'lib/ngrokapi/client.rb', line 217
     
     def tls_certificates
       @_tls_certificates ||= NgrokAPI::Services::TLSCertificatesClient.new(client: @client)
    @@ -2112,12 +2214,12 @@ 

     
     
    -217
    -218
    -219
    +226 +227 +228

    -
    # File 'lib/ngrokapi/client.rb', line 217
    +      
    # File 'lib/ngrokapi/client.rb', line 226
     
     def tunnels
       @_tunnels ||= NgrokAPI::Services::TunnelsClient.new(client: @client)
    @@ -2125,6 +2227,60 @@ 

    +
    + +
    +

    + + #vaultsNgrokAPI::Services::VaultsClient + + + + + +

    +
    + +

    Vaults is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.

    + + +
    +
    +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +235
    +236
    +237
    +
    +
    # File 'lib/ngrokapi/client.rb', line 235
    +
    +def vaults
    +  @_vaults ||= NgrokAPI::Services::VaultsClient.new(client: @client)
    +end
    +
    @@ -2132,9 +2288,9 @@

    diff --git a/doc/NgrokAPI/Error.html b/doc/NgrokAPI/Error.html index 9e616672..3f1e4545 100644 --- a/doc/NgrokAPI/Error.html +++ b/doc/NgrokAPI/Error.html @@ -295,9 +295,9 @@

    diff --git a/doc/NgrokAPI/Errors.html b/doc/NgrokAPI/Errors.html index 58bba368..f6561962 100644 --- a/doc/NgrokAPI/Errors.html +++ b/doc/NgrokAPI/Errors.html @@ -105,9 +105,9 @@

    Defined Under Namespace

    diff --git a/doc/NgrokAPI/Errors/NotFoundError.html b/doc/NgrokAPI/Errors/NotFoundError.html index 4bf441cf..0ecabd12 100644 --- a/doc/NgrokAPI/Errors/NotFoundError.html +++ b/doc/NgrokAPI/Errors/NotFoundError.html @@ -299,9 +299,9 @@

    diff --git a/doc/NgrokAPI/HttpClient.html b/doc/NgrokAPI/HttpClient.html index c060d4e5..53088ed4 100644 --- a/doc/NgrokAPI/HttpClient.html +++ b/doc/NgrokAPI/HttpClient.html @@ -1267,9 +1267,9 @@

    diff --git a/doc/NgrokAPI/Models.html b/doc/NgrokAPI/Models.html index 8c45abee..9d488dad 100644 --- a/doc/NgrokAPI/Models.html +++ b/doc/NgrokAPI/Models.html @@ -79,7 +79,7 @@
    Defined in:
    lib/ngrokapi/models/ref.rb,
    - lib/ngrokapi/models/tunnel.rb,
    lib/ngrokapi/models/api_key.rb,
    lib/ngrokapi/models/aws_auth.rb,
    lib/ngrokapi/models/aws_role.rb,
    lib/ngrokapi/models/bot_user.rb,
    lib/ngrokapi/models/endpoint.rb,
    lib/ngrokapi/models/listable.rb,
    lib/ngrokapi/models/location.rb,
    lib/ngrokapi/models/tcp_edge.rb,
    lib/ngrokapi/models/tls_edge.rb,
    lib/ngrokapi/models/ip_policy.rb,
    lib/ngrokapi/models/credential.rb,
    lib/ngrokapi/models/https_edge.rb,
    lib/ngrokapi/models/user_agent.rb,
    lib/ngrokapi/models/abuse_report.rb,
    lib/ngrokapi/models/event_source.rb,
    lib/ngrokapi/models/event_target.rb,
    lib/ngrokapi/models/agent_ingress.rb,
    lib/ngrokapi/models/endpoint_oidc.rb,
    lib/ngrokapi/models/endpoint_saml.rb,
    lib/ngrokapi/models/reserved_addr.rb,
    lib/ngrokapi/models/ip_policy_rule.rb,
    lib/ngrokapi/models/ip_restriction.rb,
    lib/ngrokapi/models/ssh_credential.rb,
    lib/ngrokapi/models/static_backend.rb,
    lib/ngrokapi/models/tunnel_session.rb,
    lib/ngrokapi/models/aws_credentials.rb,
    lib/ngrokapi/models/browser_session.rb,
    lib/ngrokapi/models/endpoint_o_auth.rb,
    lib/ngrokapi/models/reserved_domain.rb,
    lib/ngrokapi/models/tls_certificate.rb,
    lib/ngrokapi/models/application_user.rb,
    lib/ngrokapi/models/endpoint_backend.rb,
    lib/ngrokapi/models/failover_backend.rb,
    lib/ngrokapi/models/https_edge_route.rb,
    lib/ngrokapi/models/weighted_backend.rb,
    lib/ngrokapi/models/event_destination.rb,
    lib/ngrokapi/models/event_source_list.rb,
    lib/ngrokapi/models/identity_provider.rb,
    lib/ngrokapi/models/endpoint_ip_policy.rb,
    lib/ngrokapi/models/event_subscription.rb,
    lib/ngrokapi/models/static_backend_tls.rb,
    lib/ngrokapi/models/application_session.rb,
    lib/ngrokapi/models/endpoint_mutual_tls.rb,
    lib/ngrokapi/models/endpoint_compression.rb,
    lib/ngrokapi/models/endpoint_saml_mutate.rb,
    lib/ngrokapi/models/event_source_replace.rb,
    lib/ngrokapi/models/event_target_datadog.rb,
    lib/ngrokapi/models/event_target_kinesis.rb,
    lib/ngrokapi/models/ssh_host_certificate.rb,
    lib/ngrokapi/models/ssh_user_certificate.rb,
    lib/ngrokapi/models/tunnel_group_backend.rb,
    lib/ngrokapi/models/abuse_report_hostname.rb,
    lib/ngrokapi/models/certificate_authority.rb,
    lib/ngrokapi/models/event_target_firehose.rb,
    lib/ngrokapi/models/http_response_backend.rb,
    lib/ngrokapi/models/tls_certificate_sa_ns.rb,
    lib/ngrokapi/models/agent_ingress_cert_job.rb,
    lib/ngrokapi/models/endpoint_o_auth_amazon.rb,
    lib/ngrokapi/models/endpoint_o_auth_google.rb,
    lib/ngrokapi/models/endpoint_o_auth_twitch.rb,
    lib/ngrokapi/models/endpoint_backend_mutate.rb,
    lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,
    lib/ngrokapi/models/endpoint_o_auth_git_lab.rb,
    lib/ngrokapi/models/endpoint_traffic_policy.rb,
    lib/ngrokapi/models/endpoint_circuit_breaker.rb,
    lib/ngrokapi/models/endpoint_o_auth_facebook.rb,
    lib/ngrokapi/models/endpoint_o_auth_provider.rb,
    lib/ngrokapi/models/endpoint_request_headers.rb,
    lib/ngrokapi/models/endpoint_tls_termination.rb,
    lib/ngrokapi/models/reserved_domain_cert_job.rb,
    lib/ngrokapi/models/agent_ingress_cert_policy.rb,
    lib/ngrokapi/models/agent_ingress_cert_status.rb,
    lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,
    lib/ngrokapi/models/endpoint_o_auth_linked_in.rb,
    lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,
    lib/ngrokapi/models/endpoint_response_headers.rb,
    lib/ngrokapi/models/ssh_certificate_authority.rb,
    lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,
    lib/ngrokapi/models/endpoint_user_agent_filter.rb,
    lib/ngrokapi/models/endpoint_webhook_validation.rb,
    lib/ngrokapi/models/reserved_domain_cert_policy.rb,
    lib/ngrokapi/models/reserved_domain_cert_status.rb,
    lib/ngrokapi/models/event_target_cloudwatch_logs.rb,
    lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb,
    lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb,
    lib/ngrokapi/models/event_target_azure_logs_ingestion.rb
    + lib/ngrokapi/models/vault.rb,
    lib/ngrokapi/models/secret.rb,
    lib/ngrokapi/models/tunnel.rb,
    lib/ngrokapi/models/api_key.rb,
    lib/ngrokapi/models/aws_auth.rb,
    lib/ngrokapi/models/aws_role.rb,
    lib/ngrokapi/models/bot_user.rb,
    lib/ngrokapi/models/endpoint.rb,
    lib/ngrokapi/models/listable.rb,
    lib/ngrokapi/models/location.rb,
    lib/ngrokapi/models/tcp_edge.rb,
    lib/ngrokapi/models/tls_edge.rb,
    lib/ngrokapi/models/ip_policy.rb,
    lib/ngrokapi/models/credential.rb,
    lib/ngrokapi/models/https_edge.rb,
    lib/ngrokapi/models/user_agent.rb,
    lib/ngrokapi/models/abuse_report.rb,
    lib/ngrokapi/models/event_source.rb,
    lib/ngrokapi/models/event_target.rb,
    lib/ngrokapi/models/agent_ingress.rb,
    lib/ngrokapi/models/endpoint_oidc.rb,
    lib/ngrokapi/models/endpoint_saml.rb,
    lib/ngrokapi/models/reserved_addr.rb,
    lib/ngrokapi/models/ip_policy_rule.rb,
    lib/ngrokapi/models/ip_restriction.rb,
    lib/ngrokapi/models/ssh_credential.rb,
    lib/ngrokapi/models/static_backend.rb,
    lib/ngrokapi/models/tunnel_session.rb,
    lib/ngrokapi/models/aws_credentials.rb,
    lib/ngrokapi/models/browser_session.rb,
    lib/ngrokapi/models/endpoint_o_auth.rb,
    lib/ngrokapi/models/reserved_domain.rb,
    lib/ngrokapi/models/tls_certificate.rb,
    lib/ngrokapi/models/application_user.rb,
    lib/ngrokapi/models/endpoint_backend.rb,
    lib/ngrokapi/models/failover_backend.rb,
    lib/ngrokapi/models/https_edge_route.rb,
    lib/ngrokapi/models/weighted_backend.rb,
    lib/ngrokapi/models/event_destination.rb,
    lib/ngrokapi/models/event_source_list.rb,
    lib/ngrokapi/models/identity_provider.rb,
    lib/ngrokapi/models/endpoint_ip_policy.rb,
    lib/ngrokapi/models/event_subscription.rb,
    lib/ngrokapi/models/static_backend_tls.rb,
    lib/ngrokapi/models/application_session.rb,
    lib/ngrokapi/models/endpoint_mutual_tls.rb,
    lib/ngrokapi/models/endpoint_compression.rb,
    lib/ngrokapi/models/endpoint_saml_mutate.rb,
    lib/ngrokapi/models/event_source_replace.rb,
    lib/ngrokapi/models/event_target_datadog.rb,
    lib/ngrokapi/models/event_target_kinesis.rb,
    lib/ngrokapi/models/ssh_host_certificate.rb,
    lib/ngrokapi/models/ssh_user_certificate.rb,
    lib/ngrokapi/models/tunnel_group_backend.rb,
    lib/ngrokapi/models/abuse_report_hostname.rb,
    lib/ngrokapi/models/certificate_authority.rb,
    lib/ngrokapi/models/event_target_firehose.rb,
    lib/ngrokapi/models/http_response_backend.rb,
    lib/ngrokapi/models/tls_certificate_sa_ns.rb,
    lib/ngrokapi/models/agent_ingress_cert_job.rb,
    lib/ngrokapi/models/endpoint_o_auth_amazon.rb,
    lib/ngrokapi/models/endpoint_o_auth_google.rb,
    lib/ngrokapi/models/endpoint_o_auth_twitch.rb,
    lib/ngrokapi/models/endpoint_backend_mutate.rb,
    lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,
    lib/ngrokapi/models/endpoint_o_auth_git_lab.rb,
    lib/ngrokapi/models/endpoint_traffic_policy.rb,
    lib/ngrokapi/models/endpoint_circuit_breaker.rb,
    lib/ngrokapi/models/endpoint_o_auth_facebook.rb,
    lib/ngrokapi/models/endpoint_o_auth_provider.rb,
    lib/ngrokapi/models/endpoint_request_headers.rb,
    lib/ngrokapi/models/endpoint_tls_termination.rb,
    lib/ngrokapi/models/reserved_domain_cert_job.rb,
    lib/ngrokapi/models/agent_ingress_cert_policy.rb,
    lib/ngrokapi/models/agent_ingress_cert_status.rb,
    lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,
    lib/ngrokapi/models/endpoint_o_auth_linked_in.rb,
    lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,
    lib/ngrokapi/models/endpoint_response_headers.rb,
    lib/ngrokapi/models/ssh_certificate_authority.rb,
    lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,
    lib/ngrokapi/models/endpoint_user_agent_filter.rb,
    lib/ngrokapi/models/endpoint_webhook_validation.rb,
    lib/ngrokapi/models/reserved_domain_cert_policy.rb,
    lib/ngrokapi/models/reserved_domain_cert_status.rb,
    lib/ngrokapi/models/event_target_cloudwatch_logs.rb,
    lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb,
    lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb,
    lib/ngrokapi/models/event_target_azure_logs_ingestion.rb
    @@ -91,7 +91,7 @@

    Defined Under Namespace

    - Classes: APIKey, AWSAuth, AWSCredentials, AWSRole, AbuseReport, AbuseReportHostname, AgentIngress, AgentIngressCertJob, AgentIngressCertPolicy, AgentIngressCertStatus, ApplicationSession, ApplicationUser, BotUser, BrowserSession, CertificateAuthority, Credential, Endpoint, EndpointBackend, EndpointBackendMutate, EndpointCircuitBreaker, EndpointCompression, EndpointIPPolicy, EndpointIPPolicyMutate, EndpointMutualTLS, EndpointMutualTLSMutate, EndpointOAuth, EndpointOAuthAmazon, EndpointOAuthFacebook, EndpointOAuthGitHub, EndpointOAuthGitLab, EndpointOAuthGoogle, EndpointOAuthLinkedIn, EndpointOAuthMicrosoft, EndpointOAuthProvider, EndpointOAuthTwitch, EndpointOIDC, EndpointRequestHeaders, EndpointResponseHeaders, EndpointSAML, EndpointSAMLMutate, EndpointTLSTermination, EndpointTLSTerminationAtEdge, EndpointTrafficPolicy, EndpointUserAgentFilter, EndpointWebhookValidation, EndpointWebsocketTCPConverter, EventDestination, EventSource, EventSourceList, EventSourceReplace, EventSubscription, EventTarget, EventTargetAzureLogsIngestion, EventTargetCloudwatchLogs, EventTargetDatadog, EventTargetFirehose, EventTargetKinesis, FailoverBackend, HTTPResponseBackend, HTTPSEdge, HTTPSEdgeRoute, IPPolicy, IPPolicyRule, IPRestriction, IdentityProvider, Listable, Location, Ref, ReservedAddr, ReservedDomain, ReservedDomainCertJob, ReservedDomainCertPolicy, ReservedDomainCertStatus, SSHCertificateAuthority, SSHCredential, SSHHostCertificate, SSHUserCertificate, StaticBackend, StaticBackendTLS, TCPEdge, TLSCertificate, TLSCertificateSANs, TLSEdge, Tunnel, TunnelGroupBackend, TunnelSession, UserAgent, WeightedBackend + Classes: APIKey, AWSAuth, AWSCredentials, AWSRole, AbuseReport, AbuseReportHostname, AgentIngress, AgentIngressCertJob, AgentIngressCertPolicy, AgentIngressCertStatus, ApplicationSession, ApplicationUser, BotUser, BrowserSession, CertificateAuthority, Credential, Endpoint, EndpointBackend, EndpointBackendMutate, EndpointCircuitBreaker, EndpointCompression, EndpointIPPolicy, EndpointIPPolicyMutate, EndpointMutualTLS, EndpointMutualTLSMutate, EndpointOAuth, EndpointOAuthAmazon, EndpointOAuthFacebook, EndpointOAuthGitHub, EndpointOAuthGitLab, EndpointOAuthGoogle, EndpointOAuthLinkedIn, EndpointOAuthMicrosoft, EndpointOAuthProvider, EndpointOAuthTwitch, EndpointOIDC, EndpointRequestHeaders, EndpointResponseHeaders, EndpointSAML, EndpointSAMLMutate, EndpointTLSTermination, EndpointTLSTerminationAtEdge, EndpointTrafficPolicy, EndpointUserAgentFilter, EndpointWebhookValidation, EndpointWebsocketTCPConverter, EventDestination, EventSource, EventSourceList, EventSourceReplace, EventSubscription, EventTarget, EventTargetAzureLogsIngestion, EventTargetCloudwatchLogs, EventTargetDatadog, EventTargetFirehose, EventTargetKinesis, FailoverBackend, HTTPResponseBackend, HTTPSEdge, HTTPSEdgeRoute, IPPolicy, IPPolicyRule, IPRestriction, IdentityProvider, Listable, Location, Ref, ReservedAddr, ReservedDomain, ReservedDomainCertJob, ReservedDomainCertPolicy, ReservedDomainCertStatus, SSHCertificateAuthority, SSHCredential, SSHHostCertificate, SSHUserCertificate, Secret, StaticBackend, StaticBackendTLS, TCPEdge, TLSCertificate, TLSCertificateSANs, TLSEdge, Tunnel, TunnelGroupBackend, TunnelSession, UserAgent, Vault, WeightedBackend

    @@ -107,9 +107,9 @@

    Defined Under Namespace

    diff --git a/doc/NgrokAPI/Models/APIKey.html b/doc/NgrokAPI/Models/APIKey.html index bc178a95..aa17a5b1 100644 --- a/doc/NgrokAPI/Models/APIKey.html +++ b/doc/NgrokAPI/Models/APIKey.html @@ -1189,9 +1189,9 @@

    diff --git a/doc/NgrokAPI/Models/AWSAuth.html b/doc/NgrokAPI/Models/AWSAuth.html index fa0a0307..73c2aef5 100644 --- a/doc/NgrokAPI/Models/AWSAuth.html +++ b/doc/NgrokAPI/Models/AWSAuth.html @@ -659,9 +659,9 @@

    diff --git a/doc/NgrokAPI/Models/AWSCredentials.html b/doc/NgrokAPI/Models/AWSCredentials.html index 91abc596..7e2738f1 100644 --- a/doc/NgrokAPI/Models/AWSCredentials.html +++ b/doc/NgrokAPI/Models/AWSCredentials.html @@ -659,9 +659,9 @@

    diff --git a/doc/NgrokAPI/Models/AWSRole.html b/doc/NgrokAPI/Models/AWSRole.html index a7206485..ecf2eca0 100644 --- a/doc/NgrokAPI/Models/AWSRole.html +++ b/doc/NgrokAPI/Models/AWSRole.html @@ -585,9 +585,9 @@

    diff --git a/doc/NgrokAPI/Models/AbuseReport.html b/doc/NgrokAPI/Models/AbuseReport.html index 1d49d6cf..c5d6e391 100644 --- a/doc/NgrokAPI/Models/AbuseReport.html +++ b/doc/NgrokAPI/Models/AbuseReport.html @@ -1033,9 +1033,9 @@

    diff --git a/doc/NgrokAPI/Models/AbuseReportHostname.html b/doc/NgrokAPI/Models/AbuseReportHostname.html index 5037d6f2..340e1a42 100644 --- a/doc/NgrokAPI/Models/AbuseReportHostname.html +++ b/doc/NgrokAPI/Models/AbuseReportHostname.html @@ -659,9 +659,9 @@

    diff --git a/doc/NgrokAPI/Models/AgentIngress.html b/doc/NgrokAPI/Models/AgentIngress.html index a232266b..593e6125 100644 --- a/doc/NgrokAPI/Models/AgentIngress.html +++ b/doc/NgrokAPI/Models/AgentIngress.html @@ -1417,9 +1417,9 @@

    diff --git a/doc/NgrokAPI/Models/AgentIngressCertJob.html b/doc/NgrokAPI/Models/AgentIngressCertJob.html index 8fc58604..da766a5c 100644 --- a/doc/NgrokAPI/Models/AgentIngressCertJob.html +++ b/doc/NgrokAPI/Models/AgentIngressCertJob.html @@ -807,9 +807,9 @@

    diff --git a/doc/NgrokAPI/Models/AgentIngressCertPolicy.html b/doc/NgrokAPI/Models/AgentIngressCertPolicy.html index 83c9cd60..c7e07a10 100644 --- a/doc/NgrokAPI/Models/AgentIngressCertPolicy.html +++ b/doc/NgrokAPI/Models/AgentIngressCertPolicy.html @@ -659,9 +659,9 @@

    diff --git a/doc/NgrokAPI/Models/AgentIngressCertStatus.html b/doc/NgrokAPI/Models/AgentIngressCertStatus.html index 3be9ff07..1264cf19 100644 --- a/doc/NgrokAPI/Models/AgentIngressCertStatus.html +++ b/doc/NgrokAPI/Models/AgentIngressCertStatus.html @@ -659,9 +659,9 @@

    diff --git a/doc/NgrokAPI/Models/ApplicationSession.html b/doc/NgrokAPI/Models/ApplicationSession.html index 4d587f77..1a59ff52 100644 --- a/doc/NgrokAPI/Models/ApplicationSession.html +++ b/doc/NgrokAPI/Models/ApplicationSession.html @@ -1404,9 +1404,9 @@

    diff --git a/doc/NgrokAPI/Models/ApplicationUser.html b/doc/NgrokAPI/Models/ApplicationUser.html index 710c470e..6529c44a 100644 --- a/doc/NgrokAPI/Models/ApplicationUser.html +++ b/doc/NgrokAPI/Models/ApplicationUser.html @@ -1326,9 +1326,9 @@

    diff --git a/doc/NgrokAPI/Models/BotUser.html b/doc/NgrokAPI/Models/BotUser.html index 739a9f21..13da4f1d 100644 --- a/doc/NgrokAPI/Models/BotUser.html +++ b/doc/NgrokAPI/Models/BotUser.html @@ -1041,9 +1041,9 @@

    diff --git a/doc/NgrokAPI/Models/BrowserSession.html b/doc/NgrokAPI/Models/BrowserSession.html index 9e9c3c1f..35395e88 100644 --- a/doc/NgrokAPI/Models/BrowserSession.html +++ b/doc/NgrokAPI/Models/BrowserSession.html @@ -733,9 +733,9 @@

    diff --git a/doc/NgrokAPI/Models/CertificateAuthority.html b/doc/NgrokAPI/Models/CertificateAuthority.html index 37cce9dd..19f1a987 100644 --- a/doc/NgrokAPI/Models/CertificateAuthority.html +++ b/doc/NgrokAPI/Models/CertificateAuthority.html @@ -1485,9 +1485,9 @@

    diff --git a/doc/NgrokAPI/Models/Credential.html b/doc/NgrokAPI/Models/Credential.html index f0e363e6..9f61c91f 100644 --- a/doc/NgrokAPI/Models/Credential.html +++ b/doc/NgrokAPI/Models/Credential.html @@ -1269,9 +1269,9 @@

    diff --git a/doc/NgrokAPI/Models/Endpoint.html b/doc/NgrokAPI/Models/Endpoint.html index fc85db05..c0205dd5 100644 --- a/doc/NgrokAPI/Models/Endpoint.html +++ b/doc/NgrokAPI/Models/Endpoint.html @@ -457,7 +457,7 @@

    Instance Attribute Summary collaps
  • - #port ⇒ Object + #pooling_enabled ⇒ Object @@ -477,7 +477,7 @@

    Instance Attribute Summary collaps
    -

    Returns the value of attribute port.

    +

    Returns the value of attribute pooling_enabled.

  • @@ -486,7 +486,7 @@

    Instance Attribute Summary collaps
  • - #principal ⇒ Object + #port ⇒ Object @@ -506,7 +506,7 @@

    Instance Attribute Summary collaps
    -

    Returns the value of attribute principal.

    +

    Returns the value of attribute port.

  • @@ -515,7 +515,7 @@

    Instance Attribute Summary collaps
  • - #principal_id ⇒ Object + #principal ⇒ Object @@ -535,7 +535,7 @@

    Instance Attribute Summary collaps
    -

    Returns the value of attribute principal_id.

    +

    Returns the value of attribute principal.

  • @@ -834,7 +834,7 @@

    Instance Attribute Summary collaps
  • - #upstream_proto ⇒ Object + #upstream_protocol ⇒ Object @@ -854,7 +854,7 @@

    Instance Attribute Summary collaps
    -

    Returns the value of attribute upstream_proto.

    +

    Returns the value of attribute upstream_protocol.

  • @@ -1079,7 +1079,7 @@

  • - #update(url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil) ⇒ Object + #update(url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ Object @@ -1194,10 +1194,9 @@

    @tunnel = @attrs['tunnel'] @edge = @attrs['edge'] @upstream_url = @attrs['upstream_url'] - @upstream_proto = @attrs['upstream_proto'] + @upstream_protocol = @attrs['upstream_protocol'] @url = @attrs['url'] @principal = @attrs['principal'] - @principal_id = @attrs['principal_id'] @traffic_policy = @attrs['traffic_policy'] @bindings = @attrs['bindings'] @tunnel_session = @attrs['tunnel_session'] @@ -1205,6 +1204,7 @@

    @uri = URI(@attrs['uri']) end @name = @attrs['name'] + @pooling_enabled = @attrs['pooling_enabled'] end

  • @@ -1735,9 +1735,9 @@

    -

    +

    - #portObject (readonly) + #pooling_enabledObject (readonly) @@ -1746,7 +1746,7 @@

    -

    Returns the value of attribute port.

    +

    Returns the value of attribute pooling_enabled.

    @@ -1767,8 +1767,8 @@

    # File 'lib/ngrokapi/models/endpoint.rb', line 10
     
    -def port
    -  @port
    +def pooling_enabled
    +  @pooling_enabled
     end
    @@ -1778,9 +1778,9 @@

    -

    +

    - #principalObject (readonly) + #portObject (readonly) @@ -1789,7 +1789,7 @@

    -

    Returns the value of attribute principal.

    +

    Returns the value of attribute port.

    @@ -1810,8 +1810,8 @@

    # File 'lib/ngrokapi/models/endpoint.rb', line 10
     
    -def principal
    -  @principal
    +def port
    +  @port
     end
    @@ -1821,9 +1821,9 @@

    -

    +

    - #principal_idObject (readonly) + #principalObject (readonly) @@ -1832,7 +1832,7 @@

    -

    Returns the value of attribute principal_id.

    +

    Returns the value of attribute principal.

    @@ -1853,8 +1853,8 @@

    # File 'lib/ngrokapi/models/endpoint.rb', line 10
     
    -def principal_id
    -  @principal_id
    +def principal
    +  @principal
     end
    @@ -2294,9 +2294,9 @@

    -

    +

    - #upstream_protoObject (readonly) + #upstream_protocolObject (readonly) @@ -2305,7 +2305,7 @@

    -

    Returns the value of attribute upstream_proto.

    +

    Returns the value of attribute upstream_protocol.

    @@ -2326,8 +2326,8 @@

    # File 'lib/ngrokapi/models/endpoint.rb', line 10
     
    -def upstream_proto
    -  @upstream_proto
    +def upstream_protocol
    +  @upstream_protocol
     end
    @@ -2528,14 +2528,14 @@

     
     
    -118
    -119
    -120
     121
    -122
    +122 +123 +124 +125

    -
    # File 'lib/ngrokapi/models/endpoint.rb', line 118
    +      
    # File 'lib/ngrokapi/models/endpoint.rb', line 121
     
     def delete
       @client.delete(
    @@ -2610,7 +2610,7 @@ 

    - #update(url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil) ⇒ Object + #update(url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ Object @@ -2655,7 +2655,10 @@

    109 110 111 -112

    +112 +113 +114 +115
    # File 'lib/ngrokapi/models/endpoint.rb', line 92
    @@ -2665,20 +2668,23 @@ 

    traffic_policy: nil, description: nil, metadata: nil, - bindings: nil + bindings: nil, + pooling_enabled: False ) @url = url if url @traffic_policy = traffic_policy if traffic_policy @description = description if description @metadata = if @bindings = bindings if bindings + @pooling_enabled = pooling_enabled if pooling_enabled @client.update( id: @id, url: url, traffic_policy: traffic_policy, description: description, metadata: , - bindings: bindings + bindings: bindings, + pooling_enabled: pooling_enabled ) end

    @@ -2691,9 +2697,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointBackend.html b/doc/NgrokAPI/Models/EndpointBackend.html index d38fa2b6..e83afea2 100644 --- a/doc/NgrokAPI/Models/EndpointBackend.html +++ b/doc/NgrokAPI/Models/EndpointBackend.html @@ -659,9 +659,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointBackendMutate.html b/doc/NgrokAPI/Models/EndpointBackendMutate.html index 7e6db8d3..9bef29dc 100644 --- a/doc/NgrokAPI/Models/EndpointBackendMutate.html +++ b/doc/NgrokAPI/Models/EndpointBackendMutate.html @@ -659,9 +659,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointCircuitBreaker.html b/doc/NgrokAPI/Models/EndpointCircuitBreaker.html index 2fda0dc3..58154d2e 100644 --- a/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +++ b/doc/NgrokAPI/Models/EndpointCircuitBreaker.html @@ -955,9 +955,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointCompression.html b/doc/NgrokAPI/Models/EndpointCompression.html index 735e8c5a..d34e15d8 100644 --- a/doc/NgrokAPI/Models/EndpointCompression.html +++ b/doc/NgrokAPI/Models/EndpointCompression.html @@ -585,9 +585,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointIPPolicy.html b/doc/NgrokAPI/Models/EndpointIPPolicy.html index 54d757d5..1ae34fe0 100644 --- a/doc/NgrokAPI/Models/EndpointIPPolicy.html +++ b/doc/NgrokAPI/Models/EndpointIPPolicy.html @@ -659,9 +659,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html b/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html index 5054c230..734dc179 100644 --- a/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +++ b/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html @@ -659,9 +659,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointMutualTLS.html b/doc/NgrokAPI/Models/EndpointMutualTLS.html index 596b39d5..40779cca 100644 --- a/doc/NgrokAPI/Models/EndpointMutualTLS.html +++ b/doc/NgrokAPI/Models/EndpointMutualTLS.html @@ -659,9 +659,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html b/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html index 2a3da13c..ce586684 100644 --- a/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +++ b/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html @@ -659,9 +659,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointOAuth.html b/doc/NgrokAPI/Models/EndpointOAuth.html index dcf0a72f..1b49e929 100644 --- a/doc/NgrokAPI/Models/EndpointOAuth.html +++ b/doc/NgrokAPI/Models/EndpointOAuth.html @@ -1029,9 +1029,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointOAuthAmazon.html b/doc/NgrokAPI/Models/EndpointOAuthAmazon.html index 11c02d37..1e7b307b 100644 --- a/doc/NgrokAPI/Models/EndpointOAuthAmazon.html +++ b/doc/NgrokAPI/Models/EndpointOAuthAmazon.html @@ -881,9 +881,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointOAuthFacebook.html b/doc/NgrokAPI/Models/EndpointOAuthFacebook.html index fabde6e3..8a6207ef 100644 --- a/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +++ b/doc/NgrokAPI/Models/EndpointOAuthFacebook.html @@ -881,9 +881,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointOAuthGitHub.html b/doc/NgrokAPI/Models/EndpointOAuthGitHub.html index 68ed0da6..8de55fa4 100644 --- a/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +++ b/doc/NgrokAPI/Models/EndpointOAuthGitHub.html @@ -1029,9 +1029,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointOAuthGitLab.html b/doc/NgrokAPI/Models/EndpointOAuthGitLab.html index a7998648..7016b303 100644 --- a/doc/NgrokAPI/Models/EndpointOAuthGitLab.html +++ b/doc/NgrokAPI/Models/EndpointOAuthGitLab.html @@ -881,9 +881,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointOAuthGoogle.html b/doc/NgrokAPI/Models/EndpointOAuthGoogle.html index 0bc9bcf4..62bb2ca9 100644 --- a/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +++ b/doc/NgrokAPI/Models/EndpointOAuthGoogle.html @@ -881,9 +881,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointOAuthLinkedIn.html b/doc/NgrokAPI/Models/EndpointOAuthLinkedIn.html index 107fdbb0..e63c1254 100644 --- a/doc/NgrokAPI/Models/EndpointOAuthLinkedIn.html +++ b/doc/NgrokAPI/Models/EndpointOAuthLinkedIn.html @@ -881,9 +881,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html b/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html index 0bc5255c..9c9ba5c0 100644 --- a/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +++ b/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html @@ -881,9 +881,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointOAuthProvider.html b/doc/NgrokAPI/Models/EndpointOAuthProvider.html index da946cf1..9de4e47f 100644 --- a/doc/NgrokAPI/Models/EndpointOAuthProvider.html +++ b/doc/NgrokAPI/Models/EndpointOAuthProvider.html @@ -1103,9 +1103,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointOAuthTwitch.html b/doc/NgrokAPI/Models/EndpointOAuthTwitch.html index 638c9a25..a2bfba9a 100644 --- a/doc/NgrokAPI/Models/EndpointOAuthTwitch.html +++ b/doc/NgrokAPI/Models/EndpointOAuthTwitch.html @@ -881,9 +881,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointOIDC.html b/doc/NgrokAPI/Models/EndpointOIDC.html index 64e16392..106a982d 100644 --- a/doc/NgrokAPI/Models/EndpointOIDC.html +++ b/doc/NgrokAPI/Models/EndpointOIDC.html @@ -1177,9 +1177,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointRequestHeaders.html b/doc/NgrokAPI/Models/EndpointRequestHeaders.html index e98dbc4e..d048a7f7 100644 --- a/doc/NgrokAPI/Models/EndpointRequestHeaders.html +++ b/doc/NgrokAPI/Models/EndpointRequestHeaders.html @@ -733,9 +733,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointResponseHeaders.html b/doc/NgrokAPI/Models/EndpointResponseHeaders.html index 027a4c5e..2782a627 100644 --- a/doc/NgrokAPI/Models/EndpointResponseHeaders.html +++ b/doc/NgrokAPI/Models/EndpointResponseHeaders.html @@ -733,9 +733,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointSAML.html b/doc/NgrokAPI/Models/EndpointSAML.html index 21676c73..2a019b98 100644 --- a/doc/NgrokAPI/Models/EndpointSAML.html +++ b/doc/NgrokAPI/Models/EndpointSAML.html @@ -1633,9 +1633,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointSAMLMutate.html b/doc/NgrokAPI/Models/EndpointSAMLMutate.html index eeaf6981..c3a3730f 100644 --- a/doc/NgrokAPI/Models/EndpointSAMLMutate.html +++ b/doc/NgrokAPI/Models/EndpointSAMLMutate.html @@ -1251,9 +1251,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointTLSTermination.html b/doc/NgrokAPI/Models/EndpointTLSTermination.html index 5e858c2d..f0b4af53 100644 --- a/doc/NgrokAPI/Models/EndpointTLSTermination.html +++ b/doc/NgrokAPI/Models/EndpointTLSTermination.html @@ -733,9 +733,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html b/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html index 561862be..42245611 100644 --- a/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +++ b/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html @@ -659,9 +659,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointTrafficPolicy.html b/doc/NgrokAPI/Models/EndpointTrafficPolicy.html index c5f69539..86b8e033 100644 --- a/doc/NgrokAPI/Models/EndpointTrafficPolicy.html +++ b/doc/NgrokAPI/Models/EndpointTrafficPolicy.html @@ -659,9 +659,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointUserAgentFilter.html b/doc/NgrokAPI/Models/EndpointUserAgentFilter.html index 60b9d743..5e63b86e 100644 --- a/doc/NgrokAPI/Models/EndpointUserAgentFilter.html +++ b/doc/NgrokAPI/Models/EndpointUserAgentFilter.html @@ -733,9 +733,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointWebhookValidation.html b/doc/NgrokAPI/Models/EndpointWebhookValidation.html index d569936e..31c83d92 100644 --- a/doc/NgrokAPI/Models/EndpointWebhookValidation.html +++ b/doc/NgrokAPI/Models/EndpointWebhookValidation.html @@ -733,9 +733,9 @@

    diff --git a/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html b/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html index 31093b8f..948e1362 100644 --- a/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +++ b/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html @@ -585,9 +585,9 @@

    diff --git a/doc/NgrokAPI/Models/EventDestination.html b/doc/NgrokAPI/Models/EventDestination.html index 06c493c8..fa9b786f 100644 --- a/doc/NgrokAPI/Models/EventDestination.html +++ b/doc/NgrokAPI/Models/EventDestination.html @@ -1104,9 +1104,9 @@

    diff --git a/doc/NgrokAPI/Models/EventSource.html b/doc/NgrokAPI/Models/EventSource.html index a8100c97..1b02a4e5 100644 --- a/doc/NgrokAPI/Models/EventSource.html +++ b/doc/NgrokAPI/Models/EventSource.html @@ -663,9 +663,9 @@

    diff --git a/doc/NgrokAPI/Models/EventSourceList.html b/doc/NgrokAPI/Models/EventSourceList.html index 2eff9fe9..81644ac5 100644 --- a/doc/NgrokAPI/Models/EventSourceList.html +++ b/doc/NgrokAPI/Models/EventSourceList.html @@ -663,9 +663,9 @@

    diff --git a/doc/NgrokAPI/Models/EventSourceReplace.html b/doc/NgrokAPI/Models/EventSourceReplace.html index d6dc417e..d58f1d2d 100644 --- a/doc/NgrokAPI/Models/EventSourceReplace.html +++ b/doc/NgrokAPI/Models/EventSourceReplace.html @@ -585,9 +585,9 @@

    diff --git a/doc/NgrokAPI/Models/EventSubscription.html b/doc/NgrokAPI/Models/EventSubscription.html index 387db492..91a10839 100644 --- a/doc/NgrokAPI/Models/EventSubscription.html +++ b/doc/NgrokAPI/Models/EventSubscription.html @@ -1104,9 +1104,9 @@

    diff --git a/doc/NgrokAPI/Models/EventTarget.html b/doc/NgrokAPI/Models/EventTarget.html index 0253d562..ddb9f43e 100644 --- a/doc/NgrokAPI/Models/EventTarget.html +++ b/doc/NgrokAPI/Models/EventTarget.html @@ -881,9 +881,9 @@

    diff --git a/doc/NgrokAPI/Models/EventTargetAzureLogsIngestion.html b/doc/NgrokAPI/Models/EventTargetAzureLogsIngestion.html index dca6e700..bd159c22 100644 --- a/doc/NgrokAPI/Models/EventTargetAzureLogsIngestion.html +++ b/doc/NgrokAPI/Models/EventTargetAzureLogsIngestion.html @@ -955,9 +955,9 @@

    diff --git a/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html b/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html index 9c86df7e..4ef2dde2 100644 --- a/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +++ b/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html @@ -659,9 +659,9 @@

    diff --git a/doc/NgrokAPI/Models/EventTargetDatadog.html b/doc/NgrokAPI/Models/EventTargetDatadog.html index e9ae4510..1a164526 100644 --- a/doc/NgrokAPI/Models/EventTargetDatadog.html +++ b/doc/NgrokAPI/Models/EventTargetDatadog.html @@ -807,9 +807,9 @@

    diff --git a/doc/NgrokAPI/Models/EventTargetFirehose.html b/doc/NgrokAPI/Models/EventTargetFirehose.html index 01be2cc8..9f86ef83 100644 --- a/doc/NgrokAPI/Models/EventTargetFirehose.html +++ b/doc/NgrokAPI/Models/EventTargetFirehose.html @@ -659,9 +659,9 @@

    diff --git a/doc/NgrokAPI/Models/EventTargetKinesis.html b/doc/NgrokAPI/Models/EventTargetKinesis.html index a5de5732..7ffea94a 100644 --- a/doc/NgrokAPI/Models/EventTargetKinesis.html +++ b/doc/NgrokAPI/Models/EventTargetKinesis.html @@ -659,9 +659,9 @@

    diff --git a/doc/NgrokAPI/Models/FailoverBackend.html b/doc/NgrokAPI/Models/FailoverBackend.html index 13ab656d..1c13b3dc 100644 --- a/doc/NgrokAPI/Models/FailoverBackend.html +++ b/doc/NgrokAPI/Models/FailoverBackend.html @@ -1121,9 +1121,9 @@

    diff --git a/doc/NgrokAPI/Models/HTTPResponseBackend.html b/doc/NgrokAPI/Models/HTTPResponseBackend.html index 22cdef6f..626c4f2a 100644 --- a/doc/NgrokAPI/Models/HTTPResponseBackend.html +++ b/doc/NgrokAPI/Models/HTTPResponseBackend.html @@ -1277,9 +1277,9 @@

    diff --git a/doc/NgrokAPI/Models/HTTPSEdge.html b/doc/NgrokAPI/Models/HTTPSEdge.html index db541a61..0c2b4d6a 100644 --- a/doc/NgrokAPI/Models/HTTPSEdge.html +++ b/doc/NgrokAPI/Models/HTTPSEdge.html @@ -1355,9 +1355,9 @@

    diff --git a/doc/NgrokAPI/Models/HTTPSEdgeRoute.html b/doc/NgrokAPI/Models/HTTPSEdgeRoute.html index 4338ffc4..0b0e10e5 100644 --- a/doc/NgrokAPI/Models/HTTPSEdgeRoute.html +++ b/doc/NgrokAPI/Models/HTTPSEdgeRoute.html @@ -2321,9 +2321,9 @@

    diff --git a/doc/NgrokAPI/Models/IPPolicy.html b/doc/NgrokAPI/Models/IPPolicy.html index ceae175c..a663f0b2 100644 --- a/doc/NgrokAPI/Models/IPPolicy.html +++ b/doc/NgrokAPI/Models/IPPolicy.html @@ -1041,9 +1041,9 @@

    diff --git a/doc/NgrokAPI/Models/IPPolicyRule.html b/doc/NgrokAPI/Models/IPPolicyRule.html index b3645d7e..99872a09 100644 --- a/doc/NgrokAPI/Models/IPPolicyRule.html +++ b/doc/NgrokAPI/Models/IPPolicyRule.html @@ -1269,9 +1269,9 @@

    diff --git a/doc/NgrokAPI/Models/IPRestriction.html b/doc/NgrokAPI/Models/IPRestriction.html index 3560292c..05a18ccd 100644 --- a/doc/NgrokAPI/Models/IPRestriction.html +++ b/doc/NgrokAPI/Models/IPRestriction.html @@ -1178,9 +1178,9 @@

    diff --git a/doc/NgrokAPI/Models/IdentityProvider.html b/doc/NgrokAPI/Models/IdentityProvider.html index 98661ebc..e5c34925 100644 --- a/doc/NgrokAPI/Models/IdentityProvider.html +++ b/doc/NgrokAPI/Models/IdentityProvider.html @@ -659,9 +659,9 @@

    diff --git a/doc/NgrokAPI/Models/Listable.html b/doc/NgrokAPI/Models/Listable.html index b201256c..6fec732b 100644 --- a/doc/NgrokAPI/Models/Listable.html +++ b/doc/NgrokAPI/Models/Listable.html @@ -992,9 +992,9 @@

    diff --git a/doc/NgrokAPI/Models/Location.html b/doc/NgrokAPI/Models/Location.html index 3174235f..f1a314a7 100644 --- a/doc/NgrokAPI/Models/Location.html +++ b/doc/NgrokAPI/Models/Location.html @@ -807,9 +807,9 @@

    diff --git a/doc/NgrokAPI/Models/Ref.html b/doc/NgrokAPI/Models/Ref.html index 5cccf8be..483f03c9 100644 --- a/doc/NgrokAPI/Models/Ref.html +++ b/doc/NgrokAPI/Models/Ref.html @@ -663,9 +663,9 @@

    diff --git a/doc/NgrokAPI/Models/ReservedAddr.html b/doc/NgrokAPI/Models/ReservedAddr.html index 5a5f00d4..50682595 100644 --- a/doc/NgrokAPI/Models/ReservedAddr.html +++ b/doc/NgrokAPI/Models/ReservedAddr.html @@ -1104,9 +1104,9 @@

    diff --git a/doc/NgrokAPI/Models/ReservedDomain.html b/doc/NgrokAPI/Models/ReservedDomain.html index 082b1a4e..d7d2be24 100644 --- a/doc/NgrokAPI/Models/ReservedDomain.html +++ b/doc/NgrokAPI/Models/ReservedDomain.html @@ -1474,9 +1474,9 @@

    diff --git a/doc/NgrokAPI/Models/ReservedDomainCertJob.html b/doc/NgrokAPI/Models/ReservedDomainCertJob.html index 843130bc..63652422 100644 --- a/doc/NgrokAPI/Models/ReservedDomainCertJob.html +++ b/doc/NgrokAPI/Models/ReservedDomainCertJob.html @@ -807,9 +807,9 @@

    diff --git a/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html b/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html index bad3e3f4..144dbea7 100644 --- a/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +++ b/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html @@ -659,9 +659,9 @@

    diff --git a/doc/NgrokAPI/Models/ReservedDomainCertStatus.html b/doc/NgrokAPI/Models/ReservedDomainCertStatus.html index d78e9b77..8972d654 100644 --- a/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +++ b/doc/NgrokAPI/Models/ReservedDomainCertStatus.html @@ -659,9 +659,9 @@

    diff --git a/doc/NgrokAPI/Models/SSHCertificateAuthority.html b/doc/NgrokAPI/Models/SSHCertificateAuthority.html index 7d3a9917..422145fb 100644 --- a/doc/NgrokAPI/Models/SSHCertificateAuthority.html +++ b/doc/NgrokAPI/Models/SSHCertificateAuthority.html @@ -1189,9 +1189,9 @@

    diff --git a/doc/NgrokAPI/Models/SSHCredential.html b/doc/NgrokAPI/Models/SSHCredential.html index f8e0015b..1f3e0584 100644 --- a/doc/NgrokAPI/Models/SSHCredential.html +++ b/doc/NgrokAPI/Models/SSHCredential.html @@ -1269,9 +1269,9 @@

    diff --git a/doc/NgrokAPI/Models/SSHHostCertificate.html b/doc/NgrokAPI/Models/SSHHostCertificate.html index c9103d30..184bccf1 100644 --- a/doc/NgrokAPI/Models/SSHHostCertificate.html +++ b/doc/NgrokAPI/Models/SSHHostCertificate.html @@ -1559,9 +1559,9 @@

    diff --git a/doc/NgrokAPI/Models/SSHUserCertificate.html b/doc/NgrokAPI/Models/SSHUserCertificate.html index f29e62fa..7ed862f5 100644 --- a/doc/NgrokAPI/Models/SSHUserCertificate.html +++ b/doc/NgrokAPI/Models/SSHUserCertificate.html @@ -1707,9 +1707,9 @@

    diff --git a/doc/NgrokAPI/Models/Secret.html b/doc/NgrokAPI/Models/Secret.html new file mode 100644 index 00000000..1fd88549 --- /dev/null +++ b/doc/NgrokAPI/Models/Secret.html @@ -0,0 +1,1336 @@ + + + + + + + Class: NgrokAPI::Models::Secret + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: NgrokAPI::Models::Secret + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/models/secret.rb
    +
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #attrs ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute attrs.

      +
      + +
    • + + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    • + + + #created_at ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute created_at.

      +
      + +
    • + + +
    • + + + #created_by ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute created_by.

      +
      + +
    • + + +
    • + + + #description ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute description.

      +
      + +
    • + + +
    • + + + #id ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute id.

      +
      + +
    • + + +
    • + + + #last_updated_by ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute last_updated_by.

      +
      + +
    • + + +
    • + + + #metadata ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute metadata.

      +
      + +
    • + + +
    • + + + #name ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute name.

      +
      + +
    • + + +
    • + + + #updated_at ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute updated_at.

      +
      + +
    • + + +
    • + + + #uri ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute uri.

      +
      + +
    • + + +
    • + + + #vault ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute vault.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client: nil, attrs: {}) ⇒ Secret + + + + + +

    +
    + +

    Returns a new instance of Secret.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +23
    +24
    +25
    +26
    +27
    +28
    +29
    +30
    +31
    +32
    +33
    +34
    +35
    +36
    +37
    +38
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 23
    +
    +def initialize(client: nil, attrs: {})
    +  @client = client
    +  @attrs = attrs
    +  @id = @attrs['id']
    +  unless @attrs['uri'].nil?
    +    @uri = URI(@attrs['uri'])
    +  end
    +  @created_at = @attrs['created_at']
    +  @updated_at = @attrs['updated_at']
    +  @name = @attrs['name']
    +  @description = @attrs['description']
    +  @metadata = @attrs['metadata']
    +  @created_by = @attrs['created_by']
    +  @last_updated_by = @attrs['last_updated_by']
    +  @vault = @attrs['vault']
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #attrsObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute attrs.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 10
    +
    +def attrs
    +  @attrs
    +end
    +
    +
    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 10
    +
    +def client
    +  @client
    +end
    +
    +
    + + + +
    +

    + + #created_atObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute created_at.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 10
    +
    +def created_at
    +  @created_at
    +end
    +
    +
    + + + +
    +

    + + #created_byObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute created_by.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 10
    +
    +def created_by
    +  @created_by
    +end
    +
    +
    + + + +
    +

    + + #descriptionObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute description.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 10
    +
    +def description
    +  @description
    +end
    +
    +
    + + + +
    +

    + + #idObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute id.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 10
    +
    +def id
    +  @id
    +end
    +
    +
    + + + +
    +

    + + #last_updated_byObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute last_updated_by.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 10
    +
    +def last_updated_by
    +  @last_updated_by
    +end
    +
    +
    + + + +
    +

    + + #metadataObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute metadata.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 10
    +
    +def 
    +  @metadata
    +end
    +
    +
    + + + +
    +

    + + #nameObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute name.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 10
    +
    +def name
    +  @name
    +end
    +
    +
    + + + +
    +

    + + #updated_atObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute updated_at.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 10
    +
    +def updated_at
    +  @updated_at
    +end
    +
    +
    + + + +
    +

    + + #uriObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute uri.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 10
    +
    +def uri
    +  @uri
    +end
    +
    +
    + + + +
    +

    + + #vaultObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute vault.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 10
    +
    +def vault
    +  @vault
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #==(other) ⇒ Object + + + + + +

    + + + + +
    +
    +
    +
    +40
    +41
    +42
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 40
    +
    +def ==(other)
    +  @attrs == other.attrs
    +end
    +
    +
    + +
    +

    + + #deleteObject + + + + + +

    +
    + +

    Delete a Secret

    + +

    ngrok.com/docs/api#api-secrets-delete

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +56
    +57
    +58
    +59
    +60
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 56
    +
    +def delete
    +  @client.delete(
    +    id: @id
    +  )
    +end
    +
    +
    + +
    +

    + + #to_hObject + + + + + +

    + + + + +
    +
    +
    +
    +48
    +49
    +50
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 48
    +
    +def to_h
    +  @attrs.to_h
    +end
    +
    +
    + +
    +

    + + #to_sObject + + + + + +

    + + + + +
    +
    +
    +
    +44
    +45
    +46
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 44
    +
    +def to_s
    +  @attrs.to_s
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/doc/NgrokAPI/Models/StaticBackend.html b/doc/NgrokAPI/Models/StaticBackend.html index 25668cdc..4a393e3c 100644 --- a/doc/NgrokAPI/Models/StaticBackend.html +++ b/doc/NgrokAPI/Models/StaticBackend.html @@ -1201,9 +1201,9 @@

    diff --git a/doc/NgrokAPI/Models/StaticBackendTLS.html b/doc/NgrokAPI/Models/StaticBackendTLS.html index e331c3b7..c36d9009 100644 --- a/doc/NgrokAPI/Models/StaticBackendTLS.html +++ b/doc/NgrokAPI/Models/StaticBackendTLS.html @@ -585,9 +585,9 @@

    diff --git a/doc/NgrokAPI/Models/TCPEdge.html b/doc/NgrokAPI/Models/TCPEdge.html index a7097427..34cc1635 100644 --- a/doc/NgrokAPI/Models/TCPEdge.html +++ b/doc/NgrokAPI/Models/TCPEdge.html @@ -1361,9 +1361,9 @@

    diff --git a/doc/NgrokAPI/Models/TLSCertificate.html b/doc/NgrokAPI/Models/TLSCertificate.html index 69065b46..a41a860e 100644 --- a/doc/NgrokAPI/Models/TLSCertificate.html +++ b/doc/NgrokAPI/Models/TLSCertificate.html @@ -2225,9 +2225,9 @@

    diff --git a/doc/NgrokAPI/Models/TLSCertificateSANs.html b/doc/NgrokAPI/Models/TLSCertificateSANs.html index 3db90af1..e974000f 100644 --- a/doc/NgrokAPI/Models/TLSCertificateSANs.html +++ b/doc/NgrokAPI/Models/TLSCertificateSANs.html @@ -659,9 +659,9 @@

    diff --git a/doc/NgrokAPI/Models/TLSEdge.html b/doc/NgrokAPI/Models/TLSEdge.html index d8a7139b..69024ae1 100644 --- a/doc/NgrokAPI/Models/TLSEdge.html +++ b/doc/NgrokAPI/Models/TLSEdge.html @@ -1521,9 +1521,9 @@

    diff --git a/doc/NgrokAPI/Models/Tunnel.html b/doc/NgrokAPI/Models/Tunnel.html index f65dfd6c..9f8d8f77 100644 --- a/doc/NgrokAPI/Models/Tunnel.html +++ b/doc/NgrokAPI/Models/Tunnel.html @@ -1329,9 +1329,9 @@

    diff --git a/doc/NgrokAPI/Models/TunnelGroupBackend.html b/doc/NgrokAPI/Models/TunnelGroupBackend.html index 05d40f39..b8df964b 100644 --- a/doc/NgrokAPI/Models/TunnelGroupBackend.html +++ b/doc/NgrokAPI/Models/TunnelGroupBackend.html @@ -1195,9 +1195,9 @@

    diff --git a/doc/NgrokAPI/Models/TunnelSession.html b/doc/NgrokAPI/Models/TunnelSession.html index 70d2b83a..f91e73b2 100644 --- a/doc/NgrokAPI/Models/TunnelSession.html +++ b/doc/NgrokAPI/Models/TunnelSession.html @@ -1255,9 +1255,9 @@

    diff --git a/doc/NgrokAPI/Models/UserAgent.html b/doc/NgrokAPI/Models/UserAgent.html index 9d4da3a6..65eaf22b 100644 --- a/doc/NgrokAPI/Models/UserAgent.html +++ b/doc/NgrokAPI/Models/UserAgent.html @@ -955,9 +955,9 @@

    diff --git a/doc/NgrokAPI/Models/Vault.html b/doc/NgrokAPI/Models/Vault.html new file mode 100644 index 00000000..96cff26c --- /dev/null +++ b/doc/NgrokAPI/Models/Vault.html @@ -0,0 +1,1353 @@ + + + + + + + Class: NgrokAPI::Models::Vault + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: NgrokAPI::Models::Vault + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/models/vault.rb
    +
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #attrs ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute attrs.

      +
      + +
    • + + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    • + + + #created_at ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute created_at.

      +
      + +
    • + + +
    • + + + #created_by ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute created_by.

      +
      + +
    • + + +
    • + + + #description ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute description.

      +
      + +
    • + + +
    • + + + #id ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute id.

      +
      + +
    • + + +
    • + + + #last_updated_by ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute last_updated_by.

      +
      + +
    • + + +
    • + + + #metadata ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute metadata.

      +
      + +
    • + + +
    • + + + #name ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute name.

      +
      + +
    • + + +
    • + + + #updated_at ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute updated_at.

      +
      + +
    • + + +
    • + + + #uri ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute uri.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client: nil, attrs: {}) ⇒ Vault + + + + + +

    +
    + +

    Returns a new instance of Vault.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +22
    +23
    +24
    +25
    +26
    +27
    +28
    +29
    +30
    +31
    +32
    +33
    +34
    +35
    +36
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 22
    +
    +def initialize(client: nil, attrs: {})
    +  @client = client
    +  @attrs = attrs
    +  @id = @attrs['id']
    +  unless @attrs['uri'].nil?
    +    @uri = URI(@attrs['uri'])
    +  end
    +  @created_at = @attrs['created_at']
    +  @updated_at = @attrs['updated_at']
    +  @name = @attrs['name']
    +  @description = @attrs['description']
    +  @metadata = @attrs['metadata']
    +  @created_by = @attrs['created_by']
    +  @last_updated_by = @attrs['last_updated_by']
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #attrsObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute attrs.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 10
    +
    +def attrs
    +  @attrs
    +end
    +
    +
    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 10
    +
    +def client
    +  @client
    +end
    +
    +
    + + + +
    +

    + + #created_atObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute created_at.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 10
    +
    +def created_at
    +  @created_at
    +end
    +
    +
    + + + +
    +

    + + #created_byObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute created_by.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 10
    +
    +def created_by
    +  @created_by
    +end
    +
    +
    + + + +
    +

    + + #descriptionObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute description.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 10
    +
    +def description
    +  @description
    +end
    +
    +
    + + + +
    +

    + + #idObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute id.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 10
    +
    +def id
    +  @id
    +end
    +
    +
    + + + +
    +

    + + #last_updated_byObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute last_updated_by.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 10
    +
    +def last_updated_by
    +  @last_updated_by
    +end
    +
    +
    + + + +
    +

    + + #metadataObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute metadata.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 10
    +
    +def 
    +  @metadata
    +end
    +
    +
    + + + +
    +

    + + #nameObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute name.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 10
    +
    +def name
    +  @name
    +end
    +
    +
    + + + +
    +

    + + #updated_atObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute updated_at.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 10
    +
    +def updated_at
    +  @updated_at
    +end
    +
    +
    + + + +
    +

    + + #uriObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute uri.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 10
    +
    +def uri
    +  @uri
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #==(other) ⇒ Object + + + + + +

    + + + + +
    +
    +
    +
    +38
    +39
    +40
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 38
    +
    +def ==(other)
    +  @attrs == other.attrs
    +end
    +
    +
    + +
    +

    + + #deleteObject + + + + + +

    +
    + +

    Delete a Vault

    + +

    ngrok.com/docs/api#api-vaults-delete

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +74
    +75
    +76
    +77
    +78
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 74
    +
    +def delete
    +  @client.delete(
    +    id: @id
    +  )
    +end
    +
    +
    + +
    +

    + + #to_hObject + + + + + +

    + + + + +
    +
    +
    +
    +46
    +47
    +48
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 46
    +
    +def to_h
    +  @attrs.to_h
    +end
    +
    +
    + +
    +

    + + #to_sObject + + + + + +

    + + + + +
    +
    +
    +
    +42
    +43
    +44
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 42
    +
    +def to_s
    +  @attrs.to_s
    +end
    +
    +
    + +
    +

    + + #update(name: nil, metadata: nil, description: nil) ⇒ Object + + + + + +

    +
    + +

    Update an existing Vault by ID

    + +

    ngrok.com/docs/api#api-vaults-update

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +54
    +55
    +56
    +57
    +58
    +59
    +60
    +61
    +62
    +63
    +64
    +65
    +66
    +67
    +68
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 54
    +
    +def update(
    +  name: nil,
    +  metadata: nil,
    +  description: nil
    +)
    +  @name = name if name
    +  @metadata =  if 
    +  @description = description if description
    +  @client.update(
    +    id: @id,
    +    name: name,
    +    metadata: ,
    +    description: description
    +  )
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/doc/NgrokAPI/Models/WeightedBackend.html b/doc/NgrokAPI/Models/WeightedBackend.html index 94ec998c..e1989f15 100644 --- a/doc/NgrokAPI/Models/WeightedBackend.html +++ b/doc/NgrokAPI/Models/WeightedBackend.html @@ -1121,9 +1121,9 @@

    diff --git a/doc/NgrokAPI/PagedIterator.html b/doc/NgrokAPI/PagedIterator.html index daa59573..cfd690a0 100644 --- a/doc/NgrokAPI/PagedIterator.html +++ b/doc/NgrokAPI/PagedIterator.html @@ -625,9 +625,9 @@

    diff --git a/doc/NgrokAPI/Services.html b/doc/NgrokAPI/Services.html index 5b21f288..2e3e9cde 100644 --- a/doc/NgrokAPI/Services.html +++ b/doc/NgrokAPI/Services.html @@ -78,8 +78,8 @@
    Defined in:
    -
    lib/ngrokapi/services/tunnels_client.rb,
    - lib/ngrokapi/services/api_keys_client.rb,
    lib/ngrokapi/services/bot_users_client.rb,
    lib/ngrokapi/services/edges_tcp_client.rb,
    lib/ngrokapi/services/edges_tls_client.rb,
    lib/ngrokapi/services/endpoints_client.rb,
    lib/ngrokapi/services/credentials_client.rb,
    lib/ngrokapi/services/edges_https_client.rb,
    lib/ngrokapi/services/ip_policies_client.rb,
    lib/ngrokapi/services/abuse_reports_client.rb,
    lib/ngrokapi/services/event_sources_client.rb,
    lib/ngrokapi/services/reserved_addrs_client.rb,
    lib/ngrokapi/services/agent_ingresses_client.rb,
    lib/ngrokapi/services/ip_policy_rules_client.rb,
    lib/ngrokapi/services/ip_restrictions_client.rb,
    lib/ngrokapi/services/ssh_credentials_client.rb,
    lib/ngrokapi/services/static_backends_client.rb,
    lib/ngrokapi/services/tunnel_sessions_client.rb,
    lib/ngrokapi/services/reserved_domains_client.rb,
    lib/ngrokapi/services/tls_certificates_client.rb,
    lib/ngrokapi/services/application_users_client.rb,
    lib/ngrokapi/services/failover_backends_client.rb,
    lib/ngrokapi/services/weighted_backends_client.rb,
    lib/ngrokapi/services/edges_https_routes_client.rb,
    lib/ngrokapi/services/event_destinations_client.rb,
    lib/ngrokapi/services/event_subscriptions_client.rb,
    lib/ngrokapi/services/application_sessions_client.rb,
    lib/ngrokapi/services/ssh_host_certificates_client.rb,
    lib/ngrokapi/services/ssh_user_certificates_client.rb,
    lib/ngrokapi/services/tunnel_group_backends_client.rb,
    lib/ngrokapi/services/edge_route_oidc_module_client.rb,
    lib/ngrokapi/services/edge_route_saml_module_client.rb,
    lib/ngrokapi/services/http_response_backends_client.rb,
    lib/ngrokapi/services/certificate_authorities_client.rb,
    lib/ngrokapi/services/tcp_edge_backend_module_client.rb,
    lib/ngrokapi/services/tls_edge_backend_module_client.rb,
    lib/ngrokapi/services/edge_route_o_auth_module_client.rb,
    lib/ngrokapi/services/edge_route_backend_module_client.rb,
    lib/ngrokapi/services/tls_edge_mutual_tls_module_client.rb,
    lib/ngrokapi/services/ssh_certificate_authorities_client.rb,
    lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb,
    lib/ngrokapi/services/edge_route_compression_module_client.rb,
    lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb,
    lib/ngrokapi/services/tcp_edge_traffic_policy_module_client.rb,
    lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb,
    lib/ngrokapi/services/tls_edge_traffic_policy_module_client.rb,
    lib/ngrokapi/services/tls_edge_tls_termination_module_client.rb,
    lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb,
    lib/ngrokapi/services/edge_route_traffic_policy_module_client.rb,
    lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb,
    lib/ngrokapi/services/edge_route_request_headers_module_client.rb,
    lib/ngrokapi/services/https_edge_tls_termination_module_client.rb,
    lib/ngrokapi/services/edge_route_response_headers_module_client.rb,
    lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb,
    lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb,
    lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb
    +
    lib/ngrokapi/services/vaults_client.rb,
    + lib/ngrokapi/services/secrets_client.rb,
    lib/ngrokapi/services/tunnels_client.rb,
    lib/ngrokapi/services/api_keys_client.rb,
    lib/ngrokapi/services/bot_users_client.rb,
    lib/ngrokapi/services/edges_tcp_client.rb,
    lib/ngrokapi/services/edges_tls_client.rb,
    lib/ngrokapi/services/endpoints_client.rb,
    lib/ngrokapi/services/credentials_client.rb,
    lib/ngrokapi/services/edges_https_client.rb,
    lib/ngrokapi/services/ip_policies_client.rb,
    lib/ngrokapi/services/abuse_reports_client.rb,
    lib/ngrokapi/services/event_sources_client.rb,
    lib/ngrokapi/services/reserved_addrs_client.rb,
    lib/ngrokapi/services/agent_ingresses_client.rb,
    lib/ngrokapi/services/ip_policy_rules_client.rb,
    lib/ngrokapi/services/ip_restrictions_client.rb,
    lib/ngrokapi/services/ssh_credentials_client.rb,
    lib/ngrokapi/services/static_backends_client.rb,
    lib/ngrokapi/services/tunnel_sessions_client.rb,
    lib/ngrokapi/services/reserved_domains_client.rb,
    lib/ngrokapi/services/tls_certificates_client.rb,
    lib/ngrokapi/services/application_users_client.rb,
    lib/ngrokapi/services/failover_backends_client.rb,
    lib/ngrokapi/services/weighted_backends_client.rb,
    lib/ngrokapi/services/edges_https_routes_client.rb,
    lib/ngrokapi/services/event_destinations_client.rb,
    lib/ngrokapi/services/event_subscriptions_client.rb,
    lib/ngrokapi/services/application_sessions_client.rb,
    lib/ngrokapi/services/ssh_host_certificates_client.rb,
    lib/ngrokapi/services/ssh_user_certificates_client.rb,
    lib/ngrokapi/services/tunnel_group_backends_client.rb,
    lib/ngrokapi/services/edge_route_oidc_module_client.rb,
    lib/ngrokapi/services/edge_route_saml_module_client.rb,
    lib/ngrokapi/services/http_response_backends_client.rb,
    lib/ngrokapi/services/certificate_authorities_client.rb,
    lib/ngrokapi/services/tcp_edge_backend_module_client.rb,
    lib/ngrokapi/services/tls_edge_backend_module_client.rb,
    lib/ngrokapi/services/edge_route_o_auth_module_client.rb,
    lib/ngrokapi/services/edge_route_backend_module_client.rb,
    lib/ngrokapi/services/tls_edge_mutual_tls_module_client.rb,
    lib/ngrokapi/services/ssh_certificate_authorities_client.rb,
    lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb,
    lib/ngrokapi/services/edge_route_compression_module_client.rb,
    lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb,
    lib/ngrokapi/services/tcp_edge_traffic_policy_module_client.rb,
    lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb,
    lib/ngrokapi/services/tls_edge_traffic_policy_module_client.rb,
    lib/ngrokapi/services/tls_edge_tls_termination_module_client.rb,
    lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb,
    lib/ngrokapi/services/edge_route_traffic_policy_module_client.rb,
    lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb,
    lib/ngrokapi/services/edge_route_request_headers_module_client.rb,
    lib/ngrokapi/services/https_edge_tls_termination_module_client.rb,
    lib/ngrokapi/services/edge_route_response_headers_module_client.rb,
    lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb,
    lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb,
    lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb
    @@ -91,7 +91,7 @@

    Defined Under Namespace

    - Classes: APIKeysClient, AbuseReportsClient, AgentIngressesClient, ApplicationSessionsClient, ApplicationUsersClient, BotUsersClient, CertificateAuthoritiesClient, CredentialsClient, EdgeRouteBackendModuleClient, EdgeRouteCircuitBreakerModuleClient, EdgeRouteCompressionModuleClient, EdgeRouteIPRestrictionModuleClient, EdgeRouteOAuthModuleClient, EdgeRouteOIDCModuleClient, EdgeRouteRequestHeadersModuleClient, EdgeRouteResponseHeadersModuleClient, EdgeRouteSAMLModuleClient, EdgeRouteTrafficPolicyModuleClient, EdgeRouteUserAgentFilterModuleClient, EdgeRouteWebhookVerificationModuleClient, EdgeRouteWebsocketTCPConverterModuleClient, EdgesHTTPSClient, EdgesHTTPSRoutesClient, EdgesTCPClient, EdgesTLSClient, EndpointsClient, EventDestinationsClient, EventSourcesClient, EventSubscriptionsClient, FailoverBackendsClient, HTTPResponseBackendsClient, HTTPSEdgeMutualTLSModuleClient, HTTPSEdgeTLSTerminationModuleClient, IPPoliciesClient, IPPolicyRulesClient, IPRestrictionsClient, ReservedAddrsClient, ReservedDomainsClient, SSHCertificateAuthoritiesClient, SSHCredentialsClient, SSHHostCertificatesClient, SSHUserCertificatesClient, StaticBackendsClient, TCPEdgeBackendModuleClient, TCPEdgeIPRestrictionModuleClient, TCPEdgeTrafficPolicyModuleClient, TLSCertificatesClient, TLSEdgeBackendModuleClient, TLSEdgeIPRestrictionModuleClient, TLSEdgeMutualTLSModuleClient, TLSEdgeTLSTerminationModuleClient, TLSEdgeTrafficPolicyModuleClient, TunnelGroupBackendsClient, TunnelSessionsClient, TunnelsClient, WeightedBackendsClient + Classes: APIKeysClient, AbuseReportsClient, AgentIngressesClient, ApplicationSessionsClient, ApplicationUsersClient, BotUsersClient, CertificateAuthoritiesClient, CredentialsClient, EdgeRouteBackendModuleClient, EdgeRouteCircuitBreakerModuleClient, EdgeRouteCompressionModuleClient, EdgeRouteIPRestrictionModuleClient, EdgeRouteOAuthModuleClient, EdgeRouteOIDCModuleClient, EdgeRouteRequestHeadersModuleClient, EdgeRouteResponseHeadersModuleClient, EdgeRouteSAMLModuleClient, EdgeRouteTrafficPolicyModuleClient, EdgeRouteUserAgentFilterModuleClient, EdgeRouteWebhookVerificationModuleClient, EdgeRouteWebsocketTCPConverterModuleClient, EdgesHTTPSClient, EdgesHTTPSRoutesClient, EdgesTCPClient, EdgesTLSClient, EndpointsClient, EventDestinationsClient, EventSourcesClient, EventSubscriptionsClient, FailoverBackendsClient, HTTPResponseBackendsClient, HTTPSEdgeMutualTLSModuleClient, HTTPSEdgeTLSTerminationModuleClient, IPPoliciesClient, IPPolicyRulesClient, IPRestrictionsClient, ReservedAddrsClient, ReservedDomainsClient, SSHCertificateAuthoritiesClient, SSHCredentialsClient, SSHHostCertificatesClient, SSHUserCertificatesClient, SecretsClient, StaticBackendsClient, TCPEdgeBackendModuleClient, TCPEdgeIPRestrictionModuleClient, TCPEdgeTrafficPolicyModuleClient, TLSCertificatesClient, TLSEdgeBackendModuleClient, TLSEdgeIPRestrictionModuleClient, TLSEdgeMutualTLSModuleClient, TLSEdgeTLSTerminationModuleClient, TLSEdgeTrafficPolicyModuleClient, TunnelGroupBackendsClient, TunnelSessionsClient, TunnelsClient, VaultsClient, WeightedBackendsClient

    @@ -107,9 +107,9 @@

    Defined Under Namespace

    diff --git a/doc/NgrokAPI/Services/APIKeysClient.html b/doc/NgrokAPI/Services/APIKeysClient.html index 7687f840..a28f835d 100644 --- a/doc/NgrokAPI/Services/APIKeysClient.html +++ b/doc/NgrokAPI/Services/APIKeysClient.html @@ -1749,9 +1749,9 @@

    diff --git a/doc/NgrokAPI/Services/AbuseReportsClient.html b/doc/NgrokAPI/Services/AbuseReportsClient.html index 7d63260c..74fc2ed3 100644 --- a/doc/NgrokAPI/Services/AbuseReportsClient.html +++ b/doc/NgrokAPI/Services/AbuseReportsClient.html @@ -833,9 +833,9 @@

    diff --git a/doc/NgrokAPI/Services/AgentIngressesClient.html b/doc/NgrokAPI/Services/AgentIngressesClient.html index b6e27521..f74bb102 100644 --- a/doc/NgrokAPI/Services/AgentIngressesClient.html +++ b/doc/NgrokAPI/Services/AgentIngressesClient.html @@ -1823,9 +1823,9 @@

    diff --git a/doc/NgrokAPI/Services/ApplicationSessionsClient.html b/doc/NgrokAPI/Services/ApplicationSessionsClient.html index 6c1d119e..fb8dc979 100644 --- a/doc/NgrokAPI/Services/ApplicationSessionsClient.html +++ b/doc/NgrokAPI/Services/ApplicationSessionsClient.html @@ -1121,9 +1121,9 @@

    diff --git a/doc/NgrokAPI/Services/ApplicationUsersClient.html b/doc/NgrokAPI/Services/ApplicationUsersClient.html index f3205ab8..30a5cb72 100644 --- a/doc/NgrokAPI/Services/ApplicationUsersClient.html +++ b/doc/NgrokAPI/Services/ApplicationUsersClient.html @@ -1121,9 +1121,9 @@

    diff --git a/doc/NgrokAPI/Services/BotUsersClient.html b/doc/NgrokAPI/Services/BotUsersClient.html index 3e1ad1a8..4a23a130 100644 --- a/doc/NgrokAPI/Services/BotUsersClient.html +++ b/doc/NgrokAPI/Services/BotUsersClient.html @@ -1707,9 +1707,9 @@

    diff --git a/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html b/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html index 19b83ba2..5d126fba 100644 --- a/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +++ b/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html @@ -1745,9 +1745,9 @@

    diff --git a/doc/NgrokAPI/Services/CredentialsClient.html b/doc/NgrokAPI/Services/CredentialsClient.html index 996f4a09..aa6db1d8 100644 --- a/doc/NgrokAPI/Services/CredentialsClient.html +++ b/doc/NgrokAPI/Services/CredentialsClient.html @@ -1829,9 +1829,9 @@

    diff --git a/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html b/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html index d85b82c8..f3ffa65c 100644 --- a/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +++ b/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html b/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html index 361820ae..a25e8096 100644 --- a/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +++ b/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html b/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html index f18da524..82696bff 100644 --- a/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +++ b/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html b/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html index be57d581..958673c0 100644 --- a/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +++ b/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html b/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html index 4033ba5d..c2bbac5e 100644 --- a/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +++ b/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html b/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html index 76afda7c..b39d58ec 100644 --- a/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +++ b/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html b/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html index 83b81956..5f0bd63b 100644 --- a/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +++ b/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html b/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html index 649f9a2b..39b25d11 100644 --- a/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +++ b/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html b/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html index d02796e7..86d88513 100644 --- a/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +++ b/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/doc/NgrokAPI/Services/EdgeRouteTrafficPolicyModuleClient.html b/doc/NgrokAPI/Services/EdgeRouteTrafficPolicyModuleClient.html index 788f772e..3aed63be 100644 --- a/doc/NgrokAPI/Services/EdgeRouteTrafficPolicyModuleClient.html +++ b/doc/NgrokAPI/Services/EdgeRouteTrafficPolicyModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/doc/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html b/doc/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html index 73e55803..bc27bf99 100644 --- a/doc/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html +++ b/doc/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html b/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html index e69edea5..a6bcc96a 100644 --- a/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +++ b/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html b/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html index da9150a1..120f9e5e 100644 --- a/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +++ b/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/doc/NgrokAPI/Services/EdgesHTTPSClient.html b/doc/NgrokAPI/Services/EdgesHTTPSClient.html index 75ec4e60..926eebee 100644 --- a/doc/NgrokAPI/Services/EdgesHTTPSClient.html +++ b/doc/NgrokAPI/Services/EdgesHTTPSClient.html @@ -1937,9 +1937,9 @@

    diff --git a/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html b/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html index fa706698..26f28aca 100644 --- a/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +++ b/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html @@ -2715,9 +2715,9 @@

    diff --git a/doc/NgrokAPI/Services/EdgesTCPClient.html b/doc/NgrokAPI/Services/EdgesTCPClient.html index 490efa20..9a297ddc 100644 --- a/doc/NgrokAPI/Services/EdgesTCPClient.html +++ b/doc/NgrokAPI/Services/EdgesTCPClient.html @@ -2017,9 +2017,9 @@

    diff --git a/doc/NgrokAPI/Services/EdgesTLSClient.html b/doc/NgrokAPI/Services/EdgesTLSClient.html index ca3f7bcb..5f47a897 100644 --- a/doc/NgrokAPI/Services/EdgesTLSClient.html +++ b/doc/NgrokAPI/Services/EdgesTLSClient.html @@ -2137,9 +2137,9 @@

    diff --git a/doc/NgrokAPI/Services/EndpointsClient.html b/doc/NgrokAPI/Services/EndpointsClient.html index 41818e2a..35ea2fa5 100644 --- a/doc/NgrokAPI/Services/EndpointsClient.html +++ b/doc/NgrokAPI/Services/EndpointsClient.html @@ -207,7 +207,7 @@

  • - #create(url: "", type: "", traffic_policy: "", description: nil, metadata: nil, bindings: nil) ⇒ NgrokAPI::Models::Endpoint + #create(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ NgrokAPI::Models::Endpoint @@ -231,7 +231,7 @@

  • - #create!(url: "", type: "", traffic_policy: "", description: nil, metadata: nil, bindings: nil) ⇒ NgrokAPI::Models::Endpoint + #create!(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ NgrokAPI::Models::Endpoint @@ -377,7 +377,7 @@

  • - #list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable + #list(before_id: nil, limit: nil, ids: [], urls: [], url: nil) ⇒ NgrokAPI::Models::Listable @@ -401,7 +401,7 @@

  • - #list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable + #list!(before_id: nil, limit: nil, ids: [], urls: [], url: nil) ⇒ NgrokAPI::Models::Listable @@ -425,7 +425,7 @@

  • - #update(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil) ⇒ NgrokAPI::Models::Endpoint + #update(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ NgrokAPI::Models::Endpoint @@ -449,7 +449,7 @@

  • - #update!(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil) ⇒ NgrokAPI::Models::Endpoint + #update!(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ NgrokAPI::Models::Endpoint @@ -575,7 +575,7 @@

    Instance Method Details

    - #create(url: "", type: "", traffic_policy: "", description: nil, metadata: nil, bindings: nil) ⇒ NgrokAPI::Models::Endpoint + #create(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ NgrokAPI::Models::Endpoint @@ -603,8 +603,6 @@

    (string) - (defaults to: "") - —
    @@ -621,12 +619,10 @@

    (string) - (defaults to: "") - —
    -

    whether the endpoint is ephemeral (served directly by an agent-initiated tunnel) or edge (served by an edge) or cloud (represents a cloud endpoint)

    +

    Type of endpoint. Only ‘cloud’ is currently supported (represents a cloud endpoint). Defaults to ‘cloud’ if not specified.

  • @@ -639,8 +635,6 @@

    (string) - (defaults to: "") - —
    @@ -703,6 +697,19 @@

  • +
  • + + pooling_enabled + + + (boolean) + + + (defaults to: False) + + +
  • +

    Returns:

    @@ -730,7 +737,6 @@

     
     
    -37
     38
     39
     40
    @@ -743,12 +749,14 @@ 

    47 48 49 -50

    +50 +51 +52

  • -
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 37
    +      
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 38
     
    -def create(url: "", type: "", traffic_policy: "", description: nil, metadata: nil, bindings: nil)
    +def create(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: False)
       path = '/endpoints'
       replacements = {
       }
    @@ -759,6 +767,7 @@ 

    data[:description] = description if description data[:metadata] = if data[:bindings] = bindings if bindings + data[:pooling_enabled] = pooling_enabled if pooling_enabled result = @client.post(path % replacements, data: data) NgrokAPI::Models::Endpoint.new(client: self, attrs: result) end

    @@ -770,7 +779,7 @@

    - #create!(url: "", type: "", traffic_policy: "", description: nil, metadata: nil, bindings: nil) ⇒ NgrokAPI::Models::Endpoint + #create!(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ NgrokAPI::Models::Endpoint @@ -798,8 +807,6 @@

    (string) - (defaults to: "") - —
    @@ -816,12 +823,10 @@

    (string) - (defaults to: "") - —
    -

    whether the endpoint is ephemeral (served directly by an agent-initiated tunnel) or edge (served by an edge) or cloud (represents a cloud endpoint)

    +

    Type of endpoint. Only ‘cloud’ is currently supported (represents a cloud endpoint). Defaults to ‘cloud’ if not specified.

    @@ -834,8 +839,6 @@

    (string) - (defaults to: "") - —
    @@ -898,6 +901,19 @@

    +
  • + + pooling_enabled + + + (boolean) + + + (defaults to: False) + + +
  • +

    Returns:

    @@ -925,9 +941,6 @@

     
     
    -65
    -66
    -67
     68
     69
     70
    @@ -938,12 +951,16 @@ 

    75 76 77 -78

    +78 +79 +80 +81 +82

    -
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 65
    +      
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 68
     
    -def create!(url: "", type: "", traffic_policy: "", description: nil, metadata: nil, bindings: nil)
    +def create!(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: False)
       path = '/endpoints'
       replacements = {
       }
    @@ -954,6 +971,7 @@ 

    data[:description] = description if description data[:metadata] = if data[:bindings] = bindings if bindings + data[:pooling_enabled] = pooling_enabled if pooling_enabled result = @client.post(path % replacements, data: data, danger: true) NgrokAPI::Models::Endpoint.new(client: self, attrs: result) end

    @@ -1030,16 +1048,16 @@

     
     
    -230
    -231
    -232
    -233
    -234
    -235
    -236
    +246 +247 +248 +249 +250 +251 +252

    -
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 230
    +      
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 246
     
     def delete(id: "")
       path = '/endpoints/%{id}'
    @@ -1121,16 +1139,16 @@ 

     
     
    -246
    -247
    -248
    -249
    -250
    -251
    -252
    +262 +263 +264 +265 +266 +267 +268

    -
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 246
    +      
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 262
     
     def delete!(id: "")
       path = '/endpoints/%{id}'
    @@ -1212,18 +1230,18 @@ 

     
     
    -140
    -141
    -142
    -143
    -144
    -145
    -146
    -147
    -148
    +152 +153 +154 +155 +156 +157 +158 +159 +160

    -
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 140
    +      
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 152
     
     def get(id: "")
       path = '/endpoints/%{id}'
    @@ -1307,18 +1325,18 @@ 

     
     
    -158
    -159
    -160
    -161
    -162
    -163
    -164
    -165
    -166
    +170 +171 +172 +173 +174 +175 +176 +177 +178

    -
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 158
    +      
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 170
     
     def get!(id: "")
       path = '/endpoints/%{id}'
    @@ -1337,7 +1355,7 @@ 

    - #list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable + #list(before_id: nil, limit: nil, ids: [], urls: [], url: nil) ⇒ NgrokAPI::Models::Listable @@ -1381,6 +1399,32 @@

    (defaults to: nil) + + +
  • + + ids + + + (List<string>) + + + (defaults to: []) + + +
  • + +
  • + + urls + + + (List<string>) + + + (defaults to: []) + +
  • @@ -1428,12 +1472,6 @@

     
     
    -89
    -90
    -91
    -92
    -93
    -94
     95
     96
     97
    @@ -1442,15 +1480,25 @@ 

    100 101 102 -103

    +103 +104 +105 +106 +107 +108 +109 +110 +111

  • -
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 89
    +      
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 95
     
    -def list(before_id: nil, limit: nil, url: nil)
    +def list(before_id: nil, limit: nil, ids: [], urls: [], url: nil)
       result = @client.list(
         before_id: before_id,
         limit: limit,
    +    ids: ids,
    +    urls: urls,
         url: url,
         path: PATH
       )
    @@ -1470,7 +1518,7 @@ 

    - #list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable + #list!(before_id: nil, limit: nil, ids: [], urls: [], url: nil) ⇒ NgrokAPI::Models::Listable @@ -1514,6 +1562,32 @@

    (defaults to: nil) + + +
  • + + ids + + + (List<string>) + + + (defaults to: []) + + +
  • + +
  • + + urls + + + (List<string>) + + + (defaults to: []) + +
  • @@ -1561,31 +1635,35 @@

     
     
    -115
    -116
    -117
    -118
    -119
    -120
    -121
    -122
    -123
    -124
     125
     126
     127
     128
     129
     130
    -131
    +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143

  • -
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 115
    +      
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 125
     
    -def list!(before_id: nil, limit: nil, url: nil)
    +def list!(before_id: nil, limit: nil, ids: [], urls: [], url: nil)
       result = @client.list(
         before_id: before_id,
         limit: limit,
    +    ids: ids,
    +    urls: urls,
         danger: true,
         url: url,
         path: PATH
    @@ -1607,7 +1685,7 @@ 

    - #update(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil) ⇒ NgrokAPI::Models::Endpoint + #update(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ NgrokAPI::Models::Endpoint @@ -1735,6 +1813,19 @@

    +
  • + + pooling_enabled + + + (boolean) + + + (defaults to: False) + + +
  • +

    Returns:

    @@ -1762,25 +1853,26 @@

     
     
    -180
    -181
    -182
    -183
    -184
    -185
    -186
    -187
    -188
    -189
    -190
    -191
    -192
    -193
    +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207

    -
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 180
    +      
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 193
     
    -def update(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil)
    +def update(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False)
       path = '/endpoints/%{id}'
       replacements = {
         id: id,
    @@ -1791,6 +1883,7 @@ 

    data[:description] = description if description data[:metadata] = if data[:bindings] = bindings if bindings + data[:pooling_enabled] = pooling_enabled if pooling_enabled result = @client.patch(path % replacements, data: data) NgrokAPI::Models::Endpoint.new(client: self, attrs: result) end

    @@ -1802,7 +1895,7 @@

    - #update!(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil) ⇒ NgrokAPI::Models::Endpoint + #update!(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ NgrokAPI::Models::Endpoint @@ -1930,6 +2023,19 @@

    +
  • + + pooling_enabled + + + (boolean) + + + (defaults to: False) + + +
  • +

    Returns:

    @@ -1957,25 +2063,26 @@

     
     
    -208
    -209
    -210
    -211
    -212
    -213
    -214
    -215
    -216
    -217
    -218
    -219
    -220
    -221
    +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237

    -
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 208
    +      
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 223
     
    -def update!(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil)
    +def update!(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False)
       path = '/endpoints/%{id}'
       replacements = {
         id: id,
    @@ -1986,6 +2093,7 @@ 

    data[:description] = description if description data[:metadata] = if data[:bindings] = bindings if bindings + data[:pooling_enabled] = pooling_enabled if pooling_enabled result = @client.patch(path % replacements, data: data, danger: true) NgrokAPI::Models::Endpoint.new(client: self, attrs: result) end

    @@ -1999,9 +2107,9 @@

    diff --git a/doc/NgrokAPI/Services/EventDestinationsClient.html b/doc/NgrokAPI/Services/EventDestinationsClient.html index 5b0cf977..a88cde23 100644 --- a/doc/NgrokAPI/Services/EventDestinationsClient.html +++ b/doc/NgrokAPI/Services/EventDestinationsClient.html @@ -1877,9 +1877,9 @@

    diff --git a/doc/NgrokAPI/Services/EventSourcesClient.html b/doc/NgrokAPI/Services/EventSourcesClient.html index a58771a8..450f406d 100644 --- a/doc/NgrokAPI/Services/EventSourcesClient.html +++ b/doc/NgrokAPI/Services/EventSourcesClient.html @@ -1661,9 +1661,9 @@

    diff --git a/doc/NgrokAPI/Services/EventSubscriptionsClient.html b/doc/NgrokAPI/Services/EventSubscriptionsClient.html index de22f570..90a0b262 100644 --- a/doc/NgrokAPI/Services/EventSubscriptionsClient.html +++ b/doc/NgrokAPI/Services/EventSubscriptionsClient.html @@ -1877,9 +1877,9 @@

    diff --git a/doc/NgrokAPI/Services/FailoverBackendsClient.html b/doc/NgrokAPI/Services/FailoverBackendsClient.html index 35b23e18..9de85477 100644 --- a/doc/NgrokAPI/Services/FailoverBackendsClient.html +++ b/doc/NgrokAPI/Services/FailoverBackendsClient.html @@ -1789,9 +1789,9 @@

    diff --git a/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html b/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html index ed821016..bd3bb984 100644 --- a/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +++ b/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html @@ -1927,9 +1927,9 @@

    diff --git a/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html b/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html index b030a93b..17c3b797 100644 --- a/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +++ b/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html @@ -1029,9 +1029,9 @@

    diff --git a/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html b/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html index b7933f6b..fd557387 100644 --- a/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +++ b/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html @@ -1029,9 +1029,9 @@

    diff --git a/doc/NgrokAPI/Services/IPPoliciesClient.html b/doc/NgrokAPI/Services/IPPoliciesClient.html index fe2d8413..0516b066 100644 --- a/doc/NgrokAPI/Services/IPPoliciesClient.html +++ b/doc/NgrokAPI/Services/IPPoliciesClient.html @@ -1709,9 +1709,9 @@

    diff --git a/doc/NgrokAPI/Services/IPPolicyRulesClient.html b/doc/NgrokAPI/Services/IPPolicyRulesClient.html index 3c816472..f0293352 100644 --- a/doc/NgrokAPI/Services/IPPolicyRulesClient.html +++ b/doc/NgrokAPI/Services/IPPolicyRulesClient.html @@ -1857,9 +1857,9 @@

    diff --git a/doc/NgrokAPI/Services/IPRestrictionsClient.html b/doc/NgrokAPI/Services/IPRestrictionsClient.html index d111f0a0..24837129 100644 --- a/doc/NgrokAPI/Services/IPRestrictionsClient.html +++ b/doc/NgrokAPI/Services/IPRestrictionsClient.html @@ -1901,9 +1901,9 @@

    diff --git a/doc/NgrokAPI/Services/ReservedAddrsClient.html b/doc/NgrokAPI/Services/ReservedAddrsClient.html index 8f50432d..84def8a7 100644 --- a/doc/NgrokAPI/Services/ReservedAddrsClient.html +++ b/doc/NgrokAPI/Services/ReservedAddrsClient.html @@ -1749,9 +1749,9 @@

    diff --git a/doc/NgrokAPI/Services/ReservedDomainsClient.html b/doc/NgrokAPI/Services/ReservedDomainsClient.html index dddae276..72183517 100644 --- a/doc/NgrokAPI/Services/ReservedDomainsClient.html +++ b/doc/NgrokAPI/Services/ReservedDomainsClient.html @@ -2409,9 +2409,9 @@

    diff --git a/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html b/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html index 1c411ff0..836e5f67 100644 --- a/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +++ b/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html @@ -1829,9 +1829,9 @@

    diff --git a/doc/NgrokAPI/Services/SSHCredentialsClient.html b/doc/NgrokAPI/Services/SSHCredentialsClient.html index c3417e3e..a76c172f 100644 --- a/doc/NgrokAPI/Services/SSHCredentialsClient.html +++ b/doc/NgrokAPI/Services/SSHCredentialsClient.html @@ -1865,9 +1865,9 @@

    diff --git a/doc/NgrokAPI/Services/SSHHostCertificatesClient.html b/doc/NgrokAPI/Services/SSHHostCertificatesClient.html index 310be8f5..5943e447 100644 --- a/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +++ b/doc/NgrokAPI/Services/SSHHostCertificatesClient.html @@ -1901,9 +1901,9 @@

    diff --git a/doc/NgrokAPI/Services/SSHUserCertificatesClient.html b/doc/NgrokAPI/Services/SSHUserCertificatesClient.html index 5f469dae..b3426062 100644 --- a/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +++ b/doc/NgrokAPI/Services/SSHUserCertificatesClient.html @@ -1981,9 +1981,9 @@

    diff --git a/doc/NgrokAPI/Services/SecretsClient.html b/doc/NgrokAPI/Services/SecretsClient.html new file mode 100644 index 00000000..5690d9a5 --- /dev/null +++ b/doc/NgrokAPI/Services/SecretsClient.html @@ -0,0 +1,1925 @@ + + + + + + + Class: NgrokAPI::Services::SecretsClient + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: NgrokAPI::Services::SecretsClient + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/services/secrets_client.rb
    +
    + +
    + +

    Overview

    +
    + +

    Secrets is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.

    + +

    ngrok.com/docs/api#api-secrets

    + + +
    +
    +
    + + +
    + +

    + Constant Summary + collapse +

    + +
    + +
    PATH = +
    +
    + +

    The API path for the requests

    + + +
    +
    +
    + + +
    +
    +
    '/vault_secrets'
    + +
    LIST_PROPERTY = +
    +
    + +

    The List Property from the resulting API for list calls

    + + +
    +
    +
    + + +
    +
    +
    'secrets'
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client:) ⇒ SecretsClient + + + + + +

    +
    + +

    Returns a new instance of SecretsClient.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +20
    +21
    +22
    +
    +
    # File 'lib/ngrokapi/services/secrets_client.rb', line 20
    +
    +def initialize(client:)
    +  @client = client
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +18
    +19
    +20
    +
    +
    # File 'lib/ngrokapi/services/secrets_client.rb', line 18
    +
    +def client
    +  @client
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #create(name: "", value: "", metadata: "", description: "", vault_id:) ⇒ NgrokAPI::Models::Secret + + + + + +

    +
    + +

    Create a new Secret

    + +

    ngrok.com/docs/api#api-secrets-create

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + name + + + (string) + + + (defaults to: "") + + + — +
      +

      Name of secret

      +
      + +
    • + +
    • + + value + + + (string) + + + (defaults to: "") + + + — +
      +

      Value of secret

      +
      + +
    • + +
    • + + metadata + + + (string) + + + (defaults to: "") + + + — +
      +

      Arbitrary user-defined metadata for this Secret

      +
      + +
    • + +
    • + + description + + + (string) + + + (defaults to: "") + + + — +
      +

      description of Secret

      +
      + +
    • + +
    • + + vault_id + + + (string) + + + + — +
      +

      unique identifier of the referenced vault

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +35
    +36
    +37
    +38
    +39
    +40
    +41
    +42
    +43
    +44
    +45
    +46
    +47
    +
    +
    # File 'lib/ngrokapi/services/secrets_client.rb', line 35
    +
    +def create(name: "", value: "", metadata: "", description: "", vault_id:)
    +  path = '/vault_secrets'
    +  replacements = {
    +  }
    +  data = {}
    +  data[:name] = name if name
    +  data[:value] = value if value
    +  data[:metadata] =  if 
    +  data[:description] = description if description
    +  data[:vault_id] = vault_id if vault_id
    +  result = @client.post(path % replacements, data: data)
    +  NgrokAPI::Models::Secret.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #create!(name: "", value: "", metadata: "", description: "", vault_id:) ⇒ NgrokAPI::Models::Secret + + + + + +

    +
    + +

    Create a new Secret Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-secrets-create

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + name + + + (string) + + + (defaults to: "") + + + — +
      +

      Name of secret

      +
      + +
    • + +
    • + + value + + + (string) + + + (defaults to: "") + + + — +
      +

      Value of secret

      +
      + +
    • + +
    • + + metadata + + + (string) + + + (defaults to: "") + + + — +
      +

      Arbitrary user-defined metadata for this Secret

      +
      + +
    • + +
    • + + description + + + (string) + + + (defaults to: "") + + + — +
      +

      description of Secret

      +
      + +
    • + +
    • + + vault_id + + + (string) + + + + — +
      +

      unique identifier of the referenced vault

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +61
    +62
    +63
    +64
    +65
    +66
    +67
    +68
    +69
    +70
    +71
    +72
    +73
    +
    +
    # File 'lib/ngrokapi/services/secrets_client.rb', line 61
    +
    +def create!(name: "", value: "", metadata: "", description: "", vault_id:)
    +  path = '/vault_secrets'
    +  replacements = {
    +  }
    +  data = {}
    +  data[:name] = name if name
    +  data[:value] = value if value
    +  data[:metadata] =  if 
    +  data[:description] = description if description
    +  data[:vault_id] = vault_id if vault_id
    +  result = @client.post(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::Secret.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #delete(id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    + +

    Delete a Secret

    + +

    ngrok.com/docs/api#api-secrets-delete

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +133
    +134
    +135
    +136
    +137
    +138
    +139
    +
    +
    # File 'lib/ngrokapi/services/secrets_client.rb', line 133
    +
    +def delete(id: "")
    +  path = '/vault_secrets/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  @client.delete(path % replacements)
    +end
    +
    +
    + +
    +

    + + #delete!(id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    + +

    Delete a Secret Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-secrets-delete

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +149
    +150
    +151
    +152
    +153
    +154
    +155
    +
    +
    # File 'lib/ngrokapi/services/secrets_client.rb', line 149
    +
    +def delete!(id: "")
    +  path = '/vault_secrets/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  @client.delete(path % replacements, danger: true)
    +end
    +
    +
    + +
    +

    + + #get(id: "") ⇒ NgrokAPI::Models::Secret + + + + + +

    +
    + +

    Get a Secret by ID

    + +

    ngrok.com/docs/api#api-secrets-get

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +164
    +165
    +166
    +167
    +168
    +169
    +170
    +171
    +172
    +
    +
    # File 'lib/ngrokapi/services/secrets_client.rb', line 164
    +
    +def get(id: "")
    +  path = '/vault_secrets/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data)
    +  NgrokAPI::Models::Secret.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #get!(id: "") ⇒ NgrokAPI::Models::Secret + + + + + +

    +
    + +

    Get a Secret by ID Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-secrets-get

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +182
    +183
    +184
    +185
    +186
    +187
    +188
    +189
    +190
    +
    +
    # File 'lib/ngrokapi/services/secrets_client.rb', line 182
    +
    +def get!(id: "")
    +  path = '/vault_secrets/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::Secret.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable + + + + + +

    +
    + +

    List all Secrets owned by account

    + +

    ngrok.com/docs/api#api-secrets-list

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + before_id + + + (string) + + + (defaults to: nil) + + +
    • + +
    • + + limit + + + (string) + + + (defaults to: nil) + + +
    • + +
    • + + url + + + (string) + + + (defaults to: nil) + + + — +
      +

      optional and mutually exclusive from before_id and limit

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +201
    +202
    +203
    +204
    +205
    +206
    +207
    +208
    +209
    +210
    +211
    +212
    +213
    +214
    +215
    +
    +
    # File 'lib/ngrokapi/services/secrets_client.rb', line 201
    +
    +def list(before_id: nil, limit: nil, url: nil)
    +  result = @client.list(
    +    before_id: before_id,
    +    limit: limit,
    +    url: url,
    +    path: PATH
    +  )
    +
    +  NgrokAPI::Models::Listable.new(
    +    client: self,
    +    attrs: result,
    +    list_property: LIST_PROPERTY,
    +    klass: NgrokAPI::Models::Secret
    +  )
    +end
    +
    +
    + +
    +

    + + #list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable + + + + + +

    +
    + +

    List all Secrets owned by account Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-secrets-list

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + before_id + + + (string) + + + (defaults to: nil) + + +
    • + +
    • + + limit + + + (string) + + + (defaults to: nil) + + +
    • + +
    • + + url + + + (string) + + + (defaults to: nil) + + + — +
      +

      optional and mutually exclusive from before_id and limit

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +227
    +228
    +229
    +230
    +231
    +232
    +233
    +234
    +235
    +236
    +237
    +238
    +239
    +240
    +241
    +242
    +243
    +
    +
    # File 'lib/ngrokapi/services/secrets_client.rb', line 227
    +
    +def list!(before_id: nil, limit: nil, url: nil)
    +  result = @client.list(
    +    before_id: before_id,
    +    limit: limit,
    +    danger: true,
    +    url: url,
    +    path: PATH
    +  )
    +
    +  NgrokAPI::Models::Listable.new(
    +    client: self,
    +    attrs: result,
    +    list_property: LIST_PROPERTY,
    +    klass: NgrokAPI::Models::Secret,
    +    danger: true
    +  )
    +end
    +
    +
    + +
    +

    + + #update(id: "", name: nil, value: nil, metadata: nil, description: nil) ⇒ NgrokAPI::Models::Secret + + + + + +

    +
    + +

    Update an existing Secret by ID

    + +

    ngrok.com/docs/api#api-secrets-update

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      identifier for Secret

      +
      + +
    • + +
    • + + name + + + (string) + + + (defaults to: nil) + + + — +
      +

      Name of secret

      +
      + +
    • + +
    • + + value + + + (string) + + + (defaults to: nil) + + + — +
      +

      Value of secret

      +
      + +
    • + +
    • + + metadata + + + (string) + + + (defaults to: nil) + + + — +
      +

      Arbitrary user-defined metadata for this Secret

      +
      + +
    • + +
    • + + description + + + (string) + + + (defaults to: nil) + + + — +
      +

      description of Secret

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +86
    +87
    +88
    +89
    +90
    +91
    +92
    +93
    +94
    +95
    +96
    +97
    +98
    +
    +
    # File 'lib/ngrokapi/services/secrets_client.rb', line 86
    +
    +def update(id: "", name: nil, value: nil, metadata: nil, description: nil)
    +  path = '/vault_secrets/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  data[:name] = name if name
    +  data[:value] = value if value
    +  data[:metadata] =  if 
    +  data[:description] = description if description
    +  result = @client.patch(path % replacements, data: data)
    +  NgrokAPI::Models::Secret.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #update!(id: "", name: nil, value: nil, metadata: nil, description: nil) ⇒ NgrokAPI::Models::Secret + + + + + +

    +
    + +

    Update an existing Secret by ID Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-secrets-update

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      identifier for Secret

      +
      + +
    • + +
    • + + name + + + (string) + + + (defaults to: nil) + + + — +
      +

      Name of secret

      +
      + +
    • + +
    • + + value + + + (string) + + + (defaults to: nil) + + + — +
      +

      Value of secret

      +
      + +
    • + +
    • + + metadata + + + (string) + + + (defaults to: nil) + + + — +
      +

      Arbitrary user-defined metadata for this Secret

      +
      + +
    • + +
    • + + description + + + (string) + + + (defaults to: nil) + + + — +
      +

      description of Secret

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +112
    +113
    +114
    +115
    +116
    +117
    +118
    +119
    +120
    +121
    +122
    +123
    +124
    +
    +
    # File 'lib/ngrokapi/services/secrets_client.rb', line 112
    +
    +def update!(id: "", name: nil, value: nil, metadata: nil, description: nil)
    +  path = '/vault_secrets/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  data[:name] = name if name
    +  data[:value] = value if value
    +  data[:metadata] =  if 
    +  data[:description] = description if description
    +  result = @client.patch(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::Secret.new(client: self, attrs: result)
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/doc/NgrokAPI/Services/StaticBackendsClient.html b/doc/NgrokAPI/Services/StaticBackendsClient.html index 4267ed3c..cb60f694 100644 --- a/doc/NgrokAPI/Services/StaticBackendsClient.html +++ b/doc/NgrokAPI/Services/StaticBackendsClient.html @@ -1869,9 +1869,9 @@

    diff --git a/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html b/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html index b1f6e95d..4824a54e 100644 --- a/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +++ b/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html @@ -1029,9 +1029,9 @@

    diff --git a/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html b/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html index 27cb3743..33384477 100644 --- a/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +++ b/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html @@ -1029,9 +1029,9 @@

    diff --git a/doc/NgrokAPI/Services/TCPEdgeTrafficPolicyModuleClient.html b/doc/NgrokAPI/Services/TCPEdgeTrafficPolicyModuleClient.html index 240689ec..87253b11 100644 --- a/doc/NgrokAPI/Services/TCPEdgeTrafficPolicyModuleClient.html +++ b/doc/NgrokAPI/Services/TCPEdgeTrafficPolicyModuleClient.html @@ -1029,9 +1029,9 @@

    diff --git a/doc/NgrokAPI/Services/TLSCertificatesClient.html b/doc/NgrokAPI/Services/TLSCertificatesClient.html index b1ef4d94..fcd49e1e 100644 --- a/doc/NgrokAPI/Services/TLSCertificatesClient.html +++ b/doc/NgrokAPI/Services/TLSCertificatesClient.html @@ -1781,9 +1781,9 @@

    diff --git a/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html b/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html index df3f351e..89a53d4c 100644 --- a/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +++ b/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html @@ -1029,9 +1029,9 @@

    diff --git a/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html b/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html index 25fcbbfa..e50be6c5 100644 --- a/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +++ b/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html @@ -1029,9 +1029,9 @@

    diff --git a/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html b/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html index 0c7604d9..59e25861 100644 --- a/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +++ b/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html @@ -1029,9 +1029,9 @@

    diff --git a/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html b/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html index b01ce109..c1140052 100644 --- a/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +++ b/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html @@ -1029,9 +1029,9 @@

    diff --git a/doc/NgrokAPI/Services/TLSEdgeTrafficPolicyModuleClient.html b/doc/NgrokAPI/Services/TLSEdgeTrafficPolicyModuleClient.html index 173f984e..2429a517 100644 --- a/doc/NgrokAPI/Services/TLSEdgeTrafficPolicyModuleClient.html +++ b/doc/NgrokAPI/Services/TLSEdgeTrafficPolicyModuleClient.html @@ -1029,9 +1029,9 @@

    diff --git a/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html b/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html index 183ddec7..eaece049 100644 --- a/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +++ b/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html @@ -1789,9 +1789,9 @@

    diff --git a/doc/NgrokAPI/Services/TunnelSessionsClient.html b/doc/NgrokAPI/Services/TunnelSessionsClient.html index 6e07eb8c..4486de0d 100644 --- a/doc/NgrokAPI/Services/TunnelSessionsClient.html +++ b/doc/NgrokAPI/Services/TunnelSessionsClient.html @@ -1573,9 +1573,9 @@

    diff --git a/doc/NgrokAPI/Services/TunnelsClient.html b/doc/NgrokAPI/Services/TunnelsClient.html index 8686d428..35bbbfd0 100644 --- a/doc/NgrokAPI/Services/TunnelsClient.html +++ b/doc/NgrokAPI/Services/TunnelsClient.html @@ -893,9 +893,9 @@

    diff --git a/doc/NgrokAPI/Services/VaultsClient.html b/doc/NgrokAPI/Services/VaultsClient.html new file mode 100644 index 00000000..85c5a626 --- /dev/null +++ b/doc/NgrokAPI/Services/VaultsClient.html @@ -0,0 +1,1809 @@ + + + + + + + Class: NgrokAPI::Services::VaultsClient + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: NgrokAPI::Services::VaultsClient + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/services/vaults_client.rb
    +
    + +
    + +

    Overview

    +
    + +

    Vaults is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.

    + +

    ngrok.com/docs/api#api-vaults

    + + +
    +
    +
    + + +
    + +

    + Constant Summary + collapse +

    + +
    + +
    PATH = +
    +
    + +

    The API path for the requests

    + + +
    +
    +
    + + +
    +
    +
    '/vaults'
    + +
    LIST_PROPERTY = +
    +
    + +

    The List Property from the resulting API for list calls

    + + +
    +
    +
    + + +
    +
    +
    'vaults'
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client:) ⇒ VaultsClient + + + + + +

    +
    + +

    Returns a new instance of VaultsClient.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +20
    +21
    +22
    +
    +
    # File 'lib/ngrokapi/services/vaults_client.rb', line 20
    +
    +def initialize(client:)
    +  @client = client
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +18
    +19
    +20
    +
    +
    # File 'lib/ngrokapi/services/vaults_client.rb', line 18
    +
    +def client
    +  @client
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #create(name: "", metadata: "", description: "") ⇒ NgrokAPI::Models::Vault + + + + + +

    +
    + +

    Create a new Vault

    + +

    ngrok.com/docs/api#api-vaults-create

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + name + + + (string) + + + (defaults to: "") + + + — +
      +

      Name of vault

      +
      + +
    • + +
    • + + metadata + + + (string) + + + (defaults to: "") + + + — +
      +

      Arbitrary user-defined metadata for this Vault

      +
      + +
    • + +
    • + + description + + + (string) + + + (defaults to: "") + + + — +
      +

      description of Vault

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +33
    +34
    +35
    +36
    +37
    +38
    +39
    +40
    +41
    +42
    +43
    +
    +
    # File 'lib/ngrokapi/services/vaults_client.rb', line 33
    +
    +def create(name: "", metadata: "", description: "")
    +  path = '/vaults'
    +  replacements = {
    +  }
    +  data = {}
    +  data[:name] = name if name
    +  data[:metadata] =  if 
    +  data[:description] = description if description
    +  result = @client.post(path % replacements, data: data)
    +  NgrokAPI::Models::Vault.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #create!(name: "", metadata: "", description: "") ⇒ NgrokAPI::Models::Vault + + + + + +

    +
    + +

    Create a new Vault Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-vaults-create

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + name + + + (string) + + + (defaults to: "") + + + — +
      +

      Name of vault

      +
      + +
    • + +
    • + + metadata + + + (string) + + + (defaults to: "") + + + — +
      +

      Arbitrary user-defined metadata for this Vault

      +
      + +
    • + +
    • + + description + + + (string) + + + (defaults to: "") + + + — +
      +

      description of Vault

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +55
    +56
    +57
    +58
    +59
    +60
    +61
    +62
    +63
    +64
    +65
    +
    +
    # File 'lib/ngrokapi/services/vaults_client.rb', line 55
    +
    +def create!(name: "", metadata: "", description: "")
    +  path = '/vaults'
    +  replacements = {
    +  }
    +  data = {}
    +  data[:name] = name if name
    +  data[:metadata] =  if 
    +  data[:description] = description if description
    +  result = @client.post(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::Vault.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #delete(id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    + +

    Delete a Vault

    + +

    ngrok.com/docs/api#api-vaults-delete

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +121
    +122
    +123
    +124
    +125
    +126
    +127
    +
    +
    # File 'lib/ngrokapi/services/vaults_client.rb', line 121
    +
    +def delete(id: "")
    +  path = '/vaults/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  @client.delete(path % replacements)
    +end
    +
    +
    + +
    +

    + + #delete!(id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    + +

    Delete a Vault Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-vaults-delete

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +137
    +138
    +139
    +140
    +141
    +142
    +143
    +
    +
    # File 'lib/ngrokapi/services/vaults_client.rb', line 137
    +
    +def delete!(id: "")
    +  path = '/vaults/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  @client.delete(path % replacements, danger: true)
    +end
    +
    +
    + +
    +

    + + #get(id: "") ⇒ NgrokAPI::Models::Vault + + + + + +

    +
    + +

    Get a Vault by ID

    + +

    ngrok.com/docs/api#api-vaults-get

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +152
    +153
    +154
    +155
    +156
    +157
    +158
    +159
    +160
    +
    +
    # File 'lib/ngrokapi/services/vaults_client.rb', line 152
    +
    +def get(id: "")
    +  path = '/vaults/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data)
    +  NgrokAPI::Models::Vault.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #get!(id: "") ⇒ NgrokAPI::Models::Vault + + + + + +

    +
    + +

    Get a Vault by ID Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-vaults-get

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +170
    +171
    +172
    +173
    +174
    +175
    +176
    +177
    +178
    +
    +
    # File 'lib/ngrokapi/services/vaults_client.rb', line 170
    +
    +def get!(id: "")
    +  path = '/vaults/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::Vault.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable + + + + + +

    +
    + +

    List all Vaults owned by account

    + +

    ngrok.com/docs/api#api-vaults-list

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + before_id + + + (string) + + + (defaults to: nil) + + +
    • + +
    • + + limit + + + (string) + + + (defaults to: nil) + + +
    • + +
    • + + url + + + (string) + + + (defaults to: nil) + + + — +
      +

      optional and mutually exclusive from before_id and limit

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +189
    +190
    +191
    +192
    +193
    +194
    +195
    +196
    +197
    +198
    +199
    +200
    +201
    +202
    +203
    +
    +
    # File 'lib/ngrokapi/services/vaults_client.rb', line 189
    +
    +def list(before_id: nil, limit: nil, url: nil)
    +  result = @client.list(
    +    before_id: before_id,
    +    limit: limit,
    +    url: url,
    +    path: PATH
    +  )
    +
    +  NgrokAPI::Models::Listable.new(
    +    client: self,
    +    attrs: result,
    +    list_property: LIST_PROPERTY,
    +    klass: NgrokAPI::Models::Vault
    +  )
    +end
    +
    +
    + +
    +

    + + #list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable + + + + + +

    +
    + +

    List all Vaults owned by account Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-vaults-list

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + before_id + + + (string) + + + (defaults to: nil) + + +
    • + +
    • + + limit + + + (string) + + + (defaults to: nil) + + +
    • + +
    • + + url + + + (string) + + + (defaults to: nil) + + + — +
      +

      optional and mutually exclusive from before_id and limit

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +215
    +216
    +217
    +218
    +219
    +220
    +221
    +222
    +223
    +224
    +225
    +226
    +227
    +228
    +229
    +230
    +231
    +
    +
    # File 'lib/ngrokapi/services/vaults_client.rb', line 215
    +
    +def list!(before_id: nil, limit: nil, url: nil)
    +  result = @client.list(
    +    before_id: before_id,
    +    limit: limit,
    +    danger: true,
    +    url: url,
    +    path: PATH
    +  )
    +
    +  NgrokAPI::Models::Listable.new(
    +    client: self,
    +    attrs: result,
    +    list_property: LIST_PROPERTY,
    +    klass: NgrokAPI::Models::Vault,
    +    danger: true
    +  )
    +end
    +
    +
    + +
    +

    + + #update(id: "", name: nil, metadata: nil, description: nil) ⇒ NgrokAPI::Models::Vault + + + + + +

    +
    + +

    Update an existing Vault by ID

    + +

    ngrok.com/docs/api#api-vaults-update

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      identifier for Vault

      +
      + +
    • + +
    • + + name + + + (string) + + + (defaults to: nil) + + + — +
      +

      Name of vault

      +
      + +
    • + +
    • + + metadata + + + (string) + + + (defaults to: nil) + + + — +
      +

      Arbitrary user-defined metadata for this Vault

      +
      + +
    • + +
    • + + description + + + (string) + + + (defaults to: nil) + + + — +
      +

      description of Vault

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +77
    +78
    +79
    +80
    +81
    +82
    +83
    +84
    +85
    +86
    +87
    +88
    +
    +
    # File 'lib/ngrokapi/services/vaults_client.rb', line 77
    +
    +def update(id: "", name: nil, metadata: nil, description: nil)
    +  path = '/vaults/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  data[:name] = name if name
    +  data[:metadata] =  if 
    +  data[:description] = description if description
    +  result = @client.patch(path % replacements, data: data)
    +  NgrokAPI::Models::Vault.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #update!(id: "", name: nil, metadata: nil, description: nil) ⇒ NgrokAPI::Models::Vault + + + + + +

    +
    + +

    Update an existing Vault by ID Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-vaults-update

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      identifier for Vault

      +
      + +
    • + +
    • + + name + + + (string) + + + (defaults to: nil) + + + — +
      +

      Name of vault

      +
      + +
    • + +
    • + + metadata + + + (string) + + + (defaults to: nil) + + + — +
      +

      Arbitrary user-defined metadata for this Vault

      +
      + +
    • + +
    • + + description + + + (string) + + + (defaults to: nil) + + + — +
      +

      description of Vault

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +101
    +102
    +103
    +104
    +105
    +106
    +107
    +108
    +109
    +110
    +111
    +112
    +
    +
    # File 'lib/ngrokapi/services/vaults_client.rb', line 101
    +
    +def update!(id: "", name: nil, metadata: nil, description: nil)
    +  path = '/vaults/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  data[:name] = name if name
    +  data[:metadata] =  if 
    +  data[:description] = description if description
    +  result = @client.patch(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::Vault.new(client: self, attrs: result)
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/doc/NgrokAPI/Services/WeightedBackendsClient.html b/doc/NgrokAPI/Services/WeightedBackendsClient.html index 303ad75f..37d2bab6 100644 --- a/doc/NgrokAPI/Services/WeightedBackendsClient.html +++ b/doc/NgrokAPI/Services/WeightedBackendsClient.html @@ -1789,9 +1789,9 @@

    diff --git a/doc/_index.html b/doc/_index.html index 0451f5bc..fafd8640 100644 --- a/doc/_index.html +++ b/doc/_index.html @@ -1066,6 +1066,20 @@

    Namespace Listing A-Z

    +
  • + Secret + + (NgrokAPI::Models) + +
  • + +
  • + SecretsClient + + (NgrokAPI::Services) + +
  • +
  • Services @@ -1257,6 +1271,28 @@

    Namespace Listing A-Z

    +
      +
    • V
    • +
        + +
      • + Vault + + (NgrokAPI::Models) + +
      • + +
      • + VaultsClient + + (NgrokAPI::Services) + +
      • + +
      +
    + +
    • W
      • @@ -1287,9 +1323,9 @@

        Namespace Listing A-Z

        diff --git a/doc/class_list.html b/doc/class_list.html index 4b8aadfa..1dd9c62e 100644 --- a/doc/class_list.html +++ b/doc/class_list.html @@ -43,7 +43,7 @@

        Class List

        diff --git a/doc/file.README.html b/doc/file.README.html index 796d62b6..54e6bb3a 100644 --- a/doc/file.README.html +++ b/doc/file.README.html @@ -166,9 +166,9 @@

        Building (internal)

        diff --git a/doc/index.html b/doc/index.html index e12cc3ee..acebabe9 100644 --- a/doc/index.html +++ b/doc/index.html @@ -166,9 +166,9 @@

        Building (internal)

        diff --git a/doc/method_list.html b/doc/method_list.html index 6b545294..a513920d 100644 --- a/doc/method_list.html +++ b/doc/method_list.html @@ -52,6 +52,22 @@

        Method List

        +
      • +
        + #== + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #== + NgrokAPI::Models::Secret +
        +
      • + +
      • #== @@ -940,6 +956,22 @@

        Method List

      • +
      • +
        + #attrs + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #attrs + NgrokAPI::Models::Secret +
        +
      • + +
      • #attrs @@ -1972,6 +2004,22 @@

        Method List

      • +
      • +
        + #client + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #client + NgrokAPI::Models::Secret +
        +
      • + +
      • #client @@ -2229,6 +2277,14 @@

        Method List

      • +
        + #client + NgrokAPI::Services::VaultsClient +
        +
      • + + +
      • #client NgrokAPI::Models::ApplicationUser @@ -2236,7 +2292,7 @@

        Method List

      • -
      • +
      • #client NgrokAPI::Models::EndpointBackend @@ -2244,7 +2300,7 @@

        Method List

      • -
      • +
      • #client NgrokAPI::Models::FailoverBackend @@ -2252,7 +2308,7 @@

        Method List

      • -
      • +
      • #client NgrokAPI::Models::HTTPSEdgeRoute @@ -2260,7 +2316,7 @@

        Method List

      • -
      • +
      • #client NgrokAPI::Models::WeightedBackend @@ -2268,6 +2324,14 @@

        Method List

      • +
      • +
        + #client + NgrokAPI::Services::SecretsClient +
        +
      • + +
      • #client @@ -3348,6 +3412,22 @@

        Method List

      • +
      • +
        + #create + NgrokAPI::Services::VaultsClient +
        +
      • + + +
      • +
        + #create + NgrokAPI::Services::SecretsClient +
        +
      • + +
      • #create @@ -3580,6 +3660,22 @@

        Method List

      • +
      • +
        + #create! + NgrokAPI::Services::VaultsClient +
        +
      • + + +
      • +
        + #create! + NgrokAPI::Services::SecretsClient +
        +
      • + +
      • #create! @@ -3812,6 +3908,22 @@

        Method List

      • +
      • +
        + #created_at + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #created_at + NgrokAPI::Models::Secret +
        +
      • + +
      • #created_at @@ -4052,6 +4164,22 @@

        Method List

      • +
      • +
        + #created_by + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #created_by + NgrokAPI::Models::Secret +
        +
      • + +
      • #credential @@ -4132,6 +4260,22 @@

        Method List

      • +
      • +
        + #delete + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #delete + NgrokAPI::Models::Secret +
        +
      • + +
      • #delete @@ -4261,6 +4405,14 @@

        Method List

      • +
        + #delete + NgrokAPI::Services::VaultsClient +
        +
      • + + +
      • #delete NgrokAPI::Models::ApplicationUser @@ -4268,7 +4420,7 @@

        Method List

      • -
      • +
      • #delete NgrokAPI::Models::FailoverBackend @@ -4276,7 +4428,7 @@

        Method List

      • -
      • +
      • #delete NgrokAPI::Models::HTTPSEdgeRoute @@ -4284,7 +4436,7 @@

        Method List

      • -
      • +
      • #delete NgrokAPI::Models::WeightedBackend @@ -4292,6 +4444,14 @@

        Method List

      • +
      • +
        + #delete + NgrokAPI::Services::SecretsClient +
        +
      • + +
      • #delete @@ -4788,6 +4948,22 @@

        Method List

      • +
      • +
        + #delete! + NgrokAPI::Services::VaultsClient +
        +
      • + + +
      • +
        + #delete! + NgrokAPI::Services::SecretsClient +
        +
      • + +
      • #delete! @@ -5260,6 +5436,22 @@

        Method List

      • +
      • +
        + #description + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #description + NgrokAPI::Models::Secret +
        +
      • + +
      • #description @@ -6044,6 +6236,22 @@

        Method List

      • +
      • +
        + #get + NgrokAPI::Services::VaultsClient +
        +
      • + + +
      • +
        + #get + NgrokAPI::Services::SecretsClient +
        +
      • + +
      • #get @@ -6492,6 +6700,22 @@

        Method List

      • +
      • +
        + #get! + NgrokAPI::Services::VaultsClient +
        +
      • + + +
      • +
        + #get! + NgrokAPI::Services::SecretsClient +
        +
      • + +
      • #get! @@ -7044,6 +7268,22 @@

        Method List

      • +
      • +
        + #id + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #id + NgrokAPI::Models::Secret +
        +
      • + +
      • #id @@ -7388,6 +7628,22 @@

        Method List

      • +
      • +
        + #initialize + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #initialize + NgrokAPI::Models::Secret +
        +
      • + +
      • #initialize @@ -7653,6 +7909,14 @@

        Method List

      • +
        + #initialize + NgrokAPI::Services::VaultsClient +
        +
      • + + +
      • #initialize NgrokAPI::Models::ApplicationUser @@ -7660,7 +7924,7 @@

        Method List

      • -
      • +
      • #initialize NgrokAPI::Models::EndpointBackend @@ -7668,7 +7932,7 @@

        Method List

      • -
      • +
      • #initialize NgrokAPI::Models::FailoverBackend @@ -7676,7 +7940,7 @@

        Method List

      • -
      • +
      • #initialize NgrokAPI::Models::HTTPSEdgeRoute @@ -7684,7 +7948,7 @@

        Method List

      • -
      • +
      • #initialize NgrokAPI::Models::WeightedBackend @@ -7692,6 +7956,14 @@

        Method List

      • +
      • +
        + #initialize + NgrokAPI::Services::SecretsClient +
        +
      • + +
      • #initialize @@ -8788,6 +9060,22 @@

        Method List

      • +
      • +
        + #last_updated_by + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #last_updated_by + NgrokAPI::Models::Secret +
        +
      • + +
      • #lat_long_radius_km @@ -8820,6 +9108,22 @@

        Method List

      • +
      • +
        + #list + NgrokAPI::Services::VaultsClient +
        +
      • + + +
      • +
        + #list + NgrokAPI::Services::SecretsClient +
        +
      • + +
      • #list @@ -9070,24 +9374,40 @@

        Method List

      • - #list! - NgrokAPI::Services::TunnelsClient + #list! + NgrokAPI::Services::VaultsClient
      • - #list! - NgrokAPI::Services::APIKeysClient + #list! + NgrokAPI::Services::SecretsClient
      • - #list! - NgrokAPI::Services::BotUsersClient + #list! + NgrokAPI::Services::TunnelsClient +
        +
      • + + +
      • +
        + #list! + NgrokAPI::Services::APIKeysClient +
        +
      • + + +
      • +
        + #list! + NgrokAPI::Services::BotUsersClient
      • @@ -9412,6 +9732,22 @@

        Method List

        +
      • +
        + #metadata + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #metadata + NgrokAPI::Models::Secret +
        +
      • + +
      • #metadata @@ -9716,6 +10052,22 @@

        Method List

      • +
      • +
        + #name + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #name + NgrokAPI::Models::Secret +
        +
      • + +
      • #name @@ -9942,7 +10294,7 @@

        Method List

      • - #port + #pooling_enabled NgrokAPI::Models::Endpoint
      • @@ -9950,23 +10302,23 @@

        Method List

      • - #post - NgrokAPI::HttpClient + #port + NgrokAPI::Models::Endpoint
      • - #principal - NgrokAPI::Models::Endpoint + #post + NgrokAPI::HttpClient
      • - #principal_id + #principal NgrokAPI::Models::Endpoint
      • @@ -10813,6 +11165,14 @@

        Method List

      • +
        + #secrets + NgrokAPI::Client +
        +
      • + + +
      • #serial_number NgrokAPI::Models::TLSCertificate @@ -10820,7 +11180,7 @@

        Method List

      • -
      • +
      • #service NgrokAPI::Models::EventTargetDatadog @@ -10828,7 +11188,7 @@

        Method List

      • -
      • +
      • #single_logout_url NgrokAPI::Models::EndpointSAML @@ -10836,7 +11196,7 @@

        Method List

      • -
      • +
      • #sources NgrokAPI::Models::EventSourceList @@ -10844,7 +11204,7 @@

        Method List

      • -
      • +
      • #sources NgrokAPI::Models::EventSubscription @@ -10852,7 +11212,7 @@

        Method List

      • -
      • +
      • #ssh_certificate_authorities NgrokAPI::Client @@ -10860,7 +11220,7 @@

        Method List

      • -
      • +
      • #ssh_certificate_authority_id NgrokAPI::Models::SSHHostCertificate @@ -10868,7 +11228,7 @@

        Method List

      • -
      • +
      • #ssh_certificate_authority_id NgrokAPI::Models::SSHUserCertificate @@ -10876,7 +11236,7 @@

        Method List

      • -
      • +
      • #ssh_credentials NgrokAPI::Client @@ -10884,7 +11244,7 @@

        Method List

      • -
      • +
      • #ssh_host_certificates NgrokAPI::Client @@ -10892,7 +11252,7 @@

        Method List

      • -
      • +
      • #ssh_user_certificates NgrokAPI::Client @@ -10900,7 +11260,7 @@

        Method List

      • -
      • +
      • #started_at NgrokAPI::Models::Tunnel @@ -10908,7 +11268,7 @@

        Method List

      • -
      • +
      • #started_at NgrokAPI::Models::TunnelSession @@ -10916,7 +11276,7 @@

        Method List

      • -
      • +
      • #started_at NgrokAPI::Models::AgentIngressCertJob @@ -10924,7 +11284,7 @@

        Method List

      • -
      • +
      • #started_at NgrokAPI::Models::ReservedDomainCertJob @@ -10932,7 +11292,7 @@

        Method List

      • -
      • +
      • #status NgrokAPI::Models::AbuseReport @@ -10940,7 +11300,7 @@

        Method List

      • -
      • +
      • #status NgrokAPI::Models::AbuseReportHostname @@ -10948,7 +11308,7 @@

        Method List

      • -
      • +
      • #status_code NgrokAPI::Models::HTTPResponseBackend @@ -10956,7 +11316,7 @@

        Method List

      • -
      • +
      • #stop NgrokAPI::Services::TunnelSessionsClient @@ -10964,7 +11324,7 @@

        Method List

      • -
      • +
      • #stop! NgrokAPI::Services::TunnelSessionsClient @@ -10972,7 +11332,7 @@

        Method List

      • -
      • +
      • #stream_arn NgrokAPI::Models::EventTargetKinesis @@ -10980,7 +11340,7 @@

        Method List

      • -
      • +
      • #subject_alternative_names NgrokAPI::Models::TLSCertificate @@ -10988,7 +11348,7 @@

        Method List

      • -
      • +
      • #subject_common_name NgrokAPI::Models::TLSCertificate @@ -10996,7 +11356,7 @@

        Method List

      • -
      • +
      • #subject_common_name NgrokAPI::Models::CertificateAuthority @@ -11004,7 +11364,7 @@

        Method List

      • -
      • +
      • #subject_country NgrokAPI::Models::TLSCertificate @@ -11012,7 +11372,7 @@

        Method List

      • -
      • +
      • #subject_locality NgrokAPI::Models::TLSCertificate @@ -11020,7 +11380,7 @@

        Method List

      • -
      • +
      • #subject_organization NgrokAPI::Models::TLSCertificate @@ -11028,7 +11388,7 @@

        Method List

      • -
      • +
      • #subject_organizational_unit NgrokAPI::Models::TLSCertificate @@ -11036,7 +11396,7 @@

        Method List

      • -
      • +
      • #subject_province NgrokAPI::Models::TLSCertificate @@ -11044,7 +11404,7 @@

        Method List

      • -
      • +
      • #target NgrokAPI::Models::EventDestination @@ -11052,7 +11412,7 @@

        Method List

      • -
      • +
      • #tcp_addr NgrokAPI::Models::Endpoint @@ -11060,7 +11420,7 @@

        Method List

      • -
      • +
      • #teams NgrokAPI::Models::EndpointOAuthGitHub @@ -11068,7 +11428,7 @@

        Method List

      • -
      • +
      • #tenant_id NgrokAPI::Models::EventTargetAzureLogsIngestion @@ -11076,7 +11436,7 @@

        Method List

      • -
      • +
      • #terminate_at NgrokAPI::Models::EndpointTLSTermination @@ -11084,7 +11444,7 @@

        Method List

      • -
      • +
      • #tls NgrokAPI::Models::StaticBackend @@ -11092,7 +11452,7 @@

        Method List

      • -
      • +
      • #tls_certificates NgrokAPI::Client @@ -11100,7 +11460,7 @@

        Method List

      • -
      • +
      • #tls_termination NgrokAPI::Models::TLSEdge @@ -11108,7 +11468,7 @@

        Method List

      • -
      • +
      • #tls_termination NgrokAPI::Models::HTTPSEdge @@ -11116,7 +11476,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::Ref @@ -11124,7 +11484,23 @@

        Method List

      • +
      • +
        + #to_h + NgrokAPI::Models::Vault +
        +
      • + +
      • +
        + #to_h + NgrokAPI::Models::Secret +
        +
      • + + +
      • #to_h NgrokAPI::Models::Tunnel @@ -11132,7 +11508,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::APIKey @@ -11140,7 +11516,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::AWSAuth @@ -11148,7 +11524,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::AWSRole @@ -11156,7 +11532,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::BotUser @@ -11164,7 +11540,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::Endpoint @@ -11172,7 +11548,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::Location @@ -11180,7 +11556,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::TCPEdge @@ -11188,7 +11564,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::TLSEdge @@ -11196,7 +11572,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::IPPolicy @@ -11204,7 +11580,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::Credential @@ -11212,7 +11588,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::HTTPSEdge @@ -11220,7 +11596,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::UserAgent @@ -11228,7 +11604,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::AbuseReport @@ -11236,7 +11612,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EventSource @@ -11244,7 +11620,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EventTarget @@ -11252,7 +11628,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::AgentIngress @@ -11260,7 +11636,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointOIDC @@ -11268,7 +11644,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointSAML @@ -11276,7 +11652,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::ReservedAddr @@ -11284,7 +11660,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::IPPolicyRule @@ -11292,7 +11668,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::IPRestriction @@ -11300,7 +11676,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::SSHCredential @@ -11308,7 +11684,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::StaticBackend @@ -11316,7 +11692,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::TunnelSession @@ -11324,7 +11700,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::AWSCredentials @@ -11332,7 +11708,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::BrowserSession @@ -11340,7 +11716,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointOAuth @@ -11348,7 +11724,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::ReservedDomain @@ -11356,7 +11732,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::TLSCertificate @@ -11364,7 +11740,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::ApplicationUser @@ -11372,7 +11748,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointBackend @@ -11380,7 +11756,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::FailoverBackend @@ -11388,7 +11764,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::HTTPSEdgeRoute @@ -11396,7 +11772,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::WeightedBackend @@ -11404,7 +11780,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EventDestination @@ -11412,7 +11788,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EventSourceList @@ -11420,7 +11796,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::IdentityProvider @@ -11428,7 +11804,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointIPPolicy @@ -11436,7 +11812,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EventSubscription @@ -11444,7 +11820,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::StaticBackendTLS @@ -11452,7 +11828,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::ApplicationSession @@ -11460,7 +11836,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointMutualTLS @@ -11468,7 +11844,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointCompression @@ -11476,7 +11852,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointSAMLMutate @@ -11484,7 +11860,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EventSourceReplace @@ -11492,7 +11868,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EventTargetDatadog @@ -11500,7 +11876,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EventTargetKinesis @@ -11508,7 +11884,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::SSHHostCertificate @@ -11516,7 +11892,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::SSHUserCertificate @@ -11524,7 +11900,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::TunnelGroupBackend @@ -11532,7 +11908,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::AbuseReportHostname @@ -11540,7 +11916,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::CertificateAuthority @@ -11548,7 +11924,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EventTargetFirehose @@ -11556,7 +11932,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::HTTPResponseBackend @@ -11564,7 +11940,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::TLSCertificateSANs @@ -11572,7 +11948,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::AgentIngressCertJob @@ -11580,7 +11956,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointOAuthAmazon @@ -11588,7 +11964,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointOAuthGoogle @@ -11596,7 +11972,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointOAuthTwitch @@ -11604,7 +11980,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointBackendMutate @@ -11612,7 +11988,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointOAuthGitHub @@ -11620,7 +11996,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointOAuthGitLab @@ -11628,7 +12004,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointTrafficPolicy @@ -11636,7 +12012,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointCircuitBreaker @@ -11644,7 +12020,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointOAuthFacebook @@ -11652,7 +12028,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointOAuthProvider @@ -11660,7 +12036,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointRequestHeaders @@ -11668,7 +12044,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointTLSTermination @@ -11676,7 +12052,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::ReservedDomainCertJob @@ -11684,7 +12060,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::AgentIngressCertPolicy @@ -11692,7 +12068,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::AgentIngressCertStatus @@ -11700,7 +12076,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointIPPolicyMutate @@ -11708,7 +12084,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointOAuthLinkedIn @@ -11716,7 +12092,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointOAuthMicrosoft @@ -11724,7 +12100,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointResponseHeaders @@ -11732,7 +12108,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::SSHCertificateAuthority @@ -11740,7 +12116,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointMutualTLSMutate @@ -11748,7 +12124,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointUserAgentFilter @@ -11756,7 +12132,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointWebhookValidation @@ -11764,7 +12140,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::ReservedDomainCertPolicy @@ -11772,7 +12148,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::ReservedDomainCertStatus @@ -11780,7 +12156,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EventTargetCloudwatchLogs @@ -11788,7 +12164,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointTLSTerminationAtEdge @@ -11796,7 +12172,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointWebsocketTCPConverter @@ -11804,7 +12180,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EventTargetAzureLogsIngestion @@ -11812,7 +12188,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::Ref @@ -11820,7 +12196,23 @@

        Method List

      • +
      • +
        + #to_s + NgrokAPI::Models::Vault +
        +
      • + +
      • +
        + #to_s + NgrokAPI::Models::Secret +
        +
      • + + +
      • #to_s NgrokAPI::Models::Tunnel @@ -11828,7 +12220,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::APIKey @@ -11836,7 +12228,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::AWSAuth @@ -11844,7 +12236,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::AWSRole @@ -11852,7 +12244,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::BotUser @@ -11860,7 +12252,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::Endpoint @@ -11868,7 +12260,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::Listable @@ -11876,7 +12268,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::Location @@ -11884,7 +12276,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::TCPEdge @@ -11892,7 +12284,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::TLSEdge @@ -11900,7 +12292,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::IPPolicy @@ -11908,7 +12300,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::Credential @@ -11916,7 +12308,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::HTTPSEdge @@ -11924,7 +12316,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::UserAgent @@ -11932,7 +12324,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::AbuseReport @@ -11940,7 +12332,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EventSource @@ -11948,7 +12340,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EventTarget @@ -11956,7 +12348,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::AgentIngress @@ -11964,7 +12356,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointOIDC @@ -11972,7 +12364,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointSAML @@ -11980,7 +12372,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::ReservedAddr @@ -11988,7 +12380,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::IPPolicyRule @@ -11996,7 +12388,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::IPRestriction @@ -12004,7 +12396,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::SSHCredential @@ -12012,7 +12404,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::StaticBackend @@ -12020,7 +12412,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::TunnelSession @@ -12028,7 +12420,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::AWSCredentials @@ -12036,7 +12428,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::BrowserSession @@ -12044,7 +12436,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointOAuth @@ -12052,7 +12444,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::ReservedDomain @@ -12060,7 +12452,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::TLSCertificate @@ -12068,7 +12460,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::ApplicationUser @@ -12076,7 +12468,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointBackend @@ -12084,7 +12476,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::FailoverBackend @@ -12092,7 +12484,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::HTTPSEdgeRoute @@ -12100,7 +12492,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::WeightedBackend @@ -12108,7 +12500,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EventDestination @@ -12116,7 +12508,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EventSourceList @@ -12124,7 +12516,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::IdentityProvider @@ -12132,7 +12524,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointIPPolicy @@ -12140,7 +12532,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EventSubscription @@ -12148,7 +12540,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::StaticBackendTLS @@ -12156,7 +12548,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::ApplicationSession @@ -12164,7 +12556,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointMutualTLS @@ -12172,7 +12564,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointCompression @@ -12180,7 +12572,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointSAMLMutate @@ -12188,7 +12580,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EventSourceReplace @@ -12196,7 +12588,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EventTargetDatadog @@ -12204,7 +12596,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EventTargetKinesis @@ -12212,7 +12604,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::SSHHostCertificate @@ -12220,7 +12612,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::SSHUserCertificate @@ -12228,7 +12620,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::TunnelGroupBackend @@ -12236,7 +12628,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::AbuseReportHostname @@ -12244,7 +12636,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::CertificateAuthority @@ -12252,7 +12644,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EventTargetFirehose @@ -12260,7 +12652,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::HTTPResponseBackend @@ -12268,7 +12660,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::TLSCertificateSANs @@ -12276,7 +12668,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::AgentIngressCertJob @@ -12284,7 +12676,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointOAuthAmazon @@ -12292,7 +12684,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointOAuthGoogle @@ -12300,7 +12692,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointOAuthTwitch @@ -12308,7 +12700,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointBackendMutate @@ -12316,7 +12708,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointOAuthGitHub @@ -12324,7 +12716,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointOAuthGitLab @@ -12332,7 +12724,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointTrafficPolicy @@ -12340,7 +12732,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointCircuitBreaker @@ -12348,7 +12740,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointOAuthFacebook @@ -12356,7 +12748,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointOAuthProvider @@ -12364,7 +12756,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointRequestHeaders @@ -12372,7 +12764,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointTLSTermination @@ -12380,7 +12772,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::ReservedDomainCertJob @@ -12388,7 +12780,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::AgentIngressCertPolicy @@ -12396,7 +12788,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::AgentIngressCertStatus @@ -12404,7 +12796,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointIPPolicyMutate @@ -12412,7 +12804,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointOAuthLinkedIn @@ -12420,7 +12812,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointOAuthMicrosoft @@ -12428,7 +12820,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointResponseHeaders @@ -12436,7 +12828,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::SSHCertificateAuthority @@ -12444,7 +12836,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointMutualTLSMutate @@ -12452,7 +12844,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointUserAgentFilter @@ -12460,7 +12852,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointWebhookValidation @@ -12468,7 +12860,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::ReservedDomainCertPolicy @@ -12476,7 +12868,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::ReservedDomainCertStatus @@ -12484,7 +12876,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EventTargetCloudwatchLogs @@ -12492,7 +12884,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointTLSTerminationAtEdge @@ -12500,7 +12892,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointWebsocketTCPConverter @@ -12508,7 +12900,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EventTargetAzureLogsIngestion @@ -12516,7 +12908,7 @@

        Method List

      • -
      • +
      • #token NgrokAPI::Models::APIKey @@ -12524,7 +12916,7 @@

        Method List

      • -
      • +
      • #token NgrokAPI::Models::Credential @@ -12532,7 +12924,7 @@

        Method List

      • -
      • +
      • #traffic_policy NgrokAPI::Models::Endpoint @@ -12540,7 +12932,7 @@

        Method List

      • -
      • +
      • #traffic_policy NgrokAPI::Models::TCPEdge @@ -12548,7 +12940,7 @@

        Method List

      • -
      • +
      • #traffic_policy NgrokAPI::Models::TLSEdge @@ -12556,7 +12948,7 @@

        Method List

      • -
      • +
      • #traffic_policy NgrokAPI::Models::HTTPSEdgeRoute @@ -12564,7 +12956,7 @@

        Method List

      • -
      • +
      • #transport NgrokAPI::Models::TunnelSession @@ -12572,7 +12964,7 @@

        Method List

      • -
      • +
      • #tripped_duration NgrokAPI::Models::EndpointCircuitBreaker @@ -12580,7 +12972,7 @@

        Method List

      • -
      • +
      • #tunnel NgrokAPI::Models::Endpoint @@ -12588,7 +12980,7 @@

        Method List

      • -
      • +
      • #tunnel_session NgrokAPI::Models::Tunnel @@ -12596,7 +12988,7 @@

        Method List

      • -
      • +
      • #tunnel_session NgrokAPI::Models::Endpoint @@ -12604,7 +12996,7 @@

        Method List

      • -
      • +
      • #tunnel_sessions NgrokAPI::Client @@ -12612,7 +13004,7 @@

        Method List

      • -
      • +
      • #tunnels NgrokAPI::Client @@ -12620,7 +13012,7 @@

        Method List

      • -
      • +
      • #tunnels NgrokAPI::Models::TunnelGroupBackend @@ -12628,7 +13020,7 @@

        Method List

      • -
      • +
      • #twitch NgrokAPI::Models::EndpointOAuthProvider @@ -12636,7 +13028,7 @@

        Method List

      • -
      • +
      • #type NgrokAPI::Models::Endpoint @@ -12644,7 +13036,7 @@

        Method List

      • -
      • +
      • #type NgrokAPI::Models::EventSource @@ -12652,7 +13044,7 @@

        Method List

      • -
      • +
      • #type NgrokAPI::Models::IPRestriction @@ -12660,7 +13052,7 @@

        Method List

      • -
      • +
      • #type NgrokAPI::Models::EventSourceReplace @@ -12668,6 +13060,14 @@

        Method List

      • +
      • +
        + #update + NgrokAPI::Models::Vault +
        +
      • + +
      • #update @@ -12773,6 +13173,14 @@

        Method List

      • +
        + #update + NgrokAPI::Services::VaultsClient +
        +
      • + + +
      • #update NgrokAPI::Models::FailoverBackend @@ -12780,7 +13188,7 @@

        Method List

      • -
      • +
      • #update NgrokAPI::Models::HTTPSEdgeRoute @@ -12788,7 +13196,7 @@

        Method List

      • -
      • +
      • #update NgrokAPI::Models::WeightedBackend @@ -12796,6 +13204,14 @@

        Method List

      • +
      • +
        + #update + NgrokAPI::Services::SecretsClient +
        +
      • + +
      • #update @@ -13076,6 +13492,22 @@

        Method List

      • +
      • +
        + #update! + NgrokAPI::Services::VaultsClient +
        +
      • + + +
      • +
        + #update! + NgrokAPI::Services::SecretsClient +
        +
      • + +
      • #update! @@ -13308,6 +13740,22 @@

        Method List

      • +
      • +
        + #updated_at + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #updated_at + NgrokAPI::Models::Secret +
        +
      • + +
      • #updated_at @@ -13318,7 +13766,7 @@

        Method List

      • - #upstream_proto + #upstream_protocol NgrokAPI::Models::Endpoint
      • @@ -13340,6 +13788,22 @@

        Method List

        +
      • +
        + #uri + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #uri + NgrokAPI::Models::Secret +
        +
      • + +
      • #uri @@ -13700,6 +14164,22 @@

        Method List

      • +
      • +
        + #vault + NgrokAPI::Models::Secret +
        +
      • + + +
      • +
        + #vaults + NgrokAPI::Client +
        +
      • + +
      • #volume_threshold diff --git a/doc/top-level-namespace.html b/doc/top-level-namespace.html index e2d16788..c95aace6 100644 --- a/doc/top-level-namespace.html +++ b/doc/top-level-namespace.html @@ -100,9 +100,9 @@

        Defined Under Namespace

        diff --git a/docs/NgrokAPI.html b/docs/NgrokAPI.html index 7c3522f4..4f00b7ad 100644 --- a/docs/NgrokAPI.html +++ b/docs/NgrokAPI.html @@ -79,7 +79,7 @@
        Defined in:
        lib/ngrokapi.rb,
        - lib/ngrokapi/error.rb,
        lib/ngrokapi/client.rb,
        lib/ngrokapi/version.rb,
        lib/ngrokapi/models/ref.rb,
        lib/ngrokapi/http_client.rb,
        lib/ngrokapi/models/tunnel.rb,
        lib/ngrokapi/models/api_key.rb,
        lib/ngrokapi/paged_iterator.rb,
        lib/ngrokapi/models/aws_auth.rb,
        lib/ngrokapi/models/aws_role.rb,
        lib/ngrokapi/models/bot_user.rb,
        lib/ngrokapi/models/endpoint.rb,
        lib/ngrokapi/models/listable.rb,
        lib/ngrokapi/models/location.rb,
        lib/ngrokapi/models/tcp_edge.rb,
        lib/ngrokapi/models/tls_edge.rb,
        lib/ngrokapi/models/ip_policy.rb,
        lib/ngrokapi/models/credential.rb,
        lib/ngrokapi/models/https_edge.rb,
        lib/ngrokapi/models/user_agent.rb,
        lib/ngrokapi/models/abuse_report.rb,
        lib/ngrokapi/models/event_source.rb,
        lib/ngrokapi/models/event_target.rb,
        lib/ngrokapi/models/agent_ingress.rb,
        lib/ngrokapi/models/endpoint_oidc.rb,
        lib/ngrokapi/models/endpoint_saml.rb,
        lib/ngrokapi/models/reserved_addr.rb,
        lib/ngrokapi/models/ip_policy_rule.rb,
        lib/ngrokapi/models/ip_restriction.rb,
        lib/ngrokapi/models/ssh_credential.rb,
        lib/ngrokapi/models/static_backend.rb,
        lib/ngrokapi/models/tunnel_session.rb,
        lib/ngrokapi/errors/not_found_error.rb,
        lib/ngrokapi/models/aws_credentials.rb,
        lib/ngrokapi/models/browser_session.rb,
        lib/ngrokapi/models/endpoint_o_auth.rb,
        lib/ngrokapi/models/reserved_domain.rb,
        lib/ngrokapi/models/tls_certificate.rb,
        lib/ngrokapi/models/application_user.rb,
        lib/ngrokapi/models/endpoint_backend.rb,
        lib/ngrokapi/models/failover_backend.rb,
        lib/ngrokapi/models/https_edge_route.rb,
        lib/ngrokapi/models/weighted_backend.rb,
        lib/ngrokapi/services/tunnels_client.rb,
        lib/ngrokapi/models/event_destination.rb,
        lib/ngrokapi/models/event_source_list.rb,
        lib/ngrokapi/models/identity_provider.rb,
        lib/ngrokapi/services/api_keys_client.rb,
        lib/ngrokapi/models/endpoint_ip_policy.rb,
        lib/ngrokapi/models/event_subscription.rb,
        lib/ngrokapi/models/static_backend_tls.rb,
        lib/ngrokapi/services/bot_users_client.rb,
        lib/ngrokapi/services/edges_tcp_client.rb,
        lib/ngrokapi/services/edges_tls_client.rb,
        lib/ngrokapi/services/endpoints_client.rb,
        lib/ngrokapi/models/application_session.rb,
        lib/ngrokapi/models/endpoint_mutual_tls.rb,
        lib/ngrokapi/models/endpoint_compression.rb,
        lib/ngrokapi/models/endpoint_saml_mutate.rb,
        lib/ngrokapi/models/event_source_replace.rb,
        lib/ngrokapi/models/event_target_datadog.rb,
        lib/ngrokapi/models/event_target_kinesis.rb,
        lib/ngrokapi/models/ssh_host_certificate.rb,
        lib/ngrokapi/models/ssh_user_certificate.rb,
        lib/ngrokapi/models/tunnel_group_backend.rb,
        lib/ngrokapi/services/credentials_client.rb,
        lib/ngrokapi/services/edges_https_client.rb,
        lib/ngrokapi/services/ip_policies_client.rb,
        lib/ngrokapi/models/abuse_report_hostname.rb,
        lib/ngrokapi/models/certificate_authority.rb,
        lib/ngrokapi/models/event_target_firehose.rb,
        lib/ngrokapi/models/http_response_backend.rb,
        lib/ngrokapi/models/tls_certificate_sa_ns.rb,
        lib/ngrokapi/models/agent_ingress_cert_job.rb,
        lib/ngrokapi/models/endpoint_o_auth_amazon.rb,
        lib/ngrokapi/models/endpoint_o_auth_google.rb,
        lib/ngrokapi/models/endpoint_o_auth_twitch.rb,
        lib/ngrokapi/services/abuse_reports_client.rb,
        lib/ngrokapi/services/event_sources_client.rb,
        lib/ngrokapi/models/endpoint_backend_mutate.rb,
        lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,
        lib/ngrokapi/models/endpoint_o_auth_git_lab.rb,
        lib/ngrokapi/models/endpoint_traffic_policy.rb,
        lib/ngrokapi/services/reserved_addrs_client.rb,
        lib/ngrokapi/models/endpoint_circuit_breaker.rb,
        lib/ngrokapi/models/endpoint_o_auth_facebook.rb,
        lib/ngrokapi/models/endpoint_o_auth_provider.rb,
        lib/ngrokapi/models/endpoint_request_headers.rb,
        lib/ngrokapi/models/endpoint_tls_termination.rb,
        lib/ngrokapi/models/reserved_domain_cert_job.rb,
        lib/ngrokapi/services/agent_ingresses_client.rb,
        lib/ngrokapi/services/ip_policy_rules_client.rb,
        lib/ngrokapi/services/ip_restrictions_client.rb,
        lib/ngrokapi/services/ssh_credentials_client.rb,
        lib/ngrokapi/services/static_backends_client.rb,
        lib/ngrokapi/services/tunnel_sessions_client.rb,
        lib/ngrokapi/models/agent_ingress_cert_policy.rb,
        lib/ngrokapi/models/agent_ingress_cert_status.rb,
        lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,
        lib/ngrokapi/models/endpoint_o_auth_linked_in.rb,
        lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,
        lib/ngrokapi/models/endpoint_response_headers.rb,
        lib/ngrokapi/models/ssh_certificate_authority.rb,
        lib/ngrokapi/services/reserved_domains_client.rb,
        lib/ngrokapi/services/tls_certificates_client.rb,
        lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,
        lib/ngrokapi/models/endpoint_user_agent_filter.rb,
        lib/ngrokapi/services/application_users_client.rb,
        lib/ngrokapi/services/failover_backends_client.rb,
        lib/ngrokapi/services/weighted_backends_client.rb,
        lib/ngrokapi/models/endpoint_webhook_validation.rb,
        lib/ngrokapi/models/reserved_domain_cert_policy.rb,
        lib/ngrokapi/models/reserved_domain_cert_status.rb,
        lib/ngrokapi/services/edges_https_routes_client.rb,
        lib/ngrokapi/services/event_destinations_client.rb,
        lib/ngrokapi/models/event_target_cloudwatch_logs.rb,
        lib/ngrokapi/services/event_subscriptions_client.rb,
        lib/ngrokapi/services/application_sessions_client.rb,
        lib/ngrokapi/services/ssh_host_certificates_client.rb,
        lib/ngrokapi/services/ssh_user_certificates_client.rb,
        lib/ngrokapi/services/tunnel_group_backends_client.rb,
        lib/ngrokapi/services/edge_route_oidc_module_client.rb,
        lib/ngrokapi/services/edge_route_saml_module_client.rb,
        lib/ngrokapi/services/http_response_backends_client.rb,
        lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb,
        lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb,
        lib/ngrokapi/services/certificate_authorities_client.rb,
        lib/ngrokapi/services/tcp_edge_backend_module_client.rb,
        lib/ngrokapi/services/tls_edge_backend_module_client.rb,
        lib/ngrokapi/models/event_target_azure_logs_ingestion.rb,
        lib/ngrokapi/services/edge_route_o_auth_module_client.rb,
        lib/ngrokapi/services/edge_route_backend_module_client.rb,
        lib/ngrokapi/services/tls_edge_mutual_tls_module_client.rb,
        lib/ngrokapi/services/ssh_certificate_authorities_client.rb,
        lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb,
        lib/ngrokapi/services/edge_route_compression_module_client.rb,
        lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb,
        lib/ngrokapi/services/tcp_edge_traffic_policy_module_client.rb,
        lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb,
        lib/ngrokapi/services/tls_edge_traffic_policy_module_client.rb,
        lib/ngrokapi/services/tls_edge_tls_termination_module_client.rb,
        lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb,
        lib/ngrokapi/services/edge_route_traffic_policy_module_client.rb,
        lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb,
        lib/ngrokapi/services/edge_route_request_headers_module_client.rb,
        lib/ngrokapi/services/https_edge_tls_termination_module_client.rb,
        lib/ngrokapi/services/edge_route_response_headers_module_client.rb,
        lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb,
        lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb,
        lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb
        + lib/ngrokapi/error.rb,
        lib/ngrokapi/client.rb,
        lib/ngrokapi/version.rb,
        lib/ngrokapi/models/ref.rb,
        lib/ngrokapi/http_client.rb,
        lib/ngrokapi/models/vault.rb,
        lib/ngrokapi/models/secret.rb,
        lib/ngrokapi/models/tunnel.rb,
        lib/ngrokapi/models/api_key.rb,
        lib/ngrokapi/paged_iterator.rb,
        lib/ngrokapi/models/aws_auth.rb,
        lib/ngrokapi/models/aws_role.rb,
        lib/ngrokapi/models/bot_user.rb,
        lib/ngrokapi/models/endpoint.rb,
        lib/ngrokapi/models/listable.rb,
        lib/ngrokapi/models/location.rb,
        lib/ngrokapi/models/tcp_edge.rb,
        lib/ngrokapi/models/tls_edge.rb,
        lib/ngrokapi/models/ip_policy.rb,
        lib/ngrokapi/models/credential.rb,
        lib/ngrokapi/models/https_edge.rb,
        lib/ngrokapi/models/user_agent.rb,
        lib/ngrokapi/models/abuse_report.rb,
        lib/ngrokapi/models/event_source.rb,
        lib/ngrokapi/models/event_target.rb,
        lib/ngrokapi/models/agent_ingress.rb,
        lib/ngrokapi/models/endpoint_oidc.rb,
        lib/ngrokapi/models/endpoint_saml.rb,
        lib/ngrokapi/models/reserved_addr.rb,
        lib/ngrokapi/models/ip_policy_rule.rb,
        lib/ngrokapi/models/ip_restriction.rb,
        lib/ngrokapi/models/ssh_credential.rb,
        lib/ngrokapi/models/static_backend.rb,
        lib/ngrokapi/models/tunnel_session.rb,
        lib/ngrokapi/errors/not_found_error.rb,
        lib/ngrokapi/models/aws_credentials.rb,
        lib/ngrokapi/models/browser_session.rb,
        lib/ngrokapi/models/endpoint_o_auth.rb,
        lib/ngrokapi/models/reserved_domain.rb,
        lib/ngrokapi/models/tls_certificate.rb,
        lib/ngrokapi/services/vaults_client.rb,
        lib/ngrokapi/models/application_user.rb,
        lib/ngrokapi/models/endpoint_backend.rb,
        lib/ngrokapi/models/failover_backend.rb,
        lib/ngrokapi/models/https_edge_route.rb,
        lib/ngrokapi/models/weighted_backend.rb,
        lib/ngrokapi/services/secrets_client.rb,
        lib/ngrokapi/services/tunnels_client.rb,
        lib/ngrokapi/models/event_destination.rb,
        lib/ngrokapi/models/event_source_list.rb,
        lib/ngrokapi/models/identity_provider.rb,
        lib/ngrokapi/services/api_keys_client.rb,
        lib/ngrokapi/models/endpoint_ip_policy.rb,
        lib/ngrokapi/models/event_subscription.rb,
        lib/ngrokapi/models/static_backend_tls.rb,
        lib/ngrokapi/services/bot_users_client.rb,
        lib/ngrokapi/services/edges_tcp_client.rb,
        lib/ngrokapi/services/edges_tls_client.rb,
        lib/ngrokapi/services/endpoints_client.rb,
        lib/ngrokapi/models/application_session.rb,
        lib/ngrokapi/models/endpoint_mutual_tls.rb,
        lib/ngrokapi/models/endpoint_compression.rb,
        lib/ngrokapi/models/endpoint_saml_mutate.rb,
        lib/ngrokapi/models/event_source_replace.rb,
        lib/ngrokapi/models/event_target_datadog.rb,
        lib/ngrokapi/models/event_target_kinesis.rb,
        lib/ngrokapi/models/ssh_host_certificate.rb,
        lib/ngrokapi/models/ssh_user_certificate.rb,
        lib/ngrokapi/models/tunnel_group_backend.rb,
        lib/ngrokapi/services/credentials_client.rb,
        lib/ngrokapi/services/edges_https_client.rb,
        lib/ngrokapi/services/ip_policies_client.rb,
        lib/ngrokapi/models/abuse_report_hostname.rb,
        lib/ngrokapi/models/certificate_authority.rb,
        lib/ngrokapi/models/event_target_firehose.rb,
        lib/ngrokapi/models/http_response_backend.rb,
        lib/ngrokapi/models/tls_certificate_sa_ns.rb,
        lib/ngrokapi/models/agent_ingress_cert_job.rb,
        lib/ngrokapi/models/endpoint_o_auth_amazon.rb,
        lib/ngrokapi/models/endpoint_o_auth_google.rb,
        lib/ngrokapi/models/endpoint_o_auth_twitch.rb,
        lib/ngrokapi/services/abuse_reports_client.rb,
        lib/ngrokapi/services/event_sources_client.rb,
        lib/ngrokapi/models/endpoint_backend_mutate.rb,
        lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,
        lib/ngrokapi/models/endpoint_o_auth_git_lab.rb,
        lib/ngrokapi/models/endpoint_traffic_policy.rb,
        lib/ngrokapi/services/reserved_addrs_client.rb,
        lib/ngrokapi/models/endpoint_circuit_breaker.rb,
        lib/ngrokapi/models/endpoint_o_auth_facebook.rb,
        lib/ngrokapi/models/endpoint_o_auth_provider.rb,
        lib/ngrokapi/models/endpoint_request_headers.rb,
        lib/ngrokapi/models/endpoint_tls_termination.rb,
        lib/ngrokapi/models/reserved_domain_cert_job.rb,
        lib/ngrokapi/services/agent_ingresses_client.rb,
        lib/ngrokapi/services/ip_policy_rules_client.rb,
        lib/ngrokapi/services/ip_restrictions_client.rb,
        lib/ngrokapi/services/ssh_credentials_client.rb,
        lib/ngrokapi/services/static_backends_client.rb,
        lib/ngrokapi/services/tunnel_sessions_client.rb,
        lib/ngrokapi/models/agent_ingress_cert_policy.rb,
        lib/ngrokapi/models/agent_ingress_cert_status.rb,
        lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,
        lib/ngrokapi/models/endpoint_o_auth_linked_in.rb,
        lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,
        lib/ngrokapi/models/endpoint_response_headers.rb,
        lib/ngrokapi/models/ssh_certificate_authority.rb,
        lib/ngrokapi/services/reserved_domains_client.rb,
        lib/ngrokapi/services/tls_certificates_client.rb,
        lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,
        lib/ngrokapi/models/endpoint_user_agent_filter.rb,
        lib/ngrokapi/services/application_users_client.rb,
        lib/ngrokapi/services/failover_backends_client.rb,
        lib/ngrokapi/services/weighted_backends_client.rb,
        lib/ngrokapi/models/endpoint_webhook_validation.rb,
        lib/ngrokapi/models/reserved_domain_cert_policy.rb,
        lib/ngrokapi/models/reserved_domain_cert_status.rb,
        lib/ngrokapi/services/edges_https_routes_client.rb,
        lib/ngrokapi/services/event_destinations_client.rb,
        lib/ngrokapi/models/event_target_cloudwatch_logs.rb,
        lib/ngrokapi/services/event_subscriptions_client.rb,
        lib/ngrokapi/services/application_sessions_client.rb,
        lib/ngrokapi/services/ssh_host_certificates_client.rb,
        lib/ngrokapi/services/ssh_user_certificates_client.rb,
        lib/ngrokapi/services/tunnel_group_backends_client.rb,
        lib/ngrokapi/services/edge_route_oidc_module_client.rb,
        lib/ngrokapi/services/edge_route_saml_module_client.rb,
        lib/ngrokapi/services/http_response_backends_client.rb,
        lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb,
        lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb,
        lib/ngrokapi/services/certificate_authorities_client.rb,
        lib/ngrokapi/services/tcp_edge_backend_module_client.rb,
        lib/ngrokapi/services/tls_edge_backend_module_client.rb,
        lib/ngrokapi/models/event_target_azure_logs_ingestion.rb,
        lib/ngrokapi/services/edge_route_o_auth_module_client.rb,
        lib/ngrokapi/services/edge_route_backend_module_client.rb,
        lib/ngrokapi/services/tls_edge_mutual_tls_module_client.rb,
        lib/ngrokapi/services/ssh_certificate_authorities_client.rb,
        lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb,
        lib/ngrokapi/services/edge_route_compression_module_client.rb,
        lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb,
        lib/ngrokapi/services/tcp_edge_traffic_policy_module_client.rb,
        lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb,
        lib/ngrokapi/services/tls_edge_traffic_policy_module_client.rb,
        lib/ngrokapi/services/tls_edge_tls_termination_module_client.rb,
        lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb,
        lib/ngrokapi/services/edge_route_traffic_policy_module_client.rb,
        lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb,
        lib/ngrokapi/services/edge_route_request_headers_module_client.rb,
        lib/ngrokapi/services/https_edge_tls_termination_module_client.rb,
        lib/ngrokapi/services/edge_route_response_headers_module_client.rb,
        lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb,
        lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb,
        lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb
        @@ -147,9 +147,9 @@

        diff --git a/docs/NgrokAPI/Client.html b/docs/NgrokAPI/Client.html index 165f9d1f..43f40b7b 100644 --- a/docs/NgrokAPI/Client.html +++ b/docs/NgrokAPI/Client.html @@ -608,6 +608,30 @@

        Reserved Domains are hostnames that you can listen for traffic on.

        +

      • + + +
      • + + + #secrets ⇒ NgrokAPI::Services::SecretsClient + + + + + + + + + + + + + +
        +

        Secrets is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.

        +
        +
      • @@ -776,6 +800,30 @@

        Tunnels provide endpoints to access services exposed by a running ngrok agent tunnel session or an SSH reverse tunnel session.

        + + + +
      • + + + #vaults ⇒ NgrokAPI::Services::VaultsClient + + + + + + + + + + + + + +
        +

        Vaults is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.

        +
        +
      • @@ -1046,19 +1094,19 @@

         
         
        -221
        -222
        -223
        -224
        -225
        -226
        -227
        -228
        -229
        -230
        +239 +240 +241 +242 +243 +244 +245 +246 +247 +248

  • -
    # File 'lib/ngrokapi/client.rb', line 221
    +      
    # File 'lib/ngrokapi/client.rb', line 239
     
     def backends
       ns = OpenStruct.new
    @@ -1228,24 +1276,6 @@ 

     
     
    -242
    -243
    -244
    -245
    -246
    -247
    -248
    -249
    -250
    -251
    -252
    -253
    -254
    -255
    -256
    -257
    -258
    -259
     260
     261
     262
    @@ -1255,10 +1285,28 @@ 

    266 267 268 -269

    +269 +270 +271 +272 +273 +274 +275 +276 +277 +278 +279 +280 +281 +282 +283 +284 +285 +286 +287

    -
    # File 'lib/ngrokapi/client.rb', line 242
    +      
    # File 'lib/ngrokapi/client.rb', line 260
     
     def edge_modules
       ns = OpenStruct.new
    @@ -1308,18 +1356,18 @@ 

     
     
    -232
    -233
    -234
    -235
    -236
    -237
    -238
    -239
    -240
    +250 +251 +252 +253 +254 +255 +256 +257 +258

    -
    # File 'lib/ngrokapi/client.rb', line 232
    +      
    # File 'lib/ngrokapi/client.rb', line 250
     
     def edges
       ns = OpenStruct.new
    @@ -1750,9 +1798,9 @@ 

    -

    +

    - #ssh_certificate_authoritiesNgrokAPI::Services::SSHCertificateAuthoritiesClient + #secretsNgrokAPI::Services::SecretsClient @@ -1761,7 +1809,7 @@

    -

    An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.

    +

    Secrets is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.

    @@ -1774,7 +1822,7 @@

  • - (NgrokAPI::Services::SSHCertificateAuthoritiesClient) + (NgrokAPI::Services::SecretsClient) @@ -1795,6 +1843,60 @@

    # File 'lib/ngrokapi/client.rb', line 167
     
    +def secrets
    +  @_secrets ||= NgrokAPI::Services::SecretsClient.new(client: @client)
    +end
    + + + +

  • + +
    +

    + + #ssh_certificate_authoritiesNgrokAPI::Services::SSHCertificateAuthoritiesClient + + + + + +

    +
    + +

    An SSH Certificate Authority is a pair of an SSH Certificate and its private key that can be used to sign other SSH host and user certificates.

    + + +
    +
    +
    + +

    Returns:

    + + +
    + + +
    +
    +
    +
    +176
    +177
    +178
    +
    +
    # File 'lib/ngrokapi/client.rb', line 176
    +
     def ssh_certificate_authorities
       @_ssh_certificate_authorities ||= NgrokAPI::Services::SSHCertificateAuthoritiesClient.new(client: @client)
     end
    @@ -1842,12 +1944,12 @@

     
     
    -176
    -177
    -178
    +185 +186 +187

    -
    # File 'lib/ngrokapi/client.rb', line 176
    +      
    # File 'lib/ngrokapi/client.rb', line 185
     
     def ssh_credentials
       @_ssh_credentials ||= NgrokAPI::Services::SSHCredentialsClient.new(client: @client)
    @@ -1896,12 +1998,12 @@ 

     
     
    -186
    -187
    -188
    +195 +196 +197

    -
    # File 'lib/ngrokapi/client.rb', line 186
    +      
    # File 'lib/ngrokapi/client.rb', line 195
     
     def ssh_host_certificates
       @_ssh_host_certificates ||= NgrokAPI::Services::SSHHostCertificatesClient.new(client: @client)
    @@ -1950,12 +2052,12 @@ 

     
     
    -196
    -197
    -198
    +205 +206 +207

    -
    # File 'lib/ngrokapi/client.rb', line 196
    +      
    # File 'lib/ngrokapi/client.rb', line 205
     
     def ssh_user_certificates
       @_ssh_user_certificates ||= NgrokAPI::Services::SSHUserCertificatesClient.new(client: @client)
    @@ -2004,12 +2106,12 @@ 

     
     
    -208
    -209
    -210
    +217 +218 +219

    -
    # File 'lib/ngrokapi/client.rb', line 208
    +      
    # File 'lib/ngrokapi/client.rb', line 217
     
     def tls_certificates
       @_tls_certificates ||= NgrokAPI::Services::TLSCertificatesClient.new(client: @client)
    @@ -2112,12 +2214,12 @@ 

     
     
    -217
    -218
    -219
    +226 +227 +228

    -
    # File 'lib/ngrokapi/client.rb', line 217
    +      
    # File 'lib/ngrokapi/client.rb', line 226
     
     def tunnels
       @_tunnels ||= NgrokAPI::Services::TunnelsClient.new(client: @client)
    @@ -2125,6 +2227,60 @@ 

    +
    + +
    +

    + + #vaultsNgrokAPI::Services::VaultsClient + + + + + +

    +
    + +

    Vaults is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.

    + + +
    +
    +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +235
    +236
    +237
    +
    +
    # File 'lib/ngrokapi/client.rb', line 235
    +
    +def vaults
    +  @_vaults ||= NgrokAPI::Services::VaultsClient.new(client: @client)
    +end
    +
    @@ -2132,9 +2288,9 @@

    diff --git a/docs/NgrokAPI/Error.html b/docs/NgrokAPI/Error.html index 9e616672..3f1e4545 100644 --- a/docs/NgrokAPI/Error.html +++ b/docs/NgrokAPI/Error.html @@ -295,9 +295,9 @@

    diff --git a/docs/NgrokAPI/Errors.html b/docs/NgrokAPI/Errors.html index 58bba368..f6561962 100644 --- a/docs/NgrokAPI/Errors.html +++ b/docs/NgrokAPI/Errors.html @@ -105,9 +105,9 @@

    Defined Under Namespace

    diff --git a/docs/NgrokAPI/Errors/NotFoundError.html b/docs/NgrokAPI/Errors/NotFoundError.html index 4bf441cf..0ecabd12 100644 --- a/docs/NgrokAPI/Errors/NotFoundError.html +++ b/docs/NgrokAPI/Errors/NotFoundError.html @@ -299,9 +299,9 @@

    diff --git a/docs/NgrokAPI/HttpClient.html b/docs/NgrokAPI/HttpClient.html index c060d4e5..53088ed4 100644 --- a/docs/NgrokAPI/HttpClient.html +++ b/docs/NgrokAPI/HttpClient.html @@ -1267,9 +1267,9 @@

    diff --git a/docs/NgrokAPI/Models.html b/docs/NgrokAPI/Models.html index 8c45abee..9d488dad 100644 --- a/docs/NgrokAPI/Models.html +++ b/docs/NgrokAPI/Models.html @@ -79,7 +79,7 @@
    Defined in:
    lib/ngrokapi/models/ref.rb,
    - lib/ngrokapi/models/tunnel.rb,
    lib/ngrokapi/models/api_key.rb,
    lib/ngrokapi/models/aws_auth.rb,
    lib/ngrokapi/models/aws_role.rb,
    lib/ngrokapi/models/bot_user.rb,
    lib/ngrokapi/models/endpoint.rb,
    lib/ngrokapi/models/listable.rb,
    lib/ngrokapi/models/location.rb,
    lib/ngrokapi/models/tcp_edge.rb,
    lib/ngrokapi/models/tls_edge.rb,
    lib/ngrokapi/models/ip_policy.rb,
    lib/ngrokapi/models/credential.rb,
    lib/ngrokapi/models/https_edge.rb,
    lib/ngrokapi/models/user_agent.rb,
    lib/ngrokapi/models/abuse_report.rb,
    lib/ngrokapi/models/event_source.rb,
    lib/ngrokapi/models/event_target.rb,
    lib/ngrokapi/models/agent_ingress.rb,
    lib/ngrokapi/models/endpoint_oidc.rb,
    lib/ngrokapi/models/endpoint_saml.rb,
    lib/ngrokapi/models/reserved_addr.rb,
    lib/ngrokapi/models/ip_policy_rule.rb,
    lib/ngrokapi/models/ip_restriction.rb,
    lib/ngrokapi/models/ssh_credential.rb,
    lib/ngrokapi/models/static_backend.rb,
    lib/ngrokapi/models/tunnel_session.rb,
    lib/ngrokapi/models/aws_credentials.rb,
    lib/ngrokapi/models/browser_session.rb,
    lib/ngrokapi/models/endpoint_o_auth.rb,
    lib/ngrokapi/models/reserved_domain.rb,
    lib/ngrokapi/models/tls_certificate.rb,
    lib/ngrokapi/models/application_user.rb,
    lib/ngrokapi/models/endpoint_backend.rb,
    lib/ngrokapi/models/failover_backend.rb,
    lib/ngrokapi/models/https_edge_route.rb,
    lib/ngrokapi/models/weighted_backend.rb,
    lib/ngrokapi/models/event_destination.rb,
    lib/ngrokapi/models/event_source_list.rb,
    lib/ngrokapi/models/identity_provider.rb,
    lib/ngrokapi/models/endpoint_ip_policy.rb,
    lib/ngrokapi/models/event_subscription.rb,
    lib/ngrokapi/models/static_backend_tls.rb,
    lib/ngrokapi/models/application_session.rb,
    lib/ngrokapi/models/endpoint_mutual_tls.rb,
    lib/ngrokapi/models/endpoint_compression.rb,
    lib/ngrokapi/models/endpoint_saml_mutate.rb,
    lib/ngrokapi/models/event_source_replace.rb,
    lib/ngrokapi/models/event_target_datadog.rb,
    lib/ngrokapi/models/event_target_kinesis.rb,
    lib/ngrokapi/models/ssh_host_certificate.rb,
    lib/ngrokapi/models/ssh_user_certificate.rb,
    lib/ngrokapi/models/tunnel_group_backend.rb,
    lib/ngrokapi/models/abuse_report_hostname.rb,
    lib/ngrokapi/models/certificate_authority.rb,
    lib/ngrokapi/models/event_target_firehose.rb,
    lib/ngrokapi/models/http_response_backend.rb,
    lib/ngrokapi/models/tls_certificate_sa_ns.rb,
    lib/ngrokapi/models/agent_ingress_cert_job.rb,
    lib/ngrokapi/models/endpoint_o_auth_amazon.rb,
    lib/ngrokapi/models/endpoint_o_auth_google.rb,
    lib/ngrokapi/models/endpoint_o_auth_twitch.rb,
    lib/ngrokapi/models/endpoint_backend_mutate.rb,
    lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,
    lib/ngrokapi/models/endpoint_o_auth_git_lab.rb,
    lib/ngrokapi/models/endpoint_traffic_policy.rb,
    lib/ngrokapi/models/endpoint_circuit_breaker.rb,
    lib/ngrokapi/models/endpoint_o_auth_facebook.rb,
    lib/ngrokapi/models/endpoint_o_auth_provider.rb,
    lib/ngrokapi/models/endpoint_request_headers.rb,
    lib/ngrokapi/models/endpoint_tls_termination.rb,
    lib/ngrokapi/models/reserved_domain_cert_job.rb,
    lib/ngrokapi/models/agent_ingress_cert_policy.rb,
    lib/ngrokapi/models/agent_ingress_cert_status.rb,
    lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,
    lib/ngrokapi/models/endpoint_o_auth_linked_in.rb,
    lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,
    lib/ngrokapi/models/endpoint_response_headers.rb,
    lib/ngrokapi/models/ssh_certificate_authority.rb,
    lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,
    lib/ngrokapi/models/endpoint_user_agent_filter.rb,
    lib/ngrokapi/models/endpoint_webhook_validation.rb,
    lib/ngrokapi/models/reserved_domain_cert_policy.rb,
    lib/ngrokapi/models/reserved_domain_cert_status.rb,
    lib/ngrokapi/models/event_target_cloudwatch_logs.rb,
    lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb,
    lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb,
    lib/ngrokapi/models/event_target_azure_logs_ingestion.rb
    + lib/ngrokapi/models/vault.rb,
    lib/ngrokapi/models/secret.rb,
    lib/ngrokapi/models/tunnel.rb,
    lib/ngrokapi/models/api_key.rb,
    lib/ngrokapi/models/aws_auth.rb,
    lib/ngrokapi/models/aws_role.rb,
    lib/ngrokapi/models/bot_user.rb,
    lib/ngrokapi/models/endpoint.rb,
    lib/ngrokapi/models/listable.rb,
    lib/ngrokapi/models/location.rb,
    lib/ngrokapi/models/tcp_edge.rb,
    lib/ngrokapi/models/tls_edge.rb,
    lib/ngrokapi/models/ip_policy.rb,
    lib/ngrokapi/models/credential.rb,
    lib/ngrokapi/models/https_edge.rb,
    lib/ngrokapi/models/user_agent.rb,
    lib/ngrokapi/models/abuse_report.rb,
    lib/ngrokapi/models/event_source.rb,
    lib/ngrokapi/models/event_target.rb,
    lib/ngrokapi/models/agent_ingress.rb,
    lib/ngrokapi/models/endpoint_oidc.rb,
    lib/ngrokapi/models/endpoint_saml.rb,
    lib/ngrokapi/models/reserved_addr.rb,
    lib/ngrokapi/models/ip_policy_rule.rb,
    lib/ngrokapi/models/ip_restriction.rb,
    lib/ngrokapi/models/ssh_credential.rb,
    lib/ngrokapi/models/static_backend.rb,
    lib/ngrokapi/models/tunnel_session.rb,
    lib/ngrokapi/models/aws_credentials.rb,
    lib/ngrokapi/models/browser_session.rb,
    lib/ngrokapi/models/endpoint_o_auth.rb,
    lib/ngrokapi/models/reserved_domain.rb,
    lib/ngrokapi/models/tls_certificate.rb,
    lib/ngrokapi/models/application_user.rb,
    lib/ngrokapi/models/endpoint_backend.rb,
    lib/ngrokapi/models/failover_backend.rb,
    lib/ngrokapi/models/https_edge_route.rb,
    lib/ngrokapi/models/weighted_backend.rb,
    lib/ngrokapi/models/event_destination.rb,
    lib/ngrokapi/models/event_source_list.rb,
    lib/ngrokapi/models/identity_provider.rb,
    lib/ngrokapi/models/endpoint_ip_policy.rb,
    lib/ngrokapi/models/event_subscription.rb,
    lib/ngrokapi/models/static_backend_tls.rb,
    lib/ngrokapi/models/application_session.rb,
    lib/ngrokapi/models/endpoint_mutual_tls.rb,
    lib/ngrokapi/models/endpoint_compression.rb,
    lib/ngrokapi/models/endpoint_saml_mutate.rb,
    lib/ngrokapi/models/event_source_replace.rb,
    lib/ngrokapi/models/event_target_datadog.rb,
    lib/ngrokapi/models/event_target_kinesis.rb,
    lib/ngrokapi/models/ssh_host_certificate.rb,
    lib/ngrokapi/models/ssh_user_certificate.rb,
    lib/ngrokapi/models/tunnel_group_backend.rb,
    lib/ngrokapi/models/abuse_report_hostname.rb,
    lib/ngrokapi/models/certificate_authority.rb,
    lib/ngrokapi/models/event_target_firehose.rb,
    lib/ngrokapi/models/http_response_backend.rb,
    lib/ngrokapi/models/tls_certificate_sa_ns.rb,
    lib/ngrokapi/models/agent_ingress_cert_job.rb,
    lib/ngrokapi/models/endpoint_o_auth_amazon.rb,
    lib/ngrokapi/models/endpoint_o_auth_google.rb,
    lib/ngrokapi/models/endpoint_o_auth_twitch.rb,
    lib/ngrokapi/models/endpoint_backend_mutate.rb,
    lib/ngrokapi/models/endpoint_o_auth_git_hub.rb,
    lib/ngrokapi/models/endpoint_o_auth_git_lab.rb,
    lib/ngrokapi/models/endpoint_traffic_policy.rb,
    lib/ngrokapi/models/endpoint_circuit_breaker.rb,
    lib/ngrokapi/models/endpoint_o_auth_facebook.rb,
    lib/ngrokapi/models/endpoint_o_auth_provider.rb,
    lib/ngrokapi/models/endpoint_request_headers.rb,
    lib/ngrokapi/models/endpoint_tls_termination.rb,
    lib/ngrokapi/models/reserved_domain_cert_job.rb,
    lib/ngrokapi/models/agent_ingress_cert_policy.rb,
    lib/ngrokapi/models/agent_ingress_cert_status.rb,
    lib/ngrokapi/models/endpoint_ip_policy_mutate.rb,
    lib/ngrokapi/models/endpoint_o_auth_linked_in.rb,
    lib/ngrokapi/models/endpoint_o_auth_microsoft.rb,
    lib/ngrokapi/models/endpoint_response_headers.rb,
    lib/ngrokapi/models/ssh_certificate_authority.rb,
    lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb,
    lib/ngrokapi/models/endpoint_user_agent_filter.rb,
    lib/ngrokapi/models/endpoint_webhook_validation.rb,
    lib/ngrokapi/models/reserved_domain_cert_policy.rb,
    lib/ngrokapi/models/reserved_domain_cert_status.rb,
    lib/ngrokapi/models/event_target_cloudwatch_logs.rb,
    lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb,
    lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb,
    lib/ngrokapi/models/event_target_azure_logs_ingestion.rb
    @@ -91,7 +91,7 @@

    Defined Under Namespace

    - Classes: APIKey, AWSAuth, AWSCredentials, AWSRole, AbuseReport, AbuseReportHostname, AgentIngress, AgentIngressCertJob, AgentIngressCertPolicy, AgentIngressCertStatus, ApplicationSession, ApplicationUser, BotUser, BrowserSession, CertificateAuthority, Credential, Endpoint, EndpointBackend, EndpointBackendMutate, EndpointCircuitBreaker, EndpointCompression, EndpointIPPolicy, EndpointIPPolicyMutate, EndpointMutualTLS, EndpointMutualTLSMutate, EndpointOAuth, EndpointOAuthAmazon, EndpointOAuthFacebook, EndpointOAuthGitHub, EndpointOAuthGitLab, EndpointOAuthGoogle, EndpointOAuthLinkedIn, EndpointOAuthMicrosoft, EndpointOAuthProvider, EndpointOAuthTwitch, EndpointOIDC, EndpointRequestHeaders, EndpointResponseHeaders, EndpointSAML, EndpointSAMLMutate, EndpointTLSTermination, EndpointTLSTerminationAtEdge, EndpointTrafficPolicy, EndpointUserAgentFilter, EndpointWebhookValidation, EndpointWebsocketTCPConverter, EventDestination, EventSource, EventSourceList, EventSourceReplace, EventSubscription, EventTarget, EventTargetAzureLogsIngestion, EventTargetCloudwatchLogs, EventTargetDatadog, EventTargetFirehose, EventTargetKinesis, FailoverBackend, HTTPResponseBackend, HTTPSEdge, HTTPSEdgeRoute, IPPolicy, IPPolicyRule, IPRestriction, IdentityProvider, Listable, Location, Ref, ReservedAddr, ReservedDomain, ReservedDomainCertJob, ReservedDomainCertPolicy, ReservedDomainCertStatus, SSHCertificateAuthority, SSHCredential, SSHHostCertificate, SSHUserCertificate, StaticBackend, StaticBackendTLS, TCPEdge, TLSCertificate, TLSCertificateSANs, TLSEdge, Tunnel, TunnelGroupBackend, TunnelSession, UserAgent, WeightedBackend + Classes: APIKey, AWSAuth, AWSCredentials, AWSRole, AbuseReport, AbuseReportHostname, AgentIngress, AgentIngressCertJob, AgentIngressCertPolicy, AgentIngressCertStatus, ApplicationSession, ApplicationUser, BotUser, BrowserSession, CertificateAuthority, Credential, Endpoint, EndpointBackend, EndpointBackendMutate, EndpointCircuitBreaker, EndpointCompression, EndpointIPPolicy, EndpointIPPolicyMutate, EndpointMutualTLS, EndpointMutualTLSMutate, EndpointOAuth, EndpointOAuthAmazon, EndpointOAuthFacebook, EndpointOAuthGitHub, EndpointOAuthGitLab, EndpointOAuthGoogle, EndpointOAuthLinkedIn, EndpointOAuthMicrosoft, EndpointOAuthProvider, EndpointOAuthTwitch, EndpointOIDC, EndpointRequestHeaders, EndpointResponseHeaders, EndpointSAML, EndpointSAMLMutate, EndpointTLSTermination, EndpointTLSTerminationAtEdge, EndpointTrafficPolicy, EndpointUserAgentFilter, EndpointWebhookValidation, EndpointWebsocketTCPConverter, EventDestination, EventSource, EventSourceList, EventSourceReplace, EventSubscription, EventTarget, EventTargetAzureLogsIngestion, EventTargetCloudwatchLogs, EventTargetDatadog, EventTargetFirehose, EventTargetKinesis, FailoverBackend, HTTPResponseBackend, HTTPSEdge, HTTPSEdgeRoute, IPPolicy, IPPolicyRule, IPRestriction, IdentityProvider, Listable, Location, Ref, ReservedAddr, ReservedDomain, ReservedDomainCertJob, ReservedDomainCertPolicy, ReservedDomainCertStatus, SSHCertificateAuthority, SSHCredential, SSHHostCertificate, SSHUserCertificate, Secret, StaticBackend, StaticBackendTLS, TCPEdge, TLSCertificate, TLSCertificateSANs, TLSEdge, Tunnel, TunnelGroupBackend, TunnelSession, UserAgent, Vault, WeightedBackend

    @@ -107,9 +107,9 @@

    Defined Under Namespace

    diff --git a/docs/NgrokAPI/Models/APIKey.html b/docs/NgrokAPI/Models/APIKey.html index bc178a95..aa17a5b1 100644 --- a/docs/NgrokAPI/Models/APIKey.html +++ b/docs/NgrokAPI/Models/APIKey.html @@ -1189,9 +1189,9 @@

    diff --git a/docs/NgrokAPI/Models/AWSAuth.html b/docs/NgrokAPI/Models/AWSAuth.html index fa0a0307..73c2aef5 100644 --- a/docs/NgrokAPI/Models/AWSAuth.html +++ b/docs/NgrokAPI/Models/AWSAuth.html @@ -659,9 +659,9 @@

    diff --git a/docs/NgrokAPI/Models/AWSCredentials.html b/docs/NgrokAPI/Models/AWSCredentials.html index 91abc596..7e2738f1 100644 --- a/docs/NgrokAPI/Models/AWSCredentials.html +++ b/docs/NgrokAPI/Models/AWSCredentials.html @@ -659,9 +659,9 @@

    diff --git a/docs/NgrokAPI/Models/AWSRole.html b/docs/NgrokAPI/Models/AWSRole.html index a7206485..ecf2eca0 100644 --- a/docs/NgrokAPI/Models/AWSRole.html +++ b/docs/NgrokAPI/Models/AWSRole.html @@ -585,9 +585,9 @@

    diff --git a/docs/NgrokAPI/Models/AbuseReport.html b/docs/NgrokAPI/Models/AbuseReport.html index 1d49d6cf..c5d6e391 100644 --- a/docs/NgrokAPI/Models/AbuseReport.html +++ b/docs/NgrokAPI/Models/AbuseReport.html @@ -1033,9 +1033,9 @@

    diff --git a/docs/NgrokAPI/Models/AbuseReportHostname.html b/docs/NgrokAPI/Models/AbuseReportHostname.html index 5037d6f2..340e1a42 100644 --- a/docs/NgrokAPI/Models/AbuseReportHostname.html +++ b/docs/NgrokAPI/Models/AbuseReportHostname.html @@ -659,9 +659,9 @@

    diff --git a/docs/NgrokAPI/Models/AgentIngress.html b/docs/NgrokAPI/Models/AgentIngress.html index a232266b..593e6125 100644 --- a/docs/NgrokAPI/Models/AgentIngress.html +++ b/docs/NgrokAPI/Models/AgentIngress.html @@ -1417,9 +1417,9 @@

    diff --git a/docs/NgrokAPI/Models/AgentIngressCertJob.html b/docs/NgrokAPI/Models/AgentIngressCertJob.html index 8fc58604..da766a5c 100644 --- a/docs/NgrokAPI/Models/AgentIngressCertJob.html +++ b/docs/NgrokAPI/Models/AgentIngressCertJob.html @@ -807,9 +807,9 @@

    diff --git a/docs/NgrokAPI/Models/AgentIngressCertPolicy.html b/docs/NgrokAPI/Models/AgentIngressCertPolicy.html index 83c9cd60..c7e07a10 100644 --- a/docs/NgrokAPI/Models/AgentIngressCertPolicy.html +++ b/docs/NgrokAPI/Models/AgentIngressCertPolicy.html @@ -659,9 +659,9 @@

    diff --git a/docs/NgrokAPI/Models/AgentIngressCertStatus.html b/docs/NgrokAPI/Models/AgentIngressCertStatus.html index 3be9ff07..1264cf19 100644 --- a/docs/NgrokAPI/Models/AgentIngressCertStatus.html +++ b/docs/NgrokAPI/Models/AgentIngressCertStatus.html @@ -659,9 +659,9 @@

    diff --git a/docs/NgrokAPI/Models/ApplicationSession.html b/docs/NgrokAPI/Models/ApplicationSession.html index 4d587f77..1a59ff52 100644 --- a/docs/NgrokAPI/Models/ApplicationSession.html +++ b/docs/NgrokAPI/Models/ApplicationSession.html @@ -1404,9 +1404,9 @@

    diff --git a/docs/NgrokAPI/Models/ApplicationUser.html b/docs/NgrokAPI/Models/ApplicationUser.html index 710c470e..6529c44a 100644 --- a/docs/NgrokAPI/Models/ApplicationUser.html +++ b/docs/NgrokAPI/Models/ApplicationUser.html @@ -1326,9 +1326,9 @@

    diff --git a/docs/NgrokAPI/Models/BotUser.html b/docs/NgrokAPI/Models/BotUser.html index 739a9f21..13da4f1d 100644 --- a/docs/NgrokAPI/Models/BotUser.html +++ b/docs/NgrokAPI/Models/BotUser.html @@ -1041,9 +1041,9 @@

    diff --git a/docs/NgrokAPI/Models/BrowserSession.html b/docs/NgrokAPI/Models/BrowserSession.html index 9e9c3c1f..35395e88 100644 --- a/docs/NgrokAPI/Models/BrowserSession.html +++ b/docs/NgrokAPI/Models/BrowserSession.html @@ -733,9 +733,9 @@

    diff --git a/docs/NgrokAPI/Models/CertificateAuthority.html b/docs/NgrokAPI/Models/CertificateAuthority.html index 37cce9dd..19f1a987 100644 --- a/docs/NgrokAPI/Models/CertificateAuthority.html +++ b/docs/NgrokAPI/Models/CertificateAuthority.html @@ -1485,9 +1485,9 @@

    diff --git a/docs/NgrokAPI/Models/Credential.html b/docs/NgrokAPI/Models/Credential.html index f0e363e6..9f61c91f 100644 --- a/docs/NgrokAPI/Models/Credential.html +++ b/docs/NgrokAPI/Models/Credential.html @@ -1269,9 +1269,9 @@

    diff --git a/docs/NgrokAPI/Models/Endpoint.html b/docs/NgrokAPI/Models/Endpoint.html index fc85db05..c0205dd5 100644 --- a/docs/NgrokAPI/Models/Endpoint.html +++ b/docs/NgrokAPI/Models/Endpoint.html @@ -457,7 +457,7 @@

    Instance Attribute Summary collaps
  • - #port ⇒ Object + #pooling_enabled ⇒ Object @@ -477,7 +477,7 @@

    Instance Attribute Summary collaps
    -

    Returns the value of attribute port.

    +

    Returns the value of attribute pooling_enabled.

  • @@ -486,7 +486,7 @@

    Instance Attribute Summary collaps
  • - #principal ⇒ Object + #port ⇒ Object @@ -506,7 +506,7 @@

    Instance Attribute Summary collaps
    -

    Returns the value of attribute principal.

    +

    Returns the value of attribute port.

  • @@ -515,7 +515,7 @@

    Instance Attribute Summary collaps
  • - #principal_id ⇒ Object + #principal ⇒ Object @@ -535,7 +535,7 @@

    Instance Attribute Summary collaps
    -

    Returns the value of attribute principal_id.

    +

    Returns the value of attribute principal.

  • @@ -834,7 +834,7 @@

    Instance Attribute Summary collaps
  • - #upstream_proto ⇒ Object + #upstream_protocol ⇒ Object @@ -854,7 +854,7 @@

    Instance Attribute Summary collaps
    -

    Returns the value of attribute upstream_proto.

    +

    Returns the value of attribute upstream_protocol.

  • @@ -1079,7 +1079,7 @@

  • - #update(url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil) ⇒ Object + #update(url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ Object @@ -1194,10 +1194,9 @@

    @tunnel = @attrs['tunnel'] @edge = @attrs['edge'] @upstream_url = @attrs['upstream_url'] - @upstream_proto = @attrs['upstream_proto'] + @upstream_protocol = @attrs['upstream_protocol'] @url = @attrs['url'] @principal = @attrs['principal'] - @principal_id = @attrs['principal_id'] @traffic_policy = @attrs['traffic_policy'] @bindings = @attrs['bindings'] @tunnel_session = @attrs['tunnel_session'] @@ -1205,6 +1204,7 @@

    @uri = URI(@attrs['uri']) end @name = @attrs['name'] + @pooling_enabled = @attrs['pooling_enabled'] end

  • @@ -1735,9 +1735,9 @@

    -

    +

    - #portObject (readonly) + #pooling_enabledObject (readonly) @@ -1746,7 +1746,7 @@

    -

    Returns the value of attribute port.

    +

    Returns the value of attribute pooling_enabled.

    @@ -1767,8 +1767,8 @@

    # File 'lib/ngrokapi/models/endpoint.rb', line 10
     
    -def port
    -  @port
    +def pooling_enabled
    +  @pooling_enabled
     end
    @@ -1778,9 +1778,9 @@

    -

    +

    - #principalObject (readonly) + #portObject (readonly) @@ -1789,7 +1789,7 @@

    -

    Returns the value of attribute principal.

    +

    Returns the value of attribute port.

    @@ -1810,8 +1810,8 @@

    # File 'lib/ngrokapi/models/endpoint.rb', line 10
     
    -def principal
    -  @principal
    +def port
    +  @port
     end
    @@ -1821,9 +1821,9 @@

    -

    +

    - #principal_idObject (readonly) + #principalObject (readonly) @@ -1832,7 +1832,7 @@

    -

    Returns the value of attribute principal_id.

    +

    Returns the value of attribute principal.

    @@ -1853,8 +1853,8 @@

    # File 'lib/ngrokapi/models/endpoint.rb', line 10
     
    -def principal_id
    -  @principal_id
    +def principal
    +  @principal
     end
    @@ -2294,9 +2294,9 @@

    -

    +

    - #upstream_protoObject (readonly) + #upstream_protocolObject (readonly) @@ -2305,7 +2305,7 @@

    -

    Returns the value of attribute upstream_proto.

    +

    Returns the value of attribute upstream_protocol.

    @@ -2326,8 +2326,8 @@

    # File 'lib/ngrokapi/models/endpoint.rb', line 10
     
    -def upstream_proto
    -  @upstream_proto
    +def upstream_protocol
    +  @upstream_protocol
     end
    @@ -2528,14 +2528,14 @@

     
     
    -118
    -119
    -120
     121
    -122
    +122 +123 +124 +125

    -
    # File 'lib/ngrokapi/models/endpoint.rb', line 118
    +      
    # File 'lib/ngrokapi/models/endpoint.rb', line 121
     
     def delete
       @client.delete(
    @@ -2610,7 +2610,7 @@ 

    - #update(url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil) ⇒ Object + #update(url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ Object @@ -2655,7 +2655,10 @@

    109 110 111 -112

    +112 +113 +114 +115
    # File 'lib/ngrokapi/models/endpoint.rb', line 92
    @@ -2665,20 +2668,23 @@ 

    traffic_policy: nil, description: nil, metadata: nil, - bindings: nil + bindings: nil, + pooling_enabled: False ) @url = url if url @traffic_policy = traffic_policy if traffic_policy @description = description if description @metadata = if @bindings = bindings if bindings + @pooling_enabled = pooling_enabled if pooling_enabled @client.update( id: @id, url: url, traffic_policy: traffic_policy, description: description, metadata: , - bindings: bindings + bindings: bindings, + pooling_enabled: pooling_enabled ) end

    @@ -2691,9 +2697,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointBackend.html b/docs/NgrokAPI/Models/EndpointBackend.html index d38fa2b6..e83afea2 100644 --- a/docs/NgrokAPI/Models/EndpointBackend.html +++ b/docs/NgrokAPI/Models/EndpointBackend.html @@ -659,9 +659,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointBackendMutate.html b/docs/NgrokAPI/Models/EndpointBackendMutate.html index 7e6db8d3..9bef29dc 100644 --- a/docs/NgrokAPI/Models/EndpointBackendMutate.html +++ b/docs/NgrokAPI/Models/EndpointBackendMutate.html @@ -659,9 +659,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointCircuitBreaker.html b/docs/NgrokAPI/Models/EndpointCircuitBreaker.html index 2fda0dc3..58154d2e 100644 --- a/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +++ b/docs/NgrokAPI/Models/EndpointCircuitBreaker.html @@ -955,9 +955,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointCompression.html b/docs/NgrokAPI/Models/EndpointCompression.html index 735e8c5a..d34e15d8 100644 --- a/docs/NgrokAPI/Models/EndpointCompression.html +++ b/docs/NgrokAPI/Models/EndpointCompression.html @@ -585,9 +585,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointIPPolicy.html b/docs/NgrokAPI/Models/EndpointIPPolicy.html index 54d757d5..1ae34fe0 100644 --- a/docs/NgrokAPI/Models/EndpointIPPolicy.html +++ b/docs/NgrokAPI/Models/EndpointIPPolicy.html @@ -659,9 +659,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html b/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html index 5054c230..734dc179 100644 --- a/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +++ b/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html @@ -659,9 +659,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointMutualTLS.html b/docs/NgrokAPI/Models/EndpointMutualTLS.html index 596b39d5..40779cca 100644 --- a/docs/NgrokAPI/Models/EndpointMutualTLS.html +++ b/docs/NgrokAPI/Models/EndpointMutualTLS.html @@ -659,9 +659,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html b/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html index 2a3da13c..ce586684 100644 --- a/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +++ b/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html @@ -659,9 +659,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointOAuth.html b/docs/NgrokAPI/Models/EndpointOAuth.html index dcf0a72f..1b49e929 100644 --- a/docs/NgrokAPI/Models/EndpointOAuth.html +++ b/docs/NgrokAPI/Models/EndpointOAuth.html @@ -1029,9 +1029,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointOAuthAmazon.html b/docs/NgrokAPI/Models/EndpointOAuthAmazon.html index 11c02d37..1e7b307b 100644 --- a/docs/NgrokAPI/Models/EndpointOAuthAmazon.html +++ b/docs/NgrokAPI/Models/EndpointOAuthAmazon.html @@ -881,9 +881,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointOAuthFacebook.html b/docs/NgrokAPI/Models/EndpointOAuthFacebook.html index fabde6e3..8a6207ef 100644 --- a/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +++ b/docs/NgrokAPI/Models/EndpointOAuthFacebook.html @@ -881,9 +881,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointOAuthGitHub.html b/docs/NgrokAPI/Models/EndpointOAuthGitHub.html index 68ed0da6..8de55fa4 100644 --- a/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +++ b/docs/NgrokAPI/Models/EndpointOAuthGitHub.html @@ -1029,9 +1029,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointOAuthGitLab.html b/docs/NgrokAPI/Models/EndpointOAuthGitLab.html index a7998648..7016b303 100644 --- a/docs/NgrokAPI/Models/EndpointOAuthGitLab.html +++ b/docs/NgrokAPI/Models/EndpointOAuthGitLab.html @@ -881,9 +881,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointOAuthGoogle.html b/docs/NgrokAPI/Models/EndpointOAuthGoogle.html index 0bc9bcf4..62bb2ca9 100644 --- a/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +++ b/docs/NgrokAPI/Models/EndpointOAuthGoogle.html @@ -881,9 +881,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointOAuthLinkedIn.html b/docs/NgrokAPI/Models/EndpointOAuthLinkedIn.html index 107fdbb0..e63c1254 100644 --- a/docs/NgrokAPI/Models/EndpointOAuthLinkedIn.html +++ b/docs/NgrokAPI/Models/EndpointOAuthLinkedIn.html @@ -881,9 +881,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html b/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html index 0bc5255c..9c9ba5c0 100644 --- a/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +++ b/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html @@ -881,9 +881,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointOAuthProvider.html b/docs/NgrokAPI/Models/EndpointOAuthProvider.html index da946cf1..9de4e47f 100644 --- a/docs/NgrokAPI/Models/EndpointOAuthProvider.html +++ b/docs/NgrokAPI/Models/EndpointOAuthProvider.html @@ -1103,9 +1103,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointOAuthTwitch.html b/docs/NgrokAPI/Models/EndpointOAuthTwitch.html index 638c9a25..a2bfba9a 100644 --- a/docs/NgrokAPI/Models/EndpointOAuthTwitch.html +++ b/docs/NgrokAPI/Models/EndpointOAuthTwitch.html @@ -881,9 +881,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointOIDC.html b/docs/NgrokAPI/Models/EndpointOIDC.html index 64e16392..106a982d 100644 --- a/docs/NgrokAPI/Models/EndpointOIDC.html +++ b/docs/NgrokAPI/Models/EndpointOIDC.html @@ -1177,9 +1177,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointRequestHeaders.html b/docs/NgrokAPI/Models/EndpointRequestHeaders.html index e98dbc4e..d048a7f7 100644 --- a/docs/NgrokAPI/Models/EndpointRequestHeaders.html +++ b/docs/NgrokAPI/Models/EndpointRequestHeaders.html @@ -733,9 +733,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointResponseHeaders.html b/docs/NgrokAPI/Models/EndpointResponseHeaders.html index 027a4c5e..2782a627 100644 --- a/docs/NgrokAPI/Models/EndpointResponseHeaders.html +++ b/docs/NgrokAPI/Models/EndpointResponseHeaders.html @@ -733,9 +733,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointSAML.html b/docs/NgrokAPI/Models/EndpointSAML.html index 21676c73..2a019b98 100644 --- a/docs/NgrokAPI/Models/EndpointSAML.html +++ b/docs/NgrokAPI/Models/EndpointSAML.html @@ -1633,9 +1633,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointSAMLMutate.html b/docs/NgrokAPI/Models/EndpointSAMLMutate.html index eeaf6981..c3a3730f 100644 --- a/docs/NgrokAPI/Models/EndpointSAMLMutate.html +++ b/docs/NgrokAPI/Models/EndpointSAMLMutate.html @@ -1251,9 +1251,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointTLSTermination.html b/docs/NgrokAPI/Models/EndpointTLSTermination.html index 5e858c2d..f0b4af53 100644 --- a/docs/NgrokAPI/Models/EndpointTLSTermination.html +++ b/docs/NgrokAPI/Models/EndpointTLSTermination.html @@ -733,9 +733,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html b/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html index 561862be..42245611 100644 --- a/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +++ b/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html @@ -659,9 +659,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointTrafficPolicy.html b/docs/NgrokAPI/Models/EndpointTrafficPolicy.html index c5f69539..86b8e033 100644 --- a/docs/NgrokAPI/Models/EndpointTrafficPolicy.html +++ b/docs/NgrokAPI/Models/EndpointTrafficPolicy.html @@ -659,9 +659,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointUserAgentFilter.html b/docs/NgrokAPI/Models/EndpointUserAgentFilter.html index 60b9d743..5e63b86e 100644 --- a/docs/NgrokAPI/Models/EndpointUserAgentFilter.html +++ b/docs/NgrokAPI/Models/EndpointUserAgentFilter.html @@ -733,9 +733,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointWebhookValidation.html b/docs/NgrokAPI/Models/EndpointWebhookValidation.html index d569936e..31c83d92 100644 --- a/docs/NgrokAPI/Models/EndpointWebhookValidation.html +++ b/docs/NgrokAPI/Models/EndpointWebhookValidation.html @@ -733,9 +733,9 @@

    diff --git a/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html b/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html index 31093b8f..948e1362 100644 --- a/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +++ b/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html @@ -585,9 +585,9 @@

    diff --git a/docs/NgrokAPI/Models/EventDestination.html b/docs/NgrokAPI/Models/EventDestination.html index 06c493c8..fa9b786f 100644 --- a/docs/NgrokAPI/Models/EventDestination.html +++ b/docs/NgrokAPI/Models/EventDestination.html @@ -1104,9 +1104,9 @@

    diff --git a/docs/NgrokAPI/Models/EventSource.html b/docs/NgrokAPI/Models/EventSource.html index a8100c97..1b02a4e5 100644 --- a/docs/NgrokAPI/Models/EventSource.html +++ b/docs/NgrokAPI/Models/EventSource.html @@ -663,9 +663,9 @@

    diff --git a/docs/NgrokAPI/Models/EventSourceList.html b/docs/NgrokAPI/Models/EventSourceList.html index 2eff9fe9..81644ac5 100644 --- a/docs/NgrokAPI/Models/EventSourceList.html +++ b/docs/NgrokAPI/Models/EventSourceList.html @@ -663,9 +663,9 @@

    diff --git a/docs/NgrokAPI/Models/EventSourceReplace.html b/docs/NgrokAPI/Models/EventSourceReplace.html index d6dc417e..d58f1d2d 100644 --- a/docs/NgrokAPI/Models/EventSourceReplace.html +++ b/docs/NgrokAPI/Models/EventSourceReplace.html @@ -585,9 +585,9 @@

    diff --git a/docs/NgrokAPI/Models/EventSubscription.html b/docs/NgrokAPI/Models/EventSubscription.html index 387db492..91a10839 100644 --- a/docs/NgrokAPI/Models/EventSubscription.html +++ b/docs/NgrokAPI/Models/EventSubscription.html @@ -1104,9 +1104,9 @@

    diff --git a/docs/NgrokAPI/Models/EventTarget.html b/docs/NgrokAPI/Models/EventTarget.html index 0253d562..ddb9f43e 100644 --- a/docs/NgrokAPI/Models/EventTarget.html +++ b/docs/NgrokAPI/Models/EventTarget.html @@ -881,9 +881,9 @@

    diff --git a/docs/NgrokAPI/Models/EventTargetAzureLogsIngestion.html b/docs/NgrokAPI/Models/EventTargetAzureLogsIngestion.html index dca6e700..bd159c22 100644 --- a/docs/NgrokAPI/Models/EventTargetAzureLogsIngestion.html +++ b/docs/NgrokAPI/Models/EventTargetAzureLogsIngestion.html @@ -955,9 +955,9 @@

    diff --git a/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html b/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html index 9c86df7e..4ef2dde2 100644 --- a/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +++ b/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html @@ -659,9 +659,9 @@

    diff --git a/docs/NgrokAPI/Models/EventTargetDatadog.html b/docs/NgrokAPI/Models/EventTargetDatadog.html index e9ae4510..1a164526 100644 --- a/docs/NgrokAPI/Models/EventTargetDatadog.html +++ b/docs/NgrokAPI/Models/EventTargetDatadog.html @@ -807,9 +807,9 @@

    diff --git a/docs/NgrokAPI/Models/EventTargetFirehose.html b/docs/NgrokAPI/Models/EventTargetFirehose.html index 01be2cc8..9f86ef83 100644 --- a/docs/NgrokAPI/Models/EventTargetFirehose.html +++ b/docs/NgrokAPI/Models/EventTargetFirehose.html @@ -659,9 +659,9 @@

    diff --git a/docs/NgrokAPI/Models/EventTargetKinesis.html b/docs/NgrokAPI/Models/EventTargetKinesis.html index a5de5732..7ffea94a 100644 --- a/docs/NgrokAPI/Models/EventTargetKinesis.html +++ b/docs/NgrokAPI/Models/EventTargetKinesis.html @@ -659,9 +659,9 @@

    diff --git a/docs/NgrokAPI/Models/FailoverBackend.html b/docs/NgrokAPI/Models/FailoverBackend.html index 13ab656d..1c13b3dc 100644 --- a/docs/NgrokAPI/Models/FailoverBackend.html +++ b/docs/NgrokAPI/Models/FailoverBackend.html @@ -1121,9 +1121,9 @@

    diff --git a/docs/NgrokAPI/Models/HTTPResponseBackend.html b/docs/NgrokAPI/Models/HTTPResponseBackend.html index 22cdef6f..626c4f2a 100644 --- a/docs/NgrokAPI/Models/HTTPResponseBackend.html +++ b/docs/NgrokAPI/Models/HTTPResponseBackend.html @@ -1277,9 +1277,9 @@

    diff --git a/docs/NgrokAPI/Models/HTTPSEdge.html b/docs/NgrokAPI/Models/HTTPSEdge.html index db541a61..0c2b4d6a 100644 --- a/docs/NgrokAPI/Models/HTTPSEdge.html +++ b/docs/NgrokAPI/Models/HTTPSEdge.html @@ -1355,9 +1355,9 @@

    diff --git a/docs/NgrokAPI/Models/HTTPSEdgeRoute.html b/docs/NgrokAPI/Models/HTTPSEdgeRoute.html index 4338ffc4..0b0e10e5 100644 --- a/docs/NgrokAPI/Models/HTTPSEdgeRoute.html +++ b/docs/NgrokAPI/Models/HTTPSEdgeRoute.html @@ -2321,9 +2321,9 @@

    diff --git a/docs/NgrokAPI/Models/IPPolicy.html b/docs/NgrokAPI/Models/IPPolicy.html index ceae175c..a663f0b2 100644 --- a/docs/NgrokAPI/Models/IPPolicy.html +++ b/docs/NgrokAPI/Models/IPPolicy.html @@ -1041,9 +1041,9 @@

    diff --git a/docs/NgrokAPI/Models/IPPolicyRule.html b/docs/NgrokAPI/Models/IPPolicyRule.html index b3645d7e..99872a09 100644 --- a/docs/NgrokAPI/Models/IPPolicyRule.html +++ b/docs/NgrokAPI/Models/IPPolicyRule.html @@ -1269,9 +1269,9 @@

    diff --git a/docs/NgrokAPI/Models/IPRestriction.html b/docs/NgrokAPI/Models/IPRestriction.html index 3560292c..05a18ccd 100644 --- a/docs/NgrokAPI/Models/IPRestriction.html +++ b/docs/NgrokAPI/Models/IPRestriction.html @@ -1178,9 +1178,9 @@

    diff --git a/docs/NgrokAPI/Models/IdentityProvider.html b/docs/NgrokAPI/Models/IdentityProvider.html index 98661ebc..e5c34925 100644 --- a/docs/NgrokAPI/Models/IdentityProvider.html +++ b/docs/NgrokAPI/Models/IdentityProvider.html @@ -659,9 +659,9 @@

    diff --git a/docs/NgrokAPI/Models/Listable.html b/docs/NgrokAPI/Models/Listable.html index b201256c..6fec732b 100644 --- a/docs/NgrokAPI/Models/Listable.html +++ b/docs/NgrokAPI/Models/Listable.html @@ -992,9 +992,9 @@

    diff --git a/docs/NgrokAPI/Models/Location.html b/docs/NgrokAPI/Models/Location.html index 3174235f..f1a314a7 100644 --- a/docs/NgrokAPI/Models/Location.html +++ b/docs/NgrokAPI/Models/Location.html @@ -807,9 +807,9 @@

    diff --git a/docs/NgrokAPI/Models/Ref.html b/docs/NgrokAPI/Models/Ref.html index 5cccf8be..483f03c9 100644 --- a/docs/NgrokAPI/Models/Ref.html +++ b/docs/NgrokAPI/Models/Ref.html @@ -663,9 +663,9 @@

    diff --git a/docs/NgrokAPI/Models/ReservedAddr.html b/docs/NgrokAPI/Models/ReservedAddr.html index 5a5f00d4..50682595 100644 --- a/docs/NgrokAPI/Models/ReservedAddr.html +++ b/docs/NgrokAPI/Models/ReservedAddr.html @@ -1104,9 +1104,9 @@

    diff --git a/docs/NgrokAPI/Models/ReservedDomain.html b/docs/NgrokAPI/Models/ReservedDomain.html index 082b1a4e..d7d2be24 100644 --- a/docs/NgrokAPI/Models/ReservedDomain.html +++ b/docs/NgrokAPI/Models/ReservedDomain.html @@ -1474,9 +1474,9 @@

    diff --git a/docs/NgrokAPI/Models/ReservedDomainCertJob.html b/docs/NgrokAPI/Models/ReservedDomainCertJob.html index 843130bc..63652422 100644 --- a/docs/NgrokAPI/Models/ReservedDomainCertJob.html +++ b/docs/NgrokAPI/Models/ReservedDomainCertJob.html @@ -807,9 +807,9 @@

    diff --git a/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html b/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html index bad3e3f4..144dbea7 100644 --- a/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +++ b/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html @@ -659,9 +659,9 @@

    diff --git a/docs/NgrokAPI/Models/ReservedDomainCertStatus.html b/docs/NgrokAPI/Models/ReservedDomainCertStatus.html index d78e9b77..8972d654 100644 --- a/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +++ b/docs/NgrokAPI/Models/ReservedDomainCertStatus.html @@ -659,9 +659,9 @@

    diff --git a/docs/NgrokAPI/Models/SSHCertificateAuthority.html b/docs/NgrokAPI/Models/SSHCertificateAuthority.html index 7d3a9917..422145fb 100644 --- a/docs/NgrokAPI/Models/SSHCertificateAuthority.html +++ b/docs/NgrokAPI/Models/SSHCertificateAuthority.html @@ -1189,9 +1189,9 @@

    diff --git a/docs/NgrokAPI/Models/SSHCredential.html b/docs/NgrokAPI/Models/SSHCredential.html index f8e0015b..1f3e0584 100644 --- a/docs/NgrokAPI/Models/SSHCredential.html +++ b/docs/NgrokAPI/Models/SSHCredential.html @@ -1269,9 +1269,9 @@

    diff --git a/docs/NgrokAPI/Models/SSHHostCertificate.html b/docs/NgrokAPI/Models/SSHHostCertificate.html index c9103d30..184bccf1 100644 --- a/docs/NgrokAPI/Models/SSHHostCertificate.html +++ b/docs/NgrokAPI/Models/SSHHostCertificate.html @@ -1559,9 +1559,9 @@

    diff --git a/docs/NgrokAPI/Models/SSHUserCertificate.html b/docs/NgrokAPI/Models/SSHUserCertificate.html index f29e62fa..7ed862f5 100644 --- a/docs/NgrokAPI/Models/SSHUserCertificate.html +++ b/docs/NgrokAPI/Models/SSHUserCertificate.html @@ -1707,9 +1707,9 @@

    diff --git a/docs/NgrokAPI/Models/Secret.html b/docs/NgrokAPI/Models/Secret.html new file mode 100644 index 00000000..1fd88549 --- /dev/null +++ b/docs/NgrokAPI/Models/Secret.html @@ -0,0 +1,1336 @@ + + + + + + + Class: NgrokAPI::Models::Secret + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: NgrokAPI::Models::Secret + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/models/secret.rb
    +
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #attrs ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute attrs.

      +
      + +
    • + + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    • + + + #created_at ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute created_at.

      +
      + +
    • + + +
    • + + + #created_by ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute created_by.

      +
      + +
    • + + +
    • + + + #description ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute description.

      +
      + +
    • + + +
    • + + + #id ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute id.

      +
      + +
    • + + +
    • + + + #last_updated_by ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute last_updated_by.

      +
      + +
    • + + +
    • + + + #metadata ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute metadata.

      +
      + +
    • + + +
    • + + + #name ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute name.

      +
      + +
    • + + +
    • + + + #updated_at ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute updated_at.

      +
      + +
    • + + +
    • + + + #uri ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute uri.

      +
      + +
    • + + +
    • + + + #vault ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute vault.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client: nil, attrs: {}) ⇒ Secret + + + + + +

    +
    + +

    Returns a new instance of Secret.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +23
    +24
    +25
    +26
    +27
    +28
    +29
    +30
    +31
    +32
    +33
    +34
    +35
    +36
    +37
    +38
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 23
    +
    +def initialize(client: nil, attrs: {})
    +  @client = client
    +  @attrs = attrs
    +  @id = @attrs['id']
    +  unless @attrs['uri'].nil?
    +    @uri = URI(@attrs['uri'])
    +  end
    +  @created_at = @attrs['created_at']
    +  @updated_at = @attrs['updated_at']
    +  @name = @attrs['name']
    +  @description = @attrs['description']
    +  @metadata = @attrs['metadata']
    +  @created_by = @attrs['created_by']
    +  @last_updated_by = @attrs['last_updated_by']
    +  @vault = @attrs['vault']
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #attrsObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute attrs.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 10
    +
    +def attrs
    +  @attrs
    +end
    +
    +
    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 10
    +
    +def client
    +  @client
    +end
    +
    +
    + + + +
    +

    + + #created_atObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute created_at.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 10
    +
    +def created_at
    +  @created_at
    +end
    +
    +
    + + + +
    +

    + + #created_byObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute created_by.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 10
    +
    +def created_by
    +  @created_by
    +end
    +
    +
    + + + +
    +

    + + #descriptionObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute description.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 10
    +
    +def description
    +  @description
    +end
    +
    +
    + + + +
    +

    + + #idObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute id.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 10
    +
    +def id
    +  @id
    +end
    +
    +
    + + + +
    +

    + + #last_updated_byObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute last_updated_by.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 10
    +
    +def last_updated_by
    +  @last_updated_by
    +end
    +
    +
    + + + +
    +

    + + #metadataObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute metadata.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 10
    +
    +def 
    +  @metadata
    +end
    +
    +
    + + + +
    +

    + + #nameObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute name.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 10
    +
    +def name
    +  @name
    +end
    +
    +
    + + + +
    +

    + + #updated_atObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute updated_at.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 10
    +
    +def updated_at
    +  @updated_at
    +end
    +
    +
    + + + +
    +

    + + #uriObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute uri.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 10
    +
    +def uri
    +  @uri
    +end
    +
    +
    + + + +
    +

    + + #vaultObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute vault.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 10
    +
    +def vault
    +  @vault
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #==(other) ⇒ Object + + + + + +

    + + + + +
    +
    +
    +
    +40
    +41
    +42
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 40
    +
    +def ==(other)
    +  @attrs == other.attrs
    +end
    +
    +
    + +
    +

    + + #deleteObject + + + + + +

    +
    + +

    Delete a Secret

    + +

    ngrok.com/docs/api#api-secrets-delete

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +56
    +57
    +58
    +59
    +60
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 56
    +
    +def delete
    +  @client.delete(
    +    id: @id
    +  )
    +end
    +
    +
    + +
    +

    + + #to_hObject + + + + + +

    + + + + +
    +
    +
    +
    +48
    +49
    +50
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 48
    +
    +def to_h
    +  @attrs.to_h
    +end
    +
    +
    + +
    +

    + + #to_sObject + + + + + +

    + + + + +
    +
    +
    +
    +44
    +45
    +46
    +
    +
    # File 'lib/ngrokapi/models/secret.rb', line 44
    +
    +def to_s
    +  @attrs.to_s
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/NgrokAPI/Models/StaticBackend.html b/docs/NgrokAPI/Models/StaticBackend.html index 25668cdc..4a393e3c 100644 --- a/docs/NgrokAPI/Models/StaticBackend.html +++ b/docs/NgrokAPI/Models/StaticBackend.html @@ -1201,9 +1201,9 @@

    diff --git a/docs/NgrokAPI/Models/StaticBackendTLS.html b/docs/NgrokAPI/Models/StaticBackendTLS.html index e331c3b7..c36d9009 100644 --- a/docs/NgrokAPI/Models/StaticBackendTLS.html +++ b/docs/NgrokAPI/Models/StaticBackendTLS.html @@ -585,9 +585,9 @@

    diff --git a/docs/NgrokAPI/Models/TCPEdge.html b/docs/NgrokAPI/Models/TCPEdge.html index a7097427..34cc1635 100644 --- a/docs/NgrokAPI/Models/TCPEdge.html +++ b/docs/NgrokAPI/Models/TCPEdge.html @@ -1361,9 +1361,9 @@

    diff --git a/docs/NgrokAPI/Models/TLSCertificate.html b/docs/NgrokAPI/Models/TLSCertificate.html index 69065b46..a41a860e 100644 --- a/docs/NgrokAPI/Models/TLSCertificate.html +++ b/docs/NgrokAPI/Models/TLSCertificate.html @@ -2225,9 +2225,9 @@

    diff --git a/docs/NgrokAPI/Models/TLSCertificateSANs.html b/docs/NgrokAPI/Models/TLSCertificateSANs.html index 3db90af1..e974000f 100644 --- a/docs/NgrokAPI/Models/TLSCertificateSANs.html +++ b/docs/NgrokAPI/Models/TLSCertificateSANs.html @@ -659,9 +659,9 @@

    diff --git a/docs/NgrokAPI/Models/TLSEdge.html b/docs/NgrokAPI/Models/TLSEdge.html index d8a7139b..69024ae1 100644 --- a/docs/NgrokAPI/Models/TLSEdge.html +++ b/docs/NgrokAPI/Models/TLSEdge.html @@ -1521,9 +1521,9 @@

    diff --git a/docs/NgrokAPI/Models/Tunnel.html b/docs/NgrokAPI/Models/Tunnel.html index f65dfd6c..9f8d8f77 100644 --- a/docs/NgrokAPI/Models/Tunnel.html +++ b/docs/NgrokAPI/Models/Tunnel.html @@ -1329,9 +1329,9 @@

    diff --git a/docs/NgrokAPI/Models/TunnelGroupBackend.html b/docs/NgrokAPI/Models/TunnelGroupBackend.html index 05d40f39..b8df964b 100644 --- a/docs/NgrokAPI/Models/TunnelGroupBackend.html +++ b/docs/NgrokAPI/Models/TunnelGroupBackend.html @@ -1195,9 +1195,9 @@

    diff --git a/docs/NgrokAPI/Models/TunnelSession.html b/docs/NgrokAPI/Models/TunnelSession.html index 70d2b83a..f91e73b2 100644 --- a/docs/NgrokAPI/Models/TunnelSession.html +++ b/docs/NgrokAPI/Models/TunnelSession.html @@ -1255,9 +1255,9 @@

    diff --git a/docs/NgrokAPI/Models/UserAgent.html b/docs/NgrokAPI/Models/UserAgent.html index 9d4da3a6..65eaf22b 100644 --- a/docs/NgrokAPI/Models/UserAgent.html +++ b/docs/NgrokAPI/Models/UserAgent.html @@ -955,9 +955,9 @@

    diff --git a/docs/NgrokAPI/Models/Vault.html b/docs/NgrokAPI/Models/Vault.html new file mode 100644 index 00000000..96cff26c --- /dev/null +++ b/docs/NgrokAPI/Models/Vault.html @@ -0,0 +1,1353 @@ + + + + + + + Class: NgrokAPI::Models::Vault + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: NgrokAPI::Models::Vault + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/models/vault.rb
    +
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #attrs ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute attrs.

      +
      + +
    • + + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    • + + + #created_at ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute created_at.

      +
      + +
    • + + +
    • + + + #created_by ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute created_by.

      +
      + +
    • + + +
    • + + + #description ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute description.

      +
      + +
    • + + +
    • + + + #id ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute id.

      +
      + +
    • + + +
    • + + + #last_updated_by ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute last_updated_by.

      +
      + +
    • + + +
    • + + + #metadata ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute metadata.

      +
      + +
    • + + +
    • + + + #name ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute name.

      +
      + +
    • + + +
    • + + + #updated_at ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute updated_at.

      +
      + +
    • + + +
    • + + + #uri ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute uri.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client: nil, attrs: {}) ⇒ Vault + + + + + +

    +
    + +

    Returns a new instance of Vault.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +22
    +23
    +24
    +25
    +26
    +27
    +28
    +29
    +30
    +31
    +32
    +33
    +34
    +35
    +36
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 22
    +
    +def initialize(client: nil, attrs: {})
    +  @client = client
    +  @attrs = attrs
    +  @id = @attrs['id']
    +  unless @attrs['uri'].nil?
    +    @uri = URI(@attrs['uri'])
    +  end
    +  @created_at = @attrs['created_at']
    +  @updated_at = @attrs['updated_at']
    +  @name = @attrs['name']
    +  @description = @attrs['description']
    +  @metadata = @attrs['metadata']
    +  @created_by = @attrs['created_by']
    +  @last_updated_by = @attrs['last_updated_by']
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #attrsObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute attrs.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 10
    +
    +def attrs
    +  @attrs
    +end
    +
    +
    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 10
    +
    +def client
    +  @client
    +end
    +
    +
    + + + +
    +

    + + #created_atObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute created_at.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 10
    +
    +def created_at
    +  @created_at
    +end
    +
    +
    + + + +
    +

    + + #created_byObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute created_by.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 10
    +
    +def created_by
    +  @created_by
    +end
    +
    +
    + + + +
    +

    + + #descriptionObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute description.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 10
    +
    +def description
    +  @description
    +end
    +
    +
    + + + +
    +

    + + #idObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute id.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 10
    +
    +def id
    +  @id
    +end
    +
    +
    + + + +
    +

    + + #last_updated_byObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute last_updated_by.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 10
    +
    +def last_updated_by
    +  @last_updated_by
    +end
    +
    +
    + + + +
    +

    + + #metadataObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute metadata.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 10
    +
    +def 
    +  @metadata
    +end
    +
    +
    + + + +
    +

    + + #nameObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute name.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 10
    +
    +def name
    +  @name
    +end
    +
    +
    + + + +
    +

    + + #updated_atObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute updated_at.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 10
    +
    +def updated_at
    +  @updated_at
    +end
    +
    +
    + + + +
    +

    + + #uriObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute uri.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +10
    +11
    +12
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 10
    +
    +def uri
    +  @uri
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #==(other) ⇒ Object + + + + + +

    + + + + +
    +
    +
    +
    +38
    +39
    +40
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 38
    +
    +def ==(other)
    +  @attrs == other.attrs
    +end
    +
    +
    + +
    +

    + + #deleteObject + + + + + +

    +
    + +

    Delete a Vault

    + +

    ngrok.com/docs/api#api-vaults-delete

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +74
    +75
    +76
    +77
    +78
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 74
    +
    +def delete
    +  @client.delete(
    +    id: @id
    +  )
    +end
    +
    +
    + +
    +

    + + #to_hObject + + + + + +

    + + + + +
    +
    +
    +
    +46
    +47
    +48
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 46
    +
    +def to_h
    +  @attrs.to_h
    +end
    +
    +
    + +
    +

    + + #to_sObject + + + + + +

    + + + + +
    +
    +
    +
    +42
    +43
    +44
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 42
    +
    +def to_s
    +  @attrs.to_s
    +end
    +
    +
    + +
    +

    + + #update(name: nil, metadata: nil, description: nil) ⇒ Object + + + + + +

    +
    + +

    Update an existing Vault by ID

    + +

    ngrok.com/docs/api#api-vaults-update

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +54
    +55
    +56
    +57
    +58
    +59
    +60
    +61
    +62
    +63
    +64
    +65
    +66
    +67
    +68
    +
    +
    # File 'lib/ngrokapi/models/vault.rb', line 54
    +
    +def update(
    +  name: nil,
    +  metadata: nil,
    +  description: nil
    +)
    +  @name = name if name
    +  @metadata =  if 
    +  @description = description if description
    +  @client.update(
    +    id: @id,
    +    name: name,
    +    metadata: ,
    +    description: description
    +  )
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/NgrokAPI/Models/WeightedBackend.html b/docs/NgrokAPI/Models/WeightedBackend.html index 94ec998c..e1989f15 100644 --- a/docs/NgrokAPI/Models/WeightedBackend.html +++ b/docs/NgrokAPI/Models/WeightedBackend.html @@ -1121,9 +1121,9 @@

    diff --git a/docs/NgrokAPI/PagedIterator.html b/docs/NgrokAPI/PagedIterator.html index daa59573..cfd690a0 100644 --- a/docs/NgrokAPI/PagedIterator.html +++ b/docs/NgrokAPI/PagedIterator.html @@ -625,9 +625,9 @@

    diff --git a/docs/NgrokAPI/Services.html b/docs/NgrokAPI/Services.html index 5b21f288..2e3e9cde 100644 --- a/docs/NgrokAPI/Services.html +++ b/docs/NgrokAPI/Services.html @@ -78,8 +78,8 @@
    Defined in:
    -
    lib/ngrokapi/services/tunnels_client.rb,
    - lib/ngrokapi/services/api_keys_client.rb,
    lib/ngrokapi/services/bot_users_client.rb,
    lib/ngrokapi/services/edges_tcp_client.rb,
    lib/ngrokapi/services/edges_tls_client.rb,
    lib/ngrokapi/services/endpoints_client.rb,
    lib/ngrokapi/services/credentials_client.rb,
    lib/ngrokapi/services/edges_https_client.rb,
    lib/ngrokapi/services/ip_policies_client.rb,
    lib/ngrokapi/services/abuse_reports_client.rb,
    lib/ngrokapi/services/event_sources_client.rb,
    lib/ngrokapi/services/reserved_addrs_client.rb,
    lib/ngrokapi/services/agent_ingresses_client.rb,
    lib/ngrokapi/services/ip_policy_rules_client.rb,
    lib/ngrokapi/services/ip_restrictions_client.rb,
    lib/ngrokapi/services/ssh_credentials_client.rb,
    lib/ngrokapi/services/static_backends_client.rb,
    lib/ngrokapi/services/tunnel_sessions_client.rb,
    lib/ngrokapi/services/reserved_domains_client.rb,
    lib/ngrokapi/services/tls_certificates_client.rb,
    lib/ngrokapi/services/application_users_client.rb,
    lib/ngrokapi/services/failover_backends_client.rb,
    lib/ngrokapi/services/weighted_backends_client.rb,
    lib/ngrokapi/services/edges_https_routes_client.rb,
    lib/ngrokapi/services/event_destinations_client.rb,
    lib/ngrokapi/services/event_subscriptions_client.rb,
    lib/ngrokapi/services/application_sessions_client.rb,
    lib/ngrokapi/services/ssh_host_certificates_client.rb,
    lib/ngrokapi/services/ssh_user_certificates_client.rb,
    lib/ngrokapi/services/tunnel_group_backends_client.rb,
    lib/ngrokapi/services/edge_route_oidc_module_client.rb,
    lib/ngrokapi/services/edge_route_saml_module_client.rb,
    lib/ngrokapi/services/http_response_backends_client.rb,
    lib/ngrokapi/services/certificate_authorities_client.rb,
    lib/ngrokapi/services/tcp_edge_backend_module_client.rb,
    lib/ngrokapi/services/tls_edge_backend_module_client.rb,
    lib/ngrokapi/services/edge_route_o_auth_module_client.rb,
    lib/ngrokapi/services/edge_route_backend_module_client.rb,
    lib/ngrokapi/services/tls_edge_mutual_tls_module_client.rb,
    lib/ngrokapi/services/ssh_certificate_authorities_client.rb,
    lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb,
    lib/ngrokapi/services/edge_route_compression_module_client.rb,
    lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb,
    lib/ngrokapi/services/tcp_edge_traffic_policy_module_client.rb,
    lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb,
    lib/ngrokapi/services/tls_edge_traffic_policy_module_client.rb,
    lib/ngrokapi/services/tls_edge_tls_termination_module_client.rb,
    lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb,
    lib/ngrokapi/services/edge_route_traffic_policy_module_client.rb,
    lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb,
    lib/ngrokapi/services/edge_route_request_headers_module_client.rb,
    lib/ngrokapi/services/https_edge_tls_termination_module_client.rb,
    lib/ngrokapi/services/edge_route_response_headers_module_client.rb,
    lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb,
    lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb,
    lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb
    +
    lib/ngrokapi/services/vaults_client.rb,
    + lib/ngrokapi/services/secrets_client.rb,
    lib/ngrokapi/services/tunnels_client.rb,
    lib/ngrokapi/services/api_keys_client.rb,
    lib/ngrokapi/services/bot_users_client.rb,
    lib/ngrokapi/services/edges_tcp_client.rb,
    lib/ngrokapi/services/edges_tls_client.rb,
    lib/ngrokapi/services/endpoints_client.rb,
    lib/ngrokapi/services/credentials_client.rb,
    lib/ngrokapi/services/edges_https_client.rb,
    lib/ngrokapi/services/ip_policies_client.rb,
    lib/ngrokapi/services/abuse_reports_client.rb,
    lib/ngrokapi/services/event_sources_client.rb,
    lib/ngrokapi/services/reserved_addrs_client.rb,
    lib/ngrokapi/services/agent_ingresses_client.rb,
    lib/ngrokapi/services/ip_policy_rules_client.rb,
    lib/ngrokapi/services/ip_restrictions_client.rb,
    lib/ngrokapi/services/ssh_credentials_client.rb,
    lib/ngrokapi/services/static_backends_client.rb,
    lib/ngrokapi/services/tunnel_sessions_client.rb,
    lib/ngrokapi/services/reserved_domains_client.rb,
    lib/ngrokapi/services/tls_certificates_client.rb,
    lib/ngrokapi/services/application_users_client.rb,
    lib/ngrokapi/services/failover_backends_client.rb,
    lib/ngrokapi/services/weighted_backends_client.rb,
    lib/ngrokapi/services/edges_https_routes_client.rb,
    lib/ngrokapi/services/event_destinations_client.rb,
    lib/ngrokapi/services/event_subscriptions_client.rb,
    lib/ngrokapi/services/application_sessions_client.rb,
    lib/ngrokapi/services/ssh_host_certificates_client.rb,
    lib/ngrokapi/services/ssh_user_certificates_client.rb,
    lib/ngrokapi/services/tunnel_group_backends_client.rb,
    lib/ngrokapi/services/edge_route_oidc_module_client.rb,
    lib/ngrokapi/services/edge_route_saml_module_client.rb,
    lib/ngrokapi/services/http_response_backends_client.rb,
    lib/ngrokapi/services/certificate_authorities_client.rb,
    lib/ngrokapi/services/tcp_edge_backend_module_client.rb,
    lib/ngrokapi/services/tls_edge_backend_module_client.rb,
    lib/ngrokapi/services/edge_route_o_auth_module_client.rb,
    lib/ngrokapi/services/edge_route_backend_module_client.rb,
    lib/ngrokapi/services/tls_edge_mutual_tls_module_client.rb,
    lib/ngrokapi/services/ssh_certificate_authorities_client.rb,
    lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb,
    lib/ngrokapi/services/edge_route_compression_module_client.rb,
    lib/ngrokapi/services/tcp_edge_ip_restriction_module_client.rb,
    lib/ngrokapi/services/tcp_edge_traffic_policy_module_client.rb,
    lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb,
    lib/ngrokapi/services/tls_edge_traffic_policy_module_client.rb,
    lib/ngrokapi/services/tls_edge_tls_termination_module_client.rb,
    lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb,
    lib/ngrokapi/services/edge_route_traffic_policy_module_client.rb,
    lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb,
    lib/ngrokapi/services/edge_route_request_headers_module_client.rb,
    lib/ngrokapi/services/https_edge_tls_termination_module_client.rb,
    lib/ngrokapi/services/edge_route_response_headers_module_client.rb,
    lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb,
    lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb,
    lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb
    @@ -91,7 +91,7 @@

    Defined Under Namespace

    - Classes: APIKeysClient, AbuseReportsClient, AgentIngressesClient, ApplicationSessionsClient, ApplicationUsersClient, BotUsersClient, CertificateAuthoritiesClient, CredentialsClient, EdgeRouteBackendModuleClient, EdgeRouteCircuitBreakerModuleClient, EdgeRouteCompressionModuleClient, EdgeRouteIPRestrictionModuleClient, EdgeRouteOAuthModuleClient, EdgeRouteOIDCModuleClient, EdgeRouteRequestHeadersModuleClient, EdgeRouteResponseHeadersModuleClient, EdgeRouteSAMLModuleClient, EdgeRouteTrafficPolicyModuleClient, EdgeRouteUserAgentFilterModuleClient, EdgeRouteWebhookVerificationModuleClient, EdgeRouteWebsocketTCPConverterModuleClient, EdgesHTTPSClient, EdgesHTTPSRoutesClient, EdgesTCPClient, EdgesTLSClient, EndpointsClient, EventDestinationsClient, EventSourcesClient, EventSubscriptionsClient, FailoverBackendsClient, HTTPResponseBackendsClient, HTTPSEdgeMutualTLSModuleClient, HTTPSEdgeTLSTerminationModuleClient, IPPoliciesClient, IPPolicyRulesClient, IPRestrictionsClient, ReservedAddrsClient, ReservedDomainsClient, SSHCertificateAuthoritiesClient, SSHCredentialsClient, SSHHostCertificatesClient, SSHUserCertificatesClient, StaticBackendsClient, TCPEdgeBackendModuleClient, TCPEdgeIPRestrictionModuleClient, TCPEdgeTrafficPolicyModuleClient, TLSCertificatesClient, TLSEdgeBackendModuleClient, TLSEdgeIPRestrictionModuleClient, TLSEdgeMutualTLSModuleClient, TLSEdgeTLSTerminationModuleClient, TLSEdgeTrafficPolicyModuleClient, TunnelGroupBackendsClient, TunnelSessionsClient, TunnelsClient, WeightedBackendsClient + Classes: APIKeysClient, AbuseReportsClient, AgentIngressesClient, ApplicationSessionsClient, ApplicationUsersClient, BotUsersClient, CertificateAuthoritiesClient, CredentialsClient, EdgeRouteBackendModuleClient, EdgeRouteCircuitBreakerModuleClient, EdgeRouteCompressionModuleClient, EdgeRouteIPRestrictionModuleClient, EdgeRouteOAuthModuleClient, EdgeRouteOIDCModuleClient, EdgeRouteRequestHeadersModuleClient, EdgeRouteResponseHeadersModuleClient, EdgeRouteSAMLModuleClient, EdgeRouteTrafficPolicyModuleClient, EdgeRouteUserAgentFilterModuleClient, EdgeRouteWebhookVerificationModuleClient, EdgeRouteWebsocketTCPConverterModuleClient, EdgesHTTPSClient, EdgesHTTPSRoutesClient, EdgesTCPClient, EdgesTLSClient, EndpointsClient, EventDestinationsClient, EventSourcesClient, EventSubscriptionsClient, FailoverBackendsClient, HTTPResponseBackendsClient, HTTPSEdgeMutualTLSModuleClient, HTTPSEdgeTLSTerminationModuleClient, IPPoliciesClient, IPPolicyRulesClient, IPRestrictionsClient, ReservedAddrsClient, ReservedDomainsClient, SSHCertificateAuthoritiesClient, SSHCredentialsClient, SSHHostCertificatesClient, SSHUserCertificatesClient, SecretsClient, StaticBackendsClient, TCPEdgeBackendModuleClient, TCPEdgeIPRestrictionModuleClient, TCPEdgeTrafficPolicyModuleClient, TLSCertificatesClient, TLSEdgeBackendModuleClient, TLSEdgeIPRestrictionModuleClient, TLSEdgeMutualTLSModuleClient, TLSEdgeTLSTerminationModuleClient, TLSEdgeTrafficPolicyModuleClient, TunnelGroupBackendsClient, TunnelSessionsClient, TunnelsClient, VaultsClient, WeightedBackendsClient

    @@ -107,9 +107,9 @@

    Defined Under Namespace

    diff --git a/docs/NgrokAPI/Services/APIKeysClient.html b/docs/NgrokAPI/Services/APIKeysClient.html index 7687f840..a28f835d 100644 --- a/docs/NgrokAPI/Services/APIKeysClient.html +++ b/docs/NgrokAPI/Services/APIKeysClient.html @@ -1749,9 +1749,9 @@

    diff --git a/docs/NgrokAPI/Services/AbuseReportsClient.html b/docs/NgrokAPI/Services/AbuseReportsClient.html index 7d63260c..74fc2ed3 100644 --- a/docs/NgrokAPI/Services/AbuseReportsClient.html +++ b/docs/NgrokAPI/Services/AbuseReportsClient.html @@ -833,9 +833,9 @@

    diff --git a/docs/NgrokAPI/Services/AgentIngressesClient.html b/docs/NgrokAPI/Services/AgentIngressesClient.html index b6e27521..f74bb102 100644 --- a/docs/NgrokAPI/Services/AgentIngressesClient.html +++ b/docs/NgrokAPI/Services/AgentIngressesClient.html @@ -1823,9 +1823,9 @@

    diff --git a/docs/NgrokAPI/Services/ApplicationSessionsClient.html b/docs/NgrokAPI/Services/ApplicationSessionsClient.html index 6c1d119e..fb8dc979 100644 --- a/docs/NgrokAPI/Services/ApplicationSessionsClient.html +++ b/docs/NgrokAPI/Services/ApplicationSessionsClient.html @@ -1121,9 +1121,9 @@

    diff --git a/docs/NgrokAPI/Services/ApplicationUsersClient.html b/docs/NgrokAPI/Services/ApplicationUsersClient.html index f3205ab8..30a5cb72 100644 --- a/docs/NgrokAPI/Services/ApplicationUsersClient.html +++ b/docs/NgrokAPI/Services/ApplicationUsersClient.html @@ -1121,9 +1121,9 @@

    diff --git a/docs/NgrokAPI/Services/BotUsersClient.html b/docs/NgrokAPI/Services/BotUsersClient.html index 3e1ad1a8..4a23a130 100644 --- a/docs/NgrokAPI/Services/BotUsersClient.html +++ b/docs/NgrokAPI/Services/BotUsersClient.html @@ -1707,9 +1707,9 @@

    diff --git a/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html b/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html index 19b83ba2..5d126fba 100644 --- a/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +++ b/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html @@ -1745,9 +1745,9 @@

    diff --git a/docs/NgrokAPI/Services/CredentialsClient.html b/docs/NgrokAPI/Services/CredentialsClient.html index 996f4a09..aa6db1d8 100644 --- a/docs/NgrokAPI/Services/CredentialsClient.html +++ b/docs/NgrokAPI/Services/CredentialsClient.html @@ -1829,9 +1829,9 @@

    diff --git a/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html b/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html index d85b82c8..f3ffa65c 100644 --- a/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +++ b/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html b/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html index 361820ae..a25e8096 100644 --- a/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +++ b/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html b/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html index f18da524..82696bff 100644 --- a/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +++ b/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html b/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html index be57d581..958673c0 100644 --- a/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +++ b/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html b/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html index 4033ba5d..c2bbac5e 100644 --- a/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +++ b/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html b/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html index 76afda7c..b39d58ec 100644 --- a/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +++ b/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html b/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html index 83b81956..5f0bd63b 100644 --- a/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +++ b/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html b/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html index 649f9a2b..39b25d11 100644 --- a/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +++ b/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html b/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html index d02796e7..86d88513 100644 --- a/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +++ b/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/docs/NgrokAPI/Services/EdgeRouteTrafficPolicyModuleClient.html b/docs/NgrokAPI/Services/EdgeRouteTrafficPolicyModuleClient.html index 788f772e..3aed63be 100644 --- a/docs/NgrokAPI/Services/EdgeRouteTrafficPolicyModuleClient.html +++ b/docs/NgrokAPI/Services/EdgeRouteTrafficPolicyModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/docs/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html b/docs/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html index 73e55803..bc27bf99 100644 --- a/docs/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html +++ b/docs/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html b/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html index e69edea5..a6bcc96a 100644 --- a/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +++ b/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html b/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html index da9150a1..120f9e5e 100644 --- a/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +++ b/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html @@ -1139,9 +1139,9 @@

    diff --git a/docs/NgrokAPI/Services/EdgesHTTPSClient.html b/docs/NgrokAPI/Services/EdgesHTTPSClient.html index 75ec4e60..926eebee 100644 --- a/docs/NgrokAPI/Services/EdgesHTTPSClient.html +++ b/docs/NgrokAPI/Services/EdgesHTTPSClient.html @@ -1937,9 +1937,9 @@

    diff --git a/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html b/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html index fa706698..26f28aca 100644 --- a/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +++ b/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html @@ -2715,9 +2715,9 @@

    diff --git a/docs/NgrokAPI/Services/EdgesTCPClient.html b/docs/NgrokAPI/Services/EdgesTCPClient.html index 490efa20..9a297ddc 100644 --- a/docs/NgrokAPI/Services/EdgesTCPClient.html +++ b/docs/NgrokAPI/Services/EdgesTCPClient.html @@ -2017,9 +2017,9 @@

    diff --git a/docs/NgrokAPI/Services/EdgesTLSClient.html b/docs/NgrokAPI/Services/EdgesTLSClient.html index ca3f7bcb..5f47a897 100644 --- a/docs/NgrokAPI/Services/EdgesTLSClient.html +++ b/docs/NgrokAPI/Services/EdgesTLSClient.html @@ -2137,9 +2137,9 @@

    diff --git a/docs/NgrokAPI/Services/EndpointsClient.html b/docs/NgrokAPI/Services/EndpointsClient.html index 41818e2a..35ea2fa5 100644 --- a/docs/NgrokAPI/Services/EndpointsClient.html +++ b/docs/NgrokAPI/Services/EndpointsClient.html @@ -207,7 +207,7 @@

  • - #create(url: "", type: "", traffic_policy: "", description: nil, metadata: nil, bindings: nil) ⇒ NgrokAPI::Models::Endpoint + #create(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ NgrokAPI::Models::Endpoint @@ -231,7 +231,7 @@

  • - #create!(url: "", type: "", traffic_policy: "", description: nil, metadata: nil, bindings: nil) ⇒ NgrokAPI::Models::Endpoint + #create!(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ NgrokAPI::Models::Endpoint @@ -377,7 +377,7 @@

  • - #list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable + #list(before_id: nil, limit: nil, ids: [], urls: [], url: nil) ⇒ NgrokAPI::Models::Listable @@ -401,7 +401,7 @@

  • - #list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable + #list!(before_id: nil, limit: nil, ids: [], urls: [], url: nil) ⇒ NgrokAPI::Models::Listable @@ -425,7 +425,7 @@

  • - #update(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil) ⇒ NgrokAPI::Models::Endpoint + #update(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ NgrokAPI::Models::Endpoint @@ -449,7 +449,7 @@

  • - #update!(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil) ⇒ NgrokAPI::Models::Endpoint + #update!(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ NgrokAPI::Models::Endpoint @@ -575,7 +575,7 @@

    Instance Method Details

    - #create(url: "", type: "", traffic_policy: "", description: nil, metadata: nil, bindings: nil) ⇒ NgrokAPI::Models::Endpoint + #create(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ NgrokAPI::Models::Endpoint @@ -603,8 +603,6 @@

    (string) - (defaults to: "") - —
    @@ -621,12 +619,10 @@

    (string) - (defaults to: "") - —
    -

    whether the endpoint is ephemeral (served directly by an agent-initiated tunnel) or edge (served by an edge) or cloud (represents a cloud endpoint)

    +

    Type of endpoint. Only ‘cloud’ is currently supported (represents a cloud endpoint). Defaults to ‘cloud’ if not specified.

  • @@ -639,8 +635,6 @@

    (string) - (defaults to: "") - —
    @@ -703,6 +697,19 @@

  • +
  • + + pooling_enabled + + + (boolean) + + + (defaults to: False) + + +
  • +

    Returns:

    @@ -730,7 +737,6 @@

     
     
    -37
     38
     39
     40
    @@ -743,12 +749,14 @@ 

    47 48 49 -50

    +50 +51 +52

  • -
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 37
    +      
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 38
     
    -def create(url: "", type: "", traffic_policy: "", description: nil, metadata: nil, bindings: nil)
    +def create(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: False)
       path = '/endpoints'
       replacements = {
       }
    @@ -759,6 +767,7 @@ 

    data[:description] = description if description data[:metadata] = if data[:bindings] = bindings if bindings + data[:pooling_enabled] = pooling_enabled if pooling_enabled result = @client.post(path % replacements, data: data) NgrokAPI::Models::Endpoint.new(client: self, attrs: result) end

    @@ -770,7 +779,7 @@

    - #create!(url: "", type: "", traffic_policy: "", description: nil, metadata: nil, bindings: nil) ⇒ NgrokAPI::Models::Endpoint + #create!(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ NgrokAPI::Models::Endpoint @@ -798,8 +807,6 @@

    (string) - (defaults to: "") - —
    @@ -816,12 +823,10 @@

    (string) - (defaults to: "") - —
    -

    whether the endpoint is ephemeral (served directly by an agent-initiated tunnel) or edge (served by an edge) or cloud (represents a cloud endpoint)

    +

    Type of endpoint. Only ‘cloud’ is currently supported (represents a cloud endpoint). Defaults to ‘cloud’ if not specified.

    @@ -834,8 +839,6 @@

    (string) - (defaults to: "") - —
    @@ -898,6 +901,19 @@

    +
  • + + pooling_enabled + + + (boolean) + + + (defaults to: False) + + +
  • +

    Returns:

    @@ -925,9 +941,6 @@

     
     
    -65
    -66
    -67
     68
     69
     70
    @@ -938,12 +951,16 @@ 

    75 76 77 -78

    +78 +79 +80 +81 +82

    -
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 65
    +      
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 68
     
    -def create!(url: "", type: "", traffic_policy: "", description: nil, metadata: nil, bindings: nil)
    +def create!(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: False)
       path = '/endpoints'
       replacements = {
       }
    @@ -954,6 +971,7 @@ 

    data[:description] = description if description data[:metadata] = if data[:bindings] = bindings if bindings + data[:pooling_enabled] = pooling_enabled if pooling_enabled result = @client.post(path % replacements, data: data, danger: true) NgrokAPI::Models::Endpoint.new(client: self, attrs: result) end

    @@ -1030,16 +1048,16 @@

     
     
    -230
    -231
    -232
    -233
    -234
    -235
    -236
    +246 +247 +248 +249 +250 +251 +252

    -
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 230
    +      
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 246
     
     def delete(id: "")
       path = '/endpoints/%{id}'
    @@ -1121,16 +1139,16 @@ 

     
     
    -246
    -247
    -248
    -249
    -250
    -251
    -252
    +262 +263 +264 +265 +266 +267 +268

    -
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 246
    +      
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 262
     
     def delete!(id: "")
       path = '/endpoints/%{id}'
    @@ -1212,18 +1230,18 @@ 

     
     
    -140
    -141
    -142
    -143
    -144
    -145
    -146
    -147
    -148
    +152 +153 +154 +155 +156 +157 +158 +159 +160

    -
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 140
    +      
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 152
     
     def get(id: "")
       path = '/endpoints/%{id}'
    @@ -1307,18 +1325,18 @@ 

     
     
    -158
    -159
    -160
    -161
    -162
    -163
    -164
    -165
    -166
    +170 +171 +172 +173 +174 +175 +176 +177 +178

    -
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 158
    +      
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 170
     
     def get!(id: "")
       path = '/endpoints/%{id}'
    @@ -1337,7 +1355,7 @@ 

    - #list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable + #list(before_id: nil, limit: nil, ids: [], urls: [], url: nil) ⇒ NgrokAPI::Models::Listable @@ -1381,6 +1399,32 @@

    (defaults to: nil) + + +
  • + + ids + + + (List<string>) + + + (defaults to: []) + + +
  • + +
  • + + urls + + + (List<string>) + + + (defaults to: []) + +
  • @@ -1428,12 +1472,6 @@

     
     
    -89
    -90
    -91
    -92
    -93
    -94
     95
     96
     97
    @@ -1442,15 +1480,25 @@ 

    100 101 102 -103

    +103 +104 +105 +106 +107 +108 +109 +110 +111

  • -
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 89
    +      
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 95
     
    -def list(before_id: nil, limit: nil, url: nil)
    +def list(before_id: nil, limit: nil, ids: [], urls: [], url: nil)
       result = @client.list(
         before_id: before_id,
         limit: limit,
    +    ids: ids,
    +    urls: urls,
         url: url,
         path: PATH
       )
    @@ -1470,7 +1518,7 @@ 

    - #list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable + #list!(before_id: nil, limit: nil, ids: [], urls: [], url: nil) ⇒ NgrokAPI::Models::Listable @@ -1514,6 +1562,32 @@

    (defaults to: nil) + + +
  • + + ids + + + (List<string>) + + + (defaults to: []) + + +
  • + +
  • + + urls + + + (List<string>) + + + (defaults to: []) + +
  • @@ -1561,31 +1635,35 @@

     
     
    -115
    -116
    -117
    -118
    -119
    -120
    -121
    -122
    -123
    -124
     125
     126
     127
     128
     129
     130
    -131
    +131 +132 +133 +134 +135 +136 +137 +138 +139 +140 +141 +142 +143

  • -
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 115
    +      
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 125
     
    -def list!(before_id: nil, limit: nil, url: nil)
    +def list!(before_id: nil, limit: nil, ids: [], urls: [], url: nil)
       result = @client.list(
         before_id: before_id,
         limit: limit,
    +    ids: ids,
    +    urls: urls,
         danger: true,
         url: url,
         path: PATH
    @@ -1607,7 +1685,7 @@ 

    - #update(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil) ⇒ NgrokAPI::Models::Endpoint + #update(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ NgrokAPI::Models::Endpoint @@ -1735,6 +1813,19 @@

    +
  • + + pooling_enabled + + + (boolean) + + + (defaults to: False) + + +
  • +

    Returns:

    @@ -1762,25 +1853,26 @@

     
     
    -180
    -181
    -182
    -183
    -184
    -185
    -186
    -187
    -188
    -189
    -190
    -191
    -192
    -193
    +193 +194 +195 +196 +197 +198 +199 +200 +201 +202 +203 +204 +205 +206 +207

    -
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 180
    +      
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 193
     
    -def update(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil)
    +def update(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False)
       path = '/endpoints/%{id}'
       replacements = {
         id: id,
    @@ -1791,6 +1883,7 @@ 

    data[:description] = description if description data[:metadata] = if data[:bindings] = bindings if bindings + data[:pooling_enabled] = pooling_enabled if pooling_enabled result = @client.patch(path % replacements, data: data) NgrokAPI::Models::Endpoint.new(client: self, attrs: result) end

    @@ -1802,7 +1895,7 @@

    - #update!(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil) ⇒ NgrokAPI::Models::Endpoint + #update!(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ NgrokAPI::Models::Endpoint @@ -1930,6 +2023,19 @@

    +
  • + + pooling_enabled + + + (boolean) + + + (defaults to: False) + + +
  • +

    Returns:

    @@ -1957,25 +2063,26 @@

     
     
    -208
    -209
    -210
    -211
    -212
    -213
    -214
    -215
    -216
    -217
    -218
    -219
    -220
    -221
    +223 +224 +225 +226 +227 +228 +229 +230 +231 +232 +233 +234 +235 +236 +237

    -
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 208
    +      
    # File 'lib/ngrokapi/services/endpoints_client.rb', line 223
     
    -def update!(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil)
    +def update!(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False)
       path = '/endpoints/%{id}'
       replacements = {
         id: id,
    @@ -1986,6 +2093,7 @@ 

    data[:description] = description if description data[:metadata] = if data[:bindings] = bindings if bindings + data[:pooling_enabled] = pooling_enabled if pooling_enabled result = @client.patch(path % replacements, data: data, danger: true) NgrokAPI::Models::Endpoint.new(client: self, attrs: result) end

    @@ -1999,9 +2107,9 @@

    diff --git a/docs/NgrokAPI/Services/EventDestinationsClient.html b/docs/NgrokAPI/Services/EventDestinationsClient.html index 5b0cf977..a88cde23 100644 --- a/docs/NgrokAPI/Services/EventDestinationsClient.html +++ b/docs/NgrokAPI/Services/EventDestinationsClient.html @@ -1877,9 +1877,9 @@

    diff --git a/docs/NgrokAPI/Services/EventSourcesClient.html b/docs/NgrokAPI/Services/EventSourcesClient.html index a58771a8..450f406d 100644 --- a/docs/NgrokAPI/Services/EventSourcesClient.html +++ b/docs/NgrokAPI/Services/EventSourcesClient.html @@ -1661,9 +1661,9 @@

    diff --git a/docs/NgrokAPI/Services/EventSubscriptionsClient.html b/docs/NgrokAPI/Services/EventSubscriptionsClient.html index de22f570..90a0b262 100644 --- a/docs/NgrokAPI/Services/EventSubscriptionsClient.html +++ b/docs/NgrokAPI/Services/EventSubscriptionsClient.html @@ -1877,9 +1877,9 @@

    diff --git a/docs/NgrokAPI/Services/FailoverBackendsClient.html b/docs/NgrokAPI/Services/FailoverBackendsClient.html index 35b23e18..9de85477 100644 --- a/docs/NgrokAPI/Services/FailoverBackendsClient.html +++ b/docs/NgrokAPI/Services/FailoverBackendsClient.html @@ -1789,9 +1789,9 @@

    diff --git a/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html b/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html index ed821016..bd3bb984 100644 --- a/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +++ b/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html @@ -1927,9 +1927,9 @@

    diff --git a/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html b/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html index b030a93b..17c3b797 100644 --- a/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +++ b/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html @@ -1029,9 +1029,9 @@

    diff --git a/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html b/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html index b7933f6b..fd557387 100644 --- a/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +++ b/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html @@ -1029,9 +1029,9 @@

    diff --git a/docs/NgrokAPI/Services/IPPoliciesClient.html b/docs/NgrokAPI/Services/IPPoliciesClient.html index fe2d8413..0516b066 100644 --- a/docs/NgrokAPI/Services/IPPoliciesClient.html +++ b/docs/NgrokAPI/Services/IPPoliciesClient.html @@ -1709,9 +1709,9 @@

    diff --git a/docs/NgrokAPI/Services/IPPolicyRulesClient.html b/docs/NgrokAPI/Services/IPPolicyRulesClient.html index 3c816472..f0293352 100644 --- a/docs/NgrokAPI/Services/IPPolicyRulesClient.html +++ b/docs/NgrokAPI/Services/IPPolicyRulesClient.html @@ -1857,9 +1857,9 @@

    diff --git a/docs/NgrokAPI/Services/IPRestrictionsClient.html b/docs/NgrokAPI/Services/IPRestrictionsClient.html index d111f0a0..24837129 100644 --- a/docs/NgrokAPI/Services/IPRestrictionsClient.html +++ b/docs/NgrokAPI/Services/IPRestrictionsClient.html @@ -1901,9 +1901,9 @@

    diff --git a/docs/NgrokAPI/Services/ReservedAddrsClient.html b/docs/NgrokAPI/Services/ReservedAddrsClient.html index 8f50432d..84def8a7 100644 --- a/docs/NgrokAPI/Services/ReservedAddrsClient.html +++ b/docs/NgrokAPI/Services/ReservedAddrsClient.html @@ -1749,9 +1749,9 @@

    diff --git a/docs/NgrokAPI/Services/ReservedDomainsClient.html b/docs/NgrokAPI/Services/ReservedDomainsClient.html index dddae276..72183517 100644 --- a/docs/NgrokAPI/Services/ReservedDomainsClient.html +++ b/docs/NgrokAPI/Services/ReservedDomainsClient.html @@ -2409,9 +2409,9 @@

    diff --git a/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html b/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html index 1c411ff0..836e5f67 100644 --- a/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +++ b/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html @@ -1829,9 +1829,9 @@

    diff --git a/docs/NgrokAPI/Services/SSHCredentialsClient.html b/docs/NgrokAPI/Services/SSHCredentialsClient.html index c3417e3e..a76c172f 100644 --- a/docs/NgrokAPI/Services/SSHCredentialsClient.html +++ b/docs/NgrokAPI/Services/SSHCredentialsClient.html @@ -1865,9 +1865,9 @@

    diff --git a/docs/NgrokAPI/Services/SSHHostCertificatesClient.html b/docs/NgrokAPI/Services/SSHHostCertificatesClient.html index 310be8f5..5943e447 100644 --- a/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +++ b/docs/NgrokAPI/Services/SSHHostCertificatesClient.html @@ -1901,9 +1901,9 @@

    diff --git a/docs/NgrokAPI/Services/SSHUserCertificatesClient.html b/docs/NgrokAPI/Services/SSHUserCertificatesClient.html index 5f469dae..b3426062 100644 --- a/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +++ b/docs/NgrokAPI/Services/SSHUserCertificatesClient.html @@ -1981,9 +1981,9 @@

    diff --git a/docs/NgrokAPI/Services/SecretsClient.html b/docs/NgrokAPI/Services/SecretsClient.html new file mode 100644 index 00000000..5690d9a5 --- /dev/null +++ b/docs/NgrokAPI/Services/SecretsClient.html @@ -0,0 +1,1925 @@ + + + + + + + Class: NgrokAPI::Services::SecretsClient + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: NgrokAPI::Services::SecretsClient + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/services/secrets_client.rb
    +
    + +
    + +

    Overview

    +
    + +

    Secrets is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.

    + +

    ngrok.com/docs/api#api-secrets

    + + +
    +
    +
    + + +
    + +

    + Constant Summary + collapse +

    + +
    + +
    PATH = +
    +
    + +

    The API path for the requests

    + + +
    +
    +
    + + +
    +
    +
    '/vault_secrets'
    + +
    LIST_PROPERTY = +
    +
    + +

    The List Property from the resulting API for list calls

    + + +
    +
    +
    + + +
    +
    +
    'secrets'
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client:) ⇒ SecretsClient + + + + + +

    +
    + +

    Returns a new instance of SecretsClient.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +20
    +21
    +22
    +
    +
    # File 'lib/ngrokapi/services/secrets_client.rb', line 20
    +
    +def initialize(client:)
    +  @client = client
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +18
    +19
    +20
    +
    +
    # File 'lib/ngrokapi/services/secrets_client.rb', line 18
    +
    +def client
    +  @client
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #create(name: "", value: "", metadata: "", description: "", vault_id:) ⇒ NgrokAPI::Models::Secret + + + + + +

    +
    + +

    Create a new Secret

    + +

    ngrok.com/docs/api#api-secrets-create

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + name + + + (string) + + + (defaults to: "") + + + — +
      +

      Name of secret

      +
      + +
    • + +
    • + + value + + + (string) + + + (defaults to: "") + + + — +
      +

      Value of secret

      +
      + +
    • + +
    • + + metadata + + + (string) + + + (defaults to: "") + + + — +
      +

      Arbitrary user-defined metadata for this Secret

      +
      + +
    • + +
    • + + description + + + (string) + + + (defaults to: "") + + + — +
      +

      description of Secret

      +
      + +
    • + +
    • + + vault_id + + + (string) + + + + — +
      +

      unique identifier of the referenced vault

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +35
    +36
    +37
    +38
    +39
    +40
    +41
    +42
    +43
    +44
    +45
    +46
    +47
    +
    +
    # File 'lib/ngrokapi/services/secrets_client.rb', line 35
    +
    +def create(name: "", value: "", metadata: "", description: "", vault_id:)
    +  path = '/vault_secrets'
    +  replacements = {
    +  }
    +  data = {}
    +  data[:name] = name if name
    +  data[:value] = value if value
    +  data[:metadata] =  if 
    +  data[:description] = description if description
    +  data[:vault_id] = vault_id if vault_id
    +  result = @client.post(path % replacements, data: data)
    +  NgrokAPI::Models::Secret.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #create!(name: "", value: "", metadata: "", description: "", vault_id:) ⇒ NgrokAPI::Models::Secret + + + + + +

    +
    + +

    Create a new Secret Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-secrets-create

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + name + + + (string) + + + (defaults to: "") + + + — +
      +

      Name of secret

      +
      + +
    • + +
    • + + value + + + (string) + + + (defaults to: "") + + + — +
      +

      Value of secret

      +
      + +
    • + +
    • + + metadata + + + (string) + + + (defaults to: "") + + + — +
      +

      Arbitrary user-defined metadata for this Secret

      +
      + +
    • + +
    • + + description + + + (string) + + + (defaults to: "") + + + — +
      +

      description of Secret

      +
      + +
    • + +
    • + + vault_id + + + (string) + + + + — +
      +

      unique identifier of the referenced vault

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +61
    +62
    +63
    +64
    +65
    +66
    +67
    +68
    +69
    +70
    +71
    +72
    +73
    +
    +
    # File 'lib/ngrokapi/services/secrets_client.rb', line 61
    +
    +def create!(name: "", value: "", metadata: "", description: "", vault_id:)
    +  path = '/vault_secrets'
    +  replacements = {
    +  }
    +  data = {}
    +  data[:name] = name if name
    +  data[:value] = value if value
    +  data[:metadata] =  if 
    +  data[:description] = description if description
    +  data[:vault_id] = vault_id if vault_id
    +  result = @client.post(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::Secret.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #delete(id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    + +

    Delete a Secret

    + +

    ngrok.com/docs/api#api-secrets-delete

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +133
    +134
    +135
    +136
    +137
    +138
    +139
    +
    +
    # File 'lib/ngrokapi/services/secrets_client.rb', line 133
    +
    +def delete(id: "")
    +  path = '/vault_secrets/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  @client.delete(path % replacements)
    +end
    +
    +
    + +
    +

    + + #delete!(id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    + +

    Delete a Secret Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-secrets-delete

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +149
    +150
    +151
    +152
    +153
    +154
    +155
    +
    +
    # File 'lib/ngrokapi/services/secrets_client.rb', line 149
    +
    +def delete!(id: "")
    +  path = '/vault_secrets/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  @client.delete(path % replacements, danger: true)
    +end
    +
    +
    + +
    +

    + + #get(id: "") ⇒ NgrokAPI::Models::Secret + + + + + +

    +
    + +

    Get a Secret by ID

    + +

    ngrok.com/docs/api#api-secrets-get

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +164
    +165
    +166
    +167
    +168
    +169
    +170
    +171
    +172
    +
    +
    # File 'lib/ngrokapi/services/secrets_client.rb', line 164
    +
    +def get(id: "")
    +  path = '/vault_secrets/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data)
    +  NgrokAPI::Models::Secret.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #get!(id: "") ⇒ NgrokAPI::Models::Secret + + + + + +

    +
    + +

    Get a Secret by ID Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-secrets-get

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +182
    +183
    +184
    +185
    +186
    +187
    +188
    +189
    +190
    +
    +
    # File 'lib/ngrokapi/services/secrets_client.rb', line 182
    +
    +def get!(id: "")
    +  path = '/vault_secrets/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::Secret.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable + + + + + +

    +
    + +

    List all Secrets owned by account

    + +

    ngrok.com/docs/api#api-secrets-list

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + before_id + + + (string) + + + (defaults to: nil) + + +
    • + +
    • + + limit + + + (string) + + + (defaults to: nil) + + +
    • + +
    • + + url + + + (string) + + + (defaults to: nil) + + + — +
      +

      optional and mutually exclusive from before_id and limit

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +201
    +202
    +203
    +204
    +205
    +206
    +207
    +208
    +209
    +210
    +211
    +212
    +213
    +214
    +215
    +
    +
    # File 'lib/ngrokapi/services/secrets_client.rb', line 201
    +
    +def list(before_id: nil, limit: nil, url: nil)
    +  result = @client.list(
    +    before_id: before_id,
    +    limit: limit,
    +    url: url,
    +    path: PATH
    +  )
    +
    +  NgrokAPI::Models::Listable.new(
    +    client: self,
    +    attrs: result,
    +    list_property: LIST_PROPERTY,
    +    klass: NgrokAPI::Models::Secret
    +  )
    +end
    +
    +
    + +
    +

    + + #list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable + + + + + +

    +
    + +

    List all Secrets owned by account Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-secrets-list

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + before_id + + + (string) + + + (defaults to: nil) + + +
    • + +
    • + + limit + + + (string) + + + (defaults to: nil) + + +
    • + +
    • + + url + + + (string) + + + (defaults to: nil) + + + — +
      +

      optional and mutually exclusive from before_id and limit

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +227
    +228
    +229
    +230
    +231
    +232
    +233
    +234
    +235
    +236
    +237
    +238
    +239
    +240
    +241
    +242
    +243
    +
    +
    # File 'lib/ngrokapi/services/secrets_client.rb', line 227
    +
    +def list!(before_id: nil, limit: nil, url: nil)
    +  result = @client.list(
    +    before_id: before_id,
    +    limit: limit,
    +    danger: true,
    +    url: url,
    +    path: PATH
    +  )
    +
    +  NgrokAPI::Models::Listable.new(
    +    client: self,
    +    attrs: result,
    +    list_property: LIST_PROPERTY,
    +    klass: NgrokAPI::Models::Secret,
    +    danger: true
    +  )
    +end
    +
    +
    + +
    +

    + + #update(id: "", name: nil, value: nil, metadata: nil, description: nil) ⇒ NgrokAPI::Models::Secret + + + + + +

    +
    + +

    Update an existing Secret by ID

    + +

    ngrok.com/docs/api#api-secrets-update

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      identifier for Secret

      +
      + +
    • + +
    • + + name + + + (string) + + + (defaults to: nil) + + + — +
      +

      Name of secret

      +
      + +
    • + +
    • + + value + + + (string) + + + (defaults to: nil) + + + — +
      +

      Value of secret

      +
      + +
    • + +
    • + + metadata + + + (string) + + + (defaults to: nil) + + + — +
      +

      Arbitrary user-defined metadata for this Secret

      +
      + +
    • + +
    • + + description + + + (string) + + + (defaults to: nil) + + + — +
      +

      description of Secret

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +86
    +87
    +88
    +89
    +90
    +91
    +92
    +93
    +94
    +95
    +96
    +97
    +98
    +
    +
    # File 'lib/ngrokapi/services/secrets_client.rb', line 86
    +
    +def update(id: "", name: nil, value: nil, metadata: nil, description: nil)
    +  path = '/vault_secrets/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  data[:name] = name if name
    +  data[:value] = value if value
    +  data[:metadata] =  if 
    +  data[:description] = description if description
    +  result = @client.patch(path % replacements, data: data)
    +  NgrokAPI::Models::Secret.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #update!(id: "", name: nil, value: nil, metadata: nil, description: nil) ⇒ NgrokAPI::Models::Secret + + + + + +

    +
    + +

    Update an existing Secret by ID Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-secrets-update

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      identifier for Secret

      +
      + +
    • + +
    • + + name + + + (string) + + + (defaults to: nil) + + + — +
      +

      Name of secret

      +
      + +
    • + +
    • + + value + + + (string) + + + (defaults to: nil) + + + — +
      +

      Value of secret

      +
      + +
    • + +
    • + + metadata + + + (string) + + + (defaults to: nil) + + + — +
      +

      Arbitrary user-defined metadata for this Secret

      +
      + +
    • + +
    • + + description + + + (string) + + + (defaults to: nil) + + + — +
      +

      description of Secret

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +112
    +113
    +114
    +115
    +116
    +117
    +118
    +119
    +120
    +121
    +122
    +123
    +124
    +
    +
    # File 'lib/ngrokapi/services/secrets_client.rb', line 112
    +
    +def update!(id: "", name: nil, value: nil, metadata: nil, description: nil)
    +  path = '/vault_secrets/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  data[:name] = name if name
    +  data[:value] = value if value
    +  data[:metadata] =  if 
    +  data[:description] = description if description
    +  result = @client.patch(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::Secret.new(client: self, attrs: result)
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/NgrokAPI/Services/StaticBackendsClient.html b/docs/NgrokAPI/Services/StaticBackendsClient.html index 4267ed3c..cb60f694 100644 --- a/docs/NgrokAPI/Services/StaticBackendsClient.html +++ b/docs/NgrokAPI/Services/StaticBackendsClient.html @@ -1869,9 +1869,9 @@

    diff --git a/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html b/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html index b1f6e95d..4824a54e 100644 --- a/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +++ b/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html @@ -1029,9 +1029,9 @@

    diff --git a/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html b/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html index 27cb3743..33384477 100644 --- a/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +++ b/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html @@ -1029,9 +1029,9 @@

    diff --git a/docs/NgrokAPI/Services/TCPEdgeTrafficPolicyModuleClient.html b/docs/NgrokAPI/Services/TCPEdgeTrafficPolicyModuleClient.html index 240689ec..87253b11 100644 --- a/docs/NgrokAPI/Services/TCPEdgeTrafficPolicyModuleClient.html +++ b/docs/NgrokAPI/Services/TCPEdgeTrafficPolicyModuleClient.html @@ -1029,9 +1029,9 @@

    diff --git a/docs/NgrokAPI/Services/TLSCertificatesClient.html b/docs/NgrokAPI/Services/TLSCertificatesClient.html index b1ef4d94..fcd49e1e 100644 --- a/docs/NgrokAPI/Services/TLSCertificatesClient.html +++ b/docs/NgrokAPI/Services/TLSCertificatesClient.html @@ -1781,9 +1781,9 @@

    diff --git a/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html b/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html index df3f351e..89a53d4c 100644 --- a/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +++ b/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html @@ -1029,9 +1029,9 @@

    diff --git a/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html b/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html index 25fcbbfa..e50be6c5 100644 --- a/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +++ b/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html @@ -1029,9 +1029,9 @@

    diff --git a/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html b/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html index 0c7604d9..59e25861 100644 --- a/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +++ b/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html @@ -1029,9 +1029,9 @@

    diff --git a/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html b/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html index b01ce109..c1140052 100644 --- a/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +++ b/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html @@ -1029,9 +1029,9 @@

    diff --git a/docs/NgrokAPI/Services/TLSEdgeTrafficPolicyModuleClient.html b/docs/NgrokAPI/Services/TLSEdgeTrafficPolicyModuleClient.html index 173f984e..2429a517 100644 --- a/docs/NgrokAPI/Services/TLSEdgeTrafficPolicyModuleClient.html +++ b/docs/NgrokAPI/Services/TLSEdgeTrafficPolicyModuleClient.html @@ -1029,9 +1029,9 @@

    diff --git a/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html b/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html index 183ddec7..eaece049 100644 --- a/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +++ b/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html @@ -1789,9 +1789,9 @@

    diff --git a/docs/NgrokAPI/Services/TunnelSessionsClient.html b/docs/NgrokAPI/Services/TunnelSessionsClient.html index 6e07eb8c..4486de0d 100644 --- a/docs/NgrokAPI/Services/TunnelSessionsClient.html +++ b/docs/NgrokAPI/Services/TunnelSessionsClient.html @@ -1573,9 +1573,9 @@

    diff --git a/docs/NgrokAPI/Services/TunnelsClient.html b/docs/NgrokAPI/Services/TunnelsClient.html index 8686d428..35bbbfd0 100644 --- a/docs/NgrokAPI/Services/TunnelsClient.html +++ b/docs/NgrokAPI/Services/TunnelsClient.html @@ -893,9 +893,9 @@

    diff --git a/docs/NgrokAPI/Services/VaultsClient.html b/docs/NgrokAPI/Services/VaultsClient.html new file mode 100644 index 00000000..85c5a626 --- /dev/null +++ b/docs/NgrokAPI/Services/VaultsClient.html @@ -0,0 +1,1809 @@ + + + + + + + Class: NgrokAPI::Services::VaultsClient + + — Documentation by YARD 0.9.36 + + + + + + + + + + + + + + + + + + + +
    + + +

    Class: NgrokAPI::Services::VaultsClient + + + +

    +
    + +
    +
    Inherits:
    +
    + Object + +
      +
    • Object
    • + + + +
    + show all + +
    +
    + + + + + + + + + + + +
    +
    Defined in:
    +
    lib/ngrokapi/services/vaults_client.rb
    +
    + +
    + +

    Overview

    +
    + +

    Vaults is an api service for securely storing and managing sensitive data such as secrets, credentials, and tokens.

    + +

    ngrok.com/docs/api#api-vaults

    + + +
    +
    +
    + + +
    + +

    + Constant Summary + collapse +

    + +
    + +
    PATH = +
    +
    + +

    The API path for the requests

    + + +
    +
    +
    + + +
    +
    +
    '/vaults'
    + +
    LIST_PROPERTY = +
    +
    + +

    The List Property from the resulting API for list calls

    + + +
    +
    +
    + + +
    +
    +
    'vaults'
    + +
    + + + + + +

    Instance Attribute Summary collapse

    +
      + +
    • + + + #client ⇒ Object + + + + + + + + + readonly + + + + + + + + + +
      +

      Returns the value of attribute client.

      +
      + +
    • + + +
    + + + + + +

    + Instance Method Summary + collapse +

    + + + + +
    +

    Constructor Details

    + +
    +

    + + #initialize(client:) ⇒ VaultsClient + + + + + +

    +
    + +

    Returns a new instance of VaultsClient.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +20
    +21
    +22
    +
    +
    # File 'lib/ngrokapi/services/vaults_client.rb', line 20
    +
    +def initialize(client:)
    +  @client = client
    +end
    +
    +
    + +
    + +
    +

    Instance Attribute Details

    + + + +
    +

    + + #clientObject (readonly) + + + + + +

    +
    + +

    Returns the value of attribute client.

    + + +
    +
    +
    + + +
    + + + + +
    +
    +
    +
    +18
    +19
    +20
    +
    +
    # File 'lib/ngrokapi/services/vaults_client.rb', line 18
    +
    +def client
    +  @client
    +end
    +
    +
    + +
    + + +
    +

    Instance Method Details

    + + +
    +

    + + #create(name: "", metadata: "", description: "") ⇒ NgrokAPI::Models::Vault + + + + + +

    +
    + +

    Create a new Vault

    + +

    ngrok.com/docs/api#api-vaults-create

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + name + + + (string) + + + (defaults to: "") + + + — +
      +

      Name of vault

      +
      + +
    • + +
    • + + metadata + + + (string) + + + (defaults to: "") + + + — +
      +

      Arbitrary user-defined metadata for this Vault

      +
      + +
    • + +
    • + + description + + + (string) + + + (defaults to: "") + + + — +
      +

      description of Vault

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +33
    +34
    +35
    +36
    +37
    +38
    +39
    +40
    +41
    +42
    +43
    +
    +
    # File 'lib/ngrokapi/services/vaults_client.rb', line 33
    +
    +def create(name: "", metadata: "", description: "")
    +  path = '/vaults'
    +  replacements = {
    +  }
    +  data = {}
    +  data[:name] = name if name
    +  data[:metadata] =  if 
    +  data[:description] = description if description
    +  result = @client.post(path % replacements, data: data)
    +  NgrokAPI::Models::Vault.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #create!(name: "", metadata: "", description: "") ⇒ NgrokAPI::Models::Vault + + + + + +

    +
    + +

    Create a new Vault Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-vaults-create

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + name + + + (string) + + + (defaults to: "") + + + — +
      +

      Name of vault

      +
      + +
    • + +
    • + + metadata + + + (string) + + + (defaults to: "") + + + — +
      +

      Arbitrary user-defined metadata for this Vault

      +
      + +
    • + +
    • + + description + + + (string) + + + (defaults to: "") + + + — +
      +

      description of Vault

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +55
    +56
    +57
    +58
    +59
    +60
    +61
    +62
    +63
    +64
    +65
    +
    +
    # File 'lib/ngrokapi/services/vaults_client.rb', line 55
    +
    +def create!(name: "", metadata: "", description: "")
    +  path = '/vaults'
    +  replacements = {
    +  }
    +  data = {}
    +  data[:name] = name if name
    +  data[:metadata] =  if 
    +  data[:description] = description if description
    +  result = @client.post(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::Vault.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #delete(id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    + +

    Delete a Vault

    + +

    ngrok.com/docs/api#api-vaults-delete

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +121
    +122
    +123
    +124
    +125
    +126
    +127
    +
    +
    # File 'lib/ngrokapi/services/vaults_client.rb', line 121
    +
    +def delete(id: "")
    +  path = '/vaults/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  @client.delete(path % replacements)
    +end
    +
    +
    + +
    +

    + + #delete!(id: "") ⇒ NgrokAPI::Models::Empty + + + + + +

    +
    + +

    Delete a Vault Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-vaults-delete

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    +
      + +
    • + + + (NgrokAPI::Models::Empty) + + + + — +
      +

      result from the API request

      +
      + +
    • + +
    + +
    + + + + +
    +
    +
    +
    +137
    +138
    +139
    +140
    +141
    +142
    +143
    +
    +
    # File 'lib/ngrokapi/services/vaults_client.rb', line 137
    +
    +def delete!(id: "")
    +  path = '/vaults/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  @client.delete(path % replacements, danger: true)
    +end
    +
    +
    + +
    +

    + + #get(id: "") ⇒ NgrokAPI::Models::Vault + + + + + +

    +
    + +

    Get a Vault by ID

    + +

    ngrok.com/docs/api#api-vaults-get

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +152
    +153
    +154
    +155
    +156
    +157
    +158
    +159
    +160
    +
    +
    # File 'lib/ngrokapi/services/vaults_client.rb', line 152
    +
    +def get(id: "")
    +  path = '/vaults/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data)
    +  NgrokAPI::Models::Vault.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #get!(id: "") ⇒ NgrokAPI::Models::Vault + + + + + +

    +
    + +

    Get a Vault by ID Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-vaults-get

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      a resource identifier

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +170
    +171
    +172
    +173
    +174
    +175
    +176
    +177
    +178
    +
    +
    # File 'lib/ngrokapi/services/vaults_client.rb', line 170
    +
    +def get!(id: "")
    +  path = '/vaults/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  result = @client.get(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::Vault.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #list(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable + + + + + +

    +
    + +

    List all Vaults owned by account

    + +

    ngrok.com/docs/api#api-vaults-list

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + before_id + + + (string) + + + (defaults to: nil) + + +
    • + +
    • + + limit + + + (string) + + + (defaults to: nil) + + +
    • + +
    • + + url + + + (string) + + + (defaults to: nil) + + + — +
      +

      optional and mutually exclusive from before_id and limit

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +189
    +190
    +191
    +192
    +193
    +194
    +195
    +196
    +197
    +198
    +199
    +200
    +201
    +202
    +203
    +
    +
    # File 'lib/ngrokapi/services/vaults_client.rb', line 189
    +
    +def list(before_id: nil, limit: nil, url: nil)
    +  result = @client.list(
    +    before_id: before_id,
    +    limit: limit,
    +    url: url,
    +    path: PATH
    +  )
    +
    +  NgrokAPI::Models::Listable.new(
    +    client: self,
    +    attrs: result,
    +    list_property: LIST_PROPERTY,
    +    klass: NgrokAPI::Models::Vault
    +  )
    +end
    +
    +
    + +
    +

    + + #list!(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable + + + + + +

    +
    + +

    List all Vaults owned by account Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-vaults-list

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + before_id + + + (string) + + + (defaults to: nil) + + +
    • + +
    • + + limit + + + (string) + + + (defaults to: nil) + + +
    • + +
    • + + url + + + (string) + + + (defaults to: nil) + + + — +
      +

      optional and mutually exclusive from before_id and limit

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +215
    +216
    +217
    +218
    +219
    +220
    +221
    +222
    +223
    +224
    +225
    +226
    +227
    +228
    +229
    +230
    +231
    +
    +
    # File 'lib/ngrokapi/services/vaults_client.rb', line 215
    +
    +def list!(before_id: nil, limit: nil, url: nil)
    +  result = @client.list(
    +    before_id: before_id,
    +    limit: limit,
    +    danger: true,
    +    url: url,
    +    path: PATH
    +  )
    +
    +  NgrokAPI::Models::Listable.new(
    +    client: self,
    +    attrs: result,
    +    list_property: LIST_PROPERTY,
    +    klass: NgrokAPI::Models::Vault,
    +    danger: true
    +  )
    +end
    +
    +
    + +
    +

    + + #update(id: "", name: nil, metadata: nil, description: nil) ⇒ NgrokAPI::Models::Vault + + + + + +

    +
    + +

    Update an existing Vault by ID

    + +

    ngrok.com/docs/api#api-vaults-update

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      identifier for Vault

      +
      + +
    • + +
    • + + name + + + (string) + + + (defaults to: nil) + + + — +
      +

      Name of vault

      +
      + +
    • + +
    • + + metadata + + + (string) + + + (defaults to: nil) + + + — +
      +

      Arbitrary user-defined metadata for this Vault

      +
      + +
    • + +
    • + + description + + + (string) + + + (defaults to: nil) + + + — +
      +

      description of Vault

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +77
    +78
    +79
    +80
    +81
    +82
    +83
    +84
    +85
    +86
    +87
    +88
    +
    +
    # File 'lib/ngrokapi/services/vaults_client.rb', line 77
    +
    +def update(id: "", name: nil, metadata: nil, description: nil)
    +  path = '/vaults/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  data[:name] = name if name
    +  data[:metadata] =  if 
    +  data[:description] = description if description
    +  result = @client.patch(path % replacements, data: data)
    +  NgrokAPI::Models::Vault.new(client: self, attrs: result)
    +end
    +
    +
    + +
    +

    + + #update!(id: "", name: nil, metadata: nil, description: nil) ⇒ NgrokAPI::Models::Vault + + + + + +

    +
    + +

    Update an existing Vault by ID Throws an exception if API error.

    + +

    ngrok.com/docs/api#api-vaults-update

    + + +
    +
    +
    +

    Parameters:

    +
      + +
    • + + id + + + (string) + + + (defaults to: "") + + + — +
      +

      identifier for Vault

      +
      + +
    • + +
    • + + name + + + (string) + + + (defaults to: nil) + + + — +
      +

      Name of vault

      +
      + +
    • + +
    • + + metadata + + + (string) + + + (defaults to: nil) + + + — +
      +

      Arbitrary user-defined metadata for this Vault

      +
      + +
    • + +
    • + + description + + + (string) + + + (defaults to: nil) + + + — +
      +

      description of Vault

      +
      + +
    • + +
    + +

    Returns:

    + + +
    + + + + +
    +
    +
    +
    +101
    +102
    +103
    +104
    +105
    +106
    +107
    +108
    +109
    +110
    +111
    +112
    +
    +
    # File 'lib/ngrokapi/services/vaults_client.rb', line 101
    +
    +def update!(id: "", name: nil, metadata: nil, description: nil)
    +  path = '/vaults/%{id}'
    +  replacements = {
    +    id: id,
    +  }
    +  data = {}
    +  data[:name] = name if name
    +  data[:metadata] =  if 
    +  data[:description] = description if description
    +  result = @client.patch(path % replacements, data: data, danger: true)
    +  NgrokAPI::Models::Vault.new(client: self, attrs: result)
    +end
    +
    +
    + +
    + +
    + + + +
    + + \ No newline at end of file diff --git a/docs/NgrokAPI/Services/WeightedBackendsClient.html b/docs/NgrokAPI/Services/WeightedBackendsClient.html index 303ad75f..37d2bab6 100644 --- a/docs/NgrokAPI/Services/WeightedBackendsClient.html +++ b/docs/NgrokAPI/Services/WeightedBackendsClient.html @@ -1789,9 +1789,9 @@

    diff --git a/docs/_index.html b/docs/_index.html index 0451f5bc..fafd8640 100644 --- a/docs/_index.html +++ b/docs/_index.html @@ -1066,6 +1066,20 @@

    Namespace Listing A-Z

    +
  • + Secret + + (NgrokAPI::Models) + +
  • + +
  • + SecretsClient + + (NgrokAPI::Services) + +
  • +
  • Services @@ -1257,6 +1271,28 @@

    Namespace Listing A-Z

    +
      +
    • V
    • +
        + +
      • + Vault + + (NgrokAPI::Models) + +
      • + +
      • + VaultsClient + + (NgrokAPI::Services) + +
      • + +
      +
    + +
    • W
      • @@ -1287,9 +1323,9 @@

        Namespace Listing A-Z

        diff --git a/docs/class_list.html b/docs/class_list.html index 4b8aadfa..1dd9c62e 100644 --- a/docs/class_list.html +++ b/docs/class_list.html @@ -43,7 +43,7 @@

        Class List

        diff --git a/docs/file.README.html b/docs/file.README.html index 796d62b6..54e6bb3a 100644 --- a/docs/file.README.html +++ b/docs/file.README.html @@ -166,9 +166,9 @@

        Building (internal)

        diff --git a/docs/index.html b/docs/index.html index e12cc3ee..acebabe9 100644 --- a/docs/index.html +++ b/docs/index.html @@ -166,9 +166,9 @@

        Building (internal)

        diff --git a/docs/method_list.html b/docs/method_list.html index 6b545294..a513920d 100644 --- a/docs/method_list.html +++ b/docs/method_list.html @@ -52,6 +52,22 @@

        Method List

        +
      • +
        + #== + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #== + NgrokAPI::Models::Secret +
        +
      • + +
      • #== @@ -940,6 +956,22 @@

        Method List

      • +
      • +
        + #attrs + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #attrs + NgrokAPI::Models::Secret +
        +
      • + +
      • #attrs @@ -1972,6 +2004,22 @@

        Method List

      • +
      • +
        + #client + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #client + NgrokAPI::Models::Secret +
        +
      • + +
      • #client @@ -2229,6 +2277,14 @@

        Method List

      • +
        + #client + NgrokAPI::Services::VaultsClient +
        +
      • + + +
      • #client NgrokAPI::Models::ApplicationUser @@ -2236,7 +2292,7 @@

        Method List

      • -
      • +
      • #client NgrokAPI::Models::EndpointBackend @@ -2244,7 +2300,7 @@

        Method List

      • -
      • +
      • #client NgrokAPI::Models::FailoverBackend @@ -2252,7 +2308,7 @@

        Method List

      • -
      • +
      • #client NgrokAPI::Models::HTTPSEdgeRoute @@ -2260,7 +2316,7 @@

        Method List

      • -
      • +
      • #client NgrokAPI::Models::WeightedBackend @@ -2268,6 +2324,14 @@

        Method List

      • +
      • +
        + #client + NgrokAPI::Services::SecretsClient +
        +
      • + +
      • #client @@ -3348,6 +3412,22 @@

        Method List

      • +
      • +
        + #create + NgrokAPI::Services::VaultsClient +
        +
      • + + +
      • +
        + #create + NgrokAPI::Services::SecretsClient +
        +
      • + +
      • #create @@ -3580,6 +3660,22 @@

        Method List

      • +
      • +
        + #create! + NgrokAPI::Services::VaultsClient +
        +
      • + + +
      • +
        + #create! + NgrokAPI::Services::SecretsClient +
        +
      • + +
      • #create! @@ -3812,6 +3908,22 @@

        Method List

      • +
      • +
        + #created_at + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #created_at + NgrokAPI::Models::Secret +
        +
      • + +
      • #created_at @@ -4052,6 +4164,22 @@

        Method List

      • +
      • +
        + #created_by + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #created_by + NgrokAPI::Models::Secret +
        +
      • + +
      • #credential @@ -4132,6 +4260,22 @@

        Method List

      • +
      • +
        + #delete + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #delete + NgrokAPI::Models::Secret +
        +
      • + +
      • #delete @@ -4261,6 +4405,14 @@

        Method List

      • +
        + #delete + NgrokAPI::Services::VaultsClient +
        +
      • + + +
      • #delete NgrokAPI::Models::ApplicationUser @@ -4268,7 +4420,7 @@

        Method List

      • -
      • +
      • #delete NgrokAPI::Models::FailoverBackend @@ -4276,7 +4428,7 @@

        Method List

      • -
      • +
      • #delete NgrokAPI::Models::HTTPSEdgeRoute @@ -4284,7 +4436,7 @@

        Method List

      • -
      • +
      • #delete NgrokAPI::Models::WeightedBackend @@ -4292,6 +4444,14 @@

        Method List

      • +
      • +
        + #delete + NgrokAPI::Services::SecretsClient +
        +
      • + +
      • #delete @@ -4788,6 +4948,22 @@

        Method List

      • +
      • +
        + #delete! + NgrokAPI::Services::VaultsClient +
        +
      • + + +
      • +
        + #delete! + NgrokAPI::Services::SecretsClient +
        +
      • + +
      • #delete! @@ -5260,6 +5436,22 @@

        Method List

      • +
      • +
        + #description + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #description + NgrokAPI::Models::Secret +
        +
      • + +
      • #description @@ -6044,6 +6236,22 @@

        Method List

      • +
      • +
        + #get + NgrokAPI::Services::VaultsClient +
        +
      • + + +
      • +
        + #get + NgrokAPI::Services::SecretsClient +
        +
      • + +
      • #get @@ -6492,6 +6700,22 @@

        Method List

      • +
      • +
        + #get! + NgrokAPI::Services::VaultsClient +
        +
      • + + +
      • +
        + #get! + NgrokAPI::Services::SecretsClient +
        +
      • + +
      • #get! @@ -7044,6 +7268,22 @@

        Method List

      • +
      • +
        + #id + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #id + NgrokAPI::Models::Secret +
        +
      • + +
      • #id @@ -7388,6 +7628,22 @@

        Method List

      • +
      • +
        + #initialize + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #initialize + NgrokAPI::Models::Secret +
        +
      • + +
      • #initialize @@ -7653,6 +7909,14 @@

        Method List

      • +
        + #initialize + NgrokAPI::Services::VaultsClient +
        +
      • + + +
      • #initialize NgrokAPI::Models::ApplicationUser @@ -7660,7 +7924,7 @@

        Method List

      • -
      • +
      • #initialize NgrokAPI::Models::EndpointBackend @@ -7668,7 +7932,7 @@

        Method List

      • -
      • +
      • #initialize NgrokAPI::Models::FailoverBackend @@ -7676,7 +7940,7 @@

        Method List

      • -
      • +
      • #initialize NgrokAPI::Models::HTTPSEdgeRoute @@ -7684,7 +7948,7 @@

        Method List

      • -
      • +
      • #initialize NgrokAPI::Models::WeightedBackend @@ -7692,6 +7956,14 @@

        Method List

      • +
      • +
        + #initialize + NgrokAPI::Services::SecretsClient +
        +
      • + +
      • #initialize @@ -8788,6 +9060,22 @@

        Method List

      • +
      • +
        + #last_updated_by + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #last_updated_by + NgrokAPI::Models::Secret +
        +
      • + +
      • #lat_long_radius_km @@ -8820,6 +9108,22 @@

        Method List

      • +
      • +
        + #list + NgrokAPI::Services::VaultsClient +
        +
      • + + +
      • +
        + #list + NgrokAPI::Services::SecretsClient +
        +
      • + +
      • #list @@ -9070,24 +9374,40 @@

        Method List

      • - #list! - NgrokAPI::Services::TunnelsClient + #list! + NgrokAPI::Services::VaultsClient
      • - #list! - NgrokAPI::Services::APIKeysClient + #list! + NgrokAPI::Services::SecretsClient
      • - #list! - NgrokAPI::Services::BotUsersClient + #list! + NgrokAPI::Services::TunnelsClient +
        +
      • + + +
      • +
        + #list! + NgrokAPI::Services::APIKeysClient +
        +
      • + + +
      • +
        + #list! + NgrokAPI::Services::BotUsersClient
      • @@ -9412,6 +9732,22 @@

        Method List

        +
      • +
        + #metadata + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #metadata + NgrokAPI::Models::Secret +
        +
      • + +
      • #metadata @@ -9716,6 +10052,22 @@

        Method List

      • +
      • +
        + #name + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #name + NgrokAPI::Models::Secret +
        +
      • + +
      • #name @@ -9942,7 +10294,7 @@

        Method List

      • - #port + #pooling_enabled NgrokAPI::Models::Endpoint
      • @@ -9950,23 +10302,23 @@

        Method List

      • - #post - NgrokAPI::HttpClient + #port + NgrokAPI::Models::Endpoint
      • - #principal - NgrokAPI::Models::Endpoint + #post + NgrokAPI::HttpClient
      • - #principal_id + #principal NgrokAPI::Models::Endpoint
      • @@ -10813,6 +11165,14 @@

        Method List

      • +
        + #secrets + NgrokAPI::Client +
        +
      • + + +
      • #serial_number NgrokAPI::Models::TLSCertificate @@ -10820,7 +11180,7 @@

        Method List

      • -
      • +
      • #service NgrokAPI::Models::EventTargetDatadog @@ -10828,7 +11188,7 @@

        Method List

      • -
      • +
      • #single_logout_url NgrokAPI::Models::EndpointSAML @@ -10836,7 +11196,7 @@

        Method List

      • -
      • +
      • #sources NgrokAPI::Models::EventSourceList @@ -10844,7 +11204,7 @@

        Method List

      • -
      • +
      • #sources NgrokAPI::Models::EventSubscription @@ -10852,7 +11212,7 @@

        Method List

      • -
      • +
      • #ssh_certificate_authorities NgrokAPI::Client @@ -10860,7 +11220,7 @@

        Method List

      • -
      • +
      • #ssh_certificate_authority_id NgrokAPI::Models::SSHHostCertificate @@ -10868,7 +11228,7 @@

        Method List

      • -
      • +
      • #ssh_certificate_authority_id NgrokAPI::Models::SSHUserCertificate @@ -10876,7 +11236,7 @@

        Method List

      • -
      • +
      • #ssh_credentials NgrokAPI::Client @@ -10884,7 +11244,7 @@

        Method List

      • -
      • +
      • #ssh_host_certificates NgrokAPI::Client @@ -10892,7 +11252,7 @@

        Method List

      • -
      • +
      • #ssh_user_certificates NgrokAPI::Client @@ -10900,7 +11260,7 @@

        Method List

      • -
      • +
      • #started_at NgrokAPI::Models::Tunnel @@ -10908,7 +11268,7 @@

        Method List

      • -
      • +
      • #started_at NgrokAPI::Models::TunnelSession @@ -10916,7 +11276,7 @@

        Method List

      • -
      • +
      • #started_at NgrokAPI::Models::AgentIngressCertJob @@ -10924,7 +11284,7 @@

        Method List

      • -
      • +
      • #started_at NgrokAPI::Models::ReservedDomainCertJob @@ -10932,7 +11292,7 @@

        Method List

      • -
      • +
      • #status NgrokAPI::Models::AbuseReport @@ -10940,7 +11300,7 @@

        Method List

      • -
      • +
      • #status NgrokAPI::Models::AbuseReportHostname @@ -10948,7 +11308,7 @@

        Method List

      • -
      • +
      • #status_code NgrokAPI::Models::HTTPResponseBackend @@ -10956,7 +11316,7 @@

        Method List

      • -
      • +
      • #stop NgrokAPI::Services::TunnelSessionsClient @@ -10964,7 +11324,7 @@

        Method List

      • -
      • +
      • #stop! NgrokAPI::Services::TunnelSessionsClient @@ -10972,7 +11332,7 @@

        Method List

      • -
      • +
      • #stream_arn NgrokAPI::Models::EventTargetKinesis @@ -10980,7 +11340,7 @@

        Method List

      • -
      • +
      • #subject_alternative_names NgrokAPI::Models::TLSCertificate @@ -10988,7 +11348,7 @@

        Method List

      • -
      • +
      • #subject_common_name NgrokAPI::Models::TLSCertificate @@ -10996,7 +11356,7 @@

        Method List

      • -
      • +
      • #subject_common_name NgrokAPI::Models::CertificateAuthority @@ -11004,7 +11364,7 @@

        Method List

      • -
      • +
      • #subject_country NgrokAPI::Models::TLSCertificate @@ -11012,7 +11372,7 @@

        Method List

      • -
      • +
      • #subject_locality NgrokAPI::Models::TLSCertificate @@ -11020,7 +11380,7 @@

        Method List

      • -
      • +
      • #subject_organization NgrokAPI::Models::TLSCertificate @@ -11028,7 +11388,7 @@

        Method List

      • -
      • +
      • #subject_organizational_unit NgrokAPI::Models::TLSCertificate @@ -11036,7 +11396,7 @@

        Method List

      • -
      • +
      • #subject_province NgrokAPI::Models::TLSCertificate @@ -11044,7 +11404,7 @@

        Method List

      • -
      • +
      • #target NgrokAPI::Models::EventDestination @@ -11052,7 +11412,7 @@

        Method List

      • -
      • +
      • #tcp_addr NgrokAPI::Models::Endpoint @@ -11060,7 +11420,7 @@

        Method List

      • -
      • +
      • #teams NgrokAPI::Models::EndpointOAuthGitHub @@ -11068,7 +11428,7 @@

        Method List

      • -
      • +
      • #tenant_id NgrokAPI::Models::EventTargetAzureLogsIngestion @@ -11076,7 +11436,7 @@

        Method List

      • -
      • +
      • #terminate_at NgrokAPI::Models::EndpointTLSTermination @@ -11084,7 +11444,7 @@

        Method List

      • -
      • +
      • #tls NgrokAPI::Models::StaticBackend @@ -11092,7 +11452,7 @@

        Method List

      • -
      • +
      • #tls_certificates NgrokAPI::Client @@ -11100,7 +11460,7 @@

        Method List

      • -
      • +
      • #tls_termination NgrokAPI::Models::TLSEdge @@ -11108,7 +11468,7 @@

        Method List

      • -
      • +
      • #tls_termination NgrokAPI::Models::HTTPSEdge @@ -11116,7 +11476,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::Ref @@ -11124,7 +11484,23 @@

        Method List

      • +
      • +
        + #to_h + NgrokAPI::Models::Vault +
        +
      • + +
      • +
        + #to_h + NgrokAPI::Models::Secret +
        +
      • + + +
      • #to_h NgrokAPI::Models::Tunnel @@ -11132,7 +11508,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::APIKey @@ -11140,7 +11516,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::AWSAuth @@ -11148,7 +11524,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::AWSRole @@ -11156,7 +11532,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::BotUser @@ -11164,7 +11540,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::Endpoint @@ -11172,7 +11548,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::Location @@ -11180,7 +11556,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::TCPEdge @@ -11188,7 +11564,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::TLSEdge @@ -11196,7 +11572,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::IPPolicy @@ -11204,7 +11580,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::Credential @@ -11212,7 +11588,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::HTTPSEdge @@ -11220,7 +11596,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::UserAgent @@ -11228,7 +11604,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::AbuseReport @@ -11236,7 +11612,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EventSource @@ -11244,7 +11620,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EventTarget @@ -11252,7 +11628,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::AgentIngress @@ -11260,7 +11636,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointOIDC @@ -11268,7 +11644,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointSAML @@ -11276,7 +11652,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::ReservedAddr @@ -11284,7 +11660,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::IPPolicyRule @@ -11292,7 +11668,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::IPRestriction @@ -11300,7 +11676,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::SSHCredential @@ -11308,7 +11684,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::StaticBackend @@ -11316,7 +11692,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::TunnelSession @@ -11324,7 +11700,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::AWSCredentials @@ -11332,7 +11708,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::BrowserSession @@ -11340,7 +11716,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointOAuth @@ -11348,7 +11724,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::ReservedDomain @@ -11356,7 +11732,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::TLSCertificate @@ -11364,7 +11740,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::ApplicationUser @@ -11372,7 +11748,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointBackend @@ -11380,7 +11756,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::FailoverBackend @@ -11388,7 +11764,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::HTTPSEdgeRoute @@ -11396,7 +11772,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::WeightedBackend @@ -11404,7 +11780,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EventDestination @@ -11412,7 +11788,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EventSourceList @@ -11420,7 +11796,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::IdentityProvider @@ -11428,7 +11804,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointIPPolicy @@ -11436,7 +11812,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EventSubscription @@ -11444,7 +11820,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::StaticBackendTLS @@ -11452,7 +11828,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::ApplicationSession @@ -11460,7 +11836,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointMutualTLS @@ -11468,7 +11844,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointCompression @@ -11476,7 +11852,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointSAMLMutate @@ -11484,7 +11860,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EventSourceReplace @@ -11492,7 +11868,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EventTargetDatadog @@ -11500,7 +11876,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EventTargetKinesis @@ -11508,7 +11884,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::SSHHostCertificate @@ -11516,7 +11892,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::SSHUserCertificate @@ -11524,7 +11900,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::TunnelGroupBackend @@ -11532,7 +11908,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::AbuseReportHostname @@ -11540,7 +11916,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::CertificateAuthority @@ -11548,7 +11924,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EventTargetFirehose @@ -11556,7 +11932,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::HTTPResponseBackend @@ -11564,7 +11940,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::TLSCertificateSANs @@ -11572,7 +11948,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::AgentIngressCertJob @@ -11580,7 +11956,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointOAuthAmazon @@ -11588,7 +11964,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointOAuthGoogle @@ -11596,7 +11972,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointOAuthTwitch @@ -11604,7 +11980,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointBackendMutate @@ -11612,7 +11988,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointOAuthGitHub @@ -11620,7 +11996,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointOAuthGitLab @@ -11628,7 +12004,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointTrafficPolicy @@ -11636,7 +12012,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointCircuitBreaker @@ -11644,7 +12020,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointOAuthFacebook @@ -11652,7 +12028,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointOAuthProvider @@ -11660,7 +12036,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointRequestHeaders @@ -11668,7 +12044,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointTLSTermination @@ -11676,7 +12052,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::ReservedDomainCertJob @@ -11684,7 +12060,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::AgentIngressCertPolicy @@ -11692,7 +12068,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::AgentIngressCertStatus @@ -11700,7 +12076,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointIPPolicyMutate @@ -11708,7 +12084,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointOAuthLinkedIn @@ -11716,7 +12092,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointOAuthMicrosoft @@ -11724,7 +12100,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointResponseHeaders @@ -11732,7 +12108,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::SSHCertificateAuthority @@ -11740,7 +12116,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointMutualTLSMutate @@ -11748,7 +12124,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointUserAgentFilter @@ -11756,7 +12132,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointWebhookValidation @@ -11764,7 +12140,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::ReservedDomainCertPolicy @@ -11772,7 +12148,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::ReservedDomainCertStatus @@ -11780,7 +12156,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EventTargetCloudwatchLogs @@ -11788,7 +12164,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointTLSTerminationAtEdge @@ -11796,7 +12172,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EndpointWebsocketTCPConverter @@ -11804,7 +12180,7 @@

        Method List

      • -
      • +
      • #to_h NgrokAPI::Models::EventTargetAzureLogsIngestion @@ -11812,7 +12188,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::Ref @@ -11820,7 +12196,23 @@

        Method List

      • +
      • +
        + #to_s + NgrokAPI::Models::Vault +
        +
      • + +
      • +
        + #to_s + NgrokAPI::Models::Secret +
        +
      • + + +
      • #to_s NgrokAPI::Models::Tunnel @@ -11828,7 +12220,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::APIKey @@ -11836,7 +12228,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::AWSAuth @@ -11844,7 +12236,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::AWSRole @@ -11852,7 +12244,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::BotUser @@ -11860,7 +12252,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::Endpoint @@ -11868,7 +12260,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::Listable @@ -11876,7 +12268,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::Location @@ -11884,7 +12276,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::TCPEdge @@ -11892,7 +12284,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::TLSEdge @@ -11900,7 +12292,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::IPPolicy @@ -11908,7 +12300,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::Credential @@ -11916,7 +12308,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::HTTPSEdge @@ -11924,7 +12316,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::UserAgent @@ -11932,7 +12324,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::AbuseReport @@ -11940,7 +12332,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EventSource @@ -11948,7 +12340,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EventTarget @@ -11956,7 +12348,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::AgentIngress @@ -11964,7 +12356,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointOIDC @@ -11972,7 +12364,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointSAML @@ -11980,7 +12372,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::ReservedAddr @@ -11988,7 +12380,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::IPPolicyRule @@ -11996,7 +12388,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::IPRestriction @@ -12004,7 +12396,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::SSHCredential @@ -12012,7 +12404,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::StaticBackend @@ -12020,7 +12412,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::TunnelSession @@ -12028,7 +12420,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::AWSCredentials @@ -12036,7 +12428,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::BrowserSession @@ -12044,7 +12436,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointOAuth @@ -12052,7 +12444,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::ReservedDomain @@ -12060,7 +12452,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::TLSCertificate @@ -12068,7 +12460,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::ApplicationUser @@ -12076,7 +12468,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointBackend @@ -12084,7 +12476,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::FailoverBackend @@ -12092,7 +12484,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::HTTPSEdgeRoute @@ -12100,7 +12492,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::WeightedBackend @@ -12108,7 +12500,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EventDestination @@ -12116,7 +12508,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EventSourceList @@ -12124,7 +12516,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::IdentityProvider @@ -12132,7 +12524,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointIPPolicy @@ -12140,7 +12532,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EventSubscription @@ -12148,7 +12540,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::StaticBackendTLS @@ -12156,7 +12548,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::ApplicationSession @@ -12164,7 +12556,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointMutualTLS @@ -12172,7 +12564,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointCompression @@ -12180,7 +12572,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointSAMLMutate @@ -12188,7 +12580,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EventSourceReplace @@ -12196,7 +12588,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EventTargetDatadog @@ -12204,7 +12596,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EventTargetKinesis @@ -12212,7 +12604,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::SSHHostCertificate @@ -12220,7 +12612,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::SSHUserCertificate @@ -12228,7 +12620,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::TunnelGroupBackend @@ -12236,7 +12628,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::AbuseReportHostname @@ -12244,7 +12636,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::CertificateAuthority @@ -12252,7 +12644,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EventTargetFirehose @@ -12260,7 +12652,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::HTTPResponseBackend @@ -12268,7 +12660,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::TLSCertificateSANs @@ -12276,7 +12668,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::AgentIngressCertJob @@ -12284,7 +12676,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointOAuthAmazon @@ -12292,7 +12684,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointOAuthGoogle @@ -12300,7 +12692,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointOAuthTwitch @@ -12308,7 +12700,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointBackendMutate @@ -12316,7 +12708,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointOAuthGitHub @@ -12324,7 +12716,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointOAuthGitLab @@ -12332,7 +12724,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointTrafficPolicy @@ -12340,7 +12732,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointCircuitBreaker @@ -12348,7 +12740,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointOAuthFacebook @@ -12356,7 +12748,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointOAuthProvider @@ -12364,7 +12756,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointRequestHeaders @@ -12372,7 +12764,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointTLSTermination @@ -12380,7 +12772,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::ReservedDomainCertJob @@ -12388,7 +12780,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::AgentIngressCertPolicy @@ -12396,7 +12788,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::AgentIngressCertStatus @@ -12404,7 +12796,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointIPPolicyMutate @@ -12412,7 +12804,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointOAuthLinkedIn @@ -12420,7 +12812,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointOAuthMicrosoft @@ -12428,7 +12820,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointResponseHeaders @@ -12436,7 +12828,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::SSHCertificateAuthority @@ -12444,7 +12836,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointMutualTLSMutate @@ -12452,7 +12844,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointUserAgentFilter @@ -12460,7 +12852,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointWebhookValidation @@ -12468,7 +12860,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::ReservedDomainCertPolicy @@ -12476,7 +12868,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::ReservedDomainCertStatus @@ -12484,7 +12876,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EventTargetCloudwatchLogs @@ -12492,7 +12884,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointTLSTerminationAtEdge @@ -12500,7 +12892,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EndpointWebsocketTCPConverter @@ -12508,7 +12900,7 @@

        Method List

      • -
      • +
      • #to_s NgrokAPI::Models::EventTargetAzureLogsIngestion @@ -12516,7 +12908,7 @@

        Method List

      • -
      • +
      • #token NgrokAPI::Models::APIKey @@ -12524,7 +12916,7 @@

        Method List

      • -
      • +
      • #token NgrokAPI::Models::Credential @@ -12532,7 +12924,7 @@

        Method List

      • -
      • +
      • #traffic_policy NgrokAPI::Models::Endpoint @@ -12540,7 +12932,7 @@

        Method List

      • -
      • +
      • #traffic_policy NgrokAPI::Models::TCPEdge @@ -12548,7 +12940,7 @@

        Method List

      • -
      • +
      • #traffic_policy NgrokAPI::Models::TLSEdge @@ -12556,7 +12948,7 @@

        Method List

      • -
      • +
      • #traffic_policy NgrokAPI::Models::HTTPSEdgeRoute @@ -12564,7 +12956,7 @@

        Method List

      • -
      • +
      • #transport NgrokAPI::Models::TunnelSession @@ -12572,7 +12964,7 @@

        Method List

      • -
      • +
      • #tripped_duration NgrokAPI::Models::EndpointCircuitBreaker @@ -12580,7 +12972,7 @@

        Method List

      • -
      • +
      • #tunnel NgrokAPI::Models::Endpoint @@ -12588,7 +12980,7 @@

        Method List

      • -
      • +
      • #tunnel_session NgrokAPI::Models::Tunnel @@ -12596,7 +12988,7 @@

        Method List

      • -
      • +
      • #tunnel_session NgrokAPI::Models::Endpoint @@ -12604,7 +12996,7 @@

        Method List

      • -
      • +
      • #tunnel_sessions NgrokAPI::Client @@ -12612,7 +13004,7 @@

        Method List

      • -
      • +
      • #tunnels NgrokAPI::Client @@ -12620,7 +13012,7 @@

        Method List

      • -
      • +
      • #tunnels NgrokAPI::Models::TunnelGroupBackend @@ -12628,7 +13020,7 @@

        Method List

      • -
      • +
      • #twitch NgrokAPI::Models::EndpointOAuthProvider @@ -12636,7 +13028,7 @@

        Method List

      • -
      • +
      • #type NgrokAPI::Models::Endpoint @@ -12644,7 +13036,7 @@

        Method List

      • -
      • +
      • #type NgrokAPI::Models::EventSource @@ -12652,7 +13044,7 @@

        Method List

      • -
      • +
      • #type NgrokAPI::Models::IPRestriction @@ -12660,7 +13052,7 @@

        Method List

      • -
      • +
      • #type NgrokAPI::Models::EventSourceReplace @@ -12668,6 +13060,14 @@

        Method List

      • +
      • +
        + #update + NgrokAPI::Models::Vault +
        +
      • + +
      • #update @@ -12773,6 +13173,14 @@

        Method List

      • +
        + #update + NgrokAPI::Services::VaultsClient +
        +
      • + + +
      • #update NgrokAPI::Models::FailoverBackend @@ -12780,7 +13188,7 @@

        Method List

      • -
      • +
      • #update NgrokAPI::Models::HTTPSEdgeRoute @@ -12788,7 +13196,7 @@

        Method List

      • -
      • +
      • #update NgrokAPI::Models::WeightedBackend @@ -12796,6 +13204,14 @@

        Method List

      • +
      • +
        + #update + NgrokAPI::Services::SecretsClient +
        +
      • + +
      • #update @@ -13076,6 +13492,22 @@

        Method List

      • +
      • +
        + #update! + NgrokAPI::Services::VaultsClient +
        +
      • + + +
      • +
        + #update! + NgrokAPI::Services::SecretsClient +
        +
      • + +
      • #update! @@ -13308,6 +13740,22 @@

        Method List

      • +
      • +
        + #updated_at + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #updated_at + NgrokAPI::Models::Secret +
        +
      • + +
      • #updated_at @@ -13318,7 +13766,7 @@

        Method List

      • - #upstream_proto + #upstream_protocol NgrokAPI::Models::Endpoint
      • @@ -13340,6 +13788,22 @@

        Method List

        +
      • +
        + #uri + NgrokAPI::Models::Vault +
        +
      • + + +
      • +
        + #uri + NgrokAPI::Models::Secret +
        +
      • + +
      • #uri @@ -13700,6 +14164,22 @@

        Method List

      • +
      • +
        + #vault + NgrokAPI::Models::Secret +
        +
      • + + +
      • +
        + #vaults + NgrokAPI::Client +
        +
      • + +
      • #volume_threshold diff --git a/docs/top-level-namespace.html b/docs/top-level-namespace.html index e2d16788..c95aace6 100644 --- a/docs/top-level-namespace.html +++ b/docs/top-level-namespace.html @@ -100,9 +100,9 @@

        Defined Under Namespace

        diff --git a/lib/ngrokapi/client.rb b/lib/ngrokapi/client.rb index bdcb27be..48db60d8 100644 --- a/lib/ngrokapi/client.rb +++ b/lib/ngrokapi/client.rb @@ -159,6 +159,15 @@ def reserved_domains @_reserved_domains ||= NgrokAPI::Services::ReservedDomainsClient.new(client: @client) end + ## + # Secrets is an api service for securely storing and managing sensitive data such + # as secrets, credentials, and tokens. + # + # @return [NgrokAPI::Services::SecretsClient] + def secrets + @_secrets ||= NgrokAPI::Services::SecretsClient.new(client: @client) + end + ## # An SSH Certificate Authority is a pair of an SSH Certificate and its private # key that can be used to sign other SSH host and user certificates. @@ -218,6 +227,15 @@ def tunnels @_tunnels ||= NgrokAPI::Services::TunnelsClient.new(client: @client) end + ## + # Vaults is an api service for securely storing and managing sensitive data such + # as secrets, credentials, and tokens. + # + # @return [NgrokAPI::Services::VaultsClient] + def vaults + @_vaults ||= NgrokAPI::Services::VaultsClient.new(client: @client) + end + def backends ns = OpenStruct.new ns.failover = NgrokAPI::Services::FailoverBackendsClient.new(client: @client) diff --git a/lib/ngrokapi/models/endpoint.rb b/lib/ngrokapi/models/endpoint.rb index 952cd520..1d40950d 100644 --- a/lib/ngrokapi/models/endpoint.rb +++ b/lib/ngrokapi/models/endpoint.rb @@ -27,15 +27,15 @@ class Endpoint :tunnel, :edge, :upstream_url, - :upstream_proto, + :upstream_protocol, :url, :principal, - :principal_id, :traffic_policy, :bindings, :tunnel_session, :uri, - :name + :name, + :pooling_enabled def initialize(client: nil, attrs: {}) @client = client @@ -60,10 +60,9 @@ def initialize(client: nil, attrs: {}) @tunnel = @attrs['tunnel'] @edge = @attrs['edge'] @upstream_url = @attrs['upstream_url'] - @upstream_proto = @attrs['upstream_proto'] + @upstream_protocol = @attrs['upstream_protocol'] @url = @attrs['url'] @principal = @attrs['principal'] - @principal_id = @attrs['principal_id'] @traffic_policy = @attrs['traffic_policy'] @bindings = @attrs['bindings'] @tunnel_session = @attrs['tunnel_session'] @@ -71,6 +70,7 @@ def initialize(client: nil, attrs: {}) @uri = URI(@attrs['uri']) end @name = @attrs['name'] + @pooling_enabled = @attrs['pooling_enabled'] end def ==(other) @@ -94,20 +94,23 @@ def update( traffic_policy: nil, description: nil, metadata: nil, - bindings: nil + bindings: nil, + pooling_enabled: False ) @url = url if url @traffic_policy = traffic_policy if traffic_policy @description = description if description @metadata = metadata if metadata @bindings = bindings if bindings + @pooling_enabled = pooling_enabled if pooling_enabled @client.update( id: @id, url: url, traffic_policy: traffic_policy, description: description, metadata: metadata, - bindings: bindings + bindings: bindings, + pooling_enabled: pooling_enabled ) end diff --git a/lib/ngrokapi/models/secret.rb b/lib/ngrokapi/models/secret.rb new file mode 100644 index 00000000..2dc37d92 --- /dev/null +++ b/lib/ngrokapi/models/secret.rb @@ -0,0 +1,63 @@ +# frozen_string_literal: true + +# Code generated for API Clients. DO NOT EDIT. + +require 'uri' + +module NgrokAPI + module Models + class Secret + attr_reader :client, + :attrs, + :id, + :uri, + :created_at, + :updated_at, + :name, + :description, + :metadata, + :created_by, + :last_updated_by, + :vault + + def initialize(client: nil, attrs: {}) + @client = client + @attrs = attrs + @id = @attrs['id'] + unless @attrs['uri'].nil? + @uri = URI(@attrs['uri']) + end + @created_at = @attrs['created_at'] + @updated_at = @attrs['updated_at'] + @name = @attrs['name'] + @description = @attrs['description'] + @metadata = @attrs['metadata'] + @created_by = @attrs['created_by'] + @last_updated_by = @attrs['last_updated_by'] + @vault = @attrs['vault'] + end + + def ==(other) + @attrs == other.attrs + end + + def to_s + @attrs.to_s + end + + def to_h + @attrs.to_h + end + + ## + # Delete a Secret + # + # https://ngrok.com/docs/api#api-secrets-delete + def delete + @client.delete( + id: @id + ) + end + end + end +end diff --git a/lib/ngrokapi/models/vault.rb b/lib/ngrokapi/models/vault.rb new file mode 100644 index 00000000..4ca32889 --- /dev/null +++ b/lib/ngrokapi/models/vault.rb @@ -0,0 +1,81 @@ +# frozen_string_literal: true + +# Code generated for API Clients. DO NOT EDIT. + +require 'uri' + +module NgrokAPI + module Models + class Vault + attr_reader :client, + :attrs, + :id, + :uri, + :created_at, + :updated_at, + :name, + :description, + :metadata, + :created_by, + :last_updated_by + + def initialize(client: nil, attrs: {}) + @client = client + @attrs = attrs + @id = @attrs['id'] + unless @attrs['uri'].nil? + @uri = URI(@attrs['uri']) + end + @created_at = @attrs['created_at'] + @updated_at = @attrs['updated_at'] + @name = @attrs['name'] + @description = @attrs['description'] + @metadata = @attrs['metadata'] + @created_by = @attrs['created_by'] + @last_updated_by = @attrs['last_updated_by'] + end + + def ==(other) + @attrs == other.attrs + end + + def to_s + @attrs.to_s + end + + def to_h + @attrs.to_h + end + + ## + # Update an existing Vault by ID + # + # https://ngrok.com/docs/api#api-vaults-update + def update( + name: nil, + metadata: nil, + description: nil + ) + @name = name if name + @metadata = metadata if metadata + @description = description if description + @client.update( + id: @id, + name: name, + metadata: metadata, + description: description + ) + end + + ## + # Delete a Vault + # + # https://ngrok.com/docs/api#api-vaults-delete + def delete + @client.delete( + id: @id + ) + end + end + end +end diff --git a/lib/ngrokapi/services/endpoints_client.rb b/lib/ngrokapi/services/endpoints_client.rb index 81ddb72e..324b57ec 100644 --- a/lib/ngrokapi/services/endpoints_client.rb +++ b/lib/ngrokapi/services/endpoints_client.rb @@ -26,15 +26,16 @@ def initialize(client:) # Create an endpoint, currently available only for cloud endpoints # # @param [string] url the url of the endpoint - # @param [string] type whether the endpoint is ``ephemeral`` (served directly by an agent-initiated tunnel) or ``edge`` (served by an edge) or ``cloud (represents a cloud endpoint)`` + # @param [string] type Type of endpoint. Only 'cloud' is currently supported (represents a cloud endpoint). Defaults to 'cloud' if not specified. # @param [string] traffic_policy The traffic policy attached to this endpoint # @param [string] description user-supplied description of the associated tunnel # @param [string] metadata user-supplied metadata of the associated tunnel or edge object # @param [List] bindings the bindings associated with this endpoint + # @param [boolean] pooling_enabled # @return [NgrokAPI::Models::Endpoint] result from the API request # # https://ngrok.com/docs/api#api-endpoints-create - def create(url: "", type: "", traffic_policy: "", description: nil, metadata: nil, bindings: nil) + def create(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) path = '/endpoints' replacements = { } @@ -45,6 +46,7 @@ def create(url: "", type: "", traffic_policy: "", description: nil, metadata: ni data[:description] = description if description data[:metadata] = metadata if metadata data[:bindings] = bindings if bindings + data[:pooling_enabled] = pooling_enabled if pooling_enabled result = @client.post(path % replacements, data: data) NgrokAPI::Models::Endpoint.new(client: self, attrs: result) end @@ -54,15 +56,16 @@ def create(url: "", type: "", traffic_policy: "", description: nil, metadata: ni # Throws an exception if API error. # # @param [string] url the url of the endpoint - # @param [string] type whether the endpoint is ``ephemeral`` (served directly by an agent-initiated tunnel) or ``edge`` (served by an edge) or ``cloud (represents a cloud endpoint)`` + # @param [string] type Type of endpoint. Only 'cloud' is currently supported (represents a cloud endpoint). Defaults to 'cloud' if not specified. # @param [string] traffic_policy The traffic policy attached to this endpoint # @param [string] description user-supplied description of the associated tunnel # @param [string] metadata user-supplied metadata of the associated tunnel or edge object # @param [List] bindings the bindings associated with this endpoint + # @param [boolean] pooling_enabled # @return [NgrokAPI::Models::Endpoint] result from the API request # # https://ngrok.com/docs/api#api-endpoints-create - def create!(url: "", type: "", traffic_policy: "", description: nil, metadata: nil, bindings: nil) + def create!(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) path = '/endpoints' replacements = { } @@ -73,6 +76,7 @@ def create!(url: "", type: "", traffic_policy: "", description: nil, metadata: n data[:description] = description if description data[:metadata] = metadata if metadata data[:bindings] = bindings if bindings + data[:pooling_enabled] = pooling_enabled if pooling_enabled result = @client.post(path % replacements, data: data, danger: true) NgrokAPI::Models::Endpoint.new(client: self, attrs: result) end @@ -82,14 +86,18 @@ def create!(url: "", type: "", traffic_policy: "", description: nil, metadata: n # # @param [string] before_id # @param [string] limit + # @param [List] ids + # @param [List] urls # @param [string] url optional and mutually exclusive from before_id and limit # @return [NgrokAPI::Models::Listable] result from the API request # # https://ngrok.com/docs/api#api-endpoints-list - def list(before_id: nil, limit: nil, url: nil) + def list(before_id: nil, limit: nil, ids: [], urls: [], url: nil) result = @client.list( before_id: before_id, limit: limit, + ids: ids, + urls: urls, url: url, path: PATH ) @@ -108,14 +116,18 @@ def list(before_id: nil, limit: nil, url: nil) # # @param [string] before_id # @param [string] limit + # @param [List] ids + # @param [List] urls # @param [string] url optional and mutually exclusive from before_id and limit # @return [NgrokAPI::Models::Listable] result from the API request # # https://ngrok.com/docs/api#api-endpoints-list - def list!(before_id: nil, limit: nil, url: nil) + def list!(before_id: nil, limit: nil, ids: [], urls: [], url: nil) result = @client.list( before_id: before_id, limit: limit, + ids: ids, + urls: urls, danger: true, url: url, path: PATH @@ -174,10 +186,11 @@ def get!(id: "") # @param [string] description user-supplied description of the associated tunnel # @param [string] metadata user-supplied metadata of the associated tunnel or edge object # @param [List] bindings the bindings associated with this endpoint + # @param [boolean] pooling_enabled # @return [NgrokAPI::Models::Endpoint] result from the API request # # https://ngrok.com/docs/api#api-endpoints-update - def update(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil) + def update(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) path = '/endpoints/%{id}' replacements = { id: id, @@ -188,6 +201,7 @@ def update(id: "", url: nil, traffic_policy: nil, description: nil, metadata: ni data[:description] = description if description data[:metadata] = metadata if metadata data[:bindings] = bindings if bindings + data[:pooling_enabled] = pooling_enabled if pooling_enabled result = @client.patch(path % replacements, data: data) NgrokAPI::Models::Endpoint.new(client: self, attrs: result) end @@ -202,10 +216,11 @@ def update(id: "", url: nil, traffic_policy: nil, description: nil, metadata: ni # @param [string] description user-supplied description of the associated tunnel # @param [string] metadata user-supplied metadata of the associated tunnel or edge object # @param [List] bindings the bindings associated with this endpoint + # @param [boolean] pooling_enabled # @return [NgrokAPI::Models::Endpoint] result from the API request # # https://ngrok.com/docs/api#api-endpoints-update - def update!(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil) + def update!(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) path = '/endpoints/%{id}' replacements = { id: id, @@ -216,6 +231,7 @@ def update!(id: "", url: nil, traffic_policy: nil, description: nil, metadata: n data[:description] = description if description data[:metadata] = metadata if metadata data[:bindings] = bindings if bindings + data[:pooling_enabled] = pooling_enabled if pooling_enabled result = @client.patch(path % replacements, data: data, danger: true) NgrokAPI::Models::Endpoint.new(client: self, attrs: result) end diff --git a/lib/ngrokapi/services/secrets_client.rb b/lib/ngrokapi/services/secrets_client.rb new file mode 100644 index 00000000..ee6533b0 --- /dev/null +++ b/lib/ngrokapi/services/secrets_client.rb @@ -0,0 +1,246 @@ +# frozen_string_literal: true + +# Code generated for API Clients. DO NOT EDIT. + +module NgrokAPI + module Services + ## + # Secrets is an api service for securely storing and managing sensitive data such + # as secrets, credentials, and tokens. + # + # https://ngrok.com/docs/api#api-secrets + class SecretsClient + # The API path for the requests + PATH = '/vault_secrets' + # The List Property from the resulting API for list calls + LIST_PROPERTY = 'secrets' + + attr_reader :client + + def initialize(client:) + @client = client + end + + ## + # Create a new Secret + # + # @param [string] name Name of secret + # @param [string] value Value of secret + # @param [string] metadata Arbitrary user-defined metadata for this Secret + # @param [string] description description of Secret + # @param [string] vault_id unique identifier of the referenced vault + # @return [NgrokAPI::Models::Secret] result from the API request + # + # https://ngrok.com/docs/api#api-secrets-create + def create(name: "", value: "", metadata: "", description: "", vault_id:) + path = '/vault_secrets' + replacements = { + } + data = {} + data[:name] = name if name + data[:value] = value if value + data[:metadata] = metadata if metadata + data[:description] = description if description + data[:vault_id] = vault_id if vault_id + result = @client.post(path % replacements, data: data) + NgrokAPI::Models::Secret.new(client: self, attrs: result) + end + + ## + # Create a new Secret + # Throws an exception if API error. + # + # @param [string] name Name of secret + # @param [string] value Value of secret + # @param [string] metadata Arbitrary user-defined metadata for this Secret + # @param [string] description description of Secret + # @param [string] vault_id unique identifier of the referenced vault + # @return [NgrokAPI::Models::Secret] result from the API request + # + # https://ngrok.com/docs/api#api-secrets-create + def create!(name: "", value: "", metadata: "", description: "", vault_id:) + path = '/vault_secrets' + replacements = { + } + data = {} + data[:name] = name if name + data[:value] = value if value + data[:metadata] = metadata if metadata + data[:description] = description if description + data[:vault_id] = vault_id if vault_id + result = @client.post(path % replacements, data: data, danger: true) + NgrokAPI::Models::Secret.new(client: self, attrs: result) + end + + ## + # Update an existing Secret by ID + # + # @param [string] id identifier for Secret + # @param [string] name Name of secret + # @param [string] value Value of secret + # @param [string] metadata Arbitrary user-defined metadata for this Secret + # @param [string] description description of Secret + # @return [NgrokAPI::Models::Secret] result from the API request + # + # https://ngrok.com/docs/api#api-secrets-update + def update(id: "", name: nil, value: nil, metadata: nil, description: nil) + path = '/vault_secrets/%{id}' + replacements = { + id: id, + } + data = {} + data[:name] = name if name + data[:value] = value if value + data[:metadata] = metadata if metadata + data[:description] = description if description + result = @client.patch(path % replacements, data: data) + NgrokAPI::Models::Secret.new(client: self, attrs: result) + end + + ## + # Update an existing Secret by ID + # Throws an exception if API error. + # + # @param [string] id identifier for Secret + # @param [string] name Name of secret + # @param [string] value Value of secret + # @param [string] metadata Arbitrary user-defined metadata for this Secret + # @param [string] description description of Secret + # @return [NgrokAPI::Models::Secret] result from the API request + # + # https://ngrok.com/docs/api#api-secrets-update + def update!(id: "", name: nil, value: nil, metadata: nil, description: nil) + path = '/vault_secrets/%{id}' + replacements = { + id: id, + } + data = {} + data[:name] = name if name + data[:value] = value if value + data[:metadata] = metadata if metadata + data[:description] = description if description + result = @client.patch(path % replacements, data: data, danger: true) + NgrokAPI::Models::Secret.new(client: self, attrs: result) + end + + ## + # Delete a Secret + # + # @param [string] id a resource identifier + # @return [NgrokAPI::Models::Empty] result from the API request + # + # https://ngrok.com/docs/api#api-secrets-delete + def delete(id: "") + path = '/vault_secrets/%{id}' + replacements = { + id: id, + } + @client.delete(path % replacements) + end + + ## + # Delete a Secret + # Throws an exception if API error. + # + # @param [string] id a resource identifier + # @return [NgrokAPI::Models::Empty] result from the API request + # + # https://ngrok.com/docs/api#api-secrets-delete + def delete!(id: "") + path = '/vault_secrets/%{id}' + replacements = { + id: id, + } + @client.delete(path % replacements, danger: true) + end + + ## + # Get a Secret by ID + # + # @param [string] id a resource identifier + # @return [NgrokAPI::Models::Secret] result from the API request + # + # https://ngrok.com/docs/api#api-secrets-get + def get(id: "") + path = '/vault_secrets/%{id}' + replacements = { + id: id, + } + data = {} + result = @client.get(path % replacements, data: data) + NgrokAPI::Models::Secret.new(client: self, attrs: result) + end + + ## + # Get a Secret by ID + # Throws an exception if API error. + # + # @param [string] id a resource identifier + # @return [NgrokAPI::Models::Secret] result from the API request + # + # https://ngrok.com/docs/api#api-secrets-get + def get!(id: "") + path = '/vault_secrets/%{id}' + replacements = { + id: id, + } + data = {} + result = @client.get(path % replacements, data: data, danger: true) + NgrokAPI::Models::Secret.new(client: self, attrs: result) + end + + ## + # List all Secrets owned by account + # + # @param [string] before_id + # @param [string] limit + # @param [string] url optional and mutually exclusive from before_id and limit + # @return [NgrokAPI::Models::Listable] result from the API request + # + # https://ngrok.com/docs/api#api-secrets-list + def list(before_id: nil, limit: nil, url: nil) + result = @client.list( + before_id: before_id, + limit: limit, + url: url, + path: PATH + ) + + NgrokAPI::Models::Listable.new( + client: self, + attrs: result, + list_property: LIST_PROPERTY, + klass: NgrokAPI::Models::Secret + ) + end + + ## + # List all Secrets owned by account + # Throws an exception if API error. + # + # @param [string] before_id + # @param [string] limit + # @param [string] url optional and mutually exclusive from before_id and limit + # @return [NgrokAPI::Models::Listable] result from the API request + # + # https://ngrok.com/docs/api#api-secrets-list + def list!(before_id: nil, limit: nil, url: nil) + result = @client.list( + before_id: before_id, + limit: limit, + danger: true, + url: url, + path: PATH + ) + + NgrokAPI::Models::Listable.new( + client: self, + attrs: result, + list_property: LIST_PROPERTY, + klass: NgrokAPI::Models::Secret, + danger: true + ) + end + end + end +end diff --git a/lib/ngrokapi/services/vaults_client.rb b/lib/ngrokapi/services/vaults_client.rb new file mode 100644 index 00000000..b7d7b23f --- /dev/null +++ b/lib/ngrokapi/services/vaults_client.rb @@ -0,0 +1,234 @@ +# frozen_string_literal: true + +# Code generated for API Clients. DO NOT EDIT. + +module NgrokAPI + module Services + ## + # Vaults is an api service for securely storing and managing sensitive data such + # as secrets, credentials, and tokens. + # + # https://ngrok.com/docs/api#api-vaults + class VaultsClient + # The API path for the requests + PATH = '/vaults' + # The List Property from the resulting API for list calls + LIST_PROPERTY = 'vaults' + + attr_reader :client + + def initialize(client:) + @client = client + end + + ## + # Create a new Vault + # + # @param [string] name Name of vault + # @param [string] metadata Arbitrary user-defined metadata for this Vault + # @param [string] description description of Vault + # @return [NgrokAPI::Models::Vault] result from the API request + # + # https://ngrok.com/docs/api#api-vaults-create + def create(name: "", metadata: "", description: "") + path = '/vaults' + replacements = { + } + data = {} + data[:name] = name if name + data[:metadata] = metadata if metadata + data[:description] = description if description + result = @client.post(path % replacements, data: data) + NgrokAPI::Models::Vault.new(client: self, attrs: result) + end + + ## + # Create a new Vault + # Throws an exception if API error. + # + # @param [string] name Name of vault + # @param [string] metadata Arbitrary user-defined metadata for this Vault + # @param [string] description description of Vault + # @return [NgrokAPI::Models::Vault] result from the API request + # + # https://ngrok.com/docs/api#api-vaults-create + def create!(name: "", metadata: "", description: "") + path = '/vaults' + replacements = { + } + data = {} + data[:name] = name if name + data[:metadata] = metadata if metadata + data[:description] = description if description + result = @client.post(path % replacements, data: data, danger: true) + NgrokAPI::Models::Vault.new(client: self, attrs: result) + end + + ## + # Update an existing Vault by ID + # + # @param [string] id identifier for Vault + # @param [string] name Name of vault + # @param [string] metadata Arbitrary user-defined metadata for this Vault + # @param [string] description description of Vault + # @return [NgrokAPI::Models::Vault] result from the API request + # + # https://ngrok.com/docs/api#api-vaults-update + def update(id: "", name: nil, metadata: nil, description: nil) + path = '/vaults/%{id}' + replacements = { + id: id, + } + data = {} + data[:name] = name if name + data[:metadata] = metadata if metadata + data[:description] = description if description + result = @client.patch(path % replacements, data: data) + NgrokAPI::Models::Vault.new(client: self, attrs: result) + end + + ## + # Update an existing Vault by ID + # Throws an exception if API error. + # + # @param [string] id identifier for Vault + # @param [string] name Name of vault + # @param [string] metadata Arbitrary user-defined metadata for this Vault + # @param [string] description description of Vault + # @return [NgrokAPI::Models::Vault] result from the API request + # + # https://ngrok.com/docs/api#api-vaults-update + def update!(id: "", name: nil, metadata: nil, description: nil) + path = '/vaults/%{id}' + replacements = { + id: id, + } + data = {} + data[:name] = name if name + data[:metadata] = metadata if metadata + data[:description] = description if description + result = @client.patch(path % replacements, data: data, danger: true) + NgrokAPI::Models::Vault.new(client: self, attrs: result) + end + + ## + # Delete a Vault + # + # @param [string] id a resource identifier + # @return [NgrokAPI::Models::Empty] result from the API request + # + # https://ngrok.com/docs/api#api-vaults-delete + def delete(id: "") + path = '/vaults/%{id}' + replacements = { + id: id, + } + @client.delete(path % replacements) + end + + ## + # Delete a Vault + # Throws an exception if API error. + # + # @param [string] id a resource identifier + # @return [NgrokAPI::Models::Empty] result from the API request + # + # https://ngrok.com/docs/api#api-vaults-delete + def delete!(id: "") + path = '/vaults/%{id}' + replacements = { + id: id, + } + @client.delete(path % replacements, danger: true) + end + + ## + # Get a Vault by ID + # + # @param [string] id a resource identifier + # @return [NgrokAPI::Models::Vault] result from the API request + # + # https://ngrok.com/docs/api#api-vaults-get + def get(id: "") + path = '/vaults/%{id}' + replacements = { + id: id, + } + data = {} + result = @client.get(path % replacements, data: data) + NgrokAPI::Models::Vault.new(client: self, attrs: result) + end + + ## + # Get a Vault by ID + # Throws an exception if API error. + # + # @param [string] id a resource identifier + # @return [NgrokAPI::Models::Vault] result from the API request + # + # https://ngrok.com/docs/api#api-vaults-get + def get!(id: "") + path = '/vaults/%{id}' + replacements = { + id: id, + } + data = {} + result = @client.get(path % replacements, data: data, danger: true) + NgrokAPI::Models::Vault.new(client: self, attrs: result) + end + + ## + # List all Vaults owned by account + # + # @param [string] before_id + # @param [string] limit + # @param [string] url optional and mutually exclusive from before_id and limit + # @return [NgrokAPI::Models::Listable] result from the API request + # + # https://ngrok.com/docs/api#api-vaults-list + def list(before_id: nil, limit: nil, url: nil) + result = @client.list( + before_id: before_id, + limit: limit, + url: url, + path: PATH + ) + + NgrokAPI::Models::Listable.new( + client: self, + attrs: result, + list_property: LIST_PROPERTY, + klass: NgrokAPI::Models::Vault + ) + end + + ## + # List all Vaults owned by account + # Throws an exception if API error. + # + # @param [string] before_id + # @param [string] limit + # @param [string] url optional and mutually exclusive from before_id and limit + # @return [NgrokAPI::Models::Listable] result from the API request + # + # https://ngrok.com/docs/api#api-vaults-list + def list!(before_id: nil, limit: nil, url: nil) + result = @client.list( + before_id: before_id, + limit: limit, + danger: true, + url: url, + path: PATH + ) + + NgrokAPI::Models::Listable.new( + client: self, + attrs: result, + list_property: LIST_PROPERTY, + klass: NgrokAPI::Models::Vault, + danger: true + ) + end + end + end +end diff --git a/lib/ngrokapi/version.rb b/lib/ngrokapi/version.rb index e2e1e1e9..ea2fd301 100644 --- a/lib/ngrokapi/version.rb +++ b/lib/ngrokapi/version.rb @@ -4,6 +4,6 @@ module NgrokAPI # rubocop:disable Layout/SpaceAroundOperators # The current version of the gem - VERSION="0.24.0".freeze + VERSION="0.25.0".freeze # rubocop:enable Layout/SpaceAroundOperators end diff --git a/spec/ngrokapi/client_spec.rb b/spec/ngrokapi/client_spec.rb index ffe9b765..c7f7393b 100644 --- a/spec/ngrokapi/client_spec.rb +++ b/spec/ngrokapi/client_spec.rb @@ -116,6 +116,12 @@ end end + describe "#secrets" do + it "returns an instance of the SecretsClient" do + expect(@client.secrets.class).to eq(NgrokAPI::Services::SecretsClient) + end + end + describe "#ssh_certificate_authorities" do it "returns an instance of the SSHCertificateAuthoritiesClient" do expect(@client.ssh_certificate_authorities.class).to eq(NgrokAPI::Services::SSHCertificateAuthoritiesClient) @@ -152,6 +158,12 @@ end end + describe "#vaults" do + it "returns an instance of the VaultsClient" do + expect(@client.vaults.class).to eq(NgrokAPI::Services::VaultsClient) + end + end + describe "#backends" do it "returns an instance of OpenStruct covering namespaces" do ns = @client.backends diff --git a/spec/ngrokapi/models/endpoint_spec.rb b/spec/ngrokapi/models/endpoint_spec.rb index e8ac903d..7c5ba72e 100644 --- a/spec/ngrokapi/models/endpoint_spec.rb +++ b/spec/ngrokapi/models/endpoint_spec.rb @@ -28,19 +28,22 @@ new_description = 'New description' new_metadata = 'New metadata' new_bindings = 'New bindings' + new_pooling_enabled = 'New pooling_enabled' expect(@endpoint.client).to receive(:update) @endpoint.update( url: new_url, traffic_policy: new_traffic_policy, description: new_description, metadata: new_metadata, - bindings: new_bindings + bindings: new_bindings, + pooling_enabled: new_pooling_enabled ) expect(@endpoint.url).to eq new_url expect(@endpoint.traffic_policy).to eq new_traffic_policy expect(@endpoint.description).to eq new_description expect(@endpoint.metadata).to eq new_metadata expect(@endpoint.bindings).to eq new_bindings + expect(@endpoint.pooling_enabled).to eq new_pooling_enabled end end diff --git a/spec/ngrokapi/models/secret_spec.rb b/spec/ngrokapi/models/secret_spec.rb new file mode 100644 index 00000000..0d2af6c6 --- /dev/null +++ b/spec/ngrokapi/models/secret_spec.rb @@ -0,0 +1,30 @@ +# Code generated for API Clients. DO NOT EDIT. + +require 'spec_helper' + +RSpec.describe NgrokAPI::Models::Secret do + before(:each) do + @client = class_double("SecretsClient") + @secret = NgrokAPI::Models::Secret.new(client: @client, attrs: secret_result) + end + + describe "#==" do + it "is equal if the results are the same" do + other = NgrokAPI::Models::Secret.new(client: @client, attrs: secret_result) + expect(@secret == other).to eq true + end + end + + describe "#to_s" do + it "stringifies as result.to_s" do + expect(@secret.to_s).to eq secret_result.to_s + end + end + + describe "#delete" do + it "calls delete on the client" do + expect(@secret.client).to receive(:delete) + @secret.delete + end + end +end diff --git a/spec/ngrokapi/models/vault_spec.rb b/spec/ngrokapi/models/vault_spec.rb new file mode 100644 index 00000000..db9d3b68 --- /dev/null +++ b/spec/ngrokapi/models/vault_spec.rb @@ -0,0 +1,47 @@ +# Code generated for API Clients. DO NOT EDIT. + +require 'spec_helper' + +RSpec.describe NgrokAPI::Models::Vault do + before(:each) do + @client = class_double("VaultsClient") + @vault = NgrokAPI::Models::Vault.new(client: @client, attrs: vault_result) + end + + describe "#==" do + it "is equal if the results are the same" do + other = NgrokAPI::Models::Vault.new(client: @client, attrs: vault_result) + expect(@vault == other).to eq true + end + end + + describe "#to_s" do + it "stringifies as result.to_s" do + expect(@vault.to_s).to eq vault_result.to_s + end + end + + describe "#update" do + it "calls update on the client" do + new_name = 'New name' + new_metadata = 'New metadata' + new_description = 'New description' + expect(@vault.client).to receive(:update) + @vault.update( + name: new_name, + metadata: new_metadata, + description: new_description + ) + expect(@vault.name).to eq new_name + expect(@vault.metadata).to eq new_metadata + expect(@vault.description).to eq new_description + end + end + + describe "#delete" do + it "calls delete on the client" do + expect(@vault.client).to receive(:delete) + @vault.delete + end + end +end diff --git a/spec/ngrokapi/services/endpoints_client_spec.rb b/spec/ngrokapi/services/endpoints_client_spec.rb index d7d68c68..0a905c6a 100644 --- a/spec/ngrokapi/services/endpoints_client_spec.rb +++ b/spec/ngrokapi/services/endpoints_client_spec.rb @@ -26,6 +26,7 @@ data[:description] = "New description" data[:metadata] = "New metadata" data[:bindings] = "New bindings" + data[:pooling_enabled] = "New pooling_enabled" expect(@client).to receive(:post).with(path % replacements, data: data). and_return(endpoint_result) result = @endpoints_client.create( @@ -34,7 +35,8 @@ traffic_policy: "New traffic_policy", description: "New description", metadata: "New metadata", - bindings: "New bindings" + bindings: "New bindings", + pooling_enabled: "New pooling_enabled" ) expect(result.class).to eq(NgrokAPI::Models::Endpoint) end @@ -52,6 +54,7 @@ data[:description] = "New description" data[:metadata] = "New metadata" data[:bindings] = "New bindings" + data[:pooling_enabled] = "New pooling_enabled" expect(@client).to receive(:post).with(path % replacements, data: data). and_return(endpoint_result) result = @endpoints_client.create( @@ -60,7 +63,8 @@ traffic_policy: "New traffic_policy", description: "New description", metadata: "New metadata", - bindings: "New bindings" + bindings: "New bindings", + pooling_enabled: "New pooling_enabled" ) expect(result.class).to eq(NgrokAPI::Models::Endpoint) # expect(result.id).to eq(endpoint_result["id"]) @@ -122,6 +126,7 @@ data[:description] = "New description" data[:metadata] = "New metadata" data[:bindings] = "New bindings" + data[:pooling_enabled] = "New pooling_enabled" expect(@client).to receive(:patch).with(path % replacements, data: data). and_return(endpoint_result) result = @endpoints_client.update( @@ -130,7 +135,8 @@ traffic_policy: "New traffic_policy", description: "New description", metadata: "New metadata", - bindings: "New bindings" + bindings: "New bindings", + pooling_enabled: "New pooling_enabled" ) expect(result.class).to eq(NgrokAPI::Models::Endpoint) end @@ -148,6 +154,7 @@ data[:description] = "New description" data[:metadata] = "New metadata" data[:bindings] = "New bindings" + data[:pooling_enabled] = "New pooling_enabled" expect(@client).to receive(:patch).with(path % replacements, data: data). and_return(endpoint_result) result = @endpoints_client.update( @@ -156,7 +163,8 @@ traffic_policy: "New traffic_policy", description: "New description", metadata: "New metadata", - bindings: "New bindings" + bindings: "New bindings", + pooling_enabled: "New pooling_enabled" ) expect(result.class).to eq(NgrokAPI::Models::Endpoint) # expect(result.id).to eq(endpoint_result["id"]) diff --git a/spec/ngrokapi/services/secrets_client_spec.rb b/spec/ngrokapi/services/secrets_client_spec.rb new file mode 100644 index 00000000..0bbf3f7a --- /dev/null +++ b/spec/ngrokapi/services/secrets_client_spec.rb @@ -0,0 +1,198 @@ +# Code generated for API Clients. DO NOT EDIT. + +require 'spec_helper' + +RSpec.describe NgrokAPI::Services::SecretsClient do + let(:base_url) { 'https://api.ngrok.com' } + let(:path) { '/vault_secrets' } + let(:not_found) do + NgrokAPI::Errors::NotFoundError.new(response: secret_result) + end + + before(:each) do + @client = class_double("HttpClient") + @secrets_client = NgrokAPI::Services::SecretsClient.new(client: @client) + end + + describe "#create" do + it "will make a post request and return an instance of NgrokAPI::Models::Secret" do + path = '/vault_secrets' + replacements = { + } + data = {} + data[:name] = "New name" + data[:value] = "New value" + data[:metadata] = "New metadata" + data[:description] = "New description" + data[:vault_id] = "New vault_id" + expect(@client).to receive(:post).with(path % replacements, data: data). + and_return(secret_result) + result = @secrets_client.create( + name: "New name", + value: "New value", + metadata: "New metadata", + description: "New description", + vault_id: "New vault_id" + ) + expect(result.class).to eq(NgrokAPI::Models::Secret) + end + end + + describe "#create!" do + it "will make a post request and return an instance of NgrokAPI::Models::Secret" do + path = '/vault_secrets' + replacements = { + } + data = {} + data[:name] = "New name" + data[:value] = "New value" + data[:metadata] = "New metadata" + data[:description] = "New description" + data[:vault_id] = "New vault_id" + expect(@client).to receive(:post).with(path % replacements, data: data). + and_return(secret_result) + result = @secrets_client.create( + name: "New name", + value: "New value", + metadata: "New metadata", + description: "New description", + vault_id: "New vault_id" + ) + expect(result.class).to eq(NgrokAPI::Models::Secret) + # expect(result.id).to eq(secret_result["id"]) + end + end + + describe "#update" do + it "will make a patch request and return an instance of NgrokAPI::Models::Secret" do + path = '/vault_secrets/%{id}' + replacements = { + id: secret_result["id"], + } + data = {} + data[:name] = "New name" + data[:value] = "New value" + data[:metadata] = "New metadata" + data[:description] = "New description" + expect(@client).to receive(:patch).with(path % replacements, data: data). + and_return(secret_result) + result = @secrets_client.update( + id: secret_result["id"], + name: "New name", + value: "New value", + metadata: "New metadata", + description: "New description" + ) + expect(result.class).to eq(NgrokAPI::Models::Secret) + end + end + + describe "#update!" do + it "will make a patch request and return an instance of NgrokAPI::Models::Secret" do + path = '/vault_secrets/%{id}' + replacements = { + id: secret_result["id"], + } + data = {} + data[:name] = "New name" + data[:value] = "New value" + data[:metadata] = "New metadata" + data[:description] = "New description" + expect(@client).to receive(:patch).with(path % replacements, data: data). + and_return(secret_result) + result = @secrets_client.update( + id: secret_result["id"], + name: "New name", + value: "New value", + metadata: "New metadata", + description: "New description" + ) + expect(result.class).to eq(NgrokAPI::Models::Secret) + # expect(result.id).to eq(secret_result["id"]) + end + end + + describe "#delete" do + it "will make a delete request" do + path = '/vault_secrets/%{id}' + replacements = { + id: api_key_result["id"], + } + expect(@client).to receive(:delete).with(path % replacements).and_return(nil) + @secrets_client.delete( + id: api_key_result["id"] + ) + end + end + + describe "#delete!" do + it "will make a delete request" do + path = '/vault_secrets/%{id}' + replacements = { + id: api_key_result["id"], + } + expect(@client).to receive(:delete).with(path % replacements, danger: true).and_return(nil) + @secrets_client.delete!( + id: api_key_result["id"] + ) + end + + it "will make a delete request and return NotFoundError if 404" do + path = '/vault_secrets/%{id}' + replacements = { + id: api_key_result["id"], + } + expect do + expect(@client).to receive(:delete).with(path % replacements, danger: true). + and_raise(NgrokAPI::Errors::NotFoundError) + result = @secrets_client.delete!( + id: api_key_result["id"] + ) + expect(result).to be nil + end.to raise_error(NgrokAPI::Errors::NotFoundError) + end + end + + describe "#get" do + it "will make a get request and return an instance of NgrokAPI::Models::Secret" do + path = '/vault_secrets/%{id}' + replacements = { + id: secret_result["id"], + } + data = {} + expect(@client).to receive(:get).with(path % replacements, data: data). + and_return(secret_result) + result = @secrets_client.get( + id: secret_result["id"] + ) + expect(result.class).to eq(NgrokAPI::Models::Secret) + end + end + + describe "#get!" do + it "will make a get request and return an instance of NgrokAPI::Models::Secret" do + path = '/vault_secrets/%{id}' + replacements = { + id: secret_result["id"], + } + data = {} + expect(@client).to receive(:get).with(path % replacements, data: data). + and_return(secret_result) + result = @secrets_client.get( + id: secret_result["id"] + ) + expect(result.class).to eq(NgrokAPI::Models::Secret) + # expect(result.id).to eq(secret_result["id"]) + end + end + + describe "#list" do + it "will make a call to list (a GET request) and return a NgrokAPI::Models::Listable" do + expect(@client).to receive(:list). + and_return(secret_results) + url = base_url + path + "?before_id=" + api_key_result["id"] + "&limit=1" + result = @secrets_client.list(url: url) + expect(result.class).to eq(NgrokAPI::Models::Listable) + end + end +end diff --git a/spec/ngrokapi/services/vaults_client_spec.rb b/spec/ngrokapi/services/vaults_client_spec.rb new file mode 100644 index 00000000..45e90db1 --- /dev/null +++ b/spec/ngrokapi/services/vaults_client_spec.rb @@ -0,0 +1,186 @@ +# Code generated for API Clients. DO NOT EDIT. + +require 'spec_helper' + +RSpec.describe NgrokAPI::Services::VaultsClient do + let(:base_url) { 'https://api.ngrok.com' } + let(:path) { '/vaults' } + let(:not_found) do + NgrokAPI::Errors::NotFoundError.new(response: vault_result) + end + + before(:each) do + @client = class_double("HttpClient") + @vaults_client = NgrokAPI::Services::VaultsClient.new(client: @client) + end + + describe "#create" do + it "will make a post request and return an instance of NgrokAPI::Models::Vault" do + path = '/vaults' + replacements = { + } + data = {} + data[:name] = "New name" + data[:metadata] = "New metadata" + data[:description] = "New description" + expect(@client).to receive(:post).with(path % replacements, data: data). + and_return(vault_result) + result = @vaults_client.create( + name: "New name", + metadata: "New metadata", + description: "New description" + ) + expect(result.class).to eq(NgrokAPI::Models::Vault) + end + end + + describe "#create!" do + it "will make a post request and return an instance of NgrokAPI::Models::Vault" do + path = '/vaults' + replacements = { + } + data = {} + data[:name] = "New name" + data[:metadata] = "New metadata" + data[:description] = "New description" + expect(@client).to receive(:post).with(path % replacements, data: data). + and_return(vault_result) + result = @vaults_client.create( + name: "New name", + metadata: "New metadata", + description: "New description" + ) + expect(result.class).to eq(NgrokAPI::Models::Vault) + # expect(result.id).to eq(vault_result["id"]) + end + end + + describe "#update" do + it "will make a patch request and return an instance of NgrokAPI::Models::Vault" do + path = '/vaults/%{id}' + replacements = { + id: vault_result["id"], + } + data = {} + data[:name] = "New name" + data[:metadata] = "New metadata" + data[:description] = "New description" + expect(@client).to receive(:patch).with(path % replacements, data: data). + and_return(vault_result) + result = @vaults_client.update( + id: vault_result["id"], + name: "New name", + metadata: "New metadata", + description: "New description" + ) + expect(result.class).to eq(NgrokAPI::Models::Vault) + end + end + + describe "#update!" do + it "will make a patch request and return an instance of NgrokAPI::Models::Vault" do + path = '/vaults/%{id}' + replacements = { + id: vault_result["id"], + } + data = {} + data[:name] = "New name" + data[:metadata] = "New metadata" + data[:description] = "New description" + expect(@client).to receive(:patch).with(path % replacements, data: data). + and_return(vault_result) + result = @vaults_client.update( + id: vault_result["id"], + name: "New name", + metadata: "New metadata", + description: "New description" + ) + expect(result.class).to eq(NgrokAPI::Models::Vault) + # expect(result.id).to eq(vault_result["id"]) + end + end + + describe "#delete" do + it "will make a delete request" do + path = '/vaults/%{id}' + replacements = { + id: api_key_result["id"], + } + expect(@client).to receive(:delete).with(path % replacements).and_return(nil) + @vaults_client.delete( + id: api_key_result["id"] + ) + end + end + + describe "#delete!" do + it "will make a delete request" do + path = '/vaults/%{id}' + replacements = { + id: api_key_result["id"], + } + expect(@client).to receive(:delete).with(path % replacements, danger: true).and_return(nil) + @vaults_client.delete!( + id: api_key_result["id"] + ) + end + + it "will make a delete request and return NotFoundError if 404" do + path = '/vaults/%{id}' + replacements = { + id: api_key_result["id"], + } + expect do + expect(@client).to receive(:delete).with(path % replacements, danger: true). + and_raise(NgrokAPI::Errors::NotFoundError) + result = @vaults_client.delete!( + id: api_key_result["id"] + ) + expect(result).to be nil + end.to raise_error(NgrokAPI::Errors::NotFoundError) + end + end + + describe "#get" do + it "will make a get request and return an instance of NgrokAPI::Models::Vault" do + path = '/vaults/%{id}' + replacements = { + id: vault_result["id"], + } + data = {} + expect(@client).to receive(:get).with(path % replacements, data: data). + and_return(vault_result) + result = @vaults_client.get( + id: vault_result["id"] + ) + expect(result.class).to eq(NgrokAPI::Models::Vault) + end + end + + describe "#get!" do + it "will make a get request and return an instance of NgrokAPI::Models::Vault" do + path = '/vaults/%{id}' + replacements = { + id: vault_result["id"], + } + data = {} + expect(@client).to receive(:get).with(path % replacements, data: data). + and_return(vault_result) + result = @vaults_client.get( + id: vault_result["id"] + ) + expect(result.class).to eq(NgrokAPI::Models::Vault) + # expect(result.id).to eq(vault_result["id"]) + end + end + + describe "#list" do + it "will make a call to list (a GET request) and return a NgrokAPI::Models::Listable" do + expect(@client).to receive(:list). + and_return(vault_results) + url = base_url + path + "?before_id=" + api_key_result["id"] + "&limit=1" + result = @vaults_client.list(url: url) + expect(result.class).to eq(NgrokAPI::Models::Listable) + end + end +end diff --git a/spec/spec_helper.rb b/spec/spec_helper.rb index 4538070a..202223a3 100644 --- a/spec/spec_helper.rb +++ b/spec/spec_helper.rb @@ -905,6 +905,59 @@ def ip_restriction_results } end +def kubernetes_operator_binding_create_result + { + } +end + +def kubernetes_operator_binding_result + { + } +end + +def kubernetes_operator_binding_update_result + { + } +end + +def kubernetes_operator_cert_result + { + } +end + +def kubernetes_operator_deployment_result + { + } +end + +def kubernetes_operator_deployment_update_result + { + } +end + +def kubernetes_operator_result + { + "id" => "ko_1rV3S8JZQ9vZ2J5Z8Z8Z8Z8Z8Z8", + "uri" => "https://api.ngrok.com/kubernetes_operators/ko_1rV3S8JZQ9vZ2J5Z8Z8Z8Z8Z8Z", + } +end + +def kubernetes_operator_results + { + "operators" => [ + kubernetes_operator_result, + ], + "uri" => "https://api.ngrok.com/kubernetes_operators", + "next_page_uri" => nil, + } +end + +def kubernetes_operators_get_bound_endpoints_input + { + "id" => kubernetes_operator_result["id"], + } +end + def ref_result { } @@ -1538,3 +1591,67 @@ def weighted_backend_results "next_page_uri" => nil, } end + +def secret_result + { + "id" => "secret_2y0arDtaBNqxT0gSw2pfBObOjgc", + "uri" => "https://api.ngrok.com.lan/vault_secrets/secret_2y0arDtaBNqxT0gSw2pfBObOjgc", + "name" => "foooooo-updated", + "description" => "Updated secret after rotation", + "metadata" => "env=prod,rotation=2025", + "created_at" => "2025-06-03T18:09:00Z", + "updated_at" => "2025-06-03T19:00:00Z", + "created_by" => { + "id" => "usr_2xVG4dWulHzHrt5TxxoQRvrLOF3", + "uri" => "", + }, + "last_updated_by" => { + "id" => "usr_2xVG4dWulHzHrt5TxxoQRvrLOF3", + "uri" => "", + }, + "vault" => { + "id" => "vault_2y0YkHvDtItsU4xNJpBPGx8EW2K", + "uri" => "https://api.ngrok.com.lan/vaults/vault_2y0YkHvDtItsU4xNJpBPGx8EW2K", + }, + } +end + +def secret_results + { + "secrets" => [ + secret_result, + ], + "uri" => "https://api.ngrok.com.lan/vault_secrets", + "next_page_uri" => nil, + } +end + +def vault_result + { + "id" => "vault_2xxf3F5QAzvG3OZYm7xyZ2Nhpkb", + "uri" => "https://api.ngrok.com.lan/vaults/vault_2xxf3F5QAzvG3OZYm7xyZ2Nhpkb", + "name" => "foo-renamed", + "description" => "Updated vault for prod environment", + "metadata" => "env=prod,team=secops", + "created_at" => "2025-06-02T17:14:03Z", + "updated_at" => "2025-06-03T10:25:00Z", + "created_by" => { + "id" => "usr_2xVG4dWulHzHrt5TxxoQRvrLOF3", + "uri" => "", + }, + "last_updated_by" => { + "id" => "usr_2xVG4dWulHzHrt5TxxoQRvrLOF3", + "uri" => "", + }, + } +end + +def vault_results + { + "vaults" => [ + vault_result, + ], + "uri" => "https://api.ngrok.com.lan/vaults", + "next_page_uri" => nil, + } +end From 45165d64a9e2510999929bc173cffe6034886b80 Mon Sep 17 00:00:00 2001 From: Benjamin Pollack Date: Fri, 15 Aug 2025 10:36:57 -0400 Subject: [PATCH 2/2] bump one more thing in Gemfile.lock --- Gemfile.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index bcbe0314..db80597b 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,7 +1,7 @@ PATH remote: . specs: - ngrok-api (0.24.0) + ngrok-api (0.25.0) GEM remote: https://rubygems.org/