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
@@ -6,7 +6,7 @@
6
6
  <title>
7
7
  Class: NgrokAPI::Services::EdgesTCPClient
8
8
 
9
- &mdash; Documentation by YARD 0.9.34
9
+ &mdash; Documentation by YARD 0.9.36
10
10
 
11
11
  </title>
12
12
 
@@ -205,7 +205,7 @@
205
205
  <li class="public ">
206
206
  <span class="summary_signature">
207
207
 
208
- <a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: &quot;&quot;, metadata: &quot;&quot;, hostports: nil, backend: nil, ip_restriction: nil) &#x21d2; NgrokAPI::Models::TCPEdge </a>
208
+ <a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: &quot;&quot;, metadata: &quot;&quot;, hostports: nil, backend: nil, ip_restriction: nil, policy: nil) &#x21d2; NgrokAPI::Models::TCPEdge </a>
209
209
 
210
210
 
211
211
 
@@ -229,7 +229,7 @@
229
229
  <li class="public ">
230
230
  <span class="summary_signature">
231
231
 
232
- <a href="#create!-instance_method" title="#create! (instance method)">#<strong>create!</strong>(description: &quot;&quot;, metadata: &quot;&quot;, hostports: nil, backend: nil, ip_restriction: nil) &#x21d2; NgrokAPI::Models::TCPEdge </a>
232
+ <a href="#create!-instance_method" title="#create! (instance method)">#<strong>create!</strong>(description: &quot;&quot;, metadata: &quot;&quot;, hostports: nil, backend: nil, ip_restriction: nil, policy: nil) &#x21d2; NgrokAPI::Models::TCPEdge </a>
233
233
 
234
234
 
235
235
 
@@ -423,7 +423,7 @@
423
423
  <li class="public ">
424
424
  <span class="summary_signature">
425
425
 
426
- <a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: &quot;&quot;, description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil) &#x21d2; NgrokAPI::Models::TCPEdge </a>
426
+ <a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: &quot;&quot;, description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, policy: nil) &#x21d2; NgrokAPI::Models::TCPEdge </a>
427
427
 
428
428
 
429
429
 
@@ -447,7 +447,7 @@
447
447
  <li class="public ">
448
448
  <span class="summary_signature">
449
449
 
450
- <a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: &quot;&quot;, description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil) &#x21d2; NgrokAPI::Models::TCPEdge </a>
450
+ <a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: &quot;&quot;, description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, policy: nil) &#x21d2; NgrokAPI::Models::TCPEdge </a>
451
451
 
452
452
 
453
453
 
@@ -573,7 +573,7 @@
573
573
  <div class="method_details first">
574
574
  <h3 class="signature first" id="create-instance_method">
575
575
 
576
- #<strong>create</strong>(description: &quot;&quot;, metadata: &quot;&quot;, hostports: nil, backend: nil, ip_restriction: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">NgrokAPI::Models::TCPEdge</a></span></tt>
576
+ #<strong>create</strong>(description: &quot;&quot;, metadata: &quot;&quot;, hostports: nil, backend: nil, ip_restriction: nil, policy: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">NgrokAPI::Models::TCPEdge</a></span></tt>
577
577
 
578
578
 
579
579
 
@@ -678,6 +678,24 @@
678
678
 
679
679
  </li>
680
680
 
681
+ <li>
682
+
683
+ <span class='name'>policy</span>
684
+
685
+
686
+ <span class='type'>(<tt>EndpointPolicy</tt>)</span>
687
+
688
+
689
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
690
+
691
+
692
+ &mdash;
693
+ <div class='inline'>
694
+ <p>the traffic policy associated with this edge or null</p>
695
+ </div>
696
+
697
+ </li>
698
+
681
699
  </ul>
682
700
 
683
701
  <p class="tag_title">Returns:</p>
@@ -705,7 +723,6 @@
705
723
  <pre class="lines">
706
724
 
707
725
 
708
- 32
709
726
  33
710
727
  34
711
728
  35
@@ -717,12 +734,14 @@
717
734
  41
718
735
  42
719
736
  43
720
- 44</pre>
737
+ 44
738
+ 45
739
+ 46</pre>
721
740
  </td>
722
741
  <td>
723
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 32</span>
742
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 33</span>
724
743
 
725
- <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>hostports:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
744
+ <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>hostports:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>policy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
726
745
  <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/edges/tcp</span><span class='tstring_end'>&#39;</span></span>
727
746
  <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
728
747
  <span class='rbrace'>}</span>
@@ -732,6 +751,7 @@
732
751
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:hostports</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_hostports'>hostports</span> <span class='kw'>if</span> <span class='id identifier rubyid_hostports'>hostports</span>
733
752
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:backend</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_backend'>backend</span> <span class='kw'>if</span> <span class='id identifier rubyid_backend'>backend</span>
734
753
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ip_restriction</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span> <span class='kw'>if</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span>
754
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_policy'>policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_policy'>policy</span>
735
755
  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
736
756
  <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">TCPEdge</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TCPEdge.html#initialize-instance_method" title="NgrokAPI::Models::TCPEdge#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
737
757
  <span class='kw'>end</span></pre>
@@ -743,7 +763,7 @@
743
763
  <div class="method_details ">
744
764
  <h3 class="signature " id="create!-instance_method">
745
765
 
746
- #<strong>create!</strong>(description: &quot;&quot;, metadata: &quot;&quot;, hostports: nil, backend: nil, ip_restriction: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">NgrokAPI::Models::TCPEdge</a></span></tt>
766
+ #<strong>create!</strong>(description: &quot;&quot;, metadata: &quot;&quot;, hostports: nil, backend: nil, ip_restriction: nil, policy: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">NgrokAPI::Models::TCPEdge</a></span></tt>
747
767
 
748
768
 
749
769
 
@@ -848,6 +868,24 @@
848
868
 
849
869
  </li>
850
870
 
871
+ <li>
872
+
873
+ <span class='name'>policy</span>
874
+
875
+
876
+ <span class='type'>(<tt>EndpointPolicy</tt>)</span>
877
+
878
+
879
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
880
+
881
+
882
+ &mdash;
883
+ <div class='inline'>
884
+ <p>the traffic policy associated with this edge or null</p>
885
+ </div>
886
+
887
+ </li>
888
+
851
889
  </ul>
852
890
 
853
891
  <p class="tag_title">Returns:</p>
@@ -875,9 +913,6 @@
875
913
  <pre class="lines">
876
914
 
877
915
 
878
- 58
879
- 59
880
- 60
881
916
  61
882
917
  62
883
918
  63
@@ -887,12 +922,16 @@
887
922
  67
888
923
  68
889
924
  69
890
- 70</pre>
925
+ 70
926
+ 71
927
+ 72
928
+ 73
929
+ 74</pre>
891
930
  </td>
892
931
  <td>
893
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 58</span>
932
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 61</span>
894
933
 
895
- <span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>hostports:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
934
+ <span class='kw'>def</span> <span class='id identifier rubyid_create!'>create!</span><span class='lparen'>(</span><span class='label'>description:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>hostports:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>policy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
896
935
  <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/edges/tcp</span><span class='tstring_end'>&#39;</span></span>
897
936
  <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
898
937
  <span class='rbrace'>}</span>
@@ -902,6 +941,7 @@
902
941
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:hostports</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_hostports'>hostports</span> <span class='kw'>if</span> <span class='id identifier rubyid_hostports'>hostports</span>
903
942
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:backend</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_backend'>backend</span> <span class='kw'>if</span> <span class='id identifier rubyid_backend'>backend</span>
904
943
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ip_restriction</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span> <span class='kw'>if</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span>
944
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_policy'>policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_policy'>policy</span>
905
945
  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
906
946
  <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">TCPEdge</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TCPEdge.html#initialize-instance_method" title="NgrokAPI::Models::TCPEdge#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
907
947
  <span class='kw'>end</span></pre>
@@ -978,16 +1018,16 @@
978
1018
  <pre class="lines">
979
1019
 
980
1020
 
981
- 228
982
- 229
983
- 230
984
- 231
985
- 232
986
- 233
987
- 234</pre>
1021
+ 236
1022
+ 237
1023
+ 238
1024
+ 239
1025
+ 240
1026
+ 241
1027
+ 242</pre>
988
1028
  </td>
989
1029
  <td>
990
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 228</span>
1030
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 236</span>
991
1031
 
992
1032
  <span class='kw'>def</span> <span class='id identifier rubyid_delete'>delete</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
993
1033
  <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/edges/tcp/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -1069,16 +1109,16 @@
1069
1109
  <pre class="lines">
1070
1110
 
1071
1111
 
1072
- 244
1073
- 245
1074
- 246
1075
- 247
1076
- 248
1077
- 249
1078
- 250</pre>
1112
+ 252
1113
+ 253
1114
+ 254
1115
+ 255
1116
+ 256
1117
+ 257
1118
+ 258</pre>
1079
1119
  </td>
1080
1120
  <td>
1081
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 244</span>
1121
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 252</span>
1082
1122
 
1083
1123
  <span class='kw'>def</span> <span class='id identifier rubyid_delete!'>delete!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
1084
1124
  <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/edges/tcp/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -1160,18 +1200,18 @@
1160
1200
  <pre class="lines">
1161
1201
 
1162
1202
 
1163
- 79
1164
- 80
1165
- 81
1166
- 82
1167
1203
  83
1168
1204
  84
1169
1205
  85
1170
1206
  86
1171
- 87</pre>
1207
+ 87
1208
+ 88
1209
+ 89
1210
+ 90
1211
+ 91</pre>
1172
1212
  </td>
1173
1213
  <td>
1174
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 79</span>
1214
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 83</span>
1175
1215
 
1176
1216
  <span class='kw'>def</span> <span class='id identifier rubyid_get'>get</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
1177
1217
  <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/edges/tcp/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -1255,18 +1295,18 @@
1255
1295
  <pre class="lines">
1256
1296
 
1257
1297
 
1258
- 97
1259
- 98
1260
- 99
1261
- 100
1262
1298
  101
1263
1299
  102
1264
1300
  103
1265
1301
  104
1266
- 105</pre>
1302
+ 105
1303
+ 106
1304
+ 107
1305
+ 108
1306
+ 109</pre>
1267
1307
  </td>
1268
1308
  <td>
1269
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 97</span>
1309
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 101</span>
1270
1310
 
1271
1311
  <span class='kw'>def</span> <span class='id identifier rubyid_get!'>get!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>
1272
1312
  <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/edges/tcp/%{id}</span><span class='tstring_end'>&#39;</span></span>
@@ -1376,10 +1416,6 @@
1376
1416
  <pre class="lines">
1377
1417
 
1378
1418
 
1379
- 116
1380
- 117
1381
- 118
1382
- 119
1383
1419
  120
1384
1420
  121
1385
1421
  122
@@ -1390,10 +1426,14 @@
1390
1426
  127
1391
1427
  128
1392
1428
  129
1393
- 130</pre>
1429
+ 130
1430
+ 131
1431
+ 132
1432
+ 133
1433
+ 134</pre>
1394
1434
  </td>
1395
1435
  <td>
1396
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 116</span>
1436
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 120</span>
1397
1437
 
1398
1438
  <span class='kw'>def</span> <span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1399
1439
  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
@@ -1509,10 +1549,6 @@
1509
1549
  <pre class="lines">
1510
1550
 
1511
1551
 
1512
- 142
1513
- 143
1514
- 144
1515
- 145
1516
1552
  146
1517
1553
  147
1518
1554
  148
@@ -1525,10 +1561,14 @@
1525
1561
  155
1526
1562
  156
1527
1563
  157
1528
- 158</pre>
1564
+ 158
1565
+ 159
1566
+ 160
1567
+ 161
1568
+ 162</pre>
1529
1569
  </td>
1530
1570
  <td>
1531
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 142</span>
1571
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 146</span>
1532
1572
 
1533
1573
  <span class='kw'>def</span> <span class='id identifier rubyid_list!'>list!</span><span class='lparen'>(</span><span class='label'>before_id:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>limit:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1534
1574
  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_list'>list</span><span class='lparen'>(</span>
@@ -1555,7 +1595,7 @@
1555
1595
  <div class="method_details ">
1556
1596
  <h3 class="signature " id="update-instance_method">
1557
1597
 
1558
- #<strong>update</strong>(id: &quot;&quot;, description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">NgrokAPI::Models::TCPEdge</a></span></tt>
1598
+ #<strong>update</strong>(id: &quot;&quot;, description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, policy: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">NgrokAPI::Models::TCPEdge</a></span></tt>
1559
1599
 
1560
1600
 
1561
1601
 
@@ -1678,6 +1718,24 @@
1678
1718
 
1679
1719
  </li>
1680
1720
 
1721
+ <li>
1722
+
1723
+ <span class='name'>policy</span>
1724
+
1725
+
1726
+ <span class='type'>(<tt>EndpointPolicy</tt>)</span>
1727
+
1728
+
1729
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1730
+
1731
+
1732
+ &mdash;
1733
+ <div class='inline'>
1734
+ <p>the traffic policy associated with this edge or null</p>
1735
+ </div>
1736
+
1737
+ </li>
1738
+
1681
1739
  </ul>
1682
1740
 
1683
1741
  <p class="tag_title">Returns:</p>
@@ -1705,11 +1763,6 @@
1705
1763
  <pre class="lines">
1706
1764
 
1707
1765
 
1708
- 175
1709
- 176
1710
- 177
1711
- 178
1712
- 179
1713
1766
  180
1714
1767
  181
1715
1768
  182
@@ -1718,12 +1771,18 @@
1718
1771
  185
1719
1772
  186
1720
1773
  187
1721
- 188</pre>
1774
+ 188
1775
+ 189
1776
+ 190
1777
+ 191
1778
+ 192
1779
+ 193
1780
+ 194</pre>
1722
1781
  </td>
1723
1782
  <td>
1724
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 175</span>
1783
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 180</span>
1725
1784
 
1726
- <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>hostports:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1785
+ <span class='kw'>def</span> <span class='id identifier rubyid_update'>update</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>hostports:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>policy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1727
1786
  <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/edges/tcp/%{id}</span><span class='tstring_end'>&#39;</span></span>
1728
1787
  <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1729
1788
  <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
@@ -1734,6 +1793,7 @@
1734
1793
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:hostports</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_hostports'>hostports</span> <span class='kw'>if</span> <span class='id identifier rubyid_hostports'>hostports</span>
1735
1794
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:backend</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_backend'>backend</span> <span class='kw'>if</span> <span class='id identifier rubyid_backend'>backend</span>
1736
1795
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ip_restriction</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span> <span class='kw'>if</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span>
1796
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_policy'>policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_policy'>policy</span>
1737
1797
  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span>
1738
1798
  <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">TCPEdge</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TCPEdge.html#initialize-instance_method" title="NgrokAPI::Models::TCPEdge#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1739
1799
  <span class='kw'>end</span></pre>
@@ -1745,7 +1805,7 @@
1745
1805
  <div class="method_details ">
1746
1806
  <h3 class="signature " id="update!-instance_method">
1747
1807
 
1748
- #<strong>update!</strong>(id: &quot;&quot;, description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">NgrokAPI::Models::TCPEdge</a></span></tt>
1808
+ #<strong>update!</strong>(id: &quot;&quot;, description: nil, metadata: nil, hostports: nil, backend: nil, ip_restriction: nil, policy: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">NgrokAPI::Models::TCPEdge</a></span></tt>
1749
1809
 
1750
1810
 
1751
1811
 
@@ -1868,6 +1928,24 @@
1868
1928
 
1869
1929
  </li>
1870
1930
 
1931
+ <li>
1932
+
1933
+ <span class='name'>policy</span>
1934
+
1935
+
1936
+ <span class='type'>(<tt>EndpointPolicy</tt>)</span>
1937
+
1938
+
1939
+ <em class="default">(defaults to: <tt>nil</tt>)</em>
1940
+
1941
+
1942
+ &mdash;
1943
+ <div class='inline'>
1944
+ <p>the traffic policy associated with this edge or null</p>
1945
+ </div>
1946
+
1947
+ </li>
1948
+
1871
1949
  </ul>
1872
1950
 
1873
1951
  <p class="tag_title">Returns:</p>
@@ -1895,25 +1973,26 @@
1895
1973
  <pre class="lines">
1896
1974
 
1897
1975
 
1898
- 206
1899
- 207
1900
- 208
1901
- 209
1902
- 210
1903
- 211
1904
- 212
1905
1976
  213
1906
1977
  214
1907
1978
  215
1908
1979
  216
1909
1980
  217
1910
1981
  218
1911
- 219</pre>
1982
+ 219
1983
+ 220
1984
+ 221
1985
+ 222
1986
+ 223
1987
+ 224
1988
+ 225
1989
+ 226
1990
+ 227</pre>
1912
1991
  </td>
1913
1992
  <td>
1914
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 206</span>
1993
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/edges_tcp_client.rb', line 213</span>
1915
1994
 
1916
- <span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>hostports:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1995
+ <span class='kw'>def</span> <span class='id identifier rubyid_update!'>update!</span><span class='lparen'>(</span><span class='label'>id:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>hostports:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>backend:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>ip_restriction:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>policy:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1917
1996
  <span class='id identifier rubyid_path'>path</span> <span class='op'>=</span> <span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/edges/tcp/%{id}</span><span class='tstring_end'>&#39;</span></span>
1918
1997
  <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1919
1998
  <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
@@ -1924,6 +2003,7 @@
1924
2003
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:hostports</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_hostports'>hostports</span> <span class='kw'>if</span> <span class='id identifier rubyid_hostports'>hostports</span>
1925
2004
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:backend</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_backend'>backend</span> <span class='kw'>if</span> <span class='id identifier rubyid_backend'>backend</span>
1926
2005
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:ip_restriction</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span> <span class='kw'>if</span> <span class='id identifier rubyid_ip_restriction'>ip_restriction</span>
2006
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:policy</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_policy'>policy</span> <span class='kw'>if</span> <span class='id identifier rubyid_policy'>policy</span>
1927
2007
  <span class='id identifier rubyid_result'>result</span> <span class='op'>=</span> <span class='ivar'>@client</span><span class='period'>.</span><span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span> <span class='op'>%</span> <span class='id identifier rubyid_replacements'>replacements</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>true</span><span class='rparen'>)</span>
1928
2008
  <span class='const'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models.html" title="NgrokAPI::Models (module)">Models</a></span></span><span class='op'>::</span><span class='const'><span class='object_link'><a href="../Models/TCPEdge.html" title="NgrokAPI::Models::TCPEdge (class)">TCPEdge</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/TCPEdge.html#initialize-instance_method" title="NgrokAPI::Models::TCPEdge#initialize (method)">new</a></span></span><span class='lparen'>(</span><span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span> <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1929
2009
  <span class='kw'>end</span></pre>
@@ -1937,9 +2017,9 @@
1937
2017
  </div>
1938
2018
 
1939
2019
  <div id="footer">
1940
- Generated on Thu Aug 24 20:57:30 2023 by
2020
+ Generated on Tue Apr 30 20:26:17 2024 by
1941
2021
  <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1942
- 0.9.34 (ruby-3.0.6).
2022
+ 0.9.36 (ruby-3.3.0).
1943
2023
  </div>
1944
2024
 
1945
2025
  </div>