ngrok-api 0.16.0 → 0.19.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (525) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +28 -1
  3. data/doc/NgrokAPI/Client.html +270 -180
  4. data/doc/NgrokAPI/Error.html +2 -2
  5. data/doc/NgrokAPI/Errors/NotFoundError.html +2 -2
  6. data/doc/NgrokAPI/Errors.html +2 -2
  7. data/doc/NgrokAPI/HttpClient.html +147 -4
  8. data/doc/NgrokAPI/Models/APIKey.html +120 -68
  9. data/doc/NgrokAPI/Models/AWSAuth.html +83 -31
  10. data/doc/NgrokAPI/Models/AWSCredentials.html +90 -38
  11. data/doc/NgrokAPI/Models/AWSRole.html +75 -23
  12. data/doc/NgrokAPI/Models/AbuseReport.html +109 -57
  13. data/doc/NgrokAPI/Models/AbuseReportHostname.html +83 -31
  14. data/doc/NgrokAPI/Models/AgentIngress.html +142 -90
  15. data/doc/NgrokAPI/Models/CertificateAuthority.html +149 -97
  16. data/doc/NgrokAPI/Models/Credential.html +121 -69
  17. data/doc/NgrokAPI/Models/Endpoint.html +1483 -0
  18. data/doc/NgrokAPI/Models/{EndpointLoggingMutate.html → EndpointBackend.html} +105 -53
  19. data/doc/NgrokAPI/Models/EndpointBackendMutate.html +669 -0
  20. data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +101 -49
  21. data/doc/NgrokAPI/Models/EndpointCompression.html +82 -30
  22. data/doc/NgrokAPI/Models/EndpointIPPolicy.html +90 -38
  23. data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +90 -38
  24. data/doc/NgrokAPI/Models/EndpointMutualTLS.html +90 -38
  25. data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +90 -38
  26. data/doc/NgrokAPI/Models/EndpointOAuth.html +124 -72
  27. data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +107 -55
  28. data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +116 -64
  29. data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +107 -55
  30. data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +107 -55
  31. data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +106 -54
  32. data/doc/NgrokAPI/Models/EndpointOIDC.html +133 -81
  33. data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +91 -39
  34. data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +91 -39
  35. data/doc/NgrokAPI/Models/EndpointSAML.html +148 -96
  36. data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +133 -81
  37. data/doc/NgrokAPI/Models/EndpointTLSTermination.html +91 -39
  38. data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +669 -0
  39. data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +91 -39
  40. data/{docs/NgrokAPI/Models/EndpointLogging.html → doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html} +95 -117
  41. data/doc/NgrokAPI/Models/EventDestination.html +122 -70
  42. data/doc/NgrokAPI/Models/EventSource.html +92 -40
  43. data/doc/NgrokAPI/Models/EventSourceList.html +76 -24
  44. data/doc/NgrokAPI/Models/EventSourceReplace.html +91 -39
  45. data/doc/NgrokAPI/Models/EventSubscription.html +122 -70
  46. data/doc/NgrokAPI/Models/EventTarget.html +106 -54
  47. data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +90 -38
  48. data/doc/NgrokAPI/Models/EventTargetFirehose.html +90 -38
  49. data/doc/NgrokAPI/Models/EventTargetKinesis.html +83 -31
  50. data/doc/NgrokAPI/Models/FailoverBackend.html +1127 -0
  51. data/{docs/NgrokAPI/Models/EventStream.html → doc/NgrokAPI/Models/HTTPResponseBackend.html} +170 -196
  52. data/doc/NgrokAPI/Models/HTTPSEdge.html +1361 -0
  53. data/doc/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +278 -288
  54. data/doc/NgrokAPI/Models/IPPolicy.html +120 -68
  55. data/doc/NgrokAPI/Models/IPPolicyRule.html +222 -96
  56. data/doc/NgrokAPI/Models/IPRestriction.html +130 -78
  57. data/doc/NgrokAPI/Models/Listable.html +61 -61
  58. data/doc/NgrokAPI/Models/Ref.html +83 -31
  59. data/doc/NgrokAPI/Models/ReservedAddr.html +130 -78
  60. data/doc/NgrokAPI/Models/ReservedDomain.html +151 -99
  61. data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +92 -40
  62. data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +90 -38
  63. data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +90 -38
  64. data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +135 -83
  65. data/doc/NgrokAPI/Models/SSHCredential.html +128 -76
  66. data/doc/NgrokAPI/Models/SSHHostCertificate.html +148 -96
  67. data/doc/NgrokAPI/Models/SSHUserCertificate.html +154 -102
  68. data/doc/NgrokAPI/Models/TCPEdge.html +1287 -0
  69. data/doc/NgrokAPI/Models/TLSCertificate.html +165 -113
  70. data/doc/NgrokAPI/Models/TLSCertificateSANs.html +90 -38
  71. data/doc/NgrokAPI/Models/TLSEdge.html +1447 -0
  72. data/doc/NgrokAPI/Models/Tunnel.html +413 -65
  73. data/doc/NgrokAPI/Models/TunnelGroupBackend.html +1201 -0
  74. data/doc/NgrokAPI/Models/TunnelSession.html +126 -74
  75. data/doc/NgrokAPI/Models/WeightedBackend.html +1127 -0
  76. data/doc/NgrokAPI/Models.html +4 -4
  77. data/doc/NgrokAPI/PagedIterator.html +3 -3
  78. data/doc/NgrokAPI/Services/APIKeysClient.html +244 -109
  79. data/doc/NgrokAPI/Services/AbuseReportsClient.html +162 -25
  80. data/doc/NgrokAPI/Services/AgentIngressesClient.html +262 -109
  81. data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +262 -109
  82. data/doc/NgrokAPI/Services/CredentialsClient.html +266 -111
  83. data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1149 -0
  84. data/doc/NgrokAPI/Services/{EndpointCircuitBreakerModuleClient.html → EdgeRouteCircuitBreakerModuleClient.html} +205 -99
  85. data/{docs/NgrokAPI/Services/EndpointCompressionModuleClient.html → doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html} +205 -99
  86. data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +1149 -0
  87. data/doc/NgrokAPI/Services/{EndpointOAuthModuleClient.html → EdgeRouteOAuthModuleClient.html} +205 -99
  88. data/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +1149 -0
  89. data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1149 -0
  90. data/doc/NgrokAPI/Services/{EndpointResponseHeadersModuleClient.html → EdgeRouteResponseHeadersModuleClient.html} +205 -99
  91. data/{docs/NgrokAPI/Services/EndpointSAMLModuleClient.html → doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html} +205 -99
  92. data/{docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html → doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html} +205 -99
  93. data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1149 -0
  94. data/doc/NgrokAPI/Services/EdgesHTTPSClient.html +1947 -0
  95. data/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +2585 -0
  96. data/doc/NgrokAPI/Services/EdgesTCPClient.html +1947 -0
  97. data/{docs/NgrokAPI/Services/EndpointConfigurationsClient.html → doc/NgrokAPI/Services/EdgesTLSClient.html} +374 -641
  98. data/doc/NgrokAPI/Services/EndpointsClient.html +903 -0
  99. data/doc/NgrokAPI/Services/EventDestinationsClient.html +290 -115
  100. data/doc/NgrokAPI/Services/EventSourcesClient.html +227 -88
  101. data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +291 -116
  102. data/doc/NgrokAPI/Services/{EventStreamsClient.html → FailoverBackendsClient.html} +342 -335
  103. data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +1937 -0
  104. data/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +1039 -0
  105. data/{docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html → doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html} +76 -80
  106. data/doc/NgrokAPI/Services/IPPoliciesClient.html +245 -128
  107. data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +328 -117
  108. data/doc/NgrokAPI/Services/IPRestrictionsClient.html +305 -114
  109. data/doc/NgrokAPI/Services/ReservedAddrsClient.html +160 -295
  110. data/doc/NgrokAPI/Services/ReservedDomainsClient.html +257 -624
  111. data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +304 -109
  112. data/doc/NgrokAPI/Services/SSHCredentialsClient.html +284 -111
  113. data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +340 -109
  114. data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +381 -110
  115. data/{docs/NgrokAPI/Services/EndpointLoggingModuleClient.html → doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html} +76 -80
  116. data/doc/NgrokAPI/Services/{EndpointIPPolicyModuleClient.html → TCPEdgeIPRestrictionModuleClient.html} +62 -66
  117. data/doc/NgrokAPI/Services/TLSCertificatesClient.html +280 -109
  118. data/doc/NgrokAPI/Services/{EndpointLoggingModuleClient.html → TLSEdgeBackendModuleClient.html} +76 -80
  119. data/{docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html → doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html} +62 -66
  120. data/doc/NgrokAPI/Services/{EndpointMutualTLSModuleClient.html → TLSEdgeMutualTLSModuleClient.html} +62 -66
  121. data/doc/NgrokAPI/Services/{EndpointTLSTerminationModuleClient.html → TLSEdgeTLSTerminationModuleClient.html} +62 -66
  122. data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +1799 -0
  123. data/doc/NgrokAPI/Services/TunnelSessionsClient.html +44 -48
  124. data/doc/NgrokAPI/Services/TunnelsClient.html +249 -15
  125. data/doc/NgrokAPI/Services/WeightedBackendsClient.html +1799 -0
  126. data/doc/NgrokAPI/Services.html +4 -4
  127. data/doc/NgrokAPI.html +3 -3
  128. data/doc/_index.html +237 -60
  129. data/doc/class_list.html +1 -1
  130. data/doc/file.README.html +55 -55
  131. data/doc/index.html +55 -55
  132. data/doc/method_list.html +4555 -1843
  133. data/doc/top-level-namespace.html +2 -2
  134. data/docs/NgrokAPI/Client.html +270 -180
  135. data/docs/NgrokAPI/Error.html +2 -2
  136. data/docs/NgrokAPI/Errors/NotFoundError.html +2 -2
  137. data/docs/NgrokAPI/Errors.html +2 -2
  138. data/docs/NgrokAPI/HttpClient.html +147 -4
  139. data/docs/NgrokAPI/Models/APIKey.html +120 -68
  140. data/docs/NgrokAPI/Models/AWSAuth.html +83 -31
  141. data/docs/NgrokAPI/Models/AWSCredentials.html +90 -38
  142. data/docs/NgrokAPI/Models/AWSRole.html +75 -23
  143. data/docs/NgrokAPI/Models/AbuseReport.html +109 -57
  144. data/docs/NgrokAPI/Models/AbuseReportHostname.html +83 -31
  145. data/docs/NgrokAPI/Models/AgentIngress.html +142 -90
  146. data/docs/NgrokAPI/Models/CertificateAuthority.html +149 -97
  147. data/docs/NgrokAPI/Models/Credential.html +121 -69
  148. data/docs/NgrokAPI/Models/Endpoint.html +1483 -0
  149. data/docs/NgrokAPI/Models/{EndpointLoggingMutate.html → EndpointBackend.html} +105 -53
  150. data/docs/NgrokAPI/Models/EndpointBackendMutate.html +669 -0
  151. data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +101 -49
  152. data/docs/NgrokAPI/Models/EndpointCompression.html +82 -30
  153. data/docs/NgrokAPI/Models/EndpointIPPolicy.html +90 -38
  154. data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +90 -38
  155. data/docs/NgrokAPI/Models/EndpointMutualTLS.html +90 -38
  156. data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +90 -38
  157. data/docs/NgrokAPI/Models/EndpointOAuth.html +124 -72
  158. data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +107 -55
  159. data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +116 -64
  160. data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +107 -55
  161. data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +107 -55
  162. data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +106 -54
  163. data/docs/NgrokAPI/Models/EndpointOIDC.html +133 -81
  164. data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +91 -39
  165. data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +91 -39
  166. data/docs/NgrokAPI/Models/EndpointSAML.html +148 -96
  167. data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +133 -81
  168. data/docs/NgrokAPI/Models/EndpointTLSTermination.html +91 -39
  169. data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +669 -0
  170. data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +91 -39
  171. data/{doc/NgrokAPI/Models/EndpointLogging.html → docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html} +95 -117
  172. data/docs/NgrokAPI/Models/EventDestination.html +122 -70
  173. data/docs/NgrokAPI/Models/EventSource.html +92 -40
  174. data/docs/NgrokAPI/Models/EventSourceList.html +76 -24
  175. data/docs/NgrokAPI/Models/EventSourceReplace.html +91 -39
  176. data/docs/NgrokAPI/Models/EventSubscription.html +122 -70
  177. data/docs/NgrokAPI/Models/EventTarget.html +106 -54
  178. data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +90 -38
  179. data/docs/NgrokAPI/Models/EventTargetFirehose.html +90 -38
  180. data/docs/NgrokAPI/Models/EventTargetKinesis.html +83 -31
  181. data/docs/NgrokAPI/Models/FailoverBackend.html +1127 -0
  182. data/{doc/NgrokAPI/Models/EventStream.html → docs/NgrokAPI/Models/HTTPResponseBackend.html} +170 -196
  183. data/docs/NgrokAPI/Models/HTTPSEdge.html +1361 -0
  184. data/docs/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +278 -288
  185. data/docs/NgrokAPI/Models/IPPolicy.html +120 -68
  186. data/docs/NgrokAPI/Models/IPPolicyRule.html +222 -96
  187. data/docs/NgrokAPI/Models/IPRestriction.html +130 -78
  188. data/docs/NgrokAPI/Models/Listable.html +61 -61
  189. data/docs/NgrokAPI/Models/Ref.html +83 -31
  190. data/docs/NgrokAPI/Models/ReservedAddr.html +130 -78
  191. data/docs/NgrokAPI/Models/ReservedDomain.html +151 -99
  192. data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +92 -40
  193. data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +90 -38
  194. data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +90 -38
  195. data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +135 -83
  196. data/docs/NgrokAPI/Models/SSHCredential.html +128 -76
  197. data/docs/NgrokAPI/Models/SSHHostCertificate.html +148 -96
  198. data/docs/NgrokAPI/Models/SSHUserCertificate.html +154 -102
  199. data/docs/NgrokAPI/Models/TCPEdge.html +1287 -0
  200. data/docs/NgrokAPI/Models/TLSCertificate.html +165 -113
  201. data/docs/NgrokAPI/Models/TLSCertificateSANs.html +90 -38
  202. data/docs/NgrokAPI/Models/TLSEdge.html +1447 -0
  203. data/docs/NgrokAPI/Models/Tunnel.html +413 -65
  204. data/docs/NgrokAPI/Models/TunnelGroupBackend.html +1201 -0
  205. data/docs/NgrokAPI/Models/TunnelSession.html +126 -74
  206. data/docs/NgrokAPI/Models/WeightedBackend.html +1127 -0
  207. data/docs/NgrokAPI/Models.html +4 -4
  208. data/docs/NgrokAPI/PagedIterator.html +3 -3
  209. data/docs/NgrokAPI/Services/APIKeysClient.html +244 -109
  210. data/docs/NgrokAPI/Services/AbuseReportsClient.html +162 -25
  211. data/docs/NgrokAPI/Services/AgentIngressesClient.html +262 -109
  212. data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +262 -109
  213. data/docs/NgrokAPI/Services/CredentialsClient.html +266 -111
  214. data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1149 -0
  215. data/docs/NgrokAPI/Services/{EndpointCircuitBreakerModuleClient.html → EdgeRouteCircuitBreakerModuleClient.html} +205 -99
  216. data/{doc/NgrokAPI/Services/EndpointCompressionModuleClient.html → docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html} +205 -99
  217. data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +1149 -0
  218. data/docs/NgrokAPI/Services/{EndpointOAuthModuleClient.html → EdgeRouteOAuthModuleClient.html} +205 -99
  219. data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +1149 -0
  220. data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1149 -0
  221. data/docs/NgrokAPI/Services/{EndpointResponseHeadersModuleClient.html → EdgeRouteResponseHeadersModuleClient.html} +205 -99
  222. data/{doc/NgrokAPI/Services/EndpointSAMLModuleClient.html → docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html} +205 -99
  223. data/{doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html → docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html} +205 -99
  224. data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1149 -0
  225. data/docs/NgrokAPI/Services/EdgesHTTPSClient.html +1947 -0
  226. data/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +2585 -0
  227. data/docs/NgrokAPI/Services/EdgesTCPClient.html +1947 -0
  228. data/{doc/NgrokAPI/Services/EndpointConfigurationsClient.html → docs/NgrokAPI/Services/EdgesTLSClient.html} +374 -641
  229. data/docs/NgrokAPI/Services/EndpointsClient.html +903 -0
  230. data/docs/NgrokAPI/Services/EventDestinationsClient.html +290 -115
  231. data/docs/NgrokAPI/Services/EventSourcesClient.html +227 -88
  232. data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +291 -116
  233. data/docs/NgrokAPI/Services/{EventStreamsClient.html → FailoverBackendsClient.html} +342 -335
  234. data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +1937 -0
  235. data/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +1039 -0
  236. data/{doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html → docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html} +76 -80
  237. data/docs/NgrokAPI/Services/IPPoliciesClient.html +245 -128
  238. data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +328 -117
  239. data/docs/NgrokAPI/Services/IPRestrictionsClient.html +305 -114
  240. data/docs/NgrokAPI/Services/ReservedAddrsClient.html +160 -295
  241. data/docs/NgrokAPI/Services/ReservedDomainsClient.html +257 -624
  242. data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +304 -109
  243. data/docs/NgrokAPI/Services/SSHCredentialsClient.html +284 -111
  244. data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +340 -109
  245. data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +381 -110
  246. data/docs/NgrokAPI/Services/{EndpointOIDCModuleClient.html → TCPEdgeBackendModuleClient.html} +76 -80
  247. data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +1039 -0
  248. data/docs/NgrokAPI/Services/TLSCertificatesClient.html +280 -109
  249. data/{doc/NgrokAPI/Services/EndpointOIDCModuleClient.html → docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html} +76 -80
  250. data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +1039 -0
  251. data/docs/NgrokAPI/Services/{EndpointMutualTLSModuleClient.html → TLSEdgeMutualTLSModuleClient.html} +62 -66
  252. data/docs/NgrokAPI/Services/{EndpointTLSTerminationModuleClient.html → TLSEdgeTLSTerminationModuleClient.html} +62 -66
  253. data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +1799 -0
  254. data/docs/NgrokAPI/Services/TunnelSessionsClient.html +44 -48
  255. data/docs/NgrokAPI/Services/TunnelsClient.html +249 -15
  256. data/docs/NgrokAPI/Services/WeightedBackendsClient.html +1799 -0
  257. data/docs/NgrokAPI/Services.html +4 -4
  258. data/docs/NgrokAPI.html +3 -3
  259. data/docs/_index.html +237 -60
  260. data/docs/class_list.html +1 -1
  261. data/docs/file.README.html +55 -55
  262. data/docs/index.html +55 -55
  263. data/docs/method_list.html +4555 -1843
  264. data/docs/top-level-namespace.html +2 -2
  265. data/lib/ngrokapi/client.rb +47 -24
  266. data/lib/ngrokapi/http_client.rb +21 -2
  267. data/lib/ngrokapi/models/abuse_report.rb +16 -12
  268. data/lib/ngrokapi/models/abuse_report_hostname.rb +11 -7
  269. data/lib/ngrokapi/models/agent_ingress.rb +17 -13
  270. data/lib/ngrokapi/models/api_key.rb +15 -11
  271. data/lib/ngrokapi/models/aws_auth.rb +11 -7
  272. data/lib/ngrokapi/models/aws_credentials.rb +11 -7
  273. data/lib/ngrokapi/models/aws_role.rb +10 -6
  274. data/lib/ngrokapi/models/certificate_authority.rb +20 -16
  275. data/lib/ngrokapi/models/credential.rb +16 -12
  276. data/lib/ngrokapi/models/endpoint.rb +53 -0
  277. data/lib/ngrokapi/models/endpoint_backend.rb +31 -0
  278. data/lib/ngrokapi/models/endpoint_backend_mutate.rb +31 -0
  279. data/lib/ngrokapi/models/endpoint_circuit_breaker.rb +15 -11
  280. data/lib/ngrokapi/models/endpoint_compression.rb +10 -6
  281. data/lib/ngrokapi/models/endpoint_ip_policy.rb +11 -7
  282. data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb +11 -7
  283. data/lib/ngrokapi/models/endpoint_mutual_tls.rb +11 -7
  284. data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb +11 -7
  285. data/lib/ngrokapi/models/endpoint_o_auth.rb +16 -12
  286. data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb +14 -10
  287. data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb +16 -12
  288. data/lib/ngrokapi/models/endpoint_o_auth_google.rb +14 -10
  289. data/lib/ngrokapi/models/endpoint_o_auth_microsoft.rb +14 -10
  290. data/lib/ngrokapi/models/endpoint_o_auth_provider.rb +13 -9
  291. data/lib/ngrokapi/models/endpoint_oidc.rb +18 -14
  292. data/lib/ngrokapi/models/endpoint_request_headers.rb +12 -8
  293. data/lib/ngrokapi/models/endpoint_response_headers.rb +12 -8
  294. data/lib/ngrokapi/models/endpoint_saml.rb +25 -21
  295. data/lib/ngrokapi/models/endpoint_saml_mutate.rb +20 -16
  296. data/lib/ngrokapi/models/endpoint_tls_termination.rb +12 -8
  297. data/lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb +31 -0
  298. data/lib/ngrokapi/models/endpoint_webhook_validation.rb +12 -8
  299. data/lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb +29 -0
  300. data/lib/ngrokapi/models/event_destination.rb +17 -14
  301. data/lib/ngrokapi/models/event_source.rb +13 -9
  302. data/lib/ngrokapi/models/event_source_list.rb +11 -7
  303. data/lib/ngrokapi/models/event_source_replace.rb +12 -8
  304. data/lib/ngrokapi/models/event_subscription.rb +16 -12
  305. data/lib/ngrokapi/models/event_target.rb +13 -9
  306. data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb +11 -7
  307. data/lib/ngrokapi/models/event_target_firehose.rb +11 -7
  308. data/lib/ngrokapi/models/event_target_kinesis.rb +11 -7
  309. data/lib/ngrokapi/models/failover_backend.rb +69 -0
  310. data/lib/ngrokapi/models/http_response_backend.rb +75 -0
  311. data/lib/ngrokapi/models/https_edge.rb +84 -0
  312. data/lib/ngrokapi/models/https_edge_route.rb +137 -0
  313. data/lib/ngrokapi/models/ip_policy.rb +15 -11
  314. data/lib/ngrokapi/models/ip_policy_rule.rb +19 -13
  315. data/lib/ngrokapi/models/ip_restriction.rb +17 -13
  316. data/lib/ngrokapi/models/listable.rb +9 -9
  317. data/lib/ngrokapi/models/ref.rb +11 -7
  318. data/lib/ngrokapi/models/reserved_addr.rb +17 -13
  319. data/lib/ngrokapi/models/reserved_domain.rb +23 -19
  320. data/lib/ngrokapi/models/reserved_domain_cert_job.rb +13 -9
  321. data/lib/ngrokapi/models/reserved_domain_cert_policy.rb +11 -7
  322. data/lib/ngrokapi/models/reserved_domain_cert_status.rb +11 -7
  323. data/lib/ngrokapi/models/ssh_certificate_authority.rb +16 -12
  324. data/lib/ngrokapi/models/ssh_credential.rb +16 -12
  325. data/lib/ngrokapi/models/ssh_host_certificate.rb +21 -17
  326. data/lib/ngrokapi/models/ssh_user_certificate.rb +23 -19
  327. data/lib/ngrokapi/models/tcp_edge.rb +82 -0
  328. data/lib/ngrokapi/models/tls_certificate.rb +30 -26
  329. data/lib/ngrokapi/models/tls_certificate_sa_ns.rb +11 -7
  330. data/lib/ngrokapi/models/tls_edge.rb +92 -0
  331. data/lib/ngrokapi/models/tunnel.rb +25 -13
  332. data/lib/ngrokapi/models/tunnel_group_backend.rb +71 -0
  333. data/lib/ngrokapi/models/tunnel_session.rb +19 -15
  334. data/lib/ngrokapi/models/weighted_backend.rb +69 -0
  335. data/lib/ngrokapi/paged_iterator.rb +1 -1
  336. data/lib/ngrokapi/services/abuse_reports_client.rb +25 -3
  337. data/lib/ngrokapi/services/agent_ingresses_client.rb +32 -11
  338. data/lib/ngrokapi/services/api_keys_client.rb +30 -11
  339. data/lib/ngrokapi/services/certificate_authorities_client.rb +31 -11
  340. data/lib/ngrokapi/services/credentials_client.rb +34 -11
  341. data/lib/ngrokapi/services/edge_route_backend_module_client.rb +118 -0
  342. data/lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb +118 -0
  343. data/lib/ngrokapi/services/edge_route_compression_module_client.rb +118 -0
  344. data/lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb +118 -0
  345. data/lib/ngrokapi/services/edge_route_o_auth_module_client.rb +118 -0
  346. data/lib/ngrokapi/services/edge_route_oidc_module_client.rb +118 -0
  347. data/lib/ngrokapi/services/edge_route_request_headers_module_client.rb +118 -0
  348. data/lib/ngrokapi/services/edge_route_response_headers_module_client.rb +118 -0
  349. data/lib/ngrokapi/services/edge_route_saml_module_client.rb +118 -0
  350. data/lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb +118 -0
  351. data/lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb +118 -0
  352. data/lib/ngrokapi/services/edges_https_client.rb +251 -0
  353. data/lib/ngrokapi/services/edges_https_routes_client.rb +292 -0
  354. data/lib/ngrokapi/services/edges_tcp_client.rb +251 -0
  355. data/lib/ngrokapi/services/edges_tls_client.rb +267 -0
  356. data/lib/ngrokapi/services/endpoints_client.rb +112 -0
  357. data/lib/ngrokapi/services/event_destinations_client.rb +37 -15
  358. data/lib/ngrokapi/services/event_sources_client.rb +27 -7
  359. data/lib/ngrokapi/services/event_subscriptions_client.rb +36 -14
  360. data/lib/ngrokapi/services/failover_backends_client.rb +234 -0
  361. data/lib/ngrokapi/services/http_response_backends_client.rb +220 -0
  362. data/lib/ngrokapi/services/{endpoint_oidc_module_client.rb → https_edge_mutual_tls_module_client.rb} +27 -29
  363. data/lib/ngrokapi/services/https_edge_tls_termination_module_client.rb +106 -0
  364. data/lib/ngrokapi/services/ip_policies_client.rb +31 -14
  365. data/lib/ngrokapi/services/ip_policy_rules_client.rb +38 -12
  366. data/lib/ngrokapi/services/ip_restrictions_client.rb +36 -12
  367. data/lib/ngrokapi/services/reserved_addrs_client.rb +31 -48
  368. data/lib/ngrokapi/services/reserved_domains_client.rb +37 -85
  369. data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +35 -11
  370. data/lib/ngrokapi/services/ssh_credentials_client.rb +34 -11
  371. data/lib/ngrokapi/services/ssh_host_certificates_client.rb +39 -11
  372. data/lib/ngrokapi/services/ssh_user_certificates_client.rb +44 -12
  373. data/lib/ngrokapi/services/{endpoint_logging_module_client.rb → tcp_edge_backend_module_client.rb} +27 -29
  374. data/lib/ngrokapi/services/{endpoint_ip_policy_module_client.rb → tcp_edge_ip_restriction_module_client.rb} +21 -23
  375. data/lib/ngrokapi/services/tls_certificates_client.rb +33 -11
  376. data/lib/ngrokapi/services/{endpoint_saml_module_client.rb → tls_edge_backend_module_client.rb} +27 -29
  377. data/lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb +106 -0
  378. data/lib/ngrokapi/services/{endpoint_mutual_tls_module_client.rb → tls_edge_mutual_tls_module_client.rb} +21 -23
  379. data/lib/ngrokapi/services/{endpoint_tls_termination_module_client.rb → tls_edge_tls_termination_module_client.rb} +21 -23
  380. data/lib/ngrokapi/services/tunnel_group_backends_client.rb +232 -0
  381. data/lib/ngrokapi/services/tunnel_sessions_client.rb +6 -8
  382. data/lib/ngrokapi/services/tunnels_client.rb +39 -6
  383. data/lib/ngrokapi/services/weighted_backends_client.rb +234 -0
  384. data/lib/ngrokapi/version.rb +1 -1
  385. data/lib/ngrokapi.rb +1 -1
  386. data/spec/ngrokapi/client_spec.rb +44 -23
  387. data/spec/ngrokapi/models/abuse_report_hostname_spec.rb +2 -2
  388. data/spec/ngrokapi/models/abuse_report_spec.rb +2 -2
  389. data/spec/ngrokapi/models/agent_ingress_spec.rb +2 -2
  390. data/spec/ngrokapi/models/api_key_spec.rb +2 -2
  391. data/spec/ngrokapi/models/aws_auth_spec.rb +2 -2
  392. data/spec/ngrokapi/models/aws_credentials_spec.rb +2 -2
  393. data/spec/ngrokapi/models/aws_role_spec.rb +2 -2
  394. data/spec/ngrokapi/models/certificate_authority_spec.rb +2 -2
  395. data/spec/ngrokapi/models/credential_spec.rb +2 -2
  396. data/spec/ngrokapi/models/endpoint_backend_mutate_spec.rb +21 -0
  397. data/spec/ngrokapi/models/endpoint_backend_spec.rb +21 -0
  398. data/spec/ngrokapi/models/endpoint_circuit_breaker_spec.rb +2 -2
  399. data/spec/ngrokapi/models/endpoint_compression_spec.rb +2 -2
  400. data/spec/ngrokapi/models/endpoint_ip_policy_mutate_spec.rb +2 -2
  401. data/spec/ngrokapi/models/endpoint_ip_policy_spec.rb +2 -2
  402. data/spec/ngrokapi/models/endpoint_mutual_tls_mutate_spec.rb +2 -2
  403. data/spec/ngrokapi/models/endpoint_mutual_tls_spec.rb +2 -2
  404. data/spec/ngrokapi/models/endpoint_o_auth_facebook_spec.rb +2 -2
  405. data/spec/ngrokapi/models/endpoint_o_auth_git_hub_spec.rb +2 -2
  406. data/spec/ngrokapi/models/endpoint_o_auth_google_spec.rb +2 -2
  407. data/spec/ngrokapi/models/endpoint_o_auth_microsoft_spec.rb +2 -2
  408. data/spec/ngrokapi/models/endpoint_o_auth_provider_spec.rb +2 -2
  409. data/spec/ngrokapi/models/endpoint_o_auth_spec.rb +2 -2
  410. data/spec/ngrokapi/models/endpoint_oidc_spec.rb +2 -2
  411. data/spec/ngrokapi/models/endpoint_request_headers_spec.rb +2 -2
  412. data/spec/ngrokapi/models/endpoint_response_headers_spec.rb +2 -2
  413. data/spec/ngrokapi/models/endpoint_saml_mutate_spec.rb +2 -2
  414. data/spec/ngrokapi/models/endpoint_saml_spec.rb +2 -2
  415. data/spec/ngrokapi/models/endpoint_spec.rb +21 -0
  416. data/spec/ngrokapi/models/endpoint_tls_termination_at_edge_spec.rb +21 -0
  417. data/spec/ngrokapi/models/endpoint_tls_termination_spec.rb +2 -2
  418. data/spec/ngrokapi/models/endpoint_webhook_validation_spec.rb +2 -2
  419. data/spec/ngrokapi/models/endpoint_websocket_tcp_converter_spec.rb +21 -0
  420. data/spec/ngrokapi/models/event_destination_spec.rb +2 -2
  421. data/spec/ngrokapi/models/event_source_list_spec.rb +2 -2
  422. data/spec/ngrokapi/models/event_source_replace_spec.rb +2 -2
  423. data/spec/ngrokapi/models/event_source_spec.rb +2 -2
  424. data/spec/ngrokapi/models/event_subscription_spec.rb +2 -2
  425. data/spec/ngrokapi/models/event_target_cloudwatch_logs_spec.rb +2 -2
  426. data/spec/ngrokapi/models/event_target_firehose_spec.rb +2 -2
  427. data/spec/ngrokapi/models/event_target_kinesis_spec.rb +2 -2
  428. data/spec/ngrokapi/models/event_target_spec.rb +2 -2
  429. data/spec/ngrokapi/models/failover_backend_spec.rb +45 -0
  430. data/spec/ngrokapi/models/http_response_backend_spec.rb +51 -0
  431. data/spec/ngrokapi/models/https_edge_route_spec.rb +81 -0
  432. data/spec/ngrokapi/models/https_edge_spec.rb +51 -0
  433. data/spec/ngrokapi/models/ip_policy_rule_spec.rb +2 -2
  434. data/spec/ngrokapi/models/ip_policy_spec.rb +2 -2
  435. data/spec/ngrokapi/models/ip_restriction_spec.rb +2 -2
  436. data/spec/ngrokapi/models/listable_spec.rb +2 -2
  437. data/spec/ngrokapi/models/ref_spec.rb +2 -2
  438. data/spec/ngrokapi/models/reserved_addr_spec.rb +2 -2
  439. data/spec/ngrokapi/models/reserved_domain_cert_job_spec.rb +2 -2
  440. data/spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb +2 -2
  441. data/spec/ngrokapi/models/reserved_domain_cert_status_spec.rb +2 -2
  442. data/spec/ngrokapi/models/reserved_domain_spec.rb +2 -2
  443. data/spec/ngrokapi/models/ssh_certificate_authority_spec.rb +2 -2
  444. data/spec/ngrokapi/models/ssh_credential_spec.rb +2 -2
  445. data/spec/ngrokapi/models/ssh_host_certificate_spec.rb +2 -2
  446. data/spec/ngrokapi/models/ssh_user_certificate_spec.rb +2 -2
  447. data/spec/ngrokapi/models/tcp_edge_spec.rb +51 -0
  448. data/spec/ngrokapi/models/tls_certificate_sa_ns_spec.rb +2 -2
  449. data/spec/ngrokapi/models/tls_certificate_spec.rb +2 -2
  450. data/spec/ngrokapi/models/tls_edge_spec.rb +57 -0
  451. data/spec/ngrokapi/models/tunnel_group_backend_spec.rb +45 -0
  452. data/spec/ngrokapi/models/tunnel_session_spec.rb +2 -2
  453. data/spec/ngrokapi/models/tunnel_spec.rb +2 -2
  454. data/spec/ngrokapi/models/weighted_backend_spec.rb +45 -0
  455. data/spec/ngrokapi/paged_iterator_spec.rb +5 -5
  456. data/spec/ngrokapi/services/abuse_reports_client_spec.rb +19 -0
  457. data/spec/ngrokapi/services/agent_ingresses_client_spec.rb +21 -0
  458. data/spec/ngrokapi/services/api_keys_client_spec.rb +19 -0
  459. data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +21 -0
  460. data/spec/ngrokapi/services/credentials_client_spec.rb +21 -0
  461. data/spec/ngrokapi/services/edge_route_backend_module_client_spec.rb +137 -0
  462. data/spec/ngrokapi/services/{endpoint_circuit_breaker_module_client_spec.rb → edge_route_circuit_breaker_module_client_spec.rb} +33 -21
  463. data/spec/ngrokapi/services/{endpoint_compression_module_client_spec.rb → edge_route_compression_module_client_spec.rb} +33 -21
  464. data/spec/ngrokapi/services/edge_route_ip_restriction_module_client_spec.rb +137 -0
  465. data/spec/ngrokapi/services/{endpoint_o_auth_module_client_spec.rb → edge_route_o_auth_module_client_spec.rb} +33 -21
  466. data/spec/ngrokapi/services/{endpoint_oidc_module_client_spec.rb → edge_route_oidc_module_client_spec.rb} +33 -21
  467. data/spec/ngrokapi/services/{endpoint_request_headers_module_client_spec.rb → edge_route_request_headers_module_client_spec.rb} +33 -21
  468. data/spec/ngrokapi/services/{endpoint_response_headers_module_client_spec.rb → edge_route_response_headers_module_client_spec.rb} +33 -21
  469. data/spec/ngrokapi/services/{endpoint_saml_module_client_spec.rb → edge_route_saml_module_client_spec.rb} +33 -21
  470. data/spec/ngrokapi/services/{endpoint_webhook_validation_module_client_spec.rb → edge_route_webhook_verification_module_client_spec.rb} +33 -21
  471. data/spec/ngrokapi/services/edge_route_websocket_tcp_converter_module_client_spec.rb +137 -0
  472. data/spec/ngrokapi/services/edges_https_client_spec.rb +200 -0
  473. data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +288 -0
  474. data/spec/ngrokapi/services/edges_tcp_client_spec.rb +200 -0
  475. data/spec/ngrokapi/services/edges_tls_client_spec.rb +216 -0
  476. data/spec/ngrokapi/services/endpoints_client_spec.rb +57 -0
  477. data/spec/ngrokapi/services/event_destinations_client_spec.rb +24 -0
  478. data/spec/ngrokapi/services/event_sources_client_spec.rb +21 -0
  479. data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +23 -0
  480. data/spec/ngrokapi/services/failover_backends_client_spec.rb +184 -0
  481. data/spec/ngrokapi/services/http_response_backends_client_spec.rb +200 -0
  482. data/spec/ngrokapi/services/{endpoint_mutual_tls_module_client_spec.rb → https_edge_mutual_tls_module_client_spec.rb} +19 -21
  483. data/spec/ngrokapi/services/{endpoint_tls_termination_module_client_spec.rb → https_edge_tls_termination_module_client_spec.rb} +19 -21
  484. data/spec/ngrokapi/services/ip_policies_client_spec.rb +20 -1
  485. data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +28 -1
  486. data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +25 -0
  487. data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +22 -44
  488. data/spec/ngrokapi/services/reserved_domains_client_spec.rb +29 -88
  489. data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +25 -0
  490. data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +23 -0
  491. data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +29 -0
  492. data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +33 -0
  493. data/spec/ngrokapi/services/tcp_edge_backend_module_client_spec.rb +123 -0
  494. data/spec/ngrokapi/services/{endpoint_ip_policy_module_client_spec.rb → tcp_edge_ip_restriction_module_client_spec.rb} +19 -21
  495. data/spec/ngrokapi/services/tls_certificates_client_spec.rb +23 -0
  496. data/spec/ngrokapi/services/tls_edge_backend_module_client_spec.rb +123 -0
  497. data/spec/ngrokapi/services/tls_edge_ip_restriction_module_client_spec.rb +123 -0
  498. data/spec/ngrokapi/services/tls_edge_mutual_tls_module_client_spec.rb +123 -0
  499. data/spec/ngrokapi/services/tls_edge_tls_termination_module_client_spec.rb +123 -0
  500. data/spec/ngrokapi/services/tunnel_group_backends_client_spec.rb +184 -0
  501. data/spec/ngrokapi/services/tunnels_client_spec.rb +36 -0
  502. data/spec/ngrokapi/services/weighted_backends_client_spec.rb +184 -0
  503. data/spec/spec_helper.rb +326 -33
  504. metadata +166 -76
  505. data/doc/README +0 -94
  506. data/docs/README +0 -94
  507. data/lib/ngrokapi/models/endpoint_configuration.rb +0 -130
  508. data/lib/ngrokapi/models/endpoint_logging.rb +0 -27
  509. data/lib/ngrokapi/models/endpoint_logging_mutate.rb +0 -27
  510. data/lib/ngrokapi/models/event_stream.rb +0 -77
  511. data/lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb +0 -108
  512. data/lib/ngrokapi/services/endpoint_compression_module_client.rb +0 -108
  513. data/lib/ngrokapi/services/endpoint_configurations_client.rb +0 -289
  514. data/lib/ngrokapi/services/endpoint_o_auth_module_client.rb +0 -108
  515. data/lib/ngrokapi/services/endpoint_request_headers_module_client.rb +0 -108
  516. data/lib/ngrokapi/services/endpoint_response_headers_module_client.rb +0 -108
  517. data/lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb +0 -108
  518. data/lib/ngrokapi/services/event_streams_client.rb +0 -224
  519. data/spec/ngrokapi/models/endpoint_configuration_spec.rb +0 -78
  520. data/spec/ngrokapi/models/endpoint_logging_mutate_spec.rb +0 -21
  521. data/spec/ngrokapi/models/endpoint_logging_spec.rb +0 -21
  522. data/spec/ngrokapi/models/event_stream_spec.rb +0 -51
  523. data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +0 -237
  524. data/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb +0 -125
  525. data/spec/ngrokapi/services/event_streams_client_spec.rb +0 -177
@@ -0,0 +1,1361 @@
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::Models::HTTPSEdge
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::Models::HTTPSEdge";
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 (H)</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="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span>
41
+ &raquo;
42
+ <span class="title">HTTPSEdge</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::Models::HTTPSEdge
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::Models::HTTPSEdge</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/models/https_edge.rb</dd>
98
+ </dl>
99
+
100
+ </div>
101
+
102
+
103
+
104
+
105
+
106
+ <h2>Instance Attribute Summary <small><a href="#" class="summary_toggle">collapse</a></small></h2>
107
+ <ul class="summary">
108
+
109
+ <li class="public ">
110
+ <span class="summary_signature">
111
+
112
+ <a href="#attrs-instance_method" title="#attrs (instance method)">#<strong>attrs</strong> &#x21d2; Object </a>
113
+
114
+
115
+
116
+ </span>
117
+
118
+
119
+
120
+
121
+ <span class="note title readonly">readonly</span>
122
+
123
+
124
+
125
+
126
+
127
+
128
+
129
+
130
+
131
+ <span class="summary_desc"><div class='inline'>
132
+ <p>Returns the value of attribute attrs.</p>
133
+ </div></span>
134
+
135
+ </li>
136
+
137
+
138
+ <li class="public ">
139
+ <span class="summary_signature">
140
+
141
+ <a href="#client-instance_method" title="#client (instance method)">#<strong>client</strong> &#x21d2; Object </a>
142
+
143
+
144
+
145
+ </span>
146
+
147
+
148
+
149
+
150
+ <span class="note title readonly">readonly</span>
151
+
152
+
153
+
154
+
155
+
156
+
157
+
158
+
159
+
160
+ <span class="summary_desc"><div class='inline'>
161
+ <p>Returns the value of attribute client.</p>
162
+ </div></span>
163
+
164
+ </li>
165
+
166
+
167
+ <li class="public ">
168
+ <span class="summary_signature">
169
+
170
+ <a href="#created_at-instance_method" title="#created_at (instance method)">#<strong>created_at</strong> &#x21d2; Object </a>
171
+
172
+
173
+
174
+ </span>
175
+
176
+
177
+
178
+
179
+ <span class="note title readonly">readonly</span>
180
+
181
+
182
+
183
+
184
+
185
+
186
+
187
+
188
+
189
+ <span class="summary_desc"><div class='inline'>
190
+ <p>Returns the value of attribute created_at.</p>
191
+ </div></span>
192
+
193
+ </li>
194
+
195
+
196
+ <li class="public ">
197
+ <span class="summary_signature">
198
+
199
+ <a href="#description-instance_method" title="#description (instance method)">#<strong>description</strong> &#x21d2; Object </a>
200
+
201
+
202
+
203
+ </span>
204
+
205
+
206
+
207
+
208
+ <span class="note title readonly">readonly</span>
209
+
210
+
211
+
212
+
213
+
214
+
215
+
216
+
217
+
218
+ <span class="summary_desc"><div class='inline'>
219
+ <p>Returns the value of attribute description.</p>
220
+ </div></span>
221
+
222
+ </li>
223
+
224
+
225
+ <li class="public ">
226
+ <span class="summary_signature">
227
+
228
+ <a href="#hostports-instance_method" title="#hostports (instance method)">#<strong>hostports</strong> &#x21d2; Object </a>
229
+
230
+
231
+
232
+ </span>
233
+
234
+
235
+
236
+
237
+ <span class="note title readonly">readonly</span>
238
+
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+ <span class="summary_desc"><div class='inline'>
248
+ <p>Returns the value of attribute hostports.</p>
249
+ </div></span>
250
+
251
+ </li>
252
+
253
+
254
+ <li class="public ">
255
+ <span class="summary_signature">
256
+
257
+ <a href="#id-instance_method" title="#id (instance method)">#<strong>id</strong> &#x21d2; Object </a>
258
+
259
+
260
+
261
+ </span>
262
+
263
+
264
+
265
+
266
+ <span class="note title readonly">readonly</span>
267
+
268
+
269
+
270
+
271
+
272
+
273
+
274
+
275
+
276
+ <span class="summary_desc"><div class='inline'>
277
+ <p>Returns the value of attribute id.</p>
278
+ </div></span>
279
+
280
+ </li>
281
+
282
+
283
+ <li class="public ">
284
+ <span class="summary_signature">
285
+
286
+ <a href="#metadata-instance_method" title="#metadata (instance method)">#<strong>metadata</strong> &#x21d2; Object </a>
287
+
288
+
289
+
290
+ </span>
291
+
292
+
293
+
294
+
295
+ <span class="note title readonly">readonly</span>
296
+
297
+
298
+
299
+
300
+
301
+
302
+
303
+
304
+
305
+ <span class="summary_desc"><div class='inline'>
306
+ <p>Returns the value of attribute metadata.</p>
307
+ </div></span>
308
+
309
+ </li>
310
+
311
+
312
+ <li class="public ">
313
+ <span class="summary_signature">
314
+
315
+ <a href="#mutual_tls-instance_method" title="#mutual_tls (instance method)">#<strong>mutual_tls</strong> &#x21d2; Object </a>
316
+
317
+
318
+
319
+ </span>
320
+
321
+
322
+
323
+
324
+ <span class="note title readonly">readonly</span>
325
+
326
+
327
+
328
+
329
+
330
+
331
+
332
+
333
+
334
+ <span class="summary_desc"><div class='inline'>
335
+ <p>Returns the value of attribute mutual_tls.</p>
336
+ </div></span>
337
+
338
+ </li>
339
+
340
+
341
+ <li class="public ">
342
+ <span class="summary_signature">
343
+
344
+ <a href="#routes-instance_method" title="#routes (instance method)">#<strong>routes</strong> &#x21d2; Object </a>
345
+
346
+
347
+
348
+ </span>
349
+
350
+
351
+
352
+
353
+ <span class="note title readonly">readonly</span>
354
+
355
+
356
+
357
+
358
+
359
+
360
+
361
+
362
+
363
+ <span class="summary_desc"><div class='inline'>
364
+ <p>Returns the value of attribute routes.</p>
365
+ </div></span>
366
+
367
+ </li>
368
+
369
+
370
+ <li class="public ">
371
+ <span class="summary_signature">
372
+
373
+ <a href="#tls_termination-instance_method" title="#tls_termination (instance method)">#<strong>tls_termination</strong> &#x21d2; Object </a>
374
+
375
+
376
+
377
+ </span>
378
+
379
+
380
+
381
+
382
+ <span class="note title readonly">readonly</span>
383
+
384
+
385
+
386
+
387
+
388
+
389
+
390
+
391
+
392
+ <span class="summary_desc"><div class='inline'>
393
+ <p>Returns the value of attribute tls_termination.</p>
394
+ </div></span>
395
+
396
+ </li>
397
+
398
+
399
+ <li class="public ">
400
+ <span class="summary_signature">
401
+
402
+ <a href="#uri-instance_method" title="#uri (instance method)">#<strong>uri</strong> &#x21d2; Object </a>
403
+
404
+
405
+
406
+ </span>
407
+
408
+
409
+
410
+
411
+ <span class="note title readonly">readonly</span>
412
+
413
+
414
+
415
+
416
+
417
+
418
+
419
+
420
+
421
+ <span class="summary_desc"><div class='inline'>
422
+ <p>Returns the value of attribute uri.</p>
423
+ </div></span>
424
+
425
+ </li>
426
+
427
+
428
+ </ul>
429
+
430
+
431
+
432
+
433
+
434
+ <h2>
435
+ Instance Method Summary
436
+ <small><a href="#" class="summary_toggle">collapse</a></small>
437
+ </h2>
438
+
439
+ <ul class="summary">
440
+
441
+ <li class="public ">
442
+ <span class="summary_signature">
443
+
444
+ <a href="#==-instance_method" title="#== (instance method)">#<strong>==</strong>(other) &#x21d2; Object </a>
445
+
446
+
447
+
448
+ </span>
449
+
450
+
451
+
452
+
453
+
454
+
455
+
456
+
457
+
458
+ <span class="summary_desc"><div class='inline'></div></span>
459
+
460
+ </li>
461
+
462
+
463
+ <li class="public ">
464
+ <span class="summary_signature">
465
+
466
+ <a href="#delete-instance_method" title="#delete (instance method)">#<strong>delete</strong> &#x21d2; Object </a>
467
+
468
+
469
+
470
+ </span>
471
+
472
+
473
+
474
+
475
+
476
+
477
+
478
+
479
+
480
+ <span class="summary_desc"><div class='inline'>
481
+ <p>Delete an HTTPS Edge by ID.</p>
482
+ </div></span>
483
+
484
+ </li>
485
+
486
+
487
+ <li class="public ">
488
+ <span class="summary_signature">
489
+
490
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client: nil, attrs: {}) &#x21d2; HTTPSEdge </a>
491
+
492
+
493
+
494
+ </span>
495
+
496
+
497
+ <span class="note title constructor">constructor</span>
498
+
499
+
500
+
501
+
502
+
503
+
504
+
505
+
506
+ <span class="summary_desc"><div class='inline'>
507
+ <p>A new instance of HTTPSEdge.</p>
508
+ </div></span>
509
+
510
+ </li>
511
+
512
+
513
+ <li class="public ">
514
+ <span class="summary_signature">
515
+
516
+ <a href="#to_h-instance_method" title="#to_h (instance method)">#<strong>to_h</strong> &#x21d2; Object </a>
517
+
518
+
519
+
520
+ </span>
521
+
522
+
523
+
524
+
525
+
526
+
527
+
528
+
529
+
530
+ <span class="summary_desc"><div class='inline'></div></span>
531
+
532
+ </li>
533
+
534
+
535
+ <li class="public ">
536
+ <span class="summary_signature">
537
+
538
+ <a href="#to_s-instance_method" title="#to_s (instance method)">#<strong>to_s</strong> &#x21d2; Object </a>
539
+
540
+
541
+
542
+ </span>
543
+
544
+
545
+
546
+
547
+
548
+
549
+
550
+
551
+
552
+ <span class="summary_desc"><div class='inline'></div></span>
553
+
554
+ </li>
555
+
556
+
557
+ <li class="public ">
558
+ <span class="summary_signature">
559
+
560
+ <a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(description: nil, metadata: nil, hostports: nil, mutual_tls: nil, tls_termination: nil) &#x21d2; Object </a>
561
+
562
+
563
+
564
+ </span>
565
+
566
+
567
+
568
+
569
+
570
+
571
+
572
+
573
+
574
+ <span class="summary_desc"><div class='inline'>
575
+ <p>Updates an HTTPS Edge by ID.</p>
576
+ </div></span>
577
+
578
+ </li>
579
+
580
+
581
+ </ul>
582
+
583
+
584
+ <div id="constructor_details" class="method_details_list">
585
+ <h2>Constructor Details</h2>
586
+
587
+ <div class="method_details first">
588
+ <h3 class="signature first" id="initialize-instance_method">
589
+
590
+ #<strong>initialize</strong>(client: nil, attrs: {}) &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Models::HTTPSEdge (class)">HTTPSEdge</a></span></tt>
591
+
592
+
593
+
594
+
595
+
596
+ </h3><div class="docstring">
597
+ <div class="discussion">
598
+
599
+ <p>Returns a new instance of HTTPSEdge.</p>
600
+
601
+
602
+ </div>
603
+ </div>
604
+ <div class="tags">
605
+
606
+
607
+ </div><table class="source_code">
608
+ <tr>
609
+ <td>
610
+ <pre class="lines">
611
+
612
+
613
+ 18
614
+ 19
615
+ 20
616
+ 21
617
+ 22
618
+ 23
619
+ 24
620
+ 25
621
+ 26
622
+ 27
623
+ 28
624
+ 29
625
+ 30</pre>
626
+ </td>
627
+ <td>
628
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/https_edge.rb', line 18</span>
629
+
630
+ <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
631
+ <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
632
+ <span class='ivar'>@attrs</span> <span class='op'>=</span> <span class='id identifier rubyid_attrs'>attrs</span>
633
+ <span class='ivar'>@id</span> <span class='op'>=</span> <span class='ivar'>@attrs</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>id</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
634
+ <span class='ivar'>@description</span> <span class='op'>=</span> <span class='ivar'>@attrs</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>description</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
635
+ <span class='ivar'>@metadata</span> <span class='op'>=</span> <span class='ivar'>@attrs</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>metadata</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
636
+ <span class='ivar'>@created_at</span> <span class='op'>=</span> <span class='ivar'>@attrs</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>created_at</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
637
+ <span class='ivar'>@uri</span> <span class='op'>=</span> <span class='ivar'>@attrs</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>uri</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
638
+ <span class='ivar'>@hostports</span> <span class='op'>=</span> <span class='ivar'>@attrs</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>hostports</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
639
+ <span class='ivar'>@mutual_tls</span> <span class='op'>=</span> <span class='ivar'>@attrs</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>mutual_tls</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
640
+ <span class='ivar'>@tls_termination</span> <span class='op'>=</span> <span class='ivar'>@attrs</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>tls_termination</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
641
+ <span class='ivar'>@routes</span> <span class='op'>=</span> <span class='ivar'>@attrs</span><span class='lbracket'>[</span><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>routes</span><span class='tstring_end'>&#39;</span></span><span class='rbracket'>]</span>
642
+ <span class='kw'>end</span></pre>
643
+ </td>
644
+ </tr>
645
+ </table>
646
+ </div>
647
+
648
+ </div>
649
+
650
+ <div id="instance_attr_details" class="attr_details">
651
+ <h2>Instance Attribute Details</h2>
652
+
653
+
654
+ <span id=""></span>
655
+ <div class="method_details first">
656
+ <h3 class="signature first" id="attrs-instance_method">
657
+
658
+ #<strong>attrs</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
659
+
660
+
661
+
662
+
663
+
664
+ </h3><div class="docstring">
665
+ <div class="discussion">
666
+
667
+ <p>Returns the value of attribute attrs.</p>
668
+
669
+
670
+ </div>
671
+ </div>
672
+ <div class="tags">
673
+
674
+
675
+ </div><table class="source_code">
676
+ <tr>
677
+ <td>
678
+ <pre class="lines">
679
+
680
+
681
+ 6
682
+ 7
683
+ 8</pre>
684
+ </td>
685
+ <td>
686
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/https_edge.rb', line 6</span>
687
+
688
+ <span class='kw'>def</span> <span class='id identifier rubyid_attrs'>attrs</span>
689
+ <span class='ivar'>@attrs</span>
690
+ <span class='kw'>end</span></pre>
691
+ </td>
692
+ </tr>
693
+ </table>
694
+ </div>
695
+
696
+
697
+ <span id=""></span>
698
+ <div class="method_details ">
699
+ <h3 class="signature " id="client-instance_method">
700
+
701
+ #<strong>client</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
702
+
703
+
704
+
705
+
706
+
707
+ </h3><div class="docstring">
708
+ <div class="discussion">
709
+
710
+ <p>Returns the value of attribute client.</p>
711
+
712
+
713
+ </div>
714
+ </div>
715
+ <div class="tags">
716
+
717
+
718
+ </div><table class="source_code">
719
+ <tr>
720
+ <td>
721
+ <pre class="lines">
722
+
723
+
724
+ 6
725
+ 7
726
+ 8</pre>
727
+ </td>
728
+ <td>
729
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/https_edge.rb', line 6</span>
730
+
731
+ <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
732
+ <span class='ivar'>@client</span>
733
+ <span class='kw'>end</span></pre>
734
+ </td>
735
+ </tr>
736
+ </table>
737
+ </div>
738
+
739
+
740
+ <span id=""></span>
741
+ <div class="method_details ">
742
+ <h3 class="signature " id="created_at-instance_method">
743
+
744
+ #<strong>created_at</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
745
+
746
+
747
+
748
+
749
+
750
+ </h3><div class="docstring">
751
+ <div class="discussion">
752
+
753
+ <p>Returns the value of attribute created_at.</p>
754
+
755
+
756
+ </div>
757
+ </div>
758
+ <div class="tags">
759
+
760
+
761
+ </div><table class="source_code">
762
+ <tr>
763
+ <td>
764
+ <pre class="lines">
765
+
766
+
767
+ 6
768
+ 7
769
+ 8</pre>
770
+ </td>
771
+ <td>
772
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/https_edge.rb', line 6</span>
773
+
774
+ <span class='kw'>def</span> <span class='id identifier rubyid_created_at'>created_at</span>
775
+ <span class='ivar'>@created_at</span>
776
+ <span class='kw'>end</span></pre>
777
+ </td>
778
+ </tr>
779
+ </table>
780
+ </div>
781
+
782
+
783
+ <span id=""></span>
784
+ <div class="method_details ">
785
+ <h3 class="signature " id="description-instance_method">
786
+
787
+ #<strong>description</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
788
+
789
+
790
+
791
+
792
+
793
+ </h3><div class="docstring">
794
+ <div class="discussion">
795
+
796
+ <p>Returns the value of attribute description.</p>
797
+
798
+
799
+ </div>
800
+ </div>
801
+ <div class="tags">
802
+
803
+
804
+ </div><table class="source_code">
805
+ <tr>
806
+ <td>
807
+ <pre class="lines">
808
+
809
+
810
+ 6
811
+ 7
812
+ 8</pre>
813
+ </td>
814
+ <td>
815
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/https_edge.rb', line 6</span>
816
+
817
+ <span class='kw'>def</span> <span class='id identifier rubyid_description'>description</span>
818
+ <span class='ivar'>@description</span>
819
+ <span class='kw'>end</span></pre>
820
+ </td>
821
+ </tr>
822
+ </table>
823
+ </div>
824
+
825
+
826
+ <span id=""></span>
827
+ <div class="method_details ">
828
+ <h3 class="signature " id="hostports-instance_method">
829
+
830
+ #<strong>hostports</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
831
+
832
+
833
+
834
+
835
+
836
+ </h3><div class="docstring">
837
+ <div class="discussion">
838
+
839
+ <p>Returns the value of attribute hostports.</p>
840
+
841
+
842
+ </div>
843
+ </div>
844
+ <div class="tags">
845
+
846
+
847
+ </div><table class="source_code">
848
+ <tr>
849
+ <td>
850
+ <pre class="lines">
851
+
852
+
853
+ 6
854
+ 7
855
+ 8</pre>
856
+ </td>
857
+ <td>
858
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/https_edge.rb', line 6</span>
859
+
860
+ <span class='kw'>def</span> <span class='id identifier rubyid_hostports'>hostports</span>
861
+ <span class='ivar'>@hostports</span>
862
+ <span class='kw'>end</span></pre>
863
+ </td>
864
+ </tr>
865
+ </table>
866
+ </div>
867
+
868
+
869
+ <span id=""></span>
870
+ <div class="method_details ">
871
+ <h3 class="signature " id="id-instance_method">
872
+
873
+ #<strong>id</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
874
+
875
+
876
+
877
+
878
+
879
+ </h3><div class="docstring">
880
+ <div class="discussion">
881
+
882
+ <p>Returns the value of attribute id.</p>
883
+
884
+
885
+ </div>
886
+ </div>
887
+ <div class="tags">
888
+
889
+
890
+ </div><table class="source_code">
891
+ <tr>
892
+ <td>
893
+ <pre class="lines">
894
+
895
+
896
+ 6
897
+ 7
898
+ 8</pre>
899
+ </td>
900
+ <td>
901
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/https_edge.rb', line 6</span>
902
+
903
+ <span class='kw'>def</span> <span class='id identifier rubyid_id'>id</span>
904
+ <span class='ivar'>@id</span>
905
+ <span class='kw'>end</span></pre>
906
+ </td>
907
+ </tr>
908
+ </table>
909
+ </div>
910
+
911
+
912
+ <span id=""></span>
913
+ <div class="method_details ">
914
+ <h3 class="signature " id="metadata-instance_method">
915
+
916
+ #<strong>metadata</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
917
+
918
+
919
+
920
+
921
+
922
+ </h3><div class="docstring">
923
+ <div class="discussion">
924
+
925
+ <p>Returns the value of attribute metadata.</p>
926
+
927
+
928
+ </div>
929
+ </div>
930
+ <div class="tags">
931
+
932
+
933
+ </div><table class="source_code">
934
+ <tr>
935
+ <td>
936
+ <pre class="lines">
937
+
938
+
939
+ 6
940
+ 7
941
+ 8</pre>
942
+ </td>
943
+ <td>
944
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/https_edge.rb', line 6</span>
945
+
946
+ <span class='kw'>def</span> <span class='id identifier rubyid_metadata'>metadata</span>
947
+ <span class='ivar'>@metadata</span>
948
+ <span class='kw'>end</span></pre>
949
+ </td>
950
+ </tr>
951
+ </table>
952
+ </div>
953
+
954
+
955
+ <span id=""></span>
956
+ <div class="method_details ">
957
+ <h3 class="signature " id="mutual_tls-instance_method">
958
+
959
+ #<strong>mutual_tls</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
960
+
961
+
962
+
963
+
964
+
965
+ </h3><div class="docstring">
966
+ <div class="discussion">
967
+
968
+ <p>Returns the value of attribute mutual_tls.</p>
969
+
970
+
971
+ </div>
972
+ </div>
973
+ <div class="tags">
974
+
975
+
976
+ </div><table class="source_code">
977
+ <tr>
978
+ <td>
979
+ <pre class="lines">
980
+
981
+
982
+ 6
983
+ 7
984
+ 8</pre>
985
+ </td>
986
+ <td>
987
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/https_edge.rb', line 6</span>
988
+
989
+ <span class='kw'>def</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span>
990
+ <span class='ivar'>@mutual_tls</span>
991
+ <span class='kw'>end</span></pre>
992
+ </td>
993
+ </tr>
994
+ </table>
995
+ </div>
996
+
997
+
998
+ <span id=""></span>
999
+ <div class="method_details ">
1000
+ <h3 class="signature " id="routes-instance_method">
1001
+
1002
+ #<strong>routes</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1003
+
1004
+
1005
+
1006
+
1007
+
1008
+ </h3><div class="docstring">
1009
+ <div class="discussion">
1010
+
1011
+ <p>Returns the value of attribute routes.</p>
1012
+
1013
+
1014
+ </div>
1015
+ </div>
1016
+ <div class="tags">
1017
+
1018
+
1019
+ </div><table class="source_code">
1020
+ <tr>
1021
+ <td>
1022
+ <pre class="lines">
1023
+
1024
+
1025
+ 6
1026
+ 7
1027
+ 8</pre>
1028
+ </td>
1029
+ <td>
1030
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/https_edge.rb', line 6</span>
1031
+
1032
+ <span class='kw'>def</span> <span class='id identifier rubyid_routes'>routes</span>
1033
+ <span class='ivar'>@routes</span>
1034
+ <span class='kw'>end</span></pre>
1035
+ </td>
1036
+ </tr>
1037
+ </table>
1038
+ </div>
1039
+
1040
+
1041
+ <span id=""></span>
1042
+ <div class="method_details ">
1043
+ <h3 class="signature " id="tls_termination-instance_method">
1044
+
1045
+ #<strong>tls_termination</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1046
+
1047
+
1048
+
1049
+
1050
+
1051
+ </h3><div class="docstring">
1052
+ <div class="discussion">
1053
+
1054
+ <p>Returns the value of attribute tls_termination.</p>
1055
+
1056
+
1057
+ </div>
1058
+ </div>
1059
+ <div class="tags">
1060
+
1061
+
1062
+ </div><table class="source_code">
1063
+ <tr>
1064
+ <td>
1065
+ <pre class="lines">
1066
+
1067
+
1068
+ 6
1069
+ 7
1070
+ 8</pre>
1071
+ </td>
1072
+ <td>
1073
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/https_edge.rb', line 6</span>
1074
+
1075
+ <span class='kw'>def</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span>
1076
+ <span class='ivar'>@tls_termination</span>
1077
+ <span class='kw'>end</span></pre>
1078
+ </td>
1079
+ </tr>
1080
+ </table>
1081
+ </div>
1082
+
1083
+
1084
+ <span id=""></span>
1085
+ <div class="method_details ">
1086
+ <h3 class="signature " id="uri-instance_method">
1087
+
1088
+ #<strong>uri</strong> &#x21d2; <tt>Object</tt> <span class="extras">(readonly)</span>
1089
+
1090
+
1091
+
1092
+
1093
+
1094
+ </h3><div class="docstring">
1095
+ <div class="discussion">
1096
+
1097
+ <p>Returns the value of attribute uri.</p>
1098
+
1099
+
1100
+ </div>
1101
+ </div>
1102
+ <div class="tags">
1103
+
1104
+
1105
+ </div><table class="source_code">
1106
+ <tr>
1107
+ <td>
1108
+ <pre class="lines">
1109
+
1110
+
1111
+ 6
1112
+ 7
1113
+ 8</pre>
1114
+ </td>
1115
+ <td>
1116
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/https_edge.rb', line 6</span>
1117
+
1118
+ <span class='kw'>def</span> <span class='id identifier rubyid_uri'>uri</span>
1119
+ <span class='ivar'>@uri</span>
1120
+ <span class='kw'>end</span></pre>
1121
+ </td>
1122
+ </tr>
1123
+ </table>
1124
+ </div>
1125
+
1126
+ </div>
1127
+
1128
+
1129
+ <div id="instance_method_details" class="method_details_list">
1130
+ <h2>Instance Method Details</h2>
1131
+
1132
+
1133
+ <div class="method_details first">
1134
+ <h3 class="signature first" id="==-instance_method">
1135
+
1136
+ #<strong>==</strong>(other) &#x21d2; <tt>Object</tt>
1137
+
1138
+
1139
+
1140
+
1141
+
1142
+ </h3><table class="source_code">
1143
+ <tr>
1144
+ <td>
1145
+ <pre class="lines">
1146
+
1147
+
1148
+ 32
1149
+ 33
1150
+ 34</pre>
1151
+ </td>
1152
+ <td>
1153
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/https_edge.rb', line 32</span>
1154
+
1155
+ <span class='kw'>def</span> <span class='op'>==</span><span class='lparen'>(</span><span class='id identifier rubyid_other'>other</span><span class='rparen'>)</span>
1156
+ <span class='ivar'>@attrs</span> <span class='op'>==</span> <span class='id identifier rubyid_other'>other</span><span class='period'>.</span><span class='id identifier rubyid_attrs'>attrs</span>
1157
+ <span class='kw'>end</span></pre>
1158
+ </td>
1159
+ </tr>
1160
+ </table>
1161
+ </div>
1162
+
1163
+ <div class="method_details ">
1164
+ <h3 class="signature " id="delete-instance_method">
1165
+
1166
+ #<strong>delete</strong> &#x21d2; <tt>Object</tt>
1167
+
1168
+
1169
+
1170
+
1171
+
1172
+ </h3><div class="docstring">
1173
+ <div class="discussion">
1174
+
1175
+ <p>Delete an HTTPS Edge by ID</p>
1176
+
1177
+ <p><a href="https://ngrok.com/docs/api#api-edges-https-delete">ngrok.com/docs/api#api-edges-https-delete</a></p>
1178
+
1179
+
1180
+ </div>
1181
+ </div>
1182
+ <div class="tags">
1183
+
1184
+
1185
+ </div><table class="source_code">
1186
+ <tr>
1187
+ <td>
1188
+ <pre class="lines">
1189
+
1190
+
1191
+ 77
1192
+ 78
1193
+ 79
1194
+ 80
1195
+ 81</pre>
1196
+ </td>
1197
+ <td>
1198
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/https_edge.rb', line 77</span>
1199
+
1200
+ <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span>
1201
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span>
1202
+ <span class='label'>id:</span> <span class='ivar'>@id</span>
1203
+ <span class='rparen'>)</span>
1204
+ <span class='kw'>end</span></pre>
1205
+ </td>
1206
+ </tr>
1207
+ </table>
1208
+ </div>
1209
+
1210
+ <div class="method_details ">
1211
+ <h3 class="signature " id="to_h-instance_method">
1212
+
1213
+ #<strong>to_h</strong> &#x21d2; <tt>Object</tt>
1214
+
1215
+
1216
+
1217
+
1218
+
1219
+ </h3><table class="source_code">
1220
+ <tr>
1221
+ <td>
1222
+ <pre class="lines">
1223
+
1224
+
1225
+ 40
1226
+ 41
1227
+ 42</pre>
1228
+ </td>
1229
+ <td>
1230
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/https_edge.rb', line 40</span>
1231
+
1232
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_h'>to_h</span>
1233
+ <span class='ivar'>@attrs</span><span class='period'>.</span><span class='id identifier rubyid_to_h'>to_h</span>
1234
+ <span class='kw'>end</span></pre>
1235
+ </td>
1236
+ </tr>
1237
+ </table>
1238
+ </div>
1239
+
1240
+ <div class="method_details ">
1241
+ <h3 class="signature " id="to_s-instance_method">
1242
+
1243
+ #<strong>to_s</strong> &#x21d2; <tt>Object</tt>
1244
+
1245
+
1246
+
1247
+
1248
+
1249
+ </h3><table class="source_code">
1250
+ <tr>
1251
+ <td>
1252
+ <pre class="lines">
1253
+
1254
+
1255
+ 36
1256
+ 37
1257
+ 38</pre>
1258
+ </td>
1259
+ <td>
1260
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/https_edge.rb', line 36</span>
1261
+
1262
+ <span class='kw'>def</span> <span class='id identifier rubyid_to_s'>to_s</span>
1263
+ <span class='ivar'>@attrs</span><span class='period'>.</span><span class='id identifier rubyid_to_s'>to_s</span>
1264
+ <span class='kw'>end</span></pre>
1265
+ </td>
1266
+ </tr>
1267
+ </table>
1268
+ </div>
1269
+
1270
+ <div class="method_details ">
1271
+ <h3 class="signature " id="update-instance_method">
1272
+
1273
+ #<strong>update</strong>(description: nil, metadata: nil, hostports: nil, mutual_tls: nil, tls_termination: nil) &#x21d2; <tt>Object</tt>
1274
+
1275
+
1276
+
1277
+
1278
+
1279
+ </h3><div class="docstring">
1280
+ <div class="discussion">
1281
+
1282
+ <p>Updates an HTTPS 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>
1283
+
1284
+ <p><a href="https://ngrok.com/docs/api#api-edges-https-update">ngrok.com/docs/api#api-edges-https-update</a></p>
1285
+
1286
+
1287
+ </div>
1288
+ </div>
1289
+ <div class="tags">
1290
+
1291
+
1292
+ </div><table class="source_code">
1293
+ <tr>
1294
+ <td>
1295
+ <pre class="lines">
1296
+
1297
+
1298
+ 51
1299
+ 52
1300
+ 53
1301
+ 54
1302
+ 55
1303
+ 56
1304
+ 57
1305
+ 58
1306
+ 59
1307
+ 60
1308
+ 61
1309
+ 62
1310
+ 63
1311
+ 64
1312
+ 65
1313
+ 66
1314
+ 67
1315
+ 68
1316
+ 69
1317
+ 70
1318
+ 71</pre>
1319
+ </td>
1320
+ <td>
1321
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/models/https_edge.rb', line 51</span>
1322
+
1323
+ <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
1324
+ <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1325
+ <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1326
+ <span class='label'>hostports:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1327
+ <span class='label'>mutual_tls:</span> <span class='kw'>nil</span><span class='comma'>,</span>
1328
+ <span class='label'>tls_termination:</span> <span class='kw'>nil</span>
1329
+ <span class='rparen'>)</span>
1330
+ <span class='ivar'>@description</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>
1331
+ <span class='ivar'>@metadata</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>
1332
+ <span class='ivar'>@hostports</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>
1333
+ <span class='ivar'>@mutual_tls</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>
1334
+ <span class='ivar'>@tls_termination</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>
1335
+ <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span>
1336
+ <span class='label'>id:</span> <span class='ivar'>@id</span><span class='comma'>,</span>
1337
+ <span class='label'>description:</span> <span class='id identifier rubyid_description'>description</span><span class='comma'>,</span>
1338
+ <span class='label'>metadata:</span> <span class='id identifier rubyid_metadata'>metadata</span><span class='comma'>,</span>
1339
+ <span class='label'>hostports:</span> <span class='id identifier rubyid_hostports'>hostports</span><span class='comma'>,</span>
1340
+ <span class='label'>mutual_tls:</span> <span class='id identifier rubyid_mutual_tls'>mutual_tls</span><span class='comma'>,</span>
1341
+ <span class='label'>tls_termination:</span> <span class='id identifier rubyid_tls_termination'>tls_termination</span>
1342
+ <span class='rparen'>)</span>
1343
+ <span class='kw'>end</span></pre>
1344
+ </td>
1345
+ </tr>
1346
+ </table>
1347
+ </div>
1348
+
1349
+ </div>
1350
+
1351
+ </div>
1352
+
1353
+ <div id="footer">
1354
+ Generated on Mon Apr 11 19:32:56 2022 by
1355
+ <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1356
+ 0.9.27 (ruby-2.7.5).
1357
+ </div>
1358
+
1359
+ </div>
1360
+ </body>
1361
+ </html>