ngrok-api 0.23.0 → 0.25.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.github/workflows/ci.yml +1 -1
- data/.gitignore +0 -1
- data/CHANGELOG.md +18 -1
- data/Gemfile +10 -10
- data/Gemfile.lock +183 -0
- data/README.md +21 -0
- data/doc/NgrokAPI/Client.html +229 -67
- data/doc/NgrokAPI/Error.html +2 -2
- data/doc/NgrokAPI/Errors/NotFoundError.html +2 -2
- data/doc/NgrokAPI/Errors.html +2 -2
- data/doc/NgrokAPI/HttpClient.html +2 -2
- data/doc/NgrokAPI/Models/APIKey.html +2 -2
- data/doc/NgrokAPI/Models/AWSAuth.html +2 -2
- data/doc/NgrokAPI/Models/AWSCredentials.html +2 -2
- data/doc/NgrokAPI/Models/AWSRole.html +2 -2
- data/doc/NgrokAPI/Models/AbuseReport.html +2 -2
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +2 -2
- data/doc/NgrokAPI/Models/AgentIngress.html +2 -2
- data/doc/NgrokAPI/Models/AgentIngressCertJob.html +2 -2
- data/doc/NgrokAPI/Models/AgentIngressCertPolicy.html +2 -2
- data/doc/NgrokAPI/Models/AgentIngressCertStatus.html +2 -2
- data/doc/NgrokAPI/Models/ApplicationSession.html +2 -2
- data/doc/NgrokAPI/Models/ApplicationUser.html +2 -2
- data/doc/NgrokAPI/Models/BotUser.html +2 -2
- data/doc/NgrokAPI/Models/BrowserSession.html +2 -2
- data/doc/NgrokAPI/Models/CertificateAuthority.html +2 -2
- data/doc/NgrokAPI/Models/Credential.html +2 -2
- data/doc/NgrokAPI/Models/Endpoint.html +1400 -180
- data/doc/NgrokAPI/Models/EndpointBackend.html +2 -2
- data/doc/NgrokAPI/Models/EndpointBackendMutate.html +2 -2
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +2 -2
- data/doc/NgrokAPI/Models/EndpointCompression.html +2 -2
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +2 -2
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +2 -2
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +2 -2
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuth.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthAmazon.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthGitLab.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthLinkedIn.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOAuthTwitch.html +2 -2
- data/doc/NgrokAPI/Models/EndpointOIDC.html +2 -2
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +2 -2
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +2 -2
- data/doc/NgrokAPI/Models/EndpointSAML.html +2 -2
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +2 -2
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +2 -2
- data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +2 -2
- data/doc/NgrokAPI/Models/EndpointTrafficPolicy.html +2 -2
- data/doc/NgrokAPI/Models/EndpointUserAgentFilter.html +2 -2
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +2 -2
- data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +2 -2
- data/doc/NgrokAPI/Models/EventDestination.html +2 -2
- data/doc/NgrokAPI/Models/EventSource.html +2 -2
- data/doc/NgrokAPI/Models/EventSourceList.html +2 -2
- data/doc/NgrokAPI/Models/EventSourceReplace.html +2 -2
- data/doc/NgrokAPI/Models/EventSubscription.html +2 -2
- data/doc/NgrokAPI/Models/EventTarget.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetAzureLogsIngestion.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetDatadog.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +2 -2
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +2 -2
- data/doc/NgrokAPI/Models/FailoverBackend.html +2 -2
- data/doc/NgrokAPI/Models/HTTPResponseBackend.html +2 -2
- data/doc/NgrokAPI/Models/HTTPSEdge.html +2 -2
- data/doc/NgrokAPI/Models/HTTPSEdgeRoute.html +2 -2
- data/doc/NgrokAPI/Models/IPPolicy.html +2 -2
- data/doc/NgrokAPI/Models/IPPolicyRule.html +2 -2
- data/doc/NgrokAPI/Models/IPRestriction.html +2 -2
- data/doc/NgrokAPI/Models/IdentityProvider.html +2 -2
- data/doc/NgrokAPI/Models/Listable.html +2 -2
- data/doc/NgrokAPI/Models/Location.html +2 -2
- data/doc/NgrokAPI/Models/Ref.html +2 -2
- data/doc/NgrokAPI/Models/ReservedAddr.html +2 -2
- data/doc/NgrokAPI/Models/ReservedDomain.html +2 -2
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +2 -2
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +2 -2
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +2 -2
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +2 -2
- data/doc/NgrokAPI/Models/SSHCredential.html +2 -2
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +2 -2
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +2 -2
- data/doc/NgrokAPI/Models/Secret.html +1336 -0
- data/doc/NgrokAPI/Models/StaticBackend.html +2 -2
- data/doc/NgrokAPI/Models/StaticBackendTLS.html +2 -2
- data/doc/NgrokAPI/Models/TCPEdge.html +2 -2
- data/doc/NgrokAPI/Models/TLSCertificate.html +2 -2
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +2 -2
- data/doc/NgrokAPI/Models/TLSEdge.html +2 -2
- data/doc/NgrokAPI/Models/Tunnel.html +2 -2
- data/doc/NgrokAPI/Models/TunnelGroupBackend.html +2 -2
- data/doc/NgrokAPI/Models/TunnelSession.html +2 -2
- data/doc/NgrokAPI/Models/UserAgent.html +2 -2
- data/doc/NgrokAPI/Models/Vault.html +1353 -0
- data/doc/NgrokAPI/Models/WeightedBackend.html +2 -2
- data/doc/NgrokAPI/Models.html +4 -4
- data/doc/NgrokAPI/PagedIterator.html +2 -2
- data/doc/NgrokAPI/Services/APIKeysClient.html +2 -2
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +2 -2
- data/doc/NgrokAPI/Services/AgentIngressesClient.html +2 -2
- data/doc/NgrokAPI/Services/ApplicationSessionsClient.html +2 -2
- data/doc/NgrokAPI/Services/ApplicationUsersClient.html +2 -2
- data/doc/NgrokAPI/Services/BotUsersClient.html +2 -2
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +2 -2
- data/doc/NgrokAPI/Services/CredentialsClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteTrafficPolicyModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgesHTTPSClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgesTCPClient.html +2 -2
- data/doc/NgrokAPI/Services/EdgesTLSClient.html +2 -2
- data/doc/NgrokAPI/Services/EndpointsClient.html +1353 -139
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +2 -2
- data/doc/NgrokAPI/Services/EventSourcesClient.html +2 -2
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +2 -2
- data/doc/NgrokAPI/Services/FailoverBackendsClient.html +2 -2
- data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +2 -2
- data/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +2 -2
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +2 -2
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +2 -2
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +2 -2
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +2 -2
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +2 -2
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +2 -2
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +2 -2
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +2 -2
- data/doc/NgrokAPI/Services/SecretsClient.html +1925 -0
- data/doc/NgrokAPI/Services/StaticBackendsClient.html +2 -2
- data/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TCPEdgeTrafficPolicyModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TLSCertificatesClient.html +2 -2
- data/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TLSEdgeTrafficPolicyModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +2 -2
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +2 -2
- data/doc/NgrokAPI/Services/TunnelsClient.html +2 -2
- data/doc/NgrokAPI/Services/VaultsClient.html +1809 -0
- data/doc/NgrokAPI/Services/WeightedBackendsClient.html +2 -2
- data/doc/NgrokAPI/Services.html +5 -5
- data/doc/NgrokAPI.html +4 -4
- data/doc/_index.html +38 -2
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +21 -2
- data/doc/index.html +21 -2
- data/doc/method_list.html +1293 -637
- data/doc/top-level-namespace.html +2 -2
- data/docs/NgrokAPI/Client.html +229 -67
- data/docs/NgrokAPI/Error.html +2 -2
- data/docs/NgrokAPI/Errors/NotFoundError.html +2 -2
- data/docs/NgrokAPI/Errors.html +2 -2
- data/docs/NgrokAPI/HttpClient.html +2 -2
- data/docs/NgrokAPI/Models/APIKey.html +2 -2
- data/docs/NgrokAPI/Models/AWSAuth.html +2 -2
- data/docs/NgrokAPI/Models/AWSCredentials.html +2 -2
- data/docs/NgrokAPI/Models/AWSRole.html +2 -2
- data/docs/NgrokAPI/Models/AbuseReport.html +2 -2
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +2 -2
- data/docs/NgrokAPI/Models/AgentIngress.html +2 -2
- data/docs/NgrokAPI/Models/AgentIngressCertJob.html +2 -2
- data/docs/NgrokAPI/Models/AgentIngressCertPolicy.html +2 -2
- data/docs/NgrokAPI/Models/AgentIngressCertStatus.html +2 -2
- data/docs/NgrokAPI/Models/ApplicationSession.html +2 -2
- data/docs/NgrokAPI/Models/ApplicationUser.html +2 -2
- data/docs/NgrokAPI/Models/BotUser.html +2 -2
- data/docs/NgrokAPI/Models/BrowserSession.html +2 -2
- data/docs/NgrokAPI/Models/CertificateAuthority.html +2 -2
- data/docs/NgrokAPI/Models/Credential.html +2 -2
- data/docs/NgrokAPI/Models/Endpoint.html +1400 -180
- data/docs/NgrokAPI/Models/EndpointBackend.html +2 -2
- data/docs/NgrokAPI/Models/EndpointBackendMutate.html +2 -2
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +2 -2
- data/docs/NgrokAPI/Models/EndpointCompression.html +2 -2
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +2 -2
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +2 -2
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +2 -2
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuth.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthAmazon.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthGitLab.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthLinkedIn.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOAuthTwitch.html +2 -2
- data/docs/NgrokAPI/Models/EndpointOIDC.html +2 -2
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +2 -2
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +2 -2
- data/docs/NgrokAPI/Models/EndpointSAML.html +2 -2
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +2 -2
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +2 -2
- data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +2 -2
- data/docs/NgrokAPI/Models/EndpointTrafficPolicy.html +2 -2
- data/docs/NgrokAPI/Models/EndpointUserAgentFilter.html +2 -2
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +2 -2
- data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +2 -2
- data/docs/NgrokAPI/Models/EventDestination.html +2 -2
- data/docs/NgrokAPI/Models/EventSource.html +2 -2
- data/docs/NgrokAPI/Models/EventSourceList.html +2 -2
- data/docs/NgrokAPI/Models/EventSourceReplace.html +2 -2
- data/docs/NgrokAPI/Models/EventSubscription.html +2 -2
- data/docs/NgrokAPI/Models/EventTarget.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetAzureLogsIngestion.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetDatadog.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +2 -2
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +2 -2
- data/docs/NgrokAPI/Models/FailoverBackend.html +2 -2
- data/docs/NgrokAPI/Models/HTTPResponseBackend.html +2 -2
- data/docs/NgrokAPI/Models/HTTPSEdge.html +2 -2
- data/docs/NgrokAPI/Models/HTTPSEdgeRoute.html +2 -2
- data/docs/NgrokAPI/Models/IPPolicy.html +2 -2
- data/docs/NgrokAPI/Models/IPPolicyRule.html +2 -2
- data/docs/NgrokAPI/Models/IPRestriction.html +2 -2
- data/docs/NgrokAPI/Models/IdentityProvider.html +2 -2
- data/docs/NgrokAPI/Models/Listable.html +2 -2
- data/docs/NgrokAPI/Models/Location.html +2 -2
- data/docs/NgrokAPI/Models/Ref.html +2 -2
- data/docs/NgrokAPI/Models/ReservedAddr.html +2 -2
- data/docs/NgrokAPI/Models/ReservedDomain.html +2 -2
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +2 -2
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +2 -2
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +2 -2
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +2 -2
- data/docs/NgrokAPI/Models/SSHCredential.html +2 -2
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +2 -2
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +2 -2
- data/docs/NgrokAPI/Models/Secret.html +1336 -0
- data/docs/NgrokAPI/Models/StaticBackend.html +2 -2
- data/docs/NgrokAPI/Models/StaticBackendTLS.html +2 -2
- data/docs/NgrokAPI/Models/TCPEdge.html +2 -2
- data/docs/NgrokAPI/Models/TLSCertificate.html +2 -2
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +2 -2
- data/docs/NgrokAPI/Models/TLSEdge.html +2 -2
- data/docs/NgrokAPI/Models/Tunnel.html +2 -2
- data/docs/NgrokAPI/Models/TunnelGroupBackend.html +2 -2
- data/docs/NgrokAPI/Models/TunnelSession.html +2 -2
- data/docs/NgrokAPI/Models/UserAgent.html +2 -2
- data/docs/NgrokAPI/Models/Vault.html +1353 -0
- data/docs/NgrokAPI/Models/WeightedBackend.html +2 -2
- data/docs/NgrokAPI/Models.html +4 -4
- data/docs/NgrokAPI/PagedIterator.html +2 -2
- data/docs/NgrokAPI/Services/APIKeysClient.html +2 -2
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +2 -2
- data/docs/NgrokAPI/Services/AgentIngressesClient.html +2 -2
- data/docs/NgrokAPI/Services/ApplicationSessionsClient.html +2 -2
- data/docs/NgrokAPI/Services/ApplicationUsersClient.html +2 -2
- data/docs/NgrokAPI/Services/BotUsersClient.html +2 -2
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +2 -2
- data/docs/NgrokAPI/Services/CredentialsClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteTrafficPolicyModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgesHTTPSClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgesTCPClient.html +2 -2
- data/docs/NgrokAPI/Services/EdgesTLSClient.html +2 -2
- data/docs/NgrokAPI/Services/EndpointsClient.html +1353 -139
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +2 -2
- data/docs/NgrokAPI/Services/EventSourcesClient.html +2 -2
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +2 -2
- data/docs/NgrokAPI/Services/FailoverBackendsClient.html +2 -2
- data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +2 -2
- data/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +2 -2
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +2 -2
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +2 -2
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +2 -2
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +2 -2
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +2 -2
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +2 -2
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +2 -2
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +2 -2
- data/docs/NgrokAPI/Services/SecretsClient.html +1925 -0
- data/docs/NgrokAPI/Services/StaticBackendsClient.html +2 -2
- data/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TCPEdgeTrafficPolicyModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TLSCertificatesClient.html +2 -2
- data/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TLSEdgeTrafficPolicyModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +2 -2
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +2 -2
- data/docs/NgrokAPI/Services/TunnelsClient.html +2 -2
- data/docs/NgrokAPI/Services/VaultsClient.html +1809 -0
- data/docs/NgrokAPI/Services/WeightedBackendsClient.html +2 -2
- data/docs/NgrokAPI/Services.html +5 -5
- data/docs/NgrokAPI.html +4 -4
- data/docs/_index.html +38 -2
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +21 -2
- data/docs/index.html +21 -2
- data/docs/method_list.html +1293 -637
- data/docs/top-level-namespace.html +2 -2
- data/lib/ngrokapi/client.rb +21 -0
- data/lib/ngrokapi/models/endpoint.rb +70 -1
- data/lib/ngrokapi/models/secret.rb +63 -0
- data/lib/ngrokapi/models/vault.rb +81 -0
- data/lib/ngrokapi/services/endpoints_client.rb +161 -4
- data/lib/ngrokapi/services/secrets_client.rb +246 -0
- data/lib/ngrokapi/services/vaults_client.rb +234 -0
- data/lib/ngrokapi/version.rb +1 -1
- data/spec/ngrokapi/client_spec.rb +15 -0
- data/spec/ngrokapi/models/endpoint_spec.rb +33 -0
- data/spec/ngrokapi/models/secret_spec.rb +30 -0
- data/spec/ngrokapi/models/vault_spec.rb +47 -0
- data/spec/ngrokapi/services/endpoints_client_spec.rb +155 -0
- data/spec/ngrokapi/services/secrets_client_spec.rb +198 -0
- data/spec/ngrokapi/services/vaults_client_spec.rb +186 -0
- data/spec/spec_helper.rb +117 -0
- metadata +19 -5
@@ -100,9 +100,9 @@
|
|
100
100
|
</div>
|
101
101
|
|
102
102
|
<div id="footer">
|
103
|
-
Generated on Thu
|
103
|
+
Generated on Thu Aug 14 22:44:14 2025 by
|
104
104
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
105
|
-
0.9.36 (ruby-3.3.
|
105
|
+
0.9.36 (ruby-3.3.8).
|
106
106
|
</div>
|
107
107
|
|
108
108
|
</div>
|
data/lib/ngrokapi/client.rb
CHANGED
@@ -159,6 +159,15 @@ module NgrokAPI
|
|
159
159
|
@_reserved_domains ||= NgrokAPI::Services::ReservedDomainsClient.new(client: @client)
|
160
160
|
end
|
161
161
|
|
162
|
+
##
|
163
|
+
# Secrets is an api service for securely storing and managing sensitive data such
|
164
|
+
# as secrets, credentials, and tokens.
|
165
|
+
#
|
166
|
+
# @return [NgrokAPI::Services::SecretsClient]
|
167
|
+
def secrets
|
168
|
+
@_secrets ||= NgrokAPI::Services::SecretsClient.new(client: @client)
|
169
|
+
end
|
170
|
+
|
162
171
|
##
|
163
172
|
# An SSH Certificate Authority is a pair of an SSH Certificate and its private
|
164
173
|
# key that can be used to sign other SSH host and user certificates.
|
@@ -218,6 +227,15 @@ module NgrokAPI
|
|
218
227
|
@_tunnels ||= NgrokAPI::Services::TunnelsClient.new(client: @client)
|
219
228
|
end
|
220
229
|
|
230
|
+
##
|
231
|
+
# Vaults is an api service for securely storing and managing sensitive data such
|
232
|
+
# as secrets, credentials, and tokens.
|
233
|
+
#
|
234
|
+
# @return [NgrokAPI::Services::VaultsClient]
|
235
|
+
def vaults
|
236
|
+
@_vaults ||= NgrokAPI::Services::VaultsClient.new(client: @client)
|
237
|
+
end
|
238
|
+
|
221
239
|
def backends
|
222
240
|
ns = OpenStruct.new
|
223
241
|
ns.failover = NgrokAPI::Services::FailoverBackendsClient.new(client: @client)
|
@@ -255,12 +273,15 @@ module NgrokAPI
|
|
255
273
|
ns.https_edge_route_oidc = NgrokAPI::Services::EdgeRouteOIDCModuleClient.new(client: @client)
|
256
274
|
ns.https_edge_route_websocket_tcp_converter = NgrokAPI::Services::EdgeRouteWebsocketTCPConverterModuleClient.new(client: @client)
|
257
275
|
ns.https_edge_route_user_agent_filter = NgrokAPI::Services::EdgeRouteUserAgentFilterModuleClient.new(client: @client)
|
276
|
+
ns.https_edge_route_traffic_policy = NgrokAPI::Services::EdgeRouteTrafficPolicyModuleClient.new(client: @client)
|
258
277
|
ns.tcp_edge_backend = NgrokAPI::Services::TCPEdgeBackendModuleClient.new(client: @client)
|
259
278
|
ns.tcp_edge_ip_restriction = NgrokAPI::Services::TCPEdgeIPRestrictionModuleClient.new(client: @client)
|
279
|
+
ns.tcp_edge_traffic_policy = NgrokAPI::Services::TCPEdgeTrafficPolicyModuleClient.new(client: @client)
|
260
280
|
ns.tls_edge_backend = NgrokAPI::Services::TLSEdgeBackendModuleClient.new(client: @client)
|
261
281
|
ns.tls_edge_ip_restriction = NgrokAPI::Services::TLSEdgeIPRestrictionModuleClient.new(client: @client)
|
262
282
|
ns.tls_edge_mutual_tls = NgrokAPI::Services::TLSEdgeMutualTLSModuleClient.new(client: @client)
|
263
283
|
ns.tls_edge_tls_termination = NgrokAPI::Services::TLSEdgeTLSTerminationModuleClient.new(client: @client)
|
284
|
+
ns.tls_edge_traffic_policy = NgrokAPI::Services::TLSEdgeTrafficPolicyModuleClient.new(client: @client)
|
264
285
|
|
265
286
|
ns
|
266
287
|
end
|
@@ -15,13 +15,27 @@ module NgrokAPI
|
|
15
15
|
:updated_at,
|
16
16
|
:public_url,
|
17
17
|
:proto,
|
18
|
+
:scheme,
|
18
19
|
:hostport,
|
20
|
+
:host,
|
21
|
+
:port,
|
19
22
|
:type,
|
20
23
|
:metadata,
|
24
|
+
:description,
|
21
25
|
:domain,
|
22
26
|
:tcp_addr,
|
23
27
|
:tunnel,
|
24
|
-
:edge
|
28
|
+
:edge,
|
29
|
+
:upstream_url,
|
30
|
+
:upstream_protocol,
|
31
|
+
:url,
|
32
|
+
:principal,
|
33
|
+
:traffic_policy,
|
34
|
+
:bindings,
|
35
|
+
:tunnel_session,
|
36
|
+
:uri,
|
37
|
+
:name,
|
38
|
+
:pooling_enabled
|
25
39
|
|
26
40
|
def initialize(client: nil, attrs: {})
|
27
41
|
@client = client
|
@@ -34,13 +48,29 @@ module NgrokAPI
|
|
34
48
|
@public_url = URI(@attrs['public_url'])
|
35
49
|
end
|
36
50
|
@proto = @attrs['proto']
|
51
|
+
@scheme = @attrs['scheme']
|
37
52
|
@hostport = @attrs['hostport']
|
53
|
+
@host = @attrs['host']
|
54
|
+
@port = @attrs['port']
|
38
55
|
@type = @attrs['type']
|
39
56
|
@metadata = @attrs['metadata']
|
57
|
+
@description = @attrs['description']
|
40
58
|
@domain = @attrs['domain']
|
41
59
|
@tcp_addr = @attrs['tcp_addr']
|
42
60
|
@tunnel = @attrs['tunnel']
|
43
61
|
@edge = @attrs['edge']
|
62
|
+
@upstream_url = @attrs['upstream_url']
|
63
|
+
@upstream_protocol = @attrs['upstream_protocol']
|
64
|
+
@url = @attrs['url']
|
65
|
+
@principal = @attrs['principal']
|
66
|
+
@traffic_policy = @attrs['traffic_policy']
|
67
|
+
@bindings = @attrs['bindings']
|
68
|
+
@tunnel_session = @attrs['tunnel_session']
|
69
|
+
unless @attrs['uri'].nil?
|
70
|
+
@uri = URI(@attrs['uri'])
|
71
|
+
end
|
72
|
+
@name = @attrs['name']
|
73
|
+
@pooling_enabled = @attrs['pooling_enabled']
|
44
74
|
end
|
45
75
|
|
46
76
|
def ==(other)
|
@@ -54,6 +84,45 @@ module NgrokAPI
|
|
54
84
|
def to_h
|
55
85
|
@attrs.to_h
|
56
86
|
end
|
87
|
+
|
88
|
+
##
|
89
|
+
# Update an Endpoint by ID, currently available only for cloud endpoints
|
90
|
+
#
|
91
|
+
# https://ngrok.com/docs/api#api-endpoints-update
|
92
|
+
def update(
|
93
|
+
url: nil,
|
94
|
+
traffic_policy: nil,
|
95
|
+
description: nil,
|
96
|
+
metadata: nil,
|
97
|
+
bindings: nil,
|
98
|
+
pooling_enabled: False
|
99
|
+
)
|
100
|
+
@url = url if url
|
101
|
+
@traffic_policy = traffic_policy if traffic_policy
|
102
|
+
@description = description if description
|
103
|
+
@metadata = metadata if metadata
|
104
|
+
@bindings = bindings if bindings
|
105
|
+
@pooling_enabled = pooling_enabled if pooling_enabled
|
106
|
+
@client.update(
|
107
|
+
id: @id,
|
108
|
+
url: url,
|
109
|
+
traffic_policy: traffic_policy,
|
110
|
+
description: description,
|
111
|
+
metadata: metadata,
|
112
|
+
bindings: bindings,
|
113
|
+
pooling_enabled: pooling_enabled
|
114
|
+
)
|
115
|
+
end
|
116
|
+
|
117
|
+
##
|
118
|
+
# Delete an Endpoint by ID, currently available only for cloud endpoints
|
119
|
+
#
|
120
|
+
# https://ngrok.com/docs/api#api-endpoints-delete
|
121
|
+
def delete
|
122
|
+
@client.delete(
|
123
|
+
id: @id
|
124
|
+
)
|
125
|
+
end
|
57
126
|
end
|
58
127
|
end
|
59
128
|
end
|
@@ -0,0 +1,63 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Code generated for API Clients. DO NOT EDIT.
|
4
|
+
|
5
|
+
require 'uri'
|
6
|
+
|
7
|
+
module NgrokAPI
|
8
|
+
module Models
|
9
|
+
class Secret
|
10
|
+
attr_reader :client,
|
11
|
+
:attrs,
|
12
|
+
:id,
|
13
|
+
:uri,
|
14
|
+
:created_at,
|
15
|
+
:updated_at,
|
16
|
+
:name,
|
17
|
+
:description,
|
18
|
+
:metadata,
|
19
|
+
:created_by,
|
20
|
+
:last_updated_by,
|
21
|
+
:vault
|
22
|
+
|
23
|
+
def initialize(client: nil, attrs: {})
|
24
|
+
@client = client
|
25
|
+
@attrs = attrs
|
26
|
+
@id = @attrs['id']
|
27
|
+
unless @attrs['uri'].nil?
|
28
|
+
@uri = URI(@attrs['uri'])
|
29
|
+
end
|
30
|
+
@created_at = @attrs['created_at']
|
31
|
+
@updated_at = @attrs['updated_at']
|
32
|
+
@name = @attrs['name']
|
33
|
+
@description = @attrs['description']
|
34
|
+
@metadata = @attrs['metadata']
|
35
|
+
@created_by = @attrs['created_by']
|
36
|
+
@last_updated_by = @attrs['last_updated_by']
|
37
|
+
@vault = @attrs['vault']
|
38
|
+
end
|
39
|
+
|
40
|
+
def ==(other)
|
41
|
+
@attrs == other.attrs
|
42
|
+
end
|
43
|
+
|
44
|
+
def to_s
|
45
|
+
@attrs.to_s
|
46
|
+
end
|
47
|
+
|
48
|
+
def to_h
|
49
|
+
@attrs.to_h
|
50
|
+
end
|
51
|
+
|
52
|
+
##
|
53
|
+
# Delete a Secret
|
54
|
+
#
|
55
|
+
# https://ngrok.com/docs/api#api-secrets-delete
|
56
|
+
def delete
|
57
|
+
@client.delete(
|
58
|
+
id: @id
|
59
|
+
)
|
60
|
+
end
|
61
|
+
end
|
62
|
+
end
|
63
|
+
end
|
@@ -0,0 +1,81 @@
|
|
1
|
+
# frozen_string_literal: true
|
2
|
+
|
3
|
+
# Code generated for API Clients. DO NOT EDIT.
|
4
|
+
|
5
|
+
require 'uri'
|
6
|
+
|
7
|
+
module NgrokAPI
|
8
|
+
module Models
|
9
|
+
class Vault
|
10
|
+
attr_reader :client,
|
11
|
+
:attrs,
|
12
|
+
:id,
|
13
|
+
:uri,
|
14
|
+
:created_at,
|
15
|
+
:updated_at,
|
16
|
+
:name,
|
17
|
+
:description,
|
18
|
+
:metadata,
|
19
|
+
:created_by,
|
20
|
+
:last_updated_by
|
21
|
+
|
22
|
+
def initialize(client: nil, attrs: {})
|
23
|
+
@client = client
|
24
|
+
@attrs = attrs
|
25
|
+
@id = @attrs['id']
|
26
|
+
unless @attrs['uri'].nil?
|
27
|
+
@uri = URI(@attrs['uri'])
|
28
|
+
end
|
29
|
+
@created_at = @attrs['created_at']
|
30
|
+
@updated_at = @attrs['updated_at']
|
31
|
+
@name = @attrs['name']
|
32
|
+
@description = @attrs['description']
|
33
|
+
@metadata = @attrs['metadata']
|
34
|
+
@created_by = @attrs['created_by']
|
35
|
+
@last_updated_by = @attrs['last_updated_by']
|
36
|
+
end
|
37
|
+
|
38
|
+
def ==(other)
|
39
|
+
@attrs == other.attrs
|
40
|
+
end
|
41
|
+
|
42
|
+
def to_s
|
43
|
+
@attrs.to_s
|
44
|
+
end
|
45
|
+
|
46
|
+
def to_h
|
47
|
+
@attrs.to_h
|
48
|
+
end
|
49
|
+
|
50
|
+
##
|
51
|
+
# Update an existing Vault by ID
|
52
|
+
#
|
53
|
+
# https://ngrok.com/docs/api#api-vaults-update
|
54
|
+
def update(
|
55
|
+
name: nil,
|
56
|
+
metadata: nil,
|
57
|
+
description: nil
|
58
|
+
)
|
59
|
+
@name = name if name
|
60
|
+
@metadata = metadata if metadata
|
61
|
+
@description = description if description
|
62
|
+
@client.update(
|
63
|
+
id: @id,
|
64
|
+
name: name,
|
65
|
+
metadata: metadata,
|
66
|
+
description: description
|
67
|
+
)
|
68
|
+
end
|
69
|
+
|
70
|
+
##
|
71
|
+
# Delete a Vault
|
72
|
+
#
|
73
|
+
# https://ngrok.com/docs/api#api-vaults-delete
|
74
|
+
def delete
|
75
|
+
@client.delete(
|
76
|
+
id: @id
|
77
|
+
)
|
78
|
+
end
|
79
|
+
end
|
80
|
+
end
|
81
|
+
end
|
@@ -11,10 +11,10 @@ module NgrokAPI
|
|
11
11
|
#
|
12
12
|
# https://ngrok.com/docs/api#api-endpoints
|
13
13
|
class EndpointsClient
|
14
|
-
# The List Property from the resulting API for list calls
|
15
|
-
LIST_PROPERTY = 'endpoints'
|
16
14
|
# The API path for the requests
|
17
15
|
PATH = '/endpoints'
|
16
|
+
# The List Property from the resulting API for list calls
|
17
|
+
LIST_PROPERTY = 'endpoints'
|
18
18
|
|
19
19
|
attr_reader :client
|
20
20
|
|
@@ -22,19 +22,82 @@ module NgrokAPI
|
|
22
22
|
@client = client
|
23
23
|
end
|
24
24
|
|
25
|
+
##
|
26
|
+
# Create an endpoint, currently available only for cloud endpoints
|
27
|
+
#
|
28
|
+
# @param [string] url the url of the endpoint
|
29
|
+
# @param [string] type Type of endpoint. Only 'cloud' is currently supported (represents a cloud endpoint). Defaults to 'cloud' if not specified.
|
30
|
+
# @param [string] traffic_policy The traffic policy attached to this endpoint
|
31
|
+
# @param [string] description user-supplied description of the associated tunnel
|
32
|
+
# @param [string] metadata user-supplied metadata of the associated tunnel or edge object
|
33
|
+
# @param [List<string>] bindings the bindings associated with this endpoint
|
34
|
+
# @param [boolean] pooling_enabled
|
35
|
+
# @return [NgrokAPI::Models::Endpoint] result from the API request
|
36
|
+
#
|
37
|
+
# https://ngrok.com/docs/api#api-endpoints-create
|
38
|
+
def create(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: False)
|
39
|
+
path = '/endpoints'
|
40
|
+
replacements = {
|
41
|
+
}
|
42
|
+
data = {}
|
43
|
+
data[:url] = url if url
|
44
|
+
data[:type] = type if type
|
45
|
+
data[:traffic_policy] = traffic_policy if traffic_policy
|
46
|
+
data[:description] = description if description
|
47
|
+
data[:metadata] = metadata if metadata
|
48
|
+
data[:bindings] = bindings if bindings
|
49
|
+
data[:pooling_enabled] = pooling_enabled if pooling_enabled
|
50
|
+
result = @client.post(path % replacements, data: data)
|
51
|
+
NgrokAPI::Models::Endpoint.new(client: self, attrs: result)
|
52
|
+
end
|
53
|
+
|
54
|
+
##
|
55
|
+
# Create an endpoint, currently available only for cloud endpoints
|
56
|
+
# Throws an exception if API error.
|
57
|
+
#
|
58
|
+
# @param [string] url the url of the endpoint
|
59
|
+
# @param [string] type Type of endpoint. Only 'cloud' is currently supported (represents a cloud endpoint). Defaults to 'cloud' if not specified.
|
60
|
+
# @param [string] traffic_policy The traffic policy attached to this endpoint
|
61
|
+
# @param [string] description user-supplied description of the associated tunnel
|
62
|
+
# @param [string] metadata user-supplied metadata of the associated tunnel or edge object
|
63
|
+
# @param [List<string>] bindings the bindings associated with this endpoint
|
64
|
+
# @param [boolean] pooling_enabled
|
65
|
+
# @return [NgrokAPI::Models::Endpoint] result from the API request
|
66
|
+
#
|
67
|
+
# https://ngrok.com/docs/api#api-endpoints-create
|
68
|
+
def create!(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: False)
|
69
|
+
path = '/endpoints'
|
70
|
+
replacements = {
|
71
|
+
}
|
72
|
+
data = {}
|
73
|
+
data[:url] = url if url
|
74
|
+
data[:type] = type if type
|
75
|
+
data[:traffic_policy] = traffic_policy if traffic_policy
|
76
|
+
data[:description] = description if description
|
77
|
+
data[:metadata] = metadata if metadata
|
78
|
+
data[:bindings] = bindings if bindings
|
79
|
+
data[:pooling_enabled] = pooling_enabled if pooling_enabled
|
80
|
+
result = @client.post(path % replacements, data: data, danger: true)
|
81
|
+
NgrokAPI::Models::Endpoint.new(client: self, attrs: result)
|
82
|
+
end
|
83
|
+
|
25
84
|
##
|
26
85
|
# List all active endpoints on the account
|
27
86
|
#
|
28
87
|
# @param [string] before_id
|
29
88
|
# @param [string] limit
|
89
|
+
# @param [List<string>] ids
|
90
|
+
# @param [List<string>] urls
|
30
91
|
# @param [string] url optional and mutually exclusive from before_id and limit
|
31
92
|
# @return [NgrokAPI::Models::Listable] result from the API request
|
32
93
|
#
|
33
94
|
# https://ngrok.com/docs/api#api-endpoints-list
|
34
|
-
def list(before_id: nil, limit: nil, url: nil)
|
95
|
+
def list(before_id: nil, limit: nil, ids: [], urls: [], url: nil)
|
35
96
|
result = @client.list(
|
36
97
|
before_id: before_id,
|
37
98
|
limit: limit,
|
99
|
+
ids: ids,
|
100
|
+
urls: urls,
|
38
101
|
url: url,
|
39
102
|
path: PATH
|
40
103
|
)
|
@@ -53,14 +116,18 @@ module NgrokAPI
|
|
53
116
|
#
|
54
117
|
# @param [string] before_id
|
55
118
|
# @param [string] limit
|
119
|
+
# @param [List<string>] ids
|
120
|
+
# @param [List<string>] urls
|
56
121
|
# @param [string] url optional and mutually exclusive from before_id and limit
|
57
122
|
# @return [NgrokAPI::Models::Listable] result from the API request
|
58
123
|
#
|
59
124
|
# https://ngrok.com/docs/api#api-endpoints-list
|
60
|
-
def list!(before_id: nil, limit: nil, url: nil)
|
125
|
+
def list!(before_id: nil, limit: nil, ids: [], urls: [], url: nil)
|
61
126
|
result = @client.list(
|
62
127
|
before_id: before_id,
|
63
128
|
limit: limit,
|
129
|
+
ids: ids,
|
130
|
+
urls: urls,
|
64
131
|
danger: true,
|
65
132
|
url: url,
|
66
133
|
path: PATH
|
@@ -109,6 +176,96 @@ module NgrokAPI
|
|
109
176
|
result = @client.get(path % replacements, data: data, danger: true)
|
110
177
|
NgrokAPI::Models::Endpoint.new(client: self, attrs: result)
|
111
178
|
end
|
179
|
+
|
180
|
+
##
|
181
|
+
# Update an Endpoint by ID, currently available only for cloud endpoints
|
182
|
+
#
|
183
|
+
# @param [string] id unique endpoint resource identifier
|
184
|
+
# @param [string] url the url of the endpoint
|
185
|
+
# @param [string] traffic_policy The traffic policy attached to this endpoint
|
186
|
+
# @param [string] description user-supplied description of the associated tunnel
|
187
|
+
# @param [string] metadata user-supplied metadata of the associated tunnel or edge object
|
188
|
+
# @param [List<string>] bindings the bindings associated with this endpoint
|
189
|
+
# @param [boolean] pooling_enabled
|
190
|
+
# @return [NgrokAPI::Models::Endpoint] result from the API request
|
191
|
+
#
|
192
|
+
# https://ngrok.com/docs/api#api-endpoints-update
|
193
|
+
def update(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False)
|
194
|
+
path = '/endpoints/%{id}'
|
195
|
+
replacements = {
|
196
|
+
id: id,
|
197
|
+
}
|
198
|
+
data = {}
|
199
|
+
data[:url] = url if url
|
200
|
+
data[:traffic_policy] = traffic_policy if traffic_policy
|
201
|
+
data[:description] = description if description
|
202
|
+
data[:metadata] = metadata if metadata
|
203
|
+
data[:bindings] = bindings if bindings
|
204
|
+
data[:pooling_enabled] = pooling_enabled if pooling_enabled
|
205
|
+
result = @client.patch(path % replacements, data: data)
|
206
|
+
NgrokAPI::Models::Endpoint.new(client: self, attrs: result)
|
207
|
+
end
|
208
|
+
|
209
|
+
##
|
210
|
+
# Update an Endpoint by ID, currently available only for cloud endpoints
|
211
|
+
# Throws an exception if API error.
|
212
|
+
#
|
213
|
+
# @param [string] id unique endpoint resource identifier
|
214
|
+
# @param [string] url the url of the endpoint
|
215
|
+
# @param [string] traffic_policy The traffic policy attached to this endpoint
|
216
|
+
# @param [string] description user-supplied description of the associated tunnel
|
217
|
+
# @param [string] metadata user-supplied metadata of the associated tunnel or edge object
|
218
|
+
# @param [List<string>] bindings the bindings associated with this endpoint
|
219
|
+
# @param [boolean] pooling_enabled
|
220
|
+
# @return [NgrokAPI::Models::Endpoint] result from the API request
|
221
|
+
#
|
222
|
+
# https://ngrok.com/docs/api#api-endpoints-update
|
223
|
+
def update!(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False)
|
224
|
+
path = '/endpoints/%{id}'
|
225
|
+
replacements = {
|
226
|
+
id: id,
|
227
|
+
}
|
228
|
+
data = {}
|
229
|
+
data[:url] = url if url
|
230
|
+
data[:traffic_policy] = traffic_policy if traffic_policy
|
231
|
+
data[:description] = description if description
|
232
|
+
data[:metadata] = metadata if metadata
|
233
|
+
data[:bindings] = bindings if bindings
|
234
|
+
data[:pooling_enabled] = pooling_enabled if pooling_enabled
|
235
|
+
result = @client.patch(path % replacements, data: data, danger: true)
|
236
|
+
NgrokAPI::Models::Endpoint.new(client: self, attrs: result)
|
237
|
+
end
|
238
|
+
|
239
|
+
##
|
240
|
+
# Delete an Endpoint by ID, currently available only for cloud endpoints
|
241
|
+
#
|
242
|
+
# @param [string] id a resource identifier
|
243
|
+
# @return [NgrokAPI::Models::Empty] result from the API request
|
244
|
+
#
|
245
|
+
# https://ngrok.com/docs/api#api-endpoints-delete
|
246
|
+
def delete(id: "")
|
247
|
+
path = '/endpoints/%{id}'
|
248
|
+
replacements = {
|
249
|
+
id: id,
|
250
|
+
}
|
251
|
+
@client.delete(path % replacements)
|
252
|
+
end
|
253
|
+
|
254
|
+
##
|
255
|
+
# Delete an Endpoint by ID, currently available only for cloud endpoints
|
256
|
+
# Throws an exception if API error.
|
257
|
+
#
|
258
|
+
# @param [string] id a resource identifier
|
259
|
+
# @return [NgrokAPI::Models::Empty] result from the API request
|
260
|
+
#
|
261
|
+
# https://ngrok.com/docs/api#api-endpoints-delete
|
262
|
+
def delete!(id: "")
|
263
|
+
path = '/endpoints/%{id}'
|
264
|
+
replacements = {
|
265
|
+
id: id,
|
266
|
+
}
|
267
|
+
@client.delete(path % replacements, danger: true)
|
268
|
+
end
|
112
269
|
end
|
113
270
|
end
|
114
271
|
end
|