ngrok-api 0.22.0 → 0.24.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.gitignore +0 -1
- data/CHANGELOG.md +9 -1
- data/Gemfile +11 -11
- data/Gemfile.lock +175 -0
- data/README.md +21 -0
- data/doc/NgrokAPI/Client.html +26 -20
- 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 +1394 -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 +669 -0
- 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 +91 -17
- data/doc/NgrokAPI/Models/EventTargetAzureLogsIngestion.html +965 -0
- 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 +36 -36
- 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/StaticBackend.html +2 -2
- data/doc/NgrokAPI/Models/StaticBackendTLS.html +2 -2
- data/doc/NgrokAPI/Models/TCPEdge.html +15 -15
- data/doc/NgrokAPI/Models/TLSCertificate.html +2 -2
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +2 -2
- data/doc/NgrokAPI/Models/TLSEdge.html +22 -22
- 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/WeightedBackend.html +2 -2
- data/doc/NgrokAPI/Models.html +4 -4
- data/doc/NgrokAPI/PagedIterator.html +2 -2
- data/doc/NgrokAPI/Services/APIKeysClient.html +3 -3
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +3 -3
- 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 +3 -3
- data/doc/NgrokAPI/Services/CredentialsClient.html +3 -3
- 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 +1149 -0
- 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 +26 -26
- data/doc/NgrokAPI/Services/EdgesTCPClient.html +26 -26
- data/doc/NgrokAPI/Services/EdgesTLSClient.html +26 -26
- data/doc/NgrokAPI/Services/EndpointsClient.html +1243 -137
- 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 +3 -3
- 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 +3 -3
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +3 -3
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +3 -3
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +3 -3
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +15 -15
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +3 -3
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +3 -3
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +3 -3
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +3 -3
- data/doc/NgrokAPI/Services/StaticBackendsClient.html +3 -3
- data/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +2 -2
- data/doc/NgrokAPI/Services/TCPEdgeTrafficPolicyModuleClient.html +1039 -0
- data/doc/NgrokAPI/Services/TLSCertificatesClient.html +3 -3
- 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 +1039 -0
- data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +3 -3
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +3 -3
- data/doc/NgrokAPI/Services/TunnelsClient.html +3 -3
- data/doc/NgrokAPI/Services/WeightedBackendsClient.html +3 -3
- data/doc/NgrokAPI/Services.html +4 -4
- data/doc/NgrokAPI.html +4 -4
- data/doc/_index.html +21 -28
- 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 +1377 -1241
- data/doc/top-level-namespace.html +2 -2
- data/docs/NgrokAPI/Client.html +26 -20
- 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 +1394 -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 +669 -0
- 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 +91 -17
- data/docs/NgrokAPI/Models/EventTargetAzureLogsIngestion.html +965 -0
- 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 +36 -36
- 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/StaticBackend.html +2 -2
- data/docs/NgrokAPI/Models/StaticBackendTLS.html +2 -2
- data/docs/NgrokAPI/Models/TCPEdge.html +15 -15
- data/docs/NgrokAPI/Models/TLSCertificate.html +2 -2
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +2 -2
- data/docs/NgrokAPI/Models/TLSEdge.html +22 -22
- 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/WeightedBackend.html +2 -2
- data/docs/NgrokAPI/Models.html +4 -4
- data/docs/NgrokAPI/PagedIterator.html +2 -2
- data/docs/NgrokAPI/Services/APIKeysClient.html +3 -3
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +3 -3
- 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 +3 -3
- data/docs/NgrokAPI/Services/CredentialsClient.html +3 -3
- 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 +1149 -0
- 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 +26 -26
- data/docs/NgrokAPI/Services/EdgesTCPClient.html +26 -26
- data/docs/NgrokAPI/Services/EdgesTLSClient.html +26 -26
- data/docs/NgrokAPI/Services/EndpointsClient.html +1243 -137
- 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 +3 -3
- 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 +3 -3
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +3 -3
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +3 -3
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +3 -3
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +15 -15
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +3 -3
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +3 -3
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +3 -3
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +3 -3
- data/docs/NgrokAPI/Services/StaticBackendsClient.html +3 -3
- data/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +2 -2
- data/docs/NgrokAPI/Services/TCPEdgeTrafficPolicyModuleClient.html +1039 -0
- data/docs/NgrokAPI/Services/TLSCertificatesClient.html +3 -3
- 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 +1039 -0
- data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +3 -3
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +3 -3
- data/docs/NgrokAPI/Services/TunnelsClient.html +3 -3
- data/docs/NgrokAPI/Services/WeightedBackendsClient.html +3 -3
- data/docs/NgrokAPI/Services.html +4 -4
- data/docs/NgrokAPI.html +4 -4
- data/docs/_index.html +21 -28
- 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 +1377 -1241
- data/docs/top-level-namespace.html +2 -2
- data/lib/ngrokapi/client.rb +3 -0
- data/lib/ngrokapi/models/endpoint.rb +67 -1
- data/lib/ngrokapi/models/{endpoint_policy.rb → endpoint_traffic_policy.rb} +3 -5
- data/lib/ngrokapi/models/event_target.rb +3 -1
- data/lib/ngrokapi/models/event_target_azure_logs_ingestion.rb +41 -0
- data/lib/ngrokapi/models/https_edge_route.rb +5 -5
- data/lib/ngrokapi/models/tcp_edge.rb +5 -5
- data/lib/ngrokapi/models/tls_edge.rb +5 -5
- data/lib/ngrokapi/services/{edge_route_policy_module_client.rb → edge_route_traffic_policy_module_client.rb} +25 -25
- data/lib/ngrokapi/services/edges_https_routes_client.rb +12 -12
- data/lib/ngrokapi/services/edges_tcp_client.rb +12 -12
- data/lib/ngrokapi/services/edges_tls_client.rb +12 -12
- data/lib/ngrokapi/services/endpoints_client.rb +143 -2
- data/lib/ngrokapi/services/reserved_domains_client.rb +4 -4
- data/lib/ngrokapi/services/{tcp_edge_policy_module_client.rb → tcp_edge_traffic_policy_module_client.rb} +25 -25
- data/lib/ngrokapi/services/{tls_edge_policy_module_client.rb → tls_edge_traffic_policy_module_client.rb} +25 -25
- data/lib/ngrokapi/version.rb +1 -1
- data/spec/ngrokapi/client_spec.rb +3 -0
- data/spec/ngrokapi/models/endpoint_spec.rb +30 -0
- data/spec/ngrokapi/models/endpoint_traffic_policy_spec.rb +23 -0
- data/spec/ngrokapi/models/event_target_azure_logs_ingestion_spec.rb +23 -0
- data/spec/ngrokapi/models/https_edge_route_spec.rb +3 -3
- data/spec/ngrokapi/models/tcp_edge_spec.rb +3 -3
- data/spec/ngrokapi/models/tls_edge_spec.rb +3 -3
- data/spec/ngrokapi/services/edge_route_traffic_policy_module_client_spec.rb +139 -0
- data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +12 -8
- data/spec/ngrokapi/services/edges_tcp_client_spec.rb +12 -8
- data/spec/ngrokapi/services/edges_tls_client_spec.rb +12 -8
- data/spec/ngrokapi/services/endpoints_client_spec.rb +147 -0
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +8 -4
- data/spec/ngrokapi/services/tcp_edge_traffic_policy_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/tls_edge_traffic_policy_module_client_spec.rb +125 -0
- data/spec/spec_helper.rb +6 -11
- metadata +23 -14
- data/lib/ngrokapi/models/endpoint_action.rb +0 -33
- data/lib/ngrokapi/models/endpoint_rule.rb +0 -35
- data/spec/ngrokapi/models/endpoint_action_spec.rb +0 -23
- data/spec/ngrokapi/models/endpoint_policy_spec.rb +0 -23
- data/spec/ngrokapi/models/endpoint_rule_spec.rb +0 -23
- data/spec/ngrokapi/services/edge_route_policy_module_client_spec.rb +0 -139
- data/spec/ngrokapi/services/tcp_edge_policy_module_client_spec.rb +0 -125
- data/spec/ngrokapi/services/tls_edge_policy_module_client_spec.rb +0 -125
@@ -102,7 +102,7 @@
|
|
102
102
|
<h2>Overview</h2><div class="docstring">
|
103
103
|
<div class="discussion">
|
104
104
|
|
105
|
-
<p>Endpoints provides an API for querying the endpoint objects
|
105
|
+
<p>Endpoints provides an API for querying the endpoint objects which define what tunnel or edge is used to serve a hostport. Only active endpoints associated with a tunnel or backend are returned.</p>
|
106
106
|
|
107
107
|
<p><a href="https://ngrok.com/docs/api#api-endpoints">ngrok.com/docs/api#api-endpoints</a></p>
|
108
108
|
|
@@ -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) ⇒ 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) ⇒ 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
|
|
@@ -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) ⇒ 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) ⇒ 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) ⇒ <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,7 +597,7 @@
|
|
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>
|
@@ -464,7 +608,97 @@
|
|
464
608
|
|
465
609
|
—
|
466
610
|
<div class='inline'>
|
467
|
-
<p>
|
611
|
+
<p>the url of the endpoint</p>
|
612
|
+
</div>
|
613
|
+
|
614
|
+
</li>
|
615
|
+
|
616
|
+
<li>
|
617
|
+
|
618
|
+
<span class='name'>type</span>
|
619
|
+
|
620
|
+
|
621
|
+
<span class='type'>(<tt>string</tt>)</span>
|
622
|
+
|
623
|
+
|
624
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
625
|
+
|
626
|
+
|
627
|
+
—
|
628
|
+
<div class='inline'>
|
629
|
+
<p>whether the endpoint is <code>ephemeral</code> (served directly by an agent-initiated tunnel) or <code>edge</code> (served by an edge) or <code>cloud (represents a cloud endpoint)</code></p>
|
630
|
+
</div>
|
631
|
+
|
632
|
+
</li>
|
633
|
+
|
634
|
+
<li>
|
635
|
+
|
636
|
+
<span class='name'>traffic_policy</span>
|
637
|
+
|
638
|
+
|
639
|
+
<span class='type'>(<tt>string</tt>)</span>
|
640
|
+
|
641
|
+
|
642
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
643
|
+
|
644
|
+
|
645
|
+
—
|
646
|
+
<div class='inline'>
|
647
|
+
<p>The traffic policy attached to this endpoint</p>
|
648
|
+
</div>
|
649
|
+
|
650
|
+
</li>
|
651
|
+
|
652
|
+
<li>
|
653
|
+
|
654
|
+
<span class='name'>description</span>
|
655
|
+
|
656
|
+
|
657
|
+
<span class='type'>(<tt>string</tt>)</span>
|
658
|
+
|
659
|
+
|
660
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
661
|
+
|
662
|
+
|
663
|
+
—
|
664
|
+
<div class='inline'>
|
665
|
+
<p>user-supplied description of the associated tunnel</p>
|
666
|
+
</div>
|
667
|
+
|
668
|
+
</li>
|
669
|
+
|
670
|
+
<li>
|
671
|
+
|
672
|
+
<span class='name'>metadata</span>
|
673
|
+
|
674
|
+
|
675
|
+
<span class='type'>(<tt>string</tt>)</span>
|
676
|
+
|
677
|
+
|
678
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
679
|
+
|
680
|
+
|
681
|
+
—
|
682
|
+
<div class='inline'>
|
683
|
+
<p>user-supplied metadata of the associated tunnel or edge object</p>
|
684
|
+
</div>
|
685
|
+
|
686
|
+
</li>
|
687
|
+
|
688
|
+
<li>
|
689
|
+
|
690
|
+
<span class='name'>bindings</span>
|
691
|
+
|
692
|
+
|
693
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
694
|
+
|
695
|
+
|
696
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
697
|
+
|
698
|
+
|
699
|
+
—
|
700
|
+
<div class='inline'>
|
701
|
+
<p>the bindings associated with this endpoint</p>
|
468
702
|
</div>
|
469
703
|
|
470
704
|
</li>
|
@@ -496,26 +730,36 @@
|
|
496
730
|
<pre class="lines">
|
497
731
|
|
498
732
|
|
499
|
-
|
500
|
-
|
501
|
-
|
502
|
-
|
503
|
-
|
504
|
-
|
505
|
-
|
506
|
-
|
507
|
-
|
733
|
+
37
|
734
|
+
38
|
735
|
+
39
|
736
|
+
40
|
737
|
+
41
|
738
|
+
42
|
739
|
+
43
|
740
|
+
44
|
741
|
+
45
|
742
|
+
46
|
743
|
+
47
|
744
|
+
48
|
745
|
+
49
|
746
|
+
50</pre>
|
508
747
|
</td>
|
509
748
|
<td>
|
510
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line
|
749
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 37</span>
|
511
750
|
|
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
|
751
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>url:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>traffic_policy:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>bindings:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
752
|
+
<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
753
|
<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
754
|
<span class='rbrace'>}</span>
|
517
755
|
<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
|
756
|
+
<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>
|
757
|
+
<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>
|
758
|
+
<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>
|
759
|
+
<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>
|
760
|
+
<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>
|
761
|
+
<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>
|
762
|
+
<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
763
|
<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
764
|
<span class='kw'>end</span></pre>
|
521
765
|
</td>
|
@@ -524,9 +768,9 @@
|
|
524
768
|
</div>
|
525
769
|
|
526
770
|
<div class="method_details ">
|
527
|
-
<h3 class="signature " id="
|
771
|
+
<h3 class="signature " id="create!-instance_method">
|
528
772
|
|
529
|
-
#<strong>
|
773
|
+
#<strong>create!</strong>(url: "", type: "", traffic_policy: "", description: nil, metadata: nil, bindings: nil) ⇒ <tt><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">NgrokAPI::Models::Endpoint</a></span></tt>
|
530
774
|
|
531
775
|
|
532
776
|
|
@@ -535,9 +779,9 @@
|
|
535
779
|
</h3><div class="docstring">
|
536
780
|
<div class="discussion">
|
537
781
|
|
538
|
-
<p>
|
782
|
+
<p>Create an endpoint, currently available only for cloud endpoints Throws an exception if API error.</p>
|
539
783
|
|
540
|
-
<p><a href="https://ngrok.com/docs/api#api-endpoints-
|
784
|
+
<p><a href="https://ngrok.com/docs/api#api-endpoints-create">ngrok.com/docs/api#api-endpoints-create</a></p>
|
541
785
|
|
542
786
|
|
543
787
|
</div>
|
@@ -548,7 +792,7 @@
|
|
548
792
|
|
549
793
|
<li>
|
550
794
|
|
551
|
-
<span class='name'>
|
795
|
+
<span class='name'>url</span>
|
552
796
|
|
553
797
|
|
554
798
|
<span class='type'>(<tt>string</tt>)</span>
|
@@ -559,12 +803,738 @@
|
|
559
803
|
|
560
804
|
—
|
561
805
|
<div class='inline'>
|
562
|
-
<p>
|
806
|
+
<p>the url of the endpoint</p>
|
563
807
|
</div>
|
564
808
|
|
565
809
|
</li>
|
566
810
|
|
567
|
-
|
811
|
+
<li>
|
812
|
+
|
813
|
+
<span class='name'>type</span>
|
814
|
+
|
815
|
+
|
816
|
+
<span class='type'>(<tt>string</tt>)</span>
|
817
|
+
|
818
|
+
|
819
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
820
|
+
|
821
|
+
|
822
|
+
—
|
823
|
+
<div class='inline'>
|
824
|
+
<p>whether the endpoint is <code>ephemeral</code> (served directly by an agent-initiated tunnel) or <code>edge</code> (served by an edge) or <code>cloud (represents a cloud endpoint)</code></p>
|
825
|
+
</div>
|
826
|
+
|
827
|
+
</li>
|
828
|
+
|
829
|
+
<li>
|
830
|
+
|
831
|
+
<span class='name'>traffic_policy</span>
|
832
|
+
|
833
|
+
|
834
|
+
<span class='type'>(<tt>string</tt>)</span>
|
835
|
+
|
836
|
+
|
837
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
838
|
+
|
839
|
+
|
840
|
+
—
|
841
|
+
<div class='inline'>
|
842
|
+
<p>The traffic policy attached to this endpoint</p>
|
843
|
+
</div>
|
844
|
+
|
845
|
+
</li>
|
846
|
+
|
847
|
+
<li>
|
848
|
+
|
849
|
+
<span class='name'>description</span>
|
850
|
+
|
851
|
+
|
852
|
+
<span class='type'>(<tt>string</tt>)</span>
|
853
|
+
|
854
|
+
|
855
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
856
|
+
|
857
|
+
|
858
|
+
—
|
859
|
+
<div class='inline'>
|
860
|
+
<p>user-supplied description of the associated tunnel</p>
|
861
|
+
</div>
|
862
|
+
|
863
|
+
</li>
|
864
|
+
|
865
|
+
<li>
|
866
|
+
|
867
|
+
<span class='name'>metadata</span>
|
868
|
+
|
869
|
+
|
870
|
+
<span class='type'>(<tt>string</tt>)</span>
|
871
|
+
|
872
|
+
|
873
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
874
|
+
|
875
|
+
|
876
|
+
—
|
877
|
+
<div class='inline'>
|
878
|
+
<p>user-supplied metadata of the associated tunnel or edge object</p>
|
879
|
+
</div>
|
880
|
+
|
881
|
+
</li>
|
882
|
+
|
883
|
+
<li>
|
884
|
+
|
885
|
+
<span class='name'>bindings</span>
|
886
|
+
|
887
|
+
|
888
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
889
|
+
|
890
|
+
|
891
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
892
|
+
|
893
|
+
|
894
|
+
—
|
895
|
+
<div class='inline'>
|
896
|
+
<p>the bindings associated with this endpoint</p>
|
897
|
+
</div>
|
898
|
+
|
899
|
+
</li>
|
900
|
+
|
901
|
+
</ul>
|
902
|
+
|
903
|
+
<p class="tag_title">Returns:</p>
|
904
|
+
<ul class="return">
|
905
|
+
|
906
|
+
<li>
|
907
|
+
|
908
|
+
|
909
|
+
<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>
|
910
|
+
|
911
|
+
|
912
|
+
|
913
|
+
—
|
914
|
+
<div class='inline'>
|
915
|
+
<p>result from the API request</p>
|
916
|
+
</div>
|
917
|
+
|
918
|
+
</li>
|
919
|
+
|
920
|
+
</ul>
|
921
|
+
|
922
|
+
</div><table class="source_code">
|
923
|
+
<tr>
|
924
|
+
<td>
|
925
|
+
<pre class="lines">
|
926
|
+
|
927
|
+
|
928
|
+
65
|
929
|
+
66
|
930
|
+
67
|
931
|
+
68
|
932
|
+
69
|
933
|
+
70
|
934
|
+
71
|
935
|
+
72
|
936
|
+
73
|
937
|
+
74
|
938
|
+
75
|
939
|
+
76
|
940
|
+
77
|
941
|
+
78</pre>
|
942
|
+
</td>
|
943
|
+
<td>
|
944
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 65</span>
|
945
|
+
|
946
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span><span class='label'>url:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>type:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>traffic_policy:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>bindings:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
947
|
+
<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>
|
948
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
949
|
+
<span class='rbrace'>}</span>
|
950
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
951
|
+
<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>
|
952
|
+
<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>
|
953
|
+
<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>
|
954
|
+
<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>
|
955
|
+
<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>
|
956
|
+
<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>
|
957
|
+
<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>
|
958
|
+
<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>
|
959
|
+
<span class='kw'>end</span></pre>
|
960
|
+
</td>
|
961
|
+
</tr>
|
962
|
+
</table>
|
963
|
+
</div>
|
964
|
+
|
965
|
+
<div class="method_details ">
|
966
|
+
<h3 class="signature " id="delete-instance_method">
|
967
|
+
|
968
|
+
#<strong>delete</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
969
|
+
|
970
|
+
|
971
|
+
|
972
|
+
|
973
|
+
|
974
|
+
</h3><div class="docstring">
|
975
|
+
<div class="discussion">
|
976
|
+
|
977
|
+
<p>Delete an Endpoint by ID, currently available only for cloud endpoints</p>
|
978
|
+
|
979
|
+
<p><a href="https://ngrok.com/docs/api#api-endpoints-delete">ngrok.com/docs/api#api-endpoints-delete</a></p>
|
980
|
+
|
981
|
+
|
982
|
+
</div>
|
983
|
+
</div>
|
984
|
+
<div class="tags">
|
985
|
+
<p class="tag_title">Parameters:</p>
|
986
|
+
<ul class="param">
|
987
|
+
|
988
|
+
<li>
|
989
|
+
|
990
|
+
<span class='name'>id</span>
|
991
|
+
|
992
|
+
|
993
|
+
<span class='type'>(<tt>string</tt>)</span>
|
994
|
+
|
995
|
+
|
996
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
997
|
+
|
998
|
+
|
999
|
+
—
|
1000
|
+
<div class='inline'>
|
1001
|
+
<p>a resource identifier</p>
|
1002
|
+
</div>
|
1003
|
+
|
1004
|
+
</li>
|
1005
|
+
|
1006
|
+
</ul>
|
1007
|
+
|
1008
|
+
<p class="tag_title">Returns:</p>
|
1009
|
+
<ul class="return">
|
1010
|
+
|
1011
|
+
<li>
|
1012
|
+
|
1013
|
+
|
1014
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
1015
|
+
|
1016
|
+
|
1017
|
+
|
1018
|
+
—
|
1019
|
+
<div class='inline'>
|
1020
|
+
<p>result from the API request</p>
|
1021
|
+
</div>
|
1022
|
+
|
1023
|
+
</li>
|
1024
|
+
|
1025
|
+
</ul>
|
1026
|
+
|
1027
|
+
</div><table class="source_code">
|
1028
|
+
<tr>
|
1029
|
+
<td>
|
1030
|
+
<pre class="lines">
|
1031
|
+
|
1032
|
+
|
1033
|
+
230
|
1034
|
+
231
|
1035
|
+
232
|
1036
|
+
233
|
1037
|
+
234
|
1038
|
+
235
|
1039
|
+
236</pre>
|
1040
|
+
</td>
|
1041
|
+
<td>
|
1042
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 230</span>
|
1043
|
+
|
1044
|
+
<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>
|
1045
|
+
<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>
|
1046
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1047
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1048
|
+
<span class='rbrace'>}</span>
|
1049
|
+
<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>
|
1050
|
+
<span class='kw'>end</span></pre>
|
1051
|
+
</td>
|
1052
|
+
</tr>
|
1053
|
+
</table>
|
1054
|
+
</div>
|
1055
|
+
|
1056
|
+
<div class="method_details ">
|
1057
|
+
<h3 class="signature " id="delete!-instance_method">
|
1058
|
+
|
1059
|
+
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
1060
|
+
|
1061
|
+
|
1062
|
+
|
1063
|
+
|
1064
|
+
|
1065
|
+
</h3><div class="docstring">
|
1066
|
+
<div class="discussion">
|
1067
|
+
|
1068
|
+
<p>Delete an Endpoint by ID, currently available only for cloud endpoints Throws an exception if API error.</p>
|
1069
|
+
|
1070
|
+
<p><a href="https://ngrok.com/docs/api#api-endpoints-delete">ngrok.com/docs/api#api-endpoints-delete</a></p>
|
1071
|
+
|
1072
|
+
|
1073
|
+
</div>
|
1074
|
+
</div>
|
1075
|
+
<div class="tags">
|
1076
|
+
<p class="tag_title">Parameters:</p>
|
1077
|
+
<ul class="param">
|
1078
|
+
|
1079
|
+
<li>
|
1080
|
+
|
1081
|
+
<span class='name'>id</span>
|
1082
|
+
|
1083
|
+
|
1084
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1085
|
+
|
1086
|
+
|
1087
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1088
|
+
|
1089
|
+
|
1090
|
+
—
|
1091
|
+
<div class='inline'>
|
1092
|
+
<p>a resource identifier</p>
|
1093
|
+
</div>
|
1094
|
+
|
1095
|
+
</li>
|
1096
|
+
|
1097
|
+
</ul>
|
1098
|
+
|
1099
|
+
<p class="tag_title">Returns:</p>
|
1100
|
+
<ul class="return">
|
1101
|
+
|
1102
|
+
<li>
|
1103
|
+
|
1104
|
+
|
1105
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
1106
|
+
|
1107
|
+
|
1108
|
+
|
1109
|
+
—
|
1110
|
+
<div class='inline'>
|
1111
|
+
<p>result from the API request</p>
|
1112
|
+
</div>
|
1113
|
+
|
1114
|
+
</li>
|
1115
|
+
|
1116
|
+
</ul>
|
1117
|
+
|
1118
|
+
</div><table class="source_code">
|
1119
|
+
<tr>
|
1120
|
+
<td>
|
1121
|
+
<pre class="lines">
|
1122
|
+
|
1123
|
+
|
1124
|
+
246
|
1125
|
+
247
|
1126
|
+
248
|
1127
|
+
249
|
1128
|
+
250
|
1129
|
+
251
|
1130
|
+
252</pre>
|
1131
|
+
</td>
|
1132
|
+
<td>
|
1133
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 246</span>
|
1134
|
+
|
1135
|
+
<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>
|
1136
|
+
<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>
|
1137
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1138
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1139
|
+
<span class='rbrace'>}</span>
|
1140
|
+
<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>
|
1141
|
+
<span class='kw'>end</span></pre>
|
1142
|
+
</td>
|
1143
|
+
</tr>
|
1144
|
+
</table>
|
1145
|
+
</div>
|
1146
|
+
|
1147
|
+
<div class="method_details ">
|
1148
|
+
<h3 class="signature " id="get-instance_method">
|
1149
|
+
|
1150
|
+
#<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>
|
1151
|
+
|
1152
|
+
|
1153
|
+
|
1154
|
+
|
1155
|
+
|
1156
|
+
</h3><div class="docstring">
|
1157
|
+
<div class="discussion">
|
1158
|
+
|
1159
|
+
<p>Get the status of an endpoint by ID</p>
|
1160
|
+
|
1161
|
+
<p><a href="https://ngrok.com/docs/api#api-endpoints-get">ngrok.com/docs/api#api-endpoints-get</a></p>
|
1162
|
+
|
1163
|
+
|
1164
|
+
</div>
|
1165
|
+
</div>
|
1166
|
+
<div class="tags">
|
1167
|
+
<p class="tag_title">Parameters:</p>
|
1168
|
+
<ul class="param">
|
1169
|
+
|
1170
|
+
<li>
|
1171
|
+
|
1172
|
+
<span class='name'>id</span>
|
1173
|
+
|
1174
|
+
|
1175
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1176
|
+
|
1177
|
+
|
1178
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1179
|
+
|
1180
|
+
|
1181
|
+
—
|
1182
|
+
<div class='inline'>
|
1183
|
+
<p>a resource identifier</p>
|
1184
|
+
</div>
|
1185
|
+
|
1186
|
+
</li>
|
1187
|
+
|
1188
|
+
</ul>
|
1189
|
+
|
1190
|
+
<p class="tag_title">Returns:</p>
|
1191
|
+
<ul class="return">
|
1192
|
+
|
1193
|
+
<li>
|
1194
|
+
|
1195
|
+
|
1196
|
+
<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>
|
1197
|
+
|
1198
|
+
|
1199
|
+
|
1200
|
+
—
|
1201
|
+
<div class='inline'>
|
1202
|
+
<p>result from the API request</p>
|
1203
|
+
</div>
|
1204
|
+
|
1205
|
+
</li>
|
1206
|
+
|
1207
|
+
</ul>
|
1208
|
+
|
1209
|
+
</div><table class="source_code">
|
1210
|
+
<tr>
|
1211
|
+
<td>
|
1212
|
+
<pre class="lines">
|
1213
|
+
|
1214
|
+
|
1215
|
+
140
|
1216
|
+
141
|
1217
|
+
142
|
1218
|
+
143
|
1219
|
+
144
|
1220
|
+
145
|
1221
|
+
146
|
1222
|
+
147
|
1223
|
+
148</pre>
|
1224
|
+
</td>
|
1225
|
+
<td>
|
1226
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 140</span>
|
1227
|
+
|
1228
|
+
<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>
|
1229
|
+
<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>
|
1230
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1231
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1232
|
+
<span class='rbrace'>}</span>
|
1233
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
1234
|
+
<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>
|
1235
|
+
<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>
|
1236
|
+
<span class='kw'>end</span></pre>
|
1237
|
+
</td>
|
1238
|
+
</tr>
|
1239
|
+
</table>
|
1240
|
+
</div>
|
1241
|
+
|
1242
|
+
<div class="method_details ">
|
1243
|
+
<h3 class="signature " id="get!-instance_method">
|
1244
|
+
|
1245
|
+
#<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>
|
1246
|
+
|
1247
|
+
|
1248
|
+
|
1249
|
+
|
1250
|
+
|
1251
|
+
</h3><div class="docstring">
|
1252
|
+
<div class="discussion">
|
1253
|
+
|
1254
|
+
<p>Get the status of an endpoint by ID Throws an exception if API error.</p>
|
1255
|
+
|
1256
|
+
<p><a href="https://ngrok.com/docs/api#api-endpoints-get">ngrok.com/docs/api#api-endpoints-get</a></p>
|
1257
|
+
|
1258
|
+
|
1259
|
+
</div>
|
1260
|
+
</div>
|
1261
|
+
<div class="tags">
|
1262
|
+
<p class="tag_title">Parameters:</p>
|
1263
|
+
<ul class="param">
|
1264
|
+
|
1265
|
+
<li>
|
1266
|
+
|
1267
|
+
<span class='name'>id</span>
|
1268
|
+
|
1269
|
+
|
1270
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1271
|
+
|
1272
|
+
|
1273
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1274
|
+
|
1275
|
+
|
1276
|
+
—
|
1277
|
+
<div class='inline'>
|
1278
|
+
<p>a resource identifier</p>
|
1279
|
+
</div>
|
1280
|
+
|
1281
|
+
</li>
|
1282
|
+
|
1283
|
+
</ul>
|
1284
|
+
|
1285
|
+
<p class="tag_title">Returns:</p>
|
1286
|
+
<ul class="return">
|
1287
|
+
|
1288
|
+
<li>
|
1289
|
+
|
1290
|
+
|
1291
|
+
<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>
|
1292
|
+
|
1293
|
+
|
1294
|
+
|
1295
|
+
—
|
1296
|
+
<div class='inline'>
|
1297
|
+
<p>result from the API request</p>
|
1298
|
+
</div>
|
1299
|
+
|
1300
|
+
</li>
|
1301
|
+
|
1302
|
+
</ul>
|
1303
|
+
|
1304
|
+
</div><table class="source_code">
|
1305
|
+
<tr>
|
1306
|
+
<td>
|
1307
|
+
<pre class="lines">
|
1308
|
+
|
1309
|
+
|
1310
|
+
158
|
1311
|
+
159
|
1312
|
+
160
|
1313
|
+
161
|
1314
|
+
162
|
1315
|
+
163
|
1316
|
+
164
|
1317
|
+
165
|
1318
|
+
166</pre>
|
1319
|
+
</td>
|
1320
|
+
<td>
|
1321
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 158</span>
|
1322
|
+
|
1323
|
+
<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>
|
1324
|
+
<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>
|
1325
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1326
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1327
|
+
<span class='rbrace'>}</span>
|
1328
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
1329
|
+
<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>
|
1330
|
+
<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>
|
1331
|
+
<span class='kw'>end</span></pre>
|
1332
|
+
</td>
|
1333
|
+
</tr>
|
1334
|
+
</table>
|
1335
|
+
</div>
|
1336
|
+
|
1337
|
+
<div class="method_details ">
|
1338
|
+
<h3 class="signature " id="list-instance_method">
|
1339
|
+
|
1340
|
+
#<strong>list</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
|
1341
|
+
|
1342
|
+
|
1343
|
+
|
1344
|
+
|
1345
|
+
|
1346
|
+
</h3><div class="docstring">
|
1347
|
+
<div class="discussion">
|
1348
|
+
|
1349
|
+
<p>List all active endpoints on the account</p>
|
1350
|
+
|
1351
|
+
<p><a href="https://ngrok.com/docs/api#api-endpoints-list">ngrok.com/docs/api#api-endpoints-list</a></p>
|
1352
|
+
|
1353
|
+
|
1354
|
+
</div>
|
1355
|
+
</div>
|
1356
|
+
<div class="tags">
|
1357
|
+
<p class="tag_title">Parameters:</p>
|
1358
|
+
<ul class="param">
|
1359
|
+
|
1360
|
+
<li>
|
1361
|
+
|
1362
|
+
<span class='name'>before_id</span>
|
1363
|
+
|
1364
|
+
|
1365
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1366
|
+
|
1367
|
+
|
1368
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1369
|
+
|
1370
|
+
|
1371
|
+
</li>
|
1372
|
+
|
1373
|
+
<li>
|
1374
|
+
|
1375
|
+
<span class='name'>limit</span>
|
1376
|
+
|
1377
|
+
|
1378
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1379
|
+
|
1380
|
+
|
1381
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1382
|
+
|
1383
|
+
|
1384
|
+
</li>
|
1385
|
+
|
1386
|
+
<li>
|
1387
|
+
|
1388
|
+
<span class='name'>url</span>
|
1389
|
+
|
1390
|
+
|
1391
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1392
|
+
|
1393
|
+
|
1394
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1395
|
+
|
1396
|
+
|
1397
|
+
—
|
1398
|
+
<div class='inline'>
|
1399
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
1400
|
+
</div>
|
1401
|
+
|
1402
|
+
</li>
|
1403
|
+
|
1404
|
+
</ul>
|
1405
|
+
|
1406
|
+
<p class="tag_title">Returns:</p>
|
1407
|
+
<ul class="return">
|
1408
|
+
|
1409
|
+
<li>
|
1410
|
+
|
1411
|
+
|
1412
|
+
<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>
|
1413
|
+
|
1414
|
+
|
1415
|
+
|
1416
|
+
—
|
1417
|
+
<div class='inline'>
|
1418
|
+
<p>result from the API request</p>
|
1419
|
+
</div>
|
1420
|
+
|
1421
|
+
</li>
|
1422
|
+
|
1423
|
+
</ul>
|
1424
|
+
|
1425
|
+
</div><table class="source_code">
|
1426
|
+
<tr>
|
1427
|
+
<td>
|
1428
|
+
<pre class="lines">
|
1429
|
+
|
1430
|
+
|
1431
|
+
89
|
1432
|
+
90
|
1433
|
+
91
|
1434
|
+
92
|
1435
|
+
93
|
1436
|
+
94
|
1437
|
+
95
|
1438
|
+
96
|
1439
|
+
97
|
1440
|
+
98
|
1441
|
+
99
|
1442
|
+
100
|
1443
|
+
101
|
1444
|
+
102
|
1445
|
+
103</pre>
|
1446
|
+
</td>
|
1447
|
+
<td>
|
1448
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 89</span>
|
1449
|
+
|
1450
|
+
<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>
|
1451
|
+
<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>
|
1452
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
1453
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
1454
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
1455
|
+
<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>
|
1456
|
+
<span class='rparen'>)</span>
|
1457
|
+
|
1458
|
+
<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>
|
1459
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
1460
|
+
<span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
1461
|
+
<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>
|
1462
|
+
<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>
|
1463
|
+
<span class='rparen'>)</span>
|
1464
|
+
<span class='kw'>end</span></pre>
|
1465
|
+
</td>
|
1466
|
+
</tr>
|
1467
|
+
</table>
|
1468
|
+
</div>
|
1469
|
+
|
1470
|
+
<div class="method_details ">
|
1471
|
+
<h3 class="signature " id="list!-instance_method">
|
1472
|
+
|
1473
|
+
#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
|
1474
|
+
|
1475
|
+
|
1476
|
+
|
1477
|
+
|
1478
|
+
|
1479
|
+
</h3><div class="docstring">
|
1480
|
+
<div class="discussion">
|
1481
|
+
|
1482
|
+
<p>List all active endpoints on the account Throws an exception if API error.</p>
|
1483
|
+
|
1484
|
+
<p><a href="https://ngrok.com/docs/api#api-endpoints-list">ngrok.com/docs/api#api-endpoints-list</a></p>
|
1485
|
+
|
1486
|
+
|
1487
|
+
</div>
|
1488
|
+
</div>
|
1489
|
+
<div class="tags">
|
1490
|
+
<p class="tag_title">Parameters:</p>
|
1491
|
+
<ul class="param">
|
1492
|
+
|
1493
|
+
<li>
|
1494
|
+
|
1495
|
+
<span class='name'>before_id</span>
|
1496
|
+
|
1497
|
+
|
1498
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1499
|
+
|
1500
|
+
|
1501
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1502
|
+
|
1503
|
+
|
1504
|
+
</li>
|
1505
|
+
|
1506
|
+
<li>
|
1507
|
+
|
1508
|
+
<span class='name'>limit</span>
|
1509
|
+
|
1510
|
+
|
1511
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1512
|
+
|
1513
|
+
|
1514
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1515
|
+
|
1516
|
+
|
1517
|
+
</li>
|
1518
|
+
|
1519
|
+
<li>
|
1520
|
+
|
1521
|
+
<span class='name'>url</span>
|
1522
|
+
|
1523
|
+
|
1524
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1525
|
+
|
1526
|
+
|
1527
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1528
|
+
|
1529
|
+
|
1530
|
+
—
|
1531
|
+
<div class='inline'>
|
1532
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
1533
|
+
</div>
|
1534
|
+
|
1535
|
+
</li>
|
1536
|
+
|
1537
|
+
</ul>
|
568
1538
|
|
569
1539
|
<p class="tag_title">Returns:</p>
|
570
1540
|
<ul class="return">
|
@@ -572,7 +1542,7 @@
|
|
572
1542
|
<li>
|
573
1543
|
|
574
1544
|
|
575
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
1545
|
+
<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
1546
|
|
577
1547
|
|
578
1548
|
|
@@ -591,27 +1561,43 @@
|
|
591
1561
|
<pre class="lines">
|
592
1562
|
|
593
1563
|
|
594
|
-
|
595
|
-
|
596
|
-
|
597
|
-
|
598
|
-
|
599
|
-
|
600
|
-
|
601
|
-
|
602
|
-
|
1564
|
+
115
|
1565
|
+
116
|
1566
|
+
117
|
1567
|
+
118
|
1568
|
+
119
|
1569
|
+
120
|
1570
|
+
121
|
1571
|
+
122
|
1572
|
+
123
|
1573
|
+
124
|
1574
|
+
125
|
1575
|
+
126
|
1576
|
+
127
|
1577
|
+
128
|
1578
|
+
129
|
1579
|
+
130
|
1580
|
+
131</pre>
|
603
1581
|
</td>
|
604
1582
|
<td>
|
605
|
-
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line
|
1583
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 115</span>
|
606
1584
|
|
607
|
-
<span class='kw'>def</span> <span class='id identifier
|
608
|
-
<span class='id identifier
|
609
|
-
|
610
|
-
<span class='label'>
|
611
|
-
|
612
|
-
|
613
|
-
|
614
|
-
<span class='
|
1585
|
+
<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>
|
1586
|
+
<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>
|
1587
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
1588
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
1589
|
+
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
1590
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
1591
|
+
<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>
|
1592
|
+
<span class='rparen'>)</span>
|
1593
|
+
|
1594
|
+
<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>
|
1595
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
1596
|
+
<span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
1597
|
+
<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>
|
1598
|
+
<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>
|
1599
|
+
<span class='label'>danger:</span> <span class='kw'>true</span>
|
1600
|
+
<span class='rparen'>)</span>
|
615
1601
|
<span class='kw'>end</span></pre>
|
616
1602
|
</td>
|
617
1603
|
</tr>
|
@@ -619,9 +1605,9 @@
|
|
619
1605
|
</div>
|
620
1606
|
|
621
1607
|
<div class="method_details ">
|
622
|
-
<h3 class="signature " id="
|
1608
|
+
<h3 class="signature " id="update-instance_method">
|
623
1609
|
|
624
|
-
#<strong>
|
1610
|
+
#<strong>update</strong>(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil) ⇒ <tt><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">NgrokAPI::Models::Endpoint</a></span></tt>
|
625
1611
|
|
626
1612
|
|
627
1613
|
|
@@ -630,9 +1616,9 @@
|
|
630
1616
|
</h3><div class="docstring">
|
631
1617
|
<div class="discussion">
|
632
1618
|
|
633
|
-
<p>
|
1619
|
+
<p>Update an Endpoint by ID, currently available only for cloud endpoints</p>
|
634
1620
|
|
635
|
-
<p><a href="https://ngrok.com/docs/api#api-endpoints-
|
1621
|
+
<p><a href="https://ngrok.com/docs/api#api-endpoints-update">ngrok.com/docs/api#api-endpoints-update</a></p>
|
636
1622
|
|
637
1623
|
|
638
1624
|
</div>
|
@@ -643,7 +1629,25 @@
|
|
643
1629
|
|
644
1630
|
<li>
|
645
1631
|
|
646
|
-
<span class='name'>
|
1632
|
+
<span class='name'>id</span>
|
1633
|
+
|
1634
|
+
|
1635
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1636
|
+
|
1637
|
+
|
1638
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1639
|
+
|
1640
|
+
|
1641
|
+
—
|
1642
|
+
<div class='inline'>
|
1643
|
+
<p>unique endpoint resource identifier</p>
|
1644
|
+
</div>
|
1645
|
+
|
1646
|
+
</li>
|
1647
|
+
|
1648
|
+
<li>
|
1649
|
+
|
1650
|
+
<span class='name'>url</span>
|
647
1651
|
|
648
1652
|
|
649
1653
|
<span class='type'>(<tt>string</tt>)</span>
|
@@ -652,11 +1656,16 @@
|
|
652
1656
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
653
1657
|
|
654
1658
|
|
1659
|
+
—
|
1660
|
+
<div class='inline'>
|
1661
|
+
<p>the url of the endpoint</p>
|
1662
|
+
</div>
|
1663
|
+
|
655
1664
|
</li>
|
656
1665
|
|
657
1666
|
<li>
|
658
1667
|
|
659
|
-
<span class='name'>
|
1668
|
+
<span class='name'>traffic_policy</span>
|
660
1669
|
|
661
1670
|
|
662
1671
|
<span class='type'>(<tt>string</tt>)</span>
|
@@ -665,11 +1674,16 @@
|
|
665
1674
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
666
1675
|
|
667
1676
|
|
1677
|
+
—
|
1678
|
+
<div class='inline'>
|
1679
|
+
<p>The traffic policy attached to this endpoint</p>
|
1680
|
+
</div>
|
1681
|
+
|
668
1682
|
</li>
|
669
1683
|
|
670
1684
|
<li>
|
671
1685
|
|
672
|
-
<span class='name'>
|
1686
|
+
<span class='name'>description</span>
|
673
1687
|
|
674
1688
|
|
675
1689
|
<span class='type'>(<tt>string</tt>)</span>
|
@@ -680,7 +1694,43 @@
|
|
680
1694
|
|
681
1695
|
—
|
682
1696
|
<div class='inline'>
|
683
|
-
<p>
|
1697
|
+
<p>user-supplied description of the associated tunnel</p>
|
1698
|
+
</div>
|
1699
|
+
|
1700
|
+
</li>
|
1701
|
+
|
1702
|
+
<li>
|
1703
|
+
|
1704
|
+
<span class='name'>metadata</span>
|
1705
|
+
|
1706
|
+
|
1707
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1708
|
+
|
1709
|
+
|
1710
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1711
|
+
|
1712
|
+
|
1713
|
+
—
|
1714
|
+
<div class='inline'>
|
1715
|
+
<p>user-supplied metadata of the associated tunnel or edge object</p>
|
1716
|
+
</div>
|
1717
|
+
|
1718
|
+
</li>
|
1719
|
+
|
1720
|
+
<li>
|
1721
|
+
|
1722
|
+
<span class='name'>bindings</span>
|
1723
|
+
|
1724
|
+
|
1725
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
1726
|
+
|
1727
|
+
|
1728
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1729
|
+
|
1730
|
+
|
1731
|
+
—
|
1732
|
+
<div class='inline'>
|
1733
|
+
<p>the bindings associated with this endpoint</p>
|
684
1734
|
</div>
|
685
1735
|
|
686
1736
|
</li>
|
@@ -693,7 +1743,7 @@
|
|
693
1743
|
<li>
|
694
1744
|
|
695
1745
|
|
696
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
1746
|
+
<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
1747
|
|
698
1748
|
|
699
1749
|
|
@@ -712,39 +1762,37 @@
|
|
712
1762
|
<pre class="lines">
|
713
1763
|
|
714
1764
|
|
715
|
-
|
716
|
-
|
717
|
-
|
718
|
-
|
719
|
-
|
720
|
-
|
721
|
-
|
722
|
-
|
723
|
-
|
724
|
-
|
725
|
-
|
726
|
-
|
727
|
-
|
728
|
-
|
729
|
-
48</pre>
|
1765
|
+
180
|
1766
|
+
181
|
1767
|
+
182
|
1768
|
+
183
|
1769
|
+
184
|
1770
|
+
185
|
1771
|
+
186
|
1772
|
+
187
|
1773
|
+
188
|
1774
|
+
189
|
1775
|
+
190
|
1776
|
+
191
|
1777
|
+
192
|
1778
|
+
193</pre>
|
730
1779
|
</td>
|
731
1780
|
<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>
|
1781
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 180</span>
|
741
1782
|
|
742
|
-
|
743
|
-
|
744
|
-
|
745
|
-
<span class='label'>
|
746
|
-
|
747
|
-
<span class='
|
1783
|
+
<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='rparen'>)</span>
|
1784
|
+
<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>
|
1785
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1786
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1787
|
+
<span class='rbrace'>}</span>
|
1788
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
1789
|
+
<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>
|
1790
|
+
<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>
|
1791
|
+
<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>
|
1792
|
+
<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>
|
1793
|
+
<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>
|
1794
|
+
<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>
|
1795
|
+
<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
1796
|
<span class='kw'>end</span></pre>
|
749
1797
|
</td>
|
750
1798
|
</tr>
|
@@ -752,9 +1800,9 @@
|
|
752
1800
|
</div>
|
753
1801
|
|
754
1802
|
<div class="method_details ">
|
755
|
-
<h3 class="signature " id="
|
1803
|
+
<h3 class="signature " id="update!-instance_method">
|
756
1804
|
|
757
|
-
#<strong>
|
1805
|
+
#<strong>update!</strong>(id: "", url: nil, traffic_policy: nil, description: nil, metadata: nil, bindings: nil) ⇒ <tt><span class='object_link'><a href="../Models/Endpoint.html" title="NgrokAPI::Models::Endpoint (class)">NgrokAPI::Models::Endpoint</a></span></tt>
|
758
1806
|
|
759
1807
|
|
760
1808
|
|
@@ -763,9 +1811,9 @@
|
|
763
1811
|
</h3><div class="docstring">
|
764
1812
|
<div class="discussion">
|
765
1813
|
|
766
|
-
<p>
|
1814
|
+
<p>Update an Endpoint by ID, currently available only for cloud endpoints Throws an exception if API error.</p>
|
767
1815
|
|
768
|
-
<p><a href="https://ngrok.com/docs/api#api-endpoints-
|
1816
|
+
<p><a href="https://ngrok.com/docs/api#api-endpoints-update">ngrok.com/docs/api#api-endpoints-update</a></p>
|
769
1817
|
|
770
1818
|
|
771
1819
|
</div>
|
@@ -776,7 +1824,25 @@
|
|
776
1824
|
|
777
1825
|
<li>
|
778
1826
|
|
779
|
-
<span class='name'>
|
1827
|
+
<span class='name'>id</span>
|
1828
|
+
|
1829
|
+
|
1830
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1831
|
+
|
1832
|
+
|
1833
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
1834
|
+
|
1835
|
+
|
1836
|
+
—
|
1837
|
+
<div class='inline'>
|
1838
|
+
<p>unique endpoint resource identifier</p>
|
1839
|
+
</div>
|
1840
|
+
|
1841
|
+
</li>
|
1842
|
+
|
1843
|
+
<li>
|
1844
|
+
|
1845
|
+
<span class='name'>url</span>
|
780
1846
|
|
781
1847
|
|
782
1848
|
<span class='type'>(<tt>string</tt>)</span>
|
@@ -785,11 +1851,16 @@
|
|
785
1851
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
786
1852
|
|
787
1853
|
|
1854
|
+
—
|
1855
|
+
<div class='inline'>
|
1856
|
+
<p>the url of the endpoint</p>
|
1857
|
+
</div>
|
1858
|
+
|
788
1859
|
</li>
|
789
1860
|
|
790
1861
|
<li>
|
791
1862
|
|
792
|
-
<span class='name'>
|
1863
|
+
<span class='name'>traffic_policy</span>
|
793
1864
|
|
794
1865
|
|
795
1866
|
<span class='type'>(<tt>string</tt>)</span>
|
@@ -798,11 +1869,16 @@
|
|
798
1869
|
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
799
1870
|
|
800
1871
|
|
1872
|
+
—
|
1873
|
+
<div class='inline'>
|
1874
|
+
<p>The traffic policy attached to this endpoint</p>
|
1875
|
+
</div>
|
1876
|
+
|
801
1877
|
</li>
|
802
1878
|
|
803
1879
|
<li>
|
804
1880
|
|
805
|
-
<span class='name'>
|
1881
|
+
<span class='name'>description</span>
|
806
1882
|
|
807
1883
|
|
808
1884
|
<span class='type'>(<tt>string</tt>)</span>
|
@@ -813,7 +1889,43 @@
|
|
813
1889
|
|
814
1890
|
—
|
815
1891
|
<div class='inline'>
|
816
|
-
<p>
|
1892
|
+
<p>user-supplied description of the associated tunnel</p>
|
1893
|
+
</div>
|
1894
|
+
|
1895
|
+
</li>
|
1896
|
+
|
1897
|
+
<li>
|
1898
|
+
|
1899
|
+
<span class='name'>metadata</span>
|
1900
|
+
|
1901
|
+
|
1902
|
+
<span class='type'>(<tt>string</tt>)</span>
|
1903
|
+
|
1904
|
+
|
1905
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1906
|
+
|
1907
|
+
|
1908
|
+
—
|
1909
|
+
<div class='inline'>
|
1910
|
+
<p>user-supplied metadata of the associated tunnel or edge object</p>
|
1911
|
+
</div>
|
1912
|
+
|
1913
|
+
</li>
|
1914
|
+
|
1915
|
+
<li>
|
1916
|
+
|
1917
|
+
<span class='name'>bindings</span>
|
1918
|
+
|
1919
|
+
|
1920
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
1921
|
+
|
1922
|
+
|
1923
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
1924
|
+
|
1925
|
+
|
1926
|
+
—
|
1927
|
+
<div class='inline'>
|
1928
|
+
<p>the bindings associated with this endpoint</p>
|
817
1929
|
</div>
|
818
1930
|
|
819
1931
|
</li>
|
@@ -826,7 +1938,7 @@
|
|
826
1938
|
<li>
|
827
1939
|
|
828
1940
|
|
829
|
-
<span class='type'>(<tt><span class='object_link'><a href="../Models/
|
1941
|
+
<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
1942
|
|
831
1943
|
|
832
1944
|
|
@@ -845,43 +1957,37 @@
|
|
845
1957
|
<pre class="lines">
|
846
1958
|
|
847
1959
|
|
848
|
-
|
849
|
-
|
850
|
-
|
851
|
-
|
852
|
-
|
853
|
-
|
854
|
-
|
855
|
-
|
856
|
-
|
857
|
-
|
858
|
-
|
859
|
-
|
860
|
-
|
861
|
-
|
862
|
-
74
|
863
|
-
75
|
864
|
-
76</pre>
|
1960
|
+
208
|
1961
|
+
209
|
1962
|
+
210
|
1963
|
+
211
|
1964
|
+
212
|
1965
|
+
213
|
1966
|
+
214
|
1967
|
+
215
|
1968
|
+
216
|
1969
|
+
217
|
1970
|
+
218
|
1971
|
+
219
|
1972
|
+
220
|
1973
|
+
221</pre>
|
865
1974
|
</td>
|
866
1975
|
<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>
|
1976
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/endpoints_client.rb', line 208</span>
|
877
1977
|
|
878
|
-
|
879
|
-
|
880
|
-
|
881
|
-
<span class='label'>
|
882
|
-
|
883
|
-
|
884
|
-
<span class='
|
1978
|
+
<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='rparen'>)</span>
|
1979
|
+
<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>
|
1980
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
1981
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
1982
|
+
<span class='rbrace'>}</span>
|
1983
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
1984
|
+
<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>
|
1985
|
+
<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>
|
1986
|
+
<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>
|
1987
|
+
<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>
|
1988
|
+
<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>
|
1989
|
+
<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>
|
1990
|
+
<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
1991
|
<span class='kw'>end</span></pre>
|
886
1992
|
</td>
|
887
1993
|
</tr>
|
@@ -893,9 +1999,9 @@
|
|
893
1999
|
</div>
|
894
2000
|
|
895
2001
|
<div id="footer">
|
896
|
-
Generated on
|
2002
|
+
Generated on Thu Oct 24 20:57:26 2024 by
|
897
2003
|
<a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
898
|
-
0.9.36 (ruby-3.3.
|
2004
|
+
0.9.36 (ruby-3.3.5).
|
899
2005
|
</div>
|
900
2006
|
|
901
2007
|
</div>
|