ngrok-api 0.21.0 → 0.22.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (378) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +4 -0
  3. data/doc/NgrokAPI/Client.html +152 -96
  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 +4 -4
  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 +3 -3
  15. data/doc/NgrokAPI/Models/AgentIngressCertJob.html +3 -3
  16. data/doc/NgrokAPI/Models/AgentIngressCertPolicy.html +3 -3
  17. data/doc/NgrokAPI/Models/AgentIngressCertStatus.html +3 -3
  18. data/doc/NgrokAPI/Models/ApplicationSession.html +3 -3
  19. data/doc/NgrokAPI/Models/ApplicationUser.html +3 -3
  20. data/doc/NgrokAPI/Models/BotUser.html +1051 -0
  21. data/doc/NgrokAPI/Models/BrowserSession.html +3 -3
  22. data/doc/NgrokAPI/Models/CertificateAuthority.html +3 -3
  23. data/doc/NgrokAPI/Models/Credential.html +3 -3
  24. data/doc/NgrokAPI/Models/Endpoint.html +3 -3
  25. data/doc/NgrokAPI/Models/EndpointAction.html +669 -0
  26. data/doc/NgrokAPI/Models/EndpointBackend.html +3 -3
  27. data/doc/NgrokAPI/Models/EndpointBackendMutate.html +3 -3
  28. data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +3 -3
  29. data/doc/NgrokAPI/Models/EndpointCompression.html +3 -3
  30. data/doc/NgrokAPI/Models/EndpointIPPolicy.html +3 -3
  31. data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +3 -3
  32. data/doc/NgrokAPI/Models/EndpointMutualTLS.html +3 -3
  33. data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +3 -3
  34. data/doc/NgrokAPI/Models/EndpointOAuth.html +3 -3
  35. data/doc/NgrokAPI/Models/EndpointOAuthAmazon.html +3 -3
  36. data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +3 -3
  37. data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +3 -3
  38. data/doc/NgrokAPI/Models/EndpointOAuthGitLab.html +3 -3
  39. data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +3 -3
  40. data/doc/NgrokAPI/Models/EndpointOAuthLinkedIn.html +3 -3
  41. data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +3 -3
  42. data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +3 -3
  43. data/doc/NgrokAPI/Models/EndpointOAuthTwitch.html +3 -3
  44. data/doc/NgrokAPI/Models/EndpointOIDC.html +3 -3
  45. data/doc/NgrokAPI/Models/EndpointPolicy.html +743 -0
  46. data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +3 -3
  47. data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +3 -3
  48. data/doc/NgrokAPI/Models/EndpointRule.html +743 -0
  49. data/doc/NgrokAPI/Models/EndpointSAML.html +18 -96
  50. data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +18 -96
  51. data/doc/NgrokAPI/Models/EndpointTLSTermination.html +3 -3
  52. data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +3 -3
  53. data/doc/NgrokAPI/Models/EndpointUserAgentFilter.html +743 -0
  54. data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +3 -3
  55. data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +3 -3
  56. data/doc/NgrokAPI/Models/EventDestination.html +3 -3
  57. data/doc/NgrokAPI/Models/EventSource.html +19 -167
  58. data/doc/NgrokAPI/Models/EventSourceList.html +3 -3
  59. data/doc/NgrokAPI/Models/EventSourceReplace.html +19 -167
  60. data/doc/NgrokAPI/Models/EventSubscription.html +3 -3
  61. data/doc/NgrokAPI/Models/EventTarget.html +18 -92
  62. data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +3 -3
  63. data/doc/NgrokAPI/Models/EventTargetDatadog.html +3 -3
  64. data/doc/NgrokAPI/Models/EventTargetFirehose.html +3 -3
  65. data/doc/NgrokAPI/Models/EventTargetKinesis.html +3 -3
  66. data/doc/NgrokAPI/Models/FailoverBackend.html +3 -3
  67. data/doc/NgrokAPI/Models/HTTPResponseBackend.html +3 -3
  68. data/doc/NgrokAPI/Models/HTTPSEdge.html +3 -3
  69. data/doc/NgrokAPI/Models/HTTPSEdgeRoute.html +197 -37
  70. data/doc/NgrokAPI/Models/IPPolicy.html +27 -101
  71. data/doc/NgrokAPI/Models/IPPolicyRule.html +3 -3
  72. data/doc/NgrokAPI/Models/IPRestriction.html +3 -3
  73. data/doc/NgrokAPI/Models/IdentityProvider.html +3 -3
  74. data/doc/NgrokAPI/Models/Listable.html +3 -3
  75. data/doc/NgrokAPI/Models/Location.html +3 -3
  76. data/doc/NgrokAPI/Models/Ref.html +3 -3
  77. data/doc/NgrokAPI/Models/ReservedAddr.html +22 -96
  78. data/doc/NgrokAPI/Models/ReservedDomain.html +25 -173
  79. data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +3 -3
  80. data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +3 -3
  81. data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +3 -3
  82. data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +3 -3
  83. data/doc/NgrokAPI/Models/SSHCredential.html +3 -3
  84. data/doc/NgrokAPI/Models/SSHHostCertificate.html +3 -3
  85. data/doc/NgrokAPI/Models/SSHUserCertificate.html +3 -3
  86. data/doc/NgrokAPI/Models/StaticBackend.html +1211 -0
  87. data/doc/NgrokAPI/Models/StaticBackendTLS.html +595 -0
  88. data/doc/NgrokAPI/Models/TCPEdge.html +112 -32
  89. data/doc/NgrokAPI/Models/TLSCertificate.html +3 -3
  90. data/doc/NgrokAPI/Models/TLSCertificateSANs.html +3 -3
  91. data/doc/NgrokAPI/Models/TLSEdge.html +112 -32
  92. data/doc/NgrokAPI/Models/Tunnel.html +3 -3
  93. data/doc/NgrokAPI/Models/TunnelGroupBackend.html +3 -3
  94. data/doc/NgrokAPI/Models/TunnelSession.html +3 -3
  95. data/doc/NgrokAPI/Models/UserAgent.html +3 -3
  96. data/doc/NgrokAPI/Models/WeightedBackend.html +3 -3
  97. data/doc/NgrokAPI/Models.html +5 -5
  98. data/doc/NgrokAPI/PagedIterator.html +3 -3
  99. data/doc/NgrokAPI/Services/APIKeysClient.html +4 -4
  100. data/doc/NgrokAPI/Services/AbuseReportsClient.html +4 -4
  101. data/doc/NgrokAPI/Services/AgentIngressesClient.html +3 -3
  102. data/doc/NgrokAPI/Services/ApplicationSessionsClient.html +3 -3
  103. data/doc/NgrokAPI/Services/ApplicationUsersClient.html +3 -3
  104. data/doc/NgrokAPI/Services/BotUsersClient.html +1717 -0
  105. data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +3 -3
  106. data/doc/NgrokAPI/Services/CredentialsClient.html +9 -9
  107. data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +3 -3
  108. data/doc/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +3 -3
  109. data/doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +3 -3
  110. data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +3 -3
  111. data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +3 -3
  112. data/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +3 -3
  113. data/doc/NgrokAPI/Services/EdgeRoutePolicyModuleClient.html +1149 -0
  114. data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +3 -3
  115. data/doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +3 -3
  116. data/doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +3 -3
  117. data/doc/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html +1149 -0
  118. data/doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +3 -3
  119. data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +3 -3
  120. data/doc/NgrokAPI/Services/EdgesHTTPSClient.html +3 -3
  121. data/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +233 -93
  122. data/doc/NgrokAPI/Services/EdgesTCPClient.html +159 -79
  123. data/doc/NgrokAPI/Services/EdgesTLSClient.html +159 -79
  124. data/doc/NgrokAPI/Services/EndpointsClient.html +3 -3
  125. data/doc/NgrokAPI/Services/EventDestinationsClient.html +3 -3
  126. data/doc/NgrokAPI/Services/EventSourcesClient.html +3 -3
  127. data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +7 -7
  128. data/doc/NgrokAPI/Services/FailoverBackendsClient.html +3 -3
  129. data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +3 -3
  130. data/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +3 -3
  131. data/doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +3 -3
  132. data/doc/NgrokAPI/Services/IPPoliciesClient.html +3 -3
  133. data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +3 -3
  134. data/doc/NgrokAPI/Services/IPRestrictionsClient.html +3 -3
  135. data/doc/NgrokAPI/Services/ReservedAddrsClient.html +3 -3
  136. data/doc/NgrokAPI/Services/ReservedDomainsClient.html +6 -6
  137. data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +3 -3
  138. data/doc/NgrokAPI/Services/SSHCredentialsClient.html +5 -5
  139. data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +3 -3
  140. data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +7 -7
  141. data/doc/NgrokAPI/Services/StaticBackendsClient.html +1879 -0
  142. data/doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +3 -3
  143. data/doc/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +3 -3
  144. data/doc/NgrokAPI/Services/TCPEdgePolicyModuleClient.html +1039 -0
  145. data/doc/NgrokAPI/Services/TLSCertificatesClient.html +7 -7
  146. data/doc/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +3 -3
  147. data/doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +3 -3
  148. data/doc/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +3 -3
  149. data/doc/NgrokAPI/Services/TLSEdgePolicyModuleClient.html +1039 -0
  150. data/doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +3 -3
  151. data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +3 -3
  152. data/doc/NgrokAPI/Services/TunnelSessionsClient.html +5 -5
  153. data/doc/NgrokAPI/Services/TunnelsClient.html +3 -3
  154. data/doc/NgrokAPI/Services/WeightedBackendsClient.html +4 -4
  155. data/doc/NgrokAPI/Services.html +5 -5
  156. data/doc/NgrokAPI.html +4 -4
  157. data/doc/_index.html +95 -4
  158. data/doc/class_list.html +1 -1
  159. data/doc/file.README.html +3 -3
  160. data/doc/frames.html +10 -5
  161. data/doc/index.html +3 -3
  162. data/doc/method_list.html +1778 -818
  163. data/doc/top-level-namespace.html +3 -3
  164. data/docs/NgrokAPI/Client.html +152 -96
  165. data/docs/NgrokAPI/Error.html +3 -3
  166. data/docs/NgrokAPI/Errors/NotFoundError.html +3 -3
  167. data/docs/NgrokAPI/Errors.html +3 -3
  168. data/docs/NgrokAPI/HttpClient.html +4 -4
  169. data/docs/NgrokAPI/Models/APIKey.html +3 -3
  170. data/docs/NgrokAPI/Models/AWSAuth.html +3 -3
  171. data/docs/NgrokAPI/Models/AWSCredentials.html +3 -3
  172. data/docs/NgrokAPI/Models/AWSRole.html +3 -3
  173. data/docs/NgrokAPI/Models/AbuseReport.html +3 -3
  174. data/docs/NgrokAPI/Models/AbuseReportHostname.html +3 -3
  175. data/docs/NgrokAPI/Models/AgentIngress.html +3 -3
  176. data/docs/NgrokAPI/Models/AgentIngressCertJob.html +3 -3
  177. data/docs/NgrokAPI/Models/AgentIngressCertPolicy.html +3 -3
  178. data/docs/NgrokAPI/Models/AgentIngressCertStatus.html +3 -3
  179. data/docs/NgrokAPI/Models/ApplicationSession.html +3 -3
  180. data/docs/NgrokAPI/Models/ApplicationUser.html +3 -3
  181. data/docs/NgrokAPI/Models/BotUser.html +1051 -0
  182. data/docs/NgrokAPI/Models/BrowserSession.html +3 -3
  183. data/docs/NgrokAPI/Models/CertificateAuthority.html +3 -3
  184. data/docs/NgrokAPI/Models/Credential.html +3 -3
  185. data/docs/NgrokAPI/Models/Endpoint.html +3 -3
  186. data/docs/NgrokAPI/Models/EndpointAction.html +669 -0
  187. data/docs/NgrokAPI/Models/EndpointBackend.html +3 -3
  188. data/docs/NgrokAPI/Models/EndpointBackendMutate.html +3 -3
  189. data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +3 -3
  190. data/docs/NgrokAPI/Models/EndpointCompression.html +3 -3
  191. data/docs/NgrokAPI/Models/EndpointIPPolicy.html +3 -3
  192. data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +3 -3
  193. data/docs/NgrokAPI/Models/EndpointMutualTLS.html +3 -3
  194. data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +3 -3
  195. data/docs/NgrokAPI/Models/EndpointOAuth.html +3 -3
  196. data/docs/NgrokAPI/Models/EndpointOAuthAmazon.html +3 -3
  197. data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +3 -3
  198. data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +3 -3
  199. data/docs/NgrokAPI/Models/EndpointOAuthGitLab.html +3 -3
  200. data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +3 -3
  201. data/docs/NgrokAPI/Models/EndpointOAuthLinkedIn.html +3 -3
  202. data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +3 -3
  203. data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +3 -3
  204. data/docs/NgrokAPI/Models/EndpointOAuthTwitch.html +3 -3
  205. data/docs/NgrokAPI/Models/EndpointOIDC.html +3 -3
  206. data/docs/NgrokAPI/Models/EndpointPolicy.html +743 -0
  207. data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +3 -3
  208. data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +3 -3
  209. data/docs/NgrokAPI/Models/EndpointRule.html +743 -0
  210. data/docs/NgrokAPI/Models/EndpointSAML.html +18 -96
  211. data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +18 -96
  212. data/docs/NgrokAPI/Models/EndpointTLSTermination.html +3 -3
  213. data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +3 -3
  214. data/docs/NgrokAPI/Models/EndpointUserAgentFilter.html +743 -0
  215. data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +3 -3
  216. data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +3 -3
  217. data/docs/NgrokAPI/Models/EventDestination.html +3 -3
  218. data/docs/NgrokAPI/Models/EventSource.html +19 -167
  219. data/docs/NgrokAPI/Models/EventSourceList.html +3 -3
  220. data/docs/NgrokAPI/Models/EventSourceReplace.html +19 -167
  221. data/docs/NgrokAPI/Models/EventSubscription.html +3 -3
  222. data/docs/NgrokAPI/Models/EventTarget.html +18 -92
  223. data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +3 -3
  224. data/docs/NgrokAPI/Models/EventTargetDatadog.html +3 -3
  225. data/docs/NgrokAPI/Models/EventTargetFirehose.html +3 -3
  226. data/docs/NgrokAPI/Models/EventTargetKinesis.html +3 -3
  227. data/docs/NgrokAPI/Models/FailoverBackend.html +3 -3
  228. data/docs/NgrokAPI/Models/HTTPResponseBackend.html +3 -3
  229. data/docs/NgrokAPI/Models/HTTPSEdge.html +3 -3
  230. data/docs/NgrokAPI/Models/HTTPSEdgeRoute.html +197 -37
  231. data/docs/NgrokAPI/Models/IPPolicy.html +27 -101
  232. data/docs/NgrokAPI/Models/IPPolicyRule.html +3 -3
  233. data/docs/NgrokAPI/Models/IPRestriction.html +3 -3
  234. data/docs/NgrokAPI/Models/IdentityProvider.html +3 -3
  235. data/docs/NgrokAPI/Models/Listable.html +3 -3
  236. data/docs/NgrokAPI/Models/Location.html +3 -3
  237. data/docs/NgrokAPI/Models/Ref.html +3 -3
  238. data/docs/NgrokAPI/Models/ReservedAddr.html +22 -96
  239. data/docs/NgrokAPI/Models/ReservedDomain.html +25 -173
  240. data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +3 -3
  241. data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +3 -3
  242. data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +3 -3
  243. data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +3 -3
  244. data/docs/NgrokAPI/Models/SSHCredential.html +3 -3
  245. data/docs/NgrokAPI/Models/SSHHostCertificate.html +3 -3
  246. data/docs/NgrokAPI/Models/SSHUserCertificate.html +3 -3
  247. data/docs/NgrokAPI/Models/StaticBackend.html +1211 -0
  248. data/docs/NgrokAPI/Models/StaticBackendTLS.html +595 -0
  249. data/docs/NgrokAPI/Models/TCPEdge.html +112 -32
  250. data/docs/NgrokAPI/Models/TLSCertificate.html +3 -3
  251. data/docs/NgrokAPI/Models/TLSCertificateSANs.html +3 -3
  252. data/docs/NgrokAPI/Models/TLSEdge.html +112 -32
  253. data/docs/NgrokAPI/Models/Tunnel.html +3 -3
  254. data/docs/NgrokAPI/Models/TunnelGroupBackend.html +3 -3
  255. data/docs/NgrokAPI/Models/TunnelSession.html +3 -3
  256. data/docs/NgrokAPI/Models/UserAgent.html +3 -3
  257. data/docs/NgrokAPI/Models/WeightedBackend.html +3 -3
  258. data/docs/NgrokAPI/Models.html +5 -5
  259. data/docs/NgrokAPI/PagedIterator.html +3 -3
  260. data/docs/NgrokAPI/Services/APIKeysClient.html +4 -4
  261. data/docs/NgrokAPI/Services/AbuseReportsClient.html +4 -4
  262. data/docs/NgrokAPI/Services/AgentIngressesClient.html +3 -3
  263. data/docs/NgrokAPI/Services/ApplicationSessionsClient.html +3 -3
  264. data/docs/NgrokAPI/Services/ApplicationUsersClient.html +3 -3
  265. data/docs/NgrokAPI/Services/BotUsersClient.html +1717 -0
  266. data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +3 -3
  267. data/docs/NgrokAPI/Services/CredentialsClient.html +9 -9
  268. data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +3 -3
  269. data/docs/NgrokAPI/Services/EdgeRouteCircuitBreakerModuleClient.html +3 -3
  270. data/docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html +3 -3
  271. data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +3 -3
  272. data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +3 -3
  273. data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +3 -3
  274. data/docs/NgrokAPI/Services/EdgeRoutePolicyModuleClient.html +1149 -0
  275. data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +3 -3
  276. data/docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html +3 -3
  277. data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +3 -3
  278. data/docs/NgrokAPI/Services/EdgeRouteUserAgentFilterModuleClient.html +1149 -0
  279. data/docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html +3 -3
  280. data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +3 -3
  281. data/docs/NgrokAPI/Services/EdgesHTTPSClient.html +3 -3
  282. data/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +233 -93
  283. data/docs/NgrokAPI/Services/EdgesTCPClient.html +159 -79
  284. data/docs/NgrokAPI/Services/EdgesTLSClient.html +159 -79
  285. data/docs/NgrokAPI/Services/EndpointsClient.html +3 -3
  286. data/docs/NgrokAPI/Services/EventDestinationsClient.html +3 -3
  287. data/docs/NgrokAPI/Services/EventSourcesClient.html +3 -3
  288. data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +7 -7
  289. data/docs/NgrokAPI/Services/FailoverBackendsClient.html +3 -3
  290. data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +3 -3
  291. data/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +3 -3
  292. data/docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html +3 -3
  293. data/docs/NgrokAPI/Services/IPPoliciesClient.html +3 -3
  294. data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +3 -3
  295. data/docs/NgrokAPI/Services/IPRestrictionsClient.html +3 -3
  296. data/docs/NgrokAPI/Services/ReservedAddrsClient.html +3 -3
  297. data/docs/NgrokAPI/Services/ReservedDomainsClient.html +6 -6
  298. data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +3 -3
  299. data/docs/NgrokAPI/Services/SSHCredentialsClient.html +5 -5
  300. data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +3 -3
  301. data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +7 -7
  302. data/docs/NgrokAPI/Services/StaticBackendsClient.html +1879 -0
  303. data/docs/NgrokAPI/Services/TCPEdgeBackendModuleClient.html +3 -3
  304. data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +3 -3
  305. data/docs/NgrokAPI/Services/TCPEdgePolicyModuleClient.html +1039 -0
  306. data/docs/NgrokAPI/Services/TLSCertificatesClient.html +7 -7
  307. data/docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html +3 -3
  308. data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +3 -3
  309. data/docs/NgrokAPI/Services/TLSEdgeMutualTLSModuleClient.html +3 -3
  310. data/docs/NgrokAPI/Services/TLSEdgePolicyModuleClient.html +1039 -0
  311. data/docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html +3 -3
  312. data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +3 -3
  313. data/docs/NgrokAPI/Services/TunnelSessionsClient.html +5 -5
  314. data/docs/NgrokAPI/Services/TunnelsClient.html +3 -3
  315. data/docs/NgrokAPI/Services/WeightedBackendsClient.html +4 -4
  316. data/docs/NgrokAPI/Services.html +5 -5
  317. data/docs/NgrokAPI.html +4 -4
  318. data/docs/_index.html +95 -4
  319. data/docs/class_list.html +1 -1
  320. data/docs/file.README.html +3 -3
  321. data/docs/frames.html +10 -5
  322. data/docs/index.html +3 -3
  323. data/docs/method_list.html +1778 -818
  324. data/docs/top-level-namespace.html +3 -3
  325. data/lib/ngrokapi/client.rb +6 -0
  326. data/lib/ngrokapi/models/bot_user.rb +70 -0
  327. data/lib/ngrokapi/models/endpoint_action.rb +33 -0
  328. data/lib/ngrokapi/models/endpoint_policy.rb +35 -0
  329. data/lib/ngrokapi/models/endpoint_rule.rb +35 -0
  330. data/lib/ngrokapi/models/endpoint_saml.rb +0 -4
  331. data/lib/ngrokapi/models/endpoint_saml_mutate.rb +0 -4
  332. data/lib/ngrokapi/models/endpoint_user_agent_filter.rb +35 -0
  333. data/lib/ngrokapi/models/event_source.rb +0 -4
  334. data/lib/ngrokapi/models/event_source_replace.rb +1 -5
  335. data/lib/ngrokapi/models/event_target.rb +0 -2
  336. data/lib/ngrokapi/models/https_edge_route.rb +13 -3
  337. data/lib/ngrokapi/models/ip_policy.rb +1 -3
  338. data/lib/ngrokapi/models/reserved_addr.rb +1 -3
  339. data/lib/ngrokapi/models/reserved_domain.rb +0 -4
  340. data/lib/ngrokapi/models/static_backend.rb +80 -0
  341. data/lib/ngrokapi/models/static_backend_tls.rb +31 -0
  342. data/lib/ngrokapi/models/tcp_edge.rb +8 -3
  343. data/lib/ngrokapi/models/tls_edge.rb +8 -3
  344. data/lib/ngrokapi/services/bot_users_client.rb +223 -0
  345. data/lib/ngrokapi/services/credentials_client.rb +2 -2
  346. data/lib/ngrokapi/services/edge_route_policy_module_client.rb +120 -0
  347. data/lib/ngrokapi/services/edge_route_user_agent_filter_module_client.rb +120 -0
  348. data/lib/ngrokapi/services/edges_https_routes_client.rb +20 -4
  349. data/lib/ngrokapi/services/edges_tcp_client.rb +12 -4
  350. data/lib/ngrokapi/services/edges_tls_client.rb +12 -4
  351. data/lib/ngrokapi/services/reserved_domains_client.rb +2 -2
  352. data/lib/ngrokapi/services/static_backends_client.rb +242 -0
  353. data/lib/ngrokapi/services/tcp_edge_policy_module_client.rb +108 -0
  354. data/lib/ngrokapi/services/tls_edge_policy_module_client.rb +108 -0
  355. data/lib/ngrokapi/version.rb +1 -1
  356. data/spec/ngrokapi/client_spec.rb +8 -0
  357. data/spec/ngrokapi/models/bot_user_spec.rb +44 -0
  358. data/spec/ngrokapi/models/endpoint_action_spec.rb +23 -0
  359. data/spec/ngrokapi/models/endpoint_policy_spec.rb +23 -0
  360. data/spec/ngrokapi/models/endpoint_rule_spec.rb +23 -0
  361. data/spec/ngrokapi/models/endpoint_user_agent_filter_spec.rb +23 -0
  362. data/spec/ngrokapi/models/https_edge_route_spec.rb +7 -1
  363. data/spec/ngrokapi/models/static_backend_spec.rb +50 -0
  364. data/spec/ngrokapi/models/static_backend_tls_spec.rb +23 -0
  365. data/spec/ngrokapi/models/tcp_edge_spec.rb +4 -1
  366. data/spec/ngrokapi/models/tls_edge_spec.rb +4 -1
  367. data/spec/ngrokapi/services/bot_users_client_spec.rb +178 -0
  368. data/spec/ngrokapi/services/credentials_client_spec.rb +4 -2
  369. data/spec/ngrokapi/services/edge_route_policy_module_client_spec.rb +139 -0
  370. data/spec/ngrokapi/services/edge_route_user_agent_filter_module_client_spec.rb +139 -0
  371. data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +20 -4
  372. data/spec/ngrokapi/services/edges_tcp_client_spec.rb +12 -4
  373. data/spec/ngrokapi/services/edges_tls_client_spec.rb +12 -4
  374. data/spec/ngrokapi/services/static_backends_client_spec.rb +194 -0
  375. data/spec/ngrokapi/services/tcp_edge_policy_module_client_spec.rb +125 -0
  376. data/spec/ngrokapi/services/tls_edge_policy_module_client_spec.rb +125 -0
  377. data/spec/spec_helper.rb +64 -0
  378. metadata +54 -2
@@ -28,10 +28,11 @@ module NgrokAPI
28
28
  # @param [EndpointIPPolicyMutate] ip_restriction
29
29
  # @param [EndpointMutualTLSMutate] mutual_tls
30
30
  # @param [EndpointTLSTermination] tls_termination
31
+ # @param [EndpointPolicy] policy the traffic policy associated with this edge or null
31
32
  # @return [NgrokAPI::Models::TLSEdge] result from the API request
32
33
  #
33
34
  # https://ngrok.com/docs/api#api-edges-tls-create
34
- def create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil)
35
+ def create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil)
35
36
  path = '/edges/tls'
36
37
  replacements = {
37
38
  }
@@ -43,6 +44,7 @@ module NgrokAPI
43
44
  data[:ip_restriction] = ip_restriction if ip_restriction
44
45
  data[:mutual_tls] = mutual_tls if mutual_tls
45
46
  data[:tls_termination] = tls_termination if tls_termination
47
+ data[:policy] = policy if policy
46
48
  result = @client.post(path % replacements, data: data)
47
49
  NgrokAPI::Models::TLSEdge.new(client: self, attrs: result)
48
50
  end
@@ -58,10 +60,11 @@ module NgrokAPI
58
60
  # @param [EndpointIPPolicyMutate] ip_restriction
59
61
  # @param [EndpointMutualTLSMutate] mutual_tls
60
62
  # @param [EndpointTLSTermination] tls_termination
63
+ # @param [EndpointPolicy] policy the traffic policy associated with this edge or null
61
64
  # @return [NgrokAPI::Models::TLSEdge] result from the API request
62
65
  #
63
66
  # https://ngrok.com/docs/api#api-edges-tls-create
64
- def create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil)
67
+ def create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil)
65
68
  path = '/edges/tls'
66
69
  replacements = {
67
70
  }
@@ -73,6 +76,7 @@ module NgrokAPI
73
76
  data[:ip_restriction] = ip_restriction if ip_restriction
74
77
  data[:mutual_tls] = mutual_tls if mutual_tls
75
78
  data[:tls_termination] = tls_termination if tls_termination
79
+ data[:policy] = policy if policy
76
80
  result = @client.post(path % replacements, data: data, danger: true)
77
81
  NgrokAPI::Models::TLSEdge.new(client: self, attrs: result)
78
82
  end
@@ -179,10 +183,11 @@ module NgrokAPI
179
183
  # @param [EndpointIPPolicyMutate] ip_restriction
180
184
  # @param [EndpointMutualTLSMutate] mutual_tls
181
185
  # @param [EndpointTLSTermination] tls_termination
186
+ # @param [EndpointPolicy] policy the traffic policy associated with this edge or null
182
187
  # @return [NgrokAPI::Models::TLSEdge] result from the API request
183
188
  #
184
189
  # https://ngrok.com/docs/api#api-edges-tls-update
185
- def update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil)
190
+ def update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil)
186
191
  path = '/edges/tls/%{id}'
187
192
  replacements = {
188
193
  id: id,
@@ -195,6 +200,7 @@ module NgrokAPI
195
200
  data[:ip_restriction] = ip_restriction if ip_restriction
196
201
  data[:mutual_tls] = mutual_tls if mutual_tls
197
202
  data[:tls_termination] = tls_termination if tls_termination
203
+ data[:policy] = policy if policy
198
204
  result = @client.patch(path % replacements, data: data)
199
205
  NgrokAPI::Models::TLSEdge.new(client: self, attrs: result)
200
206
  end
@@ -214,10 +220,11 @@ module NgrokAPI
214
220
  # @param [EndpointIPPolicyMutate] ip_restriction
215
221
  # @param [EndpointMutualTLSMutate] mutual_tls
216
222
  # @param [EndpointTLSTermination] tls_termination
223
+ # @param [EndpointPolicy] policy the traffic policy associated with this edge or null
217
224
  # @return [NgrokAPI::Models::TLSEdge] result from the API request
218
225
  #
219
226
  # https://ngrok.com/docs/api#api-edges-tls-update
220
- def update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil)
227
+ def update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, mutual_tls: nil, tls_termination: nil, policy: nil)
221
228
  path = '/edges/tls/%{id}'
222
229
  replacements = {
223
230
  id: id,
@@ -230,6 +237,7 @@ module NgrokAPI
230
237
  data[:ip_restriction] = ip_restriction if ip_restriction
231
238
  data[:mutual_tls] = mutual_tls if mutual_tls
232
239
  data[:tls_termination] = tls_termination if tls_termination
240
+ data[:policy] = policy if policy
233
241
  result = @client.patch(path % replacements, data: data, danger: true)
234
242
  NgrokAPI::Models::TLSEdge.new(client: self, attrs: result)
235
243
  end
@@ -27,7 +27,7 @@ module NgrokAPI
27
27
  # Create a new reserved domain.
28
28
  #
29
29
  # @param [string] domain hostname of the reserved domain
30
- # @param [string] region reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
30
+ # @param [string] region deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa)
31
31
  # @param [string] description human-readable description of what this reserved domain will be used for
32
32
  # @param [string] metadata arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
33
33
  # @param [string] certificate_id ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with ``certificate_management_policy``.
@@ -55,7 +55,7 @@ module NgrokAPI
55
55
  # Throws an exception if API error.
56
56
  #
57
57
  # @param [string] domain hostname of the reserved domain
58
- # @param [string] region reserve the domain in this geographic ngrok datacenter. Optional, default is us. (au, eu, ap, us, jp, in, sa)
58
+ # @param [string] region deprecated: With the launch of the ngrok Global Network domains traffic is now handled globally. This field applied only to endpoints. Note that agents may still connect to specific regions. Optional, null by default. (au, eu, ap, us, jp, in, sa)
59
59
  # @param [string] description human-readable description of what this reserved domain will be used for
60
60
  # @param [string] metadata arbitrary user-defined machine-readable data of this reserved domain. Optional, max 4096 bytes.
61
61
  # @param [string] certificate_id ID of a user-uploaded TLS certificate to use for connections to targeting this domain. Optional, mutually exclusive with ``certificate_management_policy``.
@@ -0,0 +1,242 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
5
+ module NgrokAPI
6
+ module Services
7
+ ##
8
+ # A static backend sends traffic to a TCP address (hostname and port) that
9
+ # is reachable on the public internet.
10
+ #
11
+ # https://ngrok.com/docs/api#api-static-backends
12
+ class StaticBackendsClient
13
+ # The API path for the requests
14
+ PATH = '/backends/static'
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 static 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 [string] address the address to forward to
30
+ # @param [StaticBackendTLS] tls tls configuration to use
31
+ # @return [NgrokAPI::Models::StaticBackend] result from the API request
32
+ #
33
+ # https://ngrok.com/docs/api#api-static-backends-create
34
+ def create(description: "", metadata: "", address: "", tls: nil)
35
+ path = '/backends/static'
36
+ replacements = {
37
+ }
38
+ data = {}
39
+ data[:description] = description if description
40
+ data[:metadata] = metadata if metadata
41
+ data[:address] = address if address
42
+ data[:tls] = tls if tls
43
+ result = @client.post(path % replacements, data: data)
44
+ NgrokAPI::Models::StaticBackend.new(client: self, attrs: result)
45
+ end
46
+
47
+ ##
48
+ # Create a new static backend
49
+ # Throws an exception if API error.
50
+ #
51
+ # @param [string] description human-readable description of this backend. Optional
52
+ # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
53
+ # @param [string] address the address to forward to
54
+ # @param [StaticBackendTLS] tls tls configuration to use
55
+ # @return [NgrokAPI::Models::StaticBackend] result from the API request
56
+ #
57
+ # https://ngrok.com/docs/api#api-static-backends-create
58
+ def create!(description: "", metadata: "", address: "", tls: nil)
59
+ path = '/backends/static'
60
+ replacements = {
61
+ }
62
+ data = {}
63
+ data[:description] = description if description
64
+ data[:metadata] = metadata if metadata
65
+ data[:address] = address if address
66
+ data[:tls] = tls if tls
67
+ result = @client.post(path % replacements, data: data, danger: true)
68
+ NgrokAPI::Models::StaticBackend.new(client: self, attrs: result)
69
+ end
70
+
71
+ ##
72
+ # Delete a static backend by ID.
73
+ #
74
+ # @param [string] id a resource identifier
75
+ # @return [NgrokAPI::Models::Empty] result from the API request
76
+ #
77
+ # https://ngrok.com/docs/api#api-static-backends-delete
78
+ def delete(id: "")
79
+ path = '/backends/static/%{id}'
80
+ replacements = {
81
+ id: id,
82
+ }
83
+ @client.delete(path % replacements)
84
+ end
85
+
86
+ ##
87
+ # Delete a static backend by ID.
88
+ # Throws an exception if API error.
89
+ #
90
+ # @param [string] id a resource identifier
91
+ # @return [NgrokAPI::Models::Empty] result from the API request
92
+ #
93
+ # https://ngrok.com/docs/api#api-static-backends-delete
94
+ def delete!(id: "")
95
+ path = '/backends/static/%{id}'
96
+ replacements = {
97
+ id: id,
98
+ }
99
+ @client.delete(path % replacements, danger: true)
100
+ end
101
+
102
+ ##
103
+ # Get detailed information about a static backend by ID
104
+ #
105
+ # @param [string] id a resource identifier
106
+ # @return [NgrokAPI::Models::StaticBackend] result from the API request
107
+ #
108
+ # https://ngrok.com/docs/api#api-static-backends-get
109
+ def get(id: "")
110
+ path = '/backends/static/%{id}'
111
+ replacements = {
112
+ id: id,
113
+ }
114
+ data = {}
115
+ result = @client.get(path % replacements, data: data)
116
+ NgrokAPI::Models::StaticBackend.new(client: self, attrs: result)
117
+ end
118
+
119
+ ##
120
+ # Get detailed information about a static backend by ID
121
+ # Throws an exception if API error.
122
+ #
123
+ # @param [string] id a resource identifier
124
+ # @return [NgrokAPI::Models::StaticBackend] result from the API request
125
+ #
126
+ # https://ngrok.com/docs/api#api-static-backends-get
127
+ def get!(id: "")
128
+ path = '/backends/static/%{id}'
129
+ replacements = {
130
+ id: id,
131
+ }
132
+ data = {}
133
+ result = @client.get(path % replacements, data: data, danger: true)
134
+ NgrokAPI::Models::StaticBackend.new(client: self, attrs: result)
135
+ end
136
+
137
+ ##
138
+ # List all static backends on this account
139
+ #
140
+ # @param [string] before_id
141
+ # @param [string] limit
142
+ # @param [string] url optional and mutually exclusive from before_id and limit
143
+ # @return [NgrokAPI::Models::Listable] result from the API request
144
+ #
145
+ # https://ngrok.com/docs/api#api-static-backends-list
146
+ def list(before_id: nil, limit: nil, url: nil)
147
+ result = @client.list(
148
+ before_id: before_id,
149
+ limit: limit,
150
+ url: url,
151
+ path: PATH
152
+ )
153
+
154
+ NgrokAPI::Models::Listable.new(
155
+ client: self,
156
+ attrs: result,
157
+ list_property: LIST_PROPERTY,
158
+ klass: NgrokAPI::Models::StaticBackend
159
+ )
160
+ end
161
+
162
+ ##
163
+ # List all static backends on this account
164
+ # Throws an exception if API error.
165
+ #
166
+ # @param [string] before_id
167
+ # @param [string] limit
168
+ # @param [string] url optional and mutually exclusive from before_id and limit
169
+ # @return [NgrokAPI::Models::Listable] result from the API request
170
+ #
171
+ # https://ngrok.com/docs/api#api-static-backends-list
172
+ def list!(before_id: nil, limit: nil, url: nil)
173
+ result = @client.list(
174
+ before_id: before_id,
175
+ limit: limit,
176
+ danger: true,
177
+ url: url,
178
+ path: PATH
179
+ )
180
+
181
+ NgrokAPI::Models::Listable.new(
182
+ client: self,
183
+ attrs: result,
184
+ list_property: LIST_PROPERTY,
185
+ klass: NgrokAPI::Models::StaticBackend,
186
+ danger: true
187
+ )
188
+ end
189
+
190
+ ##
191
+ # Update static backend by ID
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 [string] address the address to forward to
197
+ # @param [StaticBackendTLS] tls tls configuration to use
198
+ # @return [NgrokAPI::Models::StaticBackend] result from the API request
199
+ #
200
+ # https://ngrok.com/docs/api#api-static-backends-update
201
+ def update(id: "", description: nil, metadata: nil, address: "", tls: nil)
202
+ path = '/backends/static/%{id}'
203
+ replacements = {
204
+ id: id,
205
+ }
206
+ data = {}
207
+ data[:description] = description if description
208
+ data[:metadata] = metadata if metadata
209
+ data[:address] = address if address
210
+ data[:tls] = tls if tls
211
+ result = @client.patch(path % replacements, data: data)
212
+ NgrokAPI::Models::StaticBackend.new(client: self, attrs: result)
213
+ end
214
+
215
+ ##
216
+ # Update static backend by ID
217
+ # Throws an exception if API error.
218
+ #
219
+ # @param [string] id
220
+ # @param [string] description human-readable description of this backend. Optional
221
+ # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
222
+ # @param [string] address the address to forward to
223
+ # @param [StaticBackendTLS] tls tls configuration to use
224
+ # @return [NgrokAPI::Models::StaticBackend] result from the API request
225
+ #
226
+ # https://ngrok.com/docs/api#api-static-backends-update
227
+ def update!(id: "", description: nil, metadata: nil, address: "", tls: nil)
228
+ path = '/backends/static/%{id}'
229
+ replacements = {
230
+ id: id,
231
+ }
232
+ data = {}
233
+ data[:description] = description if description
234
+ data[:metadata] = metadata if metadata
235
+ data[:address] = address if address
236
+ data[:tls] = tls if tls
237
+ result = @client.patch(path % replacements, data: data, danger: true)
238
+ NgrokAPI::Models::StaticBackend.new(client: self, attrs: result)
239
+ end
240
+ end
241
+ end
242
+ end
@@ -0,0 +1,108 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
5
+ module NgrokAPI
6
+ module Services
7
+ ##
8
+ # https://ngrok.com/docs/api#api-tcp-edge-policy-module
9
+ class TCPEdgePolicyModuleClient
10
+ # The API path for the requests
11
+ PATH = '/edges/tcp/%{id}/policy'
12
+
13
+ attr_reader :client
14
+
15
+ def initialize(client:)
16
+ @client = client
17
+ end
18
+
19
+ ##
20
+ # @param [string] id
21
+ # @param [EndpointPolicy] a_module
22
+ # @return [NgrokAPI::Models::EndpointPolicy] result from the API request
23
+ #
24
+ # https://ngrok.com/docs/api#api-tcp-edge-policy-module-replace
25
+ def replace(id: "", a_module: nil)
26
+ path = '/edges/tcp/%{id}/policy'
27
+ replacements = {
28
+ id: id,
29
+ }
30
+ data = a_module
31
+ result = @client.put(path % replacements, data: data)
32
+ NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
33
+ end
34
+
35
+ ##
36
+ # @param [string] id
37
+ # @param [EndpointPolicy] a_module
38
+ # @return [NgrokAPI::Models::EndpointPolicy] result from the API request
39
+ #
40
+ # https://ngrok.com/docs/api#api-tcp-edge-policy-module-replace
41
+ def replace!(id: "", a_module: nil)
42
+ path = '/edges/tcp/%{id}/policy'
43
+ replacements = {
44
+ id: id,
45
+ }
46
+ data = a_module
47
+ result = @client.put(path % replacements, data: data, danger: true)
48
+ NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
49
+ end
50
+
51
+ ##
52
+ # @param [string] id a resource identifier
53
+ # @return [NgrokAPI::Models::EndpointPolicy] result from the API request
54
+ #
55
+ # https://ngrok.com/docs/api#api-tcp-edge-policy-module-get
56
+ def get(id: "")
57
+ path = '/edges/tcp/%{id}/policy'
58
+ replacements = {
59
+ id: id,
60
+ }
61
+ data = {}
62
+ result = @client.get(path % replacements, data: data)
63
+ NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
64
+ end
65
+
66
+ ##
67
+ # @param [string] id a resource identifier
68
+ # @return [NgrokAPI::Models::EndpointPolicy] result from the API request
69
+ #
70
+ # https://ngrok.com/docs/api#api-tcp-edge-policy-module-get
71
+ def get!(id: "")
72
+ path = '/edges/tcp/%{id}/policy'
73
+ replacements = {
74
+ id: id,
75
+ }
76
+ data = {}
77
+ result = @client.get(path % replacements, data: data, danger: true)
78
+ NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
79
+ end
80
+
81
+ ##
82
+ # @param [string] id a resource identifier
83
+ # @return [NgrokAPI::Models::Empty] result from the API request
84
+ #
85
+ # https://ngrok.com/docs/api#api-tcp-edge-policy-module-delete
86
+ def delete(id: "")
87
+ path = '/edges/tcp/%{id}/policy'
88
+ replacements = {
89
+ id: id,
90
+ }
91
+ @client.delete(path % replacements)
92
+ end
93
+
94
+ ##
95
+ # @param [string] id a resource identifier
96
+ # @return [NgrokAPI::Models::Empty] result from the API request
97
+ #
98
+ # https://ngrok.com/docs/api#api-tcp-edge-policy-module-delete
99
+ def delete!(id: "")
100
+ path = '/edges/tcp/%{id}/policy'
101
+ replacements = {
102
+ id: id,
103
+ }
104
+ @client.delete(path % replacements, danger: true)
105
+ end
106
+ end
107
+ end
108
+ end
@@ -0,0 +1,108 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Code generated for API Clients. DO NOT EDIT.
4
+
5
+ module NgrokAPI
6
+ module Services
7
+ ##
8
+ # https://ngrok.com/docs/api#api-tls-edge-policy-module
9
+ class TLSEdgePolicyModuleClient
10
+ # The API path for the requests
11
+ PATH = '/edges/tls/%{id}/policy'
12
+
13
+ attr_reader :client
14
+
15
+ def initialize(client:)
16
+ @client = client
17
+ end
18
+
19
+ ##
20
+ # @param [string] id
21
+ # @param [EndpointPolicy] a_module
22
+ # @return [NgrokAPI::Models::EndpointPolicy] result from the API request
23
+ #
24
+ # https://ngrok.com/docs/api#api-tls-edge-policy-module-replace
25
+ def replace(id: "", a_module: nil)
26
+ path = '/edges/tls/%{id}/policy'
27
+ replacements = {
28
+ id: id,
29
+ }
30
+ data = a_module
31
+ result = @client.put(path % replacements, data: data)
32
+ NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
33
+ end
34
+
35
+ ##
36
+ # @param [string] id
37
+ # @param [EndpointPolicy] a_module
38
+ # @return [NgrokAPI::Models::EndpointPolicy] result from the API request
39
+ #
40
+ # https://ngrok.com/docs/api#api-tls-edge-policy-module-replace
41
+ def replace!(id: "", a_module: nil)
42
+ path = '/edges/tls/%{id}/policy'
43
+ replacements = {
44
+ id: id,
45
+ }
46
+ data = a_module
47
+ result = @client.put(path % replacements, data: data, danger: true)
48
+ NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
49
+ end
50
+
51
+ ##
52
+ # @param [string] id a resource identifier
53
+ # @return [NgrokAPI::Models::EndpointPolicy] result from the API request
54
+ #
55
+ # https://ngrok.com/docs/api#api-tls-edge-policy-module-get
56
+ def get(id: "")
57
+ path = '/edges/tls/%{id}/policy'
58
+ replacements = {
59
+ id: id,
60
+ }
61
+ data = {}
62
+ result = @client.get(path % replacements, data: data)
63
+ NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
64
+ end
65
+
66
+ ##
67
+ # @param [string] id a resource identifier
68
+ # @return [NgrokAPI::Models::EndpointPolicy] result from the API request
69
+ #
70
+ # https://ngrok.com/docs/api#api-tls-edge-policy-module-get
71
+ def get!(id: "")
72
+ path = '/edges/tls/%{id}/policy'
73
+ replacements = {
74
+ id: id,
75
+ }
76
+ data = {}
77
+ result = @client.get(path % replacements, data: data, danger: true)
78
+ NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
79
+ end
80
+
81
+ ##
82
+ # @param [string] id a resource identifier
83
+ # @return [NgrokAPI::Models::Empty] result from the API request
84
+ #
85
+ # https://ngrok.com/docs/api#api-tls-edge-policy-module-delete
86
+ def delete(id: "")
87
+ path = '/edges/tls/%{id}/policy'
88
+ replacements = {
89
+ id: id,
90
+ }
91
+ @client.delete(path % replacements)
92
+ end
93
+
94
+ ##
95
+ # @param [string] id a resource identifier
96
+ # @return [NgrokAPI::Models::Empty] result from the API request
97
+ #
98
+ # https://ngrok.com/docs/api#api-tls-edge-policy-module-delete
99
+ def delete!(id: "")
100
+ path = '/edges/tls/%{id}/policy'
101
+ replacements = {
102
+ id: id,
103
+ }
104
+ @client.delete(path % replacements, danger: true)
105
+ end
106
+ end
107
+ end
108
+ end
@@ -4,6 +4,6 @@ module NgrokAPI
4
4
  # rubocop:disable Layout/SpaceAroundOperators
5
5
 
6
6
  # The current version of the gem
7
- VERSION="0.21.0".freeze
7
+ VERSION="0.22.0".freeze
8
8
  # rubocop:enable Layout/SpaceAroundOperators
9
9
  end
@@ -44,6 +44,12 @@ RSpec.describe NgrokAPI::Client do
44
44
  end
45
45
  end
46
46
 
47
+ describe "#bot_users" do
48
+ it "returns an instance of the BotUsersClient" do
49
+ expect(@client.bot_users.class).to eq(NgrokAPI::Services::BotUsersClient)
50
+ end
51
+ end
52
+
47
53
  describe "#certificate_authorities" do
48
54
  it "returns an instance of the CertificateAuthoritiesClient" do
49
55
  expect(@client.certificate_authorities.class).to eq(NgrokAPI::Services::CertificateAuthoritiesClient)
@@ -151,6 +157,7 @@ RSpec.describe NgrokAPI::Client do
151
157
  ns = @client.backends
152
158
  expect(ns.failover.class).to eq(NgrokAPI::Services::FailoverBackendsClient)
153
159
  expect(ns.http_response.class).to eq(NgrokAPI::Services::HTTPResponseBackendsClient)
160
+ expect(ns.static_address.class).to eq(NgrokAPI::Services::StaticBackendsClient)
154
161
  expect(ns.tunnel_group.class).to eq(NgrokAPI::Services::TunnelGroupBackendsClient)
155
162
  expect(ns.weighted.class).to eq(NgrokAPI::Services::WeightedBackendsClient)
156
163
  end
@@ -182,6 +189,7 @@ RSpec.describe NgrokAPI::Client do
182
189
  expect(ns.https_edge_route_saml.class).to eq(NgrokAPI::Services::EdgeRouteSAMLModuleClient)
183
190
  expect(ns.https_edge_route_oidc.class).to eq(NgrokAPI::Services::EdgeRouteOIDCModuleClient)
184
191
  expect(ns.https_edge_route_websocket_tcp_converter.class).to eq(NgrokAPI::Services::EdgeRouteWebsocketTCPConverterModuleClient)
192
+ expect(ns.https_edge_route_user_agent_filter.class).to eq(NgrokAPI::Services::EdgeRouteUserAgentFilterModuleClient)
185
193
  expect(ns.tcp_edge_backend.class).to eq(NgrokAPI::Services::TCPEdgeBackendModuleClient)
186
194
  expect(ns.tcp_edge_ip_restriction.class).to eq(NgrokAPI::Services::TCPEdgeIPRestrictionModuleClient)
187
195
  expect(ns.tls_edge_backend.class).to eq(NgrokAPI::Services::TLSEdgeBackendModuleClient)
@@ -0,0 +1,44 @@
1
+ # Code generated for API Clients. DO NOT EDIT.
2
+
3
+ require 'spec_helper'
4
+
5
+ RSpec.describe NgrokAPI::Models::BotUser do
6
+ before(:each) do
7
+ @client = class_double("BotUsersClient")
8
+ @bot_user = NgrokAPI::Models::BotUser.new(client: @client, attrs: bot_user_result)
9
+ end
10
+
11
+ describe "#==" do
12
+ it "is equal if the results are the same" do
13
+ other = NgrokAPI::Models::BotUser.new(client: @client, attrs: bot_user_result)
14
+ expect(@bot_user == other).to eq true
15
+ end
16
+ end
17
+
18
+ describe "#to_s" do
19
+ it "stringifies as result.to_s" do
20
+ expect(@bot_user.to_s).to eq bot_user_result.to_s
21
+ end
22
+ end
23
+
24
+ describe "#delete" do
25
+ it "calls delete on the client" do
26
+ expect(@bot_user.client).to receive(:delete)
27
+ @bot_user.delete
28
+ end
29
+ end
30
+
31
+ describe "#update" do
32
+ it "calls update on the client" do
33
+ new_name = 'New name'
34
+ new_active = 'New active'
35
+ expect(@bot_user.client).to receive(:update)
36
+ @bot_user.update(
37
+ name: new_name,
38
+ active: new_active
39
+ )
40
+ expect(@bot_user.name).to eq new_name
41
+ expect(@bot_user.active).to eq new_active
42
+ end
43
+ end
44
+ end
@@ -0,0 +1,23 @@
1
+ # Code generated for API Clients. DO NOT EDIT.
2
+
3
+ require 'spec_helper'
4
+
5
+ RSpec.describe NgrokAPI::Models::EndpointAction do
6
+ before(:each) do
7
+ @client = class_double("EndpointActionsClient")
8
+ @endpoint_action = NgrokAPI::Models::EndpointAction.new(client: @client, attrs: endpoint_action_result)
9
+ end
10
+
11
+ describe "#==" do
12
+ it "is equal if the results are the same" do
13
+ other = NgrokAPI::Models::EndpointAction.new(client: @client, attrs: endpoint_action_result)
14
+ expect(@endpoint_action == other).to eq true
15
+ end
16
+ end
17
+
18
+ describe "#to_s" do
19
+ it "stringifies as result.to_s" do
20
+ expect(@endpoint_action.to_s).to eq endpoint_action_result.to_s
21
+ end
22
+ end
23
+ end