ngrok-api 0.16.0 → 0.17.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (373) hide show
  1. checksums.yaml +4 -4
  2. data/doc/NgrokAPI/Client.html +270 -180
  3. data/doc/NgrokAPI/Error.html +2 -2
  4. data/doc/NgrokAPI/Errors/NotFoundError.html +2 -2
  5. data/doc/NgrokAPI/Errors.html +2 -2
  6. data/doc/NgrokAPI/HttpClient.html +2 -2
  7. data/doc/NgrokAPI/Models/APIKey.html +2 -2
  8. data/doc/NgrokAPI/Models/AWSAuth.html +2 -2
  9. data/doc/NgrokAPI/Models/AWSCredentials.html +2 -2
  10. data/doc/NgrokAPI/Models/AWSRole.html +2 -2
  11. data/doc/NgrokAPI/Models/AbuseReport.html +2 -2
  12. data/doc/NgrokAPI/Models/AbuseReportHostname.html +2 -2
  13. data/doc/NgrokAPI/Models/AgentIngress.html +2 -2
  14. data/doc/NgrokAPI/Models/CertificateAuthority.html +2 -2
  15. data/doc/NgrokAPI/Models/Credential.html +2 -2
  16. data/doc/NgrokAPI/Models/Endpoint.html +1431 -0
  17. data/{docs/NgrokAPI/Models/EndpointLogging.html → doc/NgrokAPI/Models/EndpointBackend.html} +41 -41
  18. data/doc/NgrokAPI/Models/{EndpointLoggingMutate.html → EndpointBackendMutate.html} +41 -41
  19. data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +2 -2
  20. data/doc/NgrokAPI/Models/EndpointCompression.html +2 -2
  21. data/doc/NgrokAPI/Models/EndpointIPPolicy.html +2 -2
  22. data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +2 -2
  23. data/doc/NgrokAPI/Models/EndpointMutualTLS.html +2 -2
  24. data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +2 -2
  25. data/doc/NgrokAPI/Models/EndpointOAuth.html +2 -2
  26. data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +2 -2
  27. data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +2 -2
  28. data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +2 -2
  29. data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +2 -2
  30. data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +2 -2
  31. data/doc/NgrokAPI/Models/EndpointOIDC.html +2 -2
  32. data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +2 -2
  33. data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +2 -2
  34. data/doc/NgrokAPI/Models/EndpointSAML.html +2 -2
  35. data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +2 -2
  36. data/doc/NgrokAPI/Models/EndpointTLSTermination.html +2 -2
  37. data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +617 -0
  38. data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +2 -2
  39. data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +543 -0
  40. data/doc/NgrokAPI/Models/EventDestination.html +6 -6
  41. data/doc/NgrokAPI/Models/EventSource.html +2 -2
  42. data/doc/NgrokAPI/Models/EventSourceList.html +2 -2
  43. data/doc/NgrokAPI/Models/EventSourceReplace.html +2 -2
  44. data/doc/NgrokAPI/Models/EventSubscription.html +2 -2
  45. data/doc/NgrokAPI/Models/EventTarget.html +2 -2
  46. data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +2 -2
  47. data/doc/NgrokAPI/Models/EventTargetFirehose.html +2 -2
  48. data/doc/NgrokAPI/Models/EventTargetKinesis.html +2 -2
  49. data/doc/NgrokAPI/Models/FailoverBackend.html +1075 -0
  50. data/doc/NgrokAPI/Models/HTTPResponseBackend.html +1231 -0
  51. data/{docs/NgrokAPI/Models/EventStream.html → doc/NgrokAPI/Models/HTTPSEdge.html} +118 -118
  52. data/doc/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +202 -264
  53. data/doc/NgrokAPI/Models/IPPolicy.html +2 -2
  54. data/doc/NgrokAPI/Models/IPPolicyRule.html +96 -22
  55. data/doc/NgrokAPI/Models/IPRestriction.html +2 -2
  56. data/doc/NgrokAPI/Models/Listable.html +2 -2
  57. data/doc/NgrokAPI/Models/Ref.html +2 -2
  58. data/doc/NgrokAPI/Models/ReservedAddr.html +2 -2
  59. data/doc/NgrokAPI/Models/ReservedDomain.html +2 -2
  60. data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +2 -2
  61. data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +2 -2
  62. data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +2 -2
  63. data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +2 -2
  64. data/doc/NgrokAPI/Models/SSHCredential.html +2 -2
  65. data/doc/NgrokAPI/Models/SSHHostCertificate.html +2 -2
  66. data/doc/NgrokAPI/Models/SSHUserCertificate.html +2 -2
  67. data/doc/NgrokAPI/Models/TCPEdge.html +1235 -0
  68. data/doc/NgrokAPI/Models/TLSCertificate.html +2 -2
  69. data/doc/NgrokAPI/Models/TLSCertificateSANs.html +2 -2
  70. data/doc/NgrokAPI/Models/TLSEdge.html +1395 -0
  71. data/doc/NgrokAPI/Models/Tunnel.html +313 -17
  72. data/doc/NgrokAPI/Models/TunnelGroupBackend.html +1149 -0
  73. data/doc/NgrokAPI/Models/TunnelSession.html +2 -2
  74. data/doc/NgrokAPI/Models/WeightedBackend.html +1075 -0
  75. data/doc/NgrokAPI/Models.html +4 -4
  76. data/doc/NgrokAPI/PagedIterator.html +2 -2
  77. data/doc/NgrokAPI/Services/APIKeysClient.html +2 -2
  78. data/doc/NgrokAPI/Services/AbuseReportsClient.html +2 -2
  79. data/doc/NgrokAPI/Services/AgentIngressesClient.html +2 -2
  80. data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +2 -2
  81. data/doc/NgrokAPI/Services/CredentialsClient.html +2 -2
  82. data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1153 -0
  83. data/doc/NgrokAPI/Services/{EndpointCircuitBreakerModuleClient.html → EdgeRouteCircuitBreakerModuleClient.html} +206 -96
  84. data/{docs/NgrokAPI/Services/EndpointCompressionModuleClient.html → doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html} +206 -96
  85. data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +1153 -0
  86. data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +1153 -0
  87. data/{docs/NgrokAPI/Services/EndpointOIDCModuleClient.html → doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html} +206 -96
  88. data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1153 -0
  89. data/{docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html → doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html} +206 -96
  90. data/{docs/NgrokAPI/Services/EndpointSAMLModuleClient.html → doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html} +206 -96
  91. data/doc/NgrokAPI/Services/{EndpointWebhookValidationModuleClient.html → EdgeRouteWebhookVerificationModuleClient.html} +206 -96
  92. data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1153 -0
  93. data/doc/NgrokAPI/Services/{EventStreamsClient.html → EdgesHTTPSClient.html} +236 -271
  94. data/{docs/NgrokAPI/Services/EndpointConfigurationsClient.html → doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html} +456 -620
  95. data/doc/NgrokAPI/Services/EdgesTCPClient.html +1757 -0
  96. data/doc/NgrokAPI/Services/EdgesTLSClient.html +1847 -0
  97. data/doc/NgrokAPI/Services/EndpointsClient.html +907 -0
  98. data/doc/NgrokAPI/Services/EventDestinationsClient.html +35 -35
  99. data/doc/NgrokAPI/Services/EventSourcesClient.html +2 -2
  100. data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +5 -5
  101. data/doc/NgrokAPI/Services/FailoverBackendsClient.html +1644 -0
  102. data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +1744 -0
  103. data/doc/NgrokAPI/Services/{EndpointOIDCModuleClient.html → HTTPSEdgeMutualTLSModuleClient.html} +59 -59
  104. data/doc/NgrokAPI/Services/{EndpointRequestHeadersModuleClient.html → HTTPSEdgeTLSTerminationModuleClient.html} +59 -59
  105. data/doc/NgrokAPI/Services/IPPoliciesClient.html +40 -58
  106. data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +60 -40
  107. data/doc/NgrokAPI/Services/IPRestrictionsClient.html +3 -3
  108. data/doc/NgrokAPI/Services/ReservedAddrsClient.html +41 -331
  109. data/doc/NgrokAPI/Services/ReservedDomainsClient.html +94 -674
  110. data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +2 -2
  111. data/doc/NgrokAPI/Services/SSHCredentialsClient.html +2 -2
  112. data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +2 -2
  113. data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +2 -2
  114. data/{docs/NgrokAPI/Services/EndpointLoggingModuleClient.html → doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html} +59 -59
  115. data/doc/NgrokAPI/Services/{EndpointIPPolicyModuleClient.html → TCPEdgeIPRestrictionModuleClient.html} +41 -41
  116. data/doc/NgrokAPI/Services/TLSCertificatesClient.html +2 -2
  117. data/doc/NgrokAPI/Services/{EndpointLoggingModuleClient.html → TLSEdgeBackendModuleClient.html} +59 -59
  118. data/{docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html → doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html} +41 -41
  119. data/doc/NgrokAPI/Services/{EndpointMutualTLSModuleClient.html → TLSEdgeMutualTLSModuleClient.html} +41 -41
  120. data/{docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html → doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html} +41 -41
  121. data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +1644 -0
  122. data/doc/NgrokAPI/Services/TunnelSessionsClient.html +2 -2
  123. data/doc/NgrokAPI/Services/TunnelsClient.html +241 -3
  124. data/doc/NgrokAPI/Services/WeightedBackendsClient.html +1644 -0
  125. data/doc/NgrokAPI/Services.html +4 -4
  126. data/doc/NgrokAPI.html +3 -3
  127. data/doc/_index.html +237 -60
  128. data/doc/class_list.html +1 -1
  129. data/doc/file.README.html +2 -2
  130. data/doc/index.html +2 -2
  131. data/doc/method_list.html +3393 -1433
  132. data/doc/top-level-namespace.html +2 -2
  133. data/docs/NgrokAPI/Client.html +270 -180
  134. data/docs/NgrokAPI/Error.html +2 -2
  135. data/docs/NgrokAPI/Errors/NotFoundError.html +2 -2
  136. data/docs/NgrokAPI/Errors.html +2 -2
  137. data/docs/NgrokAPI/HttpClient.html +2 -2
  138. data/docs/NgrokAPI/Models/APIKey.html +2 -2
  139. data/docs/NgrokAPI/Models/AWSAuth.html +2 -2
  140. data/docs/NgrokAPI/Models/AWSCredentials.html +2 -2
  141. data/docs/NgrokAPI/Models/AWSRole.html +2 -2
  142. data/docs/NgrokAPI/Models/AbuseReport.html +2 -2
  143. data/docs/NgrokAPI/Models/AbuseReportHostname.html +2 -2
  144. data/docs/NgrokAPI/Models/AgentIngress.html +2 -2
  145. data/docs/NgrokAPI/Models/CertificateAuthority.html +2 -2
  146. data/docs/NgrokAPI/Models/Credential.html +2 -2
  147. data/docs/NgrokAPI/Models/Endpoint.html +1431 -0
  148. data/{doc/NgrokAPI/Models/EndpointLogging.html → docs/NgrokAPI/Models/EndpointBackend.html} +41 -41
  149. data/docs/NgrokAPI/Models/{EndpointLoggingMutate.html → EndpointBackendMutate.html} +41 -41
  150. data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +2 -2
  151. data/docs/NgrokAPI/Models/EndpointCompression.html +2 -2
  152. data/docs/NgrokAPI/Models/EndpointIPPolicy.html +2 -2
  153. data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +2 -2
  154. data/docs/NgrokAPI/Models/EndpointMutualTLS.html +2 -2
  155. data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +2 -2
  156. data/docs/NgrokAPI/Models/EndpointOAuth.html +2 -2
  157. data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +2 -2
  158. data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +2 -2
  159. data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +2 -2
  160. data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +2 -2
  161. data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +2 -2
  162. data/docs/NgrokAPI/Models/EndpointOIDC.html +2 -2
  163. data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +2 -2
  164. data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +2 -2
  165. data/docs/NgrokAPI/Models/EndpointSAML.html +2 -2
  166. data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +2 -2
  167. data/docs/NgrokAPI/Models/EndpointTLSTermination.html +2 -2
  168. data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +617 -0
  169. data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +2 -2
  170. data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +543 -0
  171. data/docs/NgrokAPI/Models/EventDestination.html +6 -6
  172. data/docs/NgrokAPI/Models/EventSource.html +2 -2
  173. data/docs/NgrokAPI/Models/EventSourceList.html +2 -2
  174. data/docs/NgrokAPI/Models/EventSourceReplace.html +2 -2
  175. data/docs/NgrokAPI/Models/EventSubscription.html +2 -2
  176. data/docs/NgrokAPI/Models/EventTarget.html +2 -2
  177. data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +2 -2
  178. data/docs/NgrokAPI/Models/EventTargetFirehose.html +2 -2
  179. data/docs/NgrokAPI/Models/EventTargetKinesis.html +2 -2
  180. data/docs/NgrokAPI/Models/FailoverBackend.html +1075 -0
  181. data/docs/NgrokAPI/Models/HTTPResponseBackend.html +1231 -0
  182. data/{doc/NgrokAPI/Models/EventStream.html → docs/NgrokAPI/Models/HTTPSEdge.html} +118 -118
  183. data/docs/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +202 -264
  184. data/docs/NgrokAPI/Models/IPPolicy.html +2 -2
  185. data/docs/NgrokAPI/Models/IPPolicyRule.html +96 -22
  186. data/docs/NgrokAPI/Models/IPRestriction.html +2 -2
  187. data/docs/NgrokAPI/Models/Listable.html +2 -2
  188. data/docs/NgrokAPI/Models/Ref.html +2 -2
  189. data/docs/NgrokAPI/Models/ReservedAddr.html +2 -2
  190. data/docs/NgrokAPI/Models/ReservedDomain.html +2 -2
  191. data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +2 -2
  192. data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +2 -2
  193. data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +2 -2
  194. data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +2 -2
  195. data/docs/NgrokAPI/Models/SSHCredential.html +2 -2
  196. data/docs/NgrokAPI/Models/SSHHostCertificate.html +2 -2
  197. data/docs/NgrokAPI/Models/SSHUserCertificate.html +2 -2
  198. data/docs/NgrokAPI/Models/TCPEdge.html +1235 -0
  199. data/docs/NgrokAPI/Models/TLSCertificate.html +2 -2
  200. data/docs/NgrokAPI/Models/TLSCertificateSANs.html +2 -2
  201. data/docs/NgrokAPI/Models/TLSEdge.html +1395 -0
  202. data/docs/NgrokAPI/Models/Tunnel.html +313 -17
  203. data/docs/NgrokAPI/Models/TunnelGroupBackend.html +1149 -0
  204. data/docs/NgrokAPI/Models/TunnelSession.html +2 -2
  205. data/docs/NgrokAPI/Models/WeightedBackend.html +1075 -0
  206. data/docs/NgrokAPI/Models.html +4 -4
  207. data/docs/NgrokAPI/PagedIterator.html +2 -2
  208. data/docs/NgrokAPI/Services/APIKeysClient.html +2 -2
  209. data/docs/NgrokAPI/Services/AbuseReportsClient.html +2 -2
  210. data/docs/NgrokAPI/Services/AgentIngressesClient.html +2 -2
  211. data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +2 -2
  212. data/docs/NgrokAPI/Services/CredentialsClient.html +2 -2
  213. data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1153 -0
  214. data/docs/NgrokAPI/Services/{EndpointCircuitBreakerModuleClient.html → EdgeRouteCircuitBreakerModuleClient.html} +206 -96
  215. data/{doc/NgrokAPI/Services/EndpointCompressionModuleClient.html → docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html} +206 -96
  216. data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +1153 -0
  217. data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +1153 -0
  218. data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +1153 -0
  219. data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1153 -0
  220. data/{doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html → docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html} +206 -96
  221. data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +1153 -0
  222. data/docs/NgrokAPI/Services/{EndpointWebhookValidationModuleClient.html → EdgeRouteWebhookVerificationModuleClient.html} +206 -96
  223. data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1153 -0
  224. data/docs/NgrokAPI/Services/{EventStreamsClient.html → EdgesHTTPSClient.html} +236 -271
  225. data/{doc/NgrokAPI/Services/EndpointConfigurationsClient.html → docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html} +456 -620
  226. data/docs/NgrokAPI/Services/EdgesTCPClient.html +1757 -0
  227. data/docs/NgrokAPI/Services/EdgesTLSClient.html +1847 -0
  228. data/docs/NgrokAPI/Services/EndpointsClient.html +907 -0
  229. data/docs/NgrokAPI/Services/EventDestinationsClient.html +35 -35
  230. data/docs/NgrokAPI/Services/EventSourcesClient.html +2 -2
  231. data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +5 -5
  232. data/docs/NgrokAPI/Services/FailoverBackendsClient.html +1644 -0
  233. data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +1744 -0
  234. data/{doc/NgrokAPI/Services/EndpointSAMLModuleClient.html → docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html} +59 -59
  235. data/docs/NgrokAPI/Services/{EndpointRequestHeadersModuleClient.html → HTTPSEdgeTLSTerminationModuleClient.html} +59 -59
  236. data/docs/NgrokAPI/Services/IPPoliciesClient.html +40 -58
  237. data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +60 -40
  238. data/docs/NgrokAPI/Services/IPRestrictionsClient.html +3 -3
  239. data/docs/NgrokAPI/Services/ReservedAddrsClient.html +41 -331
  240. data/docs/NgrokAPI/Services/ReservedDomainsClient.html +94 -674
  241. data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +2 -2
  242. data/docs/NgrokAPI/Services/SSHCredentialsClient.html +2 -2
  243. data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +2 -2
  244. data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +2 -2
  245. data/docs/NgrokAPI/Services/{EndpointOAuthModuleClient.html → TCPEdgeBackendModuleClient.html} +59 -59
  246. data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +1043 -0
  247. data/docs/NgrokAPI/Services/TLSCertificatesClient.html +2 -2
  248. data/{doc/NgrokAPI/Services/EndpointOAuthModuleClient.html → docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html} +59 -59
  249. data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +1043 -0
  250. data/docs/NgrokAPI/Services/{EndpointMutualTLSModuleClient.html → TLSEdgeMutualTLSModuleClient.html} +41 -41
  251. data/{doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html → docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html} +41 -41
  252. data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +1644 -0
  253. data/docs/NgrokAPI/Services/TunnelSessionsClient.html +2 -2
  254. data/docs/NgrokAPI/Services/TunnelsClient.html +241 -3
  255. data/docs/NgrokAPI/Services/WeightedBackendsClient.html +1644 -0
  256. data/docs/NgrokAPI/Services.html +4 -4
  257. data/docs/NgrokAPI.html +3 -3
  258. data/docs/_index.html +237 -60
  259. data/docs/class_list.html +1 -1
  260. data/docs/file.README.html +2 -2
  261. data/docs/index.html +2 -2
  262. data/docs/method_list.html +3393 -1433
  263. data/docs/top-level-namespace.html +2 -2
  264. data/lib/ngrokapi/client.rb +47 -24
  265. data/lib/ngrokapi/models/endpoint.rb +49 -0
  266. data/lib/ngrokapi/models/{endpoint_logging.rb → endpoint_backend.rb} +3 -3
  267. data/lib/ngrokapi/models/{endpoint_logging_mutate.rb → endpoint_backend_mutate.rb} +3 -3
  268. data/lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb +27 -0
  269. data/lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb +25 -0
  270. data/lib/ngrokapi/models/event_destination.rb +1 -2
  271. data/lib/ngrokapi/models/{event_stream.rb → failover_backend.rb} +15 -27
  272. data/lib/ngrokapi/models/http_response_backend.rb +71 -0
  273. data/lib/ngrokapi/models/https_edge.rb +80 -0
  274. data/lib/ngrokapi/models/{endpoint_configuration.rb → https_edge_route.rb} +56 -53
  275. data/lib/ngrokapi/models/ip_policy_rule.rb +3 -1
  276. data/lib/ngrokapi/models/tcp_edge.rb +78 -0
  277. data/lib/ngrokapi/models/tls_edge.rb +88 -0
  278. data/lib/ngrokapi/models/tunnel.rb +9 -1
  279. data/lib/ngrokapi/models/tunnel_group_backend.rb +67 -0
  280. data/lib/ngrokapi/models/weighted_backend.rb +65 -0
  281. data/lib/ngrokapi/services/edge_route_backend_module_client.rb +120 -0
  282. data/lib/ngrokapi/services/{endpoint_circuit_breaker_module_client.rb → edge_route_circuit_breaker_module_client.rb} +37 -25
  283. data/lib/ngrokapi/services/{endpoint_compression_module_client.rb → edge_route_compression_module_client.rb} +37 -25
  284. data/lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb +120 -0
  285. data/lib/ngrokapi/services/edge_route_o_auth_module_client.rb +120 -0
  286. data/lib/ngrokapi/services/edge_route_oidc_module_client.rb +120 -0
  287. data/lib/ngrokapi/services/edge_route_request_headers_module_client.rb +120 -0
  288. data/lib/ngrokapi/services/{endpoint_response_headers_module_client.rb → edge_route_response_headers_module_client.rb} +37 -25
  289. data/lib/ngrokapi/services/edge_route_saml_module_client.rb +120 -0
  290. data/lib/ngrokapi/services/{endpoint_webhook_validation_module_client.rb → edge_route_webhook_verification_module_client.rb} +37 -25
  291. data/lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb +120 -0
  292. data/lib/ngrokapi/services/edges_https_client.rb +227 -0
  293. data/lib/ngrokapi/services/edges_https_routes_client.rb +244 -0
  294. data/lib/ngrokapi/services/edges_tcp_client.rb +227 -0
  295. data/lib/ngrokapi/services/edges_tls_client.rb +239 -0
  296. data/lib/ngrokapi/services/endpoints_client.rb +114 -0
  297. data/lib/ngrokapi/services/event_destinations_client.rb +2 -4
  298. data/lib/ngrokapi/services/event_subscriptions_client.rb +3 -3
  299. data/lib/ngrokapi/services/failover_backends_client.rb +214 -0
  300. data/lib/ngrokapi/services/http_response_backends_client.rb +199 -0
  301. data/lib/ngrokapi/services/{endpoint_saml_module_client.rb → https_edge_mutual_tls_module_client.rb} +25 -25
  302. data/lib/ngrokapi/services/{endpoint_request_headers_module_client.rb → https_edge_tls_termination_module_client.rb} +25 -25
  303. data/lib/ngrokapi/services/ip_policies_client.rb +1 -3
  304. data/lib/ngrokapi/services/ip_policy_rules_client.rb +3 -1
  305. data/lib/ngrokapi/services/ip_restrictions_client.rb +1 -1
  306. data/lib/ngrokapi/services/reserved_addrs_client.rb +0 -37
  307. data/lib/ngrokapi/services/reserved_domains_client.rb +0 -74
  308. data/lib/ngrokapi/services/{endpoint_logging_module_client.rb → tcp_edge_backend_module_client.rb} +25 -25
  309. data/lib/ngrokapi/services/{endpoint_ip_policy_module_client.rb → tcp_edge_ip_restriction_module_client.rb} +15 -15
  310. data/lib/ngrokapi/services/{endpoint_oidc_module_client.rb → tls_edge_backend_module_client.rb} +25 -25
  311. data/lib/ngrokapi/services/{endpoint_o_auth_module_client.rb → tls_edge_ip_restriction_module_client.rb} +25 -25
  312. data/lib/ngrokapi/services/{endpoint_mutual_tls_module_client.rb → tls_edge_mutual_tls_module_client.rb} +15 -15
  313. data/lib/ngrokapi/services/{endpoint_tls_termination_module_client.rb → tls_edge_tls_termination_module_client.rb} +15 -15
  314. data/lib/ngrokapi/services/tunnel_group_backends_client.rb +212 -0
  315. data/lib/ngrokapi/services/tunnels_client.rb +35 -0
  316. data/lib/ngrokapi/services/weighted_backends_client.rb +214 -0
  317. data/lib/ngrokapi/version.rb +1 -1
  318. data/spec/ngrokapi/client_spec.rb +44 -23
  319. data/spec/ngrokapi/models/endpoint_backend_mutate_spec.rb +21 -0
  320. data/spec/ngrokapi/models/endpoint_backend_spec.rb +21 -0
  321. data/spec/ngrokapi/models/endpoint_spec.rb +21 -0
  322. data/spec/ngrokapi/models/endpoint_tls_termination_at_edge_spec.rb +21 -0
  323. data/spec/ngrokapi/models/endpoint_websocket_tcp_converter_spec.rb +21 -0
  324. data/spec/ngrokapi/models/failover_backend_spec.rb +45 -0
  325. data/spec/ngrokapi/models/http_response_backend_spec.rb +51 -0
  326. data/spec/ngrokapi/models/https_edge_route_spec.rb +81 -0
  327. data/spec/ngrokapi/models/https_edge_spec.rb +51 -0
  328. data/spec/ngrokapi/models/tcp_edge_spec.rb +51 -0
  329. data/spec/ngrokapi/models/tls_edge_spec.rb +57 -0
  330. data/spec/ngrokapi/models/tunnel_group_backend_spec.rb +45 -0
  331. data/spec/ngrokapi/models/weighted_backend_spec.rb +45 -0
  332. data/spec/ngrokapi/services/edge_route_backend_module_client_spec.rb +139 -0
  333. data/spec/ngrokapi/services/{endpoint_circuit_breaker_module_client_spec.rb → edge_route_circuit_breaker_module_client_spec.rb} +31 -17
  334. data/spec/ngrokapi/services/{endpoint_compression_module_client_spec.rb → edge_route_compression_module_client_spec.rb} +31 -17
  335. data/spec/ngrokapi/services/edge_route_ip_restriction_module_client_spec.rb +139 -0
  336. data/spec/ngrokapi/services/{endpoint_o_auth_module_client_spec.rb → edge_route_o_auth_module_client_spec.rb} +31 -17
  337. data/spec/ngrokapi/services/{endpoint_oidc_module_client_spec.rb → edge_route_oidc_module_client_spec.rb} +31 -17
  338. data/spec/ngrokapi/services/{endpoint_request_headers_module_client_spec.rb → edge_route_request_headers_module_client_spec.rb} +31 -17
  339. data/spec/ngrokapi/services/{endpoint_response_headers_module_client_spec.rb → edge_route_response_headers_module_client_spec.rb} +31 -17
  340. data/spec/ngrokapi/services/{endpoint_saml_module_client_spec.rb → edge_route_saml_module_client_spec.rb} +31 -17
  341. data/spec/ngrokapi/services/{endpoint_webhook_validation_module_client_spec.rb → edge_route_webhook_verification_module_client_spec.rb} +31 -17
  342. data/spec/ngrokapi/services/edge_route_websocket_tcp_converter_module_client_spec.rb +139 -0
  343. data/spec/ngrokapi/services/{event_streams_client_spec.rb → edges_https_client_spec.rb} +106 -108
  344. data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +241 -0
  345. data/spec/ngrokapi/services/edges_tcp_client_spec.rb +175 -0
  346. data/spec/ngrokapi/services/edges_tls_client_spec.rb +187 -0
  347. data/spec/ngrokapi/services/endpoints_client_spec.rb +57 -0
  348. data/spec/ngrokapi/services/failover_backends_client_spec.rb +163 -0
  349. data/spec/ngrokapi/services/http_response_backends_client_spec.rb +175 -0
  350. data/spec/ngrokapi/services/{endpoint_mutual_tls_module_client_spec.rb → https_edge_mutual_tls_module_client_spec.rb} +17 -17
  351. data/spec/ngrokapi/services/{endpoint_tls_termination_module_client_spec.rb → https_edge_tls_termination_module_client_spec.rb} +17 -17
  352. data/spec/ngrokapi/services/ip_policies_client_spec.rb +0 -1
  353. data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +3 -1
  354. data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +0 -44
  355. data/spec/ngrokapi/services/reserved_domains_client_spec.rb +0 -88
  356. data/spec/ngrokapi/services/{endpoint_logging_module_client_spec.rb → tcp_edge_backend_module_client_spec.rb} +40 -40
  357. data/spec/ngrokapi/services/{endpoint_ip_policy_module_client_spec.rb → tcp_edge_ip_restriction_module_client_spec.rb} +17 -17
  358. data/spec/ngrokapi/services/tls_edge_backend_module_client_spec.rb +125 -0
  359. data/spec/ngrokapi/services/tls_edge_ip_restriction_module_client_spec.rb +125 -0
  360. data/spec/ngrokapi/services/tls_edge_mutual_tls_module_client_spec.rb +125 -0
  361. data/spec/ngrokapi/services/tls_edge_tls_termination_module_client_spec.rb +125 -0
  362. data/spec/ngrokapi/services/tunnel_group_backends_client_spec.rb +163 -0
  363. data/spec/ngrokapi/services/tunnels_client_spec.rb +36 -0
  364. data/spec/ngrokapi/services/weighted_backends_client_spec.rb +163 -0
  365. data/spec/spec_helper.rb +326 -33
  366. metadata +166 -74
  367. data/lib/ngrokapi/services/endpoint_configurations_client.rb +0 -289
  368. data/lib/ngrokapi/services/event_streams_client.rb +0 -224
  369. data/spec/ngrokapi/models/endpoint_configuration_spec.rb +0 -78
  370. data/spec/ngrokapi/models/endpoint_logging_mutate_spec.rb +0 -21
  371. data/spec/ngrokapi/models/endpoint_logging_spec.rb +0 -21
  372. data/spec/ngrokapi/models/event_stream_spec.rb +0 -51
  373. data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +0 -237
@@ -0,0 +1,1847 @@
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::EdgesTLSClient
8
+
9
+ &mdash; 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::EdgesTLSClient";
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> &raquo;
40
+ <span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Services.html" title="NgrokAPI::Services (module)">Services</a></span></span>
41
+ &raquo;
42
+ <span class="title">EdgesTLSClient</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::EdgesTLSClient
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::EdgesTLSClient</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_tls_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-tls">ngrok.com/docs/api#api-edges-tls</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'>&#39;</span><span class='tstring_content'>/edges/tls</span><span class='tstring_end'>&#39;</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'>&#39;</span><span class='tstring_content'>tls_edges</span><span class='tstring_end'>&#39;</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> &#x21d2; 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: &quot;&quot;, metadata: &quot;&quot;, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) &#x21d2; NgrokAPI::Models::TLSEdge </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 TLS 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: &quot;&quot;) &#x21d2; 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 TLS 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: &quot;&quot;) &#x21d2; 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 TLS 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: &quot;&quot;) &#x21d2; NgrokAPI::Models::TLSEdge </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 TLS 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: &quot;&quot;) &#x21d2; NgrokAPI::Models::TLSEdge </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 TLS 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:) &#x21d2; EdgesTLSClient </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 EdgesTLSClient.</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) &#x21d2; 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 TLS 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) &#x21d2; 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 TLS 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: &quot;&quot;, description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) &#x21d2; NgrokAPI::Models::TLSEdge </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 TLS 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: &quot;&quot;, description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) &#x21d2; NgrokAPI::Models::TLSEdge </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 TLS 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:) &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Services::EdgesTLSClient (class)">EdgesTLSClient</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 EdgesTLSClient.</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_tls_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> &#x21d2; <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_tls_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: &quot;&quot;, metadata: &quot;&quot;, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/TLSEdge.html" title="NgrokAPI::Models::TLSEdge (class)">NgrokAPI::Models::TLSEdge</a></span></tt>
553
+
554
+
555
+
556
+
557
+
558
+ </h3><div class="docstring">
559
+ <div class="discussion">
560
+
561
+ <p>Create a TLS Edge</p>
562
+
563
+ <p><a href="https://ngrok.com/docs/api#api-edges-tls-create">ngrok.com/docs/api#api-edges-tls-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>&quot;&quot;</tt>)</em>
581
+
582
+
583
+ &mdash;
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>&quot;&quot;</tt>)</em>
599
+
600
+
601
+ &mdash;
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&lt;string&gt;</tt>)</span>
614
+
615
+
616
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
617
+
618
+
619
+ &mdash;
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
+ &mdash;
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
+ <li>
658
+
659
+ <span class='name'>mutual_tls</span>
660
+
661
+
662
+ <span class='type'>(<tt>EndpointMutualTLSMutate</tt>)</span>
663
+
664
+
665
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
666
+
667
+
668
+ </li>
669
+
670
+ <li>
671
+
672
+ <span class='name'>tls_termination</span>
673
+
674
+
675
+ <span class='type'>(<tt>EndpointTLSTermination</tt>)</span>
676
+
677
+
678
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
679
+
680
+
681
+ </li>
682
+
683
+ </ul>
684
+
685
+ <p class="tag_title">Returns:</p>
686
+ <ul class="return">
687
+
688
+ <li>
689
+
690
+
691
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/TLSEdge.html" title="NgrokAPI::Models::TLSEdge (class)">NgrokAPI::Models::TLSEdge</a></span></tt>)</span>
692
+
693
+
694
+
695
+ &mdash;
696
+ <div class='inline'>
697
+ <p>result from the API request</p>
698
+ </div>
699
+
700
+ </li>
701
+
702
+ </ul>
703
+
704
+ </div><table class="source_code">
705
+ <tr>
706
+ <td>
707
+ <pre class="lines">
708
+
709
+
710
+ 32
711
+ 33
712
+ 34
713
+ 35
714
+ 36
715
+ 37
716
+ 38
717
+ 39
718
+ 40
719
+ 41
720
+ 42
721
+ 43
722
+ 44
723
+ 45
724
+ 46</pre>
725
+ </td>
726
+ <td>
727
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tls_client.rb', line 32</span>
728
+
729
+ <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'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</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='comma'>,</span> <span class='label'>mutual_tls:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>tls_termination:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
730
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/edges/tls</span><span class='tstring_end'>&#39;</span></span>
731
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
732
+ <span class='rbrace'>}</span>
733
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
734
+ <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>
735
+ <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>
736
+ <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>
737
+ <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>
738
+ <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>
739
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:mutual_tls</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span> <span class='kw'>if</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span>
740
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:tls_termination</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span> <span class='kw'>if</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span>
741
+ <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>
742
+ <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/TLSEdge.html" title="NgrokAPI::Models::TLSEdge (class)">TLSEdge</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TLSEdge.html#initialize-instance_method" title="NgrokAPI::Models::TLSEdge#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>
743
+ <span class='kw'>end</span></pre>
744
+ </td>
745
+ </tr>
746
+ </table>
747
+ </div>
748
+
749
+ <div class="method_details ">
750
+ <h3 class="signature " id="delete-instance_method">
751
+
752
+ #<strong>delete</strong>(id: &quot;&quot;) &#x21d2; <tt>NgrokAPI::Models::Empty</tt>
753
+
754
+
755
+
756
+
757
+
758
+ </h3><div class="docstring">
759
+ <div class="discussion">
760
+
761
+ <p>Delete a TLS Edge by ID</p>
762
+
763
+ <p><a href="https://ngrok.com/docs/api#api-edges-tls-delete">ngrok.com/docs/api#api-edges-tls-delete</a></p>
764
+
765
+
766
+ </div>
767
+ </div>
768
+ <div class="tags">
769
+ <p class="tag_title">Parameters:</p>
770
+ <ul class="param">
771
+
772
+ <li>
773
+
774
+ <span class='name'>id</span>
775
+
776
+
777
+ <span class='type'>(<tt>string</tt>)</span>
778
+
779
+
780
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
781
+
782
+
783
+ &mdash;
784
+ <div class='inline'>
785
+ <p>a resource identifier</p>
786
+ </div>
787
+
788
+ </li>
789
+
790
+ </ul>
791
+
792
+ <p class="tag_title">Returns:</p>
793
+ <ul class="return">
794
+
795
+ <li>
796
+
797
+
798
+ <span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
799
+
800
+
801
+
802
+ &mdash;
803
+ <div class='inline'>
804
+ <p>result from the API request</p>
805
+ </div>
806
+
807
+ </li>
808
+
809
+ </ul>
810
+
811
+ </div><table class="source_code">
812
+ <tr>
813
+ <td>
814
+ <pre class="lines">
815
+
816
+
817
+ 214
818
+ 215
819
+ 216
820
+ 217
821
+ 218
822
+ 219
823
+ 220</pre>
824
+ </td>
825
+ <td>
826
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tls_client.rb', line 214</span>
827
+
828
+ <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'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
829
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/edges/tls/%{id}</span><span class='tstring_end'>&#39;</span></span>
830
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
831
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
832
+ <span class='rbrace'>}</span>
833
+ <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>
834
+ <span class='kw'>end</span></pre>
835
+ </td>
836
+ </tr>
837
+ </table>
838
+ </div>
839
+
840
+ <div class="method_details ">
841
+ <h3 class="signature " id="delete!-instance_method">
842
+
843
+ #<strong>delete!</strong>(id: &quot;&quot;) &#x21d2; <tt>NgrokAPI::Models::Empty</tt>
844
+
845
+
846
+
847
+
848
+
849
+ </h3><div class="docstring">
850
+ <div class="discussion">
851
+
852
+ <p>Delete a TLS Edge by ID Throws an exception if API error.</p>
853
+
854
+ <p><a href="https://ngrok.com/docs/api#api-edges-tls-delete">ngrok.com/docs/api#api-edges-tls-delete</a></p>
855
+
856
+
857
+ </div>
858
+ </div>
859
+ <div class="tags">
860
+ <p class="tag_title">Parameters:</p>
861
+ <ul class="param">
862
+
863
+ <li>
864
+
865
+ <span class='name'>id</span>
866
+
867
+
868
+ <span class='type'>(<tt>string</tt>)</span>
869
+
870
+
871
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
872
+
873
+
874
+ &mdash;
875
+ <div class='inline'>
876
+ <p>a resource identifier</p>
877
+ </div>
878
+
879
+ </li>
880
+
881
+ </ul>
882
+
883
+ <p class="tag_title">Returns:</p>
884
+ <ul class="return">
885
+
886
+ <li>
887
+
888
+
889
+ <span class='type'>(<tt>NgrokAPI::Models::Empty</tt>)</span>
890
+
891
+
892
+
893
+ &mdash;
894
+ <div class='inline'>
895
+ <p>result from the API request</p>
896
+ </div>
897
+
898
+ </li>
899
+
900
+ </ul>
901
+
902
+ </div><table class="source_code">
903
+ <tr>
904
+ <td>
905
+ <pre class="lines">
906
+
907
+
908
+ 230
909
+ 231
910
+ 232
911
+ 233
912
+ 234
913
+ 235
914
+ 236</pre>
915
+ </td>
916
+ <td>
917
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tls_client.rb', line 230</span>
918
+
919
+ <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'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
920
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/edges/tls/%{id}</span><span class='tstring_end'>&#39;</span></span>
921
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
922
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
923
+ <span class='rbrace'>}</span>
924
+ <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>
925
+ <span class='kw'>end</span></pre>
926
+ </td>
927
+ </tr>
928
+ </table>
929
+ </div>
930
+
931
+ <div class="method_details ">
932
+ <h3 class="signature " id="get-instance_method">
933
+
934
+ #<strong>get</strong>(id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/TLSEdge.html" title="NgrokAPI::Models::TLSEdge (class)">NgrokAPI::Models::TLSEdge</a></span></tt>
935
+
936
+
937
+
938
+
939
+
940
+ </h3><div class="docstring">
941
+ <div class="discussion">
942
+
943
+ <p>Get a TLS Edge by ID</p>
944
+
945
+ <p><a href="https://ngrok.com/docs/api#api-edges-tls-get">ngrok.com/docs/api#api-edges-tls-get</a></p>
946
+
947
+
948
+ </div>
949
+ </div>
950
+ <div class="tags">
951
+ <p class="tag_title">Parameters:</p>
952
+ <ul class="param">
953
+
954
+ <li>
955
+
956
+ <span class='name'>id</span>
957
+
958
+
959
+ <span class='type'>(<tt>string</tt>)</span>
960
+
961
+
962
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
963
+
964
+
965
+ &mdash;
966
+ <div class='inline'>
967
+ <p>a resource identifier</p>
968
+ </div>
969
+
970
+ </li>
971
+
972
+ </ul>
973
+
974
+ <p class="tag_title">Returns:</p>
975
+ <ul class="return">
976
+
977
+ <li>
978
+
979
+
980
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/TLSEdge.html" title="NgrokAPI::Models::TLSEdge (class)">NgrokAPI::Models::TLSEdge</a></span></tt>)</span>
981
+
982
+
983
+
984
+ &mdash;
985
+ <div class='inline'>
986
+ <p>result from the API request</p>
987
+ </div>
988
+
989
+ </li>
990
+
991
+ </ul>
992
+
993
+ </div><table class="source_code">
994
+ <tr>
995
+ <td>
996
+ <pre class="lines">
997
+
998
+
999
+ 55
1000
+ 56
1001
+ 57
1002
+ 58
1003
+ 59
1004
+ 60
1005
+ 61
1006
+ 62
1007
+ 63</pre>
1008
+ </td>
1009
+ <td>
1010
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tls_client.rb', line 55</span>
1011
+
1012
+ <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'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
1013
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/edges/tls/%{id}</span><span class='tstring_end'>&#39;</span></span>
1014
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1015
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1016
+ <span class='rbrace'>}</span>
1017
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1018
+ <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>
1019
+ <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/TLSEdge.html" title="NgrokAPI::Models::TLSEdge (class)">TLSEdge</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TLSEdge.html#initialize-instance_method" title="NgrokAPI::Models::TLSEdge#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>
1020
+ <span class='kw'>end</span></pre>
1021
+ </td>
1022
+ </tr>
1023
+ </table>
1024
+ </div>
1025
+
1026
+ <div class="method_details ">
1027
+ <h3 class="signature " id="get!-instance_method">
1028
+
1029
+ #<strong>get!</strong>(id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/TLSEdge.html" title="NgrokAPI::Models::TLSEdge (class)">NgrokAPI::Models::TLSEdge</a></span></tt>
1030
+
1031
+
1032
+
1033
+
1034
+
1035
+ </h3><div class="docstring">
1036
+ <div class="discussion">
1037
+
1038
+ <p>Get a TLS Edge by ID Throws an exception if API error.</p>
1039
+
1040
+ <p><a href="https://ngrok.com/docs/api#api-edges-tls-get">ngrok.com/docs/api#api-edges-tls-get</a></p>
1041
+
1042
+
1043
+ </div>
1044
+ </div>
1045
+ <div class="tags">
1046
+ <p class="tag_title">Parameters:</p>
1047
+ <ul class="param">
1048
+
1049
+ <li>
1050
+
1051
+ <span class='name'>id</span>
1052
+
1053
+
1054
+ <span class='type'>(<tt>string</tt>)</span>
1055
+
1056
+
1057
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
1058
+
1059
+
1060
+ &mdash;
1061
+ <div class='inline'>
1062
+ <p>a resource identifier</p>
1063
+ </div>
1064
+
1065
+ </li>
1066
+
1067
+ </ul>
1068
+
1069
+ <p class="tag_title">Returns:</p>
1070
+ <ul class="return">
1071
+
1072
+ <li>
1073
+
1074
+
1075
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/TLSEdge.html" title="NgrokAPI::Models::TLSEdge (class)">NgrokAPI::Models::TLSEdge</a></span></tt>)</span>
1076
+
1077
+
1078
+
1079
+ &mdash;
1080
+ <div class='inline'>
1081
+ <p>result from the API request</p>
1082
+ </div>
1083
+
1084
+ </li>
1085
+
1086
+ </ul>
1087
+
1088
+ </div><table class="source_code">
1089
+ <tr>
1090
+ <td>
1091
+ <pre class="lines">
1092
+
1093
+
1094
+ 73
1095
+ 74
1096
+ 75
1097
+ 76
1098
+ 77
1099
+ 78
1100
+ 79
1101
+ 80
1102
+ 81</pre>
1103
+ </td>
1104
+ <td>
1105
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tls_client.rb', line 73</span>
1106
+
1107
+ <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'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
1108
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/edges/tls/%{id}</span><span class='tstring_end'>&#39;</span></span>
1109
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1110
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1111
+ <span class='rbrace'>}</span>
1112
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1113
+ <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>
1114
+ <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/TLSEdge.html" title="NgrokAPI::Models::TLSEdge (class)">TLSEdge</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TLSEdge.html#initialize-instance_method" title="NgrokAPI::Models::TLSEdge#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>
1115
+ <span class='kw'>end</span></pre>
1116
+ </td>
1117
+ </tr>
1118
+ </table>
1119
+ </div>
1120
+
1121
+ <div class="method_details ">
1122
+ <h3 class="signature " id="list-instance_method">
1123
+
1124
+ #<strong>list</strong>(before_id: nil, limit: nil, url: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
1125
+
1126
+
1127
+
1128
+
1129
+
1130
+ </h3><div class="docstring">
1131
+ <div class="discussion">
1132
+
1133
+ <p>Returns a list of all TLS Edges on this account</p>
1134
+
1135
+ <p><a href="https://ngrok.com/docs/api#api-edges-tls-list">ngrok.com/docs/api#api-edges-tls-list</a></p>
1136
+
1137
+
1138
+ </div>
1139
+ </div>
1140
+ <div class="tags">
1141
+ <p class="tag_title">Parameters:</p>
1142
+ <ul class="param">
1143
+
1144
+ <li>
1145
+
1146
+ <span class='name'>before_id</span>
1147
+
1148
+
1149
+ <span class='type'>(<tt>string</tt>)</span>
1150
+
1151
+
1152
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1153
+
1154
+
1155
+ </li>
1156
+
1157
+ <li>
1158
+
1159
+ <span class='name'>limit</span>
1160
+
1161
+
1162
+ <span class='type'>(<tt>string</tt>)</span>
1163
+
1164
+
1165
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1166
+
1167
+
1168
+ </li>
1169
+
1170
+ <li>
1171
+
1172
+ <span class='name'>url</span>
1173
+
1174
+
1175
+ <span class='type'>(<tt>string</tt>)</span>
1176
+
1177
+
1178
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1179
+
1180
+
1181
+ &mdash;
1182
+ <div class='inline'>
1183
+ <p>optional and mutually exclusive from before_id and limit</p>
1184
+ </div>
1185
+
1186
+ </li>
1187
+
1188
+ </ul>
1189
+
1190
+ <p class="tag_title">Returns:</p>
1191
+ <ul class="return">
1192
+
1193
+ <li>
1194
+
1195
+
1196
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>)</span>
1197
+
1198
+
1199
+
1200
+ &mdash;
1201
+ <div class='inline'>
1202
+ <p>result from the API request</p>
1203
+ </div>
1204
+
1205
+ </li>
1206
+
1207
+ </ul>
1208
+
1209
+ </div><table class="source_code">
1210
+ <tr>
1211
+ <td>
1212
+ <pre class="lines">
1213
+
1214
+
1215
+ 92
1216
+ 93
1217
+ 94
1218
+ 95
1219
+ 96
1220
+ 97
1221
+ 98
1222
+ 99
1223
+ 100
1224
+ 101
1225
+ 102
1226
+ 103
1227
+ 104
1228
+ 105
1229
+ 106
1230
+ 107</pre>
1231
+ </td>
1232
+ <td>
1233
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tls_client.rb', line 92</span>
1234
+
1235
+ <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>
1236
+ <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1237
+ <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>
1238
+ <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
1239
+ <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
1240
+ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
1241
+ <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EdgesTLSClient::PATH (constant)">PATH</a></span></span>
1242
+ <span class='rparen'>)</span>
1243
+
1244
+ <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>
1245
+ <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
1246
+ <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1247
+ <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EdgesTLSClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1248
+ <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/TLSEdge.html" title="NgrokAPI::Models::TLSEdge (class)">TLSEdge</a></span></span>
1249
+ <span class='rparen'>)</span>
1250
+ <span class='kw'>end</span></pre>
1251
+ </td>
1252
+ </tr>
1253
+ </table>
1254
+ </div>
1255
+
1256
+ <div class="method_details ">
1257
+ <h3 class="signature " id="list!-instance_method">
1258
+
1259
+ #<strong>list!</strong>(before_id: nil, limit: nil, url: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/Listable.html" title="NgrokAPI::Models::Listable (class)">NgrokAPI::Models::Listable</a></span></tt>
1260
+
1261
+
1262
+
1263
+
1264
+
1265
+ </h3><div class="docstring">
1266
+ <div class="discussion">
1267
+
1268
+ <p>Returns a list of all TLS Edges on this account Throws an exception if API error.</p>
1269
+
1270
+ <p><a href="https://ngrok.com/docs/api#api-edges-tls-list">ngrok.com/docs/api#api-edges-tls-list</a></p>
1271
+
1272
+
1273
+ </div>
1274
+ </div>
1275
+ <div class="tags">
1276
+ <p class="tag_title">Parameters:</p>
1277
+ <ul class="param">
1278
+
1279
+ <li>
1280
+
1281
+ <span class='name'>before_id</span>
1282
+
1283
+
1284
+ <span class='type'>(<tt>string</tt>)</span>
1285
+
1286
+
1287
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1288
+
1289
+
1290
+ </li>
1291
+
1292
+ <li>
1293
+
1294
+ <span class='name'>limit</span>
1295
+
1296
+
1297
+ <span class='type'>(<tt>string</tt>)</span>
1298
+
1299
+
1300
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1301
+
1302
+
1303
+ </li>
1304
+
1305
+ <li>
1306
+
1307
+ <span class='name'>url</span>
1308
+
1309
+
1310
+ <span class='type'>(<tt>string</tt>)</span>
1311
+
1312
+
1313
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1314
+
1315
+
1316
+ &mdash;
1317
+ <div class='inline'>
1318
+ <p>optional and mutually exclusive from before_id and limit</p>
1319
+ </div>
1320
+
1321
+ </li>
1322
+
1323
+ </ul>
1324
+
1325
+ <p class="tag_title">Returns:</p>
1326
+ <ul class="return">
1327
+
1328
+ <li>
1329
+
1330
+
1331
+ <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>
1332
+
1333
+
1334
+
1335
+ &mdash;
1336
+ <div class='inline'>
1337
+ <p>result from the API request</p>
1338
+ </div>
1339
+
1340
+ </li>
1341
+
1342
+ </ul>
1343
+
1344
+ </div><table class="source_code">
1345
+ <tr>
1346
+ <td>
1347
+ <pre class="lines">
1348
+
1349
+
1350
+ 119
1351
+ 120
1352
+ 121
1353
+ 122
1354
+ 123
1355
+ 124
1356
+ 125
1357
+ 126
1358
+ 127
1359
+ 128
1360
+ 129
1361
+ 130
1362
+ 131
1363
+ 132
1364
+ 133
1365
+ 134
1366
+ 135
1367
+ 136</pre>
1368
+ </td>
1369
+ <td>
1370
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tls_client.rb', line 119</span>
1371
+
1372
+ <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>
1373
+ <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1374
+ <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>
1375
+ <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
1376
+ <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
1377
+ <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
1378
+ <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
1379
+ <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EdgesTLSClient::PATH (constant)">PATH</a></span></span>
1380
+ <span class='rparen'>)</span>
1381
+
1382
+ <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>
1383
+ <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
1384
+ <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1385
+ <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EdgesTLSClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1386
+ <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/TLSEdge.html" title="NgrokAPI::Models::TLSEdge (class)">TLSEdge</a></span></span><span class='comma'>,</span>
1387
+ <span class='label'>danger:</span> <span class='kw'>true</span>
1388
+ <span class='rparen'>)</span>
1389
+ <span class='kw'>end</span></pre>
1390
+ </td>
1391
+ </tr>
1392
+ </table>
1393
+ </div>
1394
+
1395
+ <div class="method_details ">
1396
+ <h3 class="signature " id="update-instance_method">
1397
+
1398
+ #<strong>update</strong>(id: &quot;&quot;, description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/TLSEdge.html" title="NgrokAPI::Models::TLSEdge (class)">NgrokAPI::Models::TLSEdge</a></span></tt>
1399
+
1400
+
1401
+
1402
+
1403
+
1404
+ </h3><div class="docstring">
1405
+ <div class="discussion">
1406
+
1407
+ <p>Updates a TLS 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>
1408
+
1409
+ <p><a href="https://ngrok.com/docs/api#api-edges-tls-update">ngrok.com/docs/api#api-edges-tls-update</a></p>
1410
+
1411
+
1412
+ </div>
1413
+ </div>
1414
+ <div class="tags">
1415
+ <p class="tag_title">Parameters:</p>
1416
+ <ul class="param">
1417
+
1418
+ <li>
1419
+
1420
+ <span class='name'>id</span>
1421
+
1422
+
1423
+ <span class='type'>(<tt>string</tt>)</span>
1424
+
1425
+
1426
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
1427
+
1428
+
1429
+ &mdash;
1430
+ <div class='inline'>
1431
+ <p>unique identifier of this edge</p>
1432
+ </div>
1433
+
1434
+ </li>
1435
+
1436
+ <li>
1437
+
1438
+ <span class='name'>description</span>
1439
+
1440
+
1441
+ <span class='type'>(<tt>string</tt>)</span>
1442
+
1443
+
1444
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1445
+
1446
+
1447
+ &mdash;
1448
+ <div class='inline'>
1449
+ <p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
1450
+ </div>
1451
+
1452
+ </li>
1453
+
1454
+ <li>
1455
+
1456
+ <span class='name'>metadata</span>
1457
+
1458
+
1459
+ <span class='type'>(<tt>string</tt>)</span>
1460
+
1461
+
1462
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1463
+
1464
+
1465
+ &mdash;
1466
+ <div class='inline'>
1467
+ <p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
1468
+ </div>
1469
+
1470
+ </li>
1471
+
1472
+ <li>
1473
+
1474
+ <span class='name'>hostports</span>
1475
+
1476
+
1477
+ <span class='type'>(<tt>List&lt;string&gt;</tt>)</span>
1478
+
1479
+
1480
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1481
+
1482
+
1483
+ &mdash;
1484
+ <div class='inline'>
1485
+ <p>hostports served by this edge</p>
1486
+ </div>
1487
+
1488
+ </li>
1489
+
1490
+ <li>
1491
+
1492
+ <span class='name'>backend</span>
1493
+
1494
+
1495
+ <span class='type'>(<tt>EndpointBackendMutate</tt>)</span>
1496
+
1497
+
1498
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1499
+
1500
+
1501
+ &mdash;
1502
+ <div class='inline'>
1503
+ <p>edge modules</p>
1504
+ </div>
1505
+
1506
+ </li>
1507
+
1508
+ <li>
1509
+
1510
+ <span class='name'>ip_restriction</span>
1511
+
1512
+
1513
+ <span class='type'>(<tt>EndpointIPPolicyMutate</tt>)</span>
1514
+
1515
+
1516
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1517
+
1518
+
1519
+ </li>
1520
+
1521
+ <li>
1522
+
1523
+ <span class='name'>mutual_tls</span>
1524
+
1525
+
1526
+ <span class='type'>(<tt>EndpointMutualTLSMutate</tt>)</span>
1527
+
1528
+
1529
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1530
+
1531
+
1532
+ </li>
1533
+
1534
+ <li>
1535
+
1536
+ <span class='name'>tls_termination</span>
1537
+
1538
+
1539
+ <span class='type'>(<tt>EndpointTLSTermination</tt>)</span>
1540
+
1541
+
1542
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1543
+
1544
+
1545
+ </li>
1546
+
1547
+ </ul>
1548
+
1549
+ <p class="tag_title">Returns:</p>
1550
+ <ul class="return">
1551
+
1552
+ <li>
1553
+
1554
+
1555
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/TLSEdge.html" title="NgrokAPI::Models::TLSEdge (class)">NgrokAPI::Models::TLSEdge</a></span></tt>)</span>
1556
+
1557
+
1558
+
1559
+ &mdash;
1560
+ <div class='inline'>
1561
+ <p>result from the API request</p>
1562
+ </div>
1563
+
1564
+ </li>
1565
+
1566
+ </ul>
1567
+
1568
+ </div><table class="source_code">
1569
+ <tr>
1570
+ <td>
1571
+ <pre class="lines">
1572
+
1573
+
1574
+ 155
1575
+ 156
1576
+ 157
1577
+ 158
1578
+ 159
1579
+ 160
1580
+ 161
1581
+ 162
1582
+ 163
1583
+ 164
1584
+ 165
1585
+ 166
1586
+ 167
1587
+ 168
1588
+ 169
1589
+ 170</pre>
1590
+ </td>
1591
+ <td>
1592
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tls_client.rb', line 155</span>
1593
+
1594
+ <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'>&quot;</span><span class='tstring_end'>&quot;</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='comma'>,</span> <span class='label'>mutual_tls:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>tls_termination:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1595
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/edges/tls/%{id}</span><span class='tstring_end'>&#39;</span></span>
1596
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1597
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1598
+ <span class='rbrace'>}</span>
1599
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1600
+ <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>
1601
+ <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>
1602
+ <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>
1603
+ <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>
1604
+ <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>
1605
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:mutual_tls</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span> <span class='kw'>if</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span>
1606
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:tls_termination</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span> <span class='kw'>if</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span>
1607
+ <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>
1608
+ <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/TLSEdge.html" title="NgrokAPI::Models::TLSEdge (class)">TLSEdge</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TLSEdge.html#initialize-instance_method" title="NgrokAPI::Models::TLSEdge#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>
1609
+ <span class='kw'>end</span></pre>
1610
+ </td>
1611
+ </tr>
1612
+ </table>
1613
+ </div>
1614
+
1615
+ <div class="method_details ">
1616
+ <h3 class="signature " id="update!-instance_method">
1617
+
1618
+ #<strong>update!</strong>(id: &quot;&quot;, description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/TLSEdge.html" title="NgrokAPI::Models::TLSEdge (class)">NgrokAPI::Models::TLSEdge</a></span></tt>
1619
+
1620
+
1621
+
1622
+
1623
+
1624
+ </h3><div class="docstring">
1625
+ <div class="discussion">
1626
+
1627
+ <p>Updates a TLS 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>
1628
+
1629
+ <p><a href="https://ngrok.com/docs/api#api-edges-tls-update">ngrok.com/docs/api#api-edges-tls-update</a></p>
1630
+
1631
+
1632
+ </div>
1633
+ </div>
1634
+ <div class="tags">
1635
+ <p class="tag_title">Parameters:</p>
1636
+ <ul class="param">
1637
+
1638
+ <li>
1639
+
1640
+ <span class='name'>id</span>
1641
+
1642
+
1643
+ <span class='type'>(<tt>string</tt>)</span>
1644
+
1645
+
1646
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
1647
+
1648
+
1649
+ &mdash;
1650
+ <div class='inline'>
1651
+ <p>unique identifier of this edge</p>
1652
+ </div>
1653
+
1654
+ </li>
1655
+
1656
+ <li>
1657
+
1658
+ <span class='name'>description</span>
1659
+
1660
+
1661
+ <span class='type'>(<tt>string</tt>)</span>
1662
+
1663
+
1664
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1665
+
1666
+
1667
+ &mdash;
1668
+ <div class='inline'>
1669
+ <p>human-readable description of what this edge will be used for; optional, max 255 bytes.</p>
1670
+ </div>
1671
+
1672
+ </li>
1673
+
1674
+ <li>
1675
+
1676
+ <span class='name'>metadata</span>
1677
+
1678
+
1679
+ <span class='type'>(<tt>string</tt>)</span>
1680
+
1681
+
1682
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1683
+
1684
+
1685
+ &mdash;
1686
+ <div class='inline'>
1687
+ <p>arbitrary user-defined machine-readable data of this edge. Optional, max 4096 bytes.</p>
1688
+ </div>
1689
+
1690
+ </li>
1691
+
1692
+ <li>
1693
+
1694
+ <span class='name'>hostports</span>
1695
+
1696
+
1697
+ <span class='type'>(<tt>List&lt;string&gt;</tt>)</span>
1698
+
1699
+
1700
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1701
+
1702
+
1703
+ &mdash;
1704
+ <div class='inline'>
1705
+ <p>hostports served by this edge</p>
1706
+ </div>
1707
+
1708
+ </li>
1709
+
1710
+ <li>
1711
+
1712
+ <span class='name'>backend</span>
1713
+
1714
+
1715
+ <span class='type'>(<tt>EndpointBackendMutate</tt>)</span>
1716
+
1717
+
1718
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1719
+
1720
+
1721
+ &mdash;
1722
+ <div class='inline'>
1723
+ <p>edge modules</p>
1724
+ </div>
1725
+
1726
+ </li>
1727
+
1728
+ <li>
1729
+
1730
+ <span class='name'>ip_restriction</span>
1731
+
1732
+
1733
+ <span class='type'>(<tt>EndpointIPPolicyMutate</tt>)</span>
1734
+
1735
+
1736
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1737
+
1738
+
1739
+ </li>
1740
+
1741
+ <li>
1742
+
1743
+ <span class='name'>mutual_tls</span>
1744
+
1745
+
1746
+ <span class='type'>(<tt>EndpointMutualTLSMutate</tt>)</span>
1747
+
1748
+
1749
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1750
+
1751
+
1752
+ </li>
1753
+
1754
+ <li>
1755
+
1756
+ <span class='name'>tls_termination</span>
1757
+
1758
+
1759
+ <span class='type'>(<tt>EndpointTLSTermination</tt>)</span>
1760
+
1761
+
1762
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1763
+
1764
+
1765
+ </li>
1766
+
1767
+ </ul>
1768
+
1769
+ <p class="tag_title">Returns:</p>
1770
+ <ul class="return">
1771
+
1772
+ <li>
1773
+
1774
+
1775
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/TLSEdge.html" title="NgrokAPI::Models::TLSEdge (class)">NgrokAPI::Models::TLSEdge</a></span></tt>)</span>
1776
+
1777
+
1778
+
1779
+ &mdash;
1780
+ <div class='inline'>
1781
+ <p>result from the API request</p>
1782
+ </div>
1783
+
1784
+ </li>
1785
+
1786
+ </ul>
1787
+
1788
+ </div><table class="source_code">
1789
+ <tr>
1790
+ <td>
1791
+ <pre class="lines">
1792
+
1793
+
1794
+ 190
1795
+ 191
1796
+ 192
1797
+ 193
1798
+ 194
1799
+ 195
1800
+ 196
1801
+ 197
1802
+ 198
1803
+ 199
1804
+ 200
1805
+ 201
1806
+ 202
1807
+ 203
1808
+ 204
1809
+ 205</pre>
1810
+ </td>
1811
+ <td>
1812
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tls_client.rb', line 190</span>
1813
+
1814
+ <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'>&quot;</span><span class='tstring_end'>&quot;</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='comma'>,</span> <span class='label'>mutual_tls:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>tls_termination:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1815
+ <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/edges/tls/%{id}</span><span class='tstring_end'>&#39;</span></span>
1816
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1817
+ <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1818
+ <span class='rbrace'>}</span>
1819
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1820
+ <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>
1821
+ <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>
1822
+ <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>
1823
+ <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>
1824
+ <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>
1825
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:mutual_tls</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span> <span class='kw'>if</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span>
1826
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:tls_termination</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span> <span class='kw'>if</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span>
1827
+ <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>
1828
+ <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/TLSEdge.html" title="NgrokAPI::Models::TLSEdge (class)">TLSEdge</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TLSEdge.html#initialize-instance_method" title="NgrokAPI::Models::TLSEdge#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>
1829
+ <span class='kw'>end</span></pre>
1830
+ </td>
1831
+ </tr>
1832
+ </table>
1833
+ </div>
1834
+
1835
+ </div>
1836
+
1837
+ </div>
1838
+
1839
+ <div id="footer">
1840
+ Generated on Thu Mar 10 04:54:50 2022 by
1841
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1842
+ 0.9.27 (ruby-2.7.5).
1843
+ </div>
1844
+
1845
+ </div>
1846
+ </body>
1847
+ </html>