ngrok-api 0.21.0 → 0.22.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
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
@@ -0,0 +1,223 @@
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-bot-users
9
+ class BotUsersClient
10
+ # The API path for the requests
11
+ PATH = '/bot_users'
12
+ # The List Property from the resulting API for list calls
13
+ LIST_PROPERTY = 'bot_users'
14
+
15
+ attr_reader :client
16
+
17
+ def initialize(client:)
18
+ @client = client
19
+ end
20
+
21
+ ##
22
+ # Create a new bot user
23
+ #
24
+ # @param [string] name human-readable name used to identify the bot
25
+ # @param [boolean] active whether or not the bot is active
26
+ # @return [NgrokAPI::Models::BotUser] result from the API request
27
+ #
28
+ # https://ngrok.com/docs/api#api-bot-users-create
29
+ def create(name: "", active: nil)
30
+ path = '/bot_users'
31
+ replacements = {
32
+ }
33
+ data = {}
34
+ data[:name] = name if name
35
+ data[:active] = active if active
36
+ result = @client.post(path % replacements, data: data)
37
+ NgrokAPI::Models::BotUser.new(client: self, attrs: result)
38
+ end
39
+
40
+ ##
41
+ # Create a new bot user
42
+ # Throws an exception if API error.
43
+ #
44
+ # @param [string] name human-readable name used to identify the bot
45
+ # @param [boolean] active whether or not the bot is active
46
+ # @return [NgrokAPI::Models::BotUser] result from the API request
47
+ #
48
+ # https://ngrok.com/docs/api#api-bot-users-create
49
+ def create!(name: "", active: nil)
50
+ path = '/bot_users'
51
+ replacements = {
52
+ }
53
+ data = {}
54
+ data[:name] = name if name
55
+ data[:active] = active if active
56
+ result = @client.post(path % replacements, data: data, danger: true)
57
+ NgrokAPI::Models::BotUser.new(client: self, attrs: result)
58
+ end
59
+
60
+ ##
61
+ # Delete a bot user by ID
62
+ #
63
+ # @param [string] id a resource identifier
64
+ # @return [NgrokAPI::Models::Empty] result from the API request
65
+ #
66
+ # https://ngrok.com/docs/api#api-bot-users-delete
67
+ def delete(id: "")
68
+ path = '/bot_users/%{id}'
69
+ replacements = {
70
+ id: id,
71
+ }
72
+ @client.delete(path % replacements)
73
+ end
74
+
75
+ ##
76
+ # Delete a bot user by ID
77
+ # Throws an exception if API error.
78
+ #
79
+ # @param [string] id a resource identifier
80
+ # @return [NgrokAPI::Models::Empty] result from the API request
81
+ #
82
+ # https://ngrok.com/docs/api#api-bot-users-delete
83
+ def delete!(id: "")
84
+ path = '/bot_users/%{id}'
85
+ replacements = {
86
+ id: id,
87
+ }
88
+ @client.delete(path % replacements, danger: true)
89
+ end
90
+
91
+ ##
92
+ # Get the details of a Bot User by ID.
93
+ #
94
+ # @param [string] id a resource identifier
95
+ # @return [NgrokAPI::Models::BotUser] result from the API request
96
+ #
97
+ # https://ngrok.com/docs/api#api-bot-users-get
98
+ def get(id: "")
99
+ path = '/bot_users/%{id}'
100
+ replacements = {
101
+ id: id,
102
+ }
103
+ data = {}
104
+ result = @client.get(path % replacements, data: data)
105
+ NgrokAPI::Models::BotUser.new(client: self, attrs: result)
106
+ end
107
+
108
+ ##
109
+ # Get the details of a Bot User by ID.
110
+ # Throws an exception if API error.
111
+ #
112
+ # @param [string] id a resource identifier
113
+ # @return [NgrokAPI::Models::BotUser] result from the API request
114
+ #
115
+ # https://ngrok.com/docs/api#api-bot-users-get
116
+ def get!(id: "")
117
+ path = '/bot_users/%{id}'
118
+ replacements = {
119
+ id: id,
120
+ }
121
+ data = {}
122
+ result = @client.get(path % replacements, data: data, danger: true)
123
+ NgrokAPI::Models::BotUser.new(client: self, attrs: result)
124
+ end
125
+
126
+ ##
127
+ # List all bot users in this account.
128
+ #
129
+ # @param [string] before_id
130
+ # @param [string] limit
131
+ # @param [string] url optional and mutually exclusive from before_id and limit
132
+ # @return [NgrokAPI::Models::Listable] result from the API request
133
+ #
134
+ # https://ngrok.com/docs/api#api-bot-users-list
135
+ def list(before_id: nil, limit: nil, url: nil)
136
+ result = @client.list(
137
+ before_id: before_id,
138
+ limit: limit,
139
+ url: url,
140
+ path: PATH
141
+ )
142
+
143
+ NgrokAPI::Models::Listable.new(
144
+ client: self,
145
+ attrs: result,
146
+ list_property: LIST_PROPERTY,
147
+ klass: NgrokAPI::Models::BotUser
148
+ )
149
+ end
150
+
151
+ ##
152
+ # List all bot users in this account.
153
+ # Throws an exception if API error.
154
+ #
155
+ # @param [string] before_id
156
+ # @param [string] limit
157
+ # @param [string] url optional and mutually exclusive from before_id and limit
158
+ # @return [NgrokAPI::Models::Listable] result from the API request
159
+ #
160
+ # https://ngrok.com/docs/api#api-bot-users-list
161
+ def list!(before_id: nil, limit: nil, url: nil)
162
+ result = @client.list(
163
+ before_id: before_id,
164
+ limit: limit,
165
+ danger: true,
166
+ url: url,
167
+ path: PATH
168
+ )
169
+
170
+ NgrokAPI::Models::Listable.new(
171
+ client: self,
172
+ attrs: result,
173
+ list_property: LIST_PROPERTY,
174
+ klass: NgrokAPI::Models::BotUser,
175
+ danger: true
176
+ )
177
+ end
178
+
179
+ ##
180
+ # Update attributes of a bot user by ID.
181
+ #
182
+ # @param [string] id
183
+ # @param [string] name human-readable name used to identify the bot
184
+ # @param [boolean] active whether or not the bot is active
185
+ # @return [NgrokAPI::Models::BotUser] result from the API request
186
+ #
187
+ # https://ngrok.com/docs/api#api-bot-users-update
188
+ def update(id: "", name: nil, active: nil)
189
+ path = '/bot_users/%{id}'
190
+ replacements = {
191
+ id: id,
192
+ }
193
+ data = {}
194
+ data[:name] = name if name
195
+ data[:active] = active if active
196
+ result = @client.patch(path % replacements, data: data)
197
+ NgrokAPI::Models::BotUser.new(client: self, attrs: result)
198
+ end
199
+
200
+ ##
201
+ # Update attributes of a bot user by ID.
202
+ # Throws an exception if API error.
203
+ #
204
+ # @param [string] id
205
+ # @param [string] name human-readable name used to identify the bot
206
+ # @param [boolean] active whether or not the bot is active
207
+ # @return [NgrokAPI::Models::BotUser] result from the API request
208
+ #
209
+ # https://ngrok.com/docs/api#api-bot-users-update
210
+ def update!(id: "", name: nil, active: nil)
211
+ path = '/bot_users/%{id}'
212
+ replacements = {
213
+ id: id,
214
+ }
215
+ data = {}
216
+ data[:name] = name if name
217
+ data[:active] = active if active
218
+ result = @client.patch(path % replacements, data: data, danger: true)
219
+ NgrokAPI::Models::BotUser.new(client: self, attrs: result)
220
+ end
221
+ end
222
+ end
223
+ end
@@ -36,7 +36,7 @@ module NgrokAPI
36
36
  # @return [NgrokAPI::Models::Credential] result from the API request
37
37
  #
38
38
  # https://ngrok.com/docs/api#api-credentials-create
39
- def create(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "")
39
+ def create(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil)
40
40
  path = '/credentials'
41
41
  replacements = {
42
42
  }
@@ -63,7 +63,7 @@ module NgrokAPI
63
63
  # @return [NgrokAPI::Models::Credential] result from the API request
64
64
  #
65
65
  # https://ngrok.com/docs/api#api-credentials-create
66
- def create!(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "")
66
+ def create!(description: "", metadata: "", acl: [], owner_id: nil, owner_email: "", precomputed_token: nil)
67
67
  path = '/credentials'
68
68
  replacements = {
69
69
  }
@@ -0,0 +1,120 @@
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-edge-route-policy-module
9
+ class EdgeRoutePolicyModuleClient
10
+ # The API path for the requests
11
+ PATH = '/edges/https/%{edge_id}/routes/%{id}/policy'
12
+
13
+ attr_reader :client
14
+
15
+ def initialize(client:)
16
+ @client = client
17
+ end
18
+
19
+ ##
20
+ # @param [string] edge_id
21
+ # @param [string] id
22
+ # @param [EndpointPolicy] a_module
23
+ # @return [NgrokAPI::Models::EndpointPolicy] result from the API request
24
+ #
25
+ # https://ngrok.com/docs/api#api-edge-route-policy-module-replace
26
+ def replace(edge_id: "", id: "", a_module: nil)
27
+ path = '/edges/https/%{edge_id}/routes/%{id}/policy'
28
+ replacements = {
29
+ edge_id: edge_id,
30
+ id: id,
31
+ }
32
+ data = a_module
33
+ result = @client.put(path % replacements, data: data)
34
+ NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
35
+ end
36
+
37
+ ##
38
+ # @param [string] edge_id
39
+ # @param [string] id
40
+ # @param [EndpointPolicy] a_module
41
+ # @return [NgrokAPI::Models::EndpointPolicy] result from the API request
42
+ #
43
+ # https://ngrok.com/docs/api#api-edge-route-policy-module-replace
44
+ def replace!(edge_id: "", id: "", a_module: nil)
45
+ path = '/edges/https/%{edge_id}/routes/%{id}/policy'
46
+ replacements = {
47
+ edge_id: edge_id,
48
+ id: id,
49
+ }
50
+ data = a_module
51
+ result = @client.put(path % replacements, data: data, danger: true)
52
+ NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
53
+ end
54
+
55
+ ##
56
+ # @param [string] edge_id unique identifier of this edge
57
+ # @param [string] id unique identifier of this edge route
58
+ # @return [NgrokAPI::Models::EndpointPolicy] result from the API request
59
+ #
60
+ # https://ngrok.com/docs/api#api-edge-route-policy-module-get
61
+ def get(edge_id: "", id: "")
62
+ path = '/edges/https/%{edge_id}/routes/%{id}/policy'
63
+ replacements = {
64
+ edge_id: edge_id,
65
+ id: id,
66
+ }
67
+ data = {}
68
+ result = @client.get(path % replacements, data: data)
69
+ NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
70
+ end
71
+
72
+ ##
73
+ # @param [string] edge_id unique identifier of this edge
74
+ # @param [string] id unique identifier of this edge route
75
+ # @return [NgrokAPI::Models::EndpointPolicy] result from the API request
76
+ #
77
+ # https://ngrok.com/docs/api#api-edge-route-policy-module-get
78
+ def get!(edge_id: "", id: "")
79
+ path = '/edges/https/%{edge_id}/routes/%{id}/policy'
80
+ replacements = {
81
+ edge_id: edge_id,
82
+ id: id,
83
+ }
84
+ data = {}
85
+ result = @client.get(path % replacements, data: data, danger: true)
86
+ NgrokAPI::Models::EndpointPolicy.new(client: self, attrs: result)
87
+ end
88
+
89
+ ##
90
+ # @param [string] edge_id unique identifier of this edge
91
+ # @param [string] id unique identifier of this edge route
92
+ # @return [NgrokAPI::Models::Empty] result from the API request
93
+ #
94
+ # https://ngrok.com/docs/api#api-edge-route-policy-module-delete
95
+ def delete(edge_id: "", id: "")
96
+ path = '/edges/https/%{edge_id}/routes/%{id}/policy'
97
+ replacements = {
98
+ edge_id: edge_id,
99
+ id: id,
100
+ }
101
+ @client.delete(path % replacements)
102
+ end
103
+
104
+ ##
105
+ # @param [string] edge_id unique identifier of this edge
106
+ # @param [string] id unique identifier of this edge route
107
+ # @return [NgrokAPI::Models::Empty] result from the API request
108
+ #
109
+ # https://ngrok.com/docs/api#api-edge-route-policy-module-delete
110
+ def delete!(edge_id: "", id: "")
111
+ path = '/edges/https/%{edge_id}/routes/%{id}/policy'
112
+ replacements = {
113
+ edge_id: edge_id,
114
+ id: id,
115
+ }
116
+ @client.delete(path % replacements, danger: true)
117
+ end
118
+ end
119
+ end
120
+ end
@@ -0,0 +1,120 @@
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-edge-route-user-agent-filter-module
9
+ class EdgeRouteUserAgentFilterModuleClient
10
+ # The API path for the requests
11
+ PATH = '/edges/https/%{edge_id}/routes/%{id}/user_agent_filter'
12
+
13
+ attr_reader :client
14
+
15
+ def initialize(client:)
16
+ @client = client
17
+ end
18
+
19
+ ##
20
+ # @param [string] edge_id
21
+ # @param [string] id
22
+ # @param [EndpointUserAgentFilter] a_module
23
+ # @return [NgrokAPI::Models::EndpointUserAgentFilter] result from the API request
24
+ #
25
+ # https://ngrok.com/docs/api#api-edge-route-user-agent-filter-module-replace
26
+ def replace(edge_id: "", id: "", a_module: nil)
27
+ path = '/edges/https/%{edge_id}/routes/%{id}/user_agent_filter'
28
+ replacements = {
29
+ edge_id: edge_id,
30
+ id: id,
31
+ }
32
+ data = a_module
33
+ result = @client.put(path % replacements, data: data)
34
+ NgrokAPI::Models::EndpointUserAgentFilter.new(client: self, attrs: result)
35
+ end
36
+
37
+ ##
38
+ # @param [string] edge_id
39
+ # @param [string] id
40
+ # @param [EndpointUserAgentFilter] a_module
41
+ # @return [NgrokAPI::Models::EndpointUserAgentFilter] result from the API request
42
+ #
43
+ # https://ngrok.com/docs/api#api-edge-route-user-agent-filter-module-replace
44
+ def replace!(edge_id: "", id: "", a_module: nil)
45
+ path = '/edges/https/%{edge_id}/routes/%{id}/user_agent_filter'
46
+ replacements = {
47
+ edge_id: edge_id,
48
+ id: id,
49
+ }
50
+ data = a_module
51
+ result = @client.put(path % replacements, data: data, danger: true)
52
+ NgrokAPI::Models::EndpointUserAgentFilter.new(client: self, attrs: result)
53
+ end
54
+
55
+ ##
56
+ # @param [string] edge_id unique identifier of this edge
57
+ # @param [string] id unique identifier of this edge route
58
+ # @return [NgrokAPI::Models::EndpointUserAgentFilter] result from the API request
59
+ #
60
+ # https://ngrok.com/docs/api#api-edge-route-user-agent-filter-module-get
61
+ def get(edge_id: "", id: "")
62
+ path = '/edges/https/%{edge_id}/routes/%{id}/user_agent_filter'
63
+ replacements = {
64
+ edge_id: edge_id,
65
+ id: id,
66
+ }
67
+ data = {}
68
+ result = @client.get(path % replacements, data: data)
69
+ NgrokAPI::Models::EndpointUserAgentFilter.new(client: self, attrs: result)
70
+ end
71
+
72
+ ##
73
+ # @param [string] edge_id unique identifier of this edge
74
+ # @param [string] id unique identifier of this edge route
75
+ # @return [NgrokAPI::Models::EndpointUserAgentFilter] result from the API request
76
+ #
77
+ # https://ngrok.com/docs/api#api-edge-route-user-agent-filter-module-get
78
+ def get!(edge_id: "", id: "")
79
+ path = '/edges/https/%{edge_id}/routes/%{id}/user_agent_filter'
80
+ replacements = {
81
+ edge_id: edge_id,
82
+ id: id,
83
+ }
84
+ data = {}
85
+ result = @client.get(path % replacements, data: data, danger: true)
86
+ NgrokAPI::Models::EndpointUserAgentFilter.new(client: self, attrs: result)
87
+ end
88
+
89
+ ##
90
+ # @param [string] edge_id unique identifier of this edge
91
+ # @param [string] id unique identifier of this edge route
92
+ # @return [NgrokAPI::Models::Empty] result from the API request
93
+ #
94
+ # https://ngrok.com/docs/api#api-edge-route-user-agent-filter-module-delete
95
+ def delete(edge_id: "", id: "")
96
+ path = '/edges/https/%{edge_id}/routes/%{id}/user_agent_filter'
97
+ replacements = {
98
+ edge_id: edge_id,
99
+ id: id,
100
+ }
101
+ @client.delete(path % replacements)
102
+ end
103
+
104
+ ##
105
+ # @param [string] edge_id unique identifier of this edge
106
+ # @param [string] id unique identifier of this edge route
107
+ # @return [NgrokAPI::Models::Empty] result from the API request
108
+ #
109
+ # https://ngrok.com/docs/api#api-edge-route-user-agent-filter-module-delete
110
+ def delete!(edge_id: "", id: "")
111
+ path = '/edges/https/%{edge_id}/routes/%{id}/user_agent_filter'
112
+ replacements = {
113
+ edge_id: edge_id,
114
+ id: id,
115
+ }
116
+ @client.delete(path % replacements, danger: true)
117
+ end
118
+ end
119
+ end
120
+ end
@@ -35,10 +35,12 @@ module NgrokAPI
35
35
  # @param [EndpointSAMLMutate] saml saml module configuration or ``null``
36
36
  # @param [EndpointOIDC] oidc oidc module configuration or ``null``
37
37
  # @param [EndpointWebsocketTCPConverter] websocket_tcp_converter websocket to tcp adapter configuration or ``null``
38
+ # @param [EndpointUserAgentFilter] user_agent_filter
39
+ # @param [EndpointPolicy] policy the traffic policy associated with this edge or null
38
40
  # @return [NgrokAPI::Models::HTTPSEdgeRoute] result from the API request
39
41
  #
40
42
  # https://ngrok.com/docs/api#api-edges-https-routes-create
41
- def create(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil)
43
+ def create(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil)
42
44
  path = '/edges/https/%{edge_id}/routes'
43
45
  replacements = {
44
46
  edge_id: edge_id,
@@ -59,6 +61,8 @@ module NgrokAPI
59
61
  data[:saml] = saml if saml
60
62
  data[:oidc] = oidc if oidc
61
63
  data[:websocket_tcp_converter] = websocket_tcp_converter if websocket_tcp_converter
64
+ data[:user_agent_filter] = user_agent_filter if user_agent_filter
65
+ data[:policy] = policy if policy
62
66
  result = @client.post(path % replacements, data: data)
63
67
  NgrokAPI::Models::HTTPSEdgeRoute.new(client: self, attrs: result)
64
68
  end
@@ -83,10 +87,12 @@ module NgrokAPI
83
87
  # @param [EndpointSAMLMutate] saml saml module configuration or ``null``
84
88
  # @param [EndpointOIDC] oidc oidc module configuration or ``null``
85
89
  # @param [EndpointWebsocketTCPConverter] websocket_tcp_converter websocket to tcp adapter configuration or ``null``
90
+ # @param [EndpointUserAgentFilter] user_agent_filter
91
+ # @param [EndpointPolicy] policy the traffic policy associated with this edge or null
86
92
  # @return [NgrokAPI::Models::HTTPSEdgeRoute] result from the API request
87
93
  #
88
94
  # https://ngrok.com/docs/api#api-edges-https-routes-create
89
- def create!(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil)
95
+ def create!(edge_id: "", match_type:, match:, description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil)
90
96
  path = '/edges/https/%{edge_id}/routes'
91
97
  replacements = {
92
98
  edge_id: edge_id,
@@ -107,6 +113,8 @@ module NgrokAPI
107
113
  data[:saml] = saml if saml
108
114
  data[:oidc] = oidc if oidc
109
115
  data[:websocket_tcp_converter] = websocket_tcp_converter if websocket_tcp_converter
116
+ data[:user_agent_filter] = user_agent_filter if user_agent_filter
117
+ data[:policy] = policy if policy
110
118
  result = @client.post(path % replacements, data: data, danger: true)
111
119
  NgrokAPI::Models::HTTPSEdgeRoute.new(client: self, attrs: result)
112
120
  end
@@ -173,10 +181,12 @@ module NgrokAPI
173
181
  # @param [EndpointSAMLMutate] saml saml module configuration or ``null``
174
182
  # @param [EndpointOIDC] oidc oidc module configuration or ``null``
175
183
  # @param [EndpointWebsocketTCPConverter] websocket_tcp_converter websocket to tcp adapter configuration or ``null``
184
+ # @param [EndpointUserAgentFilter] user_agent_filter
185
+ # @param [EndpointPolicy] policy the traffic policy associated with this edge or null
176
186
  # @return [NgrokAPI::Models::HTTPSEdgeRoute] result from the API request
177
187
  #
178
188
  # https://ngrok.com/docs/api#api-edges-https-routes-update
179
- def update(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil)
189
+ def update(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil)
180
190
  path = '/edges/https/%{edge_id}/routes/%{id}'
181
191
  replacements = {
182
192
  edge_id: edge_id,
@@ -198,6 +208,8 @@ module NgrokAPI
198
208
  data[:saml] = saml if saml
199
209
  data[:oidc] = oidc if oidc
200
210
  data[:websocket_tcp_converter] = websocket_tcp_converter if websocket_tcp_converter
211
+ data[:user_agent_filter] = user_agent_filter if user_agent_filter
212
+ data[:policy] = policy if policy
201
213
  result = @client.patch(path % replacements, data: data)
202
214
  NgrokAPI::Models::HTTPSEdgeRoute.new(client: self, attrs: result)
203
215
  end
@@ -226,10 +238,12 @@ module NgrokAPI
226
238
  # @param [EndpointSAMLMutate] saml saml module configuration or ``null``
227
239
  # @param [EndpointOIDC] oidc oidc module configuration or ``null``
228
240
  # @param [EndpointWebsocketTCPConverter] websocket_tcp_converter websocket to tcp adapter configuration or ``null``
241
+ # @param [EndpointUserAgentFilter] user_agent_filter
242
+ # @param [EndpointPolicy] policy the traffic policy associated with this edge or null
229
243
  # @return [NgrokAPI::Models::HTTPSEdgeRoute] result from the API request
230
244
  #
231
245
  # https://ngrok.com/docs/api#api-edges-https-routes-update
232
- def update!(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil)
246
+ def update!(edge_id: "", id: "", match_type: "", match: "", description: "", metadata: "", backend: nil, ip_restriction: nil, circuit_breaker: nil, compression: nil, request_headers: nil, response_headers: nil, webhook_verification: nil, oauth: nil, saml: nil, oidc: nil, websocket_tcp_converter: nil, user_agent_filter: nil, policy: nil)
233
247
  path = '/edges/https/%{edge_id}/routes/%{id}'
234
248
  replacements = {
235
249
  edge_id: edge_id,
@@ -251,6 +265,8 @@ module NgrokAPI
251
265
  data[:saml] = saml if saml
252
266
  data[:oidc] = oidc if oidc
253
267
  data[:websocket_tcp_converter] = websocket_tcp_converter if websocket_tcp_converter
268
+ data[:user_agent_filter] = user_agent_filter if user_agent_filter
269
+ data[:policy] = policy if policy
254
270
  result = @client.patch(path % replacements, data: data, danger: true)
255
271
  NgrokAPI::Models::HTTPSEdgeRoute.new(client: self, attrs: result)
256
272
  end
@@ -26,10 +26,11 @@ module NgrokAPI
26
26
  # @param [List<string>] hostports hostports served by this edge
27
27
  # @param [EndpointBackendMutate] backend edge modules
28
28
  # @param [EndpointIPPolicyMutate] ip_restriction
29
+ # @param [EndpointPolicy] policy the traffic policy associated with this edge or null
29
30
  # @return [NgrokAPI::Models::TCPEdge] result from the API request
30
31
  #
31
32
  # https://ngrok.com/docs/api#api-edges-tcp-create
32
- def create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil)
33
+ def create(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, policy: nil)
33
34
  path = '/edges/tcp'
34
35
  replacements = {
35
36
  }
@@ -39,6 +40,7 @@ module NgrokAPI
39
40
  data[:hostports] = hostports if hostports
40
41
  data[:backend] = backend if backend
41
42
  data[:ip_restriction] = ip_restriction if ip_restriction
43
+ data[:policy] = policy if policy
42
44
  result = @client.post(path % replacements, data: data)
43
45
  NgrokAPI::Models::TCPEdge.new(client: self, attrs: result)
44
46
  end
@@ -52,10 +54,11 @@ module NgrokAPI
52
54
  # @param [List<string>] hostports hostports served by this edge
53
55
  # @param [EndpointBackendMutate] backend edge modules
54
56
  # @param [EndpointIPPolicyMutate] ip_restriction
57
+ # @param [EndpointPolicy] policy the traffic policy associated with this edge or null
55
58
  # @return [NgrokAPI::Models::TCPEdge] result from the API request
56
59
  #
57
60
  # https://ngrok.com/docs/api#api-edges-tcp-create
58
- def create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil)
61
+ def create!(description: "", metadata: "", hostports: nil, backend: nil, ip_restriction: nil, policy: nil)
59
62
  path = '/edges/tcp'
60
63
  replacements = {
61
64
  }
@@ -65,6 +68,7 @@ module NgrokAPI
65
68
  data[:hostports] = hostports if hostports
66
69
  data[:backend] = backend if backend
67
70
  data[:ip_restriction] = ip_restriction if ip_restriction
71
+ data[:policy] = policy if policy
68
72
  result = @client.post(path % replacements, data: data, danger: true)
69
73
  NgrokAPI::Models::TCPEdge.new(client: self, attrs: result)
70
74
  end
@@ -169,10 +173,11 @@ module NgrokAPI
169
173
  # @param [List<string>] hostports hostports served by this edge
170
174
  # @param [EndpointBackendMutate] backend edge modules
171
175
  # @param [EndpointIPPolicyMutate] ip_restriction
176
+ # @param [EndpointPolicy] policy the traffic policy associated with this edge or null
172
177
  # @return [NgrokAPI::Models::TCPEdge] result from the API request
173
178
  #
174
179
  # https://ngrok.com/docs/api#api-edges-tcp-update
175
- def update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil)
180
+ def update(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, policy: nil)
176
181
  path = '/edges/tcp/%{id}'
177
182
  replacements = {
178
183
  id: id,
@@ -183,6 +188,7 @@ module NgrokAPI
183
188
  data[:hostports] = hostports if hostports
184
189
  data[:backend] = backend if backend
185
190
  data[:ip_restriction] = ip_restriction if ip_restriction
191
+ data[:policy] = policy if policy
186
192
  result = @client.patch(path % replacements, data: data)
187
193
  NgrokAPI::Models::TCPEdge.new(client: self, attrs: result)
188
194
  end
@@ -200,10 +206,11 @@ module NgrokAPI
200
206
  # @param [List<string>] hostports hostports served by this edge
201
207
  # @param [EndpointBackendMutate] backend edge modules
202
208
  # @param [EndpointIPPolicyMutate] ip_restriction
209
+ # @param [EndpointPolicy] policy the traffic policy associated with this edge or null
203
210
  # @return [NgrokAPI::Models::TCPEdge] result from the API request
204
211
  #
205
212
  # https://ngrok.com/docs/api#api-edges-tcp-update
206
- def update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil)
213
+ def update!(id: "", description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, policy: nil)
207
214
  path = '/edges/tcp/%{id}'
208
215
  replacements = {
209
216
  id: id,
@@ -214,6 +221,7 @@ module NgrokAPI
214
221
  data[:hostports] = hostports if hostports
215
222
  data[:backend] = backend if backend
216
223
  data[:ip_restriction] = ip_restriction if ip_restriction
224
+ data[:policy] = policy if policy
217
225
  result = @client.patch(path % replacements, data: data, danger: true)
218
226
  NgrokAPI::Models::TCPEdge.new(client: self, attrs: result)
219
227
  end