ngrok-api 0.16.0 → 0.17.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 (373) hide show
  1. checksums.yaml +4 -4
  2. data/doc/NgrokAPI/Client.html +270 -180
  3. data/doc/NgrokAPI/Error.html +2 -2
  4. data/doc/NgrokAPI/Errors/NotFoundError.html +2 -2
  5. data/doc/NgrokAPI/Errors.html +2 -2
  6. data/doc/NgrokAPI/HttpClient.html +2 -2
  7. data/doc/NgrokAPI/Models/APIKey.html +2 -2
  8. data/doc/NgrokAPI/Models/AWSAuth.html +2 -2
  9. data/doc/NgrokAPI/Models/AWSCredentials.html +2 -2
  10. data/doc/NgrokAPI/Models/AWSRole.html +2 -2
  11. data/doc/NgrokAPI/Models/AbuseReport.html +2 -2
  12. data/doc/NgrokAPI/Models/AbuseReportHostname.html +2 -2
  13. data/doc/NgrokAPI/Models/AgentIngress.html +2 -2
  14. data/doc/NgrokAPI/Models/CertificateAuthority.html +2 -2
  15. data/doc/NgrokAPI/Models/Credential.html +2 -2
  16. data/doc/NgrokAPI/Models/Endpoint.html +1431 -0
  17. data/{docs/NgrokAPI/Models/EndpointLogging.html → doc/NgrokAPI/Models/EndpointBackend.html} +41 -41
  18. data/doc/NgrokAPI/Models/{EndpointLoggingMutate.html → EndpointBackendMutate.html} +41 -41
  19. data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +2 -2
  20. data/doc/NgrokAPI/Models/EndpointCompression.html +2 -2
  21. data/doc/NgrokAPI/Models/EndpointIPPolicy.html +2 -2
  22. data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +2 -2
  23. data/doc/NgrokAPI/Models/EndpointMutualTLS.html +2 -2
  24. data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +2 -2
  25. data/doc/NgrokAPI/Models/EndpointOAuth.html +2 -2
  26. data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +2 -2
  27. data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +2 -2
  28. data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +2 -2
  29. data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +2 -2
  30. data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +2 -2
  31. data/doc/NgrokAPI/Models/EndpointOIDC.html +2 -2
  32. data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +2 -2
  33. data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +2 -2
  34. data/doc/NgrokAPI/Models/EndpointSAML.html +2 -2
  35. data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +2 -2
  36. data/doc/NgrokAPI/Models/EndpointTLSTermination.html +2 -2
  37. data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +617 -0
  38. data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +2 -2
  39. data/doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +543 -0
  40. data/doc/NgrokAPI/Models/EventDestination.html +6 -6
  41. data/doc/NgrokAPI/Models/EventSource.html +2 -2
  42. data/doc/NgrokAPI/Models/EventSourceList.html +2 -2
  43. data/doc/NgrokAPI/Models/EventSourceReplace.html +2 -2
  44. data/doc/NgrokAPI/Models/EventSubscription.html +2 -2
  45. data/doc/NgrokAPI/Models/EventTarget.html +2 -2
  46. data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +2 -2
  47. data/doc/NgrokAPI/Models/EventTargetFirehose.html +2 -2
  48. data/doc/NgrokAPI/Models/EventTargetKinesis.html +2 -2
  49. data/doc/NgrokAPI/Models/FailoverBackend.html +1075 -0
  50. data/doc/NgrokAPI/Models/HTTPResponseBackend.html +1231 -0
  51. data/{docs/NgrokAPI/Models/EventStream.html → doc/NgrokAPI/Models/HTTPSEdge.html} +118 -118
  52. data/doc/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +202 -264
  53. data/doc/NgrokAPI/Models/IPPolicy.html +2 -2
  54. data/doc/NgrokAPI/Models/IPPolicyRule.html +96 -22
  55. data/doc/NgrokAPI/Models/IPRestriction.html +2 -2
  56. data/doc/NgrokAPI/Models/Listable.html +2 -2
  57. data/doc/NgrokAPI/Models/Ref.html +2 -2
  58. data/doc/NgrokAPI/Models/ReservedAddr.html +2 -2
  59. data/doc/NgrokAPI/Models/ReservedDomain.html +2 -2
  60. data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +2 -2
  61. data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +2 -2
  62. data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +2 -2
  63. data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +2 -2
  64. data/doc/NgrokAPI/Models/SSHCredential.html +2 -2
  65. data/doc/NgrokAPI/Models/SSHHostCertificate.html +2 -2
  66. data/doc/NgrokAPI/Models/SSHUserCertificate.html +2 -2
  67. data/doc/NgrokAPI/Models/TCPEdge.html +1235 -0
  68. data/doc/NgrokAPI/Models/TLSCertificate.html +2 -2
  69. data/doc/NgrokAPI/Models/TLSCertificateSANs.html +2 -2
  70. data/doc/NgrokAPI/Models/TLSEdge.html +1395 -0
  71. data/doc/NgrokAPI/Models/Tunnel.html +313 -17
  72. data/doc/NgrokAPI/Models/TunnelGroupBackend.html +1149 -0
  73. data/doc/NgrokAPI/Models/TunnelSession.html +2 -2
  74. data/doc/NgrokAPI/Models/WeightedBackend.html +1075 -0
  75. data/doc/NgrokAPI/Models.html +4 -4
  76. data/doc/NgrokAPI/PagedIterator.html +2 -2
  77. data/doc/NgrokAPI/Services/APIKeysClient.html +2 -2
  78. data/doc/NgrokAPI/Services/AbuseReportsClient.html +2 -2
  79. data/doc/NgrokAPI/Services/AgentIngressesClient.html +2 -2
  80. data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +2 -2
  81. data/doc/NgrokAPI/Services/CredentialsClient.html +2 -2
  82. data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1153 -0
  83. data/doc/NgrokAPI/Services/{EndpointCircuitBreakerModuleClient.html → EdgeRouteCircuitBreakerModuleClient.html} +206 -96
  84. data/{docs/NgrokAPI/Services/EndpointCompressionModuleClient.html → doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html} +206 -96
  85. data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +1153 -0
  86. data/doc/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +1153 -0
  87. data/{docs/NgrokAPI/Services/EndpointOIDCModuleClient.html → doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html} +206 -96
  88. data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1153 -0
  89. data/{docs/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html → doc/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html} +206 -96
  90. data/{docs/NgrokAPI/Services/EndpointSAMLModuleClient.html → doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html} +206 -96
  91. data/doc/NgrokAPI/Services/{EndpointWebhookValidationModuleClient.html → EdgeRouteWebhookVerificationModuleClient.html} +206 -96
  92. data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1153 -0
  93. data/doc/NgrokAPI/Services/{EventStreamsClient.html → EdgesHTTPSClient.html} +236 -271
  94. data/{docs/NgrokAPI/Services/EndpointConfigurationsClient.html → doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html} +456 -620
  95. data/doc/NgrokAPI/Services/EdgesTCPClient.html +1757 -0
  96. data/doc/NgrokAPI/Services/EdgesTLSClient.html +1847 -0
  97. data/doc/NgrokAPI/Services/EndpointsClient.html +907 -0
  98. data/doc/NgrokAPI/Services/EventDestinationsClient.html +35 -35
  99. data/doc/NgrokAPI/Services/EventSourcesClient.html +2 -2
  100. data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +5 -5
  101. data/doc/NgrokAPI/Services/FailoverBackendsClient.html +1644 -0
  102. data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +1744 -0
  103. data/doc/NgrokAPI/Services/{EndpointOIDCModuleClient.html → HTTPSEdgeMutualTLSModuleClient.html} +59 -59
  104. data/doc/NgrokAPI/Services/{EndpointRequestHeadersModuleClient.html → HTTPSEdgeTLSTerminationModuleClient.html} +59 -59
  105. data/doc/NgrokAPI/Services/IPPoliciesClient.html +40 -58
  106. data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +60 -40
  107. data/doc/NgrokAPI/Services/IPRestrictionsClient.html +3 -3
  108. data/doc/NgrokAPI/Services/ReservedAddrsClient.html +41 -331
  109. data/doc/NgrokAPI/Services/ReservedDomainsClient.html +94 -674
  110. data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +2 -2
  111. data/doc/NgrokAPI/Services/SSHCredentialsClient.html +2 -2
  112. data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +2 -2
  113. data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +2 -2
  114. data/{docs/NgrokAPI/Services/EndpointLoggingModuleClient.html → doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html} +59 -59
  115. data/doc/NgrokAPI/Services/{EndpointIPPolicyModuleClient.html → TCPEdgeIPRestrictionModuleClient.html} +41 -41
  116. data/doc/NgrokAPI/Services/TLSCertificatesClient.html +2 -2
  117. data/doc/NgrokAPI/Services/{EndpointLoggingModuleClient.html → TLSEdgeBackendModuleClient.html} +59 -59
  118. data/{docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html → doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html} +41 -41
  119. data/doc/NgrokAPI/Services/{EndpointMutualTLSModuleClient.html → TLSEdgeMutualTLSModuleClient.html} +41 -41
  120. data/{docs/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html → doc/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html} +41 -41
  121. data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +1644 -0
  122. data/doc/NgrokAPI/Services/TunnelSessionsClient.html +2 -2
  123. data/doc/NgrokAPI/Services/TunnelsClient.html +241 -3
  124. data/doc/NgrokAPI/Services/WeightedBackendsClient.html +1644 -0
  125. data/doc/NgrokAPI/Services.html +4 -4
  126. data/doc/NgrokAPI.html +3 -3
  127. data/doc/_index.html +237 -60
  128. data/doc/class_list.html +1 -1
  129. data/doc/file.README.html +2 -2
  130. data/doc/index.html +2 -2
  131. data/doc/method_list.html +3393 -1433
  132. data/doc/top-level-namespace.html +2 -2
  133. data/docs/NgrokAPI/Client.html +270 -180
  134. data/docs/NgrokAPI/Error.html +2 -2
  135. data/docs/NgrokAPI/Errors/NotFoundError.html +2 -2
  136. data/docs/NgrokAPI/Errors.html +2 -2
  137. data/docs/NgrokAPI/HttpClient.html +2 -2
  138. data/docs/NgrokAPI/Models/APIKey.html +2 -2
  139. data/docs/NgrokAPI/Models/AWSAuth.html +2 -2
  140. data/docs/NgrokAPI/Models/AWSCredentials.html +2 -2
  141. data/docs/NgrokAPI/Models/AWSRole.html +2 -2
  142. data/docs/NgrokAPI/Models/AbuseReport.html +2 -2
  143. data/docs/NgrokAPI/Models/AbuseReportHostname.html +2 -2
  144. data/docs/NgrokAPI/Models/AgentIngress.html +2 -2
  145. data/docs/NgrokAPI/Models/CertificateAuthority.html +2 -2
  146. data/docs/NgrokAPI/Models/Credential.html +2 -2
  147. data/docs/NgrokAPI/Models/Endpoint.html +1431 -0
  148. data/{doc/NgrokAPI/Models/EndpointLogging.html → docs/NgrokAPI/Models/EndpointBackend.html} +41 -41
  149. data/docs/NgrokAPI/Models/{EndpointLoggingMutate.html → EndpointBackendMutate.html} +41 -41
  150. data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +2 -2
  151. data/docs/NgrokAPI/Models/EndpointCompression.html +2 -2
  152. data/docs/NgrokAPI/Models/EndpointIPPolicy.html +2 -2
  153. data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +2 -2
  154. data/docs/NgrokAPI/Models/EndpointMutualTLS.html +2 -2
  155. data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +2 -2
  156. data/docs/NgrokAPI/Models/EndpointOAuth.html +2 -2
  157. data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +2 -2
  158. data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +2 -2
  159. data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +2 -2
  160. data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +2 -2
  161. data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +2 -2
  162. data/docs/NgrokAPI/Models/EndpointOIDC.html +2 -2
  163. data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +2 -2
  164. data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +2 -2
  165. data/docs/NgrokAPI/Models/EndpointSAML.html +2 -2
  166. data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +2 -2
  167. data/docs/NgrokAPI/Models/EndpointTLSTermination.html +2 -2
  168. data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +617 -0
  169. data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +2 -2
  170. data/docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html +543 -0
  171. data/docs/NgrokAPI/Models/EventDestination.html +6 -6
  172. data/docs/NgrokAPI/Models/EventSource.html +2 -2
  173. data/docs/NgrokAPI/Models/EventSourceList.html +2 -2
  174. data/docs/NgrokAPI/Models/EventSourceReplace.html +2 -2
  175. data/docs/NgrokAPI/Models/EventSubscription.html +2 -2
  176. data/docs/NgrokAPI/Models/EventTarget.html +2 -2
  177. data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +2 -2
  178. data/docs/NgrokAPI/Models/EventTargetFirehose.html +2 -2
  179. data/docs/NgrokAPI/Models/EventTargetKinesis.html +2 -2
  180. data/docs/NgrokAPI/Models/FailoverBackend.html +1075 -0
  181. data/docs/NgrokAPI/Models/HTTPResponseBackend.html +1231 -0
  182. data/{doc/NgrokAPI/Models/EventStream.html → docs/NgrokAPI/Models/HTTPSEdge.html} +118 -118
  183. data/docs/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +202 -264
  184. data/docs/NgrokAPI/Models/IPPolicy.html +2 -2
  185. data/docs/NgrokAPI/Models/IPPolicyRule.html +96 -22
  186. data/docs/NgrokAPI/Models/IPRestriction.html +2 -2
  187. data/docs/NgrokAPI/Models/Listable.html +2 -2
  188. data/docs/NgrokAPI/Models/Ref.html +2 -2
  189. data/docs/NgrokAPI/Models/ReservedAddr.html +2 -2
  190. data/docs/NgrokAPI/Models/ReservedDomain.html +2 -2
  191. data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +2 -2
  192. data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +2 -2
  193. data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +2 -2
  194. data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +2 -2
  195. data/docs/NgrokAPI/Models/SSHCredential.html +2 -2
  196. data/docs/NgrokAPI/Models/SSHHostCertificate.html +2 -2
  197. data/docs/NgrokAPI/Models/SSHUserCertificate.html +2 -2
  198. data/docs/NgrokAPI/Models/TCPEdge.html +1235 -0
  199. data/docs/NgrokAPI/Models/TLSCertificate.html +2 -2
  200. data/docs/NgrokAPI/Models/TLSCertificateSANs.html +2 -2
  201. data/docs/NgrokAPI/Models/TLSEdge.html +1395 -0
  202. data/docs/NgrokAPI/Models/Tunnel.html +313 -17
  203. data/docs/NgrokAPI/Models/TunnelGroupBackend.html +1149 -0
  204. data/docs/NgrokAPI/Models/TunnelSession.html +2 -2
  205. data/docs/NgrokAPI/Models/WeightedBackend.html +1075 -0
  206. data/docs/NgrokAPI/Models.html +4 -4
  207. data/docs/NgrokAPI/PagedIterator.html +2 -2
  208. data/docs/NgrokAPI/Services/APIKeysClient.html +2 -2
  209. data/docs/NgrokAPI/Services/AbuseReportsClient.html +2 -2
  210. data/docs/NgrokAPI/Services/AgentIngressesClient.html +2 -2
  211. data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +2 -2
  212. data/docs/NgrokAPI/Services/CredentialsClient.html +2 -2
  213. data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1153 -0
  214. data/docs/NgrokAPI/Services/{EndpointCircuitBreakerModuleClient.html → EdgeRouteCircuitBreakerModuleClient.html} +206 -96
  215. data/{doc/NgrokAPI/Services/EndpointCompressionModuleClient.html → docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html} +206 -96
  216. data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +1153 -0
  217. data/docs/NgrokAPI/Services/EdgeRouteOAuthModuleClient.html +1153 -0
  218. data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +1153 -0
  219. data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1153 -0
  220. data/{doc/NgrokAPI/Services/EndpointResponseHeadersModuleClient.html → docs/NgrokAPI/Services/EdgeRouteResponseHeadersModuleClient.html} +206 -96
  221. data/docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html +1153 -0
  222. data/docs/NgrokAPI/Services/{EndpointWebhookValidationModuleClient.html → EdgeRouteWebhookVerificationModuleClient.html} +206 -96
  223. data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1153 -0
  224. data/docs/NgrokAPI/Services/{EventStreamsClient.html → EdgesHTTPSClient.html} +236 -271
  225. data/{doc/NgrokAPI/Services/EndpointConfigurationsClient.html → docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html} +456 -620
  226. data/docs/NgrokAPI/Services/EdgesTCPClient.html +1757 -0
  227. data/docs/NgrokAPI/Services/EdgesTLSClient.html +1847 -0
  228. data/docs/NgrokAPI/Services/EndpointsClient.html +907 -0
  229. data/docs/NgrokAPI/Services/EventDestinationsClient.html +35 -35
  230. data/docs/NgrokAPI/Services/EventSourcesClient.html +2 -2
  231. data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +5 -5
  232. data/docs/NgrokAPI/Services/FailoverBackendsClient.html +1644 -0
  233. data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +1744 -0
  234. data/{doc/NgrokAPI/Services/EndpointSAMLModuleClient.html → docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html} +59 -59
  235. data/docs/NgrokAPI/Services/{EndpointRequestHeadersModuleClient.html → HTTPSEdgeTLSTerminationModuleClient.html} +59 -59
  236. data/docs/NgrokAPI/Services/IPPoliciesClient.html +40 -58
  237. data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +60 -40
  238. data/docs/NgrokAPI/Services/IPRestrictionsClient.html +3 -3
  239. data/docs/NgrokAPI/Services/ReservedAddrsClient.html +41 -331
  240. data/docs/NgrokAPI/Services/ReservedDomainsClient.html +94 -674
  241. data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +2 -2
  242. data/docs/NgrokAPI/Services/SSHCredentialsClient.html +2 -2
  243. data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +2 -2
  244. data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +2 -2
  245. data/docs/NgrokAPI/Services/{EndpointOAuthModuleClient.html → TCPEdgeBackendModuleClient.html} +59 -59
  246. data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +1043 -0
  247. data/docs/NgrokAPI/Services/TLSCertificatesClient.html +2 -2
  248. data/{doc/NgrokAPI/Services/EndpointOAuthModuleClient.html → docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html} +59 -59
  249. data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +1043 -0
  250. data/docs/NgrokAPI/Services/{EndpointMutualTLSModuleClient.html → TLSEdgeMutualTLSModuleClient.html} +41 -41
  251. data/{doc/NgrokAPI/Services/EndpointTLSTerminationModuleClient.html → docs/NgrokAPI/Services/TLSEdgeTLSTerminationModuleClient.html} +41 -41
  252. data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +1644 -0
  253. data/docs/NgrokAPI/Services/TunnelSessionsClient.html +2 -2
  254. data/docs/NgrokAPI/Services/TunnelsClient.html +241 -3
  255. data/docs/NgrokAPI/Services/WeightedBackendsClient.html +1644 -0
  256. data/docs/NgrokAPI/Services.html +4 -4
  257. data/docs/NgrokAPI.html +3 -3
  258. data/docs/_index.html +237 -60
  259. data/docs/class_list.html +1 -1
  260. data/docs/file.README.html +2 -2
  261. data/docs/index.html +2 -2
  262. data/docs/method_list.html +3393 -1433
  263. data/docs/top-level-namespace.html +2 -2
  264. data/lib/ngrokapi/client.rb +47 -24
  265. data/lib/ngrokapi/models/endpoint.rb +49 -0
  266. data/lib/ngrokapi/models/{endpoint_logging.rb → endpoint_backend.rb} +3 -3
  267. data/lib/ngrokapi/models/{endpoint_logging_mutate.rb → endpoint_backend_mutate.rb} +3 -3
  268. data/lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb +27 -0
  269. data/lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb +25 -0
  270. data/lib/ngrokapi/models/event_destination.rb +1 -2
  271. data/lib/ngrokapi/models/{event_stream.rb → failover_backend.rb} +15 -27
  272. data/lib/ngrokapi/models/http_response_backend.rb +71 -0
  273. data/lib/ngrokapi/models/https_edge.rb +80 -0
  274. data/lib/ngrokapi/models/{endpoint_configuration.rb → https_edge_route.rb} +56 -53
  275. data/lib/ngrokapi/models/ip_policy_rule.rb +3 -1
  276. data/lib/ngrokapi/models/tcp_edge.rb +78 -0
  277. data/lib/ngrokapi/models/tls_edge.rb +88 -0
  278. data/lib/ngrokapi/models/tunnel.rb +9 -1
  279. data/lib/ngrokapi/models/tunnel_group_backend.rb +67 -0
  280. data/lib/ngrokapi/models/weighted_backend.rb +65 -0
  281. data/lib/ngrokapi/services/edge_route_backend_module_client.rb +120 -0
  282. data/lib/ngrokapi/services/{endpoint_circuit_breaker_module_client.rb → edge_route_circuit_breaker_module_client.rb} +37 -25
  283. data/lib/ngrokapi/services/{endpoint_compression_module_client.rb → edge_route_compression_module_client.rb} +37 -25
  284. data/lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb +120 -0
  285. data/lib/ngrokapi/services/edge_route_o_auth_module_client.rb +120 -0
  286. data/lib/ngrokapi/services/edge_route_oidc_module_client.rb +120 -0
  287. data/lib/ngrokapi/services/edge_route_request_headers_module_client.rb +120 -0
  288. data/lib/ngrokapi/services/{endpoint_response_headers_module_client.rb → edge_route_response_headers_module_client.rb} +37 -25
  289. data/lib/ngrokapi/services/edge_route_saml_module_client.rb +120 -0
  290. data/lib/ngrokapi/services/{endpoint_webhook_validation_module_client.rb → edge_route_webhook_verification_module_client.rb} +37 -25
  291. data/lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb +120 -0
  292. data/lib/ngrokapi/services/edges_https_client.rb +227 -0
  293. data/lib/ngrokapi/services/edges_https_routes_client.rb +244 -0
  294. data/lib/ngrokapi/services/edges_tcp_client.rb +227 -0
  295. data/lib/ngrokapi/services/edges_tls_client.rb +239 -0
  296. data/lib/ngrokapi/services/endpoints_client.rb +114 -0
  297. data/lib/ngrokapi/services/event_destinations_client.rb +2 -4
  298. data/lib/ngrokapi/services/event_subscriptions_client.rb +3 -3
  299. data/lib/ngrokapi/services/failover_backends_client.rb +214 -0
  300. data/lib/ngrokapi/services/http_response_backends_client.rb +199 -0
  301. data/lib/ngrokapi/services/{endpoint_saml_module_client.rb → https_edge_mutual_tls_module_client.rb} +25 -25
  302. data/lib/ngrokapi/services/{endpoint_request_headers_module_client.rb → https_edge_tls_termination_module_client.rb} +25 -25
  303. data/lib/ngrokapi/services/ip_policies_client.rb +1 -3
  304. data/lib/ngrokapi/services/ip_policy_rules_client.rb +3 -1
  305. data/lib/ngrokapi/services/ip_restrictions_client.rb +1 -1
  306. data/lib/ngrokapi/services/reserved_addrs_client.rb +0 -37
  307. data/lib/ngrokapi/services/reserved_domains_client.rb +0 -74
  308. data/lib/ngrokapi/services/{endpoint_logging_module_client.rb → tcp_edge_backend_module_client.rb} +25 -25
  309. data/lib/ngrokapi/services/{endpoint_ip_policy_module_client.rb → tcp_edge_ip_restriction_module_client.rb} +15 -15
  310. data/lib/ngrokapi/services/{endpoint_oidc_module_client.rb → tls_edge_backend_module_client.rb} +25 -25
  311. data/lib/ngrokapi/services/{endpoint_o_auth_module_client.rb → tls_edge_ip_restriction_module_client.rb} +25 -25
  312. data/lib/ngrokapi/services/{endpoint_mutual_tls_module_client.rb → tls_edge_mutual_tls_module_client.rb} +15 -15
  313. data/lib/ngrokapi/services/{endpoint_tls_termination_module_client.rb → tls_edge_tls_termination_module_client.rb} +15 -15
  314. data/lib/ngrokapi/services/tunnel_group_backends_client.rb +212 -0
  315. data/lib/ngrokapi/services/tunnels_client.rb +35 -0
  316. data/lib/ngrokapi/services/weighted_backends_client.rb +214 -0
  317. data/lib/ngrokapi/version.rb +1 -1
  318. data/spec/ngrokapi/client_spec.rb +44 -23
  319. data/spec/ngrokapi/models/endpoint_backend_mutate_spec.rb +21 -0
  320. data/spec/ngrokapi/models/endpoint_backend_spec.rb +21 -0
  321. data/spec/ngrokapi/models/endpoint_spec.rb +21 -0
  322. data/spec/ngrokapi/models/endpoint_tls_termination_at_edge_spec.rb +21 -0
  323. data/spec/ngrokapi/models/endpoint_websocket_tcp_converter_spec.rb +21 -0
  324. data/spec/ngrokapi/models/failover_backend_spec.rb +45 -0
  325. data/spec/ngrokapi/models/http_response_backend_spec.rb +51 -0
  326. data/spec/ngrokapi/models/https_edge_route_spec.rb +81 -0
  327. data/spec/ngrokapi/models/https_edge_spec.rb +51 -0
  328. data/spec/ngrokapi/models/tcp_edge_spec.rb +51 -0
  329. data/spec/ngrokapi/models/tls_edge_spec.rb +57 -0
  330. data/spec/ngrokapi/models/tunnel_group_backend_spec.rb +45 -0
  331. data/spec/ngrokapi/models/weighted_backend_spec.rb +45 -0
  332. data/spec/ngrokapi/services/edge_route_backend_module_client_spec.rb +139 -0
  333. data/spec/ngrokapi/services/{endpoint_circuit_breaker_module_client_spec.rb → edge_route_circuit_breaker_module_client_spec.rb} +31 -17
  334. data/spec/ngrokapi/services/{endpoint_compression_module_client_spec.rb → edge_route_compression_module_client_spec.rb} +31 -17
  335. data/spec/ngrokapi/services/edge_route_ip_restriction_module_client_spec.rb +139 -0
  336. data/spec/ngrokapi/services/{endpoint_o_auth_module_client_spec.rb → edge_route_o_auth_module_client_spec.rb} +31 -17
  337. data/spec/ngrokapi/services/{endpoint_oidc_module_client_spec.rb → edge_route_oidc_module_client_spec.rb} +31 -17
  338. data/spec/ngrokapi/services/{endpoint_request_headers_module_client_spec.rb → edge_route_request_headers_module_client_spec.rb} +31 -17
  339. data/spec/ngrokapi/services/{endpoint_response_headers_module_client_spec.rb → edge_route_response_headers_module_client_spec.rb} +31 -17
  340. data/spec/ngrokapi/services/{endpoint_saml_module_client_spec.rb → edge_route_saml_module_client_spec.rb} +31 -17
  341. data/spec/ngrokapi/services/{endpoint_webhook_validation_module_client_spec.rb → edge_route_webhook_verification_module_client_spec.rb} +31 -17
  342. data/spec/ngrokapi/services/edge_route_websocket_tcp_converter_module_client_spec.rb +139 -0
  343. data/spec/ngrokapi/services/{event_streams_client_spec.rb → edges_https_client_spec.rb} +106 -108
  344. data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +241 -0
  345. data/spec/ngrokapi/services/edges_tcp_client_spec.rb +175 -0
  346. data/spec/ngrokapi/services/edges_tls_client_spec.rb +187 -0
  347. data/spec/ngrokapi/services/endpoints_client_spec.rb +57 -0
  348. data/spec/ngrokapi/services/failover_backends_client_spec.rb +163 -0
  349. data/spec/ngrokapi/services/http_response_backends_client_spec.rb +175 -0
  350. data/spec/ngrokapi/services/{endpoint_mutual_tls_module_client_spec.rb → https_edge_mutual_tls_module_client_spec.rb} +17 -17
  351. data/spec/ngrokapi/services/{endpoint_tls_termination_module_client_spec.rb → https_edge_tls_termination_module_client_spec.rb} +17 -17
  352. data/spec/ngrokapi/services/ip_policies_client_spec.rb +0 -1
  353. data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +3 -1
  354. data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +0 -44
  355. data/spec/ngrokapi/services/reserved_domains_client_spec.rb +0 -88
  356. data/spec/ngrokapi/services/{endpoint_logging_module_client_spec.rb → tcp_edge_backend_module_client_spec.rb} +40 -40
  357. data/spec/ngrokapi/services/{endpoint_ip_policy_module_client_spec.rb → tcp_edge_ip_restriction_module_client_spec.rb} +17 -17
  358. data/spec/ngrokapi/services/tls_edge_backend_module_client_spec.rb +125 -0
  359. data/spec/ngrokapi/services/tls_edge_ip_restriction_module_client_spec.rb +125 -0
  360. data/spec/ngrokapi/services/tls_edge_mutual_tls_module_client_spec.rb +125 -0
  361. data/spec/ngrokapi/services/tls_edge_tls_termination_module_client_spec.rb +125 -0
  362. data/spec/ngrokapi/services/tunnel_group_backends_client_spec.rb +163 -0
  363. data/spec/ngrokapi/services/tunnels_client_spec.rb +36 -0
  364. data/spec/ngrokapi/services/weighted_backends_client_spec.rb +163 -0
  365. data/spec/spec_helper.rb +326 -33
  366. metadata +166 -74
  367. data/lib/ngrokapi/services/endpoint_configurations_client.rb +0 -289
  368. data/lib/ngrokapi/services/event_streams_client.rb +0 -224
  369. data/spec/ngrokapi/models/endpoint_configuration_spec.rb +0 -78
  370. data/spec/ngrokapi/models/endpoint_logging_mutate_spec.rb +0 -21
  371. data/spec/ngrokapi/models/endpoint_logging_spec.rb +0 -21
  372. data/spec/ngrokapi/models/event_stream_spec.rb +0 -51
  373. data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +0 -237
@@ -0,0 +1,214 @@
1
+ # frozen_string_literal: true
2
+
3
+ module NgrokAPI
4
+ module Services
5
+ ##
6
+ # A Failover backend defines failover behavior within a list of referenced
7
+ # backends. Traffic is sent to the first backend in the list. If that backend
8
+ # is offline or no connection can be established, ngrok attempts to connect to
9
+ # the next backend in the list until one is successful.
10
+ #
11
+ # https://ngrok.com/docs/api#api-failover-backends
12
+ class FailoverBackendsClient
13
+ # The API path for the requests
14
+ PATH = '/backends/failover'
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 Failover 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 [List<string>] backends the ids of the child backends in order
30
+ # @return [NgrokAPI::Models::FailoverBackend] result from the API request
31
+ #
32
+ # https://ngrok.com/docs/api#api-failover-backends-create
33
+ def create(description: "", metadata: "", backends: [])
34
+ path = '/backends/failover'
35
+ replacements = {
36
+ }
37
+ data = {}
38
+ data[:description] = description if description
39
+ data[:metadata] = metadata if metadata
40
+ data[:backends] = backends if backends
41
+ result = @client.post(path % replacements, data: data)
42
+ NgrokAPI::Models::FailoverBackend.new(client: self, result: result)
43
+ end
44
+
45
+ ##
46
+ # Delete a Failover backend by ID. TODO what if used?
47
+ #
48
+ # @param [string] id a resource identifier
49
+ # @return [NgrokAPI::Models::Empty] result from the API request
50
+ #
51
+ # https://ngrok.com/docs/api#api-failover-backends-delete
52
+ def delete(id: "")
53
+ path = '/backends/failover/%{id}'
54
+ replacements = {
55
+ id: id,
56
+ }
57
+ @client.delete(path % replacements)
58
+ end
59
+
60
+ ##
61
+ # Delete a Failover backend by ID. TODO what if used?
62
+ # Throws an exception if API error.
63
+ #
64
+ # @param [string] id a resource identifier
65
+ # @return [NgrokAPI::Models::Empty] result from the API request
66
+ #
67
+ # https://ngrok.com/docs/api#api-failover-backends-delete
68
+ def delete!(id: "")
69
+ path = '/backends/failover/%{id}'
70
+ replacements = {
71
+ id: id,
72
+ }
73
+ @client.delete(path % replacements, danger: true)
74
+ end
75
+
76
+ ##
77
+ # Get detailed information about a Failover backend by ID
78
+ #
79
+ # @param [string] id a resource identifier
80
+ # @return [NgrokAPI::Models::FailoverBackend] result from the API request
81
+ #
82
+ # https://ngrok.com/docs/api#api-failover-backends-get
83
+ def get(id: "")
84
+ path = '/backends/failover/%{id}'
85
+ replacements = {
86
+ id: id,
87
+ }
88
+ data = {}
89
+ result = @client.get(path % replacements, data: data)
90
+ NgrokAPI::Models::FailoverBackend.new(client: self, result: result)
91
+ end
92
+
93
+ ##
94
+ # Get detailed information about a Failover backend by ID
95
+ # Throws an exception if API error.
96
+ #
97
+ # @param [string] id a resource identifier
98
+ # @return [NgrokAPI::Models::FailoverBackend] result from the API request
99
+ #
100
+ # https://ngrok.com/docs/api#api-failover-backends-get
101
+ def get!(id: "")
102
+ path = '/backends/failover/%{id}'
103
+ replacements = {
104
+ id: id,
105
+ }
106
+ data = {}
107
+ result = @client.get(path % replacements, data: data, danger: true)
108
+ NgrokAPI::Models::FailoverBackend.new(client: self, result: result)
109
+ end
110
+
111
+ ##
112
+ # List all Failover backends on this account
113
+ #
114
+ # @param [string] before_id
115
+ # @param [string] limit
116
+ # @param [string] url optional and mutually exclusive from before_id and limit
117
+ # @return [NgrokAPI::Models::Listable] result from the API request
118
+ #
119
+ # https://ngrok.com/docs/api#api-failover-backends-list
120
+ def list(before_id: nil, limit: nil,
121
+ url: nil)
122
+ result = @client.list(
123
+ before_id: before_id,
124
+ limit: limit,
125
+ url: url,
126
+ path: PATH
127
+ )
128
+
129
+ NgrokAPI::Models::Listable.new(
130
+ client: self,
131
+ result: result,
132
+ list_property: LIST_PROPERTY,
133
+ klass: NgrokAPI::Models::FailoverBackend
134
+ )
135
+ end
136
+
137
+ ##
138
+ # List all Failover backends on this account
139
+ # Throws an exception if API error.
140
+ #
141
+ # @param [string] before_id
142
+ # @param [string] limit
143
+ # @param [string] url optional and mutually exclusive from before_id and limit
144
+ # @return [NgrokAPI::Models::Listable] result from the API request
145
+ #
146
+ # https://ngrok.com/docs/api#api-failover-backends-list
147
+ def list!(before_id: nil, limit: nil,
148
+ url: nil)
149
+ result = @client.list(
150
+ before_id: before_id,
151
+ limit: limit,
152
+ danger: true,
153
+ url: url,
154
+ path: PATH
155
+ )
156
+
157
+ NgrokAPI::Models::Listable.new(
158
+ client: self,
159
+ result: result,
160
+ list_property: LIST_PROPERTY,
161
+ klass: NgrokAPI::Models::FailoverBackend,
162
+ danger: true
163
+ )
164
+ end
165
+
166
+ ##
167
+ # Update Failover backend by ID
168
+ #
169
+ # @param [string] id
170
+ # @param [string] description human-readable description of this backend. Optional
171
+ # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
172
+ # @param [List<string>] backends the ids of the child backends in order
173
+ # @return [NgrokAPI::Models::FailoverBackend] result from the API request
174
+ #
175
+ # https://ngrok.com/docs/api#api-failover-backends-update
176
+ def update(id: "", description: nil, metadata: nil, backends: [])
177
+ path = '/backends/failover/%{id}'
178
+ replacements = {
179
+ id: id,
180
+ }
181
+ data = {}
182
+ data[:description] = description if description
183
+ data[:metadata] = metadata if metadata
184
+ data[:backends] = backends if backends
185
+ result = @client.patch(path % replacements, data: data)
186
+ NgrokAPI::Models::FailoverBackend.new(client: self, result: result)
187
+ end
188
+
189
+ ##
190
+ # Update Failover backend by ID
191
+ # Throws an exception if API error.
192
+ #
193
+ # @param [string] id
194
+ # @param [string] description human-readable description of this backend. Optional
195
+ # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
196
+ # @param [List<string>] backends the ids of the child backends in order
197
+ # @return [NgrokAPI::Models::FailoverBackend] result from the API request
198
+ #
199
+ # https://ngrok.com/docs/api#api-failover-backends-update
200
+ def update!(id: "", description: nil, metadata: nil, backends: [])
201
+ path = '/backends/failover/%{id}'
202
+ replacements = {
203
+ id: id,
204
+ }
205
+ data = {}
206
+ data[:description] = description if description
207
+ data[:metadata] = metadata if metadata
208
+ data[:backends] = backends if backends
209
+ result = @client.patch(path % replacements, data: data, danger: true)
210
+ NgrokAPI::Models::FailoverBackend.new(client: self, result: result)
211
+ end
212
+ end
213
+ end
214
+ end
@@ -0,0 +1,199 @@
1
+ # frozen_string_literal: true
2
+
3
+ module NgrokAPI
4
+ module Services
5
+ ##
6
+ # https://ngrok.com/docs/api#api-http-response-backends
7
+ class HTTPResponseBackendsClient
8
+ # The API path for the requests
9
+ PATH = '/backends/http_response'
10
+ # The List Property from the resulting API for list calls
11
+ LIST_PROPERTY = 'backends'
12
+
13
+ attr_reader :client
14
+
15
+ def initialize(client:)
16
+ @client = client
17
+ end
18
+
19
+ ##
20
+ # @param [string] description human-readable description of this backend. Optional
21
+ # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
22
+ # @param [string] body body to return as fixed content
23
+ # @param [Map<string, string>] headers headers to return
24
+ # @param [int32] status_code status code to return
25
+ # @return [NgrokAPI::Models::HTTPResponseBackend] result from the API request
26
+ #
27
+ # https://ngrok.com/docs/api#api-http-response-backends-create
28
+ def create(description: "", metadata: "", body: "", headers: {}, status_code: nil)
29
+ path = '/backends/http_response'
30
+ replacements = {
31
+ }
32
+ data = {}
33
+ data[:description] = description if description
34
+ data[:metadata] = metadata if metadata
35
+ data[:body] = body if body
36
+ data[:headers] = headers if headers
37
+ data[:status_code] = status_code if status_code
38
+ result = @client.post(path % replacements, data: data)
39
+ NgrokAPI::Models::HTTPResponseBackend.new(client: self, result: result)
40
+ end
41
+
42
+ ##
43
+ # @param [string] id a resource identifier
44
+ # @return [NgrokAPI::Models::Empty] result from the API request
45
+ #
46
+ # https://ngrok.com/docs/api#api-http-response-backends-delete
47
+ def delete(id: "")
48
+ path = '/backends/http_response/%{id}'
49
+ replacements = {
50
+ id: id,
51
+ }
52
+ @client.delete(path % replacements)
53
+ end
54
+
55
+ ##
56
+ # @param [string] id a resource identifier
57
+ # @return [NgrokAPI::Models::Empty] result from the API request
58
+ #
59
+ # https://ngrok.com/docs/api#api-http-response-backends-delete
60
+ def delete!(id: "")
61
+ path = '/backends/http_response/%{id}'
62
+ replacements = {
63
+ id: id,
64
+ }
65
+ @client.delete(path % replacements, danger: true)
66
+ end
67
+
68
+ ##
69
+ # @param [string] id a resource identifier
70
+ # @return [NgrokAPI::Models::HTTPResponseBackend] result from the API request
71
+ #
72
+ # https://ngrok.com/docs/api#api-http-response-backends-get
73
+ def get(id: "")
74
+ path = '/backends/http_response/%{id}'
75
+ replacements = {
76
+ id: id,
77
+ }
78
+ data = {}
79
+ result = @client.get(path % replacements, data: data)
80
+ NgrokAPI::Models::HTTPResponseBackend.new(client: self, result: result)
81
+ end
82
+
83
+ ##
84
+ # @param [string] id a resource identifier
85
+ # @return [NgrokAPI::Models::HTTPResponseBackend] result from the API request
86
+ #
87
+ # https://ngrok.com/docs/api#api-http-response-backends-get
88
+ def get!(id: "")
89
+ path = '/backends/http_response/%{id}'
90
+ replacements = {
91
+ id: id,
92
+ }
93
+ data = {}
94
+ result = @client.get(path % replacements, data: data, danger: true)
95
+ NgrokAPI::Models::HTTPResponseBackend.new(client: self, result: result)
96
+ end
97
+
98
+ ##
99
+ # @param [string] before_id
100
+ # @param [string] limit
101
+ # @param [string] url optional and mutually exclusive from before_id and limit
102
+ # @return [NgrokAPI::Models::Listable] result from the API request
103
+ #
104
+ # https://ngrok.com/docs/api#api-http-response-backends-list
105
+ def list(before_id: nil, limit: nil,
106
+ url: nil)
107
+ result = @client.list(
108
+ before_id: before_id,
109
+ limit: limit,
110
+ url: url,
111
+ path: PATH
112
+ )
113
+
114
+ NgrokAPI::Models::Listable.new(
115
+ client: self,
116
+ result: result,
117
+ list_property: LIST_PROPERTY,
118
+ klass: NgrokAPI::Models::HTTPResponseBackend
119
+ )
120
+ end
121
+
122
+ ##
123
+ # @param [string] before_id
124
+ # @param [string] limit
125
+ # @param [string] url optional and mutually exclusive from before_id and limit
126
+ # @return [NgrokAPI::Models::Listable] result from the API request
127
+ #
128
+ # https://ngrok.com/docs/api#api-http-response-backends-list
129
+ def list!(before_id: nil, limit: nil,
130
+ url: nil)
131
+ result = @client.list(
132
+ before_id: before_id,
133
+ limit: limit,
134
+ danger: true,
135
+ url: url,
136
+ path: PATH
137
+ )
138
+
139
+ NgrokAPI::Models::Listable.new(
140
+ client: self,
141
+ result: result,
142
+ list_property: LIST_PROPERTY,
143
+ klass: NgrokAPI::Models::HTTPResponseBackend,
144
+ danger: true
145
+ )
146
+ end
147
+
148
+ ##
149
+ # @param [string] id
150
+ # @param [string] description human-readable description of this backend. Optional
151
+ # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
152
+ # @param [string] body body to return as fixed content
153
+ # @param [Map<string, string>] headers headers to return
154
+ # @param [int32] status_code status code to return
155
+ # @return [NgrokAPI::Models::HTTPResponseBackend] result from the API request
156
+ #
157
+ # https://ngrok.com/docs/api#api-http-response-backends-update
158
+ def update(id: "", description: nil, metadata: nil, body: nil, headers: nil, status_code: nil)
159
+ path = '/backends/http_response/%{id}'
160
+ replacements = {
161
+ id: id,
162
+ }
163
+ data = {}
164
+ data[:description] = description if description
165
+ data[:metadata] = metadata if metadata
166
+ data[:body] = body if body
167
+ data[:headers] = headers if headers
168
+ data[:status_code] = status_code if status_code
169
+ result = @client.patch(path % replacements, data: data)
170
+ NgrokAPI::Models::HTTPResponseBackend.new(client: self, result: result)
171
+ end
172
+
173
+ ##
174
+ # @param [string] id
175
+ # @param [string] description human-readable description of this backend. Optional
176
+ # @param [string] metadata arbitrary user-defined machine-readable data of this backend. Optional
177
+ # @param [string] body body to return as fixed content
178
+ # @param [Map<string, string>] headers headers to return
179
+ # @param [int32] status_code status code to return
180
+ # @return [NgrokAPI::Models::HTTPResponseBackend] result from the API request
181
+ #
182
+ # https://ngrok.com/docs/api#api-http-response-backends-update
183
+ def update!(id: "", description: nil, metadata: nil, body: nil, headers: nil, status_code: nil)
184
+ path = '/backends/http_response/%{id}'
185
+ replacements = {
186
+ id: id,
187
+ }
188
+ data = {}
189
+ data[:description] = description if description
190
+ data[:metadata] = metadata if metadata
191
+ data[:body] = body if body
192
+ data[:headers] = headers if headers
193
+ data[:status_code] = status_code if status_code
194
+ result = @client.patch(path % replacements, data: data, danger: true)
195
+ NgrokAPI::Models::HTTPResponseBackend.new(client: self, result: result)
196
+ end
197
+ end
198
+ end
199
+ end
@@ -3,10 +3,10 @@
3
3
  module NgrokAPI
4
4
  module Services
5
5
  ##
6
- # https://ngrok.com/docs/api#api-endpoint-saml-module
7
- class EndpointSAMLModuleClient
6
+ # https://ngrok.com/docs/api#api-https-edge-mutual-tls-module
7
+ class HTTPSEdgeMutualTLSModuleClient
8
8
  # The API path for the requests
9
- PATH = '/endpoint_configurations/%{id}/saml'
9
+ PATH = '/edges/https/%{id}/mutual_tls'
10
10
 
11
11
  attr_reader :client
12
12
 
@@ -16,75 +16,75 @@ module NgrokAPI
16
16
 
17
17
  ##
18
18
  # @param [string] id
19
- # @param [EndpointSAMLMutate] a_module
20
- # @return [NgrokAPI::Models::EndpointSAML] result from the API request
19
+ # @param [EndpointMutualTLSMutate] a_module
20
+ # @return [NgrokAPI::Models::EndpointMutualTLS] result from the API request
21
21
  #
22
- # https://ngrok.com/docs/api#api-endpoint-saml-module-replace
22
+ # https://ngrok.com/docs/api#api-https-edge-mutual-tls-module-replace
23
23
  def replace(id: "", a_module: nil)
24
- path = '/endpoint_configurations/%{id}/saml'
24
+ path = '/edges/https/%{id}/mutual_tls'
25
25
  replacements = {
26
26
  id: id,
27
27
  }
28
28
  data = {}
29
29
  data[:module] = a_module if a_module
30
30
  result = @client.put(path % replacements, data: data)
31
- NgrokAPI::Models::EndpointSAML.new(client: self, result: result)
31
+ NgrokAPI::Models::EndpointMutualTLS.new(client: self, result: result)
32
32
  end
33
33
 
34
34
  ##
35
35
  # @param [string] id
36
- # @param [EndpointSAMLMutate] a_module
37
- # @return [NgrokAPI::Models::EndpointSAML] result from the API request
36
+ # @param [EndpointMutualTLSMutate] a_module
37
+ # @return [NgrokAPI::Models::EndpointMutualTLS] result from the API request
38
38
  #
39
- # https://ngrok.com/docs/api#api-endpoint-saml-module-replace
39
+ # https://ngrok.com/docs/api#api-https-edge-mutual-tls-module-replace
40
40
  def replace!(id: "", a_module: nil)
41
- path = '/endpoint_configurations/%{id}/saml'
41
+ path = '/edges/https/%{id}/mutual_tls'
42
42
  replacements = {
43
43
  id: id,
44
44
  }
45
45
  data = {}
46
46
  data[:module] = a_module if a_module
47
47
  result = @client.put(path % replacements, data: data, danger: true)
48
- NgrokAPI::Models::EndpointSAML.new(client: self, result: result)
48
+ NgrokAPI::Models::EndpointMutualTLS.new(client: self, result: result)
49
49
  end
50
50
 
51
51
  ##
52
52
  # @param [string] id a resource identifier
53
- # @return [NgrokAPI::Models::EndpointSAML] result from the API request
53
+ # @return [NgrokAPI::Models::EndpointMutualTLS] result from the API request
54
54
  #
55
- # https://ngrok.com/docs/api#api-endpoint-saml-module-get
55
+ # https://ngrok.com/docs/api#api-https-edge-mutual-tls-module-get
56
56
  def get(id: "")
57
- path = '/endpoint_configurations/%{id}/saml'
57
+ path = '/edges/https/%{id}/mutual_tls'
58
58
  replacements = {
59
59
  id: id,
60
60
  }
61
61
  data = {}
62
62
  result = @client.get(path % replacements, data: data)
63
- NgrokAPI::Models::EndpointSAML.new(client: self, result: result)
63
+ NgrokAPI::Models::EndpointMutualTLS.new(client: self, result: result)
64
64
  end
65
65
 
66
66
  ##
67
67
  # @param [string] id a resource identifier
68
- # @return [NgrokAPI::Models::EndpointSAML] result from the API request
68
+ # @return [NgrokAPI::Models::EndpointMutualTLS] result from the API request
69
69
  #
70
- # https://ngrok.com/docs/api#api-endpoint-saml-module-get
70
+ # https://ngrok.com/docs/api#api-https-edge-mutual-tls-module-get
71
71
  def get!(id: "")
72
- path = '/endpoint_configurations/%{id}/saml'
72
+ path = '/edges/https/%{id}/mutual_tls'
73
73
  replacements = {
74
74
  id: id,
75
75
  }
76
76
  data = {}
77
77
  result = @client.get(path % replacements, data: data, danger: true)
78
- NgrokAPI::Models::EndpointSAML.new(client: self, result: result)
78
+ NgrokAPI::Models::EndpointMutualTLS.new(client: self, result: result)
79
79
  end
80
80
 
81
81
  ##
82
82
  # @param [string] id a resource identifier
83
83
  # @return [NgrokAPI::Models::Empty] result from the API request
84
84
  #
85
- # https://ngrok.com/docs/api#api-endpoint-saml-module-delete
85
+ # https://ngrok.com/docs/api#api-https-edge-mutual-tls-module-delete
86
86
  def delete(id: "")
87
- path = '/endpoint_configurations/%{id}/saml'
87
+ path = '/edges/https/%{id}/mutual_tls'
88
88
  replacements = {
89
89
  id: id,
90
90
  }
@@ -95,9 +95,9 @@ module NgrokAPI
95
95
  # @param [string] id a resource identifier
96
96
  # @return [NgrokAPI::Models::Empty] result from the API request
97
97
  #
98
- # https://ngrok.com/docs/api#api-endpoint-saml-module-delete
98
+ # https://ngrok.com/docs/api#api-https-edge-mutual-tls-module-delete
99
99
  def delete!(id: "")
100
- path = '/endpoint_configurations/%{id}/saml'
100
+ path = '/edges/https/%{id}/mutual_tls'
101
101
  replacements = {
102
102
  id: id,
103
103
  }
@@ -3,10 +3,10 @@
3
3
  module NgrokAPI
4
4
  module Services
5
5
  ##
6
- # https://ngrok.com/docs/api#api-endpoint-request-headers-module
7
- class EndpointRequestHeadersModuleClient
6
+ # https://ngrok.com/docs/api#api-https-edge-tls-termination-module
7
+ class HTTPSEdgeTLSTerminationModuleClient
8
8
  # The API path for the requests
9
- PATH = '/endpoint_configurations/%{id}/request_headers'
9
+ PATH = '/edges/https/%{id}/tls_termination'
10
10
 
11
11
  attr_reader :client
12
12
 
@@ -16,75 +16,75 @@ module NgrokAPI
16
16
 
17
17
  ##
18
18
  # @param [string] id
19
- # @param [EndpointRequestHeaders] a_module
20
- # @return [NgrokAPI::Models::EndpointRequestHeaders] result from the API request
19
+ # @param [EndpointTLSTerminationAtEdge] a_module
20
+ # @return [NgrokAPI::Models::EndpointTLSTermination] result from the API request
21
21
  #
22
- # https://ngrok.com/docs/api#api-endpoint-request-headers-module-replace
22
+ # https://ngrok.com/docs/api#api-https-edge-tls-termination-module-replace
23
23
  def replace(id: "", a_module: nil)
24
- path = '/endpoint_configurations/%{id}/request_headers'
24
+ path = '/edges/https/%{id}/tls_termination'
25
25
  replacements = {
26
26
  id: id,
27
27
  }
28
28
  data = {}
29
29
  data[:module] = a_module if a_module
30
30
  result = @client.put(path % replacements, data: data)
31
- NgrokAPI::Models::EndpointRequestHeaders.new(client: self, result: result)
31
+ NgrokAPI::Models::EndpointTLSTermination.new(client: self, result: result)
32
32
  end
33
33
 
34
34
  ##
35
35
  # @param [string] id
36
- # @param [EndpointRequestHeaders] a_module
37
- # @return [NgrokAPI::Models::EndpointRequestHeaders] result from the API request
36
+ # @param [EndpointTLSTerminationAtEdge] a_module
37
+ # @return [NgrokAPI::Models::EndpointTLSTermination] result from the API request
38
38
  #
39
- # https://ngrok.com/docs/api#api-endpoint-request-headers-module-replace
39
+ # https://ngrok.com/docs/api#api-https-edge-tls-termination-module-replace
40
40
  def replace!(id: "", a_module: nil)
41
- path = '/endpoint_configurations/%{id}/request_headers'
41
+ path = '/edges/https/%{id}/tls_termination'
42
42
  replacements = {
43
43
  id: id,
44
44
  }
45
45
  data = {}
46
46
  data[:module] = a_module if a_module
47
47
  result = @client.put(path % replacements, data: data, danger: true)
48
- NgrokAPI::Models::EndpointRequestHeaders.new(client: self, result: result)
48
+ NgrokAPI::Models::EndpointTLSTermination.new(client: self, result: result)
49
49
  end
50
50
 
51
51
  ##
52
52
  # @param [string] id a resource identifier
53
- # @return [NgrokAPI::Models::EndpointRequestHeaders] result from the API request
53
+ # @return [NgrokAPI::Models::EndpointTLSTermination] result from the API request
54
54
  #
55
- # https://ngrok.com/docs/api#api-endpoint-request-headers-module-get
55
+ # https://ngrok.com/docs/api#api-https-edge-tls-termination-module-get
56
56
  def get(id: "")
57
- path = '/endpoint_configurations/%{id}/request_headers'
57
+ path = '/edges/https/%{id}/tls_termination'
58
58
  replacements = {
59
59
  id: id,
60
60
  }
61
61
  data = {}
62
62
  result = @client.get(path % replacements, data: data)
63
- NgrokAPI::Models::EndpointRequestHeaders.new(client: self, result: result)
63
+ NgrokAPI::Models::EndpointTLSTermination.new(client: self, result: result)
64
64
  end
65
65
 
66
66
  ##
67
67
  # @param [string] id a resource identifier
68
- # @return [NgrokAPI::Models::EndpointRequestHeaders] result from the API request
68
+ # @return [NgrokAPI::Models::EndpointTLSTermination] result from the API request
69
69
  #
70
- # https://ngrok.com/docs/api#api-endpoint-request-headers-module-get
70
+ # https://ngrok.com/docs/api#api-https-edge-tls-termination-module-get
71
71
  def get!(id: "")
72
- path = '/endpoint_configurations/%{id}/request_headers'
72
+ path = '/edges/https/%{id}/tls_termination'
73
73
  replacements = {
74
74
  id: id,
75
75
  }
76
76
  data = {}
77
77
  result = @client.get(path % replacements, data: data, danger: true)
78
- NgrokAPI::Models::EndpointRequestHeaders.new(client: self, result: result)
78
+ NgrokAPI::Models::EndpointTLSTermination.new(client: self, result: result)
79
79
  end
80
80
 
81
81
  ##
82
82
  # @param [string] id a resource identifier
83
83
  # @return [NgrokAPI::Models::Empty] result from the API request
84
84
  #
85
- # https://ngrok.com/docs/api#api-endpoint-request-headers-module-delete
85
+ # https://ngrok.com/docs/api#api-https-edge-tls-termination-module-delete
86
86
  def delete(id: "")
87
- path = '/endpoint_configurations/%{id}/request_headers'
87
+ path = '/edges/https/%{id}/tls_termination'
88
88
  replacements = {
89
89
  id: id,
90
90
  }
@@ -95,9 +95,9 @@ module NgrokAPI
95
95
  # @param [string] id a resource identifier
96
96
  # @return [NgrokAPI::Models::Empty] result from the API request
97
97
  #
98
- # https://ngrok.com/docs/api#api-endpoint-request-headers-module-delete
98
+ # https://ngrok.com/docs/api#api-https-edge-tls-termination-module-delete
99
99
  def delete!(id: "")
100
- path = '/endpoint_configurations/%{id}/request_headers'
100
+ path = '/edges/https/%{id}/tls_termination'
101
101
  replacements = {
102
102
  id: id,
103
103
  }
@@ -27,18 +27,16 @@ module NgrokAPI
27
27
  #
28
28
  # @param [string] description human-readable description of the source IPs of this IP policy. optional, max 255 bytes.
29
29
  # @param [string] metadata arbitrary user-defined machine-readable data of this IP policy. optional, max 4096 bytes.
30
- # @param [string] action the IP policy action. Supported values are ``allow`` or ``deny``
31
30
  # @return [NgrokAPI::Models::IPPolicy] result from the API request
32
31
  #
33
32
  # https://ngrok.com/docs/api#api-ip-policies-create
34
- def create(description: "", metadata: "", action:)
33
+ def create(description: "", metadata: "", action: nil)
35
34
  path = '/ip_policies'
36
35
  replacements = {
37
36
  }
38
37
  data = {}
39
38
  data[:description] = description if description
40
39
  data[:metadata] = metadata if metadata
41
- data[:action] = action if action
42
40
  result = @client.post(path % replacements, data: data)
43
41
  NgrokAPI::Models::IPPolicy.new(client: self, result: result)
44
42
  end