ngrok-api 0.16.0 → 0.19.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (525) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +28 -1
  3. data/doc/NgrokAPI/Client.html +270 -180
  4. data/doc/NgrokAPI/Error.html +2 -2
  5. data/doc/NgrokAPI/Errors/NotFoundError.html +2 -2
  6. data/doc/NgrokAPI/Errors.html +2 -2
  7. data/doc/NgrokAPI/HttpClient.html +147 -4
  8. data/doc/NgrokAPI/Models/APIKey.html +120 -68
  9. data/doc/NgrokAPI/Models/AWSAuth.html +83 -31
  10. data/doc/NgrokAPI/Models/AWSCredentials.html +90 -38
  11. data/doc/NgrokAPI/Models/AWSRole.html +75 -23
  12. data/doc/NgrokAPI/Models/AbuseReport.html +109 -57
  13. data/doc/NgrokAPI/Models/AbuseReportHostname.html +83 -31
  14. data/doc/NgrokAPI/Models/AgentIngress.html +142 -90
  15. data/doc/NgrokAPI/Models/CertificateAuthority.html +149 -97
  16. data/doc/NgrokAPI/Models/Credential.html +121 -69
  17. data/doc/NgrokAPI/Models/Endpoint.html +1483 -0
  18. data/doc/NgrokAPI/Models/{EndpointLoggingMutate.html → EndpointBackend.html} +105 -53
  19. data/doc/NgrokAPI/Models/EndpointBackendMutate.html +669 -0
  20. data/doc/NgrokAPI/Models/EndpointCircuitBreaker.html +101 -49
  21. data/doc/NgrokAPI/Models/EndpointCompression.html +82 -30
  22. data/doc/NgrokAPI/Models/EndpointIPPolicy.html +90 -38
  23. data/doc/NgrokAPI/Models/EndpointIPPolicyMutate.html +90 -38
  24. data/doc/NgrokAPI/Models/EndpointMutualTLS.html +90 -38
  25. data/doc/NgrokAPI/Models/EndpointMutualTLSMutate.html +90 -38
  26. data/doc/NgrokAPI/Models/EndpointOAuth.html +124 -72
  27. data/doc/NgrokAPI/Models/EndpointOAuthFacebook.html +107 -55
  28. data/doc/NgrokAPI/Models/EndpointOAuthGitHub.html +116 -64
  29. data/doc/NgrokAPI/Models/EndpointOAuthGoogle.html +107 -55
  30. data/doc/NgrokAPI/Models/EndpointOAuthMicrosoft.html +107 -55
  31. data/doc/NgrokAPI/Models/EndpointOAuthProvider.html +106 -54
  32. data/doc/NgrokAPI/Models/EndpointOIDC.html +133 -81
  33. data/doc/NgrokAPI/Models/EndpointRequestHeaders.html +91 -39
  34. data/doc/NgrokAPI/Models/EndpointResponseHeaders.html +91 -39
  35. data/doc/NgrokAPI/Models/EndpointSAML.html +148 -96
  36. data/doc/NgrokAPI/Models/EndpointSAMLMutate.html +133 -81
  37. data/doc/NgrokAPI/Models/EndpointTLSTermination.html +91 -39
  38. data/doc/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +669 -0
  39. data/doc/NgrokAPI/Models/EndpointWebhookValidation.html +91 -39
  40. data/{docs/NgrokAPI/Models/EndpointLogging.html → doc/NgrokAPI/Models/EndpointWebsocketTCPConverter.html} +95 -117
  41. data/doc/NgrokAPI/Models/EventDestination.html +122 -70
  42. data/doc/NgrokAPI/Models/EventSource.html +92 -40
  43. data/doc/NgrokAPI/Models/EventSourceList.html +76 -24
  44. data/doc/NgrokAPI/Models/EventSourceReplace.html +91 -39
  45. data/doc/NgrokAPI/Models/EventSubscription.html +122 -70
  46. data/doc/NgrokAPI/Models/EventTarget.html +106 -54
  47. data/doc/NgrokAPI/Models/EventTargetCloudwatchLogs.html +90 -38
  48. data/doc/NgrokAPI/Models/EventTargetFirehose.html +90 -38
  49. data/doc/NgrokAPI/Models/EventTargetKinesis.html +83 -31
  50. data/doc/NgrokAPI/Models/FailoverBackend.html +1127 -0
  51. data/{docs/NgrokAPI/Models/EventStream.html → doc/NgrokAPI/Models/HTTPResponseBackend.html} +170 -196
  52. data/doc/NgrokAPI/Models/HTTPSEdge.html +1361 -0
  53. data/doc/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +278 -288
  54. data/doc/NgrokAPI/Models/IPPolicy.html +120 -68
  55. data/doc/NgrokAPI/Models/IPPolicyRule.html +222 -96
  56. data/doc/NgrokAPI/Models/IPRestriction.html +130 -78
  57. data/doc/NgrokAPI/Models/Listable.html +61 -61
  58. data/doc/NgrokAPI/Models/Ref.html +83 -31
  59. data/doc/NgrokAPI/Models/ReservedAddr.html +130 -78
  60. data/doc/NgrokAPI/Models/ReservedDomain.html +151 -99
  61. data/doc/NgrokAPI/Models/ReservedDomainCertJob.html +92 -40
  62. data/doc/NgrokAPI/Models/ReservedDomainCertPolicy.html +90 -38
  63. data/doc/NgrokAPI/Models/ReservedDomainCertStatus.html +90 -38
  64. data/doc/NgrokAPI/Models/SSHCertificateAuthority.html +135 -83
  65. data/doc/NgrokAPI/Models/SSHCredential.html +128 -76
  66. data/doc/NgrokAPI/Models/SSHHostCertificate.html +148 -96
  67. data/doc/NgrokAPI/Models/SSHUserCertificate.html +154 -102
  68. data/doc/NgrokAPI/Models/TCPEdge.html +1287 -0
  69. data/doc/NgrokAPI/Models/TLSCertificate.html +165 -113
  70. data/doc/NgrokAPI/Models/TLSCertificateSANs.html +90 -38
  71. data/doc/NgrokAPI/Models/TLSEdge.html +1447 -0
  72. data/doc/NgrokAPI/Models/Tunnel.html +413 -65
  73. data/doc/NgrokAPI/Models/TunnelGroupBackend.html +1201 -0
  74. data/doc/NgrokAPI/Models/TunnelSession.html +126 -74
  75. data/doc/NgrokAPI/Models/WeightedBackend.html +1127 -0
  76. data/doc/NgrokAPI/Models.html +4 -4
  77. data/doc/NgrokAPI/PagedIterator.html +3 -3
  78. data/doc/NgrokAPI/Services/APIKeysClient.html +244 -109
  79. data/doc/NgrokAPI/Services/AbuseReportsClient.html +162 -25
  80. data/doc/NgrokAPI/Services/AgentIngressesClient.html +262 -109
  81. data/doc/NgrokAPI/Services/CertificateAuthoritiesClient.html +262 -109
  82. data/doc/NgrokAPI/Services/CredentialsClient.html +266 -111
  83. data/doc/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1149 -0
  84. data/doc/NgrokAPI/Services/{EndpointCircuitBreakerModuleClient.html → EdgeRouteCircuitBreakerModuleClient.html} +205 -99
  85. data/{docs/NgrokAPI/Services/EndpointCompressionModuleClient.html → doc/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html} +205 -99
  86. data/doc/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +1149 -0
  87. data/doc/NgrokAPI/Services/{EndpointOAuthModuleClient.html → EdgeRouteOAuthModuleClient.html} +205 -99
  88. data/doc/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +1149 -0
  89. data/doc/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1149 -0
  90. data/doc/NgrokAPI/Services/{EndpointResponseHeadersModuleClient.html → EdgeRouteResponseHeadersModuleClient.html} +205 -99
  91. data/{docs/NgrokAPI/Services/EndpointSAMLModuleClient.html → doc/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html} +205 -99
  92. data/{docs/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html → doc/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html} +205 -99
  93. data/doc/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1149 -0
  94. data/doc/NgrokAPI/Services/EdgesHTTPSClient.html +1947 -0
  95. data/doc/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +2585 -0
  96. data/doc/NgrokAPI/Services/EdgesTCPClient.html +1947 -0
  97. data/{docs/NgrokAPI/Services/EndpointConfigurationsClient.html → doc/NgrokAPI/Services/EdgesTLSClient.html} +374 -641
  98. data/doc/NgrokAPI/Services/EndpointsClient.html +903 -0
  99. data/doc/NgrokAPI/Services/EventDestinationsClient.html +290 -115
  100. data/doc/NgrokAPI/Services/EventSourcesClient.html +227 -88
  101. data/doc/NgrokAPI/Services/EventSubscriptionsClient.html +291 -116
  102. data/doc/NgrokAPI/Services/{EventStreamsClient.html → FailoverBackendsClient.html} +342 -335
  103. data/doc/NgrokAPI/Services/HTTPResponseBackendsClient.html +1937 -0
  104. data/doc/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +1039 -0
  105. data/{docs/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html → doc/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html} +76 -80
  106. data/doc/NgrokAPI/Services/IPPoliciesClient.html +245 -128
  107. data/doc/NgrokAPI/Services/IPPolicyRulesClient.html +328 -117
  108. data/doc/NgrokAPI/Services/IPRestrictionsClient.html +305 -114
  109. data/doc/NgrokAPI/Services/ReservedAddrsClient.html +160 -295
  110. data/doc/NgrokAPI/Services/ReservedDomainsClient.html +257 -624
  111. data/doc/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +304 -109
  112. data/doc/NgrokAPI/Services/SSHCredentialsClient.html +284 -111
  113. data/doc/NgrokAPI/Services/SSHHostCertificatesClient.html +340 -109
  114. data/doc/NgrokAPI/Services/SSHUserCertificatesClient.html +381 -110
  115. data/{docs/NgrokAPI/Services/EndpointLoggingModuleClient.html → doc/NgrokAPI/Services/TCPEdgeBackendModuleClient.html} +76 -80
  116. data/doc/NgrokAPI/Services/{EndpointIPPolicyModuleClient.html → TCPEdgeIPRestrictionModuleClient.html} +62 -66
  117. data/doc/NgrokAPI/Services/TLSCertificatesClient.html +280 -109
  118. data/doc/NgrokAPI/Services/{EndpointLoggingModuleClient.html → TLSEdgeBackendModuleClient.html} +76 -80
  119. data/{docs/NgrokAPI/Services/EndpointIPPolicyModuleClient.html → doc/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html} +62 -66
  120. data/doc/NgrokAPI/Services/{EndpointMutualTLSModuleClient.html → TLSEdgeMutualTLSModuleClient.html} +62 -66
  121. data/doc/NgrokAPI/Services/{EndpointTLSTerminationModuleClient.html → TLSEdgeTLSTerminationModuleClient.html} +62 -66
  122. data/doc/NgrokAPI/Services/TunnelGroupBackendsClient.html +1799 -0
  123. data/doc/NgrokAPI/Services/TunnelSessionsClient.html +44 -48
  124. data/doc/NgrokAPI/Services/TunnelsClient.html +249 -15
  125. data/doc/NgrokAPI/Services/WeightedBackendsClient.html +1799 -0
  126. data/doc/NgrokAPI/Services.html +4 -4
  127. data/doc/NgrokAPI.html +3 -3
  128. data/doc/_index.html +237 -60
  129. data/doc/class_list.html +1 -1
  130. data/doc/file.README.html +55 -55
  131. data/doc/index.html +55 -55
  132. data/doc/method_list.html +4555 -1843
  133. data/doc/top-level-namespace.html +2 -2
  134. data/docs/NgrokAPI/Client.html +270 -180
  135. data/docs/NgrokAPI/Error.html +2 -2
  136. data/docs/NgrokAPI/Errors/NotFoundError.html +2 -2
  137. data/docs/NgrokAPI/Errors.html +2 -2
  138. data/docs/NgrokAPI/HttpClient.html +147 -4
  139. data/docs/NgrokAPI/Models/APIKey.html +120 -68
  140. data/docs/NgrokAPI/Models/AWSAuth.html +83 -31
  141. data/docs/NgrokAPI/Models/AWSCredentials.html +90 -38
  142. data/docs/NgrokAPI/Models/AWSRole.html +75 -23
  143. data/docs/NgrokAPI/Models/AbuseReport.html +109 -57
  144. data/docs/NgrokAPI/Models/AbuseReportHostname.html +83 -31
  145. data/docs/NgrokAPI/Models/AgentIngress.html +142 -90
  146. data/docs/NgrokAPI/Models/CertificateAuthority.html +149 -97
  147. data/docs/NgrokAPI/Models/Credential.html +121 -69
  148. data/docs/NgrokAPI/Models/Endpoint.html +1483 -0
  149. data/docs/NgrokAPI/Models/{EndpointLoggingMutate.html → EndpointBackend.html} +105 -53
  150. data/docs/NgrokAPI/Models/EndpointBackendMutate.html +669 -0
  151. data/docs/NgrokAPI/Models/EndpointCircuitBreaker.html +101 -49
  152. data/docs/NgrokAPI/Models/EndpointCompression.html +82 -30
  153. data/docs/NgrokAPI/Models/EndpointIPPolicy.html +90 -38
  154. data/docs/NgrokAPI/Models/EndpointIPPolicyMutate.html +90 -38
  155. data/docs/NgrokAPI/Models/EndpointMutualTLS.html +90 -38
  156. data/docs/NgrokAPI/Models/EndpointMutualTLSMutate.html +90 -38
  157. data/docs/NgrokAPI/Models/EndpointOAuth.html +124 -72
  158. data/docs/NgrokAPI/Models/EndpointOAuthFacebook.html +107 -55
  159. data/docs/NgrokAPI/Models/EndpointOAuthGitHub.html +116 -64
  160. data/docs/NgrokAPI/Models/EndpointOAuthGoogle.html +107 -55
  161. data/docs/NgrokAPI/Models/EndpointOAuthMicrosoft.html +107 -55
  162. data/docs/NgrokAPI/Models/EndpointOAuthProvider.html +106 -54
  163. data/docs/NgrokAPI/Models/EndpointOIDC.html +133 -81
  164. data/docs/NgrokAPI/Models/EndpointRequestHeaders.html +91 -39
  165. data/docs/NgrokAPI/Models/EndpointResponseHeaders.html +91 -39
  166. data/docs/NgrokAPI/Models/EndpointSAML.html +148 -96
  167. data/docs/NgrokAPI/Models/EndpointSAMLMutate.html +133 -81
  168. data/docs/NgrokAPI/Models/EndpointTLSTermination.html +91 -39
  169. data/docs/NgrokAPI/Models/EndpointTLSTerminationAtEdge.html +669 -0
  170. data/docs/NgrokAPI/Models/EndpointWebhookValidation.html +91 -39
  171. data/{doc/NgrokAPI/Models/EndpointLogging.html → docs/NgrokAPI/Models/EndpointWebsocketTCPConverter.html} +95 -117
  172. data/docs/NgrokAPI/Models/EventDestination.html +122 -70
  173. data/docs/NgrokAPI/Models/EventSource.html +92 -40
  174. data/docs/NgrokAPI/Models/EventSourceList.html +76 -24
  175. data/docs/NgrokAPI/Models/EventSourceReplace.html +91 -39
  176. data/docs/NgrokAPI/Models/EventSubscription.html +122 -70
  177. data/docs/NgrokAPI/Models/EventTarget.html +106 -54
  178. data/docs/NgrokAPI/Models/EventTargetCloudwatchLogs.html +90 -38
  179. data/docs/NgrokAPI/Models/EventTargetFirehose.html +90 -38
  180. data/docs/NgrokAPI/Models/EventTargetKinesis.html +83 -31
  181. data/docs/NgrokAPI/Models/FailoverBackend.html +1127 -0
  182. data/{doc/NgrokAPI/Models/EventStream.html → docs/NgrokAPI/Models/HTTPResponseBackend.html} +170 -196
  183. data/docs/NgrokAPI/Models/HTTPSEdge.html +1361 -0
  184. data/docs/NgrokAPI/Models/{EndpointConfiguration.html → HTTPSEdgeRoute.html} +278 -288
  185. data/docs/NgrokAPI/Models/IPPolicy.html +120 -68
  186. data/docs/NgrokAPI/Models/IPPolicyRule.html +222 -96
  187. data/docs/NgrokAPI/Models/IPRestriction.html +130 -78
  188. data/docs/NgrokAPI/Models/Listable.html +61 -61
  189. data/docs/NgrokAPI/Models/Ref.html +83 -31
  190. data/docs/NgrokAPI/Models/ReservedAddr.html +130 -78
  191. data/docs/NgrokAPI/Models/ReservedDomain.html +151 -99
  192. data/docs/NgrokAPI/Models/ReservedDomainCertJob.html +92 -40
  193. data/docs/NgrokAPI/Models/ReservedDomainCertPolicy.html +90 -38
  194. data/docs/NgrokAPI/Models/ReservedDomainCertStatus.html +90 -38
  195. data/docs/NgrokAPI/Models/SSHCertificateAuthority.html +135 -83
  196. data/docs/NgrokAPI/Models/SSHCredential.html +128 -76
  197. data/docs/NgrokAPI/Models/SSHHostCertificate.html +148 -96
  198. data/docs/NgrokAPI/Models/SSHUserCertificate.html +154 -102
  199. data/docs/NgrokAPI/Models/TCPEdge.html +1287 -0
  200. data/docs/NgrokAPI/Models/TLSCertificate.html +165 -113
  201. data/docs/NgrokAPI/Models/TLSCertificateSANs.html +90 -38
  202. data/docs/NgrokAPI/Models/TLSEdge.html +1447 -0
  203. data/docs/NgrokAPI/Models/Tunnel.html +413 -65
  204. data/docs/NgrokAPI/Models/TunnelGroupBackend.html +1201 -0
  205. data/docs/NgrokAPI/Models/TunnelSession.html +126 -74
  206. data/docs/NgrokAPI/Models/WeightedBackend.html +1127 -0
  207. data/docs/NgrokAPI/Models.html +4 -4
  208. data/docs/NgrokAPI/PagedIterator.html +3 -3
  209. data/docs/NgrokAPI/Services/APIKeysClient.html +244 -109
  210. data/docs/NgrokAPI/Services/AbuseReportsClient.html +162 -25
  211. data/docs/NgrokAPI/Services/AgentIngressesClient.html +262 -109
  212. data/docs/NgrokAPI/Services/CertificateAuthoritiesClient.html +262 -109
  213. data/docs/NgrokAPI/Services/CredentialsClient.html +266 -111
  214. data/docs/NgrokAPI/Services/EdgeRouteBackendModuleClient.html +1149 -0
  215. data/docs/NgrokAPI/Services/{EndpointCircuitBreakerModuleClient.html → EdgeRouteCircuitBreakerModuleClient.html} +205 -99
  216. data/{doc/NgrokAPI/Services/EndpointCompressionModuleClient.html → docs/NgrokAPI/Services/EdgeRouteCompressionModuleClient.html} +205 -99
  217. data/docs/NgrokAPI/Services/EdgeRouteIPRestrictionModuleClient.html +1149 -0
  218. data/docs/NgrokAPI/Services/{EndpointOAuthModuleClient.html → EdgeRouteOAuthModuleClient.html} +205 -99
  219. data/docs/NgrokAPI/Services/EdgeRouteOIDCModuleClient.html +1149 -0
  220. data/docs/NgrokAPI/Services/EdgeRouteRequestHeadersModuleClient.html +1149 -0
  221. data/docs/NgrokAPI/Services/{EndpointResponseHeadersModuleClient.html → EdgeRouteResponseHeadersModuleClient.html} +205 -99
  222. data/{doc/NgrokAPI/Services/EndpointSAMLModuleClient.html → docs/NgrokAPI/Services/EdgeRouteSAMLModuleClient.html} +205 -99
  223. data/{doc/NgrokAPI/Services/EndpointWebhookValidationModuleClient.html → docs/NgrokAPI/Services/EdgeRouteWebhookVerificationModuleClient.html} +205 -99
  224. data/docs/NgrokAPI/Services/EdgeRouteWebsocketTCPConverterModuleClient.html +1149 -0
  225. data/docs/NgrokAPI/Services/EdgesHTTPSClient.html +1947 -0
  226. data/docs/NgrokAPI/Services/EdgesHTTPSRoutesClient.html +2585 -0
  227. data/docs/NgrokAPI/Services/EdgesTCPClient.html +1947 -0
  228. data/{doc/NgrokAPI/Services/EndpointConfigurationsClient.html → docs/NgrokAPI/Services/EdgesTLSClient.html} +374 -641
  229. data/docs/NgrokAPI/Services/EndpointsClient.html +903 -0
  230. data/docs/NgrokAPI/Services/EventDestinationsClient.html +290 -115
  231. data/docs/NgrokAPI/Services/EventSourcesClient.html +227 -88
  232. data/docs/NgrokAPI/Services/EventSubscriptionsClient.html +291 -116
  233. data/docs/NgrokAPI/Services/{EventStreamsClient.html → FailoverBackendsClient.html} +342 -335
  234. data/docs/NgrokAPI/Services/HTTPResponseBackendsClient.html +1937 -0
  235. data/docs/NgrokAPI/Services/HTTPSEdgeMutualTLSModuleClient.html +1039 -0
  236. data/{doc/NgrokAPI/Services/EndpointRequestHeadersModuleClient.html → docs/NgrokAPI/Services/HTTPSEdgeTLSTerminationModuleClient.html} +76 -80
  237. data/docs/NgrokAPI/Services/IPPoliciesClient.html +245 -128
  238. data/docs/NgrokAPI/Services/IPPolicyRulesClient.html +328 -117
  239. data/docs/NgrokAPI/Services/IPRestrictionsClient.html +305 -114
  240. data/docs/NgrokAPI/Services/ReservedAddrsClient.html +160 -295
  241. data/docs/NgrokAPI/Services/ReservedDomainsClient.html +257 -624
  242. data/docs/NgrokAPI/Services/SSHCertificateAuthoritiesClient.html +304 -109
  243. data/docs/NgrokAPI/Services/SSHCredentialsClient.html +284 -111
  244. data/docs/NgrokAPI/Services/SSHHostCertificatesClient.html +340 -109
  245. data/docs/NgrokAPI/Services/SSHUserCertificatesClient.html +381 -110
  246. data/docs/NgrokAPI/Services/{EndpointOIDCModuleClient.html → TCPEdgeBackendModuleClient.html} +76 -80
  247. data/docs/NgrokAPI/Services/TCPEdgeIPRestrictionModuleClient.html +1039 -0
  248. data/docs/NgrokAPI/Services/TLSCertificatesClient.html +280 -109
  249. data/{doc/NgrokAPI/Services/EndpointOIDCModuleClient.html → docs/NgrokAPI/Services/TLSEdgeBackendModuleClient.html} +76 -80
  250. data/docs/NgrokAPI/Services/TLSEdgeIPRestrictionModuleClient.html +1039 -0
  251. data/docs/NgrokAPI/Services/{EndpointMutualTLSModuleClient.html → TLSEdgeMutualTLSModuleClient.html} +62 -66
  252. data/docs/NgrokAPI/Services/{EndpointTLSTerminationModuleClient.html → TLSEdgeTLSTerminationModuleClient.html} +62 -66
  253. data/docs/NgrokAPI/Services/TunnelGroupBackendsClient.html +1799 -0
  254. data/docs/NgrokAPI/Services/TunnelSessionsClient.html +44 -48
  255. data/docs/NgrokAPI/Services/TunnelsClient.html +249 -15
  256. data/docs/NgrokAPI/Services/WeightedBackendsClient.html +1799 -0
  257. data/docs/NgrokAPI/Services.html +4 -4
  258. data/docs/NgrokAPI.html +3 -3
  259. data/docs/_index.html +237 -60
  260. data/docs/class_list.html +1 -1
  261. data/docs/file.README.html +55 -55
  262. data/docs/index.html +55 -55
  263. data/docs/method_list.html +4555 -1843
  264. data/docs/top-level-namespace.html +2 -2
  265. data/lib/ngrokapi/client.rb +47 -24
  266. data/lib/ngrokapi/http_client.rb +21 -2
  267. data/lib/ngrokapi/models/abuse_report.rb +16 -12
  268. data/lib/ngrokapi/models/abuse_report_hostname.rb +11 -7
  269. data/lib/ngrokapi/models/agent_ingress.rb +17 -13
  270. data/lib/ngrokapi/models/api_key.rb +15 -11
  271. data/lib/ngrokapi/models/aws_auth.rb +11 -7
  272. data/lib/ngrokapi/models/aws_credentials.rb +11 -7
  273. data/lib/ngrokapi/models/aws_role.rb +10 -6
  274. data/lib/ngrokapi/models/certificate_authority.rb +20 -16
  275. data/lib/ngrokapi/models/credential.rb +16 -12
  276. data/lib/ngrokapi/models/endpoint.rb +53 -0
  277. data/lib/ngrokapi/models/endpoint_backend.rb +31 -0
  278. data/lib/ngrokapi/models/endpoint_backend_mutate.rb +31 -0
  279. data/lib/ngrokapi/models/endpoint_circuit_breaker.rb +15 -11
  280. data/lib/ngrokapi/models/endpoint_compression.rb +10 -6
  281. data/lib/ngrokapi/models/endpoint_ip_policy.rb +11 -7
  282. data/lib/ngrokapi/models/endpoint_ip_policy_mutate.rb +11 -7
  283. data/lib/ngrokapi/models/endpoint_mutual_tls.rb +11 -7
  284. data/lib/ngrokapi/models/endpoint_mutual_tls_mutate.rb +11 -7
  285. data/lib/ngrokapi/models/endpoint_o_auth.rb +16 -12
  286. data/lib/ngrokapi/models/endpoint_o_auth_facebook.rb +14 -10
  287. data/lib/ngrokapi/models/endpoint_o_auth_git_hub.rb +16 -12
  288. data/lib/ngrokapi/models/endpoint_o_auth_google.rb +14 -10
  289. data/lib/ngrokapi/models/endpoint_o_auth_microsoft.rb +14 -10
  290. data/lib/ngrokapi/models/endpoint_o_auth_provider.rb +13 -9
  291. data/lib/ngrokapi/models/endpoint_oidc.rb +18 -14
  292. data/lib/ngrokapi/models/endpoint_request_headers.rb +12 -8
  293. data/lib/ngrokapi/models/endpoint_response_headers.rb +12 -8
  294. data/lib/ngrokapi/models/endpoint_saml.rb +25 -21
  295. data/lib/ngrokapi/models/endpoint_saml_mutate.rb +20 -16
  296. data/lib/ngrokapi/models/endpoint_tls_termination.rb +12 -8
  297. data/lib/ngrokapi/models/endpoint_tls_termination_at_edge.rb +31 -0
  298. data/lib/ngrokapi/models/endpoint_webhook_validation.rb +12 -8
  299. data/lib/ngrokapi/models/endpoint_websocket_tcp_converter.rb +29 -0
  300. data/lib/ngrokapi/models/event_destination.rb +17 -14
  301. data/lib/ngrokapi/models/event_source.rb +13 -9
  302. data/lib/ngrokapi/models/event_source_list.rb +11 -7
  303. data/lib/ngrokapi/models/event_source_replace.rb +12 -8
  304. data/lib/ngrokapi/models/event_subscription.rb +16 -12
  305. data/lib/ngrokapi/models/event_target.rb +13 -9
  306. data/lib/ngrokapi/models/event_target_cloudwatch_logs.rb +11 -7
  307. data/lib/ngrokapi/models/event_target_firehose.rb +11 -7
  308. data/lib/ngrokapi/models/event_target_kinesis.rb +11 -7
  309. data/lib/ngrokapi/models/failover_backend.rb +69 -0
  310. data/lib/ngrokapi/models/http_response_backend.rb +75 -0
  311. data/lib/ngrokapi/models/https_edge.rb +84 -0
  312. data/lib/ngrokapi/models/https_edge_route.rb +137 -0
  313. data/lib/ngrokapi/models/ip_policy.rb +15 -11
  314. data/lib/ngrokapi/models/ip_policy_rule.rb +19 -13
  315. data/lib/ngrokapi/models/ip_restriction.rb +17 -13
  316. data/lib/ngrokapi/models/listable.rb +9 -9
  317. data/lib/ngrokapi/models/ref.rb +11 -7
  318. data/lib/ngrokapi/models/reserved_addr.rb +17 -13
  319. data/lib/ngrokapi/models/reserved_domain.rb +23 -19
  320. data/lib/ngrokapi/models/reserved_domain_cert_job.rb +13 -9
  321. data/lib/ngrokapi/models/reserved_domain_cert_policy.rb +11 -7
  322. data/lib/ngrokapi/models/reserved_domain_cert_status.rb +11 -7
  323. data/lib/ngrokapi/models/ssh_certificate_authority.rb +16 -12
  324. data/lib/ngrokapi/models/ssh_credential.rb +16 -12
  325. data/lib/ngrokapi/models/ssh_host_certificate.rb +21 -17
  326. data/lib/ngrokapi/models/ssh_user_certificate.rb +23 -19
  327. data/lib/ngrokapi/models/tcp_edge.rb +82 -0
  328. data/lib/ngrokapi/models/tls_certificate.rb +30 -26
  329. data/lib/ngrokapi/models/tls_certificate_sa_ns.rb +11 -7
  330. data/lib/ngrokapi/models/tls_edge.rb +92 -0
  331. data/lib/ngrokapi/models/tunnel.rb +25 -13
  332. data/lib/ngrokapi/models/tunnel_group_backend.rb +71 -0
  333. data/lib/ngrokapi/models/tunnel_session.rb +19 -15
  334. data/lib/ngrokapi/models/weighted_backend.rb +69 -0
  335. data/lib/ngrokapi/paged_iterator.rb +1 -1
  336. data/lib/ngrokapi/services/abuse_reports_client.rb +25 -3
  337. data/lib/ngrokapi/services/agent_ingresses_client.rb +32 -11
  338. data/lib/ngrokapi/services/api_keys_client.rb +30 -11
  339. data/lib/ngrokapi/services/certificate_authorities_client.rb +31 -11
  340. data/lib/ngrokapi/services/credentials_client.rb +34 -11
  341. data/lib/ngrokapi/services/edge_route_backend_module_client.rb +118 -0
  342. data/lib/ngrokapi/services/edge_route_circuit_breaker_module_client.rb +118 -0
  343. data/lib/ngrokapi/services/edge_route_compression_module_client.rb +118 -0
  344. data/lib/ngrokapi/services/edge_route_ip_restriction_module_client.rb +118 -0
  345. data/lib/ngrokapi/services/edge_route_o_auth_module_client.rb +118 -0
  346. data/lib/ngrokapi/services/edge_route_oidc_module_client.rb +118 -0
  347. data/lib/ngrokapi/services/edge_route_request_headers_module_client.rb +118 -0
  348. data/lib/ngrokapi/services/edge_route_response_headers_module_client.rb +118 -0
  349. data/lib/ngrokapi/services/edge_route_saml_module_client.rb +118 -0
  350. data/lib/ngrokapi/services/edge_route_webhook_verification_module_client.rb +118 -0
  351. data/lib/ngrokapi/services/edge_route_websocket_tcp_converter_module_client.rb +118 -0
  352. data/lib/ngrokapi/services/edges_https_client.rb +251 -0
  353. data/lib/ngrokapi/services/edges_https_routes_client.rb +292 -0
  354. data/lib/ngrokapi/services/edges_tcp_client.rb +251 -0
  355. data/lib/ngrokapi/services/edges_tls_client.rb +267 -0
  356. data/lib/ngrokapi/services/endpoints_client.rb +112 -0
  357. data/lib/ngrokapi/services/event_destinations_client.rb +37 -15
  358. data/lib/ngrokapi/services/event_sources_client.rb +27 -7
  359. data/lib/ngrokapi/services/event_subscriptions_client.rb +36 -14
  360. data/lib/ngrokapi/services/failover_backends_client.rb +234 -0
  361. data/lib/ngrokapi/services/http_response_backends_client.rb +220 -0
  362. data/lib/ngrokapi/services/{endpoint_oidc_module_client.rb → https_edge_mutual_tls_module_client.rb} +27 -29
  363. data/lib/ngrokapi/services/https_edge_tls_termination_module_client.rb +106 -0
  364. data/lib/ngrokapi/services/ip_policies_client.rb +31 -14
  365. data/lib/ngrokapi/services/ip_policy_rules_client.rb +38 -12
  366. data/lib/ngrokapi/services/ip_restrictions_client.rb +36 -12
  367. data/lib/ngrokapi/services/reserved_addrs_client.rb +31 -48
  368. data/lib/ngrokapi/services/reserved_domains_client.rb +37 -85
  369. data/lib/ngrokapi/services/ssh_certificate_authorities_client.rb +35 -11
  370. data/lib/ngrokapi/services/ssh_credentials_client.rb +34 -11
  371. data/lib/ngrokapi/services/ssh_host_certificates_client.rb +39 -11
  372. data/lib/ngrokapi/services/ssh_user_certificates_client.rb +44 -12
  373. data/lib/ngrokapi/services/{endpoint_logging_module_client.rb → tcp_edge_backend_module_client.rb} +27 -29
  374. data/lib/ngrokapi/services/{endpoint_ip_policy_module_client.rb → tcp_edge_ip_restriction_module_client.rb} +21 -23
  375. data/lib/ngrokapi/services/tls_certificates_client.rb +33 -11
  376. data/lib/ngrokapi/services/{endpoint_saml_module_client.rb → tls_edge_backend_module_client.rb} +27 -29
  377. data/lib/ngrokapi/services/tls_edge_ip_restriction_module_client.rb +106 -0
  378. data/lib/ngrokapi/services/{endpoint_mutual_tls_module_client.rb → tls_edge_mutual_tls_module_client.rb} +21 -23
  379. data/lib/ngrokapi/services/{endpoint_tls_termination_module_client.rb → tls_edge_tls_termination_module_client.rb} +21 -23
  380. data/lib/ngrokapi/services/tunnel_group_backends_client.rb +232 -0
  381. data/lib/ngrokapi/services/tunnel_sessions_client.rb +6 -8
  382. data/lib/ngrokapi/services/tunnels_client.rb +39 -6
  383. data/lib/ngrokapi/services/weighted_backends_client.rb +234 -0
  384. data/lib/ngrokapi/version.rb +1 -1
  385. data/lib/ngrokapi.rb +1 -1
  386. data/spec/ngrokapi/client_spec.rb +44 -23
  387. data/spec/ngrokapi/models/abuse_report_hostname_spec.rb +2 -2
  388. data/spec/ngrokapi/models/abuse_report_spec.rb +2 -2
  389. data/spec/ngrokapi/models/agent_ingress_spec.rb +2 -2
  390. data/spec/ngrokapi/models/api_key_spec.rb +2 -2
  391. data/spec/ngrokapi/models/aws_auth_spec.rb +2 -2
  392. data/spec/ngrokapi/models/aws_credentials_spec.rb +2 -2
  393. data/spec/ngrokapi/models/aws_role_spec.rb +2 -2
  394. data/spec/ngrokapi/models/certificate_authority_spec.rb +2 -2
  395. data/spec/ngrokapi/models/credential_spec.rb +2 -2
  396. data/spec/ngrokapi/models/endpoint_backend_mutate_spec.rb +21 -0
  397. data/spec/ngrokapi/models/endpoint_backend_spec.rb +21 -0
  398. data/spec/ngrokapi/models/endpoint_circuit_breaker_spec.rb +2 -2
  399. data/spec/ngrokapi/models/endpoint_compression_spec.rb +2 -2
  400. data/spec/ngrokapi/models/endpoint_ip_policy_mutate_spec.rb +2 -2
  401. data/spec/ngrokapi/models/endpoint_ip_policy_spec.rb +2 -2
  402. data/spec/ngrokapi/models/endpoint_mutual_tls_mutate_spec.rb +2 -2
  403. data/spec/ngrokapi/models/endpoint_mutual_tls_spec.rb +2 -2
  404. data/spec/ngrokapi/models/endpoint_o_auth_facebook_spec.rb +2 -2
  405. data/spec/ngrokapi/models/endpoint_o_auth_git_hub_spec.rb +2 -2
  406. data/spec/ngrokapi/models/endpoint_o_auth_google_spec.rb +2 -2
  407. data/spec/ngrokapi/models/endpoint_o_auth_microsoft_spec.rb +2 -2
  408. data/spec/ngrokapi/models/endpoint_o_auth_provider_spec.rb +2 -2
  409. data/spec/ngrokapi/models/endpoint_o_auth_spec.rb +2 -2
  410. data/spec/ngrokapi/models/endpoint_oidc_spec.rb +2 -2
  411. data/spec/ngrokapi/models/endpoint_request_headers_spec.rb +2 -2
  412. data/spec/ngrokapi/models/endpoint_response_headers_spec.rb +2 -2
  413. data/spec/ngrokapi/models/endpoint_saml_mutate_spec.rb +2 -2
  414. data/spec/ngrokapi/models/endpoint_saml_spec.rb +2 -2
  415. data/spec/ngrokapi/models/endpoint_spec.rb +21 -0
  416. data/spec/ngrokapi/models/endpoint_tls_termination_at_edge_spec.rb +21 -0
  417. data/spec/ngrokapi/models/endpoint_tls_termination_spec.rb +2 -2
  418. data/spec/ngrokapi/models/endpoint_webhook_validation_spec.rb +2 -2
  419. data/spec/ngrokapi/models/endpoint_websocket_tcp_converter_spec.rb +21 -0
  420. data/spec/ngrokapi/models/event_destination_spec.rb +2 -2
  421. data/spec/ngrokapi/models/event_source_list_spec.rb +2 -2
  422. data/spec/ngrokapi/models/event_source_replace_spec.rb +2 -2
  423. data/spec/ngrokapi/models/event_source_spec.rb +2 -2
  424. data/spec/ngrokapi/models/event_subscription_spec.rb +2 -2
  425. data/spec/ngrokapi/models/event_target_cloudwatch_logs_spec.rb +2 -2
  426. data/spec/ngrokapi/models/event_target_firehose_spec.rb +2 -2
  427. data/spec/ngrokapi/models/event_target_kinesis_spec.rb +2 -2
  428. data/spec/ngrokapi/models/event_target_spec.rb +2 -2
  429. data/spec/ngrokapi/models/failover_backend_spec.rb +45 -0
  430. data/spec/ngrokapi/models/http_response_backend_spec.rb +51 -0
  431. data/spec/ngrokapi/models/https_edge_route_spec.rb +81 -0
  432. data/spec/ngrokapi/models/https_edge_spec.rb +51 -0
  433. data/spec/ngrokapi/models/ip_policy_rule_spec.rb +2 -2
  434. data/spec/ngrokapi/models/ip_policy_spec.rb +2 -2
  435. data/spec/ngrokapi/models/ip_restriction_spec.rb +2 -2
  436. data/spec/ngrokapi/models/listable_spec.rb +2 -2
  437. data/spec/ngrokapi/models/ref_spec.rb +2 -2
  438. data/spec/ngrokapi/models/reserved_addr_spec.rb +2 -2
  439. data/spec/ngrokapi/models/reserved_domain_cert_job_spec.rb +2 -2
  440. data/spec/ngrokapi/models/reserved_domain_cert_policy_spec.rb +2 -2
  441. data/spec/ngrokapi/models/reserved_domain_cert_status_spec.rb +2 -2
  442. data/spec/ngrokapi/models/reserved_domain_spec.rb +2 -2
  443. data/spec/ngrokapi/models/ssh_certificate_authority_spec.rb +2 -2
  444. data/spec/ngrokapi/models/ssh_credential_spec.rb +2 -2
  445. data/spec/ngrokapi/models/ssh_host_certificate_spec.rb +2 -2
  446. data/spec/ngrokapi/models/ssh_user_certificate_spec.rb +2 -2
  447. data/spec/ngrokapi/models/tcp_edge_spec.rb +51 -0
  448. data/spec/ngrokapi/models/tls_certificate_sa_ns_spec.rb +2 -2
  449. data/spec/ngrokapi/models/tls_certificate_spec.rb +2 -2
  450. data/spec/ngrokapi/models/tls_edge_spec.rb +57 -0
  451. data/spec/ngrokapi/models/tunnel_group_backend_spec.rb +45 -0
  452. data/spec/ngrokapi/models/tunnel_session_spec.rb +2 -2
  453. data/spec/ngrokapi/models/tunnel_spec.rb +2 -2
  454. data/spec/ngrokapi/models/weighted_backend_spec.rb +45 -0
  455. data/spec/ngrokapi/paged_iterator_spec.rb +5 -5
  456. data/spec/ngrokapi/services/abuse_reports_client_spec.rb +19 -0
  457. data/spec/ngrokapi/services/agent_ingresses_client_spec.rb +21 -0
  458. data/spec/ngrokapi/services/api_keys_client_spec.rb +19 -0
  459. data/spec/ngrokapi/services/certificate_authorities_client_spec.rb +21 -0
  460. data/spec/ngrokapi/services/credentials_client_spec.rb +21 -0
  461. data/spec/ngrokapi/services/edge_route_backend_module_client_spec.rb +137 -0
  462. data/spec/ngrokapi/services/{endpoint_circuit_breaker_module_client_spec.rb → edge_route_circuit_breaker_module_client_spec.rb} +33 -21
  463. data/spec/ngrokapi/services/{endpoint_compression_module_client_spec.rb → edge_route_compression_module_client_spec.rb} +33 -21
  464. data/spec/ngrokapi/services/edge_route_ip_restriction_module_client_spec.rb +137 -0
  465. data/spec/ngrokapi/services/{endpoint_o_auth_module_client_spec.rb → edge_route_o_auth_module_client_spec.rb} +33 -21
  466. data/spec/ngrokapi/services/{endpoint_oidc_module_client_spec.rb → edge_route_oidc_module_client_spec.rb} +33 -21
  467. data/spec/ngrokapi/services/{endpoint_request_headers_module_client_spec.rb → edge_route_request_headers_module_client_spec.rb} +33 -21
  468. data/spec/ngrokapi/services/{endpoint_response_headers_module_client_spec.rb → edge_route_response_headers_module_client_spec.rb} +33 -21
  469. data/spec/ngrokapi/services/{endpoint_saml_module_client_spec.rb → edge_route_saml_module_client_spec.rb} +33 -21
  470. data/spec/ngrokapi/services/{endpoint_webhook_validation_module_client_spec.rb → edge_route_webhook_verification_module_client_spec.rb} +33 -21
  471. data/spec/ngrokapi/services/edge_route_websocket_tcp_converter_module_client_spec.rb +137 -0
  472. data/spec/ngrokapi/services/edges_https_client_spec.rb +200 -0
  473. data/spec/ngrokapi/services/edges_https_routes_client_spec.rb +288 -0
  474. data/spec/ngrokapi/services/edges_tcp_client_spec.rb +200 -0
  475. data/spec/ngrokapi/services/edges_tls_client_spec.rb +216 -0
  476. data/spec/ngrokapi/services/endpoints_client_spec.rb +57 -0
  477. data/spec/ngrokapi/services/event_destinations_client_spec.rb +24 -0
  478. data/spec/ngrokapi/services/event_sources_client_spec.rb +21 -0
  479. data/spec/ngrokapi/services/event_subscriptions_client_spec.rb +23 -0
  480. data/spec/ngrokapi/services/failover_backends_client_spec.rb +184 -0
  481. data/spec/ngrokapi/services/http_response_backends_client_spec.rb +200 -0
  482. data/spec/ngrokapi/services/{endpoint_mutual_tls_module_client_spec.rb → https_edge_mutual_tls_module_client_spec.rb} +19 -21
  483. data/spec/ngrokapi/services/{endpoint_tls_termination_module_client_spec.rb → https_edge_tls_termination_module_client_spec.rb} +19 -21
  484. data/spec/ngrokapi/services/ip_policies_client_spec.rb +20 -1
  485. data/spec/ngrokapi/services/ip_policy_rules_client_spec.rb +28 -1
  486. data/spec/ngrokapi/services/ip_restrictions_client_spec.rb +25 -0
  487. data/spec/ngrokapi/services/reserved_addrs_client_spec.rb +22 -44
  488. data/spec/ngrokapi/services/reserved_domains_client_spec.rb +29 -88
  489. data/spec/ngrokapi/services/ssh_certificate_authorities_client_spec.rb +25 -0
  490. data/spec/ngrokapi/services/ssh_credentials_client_spec.rb +23 -0
  491. data/spec/ngrokapi/services/ssh_host_certificates_client_spec.rb +29 -0
  492. data/spec/ngrokapi/services/ssh_user_certificates_client_spec.rb +33 -0
  493. data/spec/ngrokapi/services/tcp_edge_backend_module_client_spec.rb +123 -0
  494. data/spec/ngrokapi/services/{endpoint_ip_policy_module_client_spec.rb → tcp_edge_ip_restriction_module_client_spec.rb} +19 -21
  495. data/spec/ngrokapi/services/tls_certificates_client_spec.rb +23 -0
  496. data/spec/ngrokapi/services/tls_edge_backend_module_client_spec.rb +123 -0
  497. data/spec/ngrokapi/services/tls_edge_ip_restriction_module_client_spec.rb +123 -0
  498. data/spec/ngrokapi/services/tls_edge_mutual_tls_module_client_spec.rb +123 -0
  499. data/spec/ngrokapi/services/tls_edge_tls_termination_module_client_spec.rb +123 -0
  500. data/spec/ngrokapi/services/tunnel_group_backends_client_spec.rb +184 -0
  501. data/spec/ngrokapi/services/tunnels_client_spec.rb +36 -0
  502. data/spec/ngrokapi/services/weighted_backends_client_spec.rb +184 -0
  503. data/spec/spec_helper.rb +326 -33
  504. metadata +166 -76
  505. data/doc/README +0 -94
  506. data/docs/README +0 -94
  507. data/lib/ngrokapi/models/endpoint_configuration.rb +0 -130
  508. data/lib/ngrokapi/models/endpoint_logging.rb +0 -27
  509. data/lib/ngrokapi/models/endpoint_logging_mutate.rb +0 -27
  510. data/lib/ngrokapi/models/event_stream.rb +0 -77
  511. data/lib/ngrokapi/services/endpoint_circuit_breaker_module_client.rb +0 -108
  512. data/lib/ngrokapi/services/endpoint_compression_module_client.rb +0 -108
  513. data/lib/ngrokapi/services/endpoint_configurations_client.rb +0 -289
  514. data/lib/ngrokapi/services/endpoint_o_auth_module_client.rb +0 -108
  515. data/lib/ngrokapi/services/endpoint_request_headers_module_client.rb +0 -108
  516. data/lib/ngrokapi/services/endpoint_response_headers_module_client.rb +0 -108
  517. data/lib/ngrokapi/services/endpoint_webhook_validation_module_client.rb +0 -108
  518. data/lib/ngrokapi/services/event_streams_client.rb +0 -224
  519. data/spec/ngrokapi/models/endpoint_configuration_spec.rb +0 -78
  520. data/spec/ngrokapi/models/endpoint_logging_mutate_spec.rb +0 -21
  521. data/spec/ngrokapi/models/endpoint_logging_spec.rb +0 -21
  522. data/spec/ngrokapi/models/event_stream_spec.rb +0 -51
  523. data/spec/ngrokapi/services/endpoint_configurations_client_spec.rb +0 -237
  524. data/spec/ngrokapi/services/endpoint_logging_module_client_spec.rb +0 -125
  525. data/spec/ngrokapi/services/event_streams_client_spec.rb +0 -177
data/doc/NgrokAPI/Services/{EventStreamsClient.html → FailoverBackendsClient.html} RENAMED
@@ -4,7 +4,7 @@
4
4
  <meta charset="utf-8">
5
5
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
6
6
  <title>
7
- Class: NgrokAPI::Services::EventStreamsClient
7
+ Class: NgrokAPI::Services::FailoverBackendsClient
8
8
 
9
9
  &mdash; Documentation by YARD 0.9.27
10
10
 
@@ -15,7 +15,7 @@
15
15
  <link rel="stylesheet" href="../../css/common.css" type="text/css" />
16
16
 
17
17
  <script type="text/javascript">
18
- pathId = "NgrokAPI::Services::EventStreamsClient";
18
+ pathId = "NgrokAPI::Services::FailoverBackendsClient";
19
19
  relpath = '../../';
20
20
  </script>
21
21
 
@@ -36,10 +36,10 @@
36
36
  <div id="header">
37
37
  <div id="menu">
38
38
 
39
- <a href="../../_index.html">Index (E)</a> &raquo;
39
+ <a href="../../_index.html">Index (F)</a> &raquo;
40
40
  <span class='title'><span class='object_link'><a href="../../NgrokAPI.html" title="NgrokAPI (module)">NgrokAPI</a></span></span> &raquo; <span class='title'><span class='object_link'><a href="../Services.html" title="NgrokAPI::Services (module)">Services</a></span></span>
41
41
  &raquo;
42
- <span class="title">EventStreamsClient</span>
42
+ <span class="title">FailoverBackendsClient</span>
43
43
 
44
44
  </div>
45
45
 
@@ -59,7 +59,7 @@
59
59
  <div class="clear"></div>
60
60
  </div>
61
61
 
62
- <div id="content"><h1>Class: NgrokAPI::Services::EventStreamsClient
62
+ <div id="content"><h1>Class: NgrokAPI::Services::FailoverBackendsClient
63
63
 
64
64
 
65
65
 
@@ -74,7 +74,7 @@
74
74
  <ul class="fullTree">
75
75
  <li>Object</li>
76
76
 
77
- <li class="next">NgrokAPI::Services::EventStreamsClient</li>
77
+ <li class="next">NgrokAPI::Services::FailoverBackendsClient</li>
78
78
 
79
79
  </ul>
80
80
  <a href="#" class="inheritanceTree">show all</a>
@@ -94,7 +94,7 @@
94
94
 
95
95
  <dl>
96
96
  <dt>Defined in:</dt>
97
- <dd>lib/ngrokapi/services/event_streams_client.rb</dd>
97
+ <dd>lib/ngrokapi/services/failover_backends_client.rb</dd>
98
98
  </dl>
99
99
 
100
100
  </div>
@@ -102,7 +102,9 @@
102
102
  <h2>Overview</h2><div class="docstring">
103
103
  <div class="discussion">
104
104
 
105
- <p><a href="https://ngrok.com/docs/api#api-event-streams">ngrok.com/docs/api#api-event-streams</a></p>
105
+ <p>A Failover backend defines failover behavior within a list of referenced backends. Traffic is sent to the first backend in the list. If that backend is offline or no connection can be established, ngrok attempts to connect to the next backend in the list until one is successful.</p>
106
+
107
+ <p><a href="https://ngrok.com/docs/api#api-failover-backends">ngrok.com/docs/api#api-failover-backends</a></p>
106
108
 
107
109
 
108
110
  </div>
@@ -133,7 +135,7 @@
133
135
 
134
136
  </div>
135
137
  </dt>
136
- <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/event_streams</span><span class='tstring_end'>&#39;</span></span></pre></dd>
138
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>/backends/failover</span><span class='tstring_end'>&#39;</span></span></pre></dd>
137
139
 
138
140
  <dt id="LIST_PROPERTY-constant" class="">LIST_PROPERTY =
139
141
  <div class="docstring">
@@ -149,7 +151,7 @@
149
151
 
150
152
  </div>
151
153
  </dt>
152
- <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>event_streams</span><span class='tstring_end'>&#39;</span></span></pre></dd>
154
+ <dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&#39;</span><span class='tstring_content'>backends</span><span class='tstring_end'>&#39;</span></span></pre></dd>
153
155
 
154
156
  </dl>
155
157
 
@@ -205,7 +207,7 @@
205
207
  <li class="public ">
206
208
  <span class="summary_signature">
207
209
 
208
- <a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(metadata: &quot;&quot;, description: &quot;&quot;, fields: [], event_type: &quot;&quot;, destination_ids: [], sampling_rate: 0) &#x21d2; NgrokAPI::Models::EventStream </a>
210
+ <a href="#create-instance_method" title="#create (instance method)">#<strong>create</strong>(description: &quot;&quot;, metadata: &quot;&quot;, backends: []) &#x21d2; NgrokAPI::Models::FailoverBackend </a>
209
211
 
210
212
 
211
213
 
@@ -220,7 +222,31 @@
220
222
 
221
223
 
222
224
  <span class="summary_desc"><div class='inline'>
223
- <p>Create a new Event Stream.</p>
225
+ <p>Create a new Failover backend.</p>
226
+ </div></span>
227
+
228
+ </li>
229
+
230
+
231
+ <li class="public ">
232
+ <span class="summary_signature">
233
+
234
+ <a href="#create!-instance_method" title="#create! (instance method)">#<strong>create!</strong>(description: &quot;&quot;, metadata: &quot;&quot;, backends: []) &#x21d2; NgrokAPI::Models::FailoverBackend </a>
235
+
236
+
237
+
238
+ </span>
239
+
240
+
241
+
242
+
243
+
244
+
245
+
246
+
247
+
248
+ <span class="summary_desc"><div class='inline'>
249
+ <p>Create a new Failover backend Throws an exception if API error.</p>
224
250
  </div></span>
225
251
 
226
252
  </li>
@@ -244,7 +270,7 @@
244
270
 
245
271
 
246
272
  <span class="summary_desc"><div class='inline'>
247
- <p>Delete an Event Stream.</p>
273
+ <p>Delete a Failover backend by ID.</p>
248
274
  </div></span>
249
275
 
250
276
  </li>
@@ -268,7 +294,7 @@
268
294
 
269
295
 
270
296
  <span class="summary_desc"><div class='inline'>
271
- <p>Delete an Event Stream.</p>
297
+ <p>Delete a Failover backend by ID.</p>
272
298
  </div></span>
273
299
 
274
300
  </li>
@@ -277,7 +303,7 @@
277
303
  <li class="public ">
278
304
  <span class="summary_signature">
279
305
 
280
- <a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::EventStream </a>
306
+ <a href="#get-instance_method" title="#get (instance method)">#<strong>get</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::FailoverBackend </a>
281
307
 
282
308
 
283
309
 
@@ -292,7 +318,7 @@
292
318
 
293
319
 
294
320
  <span class="summary_desc"><div class='inline'>
295
- <p>Get detailed information about an Event Stream by ID.</p>
321
+ <p>Get detailed information about a Failover backend by ID.</p>
296
322
  </div></span>
297
323
 
298
324
  </li>
@@ -301,7 +327,7 @@
301
327
  <li class="public ">
302
328
  <span class="summary_signature">
303
329
 
304
- <a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::EventStream </a>
330
+ <a href="#get!-instance_method" title="#get! (instance method)">#<strong>get!</strong>(id: &quot;&quot;) &#x21d2; NgrokAPI::Models::FailoverBackend </a>
305
331
 
306
332
 
307
333
 
@@ -316,7 +342,7 @@
316
342
 
317
343
 
318
344
  <span class="summary_desc"><div class='inline'>
319
- <p>Get detailed information about an Event Stream by ID.</p>
345
+ <p>Get detailed information about a Failover backend by ID Throws an exception if API error.</p>
320
346
  </div></span>
321
347
 
322
348
  </li>
@@ -325,7 +351,7 @@
325
351
  <li class="public ">
326
352
  <span class="summary_signature">
327
353
 
328
- <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) &#x21d2; EventStreamsClient </a>
354
+ <a href="#initialize-instance_method" title="#initialize (instance method)">#<strong>initialize</strong>(client:) &#x21d2; FailoverBackendsClient </a>
329
355
 
330
356
 
331
357
 
@@ -342,7 +368,7 @@
342
368
 
343
369
 
344
370
  <span class="summary_desc"><div class='inline'>
345
- <p>A new instance of EventStreamsClient.</p>
371
+ <p>A new instance of FailoverBackendsClient.</p>
346
372
  </div></span>
347
373
 
348
374
  </li>
@@ -366,7 +392,7 @@
366
392
 
367
393
 
368
394
  <span class="summary_desc"><div class='inline'>
369
- <p>List all Event Streams available on this account.</p>
395
+ <p>List all Failover backends on this account.</p>
370
396
  </div></span>
371
397
 
372
398
  </li>
@@ -390,7 +416,7 @@
390
416
 
391
417
 
392
418
  <span class="summary_desc"><div class='inline'>
393
- <p>List all Event Streams available on this account.</p>
419
+ <p>List all Failover backends on this account Throws an exception if API error.</p>
394
420
  </div></span>
395
421
 
396
422
  </li>
@@ -399,7 +425,7 @@
399
425
  <li class="public ">
400
426
  <span class="summary_signature">
401
427
 
402
- <a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: &quot;&quot;, metadata: nil, description: nil, fields: nil, destination_ids: nil, sampling_rate: nil) &#x21d2; NgrokAPI::Models::EventStream </a>
428
+ <a href="#update-instance_method" title="#update (instance method)">#<strong>update</strong>(id: &quot;&quot;, description: nil, metadata: nil, backends: []) &#x21d2; NgrokAPI::Models::FailoverBackend </a>
403
429
 
404
430
 
405
431
 
@@ -414,7 +440,7 @@
414
440
 
415
441
 
416
442
  <span class="summary_desc"><div class='inline'>
417
- <p>Update attributes of an Event Stream by ID.</p>
443
+ <p>Update Failover backend by ID.</p>
418
444
  </div></span>
419
445
 
420
446
  </li>
@@ -423,7 +449,7 @@
423
449
  <li class="public ">
424
450
  <span class="summary_signature">
425
451
 
426
- <a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: &quot;&quot;, metadata: nil, description: nil, fields: nil, destination_ids: nil, sampling_rate: nil) &#x21d2; NgrokAPI::Models::EventStream </a>
452
+ <a href="#update!-instance_method" title="#update! (instance method)">#<strong>update!</strong>(id: &quot;&quot;, description: nil, metadata: nil, backends: []) &#x21d2; NgrokAPI::Models::FailoverBackend </a>
427
453
 
428
454
 
429
455
 
@@ -438,7 +464,7 @@
438
464
 
439
465
 
440
466
  <span class="summary_desc"><div class='inline'>
441
- <p>Update attributes of an Event Stream by ID.</p>
467
+ <p>Update Failover backend by ID Throws an exception if API error.</p>
442
468
  </div></span>
443
469
 
444
470
  </li>
@@ -453,7 +479,7 @@
453
479
  <div class="method_details first">
454
480
  <h3 class="signature first" id="initialize-instance_method">
455
481
 
456
- #<strong>initialize</strong>(client:) &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Services::EventStreamsClient (class)">EventStreamsClient</a></span></tt>
482
+ #<strong>initialize</strong>(client:) &#x21d2; <tt><span class='object_link'><a href="" title="NgrokAPI::Services::FailoverBackendsClient (class)">FailoverBackendsClient</a></span></tt>
457
483
 
458
484
 
459
485
 
@@ -462,7 +488,7 @@
462
488
  </h3><div class="docstring">
463
489
  <div class="discussion">
464
490
 
465
- <p>Returns a new instance of EventStreamsClient.</p>
491
+ <p>Returns a new instance of FailoverBackendsClient.</p>
466
492
 
467
493
 
468
494
  </div>
@@ -476,12 +502,12 @@
476
502
  <pre class="lines">
477
503
 
478
504
 
479
- 15
480
- 16
481
- 17</pre>
505
+ 20
506
+ 21
507
+ 22</pre>
482
508
  </td>
483
509
  <td>
484
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 15</span>
510
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/failover_backends_client.rb', line 20</span>
485
511
 
486
512
  <span class='kw'>def</span> <span class='id identifier rubyid_initialize'>initialize</span><span class='lparen'>(</span><span class='label'>client:</span><span class='rparen'>)</span>
487
513
  <span class='ivar'>@client</span> <span class='op'>=</span> <span class='id identifier rubyid_client'>client</span>
@@ -524,12 +550,12 @@
524
550
  <pre class="lines">
525
551
 
526
552
 
527
- 13
528
- 14
529
- 15</pre>
553
+ 18
554
+ 19
555
+ 20</pre>
530
556
  </td>
531
557
  <td>
532
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 13</span>
558
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/failover_backends_client.rb', line 18</span>
533
559
 
534
560
  <span class='kw'>def</span> <span class='id identifier rubyid_client'>client</span>
535
561
  <span class='ivar'>@client</span>
@@ -549,7 +575,7 @@
549
575
  <div class="method_details first">
550
576
  <h3 class="signature first" id="create-instance_method">
551
577
 
552
- #<strong>create</strong>(metadata: &quot;&quot;, description: &quot;&quot;, fields: [], event_type: &quot;&quot;, destination_ids: [], sampling_rate: 0) &#x21d2; <tt><span class='object_link'><a href="../Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">NgrokAPI::Models::EventStream</a></span></tt>
578
+ #<strong>create</strong>(description: &quot;&quot;, metadata: &quot;&quot;, backends: []) &#x21d2; <tt><span class='object_link'><a href="../Models/FailoverBackend.html" title="NgrokAPI::Models::FailoverBackend (class)">NgrokAPI::Models::FailoverBackend</a></span></tt>
553
579
 
554
580
 
555
581
 
@@ -558,9 +584,9 @@
558
584
  </h3><div class="docstring">
559
585
  <div class="discussion">
560
586
 
561
- <p>Create a new Event Stream. It will not apply to anything until you associate it with one or more Endpoint Configs.</p>
587
+ <p>Create a new Failover backend</p>
562
588
 
563
- <p><a href="https://ngrok.com/docs/api#api-event-streams-create">ngrok.com/docs/api#api-event-streams-create</a></p>
589
+ <p><a href="https://ngrok.com/docs/api#api-failover-backends-create">ngrok.com/docs/api#api-failover-backends-create</a></p>
564
590
 
565
591
 
566
592
  </div>
@@ -571,7 +597,7 @@
571
597
 
572
598
  <li>
573
599
 
574
- <span class='name'>metadata</span>
600
+ <span class='name'>description</span>
575
601
 
576
602
 
577
603
  <span class='type'>(<tt>string</tt>)</span>
@@ -582,14 +608,14 @@
582
608
 
583
609
  &mdash;
584
610
  <div class='inline'>
585
- <p>Arbitrary user-defined machine-readable data of this Event Stream. Optional, max 4096 bytes.</p>
611
+ <p>human-readable description of this backend. Optional</p>
586
612
  </div>
587
613
 
588
614
  </li>
589
615
 
590
616
  <li>
591
617
 
592
- <span class='name'>description</span>
618
+ <span class='name'>metadata</span>
593
619
 
594
620
 
595
621
  <span class='type'>(<tt>string</tt>)</span>
@@ -600,14 +626,14 @@
600
626
 
601
627
  &mdash;
602
628
  <div class='inline'>
603
- <p>Human-readable description of the Event Stream. Optional, max 255 bytes.</p>
629
+ <p>arbitrary user-defined machine-readable data of this backend. Optional</p>
604
630
  </div>
605
631
 
606
632
  </li>
607
633
 
608
634
  <li>
609
635
 
610
- <span class='name'>fields</span>
636
+ <span class='name'>backends</span>
611
637
 
612
638
 
613
639
  <span class='type'>(<tt>List&lt;string&gt;</tt>)</span>
@@ -618,14 +644,95 @@
618
644
 
619
645
  &mdash;
620
646
  <div class='inline'>
621
- <p>A list of protocol-specific fields you want to collect on each event.</p>
647
+ <p>the ids of the child backends in order</p>
622
648
  </div>
623
649
 
624
650
  </li>
625
651
 
652
+ </ul>
653
+
654
+ <p class="tag_title">Returns:</p>
655
+ <ul class="return">
656
+
626
657
  <li>
627
658
 
628
- <span class='name'>event_type</span>
659
+
660
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/FailoverBackend.html" title="NgrokAPI::Models::FailoverBackend (class)">NgrokAPI::Models::FailoverBackend</a></span></tt>)</span>
661
+
662
+
663
+
664
+ &mdash;
665
+ <div class='inline'>
666
+ <p>result from the API request</p>
667
+ </div>
668
+
669
+ </li>
670
+
671
+ </ul>
672
+
673
+ </div><table class="source_code">
674
+ <tr>
675
+ <td>
676
+ <pre class="lines">
677
+
678
+
679
+ 33
680
+ 34
681
+ 35
682
+ 36
683
+ 37
684
+ 38
685
+ 39
686
+ 40
687
+ 41
688
+ 42
689
+ 43</pre>
690
+ </td>
691
+ <td>
692
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/failover_backends_client.rb', line 33</span>
693
+
694
+ <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'>backends:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span>
695
+ <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'>/backends/failover</span><span class='tstring_end'>&#39;</span></span>
696
+ <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
697
+ <span class='rbrace'>}</span>
698
+ <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
699
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
700
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
701
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:backends</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_backends'>backends</span> <span class='kw'>if</span> <span class='id identifier rubyid_backends'>backends</span>
702
+ <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>
703
+ <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/FailoverBackend.html" title="NgrokAPI::Models::FailoverBackend (class)">FailoverBackend</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/FailoverBackend.html#initialize-instance_method" title="NgrokAPI::Models::FailoverBackend#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>
704
+ <span class='kw'>end</span></pre>
705
+ </td>
706
+ </tr>
707
+ </table>
708
+ </div>
709
+
710
+ <div class="method_details ">
711
+ <h3 class="signature " id="create!-instance_method">
712
+
713
+ #<strong>create!</strong>(description: &quot;&quot;, metadata: &quot;&quot;, backends: []) &#x21d2; <tt><span class='object_link'><a href="../Models/FailoverBackend.html" title="NgrokAPI::Models::FailoverBackend (class)">NgrokAPI::Models::FailoverBackend</a></span></tt>
714
+
715
+
716
+
717
+
718
+
719
+ </h3><div class="docstring">
720
+ <div class="discussion">
721
+
722
+ <p>Create a new Failover backend Throws an exception if API error.</p>
723
+
724
+ <p><a href="https://ngrok.com/docs/api#api-failover-backends-create">ngrok.com/docs/api#api-failover-backends-create</a></p>
725
+
726
+
727
+ </div>
728
+ </div>
729
+ <div class="tags">
730
+ <p class="tag_title">Parameters:</p>
731
+ <ul class="param">
732
+
733
+ <li>
734
+
735
+ <span class='name'>description</span>
629
736
 
630
737
 
631
738
  <span class='type'>(<tt>string</tt>)</span>
@@ -636,43 +743,43 @@
636
743
 
637
744
  &mdash;
638
745
  <div class='inline'>
639
- <p>The protocol that determines which events will be collected. Supported values are <code>tcp_connection_closed</code> and <code>http_request_complete</code>.</p>
746
+ <p>human-readable description of this backend. Optional</p>
640
747
  </div>
641
748
 
642
749
  </li>
643
750
 
644
751
  <li>
645
752
 
646
- <span class='name'>destination_ids</span>
753
+ <span class='name'>metadata</span>
647
754
 
648
755
 
649
- <span class='type'>(<tt>List&lt;string&gt;</tt>)</span>
756
+ <span class='type'>(<tt>string</tt>)</span>
650
757
 
651
758
 
652
- <em class="default">(defaults to: <tt>[]</tt>)</em>
759
+ <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
653
760
 
654
761
 
655
762
  &mdash;
656
763
  <div class='inline'>
657
- <p>A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.</p>
764
+ <p>arbitrary user-defined machine-readable data of this backend. Optional</p>
658
765
  </div>
659
766
 
660
767
  </li>
661
768
 
662
769
  <li>
663
770
 
664
- <span class='name'>sampling_rate</span>
771
+ <span class='name'>backends</span>
665
772
 
666
773
 
667
- <span class='type'>(<tt>float64</tt>)</span>
774
+ <span class='type'>(<tt>List&lt;string&gt;</tt>)</span>
668
775
 
669
776
 
670
- <em class="default">(defaults to: <tt>0</tt>)</em>
777
+ <em class="default">(defaults to: <tt>[]</tt>)</em>
671
778
 
672
779
 
673
780
  &mdash;
674
781
  <div class='inline'>
675
- <p>The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events.</p>
782
+ <p>the ids of the child backends in order</p>
676
783
  </div>
677
784
 
678
785
  </li>
@@ -685,7 +792,7 @@
685
792
  <li>
686
793
 
687
794
 
688
- <span class='type'>(<tt><span class='object_link'><a href="../Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">NgrokAPI::Models::EventStream</a></span></tt>)</span>
795
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/FailoverBackend.html" title="NgrokAPI::Models::FailoverBackend (class)">NgrokAPI::Models::FailoverBackend</a></span></tt>)</span>
689
796
 
690
797
 
691
798
 
@@ -704,37 +811,31 @@
704
811
  <pre class="lines">
705
812
 
706
813
 
707
- 32
708
- 33
709
- 34
710
- 35
711
- 36
712
- 37
713
- 38
714
- 39
715
- 40
716
- 41
717
- 42
718
- 43
719
- 44
720
- 45</pre>
814
+ 55
815
+ 56
816
+ 57
817
+ 58
818
+ 59
819
+ 60
820
+ 61
821
+ 62
822
+ 63
823
+ 64
824
+ 65</pre>
721
825
  </td>
722
826
  <td>
723
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 32</span>
827
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/failover_backends_client.rb', line 55</span>
724
828
 
725
- <span class='kw'>def</span> <span class='id identifier rubyid_create'>create</span><span class='lparen'>(</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'>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'>fields:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>event_type:</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_end'>&quot;</span></span><span class='comma'>,</span> <span class='label'>destination_ids:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='comma'>,</span> <span class='label'>sampling_rate:</span> <span class='int'>0</span><span class='rparen'>)</span>
726
- <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'>/event_streams</span><span class='tstring_end'>&#39;</span></span>
829
+ <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'>backends:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span>
830
+ <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'>/backends/failover</span><span class='tstring_end'>&#39;</span></span>
727
831
  <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
728
832
  <span class='rbrace'>}</span>
729
833
  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
730
- <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
731
834
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
732
- <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:fields</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_fields'>fields</span> <span class='kw'>if</span> <span class='id identifier rubyid_fields'>fields</span>
733
- <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:event_type</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_event_type'>event_type</span> <span class='kw'>if</span> <span class='id identifier rubyid_event_type'>event_type</span>
734
- <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:destination_ids</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_destination_ids'>destination_ids</span> <span class='kw'>if</span> <span class='id identifier rubyid_destination_ids'>destination_ids</span>
735
- <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:sampling_rate</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_sampling_rate'>sampling_rate</span> <span class='kw'>if</span> <span class='id identifier rubyid_sampling_rate'>sampling_rate</span>
736
- <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>
737
- <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/EventStream.html" title="NgrokAPI::Models::EventStream (class)">EventStream</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventStream.html#initialize-instance_method" title="NgrokAPI::Models::EventStream#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'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
835
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
836
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:backends</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_backends'>backends</span> <span class='kw'>if</span> <span class='id identifier rubyid_backends'>backends</span>
837
+ <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>
838
+ <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/FailoverBackend.html" title="NgrokAPI::Models::FailoverBackend (class)">FailoverBackend</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/FailoverBackend.html#initialize-instance_method" title="NgrokAPI::Models::FailoverBackend#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>
738
839
  <span class='kw'>end</span></pre>
739
840
  </td>
740
841
  </tr>
@@ -753,9 +854,9 @@
753
854
  </h3><div class="docstring">
754
855
  <div class="discussion">
755
856
 
756
- <p>Delete an Event Stream. Associated Event Destinations will be preserved.</p>
857
+ <p>Delete a Failover backend by ID.</p>
757
858
 
758
- <p><a href="https://ngrok.com/docs/api#api-event-streams-delete">ngrok.com/docs/api#api-event-streams-delete</a></p>
859
+ <p><a href="https://ngrok.com/docs/api#api-failover-backends-delete">ngrok.com/docs/api#api-failover-backends-delete</a></p>
759
860
 
760
861
 
761
862
  </div>
@@ -809,19 +910,19 @@
809
910
  <pre class="lines">
810
911
 
811
912
 
812
- 54
813
- 55
814
- 56
815
- 57
816
- 58
817
- 59
818
- 60</pre>
913
+ 74
914
+ 75
915
+ 76
916
+ 77
917
+ 78
918
+ 79
919
+ 80</pre>
819
920
  </td>
820
921
  <td>
821
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 54</span>
922
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/failover_backends_client.rb', line 74</span>
822
923
 
823
924
  <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>
824
- <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'>/event_streams/%{id}</span><span class='tstring_end'>&#39;</span></span>
925
+ <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'>/backends/failover/%{id}</span><span class='tstring_end'>&#39;</span></span>
825
926
  <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
826
927
  <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
827
928
  <span class='rbrace'>}</span>
@@ -844,9 +945,9 @@
844
945
  </h3><div class="docstring">
845
946
  <div class="discussion">
846
947
 
847
- <p>Delete an Event Stream. Associated Event Destinations will be preserved. Throws an exception if API error.</p>
948
+ <p>Delete a Failover backend by ID. Throws an exception if API error.</p>
848
949
 
849
- <p><a href="https://ngrok.com/docs/api#api-event-streams-delete">ngrok.com/docs/api#api-event-streams-delete</a></p>
950
+ <p><a href="https://ngrok.com/docs/api#api-failover-backends-delete">ngrok.com/docs/api#api-failover-backends-delete</a></p>
850
951
 
851
952
 
852
953
  </div>
@@ -900,19 +1001,19 @@
900
1001
  <pre class="lines">
901
1002
 
902
1003
 
903
- 70
904
- 71
905
- 72
906
- 73
907
- 74
908
- 75
909
- 76</pre>
1004
+ 90
1005
+ 91
1006
+ 92
1007
+ 93
1008
+ 94
1009
+ 95
1010
+ 96</pre>
910
1011
  </td>
911
1012
  <td>
912
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 70</span>
1013
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/failover_backends_client.rb', line 90</span>
913
1014
 
914
1015
  <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>
915
- <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'>/event_streams/%{id}</span><span class='tstring_end'>&#39;</span></span>
1016
+ <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'>/backends/failover/%{id}</span><span class='tstring_end'>&#39;</span></span>
916
1017
  <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
917
1018
  <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
918
1019
  <span class='rbrace'>}</span>
@@ -926,7 +1027,7 @@
926
1027
  <div class="method_details ">
927
1028
  <h3 class="signature " id="get-instance_method">
928
1029
 
929
- #<strong>get</strong>(id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">NgrokAPI::Models::EventStream</a></span></tt>
1030
+ #<strong>get</strong>(id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/FailoverBackend.html" title="NgrokAPI::Models::FailoverBackend (class)">NgrokAPI::Models::FailoverBackend</a></span></tt>
930
1031
 
931
1032
 
932
1033
 
@@ -935,9 +1036,9 @@
935
1036
  </h3><div class="docstring">
936
1037
  <div class="discussion">
937
1038
 
938
- <p>Get detailed information about an Event Stream by ID.</p>
1039
+ <p>Get detailed information about a Failover backend by ID</p>
939
1040
 
940
- <p><a href="https://ngrok.com/docs/api#api-event-streams-get">ngrok.com/docs/api#api-event-streams-get</a></p>
1041
+ <p><a href="https://ngrok.com/docs/api#api-failover-backends-get">ngrok.com/docs/api#api-failover-backends-get</a></p>
941
1042
 
942
1043
 
943
1044
  </div>
@@ -972,7 +1073,7 @@
972
1073
  <li>
973
1074
 
974
1075
 
975
- <span class='type'>(<tt><span class='object_link'><a href="../Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">NgrokAPI::Models::EventStream</a></span></tt>)</span>
1076
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/FailoverBackend.html" title="NgrokAPI::Models::FailoverBackend (class)">NgrokAPI::Models::FailoverBackend</a></span></tt>)</span>
976
1077
 
977
1078
 
978
1079
 
@@ -991,27 +1092,27 @@
991
1092
  <pre class="lines">
992
1093
 
993
1094
 
994
- 85
995
- 86
996
- 87
997
- 88
998
- 89
999
- 90
1000
- 91
1001
- 92
1002
- 93</pre>
1095
+ 105
1096
+ 106
1097
+ 107
1098
+ 108
1099
+ 109
1100
+ 110
1101
+ 111
1102
+ 112
1103
+ 113</pre>
1003
1104
  </td>
1004
1105
  <td>
1005
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 85</span>
1106
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/failover_backends_client.rb', line 105</span>
1006
1107
 
1007
1108
  <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>
1008
- <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'>/event_streams/%{id}</span><span class='tstring_end'>&#39;</span></span>
1109
+ <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'>/backends/failover/%{id}</span><span class='tstring_end'>&#39;</span></span>
1009
1110
  <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1010
1111
  <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1011
1112
  <span class='rbrace'>}</span>
1012
1113
  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1013
1114
  <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_get'>get</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>
1014
- <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/EventStream.html" title="NgrokAPI::Models::EventStream (class)">EventStream</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventStream.html#initialize-instance_method" title="NgrokAPI::Models::EventStream#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'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1115
+ <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/FailoverBackend.html" title="NgrokAPI::Models::FailoverBackend (class)">FailoverBackend</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/FailoverBackend.html#initialize-instance_method" title="NgrokAPI::Models::FailoverBackend#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>
1015
1116
  <span class='kw'>end</span></pre>
1016
1117
  </td>
1017
1118
  </tr>
@@ -1021,7 +1122,7 @@
1021
1122
  <div class="method_details ">
1022
1123
  <h3 class="signature " id="get!-instance_method">
1023
1124
 
1024
- #<strong>get!</strong>(id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">NgrokAPI::Models::EventStream</a></span></tt>
1125
+ #<strong>get!</strong>(id: &quot;&quot;) &#x21d2; <tt><span class='object_link'><a href="../Models/FailoverBackend.html" title="NgrokAPI::Models::FailoverBackend (class)">NgrokAPI::Models::FailoverBackend</a></span></tt>
1025
1126
 
1026
1127
 
1027
1128
 
@@ -1030,9 +1131,9 @@
1030
1131
  </h3><div class="docstring">
1031
1132
  <div class="discussion">
1032
1133
 
1033
- <p>Get detailed information about an Event Stream by ID. Throws an exception if API error.</p>
1134
+ <p>Get detailed information about a Failover backend by ID Throws an exception if API error.</p>
1034
1135
 
1035
- <p><a href="https://ngrok.com/docs/api#api-event-streams-get">ngrok.com/docs/api#api-event-streams-get</a></p>
1136
+ <p><a href="https://ngrok.com/docs/api#api-failover-backends-get">ngrok.com/docs/api#api-failover-backends-get</a></p>
1036
1137
 
1037
1138
 
1038
1139
  </div>
@@ -1067,7 +1168,7 @@
1067
1168
  <li>
1068
1169
 
1069
1170
 
1070
- <span class='type'>(<tt><span class='object_link'><a href="../Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">NgrokAPI::Models::EventStream</a></span></tt>)</span>
1171
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/FailoverBackend.html" title="NgrokAPI::Models::FailoverBackend (class)">NgrokAPI::Models::FailoverBackend</a></span></tt>)</span>
1071
1172
 
1072
1173
 
1073
1174
 
@@ -1086,27 +1187,27 @@
1086
1187
  <pre class="lines">
1087
1188
 
1088
1189
 
1089
- 103
1090
- 104
1091
- 105
1092
- 106
1093
- 107
1094
- 108
1095
- 109
1096
- 110
1097
- 111</pre>
1190
+ 123
1191
+ 124
1192
+ 125
1193
+ 126
1194
+ 127
1195
+ 128
1196
+ 129
1197
+ 130
1198
+ 131</pre>
1098
1199
  </td>
1099
1200
  <td>
1100
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 103</span>
1201
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/failover_backends_client.rb', line 123</span>
1101
1202
 
1102
1203
  <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>
1103
- <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'>/event_streams/%{id}</span><span class='tstring_end'>&#39;</span></span>
1204
+ <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'>/backends/failover/%{id}</span><span class='tstring_end'>&#39;</span></span>
1104
1205
  <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1105
1206
  <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1106
1207
  <span class='rbrace'>}</span>
1107
1208
  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1108
1209
  <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_get'>get</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>
1109
- <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/EventStream.html" title="NgrokAPI::Models::EventStream (class)">EventStream</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventStream.html#initialize-instance_method" title="NgrokAPI::Models::EventStream#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'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1210
+ <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/FailoverBackend.html" title="NgrokAPI::Models::FailoverBackend (class)">FailoverBackend</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/FailoverBackend.html#initialize-instance_method" title="NgrokAPI::Models::FailoverBackend#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>
1110
1211
  <span class='kw'>end</span></pre>
1111
1212
  </td>
1112
1213
  </tr>
@@ -1125,9 +1226,9 @@
1125
1226
  </h3><div class="docstring">
1126
1227
  <div class="discussion">
1127
1228
 
1128
- <p>List all Event Streams available on this account.</p>
1229
+ <p>List all Failover backends on this account</p>
1129
1230
 
1130
- <p><a href="https://ngrok.com/docs/api#api-event-streams-list">ngrok.com/docs/api#api-event-streams-list</a></p>
1231
+ <p><a href="https://ngrok.com/docs/api#api-failover-backends-list">ngrok.com/docs/api#api-failover-backends-list</a></p>
1131
1232
 
1132
1233
 
1133
1234
  </div>
@@ -1207,40 +1308,38 @@
1207
1308
  <pre class="lines">
1208
1309
 
1209
1310
 
1210
- 122
1211
- 123
1212
- 124
1213
- 125
1214
- 126
1215
- 127
1216
- 128
1217
- 129
1218
- 130
1219
- 131
1220
- 132
1221
- 133
1222
- 134
1223
- 135
1224
- 136
1225
- 137</pre>
1311
+ 142
1312
+ 143
1313
+ 144
1314
+ 145
1315
+ 146
1316
+ 147
1317
+ 148
1318
+ 149
1319
+ 150
1320
+ 151
1321
+ 152
1322
+ 153
1323
+ 154
1324
+ 155
1325
+ 156</pre>
1226
1326
  </td>
1227
1327
  <td>
1228
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 122</span>
1328
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/failover_backends_client.rb', line 142</span>
1229
1329
 
1230
- <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>
1231
- <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1330
+ <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>
1232
1331
  <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>
1233
1332
  <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
1234
1333
  <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
1235
1334
  <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
1236
- <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EventStreamsClient::PATH (constant)">PATH</a></span></span>
1335
+ <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::FailoverBackendsClient::PATH (constant)">PATH</a></span></span>
1237
1336
  <span class='rparen'>)</span>
1238
1337
 
1239
1338
  <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/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
1240
1339
  <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
1241
- <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1242
- <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EventStreamsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1243
- <span class='label'>klass:</span> <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/EventStream.html" title="NgrokAPI::Models::EventStream (class)">EventStream</a></span></span>
1340
+ <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1341
+ <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::FailoverBackendsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1342
+ <span class='label'>klass:</span> <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/FailoverBackend.html" title="NgrokAPI::Models::FailoverBackend (class)">FailoverBackend</a></span></span>
1244
1343
  <span class='rparen'>)</span>
1245
1344
  <span class='kw'>end</span></pre>
1246
1345
  </td>
@@ -1260,9 +1359,9 @@
1260
1359
  </h3><div class="docstring">
1261
1360
  <div class="discussion">
1262
1361
 
1263
- <p>List all Event Streams available on this account. Throws an exception if API error.</p>
1362
+ <p>List all Failover backends on this account Throws an exception if API error.</p>
1264
1363
 
1265
- <p><a href="https://ngrok.com/docs/api#api-event-streams-list">ngrok.com/docs/api#api-event-streams-list</a></p>
1364
+ <p><a href="https://ngrok.com/docs/api#api-failover-backends-list">ngrok.com/docs/api#api-failover-backends-list</a></p>
1266
1365
 
1267
1366
 
1268
1367
  </div>
@@ -1342,43 +1441,41 @@
1342
1441
  <pre class="lines">
1343
1442
 
1344
1443
 
1345
- 149
1346
- 150
1347
- 151
1348
- 152
1349
- 153
1350
- 154
1351
- 155
1352
- 156
1353
- 157
1354
- 158
1355
- 159
1356
- 160
1357
- 161
1358
- 162
1359
- 163
1360
- 164
1361
- 165
1362
- 166</pre>
1444
+ 168
1445
+ 169
1446
+ 170
1447
+ 171
1448
+ 172
1449
+ 173
1450
+ 174
1451
+ 175
1452
+ 176
1453
+ 177
1454
+ 178
1455
+ 179
1456
+ 180
1457
+ 181
1458
+ 182
1459
+ 183
1460
+ 184</pre>
1363
1461
  </td>
1364
1462
  <td>
1365
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 149</span>
1463
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/failover_backends_client.rb', line 168</span>
1366
1464
 
1367
- <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>
1368
- <span class='label'>url:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1465
+ <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>
1369
1466
  <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>
1370
1467
  <span class='label'>before_id:</span> <span class='id identifier rubyid_before_id'>before_id</span><span class='comma'>,</span>
1371
1468
  <span class='label'>limit:</span> <span class='id identifier rubyid_limit'>limit</span><span class='comma'>,</span>
1372
1469
  <span class='label'>danger:</span> <span class='kw'>true</span><span class='comma'>,</span>
1373
1470
  <span class='label'>url:</span> <span class='id identifier rubyid_url'>url</span><span class='comma'>,</span>
1374
- <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::EventStreamsClient::PATH (constant)">PATH</a></span></span>
1471
+ <span class='label'>path:</span> <span class='const'><span class='object_link'><a href="#PATH-constant" title="NgrokAPI::Services::FailoverBackendsClient::PATH (constant)">PATH</a></span></span>
1375
1472
  <span class='rparen'>)</span>
1376
1473
 
1377
1474
  <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/Listable.html" title="NgrokAPI::Models::Listable (class)">Listable</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/Listable.html#initialize-instance_method" title="NgrokAPI::Models::Listable#initialize (method)">new</a></span></span><span class='lparen'>(</span>
1378
1475
  <span class='label'>client:</span> <span class='kw'>self</span><span class='comma'>,</span>
1379
- <span class='label'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1380
- <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::EventStreamsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1381
- <span class='label'>klass:</span> <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/EventStream.html" title="NgrokAPI::Models::EventStream (class)">EventStream</a></span></span><span class='comma'>,</span>
1476
+ <span class='label'>attrs:</span> <span class='id identifier rubyid_result'>result</span><span class='comma'>,</span>
1477
+ <span class='label'>list_property:</span> <span class='const'><span class='object_link'><a href="#LIST_PROPERTY-constant" title="NgrokAPI::Services::FailoverBackendsClient::LIST_PROPERTY (constant)">LIST_PROPERTY</a></span></span><span class='comma'>,</span>
1478
+ <span class='label'>klass:</span> <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/FailoverBackend.html" title="NgrokAPI::Models::FailoverBackend (class)">FailoverBackend</a></span></span><span class='comma'>,</span>
1382
1479
  <span class='label'>danger:</span> <span class='kw'>true</span>
1383
1480
  <span class='rparen'>)</span>
1384
1481
  <span class='kw'>end</span></pre>
@@ -1390,7 +1487,7 @@
1390
1487
  <div class="method_details ">
1391
1488
  <h3 class="signature " id="update-instance_method">
1392
1489
 
1393
- #<strong>update</strong>(id: &quot;&quot;, metadata: nil, description: nil, fields: nil, destination_ids: nil, sampling_rate: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">NgrokAPI::Models::EventStream</a></span></tt>
1490
+ #<strong>update</strong>(id: &quot;&quot;, description: nil, metadata: nil, backends: []) &#x21d2; <tt><span class='object_link'><a href="../Models/FailoverBackend.html" title="NgrokAPI::Models::FailoverBackend (class)">NgrokAPI::Models::FailoverBackend</a></span></tt>
1394
1491
 
1395
1492
 
1396
1493
 
@@ -1399,9 +1496,9 @@
1399
1496
  </h3><div class="docstring">
1400
1497
  <div class="discussion">
1401
1498
 
1402
- <p>Update attributes of an Event Stream by ID.</p>
1499
+ <p>Update Failover backend by ID</p>
1403
1500
 
1404
- <p><a href="https://ngrok.com/docs/api#api-event-streams-update">ngrok.com/docs/api#api-event-streams-update</a></p>
1501
+ <p><a href="https://ngrok.com/docs/api#api-failover-backends-update">ngrok.com/docs/api#api-failover-backends-update</a></p>
1405
1502
 
1406
1503
 
1407
1504
  </div>
@@ -1421,29 +1518,6 @@
1421
1518
  <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
1422
1519
 
1423
1520
 
1424
- &mdash;
1425
- <div class='inline'>
1426
- <p>Unique identifier for this Event Stream.</p>
1427
- </div>
1428
-
1429
- </li>
1430
-
1431
- <li>
1432
-
1433
- <span class='name'>metadata</span>
1434
-
1435
-
1436
- <span class='type'>(<tt>string</tt>)</span>
1437
-
1438
-
1439
- <em class="default">(defaults to: <tt>nil</tt>)</em>
1440
-
1441
-
1442
- &mdash;
1443
- <div class='inline'>
1444
- <p>Arbitrary user-defined machine-readable data of this Event Stream. Optional, max 4096 bytes.</p>
1445
- </div>
1446
-
1447
1521
  </li>
1448
1522
 
1449
1523
  <li>
@@ -1459,17 +1533,17 @@
1459
1533
 
1460
1534
  &mdash;
1461
1535
  <div class='inline'>
1462
- <p>Human-readable description of the Event Stream. Optional, max 255 bytes.</p>
1536
+ <p>human-readable description of this backend. Optional</p>
1463
1537
  </div>
1464
1538
 
1465
1539
  </li>
1466
1540
 
1467
1541
  <li>
1468
1542
 
1469
- <span class='name'>fields</span>
1543
+ <span class='name'>metadata</span>
1470
1544
 
1471
1545
 
1472
- <span class='type'>(<tt>List&lt;string&gt;</tt>)</span>
1546
+ <span class='type'>(<tt>string</tt>)</span>
1473
1547
 
1474
1548
 
1475
1549
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -1477,43 +1551,25 @@
1477
1551
 
1478
1552
  &mdash;
1479
1553
  <div class='inline'>
1480
- <p>A list of protocol-specific fields you want to collect on each event.</p>
1554
+ <p>arbitrary user-defined machine-readable data of this backend. Optional</p>
1481
1555
  </div>
1482
1556
 
1483
1557
  </li>
1484
1558
 
1485
1559
  <li>
1486
1560
 
1487
- <span class='name'>destination_ids</span>
1561
+ <span class='name'>backends</span>
1488
1562
 
1489
1563
 
1490
1564
  <span class='type'>(<tt>List&lt;string&gt;</tt>)</span>
1491
1565
 
1492
1566
 
1493
- <em class="default">(defaults to: <tt>nil</tt>)</em>
1494
-
1495
-
1496
- &mdash;
1497
- <div class='inline'>
1498
- <p>A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.</p>
1499
- </div>
1500
-
1501
- </li>
1502
-
1503
- <li>
1504
-
1505
- <span class='name'>sampling_rate</span>
1506
-
1507
-
1508
- <span class='type'>(<tt>float64</tt>)</span>
1509
-
1510
-
1511
- <em class="default">(defaults to: <tt>nil</tt>)</em>
1567
+ <em class="default">(defaults to: <tt>[]</tt>)</em>
1512
1568
 
1513
1569
 
1514
1570
  &mdash;
1515
1571
  <div class='inline'>
1516
- <p>The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events.</p>
1572
+ <p>the ids of the child backends in order</p>
1517
1573
  </div>
1518
1574
 
1519
1575
  </li>
@@ -1526,7 +1582,7 @@
1526
1582
  <li>
1527
1583
 
1528
1584
 
1529
- <span class='type'>(<tt><span class='object_link'><a href="../Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">NgrokAPI::Models::EventStream</a></span></tt>)</span>
1585
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/FailoverBackend.html" title="NgrokAPI::Models::FailoverBackend (class)">NgrokAPI::Models::FailoverBackend</a></span></tt>)</span>
1530
1586
 
1531
1587
 
1532
1588
 
@@ -1545,37 +1601,33 @@
1545
1601
  <pre class="lines">
1546
1602
 
1547
1603
 
1548
- 180
1549
- 181
1550
- 182
1551
- 183
1552
- 184
1553
- 185
1554
- 186
1555
- 187
1556
- 188
1557
- 189
1558
- 190
1559
- 191
1560
- 192
1561
- 193</pre>
1604
+ 196
1605
+ 197
1606
+ 198
1607
+ 199
1608
+ 200
1609
+ 201
1610
+ 202
1611
+ 203
1612
+ 204
1613
+ 205
1614
+ 206
1615
+ 207</pre>
1562
1616
  </td>
1563
1617
  <td>
1564
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 180</span>
1618
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/failover_backends_client.rb', line 196</span>
1565
1619
 
1566
- <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'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>fields:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>destination_ids:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>sampling_rate:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1567
- <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'>/event_streams/%{id}</span><span class='tstring_end'>&#39;</span></span>
1620
+ <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'>backends:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span>
1621
+ <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'>/backends/failover/%{id}</span><span class='tstring_end'>&#39;</span></span>
1568
1622
  <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1569
1623
  <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1570
1624
  <span class='rbrace'>}</span>
1571
1625
  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1572
- <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
1573
1626
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
1574
- <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:fields</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_fields'>fields</span> <span class='kw'>if</span> <span class='id identifier rubyid_fields'>fields</span>
1575
- <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:destination_ids</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_destination_ids'>destination_ids</span> <span class='kw'>if</span> <span class='id identifier rubyid_destination_ids'>destination_ids</span>
1576
- <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:sampling_rate</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_sampling_rate'>sampling_rate</span> <span class='kw'>if</span> <span class='id identifier rubyid_sampling_rate'>sampling_rate</span>
1627
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
1628
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:backends</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_backends'>backends</span> <span class='kw'>if</span> <span class='id identifier rubyid_backends'>backends</span>
1577
1629
  <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>
1578
- <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/EventStream.html" title="NgrokAPI::Models::EventStream (class)">EventStream</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventStream.html#initialize-instance_method" title="NgrokAPI::Models::EventStream#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'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1630
+ <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/FailoverBackend.html" title="NgrokAPI::Models::FailoverBackend (class)">FailoverBackend</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/FailoverBackend.html#initialize-instance_method" title="NgrokAPI::Models::FailoverBackend#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>
1579
1631
  <span class='kw'>end</span></pre>
1580
1632
  </td>
1581
1633
  </tr>
@@ -1585,7 +1637,7 @@
1585
1637
  <div class="method_details ">
1586
1638
  <h3 class="signature " id="update!-instance_method">
1587
1639
 
1588
- #<strong>update!</strong>(id: &quot;&quot;, metadata: nil, description: nil, fields: nil, destination_ids: nil, sampling_rate: nil) &#x21d2; <tt><span class='object_link'><a href="../Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">NgrokAPI::Models::EventStream</a></span></tt>
1640
+ #<strong>update!</strong>(id: &quot;&quot;, description: nil, metadata: nil, backends: []) &#x21d2; <tt><span class='object_link'><a href="../Models/FailoverBackend.html" title="NgrokAPI::Models::FailoverBackend (class)">NgrokAPI::Models::FailoverBackend</a></span></tt>
1589
1641
 
1590
1642
 
1591
1643
 
@@ -1594,9 +1646,9 @@
1594
1646
  </h3><div class="docstring">
1595
1647
  <div class="discussion">
1596
1648
 
1597
- <p>Update attributes of an Event Stream by ID. Throws an exception if API error.</p>
1649
+ <p>Update Failover backend by ID Throws an exception if API error.</p>
1598
1650
 
1599
- <p><a href="https://ngrok.com/docs/api#api-event-streams-update">ngrok.com/docs/api#api-event-streams-update</a></p>
1651
+ <p><a href="https://ngrok.com/docs/api#api-failover-backends-update">ngrok.com/docs/api#api-failover-backends-update</a></p>
1600
1652
 
1601
1653
 
1602
1654
  </div>
@@ -1616,29 +1668,6 @@
1616
1668
  <em class="default">(defaults to: <tt>&quot;&quot;</tt>)</em>
1617
1669
 
1618
1670
 
1619
- &mdash;
1620
- <div class='inline'>
1621
- <p>Unique identifier for this Event Stream.</p>
1622
- </div>
1623
-
1624
- </li>
1625
-
1626
- <li>
1627
-
1628
- <span class='name'>metadata</span>
1629
-
1630
-
1631
- <span class='type'>(<tt>string</tt>)</span>
1632
-
1633
-
1634
- <em class="default">(defaults to: <tt>nil</tt>)</em>
1635
-
1636
-
1637
- &mdash;
1638
- <div class='inline'>
1639
- <p>Arbitrary user-defined machine-readable data of this Event Stream. Optional, max 4096 bytes.</p>
1640
- </div>
1641
-
1642
1671
  </li>
1643
1672
 
1644
1673
  <li>
@@ -1654,17 +1683,17 @@
1654
1683
 
1655
1684
  &mdash;
1656
1685
  <div class='inline'>
1657
- <p>Human-readable description of the Event Stream. Optional, max 255 bytes.</p>
1686
+ <p>human-readable description of this backend. Optional</p>
1658
1687
  </div>
1659
1688
 
1660
1689
  </li>
1661
1690
 
1662
1691
  <li>
1663
1692
 
1664
- <span class='name'>fields</span>
1693
+ <span class='name'>metadata</span>
1665
1694
 
1666
1695
 
1667
- <span class='type'>(<tt>List&lt;string&gt;</tt>)</span>
1696
+ <span class='type'>(<tt>string</tt>)</span>
1668
1697
 
1669
1698
 
1670
1699
  <em class="default">(defaults to: <tt>nil</tt>)</em>
@@ -1672,43 +1701,25 @@
1672
1701
 
1673
1702
  &mdash;
1674
1703
  <div class='inline'>
1675
- <p>A list of protocol-specific fields you want to collect on each event.</p>
1704
+ <p>arbitrary user-defined machine-readable data of this backend. Optional</p>
1676
1705
  </div>
1677
1706
 
1678
1707
  </li>
1679
1708
 
1680
1709
  <li>
1681
1710
 
1682
- <span class='name'>destination_ids</span>
1711
+ <span class='name'>backends</span>
1683
1712
 
1684
1713
 
1685
1714
  <span class='type'>(<tt>List&lt;string&gt;</tt>)</span>
1686
1715
 
1687
1716
 
1688
- <em class="default">(defaults to: <tt>nil</tt>)</em>
1689
-
1690
-
1691
- &mdash;
1692
- <div class='inline'>
1693
- <p>A list of Event Destination IDs which should be used for this Event Stream. Event Streams are required to have at least one Event Destination.</p>
1694
- </div>
1695
-
1696
- </li>
1697
-
1698
- <li>
1699
-
1700
- <span class='name'>sampling_rate</span>
1701
-
1702
-
1703
- <span class='type'>(<tt>float64</tt>)</span>
1704
-
1705
-
1706
- <em class="default">(defaults to: <tt>nil</tt>)</em>
1717
+ <em class="default">(defaults to: <tt>[]</tt>)</em>
1707
1718
 
1708
1719
 
1709
1720
  &mdash;
1710
1721
  <div class='inline'>
1711
- <p>The percentage of all events you would like to capture. Valid values range from 0.01, representing 1% of all events to 1.00, representing 100% of all events.</p>
1722
+ <p>the ids of the child backends in order</p>
1712
1723
  </div>
1713
1724
 
1714
1725
  </li>
@@ -1721,7 +1732,7 @@
1721
1732
  <li>
1722
1733
 
1723
1734
 
1724
- <span class='type'>(<tt><span class='object_link'><a href="../Models/EventStream.html" title="NgrokAPI::Models::EventStream (class)">NgrokAPI::Models::EventStream</a></span></tt>)</span>
1735
+ <span class='type'>(<tt><span class='object_link'><a href="../Models/FailoverBackend.html" title="NgrokAPI::Models::FailoverBackend (class)">NgrokAPI::Models::FailoverBackend</a></span></tt>)</span>
1725
1736
 
1726
1737
 
1727
1738
 
@@ -1740,37 +1751,33 @@
1740
1751
  <pre class="lines">
1741
1752
 
1742
1753
 
1743
- 208
1744
- 209
1745
- 210
1746
- 211
1747
- 212
1748
- 213
1749
- 214
1750
- 215
1751
- 216
1752
- 217
1753
- 218
1754
- 219
1755
1754
  220
1756
- 221</pre>
1755
+ 221
1756
+ 222
1757
+ 223
1758
+ 224
1759
+ 225
1760
+ 226
1761
+ 227
1762
+ 228
1763
+ 229
1764
+ 230
1765
+ 231</pre>
1757
1766
  </td>
1758
1767
  <td>
1759
- <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/event_streams_client.rb', line 208</span>
1768
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/services/failover_backends_client.rb', line 220</span>
1760
1769
 
1761
- <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'>metadata:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>description:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>fields:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>destination_ids:</span> <span class='kw'>nil</span><span class='comma'>,</span> <span class='label'>sampling_rate:</span> <span class='kw'>nil</span><span class='rparen'>)</span>
1762
- <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'>/event_streams/%{id}</span><span class='tstring_end'>&#39;</span></span>
1770
+ <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'>backends:</span> <span class='lbracket'>[</span><span class='rbracket'>]</span><span class='rparen'>)</span>
1771
+ <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'>/backends/failover/%{id}</span><span class='tstring_end'>&#39;</span></span>
1763
1772
  <span class='id identifier rubyid_replacements'>replacements</span> <span class='op'>=</span> <span class='lbrace'>{</span>
1764
1773
  <span class='label'>id:</span> <span class='id identifier rubyid_id'>id</span><span class='comma'>,</span>
1765
1774
  <span class='rbrace'>}</span>
1766
1775
  <span class='id identifier rubyid_data'>data</span> <span class='op'>=</span> <span class='lbrace'>{</span><span class='rbrace'>}</span>
1767
- <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
1768
1776
  <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:description</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_description'>description</span> <span class='kw'>if</span> <span class='id identifier rubyid_description'>description</span>
1769
- <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:fields</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_fields'>fields</span> <span class='kw'>if</span> <span class='id identifier rubyid_fields'>fields</span>
1770
- <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:destination_ids</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_destination_ids'>destination_ids</span> <span class='kw'>if</span> <span class='id identifier rubyid_destination_ids'>destination_ids</span>
1771
- <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:sampling_rate</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_sampling_rate'>sampling_rate</span> <span class='kw'>if</span> <span class='id identifier rubyid_sampling_rate'>sampling_rate</span>
1777
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:metadata</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_metadata'>metadata</span> <span class='kw'>if</span> <span class='id identifier rubyid_metadata'>metadata</span>
1778
+ <span class='id identifier rubyid_data'>data</span><span class='lbracket'>[</span><span class='symbol'>:backends</span><span class='rbracket'>]</span> <span class='op'>=</span> <span class='id identifier rubyid_backends'>backends</span> <span class='kw'>if</span> <span class='id identifier rubyid_backends'>backends</span>
1772
1779
  <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>
1773
- <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/EventStream.html" title="NgrokAPI::Models::EventStream (class)">EventStream</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/EventStream.html#initialize-instance_method" title="NgrokAPI::Models::EventStream#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'>result:</span> <span class='id identifier rubyid_result'>result</span><span class='rparen'>)</span>
1780
+ <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/FailoverBackend.html" title="NgrokAPI::Models::FailoverBackend (class)">FailoverBackend</a></span></span><span class='period'>.</span><span class='id identifier rubyid_new'><span class='object_link'><a href="../Models/FailoverBackend.html#initialize-instance_method" title="NgrokAPI::Models::FailoverBackend#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>
1774
1781
  <span class='kw'>end</span></pre>
1775
1782
  </td>
1776
1783
  </tr>
@@ -1782,9 +1789,9 @@
1782
1789
  </div>
1783
1790
 
1784
1791
  <div id="footer">
1785
- Generated on Thu Dec 2 18:48:53 2021 by
1792
+ Generated on Mon Apr 11 19:33:03 2022 by
1786
1793
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1787
- 0.9.27 (ruby-3.0.1).
1794
+ 0.9.27 (ruby-2.7.5).
1788
1795
  </div>
1789
1796
 
1790
1797
  </div>