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
@@ -121,11 +121,11 @@
|
|
121
121
|
|
122
122
|
<dl class="constants">
|
123
123
|
|
124
|
-
<dt id="
|
124
|
+
<dt id="PATH-constant" class="">PATH =
|
125
125
|
<div class="docstring">
|
126
126
|
<div class="discussion">
|
127
127
|
|
128
|
-
<p>The
|
128
|
+
<p>The API path for the requests</p>
|
129
129
|
|
130
130
|
|
131
131
|
</div>
|
@@ -135,13 +135,13 @@
|
|
135
135
|
|
136
136
|
</div>
|
137
137
|
</dt>
|
138
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'
|
138
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/endpoints</span><span class='tstring_end'>'</span></span></pre></dd>
|
139
139
|
|
140
|
-
<dt id="
|
140
|
+
<dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
|
141
141
|
<div class="docstring">
|
142
142
|
<div class="discussion">
|
143
143
|
|
144
|
-
<p>The
|
144
|
+
<p>The List Property from the resulting API for list calls</p>
|
145
145
|
|
146
146
|
|
147
147
|
</div>
|
@@ -151,7 +151,7 @@
|
|
151
151
|
|
152
152
|
</div>
|
153
153
|
</dt>
|
154
|
-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'
|
154
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>endpoints</span><span class='tstring_end'>'</span></span></pre></dd>
|
155
155
|
|
156
156
|
</dl>
|
157
157
|
|
@@ -207,6 +207,102 @@
|
|
207
207
|
<li class="public ">
|
208
208
|
<span class="summary_signature">
|
209
209
|
|
210
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ NgrokAPI::Models::Endpoint </a>
|
211
|
+
|
212
|
+
|
213
|
+
|
214
|
+
</span>
|
215
|
+
|
216
|
+
|
217
|
+
|
218
|
+
|
219
|
+
|
220
|
+
|
221
|
+
|
222
|
+
|
223
|
+
|
224
|
+
<span class="summary_desc"><div class='inline'>
|
225
|
+
<p>Create an endpoint, currently available only for cloud endpoints.</p>
|
226
|
+
</div></span>
|
227
|
+
|
228
|
+
</li>
|
229
|
+
|
230
|
+
|
231
|
+
<li class="public ">
|
232
|
+
<span class="summary_signature">
|
233
|
+
|
234
|
+
<a href="#create!-instance_method" title="#create! (instance method)">#<strong>create!</strong>(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ NgrokAPI::Models::Endpoint </a>
|
235
|
+
|
236
|
+
|
237
|
+
|
238
|
+
</span>
|
239
|
+
|
240
|
+
|
241
|
+
|
242
|
+
|
243
|
+
|
244
|
+
|
245
|
+
|
246
|
+
|
247
|
+
|
248
|
+
<span class="summary_desc"><div class='inline'>
|
249
|
+
<p>Create an endpoint, currently available only for cloud endpoints Throws an exception if API error.</p>
|
250
|
+
</div></span>
|
251
|
+
|
252
|
+
</li>
|
253
|
+
|
254
|
+
|
255
|
+
<li class="public ">
|
256
|
+
<span class="summary_signature">
|
257
|
+
|
258
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
259
|
+
|
260
|
+
|
261
|
+
|
262
|
+
</span>
|
263
|
+
|
264
|
+
|
265
|
+
|
266
|
+
|
267
|
+
|
268
|
+
|
269
|
+
|
270
|
+
|
271
|
+
|
272
|
+
<span class="summary_desc"><div class='inline'>
|
273
|
+
<p>Delete an Endpoint by ID, currently available only for cloud endpoints.</p>
|
274
|
+
</div></span>
|
275
|
+
|
276
|
+
</li>
|
277
|
+
|
278
|
+
|
279
|
+
<li class="public ">
|
280
|
+
<span class="summary_signature">
|
281
|
+
|
282
|
+
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
283
|
+
|
284
|
+
|
285
|
+
|
286
|
+
</span>
|
287
|
+
|
288
|
+
|
289
|
+
|
290
|
+
|
291
|
+
|
292
|
+
|
293
|
+
|
294
|
+
|
295
|
+
|
296
|
+
<span class="summary_desc"><div class='inline'>
|
297
|
+
<p>Delete an Endpoint by ID, currently available only for cloud endpoints Throws an exception if API error.</p>
|
298
|
+
</div></span>
|
299
|
+
|
300
|
+
</li>
|
301
|
+
|
302
|
+
|
303
|
+
<li class="public ">
|
304
|
+
<span class="summary_signature">
|
305
|
+
|
210
306
|
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: "") ⇒ NgrokAPI::Models::Endpoint </a>
|
211
307
|
|
212
308
|
|
@@ -281,7 +377,7 @@
|
|
281
377
|
<li class="public ">
|
282
378
|
<span class="summary_signature">
|
283
379
|
|
284
|
-
<a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
380
|
+
<a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, ids: [], urls: [], url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
285
381
|
|
286
382
|
|
287
383
|
|
@@ -305,7 +401,7 @@
|
|
305
401
|
<li class="public ">
|
306
402
|
<span class="summary_signature">
|
307
403
|
|
308
|
-
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
404
|
+
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, ids: [], urls: [], url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
309
405
|
|
310
406
|
|
311
407
|
|
@@ -323,6 +419,54 @@
|
|
323
419
|
<p>List all active endpoints on the account Throws an exception if API error.</p>
|
324
420
|
</div></span>
|
325
421
|
|
422
|
+
</li>
|
423
|
+
|
424
|
+
|
425
|
+
<li class="public ">
|
426
|
+
<span class="summary_signature">
|
427
|
+
|
428
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ NgrokAPI::Models::Endpoint </a>
|
429
|
+
|
430
|
+
|
431
|
+
|
432
|
+
</span>
|
433
|
+
|
434
|
+
|
435
|
+
|
436
|
+
|
437
|
+
|
438
|
+
|
439
|
+
|
440
|
+
|
441
|
+
|
442
|
+
<span class="summary_desc"><div class='inline'>
|
443
|
+
<p>Update an Endpoint by ID, currently available only for cloud endpoints.</p>
|
444
|
+
</div></span>
|
445
|
+
|
446
|
+
</li>
|
447
|
+
|
448
|
+
|
449
|
+
<li class="public ">
|
450
|
+
<span class="summary_signature">
|
451
|
+
|
452
|
+
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ NgrokAPI::Models::Endpoint </a>
|
453
|
+
|
454
|
+
|
455
|
+
|
456
|
+
</span>
|
457
|
+
|
458
|
+
|
459
|
+
|
460
|
+
|
461
|
+
|
462
|
+
|
463
|
+
|
464
|
+
|
465
|
+
|
466
|
+
<span class="summary_desc"><div class='inline'>
|
467
|
+
<p>Update an Endpoint by ID, currently available only for cloud endpoints Throws an exception if API error.</p>
|
468
|
+
</div></span>
|
469
|
+
|
326
470
|
</li>
|
327
471
|
|
328
472
|
|
@@ -429,9 +573,9 @@
|
|
429
573
|
|
430
574
|
|
431
575
|
<div class="method_details first">
|
432
|
-
<h3 class="signature first" id="
|
576
|
+
<h3 class="signature first" id="create-instance_method">
|
433
577
|
|
434
|
-
#<strong>
|
578
|
+
#<strong>create</strong>(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ <tt><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">NgrokAPI::Models::Endpoint</a></span></tt>
|
435
579
|
|
436
580
|
|
437
581
|
|
@@ -440,9 +584,9 @@
|
|
440
584
|
</h3><div class="docstring">
|
441
585
|
<div class="discussion">
|
442
586
|
|
443
|
-
<p>
|
587
|
+
<p>Create an endpoint, currently available only for cloud endpoints</p>
|
444
588
|
|
445
|
-
<p><a href="https://ngrok.com/docs/api#api-endpoints-
|
589
|
+
<p><a href="https://ngrok.com/docs/api#api-endpoints-create">ngrok.com/docs/api#api-endpoints-create</a></p>
|
446
590
|
|
447
591
|
|
448
592
|
</div>
|
@@ -453,22 +597,119 @@
|
|
453
597
|
|
454
598
|
<li>
|
455
599
|
|
456
|
-
<span class='name'>
|
600
|
+
<span class='name'>url</span>
|
457
601
|
|
458
602
|
|
459
603
|
<span class='type'>(<tt>string</tt>)</span>
|
460
604
|
|
461
605
|
|
462
|
-
|
606
|
+
|
607
|
+
—
|
608
|
+
<div class='inline'>
|
609
|
+
<p>the url of the endpoint</p>
|
610
|
+
</div>
|
611
|
+
|
612
|
+
</li>
|
613
|
+
|
614
|
+
<li>
|
615
|
+
|
616
|
+
<span class='name'>type</span>
|
617
|
+
|
618
|
+
|
619
|
+
<span class='type'>(<tt>string</tt>)</span>
|
620
|
+
|
463
621
|
|
464
622
|
|
465
623
|
—
|
466
624
|
<div class='inline'>
|
467
|
-
<p>a
|
625
|
+
<p>Type of endpoint. Only ‘cloud’ is currently supported (represents a cloud endpoint). Defaults to ‘cloud’ if not specified.</p>
|
626
|
+
</div>
|
627
|
+
|
628
|
+
</li>
|
629
|
+
|
630
|
+
<li>
|
631
|
+
|
632
|
+
<span class='name'>traffic_policy</span>
|
633
|
+
|
634
|
+
|
635
|
+
<span class='type'>(<tt>string</tt>)</span>
|
636
|
+
|
637
|
+
|
638
|
+
|
639
|
+
—
|
640
|
+
<div class='inline'>
|
641
|
+
<p>The traffic policy attached to this endpoint</p>
|
642
|
+
</div>
|
643
|
+
|
644
|
+
</li>
|
645
|
+
|
646
|
+
<li>
|
647
|
+
|
648
|
+
<span class='name'>description</span>
|
649
|
+
|
650
|
+
|
651
|
+
<span class='type'>(<tt>string</tt>)</span>
|
652
|
+
|
653
|
+
|
654
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
655
|
+
|
656
|
+
|
657
|
+
—
|
658
|
+
<div class='inline'>
|
659
|
+
<p>user-supplied description of the associated tunnel</p>
|
660
|
+
</div>
|
661
|
+
|
662
|
+
</li>
|
663
|
+
|
664
|
+
<li>
|
665
|
+
|
666
|
+
<span class='name'>metadata</span>
|
667
|
+
|
668
|
+
|
669
|
+
<span class='type'>(<tt>string</tt>)</span>
|
670
|
+
|
671
|
+
|
672
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
673
|
+
|
674
|
+
|
675
|
+
—
|
676
|
+
<div class='inline'>
|
677
|
+
<p>user-supplied metadata of the associated tunnel or edge object</p>
|
678
|
+
</div>
|
679
|
+
|
680
|
+
</li>
|
681
|
+
|
682
|
+
<li>
|
683
|
+
|
684
|
+
<span class='name'>bindings</span>
|
685
|
+
|
686
|
+
|
687
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
688
|
+
|
689
|
+
|
690
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
691
|
+
|
692
|
+
|
693
|
+
—
|
694
|
+
<div class='inline'>
|
695
|
+
<p>the bindings associated with this endpoint</p>
|
468
696
|
</div>
|
469
697
|
|
470
698
|
</li>
|
471
699
|
|
700
|
+
<li>
|
701
|
+
|
702
|
+
<span class='name'>pooling_enabled</span>
|
703
|
+
|
704
|
+
|
705
|
+
<span class='type'>(<tt>boolean</tt>)</span>
|
706
|
+
|
707
|
+
|
708
|
+
<em class="default">(defaults to: <tt>False</tt>)</em>
|
709
|
+
|
710
|
+
|
711
|
+
</li>
|
712
|
+
|
472
713
|
</ul>
|
473
714
|
|
474
715
|
<p class="tag_title">Returns:</p>
|
@@ -496,26 +737,38 @@
|
|
496
737
|
<pre class="lines">
|
497
738
|
|
498
739
|
|
499
|
-
|
500
|
-
|
501
|
-
|
502
|
-
|
503
|
-
|
504
|
-
|
505
|
-
|
506
|
-
|
507
|
-
|
740
|
+
38
|
741
|
+
39
|
742
|
+
40
|
743
|
+
41
|
744
|
+
42
|
745
|
+
43
|
746
|
+
44
|
747
|
+
45
|
748
|
+
46
|
749
|
+
47
|
750
|
+
48
|
751
|
+
49
|
752
|
+
50
|
753
|
+
51
|
754
|
+
52</pre>
|
508
755
|
</td>
|
509
756
|
<td>
|
510
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line
|
757
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 38</span>
|
511
758
|
|
512
|
-
<span class='kw'>def</span> <span class='id identifier
|
513
|
-
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/endpoints
|
759
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>url:</span><span class='comma'>,</span> <span class='label'>type:</span><span class='comma'>,</span> <span class='label'>traffic_policy:</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>bindings:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>pooling_enabled:</span> <span class='const'>False</span><span class='rparen'>)</span>
|
760
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/endpoints</span><span class='tstring_end'>'</span></span>
|
514
761
|
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
515
|
-
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
516
762
|
<span class='rbrace'>}</span>
|
517
763
|
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
518
|
-
<span class='id identifier
|
764
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:url</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_url'>url</span> <span class='kw'>if</span> <span class='id identifier rubyid_url'>url</span>
|
765
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_type'>type</span> <span class='kw'>if</span> <span class='id identifier rubyid_type'>type</span>
|
766
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:traffic_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_traffic_policy'>traffic_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_traffic_policy'>traffic_policy</span>
|
767
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
768
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
769
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:bindings</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_bindings'>bindings</span> <span class='kw'>if</span> <span class='id identifier rubyid_bindings'>bindings</span>
|
770
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:pooling_enabled</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_pooling_enabled'>pooling_enabled</span> <span class='kw'>if</span> <span class='id identifier rubyid_pooling_enabled'>pooling_enabled</span>
|
771
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
519
772
|
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">Endpoint</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Endpoint.html#initialize-instance_method" title="NgrokAPI::Models::Endpoint#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
520
773
|
<span class='kw'>end</span></pre>
|
521
774
|
</td>
|
@@ -524,9 +777,9 @@
|
|
524
777
|
</div>
|
525
778
|
|
526
779
|
<div class="method_details ">
|
527
|
-
<h3 class="signature " id="
|
780
|
+
<h3 class="signature " id="create!-instance_method">
|
528
781
|
|
529
|
-
#<strong>
|
782
|
+
#<strong>create!</strong>(url:, type:, traffic_policy:, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ <tt><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">NgrokAPI::Models::Endpoint</a></span></tt>
|
530
783
|
|
531
784
|
|
532
785
|
|
@@ -535,9 +788,9 @@
|
|
535
788
|
</h3><div class="docstring">
|
536
789
|
<div class="discussion">
|
537
790
|
|
538
|
-
<p>
|
791
|
+
<p>Create an endpoint, currently available only for cloud endpoints Throws an exception if API error.</p>
|
539
792
|
|
540
|
-
<p><a href="https://ngrok.com/docs/api#api-endpoints-
|
793
|
+
<p><a href="https://ngrok.com/docs/api#api-endpoints-create">ngrok.com/docs/api#api-endpoints-create</a></p>
|
541
794
|
|
542
795
|
|
543
796
|
</div>
|
@@ -548,18 +801,809 @@
|
|
548
801
|
|
549
802
|
<li>
|
550
803
|
|
551
|
-
<span class='name'>
|
804
|
+
<span class='name'>url</span>
|
552
805
|
|
553
806
|
|
554
807
|
<span class='type'>(<tt>string</tt>)</span>
|
555
808
|
|
556
809
|
|
557
|
-
|
810
|
+
|
811
|
+
—
|
812
|
+
<div class='inline'>
|
813
|
+
<p>the url of the endpoint</p>
|
814
|
+
</div>
|
815
|
+
|
816
|
+
</li>
|
817
|
+
|
818
|
+
<li>
|
819
|
+
|
820
|
+
<span class='name'>type</span>
|
821
|
+
|
822
|
+
|
823
|
+
<span class='type'>(<tt>string</tt>)</span>
|
824
|
+
|
825
|
+
|
826
|
+
|
827
|
+
—
|
828
|
+
<div class='inline'>
|
829
|
+
<p>Type of endpoint. Only ‘cloud’ is currently supported (represents a cloud endpoint). Defaults to ‘cloud’ if not specified.</p>
|
830
|
+
</div>
|
831
|
+
|
832
|
+
</li>
|
833
|
+
|
834
|
+
<li>
|
835
|
+
|
836
|
+
<span class='name'>traffic_policy</span>
|
837
|
+
|
838
|
+
|
839
|
+
<span class='type'>(<tt>string</tt>)</span>
|
840
|
+
|
841
|
+
|
842
|
+
|
843
|
+
—
|
844
|
+
<div class='inline'>
|
845
|
+
<p>The traffic policy attached to this endpoint</p>
|
846
|
+
</div>
|
847
|
+
|
848
|
+
</li>
|
849
|
+
|
850
|
+
<li>
|
851
|
+
|
852
|
+
<span class='name'>description</span>
|
853
|
+
|
854
|
+
|
855
|
+
<span class='type'>(<tt>string</tt>)</span>
|
856
|
+
|
857
|
+
|
858
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
859
|
+
|
860
|
+
|
861
|
+
—
|
862
|
+
<div class='inline'>
|
863
|
+
<p>user-supplied description of the associated tunnel</p>
|
864
|
+
</div>
|
865
|
+
|
866
|
+
</li>
|
867
|
+
|
868
|
+
<li>
|
869
|
+
|
870
|
+
<span class='name'>metadata</span>
|
871
|
+
|
872
|
+
|
873
|
+
<span class='type'>(<tt>string</tt>)</span>
|
874
|
+
|
875
|
+
|
876
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
877
|
+
|
878
|
+
|
879
|
+
—
|
880
|
+
<div class='inline'>
|
881
|
+
<p>user-supplied metadata of the associated tunnel or edge object</p>
|
882
|
+
</div>
|
883
|
+
|
884
|
+
</li>
|
885
|
+
|
886
|
+
<li>
|
887
|
+
|
888
|
+
<span class='name'>bindings</span>
|
889
|
+
|
890
|
+
|
891
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
892
|
+
|
893
|
+
|
894
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
895
|
+
|
896
|
+
|
897
|
+
—
|
898
|
+
<div class='inline'>
|
899
|
+
<p>the bindings associated with this endpoint</p>
|
900
|
+
</div>
|
901
|
+
|
902
|
+
</li>
|
903
|
+
|
904
|
+
<li>
|
905
|
+
|
906
|
+
<span class='name'>pooling_enabled</span>
|
907
|
+
|
908
|
+
|
909
|
+
<span class='type'>(<tt>boolean</tt>)</span>
|
910
|
+
|
911
|
+
|
912
|
+
<em class="default">(defaults to: <tt>False</tt>)</em>
|
913
|
+
|
914
|
+
|
915
|
+
</li>
|
916
|
+
|
917
|
+
</ul>
|
918
|
+
|
919
|
+
<p class="tag_title">Returns:</p>
|
920
|
+
<ul class="return">
|
921
|
+
|
922
|
+
<li>
|
923
|
+
|
924
|
+
|
925
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">NgrokAPI::Models::Endpoint</a></span></tt>)</span>
|
926
|
+
|
927
|
+
|
928
|
+
|
929
|
+
—
|
930
|
+
<div class='inline'>
|
931
|
+
<p>result from the API request</p>
|
932
|
+
</div>
|
933
|
+
|
934
|
+
</li>
|
935
|
+
|
936
|
+
</ul>
|
937
|
+
|
938
|
+
</div><table class="source_code">
|
939
|
+
<tr>
|
940
|
+
<td>
|
941
|
+
<pre class="lines">
|
942
|
+
|
943
|
+
|
944
|
+
68
|
945
|
+
69
|
946
|
+
70
|
947
|
+
71
|
948
|
+
72
|
949
|
+
73
|
950
|
+
74
|
951
|
+
75
|
952
|
+
76
|
953
|
+
77
|
954
|
+
78
|
955
|
+
79
|
956
|
+
80
|
957
|
+
81
|
958
|
+
82</pre>
|
959
|
+
</td>
|
960
|
+
<td>
|
961
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 68</span>
|
962
|
+
|
963
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span><span class='label'>url:</span><span class='comma'>,</span> <span class='label'>type:</span><span class='comma'>,</span> <span class='label'>traffic_policy:</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>bindings:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>pooling_enabled:</span> <span class='const'>False</span><span class='rparen'>)</span>
|
964
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/endpoints</span><span class='tstring_end'>'</span></span>
|
965
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
966
|
+
<span class='rbrace'>}</span>
|
967
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
968
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:url</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_url'>url</span> <span class='kw'>if</span> <span class='id identifier rubyid_url'>url</span>
|
969
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:type</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_type'>type</span> <span class='kw'>if</span> <span class='id identifier rubyid_type'>type</span>
|
970
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:traffic_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_traffic_policy'>traffic_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_traffic_policy'>traffic_policy</span>
|
971
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
972
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
973
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:bindings</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_bindings'>bindings</span> <span class='kw'>if</span> <span class='id identifier rubyid_bindings'>bindings</span>
|
974
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:pooling_enabled</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_pooling_enabled'>pooling_enabled</span> <span class='kw'>if</span> <span class='id identifier rubyid_pooling_enabled'>pooling_enabled</span>
|
975
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
976
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">Endpoint</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Endpoint.html#initialize-instance_method" title="NgrokAPI::Models::Endpoint#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
977
|
+
<span class='kw'>end</span></pre>
|
978
|
+
</td>
|
979
|
+
</tr>
|
980
|
+
</table>
|
981
|
+
</div>
|
982
|
+
|
983
|
+
<div class="method_details ">
|
984
|
+
<h3 class="signature " id="delete-instance_method">
|
985
|
+
|
986
|
+
#<strong>delete</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
987
|
+
|
988
|
+
|
989
|
+
|
990
|
+
|
991
|
+
|
992
|
+
</h3><div class="docstring">
|
993
|
+
<div class="discussion">
|
994
|
+
|
995
|
+
<p>Delete an Endpoint by ID, currently available only for cloud endpoints</p>
|
996
|
+
|
997
|
+
<p><a href="https://ngrok.com/docs/api#api-endpoints-delete">ngrok.com/docs/api#api-endpoints-delete</a></p>
|
998
|
+
|
999
|
+
|
1000
|
+
</div>
|
1001
|
+
</div>
|
1002
|
+
<div class="tags">
|
1003
|
+
<p class="tag_title">Parameters:</p>
|
1004
|
+
<ul class="param">
|
1005
|
+
|
1006
|
+
<li>
|
1007
|
+
|
1008
|
+
<span class='name'>id</span>
|
1009
|
+
|
1010
|
+
|
1011
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1012
|
+
|
1013
|
+
|
1014
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1015
|
+
|
1016
|
+
|
1017
|
+
—
|
1018
|
+
<div class='inline'>
|
1019
|
+
<p>a resource identifier</p>
|
1020
|
+
</div>
|
1021
|
+
|
1022
|
+
</li>
|
1023
|
+
|
1024
|
+
</ul>
|
1025
|
+
|
1026
|
+
<p class="tag_title">Returns:</p>
|
1027
|
+
<ul class="return">
|
1028
|
+
|
1029
|
+
<li>
|
1030
|
+
|
1031
|
+
|
1032
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
1033
|
+
|
1034
|
+
|
1035
|
+
|
1036
|
+
—
|
1037
|
+
<div class='inline'>
|
1038
|
+
<p>result from the API request</p>
|
1039
|
+
</div>
|
1040
|
+
|
1041
|
+
</li>
|
1042
|
+
|
1043
|
+
</ul>
|
1044
|
+
|
1045
|
+
</div><table class="source_code">
|
1046
|
+
<tr>
|
1047
|
+
<td>
|
1048
|
+
<pre class="lines">
|
1049
|
+
|
1050
|
+
|
1051
|
+
246
|
1052
|
+
247
|
1053
|
+
248
|
1054
|
+
249
|
1055
|
+
250
|
1056
|
+
251
|
1057
|
+
252</pre>
|
1058
|
+
</td>
|
1059
|
+
<td>
|
1060
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 246</span>
|
1061
|
+
|
1062
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
1063
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/endpoints/%{id}</span><span class='tstring_end'>'</span></span>
|
1064
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1065
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1066
|
+
<span class='rbrace'>}</span>
|
1067
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='rparen'>)</span>
|
1068
|
+
<span class='kw'>end</span></pre>
|
1069
|
+
</td>
|
1070
|
+
</tr>
|
1071
|
+
</table>
|
1072
|
+
</div>
|
1073
|
+
|
1074
|
+
<div class="method_details ">
|
1075
|
+
<h3 class="signature " id="delete!-instance_method">
|
1076
|
+
|
1077
|
+
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
1078
|
+
|
1079
|
+
|
1080
|
+
|
1081
|
+
|
1082
|
+
|
1083
|
+
</h3><div class="docstring">
|
1084
|
+
<div class="discussion">
|
1085
|
+
|
1086
|
+
<p>Delete an Endpoint by ID, currently available only for cloud endpoints Throws an exception if API error.</p>
|
1087
|
+
|
1088
|
+
<p><a href="https://ngrok.com/docs/api#api-endpoints-delete">ngrok.com/docs/api#api-endpoints-delete</a></p>
|
1089
|
+
|
1090
|
+
|
1091
|
+
</div>
|
1092
|
+
</div>
|
1093
|
+
<div class="tags">
|
1094
|
+
<p class="tag_title">Parameters:</p>
|
1095
|
+
<ul class="param">
|
1096
|
+
|
1097
|
+
<li>
|
1098
|
+
|
1099
|
+
<span class='name'>id</span>
|
1100
|
+
|
1101
|
+
|
1102
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1103
|
+
|
1104
|
+
|
1105
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1106
|
+
|
1107
|
+
|
1108
|
+
—
|
1109
|
+
<div class='inline'>
|
1110
|
+
<p>a resource identifier</p>
|
1111
|
+
</div>
|
1112
|
+
|
1113
|
+
</li>
|
1114
|
+
|
1115
|
+
</ul>
|
1116
|
+
|
1117
|
+
<p class="tag_title">Returns:</p>
|
1118
|
+
<ul class="return">
|
1119
|
+
|
1120
|
+
<li>
|
1121
|
+
|
1122
|
+
|
1123
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
1124
|
+
|
1125
|
+
|
1126
|
+
|
1127
|
+
—
|
1128
|
+
<div class='inline'>
|
1129
|
+
<p>result from the API request</p>
|
1130
|
+
</div>
|
1131
|
+
|
1132
|
+
</li>
|
1133
|
+
|
1134
|
+
</ul>
|
1135
|
+
|
1136
|
+
</div><table class="source_code">
|
1137
|
+
<tr>
|
1138
|
+
<td>
|
1139
|
+
<pre class="lines">
|
1140
|
+
|
1141
|
+
|
1142
|
+
262
|
1143
|
+
263
|
1144
|
+
264
|
1145
|
+
265
|
1146
|
+
266
|
1147
|
+
267
|
1148
|
+
268</pre>
|
1149
|
+
</td>
|
1150
|
+
<td>
|
1151
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 262</span>
|
1152
|
+
|
1153
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
1154
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/endpoints/%{id}</span><span class='tstring_end'>'</span></span>
|
1155
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1156
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1157
|
+
<span class='rbrace'>}</span>
|
1158
|
+
<span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
1159
|
+
<span class='kw'>end</span></pre>
|
1160
|
+
</td>
|
1161
|
+
</tr>
|
1162
|
+
</table>
|
1163
|
+
</div>
|
1164
|
+
|
1165
|
+
<div class="method_details ">
|
1166
|
+
<h3 class="signature " id="get-instance_method">
|
1167
|
+
|
1168
|
+
#<strong>get</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">NgrokAPI::Models::Endpoint</a></span></tt>
|
1169
|
+
|
1170
|
+
|
1171
|
+
|
1172
|
+
|
1173
|
+
|
1174
|
+
</h3><div class="docstring">
|
1175
|
+
<div class="discussion">
|
1176
|
+
|
1177
|
+
<p>Get the status of an endpoint by ID</p>
|
1178
|
+
|
1179
|
+
<p><a href="https://ngrok.com/docs/api#api-endpoints-get">ngrok.com/docs/api#api-endpoints-get</a></p>
|
1180
|
+
|
1181
|
+
|
1182
|
+
</div>
|
1183
|
+
</div>
|
1184
|
+
<div class="tags">
|
1185
|
+
<p class="tag_title">Parameters:</p>
|
1186
|
+
<ul class="param">
|
1187
|
+
|
1188
|
+
<li>
|
1189
|
+
|
1190
|
+
<span class='name'>id</span>
|
1191
|
+
|
1192
|
+
|
1193
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1194
|
+
|
1195
|
+
|
1196
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1197
|
+
|
1198
|
+
|
1199
|
+
—
|
1200
|
+
<div class='inline'>
|
1201
|
+
<p>a resource identifier</p>
|
1202
|
+
</div>
|
1203
|
+
|
1204
|
+
</li>
|
1205
|
+
|
1206
|
+
</ul>
|
1207
|
+
|
1208
|
+
<p class="tag_title">Returns:</p>
|
1209
|
+
<ul class="return">
|
1210
|
+
|
1211
|
+
<li>
|
1212
|
+
|
1213
|
+
|
1214
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">NgrokAPI::Models::Endpoint</a></span></tt>)</span>
|
1215
|
+
|
1216
|
+
|
1217
|
+
|
1218
|
+
—
|
1219
|
+
<div class='inline'>
|
1220
|
+
<p>result from the API request</p>
|
1221
|
+
</div>
|
1222
|
+
|
1223
|
+
</li>
|
1224
|
+
|
1225
|
+
</ul>
|
1226
|
+
|
1227
|
+
</div><table class="source_code">
|
1228
|
+
<tr>
|
1229
|
+
<td>
|
1230
|
+
<pre class="lines">
|
1231
|
+
|
1232
|
+
|
1233
|
+
152
|
1234
|
+
153
|
1235
|
+
154
|
1236
|
+
155
|
1237
|
+
156
|
1238
|
+
157
|
1239
|
+
158
|
1240
|
+
159
|
1241
|
+
160</pre>
|
1242
|
+
</td>
|
1243
|
+
<td>
|
1244
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 152</span>
|
1245
|
+
|
1246
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
1247
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/endpoints/%{id}</span><span class='tstring_end'>'</span></span>
|
1248
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1249
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1250
|
+
<span class='rbrace'>}</span>
|
1251
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
1252
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
1253
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">Endpoint</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Endpoint.html#initialize-instance_method" title="NgrokAPI::Models::Endpoint#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
1254
|
+
<span class='kw'>end</span></pre>
|
1255
|
+
</td>
|
1256
|
+
</tr>
|
1257
|
+
</table>
|
1258
|
+
</div>
|
1259
|
+
|
1260
|
+
<div class="method_details ">
|
1261
|
+
<h3 class="signature " id="get!-instance_method">
|
1262
|
+
|
1263
|
+
#<strong>get!</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">NgrokAPI::Models::Endpoint</a></span></tt>
|
1264
|
+
|
1265
|
+
|
1266
|
+
|
1267
|
+
|
1268
|
+
|
1269
|
+
</h3><div class="docstring">
|
1270
|
+
<div class="discussion">
|
1271
|
+
|
1272
|
+
<p>Get the status of an endpoint by ID Throws an exception if API error.</p>
|
1273
|
+
|
1274
|
+
<p><a href="https://ngrok.com/docs/api#api-endpoints-get">ngrok.com/docs/api#api-endpoints-get</a></p>
|
1275
|
+
|
1276
|
+
|
1277
|
+
</div>
|
1278
|
+
</div>
|
1279
|
+
<div class="tags">
|
1280
|
+
<p class="tag_title">Parameters:</p>
|
1281
|
+
<ul class="param">
|
1282
|
+
|
1283
|
+
<li>
|
1284
|
+
|
1285
|
+
<span class='name'>id</span>
|
1286
|
+
|
1287
|
+
|
1288
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1289
|
+
|
1290
|
+
|
1291
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1292
|
+
|
1293
|
+
|
1294
|
+
—
|
1295
|
+
<div class='inline'>
|
1296
|
+
<p>a resource identifier</p>
|
1297
|
+
</div>
|
1298
|
+
|
1299
|
+
</li>
|
1300
|
+
|
1301
|
+
</ul>
|
1302
|
+
|
1303
|
+
<p class="tag_title">Returns:</p>
|
1304
|
+
<ul class="return">
|
1305
|
+
|
1306
|
+
<li>
|
1307
|
+
|
1308
|
+
|
1309
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">NgrokAPI::Models::Endpoint</a></span></tt>)</span>
|
1310
|
+
|
1311
|
+
|
1312
|
+
|
1313
|
+
—
|
1314
|
+
<div class='inline'>
|
1315
|
+
<p>result from the API request</p>
|
1316
|
+
</div>
|
1317
|
+
|
1318
|
+
</li>
|
1319
|
+
|
1320
|
+
</ul>
|
1321
|
+
|
1322
|
+
</div><table class="source_code">
|
1323
|
+
<tr>
|
1324
|
+
<td>
|
1325
|
+
<pre class="lines">
|
1326
|
+
|
1327
|
+
|
1328
|
+
170
|
1329
|
+
171
|
1330
|
+
172
|
1331
|
+
173
|
1332
|
+
174
|
1333
|
+
175
|
1334
|
+
176
|
1335
|
+
177
|
1336
|
+
178</pre>
|
1337
|
+
</td>
|
1338
|
+
<td>
|
1339
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 170</span>
|
1340
|
+
|
1341
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='rparen'>)</span>
|
1342
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/endpoints/%{id}</span><span class='tstring_end'>'</span></span>
|
1343
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1344
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1345
|
+
<span class='rbrace'>}</span>
|
1346
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
1347
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
1348
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">Endpoint</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Endpoint.html#initialize-instance_method" title="NgrokAPI::Models::Endpoint#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
1349
|
+
<span class='kw'>end</span></pre>
|
1350
|
+
</td>
|
1351
|
+
</tr>
|
1352
|
+
</table>
|
1353
|
+
</div>
|
1354
|
+
|
1355
|
+
<div class="method_details ">
|
1356
|
+
<h3 class="signature " id="list-instance_method">
|
1357
|
+
|
1358
|
+
#<strong>list</strong>(before_id: nil, limit: nil, ids: [], urls: [], url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
|
1359
|
+
|
1360
|
+
|
1361
|
+
|
1362
|
+
|
1363
|
+
|
1364
|
+
</h3><div class="docstring">
|
1365
|
+
<div class="discussion">
|
1366
|
+
|
1367
|
+
<p>List all active endpoints on the account</p>
|
1368
|
+
|
1369
|
+
<p><a href="https://ngrok.com/docs/api#api-endpoints-list">ngrok.com/docs/api#api-endpoints-list</a></p>
|
1370
|
+
|
1371
|
+
|
1372
|
+
</div>
|
1373
|
+
</div>
|
1374
|
+
<div class="tags">
|
1375
|
+
<p class="tag_title">Parameters:</p>
|
1376
|
+
<ul class="param">
|
1377
|
+
|
1378
|
+
<li>
|
1379
|
+
|
1380
|
+
<span class='name'>before_id</span>
|
1381
|
+
|
1382
|
+
|
1383
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1384
|
+
|
1385
|
+
|
1386
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1387
|
+
|
1388
|
+
|
1389
|
+
</li>
|
1390
|
+
|
1391
|
+
<li>
|
1392
|
+
|
1393
|
+
<span class='name'>limit</span>
|
1394
|
+
|
1395
|
+
|
1396
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1397
|
+
|
1398
|
+
|
1399
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1400
|
+
|
1401
|
+
|
1402
|
+
</li>
|
1403
|
+
|
1404
|
+
<li>
|
1405
|
+
|
1406
|
+
<span class='name'>ids</span>
|
1407
|
+
|
1408
|
+
|
1409
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
1410
|
+
|
1411
|
+
|
1412
|
+
<em class="default">(defaults to: <tt>[]</tt>)</em>
|
1413
|
+
|
1414
|
+
|
1415
|
+
</li>
|
1416
|
+
|
1417
|
+
<li>
|
1418
|
+
|
1419
|
+
<span class='name'>urls</span>
|
1420
|
+
|
1421
|
+
|
1422
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
1423
|
+
|
1424
|
+
|
1425
|
+
<em class="default">(defaults to: <tt>[]</tt>)</em>
|
1426
|
+
|
1427
|
+
|
1428
|
+
</li>
|
1429
|
+
|
1430
|
+
<li>
|
1431
|
+
|
1432
|
+
<span class='name'>url</span>
|
1433
|
+
|
1434
|
+
|
1435
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1436
|
+
|
1437
|
+
|
1438
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1439
|
+
|
1440
|
+
|
1441
|
+
—
|
1442
|
+
<div class='inline'>
|
1443
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
1444
|
+
</div>
|
1445
|
+
|
1446
|
+
</li>
|
1447
|
+
|
1448
|
+
</ul>
|
1449
|
+
|
1450
|
+
<p class="tag_title">Returns:</p>
|
1451
|
+
<ul class="return">
|
1452
|
+
|
1453
|
+
<li>
|
1454
|
+
|
1455
|
+
|
1456
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
|
1457
|
+
|
1458
|
+
|
1459
|
+
|
1460
|
+
—
|
1461
|
+
<div class='inline'>
|
1462
|
+
<p>result from the API request</p>
|
1463
|
+
</div>
|
1464
|
+
|
1465
|
+
</li>
|
1466
|
+
|
1467
|
+
</ul>
|
1468
|
+
|
1469
|
+
</div><table class="source_code">
|
1470
|
+
<tr>
|
1471
|
+
<td>
|
1472
|
+
<pre class="lines">
|
1473
|
+
|
1474
|
+
|
1475
|
+
95
|
1476
|
+
96
|
1477
|
+
97
|
1478
|
+
98
|
1479
|
+
99
|
1480
|
+
100
|
1481
|
+
101
|
1482
|
+
102
|
1483
|
+
103
|
1484
|
+
104
|
1485
|
+
105
|
1486
|
+
106
|
1487
|
+
107
|
1488
|
+
108
|
1489
|
+
109
|
1490
|
+
110
|
1491
|
+
111</pre>
|
1492
|
+
</td>
|
1493
|
+
<td>
|
1494
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 95</span>
|
1495
|
+
|
1496
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ids:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>urls:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
1497
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
1498
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
1499
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
1500
|
+
<span class='label'>ids:</span> <span class='id identifier rubyid_ids'>ids</span><span class='comma'>,</span>
|
1501
|
+
<span class='label'>urls:</span> <span class='id identifier rubyid_urls'>urls</span><span class='comma'>,</span>
|
1502
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
1503
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EndpointsClient::PATH (constant)">PATH</a></span></span>
|
1504
|
+
<span class='rparen'>)</span>
|
1505
|
+
|
1506
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
|
1507
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
1508
|
+
<span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
1509
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EndpointsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
1510
|
+
<span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">Endpoint</a></span></span>
|
1511
|
+
<span class='rparen'>)</span>
|
1512
|
+
<span class='kw'>end</span></pre>
|
1513
|
+
</td>
|
1514
|
+
</tr>
|
1515
|
+
</table>
|
1516
|
+
</div>
|
1517
|
+
|
1518
|
+
<div class="method_details ">
|
1519
|
+
<h3 class="signature " id="list!-instance_method">
|
1520
|
+
|
1521
|
+
#<strong>list!</strong>(before_id: nil, limit: nil, ids: [], urls: [], url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
|
1522
|
+
|
1523
|
+
|
1524
|
+
|
1525
|
+
|
1526
|
+
|
1527
|
+
</h3><div class="docstring">
|
1528
|
+
<div class="discussion">
|
1529
|
+
|
1530
|
+
<p>List all active endpoints on the account Throws an exception if API error.</p>
|
1531
|
+
|
1532
|
+
<p><a href="https://ngrok.com/docs/api#api-endpoints-list">ngrok.com/docs/api#api-endpoints-list</a></p>
|
1533
|
+
|
1534
|
+
|
1535
|
+
</div>
|
1536
|
+
</div>
|
1537
|
+
<div class="tags">
|
1538
|
+
<p class="tag_title">Parameters:</p>
|
1539
|
+
<ul class="param">
|
1540
|
+
|
1541
|
+
<li>
|
1542
|
+
|
1543
|
+
<span class='name'>before_id</span>
|
1544
|
+
|
1545
|
+
|
1546
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1547
|
+
|
1548
|
+
|
1549
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1550
|
+
|
1551
|
+
|
1552
|
+
</li>
|
1553
|
+
|
1554
|
+
<li>
|
1555
|
+
|
1556
|
+
<span class='name'>limit</span>
|
1557
|
+
|
1558
|
+
|
1559
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1560
|
+
|
1561
|
+
|
1562
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1563
|
+
|
1564
|
+
|
1565
|
+
</li>
|
1566
|
+
|
1567
|
+
<li>
|
1568
|
+
|
1569
|
+
<span class='name'>ids</span>
|
1570
|
+
|
1571
|
+
|
1572
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
1573
|
+
|
1574
|
+
|
1575
|
+
<em class="default">(defaults to: <tt>[]</tt>)</em>
|
1576
|
+
|
1577
|
+
|
1578
|
+
</li>
|
1579
|
+
|
1580
|
+
<li>
|
1581
|
+
|
1582
|
+
<span class='name'>urls</span>
|
1583
|
+
|
1584
|
+
|
1585
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
1586
|
+
|
1587
|
+
|
1588
|
+
<em class="default">(defaults to: <tt>[]</tt>)</em>
|
1589
|
+
|
1590
|
+
|
1591
|
+
</li>
|
1592
|
+
|
1593
|
+
<li>
|
1594
|
+
|
1595
|
+
<span class='name'>url</span>
|
1596
|
+
|
1597
|
+
|
1598
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1599
|
+
|
1600
|
+
|
1601
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
558
1602
|
|
559
1603
|
|
560
1604
|
—
|
561
1605
|
<div class='inline'>
|
562
|
-
<p>
|
1606
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
563
1607
|
</div>
|
564
1608
|
|
565
1609
|
</li>
|
@@ -572,7 +1616,7 @@
|
|
572
1616
|
<li>
|
573
1617
|
|
574
1618
|
|
575
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
1619
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
|
576
1620
|
|
577
1621
|
|
578
1622
|
|
@@ -591,27 +1635,47 @@
|
|
591
1635
|
<pre class="lines">
|
592
1636
|
|
593
1637
|
|
594
|
-
|
595
|
-
|
596
|
-
|
597
|
-
|
598
|
-
|
599
|
-
|
600
|
-
|
601
|
-
|
602
|
-
|
1638
|
+
125
|
1639
|
+
126
|
1640
|
+
127
|
1641
|
+
128
|
1642
|
+
129
|
1643
|
+
130
|
1644
|
+
131
|
1645
|
+
132
|
1646
|
+
133
|
1647
|
+
134
|
1648
|
+
135
|
1649
|
+
136
|
1650
|
+
137
|
1651
|
+
138
|
1652
|
+
139
|
1653
|
+
140
|
1654
|
+
141
|
1655
|
+
142
|
1656
|
+
143</pre>
|
603
1657
|
</td>
|
604
1658
|
<td>
|
605
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line
|
1659
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 125</span>
|
606
1660
|
|
607
|
-
<span class='kw'>def</span> <span class='id identifier
|
608
|
-
<span class='id identifier
|
609
|
-
|
610
|
-
<span class='label'>
|
611
|
-
|
612
|
-
|
613
|
-
|
614
|
-
|
1661
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ids:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>urls:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
1662
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
1663
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
1664
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
1665
|
+
<span class='label'>ids:</span> <span class='id identifier rubyid_ids'>ids</span><span class='comma'>,</span>
|
1666
|
+
<span class='label'>urls:</span> <span class='id identifier rubyid_urls'>urls</span><span class='comma'>,</span>
|
1667
|
+
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
1668
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
1669
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EndpointsClient::PATH (constant)">PATH</a></span></span>
|
1670
|
+
<span class='rparen'>)</span>
|
1671
|
+
|
1672
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
|
1673
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
1674
|
+
<span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
1675
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EndpointsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
1676
|
+
<span class='label'>klass:</span> <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">Endpoint</a></span></span><span class='comma'>,</span>
|
1677
|
+
<span class='label'>danger:</span> <span class='kw'>true</span>
|
1678
|
+
<span class='rparen'>)</span>
|
615
1679
|
<span class='kw'>end</span></pre>
|
616
1680
|
</td>
|
617
1681
|
</tr>
|
@@ -619,9 +1683,9 @@
|
|
619
1683
|
</div>
|
620
1684
|
|
621
1685
|
<div class="method_details ">
|
622
|
-
<h3 class="signature " id="
|
1686
|
+
<h3 class="signature " id="update-instance_method">
|
623
1687
|
|
624
|
-
#<strong>
|
1688
|
+
#<strong>update</strong>(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ <tt><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">NgrokAPI::Models::Endpoint</a></span></tt>
|
625
1689
|
|
626
1690
|
|
627
1691
|
|
@@ -630,9 +1694,9 @@
|
|
630
1694
|
</h3><div class="docstring">
|
631
1695
|
<div class="discussion">
|
632
1696
|
|
633
|
-
<p>
|
1697
|
+
<p>Update an Endpoint by ID, currently available only for cloud endpoints</p>
|
634
1698
|
|
635
|
-
<p><a href="https://ngrok.com/docs/api#api-endpoints-
|
1699
|
+
<p><a href="https://ngrok.com/docs/api#api-endpoints-update">ngrok.com/docs/api#api-endpoints-update</a></p>
|
636
1700
|
|
637
1701
|
|
638
1702
|
</div>
|
@@ -643,7 +1707,25 @@
|
|
643
1707
|
|
644
1708
|
<li>
|
645
1709
|
|
646
|
-
<span class='name'>
|
1710
|
+
<span class='name'>id</span>
|
1711
|
+
|
1712
|
+
|
1713
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1714
|
+
|
1715
|
+
|
1716
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1717
|
+
|
1718
|
+
|
1719
|
+
—
|
1720
|
+
<div class='inline'>
|
1721
|
+
<p>unique endpoint resource identifier</p>
|
1722
|
+
</div>
|
1723
|
+
|
1724
|
+
</li>
|
1725
|
+
|
1726
|
+
<li>
|
1727
|
+
|
1728
|
+
<span class='name'>url</span>
|
647
1729
|
|
648
1730
|
|
649
1731
|
<span class='type'>(<tt>string</tt>)</span>
|
@@ -652,11 +1734,16 @@
|
|
652
1734
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
653
1735
|
|
654
1736
|
|
1737
|
+
—
|
1738
|
+
<div class='inline'>
|
1739
|
+
<p>the url of the endpoint</p>
|
1740
|
+
</div>
|
1741
|
+
|
655
1742
|
</li>
|
656
1743
|
|
657
1744
|
<li>
|
658
1745
|
|
659
|
-
<span class='name'>
|
1746
|
+
<span class='name'>traffic_policy</span>
|
660
1747
|
|
661
1748
|
|
662
1749
|
<span class='type'>(<tt>string</tt>)</span>
|
@@ -665,11 +1752,16 @@
|
|
665
1752
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
666
1753
|
|
667
1754
|
|
1755
|
+
—
|
1756
|
+
<div class='inline'>
|
1757
|
+
<p>The traffic policy attached to this endpoint</p>
|
1758
|
+
</div>
|
1759
|
+
|
668
1760
|
</li>
|
669
1761
|
|
670
1762
|
<li>
|
671
1763
|
|
672
|
-
<span class='name'>
|
1764
|
+
<span class='name'>description</span>
|
673
1765
|
|
674
1766
|
|
675
1767
|
<span class='type'>(<tt>string</tt>)</span>
|
@@ -680,11 +1772,60 @@
|
|
680
1772
|
|
681
1773
|
—
|
682
1774
|
<div class='inline'>
|
683
|
-
<p>
|
1775
|
+
<p>user-supplied description of the associated tunnel</p>
|
1776
|
+
</div>
|
1777
|
+
|
1778
|
+
</li>
|
1779
|
+
|
1780
|
+
<li>
|
1781
|
+
|
1782
|
+
<span class='name'>metadata</span>
|
1783
|
+
|
1784
|
+
|
1785
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1786
|
+
|
1787
|
+
|
1788
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1789
|
+
|
1790
|
+
|
1791
|
+
—
|
1792
|
+
<div class='inline'>
|
1793
|
+
<p>user-supplied metadata of the associated tunnel or edge object</p>
|
1794
|
+
</div>
|
1795
|
+
|
1796
|
+
</li>
|
1797
|
+
|
1798
|
+
<li>
|
1799
|
+
|
1800
|
+
<span class='name'>bindings</span>
|
1801
|
+
|
1802
|
+
|
1803
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
1804
|
+
|
1805
|
+
|
1806
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1807
|
+
|
1808
|
+
|
1809
|
+
—
|
1810
|
+
<div class='inline'>
|
1811
|
+
<p>the bindings associated with this endpoint</p>
|
684
1812
|
</div>
|
685
1813
|
|
686
1814
|
</li>
|
687
1815
|
|
1816
|
+
<li>
|
1817
|
+
|
1818
|
+
<span class='name'>pooling_enabled</span>
|
1819
|
+
|
1820
|
+
|
1821
|
+
<span class='type'>(<tt>boolean</tt>)</span>
|
1822
|
+
|
1823
|
+
|
1824
|
+
<em class="default">(defaults to: <tt>False</tt>)</em>
|
1825
|
+
|
1826
|
+
|
1827
|
+
</li>
|
1828
|
+
|
688
1829
|
</ul>
|
689
1830
|
|
690
1831
|
<p class="tag_title">Returns:</p>
|
@@ -693,7 +1834,7 @@
|
|
693
1834
|
<li>
|
694
1835
|
|
695
1836
|
|
696
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
1837
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">NgrokAPI::Models::Endpoint</a></span></tt>)</span>
|
697
1838
|
|
698
1839
|
|
699
1840
|
|
@@ -712,39 +1853,39 @@
|
|
712
1853
|
<pre class="lines">
|
713
1854
|
|
714
1855
|
|
715
|
-
|
716
|
-
|
717
|
-
|
718
|
-
|
719
|
-
|
720
|
-
|
721
|
-
|
722
|
-
|
723
|
-
|
724
|
-
|
725
|
-
|
726
|
-
|
727
|
-
|
728
|
-
|
729
|
-
|
1856
|
+
193
|
1857
|
+
194
|
1858
|
+
195
|
1859
|
+
196
|
1860
|
+
197
|
1861
|
+
198
|
1862
|
+
199
|
1863
|
+
200
|
1864
|
+
201
|
1865
|
+
202
|
1866
|
+
203
|
1867
|
+
204
|
1868
|
+
205
|
1869
|
+
206
|
1870
|
+
207</pre>
|
730
1871
|
</td>
|
731
1872
|
<td>
|
732
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line
|
733
|
-
|
734
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
735
|
-
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
736
|
-
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
737
|
-
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
738
|
-
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
739
|
-
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EndpointsClient::PATH (constant)">PATH</a></span></span>
|
740
|
-
<span class='rparen'>)</span>
|
1873
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 193</span>
|
741
1874
|
|
742
|
-
|
743
|
-
|
744
|
-
|
745
|
-
<span class='label'>
|
746
|
-
|
747
|
-
<span class='
|
1875
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>url:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>traffic_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>bindings:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>pooling_enabled:</span> <span class='const'>False</span><span class='rparen'>)</span>
|
1876
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/endpoints/%{id}</span><span class='tstring_end'>'</span></span>
|
1877
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1878
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1879
|
+
<span class='rbrace'>}</span>
|
1880
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
1881
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:url</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_url'>url</span> <span class='kw'>if</span> <span class='id identifier rubyid_url'>url</span>
|
1882
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:traffic_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_traffic_policy'>traffic_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_traffic_policy'>traffic_policy</span>
|
1883
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
1884
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
1885
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:bindings</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_bindings'>bindings</span> <span class='kw'>if</span> <span class='id identifier rubyid_bindings'>bindings</span>
|
1886
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:pooling_enabled</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_pooling_enabled'>pooling_enabled</span> <span class='kw'>if</span> <span class='id identifier rubyid_pooling_enabled'>pooling_enabled</span>
|
1887
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
|
1888
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">Endpoint</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Endpoint.html#initialize-instance_method" title="NgrokAPI::Models::Endpoint#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
748
1889
|
<span class='kw'>end</span></pre>
|
749
1890
|
</td>
|
750
1891
|
</tr>
|
@@ -752,9 +1893,9 @@
|
|
752
1893
|
</div>
|
753
1894
|
|
754
1895
|
<div class="method_details ">
|
755
|
-
<h3 class="signature " id="
|
1896
|
+
<h3 class="signature " id="update!-instance_method">
|
756
1897
|
|
757
|
-
#<strong>
|
1898
|
+
#<strong>update!</strong>(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil, pooling_enabled: False) ⇒ <tt><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">NgrokAPI::Models::Endpoint</a></span></tt>
|
758
1899
|
|
759
1900
|
|
760
1901
|
|
@@ -763,9 +1904,9 @@
|
|
763
1904
|
</h3><div class="docstring">
|
764
1905
|
<div class="discussion">
|
765
1906
|
|
766
|
-
<p>
|
1907
|
+
<p>Update an Endpoint by ID, currently available only for cloud endpoints Throws an exception if API error.</p>
|
767
1908
|
|
768
|
-
<p><a href="https://ngrok.com/docs/api#api-endpoints-
|
1909
|
+
<p><a href="https://ngrok.com/docs/api#api-endpoints-update">ngrok.com/docs/api#api-endpoints-update</a></p>
|
769
1910
|
|
770
1911
|
|
771
1912
|
</div>
|
@@ -776,7 +1917,25 @@
|
|
776
1917
|
|
777
1918
|
<li>
|
778
1919
|
|
779
|
-
<span class='name'>
|
1920
|
+
<span class='name'>id</span>
|
1921
|
+
|
1922
|
+
|
1923
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1924
|
+
|
1925
|
+
|
1926
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1927
|
+
|
1928
|
+
|
1929
|
+
—
|
1930
|
+
<div class='inline'>
|
1931
|
+
<p>unique endpoint resource identifier</p>
|
1932
|
+
</div>
|
1933
|
+
|
1934
|
+
</li>
|
1935
|
+
|
1936
|
+
<li>
|
1937
|
+
|
1938
|
+
<span class='name'>url</span>
|
780
1939
|
|
781
1940
|
|
782
1941
|
<span class='type'>(<tt>string</tt>)</span>
|
@@ -785,11 +1944,16 @@
|
|
785
1944
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
786
1945
|
|
787
1946
|
|
1947
|
+
—
|
1948
|
+
<div class='inline'>
|
1949
|
+
<p>the url of the endpoint</p>
|
1950
|
+
</div>
|
1951
|
+
|
788
1952
|
</li>
|
789
1953
|
|
790
1954
|
<li>
|
791
1955
|
|
792
|
-
<span class='name'>
|
1956
|
+
<span class='name'>traffic_policy</span>
|
793
1957
|
|
794
1958
|
|
795
1959
|
<span class='type'>(<tt>string</tt>)</span>
|
@@ -798,11 +1962,16 @@
|
|
798
1962
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
799
1963
|
|
800
1964
|
|
1965
|
+
—
|
1966
|
+
<div class='inline'>
|
1967
|
+
<p>The traffic policy attached to this endpoint</p>
|
1968
|
+
</div>
|
1969
|
+
|
801
1970
|
</li>
|
802
1971
|
|
803
1972
|
<li>
|
804
1973
|
|
805
|
-
<span class='name'>
|
1974
|
+
<span class='name'>description</span>
|
806
1975
|
|
807
1976
|
|
808
1977
|
<span class='type'>(<tt>string</tt>)</span>
|
@@ -813,11 +1982,60 @@
|
|
813
1982
|
|
814
1983
|
—
|
815
1984
|
<div class='inline'>
|
816
|
-
<p>
|
1985
|
+
<p>user-supplied description of the associated tunnel</p>
|
1986
|
+
</div>
|
1987
|
+
|
1988
|
+
</li>
|
1989
|
+
|
1990
|
+
<li>
|
1991
|
+
|
1992
|
+
<span class='name'>metadata</span>
|
1993
|
+
|
1994
|
+
|
1995
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1996
|
+
|
1997
|
+
|
1998
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1999
|
+
|
2000
|
+
|
2001
|
+
—
|
2002
|
+
<div class='inline'>
|
2003
|
+
<p>user-supplied metadata of the associated tunnel or edge object</p>
|
2004
|
+
</div>
|
2005
|
+
|
2006
|
+
</li>
|
2007
|
+
|
2008
|
+
<li>
|
2009
|
+
|
2010
|
+
<span class='name'>bindings</span>
|
2011
|
+
|
2012
|
+
|
2013
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
2014
|
+
|
2015
|
+
|
2016
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
2017
|
+
|
2018
|
+
|
2019
|
+
—
|
2020
|
+
<div class='inline'>
|
2021
|
+
<p>the bindings associated with this endpoint</p>
|
817
2022
|
</div>
|
818
2023
|
|
819
2024
|
</li>
|
820
2025
|
|
2026
|
+
<li>
|
2027
|
+
|
2028
|
+
<span class='name'>pooling_enabled</span>
|
2029
|
+
|
2030
|
+
|
2031
|
+
<span class='type'>(<tt>boolean</tt>)</span>
|
2032
|
+
|
2033
|
+
|
2034
|
+
<em class="default">(defaults to: <tt>False</tt>)</em>
|
2035
|
+
|
2036
|
+
|
2037
|
+
</li>
|
2038
|
+
|
821
2039
|
</ul>
|
822
2040
|
|
823
2041
|
<p class="tag_title">Returns:</p>
|
@@ -826,7 +2044,7 @@
|
|
826
2044
|
<li>
|
827
2045
|
|
828
2046
|
|
829
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
2047
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">NgrokAPI::Models::Endpoint</a></span></tt>)</span>
|
830
2048
|
|
831
2049
|
|
832
2050
|
|
@@ -845,43 +2063,39 @@
|
|
845
2063
|
<pre class="lines">
|
846
2064
|
|
847
2065
|
|
848
|
-
|
849
|
-
|
850
|
-
|
851
|
-
|
852
|
-
|
853
|
-
|
854
|
-
|
855
|
-
|
856
|
-
|
857
|
-
|
858
|
-
|
859
|
-
|
860
|
-
|
861
|
-
|
862
|
-
|
863
|
-
75
|
864
|
-
76</pre>
|
2066
|
+
223
|
2067
|
+
224
|
2068
|
+
225
|
2069
|
+
226
|
2070
|
+
227
|
2071
|
+
228
|
2072
|
+
229
|
2073
|
+
230
|
2074
|
+
231
|
2075
|
+
232
|
2076
|
+
233
|
2077
|
+
234
|
2078
|
+
235
|
2079
|
+
236
|
2080
|
+
237</pre>
|
865
2081
|
</td>
|
866
2082
|
<td>
|
867
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line
|
868
|
-
|
869
|
-
<span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
870
|
-
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
|
871
|
-
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
872
|
-
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
873
|
-
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
874
|
-
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
875
|
-
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EndpointsClient::PATH (constant)">PATH</a></span></span>
|
876
|
-
<span class='rparen'>)</span>
|
2083
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 223</span>
|
877
2084
|
|
878
|
-
|
879
|
-
|
880
|
-
|
881
|
-
<span class='label'>
|
882
|
-
|
883
|
-
|
884
|
-
<span class='
|
2085
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>url:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>traffic_policy:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>bindings:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>pooling_enabled:</span> <span class='const'>False</span><span class='rparen'>)</span>
|
2086
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/endpoints/%{id}</span><span class='tstring_end'>'</span></span>
|
2087
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
2088
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
2089
|
+
<span class='rbrace'>}</span>
|
2090
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
2091
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:url</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_url'>url</span> <span class='kw'>if</span> <span class='id identifier rubyid_url'>url</span>
|
2092
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:traffic_policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_traffic_policy'>traffic_policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_traffic_policy'>traffic_policy</span>
|
2093
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
|
2094
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
|
2095
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:bindings</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_bindings'>bindings</span> <span class='kw'>if</span> <span class='id identifier rubyid_bindings'>bindings</span>
|
2096
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:pooling_enabled</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_pooling_enabled'>pooling_enabled</span> <span class='kw'>if</span> <span class='id identifier rubyid_pooling_enabled'>pooling_enabled</span>
|
2097
|
+
<span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
|
2098
|
+
<span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">Endpoint</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Endpoint.html#initialize-instance_method" title="NgrokAPI::Models::Endpoint#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
885
2099
|
<span class='kw'>end</span></pre>
|
886
2100
|
</td>
|
887
2101
|
</tr>
|
@@ -893,9 +2107,9 @@
|
|
893
2107
|
</div>
|
894
2108
|
|
895
2109
|
<div id="footer">
|
896
|
-
Generated on Thu
|
2110
|
+
Generated on Thu Aug 14 22:44:18 2025 by
|
897
2111
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
898
|
-
0.9.36 (ruby-3.3.
|
2112
|
+
0.9.36 (ruby-3.3.8).
|
899
2113
|
</div>
|
900
2114
|
|
901
2115
|
</div>
|