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
@@ -295,9 +295,9 @@
295
295
  </div>
296
296
 
297
297
  <div id="footer">
298
- Generated on Thu Dec 2 18:48:49 2021 by
298
+ Generated on Mon Apr 11 19:32:55 2022 by
299
299
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
300
- 0.9.27 (ruby-3.0.1).
300
+ 0.9.27 (ruby-2.7.5).
301
301
  </div>
302
302
 
303
303
  </div>
@@ -299,9 +299,9 @@
299
299
  </div>
300
300
 
301
301
  <div id="footer">
302
- Generated on Thu Dec 2 18:48:51 2021 by
302
+ Generated on Mon Apr 11 19:32:57 2022 by
303
303
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
304
- 0.9.27 (ruby-3.0.1).
304
+ 0.9.27 (ruby-2.7.5).
305
305
  </div>
306
306
 
307
307
  </div>
@@ -105,9 +105,9 @@
105
105
  </div>
106
106
 
107
107
  <div id="footer">
108
- Generated on Thu Dec 2 18:48:49 2021 by
108
+ Generated on Mon Apr 11 19:32:55 2022 by
109
109
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
110
- 0.9.27 (ruby-3.0.1).
110
+ 0.9.27 (ruby-2.7.5).
111
111
  </div>
112
112
 
113
113
  </div>
@@ -331,6 +331,30 @@
331
331
  <p>Make a POST request to a given URI with optional data.</p>
332
332
  </div></span>
333
333
 
334
+ </li>
335
+
336
+
337
+ <li class="public ">
338
+ <span class="summary_signature">
339
+
340
+ <a href="#put-instance_method" title="#put (instance method)">#<strong>put</strong>(path, danger: false, data: {}) &#x21d2; json </a>
341
+
342
+
343
+
344
+ </span>
345
+
346
+
347
+
348
+
349
+
350
+
351
+
352
+
353
+
354
+ <span class="summary_desc"><div class='inline'>
355
+ <p>Make a PUT request to a given URI with optional data.</p>
356
+ </div></span>
357
+
334
358
  </li>
335
359
 
336
360
 
@@ -993,7 +1017,7 @@
993
1017
  <span class='kw'>def</span> <span class='id identifier rubyid_patch'>patch</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
994
1018
  <span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='id identifier rubyid_get_uri'>get_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
995
1019
  <span class='id identifier rubyid_req'>req</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Patch</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_headers_with_json'>headers_with_json</span><span class='rparen'>)</span>
996
- <span class='id identifier rubyid_json_do'>json_do</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_req'>req</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
1020
+ <span class='id identifier rubyid_json_do'>json_do</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_req'>req</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_deep_to_h'>deep_to_h</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
997
1021
  <span class='kw'>end</span></pre>
998
1022
  </td>
999
1023
  </tr>
@@ -1112,7 +1136,126 @@
1112
1136
  <span class='kw'>def</span> <span class='id identifier rubyid_post'>post</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1113
1137
  <span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='id identifier rubyid_get_uri'>get_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
1114
1138
  <span class='id identifier rubyid_req'>req</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Post</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_headers_with_json'>headers_with_json</span><span class='rparen'>)</span>
1115
- <span class='id identifier rubyid_json_do'>json_do</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_req'>req</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_data'>data</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
1139
+ <span class='id identifier rubyid_json_do'>json_do</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_req'>req</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_deep_to_h'>deep_to_h</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
1140
+ <span class='kw'>end</span></pre>
1141
+ </td>
1142
+ </tr>
1143
+ </table>
1144
+ </div>
1145
+
1146
+ <div class="method_details ">
1147
+ <h3 class="signature " id="put-instance_method">
1148
+
1149
+ #<strong>put</strong>(path, danger: false, data: {}) &#x21d2; <tt>json</tt>
1150
+
1151
+
1152
+
1153
+
1154
+
1155
+ </h3><div class="docstring">
1156
+ <div class="discussion">
1157
+
1158
+ <p>Make a PUT request to a given URI with optional data</p>
1159
+
1160
+
1161
+ </div>
1162
+ </div>
1163
+ <div class="tags">
1164
+ <p class="tag_title">Parameters:</p>
1165
+ <ul class="param">
1166
+
1167
+ <li>
1168
+
1169
+ <span class='name'>path</span>
1170
+
1171
+
1172
+ <span class='type'>(<tt>string</tt>)</span>
1173
+
1174
+
1175
+
1176
+ &mdash;
1177
+ <div class='inline'>
1178
+ <p>URL resource path</p>
1179
+ </div>
1180
+
1181
+ </li>
1182
+
1183
+ <li>
1184
+
1185
+ <span class='name'>danger</span>
1186
+
1187
+
1188
+ <span class='type'>(<tt>boolean</tt>)</span>
1189
+
1190
+
1191
+ <em class="default">(defaults to: <tt>false</tt>)</em>
1192
+
1193
+
1194
+ &mdash;
1195
+ <div class='inline'>
1196
+ <p>determine if we should throw an exception on 404 or not</p>
1197
+ </div>
1198
+
1199
+ </li>
1200
+
1201
+ <li>
1202
+
1203
+ <span class='name'>data</span>
1204
+
1205
+
1206
+ <span class='type'>(<tt>hash</tt>)</span>
1207
+
1208
+
1209
+ <em class="default">(defaults to: <tt>{}</tt>)</em>
1210
+
1211
+
1212
+ &mdash;
1213
+ <div class='inline'>
1214
+ <p>hash which will be converted to query parameters or form data</p>
1215
+ </div>
1216
+
1217
+ </li>
1218
+
1219
+ </ul>
1220
+
1221
+ <p class="tag_title">Returns:</p>
1222
+ <ul class="return">
1223
+
1224
+ <li>
1225
+
1226
+
1227
+ <span class='type'>(<tt>json</tt>)</span>
1228
+
1229
+
1230
+
1231
+ &mdash;
1232
+ <div class='inline'>
1233
+ <p>response body</p>
1234
+ </div>
1235
+
1236
+ </li>
1237
+
1238
+ </ul>
1239
+
1240
+ </div><table class="source_code">
1241
+ <tr>
1242
+ <td>
1243
+ <pre class="lines">
1244
+
1245
+
1246
+ 95
1247
+ 96
1248
+ 97
1249
+ 98
1250
+ 99</pre>
1251
+ </td>
1252
+ <td>
1253
+ <pre class="code"><span class="info file"># File 'lib/ngrokapi/http_client.rb', line 95</span>
1254
+
1255
+ <span class='kw'>def</span> <span class='id identifier rubyid_put'>put</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='kw'>false</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='lbrace'>{</span><span class='rbrace'>}</span><span class='rparen'>)</span>
1256
+ <span class='id identifier rubyid_uri'>uri</span> <span class='op'>=</span> <span class='id identifier rubyid_get_uri'>get_uri</span><span class='lparen'>(</span><span class='id identifier rubyid_path'>path</span><span class='rparen'>)</span>
1257
+ <span class='id identifier rubyid_req'>req</span> <span class='op'>=</span> <span class='const'>Net</span><span class='op'>::</span><span class='const'>HTTP</span><span class='op'>::</span><span class='const'>Put</span><span class='period'>.</span><span class='id identifier rubyid_new'>new</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_headers_with_json'>headers_with_json</span><span class='rparen'>)</span>
1258
+ <span class='id identifier rubyid_json_do'>json_do</span><span class='lparen'>(</span><span class='id identifier rubyid_uri'>uri</span><span class='comma'>,</span> <span class='id identifier rubyid_req'>req</span><span class='comma'>,</span> <span class='label'>danger:</span> <span class='id identifier rubyid_danger'>danger</span><span class='comma'>,</span> <span class='label'>data:</span> <span class='id identifier rubyid_deep_to_h'>deep_to_h</span><span class='lparen'>(</span><span class='id identifier rubyid_data'>data</span><span class='rparen'>)</span><span class='period'>.</span><span class='id identifier rubyid_to_json'>to_json</span><span class='rparen'>)</span>
1116
1259
  <span class='kw'>end</span></pre>
1117
1260
  </td>
1118
1261
  </tr>
@@ -1124,9 +1267,9 @@
1124
1267
  </div>
1125
1268
 
1126
1269
  <div id="footer">
1127
- Generated on Thu Dec 2 18:48:49 2021 by
1270
+ Generated on Mon Apr 11 19:32:56 2022 by
1128
1271
  <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1129
- 0.9.27 (ruby-3.0.1).
1272
+ 0.9.27 (ruby-2.7.5).
1130
1273
  </div>
1131
1274
 
1132
1275
  </div>