ngrok-api 0.15.0 → 0.18.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (395) hide show
  1. checksums.yaml +4 -4
  2. data/.rubocop.yml +1 -1
  3. data/doc/NgrokAPI/Client.html +325 -267
  4. data/doc/NgrokAPI/Error.html +3 -3
  5. data/doc/NgrokAPI/Errors/NotFoundError.html +3 -3
  6. data/doc/NgrokAPI/Errors.html +3 -3
  7. data/doc/NgrokAPI/HttpClient.html +30 -36
  8. data/doc/NgrokAPI/Models/APIKey.html +3 -3
  9. data/doc/NgrokAPI/Models/AWSAuth.html +3 -3
  10. data/doc/NgrokAPI/Models/AWSCredentials.html +3 -3
  11. data/doc/NgrokAPI/Models/AWSRole.html +3 -3
  12. data/doc/NgrokAPI/Models/AbuseReport.html +3 -3
  13. data/doc/NgrokAPI/Models/AbuseReportHostname.html +3 -3
  14. data/doc/NgrokAPI/Models/AgentIngress.html +1217 -0
  15. data/doc/NgrokAPI/Models/CertificateAuthority.html +3 -3
  16. data/doc/NgrokAPI/Models/Credential.html +3 -3
  17. data/doc/NgrokAPI/Models/Endpoint.html +1431 -0
  18. data/doc/NgrokAPI/Models/{EndpointLogging.html → EndpointBackend.html} +42 -42
  19. data/{docs/NgrokAPI/Models/EndpointLoggingMutate.html → doc/NgrokAPI/Models/EndpointBackendMutate.html} +42 -42
  20. data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +3 -3
  21. data/doc/NgrokAPI/Models/EndpointCompression.html +3 -3
  22. data/doc/NgrokAPI/Models/EndpointIPPolicy.html +3 -3
  23. data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +3 -3
  24. data/doc/NgrokAPI/Models/EndpointMutualTLS.html +3 -3
  25. data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +3 -3
  26. data/doc/NgrokAPI/Models/EndpointOAuth.html +3 -3
  27. data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +3 -3
  28. data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +3 -3
  29. data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +3 -3
  30. data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +3 -3
  31. data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +3 -3
  32. data/doc/NgrokAPI/Models/EndpointOIDC.html +3 -3
  33. data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +3 -3
  34. data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +3 -3
  35. data/doc/NgrokAPI/Models/EndpointSAML.html +3 -3
  36. data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +3 -3
  37. data/doc/NgrokAPI/Models/EndpointTLSTermination.html +3 -3
  38. data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +617 -0
  39. data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +3 -3
  40. data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +543 -0
  41. data/doc/NgrokAPI/Models/EventDestination.html +7 -7
  42. data/doc/NgrokAPI/Models/EventSource.html +3 -3
  43. data/doc/NgrokAPI/Models/EventSourceList.html +3 -3
  44. data/doc/NgrokAPI/Models/EventSourceReplace.html +3 -3
  45. data/doc/NgrokAPI/Models/EventSubscription.html +3 -3
  46. data/doc/NgrokAPI/Models/EventTarget.html +3 -3
  47. data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +3 -3
  48. data/doc/NgrokAPI/Models/EventTargetFirehose.html +3 -3
  49. data/doc/NgrokAPI/Models/EventTargetKinesis.html +3 -3
  50. data/doc/NgrokAPI/Models/FailoverBackend.html +1075 -0
  51. data/doc/NgrokAPI/Models/HTTPResponseBackend.html +1231 -0
  52. data/{docs/NgrokAPI/Models/EventStream.html → doc/NgrokAPI/Models/HTTPSEdge.html} +119 -119
  53. data/doc/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +203 -265
  54. data/doc/NgrokAPI/Models/IPPolicy.html +3 -3
  55. data/doc/NgrokAPI/Models/IPPolicyRule.html +97 -23
  56. data/doc/NgrokAPI/Models/IPRestriction.html +3 -3
  57. data/doc/NgrokAPI/Models/Listable.html +3 -3
  58. data/doc/NgrokAPI/Models/Ref.html +3 -3
  59. data/doc/NgrokAPI/Models/ReservedAddr.html +3 -3
  60. data/doc/NgrokAPI/Models/ReservedDomain.html +3 -3
  61. data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +3 -3
  62. data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +3 -3
  63. data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +3 -3
  64. data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +3 -3
  65. data/doc/NgrokAPI/Models/SSHCredential.html +3 -3
  66. data/doc/NgrokAPI/Models/SSHHostCertificate.html +3 -3
  67. data/doc/NgrokAPI/Models/SSHUserCertificate.html +3 -3
  68. data/doc/NgrokAPI/Models/TCPEdge.html +1235 -0
  69. data/doc/NgrokAPI/Models/TLSCertificate.html +3 -3
  70. data/doc/NgrokAPI/Models/TLSCertificateSANs.html +3 -3
  71. data/doc/NgrokAPI/Models/TLSEdge.html +1395 -0
  72. data/doc/NgrokAPI/Models/Tunnel.html +314 -18
  73. data/doc/NgrokAPI/Models/TunnelGroupBackend.html +1149 -0
  74. data/doc/NgrokAPI/Models/TunnelSession.html +3 -3
  75. data/doc/NgrokAPI/Models/{IPWhitelistEntry.html → WeightedBackend.html} +80 -74
  76. data/doc/NgrokAPI/Models.html +5 -5
  77. data/doc/NgrokAPI/PagedIterator.html +3 -3
  78. data/doc/NgrokAPI/Services/APIKeysClient.html +99 -149
  79. data/doc/NgrokAPI/Services/AbuseReportsClient.html +19 -33
  80. data/doc/NgrokAPI/Services/{IPWhitelistClient.html → AgentIngressesClient.html} +209 -265
  81. data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +104 -156
  82. data/doc/NgrokAPI/Services/CredentialsClient.html +108 -164
  83. data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1153 -0
  84. data/{docs/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html → doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html} +177 -95
  85. data/doc/NgrokAPI/Services/{EndpointCompressionModuleClient.html → EdgeRouteCompressionModuleClient.html} +177 -95
  86. data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +1153 -0
  87. data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +1153 -0
  88. data/{docs/NgrokAPI/Services/EndpointOIDCModuleClient.html → doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html} +177 -95
  89. data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1153 -0
  90. data/{docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html → doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html} +177 -95
  91. data/{docs/NgrokAPI/Services/EndpointSAMLModuleClient.html → doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html} +177 -95
  92. data/doc/NgrokAPI/Services/{EndpointWebhookValidationModuleClient.html → EdgeRouteWebhookVerificationModuleClient.html} +177 -95
  93. data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1153 -0
  94. data/doc/NgrokAPI/Services/{EventStreamsClient.html → EdgesHTTPSClient.html} +248 -353
  95. data/{docs/NgrokAPI/Services/EndpointConfigurationsClient.html → doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html} +461 -761
  96. data/doc/NgrokAPI/Services/EdgesTCPClient.html +1757 -0
  97. data/doc/NgrokAPI/Services/EdgesTLSClient.html +1847 -0
  98. data/doc/NgrokAPI/Services/EndpointsClient.html +907 -0
  99. data/doc/NgrokAPI/Services/EventDestinationsClient.html +119 -187
  100. data/doc/NgrokAPI/Services/EventSourcesClient.html +95 -157
  101. data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +116 -178
  102. data/doc/NgrokAPI/Services/FailoverBackendsClient.html +1644 -0
  103. data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +1744 -0
  104. data/doc/NgrokAPI/Services/{EndpointSAMLModuleClient.html → HTTPSEdgeMutualTLSModuleClient.html} +101 -129
  105. data/doc/NgrokAPI/Services/{EndpointRequestHeadersModuleClient.html → HTTPSEdgeTLSTerminationModuleClient.html} +101 -129
  106. data/doc/NgrokAPI/Services/IPPoliciesClient.html +114 -184
  107. data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +126 -164
  108. data/doc/NgrokAPI/Services/IPRestrictionsClient.html +117 -181
  109. data/doc/NgrokAPI/Services/ReservedAddrsClient.html +117 -473
  110. data/doc/NgrokAPI/Services/ReservedDomainsClient.html +209 -899
  111. data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +110 -166
  112. data/doc/NgrokAPI/Services/SSHCredentialsClient.html +111 -169
  113. data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +111 -171
  114. data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +111 -175
  115. data/{docs/NgrokAPI/Services/EndpointLoggingModuleClient.html → doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html} +101 -129
  116. data/{docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html → doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html} +83 -111
  117. data/doc/NgrokAPI/Services/TLSCertificatesClient.html +107 -161
  118. data/doc/NgrokAPI/Services/{EndpointLoggingModuleClient.html → TLSEdgeBackendModuleClient.html} +101 -129
  119. data/doc/NgrokAPI/Services/{EndpointIPPolicyModuleClient.html → TLSEdgeIPRestrictionModuleClient.html} +83 -111
  120. data/{docs/NgrokAPI/Services/EndpointMutualTLSModuleClient.html → doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html} +83 -111
  121. data/{docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html → doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html} +83 -111
  122. data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +1644 -0
  123. data/doc/NgrokAPI/Services/TunnelSessionsClient.html +87 -135
  124. data/doc/NgrokAPI/Services/TunnelsClient.html +252 -26
  125. data/doc/NgrokAPI/Services/WeightedBackendsClient.html +1644 -0
  126. data/doc/NgrokAPI/Services.html +5 -5
  127. data/doc/NgrokAPI.html +4 -4
  128. data/doc/_index.html +253 -76
  129. data/doc/class_list.html +1 -1
  130. data/doc/file.README.html +3 -3
  131. data/doc/frames.html +1 -1
  132. data/doc/index.html +3 -3
  133. data/doc/method_list.html +3559 -1583
  134. data/doc/top-level-namespace.html +3 -3
  135. data/docs/NgrokAPI/Client.html +325 -267
  136. data/docs/NgrokAPI/Error.html +3 -3
  137. data/docs/NgrokAPI/Errors/NotFoundError.html +3 -3
  138. data/docs/NgrokAPI/Errors.html +3 -3
  139. data/docs/NgrokAPI/HttpClient.html +30 -36
  140. data/docs/NgrokAPI/Models/APIKey.html +3 -3
  141. data/docs/NgrokAPI/Models/AWSAuth.html +3 -3
  142. data/docs/NgrokAPI/Models/AWSCredentials.html +3 -3
  143. data/docs/NgrokAPI/Models/AWSRole.html +3 -3
  144. data/docs/NgrokAPI/Models/AbuseReport.html +3 -3
  145. data/docs/NgrokAPI/Models/AbuseReportHostname.html +3 -3
  146. data/docs/NgrokAPI/Models/AgentIngress.html +1217 -0
  147. data/docs/NgrokAPI/Models/CertificateAuthority.html +3 -3
  148. data/docs/NgrokAPI/Models/Credential.html +3 -3
  149. data/docs/NgrokAPI/Models/Endpoint.html +1431 -0
  150. data/docs/NgrokAPI/Models/{EndpointLogging.html → EndpointBackend.html} +42 -42
  151. data/{doc/NgrokAPI/Models/EndpointLoggingMutate.html → docs/NgrokAPI/Models/EndpointBackendMutate.html} +42 -42
  152. data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +3 -3
  153. data/docs/NgrokAPI/Models/EndpointCompression.html +3 -3
  154. data/docs/NgrokAPI/Models/EndpointIPPolicy.html +3 -3
  155. data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +3 -3
  156. data/docs/NgrokAPI/Models/EndpointMutualTLS.html +3 -3
  157. data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +3 -3
  158. data/docs/NgrokAPI/Models/EndpointOAuth.html +3 -3
  159. data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +3 -3
  160. data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +3 -3
  161. data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +3 -3
  162. data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +3 -3
  163. data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +3 -3
  164. data/docs/NgrokAPI/Models/EndpointOIDC.html +3 -3
  165. data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +3 -3
  166. data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +3 -3
  167. data/docs/NgrokAPI/Models/EndpointSAML.html +3 -3
  168. data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +3 -3
  169. data/docs/NgrokAPI/Models/EndpointTLSTermination.html +3 -3
  170. data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +617 -0
  171. data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +3 -3
  172. data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +543 -0
  173. data/docs/NgrokAPI/Models/EventDestination.html +7 -7
  174. data/docs/NgrokAPI/Models/EventSource.html +3 -3
  175. data/docs/NgrokAPI/Models/EventSourceList.html +3 -3
  176. data/docs/NgrokAPI/Models/EventSourceReplace.html +3 -3
  177. data/docs/NgrokAPI/Models/EventSubscription.html +3 -3
  178. data/docs/NgrokAPI/Models/EventTarget.html +3 -3
  179. data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +3 -3
  180. data/docs/NgrokAPI/Models/EventTargetFirehose.html +3 -3
  181. data/docs/NgrokAPI/Models/EventTargetKinesis.html +3 -3
  182. data/docs/NgrokAPI/Models/FailoverBackend.html +1075 -0
  183. data/docs/NgrokAPI/Models/HTTPResponseBackend.html +1231 -0
  184. data/{doc/NgrokAPI/Models/EventStream.html → docs/NgrokAPI/Models/HTTPSEdge.html} +119 -119
  185. data/docs/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +203 -265
  186. data/docs/NgrokAPI/Models/IPPolicy.html +3 -3
  187. data/docs/NgrokAPI/Models/IPPolicyRule.html +97 -23
  188. data/docs/NgrokAPI/Models/IPRestriction.html +3 -3
  189. data/docs/NgrokAPI/Models/Listable.html +3 -3
  190. data/docs/NgrokAPI/Models/Ref.html +3 -3
  191. data/docs/NgrokAPI/Models/ReservedAddr.html +3 -3
  192. data/docs/NgrokAPI/Models/ReservedDomain.html +3 -3
  193. data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +3 -3
  194. data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +3 -3
  195. data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +3 -3
  196. data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +3 -3
  197. data/docs/NgrokAPI/Models/SSHCredential.html +3 -3
  198. data/docs/NgrokAPI/Models/SSHHostCertificate.html +3 -3
  199. data/docs/NgrokAPI/Models/SSHUserCertificate.html +3 -3
  200. data/docs/NgrokAPI/Models/TCPEdge.html +1235 -0
  201. data/docs/NgrokAPI/Models/TLSCertificate.html +3 -3
  202. data/docs/NgrokAPI/Models/TLSCertificateSANs.html +3 -3
  203. data/docs/NgrokAPI/Models/TLSEdge.html +1395 -0
  204. data/docs/NgrokAPI/Models/Tunnel.html +314 -18
  205. data/docs/NgrokAPI/Models/TunnelGroupBackend.html +1149 -0
  206. data/docs/NgrokAPI/Models/TunnelSession.html +3 -3
  207. data/docs/NgrokAPI/Models/{IPWhitelistEntry.html → WeightedBackend.html} +80 -74
  208. data/docs/NgrokAPI/Models.html +5 -5
  209. data/docs/NgrokAPI/PagedIterator.html +3 -3
  210. data/docs/NgrokAPI/Services/APIKeysClient.html +99 -149
  211. data/docs/NgrokAPI/Services/AbuseReportsClient.html +19 -33
  212. data/docs/NgrokAPI/Services/{IPWhitelistClient.html → AgentIngressesClient.html} +209 -265
  213. data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +104 -156
  214. data/docs/NgrokAPI/Services/CredentialsClient.html +108 -164
  215. data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1153 -0
  216. data/{doc/NgrokAPI/Services/EndpointCircuitBreakerModuleClient.html → docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html} +177 -95
  217. data/docs/NgrokAPI/Services/{EndpointCompressionModuleClient.html → EdgeRouteCompressionModuleClient.html} +177 -95
  218. data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +1153 -0
  219. data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +1153 -0
  220. data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +1153 -0
  221. data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1153 -0
  222. data/{doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html → docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html} +177 -95
  223. data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +1153 -0
  224. data/docs/NgrokAPI/Services/{EndpointWebhookValidationModuleClient.html → EdgeRouteWebhookVerificationModuleClient.html} +177 -95
  225. data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1153 -0
  226. data/docs/NgrokAPI/Services/{EventStreamsClient.html → EdgesHTTPSClient.html} +248 -353
  227. data/{doc/NgrokAPI/Services/EndpointConfigurationsClient.html → docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html} +461 -761
  228. data/docs/NgrokAPI/Services/EdgesTCPClient.html +1757 -0
  229. data/docs/NgrokAPI/Services/EdgesTLSClient.html +1847 -0
  230. data/docs/NgrokAPI/Services/EndpointsClient.html +907 -0
  231. data/docs/NgrokAPI/Services/EventDestinationsClient.html +119 -187
  232. data/docs/NgrokAPI/Services/EventSourcesClient.html +95 -157
  233. data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +116 -178
  234. data/docs/NgrokAPI/Services/FailoverBackendsClient.html +1644 -0
  235. data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +1744 -0
  236. data/{doc/NgrokAPI/Services/EndpointOIDCModuleClient.html → docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html} +101 -129
  237. data/docs/NgrokAPI/Services/{EndpointRequestHeadersModuleClient.html → HTTPSEdgeTLSTerminationModuleClient.html} +101 -129
  238. data/docs/NgrokAPI/Services/IPPoliciesClient.html +114 -184
  239. data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +126 -164
  240. data/docs/NgrokAPI/Services/IPRestrictionsClient.html +117 -181
  241. data/docs/NgrokAPI/Services/ReservedAddrsClient.html +117 -473
  242. data/docs/NgrokAPI/Services/ReservedDomainsClient.html +209 -899
  243. data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +110 -166
  244. data/docs/NgrokAPI/Services/SSHCredentialsClient.html +111 -169
  245. data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +111 -171
  246. data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +111 -175
  247. data/{doc/NgrokAPI/Services/EndpointOAuthModuleClient.html → docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html} +101 -129
  248. data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +1043 -0
  249. data/docs/NgrokAPI/Services/TLSCertificatesClient.html +107 -161
  250. data/docs/NgrokAPI/Services/{EndpointOAuthModuleClient.html → TLSEdgeBackendModuleClient.html} +101 -129
  251. data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +1043 -0
  252. data/{doc/NgrokAPI/Services/EndpointMutualTLSModuleClient.html → docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html} +83 -111
  253. data/{doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html → docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html} +83 -111
  254. data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +1644 -0
  255. data/docs/NgrokAPI/Services/TunnelSessionsClient.html +87 -135
  256. data/docs/NgrokAPI/Services/TunnelsClient.html +252 -26
  257. data/docs/NgrokAPI/Services/WeightedBackendsClient.html +1644 -0
  258. data/docs/NgrokAPI/Services.html +5 -5
  259. data/docs/NgrokAPI.html +4 -4
  260. data/docs/_index.html +253 -76
  261. data/docs/class_list.html +1 -1
  262. data/docs/file.README.html +3 -3
  263. data/docs/frames.html +1 -1
  264. data/docs/index.html +3 -3
  265. data/docs/method_list.html +3559 -1583
  266. data/docs/top-level-namespace.html +3 -3
  267. data/lib/ngrokapi/client.rb +52 -37
  268. data/lib/ngrokapi/http_client.rb +1 -4
  269. data/lib/ngrokapi/models/{ip_whitelist_entry.rb → agent_ingress.rb} +13 -9
  270. data/lib/ngrokapi/models/endpoint.rb +49 -0
  271. data/lib/ngrokapi/models/{endpoint_logging.rb → endpoint_backend.rb} +3 -3
  272. data/lib/ngrokapi/models/{endpoint_logging_mutate.rb → endpoint_backend_mutate.rb} +3 -3
  273. data/lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb +27 -0
  274. data/lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb +25 -0
  275. data/lib/ngrokapi/models/event_destination.rb +1 -2
  276. data/lib/ngrokapi/models/{event_stream.rb → failover_backend.rb} +15 -27
  277. data/lib/ngrokapi/models/http_response_backend.rb +71 -0
  278. data/lib/ngrokapi/models/https_edge.rb +80 -0
  279. data/lib/ngrokapi/models/{endpoint_configuration.rb → https_edge_route.rb} +56 -53
  280. data/lib/ngrokapi/models/ip_policy_rule.rb +3 -1
  281. data/lib/ngrokapi/models/tcp_edge.rb +78 -0
  282. data/lib/ngrokapi/models/tls_edge.rb +88 -0
  283. data/lib/ngrokapi/models/tunnel.rb +9 -1
  284. data/lib/ngrokapi/models/tunnel_group_backend.rb +67 -0
  285. data/lib/ngrokapi/models/weighted_backend.rb +65 -0
  286. data/lib/ngrokapi/services/abuse_reports_client.rb +3 -10
  287. data/lib/ngrokapi/services/agent_ingresses_client.rb +206 -0
  288. data/lib/ngrokapi/services/api_keys_client.rb +11 -36
  289. data/lib/ngrokapi/services/certificate_authorities_client.rb +11 -37
  290. data/lib/ngrokapi/services/credentials_client.rb +11 -39
  291. data/lib/ngrokapi/services/edge_route_backend_module_client.rb +120 -0
  292. data/lib/ngrokapi/services/{endpoint_circuit_breaker_module_client.rb → edge_route_circuit_breaker_module_client.rb} +37 -39
  293. data/lib/ngrokapi/services/{endpoint_compression_module_client.rb → edge_route_compression_module_client.rb} +37 -39
  294. data/lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb +120 -0
  295. data/lib/ngrokapi/services/{endpoint_o_auth_module_client.rb → edge_route_o_auth_module_client.rb} +37 -39
  296. data/lib/ngrokapi/services/{endpoint_oidc_module_client.rb → edge_route_oidc_module_client.rb} +37 -39
  297. data/lib/ngrokapi/services/{endpoint_request_headers_module_client.rb → edge_route_request_headers_module_client.rb} +37 -39
  298. data/lib/ngrokapi/services/{endpoint_response_headers_module_client.rb → edge_route_response_headers_module_client.rb} +37 -39
  299. data/lib/ngrokapi/services/{endpoint_saml_module_client.rb → edge_route_saml_module_client.rb} +37 -39
  300. data/lib/ngrokapi/services/{endpoint_webhook_validation_module_client.rb → edge_route_webhook_verification_module_client.rb} +37 -39
  301. data/lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb +120 -0
  302. data/lib/ngrokapi/services/edges_https_client.rb +227 -0
  303. data/lib/ngrokapi/services/edges_https_routes_client.rb +244 -0
  304. data/lib/ngrokapi/services/edges_tcp_client.rb +227 -0
  305. data/lib/ngrokapi/services/edges_tls_client.rb +239 -0
  306. data/lib/ngrokapi/services/endpoints_client.rb +114 -0
  307. data/lib/ngrokapi/services/event_destinations_client.rb +13 -49
  308. data/lib/ngrokapi/services/event_sources_client.rb +9 -40
  309. data/lib/ngrokapi/services/event_subscriptions_client.rb +14 -45
  310. data/lib/ngrokapi/services/failover_backends_client.rb +214 -0
  311. data/lib/ngrokapi/services/http_response_backends_client.rb +199 -0
  312. data/lib/ngrokapi/services/https_edge_mutual_tls_module_client.rb +108 -0
  313. data/lib/ngrokapi/services/https_edge_tls_termination_module_client.rb +108 -0
  314. data/lib/ngrokapi/services/ip_policies_client.rb +11 -39
  315. data/lib/ngrokapi/services/ip_policy_rules_client.rb +13 -40
  316. data/lib/ngrokapi/services/ip_restrictions_client.rb +12 -44
  317. data/lib/ngrokapi/services/reserved_addrs_client.rb +11 -81
  318. data/lib/ngrokapi/services/reserved_domains_client.rb +15 -144
  319. data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +11 -39
  320. data/lib/ngrokapi/services/ssh_credentials_client.rb +11 -40
  321. data/lib/ngrokapi/services/ssh_host_certificates_client.rb +11 -41
  322. data/lib/ngrokapi/services/ssh_user_certificates_client.rb +11 -43
  323. data/lib/ngrokapi/services/{endpoint_logging_module_client.rb → tcp_edge_backend_module_client.rb} +31 -45
  324. data/lib/ngrokapi/services/{endpoint_ip_policy_module_client.rb → tcp_edge_ip_restriction_module_client.rb} +21 -35
  325. data/lib/ngrokapi/services/tls_certificates_client.rb +11 -38
  326. data/lib/ngrokapi/services/tls_edge_backend_module_client.rb +108 -0
  327. data/lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb +108 -0
  328. data/lib/ngrokapi/services/{endpoint_mutual_tls_module_client.rb → tls_edge_mutual_tls_module_client.rb} +21 -35
  329. data/lib/ngrokapi/services/{endpoint_tls_termination_module_client.rb → tls_edge_tls_termination_module_client.rb} +21 -35
  330. data/lib/ngrokapi/services/{ip_whitelist_client.rb → tunnel_group_backends_client.rb} +70 -93
  331. data/lib/ngrokapi/services/tunnel_sessions_client.rb +12 -36
  332. data/lib/ngrokapi/services/tunnels_client.rb +39 -10
  333. data/lib/ngrokapi/services/weighted_backends_client.rb +214 -0
  334. data/lib/ngrokapi/version.rb +1 -1
  335. data/lib/ngrokapi.rb +1 -1
  336. data/ngrok-api.gemspec +1 -1
  337. data/spec/ngrokapi/client_spec.rb +50 -29
  338. data/spec/ngrokapi/models/agent_ingress_spec.rb +42 -0
  339. data/spec/ngrokapi/models/endpoint_backend_mutate_spec.rb +21 -0
  340. data/spec/ngrokapi/models/endpoint_backend_spec.rb +21 -0
  341. data/spec/ngrokapi/models/endpoint_spec.rb +21 -0
  342. data/spec/ngrokapi/models/endpoint_tls_termination_at_edge_spec.rb +21 -0
  343. data/spec/ngrokapi/models/endpoint_websocket_tcp_converter_spec.rb +21 -0
  344. data/spec/ngrokapi/models/failover_backend_spec.rb +45 -0
  345. data/spec/ngrokapi/models/http_response_backend_spec.rb +51 -0
  346. data/spec/ngrokapi/models/https_edge_route_spec.rb +81 -0
  347. data/spec/ngrokapi/models/https_edge_spec.rb +51 -0
  348. data/spec/ngrokapi/models/tcp_edge_spec.rb +51 -0
  349. data/spec/ngrokapi/models/tls_edge_spec.rb +57 -0
  350. data/spec/ngrokapi/models/tunnel_group_backend_spec.rb +45 -0
  351. data/spec/ngrokapi/models/weighted_backend_spec.rb +45 -0
  352. data/spec/ngrokapi/services/{ip_whitelist_client_spec.rb → agent_ingresses_client_spec.rb} +49 -49
  353. data/spec/ngrokapi/services/edge_route_backend_module_client_spec.rb +139 -0
  354. data/spec/ngrokapi/services/{endpoint_circuit_breaker_module_client_spec.rb → edge_route_circuit_breaker_module_client_spec.rb} +31 -17
  355. data/spec/ngrokapi/services/{endpoint_compression_module_client_spec.rb → edge_route_compression_module_client_spec.rb} +31 -17
  356. data/spec/ngrokapi/services/edge_route_ip_restriction_module_client_spec.rb +139 -0
  357. data/spec/ngrokapi/services/{endpoint_o_auth_module_client_spec.rb → edge_route_o_auth_module_client_spec.rb} +31 -17
  358. data/spec/ngrokapi/services/{endpoint_oidc_module_client_spec.rb → edge_route_oidc_module_client_spec.rb} +31 -17
  359. data/spec/ngrokapi/services/{endpoint_request_headers_module_client_spec.rb → edge_route_request_headers_module_client_spec.rb} +31 -17
  360. data/spec/ngrokapi/services/{endpoint_response_headers_module_client_spec.rb → edge_route_response_headers_module_client_spec.rb} +31 -17
  361. data/spec/ngrokapi/services/{endpoint_saml_module_client_spec.rb → edge_route_saml_module_client_spec.rb} +31 -17
  362. data/spec/ngrokapi/services/{endpoint_webhook_validation_module_client_spec.rb → edge_route_webhook_verification_module_client_spec.rb} +31 -17
  363. data/spec/ngrokapi/services/edge_route_websocket_tcp_converter_module_client_spec.rb +139 -0
  364. data/spec/ngrokapi/services/{event_streams_client_spec.rb → edges_https_client_spec.rb} +106 -108
  365. data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +241 -0
  366. data/spec/ngrokapi/services/edges_tcp_client_spec.rb +175 -0
  367. data/spec/ngrokapi/services/edges_tls_client_spec.rb +187 -0
  368. data/spec/ngrokapi/services/endpoints_client_spec.rb +57 -0
  369. data/spec/ngrokapi/services/failover_backends_client_spec.rb +163 -0
  370. data/spec/ngrokapi/services/http_response_backends_client_spec.rb +175 -0
  371. data/spec/ngrokapi/services/{endpoint_mutual_tls_module_client_spec.rb → https_edge_mutual_tls_module_client_spec.rb} +17 -17
  372. data/spec/ngrokapi/services/{endpoint_tls_termination_module_client_spec.rb → https_edge_tls_termination_module_client_spec.rb} +17 -17
  373. data/spec/ngrokapi/services/ip_policies_client_spec.rb +0 -1
  374. data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +3 -1
  375. data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +0 -44
  376. data/spec/ngrokapi/services/reserved_domains_client_spec.rb +0 -88
  377. data/spec/ngrokapi/services/{endpoint_logging_module_client_spec.rb → tcp_edge_backend_module_client_spec.rb} +40 -40
  378. data/spec/ngrokapi/services/{endpoint_ip_policy_module_client_spec.rb → tcp_edge_ip_restriction_module_client_spec.rb} +17 -17
  379. data/spec/ngrokapi/services/tls_edge_backend_module_client_spec.rb +125 -0
  380. data/spec/ngrokapi/services/tls_edge_ip_restriction_module_client_spec.rb +125 -0
  381. data/spec/ngrokapi/services/tls_edge_mutual_tls_module_client_spec.rb +125 -0
  382. data/spec/ngrokapi/services/tls_edge_tls_termination_module_client_spec.rb +125 -0
  383. data/spec/ngrokapi/services/tunnel_group_backends_client_spec.rb +163 -0
  384. data/spec/ngrokapi/services/tunnels_client_spec.rb +36 -0
  385. data/spec/ngrokapi/services/weighted_backends_client_spec.rb +163 -0
  386. data/spec/spec_helper.rb +1389 -1045
  387. metadata +175 -83
  388. data/lib/ngrokapi/services/endpoint_configurations_client.rb +0 -357
  389. data/lib/ngrokapi/services/event_streams_client.rb +0 -259
  390. data/spec/ngrokapi/models/endpoint_configuration_spec.rb +0 -78
  391. data/spec/ngrokapi/models/endpoint_logging_mutate_spec.rb +0 -21
  392. data/spec/ngrokapi/models/endpoint_logging_spec.rb +0 -21
  393. data/spec/ngrokapi/models/event_stream_spec.rb +0 -51
  394. data/spec/ngrokapi/models/ip_whitelist_entry_spec.rb +0 -42
  395. data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +0 -237
@@ -28,11 +28,8 @@ module NgrokAPI
28
28
  # @return [NgrokAPI::Models::Listable] result from the API request
29
29
  #
30
30
  # https://ngrok.com/docs/api#api-tunnels-list
31
- def list(
32
- before_id: nil,
33
- limit: nil,
34
- url: nil
35
- )
31
+ def list(before_id: nil, limit: nil,
32
+ url: nil)
36
33
  result = @client.list(
37
34
  before_id: before_id,
38
35
  limit: limit,
@@ -58,11 +55,8 @@ module NgrokAPI
58
55
  # @return [NgrokAPI::Models::Listable] result from the API request
59
56
  #
60
57
  # https://ngrok.com/docs/api#api-tunnels-list
61
- def list!(
62
- before_id: nil,
63
- limit: nil,
64
- url: nil
65
- )
58
+ def list!(before_id: nil, limit: nil,
59
+ url: nil)
66
60
  result = @client.list(
67
61
  before_id: before_id,
68
62
  limit: limit,
@@ -79,6 +73,41 @@ module NgrokAPI
79
73
  danger: true
80
74
  )
81
75
  end
76
+
77
+ ##
78
+ # Get the status of a tunnel by ID
79
+ #
80
+ # @param [string] id a resource identifier
81
+ # @return [NgrokAPI::Models::Tunnel] result from the API request
82
+ #
83
+ # https://ngrok.com/docs/api#api-tunnels-get
84
+ def get(id: "")
85
+ path = '/tunnels/%{id}'
86
+ replacements = {
87
+ id: id,
88
+ }
89
+ data = {}
90
+ result = @client.get(path % replacements, data: data)
91
+ NgrokAPI::Models::Tunnel.new(client: self, result: result)
92
+ end
93
+
94
+ ##
95
+ # Get the status of a tunnel by ID
96
+ # Throws an exception if API error.
97
+ #
98
+ # @param [string] id a resource identifier
99
+ # @return [NgrokAPI::Models::Tunnel] result from the API request
100
+ #
101
+ # https://ngrok.com/docs/api#api-tunnels-get
102
+ def get!(id: "")
103
+ path = '/tunnels/%{id}'
104
+ replacements = {
105
+ id: id,
106
+ }
107
+ data = {}
108
+ result = @client.get(path % replacements, data: data, danger: true)
109
+ NgrokAPI::Models::Tunnel.new(client: self, result: result)
110
+ end
82
111
  end
83
112
  end
84
113
  end
@@ -0,0 +1,214 @@
1
+ # frozen_string_literal: true
2
+
3
+ module NgrokAPI
4
+ module Services
5
+ ##
6
+ # A Weighted Backend balances traffic among the referenced backends. Traffic
7
+ # is assigned proportionally to each based on its weight. The percentage of
8
+ # traffic is calculated by dividing a backend's weight by the sum of all
9
+ # weights.
10
+ #
11
+ # https://ngrok.com/docs/api#api-weighted-backends
12
+ class WeightedBackendsClient
13
+ # The API path for the requests
14
+ PATH = '/backends/weighted'
15
+ # The List Property from the resulting API for list calls
16
+ LIST_PROPERTY = 'backends'
17
+
18
+ attr_reader :client
19
+
20
+ def initialize(client:)
21
+ @client = client
22
+ end
23
+
24
+ ##
25
+ # Create a new Weighted backend
26
+ #
27
+ # @param [string] description human-readable description of this backend. Optional
28
+ # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
29
+ # @param [Map<string, int64>] backends the ids of the child backends to their weights (0-10000)
30
+ # @return [NgrokAPI::Models::WeightedBackend] result from the API request
31
+ #
32
+ # https://ngrok.com/docs/api#api-weighted-backends-create
33
+ def create(description: "", metadata: "", backends: {})
34
+ path = '/backends/weighted'
35
+ replacements = {
36
+ }
37
+ data = {}
38
+ data[:description] = description if description
39
+ data[:metadata] = metadata if metadata
40
+ data[:backends] = backends if backends
41
+ result = @client.post(path % replacements, data: data)
42
+ NgrokAPI::Models::WeightedBackend.new(client: self, result: result)
43
+ end
44
+
45
+ ##
46
+ # Delete a Weighted backend by ID. TODO what if used?
47
+ #
48
+ # @param [string] id a resource identifier
49
+ # @return [NgrokAPI::Models::Empty] result from the API request
50
+ #
51
+ # https://ngrok.com/docs/api#api-weighted-backends-delete
52
+ def delete(id: "")
53
+ path = '/backends/weighted/%{id}'
54
+ replacements = {
55
+ id: id,
56
+ }
57
+ @client.delete(path % replacements)
58
+ end
59
+
60
+ ##
61
+ # Delete a Weighted backend by ID. TODO what if used?
62
+ # Throws an exception if API error.
63
+ #
64
+ # @param [string] id a resource identifier
65
+ # @return [NgrokAPI::Models::Empty] result from the API request
66
+ #
67
+ # https://ngrok.com/docs/api#api-weighted-backends-delete
68
+ def delete!(id: "")
69
+ path = '/backends/weighted/%{id}'
70
+ replacements = {
71
+ id: id,
72
+ }
73
+ @client.delete(path % replacements, danger: true)
74
+ end
75
+
76
+ ##
77
+ # Get detailed information about a Weighted backend by ID
78
+ #
79
+ # @param [string] id a resource identifier
80
+ # @return [NgrokAPI::Models::WeightedBackend] result from the API request
81
+ #
82
+ # https://ngrok.com/docs/api#api-weighted-backends-get
83
+ def get(id: "")
84
+ path = '/backends/weighted/%{id}'
85
+ replacements = {
86
+ id: id,
87
+ }
88
+ data = {}
89
+ result = @client.get(path % replacements, data: data)
90
+ NgrokAPI::Models::WeightedBackend.new(client: self, result: result)
91
+ end
92
+
93
+ ##
94
+ # Get detailed information about a Weighted backend by ID
95
+ # Throws an exception if API error.
96
+ #
97
+ # @param [string] id a resource identifier
98
+ # @return [NgrokAPI::Models::WeightedBackend] result from the API request
99
+ #
100
+ # https://ngrok.com/docs/api#api-weighted-backends-get
101
+ def get!(id: "")
102
+ path = '/backends/weighted/%{id}'
103
+ replacements = {
104
+ id: id,
105
+ }
106
+ data = {}
107
+ result = @client.get(path % replacements, data: data, danger: true)
108
+ NgrokAPI::Models::WeightedBackend.new(client: self, result: result)
109
+ end
110
+
111
+ ##
112
+ # List all Weighted backends on this account
113
+ #
114
+ # @param [string] before_id
115
+ # @param [string] limit
116
+ # @param [string] url optional and mutually exclusive from before_id and limit
117
+ # @return [NgrokAPI::Models::Listable] result from the API request
118
+ #
119
+ # https://ngrok.com/docs/api#api-weighted-backends-list
120
+ def list(before_id: nil, limit: nil,
121
+ url: nil)
122
+ result = @client.list(
123
+ before_id: before_id,
124
+ limit: limit,
125
+ url: url,
126
+ path: PATH
127
+ )
128
+
129
+ NgrokAPI::Models::Listable.new(
130
+ client: self,
131
+ result: result,
132
+ list_property: LIST_PROPERTY,
133
+ klass: NgrokAPI::Models::WeightedBackend
134
+ )
135
+ end
136
+
137
+ ##
138
+ # List all Weighted backends on this account
139
+ # Throws an exception if API error.
140
+ #
141
+ # @param [string] before_id
142
+ # @param [string] limit
143
+ # @param [string] url optional and mutually exclusive from before_id and limit
144
+ # @return [NgrokAPI::Models::Listable] result from the API request
145
+ #
146
+ # https://ngrok.com/docs/api#api-weighted-backends-list
147
+ def list!(before_id: nil, limit: nil,
148
+ url: nil)
149
+ result = @client.list(
150
+ before_id: before_id,
151
+ limit: limit,
152
+ danger: true,
153
+ url: url,
154
+ path: PATH
155
+ )
156
+
157
+ NgrokAPI::Models::Listable.new(
158
+ client: self,
159
+ result: result,
160
+ list_property: LIST_PROPERTY,
161
+ klass: NgrokAPI::Models::WeightedBackend,
162
+ danger: true
163
+ )
164
+ end
165
+
166
+ ##
167
+ # Update Weighted backend by ID
168
+ #
169
+ # @param [string] id
170
+ # @param [string] description human-readable description of this backend. Optional
171
+ # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
172
+ # @param [Map<string, int64>] backends the ids of the child backends to their weights (0-10000)
173
+ # @return [NgrokAPI::Models::WeightedBackend] result from the API request
174
+ #
175
+ # https://ngrok.com/docs/api#api-weighted-backends-update
176
+ def update(id: "", description: nil, metadata: nil, backends: {})
177
+ path = '/backends/weighted/%{id}'
178
+ replacements = {
179
+ id: id,
180
+ }
181
+ data = {}
182
+ data[:description] = description if description
183
+ data[:metadata] = metadata if metadata
184
+ data[:backends] = backends if backends
185
+ result = @client.patch(path % replacements, data: data)
186
+ NgrokAPI::Models::WeightedBackend.new(client: self, result: result)
187
+ end
188
+
189
+ ##
190
+ # Update Weighted backend by ID
191
+ # Throws an exception if API error.
192
+ #
193
+ # @param [string] id
194
+ # @param [string] description human-readable description of this backend. Optional
195
+ # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
196
+ # @param [Map<string, int64>] backends the ids of the child backends to their weights (0-10000)
197
+ # @return [NgrokAPI::Models::WeightedBackend] result from the API request
198
+ #
199
+ # https://ngrok.com/docs/api#api-weighted-backends-update
200
+ def update!(id: "", description: nil, metadata: nil, backends: {})
201
+ path = '/backends/weighted/%{id}'
202
+ replacements = {
203
+ id: id,
204
+ }
205
+ data = {}
206
+ data[:description] = description if description
207
+ data[:metadata] = metadata if metadata
208
+ data[:backends] = backends if backends
209
+ result = @client.patch(path % replacements, data: data, danger: true)
210
+ NgrokAPI::Models::WeightedBackend.new(client: self, result: result)
211
+ end
212
+ end
213
+ end
214
+ end
@@ -2,6 +2,6 @@ module NgrokAPI
2
2
  # rubocop:disable Layout/SpaceAroundOperators
3
3
 
4
4
  # The current version of the gem
5
- VERSION="0.15.0".freeze
5
+ VERSION="0.18.0".freeze
6
6
  # rubocop:enable Layout/SpaceAroundOperators
7
7
  end
data/lib/ngrokapi.rb CHANGED
@@ -3,7 +3,7 @@
3
3
  require 'json'
4
4
  require 'net/http'
5
5
 
6
- Dir[File.join('.', 'lib', '**/*.rb')].each do |f|
6
+ Dir[File.join('.', 'lib', '**/*.rb')].sort.each do |f|
7
7
  require f
8
8
  end
9
9
 
data/ngrok-api.gemspec CHANGED
@@ -16,7 +16,7 @@ Gem::Specification.new do |s|
16
16
  s.description = 'This library wraps the [ngrok HTTP API](https://ngrok.com/docs/api) to make
17
17
  it easier to consume in Ruby.'
18
18
 
19
- s.required_ruby_version = '>= 3.0.0'
19
+ s.required_ruby_version = '>= 2.7.2'
20
20
 
21
21
  all_files = `git ls-files`.split("\n")
22
22
  test_files = `git ls-files -- {test,spec,features}/*`.split('\n')
@@ -12,6 +12,12 @@ RSpec.describe NgrokAPI::Client do
12
12
  end
13
13
  end
14
14
 
15
+ describe "#agent_ingresses" do
16
+ it "returns an instance of the AgentIngressesClient" do
17
+ expect(@client.agent_ingresses.class).to eq(NgrokAPI::Services::AgentIngressesClient)
18
+ end
19
+ end
20
+
15
21
  describe "#api_keys" do
16
22
  it "returns an instance of the APIKeysClient" do
17
23
  expect(@client.api_keys.class).to eq(NgrokAPI::Services::APIKeysClient)
@@ -30,15 +36,9 @@ RSpec.describe NgrokAPI::Client do
30
36
  end
31
37
  end
32
38
 
33
- describe "#endpoint_configurations" do
34
- it "returns an instance of the EndpointConfigurationsClient" do
35
- expect(@client.endpoint_configurations.class).to eq(NgrokAPI::Services::EndpointConfigurationsClient)
36
- end
37
- end
38
-
39
- describe "#event_streams" do
40
- it "returns an instance of the EventStreamsClient" do
41
- expect(@client.event_streams.class).to eq(NgrokAPI::Services::EventStreamsClient)
39
+ describe "#endpoints" do
40
+ it "returns an instance of the EndpointsClient" do
41
+ expect(@client.endpoints.class).to eq(NgrokAPI::Services::EndpointsClient)
42
42
  end
43
43
  end
44
44
 
@@ -78,12 +78,6 @@ RSpec.describe NgrokAPI::Client do
78
78
  end
79
79
  end
80
80
 
81
- describe "#ip_whitelist" do
82
- it "returns an instance of the IPWhitelistClient" do
83
- expect(@client.ip_whitelist.class).to eq(NgrokAPI::Services::IPWhitelistClient)
84
- end
85
- end
86
-
87
81
  describe "#reserved_addrs" do
88
82
  it "returns an instance of the ReservedAddrsClient" do
89
83
  expect(@client.reserved_addrs.class).to eq(NgrokAPI::Services::ReservedAddrsClient)
@@ -138,21 +132,48 @@ RSpec.describe NgrokAPI::Client do
138
132
  end
139
133
  end
140
134
 
141
- describe "#pointcfg_module" do
135
+ describe "#backends" do
136
+ it "returns an instance of OpenStruct covering namespaces" do
137
+ ns = @client.backends
138
+ expect(ns.failover.class).to eq(NgrokAPI::Services::FailoverBackendsClient)
139
+ expect(ns.http_response.class).to eq(NgrokAPI::Services::HTTPResponseBackendsClient)
140
+ expect(ns.tunnel_group.class).to eq(NgrokAPI::Services::TunnelGroupBackendsClient)
141
+ expect(ns.weighted.class).to eq(NgrokAPI::Services::WeightedBackendsClient)
142
+ end
143
+ end
144
+
145
+ describe "#edges" do
146
+ it "returns an instance of OpenStruct covering namespaces" do
147
+ ns = @client.edges
148
+ expect(ns.https_routes.class).to eq(NgrokAPI::Services::EdgesHTTPSRoutesClient)
149
+ expect(ns.https.class).to eq(NgrokAPI::Services::EdgesHTTPSClient)
150
+ expect(ns.tcp.class).to eq(NgrokAPI::Services::EdgesTCPClient)
151
+ expect(ns.tls.class).to eq(NgrokAPI::Services::EdgesTLSClient)
152
+ end
153
+ end
154
+
155
+ describe "#edge_modules" do
142
156
  it "returns an instance of OpenStruct covering namespaces" do
143
- ns = @client.pointcfg_module
144
- expect(ns.logging.class).to eq(NgrokAPI::Services::EndpointLoggingModuleClient)
145
- expect(ns.circuit_breaker.class).to eq(NgrokAPI::Services::EndpointCircuitBreakerModuleClient)
146
- expect(ns.compression.class).to eq(NgrokAPI::Services::EndpointCompressionModuleClient)
147
- expect(ns.tls_termination.class).to eq(NgrokAPI::Services::EndpointTLSTerminationModuleClient)
148
- expect(ns.ip_policy.class).to eq(NgrokAPI::Services::EndpointIPPolicyModuleClient)
149
- expect(ns.mutual_tls.class).to eq(NgrokAPI::Services::EndpointMutualTLSModuleClient)
150
- expect(ns.request_headers.class).to eq(NgrokAPI::Services::EndpointRequestHeadersModuleClient)
151
- expect(ns.response_headers.class).to eq(NgrokAPI::Services::EndpointResponseHeadersModuleClient)
152
- expect(ns.oauth.class).to eq(NgrokAPI::Services::EndpointOAuthModuleClient)
153
- expect(ns.webhook_validation.class).to eq(NgrokAPI::Services::EndpointWebhookValidationModuleClient)
154
- expect(ns.saml.class).to eq(NgrokAPI::Services::EndpointSAMLModuleClient)
155
- expect(ns.oidc.class).to eq(NgrokAPI::Services::EndpointOIDCModuleClient)
157
+ ns = @client.edge_modules
158
+ expect(ns.https_edge_mutual_tls.class).to eq(NgrokAPI::Services::HTTPSEdgeMutualTLSModuleClient)
159
+ expect(ns.https_edge_tls_termination.class).to eq(NgrokAPI::Services::HTTPSEdgeTLSTerminationModuleClient)
160
+ expect(ns.https_edge_route_backend.class).to eq(NgrokAPI::Services::EdgeRouteBackendModuleClient)
161
+ expect(ns.https_edge_route_ip_restriction.class).to eq(NgrokAPI::Services::EdgeRouteIPRestrictionModuleClient)
162
+ expect(ns.https_edge_route_request_headers.class).to eq(NgrokAPI::Services::EdgeRouteRequestHeadersModuleClient)
163
+ expect(ns.https_edge_route_response_headers.class).to eq(NgrokAPI::Services::EdgeRouteResponseHeadersModuleClient)
164
+ expect(ns.https_edge_route_compression.class).to eq(NgrokAPI::Services::EdgeRouteCompressionModuleClient)
165
+ expect(ns.https_edge_route_circuit_breaker.class).to eq(NgrokAPI::Services::EdgeRouteCircuitBreakerModuleClient)
166
+ expect(ns.https_edge_route_webhook_verification.class).to eq(NgrokAPI::Services::EdgeRouteWebhookVerificationModuleClient)
167
+ expect(ns.https_edge_route_oauth.class).to eq(NgrokAPI::Services::EdgeRouteOAuthModuleClient)
168
+ expect(ns.https_edge_route_saml.class).to eq(NgrokAPI::Services::EdgeRouteSAMLModuleClient)
169
+ expect(ns.https_edge_route_oidc.class).to eq(NgrokAPI::Services::EdgeRouteOIDCModuleClient)
170
+ expect(ns.https_edge_route_websocket_tcp_converter.class).to eq(NgrokAPI::Services::EdgeRouteWebsocketTCPConverterModuleClient)
171
+ expect(ns.tcp_edge_backend.class).to eq(NgrokAPI::Services::TCPEdgeBackendModuleClient)
172
+ expect(ns.tcp_edge_ip_restriction.class).to eq(NgrokAPI::Services::TCPEdgeIPRestrictionModuleClient)
173
+ expect(ns.tls_edge_backend.class).to eq(NgrokAPI::Services::TLSEdgeBackendModuleClient)
174
+ expect(ns.tls_edge_ip_restriction.class).to eq(NgrokAPI::Services::TLSEdgeIPRestrictionModuleClient)
175
+ expect(ns.tls_edge_mutual_tls.class).to eq(NgrokAPI::Services::TLSEdgeMutualTLSModuleClient)
176
+ expect(ns.tls_edge_tls_termination.class).to eq(NgrokAPI::Services::TLSEdgeTLSTerminationModuleClient)
156
177
  end
157
178
  end
158
179
  end
@@ -0,0 +1,42 @@
1
+ require 'spec_helper'
2
+
3
+ RSpec.describe NgrokAPI::Models::AgentIngress do
4
+ before(:each) do
5
+ @client = class_double("AgentIngresssClient")
6
+ @agent_ingress = NgrokAPI::Models::AgentIngress.new(client: @client, result: agent_ingress_result)
7
+ end
8
+
9
+ describe "#==" do
10
+ it "is equal if the results are the same" do
11
+ other = NgrokAPI::Models::AgentIngress.new(client: @client, result: agent_ingress_result)
12
+ expect(@agent_ingress == other).to eq true
13
+ end
14
+ end
15
+
16
+ describe "#to_s" do
17
+ it "stringifies as result.to_s" do
18
+ expect(@agent_ingress.to_s).to eq agent_ingress_result.to_s
19
+ end
20
+ end
21
+
22
+ describe "#delete" do
23
+ it "calls delete on the client" do
24
+ expect(@agent_ingress.client).to receive(:delete)
25
+ @agent_ingress.delete
26
+ end
27
+ end
28
+
29
+ describe "#update" do
30
+ it "calls update on the client" do
31
+ new_description = 'New description'
32
+ new_metadata = 'New metadata'
33
+ expect(@agent_ingress.client).to receive(:update)
34
+ @agent_ingress.update(
35
+ description: new_description,
36
+ metadata: new_metadata
37
+ )
38
+ expect(@agent_ingress.description).to eq new_description
39
+ expect(@agent_ingress.metadata).to eq new_metadata
40
+ end
41
+ end
42
+ end
@@ -0,0 +1,21 @@
1
+ require 'spec_helper'
2
+
3
+ RSpec.describe NgrokAPI::Models::EndpointBackendMutate do
4
+ before(:each) do
5
+ @client = class_double("EndpointBackendMutatesClient")
6
+ @endpoint_backend_mutate = NgrokAPI::Models::EndpointBackendMutate.new(client: @client, result: endpoint_backend_mutate_result)
7
+ end
8
+
9
+ describe "#==" do
10
+ it "is equal if the results are the same" do
11
+ other = NgrokAPI::Models::EndpointBackendMutate.new(client: @client, result: endpoint_backend_mutate_result)
12
+ expect(@endpoint_backend_mutate == other).to eq true
13
+ end
14
+ end
15
+
16
+ describe "#to_s" do
17
+ it "stringifies as result.to_s" do
18
+ expect(@endpoint_backend_mutate.to_s).to eq endpoint_backend_mutate_result.to_s
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,21 @@
1
+ require 'spec_helper'
2
+
3
+ RSpec.describe NgrokAPI::Models::EndpointBackend do
4
+ before(:each) do
5
+ @client = class_double("EndpointBackendsClient")
6
+ @endpoint_backend = NgrokAPI::Models::EndpointBackend.new(client: @client, result: endpoint_backend_result)
7
+ end
8
+
9
+ describe "#==" do
10
+ it "is equal if the results are the same" do
11
+ other = NgrokAPI::Models::EndpointBackend.new(client: @client, result: endpoint_backend_result)
12
+ expect(@endpoint_backend == other).to eq true
13
+ end
14
+ end
15
+
16
+ describe "#to_s" do
17
+ it "stringifies as result.to_s" do
18
+ expect(@endpoint_backend.to_s).to eq endpoint_backend_result.to_s
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,21 @@
1
+ require 'spec_helper'
2
+
3
+ RSpec.describe NgrokAPI::Models::Endpoint do
4
+ before(:each) do
5
+ @client = class_double("EndpointsClient")
6
+ @endpoint = NgrokAPI::Models::Endpoint.new(client: @client, result: endpoint_result)
7
+ end
8
+
9
+ describe "#==" do
10
+ it "is equal if the results are the same" do
11
+ other = NgrokAPI::Models::Endpoint.new(client: @client, result: endpoint_result)
12
+ expect(@endpoint == other).to eq true
13
+ end
14
+ end
15
+
16
+ describe "#to_s" do
17
+ it "stringifies as result.to_s" do
18
+ expect(@endpoint.to_s).to eq endpoint_result.to_s
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,21 @@
1
+ require 'spec_helper'
2
+
3
+ RSpec.describe NgrokAPI::Models::EndpointTLSTerminationAtEdge do
4
+ before(:each) do
5
+ @client = class_double("EndpointTLSTerminationAtEdgesClient")
6
+ @endpoint_tls_termination_at_edge = NgrokAPI::Models::EndpointTLSTerminationAtEdge.new(client: @client, result: endpoint_tls_termination_at_edge_result)
7
+ end
8
+
9
+ describe "#==" do
10
+ it "is equal if the results are the same" do
11
+ other = NgrokAPI::Models::EndpointTLSTerminationAtEdge.new(client: @client, result: endpoint_tls_termination_at_edge_result)
12
+ expect(@endpoint_tls_termination_at_edge == other).to eq true
13
+ end
14
+ end
15
+
16
+ describe "#to_s" do
17
+ it "stringifies as result.to_s" do
18
+ expect(@endpoint_tls_termination_at_edge.to_s).to eq endpoint_tls_termination_at_edge_result.to_s
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,21 @@
1
+ require 'spec_helper'
2
+
3
+ RSpec.describe NgrokAPI::Models::EndpointWebsocketTCPConverter do
4
+ before(:each) do
5
+ @client = class_double("EndpointWebsocketTCPConvertersClient")
6
+ @endpoint_websocket_tcp_converter = NgrokAPI::Models::EndpointWebsocketTCPConverter.new(client: @client, result: endpoint_websocket_tcp_converter_result)
7
+ end
8
+
9
+ describe "#==" do
10
+ it "is equal if the results are the same" do
11
+ other = NgrokAPI::Models::EndpointWebsocketTCPConverter.new(client: @client, result: endpoint_websocket_tcp_converter_result)
12
+ expect(@endpoint_websocket_tcp_converter == other).to eq true
13
+ end
14
+ end
15
+
16
+ describe "#to_s" do
17
+ it "stringifies as result.to_s" do
18
+ expect(@endpoint_websocket_tcp_converter.to_s).to eq endpoint_websocket_tcp_converter_result.to_s
19
+ end
20
+ end
21
+ end
@@ -0,0 +1,45 @@
1
+ require 'spec_helper'
2
+
3
+ RSpec.describe NgrokAPI::Models::FailoverBackend do
4
+ before(:each) do
5
+ @client = class_double("FailoverBackendsClient")
6
+ @failover_backend = NgrokAPI::Models::FailoverBackend.new(client: @client, result: failover_backend_result)
7
+ end
8
+
9
+ describe "#==" do
10
+ it "is equal if the results are the same" do
11
+ other = NgrokAPI::Models::FailoverBackend.new(client: @client, result: failover_backend_result)
12
+ expect(@failover_backend == other).to eq true
13
+ end
14
+ end
15
+
16
+ describe "#to_s" do
17
+ it "stringifies as result.to_s" do
18
+ expect(@failover_backend.to_s).to eq failover_backend_result.to_s
19
+ end
20
+ end
21
+
22
+ describe "#delete" do
23
+ it "calls delete on the client" do
24
+ expect(@failover_backend.client).to receive(:delete)
25
+ @failover_backend.delete
26
+ end
27
+ end
28
+
29
+ describe "#update" do
30
+ it "calls update on the client" do
31
+ new_description = 'New description'
32
+ new_metadata = 'New metadata'
33
+ new_backends = 'New backends'
34
+ expect(@failover_backend.client).to receive(:update)
35
+ @failover_backend.update(
36
+ description: new_description,
37
+ metadata: new_metadata,
38
+ backends: new_backends
39
+ )
40
+ expect(@failover_backend.description).to eq new_description
41
+ expect(@failover_backend.metadata).to eq new_metadata
42
+ expect(@failover_backend.backends).to eq new_backends
43
+ end
44
+ end
45
+ end
@@ -0,0 +1,51 @@
1
+ require 'spec_helper'
2
+
3
+ RSpec.describe NgrokAPI::Models::HTTPResponseBackend do
4
+ before(:each) do
5
+ @client = class_double("HTTPResponseBackendsClient")
6
+ @http_response_backend = NgrokAPI::Models::HTTPResponseBackend.new(client: @client, result: http_response_backend_result)
7
+ end
8
+
9
+ describe "#==" do
10
+ it "is equal if the results are the same" do
11
+ other = NgrokAPI::Models::HTTPResponseBackend.new(client: @client, result: http_response_backend_result)
12
+ expect(@http_response_backend == other).to eq true
13
+ end
14
+ end
15
+
16
+ describe "#to_s" do
17
+ it "stringifies as result.to_s" do
18
+ expect(@http_response_backend.to_s).to eq http_response_backend_result.to_s
19
+ end
20
+ end
21
+
22
+ describe "#delete" do
23
+ it "calls delete on the client" do
24
+ expect(@http_response_backend.client).to receive(:delete)
25
+ @http_response_backend.delete
26
+ end
27
+ end
28
+
29
+ describe "#update" do
30
+ it "calls update on the client" do
31
+ new_description = 'New description'
32
+ new_metadata = 'New metadata'
33
+ new_body = 'New body'
34
+ new_headers = 'New headers'
35
+ new_status_code = 'New status_code'
36
+ expect(@http_response_backend.client).to receive(:update)
37
+ @http_response_backend.update(
38
+ description: new_description,
39
+ metadata: new_metadata,
40
+ body: new_body,
41
+ headers: new_headers,
42
+ status_code: new_status_code
43
+ )
44
+ expect(@http_response_backend.description).to eq new_description
45
+ expect(@http_response_backend.metadata).to eq new_metadata
46
+ expect(@http_response_backend.body).to eq new_body
47
+ expect(@http_response_backend.headers).to eq new_headers
48
+ expect(@http_response_backend.status_code).to eq new_status_code
49
+ end
50
+ end
51
+ end