ngrok-api 0.14.0 → 0.17.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/.rubocop.yml +1 -1
- data/doc/NgrokAPI/Client.html +325 -267
- data/doc/NgrokAPI/Error.html +3 -3
- data/doc/NgrokAPI/Errors/NotFoundError.html +3 -3
- data/doc/NgrokAPI/Errors.html +3 -3
- data/doc/NgrokAPI/HttpClient.html +30 -36
- data/doc/NgrokAPI/Models/APIKey.html +3 -3
- data/doc/NgrokAPI/Models/AWSAuth.html +3 -3
- data/doc/NgrokAPI/Models/AWSCredentials.html +3 -3
- data/doc/NgrokAPI/Models/AWSRole.html +3 -3
- data/doc/NgrokAPI/Models/AbuseReport.html +3 -3
- data/doc/NgrokAPI/Models/AbuseReportHostname.html +3 -3
- data/doc/NgrokAPI/Models/AgentIngress.html +1217 -0
- data/doc/NgrokAPI/Models/CertificateAuthority.html +3 -3
- data/doc/NgrokAPI/Models/Credential.html +3 -3
- data/doc/NgrokAPI/Models/Endpoint.html +1431 -0
- data/doc/NgrokAPI/Models/{EndpointLogging.html → EndpointBackend.html} +42 -42
- data/{docs/NgrokAPI/Models/EndpointLoggingMutate.html → doc/NgrokAPI/Models/EndpointBackendMutate.html} +42 -42
- data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +3 -3
- data/doc/NgrokAPI/Models/EndpointCompression.html +3 -3
- data/doc/NgrokAPI/Models/EndpointIPPolicy.html +3 -3
- data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +3 -3
- data/doc/NgrokAPI/Models/EndpointMutualTLS.html +3 -3
- data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuth.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +3 -3
- data/doc/NgrokAPI/Models/EndpointOIDC.html +3 -3
- data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +3 -3
- data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +3 -3
- data/doc/NgrokAPI/Models/EndpointSAML.html +3 -3
- data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +3 -3
- data/doc/NgrokAPI/Models/EndpointTLSTermination.html +3 -3
- data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +617 -0
- data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +3 -3
- data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +543 -0
- data/doc/NgrokAPI/Models/EventDestination.html +7 -7
- data/doc/NgrokAPI/Models/EventSource.html +3 -3
- data/doc/NgrokAPI/Models/EventSourceList.html +3 -3
- data/doc/NgrokAPI/Models/EventSourceReplace.html +3 -3
- data/doc/NgrokAPI/Models/EventSubscription.html +3 -3
- data/doc/NgrokAPI/Models/EventTarget.html +3 -3
- data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +3 -3
- data/doc/NgrokAPI/Models/EventTargetFirehose.html +3 -3
- data/doc/NgrokAPI/Models/EventTargetKinesis.html +3 -3
- data/doc/NgrokAPI/Models/FailoverBackend.html +1075 -0
- data/doc/NgrokAPI/Models/HTTPResponseBackend.html +1231 -0
- data/{docs/NgrokAPI/Models/EventStream.html → doc/NgrokAPI/Models/HTTPSEdge.html} +119 -119
- data/doc/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +203 -265
- data/doc/NgrokAPI/Models/IPPolicy.html +3 -3
- data/doc/NgrokAPI/Models/IPPolicyRule.html +97 -23
- data/doc/NgrokAPI/Models/IPRestriction.html +3 -3
- data/doc/NgrokAPI/Models/Listable.html +3 -3
- data/doc/NgrokAPI/Models/Ref.html +3 -3
- data/doc/NgrokAPI/Models/ReservedAddr.html +3 -3
- data/doc/NgrokAPI/Models/ReservedDomain.html +3 -3
- data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +3 -3
- data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +3 -3
- data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +3 -3
- data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +3 -3
- data/doc/NgrokAPI/Models/SSHCredential.html +3 -3
- data/doc/NgrokAPI/Models/SSHHostCertificate.html +3 -3
- data/doc/NgrokAPI/Models/SSHUserCertificate.html +3 -3
- data/doc/NgrokAPI/Models/TCPEdge.html +1235 -0
- data/doc/NgrokAPI/Models/TLSCertificate.html +3 -3
- data/doc/NgrokAPI/Models/TLSCertificateSANs.html +3 -3
- data/doc/NgrokAPI/Models/TLSEdge.html +1395 -0
- data/doc/NgrokAPI/Models/Tunnel.html +314 -18
- data/doc/NgrokAPI/Models/TunnelGroupBackend.html +1149 -0
- data/doc/NgrokAPI/Models/TunnelSession.html +3 -3
- data/doc/NgrokAPI/Models/{IPWhitelistEntry.html → WeightedBackend.html} +80 -74
- data/doc/NgrokAPI/Models.html +5 -5
- data/doc/NgrokAPI/PagedIterator.html +3 -3
- data/doc/NgrokAPI/Services/APIKeysClient.html +99 -149
- data/doc/NgrokAPI/Services/AbuseReportsClient.html +19 -33
- data/doc/NgrokAPI/Services/{IPWhitelistClient.html → AgentIngressesClient.html} +209 -265
- data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +104 -156
- data/doc/NgrokAPI/Services/CredentialsClient.html +108 -164
- data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1153 -0
- data/{docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html → doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html} +177 -95
- data/doc/NgrokAPI/Services/{EndpointCompressionModuleClient.html → EdgeRouteCompressionModuleClient.html} +177 -95
- data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +1153 -0
- data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +1153 -0
- data/{docs/NgrokAPI/Services/EndpointOIDCModuleClient.html → doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html} +177 -95
- data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1153 -0
- data/{docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html → doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html} +177 -95
- data/{docs/NgrokAPI/Services/EndpointSAMLModuleClient.html → doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html} +177 -95
- data/doc/NgrokAPI/Services/{EndpointWebhookValidationModuleClient.html → EdgeRouteWebhookVerificationModuleClient.html} +177 -95
- data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1153 -0
- data/doc/NgrokAPI/Services/{EventStreamsClient.html → EdgesHTTPSClient.html} +248 -353
- data/{docs/NgrokAPI/Services/EndpointConfigurationsClient.html → doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html} +461 -761
- data/doc/NgrokAPI/Services/EdgesTCPClient.html +1757 -0
- data/doc/NgrokAPI/Services/EdgesTLSClient.html +1847 -0
- data/doc/NgrokAPI/Services/EndpointsClient.html +907 -0
- data/doc/NgrokAPI/Services/EventDestinationsClient.html +119 -187
- data/doc/NgrokAPI/Services/EventSourcesClient.html +95 -157
- data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +116 -178
- data/doc/NgrokAPI/Services/FailoverBackendsClient.html +1644 -0
- data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +1744 -0
- data/doc/NgrokAPI/Services/{EndpointSAMLModuleClient.html → HTTPSEdgeMutualTLSModuleClient.html} +101 -129
- data/doc/NgrokAPI/Services/{EndpointRequestHeadersModuleClient.html → HTTPSEdgeTLSTerminationModuleClient.html} +101 -129
- data/doc/NgrokAPI/Services/IPPoliciesClient.html +114 -184
- data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +126 -164
- data/doc/NgrokAPI/Services/IPRestrictionsClient.html +117 -181
- data/doc/NgrokAPI/Services/ReservedAddrsClient.html +117 -473
- data/doc/NgrokAPI/Services/ReservedDomainsClient.html +209 -899
- data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +110 -166
- data/doc/NgrokAPI/Services/SSHCredentialsClient.html +111 -169
- data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +111 -171
- data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +111 -175
- data/{docs/NgrokAPI/Services/EndpointLoggingModuleClient.html → doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html} +101 -129
- data/{docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html → doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html} +83 -111
- data/doc/NgrokAPI/Services/TLSCertificatesClient.html +107 -161
- data/doc/NgrokAPI/Services/{EndpointLoggingModuleClient.html → TLSEdgeBackendModuleClient.html} +101 -129
- data/doc/NgrokAPI/Services/{EndpointIPPolicyModuleClient.html → TLSEdgeIPRestrictionModuleClient.html} +83 -111
- data/{docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html → doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html} +83 -111
- data/{docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html → doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html} +83 -111
- data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +1644 -0
- data/doc/NgrokAPI/Services/TunnelSessionsClient.html +87 -135
- data/doc/NgrokAPI/Services/TunnelsClient.html +252 -26
- data/doc/NgrokAPI/Services/WeightedBackendsClient.html +1644 -0
- data/doc/NgrokAPI/Services.html +5 -5
- data/doc/NgrokAPI.html +4 -4
- data/doc/_index.html +253 -76
- data/doc/class_list.html +1 -1
- data/doc/file.README.html +3 -3
- data/doc/frames.html +1 -1
- data/doc/index.html +3 -3
- data/doc/method_list.html +3559 -1583
- data/doc/top-level-namespace.html +3 -3
- data/docs/CNAME +1 -0
- data/docs/NgrokAPI/Client.html +325 -267
- data/docs/NgrokAPI/Error.html +3 -3
- data/docs/NgrokAPI/Errors/NotFoundError.html +3 -3
- data/docs/NgrokAPI/Errors.html +3 -3
- data/docs/NgrokAPI/HttpClient.html +30 -36
- data/docs/NgrokAPI/Models/APIKey.html +3 -3
- data/docs/NgrokAPI/Models/AWSAuth.html +3 -3
- data/docs/NgrokAPI/Models/AWSCredentials.html +3 -3
- data/docs/NgrokAPI/Models/AWSRole.html +3 -3
- data/docs/NgrokAPI/Models/AbuseReport.html +3 -3
- data/docs/NgrokAPI/Models/AbuseReportHostname.html +3 -3
- data/docs/NgrokAPI/Models/AgentIngress.html +1217 -0
- data/docs/NgrokAPI/Models/CertificateAuthority.html +3 -3
- data/docs/NgrokAPI/Models/Credential.html +3 -3
- data/docs/NgrokAPI/Models/Endpoint.html +1431 -0
- data/docs/NgrokAPI/Models/{EndpointLogging.html → EndpointBackend.html} +42 -42
- data/{doc/NgrokAPI/Models/EndpointLoggingMutate.html → docs/NgrokAPI/Models/EndpointBackendMutate.html} +42 -42
- data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +3 -3
- data/docs/NgrokAPI/Models/EndpointCompression.html +3 -3
- data/docs/NgrokAPI/Models/EndpointIPPolicy.html +3 -3
- data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +3 -3
- data/docs/NgrokAPI/Models/EndpointMutualTLS.html +3 -3
- data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuth.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +3 -3
- data/docs/NgrokAPI/Models/EndpointOIDC.html +3 -3
- data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +3 -3
- data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +3 -3
- data/docs/NgrokAPI/Models/EndpointSAML.html +3 -3
- data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +3 -3
- data/docs/NgrokAPI/Models/EndpointTLSTermination.html +3 -3
- data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +617 -0
- data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +3 -3
- data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +543 -0
- data/docs/NgrokAPI/Models/EventDestination.html +7 -7
- data/docs/NgrokAPI/Models/EventSource.html +3 -3
- data/docs/NgrokAPI/Models/EventSourceList.html +3 -3
- data/docs/NgrokAPI/Models/EventSourceReplace.html +3 -3
- data/docs/NgrokAPI/Models/EventSubscription.html +3 -3
- data/docs/NgrokAPI/Models/EventTarget.html +3 -3
- data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +3 -3
- data/docs/NgrokAPI/Models/EventTargetFirehose.html +3 -3
- data/docs/NgrokAPI/Models/EventTargetKinesis.html +3 -3
- data/docs/NgrokAPI/Models/FailoverBackend.html +1075 -0
- data/docs/NgrokAPI/Models/HTTPResponseBackend.html +1231 -0
- data/{doc/NgrokAPI/Models/EventStream.html → docs/NgrokAPI/Models/HTTPSEdge.html} +119 -119
- data/docs/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +203 -265
- data/docs/NgrokAPI/Models/IPPolicy.html +3 -3
- data/docs/NgrokAPI/Models/IPPolicyRule.html +97 -23
- data/docs/NgrokAPI/Models/IPRestriction.html +3 -3
- data/docs/NgrokAPI/Models/Listable.html +3 -3
- data/docs/NgrokAPI/Models/Ref.html +3 -3
- data/docs/NgrokAPI/Models/ReservedAddr.html +3 -3
- data/docs/NgrokAPI/Models/ReservedDomain.html +3 -3
- data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +3 -3
- data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +3 -3
- data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +3 -3
- data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +3 -3
- data/docs/NgrokAPI/Models/SSHCredential.html +3 -3
- data/docs/NgrokAPI/Models/SSHHostCertificate.html +3 -3
- data/docs/NgrokAPI/Models/SSHUserCertificate.html +3 -3
- data/docs/NgrokAPI/Models/TCPEdge.html +1235 -0
- data/docs/NgrokAPI/Models/TLSCertificate.html +3 -3
- data/docs/NgrokAPI/Models/TLSCertificateSANs.html +3 -3
- data/docs/NgrokAPI/Models/TLSEdge.html +1395 -0
- data/docs/NgrokAPI/Models/Tunnel.html +314 -18
- data/docs/NgrokAPI/Models/TunnelGroupBackend.html +1149 -0
- data/docs/NgrokAPI/Models/TunnelSession.html +3 -3
- data/docs/NgrokAPI/Models/{IPWhitelistEntry.html → WeightedBackend.html} +80 -74
- data/docs/NgrokAPI/Models.html +5 -5
- data/docs/NgrokAPI/PagedIterator.html +3 -3
- data/docs/NgrokAPI/Services/APIKeysClient.html +99 -149
- data/docs/NgrokAPI/Services/AbuseReportsClient.html +19 -33
- data/docs/NgrokAPI/Services/{IPWhitelistClient.html → AgentIngressesClient.html} +209 -265
- data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +104 -156
- data/docs/NgrokAPI/Services/CredentialsClient.html +108 -164
- data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1153 -0
- data/{doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html → docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html} +177 -95
- data/docs/NgrokAPI/Services/{EndpointCompressionModuleClient.html → EdgeRouteCompressionModuleClient.html} +177 -95
- data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +1153 -0
- data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +1153 -0
- data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +1153 -0
- data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1153 -0
- data/{doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html → docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html} +177 -95
- data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +1153 -0
- data/docs/NgrokAPI/Services/{EndpointWebhookValidationModuleClient.html → EdgeRouteWebhookVerificationModuleClient.html} +177 -95
- data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1153 -0
- data/docs/NgrokAPI/Services/{EventStreamsClient.html → EdgesHTTPSClient.html} +248 -353
- data/{doc/NgrokAPI/Services/EndpointConfigurationsClient.html → docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html} +461 -761
- data/docs/NgrokAPI/Services/EdgesTCPClient.html +1757 -0
- data/docs/NgrokAPI/Services/EdgesTLSClient.html +1847 -0
- data/docs/NgrokAPI/Services/EndpointsClient.html +907 -0
- data/docs/NgrokAPI/Services/EventDestinationsClient.html +119 -187
- data/docs/NgrokAPI/Services/EventSourcesClient.html +95 -157
- data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +116 -178
- data/docs/NgrokAPI/Services/FailoverBackendsClient.html +1644 -0
- data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +1744 -0
- data/{doc/NgrokAPI/Services/EndpointOIDCModuleClient.html → docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html} +101 -129
- data/docs/NgrokAPI/Services/{EndpointRequestHeadersModuleClient.html → HTTPSEdgeTLSTerminationModuleClient.html} +101 -129
- data/docs/NgrokAPI/Services/IPPoliciesClient.html +114 -184
- data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +126 -164
- data/docs/NgrokAPI/Services/IPRestrictionsClient.html +117 -181
- data/docs/NgrokAPI/Services/ReservedAddrsClient.html +117 -473
- data/docs/NgrokAPI/Services/ReservedDomainsClient.html +209 -899
- data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +110 -166
- data/docs/NgrokAPI/Services/SSHCredentialsClient.html +111 -169
- data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +111 -171
- data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +111 -175
- data/{doc/NgrokAPI/Services/EndpointOAuthModuleClient.html → docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html} +101 -129
- data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +1043 -0
- data/docs/NgrokAPI/Services/TLSCertificatesClient.html +107 -161
- data/docs/NgrokAPI/Services/{EndpointOAuthModuleClient.html → TLSEdgeBackendModuleClient.html} +101 -129
- data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +1043 -0
- data/{doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html → docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html} +83 -111
- data/{doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html → docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html} +83 -111
- data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +1644 -0
- data/docs/NgrokAPI/Services/TunnelSessionsClient.html +87 -135
- data/docs/NgrokAPI/Services/TunnelsClient.html +252 -26
- data/docs/NgrokAPI/Services/WeightedBackendsClient.html +1644 -0
- data/docs/NgrokAPI/Services.html +5 -5
- data/docs/NgrokAPI.html +4 -4
- data/docs/_index.html +253 -76
- data/docs/class_list.html +1 -1
- data/docs/file.README.html +3 -3
- data/docs/frames.html +1 -1
- data/docs/index.html +3 -3
- data/docs/method_list.html +3559 -1583
- data/docs/top-level-namespace.html +3 -3
- data/lib/ngrokapi/client.rb +52 -37
- data/lib/ngrokapi/http_client.rb +1 -4
- data/lib/ngrokapi/models/{ip_whitelist_entry.rb → agent_ingress.rb} +13 -9
- data/lib/ngrokapi/models/endpoint.rb +49 -0
- data/lib/ngrokapi/models/{endpoint_logging.rb → endpoint_backend.rb} +3 -3
- data/lib/ngrokapi/models/{endpoint_logging_mutate.rb → endpoint_backend_mutate.rb} +3 -3
- data/lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb +27 -0
- data/lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb +25 -0
- data/lib/ngrokapi/models/event_destination.rb +1 -2
- data/lib/ngrokapi/models/{event_stream.rb → failover_backend.rb} +15 -27
- data/lib/ngrokapi/models/http_response_backend.rb +71 -0
- data/lib/ngrokapi/models/https_edge.rb +80 -0
- data/lib/ngrokapi/models/{endpoint_configuration.rb → https_edge_route.rb} +56 -53
- data/lib/ngrokapi/models/ip_policy_rule.rb +3 -1
- data/lib/ngrokapi/models/tcp_edge.rb +78 -0
- data/lib/ngrokapi/models/tls_edge.rb +88 -0
- data/lib/ngrokapi/models/tunnel.rb +9 -1
- data/lib/ngrokapi/models/tunnel_group_backend.rb +67 -0
- data/lib/ngrokapi/models/weighted_backend.rb +65 -0
- data/lib/ngrokapi/services/abuse_reports_client.rb +3 -10
- data/lib/ngrokapi/services/agent_ingresses_client.rb +206 -0
- data/lib/ngrokapi/services/api_keys_client.rb +11 -36
- data/lib/ngrokapi/services/certificate_authorities_client.rb +11 -37
- data/lib/ngrokapi/services/credentials_client.rb +11 -39
- data/lib/ngrokapi/services/edge_route_backend_module_client.rb +120 -0
- data/lib/ngrokapi/services/{endpoint_circuit_breaker_module_client.rb → edge_route_circuit_breaker_module_client.rb} +37 -39
- data/lib/ngrokapi/services/{endpoint_compression_module_client.rb → edge_route_compression_module_client.rb} +37 -39
- data/lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb +120 -0
- data/lib/ngrokapi/services/{endpoint_o_auth_module_client.rb → edge_route_o_auth_module_client.rb} +37 -39
- data/lib/ngrokapi/services/{endpoint_oidc_module_client.rb → edge_route_oidc_module_client.rb} +37 -39
- data/lib/ngrokapi/services/{endpoint_request_headers_module_client.rb → edge_route_request_headers_module_client.rb} +37 -39
- data/lib/ngrokapi/services/{endpoint_response_headers_module_client.rb → edge_route_response_headers_module_client.rb} +37 -39
- data/lib/ngrokapi/services/{endpoint_saml_module_client.rb → edge_route_saml_module_client.rb} +37 -39
- data/lib/ngrokapi/services/{endpoint_webhook_validation_module_client.rb → edge_route_webhook_verification_module_client.rb} +37 -39
- data/lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb +120 -0
- data/lib/ngrokapi/services/edges_https_client.rb +227 -0
- data/lib/ngrokapi/services/edges_https_routes_client.rb +244 -0
- data/lib/ngrokapi/services/edges_tcp_client.rb +227 -0
- data/lib/ngrokapi/services/edges_tls_client.rb +239 -0
- data/lib/ngrokapi/services/endpoints_client.rb +114 -0
- data/lib/ngrokapi/services/event_destinations_client.rb +13 -49
- data/lib/ngrokapi/services/event_sources_client.rb +9 -40
- data/lib/ngrokapi/services/event_subscriptions_client.rb +14 -45
- data/lib/ngrokapi/services/failover_backends_client.rb +214 -0
- data/lib/ngrokapi/services/http_response_backends_client.rb +199 -0
- data/lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb +108 -0
- data/lib/ngrokapi/services/https_edge_tls_termination_module_client.rb +108 -0
- data/lib/ngrokapi/services/ip_policies_client.rb +11 -39
- data/lib/ngrokapi/services/ip_policy_rules_client.rb +13 -40
- data/lib/ngrokapi/services/ip_restrictions_client.rb +12 -44
- data/lib/ngrokapi/services/reserved_addrs_client.rb +11 -81
- data/lib/ngrokapi/services/reserved_domains_client.rb +15 -144
- data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +11 -39
- data/lib/ngrokapi/services/ssh_credentials_client.rb +11 -40
- data/lib/ngrokapi/services/ssh_host_certificates_client.rb +11 -41
- data/lib/ngrokapi/services/ssh_user_certificates_client.rb +11 -43
- data/lib/ngrokapi/services/{endpoint_logging_module_client.rb → tcp_edge_backend_module_client.rb} +31 -45
- data/lib/ngrokapi/services/{endpoint_ip_policy_module_client.rb → tcp_edge_ip_restriction_module_client.rb} +21 -35
- data/lib/ngrokapi/services/tls_certificates_client.rb +11 -38
- data/lib/ngrokapi/services/tls_edge_backend_module_client.rb +108 -0
- data/lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb +108 -0
- data/lib/ngrokapi/services/{endpoint_mutual_tls_module_client.rb → tls_edge_mutual_tls_module_client.rb} +21 -35
- data/lib/ngrokapi/services/{endpoint_tls_termination_module_client.rb → tls_edge_tls_termination_module_client.rb} +21 -35
- data/lib/ngrokapi/services/{ip_whitelist_client.rb → tunnel_group_backends_client.rb} +70 -93
- data/lib/ngrokapi/services/tunnel_sessions_client.rb +12 -36
- data/lib/ngrokapi/services/tunnels_client.rb +39 -10
- data/lib/ngrokapi/services/weighted_backends_client.rb +214 -0
- data/lib/ngrokapi/version.rb +1 -1
- data/lib/ngrokapi.rb +1 -1
- data/ngrok-api.gemspec +1 -1
- data/spec/ngrokapi/client_spec.rb +50 -29
- data/spec/ngrokapi/models/agent_ingress_spec.rb +42 -0
- data/spec/ngrokapi/models/endpoint_backend_mutate_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_backend_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_tls_termination_at_edge_spec.rb +21 -0
- data/spec/ngrokapi/models/endpoint_websocket_tcp_converter_spec.rb +21 -0
- data/spec/ngrokapi/models/failover_backend_spec.rb +45 -0
- data/spec/ngrokapi/models/http_response_backend_spec.rb +51 -0
- data/spec/ngrokapi/models/https_edge_route_spec.rb +81 -0
- data/spec/ngrokapi/models/https_edge_spec.rb +51 -0
- data/spec/ngrokapi/models/tcp_edge_spec.rb +51 -0
- data/spec/ngrokapi/models/tls_edge_spec.rb +57 -0
- data/spec/ngrokapi/models/tunnel_group_backend_spec.rb +45 -0
- data/spec/ngrokapi/models/weighted_backend_spec.rb +45 -0
- data/spec/ngrokapi/services/{ip_whitelist_client_spec.rb → agent_ingresses_client_spec.rb} +49 -49
- data/spec/ngrokapi/services/edge_route_backend_module_client_spec.rb +139 -0
- data/spec/ngrokapi/services/{endpoint_circuit_breaker_module_client_spec.rb → edge_route_circuit_breaker_module_client_spec.rb} +31 -17
- data/spec/ngrokapi/services/{endpoint_compression_module_client_spec.rb → edge_route_compression_module_client_spec.rb} +31 -17
- data/spec/ngrokapi/services/edge_route_ip_restriction_module_client_spec.rb +139 -0
- data/spec/ngrokapi/services/{endpoint_o_auth_module_client_spec.rb → edge_route_o_auth_module_client_spec.rb} +31 -17
- data/spec/ngrokapi/services/{endpoint_oidc_module_client_spec.rb → edge_route_oidc_module_client_spec.rb} +31 -17
- data/spec/ngrokapi/services/{endpoint_request_headers_module_client_spec.rb → edge_route_request_headers_module_client_spec.rb} +31 -17
- data/spec/ngrokapi/services/{endpoint_response_headers_module_client_spec.rb → edge_route_response_headers_module_client_spec.rb} +31 -17
- data/spec/ngrokapi/services/{endpoint_saml_module_client_spec.rb → edge_route_saml_module_client_spec.rb} +31 -17
- data/spec/ngrokapi/services/{endpoint_webhook_validation_module_client_spec.rb → edge_route_webhook_verification_module_client_spec.rb} +31 -17
- data/spec/ngrokapi/services/edge_route_websocket_tcp_converter_module_client_spec.rb +139 -0
- data/spec/ngrokapi/services/{event_streams_client_spec.rb → edges_https_client_spec.rb} +106 -108
- data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +241 -0
- data/spec/ngrokapi/services/edges_tcp_client_spec.rb +175 -0
- data/spec/ngrokapi/services/edges_tls_client_spec.rb +187 -0
- data/spec/ngrokapi/services/endpoints_client_spec.rb +57 -0
- data/spec/ngrokapi/services/failover_backends_client_spec.rb +163 -0
- data/spec/ngrokapi/services/http_response_backends_client_spec.rb +175 -0
- data/spec/ngrokapi/services/{endpoint_mutual_tls_module_client_spec.rb → https_edge_mutual_tls_module_client_spec.rb} +17 -17
- data/spec/ngrokapi/services/{endpoint_tls_termination_module_client_spec.rb → https_edge_tls_termination_module_client_spec.rb} +17 -17
- data/spec/ngrokapi/services/ip_policies_client_spec.rb +0 -1
- data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +3 -1
- data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +0 -44
- data/spec/ngrokapi/services/reserved_domains_client_spec.rb +0 -88
- data/spec/ngrokapi/services/{endpoint_logging_module_client_spec.rb → tcp_edge_backend_module_client_spec.rb} +40 -40
- data/spec/ngrokapi/services/{endpoint_ip_policy_module_client_spec.rb → tcp_edge_ip_restriction_module_client_spec.rb} +17 -17
- data/spec/ngrokapi/services/tls_edge_backend_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/tls_edge_ip_restriction_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/tls_edge_mutual_tls_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/tls_edge_tls_termination_module_client_spec.rb +125 -0
- data/spec/ngrokapi/services/tunnel_group_backends_client_spec.rb +163 -0
- data/spec/ngrokapi/services/tunnels_client_spec.rb +36 -0
- data/spec/ngrokapi/services/weighted_backends_client_spec.rb +163 -0
- data/spec/spec_helper.rb +1389 -1045
- metadata +176 -83
- data/lib/ngrokapi/services/endpoint_configurations_client.rb +0 -357
- data/lib/ngrokapi/services/event_streams_client.rb +0 -259
- data/spec/ngrokapi/models/endpoint_configuration_spec.rb +0 -78
- data/spec/ngrokapi/models/endpoint_logging_mutate_spec.rb +0 -21
- data/spec/ngrokapi/models/endpoint_logging_spec.rb +0 -21
- data/spec/ngrokapi/models/event_stream_spec.rb +0 -51
- data/spec/ngrokapi/models/ip_whitelist_entry_spec.rb +0 -42
- data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +0 -237
|
@@ -0,0 +1,1757 @@
|
|
|
1
|
+
<!DOCTYPE html>
|
|
2
|
+
<html>
|
|
3
|
+
<head>
|
|
4
|
+
<meta charset="utf-8">
|
|
5
|
+
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
6
|
+
<title>
|
|
7
|
+
Class: NgrokAPI::Services::EdgesTCPClient
|
|
8
|
+
|
|
9
|
+
— Documentation by YARD 0.9.27
|
|
10
|
+
|
|
11
|
+
</title>
|
|
12
|
+
|
|
13
|
+
<link rel="stylesheet" href="../../css/style.css" type="text/css" />
|
|
14
|
+
|
|
15
|
+
<link rel="stylesheet" href="../../css/common.css" type="text/css" />
|
|
16
|
+
|
|
17
|
+
<script type="text/javascript">
|
|
18
|
+
pathId = "NgrokAPI::Services::EdgesTCPClient";
|
|
19
|
+
relpath = '../../';
|
|
20
|
+
</script>
|
|
21
|
+
|
|
22
|
+
|
|
23
|
+
<script type="text/javascript" charset="utf-8" src="../../js/jquery.js"></script>
|
|
24
|
+
|
|
25
|
+
<script type="text/javascript" charset="utf-8" src="../../js/app.js"></script>
|
|
26
|
+
|
|
27
|
+
|
|
28
|
+
</head>
|
|
29
|
+
<body>
|
|
30
|
+
<div class="nav_wrap">
|
|
31
|
+
<iframe id="nav" src="../../class_list.html?1"></iframe>
|
|
32
|
+
<div id="resizer"></div>
|
|
33
|
+
</div>
|
|
34
|
+
|
|
35
|
+
<div id="main" tabindex="-1">
|
|
36
|
+
<div id="header">
|
|
37
|
+
<div id="menu">
|
|
38
|
+
|
|
39
|
+
<a href="../../_index.html">Index (E)</a> »
|
|
40
|
+
<span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> » <span class='title'><span class='object_link'><a href="../Services.html" title="NgrokAPI::Services (module)">Services</a></span></span>
|
|
41
|
+
»
|
|
42
|
+
<span class="title">EdgesTCPClient</span>
|
|
43
|
+
|
|
44
|
+
</div>
|
|
45
|
+
|
|
46
|
+
<div id="search">
|
|
47
|
+
|
|
48
|
+
<a class="full_list_link" id="class_list_link"
|
|
49
|
+
href="../../class_list.html">
|
|
50
|
+
|
|
51
|
+
<svg width="24" height="24">
|
|
52
|
+
<rect x="0" y="4" width="24" height="4" rx="1" ry="1"></rect>
|
|
53
|
+
<rect x="0" y="12" width="24" height="4" rx="1" ry="1"></rect>
|
|
54
|
+
<rect x="0" y="20" width="24" height="4" rx="1" ry="1"></rect>
|
|
55
|
+
</svg>
|
|
56
|
+
</a>
|
|
57
|
+
|
|
58
|
+
</div>
|
|
59
|
+
<div class="clear"></div>
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
<div id="content"><h1>Class: NgrokAPI::Services::EdgesTCPClient
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
</h1>
|
|
67
|
+
<div class="box_info">
|
|
68
|
+
|
|
69
|
+
<dl>
|
|
70
|
+
<dt>Inherits:</dt>
|
|
71
|
+
<dd>
|
|
72
|
+
<span class="inheritName">Object</span>
|
|
73
|
+
|
|
74
|
+
<ul class="fullTree">
|
|
75
|
+
<li>Object</li>
|
|
76
|
+
|
|
77
|
+
<li class="next">NgrokAPI::Services::EdgesTCPClient</li>
|
|
78
|
+
|
|
79
|
+
</ul>
|
|
80
|
+
<a href="#" class="inheritanceTree">show all</a>
|
|
81
|
+
|
|
82
|
+
</dd>
|
|
83
|
+
</dl>
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
|
|
87
|
+
|
|
88
|
+
|
|
89
|
+
|
|
90
|
+
|
|
91
|
+
|
|
92
|
+
|
|
93
|
+
|
|
94
|
+
|
|
95
|
+
<dl>
|
|
96
|
+
<dt>Defined in:</dt>
|
|
97
|
+
<dd>lib/ngrokapi/services/edges_tcp_client.rb</dd>
|
|
98
|
+
</dl>
|
|
99
|
+
|
|
100
|
+
</div>
|
|
101
|
+
|
|
102
|
+
<h2>Overview</h2><div class="docstring">
|
|
103
|
+
<div class="discussion">
|
|
104
|
+
|
|
105
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-tcp">ngrok.com/docs/api#api-edges-tcp</a></p>
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
</div>
|
|
109
|
+
</div>
|
|
110
|
+
<div class="tags">
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
</div>
|
|
114
|
+
|
|
115
|
+
<h2>
|
|
116
|
+
Constant Summary
|
|
117
|
+
<small><a href="#" class="constants_summary_toggle">collapse</a></small>
|
|
118
|
+
</h2>
|
|
119
|
+
|
|
120
|
+
<dl class="constants">
|
|
121
|
+
|
|
122
|
+
<dt id="PATH-constant" class="">PATH =
|
|
123
|
+
<div class="docstring">
|
|
124
|
+
<div class="discussion">
|
|
125
|
+
|
|
126
|
+
<p>The API path for the requests</p>
|
|
127
|
+
|
|
128
|
+
|
|
129
|
+
</div>
|
|
130
|
+
</div>
|
|
131
|
+
<div class="tags">
|
|
132
|
+
|
|
133
|
+
|
|
134
|
+
</div>
|
|
135
|
+
</dt>
|
|
136
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/tcp</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
137
|
+
|
|
138
|
+
<dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
|
|
139
|
+
<div class="docstring">
|
|
140
|
+
<div class="discussion">
|
|
141
|
+
|
|
142
|
+
<p>The List Property from the resulting API for list calls</p>
|
|
143
|
+
|
|
144
|
+
|
|
145
|
+
</div>
|
|
146
|
+
</div>
|
|
147
|
+
<div class="tags">
|
|
148
|
+
|
|
149
|
+
|
|
150
|
+
</div>
|
|
151
|
+
</dt>
|
|
152
|
+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>tcp_edges</span><span class='tstring_end'>'</span></span></pre></dd>
|
|
153
|
+
|
|
154
|
+
</dl>
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
|
|
158
|
+
|
|
159
|
+
|
|
160
|
+
<h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
|
|
161
|
+
<ul class="summary">
|
|
162
|
+
|
|
163
|
+
<li class="public ">
|
|
164
|
+
<span class="summary_signature">
|
|
165
|
+
|
|
166
|
+
<a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> ⇒ Object </a>
|
|
167
|
+
|
|
168
|
+
|
|
169
|
+
|
|
170
|
+
</span>
|
|
171
|
+
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
|
|
175
|
+
<span class="note title readonly">readonly</span>
|
|
176
|
+
|
|
177
|
+
|
|
178
|
+
|
|
179
|
+
|
|
180
|
+
|
|
181
|
+
|
|
182
|
+
|
|
183
|
+
|
|
184
|
+
|
|
185
|
+
<span class="summary_desc"><div class='inline'>
|
|
186
|
+
<p>Returns the value of attribute client.</p>
|
|
187
|
+
</div></span>
|
|
188
|
+
|
|
189
|
+
</li>
|
|
190
|
+
|
|
191
|
+
|
|
192
|
+
</ul>
|
|
193
|
+
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
|
|
197
|
+
|
|
198
|
+
<h2>
|
|
199
|
+
Instance Method Summary
|
|
200
|
+
<small><a href="#" class="summary_toggle">collapse</a></small>
|
|
201
|
+
</h2>
|
|
202
|
+
|
|
203
|
+
<ul class="summary">
|
|
204
|
+
|
|
205
|
+
<li class="public ">
|
|
206
|
+
<span class="summary_signature">
|
|
207
|
+
|
|
208
|
+
<a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil) ⇒ NgrokAPI::Models::TCPEdge </a>
|
|
209
|
+
|
|
210
|
+
|
|
211
|
+
|
|
212
|
+
</span>
|
|
213
|
+
|
|
214
|
+
|
|
215
|
+
|
|
216
|
+
|
|
217
|
+
|
|
218
|
+
|
|
219
|
+
|
|
220
|
+
|
|
221
|
+
|
|
222
|
+
<span class="summary_desc"><div class='inline'>
|
|
223
|
+
<p>Create a TCP Edge.</p>
|
|
224
|
+
</div></span>
|
|
225
|
+
|
|
226
|
+
</li>
|
|
227
|
+
|
|
228
|
+
|
|
229
|
+
<li class="public ">
|
|
230
|
+
<span class="summary_signature">
|
|
231
|
+
|
|
232
|
+
<a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
233
|
+
|
|
234
|
+
|
|
235
|
+
|
|
236
|
+
</span>
|
|
237
|
+
|
|
238
|
+
|
|
239
|
+
|
|
240
|
+
|
|
241
|
+
|
|
242
|
+
|
|
243
|
+
|
|
244
|
+
|
|
245
|
+
|
|
246
|
+
<span class="summary_desc"><div class='inline'>
|
|
247
|
+
<p>Delete a TCP Edge by ID.</p>
|
|
248
|
+
</div></span>
|
|
249
|
+
|
|
250
|
+
</li>
|
|
251
|
+
|
|
252
|
+
|
|
253
|
+
<li class="public ">
|
|
254
|
+
<span class="summary_signature">
|
|
255
|
+
|
|
256
|
+
<a href="#delete!-instance_method" title="#delete! (instance method)">#<strong>delete!</strong>(id: "") ⇒ NgrokAPI::Models::Empty </a>
|
|
257
|
+
|
|
258
|
+
|
|
259
|
+
|
|
260
|
+
</span>
|
|
261
|
+
|
|
262
|
+
|
|
263
|
+
|
|
264
|
+
|
|
265
|
+
|
|
266
|
+
|
|
267
|
+
|
|
268
|
+
|
|
269
|
+
|
|
270
|
+
<span class="summary_desc"><div class='inline'>
|
|
271
|
+
<p>Delete a TCP Edge by ID Throws an exception if API error.</p>
|
|
272
|
+
</div></span>
|
|
273
|
+
|
|
274
|
+
</li>
|
|
275
|
+
|
|
276
|
+
|
|
277
|
+
<li class="public ">
|
|
278
|
+
<span class="summary_signature">
|
|
279
|
+
|
|
280
|
+
<a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: "") ⇒ NgrokAPI::Models::TCPEdge </a>
|
|
281
|
+
|
|
282
|
+
|
|
283
|
+
|
|
284
|
+
</span>
|
|
285
|
+
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+
|
|
289
|
+
|
|
290
|
+
|
|
291
|
+
|
|
292
|
+
|
|
293
|
+
|
|
294
|
+
<span class="summary_desc"><div class='inline'>
|
|
295
|
+
<p>Get a TCP Edge by ID.</p>
|
|
296
|
+
</div></span>
|
|
297
|
+
|
|
298
|
+
</li>
|
|
299
|
+
|
|
300
|
+
|
|
301
|
+
<li class="public ">
|
|
302
|
+
<span class="summary_signature">
|
|
303
|
+
|
|
304
|
+
<a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: "") ⇒ NgrokAPI::Models::TCPEdge </a>
|
|
305
|
+
|
|
306
|
+
|
|
307
|
+
|
|
308
|
+
</span>
|
|
309
|
+
|
|
310
|
+
|
|
311
|
+
|
|
312
|
+
|
|
313
|
+
|
|
314
|
+
|
|
315
|
+
|
|
316
|
+
|
|
317
|
+
|
|
318
|
+
<span class="summary_desc"><div class='inline'>
|
|
319
|
+
<p>Get a TCP Edge by ID Throws an exception if API error.</p>
|
|
320
|
+
</div></span>
|
|
321
|
+
|
|
322
|
+
</li>
|
|
323
|
+
|
|
324
|
+
|
|
325
|
+
<li class="public ">
|
|
326
|
+
<span class="summary_signature">
|
|
327
|
+
|
|
328
|
+
<a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) ⇒ EdgesTCPClient </a>
|
|
329
|
+
|
|
330
|
+
|
|
331
|
+
|
|
332
|
+
</span>
|
|
333
|
+
|
|
334
|
+
|
|
335
|
+
<span class="note title constructor">constructor</span>
|
|
336
|
+
|
|
337
|
+
|
|
338
|
+
|
|
339
|
+
|
|
340
|
+
|
|
341
|
+
|
|
342
|
+
|
|
343
|
+
|
|
344
|
+
<span class="summary_desc"><div class='inline'>
|
|
345
|
+
<p>A new instance of EdgesTCPClient.</p>
|
|
346
|
+
</div></span>
|
|
347
|
+
|
|
348
|
+
</li>
|
|
349
|
+
|
|
350
|
+
|
|
351
|
+
<li class="public ">
|
|
352
|
+
<span class="summary_signature">
|
|
353
|
+
|
|
354
|
+
<a href="#list-instance_method" title="#list (instance method)">#<strong>list</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
355
|
+
|
|
356
|
+
|
|
357
|
+
|
|
358
|
+
</span>
|
|
359
|
+
|
|
360
|
+
|
|
361
|
+
|
|
362
|
+
|
|
363
|
+
|
|
364
|
+
|
|
365
|
+
|
|
366
|
+
|
|
367
|
+
|
|
368
|
+
<span class="summary_desc"><div class='inline'>
|
|
369
|
+
<p>Returns a list of all TCP Edges on this account.</p>
|
|
370
|
+
</div></span>
|
|
371
|
+
|
|
372
|
+
</li>
|
|
373
|
+
|
|
374
|
+
|
|
375
|
+
<li class="public ">
|
|
376
|
+
<span class="summary_signature">
|
|
377
|
+
|
|
378
|
+
<a href="#list!-instance_method" title="#list! (instance method)">#<strong>list!</strong>(before_id: nil, limit: nil, url: nil) ⇒ NgrokAPI::Models::Listable </a>
|
|
379
|
+
|
|
380
|
+
|
|
381
|
+
|
|
382
|
+
</span>
|
|
383
|
+
|
|
384
|
+
|
|
385
|
+
|
|
386
|
+
|
|
387
|
+
|
|
388
|
+
|
|
389
|
+
|
|
390
|
+
|
|
391
|
+
|
|
392
|
+
<span class="summary_desc"><div class='inline'>
|
|
393
|
+
<p>Returns a list of all TCP Edges on this account Throws an exception if API error.</p>
|
|
394
|
+
</div></span>
|
|
395
|
+
|
|
396
|
+
</li>
|
|
397
|
+
|
|
398
|
+
|
|
399
|
+
<li class="public ">
|
|
400
|
+
<span class="summary_signature">
|
|
401
|
+
|
|
402
|
+
<a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil) ⇒ NgrokAPI::Models::TCPEdge </a>
|
|
403
|
+
|
|
404
|
+
|
|
405
|
+
|
|
406
|
+
</span>
|
|
407
|
+
|
|
408
|
+
|
|
409
|
+
|
|
410
|
+
|
|
411
|
+
|
|
412
|
+
|
|
413
|
+
|
|
414
|
+
|
|
415
|
+
|
|
416
|
+
<span class="summary_desc"><div class='inline'>
|
|
417
|
+
<p>Updates a TCP Edge by ID.</p>
|
|
418
|
+
</div></span>
|
|
419
|
+
|
|
420
|
+
</li>
|
|
421
|
+
|
|
422
|
+
|
|
423
|
+
<li class="public ">
|
|
424
|
+
<span class="summary_signature">
|
|
425
|
+
|
|
426
|
+
<a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil) ⇒ NgrokAPI::Models::TCPEdge </a>
|
|
427
|
+
|
|
428
|
+
|
|
429
|
+
|
|
430
|
+
</span>
|
|
431
|
+
|
|
432
|
+
|
|
433
|
+
|
|
434
|
+
|
|
435
|
+
|
|
436
|
+
|
|
437
|
+
|
|
438
|
+
|
|
439
|
+
|
|
440
|
+
<span class="summary_desc"><div class='inline'>
|
|
441
|
+
<p>Updates a TCP Edge by ID.</p>
|
|
442
|
+
</div></span>
|
|
443
|
+
|
|
444
|
+
</li>
|
|
445
|
+
|
|
446
|
+
|
|
447
|
+
</ul>
|
|
448
|
+
|
|
449
|
+
|
|
450
|
+
<div id="constructor_details" class="method_details_list">
|
|
451
|
+
<h2>Constructor Details</h2>
|
|
452
|
+
|
|
453
|
+
<div class="method_details first">
|
|
454
|
+
<h3 class="signature first" id="initialize-instance_method">
|
|
455
|
+
|
|
456
|
+
#<strong>initialize</strong>(client:) ⇒ <tt><span class='object_link'><a href="" title="NgrokAPI::Services::EdgesTCPClient (class)">EdgesTCPClient</a></span></tt>
|
|
457
|
+
|
|
458
|
+
|
|
459
|
+
|
|
460
|
+
|
|
461
|
+
|
|
462
|
+
</h3><div class="docstring">
|
|
463
|
+
<div class="discussion">
|
|
464
|
+
|
|
465
|
+
<p>Returns a new instance of EdgesTCPClient.</p>
|
|
466
|
+
|
|
467
|
+
|
|
468
|
+
</div>
|
|
469
|
+
</div>
|
|
470
|
+
<div class="tags">
|
|
471
|
+
|
|
472
|
+
|
|
473
|
+
</div><table class="source_code">
|
|
474
|
+
<tr>
|
|
475
|
+
<td>
|
|
476
|
+
<pre class="lines">
|
|
477
|
+
|
|
478
|
+
|
|
479
|
+
15
|
|
480
|
+
16
|
|
481
|
+
17</pre>
|
|
482
|
+
</td>
|
|
483
|
+
<td>
|
|
484
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 15</span>
|
|
485
|
+
|
|
486
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='rparen'>)</span>
|
|
487
|
+
<span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
|
|
488
|
+
<span class='kw'>end</span></pre>
|
|
489
|
+
</td>
|
|
490
|
+
</tr>
|
|
491
|
+
</table>
|
|
492
|
+
</div>
|
|
493
|
+
|
|
494
|
+
</div>
|
|
495
|
+
|
|
496
|
+
<div id="instance_attr_details" class="attr_details">
|
|
497
|
+
<h2>Instance Attribute Details</h2>
|
|
498
|
+
|
|
499
|
+
|
|
500
|
+
<span id=""></span>
|
|
501
|
+
<div class="method_details first">
|
|
502
|
+
<h3 class="signature first" id="client-instance_method">
|
|
503
|
+
|
|
504
|
+
#<strong>client</strong> ⇒ <tt>Object</tt> <span class="extras">(readonly)</span>
|
|
505
|
+
|
|
506
|
+
|
|
507
|
+
|
|
508
|
+
|
|
509
|
+
|
|
510
|
+
</h3><div class="docstring">
|
|
511
|
+
<div class="discussion">
|
|
512
|
+
|
|
513
|
+
<p>Returns the value of attribute client.</p>
|
|
514
|
+
|
|
515
|
+
|
|
516
|
+
</div>
|
|
517
|
+
</div>
|
|
518
|
+
<div class="tags">
|
|
519
|
+
|
|
520
|
+
|
|
521
|
+
</div><table class="source_code">
|
|
522
|
+
<tr>
|
|
523
|
+
<td>
|
|
524
|
+
<pre class="lines">
|
|
525
|
+
|
|
526
|
+
|
|
527
|
+
13
|
|
528
|
+
14
|
|
529
|
+
15</pre>
|
|
530
|
+
</td>
|
|
531
|
+
<td>
|
|
532
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 13</span>
|
|
533
|
+
|
|
534
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
|
|
535
|
+
<span class='ivar'>@client</span>
|
|
536
|
+
<span class='kw'>end</span></pre>
|
|
537
|
+
</td>
|
|
538
|
+
</tr>
|
|
539
|
+
</table>
|
|
540
|
+
</div>
|
|
541
|
+
|
|
542
|
+
</div>
|
|
543
|
+
|
|
544
|
+
|
|
545
|
+
<div id="instance_method_details" class="method_details_list">
|
|
546
|
+
<h2>Instance Method Details</h2>
|
|
547
|
+
|
|
548
|
+
|
|
549
|
+
<div class="method_details first">
|
|
550
|
+
<h3 class="signature first" id="create-instance_method">
|
|
551
|
+
|
|
552
|
+
#<strong>create</strong>(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil) ⇒ <tt><span class='object_link'><a href="../Models/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">NgrokAPI::Models::TCPEdge</a></span></tt>
|
|
553
|
+
|
|
554
|
+
|
|
555
|
+
|
|
556
|
+
|
|
557
|
+
|
|
558
|
+
</h3><div class="docstring">
|
|
559
|
+
<div class="discussion">
|
|
560
|
+
|
|
561
|
+
<p>Create a TCP Edge</p>
|
|
562
|
+
|
|
563
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-tcp-create">ngrok.com/docs/api#api-edges-tcp-create</a></p>
|
|
564
|
+
|
|
565
|
+
|
|
566
|
+
</div>
|
|
567
|
+
</div>
|
|
568
|
+
<div class="tags">
|
|
569
|
+
<p class="tag_title">Parameters:</p>
|
|
570
|
+
<ul class="param">
|
|
571
|
+
|
|
572
|
+
<li>
|
|
573
|
+
|
|
574
|
+
<span class='name'>description</span>
|
|
575
|
+
|
|
576
|
+
|
|
577
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
578
|
+
|
|
579
|
+
|
|
580
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
581
|
+
|
|
582
|
+
|
|
583
|
+
—
|
|
584
|
+
<div class='inline'>
|
|
585
|
+
<p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
|
|
586
|
+
</div>
|
|
587
|
+
|
|
588
|
+
</li>
|
|
589
|
+
|
|
590
|
+
<li>
|
|
591
|
+
|
|
592
|
+
<span class='name'>metadata</span>
|
|
593
|
+
|
|
594
|
+
|
|
595
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
596
|
+
|
|
597
|
+
|
|
598
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
599
|
+
|
|
600
|
+
|
|
601
|
+
—
|
|
602
|
+
<div class='inline'>
|
|
603
|
+
<p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
|
|
604
|
+
</div>
|
|
605
|
+
|
|
606
|
+
</li>
|
|
607
|
+
|
|
608
|
+
<li>
|
|
609
|
+
|
|
610
|
+
<span class='name'>hostports</span>
|
|
611
|
+
|
|
612
|
+
|
|
613
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
|
614
|
+
|
|
615
|
+
|
|
616
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
617
|
+
|
|
618
|
+
|
|
619
|
+
—
|
|
620
|
+
<div class='inline'>
|
|
621
|
+
<p>hostports served by this edge</p>
|
|
622
|
+
</div>
|
|
623
|
+
|
|
624
|
+
</li>
|
|
625
|
+
|
|
626
|
+
<li>
|
|
627
|
+
|
|
628
|
+
<span class='name'>backend</span>
|
|
629
|
+
|
|
630
|
+
|
|
631
|
+
<span class='type'>(<tt>EndpointBackendMutate</tt>)</span>
|
|
632
|
+
|
|
633
|
+
|
|
634
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
635
|
+
|
|
636
|
+
|
|
637
|
+
—
|
|
638
|
+
<div class='inline'>
|
|
639
|
+
<p>edge modules</p>
|
|
640
|
+
</div>
|
|
641
|
+
|
|
642
|
+
</li>
|
|
643
|
+
|
|
644
|
+
<li>
|
|
645
|
+
|
|
646
|
+
<span class='name'>ip_restriction</span>
|
|
647
|
+
|
|
648
|
+
|
|
649
|
+
<span class='type'>(<tt>EndpointIPPolicyMutate</tt>)</span>
|
|
650
|
+
|
|
651
|
+
|
|
652
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
653
|
+
|
|
654
|
+
|
|
655
|
+
</li>
|
|
656
|
+
|
|
657
|
+
</ul>
|
|
658
|
+
|
|
659
|
+
<p class="tag_title">Returns:</p>
|
|
660
|
+
<ul class="return">
|
|
661
|
+
|
|
662
|
+
<li>
|
|
663
|
+
|
|
664
|
+
|
|
665
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">NgrokAPI::Models::TCPEdge</a></span></tt>)</span>
|
|
666
|
+
|
|
667
|
+
|
|
668
|
+
|
|
669
|
+
—
|
|
670
|
+
<div class='inline'>
|
|
671
|
+
<p>result from the API request</p>
|
|
672
|
+
</div>
|
|
673
|
+
|
|
674
|
+
</li>
|
|
675
|
+
|
|
676
|
+
</ul>
|
|
677
|
+
|
|
678
|
+
</div><table class="source_code">
|
|
679
|
+
<tr>
|
|
680
|
+
<td>
|
|
681
|
+
<pre class="lines">
|
|
682
|
+
|
|
683
|
+
|
|
684
|
+
30
|
|
685
|
+
31
|
|
686
|
+
32
|
|
687
|
+
33
|
|
688
|
+
34
|
|
689
|
+
35
|
|
690
|
+
36
|
|
691
|
+
37
|
|
692
|
+
38
|
|
693
|
+
39
|
|
694
|
+
40
|
|
695
|
+
41
|
|
696
|
+
42</pre>
|
|
697
|
+
</td>
|
|
698
|
+
<td>
|
|
699
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 30</span>
|
|
700
|
+
|
|
701
|
+
<span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>"</span><span class='tstring_end'>"</span></span><span class='comma'>,</span> <span class='label'>hostports:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
702
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/tcp</span><span class='tstring_end'>'</span></span>
|
|
703
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
704
|
+
<span class='rbrace'>}</span>
|
|
705
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
706
|
+
<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>
|
|
707
|
+
<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>
|
|
708
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:hostports</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_hostports'>hostports</span> <span class='kw'>if</span> <span class='id identifier rubyid_hostports'>hostports</span>
|
|
709
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:backend</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_backend'>backend</span> <span class='kw'>if</span> <span class='id identifier rubyid_backend'>backend</span>
|
|
710
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ip_restriction</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span> <span class='kw'>if</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span>
|
|
711
|
+
<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>
|
|
712
|
+
<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/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">TCPEdge</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TCPEdge.html#initialize-instance_method" title="NgrokAPI::Models::TCPEdge#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'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
713
|
+
<span class='kw'>end</span></pre>
|
|
714
|
+
</td>
|
|
715
|
+
</tr>
|
|
716
|
+
</table>
|
|
717
|
+
</div>
|
|
718
|
+
|
|
719
|
+
<div class="method_details ">
|
|
720
|
+
<h3 class="signature " id="delete-instance_method">
|
|
721
|
+
|
|
722
|
+
#<strong>delete</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
723
|
+
|
|
724
|
+
|
|
725
|
+
|
|
726
|
+
|
|
727
|
+
|
|
728
|
+
</h3><div class="docstring">
|
|
729
|
+
<div class="discussion">
|
|
730
|
+
|
|
731
|
+
<p>Delete a TCP Edge by ID</p>
|
|
732
|
+
|
|
733
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-tcp-delete">ngrok.com/docs/api#api-edges-tcp-delete</a></p>
|
|
734
|
+
|
|
735
|
+
|
|
736
|
+
</div>
|
|
737
|
+
</div>
|
|
738
|
+
<div class="tags">
|
|
739
|
+
<p class="tag_title">Parameters:</p>
|
|
740
|
+
<ul class="param">
|
|
741
|
+
|
|
742
|
+
<li>
|
|
743
|
+
|
|
744
|
+
<span class='name'>id</span>
|
|
745
|
+
|
|
746
|
+
|
|
747
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
748
|
+
|
|
749
|
+
|
|
750
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
751
|
+
|
|
752
|
+
|
|
753
|
+
—
|
|
754
|
+
<div class='inline'>
|
|
755
|
+
<p>a resource identifier</p>
|
|
756
|
+
</div>
|
|
757
|
+
|
|
758
|
+
</li>
|
|
759
|
+
|
|
760
|
+
</ul>
|
|
761
|
+
|
|
762
|
+
<p class="tag_title">Returns:</p>
|
|
763
|
+
<ul class="return">
|
|
764
|
+
|
|
765
|
+
<li>
|
|
766
|
+
|
|
767
|
+
|
|
768
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
769
|
+
|
|
770
|
+
|
|
771
|
+
|
|
772
|
+
—
|
|
773
|
+
<div class='inline'>
|
|
774
|
+
<p>result from the API request</p>
|
|
775
|
+
</div>
|
|
776
|
+
|
|
777
|
+
</li>
|
|
778
|
+
|
|
779
|
+
</ul>
|
|
780
|
+
|
|
781
|
+
</div><table class="source_code">
|
|
782
|
+
<tr>
|
|
783
|
+
<td>
|
|
784
|
+
<pre class="lines">
|
|
785
|
+
|
|
786
|
+
|
|
787
|
+
202
|
|
788
|
+
203
|
|
789
|
+
204
|
|
790
|
+
205
|
|
791
|
+
206
|
|
792
|
+
207
|
|
793
|
+
208</pre>
|
|
794
|
+
</td>
|
|
795
|
+
<td>
|
|
796
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 202</span>
|
|
797
|
+
|
|
798
|
+
<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>
|
|
799
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/tcp/%{id}</span><span class='tstring_end'>'</span></span>
|
|
800
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
801
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
802
|
+
<span class='rbrace'>}</span>
|
|
803
|
+
<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>
|
|
804
|
+
<span class='kw'>end</span></pre>
|
|
805
|
+
</td>
|
|
806
|
+
</tr>
|
|
807
|
+
</table>
|
|
808
|
+
</div>
|
|
809
|
+
|
|
810
|
+
<div class="method_details ">
|
|
811
|
+
<h3 class="signature " id="delete!-instance_method">
|
|
812
|
+
|
|
813
|
+
#<strong>delete!</strong>(id: "") ⇒ <tt>NgrokAPI::Models::Empty</tt>
|
|
814
|
+
|
|
815
|
+
|
|
816
|
+
|
|
817
|
+
|
|
818
|
+
|
|
819
|
+
</h3><div class="docstring">
|
|
820
|
+
<div class="discussion">
|
|
821
|
+
|
|
822
|
+
<p>Delete a TCP Edge by ID Throws an exception if API error.</p>
|
|
823
|
+
|
|
824
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-tcp-delete">ngrok.com/docs/api#api-edges-tcp-delete</a></p>
|
|
825
|
+
|
|
826
|
+
|
|
827
|
+
</div>
|
|
828
|
+
</div>
|
|
829
|
+
<div class="tags">
|
|
830
|
+
<p class="tag_title">Parameters:</p>
|
|
831
|
+
<ul class="param">
|
|
832
|
+
|
|
833
|
+
<li>
|
|
834
|
+
|
|
835
|
+
<span class='name'>id</span>
|
|
836
|
+
|
|
837
|
+
|
|
838
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
839
|
+
|
|
840
|
+
|
|
841
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
842
|
+
|
|
843
|
+
|
|
844
|
+
—
|
|
845
|
+
<div class='inline'>
|
|
846
|
+
<p>a resource identifier</p>
|
|
847
|
+
</div>
|
|
848
|
+
|
|
849
|
+
</li>
|
|
850
|
+
|
|
851
|
+
</ul>
|
|
852
|
+
|
|
853
|
+
<p class="tag_title">Returns:</p>
|
|
854
|
+
<ul class="return">
|
|
855
|
+
|
|
856
|
+
<li>
|
|
857
|
+
|
|
858
|
+
|
|
859
|
+
<span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
|
|
860
|
+
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
—
|
|
864
|
+
<div class='inline'>
|
|
865
|
+
<p>result from the API request</p>
|
|
866
|
+
</div>
|
|
867
|
+
|
|
868
|
+
</li>
|
|
869
|
+
|
|
870
|
+
</ul>
|
|
871
|
+
|
|
872
|
+
</div><table class="source_code">
|
|
873
|
+
<tr>
|
|
874
|
+
<td>
|
|
875
|
+
<pre class="lines">
|
|
876
|
+
|
|
877
|
+
|
|
878
|
+
218
|
|
879
|
+
219
|
|
880
|
+
220
|
|
881
|
+
221
|
|
882
|
+
222
|
|
883
|
+
223
|
|
884
|
+
224</pre>
|
|
885
|
+
</td>
|
|
886
|
+
<td>
|
|
887
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 218</span>
|
|
888
|
+
|
|
889
|
+
<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>
|
|
890
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/tcp/%{id}</span><span class='tstring_end'>'</span></span>
|
|
891
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
892
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
893
|
+
<span class='rbrace'>}</span>
|
|
894
|
+
<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>
|
|
895
|
+
<span class='kw'>end</span></pre>
|
|
896
|
+
</td>
|
|
897
|
+
</tr>
|
|
898
|
+
</table>
|
|
899
|
+
</div>
|
|
900
|
+
|
|
901
|
+
<div class="method_details ">
|
|
902
|
+
<h3 class="signature " id="get-instance_method">
|
|
903
|
+
|
|
904
|
+
#<strong>get</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">NgrokAPI::Models::TCPEdge</a></span></tt>
|
|
905
|
+
|
|
906
|
+
|
|
907
|
+
|
|
908
|
+
|
|
909
|
+
|
|
910
|
+
</h3><div class="docstring">
|
|
911
|
+
<div class="discussion">
|
|
912
|
+
|
|
913
|
+
<p>Get a TCP Edge by ID</p>
|
|
914
|
+
|
|
915
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-tcp-get">ngrok.com/docs/api#api-edges-tcp-get</a></p>
|
|
916
|
+
|
|
917
|
+
|
|
918
|
+
</div>
|
|
919
|
+
</div>
|
|
920
|
+
<div class="tags">
|
|
921
|
+
<p class="tag_title">Parameters:</p>
|
|
922
|
+
<ul class="param">
|
|
923
|
+
|
|
924
|
+
<li>
|
|
925
|
+
|
|
926
|
+
<span class='name'>id</span>
|
|
927
|
+
|
|
928
|
+
|
|
929
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
930
|
+
|
|
931
|
+
|
|
932
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
933
|
+
|
|
934
|
+
|
|
935
|
+
—
|
|
936
|
+
<div class='inline'>
|
|
937
|
+
<p>a resource identifier</p>
|
|
938
|
+
</div>
|
|
939
|
+
|
|
940
|
+
</li>
|
|
941
|
+
|
|
942
|
+
</ul>
|
|
943
|
+
|
|
944
|
+
<p class="tag_title">Returns:</p>
|
|
945
|
+
<ul class="return">
|
|
946
|
+
|
|
947
|
+
<li>
|
|
948
|
+
|
|
949
|
+
|
|
950
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">NgrokAPI::Models::TCPEdge</a></span></tt>)</span>
|
|
951
|
+
|
|
952
|
+
|
|
953
|
+
|
|
954
|
+
—
|
|
955
|
+
<div class='inline'>
|
|
956
|
+
<p>result from the API request</p>
|
|
957
|
+
</div>
|
|
958
|
+
|
|
959
|
+
</li>
|
|
960
|
+
|
|
961
|
+
</ul>
|
|
962
|
+
|
|
963
|
+
</div><table class="source_code">
|
|
964
|
+
<tr>
|
|
965
|
+
<td>
|
|
966
|
+
<pre class="lines">
|
|
967
|
+
|
|
968
|
+
|
|
969
|
+
51
|
|
970
|
+
52
|
|
971
|
+
53
|
|
972
|
+
54
|
|
973
|
+
55
|
|
974
|
+
56
|
|
975
|
+
57
|
|
976
|
+
58
|
|
977
|
+
59</pre>
|
|
978
|
+
</td>
|
|
979
|
+
<td>
|
|
980
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 51</span>
|
|
981
|
+
|
|
982
|
+
<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>
|
|
983
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/tcp/%{id}</span><span class='tstring_end'>'</span></span>
|
|
984
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
985
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
986
|
+
<span class='rbrace'>}</span>
|
|
987
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
988
|
+
<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>
|
|
989
|
+
<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/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">TCPEdge</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TCPEdge.html#initialize-instance_method" title="NgrokAPI::Models::TCPEdge#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'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
990
|
+
<span class='kw'>end</span></pre>
|
|
991
|
+
</td>
|
|
992
|
+
</tr>
|
|
993
|
+
</table>
|
|
994
|
+
</div>
|
|
995
|
+
|
|
996
|
+
<div class="method_details ">
|
|
997
|
+
<h3 class="signature " id="get!-instance_method">
|
|
998
|
+
|
|
999
|
+
#<strong>get!</strong>(id: "") ⇒ <tt><span class='object_link'><a href="../Models/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">NgrokAPI::Models::TCPEdge</a></span></tt>
|
|
1000
|
+
|
|
1001
|
+
|
|
1002
|
+
|
|
1003
|
+
|
|
1004
|
+
|
|
1005
|
+
</h3><div class="docstring">
|
|
1006
|
+
<div class="discussion">
|
|
1007
|
+
|
|
1008
|
+
<p>Get a TCP Edge by ID Throws an exception if API error.</p>
|
|
1009
|
+
|
|
1010
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-tcp-get">ngrok.com/docs/api#api-edges-tcp-get</a></p>
|
|
1011
|
+
|
|
1012
|
+
|
|
1013
|
+
</div>
|
|
1014
|
+
</div>
|
|
1015
|
+
<div class="tags">
|
|
1016
|
+
<p class="tag_title">Parameters:</p>
|
|
1017
|
+
<ul class="param">
|
|
1018
|
+
|
|
1019
|
+
<li>
|
|
1020
|
+
|
|
1021
|
+
<span class='name'>id</span>
|
|
1022
|
+
|
|
1023
|
+
|
|
1024
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1025
|
+
|
|
1026
|
+
|
|
1027
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1028
|
+
|
|
1029
|
+
|
|
1030
|
+
—
|
|
1031
|
+
<div class='inline'>
|
|
1032
|
+
<p>a resource identifier</p>
|
|
1033
|
+
</div>
|
|
1034
|
+
|
|
1035
|
+
</li>
|
|
1036
|
+
|
|
1037
|
+
</ul>
|
|
1038
|
+
|
|
1039
|
+
<p class="tag_title">Returns:</p>
|
|
1040
|
+
<ul class="return">
|
|
1041
|
+
|
|
1042
|
+
<li>
|
|
1043
|
+
|
|
1044
|
+
|
|
1045
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">NgrokAPI::Models::TCPEdge</a></span></tt>)</span>
|
|
1046
|
+
|
|
1047
|
+
|
|
1048
|
+
|
|
1049
|
+
—
|
|
1050
|
+
<div class='inline'>
|
|
1051
|
+
<p>result from the API request</p>
|
|
1052
|
+
</div>
|
|
1053
|
+
|
|
1054
|
+
</li>
|
|
1055
|
+
|
|
1056
|
+
</ul>
|
|
1057
|
+
|
|
1058
|
+
</div><table class="source_code">
|
|
1059
|
+
<tr>
|
|
1060
|
+
<td>
|
|
1061
|
+
<pre class="lines">
|
|
1062
|
+
|
|
1063
|
+
|
|
1064
|
+
69
|
|
1065
|
+
70
|
|
1066
|
+
71
|
|
1067
|
+
72
|
|
1068
|
+
73
|
|
1069
|
+
74
|
|
1070
|
+
75
|
|
1071
|
+
76
|
|
1072
|
+
77</pre>
|
|
1073
|
+
</td>
|
|
1074
|
+
<td>
|
|
1075
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 69</span>
|
|
1076
|
+
|
|
1077
|
+
<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>
|
|
1078
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/tcp/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1079
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1080
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1081
|
+
<span class='rbrace'>}</span>
|
|
1082
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1083
|
+
<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>
|
|
1084
|
+
<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/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">TCPEdge</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TCPEdge.html#initialize-instance_method" title="NgrokAPI::Models::TCPEdge#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'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
1085
|
+
<span class='kw'>end</span></pre>
|
|
1086
|
+
</td>
|
|
1087
|
+
</tr>
|
|
1088
|
+
</table>
|
|
1089
|
+
</div>
|
|
1090
|
+
|
|
1091
|
+
<div class="method_details ">
|
|
1092
|
+
<h3 class="signature " id="list-instance_method">
|
|
1093
|
+
|
|
1094
|
+
#<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>
|
|
1095
|
+
|
|
1096
|
+
|
|
1097
|
+
|
|
1098
|
+
|
|
1099
|
+
|
|
1100
|
+
</h3><div class="docstring">
|
|
1101
|
+
<div class="discussion">
|
|
1102
|
+
|
|
1103
|
+
<p>Returns a list of all TCP Edges on this account</p>
|
|
1104
|
+
|
|
1105
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-tcp-list">ngrok.com/docs/api#api-edges-tcp-list</a></p>
|
|
1106
|
+
|
|
1107
|
+
|
|
1108
|
+
</div>
|
|
1109
|
+
</div>
|
|
1110
|
+
<div class="tags">
|
|
1111
|
+
<p class="tag_title">Parameters:</p>
|
|
1112
|
+
<ul class="param">
|
|
1113
|
+
|
|
1114
|
+
<li>
|
|
1115
|
+
|
|
1116
|
+
<span class='name'>before_id</span>
|
|
1117
|
+
|
|
1118
|
+
|
|
1119
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1120
|
+
|
|
1121
|
+
|
|
1122
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1123
|
+
|
|
1124
|
+
|
|
1125
|
+
</li>
|
|
1126
|
+
|
|
1127
|
+
<li>
|
|
1128
|
+
|
|
1129
|
+
<span class='name'>limit</span>
|
|
1130
|
+
|
|
1131
|
+
|
|
1132
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1133
|
+
|
|
1134
|
+
|
|
1135
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1136
|
+
|
|
1137
|
+
|
|
1138
|
+
</li>
|
|
1139
|
+
|
|
1140
|
+
<li>
|
|
1141
|
+
|
|
1142
|
+
<span class='name'>url</span>
|
|
1143
|
+
|
|
1144
|
+
|
|
1145
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1146
|
+
|
|
1147
|
+
|
|
1148
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1149
|
+
|
|
1150
|
+
|
|
1151
|
+
—
|
|
1152
|
+
<div class='inline'>
|
|
1153
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
1154
|
+
</div>
|
|
1155
|
+
|
|
1156
|
+
</li>
|
|
1157
|
+
|
|
1158
|
+
</ul>
|
|
1159
|
+
|
|
1160
|
+
<p class="tag_title">Returns:</p>
|
|
1161
|
+
<ul class="return">
|
|
1162
|
+
|
|
1163
|
+
<li>
|
|
1164
|
+
|
|
1165
|
+
|
|
1166
|
+
<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>
|
|
1167
|
+
|
|
1168
|
+
|
|
1169
|
+
|
|
1170
|
+
—
|
|
1171
|
+
<div class='inline'>
|
|
1172
|
+
<p>result from the API request</p>
|
|
1173
|
+
</div>
|
|
1174
|
+
|
|
1175
|
+
</li>
|
|
1176
|
+
|
|
1177
|
+
</ul>
|
|
1178
|
+
|
|
1179
|
+
</div><table class="source_code">
|
|
1180
|
+
<tr>
|
|
1181
|
+
<td>
|
|
1182
|
+
<pre class="lines">
|
|
1183
|
+
|
|
1184
|
+
|
|
1185
|
+
88
|
|
1186
|
+
89
|
|
1187
|
+
90
|
|
1188
|
+
91
|
|
1189
|
+
92
|
|
1190
|
+
93
|
|
1191
|
+
94
|
|
1192
|
+
95
|
|
1193
|
+
96
|
|
1194
|
+
97
|
|
1195
|
+
98
|
|
1196
|
+
99
|
|
1197
|
+
100
|
|
1198
|
+
101
|
|
1199
|
+
102
|
|
1200
|
+
103</pre>
|
|
1201
|
+
</td>
|
|
1202
|
+
<td>
|
|
1203
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 88</span>
|
|
1204
|
+
|
|
1205
|
+
<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>
|
|
1206
|
+
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1207
|
+
<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>
|
|
1208
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1209
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1210
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1211
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EdgesTCPClient::PATH (constant)">PATH</a></span></span>
|
|
1212
|
+
<span class='rparen'>)</span>
|
|
1213
|
+
|
|
1214
|
+
<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>
|
|
1215
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1216
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1217
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EdgesTCPClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1218
|
+
<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/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">TCPEdge</a></span></span>
|
|
1219
|
+
<span class='rparen'>)</span>
|
|
1220
|
+
<span class='kw'>end</span></pre>
|
|
1221
|
+
</td>
|
|
1222
|
+
</tr>
|
|
1223
|
+
</table>
|
|
1224
|
+
</div>
|
|
1225
|
+
|
|
1226
|
+
<div class="method_details ">
|
|
1227
|
+
<h3 class="signature " id="list!-instance_method">
|
|
1228
|
+
|
|
1229
|
+
#<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>
|
|
1230
|
+
|
|
1231
|
+
|
|
1232
|
+
|
|
1233
|
+
|
|
1234
|
+
|
|
1235
|
+
</h3><div class="docstring">
|
|
1236
|
+
<div class="discussion">
|
|
1237
|
+
|
|
1238
|
+
<p>Returns a list of all TCP Edges on this account Throws an exception if API error.</p>
|
|
1239
|
+
|
|
1240
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-tcp-list">ngrok.com/docs/api#api-edges-tcp-list</a></p>
|
|
1241
|
+
|
|
1242
|
+
|
|
1243
|
+
</div>
|
|
1244
|
+
</div>
|
|
1245
|
+
<div class="tags">
|
|
1246
|
+
<p class="tag_title">Parameters:</p>
|
|
1247
|
+
<ul class="param">
|
|
1248
|
+
|
|
1249
|
+
<li>
|
|
1250
|
+
|
|
1251
|
+
<span class='name'>before_id</span>
|
|
1252
|
+
|
|
1253
|
+
|
|
1254
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1255
|
+
|
|
1256
|
+
|
|
1257
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1258
|
+
|
|
1259
|
+
|
|
1260
|
+
</li>
|
|
1261
|
+
|
|
1262
|
+
<li>
|
|
1263
|
+
|
|
1264
|
+
<span class='name'>limit</span>
|
|
1265
|
+
|
|
1266
|
+
|
|
1267
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1268
|
+
|
|
1269
|
+
|
|
1270
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1271
|
+
|
|
1272
|
+
|
|
1273
|
+
</li>
|
|
1274
|
+
|
|
1275
|
+
<li>
|
|
1276
|
+
|
|
1277
|
+
<span class='name'>url</span>
|
|
1278
|
+
|
|
1279
|
+
|
|
1280
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1281
|
+
|
|
1282
|
+
|
|
1283
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1284
|
+
|
|
1285
|
+
|
|
1286
|
+
—
|
|
1287
|
+
<div class='inline'>
|
|
1288
|
+
<p>optional and mutually exclusive from before_id and limit</p>
|
|
1289
|
+
</div>
|
|
1290
|
+
|
|
1291
|
+
</li>
|
|
1292
|
+
|
|
1293
|
+
</ul>
|
|
1294
|
+
|
|
1295
|
+
<p class="tag_title">Returns:</p>
|
|
1296
|
+
<ul class="return">
|
|
1297
|
+
|
|
1298
|
+
<li>
|
|
1299
|
+
|
|
1300
|
+
|
|
1301
|
+
<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>
|
|
1302
|
+
|
|
1303
|
+
|
|
1304
|
+
|
|
1305
|
+
—
|
|
1306
|
+
<div class='inline'>
|
|
1307
|
+
<p>result from the API request</p>
|
|
1308
|
+
</div>
|
|
1309
|
+
|
|
1310
|
+
</li>
|
|
1311
|
+
|
|
1312
|
+
</ul>
|
|
1313
|
+
|
|
1314
|
+
</div><table class="source_code">
|
|
1315
|
+
<tr>
|
|
1316
|
+
<td>
|
|
1317
|
+
<pre class="lines">
|
|
1318
|
+
|
|
1319
|
+
|
|
1320
|
+
115
|
|
1321
|
+
116
|
|
1322
|
+
117
|
|
1323
|
+
118
|
|
1324
|
+
119
|
|
1325
|
+
120
|
|
1326
|
+
121
|
|
1327
|
+
122
|
|
1328
|
+
123
|
|
1329
|
+
124
|
|
1330
|
+
125
|
|
1331
|
+
126
|
|
1332
|
+
127
|
|
1333
|
+
128
|
|
1334
|
+
129
|
|
1335
|
+
130
|
|
1336
|
+
131
|
|
1337
|
+
132</pre>
|
|
1338
|
+
</td>
|
|
1339
|
+
<td>
|
|
1340
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 115</span>
|
|
1341
|
+
|
|
1342
|
+
<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>
|
|
1343
|
+
<span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1344
|
+
<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>
|
|
1345
|
+
<span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
|
|
1346
|
+
<span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
|
|
1347
|
+
<span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
|
|
1348
|
+
<span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
|
|
1349
|
+
<span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EdgesTCPClient::PATH (constant)">PATH</a></span></span>
|
|
1350
|
+
<span class='rparen'>)</span>
|
|
1351
|
+
|
|
1352
|
+
<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>
|
|
1353
|
+
<span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
|
|
1354
|
+
<span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
|
|
1355
|
+
<span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EdgesTCPClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
|
|
1356
|
+
<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/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">TCPEdge</a></span></span><span class='comma'>,</span>
|
|
1357
|
+
<span class='label'>danger:</span> <span class='kw'>true</span>
|
|
1358
|
+
<span class='rparen'>)</span>
|
|
1359
|
+
<span class='kw'>end</span></pre>
|
|
1360
|
+
</td>
|
|
1361
|
+
</tr>
|
|
1362
|
+
</table>
|
|
1363
|
+
</div>
|
|
1364
|
+
|
|
1365
|
+
<div class="method_details ">
|
|
1366
|
+
<h3 class="signature " id="update-instance_method">
|
|
1367
|
+
|
|
1368
|
+
#<strong>update</strong>(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil) ⇒ <tt><span class='object_link'><a href="../Models/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">NgrokAPI::Models::TCPEdge</a></span></tt>
|
|
1369
|
+
|
|
1370
|
+
|
|
1371
|
+
|
|
1372
|
+
|
|
1373
|
+
|
|
1374
|
+
</h3><div class="docstring">
|
|
1375
|
+
<div class="discussion">
|
|
1376
|
+
|
|
1377
|
+
<p>Updates a TCP Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API.</p>
|
|
1378
|
+
|
|
1379
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-tcp-update">ngrok.com/docs/api#api-edges-tcp-update</a></p>
|
|
1380
|
+
|
|
1381
|
+
|
|
1382
|
+
</div>
|
|
1383
|
+
</div>
|
|
1384
|
+
<div class="tags">
|
|
1385
|
+
<p class="tag_title">Parameters:</p>
|
|
1386
|
+
<ul class="param">
|
|
1387
|
+
|
|
1388
|
+
<li>
|
|
1389
|
+
|
|
1390
|
+
<span class='name'>id</span>
|
|
1391
|
+
|
|
1392
|
+
|
|
1393
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1394
|
+
|
|
1395
|
+
|
|
1396
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1397
|
+
|
|
1398
|
+
|
|
1399
|
+
—
|
|
1400
|
+
<div class='inline'>
|
|
1401
|
+
<p>unique identifier of this edge</p>
|
|
1402
|
+
</div>
|
|
1403
|
+
|
|
1404
|
+
</li>
|
|
1405
|
+
|
|
1406
|
+
<li>
|
|
1407
|
+
|
|
1408
|
+
<span class='name'>description</span>
|
|
1409
|
+
|
|
1410
|
+
|
|
1411
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1412
|
+
|
|
1413
|
+
|
|
1414
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1415
|
+
|
|
1416
|
+
|
|
1417
|
+
—
|
|
1418
|
+
<div class='inline'>
|
|
1419
|
+
<p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
|
|
1420
|
+
</div>
|
|
1421
|
+
|
|
1422
|
+
</li>
|
|
1423
|
+
|
|
1424
|
+
<li>
|
|
1425
|
+
|
|
1426
|
+
<span class='name'>metadata</span>
|
|
1427
|
+
|
|
1428
|
+
|
|
1429
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1430
|
+
|
|
1431
|
+
|
|
1432
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1433
|
+
|
|
1434
|
+
|
|
1435
|
+
—
|
|
1436
|
+
<div class='inline'>
|
|
1437
|
+
<p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
|
|
1438
|
+
</div>
|
|
1439
|
+
|
|
1440
|
+
</li>
|
|
1441
|
+
|
|
1442
|
+
<li>
|
|
1443
|
+
|
|
1444
|
+
<span class='name'>hostports</span>
|
|
1445
|
+
|
|
1446
|
+
|
|
1447
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
|
1448
|
+
|
|
1449
|
+
|
|
1450
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1451
|
+
|
|
1452
|
+
|
|
1453
|
+
—
|
|
1454
|
+
<div class='inline'>
|
|
1455
|
+
<p>hostports served by this edge</p>
|
|
1456
|
+
</div>
|
|
1457
|
+
|
|
1458
|
+
</li>
|
|
1459
|
+
|
|
1460
|
+
<li>
|
|
1461
|
+
|
|
1462
|
+
<span class='name'>backend</span>
|
|
1463
|
+
|
|
1464
|
+
|
|
1465
|
+
<span class='type'>(<tt>EndpointBackendMutate</tt>)</span>
|
|
1466
|
+
|
|
1467
|
+
|
|
1468
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1469
|
+
|
|
1470
|
+
|
|
1471
|
+
—
|
|
1472
|
+
<div class='inline'>
|
|
1473
|
+
<p>edge modules</p>
|
|
1474
|
+
</div>
|
|
1475
|
+
|
|
1476
|
+
</li>
|
|
1477
|
+
|
|
1478
|
+
<li>
|
|
1479
|
+
|
|
1480
|
+
<span class='name'>ip_restriction</span>
|
|
1481
|
+
|
|
1482
|
+
|
|
1483
|
+
<span class='type'>(<tt>EndpointIPPolicyMutate</tt>)</span>
|
|
1484
|
+
|
|
1485
|
+
|
|
1486
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1487
|
+
|
|
1488
|
+
|
|
1489
|
+
</li>
|
|
1490
|
+
|
|
1491
|
+
</ul>
|
|
1492
|
+
|
|
1493
|
+
<p class="tag_title">Returns:</p>
|
|
1494
|
+
<ul class="return">
|
|
1495
|
+
|
|
1496
|
+
<li>
|
|
1497
|
+
|
|
1498
|
+
|
|
1499
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">NgrokAPI::Models::TCPEdge</a></span></tt>)</span>
|
|
1500
|
+
|
|
1501
|
+
|
|
1502
|
+
|
|
1503
|
+
—
|
|
1504
|
+
<div class='inline'>
|
|
1505
|
+
<p>result from the API request</p>
|
|
1506
|
+
</div>
|
|
1507
|
+
|
|
1508
|
+
</li>
|
|
1509
|
+
|
|
1510
|
+
</ul>
|
|
1511
|
+
|
|
1512
|
+
</div><table class="source_code">
|
|
1513
|
+
<tr>
|
|
1514
|
+
<td>
|
|
1515
|
+
<pre class="lines">
|
|
1516
|
+
|
|
1517
|
+
|
|
1518
|
+
149
|
|
1519
|
+
150
|
|
1520
|
+
151
|
|
1521
|
+
152
|
|
1522
|
+
153
|
|
1523
|
+
154
|
|
1524
|
+
155
|
|
1525
|
+
156
|
|
1526
|
+
157
|
|
1527
|
+
158
|
|
1528
|
+
159
|
|
1529
|
+
160
|
|
1530
|
+
161
|
|
1531
|
+
162</pre>
|
|
1532
|
+
</td>
|
|
1533
|
+
<td>
|
|
1534
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 149</span>
|
|
1535
|
+
|
|
1536
|
+
<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'>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'>hostports:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1537
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/tcp/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1538
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1539
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1540
|
+
<span class='rbrace'>}</span>
|
|
1541
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1542
|
+
<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>
|
|
1543
|
+
<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>
|
|
1544
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:hostports</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_hostports'>hostports</span> <span class='kw'>if</span> <span class='id identifier rubyid_hostports'>hostports</span>
|
|
1545
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:backend</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_backend'>backend</span> <span class='kw'>if</span> <span class='id identifier rubyid_backend'>backend</span>
|
|
1546
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ip_restriction</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span> <span class='kw'>if</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span>
|
|
1547
|
+
<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>
|
|
1548
|
+
<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/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">TCPEdge</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TCPEdge.html#initialize-instance_method" title="NgrokAPI::Models::TCPEdge#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'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
1549
|
+
<span class='kw'>end</span></pre>
|
|
1550
|
+
</td>
|
|
1551
|
+
</tr>
|
|
1552
|
+
</table>
|
|
1553
|
+
</div>
|
|
1554
|
+
|
|
1555
|
+
<div class="method_details ">
|
|
1556
|
+
<h3 class="signature " id="update!-instance_method">
|
|
1557
|
+
|
|
1558
|
+
#<strong>update!</strong>(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil) ⇒ <tt><span class='object_link'><a href="../Models/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">NgrokAPI::Models::TCPEdge</a></span></tt>
|
|
1559
|
+
|
|
1560
|
+
|
|
1561
|
+
|
|
1562
|
+
|
|
1563
|
+
|
|
1564
|
+
</h3><div class="docstring">
|
|
1565
|
+
<div class="discussion">
|
|
1566
|
+
|
|
1567
|
+
<p>Updates a TCP Edge by ID. If a module is not specified in the update, it will not be modified. However, each module configuration that is specified will completely replace the existing value. There is no way to delete an existing module via this API, instead use the delete module API. Throws an exception if API error.</p>
|
|
1568
|
+
|
|
1569
|
+
<p><a href="https://ngrok.com/docs/api#api-edges-tcp-update">ngrok.com/docs/api#api-edges-tcp-update</a></p>
|
|
1570
|
+
|
|
1571
|
+
|
|
1572
|
+
</div>
|
|
1573
|
+
</div>
|
|
1574
|
+
<div class="tags">
|
|
1575
|
+
<p class="tag_title">Parameters:</p>
|
|
1576
|
+
<ul class="param">
|
|
1577
|
+
|
|
1578
|
+
<li>
|
|
1579
|
+
|
|
1580
|
+
<span class='name'>id</span>
|
|
1581
|
+
|
|
1582
|
+
|
|
1583
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1584
|
+
|
|
1585
|
+
|
|
1586
|
+
<em class="default">(defaults to: <tt>""</tt>)</em>
|
|
1587
|
+
|
|
1588
|
+
|
|
1589
|
+
—
|
|
1590
|
+
<div class='inline'>
|
|
1591
|
+
<p>unique identifier of this edge</p>
|
|
1592
|
+
</div>
|
|
1593
|
+
|
|
1594
|
+
</li>
|
|
1595
|
+
|
|
1596
|
+
<li>
|
|
1597
|
+
|
|
1598
|
+
<span class='name'>description</span>
|
|
1599
|
+
|
|
1600
|
+
|
|
1601
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1602
|
+
|
|
1603
|
+
|
|
1604
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1605
|
+
|
|
1606
|
+
|
|
1607
|
+
—
|
|
1608
|
+
<div class='inline'>
|
|
1609
|
+
<p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
|
|
1610
|
+
</div>
|
|
1611
|
+
|
|
1612
|
+
</li>
|
|
1613
|
+
|
|
1614
|
+
<li>
|
|
1615
|
+
|
|
1616
|
+
<span class='name'>metadata</span>
|
|
1617
|
+
|
|
1618
|
+
|
|
1619
|
+
<span class='type'>(<tt>string</tt>)</span>
|
|
1620
|
+
|
|
1621
|
+
|
|
1622
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1623
|
+
|
|
1624
|
+
|
|
1625
|
+
—
|
|
1626
|
+
<div class='inline'>
|
|
1627
|
+
<p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
|
|
1628
|
+
</div>
|
|
1629
|
+
|
|
1630
|
+
</li>
|
|
1631
|
+
|
|
1632
|
+
<li>
|
|
1633
|
+
|
|
1634
|
+
<span class='name'>hostports</span>
|
|
1635
|
+
|
|
1636
|
+
|
|
1637
|
+
<span class='type'>(<tt>List<string></tt>)</span>
|
|
1638
|
+
|
|
1639
|
+
|
|
1640
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1641
|
+
|
|
1642
|
+
|
|
1643
|
+
—
|
|
1644
|
+
<div class='inline'>
|
|
1645
|
+
<p>hostports served by this edge</p>
|
|
1646
|
+
</div>
|
|
1647
|
+
|
|
1648
|
+
</li>
|
|
1649
|
+
|
|
1650
|
+
<li>
|
|
1651
|
+
|
|
1652
|
+
<span class='name'>backend</span>
|
|
1653
|
+
|
|
1654
|
+
|
|
1655
|
+
<span class='type'>(<tt>EndpointBackendMutate</tt>)</span>
|
|
1656
|
+
|
|
1657
|
+
|
|
1658
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1659
|
+
|
|
1660
|
+
|
|
1661
|
+
—
|
|
1662
|
+
<div class='inline'>
|
|
1663
|
+
<p>edge modules</p>
|
|
1664
|
+
</div>
|
|
1665
|
+
|
|
1666
|
+
</li>
|
|
1667
|
+
|
|
1668
|
+
<li>
|
|
1669
|
+
|
|
1670
|
+
<span class='name'>ip_restriction</span>
|
|
1671
|
+
|
|
1672
|
+
|
|
1673
|
+
<span class='type'>(<tt>EndpointIPPolicyMutate</tt>)</span>
|
|
1674
|
+
|
|
1675
|
+
|
|
1676
|
+
<em class="default">(defaults to: <tt>nil</tt>)</em>
|
|
1677
|
+
|
|
1678
|
+
|
|
1679
|
+
</li>
|
|
1680
|
+
|
|
1681
|
+
</ul>
|
|
1682
|
+
|
|
1683
|
+
<p class="tag_title">Returns:</p>
|
|
1684
|
+
<ul class="return">
|
|
1685
|
+
|
|
1686
|
+
<li>
|
|
1687
|
+
|
|
1688
|
+
|
|
1689
|
+
<span class='type'>(<tt><span class='object_link'><a href="../Models/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">NgrokAPI::Models::TCPEdge</a></span></tt>)</span>
|
|
1690
|
+
|
|
1691
|
+
|
|
1692
|
+
|
|
1693
|
+
—
|
|
1694
|
+
<div class='inline'>
|
|
1695
|
+
<p>result from the API request</p>
|
|
1696
|
+
</div>
|
|
1697
|
+
|
|
1698
|
+
</li>
|
|
1699
|
+
|
|
1700
|
+
</ul>
|
|
1701
|
+
|
|
1702
|
+
</div><table class="source_code">
|
|
1703
|
+
<tr>
|
|
1704
|
+
<td>
|
|
1705
|
+
<pre class="lines">
|
|
1706
|
+
|
|
1707
|
+
|
|
1708
|
+
180
|
|
1709
|
+
181
|
|
1710
|
+
182
|
|
1711
|
+
183
|
|
1712
|
+
184
|
|
1713
|
+
185
|
|
1714
|
+
186
|
|
1715
|
+
187
|
|
1716
|
+
188
|
|
1717
|
+
189
|
|
1718
|
+
190
|
|
1719
|
+
191
|
|
1720
|
+
192
|
|
1721
|
+
193</pre>
|
|
1722
|
+
</td>
|
|
1723
|
+
<td>
|
|
1724
|
+
<pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 180</span>
|
|
1725
|
+
|
|
1726
|
+
<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'>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'>hostports:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
|
|
1727
|
+
<span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>'</span><span class='tstring_content'>/edges/tcp/%{id}</span><span class='tstring_end'>'</span></span>
|
|
1728
|
+
<span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
|
|
1729
|
+
<span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
|
|
1730
|
+
<span class='rbrace'>}</span>
|
|
1731
|
+
<span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
|
|
1732
|
+
<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>
|
|
1733
|
+
<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>
|
|
1734
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:hostports</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_hostports'>hostports</span> <span class='kw'>if</span> <span class='id identifier rubyid_hostports'>hostports</span>
|
|
1735
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:backend</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_backend'>backend</span> <span class='kw'>if</span> <span class='id identifier rubyid_backend'>backend</span>
|
|
1736
|
+
<span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ip_restriction</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span> <span class='kw'>if</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span>
|
|
1737
|
+
<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>
|
|
1738
|
+
<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/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">TCPEdge</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TCPEdge.html#initialize-instance_method" title="NgrokAPI::Models::TCPEdge#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'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
|
|
1739
|
+
<span class='kw'>end</span></pre>
|
|
1740
|
+
</td>
|
|
1741
|
+
</tr>
|
|
1742
|
+
</table>
|
|
1743
|
+
</div>
|
|
1744
|
+
|
|
1745
|
+
</div>
|
|
1746
|
+
|
|
1747
|
+
</div>
|
|
1748
|
+
|
|
1749
|
+
<div id="footer">
|
|
1750
|
+
Generated on Thu Mar 10 04:54:49 2022 by
|
|
1751
|
+
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
|
|
1752
|
+
0.9.27 (ruby-2.7.5).
|
|
1753
|
+
</div>
|
|
1754
|
+
|
|
1755
|
+
</div>
|
|
1756
|
+
</body>
|
|
1757
|
+
</html>
|